blob: 5d1ae00d137867d8404238237f1cccbb21d7ce18 [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 = "?";
drh22c17b82015-05-15 04:13:15 +000031 z = sqlite3_mprintf("malformed database schema (%s)", zObj);
32 if( z && zExtra ) z = sqlite3_mprintf("%z - %s", z, zExtra);
33 sqlite3DbFree(db, *pData->pzErrMsg);
34 *pData->pzErrMsg = z;
35 if( z==0 ) db->mallocFailed = 1;
danielk1977fa256a32005-05-25 04:11:56 +000036 }
drh2b89fbc2011-04-09 02:09:44 +000037 pData->rc = db->mallocFailed ? SQLITE_NOMEM : SQLITE_CORRUPT_BKPT;
danielk1977fa256a32005-05-25 04:11:56 +000038}
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
danielk197778efaba2006-06-12 06:09:17 +000048** argv[1] = root page number for table or index. 0 for trigger or view.
danielk1977fa256a32005-05-25 04:11:56 +000049** argv[2] = SQL text for the CREATE statement.
danielk1977fa256a32005-05-25 04:11:56 +000050**
51*/
danielk197762c14b32008-11-19 09:05:26 +000052int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
danielk1977fa256a32005-05-25 04:11:56 +000053 InitData *pData = (InitData*)pInit;
54 sqlite3 *db = pData->db;
drhece3c722006-09-23 20:36:01 +000055 int iDb = pData->iDb;
danielk1977fa256a32005-05-25 04:11:56 +000056
danielk1977f3d3c272008-11-19 16:52:44 +000057 assert( argc==3 );
58 UNUSED_PARAMETER2(NotUsed, argc);
drhb1ab8ea2007-08-29 00:33:07 +000059 assert( sqlite3_mutex_held(db->mutex) );
drhece3c722006-09-23 20:36:01 +000060 DbClearProperty(db, iDb, DB_Empty);
drh17435752007-08-16 04:30:38 +000061 if( db->mallocFailed ){
drh34533152008-03-19 13:03:33 +000062 corruptSchema(pData, argv[0], 0);
drh9da742f2009-06-16 17:49:36 +000063 return 1;
danielk1977da184232006-01-05 11:34:32 +000064 }
65
danielk1977ff9b2e72008-09-08 09:06:18 +000066 assert( iDb>=0 && iDb<db->nDb );
danielk1977fa256a32005-05-25 04:11:56 +000067 if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
drhece3c722006-09-23 20:36:01 +000068 if( argv[1]==0 ){
drh34533152008-03-19 13:03:33 +000069 corruptSchema(pData, argv[0], 0);
drh22ecef52015-04-16 00:26:03 +000070 }else if( sqlite3_strnicmp(argv[2],"create ",7)==0 ){
danielk1977fa256a32005-05-25 04:11:56 +000071 /* 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 */
danielk1977fa256a32005-05-25 04:11:56 +000076 int rc;
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) );
danielk1977fa256a32005-05-25 04:11:56 +000087 db->init.iDb = 0;
88 if( SQLITE_OK!=rc ){
drh3d5f74b2009-08-06 17:43:31 +000089 if( db->init.orphanTrigger ){
90 assert( iDb==1 );
91 }else{
92 pData->rc = rc;
93 if( rc==SQLITE_NOMEM ){
94 db->mallocFailed = 1;
dan9859c422010-07-06 07:36:18 +000095 }else if( rc!=SQLITE_INTERRUPT && (rc&0xFF)!=SQLITE_LOCKED ){
drh6498f0b2010-04-09 09:14:05 +000096 corruptSchema(pData, argv[0], sqlite3_errmsg(db));
drh3d5f74b2009-08-06 17:43:31 +000097 }
danielk1977261919c2005-12-06 12:52:59 +000098 }
danielk1977fa256a32005-05-25 04:11:56 +000099 }
drh6498f0b2010-04-09 09:14:05 +0000100 sqlite3_finalize(pStmt);
drh22ecef52015-04-16 00:26:03 +0000101 }else if( argv[0]==0 || (argv[2]!=0 && argv[2][0]!=0) ){
102 corruptSchema(pData, argv[0], 0);
danielk1977fa256a32005-05-25 04:11:56 +0000103 }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);
drh9da742f2009-06-16 17:49:36 +0000112 if( pIndex==0 ){
danielk1977fa256a32005-05-25 04:11:56 +0000113 /* 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 */;
drh9da742f2009-06-16 17:49:36 +0000119 }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
120 corruptSchema(pData, argv[0], "invalid rootpage");
danielk1977fa256a32005-05-25 04:11:56 +0000121 }
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*/
134static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
135 int rc;
drh8a939192009-04-20 17:43:03 +0000136 int i;
mistachkinba2bba32012-09-18 23:21:32 +0000137#ifndef SQLITE_OMIT_DEPRECATED
danielk1977fa256a32005-05-25 04:11:56 +0000138 int size;
mistachkinba2bba32012-09-18 23:21:32 +0000139#endif
danielk1977fa256a32005-05-25 04:11:56 +0000140 Table *pTab;
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;
145 char const *zMasterSchema;
drhc126e632011-03-06 21:28:32 +0000146 char const *zMasterName;
danielk197794b30732009-07-02 17:21:57 +0000147 int openedTransaction = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000148
149 /*
150 ** The master database table has a structure like this
151 */
152 static const char master_schema[] =
153 "CREATE TABLE sqlite_master(\n"
154 " type text,\n"
155 " name text,\n"
156 " tbl_name text,\n"
157 " rootpage integer,\n"
158 " sql text\n"
159 ")"
160 ;
161#ifndef SQLITE_OMIT_TEMPDB
162 static const char temp_master_schema[] =
163 "CREATE TEMP TABLE sqlite_temp_master(\n"
164 " type text,\n"
165 " name text,\n"
166 " tbl_name text,\n"
167 " rootpage integer,\n"
168 " sql text\n"
169 ")"
170 ;
171#else
172 #define temp_master_schema 0
173#endif
174
175 assert( iDb>=0 && iDb<db->nDb );
danielk197714db2662006-01-09 16:12:04 +0000176 assert( db->aDb[iDb].pSchema );
drhb1ab8ea2007-08-29 00:33:07 +0000177 assert( sqlite3_mutex_held(db->mutex) );
danielk19774eab8b72007-12-27 15:12:16 +0000178 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
danielk1977da184232006-01-05 11:34:32 +0000179
danielk1977fa256a32005-05-25 04:11:56 +0000180 /* zMasterSchema and zInitScript are set to point at the master schema
181 ** and initialisation script appropriate for the database being
mistachkin48864df2013-03-21 21:20:32 +0000182 ** initialized. zMasterName is the name of the master table.
danielk1977fa256a32005-05-25 04:11:56 +0000183 */
184 if( !OMIT_TEMPDB && iDb==1 ){
185 zMasterSchema = temp_master_schema;
186 }else{
187 zMasterSchema = master_schema;
188 }
189 zMasterName = SCHEMA_TABLE(iDb);
190
191 /* Construct the schema tables. */
danielk1977fa256a32005-05-25 04:11:56 +0000192 azArg[0] = zMasterName;
193 azArg[1] = "1";
194 azArg[2] = zMasterSchema;
drhece3c722006-09-23 20:36:01 +0000195 azArg[3] = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000196 initData.db = db;
drhece3c722006-09-23 20:36:01 +0000197 initData.iDb = iDb;
drhc456e572008-08-11 18:44:58 +0000198 initData.rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000199 initData.pzErrMsg = pzErrMsg;
drhc456e572008-08-11 18:44:58 +0000200 sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
drhc456e572008-08-11 18:44:58 +0000201 if( initData.rc ){
danielk1977a1644fd2007-08-29 12:31:25 +0000202 rc = initData.rc;
203 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000204 }
205 pTab = sqlite3FindTable(db, zMasterName, db->aDb[iDb].zName);
drh9da742f2009-06-16 17:49:36 +0000206 if( ALWAYS(pTab) ){
drh7d10d5a2008-08-20 16:35:10 +0000207 pTab->tabFlags |= TF_Readonly;
danielk1977fa256a32005-05-25 04:11:56 +0000208 }
danielk1977fa256a32005-05-25 04:11:56 +0000209
210 /* Create a cursor to hold the database open
211 */
drhfdd6e852005-12-16 01:06:16 +0000212 pDb = &db->aDb[iDb];
213 if( pDb->pBt==0 ){
drh9da742f2009-06-16 17:49:36 +0000214 if( !OMIT_TEMPDB && ALWAYS(iDb==1) ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000215 DbSetProperty(db, 1, DB_SchemaLoaded);
216 }
danielk1977fa256a32005-05-25 04:11:56 +0000217 return SQLITE_OK;
218 }
danielk1977602b4662009-07-02 07:47:33 +0000219
220 /* If there is not already a read-only (or read-write) transaction opened
221 ** on the b-tree database, open one now. If a transaction is opened, it
222 ** will be closed before this function returns. */
drhb1ab8ea2007-08-29 00:33:07 +0000223 sqlite3BtreeEnter(pDb->pBt);
danielk1977602b4662009-07-02 07:47:33 +0000224 if( !sqlite3BtreeIsInReadTrans(pDb->pBt) ){
225 rc = sqlite3BtreeBeginTrans(pDb->pBt, 0);
226 if( rc!=SQLITE_OK ){
drh22c17b82015-05-15 04:13:15 +0000227 sqlite3SetString(pzErrMsg, db, sqlite3ErrStr(rc));
danielk1977602b4662009-07-02 07:47:33 +0000228 goto initone_error_out;
229 }
230 openedTransaction = 1;
danielk1977602b4662009-07-02 07:47:33 +0000231 }
danielk1977fa256a32005-05-25 04:11:56 +0000232
233 /* Get the database meta information.
234 **
235 ** Meta values are as follows:
236 ** meta[0] Schema cookie. Changes with each schema change.
237 ** meta[1] File format of schema layer.
238 ** meta[2] Size of the page cache.
drh27731d72009-06-22 12:05:10 +0000239 ** meta[3] Largest rootpage (auto/incr_vacuum mode)
drh8159a352006-05-23 23:22:29 +0000240 ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
drh27731d72009-06-22 12:05:10 +0000241 ** meta[5] User version
242 ** meta[6] Incremental vacuum mode
243 ** meta[7] unused
244 ** meta[8] unused
245 ** meta[9] unused
danielk1977fa256a32005-05-25 04:11:56 +0000246 **
drhf248e212006-01-25 22:50:38 +0000247 ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
danielk1977fa256a32005-05-25 04:11:56 +0000248 ** the possible values of meta[4].
249 */
danielk1977602b4662009-07-02 07:47:33 +0000250 for(i=0; i<ArraySize(meta); i++){
251 sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
danielk19770d19f7a2009-06-03 11:25:07 +0000252 }
253 pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
danielk1977fa256a32005-05-25 04:11:56 +0000254
255 /* If opening a non-empty database, check the text encoding. For the
256 ** main database, set sqlite3.enc to the encoding of the main database.
257 ** For an attached db, it is an error if the encoding is not the same
258 ** as sqlite3.enc.
259 */
danielk19770d19f7a2009-06-03 11:25:07 +0000260 if( meta[BTREE_TEXT_ENCODING-1] ){ /* text encoding */
danielk1977fa256a32005-05-25 04:11:56 +0000261 if( iDb==0 ){
dandbd4d5f2013-03-08 07:10:37 +0000262#ifndef SQLITE_OMIT_UTF16
drhc5e47ac2009-06-04 00:11:56 +0000263 u8 encoding;
danielk197714db2662006-01-09 16:12:04 +0000264 /* If opening the main database, set ENC(db). */
drhc5e47ac2009-06-04 00:11:56 +0000265 encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
266 if( encoding==0 ) encoding = SQLITE_UTF8;
267 ENC(db) = encoding;
dandbd4d5f2013-03-08 07:10:37 +0000268#else
269 ENC(db) = SQLITE_UTF8;
270#endif
danielk1977fa256a32005-05-25 04:11:56 +0000271 }else{
danielk197714db2662006-01-09 16:12:04 +0000272 /* If opening an attached database, the encoding much match ENC(db) */
danielk19770d19f7a2009-06-03 11:25:07 +0000273 if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
drhf089aa42008-07-08 19:34:06 +0000274 sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
275 " text encoding as main database");
danielk1977cd3e8f72008-03-25 09:47:35 +0000276 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000277 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000278 }
279 }
danielk1977b82e7ed2006-01-11 14:09:31 +0000280 }else{
281 DbSetProperty(db, iDb, DB_Empty);
danielk1977fa256a32005-05-25 04:11:56 +0000282 }
danielk197714db2662006-01-09 16:12:04 +0000283 pDb->pSchema->enc = ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000284
danielk19778cf6c552008-06-23 16:53:46 +0000285 if( pDb->pSchema->cache_size==0 ){
drhe73c9142011-11-09 16:12:24 +0000286#ifndef SQLITE_OMIT_DEPRECATED
drhd50ffc42011-03-08 02:38:28 +0000287 size = sqlite3AbsInt32(meta[BTREE_DEFAULT_CACHE_SIZE-1]);
danielk19778cf6c552008-06-23 16:53:46 +0000288 if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
danielk19778cf6c552008-06-23 16:53:46 +0000289 pDb->pSchema->cache_size = size;
drhe73c9142011-11-09 16:12:24 +0000290#else
291 pDb->pSchema->cache_size = SQLITE_DEFAULT_CACHE_SIZE;
292#endif
danielk19778cf6c552008-06-23 16:53:46 +0000293 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
294 }
danielk1977fa256a32005-05-25 04:11:56 +0000295
296 /*
297 ** file_format==1 Version 3.0.0.
drhfdd6e852005-12-16 01:06:16 +0000298 ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
299 ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
drhd946db02005-12-29 19:23:06 +0000300 ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
danielk1977fa256a32005-05-25 04:11:56 +0000301 */
danielk19770d19f7a2009-06-03 11:25:07 +0000302 pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
danielk1977da184232006-01-05 11:34:32 +0000303 if( pDb->pSchema->file_format==0 ){
304 pDb->pSchema->file_format = 1;
drhfdd6e852005-12-16 01:06:16 +0000305 }
danielk1977da184232006-01-05 11:34:32 +0000306 if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
drhf089aa42008-07-08 19:34:06 +0000307 sqlite3SetString(pzErrMsg, db, "unsupported file format");
danielk1977cd3e8f72008-03-25 09:47:35 +0000308 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000309 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000310 }
311
drh4aa2bfe2007-11-28 13:43:16 +0000312 /* Ticket #2804: When we open a database in the newer file format,
313 ** clear the legacy_file_format pragma flag so that a VACUUM will
314 ** not downgrade the database and thus invalidate any descending
315 ** indices that the user might have created.
316 */
danielk19770d19f7a2009-06-03 11:25:07 +0000317 if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
drh4aa2bfe2007-11-28 13:43:16 +0000318 db->flags &= ~SQLITE_LegacyFileFmt;
319 }
danielk1977fa256a32005-05-25 04:11:56 +0000320
321 /* Read the schema information out of the schema tables
322 */
323 assert( db->init.busy );
drh9da742f2009-06-16 17:49:36 +0000324 {
danielk1977fa256a32005-05-25 04:11:56 +0000325 char *zSql;
danielk19771e536952007-08-16 10:09:01 +0000326 zSql = sqlite3MPrintf(db,
drh6a9c64b2010-01-12 23:54:14 +0000327 "SELECT name, rootpage, sql FROM '%q'.%s ORDER BY rowid",
drhece3c722006-09-23 20:36:01 +0000328 db->aDb[iDb].zName, zMasterName);
drha6d0ffc2007-10-12 20:42:28 +0000329#ifndef SQLITE_OMIT_AUTHORIZATION
330 {
drh32c6a482014-09-11 13:44:52 +0000331 sqlite3_xauth xAuth;
drha6d0ffc2007-10-12 20:42:28 +0000332 xAuth = db->xAuth;
333 db->xAuth = 0;
334#endif
335 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
336#ifndef SQLITE_OMIT_AUTHORIZATION
337 db->xAuth = xAuth;
338 }
339#endif
drhc456e572008-08-11 18:44:58 +0000340 if( rc==SQLITE_OK ) rc = initData.rc;
drh633e6d52008-07-28 19:34:53 +0000341 sqlite3DbFree(db, zSql);
drh497e4462005-07-23 03:18:40 +0000342#ifndef SQLITE_OMIT_ANALYZE
343 if( rc==SQLITE_OK ){
344 sqlite3AnalysisLoad(db, iDb);
345 }
346#endif
danielk1977fa256a32005-05-25 04:11:56 +0000347 }
drh17435752007-08-16 04:30:38 +0000348 if( db->mallocFailed ){
danielk1977fa256a32005-05-25 04:11:56 +0000349 rc = SQLITE_NOMEM;
drh81028a42012-05-15 18:28:27 +0000350 sqlite3ResetAllSchemasOfConnection(db);
danielk1977fa256a32005-05-25 04:11:56 +0000351 }
danielk197734c68fb2007-03-14 15:37:04 +0000352 if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
353 /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
shanebe217792009-03-05 04:20:31 +0000354 ** the schema loaded, even if errors occurred. In this situation the
danielk197734c68fb2007-03-14 15:37:04 +0000355 ** current sqlite3_prepare() operation will fail, but the following one
356 ** will attempt to compile the supplied statement against whatever subset
shanebe217792009-03-05 04:20:31 +0000357 ** of the schema was loaded before the error occurred. The primary
danielk197734c68fb2007-03-14 15:37:04 +0000358 ** purpose of this is to allow access to the sqlite_master table
drh85b623f2007-12-13 21:54:09 +0000359 ** even when its contents have been corrupted.
danielk197734c68fb2007-03-14 15:37:04 +0000360 */
danielk1977fa256a32005-05-25 04:11:56 +0000361 DbSetProperty(db, iDb, DB_SchemaLoaded);
danielk197734c68fb2007-03-14 15:37:04 +0000362 rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000363 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000364
365 /* Jump here for an error that occurs after successfully allocating
366 ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
367 ** before that point, jump to error_out.
368 */
drh701bb3b2008-08-02 03:50:39 +0000369initone_error_out:
danielk1977602b4662009-07-02 07:47:33 +0000370 if( openedTransaction ){
371 sqlite3BtreeCommit(pDb->pBt);
372 }
drhb1ab8ea2007-08-29 00:33:07 +0000373 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000374
375error_out:
danielk1977ae72d982007-10-03 08:46:44 +0000376 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000377 db->mallocFailed = 1;
378 }
danielk1977fa256a32005-05-25 04:11:56 +0000379 return rc;
380}
381
382/*
383** Initialize all database files - the main database file, the file
384** used to store temporary tables, and any additional database files
385** created using ATTACH statements. Return a success code. If an
386** error occurs, write an error message into *pzErrMsg.
387**
danielk1977e7259292006-01-13 06:33:23 +0000388** After a database is initialized, the DB_SchemaLoaded bit is set
389** bit is set in the flags field of the Db structure. If the database
390** file was of zero-length, then the DB_Empty flag is also set.
danielk1977fa256a32005-05-25 04:11:56 +0000391*/
392int sqlite3Init(sqlite3 *db, char **pzErrMsg){
393 int i, rc;
danielk19775814c1a2007-08-13 14:41:19 +0000394 int commit_internal = !(db->flags&SQLITE_InternChanges);
danielk1977fa256a32005-05-25 04:11:56 +0000395
drhb1ab8ea2007-08-29 00:33:07 +0000396 assert( sqlite3_mutex_held(db->mutex) );
drh9bd3cc42014-12-12 23:17:54 +0000397 assert( sqlite3BtreeHoldsMutex(db->aDb[0].pBt) );
drh09e60542014-09-10 22:46:46 +0000398 assert( db->init.busy==0 );
danielk1977fa256a32005-05-25 04:11:56 +0000399 rc = SQLITE_OK;
400 db->init.busy = 1;
drh9bd3cc42014-12-12 23:17:54 +0000401 ENC(db) = SCHEMA_ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000402 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
403 if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
404 rc = sqlite3InitOne(db, i, pzErrMsg);
405 if( rc ){
drh81028a42012-05-15 18:28:27 +0000406 sqlite3ResetOneSchema(db, i);
danielk1977fa256a32005-05-25 04:11:56 +0000407 }
408 }
409
mistachkin48864df2013-03-21 21:20:32 +0000410 /* Once all the other databases have been initialized, load the schema
danielk1977fa256a32005-05-25 04:11:56 +0000411 ** for the TEMP database. This is loaded last, as the TEMP database
412 ** schema may contain references to objects in other databases.
413 */
414#ifndef SQLITE_OMIT_TEMPDB
drhe933b832014-09-10 17:34:28 +0000415 assert( db->nDb>1 );
416 if( rc==SQLITE_OK && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
danielk1977fa256a32005-05-25 04:11:56 +0000417 rc = sqlite3InitOne(db, 1, pzErrMsg);
418 if( rc ){
drh81028a42012-05-15 18:28:27 +0000419 sqlite3ResetOneSchema(db, 1);
danielk1977fa256a32005-05-25 04:11:56 +0000420 }
421 }
422#endif
423
424 db->init.busy = 0;
danielk19775814c1a2007-08-13 14:41:19 +0000425 if( rc==SQLITE_OK && commit_internal ){
danielk1977fa256a32005-05-25 04:11:56 +0000426 sqlite3CommitInternalChanges(db);
427 }
428
danielk1977b82e7ed2006-01-11 14:09:31 +0000429 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000430}
431
432/*
mistachkin48864df2013-03-21 21:20:32 +0000433** This routine is a no-op if the database schema is already initialized.
danielk1977fa256a32005-05-25 04:11:56 +0000434** Otherwise, the schema is loaded. An error code is returned.
435*/
436int sqlite3ReadSchema(Parse *pParse){
437 int rc = SQLITE_OK;
438 sqlite3 *db = pParse->db;
drhb1ab8ea2007-08-29 00:33:07 +0000439 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000440 if( !db->init.busy ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000441 rc = sqlite3Init(db, &pParse->zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000442 }
danielk1977fa256a32005-05-25 04:11:56 +0000443 if( rc!=SQLITE_OK ){
444 pParse->rc = rc;
445 pParse->nErr++;
446 }
447 return rc;
448}
449
450
451/*
452** Check schema cookies in all databases. If any cookie is out
drh1adecdf2009-07-03 19:19:50 +0000453** of date set pParse->rc to SQLITE_SCHEMA. If all schema cookies
454** make no changes to pParse->rc.
danielk1977fa256a32005-05-25 04:11:56 +0000455*/
danielk1977602b4662009-07-02 07:47:33 +0000456static void schemaIsValid(Parse *pParse){
457 sqlite3 *db = pParse->db;
danielk1977fa256a32005-05-25 04:11:56 +0000458 int iDb;
459 int rc;
danielk1977fa256a32005-05-25 04:11:56 +0000460 int cookie;
danielk1977fa256a32005-05-25 04:11:56 +0000461
danielk1977602b4662009-07-02 07:47:33 +0000462 assert( pParse->checkSchema );
463 assert( sqlite3_mutex_held(db->mutex) );
464 for(iDb=0; iDb<db->nDb; iDb++){
465 int openedTransaction = 0; /* True if a transaction is opened */
466 Btree *pBt = db->aDb[iDb].pBt; /* Btree database to read cookie from */
467 if( pBt==0 ) continue;
468
469 /* If there is not already a read-only (or read-write) transaction opened
470 ** on the b-tree database, open one now. If a transaction is opened, it
471 ** will be closed immediately after reading the meta-value. */
472 if( !sqlite3BtreeIsInReadTrans(pBt) ){
473 rc = sqlite3BtreeBeginTrans(pBt, 0);
drh1adecdf2009-07-03 19:19:50 +0000474 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977602b4662009-07-02 07:47:33 +0000475 db->mallocFailed = 1;
476 }
477 if( rc!=SQLITE_OK ) return;
478 openedTransaction = 1;
479 }
480
481 /* Read the schema cookie from the database. If it does not match the
shanehd77f56e2009-12-17 21:05:42 +0000482 ** value stored as part of the in-memory schema representation,
danielk1977602b4662009-07-02 07:47:33 +0000483 ** set Parse.rc to SQLITE_SCHEMA. */
484 sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
drh21206082011-04-04 18:22:02 +0000485 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk1977602b4662009-07-02 07:47:33 +0000486 if( cookie!=db->aDb[iDb].pSchema->schema_cookie ){
drh81028a42012-05-15 18:28:27 +0000487 sqlite3ResetOneSchema(db, iDb);
danielk1977602b4662009-07-02 07:47:33 +0000488 pParse->rc = SQLITE_SCHEMA;
489 }
490
491 /* Close the transaction, if one was opened. */
492 if( openedTransaction ){
493 sqlite3BtreeCommit(pBt);
494 }
495 }
danielk1977fa256a32005-05-25 04:11:56 +0000496}
497
498/*
drhf248e212006-01-25 22:50:38 +0000499** Convert a schema pointer into the iDb index that indicates
500** which database file in db->aDb[] the schema refers to.
501**
502** If the same database is attached more than once, the first
503** attached database is returned.
504*/
danielk1977e501b892006-01-09 06:29:47 +0000505int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
drh198bf392006-01-06 21:52:49 +0000506 int i = -1000000;
507
508 /* If pSchema is NULL, then return -1000000. This happens when code in
509 ** expr.c is trying to resolve a reference to a transient table (i.e. one
510 ** created by a sub-select). In this case the return value of this
511 ** function should never be used.
512 **
513 ** We return -1000000 instead of the more usual -1 simply because using
drh1c767f02009-01-09 02:49:31 +0000514 ** -1000000 as the incorrect index into db->aDb[] is much
drh198bf392006-01-06 21:52:49 +0000515 ** more likely to cause a segfault than -1 (of course there are assert()
516 ** statements too, but it never hurts to play the odds).
517 */
drhb1ab8ea2007-08-29 00:33:07 +0000518 assert( sqlite3_mutex_held(db->mutex) );
drh198bf392006-01-06 21:52:49 +0000519 if( pSchema ){
drh1c767f02009-01-09 02:49:31 +0000520 for(i=0; ALWAYS(i<db->nDb); i++){
drh198bf392006-01-06 21:52:49 +0000521 if( db->aDb[i].pSchema==pSchema ){
522 break;
523 }
524 }
drh1c767f02009-01-09 02:49:31 +0000525 assert( i>=0 && i<db->nDb );
drh198bf392006-01-06 21:52:49 +0000526 }
527 return i;
528}
529
530/*
drhf30a9692013-11-15 01:10:18 +0000531** Free all memory allocations in the pParse object
532*/
533void sqlite3ParserReset(Parse *pParse){
drh73d5b8f2013-12-23 19:09:07 +0000534 if( pParse ){
535 sqlite3 *db = pParse->db;
536 sqlite3DbFree(db, pParse->aLabel);
537 sqlite3ExprListDelete(db, pParse->pConstExpr);
538 }
drhf30a9692013-11-15 01:10:18 +0000539}
540
541/*
danielk1977fa256a32005-05-25 04:11:56 +0000542** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
543*/
mlcreech3a00f902008-03-04 17:45:01 +0000544static int sqlite3Prepare(
danielk1977fa256a32005-05-25 04:11:56 +0000545 sqlite3 *db, /* Database handle. */
546 const char *zSql, /* UTF-8 encoded SQL statement. */
547 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000548 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
dan937d0de2009-10-15 18:35:38 +0000549 Vdbe *pReprepare, /* VM being reprepared */
danielk1977fa256a32005-05-25 04:11:56 +0000550 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
drhb900aaf2006-11-09 00:24:53 +0000551 const char **pzTail /* OUT: End of parsed string */
danielk1977fa256a32005-05-25 04:11:56 +0000552){
drhe7b347072009-06-01 18:18:20 +0000553 Parse *pParse; /* Parsing context */
554 char *zErrMsg = 0; /* Error message */
555 int rc = SQLITE_OK; /* Result code */
556 int i; /* Loop counter */
danielk1977fa256a32005-05-25 04:11:56 +0000557
drhe7b347072009-06-01 18:18:20 +0000558 /* Allocate the parsing context */
559 pParse = sqlite3StackAllocZero(db, sizeof(*pParse));
560 if( pParse==0 ){
561 rc = SQLITE_NOMEM;
562 goto end_prepare;
563 }
dan937d0de2009-10-15 18:35:38 +0000564 pParse->pReprepare = pReprepare;
drh860e0772009-04-02 18:32:26 +0000565 assert( ppStmt && *ppStmt==0 );
drh86f8c192007-08-22 00:39:19 +0000566 assert( !db->mallocFailed );
drhb21c8cd2007-08-21 19:33:56 +0000567 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000568
drhc74d0b1d2009-02-24 16:18:05 +0000569 /* Check to verify that it is possible to get a read lock on all
570 ** database schemas. The inability to get a read lock indicates that
571 ** some other database connection is holding a write-lock, which in
572 ** turn means that the other connection has made uncommitted changes
573 ** to the schema.
574 **
575 ** Were we to proceed and prepare the statement against the uncommitted
576 ** schema changes and if those schema changes are subsequently rolled
577 ** back and different changes are made in their place, then when this
578 ** prepared statement goes to run the schema cookie would fail to detect
579 ** the schema change. Disaster would follow.
580 **
581 ** This thread is currently holding mutexes on all Btrees (because
582 ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
583 ** is not possible for another thread to start a new schema change
584 ** while this routine is running. Hence, we do not need to hold
585 ** locks on the schema, we just need to make sure nobody else is
586 ** holding them.
587 **
588 ** Note that setting READ_UNCOMMITTED overrides most lock detection,
589 ** but it does *not* override schema lock detection, so this all still
590 ** works even if READ_UNCOMMITTED is set.
danielk1977c87d34d2006-01-06 13:00:28 +0000591 */
592 for(i=0; i<db->nDb; i++) {
593 Btree *pBt = db->aDb[i].pBt;
drhb1ab8ea2007-08-29 00:33:07 +0000594 if( pBt ){
drhc74d0b1d2009-02-24 16:18:05 +0000595 assert( sqlite3BtreeHoldsMutex(pBt) );
drhb1ab8ea2007-08-29 00:33:07 +0000596 rc = sqlite3BtreeSchemaLocked(pBt);
597 if( rc ){
598 const char *zDb = db->aDb[i].zName;
drh13f40da2014-08-22 18:00:11 +0000599 sqlite3ErrorWithMsg(db, rc, "database schema is locked: %s", zDb);
drhc74d0b1d2009-02-24 16:18:05 +0000600 testcase( db->flags & SQLITE_ReadUncommitted );
drhe7b347072009-06-01 18:18:20 +0000601 goto end_prepare;
drhb1ab8ea2007-08-29 00:33:07 +0000602 }
danielk1977c87d34d2006-01-06 13:00:28 +0000603 }
604 }
drhe7b347072009-06-01 18:18:20 +0000605
danielk1977595a5232009-07-24 17:58:53 +0000606 sqlite3VtabUnlockList(db);
drhe7b347072009-06-01 18:18:20 +0000607
608 pParse->db = db;
drhc7f0d222013-06-19 03:27:12 +0000609 pParse->nQueryLoop = 0; /* Logarithmic, so 0 really means 1 */
drhd2d88bb2008-05-23 14:32:18 +0000610 if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
drhe5c941b2007-05-08 13:58:26 +0000611 char *zSqlCopy;
drhbb4957f2008-03-20 14:03:29 +0000612 int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
drh58fbb312009-06-17 00:35:30 +0000613 testcase( nBytes==mxLen );
614 testcase( nBytes==mxLen+1 );
drhbb4957f2008-03-20 14:03:29 +0000615 if( nBytes>mxLen ){
drh13f40da2014-08-22 18:00:11 +0000616 sqlite3ErrorWithMsg(db, SQLITE_TOOBIG, "statement too long");
drhe7b347072009-06-01 18:18:20 +0000617 rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
618 goto end_prepare;
drhe5c941b2007-05-08 13:58:26 +0000619 }
drh17435752007-08-16 04:30:38 +0000620 zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
drh276fdbf2007-04-30 21:39:16 +0000621 if( zSqlCopy ){
drhe7b347072009-06-01 18:18:20 +0000622 sqlite3RunParser(pParse, zSqlCopy, &zErrMsg);
drh633e6d52008-07-28 19:34:53 +0000623 sqlite3DbFree(db, zSqlCopy);
drhe7b347072009-06-01 18:18:20 +0000624 pParse->zTail = &zSql[pParse->zTail-zSqlCopy];
danielk19773a2c8c82008-04-03 14:36:25 +0000625 }else{
drhe7b347072009-06-01 18:18:20 +0000626 pParse->zTail = &zSql[nBytes];
drh276fdbf2007-04-30 21:39:16 +0000627 }
drh9051a422006-01-30 22:35:43 +0000628 }else{
drhe7b347072009-06-01 18:18:20 +0000629 sqlite3RunParser(pParse, zSql, &zErrMsg);
drh9051a422006-01-30 22:35:43 +0000630 }
drhc7f0d222013-06-19 03:27:12 +0000631 assert( 0==pParse->nQueryLoop );
danielk1977fa256a32005-05-25 04:11:56 +0000632
drh17435752007-08-16 04:30:38 +0000633 if( db->mallocFailed ){
drhe7b347072009-06-01 18:18:20 +0000634 pParse->rc = SQLITE_NOMEM;
danielk1977fa256a32005-05-25 04:11:56 +0000635 }
drhe7b347072009-06-01 18:18:20 +0000636 if( pParse->rc==SQLITE_DONE ) pParse->rc = SQLITE_OK;
danielk1977602b4662009-07-02 07:47:33 +0000637 if( pParse->checkSchema ){
638 schemaIsValid(pParse);
danielk1977fa256a32005-05-25 04:11:56 +0000639 }
drh17435752007-08-16 04:30:38 +0000640 if( db->mallocFailed ){
drhe7b347072009-06-01 18:18:20 +0000641 pParse->rc = SQLITE_NOMEM;
drh344a6272006-06-26 12:50:09 +0000642 }
drhb900aaf2006-11-09 00:24:53 +0000643 if( pzTail ){
drhe7b347072009-06-01 18:18:20 +0000644 *pzTail = pParse->zTail;
drhb900aaf2006-11-09 00:24:53 +0000645 }
drhe7b347072009-06-01 18:18:20 +0000646 rc = pParse->rc;
danielk1977fa256a32005-05-25 04:11:56 +0000647
648#ifndef SQLITE_OMIT_EXPLAIN
drhe7b347072009-06-01 18:18:20 +0000649 if( rc==SQLITE_OK && pParse->pVdbe && pParse->explain ){
650 static const char * const azColName[] = {
651 "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
dan2ce22452010-11-08 19:01:16 +0000652 "selectid", "order", "from", "detail"
drhe7b347072009-06-01 18:18:20 +0000653 };
654 int iFirst, mx;
655 if( pParse->explain==2 ){
dan2ce22452010-11-08 19:01:16 +0000656 sqlite3VdbeSetNumCols(pParse->pVdbe, 4);
drhe7b347072009-06-01 18:18:20 +0000657 iFirst = 8;
dan2ce22452010-11-08 19:01:16 +0000658 mx = 12;
drhecc92422005-09-10 16:46:12 +0000659 }else{
drhe7b347072009-06-01 18:18:20 +0000660 sqlite3VdbeSetNumCols(pParse->pVdbe, 8);
661 iFirst = 0;
662 mx = 8;
663 }
664 for(i=iFirst; i<mx; i++){
665 sqlite3VdbeSetColName(pParse->pVdbe, i-iFirst, COLNAME_NAME,
666 azColName[i], SQLITE_STATIC);
drhecc92422005-09-10 16:46:12 +0000667 }
drhb900aaf2006-11-09 00:24:53 +0000668 }
danielk1977fa256a32005-05-25 04:11:56 +0000669#endif
670
danielk19776ab3a2e2009-02-19 14:39:25 +0000671 if( db->init.busy==0 ){
drhe7b347072009-06-01 18:18:20 +0000672 Vdbe *pVdbe = pParse->pVdbe;
673 sqlite3VdbeSetSql(pVdbe, zSql, (int)(pParse->zTail-zSql), saveSqlFlag);
danielk19777e29e952007-04-19 11:09:01 +0000674 }
drhe7b347072009-06-01 18:18:20 +0000675 if( pParse->pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
676 sqlite3VdbeFinalize(pParse->pVdbe);
danielk19777e29e952007-04-19 11:09:01 +0000677 assert(!(*ppStmt));
678 }else{
drhe7b347072009-06-01 18:18:20 +0000679 *ppStmt = (sqlite3_stmt*)pParse->pVdbe;
danielk1977fa256a32005-05-25 04:11:56 +0000680 }
681
682 if( zErrMsg ){
drh13f40da2014-08-22 18:00:11 +0000683 sqlite3ErrorWithMsg(db, rc, "%s", zErrMsg);
drh633e6d52008-07-28 19:34:53 +0000684 sqlite3DbFree(db, zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000685 }else{
drh13f40da2014-08-22 18:00:11 +0000686 sqlite3Error(db, rc);
danielk1977fa256a32005-05-25 04:11:56 +0000687 }
danielk1977261919c2005-12-06 12:52:59 +0000688
dan65a7cd12009-09-01 12:16:01 +0000689 /* Delete any TriggerPrg structures allocated while parsing this statement. */
dan2832ad42009-08-31 15:27:27 +0000690 while( pParse->pTriggerPrg ){
691 TriggerPrg *pT = pParse->pTriggerPrg;
692 pParse->pTriggerPrg = pT->pNext;
dan165921a2009-08-28 18:53:45 +0000693 sqlite3DbFree(db, pT);
694 }
695
drhe7b347072009-06-01 18:18:20 +0000696end_prepare:
697
drhf30a9692013-11-15 01:10:18 +0000698 sqlite3ParserReset(pParse);
drhe7b347072009-06-01 18:18:20 +0000699 sqlite3StackFree(db, pParse);
danielk197754f01982006-01-18 15:25:17 +0000700 rc = sqlite3ApiExit(db, rc);
drh4ac285a2006-09-15 07:28:50 +0000701 assert( (rc&db->errMask)==rc );
danielk1977fa256a32005-05-25 04:11:56 +0000702 return rc;
703}
drhb21c8cd2007-08-21 19:33:56 +0000704static int sqlite3LockAndPrepare(
705 sqlite3 *db, /* Database handle. */
706 const char *zSql, /* UTF-8 encoded SQL statement. */
707 int nBytes, /* Length of zSql in bytes. */
708 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
dan937d0de2009-10-15 18:35:38 +0000709 Vdbe *pOld, /* VM being reprepared */
drhb21c8cd2007-08-21 19:33:56 +0000710 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
711 const char **pzTail /* OUT: End of parsed string */
712){
713 int rc;
drh9ca95732014-10-24 00:35:58 +0000714
715#ifdef SQLITE_ENABLE_API_ARMOR
716 if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
717#endif
drh860e0772009-04-02 18:32:26 +0000718 *ppStmt = 0;
drh9ca95732014-10-24 00:35:58 +0000719 if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
drh413c3d32010-02-23 20:11:56 +0000720 return SQLITE_MISUSE_BKPT;
drh27641702007-08-22 02:56:42 +0000721 }
drhb21c8cd2007-08-21 19:33:56 +0000722 sqlite3_mutex_enter(db->mutex);
drhb1ab8ea2007-08-29 00:33:07 +0000723 sqlite3BtreeEnterAll(db);
dan937d0de2009-10-15 18:35:38 +0000724 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
drh9da742f2009-06-16 17:49:36 +0000725 if( rc==SQLITE_SCHEMA ){
726 sqlite3_finalize(*ppStmt);
dan937d0de2009-10-15 18:35:38 +0000727 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, pOld, ppStmt, pzTail);
drh9da742f2009-06-16 17:49:36 +0000728 }
drhb1ab8ea2007-08-29 00:33:07 +0000729 sqlite3BtreeLeaveAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000730 sqlite3_mutex_leave(db->mutex);
drh74ea19b2012-05-14 12:20:54 +0000731 assert( rc==SQLITE_OK || *ppStmt==0 );
drhb21c8cd2007-08-21 19:33:56 +0000732 return rc;
733}
danielk1977fa256a32005-05-25 04:11:56 +0000734
drhb900aaf2006-11-09 00:24:53 +0000735/*
736** Rerun the compilation of a statement after a schema change.
danielk197765a2ea12009-03-19 07:58:31 +0000737**
738** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
739** if the statement cannot be recompiled because another connection has
740** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
741** occurs, return SQLITE_SCHEMA.
drhb900aaf2006-11-09 00:24:53 +0000742*/
743int sqlite3Reprepare(Vdbe *p){
744 int rc;
drh4f0c5872007-03-26 22:05:01 +0000745 sqlite3_stmt *pNew;
drhb900aaf2006-11-09 00:24:53 +0000746 const char *zSql;
747 sqlite3 *db;
drhb21c8cd2007-08-21 19:33:56 +0000748
drhb1ab8ea2007-08-29 00:33:07 +0000749 assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
danielk1977d0e2a852007-11-14 06:48:48 +0000750 zSql = sqlite3_sql((sqlite3_stmt *)p);
drhc4dd3fd2008-01-22 01:48:05 +0000751 assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
drhb900aaf2006-11-09 00:24:53 +0000752 db = sqlite3VdbeDb(p);
drhb21c8cd2007-08-21 19:33:56 +0000753 assert( sqlite3_mutex_held(db->mutex) );
dan937d0de2009-10-15 18:35:38 +0000754 rc = sqlite3LockAndPrepare(db, zSql, -1, 0, p, &pNew, 0);
drhb900aaf2006-11-09 00:24:53 +0000755 if( rc ){
danielk19778e556522007-11-13 10:30:24 +0000756 if( rc==SQLITE_NOMEM ){
757 db->mallocFailed = 1;
758 }
drhb900aaf2006-11-09 00:24:53 +0000759 assert( pNew==0 );
drha6129fa2010-02-24 17:15:19 +0000760 return rc;
drhb900aaf2006-11-09 00:24:53 +0000761 }else{
762 assert( pNew!=0 );
763 }
drh4f0c5872007-03-26 22:05:01 +0000764 sqlite3VdbeSwap((Vdbe*)pNew, p);
shane145834a2008-09-04 12:03:42 +0000765 sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
drh4f0c5872007-03-26 22:05:01 +0000766 sqlite3VdbeResetStepResult((Vdbe*)pNew);
767 sqlite3VdbeFinalize((Vdbe*)pNew);
danielk197765a2ea12009-03-19 07:58:31 +0000768 return SQLITE_OK;
drhb900aaf2006-11-09 00:24:53 +0000769}
770
771
772/*
773** Two versions of the official API. Legacy and new use. In the legacy
774** version, the original SQL text is not saved in the prepared statement
775** and so if a schema change occurs, SQLITE_SCHEMA is returned by
776** sqlite3_step(). In the new version, the original SQL text is retained
777** and the statement is automatically recompiled if an schema change
778** occurs.
779*/
780int sqlite3_prepare(
781 sqlite3 *db, /* Database handle. */
782 const char *zSql, /* UTF-8 encoded SQL statement. */
783 int nBytes, /* Length of zSql in bytes. */
784 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
785 const char **pzTail /* OUT: End of parsed string */
786){
drh17eaae72008-03-03 18:47:28 +0000787 int rc;
dan937d0de2009-10-15 18:35:38 +0000788 rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000789 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000790 return rc;
drhb900aaf2006-11-09 00:24:53 +0000791}
792int sqlite3_prepare_v2(
793 sqlite3 *db, /* Database handle. */
794 const char *zSql, /* UTF-8 encoded SQL statement. */
795 int nBytes, /* Length of zSql in bytes. */
796 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
797 const char **pzTail /* OUT: End of parsed string */
798){
drh17eaae72008-03-03 18:47:28 +0000799 int rc;
dan937d0de2009-10-15 18:35:38 +0000800 rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000801 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000802 return rc;
drhb900aaf2006-11-09 00:24:53 +0000803}
804
805
danielk1977fa256a32005-05-25 04:11:56 +0000806#ifndef SQLITE_OMIT_UTF16
807/*
808** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
809*/
drhb900aaf2006-11-09 00:24:53 +0000810static int sqlite3Prepare16(
danielk1977fa256a32005-05-25 04:11:56 +0000811 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000812 const void *zSql, /* UTF-16 encoded SQL statement. */
danielk1977fa256a32005-05-25 04:11:56 +0000813 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000814 int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000815 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
816 const void **pzTail /* OUT: End of parsed string */
817){
818 /* This function currently works by first transforming the UTF-16
819 ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
820 ** tricky bit is figuring out the pointer to return in *pzTail.
821 */
danielk197754f01982006-01-18 15:25:17 +0000822 char *zSql8;
danielk1977c87d34d2006-01-06 13:00:28 +0000823 const char *zTail8 = 0;
danielk197754f01982006-01-18 15:25:17 +0000824 int rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000825
drh9ca95732014-10-24 00:35:58 +0000826#ifdef SQLITE_ENABLE_API_ARMOR
827 if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
828#endif
drh769e97e2009-04-01 16:33:37 +0000829 *ppStmt = 0;
drh9ca95732014-10-24 00:35:58 +0000830 if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
drh413c3d32010-02-23 20:11:56 +0000831 return SQLITE_MISUSE_BKPT;
danielk1977fa256a32005-05-25 04:11:56 +0000832 }
drh7232ad02013-07-16 23:26:43 +0000833 if( nBytes>=0 ){
834 int sz;
835 const char *z = (const char*)zSql;
836 for(sz=0; sz<nBytes && (z[sz]!=0 || z[sz+1]!=0); sz += 2){}
837 nBytes = sz;
838 }
drhb21c8cd2007-08-21 19:33:56 +0000839 sqlite3_mutex_enter(db->mutex);
danb7dca7d2010-03-05 16:32:12 +0000840 zSql8 = sqlite3Utf16to8(db, zSql, nBytes, SQLITE_UTF16NATIVE);
danielk197754f01982006-01-18 15:25:17 +0000841 if( zSql8 ){
dan937d0de2009-10-15 18:35:38 +0000842 rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, 0, ppStmt, &zTail8);
danielk1977fa256a32005-05-25 04:11:56 +0000843 }
danielk1977fa256a32005-05-25 04:11:56 +0000844
845 if( zTail8 && pzTail ){
846 /* If sqlite3_prepare returns a tail pointer, we calculate the
847 ** equivalent pointer into the UTF-16 string by counting the unicode
848 ** characters between zSql8 and zTail8, and then returning a pointer
849 ** the same number of characters into the UTF-16 string.
850 */
drhea678832008-12-10 19:26:22 +0000851 int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
drhee858132007-05-08 20:37:38 +0000852 *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
danielk1977fa256a32005-05-25 04:11:56 +0000853 }
drh633e6d52008-07-28 19:34:53 +0000854 sqlite3DbFree(db, zSql8);
drhb21c8cd2007-08-21 19:33:56 +0000855 rc = sqlite3ApiExit(db, rc);
856 sqlite3_mutex_leave(db->mutex);
857 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000858}
drhb900aaf2006-11-09 00:24:53 +0000859
860/*
861** Two versions of the official API. Legacy and new use. In the legacy
862** version, the original SQL text is not saved in the prepared statement
863** and so if a schema change occurs, SQLITE_SCHEMA is returned by
864** sqlite3_step(). In the new version, the original SQL text is retained
865** and the statement is automatically recompiled if an schema change
866** occurs.
867*/
868int sqlite3_prepare16(
869 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000870 const void *zSql, /* UTF-16 encoded SQL statement. */
drhb900aaf2006-11-09 00:24:53 +0000871 int nBytes, /* Length of zSql in bytes. */
872 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
873 const void **pzTail /* OUT: End of parsed string */
874){
drh17eaae72008-03-03 18:47:28 +0000875 int rc;
876 rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000877 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000878 return rc;
drhb900aaf2006-11-09 00:24:53 +0000879}
880int sqlite3_prepare16_v2(
881 sqlite3 *db, /* Database handle. */
dan0ecdeb22011-01-25 13:43:35 +0000882 const void *zSql, /* UTF-16 encoded SQL statement. */
drhb900aaf2006-11-09 00:24:53 +0000883 int nBytes, /* Length of zSql in bytes. */
884 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
885 const void **pzTail /* OUT: End of parsed string */
886){
drh17eaae72008-03-03 18:47:28 +0000887 int rc;
888 rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000889 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000890 return rc;
drhb900aaf2006-11-09 00:24:53 +0000891}
892
danielk1977fa256a32005-05-25 04:11:56 +0000893#endif /* SQLITE_OMIT_UTF16 */