175897234Sdrh /* 2b19a2bc6Sdrh ** 2001 September 15 375897234Sdrh ** 4b19a2bc6Sdrh ** The author disclaims copyright to this source code. In place of 5b19a2bc6Sdrh ** a legal notice, here is a blessing: 675897234Sdrh ** 7b19a2bc6Sdrh ** May you do good and not evil. 8b19a2bc6Sdrh ** May you find forgiveness for yourself and forgive others. 9b19a2bc6Sdrh ** May you share freely, never taking more than you give. 1075897234Sdrh ** 1175897234Sdrh ************************************************************************* 1275897234Sdrh ** Internal interface definitions for SQLite. 1375897234Sdrh ** 14*a9671a22Sdrh ** @(#) $Id: sqliteInt.h,v 1.738 2008/07/08 23:40:20 drh Exp $ 1575897234Sdrh */ 16e3026636Sdanielk1977 #ifndef _SQLITEINT_H_ 17e3026636Sdanielk1977 #define _SQLITEINT_H_ 1871674ce9Sdrh 19bd0ae111Smlcreech /* 201e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the 211e12d43bSmlcreech ** autoconf-based build 22bd0ae111Smlcreech */ 231e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H 2498dc4b1aSmlcreech #include "config.h" 251e12d43bSmlcreech #endif 261e12d43bSmlcreech 27bb4957f8Sdrh #include "sqliteLimit.h" 2898dc4b1aSmlcreech 29e2965827Sdrh /* Disable nuisance warnings on Borland compilers */ 30e2965827Sdrh #if defined(__BORLANDC__) 31e2965827Sdrh #pragma warn -rch /* unreachable code */ 32e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */ 33e2965827Sdrh #pragma warn -aus /* Assigned value is never used */ 34e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */ 35e2965827Sdrh #pragma warn -spa /* Suspicous pointer arithmetic */ 36e2965827Sdrh #endif 37e2965827Sdrh 3898dc4b1aSmlcreech /* Needed for various definitions... */ 3998dc4b1aSmlcreech #define _GNU_SOURCE 4098dc4b1aSmlcreech 4198dc4b1aSmlcreech /* 4206af763eSdrh ** Include standard header files as necessary 4306af763eSdrh */ 4406af763eSdrh #ifdef HAVE_STDINT_H 4506af763eSdrh #include <stdint.h> 4606af763eSdrh #endif 4706af763eSdrh #ifdef HAVE_INTTYPES_H 4806af763eSdrh #include <inttypes.h> 4906af763eSdrh #endif 5006af763eSdrh 5106af763eSdrh /* 52c5499befSdrh ** A macro used to aid in coverage testing. When doing coverage 53c5499befSdrh ** testing, the condition inside the argument must be evaluated 54c5499befSdrh ** both true and false in order to get full branch coverage. 55c5499befSdrh ** This macro can be inserted to ensure adequate test coverage 56c5499befSdrh ** in places where simple condition/decision coverage is inadequate. 57c5499befSdrh */ 58c5499befSdrh #ifdef SQLITE_COVERAGE_TEST 59c5499befSdrh void sqlite3Coverage(int); 60c5499befSdrh # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 61c5499befSdrh #else 62c5499befSdrh # define testcase(X) 63c5499befSdrh #endif 64c5499befSdrh 6598dc4b1aSmlcreech 6671674ce9Sdrh /* 67b6dbc000Sdrh ** The macro unlikely() is a hint that surrounds a boolean 68b6dbc000Sdrh ** expression that is usually false. Macro likely() surrounds 69b6dbc000Sdrh ** a boolean expression that is usually true. GCC is able to 70b6dbc000Sdrh ** use these hints to generate better code, sometimes. 71b6dbc000Sdrh */ 724bbf464fSdrh #if defined(__GNUC__) && 0 73b6dbc000Sdrh # define likely(X) __builtin_expect((X),1) 74b6dbc000Sdrh # define unlikely(X) __builtin_expect((X),0) 75b6dbc000Sdrh #else 76b6dbc000Sdrh # define likely(X) !!(X) 77b6dbc000Sdrh # define unlikely(X) !!(X) 78b6dbc000Sdrh #endif 79b6dbc000Sdrh 801fc4129dSshane /* 811fc4129dSshane * This macro is used to "hide" some ugliness in casting an int 821fc4129dSshane * value to a ptr value under the MSVC 64-bit compiler. Casting 831fc4129dSshane * non 64-bit values to ptr types results in a "hard" error with 841fc4129dSshane * the MSVC 64-bit compiler which this attempts to avoid. 851fc4129dSshane * 861fc4129dSshane * A simple compiler pragma or casting sequence could not be found 871fc4129dSshane * to correct this in all situations, so this macro was introduced. 881fc4129dSshane * 891fc4129dSshane * It could be argued that the intptr_t type could be used in this 901fc4129dSshane * case, but that type is not available on all compilers, or 911fc4129dSshane * requires the #include of specific headers which differs between 921fc4129dSshane * platforms. 931fc4129dSshane */ 941fc4129dSshane #define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 951fc4129dSshane #define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 96b6dbc000Sdrh 97b6dbc000Sdrh /* 9871674ce9Sdrh ** These #defines should enable >2GB file support on Posix if the 9971674ce9Sdrh ** underlying operating system supports it. If the OS lacks 10071674ce9Sdrh ** large file support, or if the OS is windows, these should be no-ops. 10171674ce9Sdrh ** 10271674ce9Sdrh ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 10371674ce9Sdrh ** system #includes. Hence, this block of code must be the very first 10471674ce9Sdrh ** code in all source files. 10571674ce9Sdrh ** 10671674ce9Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 10771674ce9Sdrh ** on the compiler command line. This is necessary if you are compiling 10871674ce9Sdrh ** on a recent machine (ex: RedHat 7.2) but you want your code to work 10971674ce9Sdrh ** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2 11071674ce9Sdrh ** without this option, LFS is enable. But LFS does not exist in the kernel 11171674ce9Sdrh ** in RedHat 6.0, so the code won't work. Hence, for maximum binary 11271674ce9Sdrh ** portability you should omit LFS. 11371674ce9Sdrh ** 11471674ce9Sdrh ** Similar is true for MacOS. LFS is only supported on MacOS 9 and later. 11571674ce9Sdrh */ 11671674ce9Sdrh #ifndef SQLITE_DISABLE_LFS 11771674ce9Sdrh # define _LARGE_FILE 1 11871674ce9Sdrh # ifndef _FILE_OFFSET_BITS 11971674ce9Sdrh # define _FILE_OFFSET_BITS 64 12071674ce9Sdrh # endif 12171674ce9Sdrh # define _LARGEFILE_SOURCE 1 12271674ce9Sdrh #endif 12371674ce9Sdrh 12471674ce9Sdrh 125e5e7a901Sdrh /* 126e5e7a901Sdrh ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1. 127e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro. 128e5e7a901Sdrh ** We support that for legacy 129e5e7a901Sdrh */ 130e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE) 131e5e7a901Sdrh #if defined(THREADSAFE) 132e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE 133e5e7a901Sdrh #else 134e5e7a901Sdrh # define SQLITE_THREADSAFE 1 135e5e7a901Sdrh #endif 136e5e7a901Sdrh #endif 137e5e7a901Sdrh 13867080617Sdrh /* 1390d18020bSdrh ** Exactly one of the following macros must be defined in order to 1400d18020bSdrh ** specify which memory allocation subsystem to use. 1410d18020bSdrh ** 1420d18020bSdrh ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 1430d18020bSdrh ** SQLITE_MEMDEBUG // Debugging version of system malloc() 1440d18020bSdrh ** SQLITE_MEMORY_SIZE // internal allocator #1 1450d18020bSdrh ** SQLITE_MMAP_HEAP_SIZE // internal mmap() allocator 1460d18020bSdrh ** SQLITE_POW2_MEMORY_SIZE // internal power-of-two allocator 1470d18020bSdrh ** 1480d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 1490d18020bSdrh ** the default. 1500d18020bSdrh */ 1510d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\ 1520d18020bSdrh defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\ 1530d18020bSdrh defined(SQLITE_POW2_MEMORY_SIZE)>1 1540d18020bSdrh # error "At most one of the following compile-time configuration options\ 1550d18020bSdrh is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\ 1560d18020bSdrh SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE" 1570d18020bSdrh #endif 1580d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\ 1590d18020bSdrh defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\ 1600d18020bSdrh defined(SQLITE_POW2_MEMORY_SIZE)==0 1610d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1 1620d18020bSdrh #endif 1630d18020bSdrh 1640d18020bSdrh /* 165eee4c8caSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the 166eee4c8caSdrh ** sizes of memory allocations below this value where possible. 167eee4c8caSdrh */ 168eee4c8caSdrh #if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT) 169eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024 170eee4c8caSdrh #endif 171eee4c8caSdrh 172eee4c8caSdrh /* 17367080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable 17467080617Sdrh ** recursive mutexes on most unix systems. But Mac OS X is different. 17567080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told, 17667080617Sdrh ** so it is omitted there. See ticket #2673. 177e5e7a901Sdrh ** 178e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly 179e5e7a901Sdrh ** implemented on some systems. So we avoid defining it at all 180e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are 181e5e7a901Sdrh ** not doing a threadsafe build. Ticket #2681. 1829e0ebbfaSdrh ** 1839e0ebbfaSdrh ** See also ticket #2741. 18467080617Sdrh */ 185ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE 186058897a9Sdrh # define _XOPEN_SOURCE 500 /* Needed to enable pthread recursive mutexes */ 18767080617Sdrh #endif 188e3026636Sdanielk1977 1894f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH) 1904f0c5878Sdrh # include <tcl.h> 191824d7c18Sdrh #endif 192824d7c18Sdrh 193824d7c18Sdrh /* 1944b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite. 195b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster. So the following 1964b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1 1974b529d97Sdrh ** option is set. Thus NDEBUG becomes an opt-in rather than an opt-out 1984b529d97Sdrh ** feature. 1994b529d97Sdrh */ 200289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 2014b529d97Sdrh # define NDEBUG 1 2024b529d97Sdrh #endif 2034b529d97Sdrh 2041d482dd9Sdrh #include "sqlite3.h" 205beae3194Sdrh #include "hash.h" 20675897234Sdrh #include "parse.h" 20775897234Sdrh #include <stdio.h> 20875897234Sdrh #include <stdlib.h> 20975897234Sdrh #include <string.h> 21075897234Sdrh #include <assert.h> 21152370e2cSdrh #include <stddef.h> 21275897234Sdrh 213967e8b73Sdrh /* 214b37df7b9Sdrh ** If compiling for a processor that lacks floating point support, 215b37df7b9Sdrh ** substitute integer for floating-point 216b37df7b9Sdrh */ 217b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT 218b37df7b9Sdrh # define double sqlite_int64 219b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64 220d1167393Sdrh # ifndef SQLITE_BIG_DBL 221b37df7b9Sdrh # define SQLITE_BIG_DBL (0x7fffffffffffffff) 222d1167393Sdrh # endif 223b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1 224b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1 225110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 226b37df7b9Sdrh #endif 227d1167393Sdrh #ifndef SQLITE_BIG_DBL 228d1167393Sdrh # define SQLITE_BIG_DBL (1e99) 229d1167393Sdrh #endif 230b37df7b9Sdrh 231b37df7b9Sdrh /* 23253c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 23353c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler 23453c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements. 23553c0f748Sdanielk1977 */ 23653c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB 23753c0f748Sdanielk1977 #define OMIT_TEMPDB 1 23853c0f748Sdanielk1977 #else 23953c0f748Sdanielk1977 #define OMIT_TEMPDB 0 24053c0f748Sdanielk1977 #endif 24153c0f748Sdanielk1977 24253c0f748Sdanielk1977 /* 2430bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered 2440bd1f4eaSdrh ** distinct when determining whether or not two entries are the same 2450bd1f4eaSdrh ** in a UNIQUE index. This is the way PostgreSQL, Oracle, DB2, MySQL, 2460bd1f4eaSdrh ** OCELOT, and Firebird all work. The SQL92 spec explicitly says this 2470bd1f4eaSdrh ** is the way things are suppose to work. 2480bd1f4eaSdrh ** 2490bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for 2500bd1f4eaSdrh ** a UNIQUE index. In this mode, you can only have a single NULL entry 2510bd1f4eaSdrh ** for a column declared UNIQUE. This is the way Informix and SQL Server 2520bd1f4eaSdrh ** work. 2530bd1f4eaSdrh */ 2540bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1 2550bd1f4eaSdrh 2560bd1f4eaSdrh /* 257d946db00Sdrh ** The "file format" number is an integer that is incremented whenever 258d946db00Sdrh ** the VDBE-level file format changes. The following macros define the 259d946db00Sdrh ** the default file format for new databases and the maximum file format 260d946db00Sdrh ** that the library can read. 261d946db00Sdrh */ 262d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4 263d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT 26476fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1 265d946db00Sdrh #endif 266d946db00Sdrh 267d946db00Sdrh /* 268b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 26949766d6cSdrh ** on the command-line 27049766d6cSdrh */ 271b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE 272b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1 27349766d6cSdrh #endif 27449766d6cSdrh 27549766d6cSdrh /* 276f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it 277f1974846Sdrh ** ourselves. 278f1974846Sdrh */ 279f1974846Sdrh #ifndef offsetof 280f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 281f1974846Sdrh #endif 282f1974846Sdrh 283f1974846Sdrh /* 2849b8f447bSdrh ** Check to see if this machine uses EBCDIC. (Yes, believe it or 2859b8f447bSdrh ** not, there are still machines out there that use EBCDIC.) 2869b8f447bSdrh */ 2879b8f447bSdrh #if 'A' == '\301' 2889b8f447bSdrh # define SQLITE_EBCDIC 1 2899b8f447bSdrh #else 2909b8f447bSdrh # define SQLITE_ASCII 1 2919b8f447bSdrh #endif 2929b8f447bSdrh 2939b8f447bSdrh /* 2945a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 2955a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 2965a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 2975a2c2c20Sdrh ** 2985a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 29941a2b48bSdrh */ 3005a2c2c20Sdrh #ifndef UINT32_TYPE 301dda5b68cSmlcreech # ifdef HAVE_UINT32_T 302dda5b68cSmlcreech # define UINT32_TYPE uint32_t 303dda5b68cSmlcreech # else 3045a2c2c20Sdrh # define UINT32_TYPE unsigned int 3055a2c2c20Sdrh # endif 306dda5b68cSmlcreech #endif 3075a2c2c20Sdrh #ifndef UINT16_TYPE 308dda5b68cSmlcreech # ifdef HAVE_UINT16_T 309dda5b68cSmlcreech # define UINT16_TYPE uint16_t 310dda5b68cSmlcreech # else 3115a2c2c20Sdrh # define UINT16_TYPE unsigned short int 3125a2c2c20Sdrh # endif 313dda5b68cSmlcreech #endif 314939a16d6Sdrh #ifndef INT16_TYPE 315dda5b68cSmlcreech # ifdef HAVE_INT16_T 316dda5b68cSmlcreech # define INT16_TYPE int16_t 317dda5b68cSmlcreech # else 318939a16d6Sdrh # define INT16_TYPE short int 319939a16d6Sdrh # endif 320dda5b68cSmlcreech #endif 3215a2c2c20Sdrh #ifndef UINT8_TYPE 322dda5b68cSmlcreech # ifdef HAVE_UINT8_T 323dda5b68cSmlcreech # define UINT8_TYPE uint8_t 324dda5b68cSmlcreech # else 3255a2c2c20Sdrh # define UINT8_TYPE unsigned char 3265a2c2c20Sdrh # endif 327dda5b68cSmlcreech #endif 328905793e2Sdrh #ifndef INT8_TYPE 329dda5b68cSmlcreech # ifdef HAVE_INT8_T 330dda5b68cSmlcreech # define INT8_TYPE int8_t 331dda5b68cSmlcreech # else 332905793e2Sdrh # define INT8_TYPE signed char 333905793e2Sdrh # endif 334dda5b68cSmlcreech #endif 335efad9995Sdrh #ifndef LONGDOUBLE_TYPE 336efad9995Sdrh # define LONGDOUBLE_TYPE long double 337efad9995Sdrh #endif 338efad9995Sdrh typedef sqlite_int64 i64; /* 8-byte signed integer */ 33927436af7Sdrh typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 3405a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 3415a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 342939a16d6Sdrh typedef INT16_TYPE i16; /* 2-byte signed integer */ 3435a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 344905793e2Sdrh typedef UINT8_TYPE i8; /* 1-byte signed integer */ 3455a2c2c20Sdrh 3465a2c2c20Sdrh /* 347bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian, 348bbd42a6dSdrh ** evaluated at runtime. 349bbd42a6dSdrh */ 35046c99e0fSdrh #ifdef SQLITE_AMALGAMATION 3517ff4a45eSmlcreech const int sqlite3one; 35246c99e0fSdrh #else 353bbd42a6dSdrh extern const int sqlite3one; 35446c99e0fSdrh #endif 35538def054Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86) 35638def054Sdrh # define SQLITE_BIGENDIAN 0 35738def054Sdrh # define SQLITE_LITTLEENDIAN 1 35838def054Sdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 35938def054Sdrh #else 3609c054830Sdrh # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 3619c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 36238def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 36338def054Sdrh #endif 364bbd42a6dSdrh 365bbd42a6dSdrh /* 3660f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers. 3670f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit 3680f050353Sdrh ** compilers. 3690f050353Sdrh */ 3700f050353Sdrh #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 3710f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 3720f050353Sdrh 3730f050353Sdrh /* 37490f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler 37590f5ecb3Sdrh ** callback for a given sqlite handle. 37690f5ecb3Sdrh ** 37790f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy 37890f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite 37990f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 38090f5ecb3Sdrh ** callback is currently invoked only from within pager.c. 38190f5ecb3Sdrh */ 38290f5ecb3Sdrh typedef struct BusyHandler BusyHandler; 38390f5ecb3Sdrh struct BusyHandler { 38490f5ecb3Sdrh int (*xFunc)(void *,int); /* The busy callback */ 38590f5ecb3Sdrh void *pArg; /* First arg to busy callback */ 386a4afb65cSdrh int nBusy; /* Incremented with each busy call */ 38790f5ecb3Sdrh }; 38890f5ecb3Sdrh 38990f5ecb3Sdrh /* 39075897234Sdrh ** Name of the master database table. The master database table 39175897234Sdrh ** is a special table that holds the names and attributes of all 39275897234Sdrh ** user tables and indices. 39375897234Sdrh */ 39475897234Sdrh #define MASTER_NAME "sqlite_master" 395e0bc4048Sdrh #define TEMP_MASTER_NAME "sqlite_temp_master" 39675897234Sdrh 39775897234Sdrh /* 3988e150818Sdanielk1977 ** The root-page of the master database table. 3998e150818Sdanielk1977 */ 4008e150818Sdanielk1977 #define MASTER_ROOT 1 4018e150818Sdanielk1977 4028e150818Sdanielk1977 /* 403ed6c8671Sdrh ** The name of the schema table. 404ed6c8671Sdrh */ 40553c0f748Sdanielk1977 #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME) 406ed6c8671Sdrh 407ed6c8671Sdrh /* 40875897234Sdrh ** A convenience macro that returns the number of elements in 40975897234Sdrh ** an array. 41075897234Sdrh */ 41175897234Sdrh #define ArraySize(X) (sizeof(X)/sizeof(X[0])) 41275897234Sdrh 41375897234Sdrh /* 41475897234Sdrh ** Forward references to structures 41575897234Sdrh */ 41613449892Sdrh typedef struct AggInfo AggInfo; 417fe05af87Sdrh typedef struct AuthContext AuthContext; 418f5e7bb51Sdrh typedef struct Bitvec Bitvec; 419fe05af87Sdrh typedef struct CollSeq CollSeq; 4207020f651Sdrh typedef struct Column Column; 421fe05af87Sdrh typedef struct Db Db; 422e501b89aSdanielk1977 typedef struct Schema Schema; 42375897234Sdrh typedef struct Expr Expr; 42475897234Sdrh typedef struct ExprList ExprList; 425c2eef3b3Sdrh typedef struct FKey FKey; 426fe05af87Sdrh typedef struct FuncDef FuncDef; 427fe05af87Sdrh typedef struct IdList IdList; 428fe05af87Sdrh typedef struct Index Index; 4298d059845Sdanielk1977 typedef struct KeyClass KeyClass; 430d3d39e93Sdrh typedef struct KeyInfo KeyInfo; 431d1ab1ba5Sdanielk1977 typedef struct Module Module; 432626a879aSdrh typedef struct NameContext NameContext; 433fe05af87Sdrh typedef struct Parse Parse; 434fe05af87Sdrh typedef struct Select Select; 435fe05af87Sdrh typedef struct SrcList SrcList; 436ade86483Sdrh typedef struct StrAccum StrAccum; 437fe05af87Sdrh typedef struct Table Table; 438c00da105Sdanielk1977 typedef struct TableLock TableLock; 439fe05af87Sdrh typedef struct Token Token; 440fe05af87Sdrh typedef struct TriggerStack TriggerStack; 441fe05af87Sdrh typedef struct TriggerStep TriggerStep; 442fe05af87Sdrh typedef struct Trigger Trigger; 443fe05af87Sdrh typedef struct WhereInfo WhereInfo; 444fe05af87Sdrh typedef struct WhereLevel WhereLevel; 445d3d39e93Sdrh 4462dca4ac1Sdanielk1977 /* 4472dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 4482dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 4492dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above. 4502dca4ac1Sdanielk1977 */ 4512dca4ac1Sdanielk1977 #include "btree.h" 4522dca4ac1Sdanielk1977 #include "vdbe.h" 4532dca4ac1Sdanielk1977 #include "pager.h" 4542dca4ac1Sdanielk1977 4551cc5ed81Sdanielk1977 #include "os.h" 456c7ce76afSdrh #include "mutex.h" 4571cc5ed81Sdanielk1977 458eee4c8caSdrh 459001bbcbbSdrh /* 460001bbcbbSdrh ** Each database file to be accessed by the system is an instance 461001bbcbbSdrh ** of the following structure. There are normally two of these structures 462001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 463a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 464a69d9168Sdrh ** databases may be attached. 465001bbcbbSdrh */ 466001bbcbbSdrh struct Db { 467001bbcbbSdrh char *zName; /* Name of this database */ 468001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 469da184236Sdanielk1977 u8 inTrans; /* 0: not writable. 1: Transaction. 2: Checkpoint */ 470da184236Sdanielk1977 u8 safety_level; /* How aggressive at synching data to disk */ 471da184236Sdanielk1977 void *pAux; /* Auxiliary data. Usually NULL */ 472da184236Sdanielk1977 void (*xFreeAux)(void*); /* Routine to free pAux */ 473e501b89aSdanielk1977 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 474da184236Sdanielk1977 }; 475da184236Sdanielk1977 476da184236Sdanielk1977 /* 477da184236Sdanielk1977 ** An instance of the following structure stores a database schema. 478a04a34ffSdanielk1977 ** 479a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the 480a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table 481a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection 482a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been 483a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated, 484a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare 485a04a34ffSdanielk1977 ** statements. 486da184236Sdanielk1977 */ 487e501b89aSdanielk1977 struct Schema { 488001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 489d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 490d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 491d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 492d24cc427Sdrh Hash aFKey; /* Foreign keys indexed by to-table */ 4934794f735Sdrh Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 494da184236Sdanielk1977 u8 file_format; /* Schema format version for this file */ 4958079a0d3Sdrh u8 enc; /* Text encoding used by this database */ 496da184236Sdanielk1977 u16 flags; /* Flags associated with this schema */ 49714db2665Sdanielk1977 int cache_size; /* Number of pages to use in the cache */ 498a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE 499a04a34ffSdanielk1977 sqlite3 *db; /* "Owner" connection. See comment above */ 500a04a34ffSdanielk1977 #endif 501001bbcbbSdrh }; 50275897234Sdrh 50375897234Sdrh /* 5048bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 5058bf8dc92Sdrh ** Db.flags field. 5068bf8dc92Sdrh */ 507da184236Sdanielk1977 #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))==(P)) 508da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->flags&(P))!=0) 509da184236Sdanielk1977 #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->flags|=(P) 510da184236Sdanielk1977 #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->flags&=~(P) 5118bf8dc92Sdrh 5128bf8dc92Sdrh /* 5138bf8dc92Sdrh ** Allowed values for the DB.flags field. 5148bf8dc92Sdrh ** 5158bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 5168bf8dc92Sdrh ** read into internal hash tables. 5178bf8dc92Sdrh ** 5188bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 5198bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 5208bf8dc92Sdrh ** changes and so the view will need to be reset. 5218bf8dc92Sdrh */ 522124b27e6Sdrh #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 523124b27e6Sdrh #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 524b82e7edaSdanielk1977 #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */ 5258bf8dc92Sdrh 526caa639f4Sdrh /* 527caa639f4Sdrh ** The number of different kinds of things that can be limited 528caa639f4Sdrh ** using the sqlite3_limit() interface. 529caa639f4Sdrh */ 530caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1) 5318bf8dc92Sdrh 5328bf8dc92Sdrh /* 533c9b84a1fSdrh ** Each database is an instance of the following structure. 534c9b84a1fSdrh ** 535b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an 536b0c374ffSrdc ** insert statement. Inserts on views do not affect its value. Each 537b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside 538b0c374ffSrdc ** triggers as usual. The previous value will be restored once the trigger 539b0c374ffSrdc ** exits. Upon entering a before or instead of trigger, lastRowid is no 540b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1. 541b0c374ffSrdc ** 542b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no 5436f8a503dSdanielk1977 ** context. It is reset at start of sqlite3_exec. 544b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last 545b0c374ffSrdc ** insert, update, or delete statement. It remains constant throughout the 546b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts. It keeps a 547b0c374ffSrdc ** context stack just like lastRowid so that the count of changes 548b0c374ffSrdc ** within a trigger is not seen outside the trigger. Changes to views do not 549b0c374ffSrdc ** affect the value of lsChange. 550b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since 551b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange. 5526622cce3Sdanielk1977 ** 5536622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16 5546622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The 5556622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables 5566622cce3Sdanielk1977 ** consistently. 55775897234Sdrh */ 5589bb575fdSdrh struct sqlite3 { 55990f6a5beSdrh sqlite3_vfs *pVfs; /* OS Interface */ 560001bbcbbSdrh int nDb; /* Number of backends currently in use */ 561001bbcbbSdrh Db *aDb; /* All backends */ 5628c82b350Sdrh int flags; /* Miscellanous flags. See below */ 56333f4e02aSdrh int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 564fcd35c7bSdrh int errCode; /* Most recent error code (SQLITE_*) */ 5654ac285a1Sdrh int errMask; /* & result codes with this before returning */ 566fcd35c7bSdrh u8 autoCommit; /* The auto-commit flag. */ 56790f5ecb3Sdrh u8 temp_store; /* 1: file 2: memory 0: default */ 56817435752Sdrh u8 mallocFailed; /* True if we have seen a malloc failure */ 5693b02013eSdrh u8 dfltLockMode; /* Default locking-mode for attached dbs */ 5703b02013eSdrh u8 dfltJournalMode; /* Default journal mode for attached dbs */ 57198757157Sdrh signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 572f653d782Sdanielk1977 int nextPagesize; /* Pagesize after VACUUM if >0 */ 5732803757aSdrh int nTable; /* Number of tables in the database */ 574d3d39e93Sdrh CollSeq *pDfltColl; /* The default collating sequence (BINARY) */ 575f328bc80Sdrh i64 lastRowid; /* ROWID of most recent insert (see above) */ 576f328bc80Sdrh i64 priorNewRowid; /* Last randomly generated ROWID */ 577247be43dSdrh int magic; /* Magic number for detect library misuse */ 578b28af71aSdanielk1977 int nChange; /* Value returned by sqlite3_changes() */ 579b28af71aSdanielk1977 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 580d677b3d6Sdrh sqlite3_mutex *mutex; /* Connection mutex */ 581caa639f4Sdrh int aLimit[SQLITE_N_LIMIT]; /* Limits */ 5824adee20fSdanielk1977 struct sqlite3InitInfo { /* Information used during initialization */ 5831d85d931Sdrh int iDb; /* When back is being initialized */ 5841d85d931Sdrh int newTnum; /* Rootpage of table being initialized */ 5851d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 5861d85d931Sdrh } init; 587f1952c5dSdrh int nExtension; /* Number of loaded extensions */ 588761df87eSdrh void **aExtension; /* Array of shared libraray handles */ 589326dce74Sdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 5901d850a72Sdanielk1977 int activeVdbeCnt; /* Number of vdbes currently executing */ 59118de4824Sdrh void (*xTrace)(void*,const char*); /* Trace function */ 59218de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 59319e2d37fSdrh void (*xProfile)(void*,const char*,u64); /* Profiling function */ 59419e2d37fSdrh void *pProfileArg; /* Argument to profile function */ 595fcd35c7bSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 596fcd35c7bSdrh int (*xCommitCallback)(void*); /* Invoked at every commit. */ 59771fd80bfSdanielk1977 void *pRollbackArg; /* Argument to xRollbackCallback() */ 59871fd80bfSdanielk1977 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 59994eb6a14Sdanielk1977 void *pUpdateArg; 60094eb6a14Sdanielk1977 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 601fcd35c7bSdrh void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 602fcd35c7bSdrh void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 603fcd35c7bSdrh void *pCollNeededArg; 604fcd35c7bSdrh sqlite3_value *pErr; /* Most recent error message */ 605fcd35c7bSdrh char *zErrMsg; /* Most recent error message (UTF-8 encoded) */ 606fcd35c7bSdrh char *zErrMsg16; /* Most recent error message (UTF-16 encoded) */ 607881feaa0Sdrh union { 608881feaa0Sdrh int isInterrupted; /* True if sqlite3_interrupt has been called */ 609881feaa0Sdrh double notUsed1; /* Spacer */ 610881feaa0Sdrh } u1; 611ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 612e22a334bSdrh int (*xAuth)(void*,int,const char*,const char*,const char*,const char*); 613e22a334bSdrh /* Access authorization function */ 614ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 615ed6c8671Sdrh #endif 616348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 617348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 618348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 619348bb5d6Sdanielk1977 int nProgressOps; /* Number of opcodes for progress callback */ 620348bb5d6Sdanielk1977 #endif 621b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 622b9bb7c18Sdrh Hash aModule; /* populated by sqlite3_create_module() */ 6237e6ebfb2Sdanielk1977 Table *pVTab; /* vtab with active Connect/Create method */ 624f9e7dda7Sdanielk1977 sqlite3_vtab **aVTrans; /* Virtual tables with open transactions */ 625f9e7dda7Sdanielk1977 int nVTrans; /* Allocated size of aVTrans */ 6266b456a2bSdanielk1977 #endif 627fcd35c7bSdrh Hash aFunc; /* All functions that can be in SQL exprs */ 628fcd35c7bSdrh Hash aCollSeq; /* All collating sequences */ 629fcd35c7bSdrh BusyHandler busyHandler; /* Busy callback */ 63097903fefSdrh int busyTimeout; /* Busy handler timeout, in msec */ 631fcd35c7bSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 6327e900abfSdanielk1977 #ifdef SQLITE_SSE 6337e900abfSdanielk1977 sqlite3_stmt *pFetch; /* Used by SSE to fetch stored statements */ 6347e900abfSdanielk1977 #endif 63575897234Sdrh }; 63675897234Sdrh 63703b808a6Sdrh /* 63803b808a6Sdrh ** A macro to discover the encoding of a database. 63903b808a6Sdrh */ 64014db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc) 64114db2665Sdanielk1977 64275897234Sdrh /* 6438bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields. 6448bf8dc92Sdrh ** 6458bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have 6468bf8dc92Sdrh ** executed a BEGIN. On Db.flags, SQLITE_InTrans means a statement 6478bf8dc92Sdrh ** transaction is active on that particular database file. 64875897234Sdrh */ 6494c504391Sdrh #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */ 650c4a3c779Sdrh #define SQLITE_InTrans 0x00000008 /* True if in a transaction */ 6515e00f6c7Sdrh #define SQLITE_InternChanges 0x00000010 /* Uncommitted Hash table changes */ 652382c0247Sdrh #define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */ 653fcabd464Sdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 654fcabd464Sdrh #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */ 6551bee3d7bSdrh /* DELETE, or UPDATE and return */ 6561bee3d7bSdrh /* the count using a callback. */ 657fcabd464Sdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 6586a535340Sdrh /* result set is empty */ 65935d4c2f4Sdrh #define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */ 66035d4c2f4Sdrh #define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */ 661f404083eSdrh #define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */ 6627bec505eSdrh #define SQLITE_NoReadlock 0x00001000 /* Readlocks are omitted when 6637bec505eSdrh ** accessing read-only databases */ 6640cd2d4c9Sdrh #define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */ 665da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */ 666e321c29aSdrh #define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */ 667ac530b1aSdrh #define SQLITE_FullFSync 0x00010000 /* Use full fsync on the backend */ 668c2e87a3eSdrh #define SQLITE_LoadExtension 0x00020000 /* Enable load_extension */ 66958b9576bSdrh 67034c68fbaSdanielk1977 #define SQLITE_RecoveryMode 0x00040000 /* Ignore schema errors */ 6714a50aac5Sdrh #define SQLITE_SharedCache 0x00080000 /* Cache sharing is enabled */ 6724a50aac5Sdrh #define SQLITE_Vtab 0x00100000 /* There exists a virtual table */ 67334c68fbaSdanielk1977 67458b9576bSdrh /* 675247be43dSdrh ** Possible values for the sqlite.magic field. 676247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 677247be43dSdrh ** than being distinct from one another. 678247be43dSdrh */ 679247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 680247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 6817e8b848aSdrh #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 682247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 683247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 684247be43dSdrh 685247be43dSdrh /* 6860bce8354Sdrh ** Each SQL function is defined by an instance of the following 6870bce8354Sdrh ** structure. A pointer to this structure is stored in the sqlite.aFunc 6888e0a2f90Sdrh ** hash table. When multiple functions have the same name, the hash table 6898e0a2f90Sdrh ** points to a linked list of these structures. 6902803757aSdrh */ 6910bce8354Sdrh struct FuncDef { 69255ef4d97Sdrh i16 nArg; /* Number of arguments. -1 means unlimited */ 693d8123366Sdanielk1977 u8 iPrefEnc; /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */ 69455ef4d97Sdrh u8 needCollSeq; /* True if sqlite3GetFuncCollSeq() might be called */ 69555ef4d97Sdrh u8 flags; /* Some combination of SQLITE_FUNC_* */ 6961350b030Sdrh void *pUserData; /* User data parameter */ 6970bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 698f9b596ebSdrh void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */ 699f9b596ebSdrh void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */ 700f9b596ebSdrh void (*xFinalize)(sqlite3_context*); /* Aggregate finializer */ 70155ef4d97Sdrh char zName[1]; /* SQL name of the function. MUST BE LAST */ 7028e0a2f90Sdrh }; 7032803757aSdrh 7042803757aSdrh /* 705d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an 706d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule 707d1ab1ba5Sdanielk1977 ** hash table. 708d1ab1ba5Sdanielk1977 */ 709d1ab1ba5Sdanielk1977 struct Module { 710d1ab1ba5Sdanielk1977 const sqlite3_module *pModule; /* Callback pointers */ 711d1ab1ba5Sdanielk1977 const char *zName; /* Name passed to create_module() */ 712d1ab1ba5Sdanielk1977 void *pAux; /* pAux passed to create_module() */ 713832a58a6Sdanielk1977 void (*xDestroy)(void *); /* Module destructor function */ 714d1ab1ba5Sdanielk1977 }; 715d1ab1ba5Sdanielk1977 716d1ab1ba5Sdanielk1977 /* 71755ef4d97Sdrh ** Possible values for FuncDef.flags 71855ef4d97Sdrh */ 719d64fe2f3Sdrh #define SQLITE_FUNC_LIKE 0x01 /* Candidate for the LIKE optimization */ 720d64fe2f3Sdrh #define SQLITE_FUNC_CASE 0x02 /* Case-sensitive LIKE-type function */ 721b7f6f68fSdrh #define SQLITE_FUNC_EPHEM 0x04 /* Ephermeral. Delete with VDBE */ 72255ef4d97Sdrh 72355ef4d97Sdrh /* 724967e8b73Sdrh ** information about each column of an SQL table is held in an instance 7257020f651Sdrh ** of this structure. 7267020f651Sdrh */ 7277020f651Sdrh struct Column { 7287020f651Sdrh char *zName; /* Name of this column */ 7297977a17fSdanielk1977 Expr *pDflt; /* Default value of this column */ 730382c0247Sdrh char *zType; /* Data type for this column */ 731b3bf556eSdanielk1977 char *zColl; /* Collating sequence. If NULL, use the default */ 7324a32431cSdrh u8 notNull; /* True if there is a NOT NULL constraint */ 73378100cc9Sdrh u8 isPrimKey; /* True if this column is part of the PRIMARY KEY */ 734a37cdde0Sdanielk1977 char affinity; /* One of the SQLITE_AFF_... values */ 735034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE 736034ca14fSdanielk1977 u8 isHidden; /* True if this column is 'hidden' */ 737034ca14fSdanielk1977 #endif 7387020f651Sdrh }; 7397020f651Sdrh 7407020f651Sdrh /* 741a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following 7420202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and 7430202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence. 744a9fd84b0Sdrh ** 7450202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one 7460202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that 7470202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine 7480202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects 7490202b29eSdanielk1977 ** the version that will require the least expensive encoding 750b3bf556eSdanielk1977 ** translations, if any. 7510202b29eSdanielk1977 ** 7520202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in 7530202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp. 7540202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function, 7550202b29eSdanielk1977 ** xCmp16. 7560202b29eSdanielk1977 ** 7570202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the 7580202b29eSdanielk1977 ** collating sequence is undefined. Indices built on an undefined 7590202b29eSdanielk1977 ** collating sequence may not be read or written. 760a9fd84b0Sdrh */ 761a9fd84b0Sdrh struct CollSeq { 7620202b29eSdanielk1977 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 763466be56bSdanielk1977 u8 enc; /* Text encoding handled by xCmp() */ 764d64fe2f3Sdrh u8 type; /* One of the SQLITE_COLL_... values below */ 765a9fd84b0Sdrh void *pUser; /* First argument to xCmp() */ 7660202b29eSdanielk1977 int (*xCmp)(void*,int, const void*, int, const void*); 767a9808b31Sdanielk1977 void (*xDel)(void*); /* Destructor for pUser */ 768a9fd84b0Sdrh }; 769a9fd84b0Sdrh 770a9fd84b0Sdrh /* 771d64fe2f3Sdrh ** Allowed values of CollSeq flags: 772d64fe2f3Sdrh */ 773d64fe2f3Sdrh #define SQLITE_COLL_BINARY 1 /* The default memcmp() collating sequence */ 774d64fe2f3Sdrh #define SQLITE_COLL_NOCASE 2 /* The built-in NOCASE collating sequence */ 775d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3 /* The built-in REVERSE collating sequence */ 776d64fe2f3Sdrh #define SQLITE_COLL_USER 0 /* Any other user-defined collating sequence */ 777d64fe2f3Sdrh 778d64fe2f3Sdrh /* 779d3d39e93Sdrh ** A sort order can be either ASC or DESC. 7808e2ca029Sdrh */ 7818e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 782d3d39e93Sdrh #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 7838e2ca029Sdrh 7848e2ca029Sdrh /* 785a37cdde0Sdanielk1977 ** Column affinity types. 7868a51256cSdrh ** 7878a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 7888a51256cSdrh ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 7898a51256cSdrh ** the speed a little by number the values consecutively. 7908a51256cSdrh ** 7918a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'. That way, 7928a51256cSdrh ** when multiple affinity types are concatenated into a string and 79366a5167bSdrh ** used as the P4 operand, they will be more readable. 7948a51256cSdrh ** 7958a51256cSdrh ** Note also that the numeric types are grouped together so that testing 7968a51256cSdrh ** for a numeric type is a single comparison. 797a37cdde0Sdanielk1977 */ 7988a51256cSdrh #define SQLITE_AFF_TEXT 'a' 7998a51256cSdrh #define SQLITE_AFF_NONE 'b' 8008a51256cSdrh #define SQLITE_AFF_NUMERIC 'c' 8018a51256cSdrh #define SQLITE_AFF_INTEGER 'd' 8028a51256cSdrh #define SQLITE_AFF_REAL 'e' 803a37cdde0Sdanielk1977 8048a51256cSdrh #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 805a37cdde0Sdanielk1977 806a37cdde0Sdanielk1977 /* 80735573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an 80835573356Sdrh ** affinity value. 80935573356Sdrh */ 81035573356Sdrh #define SQLITE_AFF_MASK 0x67 81135573356Sdrh 81235573356Sdrh /* 81335573356Sdrh ** Additional bit values that can be ORed with an affinity without 81435573356Sdrh ** changing the affinity. 81535573356Sdrh */ 81635573356Sdrh #define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */ 81735573356Sdrh #define SQLITE_NULLEQUAL 0x10 /* compare NULLs equal */ 81835573356Sdrh #define SQLITE_STOREP2 0x80 /* Store result in reg[P2] rather than jump */ 81935573356Sdrh 82035573356Sdrh /* 82122f70c32Sdrh ** Each SQL table is represented in memory by an instance of the 82222f70c32Sdrh ** following structure. 82322f70c32Sdrh ** 824d24cc427Sdrh ** Table.zName is the name of the table. The case of the original 82522f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for 82622f70c32Sdrh ** comparisons. 82722f70c32Sdrh ** 828d24cc427Sdrh ** Table.nCol is the number of columns in this table. Table.aCol is a 82922f70c32Sdrh ** pointer to an array of Column structures, one for each column. 83022f70c32Sdrh ** 831d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of 832d24cc427Sdrh ** the column that is that key. Otherwise Table.iPKey is negative. Note 83322f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to 83422f70c32Sdrh ** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of 83522f70c32Sdrh ** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid 836d24cc427Sdrh ** is generated for each row of the table. Table.hasPrimKey is true if 83722f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise. 83822f70c32Sdrh ** 839d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the 840d24cc427Sdrh ** database file. If Table.iDb is the index of the database table backend 841d24cc427Sdrh ** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that 842b9bb7c18Sdrh ** holds temporary tables and indices. If Table.isEphem 84322f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted 844d24cc427Sdrh ** when the VDBE cursor to the table is closed. In this case Table.tnum 84522f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root 84622f70c32Sdrh ** page number. Transient tables are used to hold the results of a 84722f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause 84822f70c32Sdrh ** of a SELECT statement. 84975897234Sdrh */ 85075897234Sdrh struct Table { 85175897234Sdrh char *zName; /* Name of the table */ 85275897234Sdrh int nCol; /* Number of columns in this table */ 8537020f651Sdrh Column *aCol; /* Information about each column */ 854c8392586Sdrh int iPKey; /* If not less then 0, use aCol[iPKey] as the primary key */ 855967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 85622f70c32Sdrh int tnum; /* Root BTree node for this table (see note above) */ 857a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 858ed8a3bb1Sdrh int nRef; /* Number of pointers to this Table */ 859c3f9bad2Sdanielk1977 Trigger *pTrigger; /* List of SQL triggers on this table */ 860c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 8613d1bfeaaSdanielk1977 char *zColAff; /* String defining the affinity of each column */ 862ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK 863ffe07b2dSdrh Expr *pCheck; /* The AND of all CHECK constraints */ 864ffe07b2dSdrh #endif 86519a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE 86619a8e7e8Sdanielk1977 int addColOffset; /* Offset in CREATE TABLE statement to add a new column */ 86719a8e7e8Sdanielk1977 #endif 8681914619aSdrh u8 readOnly; /* True if this table should not be written by the user */ 8691914619aSdrh u8 isEphem; /* True if created using OP_OpenEphermeral */ 8701914619aSdrh u8 hasPrimKey; /* True if there exists a primary key */ 8711914619aSdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 8721914619aSdrh u8 autoInc; /* True if the integer primary key is autoincrement */ 873e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 8741914619aSdrh u8 isVirtual; /* True if this is a virtual table */ 8751914619aSdrh u8 isCommit; /* True once the CREATE TABLE has been committed */ 876d1ab1ba5Sdanielk1977 Module *pMod; /* Pointer to the implementation of the module */ 877b9bb7c18Sdrh sqlite3_vtab *pVtab; /* Pointer to the module instance */ 878b9bb7c18Sdrh int nModuleArg; /* Number of arguments to the module */ 879b9bb7c18Sdrh char **azModuleArg; /* Text of all module args. [0] is module name */ 880e09daa90Sdrh #endif 881728b5779Sdrh Schema *pSchema; /* Schema that contains this table */ 88275897234Sdrh }; 88375897234Sdrh 88475897234Sdrh /* 8854cbdda9eSdrh ** Test to see whether or not a table is a virtual table. This is 8864cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual 8874cbdda9eSdrh ** table support is omitted from the build. 8884cbdda9eSdrh */ 8894cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 8904cbdda9eSdrh # define IsVirtual(X) ((X)->isVirtual) 891034ca14fSdanielk1977 # define IsHiddenColumn(X) ((X)->isHidden) 8924cbdda9eSdrh #else 8934cbdda9eSdrh # define IsVirtual(X) 0 894034ca14fSdanielk1977 # define IsHiddenColumn(X) 0 8954cbdda9eSdrh #endif 8964cbdda9eSdrh 8974cbdda9eSdrh /* 898c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 899c2eef3b3Sdrh ** 900c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 901c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 902c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 903c2eef3b3Sdrh ** Consider this example: 904c2eef3b3Sdrh ** 905c2eef3b3Sdrh ** CREATE TABLE ex1( 906c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 907c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 908c2eef3b3Sdrh ** ); 909c2eef3b3Sdrh ** 910c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 911c2eef3b3Sdrh ** 912c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 913c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 914c2eef3b3Sdrh ** the from-table is created. The existance of the to-table is not checked 915c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table. 916c2eef3b3Sdrh ** 917ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure 918c2eef3b3Sdrh ** given the name of a to-table. For each to-table, all foreign keys 919c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo 920c2eef3b3Sdrh ** field. 921c2eef3b3Sdrh */ 922c2eef3b3Sdrh struct FKey { 923c2eef3b3Sdrh Table *pFrom; /* The table that constains the REFERENCES clause */ 924c2eef3b3Sdrh FKey *pNextFrom; /* Next foreign key in pFrom */ 925c2eef3b3Sdrh char *zTo; /* Name of table that the key points to */ 926c2eef3b3Sdrh FKey *pNextTo; /* Next foreign key that points to zTo */ 927c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 928c2eef3b3Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 929c2eef3b3Sdrh int iFrom; /* Index of column in pFrom */ 930c2eef3b3Sdrh char *zCol; /* Name of column in zTo. If 0 use PRIMARY KEY */ 931c2eef3b3Sdrh } *aCol; /* One entry for each of nCol column s */ 932c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 933c2eef3b3Sdrh u8 updateConf; /* How to resolve conflicts that occur on UPDATE */ 934c2eef3b3Sdrh u8 deleteConf; /* How to resolve conflicts that occur on DELETE */ 935c2eef3b3Sdrh u8 insertConf; /* How to resolve conflicts that occur on INSERT */ 936c2eef3b3Sdrh }; 937c2eef3b3Sdrh 938c2eef3b3Sdrh /* 939aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint 94022f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 9410bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 9421c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 9431c92853dSdrh ** fails and any prior changes from that one operation are backed out, 9441c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 9451c92853dSdrh ** the operation in progress stops and returns an error code. But prior 9461c92853dSdrh ** changes due to the same operation are not backed out and no rollback 9471c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 9481c92853dSdrh ** error is not inserted or updated. Processing continues and no error 9491c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 9501c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 9511c92853dSdrh ** update can proceed. Processing continues and no error is reported. 9521c92853dSdrh ** 953c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys. 954c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 955c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 956c2eef3b3Sdrh ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the 957c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 958c2eef3b3Sdrh ** foreign key. 959c2eef3b3Sdrh ** 960968af52aSdrh ** The following symbolic values are used to record which type 9611c92853dSdrh ** of action to take. 9629cfcf5d4Sdrh */ 9639cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 9641c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 9651c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 9661c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 9671c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 9681c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 969c2eef3b3Sdrh 970c2eef3b3Sdrh #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 971c2eef3b3Sdrh #define OE_SetNull 7 /* Set the foreign key value to NULL */ 972c2eef3b3Sdrh #define OE_SetDflt 8 /* Set the foreign key value to its default */ 973c2eef3b3Sdrh #define OE_Cascade 9 /* Cascade the changes */ 974c2eef3b3Sdrh 975c2eef3b3Sdrh #define OE_Default 99 /* Do whatever the default action is */ 9769cfcf5d4Sdrh 977d3d39e93Sdrh 978d3d39e93Sdrh /* 979d3d39e93Sdrh ** An instance of the following structure is passed as the first 980d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the 981d3d39e93Sdrh ** comparison of the two index keys. 982d3d39e93Sdrh ** 983d3d39e93Sdrh ** If the KeyInfo.incrKey value is true and the comparison would 9847e62779aSdrh ** otherwise be equal, then return a result as if the second key 9857e62779aSdrh ** were larger. 986d3d39e93Sdrh */ 987d3d39e93Sdrh struct KeyInfo { 988b21c8cd4Sdrh sqlite3 *db; /* The database connection */ 989b1bc9531Sdanielk1977 u8 enc; /* Text encoding - one of the TEXT_Utf* values */ 990d3d39e93Sdrh u8 incrKey; /* Increase 2nd key by epsilon before comparison */ 9919a96b668Sdanielk1977 u8 prefixIsEqual; /* Treat a prefix as equal */ 992d3d39e93Sdrh int nField; /* Number of entries in aColl[] */ 993d2d4a6b0Sdrh u8 *aSortOrder; /* If defined an aSortOrder[i] is true, sort DESC */ 994d3d39e93Sdrh CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 995d3d39e93Sdrh }; 996d3d39e93Sdrh 9979cfcf5d4Sdrh /* 99866b89c8fSdrh ** Each SQL index is represented in memory by an 99975897234Sdrh ** instance of the following structure. 1000967e8b73Sdrh ** 1001967e8b73Sdrh ** The columns of the table that are to be indexed are described 1002967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 1003967e8b73Sdrh ** we have the following table and index: 1004967e8b73Sdrh ** 1005967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 1006967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 1007967e8b73Sdrh ** 1008967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 1009967e8b73Sdrh ** three columns in the table. In the Index structure describing 1010967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 1011967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 1012967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 1013967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 1014967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 1015ea1ba17cSdrh ** 1016ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 1017ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 1018ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 1019ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 1020ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 1021ea1ba17cSdrh ** element. 102275897234Sdrh */ 102375897234Sdrh struct Index { 102475897234Sdrh char *zName; /* Name of this index */ 1025967e8b73Sdrh int nColumn; /* Number of columns in the table used by this index */ 1026967e8b73Sdrh int *aiColumn; /* Which columns are used by this index. 1st is 0 */ 10278b3d990bSdrh unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */ 1028967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 1029be0072d2Sdrh int tnum; /* Page containing root of this index in database file */ 10309cfcf5d4Sdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 1031485b39b4Sdrh u8 autoIndex; /* True if is automatically created (ex: by UNIQUE) */ 1032a37cdde0Sdanielk1977 char *zColAff; /* String defining the affinity of each column */ 103375897234Sdrh Index *pNext; /* The next index associated with the same table */ 1034b3bf556eSdanielk1977 Schema *pSchema; /* Schema containing this index */ 1035b3bf556eSdanielk1977 u8 *aSortOrder; /* Array of size Index.nColumn. True==DESC, False==ASC */ 1036b3bf556eSdanielk1977 char **azColl; /* Array of collation sequence names for index */ 103775897234Sdrh }; 103875897234Sdrh 103975897234Sdrh /* 104075897234Sdrh ** Each token coming out of the lexer is an instance of 10414b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 10424efc4754Sdrh ** 10434efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and 10444efc4754Sdrh ** may contain random values. Do not make any assuptions about Token.dyn 10454efc4754Sdrh ** and Token.n when Token.z==0. 104675897234Sdrh */ 104775897234Sdrh struct Token { 10484c755c0fSdrh const unsigned char *z; /* Text of the token. Not NULL-terminated! */ 10494b59ab5eSdrh unsigned dyn : 1; /* True for malloced memory, false for static */ 10506977fea8Sdrh unsigned n : 31; /* Number of characters in this token */ 105175897234Sdrh }; 105275897234Sdrh 105375897234Sdrh /* 105413449892Sdrh ** An instance of this structure contains information needed to generate 105513449892Sdrh ** code for a SELECT that contains aggregate functions. 105613449892Sdrh ** 105713449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 105813449892Sdrh ** pointer to this structure. The Expr.iColumn field is the index in 105913449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 106013449892Sdrh ** code for that node. 106113449892Sdrh ** 106213449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 106313449892Sdrh ** original Select structure that describes the SELECT statement. These 106413449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure. 106513449892Sdrh */ 106613449892Sdrh struct AggInfo { 106713449892Sdrh u8 directMode; /* Direct rendering mode means take data directly 106813449892Sdrh ** from source tables rather than from accumulators */ 106913449892Sdrh u8 useSortingIdx; /* In direct mode, reference the sorting index rather 107013449892Sdrh ** than the source table */ 107113449892Sdrh int sortingIdx; /* Cursor number of the sorting index */ 107213449892Sdrh ExprList *pGroupBy; /* The group by clause */ 107313449892Sdrh int nSortingColumn; /* Number of columns in the sorting index */ 107413449892Sdrh struct AggInfo_col { /* For each column used in source tables */ 10750817d0dfSdanielk1977 Table *pTab; /* Source table */ 107613449892Sdrh int iTable; /* Cursor number of the source table */ 107713449892Sdrh int iColumn; /* Column number within the source table */ 107813449892Sdrh int iSorterColumn; /* Column number in the sorting index */ 107913449892Sdrh int iMem; /* Memory location that acts as accumulator */ 10805774b806Sdrh Expr *pExpr; /* The original expression */ 108113449892Sdrh } *aCol; 108213449892Sdrh int nColumn; /* Number of used entries in aCol[] */ 108313449892Sdrh int nColumnAlloc; /* Number of slots allocated for aCol[] */ 108413449892Sdrh int nAccumulator; /* Number of columns that show through to the output. 108513449892Sdrh ** Additional columns are used only as parameters to 108613449892Sdrh ** aggregate functions */ 108713449892Sdrh struct AggInfo_func { /* For each aggregate function */ 108813449892Sdrh Expr *pExpr; /* Expression encoding the function */ 108913449892Sdrh FuncDef *pFunc; /* The aggregate function implementation */ 109013449892Sdrh int iMem; /* Memory location that acts as accumulator */ 1091b9bb7c18Sdrh int iDistinct; /* Ephermeral table used to enforce DISTINCT */ 109213449892Sdrh } *aFunc; 109313449892Sdrh int nFunc; /* Number of entries in aFunc[] */ 109413449892Sdrh int nFuncAlloc; /* Number of slots allocated for aFunc[] */ 109513449892Sdrh }; 109613449892Sdrh 109713449892Sdrh /* 109875897234Sdrh ** Each node of an expression in the parse tree is an instance 109922f70c32Sdrh ** of this structure. 110022f70c32Sdrh ** 110122f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 110222f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 110322f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 110422f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 110522f70c32Sdrh ** tree. 110622f70c32Sdrh ** 110722f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions. Expr.pList is a list 110822f70c32Sdrh ** of argument if the expression is a function. 110922f70c32Sdrh ** 11104b59ab5eSdrh ** Expr.token is the operator token for this node. For some expressions 11114b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave 11124b59ab5eSdrh ** rise to the Expr. In the latter case, the token is marked as being 11134b59ab5eSdrh ** a compound token. 111422f70c32Sdrh ** 111522f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 111622f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 111722f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 111822f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 111922f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 112022f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 112122f70c32Sdrh ** it can be accessed after all aggregates are computed. 112222f70c32Sdrh ** 112322f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code 11247c972decSdrh ** representing which function. If the expression is an unbound variable 11257c972decSdrh ** marker (a question mark character '?' in the original SQL) then the 11267c972decSdrh ** Expr.iTable holds the index number for that variable. 112722f70c32Sdrh ** 11281398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer 11291398ad36Sdrh ** register number containing the result of the subquery. If the 11301398ad36Sdrh ** subquery gives a constant result, then iTable is -1. If the subquery 11311398ad36Sdrh ** gives a different answer at different times during statement processing 11321398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery. 11331398ad36Sdrh ** 113422f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement. The SELECT might 113522f70c32Sdrh ** be the right operand of an IN operator. Or, if a scalar SELECT appears 113622f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only 113722f70c32Sdrh ** operand. 1138aee18ef8Sdanielk1977 ** 1139aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from 1140aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 1141aee18ef8Sdanielk1977 ** corresponding table definition. 114275897234Sdrh */ 114375897234Sdrh struct Expr { 11441cc093c2Sdrh u8 op; /* Operation performed by this node */ 1145a9fd84b0Sdrh char affinity; /* The affinity of the column or 0 if not a column */ 11466a03a1c5Sdrh u16 flags; /* Various flags. See below */ 1147f2bc013cSdrh CollSeq *pColl; /* The collation type of the column or 0 */ 114875897234Sdrh Expr *pLeft, *pRight; /* Left and right subnodes */ 1149d99f7068Sdrh ExprList *pList; /* A list of expressions used as function arguments 1150d99f7068Sdrh ** or in "<expr> IN (<expr-list)" */ 115175897234Sdrh Token token; /* An operand token */ 11526977fea8Sdrh Token span; /* Complete text of the expression */ 1153967e8b73Sdrh int iTable, iColumn; /* When op==TK_COLUMN, then this expr node means the 11548e2ca029Sdrh ** iColumn-th field of the iTable-th table. */ 115513449892Sdrh AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 115613449892Sdrh int iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 115722d6a53aSdrh int iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 1158d99f7068Sdrh Select *pSelect; /* When the expression is a sub-select. Also the 1159d99f7068Sdrh ** right side of "<expr> IN (<select>)" */ 1160aee18ef8Sdanielk1977 Table *pTab; /* Table for OP_Column expressions. */ 11610224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 1162fc976065Sdanielk1977 int nHeight; /* Height of the tree headed by this node */ 1163fc976065Sdanielk1977 #endif 116475897234Sdrh }; 116575897234Sdrh 116675897234Sdrh /* 11671f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 11681f16230bSdrh */ 1169678ccce8Sdrh #define EP_FromJoin 0x0001 /* Originated in ON or USING clause of a join */ 1170678ccce8Sdrh #define EP_Agg 0x0002 /* Contains one or more aggregate functions */ 1171678ccce8Sdrh #define EP_Resolved 0x0004 /* IDs have been resolved to COLUMNs */ 1172678ccce8Sdrh #define EP_Error 0x0008 /* Expression contains one or more errors */ 1173678ccce8Sdrh #define EP_Distinct 0x0010 /* Aggregate function with DISTINCT keyword */ 1174678ccce8Sdrh #define EP_VarSelect 0x0020 /* pSelect is correlated, not constant */ 1175678ccce8Sdrh #define EP_Dequoted 0x0040 /* True if the string has been dequoted */ 1176678ccce8Sdrh #define EP_InfixFunc 0x0080 /* True for an infix function: LIKE, GLOB, etc */ 1177678ccce8Sdrh #define EP_ExpCollate 0x0100 /* Collating sequence specified explicitly */ 1178da250ea5Sdrh #define EP_AnyAff 0x0200 /* Can take a cached column of any affinity */ 117947de955eSdrh #define EP_FixedDest 0x0400 /* Result needed in a specific register */ 118092b01d53Sdrh #define EP_IntValue 0x0800 /* Integer value contained in iTable */ 11811f16230bSdrh /* 11821f16230bSdrh ** These macros can be used to test, set, or clear bits in the 11831f16230bSdrh ** Expr.flags field. 11841f16230bSdrh */ 11851f16230bSdrh #define ExprHasProperty(E,P) (((E)->flags&(P))==(P)) 11861f16230bSdrh #define ExprHasAnyProperty(E,P) (((E)->flags&(P))!=0) 11871f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 11881f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 11891f16230bSdrh 11901f16230bSdrh /* 119175897234Sdrh ** A list of expressions. Each expression may optionally have a 119275897234Sdrh ** name. An expr/name combination can be used in several ways, such 119375897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 119475897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 1195ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 119675897234Sdrh ** field is not used. 119775897234Sdrh */ 119875897234Sdrh struct ExprList { 119975897234Sdrh int nExpr; /* Number of expressions on the list */ 12004305d103Sdrh int nAlloc; /* Number of entries allocated below */ 12019d2985c7Sdrh int iECursor; /* VDBE Cursor associated with this ExprList */ 12026d4abfbeSdrh struct ExprList_item { 120375897234Sdrh Expr *pExpr; /* The list of expressions */ 120475897234Sdrh char *zName; /* Token associated with this expression */ 12058e2ca029Sdrh u8 sortOrder; /* 1 for DESC or 0 for ASC */ 12068e2ca029Sdrh u8 isAgg; /* True if this is an aggregate like count(*) */ 12078e2ca029Sdrh u8 done; /* A flag to indicate when processing is finished */ 120875897234Sdrh } *a; /* One entry for each expression */ 120975897234Sdrh }; 121075897234Sdrh 121175897234Sdrh /* 1212ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 1213ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 1214ad3cab52Sdrh ** 1215ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 1216ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 1217ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 1218ad3cab52Sdrh ** 1219ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 1220ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 1221ad3cab52Sdrh ** 1222ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 1223ad3cab52Sdrh ** 1224ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 122575897234Sdrh */ 122675897234Sdrh struct IdList { 12276d4abfbeSdrh struct IdList_item { 1228ad3cab52Sdrh char *zName; /* Name of the identifier */ 1229967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 1230ad3cab52Sdrh } *a; 123113449892Sdrh int nId; /* Number of identifiers on the list */ 123213449892Sdrh int nAlloc; /* Number of entries allocated for a[] below */ 1233ad3cab52Sdrh }; 1234ad3cab52Sdrh 1235ad3cab52Sdrh /* 123651669863Sdrh ** The bitmask datatype defined below is used for various optimizations. 1237ca83ac51Sdrh ** 1238ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of 1239ca83ac51Sdrh ** tables in a join to 32 instead of 64. But it also reduces the size 1240ca83ac51Sdrh ** of the library by 738 bytes on ix86. 124151669863Sdrh */ 1242ca83ac51Sdrh typedef u64 Bitmask; 124351669863Sdrh 124451669863Sdrh /* 1245ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement. 1246ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of 1247ad3cab52Sdrh ** the SrcList.a[] array. 1248d24cc427Sdrh ** 1249d24cc427Sdrh ** With the addition of multiple database support, the following structure 1250d24cc427Sdrh ** can also be used to describe a particular table such as the table that 1251d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 1252d24cc427Sdrh ** such a table must be a simple name: ID. But in SQLite, the table can 1253d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 1254c49de5d9Sdrh ** 1255c49de5d9Sdrh ** The jointype starts out showing the join type between the current table 1256c49de5d9Sdrh ** and the next table on the list. The parser builds the list this way. 1257c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 1258c49de5d9Sdrh ** jointype expresses the join between the table and the previous table. 1259ad3cab52Sdrh */ 1260ad3cab52Sdrh struct SrcList { 1261939a16d6Sdrh i16 nSrc; /* Number of tables or subqueries in the FROM clause */ 1262939a16d6Sdrh i16 nAlloc; /* Number of entries allocated in a[] below */ 1263ad3cab52Sdrh struct SrcList_item { 1264113088ecSdrh char *zDatabase; /* Name of database holding this table */ 1265ad3cab52Sdrh char *zName; /* Name of the table */ 1266ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 1267daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 1268daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 12691787ccabSdanielk1977 u8 isPopulated; /* Temporary table associated with SELECT is populated */ 1270c49de5d9Sdrh u8 jointype; /* Type of join between this able and the previous */ 1271e68fbe79Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 1272ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 1273ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 127451669863Sdrh Bitmask colUsed; /* Bit N (1<<N) set if column N or pTab is used */ 1275113088ecSdrh } a[1]; /* One entry for each identifier on the list */ 127675897234Sdrh }; 127775897234Sdrh 127875897234Sdrh /* 127901f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 128001f3f253Sdrh */ 128101f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 12823dec223cSdrh #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 12833dec223cSdrh #define JT_NATURAL 0x0004 /* True for a "natural" join */ 12843dec223cSdrh #define JT_LEFT 0x0008 /* Left outer join */ 12853dec223cSdrh #define JT_RIGHT 0x0010 /* Right outer join */ 12863dec223cSdrh #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 12873dec223cSdrh #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 128801f3f253Sdrh 128901f3f253Sdrh /* 12906b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo 12916b56344dSdrh ** structure contains a single instance of this structure. This structure 12926b56344dSdrh ** is intended to be private the the where.c module and should not be 12936b56344dSdrh ** access or modified by other modules. 12946d209d8bSdrh ** 12956d209d8bSdrh ** The pIdxInfo and pBestIdx fields are used to help pick the best 12966d209d8bSdrh ** index on a virtual table. The pIdxInfo pointer contains indexing 12976d209d8bSdrh ** information for the i-th table in the FROM clause before reordering. 12986d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c. 12996d209d8bSdrh ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after 13006d209d8bSdrh ** FROM clause ordering. This is a little confusing so I will repeat 13016d209d8bSdrh ** it in different words. WhereInfo.a[i].pIdxInfo is index information 13026d209d8bSdrh ** for WhereInfo.pTabList.a[i]. WhereInfo.a[i].pBestInfo is the 13036d209d8bSdrh ** index information for the i-th loop of the join. pBestInfo is always 13046d209d8bSdrh ** either NULL or a copy of some pIdxInfo. So for cleanup it is 13056d209d8bSdrh ** sufficient to free all of the pIdxInfo pointers. 13066d209d8bSdrh ** 13076b56344dSdrh */ 13086b56344dSdrh struct WhereLevel { 130929dda4aeSdrh int iFrom; /* Which entry in the FROM clause */ 131029dda4aeSdrh int flags; /* Flags associated with this level */ 131151147baaSdrh int iMem; /* First memory cell used by this level */ 131229dda4aeSdrh int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */ 13139012bcbcSdrh Index *pIdx; /* Index used. NULL if no index */ 13149012bcbcSdrh int iTabCur; /* The VDBE cursor used to access the table */ 13159012bcbcSdrh int iIdxCur; /* The VDBE cursor used to acesss pIdx */ 13166b56344dSdrh int brk; /* Jump here to break out of the loop */ 131772e8fa42Sdrh int nxt; /* Jump here to start the next IN combination */ 13186b56344dSdrh int cont; /* Jump here to continue with the next loop cycle */ 1319ad2d8307Sdrh int top; /* First instruction of interior of the loop */ 132029dda4aeSdrh int op, p1, p2; /* Opcode used to terminate the loop */ 132151147baaSdrh int nEq; /* Number of == or IN constraints on this loop */ 1322e23399fcSdrh int nIn; /* Number of IN operators constraining this loop */ 132372e8fa42Sdrh struct InLoop { 132472e8fa42Sdrh int iCur; /* The VDBE cursor used by this IN operator */ 132572e8fa42Sdrh int topAddr; /* Top of the IN loop */ 132672e8fa42Sdrh } *aInLoop; /* Information about each nested IN operator */ 13276d209d8bSdrh sqlite3_index_info *pBestIdx; /* Index information for this level */ 13286d209d8bSdrh 13296d209d8bSdrh /* The following field is really not part of the current level. But 13306d209d8bSdrh ** we need a place to cache index information for each table in the 13316d209d8bSdrh ** FROM clause and the WhereLevel structure is a convenient place. 13326d209d8bSdrh */ 13336d209d8bSdrh sqlite3_index_info *pIdxInfo; /* Index info for n-th source table */ 13346b56344dSdrh }; 13356b56344dSdrh 133608c88eb0Sdrh /* 133708c88eb0Sdrh ** Flags appropriate for the wflags parameter of sqlite3WhereBegin(). 133808c88eb0Sdrh */ 133908c88eb0Sdrh #define WHERE_ORDERBY_NORMAL 0 /* No-op */ 134008c88eb0Sdrh #define WHERE_ORDERBY_MIN 1 /* ORDER BY processing for min() func */ 134108c88eb0Sdrh #define WHERE_ORDERBY_MAX 2 /* ORDER BY processing for max() func */ 134208c88eb0Sdrh #define WHERE_ONEPASS_DESIRED 4 /* Want to do one-pass UPDATE/DELETE */ 1343a9d1ccb9Sdanielk1977 13446b56344dSdrh /* 134575897234Sdrh ** The WHERE clause processing routine has two halves. The 134675897234Sdrh ** first part does the start of the WHERE loop and the second 134775897234Sdrh ** half does the tail of the WHERE loop. An instance of 134875897234Sdrh ** this structure is returned by the first half and passed 134975897234Sdrh ** into the second half to give some continuity. 135075897234Sdrh */ 135175897234Sdrh struct WhereInfo { 135208c88eb0Sdrh Parse *pParse; /* Parsing and code generating context */ 135308c88eb0Sdrh u8 okOnePass; /* Ok to use one-pass algorithm for UPDATE or DELETE */ 1354ad3cab52Sdrh SrcList *pTabList; /* List of tables in the join */ 13559012bcbcSdrh int iTop; /* The very beginning of the WHERE loop */ 135619a775c2Sdrh int iContinue; /* Jump here to continue with next record */ 135719a775c2Sdrh int iBreak; /* Jump here to break out of the loop */ 13586b56344dSdrh int nLevel; /* Number of nested loop */ 13596d209d8bSdrh sqlite3_index_info **apInfo; /* Array of pointers to index info structures */ 13606b56344dSdrh WhereLevel a[1]; /* Information about each nest loop in the WHERE */ 136175897234Sdrh }; 136275897234Sdrh 136375897234Sdrh /* 1364b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column 1365b3bce662Sdanielk1977 ** names. The context consists of a list of tables (the pSrcList) field and 1366b3bce662Sdanielk1977 ** a list of named expression (pEList). The named expression list may 1367b3bce662Sdanielk1977 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 1368b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 1369b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for 1370b3bce662Sdanielk1977 ** other statements. 1371b3bce662Sdanielk1977 ** 1372b3bce662Sdanielk1977 ** NameContexts can be nested. When resolving names, the inner-most 1373b3bce662Sdanielk1977 ** context is searched first. If no match is found, the next outer 1374b3bce662Sdanielk1977 ** context is checked. If there is still no match, the next context 1375b3bce662Sdanielk1977 ** is checked. This process continues until either a match is found 1376b3bce662Sdanielk1977 ** or all contexts are check. When a match is found, the nRef member of 1377b3bce662Sdanielk1977 ** the context containing the match is incremented. 1378b3bce662Sdanielk1977 ** 1379b3bce662Sdanielk1977 ** Each subquery gets a new NameContext. The pNext field points to the 1380b3bce662Sdanielk1977 ** NameContext in the parent query. Thus the process of scanning the 1381b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer 1382b3bce662Sdanielk1977 ** subqueries looking for a match. 1383b3bce662Sdanielk1977 */ 1384b3bce662Sdanielk1977 struct NameContext { 1385b3bce662Sdanielk1977 Parse *pParse; /* The parser */ 1386b3bce662Sdanielk1977 SrcList *pSrcList; /* One or more tables used to resolve names */ 1387b3bce662Sdanielk1977 ExprList *pEList; /* Optional list of named expressions */ 1388b3bce662Sdanielk1977 int nRef; /* Number of names resolved by this context */ 1389b3bce662Sdanielk1977 int nErr; /* Number of errors encountered while resolving names */ 1390b3bce662Sdanielk1977 u8 allowAgg; /* Aggregate functions allowed here */ 139113449892Sdrh u8 hasAgg; /* True if aggregates are seen */ 139206f6541eSdrh u8 isCheck; /* True if resolving names in a CHECK constraint */ 1393b3bce662Sdanielk1977 int nDepth; /* Depth of subquery recursion. 1 for no recursion */ 139413449892Sdrh AggInfo *pAggInfo; /* Information about aggregates at this level */ 1395b3bce662Sdanielk1977 NameContext *pNext; /* Next outer name context. NULL for outermost */ 1396b3bce662Sdanielk1977 }; 1397b3bce662Sdanielk1977 1398b3bce662Sdanielk1977 /* 13999bb61fe7Sdrh ** An instance of the following structure contains all information 14009bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 1401a76b5dfcSdrh ** 1402d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0. 1403d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the 1404d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not 1405d11d382cSdrh ** offset). But later on, nLimit and nOffset become the memory locations 1406d11d382cSdrh ** in the VDBE that record the limit and offset counters. 14070342b1f5Sdrh ** 1408b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 14090342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in 141066a5167bSdrh ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 14110342b1f5Sdrh ** the number of columns in P2 can be computed at the same time 1412b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not 14130342b1f5Sdrh ** enough information about the compound query is known at that point. 1414b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 1415b9bb7c18Sdrh ** for the result set. The KeyInfo for addrOpenTran[2] contains collating 14160342b1f5Sdrh ** sequences for the ORDER BY clause. 14179bb61fe7Sdrh */ 14189bb61fe7Sdrh struct Select { 14199bb61fe7Sdrh ExprList *pEList; /* The fields of the result */ 14207b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 14217b58daeaSdrh u8 isDistinct; /* True if the DISTINCT keyword is present */ 14220342b1f5Sdrh u8 isResolved; /* True once sqlite3SelectResolve() has run. */ 14230342b1f5Sdrh u8 isAgg; /* True if this is an aggregate query */ 1424b9bb7c18Sdrh u8 usesEphm; /* True if uses an OpenEphemeral opcode */ 14254b14b4d7Sdrh u8 disallowOrderBy; /* Do not allow an ORDER BY to be attached if TRUE */ 14266c1426fdSdrh char affinity; /* MakeRecord with this affinity for SRT_Set */ 1427ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 14289bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 14299bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 14309bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 14319bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 1432967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 14331e281291Sdrh Select *pNext; /* Next select to the left in a compound */ 14340342b1f5Sdrh Select *pRightmost; /* Right-most select in a compound select statement */ 1435a2dc3b1aSdanielk1977 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 1436a2dc3b1aSdanielk1977 Expr *pOffset; /* OFFSET expression. NULL means not used. */ 14377b58daeaSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 1438b9bb7c18Sdrh int addrOpenEphm[3]; /* OP_OpenEphem opcodes related to this select */ 14399bb61fe7Sdrh }; 14409bb61fe7Sdrh 14419bb61fe7Sdrh /* 1442fef5208cSdrh ** The results of a select can be distributed in several ways. 1443fef5208cSdrh */ 144413449892Sdrh #define SRT_Union 1 /* Store result as keys in an index */ 144513449892Sdrh #define SRT_Except 2 /* Remove result from a UNION index */ 14469ed1dfa8Sdanielk1977 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 14479ed1dfa8Sdanielk1977 #define SRT_Discard 4 /* Do not save the results anywhere */ 1448fef5208cSdrh 144913449892Sdrh /* The ORDER BY clause is ignored for all of the above */ 14506c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard) 145113449892Sdrh 14529ed1dfa8Sdanielk1977 #define SRT_Callback 5 /* Invoke a callback with each row of result */ 14539ed1dfa8Sdanielk1977 #define SRT_Mem 6 /* Store result in a memory cell */ 14540cdc022eSdanielk1977 #define SRT_Set 7 /* Store results as keys in an index */ 14559ed1dfa8Sdanielk1977 #define SRT_Table 8 /* Store result as data with an automatic rowid */ 14569ed1dfa8Sdanielk1977 #define SRT_EphemTab 9 /* Create transient tab and store like SRT_Table */ 1457e00ee6ebSdrh #define SRT_Coroutine 10 /* Generate a single row of result */ 14582282792aSdrh 14592282792aSdrh /* 14606c8c8ce0Sdanielk1977 ** A structure used to customize the behaviour of sqlite3Select(). See 14616c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details. 14626c8c8ce0Sdanielk1977 */ 14636c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest; 14646c8c8ce0Sdanielk1977 struct SelectDest { 1465477df4b3Sdrh u8 eDest; /* How to dispose of the results */ 1466477df4b3Sdrh u8 affinity; /* Affinity used when eDest==SRT_Set */ 14676c8c8ce0Sdanielk1977 int iParm; /* A parameter used by the eDest disposal method */ 14681013c932Sdrh int iMem; /* Base register where results are written */ 1469ad27e761Sdrh int nMem; /* Number of registers allocated */ 14706c8c8ce0Sdanielk1977 }; 14716c8c8ce0Sdanielk1977 14726c8c8ce0Sdanielk1977 /* 1473f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 1474f57b3399Sdrh ** the parser and down into all the parser action routine in order to 1475f57b3399Sdrh ** carry around information that is global to the entire parse. 1476f1974846Sdrh ** 1477f1974846Sdrh ** The structure is divided into two parts. When the parser and code 1478f1974846Sdrh ** generate call themselves recursively, the first part of the structure 1479f1974846Sdrh ** is constant but the second part is reset at the beginning and end of 1480f1974846Sdrh ** each recursion. 1481c00da105Sdanielk1977 ** 1482c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache 1483c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 1484c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being 1485c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the 1486c00da105Sdanielk1977 ** list. 148775897234Sdrh */ 148875897234Sdrh struct Parse { 14899bb575fdSdrh sqlite3 *db; /* The main database structure */ 14904c504391Sdrh int rc; /* Return code from execution */ 149175897234Sdrh char *zErrMsg; /* An error message */ 149275897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 1493836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 1494e0bc4048Sdrh u8 nameClash; /* A permanent table name clashes with temp table name */ 1495a6ecd338Sdrh u8 checkSchema; /* Causes schema cookie check after an error */ 1496205f48e6Sdrh u8 nested; /* Number of nested calls to the parser/code generator */ 14977e326c09Sdrh u8 parseError; /* True after a parsing error. Ticket #1794 */ 1498892d3179Sdrh u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 14992dcef11bSdrh u8 nTempInUse; /* Number of aTempReg[] currently checked out */ 1500892d3179Sdrh int aTempReg[8]; /* Holding area for temporary registers */ 1501892d3179Sdrh int nRangeReg; /* Size of the temporary register block */ 1502892d3179Sdrh int iRangeReg; /* First register in temporary register block */ 150375897234Sdrh int nErr; /* Number of errors seen */ 1504832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 150519a775c2Sdrh int nMem; /* Number of memory cells used so far */ 1506fef5208cSdrh int nSet; /* Number of sets used so far */ 1507aa9b8963Sdrh int ckBase; /* Base register of data during check constraints */ 1508e55cbd72Sdrh int disableColCache; /* True to disable adding to column cache */ 1509e55cbd72Sdrh int nColCache; /* Number of entries in the column cache */ 1510e55cbd72Sdrh int iColCache; /* Next entry of the cache to replace */ 15112f7794c1Sdrh struct yColCache { 1512e55cbd72Sdrh int iTable; /* Table cursor number */ 1513e55cbd72Sdrh int iColumn; /* Table column number */ 1514da250ea5Sdrh char affChange; /* True if this register has had an affinity change */ 1515e55cbd72Sdrh int iReg; /* Register holding value of this column */ 1516e55cbd72Sdrh } aColCache[10]; /* One for each valid column cache entry */ 151780242055Sdrh u32 writeMask; /* Start a write transaction on these databases */ 1518fcd35c7bSdrh u32 cookieMask; /* Bitmask of schema verified databases */ 1519fcd35c7bSdrh int cookieGoto; /* Address of OP_Goto to cookie verifier subroutine */ 1520c797d4dcSdrh int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */ 1521c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 1522c00da105Sdanielk1977 int nTableLock; /* Number of locks in aTableLock */ 1523c00da105Sdanielk1977 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 1524c00da105Sdanielk1977 #endif 1525cac336adSdanielk1977 int regRowid; /* Register holding rowid of CREATE TABLE entry */ 1526cac336adSdanielk1977 int regRoot; /* Register holding root page number for new objects */ 1527f1974846Sdrh 1528f1974846Sdrh /* Above is constant between recursions. Below is reset before and after 1529f1974846Sdrh ** each recursion */ 1530f1974846Sdrh 1531f1974846Sdrh int nVar; /* Number of '?' variables seen in the SQL so far */ 1532f1974846Sdrh int nVarExpr; /* Number of used slots in apVarExpr[] */ 1533f1974846Sdrh int nVarExprAlloc; /* Number of allocated slots in apVarExpr[] */ 1534f1974846Sdrh Expr **apVarExpr; /* Pointers to :aaa and $aaaa wildcard expressions */ 1535f1974846Sdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 1536f1974846Sdrh Token sErrToken; /* The token at which the error occurred */ 1537f1974846Sdrh Token sNameToken; /* Token with unqualified schema object name */ 1538f1974846Sdrh Token sLastToken; /* The last token parsed */ 1539f1974846Sdrh const char *zSql; /* All SQL text */ 1540f1974846Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 1541f1974846Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 1542f1974846Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 1543f1974846Sdrh TriggerStack *trigStack; /* Trigger actions being coded */ 1544f1974846Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 1545b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 154633b3933cSdanielk1977 Token sArg; /* Complete text of a module argument */ 15477e6ebfb2Sdanielk1977 u8 declareVtab; /* True if inside sqlite3_declare_vtab() */ 15484f3dd150Sdrh int nVtabLock; /* Number of virtual tables to lock */ 15494f3dd150Sdrh Table **apVtabLock; /* Pointer to virtual tables needing locking */ 1550b9bb7c18Sdrh #endif 1551fc976065Sdanielk1977 int nHeight; /* Expression tree height of current sub-select */ 155275897234Sdrh }; 155375897234Sdrh 15547e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE 15557e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB 0 15567e6ebfb2Sdanielk1977 #else 15577e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB (pParse->declareVtab) 15587e6ebfb2Sdanielk1977 #endif 15597e6ebfb2Sdanielk1977 1560d99bc930Sdanielk1977 /* 156185e2096fSdrh ** An instance of the following structure can be declared on a stack and used 156285e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 156385e2096fSdrh */ 156485e2096fSdrh struct AuthContext { 156585e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 156685e2096fSdrh Parse *pParse; /* The Parse structure */ 156785e2096fSdrh }; 156885e2096fSdrh 156985e2096fSdrh /* 1570f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete 1571b0c374ffSrdc */ 1572b0c374ffSrdc #define OPFLAG_NCHANGE 1 /* Set to update db->nChange */ 1573b0c374ffSrdc #define OPFLAG_LASTROWID 2 /* Set to update db->lastRowid */ 157494eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE 4 /* This OP_Insert is an sql UPDATE */ 1575e4d90813Sdrh #define OPFLAG_APPEND 8 /* This is likely to be an append */ 1576b0c374ffSrdc 1577b0c374ffSrdc /* 1578d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 1579d99bc930Sdanielk1977 * struct Trigger. 1580d99bc930Sdanielk1977 * 1581d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 15829bb575fdSdrh * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 1583d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 1584d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 1585ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 1586ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 1587ad3cab52Sdrh * struct Table. 1588d99bc930Sdanielk1977 * 1589ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 1590ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 1591d99bc930Sdanielk1977 */ 1592d99bc930Sdanielk1977 struct Trigger { 1593d99bc930Sdanielk1977 char *name; /* The name of the trigger */ 1594d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 1595f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 1596dca76841Sdrh u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 1597d99bc930Sdanielk1977 Expr *pWhen; /* The WHEN clause of the expresion (may be NULL) */ 1598d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 1599d99bc930Sdanielk1977 the <column-list> is stored here */ 16004312db55Sdrh Token nameToken; /* Token containing zName. Use during parsing only */ 1601e501b89aSdanielk1977 Schema *pSchema; /* Schema containing the trigger */ 1602e501b89aSdanielk1977 Schema *pTabSchema; /* Schema containing the table */ 1603d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 1604d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 1605c3f9bad2Sdanielk1977 }; 1606d99bc930Sdanielk1977 1607d99bc930Sdanielk1977 /* 1608dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger. The following constants 1609dca76841Sdrh ** determine which. 1610dca76841Sdrh ** 1611dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER. 1612dca76841Sdrh ** In that cases, the constants below can be ORed together. 1613dca76841Sdrh */ 1614dca76841Sdrh #define TRIGGER_BEFORE 1 1615dca76841Sdrh #define TRIGGER_AFTER 2 1616dca76841Sdrh 1617dca76841Sdrh /* 1618d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 1619d99bc930Sdanielk1977 * that is a part of a trigger-program. 1620d99bc930Sdanielk1977 * 1621d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 1622d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 1623d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 1624d99bc930Sdanielk1977 * the first step of the trigger-program. 1625d99bc930Sdanielk1977 * 1626d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 1627d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 1628d99bc930Sdanielk1977 * value of "op" as follows: 1629d99bc930Sdanielk1977 * 1630d99bc930Sdanielk1977 * (op == TK_INSERT) 1631d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 1632d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 1633d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 1634d99bc930Sdanielk1977 * target -> A token holding the name of the table to insert into. 1635d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 1636d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 1637d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 1638ad3cab52Sdrh * statement, then this stores the column-names to be 1639ad3cab52Sdrh * inserted into. 1640d99bc930Sdanielk1977 * 1641d99bc930Sdanielk1977 * (op == TK_DELETE) 1642d99bc930Sdanielk1977 * target -> A token holding the name of the table to delete from. 1643d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 1644d99bc930Sdanielk1977 * Otherwise NULL. 1645d99bc930Sdanielk1977 * 1646d99bc930Sdanielk1977 * (op == TK_UPDATE) 1647d99bc930Sdanielk1977 * target -> A token holding the name of the table to update rows of. 1648d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 1649d99bc930Sdanielk1977 * Otherwise NULL. 1650d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 16514adee20fSdanielk1977 * them to. See sqlite3Update() documentation of "pChanges" 1652ad3cab52Sdrh * argument. 1653d99bc930Sdanielk1977 * 1654d99bc930Sdanielk1977 */ 1655c3f9bad2Sdanielk1977 struct TriggerStep { 1656c3f9bad2Sdanielk1977 int op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */ 1657d99bc930Sdanielk1977 int orconf; /* OE_Rollback etc. */ 1658a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 1659c3f9bad2Sdanielk1977 1660c3f9bad2Sdanielk1977 Select *pSelect; /* Valid for SELECT and sometimes 1661c3f9bad2Sdanielk1977 INSERT steps (when pExprList == 0) */ 1662c3f9bad2Sdanielk1977 Token target; /* Valid for DELETE, UPDATE, INSERT steps */ 1663c3f9bad2Sdanielk1977 Expr *pWhere; /* Valid for DELETE, UPDATE steps */ 1664c3f9bad2Sdanielk1977 ExprList *pExprList; /* Valid for UPDATE statements and sometimes 1665c3f9bad2Sdanielk1977 INSERT steps (when pSelect == 0) */ 1666c3f9bad2Sdanielk1977 IdList *pIdList; /* Valid for INSERT statements only */ 1667c3f9bad2Sdanielk1977 TriggerStep *pNext; /* Next in the link-list */ 1668187e4c6aSdrh TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 1669c3f9bad2Sdanielk1977 }; 1670c3f9bad2Sdanielk1977 1671d99bc930Sdanielk1977 /* 1672d99bc930Sdanielk1977 * An instance of struct TriggerStack stores information required during code 1673d99bc930Sdanielk1977 * generation of a single trigger program. While the trigger program is being 1674d99bc930Sdanielk1977 * coded, its associated TriggerStack instance is pointed to by the 1675d99bc930Sdanielk1977 * "pTriggerStack" member of the Parse structure. 1676d99bc930Sdanielk1977 * 1677d99bc930Sdanielk1977 * The pTab member points to the table that triggers are being coded on. The 1678d99bc930Sdanielk1977 * newIdx member contains the index of the vdbe cursor that points at the temp 1679d99bc930Sdanielk1977 * table that stores the new.* references. If new.* references are not valid 1680d99bc930Sdanielk1977 * for the trigger being coded (for example an ON DELETE trigger), then newIdx 1681d99bc930Sdanielk1977 * is set to -1. The oldIdx member is analogous to newIdx, for old.* references. 1682d99bc930Sdanielk1977 * 1683d99bc930Sdanielk1977 * The ON CONFLICT policy to be used for the trigger program steps is stored 1684d99bc930Sdanielk1977 * as the orconf member. If this is OE_Default, then the ON CONFLICT clause 1685d99bc930Sdanielk1977 * specified for individual triggers steps is used. 1686d99bc930Sdanielk1977 * 1687d99bc930Sdanielk1977 * struct TriggerStack has a "pNext" member, to allow linked lists to be 1688d99bc930Sdanielk1977 * constructed. When coding nested triggers (triggers fired by other triggers) 1689d99bc930Sdanielk1977 * each nested trigger stores its parent trigger's TriggerStack as the "pNext" 1690d99bc930Sdanielk1977 * pointer. Once the nested trigger has been coded, the pNext value is restored 1691d99bc930Sdanielk1977 * to the pTriggerStack member of the Parse stucture and coding of the parent 1692d99bc930Sdanielk1977 * trigger continues. 1693d99bc930Sdanielk1977 * 1694d99bc930Sdanielk1977 * Before a nested trigger is coded, the linked list pointed to by the 1695d99bc930Sdanielk1977 * pTriggerStack is scanned to ensure that the trigger is not about to be coded 1696d99bc930Sdanielk1977 * recursively. If this condition is detected, the nested trigger is not coded. 1697d99bc930Sdanielk1977 */ 1698d99bc930Sdanielk1977 struct TriggerStack { 1699d99bc930Sdanielk1977 Table *pTab; /* Table that triggers are currently being coded on */ 1700d99bc930Sdanielk1977 int newIdx; /* Index of vdbe cursor to "new" temp table */ 1701d99bc930Sdanielk1977 int oldIdx; /* Index of vdbe cursor to "old" temp table */ 17028f2c54e6Sdanielk1977 u32 newColMask; 17038f2c54e6Sdanielk1977 u32 oldColMask; 1704d99bc930Sdanielk1977 int orconf; /* Current orconf policy */ 17056f34903eSdanielk1977 int ignoreJump; /* where to jump to for a RAISE(IGNORE) */ 1706e22a334bSdrh Trigger *pTrigger; /* The trigger currently being coded */ 1707e22a334bSdrh TriggerStack *pNext; /* Next trigger down on the trigger stack */ 1708c3f9bad2Sdanielk1977 }; 1709c3f9bad2Sdanielk1977 1710d99bc930Sdanielk1977 /* 1711f26e09c8Sdrh ** The following structure contains information used by the sqliteFix... 1712f26e09c8Sdrh ** routines as they walk the parse tree to make database references 1713f26e09c8Sdrh ** explicit. 1714f26e09c8Sdrh */ 1715f26e09c8Sdrh typedef struct DbFixer DbFixer; 1716f26e09c8Sdrh struct DbFixer { 1717f26e09c8Sdrh Parse *pParse; /* The parsing context. Error messages written here */ 1718f26e09c8Sdrh const char *zDb; /* Make sure all objects are contained in this database */ 1719f26e09c8Sdrh const char *zType; /* Type of the container - used for error messages */ 1720f26e09c8Sdrh const Token *pName; /* Name of the container - used for error messages */ 1721f26e09c8Sdrh }; 1722f26e09c8Sdrh 1723f26e09c8Sdrh /* 1724ade86483Sdrh ** An objected used to accumulate the text of a string where we 1725ade86483Sdrh ** do not necessarily know how big the string will be in the end. 1726ade86483Sdrh */ 1727ade86483Sdrh struct StrAccum { 1728ade86483Sdrh char *zBase; /* A base allocation. Not from malloc. */ 1729ade86483Sdrh char *zText; /* The string collected so far */ 1730ade86483Sdrh int nChar; /* Length of the string so far */ 1731ade86483Sdrh int nAlloc; /* Amount of space allocated in zText */ 1732bb4957f8Sdrh int mxAlloc; /* Maximum allowed string length */ 1733ade86483Sdrh u8 mallocFailed; /* Becomes true if any memory allocation fails */ 1734ade86483Sdrh u8 useMalloc; /* True if zText is enlargable using realloc */ 1735ade86483Sdrh u8 tooBig; /* Becomes true if string size exceeds limits */ 1736ade86483Sdrh }; 1737ade86483Sdrh 1738ade86483Sdrh /* 1739234c39dfSdrh ** A pointer to this structure is used to communicate information 1740234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 1741234c39dfSdrh */ 1742234c39dfSdrh typedef struct { 17439bb575fdSdrh sqlite3 *db; /* The database being initialized */ 1744ece3c728Sdrh int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 1745234c39dfSdrh char **pzErrMsg; /* Error message stored here */ 174615ca1df1Sdrh int rc; /* Result code stored here */ 1747234c39dfSdrh } InitData; 1748234c39dfSdrh 1749b6c29897Sdrh /* 175040257ffdSdrh ** Structure containing global configuration data for the SQLite library. 175133589797Sdrh ** 175233589797Sdrh ** This structure also contains some state information. 175340257ffdSdrh */ 175440257ffdSdrh struct Sqlite3Config { 1755fec00eabSdrh int bMemstat; /* True to enable memory status */ 1756fec00eabSdrh int bCoreMutex; /* True to enable core mutexing */ 1757fec00eabSdrh int bFullMutex; /* True to enable full mutexing */ 17580a687d12Sdrh int mxStrlen; /* Maximum string length */ 1759fec00eabSdrh sqlite3_mem_methods m; /* Low-level memory allocation interface */ 17606d2ab0e4Sdanielk1977 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 176140257ffdSdrh void *pHeap; /* Heap storage space */ 176233589797Sdrh int nHeap; /* Size of pHeap[] */ 176333589797Sdrh int mnReq, mxReq; /* Min and max heap requests sizes */ 176433589797Sdrh void *pScratch; /* Scratch memory */ 176533589797Sdrh int szScratch; /* Size of each scratch buffer */ 176633589797Sdrh int nScratch; /* Number of scratch buffers */ 176733589797Sdrh void *pPage; /* Page cache memory */ 176833589797Sdrh int szPage; /* Size of each page in pPage[] */ 176933589797Sdrh int nPage; /* Number of pages in pPage[] */ 177071bc31c6Sdanielk1977 int isInit; /* True after initialization has finished */ 177171bc31c6Sdanielk1977 int isMallocInit; /* True after malloc is initialized */ 177271bc31c6Sdanielk1977 sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 177340257ffdSdrh }; 177440257ffdSdrh 177540257ffdSdrh /* 177666150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character, 177766150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character. 17784a919118Sdrh */ 17794a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) { \ 17804a919118Sdrh if( (*(zIn++))>=0xc0 ){ \ 17814a919118Sdrh while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 17824a919118Sdrh } \ 17834a919118Sdrh } 17844a919118Sdrh 17854a919118Sdrh /* 178649285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production 178749285708Sdrh ** builds) or a function call (for debugging). If it is a function call, 178849285708Sdrh ** it allows the operator to set a breakpoint at the spot where database 178949285708Sdrh ** corruption is first detected. 179049285708Sdrh */ 179149285708Sdrh #ifdef SQLITE_DEBUG 17926e736838Sdrh int sqlite3Corrupt(void); 179349285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt() 1794e5fe690dSdrh # define DEBUGONLY(X) X 179549285708Sdrh #else 179649285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT 1797e5fe690dSdrh # define DEBUGONLY(X) 179849285708Sdrh #endif 179949285708Sdrh 180049285708Sdrh /* 180175897234Sdrh ** Internal function prototypes 180275897234Sdrh */ 18034adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *); 18044adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int); 18058a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8); 18060a687d12Sdrh int sqlite3Strlen(sqlite3*, const char*); 18072e588c75Sdanielk1977 180840257ffdSdrh int sqlite3MallocInit(void); 1809fec00eabSdrh void sqlite3MallocEnd(void); 1810fec00eabSdrh void *sqlite3Malloc(int); 1811fec00eabSdrh void *sqlite3MallocZero(int); 1812fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int); 1813fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int); 1814bdb4383aSdrh char *sqlite3StrDup(const char*); 1815bdb4383aSdrh char *sqlite3StrNDup(const char*, int); 181617435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*); 181717435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int); 1818fec00eabSdrh void *sqlite3Realloc(void*, int); 181997c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int); 1820a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int); 1821a7a8e14bSdanielk1977 int sqlite3MallocSize(void *); 1822facf0307Sdrh void *sqlite3ScratchMalloc(int); 1823facf0307Sdrh void sqlite3ScratchFree(void*); 1824facf0307Sdrh void *sqlite3PageMalloc(int); 1825facf0307Sdrh void sqlite3PageFree(void*); 1826fec00eabSdrh void sqlite3MemSetDefault(void); 18275099be5eSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 18280d84e5b2Sdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 1829171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 18302e588c75Sdanielk1977 183165bbf29eSdrh #ifndef SQLITE_MUTEX_NOOP 18326d2ab0e4Sdanielk1977 sqlite3_mutex_methods *sqlite3DefaultMutex(void); 183359f8c08eSdanielk1977 sqlite3_mutex *sqlite3MutexAlloc(int); 1834d025174fSdanielk1977 int sqlite3MutexInit(void); 1835d025174fSdanielk1977 int sqlite3MutexEnd(void); 183665bbf29eSdrh #endif 18376d2ab0e4Sdanielk1977 1838f7141990Sdrh void sqlite3StatusReset(void); 1839f7141990Sdrh int sqlite3StatusValue(int); 1840f7141990Sdrh void sqlite3StatusAdd(int, int); 1841f7141990Sdrh void sqlite3StatusSet(int, int); 1842f7141990Sdrh 18430de3ae95Sdrh int sqlite3IsNaN(double); 18440de3ae95Sdrh 1845f089aa45Sdrh void sqlite3VXPrintf(StrAccum*, int, const char*, va_list); 184617435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...); 184717435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 184887cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG) 1849e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...); 1850d919fe17Sdrh #endif 1851d919fe17Sdrh #if defined(SQLITE_TEST) 1852fe63d1c9Sdrh void *sqlite3TextToPtr(const char*); 185387cc3b31Sdrh #endif 1854f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...); 18554adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...); 1856a073384fSdrh void sqlite3ErrorClear(Parse*); 18574adee20fSdanielk1977 void sqlite3Dequote(char*); 185817435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*); 18592646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int); 18604adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **); 186180242055Sdrh void sqlite3FinishCoding(Parse*); 1862892d3179Sdrh int sqlite3GetTempReg(Parse*); 1863892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int); 1864892d3179Sdrh int sqlite3GetTempRange(Parse*,int); 1865892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int); 1866a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*); 186717435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*); 18684e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*); 18691e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*); 18704adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*); 187117435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*); 1872fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*); 18734adee20fSdanielk1977 void sqlite3ExprDelete(Expr*); 187417435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*); 18754adee20fSdanielk1977 void sqlite3ExprListDelete(ExprList*); 18769bb575fdSdrh int sqlite3Init(sqlite3*, char**); 1877234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**); 187891cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 18799bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int); 18804adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int); 18819bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*); 18824adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*); 1883c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int); 1884f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 18854adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*); 18864adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int); 1887fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 1888ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*); 1889487e262fSdrh void sqlite3AddColumnType(Parse*,Token*); 18907977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*); 189139002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*); 189219a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*); 1893b7f9164eSdrh 1894f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32); 1895f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32); 1896f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32); 1897f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32); 1898f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*); 18993088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*); 1900f5e7bb51Sdrh 1901fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int); 1902fe3fcbe2Sdanielk1977 1903fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 19044adee20fSdanielk1977 int sqlite3ViewGetColumnNames(Parse*,Table*); 1905b7f9164eSdrh #else 1906b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0 1907b7f9164eSdrh #endif 1908b7f9164eSdrh 1909a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int); 1910a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*); 19114adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int); 191217435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*); 191317435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*); 19144adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*); 191517435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*); 191617435752Sdrh SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*, 191761dfc31dSdrh Select*, Expr*, IdList*); 191861dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*); 19194adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 19204adee20fSdanielk1977 void sqlite3IdListDelete(IdList*); 19214adee20fSdanielk1977 void sqlite3SrcListDelete(SrcList*); 19220202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 19234d91a701Sdrh Token*, int, int); 19244d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int); 1925*a9671a22Sdrh int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*); 192617435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 192717435752Sdrh Expr*,ExprList*,int,Expr*,Expr*); 19284adee20fSdanielk1977 void sqlite3SelectDelete(Select*); 19294adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*); 19304adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int); 1931c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 19324adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*); 19334adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int); 1934a9d1ccb9Sdanielk1977 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8); 19354adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*); 1936da250ea5Sdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int); 1937b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int); 193892b01d53Sdrh void sqlite3ExprCodeCopy(Parse*, int, int, int); 1939e55cbd72Sdrh void sqlite3ExprClearColumnCache(Parse*, int); 1940da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int); 1941652fbf55Sdrh int sqlite3ExprWritableRegister(Parse*,int,int); 1942191b54cbSdrh void sqlite3ExprHardCopy(Parse*,int,int); 1943389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int); 19442dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 1945678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int); 19462dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int); 1947678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*); 1948191b54cbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int); 19494adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 19504adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 19519bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*); 1952ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*); 19539bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 19549bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 19559bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 195674161705Sdrh void sqlite3Vacuum(Parse*); 19579bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*); 195817435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*); 19594adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*); 1960b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *); 1961d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 1962d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 19634adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*); 19641e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*); 19652fa1868fSdrh void sqlite3PrngSaveState(void); 19662fa1868fSdrh void sqlite3PrngRestoreState(void); 19672fa1868fSdrh void sqlite3PrngResetState(void); 19689bb575fdSdrh void sqlite3RollbackAll(sqlite3*); 19694adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int); 1970684917c2Sdrh void sqlite3BeginTransaction(Parse*, int); 19714adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*); 19724adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*); 19734adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*); 19740a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*); 1975eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*); 19764adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*); 19774adee20fSdanielk1977 int sqlite3IsRowid(const char*); 19782d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int); 19792d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*); 1980e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int); 198104adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int, 198204adf416Sdrh int*,int,int,int,int); 198304adf416Sdrh void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int); 1984aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int); 19854adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int); 198617435752Sdrh Expr *sqlite3ExprDup(sqlite3*,Expr*); 198717435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*); 198817435752Sdrh ExprList *sqlite3ExprListDup(sqlite3*,ExprList*); 198917435752Sdrh SrcList *sqlite3SrcListDup(sqlite3*,SrcList*); 199017435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*); 199117435752Sdrh Select *sqlite3SelectDup(sqlite3*,Select*); 19929bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int); 19939bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*); 19949bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*); 19957e8b848aSdrh #ifdef SQLITE_DEBUG 19969bb575fdSdrh int sqlite3SafetyOn(sqlite3*); 19979bb575fdSdrh int sqlite3SafetyOff(sqlite3*); 19987e8b848aSdrh #else 19997e8b848aSdrh # define sqlite3SafetyOn(A) 0 20007e8b848aSdrh # define sqlite3SafetyOff(A) 0 20017e8b848aSdrh #endif 20027e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*); 20037e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*); 20049cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int); 2005f93d9999Sdrh void sqlite3MaterializeView(Parse*, Select*, Expr*, int); 2006b7f9164eSdrh 2007b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER 2008ef2cb63eSdanielk1977 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 200960218d2aSdrh Expr*,int, int); 20104adee20fSdanielk1977 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 2011fdd48a76Sdrh void sqlite3DropTrigger(Parse*, SrcList*, int); 201274161705Sdrh void sqlite3DropTriggerPtr(Parse*, Trigger*); 2013dca76841Sdrh int sqlite3TriggersExist(Parse*, Table*, int, ExprList*); 20144adee20fSdanielk1977 int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int, 20158f2c54e6Sdanielk1977 int, int, u32*, u32*); 2016dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 20174adee20fSdanielk1977 void sqlite3DeleteTriggerStep(TriggerStep*); 201817435752Sdrh TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*); 201917435752Sdrh TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*, 202017435752Sdrh ExprList*,Select*,int); 202117435752Sdrh TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int); 202217435752Sdrh TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*); 20234adee20fSdanielk1977 void sqlite3DeleteTrigger(Trigger*); 2024b7f9164eSdrh void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 2025b7f9164eSdrh #else 2026b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0 2027b7f9164eSdrh # define sqlite3DeleteTrigger(A) 2028cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B) 2029b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 20308f2c54e6Sdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0 2031b7f9164eSdrh #endif 2032b7f9164eSdrh 20334adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 20340202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 20354adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int); 2036ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 2037728b5779Sdrh void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 20384adee20fSdanielk1977 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 20394adee20fSdanielk1977 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 20404adee20fSdanielk1977 void sqlite3AuthContextPop(AuthContext*); 2041ed6c8671Sdrh #else 2042b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d) 20434adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 20444adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c) 20454adee20fSdanielk1977 # define sqlite3AuthContextPop(a) ((void)(a)) 2046ed6c8671Sdrh #endif 2047f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 2048f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*); 20499bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename, 205033f4e02aSdrh int omitJournal, int nCache, int flags, Btree **ppBtree); 20514adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 20524adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*); 20534adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*); 20544adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*); 20554adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*); 20564adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 2057487e262fSdrh int sqlite3AtoF(const char *z, double*); 20586f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...); 2059fec19aadSdrh int sqlite3GetInt32(const char *, int*); 2060598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int); 2061ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar); 2062ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte); 206366150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**); 20643f8d5cfcSshane 20653f8d5cfcSshane /* 20663f8d5cfcSshane ** Routines to read and write variable-length integers. These used to 20673f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c 2068952856adSshane ** file. Code should use the MACRO forms below, as the Varint32 versions 2069952856adSshane ** are coded to assume the single byte case is already handled (which 2070952856adSshane ** the MACRO form does). 20713f8d5cfcSshane */ 2072192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64); 207335b5a33eSdrh int sqlite3PutVarint32(unsigned char*, u32); 207490e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *); 20756d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *); 2076192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v); 20773f8d5cfcSshane 20783f8d5cfcSshane /* 20793f8d5cfcSshane ** The header of a record consists of a sequence variable-length integers. 20803f8d5cfcSshane ** These integers are almost always small and are encoded as a single byte. 20813f8d5cfcSshane ** The following macros take advantage this fact to provide a fast encode 20823f8d5cfcSshane ** and decode of the integers in a record header. It is faster for the common 20833f8d5cfcSshane ** case where the integer is a single byte. It is a little slower when the 20843f8d5cfcSshane ** integer is two or more bytes. But overall it is faster. 20853f8d5cfcSshane ** 20863f8d5cfcSshane ** The following expressions are equivalent: 20873f8d5cfcSshane ** 20883f8d5cfcSshane ** x = sqlite3GetVarint32( A, &B ); 20893f8d5cfcSshane ** x = sqlite3PutVarint32( A, B ); 20903f8d5cfcSshane ** 20913f8d5cfcSshane ** x = getVarint32( A, B ); 20923f8d5cfcSshane ** x = putVarint32( A, B ); 20933f8d5cfcSshane ** 20943f8d5cfcSshane */ 20953f8d5cfcSshane #define getVarint32(A,B) ((*(A)<(unsigned char)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), &(B))) 20963f8d5cfcSshane #define putVarint32(A,B) (((B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B))) 20973f8d5cfcSshane #define getVarint sqlite3GetVarint 20983f8d5cfcSshane #define putVarint sqlite3PutVarint 20993f8d5cfcSshane 21003f8d5cfcSshane 2101a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *); 2102a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *); 2103e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2); 2104e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity); 2105bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr); 2106b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*); 21079bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...); 2108ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 2109ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 2110f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int); 21118a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse); 21129bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int); 21130202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName); 21147cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr); 21158b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *); 21167cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *); 2117d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *); 2118b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int); 21194e6af134Sdanielk1977 2120b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8); 2121b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8); 2122b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 21231e536953Sdanielk1977 void(*)(void*)); 21244e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*); 21251e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *); 21261e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int); 21271e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 2128b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 212946c99e0fSdrh #ifndef SQLITE_AMALGAMATION 21304e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[]; 213140257ffdSdrh extern struct Sqlite3Config sqlite3Config; 213246c99e0fSdrh #endif 2133a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int); 21344343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*); 21351f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*); 21369fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 21379fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *); 21382958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...); 2139d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*); 21400cdc022eSdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *, int); 2141b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *); 2142aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int); 214319a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *); 214419a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 21454dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int); 21468a51256cSdrh char sqlite3AffinityType(const Token*); 21479f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*); 2148a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*); 2149ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*); 2150cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB); 215151147baaSdrh void sqlite3DefaultRowEst(Index*); 215255ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int); 2153d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 2154f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *); 2155fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int); 2156da184236Sdanielk1977 void sqlite3SchemaFree(void *); 21571e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 2158e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 2159b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *); 2160771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 2161771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), 2162771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*)); 216354f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int); 2164ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *); 216569dab1d3Sdrh 2166f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int); 2167ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int); 2168ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*); 2169ade86483Sdrh void sqlite3StrAccumReset(StrAccum*); 21701013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int); 21711e536953Sdanielk1977 217295bdbbbdSdrh /* 217395bdbbbdSdrh ** The interface to the LEMON-generated parser 217495bdbbbdSdrh */ 217595bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t)); 217695bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*)); 217795bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*); 217895bdbbbdSdrh 2179caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*); 218069dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION 2181f1952c5dSdrh void sqlite3CloseExtensions(sqlite3*); 218269dab1d3Sdrh #else 218369dab1d3Sdrh # define sqlite3CloseExtensions(X) 218469dab1d3Sdrh #endif 2185e3026636Sdanielk1977 2186c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 2187c00da105Sdanielk1977 void sqlite3TableLock(Parse *, int, int, u8, const char *); 2188c00da105Sdanielk1977 #else 2189c00da105Sdanielk1977 #define sqlite3TableLock(v,w,x,y,z) 2190c00da105Sdanielk1977 #endif 2191c00da105Sdanielk1977 219253c14021Sdrh #ifdef SQLITE_TEST 219353c14021Sdrh int sqlite3Utf8To8(unsigned char*); 219453c14021Sdrh #endif 219553c14021Sdrh 2196b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE 2197b9bb7c18Sdrh # define sqlite3VtabClear(X) 2198f9e7dda7Sdanielk1977 # define sqlite3VtabSync(X,Y) (Y) 2199f9e7dda7Sdanielk1977 # define sqlite3VtabRollback(X) 2200f9e7dda7Sdanielk1977 # define sqlite3VtabCommit(X) 2201b9bb7c18Sdrh #else 2202707205d1Sdrh void sqlite3VtabClear(Table*); 2203f9e7dda7Sdanielk1977 int sqlite3VtabSync(sqlite3 *db, int rc); 2204f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db); 2205f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db); 2206b9bb7c18Sdrh #endif 22074f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*); 2208189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*); 2209a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*); 2210b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*); 2211b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*); 2212b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*); 2213b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*); 221478efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 22157e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*); 22169e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 2217f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *); 22181e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 2219b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**); 2220b900aaf3Sdrh int sqlite3Reprepare(Vdbe*); 2221b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 2222bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *); 2223b9bb7c18Sdrh 2224643167ffSdrh 2225643167ffSdrh /* 2226643167ffSdrh ** Available fault injectors. Should be numbered beginning with 0. 2227643167ffSdrh */ 2228643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC 0 22297e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT 1 2230643167ffSdrh 2231643167ffSdrh /* 2232ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign" 2233ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST 2234ef05f2dfSdanielk1977 ** is not defined. 2235643167ffSdrh */ 22363088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST 22372d1d86fbSdanielk1977 void sqlite3BeginBenignMalloc(void); 22382d1d86fbSdanielk1977 void sqlite3EndBenignMalloc(void); 2239643167ffSdrh #else 22402d1d86fbSdanielk1977 #define sqlite3BeginBenignMalloc() 2241867d05a0Sdanielk1977 #define sqlite3EndBenignMalloc() 2242643167ffSdrh #endif 2243643167ffSdrh 22449a96b668Sdanielk1977 #define IN_INDEX_ROWID 1 22459a96b668Sdanielk1977 #define IN_INDEX_EPH 2 22469a96b668Sdanielk1977 #define IN_INDEX_INDEX 3 22470cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int*); 22489a96b668Sdanielk1977 2249c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE 2250c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 2251c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *); 2252f55b8998Sdanielk1977 int sqlite3JournalCreate(sqlite3_file *); 2253c7b6017cSdanielk1977 #else 2254c7b6017cSdanielk1977 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile) 2255c7b6017cSdanielk1977 #endif 2256c7b6017cSdanielk1977 22570224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 22584b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p); 2259fc976065Sdanielk1977 int sqlite3SelectExprHeight(Select *); 2260fc976065Sdanielk1977 #else 22614b5255acSdanielk1977 #define sqlite3ExprSetHeight(x,y) 22620224d26dSdrh #define sqlite3SelectExprHeight(x) 0 2263fc976065Sdanielk1977 #endif 2264fc976065Sdanielk1977 2265a3152895Sdrh u32 sqlite3Get4byte(const u8*); 2266a3152895Sdrh void sqlite3Put4byte(u8*, u32); 2267a3152895Sdrh 2268fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE 2269fd9a0a45Sdanielk1977 #include "sseInt.h" 2270fd9a0a45Sdanielk1977 #endif 2271fd9a0a45Sdanielk1977 22726e736838Sdrh #ifdef SQLITE_DEBUG 22736e736838Sdrh void sqlite3ParserTrace(FILE*, char *); 22746e736838Sdrh #endif 22756e736838Sdrh 2276b0603416Sdrh /* 2277b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable 22783a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to 2279b0603416Sdrh ** print I/O tracing messages. 2280b0603416Sdrh */ 2281b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE 22823a00f907Smlcreech # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 2283b4622b60Sdanielk1977 void sqlite3VdbeIOTraceSql(Vdbe*); 2284e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...); 2285b0603416Sdrh #else 2286b0603416Sdrh # define IOTRACE(A) 2287b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X) 2288b0603416Sdrh #endif 2289b0603416Sdrh 2290e3026636Sdanielk1977 #endif 2291