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