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