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