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);
645 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
646 case SQLITE_CONFIG_SORTERREF_SIZE
: {
647 int iVal
= va_arg(ap
, int);
649 iVal
= SQLITE_DEFAULT_SORTERREF_SIZE
;
651 sqlite3GlobalConfig
.szSorterRef
= (u32
)iVal
;
654 #endif /* SQLITE_ENABLE_SORTER_REFERENCES */
666 ** Set up the lookaside buffers for a database connection.
667 ** Return SQLITE_OK on success.
668 ** If lookaside is already active, return SQLITE_BUSY.
670 ** The sz parameter is the number of bytes in each lookaside slot.
671 ** The cnt parameter is the number of slots. If pStart is NULL the
672 ** space for the lookaside memory is obtained from sqlite3_malloc().
673 ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
674 ** the lookaside memory.
676 static int setupLookaside(sqlite3
*db
, void *pBuf
, int sz
, int cnt
){
677 #ifndef SQLITE_OMIT_LOOKASIDE
680 if( sqlite3LookasideUsed(db
,0)>0 ){
683 /* Free any existing lookaside buffer for this handle before
684 ** allocating a new one so we don't have to have space for
685 ** both at the same time.
687 if( db
->lookaside
.bMalloced
){
688 sqlite3_free(db
->lookaside
.pStart
);
690 /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
691 ** than a pointer to be useful.
693 sz
= ROUNDDOWN8(sz
); /* IMP: R-33038-09382 */
694 if( sz
<=(int)sizeof(LookasideSlot
*) ) sz
= 0;
696 if( sz
==0 || cnt
==0 ){
700 sqlite3BeginBenignMalloc();
701 pStart
= sqlite3Malloc( sz
*cnt
); /* IMP: R-61949-35727 */
702 sqlite3EndBenignMalloc();
703 if( pStart
) cnt
= sqlite3MallocSize(pStart
)/sz
;
707 db
->lookaside
.pStart
= pStart
;
708 db
->lookaside
.pInit
= 0;
709 db
->lookaside
.pFree
= 0;
710 db
->lookaside
.sz
= (u16
)sz
;
714 assert( sz
> (int)sizeof(LookasideSlot
*) );
715 db
->lookaside
.nSlot
= cnt
;
716 p
= (LookasideSlot
*)pStart
;
717 for(i
=cnt
-1; i
>=0; i
--){
718 p
->pNext
= db
->lookaside
.pInit
;
719 db
->lookaside
.pInit
= p
;
720 p
= (LookasideSlot
*)&((u8
*)p
)[sz
];
722 db
->lookaside
.pEnd
= p
;
723 db
->lookaside
.bDisable
= 0;
724 db
->lookaside
.bMalloced
= pBuf
==0 ?1:0;
726 db
->lookaside
.pStart
= db
;
727 db
->lookaside
.pEnd
= db
;
728 db
->lookaside
.bDisable
= 1;
729 db
->lookaside
.bMalloced
= 0;
730 db
->lookaside
.nSlot
= 0;
732 #endif /* SQLITE_OMIT_LOOKASIDE */
737 ** Return the mutex associated with a database connection.
739 sqlite3_mutex
*sqlite3_db_mutex(sqlite3
*db
){
740 #ifdef SQLITE_ENABLE_API_ARMOR
741 if( !sqlite3SafetyCheckOk(db
) ){
742 (void)SQLITE_MISUSE_BKPT
;
750 ** Free up as much memory as we can from the given database
753 int sqlite3_db_release_memory(sqlite3
*db
){
756 #ifdef SQLITE_ENABLE_API_ARMOR
757 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
759 sqlite3_mutex_enter(db
->mutex
);
760 sqlite3BtreeEnterAll(db
);
761 for(i
=0; i
<db
->nDb
; i
++){
762 Btree
*pBt
= db
->aDb
[i
].pBt
;
764 Pager
*pPager
= sqlite3BtreePager(pBt
);
765 sqlite3PagerShrink(pPager
);
768 sqlite3BtreeLeaveAll(db
);
769 sqlite3_mutex_leave(db
->mutex
);
774 ** Flush any dirty pages in the pager-cache for any attached database
777 int sqlite3_db_cacheflush(sqlite3
*db
){
782 #ifdef SQLITE_ENABLE_API_ARMOR
783 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
785 sqlite3_mutex_enter(db
->mutex
);
786 sqlite3BtreeEnterAll(db
);
787 for(i
=0; rc
==SQLITE_OK
&& i
<db
->nDb
; i
++){
788 Btree
*pBt
= db
->aDb
[i
].pBt
;
789 if( pBt
&& sqlite3BtreeIsInTrans(pBt
) ){
790 Pager
*pPager
= sqlite3BtreePager(pBt
);
791 rc
= sqlite3PagerFlush(pPager
);
792 if( rc
==SQLITE_BUSY
){
798 sqlite3BtreeLeaveAll(db
);
799 sqlite3_mutex_leave(db
->mutex
);
800 return ((rc
==SQLITE_OK
&& bSeenBusy
) ? SQLITE_BUSY
: rc
);
804 ** Configuration settings for an individual database connection
806 int sqlite3_db_config(sqlite3
*db
, int op
, ...){
811 case SQLITE_DBCONFIG_MAINDBNAME
: {
812 /* IMP: R-06824-28531 */
813 /* IMP: R-36257-52125 */
814 db
->aDb
[0].zDbSName
= va_arg(ap
,char*);
818 case SQLITE_DBCONFIG_LOOKASIDE
: {
819 void *pBuf
= va_arg(ap
, void*); /* IMP: R-26835-10964 */
820 int sz
= va_arg(ap
, int); /* IMP: R-47871-25994 */
821 int cnt
= va_arg(ap
, int); /* IMP: R-04460-53386 */
822 rc
= setupLookaside(db
, pBuf
, sz
, cnt
);
826 static const struct {
827 int op
; /* The opcode */
828 u32 mask
; /* Mask of the bit in sqlite3.flags to set/clear */
830 { SQLITE_DBCONFIG_ENABLE_FKEY
, SQLITE_ForeignKeys
},
831 { SQLITE_DBCONFIG_ENABLE_TRIGGER
, SQLITE_EnableTrigger
},
832 { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
, SQLITE_Fts3Tokenizer
},
833 { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
, SQLITE_LoadExtension
},
834 { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
, SQLITE_NoCkptOnClose
},
835 { SQLITE_DBCONFIG_ENABLE_QPSG
, SQLITE_EnableQPSG
},
836 { SQLITE_DBCONFIG_TRIGGER_EQP
, SQLITE_TriggerEQP
},
837 { SQLITE_DBCONFIG_RESET_DATABASE
, SQLITE_ResetDatabase
},
840 rc
= SQLITE_ERROR
; /* IMP: R-42790-23372 */
841 for(i
=0; i
<ArraySize(aFlagOp
); i
++){
842 if( aFlagOp
[i
].op
==op
){
843 int onoff
= va_arg(ap
, int);
844 int *pRes
= va_arg(ap
, int*);
845 u32 oldFlags
= db
->flags
;
847 db
->flags
|= aFlagOp
[i
].mask
;
848 }else if( onoff
==0 ){
849 db
->flags
&= ~aFlagOp
[i
].mask
;
851 if( oldFlags
!=db
->flags
){
852 sqlite3ExpirePreparedStatements(db
);
855 *pRes
= (db
->flags
& aFlagOp
[i
].mask
)!=0;
870 ** Return true if the buffer z[0..n-1] contains all spaces.
872 static int allSpaces(const char *z
, int n
){
873 while( n
>0 && z
[n
-1]==' ' ){ n
--; }
878 ** This is the default collating function named "BINARY" which is always
881 ** If the padFlag argument is not NULL then space padding at the end
882 ** of strings is ignored. This implements the RTRIM collation.
884 static int binCollFunc(
886 int nKey1
, const void *pKey1
,
887 int nKey2
, const void *pKey2
890 n
= nKey1
<nKey2
? nKey1
: nKey2
;
891 /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
892 ** strings byte by byte using the memcmp() function from the standard C
894 assert( pKey1
&& pKey2
);
895 rc
= memcmp(pKey1
, pKey2
, n
);
898 && allSpaces(((char*)pKey1
)+n
, nKey1
-n
)
899 && allSpaces(((char*)pKey2
)+n
, nKey2
-n
)
901 /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
902 ** spaces at the end of either string do not change the result. In other
903 ** words, strings will compare equal to one another as long as they
904 ** differ only in the number of spaces at the end.
914 ** Another built-in collating sequence: NOCASE.
916 ** This collating sequence is intended to be used for "case independent
917 ** comparison". SQLite's knowledge of upper and lower case equivalents
918 ** extends only to the 26 characters used in the English language.
920 ** At the moment there is only a UTF-8 implementation.
922 static int nocaseCollatingFunc(
924 int nKey1
, const void *pKey1
,
925 int nKey2
, const void *pKey2
927 int r
= sqlite3StrNICmp(
928 (const char *)pKey1
, (const char *)pKey2
, (nKey1
<nKey2
)?nKey1
:nKey2
);
929 UNUSED_PARAMETER(NotUsed
);
937 ** Return the ROWID of the most recent insert
939 sqlite_int64
sqlite3_last_insert_rowid(sqlite3
*db
){
940 #ifdef SQLITE_ENABLE_API_ARMOR
941 if( !sqlite3SafetyCheckOk(db
) ){
942 (void)SQLITE_MISUSE_BKPT
;
946 return db
->lastRowid
;
950 ** Set the value returned by the sqlite3_last_insert_rowid() API function.
952 void sqlite3_set_last_insert_rowid(sqlite3
*db
, sqlite3_int64 iRowid
){
953 #ifdef SQLITE_ENABLE_API_ARMOR
954 if( !sqlite3SafetyCheckOk(db
) ){
955 (void)SQLITE_MISUSE_BKPT
;
959 sqlite3_mutex_enter(db
->mutex
);
960 db
->lastRowid
= iRowid
;
961 sqlite3_mutex_leave(db
->mutex
);
965 ** Return the number of changes in the most recent call to sqlite3_exec().
967 int sqlite3_changes(sqlite3
*db
){
968 #ifdef SQLITE_ENABLE_API_ARMOR
969 if( !sqlite3SafetyCheckOk(db
) ){
970 (void)SQLITE_MISUSE_BKPT
;
978 ** Return the number of changes since the database handle was opened.
980 int sqlite3_total_changes(sqlite3
*db
){
981 #ifdef SQLITE_ENABLE_API_ARMOR
982 if( !sqlite3SafetyCheckOk(db
) ){
983 (void)SQLITE_MISUSE_BKPT
;
987 return db
->nTotalChange
;
991 ** Close all open savepoints. This function only manipulates fields of the
992 ** database handle object, it does not close any savepoints that may be open
993 ** at the b-tree/pager level.
995 void sqlite3CloseSavepoints(sqlite3
*db
){
996 while( db
->pSavepoint
){
997 Savepoint
*pTmp
= db
->pSavepoint
;
998 db
->pSavepoint
= pTmp
->pNext
;
999 sqlite3DbFree(db
, pTmp
);
1003 db
->isTransactionSavepoint
= 0;
1007 ** Invoke the destructor function associated with FuncDef p, if any. Except,
1008 ** if this is not the last copy of the function, do not invoke it. Multiple
1009 ** copies of a single function are created when create_function() is called
1010 ** with SQLITE_ANY as the encoding.
1012 static void functionDestroy(sqlite3
*db
, FuncDef
*p
){
1013 FuncDestructor
*pDestructor
= p
->u
.pDestructor
;
1015 pDestructor
->nRef
--;
1016 if( pDestructor
->nRef
==0 ){
1017 pDestructor
->xDestroy(pDestructor
->pUserData
);
1018 sqlite3DbFree(db
, pDestructor
);
1024 ** Disconnect all sqlite3_vtab objects that belong to database connection
1025 ** db. This is called when db is being closed.
1027 static void disconnectAllVtab(sqlite3
*db
){
1028 #ifndef SQLITE_OMIT_VIRTUALTABLE
1031 sqlite3BtreeEnterAll(db
);
1032 for(i
=0; i
<db
->nDb
; i
++){
1033 Schema
*pSchema
= db
->aDb
[i
].pSchema
;
1034 if( db
->aDb
[i
].pSchema
){
1035 for(p
=sqliteHashFirst(&pSchema
->tblHash
); p
; p
=sqliteHashNext(p
)){
1036 Table
*pTab
= (Table
*)sqliteHashData(p
);
1037 if( IsVirtual(pTab
) ) sqlite3VtabDisconnect(db
, pTab
);
1041 for(p
=sqliteHashFirst(&db
->aModule
); p
; p
=sqliteHashNext(p
)){
1042 Module
*pMod
= (Module
*)sqliteHashData(p
);
1043 if( pMod
->pEpoTab
){
1044 sqlite3VtabDisconnect(db
, pMod
->pEpoTab
);
1047 sqlite3VtabUnlockList(db
);
1048 sqlite3BtreeLeaveAll(db
);
1050 UNUSED_PARAMETER(db
);
1055 ** Return TRUE if database connection db has unfinalized prepared
1056 ** statements or unfinished sqlite3_backup objects.
1058 static int connectionIsBusy(sqlite3
*db
){
1060 assert( sqlite3_mutex_held(db
->mutex
) );
1061 if( db
->pVdbe
) return 1;
1062 for(j
=0; j
<db
->nDb
; j
++){
1063 Btree
*pBt
= db
->aDb
[j
].pBt
;
1064 if( pBt
&& sqlite3BtreeIsInBackup(pBt
) ) return 1;
1070 ** Close an existing SQLite database
1072 static int sqlite3Close(sqlite3
*db
, int forceZombie
){
1074 /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
1075 ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
1078 if( !sqlite3SafetyCheckSickOrOk(db
) ){
1079 return SQLITE_MISUSE_BKPT
;
1081 sqlite3_mutex_enter(db
->mutex
);
1082 if( db
->mTrace
& SQLITE_TRACE_CLOSE
){
1083 db
->xTrace(SQLITE_TRACE_CLOSE
, db
->pTraceArg
, db
, 0);
1086 /* Force xDisconnect calls on all virtual tables */
1087 disconnectAllVtab(db
);
1089 /* If a transaction is open, the disconnectAllVtab() call above
1090 ** will not have called the xDisconnect() method on any virtual
1091 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
1092 ** call will do so. We need to do this before the check for active
1093 ** SQL statements below, as the v-table implementation may be storing
1094 ** some prepared statements internally.
1096 sqlite3VtabRollback(db
);
1098 /* Legacy behavior (sqlite3_close() behavior) is to return
1099 ** SQLITE_BUSY if the connection can not be closed immediately.
1101 if( !forceZombie
&& connectionIsBusy(db
) ){
1102 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
, "unable to close due to unfinalized "
1103 "statements or unfinished backups");
1104 sqlite3_mutex_leave(db
->mutex
);
1108 #ifdef SQLITE_ENABLE_SQLLOG
1109 if( sqlite3GlobalConfig
.xSqllog
){
1110 /* Closing the handle. Fourth parameter is passed the value 2. */
1111 sqlite3GlobalConfig
.xSqllog(sqlite3GlobalConfig
.pSqllogArg
, db
, 0, 2);
1115 /* Convert the connection into a zombie and then close it.
1117 db
->magic
= SQLITE_MAGIC_ZOMBIE
;
1118 sqlite3LeaveMutexAndCloseZombie(db
);
1123 ** Two variations on the public interface for closing a database
1124 ** connection. The sqlite3_close() version returns SQLITE_BUSY and
1125 ** leaves the connection option if there are unfinalized prepared
1126 ** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
1127 ** version forces the connection to become a zombie if there are
1128 ** unclosed resources, and arranges for deallocation when the last
1129 ** prepare statement or sqlite3_backup closes.
1131 int sqlite3_close(sqlite3
*db
){ return sqlite3Close(db
,0); }
1132 int sqlite3_close_v2(sqlite3
*db
){ return sqlite3Close(db
,1); }
1136 ** Close the mutex on database connection db.
1138 ** Furthermore, if database connection db is a zombie (meaning that there
1139 ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
1140 ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
1141 ** finished, then free all resources.
1143 void sqlite3LeaveMutexAndCloseZombie(sqlite3
*db
){
1144 HashElem
*i
; /* Hash table iterator */
1147 /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
1148 ** or if the connection has not yet been closed by sqlite3_close_v2(),
1149 ** then just leave the mutex and return.
1151 if( db
->magic
!=SQLITE_MAGIC_ZOMBIE
|| connectionIsBusy(db
) ){
1152 sqlite3_mutex_leave(db
->mutex
);
1156 /* If we reach this point, it means that the database connection has
1157 ** closed all sqlite3_stmt and sqlite3_backup objects and has been
1158 ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
1159 ** go ahead and free all resources.
1162 /* If a transaction is open, roll it back. This also ensures that if
1163 ** any database schemas have been modified by an uncommitted transaction
1164 ** they are reset. And that the required b-tree mutex is held to make
1165 ** the pager rollback and schema reset an atomic operation. */
1166 sqlite3RollbackAll(db
, SQLITE_OK
);
1168 /* Free any outstanding Savepoint structures. */
1169 sqlite3CloseSavepoints(db
);
1171 /* Close all database connections */
1172 for(j
=0; j
<db
->nDb
; j
++){
1173 struct Db
*pDb
= &db
->aDb
[j
];
1175 sqlite3BtreeClose(pDb
->pBt
);
1182 /* Clear the TEMP schema separately and last */
1183 if( db
->aDb
[1].pSchema
){
1184 sqlite3SchemaClear(db
->aDb
[1].pSchema
);
1186 sqlite3VtabUnlockList(db
);
1188 /* Free up the array of auxiliary databases */
1189 sqlite3CollapseDatabaseArray(db
);
1190 assert( db
->nDb
<=2 );
1191 assert( db
->aDb
==db
->aDbStatic
);
1193 /* Tell the code in notify.c that the connection no longer holds any
1194 ** locks and does not require any further unlock-notify callbacks.
1196 sqlite3ConnectionClosed(db
);
1198 for(i
=sqliteHashFirst(&db
->aFunc
); i
; i
=sqliteHashNext(i
)){
1200 p
= sqliteHashData(i
);
1202 functionDestroy(db
, p
);
1204 sqlite3DbFree(db
, p
);
1208 sqlite3HashClear(&db
->aFunc
);
1209 for(i
=sqliteHashFirst(&db
->aCollSeq
); i
; i
=sqliteHashNext(i
)){
1210 CollSeq
*pColl
= (CollSeq
*)sqliteHashData(i
);
1211 /* Invoke any destructors registered for collation sequence user data. */
1213 if( pColl
[j
].xDel
){
1214 pColl
[j
].xDel(pColl
[j
].pUser
);
1217 sqlite3DbFree(db
, pColl
);
1219 sqlite3HashClear(&db
->aCollSeq
);
1220 #ifndef SQLITE_OMIT_VIRTUALTABLE
1221 for(i
=sqliteHashFirst(&db
->aModule
); i
; i
=sqliteHashNext(i
)){
1222 Module
*pMod
= (Module
*)sqliteHashData(i
);
1223 if( pMod
->xDestroy
){
1224 pMod
->xDestroy(pMod
->pAux
);
1226 sqlite3VtabEponymousTableClear(db
, pMod
);
1227 sqlite3DbFree(db
, pMod
);
1229 sqlite3HashClear(&db
->aModule
);
1232 sqlite3Error(db
, SQLITE_OK
); /* Deallocates any cached error strings. */
1233 sqlite3ValueFree(db
->pErr
);
1234 sqlite3CloseExtensions(db
);
1235 #if SQLITE_USER_AUTHENTICATION
1236 sqlite3_free(db
->auth
.zAuthUser
);
1237 sqlite3_free(db
->auth
.zAuthPW
);
1240 db
->magic
= SQLITE_MAGIC_ERROR
;
1242 /* The temp-database schema is allocated differently from the other schema
1243 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
1244 ** So it needs to be freed here. Todo: Why not roll the temp schema into
1245 ** the same sqliteMalloc() as the one that allocates the database
1248 sqlite3DbFree(db
, db
->aDb
[1].pSchema
);
1249 sqlite3_mutex_leave(db
->mutex
);
1250 db
->magic
= SQLITE_MAGIC_CLOSED
;
1251 sqlite3_mutex_free(db
->mutex
);
1252 assert( sqlite3LookasideUsed(db
,0)==0 );
1253 if( db
->lookaside
.bMalloced
){
1254 sqlite3_free(db
->lookaside
.pStart
);
1260 ** Rollback all database files. If tripCode is not SQLITE_OK, then
1261 ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
1262 ** breaker") and made to return tripCode if there are any further
1263 ** attempts to use that cursor. Read cursors remain open and valid
1264 ** but are "saved" in case the table pages are moved around.
1266 void sqlite3RollbackAll(sqlite3
*db
, int tripCode
){
1270 assert( sqlite3_mutex_held(db
->mutex
) );
1271 sqlite3BeginBenignMalloc();
1273 /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
1274 ** This is important in case the transaction being rolled back has
1275 ** modified the database schema. If the b-tree mutexes are not taken
1276 ** here, then another shared-cache connection might sneak in between
1277 ** the database rollback and schema reset, which can cause false
1278 ** corruption reports in some cases. */
1279 sqlite3BtreeEnterAll(db
);
1280 schemaChange
= (db
->mDbFlags
& DBFLAG_SchemaChange
)!=0 && db
->init
.busy
==0;
1282 for(i
=0; i
<db
->nDb
; i
++){
1283 Btree
*p
= db
->aDb
[i
].pBt
;
1285 if( sqlite3BtreeIsInTrans(p
) ){
1288 sqlite3BtreeRollback(p
, tripCode
, !schemaChange
);
1291 sqlite3VtabRollback(db
);
1292 sqlite3EndBenignMalloc();
1294 if( (db
->mDbFlags
&DBFLAG_SchemaChange
)!=0 && db
->init
.busy
==0 ){
1295 sqlite3ExpirePreparedStatements(db
);
1296 sqlite3ResetAllSchemasOfConnection(db
);
1298 sqlite3BtreeLeaveAll(db
);
1300 /* Any deferred constraint violations have now been resolved. */
1301 db
->nDeferredCons
= 0;
1302 db
->nDeferredImmCons
= 0;
1303 db
->flags
&= ~SQLITE_DeferFKs
;
1305 /* If one has been configured, invoke the rollback-hook callback */
1306 if( db
->xRollbackCallback
&& (inTrans
|| !db
->autoCommit
) ){
1307 db
->xRollbackCallback(db
->pRollbackArg
);
1312 ** Return a static string containing the name corresponding to the error code
1313 ** specified in the argument.
1315 #if defined(SQLITE_NEED_ERR_NAME)
1316 const char *sqlite3ErrName(int rc
){
1317 const char *zName
= 0;
1319 for(i
=0; i
<2 && zName
==0; i
++, rc
&= 0xff){
1321 case SQLITE_OK
: zName
= "SQLITE_OK"; break;
1322 case SQLITE_ERROR
: zName
= "SQLITE_ERROR"; break;
1323 case SQLITE_INTERNAL
: zName
= "SQLITE_INTERNAL"; break;
1324 case SQLITE_PERM
: zName
= "SQLITE_PERM"; break;
1325 case SQLITE_ABORT
: zName
= "SQLITE_ABORT"; break;
1326 case SQLITE_ABORT_ROLLBACK
: zName
= "SQLITE_ABORT_ROLLBACK"; break;
1327 case SQLITE_BUSY
: zName
= "SQLITE_BUSY"; break;
1328 case SQLITE_BUSY_RECOVERY
: zName
= "SQLITE_BUSY_RECOVERY"; break;
1329 case SQLITE_BUSY_SNAPSHOT
: zName
= "SQLITE_BUSY_SNAPSHOT"; break;
1330 case SQLITE_LOCKED
: zName
= "SQLITE_LOCKED"; break;
1331 case SQLITE_LOCKED_SHAREDCACHE
: zName
= "SQLITE_LOCKED_SHAREDCACHE";break;
1332 case SQLITE_NOMEM
: zName
= "SQLITE_NOMEM"; break;
1333 case SQLITE_READONLY
: zName
= "SQLITE_READONLY"; break;
1334 case SQLITE_READONLY_RECOVERY
: zName
= "SQLITE_READONLY_RECOVERY"; break;
1335 case SQLITE_READONLY_CANTINIT
: zName
= "SQLITE_READONLY_CANTINIT"; break;
1336 case SQLITE_READONLY_ROLLBACK
: zName
= "SQLITE_READONLY_ROLLBACK"; break;
1337 case SQLITE_READONLY_DBMOVED
: zName
= "SQLITE_READONLY_DBMOVED"; break;
1338 case SQLITE_READONLY_DIRECTORY
: zName
= "SQLITE_READONLY_DIRECTORY";break;
1339 case SQLITE_INTERRUPT
: zName
= "SQLITE_INTERRUPT"; break;
1340 case SQLITE_IOERR
: zName
= "SQLITE_IOERR"; break;
1341 case SQLITE_IOERR_READ
: zName
= "SQLITE_IOERR_READ"; break;
1342 case SQLITE_IOERR_SHORT_READ
: zName
= "SQLITE_IOERR_SHORT_READ"; break;
1343 case SQLITE_IOERR_WRITE
: zName
= "SQLITE_IOERR_WRITE"; break;
1344 case SQLITE_IOERR_FSYNC
: zName
= "SQLITE_IOERR_FSYNC"; break;
1345 case SQLITE_IOERR_DIR_FSYNC
: zName
= "SQLITE_IOERR_DIR_FSYNC"; break;
1346 case SQLITE_IOERR_TRUNCATE
: zName
= "SQLITE_IOERR_TRUNCATE"; break;
1347 case SQLITE_IOERR_FSTAT
: zName
= "SQLITE_IOERR_FSTAT"; break;
1348 case SQLITE_IOERR_UNLOCK
: zName
= "SQLITE_IOERR_UNLOCK"; break;
1349 case SQLITE_IOERR_RDLOCK
: zName
= "SQLITE_IOERR_RDLOCK"; break;
1350 case SQLITE_IOERR_DELETE
: zName
= "SQLITE_IOERR_DELETE"; break;
1351 case SQLITE_IOERR_NOMEM
: zName
= "SQLITE_IOERR_NOMEM"; break;
1352 case SQLITE_IOERR_ACCESS
: zName
= "SQLITE_IOERR_ACCESS"; break;
1353 case SQLITE_IOERR_CHECKRESERVEDLOCK
:
1354 zName
= "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
1355 case SQLITE_IOERR_LOCK
: zName
= "SQLITE_IOERR_LOCK"; break;
1356 case SQLITE_IOERR_CLOSE
: zName
= "SQLITE_IOERR_CLOSE"; break;
1357 case SQLITE_IOERR_DIR_CLOSE
: zName
= "SQLITE_IOERR_DIR_CLOSE"; break;
1358 case SQLITE_IOERR_SHMOPEN
: zName
= "SQLITE_IOERR_SHMOPEN"; break;
1359 case SQLITE_IOERR_SHMSIZE
: zName
= "SQLITE_IOERR_SHMSIZE"; break;
1360 case SQLITE_IOERR_SHMLOCK
: zName
= "SQLITE_IOERR_SHMLOCK"; break;
1361 case SQLITE_IOERR_SHMMAP
: zName
= "SQLITE_IOERR_SHMMAP"; break;
1362 case SQLITE_IOERR_SEEK
: zName
= "SQLITE_IOERR_SEEK"; break;
1363 case SQLITE_IOERR_DELETE_NOENT
: zName
= "SQLITE_IOERR_DELETE_NOENT";break;
1364 case SQLITE_IOERR_MMAP
: zName
= "SQLITE_IOERR_MMAP"; break;
1365 case SQLITE_IOERR_GETTEMPPATH
: zName
= "SQLITE_IOERR_GETTEMPPATH"; break;
1366 case SQLITE_IOERR_CONVPATH
: zName
= "SQLITE_IOERR_CONVPATH"; break;
1367 case SQLITE_CORRUPT
: zName
= "SQLITE_CORRUPT"; break;
1368 case SQLITE_CORRUPT_VTAB
: zName
= "SQLITE_CORRUPT_VTAB"; break;
1369 case SQLITE_NOTFOUND
: zName
= "SQLITE_NOTFOUND"; break;
1370 case SQLITE_FULL
: zName
= "SQLITE_FULL"; break;
1371 case SQLITE_CANTOPEN
: zName
= "SQLITE_CANTOPEN"; break;
1372 case SQLITE_CANTOPEN_NOTEMPDIR
: zName
= "SQLITE_CANTOPEN_NOTEMPDIR";break;
1373 case SQLITE_CANTOPEN_ISDIR
: zName
= "SQLITE_CANTOPEN_ISDIR"; break;
1374 case SQLITE_CANTOPEN_FULLPATH
: zName
= "SQLITE_CANTOPEN_FULLPATH"; break;
1375 case SQLITE_CANTOPEN_CONVPATH
: zName
= "SQLITE_CANTOPEN_CONVPATH"; break;
1376 case SQLITE_PROTOCOL
: zName
= "SQLITE_PROTOCOL"; break;
1377 case SQLITE_EMPTY
: zName
= "SQLITE_EMPTY"; break;
1378 case SQLITE_SCHEMA
: zName
= "SQLITE_SCHEMA"; break;
1379 case SQLITE_TOOBIG
: zName
= "SQLITE_TOOBIG"; break;
1380 case SQLITE_CONSTRAINT
: zName
= "SQLITE_CONSTRAINT"; break;
1381 case SQLITE_CONSTRAINT_UNIQUE
: zName
= "SQLITE_CONSTRAINT_UNIQUE"; break;
1382 case SQLITE_CONSTRAINT_TRIGGER
: zName
= "SQLITE_CONSTRAINT_TRIGGER";break;
1383 case SQLITE_CONSTRAINT_FOREIGNKEY
:
1384 zName
= "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
1385 case SQLITE_CONSTRAINT_CHECK
: zName
= "SQLITE_CONSTRAINT_CHECK"; break;
1386 case SQLITE_CONSTRAINT_PRIMARYKEY
:
1387 zName
= "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
1388 case SQLITE_CONSTRAINT_NOTNULL
: zName
= "SQLITE_CONSTRAINT_NOTNULL";break;
1389 case SQLITE_CONSTRAINT_COMMITHOOK
:
1390 zName
= "SQLITE_CONSTRAINT_COMMITHOOK"; break;
1391 case SQLITE_CONSTRAINT_VTAB
: zName
= "SQLITE_CONSTRAINT_VTAB"; break;
1392 case SQLITE_CONSTRAINT_FUNCTION
:
1393 zName
= "SQLITE_CONSTRAINT_FUNCTION"; break;
1394 case SQLITE_CONSTRAINT_ROWID
: zName
= "SQLITE_CONSTRAINT_ROWID"; break;
1395 case SQLITE_MISMATCH
: zName
= "SQLITE_MISMATCH"; break;
1396 case SQLITE_MISUSE
: zName
= "SQLITE_MISUSE"; break;
1397 case SQLITE_NOLFS
: zName
= "SQLITE_NOLFS"; break;
1398 case SQLITE_AUTH
: zName
= "SQLITE_AUTH"; break;
1399 case SQLITE_FORMAT
: zName
= "SQLITE_FORMAT"; break;
1400 case SQLITE_RANGE
: zName
= "SQLITE_RANGE"; break;
1401 case SQLITE_NOTADB
: zName
= "SQLITE_NOTADB"; break;
1402 case SQLITE_ROW
: zName
= "SQLITE_ROW"; break;
1403 case SQLITE_NOTICE
: zName
= "SQLITE_NOTICE"; break;
1404 case SQLITE_NOTICE_RECOVER_WAL
: zName
= "SQLITE_NOTICE_RECOVER_WAL";break;
1405 case SQLITE_NOTICE_RECOVER_ROLLBACK
:
1406 zName
= "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
1407 case SQLITE_WARNING
: zName
= "SQLITE_WARNING"; break;
1408 case SQLITE_WARNING_AUTOINDEX
: zName
= "SQLITE_WARNING_AUTOINDEX"; break;
1409 case SQLITE_DONE
: zName
= "SQLITE_DONE"; break;
1413 static char zBuf
[50];
1414 sqlite3_snprintf(sizeof(zBuf
), zBuf
, "SQLITE_UNKNOWN(%d)", origRc
);
1422 ** Return a static string that describes the kind of error specified in the
1425 const char *sqlite3ErrStr(int rc
){
1426 static const char* const aMsg
[] = {
1427 /* SQLITE_OK */ "not an error",
1428 /* SQLITE_ERROR */ "SQL logic error",
1429 /* SQLITE_INTERNAL */ 0,
1430 /* SQLITE_PERM */ "access permission denied",
1431 /* SQLITE_ABORT */ "query aborted",
1432 /* SQLITE_BUSY */ "database is locked",
1433 /* SQLITE_LOCKED */ "database table is locked",
1434 /* SQLITE_NOMEM */ "out of memory",
1435 /* SQLITE_READONLY */ "attempt to write a readonly database",
1436 /* SQLITE_INTERRUPT */ "interrupted",
1437 /* SQLITE_IOERR */ "disk I/O error",
1438 /* SQLITE_CORRUPT */ "database disk image is malformed",
1439 /* SQLITE_NOTFOUND */ "unknown operation",
1440 /* SQLITE_FULL */ "database or disk is full",
1441 /* SQLITE_CANTOPEN */ "unable to open database file",
1442 /* SQLITE_PROTOCOL */ "locking protocol",
1443 /* SQLITE_EMPTY */ 0,
1444 /* SQLITE_SCHEMA */ "database schema has changed",
1445 /* SQLITE_TOOBIG */ "string or blob too big",
1446 /* SQLITE_CONSTRAINT */ "constraint failed",
1447 /* SQLITE_MISMATCH */ "datatype mismatch",
1448 /* SQLITE_MISUSE */ "bad parameter or other API misuse",
1449 #ifdef SQLITE_DISABLE_LFS
1450 /* SQLITE_NOLFS */ "large file support is disabled",
1452 /* SQLITE_NOLFS */ 0,
1454 /* SQLITE_AUTH */ "authorization denied",
1455 /* SQLITE_FORMAT */ 0,
1456 /* SQLITE_RANGE */ "column index out of range",
1457 /* SQLITE_NOTADB */ "file is not a database",
1458 /* SQLITE_NOTICE */ "notification message",
1459 /* SQLITE_WARNING */ "warning message",
1461 const char *zErr
= "unknown error";
1463 case SQLITE_ABORT_ROLLBACK
: {
1464 zErr
= "abort due to ROLLBACK";
1468 zErr
= "another row available";
1472 zErr
= "no more rows available";
1477 if( ALWAYS(rc
>=0) && rc
<ArraySize(aMsg
) && aMsg
[rc
]!=0 ){
1487 ** This routine implements a busy callback that sleeps and tries
1488 ** again until a timeout value is reached. The timeout value is
1489 ** an integer number of milliseconds passed in as the first
1492 ** Return non-zero to retry the lock. Return zero to stop trying
1493 ** and cause SQLite to return SQLITE_BUSY.
1495 static int sqliteDefaultBusyCallback(
1496 void *ptr
, /* Database connection */
1497 int count
, /* Number of times table has been busy */
1498 sqlite3_file
*pFile
/* The file on which the lock occurred */
1500 #if SQLITE_OS_WIN || HAVE_USLEEP
1501 /* This case is for systems that have support for sleeping for fractions of
1502 ** a second. Examples: All windows systems, unix systems with usleep() */
1503 static const u8 delays
[] =
1504 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
1505 static const u8 totals
[] =
1506 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
1507 # define NDELAY ArraySize(delays)
1508 sqlite3
*db
= (sqlite3
*)ptr
;
1509 int tmout
= db
->busyTimeout
;
1512 #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
1513 if( sqlite3OsFileControl(pFile
,SQLITE_FCNTL_LOCK_TIMEOUT
,&tmout
)==SQLITE_OK
){
1516 sqlite3OsFileControl(pFile
, SQLITE_FCNTL_LOCK_TIMEOUT
, &tmout
);
1523 UNUSED_PARAMETER(pFile
);
1526 if( count
< NDELAY
){
1527 delay
= delays
[count
];
1528 prior
= totals
[count
];
1530 delay
= delays
[NDELAY
-1];
1531 prior
= totals
[NDELAY
-1] + delay
*(count
-(NDELAY
-1));
1533 if( prior
+ delay
> tmout
){
1534 delay
= tmout
- prior
;
1535 if( delay
<=0 ) return 0;
1537 sqlite3OsSleep(db
->pVfs
, delay
*1000);
1540 /* This case for unix systems that lack usleep() support. Sleeping
1541 ** must be done in increments of whole seconds */
1542 sqlite3
*db
= (sqlite3
*)ptr
;
1543 int tmout
= ((sqlite3
*)ptr
)->busyTimeout
;
1544 UNUSED_PARAMETER(pFile
);
1545 if( (count
+1)*1000 > tmout
){
1548 sqlite3OsSleep(db
->pVfs
, 1000000);
1554 ** Invoke the given busy handler.
1556 ** This routine is called when an operation failed to acquire a
1557 ** lock on VFS file pFile.
1559 ** If this routine returns non-zero, the lock is retried. If it
1560 ** returns 0, the operation aborts with an SQLITE_BUSY error.
1562 int sqlite3InvokeBusyHandler(BusyHandler
*p
, sqlite3_file
*pFile
){
1564 if( p
->xBusyHandler
==0 || p
->nBusy
<0 ) return 0;
1565 if( p
->bExtraFileArg
){
1566 /* Add an extra parameter with the pFile pointer to the end of the
1567 ** callback argument list */
1568 int (*xTra
)(void*,int,sqlite3_file
*);
1569 xTra
= (int(*)(void*,int,sqlite3_file
*))p
->xBusyHandler
;
1570 rc
= xTra(p
->pBusyArg
, p
->nBusy
, pFile
);
1572 /* Legacy style busy handler callback */
1573 rc
= p
->xBusyHandler(p
->pBusyArg
, p
->nBusy
);
1584 ** This routine sets the busy callback for an Sqlite database to the
1585 ** given callback function with the given argument.
1587 int sqlite3_busy_handler(
1589 int (*xBusy
)(void*,int),
1592 #ifdef SQLITE_ENABLE_API_ARMOR
1593 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
1595 sqlite3_mutex_enter(db
->mutex
);
1596 db
->busyHandler
.xBusyHandler
= xBusy
;
1597 db
->busyHandler
.pBusyArg
= pArg
;
1598 db
->busyHandler
.nBusy
= 0;
1599 db
->busyHandler
.bExtraFileArg
= 0;
1600 db
->busyTimeout
= 0;
1601 sqlite3_mutex_leave(db
->mutex
);
1605 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1607 ** This routine sets the progress callback for an Sqlite database to the
1608 ** given callback function with the given argument. The progress callback will
1609 ** be invoked every nOps opcodes.
1611 void sqlite3_progress_handler(
1614 int (*xProgress
)(void*),
1617 #ifdef SQLITE_ENABLE_API_ARMOR
1618 if( !sqlite3SafetyCheckOk(db
) ){
1619 (void)SQLITE_MISUSE_BKPT
;
1623 sqlite3_mutex_enter(db
->mutex
);
1625 db
->xProgress
= xProgress
;
1626 db
->nProgressOps
= (unsigned)nOps
;
1627 db
->pProgressArg
= pArg
;
1630 db
->nProgressOps
= 0;
1631 db
->pProgressArg
= 0;
1633 sqlite3_mutex_leave(db
->mutex
);
1639 ** This routine installs a default busy handler that waits for the
1640 ** specified number of milliseconds before returning 0.
1642 int sqlite3_busy_timeout(sqlite3
*db
, int ms
){
1643 #ifdef SQLITE_ENABLE_API_ARMOR
1644 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
1647 sqlite3_busy_handler(db
, (int(*)(void*,int))sqliteDefaultBusyCallback
,
1649 db
->busyTimeout
= ms
;
1650 db
->busyHandler
.bExtraFileArg
= 1;
1652 sqlite3_busy_handler(db
, 0, 0);
1658 ** Cause any pending operation to stop at its earliest opportunity.
1660 void sqlite3_interrupt(sqlite3
*db
){
1661 #ifdef SQLITE_ENABLE_API_ARMOR
1662 if( !sqlite3SafetyCheckOk(db
) && (db
==0 || db
->magic
!=SQLITE_MAGIC_ZOMBIE
) ){
1663 (void)SQLITE_MISUSE_BKPT
;
1667 db
->u1
.isInterrupted
= 1;
1672 ** This function is exactly the same as sqlite3_create_function(), except
1673 ** that it is designed to be called by internal code. The difference is
1674 ** that if a malloc() fails in sqlite3_create_function(), an error code
1675 ** is returned and the mallocFailed flag cleared.
1677 int sqlite3CreateFunc(
1679 const char *zFunctionName
,
1683 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1684 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1685 void (*xFinal
)(sqlite3_context
*),
1686 void (*xValue
)(sqlite3_context
*),
1687 void (*xInverse
)(sqlite3_context
*,int,sqlite3_value
**),
1688 FuncDestructor
*pDestructor
1694 assert( sqlite3_mutex_held(db
->mutex
) );
1695 assert( xValue
==0 || xSFunc
==0 );
1696 if( zFunctionName
==0 /* Must have a valid name */
1697 || (xSFunc
!=0 && xFinal
!=0) /* Not both xSFunc and xFinal */
1698 || ((xFinal
==0)!=(xStep
==0)) /* Both or neither of xFinal and xStep */
1699 || ((xValue
==0)!=(xInverse
==0)) /* Both or neither of xValue, xInverse */
1700 || (nArg
<-1 || nArg
>SQLITE_MAX_FUNCTION_ARG
)
1701 || (255<(nName
= sqlite3Strlen30( zFunctionName
)))
1703 return SQLITE_MISUSE_BKPT
;
1706 assert( SQLITE_FUNC_CONSTANT
==SQLITE_DETERMINISTIC
);
1707 extraFlags
= enc
& SQLITE_DETERMINISTIC
;
1708 enc
&= (SQLITE_FUNC_ENCMASK
|SQLITE_ANY
);
1710 #ifndef SQLITE_OMIT_UTF16
1711 /* If SQLITE_UTF16 is specified as the encoding type, transform this
1712 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
1713 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
1715 ** If SQLITE_ANY is specified, add three versions of the function
1716 ** to the hash table.
1718 if( enc
==SQLITE_UTF16
){
1719 enc
= SQLITE_UTF16NATIVE
;
1720 }else if( enc
==SQLITE_ANY
){
1722 rc
= sqlite3CreateFunc(db
, zFunctionName
, nArg
, SQLITE_UTF8
|extraFlags
,
1723 pUserData
, xSFunc
, xStep
, xFinal
, xValue
, xInverse
, pDestructor
);
1724 if( rc
==SQLITE_OK
){
1725 rc
= sqlite3CreateFunc(db
, zFunctionName
, nArg
, SQLITE_UTF16LE
|extraFlags
,
1726 pUserData
, xSFunc
, xStep
, xFinal
, xValue
, xInverse
, pDestructor
);
1728 if( rc
!=SQLITE_OK
){
1731 enc
= SQLITE_UTF16BE
;
1737 /* Check if an existing function is being overridden or deleted. If so,
1738 ** and there are active VMs, then return SQLITE_BUSY. If a function
1739 ** is being overridden/deleted but there are no active VMs, allow the
1740 ** operation to continue but invalidate all precompiled statements.
1742 p
= sqlite3FindFunction(db
, zFunctionName
, nArg
, (u8
)enc
, 0);
1743 if( p
&& (p
->funcFlags
& SQLITE_FUNC_ENCMASK
)==(u32
)enc
&& p
->nArg
==nArg
){
1744 if( db
->nVdbeActive
){
1745 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
,
1746 "unable to delete/modify user-function due to active statements");
1747 assert( !db
->mallocFailed
);
1750 sqlite3ExpirePreparedStatements(db
);
1754 p
= sqlite3FindFunction(db
, zFunctionName
, nArg
, (u8
)enc
, 1);
1755 assert(p
|| db
->mallocFailed
);
1757 return SQLITE_NOMEM_BKPT
;
1760 /* If an older version of the function with a configured destructor is
1761 ** being replaced invoke the destructor function here. */
1762 functionDestroy(db
, p
);
1765 pDestructor
->nRef
++;
1767 p
->u
.pDestructor
= pDestructor
;
1768 p
->funcFlags
= (p
->funcFlags
& SQLITE_FUNC_ENCMASK
) | extraFlags
;
1769 testcase( p
->funcFlags
& SQLITE_DETERMINISTIC
);
1770 p
->xSFunc
= xSFunc
? xSFunc
: xStep
;
1771 p
->xFinalize
= xFinal
;
1773 p
->xInverse
= xInverse
;
1774 p
->pUserData
= pUserData
;
1775 p
->nArg
= (u16
)nArg
;
1780 ** Worker function used by utf-8 APIs that create new functions:
1782 ** sqlite3_create_function()
1783 ** sqlite3_create_function_v2()
1784 ** sqlite3_create_window_function()
1786 static int createFunctionApi(
1792 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1793 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1794 void (*xFinal
)(sqlite3_context
*),
1795 void (*xValue
)(sqlite3_context
*),
1796 void (*xInverse
)(sqlite3_context
*,int,sqlite3_value
**),
1797 void(*xDestroy
)(void*)
1799 int rc
= SQLITE_ERROR
;
1800 FuncDestructor
*pArg
= 0;
1802 #ifdef SQLITE_ENABLE_API_ARMOR
1803 if( !sqlite3SafetyCheckOk(db
) ){
1804 return SQLITE_MISUSE_BKPT
;
1807 sqlite3_mutex_enter(db
->mutex
);
1809 pArg
= (FuncDestructor
*)sqlite3Malloc(sizeof(FuncDestructor
));
1811 sqlite3OomFault(db
);
1816 pArg
->xDestroy
= xDestroy
;
1817 pArg
->pUserData
= p
;
1819 rc
= sqlite3CreateFunc(db
, zFunc
, nArg
, enc
, p
,
1820 xSFunc
, xStep
, xFinal
, xValue
, xInverse
, pArg
1822 if( pArg
&& pArg
->nRef
==0 ){
1823 assert( rc
!=SQLITE_OK
);
1829 rc
= sqlite3ApiExit(db
, rc
);
1830 sqlite3_mutex_leave(db
->mutex
);
1835 ** Create new user functions.
1837 int sqlite3_create_function(
1843 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1844 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1845 void (*xFinal
)(sqlite3_context
*)
1847 return createFunctionApi(db
, zFunc
, nArg
, enc
, p
, xSFunc
, xStep
,
1850 int sqlite3_create_function_v2(
1856 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1857 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1858 void (*xFinal
)(sqlite3_context
*),
1859 void (*xDestroy
)(void *)
1861 return createFunctionApi(db
, zFunc
, nArg
, enc
, p
, xSFunc
, xStep
,
1862 xFinal
, 0, 0, xDestroy
);
1864 int sqlite3_create_window_function(
1870 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1871 void (*xFinal
)(sqlite3_context
*),
1872 void (*xValue
)(sqlite3_context
*),
1873 void (*xInverse
)(sqlite3_context
*,int,sqlite3_value
**),
1874 void (*xDestroy
)(void *)
1876 return createFunctionApi(db
, zFunc
, nArg
, enc
, p
, 0, xStep
,
1877 xFinal
, xValue
, xInverse
, xDestroy
);
1880 #ifndef SQLITE_OMIT_UTF16
1881 int sqlite3_create_function16(
1883 const void *zFunctionName
,
1887 void (*xSFunc
)(sqlite3_context
*,int,sqlite3_value
**),
1888 void (*xStep
)(sqlite3_context
*,int,sqlite3_value
**),
1889 void (*xFinal
)(sqlite3_context
*)
1894 #ifdef SQLITE_ENABLE_API_ARMOR
1895 if( !sqlite3SafetyCheckOk(db
) || zFunctionName
==0 ) return SQLITE_MISUSE_BKPT
;
1897 sqlite3_mutex_enter(db
->mutex
);
1898 assert( !db
->mallocFailed
);
1899 zFunc8
= sqlite3Utf16to8(db
, zFunctionName
, -1, SQLITE_UTF16NATIVE
);
1900 rc
= sqlite3CreateFunc(db
, zFunc8
, nArg
, eTextRep
, p
, xSFunc
,xStep
,xFinal
,0,0,0);
1901 sqlite3DbFree(db
, zFunc8
);
1902 rc
= sqlite3ApiExit(db
, rc
);
1903 sqlite3_mutex_leave(db
->mutex
);
1910 ** The following is the implementation of an SQL function that always
1911 ** fails with an error message stating that the function is used in the
1912 ** wrong context. The sqlite3_overload_function() API might construct
1913 ** SQL function that use this routine so that the functions will exist
1914 ** for name resolution but are actually overloaded by the xFindFunction
1915 ** method of virtual tables.
1917 static void sqlite3InvalidFunction(
1918 sqlite3_context
*context
, /* The function calling context */
1919 int NotUsed
, /* Number of arguments to the function */
1920 sqlite3_value
**NotUsed2
/* Value of each argument */
1922 const char *zName
= (const char*)sqlite3_user_data(context
);
1924 UNUSED_PARAMETER2(NotUsed
, NotUsed2
);
1925 zErr
= sqlite3_mprintf(
1926 "unable to use function %s in the requested context", zName
);
1927 sqlite3_result_error(context
, zErr
, -1);
1932 ** Declare that a function has been overloaded by a virtual table.
1934 ** If the function already exists as a regular global function, then
1935 ** this routine is a no-op. If the function does not exist, then create
1936 ** a new one that always throws a run-time error.
1938 ** When virtual tables intend to provide an overloaded function, they
1939 ** should call this routine to make sure the global function exists.
1940 ** A global function must exist in order for name resolution to work
1943 int sqlite3_overload_function(
1951 #ifdef SQLITE_ENABLE_API_ARMOR
1952 if( !sqlite3SafetyCheckOk(db
) || zName
==0 || nArg
<-2 ){
1953 return SQLITE_MISUSE_BKPT
;
1956 sqlite3_mutex_enter(db
->mutex
);
1957 rc
= sqlite3FindFunction(db
, zName
, nArg
, SQLITE_UTF8
, 0)!=0;
1958 sqlite3_mutex_leave(db
->mutex
);
1959 if( rc
) return SQLITE_OK
;
1960 zCopy
= sqlite3_mprintf(zName
);
1961 if( zCopy
==0 ) return SQLITE_NOMEM
;
1962 return sqlite3_create_function_v2(db
, zName
, nArg
, SQLITE_UTF8
,
1963 zCopy
, sqlite3InvalidFunction
, 0, 0, sqlite3_free
);
1966 #ifndef SQLITE_OMIT_TRACE
1968 ** Register a trace function. The pArg from the previously registered trace
1971 ** A NULL trace function means that no tracing is executes. A non-NULL
1972 ** trace is a pointer to a function that is invoked at the start of each
1975 #ifndef SQLITE_OMIT_DEPRECATED
1976 void *sqlite3_trace(sqlite3
*db
, void(*xTrace
)(void*,const char*), void *pArg
){
1979 #ifdef SQLITE_ENABLE_API_ARMOR
1980 if( !sqlite3SafetyCheckOk(db
) ){
1981 (void)SQLITE_MISUSE_BKPT
;
1985 sqlite3_mutex_enter(db
->mutex
);
1986 pOld
= db
->pTraceArg
;
1987 db
->mTrace
= xTrace
? SQLITE_TRACE_LEGACY
: 0;
1988 db
->xTrace
= (int(*)(u32
,void*,void*,void*))xTrace
;
1989 db
->pTraceArg
= pArg
;
1990 sqlite3_mutex_leave(db
->mutex
);
1993 #endif /* SQLITE_OMIT_DEPRECATED */
1995 /* Register a trace callback using the version-2 interface.
1997 int sqlite3_trace_v2(
1998 sqlite3
*db
, /* Trace this connection */
1999 unsigned mTrace
, /* Mask of events to be traced */
2000 int(*xTrace
)(unsigned,void*,void*,void*), /* Callback to invoke */
2001 void *pArg
/* Context */
2003 #ifdef SQLITE_ENABLE_API_ARMOR
2004 if( !sqlite3SafetyCheckOk(db
) ){
2005 return SQLITE_MISUSE_BKPT
;
2008 sqlite3_mutex_enter(db
->mutex
);
2009 if( mTrace
==0 ) xTrace
= 0;
2010 if( xTrace
==0 ) mTrace
= 0;
2011 db
->mTrace
= mTrace
;
2012 db
->xTrace
= xTrace
;
2013 db
->pTraceArg
= pArg
;
2014 sqlite3_mutex_leave(db
->mutex
);
2018 #ifndef SQLITE_OMIT_DEPRECATED
2020 ** Register a profile function. The pArg from the previously registered
2021 ** profile function is returned.
2023 ** A NULL profile function means that no profiling is executes. A non-NULL
2024 ** profile is a pointer to a function that is invoked at the conclusion of
2025 ** each SQL statement that is run.
2027 void *sqlite3_profile(
2029 void (*xProfile
)(void*,const char*,sqlite_uint64
),
2034 #ifdef SQLITE_ENABLE_API_ARMOR
2035 if( !sqlite3SafetyCheckOk(db
) ){
2036 (void)SQLITE_MISUSE_BKPT
;
2040 sqlite3_mutex_enter(db
->mutex
);
2041 pOld
= db
->pProfileArg
;
2042 db
->xProfile
= xProfile
;
2043 db
->pProfileArg
= pArg
;
2044 sqlite3_mutex_leave(db
->mutex
);
2047 #endif /* SQLITE_OMIT_DEPRECATED */
2048 #endif /* SQLITE_OMIT_TRACE */
2051 ** Register a function to be invoked when a transaction commits.
2052 ** If the invoked function returns non-zero, then the commit becomes a
2055 void *sqlite3_commit_hook(
2056 sqlite3
*db
, /* Attach the hook to this database */
2057 int (*xCallback
)(void*), /* Function to invoke on each commit */
2058 void *pArg
/* Argument to the function */
2062 #ifdef SQLITE_ENABLE_API_ARMOR
2063 if( !sqlite3SafetyCheckOk(db
) ){
2064 (void)SQLITE_MISUSE_BKPT
;
2068 sqlite3_mutex_enter(db
->mutex
);
2069 pOld
= db
->pCommitArg
;
2070 db
->xCommitCallback
= xCallback
;
2071 db
->pCommitArg
= pArg
;
2072 sqlite3_mutex_leave(db
->mutex
);
2077 ** Register a callback to be invoked each time a row is updated,
2078 ** inserted or deleted using this database connection.
2080 void *sqlite3_update_hook(
2081 sqlite3
*db
, /* Attach the hook to this database */
2082 void (*xCallback
)(void*,int,char const *,char const *,sqlite_int64
),
2083 void *pArg
/* Argument to the function */
2087 #ifdef SQLITE_ENABLE_API_ARMOR
2088 if( !sqlite3SafetyCheckOk(db
) ){
2089 (void)SQLITE_MISUSE_BKPT
;
2093 sqlite3_mutex_enter(db
->mutex
);
2094 pRet
= db
->pUpdateArg
;
2095 db
->xUpdateCallback
= xCallback
;
2096 db
->pUpdateArg
= pArg
;
2097 sqlite3_mutex_leave(db
->mutex
);
2102 ** Register a callback to be invoked each time a transaction is rolled
2103 ** back by this database connection.
2105 void *sqlite3_rollback_hook(
2106 sqlite3
*db
, /* Attach the hook to this database */
2107 void (*xCallback
)(void*), /* Callback function */
2108 void *pArg
/* Argument to the function */
2112 #ifdef SQLITE_ENABLE_API_ARMOR
2113 if( !sqlite3SafetyCheckOk(db
) ){
2114 (void)SQLITE_MISUSE_BKPT
;
2118 sqlite3_mutex_enter(db
->mutex
);
2119 pRet
= db
->pRollbackArg
;
2120 db
->xRollbackCallback
= xCallback
;
2121 db
->pRollbackArg
= pArg
;
2122 sqlite3_mutex_leave(db
->mutex
);
2126 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
2128 ** Register a callback to be invoked each time a row is updated,
2129 ** inserted or deleted using this database connection.
2131 void *sqlite3_preupdate_hook(
2132 sqlite3
*db
, /* Attach the hook to this database */
2133 void(*xCallback
)( /* Callback function */
2134 void*,sqlite3
*,int,char const*,char const*,sqlite3_int64
,sqlite3_int64
),
2135 void *pArg
/* First callback argument */
2138 sqlite3_mutex_enter(db
->mutex
);
2139 pRet
= db
->pPreUpdateArg
;
2140 db
->xPreUpdateCallback
= xCallback
;
2141 db
->pPreUpdateArg
= pArg
;
2142 sqlite3_mutex_leave(db
->mutex
);
2145 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
2147 #ifndef SQLITE_OMIT_WAL
2149 ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
2150 ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
2151 ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
2152 ** wal_autocheckpoint()).
2154 int sqlite3WalDefaultHook(
2155 void *pClientData
, /* Argument */
2156 sqlite3
*db
, /* Connection */
2157 const char *zDb
, /* Database */
2158 int nFrame
/* Size of WAL */
2160 if( nFrame
>=SQLITE_PTR_TO_INT(pClientData
) ){
2161 sqlite3BeginBenignMalloc();
2162 sqlite3_wal_checkpoint(db
, zDb
);
2163 sqlite3EndBenignMalloc();
2167 #endif /* SQLITE_OMIT_WAL */
2170 ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
2171 ** a database after committing a transaction if there are nFrame or
2172 ** more frames in the log file. Passing zero or a negative value as the
2173 ** nFrame parameter disables automatic checkpoints entirely.
2175 ** The callback registered by this function replaces any existing callback
2176 ** registered using sqlite3_wal_hook(). Likewise, registering a callback
2177 ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
2178 ** configured by this function.
2180 int sqlite3_wal_autocheckpoint(sqlite3
*db
, int nFrame
){
2181 #ifdef SQLITE_OMIT_WAL
2182 UNUSED_PARAMETER(db
);
2183 UNUSED_PARAMETER(nFrame
);
2185 #ifdef SQLITE_ENABLE_API_ARMOR
2186 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
2189 sqlite3_wal_hook(db
, sqlite3WalDefaultHook
, SQLITE_INT_TO_PTR(nFrame
));
2191 sqlite3_wal_hook(db
, 0, 0);
2198 ** Register a callback to be invoked each time a transaction is written
2199 ** into the write-ahead-log by this database connection.
2201 void *sqlite3_wal_hook(
2202 sqlite3
*db
, /* Attach the hook to this db handle */
2203 int(*xCallback
)(void *, sqlite3
*, const char*, int),
2204 void *pArg
/* First argument passed to xCallback() */
2206 #ifndef SQLITE_OMIT_WAL
2208 #ifdef SQLITE_ENABLE_API_ARMOR
2209 if( !sqlite3SafetyCheckOk(db
) ){
2210 (void)SQLITE_MISUSE_BKPT
;
2214 sqlite3_mutex_enter(db
->mutex
);
2216 db
->xWalCallback
= xCallback
;
2218 sqlite3_mutex_leave(db
->mutex
);
2226 ** Checkpoint database zDb.
2228 int sqlite3_wal_checkpoint_v2(
2229 sqlite3
*db
, /* Database handle */
2230 const char *zDb
, /* Name of attached database (or NULL) */
2231 int eMode
, /* SQLITE_CHECKPOINT_* value */
2232 int *pnLog
, /* OUT: Size of WAL log in frames */
2233 int *pnCkpt
/* OUT: Total number of frames checkpointed */
2235 #ifdef SQLITE_OMIT_WAL
2238 int rc
; /* Return code */
2239 int iDb
= SQLITE_MAX_ATTACHED
; /* sqlite3.aDb[] index of db to checkpoint */
2241 #ifdef SQLITE_ENABLE_API_ARMOR
2242 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
2245 /* Initialize the output variables to -1 in case an error occurs. */
2246 if( pnLog
) *pnLog
= -1;
2247 if( pnCkpt
) *pnCkpt
= -1;
2249 assert( SQLITE_CHECKPOINT_PASSIVE
==0 );
2250 assert( SQLITE_CHECKPOINT_FULL
==1 );
2251 assert( SQLITE_CHECKPOINT_RESTART
==2 );
2252 assert( SQLITE_CHECKPOINT_TRUNCATE
==3 );
2253 if( eMode
<SQLITE_CHECKPOINT_PASSIVE
|| eMode
>SQLITE_CHECKPOINT_TRUNCATE
){
2254 /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
2256 return SQLITE_MISUSE
;
2259 sqlite3_mutex_enter(db
->mutex
);
2260 if( zDb
&& zDb
[0] ){
2261 iDb
= sqlite3FindDbName(db
, zDb
);
2265 sqlite3ErrorWithMsg(db
, SQLITE_ERROR
, "unknown database: %s", zDb
);
2267 db
->busyHandler
.nBusy
= 0;
2268 rc
= sqlite3Checkpoint(db
, iDb
, eMode
, pnLog
, pnCkpt
);
2269 sqlite3Error(db
, rc
);
2271 rc
= sqlite3ApiExit(db
, rc
);
2273 /* If there are no active statements, clear the interrupt flag at this
2275 if( db
->nVdbeActive
==0 ){
2276 db
->u1
.isInterrupted
= 0;
2279 sqlite3_mutex_leave(db
->mutex
);
2286 ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
2287 ** to contains a zero-length string, all attached databases are
2290 int sqlite3_wal_checkpoint(sqlite3
*db
, const char *zDb
){
2291 /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
2292 ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
2293 return sqlite3_wal_checkpoint_v2(db
,zDb
,SQLITE_CHECKPOINT_PASSIVE
,0,0);
2296 #ifndef SQLITE_OMIT_WAL
2298 ** Run a checkpoint on database iDb. This is a no-op if database iDb is
2299 ** not currently open in WAL mode.
2301 ** If a transaction is open on the database being checkpointed, this
2302 ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
2303 ** an error occurs while running the checkpoint, an SQLite error code is
2304 ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
2306 ** The mutex on database handle db should be held by the caller. The mutex
2307 ** associated with the specific b-tree being checkpointed is taken by
2308 ** this function while the checkpoint is running.
2310 ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
2311 ** checkpointed. If an error is encountered it is returned immediately -
2312 ** no attempt is made to checkpoint any remaining databases.
2314 ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
2317 int sqlite3Checkpoint(sqlite3
*db
, int iDb
, int eMode
, int *pnLog
, int *pnCkpt
){
2318 int rc
= SQLITE_OK
; /* Return code */
2319 int i
; /* Used to iterate through attached dbs */
2320 int bBusy
= 0; /* True if SQLITE_BUSY has been encountered */
2322 assert( sqlite3_mutex_held(db
->mutex
) );
2323 assert( !pnLog
|| *pnLog
==-1 );
2324 assert( !pnCkpt
|| *pnCkpt
==-1 );
2326 for(i
=0; i
<db
->nDb
&& rc
==SQLITE_OK
; i
++){
2327 if( i
==iDb
|| iDb
==SQLITE_MAX_ATTACHED
){
2328 rc
= sqlite3BtreeCheckpoint(db
->aDb
[i
].pBt
, eMode
, pnLog
, pnCkpt
);
2331 if( rc
==SQLITE_BUSY
){
2338 return (rc
==SQLITE_OK
&& bBusy
) ? SQLITE_BUSY
: rc
;
2340 #endif /* SQLITE_OMIT_WAL */
2343 ** This function returns true if main-memory should be used instead of
2344 ** a temporary file for transient pager files and statement journals.
2345 ** The value returned depends on the value of db->temp_store (runtime
2346 ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
2347 ** following table describes the relationship between these two values
2348 ** and this functions return value.
2350 ** SQLITE_TEMP_STORE db->temp_store Location of temporary database
2351 ** ----------------- -------------- ------------------------------
2352 ** 0 any file (return 0)
2353 ** 1 1 file (return 0)
2354 ** 1 2 memory (return 1)
2355 ** 1 0 file (return 0)
2356 ** 2 1 file (return 0)
2357 ** 2 2 memory (return 1)
2358 ** 2 0 memory (return 1)
2359 ** 3 any memory (return 1)
2361 int sqlite3TempInMemory(const sqlite3
*db
){
2362 #if SQLITE_TEMP_STORE==1
2363 return ( db
->temp_store
==2 );
2365 #if SQLITE_TEMP_STORE==2
2366 return ( db
->temp_store
!=1 );
2368 #if SQLITE_TEMP_STORE==3
2369 UNUSED_PARAMETER(db
);
2372 #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
2373 UNUSED_PARAMETER(db
);
2379 ** Return UTF-8 encoded English language explanation of the most recent
2382 const char *sqlite3_errmsg(sqlite3
*db
){
2385 return sqlite3ErrStr(SQLITE_NOMEM_BKPT
);
2387 if( !sqlite3SafetyCheckSickOrOk(db
) ){
2388 return sqlite3ErrStr(SQLITE_MISUSE_BKPT
);
2390 sqlite3_mutex_enter(db
->mutex
);
2391 if( db
->mallocFailed
){
2392 z
= sqlite3ErrStr(SQLITE_NOMEM_BKPT
);
2394 testcase( db
->pErr
==0 );
2395 z
= (char*)sqlite3_value_text(db
->pErr
);
2396 assert( !db
->mallocFailed
);
2398 z
= sqlite3ErrStr(db
->errCode
);
2401 sqlite3_mutex_leave(db
->mutex
);
2405 #ifndef SQLITE_OMIT_UTF16
2407 ** Return UTF-16 encoded English language explanation of the most recent
2410 const void *sqlite3_errmsg16(sqlite3
*db
){
2411 static const u16 outOfMem
[] = {
2412 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
2414 static const u16 misuse
[] = {
2415 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
2416 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
2417 'm', 'i', 's', 'u', 's', 'e', 0
2422 return (void *)outOfMem
;
2424 if( !sqlite3SafetyCheckSickOrOk(db
) ){
2425 return (void *)misuse
;
2427 sqlite3_mutex_enter(db
->mutex
);
2428 if( db
->mallocFailed
){
2429 z
= (void *)outOfMem
;
2431 z
= sqlite3_value_text16(db
->pErr
);
2433 sqlite3ErrorWithMsg(db
, db
->errCode
, sqlite3ErrStr(db
->errCode
));
2434 z
= sqlite3_value_text16(db
->pErr
);
2436 /* A malloc() may have failed within the call to sqlite3_value_text16()
2437 ** above. If this is the case, then the db->mallocFailed flag needs to
2438 ** be cleared before returning. Do this directly, instead of via
2439 ** sqlite3ApiExit(), to avoid setting the database handle error message.
2441 sqlite3OomClear(db
);
2443 sqlite3_mutex_leave(db
->mutex
);
2446 #endif /* SQLITE_OMIT_UTF16 */
2449 ** Return the most recent error code generated by an SQLite routine. If NULL is
2450 ** passed to this function, we assume a malloc() failed during sqlite3_open().
2452 int sqlite3_errcode(sqlite3
*db
){
2453 if( db
&& !sqlite3SafetyCheckSickOrOk(db
) ){
2454 return SQLITE_MISUSE_BKPT
;
2456 if( !db
|| db
->mallocFailed
){
2457 return SQLITE_NOMEM_BKPT
;
2459 return db
->errCode
& db
->errMask
;
2461 int sqlite3_extended_errcode(sqlite3
*db
){
2462 if( db
&& !sqlite3SafetyCheckSickOrOk(db
) ){
2463 return SQLITE_MISUSE_BKPT
;
2465 if( !db
|| db
->mallocFailed
){
2466 return SQLITE_NOMEM_BKPT
;
2470 int sqlite3_system_errno(sqlite3
*db
){
2471 return db
? db
->iSysErrno
: 0;
2475 ** Return a string that describes the kind of error specified in the
2476 ** argument. For now, this simply calls the internal sqlite3ErrStr()
2479 const char *sqlite3_errstr(int rc
){
2480 return sqlite3ErrStr(rc
);
2484 ** Create a new collating function for database "db". The name is zName
2485 ** and the encoding is enc.
2487 static int createCollation(
2492 int(*xCompare
)(void*,int,const void*,int,const void*),
2498 assert( sqlite3_mutex_held(db
->mutex
) );
2500 /* If SQLITE_UTF16 is specified as the encoding type, transform this
2501 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
2502 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
2505 testcase( enc2
==SQLITE_UTF16
);
2506 testcase( enc2
==SQLITE_UTF16_ALIGNED
);
2507 if( enc2
==SQLITE_UTF16
|| enc2
==SQLITE_UTF16_ALIGNED
){
2508 enc2
= SQLITE_UTF16NATIVE
;
2510 if( enc2
<SQLITE_UTF8
|| enc2
>SQLITE_UTF16BE
){
2511 return SQLITE_MISUSE_BKPT
;
2514 /* Check if this call is removing or replacing an existing collation
2515 ** sequence. If so, and there are active VMs, return busy. If there
2516 ** are no active VMs, invalidate any pre-compiled statements.
2518 pColl
= sqlite3FindCollSeq(db
, (u8
)enc2
, zName
, 0);
2519 if( pColl
&& pColl
->xCmp
){
2520 if( db
->nVdbeActive
){
2521 sqlite3ErrorWithMsg(db
, SQLITE_BUSY
,
2522 "unable to delete/modify collation sequence due to active statements");
2525 sqlite3ExpirePreparedStatements(db
);
2527 /* If collation sequence pColl was created directly by a call to
2528 ** sqlite3_create_collation, and not generated by synthCollSeq(),
2529 ** then any copies made by synthCollSeq() need to be invalidated.
2530 ** Also, collation destructor - CollSeq.xDel() - function may need
2533 if( (pColl
->enc
& ~SQLITE_UTF16_ALIGNED
)==enc2
){
2534 CollSeq
*aColl
= sqlite3HashFind(&db
->aCollSeq
, zName
);
2537 CollSeq
*p
= &aColl
[j
];
2538 if( p
->enc
==pColl
->enc
){
2548 pColl
= sqlite3FindCollSeq(db
, (u8
)enc2
, zName
, 1);
2549 if( pColl
==0 ) return SQLITE_NOMEM_BKPT
;
2550 pColl
->xCmp
= xCompare
;
2551 pColl
->pUser
= pCtx
;
2553 pColl
->enc
= (u8
)(enc2
| (enc
& SQLITE_UTF16_ALIGNED
));
2554 sqlite3Error(db
, SQLITE_OK
);
2560 ** This array defines hard upper bounds on limit values. The
2561 ** initializer must be kept in sync with the SQLITE_LIMIT_*
2562 ** #defines in sqlite3.h.
2564 static const int aHardLimit
[] = {
2566 SQLITE_MAX_SQL_LENGTH
,
2568 SQLITE_MAX_EXPR_DEPTH
,
2569 SQLITE_MAX_COMPOUND_SELECT
,
2571 SQLITE_MAX_FUNCTION_ARG
,
2572 SQLITE_MAX_ATTACHED
,
2573 SQLITE_MAX_LIKE_PATTERN_LENGTH
,
2574 SQLITE_MAX_VARIABLE_NUMBER
, /* IMP: R-38091-32352 */
2575 SQLITE_MAX_TRIGGER_DEPTH
,
2576 SQLITE_MAX_WORKER_THREADS
,
2580 ** Make sure the hard limits are set to reasonable values
2582 #if SQLITE_MAX_LENGTH<100
2583 # error SQLITE_MAX_LENGTH must be at least 100
2585 #if SQLITE_MAX_SQL_LENGTH<100
2586 # error SQLITE_MAX_SQL_LENGTH must be at least 100
2588 #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
2589 # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
2591 #if SQLITE_MAX_COMPOUND_SELECT<2
2592 # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
2594 #if SQLITE_MAX_VDBE_OP<40
2595 # error SQLITE_MAX_VDBE_OP must be at least 40
2597 #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
2598 # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
2600 #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
2601 # error SQLITE_MAX_ATTACHED must be between 0 and 125
2603 #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
2604 # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
2606 #if SQLITE_MAX_COLUMN>32767
2607 # error SQLITE_MAX_COLUMN must not exceed 32767
2609 #if SQLITE_MAX_TRIGGER_DEPTH<1
2610 # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
2612 #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
2613 # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
2618 ** Change the value of a limit. Report the old value.
2619 ** If an invalid limit index is supplied, report -1.
2620 ** Make no changes but still report the old value if the
2621 ** new limit is negative.
2623 ** A new lower limit does not shrink existing constructs.
2624 ** It merely prevents new constructs that exceed the limit
2627 int sqlite3_limit(sqlite3
*db
, int limitId
, int newLimit
){
2630 #ifdef SQLITE_ENABLE_API_ARMOR
2631 if( !sqlite3SafetyCheckOk(db
) ){
2632 (void)SQLITE_MISUSE_BKPT
;
2637 /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
2638 ** there is a hard upper bound set at compile-time by a C preprocessor
2639 ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
2642 assert( aHardLimit
[SQLITE_LIMIT_LENGTH
]==SQLITE_MAX_LENGTH
);
2643 assert( aHardLimit
[SQLITE_LIMIT_SQL_LENGTH
]==SQLITE_MAX_SQL_LENGTH
);
2644 assert( aHardLimit
[SQLITE_LIMIT_COLUMN
]==SQLITE_MAX_COLUMN
);
2645 assert( aHardLimit
[SQLITE_LIMIT_EXPR_DEPTH
]==SQLITE_MAX_EXPR_DEPTH
);
2646 assert( aHardLimit
[SQLITE_LIMIT_COMPOUND_SELECT
]==SQLITE_MAX_COMPOUND_SELECT
);
2647 assert( aHardLimit
[SQLITE_LIMIT_VDBE_OP
]==SQLITE_MAX_VDBE_OP
);
2648 assert( aHardLimit
[SQLITE_LIMIT_FUNCTION_ARG
]==SQLITE_MAX_FUNCTION_ARG
);
2649 assert( aHardLimit
[SQLITE_LIMIT_ATTACHED
]==SQLITE_MAX_ATTACHED
);
2650 assert( aHardLimit
[SQLITE_LIMIT_LIKE_PATTERN_LENGTH
]==
2651 SQLITE_MAX_LIKE_PATTERN_LENGTH
);
2652 assert( aHardLimit
[SQLITE_LIMIT_VARIABLE_NUMBER
]==SQLITE_MAX_VARIABLE_NUMBER
);
2653 assert( aHardLimit
[SQLITE_LIMIT_TRIGGER_DEPTH
]==SQLITE_MAX_TRIGGER_DEPTH
);
2654 assert( aHardLimit
[SQLITE_LIMIT_WORKER_THREADS
]==SQLITE_MAX_WORKER_THREADS
);
2655 assert( SQLITE_LIMIT_WORKER_THREADS
==(SQLITE_N_LIMIT
-1) );
2658 if( limitId
<0 || limitId
>=SQLITE_N_LIMIT
){
2661 oldLimit
= db
->aLimit
[limitId
];
2662 if( newLimit
>=0 ){ /* IMP: R-52476-28732 */
2663 if( newLimit
>aHardLimit
[limitId
] ){
2664 newLimit
= aHardLimit
[limitId
]; /* IMP: R-51463-25634 */
2666 db
->aLimit
[limitId
] = newLimit
;
2668 return oldLimit
; /* IMP: R-53341-35419 */
2672 ** This function is used to parse both URIs and non-URI filenames passed by the
2673 ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
2674 ** URIs specified as part of ATTACH statements.
2676 ** The first argument to this function is the name of the VFS to use (or
2677 ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
2678 ** query parameter. The second argument contains the URI (or non-URI filename)
2679 ** itself. When this function is called the *pFlags variable should contain
2680 ** the default flags to open the database handle with. The value stored in
2681 ** *pFlags may be updated before returning if the URI filename contains
2682 ** "cache=xxx" or "mode=xxx" query parameters.
2684 ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
2685 ** the VFS that should be used to open the database file. *pzFile is set to
2686 ** point to a buffer containing the name of the file to open. It is the
2687 ** responsibility of the caller to eventually call sqlite3_free() to release
2690 ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
2691 ** may be set to point to a buffer containing an English language error
2692 ** message. It is the responsibility of the caller to eventually release
2693 ** this buffer by calling sqlite3_free().
2695 int sqlite3ParseUri(
2696 const char *zDefaultVfs
, /* VFS to use if no "vfs=xxx" query option */
2697 const char *zUri
, /* Nul-terminated URI to parse */
2698 unsigned int *pFlags
, /* IN/OUT: SQLITE_OPEN_XXX flags */
2699 sqlite3_vfs
**ppVfs
, /* OUT: VFS to use */
2700 char **pzFile
, /* OUT: Filename component of URI */
2701 char **pzErrMsg
/* OUT: Error message (if rc!=SQLITE_OK) */
2704 unsigned int flags
= *pFlags
;
2705 const char *zVfs
= zDefaultVfs
;
2708 int nUri
= sqlite3Strlen30(zUri
);
2710 assert( *pzErrMsg
==0 );
2712 if( ((flags
& SQLITE_OPEN_URI
) /* IMP: R-48725-32206 */
2713 || sqlite3GlobalConfig
.bOpenUri
) /* IMP: R-51689-46548 */
2714 && nUri
>=5 && memcmp(zUri
, "file:", 5)==0 /* IMP: R-57884-37496 */
2717 int eState
; /* Parser state when parsing URI */
2718 int iIn
; /* Input character index */
2719 int iOut
= 0; /* Output character index */
2720 u64 nByte
= nUri
+2; /* Bytes of space to allocate */
2722 /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
2723 ** method that there may be extra parameters following the file-name. */
2724 flags
|= SQLITE_OPEN_URI
;
2726 for(iIn
=0; iIn
<nUri
; iIn
++) nByte
+= (zUri
[iIn
]=='&');
2727 zFile
= sqlite3_malloc64(nByte
);
2728 if( !zFile
) return SQLITE_NOMEM_BKPT
;
2731 #ifdef SQLITE_ALLOW_URI_AUTHORITY
2732 if( strncmp(zUri
+5, "///", 3)==0 ){
2734 /* The following condition causes URIs with five leading / characters
2735 ** like file://///host/path to be converted into UNCs like //host/path.
2736 ** The correct URI for that UNC has only two or four leading / characters
2737 ** file://host/path or file:////host/path. But 5 leading slashes is a
2738 ** common error, we are told, so we handle it as a special case. */
2739 if( strncmp(zUri
+7, "///", 3)==0 ){ iIn
++; }
2740 }else if( strncmp(zUri
+5, "//localhost/", 12)==0 ){
2744 /* Discard the scheme and authority segments of the URI. */
2745 if( zUri
[5]=='/' && zUri
[6]=='/' ){
2747 while( zUri
[iIn
] && zUri
[iIn
]!='/' ) iIn
++;
2748 if( iIn
!=7 && (iIn
!=16 || memcmp("localhost", &zUri
[7], 9)) ){
2749 *pzErrMsg
= sqlite3_mprintf("invalid uri authority: %.*s",
2757 /* Copy the filename and any query parameters into the zFile buffer.
2758 ** Decode %HH escape codes along the way.
2760 ** Within this loop, variable eState may be set to 0, 1 or 2, depending
2761 ** on the parsing context. As follows:
2763 ** 0: Parsing file-name.
2764 ** 1: Parsing name section of a name=value query parameter.
2765 ** 2: Parsing value section of a name=value query parameter.
2768 while( (c
= zUri
[iIn
])!=0 && c
!='#' ){
2771 && sqlite3Isxdigit(zUri
[iIn
])
2772 && sqlite3Isxdigit(zUri
[iIn
+1])
2774 int octet
= (sqlite3HexToInt(zUri
[iIn
++]) << 4);
2775 octet
+= sqlite3HexToInt(zUri
[iIn
++]);
2777 assert( octet
>=0 && octet
<256 );
2779 #ifndef SQLITE_ENABLE_URI_00_ERROR
2780 /* This branch is taken when "%00" appears within the URI. In this
2781 ** case we ignore all text in the remainder of the path, name or
2782 ** value currently being parsed. So ignore the current character
2783 ** and skip to the next "?", "=" or "&", as appropriate. */
2784 while( (c
= zUri
[iIn
])!=0 && c
!='#'
2785 && (eState
!=0 || c
!='?')
2786 && (eState
!=1 || (c
!='=' && c
!='&'))
2787 && (eState
!=2 || c
!='&')
2793 /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
2794 *pzErrMsg
= sqlite3_mprintf("unexpected %%00 in uri");
2800 }else if( eState
==1 && (c
=='&' || c
=='=') ){
2801 if( zFile
[iOut
-1]==0 ){
2802 /* An empty option name. Ignore this option altogether. */
2803 while( zUri
[iIn
] && zUri
[iIn
]!='#' && zUri
[iIn
-1]!='&' ) iIn
++;
2807 zFile
[iOut
++] = '\0';
2812 }else if( (eState
==0 && c
=='?') || (eState
==2 && c
=='&') ){
2818 if( eState
==1 ) zFile
[iOut
++] = '\0';
2819 zFile
[iOut
++] = '\0';
2820 zFile
[iOut
++] = '\0';
2822 /* Check if there were any options specified that should be interpreted
2823 ** here. Options that are interpreted here include "vfs" and those that
2824 ** correspond to flags that may be passed to the sqlite3_open_v2()
2826 zOpt
= &zFile
[sqlite3Strlen30(zFile
)+1];
2828 int nOpt
= sqlite3Strlen30(zOpt
);
2829 char *zVal
= &zOpt
[nOpt
+1];
2830 int nVal
= sqlite3Strlen30(zVal
);
2832 if( nOpt
==3 && memcmp("vfs", zOpt
, 3)==0 ){
2839 char *zModeType
= 0;
2843 if( nOpt
==5 && memcmp("cache", zOpt
, 5)==0 ){
2844 static struct OpenMode aCacheMode
[] = {
2845 { "shared", SQLITE_OPEN_SHAREDCACHE
},
2846 { "private", SQLITE_OPEN_PRIVATECACHE
},
2850 mask
= SQLITE_OPEN_SHAREDCACHE
|SQLITE_OPEN_PRIVATECACHE
;
2853 zModeType
= "cache";
2855 if( nOpt
==4 && memcmp("mode", zOpt
, 4)==0 ){
2856 static struct OpenMode aOpenMode
[] = {
2857 { "ro", SQLITE_OPEN_READONLY
},
2858 { "rw", SQLITE_OPEN_READWRITE
},
2859 { "rwc", SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
},
2860 { "memory", SQLITE_OPEN_MEMORY
},
2864 mask
= SQLITE_OPEN_READONLY
| SQLITE_OPEN_READWRITE
2865 | SQLITE_OPEN_CREATE
| SQLITE_OPEN_MEMORY
;
2867 limit
= mask
& flags
;
2868 zModeType
= "access";
2874 for(i
=0; aMode
[i
].z
; i
++){
2875 const char *z
= aMode
[i
].z
;
2876 if( nVal
==sqlite3Strlen30(z
) && 0==memcmp(zVal
, z
, nVal
) ){
2877 mode
= aMode
[i
].mode
;
2882 *pzErrMsg
= sqlite3_mprintf("no such %s mode: %s", zModeType
, zVal
);
2886 if( (mode
& ~SQLITE_OPEN_MEMORY
)>limit
){
2887 *pzErrMsg
= sqlite3_mprintf("%s mode not allowed: %s",
2892 flags
= (flags
& ~mask
) | mode
;
2896 zOpt
= &zVal
[nVal
+1];
2900 zFile
= sqlite3_malloc64(nUri
+2);
2901 if( !zFile
) return SQLITE_NOMEM_BKPT
;
2903 memcpy(zFile
, zUri
, nUri
);
2906 zFile
[nUri
+1] = '\0';
2907 flags
&= ~SQLITE_OPEN_URI
;
2910 *ppVfs
= sqlite3_vfs_find(zVfs
);
2912 *pzErrMsg
= sqlite3_mprintf("no such vfs: %s", zVfs
);
2916 if( rc
!=SQLITE_OK
){
2917 sqlite3_free(zFile
);
2927 ** This routine does the work of opening a database on behalf of
2928 ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
2929 ** is UTF-8 encoded.
2931 static int openDatabase(
2932 const char *zFilename
, /* Database filename UTF-8 encoded */
2933 sqlite3
**ppDb
, /* OUT: Returned database handle */
2934 unsigned int flags
, /* Operational flags */
2935 const char *zVfs
/* Name of the VFS to use */
2937 sqlite3
*db
; /* Store allocated handle here */
2938 int rc
; /* Return code */
2939 int isThreadsafe
; /* True for threadsafe connections */
2940 char *zOpen
= 0; /* Filename argument to pass to BtreeOpen() */
2941 char *zErrMsg
= 0; /* Error message from sqlite3ParseUri() */
2943 #ifdef SQLITE_ENABLE_API_ARMOR
2944 if( ppDb
==0 ) return SQLITE_MISUSE_BKPT
;
2947 #ifndef SQLITE_OMIT_AUTOINIT
2948 rc
= sqlite3_initialize();
2952 if( sqlite3GlobalConfig
.bCoreMutex
==0 ){
2954 }else if( flags
& SQLITE_OPEN_NOMUTEX
){
2956 }else if( flags
& SQLITE_OPEN_FULLMUTEX
){
2959 isThreadsafe
= sqlite3GlobalConfig
.bFullMutex
;
2962 if( flags
& SQLITE_OPEN_PRIVATECACHE
){
2963 flags
&= ~SQLITE_OPEN_SHAREDCACHE
;
2964 }else if( sqlite3GlobalConfig
.sharedCacheEnabled
){
2965 flags
|= SQLITE_OPEN_SHAREDCACHE
;
2968 /* Remove harmful bits from the flags parameter
2970 ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
2971 ** dealt with in the previous code block. Besides these, the only
2972 ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
2973 ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
2974 ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
2975 ** off all other flags.
2977 flags
&= ~( SQLITE_OPEN_DELETEONCLOSE
|
2978 SQLITE_OPEN_EXCLUSIVE
|
2979 SQLITE_OPEN_MAIN_DB
|
2980 SQLITE_OPEN_TEMP_DB
|
2981 SQLITE_OPEN_TRANSIENT_DB
|
2982 SQLITE_OPEN_MAIN_JOURNAL
|
2983 SQLITE_OPEN_TEMP_JOURNAL
|
2984 SQLITE_OPEN_SUBJOURNAL
|
2985 SQLITE_OPEN_MASTER_JOURNAL
|
2986 SQLITE_OPEN_NOMUTEX
|
2987 SQLITE_OPEN_FULLMUTEX
|
2991 /* Allocate the sqlite data structure */
2992 db
= sqlite3MallocZero( sizeof(sqlite3
) );
2993 if( db
==0 ) goto opendb_out
;
2995 #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
2996 || sqlite3GlobalConfig
.bCoreMutex
2999 db
->mutex
= sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE
);
3005 if( isThreadsafe
==0 ){
3006 sqlite3MutexWarnOnContention(db
->mutex
);
3009 sqlite3_mutex_enter(db
->mutex
);
3012 db
->magic
= SQLITE_MAGIC_BUSY
;
3013 db
->aDb
= db
->aDbStatic
;
3015 assert( sizeof(db
->aLimit
)==sizeof(aHardLimit
) );
3016 memcpy(db
->aLimit
, aHardLimit
, sizeof(db
->aLimit
));
3017 db
->aLimit
[SQLITE_LIMIT_WORKER_THREADS
] = SQLITE_DEFAULT_WORKER_THREADS
;
3019 db
->nextAutovac
= -1;
3020 db
->szMmap
= sqlite3GlobalConfig
.szMmap
;
3021 db
->nextPagesize
= 0;
3022 db
->nMaxSorterMmap
= 0x7FFFFFFF;
3023 db
->flags
|= SQLITE_ShortColNames
| SQLITE_EnableTrigger
| SQLITE_CacheSpill
3024 #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
3027 #if SQLITE_DEFAULT_CKPTFULLFSYNC
3028 | SQLITE_CkptFullFSync
3030 #if SQLITE_DEFAULT_FILE_FORMAT<4
3031 | SQLITE_LegacyFileFmt
3033 #ifdef SQLITE_ENABLE_LOAD_EXTENSION
3034 | SQLITE_LoadExtension
3036 #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
3037 | SQLITE_RecTriggers
3039 #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
3040 | SQLITE_ForeignKeys
3042 #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
3043 | SQLITE_ReverseOrder
3045 #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
3048 #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
3049 | SQLITE_Fts3Tokenizer
3051 #if defined(SQLITE_ENABLE_QPSG)
3055 sqlite3HashInit(&db
->aCollSeq
);
3056 #ifndef SQLITE_OMIT_VIRTUALTABLE
3057 sqlite3HashInit(&db
->aModule
);
3060 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
3061 ** and UTF-16, so add a version for each to avoid any unnecessary
3062 ** conversions. The only error that can occur here is a malloc() failure.
3064 ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
3067 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF8
, 0, binCollFunc
, 0);
3068 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF16BE
, 0, binCollFunc
, 0);
3069 createCollation(db
, sqlite3StrBINARY
, SQLITE_UTF16LE
, 0, binCollFunc
, 0);
3070 createCollation(db
, "NOCASE", SQLITE_UTF8
, 0, nocaseCollatingFunc
, 0);
3071 createCollation(db
, "RTRIM", SQLITE_UTF8
, (void*)1, binCollFunc
, 0);
3072 if( db
->mallocFailed
){
3075 /* EVIDENCE-OF: R-08308-17224 The default collating function for all
3076 ** strings is BINARY.
3078 db
->pDfltColl
= sqlite3FindCollSeq(db
, SQLITE_UTF8
, sqlite3StrBINARY
, 0);
3079 assert( db
->pDfltColl
!=0 );
3081 /* Parse the filename/URI argument
3083 ** Only allow sensible combinations of bits in the flags argument.
3084 ** Throw an error if any non-sense combination is used. If we
3085 ** do not block illegal combinations here, it could trigger
3086 ** assert() statements in deeper layers. Sensible combinations
3089 ** 1: SQLITE_OPEN_READONLY
3090 ** 2: SQLITE_OPEN_READWRITE
3091 ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
3093 db
->openFlags
= flags
;
3094 assert( SQLITE_OPEN_READONLY
== 0x01 );
3095 assert( SQLITE_OPEN_READWRITE
== 0x02 );
3096 assert( SQLITE_OPEN_CREATE
== 0x04 );
3097 testcase( (1<<(flags
&7))==0x02 ); /* READONLY */
3098 testcase( (1<<(flags
&7))==0x04 ); /* READWRITE */
3099 testcase( (1<<(flags
&7))==0x40 ); /* READWRITE | CREATE */
3100 if( ((1<<(flags
&7)) & 0x46)==0 ){
3101 rc
= SQLITE_MISUSE_BKPT
; /* IMP: R-65497-44594 */
3103 rc
= sqlite3ParseUri(zVfs
, zFilename
, &flags
, &db
->pVfs
, &zOpen
, &zErrMsg
);
3105 if( rc
!=SQLITE_OK
){
3106 if( rc
==SQLITE_NOMEM
) sqlite3OomFault(db
);
3107 sqlite3ErrorWithMsg(db
, rc
, zErrMsg
? "%s" : 0, zErrMsg
);
3108 sqlite3_free(zErrMsg
);
3112 /* Open the backend database driver */
3113 rc
= sqlite3BtreeOpen(db
->pVfs
, zOpen
, db
, &db
->aDb
[0].pBt
, 0,
3114 flags
| SQLITE_OPEN_MAIN_DB
);
3115 if( rc
!=SQLITE_OK
){
3116 if( rc
==SQLITE_IOERR_NOMEM
){
3117 rc
= SQLITE_NOMEM_BKPT
;
3119 sqlite3Error(db
, rc
);
3122 sqlite3BtreeEnter(db
->aDb
[0].pBt
);
3123 db
->aDb
[0].pSchema
= sqlite3SchemaGet(db
, db
->aDb
[0].pBt
);
3124 if( !db
->mallocFailed
) ENC(db
) = SCHEMA_ENC(db
);
3125 sqlite3BtreeLeave(db
->aDb
[0].pBt
);
3126 db
->aDb
[1].pSchema
= sqlite3SchemaGet(db
, 0);
3128 /* The default safety_level for the main database is FULL; for the temp
3129 ** database it is OFF. This matches the pager layer defaults.
3131 db
->aDb
[0].zDbSName
= "main";
3132 db
->aDb
[0].safety_level
= SQLITE_DEFAULT_SYNCHRONOUS
+1;
3133 db
->aDb
[1].zDbSName
= "temp";
3134 db
->aDb
[1].safety_level
= PAGER_SYNCHRONOUS_OFF
;
3136 db
->magic
= SQLITE_MAGIC_OPEN
;
3137 if( db
->mallocFailed
){
3141 /* Register all built-in functions, but do not attempt to read the
3142 ** database schema yet. This is delayed until the first time the database
3145 sqlite3Error(db
, SQLITE_OK
);
3146 sqlite3RegisterPerConnectionBuiltinFunctions(db
);
3147 rc
= sqlite3_errcode(db
);
3149 #ifdef SQLITE_ENABLE_FTS5
3150 /* Register any built-in FTS5 module before loading the automatic
3151 ** extensions. This allows automatic extensions to register FTS5
3152 ** tokenizers and auxiliary functions. */
3153 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3154 rc
= sqlite3Fts5Init(db
);
3158 /* Load automatic extensions - extensions that have been registered
3159 ** using the sqlite3_automatic_extension() API.
3161 if( rc
==SQLITE_OK
){
3162 sqlite3AutoLoadExtensions(db
);
3163 rc
= sqlite3_errcode(db
);
3164 if( rc
!=SQLITE_OK
){
3169 #ifdef SQLITE_ENABLE_FTS1
3170 if( !db
->mallocFailed
){
3171 extern int sqlite3Fts1Init(sqlite3
*);
3172 rc
= sqlite3Fts1Init(db
);
3176 #ifdef SQLITE_ENABLE_FTS2
3177 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3178 extern int sqlite3Fts2Init(sqlite3
*);
3179 rc
= sqlite3Fts2Init(db
);
3183 #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
3184 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3185 rc
= sqlite3Fts3Init(db
);
3189 #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
3190 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3191 rc
= sqlite3IcuInit(db
);
3195 #ifdef SQLITE_ENABLE_RTREE
3196 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3197 rc
= sqlite3RtreeInit(db
);
3201 #ifdef SQLITE_ENABLE_DBPAGE_VTAB
3202 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3203 rc
= sqlite3DbpageRegister(db
);
3207 #ifdef SQLITE_ENABLE_DBSTAT_VTAB
3208 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3209 rc
= sqlite3DbstatRegister(db
);
3213 #ifdef SQLITE_ENABLE_JSON1
3214 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3215 rc
= sqlite3Json1Init(db
);
3219 #ifdef SQLITE_ENABLE_STMTVTAB
3220 if( !db
->mallocFailed
&& rc
==SQLITE_OK
){
3221 rc
= sqlite3StmtVtabInit(db
);
3225 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
3226 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
3227 ** mode. Doing nothing at all also makes NORMAL the default.
3229 #ifdef SQLITE_DEFAULT_LOCKING_MODE
3230 db
->dfltLockMode
= SQLITE_DEFAULT_LOCKING_MODE
;
3231 sqlite3PagerLockingMode(sqlite3BtreePager(db
->aDb
[0].pBt
),
3232 SQLITE_DEFAULT_LOCKING_MODE
);
3235 if( rc
) sqlite3Error(db
, rc
);
3237 /* Enable the lookaside-malloc subsystem */
3238 setupLookaside(db
, 0, sqlite3GlobalConfig
.szLookaside
,
3239 sqlite3GlobalConfig
.nLookaside
);
3241 sqlite3_wal_autocheckpoint(db
, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT
);
3245 assert( db
->mutex
!=0 || isThreadsafe
==0
3246 || sqlite3GlobalConfig
.bFullMutex
==0 );
3247 sqlite3_mutex_leave(db
->mutex
);
3249 rc
= sqlite3_errcode(db
);
3250 assert( db
!=0 || rc
==SQLITE_NOMEM
);
3251 if( rc
==SQLITE_NOMEM
){
3254 }else if( rc
!=SQLITE_OK
){
3255 db
->magic
= SQLITE_MAGIC_SICK
;
3258 #ifdef SQLITE_ENABLE_SQLLOG
3259 if( sqlite3GlobalConfig
.xSqllog
){
3260 /* Opening a db handle. Fourth parameter is passed 0. */
3261 void *pArg
= sqlite3GlobalConfig
.pSqllogArg
;
3262 sqlite3GlobalConfig
.xSqllog(pArg
, db
, zFilename
, 0);
3265 #if defined(SQLITE_HAS_CODEC)
3266 if( rc
==SQLITE_OK
){
3268 if( (zKey
= sqlite3_uri_parameter(zOpen
, "hexkey"))!=0 && zKey
[0] ){
3272 for(i
=0, iByte
=0; i
<sizeof(zDecoded
)*2 && sqlite3Isxdigit(zKey
[i
]); i
++){
3273 iByte
= (iByte
<<4) + sqlite3HexToInt(zKey
[i
]);
3274 if( (i
&1)!=0 ) zDecoded
[i
/2] = iByte
;
3276 sqlite3_key_v2(db
, 0, zDecoded
, i
/2);
3277 }else if( (zKey
= sqlite3_uri_parameter(zOpen
, "key"))!=0 ){
3278 sqlite3_key_v2(db
, 0, zKey
, sqlite3Strlen30(zKey
));
3282 sqlite3_free(zOpen
);
3287 ** Open a new database handle.
3290 const char *zFilename
,
3293 return openDatabase(zFilename
, ppDb
,
3294 SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
, 0);
3296 int sqlite3_open_v2(
3297 const char *filename
, /* Database filename (UTF-8) */
3298 sqlite3
**ppDb
, /* OUT: SQLite db handle */
3299 int flags
, /* Flags */
3300 const char *zVfs
/* Name of VFS module to use */
3302 return openDatabase(filename
, ppDb
, (unsigned int)flags
, zVfs
);
3305 #ifndef SQLITE_OMIT_UTF16
3307 ** Open a new database handle.
3310 const void *zFilename
,
3313 char const *zFilename8
; /* zFilename encoded in UTF-8 instead of UTF-16 */
3314 sqlite3_value
*pVal
;
3317 #ifdef SQLITE_ENABLE_API_ARMOR
3318 if( ppDb
==0 ) return SQLITE_MISUSE_BKPT
;
3321 #ifndef SQLITE_OMIT_AUTOINIT
3322 rc
= sqlite3_initialize();
3325 if( zFilename
==0 ) zFilename
= "\000\000";
3326 pVal
= sqlite3ValueNew(0);
3327 sqlite3ValueSetStr(pVal
, -1, zFilename
, SQLITE_UTF16NATIVE
, SQLITE_STATIC
);
3328 zFilename8
= sqlite3ValueText(pVal
, SQLITE_UTF8
);
3330 rc
= openDatabase(zFilename8
, ppDb
,
3331 SQLITE_OPEN_READWRITE
| SQLITE_OPEN_CREATE
, 0);
3332 assert( *ppDb
|| rc
==SQLITE_NOMEM
);
3333 if( rc
==SQLITE_OK
&& !DbHasProperty(*ppDb
, 0, DB_SchemaLoaded
) ){
3334 SCHEMA_ENC(*ppDb
) = ENC(*ppDb
) = SQLITE_UTF16NATIVE
;
3337 rc
= SQLITE_NOMEM_BKPT
;
3339 sqlite3ValueFree(pVal
);
3343 #endif /* SQLITE_OMIT_UTF16 */
3346 ** Register a new collation sequence with the database handle db.
3348 int sqlite3_create_collation(
3353 int(*xCompare
)(void*,int,const void*,int,const void*)
3355 return sqlite3_create_collation_v2(db
, zName
, enc
, pCtx
, xCompare
, 0);
3359 ** Register a new collation sequence with the database handle db.
3361 int sqlite3_create_collation_v2(
3366 int(*xCompare
)(void*,int,const void*,int,const void*),
3371 #ifdef SQLITE_ENABLE_API_ARMOR
3372 if( !sqlite3SafetyCheckOk(db
) || zName
==0 ) return SQLITE_MISUSE_BKPT
;
3374 sqlite3_mutex_enter(db
->mutex
);
3375 assert( !db
->mallocFailed
);
3376 rc
= createCollation(db
, zName
, (u8
)enc
, pCtx
, xCompare
, xDel
);
3377 rc
= sqlite3ApiExit(db
, rc
);
3378 sqlite3_mutex_leave(db
->mutex
);
3382 #ifndef SQLITE_OMIT_UTF16
3384 ** Register a new collation sequence with the database handle db.
3386 int sqlite3_create_collation16(
3391 int(*xCompare
)(void*,int,const void*,int,const void*)
3396 #ifdef SQLITE_ENABLE_API_ARMOR
3397 if( !sqlite3SafetyCheckOk(db
) || zName
==0 ) return SQLITE_MISUSE_BKPT
;
3399 sqlite3_mutex_enter(db
->mutex
);
3400 assert( !db
->mallocFailed
);
3401 zName8
= sqlite3Utf16to8(db
, zName
, -1, SQLITE_UTF16NATIVE
);
3403 rc
= createCollation(db
, zName8
, (u8
)enc
, pCtx
, xCompare
, 0);
3404 sqlite3DbFree(db
, zName8
);
3406 rc
= sqlite3ApiExit(db
, rc
);
3407 sqlite3_mutex_leave(db
->mutex
);
3410 #endif /* SQLITE_OMIT_UTF16 */
3413 ** Register a collation sequence factory callback with the database handle
3414 ** db. Replace any previously installed collation sequence factory.
3416 int sqlite3_collation_needed(
3418 void *pCollNeededArg
,
3419 void(*xCollNeeded
)(void*,sqlite3
*,int eTextRep
,const char*)
3421 #ifdef SQLITE_ENABLE_API_ARMOR
3422 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3424 sqlite3_mutex_enter(db
->mutex
);
3425 db
->xCollNeeded
= xCollNeeded
;
3426 db
->xCollNeeded16
= 0;
3427 db
->pCollNeededArg
= pCollNeededArg
;
3428 sqlite3_mutex_leave(db
->mutex
);
3432 #ifndef SQLITE_OMIT_UTF16
3434 ** Register a collation sequence factory callback with the database handle
3435 ** db. Replace any previously installed collation sequence factory.
3437 int sqlite3_collation_needed16(
3439 void *pCollNeededArg
,
3440 void(*xCollNeeded16
)(void*,sqlite3
*,int eTextRep
,const void*)
3442 #ifdef SQLITE_ENABLE_API_ARMOR
3443 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3445 sqlite3_mutex_enter(db
->mutex
);
3446 db
->xCollNeeded
= 0;
3447 db
->xCollNeeded16
= xCollNeeded16
;
3448 db
->pCollNeededArg
= pCollNeededArg
;
3449 sqlite3_mutex_leave(db
->mutex
);
3452 #endif /* SQLITE_OMIT_UTF16 */
3454 #ifndef SQLITE_OMIT_DEPRECATED
3456 ** This function is now an anachronism. It used to be used to recover from a
3457 ** malloc() failure, but SQLite now does this automatically.
3459 int sqlite3_global_recover(void){
3465 ** Test to see whether or not the database connection is in autocommit
3466 ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
3467 ** by default. Autocommit is disabled by a BEGIN statement and reenabled
3468 ** by the next COMMIT or ROLLBACK.
3470 int sqlite3_get_autocommit(sqlite3
*db
){
3471 #ifdef SQLITE_ENABLE_API_ARMOR
3472 if( !sqlite3SafetyCheckOk(db
) ){
3473 (void)SQLITE_MISUSE_BKPT
;
3477 return db
->autoCommit
;
3481 ** The following routines are substitutes for constants SQLITE_CORRUPT,
3482 ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
3483 ** constants. They serve two purposes:
3485 ** 1. Serve as a convenient place to set a breakpoint in a debugger
3486 ** to detect when version error conditions occurs.
3488 ** 2. Invoke sqlite3_log() to provide the source code location where
3489 ** a low-level error is first detected.
3491 int sqlite3ReportError(int iErr
, int lineno
, const char *zType
){
3492 sqlite3_log(iErr
, "%s at line %d of [%.10s]",
3493 zType
, lineno
, 20+sqlite3_sourceid());
3496 int sqlite3CorruptError(int lineno
){
3497 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3498 return sqlite3ReportError(SQLITE_CORRUPT
, lineno
, "database corruption");
3500 int sqlite3MisuseError(int lineno
){
3501 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3502 return sqlite3ReportError(SQLITE_MISUSE
, lineno
, "misuse");
3504 int sqlite3CantopenError(int lineno
){
3505 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3506 return sqlite3ReportError(SQLITE_CANTOPEN
, lineno
, "cannot open file");
3509 int sqlite3CorruptPgnoError(int lineno
, Pgno pgno
){
3511 sqlite3_snprintf(sizeof(zMsg
), zMsg
, "database corruption page %d", pgno
);
3512 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3513 return sqlite3ReportError(SQLITE_CORRUPT
, lineno
, zMsg
);
3515 int sqlite3NomemError(int lineno
){
3516 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3517 return sqlite3ReportError(SQLITE_NOMEM
, lineno
, "OOM");
3519 int sqlite3IoerrnomemError(int lineno
){
3520 testcase( sqlite3GlobalConfig
.xLog
!=0 );
3521 return sqlite3ReportError(SQLITE_IOERR_NOMEM
, lineno
, "I/O OOM error");
3525 #ifndef SQLITE_OMIT_DEPRECATED
3527 ** This is a convenience routine that makes sure that all thread-specific
3528 ** data for this thread has been deallocated.
3530 ** SQLite no longer uses thread-specific data so this routine is now a
3531 ** no-op. It is retained for historical compatibility.
3533 void sqlite3_thread_cleanup(void){
3538 ** Return meta information about a specific column of a database table.
3539 ** See comment in sqlite3.h (sqlite.h.in) for details.
3541 int sqlite3_table_column_metadata(
3542 sqlite3
*db
, /* Connection handle */
3543 const char *zDbName
, /* Database name or NULL */
3544 const char *zTableName
, /* Table name */
3545 const char *zColumnName
, /* Column name */
3546 char const **pzDataType
, /* OUTPUT: Declared data type */
3547 char const **pzCollSeq
, /* OUTPUT: Collation sequence name */
3548 int *pNotNull
, /* OUTPUT: True if NOT NULL constraint exists */
3549 int *pPrimaryKey
, /* OUTPUT: True if column part of PK */
3550 int *pAutoinc
/* OUTPUT: True if column is auto-increment */
3557 char const *zDataType
= 0;
3558 char const *zCollSeq
= 0;
3564 #ifdef SQLITE_ENABLE_API_ARMOR
3565 if( !sqlite3SafetyCheckOk(db
) || zTableName
==0 ){
3566 return SQLITE_MISUSE_BKPT
;
3570 /* Ensure the database schema has been loaded */
3571 sqlite3_mutex_enter(db
->mutex
);
3572 sqlite3BtreeEnterAll(db
);
3573 rc
= sqlite3Init(db
, &zErrMsg
);
3574 if( SQLITE_OK
!=rc
){
3578 /* Locate the table in question */
3579 pTab
= sqlite3FindTable(db
, zTableName
, zDbName
);
3580 if( !pTab
|| pTab
->pSelect
){
3585 /* Find the column for which info is requested */
3586 if( zColumnName
==0 ){
3587 /* Query for existance of table only */
3589 for(iCol
=0; iCol
<pTab
->nCol
; iCol
++){
3590 pCol
= &pTab
->aCol
[iCol
];
3591 if( 0==sqlite3StrICmp(pCol
->zName
, zColumnName
) ){
3595 if( iCol
==pTab
->nCol
){
3596 if( HasRowid(pTab
) && sqlite3IsRowid(zColumnName
) ){
3598 pCol
= iCol
>=0 ? &pTab
->aCol
[iCol
] : 0;
3606 /* The following block stores the meta information that will be returned
3607 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
3608 ** and autoinc. At this point there are two possibilities:
3610 ** 1. The specified column name was rowid", "oid" or "_rowid_"
3611 ** and there is no explicitly declared IPK column.
3613 ** 2. The table is not a view and the column name identified an
3614 ** explicitly declared column. Copy meta information from *pCol.
3617 zDataType
= sqlite3ColumnType(pCol
,0);
3618 zCollSeq
= pCol
->zColl
;
3619 notnull
= pCol
->notNull
!=0;
3620 primarykey
= (pCol
->colFlags
& COLFLAG_PRIMKEY
)!=0;
3621 autoinc
= pTab
->iPKey
==iCol
&& (pTab
->tabFlags
& TF_Autoincrement
)!=0;
3623 zDataType
= "INTEGER";
3627 zCollSeq
= sqlite3StrBINARY
;
3631 sqlite3BtreeLeaveAll(db
);
3633 /* Whether the function call succeeded or failed, set the output parameters
3634 ** to whatever their local counterparts contain. If an error did occur,
3635 ** this has the effect of zeroing all output parameters.
3637 if( pzDataType
) *pzDataType
= zDataType
;
3638 if( pzCollSeq
) *pzCollSeq
= zCollSeq
;
3639 if( pNotNull
) *pNotNull
= notnull
;
3640 if( pPrimaryKey
) *pPrimaryKey
= primarykey
;
3641 if( pAutoinc
) *pAutoinc
= autoinc
;
3643 if( SQLITE_OK
==rc
&& !pTab
){
3644 sqlite3DbFree(db
, zErrMsg
);
3645 zErrMsg
= sqlite3MPrintf(db
, "no such table column: %s.%s", zTableName
,
3649 sqlite3ErrorWithMsg(db
, rc
, (zErrMsg
?"%s":0), zErrMsg
);
3650 sqlite3DbFree(db
, zErrMsg
);
3651 rc
= sqlite3ApiExit(db
, rc
);
3652 sqlite3_mutex_leave(db
->mutex
);
3657 ** Sleep for a little while. Return the amount of time slept.
3659 int sqlite3_sleep(int ms
){
3662 pVfs
= sqlite3_vfs_find(0);
3663 if( pVfs
==0 ) return 0;
3665 /* This function works in milliseconds, but the underlying OsSleep()
3666 ** API uses microseconds. Hence the 1000's.
3668 rc
= (sqlite3OsSleep(pVfs
, 1000*ms
)/1000);
3673 ** Enable or disable the extended result codes.
3675 int sqlite3_extended_result_codes(sqlite3
*db
, int onoff
){
3676 #ifdef SQLITE_ENABLE_API_ARMOR
3677 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3679 sqlite3_mutex_enter(db
->mutex
);
3680 db
->errMask
= onoff
? 0xffffffff : 0xff;
3681 sqlite3_mutex_leave(db
->mutex
);
3686 ** Invoke the xFileControl method on a particular database.
3688 int sqlite3_file_control(sqlite3
*db
, const char *zDbName
, int op
, void *pArg
){
3689 int rc
= SQLITE_ERROR
;
3692 #ifdef SQLITE_ENABLE_API_ARMOR
3693 if( !sqlite3SafetyCheckOk(db
) ) return SQLITE_MISUSE_BKPT
;
3695 sqlite3_mutex_enter(db
->mutex
);
3696 pBtree
= sqlite3DbNameToBtree(db
, zDbName
);
3700 sqlite3BtreeEnter(pBtree
);
3701 pPager
= sqlite3BtreePager(pBtree
);
3702 assert( pPager
!=0 );
3703 fd
= sqlite3PagerFile(pPager
);
3705 if( op
==SQLITE_FCNTL_FILE_POINTER
){
3706 *(sqlite3_file
**)pArg
= fd
;
3708 }else if( op
==SQLITE_FCNTL_VFS_POINTER
){
3709 *(sqlite3_vfs
**)pArg
= sqlite3PagerVfs(pPager
);
3711 }else if( op
==SQLITE_FCNTL_JOURNAL_POINTER
){
3712 *(sqlite3_file
**)pArg
= sqlite3PagerJrnlFile(pPager
);
3715 rc
= sqlite3OsFileControl(fd
, op
, pArg
);
3717 sqlite3BtreeLeave(pBtree
);
3719 sqlite3_mutex_leave(db
->mutex
);
3724 ** Interface to the testing logic.
3726 int sqlite3_test_control(int op
, ...){
3728 #ifdef SQLITE_UNTESTABLE
3729 UNUSED_PARAMETER(op
);
3736 ** Save the current state of the PRNG.
3738 case SQLITE_TESTCTRL_PRNG_SAVE
: {
3739 sqlite3PrngSaveState();
3744 ** Restore the state of the PRNG to the last state saved using
3745 ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
3746 ** this verb acts like PRNG_RESET.
3748 case SQLITE_TESTCTRL_PRNG_RESTORE
: {
3749 sqlite3PrngRestoreState();
3754 ** Reset the PRNG back to its uninitialized state. The next call
3755 ** to sqlite3_randomness() will reseed the PRNG using a single call
3756 ** to the xRandomness method of the default VFS.
3758 case SQLITE_TESTCTRL_PRNG_RESET
: {
3759 sqlite3_randomness(0,0);
3764 ** sqlite3_test_control(BITVEC_TEST, size, program)
3766 ** Run a test against a Bitvec object of size. The program argument
3767 ** is an array of integers that defines the test. Return -1 on a
3768 ** memory allocation error, 0 on success, or non-zero for an error.
3769 ** See the sqlite3BitvecBuiltinTest() for additional information.
3771 case SQLITE_TESTCTRL_BITVEC_TEST
: {
3772 int sz
= va_arg(ap
, int);
3773 int *aProg
= va_arg(ap
, int*);
3774 rc
= sqlite3BitvecBuiltinTest(sz
, aProg
);
3779 ** sqlite3_test_control(FAULT_INSTALL, xCallback)
3781 ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
3782 ** if xCallback is not NULL.
3784 ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
3785 ** is called immediately after installing the new callback and the return
3786 ** value from sqlite3FaultSim(0) becomes the return from
3787 ** sqlite3_test_control().
3789 case SQLITE_TESTCTRL_FAULT_INSTALL
: {
3790 /* MSVC is picky about pulling func ptrs from va lists.
3791 ** http://support.microsoft.com/kb/47961
3792 ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
3794 typedef int(*TESTCALLBACKFUNC_t
)(int);
3795 sqlite3GlobalConfig
.xTestCallback
= va_arg(ap
, TESTCALLBACKFUNC_t
);
3796 rc
= sqlite3FaultSim(0);
3801 ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
3803 ** Register hooks to call to indicate which malloc() failures
3806 case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS
: {
3807 typedef void (*void_function
)(void);
3808 void_function xBenignBegin
;
3809 void_function xBenignEnd
;
3810 xBenignBegin
= va_arg(ap
, void_function
);
3811 xBenignEnd
= va_arg(ap
, void_function
);
3812 sqlite3BenignMallocHooks(xBenignBegin
, xBenignEnd
);
3817 ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
3819 ** Set the PENDING byte to the value in the argument, if X>0.
3820 ** Make no changes if X==0. Return the value of the pending byte
3821 ** as it existing before this routine was called.
3823 ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
3824 ** an incompatible database file format. Changing the PENDING byte
3825 ** while any database connection is open results in undefined and
3826 ** deleterious behavior.
3828 case SQLITE_TESTCTRL_PENDING_BYTE
: {
3830 #ifndef SQLITE_OMIT_WSD
3832 unsigned int newVal
= va_arg(ap
, unsigned int);
3833 if( newVal
) sqlite3PendingByte
= newVal
;
3840 ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
3842 ** This action provides a run-time test to see whether or not
3843 ** assert() was enabled at compile-time. If X is true and assert()
3844 ** is enabled, then the return value is true. If X is true and
3845 ** assert() is disabled, then the return value is zero. If X is
3846 ** false and assert() is enabled, then the assertion fires and the
3847 ** process aborts. If X is false and assert() is disabled, then the
3848 ** return value is zero.
3850 case SQLITE_TESTCTRL_ASSERT
: {
3852 assert( /*side-effects-ok*/ (x
= va_arg(ap
,int))!=0 );
3859 ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
3861 ** This action provides a run-time test to see how the ALWAYS and
3862 ** NEVER macros were defined at compile-time.
3864 ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
3866 ** The recommended test is X==2. If the return value is 2, that means
3867 ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
3868 ** default setting. If the return value is 1, then ALWAYS() is either
3869 ** hard-coded to true or else it asserts if its argument is false.
3870 ** The first behavior (hard-coded to true) is the case if
3871 ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
3872 ** behavior (assert if the argument to ALWAYS() is false) is the case if
3873 ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
3875 ** The run-time test procedure might look something like this:
3877 ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
3878 ** // ALWAYS() and NEVER() are no-op pass-through macros
3879 ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
3880 ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
3882 ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
3885 case SQLITE_TESTCTRL_ALWAYS
: {
3886 int x
= va_arg(ap
,int);
3887 rc
= x
? ALWAYS(x
) : 0;
3892 ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
3894 ** The integer returned reveals the byte-order of the computer on which
3895 ** SQLite is running:
3897 ** 1 big-endian, determined at run-time
3898 ** 10 little-endian, determined at run-time
3899 ** 432101 big-endian, determined at compile-time
3900 ** 123410 little-endian, determined at compile-time
3902 case SQLITE_TESTCTRL_BYTEORDER
: {
3903 rc
= SQLITE_BYTEORDER
*100 + SQLITE_LITTLEENDIAN
*10 + SQLITE_BIGENDIAN
;
3907 /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
3909 ** Set the nReserve size to N for the main database on the database
3912 case SQLITE_TESTCTRL_RESERVE
: {
3913 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3914 int x
= va_arg(ap
,int);
3915 sqlite3_mutex_enter(db
->mutex
);
3916 sqlite3BtreeSetPageSize(db
->aDb
[0].pBt
, 0, x
, 0);
3917 sqlite3_mutex_leave(db
->mutex
);
3921 /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
3923 ** Enable or disable various optimizations for testing purposes. The
3924 ** argument N is a bitmask of optimizations to be disabled. For normal
3925 ** operation N should be 0. The idea is that a test program (like the
3926 ** SQL Logic Test or SLT test module) can run the same SQL multiple times
3927 ** with various optimizations disabled to verify that the same answer
3928 ** is obtained in every case.
3930 case SQLITE_TESTCTRL_OPTIMIZATIONS
: {
3931 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3932 db
->dbOptFlags
= (u16
)(va_arg(ap
, int) & 0xffff);
3936 /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
3938 ** If parameter onoff is non-zero, configure the wrappers so that all
3939 ** subsequent calls to localtime() and variants fail. If onoff is zero,
3940 ** undo this setting.
3942 case SQLITE_TESTCTRL_LOCALTIME_FAULT
: {
3943 sqlite3GlobalConfig
.bLocaltimeFault
= va_arg(ap
, int);
3947 /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
3949 ** Set or clear a flag that indicates that the database file is always well-
3950 ** formed and never corrupt. This flag is clear by default, indicating that
3951 ** database files might have arbitrary corruption. Setting the flag during
3952 ** testing causes certain assert() statements in the code to be activated
3953 ** that demonstrat invariants on well-formed database files.
3955 case SQLITE_TESTCTRL_NEVER_CORRUPT
: {
3956 sqlite3GlobalConfig
.neverCorrupt
= va_arg(ap
, int);
3960 /* Set the threshold at which OP_Once counters reset back to zero.
3961 ** By default this is 0x7ffffffe (over 2 billion), but that value is
3962 ** too big to test in a reasonable amount of time, so this control is
3963 ** provided to set a small and easily reachable reset value.
3965 case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD
: {
3966 sqlite3GlobalConfig
.iOnceResetThreshold
= va_arg(ap
, int);
3970 /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
3972 ** Set the VDBE coverage callback function to xCallback with context
3975 case SQLITE_TESTCTRL_VDBE_COVERAGE
: {
3976 #ifdef SQLITE_VDBE_COVERAGE
3977 typedef void (*branch_callback
)(void*,unsigned int,
3978 unsigned char,unsigned char);
3979 sqlite3GlobalConfig
.xVdbeBranch
= va_arg(ap
,branch_callback
);
3980 sqlite3GlobalConfig
.pVdbeBranchArg
= va_arg(ap
,void*);
3985 /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
3986 case SQLITE_TESTCTRL_SORTER_MMAP
: {
3987 sqlite3
*db
= va_arg(ap
, sqlite3
*);
3988 db
->nMaxSorterMmap
= va_arg(ap
, int);
3992 /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
3994 ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
3997 case SQLITE_TESTCTRL_ISINIT
: {
3998 if( sqlite3GlobalConfig
.isInit
==0 ) rc
= SQLITE_ERROR
;
4002 /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
4004 ** This test control is used to create imposter tables. "db" is a pointer
4005 ** to the database connection. dbName is the database name (ex: "main" or
4006 ** "temp") which will receive the imposter. "onOff" turns imposter mode on
4007 ** or off. "tnum" is the root page of the b-tree to which the imposter
4008 ** table should connect.
4010 ** Enable imposter mode only when the schema has already been parsed. Then
4011 ** run a single CREATE TABLE statement to construct the imposter table in
4012 ** the parsed schema. Then turn imposter mode back off again.
4014 ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
4015 ** the schema to be reparsed the next time it is needed. This has the
4016 ** effect of erasing all imposter tables.
4018 case SQLITE_TESTCTRL_IMPOSTER
: {
4019 sqlite3
*db
= va_arg(ap
, sqlite3
*);
4020 sqlite3_mutex_enter(db
->mutex
);
4021 db
->init
.iDb
= sqlite3FindDbName(db
, va_arg(ap
,const char*));
4022 db
->init
.busy
= db
->init
.imposterTable
= va_arg(ap
,int);
4023 db
->init
.newTnum
= va_arg(ap
,int);
4024 if( db
->init
.busy
==0 && db
->init
.newTnum
>0 ){
4025 sqlite3ResetAllSchemasOfConnection(db
);
4027 sqlite3_mutex_leave(db
->mutex
);
4031 #if defined(YYCOVERAGE)
4032 /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
4034 ** This test control (only available when SQLite is compiled with
4035 ** -DYYCOVERAGE) writes a report onto "out" that shows all
4036 ** state/lookahead combinations in the parser state machine
4037 ** which are never exercised. If any state is missed, make the
4038 ** return code SQLITE_ERROR.
4040 case SQLITE_TESTCTRL_PARSER_COVERAGE
: {
4041 FILE *out
= va_arg(ap
, FILE*);
4042 if( sqlite3ParserCoverage(out
) ) rc
= SQLITE_ERROR
;
4045 #endif /* defined(YYCOVERAGE) */
4048 #endif /* SQLITE_UNTESTABLE */
4053 ** This is a utility routine, useful to VFS implementations, that checks
4054 ** to see if a database file was a URI that contained a specific query
4055 ** parameter, and if so obtains the value of the query parameter.
4057 ** The zFilename argument is the filename pointer passed into the xOpen()
4058 ** method of a VFS implementation. The zParam argument is the name of the
4059 ** query parameter we seek. This routine returns the value of the zParam
4060 ** parameter if it exists. If the parameter does not exist, this routine
4061 ** returns a NULL pointer.
4063 const char *sqlite3_uri_parameter(const char *zFilename
, const char *zParam
){
4064 if( zFilename
==0 || zParam
==0 ) return 0;
4065 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4066 while( zFilename
[0] ){
4067 int x
= strcmp(zFilename
, zParam
);
4068 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4069 if( x
==0 ) return zFilename
;
4070 zFilename
+= sqlite3Strlen30(zFilename
) + 1;
4076 ** Return a boolean value for a query parameter.
4078 int sqlite3_uri_boolean(const char *zFilename
, const char *zParam
, int bDflt
){
4079 const char *z
= sqlite3_uri_parameter(zFilename
, zParam
);
4081 return z
? sqlite3GetBoolean(z
, bDflt
) : bDflt
;
4085 ** Return a 64-bit integer value for a query parameter.
4087 sqlite3_int64
sqlite3_uri_int64(
4088 const char *zFilename
, /* Filename as passed to xOpen */
4089 const char *zParam
, /* URI parameter sought */
4090 sqlite3_int64 bDflt
/* return if parameter is missing */
4092 const char *z
= sqlite3_uri_parameter(zFilename
, zParam
);
4094 if( z
&& sqlite3DecOrHexToI64(z
, &v
)==0 ){
4101 ** Return the Btree pointer identified by zDbName. Return NULL if not found.
4103 Btree
*sqlite3DbNameToBtree(sqlite3
*db
, const char *zDbName
){
4104 int iDb
= zDbName
? sqlite3FindDbName(db
, zDbName
) : 0;
4105 return iDb
<0 ? 0 : db
->aDb
[iDb
].pBt
;
4109 ** Return the filename of the database associated with a database
4112 const char *sqlite3_db_filename(sqlite3
*db
, const char *zDbName
){
4114 #ifdef SQLITE_ENABLE_API_ARMOR
4115 if( !sqlite3SafetyCheckOk(db
) ){
4116 (void)SQLITE_MISUSE_BKPT
;
4120 pBt
= sqlite3DbNameToBtree(db
, zDbName
);
4121 return pBt
? sqlite3BtreeGetFilename(pBt
) : 0;
4125 ** Return 1 if database is read-only or 0 if read/write. Return -1 if
4126 ** no such database exists.
4128 int sqlite3_db_readonly(sqlite3
*db
, const char *zDbName
){
4130 #ifdef SQLITE_ENABLE_API_ARMOR
4131 if( !sqlite3SafetyCheckOk(db
) ){
4132 (void)SQLITE_MISUSE_BKPT
;
4136 pBt
= sqlite3DbNameToBtree(db
, zDbName
);
4137 return pBt
? sqlite3BtreeIsReadonly(pBt
) : -1;
4140 #ifdef SQLITE_ENABLE_SNAPSHOT
4142 ** Obtain a snapshot handle for the snapshot of database zDb currently
4143 ** being read by handle db.
4145 int sqlite3_snapshot_get(
4148 sqlite3_snapshot
**ppSnapshot
4150 int rc
= SQLITE_ERROR
;
4151 #ifndef SQLITE_OMIT_WAL
4153 #ifdef SQLITE_ENABLE_API_ARMOR
4154 if( !sqlite3SafetyCheckOk(db
) ){
4155 return SQLITE_MISUSE_BKPT
;
4158 sqlite3_mutex_enter(db
->mutex
);
4160 if( db
->autoCommit
==0 ){
4161 int iDb
= sqlite3FindDbName(db
, zDb
);
4162 if( iDb
==0 || iDb
>1 ){
4163 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4164 if( 0==sqlite3BtreeIsInTrans(pBt
) ){
4165 rc
= sqlite3BtreeBeginTrans(pBt
, 0, 0);
4166 if( rc
==SQLITE_OK
){
4167 rc
= sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt
), ppSnapshot
);
4173 sqlite3_mutex_leave(db
->mutex
);
4174 #endif /* SQLITE_OMIT_WAL */
4179 ** Open a read-transaction on the snapshot idendified by pSnapshot.
4181 int sqlite3_snapshot_open(
4184 sqlite3_snapshot
*pSnapshot
4186 int rc
= SQLITE_ERROR
;
4187 #ifndef SQLITE_OMIT_WAL
4189 #ifdef SQLITE_ENABLE_API_ARMOR
4190 if( !sqlite3SafetyCheckOk(db
) ){
4191 return SQLITE_MISUSE_BKPT
;
4194 sqlite3_mutex_enter(db
->mutex
);
4195 if( db
->autoCommit
==0 ){
4197 iDb
= sqlite3FindDbName(db
, zDb
);
4198 if( iDb
==0 || iDb
>1 ){
4199 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4200 if( 0==sqlite3BtreeIsInReadTrans(pBt
) ){
4201 rc
= sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt
), pSnapshot
);
4202 if( rc
==SQLITE_OK
){
4203 rc
= sqlite3BtreeBeginTrans(pBt
, 0, 0);
4204 sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt
), 0);
4210 sqlite3_mutex_leave(db
->mutex
);
4211 #endif /* SQLITE_OMIT_WAL */
4216 ** Recover as many snapshots as possible from the wal file associated with
4217 ** schema zDb of database db.
4219 int sqlite3_snapshot_recover(sqlite3
*db
, const char *zDb
){
4220 int rc
= SQLITE_ERROR
;
4222 #ifndef SQLITE_OMIT_WAL
4224 #ifdef SQLITE_ENABLE_API_ARMOR
4225 if( !sqlite3SafetyCheckOk(db
) ){
4226 return SQLITE_MISUSE_BKPT
;
4230 sqlite3_mutex_enter(db
->mutex
);
4231 iDb
= sqlite3FindDbName(db
, zDb
);
4232 if( iDb
==0 || iDb
>1 ){
4233 Btree
*pBt
= db
->aDb
[iDb
].pBt
;
4234 if( 0==sqlite3BtreeIsInReadTrans(pBt
) ){
4235 rc
= sqlite3BtreeBeginTrans(pBt
, 0, 0);
4236 if( rc
==SQLITE_OK
){
4237 rc
= sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt
));
4238 sqlite3BtreeCommit(pBt
);
4242 sqlite3_mutex_leave(db
->mutex
);
4243 #endif /* SQLITE_OMIT_WAL */
4248 ** Free a snapshot handle obtained from sqlite3_snapshot_get().
4250 void sqlite3_snapshot_free(sqlite3_snapshot
*pSnapshot
){
4251 sqlite3_free(pSnapshot
);
4253 #endif /* SQLITE_ENABLE_SNAPSHOT */
4255 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4257 ** Given the name of a compile-time option, return true if that option
4258 ** was used and false if not.
4260 ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
4261 ** is not required for a match.
4263 int sqlite3_compileoption_used(const char *zOptName
){
4266 const char **azCompileOpt
;
4268 #if SQLITE_ENABLE_API_ARMOR
4270 (void)SQLITE_MISUSE_BKPT
;
4275 azCompileOpt
= sqlite3CompileOptions(&nOpt
);
4277 if( sqlite3StrNICmp(zOptName
, "SQLITE_", 7)==0 ) zOptName
+= 7;
4278 n
= sqlite3Strlen30(zOptName
);
4280 /* Since nOpt is normally in single digits, a linear search is
4281 ** adequate. No need for a binary search. */
4282 for(i
=0; i
<nOpt
; i
++){
4283 if( sqlite3StrNICmp(zOptName
, azCompileOpt
[i
], n
)==0
4284 && sqlite3IsIdChar((unsigned char)azCompileOpt
[i
][n
])==0
4293 ** Return the N-th compile-time option string. If N is out of range,
4294 ** return a NULL pointer.
4296 const char *sqlite3_compileoption_get(int N
){
4298 const char **azCompileOpt
;
4299 azCompileOpt
= sqlite3CompileOptions(&nOpt
);
4300 if( N
>=0 && N
<nOpt
){
4301 return azCompileOpt
[N
];
4305 #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */