xref: /sqlite-3.40.0/src/prepare.c (revision 6695f47e)
1 /*
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 */
16 #include "sqliteInt.h"
17 
18 /*
19 ** Fill the InitData structure with an error message that indicates
20 ** that the database is corrupt.
21 */
22 static void corruptSchema(
23   InitData *pData,     /* Initialization context */
24   const char *zObj,    /* Object being parsed at the point of error */
25   const char *zExtra   /* Error information */
26 ){
27   sqlite3 *db = pData->db;
28   if( !db->mallocFailed && (db->flags & SQLITE_RecoveryMode)==0 ){
29     if( zObj==0 ) zObj = "?";
30     sqlite3SetString(pData->pzErrMsg, db,
31       "malformed database schema (%s)", zObj);
32     if( zExtra ){
33       *pData->pzErrMsg = sqlite3MAppendf(db, *pData->pzErrMsg,
34                                  "%s - %s", *pData->pzErrMsg, zExtra);
35     }
36   }
37   pData->rc = db->mallocFailed ? SQLITE_NOMEM : SQLITE_CORRUPT;
38 }
39 
40 /*
41 ** This is the callback routine for the code that initializes the
42 ** database.  See sqlite3Init() below for additional information.
43 ** This routine is also called from the OP_ParseSchema opcode of the VDBE.
44 **
45 ** Each callback contains the following information:
46 **
47 **     argv[0] = name of thing being created
48 **     argv[1] = root page number for table or index. 0 for trigger or view.
49 **     argv[2] = SQL text for the CREATE statement.
50 **
51 */
52 int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
53   InitData *pData = (InitData*)pInit;
54   sqlite3 *db = pData->db;
55   int iDb = pData->iDb;
56 
57   assert( argc==3 );
58   UNUSED_PARAMETER2(NotUsed, argc);
59   assert( sqlite3_mutex_held(db->mutex) );
60   DbClearProperty(db, iDb, DB_Empty);
61   if( db->mallocFailed ){
62     corruptSchema(pData, argv[0], 0);
63     return 1;
64   }
65 
66   assert( iDb>=0 && iDb<db->nDb );
67   if( argv==0 ) return 0;   /* Might happen if EMPTY_RESULT_CALLBACKS are on */
68   if( argv[1]==0 ){
69     corruptSchema(pData, argv[0], 0);
70   }else 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     db->init.orphanTrigger = 0;
82     rc = sqlite3_exec(db, argv[2], 0, 0, &zErr);
83     db->init.iDb = 0;
84     assert( rc!=SQLITE_OK || zErr==0 );
85     if( SQLITE_OK!=rc ){
86       if( db->init.orphanTrigger ){
87         assert( iDb==1 );
88       }else{
89         pData->rc = rc;
90         if( rc==SQLITE_NOMEM ){
91           db->mallocFailed = 1;
92         }else if( rc!=SQLITE_INTERRUPT && rc!=SQLITE_LOCKED ){
93           corruptSchema(pData, argv[0], zErr);
94         }
95       }
96       sqlite3DbFree(db, zErr);
97     }
98   }else if( argv[0]==0 ){
99     corruptSchema(pData, 0, 0);
100   }else{
101     /* If the SQL column is blank it means this is an index that
102     ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
103     ** constraint for a CREATE TABLE.  The index should have already
104     ** been created when we processed the CREATE TABLE.  All we have
105     ** to do here is record the root page number for that index.
106     */
107     Index *pIndex;
108     pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zName);
109     if( pIndex==0 ){
110       /* This can occur if there exists an index on a TEMP table which
111       ** has the same name as another index on a permanent index.  Since
112       ** the permanent table is hidden by the TEMP table, we can also
113       ** safely ignore the index on the permanent table.
114       */
115       /* Do Nothing */;
116     }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
117       corruptSchema(pData, argv[0], "invalid rootpage");
118     }
119   }
120   return 0;
121 }
122 
123 /*
124 ** Attempt to read the database schema and initialize internal
125 ** data structures for a single database file.  The index of the
126 ** database file is given by iDb.  iDb==0 is used for the main
127 ** database.  iDb==1 should never be used.  iDb>=2 is used for
128 ** auxiliary databases.  Return one of the SQLITE_ error codes to
129 ** indicate success or failure.
130 */
131 static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
132   int rc;
133   int i;
134   int size;
135   Table *pTab;
136   Db *pDb;
137   char const *azArg[4];
138   int meta[5];
139   InitData initData;
140   char const *zMasterSchema;
141   char const *zMasterName = SCHEMA_TABLE(iDb);
142   int openedTransaction = 0;
143 
144   /*
145   ** The master database table has a structure like this
146   */
147   static const char master_schema[] =
148      "CREATE TABLE sqlite_master(\n"
149      "  type text,\n"
150      "  name text,\n"
151      "  tbl_name text,\n"
152      "  rootpage integer,\n"
153      "  sql text\n"
154      ")"
155   ;
156 #ifndef SQLITE_OMIT_TEMPDB
157   static const char temp_master_schema[] =
158      "CREATE TEMP TABLE sqlite_temp_master(\n"
159      "  type text,\n"
160      "  name text,\n"
161      "  tbl_name text,\n"
162      "  rootpage integer,\n"
163      "  sql text\n"
164      ")"
165   ;
166 #else
167   #define temp_master_schema 0
168 #endif
169 
170   assert( iDb>=0 && iDb<db->nDb );
171   assert( db->aDb[iDb].pSchema );
172   assert( sqlite3_mutex_held(db->mutex) );
173   assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
174 
175   /* zMasterSchema and zInitScript are set to point at the master schema
176   ** and initialisation script appropriate for the database being
177   ** initialised. zMasterName is the name of the master table.
178   */
179   if( !OMIT_TEMPDB && iDb==1 ){
180     zMasterSchema = temp_master_schema;
181   }else{
182     zMasterSchema = master_schema;
183   }
184   zMasterName = SCHEMA_TABLE(iDb);
185 
186   /* Construct the schema tables.  */
187   azArg[0] = zMasterName;
188   azArg[1] = "1";
189   azArg[2] = zMasterSchema;
190   azArg[3] = 0;
191   initData.db = db;
192   initData.iDb = iDb;
193   initData.rc = SQLITE_OK;
194   initData.pzErrMsg = pzErrMsg;
195   (void)sqlite3SafetyOff(db);
196   sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
197   (void)sqlite3SafetyOn(db);
198   if( initData.rc ){
199     rc = initData.rc;
200     goto error_out;
201   }
202   pTab = sqlite3FindTable(db, zMasterName, db->aDb[iDb].zName);
203   if( ALWAYS(pTab) ){
204     pTab->tabFlags |= TF_Readonly;
205   }
206 
207   /* Create a cursor to hold the database open
208   */
209   pDb = &db->aDb[iDb];
210   if( pDb->pBt==0 ){
211     if( !OMIT_TEMPDB && ALWAYS(iDb==1) ){
212       DbSetProperty(db, 1, DB_SchemaLoaded);
213     }
214     return SQLITE_OK;
215   }
216 
217   /* If there is not already a read-only (or read-write) transaction opened
218   ** on the b-tree database, open one now. If a transaction is opened, it
219   ** will be closed before this function returns.  */
220   sqlite3BtreeEnter(pDb->pBt);
221   if( !sqlite3BtreeIsInReadTrans(pDb->pBt) ){
222     rc = sqlite3BtreeBeginTrans(pDb->pBt, 0);
223     if( rc!=SQLITE_OK ){
224       sqlite3SetString(pzErrMsg, db, "%s", sqlite3ErrStr(rc));
225       goto initone_error_out;
226     }
227     openedTransaction = 1;
228   }
229 
230   /* Get the database meta information.
231   **
232   ** Meta values are as follows:
233   **    meta[0]   Schema cookie.  Changes with each schema change.
234   **    meta[1]   File format of schema layer.
235   **    meta[2]   Size of the page cache.
236   **    meta[3]   Largest rootpage (auto/incr_vacuum mode)
237   **    meta[4]   Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
238   **    meta[5]   User version
239   **    meta[6]   Incremental vacuum mode
240   **    meta[7]   unused
241   **    meta[8]   unused
242   **    meta[9]   unused
243   **
244   ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
245   ** the possible values of meta[4].
246   */
247   for(i=0; i<ArraySize(meta); i++){
248     sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
249   }
250   pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
251 
252   /* If opening a non-empty database, check the text encoding. For the
253   ** main database, set sqlite3.enc to the encoding of the main database.
254   ** For an attached db, it is an error if the encoding is not the same
255   ** as sqlite3.enc.
256   */
257   if( meta[BTREE_TEXT_ENCODING-1] ){  /* text encoding */
258     if( iDb==0 ){
259       u8 encoding;
260       /* If opening the main database, set ENC(db). */
261       encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
262       if( encoding==0 ) encoding = SQLITE_UTF8;
263       ENC(db) = encoding;
264       db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
265     }else{
266       /* If opening an attached database, the encoding much match ENC(db) */
267       if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
268         sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
269             " text encoding as main database");
270         rc = SQLITE_ERROR;
271         goto initone_error_out;
272       }
273     }
274   }else{
275     DbSetProperty(db, iDb, DB_Empty);
276   }
277   pDb->pSchema->enc = ENC(db);
278 
279   if( pDb->pSchema->cache_size==0 ){
280     size = meta[BTREE_DEFAULT_CACHE_SIZE-1];
281     if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
282     if( size<0 ) size = -size;
283     pDb->pSchema->cache_size = size;
284     sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
285   }
286 
287   /*
288   ** file_format==1    Version 3.0.0.
289   ** file_format==2    Version 3.1.3.  // ALTER TABLE ADD COLUMN
290   ** file_format==3    Version 3.1.4.  // ditto but with non-NULL defaults
291   ** file_format==4    Version 3.3.0.  // DESC indices.  Boolean constants
292   */
293   pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
294   if( pDb->pSchema->file_format==0 ){
295     pDb->pSchema->file_format = 1;
296   }
297   if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
298     sqlite3SetString(pzErrMsg, db, "unsupported file format");
299     rc = SQLITE_ERROR;
300     goto initone_error_out;
301   }
302 
303   /* Ticket #2804:  When we open a database in the newer file format,
304   ** clear the legacy_file_format pragma flag so that a VACUUM will
305   ** not downgrade the database and thus invalidate any descending
306   ** indices that the user might have created.
307   */
308   if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
309     db->flags &= ~SQLITE_LegacyFileFmt;
310   }
311 
312   /* Read the schema information out of the schema tables
313   */
314   assert( db->init.busy );
315   {
316     char *zSql;
317     zSql = sqlite3MPrintf(db,
318         "SELECT name, rootpage, sql FROM '%q'.%s",
319         db->aDb[iDb].zName, zMasterName);
320     (void)sqlite3SafetyOff(db);
321 #ifndef SQLITE_OMIT_AUTHORIZATION
322     {
323       int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
324       xAuth = db->xAuth;
325       db->xAuth = 0;
326 #endif
327       rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
328 #ifndef SQLITE_OMIT_AUTHORIZATION
329       db->xAuth = xAuth;
330     }
331 #endif
332     if( rc==SQLITE_OK ) rc = initData.rc;
333     (void)sqlite3SafetyOn(db);
334     sqlite3DbFree(db, zSql);
335 #ifndef SQLITE_OMIT_ANALYZE
336     if( rc==SQLITE_OK ){
337       sqlite3AnalysisLoad(db, iDb);
338     }
339 #endif
340   }
341   if( db->mallocFailed ){
342     rc = SQLITE_NOMEM;
343     sqlite3ResetInternalSchema(db, 0);
344   }
345   if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
346     /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
347     ** the schema loaded, even if errors occurred. In this situation the
348     ** current sqlite3_prepare() operation will fail, but the following one
349     ** will attempt to compile the supplied statement against whatever subset
350     ** of the schema was loaded before the error occurred. The primary
351     ** purpose of this is to allow access to the sqlite_master table
352     ** even when its contents have been corrupted.
353     */
354     DbSetProperty(db, iDb, DB_SchemaLoaded);
355     rc = SQLITE_OK;
356   }
357 
358   /* Jump here for an error that occurs after successfully allocating
359   ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
360   ** before that point, jump to error_out.
361   */
362 initone_error_out:
363   if( openedTransaction ){
364     sqlite3BtreeCommit(pDb->pBt);
365   }
366   sqlite3BtreeLeave(pDb->pBt);
367 
368 error_out:
369   if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
370     db->mallocFailed = 1;
371   }
372   return rc;
373 }
374 
375 /*
376 ** Initialize all database files - the main database file, the file
377 ** used to store temporary tables, and any additional database files
378 ** created using ATTACH statements.  Return a success code.  If an
379 ** error occurs, write an error message into *pzErrMsg.
380 **
381 ** After a database is initialized, the DB_SchemaLoaded bit is set
382 ** bit is set in the flags field of the Db structure. If the database
383 ** file was of zero-length, then the DB_Empty flag is also set.
384 */
385 int sqlite3Init(sqlite3 *db, char **pzErrMsg){
386   int i, rc;
387   int commit_internal = !(db->flags&SQLITE_InternChanges);
388 
389   assert( sqlite3_mutex_held(db->mutex) );
390   rc = SQLITE_OK;
391   db->init.busy = 1;
392   for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
393     if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
394     rc = sqlite3InitOne(db, i, pzErrMsg);
395     if( rc ){
396       sqlite3ResetInternalSchema(db, i);
397     }
398   }
399 
400   /* Once all the other databases have been initialised, load the schema
401   ** for the TEMP database. This is loaded last, as the TEMP database
402   ** schema may contain references to objects in other databases.
403   */
404 #ifndef SQLITE_OMIT_TEMPDB
405   if( rc==SQLITE_OK && ALWAYS(db->nDb>1)
406                     && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
407     rc = sqlite3InitOne(db, 1, pzErrMsg);
408     if( rc ){
409       sqlite3ResetInternalSchema(db, 1);
410     }
411   }
412 #endif
413 
414   db->init.busy = 0;
415   if( rc==SQLITE_OK && commit_internal ){
416     sqlite3CommitInternalChanges(db);
417   }
418 
419   return rc;
420 }
421 
422 /*
423 ** This routine is a no-op if the database schema is already initialised.
424 ** Otherwise, the schema is loaded. An error code is returned.
425 */
426 int sqlite3ReadSchema(Parse *pParse){
427   int rc = SQLITE_OK;
428   sqlite3 *db = pParse->db;
429   assert( sqlite3_mutex_held(db->mutex) );
430   if( !db->init.busy ){
431     rc = sqlite3Init(db, &pParse->zErrMsg);
432   }
433   if( rc!=SQLITE_OK ){
434     pParse->rc = rc;
435     pParse->nErr++;
436   }
437   return rc;
438 }
439 
440 
441 /*
442 ** Check schema cookies in all databases.  If any cookie is out
443 ** of date set pParse->rc to SQLITE_SCHEMA.  If all schema cookies
444 ** make no changes to pParse->rc.
445 */
446 static void schemaIsValid(Parse *pParse){
447   sqlite3 *db = pParse->db;
448   int iDb;
449   int rc;
450   int cookie;
451 
452   assert( pParse->checkSchema );
453   assert( sqlite3_mutex_held(db->mutex) );
454   for(iDb=0; iDb<db->nDb; iDb++){
455     int openedTransaction = 0;         /* True if a transaction is opened */
456     Btree *pBt = db->aDb[iDb].pBt;     /* Btree database to read cookie from */
457     if( pBt==0 ) continue;
458 
459     /* If there is not already a read-only (or read-write) transaction opened
460     ** on the b-tree database, open one now. If a transaction is opened, it
461     ** will be closed immediately after reading the meta-value. */
462     if( !sqlite3BtreeIsInReadTrans(pBt) ){
463       rc = sqlite3BtreeBeginTrans(pBt, 0);
464       if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
465         db->mallocFailed = 1;
466       }
467       if( rc!=SQLITE_OK ) return;
468       openedTransaction = 1;
469     }
470 
471     /* Read the schema cookie from the database. If it does not match the
472     ** value stored as part of the in the in-memory schema representation,
473     ** set Parse.rc to SQLITE_SCHEMA. */
474     sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
475     if( cookie!=db->aDb[iDb].pSchema->schema_cookie ){
476       pParse->rc = SQLITE_SCHEMA;
477     }
478 
479     /* Close the transaction, if one was opened. */
480     if( openedTransaction ){
481       sqlite3BtreeCommit(pBt);
482     }
483   }
484 }
485 
486 /*
487 ** Convert a schema pointer into the iDb index that indicates
488 ** which database file in db->aDb[] the schema refers to.
489 **
490 ** If the same database is attached more than once, the first
491 ** attached database is returned.
492 */
493 int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
494   int i = -1000000;
495 
496   /* If pSchema is NULL, then return -1000000. This happens when code in
497   ** expr.c is trying to resolve a reference to a transient table (i.e. one
498   ** created by a sub-select). In this case the return value of this
499   ** function should never be used.
500   **
501   ** We return -1000000 instead of the more usual -1 simply because using
502   ** -1000000 as the incorrect index into db->aDb[] is much
503   ** more likely to cause a segfault than -1 (of course there are assert()
504   ** statements too, but it never hurts to play the odds).
505   */
506   assert( sqlite3_mutex_held(db->mutex) );
507   if( pSchema ){
508     for(i=0; ALWAYS(i<db->nDb); i++){
509       if( db->aDb[i].pSchema==pSchema ){
510         break;
511       }
512     }
513     assert( i>=0 && i<db->nDb );
514   }
515   return i;
516 }
517 
518 /*
519 ** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
520 */
521 static int sqlite3Prepare(
522   sqlite3 *db,              /* Database handle. */
523   const char *zSql,         /* UTF-8 encoded SQL statement. */
524   int nBytes,               /* Length of zSql in bytes. */
525   int saveSqlFlag,          /* True to copy SQL text into the sqlite3_stmt */
526   Vdbe *pReprepare,         /* VM being reprepared */
527   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
528   const char **pzTail       /* OUT: End of parsed string */
529 ){
530   Parse *pParse;            /* Parsing context */
531   char *zErrMsg = 0;        /* Error message */
532   int rc = SQLITE_OK;       /* Result code */
533   int i;                    /* Loop counter */
534 
535   /* Allocate the parsing context */
536   pParse = sqlite3StackAllocZero(db, sizeof(*pParse));
537   if( pParse==0 ){
538     rc = SQLITE_NOMEM;
539     goto end_prepare;
540   }
541   pParse->pReprepare = pReprepare;
542 
543   if( sqlite3SafetyOn(db) ){
544     rc = SQLITE_MISUSE;
545     goto end_prepare;
546   }
547   assert( ppStmt && *ppStmt==0 );
548   assert( !db->mallocFailed );
549   assert( sqlite3_mutex_held(db->mutex) );
550 
551   /* Check to verify that it is possible to get a read lock on all
552   ** database schemas.  The inability to get a read lock indicates that
553   ** some other database connection is holding a write-lock, which in
554   ** turn means that the other connection has made uncommitted changes
555   ** to the schema.
556   **
557   ** Were we to proceed and prepare the statement against the uncommitted
558   ** schema changes and if those schema changes are subsequently rolled
559   ** back and different changes are made in their place, then when this
560   ** prepared statement goes to run the schema cookie would fail to detect
561   ** the schema change.  Disaster would follow.
562   **
563   ** This thread is currently holding mutexes on all Btrees (because
564   ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
565   ** is not possible for another thread to start a new schema change
566   ** while this routine is running.  Hence, we do not need to hold
567   ** locks on the schema, we just need to make sure nobody else is
568   ** holding them.
569   **
570   ** Note that setting READ_UNCOMMITTED overrides most lock detection,
571   ** but it does *not* override schema lock detection, so this all still
572   ** works even if READ_UNCOMMITTED is set.
573   */
574   for(i=0; i<db->nDb; i++) {
575     Btree *pBt = db->aDb[i].pBt;
576     if( pBt ){
577       assert( sqlite3BtreeHoldsMutex(pBt) );
578       rc = sqlite3BtreeSchemaLocked(pBt);
579       if( rc ){
580         const char *zDb = db->aDb[i].zName;
581         sqlite3Error(db, rc, "database schema is locked: %s", zDb);
582         (void)sqlite3SafetyOff(db);
583         testcase( db->flags & SQLITE_ReadUncommitted );
584         goto end_prepare;
585       }
586     }
587   }
588 
589   sqlite3VtabUnlockList(db);
590 
591   pParse->db = db;
592   if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
593     char *zSqlCopy;
594     int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
595     testcase( nBytes==mxLen );
596     testcase( nBytes==mxLen+1 );
597     if( nBytes>mxLen ){
598       sqlite3Error(db, SQLITE_TOOBIG, "statement too long");
599       (void)sqlite3SafetyOff(db);
600       rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
601       goto end_prepare;
602     }
603     zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
604     if( zSqlCopy ){
605       sqlite3RunParser(pParse, zSqlCopy, &zErrMsg);
606       sqlite3DbFree(db, zSqlCopy);
607       pParse->zTail = &zSql[pParse->zTail-zSqlCopy];
608     }else{
609       pParse->zTail = &zSql[nBytes];
610     }
611   }else{
612     sqlite3RunParser(pParse, zSql, &zErrMsg);
613   }
614 
615   if( db->mallocFailed ){
616     pParse->rc = SQLITE_NOMEM;
617   }
618   if( pParse->rc==SQLITE_DONE ) pParse->rc = SQLITE_OK;
619   if( pParse->checkSchema ){
620     schemaIsValid(pParse);
621   }
622   if( pParse->rc==SQLITE_SCHEMA ){
623     sqlite3ResetInternalSchema(db, 0);
624   }
625   if( db->mallocFailed ){
626     pParse->rc = SQLITE_NOMEM;
627   }
628   if( pzTail ){
629     *pzTail = pParse->zTail;
630   }
631   rc = pParse->rc;
632 
633 #ifndef SQLITE_OMIT_EXPLAIN
634   if( rc==SQLITE_OK && pParse->pVdbe && pParse->explain ){
635     static const char * const azColName[] = {
636        "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
637        "order", "from", "detail"
638     };
639     int iFirst, mx;
640     if( pParse->explain==2 ){
641       sqlite3VdbeSetNumCols(pParse->pVdbe, 3);
642       iFirst = 8;
643       mx = 11;
644     }else{
645       sqlite3VdbeSetNumCols(pParse->pVdbe, 8);
646       iFirst = 0;
647       mx = 8;
648     }
649     for(i=iFirst; i<mx; i++){
650       sqlite3VdbeSetColName(pParse->pVdbe, i-iFirst, COLNAME_NAME,
651                             azColName[i], SQLITE_STATIC);
652     }
653   }
654 #endif
655 
656   if( sqlite3SafetyOff(db) ){
657     rc = SQLITE_MISUSE;
658   }
659 
660   assert( db->init.busy==0 || saveSqlFlag==0 );
661   if( db->init.busy==0 ){
662     Vdbe *pVdbe = pParse->pVdbe;
663     sqlite3VdbeSetSql(pVdbe, zSql, (int)(pParse->zTail-zSql), saveSqlFlag);
664   }
665   if( pParse->pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
666     sqlite3VdbeFinalize(pParse->pVdbe);
667     assert(!(*ppStmt));
668   }else{
669     *ppStmt = (sqlite3_stmt*)pParse->pVdbe;
670   }
671 
672   if( zErrMsg ){
673     sqlite3Error(db, rc, "%s", zErrMsg);
674     sqlite3DbFree(db, zErrMsg);
675   }else{
676     sqlite3Error(db, rc, 0);
677   }
678 
679   /* Delete any TriggerPrg structures allocated while parsing this statement. */
680   while( pParse->pTriggerPrg ){
681     TriggerPrg *pT = pParse->pTriggerPrg;
682     pParse->pTriggerPrg = pT->pNext;
683     sqlite3VdbeProgramDelete(db, pT->pProgram, 0);
684     sqlite3DbFree(db, pT);
685   }
686 
687 end_prepare:
688 
689   sqlite3StackFree(db, pParse);
690   rc = sqlite3ApiExit(db, rc);
691   assert( (rc&db->errMask)==rc );
692   return rc;
693 }
694 static int sqlite3LockAndPrepare(
695   sqlite3 *db,              /* Database handle. */
696   const char *zSql,         /* UTF-8 encoded SQL statement. */
697   int nBytes,               /* Length of zSql in bytes. */
698   int saveSqlFlag,          /* True to copy SQL text into the sqlite3_stmt */
699   Vdbe *pOld,               /* VM being reprepared */
700   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
701   const char **pzTail       /* OUT: End of parsed string */
702 ){
703   int rc;
704   assert( ppStmt!=0 );
705   *ppStmt = 0;
706   if( !sqlite3SafetyCheckOk(db) ){
707     return SQLITE_MISUSE;
708   }
709   sqlite3_mutex_enter(db->mutex);
710   sqlite3BtreeEnterAll(db);
711   rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
712   if( rc==SQLITE_SCHEMA ){
713     sqlite3_finalize(*ppStmt);
714     rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
715   }
716   sqlite3BtreeLeaveAll(db);
717   sqlite3_mutex_leave(db->mutex);
718   return rc;
719 }
720 
721 /*
722 ** Rerun the compilation of a statement after a schema change.
723 **
724 ** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
725 ** if the statement cannot be recompiled because another connection has
726 ** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
727 ** occurs, return SQLITE_SCHEMA.
728 */
729 int sqlite3Reprepare(Vdbe *p){
730   int rc;
731   sqlite3_stmt *pNew;
732   const char *zSql;
733   sqlite3 *db;
734 
735   assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
736   zSql = sqlite3_sql((sqlite3_stmt *)p);
737   assert( zSql!=0 );  /* Reprepare only called for prepare_v2() statements */
738   db = sqlite3VdbeDb(p);
739   assert( sqlite3_mutex_held(db->mutex) );
740   rc = sqlite3LockAndPrepare(db, zSql, -1, 0, p, &pNew, 0);
741   if( rc ){
742     if( rc==SQLITE_NOMEM ){
743       db->mallocFailed = 1;
744     }
745     assert( pNew==0 );
746     return (rc==SQLITE_LOCKED) ? SQLITE_LOCKED : SQLITE_SCHEMA;
747   }else{
748     assert( pNew!=0 );
749   }
750   sqlite3VdbeSwap((Vdbe*)pNew, p);
751   sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
752   sqlite3VdbeResetStepResult((Vdbe*)pNew);
753   sqlite3VdbeFinalize((Vdbe*)pNew);
754   return SQLITE_OK;
755 }
756 
757 
758 /*
759 ** Two versions of the official API.  Legacy and new use.  In the legacy
760 ** version, the original SQL text is not saved in the prepared statement
761 ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
762 ** sqlite3_step().  In the new version, the original SQL text is retained
763 ** and the statement is automatically recompiled if an schema change
764 ** occurs.
765 */
766 int sqlite3_prepare(
767   sqlite3 *db,              /* Database handle. */
768   const char *zSql,         /* UTF-8 encoded SQL statement. */
769   int nBytes,               /* Length of zSql in bytes. */
770   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
771   const char **pzTail       /* OUT: End of parsed string */
772 ){
773   int rc;
774   rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,0,ppStmt,pzTail);
775   assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );  /* VERIFY: F13021 */
776   return rc;
777 }
778 int sqlite3_prepare_v2(
779   sqlite3 *db,              /* Database handle. */
780   const char *zSql,         /* UTF-8 encoded SQL statement. */
781   int nBytes,               /* Length of zSql in bytes. */
782   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
783   const char **pzTail       /* OUT: End of parsed string */
784 ){
785   int rc;
786   rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,0,ppStmt,pzTail);
787   assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );  /* VERIFY: F13021 */
788   return rc;
789 }
790 
791 
792 #ifndef SQLITE_OMIT_UTF16
793 /*
794 ** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
795 */
796 static int sqlite3Prepare16(
797   sqlite3 *db,              /* Database handle. */
798   const void *zSql,         /* UTF-8 encoded SQL statement. */
799   int nBytes,               /* Length of zSql in bytes. */
800   int saveSqlFlag,          /* True to save SQL text into the sqlite3_stmt */
801   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
802   const void **pzTail       /* OUT: End of parsed string */
803 ){
804   /* This function currently works by first transforming the UTF-16
805   ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
806   ** tricky bit is figuring out the pointer to return in *pzTail.
807   */
808   char *zSql8;
809   const char *zTail8 = 0;
810   int rc = SQLITE_OK;
811 
812   assert( ppStmt );
813   *ppStmt = 0;
814   if( !sqlite3SafetyCheckOk(db) ){
815     return SQLITE_MISUSE;
816   }
817   sqlite3_mutex_enter(db->mutex);
818   zSql8 = sqlite3Utf16to8(db, zSql, nBytes);
819   if( zSql8 ){
820     rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, 0, ppStmt, &zTail8);
821   }
822 
823   if( zTail8 && pzTail ){
824     /* If sqlite3_prepare returns a tail pointer, we calculate the
825     ** equivalent pointer into the UTF-16 string by counting the unicode
826     ** characters between zSql8 and zTail8, and then returning a pointer
827     ** the same number of characters into the UTF-16 string.
828     */
829     int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
830     *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
831   }
832   sqlite3DbFree(db, zSql8);
833   rc = sqlite3ApiExit(db, rc);
834   sqlite3_mutex_leave(db->mutex);
835   return rc;
836 }
837 
838 /*
839 ** Two versions of the official API.  Legacy and new use.  In the legacy
840 ** version, the original SQL text is not saved in the prepared statement
841 ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
842 ** sqlite3_step().  In the new version, the original SQL text is retained
843 ** and the statement is automatically recompiled if an schema change
844 ** occurs.
845 */
846 int sqlite3_prepare16(
847   sqlite3 *db,              /* Database handle. */
848   const void *zSql,         /* UTF-8 encoded SQL statement. */
849   int nBytes,               /* Length of zSql in bytes. */
850   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
851   const void **pzTail       /* OUT: End of parsed string */
852 ){
853   int rc;
854   rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
855   assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );  /* VERIFY: F13021 */
856   return rc;
857 }
858 int sqlite3_prepare16_v2(
859   sqlite3 *db,              /* Database handle. */
860   const void *zSql,         /* UTF-8 encoded SQL statement. */
861   int nBytes,               /* Length of zSql in bytes. */
862   sqlite3_stmt **ppStmt,    /* OUT: A pointer to the prepared statement */
863   const void **pzTail       /* OUT: End of parsed string */
864 ){
865   int rc;
866   rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
867   assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );  /* VERIFY: F13021 */
868   return rc;
869 }
870 
871 #endif /* SQLITE_OMIT_UTF16 */
872