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