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