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