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