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