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 ** Internal interface definitions for SQLite. 13 ** 14 */ 15 #ifndef SQLITEINT_H 16 #define SQLITEINT_H 17 18 /* Special Comments: 19 ** 20 ** Some comments have special meaning to the tools that measure test 21 ** coverage: 22 ** 23 ** NO_TEST - The branches on this line are not 24 ** measured by branch coverage. This is 25 ** used on lines of code that actually 26 ** implement parts of coverage testing. 27 ** 28 ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false 29 ** and the correct answer is still obtained, 30 ** though perhaps more slowly. 31 ** 32 ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true 33 ** and the correct answer is still obtained, 34 ** though perhaps more slowly. 35 ** 36 ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread 37 ** that would be harmless and undetectable 38 ** if it did occur. 39 ** 40 ** In all cases, the special comment must be enclosed in the usual 41 ** slash-asterisk...asterisk-slash comment marks, with no spaces between the 42 ** asterisks and the comment text. 43 */ 44 45 /* 46 ** Make sure the Tcl calling convention macro is defined. This macro is 47 ** only used by test code and Tcl integration code. 48 */ 49 #ifndef SQLITE_TCLAPI 50 # define SQLITE_TCLAPI 51 #endif 52 53 /* 54 ** Make sure that rand_s() is available on Windows systems with MSVC 2005 55 ** or higher. 56 */ 57 #if defined(_MSC_VER) && _MSC_VER>=1400 58 # define _CRT_RAND_S 59 #endif 60 61 /* 62 ** Include the header file used to customize the compiler options for MSVC. 63 ** This should be done first so that it can successfully prevent spurious 64 ** compiler warnings due to subsequent content in this file and other files 65 ** that are included by this file. 66 */ 67 #include "msvc.h" 68 69 /* 70 ** Special setup for VxWorks 71 */ 72 #include "vxworks.h" 73 74 /* 75 ** These #defines should enable >2GB file support on POSIX if the 76 ** underlying operating system supports it. If the OS lacks 77 ** large file support, or if the OS is windows, these should be no-ops. 78 ** 79 ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 80 ** system #includes. Hence, this block of code must be the very first 81 ** code in all source files. 82 ** 83 ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 84 ** on the compiler command line. This is necessary if you are compiling 85 ** on a recent machine (ex: Red Hat 7.2) but you want your code to work 86 ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2 87 ** without this option, LFS is enable. But LFS does not exist in the kernel 88 ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary 89 ** portability you should omit LFS. 90 ** 91 ** The previous paragraph was written in 2005. (This paragraph is written 92 ** on 2008-11-28.) These days, all Linux kernels support large files, so 93 ** you should probably leave LFS enabled. But some embedded platforms might 94 ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful. 95 ** 96 ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later. 97 */ 98 #ifndef SQLITE_DISABLE_LFS 99 # define _LARGE_FILE 1 100 # ifndef _FILE_OFFSET_BITS 101 # define _FILE_OFFSET_BITS 64 102 # endif 103 # define _LARGEFILE_SOURCE 1 104 #endif 105 106 /* What version of GCC is being used. 0 means GCC is not being used */ 107 #ifdef __GNUC__ 108 # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__) 109 #else 110 # define GCC_VERSION 0 111 #endif 112 113 /* Needed for various definitions... */ 114 #if defined(__GNUC__) && !defined(_GNU_SOURCE) 115 # define _GNU_SOURCE 116 #endif 117 118 #if defined(__OpenBSD__) && !defined(_BSD_SOURCE) 119 # define _BSD_SOURCE 120 #endif 121 122 /* 123 ** For MinGW, check to see if we can include the header file containing its 124 ** version information, among other things. Normally, this internal MinGW 125 ** header file would [only] be included automatically by other MinGW header 126 ** files; however, the contained version information is now required by this 127 ** header file to work around binary compatibility issues (see below) and 128 ** this is the only known way to reliably obtain it. This entire #if block 129 ** would be completely unnecessary if there was any other way of detecting 130 ** MinGW via their preprocessor (e.g. if they customized their GCC to define 131 ** some MinGW-specific macros). When compiling for MinGW, either the 132 ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be 133 ** defined; otherwise, detection of conditions specific to MinGW will be 134 ** disabled. 135 */ 136 #if defined(_HAVE_MINGW_H) 137 # include "mingw.h" 138 #elif defined(_HAVE__MINGW_H) 139 # include "_mingw.h" 140 #endif 141 142 /* 143 ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T 144 ** define is required to maintain binary compatibility with the MSVC runtime 145 ** library in use (e.g. for Windows XP). 146 */ 147 #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \ 148 defined(_WIN32) && !defined(_WIN64) && \ 149 defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \ 150 defined(__MSVCRT__) 151 # define _USE_32BIT_TIME_T 152 #endif 153 154 /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear 155 ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for 156 ** MinGW. 157 */ 158 #include "sqlite3.h" 159 160 /* 161 ** Include the configuration header output by 'configure' if we're using the 162 ** autoconf-based build 163 */ 164 #ifdef _HAVE_SQLITE_CONFIG_H 165 #include "config.h" 166 #endif 167 168 #include "sqliteLimit.h" 169 170 /* Disable nuisance warnings on Borland compilers */ 171 #if defined(__BORLANDC__) 172 #pragma warn -rch /* unreachable code */ 173 #pragma warn -ccc /* Condition is always true or false */ 174 #pragma warn -aus /* Assigned value is never used */ 175 #pragma warn -csu /* Comparing signed and unsigned */ 176 #pragma warn -spa /* Suspicious pointer arithmetic */ 177 #endif 178 179 /* 180 ** Include standard header files as necessary 181 */ 182 #ifdef HAVE_STDINT_H 183 #include <stdint.h> 184 #endif 185 #ifdef HAVE_INTTYPES_H 186 #include <inttypes.h> 187 #endif 188 189 /* 190 ** The following macros are used to cast pointers to integers and 191 ** integers to pointers. The way you do this varies from one compiler 192 ** to the next, so we have developed the following set of #if statements 193 ** to generate appropriate macros for a wide range of compilers. 194 ** 195 ** The correct "ANSI" way to do this is to use the intptr_t type. 196 ** Unfortunately, that typedef is not available on all compilers, or 197 ** if it is available, it requires an #include of specific headers 198 ** that vary from one machine to the next. 199 ** 200 ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 201 ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 202 ** So we have to define the macros in different ways depending on the 203 ** compiler. 204 */ 205 #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 206 # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 207 # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 208 #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 209 # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 210 # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 211 #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 212 # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 213 # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 214 #else /* Generates a warning - but it always works */ 215 # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 216 # define SQLITE_PTR_TO_INT(X) ((int)(X)) 217 #endif 218 219 /* 220 ** A macro to hint to the compiler that a function should not be 221 ** inlined. 222 */ 223 #if defined(__GNUC__) 224 # define SQLITE_NOINLINE __attribute__((noinline)) 225 #elif defined(_MSC_VER) && _MSC_VER>=1310 226 # define SQLITE_NOINLINE __declspec(noinline) 227 #else 228 # define SQLITE_NOINLINE 229 #endif 230 231 /* 232 ** Make sure that the compiler intrinsics we desire are enabled when 233 ** compiling with an appropriate version of MSVC unless prevented by 234 ** the SQLITE_DISABLE_INTRINSIC define. 235 */ 236 #if !defined(SQLITE_DISABLE_INTRINSIC) 237 # if defined(_MSC_VER) && _MSC_VER>=1400 238 # if !defined(_WIN32_WCE) 239 # include <intrin.h> 240 # pragma intrinsic(_byteswap_ushort) 241 # pragma intrinsic(_byteswap_ulong) 242 # pragma intrinsic(_ReadWriteBarrier) 243 # else 244 # include <cmnintrin.h> 245 # endif 246 # endif 247 #endif 248 249 /* 250 ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 251 ** 0 means mutexes are permanently disable and the library is never 252 ** threadsafe. 1 means the library is serialized which is the highest 253 ** level of threadsafety. 2 means the library is multithreaded - multiple 254 ** threads can use SQLite as long as no two threads try to use the same 255 ** database connection at the same time. 256 ** 257 ** Older versions of SQLite used an optional THREADSAFE macro. 258 ** We support that for legacy. 259 */ 260 #if !defined(SQLITE_THREADSAFE) 261 # if defined(THREADSAFE) 262 # define SQLITE_THREADSAFE THREADSAFE 263 # else 264 # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 265 # endif 266 #endif 267 268 /* 269 ** Powersafe overwrite is on by default. But can be turned off using 270 ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option. 271 */ 272 #ifndef SQLITE_POWERSAFE_OVERWRITE 273 # define SQLITE_POWERSAFE_OVERWRITE 1 274 #endif 275 276 /* 277 ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by 278 ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in 279 ** which case memory allocation statistics are disabled by default. 280 */ 281 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 282 # define SQLITE_DEFAULT_MEMSTATUS 1 283 #endif 284 285 /* 286 ** Exactly one of the following macros must be defined in order to 287 ** specify which memory allocation subsystem to use. 288 ** 289 ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 290 ** SQLITE_WIN32_MALLOC // Use Win32 native heap API 291 ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails 292 ** SQLITE_MEMDEBUG // Debugging version of system malloc() 293 ** 294 ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the 295 ** assert() macro is enabled, each call into the Win32 native heap subsystem 296 ** will cause HeapValidate to be called. If heap validation should fail, an 297 ** assertion will be triggered. 298 ** 299 ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 300 ** the default. 301 */ 302 #if defined(SQLITE_SYSTEM_MALLOC) \ 303 + defined(SQLITE_WIN32_MALLOC) \ 304 + defined(SQLITE_ZERO_MALLOC) \ 305 + defined(SQLITE_MEMDEBUG)>1 306 # error "Two or more of the following compile-time configuration options\ 307 are defined but at most one is allowed:\ 308 SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\ 309 SQLITE_ZERO_MALLOC" 310 #endif 311 #if defined(SQLITE_SYSTEM_MALLOC) \ 312 + defined(SQLITE_WIN32_MALLOC) \ 313 + defined(SQLITE_ZERO_MALLOC) \ 314 + defined(SQLITE_MEMDEBUG)==0 315 # define SQLITE_SYSTEM_MALLOC 1 316 #endif 317 318 /* 319 ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 320 ** sizes of memory allocations below this value where possible. 321 */ 322 #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 323 # define SQLITE_MALLOC_SOFT_LIMIT 1024 324 #endif 325 326 /* 327 ** We need to define _XOPEN_SOURCE as follows in order to enable 328 ** recursive mutexes on most Unix systems and fchmod() on OpenBSD. 329 ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit 330 ** it. 331 */ 332 #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) 333 # define _XOPEN_SOURCE 600 334 #endif 335 336 /* 337 ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that 338 ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true, 339 ** make it true by defining or undefining NDEBUG. 340 ** 341 ** Setting NDEBUG makes the code smaller and faster by disabling the 342 ** assert() statements in the code. So we want the default action 343 ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG 344 ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out 345 ** feature. 346 */ 347 #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 348 # define NDEBUG 1 349 #endif 350 #if defined(NDEBUG) && defined(SQLITE_DEBUG) 351 # undef NDEBUG 352 #endif 353 354 /* 355 ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on. 356 */ 357 #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG) 358 # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1 359 #endif 360 361 /* 362 ** The testcase() macro is used to aid in coverage testing. When 363 ** doing coverage testing, the condition inside the argument to 364 ** testcase() must be evaluated both true and false in order to 365 ** get full branch coverage. The testcase() macro is inserted 366 ** to help ensure adequate test coverage in places where simple 367 ** condition/decision coverage is inadequate. For example, testcase() 368 ** can be used to make sure boundary values are tested. For 369 ** bitmask tests, testcase() can be used to make sure each bit 370 ** is significant and used at least once. On switch statements 371 ** where multiple cases go to the same block of code, testcase() 372 ** can insure that all cases are evaluated. 373 ** 374 */ 375 #ifdef SQLITE_COVERAGE_TEST 376 void sqlite3Coverage(int); 377 # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 378 #else 379 # define testcase(X) 380 #endif 381 382 /* 383 ** The TESTONLY macro is used to enclose variable declarations or 384 ** other bits of code that are needed to support the arguments 385 ** within testcase() and assert() macros. 386 */ 387 #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 388 # define TESTONLY(X) X 389 #else 390 # define TESTONLY(X) 391 #endif 392 393 /* 394 ** Sometimes we need a small amount of code such as a variable initialization 395 ** to setup for a later assert() statement. We do not want this code to 396 ** appear when assert() is disabled. The following macro is therefore 397 ** used to contain that setup code. The "VVA" acronym stands for 398 ** "Verification, Validation, and Accreditation". In other words, the 399 ** code within VVA_ONLY() will only run during verification processes. 400 */ 401 #ifndef NDEBUG 402 # define VVA_ONLY(X) X 403 #else 404 # define VVA_ONLY(X) 405 #endif 406 407 /* 408 ** The ALWAYS and NEVER macros surround boolean expressions which 409 ** are intended to always be true or false, respectively. Such 410 ** expressions could be omitted from the code completely. But they 411 ** are included in a few cases in order to enhance the resilience 412 ** of SQLite to unexpected behavior - to make the code "self-healing" 413 ** or "ductile" rather than being "brittle" and crashing at the first 414 ** hint of unplanned behavior. 415 ** 416 ** In other words, ALWAYS and NEVER are added for defensive code. 417 ** 418 ** When doing coverage testing ALWAYS and NEVER are hard-coded to 419 ** be true and false so that the unreachable code they specify will 420 ** not be counted as untested code. 421 */ 422 #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST) 423 # define ALWAYS(X) (1) 424 # define NEVER(X) (0) 425 #elif !defined(NDEBUG) 426 # define ALWAYS(X) ((X)?1:(assert(0),0)) 427 # define NEVER(X) ((X)?(assert(0),1):0) 428 #else 429 # define ALWAYS(X) (X) 430 # define NEVER(X) (X) 431 #endif 432 433 /* 434 ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is 435 ** defined. We need to defend against those failures when testing with 436 ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches 437 ** during a normal build. The following macro can be used to disable tests 438 ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set. 439 */ 440 #if defined(SQLITE_TEST_REALLOC_STRESS) 441 # define ONLY_IF_REALLOC_STRESS(X) (X) 442 #elif !defined(NDEBUG) 443 # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0) 444 #else 445 # define ONLY_IF_REALLOC_STRESS(X) (0) 446 #endif 447 448 /* 449 ** Declarations used for tracing the operating system interfaces. 450 */ 451 #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \ 452 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 453 extern int sqlite3OSTrace; 454 # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X 455 # define SQLITE_HAVE_OS_TRACE 456 #else 457 # define OSTRACE(X) 458 # undef SQLITE_HAVE_OS_TRACE 459 #endif 460 461 /* 462 ** Is the sqlite3ErrName() function needed in the build? Currently, 463 ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when 464 ** OSTRACE is enabled), and by several "test*.c" files (which are 465 ** compiled using SQLITE_TEST). 466 */ 467 #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \ 468 (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 469 # define SQLITE_NEED_ERR_NAME 470 #else 471 # undef SQLITE_NEED_ERR_NAME 472 #endif 473 474 /* 475 ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN 476 */ 477 #ifdef SQLITE_OMIT_EXPLAIN 478 # undef SQLITE_ENABLE_EXPLAIN_COMMENTS 479 #endif 480 481 /* 482 ** Return true (non-zero) if the input is an integer that is too large 483 ** to fit in 32-bits. This macro is used inside of various testcase() 484 ** macros to verify that we have tested SQLite for large-file support. 485 */ 486 #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 487 488 /* 489 ** The macro unlikely() is a hint that surrounds a boolean 490 ** expression that is usually false. Macro likely() surrounds 491 ** a boolean expression that is usually true. These hints could, 492 ** in theory, be used by the compiler to generate better code, but 493 ** currently they are just comments for human readers. 494 */ 495 #define likely(X) (X) 496 #define unlikely(X) (X) 497 498 #include "hash.h" 499 #include "parse.h" 500 #include <stdio.h> 501 #include <stdlib.h> 502 #include <string.h> 503 #include <assert.h> 504 #include <stddef.h> 505 506 /* 507 ** If compiling for a processor that lacks floating point support, 508 ** substitute integer for floating-point 509 */ 510 #ifdef SQLITE_OMIT_FLOATING_POINT 511 # define double sqlite_int64 512 # define float sqlite_int64 513 # define LONGDOUBLE_TYPE sqlite_int64 514 # ifndef SQLITE_BIG_DBL 515 # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 516 # endif 517 # define SQLITE_OMIT_DATETIME_FUNCS 1 518 # define SQLITE_OMIT_TRACE 1 519 # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 520 # undef SQLITE_HAVE_ISNAN 521 #endif 522 #ifndef SQLITE_BIG_DBL 523 # define SQLITE_BIG_DBL (1e99) 524 #endif 525 526 /* 527 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 528 ** afterward. Having this macro allows us to cause the C compiler 529 ** to omit code used by TEMP tables without messy #ifndef statements. 530 */ 531 #ifdef SQLITE_OMIT_TEMPDB 532 #define OMIT_TEMPDB 1 533 #else 534 #define OMIT_TEMPDB 0 535 #endif 536 537 /* 538 ** The "file format" number is an integer that is incremented whenever 539 ** the VDBE-level file format changes. The following macros define the 540 ** the default file format for new databases and the maximum file format 541 ** that the library can read. 542 */ 543 #define SQLITE_MAX_FILE_FORMAT 4 544 #ifndef SQLITE_DEFAULT_FILE_FORMAT 545 # define SQLITE_DEFAULT_FILE_FORMAT 4 546 #endif 547 548 /* 549 ** Determine whether triggers are recursive by default. This can be 550 ** changed at run-time using a pragma. 551 */ 552 #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 553 # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 554 #endif 555 556 /* 557 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 558 ** on the command-line 559 */ 560 #ifndef SQLITE_TEMP_STORE 561 # define SQLITE_TEMP_STORE 1 562 # define SQLITE_TEMP_STORE_xc 1 /* Exclude from ctime.c */ 563 #endif 564 565 /* 566 ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if 567 ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it 568 ** to zero. 569 */ 570 #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0 571 # undef SQLITE_MAX_WORKER_THREADS 572 # define SQLITE_MAX_WORKER_THREADS 0 573 #endif 574 #ifndef SQLITE_MAX_WORKER_THREADS 575 # define SQLITE_MAX_WORKER_THREADS 8 576 #endif 577 #ifndef SQLITE_DEFAULT_WORKER_THREADS 578 # define SQLITE_DEFAULT_WORKER_THREADS 0 579 #endif 580 #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS 581 # undef SQLITE_MAX_WORKER_THREADS 582 # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS 583 #endif 584 585 /* 586 ** The default initial allocation for the pagecache when using separate 587 ** pagecaches for each database connection. A positive number is the 588 ** number of pages. A negative number N translations means that a buffer 589 ** of -1024*N bytes is allocated and used for as many pages as it will hold. 590 */ 591 #ifndef SQLITE_DEFAULT_PCACHE_INITSZ 592 # define SQLITE_DEFAULT_PCACHE_INITSZ 100 593 #endif 594 595 /* 596 ** GCC does not define the offsetof() macro so we'll have to do it 597 ** ourselves. 598 */ 599 #ifndef offsetof 600 #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 601 #endif 602 603 /* 604 ** Macros to compute minimum and maximum of two numbers. 605 */ 606 #ifndef MIN 607 # define MIN(A,B) ((A)<(B)?(A):(B)) 608 #endif 609 #ifndef MAX 610 # define MAX(A,B) ((A)>(B)?(A):(B)) 611 #endif 612 613 /* 614 ** Swap two objects of type TYPE. 615 */ 616 #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;} 617 618 /* 619 ** Check to see if this machine uses EBCDIC. (Yes, believe it or 620 ** not, there are still machines out there that use EBCDIC.) 621 */ 622 #if 'A' == '\301' 623 # define SQLITE_EBCDIC 1 624 #else 625 # define SQLITE_ASCII 1 626 #endif 627 628 /* 629 ** Integers of known sizes. These typedefs might change for architectures 630 ** where the sizes very. Preprocessor macros are available so that the 631 ** types can be conveniently redefined at compile-type. Like this: 632 ** 633 ** cc '-DUINTPTR_TYPE=long long int' ... 634 */ 635 #ifndef UINT32_TYPE 636 # ifdef HAVE_UINT32_T 637 # define UINT32_TYPE uint32_t 638 # else 639 # define UINT32_TYPE unsigned int 640 # endif 641 #endif 642 #ifndef UINT16_TYPE 643 # ifdef HAVE_UINT16_T 644 # define UINT16_TYPE uint16_t 645 # else 646 # define UINT16_TYPE unsigned short int 647 # endif 648 #endif 649 #ifndef INT16_TYPE 650 # ifdef HAVE_INT16_T 651 # define INT16_TYPE int16_t 652 # else 653 # define INT16_TYPE short int 654 # endif 655 #endif 656 #ifndef UINT8_TYPE 657 # ifdef HAVE_UINT8_T 658 # define UINT8_TYPE uint8_t 659 # else 660 # define UINT8_TYPE unsigned char 661 # endif 662 #endif 663 #ifndef INT8_TYPE 664 # ifdef HAVE_INT8_T 665 # define INT8_TYPE int8_t 666 # else 667 # define INT8_TYPE signed char 668 # endif 669 #endif 670 #ifndef LONGDOUBLE_TYPE 671 # define LONGDOUBLE_TYPE long double 672 #endif 673 typedef sqlite_int64 i64; /* 8-byte signed integer */ 674 typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 675 typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 676 typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 677 typedef INT16_TYPE i16; /* 2-byte signed integer */ 678 typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 679 typedef INT8_TYPE i8; /* 1-byte signed integer */ 680 681 /* 682 ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 683 ** that can be stored in a u32 without loss of data. The value 684 ** is 0x00000000ffffffff. But because of quirks of some compilers, we 685 ** have to specify the value in the less intuitive manner shown: 686 */ 687 #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 688 689 /* 690 ** The datatype used to store estimates of the number of rows in a 691 ** table or index. This is an unsigned integer type. For 99.9% of 692 ** the world, a 32-bit integer is sufficient. But a 64-bit integer 693 ** can be used at compile-time if desired. 694 */ 695 #ifdef SQLITE_64BIT_STATS 696 typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */ 697 #else 698 typedef u32 tRowcnt; /* 32-bit is the default */ 699 #endif 700 701 /* 702 ** Estimated quantities used for query planning are stored as 16-bit 703 ** logarithms. For quantity X, the value stored is 10*log2(X). This 704 ** gives a possible range of values of approximately 1.0e986 to 1e-986. 705 ** But the allowed values are "grainy". Not every value is representable. 706 ** For example, quantities 16 and 17 are both represented by a LogEst 707 ** of 40. However, since LogEst quantities are suppose to be estimates, 708 ** not exact values, this imprecision is not a problem. 709 ** 710 ** "LogEst" is short for "Logarithmic Estimate". 711 ** 712 ** Examples: 713 ** 1 -> 0 20 -> 43 10000 -> 132 714 ** 2 -> 10 25 -> 46 25000 -> 146 715 ** 3 -> 16 100 -> 66 1000000 -> 199 716 ** 4 -> 20 1000 -> 99 1048576 -> 200 717 ** 10 -> 33 1024 -> 100 4294967296 -> 320 718 ** 719 ** The LogEst can be negative to indicate fractional values. 720 ** Examples: 721 ** 722 ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40 723 */ 724 typedef INT16_TYPE LogEst; 725 726 /* 727 ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer 728 */ 729 #ifndef SQLITE_PTRSIZE 730 # if defined(__SIZEOF_POINTER__) 731 # define SQLITE_PTRSIZE __SIZEOF_POINTER__ 732 # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 733 defined(_M_ARM) || defined(__arm__) || defined(__x86) 734 # define SQLITE_PTRSIZE 4 735 # else 736 # define SQLITE_PTRSIZE 8 737 # endif 738 #endif 739 740 /* The uptr type is an unsigned integer large enough to hold a pointer 741 */ 742 #if defined(HAVE_STDINT_H) 743 typedef uintptr_t uptr; 744 #elif SQLITE_PTRSIZE==4 745 typedef u32 uptr; 746 #else 747 typedef u64 uptr; 748 #endif 749 750 /* 751 ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to 752 ** something between S (inclusive) and E (exclusive). 753 ** 754 ** In other words, S is a buffer and E is a pointer to the first byte after 755 ** the end of buffer S. This macro returns true if P points to something 756 ** contained within the buffer S. 757 */ 758 #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E))) 759 760 761 /* 762 ** Macros to determine whether the machine is big or little endian, 763 ** and whether or not that determination is run-time or compile-time. 764 ** 765 ** For best performance, an attempt is made to guess at the byte-order 766 ** using C-preprocessor macros. If that is unsuccessful, or if 767 ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined 768 ** at run-time. 769 */ 770 #if (defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 771 defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \ 772 defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \ 773 defined(__arm__)) && !defined(SQLITE_RUNTIME_BYTEORDER) 774 # define SQLITE_BYTEORDER 1234 775 # define SQLITE_BIGENDIAN 0 776 # define SQLITE_LITTLEENDIAN 1 777 # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 778 #endif 779 #if (defined(sparc) || defined(__ppc__)) \ 780 && !defined(SQLITE_RUNTIME_BYTEORDER) 781 # define SQLITE_BYTEORDER 4321 782 # define SQLITE_BIGENDIAN 1 783 # define SQLITE_LITTLEENDIAN 0 784 # define SQLITE_UTF16NATIVE SQLITE_UTF16BE 785 #endif 786 #if !defined(SQLITE_BYTEORDER) 787 # ifdef SQLITE_AMALGAMATION 788 const int sqlite3one = 1; 789 # else 790 extern const int sqlite3one; 791 # endif 792 # define SQLITE_BYTEORDER 0 /* 0 means "unknown at compile-time" */ 793 # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 794 # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 795 # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 796 #endif 797 798 /* 799 ** Constants for the largest and smallest possible 64-bit signed integers. 800 ** These macros are designed to work correctly on both 32-bit and 64-bit 801 ** compilers. 802 */ 803 #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 804 #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 805 806 /* 807 ** Round up a number to the next larger multiple of 8. This is used 808 ** to force 8-byte alignment on 64-bit architectures. 809 */ 810 #define ROUND8(x) (((x)+7)&~7) 811 812 /* 813 ** Round down to the nearest multiple of 8 814 */ 815 #define ROUNDDOWN8(x) ((x)&~7) 816 817 /* 818 ** Assert that the pointer X is aligned to an 8-byte boundary. This 819 ** macro is used only within assert() to verify that the code gets 820 ** all alignment restrictions correct. 821 ** 822 ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 823 ** underlying malloc() implementation might return us 4-byte aligned 824 ** pointers. In that case, only verify 4-byte alignment. 825 */ 826 #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 827 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 828 #else 829 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 830 #endif 831 832 /* 833 ** Disable MMAP on platforms where it is known to not work 834 */ 835 #if defined(__OpenBSD__) || defined(__QNXNTO__) 836 # undef SQLITE_MAX_MMAP_SIZE 837 # define SQLITE_MAX_MMAP_SIZE 0 838 #endif 839 840 /* 841 ** Default maximum size of memory used by memory-mapped I/O in the VFS 842 */ 843 #ifdef __APPLE__ 844 # include <TargetConditionals.h> 845 #endif 846 #ifndef SQLITE_MAX_MMAP_SIZE 847 # if defined(__linux__) \ 848 || defined(_WIN32) \ 849 || (defined(__APPLE__) && defined(__MACH__)) \ 850 || defined(__sun) \ 851 || defined(__FreeBSD__) \ 852 || defined(__DragonFly__) 853 # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */ 854 # else 855 # define SQLITE_MAX_MMAP_SIZE 0 856 # endif 857 # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */ 858 #endif 859 860 /* 861 ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger 862 ** default MMAP_SIZE is specified at compile-time, make sure that it does 863 ** not exceed the maximum mmap size. 864 */ 865 #ifndef SQLITE_DEFAULT_MMAP_SIZE 866 # define SQLITE_DEFAULT_MMAP_SIZE 0 867 # define SQLITE_DEFAULT_MMAP_SIZE_xc 1 /* Exclude from ctime.c */ 868 #endif 869 #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE 870 # undef SQLITE_DEFAULT_MMAP_SIZE 871 # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE 872 #endif 873 874 /* 875 ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined. 876 ** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also 877 ** define SQLITE_ENABLE_STAT3_OR_STAT4 878 */ 879 #ifdef SQLITE_ENABLE_STAT4 880 # undef SQLITE_ENABLE_STAT3 881 # define SQLITE_ENABLE_STAT3_OR_STAT4 1 882 #elif SQLITE_ENABLE_STAT3 883 # define SQLITE_ENABLE_STAT3_OR_STAT4 1 884 #elif SQLITE_ENABLE_STAT3_OR_STAT4 885 # undef SQLITE_ENABLE_STAT3_OR_STAT4 886 #endif 887 888 /* 889 ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not 890 ** the Select query generator tracing logic is turned on. 891 */ 892 #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_SELECTTRACE) 893 # define SELECTTRACE_ENABLED 1 894 #else 895 # define SELECTTRACE_ENABLED 0 896 #endif 897 898 /* 899 ** An instance of the following structure is used to store the busy-handler 900 ** callback for a given sqlite handle. 901 ** 902 ** The sqlite.busyHandler member of the sqlite struct contains the busy 903 ** callback for the database handle. Each pager opened via the sqlite 904 ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 905 ** callback is currently invoked only from within pager.c. 906 */ 907 typedef struct BusyHandler BusyHandler; 908 struct BusyHandler { 909 int (*xFunc)(void *,int); /* The busy callback */ 910 void *pArg; /* First arg to busy callback */ 911 int nBusy; /* Incremented with each busy call */ 912 }; 913 914 /* 915 ** Name of the master database table. The master database table 916 ** is a special table that holds the names and attributes of all 917 ** user tables and indices. 918 */ 919 #define MASTER_NAME "sqlite_master" 920 #define TEMP_MASTER_NAME "sqlite_temp_master" 921 922 /* 923 ** The root-page of the master database table. 924 */ 925 #define MASTER_ROOT 1 926 927 /* 928 ** The name of the schema table. 929 */ 930 #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME) 931 932 /* 933 ** A convenience macro that returns the number of elements in 934 ** an array. 935 */ 936 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 937 938 /* 939 ** Determine if the argument is a power of two 940 */ 941 #define IsPowerOfTwo(X) (((X)&((X)-1))==0) 942 943 /* 944 ** The following value as a destructor means to use sqlite3DbFree(). 945 ** The sqlite3DbFree() routine requires two parameters instead of the 946 ** one parameter that destructors normally want. So we have to introduce 947 ** this magic value that the code knows to handle differently. Any 948 ** pointer will work here as long as it is distinct from SQLITE_STATIC 949 ** and SQLITE_TRANSIENT. 950 */ 951 #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize) 952 953 /* 954 ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 955 ** not support Writable Static Data (WSD) such as global and static variables. 956 ** All variables must either be on the stack or dynamically allocated from 957 ** the heap. When WSD is unsupported, the variable declarations scattered 958 ** throughout the SQLite code must become constants instead. The SQLITE_WSD 959 ** macro is used for this purpose. And instead of referencing the variable 960 ** directly, we use its constant as a key to lookup the run-time allocated 961 ** buffer that holds real variable. The constant is also the initializer 962 ** for the run-time allocated buffer. 963 ** 964 ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 965 ** macros become no-ops and have zero performance impact. 966 */ 967 #ifdef SQLITE_OMIT_WSD 968 #define SQLITE_WSD const 969 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 970 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 971 int sqlite3_wsd_init(int N, int J); 972 void *sqlite3_wsd_find(void *K, int L); 973 #else 974 #define SQLITE_WSD 975 #define GLOBAL(t,v) v 976 #define sqlite3GlobalConfig sqlite3Config 977 #endif 978 979 /* 980 ** The following macros are used to suppress compiler warnings and to 981 ** make it clear to human readers when a function parameter is deliberately 982 ** left unused within the body of a function. This usually happens when 983 ** a function is called via a function pointer. For example the 984 ** implementation of an SQL aggregate step callback may not use the 985 ** parameter indicating the number of arguments passed to the aggregate, 986 ** if it knows that this is enforced elsewhere. 987 ** 988 ** When a function parameter is not used at all within the body of a function, 989 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 990 ** However, these macros may also be used to suppress warnings related to 991 ** parameters that may or may not be used depending on compilation options. 992 ** For example those parameters only used in assert() statements. In these 993 ** cases the parameters are named as per the usual conventions. 994 */ 995 #define UNUSED_PARAMETER(x) (void)(x) 996 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 997 998 /* 999 ** Forward references to structures 1000 */ 1001 typedef struct AggInfo AggInfo; 1002 typedef struct AuthContext AuthContext; 1003 typedef struct AutoincInfo AutoincInfo; 1004 typedef struct Bitvec Bitvec; 1005 typedef struct CollSeq CollSeq; 1006 typedef struct Column Column; 1007 typedef struct Db Db; 1008 typedef struct Schema Schema; 1009 typedef struct Expr Expr; 1010 typedef struct ExprList ExprList; 1011 typedef struct ExprSpan ExprSpan; 1012 typedef struct FKey FKey; 1013 typedef struct FuncDestructor FuncDestructor; 1014 typedef struct FuncDef FuncDef; 1015 typedef struct FuncDefHash FuncDefHash; 1016 typedef struct IdList IdList; 1017 typedef struct Index Index; 1018 typedef struct IndexSample IndexSample; 1019 typedef struct KeyClass KeyClass; 1020 typedef struct KeyInfo KeyInfo; 1021 typedef struct Lookaside Lookaside; 1022 typedef struct LookasideSlot LookasideSlot; 1023 typedef struct Module Module; 1024 typedef struct NameContext NameContext; 1025 typedef struct Parse Parse; 1026 typedef struct PreUpdate PreUpdate; 1027 typedef struct PrintfArguments PrintfArguments; 1028 typedef struct RowSet RowSet; 1029 typedef struct Savepoint Savepoint; 1030 typedef struct Select Select; 1031 typedef struct SQLiteThread SQLiteThread; 1032 typedef struct SelectDest SelectDest; 1033 typedef struct SrcList SrcList; 1034 typedef struct StrAccum StrAccum; 1035 typedef struct Table Table; 1036 typedef struct TableLock TableLock; 1037 typedef struct Token Token; 1038 typedef struct TreeView TreeView; 1039 typedef struct Trigger Trigger; 1040 typedef struct TriggerPrg TriggerPrg; 1041 typedef struct TriggerStep TriggerStep; 1042 typedef struct UnpackedRecord UnpackedRecord; 1043 typedef struct VTable VTable; 1044 typedef struct VtabCtx VtabCtx; 1045 typedef struct Walker Walker; 1046 typedef struct WhereInfo WhereInfo; 1047 typedef struct With With; 1048 1049 /* 1050 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 1051 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 1052 ** pointer types (i.e. FuncDef) defined above. 1053 */ 1054 #include "btree.h" 1055 #include "vdbe.h" 1056 #include "pager.h" 1057 #include "pcache.h" 1058 #include "os.h" 1059 #include "mutex.h" 1060 1061 /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default 1062 ** synchronous setting to EXTRA. It is no longer supported. 1063 */ 1064 #ifdef SQLITE_EXTRA_DURABLE 1065 # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE 1066 # define SQLITE_DEFAULT_SYNCHRONOUS 3 1067 #endif 1068 1069 /* 1070 ** Default synchronous levels. 1071 ** 1072 ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ 1073 ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1. 1074 ** 1075 ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS 1076 ** OFF 1 0 1077 ** NORMAL 2 1 1078 ** FULL 3 2 1079 ** EXTRA 4 3 1080 ** 1081 ** The "PRAGMA synchronous" statement also uses the zero-based numbers. 1082 ** In other words, the zero-based numbers are used for all external interfaces 1083 ** and the one-based values are used internally. 1084 */ 1085 #ifndef SQLITE_DEFAULT_SYNCHRONOUS 1086 # define SQLITE_DEFAULT_SYNCHRONOUS (PAGER_SYNCHRONOUS_FULL-1) 1087 #endif 1088 #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS 1089 # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS 1090 #endif 1091 1092 /* 1093 ** Each database file to be accessed by the system is an instance 1094 ** of the following structure. There are normally two of these structures 1095 ** in the sqlite.aDb[] array. aDb[0] is the main database file and 1096 ** aDb[1] is the database file used to hold temporary tables. Additional 1097 ** databases may be attached. 1098 */ 1099 struct Db { 1100 char *zDbSName; /* Name of this database. (schema name, not filename) */ 1101 Btree *pBt; /* The B*Tree structure for this database file */ 1102 u8 safety_level; /* How aggressive at syncing data to disk */ 1103 u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */ 1104 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 1105 }; 1106 1107 /* 1108 ** An instance of the following structure stores a database schema. 1109 ** 1110 ** Most Schema objects are associated with a Btree. The exception is 1111 ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 1112 ** In shared cache mode, a single Schema object can be shared by multiple 1113 ** Btrees that refer to the same underlying BtShared object. 1114 ** 1115 ** Schema objects are automatically deallocated when the last Btree that 1116 ** references them is destroyed. The TEMP Schema is manually freed by 1117 ** sqlite3_close(). 1118 * 1119 ** A thread must be holding a mutex on the corresponding Btree in order 1120 ** to access Schema content. This implies that the thread must also be 1121 ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 1122 ** For a TEMP Schema, only the connection mutex is required. 1123 */ 1124 struct Schema { 1125 int schema_cookie; /* Database schema version number for this file */ 1126 int iGeneration; /* Generation counter. Incremented with each change */ 1127 Hash tblHash; /* All tables indexed by name */ 1128 Hash idxHash; /* All (named) indices indexed by name */ 1129 Hash trigHash; /* All triggers indexed by name */ 1130 Hash fkeyHash; /* All foreign keys by referenced table name */ 1131 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 1132 u8 file_format; /* Schema format version for this file */ 1133 u8 enc; /* Text encoding used by this database */ 1134 u16 schemaFlags; /* Flags associated with this schema */ 1135 int cache_size; /* Number of pages to use in the cache */ 1136 }; 1137 1138 /* 1139 ** These macros can be used to test, set, or clear bits in the 1140 ** Db.pSchema->flags field. 1141 */ 1142 #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P)) 1143 #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0) 1144 #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P) 1145 #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P) 1146 1147 /* 1148 ** Allowed values for the DB.pSchema->flags field. 1149 ** 1150 ** The DB_SchemaLoaded flag is set after the database schema has been 1151 ** read into internal hash tables. 1152 ** 1153 ** DB_UnresetViews means that one or more views have column names that 1154 ** have been filled out. If the schema changes, these column names might 1155 ** changes and so the view will need to be reset. 1156 */ 1157 #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 1158 #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 1159 #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */ 1160 1161 /* 1162 ** The number of different kinds of things that can be limited 1163 ** using the sqlite3_limit() interface. 1164 */ 1165 #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1) 1166 1167 /* 1168 ** Lookaside malloc is a set of fixed-size buffers that can be used 1169 ** to satisfy small transient memory allocation requests for objects 1170 ** associated with a particular database connection. The use of 1171 ** lookaside malloc provides a significant performance enhancement 1172 ** (approx 10%) by avoiding numerous malloc/free requests while parsing 1173 ** SQL statements. 1174 ** 1175 ** The Lookaside structure holds configuration information about the 1176 ** lookaside malloc subsystem. Each available memory allocation in 1177 ** the lookaside subsystem is stored on a linked list of LookasideSlot 1178 ** objects. 1179 ** 1180 ** Lookaside allocations are only allowed for objects that are associated 1181 ** with a particular database connection. Hence, schema information cannot 1182 ** be stored in lookaside because in shared cache mode the schema information 1183 ** is shared by multiple database connections. Therefore, while parsing 1184 ** schema information, the Lookaside.bEnabled flag is cleared so that 1185 ** lookaside allocations are not used to construct the schema objects. 1186 */ 1187 struct Lookaside { 1188 u32 bDisable; /* Only operate the lookaside when zero */ 1189 u16 sz; /* Size of each buffer in bytes */ 1190 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 1191 int nOut; /* Number of buffers currently checked out */ 1192 int mxOut; /* Highwater mark for nOut */ 1193 int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 1194 LookasideSlot *pFree; /* List of available buffers */ 1195 void *pStart; /* First byte of available memory space */ 1196 void *pEnd; /* First byte past end of available space */ 1197 }; 1198 struct LookasideSlot { 1199 LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 1200 }; 1201 1202 /* 1203 ** A hash table for built-in function definitions. (Application-defined 1204 ** functions use a regular table table from hash.h.) 1205 ** 1206 ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 1207 ** Collisions are on the FuncDef.u.pHash chain. 1208 */ 1209 #define SQLITE_FUNC_HASH_SZ 23 1210 struct FuncDefHash { 1211 FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */ 1212 }; 1213 1214 #ifdef SQLITE_USER_AUTHENTICATION 1215 /* 1216 ** Information held in the "sqlite3" database connection object and used 1217 ** to manage user authentication. 1218 */ 1219 typedef struct sqlite3_userauth sqlite3_userauth; 1220 struct sqlite3_userauth { 1221 u8 authLevel; /* Current authentication level */ 1222 int nAuthPW; /* Size of the zAuthPW in bytes */ 1223 char *zAuthPW; /* Password used to authenticate */ 1224 char *zAuthUser; /* User name used to authenticate */ 1225 }; 1226 1227 /* Allowed values for sqlite3_userauth.authLevel */ 1228 #define UAUTH_Unknown 0 /* Authentication not yet checked */ 1229 #define UAUTH_Fail 1 /* User authentication failed */ 1230 #define UAUTH_User 2 /* Authenticated as a normal user */ 1231 #define UAUTH_Admin 3 /* Authenticated as an administrator */ 1232 1233 /* Functions used only by user authorization logic */ 1234 int sqlite3UserAuthTable(const char*); 1235 int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*); 1236 void sqlite3UserAuthInit(sqlite3*); 1237 void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**); 1238 1239 #endif /* SQLITE_USER_AUTHENTICATION */ 1240 1241 /* 1242 ** typedef for the authorization callback function. 1243 */ 1244 #ifdef SQLITE_USER_AUTHENTICATION 1245 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 1246 const char*, const char*); 1247 #else 1248 typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 1249 const char*); 1250 #endif 1251 1252 #ifndef SQLITE_OMIT_DEPRECATED 1253 /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing 1254 ** in the style of sqlite3_trace() 1255 */ 1256 #define SQLITE_TRACE_LEGACY 0x80 1257 #else 1258 #define SQLITE_TRACE_LEGACY 0 1259 #endif /* SQLITE_OMIT_DEPRECATED */ 1260 1261 1262 /* 1263 ** Each database connection is an instance of the following structure. 1264 */ 1265 struct sqlite3 { 1266 sqlite3_vfs *pVfs; /* OS Interface */ 1267 struct Vdbe *pVdbe; /* List of active virtual machines */ 1268 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */ 1269 sqlite3_mutex *mutex; /* Connection mutex */ 1270 Db *aDb; /* All backends */ 1271 int nDb; /* Number of backends currently in use */ 1272 int flags; /* Miscellaneous flags. See below */ 1273 i64 lastRowid; /* ROWID of most recent insert (see above) */ 1274 i64 szMmap; /* Default mmap_size setting */ 1275 unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 1276 int errCode; /* Most recent error code (SQLITE_*) */ 1277 int errMask; /* & result codes with this before returning */ 1278 int iSysErrno; /* Errno value from last system error */ 1279 u16 dbOptFlags; /* Flags to enable/disable optimizations */ 1280 u8 enc; /* Text encoding */ 1281 u8 autoCommit; /* The auto-commit flag. */ 1282 u8 temp_store; /* 1: file 2: memory 0: default */ 1283 u8 mallocFailed; /* True if we have seen a malloc failure */ 1284 u8 bBenignMalloc; /* Do not require OOMs if true */ 1285 u8 dfltLockMode; /* Default locking-mode for attached dbs */ 1286 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 1287 u8 suppressErr; /* Do not issue error messages if true */ 1288 u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */ 1289 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 1290 u8 mTrace; /* zero or more SQLITE_TRACE flags */ 1291 int nextPagesize; /* Pagesize after VACUUM if >0 */ 1292 u32 magic; /* Magic number for detect library misuse */ 1293 int nChange; /* Value returned by sqlite3_changes() */ 1294 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 1295 int aLimit[SQLITE_N_LIMIT]; /* Limits */ 1296 int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */ 1297 struct sqlite3InitInfo { /* Information used during initialization */ 1298 int newTnum; /* Rootpage of table being initialized */ 1299 u8 iDb; /* Which db file is being initialized */ 1300 u8 busy; /* TRUE if currently initializing */ 1301 u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */ 1302 u8 imposterTable; /* Building an imposter table */ 1303 } init; 1304 int nVdbeActive; /* Number of VDBEs currently running */ 1305 int nVdbeRead; /* Number of active VDBEs that read or write */ 1306 int nVdbeWrite; /* Number of active VDBEs that read and write */ 1307 int nVdbeExec; /* Number of nested calls to VdbeExec() */ 1308 int nVDestroy; /* Number of active OP_VDestroy operations */ 1309 int nExtension; /* Number of loaded extensions */ 1310 void **aExtension; /* Array of shared library handles */ 1311 int (*xTrace)(u32,void*,void*,void*); /* Trace function */ 1312 void *pTraceArg; /* Argument to the trace function */ 1313 void (*xProfile)(void*,const char*,u64); /* Profiling function */ 1314 void *pProfileArg; /* Argument to profile function */ 1315 void *pCommitArg; /* Argument to xCommitCallback() */ 1316 int (*xCommitCallback)(void*); /* Invoked at every commit. */ 1317 void *pRollbackArg; /* Argument to xRollbackCallback() */ 1318 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 1319 void *pUpdateArg; 1320 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 1321 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK 1322 void *pPreUpdateArg; /* First argument to xPreUpdateCallback */ 1323 void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */ 1324 void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64 1325 ); 1326 PreUpdate *pPreUpdate; /* Context for active pre-update callback */ 1327 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */ 1328 #ifndef SQLITE_OMIT_WAL 1329 int (*xWalCallback)(void *, sqlite3 *, const char *, int); 1330 void *pWalArg; 1331 #endif 1332 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 1333 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 1334 void *pCollNeededArg; 1335 sqlite3_value *pErr; /* Most recent error message */ 1336 union { 1337 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 1338 double notUsed1; /* Spacer */ 1339 } u1; 1340 Lookaside lookaside; /* Lookaside malloc configuration */ 1341 #ifndef SQLITE_OMIT_AUTHORIZATION 1342 sqlite3_xauth xAuth; /* Access authorization function */ 1343 void *pAuthArg; /* 1st argument to the access auth function */ 1344 #endif 1345 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 1346 int (*xProgress)(void *); /* The progress callback */ 1347 void *pProgressArg; /* Argument to the progress callback */ 1348 unsigned nProgressOps; /* Number of opcodes for progress callback */ 1349 #endif 1350 #ifndef SQLITE_OMIT_VIRTUALTABLE 1351 int nVTrans; /* Allocated size of aVTrans */ 1352 Hash aModule; /* populated by sqlite3_create_module() */ 1353 VtabCtx *pVtabCtx; /* Context for active vtab connect/create */ 1354 VTable **aVTrans; /* Virtual tables with open transactions */ 1355 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 1356 #endif 1357 Hash aFunc; /* Hash table of connection functions */ 1358 Hash aCollSeq; /* All collating sequences */ 1359 BusyHandler busyHandler; /* Busy callback */ 1360 Db aDbStatic[2]; /* Static space for the 2 default backends */ 1361 Savepoint *pSavepoint; /* List of active savepoints */ 1362 int busyTimeout; /* Busy handler timeout, in msec */ 1363 int nSavepoint; /* Number of non-transaction savepoints */ 1364 int nStatement; /* Number of nested statement-transactions */ 1365 i64 nDeferredCons; /* Net deferred constraints this transaction. */ 1366 i64 nDeferredImmCons; /* Net deferred immediate constraints */ 1367 int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 1368 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 1369 /* The following variables are all protected by the STATIC_MASTER 1370 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 1371 ** 1372 ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 1373 ** unlock so that it can proceed. 1374 ** 1375 ** When X.pBlockingConnection==Y, that means that something that X tried 1376 ** tried to do recently failed with an SQLITE_LOCKED error due to locks 1377 ** held by Y. 1378 */ 1379 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 1380 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 1381 void *pUnlockArg; /* Argument to xUnlockNotify */ 1382 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 1383 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 1384 #endif 1385 #ifdef SQLITE_USER_AUTHENTICATION 1386 sqlite3_userauth auth; /* User authentication information */ 1387 #endif 1388 }; 1389 1390 /* 1391 ** A macro to discover the encoding of a database. 1392 */ 1393 #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc) 1394 #define ENC(db) ((db)->enc) 1395 1396 /* 1397 ** Possible values for the sqlite3.flags. 1398 ** 1399 ** Value constraints (enforced via assert()): 1400 ** SQLITE_FullFSync == PAGER_FULLFSYNC 1401 ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC 1402 ** SQLITE_CacheSpill == PAGER_CACHE_SPILL 1403 */ 1404 #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */ 1405 #define SQLITE_InternChanges 0x00000002 /* Uncommitted Hash table changes */ 1406 #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */ 1407 #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */ 1408 #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */ 1409 #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */ 1410 #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 1411 #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */ 1412 /* DELETE, or UPDATE and return */ 1413 /* the count using a callback. */ 1414 #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 1415 /* result set is empty */ 1416 #define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */ 1417 #define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */ 1418 #define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */ 1419 #define SQLITE_VdbeAddopTrace 0x00001000 /* Trace sqlite3VdbeAddOp() calls */ 1420 #define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */ 1421 #define SQLITE_ReadUncommitted 0x0004000 /* For shared-cache mode */ 1422 #define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */ 1423 #define SQLITE_RecoveryMode 0x00010000 /* Ignore schema errors */ 1424 #define SQLITE_ReverseOrder 0x00020000 /* Reverse unordered SELECTs */ 1425 #define SQLITE_RecTriggers 0x00040000 /* Enable recursive triggers */ 1426 #define SQLITE_ForeignKeys 0x00080000 /* Enforce foreign key constraints */ 1427 #define SQLITE_AutoIndex 0x00100000 /* Enable automatic indexes */ 1428 #define SQLITE_PreferBuiltin 0x00200000 /* Preference to built-in funcs */ 1429 #define SQLITE_LoadExtension 0x00400000 /* Enable load_extension */ 1430 #define SQLITE_LoadExtFunc 0x00800000 /* Enable load_extension() SQL func */ 1431 #define SQLITE_EnableTrigger 0x01000000 /* True to enable triggers */ 1432 #define SQLITE_DeferFKs 0x02000000 /* Defer all FK constraints */ 1433 #define SQLITE_QueryOnly 0x04000000 /* Disable database changes */ 1434 #define SQLITE_VdbeEQP 0x08000000 /* Debug EXPLAIN QUERY PLAN */ 1435 #define SQLITE_Vacuum 0x10000000 /* Currently in a VACUUM */ 1436 #define SQLITE_CellSizeCk 0x20000000 /* Check btree cell sizes on load */ 1437 #define SQLITE_Fts3Tokenizer 0x40000000 /* Enable fts3_tokenizer(2) */ 1438 #define SQLITE_NoCkptOnClose 0x80000000 /* No checkpoint on close()/DETACH */ 1439 1440 1441 /* 1442 ** Bits of the sqlite3.dbOptFlags field that are used by the 1443 ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to 1444 ** selectively disable various optimizations. 1445 */ 1446 #define SQLITE_QueryFlattener 0x0001 /* Query flattening */ 1447 #define SQLITE_ColumnCache 0x0002 /* Column cache */ 1448 #define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */ 1449 #define SQLITE_FactorOutConst 0x0008 /* Constant factoring */ 1450 /* not used 0x0010 // Was: SQLITE_IdxRealAsInt */ 1451 #define SQLITE_DistinctOpt 0x0020 /* DISTINCT using indexes */ 1452 #define SQLITE_CoverIdxScan 0x0040 /* Covering index scans */ 1453 #define SQLITE_OrderByIdxJoin 0x0080 /* ORDER BY of joins via index */ 1454 #define SQLITE_SubqCoroutine 0x0100 /* Evaluate subqueries as coroutines */ 1455 #define SQLITE_Transitive 0x0200 /* Transitive constraints */ 1456 #define SQLITE_OmitNoopJoin 0x0400 /* Omit unused tables in joins */ 1457 #define SQLITE_Stat34 0x0800 /* Use STAT3 or STAT4 data */ 1458 #define SQLITE_CursorHints 0x2000 /* Add OP_CursorHint opcodes */ 1459 #define SQLITE_AllOpts 0xffff /* All optimizations */ 1460 1461 /* 1462 ** Macros for testing whether or not optimizations are enabled or disabled. 1463 */ 1464 #ifndef SQLITE_OMIT_BUILTIN_TEST 1465 #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0) 1466 #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0) 1467 #else 1468 #define OptimizationDisabled(db, mask) 0 1469 #define OptimizationEnabled(db, mask) 1 1470 #endif 1471 1472 /* 1473 ** Return true if it OK to factor constant expressions into the initialization 1474 ** code. The argument is a Parse object for the code generator. 1475 */ 1476 #define ConstFactorOk(P) ((P)->okConstFactor) 1477 1478 /* 1479 ** Possible values for the sqlite.magic field. 1480 ** The numbers are obtained at random and have no special meaning, other 1481 ** than being distinct from one another. 1482 */ 1483 #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 1484 #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 1485 #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 1486 #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 1487 #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 1488 #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */ 1489 1490 /* 1491 ** Each SQL function is defined by an instance of the following 1492 ** structure. For global built-in functions (ex: substr(), max(), count()) 1493 ** a pointer to this structure is held in the sqlite3BuiltinFunctions object. 1494 ** For per-connection application-defined functions, a pointer to this 1495 ** structure is held in the db->aHash hash table. 1496 ** 1497 ** The u.pHash field is used by the global built-ins. The u.pDestructor 1498 ** field is used by per-connection app-def functions. 1499 */ 1500 struct FuncDef { 1501 i8 nArg; /* Number of arguments. -1 means unlimited */ 1502 u16 funcFlags; /* Some combination of SQLITE_FUNC_* */ 1503 void *pUserData; /* User data parameter */ 1504 FuncDef *pNext; /* Next function with same name */ 1505 void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */ 1506 void (*xFinalize)(sqlite3_context*); /* Agg finalizer */ 1507 const char *zName; /* SQL name of the function. */ 1508 union { 1509 FuncDef *pHash; /* Next with a different name but the same hash */ 1510 FuncDestructor *pDestructor; /* Reference counted destructor function */ 1511 } u; 1512 }; 1513 1514 /* 1515 ** This structure encapsulates a user-function destructor callback (as 1516 ** configured using create_function_v2()) and a reference counter. When 1517 ** create_function_v2() is called to create a function with a destructor, 1518 ** a single object of this type is allocated. FuncDestructor.nRef is set to 1519 ** the number of FuncDef objects created (either 1 or 3, depending on whether 1520 ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 1521 ** member of each of the new FuncDef objects is set to point to the allocated 1522 ** FuncDestructor. 1523 ** 1524 ** Thereafter, when one of the FuncDef objects is deleted, the reference 1525 ** count on this object is decremented. When it reaches 0, the destructor 1526 ** is invoked and the FuncDestructor structure freed. 1527 */ 1528 struct FuncDestructor { 1529 int nRef; 1530 void (*xDestroy)(void *); 1531 void *pUserData; 1532 }; 1533 1534 /* 1535 ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF 1536 ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And 1537 ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There 1538 ** are assert() statements in the code to verify this. 1539 ** 1540 ** Value constraints (enforced via assert()): 1541 ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg 1542 ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG 1543 ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG 1544 ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API 1545 ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API 1546 */ 1547 #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */ 1548 #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */ 1549 #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */ 1550 #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */ 1551 #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/ 1552 #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */ 1553 #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */ 1554 #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */ 1555 #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */ 1556 #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */ 1557 #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */ 1558 #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */ 1559 #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a 1560 ** single query - might change over time */ 1561 1562 /* 1563 ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1564 ** used to create the initializers for the FuncDef structures. 1565 ** 1566 ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1567 ** Used to create a scalar function definition of a function zName 1568 ** implemented by C function xFunc that accepts nArg arguments. The 1569 ** value passed as iArg is cast to a (void*) and made available 1570 ** as the user-data (sqlite3_user_data()) for the function. If 1571 ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1572 ** 1573 ** VFUNCTION(zName, nArg, iArg, bNC, xFunc) 1574 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag. 1575 ** 1576 ** DFUNCTION(zName, nArg, iArg, bNC, xFunc) 1577 ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 1578 ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions 1579 ** and functions like sqlite_version() that can change, but not during 1580 ** a single query. 1581 ** 1582 ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1583 ** Used to create an aggregate function definition implemented by 1584 ** the C functions xStep and xFinal. The first four parameters 1585 ** are interpreted in the same way as the first 4 parameters to 1586 ** FUNCTION(). 1587 ** 1588 ** LIKEFUNC(zName, nArg, pArg, flags) 1589 ** Used to create a scalar function definition of a function zName 1590 ** that accepts nArg arguments and is implemented by a call to C 1591 ** function likeFunc. Argument pArg is cast to a (void *) and made 1592 ** available as the function user-data (sqlite3_user_data()). The 1593 ** FuncDef.flags variable is set to the value passed as the flags 1594 ** parameter. 1595 */ 1596 #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1597 {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1598 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} } 1599 #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1600 {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1601 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} } 1602 #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1603 {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1604 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} } 1605 #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \ 1606 {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\ 1607 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} } 1608 #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 1609 {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1610 pArg, 0, xFunc, 0, #zName, } 1611 #define LIKEFUNC(zName, nArg, arg, flags) \ 1612 {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \ 1613 (void *)arg, 0, likeFunc, 0, #zName, {0} } 1614 #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \ 1615 {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \ 1616 SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}} 1617 #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \ 1618 {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \ 1619 SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}} 1620 1621 /* 1622 ** All current savepoints are stored in a linked list starting at 1623 ** sqlite3.pSavepoint. The first element in the list is the most recently 1624 ** opened savepoint. Savepoints are added to the list by the vdbe 1625 ** OP_Savepoint instruction. 1626 */ 1627 struct Savepoint { 1628 char *zName; /* Savepoint name (nul-terminated) */ 1629 i64 nDeferredCons; /* Number of deferred fk violations */ 1630 i64 nDeferredImmCons; /* Number of deferred imm fk. */ 1631 Savepoint *pNext; /* Parent savepoint (if any) */ 1632 }; 1633 1634 /* 1635 ** The following are used as the second parameter to sqlite3Savepoint(), 1636 ** and as the P1 argument to the OP_Savepoint instruction. 1637 */ 1638 #define SAVEPOINT_BEGIN 0 1639 #define SAVEPOINT_RELEASE 1 1640 #define SAVEPOINT_ROLLBACK 2 1641 1642 1643 /* 1644 ** Each SQLite module (virtual table definition) is defined by an 1645 ** instance of the following structure, stored in the sqlite3.aModule 1646 ** hash table. 1647 */ 1648 struct Module { 1649 const sqlite3_module *pModule; /* Callback pointers */ 1650 const char *zName; /* Name passed to create_module() */ 1651 void *pAux; /* pAux passed to create_module() */ 1652 void (*xDestroy)(void *); /* Module destructor function */ 1653 Table *pEpoTab; /* Eponymous table for this module */ 1654 }; 1655 1656 /* 1657 ** information about each column of an SQL table is held in an instance 1658 ** of this structure. 1659 */ 1660 struct Column { 1661 char *zName; /* Name of this column, \000, then the type */ 1662 Expr *pDflt; /* Default value of this column */ 1663 char *zColl; /* Collating sequence. If NULL, use the default */ 1664 u8 notNull; /* An OE_ code for handling a NOT NULL constraint */ 1665 char affinity; /* One of the SQLITE_AFF_... values */ 1666 u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */ 1667 u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */ 1668 }; 1669 1670 /* Allowed values for Column.colFlags: 1671 */ 1672 #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */ 1673 #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */ 1674 #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */ 1675 1676 /* 1677 ** A "Collating Sequence" is defined by an instance of the following 1678 ** structure. Conceptually, a collating sequence consists of a name and 1679 ** a comparison routine that defines the order of that sequence. 1680 ** 1681 ** If CollSeq.xCmp is NULL, it means that the 1682 ** collating sequence is undefined. Indices built on an undefined 1683 ** collating sequence may not be read or written. 1684 */ 1685 struct CollSeq { 1686 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 1687 u8 enc; /* Text encoding handled by xCmp() */ 1688 void *pUser; /* First argument to xCmp() */ 1689 int (*xCmp)(void*,int, const void*, int, const void*); 1690 void (*xDel)(void*); /* Destructor for pUser */ 1691 }; 1692 1693 /* 1694 ** A sort order can be either ASC or DESC. 1695 */ 1696 #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 1697 #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 1698 #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */ 1699 1700 /* 1701 ** Column affinity types. 1702 ** 1703 ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 1704 ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 1705 ** the speed a little by numbering the values consecutively. 1706 ** 1707 ** But rather than start with 0 or 1, we begin with 'A'. That way, 1708 ** when multiple affinity types are concatenated into a string and 1709 ** used as the P4 operand, they will be more readable. 1710 ** 1711 ** Note also that the numeric types are grouped together so that testing 1712 ** for a numeric type is a single comparison. And the BLOB type is first. 1713 */ 1714 #define SQLITE_AFF_BLOB 'A' 1715 #define SQLITE_AFF_TEXT 'B' 1716 #define SQLITE_AFF_NUMERIC 'C' 1717 #define SQLITE_AFF_INTEGER 'D' 1718 #define SQLITE_AFF_REAL 'E' 1719 1720 #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 1721 1722 /* 1723 ** The SQLITE_AFF_MASK values masks off the significant bits of an 1724 ** affinity value. 1725 */ 1726 #define SQLITE_AFF_MASK 0x47 1727 1728 /* 1729 ** Additional bit values that can be ORed with an affinity without 1730 ** changing the affinity. 1731 ** 1732 ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL. 1733 ** It causes an assert() to fire if either operand to a comparison 1734 ** operator is NULL. It is added to certain comparison operators to 1735 ** prove that the operands are always NOT NULL. 1736 */ 1737 #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */ 1738 #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */ 1739 #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */ 1740 #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 1741 #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */ 1742 1743 /* 1744 ** An object of this type is created for each virtual table present in 1745 ** the database schema. 1746 ** 1747 ** If the database schema is shared, then there is one instance of this 1748 ** structure for each database connection (sqlite3*) that uses the shared 1749 ** schema. This is because each database connection requires its own unique 1750 ** instance of the sqlite3_vtab* handle used to access the virtual table 1751 ** implementation. sqlite3_vtab* handles can not be shared between 1752 ** database connections, even when the rest of the in-memory database 1753 ** schema is shared, as the implementation often stores the database 1754 ** connection handle passed to it via the xConnect() or xCreate() method 1755 ** during initialization internally. This database connection handle may 1756 ** then be used by the virtual table implementation to access real tables 1757 ** within the database. So that they appear as part of the callers 1758 ** transaction, these accesses need to be made via the same database 1759 ** connection as that used to execute SQL operations on the virtual table. 1760 ** 1761 ** All VTable objects that correspond to a single table in a shared 1762 ** database schema are initially stored in a linked-list pointed to by 1763 ** the Table.pVTable member variable of the corresponding Table object. 1764 ** When an sqlite3_prepare() operation is required to access the virtual 1765 ** table, it searches the list for the VTable that corresponds to the 1766 ** database connection doing the preparing so as to use the correct 1767 ** sqlite3_vtab* handle in the compiled query. 1768 ** 1769 ** When an in-memory Table object is deleted (for example when the 1770 ** schema is being reloaded for some reason), the VTable objects are not 1771 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 1772 ** immediately. Instead, they are moved from the Table.pVTable list to 1773 ** another linked list headed by the sqlite3.pDisconnect member of the 1774 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 1775 ** next time a statement is prepared using said sqlite3*. This is done 1776 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 1777 ** Refer to comments above function sqlite3VtabUnlockList() for an 1778 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 1779 ** list without holding the corresponding sqlite3.mutex mutex. 1780 ** 1781 ** The memory for objects of this type is always allocated by 1782 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 1783 ** the first argument. 1784 */ 1785 struct VTable { 1786 sqlite3 *db; /* Database connection associated with this table */ 1787 Module *pMod; /* Pointer to module implementation */ 1788 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 1789 int nRef; /* Number of pointers to this structure */ 1790 u8 bConstraint; /* True if constraints are supported */ 1791 int iSavepoint; /* Depth of the SAVEPOINT stack */ 1792 VTable *pNext; /* Next in linked list (see above) */ 1793 }; 1794 1795 /* 1796 ** The schema for each SQL table and view is represented in memory 1797 ** by an instance of the following structure. 1798 */ 1799 struct Table { 1800 char *zName; /* Name of the table or view */ 1801 Column *aCol; /* Information about each column */ 1802 Index *pIndex; /* List of SQL indexes on this table. */ 1803 Select *pSelect; /* NULL for tables. Points to definition if a view. */ 1804 FKey *pFKey; /* Linked list of all foreign keys in this table */ 1805 char *zColAff; /* String defining the affinity of each column */ 1806 ExprList *pCheck; /* All CHECK constraints */ 1807 /* ... also used as column name list in a VIEW */ 1808 int tnum; /* Root BTree page for this table */ 1809 i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */ 1810 i16 nCol; /* Number of columns in this table */ 1811 u16 nRef; /* Number of pointers to this Table */ 1812 LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */ 1813 LogEst szTabRow; /* Estimated size of each table row in bytes */ 1814 #ifdef SQLITE_ENABLE_COSTMULT 1815 LogEst costMult; /* Cost multiplier for using this table */ 1816 #endif 1817 u8 tabFlags; /* Mask of TF_* values */ 1818 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 1819 #ifndef SQLITE_OMIT_ALTERTABLE 1820 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 1821 #endif 1822 #ifndef SQLITE_OMIT_VIRTUALTABLE 1823 int nModuleArg; /* Number of arguments to the module */ 1824 char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */ 1825 VTable *pVTable; /* List of VTable objects. */ 1826 #endif 1827 Trigger *pTrigger; /* List of triggers stored in pSchema */ 1828 Schema *pSchema; /* Schema that contains this table */ 1829 Table *pNextZombie; /* Next on the Parse.pZombieTab list */ 1830 }; 1831 1832 /* 1833 ** Allowed values for Table.tabFlags. 1834 ** 1835 ** TF_OOOHidden applies to tables or view that have hidden columns that are 1836 ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING 1837 ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden, 1838 ** the TF_OOOHidden attribute would apply in this case. Such tables require 1839 ** special handling during INSERT processing. 1840 */ 1841 #define TF_Readonly 0x01 /* Read-only system table */ 1842 #define TF_Ephemeral 0x02 /* An ephemeral table */ 1843 #define TF_HasPrimaryKey 0x04 /* Table has a primary key */ 1844 #define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */ 1845 #define TF_Virtual 0x10 /* Is a virtual table */ 1846 #define TF_WithoutRowid 0x20 /* No rowid. PRIMARY KEY is the key */ 1847 #define TF_NoVisibleRowid 0x40 /* No user-visible "rowid" column */ 1848 #define TF_OOOHidden 0x80 /* Out-of-Order hidden columns */ 1849 1850 1851 /* 1852 ** Test to see whether or not a table is a virtual table. This is 1853 ** done as a macro so that it will be optimized out when virtual 1854 ** table support is omitted from the build. 1855 */ 1856 #ifndef SQLITE_OMIT_VIRTUALTABLE 1857 # define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0) 1858 #else 1859 # define IsVirtual(X) 0 1860 #endif 1861 1862 /* 1863 ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn() 1864 ** only works for non-virtual tables (ordinary tables and views) and is 1865 ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The 1866 ** IsHiddenColumn() macro is general purpose. 1867 */ 1868 #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS) 1869 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 1870 # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 1871 #elif !defined(SQLITE_OMIT_VIRTUALTABLE) 1872 # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 1873 # define IsOrdinaryHiddenColumn(X) 0 1874 #else 1875 # define IsHiddenColumn(X) 0 1876 # define IsOrdinaryHiddenColumn(X) 0 1877 #endif 1878 1879 1880 /* Does the table have a rowid */ 1881 #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0) 1882 #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0) 1883 1884 /* 1885 ** Each foreign key constraint is an instance of the following structure. 1886 ** 1887 ** A foreign key is associated with two tables. The "from" table is 1888 ** the table that contains the REFERENCES clause that creates the foreign 1889 ** key. The "to" table is the table that is named in the REFERENCES clause. 1890 ** Consider this example: 1891 ** 1892 ** CREATE TABLE ex1( 1893 ** a INTEGER PRIMARY KEY, 1894 ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 1895 ** ); 1896 ** 1897 ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 1898 ** Equivalent names: 1899 ** 1900 ** from-table == child-table 1901 ** to-table == parent-table 1902 ** 1903 ** Each REFERENCES clause generates an instance of the following structure 1904 ** which is attached to the from-table. The to-table need not exist when 1905 ** the from-table is created. The existence of the to-table is not checked. 1906 ** 1907 ** The list of all parents for child Table X is held at X.pFKey. 1908 ** 1909 ** A list of all children for a table named Z (which might not even exist) 1910 ** is held in Schema.fkeyHash with a hash key of Z. 1911 */ 1912 struct FKey { 1913 Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 1914 FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */ 1915 char *zTo; /* Name of table that the key points to (aka: Parent) */ 1916 FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */ 1917 FKey *pPrevTo; /* Previous with the same zTo */ 1918 int nCol; /* Number of columns in this key */ 1919 /* EV: R-30323-21917 */ 1920 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 1921 u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 1922 Trigger *apTrigger[2];/* Triggers for aAction[] actions */ 1923 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 1924 int iFrom; /* Index of column in pFrom */ 1925 char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */ 1926 } aCol[1]; /* One entry for each of nCol columns */ 1927 }; 1928 1929 /* 1930 ** SQLite supports many different ways to resolve a constraint 1931 ** error. ROLLBACK processing means that a constraint violation 1932 ** causes the operation in process to fail and for the current transaction 1933 ** to be rolled back. ABORT processing means the operation in process 1934 ** fails and any prior changes from that one operation are backed out, 1935 ** but the transaction is not rolled back. FAIL processing means that 1936 ** the operation in progress stops and returns an error code. But prior 1937 ** changes due to the same operation are not backed out and no rollback 1938 ** occurs. IGNORE means that the particular row that caused the constraint 1939 ** error is not inserted or updated. Processing continues and no error 1940 ** is returned. REPLACE means that preexisting database rows that caused 1941 ** a UNIQUE constraint violation are removed so that the new insert or 1942 ** update can proceed. Processing continues and no error is reported. 1943 ** 1944 ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys. 1945 ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 1946 ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 1947 ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the 1948 ** referenced table row is propagated into the row that holds the 1949 ** foreign key. 1950 ** 1951 ** The following symbolic values are used to record which type 1952 ** of action to take. 1953 */ 1954 #define OE_None 0 /* There is no constraint to check */ 1955 #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 1956 #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 1957 #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 1958 #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 1959 #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 1960 1961 #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 1962 #define OE_SetNull 7 /* Set the foreign key value to NULL */ 1963 #define OE_SetDflt 8 /* Set the foreign key value to its default */ 1964 #define OE_Cascade 9 /* Cascade the changes */ 1965 1966 #define OE_Default 10 /* Do whatever the default action is */ 1967 1968 1969 /* 1970 ** An instance of the following structure is passed as the first 1971 ** argument to sqlite3VdbeKeyCompare and is used to control the 1972 ** comparison of the two index keys. 1973 ** 1974 ** Note that aSortOrder[] and aColl[] have nField+1 slots. There 1975 ** are nField slots for the columns of an index then one extra slot 1976 ** for the rowid at the end. 1977 */ 1978 struct KeyInfo { 1979 u32 nRef; /* Number of references to this KeyInfo object */ 1980 u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 1981 u16 nField; /* Number of key columns in the index */ 1982 u16 nXField; /* Number of columns beyond the key columns */ 1983 sqlite3 *db; /* The database connection */ 1984 u8 *aSortOrder; /* Sort order for each column. */ 1985 CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 1986 }; 1987 1988 /* 1989 ** This object holds a record which has been parsed out into individual 1990 ** fields, for the purposes of doing a comparison. 1991 ** 1992 ** A record is an object that contains one or more fields of data. 1993 ** Records are used to store the content of a table row and to store 1994 ** the key of an index. A blob encoding of a record is created by 1995 ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 1996 ** OP_Column opcode. 1997 ** 1998 ** An instance of this object serves as a "key" for doing a search on 1999 ** an index b+tree. The goal of the search is to find the entry that 2000 ** is closed to the key described by this object. This object might hold 2001 ** just a prefix of the key. The number of fields is given by 2002 ** pKeyInfo->nField. 2003 ** 2004 ** The r1 and r2 fields are the values to return if this key is less than 2005 ** or greater than a key in the btree, respectively. These are normally 2006 ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree 2007 ** is in DESC order. 2008 ** 2009 ** The key comparison functions actually return default_rc when they find 2010 ** an equals comparison. default_rc can be -1, 0, or +1. If there are 2011 ** multiple entries in the b-tree with the same key (when only looking 2012 ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to 2013 ** cause the search to find the last match, or +1 to cause the search to 2014 ** find the first match. 2015 ** 2016 ** The key comparison functions will set eqSeen to true if they ever 2017 ** get and equal results when comparing this structure to a b-tree record. 2018 ** When default_rc!=0, the search might end up on the record immediately 2019 ** before the first match or immediately after the last match. The 2020 ** eqSeen field will indicate whether or not an exact match exists in the 2021 ** b-tree. 2022 */ 2023 struct UnpackedRecord { 2024 KeyInfo *pKeyInfo; /* Collation and sort-order information */ 2025 Mem *aMem; /* Values */ 2026 u16 nField; /* Number of entries in apMem[] */ 2027 i8 default_rc; /* Comparison result if keys are equal */ 2028 u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */ 2029 i8 r1; /* Value to return if (lhs > rhs) */ 2030 i8 r2; /* Value to return if (rhs < lhs) */ 2031 u8 eqSeen; /* True if an equality comparison has been seen */ 2032 }; 2033 2034 2035 /* 2036 ** Each SQL index is represented in memory by an 2037 ** instance of the following structure. 2038 ** 2039 ** The columns of the table that are to be indexed are described 2040 ** by the aiColumn[] field of this structure. For example, suppose 2041 ** we have the following table and index: 2042 ** 2043 ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 2044 ** CREATE INDEX Ex2 ON Ex1(c3,c1); 2045 ** 2046 ** In the Table structure describing Ex1, nCol==3 because there are 2047 ** three columns in the table. In the Index structure describing 2048 ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 2049 ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 2050 ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 2051 ** The second column to be indexed (c1) has an index of 0 in 2052 ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 2053 ** 2054 ** The Index.onError field determines whether or not the indexed columns 2055 ** must be unique and what to do if they are not. When Index.onError=OE_None, 2056 ** it means this is not a unique index. Otherwise it is a unique index 2057 ** and the value of Index.onError indicate the which conflict resolution 2058 ** algorithm to employ whenever an attempt is made to insert a non-unique 2059 ** element. 2060 ** 2061 ** While parsing a CREATE TABLE or CREATE INDEX statement in order to 2062 ** generate VDBE code (as opposed to parsing one read from an sqlite_master 2063 ** table as part of parsing an existing database schema), transient instances 2064 ** of this structure may be created. In this case the Index.tnum variable is 2065 ** used to store the address of a VDBE instruction, not a database page 2066 ** number (it cannot - the database page is not allocated until the VDBE 2067 ** program is executed). See convertToWithoutRowidTable() for details. 2068 */ 2069 struct Index { 2070 char *zName; /* Name of this index */ 2071 i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */ 2072 LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */ 2073 Table *pTable; /* The SQL table being indexed */ 2074 char *zColAff; /* String defining the affinity of each column */ 2075 Index *pNext; /* The next index associated with the same table */ 2076 Schema *pSchema; /* Schema containing this index */ 2077 u8 *aSortOrder; /* for each column: True==DESC, False==ASC */ 2078 const char **azColl; /* Array of collation sequence names for index */ 2079 Expr *pPartIdxWhere; /* WHERE clause for partial indices */ 2080 ExprList *aColExpr; /* Column expressions */ 2081 int tnum; /* DB Page containing root of this index */ 2082 LogEst szIdxRow; /* Estimated average row size in bytes */ 2083 u16 nKeyCol; /* Number of columns forming the key */ 2084 u16 nColumn; /* Number of columns stored in the index */ 2085 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 2086 unsigned idxType:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */ 2087 unsigned bUnordered:1; /* Use this index for == or IN queries only */ 2088 unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */ 2089 unsigned isResized:1; /* True if resizeIndexObject() has been called */ 2090 unsigned isCovering:1; /* True if this is a covering index */ 2091 unsigned noSkipScan:1; /* Do not try to use skip-scan if true */ 2092 #ifdef SQLITE_ENABLE_STAT3_OR_STAT4 2093 int nSample; /* Number of elements in aSample[] */ 2094 int nSampleCol; /* Size of IndexSample.anEq[] and so on */ 2095 tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */ 2096 IndexSample *aSample; /* Samples of the left-most key */ 2097 tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */ 2098 tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */ 2099 #endif 2100 }; 2101 2102 /* 2103 ** Allowed values for Index.idxType 2104 */ 2105 #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */ 2106 #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */ 2107 #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */ 2108 2109 /* Return true if index X is a PRIMARY KEY index */ 2110 #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY) 2111 2112 /* Return true if index X is a UNIQUE index */ 2113 #define IsUniqueIndex(X) ((X)->onError!=OE_None) 2114 2115 /* The Index.aiColumn[] values are normally positive integer. But 2116 ** there are some negative values that have special meaning: 2117 */ 2118 #define XN_ROWID (-1) /* Indexed column is the rowid */ 2119 #define XN_EXPR (-2) /* Indexed column is an expression */ 2120 2121 /* 2122 ** Each sample stored in the sqlite_stat3 table is represented in memory 2123 ** using a structure of this type. See documentation at the top of the 2124 ** analyze.c source file for additional information. 2125 */ 2126 struct IndexSample { 2127 void *p; /* Pointer to sampled record */ 2128 int n; /* Size of record in bytes */ 2129 tRowcnt *anEq; /* Est. number of rows where the key equals this sample */ 2130 tRowcnt *anLt; /* Est. number of rows where key is less than this sample */ 2131 tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */ 2132 }; 2133 2134 /* 2135 ** Each token coming out of the lexer is an instance of 2136 ** this structure. Tokens are also used as part of an expression. 2137 ** 2138 ** Note if Token.z==0 then Token.dyn and Token.n are undefined and 2139 ** may contain random values. Do not make any assumptions about Token.dyn 2140 ** and Token.n when Token.z==0. 2141 */ 2142 struct Token { 2143 const char *z; /* Text of the token. Not NULL-terminated! */ 2144 unsigned int n; /* Number of characters in this token */ 2145 }; 2146 2147 /* 2148 ** An instance of this structure contains information needed to generate 2149 ** code for a SELECT that contains aggregate functions. 2150 ** 2151 ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 2152 ** pointer to this structure. The Expr.iColumn field is the index in 2153 ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 2154 ** code for that node. 2155 ** 2156 ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 2157 ** original Select structure that describes the SELECT statement. These 2158 ** fields do not need to be freed when deallocating the AggInfo structure. 2159 */ 2160 struct AggInfo { 2161 u8 directMode; /* Direct rendering mode means take data directly 2162 ** from source tables rather than from accumulators */ 2163 u8 useSortingIdx; /* In direct mode, reference the sorting index rather 2164 ** than the source table */ 2165 int sortingIdx; /* Cursor number of the sorting index */ 2166 int sortingIdxPTab; /* Cursor number of pseudo-table */ 2167 int nSortingColumn; /* Number of columns in the sorting index */ 2168 int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */ 2169 ExprList *pGroupBy; /* The group by clause */ 2170 struct AggInfo_col { /* For each column used in source tables */ 2171 Table *pTab; /* Source table */ 2172 int iTable; /* Cursor number of the source table */ 2173 int iColumn; /* Column number within the source table */ 2174 int iSorterColumn; /* Column number in the sorting index */ 2175 int iMem; /* Memory location that acts as accumulator */ 2176 Expr *pExpr; /* The original expression */ 2177 } *aCol; 2178 int nColumn; /* Number of used entries in aCol[] */ 2179 int nAccumulator; /* Number of columns that show through to the output. 2180 ** Additional columns are used only as parameters to 2181 ** aggregate functions */ 2182 struct AggInfo_func { /* For each aggregate function */ 2183 Expr *pExpr; /* Expression encoding the function */ 2184 FuncDef *pFunc; /* The aggregate function implementation */ 2185 int iMem; /* Memory location that acts as accumulator */ 2186 int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 2187 } *aFunc; 2188 int nFunc; /* Number of entries in aFunc[] */ 2189 }; 2190 2191 /* 2192 ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 2193 ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 2194 ** than 32767 we have to make it 32-bit. 16-bit is preferred because 2195 ** it uses less memory in the Expr object, which is a big memory user 2196 ** in systems with lots of prepared statements. And few applications 2197 ** need more than about 10 or 20 variables. But some extreme users want 2198 ** to have prepared statements with over 32767 variables, and for them 2199 ** the option is available (at compile-time). 2200 */ 2201 #if SQLITE_MAX_VARIABLE_NUMBER<=32767 2202 typedef i16 ynVar; 2203 #else 2204 typedef int ynVar; 2205 #endif 2206 2207 /* 2208 ** Each node of an expression in the parse tree is an instance 2209 ** of this structure. 2210 ** 2211 ** Expr.op is the opcode. The integer parser token codes are reused 2212 ** as opcodes here. For example, the parser defines TK_GE to be an integer 2213 ** code representing the ">=" operator. This same integer code is reused 2214 ** to represent the greater-than-or-equal-to operator in the expression 2215 ** tree. 2216 ** 2217 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 2218 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 2219 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 2220 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 2221 ** then Expr.token contains the name of the function. 2222 ** 2223 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 2224 ** binary operator. Either or both may be NULL. 2225 ** 2226 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 2227 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 2228 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 2229 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 2230 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 2231 ** valid. 2232 ** 2233 ** An expression of the form ID or ID.ID refers to a column in a table. 2234 ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 2235 ** the integer cursor number of a VDBE cursor pointing to that table and 2236 ** Expr.iColumn is the column number for the specific column. If the 2237 ** expression is used as a result in an aggregate SELECT, then the 2238 ** value is also stored in the Expr.iAgg column in the aggregate so that 2239 ** it can be accessed after all aggregates are computed. 2240 ** 2241 ** If the expression is an unbound variable marker (a question mark 2242 ** character '?' in the original SQL) then the Expr.iTable holds the index 2243 ** number for that variable. 2244 ** 2245 ** If the expression is a subquery then Expr.iColumn holds an integer 2246 ** register number containing the result of the subquery. If the 2247 ** subquery gives a constant result, then iTable is -1. If the subquery 2248 ** gives a different answer at different times during statement processing 2249 ** then iTable is the address of a subroutine that computes the subquery. 2250 ** 2251 ** If the Expr is of type OP_Column, and the table it is selecting from 2252 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 2253 ** corresponding table definition. 2254 ** 2255 ** ALLOCATION NOTES: 2256 ** 2257 ** Expr objects can use a lot of memory space in database schema. To 2258 ** help reduce memory requirements, sometimes an Expr object will be 2259 ** truncated. And to reduce the number of memory allocations, sometimes 2260 ** two or more Expr objects will be stored in a single memory allocation, 2261 ** together with Expr.zToken strings. 2262 ** 2263 ** If the EP_Reduced and EP_TokenOnly flags are set when 2264 ** an Expr object is truncated. When EP_Reduced is set, then all 2265 ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 2266 ** are contained within the same memory allocation. Note, however, that 2267 ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 2268 ** allocated, regardless of whether or not EP_Reduced is set. 2269 */ 2270 struct Expr { 2271 u8 op; /* Operation performed by this node */ 2272 char affinity; /* The affinity of the column or 0 if not a column */ 2273 u32 flags; /* Various flags. EP_* See below */ 2274 union { 2275 char *zToken; /* Token value. Zero terminated and dequoted */ 2276 int iValue; /* Non-negative integer value if EP_IntValue */ 2277 } u; 2278 2279 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 2280 ** space is allocated for the fields below this point. An attempt to 2281 ** access them will result in a segfault or malfunction. 2282 *********************************************************************/ 2283 2284 Expr *pLeft; /* Left subnode */ 2285 Expr *pRight; /* Right subnode */ 2286 union { 2287 ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */ 2288 Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */ 2289 } x; 2290 2291 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 2292 ** space is allocated for the fields below this point. An attempt to 2293 ** access them will result in a segfault or malfunction. 2294 *********************************************************************/ 2295 2296 #if SQLITE_MAX_EXPR_DEPTH>0 2297 int nHeight; /* Height of the tree headed by this node */ 2298 #endif 2299 int iTable; /* TK_COLUMN: cursor number of table holding column 2300 ** TK_REGISTER: register number 2301 ** TK_TRIGGER: 1 -> new, 0 -> old 2302 ** EP_Unlikely: 134217728 times likelihood 2303 ** TK_SELECT: 1st register of result vector */ 2304 ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 2305 ** TK_VARIABLE: variable number (always >= 1). 2306 ** TK_SELECT_COLUMN: column of the result vector */ 2307 i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 2308 i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 2309 u8 op2; /* TK_REGISTER: original value of Expr.op 2310 ** TK_COLUMN: the value of p5 for OP_Column 2311 ** TK_AGG_FUNCTION: nesting depth */ 2312 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 2313 Table *pTab; /* Table for TK_COLUMN expressions. */ 2314 }; 2315 2316 /* 2317 ** The following are the meanings of bits in the Expr.flags field. 2318 */ 2319 #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */ 2320 #define EP_Agg 0x000002 /* Contains one or more aggregate functions */ 2321 #define EP_Resolved 0x000004 /* IDs have been resolved to COLUMNs */ 2322 #define EP_Error 0x000008 /* Expression contains one or more errors */ 2323 #define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */ 2324 #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */ 2325 #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */ 2326 #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */ 2327 #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */ 2328 #define EP_Generic 0x000200 /* Ignore COLLATE or affinity on this tree */ 2329 #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */ 2330 #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */ 2331 #define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */ 2332 #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */ 2333 #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */ 2334 #define EP_Static 0x008000 /* Held in memory not obtained from malloc() */ 2335 #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */ 2336 #define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */ 2337 #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */ 2338 #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */ 2339 #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */ 2340 #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */ 2341 #define EP_Alias 0x400000 /* Is an alias for a result set column */ 2342 #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */ 2343 2344 /* 2345 ** Combinations of two or more EP_* flags 2346 */ 2347 #define EP_Propagate (EP_Collate|EP_Subquery) /* Propagate these bits up tree */ 2348 2349 /* 2350 ** These macros can be used to test, set, or clear bits in the 2351 ** Expr.flags field. 2352 */ 2353 #define ExprHasProperty(E,P) (((E)->flags&(P))!=0) 2354 #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P)) 2355 #define ExprSetProperty(E,P) (E)->flags|=(P) 2356 #define ExprClearProperty(E,P) (E)->flags&=~(P) 2357 2358 /* The ExprSetVVAProperty() macro is used for Verification, Validation, 2359 ** and Accreditation only. It works like ExprSetProperty() during VVA 2360 ** processes but is a no-op for delivery. 2361 */ 2362 #ifdef SQLITE_DEBUG 2363 # define ExprSetVVAProperty(E,P) (E)->flags|=(P) 2364 #else 2365 # define ExprSetVVAProperty(E,P) 2366 #endif 2367 2368 /* 2369 ** Macros to determine the number of bytes required by a normal Expr 2370 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 2371 ** and an Expr struct with the EP_TokenOnly flag set. 2372 */ 2373 #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 2374 #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 2375 #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 2376 2377 /* 2378 ** Flags passed to the sqlite3ExprDup() function. See the header comment 2379 ** above sqlite3ExprDup() for details. 2380 */ 2381 #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 2382 2383 /* 2384 ** A list of expressions. Each expression may optionally have a 2385 ** name. An expr/name combination can be used in several ways, such 2386 ** as the list of "expr AS ID" fields following a "SELECT" or in the 2387 ** list of "ID = expr" items in an UPDATE. A list of expressions can 2388 ** also be used as the argument to a function, in which case the a.zName 2389 ** field is not used. 2390 ** 2391 ** By default the Expr.zSpan field holds a human-readable description of 2392 ** the expression that is used in the generation of error messages and 2393 ** column labels. In this case, Expr.zSpan is typically the text of a 2394 ** column expression as it exists in a SELECT statement. However, if 2395 ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name 2396 ** of the result column in the form: DATABASE.TABLE.COLUMN. This later 2397 ** form is used for name resolution with nested FROM clauses. 2398 */ 2399 struct ExprList { 2400 int nExpr; /* Number of expressions on the list */ 2401 struct ExprList_item { /* For each expression in the list */ 2402 Expr *pExpr; /* The list of expressions */ 2403 char *zName; /* Token associated with this expression */ 2404 char *zSpan; /* Original text of the expression */ 2405 u8 sortOrder; /* 1 for DESC or 0 for ASC */ 2406 unsigned done :1; /* A flag to indicate when processing is finished */ 2407 unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */ 2408 unsigned reusable :1; /* Constant expression is reusable */ 2409 union { 2410 struct { 2411 u16 iOrderByCol; /* For ORDER BY, column number in result set */ 2412 u16 iAlias; /* Index into Parse.aAlias[] for zName */ 2413 } x; 2414 int iConstExprReg; /* Register in which Expr value is cached */ 2415 } u; 2416 } *a; /* Alloc a power of two greater or equal to nExpr */ 2417 }; 2418 2419 /* 2420 ** An instance of this structure is used by the parser to record both 2421 ** the parse tree for an expression and the span of input text for an 2422 ** expression. 2423 */ 2424 struct ExprSpan { 2425 Expr *pExpr; /* The expression parse tree */ 2426 const char *zStart; /* First character of input text */ 2427 const char *zEnd; /* One character past the end of input text */ 2428 }; 2429 2430 /* 2431 ** An instance of this structure can hold a simple list of identifiers, 2432 ** such as the list "a,b,c" in the following statements: 2433 ** 2434 ** INSERT INTO t(a,b,c) VALUES ...; 2435 ** CREATE INDEX idx ON t(a,b,c); 2436 ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 2437 ** 2438 ** The IdList.a.idx field is used when the IdList represents the list of 2439 ** column names after a table name in an INSERT statement. In the statement 2440 ** 2441 ** INSERT INTO t(a,b,c) ... 2442 ** 2443 ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 2444 */ 2445 struct IdList { 2446 struct IdList_item { 2447 char *zName; /* Name of the identifier */ 2448 int idx; /* Index in some Table.aCol[] of a column named zName */ 2449 } *a; 2450 int nId; /* Number of identifiers on the list */ 2451 }; 2452 2453 /* 2454 ** The bitmask datatype defined below is used for various optimizations. 2455 ** 2456 ** Changing this from a 64-bit to a 32-bit type limits the number of 2457 ** tables in a join to 32 instead of 64. But it also reduces the size 2458 ** of the library by 738 bytes on ix86. 2459 */ 2460 #ifdef SQLITE_BITMASK_TYPE 2461 typedef SQLITE_BITMASK_TYPE Bitmask; 2462 #else 2463 typedef u64 Bitmask; 2464 #endif 2465 2466 /* 2467 ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 2468 */ 2469 #define BMS ((int)(sizeof(Bitmask)*8)) 2470 2471 /* 2472 ** A bit in a Bitmask 2473 */ 2474 #define MASKBIT(n) (((Bitmask)1)<<(n)) 2475 #define MASKBIT32(n) (((unsigned int)1)<<(n)) 2476 #define ALLBITS ((Bitmask)-1) 2477 2478 /* 2479 ** The following structure describes the FROM clause of a SELECT statement. 2480 ** Each table or subquery in the FROM clause is a separate element of 2481 ** the SrcList.a[] array. 2482 ** 2483 ** With the addition of multiple database support, the following structure 2484 ** can also be used to describe a particular table such as the table that 2485 ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 2486 ** such a table must be a simple name: ID. But in SQLite, the table can 2487 ** now be identified by a database name, a dot, then the table name: ID.ID. 2488 ** 2489 ** The jointype starts out showing the join type between the current table 2490 ** and the next table on the list. The parser builds the list this way. 2491 ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 2492 ** jointype expresses the join between the table and the previous table. 2493 ** 2494 ** In the colUsed field, the high-order bit (bit 63) is set if the table 2495 ** contains more than 63 columns and the 64-th or later column is used. 2496 */ 2497 struct SrcList { 2498 int nSrc; /* Number of tables or subqueries in the FROM clause */ 2499 u32 nAlloc; /* Number of entries allocated in a[] below */ 2500 struct SrcList_item { 2501 Schema *pSchema; /* Schema to which this item is fixed */ 2502 char *zDatabase; /* Name of database holding this table */ 2503 char *zName; /* Name of the table */ 2504 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 2505 Table *pTab; /* An SQL table corresponding to zName */ 2506 Select *pSelect; /* A SELECT statement used in place of a table name */ 2507 int addrFillSub; /* Address of subroutine to manifest a subquery */ 2508 int regReturn; /* Register holding return address of addrFillSub */ 2509 int regResult; /* Registers holding results of a co-routine */ 2510 struct { 2511 u8 jointype; /* Type of join between this table and the previous */ 2512 unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */ 2513 unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */ 2514 unsigned isTabFunc :1; /* True if table-valued-function syntax */ 2515 unsigned isCorrelated :1; /* True if sub-query is correlated */ 2516 unsigned viaCoroutine :1; /* Implemented as a co-routine */ 2517 unsigned isRecursive :1; /* True for recursive reference in WITH */ 2518 } fg; 2519 #ifndef SQLITE_OMIT_EXPLAIN 2520 u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */ 2521 #endif 2522 int iCursor; /* The VDBE cursor number used to access this table */ 2523 Expr *pOn; /* The ON clause of a join */ 2524 IdList *pUsing; /* The USING clause of a join */ 2525 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 2526 union { 2527 char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */ 2528 ExprList *pFuncArg; /* Arguments to table-valued-function */ 2529 } u1; 2530 Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */ 2531 } a[1]; /* One entry for each identifier on the list */ 2532 }; 2533 2534 /* 2535 ** Permitted values of the SrcList.a.jointype field 2536 */ 2537 #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 2538 #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 2539 #define JT_NATURAL 0x0004 /* True for a "natural" join */ 2540 #define JT_LEFT 0x0008 /* Left outer join */ 2541 #define JT_RIGHT 0x0010 /* Right outer join */ 2542 #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 2543 #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 2544 2545 2546 /* 2547 ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 2548 ** and the WhereInfo.wctrlFlags member. 2549 ** 2550 ** Value constraints (enforced via assert()): 2551 ** WHERE_USE_LIMIT == SF_FixedLimit 2552 */ 2553 #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 2554 #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 2555 #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 2556 #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 2557 #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */ 2558 #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */ 2559 #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of 2560 ** the OR optimization */ 2561 #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */ 2562 #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */ 2563 #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */ 2564 #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */ 2565 #define WHERE_SEEK_TABLE 0x0400 /* Do not defer seeks on main table */ 2566 #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */ 2567 /* 0x1000 not currently used */ 2568 /* 0x2000 not currently used */ 2569 #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */ 2570 /* 0x8000 not currently used */ 2571 2572 /* Allowed return values from sqlite3WhereIsDistinct() 2573 */ 2574 #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */ 2575 #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */ 2576 #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */ 2577 #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */ 2578 2579 /* 2580 ** A NameContext defines a context in which to resolve table and column 2581 ** names. The context consists of a list of tables (the pSrcList) field and 2582 ** a list of named expression (pEList). The named expression list may 2583 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 2584 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 2585 ** pEList corresponds to the result set of a SELECT and is NULL for 2586 ** other statements. 2587 ** 2588 ** NameContexts can be nested. When resolving names, the inner-most 2589 ** context is searched first. If no match is found, the next outer 2590 ** context is checked. If there is still no match, the next context 2591 ** is checked. This process continues until either a match is found 2592 ** or all contexts are check. When a match is found, the nRef member of 2593 ** the context containing the match is incremented. 2594 ** 2595 ** Each subquery gets a new NameContext. The pNext field points to the 2596 ** NameContext in the parent query. Thus the process of scanning the 2597 ** NameContext list corresponds to searching through successively outer 2598 ** subqueries looking for a match. 2599 */ 2600 struct NameContext { 2601 Parse *pParse; /* The parser */ 2602 SrcList *pSrcList; /* One or more tables used to resolve names */ 2603 ExprList *pEList; /* Optional list of result-set columns */ 2604 AggInfo *pAggInfo; /* Information about aggregates at this level */ 2605 NameContext *pNext; /* Next outer name context. NULL for outermost */ 2606 int nRef; /* Number of names resolved by this context */ 2607 int nErr; /* Number of errors encountered while resolving names */ 2608 u16 ncFlags; /* Zero or more NC_* flags defined below */ 2609 }; 2610 2611 /* 2612 ** Allowed values for the NameContext, ncFlags field. 2613 ** 2614 ** Value constraints (all checked via assert()): 2615 ** NC_HasAgg == SF_HasAgg 2616 ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX 2617 ** 2618 */ 2619 #define NC_AllowAgg 0x0001 /* Aggregate functions are allowed here */ 2620 #define NC_PartIdx 0x0002 /* True if resolving a partial index WHERE */ 2621 #define NC_IsCheck 0x0004 /* True if resolving names in a CHECK constraint */ 2622 #define NC_InAggFunc 0x0008 /* True if analyzing arguments to an agg func */ 2623 #define NC_HasAgg 0x0010 /* One or more aggregate functions seen */ 2624 #define NC_IdxExpr 0x0020 /* True if resolving columns of CREATE INDEX */ 2625 #define NC_VarSelect 0x0040 /* A correlated subquery has been seen */ 2626 #define NC_MinMaxAgg 0x1000 /* min/max aggregates seen. See note above */ 2627 2628 /* 2629 ** An instance of the following structure contains all information 2630 ** needed to generate code for a single SELECT statement. 2631 ** 2632 ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0. 2633 ** If there is a LIMIT clause, the parser sets nLimit to the value of the 2634 ** limit and nOffset to the value of the offset (or 0 if there is not 2635 ** offset). But later on, nLimit and nOffset become the memory locations 2636 ** in the VDBE that record the limit and offset counters. 2637 ** 2638 ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 2639 ** These addresses must be stored so that we can go back and fill in 2640 ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 2641 ** the number of columns in P2 can be computed at the same time 2642 ** as the OP_OpenEphm instruction is coded because not 2643 ** enough information about the compound query is known at that point. 2644 ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 2645 ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating 2646 ** sequences for the ORDER BY clause. 2647 */ 2648 struct Select { 2649 ExprList *pEList; /* The fields of the result */ 2650 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 2651 LogEst nSelectRow; /* Estimated number of result rows */ 2652 u32 selFlags; /* Various SF_* values */ 2653 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 2654 #if SELECTTRACE_ENABLED 2655 char zSelName[12]; /* Symbolic name of this SELECT use for debugging */ 2656 #endif 2657 int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */ 2658 SrcList *pSrc; /* The FROM clause */ 2659 Expr *pWhere; /* The WHERE clause */ 2660 ExprList *pGroupBy; /* The GROUP BY clause */ 2661 Expr *pHaving; /* The HAVING clause */ 2662 ExprList *pOrderBy; /* The ORDER BY clause */ 2663 Select *pPrior; /* Prior select in a compound select statement */ 2664 Select *pNext; /* Next select to the left in a compound */ 2665 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 2666 Expr *pOffset; /* OFFSET expression. NULL means not used. */ 2667 With *pWith; /* WITH clause attached to this select. Or NULL. */ 2668 }; 2669 2670 /* 2671 ** Allowed values for Select.selFlags. The "SF" prefix stands for 2672 ** "Select Flag". 2673 ** 2674 ** Value constraints (all checked via assert()) 2675 ** SF_HasAgg == NC_HasAgg 2676 ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX 2677 ** SF_FixedLimit == WHERE_USE_LIMIT 2678 */ 2679 #define SF_Distinct 0x00001 /* Output should be DISTINCT */ 2680 #define SF_All 0x00002 /* Includes the ALL keyword */ 2681 #define SF_Resolved 0x00004 /* Identifiers have been resolved */ 2682 #define SF_Aggregate 0x00008 /* Contains agg functions or a GROUP BY */ 2683 #define SF_HasAgg 0x00010 /* Contains aggregate functions */ 2684 #define SF_UsesEphemeral 0x00020 /* Uses the OpenEphemeral opcode */ 2685 #define SF_Expanded 0x00040 /* sqlite3SelectExpand() called on this */ 2686 #define SF_HasTypeInfo 0x00080 /* FROM subqueries have Table metadata */ 2687 #define SF_Compound 0x00100 /* Part of a compound query */ 2688 #define SF_Values 0x00200 /* Synthesized from VALUES clause */ 2689 #define SF_MultiValue 0x00400 /* Single VALUES term with multiple rows */ 2690 #define SF_NestedFrom 0x00800 /* Part of a parenthesized FROM clause */ 2691 #define SF_MinMaxAgg 0x01000 /* Aggregate containing min() or max() */ 2692 #define SF_Recursive 0x02000 /* The recursive part of a recursive CTE */ 2693 #define SF_FixedLimit 0x04000 /* nSelectRow set by a constant LIMIT */ 2694 #define SF_MaybeConvert 0x08000 /* Need convertCompoundSelectToSubquery() */ 2695 #define SF_Converted 0x10000 /* By convertCompoundSelectToSubquery() */ 2696 #define SF_IncludeHidden 0x20000 /* Include hidden columns in output */ 2697 2698 2699 /* 2700 ** The results of a SELECT can be distributed in several ways, as defined 2701 ** by one of the following macros. The "SRT" prefix means "SELECT Result 2702 ** Type". 2703 ** 2704 ** SRT_Union Store results as a key in a temporary index 2705 ** identified by pDest->iSDParm. 2706 ** 2707 ** SRT_Except Remove results from the temporary index pDest->iSDParm. 2708 ** 2709 ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result 2710 ** set is not empty. 2711 ** 2712 ** SRT_Discard Throw the results away. This is used by SELECT 2713 ** statements within triggers whose only purpose is 2714 ** the side-effects of functions. 2715 ** 2716 ** All of the above are free to ignore their ORDER BY clause. Those that 2717 ** follow must honor the ORDER BY clause. 2718 ** 2719 ** SRT_Output Generate a row of output (using the OP_ResultRow 2720 ** opcode) for each row in the result set. 2721 ** 2722 ** SRT_Mem Only valid if the result is a single column. 2723 ** Store the first column of the first result row 2724 ** in register pDest->iSDParm then abandon the rest 2725 ** of the query. This destination implies "LIMIT 1". 2726 ** 2727 ** SRT_Set The result must be a single column. Store each 2728 ** row of result as the key in table pDest->iSDParm. 2729 ** Apply the affinity pDest->affSdst before storing 2730 ** results. Used to implement "IN (SELECT ...)". 2731 ** 2732 ** SRT_EphemTab Create an temporary table pDest->iSDParm and store 2733 ** the result there. The cursor is left open after 2734 ** returning. This is like SRT_Table except that 2735 ** this destination uses OP_OpenEphemeral to create 2736 ** the table first. 2737 ** 2738 ** SRT_Coroutine Generate a co-routine that returns a new row of 2739 ** results each time it is invoked. The entry point 2740 ** of the co-routine is stored in register pDest->iSDParm 2741 ** and the result row is stored in pDest->nDest registers 2742 ** starting with pDest->iSdst. 2743 ** 2744 ** SRT_Table Store results in temporary table pDest->iSDParm. 2745 ** SRT_Fifo This is like SRT_EphemTab except that the table 2746 ** is assumed to already be open. SRT_Fifo has 2747 ** the additional property of being able to ignore 2748 ** the ORDER BY clause. 2749 ** 2750 ** SRT_DistFifo Store results in a temporary table pDest->iSDParm. 2751 ** But also use temporary table pDest->iSDParm+1 as 2752 ** a record of all prior results and ignore any duplicate 2753 ** rows. Name means: "Distinct Fifo". 2754 ** 2755 ** SRT_Queue Store results in priority queue pDest->iSDParm (really 2756 ** an index). Append a sequence number so that all entries 2757 ** are distinct. 2758 ** 2759 ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if 2760 ** the same record has never been stored before. The 2761 ** index at pDest->iSDParm+1 hold all prior stores. 2762 */ 2763 #define SRT_Union 1 /* Store result as keys in an index */ 2764 #define SRT_Except 2 /* Remove result from a UNION index */ 2765 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 2766 #define SRT_Discard 4 /* Do not save the results anywhere */ 2767 #define SRT_Fifo 5 /* Store result as data with an automatic rowid */ 2768 #define SRT_DistFifo 6 /* Like SRT_Fifo, but unique results only */ 2769 #define SRT_Queue 7 /* Store result in an queue */ 2770 #define SRT_DistQueue 8 /* Like SRT_Queue, but unique results only */ 2771 2772 /* The ORDER BY clause is ignored for all of the above */ 2773 #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue) 2774 2775 #define SRT_Output 9 /* Output each row of result */ 2776 #define SRT_Mem 10 /* Store result in a memory cell */ 2777 #define SRT_Set 11 /* Store results as keys in an index */ 2778 #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */ 2779 #define SRT_Coroutine 13 /* Generate a single row of result */ 2780 #define SRT_Table 14 /* Store result as data with an automatic rowid */ 2781 2782 /* 2783 ** An instance of this object describes where to put of the results of 2784 ** a SELECT statement. 2785 */ 2786 struct SelectDest { 2787 u8 eDest; /* How to dispose of the results. On of SRT_* above. */ 2788 char *zAffSdst; /* Affinity used when eDest==SRT_Set */ 2789 int iSDParm; /* A parameter used by the eDest disposal method */ 2790 int iSdst; /* Base register where results are written */ 2791 int nSdst; /* Number of registers allocated */ 2792 ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */ 2793 }; 2794 2795 /* 2796 ** During code generation of statements that do inserts into AUTOINCREMENT 2797 ** tables, the following information is attached to the Table.u.autoInc.p 2798 ** pointer of each autoincrement table to record some side information that 2799 ** the code generator needs. We have to keep per-table autoincrement 2800 ** information in case inserts are done within triggers. Triggers do not 2801 ** normally coordinate their activities, but we do need to coordinate the 2802 ** loading and saving of autoincrement information. 2803 */ 2804 struct AutoincInfo { 2805 AutoincInfo *pNext; /* Next info block in a list of them all */ 2806 Table *pTab; /* Table this info block refers to */ 2807 int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 2808 int regCtr; /* Memory register holding the rowid counter */ 2809 }; 2810 2811 /* 2812 ** Size of the column cache 2813 */ 2814 #ifndef SQLITE_N_COLCACHE 2815 # define SQLITE_N_COLCACHE 10 2816 #endif 2817 2818 /* 2819 ** At least one instance of the following structure is created for each 2820 ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 2821 ** statement. All such objects are stored in the linked list headed at 2822 ** Parse.pTriggerPrg and deleted once statement compilation has been 2823 ** completed. 2824 ** 2825 ** A Vdbe sub-program that implements the body and WHEN clause of trigger 2826 ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 2827 ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 2828 ** The Parse.pTriggerPrg list never contains two entries with the same 2829 ** values for both pTrigger and orconf. 2830 ** 2831 ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 2832 ** accessed (or set to 0 for triggers fired as a result of INSERT 2833 ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 2834 ** a mask of new.* columns used by the program. 2835 */ 2836 struct TriggerPrg { 2837 Trigger *pTrigger; /* Trigger this program was coded from */ 2838 TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 2839 SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 2840 int orconf; /* Default ON CONFLICT policy */ 2841 u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 2842 }; 2843 2844 /* 2845 ** The yDbMask datatype for the bitmask of all attached databases. 2846 */ 2847 #if SQLITE_MAX_ATTACHED>30 2848 typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8]; 2849 # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0) 2850 # define DbMaskZero(M) memset((M),0,sizeof(M)) 2851 # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7)) 2852 # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M) 2853 # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0) 2854 #else 2855 typedef unsigned int yDbMask; 2856 # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0) 2857 # define DbMaskZero(M) (M)=0 2858 # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I)) 2859 # define DbMaskAllZero(M) (M)==0 2860 # define DbMaskNonZero(M) (M)!=0 2861 #endif 2862 2863 /* 2864 ** An SQL parser context. A copy of this structure is passed through 2865 ** the parser and down into all the parser action routine in order to 2866 ** carry around information that is global to the entire parse. 2867 ** 2868 ** The structure is divided into two parts. When the parser and code 2869 ** generate call themselves recursively, the first part of the structure 2870 ** is constant but the second part is reset at the beginning and end of 2871 ** each recursion. 2872 ** 2873 ** The nTableLock and aTableLock variables are only used if the shared-cache 2874 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 2875 ** used to store the set of table-locks required by the statement being 2876 ** compiled. Function sqlite3TableLock() is used to add entries to the 2877 ** list. 2878 */ 2879 struct Parse { 2880 sqlite3 *db; /* The main database structure */ 2881 char *zErrMsg; /* An error message */ 2882 Vdbe *pVdbe; /* An engine for executing database bytecode */ 2883 int rc; /* Return code from execution */ 2884 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 2885 u8 checkSchema; /* Causes schema cookie check after an error */ 2886 u8 nested; /* Number of nested calls to the parser/code generator */ 2887 u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 2888 u8 isMultiWrite; /* True if statement may modify/insert multiple rows */ 2889 u8 mayAbort; /* True if statement may throw an ABORT exception */ 2890 u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */ 2891 u8 okConstFactor; /* OK to factor out constants */ 2892 u8 disableLookaside; /* Number of times lookaside has been disabled */ 2893 u8 nColCache; /* Number of entries in aColCache[] */ 2894 int nRangeReg; /* Size of the temporary register block */ 2895 int iRangeReg; /* First register in temporary register block */ 2896 int nErr; /* Number of errors seen */ 2897 int nTab; /* Number of previously allocated VDBE cursors */ 2898 int nMem; /* Number of memory cells used so far */ 2899 int nOpAlloc; /* Number of slots allocated for Vdbe.aOp[] */ 2900 int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */ 2901 int ckBase; /* Base register of data during check constraints */ 2902 int iSelfTab; /* Table of an index whose exprs are being coded */ 2903 int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */ 2904 int iCacheCnt; /* Counter used to generate aColCache[].lru values */ 2905 int nLabel; /* Number of labels used */ 2906 int *aLabel; /* Space to hold the labels */ 2907 ExprList *pConstExpr;/* Constant expressions */ 2908 Token constraintName;/* Name of the constraint currently being parsed */ 2909 yDbMask writeMask; /* Start a write transaction on these databases */ 2910 yDbMask cookieMask; /* Bitmask of schema verified databases */ 2911 int regRowid; /* Register holding rowid of CREATE TABLE entry */ 2912 int regRoot; /* Register holding root page number for new objects */ 2913 int nMaxArg; /* Max args passed to user function by sub-program */ 2914 #if SELECTTRACE_ENABLED 2915 int nSelect; /* Number of SELECT statements seen */ 2916 int nSelectIndent; /* How far to indent SELECTTRACE() output */ 2917 #endif 2918 #ifndef SQLITE_OMIT_SHARED_CACHE 2919 int nTableLock; /* Number of locks in aTableLock */ 2920 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 2921 #endif 2922 AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 2923 Parse *pToplevel; /* Parse structure for main program (or NULL) */ 2924 Table *pTriggerTab; /* Table triggers are being coded for */ 2925 int addrCrTab; /* Address of OP_CreateTable opcode on CREATE TABLE */ 2926 u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */ 2927 u32 oldmask; /* Mask of old.* columns referenced */ 2928 u32 newmask; /* Mask of new.* columns referenced */ 2929 u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 2930 u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 2931 u8 disableTriggers; /* True to disable triggers */ 2932 2933 /************************************************************************** 2934 ** Fields above must be initialized to zero. The fields that follow, 2935 ** down to the beginning of the recursive section, do not need to be 2936 ** initialized as they will be set before being used. The boundary is 2937 ** determined by offsetof(Parse,aColCache). 2938 **************************************************************************/ 2939 2940 struct yColCache { 2941 int iTable; /* Table cursor number */ 2942 i16 iColumn; /* Table column number */ 2943 u8 tempReg; /* iReg is a temp register that needs to be freed */ 2944 int iLevel; /* Nesting level */ 2945 int iReg; /* Reg with value of this column. 0 means none. */ 2946 int lru; /* Least recently used entry has the smallest value */ 2947 } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */ 2948 int aTempReg[8]; /* Holding area for temporary registers */ 2949 Token sNameToken; /* Token with unqualified schema object name */ 2950 Token sLastToken; /* The last token parsed */ 2951 2952 /************************************************************************ 2953 ** Above is constant between recursions. Below is reset before and after 2954 ** each recursion. The boundary between these two regions is determined 2955 ** using offsetof(Parse,nVar) so the nVar field must be the first field 2956 ** in the recursive region. 2957 ************************************************************************/ 2958 2959 ynVar nVar; /* Number of '?' variables seen in the SQL so far */ 2960 int nzVar; /* Number of available slots in azVar[] */ 2961 u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */ 2962 u8 explain; /* True if the EXPLAIN flag is found on the query */ 2963 #ifndef SQLITE_OMIT_VIRTUALTABLE 2964 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */ 2965 int nVtabLock; /* Number of virtual tables to lock */ 2966 #endif 2967 int nHeight; /* Expression tree height of current sub-select */ 2968 #ifndef SQLITE_OMIT_EXPLAIN 2969 int iSelectId; /* ID of current select for EXPLAIN output */ 2970 int iNextSelectId; /* Next available select ID for EXPLAIN output */ 2971 #endif 2972 char **azVar; /* Pointers to names of parameters */ 2973 Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 2974 const char *zTail; /* All SQL text past the last semicolon parsed */ 2975 Table *pNewTable; /* A table being constructed by CREATE TABLE */ 2976 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 2977 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 2978 #ifndef SQLITE_OMIT_VIRTUALTABLE 2979 Token sArg; /* Complete text of a module argument */ 2980 Table **apVtabLock; /* Pointer to virtual tables needing locking */ 2981 #endif 2982 Table *pZombieTab; /* List of Table objects to delete after code gen */ 2983 TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 2984 With *pWith; /* Current WITH clause, or NULL */ 2985 With *pWithToFree; /* Free this WITH object at the end of the parse */ 2986 }; 2987 2988 /* 2989 ** Sizes and pointers of various parts of the Parse object. 2990 */ 2991 #define PARSE_HDR_SZ offsetof(Parse,aColCache) /* Recursive part w/o aColCache*/ 2992 #define PARSE_RECURSE_SZ offsetof(Parse,nVar) /* Recursive part */ 2993 #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */ 2994 #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */ 2995 2996 /* 2997 ** Return true if currently inside an sqlite3_declare_vtab() call. 2998 */ 2999 #ifdef SQLITE_OMIT_VIRTUALTABLE 3000 #define IN_DECLARE_VTAB 0 3001 #else 3002 #define IN_DECLARE_VTAB (pParse->declareVtab) 3003 #endif 3004 3005 /* 3006 ** An instance of the following structure can be declared on a stack and used 3007 ** to save the Parse.zAuthContext value so that it can be restored later. 3008 */ 3009 struct AuthContext { 3010 const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 3011 Parse *pParse; /* The Parse structure */ 3012 }; 3013 3014 /* 3015 ** Bitfield flags for P5 value in various opcodes. 3016 ** 3017 ** Value constraints (enforced via assert()): 3018 ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH 3019 ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF 3020 ** OPFLAG_BULKCSR == BTREE_BULKLOAD 3021 ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ 3022 ** OPFLAG_FORDELETE == BTREE_FORDELETE 3023 ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION 3024 ** OPFLAG_AUXDELETE == BTREE_AUXDELETE 3025 */ 3026 #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */ 3027 /* Also used in P2 (not P5) of OP_Delete */ 3028 #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */ 3029 #define OPFLAG_LASTROWID 0x02 /* Set to update db->lastRowid */ 3030 #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 3031 #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 3032 #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 3033 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK 3034 #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */ 3035 #endif 3036 #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */ 3037 #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */ 3038 #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */ 3039 #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */ 3040 #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */ 3041 #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */ 3042 #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */ 3043 #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete: keep cursor position */ 3044 #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */ 3045 3046 /* 3047 * Each trigger present in the database schema is stored as an instance of 3048 * struct Trigger. 3049 * 3050 * Pointers to instances of struct Trigger are stored in two ways. 3051 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 3052 * database). This allows Trigger structures to be retrieved by name. 3053 * 2. All triggers associated with a single table form a linked list, using the 3054 * pNext member of struct Trigger. A pointer to the first element of the 3055 * linked list is stored as the "pTrigger" member of the associated 3056 * struct Table. 3057 * 3058 * The "step_list" member points to the first element of a linked list 3059 * containing the SQL statements specified as the trigger program. 3060 */ 3061 struct Trigger { 3062 char *zName; /* The name of the trigger */ 3063 char *table; /* The table or view to which the trigger applies */ 3064 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 3065 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 3066 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 3067 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 3068 the <column-list> is stored here */ 3069 Schema *pSchema; /* Schema containing the trigger */ 3070 Schema *pTabSchema; /* Schema containing the table */ 3071 TriggerStep *step_list; /* Link list of trigger program steps */ 3072 Trigger *pNext; /* Next trigger associated with the table */ 3073 }; 3074 3075 /* 3076 ** A trigger is either a BEFORE or an AFTER trigger. The following constants 3077 ** determine which. 3078 ** 3079 ** If there are multiple triggers, you might of some BEFORE and some AFTER. 3080 ** In that cases, the constants below can be ORed together. 3081 */ 3082 #define TRIGGER_BEFORE 1 3083 #define TRIGGER_AFTER 2 3084 3085 /* 3086 * An instance of struct TriggerStep is used to store a single SQL statement 3087 * that is a part of a trigger-program. 3088 * 3089 * Instances of struct TriggerStep are stored in a singly linked list (linked 3090 * using the "pNext" member) referenced by the "step_list" member of the 3091 * associated struct Trigger instance. The first element of the linked list is 3092 * the first step of the trigger-program. 3093 * 3094 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 3095 * "SELECT" statement. The meanings of the other members is determined by the 3096 * value of "op" as follows: 3097 * 3098 * (op == TK_INSERT) 3099 * orconf -> stores the ON CONFLICT algorithm 3100 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 3101 * this stores a pointer to the SELECT statement. Otherwise NULL. 3102 * zTarget -> Dequoted name of the table to insert into. 3103 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 3104 * this stores values to be inserted. Otherwise NULL. 3105 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 3106 * statement, then this stores the column-names to be 3107 * inserted into. 3108 * 3109 * (op == TK_DELETE) 3110 * zTarget -> Dequoted name of the table to delete from. 3111 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 3112 * Otherwise NULL. 3113 * 3114 * (op == TK_UPDATE) 3115 * zTarget -> Dequoted name of the table to update. 3116 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 3117 * Otherwise NULL. 3118 * pExprList -> A list of the columns to update and the expressions to update 3119 * them to. See sqlite3Update() documentation of "pChanges" 3120 * argument. 3121 * 3122 */ 3123 struct TriggerStep { 3124 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */ 3125 u8 orconf; /* OE_Rollback etc. */ 3126 Trigger *pTrig; /* The trigger that this step is a part of */ 3127 Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */ 3128 char *zTarget; /* Target table for DELETE, UPDATE, INSERT */ 3129 Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 3130 ExprList *pExprList; /* SET clause for UPDATE. */ 3131 IdList *pIdList; /* Column names for INSERT */ 3132 TriggerStep *pNext; /* Next in the link-list */ 3133 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 3134 }; 3135 3136 /* 3137 ** The following structure contains information used by the sqliteFix... 3138 ** routines as they walk the parse tree to make database references 3139 ** explicit. 3140 */ 3141 typedef struct DbFixer DbFixer; 3142 struct DbFixer { 3143 Parse *pParse; /* The parsing context. Error messages written here */ 3144 Schema *pSchema; /* Fix items to this schema */ 3145 int bVarOnly; /* Check for variable references only */ 3146 const char *zDb; /* Make sure all objects are contained in this database */ 3147 const char *zType; /* Type of the container - used for error messages */ 3148 const Token *pName; /* Name of the container - used for error messages */ 3149 }; 3150 3151 /* 3152 ** An objected used to accumulate the text of a string where we 3153 ** do not necessarily know how big the string will be in the end. 3154 */ 3155 struct StrAccum { 3156 sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 3157 char *zBase; /* A base allocation. Not from malloc. */ 3158 char *zText; /* The string collected so far */ 3159 u32 nChar; /* Length of the string so far */ 3160 u32 nAlloc; /* Amount of space allocated in zText */ 3161 u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */ 3162 u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */ 3163 u8 printfFlags; /* SQLITE_PRINTF flags below */ 3164 }; 3165 #define STRACCUM_NOMEM 1 3166 #define STRACCUM_TOOBIG 2 3167 #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */ 3168 #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */ 3169 #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */ 3170 3171 #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0) 3172 3173 3174 /* 3175 ** A pointer to this structure is used to communicate information 3176 ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 3177 */ 3178 typedef struct { 3179 sqlite3 *db; /* The database being initialized */ 3180 char **pzErrMsg; /* Error message stored here */ 3181 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 3182 int rc; /* Result code stored here */ 3183 } InitData; 3184 3185 /* 3186 ** Structure containing global configuration data for the SQLite library. 3187 ** 3188 ** This structure also contains some state information. 3189 */ 3190 struct Sqlite3Config { 3191 int bMemstat; /* True to enable memory status */ 3192 int bCoreMutex; /* True to enable core mutexing */ 3193 int bFullMutex; /* True to enable full mutexing */ 3194 int bOpenUri; /* True to interpret filenames as URIs */ 3195 int bUseCis; /* Use covering indices for full-scans */ 3196 int mxStrlen; /* Maximum string length */ 3197 int neverCorrupt; /* Database is always well-formed */ 3198 int szLookaside; /* Default lookaside buffer size */ 3199 int nLookaside; /* Default lookaside buffer count */ 3200 int nStmtSpill; /* Stmt-journal spill-to-disk threshold */ 3201 sqlite3_mem_methods m; /* Low-level memory allocation interface */ 3202 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 3203 sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */ 3204 void *pHeap; /* Heap storage space */ 3205 int nHeap; /* Size of pHeap[] */ 3206 int mnReq, mxReq; /* Min and max heap requests sizes */ 3207 sqlite3_int64 szMmap; /* mmap() space per open file */ 3208 sqlite3_int64 mxMmap; /* Maximum value for szMmap */ 3209 void *pScratch; /* Scratch memory */ 3210 int szScratch; /* Size of each scratch buffer */ 3211 int nScratch; /* Number of scratch buffers */ 3212 void *pPage; /* Page cache memory */ 3213 int szPage; /* Size of each page in pPage[] */ 3214 int nPage; /* Number of pages in pPage[] */ 3215 int mxParserStack; /* maximum depth of the parser stack */ 3216 int sharedCacheEnabled; /* true if shared-cache mode enabled */ 3217 u32 szPma; /* Maximum Sorter PMA size */ 3218 /* The above might be initialized to non-zero. The following need to always 3219 ** initially be zero, however. */ 3220 int isInit; /* True after initialization has finished */ 3221 int inProgress; /* True while initialization in progress */ 3222 int isMutexInit; /* True after mutexes are initialized */ 3223 int isMallocInit; /* True after malloc is initialized */ 3224 int isPCacheInit; /* True after malloc is initialized */ 3225 int nRefInitMutex; /* Number of users of pInitMutex */ 3226 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 3227 void (*xLog)(void*,int,const char*); /* Function for logging */ 3228 void *pLogArg; /* First argument to xLog() */ 3229 #ifdef SQLITE_ENABLE_SQLLOG 3230 void(*xSqllog)(void*,sqlite3*,const char*, int); 3231 void *pSqllogArg; 3232 #endif 3233 #ifdef SQLITE_VDBE_COVERAGE 3234 /* The following callback (if not NULL) is invoked on every VDBE branch 3235 ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE. 3236 */ 3237 void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx); /* Callback */ 3238 void *pVdbeBranchArg; /* 1st argument */ 3239 #endif 3240 #ifndef SQLITE_OMIT_BUILTIN_TEST 3241 int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */ 3242 #endif 3243 int bLocaltimeFault; /* True to fail localtime() calls */ 3244 int iOnceResetThreshold; /* When to reset OP_Once counters */ 3245 }; 3246 3247 /* 3248 ** This macro is used inside of assert() statements to indicate that 3249 ** the assert is only valid on a well-formed database. Instead of: 3250 ** 3251 ** assert( X ); 3252 ** 3253 ** One writes: 3254 ** 3255 ** assert( X || CORRUPT_DB ); 3256 ** 3257 ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate 3258 ** that the database is definitely corrupt, only that it might be corrupt. 3259 ** For most test cases, CORRUPT_DB is set to false using a special 3260 ** sqlite3_test_control(). This enables assert() statements to prove 3261 ** things that are always true for well-formed databases. 3262 */ 3263 #define CORRUPT_DB (sqlite3Config.neverCorrupt==0) 3264 3265 /* 3266 ** Context pointer passed down through the tree-walk. 3267 */ 3268 struct Walker { 3269 Parse *pParse; /* Parser context. */ 3270 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 3271 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 3272 void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */ 3273 int walkerDepth; /* Number of subqueries */ 3274 u8 eCode; /* A small processing code */ 3275 union { /* Extra data for callback */ 3276 NameContext *pNC; /* Naming context */ 3277 int n; /* A counter */ 3278 int iCur; /* A cursor number */ 3279 SrcList *pSrcList; /* FROM clause */ 3280 struct SrcCount *pSrcCount; /* Counting column references */ 3281 struct CCurHint *pCCurHint; /* Used by codeCursorHint() */ 3282 int *aiCol; /* array of column indexes */ 3283 struct IdxCover *pIdxCover; /* Check for index coverage */ 3284 } u; 3285 }; 3286 3287 /* Forward declarations */ 3288 int sqlite3WalkExpr(Walker*, Expr*); 3289 int sqlite3WalkExprList(Walker*, ExprList*); 3290 int sqlite3WalkSelect(Walker*, Select*); 3291 int sqlite3WalkSelectExpr(Walker*, Select*); 3292 int sqlite3WalkSelectFrom(Walker*, Select*); 3293 int sqlite3ExprWalkNoop(Walker*, Expr*); 3294 3295 /* 3296 ** Return code from the parse-tree walking primitives and their 3297 ** callbacks. 3298 */ 3299 #define WRC_Continue 0 /* Continue down into children */ 3300 #define WRC_Prune 1 /* Omit children but continue walking siblings */ 3301 #define WRC_Abort 2 /* Abandon the tree walk */ 3302 3303 /* 3304 ** An instance of this structure represents a set of one or more CTEs 3305 ** (common table expressions) created by a single WITH clause. 3306 */ 3307 struct With { 3308 int nCte; /* Number of CTEs in the WITH clause */ 3309 With *pOuter; /* Containing WITH clause, or NULL */ 3310 struct Cte { /* For each CTE in the WITH clause.... */ 3311 char *zName; /* Name of this CTE */ 3312 ExprList *pCols; /* List of explicit column names, or NULL */ 3313 Select *pSelect; /* The definition of this CTE */ 3314 const char *zCteErr; /* Error message for circular references */ 3315 } a[1]; 3316 }; 3317 3318 #ifdef SQLITE_DEBUG 3319 /* 3320 ** An instance of the TreeView object is used for printing the content of 3321 ** data structures on sqlite3DebugPrintf() using a tree-like view. 3322 */ 3323 struct TreeView { 3324 int iLevel; /* Which level of the tree we are on */ 3325 u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */ 3326 }; 3327 #endif /* SQLITE_DEBUG */ 3328 3329 /* 3330 ** Assuming zIn points to the first byte of a UTF-8 character, 3331 ** advance zIn to point to the first byte of the next UTF-8 character. 3332 */ 3333 #define SQLITE_SKIP_UTF8(zIn) { \ 3334 if( (*(zIn++))>=0xc0 ){ \ 3335 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 3336 } \ 3337 } 3338 3339 /* 3340 ** The SQLITE_*_BKPT macros are substitutes for the error codes with 3341 ** the same name but without the _BKPT suffix. These macros invoke 3342 ** routines that report the line-number on which the error originated 3343 ** using sqlite3_log(). The routines also provide a convenient place 3344 ** to set a debugger breakpoint. 3345 */ 3346 int sqlite3CorruptError(int); 3347 int sqlite3MisuseError(int); 3348 int sqlite3CantopenError(int); 3349 #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 3350 #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 3351 #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 3352 #ifdef SQLITE_DEBUG 3353 int sqlite3NomemError(int); 3354 int sqlite3IoerrnomemError(int); 3355 # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__) 3356 # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__) 3357 #else 3358 # define SQLITE_NOMEM_BKPT SQLITE_NOMEM 3359 # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM 3360 #endif 3361 3362 /* 3363 ** FTS3 and FTS4 both require virtual table support 3364 */ 3365 #if defined(SQLITE_OMIT_VIRTUALTABLE) 3366 # undef SQLITE_ENABLE_FTS3 3367 # undef SQLITE_ENABLE_FTS4 3368 #endif 3369 3370 /* 3371 ** FTS4 is really an extension for FTS3. It is enabled using the 3372 ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call 3373 ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3. 3374 */ 3375 #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 3376 # define SQLITE_ENABLE_FTS3 1 3377 #endif 3378 3379 /* 3380 ** The ctype.h header is needed for non-ASCII systems. It is also 3381 ** needed by FTS3 when FTS3 is included in the amalgamation. 3382 */ 3383 #if !defined(SQLITE_ASCII) || \ 3384 (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 3385 # include <ctype.h> 3386 #endif 3387 3388 /* 3389 ** The following macros mimic the standard library functions toupper(), 3390 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 3391 ** sqlite versions only work for ASCII characters, regardless of locale. 3392 */ 3393 #ifdef SQLITE_ASCII 3394 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 3395 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 3396 # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 3397 # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 3398 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 3399 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 3400 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 3401 # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80) 3402 #else 3403 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 3404 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 3405 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 3406 # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 3407 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 3408 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 3409 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 3410 # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`') 3411 #endif 3412 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 3413 int sqlite3IsIdChar(u8); 3414 #endif 3415 3416 /* 3417 ** Internal function prototypes 3418 */ 3419 int sqlite3StrICmp(const char*,const char*); 3420 int sqlite3Strlen30(const char*); 3421 char *sqlite3ColumnType(Column*,char*); 3422 #define sqlite3StrNICmp sqlite3_strnicmp 3423 3424 int sqlite3MallocInit(void); 3425 void sqlite3MallocEnd(void); 3426 void *sqlite3Malloc(u64); 3427 void *sqlite3MallocZero(u64); 3428 void *sqlite3DbMallocZero(sqlite3*, u64); 3429 void *sqlite3DbMallocRaw(sqlite3*, u64); 3430 void *sqlite3DbMallocRawNN(sqlite3*, u64); 3431 char *sqlite3DbStrDup(sqlite3*,const char*); 3432 char *sqlite3DbStrNDup(sqlite3*,const char*, u64); 3433 void *sqlite3Realloc(void*, u64); 3434 void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64); 3435 void *sqlite3DbRealloc(sqlite3 *, void *, u64); 3436 void sqlite3DbFree(sqlite3*, void*); 3437 int sqlite3MallocSize(void*); 3438 int sqlite3DbMallocSize(sqlite3*, void*); 3439 void *sqlite3ScratchMalloc(int); 3440 void sqlite3ScratchFree(void*); 3441 void *sqlite3PageMalloc(int); 3442 void sqlite3PageFree(void*); 3443 void sqlite3MemSetDefault(void); 3444 #ifndef SQLITE_OMIT_BUILTIN_TEST 3445 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 3446 #endif 3447 int sqlite3HeapNearlyFull(void); 3448 3449 /* 3450 ** On systems with ample stack space and that support alloca(), make 3451 ** use of alloca() to obtain space for large automatic objects. By default, 3452 ** obtain space from malloc(). 3453 ** 3454 ** The alloca() routine never returns NULL. This will cause code paths 3455 ** that deal with sqlite3StackAlloc() failures to be unreachable. 3456 */ 3457 #ifdef SQLITE_USE_ALLOCA 3458 # define sqlite3StackAllocRaw(D,N) alloca(N) 3459 # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 3460 # define sqlite3StackFree(D,P) 3461 #else 3462 # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 3463 # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 3464 # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 3465 #endif 3466 3467 /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they 3468 ** are, disable MEMSYS3 3469 */ 3470 #ifdef SQLITE_ENABLE_MEMSYS5 3471 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 3472 #undef SQLITE_ENABLE_MEMSYS3 3473 #endif 3474 #ifdef SQLITE_ENABLE_MEMSYS3 3475 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 3476 #endif 3477 3478 3479 #ifndef SQLITE_MUTEX_OMIT 3480 sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 3481 sqlite3_mutex_methods const *sqlite3NoopMutex(void); 3482 sqlite3_mutex *sqlite3MutexAlloc(int); 3483 int sqlite3MutexInit(void); 3484 int sqlite3MutexEnd(void); 3485 #endif 3486 #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP) 3487 void sqlite3MemoryBarrier(void); 3488 #else 3489 # define sqlite3MemoryBarrier() 3490 #endif 3491 3492 sqlite3_int64 sqlite3StatusValue(int); 3493 void sqlite3StatusUp(int, int); 3494 void sqlite3StatusDown(int, int); 3495 void sqlite3StatusHighwater(int, int); 3496 3497 /* Access to mutexes used by sqlite3_status() */ 3498 sqlite3_mutex *sqlite3Pcache1Mutex(void); 3499 sqlite3_mutex *sqlite3MallocMutex(void); 3500 3501 #ifndef SQLITE_OMIT_FLOATING_POINT 3502 int sqlite3IsNaN(double); 3503 #else 3504 # define sqlite3IsNaN(X) 0 3505 #endif 3506 3507 /* 3508 ** An instance of the following structure holds information about SQL 3509 ** functions arguments that are the parameters to the printf() function. 3510 */ 3511 struct PrintfArguments { 3512 int nArg; /* Total number of arguments */ 3513 int nUsed; /* Number of arguments used so far */ 3514 sqlite3_value **apArg; /* The argument values */ 3515 }; 3516 3517 void sqlite3VXPrintf(StrAccum*, const char*, va_list); 3518 void sqlite3XPrintf(StrAccum*, const char*, ...); 3519 char *sqlite3MPrintf(sqlite3*,const char*, ...); 3520 char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 3521 #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE) 3522 void sqlite3DebugPrintf(const char*, ...); 3523 #endif 3524 #if defined(SQLITE_TEST) 3525 void *sqlite3TestTextToPtr(const char*); 3526 #endif 3527 3528 #if defined(SQLITE_DEBUG) 3529 void sqlite3TreeViewExpr(TreeView*, const Expr*, u8); 3530 void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*); 3531 void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*); 3532 void sqlite3TreeViewSelect(TreeView*, const Select*, u8); 3533 void sqlite3TreeViewWith(TreeView*, const With*, u8); 3534 #endif 3535 3536 3537 void sqlite3SetString(char **, sqlite3*, const char*); 3538 void sqlite3ErrorMsg(Parse*, const char*, ...); 3539 void sqlite3Dequote(char*); 3540 void sqlite3TokenInit(Token*,char*); 3541 int sqlite3KeywordCode(const unsigned char*, int); 3542 int sqlite3RunParser(Parse*, const char*, char **); 3543 void sqlite3FinishCoding(Parse*); 3544 int sqlite3GetTempReg(Parse*); 3545 void sqlite3ReleaseTempReg(Parse*,int); 3546 int sqlite3GetTempRange(Parse*,int); 3547 void sqlite3ReleaseTempRange(Parse*,int,int); 3548 void sqlite3ClearTempRegCache(Parse*); 3549 #ifdef SQLITE_DEBUG 3550 int sqlite3NoTempsInRange(Parse*,int,int); 3551 #endif 3552 Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 3553 Expr *sqlite3Expr(sqlite3*,int,const char*); 3554 void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 3555 Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*); 3556 void sqlite3PExprAddSelect(Parse*, Expr*, Select*); 3557 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*); 3558 Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*); 3559 void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32); 3560 void sqlite3ExprDelete(sqlite3*, Expr*); 3561 ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 3562 ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*); 3563 void sqlite3ExprListSetSortOrder(ExprList*,int); 3564 void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 3565 void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*); 3566 void sqlite3ExprListDelete(sqlite3*, ExprList*); 3567 u32 sqlite3ExprListFlags(const ExprList*); 3568 int sqlite3Init(sqlite3*, char**); 3569 int sqlite3InitCallback(void*, int, char**, char**); 3570 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 3571 void sqlite3ResetAllSchemasOfConnection(sqlite3*); 3572 void sqlite3ResetOneSchema(sqlite3*,int); 3573 void sqlite3CollapseDatabaseArray(sqlite3*); 3574 void sqlite3CommitInternalChanges(sqlite3*); 3575 void sqlite3DeleteColumnNames(sqlite3*,Table*); 3576 int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**); 3577 void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*); 3578 Table *sqlite3ResultSetOfSelect(Parse*,Select*); 3579 void sqlite3OpenMasterTable(Parse *, int); 3580 Index *sqlite3PrimaryKeyIndex(Table*); 3581 i16 sqlite3ColumnOfIndex(Index*, i16); 3582 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 3583 #if SQLITE_ENABLE_HIDDEN_COLUMNS 3584 void sqlite3ColumnPropertiesFromName(Table*, Column*); 3585 #else 3586 # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */ 3587 #endif 3588 void sqlite3AddColumn(Parse*,Token*,Token*); 3589 void sqlite3AddNotNull(Parse*, int); 3590 void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 3591 void sqlite3AddCheckConstraint(Parse*, Expr*); 3592 void sqlite3AddDefaultValue(Parse*,ExprSpan*); 3593 void sqlite3AddCollateType(Parse*, Token*); 3594 void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*); 3595 int sqlite3ParseUri(const char*,const char*,unsigned int*, 3596 sqlite3_vfs**,char**,char **); 3597 Btree *sqlite3DbNameToBtree(sqlite3*,const char*); 3598 3599 #ifdef SQLITE_OMIT_BUILTIN_TEST 3600 # define sqlite3FaultSim(X) SQLITE_OK 3601 #else 3602 int sqlite3FaultSim(int); 3603 #endif 3604 3605 Bitvec *sqlite3BitvecCreate(u32); 3606 int sqlite3BitvecTest(Bitvec*, u32); 3607 int sqlite3BitvecTestNotNull(Bitvec*, u32); 3608 int sqlite3BitvecSet(Bitvec*, u32); 3609 void sqlite3BitvecClear(Bitvec*, u32, void*); 3610 void sqlite3BitvecDestroy(Bitvec*); 3611 u32 sqlite3BitvecSize(Bitvec*); 3612 #ifndef SQLITE_OMIT_BUILTIN_TEST 3613 int sqlite3BitvecBuiltinTest(int,int*); 3614 #endif 3615 3616 RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int); 3617 void sqlite3RowSetClear(RowSet*); 3618 void sqlite3RowSetInsert(RowSet*, i64); 3619 int sqlite3RowSetTest(RowSet*, int iBatch, i64); 3620 int sqlite3RowSetNext(RowSet*, i64*); 3621 3622 void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int); 3623 3624 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 3625 int sqlite3ViewGetColumnNames(Parse*,Table*); 3626 #else 3627 # define sqlite3ViewGetColumnNames(A,B) 0 3628 #endif 3629 3630 #if SQLITE_MAX_ATTACHED>30 3631 int sqlite3DbMaskAllZero(yDbMask); 3632 #endif 3633 void sqlite3DropTable(Parse*, SrcList*, int, int); 3634 void sqlite3CodeDropTable(Parse*, Table*, int, int); 3635 void sqlite3DeleteTable(sqlite3*, Table*); 3636 #ifndef SQLITE_OMIT_AUTOINCREMENT 3637 void sqlite3AutoincrementBegin(Parse *pParse); 3638 void sqlite3AutoincrementEnd(Parse *pParse); 3639 #else 3640 # define sqlite3AutoincrementBegin(X) 3641 # define sqlite3AutoincrementEnd(X) 3642 #endif 3643 void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int); 3644 void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*); 3645 IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*); 3646 int sqlite3IdListIndex(IdList*,const char*); 3647 SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int); 3648 SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*); 3649 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 3650 Token*, Select*, Expr*, IdList*); 3651 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 3652 void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*); 3653 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *); 3654 void sqlite3SrcListShiftJoinType(SrcList*); 3655 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 3656 void sqlite3IdListDelete(sqlite3*, IdList*); 3657 void sqlite3SrcListDelete(sqlite3*, SrcList*); 3658 Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**); 3659 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 3660 Expr*, int, int, u8); 3661 void sqlite3DropIndex(Parse*, SrcList*, int); 3662 int sqlite3Select(Parse*, Select*, SelectDest*); 3663 Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 3664 Expr*,ExprList*,u32,Expr*,Expr*); 3665 void sqlite3SelectDelete(sqlite3*, Select*); 3666 Table *sqlite3SrcListLookup(Parse*, SrcList*); 3667 int sqlite3IsReadOnly(Parse*, Table*, int); 3668 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 3669 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 3670 Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*); 3671 #endif 3672 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*); 3673 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int); 3674 WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int); 3675 void sqlite3WhereEnd(WhereInfo*); 3676 LogEst sqlite3WhereOutputRowCount(WhereInfo*); 3677 int sqlite3WhereIsDistinct(WhereInfo*); 3678 int sqlite3WhereIsOrdered(WhereInfo*); 3679 int sqlite3WhereOrderedInnerLoop(WhereInfo*); 3680 int sqlite3WhereIsSorted(WhereInfo*); 3681 int sqlite3WhereContinueLabel(WhereInfo*); 3682 int sqlite3WhereBreakLabel(WhereInfo*); 3683 int sqlite3WhereOkOnePass(WhereInfo*, int*); 3684 #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */ 3685 #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */ 3686 #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */ 3687 void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int); 3688 int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8); 3689 void sqlite3ExprCodeGetColumnToReg(Parse*, Table*, int, int, int); 3690 void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 3691 void sqlite3ExprCodeMove(Parse*, int, int, int); 3692 void sqlite3ExprCacheStore(Parse*, int, int, int); 3693 void sqlite3ExprCachePush(Parse*); 3694 void sqlite3ExprCachePop(Parse*); 3695 void sqlite3ExprCacheRemove(Parse*, int, int); 3696 void sqlite3ExprCacheClear(Parse*); 3697 void sqlite3ExprCacheAffinityChange(Parse*, int, int); 3698 void sqlite3ExprCode(Parse*, Expr*, int); 3699 void sqlite3ExprCodeCopy(Parse*, Expr*, int); 3700 void sqlite3ExprCodeFactorable(Parse*, Expr*, int); 3701 void sqlite3ExprCodeAtInit(Parse*, Expr*, int, u8); 3702 int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 3703 int sqlite3ExprCodeTarget(Parse*, Expr*, int); 3704 void sqlite3ExprCodeAndCache(Parse*, Expr*, int); 3705 int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8); 3706 #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */ 3707 #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */ 3708 #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */ 3709 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 3710 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 3711 void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int); 3712 Table *sqlite3FindTable(sqlite3*,const char*, const char*); 3713 #define LOCATE_VIEW 0x01 3714 #define LOCATE_NOERR 0x02 3715 Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*); 3716 Table *sqlite3LocateTableItem(Parse*,u32 flags,struct SrcList_item *); 3717 Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 3718 void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 3719 void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 3720 void sqlite3Vacuum(Parse*,Token*); 3721 int sqlite3RunVacuum(char**, sqlite3*, int); 3722 char *sqlite3NameFromToken(sqlite3*, Token*); 3723 int sqlite3ExprCompare(Expr*, Expr*, int); 3724 int sqlite3ExprListCompare(ExprList*, ExprList*, int); 3725 int sqlite3ExprImpliesExpr(Expr*, Expr*, int); 3726 void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 3727 void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 3728 int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx); 3729 int sqlite3FunctionUsesThisSrc(Expr*, SrcList*); 3730 Vdbe *sqlite3GetVdbe(Parse*); 3731 #ifndef SQLITE_OMIT_BUILTIN_TEST 3732 void sqlite3PrngSaveState(void); 3733 void sqlite3PrngRestoreState(void); 3734 #endif 3735 void sqlite3RollbackAll(sqlite3*,int); 3736 void sqlite3CodeVerifySchema(Parse*, int); 3737 void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb); 3738 void sqlite3BeginTransaction(Parse*, int); 3739 void sqlite3CommitTransaction(Parse*); 3740 void sqlite3RollbackTransaction(Parse*); 3741 void sqlite3Savepoint(Parse*, int, Token*); 3742 void sqlite3CloseSavepoints(sqlite3 *); 3743 void sqlite3LeaveMutexAndCloseZombie(sqlite3*); 3744 int sqlite3ExprIsConstant(Expr*); 3745 int sqlite3ExprIsConstantNotJoin(Expr*); 3746 int sqlite3ExprIsConstantOrFunction(Expr*, u8); 3747 int sqlite3ExprIsTableConstant(Expr*,int); 3748 #ifdef SQLITE_ENABLE_CURSOR_HINTS 3749 int sqlite3ExprContainsSubquery(Expr*); 3750 #endif 3751 int sqlite3ExprIsInteger(Expr*, int*); 3752 int sqlite3ExprCanBeNull(const Expr*); 3753 int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 3754 int sqlite3IsRowid(const char*); 3755 void sqlite3GenerateRowDelete( 3756 Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int); 3757 void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int); 3758 int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int); 3759 void sqlite3ResolvePartIdxLabel(Parse*,int); 3760 void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int, 3761 u8,u8,int,int*,int*); 3762 void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int); 3763 int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*); 3764 void sqlite3BeginWriteOperation(Parse*, int, int); 3765 void sqlite3MultiWrite(Parse*); 3766 void sqlite3MayAbort(Parse*); 3767 void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8); 3768 void sqlite3UniqueConstraint(Parse*, int, Index*); 3769 void sqlite3RowidConstraint(Parse*, int, Table*); 3770 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 3771 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 3772 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 3773 IdList *sqlite3IdListDup(sqlite3*,IdList*); 3774 Select *sqlite3SelectDup(sqlite3*,Select*,int); 3775 #if SELECTTRACE_ENABLED 3776 void sqlite3SelectSetName(Select*,const char*); 3777 #else 3778 # define sqlite3SelectSetName(A,B) 3779 #endif 3780 void sqlite3InsertBuiltinFuncs(FuncDef*,int); 3781 FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8); 3782 void sqlite3RegisterBuiltinFunctions(void); 3783 void sqlite3RegisterDateTimeFunctions(void); 3784 void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*); 3785 int sqlite3SafetyCheckOk(sqlite3*); 3786 int sqlite3SafetyCheckSickOrOk(sqlite3*); 3787 void sqlite3ChangeCookie(Parse*, int); 3788 3789 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 3790 void sqlite3MaterializeView(Parse*, Table*, Expr*, int); 3791 #endif 3792 3793 #ifndef SQLITE_OMIT_TRIGGER 3794 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 3795 Expr*,int, int); 3796 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 3797 void sqlite3DropTrigger(Parse*, SrcList*, int); 3798 void sqlite3DropTriggerPtr(Parse*, Trigger*); 3799 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 3800 Trigger *sqlite3TriggerList(Parse *, Table *); 3801 void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 3802 int, int, int); 3803 void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 3804 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 3805 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 3806 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*); 3807 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*, 3808 Select*,u8); 3809 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8); 3810 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*); 3811 void sqlite3DeleteTrigger(sqlite3*, Trigger*); 3812 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 3813 u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 3814 # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 3815 # define sqlite3IsToplevel(p) ((p)->pToplevel==0) 3816 #else 3817 # define sqlite3TriggersExist(B,C,D,E,F) 0 3818 # define sqlite3DeleteTrigger(A,B) 3819 # define sqlite3DropTriggerPtr(A,B) 3820 # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 3821 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 3822 # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 3823 # define sqlite3TriggerList(X, Y) 0 3824 # define sqlite3ParseToplevel(p) p 3825 # define sqlite3IsToplevel(p) 1 3826 # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 3827 #endif 3828 3829 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 3830 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 3831 void sqlite3DeferForeignKey(Parse*, int); 3832 #ifndef SQLITE_OMIT_AUTHORIZATION 3833 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 3834 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 3835 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 3836 void sqlite3AuthContextPop(AuthContext*); 3837 int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 3838 #else 3839 # define sqlite3AuthRead(a,b,c,d) 3840 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 3841 # define sqlite3AuthContextPush(a,b,c) 3842 # define sqlite3AuthContextPop(a) ((void)(a)) 3843 #endif 3844 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 3845 void sqlite3Detach(Parse*, Expr*); 3846 void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 3847 int sqlite3FixSrcList(DbFixer*, SrcList*); 3848 int sqlite3FixSelect(DbFixer*, Select*); 3849 int sqlite3FixExpr(DbFixer*, Expr*); 3850 int sqlite3FixExprList(DbFixer*, ExprList*); 3851 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 3852 int sqlite3AtoF(const char *z, double*, int, u8); 3853 int sqlite3GetInt32(const char *, int*); 3854 int sqlite3Atoi(const char*); 3855 int sqlite3Utf16ByteLen(const void *pData, int nChar); 3856 int sqlite3Utf8CharLen(const char *pData, int nByte); 3857 u32 sqlite3Utf8Read(const u8**); 3858 LogEst sqlite3LogEst(u64); 3859 LogEst sqlite3LogEstAdd(LogEst,LogEst); 3860 #ifndef SQLITE_OMIT_VIRTUALTABLE 3861 LogEst sqlite3LogEstFromDouble(double); 3862 #endif 3863 #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \ 3864 defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \ 3865 defined(SQLITE_EXPLAIN_ESTIMATED_ROWS) 3866 u64 sqlite3LogEstToInt(LogEst); 3867 #endif 3868 3869 /* 3870 ** Routines to read and write variable-length integers. These used to 3871 ** be defined locally, but now we use the varint routines in the util.c 3872 ** file. 3873 */ 3874 int sqlite3PutVarint(unsigned char*, u64); 3875 u8 sqlite3GetVarint(const unsigned char *, u64 *); 3876 u8 sqlite3GetVarint32(const unsigned char *, u32 *); 3877 int sqlite3VarintLen(u64 v); 3878 3879 /* 3880 ** The common case is for a varint to be a single byte. They following 3881 ** macros handle the common case without a procedure call, but then call 3882 ** the procedure for larger varints. 3883 */ 3884 #define getVarint32(A,B) \ 3885 (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B))) 3886 #define putVarint32(A,B) \ 3887 (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\ 3888 sqlite3PutVarint((A),(B))) 3889 #define getVarint sqlite3GetVarint 3890 #define putVarint sqlite3PutVarint 3891 3892 3893 const char *sqlite3IndexAffinityStr(sqlite3*, Index*); 3894 void sqlite3TableAffinity(Vdbe*, Table*, int); 3895 char sqlite3CompareAffinity(Expr *pExpr, char aff2); 3896 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity); 3897 char sqlite3TableColumnAffinity(Table*,int); 3898 char sqlite3ExprAffinity(Expr *pExpr); 3899 int sqlite3Atoi64(const char*, i64*, int, u8); 3900 int sqlite3DecOrHexToI64(const char*, i64*); 3901 void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...); 3902 void sqlite3Error(sqlite3*,int); 3903 void sqlite3SystemError(sqlite3*,int); 3904 void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 3905 u8 sqlite3HexToInt(int h); 3906 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 3907 3908 #if defined(SQLITE_NEED_ERR_NAME) 3909 const char *sqlite3ErrName(int); 3910 #endif 3911 3912 const char *sqlite3ErrStr(int); 3913 int sqlite3ReadSchema(Parse *pParse); 3914 CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 3915 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 3916 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr); 3917 Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int); 3918 Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*); 3919 Expr *sqlite3ExprSkipCollate(Expr*); 3920 int sqlite3CheckCollSeq(Parse *, CollSeq *); 3921 int sqlite3CheckObjectName(Parse *, const char *); 3922 void sqlite3VdbeSetChanges(sqlite3 *, int); 3923 int sqlite3AddInt64(i64*,i64); 3924 int sqlite3SubInt64(i64*,i64); 3925 int sqlite3MulInt64(i64*,i64); 3926 int sqlite3AbsInt32(int); 3927 #ifdef SQLITE_ENABLE_8_3_NAMES 3928 void sqlite3FileSuffix3(const char*, char*); 3929 #else 3930 # define sqlite3FileSuffix3(X,Y) 3931 #endif 3932 u8 sqlite3GetBoolean(const char *z,u8); 3933 3934 const void *sqlite3ValueText(sqlite3_value*, u8); 3935 int sqlite3ValueBytes(sqlite3_value*, u8); 3936 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 3937 void(*)(void*)); 3938 void sqlite3ValueSetNull(sqlite3_value*); 3939 void sqlite3ValueFree(sqlite3_value*); 3940 sqlite3_value *sqlite3ValueNew(sqlite3 *); 3941 char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 3942 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 3943 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 3944 #ifndef SQLITE_AMALGAMATION 3945 extern const unsigned char sqlite3OpcodeProperty[]; 3946 extern const char sqlite3StrBINARY[]; 3947 extern const unsigned char sqlite3UpperToLower[]; 3948 extern const unsigned char sqlite3CtypeMap[]; 3949 extern const Token sqlite3IntTokens[]; 3950 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 3951 extern FuncDefHash sqlite3BuiltinFunctions; 3952 #ifndef SQLITE_OMIT_WSD 3953 extern int sqlite3PendingByte; 3954 #endif 3955 #endif 3956 void sqlite3RootPageMoved(sqlite3*, int, int, int); 3957 void sqlite3Reindex(Parse*, Token*, Token*); 3958 void sqlite3AlterFunctions(void); 3959 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 3960 int sqlite3GetToken(const unsigned char *, int *); 3961 void sqlite3NestedParse(Parse*, const char*, ...); 3962 void sqlite3ExpirePreparedStatements(sqlite3*); 3963 int sqlite3CodeSubselect(Parse*, Expr *, int, int); 3964 void sqlite3SelectPrep(Parse*, Select*, NameContext*); 3965 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p); 3966 int sqlite3MatchSpanName(const char*, const char*, const char*, const char*); 3967 int sqlite3ResolveExprNames(NameContext*, Expr*); 3968 int sqlite3ResolveExprListNames(NameContext*, ExprList*); 3969 void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 3970 void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*); 3971 int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 3972 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 3973 void sqlite3AlterFinishAddColumn(Parse *, Token *); 3974 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 3975 CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*); 3976 char sqlite3AffinityType(const char*, u8*); 3977 void sqlite3Analyze(Parse*, Token*, Token*); 3978 int sqlite3InvokeBusyHandler(BusyHandler*); 3979 int sqlite3FindDb(sqlite3*, Token*); 3980 int sqlite3FindDbName(sqlite3 *, const char *); 3981 int sqlite3AnalysisLoad(sqlite3*,int iDB); 3982 void sqlite3DeleteIndexSamples(sqlite3*,Index*); 3983 void sqlite3DefaultRowEst(Index*); 3984 void sqlite3RegisterLikeFunctions(sqlite3*, int); 3985 int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 3986 void sqlite3SchemaClear(void *); 3987 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 3988 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 3989 KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int); 3990 void sqlite3KeyInfoUnref(KeyInfo*); 3991 KeyInfo *sqlite3KeyInfoRef(KeyInfo*); 3992 KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*); 3993 #ifdef SQLITE_DEBUG 3994 int sqlite3KeyInfoIsWriteable(KeyInfo*); 3995 #endif 3996 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 3997 void (*)(sqlite3_context*,int,sqlite3_value **), 3998 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*), 3999 FuncDestructor *pDestructor 4000 ); 4001 void sqlite3OomFault(sqlite3*); 4002 void sqlite3OomClear(sqlite3*); 4003 int sqlite3ApiExit(sqlite3 *db, int); 4004 int sqlite3OpenTempDatabase(Parse *); 4005 4006 void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int); 4007 void sqlite3StrAccumAppend(StrAccum*,const char*,int); 4008 void sqlite3StrAccumAppendAll(StrAccum*,const char*); 4009 void sqlite3AppendChar(StrAccum*,int,char); 4010 char *sqlite3StrAccumFinish(StrAccum*); 4011 void sqlite3StrAccumReset(StrAccum*); 4012 void sqlite3SelectDestInit(SelectDest*,int,int); 4013 Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 4014 4015 void sqlite3BackupRestart(sqlite3_backup *); 4016 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 4017 4018 #ifndef SQLITE_OMIT_SUBQUERY 4019 int sqlite3ExprCheckIN(Parse*, Expr*); 4020 #else 4021 # define sqlite3ExprCheckIN(x,y) SQLITE_OK 4022 #endif 4023 4024 #ifdef SQLITE_ENABLE_STAT3_OR_STAT4 4025 void sqlite3AnalyzeFunctions(void); 4026 int sqlite3Stat4ProbeSetValue( 4027 Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*); 4028 int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**); 4029 void sqlite3Stat4ProbeFree(UnpackedRecord*); 4030 int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**); 4031 char sqlite3IndexColumnAffinity(sqlite3*, Index*, int); 4032 #endif 4033 4034 /* 4035 ** The interface to the LEMON-generated parser 4036 */ 4037 void *sqlite3ParserAlloc(void*(*)(u64)); 4038 void sqlite3ParserFree(void*, void(*)(void*)); 4039 void sqlite3Parser(void*, int, Token, Parse*); 4040 #ifdef YYTRACKMAXSTACKDEPTH 4041 int sqlite3ParserStackPeak(void*); 4042 #endif 4043 4044 void sqlite3AutoLoadExtensions(sqlite3*); 4045 #ifndef SQLITE_OMIT_LOAD_EXTENSION 4046 void sqlite3CloseExtensions(sqlite3*); 4047 #else 4048 # define sqlite3CloseExtensions(X) 4049 #endif 4050 4051 #ifndef SQLITE_OMIT_SHARED_CACHE 4052 void sqlite3TableLock(Parse *, int, int, u8, const char *); 4053 #else 4054 #define sqlite3TableLock(v,w,x,y,z) 4055 #endif 4056 4057 #ifdef SQLITE_TEST 4058 int sqlite3Utf8To8(unsigned char*); 4059 #endif 4060 4061 #ifdef SQLITE_OMIT_VIRTUALTABLE 4062 # define sqlite3VtabClear(Y) 4063 # define sqlite3VtabSync(X,Y) SQLITE_OK 4064 # define sqlite3VtabRollback(X) 4065 # define sqlite3VtabCommit(X) 4066 # define sqlite3VtabInSync(db) 0 4067 # define sqlite3VtabLock(X) 4068 # define sqlite3VtabUnlock(X) 4069 # define sqlite3VtabUnlockList(X) 4070 # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK 4071 # define sqlite3GetVTable(X,Y) ((VTable*)0) 4072 #else 4073 void sqlite3VtabClear(sqlite3 *db, Table*); 4074 void sqlite3VtabDisconnect(sqlite3 *db, Table *p); 4075 int sqlite3VtabSync(sqlite3 *db, Vdbe*); 4076 int sqlite3VtabRollback(sqlite3 *db); 4077 int sqlite3VtabCommit(sqlite3 *db); 4078 void sqlite3VtabLock(VTable *); 4079 void sqlite3VtabUnlock(VTable *); 4080 void sqlite3VtabUnlockList(sqlite3*); 4081 int sqlite3VtabSavepoint(sqlite3 *, int, int); 4082 void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*); 4083 VTable *sqlite3GetVTable(sqlite3*, Table*); 4084 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 4085 #endif 4086 int sqlite3VtabEponymousTableInit(Parse*,Module*); 4087 void sqlite3VtabEponymousTableClear(sqlite3*,Module*); 4088 void sqlite3VtabMakeWritable(Parse*,Table*); 4089 void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int); 4090 void sqlite3VtabFinishParse(Parse*, Token*); 4091 void sqlite3VtabArgInit(Parse*); 4092 void sqlite3VtabArgExtend(Parse*, Token*); 4093 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 4094 int sqlite3VtabCallConnect(Parse*, Table*); 4095 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 4096 int sqlite3VtabBegin(sqlite3 *, VTable *); 4097 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 4098 void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**); 4099 sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*); 4100 int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 4101 int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 4102 void sqlite3ParserReset(Parse*); 4103 int sqlite3Reprepare(Vdbe*); 4104 void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 4105 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *); 4106 int sqlite3TempInMemory(const sqlite3*); 4107 const char *sqlite3JournalModename(int); 4108 #ifndef SQLITE_OMIT_WAL 4109 int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 4110 int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 4111 #endif 4112 #ifndef SQLITE_OMIT_CTE 4113 With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*); 4114 void sqlite3WithDelete(sqlite3*,With*); 4115 void sqlite3WithPush(Parse*, With*, u8); 4116 #else 4117 #define sqlite3WithPush(x,y,z) 4118 #define sqlite3WithDelete(x,y) 4119 #endif 4120 4121 /* Declarations for functions in fkey.c. All of these are replaced by 4122 ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 4123 ** key functionality is available. If OMIT_TRIGGER is defined but 4124 ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 4125 ** this case foreign keys are parsed, but no other functionality is 4126 ** provided (enforcement of FK constraints requires the triggers sub-system). 4127 */ 4128 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 4129 void sqlite3FkCheck(Parse*, Table*, int, int, int*, int); 4130 void sqlite3FkDropTable(Parse*, SrcList *, Table*); 4131 void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int); 4132 int sqlite3FkRequired(Parse*, Table*, int*, int); 4133 u32 sqlite3FkOldmask(Parse*, Table*); 4134 FKey *sqlite3FkReferences(Table *); 4135 #else 4136 #define sqlite3FkActions(a,b,c,d,e,f) 4137 #define sqlite3FkCheck(a,b,c,d,e,f) 4138 #define sqlite3FkDropTable(a,b,c) 4139 #define sqlite3FkOldmask(a,b) 0 4140 #define sqlite3FkRequired(a,b,c,d) 0 4141 #endif 4142 #ifndef SQLITE_OMIT_FOREIGN_KEY 4143 void sqlite3FkDelete(sqlite3 *, Table*); 4144 int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**); 4145 #else 4146 #define sqlite3FkDelete(a,b) 4147 #define sqlite3FkLocateIndex(a,b,c,d,e) 4148 #endif 4149 4150 4151 /* 4152 ** Available fault injectors. Should be numbered beginning with 0. 4153 */ 4154 #define SQLITE_FAULTINJECTOR_MALLOC 0 4155 #define SQLITE_FAULTINJECTOR_COUNT 1 4156 4157 /* 4158 ** The interface to the code in fault.c used for identifying "benign" 4159 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST 4160 ** is not defined. 4161 */ 4162 #ifndef SQLITE_OMIT_BUILTIN_TEST 4163 void sqlite3BeginBenignMalloc(void); 4164 void sqlite3EndBenignMalloc(void); 4165 #else 4166 #define sqlite3BeginBenignMalloc() 4167 #define sqlite3EndBenignMalloc() 4168 #endif 4169 4170 /* 4171 ** Allowed return values from sqlite3FindInIndex() 4172 */ 4173 #define IN_INDEX_ROWID 1 /* Search the rowid of the table */ 4174 #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */ 4175 #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */ 4176 #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */ 4177 #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */ 4178 /* 4179 ** Allowed flags for the 3rd parameter to sqlite3FindInIndex(). 4180 */ 4181 #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */ 4182 #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */ 4183 #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */ 4184 int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*); 4185 4186 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 4187 int sqlite3JournalSize(sqlite3_vfs *); 4188 #ifdef SQLITE_ENABLE_ATOMIC_WRITE 4189 int sqlite3JournalCreate(sqlite3_file *); 4190 #endif 4191 4192 int sqlite3JournalIsInMemory(sqlite3_file *p); 4193 void sqlite3MemJournalOpen(sqlite3_file *); 4194 4195 void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p); 4196 #if SQLITE_MAX_EXPR_DEPTH>0 4197 int sqlite3SelectExprHeight(Select *); 4198 int sqlite3ExprCheckHeight(Parse*, int); 4199 #else 4200 #define sqlite3SelectExprHeight(x) 0 4201 #define sqlite3ExprCheckHeight(x,y) 4202 #endif 4203 4204 u32 sqlite3Get4byte(const u8*); 4205 void sqlite3Put4byte(u8*, u32); 4206 4207 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 4208 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 4209 void sqlite3ConnectionUnlocked(sqlite3 *db); 4210 void sqlite3ConnectionClosed(sqlite3 *db); 4211 #else 4212 #define sqlite3ConnectionBlocked(x,y) 4213 #define sqlite3ConnectionUnlocked(x) 4214 #define sqlite3ConnectionClosed(x) 4215 #endif 4216 4217 #ifdef SQLITE_DEBUG 4218 void sqlite3ParserTrace(FILE*, char *); 4219 #endif 4220 4221 /* 4222 ** If the SQLITE_ENABLE IOTRACE exists then the global variable 4223 ** sqlite3IoTrace is a pointer to a printf-like routine used to 4224 ** print I/O tracing messages. 4225 */ 4226 #ifdef SQLITE_ENABLE_IOTRACE 4227 # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 4228 void sqlite3VdbeIOTraceSql(Vdbe*); 4229 SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...); 4230 #else 4231 # define IOTRACE(A) 4232 # define sqlite3VdbeIOTraceSql(X) 4233 #endif 4234 4235 /* 4236 ** These routines are available for the mem2.c debugging memory allocator 4237 ** only. They are used to verify that different "types" of memory 4238 ** allocations are properly tracked by the system. 4239 ** 4240 ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 4241 ** the MEMTYPE_* macros defined below. The type must be a bitmask with 4242 ** a single bit set. 4243 ** 4244 ** sqlite3MemdebugHasType() returns true if any of the bits in its second 4245 ** argument match the type set by the previous sqlite3MemdebugSetType(). 4246 ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 4247 ** 4248 ** sqlite3MemdebugNoType() returns true if none of the bits in its second 4249 ** argument match the type set by the previous sqlite3MemdebugSetType(). 4250 ** 4251 ** Perhaps the most important point is the difference between MEMTYPE_HEAP 4252 ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 4253 ** it might have been allocated by lookaside, except the allocation was 4254 ** too large or lookaside was already full. It is important to verify 4255 ** that allocations that might have been satisfied by lookaside are not 4256 ** passed back to non-lookaside free() routines. Asserts such as the 4257 ** example above are placed on the non-lookaside free() routines to verify 4258 ** this constraint. 4259 ** 4260 ** All of this is no-op for a production build. It only comes into 4261 ** play when the SQLITE_MEMDEBUG compile-time option is used. 4262 */ 4263 #ifdef SQLITE_MEMDEBUG 4264 void sqlite3MemdebugSetType(void*,u8); 4265 int sqlite3MemdebugHasType(void*,u8); 4266 int sqlite3MemdebugNoType(void*,u8); 4267 #else 4268 # define sqlite3MemdebugSetType(X,Y) /* no-op */ 4269 # define sqlite3MemdebugHasType(X,Y) 1 4270 # define sqlite3MemdebugNoType(X,Y) 1 4271 #endif 4272 #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 4273 #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */ 4274 #define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */ 4275 #define MEMTYPE_PCACHE 0x08 /* Page cache allocations */ 4276 4277 /* 4278 ** Threading interface 4279 */ 4280 #if SQLITE_MAX_WORKER_THREADS>0 4281 int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*); 4282 int sqlite3ThreadJoin(SQLiteThread*, void**); 4283 #endif 4284 4285 #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST) 4286 int sqlite3DbstatRegister(sqlite3*); 4287 #endif 4288 4289 int sqlite3ExprVectorSize(Expr *pExpr); 4290 int sqlite3ExprIsVector(Expr *pExpr); 4291 Expr *sqlite3VectorFieldSubexpr(Expr*, int); 4292 Expr *sqlite3ExprForVectorField(Parse*,Expr*,int); 4293 4294 #endif /* SQLITEINT_H */ 4295