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