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