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