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