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 ** These #defines should enable >2GB file support on POSIX if the 20 ** underlying operating system supports it. If the OS lacks 21 ** large file support, or if the OS is windows, these should be no-ops. 22 ** 23 ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 24 ** system #includes. Hence, this block of code must be the very first 25 ** code in all source files. 26 ** 27 ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 28 ** on the compiler command line. This is necessary if you are compiling 29 ** on a recent machine (ex: Red Hat 7.2) but you want your code to work 30 ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2 31 ** without this option, LFS is enable. But LFS does not exist in the kernel 32 ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary 33 ** portability you should omit LFS. 34 ** 35 ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later. 36 */ 37 #ifndef SQLITE_DISABLE_LFS 38 # define _LARGE_FILE 1 39 # ifndef _FILE_OFFSET_BITS 40 # define _FILE_OFFSET_BITS 64 41 # endif 42 # define _LARGEFILE_SOURCE 1 43 #endif 44 45 /* 46 ** Include the configuration header output by 'configure' if we're using the 47 ** autoconf-based build 48 */ 49 #ifdef _HAVE_SQLITE_CONFIG_H 50 #include "config.h" 51 #endif 52 53 #include "sqliteLimit.h" 54 55 /* Disable nuisance warnings on Borland compilers */ 56 #if defined(__BORLANDC__) 57 #pragma warn -rch /* unreachable code */ 58 #pragma warn -ccc /* Condition is always true or false */ 59 #pragma warn -aus /* Assigned value is never used */ 60 #pragma warn -csu /* Comparing signed and unsigned */ 61 #pragma warn -spa /* Suspicious pointer arithmetic */ 62 #endif 63 64 /* Needed for various definitions... */ 65 #ifndef _GNU_SOURCE 66 # define _GNU_SOURCE 67 #endif 68 69 /* 70 ** Include standard header files as necessary 71 */ 72 #ifdef HAVE_STDINT_H 73 #include <stdint.h> 74 #endif 75 #ifdef HAVE_INTTYPES_H 76 #include <inttypes.h> 77 #endif 78 79 /* 80 ** The number of samples of an index that SQLite takes in order to 81 ** construct a histogram of the table content when running ANALYZE 82 ** and with SQLITE_ENABLE_STAT2 83 */ 84 #define SQLITE_INDEX_SAMPLES 10 85 86 /* 87 ** The following macros are used to cast pointers to integers and 88 ** integers to pointers. The way you do this varies from one compiler 89 ** to the next, so we have developed the following set of #if statements 90 ** to generate appropriate macros for a wide range of compilers. 91 ** 92 ** The correct "ANSI" way to do this is to use the intptr_t type. 93 ** Unfortunately, that typedef is not available on all compilers, or 94 ** if it is available, it requires an #include of specific headers 95 ** that vary from one machine to the next. 96 ** 97 ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 98 ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 99 ** So we have to define the macros in different ways depending on the 100 ** compiler. 101 */ 102 #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 103 # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 104 # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 105 #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 106 # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 107 # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 108 #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 109 # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 110 # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 111 #else /* Generates a warning - but it always works */ 112 # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 113 # define SQLITE_PTR_TO_INT(X) ((int)(X)) 114 #endif 115 116 /* 117 ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 118 ** 0 means mutexes are permanently disable and the library is never 119 ** threadsafe. 1 means the library is serialized which is the highest 120 ** level of threadsafety. 2 means the libary is multithreaded - multiple 121 ** threads can use SQLite as long as no two threads try to use the same 122 ** database connection at the same time. 123 ** 124 ** Older versions of SQLite used an optional THREADSAFE macro. 125 ** We support that for legacy. 126 */ 127 #if !defined(SQLITE_THREADSAFE) 128 #if defined(THREADSAFE) 129 # define SQLITE_THREADSAFE THREADSAFE 130 #else 131 # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 132 #endif 133 #endif 134 135 /* 136 ** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1. 137 ** It determines whether or not the features related to 138 ** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can 139 ** be overridden at runtime using the sqlite3_config() API. 140 */ 141 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 142 # define SQLITE_DEFAULT_MEMSTATUS 1 143 #endif 144 145 /* 146 ** Exactly one of the following macros must be defined in order to 147 ** specify which memory allocation subsystem to use. 148 ** 149 ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 150 ** SQLITE_MEMDEBUG // Debugging version of system malloc() 151 ** 152 ** (Historical note: There used to be several other options, but we've 153 ** pared it down to just these two.) 154 ** 155 ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 156 ** the default. 157 */ 158 #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)>1 159 # error "At most one of the following compile-time configuration options\ 160 is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG" 161 #endif 162 #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)==0 163 # define SQLITE_SYSTEM_MALLOC 1 164 #endif 165 166 /* 167 ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 168 ** sizes of memory allocations below this value where possible. 169 */ 170 #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 171 # define SQLITE_MALLOC_SOFT_LIMIT 1024 172 #endif 173 174 /* 175 ** We need to define _XOPEN_SOURCE as follows in order to enable 176 ** recursive mutexes on most Unix systems. But Mac OS X is different. 177 ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told, 178 ** so it is omitted there. See ticket #2673. 179 ** 180 ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly 181 ** implemented on some systems. So we avoid defining it at all 182 ** if it is already defined or if it is unneeded because we are 183 ** not doing a threadsafe build. Ticket #2681. 184 ** 185 ** See also ticket #2741. 186 */ 187 #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE 188 # define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */ 189 #endif 190 191 /* 192 ** The TCL headers are only needed when compiling the TCL bindings. 193 */ 194 #if defined(SQLITE_TCL) || defined(TCLSH) 195 # include <tcl.h> 196 #endif 197 198 /* 199 ** Many people are failing to set -DNDEBUG=1 when compiling SQLite. 200 ** Setting NDEBUG makes the code smaller and run faster. So the following 201 ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1 202 ** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out 203 ** feature. 204 */ 205 #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 206 # define NDEBUG 1 207 #endif 208 209 /* 210 ** The testcase() macro is used to aid in coverage testing. When 211 ** doing coverage testing, the condition inside the argument to 212 ** testcase() must be evaluated both true and false in order to 213 ** get full branch coverage. The testcase() macro is inserted 214 ** to help ensure adequate test coverage in places where simple 215 ** condition/decision coverage is inadequate. For example, testcase() 216 ** can be used to make sure boundary values are tested. For 217 ** bitmask tests, testcase() can be used to make sure each bit 218 ** is significant and used at least once. On switch statements 219 ** where multiple cases go to the same block of code, testcase() 220 ** can insure that all cases are evaluated. 221 ** 222 */ 223 #ifdef SQLITE_COVERAGE_TEST 224 void sqlite3Coverage(int); 225 # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 226 #else 227 # define testcase(X) 228 #endif 229 230 /* 231 ** The TESTONLY macro is used to enclose variable declarations or 232 ** other bits of code that are needed to support the arguments 233 ** within testcase() and assert() macros. 234 */ 235 #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 236 # define TESTONLY(X) X 237 #else 238 # define TESTONLY(X) 239 #endif 240 241 /* 242 ** Sometimes we need a small amount of code such as a variable initialization 243 ** to setup for a later assert() statement. We do not want this code to 244 ** appear when assert() is disabled. The following macro is therefore 245 ** used to contain that setup code. The "VVA" acronym stands for 246 ** "Verification, Validation, and Accreditation". In other words, the 247 ** code within VVA_ONLY() will only run during verification processes. 248 */ 249 #ifndef NDEBUG 250 # define VVA_ONLY(X) X 251 #else 252 # define VVA_ONLY(X) 253 #endif 254 255 /* 256 ** The ALWAYS and NEVER macros surround boolean expressions which 257 ** are intended to always be true or false, respectively. Such 258 ** expressions could be omitted from the code completely. But they 259 ** are included in a few cases in order to enhance the resilience 260 ** of SQLite to unexpected behavior - to make the code "self-healing" 261 ** or "ductile" rather than being "brittle" and crashing at the first 262 ** hint of unplanned behavior. 263 ** 264 ** In other words, ALWAYS and NEVER are added for defensive code. 265 ** 266 ** When doing coverage testing ALWAYS and NEVER are hard-coded to 267 ** be true and false so that the unreachable code then specify will 268 ** not be counted as untested code. 269 */ 270 #if defined(SQLITE_COVERAGE_TEST) 271 # define ALWAYS(X) (1) 272 # define NEVER(X) (0) 273 #elif !defined(NDEBUG) 274 # define ALWAYS(X) ((X)?1:(assert(0),0)) 275 # define NEVER(X) ((X)?(assert(0),1):0) 276 #else 277 # define ALWAYS(X) (X) 278 # define NEVER(X) (X) 279 #endif 280 281 /* 282 ** Return true (non-zero) if the input is a integer that is too large 283 ** to fit in 32-bits. This macro is used inside of various testcase() 284 ** macros to verify that we have tested SQLite for large-file support. 285 */ 286 #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 287 288 /* 289 ** The macro unlikely() is a hint that surrounds a boolean 290 ** expression that is usually false. Macro likely() surrounds 291 ** a boolean expression that is usually true. GCC is able to 292 ** use these hints to generate better code, sometimes. 293 */ 294 #if defined(__GNUC__) && 0 295 # define likely(X) __builtin_expect((X),1) 296 # define unlikely(X) __builtin_expect((X),0) 297 #else 298 # define likely(X) !!(X) 299 # define unlikely(X) !!(X) 300 #endif 301 302 #include "sqlite3.h" 303 #include "hash.h" 304 #include <stdio.h> 305 #include <stdlib.h> 306 #include <string.h> 307 #include <assert.h> 308 #include <stddef.h> 309 310 /* 311 ** If compiling for a processor that lacks floating point support, 312 ** substitute integer for floating-point 313 */ 314 #ifdef SQLITE_OMIT_FLOATING_POINT 315 # define double sqlite_int64 316 # define float sqlite_int64 317 # define LONGDOUBLE_TYPE sqlite_int64 318 # ifndef SQLITE_BIG_DBL 319 # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 320 # endif 321 # define SQLITE_OMIT_DATETIME_FUNCS 1 322 # define SQLITE_OMIT_TRACE 1 323 # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 324 # undef SQLITE_HAVE_ISNAN 325 #endif 326 #ifndef SQLITE_BIG_DBL 327 # define SQLITE_BIG_DBL (1e99) 328 #endif 329 330 /* 331 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 332 ** afterward. Having this macro allows us to cause the C compiler 333 ** to omit code used by TEMP tables without messy #ifndef statements. 334 */ 335 #ifdef SQLITE_OMIT_TEMPDB 336 #define OMIT_TEMPDB 1 337 #else 338 #define OMIT_TEMPDB 0 339 #endif 340 341 /* 342 ** The "file format" number is an integer that is incremented whenever 343 ** the VDBE-level file format changes. The following macros define the 344 ** the default file format for new databases and the maximum file format 345 ** that the library can read. 346 */ 347 #define SQLITE_MAX_FILE_FORMAT 4 348 #ifndef SQLITE_DEFAULT_FILE_FORMAT 349 # define SQLITE_DEFAULT_FILE_FORMAT 1 350 #endif 351 352 /* 353 ** Determine whether triggers are recursive by default. This can be 354 ** changed at run-time using a pragma. 355 */ 356 #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 357 # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 358 #endif 359 360 /* 361 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 362 ** on the command-line 363 */ 364 #ifndef SQLITE_TEMP_STORE 365 # define SQLITE_TEMP_STORE 1 366 #endif 367 368 /* 369 ** GCC does not define the offsetof() macro so we'll have to do it 370 ** ourselves. 371 */ 372 #ifndef offsetof 373 #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 374 #endif 375 376 /* 377 ** Check to see if this machine uses EBCDIC. (Yes, believe it or 378 ** not, there are still machines out there that use EBCDIC.) 379 */ 380 #if 'A' == '\301' 381 # define SQLITE_EBCDIC 1 382 #else 383 # define SQLITE_ASCII 1 384 #endif 385 386 /* 387 ** Integers of known sizes. These typedefs might change for architectures 388 ** where the sizes very. Preprocessor macros are available so that the 389 ** types can be conveniently redefined at compile-type. Like this: 390 ** 391 ** cc '-DUINTPTR_TYPE=long long int' ... 392 */ 393 #ifndef UINT32_TYPE 394 # ifdef HAVE_UINT32_T 395 # define UINT32_TYPE uint32_t 396 # else 397 # define UINT32_TYPE unsigned int 398 # endif 399 #endif 400 #ifndef UINT16_TYPE 401 # ifdef HAVE_UINT16_T 402 # define UINT16_TYPE uint16_t 403 # else 404 # define UINT16_TYPE unsigned short int 405 # endif 406 #endif 407 #ifndef INT16_TYPE 408 # ifdef HAVE_INT16_T 409 # define INT16_TYPE int16_t 410 # else 411 # define INT16_TYPE short int 412 # endif 413 #endif 414 #ifndef UINT8_TYPE 415 # ifdef HAVE_UINT8_T 416 # define UINT8_TYPE uint8_t 417 # else 418 # define UINT8_TYPE unsigned char 419 # endif 420 #endif 421 #ifndef INT8_TYPE 422 # ifdef HAVE_INT8_T 423 # define INT8_TYPE int8_t 424 # else 425 # define INT8_TYPE signed char 426 # endif 427 #endif 428 #ifndef LONGDOUBLE_TYPE 429 # define LONGDOUBLE_TYPE long double 430 #endif 431 typedef sqlite_int64 i64; /* 8-byte signed integer */ 432 typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 433 typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 434 typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 435 typedef INT16_TYPE i16; /* 2-byte signed integer */ 436 typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 437 typedef INT8_TYPE i8; /* 1-byte signed integer */ 438 439 /* 440 ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 441 ** that can be stored in a u32 without loss of data. The value 442 ** is 0x00000000ffffffff. But because of quirks of some compilers, we 443 ** have to specify the value in the less intuitive manner shown: 444 */ 445 #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 446 447 /* 448 ** Macros to determine whether the machine is big or little endian, 449 ** evaluated at runtime. 450 */ 451 #ifdef SQLITE_AMALGAMATION 452 const int sqlite3one = 1; 453 #else 454 extern const int sqlite3one; 455 #endif 456 #if defined(i386) || defined(__i386__) || defined(_M_IX86)\ 457 || defined(__x86_64) || defined(__x86_64__) 458 # define SQLITE_BIGENDIAN 0 459 # define SQLITE_LITTLEENDIAN 1 460 # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 461 #else 462 # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 463 # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 464 # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 465 #endif 466 467 /* 468 ** Constants for the largest and smallest possible 64-bit signed integers. 469 ** These macros are designed to work correctly on both 32-bit and 64-bit 470 ** compilers. 471 */ 472 #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 473 #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 474 475 /* 476 ** Round up a number to the next larger multiple of 8. This is used 477 ** to force 8-byte alignment on 64-bit architectures. 478 */ 479 #define ROUND8(x) (((x)+7)&~7) 480 481 /* 482 ** Round down to the nearest multiple of 8 483 */ 484 #define ROUNDDOWN8(x) ((x)&~7) 485 486 /* 487 ** Assert that the pointer X is aligned to an 8-byte boundary. This 488 ** macro is used only within assert() to verify that the code gets 489 ** all alignment restrictions correct. 490 ** 491 ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 492 ** underlying malloc() implemention might return us 4-byte aligned 493 ** pointers. In that case, only verify 4-byte alignment. 494 */ 495 #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 496 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 497 #else 498 # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 499 #endif 500 501 502 /* 503 ** An instance of the following structure is used to store the busy-handler 504 ** callback for a given sqlite handle. 505 ** 506 ** The sqlite.busyHandler member of the sqlite struct contains the busy 507 ** callback for the database handle. Each pager opened via the sqlite 508 ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 509 ** callback is currently invoked only from within pager.c. 510 */ 511 typedef struct BusyHandler BusyHandler; 512 struct BusyHandler { 513 int (*xFunc)(void *,int); /* The busy callback */ 514 void *pArg; /* First arg to busy callback */ 515 int nBusy; /* Incremented with each busy call */ 516 }; 517 518 /* 519 ** Name of the master database table. The master database table 520 ** is a special table that holds the names and attributes of all 521 ** user tables and indices. 522 */ 523 #define MASTER_NAME "sqlite_master" 524 #define TEMP_MASTER_NAME "sqlite_temp_master" 525 526 /* 527 ** The root-page of the master database table. 528 */ 529 #define MASTER_ROOT 1 530 531 /* 532 ** The name of the schema table. 533 */ 534 #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME) 535 536 /* 537 ** A convenience macro that returns the number of elements in 538 ** an array. 539 */ 540 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 541 542 /* 543 ** The following value as a destructor means to use sqlite3DbFree(). 544 ** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT. 545 */ 546 #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3DbFree) 547 548 /* 549 ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 550 ** not support Writable Static Data (WSD) such as global and static variables. 551 ** All variables must either be on the stack or dynamically allocated from 552 ** the heap. When WSD is unsupported, the variable declarations scattered 553 ** throughout the SQLite code must become constants instead. The SQLITE_WSD 554 ** macro is used for this purpose. And instead of referencing the variable 555 ** directly, we use its constant as a key to lookup the run-time allocated 556 ** buffer that holds real variable. The constant is also the initializer 557 ** for the run-time allocated buffer. 558 ** 559 ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 560 ** macros become no-ops and have zero performance impact. 561 */ 562 #ifdef SQLITE_OMIT_WSD 563 #define SQLITE_WSD const 564 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 565 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 566 int sqlite3_wsd_init(int N, int J); 567 void *sqlite3_wsd_find(void *K, int L); 568 #else 569 #define SQLITE_WSD 570 #define GLOBAL(t,v) v 571 #define sqlite3GlobalConfig sqlite3Config 572 #endif 573 574 /* 575 ** The following macros are used to suppress compiler warnings and to 576 ** make it clear to human readers when a function parameter is deliberately 577 ** left unused within the body of a function. This usually happens when 578 ** a function is called via a function pointer. For example the 579 ** implementation of an SQL aggregate step callback may not use the 580 ** parameter indicating the number of arguments passed to the aggregate, 581 ** if it knows that this is enforced elsewhere. 582 ** 583 ** When a function parameter is not used at all within the body of a function, 584 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 585 ** However, these macros may also be used to suppress warnings related to 586 ** parameters that may or may not be used depending on compilation options. 587 ** For example those parameters only used in assert() statements. In these 588 ** cases the parameters are named as per the usual conventions. 589 */ 590 #define UNUSED_PARAMETER(x) (void)(x) 591 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 592 593 /* 594 ** Forward references to structures 595 */ 596 typedef struct AggInfo AggInfo; 597 typedef struct AuthContext AuthContext; 598 typedef struct AutoincInfo AutoincInfo; 599 typedef struct Bitvec Bitvec; 600 typedef struct CollSeq CollSeq; 601 typedef struct Column Column; 602 typedef struct Db Db; 603 typedef struct Schema Schema; 604 typedef struct Expr Expr; 605 typedef struct ExprList ExprList; 606 typedef struct ExprSpan ExprSpan; 607 typedef struct FKey FKey; 608 typedef struct FuncDestructor FuncDestructor; 609 typedef struct FuncDef FuncDef; 610 typedef struct FuncDefHash FuncDefHash; 611 typedef struct IdList IdList; 612 typedef struct Index Index; 613 typedef struct IndexSample IndexSample; 614 typedef struct KeyClass KeyClass; 615 typedef struct KeyInfo KeyInfo; 616 typedef struct Lookaside Lookaside; 617 typedef struct LookasideSlot LookasideSlot; 618 typedef struct Module Module; 619 typedef struct NameContext NameContext; 620 typedef struct Parse Parse; 621 typedef struct RowSet RowSet; 622 typedef struct Savepoint Savepoint; 623 typedef struct Select Select; 624 typedef struct SrcList SrcList; 625 typedef struct StrAccum StrAccum; 626 typedef struct Table Table; 627 typedef struct TableLock TableLock; 628 typedef struct Token Token; 629 typedef struct Trigger Trigger; 630 typedef struct TriggerPrg TriggerPrg; 631 typedef struct TriggerStep TriggerStep; 632 typedef struct UnpackedRecord UnpackedRecord; 633 typedef struct VTable VTable; 634 typedef struct Walker Walker; 635 typedef struct WherePlan WherePlan; 636 typedef struct WhereInfo WhereInfo; 637 typedef struct WhereLevel WhereLevel; 638 639 /* 640 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 641 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 642 ** pointer types (i.e. FuncDef) defined above. 643 */ 644 #include "btree.h" 645 #if 0 646 #include "vdbe.h" 647 #include "pager.h" 648 #include "pcache.h" 649 650 #include "os.h" 651 #include "mutex.h" 652 #endif 653 654 /* 655 ** Each database file to be accessed by the system is an instance 656 ** of the following structure. There are normally two of these structures 657 ** in the sqlite.aDb[] array. aDb[0] is the main database file and 658 ** aDb[1] is the database file used to hold temporary tables. Additional 659 ** databases may be attached. 660 */ 661 struct Db { 662 char *zName; /* Name of this database */ 663 Btree *pBt; /* The B*Tree structure for this database file */ 664 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */ 665 u8 safety_level; /* How aggressive at syncing data to disk */ 666 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 667 }; 668 669 /* 670 ** An instance of the following structure stores a database schema. 671 ** 672 ** Most Schema objects are associated with a Btree. The exception is 673 ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 674 ** In shared cache mode, a single Schema object can be shared by multiple 675 ** Btrees that refer to the same underlying BtShared object. 676 ** 677 ** Schema objects are automatically deallocated when the last Btree that 678 ** references them is destroyed. The TEMP Schema is manually freed by 679 ** sqlite3_close(). 680 * 681 ** A thread must be holding a mutex on the corresponding Btree in order 682 ** to access Schema content. This implies that the thread must also be 683 ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 684 ** For a TEMP Schema, on the connection mutex is required. 685 */ 686 struct Schema { 687 int schema_cookie; /* Database schema version number for this file */ 688 int iGeneration; /* Generation counter. Incremented with each change */ 689 Hash tblHash; /* All tables indexed by name */ 690 Hash idxHash; /* All (named) indices indexed by name */ 691 Hash trigHash; /* All triggers indexed by name */ 692 Hash fkeyHash; /* All foreign keys by referenced table name */ 693 Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 694 u8 file_format; /* Schema format version for this file */ 695 u8 enc; /* Text encoding used by this database */ 696 u16 flags; /* Flags associated with this schema */ 697 int cache_size; /* Number of pages to use in the cache */ 698 }; 699 700 /* 701 ** These macros can be used to test, set, or clear bits in the 702 ** Db.pSchema->flags field. 703 */ 704 #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P)) 705 #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0) 706 #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P) 707 #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P) 708 709 /* 710 ** Allowed values for the DB.pSchema->flags field. 711 ** 712 ** The DB_SchemaLoaded flag is set after the database schema has been 713 ** read into internal hash tables. 714 ** 715 ** DB_UnresetViews means that one or more views have column names that 716 ** have been filled out. If the schema changes, these column names might 717 ** changes and so the view will need to be reset. 718 */ 719 #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 720 #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 721 #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */ 722 723 /* 724 ** The number of different kinds of things that can be limited 725 ** using the sqlite3_limit() interface. 726 */ 727 #define SQLITE_N_LIMIT (SQLITE_LIMIT_TRIGGER_DEPTH+1) 728 729 /* 730 ** Lookaside malloc is a set of fixed-size buffers that can be used 731 ** to satisfy small transient memory allocation requests for objects 732 ** associated with a particular database connection. The use of 733 ** lookaside malloc provides a significant performance enhancement 734 ** (approx 10%) by avoiding numerous malloc/free requests while parsing 735 ** SQL statements. 736 ** 737 ** The Lookaside structure holds configuration information about the 738 ** lookaside malloc subsystem. Each available memory allocation in 739 ** the lookaside subsystem is stored on a linked list of LookasideSlot 740 ** objects. 741 ** 742 ** Lookaside allocations are only allowed for objects that are associated 743 ** with a particular database connection. Hence, schema information cannot 744 ** be stored in lookaside because in shared cache mode the schema information 745 ** is shared by multiple database connections. Therefore, while parsing 746 ** schema information, the Lookaside.bEnabled flag is cleared so that 747 ** lookaside allocations are not used to construct the schema objects. 748 */ 749 struct Lookaside { 750 u16 sz; /* Size of each buffer in bytes */ 751 u8 bEnabled; /* False to disable new lookaside allocations */ 752 u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 753 int nOut; /* Number of buffers currently checked out */ 754 int mxOut; /* Highwater mark for nOut */ 755 int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 756 LookasideSlot *pFree; /* List of available buffers */ 757 void *pStart; /* First byte of available memory space */ 758 void *pEnd; /* First byte past end of available space */ 759 }; 760 struct LookasideSlot { 761 LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 762 }; 763 764 /* 765 ** A hash table for function definitions. 766 ** 767 ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 768 ** Collisions are on the FuncDef.pHash chain. 769 */ 770 struct FuncDefHash { 771 FuncDef *a[23]; /* Hash table for functions */ 772 }; 773 774 /* 775 ** Each database connection is an instance of the following structure. 776 ** 777 ** The sqlite.lastRowid records the last insert rowid generated by an 778 ** insert statement. Inserts on views do not affect its value. Each 779 ** trigger has its own context, so that lastRowid can be updated inside 780 ** triggers as usual. The previous value will be restored once the trigger 781 ** exits. Upon entering a before or instead of trigger, lastRowid is no 782 ** longer (since after version 2.8.12) reset to -1. 783 ** 784 ** The sqlite.nChange does not count changes within triggers and keeps no 785 ** context. It is reset at start of sqlite3_exec. 786 ** The sqlite.lsChange represents the number of changes made by the last 787 ** insert, update, or delete statement. It remains constant throughout the 788 ** length of a statement and is then updated by OP_SetCounts. It keeps a 789 ** context stack just like lastRowid so that the count of changes 790 ** within a trigger is not seen outside the trigger. Changes to views do not 791 ** affect the value of lsChange. 792 ** The sqlite.csChange keeps track of the number of current changes (since 793 ** the last statement) and is used to update sqlite_lsChange. 794 ** 795 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16 796 ** store the most recent error code and, if applicable, string. The 797 ** internal function sqlite3Error() is used to set these variables 798 ** consistently. 799 */ 800 struct sqlite3 { 801 sqlite3_vfs *pVfs; /* OS Interface */ 802 int nDb; /* Number of backends currently in use */ 803 Db *aDb; /* All backends */ 804 int flags; /* Miscellaneous flags. See below */ 805 int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 806 int errCode; /* Most recent error code (SQLITE_*) */ 807 int errMask; /* & result codes with this before returning */ 808 u8 autoCommit; /* The auto-commit flag. */ 809 u8 temp_store; /* 1: file 2: memory 0: default */ 810 u8 mallocFailed; /* True if we have seen a malloc failure */ 811 u8 dfltLockMode; /* Default locking-mode for attached dbs */ 812 signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 813 u8 suppressErr; /* Do not issue error messages if true */ 814 int nextPagesize; /* Pagesize after VACUUM if >0 */ 815 int nTable; /* Number of tables in the database */ 816 CollSeq *pDfltColl; /* The default collating sequence (BINARY) */ 817 i64 lastRowid; /* ROWID of most recent insert (see above) */ 818 u32 magic; /* Magic number for detect library misuse */ 819 int nChange; /* Value returned by sqlite3_changes() */ 820 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 821 sqlite3_mutex *mutex; /* Connection mutex */ 822 int aLimit[SQLITE_N_LIMIT]; /* Limits */ 823 struct sqlite3InitInfo { /* Information used during initialization */ 824 int iDb; /* When back is being initialized */ 825 int newTnum; /* Rootpage of table being initialized */ 826 u8 busy; /* TRUE if currently initializing */ 827 u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */ 828 } init; 829 int nExtension; /* Number of loaded extensions */ 830 void **aExtension; /* Array of shared library handles */ 831 struct Vdbe *pVdbe; /* List of active virtual machines */ 832 int activeVdbeCnt; /* Number of VDBEs currently executing */ 833 int writeVdbeCnt; /* Number of active VDBEs that are writing */ 834 int vdbeExecCnt; /* Number of nested calls to VdbeExec() */ 835 void (*xTrace)(void*,const char*); /* Trace function */ 836 void *pTraceArg; /* Argument to the trace function */ 837 void (*xProfile)(void*,const char*,u64); /* Profiling function */ 838 void *pProfileArg; /* Argument to profile function */ 839 void *pCommitArg; /* Argument to xCommitCallback() */ 840 int (*xCommitCallback)(void*); /* Invoked at every commit. */ 841 void *pRollbackArg; /* Argument to xRollbackCallback() */ 842 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 843 void *pUpdateArg; 844 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 845 #ifndef SQLITE_OMIT_WAL 846 int (*xWalCallback)(void *, sqlite3 *, const char *, int); 847 void *pWalArg; 848 #endif 849 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 850 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 851 void *pCollNeededArg; 852 sqlite3_value *pErr; /* Most recent error message */ 853 char *zErrMsg; /* Most recent error message (UTF-8 encoded) */ 854 char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */ 855 union { 856 volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 857 double notUsed1; /* Spacer */ 858 } u1; 859 Lookaside lookaside; /* Lookaside malloc configuration */ 860 #ifndef SQLITE_OMIT_AUTHORIZATION 861 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*); 862 /* Access authorization function */ 863 void *pAuthArg; /* 1st argument to the access auth function */ 864 #endif 865 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 866 int (*xProgress)(void *); /* The progress callback */ 867 void *pProgressArg; /* Argument to the progress callback */ 868 int nProgressOps; /* Number of opcodes for progress callback */ 869 #endif 870 #ifndef SQLITE_OMIT_VIRTUALTABLE 871 Hash aModule; /* populated by sqlite3_create_module() */ 872 Table *pVTab; /* vtab with active Connect/Create method */ 873 VTable **aVTrans; /* Virtual tables with open transactions */ 874 int nVTrans; /* Allocated size of aVTrans */ 875 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 876 #endif 877 FuncDefHash aFunc; /* Hash table of connection functions */ 878 Hash aCollSeq; /* All collating sequences */ 879 BusyHandler busyHandler; /* Busy callback */ 880 int busyTimeout; /* Busy handler timeout, in msec */ 881 Db aDbStatic[2]; /* Static space for the 2 default backends */ 882 Savepoint *pSavepoint; /* List of active savepoints */ 883 int nSavepoint; /* Number of non-transaction savepoints */ 884 int nStatement; /* Number of nested statement-transactions */ 885 u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 886 i64 nDeferredCons; /* Net deferred constraints this transaction. */ 887 int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 888 889 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 890 /* The following variables are all protected by the STATIC_MASTER 891 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 892 ** 893 ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 894 ** unlock so that it can proceed. 895 ** 896 ** When X.pBlockingConnection==Y, that means that something that X tried 897 ** tried to do recently failed with an SQLITE_LOCKED error due to locks 898 ** held by Y. 899 */ 900 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 901 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 902 void *pUnlockArg; /* Argument to xUnlockNotify */ 903 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 904 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 905 #endif 906 }; 907 908 #if 0 909 /* 910 ** A macro to discover the encoding of a database. 911 */ 912 #define ENC(db) ((db)->aDb[0].pSchema->enc) 913 914 /* 915 ** Possible values for the sqlite3.flags. 916 */ 917 #define SQLITE_VdbeTrace 0x00000100 /* True to trace VDBE execution */ 918 #define SQLITE_InternChanges 0x00000200 /* Uncommitted Hash table changes */ 919 #define SQLITE_FullColNames 0x00000400 /* Show full column names on SELECT */ 920 #define SQLITE_ShortColNames 0x00000800 /* Show short columns names */ 921 #define SQLITE_CountRows 0x00001000 /* Count rows changed by INSERT, */ 922 /* DELETE, or UPDATE and return */ 923 /* the count using a callback. */ 924 #define SQLITE_NullCallback 0x00002000 /* Invoke the callback once if the */ 925 /* result set is empty */ 926 #define SQLITE_SqlTrace 0x00004000 /* Debug print SQL as it executes */ 927 #define SQLITE_VdbeListing 0x00008000 /* Debug listings of VDBE programs */ 928 #define SQLITE_WriteSchema 0x00010000 /* OK to update SQLITE_MASTER */ 929 #define SQLITE_NoReadlock 0x00020000 /* Readlocks are omitted when 930 ** accessing read-only databases */ 931 #define SQLITE_IgnoreChecks 0x00040000 /* Do not enforce check constraints */ 932 #define SQLITE_ReadUncommitted 0x0080000 /* For shared-cache mode */ 933 #define SQLITE_LegacyFileFmt 0x00100000 /* Create new databases in format 1 */ 934 #define SQLITE_FullFSync 0x00200000 /* Use full fsync on the backend */ 935 #define SQLITE_CkptFullFSync 0x00400000 /* Use full fsync for checkpoint */ 936 #define SQLITE_RecoveryMode 0x00800000 /* Ignore schema errors */ 937 #define SQLITE_ReverseOrder 0x01000000 /* Reverse unordered SELECTs */ 938 #define SQLITE_RecTriggers 0x02000000 /* Enable recursive triggers */ 939 #define SQLITE_ForeignKeys 0x04000000 /* Enforce foreign key constraints */ 940 #define SQLITE_AutoIndex 0x08000000 /* Enable automatic indexes */ 941 #define SQLITE_PreferBuiltin 0x10000000 /* Preference to built-in funcs */ 942 #define SQLITE_LoadExtension 0x20000000 /* Enable load_extension */ 943 #define SQLITE_EnableTrigger 0x40000000 /* True to enable triggers */ 944 945 /* 946 ** Bits of the sqlite3.flags field that are used by the 947 ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface. 948 ** These must be the low-order bits of the flags field. 949 */ 950 #define SQLITE_QueryFlattener 0x01 /* Disable query flattening */ 951 #define SQLITE_ColumnCache 0x02 /* Disable the column cache */ 952 #define SQLITE_IndexSort 0x04 /* Disable indexes for sorting */ 953 #define SQLITE_IndexSearch 0x08 /* Disable indexes for searching */ 954 #define SQLITE_IndexCover 0x10 /* Disable index covering table */ 955 #define SQLITE_GroupByOrder 0x20 /* Disable GROUPBY cover of ORDERBY */ 956 #define SQLITE_FactorOutConst 0x40 /* Disable factoring out constants */ 957 #define SQLITE_OptMask 0xff /* Mask of all disablable opts */ 958 959 /* 960 ** Possible values for the sqlite.magic field. 961 ** The numbers are obtained at random and have no special meaning, other 962 ** than being distinct from one another. 963 */ 964 #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 965 #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 966 #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 967 #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 968 #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 969 970 /* 971 ** Each SQL function is defined by an instance of the following 972 ** structure. A pointer to this structure is stored in the sqlite.aFunc 973 ** hash table. When multiple functions have the same name, the hash table 974 ** points to a linked list of these structures. 975 */ 976 struct FuncDef { 977 i16 nArg; /* Number of arguments. -1 means unlimited */ 978 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */ 979 u8 flags; /* Some combination of SQLITE_FUNC_* */ 980 void *pUserData; /* User data parameter */ 981 FuncDef *pNext; /* Next function with same name */ 982 void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */ 983 void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */ 984 void (*xFinalize)(sqlite3_context*); /* Aggregate finalizer */ 985 char *zName; /* SQL name of the function. */ 986 FuncDef *pHash; /* Next with a different name but the same hash */ 987 FuncDestructor *pDestructor; /* Reference counted destructor function */ 988 }; 989 990 /* 991 ** This structure encapsulates a user-function destructor callback (as 992 ** configured using create_function_v2()) and a reference counter. When 993 ** create_function_v2() is called to create a function with a destructor, 994 ** a single object of this type is allocated. FuncDestructor.nRef is set to 995 ** the number of FuncDef objects created (either 1 or 3, depending on whether 996 ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 997 ** member of each of the new FuncDef objects is set to point to the allocated 998 ** FuncDestructor. 999 ** 1000 ** Thereafter, when one of the FuncDef objects is deleted, the reference 1001 ** count on this object is decremented. When it reaches 0, the destructor 1002 ** is invoked and the FuncDestructor structure freed. 1003 */ 1004 struct FuncDestructor { 1005 int nRef; 1006 void (*xDestroy)(void *); 1007 void *pUserData; 1008 }; 1009 1010 /* 1011 ** Possible values for FuncDef.flags 1012 */ 1013 #define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */ 1014 #define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */ 1015 #define SQLITE_FUNC_EPHEM 0x04 /* Ephemeral. Delete with VDBE */ 1016 #define SQLITE_FUNC_NEEDCOLL 0x08 /* sqlite3GetFuncCollSeq() might be called */ 1017 #define SQLITE_FUNC_PRIVATE 0x10 /* Allowed for internal use only */ 1018 #define SQLITE_FUNC_COUNT 0x20 /* Built-in count(*) aggregate */ 1019 #define SQLITE_FUNC_COALESCE 0x40 /* Built-in coalesce() or ifnull() function */ 1020 1021 /* 1022 ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1023 ** used to create the initializers for the FuncDef structures. 1024 ** 1025 ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1026 ** Used to create a scalar function definition of a function zName 1027 ** implemented by C function xFunc that accepts nArg arguments. The 1028 ** value passed as iArg is cast to a (void*) and made available 1029 ** as the user-data (sqlite3_user_data()) for the function. If 1030 ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1031 ** 1032 ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1033 ** Used to create an aggregate function definition implemented by 1034 ** the C functions xStep and xFinal. The first four parameters 1035 ** are interpreted in the same way as the first 4 parameters to 1036 ** FUNCTION(). 1037 ** 1038 ** LIKEFUNC(zName, nArg, pArg, flags) 1039 ** Used to create a scalar function definition of a function zName 1040 ** that accepts nArg arguments and is implemented by a call to C 1041 ** function likeFunc. Argument pArg is cast to a (void *) and made 1042 ** available as the function user-data (sqlite3_user_data()). The 1043 ** FuncDef.flags variable is set to the value passed as the flags 1044 ** parameter. 1045 */ 1046 #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1047 {nArg, SQLITE_UTF8, bNC*SQLITE_FUNC_NEEDCOLL, \ 1048 SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0} 1049 #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 1050 {nArg, SQLITE_UTF8, bNC*SQLITE_FUNC_NEEDCOLL, \ 1051 pArg, 0, xFunc, 0, 0, #zName, 0, 0} 1052 #define LIKEFUNC(zName, nArg, arg, flags) \ 1053 {nArg, SQLITE_UTF8, flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0, 0} 1054 #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \ 1055 {nArg, SQLITE_UTF8, nc*SQLITE_FUNC_NEEDCOLL, \ 1056 SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0} 1057 1058 /* 1059 ** All current savepoints are stored in a linked list starting at 1060 ** sqlite3.pSavepoint. The first element in the list is the most recently 1061 ** opened savepoint. Savepoints are added to the list by the vdbe 1062 ** OP_Savepoint instruction. 1063 */ 1064 struct Savepoint { 1065 char *zName; /* Savepoint name (nul-terminated) */ 1066 i64 nDeferredCons; /* Number of deferred fk violations */ 1067 Savepoint *pNext; /* Parent savepoint (if any) */ 1068 }; 1069 1070 /* 1071 ** The following are used as the second parameter to sqlite3Savepoint(), 1072 ** and as the P1 argument to the OP_Savepoint instruction. 1073 */ 1074 #define SAVEPOINT_BEGIN 0 1075 #define SAVEPOINT_RELEASE 1 1076 #define SAVEPOINT_ROLLBACK 2 1077 1078 1079 /* 1080 ** Each SQLite module (virtual table definition) is defined by an 1081 ** instance of the following structure, stored in the sqlite3.aModule 1082 ** hash table. 1083 */ 1084 struct Module { 1085 const sqlite3_module *pModule; /* Callback pointers */ 1086 const char *zName; /* Name passed to create_module() */ 1087 void *pAux; /* pAux passed to create_module() */ 1088 void (*xDestroy)(void *); /* Module destructor function */ 1089 }; 1090 1091 /* 1092 ** information about each column of an SQL table is held in an instance 1093 ** of this structure. 1094 */ 1095 struct Column { 1096 char *zName; /* Name of this column */ 1097 Expr *pDflt; /* Default value of this column */ 1098 char *zDflt; /* Original text of the default value */ 1099 char *zType; /* Data type for this column */ 1100 char *zColl; /* Collating sequence. If NULL, use the default */ 1101 u8 notNull; /* True if there is a NOT NULL constraint */ 1102 u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */ 1103 char affinity; /* One of the SQLITE_AFF_... values */ 1104 #ifndef SQLITE_OMIT_VIRTUALTABLE 1105 u8 isHidden; /* True if this column is 'hidden' */ 1106 #endif 1107 }; 1108 1109 /* 1110 ** A "Collating Sequence" is defined by an instance of the following 1111 ** structure. Conceptually, a collating sequence consists of a name and 1112 ** a comparison routine that defines the order of that sequence. 1113 ** 1114 ** There may two separate implementations of the collation function, one 1115 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that 1116 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine 1117 ** native byte order. When a collation sequence is invoked, SQLite selects 1118 ** the version that will require the least expensive encoding 1119 ** translations, if any. 1120 ** 1121 ** The CollSeq.pUser member variable is an extra parameter that passed in 1122 ** as the first argument to the UTF-8 comparison function, xCmp. 1123 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function, 1124 ** xCmp16. 1125 ** 1126 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the 1127 ** collating sequence is undefined. Indices built on an undefined 1128 ** collating sequence may not be read or written. 1129 */ 1130 struct CollSeq { 1131 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 1132 u8 enc; /* Text encoding handled by xCmp() */ 1133 u8 type; /* One of the SQLITE_COLL_... values below */ 1134 void *pUser; /* First argument to xCmp() */ 1135 int (*xCmp)(void*,int, const void*, int, const void*); 1136 void (*xDel)(void*); /* Destructor for pUser */ 1137 }; 1138 1139 /* 1140 ** Allowed values of CollSeq.type: 1141 */ 1142 #define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */ 1143 #define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */ 1144 #define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */ 1145 #define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */ 1146 1147 /* 1148 ** A sort order can be either ASC or DESC. 1149 */ 1150 #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 1151 #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 1152 1153 /* 1154 ** Column affinity types. 1155 ** 1156 ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 1157 ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 1158 ** the speed a little by numbering the values consecutively. 1159 ** 1160 ** But rather than start with 0 or 1, we begin with 'a'. That way, 1161 ** when multiple affinity types are concatenated into a string and 1162 ** used as the P4 operand, they will be more readable. 1163 ** 1164 ** Note also that the numeric types are grouped together so that testing 1165 ** for a numeric type is a single comparison. 1166 */ 1167 #define SQLITE_AFF_TEXT 'a' 1168 #define SQLITE_AFF_NONE 'b' 1169 #define SQLITE_AFF_NUMERIC 'c' 1170 #define SQLITE_AFF_INTEGER 'd' 1171 #define SQLITE_AFF_REAL 'e' 1172 1173 #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 1174 1175 /* 1176 ** The SQLITE_AFF_MASK values masks off the significant bits of an 1177 ** affinity value. 1178 */ 1179 #define SQLITE_AFF_MASK 0x67 1180 1181 /* 1182 ** Additional bit values that can be ORed with an affinity without 1183 ** changing the affinity. 1184 */ 1185 #define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */ 1186 #define SQLITE_STOREP2 0x10 /* Store result in reg[P2] rather than jump */ 1187 #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 1188 1189 /* 1190 ** An object of this type is created for each virtual table present in 1191 ** the database schema. 1192 ** 1193 ** If the database schema is shared, then there is one instance of this 1194 ** structure for each database connection (sqlite3*) that uses the shared 1195 ** schema. This is because each database connection requires its own unique 1196 ** instance of the sqlite3_vtab* handle used to access the virtual table 1197 ** implementation. sqlite3_vtab* handles can not be shared between 1198 ** database connections, even when the rest of the in-memory database 1199 ** schema is shared, as the implementation often stores the database 1200 ** connection handle passed to it via the xConnect() or xCreate() method 1201 ** during initialization internally. This database connection handle may 1202 ** then be used by the virtual table implementation to access real tables 1203 ** within the database. So that they appear as part of the callers 1204 ** transaction, these accesses need to be made via the same database 1205 ** connection as that used to execute SQL operations on the virtual table. 1206 ** 1207 ** All VTable objects that correspond to a single table in a shared 1208 ** database schema are initially stored in a linked-list pointed to by 1209 ** the Table.pVTable member variable of the corresponding Table object. 1210 ** When an sqlite3_prepare() operation is required to access the virtual 1211 ** table, it searches the list for the VTable that corresponds to the 1212 ** database connection doing the preparing so as to use the correct 1213 ** sqlite3_vtab* handle in the compiled query. 1214 ** 1215 ** When an in-memory Table object is deleted (for example when the 1216 ** schema is being reloaded for some reason), the VTable objects are not 1217 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 1218 ** immediately. Instead, they are moved from the Table.pVTable list to 1219 ** another linked list headed by the sqlite3.pDisconnect member of the 1220 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 1221 ** next time a statement is prepared using said sqlite3*. This is done 1222 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 1223 ** Refer to comments above function sqlite3VtabUnlockList() for an 1224 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 1225 ** list without holding the corresponding sqlite3.mutex mutex. 1226 ** 1227 ** The memory for objects of this type is always allocated by 1228 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 1229 ** the first argument. 1230 */ 1231 struct VTable { 1232 sqlite3 *db; /* Database connection associated with this table */ 1233 Module *pMod; /* Pointer to module implementation */ 1234 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 1235 int nRef; /* Number of pointers to this structure */ 1236 VTable *pNext; /* Next in linked list (see above) */ 1237 }; 1238 1239 /* 1240 ** Each SQL table is represented in memory by an instance of the 1241 ** following structure. 1242 ** 1243 ** Table.zName is the name of the table. The case of the original 1244 ** CREATE TABLE statement is stored, but case is not significant for 1245 ** comparisons. 1246 ** 1247 ** Table.nCol is the number of columns in this table. Table.aCol is a 1248 ** pointer to an array of Column structures, one for each column. 1249 ** 1250 ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of 1251 ** the column that is that key. Otherwise Table.iPKey is negative. Note 1252 ** that the datatype of the PRIMARY KEY must be INTEGER for this field to 1253 ** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of 1254 ** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid 1255 ** is generated for each row of the table. TF_HasPrimaryKey is set if 1256 ** the table has any PRIMARY KEY, INTEGER or otherwise. 1257 ** 1258 ** Table.tnum is the page number for the root BTree page of the table in the 1259 ** database file. If Table.iDb is the index of the database table backend 1260 ** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that 1261 ** holds temporary tables and indices. If TF_Ephemeral is set 1262 ** then the table is stored in a file that is automatically deleted 1263 ** when the VDBE cursor to the table is closed. In this case Table.tnum 1264 ** refers VDBE cursor number that holds the table open, not to the root 1265 ** page number. Transient tables are used to hold the results of a 1266 ** sub-query that appears instead of a real table name in the FROM clause 1267 ** of a SELECT statement. 1268 */ 1269 struct Table { 1270 char *zName; /* Name of the table or view */ 1271 int iPKey; /* If not negative, use aCol[iPKey] as the primary key */ 1272 int nCol; /* Number of columns in this table */ 1273 Column *aCol; /* Information about each column */ 1274 Index *pIndex; /* List of SQL indexes on this table. */ 1275 int tnum; /* Root BTree node for this table (see note above) */ 1276 unsigned nRowEst; /* Estimated rows in table - from sqlite_stat1 table */ 1277 Select *pSelect; /* NULL for tables. Points to definition if a view. */ 1278 u16 nRef; /* Number of pointers to this Table */ 1279 u8 tabFlags; /* Mask of TF_* values */ 1280 u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 1281 FKey *pFKey; /* Linked list of all foreign keys in this table */ 1282 char *zColAff; /* String defining the affinity of each column */ 1283 #ifndef SQLITE_OMIT_CHECK 1284 Expr *pCheck; /* The AND of all CHECK constraints */ 1285 #endif 1286 #ifndef SQLITE_OMIT_ALTERTABLE 1287 int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 1288 #endif 1289 #ifndef SQLITE_OMIT_VIRTUALTABLE 1290 VTable *pVTable; /* List of VTable objects. */ 1291 int nModuleArg; /* Number of arguments to the module */ 1292 char **azModuleArg; /* Text of all module args. [0] is module name */ 1293 #endif 1294 Trigger *pTrigger; /* List of triggers stored in pSchema */ 1295 Schema *pSchema; /* Schema that contains this table */ 1296 Table *pNextZombie; /* Next on the Parse.pZombieTab list */ 1297 }; 1298 1299 /* 1300 ** Allowed values for Tabe.tabFlags. 1301 */ 1302 #define TF_Readonly 0x01 /* Read-only system table */ 1303 #define TF_Ephemeral 0x02 /* An ephemeral table */ 1304 #define TF_HasPrimaryKey 0x04 /* Table has a primary key */ 1305 #define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */ 1306 #define TF_Virtual 0x10 /* Is a virtual table */ 1307 #define TF_NeedMetadata 0x20 /* aCol[].zType and aCol[].pColl missing */ 1308 1309 1310 1311 /* 1312 ** Test to see whether or not a table is a virtual table. This is 1313 ** done as a macro so that it will be optimized out when virtual 1314 ** table support is omitted from the build. 1315 */ 1316 #ifndef SQLITE_OMIT_VIRTUALTABLE 1317 # define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0) 1318 # define IsHiddenColumn(X) ((X)->isHidden) 1319 #else 1320 # define IsVirtual(X) 0 1321 # define IsHiddenColumn(X) 0 1322 #endif 1323 1324 /* 1325 ** Each foreign key constraint is an instance of the following structure. 1326 ** 1327 ** A foreign key is associated with two tables. The "from" table is 1328 ** the table that contains the REFERENCES clause that creates the foreign 1329 ** key. The "to" table is the table that is named in the REFERENCES clause. 1330 ** Consider this example: 1331 ** 1332 ** CREATE TABLE ex1( 1333 ** a INTEGER PRIMARY KEY, 1334 ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 1335 ** ); 1336 ** 1337 ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 1338 ** 1339 ** Each REFERENCES clause generates an instance of the following structure 1340 ** which is attached to the from-table. The to-table need not exist when 1341 ** the from-table is created. The existence of the to-table is not checked. 1342 */ 1343 struct FKey { 1344 Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 1345 FKey *pNextFrom; /* Next foreign key in pFrom */ 1346 char *zTo; /* Name of table that the key points to (aka: Parent) */ 1347 FKey *pNextTo; /* Next foreign key on table named zTo */ 1348 FKey *pPrevTo; /* Previous foreign key on table named zTo */ 1349 int nCol; /* Number of columns in this key */ 1350 /* EV: R-30323-21917 */ 1351 u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 1352 u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 1353 Trigger *apTrigger[2]; /* Triggers for aAction[] actions */ 1354 struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 1355 int iFrom; /* Index of column in pFrom */ 1356 char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */ 1357 } aCol[1]; /* One entry for each of nCol column s */ 1358 }; 1359 1360 /* 1361 ** SQLite supports many different ways to resolve a constraint 1362 ** error. ROLLBACK processing means that a constraint violation 1363 ** causes the operation in process to fail and for the current transaction 1364 ** to be rolled back. ABORT processing means the operation in process 1365 ** fails and any prior changes from that one operation are backed out, 1366 ** but the transaction is not rolled back. FAIL processing means that 1367 ** the operation in progress stops and returns an error code. But prior 1368 ** changes due to the same operation are not backed out and no rollback 1369 ** occurs. IGNORE means that the particular row that caused the constraint 1370 ** error is not inserted or updated. Processing continues and no error 1371 ** is returned. REPLACE means that preexisting database rows that caused 1372 ** a UNIQUE constraint violation are removed so that the new insert or 1373 ** update can proceed. Processing continues and no error is reported. 1374 ** 1375 ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys. 1376 ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 1377 ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 1378 ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the 1379 ** referenced table row is propagated into the row that holds the 1380 ** foreign key. 1381 ** 1382 ** The following symbolic values are used to record which type 1383 ** of action to take. 1384 */ 1385 #define OE_None 0 /* There is no constraint to check */ 1386 #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 1387 #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 1388 #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 1389 #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 1390 #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 1391 1392 #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 1393 #define OE_SetNull 7 /* Set the foreign key value to NULL */ 1394 #define OE_SetDflt 8 /* Set the foreign key value to its default */ 1395 #define OE_Cascade 9 /* Cascade the changes */ 1396 1397 #define OE_Default 99 /* Do whatever the default action is */ 1398 1399 #endif 1400 /* 1401 ** An instance of the following structure is passed as the first 1402 ** argument to sqlite3VdbeKeyCompare and is used to control the 1403 ** comparison of the two index keys. 1404 */ 1405 struct KeyInfo { 1406 sqlite3 *db; /* The database connection */ 1407 u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 1408 u16 nField; /* Number of entries in aColl[] */ 1409 u8 *aSortOrder; /* Sort order for each column. May be NULL */ 1410 CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 1411 }; 1412 1413 /* 1414 ** An instance of the following structure holds information about a 1415 ** single index record that has already been parsed out into individual 1416 ** values. 1417 ** 1418 ** A record is an object that contains one or more fields of data. 1419 ** Records are used to store the content of a table row and to store 1420 ** the key of an index. A blob encoding of a record is created by 1421 ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 1422 ** OP_Column opcode. 1423 ** 1424 ** This structure holds a record that has already been disassembled 1425 ** into its constituent fields. 1426 */ 1427 struct UnpackedRecord { 1428 KeyInfo *pKeyInfo; /* Collation and sort-order information */ 1429 u16 nField; /* Number of entries in apMem[] */ 1430 u16 flags; /* Boolean settings. UNPACKED_... below */ 1431 i64 rowid; /* Used by UNPACKED_PREFIX_SEARCH */ 1432 Mem *aMem; /* Values */ 1433 }; 1434 1435 /* 1436 ** Allowed values of UnpackedRecord.flags 1437 */ 1438 #define UNPACKED_NEED_FREE 0x0001 /* Memory is from sqlite3Malloc() */ 1439 #define UNPACKED_NEED_DESTROY 0x0002 /* apMem[]s should all be destroyed */ 1440 #define UNPACKED_IGNORE_ROWID 0x0004 /* Ignore trailing rowid on key1 */ 1441 #define UNPACKED_INCRKEY 0x0008 /* Make this key an epsilon larger */ 1442 #define UNPACKED_PREFIX_MATCH 0x0010 /* A prefix match is considered OK */ 1443 #define UNPACKED_PREFIX_SEARCH 0x0020 /* A prefix match is considered OK */ 1444 1445 #if 0 1446 1447 /* 1448 ** Each SQL index is represented in memory by an 1449 ** instance of the following structure. 1450 ** 1451 ** The columns of the table that are to be indexed are described 1452 ** by the aiColumn[] field of this structure. For example, suppose 1453 ** we have the following table and index: 1454 ** 1455 ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 1456 ** CREATE INDEX Ex2 ON Ex1(c3,c1); 1457 ** 1458 ** In the Table structure describing Ex1, nCol==3 because there are 1459 ** three columns in the table. In the Index structure describing 1460 ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 1461 ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 1462 ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 1463 ** The second column to be indexed (c1) has an index of 0 in 1464 ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 1465 ** 1466 ** The Index.onError field determines whether or not the indexed columns 1467 ** must be unique and what to do if they are not. When Index.onError=OE_None, 1468 ** it means this is not a unique index. Otherwise it is a unique index 1469 ** and the value of Index.onError indicate the which conflict resolution 1470 ** algorithm to employ whenever an attempt is made to insert a non-unique 1471 ** element. 1472 */ 1473 struct Index { 1474 char *zName; /* Name of this index */ 1475 int nColumn; /* Number of columns in the table used by this index */ 1476 int *aiColumn; /* Which columns are used by this index. 1st is 0 */ 1477 unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */ 1478 Table *pTable; /* The SQL table being indexed */ 1479 int tnum; /* Page containing root of this index in database file */ 1480 u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 1481 u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */ 1482 char *zColAff; /* String defining the affinity of each column */ 1483 Index *pNext; /* The next index associated with the same table */ 1484 Schema *pSchema; /* Schema containing this index */ 1485 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */ 1486 char **azColl; /* Array of collation sequence names for index */ 1487 IndexSample *aSample; /* Array of SQLITE_INDEX_SAMPLES samples */ 1488 }; 1489 1490 /* 1491 ** Each sample stored in the sqlite_stat2 table is represented in memory 1492 ** using a structure of this type. 1493 */ 1494 struct IndexSample { 1495 union { 1496 char *z; /* Value if eType is SQLITE_TEXT or SQLITE_BLOB */ 1497 double r; /* Value if eType is SQLITE_FLOAT or SQLITE_INTEGER */ 1498 } u; 1499 u8 eType; /* SQLITE_NULL, SQLITE_INTEGER ... etc. */ 1500 u8 nByte; /* Size in byte of text or blob. */ 1501 }; 1502 1503 /* 1504 ** Each token coming out of the lexer is an instance of 1505 ** this structure. Tokens are also used as part of an expression. 1506 ** 1507 ** Note if Token.z==0 then Token.dyn and Token.n are undefined and 1508 ** may contain random values. Do not make any assumptions about Token.dyn 1509 ** and Token.n when Token.z==0. 1510 */ 1511 struct Token { 1512 const char *z; /* Text of the token. Not NULL-terminated! */ 1513 unsigned int n; /* Number of characters in this token */ 1514 }; 1515 1516 /* 1517 ** An instance of this structure contains information needed to generate 1518 ** code for a SELECT that contains aggregate functions. 1519 ** 1520 ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 1521 ** pointer to this structure. The Expr.iColumn field is the index in 1522 ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 1523 ** code for that node. 1524 ** 1525 ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 1526 ** original Select structure that describes the SELECT statement. These 1527 ** fields do not need to be freed when deallocating the AggInfo structure. 1528 */ 1529 struct AggInfo { 1530 u8 directMode; /* Direct rendering mode means take data directly 1531 ** from source tables rather than from accumulators */ 1532 u8 useSortingIdx; /* In direct mode, reference the sorting index rather 1533 ** than the source table */ 1534 int sortingIdx; /* Cursor number of the sorting index */ 1535 ExprList *pGroupBy; /* The group by clause */ 1536 int nSortingColumn; /* Number of columns in the sorting index */ 1537 struct AggInfo_col { /* For each column used in source tables */ 1538 Table *pTab; /* Source table */ 1539 int iTable; /* Cursor number of the source table */ 1540 int iColumn; /* Column number within the source table */ 1541 int iSorterColumn; /* Column number in the sorting index */ 1542 int iMem; /* Memory location that acts as accumulator */ 1543 Expr *pExpr; /* The original expression */ 1544 } *aCol; 1545 int nColumn; /* Number of used entries in aCol[] */ 1546 int nColumnAlloc; /* Number of slots allocated for aCol[] */ 1547 int nAccumulator; /* Number of columns that show through to the output. 1548 ** Additional columns are used only as parameters to 1549 ** aggregate functions */ 1550 struct AggInfo_func { /* For each aggregate function */ 1551 Expr *pExpr; /* Expression encoding the function */ 1552 FuncDef *pFunc; /* The aggregate function implementation */ 1553 int iMem; /* Memory location that acts as accumulator */ 1554 int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 1555 } *aFunc; 1556 int nFunc; /* Number of entries in aFunc[] */ 1557 int nFuncAlloc; /* Number of slots allocated for aFunc[] */ 1558 }; 1559 1560 /* 1561 ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 1562 ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 1563 ** than 32767 we have to make it 32-bit. 16-bit is preferred because 1564 ** it uses less memory in the Expr object, which is a big memory user 1565 ** in systems with lots of prepared statements. And few applications 1566 ** need more than about 10 or 20 variables. But some extreme users want 1567 ** to have prepared statements with over 32767 variables, and for them 1568 ** the option is available (at compile-time). 1569 */ 1570 #if SQLITE_MAX_VARIABLE_NUMBER<=32767 1571 typedef i16 ynVar; 1572 #else 1573 typedef int ynVar; 1574 #endif 1575 1576 /* 1577 ** Each node of an expression in the parse tree is an instance 1578 ** of this structure. 1579 ** 1580 ** Expr.op is the opcode. The integer parser token codes are reused 1581 ** as opcodes here. For example, the parser defines TK_GE to be an integer 1582 ** code representing the ">=" operator. This same integer code is reused 1583 ** to represent the greater-than-or-equal-to operator in the expression 1584 ** tree. 1585 ** 1586 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 1587 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 1588 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 1589 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 1590 ** then Expr.token contains the name of the function. 1591 ** 1592 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 1593 ** binary operator. Either or both may be NULL. 1594 ** 1595 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 1596 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 1597 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 1598 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 1599 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 1600 ** valid. 1601 ** 1602 ** An expression of the form ID or ID.ID refers to a column in a table. 1603 ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 1604 ** the integer cursor number of a VDBE cursor pointing to that table and 1605 ** Expr.iColumn is the column number for the specific column. If the 1606 ** expression is used as a result in an aggregate SELECT, then the 1607 ** value is also stored in the Expr.iAgg column in the aggregate so that 1608 ** it can be accessed after all aggregates are computed. 1609 ** 1610 ** If the expression is an unbound variable marker (a question mark 1611 ** character '?' in the original SQL) then the Expr.iTable holds the index 1612 ** number for that variable. 1613 ** 1614 ** If the expression is a subquery then Expr.iColumn holds an integer 1615 ** register number containing the result of the subquery. If the 1616 ** subquery gives a constant result, then iTable is -1. If the subquery 1617 ** gives a different answer at different times during statement processing 1618 ** then iTable is the address of a subroutine that computes the subquery. 1619 ** 1620 ** If the Expr is of type OP_Column, and the table it is selecting from 1621 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 1622 ** corresponding table definition. 1623 ** 1624 ** ALLOCATION NOTES: 1625 ** 1626 ** Expr objects can use a lot of memory space in database schema. To 1627 ** help reduce memory requirements, sometimes an Expr object will be 1628 ** truncated. And to reduce the number of memory allocations, sometimes 1629 ** two or more Expr objects will be stored in a single memory allocation, 1630 ** together with Expr.zToken strings. 1631 ** 1632 ** If the EP_Reduced and EP_TokenOnly flags are set when 1633 ** an Expr object is truncated. When EP_Reduced is set, then all 1634 ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 1635 ** are contained within the same memory allocation. Note, however, that 1636 ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 1637 ** allocated, regardless of whether or not EP_Reduced is set. 1638 */ 1639 struct Expr { 1640 u8 op; /* Operation performed by this node */ 1641 char affinity; /* The affinity of the column or 0 if not a column */ 1642 u16 flags; /* Various flags. EP_* See below */ 1643 union { 1644 char *zToken; /* Token value. Zero terminated and dequoted */ 1645 int iValue; /* Non-negative integer value if EP_IntValue */ 1646 } u; 1647 1648 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 1649 ** space is allocated for the fields below this point. An attempt to 1650 ** access them will result in a segfault or malfunction. 1651 *********************************************************************/ 1652 1653 Expr *pLeft; /* Left subnode */ 1654 Expr *pRight; /* Right subnode */ 1655 union { 1656 ExprList *pList; /* Function arguments or in "<expr> IN (<expr-list)" */ 1657 Select *pSelect; /* Used for sub-selects and "<expr> IN (<select>)" */ 1658 } x; 1659 CollSeq *pColl; /* The collation type of the column or 0 */ 1660 1661 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 1662 ** space is allocated for the fields below this point. An attempt to 1663 ** access them will result in a segfault or malfunction. 1664 *********************************************************************/ 1665 1666 int iTable; /* TK_COLUMN: cursor number of table holding column 1667 ** TK_REGISTER: register number 1668 ** TK_TRIGGER: 1 -> new, 0 -> old */ 1669 ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 1670 ** TK_VARIABLE: variable number (always >= 1). */ 1671 i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 1672 i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 1673 u8 flags2; /* Second set of flags. EP2_... */ 1674 u8 op2; /* If a TK_REGISTER, the original value of Expr.op */ 1675 AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 1676 Table *pTab; /* Table for TK_COLUMN expressions. */ 1677 #if SQLITE_MAX_EXPR_DEPTH>0 1678 int nHeight; /* Height of the tree headed by this node */ 1679 #endif 1680 }; 1681 1682 /* 1683 ** The following are the meanings of bits in the Expr.flags field. 1684 */ 1685 #define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */ 1686 #define EP_Agg 0x0002 /* Contains one or more aggregate functions */ 1687 #define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */ 1688 #define EP_Error 0x0008 /* Expression contains one or more errors */ 1689 #define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */ 1690 #define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */ 1691 #define EP_DblQuoted 0x0040 /* token.z was originally in "..." */ 1692 #define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */ 1693 #define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */ 1694 #define EP_FixedDest 0x0200 /* Result needed in a specific register */ 1695 #define EP_IntValue 0x0400 /* Integer value contained in u.iValue */ 1696 #define EP_xIsSelect 0x0800 /* x.pSelect is valid (otherwise x.pList is) */ 1697 1698 #define EP_Reduced 0x1000 /* Expr struct is EXPR_REDUCEDSIZE bytes only */ 1699 #define EP_TokenOnly 0x2000 /* Expr struct is EXPR_TOKENONLYSIZE bytes only */ 1700 #define EP_Static 0x4000 /* Held in memory not obtained from malloc() */ 1701 1702 /* 1703 ** The following are the meanings of bits in the Expr.flags2 field. 1704 */ 1705 #define EP2_MallocedToken 0x0001 /* Need to sqlite3DbFree() Expr.zToken */ 1706 #define EP2_Irreducible 0x0002 /* Cannot EXPRDUP_REDUCE this Expr */ 1707 1708 /* 1709 ** The pseudo-routine sqlite3ExprSetIrreducible sets the EP2_Irreducible 1710 ** flag on an expression structure. This flag is used for VV&A only. The 1711 ** routine is implemented as a macro that only works when in debugging mode, 1712 ** so as not to burden production code. 1713 */ 1714 #ifdef SQLITE_DEBUG 1715 # define ExprSetIrreducible(X) (X)->flags2 |= EP2_Irreducible 1716 #else 1717 # define ExprSetIrreducible(X) 1718 #endif 1719 1720 /* 1721 ** These macros can be used to test, set, or clear bits in the 1722 ** Expr.flags field. 1723 */ 1724 #define ExprHasProperty(E,P) (((E)->flags&(P))==(P)) 1725 #define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0) 1726 #define ExprSetProperty(E,P) (E)->flags|=(P) 1727 #define ExprClearProperty(E,P) (E)->flags&=~(P) 1728 1729 /* 1730 ** Macros to determine the number of bytes required by a normal Expr 1731 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 1732 ** and an Expr struct with the EP_TokenOnly flag set. 1733 */ 1734 #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 1735 #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 1736 #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 1737 1738 /* 1739 ** Flags passed to the sqlite3ExprDup() function. See the header comment 1740 ** above sqlite3ExprDup() for details. 1741 */ 1742 #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 1743 1744 /* 1745 ** A list of expressions. Each expression may optionally have a 1746 ** name. An expr/name combination can be used in several ways, such 1747 ** as the list of "expr AS ID" fields following a "SELECT" or in the 1748 ** list of "ID = expr" items in an UPDATE. A list of expressions can 1749 ** also be used as the argument to a function, in which case the a.zName 1750 ** field is not used. 1751 */ 1752 struct ExprList { 1753 int nExpr; /* Number of expressions on the list */ 1754 int nAlloc; /* Number of entries allocated below */ 1755 int iECursor; /* VDBE Cursor associated with this ExprList */ 1756 struct ExprList_item { 1757 Expr *pExpr; /* The list of expressions */ 1758 char *zName; /* Token associated with this expression */ 1759 char *zSpan; /* Original text of the expression */ 1760 u8 sortOrder; /* 1 for DESC or 0 for ASC */ 1761 u8 done; /* A flag to indicate when processing is finished */ 1762 u16 iCol; /* For ORDER BY, column number in result set */ 1763 u16 iAlias; /* Index into Parse.aAlias[] for zName */ 1764 } *a; /* One entry for each expression */ 1765 }; 1766 1767 /* 1768 ** An instance of this structure is used by the parser to record both 1769 ** the parse tree for an expression and the span of input text for an 1770 ** expression. 1771 */ 1772 struct ExprSpan { 1773 Expr *pExpr; /* The expression parse tree */ 1774 const char *zStart; /* First character of input text */ 1775 const char *zEnd; /* One character past the end of input text */ 1776 }; 1777 1778 /* 1779 ** An instance of this structure can hold a simple list of identifiers, 1780 ** such as the list "a,b,c" in the following statements: 1781 ** 1782 ** INSERT INTO t(a,b,c) VALUES ...; 1783 ** CREATE INDEX idx ON t(a,b,c); 1784 ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 1785 ** 1786 ** The IdList.a.idx field is used when the IdList represents the list of 1787 ** column names after a table name in an INSERT statement. In the statement 1788 ** 1789 ** INSERT INTO t(a,b,c) ... 1790 ** 1791 ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 1792 */ 1793 struct IdList { 1794 struct IdList_item { 1795 char *zName; /* Name of the identifier */ 1796 int idx; /* Index in some Table.aCol[] of a column named zName */ 1797 } *a; 1798 int nId; /* Number of identifiers on the list */ 1799 int nAlloc; /* Number of entries allocated for a[] below */ 1800 }; 1801 1802 /* 1803 ** The bitmask datatype defined below is used for various optimizations. 1804 ** 1805 ** Changing this from a 64-bit to a 32-bit type limits the number of 1806 ** tables in a join to 32 instead of 64. But it also reduces the size 1807 ** of the library by 738 bytes on ix86. 1808 */ 1809 typedef u64 Bitmask; 1810 1811 /* 1812 ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 1813 */ 1814 #define BMS ((int)(sizeof(Bitmask)*8)) 1815 1816 /* 1817 ** The following structure describes the FROM clause of a SELECT statement. 1818 ** Each table or subquery in the FROM clause is a separate element of 1819 ** the SrcList.a[] array. 1820 ** 1821 ** With the addition of multiple database support, the following structure 1822 ** can also be used to describe a particular table such as the table that 1823 ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 1824 ** such a table must be a simple name: ID. But in SQLite, the table can 1825 ** now be identified by a database name, a dot, then the table name: ID.ID. 1826 ** 1827 ** The jointype starts out showing the join type between the current table 1828 ** and the next table on the list. The parser builds the list this way. 1829 ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 1830 ** jointype expresses the join between the table and the previous table. 1831 ** 1832 ** In the colUsed field, the high-order bit (bit 63) is set if the table 1833 ** contains more than 63 columns and the 64-th or later column is used. 1834 */ 1835 struct SrcList { 1836 i16 nSrc; /* Number of tables or subqueries in the FROM clause */ 1837 i16 nAlloc; /* Number of entries allocated in a[] below */ 1838 struct SrcList_item { 1839 char *zDatabase; /* Name of database holding this table */ 1840 char *zName; /* Name of the table */ 1841 char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 1842 Table *pTab; /* An SQL table corresponding to zName */ 1843 Select *pSelect; /* A SELECT statement used in place of a table name */ 1844 u8 isPopulated; /* Temporary table associated with SELECT is populated */ 1845 u8 jointype; /* Type of join between this able and the previous */ 1846 u8 notIndexed; /* True if there is a NOT INDEXED clause */ 1847 #ifndef SQLITE_OMIT_EXPLAIN 1848 u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */ 1849 #endif 1850 int iCursor; /* The VDBE cursor number used to access this table */ 1851 Expr *pOn; /* The ON clause of a join */ 1852 IdList *pUsing; /* The USING clause of a join */ 1853 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 1854 char *zIndex; /* Identifier from "INDEXED BY <zIndex>" clause */ 1855 Index *pIndex; /* Index structure corresponding to zIndex, if any */ 1856 } a[1]; /* One entry for each identifier on the list */ 1857 }; 1858 1859 /* 1860 ** Permitted values of the SrcList.a.jointype field 1861 */ 1862 #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 1863 #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 1864 #define JT_NATURAL 0x0004 /* True for a "natural" join */ 1865 #define JT_LEFT 0x0008 /* Left outer join */ 1866 #define JT_RIGHT 0x0010 /* Right outer join */ 1867 #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 1868 #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 1869 1870 1871 /* 1872 ** A WherePlan object holds information that describes a lookup 1873 ** strategy. 1874 ** 1875 ** This object is intended to be opaque outside of the where.c module. 1876 ** It is included here only so that that compiler will know how big it 1877 ** is. None of the fields in this object should be used outside of 1878 ** the where.c module. 1879 ** 1880 ** Within the union, pIdx is only used when wsFlags&WHERE_INDEXED is true. 1881 ** pTerm is only used when wsFlags&WHERE_MULTI_OR is true. And pVtabIdx 1882 ** is only used when wsFlags&WHERE_VIRTUALTABLE is true. It is never the 1883 ** case that more than one of these conditions is true. 1884 */ 1885 struct WherePlan { 1886 u32 wsFlags; /* WHERE_* flags that describe the strategy */ 1887 u32 nEq; /* Number of == constraints */ 1888 double nRow; /* Estimated number of rows (for EQP) */ 1889 union { 1890 Index *pIdx; /* Index when WHERE_INDEXED is true */ 1891 struct WhereTerm *pTerm; /* WHERE clause term for OR-search */ 1892 sqlite3_index_info *pVtabIdx; /* Virtual table index to use */ 1893 } u; 1894 }; 1895 1896 /* 1897 ** For each nested loop in a WHERE clause implementation, the WhereInfo 1898 ** structure contains a single instance of this structure. This structure 1899 ** is intended to be private the the where.c module and should not be 1900 ** access or modified by other modules. 1901 ** 1902 ** The pIdxInfo field is used to help pick the best index on a 1903 ** virtual table. The pIdxInfo pointer contains indexing 1904 ** information for the i-th table in the FROM clause before reordering. 1905 ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c. 1906 ** All other information in the i-th WhereLevel object for the i-th table 1907 ** after FROM clause ordering. 1908 */ 1909 struct WhereLevel { 1910 WherePlan plan; /* query plan for this element of the FROM clause */ 1911 int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */ 1912 int iTabCur; /* The VDBE cursor used to access the table */ 1913 int iIdxCur; /* The VDBE cursor used to access pIdx */ 1914 int addrBrk; /* Jump here to break out of the loop */ 1915 int addrNxt; /* Jump here to start the next IN combination */ 1916 int addrCont; /* Jump here to continue with the next loop cycle */ 1917 int addrFirst; /* First instruction of interior of the loop */ 1918 u8 iFrom; /* Which entry in the FROM clause */ 1919 u8 op, p5; /* Opcode and P5 of the opcode that ends the loop */ 1920 int p1, p2; /* Operands of the opcode used to ends the loop */ 1921 union { /* Information that depends on plan.wsFlags */ 1922 struct { 1923 int nIn; /* Number of entries in aInLoop[] */ 1924 struct InLoop { 1925 int iCur; /* The VDBE cursor used by this IN operator */ 1926 int addrInTop; /* Top of the IN loop */ 1927 } *aInLoop; /* Information about each nested IN operator */ 1928 } in; /* Used when plan.wsFlags&WHERE_IN_ABLE */ 1929 } u; 1930 1931 /* The following field is really not part of the current level. But 1932 ** we need a place to cache virtual table index information for each 1933 ** virtual table in the FROM clause and the WhereLevel structure is 1934 ** a convenient place since there is one WhereLevel for each FROM clause 1935 ** element. 1936 */ 1937 sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */ 1938 }; 1939 1940 /* 1941 ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 1942 ** and the WhereInfo.wctrlFlags member. 1943 */ 1944 #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 1945 #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 1946 #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 1947 #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 1948 #define WHERE_DUPLICATES_OK 0x0008 /* Ok to return a row more than once */ 1949 #define WHERE_OMIT_OPEN 0x0010 /* Table cursors are already open */ 1950 #define WHERE_OMIT_CLOSE 0x0020 /* Omit close of table & index cursors */ 1951 #define WHERE_FORCE_TABLE 0x0040 /* Do not use an index-only search */ 1952 #define WHERE_ONETABLE_ONLY 0x0080 /* Only code the 1st table in pTabList */ 1953 1954 /* 1955 ** The WHERE clause processing routine has two halves. The 1956 ** first part does the start of the WHERE loop and the second 1957 ** half does the tail of the WHERE loop. An instance of 1958 ** this structure is returned by the first half and passed 1959 ** into the second half to give some continuity. 1960 */ 1961 struct WhereInfo { 1962 Parse *pParse; /* Parsing and code generating context */ 1963 u16 wctrlFlags; /* Flags originally passed to sqlite3WhereBegin() */ 1964 u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */ 1965 u8 untestedTerms; /* Not all WHERE terms resolved by outer loop */ 1966 SrcList *pTabList; /* List of tables in the join */ 1967 int iTop; /* The very beginning of the WHERE loop */ 1968 int iContinue; /* Jump here to continue with next record */ 1969 int iBreak; /* Jump here to break out of the loop */ 1970 int nLevel; /* Number of nested loop */ 1971 struct WhereClause *pWC; /* Decomposition of the WHERE clause */ 1972 double savedNQueryLoop; /* pParse->nQueryLoop outside the WHERE loop */ 1973 double nRowOut; /* Estimated number of output rows */ 1974 WhereLevel a[1]; /* Information about each nest loop in WHERE */ 1975 }; 1976 1977 /* 1978 ** A NameContext defines a context in which to resolve table and column 1979 ** names. The context consists of a list of tables (the pSrcList) field and 1980 ** a list of named expression (pEList). The named expression list may 1981 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 1982 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 1983 ** pEList corresponds to the result set of a SELECT and is NULL for 1984 ** other statements. 1985 ** 1986 ** NameContexts can be nested. When resolving names, the inner-most 1987 ** context is searched first. If no match is found, the next outer 1988 ** context is checked. If there is still no match, the next context 1989 ** is checked. This process continues until either a match is found 1990 ** or all contexts are check. When a match is found, the nRef member of 1991 ** the context containing the match is incremented. 1992 ** 1993 ** Each subquery gets a new NameContext. The pNext field points to the 1994 ** NameContext in the parent query. Thus the process of scanning the 1995 ** NameContext list corresponds to searching through successively outer 1996 ** subqueries looking for a match. 1997 */ 1998 struct NameContext { 1999 Parse *pParse; /* The parser */ 2000 SrcList *pSrcList; /* One or more tables used to resolve names */ 2001 ExprList *pEList; /* Optional list of named expressions */ 2002 int nRef; /* Number of names resolved by this context */ 2003 int nErr; /* Number of errors encountered while resolving names */ 2004 u8 allowAgg; /* Aggregate functions allowed here */ 2005 u8 hasAgg; /* True if aggregates are seen */ 2006 u8 isCheck; /* True if resolving names in a CHECK constraint */ 2007 int nDepth; /* Depth of subquery recursion. 1 for no recursion */ 2008 AggInfo *pAggInfo; /* Information about aggregates at this level */ 2009 NameContext *pNext; /* Next outer name context. NULL for outermost */ 2010 }; 2011 2012 /* 2013 ** An instance of the following structure contains all information 2014 ** needed to generate code for a single SELECT statement. 2015 ** 2016 ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0. 2017 ** If there is a LIMIT clause, the parser sets nLimit to the value of the 2018 ** limit and nOffset to the value of the offset (or 0 if there is not 2019 ** offset). But later on, nLimit and nOffset become the memory locations 2020 ** in the VDBE that record the limit and offset counters. 2021 ** 2022 ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 2023 ** These addresses must be stored so that we can go back and fill in 2024 ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 2025 ** the number of columns in P2 can be computed at the same time 2026 ** as the OP_OpenEphm instruction is coded because not 2027 ** enough information about the compound query is known at that point. 2028 ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 2029 ** for the result set. The KeyInfo for addrOpenTran[2] contains collating 2030 ** sequences for the ORDER BY clause. 2031 */ 2032 struct Select { 2033 ExprList *pEList; /* The fields of the result */ 2034 u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 2035 char affinity; /* MakeRecord with this affinity for SRT_Set */ 2036 u16 selFlags; /* Various SF_* values */ 2037 SrcList *pSrc; /* The FROM clause */ 2038 Expr *pWhere; /* The WHERE clause */ 2039 ExprList *pGroupBy; /* The GROUP BY clause */ 2040 Expr *pHaving; /* The HAVING clause */ 2041 ExprList *pOrderBy; /* The ORDER BY clause */ 2042 Select *pPrior; /* Prior select in a compound select statement */ 2043 Select *pNext; /* Next select to the left in a compound */ 2044 Select *pRightmost; /* Right-most select in a compound select statement */ 2045 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 2046 Expr *pOffset; /* OFFSET expression. NULL means not used. */ 2047 int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 2048 int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */ 2049 double nSelectRow; /* Estimated number of result rows */ 2050 }; 2051 2052 /* 2053 ** Allowed values for Select.selFlags. The "SF" prefix stands for 2054 ** "Select Flag". 2055 */ 2056 #define SF_Distinct 0x0001 /* Output should be DISTINCT */ 2057 #define SF_Resolved 0x0002 /* Identifiers have been resolved */ 2058 #define SF_Aggregate 0x0004 /* Contains aggregate functions */ 2059 #define SF_UsesEphemeral 0x0008 /* Uses the OpenEphemeral opcode */ 2060 #define SF_Expanded 0x0010 /* sqlite3SelectExpand() called on this */ 2061 #define SF_HasTypeInfo 0x0020 /* FROM subqueries have Table metadata */ 2062 2063 2064 /* 2065 ** The results of a select can be distributed in several ways. The 2066 ** "SRT" prefix means "SELECT Result Type". 2067 */ 2068 #define SRT_Union 1 /* Store result as keys in an index */ 2069 #define SRT_Except 2 /* Remove result from a UNION index */ 2070 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 2071 #define SRT_Discard 4 /* Do not save the results anywhere */ 2072 2073 /* The ORDER BY clause is ignored for all of the above */ 2074 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard) 2075 2076 #define SRT_Output 5 /* Output each row of result */ 2077 #define SRT_Mem 6 /* Store result in a memory cell */ 2078 #define SRT_Set 7 /* Store results as keys in an index */ 2079 #define SRT_Table 8 /* Store result as data with an automatic rowid */ 2080 #define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */ 2081 #define SRT_Coroutine 10 /* Generate a single row of result */ 2082 2083 /* 2084 ** A structure used to customize the behavior of sqlite3Select(). See 2085 ** comments above sqlite3Select() for details. 2086 */ 2087 typedef struct SelectDest SelectDest; 2088 struct SelectDest { 2089 u8 eDest; /* How to dispose of the results */ 2090 u8 affinity; /* Affinity used when eDest==SRT_Set */ 2091 int iParm; /* A parameter used by the eDest disposal method */ 2092 int iMem; /* Base register where results are written */ 2093 int nMem; /* Number of registers allocated */ 2094 }; 2095 2096 /* 2097 ** During code generation of statements that do inserts into AUTOINCREMENT 2098 ** tables, the following information is attached to the Table.u.autoInc.p 2099 ** pointer of each autoincrement table to record some side information that 2100 ** the code generator needs. We have to keep per-table autoincrement 2101 ** information in case inserts are down within triggers. Triggers do not 2102 ** normally coordinate their activities, but we do need to coordinate the 2103 ** loading and saving of autoincrement information. 2104 */ 2105 struct AutoincInfo { 2106 AutoincInfo *pNext; /* Next info block in a list of them all */ 2107 Table *pTab; /* Table this info block refers to */ 2108 int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 2109 int regCtr; /* Memory register holding the rowid counter */ 2110 }; 2111 2112 /* 2113 ** Size of the column cache 2114 */ 2115 #ifndef SQLITE_N_COLCACHE 2116 # define SQLITE_N_COLCACHE 10 2117 #endif 2118 2119 /* 2120 ** At least one instance of the following structure is created for each 2121 ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 2122 ** statement. All such objects are stored in the linked list headed at 2123 ** Parse.pTriggerPrg and deleted once statement compilation has been 2124 ** completed. 2125 ** 2126 ** A Vdbe sub-program that implements the body and WHEN clause of trigger 2127 ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 2128 ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 2129 ** The Parse.pTriggerPrg list never contains two entries with the same 2130 ** values for both pTrigger and orconf. 2131 ** 2132 ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 2133 ** accessed (or set to 0 for triggers fired as a result of INSERT 2134 ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 2135 ** a mask of new.* columns used by the program. 2136 */ 2137 struct TriggerPrg { 2138 Trigger *pTrigger; /* Trigger this program was coded from */ 2139 int orconf; /* Default ON CONFLICT policy */ 2140 SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 2141 u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 2142 TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 2143 }; 2144 2145 /* 2146 ** The yDbMask datatype for the bitmask of all attached databases. 2147 */ 2148 #if SQLITE_MAX_ATTACHED>30 2149 typedef sqlite3_uint64 yDbMask; 2150 #else 2151 typedef unsigned int yDbMask; 2152 #endif 2153 2154 /* 2155 ** An SQL parser context. A copy of this structure is passed through 2156 ** the parser and down into all the parser action routine in order to 2157 ** carry around information that is global to the entire parse. 2158 ** 2159 ** The structure is divided into two parts. When the parser and code 2160 ** generate call themselves recursively, the first part of the structure 2161 ** is constant but the second part is reset at the beginning and end of 2162 ** each recursion. 2163 ** 2164 ** The nTableLock and aTableLock variables are only used if the shared-cache 2165 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 2166 ** used to store the set of table-locks required by the statement being 2167 ** compiled. Function sqlite3TableLock() is used to add entries to the 2168 ** list. 2169 */ 2170 struct Parse { 2171 sqlite3 *db; /* The main database structure */ 2172 int rc; /* Return code from execution */ 2173 char *zErrMsg; /* An error message */ 2174 Vdbe *pVdbe; /* An engine for executing database bytecode */ 2175 u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 2176 u8 nameClash; /* A permanent table name clashes with temp table name */ 2177 u8 checkSchema; /* Causes schema cookie check after an error */ 2178 u8 nested; /* Number of nested calls to the parser/code generator */ 2179 u8 parseError; /* True after a parsing error. Ticket #1794 */ 2180 u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 2181 u8 nTempInUse; /* Number of aTempReg[] currently checked out */ 2182 int aTempReg[8]; /* Holding area for temporary registers */ 2183 int nRangeReg; /* Size of the temporary register block */ 2184 int iRangeReg; /* First register in temporary register block */ 2185 int nErr; /* Number of errors seen */ 2186 int nTab; /* Number of previously allocated VDBE cursors */ 2187 int nMem; /* Number of memory cells used so far */ 2188 int nSet; /* Number of sets used so far */ 2189 int ckBase; /* Base register of data during check constraints */ 2190 int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */ 2191 int iCacheCnt; /* Counter used to generate aColCache[].lru values */ 2192 u8 nColCache; /* Number of entries in the column cache */ 2193 u8 iColCache; /* Next entry of the cache to replace */ 2194 struct yColCache { 2195 int iTable; /* Table cursor number */ 2196 int iColumn; /* Table column number */ 2197 u8 tempReg; /* iReg is a temp register that needs to be freed */ 2198 int iLevel; /* Nesting level */ 2199 int iReg; /* Reg with value of this column. 0 means none. */ 2200 int lru; /* Least recently used entry has the smallest value */ 2201 } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */ 2202 yDbMask writeMask; /* Start a write transaction on these databases */ 2203 yDbMask cookieMask; /* Bitmask of schema verified databases */ 2204 u8 isMultiWrite; /* True if statement may affect/insert multiple rows */ 2205 u8 mayAbort; /* True if statement may throw an ABORT exception */ 2206 int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */ 2207 int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */ 2208 #ifndef SQLITE_OMIT_SHARED_CACHE 2209 int nTableLock; /* Number of locks in aTableLock */ 2210 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 2211 #endif 2212 int regRowid; /* Register holding rowid of CREATE TABLE entry */ 2213 int regRoot; /* Register holding root page number for new objects */ 2214 AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 2215 int nMaxArg; /* Max args passed to user function by sub-program */ 2216 2217 /* Information used while coding trigger programs. */ 2218 Parse *pToplevel; /* Parse structure for main program (or NULL) */ 2219 Table *pTriggerTab; /* Table triggers are being coded for */ 2220 u32 oldmask; /* Mask of old.* columns referenced */ 2221 u32 newmask; /* Mask of new.* columns referenced */ 2222 u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 2223 u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 2224 u8 disableTriggers; /* True to disable triggers */ 2225 double nQueryLoop; /* Estimated number of iterations of a query */ 2226 2227 /* Above is constant between recursions. Below is reset before and after 2228 ** each recursion */ 2229 2230 int nVar; /* Number of '?' variables seen in the SQL so far */ 2231 int nVarExpr; /* Number of used slots in apVarExpr[] */ 2232 int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */ 2233 Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */ 2234 Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 2235 int nAlias; /* Number of aliased result set columns */ 2236 int nAliasAlloc; /* Number of allocated slots for aAlias[] */ 2237 int *aAlias; /* Register used to hold aliased result */ 2238 u8 explain; /* True if the EXPLAIN flag is found on the query */ 2239 Token sNameToken; /* Token with unqualified schema object name */ 2240 Token sLastToken; /* The last token parsed */ 2241 const char *zTail; /* All SQL text past the last semicolon parsed */ 2242 Table *pNewTable; /* A table being constructed by CREATE TABLE */ 2243 Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 2244 const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 2245 #ifndef SQLITE_OMIT_VIRTUALTABLE 2246 Token sArg; /* Complete text of a module argument */ 2247 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */ 2248 int nVtabLock; /* Number of virtual tables to lock */ 2249 Table **apVtabLock; /* Pointer to virtual tables needing locking */ 2250 #endif 2251 int nHeight; /* Expression tree height of current sub-select */ 2252 Table *pZombieTab; /* List of Table objects to delete after code gen */ 2253 TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 2254 2255 #ifndef SQLITE_OMIT_EXPLAIN 2256 int iSelectId; 2257 int iNextSelectId; 2258 #endif 2259 }; 2260 2261 #ifdef SQLITE_OMIT_VIRTUALTABLE 2262 #define IN_DECLARE_VTAB 0 2263 #else 2264 #define IN_DECLARE_VTAB (pParse->declareVtab) 2265 #endif 2266 2267 /* 2268 ** An instance of the following structure can be declared on a stack and used 2269 ** to save the Parse.zAuthContext value so that it can be restored later. 2270 */ 2271 struct AuthContext { 2272 const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 2273 Parse *pParse; /* The Parse structure */ 2274 }; 2275 2276 /* 2277 ** Bitfield flags for P5 value in OP_Insert and OP_Delete 2278 */ 2279 #define OPFLAG_NCHANGE 0x01 /* Set to update db->nChange */ 2280 #define OPFLAG_LASTROWID 0x02 /* Set to update db->lastRowid */ 2281 #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 2282 #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 2283 #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 2284 #define OPFLAG_CLEARCACHE 0x20 /* Clear pseudo-table cache in OP_Column */ 2285 2286 /* 2287 * Each trigger present in the database schema is stored as an instance of 2288 * struct Trigger. 2289 * 2290 * Pointers to instances of struct Trigger are stored in two ways. 2291 * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 2292 * database). This allows Trigger structures to be retrieved by name. 2293 * 2. All triggers associated with a single table form a linked list, using the 2294 * pNext member of struct Trigger. A pointer to the first element of the 2295 * linked list is stored as the "pTrigger" member of the associated 2296 * struct Table. 2297 * 2298 * The "step_list" member points to the first element of a linked list 2299 * containing the SQL statements specified as the trigger program. 2300 */ 2301 struct Trigger { 2302 char *zName; /* The name of the trigger */ 2303 char *table; /* The table or view to which the trigger applies */ 2304 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 2305 u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 2306 Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 2307 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 2308 the <column-list> is stored here */ 2309 Schema *pSchema; /* Schema containing the trigger */ 2310 Schema *pTabSchema; /* Schema containing the table */ 2311 TriggerStep *step_list; /* Link list of trigger program steps */ 2312 Trigger *pNext; /* Next trigger associated with the table */ 2313 }; 2314 2315 /* 2316 ** A trigger is either a BEFORE or an AFTER trigger. The following constants 2317 ** determine which. 2318 ** 2319 ** If there are multiple triggers, you might of some BEFORE and some AFTER. 2320 ** In that cases, the constants below can be ORed together. 2321 */ 2322 #define TRIGGER_BEFORE 1 2323 #define TRIGGER_AFTER 2 2324 2325 /* 2326 * An instance of struct TriggerStep is used to store a single SQL statement 2327 * that is a part of a trigger-program. 2328 * 2329 * Instances of struct TriggerStep are stored in a singly linked list (linked 2330 * using the "pNext" member) referenced by the "step_list" member of the 2331 * associated struct Trigger instance. The first element of the linked list is 2332 * the first step of the trigger-program. 2333 * 2334 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 2335 * "SELECT" statement. The meanings of the other members is determined by the 2336 * value of "op" as follows: 2337 * 2338 * (op == TK_INSERT) 2339 * orconf -> stores the ON CONFLICT algorithm 2340 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 2341 * this stores a pointer to the SELECT statement. Otherwise NULL. 2342 * target -> A token holding the quoted name of the table to insert into. 2343 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 2344 * this stores values to be inserted. Otherwise NULL. 2345 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 2346 * statement, then this stores the column-names to be 2347 * inserted into. 2348 * 2349 * (op == TK_DELETE) 2350 * target -> A token holding the quoted name of the table to delete from. 2351 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 2352 * Otherwise NULL. 2353 * 2354 * (op == TK_UPDATE) 2355 * target -> A token holding the quoted name of the table to update rows of. 2356 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 2357 * Otherwise NULL. 2358 * pExprList -> A list of the columns to update and the expressions to update 2359 * them to. See sqlite3Update() documentation of "pChanges" 2360 * argument. 2361 * 2362 */ 2363 struct TriggerStep { 2364 u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */ 2365 u8 orconf; /* OE_Rollback etc. */ 2366 Trigger *pTrig; /* The trigger that this step is a part of */ 2367 Select *pSelect; /* SELECT statment or RHS of INSERT INTO .. SELECT ... */ 2368 Token target; /* Target table for DELETE, UPDATE, INSERT */ 2369 Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 2370 ExprList *pExprList; /* SET clause for UPDATE. VALUES clause for INSERT */ 2371 IdList *pIdList; /* Column names for INSERT */ 2372 TriggerStep *pNext; /* Next in the link-list */ 2373 TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 2374 }; 2375 2376 /* 2377 ** The following structure contains information used by the sqliteFix... 2378 ** routines as they walk the parse tree to make database references 2379 ** explicit. 2380 */ 2381 typedef struct DbFixer DbFixer; 2382 struct DbFixer { 2383 Parse *pParse; /* The parsing context. Error messages written here */ 2384 const char *zDb; /* Make sure all objects are contained in this database */ 2385 const char *zType; /* Type of the container - used for error messages */ 2386 const Token *pName; /* Name of the container - used for error messages */ 2387 }; 2388 2389 /* 2390 ** An objected used to accumulate the text of a string where we 2391 ** do not necessarily know how big the string will be in the end. 2392 */ 2393 struct StrAccum { 2394 sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 2395 char *zBase; /* A base allocation. Not from malloc. */ 2396 char *zText; /* The string collected so far */ 2397 int nChar; /* Length of the string so far */ 2398 int nAlloc; /* Amount of space allocated in zText */ 2399 int mxAlloc; /* Maximum allowed string length */ 2400 u8 mallocFailed; /* Becomes true if any memory allocation fails */ 2401 u8 useMalloc; /* 0: none, 1: sqlite3DbMalloc, 2: sqlite3_malloc */ 2402 u8 tooBig; /* Becomes true if string size exceeds limits */ 2403 }; 2404 2405 /* 2406 ** A pointer to this structure is used to communicate information 2407 ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 2408 */ 2409 typedef struct { 2410 sqlite3 *db; /* The database being initialized */ 2411 int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 2412 char **pzErrMsg; /* Error message stored here */ 2413 int rc; /* Result code stored here */ 2414 } InitData; 2415 2416 /* 2417 ** Structure containing global configuration data for the SQLite library. 2418 ** 2419 ** This structure also contains some state information. 2420 */ 2421 struct Sqlite3Config { 2422 int bMemstat; /* True to enable memory status */ 2423 int bCoreMutex; /* True to enable core mutexing */ 2424 int bFullMutex; /* True to enable full mutexing */ 2425 int mxStrlen; /* Maximum string length */ 2426 int szLookaside; /* Default lookaside buffer size */ 2427 int nLookaside; /* Default lookaside buffer count */ 2428 sqlite3_mem_methods m; /* Low-level memory allocation interface */ 2429 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 2430 sqlite3_pcache_methods pcache; /* Low-level page-cache interface */ 2431 void *pHeap; /* Heap storage space */ 2432 int nHeap; /* Size of pHeap[] */ 2433 int mnReq, mxReq; /* Min and max heap requests sizes */ 2434 void *pScratch; /* Scratch memory */ 2435 int szScratch; /* Size of each scratch buffer */ 2436 int nScratch; /* Number of scratch buffers */ 2437 void *pPage; /* Page cache memory */ 2438 int szPage; /* Size of each page in pPage[] */ 2439 int nPage; /* Number of pages in pPage[] */ 2440 int mxParserStack; /* maximum depth of the parser stack */ 2441 int sharedCacheEnabled; /* true if shared-cache mode enabled */ 2442 /* The above might be initialized to non-zero. The following need to always 2443 ** initially be zero, however. */ 2444 int isInit; /* True after initialization has finished */ 2445 int inProgress; /* True while initialization in progress */ 2446 int isMutexInit; /* True after mutexes are initialized */ 2447 int isMallocInit; /* True after malloc is initialized */ 2448 int isPCacheInit; /* True after malloc is initialized */ 2449 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 2450 int nRefInitMutex; /* Number of users of pInitMutex */ 2451 void (*xLog)(void*,int,const char*); /* Function for logging */ 2452 void *pLogArg; /* First argument to xLog() */ 2453 }; 2454 2455 /* 2456 ** Context pointer passed down through the tree-walk. 2457 */ 2458 struct Walker { 2459 int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 2460 int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 2461 Parse *pParse; /* Parser context. */ 2462 union { /* Extra data for callback */ 2463 NameContext *pNC; /* Naming context */ 2464 int i; /* Integer value */ 2465 } u; 2466 }; 2467 2468 /* Forward declarations */ 2469 int sqlite3WalkExpr(Walker*, Expr*); 2470 int sqlite3WalkExprList(Walker*, ExprList*); 2471 int sqlite3WalkSelect(Walker*, Select*); 2472 int sqlite3WalkSelectExpr(Walker*, Select*); 2473 int sqlite3WalkSelectFrom(Walker*, Select*); 2474 2475 /* 2476 ** Return code from the parse-tree walking primitives and their 2477 ** callbacks. 2478 */ 2479 #define WRC_Continue 0 /* Continue down into children */ 2480 #define WRC_Prune 1 /* Omit children but continue walking siblings */ 2481 #define WRC_Abort 2 /* Abandon the tree walk */ 2482 2483 /* 2484 ** Assuming zIn points to the first byte of a UTF-8 character, 2485 ** advance zIn to point to the first byte of the next UTF-8 character. 2486 */ 2487 #define SQLITE_SKIP_UTF8(zIn) { \ 2488 if( (*(zIn++))>=0xc0 ){ \ 2489 while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 2490 } \ 2491 } 2492 2493 #endif 2494 /* 2495 ** The SQLITE_*_BKPT macros are substitutes for the error codes with 2496 ** the same name but without the _BKPT suffix. These macros invoke 2497 ** routines that report the line-number on which the error originated 2498 ** using sqlite3_log(). The routines also provide a convenient place 2499 ** to set a debugger breakpoint. 2500 */ 2501 int sqlite3CorruptError(int); 2502 int sqlite3MisuseError(int); 2503 int sqlite3CantopenError(int); 2504 #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 2505 #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 2506 #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 2507 #if 0 2508 2509 /* 2510 ** FTS4 is really an extension for FTS3. It is enabled using the 2511 ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also all 2512 ** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3. 2513 */ 2514 #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 2515 # define SQLITE_ENABLE_FTS3 2516 #endif 2517 2518 /* 2519 ** The ctype.h header is needed for non-ASCII systems. It is also 2520 ** needed by FTS3 when FTS3 is included in the amalgamation. 2521 */ 2522 #if !defined(SQLITE_ASCII) || \ 2523 (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 2524 # include <ctype.h> 2525 #endif 2526 2527 /* 2528 ** The following macros mimic the standard library functions toupper(), 2529 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 2530 ** sqlite versions only work for ASCII characters, regardless of locale. 2531 */ 2532 #ifdef SQLITE_ASCII 2533 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 2534 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 2535 # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 2536 # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 2537 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 2538 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 2539 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 2540 #else 2541 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 2542 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 2543 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 2544 # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 2545 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 2546 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 2547 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 2548 #endif 2549 #endif 2550 2551 /* 2552 ** Internal function prototypes 2553 */ 2554 int sqlite3StrICmp(const char *, const char *); 2555 int sqlite3Strlen30(const char*); 2556 #define sqlite3StrNICmp sqlite3_strnicmp 2557 2558 int sqlite3MallocInit(void); 2559 void sqlite3MallocEnd(void); 2560 void *sqlite3Malloc(int); 2561 #if 0 2562 void *sqlite3MallocZero(int); 2563 void *sqlite3DbMallocZero(sqlite3*, int); 2564 void *sqlite3DbMallocRaw(sqlite3*, int); 2565 char *sqlite3DbStrDup(sqlite3*,const char*); 2566 char *sqlite3DbStrNDup(sqlite3*,const char*, int); 2567 void *sqlite3Realloc(void*, int); 2568 void *sqlite3DbReallocOrFree(sqlite3 *, void *, int); 2569 void *sqlite3DbRealloc(sqlite3 *, void *, int); 2570 void sqlite3DbFree(sqlite3*, void*); 2571 int sqlite3MallocSize(void*); 2572 int sqlite3DbMallocSize(sqlite3*, void*); 2573 void *sqlite3ScratchMalloc(int); 2574 void sqlite3ScratchFree(void*); 2575 void *sqlite3PageMalloc(int); 2576 void sqlite3PageFree(void*); 2577 void sqlite3MemSetDefault(void); 2578 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 2579 int sqlite3HeapNearlyFull(void); 2580 2581 /* 2582 ** On systems with ample stack space and that support alloca(), make 2583 ** use of alloca() to obtain space for large automatic objects. By default, 2584 ** obtain space from malloc(). 2585 ** 2586 ** The alloca() routine never returns NULL. This will cause code paths 2587 ** that deal with sqlite3StackAlloc() failures to be unreachable. 2588 */ 2589 #ifdef SQLITE_USE_ALLOCA 2590 # define sqlite3StackAllocRaw(D,N) alloca(N) 2591 # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 2592 # define sqlite3StackFree(D,P) 2593 #else 2594 # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 2595 # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 2596 # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 2597 #endif 2598 2599 #ifdef SQLITE_ENABLE_MEMSYS3 2600 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 2601 #endif 2602 #ifdef SQLITE_ENABLE_MEMSYS5 2603 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 2604 #endif 2605 2606 #endif 2607 2608 #ifndef SQLITE_MUTEX_OMIT 2609 sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 2610 sqlite3_mutex_methods const *sqlite3NoopMutex(void); 2611 sqlite3_mutex *sqlite3MutexAlloc(int); 2612 int sqlite3MutexInit(void); 2613 int sqlite3MutexEnd(void); 2614 #endif 2615 2616 #if 0 2617 2618 int sqlite3StatusValue(int); 2619 void sqlite3StatusAdd(int, int); 2620 void sqlite3StatusSet(int, int); 2621 2622 #ifndef SQLITE_OMIT_FLOATING_POINT 2623 int sqlite3IsNaN(double); 2624 #else 2625 # define sqlite3IsNaN(X) 0 2626 #endif 2627 2628 void sqlite3VXPrintf(StrAccum*, int, const char*, va_list); 2629 #ifndef SQLITE_OMIT_TRACE 2630 void sqlite3XPrintf(StrAccum*, const char*, ...); 2631 #endif 2632 char *sqlite3MPrintf(sqlite3*,const char*, ...); 2633 char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 2634 char *sqlite3MAppendf(sqlite3*,char*,const char*,...); 2635 #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG) 2636 void sqlite3DebugPrintf(const char*, ...); 2637 #endif 2638 #if defined(SQLITE_TEST) 2639 void *sqlite3TestTextToPtr(const char*); 2640 #endif 2641 void sqlite3SetString(char **, sqlite3*, const char*, ...); 2642 void sqlite3ErrorMsg(Parse*, const char*, ...); 2643 int sqlite3Dequote(char*); 2644 int sqlite3KeywordCode(const unsigned char*, int); 2645 int sqlite3RunParser(Parse*, const char*, char **); 2646 void sqlite3FinishCoding(Parse*); 2647 int sqlite3GetTempReg(Parse*); 2648 void sqlite3ReleaseTempReg(Parse*,int); 2649 int sqlite3GetTempRange(Parse*,int); 2650 void sqlite3ReleaseTempRange(Parse*,int,int); 2651 Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 2652 Expr *sqlite3Expr(sqlite3*,int,const char*); 2653 void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 2654 Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*); 2655 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*); 2656 Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*); 2657 void sqlite3ExprAssignVarNumber(Parse*, Expr*); 2658 void sqlite3ExprDelete(sqlite3*, Expr*); 2659 ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 2660 void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 2661 void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*); 2662 void sqlite3ExprListDelete(sqlite3*, ExprList*); 2663 int sqlite3Init(sqlite3*, char**); 2664 int sqlite3InitCallback(void*, int, char**, char**); 2665 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 2666 void sqlite3ResetInternalSchema(sqlite3*, int); 2667 void sqlite3BeginParse(Parse*,int); 2668 void sqlite3CommitInternalChanges(sqlite3*); 2669 Table *sqlite3ResultSetOfSelect(Parse*,Select*); 2670 void sqlite3OpenMasterTable(Parse *, int); 2671 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 2672 void sqlite3AddColumn(Parse*,Token*); 2673 void sqlite3AddNotNull(Parse*, int); 2674 void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 2675 void sqlite3AddCheckConstraint(Parse*, Expr*); 2676 void sqlite3AddColumnType(Parse*,Token*); 2677 void sqlite3AddDefaultValue(Parse*,ExprSpan*); 2678 void sqlite3AddCollateType(Parse*, Token*); 2679 void sqlite3EndTable(Parse*,Token*,Token*,Select*); 2680 2681 Bitvec *sqlite3BitvecCreate(u32); 2682 int sqlite3BitvecTest(Bitvec*, u32); 2683 int sqlite3BitvecSet(Bitvec*, u32); 2684 void sqlite3BitvecClear(Bitvec*, u32, void*); 2685 void sqlite3BitvecDestroy(Bitvec*); 2686 u32 sqlite3BitvecSize(Bitvec*); 2687 int sqlite3BitvecBuiltinTest(int,int*); 2688 2689 RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int); 2690 void sqlite3RowSetClear(RowSet*); 2691 void sqlite3RowSetInsert(RowSet*, i64); 2692 int sqlite3RowSetTest(RowSet*, u8 iBatch, i64); 2693 int sqlite3RowSetNext(RowSet*, i64*); 2694 2695 void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int); 2696 2697 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 2698 int sqlite3ViewGetColumnNames(Parse*,Table*); 2699 #else 2700 # define sqlite3ViewGetColumnNames(A,B) 0 2701 #endif 2702 2703 void sqlite3DropTable(Parse*, SrcList*, int, int); 2704 void sqlite3DeleteTable(sqlite3*, Table*); 2705 #ifndef SQLITE_OMIT_AUTOINCREMENT 2706 void sqlite3AutoincrementBegin(Parse *pParse); 2707 void sqlite3AutoincrementEnd(Parse *pParse); 2708 #else 2709 # define sqlite3AutoincrementBegin(X) 2710 # define sqlite3AutoincrementEnd(X) 2711 #endif 2712 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int); 2713 void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*); 2714 IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*); 2715 int sqlite3IdListIndex(IdList*,const char*); 2716 SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int); 2717 SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*); 2718 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 2719 Token*, Select*, Expr*, IdList*); 2720 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 2721 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *); 2722 void sqlite3SrcListShiftJoinType(SrcList*); 2723 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 2724 void sqlite3IdListDelete(sqlite3*, IdList*); 2725 void sqlite3SrcListDelete(sqlite3*, SrcList*); 2726 Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 2727 Token*, int, int); 2728 void sqlite3DropIndex(Parse*, SrcList*, int); 2729 int sqlite3Select(Parse*, Select*, SelectDest*); 2730 Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 2731 Expr*,ExprList*,int,Expr*,Expr*); 2732 void sqlite3SelectDelete(sqlite3*, Select*); 2733 Table *sqlite3SrcListLookup(Parse*, SrcList*); 2734 int sqlite3IsReadOnly(Parse*, Table*, int); 2735 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 2736 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 2737 Expr *sqlite3LimitWhere(Parse *, SrcList *, Expr *, ExprList *, Expr *, Expr *, char *); 2738 #endif 2739 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*); 2740 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int); 2741 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u16); 2742 void sqlite3WhereEnd(WhereInfo*); 2743 int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int); 2744 void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 2745 void sqlite3ExprCodeMove(Parse*, int, int, int); 2746 void sqlite3ExprCodeCopy(Parse*, int, int, int); 2747 void sqlite3ExprCacheStore(Parse*, int, int, int); 2748 void sqlite3ExprCachePush(Parse*); 2749 void sqlite3ExprCachePop(Parse*, int); 2750 void sqlite3ExprCacheRemove(Parse*, int, int); 2751 void sqlite3ExprCacheClear(Parse*); 2752 void sqlite3ExprCacheAffinityChange(Parse*, int, int); 2753 int sqlite3ExprCode(Parse*, Expr*, int); 2754 int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 2755 int sqlite3ExprCodeTarget(Parse*, Expr*, int); 2756 int sqlite3ExprCodeAndCache(Parse*, Expr*, int); 2757 void sqlite3ExprCodeConstants(Parse*, Expr*); 2758 int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int); 2759 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 2760 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 2761 Table *sqlite3FindTable(sqlite3*,const char*, const char*); 2762 Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*); 2763 Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 2764 void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 2765 void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 2766 void sqlite3Vacuum(Parse*); 2767 int sqlite3RunVacuum(char**, sqlite3*); 2768 char *sqlite3NameFromToken(sqlite3*, Token*); 2769 int sqlite3ExprCompare(Expr*, Expr*); 2770 int sqlite3ExprListCompare(ExprList*, ExprList*); 2771 void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 2772 void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 2773 Vdbe *sqlite3GetVdbe(Parse*); 2774 void sqlite3PrngSaveState(void); 2775 void sqlite3PrngRestoreState(void); 2776 void sqlite3PrngResetState(void); 2777 void sqlite3RollbackAll(sqlite3*); 2778 void sqlite3CodeVerifySchema(Parse*, int); 2779 void sqlite3BeginTransaction(Parse*, int); 2780 void sqlite3CommitTransaction(Parse*); 2781 void sqlite3RollbackTransaction(Parse*); 2782 void sqlite3Savepoint(Parse*, int, Token*); 2783 void sqlite3CloseSavepoints(sqlite3 *); 2784 int sqlite3ExprIsConstant(Expr*); 2785 int sqlite3ExprIsConstantNotJoin(Expr*); 2786 int sqlite3ExprIsConstantOrFunction(Expr*); 2787 int sqlite3ExprIsInteger(Expr*, int*); 2788 int sqlite3ExprCanBeNull(const Expr*); 2789 void sqlite3ExprCodeIsNullJump(Vdbe*, const Expr*, int, int); 2790 int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 2791 int sqlite3IsRowid(const char*); 2792 void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int, Trigger *, int); 2793 void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*); 2794 int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int); 2795 void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int, 2796 int*,int,int,int,int,int*); 2797 void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int); 2798 int sqlite3OpenTableAndIndices(Parse*, Table*, int, int); 2799 void sqlite3BeginWriteOperation(Parse*, int, int); 2800 void sqlite3MultiWrite(Parse*); 2801 void sqlite3MayAbort(Parse*); 2802 void sqlite3HaltConstraint(Parse*, int, char*, int); 2803 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 2804 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 2805 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 2806 IdList *sqlite3IdListDup(sqlite3*,IdList*); 2807 Select *sqlite3SelectDup(sqlite3*,Select*,int); 2808 void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*); 2809 FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int); 2810 void sqlite3RegisterBuiltinFunctions(sqlite3*); 2811 void sqlite3RegisterDateTimeFunctions(void); 2812 void sqlite3RegisterGlobalFunctions(void); 2813 int sqlite3SafetyCheckOk(sqlite3*); 2814 int sqlite3SafetyCheckSickOrOk(sqlite3*); 2815 void sqlite3ChangeCookie(Parse*, int); 2816 2817 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 2818 void sqlite3MaterializeView(Parse*, Table*, Expr*, int); 2819 #endif 2820 2821 #ifndef SQLITE_OMIT_TRIGGER 2822 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 2823 Expr*,int, int); 2824 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 2825 void sqlite3DropTrigger(Parse*, SrcList*, int); 2826 void sqlite3DropTriggerPtr(Parse*, Trigger*); 2827 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 2828 Trigger *sqlite3TriggerList(Parse *, Table *); 2829 void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 2830 int, int, int); 2831 void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 2832 void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 2833 void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 2834 TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*); 2835 TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*, 2836 ExprList*,Select*,u8); 2837 TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8); 2838 TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*); 2839 void sqlite3DeleteTrigger(sqlite3*, Trigger*); 2840 void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 2841 u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 2842 # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 2843 #else 2844 # define sqlite3TriggersExist(B,C,D,E,F) 0 2845 # define sqlite3DeleteTrigger(A,B) 2846 # define sqlite3DropTriggerPtr(A,B) 2847 # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 2848 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 2849 # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 2850 # define sqlite3TriggerList(X, Y) 0 2851 # define sqlite3ParseToplevel(p) p 2852 # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 2853 #endif 2854 2855 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 2856 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 2857 void sqlite3DeferForeignKey(Parse*, int); 2858 #ifndef SQLITE_OMIT_AUTHORIZATION 2859 void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 2860 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 2861 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 2862 void sqlite3AuthContextPop(AuthContext*); 2863 int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 2864 #else 2865 # define sqlite3AuthRead(a,b,c,d) 2866 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 2867 # define sqlite3AuthContextPush(a,b,c) 2868 # define sqlite3AuthContextPop(a) ((void)(a)) 2869 #endif 2870 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 2871 void sqlite3Detach(Parse*, Expr*); 2872 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 2873 int sqlite3FixSrcList(DbFixer*, SrcList*); 2874 int sqlite3FixSelect(DbFixer*, Select*); 2875 int sqlite3FixExpr(DbFixer*, Expr*); 2876 int sqlite3FixExprList(DbFixer*, ExprList*); 2877 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 2878 int sqlite3AtoF(const char *z, double*, int, u8); 2879 int sqlite3GetInt32(const char *, int*); 2880 int sqlite3Atoi(const char*); 2881 int sqlite3Utf16ByteLen(const void *pData, int nChar); 2882 int sqlite3Utf8CharLen(const char *pData, int nByte); 2883 int sqlite3Utf8Read(const u8*, const u8**); 2884 2885 #endif 2886 /* 2887 ** Routines to read and write variable-length integers. These used to 2888 ** be defined locally, but now we use the varint routines in the util.c 2889 ** file. Code should use the MACRO forms below, as the Varint32 versions 2890 ** are coded to assume the single byte case is already handled (which 2891 ** the MACRO form does). 2892 */ 2893 int sqlite3PutVarint(unsigned char*, u64); 2894 int sqlite3PutVarint32(unsigned char*, u32); 2895 u8 sqlite3GetVarint(const unsigned char *, u64 *); 2896 u8 sqlite3GetVarint32(const unsigned char *, u32 *); 2897 int sqlite3VarintLen(u64 v); 2898 2899 /* 2900 ** The header of a record consists of a sequence variable-length integers. 2901 ** These integers are almost always small and are encoded as a single byte. 2902 ** The following macros take advantage this fact to provide a fast encode 2903 ** and decode of the integers in a record header. It is faster for the common 2904 ** case where the integer is a single byte. It is a little slower when the 2905 ** integer is two or more bytes. But overall it is faster. 2906 ** 2907 ** The following expressions are equivalent: 2908 ** 2909 ** x = sqlite3GetVarint32( A, &B ); 2910 ** x = sqlite3PutVarint32( A, B ); 2911 ** 2912 ** x = getVarint32( A, B ); 2913 ** x = putVarint32( A, B ); 2914 ** 2915 */ 2916 #define getVarint32(A,B) (u8)((*(A)<(u8)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), (u32 *)&(B))) 2917 #define putVarint32(A,B) (u8)(((u32)(B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B))) 2918 #define getVarint sqlite3GetVarint 2919 #define putVarint sqlite3PutVarint 2920 2921 const char *sqlite3ErrStr(int); 2922 2923 #if 0 2924 2925 const char *sqlite3IndexAffinityStr(Vdbe *, Index *); 2926 void sqlite3TableAffinityStr(Vdbe *, Table *); 2927 char sqlite3CompareAffinity(Expr *pExpr, char aff2); 2928 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity); 2929 char sqlite3ExprAffinity(Expr *pExpr); 2930 int sqlite3Atoi64(const char*, i64*, int, u8); 2931 void sqlite3Error(sqlite3*, int, const char*,...); 2932 void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 2933 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 2934 int sqlite3ReadSchema(Parse *pParse); 2935 CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 2936 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 2937 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr); 2938 Expr *sqlite3ExprSetColl(Expr*, CollSeq*); 2939 Expr *sqlite3ExprSetCollByToken(Parse *pParse, Expr*, Token*); 2940 int sqlite3CheckCollSeq(Parse *, CollSeq *); 2941 int sqlite3CheckObjectName(Parse *, const char *); 2942 void sqlite3VdbeSetChanges(sqlite3 *, int); 2943 int sqlite3AddInt64(i64*,i64); 2944 int sqlite3SubInt64(i64*,i64); 2945 int sqlite3MulInt64(i64*,i64); 2946 int sqlite3AbsInt32(int); 2947 2948 const void *sqlite3ValueText(sqlite3_value*, u8); 2949 int sqlite3ValueBytes(sqlite3_value*, u8); 2950 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 2951 void(*)(void*)); 2952 void sqlite3ValueFree(sqlite3_value*); 2953 sqlite3_value *sqlite3ValueNew(sqlite3 *); 2954 char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 2955 #ifdef SQLITE_ENABLE_STAT2 2956 char *sqlite3Utf8to16(sqlite3 *, u8, char *, int, int *); 2957 #endif 2958 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 2959 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 2960 2961 #endif 2962 2963 #ifndef SQLITE_AMALGAMATION 2964 extern const unsigned char sqlite3OpcodeProperty[]; 2965 extern const unsigned char sqlite3UpperToLower[]; 2966 extern const unsigned char sqlite3CtypeMap[]; 2967 extern const Token sqlite3IntTokens[]; 2968 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 2969 extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions; 2970 #ifndef SQLITE_OMIT_WSD 2971 extern int sqlite3PendingByte; 2972 #endif 2973 #endif 2974 2975 #if 0 2976 2977 void sqlite3RootPageMoved(sqlite3*, int, int, int); 2978 void sqlite3Reindex(Parse*, Token*, Token*); 2979 void sqlite3AlterFunctions(void); 2980 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 2981 int sqlite3GetToken(const unsigned char *, int *); 2982 void sqlite3NestedParse(Parse*, const char*, ...); 2983 void sqlite3ExpirePreparedStatements(sqlite3*); 2984 int sqlite3CodeSubselect(Parse *, Expr *, int, int); 2985 void sqlite3SelectPrep(Parse*, Select*, NameContext*); 2986 int sqlite3ResolveExprNames(NameContext*, Expr*); 2987 void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 2988 int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 2989 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 2990 void sqlite3AlterFinishAddColumn(Parse *, Token *); 2991 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 2992 CollSeq *sqlite3GetCollSeq(sqlite3*, u8, CollSeq *, const char*); 2993 char sqlite3AffinityType(const char*); 2994 void sqlite3Analyze(Parse*, Token*, Token*); 2995 int sqlite3InvokeBusyHandler(BusyHandler*); 2996 int sqlite3FindDb(sqlite3*, Token*); 2997 int sqlite3FindDbName(sqlite3 *, const char *); 2998 int sqlite3AnalysisLoad(sqlite3*,int iDB); 2999 void sqlite3DeleteIndexSamples(sqlite3*,Index*); 3000 void sqlite3DefaultRowEst(Index*); 3001 void sqlite3RegisterLikeFunctions(sqlite3*, int); 3002 int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 3003 void sqlite3MinimumFileFormat(Parse*, int, int); 3004 void sqlite3SchemaClear(void *); 3005 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 3006 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 3007 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *); 3008 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 3009 void (*)(sqlite3_context*,int,sqlite3_value **), 3010 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*), 3011 FuncDestructor *pDestructor 3012 ); 3013 int sqlite3ApiExit(sqlite3 *db, int); 3014 int sqlite3OpenTempDatabase(Parse *); 3015 3016 void sqlite3StrAccumInit(StrAccum*, char*, int, int); 3017 void sqlite3StrAccumAppend(StrAccum*,const char*,int); 3018 char *sqlite3StrAccumFinish(StrAccum*); 3019 void sqlite3StrAccumReset(StrAccum*); 3020 void sqlite3SelectDestInit(SelectDest*,int,int); 3021 Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 3022 3023 void sqlite3BackupRestart(sqlite3_backup *); 3024 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 3025 3026 /* 3027 ** The interface to the LEMON-generated parser 3028 */ 3029 void *sqlite3ParserAlloc(void*(*)(size_t)); 3030 void sqlite3ParserFree(void*, void(*)(void*)); 3031 void sqlite3Parser(void*, int, Token, Parse*); 3032 #ifdef YYTRACKMAXSTACKDEPTH 3033 int sqlite3ParserStackPeak(void*); 3034 #endif 3035 3036 void sqlite3AutoLoadExtensions(sqlite3*); 3037 #ifndef SQLITE_OMIT_LOAD_EXTENSION 3038 void sqlite3CloseExtensions(sqlite3*); 3039 #else 3040 # define sqlite3CloseExtensions(X) 3041 #endif 3042 3043 #ifndef SQLITE_OMIT_SHARED_CACHE 3044 void sqlite3TableLock(Parse *, int, int, u8, const char *); 3045 #else 3046 #define sqlite3TableLock(v,w,x,y,z) 3047 #endif 3048 3049 #ifdef SQLITE_TEST 3050 int sqlite3Utf8To8(unsigned char*); 3051 #endif 3052 3053 #ifdef SQLITE_OMIT_VIRTUALTABLE 3054 # define sqlite3VtabClear(Y) 3055 # define sqlite3VtabSync(X,Y) SQLITE_OK 3056 # define sqlite3VtabRollback(X) 3057 # define sqlite3VtabCommit(X) 3058 # define sqlite3VtabInSync(db) 0 3059 # define sqlite3VtabLock(X) 3060 # define sqlite3VtabUnlock(X) 3061 # define sqlite3VtabUnlockList(X) 3062 #else 3063 void sqlite3VtabClear(sqlite3 *db, Table*); 3064 int sqlite3VtabSync(sqlite3 *db, char **); 3065 int sqlite3VtabRollback(sqlite3 *db); 3066 int sqlite3VtabCommit(sqlite3 *db); 3067 void sqlite3VtabLock(VTable *); 3068 void sqlite3VtabUnlock(VTable *); 3069 void sqlite3VtabUnlockList(sqlite3*); 3070 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 3071 #endif 3072 void sqlite3VtabMakeWritable(Parse*,Table*); 3073 void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*); 3074 void sqlite3VtabFinishParse(Parse*, Token*); 3075 void sqlite3VtabArgInit(Parse*); 3076 void sqlite3VtabArgExtend(Parse*, Token*); 3077 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 3078 int sqlite3VtabCallConnect(Parse*, Table*); 3079 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 3080 int sqlite3VtabBegin(sqlite3 *, VTable *); 3081 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 3082 void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**); 3083 int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 3084 int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 3085 int sqlite3Reprepare(Vdbe*); 3086 void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 3087 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *); 3088 int sqlite3TempInMemory(const sqlite3*); 3089 VTable *sqlite3GetVTable(sqlite3*, Table*); 3090 const char *sqlite3JournalModename(int); 3091 int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 3092 int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 3093 3094 /* Declarations for functions in fkey.c. All of these are replaced by 3095 ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 3096 ** key functionality is available. If OMIT_TRIGGER is defined but 3097 ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 3098 ** this case foreign keys are parsed, but no other functionality is 3099 ** provided (enforcement of FK constraints requires the triggers sub-system). 3100 */ 3101 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 3102 void sqlite3FkCheck(Parse*, Table*, int, int); 3103 void sqlite3FkDropTable(Parse*, SrcList *, Table*); 3104 void sqlite3FkActions(Parse*, Table*, ExprList*, int); 3105 int sqlite3FkRequired(Parse*, Table*, int*, int); 3106 u32 sqlite3FkOldmask(Parse*, Table*); 3107 FKey *sqlite3FkReferences(Table *); 3108 #else 3109 #define sqlite3FkActions(a,b,c,d) 3110 #define sqlite3FkCheck(a,b,c,d) 3111 #define sqlite3FkDropTable(a,b,c) 3112 #define sqlite3FkOldmask(a,b) 0 3113 #define sqlite3FkRequired(a,b,c,d) 0 3114 #endif 3115 #ifndef SQLITE_OMIT_FOREIGN_KEY 3116 void sqlite3FkDelete(sqlite3 *, Table*); 3117 #else 3118 #define sqlite3FkDelete(a,b) 3119 #endif 3120 3121 3122 /* 3123 ** Available fault injectors. Should be numbered beginning with 0. 3124 */ 3125 #define SQLITE_FAULTINJECTOR_MALLOC 0 3126 #define SQLITE_FAULTINJECTOR_COUNT 1 3127 3128 /* 3129 ** The interface to the code in fault.c used for identifying "benign" 3130 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST 3131 ** is not defined. 3132 */ 3133 #ifndef SQLITE_OMIT_BUILTIN_TEST 3134 void sqlite3BeginBenignMalloc(void); 3135 void sqlite3EndBenignMalloc(void); 3136 #else 3137 #define sqlite3BeginBenignMalloc() 3138 #define sqlite3EndBenignMalloc() 3139 #endif 3140 3141 #define IN_INDEX_ROWID 1 3142 #define IN_INDEX_EPH 2 3143 #define IN_INDEX_INDEX 3 3144 int sqlite3FindInIndex(Parse *, Expr *, int*); 3145 3146 #ifdef SQLITE_ENABLE_ATOMIC_WRITE 3147 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 3148 int sqlite3JournalSize(sqlite3_vfs *); 3149 int sqlite3JournalCreate(sqlite3_file *); 3150 #else 3151 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile) 3152 #endif 3153 3154 void sqlite3MemJournalOpen(sqlite3_file *); 3155 int sqlite3MemJournalSize(void); 3156 int sqlite3IsMemJournal(sqlite3_file *); 3157 3158 #if SQLITE_MAX_EXPR_DEPTH>0 3159 void sqlite3ExprSetHeight(Parse *pParse, Expr *p); 3160 int sqlite3SelectExprHeight(Select *); 3161 int sqlite3ExprCheckHeight(Parse*, int); 3162 #else 3163 #define sqlite3ExprSetHeight(x,y) 3164 #define sqlite3SelectExprHeight(x) 0 3165 #define sqlite3ExprCheckHeight(x,y) 3166 #endif 3167 3168 u32 sqlite3Get4byte(const u8*); 3169 void sqlite3Put4byte(u8*, u32); 3170 3171 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 3172 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 3173 void sqlite3ConnectionUnlocked(sqlite3 *db); 3174 void sqlite3ConnectionClosed(sqlite3 *db); 3175 #else 3176 #define sqlite3ConnectionBlocked(x,y) 3177 #define sqlite3ConnectionUnlocked(x) 3178 #define sqlite3ConnectionClosed(x) 3179 #endif 3180 3181 #ifdef SQLITE_DEBUG 3182 void sqlite3ParserTrace(FILE*, char *); 3183 #endif 3184 3185 /* 3186 ** If the SQLITE_ENABLE IOTRACE exists then the global variable 3187 ** sqlite3IoTrace is a pointer to a printf-like routine used to 3188 ** print I/O tracing messages. 3189 */ 3190 #ifdef SQLITE_ENABLE_IOTRACE 3191 # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 3192 void sqlite3VdbeIOTraceSql(Vdbe*); 3193 SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...); 3194 #else 3195 # define IOTRACE(A) 3196 # define sqlite3VdbeIOTraceSql(X) 3197 #endif 3198 3199 /* 3200 ** These routines are available for the mem2.c debugging memory allocator 3201 ** only. They are used to verify that different "types" of memory 3202 ** allocations are properly tracked by the system. 3203 ** 3204 ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 3205 ** the MEMTYPE_* macros defined below. The type must be a bitmask with 3206 ** a single bit set. 3207 ** 3208 ** sqlite3MemdebugHasType() returns true if any of the bits in its second 3209 ** argument match the type set by the previous sqlite3MemdebugSetType(). 3210 ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 3211 ** 3212 ** sqlite3MemdebugNoType() returns true if none of the bits in its second 3213 ** argument match the type set by the previous sqlite3MemdebugSetType(). 3214 ** 3215 ** Perhaps the most important point is the difference between MEMTYPE_HEAP 3216 ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 3217 ** it might have been allocated by lookaside, except the allocation was 3218 ** too large or lookaside was already full. It is important to verify 3219 ** that allocations that might have been satisfied by lookaside are not 3220 ** passed back to non-lookaside free() routines. Asserts such as the 3221 ** example above are placed on the non-lookaside free() routines to verify 3222 ** this constraint. 3223 ** 3224 ** All of this is no-op for a production build. It only comes into 3225 ** play when the SQLITE_MEMDEBUG compile-time option is used. 3226 */ 3227 #ifdef SQLITE_MEMDEBUG 3228 void sqlite3MemdebugSetType(void*,u8); 3229 int sqlite3MemdebugHasType(void*,u8); 3230 int sqlite3MemdebugNoType(void*,u8); 3231 #else 3232 # define sqlite3MemdebugSetType(X,Y) /* no-op */ 3233 # define sqlite3MemdebugHasType(X,Y) 1 3234 # define sqlite3MemdebugNoType(X,Y) 1 3235 #endif 3236 #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 3237 #define MEMTYPE_LOOKASIDE 0x02 /* Might have been lookaside memory */ 3238 #define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */ 3239 #define MEMTYPE_PCACHE 0x08 /* Page cache allocations */ 3240 #define MEMTYPE_DB 0x10 /* Uses sqlite3DbMalloc, not sqlite_malloc */ 3241 3242 #endif 3243 3244 // Mem definition is copied here so they can be allocated outside of SQLite code, though they 3245 // are currently only manipulated using SQLite functions. 3246 typedef struct VdbeFrame VdbeFrame; 3247 struct Mem { 3248 sqlite3 *db; /* The associated database connection */ 3249 char *z; /* String or BLOB value */ 3250 double r; /* Real value */ 3251 union { 3252 i64 i; /* Integer value used when MEM_Int is set in flags */ 3253 int nZero; /* Used when bit MEM_Zero is set in flags */ 3254 FuncDef *pDef; /* Used only when flags==MEM_Agg */ 3255 RowSet *pRowSet; /* Used only when flags==MEM_RowSet */ 3256 VdbeFrame *pFrame; /* Used when flags==MEM_Frame */ 3257 } u; 3258 int n; /* Number of characters in string value, excluding '\0' */ 3259 u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */ 3260 u8 type; /* One of SQLITE_NULL, SQLITE_TEXT, SQLITE_INTEGER, etc */ 3261 u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */ 3262 #ifdef SQLITE_DEBUG 3263 Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */ 3264 void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */ 3265 #endif 3266 void (*xDel)(void *); /* If not null, call this function to delete Mem.z */ 3267 char *zMalloc; /* Dynamic buffer allocated by sqlite3_malloc() */ 3268 }; 3269 3270 #endif /* _SQLITEINT_H_ */ 3271