Snapshot of upstream SQLite 3.41.0
[sqlcipher.git] / src / main.c
blobeaecb56df9f3beee4afafe530ee4600d920fbce7
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.
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.
17 #include "sqliteInt.h"
19 #ifdef SQLITE_ENABLE_FTS3
20 # include "fts3.h"
21 #endif
22 #ifdef SQLITE_ENABLE_RTREE
23 # include "rtree.h"
24 #endif
25 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
26 # include "sqliteicu.h"
27 #endif
30 ** This is an extension initializer that is a no-op and always
31 ** succeeds, except that it fails if the fault-simulation is set
32 ** to 500.
34 static int sqlite3TestExtInit(sqlite3 *db){
35 (void)db;
36 return sqlite3FaultSim(500);
41 ** Forward declarations of external module initializer functions
42 ** for modules that need them.
44 #ifdef SQLITE_ENABLE_FTS1
45 int sqlite3Fts1Init(sqlite3*);
46 #endif
47 #ifdef SQLITE_ENABLE_FTS2
48 int sqlite3Fts2Init(sqlite3*);
49 #endif
50 #ifdef SQLITE_ENABLE_FTS5
51 int sqlite3Fts5Init(sqlite3*);
52 #endif
53 #ifdef SQLITE_ENABLE_STMTVTAB
54 int sqlite3StmtVtabInit(sqlite3*);
55 #endif
58 ** An array of pointers to extension initializer functions for
59 ** built-in extensions.
61 static int (*const sqlite3BuiltinExtensions[])(sqlite3*) = {
62 #ifdef SQLITE_ENABLE_FTS1
63 sqlite3Fts1Init,
64 #endif
65 #ifdef SQLITE_ENABLE_FTS2
66 sqlite3Fts2Init,
67 #endif
68 #ifdef SQLITE_ENABLE_FTS3
69 sqlite3Fts3Init,
70 #endif
71 #ifdef SQLITE_ENABLE_FTS5
72 sqlite3Fts5Init,
73 #endif
74 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
75 sqlite3IcuInit,
76 #endif
77 #ifdef SQLITE_ENABLE_RTREE
78 sqlite3RtreeInit,
79 #endif
80 #ifdef SQLITE_ENABLE_DBPAGE_VTAB
81 sqlite3DbpageRegister,
82 #endif
83 #ifdef SQLITE_ENABLE_DBSTAT_VTAB
84 sqlite3DbstatRegister,
85 #endif
86 sqlite3TestExtInit,
87 #if !defined(SQLITE_OMIT_VIRTUALTABLE) && !defined(SQLITE_OMIT_JSON)
88 sqlite3JsonTableFunctions,
89 #endif
90 #ifdef SQLITE_ENABLE_STMTVTAB
91 sqlite3StmtVtabInit,
92 #endif
93 #ifdef SQLITE_ENABLE_BYTECODE_VTAB
94 sqlite3VdbeBytecodeVtabInit,
95 #endif
98 #ifndef SQLITE_AMALGAMATION
99 /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
100 ** contains the text of SQLITE_VERSION macro.
102 const char sqlite3_version[] = SQLITE_VERSION;
103 #endif
105 /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
106 ** a pointer to the to the sqlite3_version[] string constant.
108 const char *sqlite3_libversion(void){ return sqlite3_version; }
110 /* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
111 ** pointer to a string constant whose value is the same as the
112 ** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
113 ** an edited copy of the amalgamation, then the last four characters of
114 ** the hash might be different from SQLITE_SOURCE_ID.
116 const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
118 /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
119 ** returns an integer equal to SQLITE_VERSION_NUMBER.
121 int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
123 /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
124 ** zero if and only if SQLite was compiled with mutexing code omitted due to
125 ** the SQLITE_THREADSAFE compile-time option being set to 0.
127 int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
130 ** When compiling the test fixture or with debugging enabled (on Win32),
131 ** this variable being set to non-zero will cause OSTRACE macros to emit
132 ** extra diagnostic information.
134 #ifdef SQLITE_HAVE_OS_TRACE
135 # ifndef SQLITE_DEBUG_OS_TRACE
136 # define SQLITE_DEBUG_OS_TRACE 0
137 # endif
138 int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
139 #endif
141 #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
143 ** If the following function pointer is not NULL and if
144 ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
145 ** I/O active are written using this function. These messages
146 ** are intended for debugging activity only.
148 SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
149 #endif
152 ** If the following global variable points to a string which is the
153 ** name of a directory, then that directory will be used to store
154 ** temporary files.
156 ** See also the "PRAGMA temp_store_directory" SQL command.
158 char *sqlite3_temp_directory = 0;
161 ** If the following global variable points to a string which is the
162 ** name of a directory, then that directory will be used to store
163 ** all database files specified with a relative pathname.
165 ** See also the "PRAGMA data_store_directory" SQL command.
167 char *sqlite3_data_directory = 0;
170 ** Initialize SQLite.
172 ** This routine must be called to initialize the memory allocation,
173 ** VFS, and mutex subsystems prior to doing any serious work with
174 ** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
175 ** this routine will be called automatically by key routines such as
176 ** sqlite3_open().
178 ** This routine is a no-op except on its very first call for the process,
179 ** or for the first call after a call to sqlite3_shutdown.
181 ** The first thread to call this routine runs the initialization to
182 ** completion. If subsequent threads call this routine before the first
183 ** thread has finished the initialization process, then the subsequent
184 ** threads must block until the first thread finishes with the initialization.
186 ** The first thread might call this routine recursively. Recursive
187 ** calls to this routine should not block, of course. Otherwise the
188 ** initialization process would never complete.
190 ** Let X be the first thread to enter this routine. Let Y be some other
191 ** thread. Then while the initial invocation of this routine by X is
192 ** incomplete, it is required that:
194 ** * Calls to this routine from Y must block until the outer-most
195 ** call by X completes.
197 ** * Recursive calls to this routine from thread X return immediately
198 ** without blocking.
200 int sqlite3_initialize(void){
201 MUTEX_LOGIC( sqlite3_mutex *pMainMtx; ) /* The main static mutex */
202 int rc; /* Result code */
203 #ifdef SQLITE_EXTRA_INIT
204 int bRunExtraInit = 0; /* Extra initialization needed */
205 #endif
207 #ifdef SQLITE_OMIT_WSD
208 rc = sqlite3_wsd_init(4096, 24);
209 if( rc!=SQLITE_OK ){
210 return rc;
212 #endif
214 /* If the following assert() fails on some obscure processor/compiler
215 ** combination, the work-around is to set the correct pointer
216 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
217 assert( SQLITE_PTRSIZE==sizeof(char*) );
219 /* If SQLite is already completely initialized, then this call
220 ** to sqlite3_initialize() should be a no-op. But the initialization
221 ** must be complete. So isInit must not be set until the very end
222 ** of this routine.
224 if( sqlite3GlobalConfig.isInit ){
225 sqlite3MemoryBarrier();
226 return SQLITE_OK;
229 /* Make sure the mutex subsystem is initialized. If unable to
230 ** initialize the mutex subsystem, return early with the error.
231 ** If the system is so sick that we are unable to allocate a mutex,
232 ** there is not much SQLite is going to be able to do.
234 ** The mutex subsystem must take care of serializing its own
235 ** initialization.
237 rc = sqlite3MutexInit();
238 if( rc ) return rc;
240 /* Initialize the malloc() system and the recursive pInitMutex mutex.
241 ** This operation is protected by the STATIC_MAIN mutex. Note that
242 ** MutexAlloc() is called for a static mutex prior to initializing the
243 ** malloc subsystem - this implies that the allocation of a static
244 ** mutex must not require support from the malloc subsystem.
246 MUTEX_LOGIC( pMainMtx = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN); )
247 sqlite3_mutex_enter(pMainMtx);
248 sqlite3GlobalConfig.isMutexInit = 1;
249 if( !sqlite3GlobalConfig.isMallocInit ){
250 rc = sqlite3MallocInit();
252 if( rc==SQLITE_OK ){
253 sqlite3GlobalConfig.isMallocInit = 1;
254 if( !sqlite3GlobalConfig.pInitMutex ){
255 sqlite3GlobalConfig.pInitMutex =
256 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
257 if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
258 rc = SQLITE_NOMEM_BKPT;
262 if( rc==SQLITE_OK ){
263 sqlite3GlobalConfig.nRefInitMutex++;
265 sqlite3_mutex_leave(pMainMtx);
267 /* If rc is not SQLITE_OK at this point, then either the malloc
268 ** subsystem could not be initialized or the system failed to allocate
269 ** the pInitMutex mutex. Return an error in either case. */
270 if( rc!=SQLITE_OK ){
271 return rc;
274 /* Do the rest of the initialization under the recursive mutex so
275 ** that we will be able to handle recursive calls into
276 ** sqlite3_initialize(). The recursive calls normally come through
277 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
278 ** recursive calls might also be possible.
280 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
281 ** to the xInit method, so the xInit method need not be threadsafe.
283 ** The following mutex is what serializes access to the appdef pcache xInit
284 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
285 ** call to sqlite3PcacheInitialize().
287 sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
288 if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
289 sqlite3GlobalConfig.inProgress = 1;
290 #ifdef SQLITE_ENABLE_SQLLOG
292 extern void sqlite3_init_sqllog(void);
293 sqlite3_init_sqllog();
295 #endif
296 memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
297 sqlite3RegisterBuiltinFunctions();
298 if( sqlite3GlobalConfig.isPCacheInit==0 ){
299 rc = sqlite3PcacheInitialize();
301 if( rc==SQLITE_OK ){
302 sqlite3GlobalConfig.isPCacheInit = 1;
303 rc = sqlite3OsInit();
305 #ifndef SQLITE_OMIT_DESERIALIZE
306 if( rc==SQLITE_OK ){
307 rc = sqlite3MemdbInit();
309 #endif
310 if( rc==SQLITE_OK ){
311 sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
312 sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
313 sqlite3MemoryBarrier();
314 sqlite3GlobalConfig.isInit = 1;
315 #ifdef SQLITE_EXTRA_INIT
316 bRunExtraInit = 1;
317 #endif
319 sqlite3GlobalConfig.inProgress = 0;
321 sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
323 /* Go back under the static mutex and clean up the recursive
324 ** mutex to prevent a resource leak.
326 sqlite3_mutex_enter(pMainMtx);
327 sqlite3GlobalConfig.nRefInitMutex--;
328 if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
329 assert( sqlite3GlobalConfig.nRefInitMutex==0 );
330 sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
331 sqlite3GlobalConfig.pInitMutex = 0;
333 sqlite3_mutex_leave(pMainMtx);
335 /* The following is just a sanity check to make sure SQLite has
336 ** been compiled correctly. It is important to run this code, but
337 ** we don't want to run it too often and soak up CPU cycles for no
338 ** reason. So we run it once during initialization.
340 #ifndef NDEBUG
341 #ifndef SQLITE_OMIT_FLOATING_POINT
342 /* This section of code's only "output" is via assert() statements. */
343 if( rc==SQLITE_OK ){
344 u64 x = (((u64)1)<<63)-1;
345 double y;
346 assert(sizeof(x)==8);
347 assert(sizeof(x)==sizeof(y));
348 memcpy(&y, &x, 8);
349 assert( sqlite3IsNaN(y) );
351 #endif
352 #endif
354 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
355 ** compile-time option.
357 #ifdef SQLITE_EXTRA_INIT
358 if( bRunExtraInit ){
359 int SQLITE_EXTRA_INIT(const char*);
360 rc = SQLITE_EXTRA_INIT(0);
362 #endif
364 return rc;
368 ** Undo the effects of sqlite3_initialize(). Must not be called while
369 ** there are outstanding database connections or memory allocations or
370 ** while any part of SQLite is otherwise in use in any thread. This
371 ** routine is not threadsafe. But it is safe to invoke this routine
372 ** on when SQLite is already shut down. If SQLite is already shut down
373 ** when this routine is invoked, then this routine is a harmless no-op.
375 int sqlite3_shutdown(void){
376 #ifdef SQLITE_OMIT_WSD
377 int rc = sqlite3_wsd_init(4096, 24);
378 if( rc!=SQLITE_OK ){
379 return rc;
381 #endif
383 if( sqlite3GlobalConfig.isInit ){
384 #ifdef SQLITE_EXTRA_SHUTDOWN
385 void SQLITE_EXTRA_SHUTDOWN(void);
386 SQLITE_EXTRA_SHUTDOWN();
387 #endif
388 sqlite3_os_end();
389 sqlite3_reset_auto_extension();
390 sqlite3GlobalConfig.isInit = 0;
392 if( sqlite3GlobalConfig.isPCacheInit ){
393 sqlite3PcacheShutdown();
394 sqlite3GlobalConfig.isPCacheInit = 0;
396 if( sqlite3GlobalConfig.isMallocInit ){
397 sqlite3MallocEnd();
398 sqlite3GlobalConfig.isMallocInit = 0;
400 #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
401 /* The heap subsystem has now been shutdown and these values are supposed
402 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
403 ** which would rely on that heap subsystem; therefore, make sure these
404 ** values cannot refer to heap memory that was just invalidated when the
405 ** heap subsystem was shutdown. This is only done if the current call to
406 ** this function resulted in the heap subsystem actually being shutdown.
408 sqlite3_data_directory = 0;
409 sqlite3_temp_directory = 0;
410 #endif
412 if( sqlite3GlobalConfig.isMutexInit ){
413 sqlite3MutexEnd();
414 sqlite3GlobalConfig.isMutexInit = 0;
417 return SQLITE_OK;
421 ** This API allows applications to modify the global configuration of
422 ** the SQLite library at run-time.
424 ** This routine should only be called when there are no outstanding
425 ** database connections or memory allocations. This routine is not
426 ** threadsafe. Failure to heed these warnings can lead to unpredictable
427 ** behavior.
429 int sqlite3_config(int op, ...){
430 va_list ap;
431 int rc = SQLITE_OK;
433 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
434 ** the SQLite library is in use. */
435 if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
437 va_start(ap, op);
438 switch( op ){
440 /* Mutex configuration options are only available in a threadsafe
441 ** compile.
443 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
444 case SQLITE_CONFIG_SINGLETHREAD: {
445 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
446 ** Single-thread. */
447 sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
448 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
449 break;
451 #endif
452 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
453 case SQLITE_CONFIG_MULTITHREAD: {
454 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
455 ** Multi-thread. */
456 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
457 sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
458 break;
460 #endif
461 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
462 case SQLITE_CONFIG_SERIALIZED: {
463 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
464 ** Serialized. */
465 sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
466 sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
467 break;
469 #endif
470 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
471 case SQLITE_CONFIG_MUTEX: {
472 /* Specify an alternative mutex implementation */
473 sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
474 break;
476 #endif
477 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
478 case SQLITE_CONFIG_GETMUTEX: {
479 /* Retrieve the current mutex implementation */
480 *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
481 break;
483 #endif
485 case SQLITE_CONFIG_MALLOC: {
486 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
487 ** single argument which is a pointer to an instance of the
488 ** sqlite3_mem_methods structure. The argument specifies alternative
489 ** low-level memory allocation routines to be used in place of the memory
490 ** allocation routines built into SQLite. */
491 sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
492 break;
494 case SQLITE_CONFIG_GETMALLOC: {
495 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
496 ** single argument which is a pointer to an instance of the
497 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
498 ** filled with the currently defined memory allocation routines. */
499 if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
500 *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
501 break;
503 case SQLITE_CONFIG_MEMSTATUS: {
504 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
505 ** single argument of type int, interpreted as a boolean, which enables
506 ** or disables the collection of memory allocation statistics. */
507 sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
508 break;
510 case SQLITE_CONFIG_SMALL_MALLOC: {
511 sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
512 break;
514 case SQLITE_CONFIG_PAGECACHE: {
515 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
516 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
517 ** the size of each page cache line (sz), and the number of cache lines
518 ** (N). */
519 sqlite3GlobalConfig.pPage = va_arg(ap, void*);
520 sqlite3GlobalConfig.szPage = va_arg(ap, int);
521 sqlite3GlobalConfig.nPage = va_arg(ap, int);
522 break;
524 case SQLITE_CONFIG_PCACHE_HDRSZ: {
525 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
526 ** a single parameter which is a pointer to an integer and writes into
527 ** that integer the number of extra bytes per page required for each page
528 ** in SQLITE_CONFIG_PAGECACHE. */
529 *va_arg(ap, int*) =
530 sqlite3HeaderSizeBtree() +
531 sqlite3HeaderSizePcache() +
532 sqlite3HeaderSizePcache1();
533 break;
536 case SQLITE_CONFIG_PCACHE: {
537 /* no-op */
538 break;
540 case SQLITE_CONFIG_GETPCACHE: {
541 /* now an error */
542 rc = SQLITE_ERROR;
543 break;
546 case SQLITE_CONFIG_PCACHE2: {
547 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
548 ** single argument which is a pointer to an sqlite3_pcache_methods2
549 ** object. This object specifies the interface to a custom page cache
550 ** implementation. */
551 sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
552 break;
554 case SQLITE_CONFIG_GETPCACHE2: {
555 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
556 ** single argument which is a pointer to an sqlite3_pcache_methods2
557 ** object. SQLite copies of the current page cache implementation into
558 ** that object. */
559 if( sqlite3GlobalConfig.pcache2.xInit==0 ){
560 sqlite3PCacheSetDefault();
562 *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
563 break;
566 /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
567 ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
568 ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
569 #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
570 case SQLITE_CONFIG_HEAP: {
571 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
572 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
573 ** number of bytes in the memory buffer, and the minimum allocation size.
575 sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
576 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
577 sqlite3GlobalConfig.mnReq = va_arg(ap, int);
579 if( sqlite3GlobalConfig.mnReq<1 ){
580 sqlite3GlobalConfig.mnReq = 1;
581 }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
582 /* cap min request size at 2^12 */
583 sqlite3GlobalConfig.mnReq = (1<<12);
586 if( sqlite3GlobalConfig.pHeap==0 ){
587 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
588 ** is NULL, then SQLite reverts to using its default memory allocator
589 ** (the system malloc() implementation), undoing any prior invocation of
590 ** SQLITE_CONFIG_MALLOC.
592 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
593 ** revert to its default implementation when sqlite3_initialize() is run
595 memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
596 }else{
597 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
598 ** alternative memory allocator is engaged to handle all of SQLites
599 ** memory allocation needs. */
600 #ifdef SQLITE_ENABLE_MEMSYS3
601 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
602 #endif
603 #ifdef SQLITE_ENABLE_MEMSYS5
604 sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
605 #endif
607 break;
609 #endif
611 case SQLITE_CONFIG_LOOKASIDE: {
612 sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
613 sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
614 break;
617 /* Record a pointer to the logger function and its first argument.
618 ** The default is NULL. Logging is disabled if the function pointer is
619 ** NULL.
621 case SQLITE_CONFIG_LOG: {
622 /* MSVC is picky about pulling func ptrs from va lists.
623 ** http://support.microsoft.com/kb/47961
624 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
626 typedef void(*LOGFUNC_t)(void*,int,const char*);
627 sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
628 sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
629 break;
632 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
633 ** can be changed at start-time using the
634 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
635 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
637 case SQLITE_CONFIG_URI: {
638 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
639 ** argument of type int. If non-zero, then URI handling is globally
640 ** enabled. If the parameter is zero, then URI handling is globally
641 ** disabled. */
642 sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
643 break;
646 case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
647 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
648 ** option takes a single integer argument which is interpreted as a
649 ** boolean in order to enable or disable the use of covering indices for
650 ** full table scans in the query optimizer. */
651 sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
652 break;
655 #ifdef SQLITE_ENABLE_SQLLOG
656 case SQLITE_CONFIG_SQLLOG: {
657 typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
658 sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
659 sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
660 break;
662 #endif
664 case SQLITE_CONFIG_MMAP_SIZE: {
665 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
666 ** integer (sqlite3_int64) values that are the default mmap size limit
667 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
668 ** mmap size limit. */
669 sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
670 sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
671 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
672 ** negative, then that argument is changed to its compile-time default.
674 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
675 ** silently truncated if necessary so that it does not exceed the
676 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
677 ** compile-time option.
679 if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
680 mxMmap = SQLITE_MAX_MMAP_SIZE;
682 if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
683 if( szMmap>mxMmap) szMmap = mxMmap;
684 sqlite3GlobalConfig.mxMmap = mxMmap;
685 sqlite3GlobalConfig.szMmap = szMmap;
686 break;
689 #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
690 case SQLITE_CONFIG_WIN32_HEAPSIZE: {
691 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
692 ** unsigned integer value that specifies the maximum size of the created
693 ** heap. */
694 sqlite3GlobalConfig.nHeap = va_arg(ap, int);
695 break;
697 #endif
699 case SQLITE_CONFIG_PMASZ: {
700 sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
701 break;
704 case SQLITE_CONFIG_STMTJRNL_SPILL: {
705 sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
706 break;
709 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
710 case SQLITE_CONFIG_SORTERREF_SIZE: {
711 int iVal = va_arg(ap, int);
712 if( iVal<0 ){
713 iVal = SQLITE_DEFAULT_SORTERREF_SIZE;
715 sqlite3GlobalConfig.szSorterRef = (u32)iVal;
716 break;
718 #endif /* SQLITE_ENABLE_SORTER_REFERENCES */
720 #ifndef SQLITE_OMIT_DESERIALIZE
721 case SQLITE_CONFIG_MEMDB_MAXSIZE: {
722 sqlite3GlobalConfig.mxMemdbSize = va_arg(ap, sqlite3_int64);
723 break;
725 #endif /* SQLITE_OMIT_DESERIALIZE */
727 default: {
728 rc = SQLITE_ERROR;
729 break;
732 va_end(ap);
733 return rc;
737 ** Set up the lookaside buffers for a database connection.
738 ** Return SQLITE_OK on success.
739 ** If lookaside is already active, return SQLITE_BUSY.
741 ** The sz parameter is the number of bytes in each lookaside slot.
742 ** The cnt parameter is the number of slots. If pStart is NULL the
743 ** space for the lookaside memory is obtained from sqlite3_malloc().
744 ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
745 ** the lookaside memory.
747 static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
748 #ifndef SQLITE_OMIT_LOOKASIDE
749 void *pStart;
750 sqlite3_int64 szAlloc = sz*(sqlite3_int64)cnt;
751 int nBig; /* Number of full-size slots */
752 int nSm; /* Number smaller LOOKASIDE_SMALL-byte slots */
754 if( sqlite3LookasideUsed(db,0)>0 ){
755 return SQLITE_BUSY;
757 /* Free any existing lookaside buffer for this handle before
758 ** allocating a new one so we don't have to have space for
759 ** both at the same time.
761 if( db->lookaside.bMalloced ){
762 sqlite3_free(db->lookaside.pStart);
764 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
765 ** than a pointer to be useful.
767 sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
768 if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
769 if( cnt<0 ) cnt = 0;
770 if( sz==0 || cnt==0 ){
771 sz = 0;
772 pStart = 0;
773 }else if( pBuf==0 ){
774 sqlite3BeginBenignMalloc();
775 pStart = sqlite3Malloc( szAlloc ); /* IMP: R-61949-35727 */
776 sqlite3EndBenignMalloc();
777 if( pStart ) szAlloc = sqlite3MallocSize(pStart);
778 }else{
779 pStart = pBuf;
781 #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
782 if( sz>=LOOKASIDE_SMALL*3 ){
783 nBig = szAlloc/(3*LOOKASIDE_SMALL+sz);
784 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
785 }else if( sz>=LOOKASIDE_SMALL*2 ){
786 nBig = szAlloc/(LOOKASIDE_SMALL+sz);
787 nSm = (szAlloc - sz*nBig)/LOOKASIDE_SMALL;
788 }else
789 #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
790 if( sz>0 ){
791 nBig = szAlloc/sz;
792 nSm = 0;
793 }else{
794 nBig = nSm = 0;
796 db->lookaside.pStart = pStart;
797 db->lookaside.pInit = 0;
798 db->lookaside.pFree = 0;
799 db->lookaside.sz = (u16)sz;
800 db->lookaside.szTrue = (u16)sz;
801 if( pStart ){
802 int i;
803 LookasideSlot *p;
804 assert( sz > (int)sizeof(LookasideSlot*) );
805 p = (LookasideSlot*)pStart;
806 for(i=0; i<nBig; i++){
807 p->pNext = db->lookaside.pInit;
808 db->lookaside.pInit = p;
809 p = (LookasideSlot*)&((u8*)p)[sz];
811 #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
812 db->lookaside.pSmallInit = 0;
813 db->lookaside.pSmallFree = 0;
814 db->lookaside.pMiddle = p;
815 for(i=0; i<nSm; i++){
816 p->pNext = db->lookaside.pSmallInit;
817 db->lookaside.pSmallInit = p;
818 p = (LookasideSlot*)&((u8*)p)[LOOKASIDE_SMALL];
820 #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
821 assert( ((uptr)p)<=szAlloc + (uptr)pStart );
822 db->lookaside.pEnd = p;
823 db->lookaside.bDisable = 0;
824 db->lookaside.bMalloced = pBuf==0 ?1:0;
825 db->lookaside.nSlot = nBig+nSm;
826 }else{
827 db->lookaside.pStart = 0;
828 #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE
829 db->lookaside.pSmallInit = 0;
830 db->lookaside.pSmallFree = 0;
831 db->lookaside.pMiddle = 0;
832 #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */
833 db->lookaside.pEnd = 0;
834 db->lookaside.bDisable = 1;
835 db->lookaside.sz = 0;
836 db->lookaside.bMalloced = 0;
837 db->lookaside.nSlot = 0;
839 db->lookaside.pTrueEnd = db->lookaside.pEnd;
840 assert( sqlite3LookasideUsed(db,0)==0 );
841 #endif /* SQLITE_OMIT_LOOKASIDE */
842 return SQLITE_OK;
846 ** Return the mutex associated with a database connection.
848 sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
849 #ifdef SQLITE_ENABLE_API_ARMOR
850 if( !sqlite3SafetyCheckOk(db) ){
851 (void)SQLITE_MISUSE_BKPT;
852 return 0;
854 #endif
855 return db->mutex;
859 ** Free up as much memory as we can from the given database
860 ** connection.
862 int sqlite3_db_release_memory(sqlite3 *db){
863 int i;
865 #ifdef SQLITE_ENABLE_API_ARMOR
866 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
867 #endif
868 sqlite3_mutex_enter(db->mutex);
869 sqlite3BtreeEnterAll(db);
870 for(i=0; i<db->nDb; i++){
871 Btree *pBt = db->aDb[i].pBt;
872 if( pBt ){
873 Pager *pPager = sqlite3BtreePager(pBt);
874 sqlite3PagerShrink(pPager);
877 sqlite3BtreeLeaveAll(db);
878 sqlite3_mutex_leave(db->mutex);
879 return SQLITE_OK;
883 ** Flush any dirty pages in the pager-cache for any attached database
884 ** to disk.
886 int sqlite3_db_cacheflush(sqlite3 *db){
887 int i;
888 int rc = SQLITE_OK;
889 int bSeenBusy = 0;
891 #ifdef SQLITE_ENABLE_API_ARMOR
892 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
893 #endif
894 sqlite3_mutex_enter(db->mutex);
895 sqlite3BtreeEnterAll(db);
896 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
897 Btree *pBt = db->aDb[i].pBt;
898 if( pBt && sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
899 Pager *pPager = sqlite3BtreePager(pBt);
900 rc = sqlite3PagerFlush(pPager);
901 if( rc==SQLITE_BUSY ){
902 bSeenBusy = 1;
903 rc = SQLITE_OK;
907 sqlite3BtreeLeaveAll(db);
908 sqlite3_mutex_leave(db->mutex);
909 return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
913 ** Configuration settings for an individual database connection
915 int sqlite3_db_config(sqlite3 *db, int op, ...){
916 va_list ap;
917 int rc;
918 sqlite3_mutex_enter(db->mutex);
919 va_start(ap, op);
920 switch( op ){
921 case SQLITE_DBCONFIG_MAINDBNAME: {
922 /* IMP: R-06824-28531 */
923 /* IMP: R-36257-52125 */
924 db->aDb[0].zDbSName = va_arg(ap,char*);
925 rc = SQLITE_OK;
926 break;
928 case SQLITE_DBCONFIG_LOOKASIDE: {
929 void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
930 int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
931 int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
932 rc = setupLookaside(db, pBuf, sz, cnt);
933 break;
935 default: {
936 static const struct {
937 int op; /* The opcode */
938 u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
939 } aFlagOp[] = {
940 { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
941 { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
942 { SQLITE_DBCONFIG_ENABLE_VIEW, SQLITE_EnableView },
943 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
944 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
945 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
946 { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
947 { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
948 { SQLITE_DBCONFIG_RESET_DATABASE, SQLITE_ResetDatabase },
949 { SQLITE_DBCONFIG_DEFENSIVE, SQLITE_Defensive },
950 { SQLITE_DBCONFIG_WRITABLE_SCHEMA, SQLITE_WriteSchema|
951 SQLITE_NoSchemaError },
952 { SQLITE_DBCONFIG_LEGACY_ALTER_TABLE, SQLITE_LegacyAlter },
953 { SQLITE_DBCONFIG_DQS_DDL, SQLITE_DqsDDL },
954 { SQLITE_DBCONFIG_DQS_DML, SQLITE_DqsDML },
955 { SQLITE_DBCONFIG_LEGACY_FILE_FORMAT, SQLITE_LegacyFileFmt },
956 { SQLITE_DBCONFIG_TRUSTED_SCHEMA, SQLITE_TrustedSchema },
958 unsigned int i;
959 rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
960 for(i=0; i<ArraySize(aFlagOp); i++){
961 if( aFlagOp[i].op==op ){
962 int onoff = va_arg(ap, int);
963 int *pRes = va_arg(ap, int*);
964 u64 oldFlags = db->flags;
965 if( onoff>0 ){
966 db->flags |= aFlagOp[i].mask;
967 }else if( onoff==0 ){
968 db->flags &= ~(u64)aFlagOp[i].mask;
970 if( oldFlags!=db->flags ){
971 sqlite3ExpirePreparedStatements(db, 0);
973 if( pRes ){
974 *pRes = (db->flags & aFlagOp[i].mask)!=0;
976 rc = SQLITE_OK;
977 break;
980 break;
983 va_end(ap);
984 sqlite3_mutex_leave(db->mutex);
985 return rc;
989 ** This is the default collating function named "BINARY" which is always
990 ** available.
992 static int binCollFunc(
993 void *NotUsed,
994 int nKey1, const void *pKey1,
995 int nKey2, const void *pKey2
997 int rc, n;
998 UNUSED_PARAMETER(NotUsed);
999 n = nKey1<nKey2 ? nKey1 : nKey2;
1000 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
1001 ** strings byte by byte using the memcmp() function from the standard C
1002 ** library. */
1003 assert( pKey1 && pKey2 );
1004 rc = memcmp(pKey1, pKey2, n);
1005 if( rc==0 ){
1006 rc = nKey1 - nKey2;
1008 return rc;
1012 ** This is the collating function named "RTRIM" which is always
1013 ** available. Ignore trailing spaces.
1015 static int rtrimCollFunc(
1016 void *pUser,
1017 int nKey1, const void *pKey1,
1018 int nKey2, const void *pKey2
1020 const u8 *pK1 = (const u8*)pKey1;
1021 const u8 *pK2 = (const u8*)pKey2;
1022 while( nKey1 && pK1[nKey1-1]==' ' ) nKey1--;
1023 while( nKey2 && pK2[nKey2-1]==' ' ) nKey2--;
1024 return binCollFunc(pUser, nKey1, pKey1, nKey2, pKey2);
1028 ** Return true if CollSeq is the default built-in BINARY.
1030 int sqlite3IsBinary(const CollSeq *p){
1031 assert( p==0 || p->xCmp!=binCollFunc || strcmp(p->zName,"BINARY")==0 );
1032 return p==0 || p->xCmp==binCollFunc;
1036 ** Another built-in collating sequence: NOCASE.
1038 ** This collating sequence is intended to be used for "case independent
1039 ** comparison". SQLite's knowledge of upper and lower case equivalents
1040 ** extends only to the 26 characters used in the English language.
1042 ** At the moment there is only a UTF-8 implementation.
1044 static int nocaseCollatingFunc(
1045 void *NotUsed,
1046 int nKey1, const void *pKey1,
1047 int nKey2, const void *pKey2
1049 int r = sqlite3StrNICmp(
1050 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
1051 UNUSED_PARAMETER(NotUsed);
1052 if( 0==r ){
1053 r = nKey1-nKey2;
1055 return r;
1059 ** Return the ROWID of the most recent insert
1061 sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
1062 #ifdef SQLITE_ENABLE_API_ARMOR
1063 if( !sqlite3SafetyCheckOk(db) ){
1064 (void)SQLITE_MISUSE_BKPT;
1065 return 0;
1067 #endif
1068 return db->lastRowid;
1072 ** Set the value returned by the sqlite3_last_insert_rowid() API function.
1074 void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
1075 #ifdef SQLITE_ENABLE_API_ARMOR
1076 if( !sqlite3SafetyCheckOk(db) ){
1077 (void)SQLITE_MISUSE_BKPT;
1078 return;
1080 #endif
1081 sqlite3_mutex_enter(db->mutex);
1082 db->lastRowid = iRowid;
1083 sqlite3_mutex_leave(db->mutex);
1087 ** Return the number of changes in the most recent call to sqlite3_exec().
1089 sqlite3_int64 sqlite3_changes64(sqlite3 *db){
1090 #ifdef SQLITE_ENABLE_API_ARMOR
1091 if( !sqlite3SafetyCheckOk(db) ){
1092 (void)SQLITE_MISUSE_BKPT;
1093 return 0;
1095 #endif
1096 return db->nChange;
1098 int sqlite3_changes(sqlite3 *db){
1099 return (int)sqlite3_changes64(db);
1103 ** Return the number of changes since the database handle was opened.
1105 sqlite3_int64 sqlite3_total_changes64(sqlite3 *db){
1106 #ifdef SQLITE_ENABLE_API_ARMOR
1107 if( !sqlite3SafetyCheckOk(db) ){
1108 (void)SQLITE_MISUSE_BKPT;
1109 return 0;
1111 #endif
1112 return db->nTotalChange;
1114 int sqlite3_total_changes(sqlite3 *db){
1115 return (int)sqlite3_total_changes64(db);
1119 ** Close all open savepoints. This function only manipulates fields of the
1120 ** database handle object, it does not close any savepoints that may be open
1121 ** at the b-tree/pager level.
1123 void sqlite3CloseSavepoints(sqlite3 *db){
1124 while( db->pSavepoint ){
1125 Savepoint *pTmp = db->pSavepoint;
1126 db->pSavepoint = pTmp->pNext;
1127 sqlite3DbFree(db, pTmp);
1129 db->nSavepoint = 0;
1130 db->nStatement = 0;
1131 db->isTransactionSavepoint = 0;
1135 ** Invoke the destructor function associated with FuncDef p, if any. Except,
1136 ** if this is not the last copy of the function, do not invoke it. Multiple
1137 ** copies of a single function are created when create_function() is called
1138 ** with SQLITE_ANY as the encoding.
1140 static void functionDestroy(sqlite3 *db, FuncDef *p){
1141 FuncDestructor *pDestructor;
1142 assert( (p->funcFlags & SQLITE_FUNC_BUILTIN)==0 );
1143 pDestructor = p->u.pDestructor;
1144 if( pDestructor ){
1145 pDestructor->nRef--;
1146 if( pDestructor->nRef==0 ){
1147 pDestructor->xDestroy(pDestructor->pUserData);
1148 sqlite3DbFree(db, pDestructor);
1154 ** Disconnect all sqlite3_vtab objects that belong to database connection
1155 ** db. This is called when db is being closed.
1157 static void disconnectAllVtab(sqlite3 *db){
1158 #ifndef SQLITE_OMIT_VIRTUALTABLE
1159 int i;
1160 HashElem *p;
1161 sqlite3BtreeEnterAll(db);
1162 for(i=0; i<db->nDb; i++){
1163 Schema *pSchema = db->aDb[i].pSchema;
1164 if( pSchema ){
1165 for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
1166 Table *pTab = (Table *)sqliteHashData(p);
1167 if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
1171 for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
1172 Module *pMod = (Module *)sqliteHashData(p);
1173 if( pMod->pEpoTab ){
1174 sqlite3VtabDisconnect(db, pMod->pEpoTab);
1177 sqlite3VtabUnlockList(db);
1178 sqlite3BtreeLeaveAll(db);
1179 #else
1180 UNUSED_PARAMETER(db);
1181 #endif
1185 ** Return TRUE if database connection db has unfinalized prepared
1186 ** statements or unfinished sqlite3_backup objects.
1188 static int connectionIsBusy(sqlite3 *db){
1189 int j;
1190 assert( sqlite3_mutex_held(db->mutex) );
1191 if( db->pVdbe ) return 1;
1192 for(j=0; j<db->nDb; j++){
1193 Btree *pBt = db->aDb[j].pBt;
1194 if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
1196 return 0;
1200 ** Close an existing SQLite database
1202 static int sqlite3Close(sqlite3 *db, int forceZombie){
1203 if( !db ){
1204 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1205 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
1206 return SQLITE_OK;
1208 if( !sqlite3SafetyCheckSickOrOk(db) ){
1209 return SQLITE_MISUSE_BKPT;
1211 sqlite3_mutex_enter(db->mutex);
1212 if( db->mTrace & SQLITE_TRACE_CLOSE ){
1213 db->trace.xV2(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
1216 /* Force xDisconnect calls on all virtual tables */
1217 disconnectAllVtab(db);
1219 /* If a transaction is open, the disconnectAllVtab() call above
1220 ** will not have called the xDisconnect() method on any virtual
1221 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1222 ** call will do so. We need to do this before the check for active
1223 ** SQL statements below, as the v-table implementation may be storing
1224 ** some prepared statements internally.
1226 sqlite3VtabRollback(db);
1228 /* Legacy behavior (sqlite3_close() behavior) is to return
1229 ** SQLITE_BUSY if the connection can not be closed immediately.
1231 if( !forceZombie && connectionIsBusy(db) ){
1232 sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
1233 "statements or unfinished backups");
1234 sqlite3_mutex_leave(db->mutex);
1235 return SQLITE_BUSY;
1238 #ifdef SQLITE_ENABLE_SQLLOG
1239 if( sqlite3GlobalConfig.xSqllog ){
1240 /* Closing the handle. Fourth parameter is passed the value 2. */
1241 sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
1243 #endif
1245 /* Convert the connection into a zombie and then close it.
1247 db->eOpenState = SQLITE_STATE_ZOMBIE;
1248 sqlite3LeaveMutexAndCloseZombie(db);
1249 return SQLITE_OK;
1253 ** Return the transaction state for a single databse, or the maximum
1254 ** transaction state over all attached databases if zSchema is null.
1256 int sqlite3_txn_state(sqlite3 *db, const char *zSchema){
1257 int iDb, nDb;
1258 int iTxn = -1;
1259 #ifdef SQLITE_ENABLE_API_ARMOR
1260 if( !sqlite3SafetyCheckOk(db) ){
1261 (void)SQLITE_MISUSE_BKPT;
1262 return -1;
1264 #endif
1265 sqlite3_mutex_enter(db->mutex);
1266 if( zSchema ){
1267 nDb = iDb = sqlite3FindDbName(db, zSchema);
1268 if( iDb<0 ) nDb--;
1269 }else{
1270 iDb = 0;
1271 nDb = db->nDb-1;
1273 for(; iDb<=nDb; iDb++){
1274 Btree *pBt = db->aDb[iDb].pBt;
1275 int x = pBt!=0 ? sqlite3BtreeTxnState(pBt) : SQLITE_TXN_NONE;
1276 if( x>iTxn ) iTxn = x;
1278 sqlite3_mutex_leave(db->mutex);
1279 return iTxn;
1283 ** Two variations on the public interface for closing a database
1284 ** connection. The sqlite3_close() version returns SQLITE_BUSY and
1285 ** leaves the connection open if there are unfinalized prepared
1286 ** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1287 ** version forces the connection to become a zombie if there are
1288 ** unclosed resources, and arranges for deallocation when the last
1289 ** prepare statement or sqlite3_backup closes.
1291 int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
1292 int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
1296 ** Close the mutex on database connection db.
1298 ** Furthermore, if database connection db is a zombie (meaning that there
1299 ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1300 ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1301 ** finished, then free all resources.
1303 void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
1304 HashElem *i; /* Hash table iterator */
1305 int j;
1307 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
1308 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1309 ** then just leave the mutex and return.
1311 if( db->eOpenState!=SQLITE_STATE_ZOMBIE || connectionIsBusy(db) ){
1312 sqlite3_mutex_leave(db->mutex);
1313 return;
1316 /* If we reach this point, it means that the database connection has
1317 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
1318 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
1319 ** go ahead and free all resources.
1322 /* If a transaction is open, roll it back. This also ensures that if
1323 ** any database schemas have been modified by an uncommitted transaction
1324 ** they are reset. And that the required b-tree mutex is held to make
1325 ** the pager rollback and schema reset an atomic operation. */
1326 sqlite3RollbackAll(db, SQLITE_OK);
1328 /* Free any outstanding Savepoint structures. */
1329 sqlite3CloseSavepoints(db);
1331 /* Close all database connections */
1332 for(j=0; j<db->nDb; j++){
1333 struct Db *pDb = &db->aDb[j];
1334 if( pDb->pBt ){
1335 sqlite3BtreeClose(pDb->pBt);
1336 pDb->pBt = 0;
1337 if( j!=1 ){
1338 pDb->pSchema = 0;
1342 /* Clear the TEMP schema separately and last */
1343 if( db->aDb[1].pSchema ){
1344 sqlite3SchemaClear(db->aDb[1].pSchema);
1346 sqlite3VtabUnlockList(db);
1348 /* Free up the array of auxiliary databases */
1349 sqlite3CollapseDatabaseArray(db);
1350 assert( db->nDb<=2 );
1351 assert( db->aDb==db->aDbStatic );
1353 /* Tell the code in notify.c that the connection no longer holds any
1354 ** locks and does not require any further unlock-notify callbacks.
1356 sqlite3ConnectionClosed(db);
1358 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
1359 FuncDef *pNext, *p;
1360 p = sqliteHashData(i);
1362 functionDestroy(db, p);
1363 pNext = p->pNext;
1364 sqlite3DbFree(db, p);
1365 p = pNext;
1366 }while( p );
1368 sqlite3HashClear(&db->aFunc);
1369 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
1370 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
1371 /* Invoke any destructors registered for collation sequence user data. */
1372 for(j=0; j<3; j++){
1373 if( pColl[j].xDel ){
1374 pColl[j].xDel(pColl[j].pUser);
1377 sqlite3DbFree(db, pColl);
1379 sqlite3HashClear(&db->aCollSeq);
1380 #ifndef SQLITE_OMIT_VIRTUALTABLE
1381 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
1382 Module *pMod = (Module *)sqliteHashData(i);
1383 sqlite3VtabEponymousTableClear(db, pMod);
1384 sqlite3VtabModuleUnref(db, pMod);
1386 sqlite3HashClear(&db->aModule);
1387 #endif
1389 sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
1390 sqlite3ValueFree(db->pErr);
1391 sqlite3CloseExtensions(db);
1392 #if SQLITE_USER_AUTHENTICATION
1393 sqlite3_free(db->auth.zAuthUser);
1394 sqlite3_free(db->auth.zAuthPW);
1395 #endif
1397 db->eOpenState = SQLITE_STATE_ERROR;
1399 /* The temp-database schema is allocated differently from the other schema
1400 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1401 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1402 ** the same sqliteMalloc() as the one that allocates the database
1403 ** structure?
1405 sqlite3DbFree(db, db->aDb[1].pSchema);
1406 if( db->xAutovacDestr ){
1407 db->xAutovacDestr(db->pAutovacPagesArg);
1409 sqlite3_mutex_leave(db->mutex);
1410 db->eOpenState = SQLITE_STATE_CLOSED;
1411 sqlite3_mutex_free(db->mutex);
1412 assert( sqlite3LookasideUsed(db,0)==0 );
1413 if( db->lookaside.bMalloced ){
1414 sqlite3_free(db->lookaside.pStart);
1416 sqlite3_free(db);
1420 ** Rollback all database files. If tripCode is not SQLITE_OK, then
1421 ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
1422 ** breaker") and made to return tripCode if there are any further
1423 ** attempts to use that cursor. Read cursors remain open and valid
1424 ** but are "saved" in case the table pages are moved around.
1426 void sqlite3RollbackAll(sqlite3 *db, int tripCode){
1427 int i;
1428 int inTrans = 0;
1429 int schemaChange;
1430 assert( sqlite3_mutex_held(db->mutex) );
1431 sqlite3BeginBenignMalloc();
1433 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1434 ** This is important in case the transaction being rolled back has
1435 ** modified the database schema. If the b-tree mutexes are not taken
1436 ** here, then another shared-cache connection might sneak in between
1437 ** the database rollback and schema reset, which can cause false
1438 ** corruption reports in some cases. */
1439 sqlite3BtreeEnterAll(db);
1440 schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
1442 for(i=0; i<db->nDb; i++){
1443 Btree *p = db->aDb[i].pBt;
1444 if( p ){
1445 if( sqlite3BtreeTxnState(p)==SQLITE_TXN_WRITE ){
1446 inTrans = 1;
1448 sqlite3BtreeRollback(p, tripCode, !schemaChange);
1451 sqlite3VtabRollback(db);
1452 sqlite3EndBenignMalloc();
1454 if( schemaChange ){
1455 sqlite3ExpirePreparedStatements(db, 0);
1456 sqlite3ResetAllSchemasOfConnection(db);
1458 sqlite3BtreeLeaveAll(db);
1460 /* Any deferred constraint violations have now been resolved. */
1461 db->nDeferredCons = 0;
1462 db->nDeferredImmCons = 0;
1463 db->flags &= ~(u64)(SQLITE_DeferFKs|SQLITE_CorruptRdOnly);
1465 /* If one has been configured, invoke the rollback-hook callback */
1466 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
1467 db->xRollbackCallback(db->pRollbackArg);
1472 ** Return a static string containing the name corresponding to the error code
1473 ** specified in the argument.
1475 #if defined(SQLITE_NEED_ERR_NAME)
1476 const char *sqlite3ErrName(int rc){
1477 const char *zName = 0;
1478 int i, origRc = rc;
1479 for(i=0; i<2 && zName==0; i++, rc &= 0xff){
1480 switch( rc ){
1481 case SQLITE_OK: zName = "SQLITE_OK"; break;
1482 case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
1483 case SQLITE_ERROR_SNAPSHOT: zName = "SQLITE_ERROR_SNAPSHOT"; break;
1484 case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
1485 case SQLITE_PERM: zName = "SQLITE_PERM"; break;
1486 case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
1487 case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
1488 case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
1489 case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
1490 case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
1491 case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
1492 case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
1493 case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
1494 case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
1495 case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
1496 case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
1497 case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
1498 case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
1499 case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
1500 case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
1501 case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
1502 case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
1503 case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
1504 case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
1505 case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
1506 case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
1507 case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
1508 case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
1509 case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
1510 case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
1511 case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
1512 case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
1513 case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
1514 case SQLITE_IOERR_CHECKRESERVEDLOCK:
1515 zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1516 case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
1517 case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
1518 case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
1519 case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
1520 case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
1521 case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
1522 case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
1523 case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
1524 case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
1525 case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
1526 case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
1527 case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
1528 case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
1529 case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
1530 case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
1531 case SQLITE_FULL: zName = "SQLITE_FULL"; break;
1532 case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
1533 case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
1534 case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
1535 case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
1536 case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
1537 case SQLITE_CANTOPEN_SYMLINK: zName = "SQLITE_CANTOPEN_SYMLINK"; break;
1538 case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
1539 case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
1540 case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
1541 case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
1542 case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
1543 case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
1544 case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
1545 case SQLITE_CONSTRAINT_FOREIGNKEY:
1546 zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1547 case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
1548 case SQLITE_CONSTRAINT_PRIMARYKEY:
1549 zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1550 case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
1551 case SQLITE_CONSTRAINT_COMMITHOOK:
1552 zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1553 case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
1554 case SQLITE_CONSTRAINT_FUNCTION:
1555 zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
1556 case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
1557 case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
1558 case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
1559 case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
1560 case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
1561 case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
1562 case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
1563 case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
1564 case SQLITE_ROW: zName = "SQLITE_ROW"; break;
1565 case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
1566 case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
1567 case SQLITE_NOTICE_RECOVER_ROLLBACK:
1568 zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
1569 case SQLITE_NOTICE_RBU: zName = "SQLITE_NOTICE_RBU"; break;
1570 case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
1571 case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
1572 case SQLITE_DONE: zName = "SQLITE_DONE"; break;
1575 if( zName==0 ){
1576 static char zBuf[50];
1577 sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
1578 zName = zBuf;
1580 return zName;
1582 #endif
1585 ** Return a static string that describes the kind of error specified in the
1586 ** argument.
1588 const char *sqlite3ErrStr(int rc){
1589 static const char* const aMsg[] = {
1590 /* SQLITE_OK */ "not an error",
1591 /* SQLITE_ERROR */ "SQL logic error",
1592 /* SQLITE_INTERNAL */ 0,
1593 /* SQLITE_PERM */ "access permission denied",
1594 /* SQLITE_ABORT */ "query aborted",
1595 /* SQLITE_BUSY */ "database is locked",
1596 /* SQLITE_LOCKED */ "database table is locked",
1597 /* SQLITE_NOMEM */ "out of memory",
1598 /* SQLITE_READONLY */ "attempt to write a readonly database",
1599 /* SQLITE_INTERRUPT */ "interrupted",
1600 /* SQLITE_IOERR */ "disk I/O error",
1601 /* SQLITE_CORRUPT */ "database disk image is malformed",
1602 /* SQLITE_NOTFOUND */ "unknown operation",
1603 /* SQLITE_FULL */ "database or disk is full",
1604 /* SQLITE_CANTOPEN */ "unable to open database file",
1605 /* SQLITE_PROTOCOL */ "locking protocol",
1606 /* SQLITE_EMPTY */ 0,
1607 /* SQLITE_SCHEMA */ "database schema has changed",
1608 /* SQLITE_TOOBIG */ "string or blob too big",
1609 /* SQLITE_CONSTRAINT */ "constraint failed",
1610 /* SQLITE_MISMATCH */ "datatype mismatch",
1611 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
1612 #ifdef SQLITE_DISABLE_LFS
1613 /* SQLITE_NOLFS */ "large file support is disabled",
1614 #else
1615 /* SQLITE_NOLFS */ 0,
1616 #endif
1617 /* SQLITE_AUTH */ "authorization denied",
1618 /* SQLITE_FORMAT */ 0,
1619 /* SQLITE_RANGE */ "column index out of range",
1620 /* SQLITE_NOTADB */ "file is not a database",
1621 /* SQLITE_NOTICE */ "notification message",
1622 /* SQLITE_WARNING */ "warning message",
1624 const char *zErr = "unknown error";
1625 switch( rc ){
1626 case SQLITE_ABORT_ROLLBACK: {
1627 zErr = "abort due to ROLLBACK";
1628 break;
1630 case SQLITE_ROW: {
1631 zErr = "another row available";
1632 break;
1634 case SQLITE_DONE: {
1635 zErr = "no more rows available";
1636 break;
1638 default: {
1639 rc &= 0xff;
1640 if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
1641 zErr = aMsg[rc];
1643 break;
1646 return zErr;
1650 ** This routine implements a busy callback that sleeps and tries
1651 ** again until a timeout value is reached. The timeout value is
1652 ** an integer number of milliseconds passed in as the first
1653 ** argument.
1655 ** Return non-zero to retry the lock. Return zero to stop trying
1656 ** and cause SQLite to return SQLITE_BUSY.
1658 static int sqliteDefaultBusyCallback(
1659 void *ptr, /* Database connection */
1660 int count /* Number of times table has been busy */
1662 #if SQLITE_OS_WIN || HAVE_USLEEP
1663 /* This case is for systems that have support for sleeping for fractions of
1664 ** a second. Examples: All windows systems, unix systems with usleep() */
1665 static const u8 delays[] =
1666 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1667 static const u8 totals[] =
1668 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
1669 # define NDELAY ArraySize(delays)
1670 sqlite3 *db = (sqlite3 *)ptr;
1671 int tmout = db->busyTimeout;
1672 int delay, prior;
1674 assert( count>=0 );
1675 if( count < NDELAY ){
1676 delay = delays[count];
1677 prior = totals[count];
1678 }else{
1679 delay = delays[NDELAY-1];
1680 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
1682 if( prior + delay > tmout ){
1683 delay = tmout - prior;
1684 if( delay<=0 ) return 0;
1686 sqlite3OsSleep(db->pVfs, delay*1000);
1687 return 1;
1688 #else
1689 /* This case for unix systems that lack usleep() support. Sleeping
1690 ** must be done in increments of whole seconds */
1691 sqlite3 *db = (sqlite3 *)ptr;
1692 int tmout = ((sqlite3 *)ptr)->busyTimeout;
1693 if( (count+1)*1000 > tmout ){
1694 return 0;
1696 sqlite3OsSleep(db->pVfs, 1000000);
1697 return 1;
1698 #endif
1702 ** Invoke the given busy handler.
1704 ** This routine is called when an operation failed to acquire a
1705 ** lock on VFS file pFile.
1707 ** If this routine returns non-zero, the lock is retried. If it
1708 ** returns 0, the operation aborts with an SQLITE_BUSY error.
1710 int sqlite3InvokeBusyHandler(BusyHandler *p){
1711 int rc;
1712 if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
1713 rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
1714 if( rc==0 ){
1715 p->nBusy = -1;
1716 }else{
1717 p->nBusy++;
1719 return rc;
1723 ** This routine sets the busy callback for an Sqlite database to the
1724 ** given callback function with the given argument.
1726 int sqlite3_busy_handler(
1727 sqlite3 *db,
1728 int (*xBusy)(void*,int),
1729 void *pArg
1731 #ifdef SQLITE_ENABLE_API_ARMOR
1732 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1733 #endif
1734 sqlite3_mutex_enter(db->mutex);
1735 db->busyHandler.xBusyHandler = xBusy;
1736 db->busyHandler.pBusyArg = pArg;
1737 db->busyHandler.nBusy = 0;
1738 db->busyTimeout = 0;
1739 sqlite3_mutex_leave(db->mutex);
1740 return SQLITE_OK;
1743 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1745 ** This routine sets the progress callback for an Sqlite database to the
1746 ** given callback function with the given argument. The progress callback will
1747 ** be invoked every nOps opcodes.
1749 void sqlite3_progress_handler(
1750 sqlite3 *db,
1751 int nOps,
1752 int (*xProgress)(void*),
1753 void *pArg
1755 #ifdef SQLITE_ENABLE_API_ARMOR
1756 if( !sqlite3SafetyCheckOk(db) ){
1757 (void)SQLITE_MISUSE_BKPT;
1758 return;
1760 #endif
1761 sqlite3_mutex_enter(db->mutex);
1762 if( nOps>0 ){
1763 db->xProgress = xProgress;
1764 db->nProgressOps = (unsigned)nOps;
1765 db->pProgressArg = pArg;
1766 }else{
1767 db->xProgress = 0;
1768 db->nProgressOps = 0;
1769 db->pProgressArg = 0;
1771 sqlite3_mutex_leave(db->mutex);
1773 #endif
1777 ** This routine installs a default busy handler that waits for the
1778 ** specified number of milliseconds before returning 0.
1780 int sqlite3_busy_timeout(sqlite3 *db, int ms){
1781 #ifdef SQLITE_ENABLE_API_ARMOR
1782 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
1783 #endif
1784 if( ms>0 ){
1785 sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
1786 (void*)db);
1787 db->busyTimeout = ms;
1788 }else{
1789 sqlite3_busy_handler(db, 0, 0);
1791 return SQLITE_OK;
1795 ** Cause any pending operation to stop at its earliest opportunity.
1797 void sqlite3_interrupt(sqlite3 *db){
1798 #ifdef SQLITE_ENABLE_API_ARMOR
1799 if( !sqlite3SafetyCheckOk(db)
1800 && (db==0 || db->eOpenState!=SQLITE_STATE_ZOMBIE)
1802 (void)SQLITE_MISUSE_BKPT;
1803 return;
1805 #endif
1806 AtomicStore(&db->u1.isInterrupted, 1);
1810 ** Return true or false depending on whether or not an interrupt is
1811 ** pending on connection db.
1813 int sqlite3_is_interrupted(sqlite3 *db){
1814 #ifdef SQLITE_ENABLE_API_ARMOR
1815 if( !sqlite3SafetyCheckOk(db)
1816 && (db==0 || db->eOpenState!=SQLITE_STATE_ZOMBIE)
1818 (void)SQLITE_MISUSE_BKPT;
1819 return 0;
1821 #endif
1822 return AtomicLoad(&db->u1.isInterrupted)!=0;
1826 ** This function is exactly the same as sqlite3_create_function(), except
1827 ** that it is designed to be called by internal code. The difference is
1828 ** that if a malloc() fails in sqlite3_create_function(), an error code
1829 ** is returned and the mallocFailed flag cleared.
1831 int sqlite3CreateFunc(
1832 sqlite3 *db,
1833 const char *zFunctionName,
1834 int nArg,
1835 int enc,
1836 void *pUserData,
1837 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
1838 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
1839 void (*xFinal)(sqlite3_context*),
1840 void (*xValue)(sqlite3_context*),
1841 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
1842 FuncDestructor *pDestructor
1844 FuncDef *p;
1845 int extraFlags;
1847 assert( sqlite3_mutex_held(db->mutex) );
1848 assert( xValue==0 || xSFunc==0 );
1849 if( zFunctionName==0 /* Must have a valid name */
1850 || (xSFunc!=0 && xFinal!=0) /* Not both xSFunc and xFinal */
1851 || ((xFinal==0)!=(xStep==0)) /* Both or neither of xFinal and xStep */
1852 || ((xValue==0)!=(xInverse==0)) /* Both or neither of xValue, xInverse */
1853 || (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG)
1854 || (255<sqlite3Strlen30(zFunctionName))
1856 return SQLITE_MISUSE_BKPT;
1859 assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
1860 assert( SQLITE_FUNC_DIRECT==SQLITE_DIRECTONLY );
1861 extraFlags = enc & (SQLITE_DETERMINISTIC|SQLITE_DIRECTONLY|
1862 SQLITE_SUBTYPE|SQLITE_INNOCUOUS);
1863 enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
1865 /* The SQLITE_INNOCUOUS flag is the same bit as SQLITE_FUNC_UNSAFE. But
1866 ** the meaning is inverted. So flip the bit. */
1867 assert( SQLITE_FUNC_UNSAFE==SQLITE_INNOCUOUS );
1868 extraFlags ^= SQLITE_FUNC_UNSAFE; /* tag-20230109-1 */
1871 #ifndef SQLITE_OMIT_UTF16
1872 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1873 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1874 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1876 ** If SQLITE_ANY is specified, add three versions of the function
1877 ** to the hash table.
1879 switch( enc ){
1880 case SQLITE_UTF16:
1881 enc = SQLITE_UTF16NATIVE;
1882 break;
1883 case SQLITE_ANY: {
1884 int rc;
1885 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1886 (SQLITE_UTF8|extraFlags)^SQLITE_FUNC_UNSAFE, /* tag-20230109-1 */
1887 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
1888 if( rc==SQLITE_OK ){
1889 rc = sqlite3CreateFunc(db, zFunctionName, nArg,
1890 (SQLITE_UTF16LE|extraFlags)^SQLITE_FUNC_UNSAFE, /* tag-20230109-1*/
1891 pUserData, xSFunc, xStep, xFinal, xValue, xInverse, pDestructor);
1893 if( rc!=SQLITE_OK ){
1894 return rc;
1896 enc = SQLITE_UTF16BE;
1897 break;
1899 case SQLITE_UTF8:
1900 case SQLITE_UTF16LE:
1901 case SQLITE_UTF16BE:
1902 break;
1903 default:
1904 enc = SQLITE_UTF8;
1905 break;
1907 #else
1908 enc = SQLITE_UTF8;
1909 #endif
1911 /* Check if an existing function is being overridden or deleted. If so,
1912 ** and there are active VMs, then return SQLITE_BUSY. If a function
1913 ** is being overridden/deleted but there are no active VMs, allow the
1914 ** operation to continue but invalidate all precompiled statements.
1916 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
1917 if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==(u32)enc && p->nArg==nArg ){
1918 if( db->nVdbeActive ){
1919 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
1920 "unable to delete/modify user-function due to active statements");
1921 assert( !db->mallocFailed );
1922 return SQLITE_BUSY;
1923 }else{
1924 sqlite3ExpirePreparedStatements(db, 0);
1926 }else if( xSFunc==0 && xFinal==0 ){
1927 /* Trying to delete a function that does not exist. This is a no-op.
1928 ** https://sqlite.org/forum/forumpost/726219164b */
1929 return SQLITE_OK;
1932 p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
1933 assert(p || db->mallocFailed);
1934 if( !p ){
1935 return SQLITE_NOMEM_BKPT;
1938 /* If an older version of the function with a configured destructor is
1939 ** being replaced invoke the destructor function here. */
1940 functionDestroy(db, p);
1942 if( pDestructor ){
1943 pDestructor->nRef++;
1945 p->u.pDestructor = pDestructor;
1946 p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
1947 testcase( p->funcFlags & SQLITE_DETERMINISTIC );
1948 testcase( p->funcFlags & SQLITE_DIRECTONLY );
1949 p->xSFunc = xSFunc ? xSFunc : xStep;
1950 p->xFinalize = xFinal;
1951 p->xValue = xValue;
1952 p->xInverse = xInverse;
1953 p->pUserData = pUserData;
1954 p->nArg = (u16)nArg;
1955 return SQLITE_OK;
1959 ** Worker function used by utf-8 APIs that create new functions:
1961 ** sqlite3_create_function()
1962 ** sqlite3_create_function_v2()
1963 ** sqlite3_create_window_function()
1965 static int createFunctionApi(
1966 sqlite3 *db,
1967 const char *zFunc,
1968 int nArg,
1969 int enc,
1970 void *p,
1971 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
1972 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
1973 void (*xFinal)(sqlite3_context*),
1974 void (*xValue)(sqlite3_context*),
1975 void (*xInverse)(sqlite3_context*,int,sqlite3_value**),
1976 void(*xDestroy)(void*)
1978 int rc = SQLITE_ERROR;
1979 FuncDestructor *pArg = 0;
1981 #ifdef SQLITE_ENABLE_API_ARMOR
1982 if( !sqlite3SafetyCheckOk(db) ){
1983 return SQLITE_MISUSE_BKPT;
1985 #endif
1986 sqlite3_mutex_enter(db->mutex);
1987 if( xDestroy ){
1988 pArg = (FuncDestructor *)sqlite3Malloc(sizeof(FuncDestructor));
1989 if( !pArg ){
1990 sqlite3OomFault(db);
1991 xDestroy(p);
1992 goto out;
1994 pArg->nRef = 0;
1995 pArg->xDestroy = xDestroy;
1996 pArg->pUserData = p;
1998 rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p,
1999 xSFunc, xStep, xFinal, xValue, xInverse, pArg
2001 if( pArg && pArg->nRef==0 ){
2002 assert( rc!=SQLITE_OK || (xStep==0 && xFinal==0) );
2003 xDestroy(p);
2004 sqlite3_free(pArg);
2007 out:
2008 rc = sqlite3ApiExit(db, rc);
2009 sqlite3_mutex_leave(db->mutex);
2010 return rc;
2014 ** Create new user functions.
2016 int sqlite3_create_function(
2017 sqlite3 *db,
2018 const char *zFunc,
2019 int nArg,
2020 int enc,
2021 void *p,
2022 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
2023 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
2024 void (*xFinal)(sqlite3_context*)
2026 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
2027 xFinal, 0, 0, 0);
2029 int sqlite3_create_function_v2(
2030 sqlite3 *db,
2031 const char *zFunc,
2032 int nArg,
2033 int enc,
2034 void *p,
2035 void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
2036 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
2037 void (*xFinal)(sqlite3_context*),
2038 void (*xDestroy)(void *)
2040 return createFunctionApi(db, zFunc, nArg, enc, p, xSFunc, xStep,
2041 xFinal, 0, 0, xDestroy);
2043 int sqlite3_create_window_function(
2044 sqlite3 *db,
2045 const char *zFunc,
2046 int nArg,
2047 int enc,
2048 void *p,
2049 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
2050 void (*xFinal)(sqlite3_context*),
2051 void (*xValue)(sqlite3_context*),
2052 void (*xInverse)(sqlite3_context*,int,sqlite3_value **),
2053 void (*xDestroy)(void *)
2055 return createFunctionApi(db, zFunc, nArg, enc, p, 0, xStep,
2056 xFinal, xValue, xInverse, xDestroy);
2059 #ifndef SQLITE_OMIT_UTF16
2060 int sqlite3_create_function16(
2061 sqlite3 *db,
2062 const void *zFunctionName,
2063 int nArg,
2064 int eTextRep,
2065 void *p,
2066 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
2067 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
2068 void (*xFinal)(sqlite3_context*)
2070 int rc;
2071 char *zFunc8;
2073 #ifdef SQLITE_ENABLE_API_ARMOR
2074 if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
2075 #endif
2076 sqlite3_mutex_enter(db->mutex);
2077 assert( !db->mallocFailed );
2078 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
2079 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0,0,0);
2080 sqlite3DbFree(db, zFunc8);
2081 rc = sqlite3ApiExit(db, rc);
2082 sqlite3_mutex_leave(db->mutex);
2083 return rc;
2085 #endif
2089 ** The following is the implementation of an SQL function that always
2090 ** fails with an error message stating that the function is used in the
2091 ** wrong context. The sqlite3_overload_function() API might construct
2092 ** SQL function that use this routine so that the functions will exist
2093 ** for name resolution but are actually overloaded by the xFindFunction
2094 ** method of virtual tables.
2096 static void sqlite3InvalidFunction(
2097 sqlite3_context *context, /* The function calling context */
2098 int NotUsed, /* Number of arguments to the function */
2099 sqlite3_value **NotUsed2 /* Value of each argument */
2101 const char *zName = (const char*)sqlite3_user_data(context);
2102 char *zErr;
2103 UNUSED_PARAMETER2(NotUsed, NotUsed2);
2104 zErr = sqlite3_mprintf(
2105 "unable to use function %s in the requested context", zName);
2106 sqlite3_result_error(context, zErr, -1);
2107 sqlite3_free(zErr);
2111 ** Declare that a function has been overloaded by a virtual table.
2113 ** If the function already exists as a regular global function, then
2114 ** this routine is a no-op. If the function does not exist, then create
2115 ** a new one that always throws a run-time error.
2117 ** When virtual tables intend to provide an overloaded function, they
2118 ** should call this routine to make sure the global function exists.
2119 ** A global function must exist in order for name resolution to work
2120 ** properly.
2122 int sqlite3_overload_function(
2123 sqlite3 *db,
2124 const char *zName,
2125 int nArg
2127 int rc;
2128 char *zCopy;
2130 #ifdef SQLITE_ENABLE_API_ARMOR
2131 if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
2132 return SQLITE_MISUSE_BKPT;
2134 #endif
2135 sqlite3_mutex_enter(db->mutex);
2136 rc = sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)!=0;
2137 sqlite3_mutex_leave(db->mutex);
2138 if( rc ) return SQLITE_OK;
2139 zCopy = sqlite3_mprintf("%s", zName);
2140 if( zCopy==0 ) return SQLITE_NOMEM;
2141 return sqlite3_create_function_v2(db, zName, nArg, SQLITE_UTF8,
2142 zCopy, sqlite3InvalidFunction, 0, 0, sqlite3_free);
2145 #ifndef SQLITE_OMIT_TRACE
2147 ** Register a trace function. The pArg from the previously registered trace
2148 ** is returned.
2150 ** A NULL trace function means that no tracing is executes. A non-NULL
2151 ** trace is a pointer to a function that is invoked at the start of each
2152 ** SQL statement.
2154 #ifndef SQLITE_OMIT_DEPRECATED
2155 void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
2156 void *pOld;
2158 #ifdef SQLITE_ENABLE_API_ARMOR
2159 if( !sqlite3SafetyCheckOk(db) ){
2160 (void)SQLITE_MISUSE_BKPT;
2161 return 0;
2163 #endif
2164 sqlite3_mutex_enter(db->mutex);
2165 pOld = db->pTraceArg;
2166 db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
2167 db->trace.xLegacy = xTrace;
2168 db->pTraceArg = pArg;
2169 sqlite3_mutex_leave(db->mutex);
2170 return pOld;
2172 #endif /* SQLITE_OMIT_DEPRECATED */
2174 /* Register a trace callback using the version-2 interface.
2176 int sqlite3_trace_v2(
2177 sqlite3 *db, /* Trace this connection */
2178 unsigned mTrace, /* Mask of events to be traced */
2179 int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
2180 void *pArg /* Context */
2182 #ifdef SQLITE_ENABLE_API_ARMOR
2183 if( !sqlite3SafetyCheckOk(db) ){
2184 return SQLITE_MISUSE_BKPT;
2186 #endif
2187 sqlite3_mutex_enter(db->mutex);
2188 if( mTrace==0 ) xTrace = 0;
2189 if( xTrace==0 ) mTrace = 0;
2190 db->mTrace = mTrace;
2191 db->trace.xV2 = xTrace;
2192 db->pTraceArg = pArg;
2193 sqlite3_mutex_leave(db->mutex);
2194 return SQLITE_OK;
2197 #ifndef SQLITE_OMIT_DEPRECATED
2199 ** Register a profile function. The pArg from the previously registered
2200 ** profile function is returned.
2202 ** A NULL profile function means that no profiling is executes. A non-NULL
2203 ** profile is a pointer to a function that is invoked at the conclusion of
2204 ** each SQL statement that is run.
2206 void *sqlite3_profile(
2207 sqlite3 *db,
2208 void (*xProfile)(void*,const char*,sqlite_uint64),
2209 void *pArg
2211 void *pOld;
2213 #ifdef SQLITE_ENABLE_API_ARMOR
2214 if( !sqlite3SafetyCheckOk(db) ){
2215 (void)SQLITE_MISUSE_BKPT;
2216 return 0;
2218 #endif
2219 sqlite3_mutex_enter(db->mutex);
2220 pOld = db->pProfileArg;
2221 db->xProfile = xProfile;
2222 db->pProfileArg = pArg;
2223 db->mTrace &= SQLITE_TRACE_NONLEGACY_MASK;
2224 if( db->xProfile ) db->mTrace |= SQLITE_TRACE_XPROFILE;
2225 sqlite3_mutex_leave(db->mutex);
2226 return pOld;
2228 #endif /* SQLITE_OMIT_DEPRECATED */
2229 #endif /* SQLITE_OMIT_TRACE */
2232 ** Register a function to be invoked when a transaction commits.
2233 ** If the invoked function returns non-zero, then the commit becomes a
2234 ** rollback.
2236 void *sqlite3_commit_hook(
2237 sqlite3 *db, /* Attach the hook to this database */
2238 int (*xCallback)(void*), /* Function to invoke on each commit */
2239 void *pArg /* Argument to the function */
2241 void *pOld;
2243 #ifdef SQLITE_ENABLE_API_ARMOR
2244 if( !sqlite3SafetyCheckOk(db) ){
2245 (void)SQLITE_MISUSE_BKPT;
2246 return 0;
2248 #endif
2249 sqlite3_mutex_enter(db->mutex);
2250 pOld = db->pCommitArg;
2251 db->xCommitCallback = xCallback;
2252 db->pCommitArg = pArg;
2253 sqlite3_mutex_leave(db->mutex);
2254 return pOld;
2258 ** Register a callback to be invoked each time a row is updated,
2259 ** inserted or deleted using this database connection.
2261 void *sqlite3_update_hook(
2262 sqlite3 *db, /* Attach the hook to this database */
2263 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
2264 void *pArg /* Argument to the function */
2266 void *pRet;
2268 #ifdef SQLITE_ENABLE_API_ARMOR
2269 if( !sqlite3SafetyCheckOk(db) ){
2270 (void)SQLITE_MISUSE_BKPT;
2271 return 0;
2273 #endif
2274 sqlite3_mutex_enter(db->mutex);
2275 pRet = db->pUpdateArg;
2276 db->xUpdateCallback = xCallback;
2277 db->pUpdateArg = pArg;
2278 sqlite3_mutex_leave(db->mutex);
2279 return pRet;
2283 ** Register a callback to be invoked each time a transaction is rolled
2284 ** back by this database connection.
2286 void *sqlite3_rollback_hook(
2287 sqlite3 *db, /* Attach the hook to this database */
2288 void (*xCallback)(void*), /* Callback function */
2289 void *pArg /* Argument to the function */
2291 void *pRet;
2293 #ifdef SQLITE_ENABLE_API_ARMOR
2294 if( !sqlite3SafetyCheckOk(db) ){
2295 (void)SQLITE_MISUSE_BKPT;
2296 return 0;
2298 #endif
2299 sqlite3_mutex_enter(db->mutex);
2300 pRet = db->pRollbackArg;
2301 db->xRollbackCallback = xCallback;
2302 db->pRollbackArg = pArg;
2303 sqlite3_mutex_leave(db->mutex);
2304 return pRet;
2307 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
2309 ** Register a callback to be invoked each time a row is updated,
2310 ** inserted or deleted using this database connection.
2312 void *sqlite3_preupdate_hook(
2313 sqlite3 *db, /* Attach the hook to this database */
2314 void(*xCallback)( /* Callback function */
2315 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
2316 void *pArg /* First callback argument */
2318 void *pRet;
2319 sqlite3_mutex_enter(db->mutex);
2320 pRet = db->pPreUpdateArg;
2321 db->xPreUpdateCallback = xCallback;
2322 db->pPreUpdateArg = pArg;
2323 sqlite3_mutex_leave(db->mutex);
2324 return pRet;
2326 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
2329 ** Register a function to be invoked prior to each autovacuum that
2330 ** determines the number of pages to vacuum.
2332 int sqlite3_autovacuum_pages(
2333 sqlite3 *db, /* Attach the hook to this database */
2334 unsigned int (*xCallback)(void*,const char*,u32,u32,u32),
2335 void *pArg, /* Argument to the function */
2336 void (*xDestructor)(void*) /* Destructor for pArg */
2338 #ifdef SQLITE_ENABLE_API_ARMOR
2339 if( !sqlite3SafetyCheckOk(db) ){
2340 if( xDestructor ) xDestructor(pArg);
2341 return SQLITE_MISUSE_BKPT;
2343 #endif
2344 sqlite3_mutex_enter(db->mutex);
2345 if( db->xAutovacDestr ){
2346 db->xAutovacDestr(db->pAutovacPagesArg);
2348 db->xAutovacPages = xCallback;
2349 db->pAutovacPagesArg = pArg;
2350 db->xAutovacDestr = xDestructor;
2351 sqlite3_mutex_leave(db->mutex);
2352 return SQLITE_OK;
2356 #ifndef SQLITE_OMIT_WAL
2358 ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
2359 ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2360 ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
2361 ** wal_autocheckpoint()).
2363 int sqlite3WalDefaultHook(
2364 void *pClientData, /* Argument */
2365 sqlite3 *db, /* Connection */
2366 const char *zDb, /* Database */
2367 int nFrame /* Size of WAL */
2369 if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
2370 sqlite3BeginBenignMalloc();
2371 sqlite3_wal_checkpoint(db, zDb);
2372 sqlite3EndBenignMalloc();
2374 return SQLITE_OK;
2376 #endif /* SQLITE_OMIT_WAL */
2379 ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2380 ** a database after committing a transaction if there are nFrame or
2381 ** more frames in the log file. Passing zero or a negative value as the
2382 ** nFrame parameter disables automatic checkpoints entirely.
2384 ** The callback registered by this function replaces any existing callback
2385 ** registered using sqlite3_wal_hook(). Likewise, registering a callback
2386 ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2387 ** configured by this function.
2389 int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
2390 #ifdef SQLITE_OMIT_WAL
2391 UNUSED_PARAMETER(db);
2392 UNUSED_PARAMETER(nFrame);
2393 #else
2394 #ifdef SQLITE_ENABLE_API_ARMOR
2395 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2396 #endif
2397 if( nFrame>0 ){
2398 sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
2399 }else{
2400 sqlite3_wal_hook(db, 0, 0);
2402 #endif
2403 return SQLITE_OK;
2407 ** Register a callback to be invoked each time a transaction is written
2408 ** into the write-ahead-log by this database connection.
2410 void *sqlite3_wal_hook(
2411 sqlite3 *db, /* Attach the hook to this db handle */
2412 int(*xCallback)(void *, sqlite3*, const char*, int),
2413 void *pArg /* First argument passed to xCallback() */
2415 #ifndef SQLITE_OMIT_WAL
2416 void *pRet;
2417 #ifdef SQLITE_ENABLE_API_ARMOR
2418 if( !sqlite3SafetyCheckOk(db) ){
2419 (void)SQLITE_MISUSE_BKPT;
2420 return 0;
2422 #endif
2423 sqlite3_mutex_enter(db->mutex);
2424 pRet = db->pWalArg;
2425 db->xWalCallback = xCallback;
2426 db->pWalArg = pArg;
2427 sqlite3_mutex_leave(db->mutex);
2428 return pRet;
2429 #else
2430 return 0;
2431 #endif
2435 ** Checkpoint database zDb.
2437 int sqlite3_wal_checkpoint_v2(
2438 sqlite3 *db, /* Database handle */
2439 const char *zDb, /* Name of attached database (or NULL) */
2440 int eMode, /* SQLITE_CHECKPOINT_* value */
2441 int *pnLog, /* OUT: Size of WAL log in frames */
2442 int *pnCkpt /* OUT: Total number of frames checkpointed */
2444 #ifdef SQLITE_OMIT_WAL
2445 return SQLITE_OK;
2446 #else
2447 int rc; /* Return code */
2448 int iDb; /* Schema to checkpoint */
2450 #ifdef SQLITE_ENABLE_API_ARMOR
2451 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
2452 #endif
2454 /* Initialize the output variables to -1 in case an error occurs. */
2455 if( pnLog ) *pnLog = -1;
2456 if( pnCkpt ) *pnCkpt = -1;
2458 assert( SQLITE_CHECKPOINT_PASSIVE==0 );
2459 assert( SQLITE_CHECKPOINT_FULL==1 );
2460 assert( SQLITE_CHECKPOINT_RESTART==2 );
2461 assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
2462 if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
2463 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2464 ** mode: */
2465 return SQLITE_MISUSE;
2468 sqlite3_mutex_enter(db->mutex);
2469 if( zDb && zDb[0] ){
2470 iDb = sqlite3FindDbName(db, zDb);
2471 }else{
2472 iDb = SQLITE_MAX_DB; /* This means process all schemas */
2474 if( iDb<0 ){
2475 rc = SQLITE_ERROR;
2476 sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
2477 }else{
2478 db->busyHandler.nBusy = 0;
2479 rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
2480 sqlite3Error(db, rc);
2482 rc = sqlite3ApiExit(db, rc);
2484 /* If there are no active statements, clear the interrupt flag at this
2485 ** point. */
2486 if( db->nVdbeActive==0 ){
2487 AtomicStore(&db->u1.isInterrupted, 0);
2490 sqlite3_mutex_leave(db->mutex);
2491 return rc;
2492 #endif
2497 ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2498 ** to contains a zero-length string, all attached databases are
2499 ** checkpointed.
2501 int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
2502 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2503 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2504 return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
2507 #ifndef SQLITE_OMIT_WAL
2509 ** Run a checkpoint on database iDb. This is a no-op if database iDb is
2510 ** not currently open in WAL mode.
2512 ** If a transaction is open on the database being checkpointed, this
2513 ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2514 ** an error occurs while running the checkpoint, an SQLite error code is
2515 ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
2517 ** The mutex on database handle db should be held by the caller. The mutex
2518 ** associated with the specific b-tree being checkpointed is taken by
2519 ** this function while the checkpoint is running.
2521 ** If iDb is passed SQLITE_MAX_DB then all attached databases are
2522 ** checkpointed. If an error is encountered it is returned immediately -
2523 ** no attempt is made to checkpoint any remaining databases.
2525 ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2526 ** or TRUNCATE.
2528 int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
2529 int rc = SQLITE_OK; /* Return code */
2530 int i; /* Used to iterate through attached dbs */
2531 int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
2533 assert( sqlite3_mutex_held(db->mutex) );
2534 assert( !pnLog || *pnLog==-1 );
2535 assert( !pnCkpt || *pnCkpt==-1 );
2536 testcase( iDb==SQLITE_MAX_ATTACHED ); /* See forum post a006d86f72 */
2537 testcase( iDb==SQLITE_MAX_DB );
2539 for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
2540 if( i==iDb || iDb==SQLITE_MAX_DB ){
2541 rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
2542 pnLog = 0;
2543 pnCkpt = 0;
2544 if( rc==SQLITE_BUSY ){
2545 bBusy = 1;
2546 rc = SQLITE_OK;
2551 return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
2553 #endif /* SQLITE_OMIT_WAL */
2556 ** This function returns true if main-memory should be used instead of
2557 ** a temporary file for transient pager files and statement journals.
2558 ** The value returned depends on the value of db->temp_store (runtime
2559 ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2560 ** following table describes the relationship between these two values
2561 ** and this functions return value.
2563 ** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2564 ** ----------------- -------------- ------------------------------
2565 ** 0 any file (return 0)
2566 ** 1 1 file (return 0)
2567 ** 1 2 memory (return 1)
2568 ** 1 0 file (return 0)
2569 ** 2 1 file (return 0)
2570 ** 2 2 memory (return 1)
2571 ** 2 0 memory (return 1)
2572 ** 3 any memory (return 1)
2574 int sqlite3TempInMemory(const sqlite3 *db){
2575 #if SQLITE_TEMP_STORE==1
2576 return ( db->temp_store==2 );
2577 #endif
2578 #if SQLITE_TEMP_STORE==2
2579 return ( db->temp_store!=1 );
2580 #endif
2581 #if SQLITE_TEMP_STORE==3
2582 UNUSED_PARAMETER(db);
2583 return 1;
2584 #endif
2585 #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
2586 UNUSED_PARAMETER(db);
2587 return 0;
2588 #endif
2592 ** Return UTF-8 encoded English language explanation of the most recent
2593 ** error.
2595 const char *sqlite3_errmsg(sqlite3 *db){
2596 const char *z;
2597 if( !db ){
2598 return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
2600 if( !sqlite3SafetyCheckSickOrOk(db) ){
2601 return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
2603 sqlite3_mutex_enter(db->mutex);
2604 if( db->mallocFailed ){
2605 z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
2606 }else{
2607 testcase( db->pErr==0 );
2608 z = db->errCode ? (char*)sqlite3_value_text(db->pErr) : 0;
2609 assert( !db->mallocFailed );
2610 if( z==0 ){
2611 z = sqlite3ErrStr(db->errCode);
2614 sqlite3_mutex_leave(db->mutex);
2615 return z;
2619 ** Return the byte offset of the most recent error
2621 int sqlite3_error_offset(sqlite3 *db){
2622 int iOffset = -1;
2623 if( db && sqlite3SafetyCheckSickOrOk(db) && db->errCode ){
2624 sqlite3_mutex_enter(db->mutex);
2625 iOffset = db->errByteOffset;
2626 sqlite3_mutex_leave(db->mutex);
2628 return iOffset;
2631 #ifndef SQLITE_OMIT_UTF16
2633 ** Return UTF-16 encoded English language explanation of the most recent
2634 ** error.
2636 const void *sqlite3_errmsg16(sqlite3 *db){
2637 static const u16 outOfMem[] = {
2638 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
2640 static const u16 misuse[] = {
2641 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2642 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2643 'm', 'i', 's', 'u', 's', 'e', 0
2646 const void *z;
2647 if( !db ){
2648 return (void *)outOfMem;
2650 if( !sqlite3SafetyCheckSickOrOk(db) ){
2651 return (void *)misuse;
2653 sqlite3_mutex_enter(db->mutex);
2654 if( db->mallocFailed ){
2655 z = (void *)outOfMem;
2656 }else{
2657 z = sqlite3_value_text16(db->pErr);
2658 if( z==0 ){
2659 sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
2660 z = sqlite3_value_text16(db->pErr);
2662 /* A malloc() may have failed within the call to sqlite3_value_text16()
2663 ** above. If this is the case, then the db->mallocFailed flag needs to
2664 ** be cleared before returning. Do this directly, instead of via
2665 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2667 sqlite3OomClear(db);
2669 sqlite3_mutex_leave(db->mutex);
2670 return z;
2672 #endif /* SQLITE_OMIT_UTF16 */
2675 ** Return the most recent error code generated by an SQLite routine. If NULL is
2676 ** passed to this function, we assume a malloc() failed during sqlite3_open().
2678 int sqlite3_errcode(sqlite3 *db){
2679 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
2680 return SQLITE_MISUSE_BKPT;
2682 if( !db || db->mallocFailed ){
2683 return SQLITE_NOMEM_BKPT;
2685 return db->errCode & db->errMask;
2687 int sqlite3_extended_errcode(sqlite3 *db){
2688 if( db && !sqlite3SafetyCheckSickOrOk(db) ){
2689 return SQLITE_MISUSE_BKPT;
2691 if( !db || db->mallocFailed ){
2692 return SQLITE_NOMEM_BKPT;
2694 return db->errCode;
2696 int sqlite3_system_errno(sqlite3 *db){
2697 return db ? db->iSysErrno : 0;
2701 ** Return a string that describes the kind of error specified in the
2702 ** argument. For now, this simply calls the internal sqlite3ErrStr()
2703 ** function.
2705 const char *sqlite3_errstr(int rc){
2706 return sqlite3ErrStr(rc);
2710 ** Create a new collating function for database "db". The name is zName
2711 ** and the encoding is enc.
2713 static int createCollation(
2714 sqlite3* db,
2715 const char *zName,
2716 u8 enc,
2717 void* pCtx,
2718 int(*xCompare)(void*,int,const void*,int,const void*),
2719 void(*xDel)(void*)
2721 CollSeq *pColl;
2722 int enc2;
2724 assert( sqlite3_mutex_held(db->mutex) );
2726 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2727 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2728 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2730 enc2 = enc;
2731 testcase( enc2==SQLITE_UTF16 );
2732 testcase( enc2==SQLITE_UTF16_ALIGNED );
2733 if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
2734 enc2 = SQLITE_UTF16NATIVE;
2736 if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
2737 return SQLITE_MISUSE_BKPT;
2740 /* Check if this call is removing or replacing an existing collation
2741 ** sequence. If so, and there are active VMs, return busy. If there
2742 ** are no active VMs, invalidate any pre-compiled statements.
2744 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
2745 if( pColl && pColl->xCmp ){
2746 if( db->nVdbeActive ){
2747 sqlite3ErrorWithMsg(db, SQLITE_BUSY,
2748 "unable to delete/modify collation sequence due to active statements");
2749 return SQLITE_BUSY;
2751 sqlite3ExpirePreparedStatements(db, 0);
2753 /* If collation sequence pColl was created directly by a call to
2754 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2755 ** then any copies made by synthCollSeq() need to be invalidated.
2756 ** Also, collation destructor - CollSeq.xDel() - function may need
2757 ** to be called.
2759 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
2760 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
2761 int j;
2762 for(j=0; j<3; j++){
2763 CollSeq *p = &aColl[j];
2764 if( p->enc==pColl->enc ){
2765 if( p->xDel ){
2766 p->xDel(p->pUser);
2768 p->xCmp = 0;
2774 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
2775 if( pColl==0 ) return SQLITE_NOMEM_BKPT;
2776 pColl->xCmp = xCompare;
2777 pColl->pUser = pCtx;
2778 pColl->xDel = xDel;
2779 pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
2780 sqlite3Error(db, SQLITE_OK);
2781 return SQLITE_OK;
2786 ** This array defines hard upper bounds on limit values. The
2787 ** initializer must be kept in sync with the SQLITE_LIMIT_*
2788 ** #defines in sqlite3.h.
2790 static const int aHardLimit[] = {
2791 SQLITE_MAX_LENGTH,
2792 SQLITE_MAX_SQL_LENGTH,
2793 SQLITE_MAX_COLUMN,
2794 SQLITE_MAX_EXPR_DEPTH,
2795 SQLITE_MAX_COMPOUND_SELECT,
2796 SQLITE_MAX_VDBE_OP,
2797 SQLITE_MAX_FUNCTION_ARG,
2798 SQLITE_MAX_ATTACHED,
2799 SQLITE_MAX_LIKE_PATTERN_LENGTH,
2800 SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
2801 SQLITE_MAX_TRIGGER_DEPTH,
2802 SQLITE_MAX_WORKER_THREADS,
2806 ** Make sure the hard limits are set to reasonable values
2808 #if SQLITE_MAX_LENGTH<100
2809 # error SQLITE_MAX_LENGTH must be at least 100
2810 #endif
2811 #if SQLITE_MAX_SQL_LENGTH<100
2812 # error SQLITE_MAX_SQL_LENGTH must be at least 100
2813 #endif
2814 #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2815 # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2816 #endif
2817 #if SQLITE_MAX_COMPOUND_SELECT<2
2818 # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2819 #endif
2820 #if SQLITE_MAX_VDBE_OP<40
2821 # error SQLITE_MAX_VDBE_OP must be at least 40
2822 #endif
2823 #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2824 # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
2825 #endif
2826 #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2827 # error SQLITE_MAX_ATTACHED must be between 0 and 125
2828 #endif
2829 #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2830 # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2831 #endif
2832 #if SQLITE_MAX_COLUMN>32767
2833 # error SQLITE_MAX_COLUMN must not exceed 32767
2834 #endif
2835 #if SQLITE_MAX_TRIGGER_DEPTH<1
2836 # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2837 #endif
2838 #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2839 # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2840 #endif
2844 ** Change the value of a limit. Report the old value.
2845 ** If an invalid limit index is supplied, report -1.
2846 ** Make no changes but still report the old value if the
2847 ** new limit is negative.
2849 ** A new lower limit does not shrink existing constructs.
2850 ** It merely prevents new constructs that exceed the limit
2851 ** from forming.
2853 int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
2854 int oldLimit;
2856 #ifdef SQLITE_ENABLE_API_ARMOR
2857 if( !sqlite3SafetyCheckOk(db) ){
2858 (void)SQLITE_MISUSE_BKPT;
2859 return -1;
2861 #endif
2863 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2864 ** there is a hard upper bound set at compile-time by a C preprocessor
2865 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2866 ** "_MAX_".)
2868 assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
2869 assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
2870 assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
2871 assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
2872 assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
2873 assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
2874 assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
2875 assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
2876 assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
2877 SQLITE_MAX_LIKE_PATTERN_LENGTH );
2878 assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
2879 assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
2880 assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
2881 assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
2884 if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
2885 return -1;
2887 oldLimit = db->aLimit[limitId];
2888 if( newLimit>=0 ){ /* IMP: R-52476-28732 */
2889 if( newLimit>aHardLimit[limitId] ){
2890 newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
2891 }else if( newLimit<1 && limitId==SQLITE_LIMIT_LENGTH ){
2892 newLimit = 1;
2894 db->aLimit[limitId] = newLimit;
2896 return oldLimit; /* IMP: R-53341-35419 */
2900 ** This function is used to parse both URIs and non-URI filenames passed by the
2901 ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2902 ** URIs specified as part of ATTACH statements.
2904 ** The first argument to this function is the name of the VFS to use (or
2905 ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2906 ** query parameter. The second argument contains the URI (or non-URI filename)
2907 ** itself. When this function is called the *pFlags variable should contain
2908 ** the default flags to open the database handle with. The value stored in
2909 ** *pFlags may be updated before returning if the URI filename contains
2910 ** "cache=xxx" or "mode=xxx" query parameters.
2912 ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2913 ** the VFS that should be used to open the database file. *pzFile is set to
2914 ** point to a buffer containing the name of the file to open. The value
2915 ** stored in *pzFile is a database name acceptable to sqlite3_uri_parameter()
2916 ** and is in the same format as names created using sqlite3_create_filename().
2917 ** The caller must invoke sqlite3_free_filename() (not sqlite3_free()!) on
2918 ** the value returned in *pzFile to avoid a memory leak.
2920 ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2921 ** may be set to point to a buffer containing an English language error
2922 ** message. It is the responsibility of the caller to eventually release
2923 ** this buffer by calling sqlite3_free().
2925 int sqlite3ParseUri(
2926 const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
2927 const char *zUri, /* Nul-terminated URI to parse */
2928 unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
2929 sqlite3_vfs **ppVfs, /* OUT: VFS to use */
2930 char **pzFile, /* OUT: Filename component of URI */
2931 char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
2933 int rc = SQLITE_OK;
2934 unsigned int flags = *pFlags;
2935 const char *zVfs = zDefaultVfs;
2936 char *zFile;
2937 char c;
2938 int nUri = sqlite3Strlen30(zUri);
2940 assert( *pzErrMsg==0 );
2942 if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
2943 || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
2944 && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
2946 char *zOpt;
2947 int eState; /* Parser state when parsing URI */
2948 int iIn; /* Input character index */
2949 int iOut = 0; /* Output character index */
2950 u64 nByte = nUri+8; /* Bytes of space to allocate */
2952 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2953 ** method that there may be extra parameters following the file-name. */
2954 flags |= SQLITE_OPEN_URI;
2956 for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
2957 zFile = sqlite3_malloc64(nByte);
2958 if( !zFile ) return SQLITE_NOMEM_BKPT;
2960 memset(zFile, 0, 4); /* 4-byte of 0x00 is the start of DB name marker */
2961 zFile += 4;
2963 iIn = 5;
2964 #ifdef SQLITE_ALLOW_URI_AUTHORITY
2965 if( strncmp(zUri+5, "///", 3)==0 ){
2966 iIn = 7;
2967 /* The following condition causes URIs with five leading / characters
2968 ** like file://///host/path to be converted into UNCs like //host/path.
2969 ** The correct URI for that UNC has only two or four leading / characters
2970 ** file://host/path or file:////host/path. But 5 leading slashes is a
2971 ** common error, we are told, so we handle it as a special case. */
2972 if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
2973 }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
2974 iIn = 16;
2976 #else
2977 /* Discard the scheme and authority segments of the URI. */
2978 if( zUri[5]=='/' && zUri[6]=='/' ){
2979 iIn = 7;
2980 while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
2981 if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
2982 *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
2983 iIn-7, &zUri[7]);
2984 rc = SQLITE_ERROR;
2985 goto parse_uri_out;
2988 #endif
2990 /* Copy the filename and any query parameters into the zFile buffer.
2991 ** Decode %HH escape codes along the way.
2993 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2994 ** on the parsing context. As follows:
2996 ** 0: Parsing file-name.
2997 ** 1: Parsing name section of a name=value query parameter.
2998 ** 2: Parsing value section of a name=value query parameter.
3000 eState = 0;
3001 while( (c = zUri[iIn])!=0 && c!='#' ){
3002 iIn++;
3003 if( c=='%'
3004 && sqlite3Isxdigit(zUri[iIn])
3005 && sqlite3Isxdigit(zUri[iIn+1])
3007 int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
3008 octet += sqlite3HexToInt(zUri[iIn++]);
3010 assert( octet>=0 && octet<256 );
3011 if( octet==0 ){
3012 #ifndef SQLITE_ENABLE_URI_00_ERROR
3013 /* This branch is taken when "%00" appears within the URI. In this
3014 ** case we ignore all text in the remainder of the path, name or
3015 ** value currently being parsed. So ignore the current character
3016 ** and skip to the next "?", "=" or "&", as appropriate. */
3017 while( (c = zUri[iIn])!=0 && c!='#'
3018 && (eState!=0 || c!='?')
3019 && (eState!=1 || (c!='=' && c!='&'))
3020 && (eState!=2 || c!='&')
3022 iIn++;
3024 continue;
3025 #else
3026 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
3027 *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
3028 rc = SQLITE_ERROR;
3029 goto parse_uri_out;
3030 #endif
3032 c = octet;
3033 }else if( eState==1 && (c=='&' || c=='=') ){
3034 if( zFile[iOut-1]==0 ){
3035 /* An empty option name. Ignore this option altogether. */
3036 while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
3037 continue;
3039 if( c=='&' ){
3040 zFile[iOut++] = '\0';
3041 }else{
3042 eState = 2;
3044 c = 0;
3045 }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
3046 c = 0;
3047 eState = 1;
3049 zFile[iOut++] = c;
3051 if( eState==1 ) zFile[iOut++] = '\0';
3052 memset(zFile+iOut, 0, 4); /* end-of-options + empty journal filenames */
3054 /* Check if there were any options specified that should be interpreted
3055 ** here. Options that are interpreted here include "vfs" and those that
3056 ** correspond to flags that may be passed to the sqlite3_open_v2()
3057 ** method. */
3058 zOpt = &zFile[sqlite3Strlen30(zFile)+1];
3059 while( zOpt[0] ){
3060 int nOpt = sqlite3Strlen30(zOpt);
3061 char *zVal = &zOpt[nOpt+1];
3062 int nVal = sqlite3Strlen30(zVal);
3064 if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
3065 zVfs = zVal;
3066 }else{
3067 struct OpenMode {
3068 const char *z;
3069 int mode;
3070 } *aMode = 0;
3071 char *zModeType = 0;
3072 int mask = 0;
3073 int limit = 0;
3075 if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
3076 static struct OpenMode aCacheMode[] = {
3077 { "shared", SQLITE_OPEN_SHAREDCACHE },
3078 { "private", SQLITE_OPEN_PRIVATECACHE },
3079 { 0, 0 }
3082 mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
3083 aMode = aCacheMode;
3084 limit = mask;
3085 zModeType = "cache";
3087 if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
3088 static struct OpenMode aOpenMode[] = {
3089 { "ro", SQLITE_OPEN_READONLY },
3090 { "rw", SQLITE_OPEN_READWRITE },
3091 { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
3092 { "memory", SQLITE_OPEN_MEMORY },
3093 { 0, 0 }
3096 mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
3097 | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
3098 aMode = aOpenMode;
3099 limit = mask & flags;
3100 zModeType = "access";
3103 if( aMode ){
3104 int i;
3105 int mode = 0;
3106 for(i=0; aMode[i].z; i++){
3107 const char *z = aMode[i].z;
3108 if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
3109 mode = aMode[i].mode;
3110 break;
3113 if( mode==0 ){
3114 *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
3115 rc = SQLITE_ERROR;
3116 goto parse_uri_out;
3118 if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
3119 *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
3120 zModeType, zVal);
3121 rc = SQLITE_PERM;
3122 goto parse_uri_out;
3124 flags = (flags & ~mask) | mode;
3128 zOpt = &zVal[nVal+1];
3131 }else{
3132 zFile = sqlite3_malloc64(nUri+8);
3133 if( !zFile ) return SQLITE_NOMEM_BKPT;
3134 memset(zFile, 0, 4);
3135 zFile += 4;
3136 if( nUri ){
3137 memcpy(zFile, zUri, nUri);
3139 memset(zFile+nUri, 0, 4);
3140 flags &= ~SQLITE_OPEN_URI;
3143 *ppVfs = sqlite3_vfs_find(zVfs);
3144 if( *ppVfs==0 ){
3145 *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
3146 rc = SQLITE_ERROR;
3148 parse_uri_out:
3149 if( rc!=SQLITE_OK ){
3150 sqlite3_free_filename(zFile);
3151 zFile = 0;
3153 *pFlags = flags;
3154 *pzFile = zFile;
3155 return rc;
3159 ** This routine does the core work of extracting URI parameters from a
3160 ** database filename for the sqlite3_uri_parameter() interface.
3162 static const char *uriParameter(const char *zFilename, const char *zParam){
3163 zFilename += sqlite3Strlen30(zFilename) + 1;
3164 while( ALWAYS(zFilename!=0) && zFilename[0] ){
3165 int x = strcmp(zFilename, zParam);
3166 zFilename += sqlite3Strlen30(zFilename) + 1;
3167 if( x==0 ) return zFilename;
3168 zFilename += sqlite3Strlen30(zFilename) + 1;
3170 return 0;
3176 ** This routine does the work of opening a database on behalf of
3177 ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
3178 ** is UTF-8 encoded.
3180 static int openDatabase(
3181 const char *zFilename, /* Database filename UTF-8 encoded */
3182 sqlite3 **ppDb, /* OUT: Returned database handle */
3183 unsigned int flags, /* Operational flags */
3184 const char *zVfs /* Name of the VFS to use */
3186 sqlite3 *db; /* Store allocated handle here */
3187 int rc; /* Return code */
3188 int isThreadsafe; /* True for threadsafe connections */
3189 char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
3190 char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
3191 int i; /* Loop counter */
3193 #ifdef SQLITE_ENABLE_API_ARMOR
3194 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3195 #endif
3196 *ppDb = 0;
3197 #ifndef SQLITE_OMIT_AUTOINIT
3198 rc = sqlite3_initialize();
3199 if( rc ) return rc;
3200 #endif
3202 if( sqlite3GlobalConfig.bCoreMutex==0 ){
3203 isThreadsafe = 0;
3204 }else if( flags & SQLITE_OPEN_NOMUTEX ){
3205 isThreadsafe = 0;
3206 }else if( flags & SQLITE_OPEN_FULLMUTEX ){
3207 isThreadsafe = 1;
3208 }else{
3209 isThreadsafe = sqlite3GlobalConfig.bFullMutex;
3212 if( flags & SQLITE_OPEN_PRIVATECACHE ){
3213 flags &= ~SQLITE_OPEN_SHAREDCACHE;
3214 }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
3215 flags |= SQLITE_OPEN_SHAREDCACHE;
3218 /* Remove harmful bits from the flags parameter
3220 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
3221 ** dealt with in the previous code block. Besides these, the only
3222 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
3223 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
3224 ** SQLITE_OPEN_PRIVATECACHE, SQLITE_OPEN_EXRESCODE, and some reserved
3225 ** bits. Silently mask off all other flags.
3227 flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
3228 SQLITE_OPEN_EXCLUSIVE |
3229 SQLITE_OPEN_MAIN_DB |
3230 SQLITE_OPEN_TEMP_DB |
3231 SQLITE_OPEN_TRANSIENT_DB |
3232 SQLITE_OPEN_MAIN_JOURNAL |
3233 SQLITE_OPEN_TEMP_JOURNAL |
3234 SQLITE_OPEN_SUBJOURNAL |
3235 SQLITE_OPEN_SUPER_JOURNAL |
3236 SQLITE_OPEN_NOMUTEX |
3237 SQLITE_OPEN_FULLMUTEX |
3238 SQLITE_OPEN_WAL
3241 /* Allocate the sqlite data structure */
3242 db = sqlite3MallocZero( sizeof(sqlite3) );
3243 if( db==0 ) goto opendb_out;
3244 if( isThreadsafe
3245 #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
3246 || sqlite3GlobalConfig.bCoreMutex
3247 #endif
3249 db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
3250 if( db->mutex==0 ){
3251 sqlite3_free(db);
3252 db = 0;
3253 goto opendb_out;
3255 if( isThreadsafe==0 ){
3256 sqlite3MutexWarnOnContention(db->mutex);
3259 sqlite3_mutex_enter(db->mutex);
3260 db->errMask = (flags & SQLITE_OPEN_EXRESCODE)!=0 ? 0xffffffff : 0xff;
3261 db->nDb = 2;
3262 db->eOpenState = SQLITE_STATE_BUSY;
3263 db->aDb = db->aDbStatic;
3264 db->lookaside.bDisable = 1;
3265 db->lookaside.sz = 0;
3267 assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
3268 memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
3269 db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
3270 db->autoCommit = 1;
3271 db->nextAutovac = -1;
3272 db->szMmap = sqlite3GlobalConfig.szMmap;
3273 db->nextPagesize = 0;
3274 db->init.azInit = sqlite3StdType; /* Any array of string ptrs will do */
3275 #ifdef SQLITE_ENABLE_SORTER_MMAP
3276 /* Beginning with version 3.37.0, using the VFS xFetch() API to memory-map
3277 ** the temporary files used to do external sorts (see code in vdbesort.c)
3278 ** is disabled. It can still be used either by defining
3279 ** SQLITE_ENABLE_SORTER_MMAP at compile time or by using the
3280 ** SQLITE_TESTCTRL_SORTER_MMAP test-control at runtime. */
3281 db->nMaxSorterMmap = 0x7FFFFFFF;
3282 #endif
3283 db->flags |= SQLITE_ShortColNames
3284 | SQLITE_EnableTrigger
3285 | SQLITE_EnableView
3286 | SQLITE_CacheSpill
3287 #if !defined(SQLITE_TRUSTED_SCHEMA) || SQLITE_TRUSTED_SCHEMA+0!=0
3288 | SQLITE_TrustedSchema
3289 #endif
3290 /* The SQLITE_DQS compile-time option determines the default settings
3291 ** for SQLITE_DBCONFIG_DQS_DDL and SQLITE_DBCONFIG_DQS_DML.
3293 ** SQLITE_DQS SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML
3294 ** ---------- ----------------------- -----------------------
3295 ** undefined on on
3296 ** 3 on on
3297 ** 2 on off
3298 ** 1 off on
3299 ** 0 off off
3301 ** Legacy behavior is 3 (double-quoted string literals are allowed anywhere)
3302 ** and so that is the default. But developers are encouranged to use
3303 ** -DSQLITE_DQS=0 (best) or -DSQLITE_DQS=1 (second choice) if possible.
3305 #if !defined(SQLITE_DQS)
3306 # define SQLITE_DQS 3
3307 #endif
3308 #if (SQLITE_DQS&1)==1
3309 | SQLITE_DqsDML
3310 #endif
3311 #if (SQLITE_DQS&2)==2
3312 | SQLITE_DqsDDL
3313 #endif
3315 #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
3316 | SQLITE_AutoIndex
3317 #endif
3318 #if SQLITE_DEFAULT_CKPTFULLFSYNC
3319 | SQLITE_CkptFullFSync
3320 #endif
3321 #if SQLITE_DEFAULT_FILE_FORMAT<4
3322 | SQLITE_LegacyFileFmt
3323 #endif
3324 #ifdef SQLITE_ENABLE_LOAD_EXTENSION
3325 | SQLITE_LoadExtension
3326 #endif
3327 #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
3328 | SQLITE_RecTriggers
3329 #endif
3330 #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3331 | SQLITE_ForeignKeys
3332 #endif
3333 #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3334 | SQLITE_ReverseOrder
3335 #endif
3336 #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3337 | SQLITE_CellSizeCk
3338 #endif
3339 #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3340 | SQLITE_Fts3Tokenizer
3341 #endif
3342 #if defined(SQLITE_ENABLE_QPSG)
3343 | SQLITE_EnableQPSG
3344 #endif
3345 #if defined(SQLITE_DEFAULT_DEFENSIVE)
3346 | SQLITE_Defensive
3347 #endif
3348 #if defined(SQLITE_DEFAULT_LEGACY_ALTER_TABLE)
3349 | SQLITE_LegacyAlter
3350 #endif
3352 sqlite3HashInit(&db->aCollSeq);
3353 #ifndef SQLITE_OMIT_VIRTUALTABLE
3354 sqlite3HashInit(&db->aModule);
3355 #endif
3357 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3358 ** and UTF-16, so add a version for each to avoid any unnecessary
3359 ** conversions. The only error that can occur here is a malloc() failure.
3361 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3362 ** functions:
3364 createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
3365 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
3366 createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
3367 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
3368 createCollation(db, "RTRIM", SQLITE_UTF8, 0, rtrimCollFunc, 0);
3369 if( db->mallocFailed ){
3370 goto opendb_out;
3373 #if SQLITE_OS_UNIX && defined(SQLITE_OS_KV_OPTIONAL)
3374 /* Process magic filenames ":localStorage:" and ":sessionStorage:" */
3375 if( zFilename && zFilename[0]==':' ){
3376 if( strcmp(zFilename, ":localStorage:")==0 ){
3377 zFilename = "file:local?vfs=kvvfs";
3378 flags |= SQLITE_OPEN_URI;
3379 }else if( strcmp(zFilename, ":sessionStorage:")==0 ){
3380 zFilename = "file:session?vfs=kvvfs";
3381 flags |= SQLITE_OPEN_URI;
3384 #endif /* SQLITE_OS_UNIX && defined(SQLITE_OS_KV_OPTIONAL) */
3386 /* Parse the filename/URI argument
3388 ** Only allow sensible combinations of bits in the flags argument.
3389 ** Throw an error if any non-sense combination is used. If we
3390 ** do not block illegal combinations here, it could trigger
3391 ** assert() statements in deeper layers. Sensible combinations
3392 ** are:
3394 ** 1: SQLITE_OPEN_READONLY
3395 ** 2: SQLITE_OPEN_READWRITE
3396 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3398 db->openFlags = flags;
3399 assert( SQLITE_OPEN_READONLY == 0x01 );
3400 assert( SQLITE_OPEN_READWRITE == 0x02 );
3401 assert( SQLITE_OPEN_CREATE == 0x04 );
3402 testcase( (1<<(flags&7))==0x02 ); /* READONLY */
3403 testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
3404 testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
3405 if( ((1<<(flags&7)) & 0x46)==0 ){
3406 rc = SQLITE_MISUSE_BKPT; /* IMP: R-18321-05872 */
3407 }else{
3408 rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
3410 if( rc!=SQLITE_OK ){
3411 if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
3412 sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
3413 sqlite3_free(zErrMsg);
3414 goto opendb_out;
3416 assert( db->pVfs!=0 );
3417 #if SQLITE_OS_KV || defined(SQLITE_OS_KV_OPTIONAL)
3418 if( sqlite3_stricmp(db->pVfs->zName, "kvvfs")==0 ){
3419 db->temp_store = 2;
3421 #endif
3423 /* Open the backend database driver */
3424 rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
3425 flags | SQLITE_OPEN_MAIN_DB);
3426 if( rc!=SQLITE_OK ){
3427 if( rc==SQLITE_IOERR_NOMEM ){
3428 rc = SQLITE_NOMEM_BKPT;
3430 sqlite3Error(db, rc);
3431 goto opendb_out;
3433 sqlite3BtreeEnter(db->aDb[0].pBt);
3434 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
3435 if( !db->mallocFailed ){
3436 sqlite3SetTextEncoding(db, SCHEMA_ENC(db));
3438 sqlite3BtreeLeave(db->aDb[0].pBt);
3439 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
3441 /* The default safety_level for the main database is FULL; for the temp
3442 ** database it is OFF. This matches the pager layer defaults.
3444 db->aDb[0].zDbSName = "main";
3445 db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
3446 db->aDb[1].zDbSName = "temp";
3447 db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
3449 db->eOpenState = SQLITE_STATE_OPEN;
3450 if( db->mallocFailed ){
3451 goto opendb_out;
3454 /* Register all built-in functions, but do not attempt to read the
3455 ** database schema yet. This is delayed until the first time the database
3456 ** is accessed.
3458 sqlite3Error(db, SQLITE_OK);
3459 sqlite3RegisterPerConnectionBuiltinFunctions(db);
3460 rc = sqlite3_errcode(db);
3463 /* Load compiled-in extensions */
3464 for(i=0; rc==SQLITE_OK && i<ArraySize(sqlite3BuiltinExtensions); i++){
3465 rc = sqlite3BuiltinExtensions[i](db);
3468 /* Load automatic extensions - extensions that have been registered
3469 ** using the sqlite3_automatic_extension() API.
3471 if( rc==SQLITE_OK ){
3472 sqlite3AutoLoadExtensions(db);
3473 rc = sqlite3_errcode(db);
3474 if( rc!=SQLITE_OK ){
3475 goto opendb_out;
3479 #ifdef SQLITE_ENABLE_INTERNAL_FUNCTIONS
3480 /* Testing use only!!! The -DSQLITE_ENABLE_INTERNAL_FUNCTIONS=1 compile-time
3481 ** option gives access to internal functions by default.
3482 ** Testing use only!!! */
3483 db->mDbFlags |= DBFLAG_InternalFunc;
3484 #endif
3486 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3487 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3488 ** mode. Doing nothing at all also makes NORMAL the default.
3490 #ifdef SQLITE_DEFAULT_LOCKING_MODE
3491 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
3492 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
3493 SQLITE_DEFAULT_LOCKING_MODE);
3494 #endif
3496 if( rc ) sqlite3Error(db, rc);
3498 /* Enable the lookaside-malloc subsystem */
3499 setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
3500 sqlite3GlobalConfig.nLookaside);
3502 sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
3504 opendb_out:
3505 if( db ){
3506 assert( db->mutex!=0 || isThreadsafe==0
3507 || sqlite3GlobalConfig.bFullMutex==0 );
3508 sqlite3_mutex_leave(db->mutex);
3510 rc = sqlite3_errcode(db);
3511 assert( db!=0 || (rc&0xff)==SQLITE_NOMEM );
3512 if( (rc&0xff)==SQLITE_NOMEM ){
3513 sqlite3_close(db);
3514 db = 0;
3515 }else if( rc!=SQLITE_OK ){
3516 db->eOpenState = SQLITE_STATE_SICK;
3518 *ppDb = db;
3519 #ifdef SQLITE_ENABLE_SQLLOG
3520 if( sqlite3GlobalConfig.xSqllog ){
3521 /* Opening a db handle. Fourth parameter is passed 0. */
3522 void *pArg = sqlite3GlobalConfig.pSqllogArg;
3523 sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
3525 #endif
3526 sqlite3_free_filename(zOpen);
3527 return rc;
3532 ** Open a new database handle.
3534 int sqlite3_open(
3535 const char *zFilename,
3536 sqlite3 **ppDb
3538 return openDatabase(zFilename, ppDb,
3539 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3541 int sqlite3_open_v2(
3542 const char *filename, /* Database filename (UTF-8) */
3543 sqlite3 **ppDb, /* OUT: SQLite db handle */
3544 int flags, /* Flags */
3545 const char *zVfs /* Name of VFS module to use */
3547 return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
3550 #ifndef SQLITE_OMIT_UTF16
3552 ** Open a new database handle.
3554 int sqlite3_open16(
3555 const void *zFilename,
3556 sqlite3 **ppDb
3558 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
3559 sqlite3_value *pVal;
3560 int rc;
3562 #ifdef SQLITE_ENABLE_API_ARMOR
3563 if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
3564 #endif
3565 *ppDb = 0;
3566 #ifndef SQLITE_OMIT_AUTOINIT
3567 rc = sqlite3_initialize();
3568 if( rc ) return rc;
3569 #endif
3570 if( zFilename==0 ) zFilename = "\000\000";
3571 pVal = sqlite3ValueNew(0);
3572 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
3573 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
3574 if( zFilename8 ){
3575 rc = openDatabase(zFilename8, ppDb,
3576 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
3577 assert( *ppDb || rc==SQLITE_NOMEM );
3578 if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
3579 SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
3581 }else{
3582 rc = SQLITE_NOMEM_BKPT;
3584 sqlite3ValueFree(pVal);
3586 return rc & 0xff;
3588 #endif /* SQLITE_OMIT_UTF16 */
3591 ** Register a new collation sequence with the database handle db.
3593 int sqlite3_create_collation(
3594 sqlite3* db,
3595 const char *zName,
3596 int enc,
3597 void* pCtx,
3598 int(*xCompare)(void*,int,const void*,int,const void*)
3600 return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
3604 ** Register a new collation sequence with the database handle db.
3606 int sqlite3_create_collation_v2(
3607 sqlite3* db,
3608 const char *zName,
3609 int enc,
3610 void* pCtx,
3611 int(*xCompare)(void*,int,const void*,int,const void*),
3612 void(*xDel)(void*)
3614 int rc;
3616 #ifdef SQLITE_ENABLE_API_ARMOR
3617 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3618 #endif
3619 sqlite3_mutex_enter(db->mutex);
3620 assert( !db->mallocFailed );
3621 rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
3622 rc = sqlite3ApiExit(db, rc);
3623 sqlite3_mutex_leave(db->mutex);
3624 return rc;
3627 #ifndef SQLITE_OMIT_UTF16
3629 ** Register a new collation sequence with the database handle db.
3631 int sqlite3_create_collation16(
3632 sqlite3* db,
3633 const void *zName,
3634 int enc,
3635 void* pCtx,
3636 int(*xCompare)(void*,int,const void*,int,const void*)
3638 int rc = SQLITE_OK;
3639 char *zName8;
3641 #ifdef SQLITE_ENABLE_API_ARMOR
3642 if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
3643 #endif
3644 sqlite3_mutex_enter(db->mutex);
3645 assert( !db->mallocFailed );
3646 zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
3647 if( zName8 ){
3648 rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
3649 sqlite3DbFree(db, zName8);
3651 rc = sqlite3ApiExit(db, rc);
3652 sqlite3_mutex_leave(db->mutex);
3653 return rc;
3655 #endif /* SQLITE_OMIT_UTF16 */
3658 ** Register a collation sequence factory callback with the database handle
3659 ** db. Replace any previously installed collation sequence factory.
3661 int sqlite3_collation_needed(
3662 sqlite3 *db,
3663 void *pCollNeededArg,
3664 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
3666 #ifdef SQLITE_ENABLE_API_ARMOR
3667 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3668 #endif
3669 sqlite3_mutex_enter(db->mutex);
3670 db->xCollNeeded = xCollNeeded;
3671 db->xCollNeeded16 = 0;
3672 db->pCollNeededArg = pCollNeededArg;
3673 sqlite3_mutex_leave(db->mutex);
3674 return SQLITE_OK;
3677 #ifndef SQLITE_OMIT_UTF16
3679 ** Register a collation sequence factory callback with the database handle
3680 ** db. Replace any previously installed collation sequence factory.
3682 int sqlite3_collation_needed16(
3683 sqlite3 *db,
3684 void *pCollNeededArg,
3685 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
3687 #ifdef SQLITE_ENABLE_API_ARMOR
3688 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3689 #endif
3690 sqlite3_mutex_enter(db->mutex);
3691 db->xCollNeeded = 0;
3692 db->xCollNeeded16 = xCollNeeded16;
3693 db->pCollNeededArg = pCollNeededArg;
3694 sqlite3_mutex_leave(db->mutex);
3695 return SQLITE_OK;
3697 #endif /* SQLITE_OMIT_UTF16 */
3699 #ifndef SQLITE_OMIT_DEPRECATED
3701 ** This function is now an anachronism. It used to be used to recover from a
3702 ** malloc() failure, but SQLite now does this automatically.
3704 int sqlite3_global_recover(void){
3705 return SQLITE_OK;
3707 #endif
3710 ** Test to see whether or not the database connection is in autocommit
3711 ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3712 ** by default. Autocommit is disabled by a BEGIN statement and reenabled
3713 ** by the next COMMIT or ROLLBACK.
3715 int sqlite3_get_autocommit(sqlite3 *db){
3716 #ifdef SQLITE_ENABLE_API_ARMOR
3717 if( !sqlite3SafetyCheckOk(db) ){
3718 (void)SQLITE_MISUSE_BKPT;
3719 return 0;
3721 #endif
3722 return db->autoCommit;
3726 ** The following routines are substitutes for constants SQLITE_CORRUPT,
3727 ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
3728 ** constants. They serve two purposes:
3730 ** 1. Serve as a convenient place to set a breakpoint in a debugger
3731 ** to detect when version error conditions occurs.
3733 ** 2. Invoke sqlite3_log() to provide the source code location where
3734 ** a low-level error is first detected.
3736 int sqlite3ReportError(int iErr, int lineno, const char *zType){
3737 sqlite3_log(iErr, "%s at line %d of [%.10s]",
3738 zType, lineno, 20+sqlite3_sourceid());
3739 return iErr;
3741 int sqlite3CorruptError(int lineno){
3742 testcase( sqlite3GlobalConfig.xLog!=0 );
3743 return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
3745 int sqlite3MisuseError(int lineno){
3746 testcase( sqlite3GlobalConfig.xLog!=0 );
3747 return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
3749 int sqlite3CantopenError(int lineno){
3750 testcase( sqlite3GlobalConfig.xLog!=0 );
3751 return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
3753 #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO)
3754 int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
3755 char zMsg[100];
3756 sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
3757 testcase( sqlite3GlobalConfig.xLog!=0 );
3758 return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
3760 #endif
3761 #ifdef SQLITE_DEBUG
3762 int sqlite3NomemError(int lineno){
3763 testcase( sqlite3GlobalConfig.xLog!=0 );
3764 return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
3766 int sqlite3IoerrnomemError(int lineno){
3767 testcase( sqlite3GlobalConfig.xLog!=0 );
3768 return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
3770 #endif
3772 #ifndef SQLITE_OMIT_DEPRECATED
3774 ** This is a convenience routine that makes sure that all thread-specific
3775 ** data for this thread has been deallocated.
3777 ** SQLite no longer uses thread-specific data so this routine is now a
3778 ** no-op. It is retained for historical compatibility.
3780 void sqlite3_thread_cleanup(void){
3782 #endif
3785 ** Return meta information about a specific column of a database table.
3786 ** See comment in sqlite3.h (sqlite.h.in) for details.
3788 int sqlite3_table_column_metadata(
3789 sqlite3 *db, /* Connection handle */
3790 const char *zDbName, /* Database name or NULL */
3791 const char *zTableName, /* Table name */
3792 const char *zColumnName, /* Column name */
3793 char const **pzDataType, /* OUTPUT: Declared data type */
3794 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
3795 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
3796 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
3797 int *pAutoinc /* OUTPUT: True if column is auto-increment */
3799 int rc;
3800 char *zErrMsg = 0;
3801 Table *pTab = 0;
3802 Column *pCol = 0;
3803 int iCol = 0;
3804 char const *zDataType = 0;
3805 char const *zCollSeq = 0;
3806 int notnull = 0;
3807 int primarykey = 0;
3808 int autoinc = 0;
3811 #ifdef SQLITE_ENABLE_API_ARMOR
3812 if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
3813 return SQLITE_MISUSE_BKPT;
3815 #endif
3817 /* Ensure the database schema has been loaded */
3818 sqlite3_mutex_enter(db->mutex);
3819 sqlite3BtreeEnterAll(db);
3820 rc = sqlite3Init(db, &zErrMsg);
3821 if( SQLITE_OK!=rc ){
3822 goto error_out;
3825 /* Locate the table in question */
3826 pTab = sqlite3FindTable(db, zTableName, zDbName);
3827 if( !pTab || IsView(pTab) ){
3828 pTab = 0;
3829 goto error_out;
3832 /* Find the column for which info is requested */
3833 if( zColumnName==0 ){
3834 /* Query for existance of table only */
3835 }else{
3836 for(iCol=0; iCol<pTab->nCol; iCol++){
3837 pCol = &pTab->aCol[iCol];
3838 if( 0==sqlite3StrICmp(pCol->zCnName, zColumnName) ){
3839 break;
3842 if( iCol==pTab->nCol ){
3843 if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
3844 iCol = pTab->iPKey;
3845 pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
3846 }else{
3847 pTab = 0;
3848 goto error_out;
3853 /* The following block stores the meta information that will be returned
3854 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3855 ** and autoinc. At this point there are two possibilities:
3857 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3858 ** and there is no explicitly declared IPK column.
3860 ** 2. The table is not a view and the column name identified an
3861 ** explicitly declared column. Copy meta information from *pCol.
3863 if( pCol ){
3864 zDataType = sqlite3ColumnType(pCol,0);
3865 zCollSeq = sqlite3ColumnColl(pCol);
3866 notnull = pCol->notNull!=0;
3867 primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
3868 autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
3869 }else{
3870 zDataType = "INTEGER";
3871 primarykey = 1;
3873 if( !zCollSeq ){
3874 zCollSeq = sqlite3StrBINARY;
3877 error_out:
3878 sqlite3BtreeLeaveAll(db);
3880 /* Whether the function call succeeded or failed, set the output parameters
3881 ** to whatever their local counterparts contain. If an error did occur,
3882 ** this has the effect of zeroing all output parameters.
3884 if( pzDataType ) *pzDataType = zDataType;
3885 if( pzCollSeq ) *pzCollSeq = zCollSeq;
3886 if( pNotNull ) *pNotNull = notnull;
3887 if( pPrimaryKey ) *pPrimaryKey = primarykey;
3888 if( pAutoinc ) *pAutoinc = autoinc;
3890 if( SQLITE_OK==rc && !pTab ){
3891 sqlite3DbFree(db, zErrMsg);
3892 zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
3893 zColumnName);
3894 rc = SQLITE_ERROR;
3896 sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
3897 sqlite3DbFree(db, zErrMsg);
3898 rc = sqlite3ApiExit(db, rc);
3899 sqlite3_mutex_leave(db->mutex);
3900 return rc;
3904 ** Sleep for a little while. Return the amount of time slept.
3906 int sqlite3_sleep(int ms){
3907 sqlite3_vfs *pVfs;
3908 int rc;
3909 pVfs = sqlite3_vfs_find(0);
3910 if( pVfs==0 ) return 0;
3912 /* This function works in milliseconds, but the underlying OsSleep()
3913 ** API uses microseconds. Hence the 1000's.
3915 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
3916 return rc;
3920 ** Enable or disable the extended result codes.
3922 int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
3923 #ifdef SQLITE_ENABLE_API_ARMOR
3924 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3925 #endif
3926 sqlite3_mutex_enter(db->mutex);
3927 db->errMask = onoff ? 0xffffffff : 0xff;
3928 sqlite3_mutex_leave(db->mutex);
3929 return SQLITE_OK;
3933 ** Invoke the xFileControl method on a particular database.
3935 int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
3936 int rc = SQLITE_ERROR;
3937 Btree *pBtree;
3939 #ifdef SQLITE_ENABLE_API_ARMOR
3940 if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
3941 #endif
3942 sqlite3_mutex_enter(db->mutex);
3943 pBtree = sqlite3DbNameToBtree(db, zDbName);
3944 if( pBtree ){
3945 Pager *pPager;
3946 sqlite3_file *fd;
3947 sqlite3BtreeEnter(pBtree);
3948 pPager = sqlite3BtreePager(pBtree);
3949 assert( pPager!=0 );
3950 fd = sqlite3PagerFile(pPager);
3951 assert( fd!=0 );
3952 if( op==SQLITE_FCNTL_FILE_POINTER ){
3953 *(sqlite3_file**)pArg = fd;
3954 rc = SQLITE_OK;
3955 }else if( op==SQLITE_FCNTL_VFS_POINTER ){
3956 *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
3957 rc = SQLITE_OK;
3958 }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
3959 *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
3960 rc = SQLITE_OK;
3961 }else if( op==SQLITE_FCNTL_DATA_VERSION ){
3962 *(unsigned int*)pArg = sqlite3PagerDataVersion(pPager);
3963 rc = SQLITE_OK;
3964 }else if( op==SQLITE_FCNTL_RESERVE_BYTES ){
3965 int iNew = *(int*)pArg;
3966 *(int*)pArg = sqlite3BtreeGetRequestedReserve(pBtree);
3967 if( iNew>=0 && iNew<=255 ){
3968 sqlite3BtreeSetPageSize(pBtree, 0, iNew, 0);
3970 rc = SQLITE_OK;
3971 }else if( op==SQLITE_FCNTL_RESET_CACHE ){
3972 sqlite3BtreeClearCache(pBtree);
3973 rc = SQLITE_OK;
3974 }else{
3975 int nSave = db->busyHandler.nBusy;
3976 rc = sqlite3OsFileControl(fd, op, pArg);
3977 db->busyHandler.nBusy = nSave;
3979 sqlite3BtreeLeave(pBtree);
3981 sqlite3_mutex_leave(db->mutex);
3982 return rc;
3986 ** Interface to the testing logic.
3988 int sqlite3_test_control(int op, ...){
3989 int rc = 0;
3990 #ifdef SQLITE_UNTESTABLE
3991 UNUSED_PARAMETER(op);
3992 #else
3993 va_list ap;
3994 va_start(ap, op);
3995 switch( op ){
3998 ** Save the current state of the PRNG.
4000 case SQLITE_TESTCTRL_PRNG_SAVE: {
4001 sqlite3PrngSaveState();
4002 break;
4006 ** Restore the state of the PRNG to the last state saved using
4007 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
4008 ** this verb acts like PRNG_RESET.
4010 case SQLITE_TESTCTRL_PRNG_RESTORE: {
4011 sqlite3PrngRestoreState();
4012 break;
4015 /* sqlite3_test_control(SQLITE_TESTCTRL_PRNG_SEED, int x, sqlite3 *db);
4017 ** Control the seed for the pseudo-random number generator (PRNG) that
4018 ** is built into SQLite. Cases:
4020 ** x!=0 && db!=0 Seed the PRNG to the current value of the
4021 ** schema cookie in the main database for db, or
4022 ** x if the schema cookie is zero. This case
4023 ** is convenient to use with database fuzzers
4024 ** as it allows the fuzzer some control over the
4025 ** the PRNG seed.
4027 ** x!=0 && db==0 Seed the PRNG to the value of x.
4029 ** x==0 && db==0 Revert to default behavior of using the
4030 ** xRandomness method on the primary VFS.
4032 ** This test-control also resets the PRNG so that the new seed will
4033 ** be used for the next call to sqlite3_randomness().
4035 #ifndef SQLITE_OMIT_WSD
4036 case SQLITE_TESTCTRL_PRNG_SEED: {
4037 int x = va_arg(ap, int);
4038 int y;
4039 sqlite3 *db = va_arg(ap, sqlite3*);
4040 assert( db==0 || db->aDb[0].pSchema!=0 );
4041 if( db && (y = db->aDb[0].pSchema->schema_cookie)!=0 ){ x = y; }
4042 sqlite3Config.iPrngSeed = x;
4043 sqlite3_randomness(0,0);
4044 break;
4046 #endif
4049 ** sqlite3_test_control(BITVEC_TEST, size, program)
4051 ** Run a test against a Bitvec object of size. The program argument
4052 ** is an array of integers that defines the test. Return -1 on a
4053 ** memory allocation error, 0 on success, or non-zero for an error.
4054 ** See the sqlite3BitvecBuiltinTest() for additional information.
4056 case SQLITE_TESTCTRL_BITVEC_TEST: {
4057 int sz = va_arg(ap, int);
4058 int *aProg = va_arg(ap, int*);
4059 rc = sqlite3BitvecBuiltinTest(sz, aProg);
4060 break;
4064 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
4066 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
4067 ** if xCallback is not NULL.
4069 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
4070 ** is called immediately after installing the new callback and the return
4071 ** value from sqlite3FaultSim(0) becomes the return from
4072 ** sqlite3_test_control().
4074 case SQLITE_TESTCTRL_FAULT_INSTALL: {
4075 /* A bug in MSVC prevents it from understanding pointers to functions
4076 ** types in the second argument to va_arg(). Work around the problem
4077 ** using a typedef.
4078 ** http://support.microsoft.com/kb/47961 <-- dead hyperlink
4079 ** Search at http://web.archive.org/ to find the 2015-03-16 archive
4080 ** of the link above to see the original text.
4081 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
4083 typedef int(*sqlite3FaultFuncType)(int);
4084 sqlite3GlobalConfig.xTestCallback = va_arg(ap, sqlite3FaultFuncType);
4085 rc = sqlite3FaultSim(0);
4086 break;
4090 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
4092 ** Register hooks to call to indicate which malloc() failures
4093 ** are benign.
4095 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
4096 typedef void (*void_function)(void);
4097 void_function xBenignBegin;
4098 void_function xBenignEnd;
4099 xBenignBegin = va_arg(ap, void_function);
4100 xBenignEnd = va_arg(ap, void_function);
4101 sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
4102 break;
4106 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
4108 ** Set the PENDING byte to the value in the argument, if X>0.
4109 ** Make no changes if X==0. Return the value of the pending byte
4110 ** as it existing before this routine was called.
4112 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
4113 ** an incompatible database file format. Changing the PENDING byte
4114 ** while any database connection is open results in undefined and
4115 ** deleterious behavior.
4117 case SQLITE_TESTCTRL_PENDING_BYTE: {
4118 rc = PENDING_BYTE;
4119 #ifndef SQLITE_OMIT_WSD
4121 unsigned int newVal = va_arg(ap, unsigned int);
4122 if( newVal ) sqlite3PendingByte = newVal;
4124 #endif
4125 break;
4129 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
4131 ** This action provides a run-time test to see whether or not
4132 ** assert() was enabled at compile-time. If X is true and assert()
4133 ** is enabled, then the return value is true. If X is true and
4134 ** assert() is disabled, then the return value is zero. If X is
4135 ** false and assert() is enabled, then the assertion fires and the
4136 ** process aborts. If X is false and assert() is disabled, then the
4137 ** return value is zero.
4139 case SQLITE_TESTCTRL_ASSERT: {
4140 volatile int x = 0;
4141 assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
4142 rc = x;
4143 #if defined(SQLITE_DEBUG)
4144 /* Invoke these debugging routines so that the compiler does not
4145 ** issue "defined but not used" warnings. */
4146 if( x==9999 ){
4147 sqlite3ShowExpr(0);
4148 sqlite3ShowExpr(0);
4149 sqlite3ShowExprList(0);
4150 sqlite3ShowIdList(0);
4151 sqlite3ShowSrcList(0);
4152 sqlite3ShowWith(0);
4153 sqlite3ShowUpsert(0);
4154 sqlite3ShowTriggerStep(0);
4155 sqlite3ShowTriggerStepList(0);
4156 sqlite3ShowTrigger(0);
4157 sqlite3ShowTriggerList(0);
4158 #ifndef SQLITE_OMIT_WINDOWFUNC
4159 sqlite3ShowWindow(0);
4160 sqlite3ShowWinFunc(0);
4161 #endif
4162 sqlite3ShowSelect(0);
4164 #endif
4165 break;
4170 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
4172 ** This action provides a run-time test to see how the ALWAYS and
4173 ** NEVER macros were defined at compile-time.
4175 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
4177 ** The recommended test is X==2. If the return value is 2, that means
4178 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
4179 ** default setting. If the return value is 1, then ALWAYS() is either
4180 ** hard-coded to true or else it asserts if its argument is false.
4181 ** The first behavior (hard-coded to true) is the case if
4182 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
4183 ** behavior (assert if the argument to ALWAYS() is false) is the case if
4184 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
4186 ** The run-time test procedure might look something like this:
4188 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
4189 ** // ALWAYS() and NEVER() are no-op pass-through macros
4190 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
4191 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
4192 ** }else{
4193 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
4194 ** }
4196 case SQLITE_TESTCTRL_ALWAYS: {
4197 int x = va_arg(ap,int);
4198 rc = x ? ALWAYS(x) : 0;
4199 break;
4203 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
4205 ** The integer returned reveals the byte-order of the computer on which
4206 ** SQLite is running:
4208 ** 1 big-endian, determined at run-time
4209 ** 10 little-endian, determined at run-time
4210 ** 432101 big-endian, determined at compile-time
4211 ** 123410 little-endian, determined at compile-time
4213 case SQLITE_TESTCTRL_BYTEORDER: {
4214 rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
4215 break;
4218 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
4220 ** Enable or disable various optimizations for testing purposes. The
4221 ** argument N is a bitmask of optimizations to be disabled. For normal
4222 ** operation N should be 0. The idea is that a test program (like the
4223 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
4224 ** with various optimizations disabled to verify that the same answer
4225 ** is obtained in every case.
4227 case SQLITE_TESTCTRL_OPTIMIZATIONS: {
4228 sqlite3 *db = va_arg(ap, sqlite3*);
4229 db->dbOptFlags = va_arg(ap, u32);
4230 break;
4233 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, onoff, xAlt);
4235 ** If parameter onoff is 1, subsequent calls to localtime() fail.
4236 ** If 2, then invoke xAlt() instead of localtime(). If 0, normal
4237 ** processing.
4239 ** xAlt arguments are void pointers, but they really want to be:
4241 ** int xAlt(const time_t*, struct tm*);
4243 ** xAlt should write results in to struct tm object of its 2nd argument
4244 ** and return zero on success, or return non-zero on failure.
4246 case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
4247 sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
4248 if( sqlite3GlobalConfig.bLocaltimeFault==2 ){
4249 typedef int(*sqlite3LocaltimeType)(const void*,void*);
4250 sqlite3GlobalConfig.xAltLocaltime = va_arg(ap, sqlite3LocaltimeType);
4251 }else{
4252 sqlite3GlobalConfig.xAltLocaltime = 0;
4254 break;
4257 /* sqlite3_test_control(SQLITE_TESTCTRL_INTERNAL_FUNCTIONS, sqlite3*);
4259 ** Toggle the ability to use internal functions on or off for
4260 ** the database connection given in the argument.
4262 case SQLITE_TESTCTRL_INTERNAL_FUNCTIONS: {
4263 sqlite3 *db = va_arg(ap, sqlite3*);
4264 db->mDbFlags ^= DBFLAG_InternalFunc;
4265 break;
4268 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
4270 ** Set or clear a flag that indicates that the database file is always well-
4271 ** formed and never corrupt. This flag is clear by default, indicating that
4272 ** database files might have arbitrary corruption. Setting the flag during
4273 ** testing causes certain assert() statements in the code to be activated
4274 ** that demonstrat invariants on well-formed database files.
4276 case SQLITE_TESTCTRL_NEVER_CORRUPT: {
4277 sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
4278 break;
4281 /* sqlite3_test_control(SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS, int);
4283 ** Set or clear a flag that causes SQLite to verify that type, name,
4284 ** and tbl_name fields of the sqlite_schema table. This is normally
4285 ** on, but it is sometimes useful to turn it off for testing.
4287 ** 2020-07-22: Disabling EXTRA_SCHEMA_CHECKS also disables the
4288 ** verification of rootpage numbers when parsing the schema. This
4289 ** is useful to make it easier to reach strange internal error states
4290 ** during testing. The EXTRA_SCHEMA_CHECKS setting is always enabled
4291 ** in production.
4293 case SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS: {
4294 sqlite3GlobalConfig.bExtraSchemaChecks = va_arg(ap, int);
4295 break;
4298 /* Set the threshold at which OP_Once counters reset back to zero.
4299 ** By default this is 0x7ffffffe (over 2 billion), but that value is
4300 ** too big to test in a reasonable amount of time, so this control is
4301 ** provided to set a small and easily reachable reset value.
4303 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
4304 sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
4305 break;
4308 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
4310 ** Set the VDBE coverage callback function to xCallback with context
4311 ** pointer ptr.
4313 case SQLITE_TESTCTRL_VDBE_COVERAGE: {
4314 #ifdef SQLITE_VDBE_COVERAGE
4315 typedef void (*branch_callback)(void*,unsigned int,
4316 unsigned char,unsigned char);
4317 sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
4318 sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
4319 #endif
4320 break;
4323 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
4324 case SQLITE_TESTCTRL_SORTER_MMAP: {
4325 sqlite3 *db = va_arg(ap, sqlite3*);
4326 db->nMaxSorterMmap = va_arg(ap, int);
4327 break;
4330 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
4332 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
4333 ** not.
4335 case SQLITE_TESTCTRL_ISINIT: {
4336 if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
4337 break;
4340 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
4342 ** This test control is used to create imposter tables. "db" is a pointer
4343 ** to the database connection. dbName is the database name (ex: "main" or
4344 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4345 ** or off. "tnum" is the root page of the b-tree to which the imposter
4346 ** table should connect.
4348 ** Enable imposter mode only when the schema has already been parsed. Then
4349 ** run a single CREATE TABLE statement to construct the imposter table in
4350 ** the parsed schema. Then turn imposter mode back off again.
4352 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4353 ** the schema to be reparsed the next time it is needed. This has the
4354 ** effect of erasing all imposter tables.
4356 case SQLITE_TESTCTRL_IMPOSTER: {
4357 sqlite3 *db = va_arg(ap, sqlite3*);
4358 int iDb;
4359 sqlite3_mutex_enter(db->mutex);
4360 iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
4361 if( iDb>=0 ){
4362 db->init.iDb = iDb;
4363 db->init.busy = db->init.imposterTable = va_arg(ap,int);
4364 db->init.newTnum = va_arg(ap,int);
4365 if( db->init.busy==0 && db->init.newTnum>0 ){
4366 sqlite3ResetAllSchemasOfConnection(db);
4369 sqlite3_mutex_leave(db->mutex);
4370 break;
4373 #if defined(YYCOVERAGE)
4374 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4376 ** This test control (only available when SQLite is compiled with
4377 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4378 ** state/lookahead combinations in the parser state machine
4379 ** which are never exercised. If any state is missed, make the
4380 ** return code SQLITE_ERROR.
4382 case SQLITE_TESTCTRL_PARSER_COVERAGE: {
4383 FILE *out = va_arg(ap, FILE*);
4384 if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
4385 break;
4387 #endif /* defined(YYCOVERAGE) */
4389 /* sqlite3_test_control(SQLITE_TESTCTRL_RESULT_INTREAL, sqlite3_context*);
4391 ** This test-control causes the most recent sqlite3_result_int64() value
4392 ** to be interpreted as a MEM_IntReal instead of as an MEM_Int. Normally,
4393 ** MEM_IntReal values only arise during an INSERT operation of integer
4394 ** values into a REAL column, so they can be challenging to test. This
4395 ** test-control enables us to write an intreal() SQL function that can
4396 ** inject an intreal() value at arbitrary places in an SQL statement,
4397 ** for testing purposes.
4399 case SQLITE_TESTCTRL_RESULT_INTREAL: {
4400 sqlite3_context *pCtx = va_arg(ap, sqlite3_context*);
4401 sqlite3ResultIntReal(pCtx);
4402 break;
4405 /* sqlite3_test_control(SQLITE_TESTCTRL_SEEK_COUNT,
4406 ** sqlite3 *db, // Database connection
4407 ** u64 *pnSeek // Write seek count here
4408 ** );
4410 ** This test-control queries the seek-counter on the "main" database
4411 ** file. The seek-counter is written into *pnSeek and is then reset.
4412 ** The seek-count is only available if compiled with SQLITE_DEBUG.
4414 case SQLITE_TESTCTRL_SEEK_COUNT: {
4415 sqlite3 *db = va_arg(ap, sqlite3*);
4416 u64 *pn = va_arg(ap, sqlite3_uint64*);
4417 *pn = sqlite3BtreeSeekCount(db->aDb->pBt);
4418 (void)db; /* Silence harmless unused variable warning */
4419 break;
4422 /* sqlite3_test_control(SQLITE_TESTCTRL_TRACEFLAGS, op, ptr)
4424 ** "ptr" is a pointer to a u32.
4426 ** op==0 Store the current sqlite3TreeTrace in *ptr
4427 ** op==1 Set sqlite3TreeTrace to the value *ptr
4428 ** op==3 Store the current sqlite3WhereTrace in *ptr
4429 ** op==3 Set sqlite3WhereTrace to the value *ptr
4431 case SQLITE_TESTCTRL_TRACEFLAGS: {
4432 int opTrace = va_arg(ap, int);
4433 u32 *ptr = va_arg(ap, u32*);
4434 switch( opTrace ){
4435 case 0: *ptr = sqlite3TreeTrace; break;
4436 case 1: sqlite3TreeTrace = *ptr; break;
4437 case 2: *ptr = sqlite3WhereTrace; break;
4438 case 3: sqlite3WhereTrace = *ptr; break;
4440 break;
4443 /* sqlite3_test_control(SQLITE_TESTCTRL_LOGEST,
4444 ** double fIn, // Input value
4445 ** int *pLogEst, // sqlite3LogEstFromDouble(fIn)
4446 ** u64 *pInt, // sqlite3LogEstToInt(*pLogEst)
4447 ** int *pLogEst2 // sqlite3LogEst(*pInt)
4448 ** );
4450 ** Test access for the LogEst conversion routines.
4452 case SQLITE_TESTCTRL_LOGEST: {
4453 double rIn = va_arg(ap, double);
4454 LogEst rLogEst = sqlite3LogEstFromDouble(rIn);
4455 int *pI1 = va_arg(ap,int*);
4456 u64 *pU64 = va_arg(ap,u64*);
4457 int *pI2 = va_arg(ap,int*);
4458 *pI1 = rLogEst;
4459 *pU64 = sqlite3LogEstToInt(rLogEst);
4460 *pI2 = sqlite3LogEst(*pU64);
4461 break;
4465 #if defined(SQLITE_DEBUG) && !defined(SQLITE_OMIT_WSD)
4466 /* sqlite3_test_control(SQLITE_TESTCTRL_TUNE, id, *piValue)
4468 ** If "id" is an integer between 1 and SQLITE_NTUNE then set the value
4469 ** of the id-th tuning parameter to *piValue. If "id" is between -1
4470 ** and -SQLITE_NTUNE, then write the current value of the (-id)-th
4471 ** tuning parameter into *piValue.
4473 ** Tuning parameters are for use during transient development builds,
4474 ** to help find the best values for constants in the query planner.
4475 ** Access tuning parameters using the Tuning(ID) macro. Set the
4476 ** parameters in the CLI using ".testctrl tune ID VALUE".
4478 ** Transient use only. Tuning parameters should not be used in
4479 ** checked-in code.
4481 case SQLITE_TESTCTRL_TUNE: {
4482 int id = va_arg(ap, int);
4483 int *piValue = va_arg(ap, int*);
4484 if( id>0 && id<=SQLITE_NTUNE ){
4485 Tuning(id) = *piValue;
4486 }else if( id<0 && id>=-SQLITE_NTUNE ){
4487 *piValue = Tuning(-id);
4488 }else{
4489 rc = SQLITE_NOTFOUND;
4491 break;
4493 #endif
4495 va_end(ap);
4496 #endif /* SQLITE_UNTESTABLE */
4497 return rc;
4501 ** The Pager stores the Database filename, Journal filename, and WAL filename
4502 ** consecutively in memory, in that order. The database filename is prefixed
4503 ** by four zero bytes. Locate the start of the database filename by searching
4504 ** backwards for the first byte following four consecutive zero bytes.
4506 ** This only works if the filename passed in was obtained from the Pager.
4508 static const char *databaseName(const char *zName){
4509 while( zName[-1]!=0 || zName[-2]!=0 || zName[-3]!=0 || zName[-4]!=0 ){
4510 zName--;
4512 return zName;
4516 ** Append text z[] to the end of p[]. Return a pointer to the first
4517 ** character after then zero terminator on the new text in p[].
4519 static char *appendText(char *p, const char *z){
4520 size_t n = strlen(z);
4521 memcpy(p, z, n+1);
4522 return p+n+1;
4526 ** Allocate memory to hold names for a database, journal file, WAL file,
4527 ** and query parameters. The pointer returned is valid for use by
4528 ** sqlite3_filename_database() and sqlite3_uri_parameter() and related
4529 ** functions.
4531 ** Memory layout must be compatible with that generated by the pager
4532 ** and expected by sqlite3_uri_parameter() and databaseName().
4534 const char *sqlite3_create_filename(
4535 const char *zDatabase,
4536 const char *zJournal,
4537 const char *zWal,
4538 int nParam,
4539 const char **azParam
4541 sqlite3_int64 nByte;
4542 int i;
4543 char *pResult, *p;
4544 nByte = strlen(zDatabase) + strlen(zJournal) + strlen(zWal) + 10;
4545 for(i=0; i<nParam*2; i++){
4546 nByte += strlen(azParam[i])+1;
4548 pResult = p = sqlite3_malloc64( nByte );
4549 if( p==0 ) return 0;
4550 memset(p, 0, 4);
4551 p += 4;
4552 p = appendText(p, zDatabase);
4553 for(i=0; i<nParam*2; i++){
4554 p = appendText(p, azParam[i]);
4556 *(p++) = 0;
4557 p = appendText(p, zJournal);
4558 p = appendText(p, zWal);
4559 *(p++) = 0;
4560 *(p++) = 0;
4561 assert( (sqlite3_int64)(p - pResult)==nByte );
4562 return pResult + 4;
4566 ** Free memory obtained from sqlite3_create_filename(). It is a severe
4567 ** error to call this routine with any parameter other than a pointer
4568 ** previously obtained from sqlite3_create_filename() or a NULL pointer.
4570 void sqlite3_free_filename(const char *p){
4571 if( p==0 ) return;
4572 p = databaseName(p);
4573 sqlite3_free((char*)p - 4);
4578 ** This is a utility routine, useful to VFS implementations, that checks
4579 ** to see if a database file was a URI that contained a specific query
4580 ** parameter, and if so obtains the value of the query parameter.
4582 ** The zFilename argument is the filename pointer passed into the xOpen()
4583 ** method of a VFS implementation. The zParam argument is the name of the
4584 ** query parameter we seek. This routine returns the value of the zParam
4585 ** parameter if it exists. If the parameter does not exist, this routine
4586 ** returns a NULL pointer.
4588 const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
4589 if( zFilename==0 || zParam==0 ) return 0;
4590 zFilename = databaseName(zFilename);
4591 return uriParameter(zFilename, zParam);
4595 ** Return a pointer to the name of Nth query parameter of the filename.
4597 const char *sqlite3_uri_key(const char *zFilename, int N){
4598 if( zFilename==0 || N<0 ) return 0;
4599 zFilename = databaseName(zFilename);
4600 zFilename += sqlite3Strlen30(zFilename) + 1;
4601 while( ALWAYS(zFilename) && zFilename[0] && (N--)>0 ){
4602 zFilename += sqlite3Strlen30(zFilename) + 1;
4603 zFilename += sqlite3Strlen30(zFilename) + 1;
4605 return zFilename[0] ? zFilename : 0;
4609 ** Return a boolean value for a query parameter.
4611 int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
4612 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4613 bDflt = bDflt!=0;
4614 return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
4618 ** Return a 64-bit integer value for a query parameter.
4620 sqlite3_int64 sqlite3_uri_int64(
4621 const char *zFilename, /* Filename as passed to xOpen */
4622 const char *zParam, /* URI parameter sought */
4623 sqlite3_int64 bDflt /* return if parameter is missing */
4625 const char *z = sqlite3_uri_parameter(zFilename, zParam);
4626 sqlite3_int64 v;
4627 if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
4628 bDflt = v;
4630 return bDflt;
4634 ** Translate a filename that was handed to a VFS routine into the corresponding
4635 ** database, journal, or WAL file.
4637 ** It is an error to pass this routine a filename string that was not
4638 ** passed into the VFS from the SQLite core. Doing so is similar to
4639 ** passing free() a pointer that was not obtained from malloc() - it is
4640 ** an error that we cannot easily detect but that will likely cause memory
4641 ** corruption.
4643 const char *sqlite3_filename_database(const char *zFilename){
4644 if( zFilename==0 ) return 0;
4645 return databaseName(zFilename);
4647 const char *sqlite3_filename_journal(const char *zFilename){
4648 if( zFilename==0 ) return 0;
4649 zFilename = databaseName(zFilename);
4650 zFilename += sqlite3Strlen30(zFilename) + 1;
4651 while( ALWAYS(zFilename) && zFilename[0] ){
4652 zFilename += sqlite3Strlen30(zFilename) + 1;
4653 zFilename += sqlite3Strlen30(zFilename) + 1;
4655 return zFilename + 1;
4657 const char *sqlite3_filename_wal(const char *zFilename){
4658 #ifdef SQLITE_OMIT_WAL
4659 return 0;
4660 #else
4661 zFilename = sqlite3_filename_journal(zFilename);
4662 if( zFilename ) zFilename += sqlite3Strlen30(zFilename) + 1;
4663 return zFilename;
4664 #endif
4668 ** Return the Btree pointer identified by zDbName. Return NULL if not found.
4670 Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
4671 int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
4672 return iDb<0 ? 0 : db->aDb[iDb].pBt;
4676 ** Return the name of the N-th database schema. Return NULL if N is out
4677 ** of range.
4679 const char *sqlite3_db_name(sqlite3 *db, int N){
4680 #ifdef SQLITE_ENABLE_API_ARMOR
4681 if( !sqlite3SafetyCheckOk(db) ){
4682 (void)SQLITE_MISUSE_BKPT;
4683 return 0;
4685 #endif
4686 if( N<0 || N>=db->nDb ){
4687 return 0;
4688 }else{
4689 return db->aDb[N].zDbSName;
4694 ** Return the filename of the database associated with a database
4695 ** connection.
4697 const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
4698 Btree *pBt;
4699 #ifdef SQLITE_ENABLE_API_ARMOR
4700 if( !sqlite3SafetyCheckOk(db) ){
4701 (void)SQLITE_MISUSE_BKPT;
4702 return 0;
4704 #endif
4705 pBt = sqlite3DbNameToBtree(db, zDbName);
4706 return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
4710 ** Return 1 if database is read-only or 0 if read/write. Return -1 if
4711 ** no such database exists.
4713 int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
4714 Btree *pBt;
4715 #ifdef SQLITE_ENABLE_API_ARMOR
4716 if( !sqlite3SafetyCheckOk(db) ){
4717 (void)SQLITE_MISUSE_BKPT;
4718 return -1;
4720 #endif
4721 pBt = sqlite3DbNameToBtree(db, zDbName);
4722 return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
4725 #ifdef SQLITE_ENABLE_SNAPSHOT
4727 ** Obtain a snapshot handle for the snapshot of database zDb currently
4728 ** being read by handle db.
4730 int sqlite3_snapshot_get(
4731 sqlite3 *db,
4732 const char *zDb,
4733 sqlite3_snapshot **ppSnapshot
4735 int rc = SQLITE_ERROR;
4736 #ifndef SQLITE_OMIT_WAL
4738 #ifdef SQLITE_ENABLE_API_ARMOR
4739 if( !sqlite3SafetyCheckOk(db) ){
4740 return SQLITE_MISUSE_BKPT;
4742 #endif
4743 sqlite3_mutex_enter(db->mutex);
4745 if( db->autoCommit==0 ){
4746 int iDb = sqlite3FindDbName(db, zDb);
4747 if( iDb==0 || iDb>1 ){
4748 Btree *pBt = db->aDb[iDb].pBt;
4749 if( SQLITE_TXN_WRITE!=sqlite3BtreeTxnState(pBt) ){
4750 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4751 if( rc==SQLITE_OK ){
4752 rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
4758 sqlite3_mutex_leave(db->mutex);
4759 #endif /* SQLITE_OMIT_WAL */
4760 return rc;
4764 ** Open a read-transaction on the snapshot idendified by pSnapshot.
4766 int sqlite3_snapshot_open(
4767 sqlite3 *db,
4768 const char *zDb,
4769 sqlite3_snapshot *pSnapshot
4771 int rc = SQLITE_ERROR;
4772 #ifndef SQLITE_OMIT_WAL
4774 #ifdef SQLITE_ENABLE_API_ARMOR
4775 if( !sqlite3SafetyCheckOk(db) ){
4776 return SQLITE_MISUSE_BKPT;
4778 #endif
4779 sqlite3_mutex_enter(db->mutex);
4780 if( db->autoCommit==0 ){
4781 int iDb;
4782 iDb = sqlite3FindDbName(db, zDb);
4783 if( iDb==0 || iDb>1 ){
4784 Btree *pBt = db->aDb[iDb].pBt;
4785 if( sqlite3BtreeTxnState(pBt)!=SQLITE_TXN_WRITE ){
4786 Pager *pPager = sqlite3BtreePager(pBt);
4787 int bUnlock = 0;
4788 if( sqlite3BtreeTxnState(pBt)!=SQLITE_TXN_NONE ){
4789 if( db->nVdbeActive==0 ){
4790 rc = sqlite3PagerSnapshotCheck(pPager, pSnapshot);
4791 if( rc==SQLITE_OK ){
4792 bUnlock = 1;
4793 rc = sqlite3BtreeCommit(pBt);
4796 }else{
4797 rc = SQLITE_OK;
4799 if( rc==SQLITE_OK ){
4800 rc = sqlite3PagerSnapshotOpen(pPager, pSnapshot);
4802 if( rc==SQLITE_OK ){
4803 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4804 sqlite3PagerSnapshotOpen(pPager, 0);
4806 if( bUnlock ){
4807 sqlite3PagerSnapshotUnlock(pPager);
4813 sqlite3_mutex_leave(db->mutex);
4814 #endif /* SQLITE_OMIT_WAL */
4815 return rc;
4819 ** Recover as many snapshots as possible from the wal file associated with
4820 ** schema zDb of database db.
4822 int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
4823 int rc = SQLITE_ERROR;
4824 #ifndef SQLITE_OMIT_WAL
4825 int iDb;
4827 #ifdef SQLITE_ENABLE_API_ARMOR
4828 if( !sqlite3SafetyCheckOk(db) ){
4829 return SQLITE_MISUSE_BKPT;
4831 #endif
4833 sqlite3_mutex_enter(db->mutex);
4834 iDb = sqlite3FindDbName(db, zDb);
4835 if( iDb==0 || iDb>1 ){
4836 Btree *pBt = db->aDb[iDb].pBt;
4837 if( SQLITE_TXN_NONE==sqlite3BtreeTxnState(pBt) ){
4838 rc = sqlite3BtreeBeginTrans(pBt, 0, 0);
4839 if( rc==SQLITE_OK ){
4840 rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
4841 sqlite3BtreeCommit(pBt);
4845 sqlite3_mutex_leave(db->mutex);
4846 #endif /* SQLITE_OMIT_WAL */
4847 return rc;
4851 ** Free a snapshot handle obtained from sqlite3_snapshot_get().
4853 void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
4854 sqlite3_free(pSnapshot);
4856 #endif /* SQLITE_ENABLE_SNAPSHOT */
4858 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4860 ** Given the name of a compile-time option, return true if that option
4861 ** was used and false if not.
4863 ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4864 ** is not required for a match.
4866 int sqlite3_compileoption_used(const char *zOptName){
4867 int i, n;
4868 int nOpt;
4869 const char **azCompileOpt;
4871 #if SQLITE_ENABLE_API_ARMOR
4872 if( zOptName==0 ){
4873 (void)SQLITE_MISUSE_BKPT;
4874 return 0;
4876 #endif
4878 azCompileOpt = sqlite3CompileOptions(&nOpt);
4880 if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
4881 n = sqlite3Strlen30(zOptName);
4883 /* Since nOpt is normally in single digits, a linear search is
4884 ** adequate. No need for a binary search. */
4885 for(i=0; i<nOpt; i++){
4886 if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
4887 && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
4889 return 1;
4892 return 0;
4896 ** Return the N-th compile-time option string. If N is out of range,
4897 ** return a NULL pointer.
4899 const char *sqlite3_compileoption_get(int N){
4900 int nOpt;
4901 const char **azCompileOpt;
4902 azCompileOpt = sqlite3CompileOptions(&nOpt);
4903 if( N>=0 && N<nOpt ){
4904 return azCompileOpt[N];
4906 return 0;
4908 #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */