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