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