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