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