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