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