blob: 74127bc76b424e558709e100765c1a26cedbd6ef [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.
danielk1977fa256a32005-05-25 04:11:56 +000015*/
16#include "sqliteInt.h"
danielk1977fa256a32005-05-25 04:11:56 +000017
18/*
19** Fill the InitData structure with an error message that indicates
20** that the database is corrupt.
21*/
drh34533152008-03-19 13:03:33 +000022static 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){
drhc456e572008-08-11 18:44:58 +000027 sqlite3 *db = pData->db;
28 if( !db->mallocFailed && (db->flags & SQLITE_RecoveryMode)==0 ){
drh22c17b82015-05-15 04:13:15 +000029 char *z;
drh34533152008-03-19 13:03:33 +000030 if( zObj==0 ) zObj = "?";
drh17a936f2016-02-05 02:50:11 +000031 z = sqlite3MPrintf(db, "malformed database schema (%s)", zObj);
32 if( zExtra ) z = sqlite3MPrintf(db, "%z - %s", z, zExtra);
drh22c17b82015-05-15 04:13:15 +000033 sqlite3DbFree(db, *pData->pzErrMsg);
34 *pData->pzErrMsg = z;
danielk1977fa256a32005-05-25 04:11:56 +000035 }
mistachkinfad30392016-02-13 23:43:46 +000036 pData->rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_CORRUPT_BKPT;
danielk1977fa256a32005-05-25 04:11:56 +000037}
38
39/*
40** This is the callback routine for the code that initializes the
41** database. See sqlite3Init() below for additional information.
42** This routine is also called from the OP_ParseSchema opcode of the VDBE.
43**
44** Each callback contains the following information:
45**
46** argv[0] = name of thing being created
danielk197778efaba2006-06-12 06:09:17 +000047** argv[1] = root page number for table or index. 0 for trigger or view.
danielk1977fa256a32005-05-25 04:11:56 +000048** argv[2] = SQL text for the CREATE statement.
danielk1977fa256a32005-05-25 04:11:56 +000049**
50*/
danielk197762c14b32008-11-19 09:05:26 +000051int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
danielk1977fa256a32005-05-25 04:11:56 +000052 InitData *pData = (InitData*)pInit;
53 sqlite3 *db = pData->db;
drhece3c722006-09-23 20:36:01 +000054 int iDb = pData->iDb;
danielk1977fa256a32005-05-25 04:11:56 +000055
danielk1977f3d3c272008-11-19 16:52:44 +000056 assert( argc==3 );
57 UNUSED_PARAMETER2(NotUsed, argc);
drhb1ab8ea2007-08-29 00:33:07 +000058 assert( sqlite3_mutex_held(db->mutex) );
drhece3c722006-09-23 20:36:01 +000059 DbClearProperty(db, iDb, DB_Empty);
drh17435752007-08-16 04:30:38 +000060 if( db->mallocFailed ){
drh34533152008-03-19 13:03:33 +000061 corruptSchema(pData, argv[0], 0);
drh9da742f2009-06-16 17:49:36 +000062 return 1;
danielk1977da184232006-01-05 11:34:32 +000063 }
64
danielk1977ff9b2e72008-09-08 09:06:18 +000065 assert( iDb>=0 && iDb<db->nDb );
danielk1977fa256a32005-05-25 04:11:56 +000066 if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
drhece3c722006-09-23 20:36:01 +000067 if( argv[1]==0 ){
drh34533152008-03-19 13:03:33 +000068 corruptSchema(pData, argv[0], 0);
drh22ecef52015-04-16 00:26:03 +000069 }else if( sqlite3_strnicmp(argv[2],"create ",7)==0 ){
danielk1977fa256a32005-05-25 04:11:56 +000070 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
71 ** But because db->init.busy is set to 1, no VDBE code is generated
72 ** or executed. All the parser does is build the internal data
73 ** structures that describe the table, index, or view.
74 */
danielk1977fa256a32005-05-25 04:11:56 +000075 int rc;
drh9ef5e772016-08-19 14:20:56 +000076 u8 saved_iDb = db->init.iDb;
drh6498f0b2010-04-09 09:14:05 +000077 sqlite3_stmt *pStmt;
drh9e55d472010-07-06 09:29:01 +000078 TESTONLY(int rcp); /* Return code from sqlite3_prepare() */
drh6498f0b2010-04-09 09:14:05 +000079
danielk1977fa256a32005-05-25 04:11:56 +000080 assert( db->init.busy );
81 db->init.iDb = iDb;
drh60ac3f42010-11-23 18:59:27 +000082 db->init.newTnum = sqlite3Atoi(argv[1]);
drh3d5f74b2009-08-06 17:43:31 +000083 db->init.orphanTrigger = 0;
dan9859c422010-07-06 07:36:18 +000084 TESTONLY(rcp = ) sqlite3_prepare(db, argv[2], -1, &pStmt, 0);
85 rc = db->errCode;
86 assert( (rc&0xFF)==(rcp&0xFF) );
drh9ef5e772016-08-19 14:20:56 +000087 db->init.iDb = saved_iDb;
88 assert( saved_iDb==0 || (db->flags & SQLITE_Vacuum)!=0 );
danielk1977fa256a32005-05-25 04:11:56 +000089 if( SQLITE_OK!=rc ){
drh3d5f74b2009-08-06 17:43:31 +000090 if( db->init.orphanTrigger ){
91 assert( iDb==1 );
92 }else{
93 pData->rc = rc;
94 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +000095 sqlite3OomFault(db);
dan9859c422010-07-06 07:36:18 +000096 }else if( rc!=SQLITE_INTERRUPT && (rc&0xFF)!=SQLITE_LOCKED ){
drh6498f0b2010-04-09 09:14:05 +000097 corruptSchema(pData, argv[0], sqlite3_errmsg(db));
drh3d5f74b2009-08-06 17:43:31 +000098 }
danielk1977261919c2005-12-06 12:52:59 +000099 }
danielk1977fa256a32005-05-25 04:11:56 +0000100 }
drh6498f0b2010-04-09 09:14:05 +0000101 sqlite3_finalize(pStmt);
drh22ecef52015-04-16 00:26:03 +0000102 }else if( argv[0]==0 || (argv[2]!=0 && argv[2][0]!=0) ){
103 corruptSchema(pData, argv[0], 0);
danielk1977fa256a32005-05-25 04:11:56 +0000104 }else{
105 /* If the SQL column is blank it means this is an index that
106 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
107 ** constraint for a CREATE TABLE. The index should have already
108 ** been created when we processed the CREATE TABLE. All we have
109 ** to do here is record the root page number for that index.
110 */
111 Index *pIndex;
drh69c33822016-08-18 14:33:11 +0000112 pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zDbSName);
drh9da742f2009-06-16 17:49:36 +0000113 if( pIndex==0 ){
danielk1977fa256a32005-05-25 04:11:56 +0000114 /* This can occur if there exists an index on a TEMP table which
115 ** has the same name as another index on a permanent index. Since
116 ** the permanent table is hidden by the TEMP table, we can also
117 ** safely ignore the index on the permanent table.
118 */
119 /* Do Nothing */;
drh9da742f2009-06-16 17:49:36 +0000120 }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
121 corruptSchema(pData, argv[0], "invalid rootpage");
danielk1977fa256a32005-05-25 04:11:56 +0000122 }
123 }
124 return 0;
125}
126
127/*
128** Attempt to read the database schema and initialize internal
129** data structures for a single database file. The index of the
130** database file is given by iDb. iDb==0 is used for the main
131** database. iDb==1 should never be used. iDb>=2 is used for
132** auxiliary databases. Return one of the SQLITE_ error codes to
133** indicate success or failure.
134*/
135static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
136 int rc;
drh8a939192009-04-20 17:43:03 +0000137 int i;
mistachkinba2bba32012-09-18 23:21:32 +0000138#ifndef SQLITE_OMIT_DEPRECATED
danielk1977fa256a32005-05-25 04:11:56 +0000139 int size;
mistachkinba2bba32012-09-18 23:21:32 +0000140#endif
drhfdd6e852005-12-16 01:06:16 +0000141 Db *pDb;
drhece3c722006-09-23 20:36:01 +0000142 char const *azArg[4];
danielk19770d19f7a2009-06-03 11:25:07 +0000143 int meta[5];
danielk1977fa256a32005-05-25 04:11:56 +0000144 InitData initData;
drh055f2982016-01-15 15:06:41 +0000145 const char *zMasterName;
danielk197794b30732009-07-02 17:21:57 +0000146 int openedTransaction = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000147
danielk1977fa256a32005-05-25 04:11:56 +0000148 assert( iDb>=0 && iDb<db->nDb );
danielk197714db2662006-01-09 16:12:04 +0000149 assert( db->aDb[iDb].pSchema );
drhb1ab8ea2007-08-29 00:33:07 +0000150 assert( sqlite3_mutex_held(db->mutex) );
danielk19774eab8b72007-12-27 15:12:16 +0000151 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
danielk1977da184232006-01-05 11:34:32 +0000152
drh055f2982016-01-15 15:06:41 +0000153 /* Construct the in-memory representation schema tables (sqlite_master or
154 ** sqlite_temp_master) by invoking the parser directly. The appropriate
155 ** table name will be inserted automatically by the parser so we can just
156 ** use the abbreviation "x" here. The parser will also automatically tag
157 ** the schema table as read-only. */
158 azArg[0] = zMasterName = SCHEMA_TABLE(iDb);
danielk1977fa256a32005-05-25 04:11:56 +0000159 azArg[1] = "1";
drh055f2982016-01-15 15:06:41 +0000160 azArg[2] = "CREATE TABLE x(type text,name text,tbl_name text,"
161 "rootpage integer,sql text)";
drhece3c722006-09-23 20:36:01 +0000162 azArg[3] = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000163 initData.db = db;
drhece3c722006-09-23 20:36:01 +0000164 initData.iDb = iDb;
drhc456e572008-08-11 18:44:58 +0000165 initData.rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000166 initData.pzErrMsg = pzErrMsg;
drhc456e572008-08-11 18:44:58 +0000167 sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
drhc456e572008-08-11 18:44:58 +0000168 if( initData.rc ){
danielk1977a1644fd2007-08-29 12:31:25 +0000169 rc = initData.rc;
170 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000171 }
danielk1977fa256a32005-05-25 04:11:56 +0000172
173 /* Create a cursor to hold the database open
174 */
drhfdd6e852005-12-16 01:06:16 +0000175 pDb = &db->aDb[iDb];
176 if( pDb->pBt==0 ){
drh9da742f2009-06-16 17:49:36 +0000177 if( !OMIT_TEMPDB && ALWAYS(iDb==1) ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000178 DbSetProperty(db, 1, DB_SchemaLoaded);
179 }
danielk1977fa256a32005-05-25 04:11:56 +0000180 return SQLITE_OK;
181 }
danielk1977602b4662009-07-02 07:47:33 +0000182
183 /* If there is not already a read-only (or read-write) transaction opened
184 ** on the b-tree database, open one now. If a transaction is opened, it
185 ** will be closed before this function returns. */
drhb1ab8ea2007-08-29 00:33:07 +0000186 sqlite3BtreeEnter(pDb->pBt);
danielk1977602b4662009-07-02 07:47:33 +0000187 if( !sqlite3BtreeIsInReadTrans(pDb->pBt) ){
188 rc = sqlite3BtreeBeginTrans(pDb->pBt, 0);
189 if( rc!=SQLITE_OK ){
drh22c17b82015-05-15 04:13:15 +0000190 sqlite3SetString(pzErrMsg, db, sqlite3ErrStr(rc));
danielk1977602b4662009-07-02 07:47:33 +0000191 goto initone_error_out;
192 }
193 openedTransaction = 1;
danielk1977602b4662009-07-02 07:47:33 +0000194 }
danielk1977fa256a32005-05-25 04:11:56 +0000195
196 /* Get the database meta information.
197 **
198 ** Meta values are as follows:
199 ** meta[0] Schema cookie. Changes with each schema change.
200 ** meta[1] File format of schema layer.
201 ** meta[2] Size of the page cache.
drh27731d72009-06-22 12:05:10 +0000202 ** meta[3] Largest rootpage (auto/incr_vacuum mode)
drh8159a352006-05-23 23:22:29 +0000203 ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
drh27731d72009-06-22 12:05:10 +0000204 ** meta[5] User version
205 ** meta[6] Incremental vacuum mode
206 ** meta[7] unused
207 ** meta[8] unused
208 ** meta[9] unused
danielk1977fa256a32005-05-25 04:11:56 +0000209 **
drhf248e212006-01-25 22:50:38 +0000210 ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
danielk1977fa256a32005-05-25 04:11:56 +0000211 ** the possible values of meta[4].
212 */
danielk1977602b4662009-07-02 07:47:33 +0000213 for(i=0; i<ArraySize(meta); i++){
214 sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
danielk19770d19f7a2009-06-03 11:25:07 +0000215 }
216 pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
danielk1977fa256a32005-05-25 04:11:56 +0000217
218 /* If opening a non-empty database, check the text encoding. For the
219 ** main database, set sqlite3.enc to the encoding of the main database.
220 ** For an attached db, it is an error if the encoding is not the same
221 ** as sqlite3.enc.
222 */
danielk19770d19f7a2009-06-03 11:25:07 +0000223 if( meta[BTREE_TEXT_ENCODING-1] ){ /* text encoding */
danielk1977fa256a32005-05-25 04:11:56 +0000224 if( iDb==0 ){
dandbd4d5f2013-03-08 07:10:37 +0000225#ifndef SQLITE_OMIT_UTF16
drhc5e47ac2009-06-04 00:11:56 +0000226 u8 encoding;
danielk197714db2662006-01-09 16:12:04 +0000227 /* If opening the main database, set ENC(db). */
drhc5e47ac2009-06-04 00:11:56 +0000228 encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
229 if( encoding==0 ) encoding = SQLITE_UTF8;
230 ENC(db) = encoding;
dandbd4d5f2013-03-08 07:10:37 +0000231#else
232 ENC(db) = SQLITE_UTF8;
233#endif
danielk1977fa256a32005-05-25 04:11:56 +0000234 }else{
danielk197714db2662006-01-09 16:12:04 +0000235 /* If opening an attached database, the encoding much match ENC(db) */
danielk19770d19f7a2009-06-03 11:25:07 +0000236 if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
drhf089aa42008-07-08 19:34:06 +0000237 sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
238 " text encoding as main database");
danielk1977cd3e8f72008-03-25 09:47:35 +0000239 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000240 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000241 }
242 }
danielk1977b82e7ed2006-01-11 14:09:31 +0000243 }else{
244 DbSetProperty(db, iDb, DB_Empty);
danielk1977fa256a32005-05-25 04:11:56 +0000245 }
danielk197714db2662006-01-09 16:12:04 +0000246 pDb->pSchema->enc = ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000247
danielk19778cf6c552008-06-23 16:53:46 +0000248 if( pDb->pSchema->cache_size==0 ){
drhe73c9142011-11-09 16:12:24 +0000249#ifndef SQLITE_OMIT_DEPRECATED
drhd50ffc42011-03-08 02:38:28 +0000250 size = sqlite3AbsInt32(meta[BTREE_DEFAULT_CACHE_SIZE-1]);
danielk19778cf6c552008-06-23 16:53:46 +0000251 if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
danielk19778cf6c552008-06-23 16:53:46 +0000252 pDb->pSchema->cache_size = size;
drhe73c9142011-11-09 16:12:24 +0000253#else
254 pDb->pSchema->cache_size = SQLITE_DEFAULT_CACHE_SIZE;
255#endif
danielk19778cf6c552008-06-23 16:53:46 +0000256 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
257 }
danielk1977fa256a32005-05-25 04:11:56 +0000258
259 /*
260 ** file_format==1 Version 3.0.0.
drhfdd6e852005-12-16 01:06:16 +0000261 ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
262 ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
drhd946db02005-12-29 19:23:06 +0000263 ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
danielk1977fa256a32005-05-25 04:11:56 +0000264 */
danielk19770d19f7a2009-06-03 11:25:07 +0000265 pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
danielk1977da184232006-01-05 11:34:32 +0000266 if( pDb->pSchema->file_format==0 ){
267 pDb->pSchema->file_format = 1;
drhfdd6e852005-12-16 01:06:16 +0000268 }
danielk1977da184232006-01-05 11:34:32 +0000269 if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
drhf089aa42008-07-08 19:34:06 +0000270 sqlite3SetString(pzErrMsg, db, "unsupported file format");
danielk1977cd3e8f72008-03-25 09:47:35 +0000271 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000272 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000273 }
274
drh4aa2bfe2007-11-28 13:43:16 +0000275 /* Ticket #2804: When we open a database in the newer file format,
276 ** clear the legacy_file_format pragma flag so that a VACUUM will
277 ** not downgrade the database and thus invalidate any descending
278 ** indices that the user might have created.
279 */
danielk19770d19f7a2009-06-03 11:25:07 +0000280 if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
drh4aa2bfe2007-11-28 13:43:16 +0000281 db->flags &= ~SQLITE_LegacyFileFmt;
282 }
danielk1977fa256a32005-05-25 04:11:56 +0000283
284 /* Read the schema information out of the schema tables
285 */
286 assert( db->init.busy );
drh9da742f2009-06-16 17:49:36 +0000287 {
danielk1977fa256a32005-05-25 04:11:56 +0000288 char *zSql;
danielk19771e536952007-08-16 10:09:01 +0000289 zSql = sqlite3MPrintf(db,
drh055f2982016-01-15 15:06:41 +0000290 "SELECT name, rootpage, sql FROM \"%w\".%s ORDER BY rowid",
drh69c33822016-08-18 14:33:11 +0000291 db->aDb[iDb].zDbSName, zMasterName);
drha6d0ffc2007-10-12 20:42:28 +0000292#ifndef SQLITE_OMIT_AUTHORIZATION
293 {
drh32c6a482014-09-11 13:44:52 +0000294 sqlite3_xauth xAuth;
drha6d0ffc2007-10-12 20:42:28 +0000295 xAuth = db->xAuth;
296 db->xAuth = 0;
297#endif
298 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
299#ifndef SQLITE_OMIT_AUTHORIZATION
300 db->xAuth = xAuth;
301 }
302#endif
drhc456e572008-08-11 18:44:58 +0000303 if( rc==SQLITE_OK ) rc = initData.rc;
drh633e6d52008-07-28 19:34:53 +0000304 sqlite3DbFree(db, zSql);
drh497e4462005-07-23 03:18:40 +0000305#ifndef SQLITE_OMIT_ANALYZE
306 if( rc==SQLITE_OK ){
307 sqlite3AnalysisLoad(db, iDb);
308 }
309#endif
danielk1977fa256a32005-05-25 04:11:56 +0000310 }
drh17435752007-08-16 04:30:38 +0000311 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +0000312 rc = SQLITE_NOMEM_BKPT;
drh81028a42012-05-15 18:28:27 +0000313 sqlite3ResetAllSchemasOfConnection(db);
danielk1977fa256a32005-05-25 04:11:56 +0000314 }
danielk197734c68fb2007-03-14 15:37:04 +0000315 if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
316 /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
shanebe217792009-03-05 04:20:31 +0000317 ** the schema loaded, even if errors occurred. In this situation the
danielk197734c68fb2007-03-14 15:37:04 +0000318 ** current sqlite3_prepare() operation will fail, but the following one
319 ** will attempt to compile the supplied statement against whatever subset
shanebe217792009-03-05 04:20:31 +0000320 ** of the schema was loaded before the error occurred. The primary
danielk197734c68fb2007-03-14 15:37:04 +0000321 ** purpose of this is to allow access to the sqlite_master table
drh85b623f2007-12-13 21:54:09 +0000322 ** even when its contents have been corrupted.
danielk197734c68fb2007-03-14 15:37:04 +0000323 */
danielk1977fa256a32005-05-25 04:11:56 +0000324 DbSetProperty(db, iDb, DB_SchemaLoaded);
danielk197734c68fb2007-03-14 15:37:04 +0000325 rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000326 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000327
328 /* Jump here for an error that occurs after successfully allocating
329 ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
330 ** before that point, jump to error_out.
331 */
drh701bb3b2008-08-02 03:50:39 +0000332initone_error_out:
danielk1977602b4662009-07-02 07:47:33 +0000333 if( openedTransaction ){
334 sqlite3BtreeCommit(pDb->pBt);
335 }
drhb1ab8ea2007-08-29 00:33:07 +0000336 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000337
338error_out:
danielk1977ae72d982007-10-03 08:46:44 +0000339 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
drh4a642b62016-02-05 01:55:27 +0000340 sqlite3OomFault(db);
danielk1977a1644fd2007-08-29 12:31:25 +0000341 }
danielk1977fa256a32005-05-25 04:11:56 +0000342 return rc;
343}
344
345/*
346** Initialize all database files - the main database file, the file
347** used to store temporary tables, and any additional database files
348** created using ATTACH statements. Return a success code. If an
349** error occurs, write an error message into *pzErrMsg.
350**
danielk1977e7259292006-01-13 06:33:23 +0000351** After a database is initialized, the DB_SchemaLoaded bit is set
352** bit is set in the flags field of the Db structure. If the database
353** file was of zero-length, then the DB_Empty flag is also set.
danielk1977fa256a32005-05-25 04:11:56 +0000354*/
355int sqlite3Init(sqlite3 *db, char **pzErrMsg){
356 int i, rc;
danielk19775814c1a2007-08-13 14:41:19 +0000357 int commit_internal = !(db->flags&SQLITE_InternChanges);
danielk1977fa256a32005-05-25 04:11:56 +0000358
drhb1ab8ea2007-08-29 00:33:07 +0000359 assert( sqlite3_mutex_held(db->mutex) );
drh9bd3cc42014-12-12 23:17:54 +0000360 assert( sqlite3BtreeHoldsMutex(db->aDb[0].pBt) );
drh09e60542014-09-10 22:46:46 +0000361 assert( db->init.busy==0 );
danielk1977fa256a32005-05-25 04:11:56 +0000362 rc = SQLITE_OK;
363 db->init.busy = 1;
drh9bd3cc42014-12-12 23:17:54 +0000364 ENC(db) = SCHEMA_ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000365 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
366 if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
367 rc = sqlite3InitOne(db, i, pzErrMsg);
368 if( rc ){
drh81028a42012-05-15 18:28:27 +0000369 sqlite3ResetOneSchema(db, i);
danielk1977fa256a32005-05-25 04:11:56 +0000370 }
371 }
372
mistachkin48864df2013-03-21 21:20:32 +0000373 /* Once all the other databases have been initialized, load the schema
danielk1977fa256a32005-05-25 04:11:56 +0000374 ** for the TEMP database. This is loaded last, as the TEMP database
375 ** schema may contain references to objects in other databases.
376 */
377#ifndef SQLITE_OMIT_TEMPDB
drhe933b832014-09-10 17:34:28 +0000378 assert( db->nDb>1 );
379 if( rc==SQLITE_OK && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
danielk1977fa256a32005-05-25 04:11:56 +0000380 rc = sqlite3InitOne(db, 1, pzErrMsg);
381 if( rc ){
drh81028a42012-05-15 18:28:27 +0000382 sqlite3ResetOneSchema(db, 1);
danielk1977fa256a32005-05-25 04:11:56 +0000383 }
384 }
385#endif
386
387 db->init.busy = 0;
danielk19775814c1a2007-08-13 14:41:19 +0000388 if( rc==SQLITE_OK && commit_internal ){
danielk1977fa256a32005-05-25 04:11:56 +0000389 sqlite3CommitInternalChanges(db);
390 }
391
danielk1977b82e7ed2006-01-11 14:09:31 +0000392 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000393}
394
395/*
mistachkin48864df2013-03-21 21:20:32 +0000396** This routine is a no-op if the database schema is already initialized.
danielk1977fa256a32005-05-25 04:11:56 +0000397** Otherwise, the schema is loaded. An error code is returned.
398*/
399int sqlite3ReadSchema(Parse *pParse){
400 int rc = SQLITE_OK;
401 sqlite3 *db = pParse->db;
drhb1ab8ea2007-08-29 00:33:07 +0000402 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000403 if( !db->init.busy ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000404 rc = sqlite3Init(db, &pParse->zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000405 }
danielk1977fa256a32005-05-25 04:11:56 +0000406 if( rc!=SQLITE_OK ){
407 pParse->rc = rc;
408 pParse->nErr++;
409 }
410 return rc;
411}
412
413
414/*
415** Check schema cookies in all databases. If any cookie is out
drh1adecdf2009-07-03 19:19:50 +0000416** of date set pParse->rc to SQLITE_SCHEMA. If all schema cookies
417** make no changes to pParse->rc.
danielk1977fa256a32005-05-25 04:11:56 +0000418*/
danielk1977602b4662009-07-02 07:47:33 +0000419static void schemaIsValid(Parse *pParse){
420 sqlite3 *db = pParse->db;
danielk1977fa256a32005-05-25 04:11:56 +0000421 int iDb;
422 int rc;
danielk1977fa256a32005-05-25 04:11:56 +0000423 int cookie;
danielk1977fa256a32005-05-25 04:11:56 +0000424
danielk1977602b4662009-07-02 07:47:33 +0000425 assert( pParse->checkSchema );
426 assert( sqlite3_mutex_held(db->mutex) );
427 for(iDb=0; iDb<db->nDb; iDb++){
428 int openedTransaction = 0; /* True if a transaction is opened */
429 Btree *pBt = db->aDb[iDb].pBt; /* Btree database to read cookie from */
430 if( pBt==0 ) continue;
431
432 /* If there is not already a read-only (or read-write) transaction opened
433 ** on the b-tree database, open one now. If a transaction is opened, it
434 ** will be closed immediately after reading the meta-value. */
435 if( !sqlite3BtreeIsInReadTrans(pBt) ){
436 rc = sqlite3BtreeBeginTrans(pBt, 0);
drh1adecdf2009-07-03 19:19:50 +0000437 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
drh4a642b62016-02-05 01:55:27 +0000438 sqlite3OomFault(db);
danielk1977602b4662009-07-02 07:47:33 +0000439 }
440 if( rc!=SQLITE_OK ) return;
441 openedTransaction = 1;
442 }
443
444 /* Read the schema cookie from the database. If it does not match the
shanehd77f56e2009-12-17 21:05:42 +0000445 ** value stored as part of the in-memory schema representation,
danielk1977602b4662009-07-02 07:47:33 +0000446 ** set Parse.rc to SQLITE_SCHEMA. */
447 sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
drh21206082011-04-04 18:22:02 +0000448 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk1977602b4662009-07-02 07:47:33 +0000449 if( cookie!=db->aDb[iDb].pSchema->schema_cookie ){
drh81028a42012-05-15 18:28:27 +0000450 sqlite3ResetOneSchema(db, iDb);
danielk1977602b4662009-07-02 07:47:33 +0000451 pParse->rc = SQLITE_SCHEMA;
452 }
453
454 /* Close the transaction, if one was opened. */
455 if( openedTransaction ){
456 sqlite3BtreeCommit(pBt);
457 }
458 }
danielk1977fa256a32005-05-25 04:11:56 +0000459}
460
461/*
drhf248e212006-01-25 22:50:38 +0000462** Convert a schema pointer into the iDb index that indicates
463** which database file in db->aDb[] the schema refers to.
464**
465** If the same database is attached more than once, the first
466** attached database is returned.
467*/
danielk1977e501b892006-01-09 06:29:47 +0000468int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
drh198bf392006-01-06 21:52:49 +0000469 int i = -1000000;
470
471 /* If pSchema is NULL, then return -1000000. This happens when code in
472 ** expr.c is trying to resolve a reference to a transient table (i.e. one
473 ** created by a sub-select). In this case the return value of this
474 ** function should never be used.
475 **
476 ** We return -1000000 instead of the more usual -1 simply because using
drh1c767f02009-01-09 02:49:31 +0000477 ** -1000000 as the incorrect index into db->aDb[] is much
drh198bf392006-01-06 21:52:49 +0000478 ** more likely to cause a segfault than -1 (of course there are assert()
479 ** statements too, but it never hurts to play the odds).
480 */
drhb1ab8ea2007-08-29 00:33:07 +0000481 assert( sqlite3_mutex_held(db->mutex) );
drh198bf392006-01-06 21:52:49 +0000482 if( pSchema ){
drh1c767f02009-01-09 02:49:31 +0000483 for(i=0; ALWAYS(i<db->nDb); i++){
drh198bf392006-01-06 21:52:49 +0000484 if( db->aDb[i].pSchema==pSchema ){
485 break;
486 }
487 }
drh1c767f02009-01-09 02:49:31 +0000488 assert( i>=0 && i<db->nDb );
drh198bf392006-01-06 21:52:49 +0000489 }
490 return i;
491}
492
493/*
drhf30a9692013-11-15 01:10:18 +0000494** Free all memory allocations in the pParse object
495*/
496void sqlite3ParserReset(Parse *pParse){
drh73d5b8f2013-12-23 19:09:07 +0000497 if( pParse ){
498 sqlite3 *db = pParse->db;
499 sqlite3DbFree(db, pParse->aLabel);
500 sqlite3ExprListDelete(db, pParse->pConstExpr);
drh4a642b62016-02-05 01:55:27 +0000501 if( db ){
502 assert( db->lookaside.bDisable >= pParse->disableLookaside );
503 db->lookaside.bDisable -= pParse->disableLookaside;
504 }
505 pParse->disableLookaside = 0;
drh73d5b8f2013-12-23 19:09:07 +0000506 }
drhf30a9692013-11-15 01:10:18 +0000507}
508
509/*
danielk1977fa256a32005-05-25 04:11:56 +0000510** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
511*/
mlcreech3a00f902008-03-04 17:45:01 +0000512static int sqlite3Prepare(
danielk1977fa256a32005-05-25 04:11:56 +0000513 sqlite3 *db, /* Database handle. */
514 const char *zSql, /* UTF-8 encoded SQL statement. */
515 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000516 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
dan937d0de2009-10-15 18:35:38 +0000517 Vdbe *pReprepare, /* VM being reprepared */
danielk1977fa256a32005-05-25 04:11:56 +0000518 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
drhb900aaf2006-11-09 00:24:53 +0000519 const char **pzTail /* OUT: End of parsed string */
danielk1977fa256a32005-05-25 04:11:56 +0000520){
drhe7b347072009-06-01 18:18:20 +0000521 char *zErrMsg = 0; /* Error message */
522 int rc = SQLITE_OK; /* Result code */
523 int i; /* Loop counter */
drhcb43a932016-10-03 01:21:51 +0000524 Parse sParse; /* Parsing context */
danielk1977fa256a32005-05-25 04:11:56 +0000525
drhcb43a932016-10-03 01:21:51 +0000526 memset(&sParse, 0, PARSE_HDR_SZ);
527 memset(PARSE_TAIL(&sParse), 0, PARSE_TAIL_SZ);
528 sParse.pReprepare = pReprepare;
drh860e0772009-04-02 18:32:26 +0000529 assert( ppStmt && *ppStmt==0 );
drhc6150972016-01-23 14:05:27 +0000530 /* assert( !db->mallocFailed ); // not true with SQLITE_USE_ALLOCA */
drhb21c8cd2007-08-21 19:33:56 +0000531 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000532
drhc74d0b1d2009-02-24 16:18:05 +0000533 /* Check to verify that it is possible to get a read lock on all
534 ** database schemas. The inability to get a read lock indicates that
535 ** some other database connection is holding a write-lock, which in
536 ** turn means that the other connection has made uncommitted changes
537 ** to the schema.
538 **
539 ** Were we to proceed and prepare the statement against the uncommitted
540 ** schema changes and if those schema changes are subsequently rolled
541 ** back and different changes are made in their place, then when this
542 ** prepared statement goes to run the schema cookie would fail to detect
543 ** the schema change. Disaster would follow.
544 **
545 ** This thread is currently holding mutexes on all Btrees (because
546 ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
547 ** is not possible for another thread to start a new schema change
548 ** while this routine is running. Hence, we do not need to hold
549 ** locks on the schema, we just need to make sure nobody else is
550 ** holding them.
551 **
552 ** Note that setting READ_UNCOMMITTED overrides most lock detection,
553 ** but it does *not* override schema lock detection, so this all still
554 ** works even if READ_UNCOMMITTED is set.
danielk1977c87d34d2006-01-06 13:00:28 +0000555 */
556 for(i=0; i<db->nDb; i++) {
557 Btree *pBt = db->aDb[i].pBt;
drhb1ab8ea2007-08-29 00:33:07 +0000558 if( pBt ){
drhc74d0b1d2009-02-24 16:18:05 +0000559 assert( sqlite3BtreeHoldsMutex(pBt) );
drhb1ab8ea2007-08-29 00:33:07 +0000560 rc = sqlite3BtreeSchemaLocked(pBt);
561 if( rc ){
drh69c33822016-08-18 14:33:11 +0000562 const char *zDb = db->aDb[i].zDbSName;
drh13f40da2014-08-22 18:00:11 +0000563 sqlite3ErrorWithMsg(db, rc, "database schema is locked: %s", zDb);
drhc74d0b1d2009-02-24 16:18:05 +0000564 testcase( db->flags & SQLITE_ReadUncommitted );
drhe7b347072009-06-01 18:18:20 +0000565 goto end_prepare;
drhb1ab8ea2007-08-29 00:33:07 +0000566 }
danielk1977c87d34d2006-01-06 13:00:28 +0000567 }
568 }
drhe7b347072009-06-01 18:18:20 +0000569
danielk1977595a5232009-07-24 17:58:53 +0000570 sqlite3VtabUnlockList(db);
drhe7b347072009-06-01 18:18:20 +0000571
drhcb43a932016-10-03 01:21:51 +0000572 sParse.db = db;
drhd2d88bb2008-05-23 14:32:18 +0000573 if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
drhe5c941b2007-05-08 13:58:26 +0000574 char *zSqlCopy;
drhbb4957f2008-03-20 14:03:29 +0000575 int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
drh58fbb312009-06-17 00:35:30 +0000576 testcase( nBytes==mxLen );
577 testcase( nBytes==mxLen+1 );
drhbb4957f2008-03-20 14:03:29 +0000578 if( nBytes>mxLen ){
drh13f40da2014-08-22 18:00:11 +0000579 sqlite3ErrorWithMsg(db, SQLITE_TOOBIG, "statement too long");
drhe7b347072009-06-01 18:18:20 +0000580 rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
581 goto end_prepare;
drhe5c941b2007-05-08 13:58:26 +0000582 }
drh17435752007-08-16 04:30:38 +0000583 zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
drh276fdbf2007-04-30 21:39:16 +0000584 if( zSqlCopy ){
drhcb43a932016-10-03 01:21:51 +0000585 sqlite3RunParser(&sParse, zSqlCopy, &zErrMsg);
586 sParse.zTail = &zSql[sParse.zTail-zSqlCopy];
dan98a4d5a2016-01-29 08:38:35 +0000587 sqlite3DbFree(db, zSqlCopy);
danielk19773a2c8c82008-04-03 14:36:25 +0000588 }else{
drhcb43a932016-10-03 01:21:51 +0000589 sParse.zTail = &zSql[nBytes];
drh276fdbf2007-04-30 21:39:16 +0000590 }
drh9051a422006-01-30 22:35:43 +0000591 }else{
drhcb43a932016-10-03 01:21:51 +0000592 sqlite3RunParser(&sParse, zSql, &zErrMsg);
drh9051a422006-01-30 22:35:43 +0000593 }
drhcb43a932016-10-03 01:21:51 +0000594 assert( 0==sParse.nQueryLoop );
danielk1977fa256a32005-05-25 04:11:56 +0000595
drhcb43a932016-10-03 01:21:51 +0000596 if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
597 if( sParse.checkSchema ){
598 schemaIsValid(&sParse);
danielk1977fa256a32005-05-25 04:11:56 +0000599 }
drh17435752007-08-16 04:30:38 +0000600 if( db->mallocFailed ){
drhcb43a932016-10-03 01:21:51 +0000601 sParse.rc = SQLITE_NOMEM_BKPT;
drh344a6272006-06-26 12:50:09 +0000602 }
drhb900aaf2006-11-09 00:24:53 +0000603 if( pzTail ){
drhcb43a932016-10-03 01:21:51 +0000604 *pzTail = sParse.zTail;
drhb900aaf2006-11-09 00:24:53 +0000605 }
drhcb43a932016-10-03 01:21:51 +0000606 rc = sParse.rc;
danielk1977fa256a32005-05-25 04:11:56 +0000607
608#ifndef SQLITE_OMIT_EXPLAIN
drhcb43a932016-10-03 01:21:51 +0000609 if( rc==SQLITE_OK && sParse.pVdbe && sParse.explain ){
drhe7b347072009-06-01 18:18:20 +0000610 static const char * const azColName[] = {
611 "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
dan2ce22452010-11-08 19:01:16 +0000612 "selectid", "order", "from", "detail"
drhe7b347072009-06-01 18:18:20 +0000613 };
614 int iFirst, mx;
drhcb43a932016-10-03 01:21:51 +0000615 if( sParse.explain==2 ){
616 sqlite3VdbeSetNumCols(sParse.pVdbe, 4);
drhe7b347072009-06-01 18:18:20 +0000617 iFirst = 8;
dan2ce22452010-11-08 19:01:16 +0000618 mx = 12;
drhecc92422005-09-10 16:46:12 +0000619 }else{
drhcb43a932016-10-03 01:21:51 +0000620 sqlite3VdbeSetNumCols(sParse.pVdbe, 8);
drhe7b347072009-06-01 18:18:20 +0000621 iFirst = 0;
622 mx = 8;
623 }
624 for(i=iFirst; i<mx; i++){
drhcb43a932016-10-03 01:21:51 +0000625 sqlite3VdbeSetColName(sParse.pVdbe, i-iFirst, COLNAME_NAME,
drhe7b347072009-06-01 18:18:20 +0000626 azColName[i], SQLITE_STATIC);
drhecc92422005-09-10 16:46:12 +0000627 }
drhb900aaf2006-11-09 00:24:53 +0000628 }
danielk1977fa256a32005-05-25 04:11:56 +0000629#endif
630
danielk19776ab3a2e2009-02-19 14:39:25 +0000631 if( db->init.busy==0 ){
drhcb43a932016-10-03 01:21:51 +0000632 Vdbe *pVdbe = sParse.pVdbe;
633 sqlite3VdbeSetSql(pVdbe, zSql, (int)(sParse.zTail-zSql), saveSqlFlag);
danielk19777e29e952007-04-19 11:09:01 +0000634 }
drhcb43a932016-10-03 01:21:51 +0000635 if( sParse.pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
636 sqlite3VdbeFinalize(sParse.pVdbe);
danielk19777e29e952007-04-19 11:09:01 +0000637 assert(!(*ppStmt));
638 }else{
drhcb43a932016-10-03 01:21:51 +0000639 *ppStmt = (sqlite3_stmt*)sParse.pVdbe;
danielk1977fa256a32005-05-25 04:11:56 +0000640 }
641
642 if( zErrMsg ){
drh13f40da2014-08-22 18:00:11 +0000643 sqlite3ErrorWithMsg(db, rc, "%s", zErrMsg);
drh633e6d52008-07-28 19:34:53 +0000644 sqlite3DbFree(db, zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000645 }else{
drh13f40da2014-08-22 18:00:11 +0000646 sqlite3Error(db, rc);
danielk1977fa256a32005-05-25 04:11:56 +0000647 }
danielk1977261919c2005-12-06 12:52:59 +0000648
dan65a7cd12009-09-01 12:16:01 +0000649 /* Delete any TriggerPrg structures allocated while parsing this statement. */
drhcb43a932016-10-03 01:21:51 +0000650 while( sParse.pTriggerPrg ){
651 TriggerPrg *pT = sParse.pTriggerPrg;
652 sParse.pTriggerPrg = pT->pNext;
dan165921a2009-08-28 18:53:45 +0000653 sqlite3DbFree(db, pT);
654 }
655
drhe7b347072009-06-01 18:18:20 +0000656end_prepare:
657
drhcb43a932016-10-03 01:21:51 +0000658 sqlite3ParserReset(&sParse);
danielk197754f01982006-01-18 15:25:17 +0000659 rc = sqlite3ApiExit(db, rc);
drh4ac285a2006-09-15 07:28:50 +0000660 assert( (rc&db->errMask)==rc );
danielk1977fa256a32005-05-25 04:11:56 +0000661 return rc;
662}
drhb21c8cd2007-08-21 19:33:56 +0000663static int sqlite3LockAndPrepare(
664 sqlite3 *db, /* Database handle. */
665 const char *zSql, /* UTF-8 encoded SQL statement. */
666 int nBytes, /* Length of zSql in bytes. */
667 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
dan937d0de2009-10-15 18:35:38 +0000668 Vdbe *pOld, /* VM being reprepared */
drhb21c8cd2007-08-21 19:33:56 +0000669 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
670 const char **pzTail /* OUT: End of parsed string */
671){
672 int rc;
drh9ca95732014-10-24 00:35:58 +0000673
674#ifdef SQLITE_ENABLE_API_ARMOR
675 if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
676#endif
drh860e0772009-04-02 18:32:26 +0000677 *ppStmt = 0;
drh9ca95732014-10-24 00:35:58 +0000678 if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
drh413c3d32010-02-23 20:11:56 +0000679 return SQLITE_MISUSE_BKPT;
drh27641702007-08-22 02:56:42 +0000680 }
drhb21c8cd2007-08-21 19:33:56 +0000681 sqlite3_mutex_enter(db->mutex);
drhb1ab8ea2007-08-29 00:33:07 +0000682 sqlite3BtreeEnterAll(db);
dan937d0de2009-10-15 18:35:38 +0000683 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
drh9da742f2009-06-16 17:49:36 +0000684 if( rc==SQLITE_SCHEMA ){
685 sqlite3_finalize(*ppStmt);
dan937d0de2009-10-15 18:35:38 +0000686 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
drh9da742f2009-06-16 17:49:36 +0000687 }
drhb1ab8ea2007-08-29 00:33:07 +0000688 sqlite3BtreeLeaveAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000689 sqlite3_mutex_leave(db->mutex);
drh74ea19b2012-05-14 12:20:54 +0000690 assert( rc==SQLITE_OK || *ppStmt==0 );
drhb21c8cd2007-08-21 19:33:56 +0000691 return rc;
692}
danielk1977fa256a32005-05-25 04:11:56 +0000693
drhb900aaf2006-11-09 00:24:53 +0000694/*
695** Rerun the compilation of a statement after a schema change.
danielk197765a2ea12009-03-19 07:58:31 +0000696**
697** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
698** if the statement cannot be recompiled because another connection has
699** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
700** occurs, return SQLITE_SCHEMA.
drhb900aaf2006-11-09 00:24:53 +0000701*/
702int sqlite3Reprepare(Vdbe *p){
703 int rc;
drh4f0c5872007-03-26 22:05:01 +0000704 sqlite3_stmt *pNew;
drhb900aaf2006-11-09 00:24:53 +0000705 const char *zSql;
706 sqlite3 *db;
drhb21c8cd2007-08-21 19:33:56 +0000707
drhb1ab8ea2007-08-29 00:33:07 +0000708 assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
danielk1977d0e2a852007-11-14 06:48:48 +0000709 zSql = sqlite3_sql((sqlite3_stmt *)p);
drhc4dd3fd2008-01-22 01:48:05 +0000710 assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
drhb900aaf2006-11-09 00:24:53 +0000711 db = sqlite3VdbeDb(p);
drhb21c8cd2007-08-21 19:33:56 +0000712 assert( sqlite3_mutex_held(db->mutex) );
dan937d0de2009-10-15 18:35:38 +0000713 rc = sqlite3LockAndPrepare(db, zSql, -1, 0, p, &pNew, 0);
drhb900aaf2006-11-09 00:24:53 +0000714 if( rc ){
danielk19778e556522007-11-13 10:30:24 +0000715 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +0000716 sqlite3OomFault(db);
danielk19778e556522007-11-13 10:30:24 +0000717 }
drhb900aaf2006-11-09 00:24:53 +0000718 assert( pNew==0 );
drha6129fa2010-02-24 17:15:19 +0000719 return rc;
drhb900aaf2006-11-09 00:24:53 +0000720 }else{
721 assert( pNew!=0 );
722 }
drh4f0c5872007-03-26 22:05:01 +0000723 sqlite3VdbeSwap((Vdbe*)pNew, p);
shane145834a2008-09-04 12:03:42 +0000724 sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
drh4f0c5872007-03-26 22:05:01 +0000725 sqlite3VdbeResetStepResult((Vdbe*)pNew);
726 sqlite3VdbeFinalize((Vdbe*)pNew);
danielk197765a2ea12009-03-19 07:58:31 +0000727 return SQLITE_OK;
drhb900aaf2006-11-09 00:24:53 +0000728}
729
730
731/*
732** Two versions of the official API. Legacy and new use. In the legacy
733** version, the original SQL text is not saved in the prepared statement
734** and so if a schema change occurs, SQLITE_SCHEMA is returned by
735** sqlite3_step(). In the new version, the original SQL text is retained
736** and the statement is automatically recompiled if an schema change
737** occurs.
738*/
739int sqlite3_prepare(
740 sqlite3 *db, /* Database handle. */
741 const char *zSql, /* UTF-8 encoded SQL statement. */
742 int nBytes, /* Length of zSql in bytes. */
743 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
744 const char **pzTail /* OUT: End of parsed string */
745){
drh17eaae72008-03-03 18:47:28 +0000746 int rc;
dan937d0de2009-10-15 18:35:38 +0000747 rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000748 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000749 return rc;
drhb900aaf2006-11-09 00:24:53 +0000750}
751int sqlite3_prepare_v2(
752 sqlite3 *db, /* Database handle. */
753 const char *zSql, /* UTF-8 encoded SQL statement. */
754 int nBytes, /* Length of zSql in bytes. */
755 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
756 const char **pzTail /* OUT: End of parsed string */
757){
drh17eaae72008-03-03 18:47:28 +0000758 int rc;
dan937d0de2009-10-15 18:35:38 +0000759 rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000760 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000761 return rc;
drhb900aaf2006-11-09 00:24:53 +0000762}
763
764
danielk1977fa256a32005-05-25 04:11:56 +0000765#ifndef SQLITE_OMIT_UTF16
766/*
767** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
768*/
drhb900aaf2006-11-09 00:24:53 +0000769static int sqlite3Prepare16(
danielk1977fa256a32005-05-25 04:11:56 +0000770 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000771 const void *zSql, /* UTF-16 encoded SQL statement. */
danielk1977fa256a32005-05-25 04:11:56 +0000772 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000773 int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000774 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
775 const void **pzTail /* OUT: End of parsed string */
776){
777 /* This function currently works by first transforming the UTF-16
778 ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
779 ** tricky bit is figuring out the pointer to return in *pzTail.
780 */
danielk197754f01982006-01-18 15:25:17 +0000781 char *zSql8;
danielk1977c87d34d2006-01-06 13:00:28 +0000782 const char *zTail8 = 0;
danielk197754f01982006-01-18 15:25:17 +0000783 int rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000784
drh9ca95732014-10-24 00:35:58 +0000785#ifdef SQLITE_ENABLE_API_ARMOR
786 if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
787#endif
drh769e97e2009-04-01 16:33:37 +0000788 *ppStmt = 0;
drh9ca95732014-10-24 00:35:58 +0000789 if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
drh413c3d32010-02-23 20:11:56 +0000790 return SQLITE_MISUSE_BKPT;
danielk1977fa256a32005-05-25 04:11:56 +0000791 }
drh7232ad02013-07-16 23:26:43 +0000792 if( nBytes>=0 ){
793 int sz;
794 const char *z = (const char*)zSql;
795 for(sz=0; sz<nBytes && (z[sz]!=0 || z[sz+1]!=0); sz += 2){}
796 nBytes = sz;
797 }
drhb21c8cd2007-08-21 19:33:56 +0000798 sqlite3_mutex_enter(db->mutex);
danb7dca7d2010-03-05 16:32:12 +0000799 zSql8 = sqlite3Utf16to8(db, zSql, nBytes, SQLITE_UTF16NATIVE);
danielk197754f01982006-01-18 15:25:17 +0000800 if( zSql8 ){
dan937d0de2009-10-15 18:35:38 +0000801 rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, 0, ppStmt, &zTail8);
danielk1977fa256a32005-05-25 04:11:56 +0000802 }
danielk1977fa256a32005-05-25 04:11:56 +0000803
804 if( zTail8 && pzTail ){
805 /* If sqlite3_prepare returns a tail pointer, we calculate the
806 ** equivalent pointer into the UTF-16 string by counting the unicode
807 ** characters between zSql8 and zTail8, and then returning a pointer
808 ** the same number of characters into the UTF-16 string.
809 */
drhea678832008-12-10 19:26:22 +0000810 int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
drhee858132007-05-08 20:37:38 +0000811 *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
danielk1977fa256a32005-05-25 04:11:56 +0000812 }
drh633e6d52008-07-28 19:34:53 +0000813 sqlite3DbFree(db, zSql8);
drhb21c8cd2007-08-21 19:33:56 +0000814 rc = sqlite3ApiExit(db, rc);
815 sqlite3_mutex_leave(db->mutex);
816 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000817}
drhb900aaf2006-11-09 00:24:53 +0000818
819/*
820** Two versions of the official API. Legacy and new use. In the legacy
821** version, the original SQL text is not saved in the prepared statement
822** and so if a schema change occurs, SQLITE_SCHEMA is returned by
823** sqlite3_step(). In the new version, the original SQL text is retained
824** and the statement is automatically recompiled if an schema change
825** occurs.
826*/
827int sqlite3_prepare16(
828 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000829 const void *zSql, /* UTF-16 encoded SQL statement. */
drhb900aaf2006-11-09 00:24:53 +0000830 int nBytes, /* Length of zSql in bytes. */
831 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
832 const void **pzTail /* OUT: End of parsed string */
833){
drh17eaae72008-03-03 18:47:28 +0000834 int rc;
835 rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000836 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000837 return rc;
drhb900aaf2006-11-09 00:24:53 +0000838}
839int sqlite3_prepare16_v2(
840 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000841 const void *zSql, /* UTF-16 encoded SQL statement. */
drhb900aaf2006-11-09 00:24:53 +0000842 int nBytes, /* Length of zSql in bytes. */
843 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
844 const void **pzTail /* OUT: End of parsed string */
845){
drh17eaae72008-03-03 18:47:28 +0000846 int rc;
847 rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000848 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000849 return rc;
drhb900aaf2006-11-09 00:24:53 +0000850}
851
danielk1977fa256a32005-05-25 04:11:56 +0000852#endif /* SQLITE_OMIT_UTF16 */