blob: 0118f65cad67d49005a4a76e5c5c8c373c52133f [file] [log] [blame]
danielk1977fa256a32005-05-25 04:11:56 +00001/*
2** 2005 May 25
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains the implementation of the sqlite3_prepare()
13** interface, and routines that contribute to loading the database schema
14** from disk.
15**
drh34533152008-03-19 13:03:33 +000016** $Id: prepare.c,v 1.79 2008/03/19 13:03:34 drh Exp $
danielk1977fa256a32005-05-25 04:11:56 +000017*/
18#include "sqliteInt.h"
danielk1977fa256a32005-05-25 04:11:56 +000019#include <ctype.h>
20
21/*
22** Fill the InitData structure with an error message that indicates
23** that the database is corrupt.
24*/
drh34533152008-03-19 13:03:33 +000025static void corruptSchema(
26 InitData *pData, /* Initialization context */
27 const char *zObj, /* Object being parsed at the point of error */
28 const char *zExtra /* Error information */
29){
drh17435752007-08-16 04:30:38 +000030 if( !pData->db->mallocFailed ){
drh34533152008-03-19 13:03:33 +000031 if( zObj==0 ) zObj = "?";
32 sqlite3SetString(pData->pzErrMsg, "malformed database schema (", zObj, ")",
danielk1977fa256a32005-05-25 04:11:56 +000033 zExtra!=0 && zExtra[0]!=0 ? " - " : (char*)0, zExtra, (char*)0);
34 }
drh15ca1df2006-07-26 13:43:30 +000035 pData->rc = SQLITE_CORRUPT;
danielk1977fa256a32005-05-25 04:11:56 +000036}
37
38/*
39** This is the callback routine for the code that initializes the
40** database. See sqlite3Init() below for additional information.
41** This routine is also called from the OP_ParseSchema opcode of the VDBE.
42**
43** Each callback contains the following information:
44**
45** argv[0] = name of thing being created
danielk197778efaba2006-06-12 06:09:17 +000046** argv[1] = root page number for table or index. 0 for trigger or view.
danielk1977fa256a32005-05-25 04:11:56 +000047** argv[2] = SQL text for the CREATE statement.
danielk1977fa256a32005-05-25 04:11:56 +000048**
49*/
50int sqlite3InitCallback(void *pInit, int argc, char **argv, char **azColName){
51 InitData *pData = (InitData*)pInit;
52 sqlite3 *db = pData->db;
drhece3c722006-09-23 20:36:01 +000053 int iDb = pData->iDb;
danielk1977fa256a32005-05-25 04:11:56 +000054
drhb1ab8ea2007-08-29 00:33:07 +000055 assert( sqlite3_mutex_held(db->mutex) );
drh15ca1df2006-07-26 13:43:30 +000056 pData->rc = SQLITE_OK;
drhece3c722006-09-23 20:36:01 +000057 DbClearProperty(db, iDb, DB_Empty);
drh17435752007-08-16 04:30:38 +000058 if( db->mallocFailed ){
drh34533152008-03-19 13:03:33 +000059 corruptSchema(pData, argv[0], 0);
danielk1977da184232006-01-05 11:34:32 +000060 return SQLITE_NOMEM;
61 }
62
drhece3c722006-09-23 20:36:01 +000063 assert( argc==3 );
danielk1977fa256a32005-05-25 04:11:56 +000064 if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
drhece3c722006-09-23 20:36:01 +000065 if( argv[1]==0 ){
drh34533152008-03-19 13:03:33 +000066 corruptSchema(pData, argv[0], 0);
danielk1977fa256a32005-05-25 04:11:56 +000067 return 1;
68 }
danielk1977fa256a32005-05-25 04:11:56 +000069 assert( iDb>=0 && iDb<db->nDb );
70 if( argv[2] && argv[2][0] ){
71 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
72 ** But because db->init.busy is set to 1, no VDBE code is generated
73 ** or executed. All the parser does is build the internal data
74 ** structures that describe the table, index, or view.
75 */
76 char *zErr;
77 int rc;
78 assert( db->init.busy );
79 db->init.iDb = iDb;
80 db->init.newTnum = atoi(argv[1]);
81 rc = sqlite3_exec(db, argv[2], 0, 0, &zErr);
82 db->init.iDb = 0;
drh43617e92006-03-06 20:55:46 +000083 assert( rc!=SQLITE_OK || zErr==0 );
danielk1977fa256a32005-05-25 04:11:56 +000084 if( SQLITE_OK!=rc ){
drh15ca1df2006-07-26 13:43:30 +000085 pData->rc = rc;
danielk1977261919c2005-12-06 12:52:59 +000086 if( rc==SQLITE_NOMEM ){
drh17435752007-08-16 04:30:38 +000087 db->mallocFailed = 1;
drh15ca1df2006-07-26 13:43:30 +000088 }else if( rc!=SQLITE_INTERRUPT ){
drh34533152008-03-19 13:03:33 +000089 corruptSchema(pData, argv[0], zErr);
danielk1977261919c2005-12-06 12:52:59 +000090 }
danielk1977fa256a32005-05-25 04:11:56 +000091 sqlite3_free(zErr);
drh15ca1df2006-07-26 13:43:30 +000092 return 1;
danielk1977fa256a32005-05-25 04:11:56 +000093 }
drh02cd2b82008-01-22 19:34:27 +000094 }else if( argv[0]==0 ){
drh34533152008-03-19 13:03:33 +000095 corruptSchema(pData, 0, 0);
danielk1977fa256a32005-05-25 04:11:56 +000096 }else{
97 /* If the SQL column is blank it means this is an index that
98 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
99 ** constraint for a CREATE TABLE. The index should have already
100 ** been created when we processed the CREATE TABLE. All we have
101 ** to do here is record the root page number for that index.
102 */
103 Index *pIndex;
104 pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zName);
105 if( pIndex==0 || pIndex->tnum!=0 ){
106 /* This can occur if there exists an index on a TEMP table which
107 ** has the same name as another index on a permanent index. Since
108 ** the permanent table is hidden by the TEMP table, we can also
109 ** safely ignore the index on the permanent table.
110 */
111 /* Do Nothing */;
112 }else{
113 pIndex->tnum = atoi(argv[1]);
114 }
115 }
116 return 0;
117}
118
119/*
120** Attempt to read the database schema and initialize internal
121** data structures for a single database file. The index of the
122** database file is given by iDb. iDb==0 is used for the main
123** database. iDb==1 should never be used. iDb>=2 is used for
124** auxiliary databases. Return one of the SQLITE_ error codes to
125** indicate success or failure.
126*/
127static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
128 int rc;
129 BtCursor *curMain;
130 int size;
131 Table *pTab;
drhfdd6e852005-12-16 01:06:16 +0000132 Db *pDb;
drhece3c722006-09-23 20:36:01 +0000133 char const *azArg[4];
danielk1977fa256a32005-05-25 04:11:56 +0000134 int meta[10];
135 InitData initData;
136 char const *zMasterSchema;
137 char const *zMasterName = SCHEMA_TABLE(iDb);
138
139 /*
140 ** The master database table has a structure like this
141 */
142 static const char master_schema[] =
143 "CREATE TABLE sqlite_master(\n"
144 " type text,\n"
145 " name text,\n"
146 " tbl_name text,\n"
147 " rootpage integer,\n"
148 " sql text\n"
149 ")"
150 ;
151#ifndef SQLITE_OMIT_TEMPDB
152 static const char temp_master_schema[] =
153 "CREATE TEMP TABLE sqlite_temp_master(\n"
154 " type text,\n"
155 " name text,\n"
156 " tbl_name text,\n"
157 " rootpage integer,\n"
158 " sql text\n"
159 ")"
160 ;
161#else
162 #define temp_master_schema 0
163#endif
164
165 assert( iDb>=0 && iDb<db->nDb );
danielk197714db2662006-01-09 16:12:04 +0000166 assert( db->aDb[iDb].pSchema );
drhb1ab8ea2007-08-29 00:33:07 +0000167 assert( sqlite3_mutex_held(db->mutex) );
danielk19774eab8b72007-12-27 15:12:16 +0000168 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
danielk1977da184232006-01-05 11:34:32 +0000169
danielk1977fa256a32005-05-25 04:11:56 +0000170 /* zMasterSchema and zInitScript are set to point at the master schema
171 ** and initialisation script appropriate for the database being
172 ** initialised. zMasterName is the name of the master table.
173 */
174 if( !OMIT_TEMPDB && iDb==1 ){
175 zMasterSchema = temp_master_schema;
176 }else{
177 zMasterSchema = master_schema;
178 }
179 zMasterName = SCHEMA_TABLE(iDb);
180
181 /* Construct the schema tables. */
danielk1977fa256a32005-05-25 04:11:56 +0000182 azArg[0] = zMasterName;
183 azArg[1] = "1";
184 azArg[2] = zMasterSchema;
drhece3c722006-09-23 20:36:01 +0000185 azArg[3] = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000186 initData.db = db;
drhece3c722006-09-23 20:36:01 +0000187 initData.iDb = iDb;
danielk1977fa256a32005-05-25 04:11:56 +0000188 initData.pzErrMsg = pzErrMsg;
drh7e8b8482008-01-23 03:03:05 +0000189 (void)sqlite3SafetyOff(db);
drhece3c722006-09-23 20:36:01 +0000190 rc = sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
drh7e8b8482008-01-23 03:03:05 +0000191 (void)sqlite3SafetyOn(db);
drh15ca1df2006-07-26 13:43:30 +0000192 if( rc ){
danielk1977a1644fd2007-08-29 12:31:25 +0000193 rc = initData.rc;
194 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000195 }
196 pTab = sqlite3FindTable(db, zMasterName, db->aDb[iDb].zName);
197 if( pTab ){
198 pTab->readOnly = 1;
199 }
danielk1977fa256a32005-05-25 04:11:56 +0000200
201 /* Create a cursor to hold the database open
202 */
drhfdd6e852005-12-16 01:06:16 +0000203 pDb = &db->aDb[iDb];
204 if( pDb->pBt==0 ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000205 if( !OMIT_TEMPDB && iDb==1 ){
206 DbSetProperty(db, 1, DB_SchemaLoaded);
207 }
danielk1977fa256a32005-05-25 04:11:56 +0000208 return SQLITE_OK;
209 }
drhb1ab8ea2007-08-29 00:33:07 +0000210 sqlite3BtreeEnter(pDb->pBt);
drhfdd6e852005-12-16 01:06:16 +0000211 rc = sqlite3BtreeCursor(pDb->pBt, MASTER_ROOT, 0, 0, 0, &curMain);
danielk1977fa256a32005-05-25 04:11:56 +0000212 if( rc!=SQLITE_OK && rc!=SQLITE_EMPTY ){
213 sqlite3SetString(pzErrMsg, sqlite3ErrStr(rc), (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000214 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000215 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000216 }
217
218 /* Get the database meta information.
219 **
220 ** Meta values are as follows:
221 ** meta[0] Schema cookie. Changes with each schema change.
222 ** meta[1] File format of schema layer.
223 ** meta[2] Size of the page cache.
224 ** meta[3] Use freelist if 0. Autovacuum if greater than zero.
drh8159a352006-05-23 23:22:29 +0000225 ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
danielk1977fa256a32005-05-25 04:11:56 +0000226 ** meta[5] The user cookie. Used by the application.
danielk1977418899a2007-06-24 10:14:00 +0000227 ** meta[6] Incremental-vacuum flag.
danielk1977fa256a32005-05-25 04:11:56 +0000228 ** meta[7]
229 ** meta[8]
230 ** meta[9]
231 **
drhf248e212006-01-25 22:50:38 +0000232 ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
danielk1977fa256a32005-05-25 04:11:56 +0000233 ** the possible values of meta[4].
234 */
235 if( rc==SQLITE_OK ){
236 int i;
237 for(i=0; rc==SQLITE_OK && i<sizeof(meta)/sizeof(meta[0]); i++){
drhfdd6e852005-12-16 01:06:16 +0000238 rc = sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
danielk1977fa256a32005-05-25 04:11:56 +0000239 }
240 if( rc ){
241 sqlite3SetString(pzErrMsg, sqlite3ErrStr(rc), (char*)0);
242 sqlite3BtreeCloseCursor(curMain);
drhb1ab8ea2007-08-29 00:33:07 +0000243 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000244 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000245 }
246 }else{
247 memset(meta, 0, sizeof(meta));
248 }
danielk1977da184232006-01-05 11:34:32 +0000249 pDb->pSchema->schema_cookie = meta[0];
danielk1977fa256a32005-05-25 04:11:56 +0000250
251 /* If opening a non-empty database, check the text encoding. For the
252 ** main database, set sqlite3.enc to the encoding of the main database.
253 ** For an attached db, it is an error if the encoding is not the same
254 ** as sqlite3.enc.
255 */
256 if( meta[4] ){ /* text encoding */
257 if( iDb==0 ){
danielk197714db2662006-01-09 16:12:04 +0000258 /* If opening the main database, set ENC(db). */
259 ENC(db) = (u8)meta[4];
danielk1977b3bf5562006-01-10 17:58:23 +0000260 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0);
danielk1977fa256a32005-05-25 04:11:56 +0000261 }else{
danielk197714db2662006-01-09 16:12:04 +0000262 /* If opening an attached database, the encoding much match ENC(db) */
263 if( meta[4]!=ENC(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000264 sqlite3BtreeCloseCursor(curMain);
265 sqlite3SetString(pzErrMsg, "attached databases must use the same"
266 " text encoding as main database", (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000267 sqlite3BtreeLeave(pDb->pBt);
danielk1977fa256a32005-05-25 04:11:56 +0000268 return SQLITE_ERROR;
269 }
270 }
danielk1977b82e7ed2006-01-11 14:09:31 +0000271 }else{
272 DbSetProperty(db, iDb, DB_Empty);
danielk1977fa256a32005-05-25 04:11:56 +0000273 }
danielk197714db2662006-01-09 16:12:04 +0000274 pDb->pSchema->enc = ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000275
276 size = meta[2];
drhc797d4d2007-05-08 01:08:49 +0000277 if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
drh3c84ddf2008-01-09 02:15:38 +0000278 if( size<0 ) size = -size;
danielk197714db2662006-01-09 16:12:04 +0000279 pDb->pSchema->cache_size = size;
280 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
danielk1977fa256a32005-05-25 04:11:56 +0000281
282 /*
283 ** file_format==1 Version 3.0.0.
drhfdd6e852005-12-16 01:06:16 +0000284 ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
285 ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
drhd946db02005-12-29 19:23:06 +0000286 ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
danielk1977fa256a32005-05-25 04:11:56 +0000287 */
danielk1977da184232006-01-05 11:34:32 +0000288 pDb->pSchema->file_format = meta[1];
289 if( pDb->pSchema->file_format==0 ){
290 pDb->pSchema->file_format = 1;
drhfdd6e852005-12-16 01:06:16 +0000291 }
danielk1977da184232006-01-05 11:34:32 +0000292 if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
danielk1977fa256a32005-05-25 04:11:56 +0000293 sqlite3BtreeCloseCursor(curMain);
294 sqlite3SetString(pzErrMsg, "unsupported file format", (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000295 sqlite3BtreeLeave(pDb->pBt);
danielk1977fa256a32005-05-25 04:11:56 +0000296 return SQLITE_ERROR;
297 }
298
drh4aa2bfe2007-11-28 13:43:16 +0000299 /* Ticket #2804: When we open a database in the newer file format,
300 ** clear the legacy_file_format pragma flag so that a VACUUM will
301 ** not downgrade the database and thus invalidate any descending
302 ** indices that the user might have created.
303 */
304 if( iDb==0 && meta[1]>=4 ){
305 db->flags &= ~SQLITE_LegacyFileFmt;
306 }
danielk1977fa256a32005-05-25 04:11:56 +0000307
308 /* Read the schema information out of the schema tables
309 */
310 assert( db->init.busy );
311 if( rc==SQLITE_EMPTY ){
312 /* For an empty database, there is nothing to read */
313 rc = SQLITE_OK;
314 }else{
315 char *zSql;
danielk19771e536952007-08-16 10:09:01 +0000316 zSql = sqlite3MPrintf(db,
drhece3c722006-09-23 20:36:01 +0000317 "SELECT name, rootpage, sql FROM '%q'.%s",
318 db->aDb[iDb].zName, zMasterName);
drh7e8b8482008-01-23 03:03:05 +0000319 (void)sqlite3SafetyOff(db);
drha6d0ffc2007-10-12 20:42:28 +0000320#ifndef SQLITE_OMIT_AUTHORIZATION
321 {
322 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
323 xAuth = db->xAuth;
324 db->xAuth = 0;
325#endif
326 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
327#ifndef SQLITE_OMIT_AUTHORIZATION
328 db->xAuth = xAuth;
329 }
330#endif
drh15ca1df2006-07-26 13:43:30 +0000331 if( rc==SQLITE_ABORT ) rc = initData.rc;
drh7e8b8482008-01-23 03:03:05 +0000332 (void)sqlite3SafetyOn(db);
drh17435752007-08-16 04:30:38 +0000333 sqlite3_free(zSql);
drh497e4462005-07-23 03:18:40 +0000334#ifndef SQLITE_OMIT_ANALYZE
335 if( rc==SQLITE_OK ){
336 sqlite3AnalysisLoad(db, iDb);
337 }
338#endif
danielk1977fa256a32005-05-25 04:11:56 +0000339 sqlite3BtreeCloseCursor(curMain);
340 }
drh17435752007-08-16 04:30:38 +0000341 if( db->mallocFailed ){
danielk19779e128002006-01-18 16:51:35 +0000342 /* sqlite3SetString(pzErrMsg, "out of memory", (char*)0); */
danielk1977fa256a32005-05-25 04:11:56 +0000343 rc = SQLITE_NOMEM;
344 sqlite3ResetInternalSchema(db, 0);
345 }
danielk197734c68fb2007-03-14 15:37:04 +0000346 if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
347 /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
348 ** the schema loaded, even if errors occured. In this situation the
349 ** current sqlite3_prepare() operation will fail, but the following one
350 ** will attempt to compile the supplied statement against whatever subset
351 ** of the schema was loaded before the error occured. The primary
352 ** purpose of this is to allow access to the sqlite_master table
drh85b623f2007-12-13 21:54:09 +0000353 ** even when its contents have been corrupted.
danielk197734c68fb2007-03-14 15:37:04 +0000354 */
danielk1977fa256a32005-05-25 04:11:56 +0000355 DbSetProperty(db, iDb, DB_SchemaLoaded);
danielk197734c68fb2007-03-14 15:37:04 +0000356 rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000357 }
drhb1ab8ea2007-08-29 00:33:07 +0000358 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000359
360error_out:
danielk1977ae72d982007-10-03 08:46:44 +0000361 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000362 db->mallocFailed = 1;
363 }
danielk1977fa256a32005-05-25 04:11:56 +0000364 return rc;
365}
366
367/*
368** Initialize all database files - the main database file, the file
369** used to store temporary tables, and any additional database files
370** created using ATTACH statements. Return a success code. If an
371** error occurs, write an error message into *pzErrMsg.
372**
danielk1977e7259292006-01-13 06:33:23 +0000373** After a database is initialized, the DB_SchemaLoaded bit is set
374** bit is set in the flags field of the Db structure. If the database
375** file was of zero-length, then the DB_Empty flag is also set.
danielk1977fa256a32005-05-25 04:11:56 +0000376*/
377int sqlite3Init(sqlite3 *db, char **pzErrMsg){
378 int i, rc;
danielk19775814c1a2007-08-13 14:41:19 +0000379 int commit_internal = !(db->flags&SQLITE_InternChanges);
danielk1977fa256a32005-05-25 04:11:56 +0000380
drhb1ab8ea2007-08-29 00:33:07 +0000381 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000382 if( db->init.busy ) return SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000383 rc = SQLITE_OK;
384 db->init.busy = 1;
385 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
386 if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
387 rc = sqlite3InitOne(db, i, pzErrMsg);
388 if( rc ){
389 sqlite3ResetInternalSchema(db, i);
390 }
391 }
392
393 /* Once all the other databases have been initialised, load the schema
394 ** for the TEMP database. This is loaded last, as the TEMP database
395 ** schema may contain references to objects in other databases.
396 */
397#ifndef SQLITE_OMIT_TEMPDB
398 if( rc==SQLITE_OK && db->nDb>1 && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
399 rc = sqlite3InitOne(db, 1, pzErrMsg);
400 if( rc ){
401 sqlite3ResetInternalSchema(db, 1);
402 }
403 }
404#endif
405
406 db->init.busy = 0;
danielk19775814c1a2007-08-13 14:41:19 +0000407 if( rc==SQLITE_OK && commit_internal ){
danielk1977fa256a32005-05-25 04:11:56 +0000408 sqlite3CommitInternalChanges(db);
409 }
410
danielk1977b82e7ed2006-01-11 14:09:31 +0000411 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000412}
413
414/*
415** This routine is a no-op if the database schema is already initialised.
416** Otherwise, the schema is loaded. An error code is returned.
417*/
418int sqlite3ReadSchema(Parse *pParse){
419 int rc = SQLITE_OK;
420 sqlite3 *db = pParse->db;
drhb1ab8ea2007-08-29 00:33:07 +0000421 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000422 if( !db->init.busy ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000423 rc = sqlite3Init(db, &pParse->zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000424 }
danielk1977fa256a32005-05-25 04:11:56 +0000425 if( rc!=SQLITE_OK ){
426 pParse->rc = rc;
427 pParse->nErr++;
428 }
429 return rc;
430}
431
432
433/*
434** Check schema cookies in all databases. If any cookie is out
435** of date, return 0. If all schema cookies are current, return 1.
436*/
437static int schemaIsValid(sqlite3 *db){
438 int iDb;
439 int rc;
440 BtCursor *curTemp;
441 int cookie;
442 int allOk = 1;
443
drhb1ab8ea2007-08-29 00:33:07 +0000444 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000445 for(iDb=0; allOk && iDb<db->nDb; iDb++){
446 Btree *pBt;
447 pBt = db->aDb[iDb].pBt;
448 if( pBt==0 ) continue;
449 rc = sqlite3BtreeCursor(pBt, MASTER_ROOT, 0, 0, 0, &curTemp);
450 if( rc==SQLITE_OK ){
451 rc = sqlite3BtreeGetMeta(pBt, 1, (u32 *)&cookie);
danielk1977da184232006-01-05 11:34:32 +0000452 if( rc==SQLITE_OK && cookie!=db->aDb[iDb].pSchema->schema_cookie ){
danielk1977fa256a32005-05-25 04:11:56 +0000453 allOk = 0;
454 }
455 sqlite3BtreeCloseCursor(curTemp);
456 }
danielk1977ae72d982007-10-03 08:46:44 +0000457 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000458 db->mallocFailed = 1;
459 }
danielk1977fa256a32005-05-25 04:11:56 +0000460 }
461 return allOk;
462}
463
464/*
drhf248e212006-01-25 22:50:38 +0000465** Convert a schema pointer into the iDb index that indicates
466** which database file in db->aDb[] the schema refers to.
467**
468** If the same database is attached more than once, the first
469** attached database is returned.
470*/
danielk1977e501b892006-01-09 06:29:47 +0000471int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
drh198bf392006-01-06 21:52:49 +0000472 int i = -1000000;
473
474 /* If pSchema is NULL, then return -1000000. This happens when code in
475 ** expr.c is trying to resolve a reference to a transient table (i.e. one
476 ** created by a sub-select). In this case the return value of this
477 ** function should never be used.
478 **
479 ** We return -1000000 instead of the more usual -1 simply because using
480 ** -1000000 as incorrectly using -1000000 index into db->aDb[] is much
481 ** more likely to cause a segfault than -1 (of course there are assert()
482 ** statements too, but it never hurts to play the odds).
483 */
drhb1ab8ea2007-08-29 00:33:07 +0000484 assert( sqlite3_mutex_held(db->mutex) );
drh198bf392006-01-06 21:52:49 +0000485 if( pSchema ){
486 for(i=0; i<db->nDb; i++){
487 if( db->aDb[i].pSchema==pSchema ){
488 break;
489 }
490 }
491 assert( i>=0 &&i>=0 && i<db->nDb );
492 }
493 return i;
494}
495
496/*
danielk1977fa256a32005-05-25 04:11:56 +0000497** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
498*/
mlcreech3a00f902008-03-04 17:45:01 +0000499static int sqlite3Prepare(
danielk1977fa256a32005-05-25 04:11:56 +0000500 sqlite3 *db, /* Database handle. */
501 const char *zSql, /* UTF-8 encoded SQL statement. */
502 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000503 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000504 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
drhb900aaf2006-11-09 00:24:53 +0000505 const char **pzTail /* OUT: End of parsed string */
danielk1977fa256a32005-05-25 04:11:56 +0000506){
507 Parse sParse;
508 char *zErrMsg = 0;
509 int rc = SQLITE_OK;
danielk1977c87d34d2006-01-06 13:00:28 +0000510 int i;
danielk1977fa256a32005-05-25 04:11:56 +0000511
danielk1977fa256a32005-05-25 04:11:56 +0000512 assert( ppStmt );
513 *ppStmt = 0;
514 if( sqlite3SafetyOn(db) ){
515 return SQLITE_MISUSE;
516 }
drh86f8c192007-08-22 00:39:19 +0000517 assert( !db->mallocFailed );
drhb21c8cd2007-08-21 19:33:56 +0000518 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000519
danielk1977c87d34d2006-01-06 13:00:28 +0000520 /* If any attached database schemas are locked, do not proceed with
521 ** compilation. Instead return SQLITE_LOCKED immediately.
522 */
523 for(i=0; i<db->nDb; i++) {
524 Btree *pBt = db->aDb[i].pBt;
drhb1ab8ea2007-08-29 00:33:07 +0000525 if( pBt ){
526 int rc;
527 rc = sqlite3BtreeSchemaLocked(pBt);
528 if( rc ){
529 const char *zDb = db->aDb[i].zName;
530 sqlite3Error(db, SQLITE_LOCKED, "database schema is locked: %s", zDb);
drh7e8b8482008-01-23 03:03:05 +0000531 (void)sqlite3SafetyOff(db);
drhb1ab8ea2007-08-29 00:33:07 +0000532 return SQLITE_LOCKED;
533 }
danielk1977c87d34d2006-01-06 13:00:28 +0000534 }
535 }
536
danielk1977fa256a32005-05-25 04:11:56 +0000537 memset(&sParse, 0, sizeof(sParse));
538 sParse.db = db;
drh9051a422006-01-30 22:35:43 +0000539 if( nBytes>=0 && zSql[nBytes]!=0 ){
drhe5c941b2007-05-08 13:58:26 +0000540 char *zSqlCopy;
drhbe69bf62007-12-18 17:50:33 +0000541 if( SQLITE_MAX_SQL_LENGTH>0 && nBytes>SQLITE_MAX_SQL_LENGTH ){
542 sqlite3Error(db, SQLITE_TOOBIG, "statement too long");
drh7e8b8482008-01-23 03:03:05 +0000543 (void)sqlite3SafetyOff(db);
drhe5c941b2007-05-08 13:58:26 +0000544 return SQLITE_TOOBIG;
545 }
drh17435752007-08-16 04:30:38 +0000546 zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
drh276fdbf2007-04-30 21:39:16 +0000547 if( zSqlCopy ){
548 sqlite3RunParser(&sParse, zSqlCopy, &zErrMsg);
drh17435752007-08-16 04:30:38 +0000549 sqlite3_free(zSqlCopy);
drh276fdbf2007-04-30 21:39:16 +0000550 }
551 sParse.zTail = &zSql[nBytes];
drh9051a422006-01-30 22:35:43 +0000552 }else{
553 sqlite3RunParser(&sParse, zSql, &zErrMsg);
554 }
danielk1977fa256a32005-05-25 04:11:56 +0000555
drh17435752007-08-16 04:30:38 +0000556 if( db->mallocFailed ){
danielk1977261919c2005-12-06 12:52:59 +0000557 sParse.rc = SQLITE_NOMEM;
danielk1977fa256a32005-05-25 04:11:56 +0000558 }
559 if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
drh4d91a702006-01-04 15:54:36 +0000560 if( sParse.checkSchema && !schemaIsValid(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000561 sParse.rc = SQLITE_SCHEMA;
562 }
563 if( sParse.rc==SQLITE_SCHEMA ){
564 sqlite3ResetInternalSchema(db, 0);
565 }
drh17435752007-08-16 04:30:38 +0000566 if( db->mallocFailed ){
drh344a6272006-06-26 12:50:09 +0000567 sParse.rc = SQLITE_NOMEM;
568 }
drhb900aaf2006-11-09 00:24:53 +0000569 if( pzTail ){
570 *pzTail = sParse.zTail;
571 }
danielk1977fa256a32005-05-25 04:11:56 +0000572 rc = sParse.rc;
573
574#ifndef SQLITE_OMIT_EXPLAIN
575 if( rc==SQLITE_OK && sParse.pVdbe && sParse.explain ){
drhecc92422005-09-10 16:46:12 +0000576 if( sParse.explain==2 ){
577 sqlite3VdbeSetNumCols(sParse.pVdbe, 3);
drh66a51672008-01-03 00:01:23 +0000578 sqlite3VdbeSetColName(sParse.pVdbe, 0, COLNAME_NAME, "order", P4_STATIC);
579 sqlite3VdbeSetColName(sParse.pVdbe, 1, COLNAME_NAME, "from", P4_STATIC);
580 sqlite3VdbeSetColName(sParse.pVdbe, 2, COLNAME_NAME, "detail", P4_STATIC);
drhecc92422005-09-10 16:46:12 +0000581 }else{
danielk19770d78bae2008-01-03 07:09:48 +0000582 sqlite3VdbeSetNumCols(sParse.pVdbe, 8);
drh66a51672008-01-03 00:01:23 +0000583 sqlite3VdbeSetColName(sParse.pVdbe, 0, COLNAME_NAME, "addr", P4_STATIC);
584 sqlite3VdbeSetColName(sParse.pVdbe, 1, COLNAME_NAME, "opcode", P4_STATIC);
585 sqlite3VdbeSetColName(sParse.pVdbe, 2, COLNAME_NAME, "p1", P4_STATIC);
586 sqlite3VdbeSetColName(sParse.pVdbe, 3, COLNAME_NAME, "p2", P4_STATIC);
587 sqlite3VdbeSetColName(sParse.pVdbe, 4, COLNAME_NAME, "p3", P4_STATIC);
danielk19770d78bae2008-01-03 07:09:48 +0000588 sqlite3VdbeSetColName(sParse.pVdbe, 5, COLNAME_NAME, "p4", P4_STATIC);
589 sqlite3VdbeSetColName(sParse.pVdbe, 6, COLNAME_NAME, "p5", P4_STATIC);
590 sqlite3VdbeSetColName(sParse.pVdbe, 7, COLNAME_NAME, "comment",P4_STATIC);
drhecc92422005-09-10 16:46:12 +0000591 }
drhb900aaf2006-11-09 00:24:53 +0000592 }
danielk1977fa256a32005-05-25 04:11:56 +0000593#endif
594
danielk1977fa256a32005-05-25 04:11:56 +0000595 if( sqlite3SafetyOff(db) ){
596 rc = SQLITE_MISUSE;
597 }
danielk19777e29e952007-04-19 11:09:01 +0000598
599 if( saveSqlFlag ){
600 sqlite3VdbeSetSql(sParse.pVdbe, zSql, sParse.zTail - zSql);
601 }
drh17435752007-08-16 04:30:38 +0000602 if( rc!=SQLITE_OK || db->mallocFailed ){
danielk1977fa256a32005-05-25 04:11:56 +0000603 sqlite3_finalize((sqlite3_stmt*)sParse.pVdbe);
danielk19777e29e952007-04-19 11:09:01 +0000604 assert(!(*ppStmt));
605 }else{
606 *ppStmt = (sqlite3_stmt*)sParse.pVdbe;
danielk1977fa256a32005-05-25 04:11:56 +0000607 }
608
609 if( zErrMsg ){
610 sqlite3Error(db, rc, "%s", zErrMsg);
drh17435752007-08-16 04:30:38 +0000611 sqlite3_free(zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000612 }else{
613 sqlite3Error(db, rc, 0);
614 }
danielk1977261919c2005-12-06 12:52:59 +0000615
danielk197754f01982006-01-18 15:25:17 +0000616 rc = sqlite3ApiExit(db, rc);
drh4ac285a2006-09-15 07:28:50 +0000617 assert( (rc&db->errMask)==rc );
danielk1977fa256a32005-05-25 04:11:56 +0000618 return rc;
619}
drhb21c8cd2007-08-21 19:33:56 +0000620static int sqlite3LockAndPrepare(
621 sqlite3 *db, /* Database handle. */
622 const char *zSql, /* UTF-8 encoded SQL statement. */
623 int nBytes, /* Length of zSql in bytes. */
624 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
625 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
626 const char **pzTail /* OUT: End of parsed string */
627){
628 int rc;
drh7e8b8482008-01-23 03:03:05 +0000629 if( !sqlite3SafetyCheckOk(db) ){
drh27641702007-08-22 02:56:42 +0000630 return SQLITE_MISUSE;
631 }
drhb21c8cd2007-08-21 19:33:56 +0000632 sqlite3_mutex_enter(db->mutex);
drhb1ab8ea2007-08-29 00:33:07 +0000633 sqlite3BtreeEnterAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000634 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, ppStmt, pzTail);
drhb1ab8ea2007-08-29 00:33:07 +0000635 sqlite3BtreeLeaveAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000636 sqlite3_mutex_leave(db->mutex);
637 return rc;
638}
danielk1977fa256a32005-05-25 04:11:56 +0000639
drhb900aaf2006-11-09 00:24:53 +0000640/*
641** Rerun the compilation of a statement after a schema change.
642** Return true if the statement was recompiled successfully.
643** Return false if there is an error of some kind.
644*/
645int sqlite3Reprepare(Vdbe *p){
646 int rc;
drh4f0c5872007-03-26 22:05:01 +0000647 sqlite3_stmt *pNew;
drhb900aaf2006-11-09 00:24:53 +0000648 const char *zSql;
649 sqlite3 *db;
drhb21c8cd2007-08-21 19:33:56 +0000650
drhb1ab8ea2007-08-29 00:33:07 +0000651 assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
danielk1977d0e2a852007-11-14 06:48:48 +0000652 zSql = sqlite3_sql((sqlite3_stmt *)p);
drhc4dd3fd2008-01-22 01:48:05 +0000653 assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
drhb900aaf2006-11-09 00:24:53 +0000654 db = sqlite3VdbeDb(p);
drhb21c8cd2007-08-21 19:33:56 +0000655 assert( sqlite3_mutex_held(db->mutex) );
drhb1ab8ea2007-08-29 00:33:07 +0000656 rc = sqlite3LockAndPrepare(db, zSql, -1, 0, &pNew, 0);
drhb900aaf2006-11-09 00:24:53 +0000657 if( rc ){
danielk19778e556522007-11-13 10:30:24 +0000658 if( rc==SQLITE_NOMEM ){
659 db->mallocFailed = 1;
660 }
drhb900aaf2006-11-09 00:24:53 +0000661 assert( pNew==0 );
662 return 0;
663 }else{
664 assert( pNew!=0 );
665 }
drh4f0c5872007-03-26 22:05:01 +0000666 sqlite3VdbeSwap((Vdbe*)pNew, p);
667 sqlite3_transfer_bindings(pNew, (sqlite3_stmt*)p);
668 sqlite3VdbeResetStepResult((Vdbe*)pNew);
669 sqlite3VdbeFinalize((Vdbe*)pNew);
drhb900aaf2006-11-09 00:24:53 +0000670 return 1;
671}
672
673
674/*
675** Two versions of the official API. Legacy and new use. In the legacy
676** version, the original SQL text is not saved in the prepared statement
677** and so if a schema change occurs, SQLITE_SCHEMA is returned by
678** sqlite3_step(). In the new version, the original SQL text is retained
679** and the statement is automatically recompiled if an schema change
680** occurs.
681*/
682int sqlite3_prepare(
683 sqlite3 *db, /* Database handle. */
684 const char *zSql, /* UTF-8 encoded SQL statement. */
685 int nBytes, /* Length of zSql in bytes. */
686 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
687 const char **pzTail /* OUT: End of parsed string */
688){
drh17eaae72008-03-03 18:47:28 +0000689 int rc;
690 rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000691 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000692 return rc;
drhb900aaf2006-11-09 00:24:53 +0000693}
694int sqlite3_prepare_v2(
695 sqlite3 *db, /* Database handle. */
696 const char *zSql, /* UTF-8 encoded SQL statement. */
697 int nBytes, /* Length of zSql in bytes. */
698 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
699 const char **pzTail /* OUT: End of parsed string */
700){
drh17eaae72008-03-03 18:47:28 +0000701 int rc;
702 rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000703 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000704 return rc;
drhb900aaf2006-11-09 00:24:53 +0000705}
706
707
danielk1977fa256a32005-05-25 04:11:56 +0000708#ifndef SQLITE_OMIT_UTF16
709/*
710** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
711*/
drhb900aaf2006-11-09 00:24:53 +0000712static int sqlite3Prepare16(
danielk1977fa256a32005-05-25 04:11:56 +0000713 sqlite3 *db, /* Database handle. */
714 const void *zSql, /* UTF-8 encoded SQL statement. */
715 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000716 int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000717 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
718 const void **pzTail /* OUT: End of parsed string */
719){
720 /* This function currently works by first transforming the UTF-16
721 ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
722 ** tricky bit is figuring out the pointer to return in *pzTail.
723 */
danielk197754f01982006-01-18 15:25:17 +0000724 char *zSql8;
danielk1977c87d34d2006-01-06 13:00:28 +0000725 const char *zTail8 = 0;
danielk197754f01982006-01-18 15:25:17 +0000726 int rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000727
drh7e8b8482008-01-23 03:03:05 +0000728 if( !sqlite3SafetyCheckOk(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000729 return SQLITE_MISUSE;
730 }
drhb21c8cd2007-08-21 19:33:56 +0000731 sqlite3_mutex_enter(db->mutex);
danielk19771e536952007-08-16 10:09:01 +0000732 zSql8 = sqlite3Utf16to8(db, zSql, nBytes);
danielk197754f01982006-01-18 15:25:17 +0000733 if( zSql8 ){
drhb1ab8ea2007-08-29 00:33:07 +0000734 rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, ppStmt, &zTail8);
danielk1977fa256a32005-05-25 04:11:56 +0000735 }
danielk1977fa256a32005-05-25 04:11:56 +0000736
737 if( zTail8 && pzTail ){
738 /* If sqlite3_prepare returns a tail pointer, we calculate the
739 ** equivalent pointer into the UTF-16 string by counting the unicode
740 ** characters between zSql8 and zTail8, and then returning a pointer
741 ** the same number of characters into the UTF-16 string.
742 */
drhee858132007-05-08 20:37:38 +0000743 int chars_parsed = sqlite3Utf8CharLen(zSql8, zTail8-zSql8);
744 *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
danielk1977fa256a32005-05-25 04:11:56 +0000745 }
drh17435752007-08-16 04:30:38 +0000746 sqlite3_free(zSql8);
drhb21c8cd2007-08-21 19:33:56 +0000747 rc = sqlite3ApiExit(db, rc);
748 sqlite3_mutex_leave(db->mutex);
749 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000750}
drhb900aaf2006-11-09 00:24:53 +0000751
752/*
753** Two versions of the official API. Legacy and new use. In the legacy
754** version, the original SQL text is not saved in the prepared statement
755** and so if a schema change occurs, SQLITE_SCHEMA is returned by
756** sqlite3_step(). In the new version, the original SQL text is retained
757** and the statement is automatically recompiled if an schema change
758** occurs.
759*/
760int sqlite3_prepare16(
761 sqlite3 *db, /* Database handle. */
762 const void *zSql, /* UTF-8 encoded SQL statement. */
763 int nBytes, /* Length of zSql in bytes. */
764 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
765 const void **pzTail /* OUT: End of parsed string */
766){
drh17eaae72008-03-03 18:47:28 +0000767 int rc;
768 rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000769 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000770 return rc;
drhb900aaf2006-11-09 00:24:53 +0000771}
772int sqlite3_prepare16_v2(
773 sqlite3 *db, /* Database handle. */
774 const void *zSql, /* UTF-8 encoded SQL statement. */
775 int nBytes, /* Length of zSql in bytes. */
776 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
777 const void **pzTail /* OUT: End of parsed string */
778){
drh17eaae72008-03-03 18:47:28 +0000779 int rc;
780 rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000781 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000782 return rc;
drhb900aaf2006-11-09 00:24:53 +0000783}
784
danielk1977fa256a32005-05-25 04:11:56 +0000785#endif /* SQLITE_OMIT_UTF16 */