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