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