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