blob: 5308698797e2c4d54dd9af1afe13aa727f509ba4 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
drh75897232000-05-29 14:26:00 +000016*/
17#include "sqliteInt.h"
drh58f1c8b2008-05-26 20:19:25 +000018
drh820a9062008-01-31 13:35:48 +000019#ifdef SQLITE_ENABLE_FTS3
20# include "fts3.h"
21#endif
drh58f1c8b2008-05-26 20:19:25 +000022#ifdef SQLITE_ENABLE_RTREE
23# include "rtree.h"
24#endif
danielk19771c826652008-09-08 08:08:09 +000025#ifdef SQLITE_ENABLE_ICU
26# include "sqliteicu.h"
27#endif
drh75897232000-05-29 14:26:00 +000028
drhb3190c12008-12-08 21:37:14 +000029#ifndef SQLITE_AMALGAMATION
drh9f129f42010-08-31 15:27:32 +000030/* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
31** contains the text of SQLITE_VERSION macro.
32*/
danielk197724b03fd2004-05-10 10:34:34 +000033const char sqlite3_version[] = SQLITE_VERSION;
drhb3190c12008-12-08 21:37:14 +000034#endif
drh9f129f42010-08-31 15:27:32 +000035
36/* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
37** a pointer to the to the sqlite3_version[] string constant.
38*/
drh4aec8b62004-08-28 16:19:00 +000039const char *sqlite3_libversion(void){ return sqlite3_version; }
drh9f129f42010-08-31 15:27:32 +000040
41/* IMPLEMENTATION-OF: R-63124-39300 The sqlite3_sourceid() function returns a
42** pointer to a string constant whose value is the same as the
43** SQLITE_SOURCE_ID C preprocessor macro.
44*/
drh47baebc2009-08-14 16:01:24 +000045const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
drh9f129f42010-08-31 15:27:32 +000046
47/* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
48** returns an integer equal to SQLITE_VERSION_NUMBER.
49*/
danielk197799ba19e2005-02-05 07:33:34 +000050int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drh9f129f42010-08-31 15:27:32 +000051
drh5dc2bcd2012-01-02 15:45:12 +000052/* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
drhb8a45bb2011-12-31 21:51:55 +000053** zero if and only if SQLite was compiled with mutexing code omitted due to
drh9f129f42010-08-31 15:27:32 +000054** the SQLITE_THREADSAFE compile-time option being set to 0.
55*/
drhb67e8bf2007-08-30 20:09:48 +000056int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000057
drhe265b082008-05-01 17:03:49 +000058#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
drhb217a572000-08-22 13:40:18 +000059/*
drhb0603412007-02-28 04:47:26 +000060** If the following function pointer is not NULL and if
61** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
62** I/O active are written using this function. These messages
63** are intended for debugging activity only.
64*/
mlcreech3a00f902008-03-04 17:45:01 +000065void (*sqlite3IoTrace)(const char*, ...) = 0;
drhe265b082008-05-01 17:03:49 +000066#endif
drhb0603412007-02-28 04:47:26 +000067
68/*
drha16313e2007-03-30 11:29:32 +000069** If the following global variable points to a string which is the
70** name of a directory, then that directory will be used to store
71** temporary files.
72**
73** See also the "PRAGMA temp_store_directory" SQL command.
74*/
75char *sqlite3_temp_directory = 0;
76
drhc5499be2008-04-01 15:06:33 +000077/*
mistachkina112d142012-03-14 00:44:01 +000078** If the following global variable points to a string which is the
79** name of a directory, then that directory will be used to store
80** all database files specified with a relative pathname.
81**
82** See also the "PRAGMA data_store_directory" SQL command.
83*/
84char *sqlite3_data_directory = 0;
85
86/*
drh40257ff2008-06-13 18:24:27 +000087** Initialize SQLite.
88**
89** This routine must be called to initialize the memory allocation,
drh93ed56d2008-08-12 15:21:11 +000090** VFS, and mutex subsystems prior to doing any serious work with
drh40257ff2008-06-13 18:24:27 +000091** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
92** this routine will be called automatically by key routines such as
93** sqlite3_open().
94**
95** This routine is a no-op except on its very first call for the process,
96** or for the first call after a call to sqlite3_shutdown.
drh93ed56d2008-08-12 15:21:11 +000097**
98** The first thread to call this routine runs the initialization to
99** completion. If subsequent threads call this routine before the first
100** thread has finished the initialization process, then the subsequent
101** threads must block until the first thread finishes with the initialization.
102**
103** The first thread might call this routine recursively. Recursive
104** calls to this routine should not block, of course. Otherwise the
105** initialization process would never complete.
106**
107** Let X be the first thread to enter this routine. Let Y be some other
108** thread. Then while the initial invocation of this routine by X is
109** incomplete, it is required that:
110**
111** * Calls to this routine from Y must block until the outer-most
112** call by X completes.
113**
114** * Recursive calls to this routine from thread X return immediately
115** without blocking.
drh40257ff2008-06-13 18:24:27 +0000116*/
117int sqlite3_initialize(void){
drh30ddce62011-10-15 00:16:30 +0000118 MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
danielk1977075c23a2008-09-01 18:34:20 +0000119 int rc; /* Result code */
drhab80be92013-08-08 14:38:45 +0000120#ifdef SQLITE_EXTRA_INIT
121 int bRunExtraInit = 0; /* Extra initialization needed */
122#endif
danielk1977075c23a2008-09-01 18:34:20 +0000123
124#ifdef SQLITE_OMIT_WSD
danielk1977a8f83bf2008-09-02 16:22:28 +0000125 rc = sqlite3_wsd_init(4096, 24);
danielk1977075c23a2008-09-01 18:34:20 +0000126 if( rc!=SQLITE_OK ){
127 return rc;
128 }
129#endif
danielk197771bc31c2008-06-26 08:29:34 +0000130
drh93ed56d2008-08-12 15:21:11 +0000131 /* If SQLite is already completely initialized, then this call
132 ** to sqlite3_initialize() should be a no-op. But the initialization
133 ** must be complete. So isInit must not be set until the very end
134 ** of this routine.
135 */
danielk1977075c23a2008-09-01 18:34:20 +0000136 if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
danielk197771bc31c2008-06-26 08:29:34 +0000137
drh93ed56d2008-08-12 15:21:11 +0000138 /* Make sure the mutex subsystem is initialized. If unable to
139 ** initialize the mutex subsystem, return early with the error.
140 ** If the system is so sick that we are unable to allocate a mutex,
141 ** there is not much SQLite is going to be able to do.
142 **
143 ** The mutex subsystem must take care of serializing its own
144 ** initialization.
145 */
danielk1977d0251742008-06-18 18:57:42 +0000146 rc = sqlite3MutexInit();
drh93ed56d2008-08-12 15:21:11 +0000147 if( rc ) return rc;
danielk197771bc31c2008-06-26 08:29:34 +0000148
drh93ed56d2008-08-12 15:21:11 +0000149 /* Initialize the malloc() system and the recursive pInitMutex mutex.
150 ** This operation is protected by the STATIC_MASTER mutex. Note that
151 ** MutexAlloc() is called for a static mutex prior to initializing the
152 ** malloc subsystem - this implies that the allocation of a static
153 ** mutex must not require support from the malloc subsystem.
154 */
drh30ddce62011-10-15 00:16:30 +0000155 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drh93ed56d2008-08-12 15:21:11 +0000156 sqlite3_mutex_enter(pMaster);
dane1ab2192009-08-17 15:16:19 +0000157 sqlite3GlobalConfig.isMutexInit = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000158 if( !sqlite3GlobalConfig.isMallocInit ){
drh93ed56d2008-08-12 15:21:11 +0000159 rc = sqlite3MallocInit();
160 }
drh40257ff2008-06-13 18:24:27 +0000161 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000162 sqlite3GlobalConfig.isMallocInit = 1;
163 if( !sqlite3GlobalConfig.pInitMutex ){
drh9ac06502009-08-17 13:42:29 +0000164 sqlite3GlobalConfig.pInitMutex =
165 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
danielk1977075c23a2008-09-01 18:34:20 +0000166 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
drh93ed56d2008-08-12 15:21:11 +0000167 rc = SQLITE_NOMEM;
drh40257ff2008-06-13 18:24:27 +0000168 }
169 }
danielk197777eb5bb2008-09-22 17:22:19 +0000170 }
171 if( rc==SQLITE_OK ){
danielk1977075c23a2008-09-01 18:34:20 +0000172 sqlite3GlobalConfig.nRefInitMutex++;
drh93ed56d2008-08-12 15:21:11 +0000173 }
174 sqlite3_mutex_leave(pMaster);
danielk197771bc31c2008-06-26 08:29:34 +0000175
dane1ab2192009-08-17 15:16:19 +0000176 /* If rc is not SQLITE_OK at this point, then either the malloc
177 ** subsystem could not be initialized or the system failed to allocate
178 ** the pInitMutex mutex. Return an error in either case. */
drh93ed56d2008-08-12 15:21:11 +0000179 if( rc!=SQLITE_OK ){
180 return rc;
181 }
182
183 /* Do the rest of the initialization under the recursive mutex so
184 ** that we will be able to handle recursive calls into
185 ** sqlite3_initialize(). The recursive calls normally come through
186 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
187 ** recursive calls might also be possible.
drhf759bb82010-09-09 18:25:34 +0000188 **
189 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
190 ** to the xInit method, so the xInit method need not be threadsafe.
191 **
192 ** The following mutex is what serializes access to the appdef pcache xInit
193 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
194 ** call to sqlite3PcacheInitialize().
drh93ed56d2008-08-12 15:21:11 +0000195 */
danielk1977075c23a2008-09-01 18:34:20 +0000196 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
danielk1977502b4e02008-09-02 14:07:24 +0000197 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
danielk1977075c23a2008-09-01 18:34:20 +0000198 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
danielk1977502b4e02008-09-02 14:07:24 +0000199 sqlite3GlobalConfig.inProgress = 1;
danielk1977075c23a2008-09-01 18:34:20 +0000200 memset(pHash, 0, sizeof(sqlite3GlobalFunctions));
drh70a8ca32008-08-21 18:49:27 +0000201 sqlite3RegisterGlobalFunctions();
dane1ab2192009-08-17 15:16:19 +0000202 if( sqlite3GlobalConfig.isPCacheInit==0 ){
203 rc = sqlite3PcacheInitialize();
204 }
danielk19778c0a7912008-08-20 14:49:23 +0000205 if( rc==SQLITE_OK ){
dane1ab2192009-08-17 15:16:19 +0000206 sqlite3GlobalConfig.isPCacheInit = 1;
dan3d6e0602009-08-17 15:52:25 +0000207 rc = sqlite3OsInit();
drh0bf9f7b2009-04-17 16:54:22 +0000208 }
209 if( rc==SQLITE_OK ){
danielk19775b775292008-09-02 09:38:06 +0000210 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
211 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
drh0bf9f7b2009-04-17 16:54:22 +0000212 sqlite3GlobalConfig.isInit = 1;
drhab80be92013-08-08 14:38:45 +0000213#ifdef SQLITE_EXTRA_INIT
214 bRunExtraInit = 1;
215#endif
danielk19778c0a7912008-08-20 14:49:23 +0000216 }
danielk1977502b4e02008-09-02 14:07:24 +0000217 sqlite3GlobalConfig.inProgress = 0;
drh40257ff2008-06-13 18:24:27 +0000218 }
danielk1977075c23a2008-09-01 18:34:20 +0000219 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
shanedfb7b372008-07-22 05:13:30 +0000220
drh93ed56d2008-08-12 15:21:11 +0000221 /* Go back under the static mutex and clean up the recursive
222 ** mutex to prevent a resource leak.
223 */
224 sqlite3_mutex_enter(pMaster);
danielk1977075c23a2008-09-01 18:34:20 +0000225 sqlite3GlobalConfig.nRefInitMutex--;
226 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
227 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
228 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
229 sqlite3GlobalConfig.pInitMutex = 0;
drh93ed56d2008-08-12 15:21:11 +0000230 }
231 sqlite3_mutex_leave(pMaster);
232
233 /* The following is just a sanity check to make sure SQLite has
234 ** been compiled correctly. It is important to run this code, but
235 ** we don't want to run it too often and soak up CPU cycles for no
236 ** reason. So we run it once during initialization.
237 */
shanedfb7b372008-07-22 05:13:30 +0000238#ifndef NDEBUG
shanefbd60f82009-02-04 03:59:25 +0000239#ifndef SQLITE_OMIT_FLOATING_POINT
shanedfb7b372008-07-22 05:13:30 +0000240 /* This section of code's only "output" is via assert() statements. */
241 if ( rc==SQLITE_OK ){
242 u64 x = (((u64)1)<<63)-1;
243 double y;
244 assert(sizeof(x)==8);
245 assert(sizeof(x)==sizeof(y));
246 memcpy(&y, &x, 8);
247 assert( sqlite3IsNaN(y) );
248 }
249#endif
shanefbd60f82009-02-04 03:59:25 +0000250#endif
shanedfb7b372008-07-22 05:13:30 +0000251
drhe4cf0b32011-08-25 00:14:41 +0000252 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
253 ** compile-time option.
254 */
255#ifdef SQLITE_EXTRA_INIT
drhab80be92013-08-08 14:38:45 +0000256 if( bRunExtraInit ){
drhc7f94622011-12-13 18:22:38 +0000257 int SQLITE_EXTRA_INIT(const char*);
258 rc = SQLITE_EXTRA_INIT(0);
drhe4cf0b32011-08-25 00:14:41 +0000259 }
260#endif
261
drh40257ff2008-06-13 18:24:27 +0000262 return rc;
263}
264
265/*
266** Undo the effects of sqlite3_initialize(). Must not be called while
267** there are outstanding database connections or memory allocations or
268** while any part of SQLite is otherwise in use in any thread. This
drhd1a24402009-04-19 12:23:58 +0000269** routine is not threadsafe. But it is safe to invoke this routine
270** on when SQLite is already shut down. If SQLite is already shut down
271** when this routine is invoked, then this routine is a harmless no-op.
drh40257ff2008-06-13 18:24:27 +0000272*/
273int sqlite3_shutdown(void){
danielk1977075c23a2008-09-01 18:34:20 +0000274 if( sqlite3GlobalConfig.isInit ){
drh97977062011-12-13 01:34:21 +0000275#ifdef SQLITE_EXTRA_SHUTDOWN
276 void SQLITE_EXTRA_SHUTDOWN(void);
277 SQLITE_EXTRA_SHUTDOWN();
278#endif
drha7640922009-04-21 12:02:56 +0000279 sqlite3_os_end();
drhd1a24402009-04-19 12:23:58 +0000280 sqlite3_reset_auto_extension();
drhd1a24402009-04-19 12:23:58 +0000281 sqlite3GlobalConfig.isInit = 0;
danielk1977fb437272008-07-08 12:02:35 +0000282 }
dane1ab2192009-08-17 15:16:19 +0000283 if( sqlite3GlobalConfig.isPCacheInit ){
284 sqlite3PcacheShutdown();
285 sqlite3GlobalConfig.isPCacheInit = 0;
286 }
287 if( sqlite3GlobalConfig.isMallocInit ){
288 sqlite3MallocEnd();
289 sqlite3GlobalConfig.isMallocInit = 0;
mistachkin86f89872012-03-18 01:32:44 +0000290
291#ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
292 /* The heap subsystem has now been shutdown and these values are supposed
293 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
294 ** which would rely on that heap subsystem; therefore, make sure these
295 ** values cannot refer to heap memory that was just invalidated when the
296 ** heap subsystem was shutdown. This is only done if the current call to
297 ** this function resulted in the heap subsystem actually being shutdown.
298 */
299 sqlite3_data_directory = 0;
300 sqlite3_temp_directory = 0;
301#endif
dane1ab2192009-08-17 15:16:19 +0000302 }
303 if( sqlite3GlobalConfig.isMutexInit ){
304 sqlite3MutexEnd();
305 sqlite3GlobalConfig.isMutexInit = 0;
306 }
307
drh40257ff2008-06-13 18:24:27 +0000308 return SQLITE_OK;
309}
310
311/*
312** This API allows applications to modify the global configuration of
313** the SQLite library at run-time.
314**
315** This routine should only be called when there are no outstanding
316** database connections or memory allocations. This routine is not
317** threadsafe. Failure to heed these warnings can lead to unpredictable
318** behavior.
319*/
320int sqlite3_config(int op, ...){
321 va_list ap;
322 int rc = SQLITE_OK;
323
324 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
325 ** the SQLite library is in use. */
drh413c3d32010-02-23 20:11:56 +0000326 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
drh40257ff2008-06-13 18:24:27 +0000327
328 va_start(ap, op);
329 switch( op ){
drh18472fa2008-10-07 15:25:48 +0000330
331 /* Mutex configuration options are only available in a threadsafe
332 ** compile.
333 */
drhd68eee02009-12-11 03:44:18 +0000334#if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0
drh40257ff2008-06-13 18:24:27 +0000335 case SQLITE_CONFIG_SINGLETHREAD: {
336 /* Disable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000337 sqlite3GlobalConfig.bCoreMutex = 0;
338 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000339 break;
340 }
341 case SQLITE_CONFIG_MULTITHREAD: {
342 /* Disable mutexing of database connections */
343 /* Enable mutexing of core data structures */
danielk1977075c23a2008-09-01 18:34:20 +0000344 sqlite3GlobalConfig.bCoreMutex = 1;
345 sqlite3GlobalConfig.bFullMutex = 0;
drh40257ff2008-06-13 18:24:27 +0000346 break;
347 }
348 case SQLITE_CONFIG_SERIALIZED: {
349 /* Enable all mutexing */
danielk1977075c23a2008-09-01 18:34:20 +0000350 sqlite3GlobalConfig.bCoreMutex = 1;
351 sqlite3GlobalConfig.bFullMutex = 1;
drh40257ff2008-06-13 18:24:27 +0000352 break;
353 }
drh18472fa2008-10-07 15:25:48 +0000354 case SQLITE_CONFIG_MUTEX: {
355 /* Specify an alternative mutex implementation */
356 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
357 break;
358 }
359 case SQLITE_CONFIG_GETMUTEX: {
360 /* Retrieve the current mutex implementation */
361 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
362 break;
363 }
364#endif
365
366
drh40257ff2008-06-13 18:24:27 +0000367 case SQLITE_CONFIG_MALLOC: {
368 /* Specify an alternative malloc implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000369 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
drh40257ff2008-06-13 18:24:27 +0000370 break;
371 }
drh33589792008-06-18 13:27:46 +0000372 case SQLITE_CONFIG_GETMALLOC: {
danielk197757e5ea92008-06-24 19:02:55 +0000373 /* Retrieve the current malloc() implementation */
danielk1977075c23a2008-09-01 18:34:20 +0000374 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
375 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
drh33589792008-06-18 13:27:46 +0000376 break;
377 }
drhfec00ea2008-06-14 16:56:21 +0000378 case SQLITE_CONFIG_MEMSTATUS: {
drh40257ff2008-06-13 18:24:27 +0000379 /* Enable or disable the malloc status collection */
danielk1977075c23a2008-09-01 18:34:20 +0000380 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
drh40257ff2008-06-13 18:24:27 +0000381 break;
382 }
drh33589792008-06-18 13:27:46 +0000383 case SQLITE_CONFIG_SCRATCH: {
384 /* Designate a buffer for scratch memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000385 sqlite3GlobalConfig.pScratch = va_arg(ap, void*);
386 sqlite3GlobalConfig.szScratch = va_arg(ap, int);
387 sqlite3GlobalConfig.nScratch = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000388 break;
389 }
390 case SQLITE_CONFIG_PAGECACHE: {
drhb0937192009-05-22 10:53:29 +0000391 /* Designate a buffer for page cache memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000392 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
393 sqlite3GlobalConfig.szPage = va_arg(ap, int);
394 sqlite3GlobalConfig.nPage = va_arg(ap, int);
drh33589792008-06-18 13:27:46 +0000395 break;
396 }
danielk19775099be52008-06-27 13:27:03 +0000397
danielk1977bc2ca9e2008-11-13 14:28:28 +0000398 case SQLITE_CONFIG_PCACHE: {
dan22e21ff2011-11-08 20:08:44 +0000399 /* no-op */
400 break;
401 }
402 case SQLITE_CONFIG_GETPCACHE: {
403 /* now an error */
404 rc = SQLITE_ERROR;
danielk1977bc2ca9e2008-11-13 14:28:28 +0000405 break;
406 }
407
dan22e21ff2011-11-08 20:08:44 +0000408 case SQLITE_CONFIG_PCACHE2: {
409 /* Specify an alternative page cache implementation */
410 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
411 break;
412 }
413 case SQLITE_CONFIG_GETPCACHE2: {
414 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
drhb232c232008-11-19 01:20:26 +0000415 sqlite3PCacheSetDefault();
416 }
dan22e21ff2011-11-08 20:08:44 +0000417 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
drhb232c232008-11-19 01:20:26 +0000418 break;
419 }
420
drh5d414832008-07-15 14:47:18 +0000421#if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
drh33589792008-06-18 13:27:46 +0000422 case SQLITE_CONFIG_HEAP: {
danielk19775099be52008-06-27 13:27:03 +0000423 /* Designate a buffer for heap memory space */
danielk1977075c23a2008-09-01 18:34:20 +0000424 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
425 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
426 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
danielk19775099be52008-06-27 13:27:03 +0000427
shaneha6ec8922011-03-09 21:36:17 +0000428 if( sqlite3GlobalConfig.mnReq<1 ){
429 sqlite3GlobalConfig.mnReq = 1;
430 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
431 /* cap min request size at 2^12 */
432 sqlite3GlobalConfig.mnReq = (1<<12);
433 }
434
danielk1977075c23a2008-09-01 18:34:20 +0000435 if( sqlite3GlobalConfig.pHeap==0 ){
drh8a42cbd2008-07-10 18:13:42 +0000436 /* If the heap pointer is NULL, then restore the malloc implementation
437 ** back to NULL pointers too. This will cause the malloc to go
438 ** back to its default implementation when sqlite3_initialize() is
439 ** run.
440 */
danielk1977075c23a2008-09-01 18:34:20 +0000441 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
drh8a42cbd2008-07-10 18:13:42 +0000442 }else{
443 /* The heap pointer is not NULL, then install one of the
mistachkin037933b2013-08-13 22:33:41 +0000444 ** mem5.c/mem3.c methods. The enclosing #if guarantees at
445 ** least one of these methods is currently enabled.
drh8a42cbd2008-07-10 18:13:42 +0000446 */
danielk19775099be52008-06-27 13:27:03 +0000447#ifdef SQLITE_ENABLE_MEMSYS3
danielk1977075c23a2008-09-01 18:34:20 +0000448 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
drh8a42cbd2008-07-10 18:13:42 +0000449#endif
450#ifdef SQLITE_ENABLE_MEMSYS5
danielk1977075c23a2008-09-01 18:34:20 +0000451 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
drh8a42cbd2008-07-10 18:13:42 +0000452#endif
drh8a42cbd2008-07-10 18:13:42 +0000453 }
danielk19775099be52008-06-27 13:27:03 +0000454 break;
455 }
drh5d414832008-07-15 14:47:18 +0000456#endif
danielk19775099be52008-06-27 13:27:03 +0000457
drh633e6d52008-07-28 19:34:53 +0000458 case SQLITE_CONFIG_LOOKASIDE: {
danielk1977075c23a2008-09-01 18:34:20 +0000459 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
460 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
drh633e6d52008-07-28 19:34:53 +0000461 break;
462 }
drh3f280702010-02-18 18:45:09 +0000463
mistachkin037933b2013-08-13 22:33:41 +0000464 /* Record a pointer to the logger function and its first argument.
drh3f280702010-02-18 18:45:09 +0000465 ** The default is NULL. Logging is disabled if the function pointer is
466 ** NULL.
467 */
468 case SQLITE_CONFIG_LOG: {
shanehdc97a8c2010-02-23 20:08:35 +0000469 /* MSVC is picky about pulling func ptrs from va lists.
470 ** http://support.microsoft.com/kb/47961
471 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
472 */
473 typedef void(*LOGFUNC_t)(void*,int,const char*);
474 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
drh3f280702010-02-18 18:45:09 +0000475 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
476 break;
477 }
drh633e6d52008-07-28 19:34:53 +0000478
drh00729cb2014-10-04 11:59:33 +0000479 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
480 ** can be changed at start-time using the
481 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
482 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
483 */
dancd74b612011-04-22 19:37:32 +0000484 case SQLITE_CONFIG_URI: {
485 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
486 break;
487 }
488
drhde9a7b82012-09-17 20:44:46 +0000489 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
490 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
491 break;
492 }
493
danac455932012-11-26 19:50:41 +0000494#ifdef SQLITE_ENABLE_SQLLOG
495 case SQLITE_CONFIG_SQLLOG: {
496 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
497 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
498 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
499 break;
500 }
501#endif
502
drh9b4c59f2013-04-15 17:03:42 +0000503 case SQLITE_CONFIG_MMAP_SIZE: {
504 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
drha1f42c72013-04-01 22:38:06 +0000505 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
drh9b4c59f2013-04-15 17:03:42 +0000506 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
507 mxMmap = SQLITE_MAX_MMAP_SIZE;
508 }
drha1f42c72013-04-01 22:38:06 +0000509 sqlite3GlobalConfig.mxMmap = mxMmap;
drh9b4c59f2013-04-15 17:03:42 +0000510 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
511 if( szMmap>mxMmap) szMmap = mxMmap;
512 sqlite3GlobalConfig.szMmap = szMmap;
drha1f42c72013-04-01 22:38:06 +0000513 break;
514 }
515
mistachkinac1f1042013-11-23 00:27:29 +0000516#if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC)
mistachkinaf8641b2013-11-25 21:49:04 +0000517 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
mistachkinac1f1042013-11-23 00:27:29 +0000518 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
519 break;
520 }
521#endif
522
drh40257ff2008-06-13 18:24:27 +0000523 default: {
524 rc = SQLITE_ERROR;
525 break;
526 }
527 }
528 va_end(ap);
529 return rc;
530}
531
532/*
drh633e6d52008-07-28 19:34:53 +0000533** Set up the lookaside buffers for a database connection.
534** Return SQLITE_OK on success.
535** If lookaside is already active, return SQLITE_BUSY.
drhe9d1c722008-08-04 20:13:26 +0000536**
537** The sz parameter is the number of bytes in each lookaside slot.
538** The cnt parameter is the number of slots. If pStart is NULL the
539** space for the lookaside memory is obtained from sqlite3_malloc().
540** If pStart is not NULL then it is sz*cnt bytes of memory to use for
541** the lookaside memory.
drh633e6d52008-07-28 19:34:53 +0000542*/
drhe9d1c722008-08-04 20:13:26 +0000543static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
drh633e6d52008-07-28 19:34:53 +0000544 void *pStart;
545 if( db->lookaside.nOut ){
546 return SQLITE_BUSY;
547 }
shanef71f89e2009-01-30 06:11:54 +0000548 /* Free any existing lookaside buffer for this handle before
549 ** allocating a new one so we don't have to have space for
550 ** both at the same time.
551 */
552 if( db->lookaside.bMalloced ){
553 sqlite3_free(db->lookaside.pStart);
554 }
drh61a4bd52011-11-10 02:39:28 +0000555 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
556 ** than a pointer to be useful.
shanef71f89e2009-01-30 06:11:54 +0000557 */
drh61a4bd52011-11-10 02:39:28 +0000558 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
drh1d34fde2009-02-03 15:50:33 +0000559 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
drh633e6d52008-07-28 19:34:53 +0000560 if( cnt<0 ) cnt = 0;
shanef71f89e2009-01-30 06:11:54 +0000561 if( sz==0 || cnt==0 ){
562 sz = 0;
563 pStart = 0;
564 }else if( pBuf==0 ){
drhe9d1c722008-08-04 20:13:26 +0000565 sqlite3BeginBenignMalloc();
drh9dd55f52010-09-03 03:32:46 +0000566 pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
drhe9d1c722008-08-04 20:13:26 +0000567 sqlite3EndBenignMalloc();
drh8225d662011-11-10 02:24:11 +0000568 if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
drhe9d1c722008-08-04 20:13:26 +0000569 }else{
570 pStart = pBuf;
571 }
drh4cfb22f2008-08-01 18:47:01 +0000572 db->lookaside.pStart = pStart;
573 db->lookaside.pFree = 0;
drh1bd10f82008-12-10 21:19:56 +0000574 db->lookaside.sz = (u16)sz;
drh633e6d52008-07-28 19:34:53 +0000575 if( pStart ){
576 int i;
577 LookasideSlot *p;
drhde467982009-04-02 17:22:41 +0000578 assert( sz > (int)sizeof(LookasideSlot*) );
drh633e6d52008-07-28 19:34:53 +0000579 p = (LookasideSlot*)pStart;
580 for(i=cnt-1; i>=0; i--){
581 p->pNext = db->lookaside.pFree;
582 db->lookaside.pFree = p;
583 p = (LookasideSlot*)&((u8*)p)[sz];
584 }
585 db->lookaside.pEnd = p;
586 db->lookaside.bEnabled = 1;
shanef71f89e2009-01-30 06:11:54 +0000587 db->lookaside.bMalloced = pBuf==0 ?1:0;
drh4cfb22f2008-08-01 18:47:01 +0000588 }else{
drhb0e77042013-12-10 19:49:00 +0000589 db->lookaside.pStart = db;
590 db->lookaside.pEnd = db;
drh4cfb22f2008-08-01 18:47:01 +0000591 db->lookaside.bEnabled = 0;
shanef71f89e2009-01-30 06:11:54 +0000592 db->lookaside.bMalloced = 0;
drh633e6d52008-07-28 19:34:53 +0000593 }
594 return SQLITE_OK;
595}
596
597/*
drh4413d0e2008-11-04 13:46:27 +0000598** Return the mutex associated with a database connection.
599*/
600sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000601#ifdef SQLITE_ENABLE_API_ARMOR
602 if( !sqlite3SafetyCheckOk(db) ){
603 (void)SQLITE_MISUSE_BKPT;
604 return 0;
605 }
606#endif
drh4413d0e2008-11-04 13:46:27 +0000607 return db->mutex;
608}
609
610/*
drh09419b42011-11-16 19:29:17 +0000611** Free up as much memory as we can from the given database
612** connection.
613*/
614int sqlite3_db_release_memory(sqlite3 *db){
615 int i;
drh9ca95732014-10-24 00:35:58 +0000616
617#ifdef SQLITE_ENABLE_API_ARMOR
618 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
619#endif
dand9bb3a92011-12-30 11:43:59 +0000620 sqlite3_mutex_enter(db->mutex);
drh09419b42011-11-16 19:29:17 +0000621 sqlite3BtreeEnterAll(db);
622 for(i=0; i<db->nDb; i++){
623 Btree *pBt = db->aDb[i].pBt;
624 if( pBt ){
625 Pager *pPager = sqlite3BtreePager(pBt);
626 sqlite3PagerShrink(pPager);
627 }
628 }
629 sqlite3BtreeLeaveAll(db);
dand9bb3a92011-12-30 11:43:59 +0000630 sqlite3_mutex_leave(db->mutex);
drh09419b42011-11-16 19:29:17 +0000631 return SQLITE_OK;
632}
633
634/*
drh633e6d52008-07-28 19:34:53 +0000635** Configuration settings for an individual database connection
636*/
637int sqlite3_db_config(sqlite3 *db, int op, ...){
638 va_list ap;
drh6480aad2008-08-01 16:31:14 +0000639 int rc;
drh633e6d52008-07-28 19:34:53 +0000640 va_start(ap, op);
641 switch( op ){
drhe9d1c722008-08-04 20:13:26 +0000642 case SQLITE_DBCONFIG_LOOKASIDE: {
drh8b2b2e62011-04-07 01:14:12 +0000643 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
drh9dd55f52010-09-03 03:32:46 +0000644 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
645 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
drhe9d1c722008-08-04 20:13:26 +0000646 rc = setupLookaside(db, pBuf, sz, cnt);
drh633e6d52008-07-28 19:34:53 +0000647 break;
648 }
drh6480aad2008-08-01 16:31:14 +0000649 default: {
drhe83cafd2011-03-21 17:15:58 +0000650 static const struct {
651 int op; /* The opcode */
652 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
653 } aFlagOp[] = {
654 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
655 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
656 };
drh58ad5802011-03-23 22:02:23 +0000657 unsigned int i;
drh9dd55f52010-09-03 03:32:46 +0000658 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
drhe83cafd2011-03-21 17:15:58 +0000659 for(i=0; i<ArraySize(aFlagOp); i++){
660 if( aFlagOp[i].op==op ){
661 int onoff = va_arg(ap, int);
662 int *pRes = va_arg(ap, int*);
drhd7b302b2011-03-23 22:54:59 +0000663 int oldFlags = db->flags;
drhe83cafd2011-03-21 17:15:58 +0000664 if( onoff>0 ){
665 db->flags |= aFlagOp[i].mask;
666 }else if( onoff==0 ){
667 db->flags &= ~aFlagOp[i].mask;
668 }
669 if( oldFlags!=db->flags ){
670 sqlite3ExpirePreparedStatements(db);
671 }
672 if( pRes ){
673 *pRes = (db->flags & aFlagOp[i].mask)!=0;
674 }
675 rc = SQLITE_OK;
676 break;
677 }
678 }
drh6480aad2008-08-01 16:31:14 +0000679 break;
680 }
drh633e6d52008-07-28 19:34:53 +0000681 }
682 va_end(ap);
683 return rc;
684}
685
drha16313e2007-03-30 11:29:32 +0000686
687/*
drh9b5adfa2008-01-20 23:19:56 +0000688** Return true if the buffer z[0..n-1] contains all spaces.
689*/
690static int allSpaces(const char *z, int n){
drh5f3a3672008-04-15 04:02:40 +0000691 while( n>0 && z[n-1]==' ' ){ n--; }
drh9b5adfa2008-01-20 23:19:56 +0000692 return n==0;
693}
694
695/*
drhd3d39e92004-05-20 22:16:29 +0000696** This is the default collating function named "BINARY" which is always
697** available.
drh9b5adfa2008-01-20 23:19:56 +0000698**
699** If the padFlag argument is not NULL then space padding at the end
700** of strings is ignored. This implements the RTRIM collation.
drhd3d39e92004-05-20 22:16:29 +0000701*/
danielk19772c336542005-01-13 02:14:23 +0000702static int binCollFunc(
drh9b5adfa2008-01-20 23:19:56 +0000703 void *padFlag,
drhd3d39e92004-05-20 22:16:29 +0000704 int nKey1, const void *pKey1,
705 int nKey2, const void *pKey2
706){
707 int rc, n;
708 n = nKey1<nKey2 ? nKey1 : nKey2;
709 rc = memcmp(pKey1, pKey2, n);
710 if( rc==0 ){
drh9b5adfa2008-01-20 23:19:56 +0000711 if( padFlag
712 && allSpaces(((char*)pKey1)+n, nKey1-n)
713 && allSpaces(((char*)pKey2)+n, nKey2-n)
714 ){
715 /* Leave rc unchanged at 0 */
716 }else{
717 rc = nKey1 - nKey2;
718 }
drhd3d39e92004-05-20 22:16:29 +0000719 }
720 return rc;
721}
722
723/*
danielk1977dc1bdc42004-06-11 10:51:27 +0000724** Another built-in collating sequence: NOCASE.
725**
drhf7b54962013-05-28 12:11:54 +0000726** This collating sequence is intended to be used for "case independent
danielk1977dc1bdc42004-06-11 10:51:27 +0000727** comparison". SQLite's knowledge of upper and lower case equivalents
728** extends only to the 26 characters used in the English language.
729**
730** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +0000731*/
732static int nocaseCollatingFunc(
733 void *NotUsed,
734 int nKey1, const void *pKey1,
735 int nKey2, const void *pKey2
736){
737 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +0000738 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk197762c14b32008-11-19 09:05:26 +0000739 UNUSED_PARAMETER(NotUsed);
danielk19770202b292004-06-09 09:55:16 +0000740 if( 0==r ){
741 r = nKey1-nKey2;
742 }
743 return r;
744}
745
746/*
drhaf9ff332002-01-16 21:00:27 +0000747** Return the ROWID of the most recent insert
748*/
drh9bb575f2004-09-06 17:24:11 +0000749sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000750#ifdef SQLITE_ENABLE_API_ARMOR
751 if( !sqlite3SafetyCheckOk(db) ){
752 (void)SQLITE_MISUSE_BKPT;
753 return 0;
754 }
755#endif
drhaf9ff332002-01-16 21:00:27 +0000756 return db->lastRowid;
757}
758
759/*
danielk197724b03fd2004-05-10 10:34:34 +0000760** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +0000761*/
drh9bb575f2004-09-06 17:24:11 +0000762int sqlite3_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000763#ifdef SQLITE_ENABLE_API_ARMOR
764 if( !sqlite3SafetyCheckOk(db) ){
765 (void)SQLITE_MISUSE_BKPT;
766 return 0;
767 }
768#endif
drhc8d30ac2002-04-12 10:08:59 +0000769 return db->nChange;
770}
771
rdcf146a772004-02-25 22:51:06 +0000772/*
danielk1977b28af712004-06-21 06:50:26 +0000773** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000774*/
danielk1977b28af712004-06-21 06:50:26 +0000775int sqlite3_total_changes(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +0000776#ifdef SQLITE_ENABLE_API_ARMOR
777 if( !sqlite3SafetyCheckOk(db) ){
778 (void)SQLITE_MISUSE_BKPT;
779 return 0;
780 }
781#endif
danielk1977b28af712004-06-21 06:50:26 +0000782 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000783}
784
drhc8d30ac2002-04-12 10:08:59 +0000785/*
danielk1977fd7f0452008-12-17 17:30:26 +0000786** Close all open savepoints. This function only manipulates fields of the
787** database handle object, it does not close any savepoints that may be open
788** at the b-tree/pager level.
789*/
790void sqlite3CloseSavepoints(sqlite3 *db){
791 while( db->pSavepoint ){
792 Savepoint *pTmp = db->pSavepoint;
793 db->pSavepoint = pTmp->pNext;
794 sqlite3DbFree(db, pTmp);
795 }
796 db->nSavepoint = 0;
danielk1977bd434552009-03-18 10:33:00 +0000797 db->nStatement = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000798 db->isTransactionSavepoint = 0;
799}
800
801/*
dand2199f02010-08-27 17:48:52 +0000802** Invoke the destructor function associated with FuncDef p, if any. Except,
803** if this is not the last copy of the function, do not invoke it. Multiple
804** copies of a single function are created when create_function() is called
805** with SQLITE_ANY as the encoding.
806*/
807static void functionDestroy(sqlite3 *db, FuncDef *p){
808 FuncDestructor *pDestructor = p->pDestructor;
809 if( pDestructor ){
810 pDestructor->nRef--;
811 if( pDestructor->nRef==0 ){
812 pDestructor->xDestroy(pDestructor->pUserData);
813 sqlite3DbFree(db, pDestructor);
814 }
815 }
816}
817
818/*
danbba02a92012-05-15 17:15:34 +0000819** Disconnect all sqlite3_vtab objects that belong to database connection
820** db. This is called when db is being closed.
821*/
822static void disconnectAllVtab(sqlite3 *db){
823#ifndef SQLITE_OMIT_VIRTUALTABLE
824 int i;
825 sqlite3BtreeEnterAll(db);
826 for(i=0; i<db->nDb; i++){
827 Schema *pSchema = db->aDb[i].pSchema;
828 if( db->aDb[i].pSchema ){
829 HashElem *p;
830 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
831 Table *pTab = (Table *)sqliteHashData(p);
832 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
833 }
834 }
835 }
dand88e5212014-03-12 19:38:38 +0000836 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000837 sqlite3BtreeLeaveAll(db);
838#else
839 UNUSED_PARAMETER(db);
840#endif
841}
842
843/*
drh167cd6a2012-06-02 17:09:46 +0000844** Return TRUE if database connection db has unfinalized prepared
845** statements or unfinished sqlite3_backup objects.
846*/
847static int connectionIsBusy(sqlite3 *db){
848 int j;
849 assert( sqlite3_mutex_held(db->mutex) );
850 if( db->pVdbe ) return 1;
851 for(j=0; j<db->nDb; j++){
852 Btree *pBt = db->aDb[j].pBt;
853 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
854 }
855 return 0;
856}
857
858/*
drh50e5dad2001-09-15 00:57:28 +0000859** Close an existing SQLite database
860*/
drh167cd6a2012-06-02 17:09:46 +0000861static int sqlite3Close(sqlite3 *db, int forceZombie){
danielk19775c4c7782004-06-16 10:39:23 +0000862 if( !db ){
drhddb17ca2014-08-11 15:54:11 +0000863 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
864 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
danielk197796d81f92004-06-19 03:33:57 +0000865 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000866 }
drh7e8b8482008-01-23 03:03:05 +0000867 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +0000868 return SQLITE_MISUSE_BKPT;
danielk1977e35ee192004-06-26 09:50:11 +0000869 }
drh605264d2007-08-21 15:13:19 +0000870 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000871
danbba02a92012-05-15 17:15:34 +0000872 /* Force xDisconnect calls on all virtual tables */
873 disconnectAllVtab(db);
danielk1977a04a34f2007-04-16 15:06:25 +0000874
danbba02a92012-05-15 17:15:34 +0000875 /* If a transaction is open, the disconnectAllVtab() call above
danielk197701256832007-04-18 14:24:32 +0000876 ** will not have called the xDisconnect() method on any virtual
877 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
878 ** call will do so. We need to do this before the check for active
879 ** SQL statements below, as the v-table implementation may be storing
880 ** some prepared statements internally.
881 */
dan67430812013-05-15 10:21:50 +0000882 sqlite3VtabRollback(db);
danielk197701256832007-04-18 14:24:32 +0000883
drh167cd6a2012-06-02 17:09:46 +0000884 /* Legacy behavior (sqlite3_close() behavior) is to return
885 ** SQLITE_BUSY if the connection can not be closed immediately.
886 */
887 if( !forceZombie && connectionIsBusy(db) ){
drh13f40da2014-08-22 18:00:11 +0000888 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
drh167cd6a2012-06-02 17:09:46 +0000889 "statements or unfinished backups");
drh27641702007-08-22 02:56:42 +0000890 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000891 return SQLITE_BUSY;
892 }
danielk1977e0048402004-06-15 16:51:01 +0000893
danac455932012-11-26 19:50:41 +0000894#ifdef SQLITE_ENABLE_SQLLOG
895 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +0000896 /* Closing the handle. Fourth parameter is passed the value 2. */
897 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
danac455932012-11-26 19:50:41 +0000898 }
899#endif
900
drh167cd6a2012-06-02 17:09:46 +0000901 /* Convert the connection into a zombie and then close it.
drh4245c402012-06-02 14:32:21 +0000902 */
903 db->magic = SQLITE_MAGIC_ZOMBIE;
904 sqlite3LeaveMutexAndCloseZombie(db);
905 return SQLITE_OK;
906}
drh94e92032003-02-16 22:21:32 +0000907
drh167cd6a2012-06-02 17:09:46 +0000908/*
909** Two variations on the public interface for closing a database
910** connection. The sqlite3_close() version returns SQLITE_BUSY and
911** leaves the connection option if there are unfinalized prepared
912** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
913** version forces the connection to become a zombie if there are
914** unclosed resources, and arranges for deallocation when the last
915** prepare statement or sqlite3_backup closes.
916*/
917int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
918int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
919
drh4245c402012-06-02 14:32:21 +0000920
921/*
922** Close the mutex on database connection db.
923**
924** Furthermore, if database connection db is a zombie (meaning that there
drh167cd6a2012-06-02 17:09:46 +0000925** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
926** every sqlite3_stmt has now been finalized and every sqlite3_backup has
927** finished, then free all resources.
drh4245c402012-06-02 14:32:21 +0000928*/
929void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
930 HashElem *i; /* Hash table iterator */
931 int j;
932
drh4245c402012-06-02 14:32:21 +0000933 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
drh167cd6a2012-06-02 17:09:46 +0000934 ** or if the connection has not yet been closed by sqlite3_close_v2(),
935 ** then just leave the mutex and return.
drh4245c402012-06-02 14:32:21 +0000936 */
drh167cd6a2012-06-02 17:09:46 +0000937 if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
drh4245c402012-06-02 14:32:21 +0000938 sqlite3_mutex_leave(db->mutex);
939 return;
danielk197704103022009-02-03 16:51:24 +0000940 }
941
drh4245c402012-06-02 14:32:21 +0000942 /* If we reach this point, it means that the database connection has
943 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
mistachkin48864df2013-03-21 21:20:32 +0000944 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
drh4245c402012-06-02 14:32:21 +0000945 ** go ahead and free all resources.
946 */
947
dan617dc862013-05-16 11:57:28 +0000948 /* If a transaction is open, roll it back. This also ensures that if
949 ** any database schemas have been modified by an uncommitted transaction
950 ** they are reset. And that the required b-tree mutex is held to make
951 ** the pager rollback and schema reset an atomic operation. */
952 sqlite3RollbackAll(db, SQLITE_OK);
953
danielk1977fd7f0452008-12-17 17:30:26 +0000954 /* Free any outstanding Savepoint structures. */
955 sqlite3CloseSavepoints(db);
956
drh5efb3142012-05-16 01:24:34 +0000957 /* Close all database connections */
drh001bbcb2003-03-19 03:14:00 +0000958 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000959 struct Db *pDb = &db->aDb[j];
960 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000961 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000962 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000963 if( j!=1 ){
964 pDb->pSchema = 0;
965 }
drh113088e2003-03-20 01:16:58 +0000966 }
drhf57b3392001-10-08 13:22:32 +0000967 }
drh5efb3142012-05-16 01:24:34 +0000968 /* Clear the TEMP schema separately and last */
969 if( db->aDb[1].pSchema ){
970 sqlite3SchemaClear(db->aDb[1].pSchema);
971 }
972 sqlite3VtabUnlockList(db);
danbba02a92012-05-15 17:15:34 +0000973
drh5efb3142012-05-16 01:24:34 +0000974 /* Free up the array of auxiliary databases */
975 sqlite3CollapseDatabaseArray(db);
danbba02a92012-05-15 17:15:34 +0000976 assert( db->nDb<=2 );
977 assert( db->aDb==db->aDbStatic );
danielk1977404ca072009-03-16 13:19:36 +0000978
979 /* Tell the code in notify.c that the connection no longer holds any
980 ** locks and does not require any further unlock-notify callbacks.
981 */
982 sqlite3ConnectionClosed(db);
983
drh70a8ca32008-08-21 18:49:27 +0000984 for(j=0; j<ArraySize(db->aFunc.a); j++){
985 FuncDef *pNext, *pHash, *p;
986 for(p=db->aFunc.a[j]; p; p=pHash){
987 pHash = p->pHash;
988 while( p ){
dand2199f02010-08-27 17:48:52 +0000989 functionDestroy(db, p);
drh70a8ca32008-08-21 18:49:27 +0000990 pNext = p->pNext;
991 sqlite3DbFree(db, p);
992 p = pNext;
993 }
drh8e0a2f92002-02-23 23:45:45 +0000994 }
995 }
danielk1977d8123362004-06-12 09:25:12 +0000996 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000997 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000998 /* Invoke any destructors registered for collation sequence user data. */
999 for(j=0; j<3; j++){
1000 if( pColl[j].xDel ){
1001 pColl[j].xDel(pColl[j].pUser);
1002 }
1003 }
drh633e6d52008-07-28 19:34:53 +00001004 sqlite3DbFree(db, pColl);
danielk1977466be562004-06-10 02:16:01 +00001005 }
danielk1977d8123362004-06-12 09:25:12 +00001006 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00001007#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +00001008 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1009 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +00001010 if( pMod->xDestroy ){
1011 pMod->xDestroy(pMod->pAux);
1012 }
drh633e6d52008-07-28 19:34:53 +00001013 sqlite3DbFree(db, pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +00001014 }
drhb9bb7c12006-06-11 23:41:55 +00001015 sqlite3HashClear(&db->aModule);
1016#endif
danielk1977466be562004-06-10 02:16:01 +00001017
drh13f40da2014-08-22 18:00:11 +00001018 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
drha3cc0072013-12-13 16:23:55 +00001019 sqlite3ValueFree(db->pErr);
drhf1952c52006-06-08 15:48:00 +00001020 sqlite3CloseExtensions(db);
drhd4530972014-09-09 14:47:53 +00001021#if SQLITE_USER_AUTHENTICATION
1022 sqlite3_free(db->auth.zAuthUser);
1023 sqlite3_free(db->auth.zAuthPW);
1024#endif
danielk197796d81f92004-06-19 03:33:57 +00001025
1026 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +00001027
1028 /* The temp-database schema is allocated differently from the other schema
1029 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1030 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1031 ** the same sqliteMalloc() as the one that allocates the database
1032 ** structure?
1033 */
drh633e6d52008-07-28 19:34:53 +00001034 sqlite3DbFree(db, db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +00001035 sqlite3_mutex_leave(db->mutex);
drh7e8b8482008-01-23 03:03:05 +00001036 db->magic = SQLITE_MAGIC_CLOSED;
drh605264d2007-08-21 15:13:19 +00001037 sqlite3_mutex_free(db->mutex);
drh4150ebf2008-10-11 15:38:29 +00001038 assert( db->lookaside.nOut==0 ); /* Fails on a lookaside memory leak */
drhe9d1c722008-08-04 20:13:26 +00001039 if( db->lookaside.bMalloced ){
1040 sqlite3_free(db->lookaside.pStart);
1041 }
drh17435752007-08-16 04:30:38 +00001042 sqlite3_free(db);
drh75897232000-05-29 14:26:00 +00001043}
1044
1045/*
drh0f198a72012-02-13 16:43:16 +00001046** Rollback all database files. If tripCode is not SQLITE_OK, then
1047** any open cursors are invalidated ("tripped" - as in "tripping a circuit
1048** breaker") and made to return tripCode if there are any further
1049** attempts to use that cursor.
drh001bbcb2003-03-19 03:14:00 +00001050*/
drh0f198a72012-02-13 16:43:16 +00001051void sqlite3RollbackAll(sqlite3 *db, int tripCode){
drh001bbcb2003-03-19 03:14:00 +00001052 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +00001053 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +00001054 assert( sqlite3_mutex_held(db->mutex) );
danielk19772d1d86f2008-06-20 14:59:51 +00001055 sqlite3BeginBenignMalloc();
dan617dc862013-05-16 11:57:28 +00001056
1057 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1058 ** This is important in case the transaction being rolled back has
1059 ** modified the database schema. If the b-tree mutexes are not taken
1060 ** here, then another shared-cache connection might sneak in between
1061 ** the database rollback and schema reset, which can cause false
1062 ** corruption reports in some cases. */
dancd7b91a2013-05-13 18:23:15 +00001063 sqlite3BtreeEnterAll(db);
dan617dc862013-05-16 11:57:28 +00001064
drh001bbcb2003-03-19 03:14:00 +00001065 for(i=0; i<db->nDb; i++){
drh0f198a72012-02-13 16:43:16 +00001066 Btree *p = db->aDb[i].pBt;
1067 if( p ){
1068 if( sqlite3BtreeIsInTrans(p) ){
danielk1977f3f06bb2005-12-16 15:24:28 +00001069 inTrans = 1;
1070 }
drh0f198a72012-02-13 16:43:16 +00001071 sqlite3BtreeRollback(p, tripCode);
drh001bbcb2003-03-19 03:14:00 +00001072 }
1073 }
danielk1977a298e902006-06-22 09:53:48 +00001074 sqlite3VtabRollback(db);
danielk19772d1d86f2008-06-20 14:59:51 +00001075 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001076
drh5c5760a2013-02-19 18:34:45 +00001077 if( (db->flags&SQLITE_InternChanges)!=0 && db->init.busy==0 ){
danielk1977ea4d9e22007-08-13 15:28:33 +00001078 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00001079 sqlite3ResetAllSchemasOfConnection(db);
danielk197771fd80b2005-12-16 06:54:01 +00001080 }
dancd7b91a2013-05-13 18:23:15 +00001081 sqlite3BtreeLeaveAll(db);
danielk197771fd80b2005-12-16 06:54:01 +00001082
dan1da40a32009-09-19 17:00:31 +00001083 /* Any deferred constraint violations have now been resolved. */
1084 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00001085 db->nDeferredImmCons = 0;
1086 db->flags &= ~SQLITE_DeferFKs;
dan1da40a32009-09-19 17:00:31 +00001087
danielk197771fd80b2005-12-16 06:54:01 +00001088 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +00001089 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +00001090 db->xRollbackCallback(db->pRollbackArg);
1091 }
drh001bbcb2003-03-19 03:14:00 +00001092}
1093
1094/*
mistachkinf2c1c992013-04-28 01:44:43 +00001095** Return a static string containing the name corresponding to the error code
1096** specified in the argument.
1097*/
drh54027102014-08-06 14:36:53 +00001098#if (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) || defined(SQLITE_TEST)
mistachkinf2c1c992013-04-28 01:44:43 +00001099const char *sqlite3ErrName(int rc){
1100 const char *zName = 0;
mistachkin10269dc2013-04-30 07:54:42 +00001101 int i, origRc = rc;
mistachkinf2c1c992013-04-28 01:44:43 +00001102 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1103 switch( rc ){
1104 case SQLITE_OK: zName = "SQLITE_OK"; break;
1105 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1106 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1107 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1108 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001109 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001110 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001111 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
danf73819a2013-06-27 11:46:27 +00001112 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001113 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1114 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1115 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1116 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001117 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1118 case SQLITE_READONLY_CANTLOCK: zName = "SQLITE_READONLY_CANTLOCK"; break;
1119 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
mistachkin091a81b2013-12-06 19:58:32 +00001120 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001121 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1122 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001123 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1124 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1125 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1126 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1127 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1128 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1129 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1130 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1131 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1132 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001133 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1134 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1135 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1136 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1137 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1138 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1139 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1140 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1141 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1142 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1143 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1144 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1145 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1146 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
mistachkin16a2e7a2013-07-31 22:27:16 +00001147 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001148 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001149 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001150 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001151 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1152 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1153 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001154 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1155 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1156 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
mistachkind95a3d32013-08-30 21:52:38 +00001157 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001158 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1159 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1160 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1161 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1162 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1163 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1164 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1165 case SQLITE_CONSTRAINT_FOREIGNKEY:
1166 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1167 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1168 case SQLITE_CONSTRAINT_PRIMARYKEY:
1169 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1170 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1171 case SQLITE_CONSTRAINT_COMMITHOOK:
1172 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1173 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1174 case SQLITE_CONSTRAINT_FUNCTION:
1175 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
drhf9c8ce32013-11-05 13:33:55 +00001176 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001177 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1178 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1179 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1180 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1181 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1182 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1183 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1184 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1185 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
mistachkine84d8d32013-04-29 03:09:10 +00001186 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1187 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1188 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001189 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
drh8d56e202013-06-28 23:55:45 +00001190 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001191 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
mistachkinf2c1c992013-04-28 01:44:43 +00001192 }
1193 }
mistachkin10269dc2013-04-30 07:54:42 +00001194 if( zName==0 ){
1195 static char zBuf[50];
1196 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1197 zName = zBuf;
1198 }
mistachkinf2c1c992013-04-28 01:44:43 +00001199 return zName;
1200}
mistachkin10269dc2013-04-30 07:54:42 +00001201#endif
mistachkinf2c1c992013-04-28 01:44:43 +00001202
1203/*
drhc22bd472002-05-10 13:14:07 +00001204** Return a static string that describes the kind of error specified in the
1205** argument.
drh247be432002-05-10 05:44:55 +00001206*/
danielk1977f20b21c2004-05-31 23:56:42 +00001207const char *sqlite3ErrStr(int rc){
drh51c7d862009-04-27 18:46:06 +00001208 static const char* const aMsg[] = {
1209 /* SQLITE_OK */ "not an error",
1210 /* SQLITE_ERROR */ "SQL logic error or missing database",
1211 /* SQLITE_INTERNAL */ 0,
1212 /* SQLITE_PERM */ "access permission denied",
1213 /* SQLITE_ABORT */ "callback requested query abort",
1214 /* SQLITE_BUSY */ "database is locked",
1215 /* SQLITE_LOCKED */ "database table is locked",
1216 /* SQLITE_NOMEM */ "out of memory",
1217 /* SQLITE_READONLY */ "attempt to write a readonly database",
1218 /* SQLITE_INTERRUPT */ "interrupted",
1219 /* SQLITE_IOERR */ "disk I/O error",
1220 /* SQLITE_CORRUPT */ "database disk image is malformed",
drh0b52b7d2011-01-26 19:46:22 +00001221 /* SQLITE_NOTFOUND */ "unknown operation",
drh51c7d862009-04-27 18:46:06 +00001222 /* SQLITE_FULL */ "database or disk is full",
1223 /* SQLITE_CANTOPEN */ "unable to open database file",
dan0dc7b742010-06-04 15:59:58 +00001224 /* SQLITE_PROTOCOL */ "locking protocol",
drh51c7d862009-04-27 18:46:06 +00001225 /* SQLITE_EMPTY */ "table contains no data",
1226 /* SQLITE_SCHEMA */ "database schema has changed",
drh4c8555f2009-06-25 01:47:11 +00001227 /* SQLITE_TOOBIG */ "string or blob too big",
drh51c7d862009-04-27 18:46:06 +00001228 /* SQLITE_CONSTRAINT */ "constraint failed",
1229 /* SQLITE_MISMATCH */ "datatype mismatch",
1230 /* SQLITE_MISUSE */ "library routine called out of sequence",
1231 /* SQLITE_NOLFS */ "large file support is disabled",
1232 /* SQLITE_AUTH */ "authorization denied",
1233 /* SQLITE_FORMAT */ "auxiliary database format error",
1234 /* SQLITE_RANGE */ "bind or column index out of range",
1235 /* SQLITE_NOTADB */ "file is encrypted or is not a database",
1236 };
drh21021a52012-02-13 17:01:51 +00001237 const char *zErr = "unknown error";
1238 switch( rc ){
1239 case SQLITE_ABORT_ROLLBACK: {
1240 zErr = "abort due to ROLLBACK";
1241 break;
1242 }
1243 default: {
1244 rc &= 0xff;
1245 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1246 zErr = aMsg[rc];
1247 }
1248 break;
1249 }
drh247be432002-05-10 05:44:55 +00001250 }
drh21021a52012-02-13 17:01:51 +00001251 return zErr;
drh247be432002-05-10 05:44:55 +00001252}
1253
1254/*
drh2dfbbca2000-07-28 14:32:48 +00001255** This routine implements a busy callback that sleeps and tries
1256** again until a timeout value is reached. The timeout value is
1257** an integer number of milliseconds passed in as the first
1258** argument.
1259*/
drhdaffd0e2001-04-11 14:28:42 +00001260static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +00001261 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +00001262 int count /* Number of times table has been busy */
1263){
danielk197729bafea2008-06-26 10:41:19 +00001264#if SQLITE_OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +00001265 static const u8 delays[] =
1266 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1267 static const u8 totals[] =
1268 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhfcd71b62011-04-05 22:08:24 +00001269# define NDELAY ArraySize(delays)
danielk1977b4b47412007-08-17 15:53:36 +00001270 sqlite3 *db = (sqlite3 *)ptr;
1271 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +00001272 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +00001273
drhee570fa2005-04-28 12:06:05 +00001274 assert( count>=0 );
1275 if( count < NDELAY ){
1276 delay = delays[count];
1277 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +00001278 }else{
1279 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +00001280 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +00001281 }
drhd1bec472004-01-15 13:29:31 +00001282 if( prior + delay > timeout ){
1283 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +00001284 if( delay<=0 ) return 0;
1285 }
danielk19772a6bdf62007-08-20 16:07:00 +00001286 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +00001287 return 1;
1288#else
drh482ea182007-08-20 11:12:40 +00001289 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +00001290 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +00001291 if( (count+1)*1000 > timeout ){
1292 return 0;
1293 }
drh482ea182007-08-20 11:12:40 +00001294 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +00001295 return 1;
1296#endif
1297}
1298
1299/*
drha4afb652005-07-09 02:16:02 +00001300** Invoke the given busy handler.
1301**
1302** This routine is called when an operation failed with a lock.
1303** If this routine returns non-zero, the lock is retried. If it
1304** returns 0, the operation aborts with an SQLITE_BUSY error.
1305*/
1306int sqlite3InvokeBusyHandler(BusyHandler *p){
1307 int rc;
drh34004ce2008-07-11 16:15:17 +00001308 if( NEVER(p==0) || p->xFunc==0 || p->nBusy<0 ) return 0;
drha4afb652005-07-09 02:16:02 +00001309 rc = p->xFunc(p->pArg, p->nBusy);
1310 if( rc==0 ){
1311 p->nBusy = -1;
1312 }else{
1313 p->nBusy++;
1314 }
1315 return rc;
1316}
1317
1318/*
drh2dfbbca2000-07-28 14:32:48 +00001319** This routine sets the busy callback for an Sqlite database to the
1320** given callback function with the given argument.
1321*/
danielk1977f9d64d22004-06-19 08:18:07 +00001322int sqlite3_busy_handler(
1323 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +00001324 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +00001325 void *pArg
1326){
drh9ca95732014-10-24 00:35:58 +00001327#ifdef SQLITE_ENABLE_API_ARMOR
1328 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE;
1329#endif
drhe30f4422007-08-21 16:15:55 +00001330 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +00001331 db->busyHandler.xFunc = xBusy;
1332 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +00001333 db->busyHandler.nBusy = 0;
drhc0c7b5e2012-09-07 18:49:57 +00001334 db->busyTimeout = 0;
drhe30f4422007-08-21 16:15:55 +00001335 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +00001336 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001337}
1338
danielk1977348bb5d2003-10-18 09:37:26 +00001339#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1340/*
1341** This routine sets the progress callback for an Sqlite database to the
1342** given callback function with the given argument. The progress callback will
1343** be invoked every nOps opcodes.
1344*/
danielk197724b03fd2004-05-10 10:34:34 +00001345void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +00001346 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +00001347 int nOps,
1348 int (*xProgress)(void*),
1349 void *pArg
1350){
drh9ca95732014-10-24 00:35:58 +00001351#ifdef SQLITE_ENABLE_API_ARMOR
1352 if( !sqlite3SafetyCheckOk(db) ){
1353 (void)SQLITE_MISUSE_BKPT;
1354 return;
1355 }
1356#endif
drhbd0b1b52008-07-07 19:52:09 +00001357 sqlite3_mutex_enter(db->mutex);
1358 if( nOps>0 ){
1359 db->xProgress = xProgress;
drh8f8c65f2013-07-10 18:14:29 +00001360 db->nProgressOps = (unsigned)nOps;
drhbd0b1b52008-07-07 19:52:09 +00001361 db->pProgressArg = pArg;
1362 }else{
1363 db->xProgress = 0;
1364 db->nProgressOps = 0;
1365 db->pProgressArg = 0;
danielk1977348bb5d2003-10-18 09:37:26 +00001366 }
drhbd0b1b52008-07-07 19:52:09 +00001367 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +00001368}
1369#endif
1370
1371
drh2dfbbca2000-07-28 14:32:48 +00001372/*
1373** This routine installs a default busy handler that waits for the
1374** specified number of milliseconds before returning 0.
1375*/
danielk1977f9d64d22004-06-19 08:18:07 +00001376int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh9ca95732014-10-24 00:35:58 +00001377#ifdef SQLITE_ENABLE_API_ARMOR
1378 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1379#endif
drh2dfbbca2000-07-28 14:32:48 +00001380 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +00001381 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drhc0c7b5e2012-09-07 18:49:57 +00001382 db->busyTimeout = ms;
drh2dfbbca2000-07-28 14:32:48 +00001383 }else{
danielk197724b03fd2004-05-10 10:34:34 +00001384 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +00001385 }
danielk1977f9d64d22004-06-19 08:18:07 +00001386 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +00001387}
drh4c504392000-10-16 22:06:40 +00001388
1389/*
1390** Cause any pending operation to stop at its earliest opportunity.
1391*/
drh9bb575f2004-09-06 17:24:11 +00001392void sqlite3_interrupt(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00001393#ifdef SQLITE_ENABLE_API_ARMOR
1394 if( !sqlite3SafetyCheckOk(db) ){
1395 (void)SQLITE_MISUSE_BKPT;
1396 return;
1397 }
1398#endif
drhbd0b1b52008-07-07 19:52:09 +00001399 db->u1.isInterrupted = 1;
drh4c504392000-10-16 22:06:40 +00001400}
drhfa86c412002-02-02 15:01:15 +00001401
drhfa86c412002-02-02 15:01:15 +00001402
1403/*
danielk1977771151b2006-01-17 13:21:40 +00001404** This function is exactly the same as sqlite3_create_function(), except
1405** that it is designed to be called by internal code. The difference is
1406** that if a malloc() fails in sqlite3_create_function(), an error code
1407** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +00001408*/
danielk1977771151b2006-01-17 13:21:40 +00001409int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +00001410 sqlite3 *db,
1411 const char *zFunctionName,
1412 int nArg,
danielk1977d8123362004-06-12 09:25:12 +00001413 int enc,
danielk197765904932004-05-26 06:18:37 +00001414 void *pUserData,
1415 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1416 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
dand2199f02010-08-27 17:48:52 +00001417 void (*xFinal)(sqlite3_context*),
1418 FuncDestructor *pDestructor
drh8e0a2f92002-02-23 23:45:45 +00001419){
drh0bce8352002-02-28 00:41:10 +00001420 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +00001421 int nName;
drh4a8ee3d2013-12-14 13:44:22 +00001422 int extraFlags;
danielk197765904932004-05-26 06:18:37 +00001423
drhe30f4422007-08-21 16:15:55 +00001424 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +00001425 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +00001426 (xFunc && (xFinal || xStep)) ||
1427 (!xFunc && (xFinal && !xStep)) ||
1428 (!xFunc && (!xFinal && xStep)) ||
drh24b58dd2008-07-07 14:50:14 +00001429 (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
drhdee0e402009-05-03 20:23:53 +00001430 (255<(nName = sqlite3Strlen30( zFunctionName))) ){
drh413c3d32010-02-23 20:11:56 +00001431 return SQLITE_MISUSE_BKPT;
danielk197765904932004-05-26 06:18:37 +00001432 }
drh4a8ee3d2013-12-14 13:44:22 +00001433
1434 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1435 extraFlags = enc & SQLITE_DETERMINISTIC;
1436 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
danielk1977d8123362004-06-12 09:25:12 +00001437
danielk197793758c82005-01-21 08:13:14 +00001438#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001439 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1440 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1441 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1442 **
1443 ** If SQLITE_ANY is specified, add three versions of the function
1444 ** to the hash table.
1445 */
1446 if( enc==SQLITE_UTF16 ){
1447 enc = SQLITE_UTF16NATIVE;
1448 }else if( enc==SQLITE_ANY ){
1449 int rc;
drh4a8ee3d2013-12-14 13:44:22 +00001450 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
dand2199f02010-08-27 17:48:52 +00001451 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001452 if( rc==SQLITE_OK ){
drh4a8ee3d2013-12-14 13:44:22 +00001453 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
dand2199f02010-08-27 17:48:52 +00001454 pUserData, xFunc, xStep, xFinal, pDestructor);
drhe30f4422007-08-21 16:15:55 +00001455 }
1456 if( rc!=SQLITE_OK ){
1457 return rc;
1458 }
danielk1977d8123362004-06-12 09:25:12 +00001459 enc = SQLITE_UTF16BE;
1460 }
danielk197793758c82005-01-21 08:13:14 +00001461#else
1462 enc = SQLITE_UTF8;
1463#endif
danielk19779636c4e2005-01-25 04:27:54 +00001464
1465 /* Check if an existing function is being overridden or deleted. If so,
1466 ** and there are active VMs, then return SQLITE_BUSY. If a function
1467 ** is being overridden/deleted but there are no active VMs, allow the
1468 ** operation to continue but invalidate all precompiled statements.
1469 */
drh3abbd392008-12-10 23:04:13 +00001470 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 0);
drhd36e1042013-09-06 13:10:12 +00001471 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
drh4f7d3a52013-06-27 23:54:02 +00001472 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00001473 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00001474 "unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +00001475 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +00001476 return SQLITE_BUSY;
1477 }else{
1478 sqlite3ExpirePreparedStatements(db);
1479 }
1480 }
danielk197765904932004-05-26 06:18:37 +00001481
drh3abbd392008-12-10 23:04:13 +00001482 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, (u8)enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +00001483 assert(p || db->mallocFailed);
1484 if( !p ){
1485 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +00001486 }
dand2199f02010-08-27 17:48:52 +00001487
1488 /* If an older version of the function with a configured destructor is
1489 ** being replaced invoke the destructor function here. */
1490 functionDestroy(db, p);
1491
1492 if( pDestructor ){
1493 pDestructor->nRef++;
1494 }
1495 p->pDestructor = pDestructor;
drh4a8ee3d2013-12-14 13:44:22 +00001496 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1497 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
danielk1977fa18bec2007-09-03 11:04:22 +00001498 p->xFunc = xFunc;
1499 p->xStep = xStep;
1500 p->xFinalize = xFinal;
1501 p->pUserData = pUserData;
drh1bd10f82008-12-10 21:19:56 +00001502 p->nArg = (u16)nArg;
danielk197765904932004-05-26 06:18:37 +00001503 return SQLITE_OK;
1504}
danielk1977771151b2006-01-17 13:21:40 +00001505
1506/*
1507** Create new user functions.
1508*/
1509int sqlite3_create_function(
1510 sqlite3 *db,
dand2199f02010-08-27 17:48:52 +00001511 const char *zFunc,
danielk1977771151b2006-01-17 13:21:40 +00001512 int nArg,
1513 int enc,
1514 void *p,
1515 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1516 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1517 void (*xFinal)(sqlite3_context*)
1518){
drh7b19fac2010-08-27 18:44:54 +00001519 return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xFunc, xStep,
1520 xFinal, 0);
dand2199f02010-08-27 17:48:52 +00001521}
1522
1523int sqlite3_create_function_v2(
1524 sqlite3 *db,
1525 const char *zFunc,
1526 int nArg,
1527 int enc,
1528 void *p,
1529 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
1530 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1531 void (*xFinal)(sqlite3_context*),
1532 void (*xDestroy)(void *)
1533){
shanehbd2aaf92010-09-01 02:38:21 +00001534 int rc = SQLITE_ERROR;
dand2199f02010-08-27 17:48:52 +00001535 FuncDestructor *pArg = 0;
drh9ca95732014-10-24 00:35:58 +00001536
1537#ifdef SQLITE_ENABLE_API_ARMOR
1538 if( !sqlite3SafetyCheckOk(db) ){
1539 return SQLITE_MISUSE_BKPT;
1540 }
1541#endif
dand2199f02010-08-27 17:48:52 +00001542 sqlite3_mutex_enter(db->mutex);
1543 if( xDestroy ){
1544 pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
dan9508daa2010-08-28 18:58:00 +00001545 if( !pArg ){
1546 xDestroy(p);
1547 goto out;
1548 }
dand2199f02010-08-27 17:48:52 +00001549 pArg->xDestroy = xDestroy;
1550 pArg->pUserData = p;
1551 }
1552 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xFunc, xStep, xFinal, pArg);
1553 if( pArg && pArg->nRef==0 ){
1554 assert( rc!=SQLITE_OK );
dan9508daa2010-08-28 18:58:00 +00001555 xDestroy(p);
dand2199f02010-08-27 17:48:52 +00001556 sqlite3DbFree(db, pArg);
1557 }
1558
1559 out:
drhe30f4422007-08-21 16:15:55 +00001560 rc = sqlite3ApiExit(db, rc);
1561 sqlite3_mutex_leave(db->mutex);
1562 return rc;
danielk1977771151b2006-01-17 13:21:40 +00001563}
1564
danielk197793758c82005-01-21 08:13:14 +00001565#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +00001566int sqlite3_create_function16(
1567 sqlite3 *db,
1568 const void *zFunctionName,
1569 int nArg,
1570 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +00001571 void *p,
danielk197765904932004-05-26 06:18:37 +00001572 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
1573 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1574 void (*xFinal)(sqlite3_context*)
1575){
1576 int rc;
drhaf9a7c22005-12-15 03:04:10 +00001577 char *zFunc8;
drh9ca95732014-10-24 00:35:58 +00001578
1579#ifdef SQLITE_ENABLE_API_ARMOR
1580 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1581#endif
drhe30f4422007-08-21 16:15:55 +00001582 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001583 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00001584 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
dand2199f02010-08-27 17:48:52 +00001585 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal,0);
drh633e6d52008-07-28 19:34:53 +00001586 sqlite3DbFree(db, zFunc8);
drhe30f4422007-08-21 16:15:55 +00001587 rc = sqlite3ApiExit(db, rc);
1588 sqlite3_mutex_leave(db->mutex);
1589 return rc;
drh8e0a2f92002-02-23 23:45:45 +00001590}
danielk197793758c82005-01-21 08:13:14 +00001591#endif
drhc9b84a12002-06-20 11:36:48 +00001592
drhb7481e72006-09-16 21:45:14 +00001593
1594/*
1595** Declare that a function has been overloaded by a virtual table.
1596**
1597** If the function already exists as a regular global function, then
1598** this routine is a no-op. If the function does not exist, then create
1599** a new one that always throws a run-time error.
1600**
1601** When virtual tables intend to provide an overloaded function, they
1602** should call this routine to make sure the global function exists.
1603** A global function must exist in order for name resolution to work
1604** properly.
1605*/
1606int sqlite3_overload_function(
1607 sqlite3 *db,
1608 const char *zName,
1609 int nArg
1610){
drhdee0e402009-05-03 20:23:53 +00001611 int nName = sqlite3Strlen30(zName);
drhcb5e4db2011-10-12 23:49:49 +00001612 int rc = SQLITE_OK;
drh9ca95732014-10-24 00:35:58 +00001613
1614#ifdef SQLITE_ENABLE_API_ARMOR
1615 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1616 return SQLITE_MISUSE_BKPT;
1617 }
1618#endif
drhe30f4422007-08-21 16:15:55 +00001619 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +00001620 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
drhcb5e4db2011-10-12 23:49:49 +00001621 rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
1622 0, sqlite3InvalidFunction, 0, 0, 0);
drhb7481e72006-09-16 21:45:14 +00001623 }
drhcb5e4db2011-10-12 23:49:49 +00001624 rc = sqlite3ApiExit(db, rc);
drhe30f4422007-08-21 16:15:55 +00001625 sqlite3_mutex_leave(db->mutex);
1626 return rc;
drhb7481e72006-09-16 21:45:14 +00001627}
1628
drh19e2d372005-08-29 23:00:03 +00001629#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +00001630/*
drh18de4822003-01-16 16:28:53 +00001631** Register a trace function. The pArg from the previously registered trace
1632** is returned.
1633**
1634** A NULL trace function means that no tracing is executes. A non-NULL
1635** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +00001636** SQL statement.
drh18de4822003-01-16 16:28:53 +00001637*/
drh9bb575f2004-09-06 17:24:11 +00001638void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +00001639 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001640
1641#ifdef SQLITE_ENABLE_API_ARMOR
1642 if( !sqlite3SafetyCheckOk(db) ){
1643 (void)SQLITE_MISUSE_BKPT;
1644 return 0;
1645 }
1646#endif
drhe30f4422007-08-21 16:15:55 +00001647 sqlite3_mutex_enter(db->mutex);
1648 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +00001649 db->xTrace = xTrace;
1650 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001651 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +00001652 return pOld;
drh0d1a6432003-04-03 15:46:04 +00001653}
drh19e2d372005-08-29 23:00:03 +00001654/*
1655** Register a profile function. The pArg from the previously registered
1656** profile function is returned.
1657**
1658** A NULL profile function means that no profiling is executes. A non-NULL
1659** profile is a pointer to a function that is invoked at the conclusion of
1660** each SQL statement that is run.
1661*/
1662void *sqlite3_profile(
1663 sqlite3 *db,
1664 void (*xProfile)(void*,const char*,sqlite_uint64),
1665 void *pArg
1666){
drhe30f4422007-08-21 16:15:55 +00001667 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001668
1669#ifdef SQLITE_ENABLE_API_ARMOR
1670 if( !sqlite3SafetyCheckOk(db) ){
1671 (void)SQLITE_MISUSE_BKPT;
1672 return 0;
1673 }
1674#endif
drhe30f4422007-08-21 16:15:55 +00001675 sqlite3_mutex_enter(db->mutex);
1676 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +00001677 db->xProfile = xProfile;
1678 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001679 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +00001680 return pOld;
1681}
1682#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +00001683
drhcd565fd2012-03-01 21:30:44 +00001684/*
1685** Register a function to be invoked when a transaction commits.
danielk197771fd80b2005-12-16 06:54:01 +00001686** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +00001687** rollback.
1688*/
danielk197724b03fd2004-05-10 10:34:34 +00001689void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +00001690 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +00001691 int (*xCallback)(void*), /* Function to invoke on each commit */
1692 void *pArg /* Argument to the function */
1693){
drhe30f4422007-08-21 16:15:55 +00001694 void *pOld;
drh9ca95732014-10-24 00:35:58 +00001695
1696#ifdef SQLITE_ENABLE_API_ARMOR
1697 if( !sqlite3SafetyCheckOk(db) ){
1698 (void)SQLITE_MISUSE_BKPT;
1699 return 0;
1700 }
1701#endif
drhe30f4422007-08-21 16:15:55 +00001702 sqlite3_mutex_enter(db->mutex);
1703 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +00001704 db->xCommitCallback = xCallback;
1705 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001706 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +00001707 return pOld;
1708}
1709
danielk197794eb6a12005-12-15 15:22:08 +00001710/*
1711** Register a callback to be invoked each time a row is updated,
1712** inserted or deleted using this database connection.
1713*/
danielk197771fd80b2005-12-16 06:54:01 +00001714void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +00001715 sqlite3 *db, /* Attach the hook to this database */
1716 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
1717 void *pArg /* Argument to the function */
1718){
drhe30f4422007-08-21 16:15:55 +00001719 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001720
1721#ifdef SQLITE_ENABLE_API_ARMOR
1722 if( !sqlite3SafetyCheckOk(db) ){
1723 (void)SQLITE_MISUSE_BKPT;
1724 return 0;
1725 }
1726#endif
drhe30f4422007-08-21 16:15:55 +00001727 sqlite3_mutex_enter(db->mutex);
1728 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +00001729 db->xUpdateCallback = xCallback;
1730 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001731 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001732 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +00001733}
1734
danielk197771fd80b2005-12-16 06:54:01 +00001735/*
1736** Register a callback to be invoked each time a transaction is rolled
1737** back by this database connection.
1738*/
1739void *sqlite3_rollback_hook(
1740 sqlite3 *db, /* Attach the hook to this database */
1741 void (*xCallback)(void*), /* Callback function */
1742 void *pArg /* Argument to the function */
1743){
drhe30f4422007-08-21 16:15:55 +00001744 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001745
1746#ifdef SQLITE_ENABLE_API_ARMOR
1747 if( !sqlite3SafetyCheckOk(db) ){
1748 (void)SQLITE_MISUSE_BKPT;
1749 return 0;
1750 }
1751#endif
drhe30f4422007-08-21 16:15:55 +00001752 sqlite3_mutex_enter(db->mutex);
1753 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +00001754 db->xRollbackCallback = xCallback;
1755 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +00001756 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +00001757 return pRet;
1758}
drhaa940ea2004-01-15 02:44:03 +00001759
dan586b9c82010-05-03 08:04:49 +00001760#ifndef SQLITE_OMIT_WAL
1761/*
1762** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
drh5def0842010-05-05 20:00:25 +00001763** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
1764** is greater than sqlite3.pWalArg cast to an integer (the value configured by
drhb033d8b2010-05-03 13:37:30 +00001765** wal_autocheckpoint()).
dan586b9c82010-05-03 08:04:49 +00001766*/
drhb033d8b2010-05-03 13:37:30 +00001767int sqlite3WalDefaultHook(
drh5def0842010-05-05 20:00:25 +00001768 void *pClientData, /* Argument */
drhb033d8b2010-05-03 13:37:30 +00001769 sqlite3 *db, /* Connection */
drh5def0842010-05-05 20:00:25 +00001770 const char *zDb, /* Database */
drhb033d8b2010-05-03 13:37:30 +00001771 int nFrame /* Size of WAL */
1772){
drh5def0842010-05-05 20:00:25 +00001773 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
drhf5330352010-05-24 20:27:44 +00001774 sqlite3BeginBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001775 sqlite3_wal_checkpoint(db, zDb);
drhf5330352010-05-24 20:27:44 +00001776 sqlite3EndBenignMalloc();
drh5def0842010-05-05 20:00:25 +00001777 }
1778 return SQLITE_OK;
dan586b9c82010-05-03 08:04:49 +00001779}
drhb033d8b2010-05-03 13:37:30 +00001780#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001781
1782/*
1783** Configure an sqlite3_wal_hook() callback to automatically checkpoint
1784** a database after committing a transaction if there are nFrame or
1785** more frames in the log file. Passing zero or a negative value as the
1786** nFrame parameter disables automatic checkpoints entirely.
1787**
1788** The callback registered by this function replaces any existing callback
1789** registered using sqlite3_wal_hook(). Likewise, registering a callback
1790** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
1791** configured by this function.
1792*/
1793int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
shanehbd2aaf92010-09-01 02:38:21 +00001794#ifdef SQLITE_OMIT_WAL
drh9dd55f52010-09-03 03:32:46 +00001795 UNUSED_PARAMETER(db);
1796 UNUSED_PARAMETER(nFrame);
shanehbd2aaf92010-09-01 02:38:21 +00001797#else
drh9ca95732014-10-24 00:35:58 +00001798#ifdef SQLITE_ENABLE_API_ARMOR
1799 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1800#endif
dan586b9c82010-05-03 08:04:49 +00001801 if( nFrame>0 ){
drhb033d8b2010-05-03 13:37:30 +00001802 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
dan586b9c82010-05-03 08:04:49 +00001803 }else{
1804 sqlite3_wal_hook(db, 0, 0);
1805 }
drhb033d8b2010-05-03 13:37:30 +00001806#endif
dan586b9c82010-05-03 08:04:49 +00001807 return SQLITE_OK;
1808}
1809
paulb0208cc2003-04-13 18:26:49 +00001810/*
dan8d22a172010-04-19 18:03:51 +00001811** Register a callback to be invoked each time a transaction is written
1812** into the write-ahead-log by this database connection.
1813*/
drh833bf962010-04-28 14:42:19 +00001814void *sqlite3_wal_hook(
dan8d22a172010-04-19 18:03:51 +00001815 sqlite3 *db, /* Attach the hook to this db handle */
1816 int(*xCallback)(void *, sqlite3*, const char*, int),
1817 void *pArg /* First argument passed to xCallback() */
1818){
drhb033d8b2010-05-03 13:37:30 +00001819#ifndef SQLITE_OMIT_WAL
dan8d22a172010-04-19 18:03:51 +00001820 void *pRet;
drh9ca95732014-10-24 00:35:58 +00001821#ifdef SQLITE_ENABLE_API_ARMOR
1822 if( !sqlite3SafetyCheckOk(db) ){
1823 (void)SQLITE_MISUSE_BKPT;
1824 return 0;
1825 }
1826#endif
dan8d22a172010-04-19 18:03:51 +00001827 sqlite3_mutex_enter(db->mutex);
drh7ed91f22010-04-29 22:34:07 +00001828 pRet = db->pWalArg;
1829 db->xWalCallback = xCallback;
1830 db->pWalArg = pArg;
dan8d22a172010-04-19 18:03:51 +00001831 sqlite3_mutex_leave(db->mutex);
1832 return pRet;
drhb033d8b2010-05-03 13:37:30 +00001833#else
1834 return 0;
1835#endif
dan8d22a172010-04-19 18:03:51 +00001836}
1837
1838/*
dancdc1f042010-11-18 12:11:05 +00001839** Checkpoint database zDb.
dan586b9c82010-05-03 08:04:49 +00001840*/
dancdc1f042010-11-18 12:11:05 +00001841int sqlite3_wal_checkpoint_v2(
1842 sqlite3 *db, /* Database handle */
1843 const char *zDb, /* Name of attached database (or NULL) */
1844 int eMode, /* SQLITE_CHECKPOINT_* value */
1845 int *pnLog, /* OUT: Size of WAL log in frames */
1846 int *pnCkpt /* OUT: Total number of frames checkpointed */
1847){
drhb033d8b2010-05-03 13:37:30 +00001848#ifdef SQLITE_OMIT_WAL
1849 return SQLITE_OK;
1850#else
dan586b9c82010-05-03 08:04:49 +00001851 int rc; /* Return code */
dan6fcff072010-05-03 14:05:43 +00001852 int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
dan586b9c82010-05-03 08:04:49 +00001853
drh9ca95732014-10-24 00:35:58 +00001854#ifdef SQLITE_ENABLE_API_ARMOR
1855 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1856#endif
1857
dan9c5e3682011-02-07 15:12:12 +00001858 /* Initialize the output variables to -1 in case an error occurs. */
1859 if( pnLog ) *pnLog = -1;
1860 if( pnCkpt ) *pnCkpt = -1;
1861
drh383d79e2011-02-09 03:03:16 +00001862 assert( SQLITE_CHECKPOINT_FULL>SQLITE_CHECKPOINT_PASSIVE );
1863 assert( SQLITE_CHECKPOINT_FULL<SQLITE_CHECKPOINT_RESTART );
1864 assert( SQLITE_CHECKPOINT_PASSIVE+2==SQLITE_CHECKPOINT_RESTART );
1865 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_RESTART ){
dancdc1f042010-11-18 12:11:05 +00001866 return SQLITE_MISUSE;
1867 }
1868
dan586b9c82010-05-03 08:04:49 +00001869 sqlite3_mutex_enter(db->mutex);
danaf0cfd32010-05-03 15:58:50 +00001870 if( zDb && zDb[0] ){
dan586b9c82010-05-03 08:04:49 +00001871 iDb = sqlite3FindDbName(db, zDb);
1872 }
1873 if( iDb<0 ){
1874 rc = SQLITE_ERROR;
drh13f40da2014-08-22 18:00:11 +00001875 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
dan586b9c82010-05-03 08:04:49 +00001876 }else{
dancdc1f042010-11-18 12:11:05 +00001877 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
drh13f40da2014-08-22 18:00:11 +00001878 sqlite3Error(db, rc);
dan586b9c82010-05-03 08:04:49 +00001879 }
drhb033d8b2010-05-03 13:37:30 +00001880 rc = sqlite3ApiExit(db, rc);
dan586b9c82010-05-03 08:04:49 +00001881 sqlite3_mutex_leave(db->mutex);
drhb033d8b2010-05-03 13:37:30 +00001882 return rc;
1883#endif
dan586b9c82010-05-03 08:04:49 +00001884}
1885
dancdc1f042010-11-18 12:11:05 +00001886
1887/*
1888** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
1889** to contains a zero-length string, all attached databases are
1890** checkpointed.
1891*/
1892int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
1893 return sqlite3_wal_checkpoint_v2(db, zDb, SQLITE_CHECKPOINT_PASSIVE, 0, 0);
1894}
1895
drhb033d8b2010-05-03 13:37:30 +00001896#ifndef SQLITE_OMIT_WAL
dan586b9c82010-05-03 08:04:49 +00001897/*
1898** Run a checkpoint on database iDb. This is a no-op if database iDb is
1899** not currently open in WAL mode.
1900**
dan6fcff072010-05-03 14:05:43 +00001901** If a transaction is open on the database being checkpointed, this
1902** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
1903** an error occurs while running the checkpoint, an SQLite error code is
1904** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
dan586b9c82010-05-03 08:04:49 +00001905**
1906** The mutex on database handle db should be held by the caller. The mutex
1907** associated with the specific b-tree being checkpointed is taken by
1908** this function while the checkpoint is running.
dan6fcff072010-05-03 14:05:43 +00001909**
1910** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
1911** checkpointed. If an error is encountered it is returned immediately -
1912** no attempt is made to checkpoint any remaining databases.
dana58f26f2010-11-16 18:56:51 +00001913**
dancdc1f042010-11-18 12:11:05 +00001914** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dan586b9c82010-05-03 08:04:49 +00001915*/
dancdc1f042010-11-18 12:11:05 +00001916int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
dan6fcff072010-05-03 14:05:43 +00001917 int rc = SQLITE_OK; /* Return code */
1918 int i; /* Used to iterate through attached dbs */
danf2b8dd52010-11-18 19:28:01 +00001919 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
dan586b9c82010-05-03 08:04:49 +00001920
1921 assert( sqlite3_mutex_held(db->mutex) );
dan9c5e3682011-02-07 15:12:12 +00001922 assert( !pnLog || *pnLog==-1 );
1923 assert( !pnCkpt || *pnCkpt==-1 );
dan586b9c82010-05-03 08:04:49 +00001924
dan6fcff072010-05-03 14:05:43 +00001925 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
1926 if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
dancdc1f042010-11-18 12:11:05 +00001927 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
danf2b8dd52010-11-18 19:28:01 +00001928 pnLog = 0;
1929 pnCkpt = 0;
1930 if( rc==SQLITE_BUSY ){
1931 bBusy = 1;
1932 rc = SQLITE_OK;
1933 }
dan6fcff072010-05-03 14:05:43 +00001934 }
dan586b9c82010-05-03 08:04:49 +00001935 }
1936
danf2b8dd52010-11-18 19:28:01 +00001937 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
dan586b9c82010-05-03 08:04:49 +00001938}
drhb033d8b2010-05-03 13:37:30 +00001939#endif /* SQLITE_OMIT_WAL */
dan586b9c82010-05-03 08:04:49 +00001940
1941/*
danielk1977d8293352009-04-30 09:10:37 +00001942** This function returns true if main-memory should be used instead of
1943** a temporary file for transient pager files and statement journals.
1944** The value returned depends on the value of db->temp_store (runtime
1945** parameter) and the compile time value of SQLITE_TEMP_STORE. The
1946** following table describes the relationship between these two values
1947** and this functions return value.
1948**
1949** SQLITE_TEMP_STORE db->temp_store Location of temporary database
1950** ----------------- -------------- ------------------------------
1951** 0 any file (return 0)
1952** 1 1 file (return 0)
1953** 1 2 memory (return 1)
1954** 1 0 file (return 0)
1955** 2 1 file (return 0)
1956** 2 2 memory (return 1)
1957** 2 0 memory (return 1)
1958** 3 any memory (return 1)
1959*/
drh1c514142009-04-30 12:25:10 +00001960int sqlite3TempInMemory(const sqlite3 *db){
danielk1977d8293352009-04-30 09:10:37 +00001961#if SQLITE_TEMP_STORE==1
1962 return ( db->temp_store==2 );
1963#endif
1964#if SQLITE_TEMP_STORE==2
1965 return ( db->temp_store!=1 );
1966#endif
1967#if SQLITE_TEMP_STORE==3
1968 return 1;
shanecf697392009-06-01 16:53:09 +00001969#endif
1970#if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
danielk1977d8293352009-04-30 09:10:37 +00001971 return 0;
shane60a4b532009-05-06 18:57:09 +00001972#endif
danielk1977d8293352009-04-30 09:10:37 +00001973}
1974
1975/*
danielk19774ad17132004-05-21 01:47:26 +00001976** Return UTF-8 encoded English language explanation of the most recent
1977** error.
1978*/
danielk19776622cce2004-05-20 11:00:52 +00001979const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +00001980 const char *z;
drhf49661a2008-12-10 16:45:50 +00001981 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +00001982 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +00001983 }
drhd55d57e2008-07-07 17:53:07 +00001984 if( !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00001985 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
danielk1977e35ee192004-06-26 09:50:11 +00001986 }
drh27641702007-08-22 02:56:42 +00001987 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00001988 if( db->mallocFailed ){
1989 z = sqlite3ErrStr(SQLITE_NOMEM);
1990 }else{
drha3cc0072013-12-13 16:23:55 +00001991 testcase( db->pErr==0 );
danielk1977238746a2009-03-19 18:51:06 +00001992 z = (char*)sqlite3_value_text(db->pErr);
1993 assert( !db->mallocFailed );
1994 if( z==0 ){
1995 z = sqlite3ErrStr(db->errCode);
1996 }
danielk19776622cce2004-05-20 11:00:52 +00001997 }
drhe30f4422007-08-21 16:15:55 +00001998 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00001999 return z;
danielk19776622cce2004-05-20 11:00:52 +00002000}
2001
drh6c626082004-11-14 21:56:29 +00002002#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002003/*
2004** Return UTF-16 encoded English language explanation of the most recent
2005** error.
2006*/
danielk19776622cce2004-05-20 11:00:52 +00002007const void *sqlite3_errmsg16(sqlite3 *db){
danielk19777c5c3ca2009-02-23 14:42:53 +00002008 static const u16 outOfMem[] = {
2009 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
danielk1977bfd6cce2004-06-18 04:24:54 +00002010 };
danielk19777c5c3ca2009-02-23 14:42:53 +00002011 static const u16 misuse[] = {
2012 'l', 'i', 'b', 'r', 'a', 'r', 'y', ' ',
2013 'r', 'o', 'u', 't', 'i', 'n', 'e', ' ',
2014 'c', 'a', 'l', 'l', 'e', 'd', ' ',
2015 'o', 'u', 't', ' ',
2016 'o', 'f', ' ',
2017 's', 'e', 'q', 'u', 'e', 'n', 'c', 'e', 0
danielk1977e35ee192004-06-26 09:50:11 +00002018 };
danielk19774ad17132004-05-21 01:47:26 +00002019
drhc60d0442004-09-30 13:43:13 +00002020 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +00002021 if( !db ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002022 return (void *)outOfMem;
drhc60d0442004-09-30 13:43:13 +00002023 }
drhd55d57e2008-07-07 17:53:07 +00002024 if( !sqlite3SafetyCheckSickOrOk(db) ){
danielk19777c5c3ca2009-02-23 14:42:53 +00002025 return (void *)misuse;
drhc60d0442004-09-30 13:43:13 +00002026 }
drhe30f4422007-08-21 16:15:55 +00002027 sqlite3_mutex_enter(db->mutex);
danielk1977238746a2009-03-19 18:51:06 +00002028 if( db->mallocFailed ){
2029 z = (void *)outOfMem;
2030 }else{
drhc60d0442004-09-30 13:43:13 +00002031 z = sqlite3_value_text16(db->pErr);
danielk1977238746a2009-03-19 18:51:06 +00002032 if( z==0 ){
drh13f40da2014-08-22 18:00:11 +00002033 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
danielk1977238746a2009-03-19 18:51:06 +00002034 z = sqlite3_value_text16(db->pErr);
2035 }
2036 /* A malloc() may have failed within the call to sqlite3_value_text16()
2037 ** above. If this is the case, then the db->mallocFailed flag needs to
2038 ** be cleared before returning. Do this directly, instead of via
2039 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2040 */
2041 db->mallocFailed = 0;
drhc60d0442004-09-30 13:43:13 +00002042 }
drhe30f4422007-08-21 16:15:55 +00002043 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +00002044 return z;
danielk19776622cce2004-05-20 11:00:52 +00002045}
drh6c626082004-11-14 21:56:29 +00002046#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +00002047
drhc60d0442004-09-30 13:43:13 +00002048/*
danielk19777ddad962005-12-12 06:53:03 +00002049** Return the most recent error code generated by an SQLite routine. If NULL is
2050** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +00002051*/
danielk19776622cce2004-05-20 11:00:52 +00002052int sqlite3_errcode(sqlite3 *db){
danielk19777c36d072008-01-31 15:31:01 +00002053 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002054 return SQLITE_MISUSE_BKPT;
drhc60d0442004-09-30 13:43:13 +00002055 }
drh01495b92008-01-23 12:52:40 +00002056 if( !db || db->mallocFailed ){
2057 return SQLITE_NOMEM;
2058 }
drh4ac285a2006-09-15 07:28:50 +00002059 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +00002060}
drh99dfe5e2008-10-30 15:03:15 +00002061int sqlite3_extended_errcode(sqlite3 *db){
2062 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
drh413c3d32010-02-23 20:11:56 +00002063 return SQLITE_MISUSE_BKPT;
drh99dfe5e2008-10-30 15:03:15 +00002064 }
2065 if( !db || db->mallocFailed ){
2066 return SQLITE_NOMEM;
2067 }
2068 return db->errCode;
2069}
danielk19776622cce2004-05-20 11:00:52 +00002070
drh0e819f92006-02-01 13:50:41 +00002071/*
mistachkin5dac8432012-09-11 02:00:25 +00002072** Return a string that describes the kind of error specified in the
2073** argument. For now, this simply calls the internal sqlite3ErrStr()
2074** function.
2075*/
2076const char *sqlite3_errstr(int rc){
2077 return sqlite3ErrStr(rc);
2078}
2079
2080/*
drh41e13e12013-11-07 14:09:39 +00002081** Invalidate all cached KeyInfo objects for database connection "db"
2082*/
2083static void invalidateCachedKeyInfo(sqlite3 *db){
2084 Db *pDb; /* A single database */
2085 int iDb; /* The database index number */
2086 HashElem *k; /* For looping over tables in pDb */
2087 Table *pTab; /* A table in the database */
2088 Index *pIdx; /* Each index */
2089
2090 for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
2091 if( pDb->pBt==0 ) continue;
2092 sqlite3BtreeEnter(pDb->pBt);
2093 for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
2094 pTab = (Table*)sqliteHashData(k);
2095 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2096 if( pIdx->pKeyInfo && pIdx->pKeyInfo->db==db ){
2097 sqlite3KeyInfoUnref(pIdx->pKeyInfo);
2098 pIdx->pKeyInfo = 0;
2099 }
2100 }
2101 }
2102 sqlite3BtreeLeave(pDb->pBt);
2103 }
2104}
2105
2106/*
drh0e819f92006-02-01 13:50:41 +00002107** Create a new collating function for database "db". The name is zName
2108** and the encoding is enc.
2109*/
danielk19779a30cf62006-01-18 04:26:07 +00002110static int createCollation(
drhf8d4e8b2009-08-20 02:49:30 +00002111 sqlite3* db,
danielk19779a30cf62006-01-18 04:26:07 +00002112 const char *zName,
shanecea72b22009-09-07 04:38:36 +00002113 u8 enc,
danielk19779a30cf62006-01-18 04:26:07 +00002114 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +00002115 int(*xCompare)(void*,int,const void*,int,const void*),
2116 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +00002117){
2118 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +00002119 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +00002120
drhe30f4422007-08-21 16:15:55 +00002121 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +00002122
2123 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2124 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2125 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2126 */
drh51c7d862009-04-27 18:46:06 +00002127 enc2 = enc;
danielk1977ebb32932009-04-28 15:35:38 +00002128 testcase( enc2==SQLITE_UTF16 );
2129 testcase( enc2==SQLITE_UTF16_ALIGNED );
2130 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
drh7d9bd4e2006-02-16 18:16:36 +00002131 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +00002132 }
drh51c7d862009-04-27 18:46:06 +00002133 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
drh413c3d32010-02-23 20:11:56 +00002134 return SQLITE_MISUSE_BKPT;
danielk19779a30cf62006-01-18 04:26:07 +00002135 }
2136
2137 /* Check if this call is removing or replacing an existing collation
2138 ** sequence. If so, and there are active VMs, return busy. If there
2139 ** are no active VMs, invalidate any pre-compiled statements.
2140 */
drhc4a64fa2009-05-11 20:53:28 +00002141 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
danielk19779a30cf62006-01-18 04:26:07 +00002142 if( pColl && pColl->xCmp ){
drh4f7d3a52013-06-27 23:54:02 +00002143 if( db->nVdbeActive ){
drh13f40da2014-08-22 18:00:11 +00002144 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
drhb309bec2009-02-04 17:40:57 +00002145 "unable to delete/modify collation sequence due to active statements");
danielk19779a30cf62006-01-18 04:26:07 +00002146 return SQLITE_BUSY;
2147 }
2148 sqlite3ExpirePreparedStatements(db);
drh41e13e12013-11-07 14:09:39 +00002149 invalidateCachedKeyInfo(db);
danielk1977a9808b32007-05-07 09:32:45 +00002150
2151 /* If collation sequence pColl was created directly by a call to
2152 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2153 ** then any copies made by synthCollSeq() need to be invalidated.
2154 ** Also, collation destructor - CollSeq.xDel() - function may need
2155 ** to be called.
2156 */
2157 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
drhacbcb7e2014-08-21 20:26:37 +00002158 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
danielk1977a9808b32007-05-07 09:32:45 +00002159 int j;
2160 for(j=0; j<3; j++){
2161 CollSeq *p = &aColl[j];
2162 if( p->enc==pColl->enc ){
2163 if( p->xDel ){
2164 p->xDel(p->pUser);
2165 }
2166 p->xCmp = 0;
2167 }
2168 }
2169 }
danielk19779a30cf62006-01-18 04:26:07 +00002170 }
2171
drhc4a64fa2009-05-11 20:53:28 +00002172 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
drh88404c22010-10-11 17:58:21 +00002173 if( pColl==0 ) return SQLITE_NOMEM;
2174 pColl->xCmp = xCompare;
2175 pColl->pUser = pCtx;
2176 pColl->xDel = xDel;
2177 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
drh13f40da2014-08-22 18:00:11 +00002178 sqlite3Error(db, SQLITE_OK);
danielk19779a30cf62006-01-18 04:26:07 +00002179 return SQLITE_OK;
2180}
2181
2182
danielk19776622cce2004-05-20 11:00:52 +00002183/*
drhbb4957f2008-03-20 14:03:29 +00002184** This array defines hard upper bounds on limit values. The
2185** initializer must be kept in sync with the SQLITE_LIMIT_*
2186** #defines in sqlite3.h.
2187*/
drhb1a6c3c2008-03-20 16:30:17 +00002188static const int aHardLimit[] = {
drhbb4957f2008-03-20 14:03:29 +00002189 SQLITE_MAX_LENGTH,
2190 SQLITE_MAX_SQL_LENGTH,
2191 SQLITE_MAX_COLUMN,
2192 SQLITE_MAX_EXPR_DEPTH,
2193 SQLITE_MAX_COMPOUND_SELECT,
2194 SQLITE_MAX_VDBE_OP,
2195 SQLITE_MAX_FUNCTION_ARG,
2196 SQLITE_MAX_ATTACHED,
drhbb4957f2008-03-20 14:03:29 +00002197 SQLITE_MAX_LIKE_PATTERN_LENGTH,
drh9f959b02014-08-11 17:37:27 +00002198 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
drh417168a2009-09-07 18:14:02 +00002199 SQLITE_MAX_TRIGGER_DEPTH,
drh111544c2014-08-29 16:20:47 +00002200 SQLITE_MAX_WORKER_THREADS,
drhbb4957f2008-03-20 14:03:29 +00002201};
2202
2203/*
2204** Make sure the hard limits are set to reasonable values
2205*/
2206#if SQLITE_MAX_LENGTH<100
2207# error SQLITE_MAX_LENGTH must be at least 100
2208#endif
2209#if SQLITE_MAX_SQL_LENGTH<100
2210# error SQLITE_MAX_SQL_LENGTH must be at least 100
2211#endif
2212#if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2213# error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2214#endif
drhbb4957f2008-03-20 14:03:29 +00002215#if SQLITE_MAX_COMPOUND_SELECT<2
2216# error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2217#endif
2218#if SQLITE_MAX_VDBE_OP<40
2219# error SQLITE_MAX_VDBE_OP must be at least 40
2220#endif
drhe82f5d02008-10-07 19:53:14 +00002221#if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>1000
2222# error SQLITE_MAX_FUNCTION_ARG must be between 0 and 1000
drhbb4957f2008-03-20 14:03:29 +00002223#endif
drhd08b2792014-07-22 15:33:31 +00002224#if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2225# error SQLITE_MAX_ATTACHED must be between 0 and 125
drhbb4957f2008-03-20 14:03:29 +00002226#endif
drhbb4957f2008-03-20 14:03:29 +00002227#if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2228# error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2229#endif
drh70a8ca32008-08-21 18:49:27 +00002230#if SQLITE_MAX_COLUMN>32767
2231# error SQLITE_MAX_COLUMN must not exceed 32767
2232#endif
drh417168a2009-09-07 18:14:02 +00002233#if SQLITE_MAX_TRIGGER_DEPTH<1
2234# error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2235#endif
drh111544c2014-08-29 16:20:47 +00002236#if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2237# error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2238#endif
drhbb4957f2008-03-20 14:03:29 +00002239
2240
2241/*
2242** Change the value of a limit. Report the old value.
2243** If an invalid limit index is supplied, report -1.
2244** Make no changes but still report the old value if the
2245** new limit is negative.
2246**
2247** A new lower limit does not shrink existing constructs.
2248** It merely prevents new constructs that exceed the limit
2249** from forming.
2250*/
2251int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2252 int oldLimit;
drh4e93f5b2010-09-07 14:59:15 +00002253
drh9ca95732014-10-24 00:35:58 +00002254#ifdef SQLITE_ENABLE_API_ARMOR
2255 if( !sqlite3SafetyCheckOk(db) ){
2256 (void)SQLITE_MISUSE_BKPT;
2257 return -1;
2258 }
2259#endif
drh4e93f5b2010-09-07 14:59:15 +00002260
2261 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2262 ** there is a hard upper bound set at compile-time by a C preprocessor
2263 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2264 ** "_MAX_".)
2265 */
2266 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2267 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2268 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2269 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2270 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2271 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2272 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2273 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2274 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2275 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2276 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2277 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
drh111544c2014-08-29 16:20:47 +00002278 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2279 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
drh4e93f5b2010-09-07 14:59:15 +00002280
2281
drh521cc842008-04-15 02:36:33 +00002282 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
drhbb4957f2008-03-20 14:03:29 +00002283 return -1;
2284 }
2285 oldLimit = db->aLimit[limitId];
drh4e93f5b2010-09-07 14:59:15 +00002286 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
drhf47ce562008-03-20 18:00:49 +00002287 if( newLimit>aHardLimit[limitId] ){
drh4e93f5b2010-09-07 14:59:15 +00002288 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
drhbb4957f2008-03-20 14:03:29 +00002289 }
2290 db->aLimit[limitId] = newLimit;
2291 }
drh4e93f5b2010-09-07 14:59:15 +00002292 return oldLimit; /* IMP: R-53341-35419 */
drhbb4957f2008-03-20 14:03:29 +00002293}
2294
2295/*
dan286ab7c2011-05-06 18:34:54 +00002296** This function is used to parse both URIs and non-URI filenames passed by the
2297** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2298** URIs specified as part of ATTACH statements.
2299**
2300** The first argument to this function is the name of the VFS to use (or
2301** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2302** query parameter. The second argument contains the URI (or non-URI filename)
2303** itself. When this function is called the *pFlags variable should contain
2304** the default flags to open the database handle with. The value stored in
2305** *pFlags may be updated before returning if the URI filename contains
2306** "cache=xxx" or "mode=xxx" query parameters.
2307**
2308** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2309** the VFS that should be used to open the database file. *pzFile is set to
2310** point to a buffer containing the name of the file to open. It is the
2311** responsibility of the caller to eventually call sqlite3_free() to release
2312** this buffer.
2313**
2314** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2315** may be set to point to a buffer containing an English language error
2316** message. It is the responsibility of the caller to eventually release
2317** this buffer by calling sqlite3_free().
dancd74b612011-04-22 19:37:32 +00002318*/
2319int sqlite3ParseUri(
2320 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2321 const char *zUri, /* Nul-terminated URI to parse */
drh522c26f2011-05-07 14:40:29 +00002322 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
dancd74b612011-04-22 19:37:32 +00002323 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2324 char **pzFile, /* OUT: Filename component of URI */
2325 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2326){
dan78e9dd22011-05-03 10:22:32 +00002327 int rc = SQLITE_OK;
drh522c26f2011-05-07 14:40:29 +00002328 unsigned int flags = *pFlags;
dancd74b612011-04-22 19:37:32 +00002329 const char *zVfs = zDefaultVfs;
2330 char *zFile;
drhde941c32011-05-09 19:20:17 +00002331 char c;
dancd74b612011-04-22 19:37:32 +00002332 int nUri = sqlite3Strlen30(zUri);
2333
2334 assert( *pzErrMsg==0 );
2335
2336 if( ((flags & SQLITE_OPEN_URI) || sqlite3GlobalConfig.bOpenUri)
drh00729cb2014-10-04 11:59:33 +00002337 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
dancd74b612011-04-22 19:37:32 +00002338 ){
dan5de15372011-04-23 10:12:30 +00002339 char *zOpt;
dancd74b612011-04-22 19:37:32 +00002340 int eState; /* Parser state when parsing URI */
2341 int iIn; /* Input character index */
2342 int iOut = 0; /* Output character index */
2343 int nByte = nUri+2; /* Bytes of space to allocate */
dancd74b612011-04-22 19:37:32 +00002344
dan286ab7c2011-05-06 18:34:54 +00002345 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2346 ** method that there may be extra parameters following the file-name. */
2347 flags |= SQLITE_OPEN_URI;
2348
2349 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
dancd74b612011-04-22 19:37:32 +00002350 zFile = sqlite3_malloc(nByte);
2351 if( !zFile ) return SQLITE_NOMEM;
2352
drh869c0402013-08-07 23:15:52 +00002353 iIn = 5;
2354#ifndef SQLITE_ALLOW_URI_AUTHORITY
dancd74b612011-04-22 19:37:32 +00002355 /* Discard the scheme and authority segments of the URI. */
2356 if( zUri[5]=='/' && zUri[6]=='/' ){
2357 iIn = 7;
2358 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
dan3b18a9a2011-05-03 11:53:20 +00002359 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2360 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2361 iIn-7, &zUri[7]);
2362 rc = SQLITE_ERROR;
2363 goto parse_uri_out;
2364 }
dancd74b612011-04-22 19:37:32 +00002365 }
drh869c0402013-08-07 23:15:52 +00002366#endif
dancd74b612011-04-22 19:37:32 +00002367
2368 /* Copy the filename and any query parameters into the zFile buffer.
2369 ** Decode %HH escape codes along the way.
2370 **
2371 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2372 ** on the parsing context. As follows:
2373 **
2374 ** 0: Parsing file-name.
2375 ** 1: Parsing name section of a name=value query parameter.
2376 ** 2: Parsing value section of a name=value query parameter.
2377 */
2378 eState = 0;
drhde941c32011-05-09 19:20:17 +00002379 while( (c = zUri[iIn])!=0 && c!='#' ){
2380 iIn++;
dancd74b612011-04-22 19:37:32 +00002381 if( c=='%'
2382 && sqlite3Isxdigit(zUri[iIn])
2383 && sqlite3Isxdigit(zUri[iIn+1])
2384 ){
dan6d49e252011-05-03 15:09:05 +00002385 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2386 octet += sqlite3HexToInt(zUri[iIn++]);
dancd74b612011-04-22 19:37:32 +00002387
dan6d49e252011-05-03 15:09:05 +00002388 assert( octet>=0 && octet<256 );
2389 if( octet==0 ){
dan5de15372011-04-23 10:12:30 +00002390 /* This branch is taken when "%00" appears within the URI. In this
2391 ** case we ignore all text in the remainder of the path, name or
2392 ** value currently being parsed. So ignore the current character
2393 ** and skip to the next "?", "=" or "&", as appropriate. */
drhde941c32011-05-09 19:20:17 +00002394 while( (c = zUri[iIn])!=0 && c!='#'
2395 && (eState!=0 || c!='?')
2396 && (eState!=1 || (c!='=' && c!='&'))
2397 && (eState!=2 || c!='&')
dan5de15372011-04-23 10:12:30 +00002398 ){
2399 iIn++;
2400 }
2401 continue;
dancd74b612011-04-22 19:37:32 +00002402 }
dan6d49e252011-05-03 15:09:05 +00002403 c = octet;
dan5de15372011-04-23 10:12:30 +00002404 }else if( eState==1 && (c=='&' || c=='=') ){
2405 if( zFile[iOut-1]==0 ){
2406 /* An empty option name. Ignore this option altogether. */
2407 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2408 continue;
2409 }
2410 if( c=='&' ){
2411 zFile[iOut++] = '\0';
2412 }else{
2413 eState = 2;
2414 }
dancd74b612011-04-22 19:37:32 +00002415 c = 0;
dan5de15372011-04-23 10:12:30 +00002416 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2417 c = 0;
dancd74b612011-04-22 19:37:32 +00002418 eState = 1;
dancd74b612011-04-22 19:37:32 +00002419 }
2420 zFile[iOut++] = c;
2421 }
2422 if( eState==1 ) zFile[iOut++] = '\0';
2423 zFile[iOut++] = '\0';
2424 zFile[iOut++] = '\0';
2425
2426 /* Check if there were any options specified that should be interpreted
2427 ** here. Options that are interpreted here include "vfs" and those that
2428 ** correspond to flags that may be passed to the sqlite3_open_v2()
dan78e9dd22011-05-03 10:22:32 +00002429 ** method. */
dan5de15372011-04-23 10:12:30 +00002430 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2431 while( zOpt[0] ){
2432 int nOpt = sqlite3Strlen30(zOpt);
2433 char *zVal = &zOpt[nOpt+1];
2434 int nVal = sqlite3Strlen30(zVal);
dancd74b612011-04-22 19:37:32 +00002435
dan286ab7c2011-05-06 18:34:54 +00002436 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002437 zVfs = zVal;
2438 }else{
2439 struct OpenMode {
2440 const char *z;
2441 int mode;
2442 } *aMode = 0;
drh45caede2011-06-03 14:19:10 +00002443 char *zModeType = 0;
2444 int mask = 0;
2445 int limit = 0;
dan78e9dd22011-05-03 10:22:32 +00002446
dan286ab7c2011-05-06 18:34:54 +00002447 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002448 static struct OpenMode aCacheMode[] = {
2449 { "shared", SQLITE_OPEN_SHAREDCACHE },
2450 { "private", SQLITE_OPEN_PRIVATECACHE },
2451 { 0, 0 }
2452 };
2453
2454 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2455 aMode = aCacheMode;
2456 limit = mask;
2457 zModeType = "cache";
2458 }
dan286ab7c2011-05-06 18:34:54 +00002459 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
dan78e9dd22011-05-03 10:22:32 +00002460 static struct OpenMode aOpenMode[] = {
2461 { "ro", SQLITE_OPEN_READONLY },
2462 { "rw", SQLITE_OPEN_READWRITE },
2463 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
dan0b8dcfa2012-06-07 17:16:04 +00002464 { "memory", SQLITE_OPEN_MEMORY },
dan78e9dd22011-05-03 10:22:32 +00002465 { 0, 0 }
2466 };
2467
drh9c67b2a2012-05-28 13:58:00 +00002468 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2469 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
dan78e9dd22011-05-03 10:22:32 +00002470 aMode = aOpenMode;
2471 limit = mask & flags;
2472 zModeType = "access";
2473 }
2474
2475 if( aMode ){
2476 int i;
2477 int mode = 0;
2478 for(i=0; aMode[i].z; i++){
2479 const char *z = aMode[i].z;
drh522c26f2011-05-07 14:40:29 +00002480 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
dan78e9dd22011-05-03 10:22:32 +00002481 mode = aMode[i].mode;
2482 break;
dancd74b612011-04-22 19:37:32 +00002483 }
2484 }
dan78e9dd22011-05-03 10:22:32 +00002485 if( mode==0 ){
2486 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2487 rc = SQLITE_ERROR;
2488 goto parse_uri_out;
2489 }
drh9c67b2a2012-05-28 13:58:00 +00002490 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
drhde941c32011-05-09 19:20:17 +00002491 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2492 zModeType, zVal);
dan78e9dd22011-05-03 10:22:32 +00002493 rc = SQLITE_PERM;
2494 goto parse_uri_out;
2495 }
2496 flags = (flags & ~mask) | mode;
dancd74b612011-04-22 19:37:32 +00002497 }
dancd74b612011-04-22 19:37:32 +00002498 }
dan5de15372011-04-23 10:12:30 +00002499
2500 zOpt = &zVal[nVal+1];
dancd74b612011-04-22 19:37:32 +00002501 }
2502
2503 }else{
2504 zFile = sqlite3_malloc(nUri+2);
2505 if( !zFile ) return SQLITE_NOMEM;
2506 memcpy(zFile, zUri, nUri);
2507 zFile[nUri] = '\0';
2508 zFile[nUri+1] = '\0';
drh4ab9d252012-05-26 20:08:49 +00002509 flags &= ~SQLITE_OPEN_URI;
dancd74b612011-04-22 19:37:32 +00002510 }
2511
2512 *ppVfs = sqlite3_vfs_find(zVfs);
2513 if( *ppVfs==0 ){
dancd74b612011-04-22 19:37:32 +00002514 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
dan78e9dd22011-05-03 10:22:32 +00002515 rc = SQLITE_ERROR;
2516 }
2517 parse_uri_out:
2518 if( rc!=SQLITE_OK ){
dan5de15372011-04-23 10:12:30 +00002519 sqlite3_free(zFile);
dan78e9dd22011-05-03 10:22:32 +00002520 zFile = 0;
dancd74b612011-04-22 19:37:32 +00002521 }
2522 *pFlags = flags;
2523 *pzFile = zFile;
dan78e9dd22011-05-03 10:22:32 +00002524 return rc;
dancd74b612011-04-22 19:37:32 +00002525}
2526
2527
2528/*
danielk19774ad17132004-05-21 01:47:26 +00002529** This routine does the work of opening a database on behalf of
2530** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +00002531** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +00002532*/
2533static int openDatabase(
2534 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +00002535 sqlite3 **ppDb, /* OUT: Returned database handle */
drh522c26f2011-05-07 14:40:29 +00002536 unsigned int flags, /* Operational flags */
drh605264d2007-08-21 15:13:19 +00002537 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +00002538){
dancd74b612011-04-22 19:37:32 +00002539 sqlite3 *db; /* Store allocated handle here */
2540 int rc; /* Return code */
2541 int isThreadsafe; /* True for threadsafe connections */
2542 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
2543 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
danielk19774ad17132004-05-21 01:47:26 +00002544
drh9ca95732014-10-24 00:35:58 +00002545#ifdef SQLITE_ENABLE_API_ARMOR
2546 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2547#endif
drhe0d0f8e2009-04-28 04:47:31 +00002548 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002549#ifndef SQLITE_OMIT_AUTOINIT
2550 rc = sqlite3_initialize();
2551 if( rc ) return rc;
2552#endif
2553
dan78e9dd22011-05-03 10:22:32 +00002554 /* Only allow sensible combinations of bits in the flags argument.
2555 ** Throw an error if any non-sense combination is used. If we
2556 ** do not block illegal combinations here, it could trigger
2557 ** assert() statements in deeper layers. Sensible combinations
2558 ** are:
2559 **
2560 ** 1: SQLITE_OPEN_READONLY
2561 ** 2: SQLITE_OPEN_READWRITE
2562 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
2563 */
2564 assert( SQLITE_OPEN_READONLY == 0x01 );
2565 assert( SQLITE_OPEN_READWRITE == 0x02 );
2566 assert( SQLITE_OPEN_CREATE == 0x04 );
2567 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
2568 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
2569 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
drh00729cb2014-10-04 11:59:33 +00002570 if( ((1<<(flags&7)) & 0x46)==0 ){
2571 return SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
2572 }
dan78e9dd22011-05-03 10:22:32 +00002573
drh039963a2008-09-03 00:43:15 +00002574 if( sqlite3GlobalConfig.bCoreMutex==0 ){
danielk19779a6284c2008-07-10 17:52:49 +00002575 isThreadsafe = 0;
drh039963a2008-09-03 00:43:15 +00002576 }else if( flags & SQLITE_OPEN_NOMUTEX ){
2577 isThreadsafe = 0;
2578 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2579 isThreadsafe = 1;
2580 }else{
2581 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
danielk19779a6284c2008-07-10 17:52:49 +00002582 }
drhf1f12682009-09-09 14:17:52 +00002583 if( flags & SQLITE_OPEN_PRIVATECACHE ){
drhf4cfac92009-09-09 15:29:41 +00002584 flags &= ~SQLITE_OPEN_SHAREDCACHE;
drhf1f12682009-09-09 14:17:52 +00002585 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2586 flags |= SQLITE_OPEN_SHAREDCACHE;
2587 }
danielk19779a6284c2008-07-10 17:52:49 +00002588
drhb25a9f42009-05-12 13:35:11 +00002589 /* Remove harmful bits from the flags parameter
2590 **
2591 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2592 ** dealt with in the previous code block. Besides these, the only
2593 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
drh03e1b402011-02-23 22:39:23 +00002594 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2595 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
drhb25a9f42009-05-12 13:35:11 +00002596 ** off all other flags.
2597 */
drha4267dc2008-02-19 15:20:44 +00002598 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
drhb25a9f42009-05-12 13:35:11 +00002599 SQLITE_OPEN_EXCLUSIVE |
drha4267dc2008-02-19 15:20:44 +00002600 SQLITE_OPEN_MAIN_DB |
2601 SQLITE_OPEN_TEMP_DB |
2602 SQLITE_OPEN_TRANSIENT_DB |
2603 SQLITE_OPEN_MAIN_JOURNAL |
2604 SQLITE_OPEN_TEMP_JOURNAL |
2605 SQLITE_OPEN_SUBJOURNAL |
danielk19779a6284c2008-07-10 17:52:49 +00002606 SQLITE_OPEN_MASTER_JOURNAL |
drh039963a2008-09-03 00:43:15 +00002607 SQLITE_OPEN_NOMUTEX |
drh357b5f92010-08-24 18:07:57 +00002608 SQLITE_OPEN_FULLMUTEX |
2609 SQLITE_OPEN_WAL
drha4267dc2008-02-19 15:20:44 +00002610 );
2611
danielk19774ad17132004-05-21 01:47:26 +00002612 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +00002613 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +00002614 if( db==0 ) goto opendb_out;
drh039963a2008-09-03 00:43:15 +00002615 if( isThreadsafe ){
danielk197759f8c082008-06-18 17:09:10 +00002616 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
2617 if( db->mutex==0 ){
2618 sqlite3_free(db);
2619 db = 0;
2620 goto opendb_out;
2621 }
drh605264d2007-08-21 15:13:19 +00002622 }
drh27641702007-08-22 02:56:42 +00002623 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00002624 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +00002625 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +00002626 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +00002627 db->aDb = db->aDbStatic;
drh633e6d52008-07-28 19:34:53 +00002628
drhbb4957f2008-03-20 14:03:29 +00002629 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
2630 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
drh6b2129a2014-08-29 19:06:07 +00002631 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
danielk19771d850a72004-05-31 08:26:49 +00002632 db->autoCommit = 1;
drhddac25c2007-12-05 01:38:23 +00002633 db->nextAutovac = -1;
drh9b4c59f2013-04-15 17:03:42 +00002634 db->szMmap = sqlite3GlobalConfig.szMmap;
danielk1977f653d782008-03-20 11:04:21 +00002635 db->nextPagesize = 0;
dan8930c2a2014-04-03 16:25:29 +00002636 db->nMaxSorterMmap = 0x7FFFFFFF;
drh40c39412013-08-16 20:42:20 +00002637 db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
dan1d1f07d2013-07-25 16:41:39 +00002638#if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
drh986b3872013-06-28 21:12:20 +00002639 | SQLITE_AutoIndex
2640#endif
drh76fe8032006-07-11 14:17:51 +00002641#if SQLITE_DEFAULT_FILE_FORMAT<4
2642 | SQLITE_LegacyFileFmt
2643#endif
drh56424db2007-03-27 22:24:11 +00002644#ifdef SQLITE_ENABLE_LOAD_EXTENSION
2645 | SQLITE_LoadExtension
2646#endif
dan5bde73c2009-09-01 17:11:07 +00002647#if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
dan5e1a2782009-09-01 17:28:29 +00002648 | SQLITE_RecTriggers
dan76d462e2009-08-30 11:42:51 +00002649#endif
drha4bfd7f2010-12-09 19:15:17 +00002650#if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2651 | SQLITE_ForeignKeys
2652#endif
drh76fe8032006-07-11 14:17:51 +00002653 ;
drhe61922a2009-05-02 13:29:37 +00002654 sqlite3HashInit(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +00002655#ifndef SQLITE_OMIT_VIRTUALTABLE
drhe61922a2009-05-02 13:29:37 +00002656 sqlite3HashInit(&db->aModule);
drhb9bb7c12006-06-11 23:41:55 +00002657#endif
danielk1977da184232006-01-05 11:34:32 +00002658
danielk19770202b292004-06-09 09:55:16 +00002659 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2660 ** and UTF-16, so add a version for each to avoid any unnecessary
2661 ** conversions. The only error that can occur here is a malloc() failure.
2662 */
drh4dd65e02011-11-29 14:46:56 +00002663 createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0);
2664 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0);
2665 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0);
2666 createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
drh77db4c02008-03-18 13:01:38 +00002667 if( db->mallocFailed ){
danielk19770202b292004-06-09 09:55:16 +00002668 goto opendb_out;
2669 }
drhc4a64fa2009-05-11 20:53:28 +00002670 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
drh77db4c02008-03-18 13:01:38 +00002671 assert( db->pDfltColl!=0 );
danielk19770202b292004-06-09 09:55:16 +00002672
2673 /* Also add a UTF-8 case-insensitive collation sequence. */
drh4dd65e02011-11-29 14:46:56 +00002674 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
drhd64fe2f2005-08-28 17:00:23 +00002675
dancd74b612011-04-22 19:37:32 +00002676 /* Parse the filename/URI argument. */
dan19432992011-05-10 18:39:10 +00002677 db->openFlags = flags;
dancd74b612011-04-22 19:37:32 +00002678 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
2679 if( rc!=SQLITE_OK ){
drhffd96682011-05-07 18:40:36 +00002680 if( rc==SQLITE_NOMEM ) db->mallocFailed = 1;
drh13f40da2014-08-22 18:00:11 +00002681 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
dancd74b612011-04-22 19:37:32 +00002682 sqlite3_free(zErrMsg);
2683 goto opendb_out;
2684 }
2685
danielk19774ad17132004-05-21 01:47:26 +00002686 /* Open the backend database driver */
dan3a6d8ae2011-04-23 15:54:54 +00002687 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
drh75c014c2010-08-30 15:02:28 +00002688 flags | SQLITE_OPEN_MAIN_DB);
danielk19774ad17132004-05-21 01:47:26 +00002689 if( rc!=SQLITE_OK ){
danielk197745e60aa2008-09-23 17:39:26 +00002690 if( rc==SQLITE_IOERR_NOMEM ){
2691 rc = SQLITE_NOMEM;
2692 }
drh13f40da2014-08-22 18:00:11 +00002693 sqlite3Error(db, rc);
danielk19774ad17132004-05-21 01:47:26 +00002694 goto opendb_out;
2695 }
drh17435752007-08-16 04:30:38 +00002696 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
2697 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00002698
danielk197753c0f742005-03-29 03:10:59 +00002699 /* The default safety_level for the main database is 'full'; for the temp
2700 ** database it is 'NONE'. This matches the pager layer defaults.
2701 */
2702 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00002703 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00002704 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00002705 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00002706
danielk1977832a58a2007-06-22 15:21:15 +00002707 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00002708 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00002709 goto opendb_out;
2710 }
2711
danielk19778e227872004-06-07 07:52:17 +00002712 /* Register all built-in functions, but do not attempt to read the
2713 ** database schema yet. This is delayed until the first time the database
2714 ** is accessed.
2715 */
drh13f40da2014-08-22 18:00:11 +00002716 sqlite3Error(db, SQLITE_OK);
danielk1977832a58a2007-06-22 15:21:15 +00002717 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00002718
drh1409be62006-08-23 20:07:20 +00002719 /* Load automatic extensions - extensions that have been registered
2720 ** using the sqlite3_automatic_extension() API.
2721 */
drh7aaa8782009-05-20 02:40:45 +00002722 rc = sqlite3_errcode(db);
drhe5077c12011-12-13 04:08:36 +00002723 if( rc==SQLITE_OK ){
2724 sqlite3AutoLoadExtensions(db);
2725 rc = sqlite3_errcode(db);
2726 if( rc!=SQLITE_OK ){
2727 goto opendb_out;
2728 }
danielk1977832a58a2007-06-22 15:21:15 +00002729 }
drh1409be62006-08-23 20:07:20 +00002730
drhaa29c132006-09-02 13:58:06 +00002731#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00002732 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00002733 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002734 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00002735 }
2736#endif
2737
shessa26cf572006-10-19 20:27:58 +00002738#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00002739 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00002740 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00002741 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00002742 }
2743#endif
2744
shess69c4ae22007-08-20 17:37:47 +00002745#ifdef SQLITE_ENABLE_FTS3
2746 if( !db->mallocFailed && rc==SQLITE_OK ){
shess69c4ae22007-08-20 17:37:47 +00002747 rc = sqlite3Fts3Init(db);
2748 }
2749#endif
2750
danielk197783852ac2007-05-06 16:04:11 +00002751#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00002752 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk1977832a58a2007-06-22 15:21:15 +00002753 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00002754 }
2755#endif
danielk1977ebaecc12008-05-26 18:41:54 +00002756
2757#ifdef SQLITE_ENABLE_RTREE
2758 if( !db->mallocFailed && rc==SQLITE_OK){
danielk1977ebaecc12008-05-26 18:41:54 +00002759 rc = sqlite3RtreeInit(db);
2760 }
2761#endif
2762
drh8fd5bd32007-04-02 16:40:37 +00002763 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
2764 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
2765 ** mode. Doing nothing at all also makes NORMAL the default.
2766 */
2767#ifdef SQLITE_DEFAULT_LOCKING_MODE
2768 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
2769 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
2770 SQLITE_DEFAULT_LOCKING_MODE);
2771#endif
2772
drh13f40da2014-08-22 18:00:11 +00002773 if( rc ) sqlite3Error(db, rc);
drhf6b1a8e2013-12-19 16:26:05 +00002774
drh633e6d52008-07-28 19:34:53 +00002775 /* Enable the lookaside-malloc subsystem */
drh1b67f3c2008-10-10 17:41:28 +00002776 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
2777 sqlite3GlobalConfig.nLookaside);
drh633e6d52008-07-28 19:34:53 +00002778
dan5a299f92010-05-03 11:05:08 +00002779 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
dan586b9c82010-05-03 08:04:49 +00002780
danielk19774ad17132004-05-21 01:47:26 +00002781opendb_out:
dancd74b612011-04-22 19:37:32 +00002782 sqlite3_free(zOpen);
drhafc91042008-02-21 02:09:45 +00002783 if( db ){
danielk1977075c23a2008-09-01 18:34:20 +00002784 assert( db->mutex!=0 || isThreadsafe==0 || sqlite3GlobalConfig.bFullMutex==0 );
drhf3a65f72007-08-22 20:18:21 +00002785 sqlite3_mutex_leave(db->mutex);
2786 }
danielk197759633ae2008-08-27 19:01:57 +00002787 rc = sqlite3_errcode(db);
drhb07028f2011-10-14 21:49:18 +00002788 assert( db!=0 || rc==SQLITE_NOMEM );
danielk197759633ae2008-08-27 19:01:57 +00002789 if( rc==SQLITE_NOMEM ){
danielk19777ddad962005-12-12 06:53:03 +00002790 sqlite3_close(db);
2791 db = 0;
danielk197759633ae2008-08-27 19:01:57 +00002792 }else if( rc!=SQLITE_OK ){
2793 db->magic = SQLITE_MAGIC_SICK;
danielk197713073932004-06-30 11:54:06 +00002794 }
danielk19774ad17132004-05-21 01:47:26 +00002795 *ppDb = db;
danac455932012-11-26 19:50:41 +00002796#ifdef SQLITE_ENABLE_SQLLOG
2797 if( sqlite3GlobalConfig.xSqllog ){
dan71ba10d2012-11-27 10:56:39 +00002798 /* Opening a db handle. Fourth parameter is passed 0. */
2799 void *pArg = sqlite3GlobalConfig.pSqllogArg;
2800 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
danac455932012-11-26 19:50:41 +00002801 }
2802#endif
danielk197754f01982006-01-18 15:25:17 +00002803 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002804}
2805
2806/*
2807** Open a new database handle.
2808*/
danielk197780290862004-05-22 09:21:21 +00002809int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00002810 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002811 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002812){
drh605264d2007-08-21 15:13:19 +00002813 return openDatabase(zFilename, ppDb,
2814 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
2815}
2816int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00002817 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00002818 sqlite3 **ppDb, /* OUT: SQLite db handle */
2819 int flags, /* Flags */
2820 const char *zVfs /* Name of VFS module to use */
2821){
drh522c26f2011-05-07 14:40:29 +00002822 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00002823}
2824
drh6c626082004-11-14 21:56:29 +00002825#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00002826/*
2827** Open a new database handle.
2828*/
2829int sqlite3_open16(
2830 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00002831 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00002832){
danielk1977bfd6cce2004-06-18 04:24:54 +00002833 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00002834 sqlite3_value *pVal;
drh40257ff2008-06-13 18:24:27 +00002835 int rc;
danielk19774ad17132004-05-21 01:47:26 +00002836
drh9ca95732014-10-24 00:35:58 +00002837#ifdef SQLITE_ENABLE_API_ARMOR
2838 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2839#endif
danielk1977bfd6cce2004-06-18 04:24:54 +00002840 *ppDb = 0;
drh40257ff2008-06-13 18:24:27 +00002841#ifndef SQLITE_OMIT_AUTOINIT
2842 rc = sqlite3_initialize();
2843 if( rc ) return rc;
2844#endif
drh9ca95732014-10-24 00:35:58 +00002845 if( zFilename==0 ) zFilename = "\000\000";
danielk19771e536952007-08-16 10:09:01 +00002846 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00002847 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
2848 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00002849 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00002850 rc = openDatabase(zFilename8, ppDb,
2851 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
drhafc91042008-02-21 02:09:45 +00002852 assert( *ppDb || rc==SQLITE_NOMEM );
danielk1977f51bf482008-04-28 16:19:35 +00002853 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
danielk1977fb103a82008-04-03 16:28:24 +00002854 ENC(*ppDb) = SQLITE_UTF16NATIVE;
danielk1977bfd6cce2004-06-18 04:24:54 +00002855 }
drh40257ff2008-06-13 18:24:27 +00002856 }else{
2857 rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00002858 }
danielk19777ddad962005-12-12 06:53:03 +00002859 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00002860
danielk197754f01982006-01-18 15:25:17 +00002861 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00002862}
drh6c626082004-11-14 21:56:29 +00002863#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00002864
danielk1977106bb232004-05-21 10:08:53 +00002865/*
danielk1977d8123362004-06-12 09:25:12 +00002866** Register a new collation sequence with the database handle db.
2867*/
danielk19770202b292004-06-09 09:55:16 +00002868int sqlite3_create_collation(
2869 sqlite3* db,
2870 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00002871 int enc,
danielk19770202b292004-06-09 09:55:16 +00002872 void* pCtx,
2873 int(*xCompare)(void*,int,const void*,int,const void*)
2874){
drh4f81bbb2014-10-23 01:01:26 +00002875 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
danielk1977a9808b32007-05-07 09:32:45 +00002876}
2877
2878/*
2879** Register a new collation sequence with the database handle db.
2880*/
danielk1977a393c032007-05-07 14:58:53 +00002881int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00002882 sqlite3* db,
2883 const char *zName,
2884 int enc,
2885 void* pCtx,
2886 int(*xCompare)(void*,int,const void*,int,const void*),
2887 void(*xDel)(void*)
2888){
2889 int rc;
drh9ca95732014-10-24 00:35:58 +00002890
2891#ifdef SQLITE_ENABLE_API_ARMOR
2892 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2893#endif
drhe30f4422007-08-21 16:15:55 +00002894 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002895 assert( !db->mallocFailed );
drh4dd65e02011-11-29 14:46:56 +00002896 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00002897 rc = sqlite3ApiExit(db, rc);
2898 sqlite3_mutex_leave(db->mutex);
2899 return rc;
danielk19770202b292004-06-09 09:55:16 +00002900}
2901
drh6c626082004-11-14 21:56:29 +00002902#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002903/*
2904** Register a new collation sequence with the database handle db.
2905*/
danielk19770202b292004-06-09 09:55:16 +00002906int sqlite3_create_collation16(
2907 sqlite3* db,
mihailimbda2e622008-06-23 11:23:14 +00002908 const void *zName,
danielk1977466be562004-06-10 02:16:01 +00002909 int enc,
danielk19770202b292004-06-09 09:55:16 +00002910 void* pCtx,
2911 int(*xCompare)(void*,int,const void*,int,const void*)
2912){
danielk19779a30cf62006-01-18 04:26:07 +00002913 int rc = SQLITE_OK;
drh01495b92008-01-23 12:52:40 +00002914 char *zName8;
drh9ca95732014-10-24 00:35:58 +00002915
2916#ifdef SQLITE_ENABLE_API_ARMOR
2917 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
2918#endif
drhe30f4422007-08-21 16:15:55 +00002919 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00002920 assert( !db->mallocFailed );
danb7dca7d2010-03-05 16:32:12 +00002921 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
danielk19779a30cf62006-01-18 04:26:07 +00002922 if( zName8 ){
drh4dd65e02011-11-29 14:46:56 +00002923 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
drh633e6d52008-07-28 19:34:53 +00002924 sqlite3DbFree(db, zName8);
danielk19779a30cf62006-01-18 04:26:07 +00002925 }
drhe30f4422007-08-21 16:15:55 +00002926 rc = sqlite3ApiExit(db, rc);
2927 sqlite3_mutex_leave(db->mutex);
2928 return rc;
danielk19770202b292004-06-09 09:55:16 +00002929}
drh6c626082004-11-14 21:56:29 +00002930#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00002931
danielk1977d8123362004-06-12 09:25:12 +00002932/*
2933** Register a collation sequence factory callback with the database handle
2934** db. Replace any previously installed collation sequence factory.
2935*/
danielk19777cedc8d2004-06-10 10:50:08 +00002936int sqlite3_collation_needed(
2937 sqlite3 *db,
2938 void *pCollNeededArg,
2939 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
2940){
drh9ca95732014-10-24 00:35:58 +00002941#ifdef SQLITE_ENABLE_API_ARMOR
2942 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2943#endif
drhe30f4422007-08-21 16:15:55 +00002944 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002945 db->xCollNeeded = xCollNeeded;
2946 db->xCollNeeded16 = 0;
2947 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002948 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002949 return SQLITE_OK;
2950}
danielk1977d8123362004-06-12 09:25:12 +00002951
drh6c626082004-11-14 21:56:29 +00002952#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00002953/*
2954** Register a collation sequence factory callback with the database handle
2955** db. Replace any previously installed collation sequence factory.
2956*/
danielk19777cedc8d2004-06-10 10:50:08 +00002957int sqlite3_collation_needed16(
2958 sqlite3 *db,
2959 void *pCollNeededArg,
2960 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
2961){
drh9ca95732014-10-24 00:35:58 +00002962#ifdef SQLITE_ENABLE_API_ARMOR
2963 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2964#endif
drhe30f4422007-08-21 16:15:55 +00002965 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002966 db->xCollNeeded = 0;
2967 db->xCollNeeded16 = xCollNeeded16;
2968 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00002969 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00002970 return SQLITE_OK;
2971}
drh6c626082004-11-14 21:56:29 +00002972#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00002973
shaneeec556d2008-10-12 00:27:53 +00002974#ifndef SQLITE_OMIT_DEPRECATED
danielk19776b456a22005-03-21 04:04:02 +00002975/*
danielk19777ddad962005-12-12 06:53:03 +00002976** This function is now an anachronism. It used to be used to recover from a
2977** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00002978*/
drh7d97efb2007-10-12 19:35:48 +00002979int sqlite3_global_recover(void){
danielk1977261919c2005-12-06 12:52:59 +00002980 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00002981}
2982#endif
drh3e1d8e62005-05-26 16:23:34 +00002983
2984/*
2985** Test to see whether or not the database connection is in autocommit
2986** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
2987** by default. Autocommit is disabled by a BEGIN statement and reenabled
2988** by the next COMMIT or ROLLBACK.
drh3e1d8e62005-05-26 16:23:34 +00002989*/
2990int sqlite3_get_autocommit(sqlite3 *db){
drh9ca95732014-10-24 00:35:58 +00002991#ifdef SQLITE_ENABLE_API_ARMOR
2992 if( !sqlite3SafetyCheckOk(db) ){
2993 (void)SQLITE_MISUSE_BKPT;
2994 return 0;
2995 }
2996#endif
drh3e1d8e62005-05-26 16:23:34 +00002997 return db->autoCommit;
2998}
drh49285702005-09-17 15:20:26 +00002999
drh49285702005-09-17 15:20:26 +00003000/*
peter.d.reid60ec9142014-09-06 16:39:46 +00003001** The following routines are substitutes for constants SQLITE_CORRUPT,
drh9978c972010-02-23 17:36:32 +00003002** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_IOERR and possibly other error
peter.d.reid60ec9142014-09-06 16:39:46 +00003003** constants. They serve two purposes:
drh9978c972010-02-23 17:36:32 +00003004**
3005** 1. Serve as a convenient place to set a breakpoint in a debugger
3006** to detect when version error conditions occurs.
3007**
3008** 2. Invoke sqlite3_log() to provide the source code location where
3009** a low-level error is first detected.
drh49285702005-09-17 15:20:26 +00003010*/
drh9978c972010-02-23 17:36:32 +00003011int sqlite3CorruptError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003012 testcase( sqlite3GlobalConfig.xLog!=0 );
drh9978c972010-02-23 17:36:32 +00003013 sqlite3_log(SQLITE_CORRUPT,
drh75e876b2010-06-23 17:59:51 +00003014 "database corruption at line %d of [%.10s]",
3015 lineno, 20+sqlite3_sourceid());
drh49285702005-09-17 15:20:26 +00003016 return SQLITE_CORRUPT;
3017}
drh9978c972010-02-23 17:36:32 +00003018int sqlite3MisuseError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003019 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003020 sqlite3_log(SQLITE_MISUSE,
3021 "misuse at line %d of [%.10s]",
3022 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003023 return SQLITE_MISUSE;
3024}
3025int sqlite3CantopenError(int lineno){
drhaf46dc12010-02-24 21:44:07 +00003026 testcase( sqlite3GlobalConfig.xLog!=0 );
drh75e876b2010-06-23 17:59:51 +00003027 sqlite3_log(SQLITE_CANTOPEN,
3028 "cannot open file at line %d of [%.10s]",
3029 lineno, 20+sqlite3_sourceid());
drh9978c972010-02-23 17:36:32 +00003030 return SQLITE_CANTOPEN;
3031}
3032
drh7c1817e2006-01-10 13:58:48 +00003033
shaneeec556d2008-10-12 00:27:53 +00003034#ifndef SQLITE_OMIT_DEPRECATED
drh6f7adc82006-01-11 21:41:20 +00003035/*
3036** This is a convenience routine that makes sure that all thread-specific
3037** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00003038**
3039** SQLite no longer uses thread-specific data so this routine is now a
3040** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00003041*/
3042void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00003043}
shaneeec556d2008-10-12 00:27:53 +00003044#endif
danielk1977deb802c2006-02-09 13:43:28 +00003045
3046/*
3047** Return meta information about a specific column of a database table.
3048** See comment in sqlite3.h (sqlite.h.in) for details.
3049*/
3050#ifdef SQLITE_ENABLE_COLUMN_METADATA
3051int sqlite3_table_column_metadata(
3052 sqlite3 *db, /* Connection handle */
3053 const char *zDbName, /* Database name or NULL */
3054 const char *zTableName, /* Table name */
3055 const char *zColumnName, /* Column name */
3056 char const **pzDataType, /* OUTPUT: Declared data type */
3057 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3058 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3059 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
drh9be07162008-06-16 20:51:15 +00003060 int *pAutoinc /* OUTPUT: True if column is auto-increment */
danielk1977deb802c2006-02-09 13:43:28 +00003061){
3062 int rc;
3063 char *zErrMsg = 0;
3064 Table *pTab = 0;
3065 Column *pCol = 0;
3066 int iCol;
3067
3068 char const *zDataType = 0;
3069 char const *zCollSeq = 0;
3070 int notnull = 0;
3071 int primarykey = 0;
3072 int autoinc = 0;
3073
3074 /* Ensure the database schema has been loaded */
drhe30f4422007-08-21 16:15:55 +00003075 sqlite3_mutex_enter(db->mutex);
drh3cb3edc2008-03-07 21:37:19 +00003076 sqlite3BtreeEnterAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003077 rc = sqlite3Init(db, &zErrMsg);
3078 if( SQLITE_OK!=rc ){
3079 goto error_out;
3080 }
3081
3082 /* Locate the table in question */
3083 pTab = sqlite3FindTable(db, zTableName, zDbName);
3084 if( !pTab || pTab->pSelect ){
3085 pTab = 0;
3086 goto error_out;
3087 }
3088
3089 /* Find the column for which info is requested */
3090 if( sqlite3IsRowid(zColumnName) ){
3091 iCol = pTab->iPKey;
3092 if( iCol>=0 ){
3093 pCol = &pTab->aCol[iCol];
3094 }
3095 }else{
3096 for(iCol=0; iCol<pTab->nCol; iCol++){
3097 pCol = &pTab->aCol[iCol];
3098 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3099 break;
3100 }
3101 }
3102 if( iCol==pTab->nCol ){
3103 pTab = 0;
3104 goto error_out;
3105 }
3106 }
3107
3108 /* The following block stores the meta information that will be returned
3109 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3110 ** and autoinc. At this point there are two possibilities:
3111 **
3112 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3113 ** and there is no explicitly declared IPK column.
3114 **
3115 ** 2. The table is not a view and the column name identified an
3116 ** explicitly declared column. Copy meta information from *pCol.
3117 */
3118 if( pCol ){
3119 zDataType = pCol->zType;
3120 zCollSeq = pCol->zColl;
drh9be07162008-06-16 20:51:15 +00003121 notnull = pCol->notNull!=0;
drha371ace2012-09-13 14:22:47 +00003122 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
drh7d10d5a2008-08-20 16:35:10 +00003123 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
danielk1977deb802c2006-02-09 13:43:28 +00003124 }else{
3125 zDataType = "INTEGER";
3126 primarykey = 1;
3127 }
3128 if( !zCollSeq ){
3129 zCollSeq = "BINARY";
3130 }
3131
3132error_out:
danielk197702b4e3b2009-02-26 07:15:59 +00003133 sqlite3BtreeLeaveAll(db);
danielk1977deb802c2006-02-09 13:43:28 +00003134
3135 /* Whether the function call succeeded or failed, set the output parameters
3136 ** to whatever their local counterparts contain. If an error did occur,
3137 ** this has the effect of zeroing all output parameters.
3138 */
3139 if( pzDataType ) *pzDataType = zDataType;
3140 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3141 if( pNotNull ) *pNotNull = notnull;
3142 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3143 if( pAutoinc ) *pAutoinc = autoinc;
3144
3145 if( SQLITE_OK==rc && !pTab ){
drh633e6d52008-07-28 19:34:53 +00003146 sqlite3DbFree(db, zErrMsg);
drh118640b2008-07-16 14:02:32 +00003147 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
drhf089aa42008-07-08 19:34:06 +00003148 zColumnName);
danielk1977deb802c2006-02-09 13:43:28 +00003149 rc = SQLITE_ERROR;
3150 }
drh13f40da2014-08-22 18:00:11 +00003151 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh633e6d52008-07-28 19:34:53 +00003152 sqlite3DbFree(db, zErrMsg);
drhe30f4422007-08-21 16:15:55 +00003153 rc = sqlite3ApiExit(db, rc);
3154 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00003155 return rc;
3156}
drhe30f4422007-08-21 16:15:55 +00003157#endif
drhf9cb7f52006-06-27 20:06:44 +00003158
3159/*
3160** Sleep for a little while. Return the amount of time slept.
3161*/
3162int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00003163 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00003164 int rc;
drhd677b3d2007-08-20 22:48:41 +00003165 pVfs = sqlite3_vfs_find(0);
drh40257ff2008-06-13 18:24:27 +00003166 if( pVfs==0 ) return 0;
danielk1977fee2d252007-08-18 10:59:19 +00003167
3168 /* This function works in milliseconds, but the underlying OsSleep()
3169 ** API uses microseconds. Hence the 1000's.
3170 */
drhe30f4422007-08-21 16:15:55 +00003171 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00003172 return rc;
drhf9cb7f52006-06-27 20:06:44 +00003173}
drh4ac285a2006-09-15 07:28:50 +00003174
3175/*
3176** Enable or disable the extended result codes.
3177*/
3178int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drh9ca95732014-10-24 00:35:58 +00003179#ifdef SQLITE_ENABLE_API_ARMOR
3180 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3181#endif
drhe30f4422007-08-21 16:15:55 +00003182 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003183 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00003184 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00003185 return SQLITE_OK;
3186}
drhcc6bb3e2007-08-31 16:11:35 +00003187
3188/*
3189** Invoke the xFileControl method on a particular database.
3190*/
3191int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3192 int rc = SQLITE_ERROR;
drh421377e2012-03-15 21:28:54 +00003193 Btree *pBtree;
3194
drh9ca95732014-10-24 00:35:58 +00003195#ifdef SQLITE_ENABLE_API_ARMOR
3196 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3197#endif
drhcc6bb3e2007-08-31 16:11:35 +00003198 sqlite3_mutex_enter(db->mutex);
drh421377e2012-03-15 21:28:54 +00003199 pBtree = sqlite3DbNameToBtree(db, zDbName);
3200 if( pBtree ){
3201 Pager *pPager;
3202 sqlite3_file *fd;
3203 sqlite3BtreeEnter(pBtree);
3204 pPager = sqlite3BtreePager(pBtree);
3205 assert( pPager!=0 );
3206 fd = sqlite3PagerFile(pPager);
3207 assert( fd!=0 );
3208 if( op==SQLITE_FCNTL_FILE_POINTER ){
3209 *(sqlite3_file**)pArg = fd;
3210 rc = SQLITE_OK;
3211 }else if( fd->pMethods ){
3212 rc = sqlite3OsFileControl(fd, op, pArg);
3213 }else{
3214 rc = SQLITE_NOTFOUND;
drhcc6bb3e2007-08-31 16:11:35 +00003215 }
drh421377e2012-03-15 21:28:54 +00003216 sqlite3BtreeLeave(pBtree);
drhcc6bb3e2007-08-31 16:11:35 +00003217 }
3218 sqlite3_mutex_leave(db->mutex);
3219 return rc;
3220}
drhed13d982008-01-31 14:43:24 +00003221
3222/*
3223** Interface to the testing logic.
3224*/
3225int sqlite3_test_control(int op, ...){
drhed13d982008-01-31 14:43:24 +00003226 int rc = 0;
drh3088d592008-03-21 16:45:47 +00003227#ifndef SQLITE_OMIT_BUILTIN_TEST
drh2fa18682008-03-19 14:15:34 +00003228 va_list ap;
drhed13d982008-01-31 14:43:24 +00003229 va_start(ap, op);
3230 switch( op ){
danielk1977d09414c2008-06-19 18:17:49 +00003231
3232 /*
drh984bfaa2008-03-19 16:08:53 +00003233 ** Save the current state of the PRNG.
3234 */
drh2fa18682008-03-19 14:15:34 +00003235 case SQLITE_TESTCTRL_PRNG_SAVE: {
3236 sqlite3PrngSaveState();
3237 break;
3238 }
drh984bfaa2008-03-19 16:08:53 +00003239
3240 /*
3241 ** Restore the state of the PRNG to the last state saved using
3242 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3243 ** this verb acts like PRNG_RESET.
3244 */
drh2fa18682008-03-19 14:15:34 +00003245 case SQLITE_TESTCTRL_PRNG_RESTORE: {
3246 sqlite3PrngRestoreState();
3247 break;
3248 }
drh984bfaa2008-03-19 16:08:53 +00003249
3250 /*
3251 ** Reset the PRNG back to its uninitialized state. The next call
3252 ** to sqlite3_randomness() will reseed the PRNG using a single call
3253 ** to the xRandomness method of the default VFS.
3254 */
drh2fa18682008-03-19 14:15:34 +00003255 case SQLITE_TESTCTRL_PRNG_RESET: {
drhfe980812014-01-01 14:00:13 +00003256 sqlite3_randomness(0,0);
drh2fa18682008-03-19 14:15:34 +00003257 break;
3258 }
drh3088d592008-03-21 16:45:47 +00003259
3260 /*
3261 ** sqlite3_test_control(BITVEC_TEST, size, program)
3262 **
3263 ** Run a test against a Bitvec object of size. The program argument
3264 ** is an array of integers that defines the test. Return -1 on a
3265 ** memory allocation error, 0 on success, or non-zero for an error.
3266 ** See the sqlite3BitvecBuiltinTest() for additional information.
3267 */
3268 case SQLITE_TESTCTRL_BITVEC_TEST: {
3269 int sz = va_arg(ap, int);
3270 int *aProg = va_arg(ap, int*);
3271 rc = sqlite3BitvecBuiltinTest(sz, aProg);
3272 break;
3273 }
danielk19772d1d86f2008-06-20 14:59:51 +00003274
3275 /*
drhc007f612014-05-16 14:17:01 +00003276 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3277 **
3278 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3279 ** if xCallback is not NULL.
3280 **
3281 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3282 ** is called immediately after installing the new callback and the return
3283 ** value from sqlite3FaultSim(0) becomes the return from
3284 ** sqlite3_test_control().
3285 */
3286 case SQLITE_TESTCTRL_FAULT_INSTALL: {
mistachkin77a90ce2014-05-16 23:15:50 +00003287 /* MSVC is picky about pulling func ptrs from va lists.
3288 ** http://support.microsoft.com/kb/47961
dan685ffb12014-06-23 10:18:50 +00003289 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
mistachkin77a90ce2014-05-16 23:15:50 +00003290 */
3291 typedef int(*TESTCALLBACKFUNC_t)(int);
dan685ffb12014-06-23 10:18:50 +00003292 sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
drhc007f612014-05-16 14:17:01 +00003293 rc = sqlite3FaultSim(0);
3294 break;
3295 }
3296
3297 /*
danielk19772d1d86f2008-06-20 14:59:51 +00003298 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3299 **
3300 ** Register hooks to call to indicate which malloc() failures
3301 ** are benign.
3302 */
3303 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
danielk1977ca026792008-06-23 14:15:52 +00003304 typedef void (*void_function)(void);
3305 void_function xBenignBegin;
3306 void_function xBenignEnd;
3307 xBenignBegin = va_arg(ap, void_function);
3308 xBenignEnd = va_arg(ap, void_function);
danielk19772d1d86f2008-06-20 14:59:51 +00003309 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3310 break;
3311 }
drhc7a3bb92009-02-05 16:31:45 +00003312
3313 /*
drhf3af63f2009-05-09 18:59:42 +00003314 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
drhc7a3bb92009-02-05 16:31:45 +00003315 **
3316 ** Set the PENDING byte to the value in the argument, if X>0.
3317 ** Make no changes if X==0. Return the value of the pending byte
3318 ** as it existing before this routine was called.
3319 **
3320 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3321 ** an incompatible database file format. Changing the PENDING byte
3322 ** while any database connection is open results in undefined and
peter.d.reid60ec9142014-09-06 16:39:46 +00003323 ** deleterious behavior.
drhc7a3bb92009-02-05 16:31:45 +00003324 */
3325 case SQLITE_TESTCTRL_PENDING_BYTE: {
drhf83dc1e2010-06-03 12:09:52 +00003326 rc = PENDING_BYTE;
3327#ifndef SQLITE_OMIT_WSD
3328 {
3329 unsigned int newVal = va_arg(ap, unsigned int);
3330 if( newVal ) sqlite3PendingByte = newVal;
3331 }
3332#endif
drhc7a3bb92009-02-05 16:31:45 +00003333 break;
3334 }
drhf3af63f2009-05-09 18:59:42 +00003335
3336 /*
3337 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3338 **
3339 ** This action provides a run-time test to see whether or not
3340 ** assert() was enabled at compile-time. If X is true and assert()
3341 ** is enabled, then the return value is true. If X is true and
3342 ** assert() is disabled, then the return value is zero. If X is
3343 ** false and assert() is enabled, then the assertion fires and the
3344 ** process aborts. If X is false and assert() is disabled, then the
3345 ** return value is zero.
3346 */
3347 case SQLITE_TESTCTRL_ASSERT: {
3348 volatile int x = 0;
3349 assert( (x = va_arg(ap,int))!=0 );
3350 rc = x;
3351 break;
3352 }
3353
3354
3355 /*
3356 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3357 **
3358 ** This action provides a run-time test to see how the ALWAYS and
3359 ** NEVER macros were defined at compile-time.
3360 **
3361 ** The return value is ALWAYS(X).
3362 **
3363 ** The recommended test is X==2. If the return value is 2, that means
3364 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3365 ** default setting. If the return value is 1, then ALWAYS() is either
3366 ** hard-coded to true or else it asserts if its argument is false.
3367 ** The first behavior (hard-coded to true) is the case if
3368 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3369 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3370 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3371 **
3372 ** The run-time test procedure might look something like this:
3373 **
3374 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3375 ** // ALWAYS() and NEVER() are no-op pass-through macros
3376 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3377 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3378 ** }else{
3379 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3380 ** }
3381 */
3382 case SQLITE_TESTCTRL_ALWAYS: {
3383 int x = va_arg(ap,int);
3384 rc = ALWAYS(x);
3385 break;
3386 }
drhc046e3e2009-07-15 11:26:44 +00003387
drh2cf4acb2014-04-18 00:06:02 +00003388 /*
3389 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3390 **
3391 ** The integer returned reveals the byte-order of the computer on which
3392 ** SQLite is running:
3393 **
3394 ** 1 big-endian, determined at run-time
3395 ** 10 little-endian, determined at run-time
3396 ** 432101 big-endian, determined at compile-time
3397 ** 123410 little-endian, determined at compile-time
3398 */
3399 case SQLITE_TESTCTRL_BYTEORDER: {
3400 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3401 break;
3402 }
3403
drhc046e3e2009-07-15 11:26:44 +00003404 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3405 **
3406 ** Set the nReserve size to N for the main database on the database
3407 ** connection db.
3408 */
3409 case SQLITE_TESTCTRL_RESERVE: {
3410 sqlite3 *db = va_arg(ap, sqlite3*);
3411 int x = va_arg(ap,int);
3412 sqlite3_mutex_enter(db->mutex);
3413 sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3414 sqlite3_mutex_leave(db->mutex);
3415 break;
3416 }
3417
drh07096f62009-12-22 23:52:32 +00003418 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3419 **
3420 ** Enable or disable various optimizations for testing purposes. The
3421 ** argument N is a bitmask of optimizations to be disabled. For normal
3422 ** operation N should be 0. The idea is that a test program (like the
3423 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3424 ** with various optimizations disabled to verify that the same answer
3425 ** is obtained in every case.
3426 */
3427 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3428 sqlite3 *db = va_arg(ap, sqlite3*);
drha5759672012-10-30 14:39:12 +00003429 db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
drh07096f62009-12-22 23:52:32 +00003430 break;
3431 }
3432
drh0e857732010-01-02 03:21:35 +00003433#ifdef SQLITE_N_KEYWORD
3434 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3435 **
3436 ** If zWord is a keyword recognized by the parser, then return the
3437 ** number of keywords. Or if zWord is not a keyword, return 0.
3438 **
3439 ** This test feature is only available in the amalgamation since
3440 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3441 ** is built using separate source files.
3442 */
3443 case SQLITE_TESTCTRL_ISKEYWORD: {
3444 const char *zWord = va_arg(ap, const char*);
3445 int n = sqlite3Strlen30(zWord);
drh855787a2010-01-02 03:46:43 +00003446 rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
drh0e857732010-01-02 03:21:35 +00003447 break;
3448 }
3449#endif
3450
drhbadc9802010-08-27 17:16:44 +00003451 /* sqlite3_test_control(SQLITE_TESTCTRL_SCRATCHMALLOC, sz, &pNew, pFree);
3452 **
3453 ** Pass pFree into sqlite3ScratchFree().
3454 ** If sz>0 then allocate a scratch buffer into pNew.
3455 */
3456 case SQLITE_TESTCTRL_SCRATCHMALLOC: {
3457 void *pFree, **ppNew;
3458 int sz;
3459 sz = va_arg(ap, int);
3460 ppNew = va_arg(ap, void**);
3461 pFree = va_arg(ap, void*);
3462 if( sz ) *ppNew = sqlite3ScratchMalloc(sz);
3463 sqlite3ScratchFree(pFree);
3464 break;
3465 }
3466
danc17d6962011-06-21 12:47:30 +00003467 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3468 **
3469 ** If parameter onoff is non-zero, configure the wrappers so that all
3470 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3471 ** undo this setting.
3472 */
3473 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3474 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3475 break;
3476 }
3477
drh09fe6142013-11-29 15:06:27 +00003478 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3479 **
3480 ** Set or clear a flag that indicates that the database file is always well-
3481 ** formed and never corrupt. This flag is clear by default, indicating that
3482 ** database files might have arbitrary corruption. Setting the flag during
3483 ** testing causes certain assert() statements in the code to be activated
3484 ** that demonstrat invariants on well-formed database files.
3485 */
3486 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
dan9c2552f2014-01-28 17:49:13 +00003487 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
drh09fe6142013-11-29 15:06:27 +00003488 break;
3489 }
3490
drh688852a2014-02-17 22:40:43 +00003491
3492 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3493 **
3494 ** Set the VDBE coverage callback function to xCallback with context
3495 ** pointer ptr.
3496 */
3497 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
3498#ifdef SQLITE_VDBE_COVERAGE
3499 typedef void (*branch_callback)(void*,int,u8,u8);
3500 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
3501 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
3502#endif
3503 break;
3504 }
3505
dan8930c2a2014-04-03 16:25:29 +00003506 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3507 case SQLITE_TESTCTRL_SORTER_MMAP: {
3508 sqlite3 *db = va_arg(ap, sqlite3*);
3509 db->nMaxSorterMmap = va_arg(ap, int);
3510 break;
3511 }
3512
drh43cfc232014-07-29 14:09:21 +00003513 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3514 **
3515 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3516 ** not.
3517 */
3518 case SQLITE_TESTCTRL_ISINIT: {
3519 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
3520 break;
3521 }
drhed13d982008-01-31 14:43:24 +00003522 }
3523 va_end(ap);
drh3088d592008-03-21 16:45:47 +00003524#endif /* SQLITE_OMIT_BUILTIN_TEST */
danielk19777c36d072008-01-31 15:31:01 +00003525 return rc;
drhed13d982008-01-31 14:43:24 +00003526}
drhcc487d12011-05-17 18:53:08 +00003527
3528/*
3529** This is a utility routine, useful to VFS implementations, that checks
3530** to see if a database file was a URI that contained a specific query
3531** parameter, and if so obtains the value of the query parameter.
3532**
3533** The zFilename argument is the filename pointer passed into the xOpen()
3534** method of a VFS implementation. The zParam argument is the name of the
3535** query parameter we seek. This routine returns the value of the zParam
3536** parameter if it exists. If the parameter does not exist, this routine
3537** returns a NULL pointer.
3538*/
3539const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
drh9ca95732014-10-24 00:35:58 +00003540 if( zFilename==0 || zParam==0 ) return 0;
drhbd695592011-05-17 19:43:38 +00003541 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003542 while( zFilename[0] ){
3543 int x = strcmp(zFilename, zParam);
drhbd695592011-05-17 19:43:38 +00003544 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003545 if( x==0 ) return zFilename;
drhbd695592011-05-17 19:43:38 +00003546 zFilename += sqlite3Strlen30(zFilename) + 1;
drhcc487d12011-05-17 18:53:08 +00003547 }
3548 return 0;
3549}
drh283829c2011-11-17 00:56:20 +00003550
3551/*
drh92913722011-12-23 00:07:33 +00003552** Return a boolean value for a query parameter.
3553*/
3554int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
3555 const char *z = sqlite3_uri_parameter(zFilename, zParam);
drh38d9c612012-01-31 14:24:47 +00003556 bDflt = bDflt!=0;
3557 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
drh92913722011-12-23 00:07:33 +00003558}
3559
3560/*
3561** Return a 64-bit integer value for a query parameter.
3562*/
3563sqlite3_int64 sqlite3_uri_int64(
3564 const char *zFilename, /* Filename as passed to xOpen */
3565 const char *zParam, /* URI parameter sought */
3566 sqlite3_int64 bDflt /* return if parameter is missing */
3567){
3568 const char *z = sqlite3_uri_parameter(zFilename, zParam);
3569 sqlite3_int64 v;
drh9296c182014-07-23 13:40:49 +00003570 if( z && sqlite3DecOrHexToI64(z, &v)==SQLITE_OK ){
drh92913722011-12-23 00:07:33 +00003571 bDflt = v;
3572 }
3573 return bDflt;
3574}
3575
3576/*
drh421377e2012-03-15 21:28:54 +00003577** Return the Btree pointer identified by zDbName. Return NULL if not found.
3578*/
3579Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
3580 int i;
3581 for(i=0; i<db->nDb; i++){
3582 if( db->aDb[i].pBt
3583 && (zDbName==0 || sqlite3StrICmp(zDbName, db->aDb[i].zName)==0)
3584 ){
3585 return db->aDb[i].pBt;
3586 }
3587 }
3588 return 0;
3589}
3590
3591/*
drh283829c2011-11-17 00:56:20 +00003592** Return the filename of the database associated with a database
3593** connection.
3594*/
3595const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003596#ifdef SQLITE_ENABLE_API_ARMOR
3597 if( !sqlite3SafetyCheckOk(db) ){
3598 (void)SQLITE_MISUSE_BKPT;
3599 return 0;
3600 }
3601#endif
drh421377e2012-03-15 21:28:54 +00003602 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
3603 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
3604}
3605
3606/*
3607** Return 1 if database is read-only or 0 if read/write. Return -1 if
3608** no such database exists.
3609*/
3610int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
drh9ca95732014-10-24 00:35:58 +00003611#ifdef SQLITE_ENABLE_API_ARMOR
3612 if( !sqlite3SafetyCheckOk(db) ){
3613 (void)SQLITE_MISUSE_BKPT;
3614 return -1;
3615 }
3616#endif
drh421377e2012-03-15 21:28:54 +00003617 Btree *pBt = sqlite3DbNameToBtree(db, zDbName);
drh781597f2014-05-21 08:21:07 +00003618 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
drh283829c2011-11-17 00:56:20 +00003619}