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