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