xref: /sqlite-3.40.0/src/main.c (revision bd462bcc)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** 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.
16 */
17 #include "sqliteInt.h"
18 
19 #ifdef SQLITE_ENABLE_FTS3
20 # include "fts3.h"
21 #endif
22 #ifdef SQLITE_ENABLE_RTREE
23 # include "rtree.h"
24 #endif
25 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
26 # include "sqliteicu.h"
27 #endif
28 #ifdef SQLITE_ENABLE_JSON1
29 int sqlite3Json1Init(sqlite3*);
30 #endif
31 #ifdef SQLITE_ENABLE_STMTVTAB
32 int sqlite3StmtVtabInit(sqlite3*);
33 #endif
34 #ifdef SQLITE_ENABLE_FTS5
35 int sqlite3Fts5Init(sqlite3*);
36 #endif
37 
38 #ifndef SQLITE_AMALGAMATION
39 /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
40 ** contains the text of SQLITE_VERSION macro.
41 */
42 const char sqlite3_version[] = SQLITE_VERSION;
43 #endif
44 
45 /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
46 ** a pointer to the to the sqlite3_version[] string constant.
47 */
48 const char *sqlite3_libversion(void){ return sqlite3_version; }
49 
50 /* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
51 ** pointer to a string constant whose value is the same as the
52 ** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
53 ** an edited copy of the amalgamation, then the last four characters of
54 ** the hash might be different from SQLITE_SOURCE_ID.
55 */
56 const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
57 
58 /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
59 ** returns an integer equal to SQLITE_VERSION_NUMBER.
60 */
61 int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
62 
63 /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
64 ** zero if and only if SQLite was compiled with mutexing code omitted due to
65 ** the SQLITE_THREADSAFE compile-time option being set to 0.
66 */
67 int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
68 
69 /*
70 ** When compiling the test fixture or with debugging enabled (on Win32),
71 ** this variable being set to non-zero will cause OSTRACE macros to emit
72 ** extra diagnostic information.
73 */
74 #ifdef SQLITE_HAVE_OS_TRACE
75 # ifndef SQLITE_DEBUG_OS_TRACE
76 #   define SQLITE_DEBUG_OS_TRACE 0
77 # endif
78   int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
79 #endif
80 
81 #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
82 /*
83 ** If the following function pointer is not NULL and if
84 ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
85 ** I/O active are written using this function.  These messages
86 ** are intended for debugging activity only.
87 */
88 SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
89 #endif
90 
91 /*
92 ** If the following global variable points to a string which is the
93 ** name of a directory, then that directory will be used to store
94 ** temporary files.
95 **
96 ** See also the "PRAGMA temp_store_directory" SQL command.
97 */
98 char *sqlite3_temp_directory = 0;
99 
100 /*
101 ** If the following global variable points to a string which is the
102 ** name of a directory, then that directory will be used to store
103 ** all database files specified with a relative pathname.
104 **
105 ** See also the "PRAGMA data_store_directory" SQL command.
106 */
107 char *sqlite3_data_directory = 0;
108 
109 /*
110 ** Initialize SQLite.
111 **
112 ** This routine must be called to initialize the memory allocation,
113 ** VFS, and mutex subsystems prior to doing any serious work with
114 ** SQLite.  But as long as you do not compile with SQLITE_OMIT_AUTOINIT
115 ** this routine will be called automatically by key routines such as
116 ** sqlite3_open().
117 **
118 ** This routine is a no-op except on its very first call for the process,
119 ** or for the first call after a call to sqlite3_shutdown.
120 **
121 ** The first thread to call this routine runs the initialization to
122 ** completion.  If subsequent threads call this routine before the first
123 ** thread has finished the initialization process, then the subsequent
124 ** threads must block until the first thread finishes with the initialization.
125 **
126 ** The first thread might call this routine recursively.  Recursive
127 ** calls to this routine should not block, of course.  Otherwise the
128 ** initialization process would never complete.
129 **
130 ** Let X be the first thread to enter this routine.  Let Y be some other
131 ** thread.  Then while the initial invocation of this routine by X is
132 ** incomplete, it is required that:
133 **
134 **    *  Calls to this routine from Y must block until the outer-most
135 **       call by X completes.
136 **
137 **    *  Recursive calls to this routine from thread X return immediately
138 **       without blocking.
139 */
140 int sqlite3_initialize(void){
141   MUTEX_LOGIC( sqlite3_mutex *pMaster; )       /* The main static mutex */
142   int rc;                                      /* Result code */
143 #ifdef SQLITE_EXTRA_INIT
144   int bRunExtraInit = 0;                       /* Extra initialization needed */
145 #endif
146 
147 #ifdef SQLITE_OMIT_WSD
148   rc = sqlite3_wsd_init(4096, 24);
149   if( rc!=SQLITE_OK ){
150     return rc;
151   }
152 #endif
153 
154   /* If the following assert() fails on some obscure processor/compiler
155   ** combination, the work-around is to set the correct pointer
156   ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
157   assert( SQLITE_PTRSIZE==sizeof(char*) );
158 
159   /* If SQLite is already completely initialized, then this call
160   ** to sqlite3_initialize() should be a no-op.  But the initialization
161   ** must be complete.  So isInit must not be set until the very end
162   ** of this routine.
163   */
164   if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
165 
166   /* Make sure the mutex subsystem is initialized.  If unable to
167   ** initialize the mutex subsystem, return early with the error.
168   ** If the system is so sick that we are unable to allocate a mutex,
169   ** there is not much SQLite is going to be able to do.
170   **
171   ** The mutex subsystem must take care of serializing its own
172   ** initialization.
173   */
174   rc = sqlite3MutexInit();
175   if( rc ) return rc;
176 
177   /* Initialize the malloc() system and the recursive pInitMutex mutex.
178   ** This operation is protected by the STATIC_MASTER mutex.  Note that
179   ** MutexAlloc() is called for a static mutex prior to initializing the
180   ** malloc subsystem - this implies that the allocation of a static
181   ** mutex must not require support from the malloc subsystem.
182   */
183   MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
184   sqlite3_mutex_enter(pMaster);
185   sqlite3GlobalConfig.isMutexInit = 1;
186   if( !sqlite3GlobalConfig.isMallocInit ){
187     rc = sqlite3MallocInit();
188   }
189   if( rc==SQLITE_OK ){
190     sqlite3GlobalConfig.isMallocInit = 1;
191     if( !sqlite3GlobalConfig.pInitMutex ){
192       sqlite3GlobalConfig.pInitMutex =
193            sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
194       if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
195         rc = SQLITE_NOMEM_BKPT;
196       }
197     }
198   }
199   if( rc==SQLITE_OK ){
200     sqlite3GlobalConfig.nRefInitMutex++;
201   }
202   sqlite3_mutex_leave(pMaster);
203 
204   /* If rc is not SQLITE_OK at this point, then either the malloc
205   ** subsystem could not be initialized or the system failed to allocate
206   ** the pInitMutex mutex. Return an error in either case.  */
207   if( rc!=SQLITE_OK ){
208     return rc;
209   }
210 
211   /* Do the rest of the initialization under the recursive mutex so
212   ** that we will be able to handle recursive calls into
213   ** sqlite3_initialize().  The recursive calls normally come through
214   ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
215   ** recursive calls might also be possible.
216   **
217   ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
218   ** to the xInit method, so the xInit method need not be threadsafe.
219   **
220   ** The following mutex is what serializes access to the appdef pcache xInit
221   ** methods.  The sqlite3_pcache_methods.xInit() all is embedded in the
222   ** call to sqlite3PcacheInitialize().
223   */
224   sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
225   if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
226     sqlite3GlobalConfig.inProgress = 1;
227 #ifdef SQLITE_ENABLE_SQLLOG
228     {
229       extern void sqlite3_init_sqllog(void);
230       sqlite3_init_sqllog();
231     }
232 #endif
233     memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
234     sqlite3RegisterBuiltinFunctions();
235     if( sqlite3GlobalConfig.isPCacheInit==0 ){
236       rc = sqlite3PcacheInitialize();
237     }
238     if( rc==SQLITE_OK ){
239       sqlite3GlobalConfig.isPCacheInit = 1;
240       rc = sqlite3OsInit();
241     }
242 #ifdef SQLITE_ENABLE_DESERIALIZE
243     if( rc==SQLITE_OK ){
244       rc = sqlite3MemdbInit();
245     }
246 #endif
247     if( rc==SQLITE_OK ){
248       sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
249           sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
250       sqlite3GlobalConfig.isInit = 1;
251 #ifdef SQLITE_EXTRA_INIT
252       bRunExtraInit = 1;
253 #endif
254     }
255     sqlite3GlobalConfig.inProgress = 0;
256   }
257   sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
258 
259   /* Go back under the static mutex and clean up the recursive
260   ** mutex to prevent a resource leak.
261   */
262   sqlite3_mutex_enter(pMaster);
263   sqlite3GlobalConfig.nRefInitMutex--;
264   if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
265     assert( sqlite3GlobalConfig.nRefInitMutex==0 );
266     sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
267     sqlite3GlobalConfig.pInitMutex = 0;
268   }
269   sqlite3_mutex_leave(pMaster);
270 
271   /* The following is just a sanity check to make sure SQLite has
272   ** been compiled correctly.  It is important to run this code, but
273   ** we don't want to run it too often and soak up CPU cycles for no
274   ** reason.  So we run it once during initialization.
275   */
276 #ifndef NDEBUG
277 #ifndef SQLITE_OMIT_FLOATING_POINT
278   /* This section of code's only "output" is via assert() statements. */
279   if( rc==SQLITE_OK ){
280     u64 x = (((u64)1)<<63)-1;
281     double y;
282     assert(sizeof(x)==8);
283     assert(sizeof(x)==sizeof(y));
284     memcpy(&y, &x, 8);
285     assert( sqlite3IsNaN(y) );
286   }
287 #endif
288 #endif
289 
290   /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
291   ** compile-time option.
292   */
293 #ifdef SQLITE_EXTRA_INIT
294   if( bRunExtraInit ){
295     int SQLITE_EXTRA_INIT(const char*);
296     rc = SQLITE_EXTRA_INIT(0);
297   }
298 #endif
299 
300   return rc;
301 }
302 
303 /*
304 ** Undo the effects of sqlite3_initialize().  Must not be called while
305 ** there are outstanding database connections or memory allocations or
306 ** while any part of SQLite is otherwise in use in any thread.  This
307 ** routine is not threadsafe.  But it is safe to invoke this routine
308 ** on when SQLite is already shut down.  If SQLite is already shut down
309 ** when this routine is invoked, then this routine is a harmless no-op.
310 */
311 int sqlite3_shutdown(void){
312 #ifdef SQLITE_OMIT_WSD
313   int rc = sqlite3_wsd_init(4096, 24);
314   if( rc!=SQLITE_OK ){
315     return rc;
316   }
317 #endif
318 
319   if( sqlite3GlobalConfig.isInit ){
320 #ifdef SQLITE_EXTRA_SHUTDOWN
321     void SQLITE_EXTRA_SHUTDOWN(void);
322     SQLITE_EXTRA_SHUTDOWN();
323 #endif
324     sqlite3_os_end();
325     sqlite3_reset_auto_extension();
326     sqlite3GlobalConfig.isInit = 0;
327   }
328   if( sqlite3GlobalConfig.isPCacheInit ){
329     sqlite3PcacheShutdown();
330     sqlite3GlobalConfig.isPCacheInit = 0;
331   }
332   if( sqlite3GlobalConfig.isMallocInit ){
333     sqlite3MallocEnd();
334     sqlite3GlobalConfig.isMallocInit = 0;
335 
336 #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
337     /* The heap subsystem has now been shutdown and these values are supposed
338     ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
339     ** which would rely on that heap subsystem; therefore, make sure these
340     ** values cannot refer to heap memory that was just invalidated when the
341     ** heap subsystem was shutdown.  This is only done if the current call to
342     ** this function resulted in the heap subsystem actually being shutdown.
343     */
344     sqlite3_data_directory = 0;
345     sqlite3_temp_directory = 0;
346 #endif
347   }
348   if( sqlite3GlobalConfig.isMutexInit ){
349     sqlite3MutexEnd();
350     sqlite3GlobalConfig.isMutexInit = 0;
351   }
352 
353   return SQLITE_OK;
354 }
355 
356 /*
357 ** This API allows applications to modify the global configuration of
358 ** the SQLite library at run-time.
359 **
360 ** This routine should only be called when there are no outstanding
361 ** database connections or memory allocations.  This routine is not
362 ** threadsafe.  Failure to heed these warnings can lead to unpredictable
363 ** behavior.
364 */
365 int sqlite3_config(int op, ...){
366   va_list ap;
367   int rc = SQLITE_OK;
368 
369   /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
370   ** the SQLite library is in use. */
371   if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
372 
373   va_start(ap, op);
374   switch( op ){
375 
376     /* Mutex configuration options are only available in a threadsafe
377     ** compile.
378     */
379 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0  /* IMP: R-54466-46756 */
380     case SQLITE_CONFIG_SINGLETHREAD: {
381       /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
382       ** Single-thread. */
383       sqlite3GlobalConfig.bCoreMutex = 0;  /* Disable mutex on core */
384       sqlite3GlobalConfig.bFullMutex = 0;  /* Disable mutex on connections */
385       break;
386     }
387 #endif
388 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
389     case SQLITE_CONFIG_MULTITHREAD: {
390       /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
391       ** Multi-thread. */
392       sqlite3GlobalConfig.bCoreMutex = 1;  /* Enable mutex on core */
393       sqlite3GlobalConfig.bFullMutex = 0;  /* Disable mutex on connections */
394       break;
395     }
396 #endif
397 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
398     case SQLITE_CONFIG_SERIALIZED: {
399       /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
400       ** Serialized. */
401       sqlite3GlobalConfig.bCoreMutex = 1;  /* Enable mutex on core */
402       sqlite3GlobalConfig.bFullMutex = 1;  /* Enable mutex on connections */
403       break;
404     }
405 #endif
406 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
407     case SQLITE_CONFIG_MUTEX: {
408       /* Specify an alternative mutex implementation */
409       sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
410       break;
411     }
412 #endif
413 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
414     case SQLITE_CONFIG_GETMUTEX: {
415       /* Retrieve the current mutex implementation */
416       *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
417       break;
418     }
419 #endif
420 
421     case SQLITE_CONFIG_MALLOC: {
422       /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
423       ** single argument which is a pointer to an instance of the
424       ** sqlite3_mem_methods structure. The argument specifies alternative
425       ** low-level memory allocation routines to be used in place of the memory
426       ** allocation routines built into SQLite. */
427       sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
428       break;
429     }
430     case SQLITE_CONFIG_GETMALLOC: {
431       /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
432       ** single argument which is a pointer to an instance of the
433       ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
434       ** filled with the currently defined memory allocation routines. */
435       if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
436       *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
437       break;
438     }
439     case SQLITE_CONFIG_MEMSTATUS: {
440       /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
441       ** single argument of type int, interpreted as a boolean, which enables
442       ** or disables the collection of memory allocation statistics. */
443       sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
444       break;
445     }
446     case SQLITE_CONFIG_SMALL_MALLOC: {
447       sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
448       break;
449     }
450     case SQLITE_CONFIG_PAGECACHE: {
451       /* EVIDENCE-OF: R-18761-36601 There are three arguments to
452       ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
453       ** the size of each page cache line (sz), and the number of cache lines
454       ** (N). */
455       sqlite3GlobalConfig.pPage = va_arg(ap, void*);
456       sqlite3GlobalConfig.szPage = va_arg(ap, int);
457       sqlite3GlobalConfig.nPage = va_arg(ap, int);
458       break;
459     }
460     case SQLITE_CONFIG_PCACHE_HDRSZ: {
461       /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
462       ** a single parameter which is a pointer to an integer and writes into
463       ** that integer the number of extra bytes per page required for each page
464       ** in SQLITE_CONFIG_PAGECACHE. */
465       *va_arg(ap, int*) =
466           sqlite3HeaderSizeBtree() +
467           sqlite3HeaderSizePcache() +
468           sqlite3HeaderSizePcache1();
469       break;
470     }
471 
472     case SQLITE_CONFIG_PCACHE: {
473       /* no-op */
474       break;
475     }
476     case SQLITE_CONFIG_GETPCACHE: {
477       /* now an error */
478       rc = SQLITE_ERROR;
479       break;
480     }
481 
482     case SQLITE_CONFIG_PCACHE2: {
483       /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
484       ** single argument which is a pointer to an sqlite3_pcache_methods2
485       ** object. This object specifies the interface to a custom page cache
486       ** implementation. */
487       sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
488       break;
489     }
490     case SQLITE_CONFIG_GETPCACHE2: {
491       /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
492       ** single argument which is a pointer to an sqlite3_pcache_methods2
493       ** object. SQLite copies of the current page cache implementation into
494       ** that object. */
495       if( sqlite3GlobalConfig.pcache2.xInit==0 ){
496         sqlite3PCacheSetDefault();
497       }
498       *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
499       break;
500     }
501 
502 /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
503 ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
504 ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
505 #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
506     case SQLITE_CONFIG_HEAP: {
507       /* EVIDENCE-OF: R-19854-42126 There are three arguments to
508       ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
509       ** number of bytes in the memory buffer, and the minimum allocation size.
510       */
511       sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
512       sqlite3GlobalConfig.nHeap = va_arg(ap, int);
513       sqlite3GlobalConfig.mnReq = va_arg(ap, int);
514 
515       if( sqlite3GlobalConfig.mnReq<1 ){
516         sqlite3GlobalConfig.mnReq = 1;
517       }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
518         /* cap min request size at 2^12 */
519         sqlite3GlobalConfig.mnReq = (1<<12);
520       }
521 
522       if( sqlite3GlobalConfig.pHeap==0 ){
523         /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
524         ** is NULL, then SQLite reverts to using its default memory allocator
525         ** (the system malloc() implementation), undoing any prior invocation of
526         ** SQLITE_CONFIG_MALLOC.
527         **
528         ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
529         ** revert to its default implementation when sqlite3_initialize() is run
530         */
531         memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
532       }else{
533         /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
534         ** alternative memory allocator is engaged to handle all of SQLites
535         ** memory allocation needs. */
536 #ifdef SQLITE_ENABLE_MEMSYS3
537         sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
538 #endif
539 #ifdef SQLITE_ENABLE_MEMSYS5
540         sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
541 #endif
542       }
543       break;
544     }
545 #endif
546 
547     case SQLITE_CONFIG_LOOKASIDE: {
548       sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
549       sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
550       break;
551     }
552 
553     /* Record a pointer to the logger function and its first argument.
554     ** The default is NULL.  Logging is disabled if the function pointer is
555     ** NULL.
556     */
557     case SQLITE_CONFIG_LOG: {
558       /* MSVC is picky about pulling func ptrs from va lists.
559       ** http://support.microsoft.com/kb/47961
560       ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
561       */
562       typedef void(*LOGFUNC_t)(void*,int,const char*);
563       sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
564       sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
565       break;
566     }
567 
568     /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
569     ** can be changed at start-time using the
570     ** sqlite3_config(SQLITE_CONFIG_URI,1) or
571     ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
572     */
573     case SQLITE_CONFIG_URI: {
574       /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
575       ** argument of type int. If non-zero, then URI handling is globally
576       ** enabled. If the parameter is zero, then URI handling is globally
577       ** disabled. */
578       sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
579       break;
580     }
581 
582     case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
583       /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
584       ** option takes a single integer argument which is interpreted as a
585       ** boolean in order to enable or disable the use of covering indices for
586       ** full table scans in the query optimizer. */
587       sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
588       break;
589     }
590 
591 #ifdef SQLITE_ENABLE_SQLLOG
592     case SQLITE_CONFIG_SQLLOG: {
593       typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
594       sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
595       sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
596       break;
597     }
598 #endif
599 
600     case SQLITE_CONFIG_MMAP_SIZE: {
601       /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
602       ** integer (sqlite3_int64) values that are the default mmap size limit
603       ** (the default setting for PRAGMA mmap_size) and the maximum allowed
604       ** mmap size limit. */
605       sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
606       sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
607       /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
608       ** negative, then that argument is changed to its compile-time default.
609       **
610       ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
611       ** silently truncated if necessary so that it does not exceed the
612       ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
613       ** compile-time option.
614       */
615       if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
616         mxMmap = SQLITE_MAX_MMAP_SIZE;
617       }
618       if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
619       if( szMmap>mxMmap) szMmap = mxMmap;
620       sqlite3GlobalConfig.mxMmap = mxMmap;
621       sqlite3GlobalConfig.szMmap = szMmap;
622       break;
623     }
624 
625 #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
626     case SQLITE_CONFIG_WIN32_HEAPSIZE: {
627       /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
628       ** unsigned integer value that specifies the maximum size of the created
629       ** heap. */
630       sqlite3GlobalConfig.nHeap = va_arg(ap, int);
631       break;
632     }
633 #endif
634 
635     case SQLITE_CONFIG_PMASZ: {
636       sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
637       break;
638     }
639 
640     case SQLITE_CONFIG_STMTJRNL_SPILL: {
641       sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
642       break;
643     }
644 
645 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
646     case SQLITE_CONFIG_SORTERREF_SIZE: {
647       int iVal = va_arg(ap, int);
648       if( iVal<0 ){
649         iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
650       }
651       sqlite3GlobalConfig.szSorterRef = (u32)iVal;
652       break;
653     }
654 #endif /* SQLITE_ENABLE_SORTER_REFERENCES */
655 
656     default: {
657       rc = SQLITE_ERROR;
658       break;
659     }
660   }
661   va_end(ap);
662   return rc;
663 }
664 
665 /*
666 ** Set up the lookaside buffers for a database connection.
667 ** Return SQLITE_OK on success.
668 ** If lookaside is already active, return SQLITE_BUSY.
669 **
670 ** The sz parameter is the number of bytes in each lookaside slot.
671 ** The cnt parameter is the number of slots.  If pStart is NULL the
672 ** space for the lookaside memory is obtained from sqlite3_malloc().
673 ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
674 ** the lookaside memory.
675 */
676 static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
677 #ifndef SQLITE_OMIT_LOOKASIDE
678   void *pStart;
679 
680   if( sqlite3LookasideUsed(db,0)>0 ){
681     return SQLITE_BUSY;
682   }
683   /* Free any existing lookaside buffer for this handle before
684   ** allocating a new one so we don't have to have space for
685   ** both at the same time.
686   */
687   if( db->lookaside.bMalloced ){
688     sqlite3_free(db->lookaside.pStart);
689   }
690   /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
691   ** than a pointer to be useful.
692   */
693   sz = ROUNDDOWN8(sz);  /* IMP: R-33038-09382 */
694   if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
695   if( cnt<0 ) cnt = 0;
696   if( sz==0 || cnt==0 ){
697     sz = 0;
698     pStart = 0;
699   }else if( pBuf==0 ){
700     sqlite3BeginBenignMalloc();
701     pStart = sqlite3Malloc( sz*cnt );  /* IMP: R-61949-35727 */
702     sqlite3EndBenignMalloc();
703     if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
704   }else{
705     pStart = pBuf;
706   }
707   db->lookaside.pStart = pStart;
708   db->lookaside.pInit = 0;
709   db->lookaside.pFree = 0;
710   db->lookaside.sz = (u16)sz;
711   if( pStart ){
712     int i;
713     LookasideSlot *p;
714     assert( sz > (int)sizeof(LookasideSlot*) );
715     db->lookaside.nSlot = cnt;
716     p = (LookasideSlot*)pStart;
717     for(i=cnt-1; i>=0; i--){
718       p->pNext = db->lookaside.pInit;
719       db->lookaside.pInit = p;
720       p = (LookasideSlot*)&((u8*)p)[sz];
721     }
722     db->lookaside.pEnd = p;
723     db->lookaside.bDisable = 0;
724     db->lookaside.bMalloced = pBuf==0 ?1:0;
725   }else{
726     db->lookaside.pStart = db;
727     db->lookaside.pEnd = db;
728     db->lookaside.bDisable = 1;
729     db->lookaside.bMalloced = 0;
730     db->lookaside.nSlot = 0;
731   }
732 #endif /* SQLITE_OMIT_LOOKASIDE */
733   return SQLITE_OK;
734 }
735 
736 /*
737 ** Return the mutex associated with a database connection.
738 */
739 sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
740 #ifdef SQLITE_ENABLE_API_ARMOR
741   if( !sqlite3SafetyCheckOk(db) ){
742     (void)SQLITE_MISUSE_BKPT;
743     return 0;
744   }
745 #endif
746   return db->mutex;
747 }
748 
749 /*
750 ** Free up as much memory as we can from the given database
751 ** connection.
752 */
753 int sqlite3_db_release_memory(sqlite3 *db){
754   int i;
755 
756 #ifdef SQLITE_ENABLE_API_ARMOR
757   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
758 #endif
759   sqlite3_mutex_enter(db->mutex);
760   sqlite3BtreeEnterAll(db);
761   for(i=0; i<db->nDb; i++){
762     Btree *pBt = db->aDb[i].pBt;
763     if( pBt ){
764       Pager *pPager = sqlite3BtreePager(pBt);
765       sqlite3PagerShrink(pPager);
766     }
767   }
768   sqlite3BtreeLeaveAll(db);
769   sqlite3_mutex_leave(db->mutex);
770   return SQLITE_OK;
771 }
772 
773 /*
774 ** Flush any dirty pages in the pager-cache for any attached database
775 ** to disk.
776 */
777 int sqlite3_db_cacheflush(sqlite3 *db){
778   int i;
779   int rc = SQLITE_OK;
780   int bSeenBusy = 0;
781 
782 #ifdef SQLITE_ENABLE_API_ARMOR
783   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
784 #endif
785   sqlite3_mutex_enter(db->mutex);
786   sqlite3BtreeEnterAll(db);
787   for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
788     Btree *pBt = db->aDb[i].pBt;
789     if( pBt && sqlite3BtreeIsInTrans(pBt) ){
790       Pager *pPager = sqlite3BtreePager(pBt);
791       rc = sqlite3PagerFlush(pPager);
792       if( rc==SQLITE_BUSY ){
793         bSeenBusy = 1;
794         rc = SQLITE_OK;
795       }
796     }
797   }
798   sqlite3BtreeLeaveAll(db);
799   sqlite3_mutex_leave(db->mutex);
800   return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
801 }
802 
803 /*
804 ** Configuration settings for an individual database connection
805 */
806 int sqlite3_db_config(sqlite3 *db, int op, ...){
807   va_list ap;
808   int rc;
809   va_start(ap, op);
810   switch( op ){
811     case SQLITE_DBCONFIG_MAINDBNAME: {
812       /* IMP: R-06824-28531 */
813       /* IMP: R-36257-52125 */
814       db->aDb[0].zDbSName = va_arg(ap,char*);
815       rc = SQLITE_OK;
816       break;
817     }
818     case SQLITE_DBCONFIG_LOOKASIDE: {
819       void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
820       int sz = va_arg(ap, int);       /* IMP: R-47871-25994 */
821       int cnt = va_arg(ap, int);      /* IMP: R-04460-53386 */
822       rc = setupLookaside(db, pBuf, sz, cnt);
823       break;
824     }
825     default: {
826       static const struct {
827         int op;      /* The opcode */
828         u32 mask;    /* Mask of the bit in sqlite3.flags to set/clear */
829       } aFlagOp[] = {
830         { SQLITE_DBCONFIG_ENABLE_FKEY,           SQLITE_ForeignKeys    },
831         { SQLITE_DBCONFIG_ENABLE_TRIGGER,        SQLITE_EnableTrigger  },
832         { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer  },
833         { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension  },
834         { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE,      SQLITE_NoCkptOnClose  },
835         { SQLITE_DBCONFIG_ENABLE_QPSG,           SQLITE_EnableQPSG     },
836         { SQLITE_DBCONFIG_TRIGGER_EQP,           SQLITE_TriggerEQP     },
837         { SQLITE_DBCONFIG_RESET_DATABASE,        SQLITE_ResetDatabase  },
838         { SQLITE_DBCONFIG_DEFENSIVE,             SQLITE_Defensive      },
839       };
840       unsigned int i;
841       rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
842       for(i=0; i<ArraySize(aFlagOp); i++){
843         if( aFlagOp[i].op==op ){
844           int onoff = va_arg(ap, int);
845           int *pRes = va_arg(ap, int*);
846           u64 oldFlags = db->flags;
847           if( onoff>0 ){
848             db->flags |= aFlagOp[i].mask;
849           }else if( onoff==0 ){
850             db->flags &= ~(u64)aFlagOp[i].mask;
851           }
852           if( oldFlags!=db->flags ){
853             sqlite3ExpirePreparedStatements(db, 0);
854           }
855           if( pRes ){
856             *pRes = (db->flags & aFlagOp[i].mask)!=0;
857           }
858           rc = SQLITE_OK;
859           break;
860         }
861       }
862       break;
863     }
864   }
865   va_end(ap);
866   return rc;
867 }
868 
869 
870 /*
871 ** Return true if the buffer z[0..n-1] contains all spaces.
872 */
873 static int allSpaces(const char *z, int n){
874   while( n>0 && z[n-1]==' ' ){ n--; }
875   return n==0;
876 }
877 
878 /*
879 ** This is the default collating function named "BINARY" which is always
880 ** available.
881 **
882 ** If the padFlag argument is not NULL then space padding at the end
883 ** of strings is ignored.  This implements the RTRIM collation.
884 */
885 static int binCollFunc(
886   void *padFlag,
887   int nKey1, const void *pKey1,
888   int nKey2, const void *pKey2
889 ){
890   int rc, n;
891   n = nKey1<nKey2 ? nKey1 : nKey2;
892   /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
893   ** strings byte by byte using the memcmp() function from the standard C
894   ** library. */
895   assert( pKey1 && pKey2 );
896   rc = memcmp(pKey1, pKey2, n);
897   if( rc==0 ){
898     if( padFlag
899      && allSpaces(((char*)pKey1)+n, nKey1-n)
900      && allSpaces(((char*)pKey2)+n, nKey2-n)
901     ){
902       /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
903       ** spaces at the end of either string do not change the result. In other
904       ** words, strings will compare equal to one another as long as they
905       ** differ only in the number of spaces at the end.
906       */
907     }else{
908       rc = nKey1 - nKey2;
909     }
910   }
911   return rc;
912 }
913 
914 /*
915 ** Return true if CollSeq is the default built-in BINARY.
916 */
917 int sqlite3IsBinary(const CollSeq *p){
918   assert( p==0 || p->xCmp!=binCollFunc || p->pUser!=0
919             || strcmp(p->zName,"BINARY")==0 );
920   return p==0 || (p->xCmp==binCollFunc && p->pUser==0);
921 }
922 
923 /*
924 ** Another built-in collating sequence: NOCASE.
925 **
926 ** This collating sequence is intended to be used for "case independent
927 ** comparison". SQLite's knowledge of upper and lower case equivalents
928 ** extends only to the 26 characters used in the English language.
929 **
930 ** At the moment there is only a UTF-8 implementation.
931 */
932 static int nocaseCollatingFunc(
933   void *NotUsed,
934   int nKey1, const void *pKey1,
935   int nKey2, const void *pKey2
936 ){
937   int r = sqlite3StrNICmp(
938       (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
939   UNUSED_PARAMETER(NotUsed);
940   if( 0==r ){
941     r = nKey1-nKey2;
942   }
943   return r;
944 }
945 
946 /*
947 ** Return the ROWID of the most recent insert
948 */
949 sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
950 #ifdef SQLITE_ENABLE_API_ARMOR
951   if( !sqlite3SafetyCheckOk(db) ){
952     (void)SQLITE_MISUSE_BKPT;
953     return 0;
954   }
955 #endif
956   return db->lastRowid;
957 }
958 
959 /*
960 ** Set the value returned by the sqlite3_last_insert_rowid() API function.
961 */
962 void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
963 #ifdef SQLITE_ENABLE_API_ARMOR
964   if( !sqlite3SafetyCheckOk(db) ){
965     (void)SQLITE_MISUSE_BKPT;
966     return;
967   }
968 #endif
969   sqlite3_mutex_enter(db->mutex);
970   db->lastRowid = iRowid;
971   sqlite3_mutex_leave(db->mutex);
972 }
973 
974 /*
975 ** Return the number of changes in the most recent call to sqlite3_exec().
976 */
977 int sqlite3_changes(sqlite3 *db){
978 #ifdef SQLITE_ENABLE_API_ARMOR
979   if( !sqlite3SafetyCheckOk(db) ){
980     (void)SQLITE_MISUSE_BKPT;
981     return 0;
982   }
983 #endif
984   return db->nChange;
985 }
986 
987 /*
988 ** Return the number of changes since the database handle was opened.
989 */
990 int sqlite3_total_changes(sqlite3 *db){
991 #ifdef SQLITE_ENABLE_API_ARMOR
992   if( !sqlite3SafetyCheckOk(db) ){
993     (void)SQLITE_MISUSE_BKPT;
994     return 0;
995   }
996 #endif
997   return db->nTotalChange;
998 }
999 
1000 /*
1001 ** Close all open savepoints. This function only manipulates fields of the
1002 ** database handle object, it does not close any savepoints that may be open
1003 ** at the b-tree/pager level.
1004 */
1005 void sqlite3CloseSavepoints(sqlite3 *db){
1006   while( db->pSavepoint ){
1007     Savepoint *pTmp = db->pSavepoint;
1008     db->pSavepoint = pTmp->pNext;
1009     sqlite3DbFree(db, pTmp);
1010   }
1011   db->nSavepoint = 0;
1012   db->nStatement = 0;
1013   db->isTransactionSavepoint = 0;
1014 }
1015 
1016 /*
1017 ** Invoke the destructor function associated with FuncDef p, if any. Except,
1018 ** if this is not the last copy of the function, do not invoke it. Multiple
1019 ** copies of a single function are created when create_function() is called
1020 ** with SQLITE_ANY as the encoding.
1021 */
1022 static void functionDestroy(sqlite3 *db, FuncDef *p){
1023   FuncDestructor *pDestructor = p->u.pDestructor;
1024   if( pDestructor ){
1025     pDestructor->nRef--;
1026     if( pDestructor->nRef==0 ){
1027       pDestructor->xDestroy(pDestructor->pUserData);
1028       sqlite3DbFree(db, pDestructor);
1029     }
1030   }
1031 }
1032 
1033 /*
1034 ** Disconnect all sqlite3_vtab objects that belong to database connection
1035 ** db. This is called when db is being closed.
1036 */
1037 static void disconnectAllVtab(sqlite3 *db){
1038 #ifndef SQLITE_OMIT_VIRTUALTABLE
1039   int i;
1040   HashElem *p;
1041   sqlite3BtreeEnterAll(db);
1042   for(i=0; i<db->nDb; i++){
1043     Schema *pSchema = db->aDb[i].pSchema;
1044     if( pSchema ){
1045       for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1046         Table *pTab = (Table *)sqliteHashData(p);
1047         if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1048       }
1049     }
1050   }
1051   for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1052     Module *pMod = (Module *)sqliteHashData(p);
1053     if( pMod->pEpoTab ){
1054       sqlite3VtabDisconnect(db, pMod->pEpoTab);
1055     }
1056   }
1057   sqlite3VtabUnlockList(db);
1058   sqlite3BtreeLeaveAll(db);
1059 #else
1060   UNUSED_PARAMETER(db);
1061 #endif
1062 }
1063 
1064 /*
1065 ** Return TRUE if database connection db has unfinalized prepared
1066 ** statements or unfinished sqlite3_backup objects.
1067 */
1068 static int connectionIsBusy(sqlite3 *db){
1069   int j;
1070   assert( sqlite3_mutex_held(db->mutex) );
1071   if( db->pVdbe ) return 1;
1072   for(j=0; j<db->nDb; j++){
1073     Btree *pBt = db->aDb[j].pBt;
1074     if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1075   }
1076   return 0;
1077 }
1078 
1079 /*
1080 ** Close an existing SQLite database
1081 */
1082 static int sqlite3Close(sqlite3 *db, int forceZombie){
1083   if( !db ){
1084     /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1085     ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
1086     return SQLITE_OK;
1087   }
1088   if( !sqlite3SafetyCheckSickOrOk(db) ){
1089     return SQLITE_MISUSE_BKPT;
1090   }
1091   sqlite3_mutex_enter(db->mutex);
1092   if( db->mTrace & SQLITE_TRACE_CLOSE ){
1093     db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1094   }
1095 
1096   /* Force xDisconnect calls on all virtual tables */
1097   disconnectAllVtab(db);
1098 
1099   /* If a transaction is open, the disconnectAllVtab() call above
1100   ** will not have called the xDisconnect() method on any virtual
1101   ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1102   ** call will do so. We need to do this before the check for active
1103   ** SQL statements below, as the v-table implementation may be storing
1104   ** some prepared statements internally.
1105   */
1106   sqlite3VtabRollback(db);
1107 
1108   /* Legacy behavior (sqlite3_close() behavior) is to return
1109   ** SQLITE_BUSY if the connection can not be closed immediately.
1110   */
1111   if( !forceZombie && connectionIsBusy(db) ){
1112     sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
1113        "statements or unfinished backups");
1114     sqlite3_mutex_leave(db->mutex);
1115     return SQLITE_BUSY;
1116   }
1117 
1118 #ifdef SQLITE_ENABLE_SQLLOG
1119   if( sqlite3GlobalConfig.xSqllog ){
1120     /* Closing the handle. Fourth parameter is passed the value 2. */
1121     sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
1122   }
1123 #endif
1124 
1125   /* Convert the connection into a zombie and then close it.
1126   */
1127   db->magic = SQLITE_MAGIC_ZOMBIE;
1128   sqlite3LeaveMutexAndCloseZombie(db);
1129   return SQLITE_OK;
1130 }
1131 
1132 /*
1133 ** Two variations on the public interface for closing a database
1134 ** connection. The sqlite3_close() version returns SQLITE_BUSY and
1135 ** leaves the connection option if there are unfinalized prepared
1136 ** statements or unfinished sqlite3_backups.  The sqlite3_close_v2()
1137 ** version forces the connection to become a zombie if there are
1138 ** unclosed resources, and arranges for deallocation when the last
1139 ** prepare statement or sqlite3_backup closes.
1140 */
1141 int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1142 int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1143 
1144 
1145 /*
1146 ** Close the mutex on database connection db.
1147 **
1148 ** Furthermore, if database connection db is a zombie (meaning that there
1149 ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1150 ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1151 ** finished, then free all resources.
1152 */
1153 void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1154   HashElem *i;                    /* Hash table iterator */
1155   int j;
1156 
1157   /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
1158   ** or if the connection has not yet been closed by sqlite3_close_v2(),
1159   ** then just leave the mutex and return.
1160   */
1161   if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
1162     sqlite3_mutex_leave(db->mutex);
1163     return;
1164   }
1165 
1166   /* If we reach this point, it means that the database connection has
1167   ** closed all sqlite3_stmt and sqlite3_backup objects and has been
1168   ** passed to sqlite3_close (meaning that it is a zombie).  Therefore,
1169   ** go ahead and free all resources.
1170   */
1171 
1172   /* If a transaction is open, roll it back. This also ensures that if
1173   ** any database schemas have been modified by an uncommitted transaction
1174   ** they are reset. And that the required b-tree mutex is held to make
1175   ** the pager rollback and schema reset an atomic operation. */
1176   sqlite3RollbackAll(db, SQLITE_OK);
1177 
1178   /* Free any outstanding Savepoint structures. */
1179   sqlite3CloseSavepoints(db);
1180 
1181   /* Close all database connections */
1182   for(j=0; j<db->nDb; j++){
1183     struct Db *pDb = &db->aDb[j];
1184     if( pDb->pBt ){
1185       sqlite3BtreeClose(pDb->pBt);
1186       pDb->pBt = 0;
1187       if( j!=1 ){
1188         pDb->pSchema = 0;
1189       }
1190     }
1191   }
1192   /* Clear the TEMP schema separately and last */
1193   if( db->aDb[1].pSchema ){
1194     sqlite3SchemaClear(db->aDb[1].pSchema);
1195   }
1196   sqlite3VtabUnlockList(db);
1197 
1198   /* Free up the array of auxiliary databases */
1199   sqlite3CollapseDatabaseArray(db);
1200   assert( db->nDb<=2 );
1201   assert( db->aDb==db->aDbStatic );
1202 
1203   /* Tell the code in notify.c that the connection no longer holds any
1204   ** locks and does not require any further unlock-notify callbacks.
1205   */
1206   sqlite3ConnectionClosed(db);
1207 
1208   for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1209     FuncDef *pNext, *p;
1210     p = sqliteHashData(i);
1211     do{
1212       functionDestroy(db, p);
1213       pNext = p->pNext;
1214       sqlite3DbFree(db, p);
1215       p = pNext;
1216     }while( p );
1217   }
1218   sqlite3HashClear(&db->aFunc);
1219   for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
1220     CollSeq *pColl = (CollSeq *)sqliteHashData(i);
1221     /* Invoke any destructors registered for collation sequence user data. */
1222     for(j=0; j<3; j++){
1223       if( pColl[j].xDel ){
1224         pColl[j].xDel(pColl[j].pUser);
1225       }
1226     }
1227     sqlite3DbFree(db, pColl);
1228   }
1229   sqlite3HashClear(&db->aCollSeq);
1230 #ifndef SQLITE_OMIT_VIRTUALTABLE
1231   for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1232     Module *pMod = (Module *)sqliteHashData(i);
1233     if( pMod->xDestroy ){
1234       pMod->xDestroy(pMod->pAux);
1235     }
1236     sqlite3VtabEponymousTableClear(db, pMod);
1237     sqlite3DbFree(db, pMod);
1238   }
1239   sqlite3HashClear(&db->aModule);
1240 #endif
1241 
1242   sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
1243   sqlite3ValueFree(db->pErr);
1244   sqlite3CloseExtensions(db);
1245 #if SQLITE_USER_AUTHENTICATION
1246   sqlite3_free(db->auth.zAuthUser);
1247   sqlite3_free(db->auth.zAuthPW);
1248 #endif
1249 
1250   db->magic = SQLITE_MAGIC_ERROR;
1251 
1252   /* The temp-database schema is allocated differently from the other schema
1253   ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1254   ** So it needs to be freed here. Todo: Why not roll the temp schema into
1255   ** the same sqliteMalloc() as the one that allocates the database
1256   ** structure?
1257   */
1258   sqlite3DbFree(db, db->aDb[1].pSchema);
1259   sqlite3_mutex_leave(db->mutex);
1260   db->magic = SQLITE_MAGIC_CLOSED;
1261   sqlite3_mutex_free(db->mutex);
1262   assert( sqlite3LookasideUsed(db,0)==0 );
1263   if( db->lookaside.bMalloced ){
1264     sqlite3_free(db->lookaside.pStart);
1265   }
1266   sqlite3_free(db);
1267 }
1268 
1269 /*
1270 ** Rollback all database files.  If tripCode is not SQLITE_OK, then
1271 ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
1272 ** breaker") and made to return tripCode if there are any further
1273 ** attempts to use that cursor.  Read cursors remain open and valid
1274 ** but are "saved" in case the table pages are moved around.
1275 */
1276 void sqlite3RollbackAll(sqlite3 *db, int tripCode){
1277   int i;
1278   int inTrans = 0;
1279   int schemaChange;
1280   assert( sqlite3_mutex_held(db->mutex) );
1281   sqlite3BeginBenignMalloc();
1282 
1283   /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1284   ** This is important in case the transaction being rolled back has
1285   ** modified the database schema. If the b-tree mutexes are not taken
1286   ** here, then another shared-cache connection might sneak in between
1287   ** the database rollback and schema reset, which can cause false
1288   ** corruption reports in some cases.  */
1289   sqlite3BtreeEnterAll(db);
1290   schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
1291 
1292   for(i=0; i<db->nDb; i++){
1293     Btree *p = db->aDb[i].pBt;
1294     if( p ){
1295       if( sqlite3BtreeIsInTrans(p) ){
1296         inTrans = 1;
1297       }
1298       sqlite3BtreeRollback(p, tripCode, !schemaChange);
1299     }
1300   }
1301   sqlite3VtabRollback(db);
1302   sqlite3EndBenignMalloc();
1303 
1304   if( schemaChange ){
1305     sqlite3ExpirePreparedStatements(db, 0);
1306     sqlite3ResetAllSchemasOfConnection(db);
1307   }
1308   sqlite3BtreeLeaveAll(db);
1309 
1310   /* Any deferred constraint violations have now been resolved. */
1311   db->nDeferredCons = 0;
1312   db->nDeferredImmCons = 0;
1313   db->flags &= ~(u64)SQLITE_DeferFKs;
1314 
1315   /* If one has been configured, invoke the rollback-hook callback */
1316   if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
1317     db->xRollbackCallback(db->pRollbackArg);
1318   }
1319 }
1320 
1321 /*
1322 ** Return a static string containing the name corresponding to the error code
1323 ** specified in the argument.
1324 */
1325 #if defined(SQLITE_NEED_ERR_NAME)
1326 const char *sqlite3ErrName(int rc){
1327   const char *zName = 0;
1328   int i, origRc = rc;
1329   for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1330     switch( rc ){
1331       case SQLITE_OK:                 zName = "SQLITE_OK";                break;
1332       case SQLITE_ERROR:              zName = "SQLITE_ERROR";             break;
1333       case SQLITE_ERROR_SNAPSHOT:     zName = "SQLITE_ERROR_SNAPSHOT";    break;
1334       case SQLITE_INTERNAL:           zName = "SQLITE_INTERNAL";          break;
1335       case SQLITE_PERM:               zName = "SQLITE_PERM";              break;
1336       case SQLITE_ABORT:              zName = "SQLITE_ABORT";             break;
1337       case SQLITE_ABORT_ROLLBACK:     zName = "SQLITE_ABORT_ROLLBACK";    break;
1338       case SQLITE_BUSY:               zName = "SQLITE_BUSY";              break;
1339       case SQLITE_BUSY_RECOVERY:      zName = "SQLITE_BUSY_RECOVERY";     break;
1340       case SQLITE_BUSY_SNAPSHOT:      zName = "SQLITE_BUSY_SNAPSHOT";     break;
1341       case SQLITE_LOCKED:             zName = "SQLITE_LOCKED";            break;
1342       case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1343       case SQLITE_NOMEM:              zName = "SQLITE_NOMEM";             break;
1344       case SQLITE_READONLY:           zName = "SQLITE_READONLY";          break;
1345       case SQLITE_READONLY_RECOVERY:  zName = "SQLITE_READONLY_RECOVERY"; break;
1346       case SQLITE_READONLY_CANTINIT:  zName = "SQLITE_READONLY_CANTINIT"; break;
1347       case SQLITE_READONLY_ROLLBACK:  zName = "SQLITE_READONLY_ROLLBACK"; break;
1348       case SQLITE_READONLY_DBMOVED:   zName = "SQLITE_READONLY_DBMOVED";  break;
1349       case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
1350       case SQLITE_INTERRUPT:          zName = "SQLITE_INTERRUPT";         break;
1351       case SQLITE_IOERR:              zName = "SQLITE_IOERR";             break;
1352       case SQLITE_IOERR_READ:         zName = "SQLITE_IOERR_READ";        break;
1353       case SQLITE_IOERR_SHORT_READ:   zName = "SQLITE_IOERR_SHORT_READ";  break;
1354       case SQLITE_IOERR_WRITE:        zName = "SQLITE_IOERR_WRITE";       break;
1355       case SQLITE_IOERR_FSYNC:        zName = "SQLITE_IOERR_FSYNC";       break;
1356       case SQLITE_IOERR_DIR_FSYNC:    zName = "SQLITE_IOERR_DIR_FSYNC";   break;
1357       case SQLITE_IOERR_TRUNCATE:     zName = "SQLITE_IOERR_TRUNCATE";    break;
1358       case SQLITE_IOERR_FSTAT:        zName = "SQLITE_IOERR_FSTAT";       break;
1359       case SQLITE_IOERR_UNLOCK:       zName = "SQLITE_IOERR_UNLOCK";      break;
1360       case SQLITE_IOERR_RDLOCK:       zName = "SQLITE_IOERR_RDLOCK";      break;
1361       case SQLITE_IOERR_DELETE:       zName = "SQLITE_IOERR_DELETE";      break;
1362       case SQLITE_IOERR_NOMEM:        zName = "SQLITE_IOERR_NOMEM";       break;
1363       case SQLITE_IOERR_ACCESS:       zName = "SQLITE_IOERR_ACCESS";      break;
1364       case SQLITE_IOERR_CHECKRESERVEDLOCK:
1365                                 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1366       case SQLITE_IOERR_LOCK:         zName = "SQLITE_IOERR_LOCK";        break;
1367       case SQLITE_IOERR_CLOSE:        zName = "SQLITE_IOERR_CLOSE";       break;
1368       case SQLITE_IOERR_DIR_CLOSE:    zName = "SQLITE_IOERR_DIR_CLOSE";   break;
1369       case SQLITE_IOERR_SHMOPEN:      zName = "SQLITE_IOERR_SHMOPEN";     break;
1370       case SQLITE_IOERR_SHMSIZE:      zName = "SQLITE_IOERR_SHMSIZE";     break;
1371       case SQLITE_IOERR_SHMLOCK:      zName = "SQLITE_IOERR_SHMLOCK";     break;
1372       case SQLITE_IOERR_SHMMAP:       zName = "SQLITE_IOERR_SHMMAP";      break;
1373       case SQLITE_IOERR_SEEK:         zName = "SQLITE_IOERR_SEEK";        break;
1374       case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1375       case SQLITE_IOERR_MMAP:         zName = "SQLITE_IOERR_MMAP";        break;
1376       case SQLITE_IOERR_GETTEMPPATH:  zName = "SQLITE_IOERR_GETTEMPPATH"; break;
1377       case SQLITE_IOERR_CONVPATH:     zName = "SQLITE_IOERR_CONVPATH";    break;
1378       case SQLITE_CORRUPT:            zName = "SQLITE_CORRUPT";           break;
1379       case SQLITE_CORRUPT_VTAB:       zName = "SQLITE_CORRUPT_VTAB";      break;
1380       case SQLITE_NOTFOUND:           zName = "SQLITE_NOTFOUND";          break;
1381       case SQLITE_FULL:               zName = "SQLITE_FULL";              break;
1382       case SQLITE_CANTOPEN:           zName = "SQLITE_CANTOPEN";          break;
1383       case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1384       case SQLITE_CANTOPEN_ISDIR:     zName = "SQLITE_CANTOPEN_ISDIR";    break;
1385       case SQLITE_CANTOPEN_FULLPATH:  zName = "SQLITE_CANTOPEN_FULLPATH"; break;
1386       case SQLITE_CANTOPEN_CONVPATH:  zName = "SQLITE_CANTOPEN_CONVPATH"; break;
1387       case SQLITE_PROTOCOL:           zName = "SQLITE_PROTOCOL";          break;
1388       case SQLITE_EMPTY:              zName = "SQLITE_EMPTY";             break;
1389       case SQLITE_SCHEMA:             zName = "SQLITE_SCHEMA";            break;
1390       case SQLITE_TOOBIG:             zName = "SQLITE_TOOBIG";            break;
1391       case SQLITE_CONSTRAINT:         zName = "SQLITE_CONSTRAINT";        break;
1392       case SQLITE_CONSTRAINT_UNIQUE:  zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1393       case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1394       case SQLITE_CONSTRAINT_FOREIGNKEY:
1395                                 zName = "SQLITE_CONSTRAINT_FOREIGNKEY";   break;
1396       case SQLITE_CONSTRAINT_CHECK:   zName = "SQLITE_CONSTRAINT_CHECK";  break;
1397       case SQLITE_CONSTRAINT_PRIMARYKEY:
1398                                 zName = "SQLITE_CONSTRAINT_PRIMARYKEY";   break;
1399       case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1400       case SQLITE_CONSTRAINT_COMMITHOOK:
1401                                 zName = "SQLITE_CONSTRAINT_COMMITHOOK";   break;
1402       case SQLITE_CONSTRAINT_VTAB:    zName = "SQLITE_CONSTRAINT_VTAB";   break;
1403       case SQLITE_CONSTRAINT_FUNCTION:
1404                                 zName = "SQLITE_CONSTRAINT_FUNCTION";     break;
1405       case SQLITE_CONSTRAINT_ROWID:   zName = "SQLITE_CONSTRAINT_ROWID";  break;
1406       case SQLITE_MISMATCH:           zName = "SQLITE_MISMATCH";          break;
1407       case SQLITE_MISUSE:             zName = "SQLITE_MISUSE";            break;
1408       case SQLITE_NOLFS:              zName = "SQLITE_NOLFS";             break;
1409       case SQLITE_AUTH:               zName = "SQLITE_AUTH";              break;
1410       case SQLITE_FORMAT:             zName = "SQLITE_FORMAT";            break;
1411       case SQLITE_RANGE:              zName = "SQLITE_RANGE";             break;
1412       case SQLITE_NOTADB:             zName = "SQLITE_NOTADB";            break;
1413       case SQLITE_ROW:                zName = "SQLITE_ROW";               break;
1414       case SQLITE_NOTICE:             zName = "SQLITE_NOTICE";            break;
1415       case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1416       case SQLITE_NOTICE_RECOVER_ROLLBACK:
1417                                 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
1418       case SQLITE_WARNING:            zName = "SQLITE_WARNING";           break;
1419       case SQLITE_WARNING_AUTOINDEX:  zName = "SQLITE_WARNING_AUTOINDEX"; break;
1420       case SQLITE_DONE:               zName = "SQLITE_DONE";              break;
1421     }
1422   }
1423   if( zName==0 ){
1424     static char zBuf[50];
1425     sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1426     zName = zBuf;
1427   }
1428   return zName;
1429 }
1430 #endif
1431 
1432 /*
1433 ** Return a static string that describes the kind of error specified in the
1434 ** argument.
1435 */
1436 const char *sqlite3ErrStr(int rc){
1437   static const char* const aMsg[] = {
1438     /* SQLITE_OK          */ "not an error",
1439     /* SQLITE_ERROR       */ "SQL logic error",
1440     /* SQLITE_INTERNAL    */ 0,
1441     /* SQLITE_PERM        */ "access permission denied",
1442     /* SQLITE_ABORT       */ "query aborted",
1443     /* SQLITE_BUSY        */ "database is locked",
1444     /* SQLITE_LOCKED      */ "database table is locked",
1445     /* SQLITE_NOMEM       */ "out of memory",
1446     /* SQLITE_READONLY    */ "attempt to write a readonly database",
1447     /* SQLITE_INTERRUPT   */ "interrupted",
1448     /* SQLITE_IOERR       */ "disk I/O error",
1449     /* SQLITE_CORRUPT     */ "database disk image is malformed",
1450     /* SQLITE_NOTFOUND    */ "unknown operation",
1451     /* SQLITE_FULL        */ "database or disk is full",
1452     /* SQLITE_CANTOPEN    */ "unable to open database file",
1453     /* SQLITE_PROTOCOL    */ "locking protocol",
1454     /* SQLITE_EMPTY       */ 0,
1455     /* SQLITE_SCHEMA      */ "database schema has changed",
1456     /* SQLITE_TOOBIG      */ "string or blob too big",
1457     /* SQLITE_CONSTRAINT  */ "constraint failed",
1458     /* SQLITE_MISMATCH    */ "datatype mismatch",
1459     /* SQLITE_MISUSE      */ "bad parameter or other API misuse",
1460 #ifdef SQLITE_DISABLE_LFS
1461     /* SQLITE_NOLFS       */ "large file support is disabled",
1462 #else
1463     /* SQLITE_NOLFS       */ 0,
1464 #endif
1465     /* SQLITE_AUTH        */ "authorization denied",
1466     /* SQLITE_FORMAT      */ 0,
1467     /* SQLITE_RANGE       */ "column index out of range",
1468     /* SQLITE_NOTADB      */ "file is not a database",
1469     /* SQLITE_NOTICE      */ "notification message",
1470     /* SQLITE_WARNING     */ "warning message",
1471   };
1472   const char *zErr = "unknown error";
1473   switch( rc ){
1474     case SQLITE_ABORT_ROLLBACK: {
1475       zErr = "abort due to ROLLBACK";
1476       break;
1477     }
1478     case SQLITE_ROW: {
1479       zErr = "another row available";
1480       break;
1481     }
1482     case SQLITE_DONE: {
1483       zErr = "no more rows available";
1484       break;
1485     }
1486     default: {
1487       rc &= 0xff;
1488       if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1489         zErr = aMsg[rc];
1490       }
1491       break;
1492     }
1493   }
1494   return zErr;
1495 }
1496 
1497 /*
1498 ** This routine implements a busy callback that sleeps and tries
1499 ** again until a timeout value is reached.  The timeout value is
1500 ** an integer number of milliseconds passed in as the first
1501 ** argument.
1502 **
1503 ** Return non-zero to retry the lock.  Return zero to stop trying
1504 ** and cause SQLite to return SQLITE_BUSY.
1505 */
1506 static int sqliteDefaultBusyCallback(
1507   void *ptr,               /* Database connection */
1508   int count,               /* Number of times table has been busy */
1509   sqlite3_file *pFile      /* The file on which the lock occurred */
1510 ){
1511 #if SQLITE_OS_WIN || HAVE_USLEEP
1512   /* This case is for systems that have support for sleeping for fractions of
1513   ** a second.  Examples:  All windows systems, unix systems with usleep() */
1514   static const u8 delays[] =
1515      { 1, 2, 5, 10, 15, 20, 25, 25,  25,  50,  50, 100 };
1516   static const u8 totals[] =
1517      { 0, 1, 3,  8, 18, 33, 53, 78, 103, 128, 178, 228 };
1518 # define NDELAY ArraySize(delays)
1519   sqlite3 *db = (sqlite3 *)ptr;
1520   int tmout = db->busyTimeout;
1521   int delay, prior;
1522 
1523 #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1524   if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
1525     if( count ){
1526       tmout = 0;
1527       sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
1528       return 0;
1529     }else{
1530       return 1;
1531     }
1532   }
1533 #else
1534   UNUSED_PARAMETER(pFile);
1535 #endif
1536   assert( count>=0 );
1537   if( count < NDELAY ){
1538     delay = delays[count];
1539     prior = totals[count];
1540   }else{
1541     delay = delays[NDELAY-1];
1542     prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
1543   }
1544   if( prior + delay > tmout ){
1545     delay = tmout - prior;
1546     if( delay<=0 ) return 0;
1547   }
1548   sqlite3OsSleep(db->pVfs, delay*1000);
1549   return 1;
1550 #else
1551   /* This case for unix systems that lack usleep() support.  Sleeping
1552   ** must be done in increments of whole seconds */
1553   sqlite3 *db = (sqlite3 *)ptr;
1554   int tmout = ((sqlite3 *)ptr)->busyTimeout;
1555   UNUSED_PARAMETER(pFile);
1556   if( (count+1)*1000 > tmout ){
1557     return 0;
1558   }
1559   sqlite3OsSleep(db->pVfs, 1000000);
1560   return 1;
1561 #endif
1562 }
1563 
1564 /*
1565 ** Invoke the given busy handler.
1566 **
1567 ** This routine is called when an operation failed to acquire a
1568 ** lock on VFS file pFile.
1569 **
1570 ** If this routine returns non-zero, the lock is retried.  If it
1571 ** returns 0, the operation aborts with an SQLITE_BUSY error.
1572 */
1573 int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
1574   int rc;
1575   if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
1576   if( p->bExtraFileArg ){
1577     /* Add an extra parameter with the pFile pointer to the end of the
1578     ** callback argument list */
1579     int (*xTra)(void*,int,sqlite3_file*);
1580     xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
1581     rc = xTra(p->pBusyArg, p->nBusy, pFile);
1582   }else{
1583     /* Legacy style busy handler callback */
1584     rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1585   }
1586   if( rc==0 ){
1587     p->nBusy = -1;
1588   }else{
1589     p->nBusy++;
1590   }
1591   return rc;
1592 }
1593 
1594 /*
1595 ** This routine sets the busy callback for an Sqlite database to the
1596 ** given callback function with the given argument.
1597 */
1598 int sqlite3_busy_handler(
1599   sqlite3 *db,
1600   int (*xBusy)(void*,int),
1601   void *pArg
1602 ){
1603 #ifdef SQLITE_ENABLE_API_ARMOR
1604   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1605 #endif
1606   sqlite3_mutex_enter(db->mutex);
1607   db->busyHandler.xBusyHandler = xBusy;
1608   db->busyHandler.pBusyArg = pArg;
1609   db->busyHandler.nBusy = 0;
1610   db->busyHandler.bExtraFileArg = 0;
1611   db->busyTimeout = 0;
1612   sqlite3_mutex_leave(db->mutex);
1613   return SQLITE_OK;
1614 }
1615 
1616 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1617 /*
1618 ** This routine sets the progress callback for an Sqlite database to the
1619 ** given callback function with the given argument. The progress callback will
1620 ** be invoked every nOps opcodes.
1621 */
1622 void sqlite3_progress_handler(
1623   sqlite3 *db,
1624   int nOps,
1625   int (*xProgress)(void*),
1626   void *pArg
1627 ){
1628 #ifdef SQLITE_ENABLE_API_ARMOR
1629   if( !sqlite3SafetyCheckOk(db) ){
1630     (void)SQLITE_MISUSE_BKPT;
1631     return;
1632   }
1633 #endif
1634   sqlite3_mutex_enter(db->mutex);
1635   if( nOps>0 ){
1636     db->xProgress = xProgress;
1637     db->nProgressOps = (unsigned)nOps;
1638     db->pProgressArg = pArg;
1639   }else{
1640     db->xProgress = 0;
1641     db->nProgressOps = 0;
1642     db->pProgressArg = 0;
1643   }
1644   sqlite3_mutex_leave(db->mutex);
1645 }
1646 #endif
1647 
1648 
1649 /*
1650 ** This routine installs a default busy handler that waits for the
1651 ** specified number of milliseconds before returning 0.
1652 */
1653 int sqlite3_busy_timeout(sqlite3 *db, int ms){
1654 #ifdef SQLITE_ENABLE_API_ARMOR
1655   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1656 #endif
1657   if( ms>0 ){
1658     sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1659                              (void*)db);
1660     db->busyTimeout = ms;
1661     db->busyHandler.bExtraFileArg = 1;
1662   }else{
1663     sqlite3_busy_handler(db, 0, 0);
1664   }
1665   return SQLITE_OK;
1666 }
1667 
1668 /*
1669 ** Cause any pending operation to stop at its earliest opportunity.
1670 */
1671 void sqlite3_interrupt(sqlite3 *db){
1672 #ifdef SQLITE_ENABLE_API_ARMOR
1673   if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
1674     (void)SQLITE_MISUSE_BKPT;
1675     return;
1676   }
1677 #endif
1678   db->u1.isInterrupted = 1;
1679 }
1680 
1681 
1682 /*
1683 ** This function is exactly the same as sqlite3_create_function(), except
1684 ** that it is designed to be called by internal code. The difference is
1685 ** that if a malloc() fails in sqlite3_create_function(), an error code
1686 ** is returned and the mallocFailed flag cleared.
1687 */
1688 int sqlite3CreateFunc(
1689   sqlite3 *db,
1690   const char *zFunctionName,
1691   int nArg,
1692   int enc,
1693   void *pUserData,
1694   void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1695   void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1696   void (*xFinal)(sqlite3_context*),
1697   void (*xValue)(sqlite3_context*),
1698   void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1699   FuncDestructor *pDestructor
1700 ){
1701   FuncDef *p;
1702   int nName;
1703   int extraFlags;
1704 
1705   assert( sqlite3_mutex_held(db->mutex) );
1706   assert( xValue==0 || xSFunc==0 );
1707   if( zFunctionName==0                /* Must have a valid name */
1708    || (xSFunc!=0 && xFinal!=0)        /* Not both xSFunc and xFinal */
1709    || ((xFinal==0)!=(xStep==0))       /* Both or neither of xFinal and xStep */
1710    || ((xValue==0)!=(xInverse==0))    /* Both or neither of xValue, xInverse */
1711    || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1712    || (255<(nName = sqlite3Strlen30( zFunctionName)))
1713   ){
1714     return SQLITE_MISUSE_BKPT;
1715   }
1716 
1717   assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1718   extraFlags = enc &  SQLITE_DETERMINISTIC;
1719   enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
1720 
1721 #ifndef SQLITE_OMIT_UTF16
1722   /* If SQLITE_UTF16 is specified as the encoding type, transform this
1723   ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1724   ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1725   **
1726   ** If SQLITE_ANY is specified, add three versions of the function
1727   ** to the hash table.
1728   */
1729   if( enc==SQLITE_UTF16 ){
1730     enc = SQLITE_UTF16NATIVE;
1731   }else if( enc==SQLITE_ANY ){
1732     int rc;
1733     rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
1734          pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
1735     if( rc==SQLITE_OK ){
1736       rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
1737           pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
1738     }
1739     if( rc!=SQLITE_OK ){
1740       return rc;
1741     }
1742     enc = SQLITE_UTF16BE;
1743   }
1744 #else
1745   enc = SQLITE_UTF8;
1746 #endif
1747 
1748   /* Check if an existing function is being overridden or deleted. If so,
1749   ** and there are active VMs, then return SQLITE_BUSY. If a function
1750   ** is being overridden/deleted but there are no active VMs, allow the
1751   ** operation to continue but invalidate all precompiled statements.
1752   */
1753   p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
1754   if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
1755     if( db->nVdbeActive ){
1756       sqlite3ErrorWithMsg(db, SQLITE_BUSY,
1757         "unable to delete/modify user-function due to active statements");
1758       assert( !db->mallocFailed );
1759       return SQLITE_BUSY;
1760     }else{
1761       sqlite3ExpirePreparedStatements(db, 0);
1762     }
1763   }
1764 
1765   p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
1766   assert(p || db->mallocFailed);
1767   if( !p ){
1768     return SQLITE_NOMEM_BKPT;
1769   }
1770 
1771   /* If an older version of the function with a configured destructor is
1772   ** being replaced invoke the destructor function here. */
1773   functionDestroy(db, p);
1774 
1775   if( pDestructor ){
1776     pDestructor->nRef++;
1777   }
1778   p->u.pDestructor = pDestructor;
1779   p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1780   testcase( p->funcFlags & SQLITE_DETERMINISTIC );
1781   p->xSFunc = xSFunc ? xSFunc : xStep;
1782   p->xFinalize = xFinal;
1783   p->xValue = xValue;
1784   p->xInverse = xInverse;
1785   p->pUserData = pUserData;
1786   p->nArg = (u16)nArg;
1787   return SQLITE_OK;
1788 }
1789 
1790 /*
1791 ** Worker function used by utf-8 APIs that create new functions:
1792 **
1793 **    sqlite3_create_function()
1794 **    sqlite3_create_function_v2()
1795 **    sqlite3_create_window_function()
1796 */
1797 static int createFunctionApi(
1798   sqlite3 *db,
1799   const char *zFunc,
1800   int nArg,
1801   int enc,
1802   void *p,
1803   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1804   void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1805   void (*xFinal)(sqlite3_context*),
1806   void (*xValue)(sqlite3_context*),
1807   void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1808   void(*xDestroy)(void*)
1809 ){
1810   int rc = SQLITE_ERROR;
1811   FuncDestructor *pArg = 0;
1812 
1813 #ifdef SQLITE_ENABLE_API_ARMOR
1814   if( !sqlite3SafetyCheckOk(db) ){
1815     return SQLITE_MISUSE_BKPT;
1816   }
1817 #endif
1818   sqlite3_mutex_enter(db->mutex);
1819   if( xDestroy ){
1820     pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
1821     if( !pArg ){
1822       sqlite3OomFault(db);
1823       xDestroy(p);
1824       goto out;
1825     }
1826     pArg->nRef = 0;
1827     pArg->xDestroy = xDestroy;
1828     pArg->pUserData = p;
1829   }
1830   rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1831       xSFunc, xStep, xFinal, xValue, xInverse, pArg
1832   );
1833   if( pArg && pArg->nRef==0 ){
1834     assert( rc!=SQLITE_OK );
1835     xDestroy(p);
1836     sqlite3_free(pArg);
1837   }
1838 
1839  out:
1840   rc = sqlite3ApiExit(db, rc);
1841   sqlite3_mutex_leave(db->mutex);
1842   return rc;
1843 }
1844 
1845 /*
1846 ** Create new user functions.
1847 */
1848 int sqlite3_create_function(
1849   sqlite3 *db,
1850   const char *zFunc,
1851   int nArg,
1852   int enc,
1853   void *p,
1854   void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1855   void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1856   void (*xFinal)(sqlite3_context*)
1857 ){
1858   return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1859                                     xFinal, 0, 0, 0);
1860 }
1861 int sqlite3_create_function_v2(
1862   sqlite3 *db,
1863   const char *zFunc,
1864   int nArg,
1865   int enc,
1866   void *p,
1867   void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1868   void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1869   void (*xFinal)(sqlite3_context*),
1870   void (*xDestroy)(void *)
1871 ){
1872   return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
1873                                     xFinal, 0, 0, xDestroy);
1874 }
1875 int sqlite3_create_window_function(
1876   sqlite3 *db,
1877   const char *zFunc,
1878   int nArg,
1879   int enc,
1880   void *p,
1881   void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1882   void (*xFinal)(sqlite3_context*),
1883   void (*xValue)(sqlite3_context*),
1884   void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1885   void (*xDestroy)(void *)
1886 ){
1887   return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
1888                                     xFinal, xValue, xInverse, xDestroy);
1889 }
1890 
1891 #ifndef SQLITE_OMIT_UTF16
1892 int sqlite3_create_function16(
1893   sqlite3 *db,
1894   const void *zFunctionName,
1895   int nArg,
1896   int eTextRep,
1897   void *p,
1898   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1899   void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1900   void (*xFinal)(sqlite3_context*)
1901 ){
1902   int rc;
1903   char *zFunc8;
1904 
1905 #ifdef SQLITE_ENABLE_API_ARMOR
1906   if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
1907 #endif
1908   sqlite3_mutex_enter(db->mutex);
1909   assert( !db->mallocFailed );
1910   zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
1911   rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
1912   sqlite3DbFree(db, zFunc8);
1913   rc = sqlite3ApiExit(db, rc);
1914   sqlite3_mutex_leave(db->mutex);
1915   return rc;
1916 }
1917 #endif
1918 
1919 
1920 /*
1921 ** The following is the implementation of an SQL function that always
1922 ** fails with an error message stating that the function is used in the
1923 ** wrong context.  The sqlite3_overload_function() API might construct
1924 ** SQL function that use this routine so that the functions will exist
1925 ** for name resolution but are actually overloaded by the xFindFunction
1926 ** method of virtual tables.
1927 */
1928 static void sqlite3InvalidFunction(
1929   sqlite3_context *context,  /* The function calling context */
1930   int NotUsed,               /* Number of arguments to the function */
1931   sqlite3_value **NotUsed2   /* Value of each argument */
1932 ){
1933   const char *zName = (const char*)sqlite3_user_data(context);
1934   char *zErr;
1935   UNUSED_PARAMETER2(NotUsed, NotUsed2);
1936   zErr = sqlite3_mprintf(
1937       "unable to use function %s in the requested context", zName);
1938   sqlite3_result_error(context, zErr, -1);
1939   sqlite3_free(zErr);
1940 }
1941 
1942 /*
1943 ** Declare that a function has been overloaded by a virtual table.
1944 **
1945 ** If the function already exists as a regular global function, then
1946 ** this routine is a no-op.  If the function does not exist, then create
1947 ** a new one that always throws a run-time error.
1948 **
1949 ** When virtual tables intend to provide an overloaded function, they
1950 ** should call this routine to make sure the global function exists.
1951 ** A global function must exist in order for name resolution to work
1952 ** properly.
1953 */
1954 int sqlite3_overload_function(
1955   sqlite3 *db,
1956   const char *zName,
1957   int nArg
1958 ){
1959   int rc;
1960   char *zCopy;
1961 
1962 #ifdef SQLITE_ENABLE_API_ARMOR
1963   if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
1964     return SQLITE_MISUSE_BKPT;
1965   }
1966 #endif
1967   sqlite3_mutex_enter(db->mutex);
1968   rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
1969   sqlite3_mutex_leave(db->mutex);
1970   if( rc ) return SQLITE_OK;
1971   zCopy = sqlite3_mprintf(zName);
1972   if( zCopy==0 ) return SQLITE_NOMEM;
1973   return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
1974                            zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
1975 }
1976 
1977 #ifndef SQLITE_OMIT_TRACE
1978 /*
1979 ** Register a trace function.  The pArg from the previously registered trace
1980 ** is returned.
1981 **
1982 ** A NULL trace function means that no tracing is executes.  A non-NULL
1983 ** trace is a pointer to a function that is invoked at the start of each
1984 ** SQL statement.
1985 */
1986 #ifndef SQLITE_OMIT_DEPRECATED
1987 void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
1988   void *pOld;
1989 
1990 #ifdef SQLITE_ENABLE_API_ARMOR
1991   if( !sqlite3SafetyCheckOk(db) ){
1992     (void)SQLITE_MISUSE_BKPT;
1993     return 0;
1994   }
1995 #endif
1996   sqlite3_mutex_enter(db->mutex);
1997   pOld = db->pTraceArg;
1998   db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
1999   db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
2000   db->pTraceArg = pArg;
2001   sqlite3_mutex_leave(db->mutex);
2002   return pOld;
2003 }
2004 #endif /* SQLITE_OMIT_DEPRECATED */
2005 
2006 /* Register a trace callback using the version-2 interface.
2007 */
2008 int sqlite3_trace_v2(
2009   sqlite3 *db,                               /* Trace this connection */
2010   unsigned mTrace,                           /* Mask of events to be traced */
2011   int(*xTrace)(unsigned,void*,void*,void*),  /* Callback to invoke */
2012   void *pArg                                 /* Context */
2013 ){
2014 #ifdef SQLITE_ENABLE_API_ARMOR
2015   if( !sqlite3SafetyCheckOk(db) ){
2016     return SQLITE_MISUSE_BKPT;
2017   }
2018 #endif
2019   sqlite3_mutex_enter(db->mutex);
2020   if( mTrace==0 ) xTrace = 0;
2021   if( xTrace==0 ) mTrace = 0;
2022   db->mTrace = mTrace;
2023   db->xTrace = xTrace;
2024   db->pTraceArg = pArg;
2025   sqlite3_mutex_leave(db->mutex);
2026   return SQLITE_OK;
2027 }
2028 
2029 #ifndef SQLITE_OMIT_DEPRECATED
2030 /*
2031 ** Register a profile function.  The pArg from the previously registered
2032 ** profile function is returned.
2033 **
2034 ** A NULL profile function means that no profiling is executes.  A non-NULL
2035 ** profile is a pointer to a function that is invoked at the conclusion of
2036 ** each SQL statement that is run.
2037 */
2038 void *sqlite3_profile(
2039   sqlite3 *db,
2040   void (*xProfile)(void*,const char*,sqlite_uint64),
2041   void *pArg
2042 ){
2043   void *pOld;
2044 
2045 #ifdef SQLITE_ENABLE_API_ARMOR
2046   if( !sqlite3SafetyCheckOk(db) ){
2047     (void)SQLITE_MISUSE_BKPT;
2048     return 0;
2049   }
2050 #endif
2051   sqlite3_mutex_enter(db->mutex);
2052   pOld = db->pProfileArg;
2053   db->xProfile = xProfile;
2054   db->pProfileArg = pArg;
2055   db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2056   if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
2057   sqlite3_mutex_leave(db->mutex);
2058   return pOld;
2059 }
2060 #endif /* SQLITE_OMIT_DEPRECATED */
2061 #endif /* SQLITE_OMIT_TRACE */
2062 
2063 /*
2064 ** Register a function to be invoked when a transaction commits.
2065 ** If the invoked function returns non-zero, then the commit becomes a
2066 ** rollback.
2067 */
2068 void *sqlite3_commit_hook(
2069   sqlite3 *db,              /* Attach the hook to this database */
2070   int (*xCallback)(void*),  /* Function to invoke on each commit */
2071   void *pArg                /* Argument to the function */
2072 ){
2073   void *pOld;
2074 
2075 #ifdef SQLITE_ENABLE_API_ARMOR
2076   if( !sqlite3SafetyCheckOk(db) ){
2077     (void)SQLITE_MISUSE_BKPT;
2078     return 0;
2079   }
2080 #endif
2081   sqlite3_mutex_enter(db->mutex);
2082   pOld = db->pCommitArg;
2083   db->xCommitCallback = xCallback;
2084   db->pCommitArg = pArg;
2085   sqlite3_mutex_leave(db->mutex);
2086   return pOld;
2087 }
2088 
2089 /*
2090 ** Register a callback to be invoked each time a row is updated,
2091 ** inserted or deleted using this database connection.
2092 */
2093 void *sqlite3_update_hook(
2094   sqlite3 *db,              /* Attach the hook to this database */
2095   void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2096   void *pArg                /* Argument to the function */
2097 ){
2098   void *pRet;
2099 
2100 #ifdef SQLITE_ENABLE_API_ARMOR
2101   if( !sqlite3SafetyCheckOk(db) ){
2102     (void)SQLITE_MISUSE_BKPT;
2103     return 0;
2104   }
2105 #endif
2106   sqlite3_mutex_enter(db->mutex);
2107   pRet = db->pUpdateArg;
2108   db->xUpdateCallback = xCallback;
2109   db->pUpdateArg = pArg;
2110   sqlite3_mutex_leave(db->mutex);
2111   return pRet;
2112 }
2113 
2114 /*
2115 ** Register a callback to be invoked each time a transaction is rolled
2116 ** back by this database connection.
2117 */
2118 void *sqlite3_rollback_hook(
2119   sqlite3 *db,              /* Attach the hook to this database */
2120   void (*xCallback)(void*), /* Callback function */
2121   void *pArg                /* Argument to the function */
2122 ){
2123   void *pRet;
2124 
2125 #ifdef SQLITE_ENABLE_API_ARMOR
2126   if( !sqlite3SafetyCheckOk(db) ){
2127     (void)SQLITE_MISUSE_BKPT;
2128     return 0;
2129   }
2130 #endif
2131   sqlite3_mutex_enter(db->mutex);
2132   pRet = db->pRollbackArg;
2133   db->xRollbackCallback = xCallback;
2134   db->pRollbackArg = pArg;
2135   sqlite3_mutex_leave(db->mutex);
2136   return pRet;
2137 }
2138 
2139 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
2140 /*
2141 ** Register a callback to be invoked each time a row is updated,
2142 ** inserted or deleted using this database connection.
2143 */
2144 void *sqlite3_preupdate_hook(
2145   sqlite3 *db,              /* Attach the hook to this database */
2146   void(*xCallback)(         /* Callback function */
2147     void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2148   void *pArg                /* First callback argument */
2149 ){
2150   void *pRet;
2151   sqlite3_mutex_enter(db->mutex);
2152   pRet = db->pPreUpdateArg;
2153   db->xPreUpdateCallback = xCallback;
2154   db->pPreUpdateArg = pArg;
2155   sqlite3_mutex_leave(db->mutex);
2156   return pRet;
2157 }
2158 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
2159 
2160 #ifndef SQLITE_OMIT_WAL
2161 /*
2162 ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
2163 ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2164 ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
2165 ** wal_autocheckpoint()).
2166 */
2167 int sqlite3WalDefaultHook(
2168   void *pClientData,     /* Argument */
2169   sqlite3 *db,           /* Connection */
2170   const char *zDb,       /* Database */
2171   int nFrame             /* Size of WAL */
2172 ){
2173   if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
2174     sqlite3BeginBenignMalloc();
2175     sqlite3_wal_checkpoint(db, zDb);
2176     sqlite3EndBenignMalloc();
2177   }
2178   return SQLITE_OK;
2179 }
2180 #endif /* SQLITE_OMIT_WAL */
2181 
2182 /*
2183 ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2184 ** a database after committing a transaction if there are nFrame or
2185 ** more frames in the log file. Passing zero or a negative value as the
2186 ** nFrame parameter disables automatic checkpoints entirely.
2187 **
2188 ** The callback registered by this function replaces any existing callback
2189 ** registered using sqlite3_wal_hook(). Likewise, registering a callback
2190 ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2191 ** configured by this function.
2192 */
2193 int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
2194 #ifdef SQLITE_OMIT_WAL
2195   UNUSED_PARAMETER(db);
2196   UNUSED_PARAMETER(nFrame);
2197 #else
2198 #ifdef SQLITE_ENABLE_API_ARMOR
2199   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2200 #endif
2201   if( nFrame>0 ){
2202     sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
2203   }else{
2204     sqlite3_wal_hook(db, 0, 0);
2205   }
2206 #endif
2207   return SQLITE_OK;
2208 }
2209 
2210 /*
2211 ** Register a callback to be invoked each time a transaction is written
2212 ** into the write-ahead-log by this database connection.
2213 */
2214 void *sqlite3_wal_hook(
2215   sqlite3 *db,                    /* Attach the hook to this db handle */
2216   int(*xCallback)(void *, sqlite3*, const char*, int),
2217   void *pArg                      /* First argument passed to xCallback() */
2218 ){
2219 #ifndef SQLITE_OMIT_WAL
2220   void *pRet;
2221 #ifdef SQLITE_ENABLE_API_ARMOR
2222   if( !sqlite3SafetyCheckOk(db) ){
2223     (void)SQLITE_MISUSE_BKPT;
2224     return 0;
2225   }
2226 #endif
2227   sqlite3_mutex_enter(db->mutex);
2228   pRet = db->pWalArg;
2229   db->xWalCallback = xCallback;
2230   db->pWalArg = pArg;
2231   sqlite3_mutex_leave(db->mutex);
2232   return pRet;
2233 #else
2234   return 0;
2235 #endif
2236 }
2237 
2238 /*
2239 ** Checkpoint database zDb.
2240 */
2241 int sqlite3_wal_checkpoint_v2(
2242   sqlite3 *db,                    /* Database handle */
2243   const char *zDb,                /* Name of attached database (or NULL) */
2244   int eMode,                      /* SQLITE_CHECKPOINT_* value */
2245   int *pnLog,                     /* OUT: Size of WAL log in frames */
2246   int *pnCkpt                     /* OUT: Total number of frames checkpointed */
2247 ){
2248 #ifdef SQLITE_OMIT_WAL
2249   return SQLITE_OK;
2250 #else
2251   int rc;                         /* Return code */
2252   int iDb = SQLITE_MAX_ATTACHED;  /* sqlite3.aDb[] index of db to checkpoint */
2253 
2254 #ifdef SQLITE_ENABLE_API_ARMOR
2255   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2256 #endif
2257 
2258   /* Initialize the output variables to -1 in case an error occurs. */
2259   if( pnLog ) *pnLog = -1;
2260   if( pnCkpt ) *pnCkpt = -1;
2261 
2262   assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2263   assert( SQLITE_CHECKPOINT_FULL==1 );
2264   assert( SQLITE_CHECKPOINT_RESTART==2 );
2265   assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2266   if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
2267     /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2268     ** mode: */
2269     return SQLITE_MISUSE;
2270   }
2271 
2272   sqlite3_mutex_enter(db->mutex);
2273   if( zDb && zDb[0] ){
2274     iDb = sqlite3FindDbName(db, zDb);
2275   }
2276   if( iDb<0 ){
2277     rc = SQLITE_ERROR;
2278     sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
2279   }else{
2280     db->busyHandler.nBusy = 0;
2281     rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
2282     sqlite3Error(db, rc);
2283   }
2284   rc = sqlite3ApiExit(db, rc);
2285 
2286   /* If there are no active statements, clear the interrupt flag at this
2287   ** point.  */
2288   if( db->nVdbeActive==0 ){
2289     db->u1.isInterrupted = 0;
2290   }
2291 
2292   sqlite3_mutex_leave(db->mutex);
2293   return rc;
2294 #endif
2295 }
2296 
2297 
2298 /*
2299 ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2300 ** to contains a zero-length string, all attached databases are
2301 ** checkpointed.
2302 */
2303 int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
2304   /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2305   ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2306   return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
2307 }
2308 
2309 #ifndef SQLITE_OMIT_WAL
2310 /*
2311 ** Run a checkpoint on database iDb. This is a no-op if database iDb is
2312 ** not currently open in WAL mode.
2313 **
2314 ** If a transaction is open on the database being checkpointed, this
2315 ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2316 ** an error occurs while running the checkpoint, an SQLite error code is
2317 ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
2318 **
2319 ** The mutex on database handle db should be held by the caller. The mutex
2320 ** associated with the specific b-tree being checkpointed is taken by
2321 ** this function while the checkpoint is running.
2322 **
2323 ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2324 ** checkpointed. If an error is encountered it is returned immediately -
2325 ** no attempt is made to checkpoint any remaining databases.
2326 **
2327 ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2328 ** or TRUNCATE.
2329 */
2330 int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
2331   int rc = SQLITE_OK;             /* Return code */
2332   int i;                          /* Used to iterate through attached dbs */
2333   int bBusy = 0;                  /* True if SQLITE_BUSY has been encountered */
2334 
2335   assert( sqlite3_mutex_held(db->mutex) );
2336   assert( !pnLog || *pnLog==-1 );
2337   assert( !pnCkpt || *pnCkpt==-1 );
2338 
2339   for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2340     if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
2341       rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
2342       pnLog = 0;
2343       pnCkpt = 0;
2344       if( rc==SQLITE_BUSY ){
2345         bBusy = 1;
2346         rc = SQLITE_OK;
2347       }
2348     }
2349   }
2350 
2351   return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
2352 }
2353 #endif /* SQLITE_OMIT_WAL */
2354 
2355 /*
2356 ** This function returns true if main-memory should be used instead of
2357 ** a temporary file for transient pager files and statement journals.
2358 ** The value returned depends on the value of db->temp_store (runtime
2359 ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2360 ** following table describes the relationship between these two values
2361 ** and this functions return value.
2362 **
2363 **   SQLITE_TEMP_STORE     db->temp_store     Location of temporary database
2364 **   -----------------     --------------     ------------------------------
2365 **   0                     any                file      (return 0)
2366 **   1                     1                  file      (return 0)
2367 **   1                     2                  memory    (return 1)
2368 **   1                     0                  file      (return 0)
2369 **   2                     1                  file      (return 0)
2370 **   2                     2                  memory    (return 1)
2371 **   2                     0                  memory    (return 1)
2372 **   3                     any                memory    (return 1)
2373 */
2374 int sqlite3TempInMemory(const sqlite3 *db){
2375 #if SQLITE_TEMP_STORE==1
2376   return ( db->temp_store==2 );
2377 #endif
2378 #if SQLITE_TEMP_STORE==2
2379   return ( db->temp_store!=1 );
2380 #endif
2381 #if SQLITE_TEMP_STORE==3
2382   UNUSED_PARAMETER(db);
2383   return 1;
2384 #endif
2385 #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
2386   UNUSED_PARAMETER(db);
2387   return 0;
2388 #endif
2389 }
2390 
2391 /*
2392 ** Return UTF-8 encoded English language explanation of the most recent
2393 ** error.
2394 */
2395 const char *sqlite3_errmsg(sqlite3 *db){
2396   const char *z;
2397   if( !db ){
2398     return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
2399   }
2400   if( !sqlite3SafetyCheckSickOrOk(db) ){
2401     return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
2402   }
2403   sqlite3_mutex_enter(db->mutex);
2404   if( db->mallocFailed ){
2405     z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
2406   }else{
2407     testcase( db->pErr==0 );
2408     z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
2409     assert( !db->mallocFailed );
2410     if( z==0 ){
2411       z = sqlite3ErrStr(db->errCode);
2412     }
2413   }
2414   sqlite3_mutex_leave(db->mutex);
2415   return z;
2416 }
2417 
2418 #ifndef SQLITE_OMIT_UTF16
2419 /*
2420 ** Return UTF-16 encoded English language explanation of the most recent
2421 ** error.
2422 */
2423 const void *sqlite3_errmsg16(sqlite3 *db){
2424   static const u16 outOfMem[] = {
2425     'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
2426   };
2427   static const u16 misuse[] = {
2428     'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2429     'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2430     'm', 'i', 's', 'u', 's', 'e', 0
2431   };
2432 
2433   const void *z;
2434   if( !db ){
2435     return (void *)outOfMem;
2436   }
2437   if( !sqlite3SafetyCheckSickOrOk(db) ){
2438     return (void *)misuse;
2439   }
2440   sqlite3_mutex_enter(db->mutex);
2441   if( db->mallocFailed ){
2442     z = (void *)outOfMem;
2443   }else{
2444     z = sqlite3_value_text16(db->pErr);
2445     if( z==0 ){
2446       sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
2447       z = sqlite3_value_text16(db->pErr);
2448     }
2449     /* A malloc() may have failed within the call to sqlite3_value_text16()
2450     ** above. If this is the case, then the db->mallocFailed flag needs to
2451     ** be cleared before returning. Do this directly, instead of via
2452     ** sqlite3ApiExit(), to avoid setting the database handle error message.
2453     */
2454     sqlite3OomClear(db);
2455   }
2456   sqlite3_mutex_leave(db->mutex);
2457   return z;
2458 }
2459 #endif /* SQLITE_OMIT_UTF16 */
2460 
2461 /*
2462 ** Return the most recent error code generated by an SQLite routine. If NULL is
2463 ** passed to this function, we assume a malloc() failed during sqlite3_open().
2464 */
2465 int sqlite3_errcode(sqlite3 *db){
2466   if( db && !sqlite3SafetyCheckSickOrOk(db) ){
2467     return SQLITE_MISUSE_BKPT;
2468   }
2469   if( !db || db->mallocFailed ){
2470     return SQLITE_NOMEM_BKPT;
2471   }
2472   return db->errCode & db->errMask;
2473 }
2474 int sqlite3_extended_errcode(sqlite3 *db){
2475   if( db && !sqlite3SafetyCheckSickOrOk(db) ){
2476     return SQLITE_MISUSE_BKPT;
2477   }
2478   if( !db || db->mallocFailed ){
2479     return SQLITE_NOMEM_BKPT;
2480   }
2481   return db->errCode;
2482 }
2483 int sqlite3_system_errno(sqlite3 *db){
2484   return db ? db->iSysErrno : 0;
2485 }
2486 
2487 /*
2488 ** Return a string that describes the kind of error specified in the
2489 ** argument.  For now, this simply calls the internal sqlite3ErrStr()
2490 ** function.
2491 */
2492 const char *sqlite3_errstr(int rc){
2493   return sqlite3ErrStr(rc);
2494 }
2495 
2496 /*
2497 ** Create a new collating function for database "db".  The name is zName
2498 ** and the encoding is enc.
2499 */
2500 static int createCollation(
2501   sqlite3* db,
2502   const char *zName,
2503   u8 enc,
2504   void* pCtx,
2505   int(*xCompare)(void*,int,const void*,int,const void*),
2506   void(*xDel)(void*)
2507 ){
2508   CollSeq *pColl;
2509   int enc2;
2510 
2511   assert( sqlite3_mutex_held(db->mutex) );
2512 
2513   /* If SQLITE_UTF16 is specified as the encoding type, transform this
2514   ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2515   ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2516   */
2517   enc2 = enc;
2518   testcase( enc2==SQLITE_UTF16 );
2519   testcase( enc2==SQLITE_UTF16_ALIGNED );
2520   if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
2521     enc2 = SQLITE_UTF16NATIVE;
2522   }
2523   if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
2524     return SQLITE_MISUSE_BKPT;
2525   }
2526 
2527   /* Check if this call is removing or replacing an existing collation
2528   ** sequence. If so, and there are active VMs, return busy. If there
2529   ** are no active VMs, invalidate any pre-compiled statements.
2530   */
2531   pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
2532   if( pColl && pColl->xCmp ){
2533     if( db->nVdbeActive ){
2534       sqlite3ErrorWithMsg(db, SQLITE_BUSY,
2535         "unable to delete/modify collation sequence due to active statements");
2536       return SQLITE_BUSY;
2537     }
2538     sqlite3ExpirePreparedStatements(db, 0);
2539 
2540     /* If collation sequence pColl was created directly by a call to
2541     ** sqlite3_create_collation, and not generated by synthCollSeq(),
2542     ** then any copies made by synthCollSeq() need to be invalidated.
2543     ** Also, collation destructor - CollSeq.xDel() - function may need
2544     ** to be called.
2545     */
2546     if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
2547       CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
2548       int j;
2549       for(j=0; j<3; j++){
2550         CollSeq *p = &aColl[j];
2551         if( p->enc==pColl->enc ){
2552           if( p->xDel ){
2553             p->xDel(p->pUser);
2554           }
2555           p->xCmp = 0;
2556         }
2557       }
2558     }
2559   }
2560 
2561   pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
2562   if( pColl==0 ) return SQLITE_NOMEM_BKPT;
2563   pColl->xCmp = xCompare;
2564   pColl->pUser = pCtx;
2565   pColl->xDel = xDel;
2566   pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
2567   sqlite3Error(db, SQLITE_OK);
2568   return SQLITE_OK;
2569 }
2570 
2571 
2572 /*
2573 ** This array defines hard upper bounds on limit values.  The
2574 ** initializer must be kept in sync with the SQLITE_LIMIT_*
2575 ** #defines in sqlite3.h.
2576 */
2577 static const int aHardLimit[] = {
2578   SQLITE_MAX_LENGTH,
2579   SQLITE_MAX_SQL_LENGTH,
2580   SQLITE_MAX_COLUMN,
2581   SQLITE_MAX_EXPR_DEPTH,
2582   SQLITE_MAX_COMPOUND_SELECT,
2583   SQLITE_MAX_VDBE_OP,
2584   SQLITE_MAX_FUNCTION_ARG,
2585   SQLITE_MAX_ATTACHED,
2586   SQLITE_MAX_LIKE_PATTERN_LENGTH,
2587   SQLITE_MAX_VARIABLE_NUMBER,      /* IMP: R-38091-32352 */
2588   SQLITE_MAX_TRIGGER_DEPTH,
2589   SQLITE_MAX_WORKER_THREADS,
2590 };
2591 
2592 /*
2593 ** Make sure the hard limits are set to reasonable values
2594 */
2595 #if SQLITE_MAX_LENGTH<100
2596 # error SQLITE_MAX_LENGTH must be at least 100
2597 #endif
2598 #if SQLITE_MAX_SQL_LENGTH<100
2599 # error SQLITE_MAX_SQL_LENGTH must be at least 100
2600 #endif
2601 #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2602 # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2603 #endif
2604 #if SQLITE_MAX_COMPOUND_SELECT<2
2605 # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2606 #endif
2607 #if SQLITE_MAX_VDBE_OP<40
2608 # error SQLITE_MAX_VDBE_OP must be at least 40
2609 #endif
2610 #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2611 # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
2612 #endif
2613 #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2614 # error SQLITE_MAX_ATTACHED must be between 0 and 125
2615 #endif
2616 #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2617 # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2618 #endif
2619 #if SQLITE_MAX_COLUMN>32767
2620 # error SQLITE_MAX_COLUMN must not exceed 32767
2621 #endif
2622 #if SQLITE_MAX_TRIGGER_DEPTH<1
2623 # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2624 #endif
2625 #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2626 # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2627 #endif
2628 
2629 
2630 /*
2631 ** Change the value of a limit.  Report the old value.
2632 ** If an invalid limit index is supplied, report -1.
2633 ** Make no changes but still report the old value if the
2634 ** new limit is negative.
2635 **
2636 ** A new lower limit does not shrink existing constructs.
2637 ** It merely prevents new constructs that exceed the limit
2638 ** from forming.
2639 */
2640 int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2641   int oldLimit;
2642 
2643 #ifdef SQLITE_ENABLE_API_ARMOR
2644   if( !sqlite3SafetyCheckOk(db) ){
2645     (void)SQLITE_MISUSE_BKPT;
2646     return -1;
2647   }
2648 #endif
2649 
2650   /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2651   ** there is a hard upper bound set at compile-time by a C preprocessor
2652   ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2653   ** "_MAX_".)
2654   */
2655   assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2656   assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2657   assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2658   assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2659   assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2660   assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2661   assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2662   assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2663   assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2664                                                SQLITE_MAX_LIKE_PATTERN_LENGTH );
2665   assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2666   assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
2667   assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2668   assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
2669 
2670 
2671   if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
2672     return -1;
2673   }
2674   oldLimit = db->aLimit[limitId];
2675   if( newLimit>=0 ){                   /* IMP: R-52476-28732 */
2676     if( newLimit>aHardLimit[limitId] ){
2677       newLimit = aHardLimit[limitId];  /* IMP: R-51463-25634 */
2678     }
2679     db->aLimit[limitId] = newLimit;
2680   }
2681   return oldLimit;                     /* IMP: R-53341-35419 */
2682 }
2683 
2684 /*
2685 ** This function is used to parse both URIs and non-URI filenames passed by the
2686 ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2687 ** URIs specified as part of ATTACH statements.
2688 **
2689 ** The first argument to this function is the name of the VFS to use (or
2690 ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2691 ** query parameter. The second argument contains the URI (or non-URI filename)
2692 ** itself. When this function is called the *pFlags variable should contain
2693 ** the default flags to open the database handle with. The value stored in
2694 ** *pFlags may be updated before returning if the URI filename contains
2695 ** "cache=xxx" or "mode=xxx" query parameters.
2696 **
2697 ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2698 ** the VFS that should be used to open the database file. *pzFile is set to
2699 ** point to a buffer containing the name of the file to open. It is the
2700 ** responsibility of the caller to eventually call sqlite3_free() to release
2701 ** this buffer.
2702 **
2703 ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2704 ** may be set to point to a buffer containing an English language error
2705 ** message. It is the responsibility of the caller to eventually release
2706 ** this buffer by calling sqlite3_free().
2707 */
2708 int sqlite3ParseUri(
2709   const char *zDefaultVfs,        /* VFS to use if no "vfs=xxx" query option */
2710   const char *zUri,               /* Nul-terminated URI to parse */
2711   unsigned int *pFlags,           /* IN/OUT: SQLITE_OPEN_XXX flags */
2712   sqlite3_vfs **ppVfs,            /* OUT: VFS to use */
2713   char **pzFile,                  /* OUT: Filename component of URI */
2714   char **pzErrMsg                 /* OUT: Error message (if rc!=SQLITE_OK) */
2715 ){
2716   int rc = SQLITE_OK;
2717   unsigned int flags = *pFlags;
2718   const char *zVfs = zDefaultVfs;
2719   char *zFile;
2720   char c;
2721   int nUri = sqlite3Strlen30(zUri);
2722 
2723   assert( *pzErrMsg==0 );
2724 
2725   if( ((flags & SQLITE_OPEN_URI)             /* IMP: R-48725-32206 */
2726             || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
2727    && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
2728   ){
2729     char *zOpt;
2730     int eState;                   /* Parser state when parsing URI */
2731     int iIn;                      /* Input character index */
2732     int iOut = 0;                 /* Output character index */
2733     u64 nByte = nUri+2;           /* Bytes of space to allocate */
2734 
2735     /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2736     ** method that there may be extra parameters following the file-name.  */
2737     flags |= SQLITE_OPEN_URI;
2738 
2739     for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
2740     zFile = sqlite3_malloc64(nByte);
2741     if( !zFile ) return SQLITE_NOMEM_BKPT;
2742 
2743     iIn = 5;
2744 #ifdef SQLITE_ALLOW_URI_AUTHORITY
2745     if( strncmp(zUri+5, "///", 3)==0 ){
2746       iIn = 7;
2747       /* The following condition causes URIs with five leading / characters
2748       ** like file://///host/path to be converted into UNCs like //host/path.
2749       ** The correct URI for that UNC has only two or four leading / characters
2750       ** file://host/path or file:////host/path.  But 5 leading slashes is a
2751       ** common error, we are told, so we handle it as a special case. */
2752       if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2753     }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2754       iIn = 16;
2755     }
2756 #else
2757     /* Discard the scheme and authority segments of the URI. */
2758     if( zUri[5]=='/' && zUri[6]=='/' ){
2759       iIn = 7;
2760       while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
2761       if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2762         *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2763             iIn-7, &zUri[7]);
2764         rc = SQLITE_ERROR;
2765         goto parse_uri_out;
2766       }
2767     }
2768 #endif
2769 
2770     /* Copy the filename and any query parameters into the zFile buffer.
2771     ** Decode %HH escape codes along the way.
2772     **
2773     ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2774     ** on the parsing context. As follows:
2775     **
2776     **   0: Parsing file-name.
2777     **   1: Parsing name section of a name=value query parameter.
2778     **   2: Parsing value section of a name=value query parameter.
2779     */
2780     eState = 0;
2781     while( (c = zUri[iIn])!=0 && c!='#' ){
2782       iIn++;
2783       if( c=='%'
2784        && sqlite3Isxdigit(zUri[iIn])
2785        && sqlite3Isxdigit(zUri[iIn+1])
2786       ){
2787         int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
2788         octet += sqlite3HexToInt(zUri[iIn++]);
2789 
2790         assert( octet>=0 && octet<256 );
2791         if( octet==0 ){
2792 #ifndef SQLITE_ENABLE_URI_00_ERROR
2793           /* This branch is taken when "%00" appears within the URI. In this
2794           ** case we ignore all text in the remainder of the path, name or
2795           ** value currently being parsed. So ignore the current character
2796           ** and skip to the next "?", "=" or "&", as appropriate. */
2797           while( (c = zUri[iIn])!=0 && c!='#'
2798               && (eState!=0 || c!='?')
2799               && (eState!=1 || (c!='=' && c!='&'))
2800               && (eState!=2 || c!='&')
2801           ){
2802             iIn++;
2803           }
2804           continue;
2805 #else
2806           /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2807           *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
2808           rc = SQLITE_ERROR;
2809           goto parse_uri_out;
2810 #endif
2811         }
2812         c = octet;
2813       }else if( eState==1 && (c=='&' || c=='=') ){
2814         if( zFile[iOut-1]==0 ){
2815           /* An empty option name. Ignore this option altogether. */
2816           while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
2817           continue;
2818         }
2819         if( c=='&' ){
2820           zFile[iOut++] = '\0';
2821         }else{
2822           eState = 2;
2823         }
2824         c = 0;
2825       }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
2826         c = 0;
2827         eState = 1;
2828       }
2829       zFile[iOut++] = c;
2830     }
2831     if( eState==1 ) zFile[iOut++] = '\0';
2832     zFile[iOut++] = '\0';
2833     zFile[iOut++] = '\0';
2834 
2835     /* Check if there were any options specified that should be interpreted
2836     ** here. Options that are interpreted here include "vfs" and those that
2837     ** correspond to flags that may be passed to the sqlite3_open_v2()
2838     ** method. */
2839     zOpt = &zFile[sqlite3Strlen30(zFile)+1];
2840     while( zOpt[0] ){
2841       int nOpt = sqlite3Strlen30(zOpt);
2842       char *zVal = &zOpt[nOpt+1];
2843       int nVal = sqlite3Strlen30(zVal);
2844 
2845       if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
2846         zVfs = zVal;
2847       }else{
2848         struct OpenMode {
2849           const char *z;
2850           int mode;
2851         } *aMode = 0;
2852         char *zModeType = 0;
2853         int mask = 0;
2854         int limit = 0;
2855 
2856         if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
2857           static struct OpenMode aCacheMode[] = {
2858             { "shared",  SQLITE_OPEN_SHAREDCACHE },
2859             { "private", SQLITE_OPEN_PRIVATECACHE },
2860             { 0, 0 }
2861           };
2862 
2863           mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
2864           aMode = aCacheMode;
2865           limit = mask;
2866           zModeType = "cache";
2867         }
2868         if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
2869           static struct OpenMode aOpenMode[] = {
2870             { "ro",  SQLITE_OPEN_READONLY },
2871             { "rw",  SQLITE_OPEN_READWRITE },
2872             { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
2873             { "memory", SQLITE_OPEN_MEMORY },
2874             { 0, 0 }
2875           };
2876 
2877           mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
2878                    | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
2879           aMode = aOpenMode;
2880           limit = mask & flags;
2881           zModeType = "access";
2882         }
2883 
2884         if( aMode ){
2885           int i;
2886           int mode = 0;
2887           for(i=0; aMode[i].z; i++){
2888             const char *z = aMode[i].z;
2889             if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
2890               mode = aMode[i].mode;
2891               break;
2892             }
2893           }
2894           if( mode==0 ){
2895             *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
2896             rc = SQLITE_ERROR;
2897             goto parse_uri_out;
2898           }
2899           if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
2900             *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
2901                                         zModeType, zVal);
2902             rc = SQLITE_PERM;
2903             goto parse_uri_out;
2904           }
2905           flags = (flags & ~mask) | mode;
2906         }
2907       }
2908 
2909       zOpt = &zVal[nVal+1];
2910     }
2911 
2912   }else{
2913     zFile = sqlite3_malloc64(nUri+2);
2914     if( !zFile ) return SQLITE_NOMEM_BKPT;
2915     if( nUri ){
2916       memcpy(zFile, zUri, nUri);
2917     }
2918     zFile[nUri] = '\0';
2919     zFile[nUri+1] = '\0';
2920     flags &= ~SQLITE_OPEN_URI;
2921   }
2922 
2923   *ppVfs = sqlite3_vfs_find(zVfs);
2924   if( *ppVfs==0 ){
2925     *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
2926     rc = SQLITE_ERROR;
2927   }
2928  parse_uri_out:
2929   if( rc!=SQLITE_OK ){
2930     sqlite3_free(zFile);
2931     zFile = 0;
2932   }
2933   *pFlags = flags;
2934   *pzFile = zFile;
2935   return rc;
2936 }
2937 
2938 
2939 /*
2940 ** This routine does the work of opening a database on behalf of
2941 ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
2942 ** is UTF-8 encoded.
2943 */
2944 static int openDatabase(
2945   const char *zFilename, /* Database filename UTF-8 encoded */
2946   sqlite3 **ppDb,        /* OUT: Returned database handle */
2947   unsigned int flags,    /* Operational flags */
2948   const char *zVfs       /* Name of the VFS to use */
2949 ){
2950   sqlite3 *db;                    /* Store allocated handle here */
2951   int rc;                         /* Return code */
2952   int isThreadsafe;               /* True for threadsafe connections */
2953   char *zOpen = 0;                /* Filename argument to pass to BtreeOpen() */
2954   char *zErrMsg = 0;              /* Error message from sqlite3ParseUri() */
2955 
2956 #ifdef SQLITE_ENABLE_API_ARMOR
2957   if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
2958 #endif
2959   *ppDb = 0;
2960 #ifndef SQLITE_OMIT_AUTOINIT
2961   rc = sqlite3_initialize();
2962   if( rc ) return rc;
2963 #endif
2964 
2965   if( sqlite3GlobalConfig.bCoreMutex==0 ){
2966     isThreadsafe = 0;
2967   }else if( flags & SQLITE_OPEN_NOMUTEX ){
2968     isThreadsafe = 0;
2969   }else if( flags & SQLITE_OPEN_FULLMUTEX ){
2970     isThreadsafe = 1;
2971   }else{
2972     isThreadsafe = sqlite3GlobalConfig.bFullMutex;
2973   }
2974 
2975   if( flags & SQLITE_OPEN_PRIVATECACHE ){
2976     flags &= ~SQLITE_OPEN_SHAREDCACHE;
2977   }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
2978     flags |= SQLITE_OPEN_SHAREDCACHE;
2979   }
2980 
2981   /* Remove harmful bits from the flags parameter
2982   **
2983   ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2984   ** dealt with in the previous code block.  Besides these, the only
2985   ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
2986   ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2987   ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits.  Silently mask
2988   ** off all other flags.
2989   */
2990   flags &=  ~( SQLITE_OPEN_DELETEONCLOSE |
2991                SQLITE_OPEN_EXCLUSIVE |
2992                SQLITE_OPEN_MAIN_DB |
2993                SQLITE_OPEN_TEMP_DB |
2994                SQLITE_OPEN_TRANSIENT_DB |
2995                SQLITE_OPEN_MAIN_JOURNAL |
2996                SQLITE_OPEN_TEMP_JOURNAL |
2997                SQLITE_OPEN_SUBJOURNAL |
2998                SQLITE_OPEN_MASTER_JOURNAL |
2999                SQLITE_OPEN_NOMUTEX |
3000                SQLITE_OPEN_FULLMUTEX |
3001                SQLITE_OPEN_WAL
3002              );
3003 
3004   /* Allocate the sqlite data structure */
3005   db = sqlite3MallocZero( sizeof(sqlite3) );
3006   if( db==0 ) goto opendb_out;
3007   if( isThreadsafe
3008 #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3009    || sqlite3GlobalConfig.bCoreMutex
3010 #endif
3011   ){
3012     db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3013     if( db->mutex==0 ){
3014       sqlite3_free(db);
3015       db = 0;
3016       goto opendb_out;
3017     }
3018     if( isThreadsafe==0 ){
3019       sqlite3MutexWarnOnContention(db->mutex);
3020     }
3021   }
3022   sqlite3_mutex_enter(db->mutex);
3023   db->errMask = 0xff;
3024   db->nDb = 2;
3025   db->magic = SQLITE_MAGIC_BUSY;
3026   db->aDb = db->aDbStatic;
3027   db->lookaside.bDisable = 1;
3028 
3029   assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3030   memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
3031   db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
3032   db->autoCommit = 1;
3033   db->nextAutovac = -1;
3034   db->szMmap = sqlite3GlobalConfig.szMmap;
3035   db->nextPagesize = 0;
3036   db->nMaxSorterMmap = 0x7FFFFFFF;
3037   db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
3038 #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
3039                  | SQLITE_AutoIndex
3040 #endif
3041 #if SQLITE_DEFAULT_CKPTFULLFSYNC
3042                  | SQLITE_CkptFullFSync
3043 #endif
3044 #if SQLITE_DEFAULT_FILE_FORMAT<4
3045                  | SQLITE_LegacyFileFmt
3046 #endif
3047 #ifdef SQLITE_ENABLE_LOAD_EXTENSION
3048                  | SQLITE_LoadExtension
3049 #endif
3050 #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
3051                  | SQLITE_RecTriggers
3052 #endif
3053 #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3054                  | SQLITE_ForeignKeys
3055 #endif
3056 #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3057                  | SQLITE_ReverseOrder
3058 #endif
3059 #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3060                  | SQLITE_CellSizeCk
3061 #endif
3062 #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3063                  | SQLITE_Fts3Tokenizer
3064 #endif
3065 #if defined(SQLITE_ENABLE_QPSG)
3066                  | SQLITE_EnableQPSG
3067 #endif
3068 #if defined(SQLITE_DEFAULT_DEFENSIVE)
3069                  | SQLITE_Defensive
3070 #endif
3071       ;
3072   sqlite3HashInit(&db->aCollSeq);
3073 #ifndef SQLITE_OMIT_VIRTUALTABLE
3074   sqlite3HashInit(&db->aModule);
3075 #endif
3076 
3077   /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3078   ** and UTF-16, so add a version for each to avoid any unnecessary
3079   ** conversions. The only error that can occur here is a malloc() failure.
3080   **
3081   ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3082   ** functions:
3083   */
3084   createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3085   createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3086   createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
3087   createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
3088   createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
3089   if( db->mallocFailed ){
3090     goto opendb_out;
3091   }
3092   /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3093   ** strings is BINARY.
3094   */
3095   db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
3096   assert( db->pDfltColl!=0 );
3097 
3098   /* Parse the filename/URI argument
3099   **
3100   ** Only allow sensible combinations of bits in the flags argument.
3101   ** Throw an error if any non-sense combination is used.  If we
3102   ** do not block illegal combinations here, it could trigger
3103   ** assert() statements in deeper layers.  Sensible combinations
3104   ** are:
3105   **
3106   **  1:  SQLITE_OPEN_READONLY
3107   **  2:  SQLITE_OPEN_READWRITE
3108   **  6:  SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3109   */
3110   db->openFlags = flags;
3111   assert( SQLITE_OPEN_READONLY  == 0x01 );
3112   assert( SQLITE_OPEN_READWRITE == 0x02 );
3113   assert( SQLITE_OPEN_CREATE    == 0x04 );
3114   testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3115   testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3116   testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3117   if( ((1<<(flags&7)) & 0x46)==0 ){
3118     rc = SQLITE_MISUSE_BKPT;  /* IMP: R-65497-44594 */
3119   }else{
3120     rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3121   }
3122   if( rc!=SQLITE_OK ){
3123     if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
3124     sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
3125     sqlite3_free(zErrMsg);
3126     goto opendb_out;
3127   }
3128 
3129   /* Open the backend database driver */
3130   rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
3131                         flags | SQLITE_OPEN_MAIN_DB);
3132   if( rc!=SQLITE_OK ){
3133     if( rc==SQLITE_IOERR_NOMEM ){
3134       rc = SQLITE_NOMEM_BKPT;
3135     }
3136     sqlite3Error(db, rc);
3137     goto opendb_out;
3138   }
3139   sqlite3BtreeEnter(db->aDb[0].pBt);
3140   db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
3141   if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
3142   sqlite3BtreeLeave(db->aDb[0].pBt);
3143   db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
3144 
3145   /* The default safety_level for the main database is FULL; for the temp
3146   ** database it is OFF. This matches the pager layer defaults.
3147   */
3148   db->aDb[0].zDbSName = "main";
3149   db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
3150   db->aDb[1].zDbSName = "temp";
3151   db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
3152 
3153   db->magic = SQLITE_MAGIC_OPEN;
3154   if( db->mallocFailed ){
3155     goto opendb_out;
3156   }
3157 
3158   /* Register all built-in functions, but do not attempt to read the
3159   ** database schema yet. This is delayed until the first time the database
3160   ** is accessed.
3161   */
3162   sqlite3Error(db, SQLITE_OK);
3163   sqlite3RegisterPerConnectionBuiltinFunctions(db);
3164   rc = sqlite3_errcode(db);
3165 
3166 #ifdef SQLITE_ENABLE_FTS5
3167   /* Register any built-in FTS5 module before loading the automatic
3168   ** extensions. This allows automatic extensions to register FTS5
3169   ** tokenizers and auxiliary functions.  */
3170   if( !db->mallocFailed && rc==SQLITE_OK ){
3171     rc = sqlite3Fts5Init(db);
3172   }
3173 #endif
3174 
3175   /* Load automatic extensions - extensions that have been registered
3176   ** using the sqlite3_automatic_extension() API.
3177   */
3178   if( rc==SQLITE_OK ){
3179     sqlite3AutoLoadExtensions(db);
3180     rc = sqlite3_errcode(db);
3181     if( rc!=SQLITE_OK ){
3182       goto opendb_out;
3183     }
3184   }
3185 
3186 #ifdef SQLITE_ENABLE_FTS1
3187   if( !db->mallocFailed ){
3188     extern int sqlite3Fts1Init(sqlite3*);
3189     rc = sqlite3Fts1Init(db);
3190   }
3191 #endif
3192 
3193 #ifdef SQLITE_ENABLE_FTS2
3194   if( !db->mallocFailed && rc==SQLITE_OK ){
3195     extern int sqlite3Fts2Init(sqlite3*);
3196     rc = sqlite3Fts2Init(db);
3197   }
3198 #endif
3199 
3200 #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
3201   if( !db->mallocFailed && rc==SQLITE_OK ){
3202     rc = sqlite3Fts3Init(db);
3203   }
3204 #endif
3205 
3206 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
3207   if( !db->mallocFailed && rc==SQLITE_OK ){
3208     rc = sqlite3IcuInit(db);
3209   }
3210 #endif
3211 
3212 #ifdef SQLITE_ENABLE_RTREE
3213   if( !db->mallocFailed && rc==SQLITE_OK){
3214     rc = sqlite3RtreeInit(db);
3215   }
3216 #endif
3217 
3218 #ifdef SQLITE_ENABLE_DBPAGE_VTAB
3219   if( !db->mallocFailed && rc==SQLITE_OK){
3220     rc = sqlite3DbpageRegister(db);
3221   }
3222 #endif
3223 
3224 #ifdef SQLITE_ENABLE_DBSTAT_VTAB
3225   if( !db->mallocFailed && rc==SQLITE_OK){
3226     rc = sqlite3DbstatRegister(db);
3227   }
3228 #endif
3229 
3230 #ifdef SQLITE_ENABLE_JSON1
3231   if( !db->mallocFailed && rc==SQLITE_OK){
3232     rc = sqlite3Json1Init(db);
3233   }
3234 #endif
3235 
3236 #ifdef SQLITE_ENABLE_STMTVTAB
3237   if( !db->mallocFailed && rc==SQLITE_OK){
3238     rc = sqlite3StmtVtabInit(db);
3239   }
3240 #endif
3241 
3242   /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3243   ** mode.  -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3244   ** mode.  Doing nothing at all also makes NORMAL the default.
3245   */
3246 #ifdef SQLITE_DEFAULT_LOCKING_MODE
3247   db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3248   sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3249                           SQLITE_DEFAULT_LOCKING_MODE);
3250 #endif
3251 
3252   if( rc ) sqlite3Error(db, rc);
3253 
3254   /* Enable the lookaside-malloc subsystem */
3255   setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3256                         sqlite3GlobalConfig.nLookaside);
3257 
3258   sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
3259 
3260 opendb_out:
3261   if( db ){
3262     assert( db->mutex!=0 || isThreadsafe==0
3263            || sqlite3GlobalConfig.bFullMutex==0 );
3264     sqlite3_mutex_leave(db->mutex);
3265   }
3266   rc = sqlite3_errcode(db);
3267   assert( db!=0 || rc==SQLITE_NOMEM );
3268   if( rc==SQLITE_NOMEM ){
3269     sqlite3_close(db);
3270     db = 0;
3271   }else if( rc!=SQLITE_OK ){
3272     db->magic = SQLITE_MAGIC_SICK;
3273   }
3274   *ppDb = db;
3275 #ifdef SQLITE_ENABLE_SQLLOG
3276   if( sqlite3GlobalConfig.xSqllog ){
3277     /* Opening a db handle. Fourth parameter is passed 0. */
3278     void *pArg = sqlite3GlobalConfig.pSqllogArg;
3279     sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
3280   }
3281 #endif
3282 #if defined(SQLITE_HAS_CODEC)
3283   if( rc==SQLITE_OK ){
3284     const char *zKey;
3285     if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){
3286       u8 iByte;
3287       int i;
3288       char zDecoded[40];
3289       for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
3290         iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
3291         if( (i&1)!=0 ) zDecoded[i/2] = iByte;
3292       }
3293       sqlite3_key_v2(db, 0, zDecoded, i/2);
3294     }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
3295       sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
3296     }
3297   }
3298 #endif
3299   sqlite3_free(zOpen);
3300   return rc & 0xff;
3301 }
3302 
3303 /*
3304 ** Open a new database handle.
3305 */
3306 int sqlite3_open(
3307   const char *zFilename,
3308   sqlite3 **ppDb
3309 ){
3310   return openDatabase(zFilename, ppDb,
3311                       SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3312 }
3313 int sqlite3_open_v2(
3314   const char *filename,   /* Database filename (UTF-8) */
3315   sqlite3 **ppDb,         /* OUT: SQLite db handle */
3316   int flags,              /* Flags */
3317   const char *zVfs        /* Name of VFS module to use */
3318 ){
3319   return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
3320 }
3321 
3322 #ifndef SQLITE_OMIT_UTF16
3323 /*
3324 ** Open a new database handle.
3325 */
3326 int sqlite3_open16(
3327   const void *zFilename,
3328   sqlite3 **ppDb
3329 ){
3330   char const *zFilename8;   /* zFilename encoded in UTF-8 instead of UTF-16 */
3331   sqlite3_value *pVal;
3332   int rc;
3333 
3334 #ifdef SQLITE_ENABLE_API_ARMOR
3335   if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3336 #endif
3337   *ppDb = 0;
3338 #ifndef SQLITE_OMIT_AUTOINIT
3339   rc = sqlite3_initialize();
3340   if( rc ) return rc;
3341 #endif
3342   if( zFilename==0 ) zFilename = "\000\000";
3343   pVal = sqlite3ValueNew(0);
3344   sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3345   zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
3346   if( zFilename8 ){
3347     rc = openDatabase(zFilename8, ppDb,
3348                       SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3349     assert( *ppDb || rc==SQLITE_NOMEM );
3350     if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
3351       SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
3352     }
3353   }else{
3354     rc = SQLITE_NOMEM_BKPT;
3355   }
3356   sqlite3ValueFree(pVal);
3357 
3358   return rc & 0xff;
3359 }
3360 #endif /* SQLITE_OMIT_UTF16 */
3361 
3362 /*
3363 ** Register a new collation sequence with the database handle db.
3364 */
3365 int sqlite3_create_collation(
3366   sqlite3* db,
3367   const char *zName,
3368   int enc,
3369   void* pCtx,
3370   int(*xCompare)(void*,int,const void*,int,const void*)
3371 ){
3372   return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
3373 }
3374 
3375 /*
3376 ** Register a new collation sequence with the database handle db.
3377 */
3378 int sqlite3_create_collation_v2(
3379   sqlite3* db,
3380   const char *zName,
3381   int enc,
3382   void* pCtx,
3383   int(*xCompare)(void*,int,const void*,int,const void*),
3384   void(*xDel)(void*)
3385 ){
3386   int rc;
3387 
3388 #ifdef SQLITE_ENABLE_API_ARMOR
3389   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3390 #endif
3391   sqlite3_mutex_enter(db->mutex);
3392   assert( !db->mallocFailed );
3393   rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
3394   rc = sqlite3ApiExit(db, rc);
3395   sqlite3_mutex_leave(db->mutex);
3396   return rc;
3397 }
3398 
3399 #ifndef SQLITE_OMIT_UTF16
3400 /*
3401 ** Register a new collation sequence with the database handle db.
3402 */
3403 int sqlite3_create_collation16(
3404   sqlite3* db,
3405   const void *zName,
3406   int enc,
3407   void* pCtx,
3408   int(*xCompare)(void*,int,const void*,int,const void*)
3409 ){
3410   int rc = SQLITE_OK;
3411   char *zName8;
3412 
3413 #ifdef SQLITE_ENABLE_API_ARMOR
3414   if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3415 #endif
3416   sqlite3_mutex_enter(db->mutex);
3417   assert( !db->mallocFailed );
3418   zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
3419   if( zName8 ){
3420     rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
3421     sqlite3DbFree(db, zName8);
3422   }
3423   rc = sqlite3ApiExit(db, rc);
3424   sqlite3_mutex_leave(db->mutex);
3425   return rc;
3426 }
3427 #endif /* SQLITE_OMIT_UTF16 */
3428 
3429 /*
3430 ** Register a collation sequence factory callback with the database handle
3431 ** db. Replace any previously installed collation sequence factory.
3432 */
3433 int sqlite3_collation_needed(
3434   sqlite3 *db,
3435   void *pCollNeededArg,
3436   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3437 ){
3438 #ifdef SQLITE_ENABLE_API_ARMOR
3439   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3440 #endif
3441   sqlite3_mutex_enter(db->mutex);
3442   db->xCollNeeded = xCollNeeded;
3443   db->xCollNeeded16 = 0;
3444   db->pCollNeededArg = pCollNeededArg;
3445   sqlite3_mutex_leave(db->mutex);
3446   return SQLITE_OK;
3447 }
3448 
3449 #ifndef SQLITE_OMIT_UTF16
3450 /*
3451 ** Register a collation sequence factory callback with the database handle
3452 ** db. Replace any previously installed collation sequence factory.
3453 */
3454 int sqlite3_collation_needed16(
3455   sqlite3 *db,
3456   void *pCollNeededArg,
3457   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3458 ){
3459 #ifdef SQLITE_ENABLE_API_ARMOR
3460   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3461 #endif
3462   sqlite3_mutex_enter(db->mutex);
3463   db->xCollNeeded = 0;
3464   db->xCollNeeded16 = xCollNeeded16;
3465   db->pCollNeededArg = pCollNeededArg;
3466   sqlite3_mutex_leave(db->mutex);
3467   return SQLITE_OK;
3468 }
3469 #endif /* SQLITE_OMIT_UTF16 */
3470 
3471 #ifndef SQLITE_OMIT_DEPRECATED
3472 /*
3473 ** This function is now an anachronism. It used to be used to recover from a
3474 ** malloc() failure, but SQLite now does this automatically.
3475 */
3476 int sqlite3_global_recover(void){
3477   return SQLITE_OK;
3478 }
3479 #endif
3480 
3481 /*
3482 ** Test to see whether or not the database connection is in autocommit
3483 ** mode.  Return TRUE if it is and FALSE if not.  Autocommit mode is on
3484 ** by default.  Autocommit is disabled by a BEGIN statement and reenabled
3485 ** by the next COMMIT or ROLLBACK.
3486 */
3487 int sqlite3_get_autocommit(sqlite3 *db){
3488 #ifdef SQLITE_ENABLE_API_ARMOR
3489   if( !sqlite3SafetyCheckOk(db) ){
3490     (void)SQLITE_MISUSE_BKPT;
3491     return 0;
3492   }
3493 #endif
3494   return db->autoCommit;
3495 }
3496 
3497 /*
3498 ** The following routines are substitutes for constants SQLITE_CORRUPT,
3499 ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
3500 ** constants.  They serve two purposes:
3501 **
3502 **   1.  Serve as a convenient place to set a breakpoint in a debugger
3503 **       to detect when version error conditions occurs.
3504 **
3505 **   2.  Invoke sqlite3_log() to provide the source code location where
3506 **       a low-level error is first detected.
3507 */
3508 int sqlite3ReportError(int iErr, int lineno, const char *zType){
3509   sqlite3_log(iErr, "%s at line %d of [%.10s]",
3510               zType, lineno, 20+sqlite3_sourceid());
3511   return iErr;
3512 }
3513 int sqlite3CorruptError(int lineno){
3514   testcase( sqlite3GlobalConfig.xLog!=0 );
3515   return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
3516 }
3517 int sqlite3MisuseError(int lineno){
3518   testcase( sqlite3GlobalConfig.xLog!=0 );
3519   return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
3520 }
3521 int sqlite3CantopenError(int lineno){
3522   testcase( sqlite3GlobalConfig.xLog!=0 );
3523   return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
3524 }
3525 #ifdef SQLITE_DEBUG
3526 int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3527   char zMsg[100];
3528   sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3529   testcase( sqlite3GlobalConfig.xLog!=0 );
3530   return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
3531 }
3532 int sqlite3NomemError(int lineno){
3533   testcase( sqlite3GlobalConfig.xLog!=0 );
3534   return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
3535 }
3536 int sqlite3IoerrnomemError(int lineno){
3537   testcase( sqlite3GlobalConfig.xLog!=0 );
3538   return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
3539 }
3540 #endif
3541 
3542 #ifndef SQLITE_OMIT_DEPRECATED
3543 /*
3544 ** This is a convenience routine that makes sure that all thread-specific
3545 ** data for this thread has been deallocated.
3546 **
3547 ** SQLite no longer uses thread-specific data so this routine is now a
3548 ** no-op.  It is retained for historical compatibility.
3549 */
3550 void sqlite3_thread_cleanup(void){
3551 }
3552 #endif
3553 
3554 /*
3555 ** Return meta information about a specific column of a database table.
3556 ** See comment in sqlite3.h (sqlite.h.in) for details.
3557 */
3558 int sqlite3_table_column_metadata(
3559   sqlite3 *db,                /* Connection handle */
3560   const char *zDbName,        /* Database name or NULL */
3561   const char *zTableName,     /* Table name */
3562   const char *zColumnName,    /* Column name */
3563   char const **pzDataType,    /* OUTPUT: Declared data type */
3564   char const **pzCollSeq,     /* OUTPUT: Collation sequence name */
3565   int *pNotNull,              /* OUTPUT: True if NOT NULL constraint exists */
3566   int *pPrimaryKey,           /* OUTPUT: True if column part of PK */
3567   int *pAutoinc               /* OUTPUT: True if column is auto-increment */
3568 ){
3569   int rc;
3570   char *zErrMsg = 0;
3571   Table *pTab = 0;
3572   Column *pCol = 0;
3573   int iCol = 0;
3574   char const *zDataType = 0;
3575   char const *zCollSeq = 0;
3576   int notnull = 0;
3577   int primarykey = 0;
3578   int autoinc = 0;
3579 
3580 
3581 #ifdef SQLITE_ENABLE_API_ARMOR
3582   if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3583     return SQLITE_MISUSE_BKPT;
3584   }
3585 #endif
3586 
3587   /* Ensure the database schema has been loaded */
3588   sqlite3_mutex_enter(db->mutex);
3589   sqlite3BtreeEnterAll(db);
3590   rc = sqlite3Init(db, &zErrMsg);
3591   if( SQLITE_OK!=rc ){
3592     goto error_out;
3593   }
3594 
3595   /* Locate the table in question */
3596   pTab = sqlite3FindTable(db, zTableName, zDbName);
3597   if( !pTab || pTab->pSelect ){
3598     pTab = 0;
3599     goto error_out;
3600   }
3601 
3602   /* Find the column for which info is requested */
3603   if( zColumnName==0 ){
3604     /* Query for existance of table only */
3605   }else{
3606     for(iCol=0; iCol<pTab->nCol; iCol++){
3607       pCol = &pTab->aCol[iCol];
3608       if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
3609         break;
3610       }
3611     }
3612     if( iCol==pTab->nCol ){
3613       if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3614         iCol = pTab->iPKey;
3615         pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3616       }else{
3617         pTab = 0;
3618         goto error_out;
3619       }
3620     }
3621   }
3622 
3623   /* The following block stores the meta information that will be returned
3624   ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3625   ** and autoinc. At this point there are two possibilities:
3626   **
3627   **     1. The specified column name was rowid", "oid" or "_rowid_"
3628   **        and there is no explicitly declared IPK column.
3629   **
3630   **     2. The table is not a view and the column name identified an
3631   **        explicitly declared column. Copy meta information from *pCol.
3632   */
3633   if( pCol ){
3634     zDataType = sqlite3ColumnType(pCol,0);
3635     zCollSeq = pCol->zColl;
3636     notnull = pCol->notNull!=0;
3637     primarykey  = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
3638     autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
3639   }else{
3640     zDataType = "INTEGER";
3641     primarykey = 1;
3642   }
3643   if( !zCollSeq ){
3644     zCollSeq = sqlite3StrBINARY;
3645   }
3646 
3647 error_out:
3648   sqlite3BtreeLeaveAll(db);
3649 
3650   /* Whether the function call succeeded or failed, set the output parameters
3651   ** to whatever their local counterparts contain. If an error did occur,
3652   ** this has the effect of zeroing all output parameters.
3653   */
3654   if( pzDataType ) *pzDataType = zDataType;
3655   if( pzCollSeq ) *pzCollSeq = zCollSeq;
3656   if( pNotNull ) *pNotNull = notnull;
3657   if( pPrimaryKey ) *pPrimaryKey = primarykey;
3658   if( pAutoinc ) *pAutoinc = autoinc;
3659 
3660   if( SQLITE_OK==rc && !pTab ){
3661     sqlite3DbFree(db, zErrMsg);
3662     zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
3663         zColumnName);
3664     rc = SQLITE_ERROR;
3665   }
3666   sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
3667   sqlite3DbFree(db, zErrMsg);
3668   rc = sqlite3ApiExit(db, rc);
3669   sqlite3_mutex_leave(db->mutex);
3670   return rc;
3671 }
3672 
3673 /*
3674 ** Sleep for a little while.  Return the amount of time slept.
3675 */
3676 int sqlite3_sleep(int ms){
3677   sqlite3_vfs *pVfs;
3678   int rc;
3679   pVfs = sqlite3_vfs_find(0);
3680   if( pVfs==0 ) return 0;
3681 
3682   /* This function works in milliseconds, but the underlying OsSleep()
3683   ** API uses microseconds. Hence the 1000's.
3684   */
3685   rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
3686   return rc;
3687 }
3688 
3689 /*
3690 ** Enable or disable the extended result codes.
3691 */
3692 int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
3693 #ifdef SQLITE_ENABLE_API_ARMOR
3694   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3695 #endif
3696   sqlite3_mutex_enter(db->mutex);
3697   db->errMask = onoff ? 0xffffffff : 0xff;
3698   sqlite3_mutex_leave(db->mutex);
3699   return SQLITE_OK;
3700 }
3701 
3702 /*
3703 ** Invoke the xFileControl method on a particular database.
3704 */
3705 int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3706   int rc = SQLITE_ERROR;
3707   Btree *pBtree;
3708 
3709 #ifdef SQLITE_ENABLE_API_ARMOR
3710   if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3711 #endif
3712   sqlite3_mutex_enter(db->mutex);
3713   pBtree = sqlite3DbNameToBtree(db, zDbName);
3714   if( pBtree ){
3715     Pager *pPager;
3716     sqlite3_file *fd;
3717     sqlite3BtreeEnter(pBtree);
3718     pPager = sqlite3BtreePager(pBtree);
3719     assert( pPager!=0 );
3720     fd = sqlite3PagerFile(pPager);
3721     assert( fd!=0 );
3722     if( op==SQLITE_FCNTL_FILE_POINTER ){
3723       *(sqlite3_file**)pArg = fd;
3724       rc = SQLITE_OK;
3725     }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3726       *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3727       rc = SQLITE_OK;
3728     }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3729       *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3730       rc = SQLITE_OK;
3731     }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3732       *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3733       rc = SQLITE_OK;
3734     }else{
3735       rc = sqlite3OsFileControl(fd, op, pArg);
3736     }
3737     sqlite3BtreeLeave(pBtree);
3738   }
3739   sqlite3_mutex_leave(db->mutex);
3740   return rc;
3741 }
3742 
3743 /*
3744 ** Interface to the testing logic.
3745 */
3746 int sqlite3_test_control(int op, ...){
3747   int rc = 0;
3748 #ifdef SQLITE_UNTESTABLE
3749   UNUSED_PARAMETER(op);
3750 #else
3751   va_list ap;
3752   va_start(ap, op);
3753   switch( op ){
3754 
3755     /*
3756     ** Save the current state of the PRNG.
3757     */
3758     case SQLITE_TESTCTRL_PRNG_SAVE: {
3759       sqlite3PrngSaveState();
3760       break;
3761     }
3762 
3763     /*
3764     ** Restore the state of the PRNG to the last state saved using
3765     ** PRNG_SAVE.  If PRNG_SAVE has never before been called, then
3766     ** this verb acts like PRNG_RESET.
3767     */
3768     case SQLITE_TESTCTRL_PRNG_RESTORE: {
3769       sqlite3PrngRestoreState();
3770       break;
3771     }
3772 
3773     /*
3774     ** Reset the PRNG back to its uninitialized state.  The next call
3775     ** to sqlite3_randomness() will reseed the PRNG using a single call
3776     ** to the xRandomness method of the default VFS.
3777     */
3778     case SQLITE_TESTCTRL_PRNG_RESET: {
3779       sqlite3_randomness(0,0);
3780       break;
3781     }
3782 
3783     /*
3784     **  sqlite3_test_control(BITVEC_TEST, size, program)
3785     **
3786     ** Run a test against a Bitvec object of size.  The program argument
3787     ** is an array of integers that defines the test.  Return -1 on a
3788     ** memory allocation error, 0 on success, or non-zero for an error.
3789     ** See the sqlite3BitvecBuiltinTest() for additional information.
3790     */
3791     case SQLITE_TESTCTRL_BITVEC_TEST: {
3792       int sz = va_arg(ap, int);
3793       int *aProg = va_arg(ap, int*);
3794       rc = sqlite3BitvecBuiltinTest(sz, aProg);
3795       break;
3796     }
3797 
3798     /*
3799     **  sqlite3_test_control(FAULT_INSTALL, xCallback)
3800     **
3801     ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3802     ** if xCallback is not NULL.
3803     **
3804     ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3805     ** is called immediately after installing the new callback and the return
3806     ** value from sqlite3FaultSim(0) becomes the return from
3807     ** sqlite3_test_control().
3808     */
3809     case SQLITE_TESTCTRL_FAULT_INSTALL: {
3810       /* MSVC is picky about pulling func ptrs from va lists.
3811       ** http://support.microsoft.com/kb/47961
3812       ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
3813       */
3814       typedef int(*TESTCALLBACKFUNC_t)(int);
3815       sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
3816       rc = sqlite3FaultSim(0);
3817       break;
3818     }
3819 
3820     /*
3821     **  sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3822     **
3823     ** Register hooks to call to indicate which malloc() failures
3824     ** are benign.
3825     */
3826     case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
3827       typedef void (*void_function)(void);
3828       void_function xBenignBegin;
3829       void_function xBenignEnd;
3830       xBenignBegin = va_arg(ap, void_function);
3831       xBenignEnd = va_arg(ap, void_function);
3832       sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
3833       break;
3834     }
3835 
3836     /*
3837     **  sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
3838     **
3839     ** Set the PENDING byte to the value in the argument, if X>0.
3840     ** Make no changes if X==0.  Return the value of the pending byte
3841     ** as it existing before this routine was called.
3842     **
3843     ** IMPORTANT:  Changing the PENDING byte from 0x40000000 results in
3844     ** an incompatible database file format.  Changing the PENDING byte
3845     ** while any database connection is open results in undefined and
3846     ** deleterious behavior.
3847     */
3848     case SQLITE_TESTCTRL_PENDING_BYTE: {
3849       rc = PENDING_BYTE;
3850 #ifndef SQLITE_OMIT_WSD
3851       {
3852         unsigned int newVal = va_arg(ap, unsigned int);
3853         if( newVal ) sqlite3PendingByte = newVal;
3854       }
3855 #endif
3856       break;
3857     }
3858 
3859     /*
3860     **  sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3861     **
3862     ** This action provides a run-time test to see whether or not
3863     ** assert() was enabled at compile-time.  If X is true and assert()
3864     ** is enabled, then the return value is true.  If X is true and
3865     ** assert() is disabled, then the return value is zero.  If X is
3866     ** false and assert() is enabled, then the assertion fires and the
3867     ** process aborts.  If X is false and assert() is disabled, then the
3868     ** return value is zero.
3869     */
3870     case SQLITE_TESTCTRL_ASSERT: {
3871       volatile int x = 0;
3872       assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
3873       rc = x;
3874       break;
3875     }
3876 
3877 
3878     /*
3879     **  sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3880     **
3881     ** This action provides a run-time test to see how the ALWAYS and
3882     ** NEVER macros were defined at compile-time.
3883     **
3884     ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
3885     **
3886     ** The recommended test is X==2.  If the return value is 2, that means
3887     ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3888     ** default setting.  If the return value is 1, then ALWAYS() is either
3889     ** hard-coded to true or else it asserts if its argument is false.
3890     ** The first behavior (hard-coded to true) is the case if
3891     ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3892     ** behavior (assert if the argument to ALWAYS() is false) is the case if
3893     ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3894     **
3895     ** The run-time test procedure might look something like this:
3896     **
3897     **    if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3898     **      // ALWAYS() and NEVER() are no-op pass-through macros
3899     **    }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3900     **      // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3901     **    }else{
3902     **      // ALWAYS(x) is a constant 1.  NEVER(x) is a constant 0.
3903     **    }
3904     */
3905     case SQLITE_TESTCTRL_ALWAYS: {
3906       int x = va_arg(ap,int);
3907       rc = x ? ALWAYS(x) : 0;
3908       break;
3909     }
3910 
3911     /*
3912     **   sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3913     **
3914     ** The integer returned reveals the byte-order of the computer on which
3915     ** SQLite is running:
3916     **
3917     **       1     big-endian,    determined at run-time
3918     **      10     little-endian, determined at run-time
3919     **  432101     big-endian,    determined at compile-time
3920     **  123410     little-endian, determined at compile-time
3921     */
3922     case SQLITE_TESTCTRL_BYTEORDER: {
3923       rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
3924       break;
3925     }
3926 
3927     /*   sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3928     **
3929     ** Set the nReserve size to N for the main database on the database
3930     ** connection db.
3931     */
3932     case SQLITE_TESTCTRL_RESERVE: {
3933       sqlite3 *db = va_arg(ap, sqlite3*);
3934       int x = va_arg(ap,int);
3935       sqlite3_mutex_enter(db->mutex);
3936       sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
3937       sqlite3_mutex_leave(db->mutex);
3938       break;
3939     }
3940 
3941     /*  sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3942     **
3943     ** Enable or disable various optimizations for testing purposes.  The
3944     ** argument N is a bitmask of optimizations to be disabled.  For normal
3945     ** operation N should be 0.  The idea is that a test program (like the
3946     ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3947     ** with various optimizations disabled to verify that the same answer
3948     ** is obtained in every case.
3949     */
3950     case SQLITE_TESTCTRL_OPTIMIZATIONS: {
3951       sqlite3 *db = va_arg(ap, sqlite3*);
3952       db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
3953       break;
3954     }
3955 
3956     /*   sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3957     **
3958     ** If parameter onoff is non-zero, subsequent calls to localtime()
3959     ** and its variants fail. If onoff is zero, undo this setting.
3960     */
3961     case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
3962       sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
3963       break;
3964     }
3965 
3966     /*   sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCS, int onoff);
3967     **
3968     ** If parameter onoff is non-zero, internal-use-only SQL functions
3969     ** are visible to ordinary SQL.  This is useful for testing but is
3970     ** unsafe because invalid parameters to those internal-use-only functions
3971     ** can result in crashes or segfaults.
3972     */
3973     case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
3974       sqlite3GlobalConfig.bInternalFunctions = va_arg(ap, int);
3975       break;
3976     }
3977 
3978     /*   sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3979     **
3980     ** Set or clear a flag that indicates that the database file is always well-
3981     ** formed and never corrupt.  This flag is clear by default, indicating that
3982     ** database files might have arbitrary corruption.  Setting the flag during
3983     ** testing causes certain assert() statements in the code to be activated
3984     ** that demonstrat invariants on well-formed database files.
3985     */
3986     case SQLITE_TESTCTRL_NEVER_CORRUPT: {
3987       sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
3988       break;
3989     }
3990 
3991     /* Set the threshold at which OP_Once counters reset back to zero.
3992     ** By default this is 0x7ffffffe (over 2 billion), but that value is
3993     ** too big to test in a reasonable amount of time, so this control is
3994     ** provided to set a small and easily reachable reset value.
3995     */
3996     case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
3997       sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
3998       break;
3999     }
4000 
4001     /*   sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4002     **
4003     ** Set the VDBE coverage callback function to xCallback with context
4004     ** pointer ptr.
4005     */
4006     case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4007 #ifdef SQLITE_VDBE_COVERAGE
4008       typedef void (*branch_callback)(void*,unsigned int,
4009                                       unsigned char,unsigned char);
4010       sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4011       sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4012 #endif
4013       break;
4014     }
4015 
4016     /*   sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4017     case SQLITE_TESTCTRL_SORTER_MMAP: {
4018       sqlite3 *db = va_arg(ap, sqlite3*);
4019       db->nMaxSorterMmap = va_arg(ap, int);
4020       break;
4021     }
4022 
4023     /*   sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4024     **
4025     ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4026     ** not.
4027     */
4028     case SQLITE_TESTCTRL_ISINIT: {
4029       if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4030       break;
4031     }
4032 
4033     /*  sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
4034     **
4035     ** This test control is used to create imposter tables.  "db" is a pointer
4036     ** to the database connection.  dbName is the database name (ex: "main" or
4037     ** "temp") which will receive the imposter.  "onOff" turns imposter mode on
4038     ** or off.  "tnum" is the root page of the b-tree to which the imposter
4039     ** table should connect.
4040     **
4041     ** Enable imposter mode only when the schema has already been parsed.  Then
4042     ** run a single CREATE TABLE statement to construct the imposter table in
4043     ** the parsed schema.  Then turn imposter mode back off again.
4044     **
4045     ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4046     ** the schema to be reparsed the next time it is needed.  This has the
4047     ** effect of erasing all imposter tables.
4048     */
4049     case SQLITE_TESTCTRL_IMPOSTER: {
4050       sqlite3 *db = va_arg(ap, sqlite3*);
4051       sqlite3_mutex_enter(db->mutex);
4052       db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4053       db->init.busy = db->init.imposterTable = va_arg(ap,int);
4054       db->init.newTnum = va_arg(ap,int);
4055       if( db->init.busy==0 && db->init.newTnum>0 ){
4056         sqlite3ResetAllSchemasOfConnection(db);
4057       }
4058       sqlite3_mutex_leave(db->mutex);
4059       break;
4060     }
4061 
4062 #if defined(YYCOVERAGE)
4063     /*  sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4064     **
4065     ** This test control (only available when SQLite is compiled with
4066     ** -DYYCOVERAGE) writes a report onto "out" that shows all
4067     ** state/lookahead combinations in the parser state machine
4068     ** which are never exercised.  If any state is missed, make the
4069     ** return code SQLITE_ERROR.
4070     */
4071     case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4072       FILE *out = va_arg(ap, FILE*);
4073       if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4074       break;
4075     }
4076 #endif /* defined(YYCOVERAGE) */
4077   }
4078   va_end(ap);
4079 #endif /* SQLITE_UNTESTABLE */
4080   return rc;
4081 }
4082 
4083 /*
4084 ** This is a utility routine, useful to VFS implementations, that checks
4085 ** to see if a database file was a URI that contained a specific query
4086 ** parameter, and if so obtains the value of the query parameter.
4087 **
4088 ** The zFilename argument is the filename pointer passed into the xOpen()
4089 ** method of a VFS implementation.  The zParam argument is the name of the
4090 ** query parameter we seek.  This routine returns the value of the zParam
4091 ** parameter if it exists.  If the parameter does not exist, this routine
4092 ** returns a NULL pointer.
4093 */
4094 const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
4095   if( zFilename==0 || zParam==0 ) return 0;
4096   zFilename += sqlite3Strlen30(zFilename) + 1;
4097   while( zFilename[0] ){
4098     int x = strcmp(zFilename, zParam);
4099     zFilename += sqlite3Strlen30(zFilename) + 1;
4100     if( x==0 ) return zFilename;
4101     zFilename += sqlite3Strlen30(zFilename) + 1;
4102   }
4103   return 0;
4104 }
4105 
4106 /*
4107 ** Return a boolean value for a query parameter.
4108 */
4109 int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4110   const char *z = sqlite3_uri_parameter(zFilename, zParam);
4111   bDflt = bDflt!=0;
4112   return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
4113 }
4114 
4115 /*
4116 ** Return a 64-bit integer value for a query parameter.
4117 */
4118 sqlite3_int64 sqlite3_uri_int64(
4119   const char *zFilename,    /* Filename as passed to xOpen */
4120   const char *zParam,       /* URI parameter sought */
4121   sqlite3_int64 bDflt       /* return if parameter is missing */
4122 ){
4123   const char *z = sqlite3_uri_parameter(zFilename, zParam);
4124   sqlite3_int64 v;
4125   if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
4126     bDflt = v;
4127   }
4128   return bDflt;
4129 }
4130 
4131 /*
4132 ** Return the Btree pointer identified by zDbName.  Return NULL if not found.
4133 */
4134 Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
4135   int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4136   return iDb<0 ? 0 : db->aDb[iDb].pBt;
4137 }
4138 
4139 /*
4140 ** Return the filename of the database associated with a database
4141 ** connection.
4142 */
4143 const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
4144   Btree *pBt;
4145 #ifdef SQLITE_ENABLE_API_ARMOR
4146   if( !sqlite3SafetyCheckOk(db) ){
4147     (void)SQLITE_MISUSE_BKPT;
4148     return 0;
4149   }
4150 #endif
4151   pBt = sqlite3DbNameToBtree(db, zDbName);
4152   return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4153 }
4154 
4155 /*
4156 ** Return 1 if database is read-only or 0 if read/write.  Return -1 if
4157 ** no such database exists.
4158 */
4159 int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
4160   Btree *pBt;
4161 #ifdef SQLITE_ENABLE_API_ARMOR
4162   if( !sqlite3SafetyCheckOk(db) ){
4163     (void)SQLITE_MISUSE_BKPT;
4164     return -1;
4165   }
4166 #endif
4167   pBt = sqlite3DbNameToBtree(db, zDbName);
4168   return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
4169 }
4170 
4171 #ifdef SQLITE_ENABLE_SNAPSHOT
4172 /*
4173 ** Obtain a snapshot handle for the snapshot of database zDb currently
4174 ** being read by handle db.
4175 */
4176 int sqlite3_snapshot_get(
4177   sqlite3 *db,
4178   const char *zDb,
4179   sqlite3_snapshot **ppSnapshot
4180 ){
4181   int rc = SQLITE_ERROR;
4182 #ifndef SQLITE_OMIT_WAL
4183 
4184 #ifdef SQLITE_ENABLE_API_ARMOR
4185   if( !sqlite3SafetyCheckOk(db) ){
4186     return SQLITE_MISUSE_BKPT;
4187   }
4188 #endif
4189   sqlite3_mutex_enter(db->mutex);
4190 
4191   if( db->autoCommit==0 ){
4192     int iDb = sqlite3FindDbName(db, zDb);
4193     if( iDb==0 || iDb>1 ){
4194       Btree *pBt = db->aDb[iDb].pBt;
4195       if( 0==sqlite3BtreeIsInTrans(pBt) ){
4196         rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4197         if( rc==SQLITE_OK ){
4198           rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4199         }
4200       }
4201     }
4202   }
4203 
4204   sqlite3_mutex_leave(db->mutex);
4205 #endif   /* SQLITE_OMIT_WAL */
4206   return rc;
4207 }
4208 
4209 /*
4210 ** Open a read-transaction on the snapshot idendified by pSnapshot.
4211 */
4212 int sqlite3_snapshot_open(
4213   sqlite3 *db,
4214   const char *zDb,
4215   sqlite3_snapshot *pSnapshot
4216 ){
4217   int rc = SQLITE_ERROR;
4218 #ifndef SQLITE_OMIT_WAL
4219 
4220 #ifdef SQLITE_ENABLE_API_ARMOR
4221   if( !sqlite3SafetyCheckOk(db) ){
4222     return SQLITE_MISUSE_BKPT;
4223   }
4224 #endif
4225   sqlite3_mutex_enter(db->mutex);
4226   if( db->autoCommit==0 ){
4227     int iDb;
4228     iDb = sqlite3FindDbName(db, zDb);
4229     if( iDb==0 || iDb>1 ){
4230       Btree *pBt = db->aDb[iDb].pBt;
4231       if( sqlite3BtreeIsInTrans(pBt)==0 ){
4232         Pager *pPager = sqlite3BtreePager(pBt);
4233         int bUnlock = 0;
4234         if( sqlite3BtreeIsInReadTrans(pBt) ){
4235           if( db->nVdbeActive==0 ){
4236             rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4237             if( rc==SQLITE_OK ){
4238               bUnlock = 1;
4239               rc = sqlite3BtreeCommit(pBt);
4240             }
4241           }
4242         }else{
4243           rc = SQLITE_OK;
4244         }
4245         if( rc==SQLITE_OK ){
4246           rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4247         }
4248         if( rc==SQLITE_OK ){
4249           rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4250           sqlite3PagerSnapshotOpen(pPager, 0);
4251         }
4252         if( bUnlock ){
4253           sqlite3PagerSnapshotUnlock(pPager);
4254         }
4255       }
4256     }
4257   }
4258 
4259   sqlite3_mutex_leave(db->mutex);
4260 #endif   /* SQLITE_OMIT_WAL */
4261   return rc;
4262 }
4263 
4264 /*
4265 ** Recover as many snapshots as possible from the wal file associated with
4266 ** schema zDb of database db.
4267 */
4268 int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4269   int rc = SQLITE_ERROR;
4270   int iDb;
4271 #ifndef SQLITE_OMIT_WAL
4272 
4273 #ifdef SQLITE_ENABLE_API_ARMOR
4274   if( !sqlite3SafetyCheckOk(db) ){
4275     return SQLITE_MISUSE_BKPT;
4276   }
4277 #endif
4278 
4279   sqlite3_mutex_enter(db->mutex);
4280   iDb = sqlite3FindDbName(db, zDb);
4281   if( iDb==0 || iDb>1 ){
4282     Btree *pBt = db->aDb[iDb].pBt;
4283     if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
4284       rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4285       if( rc==SQLITE_OK ){
4286         rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4287         sqlite3BtreeCommit(pBt);
4288       }
4289     }
4290   }
4291   sqlite3_mutex_leave(db->mutex);
4292 #endif   /* SQLITE_OMIT_WAL */
4293   return rc;
4294 }
4295 
4296 /*
4297 ** Free a snapshot handle obtained from sqlite3_snapshot_get().
4298 */
4299 void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4300   sqlite3_free(pSnapshot);
4301 }
4302 #endif /* SQLITE_ENABLE_SNAPSHOT */
4303 
4304 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4305 /*
4306 ** Given the name of a compile-time option, return true if that option
4307 ** was used and false if not.
4308 **
4309 ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4310 ** is not required for a match.
4311 */
4312 int sqlite3_compileoption_used(const char *zOptName){
4313   int i, n;
4314   int nOpt;
4315   const char **azCompileOpt;
4316 
4317 #if SQLITE_ENABLE_API_ARMOR
4318   if( zOptName==0 ){
4319     (void)SQLITE_MISUSE_BKPT;
4320     return 0;
4321   }
4322 #endif
4323 
4324   azCompileOpt = sqlite3CompileOptions(&nOpt);
4325 
4326   if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4327   n = sqlite3Strlen30(zOptName);
4328 
4329   /* Since nOpt is normally in single digits, a linear search is
4330   ** adequate. No need for a binary search. */
4331   for(i=0; i<nOpt; i++){
4332     if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4333      && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4334     ){
4335       return 1;
4336     }
4337   }
4338   return 0;
4339 }
4340 
4341 /*
4342 ** Return the N-th compile-time option string.  If N is out of range,
4343 ** return a NULL pointer.
4344 */
4345 const char *sqlite3_compileoption_get(int N){
4346   int nOpt;
4347   const char **azCompileOpt;
4348   azCompileOpt = sqlite3CompileOptions(&nOpt);
4349   if( N>=0 && N<nOpt ){
4350     return azCompileOpt[N];
4351   }
4352   return 0;
4353 }
4354 #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
4355