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