4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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
22 #ifdef SQLITE_ENABLE_RTREE
25 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
26 # include "sqliteicu.h"
28 #ifdef SQLITE_ENABLE_JSON1
29 int sqlite3Json1Init(sqlite3
*);
31 #ifdef SQLITE_ENABLE_STMTVTAB
32 int sqlite3StmtVtabInit(sqlite3
*);
34 #ifdef SQLITE_ENABLE_FTS5
35 int sqlite3Fts5Init(sqlite3
*);
38 #ifndef SQLITE_AMALGAMATION
39 /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
40 ** contains the text of SQLITE_VERSION macro.
42 const char sqlite3_version
[] = SQLITE_VERSION
;
45 /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
46 ** a pointer to the to the sqlite3_version[] string constant.
48 const char *sqlite3_libversion(void){ return sqlite3_version
; }
50 /* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
51 ** pointer to a string constant whose value is the same as the
52 ** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
53 ** an edited copy of the amalgamation, then the last four characters of
54 ** the hash might be different from SQLITE_SOURCE_ID.
56 const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID
; }
58 /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
59 ** returns an integer equal to SQLITE_VERSION_NUMBER.
61 int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER
; }
63 /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
64 ** zero if and only if SQLite was compiled with mutexing code omitted due to
65 ** the SQLITE_THREADSAFE compile-time option being set to 0.
67 int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE
; }
70 ** When compiling the test fixture or with debugging enabled (on Win32),
71 ** this variable being set to non-zero will cause OSTRACE macros to emit
72 ** extra diagnostic information.
74 #ifdef SQLITE_HAVE_OS_TRACE
75 # ifndef SQLITE_DEBUG_OS_TRACE
76 # define SQLITE_DEBUG_OS_TRACE 0
78 int sqlite3OSTrace
= SQLITE_DEBUG_OS_TRACE
;
81 #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
83 ** If the following function pointer is not NULL and if
84 ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
85 ** I/O active are written using this function. These messages
86 ** are intended for debugging activity only.
88 SQLITE_API
void (SQLITE_CDECL
*sqlite3IoTrace
)(const char*, ...) = 0;
92 ** If the following global variable points to a string which is the
93 ** name of a directory, then that directory will be used to store
96 ** See also the "PRAGMA temp_store_directory" SQL command.
98 char *sqlite3_temp_directory
= 0;
101 ** If the following global variable points to a string which is the
102 ** name of a directory, then that directory will be used to store
103 ** all database files specified with a relative pathname.
105 ** See also the "PRAGMA data_store_directory" SQL command.
107 char *sqlite3_data_directory
= 0;
110 ** Initialize SQLite.
112 ** This routine must be called to initialize the memory allocation,
113 ** VFS, and mutex subsystems prior to doing any serious work with
114 ** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
115 ** this routine will be called automatically by key routines such as
118 ** This routine is a no-op except on its very first call for the process,
119 ** or for the first call after a call to sqlite3_shutdown.
121 ** The first thread to call this routine runs the initialization to
122 ** completion. If subsequent threads call this routine before the first
123 ** thread has finished the initialization process, then the subsequent
124 ** threads must block until the first thread finishes with the initialization.
126 ** The first thread might call this routine recursively. Recursive
127 ** calls to this routine should not block, of course. Otherwise the
128 ** initialization process would never complete.
130 ** Let X be the first thread to enter this routine. Let Y be some other
131 ** thread. Then while the initial invocation of this routine by X is
132 ** incomplete, it is required that:
134 ** * Calls to this routine from Y must block until the outer-most
135 ** call by X completes.
137 ** * Recursive calls to this routine from thread X return immediately
140 int sqlite3_initialize(void){
141 MUTEX_LOGIC( sqlite3_mutex
*pMaster
; ) /* The main static mutex */
142 int rc
; /* Result code */
143 #ifdef SQLITE_EXTRA_INIT
144 int bRunExtraInit
= 0; /* Extra initialization needed */
147 #ifdef SQLITE_OMIT_WSD
148 rc
= sqlite3_wsd_init(4096, 24);
154 /* If the following assert() fails on some obscure processor/compiler
155 ** combination, the work-around is to set the correct pointer
156 ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
157 assert( SQLITE_PTRSIZE
==sizeof(char*) );
159 /* If SQLite is already completely initialized, then this call
160 ** to sqlite3_initialize() should be a no-op. But the initialization
161 ** must be complete. So isInit must not be set until the very end
164 if( sqlite3GlobalConfig
.isInit
) return SQLITE_OK
;
166 /* Make sure the mutex subsystem is initialized. If unable to
167 ** initialize the mutex subsystem, return early with the error.
168 ** If the system is so sick that we are unable to allocate a mutex,
169 ** there is not much SQLite is going to be able to do.
171 ** The mutex subsystem must take care of serializing its own
174 rc
= sqlite3MutexInit();
177 /* Initialize the malloc() system and the recursive pInitMutex mutex.
178 ** This operation is protected by the STATIC_MASTER mutex. Note that
179 ** MutexAlloc() is called for a static mutex prior to initializing the
180 ** malloc subsystem - this implies that the allocation of a static
181 ** mutex must not require support from the malloc subsystem.
183 MUTEX_LOGIC( pMaster
= sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER
); )
184 sqlite3_mutex_enter(pMaster
);
185 sqlite3GlobalConfig
.isMutexInit
= 1;
186 if( !sqlite3GlobalConfig
.isMallocInit
){
187 rc
= sqlite3MallocInit();
190 sqlite3GlobalConfig
.isMallocInit
= 1;
191 if( !sqlite3GlobalConfig
.pInitMutex
){
192 sqlite3GlobalConfig
.pInitMutex
=
193 sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE
);
194 if( sqlite3GlobalConfig
.bCoreMutex
&& !sqlite3GlobalConfig
.pInitMutex
){
195 rc
= SQLITE_NOMEM_BKPT
;
200 sqlite3GlobalConfig
.nRefInitMutex
++;
202 sqlite3_mutex_leave(pMaster
);
204 /* If rc is not SQLITE_OK at this point, then either the malloc
205 ** subsystem could not be initialized or the system failed to allocate
206 ** the pInitMutex mutex. Return an error in either case. */
211 /* Do the rest of the initialization under the recursive mutex so
212 ** that we will be able to handle recursive calls into
213 ** sqlite3_initialize(). The recursive calls normally come through
214 ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
215 ** recursive calls might also be possible.
217 ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
218 ** to the xInit method, so the xInit method need not be threadsafe.
220 ** The following mutex is what serializes access to the appdef pcache xInit
221 ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
222 ** call to sqlite3PcacheInitialize().
224 sqlite3_mutex_enter(sqlite3GlobalConfig
.pInitMutex
);
225 if( sqlite3GlobalConfig
.isInit
==0 && sqlite3GlobalConfig
.inProgress
==0 ){
226 sqlite3GlobalConfig
.inProgress
= 1;
227 #ifdef SQLITE_ENABLE_SQLLOG
229 extern void sqlite3_init_sqllog(void);
230 sqlite3_init_sqllog();
233 memset(&sqlite3BuiltinFunctions
, 0, sizeof(sqlite3BuiltinFunctions
));
234 sqlite3RegisterBuiltinFunctions();
235 if( sqlite3GlobalConfig
.isPCacheInit
==0 ){
236 rc
= sqlite3PcacheInitialize();
239 sqlite3GlobalConfig
.isPCacheInit
= 1;
240 rc
= sqlite3OsInit();
242 #ifdef SQLITE_ENABLE_DESERIALIZE
244 rc
= sqlite3MemdbInit();
248 sqlite3PCacheBufferSetup( sqlite3GlobalConfig
.pPage
,
249 sqlite3GlobalConfig
.szPage
, sqlite3GlobalConfig
.nPage
);
250 sqlite3GlobalConfig
.isInit
= 1;
251 #ifdef SQLITE_EXTRA_INIT
255 sqlite3GlobalConfig
.inProgress
= 0;
257 sqlite3_mutex_leave(sqlite3GlobalConfig
.pInitMutex
);
259 /* Go back under the static mutex and clean up the recursive
260 ** mutex to prevent a resource leak.
262 sqlite3_mutex_enter(pMaster
);
263 sqlite3GlobalConfig
.nRefInitMutex
--;
264 if( sqlite3GlobalConfig
.nRefInitMutex
<=0 ){
265 assert( sqlite3GlobalConfig
.nRefInitMutex
==0 );
266 sqlite3_mutex_free(sqlite3GlobalConfig
.pInitMutex
);
267 sqlite3GlobalConfig
.pInitMutex
= 0;
269 sqlite3_mutex_leave(pMaster
);
271 /* The following is just a sanity check to make sure SQLite has
272 ** been compiled correctly. It is important to run this code, but
273 ** we don't want to run it too often and soak up CPU cycles for no
274 ** reason. So we run it once during initialization.
277 #ifndef SQLITE_OMIT_FLOATING_POINT
278 /* This section of code's only "output" is via assert() statements. */
280 u64 x
= (((u64
)1)<<63)-1;
282 assert(sizeof(x
)==8);
283 assert(sizeof(x
)==sizeof(y
));
285 assert( sqlite3IsNaN(y
) );
290 /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
291 ** compile-time option.
293 #ifdef SQLITE_EXTRA_INIT
295 int SQLITE_EXTRA_INIT(const char*);
296 rc
= SQLITE_EXTRA_INIT(0);
304 ** Undo the effects of sqlite3_initialize(). Must not be called while
305 ** there are outstanding database connections or memory allocations or
306 ** while any part of SQLite is otherwise in use in any thread. This
307 ** routine is not threadsafe. But it is safe to invoke this routine
308 ** on when SQLite is already shut down. If SQLite is already shut down
309 ** when this routine is invoked, then this routine is a harmless no-op.
311 int sqlite3_shutdown(void){
312 #ifdef SQLITE_OMIT_WSD
313 int rc
= sqlite3_wsd_init(4096, 24);
319 if( sqlite3GlobalConfig
.isInit
){
320 #ifdef SQLITE_EXTRA_SHUTDOWN
321 void SQLITE_EXTRA_SHUTDOWN(void);
322 SQLITE_EXTRA_SHUTDOWN();
325 sqlite3_reset_auto_extension();
326 sqlite3GlobalConfig
.isInit
= 0;
328 if( sqlite3GlobalConfig
.isPCacheInit
){
329 sqlite3PcacheShutdown();
330 sqlite3GlobalConfig
.isPCacheInit
= 0;
332 if( sqlite3GlobalConfig
.isMallocInit
){
334 sqlite3GlobalConfig
.isMallocInit
= 0;
336 #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
337 /* The heap subsystem has now been shutdown and these values are supposed
338 ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
339 ** which would rely on that heap subsystem; therefore, make sure these
340 ** values cannot refer to heap memory that was just invalidated when the
341 ** heap subsystem was shutdown. This is only done if the current call to
342 ** this function resulted in the heap subsystem actually being shutdown.
344 sqlite3_data_directory
= 0;
345 sqlite3_temp_directory
= 0;
348 if( sqlite3GlobalConfig
.isMutexInit
){
350 sqlite3GlobalConfig
.isMutexInit
= 0;
357 ** This API allows applications to modify the global configuration of
358 ** the SQLite library at run-time.
360 ** This routine should only be called when there are no outstanding
361 ** database connections or memory allocations. This routine is not
362 ** threadsafe. Failure to heed these warnings can lead to unpredictable
365 int sqlite3_config(int op
, ...){
369 /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
370 ** the SQLite library is in use. */
371 if( sqlite3GlobalConfig
.isInit
) return SQLITE_MISUSE_BKPT
;
376 /* Mutex configuration options are only available in a threadsafe
379 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
380 case SQLITE_CONFIG_SINGLETHREAD
: {
381 /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
383 sqlite3GlobalConfig
.bCoreMutex
= 0; /* Disable mutex on core */
384 sqlite3GlobalConfig
.bFullMutex
= 0; /* Disable mutex on connections */
388 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
389 case SQLITE_CONFIG_MULTITHREAD
: {
390 /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
392 sqlite3GlobalConfig
.bCoreMutex
= 1; /* Enable mutex on core */
393 sqlite3GlobalConfig
.bFullMutex
= 0; /* Disable mutex on connections */
397 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
398 case SQLITE_CONFIG_SERIALIZED
: {
399 /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
401 sqlite3GlobalConfig
.bCoreMutex
= 1; /* Enable mutex on core */
402 sqlite3GlobalConfig
.bFullMutex
= 1; /* Enable mutex on connections */
406 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
407 case SQLITE_CONFIG_MUTEX
: {
408 /* Specify an alternative mutex implementation */
409 sqlite3GlobalConfig
.mutex
= *va_arg(ap
, sqlite3_mutex_methods
*);
413 #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
414 case SQLITE_CONFIG_GETMUTEX
: {
415 /* Retrieve the current mutex implementation */
416 *va_arg(ap
, sqlite3_mutex_methods
*) = sqlite3GlobalConfig
.mutex
;
421 case SQLITE_CONFIG_MALLOC
: {
422 /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
423 ** single argument which is a pointer to an instance of the
424 ** sqlite3_mem_methods structure. The argument specifies alternative
425 ** low-level memory allocation routines to be used in place of the memory
426 ** allocation routines built into SQLite. */
427 sqlite3GlobalConfig
.m
= *va_arg(ap
, sqlite3_mem_methods
*);
430 case SQLITE_CONFIG_GETMALLOC
: {
431 /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
432 ** single argument which is a pointer to an instance of the
433 ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
434 ** filled with the currently defined memory allocation routines. */
435 if( sqlite3GlobalConfig
.m
.xMalloc
==0 ) sqlite3MemSetDefault();
436 *va_arg(ap
, sqlite3_mem_methods
*) = sqlite3GlobalConfig
.m
;
439 case SQLITE_CONFIG_MEMSTATUS
: {
440 /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
441 ** single argument of type int, interpreted as a boolean, which enables
442 ** or disables the collection of memory allocation statistics. */
443 sqlite3GlobalConfig
.bMemstat
= va_arg(ap
, int);
446 case SQLITE_CONFIG_SMALL_MALLOC
: {
447 sqlite3GlobalConfig
.bSmallMalloc
= va_arg(ap
, int);
450 case SQLITE_CONFIG_PAGECACHE
: {
451 /* EVIDENCE-OF: R-18761-36601 There are three arguments to
452 ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
453 ** the size of each page cache line (sz), and the number of cache lines
455 sqlite3GlobalConfig
.pPage
= va_arg(ap
, void*);
456 sqlite3GlobalConfig
.szPage
= va_arg(ap
, int);
457 sqlite3GlobalConfig
.nPage
= va_arg(ap
, int);
460 case SQLITE_CONFIG_PCACHE_HDRSZ
: {
461 /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
462 ** a single parameter which is a pointer to an integer and writes into
463 ** that integer the number of extra bytes per page required for each page
464 ** in SQLITE_CONFIG_PAGECACHE. */
466 sqlite3HeaderSizeBtree() +
467 sqlite3HeaderSizePcache() +
468 sqlite3HeaderSizePcache1();
472 case SQLITE_CONFIG_PCACHE
: {
476 case SQLITE_CONFIG_GETPCACHE
: {
482 case SQLITE_CONFIG_PCACHE2
: {
483 /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
484 ** single argument which is a pointer to an sqlite3_pcache_methods2
485 ** object. This object specifies the interface to a custom page cache
486 ** implementation. */
487 sqlite3GlobalConfig
.pcache2
= *va_arg(ap
, sqlite3_pcache_methods2
*);
490 case SQLITE_CONFIG_GETPCACHE2
: {
491 /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
492 ** single argument which is a pointer to an sqlite3_pcache_methods2
493 ** object. SQLite copies of the current page cache implementation into
495 if( sqlite3GlobalConfig
.pcache2
.xInit
==0 ){
496 sqlite3PCacheSetDefault();
498 *va_arg(ap
, sqlite3_pcache_methods2
*) = sqlite3GlobalConfig
.pcache2
;
502 /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
503 ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
504 ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
505 #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
506 case SQLITE_CONFIG_HEAP
: {
507 /* EVIDENCE-OF: R-19854-42126 There are three arguments to
508 ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
509 ** number of bytes in the memory buffer, and the minimum allocation size.
511 sqlite3GlobalConfig
.pHeap
= va_arg(ap
, void*);
512 sqlite3GlobalConfig
.nHeap
= va_arg(ap
, int);
513 sqlite3GlobalConfig
.mnReq
= va_arg(ap
, int);
515 if( sqlite3GlobalConfig
.mnReq
<1 ){
516 sqlite3GlobalConfig
.mnReq
= 1;
517 }else if( sqlite3GlobalConfig
.mnReq
>(1<<12) ){
518 /* cap min request size at 2^12 */
519 sqlite3GlobalConfig
.mnReq
= (1<<12);
522 if( sqlite3GlobalConfig
.pHeap
==0 ){
523 /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
524 ** is NULL, then SQLite reverts to using its default memory allocator
525 ** (the system malloc() implementation), undoing any prior invocation of
526 ** SQLITE_CONFIG_MALLOC.
528 ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
529 ** revert to its default implementation when sqlite3_initialize() is run
531 memset(&sqlite3GlobalConfig
.m
, 0, sizeof(sqlite3GlobalConfig
.m
));
533 /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
534 ** alternative memory allocator is engaged to handle all of SQLites
535 ** memory allocation needs. */
536 #ifdef SQLITE_ENABLE_MEMSYS3
537 sqlite3GlobalConfig
.m
= *sqlite3MemGetMemsys3();
539 #ifdef SQLITE_ENABLE_MEMSYS5
540 sqlite3GlobalConfig
.m
= *sqlite3MemGetMemsys5();
547 case SQLITE_CONFIG_LOOKASIDE
: {
548 sqlite3GlobalConfig
.szLookaside
= va_arg(ap
, int);
549 sqlite3GlobalConfig
.nLookaside
= va_arg(ap
, int);
553 /* Record a pointer to the logger function and its first argument.
554 ** The default is NULL. Logging is disabled if the function pointer is
557 case SQLITE_CONFIG_LOG
: {
558 /* MSVC is picky about pulling func ptrs from va lists.
559 ** http://support.microsoft.com/kb/47961
560 ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
562 typedef void(*LOGFUNC_t
)(void*,int,const char*);
563 sqlite3GlobalConfig
.xLog
= va_arg(ap
, LOGFUNC_t
);
564 sqlite3GlobalConfig
.pLogArg
= va_arg(ap
, void*);
568 /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
569 ** can be changed at start-time using the
570 ** sqlite3_config(SQLITE_CONFIG_URI,1) or
571 ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
573 case SQLITE_CONFIG_URI
: {
574 /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
575 ** argument of type int. If non-zero, then URI handling is globally
576 ** enabled. If the parameter is zero, then URI handling is globally
578 sqlite3GlobalConfig
.bOpenUri
= va_arg(ap
, int);
582 case SQLITE_CONFIG_COVERING_INDEX_SCAN
: {
583 /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
584 ** option takes a single integer argument which is interpreted as a
585 ** boolean in order to enable or disable the use of covering indices for
586 ** full table scans in the query optimizer. */
587 sqlite3GlobalConfig
.bUseCis
= va_arg(ap
, int);
591 #ifdef SQLITE_ENABLE_SQLLOG
592 case SQLITE_CONFIG_SQLLOG
: {
593 typedef void(*SQLLOGFUNC_t
)(void*, sqlite3
*, const char*, int);
594 sqlite3GlobalConfig
.xSqllog
= va_arg(ap
, SQLLOGFUNC_t
);
595 sqlite3GlobalConfig
.pSqllogArg
= va_arg(ap
, void *);
600 case SQLITE_CONFIG_MMAP_SIZE
: {
601 /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
602 ** integer (sqlite3_int64) values that are the default mmap size limit
603 ** (the default setting for PRAGMA mmap_size) and the maximum allowed
604 ** mmap size limit. */
605 sqlite3_int64 szMmap
= va_arg(ap
, sqlite3_int64
);
606 sqlite3_int64 mxMmap
= va_arg(ap
, sqlite3_int64
);
607 /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
608 ** negative, then that argument is changed to its compile-time default.
610 ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
611 ** silently truncated if necessary so that it does not exceed the
612 ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
613 ** compile-time option.
615 if( mxMmap
<0 || mxMmap
>SQLITE_MAX_MMAP_SIZE
){
616 mxMmap
= SQLITE_MAX_MMAP_SIZE
;
618 if( szMmap
<0 ) szMmap
= SQLITE_DEFAULT_MMAP_SIZE
;
619 if( szMmap
>mxMmap
) szMmap
= mxMmap
;
620 sqlite3GlobalConfig
.mxMmap
= mxMmap
;
621 sqlite3GlobalConfig
.szMmap
= szMmap
;
625 #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
626 case SQLITE_CONFIG_WIN32_HEAPSIZE
: {
627 /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
628 ** unsigned integer value that specifies the maximum size of the created
630 sqlite3GlobalConfig
.nHeap
= va_arg(ap
, int);
635 case SQLITE_CONFIG_PMASZ
: {
636 sqlite3GlobalConfig
.szPma
= va_arg(ap
, unsigned int);
640 case SQLITE_CONFIG_STMTJRNL_SPILL
: {
641 sqlite3GlobalConfig
.nStmtSpill
= va_arg(ap
, int);
655 ** Set up the lookaside buffers for a database connection.
656 ** Return SQLITE_OK on success.
657 ** If lookaside is already active, return SQLITE_BUSY.
659 ** The sz parameter is the number of bytes in each lookaside slot.
660 ** The cnt parameter is the number of slots. If pStart is NULL the
661 ** space for the lookaside memory is obtained from sqlite3_malloc().
662 ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
663 ** the lookaside memory.
665 static int setupLookaside(sqlite3
*db
, void *pBuf
, int sz
, int cnt
){
666 #ifndef SQLITE_OMIT_LOOKASIDE
669 if( sqlite3LookasideUsed(db
,0)>0 ){
672 /* Free any existing lookaside buffer for this handle before
673 ** allocating a new one so we don't have to have space for
674 ** both at the same time.
676 if( db
->lookaside
.bMalloced
){
677 sqlite3_free(db
->lookaside
.pStart
);
679 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
680 ** than a pointer to be useful.
682 sz
= ROUNDDOWN8(sz
); /* IMP: R-33038-09382 */
683 if( sz
<=(int)sizeof(LookasideSlot
*) ) sz
= 0;
685 if( sz
==0 || cnt
==0 ){
689 sqlite3BeginBenignMalloc();
690 pStart
= sqlite3Malloc( sz
*cnt
); /* IMP: R-61949-35727 */
691 sqlite3EndBenignMalloc();
692 if( pStart
) cnt
= sqlite3MallocSize(pStart
)/sz
;
696 db
->lookaside
.pStart
= pStart
;
697 db
->lookaside
.pInit
= 0;
698 db
->lookaside
.pFree
= 0;
699 db
->lookaside
.sz
= (u16
)sz
;
703 assert( sz
> (int)sizeof(LookasideSlot
*) );
704 db
->lookaside
.nSlot
= cnt
;
705 p
= (LookasideSlot
*)pStart
;
706 for(i
=cnt
-1; i
>=0; i
--){
707 p
->pNext
= db
->lookaside
.pInit
;
708 db
->lookaside
.pInit
= p
;
709 p
= (LookasideSlot
*)&((u8
*)p
)[sz
];
711 db
->lookaside
.pEnd
= p
;
712 db
->lookaside
.bDisable
= 0;
713 db
->lookaside
.bMalloced
= pBuf
==0 ?1:0;
715 db
->lookaside
.pStart
= db
;
716 db
->lookaside
.pEnd
= db
;
717 db
->lookaside
.bDisable
= 1;
718 db
->lookaside
.bMalloced
= 0;
719 db
->lookaside
.nSlot
= 0;
721 #endif /* SQLITE_OMIT_LOOKASIDE */
726 ** Return the mutex associated with a database connection.
728 sqlite3_mutex
*sqlite3_db_mutex(sqlite3
*db
){
729 #ifdef SQLITE_ENABLE_API_ARMOR
730 if( !sqlite3SafetyCheckOk(db
) ){
731 (void)SQLITE_MISUSE_BKPT
;
739 ** Free up as much memory as we can from the given database
742 int sqlite3_db_release_memory(sqlite3
*db
){
745 #ifdef SQLITE_ENABLE_API_ARMOR
746 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
748 sqlite3_mutex_enter(db
->mutex
);
749 sqlite3BtreeEnterAll(db
);
750 for(i
=0; i
<db
->nDb
; i
++){
751 Btree
*pBt
= db
->aDb
[i
].pBt
;
753 Pager
*pPager
= sqlite3BtreePager(pBt
);
754 sqlite3PagerShrink(pPager
);
757 sqlite3BtreeLeaveAll(db
);
758 sqlite3_mutex_leave(db
->mutex
);
763 ** Flush any dirty pages in the pager-cache for any attached database
766 int sqlite3_db_cacheflush(sqlite3
*db
){
771 #ifdef SQLITE_ENABLE_API_ARMOR
772 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
774 sqlite3_mutex_enter(db
->mutex
);
775 sqlite3BtreeEnterAll(db
);
776 for(i
=0; rc
==SQLITE_OK
&& i
<db
->nDb
; i
++){
777 Btree
*pBt
= db
->aDb
[i
].pBt
;
778 if( pBt
&& sqlite3BtreeIsInTrans(pBt
) ){
779 Pager
*pPager
= sqlite3BtreePager(pBt
);
780 rc
= sqlite3PagerFlush(pPager
);
781 if( rc
==SQLITE_BUSY
){
787 sqlite3BtreeLeaveAll(db
);
788 sqlite3_mutex_leave(db
->mutex
);
789 return ((rc
==SQLITE_OK
&& bSeenBusy
) ? SQLITE_BUSY
: rc
);
793 ** Configuration settings for an individual database connection
795 int sqlite3_db_config(sqlite3
*db
, int op
, ...){
800 case SQLITE_DBCONFIG_MAINDBNAME
: {
801 /* IMP: R-06824-28531 */
802 /* IMP: R-36257-52125 */
803 db
->aDb
[0].zDbSName
= va_arg(ap
,char*);
807 case SQLITE_DBCONFIG_LOOKASIDE
: {
808 void *pBuf
= va_arg(ap
, void*); /* IMP: R-26835-10964 */
809 int sz
= va_arg(ap
, int); /* IMP: R-47871-25994 */
810 int cnt
= va_arg(ap
, int); /* IMP: R-04460-53386 */
811 rc
= setupLookaside(db
, pBuf
, sz
, cnt
);
815 static const struct {
816 int op
; /* The opcode */
817 u32 mask
; /* Mask of the bit in sqlite3.flags to set/clear */
819 { SQLITE_DBCONFIG_ENABLE_FKEY
, SQLITE_ForeignKeys
},
820 { SQLITE_DBCONFIG_ENABLE_TRIGGER
, SQLITE_EnableTrigger
},
821 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
, SQLITE_Fts3Tokenizer
},
822 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
, SQLITE_LoadExtension
},
823 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
, SQLITE_NoCkptOnClose
},
824 { SQLITE_DBCONFIG_ENABLE_QPSG
, SQLITE_EnableQPSG
},
825 { SQLITE_DBCONFIG_TRIGGER_EQP
, SQLITE_TriggerEQP
},
828 rc
= SQLITE_ERROR
; /* IMP: R-42790-23372 */
829 for(i
=0; i
<ArraySize(aFlagOp
); i
++){
830 if( aFlagOp
[i
].op
==op
){
831 int onoff
= va_arg(ap
, int);
832 int *pRes
= va_arg(ap
, int*);
833 u32 oldFlags
= db
->flags
;
835 db
->flags
|= aFlagOp
[i
].mask
;
836 }else if( onoff
==0 ){
837 db
->flags
&= ~aFlagOp
[i
].mask
;
839 if( oldFlags
!=db
->flags
){
840 sqlite3ExpirePreparedStatements(db
);
843 *pRes
= (db
->flags
& aFlagOp
[i
].mask
)!=0;
858 ** Return true if the buffer z[0..n-1] contains all spaces.
860 static int allSpaces(const char *z
, int n
){
861 while( n
>0 && z
[n
-1]==' ' ){ n
--; }
866 ** This is the default collating function named "BINARY" which is always
869 ** If the padFlag argument is not NULL then space padding at the end
870 ** of strings is ignored. This implements the RTRIM collation.
872 static int binCollFunc(
874 int nKey1
, const void *pKey1
,
875 int nKey2
, const void *pKey2
878 n
= nKey1
<nKey2
? nKey1
: nKey2
;
879 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
880 ** strings byte by byte using the memcmp() function from the standard C
882 assert( pKey1
&& pKey2
);
883 rc
= memcmp(pKey1
, pKey2
, n
);
886 && allSpaces(((char*)pKey1
)+n
, nKey1
-n
)
887 && allSpaces(((char*)pKey2
)+n
, nKey2
-n
)
889 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
890 ** spaces at the end of either string do not change the result. In other
891 ** words, strings will compare equal to one another as long as they
892 ** differ only in the number of spaces at the end.
902 ** Another built-in collating sequence: NOCASE.
904 ** This collating sequence is intended to be used for "case independent
905 ** comparison". SQLite's knowledge of upper and lower case equivalents
906 ** extends only to the 26 characters used in the English language.
908 ** At the moment there is only a UTF-8 implementation.
910 static int nocaseCollatingFunc(
912 int nKey1
, const void *pKey1
,
913 int nKey2
, const void *pKey2
915 int r
= sqlite3StrNICmp(
916 (const char *)pKey1
, (const char *)pKey2
, (nKey1
<nKey2
)?nKey1
:nKey2
);
917 UNUSED_PARAMETER(NotUsed
);
925 ** Return the ROWID of the most recent insert
927 sqlite_int64
sqlite3_last_insert_rowid(sqlite3
*db
){
928 #ifdef SQLITE_ENABLE_API_ARMOR
929 if( !sqlite3SafetyCheckOk(db
) ){
930 (void)SQLITE_MISUSE_BKPT
;
934 return db
->lastRowid
;
938 ** Set the value returned by the sqlite3_last_insert_rowid() API function.
940 void sqlite3_set_last_insert_rowid(sqlite3
*db
, sqlite3_int64 iRowid
){
941 #ifdef SQLITE_ENABLE_API_ARMOR
942 if( !sqlite3SafetyCheckOk(db
) ){
943 (void)SQLITE_MISUSE_BKPT
;
947 sqlite3_mutex_enter(db
->mutex
);
948 db
->lastRowid
= iRowid
;
949 sqlite3_mutex_leave(db
->mutex
);
953 ** Return the number of changes in the most recent call to sqlite3_exec().
955 int sqlite3_changes(sqlite3
*db
){
956 #ifdef SQLITE_ENABLE_API_ARMOR
957 if( !sqlite3SafetyCheckOk(db
) ){
958 (void)SQLITE_MISUSE_BKPT
;
966 ** Return the number of changes since the database handle was opened.
968 int sqlite3_total_changes(sqlite3
*db
){
969 #ifdef SQLITE_ENABLE_API_ARMOR
970 if( !sqlite3SafetyCheckOk(db
) ){
971 (void)SQLITE_MISUSE_BKPT
;
975 return db
->nTotalChange
;
979 ** Close all open savepoints. This function only manipulates fields of the
980 ** database handle object, it does not close any savepoints that may be open
981 ** at the b-tree/pager level.
983 void sqlite3CloseSavepoints(sqlite3
*db
){
984 while( db
->pSavepoint
){
985 Savepoint
*pTmp
= db
->pSavepoint
;
986 db
->pSavepoint
= pTmp
->pNext
;
987 sqlite3DbFree(db
, pTmp
);
991 db
->isTransactionSavepoint
= 0;
995 ** Invoke the destructor function associated with FuncDef p, if any. Except,
996 ** if this is not the last copy of the function, do not invoke it. Multiple
997 ** copies of a single function are created when create_function() is called
998 ** with SQLITE_ANY as the encoding.
1000 static void functionDestroy(sqlite3
*db
, FuncDef
*p
){
1001 FuncDestructor
*pDestructor
= p
->u
.pDestructor
;
1003 pDestructor
->nRef
--;
1004 if( pDestructor
->nRef
==0 ){
1005 pDestructor
->xDestroy(pDestructor
->pUserData
);
1006 sqlite3DbFree(db
, pDestructor
);
1012 ** Disconnect all sqlite3_vtab objects that belong to database connection
1013 ** db. This is called when db is being closed.
1015 static void disconnectAllVtab(sqlite3
*db
){
1016 #ifndef SQLITE_OMIT_VIRTUALTABLE
1019 sqlite3BtreeEnterAll(db
);
1020 for(i
=0; i
<db
->nDb
; i
++){
1021 Schema
*pSchema
= db
->aDb
[i
].pSchema
;
1022 if( db
->aDb
[i
].pSchema
){
1023 for(p
=sqliteHashFirst(&pSchema
->tblHash
); p
; p
=sqliteHashNext(p
)){
1024 Table
*pTab
= (Table
*)sqliteHashData(p
);
1025 if( IsVirtual(pTab
) ) sqlite3VtabDisconnect(db
, pTab
);
1029 for(p
=sqliteHashFirst(&db
->aModule
); p
; p
=sqliteHashNext(p
)){
1030 Module
*pMod
= (Module
*)sqliteHashData(p
);
1031 if( pMod
->pEpoTab
){
1032 sqlite3VtabDisconnect(db
, pMod
->pEpoTab
);
1035 sqlite3VtabUnlockList(db
);
1036 sqlite3BtreeLeaveAll(db
);
1038 UNUSED_PARAMETER(db
);
1043 ** Return TRUE if database connection db has unfinalized prepared
1044 ** statements or unfinished sqlite3_backup objects.
1046 static int connectionIsBusy(sqlite3
*db
){
1048 assert( sqlite3_mutex_held(db
->mutex
) );
1049 if( db
->pVdbe
) return 1;
1050 for(j
=0; j
<db
->nDb
; j
++){
1051 Btree
*pBt
= db
->aDb
[j
].pBt
;
1052 if( pBt
&& sqlite3BtreeIsInBackup(pBt
) ) return 1;
1058 ** Close an existing SQLite database
1060 static int sqlite3Close(sqlite3
*db
, int forceZombie
){
1062 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1063 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
1066 if( !sqlite3SafetyCheckSickOrOk(db
) ){
1067 return SQLITE_MISUSE_BKPT
;
1069 sqlite3_mutex_enter(db
->mutex
);
1070 if( db
->mTrace
& SQLITE_TRACE_CLOSE
){
1071 db
->xTrace(SQLITE_TRACE_CLOSE
, db
->pTraceArg
, db
, 0);
1074 /* Force xDisconnect calls on all virtual tables */
1075 disconnectAllVtab(db
);
1077 /* If a transaction is open, the disconnectAllVtab() call above
1078 ** will not have called the xDisconnect() method on any virtual
1079 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1080 ** call will do so. We need to do this before the check for active
1081 ** SQL statements below, as the v-table implementation may be storing
1082 ** some prepared statements internally.
1084 sqlite3VtabRollback(db
);
1086 /* Legacy behavior (sqlite3_close() behavior) is to return
1087 ** SQLITE_BUSY if the connection can not be closed immediately.
1089 if( !forceZombie
&& connectionIsBusy(db
) ){
1090 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
, "unable to close due to unfinalized "
1091 "statements or unfinished backups");
1092 sqlite3_mutex_leave(db
->mutex
);
1096 #ifdef SQLITE_ENABLE_SQLLOG
1097 if( sqlite3GlobalConfig
.xSqllog
){
1098 /* Closing the handle. Fourth parameter is passed the value 2. */
1099 sqlite3GlobalConfig
.xSqllog(sqlite3GlobalConfig
.pSqllogArg
, db
, 0, 2);
1103 /* Convert the connection into a zombie and then close it.
1105 db
->magic
= SQLITE_MAGIC_ZOMBIE
;
1106 sqlite3LeaveMutexAndCloseZombie(db
);
1111 ** Two variations on the public interface for closing a database
1112 ** connection. The sqlite3_close() version returns SQLITE_BUSY and
1113 ** leaves the connection option if there are unfinalized prepared
1114 ** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1115 ** version forces the connection to become a zombie if there are
1116 ** unclosed resources, and arranges for deallocation when the last
1117 ** prepare statement or sqlite3_backup closes.
1119 int sqlite3_close(sqlite3
*db
){ return sqlite3Close(db
,0); }
1120 int sqlite3_close_v2(sqlite3
*db
){ return sqlite3Close(db
,1); }
1124 ** Close the mutex on database connection db.
1126 ** Furthermore, if database connection db is a zombie (meaning that there
1127 ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1128 ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1129 ** finished, then free all resources.
1131 void sqlite3LeaveMutexAndCloseZombie(sqlite3
*db
){
1132 HashElem
*i
; /* Hash table iterator */
1135 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
1136 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1137 ** then just leave the mutex and return.
1139 if( db
->magic
!=SQLITE_MAGIC_ZOMBIE
|| connectionIsBusy(db
) ){
1140 sqlite3_mutex_leave(db
->mutex
);
1144 /* If we reach this point, it means that the database connection has
1145 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
1146 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
1147 ** go ahead and free all resources.
1150 /* If a transaction is open, roll it back. This also ensures that if
1151 ** any database schemas have been modified by an uncommitted transaction
1152 ** they are reset. And that the required b-tree mutex is held to make
1153 ** the pager rollback and schema reset an atomic operation. */
1154 sqlite3RollbackAll(db
, SQLITE_OK
);
1156 /* Free any outstanding Savepoint structures. */
1157 sqlite3CloseSavepoints(db
);
1159 /* Close all database connections */
1160 for(j
=0; j
<db
->nDb
; j
++){
1161 struct Db
*pDb
= &db
->aDb
[j
];
1163 sqlite3BtreeClose(pDb
->pBt
);
1170 /* Clear the TEMP schema separately and last */
1171 if( db
->aDb
[1].pSchema
){
1172 sqlite3SchemaClear(db
->aDb
[1].pSchema
);
1174 sqlite3VtabUnlockList(db
);
1176 /* Free up the array of auxiliary databases */
1177 sqlite3CollapseDatabaseArray(db
);
1178 assert( db
->nDb
<=2 );
1179 assert( db
->aDb
==db
->aDbStatic
);
1181 /* Tell the code in notify.c that the connection no longer holds any
1182 ** locks and does not require any further unlock-notify callbacks.
1184 sqlite3ConnectionClosed(db
);
1186 for(i
=sqliteHashFirst(&db
->aFunc
); i
; i
=sqliteHashNext(i
)){
1188 p
= sqliteHashData(i
);
1190 functionDestroy(db
, p
);
1192 sqlite3DbFree(db
, p
);
1196 sqlite3HashClear(&db
->aFunc
);
1197 for(i
=sqliteHashFirst(&db
->aCollSeq
); i
; i
=sqliteHashNext(i
)){
1198 CollSeq
*pColl
= (CollSeq
*)sqliteHashData(i
);
1199 /* Invoke any destructors registered for collation sequence user data. */
1201 if( pColl
[j
].xDel
){
1202 pColl
[j
].xDel(pColl
[j
].pUser
);
1205 sqlite3DbFree(db
, pColl
);
1207 sqlite3HashClear(&db
->aCollSeq
);
1208 #ifndef SQLITE_OMIT_VIRTUALTABLE
1209 for(i
=sqliteHashFirst(&db
->aModule
); i
; i
=sqliteHashNext(i
)){
1210 Module
*pMod
= (Module
*)sqliteHashData(i
);
1211 if( pMod
->xDestroy
){
1212 pMod
->xDestroy(pMod
->pAux
);
1214 sqlite3VtabEponymousTableClear(db
, pMod
);
1215 sqlite3DbFree(db
, pMod
);
1217 sqlite3HashClear(&db
->aModule
);
1220 sqlite3Error(db
, SQLITE_OK
); /* Deallocates any cached error strings. */
1221 sqlite3ValueFree(db
->pErr
);
1222 sqlite3CloseExtensions(db
);
1223 #if SQLITE_USER_AUTHENTICATION
1224 sqlite3_free(db
->auth
.zAuthUser
);
1225 sqlite3_free(db
->auth
.zAuthPW
);
1228 db
->magic
= SQLITE_MAGIC_ERROR
;
1230 /* The temp-database schema is allocated differently from the other schema
1231 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1232 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1233 ** the same sqliteMalloc() as the one that allocates the database
1236 sqlite3DbFree(db
, db
->aDb
[1].pSchema
);
1237 sqlite3_mutex_leave(db
->mutex
);
1238 db
->magic
= SQLITE_MAGIC_CLOSED
;
1239 sqlite3_mutex_free(db
->mutex
);
1240 assert( sqlite3LookasideUsed(db
,0)==0 );
1241 if( db
->lookaside
.bMalloced
){
1242 sqlite3_free(db
->lookaside
.pStart
);
1248 ** Rollback all database files. If tripCode is not SQLITE_OK, then
1249 ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
1250 ** breaker") and made to return tripCode if there are any further
1251 ** attempts to use that cursor. Read cursors remain open and valid
1252 ** but are "saved" in case the table pages are moved around.
1254 void sqlite3RollbackAll(sqlite3
*db
, int tripCode
){
1258 assert( sqlite3_mutex_held(db
->mutex
) );
1259 sqlite3BeginBenignMalloc();
1261 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1262 ** This is important in case the transaction being rolled back has
1263 ** modified the database schema. If the b-tree mutexes are not taken
1264 ** here, then another shared-cache connection might sneak in between
1265 ** the database rollback and schema reset, which can cause false
1266 ** corruption reports in some cases. */
1267 sqlite3BtreeEnterAll(db
);
1268 schemaChange
= (db
->mDbFlags
& DBFLAG_SchemaChange
)!=0 && db
->init
.busy
==0;
1270 for(i
=0; i
<db
->nDb
; i
++){
1271 Btree
*p
= db
->aDb
[i
].pBt
;
1273 if( sqlite3BtreeIsInTrans(p
) ){
1276 sqlite3BtreeRollback(p
, tripCode
, !schemaChange
);
1279 sqlite3VtabRollback(db
);
1280 sqlite3EndBenignMalloc();
1282 if( (db
->mDbFlags
&DBFLAG_SchemaChange
)!=0 && db
->init
.busy
==0 ){
1283 sqlite3ExpirePreparedStatements(db
);
1284 sqlite3ResetAllSchemasOfConnection(db
);
1286 sqlite3BtreeLeaveAll(db
);
1288 /* Any deferred constraint violations have now been resolved. */
1289 db
->nDeferredCons
= 0;
1290 db
->nDeferredImmCons
= 0;
1291 db
->flags
&= ~SQLITE_DeferFKs
;
1293 /* If one has been configured, invoke the rollback-hook callback */
1294 if( db
->xRollbackCallback
&& (inTrans
|| !db
->autoCommit
) ){
1295 db
->xRollbackCallback(db
->pRollbackArg
);
1300 ** Return a static string containing the name corresponding to the error code
1301 ** specified in the argument.
1303 #if defined(SQLITE_NEED_ERR_NAME)
1304 const char *sqlite3ErrName(int rc
){
1305 const char *zName
= 0;
1307 for(i
=0; i
<2 && zName
==0; i
++, rc
&= 0xff){
1309 case SQLITE_OK
: zName
= "SQLITE_OK"; break;
1310 case SQLITE_ERROR
: zName
= "SQLITE_ERROR"; break;
1311 case SQLITE_INTERNAL
: zName
= "SQLITE_INTERNAL"; break;
1312 case SQLITE_PERM
: zName
= "SQLITE_PERM"; break;
1313 case SQLITE_ABORT
: zName
= "SQLITE_ABORT"; break;
1314 case SQLITE_ABORT_ROLLBACK
: zName
= "SQLITE_ABORT_ROLLBACK"; break;
1315 case SQLITE_BUSY
: zName
= "SQLITE_BUSY"; break;
1316 case SQLITE_BUSY_RECOVERY
: zName
= "SQLITE_BUSY_RECOVERY"; break;
1317 case SQLITE_BUSY_SNAPSHOT
: zName
= "SQLITE_BUSY_SNAPSHOT"; break;
1318 case SQLITE_LOCKED
: zName
= "SQLITE_LOCKED"; break;
1319 case SQLITE_LOCKED_SHAREDCACHE
: zName
= "SQLITE_LOCKED_SHAREDCACHE";break;
1320 case SQLITE_NOMEM
: zName
= "SQLITE_NOMEM"; break;
1321 case SQLITE_READONLY
: zName
= "SQLITE_READONLY"; break;
1322 case SQLITE_READONLY_RECOVERY
: zName
= "SQLITE_READONLY_RECOVERY"; break;
1323 case SQLITE_READONLY_CANTINIT
: zName
= "SQLITE_READONLY_CANTINIT"; break;
1324 case SQLITE_READONLY_ROLLBACK
: zName
= "SQLITE_READONLY_ROLLBACK"; break;
1325 case SQLITE_READONLY_DBMOVED
: zName
= "SQLITE_READONLY_DBMOVED"; break;
1326 case SQLITE_READONLY_DIRECTORY
: zName
= "SQLITE_READONLY_DIRECTORY";break;
1327 case SQLITE_INTERRUPT
: zName
= "SQLITE_INTERRUPT"; break;
1328 case SQLITE_IOERR
: zName
= "SQLITE_IOERR"; break;
1329 case SQLITE_IOERR_READ
: zName
= "SQLITE_IOERR_READ"; break;
1330 case SQLITE_IOERR_SHORT_READ
: zName
= "SQLITE_IOERR_SHORT_READ"; break;
1331 case SQLITE_IOERR_WRITE
: zName
= "SQLITE_IOERR_WRITE"; break;
1332 case SQLITE_IOERR_FSYNC
: zName
= "SQLITE_IOERR_FSYNC"; break;
1333 case SQLITE_IOERR_DIR_FSYNC
: zName
= "SQLITE_IOERR_DIR_FSYNC"; break;
1334 case SQLITE_IOERR_TRUNCATE
: zName
= "SQLITE_IOERR_TRUNCATE"; break;
1335 case SQLITE_IOERR_FSTAT
: zName
= "SQLITE_IOERR_FSTAT"; break;
1336 case SQLITE_IOERR_UNLOCK
: zName
= "SQLITE_IOERR_UNLOCK"; break;
1337 case SQLITE_IOERR_RDLOCK
: zName
= "SQLITE_IOERR_RDLOCK"; break;
1338 case SQLITE_IOERR_DELETE
: zName
= "SQLITE_IOERR_DELETE"; break;
1339 case SQLITE_IOERR_NOMEM
: zName
= "SQLITE_IOERR_NOMEM"; break;
1340 case SQLITE_IOERR_ACCESS
: zName
= "SQLITE_IOERR_ACCESS"; break;
1341 case SQLITE_IOERR_CHECKRESERVEDLOCK
:
1342 zName
= "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1343 case SQLITE_IOERR_LOCK
: zName
= "SQLITE_IOERR_LOCK"; break;
1344 case SQLITE_IOERR_CLOSE
: zName
= "SQLITE_IOERR_CLOSE"; break;
1345 case SQLITE_IOERR_DIR_CLOSE
: zName
= "SQLITE_IOERR_DIR_CLOSE"; break;
1346 case SQLITE_IOERR_SHMOPEN
: zName
= "SQLITE_IOERR_SHMOPEN"; break;
1347 case SQLITE_IOERR_SHMSIZE
: zName
= "SQLITE_IOERR_SHMSIZE"; break;
1348 case SQLITE_IOERR_SHMLOCK
: zName
= "SQLITE_IOERR_SHMLOCK"; break;
1349 case SQLITE_IOERR_SHMMAP
: zName
= "SQLITE_IOERR_SHMMAP"; break;
1350 case SQLITE_IOERR_SEEK
: zName
= "SQLITE_IOERR_SEEK"; break;
1351 case SQLITE_IOERR_DELETE_NOENT
: zName
= "SQLITE_IOERR_DELETE_NOENT";break;
1352 case SQLITE_IOERR_MMAP
: zName
= "SQLITE_IOERR_MMAP"; break;
1353 case SQLITE_IOERR_GETTEMPPATH
: zName
= "SQLITE_IOERR_GETTEMPPATH"; break;
1354 case SQLITE_IOERR_CONVPATH
: zName
= "SQLITE_IOERR_CONVPATH"; break;
1355 case SQLITE_CORRUPT
: zName
= "SQLITE_CORRUPT"; break;
1356 case SQLITE_CORRUPT_VTAB
: zName
= "SQLITE_CORRUPT_VTAB"; break;
1357 case SQLITE_NOTFOUND
: zName
= "SQLITE_NOTFOUND"; break;
1358 case SQLITE_FULL
: zName
= "SQLITE_FULL"; break;
1359 case SQLITE_CANTOPEN
: zName
= "SQLITE_CANTOPEN"; break;
1360 case SQLITE_CANTOPEN_NOTEMPDIR
: zName
= "SQLITE_CANTOPEN_NOTEMPDIR";break;
1361 case SQLITE_CANTOPEN_ISDIR
: zName
= "SQLITE_CANTOPEN_ISDIR"; break;
1362 case SQLITE_CANTOPEN_FULLPATH
: zName
= "SQLITE_CANTOPEN_FULLPATH"; break;
1363 case SQLITE_CANTOPEN_CONVPATH
: zName
= "SQLITE_CANTOPEN_CONVPATH"; break;
1364 case SQLITE_PROTOCOL
: zName
= "SQLITE_PROTOCOL"; break;
1365 case SQLITE_EMPTY
: zName
= "SQLITE_EMPTY"; break;
1366 case SQLITE_SCHEMA
: zName
= "SQLITE_SCHEMA"; break;
1367 case SQLITE_TOOBIG
: zName
= "SQLITE_TOOBIG"; break;
1368 case SQLITE_CONSTRAINT
: zName
= "SQLITE_CONSTRAINT"; break;
1369 case SQLITE_CONSTRAINT_UNIQUE
: zName
= "SQLITE_CONSTRAINT_UNIQUE"; break;
1370 case SQLITE_CONSTRAINT_TRIGGER
: zName
= "SQLITE_CONSTRAINT_TRIGGER";break;
1371 case SQLITE_CONSTRAINT_FOREIGNKEY
:
1372 zName
= "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1373 case SQLITE_CONSTRAINT_CHECK
: zName
= "SQLITE_CONSTRAINT_CHECK"; break;
1374 case SQLITE_CONSTRAINT_PRIMARYKEY
:
1375 zName
= "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1376 case SQLITE_CONSTRAINT_NOTNULL
: zName
= "SQLITE_CONSTRAINT_NOTNULL";break;
1377 case SQLITE_CONSTRAINT_COMMITHOOK
:
1378 zName
= "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1379 case SQLITE_CONSTRAINT_VTAB
: zName
= "SQLITE_CONSTRAINT_VTAB"; break;
1380 case SQLITE_CONSTRAINT_FUNCTION
:
1381 zName
= "SQLITE_CONSTRAINT_FUNCTION"; break;
1382 case SQLITE_CONSTRAINT_ROWID
: zName
= "SQLITE_CONSTRAINT_ROWID"; break;
1383 case SQLITE_MISMATCH
: zName
= "SQLITE_MISMATCH"; break;
1384 case SQLITE_MISUSE
: zName
= "SQLITE_MISUSE"; break;
1385 case SQLITE_NOLFS
: zName
= "SQLITE_NOLFS"; break;
1386 case SQLITE_AUTH
: zName
= "SQLITE_AUTH"; break;
1387 case SQLITE_FORMAT
: zName
= "SQLITE_FORMAT"; break;
1388 case SQLITE_RANGE
: zName
= "SQLITE_RANGE"; break;
1389 case SQLITE_NOTADB
: zName
= "SQLITE_NOTADB"; break;
1390 case SQLITE_ROW
: zName
= "SQLITE_ROW"; break;
1391 case SQLITE_NOTICE
: zName
= "SQLITE_NOTICE"; break;
1392 case SQLITE_NOTICE_RECOVER_WAL
: zName
= "SQLITE_NOTICE_RECOVER_WAL";break;
1393 case SQLITE_NOTICE_RECOVER_ROLLBACK
:
1394 zName
= "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
1395 case SQLITE_WARNING
: zName
= "SQLITE_WARNING"; break;
1396 case SQLITE_WARNING_AUTOINDEX
: zName
= "SQLITE_WARNING_AUTOINDEX"; break;
1397 case SQLITE_DONE
: zName
= "SQLITE_DONE"; break;
1401 static char zBuf
[50];
1402 sqlite3_snprintf(sizeof(zBuf
), zBuf
, "SQLITE_UNKNOWN(%d)", origRc
);
1410 ** Return a static string that describes the kind of error specified in the
1413 const char *sqlite3ErrStr(int rc
){
1414 static const char* const aMsg
[] = {
1415 /* SQLITE_OK */ "not an error",
1416 /* SQLITE_ERROR */ "SQL logic error",
1417 /* SQLITE_INTERNAL */ 0,
1418 /* SQLITE_PERM */ "access permission denied",
1419 /* SQLITE_ABORT */ "query aborted",
1420 /* SQLITE_BUSY */ "database is locked",
1421 /* SQLITE_LOCKED */ "database table is locked",
1422 /* SQLITE_NOMEM */ "out of memory",
1423 /* SQLITE_READONLY */ "attempt to write a readonly database",
1424 /* SQLITE_INTERRUPT */ "interrupted",
1425 /* SQLITE_IOERR */ "disk I/O error",
1426 /* SQLITE_CORRUPT */ "database disk image is malformed",
1427 /* SQLITE_NOTFOUND */ "unknown operation",
1428 /* SQLITE_FULL */ "database or disk is full",
1429 /* SQLITE_CANTOPEN */ "unable to open database file",
1430 /* SQLITE_PROTOCOL */ "locking protocol",
1431 /* SQLITE_EMPTY */ 0,
1432 /* SQLITE_SCHEMA */ "database schema has changed",
1433 /* SQLITE_TOOBIG */ "string or blob too big",
1434 /* SQLITE_CONSTRAINT */ "constraint failed",
1435 /* SQLITE_MISMATCH */ "datatype mismatch",
1436 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
1437 #ifdef SQLITE_DISABLE_LFS
1438 /* SQLITE_NOLFS */ "large file support is disabled",
1440 /* SQLITE_NOLFS */ 0,
1442 /* SQLITE_AUTH */ "authorization denied",
1443 /* SQLITE_FORMAT */ 0,
1444 /* SQLITE_RANGE */ "column index out of range",
1445 /* SQLITE_NOTADB */ "file is not a database",
1446 /* SQLITE_NOTICE */ "notification message",
1447 /* SQLITE_WARNING */ "warning message",
1449 const char *zErr
= "unknown error";
1451 case SQLITE_ABORT_ROLLBACK
: {
1452 zErr
= "abort due to ROLLBACK";
1456 zErr
= "another row available";
1460 zErr
= "no more rows available";
1465 if( ALWAYS(rc
>=0) && rc
<ArraySize(aMsg
) && aMsg
[rc
]!=0 ){
1475 ** This routine implements a busy callback that sleeps and tries
1476 ** again until a timeout value is reached. The timeout value is
1477 ** an integer number of milliseconds passed in as the first
1480 ** Return non-zero to retry the lock. Return zero to stop trying
1481 ** and cause SQLite to return SQLITE_BUSY.
1483 static int sqliteDefaultBusyCallback(
1484 void *ptr
, /* Database connection */
1485 int count
, /* Number of times table has been busy */
1486 sqlite3_file
*pFile
/* The file on which the lock occurred */
1488 #if SQLITE_OS_WIN || HAVE_USLEEP
1489 /* This case is for systems that have support for sleeping for fractions of
1490 ** a second. Examples: All windows systems, unix systems with usleep() */
1491 static const u8 delays
[] =
1492 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1493 static const u8 totals
[] =
1494 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
1495 # define NDELAY ArraySize(delays)
1496 sqlite3
*db
= (sqlite3
*)ptr
;
1497 int tmout
= db
->busyTimeout
;
1500 #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1501 if( sqlite3OsFileControl(pFile
,SQLITE_FCNTL_LOCK_TIMEOUT
,&tmout
)==SQLITE_OK
){
1504 sqlite3OsFileControl(pFile
, SQLITE_FCNTL_LOCK_TIMEOUT
, &tmout
);
1511 UNUSED_PARAMETER(pFile
);
1514 if( count
< NDELAY
){
1515 delay
= delays
[count
];
1516 prior
= totals
[count
];
1518 delay
= delays
[NDELAY
-1];
1519 prior
= totals
[NDELAY
-1] + delay
*(count
-(NDELAY
-1));
1521 if( prior
+ delay
> tmout
){
1522 delay
= tmout
- prior
;
1523 if( delay
<=0 ) return 0;
1525 sqlite3OsSleep(db
->pVfs
, delay
*1000);
1528 /* This case for unix systems that lack usleep() support. Sleeping
1529 ** must be done in increments of whole seconds */
1530 sqlite3
*db
= (sqlite3
*)ptr
;
1531 int tmout
= ((sqlite3
*)ptr
)->busyTimeout
;
1532 UNUSED_PARAMETER(pFile
);
1533 if( (count
+1)*1000 > tmout
){
1536 sqlite3OsSleep(db
->pVfs
, 1000000);
1542 ** Invoke the given busy handler.
1544 ** This routine is called when an operation failed to acquire a
1545 ** lock on VFS file pFile.
1547 ** If this routine returns non-zero, the lock is retried. If it
1548 ** returns 0, the operation aborts with an SQLITE_BUSY error.
1550 int sqlite3InvokeBusyHandler(BusyHandler
*p
, sqlite3_file
*pFile
){
1552 if( p
->xBusyHandler
==0 || p
->nBusy
<0 ) return 0;
1553 if( p
->bExtraFileArg
){
1554 /* Add an extra parameter with the pFile pointer to the end of the
1555 ** callback argument list */
1556 int (*xTra
)(void*,int,sqlite3_file
*);
1557 xTra
= (int(*)(void*,int,sqlite3_file
*))p
->xBusyHandler
;
1558 rc
= xTra(p
->pBusyArg
, p
->nBusy
, pFile
);
1560 /* Legacy style busy handler callback */
1561 rc
= p
->xBusyHandler(p
->pBusyArg
, p
->nBusy
);
1572 ** This routine sets the busy callback for an Sqlite database to the
1573 ** given callback function with the given argument.
1575 int sqlite3_busy_handler(
1577 int (*xBusy
)(void*,int),
1580 #ifdef SQLITE_ENABLE_API_ARMOR
1581 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
1583 sqlite3_mutex_enter(db
->mutex
);
1584 db
->busyHandler
.xBusyHandler
= xBusy
;
1585 db
->busyHandler
.pBusyArg
= pArg
;
1586 db
->busyHandler
.nBusy
= 0;
1587 db
->busyHandler
.bExtraFileArg
= 0;
1588 db
->busyTimeout
= 0;
1589 sqlite3_mutex_leave(db
->mutex
);
1593 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1595 ** This routine sets the progress callback for an Sqlite database to the
1596 ** given callback function with the given argument. The progress callback will
1597 ** be invoked every nOps opcodes.
1599 void sqlite3_progress_handler(
1602 int (*xProgress
)(void*),
1605 #ifdef SQLITE_ENABLE_API_ARMOR
1606 if( !sqlite3SafetyCheckOk(db
) ){
1607 (void)SQLITE_MISUSE_BKPT
;
1611 sqlite3_mutex_enter(db
->mutex
);
1613 db
->xProgress
= xProgress
;
1614 db
->nProgressOps
= (unsigned)nOps
;
1615 db
->pProgressArg
= pArg
;
1618 db
->nProgressOps
= 0;
1619 db
->pProgressArg
= 0;
1621 sqlite3_mutex_leave(db
->mutex
);
1627 ** This routine installs a default busy handler that waits for the
1628 ** specified number of milliseconds before returning 0.
1630 int sqlite3_busy_timeout(sqlite3
*db
, int ms
){
1631 #ifdef SQLITE_ENABLE_API_ARMOR
1632 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
1635 sqlite3_busy_handler(db
, (int(*)(void*,int))sqliteDefaultBusyCallback
,
1637 db
->busyTimeout
= ms
;
1638 db
->busyHandler
.bExtraFileArg
= 1;
1640 sqlite3_busy_handler(db
, 0, 0);
1646 ** Cause any pending operation to stop at its earliest opportunity.
1648 void sqlite3_interrupt(sqlite3
*db
){
1649 #ifdef SQLITE_ENABLE_API_ARMOR
1650 if( !sqlite3SafetyCheckOk(db
) && (db
==0 || db
->magic
!=SQLITE_MAGIC_ZOMBIE
) ){
1651 (void)SQLITE_MISUSE_BKPT
;
1655 db
->u1
.isInterrupted
= 1;
1660 ** This function is exactly the same as sqlite3_create_function(), except
1661 ** that it is designed to be called by internal code. The difference is
1662 ** that if a malloc() fails in sqlite3_create_function(), an error code
1663 ** is returned and the mallocFailed flag cleared.
1665 int sqlite3CreateFunc(
1667 const char *zFunctionName
,
1671 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1672 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1673 void (*xFinal
)(sqlite3_context
*),
1674 FuncDestructor
*pDestructor
1680 assert( sqlite3_mutex_held(db
->mutex
) );
1681 if( zFunctionName
==0 ||
1682 (xSFunc
&& (xFinal
|| xStep
)) ||
1683 (!xSFunc
&& (xFinal
&& !xStep
)) ||
1684 (!xSFunc
&& (!xFinal
&& xStep
)) ||
1685 (nArg
<-1 || nArg
>SQLITE_MAX_FUNCTION_ARG
) ||
1686 (255<(nName
= sqlite3Strlen30( zFunctionName
))) ){
1687 return SQLITE_MISUSE_BKPT
;
1690 assert( SQLITE_FUNC_CONSTANT
==SQLITE_DETERMINISTIC
);
1691 extraFlags
= enc
& SQLITE_DETERMINISTIC
;
1692 enc
&= (SQLITE_FUNC_ENCMASK
|SQLITE_ANY
);
1694 #ifndef SQLITE_OMIT_UTF16
1695 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1696 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1697 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1699 ** If SQLITE_ANY is specified, add three versions of the function
1700 ** to the hash table.
1702 if( enc
==SQLITE_UTF16
){
1703 enc
= SQLITE_UTF16NATIVE
;
1704 }else if( enc
==SQLITE_ANY
){
1706 rc
= sqlite3CreateFunc(db
, zFunctionName
, nArg
, SQLITE_UTF8
|extraFlags
,
1707 pUserData
, xSFunc
, xStep
, xFinal
, pDestructor
);
1708 if( rc
==SQLITE_OK
){
1709 rc
= sqlite3CreateFunc(db
, zFunctionName
, nArg
, SQLITE_UTF16LE
|extraFlags
,
1710 pUserData
, xSFunc
, xStep
, xFinal
, pDestructor
);
1712 if( rc
!=SQLITE_OK
){
1715 enc
= SQLITE_UTF16BE
;
1721 /* Check if an existing function is being overridden or deleted. If so,
1722 ** and there are active VMs, then return SQLITE_BUSY. If a function
1723 ** is being overridden/deleted but there are no active VMs, allow the
1724 ** operation to continue but invalidate all precompiled statements.
1726 p
= sqlite3FindFunction(db
, zFunctionName
, nArg
, (u8
)enc
, 0);
1727 if( p
&& (p
->funcFlags
& SQLITE_FUNC_ENCMASK
)==enc
&& p
->nArg
==nArg
){
1728 if( db
->nVdbeActive
){
1729 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
,
1730 "unable to delete/modify user-function due to active statements");
1731 assert( !db
->mallocFailed
);
1734 sqlite3ExpirePreparedStatements(db
);
1738 p
= sqlite3FindFunction(db
, zFunctionName
, nArg
, (u8
)enc
, 1);
1739 assert(p
|| db
->mallocFailed
);
1741 return SQLITE_NOMEM_BKPT
;
1744 /* If an older version of the function with a configured destructor is
1745 ** being replaced invoke the destructor function here. */
1746 functionDestroy(db
, p
);
1749 pDestructor
->nRef
++;
1751 p
->u
.pDestructor
= pDestructor
;
1752 p
->funcFlags
= (p
->funcFlags
& SQLITE_FUNC_ENCMASK
) | extraFlags
;
1753 testcase( p
->funcFlags
& SQLITE_DETERMINISTIC
);
1754 p
->xSFunc
= xSFunc
? xSFunc
: xStep
;
1755 p
->xFinalize
= xFinal
;
1756 p
->pUserData
= pUserData
;
1757 p
->nArg
= (u16
)nArg
;
1762 ** Create new user functions.
1764 int sqlite3_create_function(
1770 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1771 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1772 void (*xFinal
)(sqlite3_context
*)
1774 return sqlite3_create_function_v2(db
, zFunc
, nArg
, enc
, p
, xSFunc
, xStep
,
1778 int sqlite3_create_function_v2(
1784 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1785 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1786 void (*xFinal
)(sqlite3_context
*),
1787 void (*xDestroy
)(void *)
1789 int rc
= SQLITE_ERROR
;
1790 FuncDestructor
*pArg
= 0;
1792 #ifdef SQLITE_ENABLE_API_ARMOR
1793 if( !sqlite3SafetyCheckOk(db
) ){
1794 return SQLITE_MISUSE_BKPT
;
1797 sqlite3_mutex_enter(db
->mutex
);
1799 pArg
= (FuncDestructor
*)sqlite3DbMallocZero(db
, sizeof(FuncDestructor
));
1804 pArg
->xDestroy
= xDestroy
;
1805 pArg
->pUserData
= p
;
1807 rc
= sqlite3CreateFunc(db
, zFunc
, nArg
, enc
, p
, xSFunc
, xStep
, xFinal
, pArg
);
1808 if( pArg
&& pArg
->nRef
==0 ){
1809 assert( rc
!=SQLITE_OK
);
1811 sqlite3DbFree(db
, pArg
);
1815 rc
= sqlite3ApiExit(db
, rc
);
1816 sqlite3_mutex_leave(db
->mutex
);
1820 #ifndef SQLITE_OMIT_UTF16
1821 int sqlite3_create_function16(
1823 const void *zFunctionName
,
1827 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1828 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1829 void (*xFinal
)(sqlite3_context
*)
1834 #ifdef SQLITE_ENABLE_API_ARMOR
1835 if( !sqlite3SafetyCheckOk(db
) || zFunctionName
==0 ) return SQLITE_MISUSE_BKPT
;
1837 sqlite3_mutex_enter(db
->mutex
);
1838 assert( !db
->mallocFailed
);
1839 zFunc8
= sqlite3Utf16to8(db
, zFunctionName
, -1, SQLITE_UTF16NATIVE
);
1840 rc
= sqlite3CreateFunc(db
, zFunc8
, nArg
, eTextRep
, p
, xSFunc
,xStep
,xFinal
,0);
1841 sqlite3DbFree(db
, zFunc8
);
1842 rc
= sqlite3ApiExit(db
, rc
);
1843 sqlite3_mutex_leave(db
->mutex
);
1850 ** Declare that a function has been overloaded by a virtual table.
1852 ** If the function already exists as a regular global function, then
1853 ** this routine is a no-op. If the function does not exist, then create
1854 ** a new one that always throws a run-time error.
1856 ** When virtual tables intend to provide an overloaded function, they
1857 ** should call this routine to make sure the global function exists.
1858 ** A global function must exist in order for name resolution to work
1861 int sqlite3_overload_function(
1868 #ifdef SQLITE_ENABLE_API_ARMOR
1869 if( !sqlite3SafetyCheckOk(db
) || zName
==0 || nArg
<-2 ){
1870 return SQLITE_MISUSE_BKPT
;
1873 sqlite3_mutex_enter(db
->mutex
);
1874 if( sqlite3FindFunction(db
, zName
, nArg
, SQLITE_UTF8
, 0)==0 ){
1875 rc
= sqlite3CreateFunc(db
, zName
, nArg
, SQLITE_UTF8
,
1876 0, sqlite3InvalidFunction
, 0, 0, 0);
1878 rc
= sqlite3ApiExit(db
, rc
);
1879 sqlite3_mutex_leave(db
->mutex
);
1883 #ifndef SQLITE_OMIT_TRACE
1885 ** Register a trace function. The pArg from the previously registered trace
1888 ** A NULL trace function means that no tracing is executes. A non-NULL
1889 ** trace is a pointer to a function that is invoked at the start of each
1892 #ifndef SQLITE_OMIT_DEPRECATED
1893 void *sqlite3_trace(sqlite3
*db
, void(*xTrace
)(void*,const char*), void *pArg
){
1896 #ifdef SQLITE_ENABLE_API_ARMOR
1897 if( !sqlite3SafetyCheckOk(db
) ){
1898 (void)SQLITE_MISUSE_BKPT
;
1902 sqlite3_mutex_enter(db
->mutex
);
1903 pOld
= db
->pTraceArg
;
1904 db
->mTrace
= xTrace
? SQLITE_TRACE_LEGACY
: 0;
1905 db
->xTrace
= (int(*)(u32
,void*,void*,void*))xTrace
;
1906 db
->pTraceArg
= pArg
;
1907 sqlite3_mutex_leave(db
->mutex
);
1910 #endif /* SQLITE_OMIT_DEPRECATED */
1912 /* Register a trace callback using the version-2 interface.
1914 int sqlite3_trace_v2(
1915 sqlite3
*db
, /* Trace this connection */
1916 unsigned mTrace
, /* Mask of events to be traced */
1917 int(*xTrace
)(unsigned,void*,void*,void*), /* Callback to invoke */
1918 void *pArg
/* Context */
1920 #ifdef SQLITE_ENABLE_API_ARMOR
1921 if( !sqlite3SafetyCheckOk(db
) ){
1922 return SQLITE_MISUSE_BKPT
;
1925 sqlite3_mutex_enter(db
->mutex
);
1926 if( mTrace
==0 ) xTrace
= 0;
1927 if( xTrace
==0 ) mTrace
= 0;
1928 db
->mTrace
= mTrace
;
1929 db
->xTrace
= xTrace
;
1930 db
->pTraceArg
= pArg
;
1931 sqlite3_mutex_leave(db
->mutex
);
1935 #ifndef SQLITE_OMIT_DEPRECATED
1937 ** Register a profile function. The pArg from the previously registered
1938 ** profile function is returned.
1940 ** A NULL profile function means that no profiling is executes. A non-NULL
1941 ** profile is a pointer to a function that is invoked at the conclusion of
1942 ** each SQL statement that is run.
1944 void *sqlite3_profile(
1946 void (*xProfile
)(void*,const char*,sqlite_uint64
),
1951 #ifdef SQLITE_ENABLE_API_ARMOR
1952 if( !sqlite3SafetyCheckOk(db
) ){
1953 (void)SQLITE_MISUSE_BKPT
;
1957 sqlite3_mutex_enter(db
->mutex
);
1958 pOld
= db
->pProfileArg
;
1959 db
->xProfile
= xProfile
;
1960 db
->pProfileArg
= pArg
;
1961 sqlite3_mutex_leave(db
->mutex
);
1964 #endif /* SQLITE_OMIT_DEPRECATED */
1965 #endif /* SQLITE_OMIT_TRACE */
1968 ** Register a function to be invoked when a transaction commits.
1969 ** If the invoked function returns non-zero, then the commit becomes a
1972 void *sqlite3_commit_hook(
1973 sqlite3
*db
, /* Attach the hook to this database */
1974 int (*xCallback
)(void*), /* Function to invoke on each commit */
1975 void *pArg
/* Argument to the function */
1979 #ifdef SQLITE_ENABLE_API_ARMOR
1980 if( !sqlite3SafetyCheckOk(db
) ){
1981 (void)SQLITE_MISUSE_BKPT
;
1985 sqlite3_mutex_enter(db
->mutex
);
1986 pOld
= db
->pCommitArg
;
1987 db
->xCommitCallback
= xCallback
;
1988 db
->pCommitArg
= pArg
;
1989 sqlite3_mutex_leave(db
->mutex
);
1994 ** Register a callback to be invoked each time a row is updated,
1995 ** inserted or deleted using this database connection.
1997 void *sqlite3_update_hook(
1998 sqlite3
*db
, /* Attach the hook to this database */
1999 void (*xCallback
)(void*,int,char const *,char const *,sqlite_int64
),
2000 void *pArg
/* Argument to the function */
2004 #ifdef SQLITE_ENABLE_API_ARMOR
2005 if( !sqlite3SafetyCheckOk(db
) ){
2006 (void)SQLITE_MISUSE_BKPT
;
2010 sqlite3_mutex_enter(db
->mutex
);
2011 pRet
= db
->pUpdateArg
;
2012 db
->xUpdateCallback
= xCallback
;
2013 db
->pUpdateArg
= pArg
;
2014 sqlite3_mutex_leave(db
->mutex
);
2019 ** Register a callback to be invoked each time a transaction is rolled
2020 ** back by this database connection.
2022 void *sqlite3_rollback_hook(
2023 sqlite3
*db
, /* Attach the hook to this database */
2024 void (*xCallback
)(void*), /* Callback function */
2025 void *pArg
/* Argument to the function */
2029 #ifdef SQLITE_ENABLE_API_ARMOR
2030 if( !sqlite3SafetyCheckOk(db
) ){
2031 (void)SQLITE_MISUSE_BKPT
;
2035 sqlite3_mutex_enter(db
->mutex
);
2036 pRet
= db
->pRollbackArg
;
2037 db
->xRollbackCallback
= xCallback
;
2038 db
->pRollbackArg
= pArg
;
2039 sqlite3_mutex_leave(db
->mutex
);
2043 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
2045 ** Register a callback to be invoked each time a row is updated,
2046 ** inserted or deleted using this database connection.
2048 void *sqlite3_preupdate_hook(
2049 sqlite3
*db
, /* Attach the hook to this database */
2050 void(*xCallback
)( /* Callback function */
2051 void*,sqlite3
*,int,char const*,char const*,sqlite3_int64
,sqlite3_int64
),
2052 void *pArg
/* First callback argument */
2055 sqlite3_mutex_enter(db
->mutex
);
2056 pRet
= db
->pPreUpdateArg
;
2057 db
->xPreUpdateCallback
= xCallback
;
2058 db
->pPreUpdateArg
= pArg
;
2059 sqlite3_mutex_leave(db
->mutex
);
2062 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
2064 #ifndef SQLITE_OMIT_WAL
2066 ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
2067 ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2068 ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
2069 ** wal_autocheckpoint()).
2071 int sqlite3WalDefaultHook(
2072 void *pClientData
, /* Argument */
2073 sqlite3
*db
, /* Connection */
2074 const char *zDb
, /* Database */
2075 int nFrame
/* Size of WAL */
2077 if( nFrame
>=SQLITE_PTR_TO_INT(pClientData
) ){
2078 sqlite3BeginBenignMalloc();
2079 sqlite3_wal_checkpoint(db
, zDb
);
2080 sqlite3EndBenignMalloc();
2084 #endif /* SQLITE_OMIT_WAL */
2087 ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2088 ** a database after committing a transaction if there are nFrame or
2089 ** more frames in the log file. Passing zero or a negative value as the
2090 ** nFrame parameter disables automatic checkpoints entirely.
2092 ** The callback registered by this function replaces any existing callback
2093 ** registered using sqlite3_wal_hook(). Likewise, registering a callback
2094 ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2095 ** configured by this function.
2097 int sqlite3_wal_autocheckpoint(sqlite3
*db
, int nFrame
){
2098 #ifdef SQLITE_OMIT_WAL
2099 UNUSED_PARAMETER(db
);
2100 UNUSED_PARAMETER(nFrame
);
2102 #ifdef SQLITE_ENABLE_API_ARMOR
2103 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
2106 sqlite3_wal_hook(db
, sqlite3WalDefaultHook
, SQLITE_INT_TO_PTR(nFrame
));
2108 sqlite3_wal_hook(db
, 0, 0);
2115 ** Register a callback to be invoked each time a transaction is written
2116 ** into the write-ahead-log by this database connection.
2118 void *sqlite3_wal_hook(
2119 sqlite3
*db
, /* Attach the hook to this db handle */
2120 int(*xCallback
)(void *, sqlite3
*, const char*, int),
2121 void *pArg
/* First argument passed to xCallback() */
2123 #ifndef SQLITE_OMIT_WAL
2125 #ifdef SQLITE_ENABLE_API_ARMOR
2126 if( !sqlite3SafetyCheckOk(db
) ){
2127 (void)SQLITE_MISUSE_BKPT
;
2131 sqlite3_mutex_enter(db
->mutex
);
2133 db
->xWalCallback
= xCallback
;
2135 sqlite3_mutex_leave(db
->mutex
);
2143 ** Checkpoint database zDb.
2145 int sqlite3_wal_checkpoint_v2(
2146 sqlite3
*db
, /* Database handle */
2147 const char *zDb
, /* Name of attached database (or NULL) */
2148 int eMode
, /* SQLITE_CHECKPOINT_* value */
2149 int *pnLog
, /* OUT: Size of WAL log in frames */
2150 int *pnCkpt
/* OUT: Total number of frames checkpointed */
2152 #ifdef SQLITE_OMIT_WAL
2155 int rc
; /* Return code */
2156 int iDb
= SQLITE_MAX_ATTACHED
; /* sqlite3.aDb[] index of db to checkpoint */
2158 #ifdef SQLITE_ENABLE_API_ARMOR
2159 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
2162 /* Initialize the output variables to -1 in case an error occurs. */
2163 if( pnLog
) *pnLog
= -1;
2164 if( pnCkpt
) *pnCkpt
= -1;
2166 assert( SQLITE_CHECKPOINT_PASSIVE
==0 );
2167 assert( SQLITE_CHECKPOINT_FULL
==1 );
2168 assert( SQLITE_CHECKPOINT_RESTART
==2 );
2169 assert( SQLITE_CHECKPOINT_TRUNCATE
==3 );
2170 if( eMode
<SQLITE_CHECKPOINT_PASSIVE
|| eMode
>SQLITE_CHECKPOINT_TRUNCATE
){
2171 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2173 return SQLITE_MISUSE
;
2176 sqlite3_mutex_enter(db
->mutex
);
2177 if( zDb
&& zDb
[0] ){
2178 iDb
= sqlite3FindDbName(db
, zDb
);
2182 sqlite3ErrorWithMsg(db
, SQLITE_ERROR
, "unknown database: %s", zDb
);
2184 db
->busyHandler
.nBusy
= 0;
2185 rc
= sqlite3Checkpoint(db
, iDb
, eMode
, pnLog
, pnCkpt
);
2186 sqlite3Error(db
, rc
);
2188 rc
= sqlite3ApiExit(db
, rc
);
2190 /* If there are no active statements, clear the interrupt flag at this
2192 if( db
->nVdbeActive
==0 ){
2193 db
->u1
.isInterrupted
= 0;
2196 sqlite3_mutex_leave(db
->mutex
);
2203 ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2204 ** to contains a zero-length string, all attached databases are
2207 int sqlite3_wal_checkpoint(sqlite3
*db
, const char *zDb
){
2208 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2209 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2210 return sqlite3_wal_checkpoint_v2(db
,zDb
,SQLITE_CHECKPOINT_PASSIVE
,0,0);
2213 #ifndef SQLITE_OMIT_WAL
2215 ** Run a checkpoint on database iDb. This is a no-op if database iDb is
2216 ** not currently open in WAL mode.
2218 ** If a transaction is open on the database being checkpointed, this
2219 ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2220 ** an error occurs while running the checkpoint, an SQLite error code is
2221 ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
2223 ** The mutex on database handle db should be held by the caller. The mutex
2224 ** associated with the specific b-tree being checkpointed is taken by
2225 ** this function while the checkpoint is running.
2227 ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2228 ** checkpointed. If an error is encountered it is returned immediately -
2229 ** no attempt is made to checkpoint any remaining databases.
2231 ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2234 int sqlite3Checkpoint(sqlite3
*db
, int iDb
, int eMode
, int *pnLog
, int *pnCkpt
){
2235 int rc
= SQLITE_OK
; /* Return code */
2236 int i
; /* Used to iterate through attached dbs */
2237 int bBusy
= 0; /* True if SQLITE_BUSY has been encountered */
2239 assert( sqlite3_mutex_held(db
->mutex
) );
2240 assert( !pnLog
|| *pnLog
==-1 );
2241 assert( !pnCkpt
|| *pnCkpt
==-1 );
2243 for(i
=0; i
<db
->nDb
&& rc
==SQLITE_OK
; i
++){
2244 if( i
==iDb
|| iDb
==SQLITE_MAX_ATTACHED
){
2245 rc
= sqlite3BtreeCheckpoint(db
->aDb
[i
].pBt
, eMode
, pnLog
, pnCkpt
);
2248 if( rc
==SQLITE_BUSY
){
2255 return (rc
==SQLITE_OK
&& bBusy
) ? SQLITE_BUSY
: rc
;
2257 #endif /* SQLITE_OMIT_WAL */
2260 ** This function returns true if main-memory should be used instead of
2261 ** a temporary file for transient pager files and statement journals.
2262 ** The value returned depends on the value of db->temp_store (runtime
2263 ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2264 ** following table describes the relationship between these two values
2265 ** and this functions return value.
2267 ** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2268 ** ----------------- -------------- ------------------------------
2269 ** 0 any file (return 0)
2270 ** 1 1 file (return 0)
2271 ** 1 2 memory (return 1)
2272 ** 1 0 file (return 0)
2273 ** 2 1 file (return 0)
2274 ** 2 2 memory (return 1)
2275 ** 2 0 memory (return 1)
2276 ** 3 any memory (return 1)
2278 int sqlite3TempInMemory(const sqlite3
*db
){
2279 #if SQLITE_TEMP_STORE==1
2280 return ( db
->temp_store
==2 );
2282 #if SQLITE_TEMP_STORE==2
2283 return ( db
->temp_store
!=1 );
2285 #if SQLITE_TEMP_STORE==3
2286 UNUSED_PARAMETER(db
);
2289 #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
2290 UNUSED_PARAMETER(db
);
2296 ** Return UTF-8 encoded English language explanation of the most recent
2299 const char *sqlite3_errmsg(sqlite3
*db
){
2302 return sqlite3ErrStr(SQLITE_NOMEM_BKPT
);
2304 if( !sqlite3SafetyCheckSickOrOk(db
) ){
2305 return sqlite3ErrStr(SQLITE_MISUSE_BKPT
);
2307 sqlite3_mutex_enter(db
->mutex
);
2308 if( db
->mallocFailed
){
2309 z
= sqlite3ErrStr(SQLITE_NOMEM_BKPT
);
2311 testcase( db
->pErr
==0 );
2312 z
= (char*)sqlite3_value_text(db
->pErr
);
2313 assert( !db
->mallocFailed
);
2315 z
= sqlite3ErrStr(db
->errCode
);
2318 sqlite3_mutex_leave(db
->mutex
);
2322 #ifndef SQLITE_OMIT_UTF16
2324 ** Return UTF-16 encoded English language explanation of the most recent
2327 const void *sqlite3_errmsg16(sqlite3
*db
){
2328 static const u16 outOfMem
[] = {
2329 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
2331 static const u16 misuse
[] = {
2332 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2333 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2334 'm', 'i', 's', 'u', 's', 'e', 0
2339 return (void *)outOfMem
;
2341 if( !sqlite3SafetyCheckSickOrOk(db
) ){
2342 return (void *)misuse
;
2344 sqlite3_mutex_enter(db
->mutex
);
2345 if( db
->mallocFailed
){
2346 z
= (void *)outOfMem
;
2348 z
= sqlite3_value_text16(db
->pErr
);
2350 sqlite3ErrorWithMsg(db
, db
->errCode
, sqlite3ErrStr(db
->errCode
));
2351 z
= sqlite3_value_text16(db
->pErr
);
2353 /* A malloc() may have failed within the call to sqlite3_value_text16()
2354 ** above. If this is the case, then the db->mallocFailed flag needs to
2355 ** be cleared before returning. Do this directly, instead of via
2356 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2358 sqlite3OomClear(db
);
2360 sqlite3_mutex_leave(db
->mutex
);
2363 #endif /* SQLITE_OMIT_UTF16 */
2366 ** Return the most recent error code generated by an SQLite routine. If NULL is
2367 ** passed to this function, we assume a malloc() failed during sqlite3_open().
2369 int sqlite3_errcode(sqlite3
*db
){
2370 if( db
&& !sqlite3SafetyCheckSickOrOk(db
) ){
2371 return SQLITE_MISUSE_BKPT
;
2373 if( !db
|| db
->mallocFailed
){
2374 return SQLITE_NOMEM_BKPT
;
2376 return db
->errCode
& db
->errMask
;
2378 int sqlite3_extended_errcode(sqlite3
*db
){
2379 if( db
&& !sqlite3SafetyCheckSickOrOk(db
) ){
2380 return SQLITE_MISUSE_BKPT
;
2382 if( !db
|| db
->mallocFailed
){
2383 return SQLITE_NOMEM_BKPT
;
2387 int sqlite3_system_errno(sqlite3
*db
){
2388 return db
? db
->iSysErrno
: 0;
2392 ** Return a string that describes the kind of error specified in the
2393 ** argument. For now, this simply calls the internal sqlite3ErrStr()
2396 const char *sqlite3_errstr(int rc
){
2397 return sqlite3ErrStr(rc
);
2401 ** Create a new collating function for database "db". The name is zName
2402 ** and the encoding is enc.
2404 static int createCollation(
2409 int(*xCompare
)(void*,int,const void*,int,const void*),
2415 assert( sqlite3_mutex_held(db
->mutex
) );
2417 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2418 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2419 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2422 testcase( enc2
==SQLITE_UTF16
);
2423 testcase( enc2
==SQLITE_UTF16_ALIGNED
);
2424 if( enc2
==SQLITE_UTF16
|| enc2
==SQLITE_UTF16_ALIGNED
){
2425 enc2
= SQLITE_UTF16NATIVE
;
2427 if( enc2
<SQLITE_UTF8
|| enc2
>SQLITE_UTF16BE
){
2428 return SQLITE_MISUSE_BKPT
;
2431 /* Check if this call is removing or replacing an existing collation
2432 ** sequence. If so, and there are active VMs, return busy. If there
2433 ** are no active VMs, invalidate any pre-compiled statements.
2435 pColl
= sqlite3FindCollSeq(db
, (u8
)enc2
, zName
, 0);
2436 if( pColl
&& pColl
->xCmp
){
2437 if( db
->nVdbeActive
){
2438 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
,
2439 "unable to delete/modify collation sequence due to active statements");
2442 sqlite3ExpirePreparedStatements(db
);
2444 /* If collation sequence pColl was created directly by a call to
2445 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2446 ** then any copies made by synthCollSeq() need to be invalidated.
2447 ** Also, collation destructor - CollSeq.xDel() - function may need
2450 if( (pColl
->enc
& ~SQLITE_UTF16_ALIGNED
)==enc2
){
2451 CollSeq
*aColl
= sqlite3HashFind(&db
->aCollSeq
, zName
);
2454 CollSeq
*p
= &aColl
[j
];
2455 if( p
->enc
==pColl
->enc
){
2465 pColl
= sqlite3FindCollSeq(db
, (u8
)enc2
, zName
, 1);
2466 if( pColl
==0 ) return SQLITE_NOMEM_BKPT
;
2467 pColl
->xCmp
= xCompare
;
2468 pColl
->pUser
= pCtx
;
2470 pColl
->enc
= (u8
)(enc2
| (enc
& SQLITE_UTF16_ALIGNED
));
2471 sqlite3Error(db
, SQLITE_OK
);
2477 ** This array defines hard upper bounds on limit values. The
2478 ** initializer must be kept in sync with the SQLITE_LIMIT_*
2479 ** #defines in sqlite3.h.
2481 static const int aHardLimit
[] = {
2483 SQLITE_MAX_SQL_LENGTH
,
2485 SQLITE_MAX_EXPR_DEPTH
,
2486 SQLITE_MAX_COMPOUND_SELECT
,
2488 SQLITE_MAX_FUNCTION_ARG
,
2489 SQLITE_MAX_ATTACHED
,
2490 SQLITE_MAX_LIKE_PATTERN_LENGTH
,
2491 SQLITE_MAX_VARIABLE_NUMBER
, /* IMP: R-38091-32352 */
2492 SQLITE_MAX_TRIGGER_DEPTH
,
2493 SQLITE_MAX_WORKER_THREADS
,
2497 ** Make sure the hard limits are set to reasonable values
2499 #if SQLITE_MAX_LENGTH<100
2500 # error SQLITE_MAX_LENGTH must be at least 100
2502 #if SQLITE_MAX_SQL_LENGTH<100
2503 # error SQLITE_MAX_SQL_LENGTH must be at least 100
2505 #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2506 # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2508 #if SQLITE_MAX_COMPOUND_SELECT<2
2509 # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2511 #if SQLITE_MAX_VDBE_OP<40
2512 # error SQLITE_MAX_VDBE_OP must be at least 40
2514 #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2515 # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
2517 #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2518 # error SQLITE_MAX_ATTACHED must be between 0 and 125
2520 #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2521 # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2523 #if SQLITE_MAX_COLUMN>32767
2524 # error SQLITE_MAX_COLUMN must not exceed 32767
2526 #if SQLITE_MAX_TRIGGER_DEPTH<1
2527 # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2529 #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2530 # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2535 ** Change the value of a limit. Report the old value.
2536 ** If an invalid limit index is supplied, report -1.
2537 ** Make no changes but still report the old value if the
2538 ** new limit is negative.
2540 ** A new lower limit does not shrink existing constructs.
2541 ** It merely prevents new constructs that exceed the limit
2544 int sqlite3_limit(sqlite3
*db
, int limitId
, int newLimit
){
2547 #ifdef SQLITE_ENABLE_API_ARMOR
2548 if( !sqlite3SafetyCheckOk(db
) ){
2549 (void)SQLITE_MISUSE_BKPT
;
2554 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2555 ** there is a hard upper bound set at compile-time by a C preprocessor
2556 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2559 assert( aHardLimit
[SQLITE_LIMIT_LENGTH
]==SQLITE_MAX_LENGTH
);
2560 assert( aHardLimit
[SQLITE_LIMIT_SQL_LENGTH
]==SQLITE_MAX_SQL_LENGTH
);
2561 assert( aHardLimit
[SQLITE_LIMIT_COLUMN
]==SQLITE_MAX_COLUMN
);
2562 assert( aHardLimit
[SQLITE_LIMIT_EXPR_DEPTH
]==SQLITE_MAX_EXPR_DEPTH
);
2563 assert( aHardLimit
[SQLITE_LIMIT_COMPOUND_SELECT
]==SQLITE_MAX_COMPOUND_SELECT
);
2564 assert( aHardLimit
[SQLITE_LIMIT_VDBE_OP
]==SQLITE_MAX_VDBE_OP
);
2565 assert( aHardLimit
[SQLITE_LIMIT_FUNCTION_ARG
]==SQLITE_MAX_FUNCTION_ARG
);
2566 assert( aHardLimit
[SQLITE_LIMIT_ATTACHED
]==SQLITE_MAX_ATTACHED
);
2567 assert( aHardLimit
[SQLITE_LIMIT_LIKE_PATTERN_LENGTH
]==
2568 SQLITE_MAX_LIKE_PATTERN_LENGTH
);
2569 assert( aHardLimit
[SQLITE_LIMIT_VARIABLE_NUMBER
]==SQLITE_MAX_VARIABLE_NUMBER
);
2570 assert( aHardLimit
[SQLITE_LIMIT_TRIGGER_DEPTH
]==SQLITE_MAX_TRIGGER_DEPTH
);
2571 assert( aHardLimit
[SQLITE_LIMIT_WORKER_THREADS
]==SQLITE_MAX_WORKER_THREADS
);
2572 assert( SQLITE_LIMIT_WORKER_THREADS
==(SQLITE_N_LIMIT
-1) );
2575 if( limitId
<0 || limitId
>=SQLITE_N_LIMIT
){
2578 oldLimit
= db
->aLimit
[limitId
];
2579 if( newLimit
>=0 ){ /* IMP: R-52476-28732 */
2580 if( newLimit
>aHardLimit
[limitId
] ){
2581 newLimit
= aHardLimit
[limitId
]; /* IMP: R-51463-25634 */
2583 db
->aLimit
[limitId
] = newLimit
;
2585 return oldLimit
; /* IMP: R-53341-35419 */
2589 ** This function is used to parse both URIs and non-URI filenames passed by the
2590 ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2591 ** URIs specified as part of ATTACH statements.
2593 ** The first argument to this function is the name of the VFS to use (or
2594 ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2595 ** query parameter. The second argument contains the URI (or non-URI filename)
2596 ** itself. When this function is called the *pFlags variable should contain
2597 ** the default flags to open the database handle with. The value stored in
2598 ** *pFlags may be updated before returning if the URI filename contains
2599 ** "cache=xxx" or "mode=xxx" query parameters.
2601 ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2602 ** the VFS that should be used to open the database file. *pzFile is set to
2603 ** point to a buffer containing the name of the file to open. It is the
2604 ** responsibility of the caller to eventually call sqlite3_free() to release
2607 ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2608 ** may be set to point to a buffer containing an English language error
2609 ** message. It is the responsibility of the caller to eventually release
2610 ** this buffer by calling sqlite3_free().
2612 int sqlite3ParseUri(
2613 const char *zDefaultVfs
, /* VFS to use if no "vfs=xxx" query option */
2614 const char *zUri
, /* Nul-terminated URI to parse */
2615 unsigned int *pFlags
, /* IN/OUT: SQLITE_OPEN_XXX flags */
2616 sqlite3_vfs
**ppVfs
, /* OUT: VFS to use */
2617 char **pzFile
, /* OUT: Filename component of URI */
2618 char **pzErrMsg
/* OUT: Error message (if rc!=SQLITE_OK) */
2621 unsigned int flags
= *pFlags
;
2622 const char *zVfs
= zDefaultVfs
;
2625 int nUri
= sqlite3Strlen30(zUri
);
2627 assert( *pzErrMsg
==0 );
2629 if( ((flags
& SQLITE_OPEN_URI
) /* IMP: R-48725-32206 */
2630 || sqlite3GlobalConfig
.bOpenUri
) /* IMP: R-51689-46548 */
2631 && nUri
>=5 && memcmp(zUri
, "file:", 5)==0 /* IMP: R-57884-37496 */
2634 int eState
; /* Parser state when parsing URI */
2635 int iIn
; /* Input character index */
2636 int iOut
= 0; /* Output character index */
2637 u64 nByte
= nUri
+2; /* Bytes of space to allocate */
2639 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2640 ** method that there may be extra parameters following the file-name. */
2641 flags
|= SQLITE_OPEN_URI
;
2643 for(iIn
=0; iIn
<nUri
; iIn
++) nByte
+= (zUri
[iIn
]=='&');
2644 zFile
= sqlite3_malloc64(nByte
);
2645 if( !zFile
) return SQLITE_NOMEM_BKPT
;
2648 #ifdef SQLITE_ALLOW_URI_AUTHORITY
2649 if( strncmp(zUri
+5, "///", 3)==0 ){
2651 /* The following condition causes URIs with five leading / characters
2652 ** like file://///host/path to be converted into UNCs like //host/path.
2653 ** The correct URI for that UNC has only two or four leading / characters
2654 ** file://host/path or file:////host/path. But 5 leading slashes is a
2655 ** common error, we are told, so we handle it as a special case. */
2656 if( strncmp(zUri
+7, "///", 3)==0 ){ iIn
++; }
2657 }else if( strncmp(zUri
+5, "//localhost/", 12)==0 ){
2661 /* Discard the scheme and authority segments of the URI. */
2662 if( zUri
[5]=='/' && zUri
[6]=='/' ){
2664 while( zUri
[iIn
] && zUri
[iIn
]!='/' ) iIn
++;
2665 if( iIn
!=7 && (iIn
!=16 || memcmp("localhost", &zUri
[7], 9)) ){
2666 *pzErrMsg
= sqlite3_mprintf("invalid uri authority: %.*s",
2674 /* Copy the filename and any query parameters into the zFile buffer.
2675 ** Decode %HH escape codes along the way.
2677 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2678 ** on the parsing context. As follows:
2680 ** 0: Parsing file-name.
2681 ** 1: Parsing name section of a name=value query parameter.
2682 ** 2: Parsing value section of a name=value query parameter.
2685 while( (c
= zUri
[iIn
])!=0 && c
!='#' ){
2688 && sqlite3Isxdigit(zUri
[iIn
])
2689 && sqlite3Isxdigit(zUri
[iIn
+1])
2691 int octet
= (sqlite3HexToInt(zUri
[iIn
++]) << 4);
2692 octet
+= sqlite3HexToInt(zUri
[iIn
++]);
2694 assert( octet
>=0 && octet
<256 );
2696 #ifndef SQLITE_ENABLE_URI_00_ERROR
2697 /* This branch is taken when "%00" appears within the URI. In this
2698 ** case we ignore all text in the remainder of the path, name or
2699 ** value currently being parsed. So ignore the current character
2700 ** and skip to the next "?", "=" or "&", as appropriate. */
2701 while( (c
= zUri
[iIn
])!=0 && c
!='#'
2702 && (eState
!=0 || c
!='?')
2703 && (eState
!=1 || (c
!='=' && c
!='&'))
2704 && (eState
!=2 || c
!='&')
2710 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2711 *pzErrMsg
= sqlite3_mprintf("unexpected %%00 in uri");
2717 }else if( eState
==1 && (c
=='&' || c
=='=') ){
2718 if( zFile
[iOut
-1]==0 ){
2719 /* An empty option name. Ignore this option altogether. */
2720 while( zUri
[iIn
] && zUri
[iIn
]!='#' && zUri
[iIn
-1]!='&' ) iIn
++;
2724 zFile
[iOut
++] = '\0';
2729 }else if( (eState
==0 && c
=='?') || (eState
==2 && c
=='&') ){
2735 if( eState
==1 ) zFile
[iOut
++] = '\0';
2736 zFile
[iOut
++] = '\0';
2737 zFile
[iOut
++] = '\0';
2739 /* Check if there were any options specified that should be interpreted
2740 ** here. Options that are interpreted here include "vfs" and those that
2741 ** correspond to flags that may be passed to the sqlite3_open_v2()
2743 zOpt
= &zFile
[sqlite3Strlen30(zFile
)+1];
2745 int nOpt
= sqlite3Strlen30(zOpt
);
2746 char *zVal
= &zOpt
[nOpt
+1];
2747 int nVal
= sqlite3Strlen30(zVal
);
2749 if( nOpt
==3 && memcmp("vfs", zOpt
, 3)==0 ){
2756 char *zModeType
= 0;
2760 if( nOpt
==5 && memcmp("cache", zOpt
, 5)==0 ){
2761 static struct OpenMode aCacheMode
[] = {
2762 { "shared", SQLITE_OPEN_SHAREDCACHE
},
2763 { "private", SQLITE_OPEN_PRIVATECACHE
},
2767 mask
= SQLITE_OPEN_SHAREDCACHE
|SQLITE_OPEN_PRIVATECACHE
;
2770 zModeType
= "cache";
2772 if( nOpt
==4 && memcmp("mode", zOpt
, 4)==0 ){
2773 static struct OpenMode aOpenMode
[] = {
2774 { "ro", SQLITE_OPEN_READONLY
},
2775 { "rw", SQLITE_OPEN_READWRITE
},
2776 { "rwc", SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
},
2777 { "memory", SQLITE_OPEN_MEMORY
},
2781 mask
= SQLITE_OPEN_READONLY
| SQLITE_OPEN_READWRITE
2782 | SQLITE_OPEN_CREATE
| SQLITE_OPEN_MEMORY
;
2784 limit
= mask
& flags
;
2785 zModeType
= "access";
2791 for(i
=0; aMode
[i
].z
; i
++){
2792 const char *z
= aMode
[i
].z
;
2793 if( nVal
==sqlite3Strlen30(z
) && 0==memcmp(zVal
, z
, nVal
) ){
2794 mode
= aMode
[i
].mode
;
2799 *pzErrMsg
= sqlite3_mprintf("no such %s mode: %s", zModeType
, zVal
);
2803 if( (mode
& ~SQLITE_OPEN_MEMORY
)>limit
){
2804 *pzErrMsg
= sqlite3_mprintf("%s mode not allowed: %s",
2809 flags
= (flags
& ~mask
) | mode
;
2813 zOpt
= &zVal
[nVal
+1];
2817 zFile
= sqlite3_malloc64(nUri
+2);
2818 if( !zFile
) return SQLITE_NOMEM_BKPT
;
2820 memcpy(zFile
, zUri
, nUri
);
2823 zFile
[nUri
+1] = '\0';
2824 flags
&= ~SQLITE_OPEN_URI
;
2827 *ppVfs
= sqlite3_vfs_find(zVfs
);
2829 *pzErrMsg
= sqlite3_mprintf("no such vfs: %s", zVfs
);
2833 if( rc
!=SQLITE_OK
){
2834 sqlite3_free(zFile
);
2844 ** This routine does the work of opening a database on behalf of
2845 ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
2846 ** is UTF-8 encoded.
2848 static int openDatabase(
2849 const char *zFilename
, /* Database filename UTF-8 encoded */
2850 sqlite3
**ppDb
, /* OUT: Returned database handle */
2851 unsigned int flags
, /* Operational flags */
2852 const char *zVfs
/* Name of the VFS to use */
2854 sqlite3
*db
; /* Store allocated handle here */
2855 int rc
; /* Return code */
2856 int isThreadsafe
; /* True for threadsafe connections */
2857 char *zOpen
= 0; /* Filename argument to pass to BtreeOpen() */
2858 char *zErrMsg
= 0; /* Error message from sqlite3ParseUri() */
2860 #ifdef SQLITE_ENABLE_API_ARMOR
2861 if( ppDb
==0 ) return SQLITE_MISUSE_BKPT
;
2864 #ifndef SQLITE_OMIT_AUTOINIT
2865 rc
= sqlite3_initialize();
2869 if( sqlite3GlobalConfig
.bCoreMutex
==0 ){
2871 }else if( flags
& SQLITE_OPEN_NOMUTEX
){
2873 }else if( flags
& SQLITE_OPEN_FULLMUTEX
){
2876 isThreadsafe
= sqlite3GlobalConfig
.bFullMutex
;
2879 if( flags
& SQLITE_OPEN_PRIVATECACHE
){
2880 flags
&= ~SQLITE_OPEN_SHAREDCACHE
;
2881 }else if( sqlite3GlobalConfig
.sharedCacheEnabled
){
2882 flags
|= SQLITE_OPEN_SHAREDCACHE
;
2885 /* Remove harmful bits from the flags parameter
2887 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2888 ** dealt with in the previous code block. Besides these, the only
2889 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
2890 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2891 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
2892 ** off all other flags.
2894 flags
&= ~( SQLITE_OPEN_DELETEONCLOSE
|
2895 SQLITE_OPEN_EXCLUSIVE
|
2896 SQLITE_OPEN_MAIN_DB
|
2897 SQLITE_OPEN_TEMP_DB
|
2898 SQLITE_OPEN_TRANSIENT_DB
|
2899 SQLITE_OPEN_MAIN_JOURNAL
|
2900 SQLITE_OPEN_TEMP_JOURNAL
|
2901 SQLITE_OPEN_SUBJOURNAL
|
2902 SQLITE_OPEN_MASTER_JOURNAL
|
2903 SQLITE_OPEN_NOMUTEX
|
2904 SQLITE_OPEN_FULLMUTEX
|
2908 /* Allocate the sqlite data structure */
2909 db
= sqlite3MallocZero( sizeof(sqlite3
) );
2910 if( db
==0 ) goto opendb_out
;
2912 #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
2913 || sqlite3GlobalConfig
.bCoreMutex
2916 db
->mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE
);
2922 if( isThreadsafe
==0 ){
2923 sqlite3MutexWarnOnContention(db
->mutex
);
2926 sqlite3_mutex_enter(db
->mutex
);
2929 db
->magic
= SQLITE_MAGIC_BUSY
;
2930 db
->aDb
= db
->aDbStatic
;
2932 assert( sizeof(db
->aLimit
)==sizeof(aHardLimit
) );
2933 memcpy(db
->aLimit
, aHardLimit
, sizeof(db
->aLimit
));
2934 db
->aLimit
[SQLITE_LIMIT_WORKER_THREADS
] = SQLITE_DEFAULT_WORKER_THREADS
;
2936 db
->nextAutovac
= -1;
2937 db
->szMmap
= sqlite3GlobalConfig
.szMmap
;
2938 db
->nextPagesize
= 0;
2939 db
->nMaxSorterMmap
= 0x7FFFFFFF;
2940 db
->flags
|= SQLITE_ShortColNames
| SQLITE_EnableTrigger
| SQLITE_CacheSpill
2941 #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
2944 #if SQLITE_DEFAULT_CKPTFULLFSYNC
2945 | SQLITE_CkptFullFSync
2947 #if SQLITE_DEFAULT_FILE_FORMAT<4
2948 | SQLITE_LegacyFileFmt
2950 #ifdef SQLITE_ENABLE_LOAD_EXTENSION
2951 | SQLITE_LoadExtension
2953 #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
2954 | SQLITE_RecTriggers
2956 #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
2957 | SQLITE_ForeignKeys
2959 #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
2960 | SQLITE_ReverseOrder
2962 #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
2965 #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
2966 | SQLITE_Fts3Tokenizer
2968 #if defined(SQLITE_ENABLE_QPSG)
2972 sqlite3HashInit(&db
->aCollSeq
);
2973 #ifndef SQLITE_OMIT_VIRTUALTABLE
2974 sqlite3HashInit(&db
->aModule
);
2977 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
2978 ** and UTF-16, so add a version for each to avoid any unnecessary
2979 ** conversions. The only error that can occur here is a malloc() failure.
2981 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
2984 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF8
, 0, binCollFunc
, 0);
2985 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF16BE
, 0, binCollFunc
, 0);
2986 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF16LE
, 0, binCollFunc
, 0);
2987 createCollation(db
, "NOCASE", SQLITE_UTF8
, 0, nocaseCollatingFunc
, 0);
2988 createCollation(db
, "RTRIM", SQLITE_UTF8
, (void*)1, binCollFunc
, 0);
2989 if( db
->mallocFailed
){
2992 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
2993 ** strings is BINARY.
2995 db
->pDfltColl
= sqlite3FindCollSeq(db
, SQLITE_UTF8
, sqlite3StrBINARY
, 0);
2996 assert( db
->pDfltColl
!=0 );
2998 /* Parse the filename/URI argument
3000 ** Only allow sensible combinations of bits in the flags argument.
3001 ** Throw an error if any non-sense combination is used. If we
3002 ** do not block illegal combinations here, it could trigger
3003 ** assert() statements in deeper layers. Sensible combinations
3006 ** 1: SQLITE_OPEN_READONLY
3007 ** 2: SQLITE_OPEN_READWRITE
3008 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3010 db
->openFlags
= flags
;
3011 assert( SQLITE_OPEN_READONLY
== 0x01 );
3012 assert( SQLITE_OPEN_READWRITE
== 0x02 );
3013 assert( SQLITE_OPEN_CREATE
== 0x04 );
3014 testcase( (1<<(flags
&7))==0x02 ); /* READONLY */
3015 testcase( (1<<(flags
&7))==0x04 ); /* READWRITE */
3016 testcase( (1<<(flags
&7))==0x40 ); /* READWRITE | CREATE */
3017 if( ((1<<(flags
&7)) & 0x46)==0 ){
3018 rc
= SQLITE_MISUSE_BKPT
; /* IMP: R-65497-44594 */
3020 rc
= sqlite3ParseUri(zVfs
, zFilename
, &flags
, &db
->pVfs
, &zOpen
, &zErrMsg
);
3022 if( rc
!=SQLITE_OK
){
3023 if( rc
==SQLITE_NOMEM
) sqlite3OomFault(db
);
3024 sqlite3ErrorWithMsg(db
, rc
, zErrMsg
? "%s" : 0, zErrMsg
);
3025 sqlite3_free(zErrMsg
);
3029 /* Open the backend database driver */
3030 rc
= sqlite3BtreeOpen(db
->pVfs
, zOpen
, db
, &db
->aDb
[0].pBt
, 0,
3031 flags
| SQLITE_OPEN_MAIN_DB
);
3032 if( rc
!=SQLITE_OK
){
3033 if( rc
==SQLITE_IOERR_NOMEM
){
3034 rc
= SQLITE_NOMEM_BKPT
;
3036 sqlite3Error(db
, rc
);
3039 sqlite3BtreeEnter(db
->aDb
[0].pBt
);
3040 db
->aDb
[0].pSchema
= sqlite3SchemaGet(db
, db
->aDb
[0].pBt
);
3041 if( !db
->mallocFailed
) ENC(db
) = SCHEMA_ENC(db
);
3042 sqlite3BtreeLeave(db
->aDb
[0].pBt
);
3043 db
->aDb
[1].pSchema
= sqlite3SchemaGet(db
, 0);
3045 /* The default safety_level for the main database is FULL; for the temp
3046 ** database it is OFF. This matches the pager layer defaults.
3048 db
->aDb
[0].zDbSName
= "main";
3049 db
->aDb
[0].safety_level
= SQLITE_DEFAULT_SYNCHRONOUS
+1;
3050 db
->aDb
[1].zDbSName
= "temp";
3051 db
->aDb
[1].safety_level
= PAGER_SYNCHRONOUS_OFF
;
3053 db
->magic
= SQLITE_MAGIC_OPEN
;
3054 if( db
->mallocFailed
){
3058 /* Register all built-in functions, but do not attempt to read the
3059 ** database schema yet. This is delayed until the first time the database
3062 sqlite3Error(db
, SQLITE_OK
);
3063 sqlite3RegisterPerConnectionBuiltinFunctions(db
);
3064 rc
= sqlite3_errcode(db
);
3066 #ifdef SQLITE_ENABLE_FTS5
3067 /* Register any built-in FTS5 module before loading the automatic
3068 ** extensions. This allows automatic extensions to register FTS5
3069 ** tokenizers and auxiliary functions. */
3070 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3071 rc
= sqlite3Fts5Init(db
);
3075 /* Load automatic extensions - extensions that have been registered
3076 ** using the sqlite3_automatic_extension() API.
3078 if( rc
==SQLITE_OK
){
3079 sqlite3AutoLoadExtensions(db
);
3080 rc
= sqlite3_errcode(db
);
3081 if( rc
!=SQLITE_OK
){
3086 #ifdef SQLITE_ENABLE_FTS1
3087 if( !db
->mallocFailed
){
3088 extern int sqlite3Fts1Init(sqlite3
*);
3089 rc
= sqlite3Fts1Init(db
);
3093 #ifdef SQLITE_ENABLE_FTS2
3094 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3095 extern int sqlite3Fts2Init(sqlite3
*);
3096 rc
= sqlite3Fts2Init(db
);
3100 #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
3101 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3102 rc
= sqlite3Fts3Init(db
);
3106 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
3107 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3108 rc
= sqlite3IcuInit(db
);
3112 #ifdef SQLITE_ENABLE_RTREE
3113 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3114 rc
= sqlite3RtreeInit(db
);
3118 #ifdef SQLITE_ENABLE_DBPAGE_VTAB
3119 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3120 rc
= sqlite3DbpageRegister(db
);
3124 #ifdef SQLITE_ENABLE_DBSTAT_VTAB
3125 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3126 rc
= sqlite3DbstatRegister(db
);
3130 #ifdef SQLITE_ENABLE_JSON1
3131 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3132 rc
= sqlite3Json1Init(db
);
3136 #ifdef SQLITE_ENABLE_STMTVTAB
3137 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3138 rc
= sqlite3StmtVtabInit(db
);
3142 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3143 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3144 ** mode. Doing nothing at all also makes NORMAL the default.
3146 #ifdef SQLITE_DEFAULT_LOCKING_MODE
3147 db
->dfltLockMode
= SQLITE_DEFAULT_LOCKING_MODE
;
3148 sqlite3PagerLockingMode(sqlite3BtreePager(db
->aDb
[0].pBt
),
3149 SQLITE_DEFAULT_LOCKING_MODE
);
3152 if( rc
) sqlite3Error(db
, rc
);
3154 /* Enable the lookaside-malloc subsystem */
3155 setupLookaside(db
, 0, sqlite3GlobalConfig
.szLookaside
,
3156 sqlite3GlobalConfig
.nLookaside
);
3158 sqlite3_wal_autocheckpoint(db
, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT
);
3162 assert( db
->mutex
!=0 || isThreadsafe
==0
3163 || sqlite3GlobalConfig
.bFullMutex
==0 );
3164 sqlite3_mutex_leave(db
->mutex
);
3166 rc
= sqlite3_errcode(db
);
3167 assert( db
!=0 || rc
==SQLITE_NOMEM
);
3168 if( rc
==SQLITE_NOMEM
){
3171 }else if( rc
!=SQLITE_OK
){
3172 db
->magic
= SQLITE_MAGIC_SICK
;
3175 #ifdef SQLITE_ENABLE_SQLLOG
3176 if( sqlite3GlobalConfig
.xSqllog
){
3177 /* Opening a db handle. Fourth parameter is passed 0. */
3178 void *pArg
= sqlite3GlobalConfig
.pSqllogArg
;
3179 sqlite3GlobalConfig
.xSqllog(pArg
, db
, zFilename
, 0);
3182 #if defined(SQLITE_HAS_CODEC)
3183 if( rc
==SQLITE_OK
){
3185 if( (zKey
= sqlite3_uri_parameter(zOpen
, "hexkey"))!=0 && zKey
[0] ){
3189 for(i
=0, iByte
=0; i
<sizeof(zDecoded
)*2 && sqlite3Isxdigit(zKey
[i
]); i
++){
3190 iByte
= (iByte
<<4) + sqlite3HexToInt(zKey
[i
]);
3191 if( (i
&1)!=0 ) zDecoded
[i
/2] = iByte
;
3193 sqlite3_key_v2(db
, 0, zDecoded
, i
/2);
3194 }else if( (zKey
= sqlite3_uri_parameter(zOpen
, "key"))!=0 ){
3195 sqlite3_key_v2(db
, 0, zKey
, sqlite3Strlen30(zKey
));
3199 sqlite3_free(zOpen
);
3204 ** Open a new database handle.
3207 const char *zFilename
,
3210 return openDatabase(zFilename
, ppDb
,
3211 SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
, 0);
3213 int sqlite3_open_v2(
3214 const char *filename
, /* Database filename (UTF-8) */
3215 sqlite3
**ppDb
, /* OUT: SQLite db handle */
3216 int flags
, /* Flags */
3217 const char *zVfs
/* Name of VFS module to use */
3219 return openDatabase(filename
, ppDb
, (unsigned int)flags
, zVfs
);
3222 #ifndef SQLITE_OMIT_UTF16
3224 ** Open a new database handle.
3227 const void *zFilename
,
3230 char const *zFilename8
; /* zFilename encoded in UTF-8 instead of UTF-16 */
3231 sqlite3_value
*pVal
;
3234 #ifdef SQLITE_ENABLE_API_ARMOR
3235 if( ppDb
==0 ) return SQLITE_MISUSE_BKPT
;
3238 #ifndef SQLITE_OMIT_AUTOINIT
3239 rc
= sqlite3_initialize();
3242 if( zFilename
==0 ) zFilename
= "\000\000";
3243 pVal
= sqlite3ValueNew(0);
3244 sqlite3ValueSetStr(pVal
, -1, zFilename
, SQLITE_UTF16NATIVE
, SQLITE_STATIC
);
3245 zFilename8
= sqlite3ValueText(pVal
, SQLITE_UTF8
);
3247 rc
= openDatabase(zFilename8
, ppDb
,
3248 SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
, 0);
3249 assert( *ppDb
|| rc
==SQLITE_NOMEM
);
3250 if( rc
==SQLITE_OK
&& !DbHasProperty(*ppDb
, 0, DB_SchemaLoaded
) ){
3251 SCHEMA_ENC(*ppDb
) = ENC(*ppDb
) = SQLITE_UTF16NATIVE
;
3254 rc
= SQLITE_NOMEM_BKPT
;
3256 sqlite3ValueFree(pVal
);
3260 #endif /* SQLITE_OMIT_UTF16 */
3263 ** Register a new collation sequence with the database handle db.
3265 int sqlite3_create_collation(
3270 int(*xCompare
)(void*,int,const void*,int,const void*)
3272 return sqlite3_create_collation_v2(db
, zName
, enc
, pCtx
, xCompare
, 0);
3276 ** Register a new collation sequence with the database handle db.
3278 int sqlite3_create_collation_v2(
3283 int(*xCompare
)(void*,int,const void*,int,const void*),
3288 #ifdef SQLITE_ENABLE_API_ARMOR
3289 if( !sqlite3SafetyCheckOk(db
) || zName
==0 ) return SQLITE_MISUSE_BKPT
;
3291 sqlite3_mutex_enter(db
->mutex
);
3292 assert( !db
->mallocFailed
);
3293 rc
= createCollation(db
, zName
, (u8
)enc
, pCtx
, xCompare
, xDel
);
3294 rc
= sqlite3ApiExit(db
, rc
);
3295 sqlite3_mutex_leave(db
->mutex
);
3299 #ifndef SQLITE_OMIT_UTF16
3301 ** Register a new collation sequence with the database handle db.
3303 int sqlite3_create_collation16(
3308 int(*xCompare
)(void*,int,const void*,int,const void*)
3313 #ifdef SQLITE_ENABLE_API_ARMOR
3314 if( !sqlite3SafetyCheckOk(db
) || zName
==0 ) return SQLITE_MISUSE_BKPT
;
3316 sqlite3_mutex_enter(db
->mutex
);
3317 assert( !db
->mallocFailed
);
3318 zName8
= sqlite3Utf16to8(db
, zName
, -1, SQLITE_UTF16NATIVE
);
3320 rc
= createCollation(db
, zName8
, (u8
)enc
, pCtx
, xCompare
, 0);
3321 sqlite3DbFree(db
, zName8
);
3323 rc
= sqlite3ApiExit(db
, rc
);
3324 sqlite3_mutex_leave(db
->mutex
);
3327 #endif /* SQLITE_OMIT_UTF16 */
3330 ** Register a collation sequence factory callback with the database handle
3331 ** db. Replace any previously installed collation sequence factory.
3333 int sqlite3_collation_needed(
3335 void *pCollNeededArg
,
3336 void(*xCollNeeded
)(void*,sqlite3
*,int eTextRep
,const char*)
3338 #ifdef SQLITE_ENABLE_API_ARMOR
3339 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3341 sqlite3_mutex_enter(db
->mutex
);
3342 db
->xCollNeeded
= xCollNeeded
;
3343 db
->xCollNeeded16
= 0;
3344 db
->pCollNeededArg
= pCollNeededArg
;
3345 sqlite3_mutex_leave(db
->mutex
);
3349 #ifndef SQLITE_OMIT_UTF16
3351 ** Register a collation sequence factory callback with the database handle
3352 ** db. Replace any previously installed collation sequence factory.
3354 int sqlite3_collation_needed16(
3356 void *pCollNeededArg
,
3357 void(*xCollNeeded16
)(void*,sqlite3
*,int eTextRep
,const void*)
3359 #ifdef SQLITE_ENABLE_API_ARMOR
3360 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3362 sqlite3_mutex_enter(db
->mutex
);
3363 db
->xCollNeeded
= 0;
3364 db
->xCollNeeded16
= xCollNeeded16
;
3365 db
->pCollNeededArg
= pCollNeededArg
;
3366 sqlite3_mutex_leave(db
->mutex
);
3369 #endif /* SQLITE_OMIT_UTF16 */
3371 #ifndef SQLITE_OMIT_DEPRECATED
3373 ** This function is now an anachronism. It used to be used to recover from a
3374 ** malloc() failure, but SQLite now does this automatically.
3376 int sqlite3_global_recover(void){
3382 ** Test to see whether or not the database connection is in autocommit
3383 ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3384 ** by default. Autocommit is disabled by a BEGIN statement and reenabled
3385 ** by the next COMMIT or ROLLBACK.
3387 int sqlite3_get_autocommit(sqlite3
*db
){
3388 #ifdef SQLITE_ENABLE_API_ARMOR
3389 if( !sqlite3SafetyCheckOk(db
) ){
3390 (void)SQLITE_MISUSE_BKPT
;
3394 return db
->autoCommit
;
3398 ** The following routines are substitutes for constants SQLITE_CORRUPT,
3399 ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
3400 ** constants. They serve two purposes:
3402 ** 1. Serve as a convenient place to set a breakpoint in a debugger
3403 ** to detect when version error conditions occurs.
3405 ** 2. Invoke sqlite3_log() to provide the source code location where
3406 ** a low-level error is first detected.
3408 int sqlite3ReportError(int iErr
, int lineno
, const char *zType
){
3409 sqlite3_log(iErr
, "%s at line %d of [%.10s]",
3410 zType
, lineno
, 20+sqlite3_sourceid());
3413 int sqlite3CorruptError(int lineno
){
3414 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3415 return sqlite3ReportError(SQLITE_CORRUPT
, lineno
, "database corruption");
3417 int sqlite3MisuseError(int lineno
){
3418 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3419 return sqlite3ReportError(SQLITE_MISUSE
, lineno
, "misuse");
3421 int sqlite3CantopenError(int lineno
){
3422 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3423 return sqlite3ReportError(SQLITE_CANTOPEN
, lineno
, "cannot open file");
3426 int sqlite3CorruptPgnoError(int lineno
, Pgno pgno
){
3428 sqlite3_snprintf(sizeof(zMsg
), zMsg
, "database corruption page %d", pgno
);
3429 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3430 return sqlite3ReportError(SQLITE_CORRUPT
, lineno
, zMsg
);
3432 int sqlite3NomemError(int lineno
){
3433 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3434 return sqlite3ReportError(SQLITE_NOMEM
, lineno
, "OOM");
3436 int sqlite3IoerrnomemError(int lineno
){
3437 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3438 return sqlite3ReportError(SQLITE_IOERR_NOMEM
, lineno
, "I/O OOM error");
3442 #ifndef SQLITE_OMIT_DEPRECATED
3444 ** This is a convenience routine that makes sure that all thread-specific
3445 ** data for this thread has been deallocated.
3447 ** SQLite no longer uses thread-specific data so this routine is now a
3448 ** no-op. It is retained for historical compatibility.
3450 void sqlite3_thread_cleanup(void){
3455 ** Return meta information about a specific column of a database table.
3456 ** See comment in sqlite3.h (sqlite.h.in) for details.
3458 int sqlite3_table_column_metadata(
3459 sqlite3
*db
, /* Connection handle */
3460 const char *zDbName
, /* Database name or NULL */
3461 const char *zTableName
, /* Table name */
3462 const char *zColumnName
, /* Column name */
3463 char const **pzDataType
, /* OUTPUT: Declared data type */
3464 char const **pzCollSeq
, /* OUTPUT: Collation sequence name */
3465 int *pNotNull
, /* OUTPUT: True if NOT NULL constraint exists */
3466 int *pPrimaryKey
, /* OUTPUT: True if column part of PK */
3467 int *pAutoinc
/* OUTPUT: True if column is auto-increment */
3474 char const *zDataType
= 0;
3475 char const *zCollSeq
= 0;
3481 #ifdef SQLITE_ENABLE_API_ARMOR
3482 if( !sqlite3SafetyCheckOk(db
) || zTableName
==0 ){
3483 return SQLITE_MISUSE_BKPT
;
3487 /* Ensure the database schema has been loaded */
3488 sqlite3_mutex_enter(db
->mutex
);
3489 sqlite3BtreeEnterAll(db
);
3490 rc
= sqlite3Init(db
, &zErrMsg
);
3491 if( SQLITE_OK
!=rc
){
3495 /* Locate the table in question */
3496 pTab
= sqlite3FindTable(db
, zTableName
, zDbName
);
3497 if( !pTab
|| pTab
->pSelect
){
3502 /* Find the column for which info is requested */
3503 if( zColumnName
==0 ){
3504 /* Query for existance of table only */
3506 for(iCol
=0; iCol
<pTab
->nCol
; iCol
++){
3507 pCol
= &pTab
->aCol
[iCol
];
3508 if( 0==sqlite3StrICmp(pCol
->zName
, zColumnName
) ){
3512 if( iCol
==pTab
->nCol
){
3513 if( HasRowid(pTab
) && sqlite3IsRowid(zColumnName
) ){
3515 pCol
= iCol
>=0 ? &pTab
->aCol
[iCol
] : 0;
3523 /* The following block stores the meta information that will be returned
3524 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3525 ** and autoinc. At this point there are two possibilities:
3527 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3528 ** and there is no explicitly declared IPK column.
3530 ** 2. The table is not a view and the column name identified an
3531 ** explicitly declared column. Copy meta information from *pCol.
3534 zDataType
= sqlite3ColumnType(pCol
,0);
3535 zCollSeq
= pCol
->zColl
;
3536 notnull
= pCol
->notNull
!=0;
3537 primarykey
= (pCol
->colFlags
& COLFLAG_PRIMKEY
)!=0;
3538 autoinc
= pTab
->iPKey
==iCol
&& (pTab
->tabFlags
& TF_Autoincrement
)!=0;
3540 zDataType
= "INTEGER";
3544 zCollSeq
= sqlite3StrBINARY
;
3548 sqlite3BtreeLeaveAll(db
);
3550 /* Whether the function call succeeded or failed, set the output parameters
3551 ** to whatever their local counterparts contain. If an error did occur,
3552 ** this has the effect of zeroing all output parameters.
3554 if( pzDataType
) *pzDataType
= zDataType
;
3555 if( pzCollSeq
) *pzCollSeq
= zCollSeq
;
3556 if( pNotNull
) *pNotNull
= notnull
;
3557 if( pPrimaryKey
) *pPrimaryKey
= primarykey
;
3558 if( pAutoinc
) *pAutoinc
= autoinc
;
3560 if( SQLITE_OK
==rc
&& !pTab
){
3561 sqlite3DbFree(db
, zErrMsg
);
3562 zErrMsg
= sqlite3MPrintf(db
, "no such table column: %s.%s", zTableName
,
3566 sqlite3ErrorWithMsg(db
, rc
, (zErrMsg
?"%s":0), zErrMsg
);
3567 sqlite3DbFree(db
, zErrMsg
);
3568 rc
= sqlite3ApiExit(db
, rc
);
3569 sqlite3_mutex_leave(db
->mutex
);
3574 ** Sleep for a little while. Return the amount of time slept.
3576 int sqlite3_sleep(int ms
){
3579 pVfs
= sqlite3_vfs_find(0);
3580 if( pVfs
==0 ) return 0;
3582 /* This function works in milliseconds, but the underlying OsSleep()
3583 ** API uses microseconds. Hence the 1000's.
3585 rc
= (sqlite3OsSleep(pVfs
, 1000*ms
)/1000);
3590 ** Enable or disable the extended result codes.
3592 int sqlite3_extended_result_codes(sqlite3
*db
, int onoff
){
3593 #ifdef SQLITE_ENABLE_API_ARMOR
3594 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3596 sqlite3_mutex_enter(db
->mutex
);
3597 db
->errMask
= onoff
? 0xffffffff : 0xff;
3598 sqlite3_mutex_leave(db
->mutex
);
3603 ** Invoke the xFileControl method on a particular database.
3605 int sqlite3_file_control(sqlite3
*db
, const char *zDbName
, int op
, void *pArg
){
3606 int rc
= SQLITE_ERROR
;
3609 #ifdef SQLITE_ENABLE_API_ARMOR
3610 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3612 sqlite3_mutex_enter(db
->mutex
);
3613 pBtree
= sqlite3DbNameToBtree(db
, zDbName
);
3617 sqlite3BtreeEnter(pBtree
);
3618 pPager
= sqlite3BtreePager(pBtree
);
3619 assert( pPager
!=0 );
3620 fd
= sqlite3PagerFile(pPager
);
3622 if( op
==SQLITE_FCNTL_FILE_POINTER
){
3623 *(sqlite3_file
**)pArg
= fd
;
3625 }else if( op
==SQLITE_FCNTL_VFS_POINTER
){
3626 *(sqlite3_vfs
**)pArg
= sqlite3PagerVfs(pPager
);
3628 }else if( op
==SQLITE_FCNTL_JOURNAL_POINTER
){
3629 *(sqlite3_file
**)pArg
= sqlite3PagerJrnlFile(pPager
);
3631 }else if( fd
->pMethods
){
3632 rc
= sqlite3OsFileControl(fd
, op
, pArg
);
3634 rc
= SQLITE_NOTFOUND
;
3636 sqlite3BtreeLeave(pBtree
);
3638 sqlite3_mutex_leave(db
->mutex
);
3643 ** Interface to the testing logic.
3645 int sqlite3_test_control(int op
, ...){
3647 #ifdef SQLITE_UNTESTABLE
3648 UNUSED_PARAMETER(op
);
3655 ** Save the current state of the PRNG.
3657 case SQLITE_TESTCTRL_PRNG_SAVE
: {
3658 sqlite3PrngSaveState();
3663 ** Restore the state of the PRNG to the last state saved using
3664 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3665 ** this verb acts like PRNG_RESET.
3667 case SQLITE_TESTCTRL_PRNG_RESTORE
: {
3668 sqlite3PrngRestoreState();
3673 ** Reset the PRNG back to its uninitialized state. The next call
3674 ** to sqlite3_randomness() will reseed the PRNG using a single call
3675 ** to the xRandomness method of the default VFS.
3677 case SQLITE_TESTCTRL_PRNG_RESET
: {
3678 sqlite3_randomness(0,0);
3683 ** sqlite3_test_control(BITVEC_TEST, size, program)
3685 ** Run a test against a Bitvec object of size. The program argument
3686 ** is an array of integers that defines the test. Return -1 on a
3687 ** memory allocation error, 0 on success, or non-zero for an error.
3688 ** See the sqlite3BitvecBuiltinTest() for additional information.
3690 case SQLITE_TESTCTRL_BITVEC_TEST
: {
3691 int sz
= va_arg(ap
, int);
3692 int *aProg
= va_arg(ap
, int*);
3693 rc
= sqlite3BitvecBuiltinTest(sz
, aProg
);
3698 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3700 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3701 ** if xCallback is not NULL.
3703 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3704 ** is called immediately after installing the new callback and the return
3705 ** value from sqlite3FaultSim(0) becomes the return from
3706 ** sqlite3_test_control().
3708 case SQLITE_TESTCTRL_FAULT_INSTALL
: {
3709 /* MSVC is picky about pulling func ptrs from va lists.
3710 ** http://support.microsoft.com/kb/47961
3711 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
3713 typedef int(*TESTCALLBACKFUNC_t
)(int);
3714 sqlite3GlobalConfig
.xTestCallback
= va_arg(ap
, TESTCALLBACKFUNC_t
);
3715 rc
= sqlite3FaultSim(0);
3720 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3722 ** Register hooks to call to indicate which malloc() failures
3725 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS
: {
3726 typedef void (*void_function
)(void);
3727 void_function xBenignBegin
;
3728 void_function xBenignEnd
;
3729 xBenignBegin
= va_arg(ap
, void_function
);
3730 xBenignEnd
= va_arg(ap
, void_function
);
3731 sqlite3BenignMallocHooks(xBenignBegin
, xBenignEnd
);
3736 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
3738 ** Set the PENDING byte to the value in the argument, if X>0.
3739 ** Make no changes if X==0. Return the value of the pending byte
3740 ** as it existing before this routine was called.
3742 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3743 ** an incompatible database file format. Changing the PENDING byte
3744 ** while any database connection is open results in undefined and
3745 ** deleterious behavior.
3747 case SQLITE_TESTCTRL_PENDING_BYTE
: {
3749 #ifndef SQLITE_OMIT_WSD
3751 unsigned int newVal
= va_arg(ap
, unsigned int);
3752 if( newVal
) sqlite3PendingByte
= newVal
;
3759 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3761 ** This action provides a run-time test to see whether or not
3762 ** assert() was enabled at compile-time. If X is true and assert()
3763 ** is enabled, then the return value is true. If X is true and
3764 ** assert() is disabled, then the return value is zero. If X is
3765 ** false and assert() is enabled, then the assertion fires and the
3766 ** process aborts. If X is false and assert() is disabled, then the
3767 ** return value is zero.
3769 case SQLITE_TESTCTRL_ASSERT
: {
3771 assert( /*side-effects-ok*/ (x
= va_arg(ap
,int))!=0 );
3778 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3780 ** This action provides a run-time test to see how the ALWAYS and
3781 ** NEVER macros were defined at compile-time.
3783 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
3785 ** The recommended test is X==2. If the return value is 2, that means
3786 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3787 ** default setting. If the return value is 1, then ALWAYS() is either
3788 ** hard-coded to true or else it asserts if its argument is false.
3789 ** The first behavior (hard-coded to true) is the case if
3790 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3791 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3792 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3794 ** The run-time test procedure might look something like this:
3796 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3797 ** // ALWAYS() and NEVER() are no-op pass-through macros
3798 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3799 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3801 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3804 case SQLITE_TESTCTRL_ALWAYS
: {
3805 int x
= va_arg(ap
,int);
3806 rc
= x
? ALWAYS(x
) : 0;
3811 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3813 ** The integer returned reveals the byte-order of the computer on which
3814 ** SQLite is running:
3816 ** 1 big-endian, determined at run-time
3817 ** 10 little-endian, determined at run-time
3818 ** 432101 big-endian, determined at compile-time
3819 ** 123410 little-endian, determined at compile-time
3821 case SQLITE_TESTCTRL_BYTEORDER
: {
3822 rc
= SQLITE_BYTEORDER
*100 + SQLITE_LITTLEENDIAN
*10 + SQLITE_BIGENDIAN
;
3826 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3828 ** Set the nReserve size to N for the main database on the database
3831 case SQLITE_TESTCTRL_RESERVE
: {
3832 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3833 int x
= va_arg(ap
,int);
3834 sqlite3_mutex_enter(db
->mutex
);
3835 sqlite3BtreeSetPageSize(db
->aDb
[0].pBt
, 0, x
, 0);
3836 sqlite3_mutex_leave(db
->mutex
);
3840 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3842 ** Enable or disable various optimizations for testing purposes. The
3843 ** argument N is a bitmask of optimizations to be disabled. For normal
3844 ** operation N should be 0. The idea is that a test program (like the
3845 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3846 ** with various optimizations disabled to verify that the same answer
3847 ** is obtained in every case.
3849 case SQLITE_TESTCTRL_OPTIMIZATIONS
: {
3850 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3851 db
->dbOptFlags
= (u16
)(va_arg(ap
, int) & 0xffff);
3855 #ifdef SQLITE_N_KEYWORD
3856 /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
3858 ** If zWord is a keyword recognized by the parser, then return the
3859 ** number of keywords. Or if zWord is not a keyword, return 0.
3861 ** This test feature is only available in the amalgamation since
3862 ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
3863 ** is built using separate source files.
3865 case SQLITE_TESTCTRL_ISKEYWORD
: {
3866 const char *zWord
= va_arg(ap
, const char*);
3867 int n
= sqlite3Strlen30(zWord
);
3868 rc
= (sqlite3KeywordCode((u8
*)zWord
, n
)!=TK_ID
) ? SQLITE_N_KEYWORD
: 0;
3873 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3875 ** If parameter onoff is non-zero, configure the wrappers so that all
3876 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3877 ** undo this setting.
3879 case SQLITE_TESTCTRL_LOCALTIME_FAULT
: {
3880 sqlite3GlobalConfig
.bLocaltimeFault
= va_arg(ap
, int);
3884 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3886 ** Set or clear a flag that indicates that the database file is always well-
3887 ** formed and never corrupt. This flag is clear by default, indicating that
3888 ** database files might have arbitrary corruption. Setting the flag during
3889 ** testing causes certain assert() statements in the code to be activated
3890 ** that demonstrat invariants on well-formed database files.
3892 case SQLITE_TESTCTRL_NEVER_CORRUPT
: {
3893 sqlite3GlobalConfig
.neverCorrupt
= va_arg(ap
, int);
3897 /* Set the threshold at which OP_Once counters reset back to zero.
3898 ** By default this is 0x7ffffffe (over 2 billion), but that value is
3899 ** too big to test in a reasonable amount of time, so this control is
3900 ** provided to set a small and easily reachable reset value.
3902 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD
: {
3903 sqlite3GlobalConfig
.iOnceResetThreshold
= va_arg(ap
, int);
3907 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3909 ** Set the VDBE coverage callback function to xCallback with context
3912 case SQLITE_TESTCTRL_VDBE_COVERAGE
: {
3913 #ifdef SQLITE_VDBE_COVERAGE
3914 typedef void (*branch_callback
)(void*,int,u8
,u8
);
3915 sqlite3GlobalConfig
.xVdbeBranch
= va_arg(ap
,branch_callback
);
3916 sqlite3GlobalConfig
.pVdbeBranchArg
= va_arg(ap
,void*);
3921 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3922 case SQLITE_TESTCTRL_SORTER_MMAP
: {
3923 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3924 db
->nMaxSorterMmap
= va_arg(ap
, int);
3928 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3930 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3933 case SQLITE_TESTCTRL_ISINIT
: {
3934 if( sqlite3GlobalConfig
.isInit
==0 ) rc
= SQLITE_ERROR
;
3938 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
3940 ** This test control is used to create imposter tables. "db" is a pointer
3941 ** to the database connection. dbName is the database name (ex: "main" or
3942 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
3943 ** or off. "tnum" is the root page of the b-tree to which the imposter
3944 ** table should connect.
3946 ** Enable imposter mode only when the schema has already been parsed. Then
3947 ** run a single CREATE TABLE statement to construct the imposter table in
3948 ** the parsed schema. Then turn imposter mode back off again.
3950 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
3951 ** the schema to be reparsed the next time it is needed. This has the
3952 ** effect of erasing all imposter tables.
3954 case SQLITE_TESTCTRL_IMPOSTER
: {
3955 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3956 sqlite3_mutex_enter(db
->mutex
);
3957 db
->init
.iDb
= sqlite3FindDbName(db
, va_arg(ap
,const char*));
3958 db
->init
.busy
= db
->init
.imposterTable
= va_arg(ap
,int);
3959 db
->init
.newTnum
= va_arg(ap
,int);
3960 if( db
->init
.busy
==0 && db
->init
.newTnum
>0 ){
3961 sqlite3ResetAllSchemasOfConnection(db
);
3963 sqlite3_mutex_leave(db
->mutex
);
3967 #if defined(YYCOVERAGE)
3968 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
3970 ** This test control (only available when SQLite is compiled with
3971 ** -DYYCOVERAGE) writes a report onto "out" that shows all
3972 ** state/lookahead combinations in the parser state machine
3973 ** which are never exercised. If any state is missed, make the
3974 ** return code SQLITE_ERROR.
3976 case SQLITE_TESTCTRL_PARSER_COVERAGE
: {
3977 FILE *out
= va_arg(ap
, FILE*);
3978 if( sqlite3ParserCoverage(out
) ) rc
= SQLITE_ERROR
;
3981 #endif /* defined(YYCOVERAGE) */
3984 #endif /* SQLITE_UNTESTABLE */
3989 ** This is a utility routine, useful to VFS implementations, that checks
3990 ** to see if a database file was a URI that contained a specific query
3991 ** parameter, and if so obtains the value of the query parameter.
3993 ** The zFilename argument is the filename pointer passed into the xOpen()
3994 ** method of a VFS implementation. The zParam argument is the name of the
3995 ** query parameter we seek. This routine returns the value of the zParam
3996 ** parameter if it exists. If the parameter does not exist, this routine
3997 ** returns a NULL pointer.
3999 const char *sqlite3_uri_parameter(const char *zFilename
, const char *zParam
){
4000 if( zFilename
==0 || zParam
==0 ) return 0;
4001 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4002 while( zFilename
[0] ){
4003 int x
= strcmp(zFilename
, zParam
);
4004 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4005 if( x
==0 ) return zFilename
;
4006 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4012 ** Return a boolean value for a query parameter.
4014 int sqlite3_uri_boolean(const char *zFilename
, const char *zParam
, int bDflt
){
4015 const char *z
= sqlite3_uri_parameter(zFilename
, zParam
);
4017 return z
? sqlite3GetBoolean(z
, bDflt
) : bDflt
;
4021 ** Return a 64-bit integer value for a query parameter.
4023 sqlite3_int64
sqlite3_uri_int64(
4024 const char *zFilename
, /* Filename as passed to xOpen */
4025 const char *zParam
, /* URI parameter sought */
4026 sqlite3_int64 bDflt
/* return if parameter is missing */
4028 const char *z
= sqlite3_uri_parameter(zFilename
, zParam
);
4030 if( z
&& sqlite3DecOrHexToI64(z
, &v
)==0 ){
4037 ** Return the Btree pointer identified by zDbName. Return NULL if not found.
4039 Btree
*sqlite3DbNameToBtree(sqlite3
*db
, const char *zDbName
){
4040 int iDb
= zDbName
? sqlite3FindDbName(db
, zDbName
) : 0;
4041 return iDb
<0 ? 0 : db
->aDb
[iDb
].pBt
;
4045 ** Return the filename of the database associated with a database
4048 const char *sqlite3_db_filename(sqlite3
*db
, const char *zDbName
){
4050 #ifdef SQLITE_ENABLE_API_ARMOR
4051 if( !sqlite3SafetyCheckOk(db
) ){
4052 (void)SQLITE_MISUSE_BKPT
;
4056 pBt
= sqlite3DbNameToBtree(db
, zDbName
);
4057 return pBt
? sqlite3BtreeGetFilename(pBt
) : 0;
4061 ** Return 1 if database is read-only or 0 if read/write. Return -1 if
4062 ** no such database exists.
4064 int sqlite3_db_readonly(sqlite3
*db
, const char *zDbName
){
4066 #ifdef SQLITE_ENABLE_API_ARMOR
4067 if( !sqlite3SafetyCheckOk(db
) ){
4068 (void)SQLITE_MISUSE_BKPT
;
4072 pBt
= sqlite3DbNameToBtree(db
, zDbName
);
4073 return pBt
? sqlite3BtreeIsReadonly(pBt
) : -1;
4076 #ifdef SQLITE_ENABLE_SNAPSHOT
4078 ** Obtain a snapshot handle for the snapshot of database zDb currently
4079 ** being read by handle db.
4081 int sqlite3_snapshot_get(
4084 sqlite3_snapshot
**ppSnapshot
4086 int rc
= SQLITE_ERROR
;
4087 #ifndef SQLITE_OMIT_WAL
4089 #ifdef SQLITE_ENABLE_API_ARMOR
4090 if( !sqlite3SafetyCheckOk(db
) ){
4091 return SQLITE_MISUSE_BKPT
;
4094 sqlite3_mutex_enter(db
->mutex
);
4096 if( db
->autoCommit
==0 ){
4097 int iDb
= sqlite3FindDbName(db
, zDb
);
4098 if( iDb
==0 || iDb
>1 ){
4099 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4100 if( 0==sqlite3BtreeIsInTrans(pBt
) ){
4101 rc
= sqlite3BtreeBeginTrans(pBt
, 0);
4102 if( rc
==SQLITE_OK
){
4103 rc
= sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt
), ppSnapshot
);
4109 sqlite3_mutex_leave(db
->mutex
);
4110 #endif /* SQLITE_OMIT_WAL */
4115 ** Open a read-transaction on the snapshot idendified by pSnapshot.
4117 int sqlite3_snapshot_open(
4120 sqlite3_snapshot
*pSnapshot
4122 int rc
= SQLITE_ERROR
;
4123 #ifndef SQLITE_OMIT_WAL
4125 #ifdef SQLITE_ENABLE_API_ARMOR
4126 if( !sqlite3SafetyCheckOk(db
) ){
4127 return SQLITE_MISUSE_BKPT
;
4130 sqlite3_mutex_enter(db
->mutex
);
4131 if( db
->autoCommit
==0 ){
4133 iDb
= sqlite3FindDbName(db
, zDb
);
4134 if( iDb
==0 || iDb
>1 ){
4135 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4136 if( 0==sqlite3BtreeIsInReadTrans(pBt
) ){
4137 rc
= sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt
), pSnapshot
);
4138 if( rc
==SQLITE_OK
){
4139 rc
= sqlite3BtreeBeginTrans(pBt
, 0);
4140 sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt
), 0);
4146 sqlite3_mutex_leave(db
->mutex
);
4147 #endif /* SQLITE_OMIT_WAL */
4152 ** Recover as many snapshots as possible from the wal file associated with
4153 ** schema zDb of database db.
4155 int sqlite3_snapshot_recover(sqlite3
*db
, const char *zDb
){
4156 int rc
= SQLITE_ERROR
;
4158 #ifndef SQLITE_OMIT_WAL
4160 #ifdef SQLITE_ENABLE_API_ARMOR
4161 if( !sqlite3SafetyCheckOk(db
) ){
4162 return SQLITE_MISUSE_BKPT
;
4166 sqlite3_mutex_enter(db
->mutex
);
4167 iDb
= sqlite3FindDbName(db
, zDb
);
4168 if( iDb
==0 || iDb
>1 ){
4169 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4170 if( 0==sqlite3BtreeIsInReadTrans(pBt
) ){
4171 rc
= sqlite3BtreeBeginTrans(pBt
, 0);
4172 if( rc
==SQLITE_OK
){
4173 rc
= sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt
));
4174 sqlite3BtreeCommit(pBt
);
4178 sqlite3_mutex_leave(db
->mutex
);
4179 #endif /* SQLITE_OMIT_WAL */
4184 ** Free a snapshot handle obtained from sqlite3_snapshot_get().
4186 void sqlite3_snapshot_free(sqlite3_snapshot
*pSnapshot
){
4187 sqlite3_free(pSnapshot
);
4189 #endif /* SQLITE_ENABLE_SNAPSHOT */
4191 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4193 ** Given the name of a compile-time option, return true if that option
4194 ** was used and false if not.
4196 ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4197 ** is not required for a match.
4199 int sqlite3_compileoption_used(const char *zOptName
){
4202 const char **azCompileOpt
;
4204 #if SQLITE_ENABLE_API_ARMOR
4206 (void)SQLITE_MISUSE_BKPT
;
4211 azCompileOpt
= sqlite3CompileOptions(&nOpt
);
4213 if( sqlite3StrNICmp(zOptName
, "SQLITE_", 7)==0 ) zOptName
+= 7;
4214 n
= sqlite3Strlen30(zOptName
);
4216 /* Since nOpt is normally in single digits, a linear search is
4217 ** adequate. No need for a binary search. */
4218 for(i
=0; i
<nOpt
; i
++){
4219 if( sqlite3StrNICmp(zOptName
, azCompileOpt
[i
], n
)==0
4220 && sqlite3IsIdChar((unsigned char)azCompileOpt
[i
][n
])==0
4229 ** Return the N-th compile-time option string. If N is out of range,
4230 ** return a NULL pointer.
4232 const char *sqlite3_compileoption_get(int N
){
4234 const char **azCompileOpt
;
4235 azCompileOpt
= sqlite3CompileOptions(&nOpt
);
4236 if( N
>=0 && N
<nOpt
){
4237 return azCompileOpt
[N
];
4241 #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */