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