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