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