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