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