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 ** 1475897234Sdrh */ 15e3026636Sdanielk1977 #ifndef _SQLITEINT_H_ 16e3026636Sdanielk1977 #define _SQLITEINT_H_ 1771674ce9Sdrh 18bd0ae111Smlcreech /* 192210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the 202210dcc6Sdrh ** underlying operating system supports it. If the OS lacks 212210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops. 222210dcc6Sdrh ** 232210dcc6Sdrh ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 242210dcc6Sdrh ** system #includes. Hence, this block of code must be the very first 252210dcc6Sdrh ** code in all source files. 262210dcc6Sdrh ** 272210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 282210dcc6Sdrh ** on the compiler command line. This is necessary if you are compiling 292210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work 302210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2 312210dcc6Sdrh ** without this option, LFS is enable. But LFS does not exist in the kernel 322210dcc6Sdrh ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary 332210dcc6Sdrh ** portability you should omit LFS. 342210dcc6Sdrh ** 35dddf6978Sdrh ** The previous paragraph was written in 2005. (This paragraph is written 36dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so 37dddf6978Sdrh ** you should probably leave LFS enabled. But some embedded platforms might 38dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful. 39dddf6978Sdrh ** 402210dcc6Sdrh ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later. 412210dcc6Sdrh */ 422210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS 432210dcc6Sdrh # define _LARGE_FILE 1 442210dcc6Sdrh # ifndef _FILE_OFFSET_BITS 452210dcc6Sdrh # define _FILE_OFFSET_BITS 64 462210dcc6Sdrh # endif 472210dcc6Sdrh # define _LARGEFILE_SOURCE 1 482210dcc6Sdrh #endif 492210dcc6Sdrh 502210dcc6Sdrh /* 51a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its 52a7b3b635Smistachkin ** version information, among other things. Normally, this internal MinGW 53a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header 54a7b3b635Smistachkin ** files; however, the contained version information is now required by this 55a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and 56a7b3b635Smistachkin ** this is the only known way to reliably obtain it. This entire #if block 57a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting 58a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define 59a7b3b635Smistachkin ** some MinGW-specific macros). When compiling for MinGW, either the 60a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be 61a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be 62a7b3b635Smistachkin ** disabled. 63a7b3b635Smistachkin */ 64a7b3b635Smistachkin #if defined(_HAVE_MINGW_H) 65a7b3b635Smistachkin # include "mingw.h" 66a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H) 67a7b3b635Smistachkin # include "_mingw.h" 68a7b3b635Smistachkin #endif 69a7b3b635Smistachkin 70a7b3b635Smistachkin /* 71a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T 72a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime 73a7b3b635Smistachkin ** library in use (e.g. for Windows XP). 74a7b3b635Smistachkin */ 75a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \ 76a7b3b635Smistachkin defined(_WIN32) && !defined(_WIN64) && \ 7765acf373Smistachkin defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \ 78a7b3b635Smistachkin defined(__MSVCRT__) 79a7b3b635Smistachkin # define _USE_32BIT_TIME_T 80a7b3b635Smistachkin #endif 81a7b3b635Smistachkin 825e990beaSdrh /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear 830d71d121Smistachkin ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for 840d71d121Smistachkin ** MinGW. 855e990beaSdrh */ 865e990beaSdrh #include "sqlite3.h" 875e990beaSdrh 88bd0ae111Smlcreech /* 891e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the 901e12d43bSmlcreech ** autoconf-based build 91bd0ae111Smlcreech */ 921e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H 9398dc4b1aSmlcreech #include "config.h" 941e12d43bSmlcreech #endif 951e12d43bSmlcreech 96bb4957f8Sdrh #include "sqliteLimit.h" 9798dc4b1aSmlcreech 98e2965827Sdrh /* Disable nuisance warnings on Borland compilers */ 99e2965827Sdrh #if defined(__BORLANDC__) 100e2965827Sdrh #pragma warn -rch /* unreachable code */ 101e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */ 102e2965827Sdrh #pragma warn -aus /* Assigned value is never used */ 103e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */ 104467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */ 105e2965827Sdrh #endif 106e2965827Sdrh 10798dc4b1aSmlcreech /* Needed for various definitions... */ 10860323418Sdrh #ifndef _GNU_SOURCE 10998dc4b1aSmlcreech # define _GNU_SOURCE 11060323418Sdrh #endif 11198dc4b1aSmlcreech 112881bd792Sdan #if defined(__OpenBSD__) && !defined(_BSD_SOURCE) 113881bd792Sdan # define _BSD_SOURCE 114881bd792Sdan #endif 115881bd792Sdan 11698dc4b1aSmlcreech /* 11706af763eSdrh ** Include standard header files as necessary 11806af763eSdrh */ 11906af763eSdrh #ifdef HAVE_STDINT_H 12006af763eSdrh #include <stdint.h> 12106af763eSdrh #endif 12206af763eSdrh #ifdef HAVE_INTTYPES_H 12306af763eSdrh #include <inttypes.h> 12406af763eSdrh #endif 12506af763eSdrh 126a2460e07Sdrh /* 127c05a9a8aSdrh ** The following macros are used to cast pointers to integers and 128c05a9a8aSdrh ** integers to pointers. The way you do this varies from one compiler 129c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements 130c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers. 131875e9e7dSdrh ** 132c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type. 133c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or 134c05a9a8aSdrh ** if it is available, it requires an #include of specific headers 135c92271c5Sdrh ** that vary from one machine to the next. 136875e9e7dSdrh ** 137875e9e7dSdrh ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 138875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 1395e49edcaSdrh ** So we have to define the macros in different ways depending on the 140875e9e7dSdrh ** compiler. 1411fc4129dSshane */ 142c05a9a8aSdrh #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 143c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 144c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 145c05a9a8aSdrh #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 146c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 147c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 148c05a9a8aSdrh #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 149367882c2Sdrh # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 150367882c2Sdrh # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 151c05a9a8aSdrh #else /* Generates a warning - but it always works */ 152875e9e7dSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 153875e9e7dSdrh # define SQLITE_PTR_TO_INT(X) ((int)(X)) 154367882c2Sdrh #endif 15571674ce9Sdrh 156e5e7a901Sdrh /* 15714a924a5Sdrh ** A macro to hint to the compiler that a function should not be 15814a924a5Sdrh ** inlined. 15914a924a5Sdrh */ 16014a924a5Sdrh #if defined(__GNUC__) 16114a924a5Sdrh # define SQLITE_NOINLINE __attribute__((noinline)) 16214a924a5Sdrh #elif defined(_MSC_VER) 16314a924a5Sdrh # define SQLITE_NOINLINE __declspec(noinline) 16414a924a5Sdrh #else 16514a924a5Sdrh # define SQLITE_NOINLINE 16614a924a5Sdrh #endif 16714a924a5Sdrh 16814a924a5Sdrh /* 16938c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 17038c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never 17138c67c36Sdrh ** threadsafe. 1 means the library is serialized which is the highest 172f7b5496eSdrh ** level of threadsafety. 2 means the library is multithreaded - multiple 17338c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same 17438c67c36Sdrh ** database connection at the same time. 17538c67c36Sdrh ** 176e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro. 17738c67c36Sdrh ** We support that for legacy. 178e5e7a901Sdrh */ 179e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE) 180e5e7a901Sdrh # if defined(THREADSAFE) 181e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE 182e5e7a901Sdrh # else 18338c67c36Sdrh # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 184e5e7a901Sdrh # endif 185e5e7a901Sdrh #endif 186e5e7a901Sdrh 18767080617Sdrh /* 188cb15f35fSdrh ** Powersafe overwrite is on by default. But can be turned off using 189cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option. 190cb15f35fSdrh */ 191cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE 192cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1 193cb15f35fSdrh #endif 194cb15f35fSdrh 195cb15f35fSdrh /* 1960a732f59Sdanielk1977 ** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1. 1970a732f59Sdanielk1977 ** It determines whether or not the features related to 198467bcf36Sshane ** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can 1990a732f59Sdanielk1977 ** be overridden at runtime using the sqlite3_config() API. 2000a732f59Sdanielk1977 */ 2010a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 2020a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1 2030a732f59Sdanielk1977 #endif 2040a732f59Sdanielk1977 2050a732f59Sdanielk1977 /* 2060d18020bSdrh ** Exactly one of the following macros must be defined in order to 2070d18020bSdrh ** specify which memory allocation subsystem to use. 2080d18020bSdrh ** 2090d18020bSdrh ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 2101b186a99Smistachkin ** SQLITE_WIN32_MALLOC // Use Win32 native heap API 211d1b0afc3Sdrh ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails 2120d18020bSdrh ** SQLITE_MEMDEBUG // Debugging version of system malloc() 213a2460e07Sdrh ** 214753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the 215753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem 216753c5444Smistachkin ** will cause HeapValidate to be called. If heap validation should fail, an 217753c5444Smistachkin ** assertion will be triggered. 218753c5444Smistachkin ** 2190d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 2200d18020bSdrh ** the default. 2210d18020bSdrh */ 222d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 223d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 224d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 225d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)>1 226d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\ 22720b1ff07Smistachkin are defined but at most one is allowed:\ 228d1b0afc3Sdrh SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\ 229d1b0afc3Sdrh SQLITE_ZERO_MALLOC" 2300d18020bSdrh #endif 231d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 232d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 233d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 234d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)==0 2350d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1 2360d18020bSdrh #endif 2370d18020bSdrh 2380d18020bSdrh /* 2398a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 240eee4c8caSdrh ** sizes of memory allocations below this value where possible. 241eee4c8caSdrh */ 2428a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 243eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024 244eee4c8caSdrh #endif 245eee4c8caSdrh 246eee4c8caSdrh /* 24767080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable 24840b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD. 24940b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit 25040b521f8Sdrh ** it. 25167080617Sdrh */ 25240b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) 25340b521f8Sdrh # define _XOPEN_SOURCE 600 25467080617Sdrh #endif 255e3026636Sdanielk1977 2567d10d5a6Sdrh /* 2571b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that 2581b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true, 2591b28b893Sdrh ** make it true by defining or undefining NDEBUG. 2601b28b893Sdrh ** 261443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the 262443dbcf5Sdrh ** assert() statements in the code. So we want the default action 2631b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG 2641b28b893Sdrh ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out 2654b529d97Sdrh ** feature. 2664b529d97Sdrh */ 267289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 2684b529d97Sdrh # define NDEBUG 1 2694b529d97Sdrh #endif 2701b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG) 2711b28b893Sdrh # undef NDEBUG 2721b28b893Sdrh #endif 2734b529d97Sdrh 2746402250eSdrh /* 275c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on. 276c7379ce4Sdrh */ 277c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG) 278c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1 279c7379ce4Sdrh #endif 280c7379ce4Sdrh 281c7379ce4Sdrh /* 28247c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing. When 28347c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to 28447c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to 28547c3b3e0Sdrh ** get full branch coverage. The testcase() macro is inserted 28647c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple 28747c3b3e0Sdrh ** condition/decision coverage is inadequate. For example, testcase() 28847c3b3e0Sdrh ** can be used to make sure boundary values are tested. For 28947c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit 29047c3b3e0Sdrh ** is significant and used at least once. On switch statements 29147c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase() 29247c3b3e0Sdrh ** can insure that all cases are evaluated. 29347c3b3e0Sdrh ** 29447c3b3e0Sdrh */ 29547c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST 29647c3b3e0Sdrh void sqlite3Coverage(int); 29747c3b3e0Sdrh # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 29847c3b3e0Sdrh #else 29947c3b3e0Sdrh # define testcase(X) 3008f941bc7Sdrh #endif 3018f941bc7Sdrh 3028f941bc7Sdrh /* 3038f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or 3048f941bc7Sdrh ** other bits of code that are needed to support the arguments 3058f941bc7Sdrh ** within testcase() and assert() macros. 3068f941bc7Sdrh */ 3078f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 3088f941bc7Sdrh # define TESTONLY(X) X 3098f941bc7Sdrh #else 31047c3b3e0Sdrh # define TESTONLY(X) 31147c3b3e0Sdrh #endif 31247c3b3e0Sdrh 31347c3b3e0Sdrh /* 3146149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization 3156149526cSdrh ** to setup for a later assert() statement. We do not want this code to 3166149526cSdrh ** appear when assert() is disabled. The following macro is therefore 3176149526cSdrh ** used to contain that setup code. The "VVA" acronym stands for 3186149526cSdrh ** "Verification, Validation, and Accreditation". In other words, the 3196149526cSdrh ** code within VVA_ONLY() will only run during verification processes. 3206149526cSdrh */ 3216149526cSdrh #ifndef NDEBUG 3226149526cSdrh # define VVA_ONLY(X) X 3236149526cSdrh #else 3246149526cSdrh # define VVA_ONLY(X) 3256149526cSdrh #endif 3266149526cSdrh 3276149526cSdrh /* 32847c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which 32947c3b3e0Sdrh ** are intended to always be true or false, respectively. Such 33047c3b3e0Sdrh ** expressions could be omitted from the code completely. But they 33147c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience 33247c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing" 33347c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first 33447c3b3e0Sdrh ** hint of unplanned behavior. 33547c3b3e0Sdrh ** 33647c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code. 33747c3b3e0Sdrh ** 33847c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to 339443dbcf5Sdrh ** be true and false so that the unreachable code they specify will 34047c3b3e0Sdrh ** not be counted as untested code. 34147c3b3e0Sdrh */ 34247c3b3e0Sdrh #if defined(SQLITE_COVERAGE_TEST) 34347c3b3e0Sdrh # define ALWAYS(X) (1) 34447c3b3e0Sdrh # define NEVER(X) (0) 34547c3b3e0Sdrh #elif !defined(NDEBUG) 3462de80f4cSdrh # define ALWAYS(X) ((X)?1:(assert(0),0)) 3472de80f4cSdrh # define NEVER(X) ((X)?(assert(0),1):0) 34847c3b3e0Sdrh #else 34947c3b3e0Sdrh # define ALWAYS(X) (X) 35047c3b3e0Sdrh # define NEVER(X) (X) 35147c3b3e0Sdrh #endif 35247c3b3e0Sdrh 35347c3b3e0Sdrh /* 3543e8e7ecbSdrh ** Return true (non-zero) if the input is a integer that is too large 3553e8e7ecbSdrh ** to fit in 32-bits. This macro is used inside of various testcase() 3563e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support. 3573e8e7ecbSdrh */ 358b31a6afaSdan #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 3593e8e7ecbSdrh 3603e8e7ecbSdrh /* 36147c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean 36247c3b3e0Sdrh ** expression that is usually false. Macro likely() surrounds 363443dbcf5Sdrh ** a boolean expression that is usually true. These hints could, 364443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but 365443dbcf5Sdrh ** currently they are just comments for human readers. 36647c3b3e0Sdrh */ 367443dbcf5Sdrh #define likely(X) (X) 368443dbcf5Sdrh #define unlikely(X) (X) 36947c3b3e0Sdrh 370beae3194Sdrh #include "hash.h" 37175897234Sdrh #include "parse.h" 37275897234Sdrh #include <stdio.h> 37375897234Sdrh #include <stdlib.h> 37475897234Sdrh #include <string.h> 37575897234Sdrh #include <assert.h> 37652370e2cSdrh #include <stddef.h> 37775897234Sdrh 378967e8b73Sdrh /* 379b37df7b9Sdrh ** If compiling for a processor that lacks floating point support, 380b37df7b9Sdrh ** substitute integer for floating-point 381b37df7b9Sdrh */ 382b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT 383b37df7b9Sdrh # define double sqlite_int64 3848b307fbfSdrh # define float sqlite_int64 385b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64 386d1167393Sdrh # ifndef SQLITE_BIG_DBL 387cdaca55eSdrh # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 388d1167393Sdrh # endif 389b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1 390b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1 391110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 3920b3bf924Sdrh # undef SQLITE_HAVE_ISNAN 393b37df7b9Sdrh #endif 394d1167393Sdrh #ifndef SQLITE_BIG_DBL 395d1167393Sdrh # define SQLITE_BIG_DBL (1e99) 396d1167393Sdrh #endif 397b37df7b9Sdrh 398b37df7b9Sdrh /* 39953c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 40053c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler 40153c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements. 40253c0f748Sdanielk1977 */ 40353c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB 40453c0f748Sdanielk1977 #define OMIT_TEMPDB 1 40553c0f748Sdanielk1977 #else 40653c0f748Sdanielk1977 #define OMIT_TEMPDB 0 40753c0f748Sdanielk1977 #endif 40853c0f748Sdanielk1977 40953c0f748Sdanielk1977 /* 410d946db00Sdrh ** The "file format" number is an integer that is incremented whenever 411d946db00Sdrh ** the VDBE-level file format changes. The following macros define the 412d946db00Sdrh ** the default file format for new databases and the maximum file format 413d946db00Sdrh ** that the library can read. 414d946db00Sdrh */ 415d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4 416d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT 417bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4 418d946db00Sdrh #endif 419d946db00Sdrh 420a2460e07Sdrh /* 421a2460e07Sdrh ** Determine whether triggers are recursive by default. This can be 422a2460e07Sdrh ** changed at run-time using a pragma. 423a2460e07Sdrh */ 4245bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 4255bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 4265bde73c4Sdan #endif 4275bde73c4Sdan 428d946db00Sdrh /* 429b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 43049766d6cSdrh ** on the command-line 43149766d6cSdrh */ 432b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE 433b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1 434d16d0bc5Sdrh # define SQLITE_TEMP_STORE_xc 1 /* Exclude from ctime.c */ 43549766d6cSdrh #endif 43649766d6cSdrh 43749766d6cSdrh /* 438f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it 439f1974846Sdrh ** ourselves. 440f1974846Sdrh */ 441f1974846Sdrh #ifndef offsetof 442f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 443f1974846Sdrh #endif 444f1974846Sdrh 445f1974846Sdrh /* 446e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers. 447e1e2e9acSdrh */ 448e1e2e9acSdrh #define MIN(A,B) ((A)<(B)?(A):(B)) 449e1e2e9acSdrh #define MAX(A,B) ((A)>(B)?(A):(B)) 450e1e2e9acSdrh 451e1e2e9acSdrh /* 4529b8f447bSdrh ** Check to see if this machine uses EBCDIC. (Yes, believe it or 4539b8f447bSdrh ** not, there are still machines out there that use EBCDIC.) 4549b8f447bSdrh */ 4559b8f447bSdrh #if 'A' == '\301' 4569b8f447bSdrh # define SQLITE_EBCDIC 1 4579b8f447bSdrh #else 4589b8f447bSdrh # define SQLITE_ASCII 1 4599b8f447bSdrh #endif 4609b8f447bSdrh 4619b8f447bSdrh /* 4625a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 4635a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 4645a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 4655a2c2c20Sdrh ** 4665a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 46741a2b48bSdrh */ 4685a2c2c20Sdrh #ifndef UINT32_TYPE 469dda5b68cSmlcreech # ifdef HAVE_UINT32_T 470dda5b68cSmlcreech # define UINT32_TYPE uint32_t 471dda5b68cSmlcreech # else 4725a2c2c20Sdrh # define UINT32_TYPE unsigned int 4735a2c2c20Sdrh # endif 474dda5b68cSmlcreech #endif 4755a2c2c20Sdrh #ifndef UINT16_TYPE 476dda5b68cSmlcreech # ifdef HAVE_UINT16_T 477dda5b68cSmlcreech # define UINT16_TYPE uint16_t 478dda5b68cSmlcreech # else 4795a2c2c20Sdrh # define UINT16_TYPE unsigned short int 4805a2c2c20Sdrh # endif 481dda5b68cSmlcreech #endif 482939a16d6Sdrh #ifndef INT16_TYPE 483dda5b68cSmlcreech # ifdef HAVE_INT16_T 484dda5b68cSmlcreech # define INT16_TYPE int16_t 485dda5b68cSmlcreech # else 486939a16d6Sdrh # define INT16_TYPE short int 487939a16d6Sdrh # endif 488dda5b68cSmlcreech #endif 4895a2c2c20Sdrh #ifndef UINT8_TYPE 490dda5b68cSmlcreech # ifdef HAVE_UINT8_T 491dda5b68cSmlcreech # define UINT8_TYPE uint8_t 492dda5b68cSmlcreech # else 4935a2c2c20Sdrh # define UINT8_TYPE unsigned char 4945a2c2c20Sdrh # endif 495dda5b68cSmlcreech #endif 496905793e2Sdrh #ifndef INT8_TYPE 497dda5b68cSmlcreech # ifdef HAVE_INT8_T 498dda5b68cSmlcreech # define INT8_TYPE int8_t 499dda5b68cSmlcreech # else 500905793e2Sdrh # define INT8_TYPE signed char 501905793e2Sdrh # endif 502dda5b68cSmlcreech #endif 503efad9995Sdrh #ifndef LONGDOUBLE_TYPE 504efad9995Sdrh # define LONGDOUBLE_TYPE long double 505efad9995Sdrh #endif 506efad9995Sdrh typedef sqlite_int64 i64; /* 8-byte signed integer */ 50727436af7Sdrh typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 5085a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 5095a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 510939a16d6Sdrh typedef INT16_TYPE i16; /* 2-byte signed integer */ 5115a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 51270a8ca3cSdrh typedef INT8_TYPE i8; /* 1-byte signed integer */ 5135a2c2c20Sdrh 5145a2c2c20Sdrh /* 51535cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 51635cd643cSdrh ** that can be stored in a u32 without loss of data. The value 51735cd643cSdrh ** is 0x00000000ffffffff. But because of quirks of some compilers, we 51835cd643cSdrh ** have to specify the value in the less intuitive manner shown: 51935cd643cSdrh */ 52035cd643cSdrh #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 52135cd643cSdrh 52235cd643cSdrh /* 523faacf17cSdrh ** The datatype used to store estimates of the number of rows in a 524faacf17cSdrh ** table or index. This is an unsigned integer type. For 99.9% of 525faacf17cSdrh ** the world, a 32-bit integer is sufficient. But a 64-bit integer 526faacf17cSdrh ** can be used at compile-time if desired. 527faacf17cSdrh */ 528faacf17cSdrh #ifdef SQLITE_64BIT_STATS 529faacf17cSdrh typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */ 530faacf17cSdrh #else 531faacf17cSdrh typedef u32 tRowcnt; /* 32-bit is the default */ 532faacf17cSdrh #endif 533faacf17cSdrh 534faacf17cSdrh /* 535bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit 536bf539c4dSdrh ** logarithms. For quantity X, the value stored is 10*log2(X). This 537bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986. 538bf539c4dSdrh ** But the allowed values are "grainy". Not every value is representable. 539bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst 540224155ddSdrh ** of 40. However, since LogEst quantaties are suppose to be estimates, 541bf539c4dSdrh ** not exact values, this imprecision is not a problem. 542bf539c4dSdrh ** 543224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate". 544bf539c4dSdrh ** 545bf539c4dSdrh ** Examples: 546bf539c4dSdrh ** 1 -> 0 20 -> 43 10000 -> 132 547bf539c4dSdrh ** 2 -> 10 25 -> 46 25000 -> 146 548bf539c4dSdrh ** 3 -> 16 100 -> 66 1000000 -> 199 549bf539c4dSdrh ** 4 -> 20 1000 -> 99 1048576 -> 200 550bf539c4dSdrh ** 10 -> 33 1024 -> 100 4294967296 -> 320 551bf539c4dSdrh ** 552bf539c4dSdrh ** The LogEst can be negative to indicate fractional values. 553bf539c4dSdrh ** Examples: 554bf539c4dSdrh ** 555bf539c4dSdrh ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40 556bf539c4dSdrh */ 557bf539c4dSdrh typedef INT16_TYPE LogEst; 558bf539c4dSdrh 559bf539c4dSdrh /* 560bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian, 56171794dbaSdrh ** and whether or not that determination is run-time or compile-time. 56271794dbaSdrh ** 56371794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order 56471794dbaSdrh ** using C-preprocessor macros. If that is unsuccessful, or if 56571794dbaSdrh ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined 56671794dbaSdrh ** at run-time. 567bbd42a6dSdrh */ 56846c99e0fSdrh #ifdef SQLITE_AMALGAMATION 569b3190c15Sdrh const int sqlite3one = 1; 57046c99e0fSdrh #else 571bbd42a6dSdrh extern const int sqlite3one; 57246c99e0fSdrh #endif 57371794dbaSdrh #if (defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 57471794dbaSdrh defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \ 57571794dbaSdrh defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \ 57671794dbaSdrh defined(__arm__)) && !defined(SQLITE_RUNTIME_BYTEORDER) 5772cf4acbdSdrh # define SQLITE_BYTEORDER 1234 57838def054Sdrh # define SQLITE_BIGENDIAN 0 57938def054Sdrh # define SQLITE_LITTLEENDIAN 1 58038def054Sdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 58171794dbaSdrh #endif 58271794dbaSdrh #if (defined(sparc) || defined(__ppc__)) \ 58371794dbaSdrh && !defined(SQLITE_RUNTIME_BYTEORDER) 58471794dbaSdrh # define SQLITE_BYTEORDER 4321 58571794dbaSdrh # define SQLITE_BIGENDIAN 1 58671794dbaSdrh # define SQLITE_LITTLEENDIAN 0 58771794dbaSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16BE 58871794dbaSdrh #endif 58971794dbaSdrh #if !defined(SQLITE_BYTEORDER) 5902cf4acbdSdrh # define SQLITE_BYTEORDER 0 /* 0 means "unknown at compile-time" */ 5919c054830Sdrh # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 5929c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 59338def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 59438def054Sdrh #endif 595bbd42a6dSdrh 596bbd42a6dSdrh /* 5970f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers. 5980f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit 5990f050353Sdrh ** compilers. 6000f050353Sdrh */ 6010f050353Sdrh #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 6020f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 6030f050353Sdrh 6040f050353Sdrh /* 605be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8. This is used 606be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures. 607be229650Sdanielk1977 */ 608bc73971dSdanielk1977 #define ROUND8(x) (((x)+7)&~7) 609bc73971dSdanielk1977 610bc73971dSdanielk1977 /* 611bc73971dSdanielk1977 ** Round down to the nearest multiple of 8 612bc73971dSdanielk1977 */ 613bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7) 614be229650Sdanielk1977 615be229650Sdanielk1977 /* 6168e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary. This 6178e14c596Sdrh ** macro is used only within assert() to verify that the code gets 6188e14c596Sdrh ** all alignment restrictions correct. 6198e14c596Sdrh ** 6208e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 6218e14c596Sdrh ** underlying malloc() implemention might return us 4-byte aligned 6228e14c596Sdrh ** pointers. In that case, only verify 4-byte alignment. 623ea598cbdSdrh */ 6248e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 6258e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 6268e14c596Sdrh #else 627ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 6288e14c596Sdrh #endif 629ea598cbdSdrh 630188d4884Sdrh /* 6319b4c59faSdrh ** Disable MMAP on platforms where it is known to not work 632188d4884Sdrh */ 633188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__) 6349b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE 6359b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 636188d4884Sdrh #endif 637188d4884Sdrh 6389b4c59faSdrh /* 6399b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS 6409b4c59faSdrh */ 6419b4c59faSdrh #ifdef __APPLE__ 6429b4c59faSdrh # include <TargetConditionals.h> 6439b4c59faSdrh # if TARGET_OS_IPHONE 6449b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE 6459b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 6469b4c59faSdrh # endif 6479b4c59faSdrh #endif 6489b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE 6499b4c59faSdrh # if defined(__linux__) \ 6509b4c59faSdrh || defined(_WIN32) \ 6519b4c59faSdrh || (defined(__APPLE__) && defined(__MACH__)) \ 6529b4c59faSdrh || defined(__sun) 6532bba8c24Sdrh # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */ 6549b4c59faSdrh # else 6559b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 6569b4c59faSdrh # endif 657d16d0bc5Sdrh # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */ 6589b4c59faSdrh #endif 6599b4c59faSdrh 6609b4c59faSdrh /* 6619b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger 6629b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does 6639b4c59faSdrh ** not exceed the maximum mmap size. 6649b4c59faSdrh */ 6659b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE 6669b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0 667d16d0bc5Sdrh # define SQLITE_DEFAULT_MMAP_SIZE_xc 1 /* Exclude from ctime.c */ 6689b4c59faSdrh #endif 6699b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE 6709b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE 6719b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE 6729b4c59faSdrh #endif 673e7b34707Sdrh 674ea598cbdSdrh /* 6751435a9a1Sdrh ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined. 6761435a9a1Sdrh ** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also 6771435a9a1Sdrh ** define SQLITE_ENABLE_STAT3_OR_STAT4 6781435a9a1Sdrh */ 6791435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT4 6801435a9a1Sdrh # undef SQLITE_ENABLE_STAT3 6811435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1 6821435a9a1Sdrh #elif SQLITE_ENABLE_STAT3 6831435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1 6841435a9a1Sdrh #elif SQLITE_ENABLE_STAT3_OR_STAT4 6851435a9a1Sdrh # undef SQLITE_ENABLE_STAT3_OR_STAT4 6861435a9a1Sdrh #endif 6871435a9a1Sdrh 6881435a9a1Sdrh /* 68990f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler 69090f5ecb3Sdrh ** callback for a given sqlite handle. 69190f5ecb3Sdrh ** 69290f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy 69390f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite 69490f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 69590f5ecb3Sdrh ** callback is currently invoked only from within pager.c. 69690f5ecb3Sdrh */ 69790f5ecb3Sdrh typedef struct BusyHandler BusyHandler; 69890f5ecb3Sdrh struct BusyHandler { 69990f5ecb3Sdrh int (*xFunc)(void *,int); /* The busy callback */ 70090f5ecb3Sdrh void *pArg; /* First arg to busy callback */ 701a4afb65cSdrh int nBusy; /* Incremented with each busy call */ 70290f5ecb3Sdrh }; 70390f5ecb3Sdrh 70490f5ecb3Sdrh /* 70575897234Sdrh ** Name of the master database table. The master database table 70675897234Sdrh ** is a special table that holds the names and attributes of all 70775897234Sdrh ** user tables and indices. 70875897234Sdrh */ 70975897234Sdrh #define MASTER_NAME "sqlite_master" 710e0bc4048Sdrh #define TEMP_MASTER_NAME "sqlite_temp_master" 71175897234Sdrh 71275897234Sdrh /* 7138e150818Sdanielk1977 ** The root-page of the master database table. 7148e150818Sdanielk1977 */ 7158e150818Sdanielk1977 #define MASTER_ROOT 1 7168e150818Sdanielk1977 7178e150818Sdanielk1977 /* 718ed6c8671Sdrh ** The name of the schema table. 719ed6c8671Sdrh */ 72053c0f748Sdanielk1977 #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME) 721ed6c8671Sdrh 722ed6c8671Sdrh /* 72375897234Sdrh ** A convenience macro that returns the number of elements in 72475897234Sdrh ** an array. 72575897234Sdrh */ 72623432976Sdanielk1977 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 72775897234Sdrh 72875897234Sdrh /* 7297a5bcc0fSdrh ** Determine if the argument is a power of two 7307a5bcc0fSdrh */ 7317a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0) 7327a5bcc0fSdrh 7337a5bcc0fSdrh /* 734633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree(). 735aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the 736aa538a58Sdrh ** one parameter that destructors normally want. So we have to introduce 737aa538a58Sdrh ** this magic value that the code knows to handle differently. Any 738aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC 739aa538a58Sdrh ** and SQLITE_TRANSIENT. 740633e6d57Sdrh */ 741aa538a58Sdrh #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize) 742633e6d57Sdrh 74378f82d1eSdrh /* 74478f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 74578f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables. 74678f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from 74778f82d1eSdrh ** the heap. When WSD is unsupported, the variable declarations scattered 74878f82d1eSdrh ** throughout the SQLite code must become constants instead. The SQLITE_WSD 74978f82d1eSdrh ** macro is used for this purpose. And instead of referencing the variable 75078f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated 75178f82d1eSdrh ** buffer that holds real variable. The constant is also the initializer 75278f82d1eSdrh ** for the run-time allocated buffer. 75378f82d1eSdrh ** 7542479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 75578f82d1eSdrh ** macros become no-ops and have zero performance impact. 75678f82d1eSdrh */ 757075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD 758075c23afSdanielk1977 #define SQLITE_WSD const 759075c23afSdanielk1977 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 760075c23afSdanielk1977 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 761d1d38488Sdrh int sqlite3_wsd_init(int N, int J); 762d1d38488Sdrh void *sqlite3_wsd_find(void *K, int L); 763075c23afSdanielk1977 #else 764075c23afSdanielk1977 #define SQLITE_WSD 765075c23afSdanielk1977 #define GLOBAL(t,v) v 766075c23afSdanielk1977 #define sqlite3GlobalConfig sqlite3Config 767075c23afSdanielk1977 #endif 768075c23afSdanielk1977 769f3d3c27aSdanielk1977 /* 770f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to 771f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately 772f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when 773f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the 774f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the 775f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate, 776f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere. 777f3d3c27aSdanielk1977 ** 778f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function, 779f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 780f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to 781f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options. 782f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these 783f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions. 784f3d3c27aSdanielk1977 */ 78562c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x) 786f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 78762c14b34Sdanielk1977 788633e6d57Sdrh /* 78975897234Sdrh ** Forward references to structures 79075897234Sdrh */ 79113449892Sdrh typedef struct AggInfo AggInfo; 792fe05af87Sdrh typedef struct AuthContext AuthContext; 7930b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo; 794f5e7bb51Sdrh typedef struct Bitvec Bitvec; 795fe05af87Sdrh typedef struct CollSeq CollSeq; 7967020f651Sdrh typedef struct Column Column; 797fe05af87Sdrh typedef struct Db Db; 798e501b89aSdanielk1977 typedef struct Schema Schema; 79975897234Sdrh typedef struct Expr Expr; 80075897234Sdrh typedef struct ExprList ExprList; 801b7916a78Sdrh typedef struct ExprSpan ExprSpan; 802c2eef3b3Sdrh typedef struct FKey FKey; 803d2199f0fSdan typedef struct FuncDestructor FuncDestructor; 804fe05af87Sdrh typedef struct FuncDef FuncDef; 80570a8ca3cSdrh typedef struct FuncDefHash FuncDefHash; 806fe05af87Sdrh typedef struct IdList IdList; 807fe05af87Sdrh typedef struct Index Index; 80802fa4696Sdan typedef struct IndexSample IndexSample; 8098d059845Sdanielk1977 typedef struct KeyClass KeyClass; 810d3d39e93Sdrh typedef struct KeyInfo KeyInfo; 811633e6d57Sdrh typedef struct Lookaside Lookaside; 812633e6d57Sdrh typedef struct LookasideSlot LookasideSlot; 813d1ab1ba5Sdanielk1977 typedef struct Module Module; 814626a879aSdrh typedef struct NameContext NameContext; 815fe05af87Sdrh typedef struct Parse Parse; 816a5c1416dSdrh typedef struct PrintfArguments PrintfArguments; 817a2460e07Sdrh typedef struct RowSet RowSet; 818fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint; 819fe05af87Sdrh typedef struct Select Select; 820634d81deSdrh typedef struct SelectDest SelectDest; 821fe05af87Sdrh typedef struct SrcList SrcList; 822ade86483Sdrh typedef struct StrAccum StrAccum; 823fe05af87Sdrh typedef struct Table Table; 824c00da105Sdanielk1977 typedef struct TableLock TableLock; 825fe05af87Sdrh typedef struct Token Token; 826a2460e07Sdrh typedef struct Trigger Trigger; 8272832ad42Sdan typedef struct TriggerPrg TriggerPrg; 828fe05af87Sdrh typedef struct TriggerStep TriggerStep; 829e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord; 830595a523aSdanielk1977 typedef struct VTable VTable; 831b061d058Sdan typedef struct VtabCtx VtabCtx; 8327d10d5a6Sdrh typedef struct Walker Walker; 833fe05af87Sdrh typedef struct WhereInfo WhereInfo; 8347d562dbeSdan typedef struct With With; 835d3d39e93Sdrh 8362dca4ac1Sdanielk1977 /* 8372dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 8382dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 8392dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above. 8402dca4ac1Sdanielk1977 */ 8412dca4ac1Sdanielk1977 #include "btree.h" 8422dca4ac1Sdanielk1977 #include "vdbe.h" 8432dca4ac1Sdanielk1977 #include "pager.h" 8448c0a791aSdanielk1977 #include "pcache.h" 8452dca4ac1Sdanielk1977 8461cc5ed81Sdanielk1977 #include "os.h" 847c7ce76afSdrh #include "mutex.h" 8481cc5ed81Sdanielk1977 849eee4c8caSdrh 850001bbcbbSdrh /* 851001bbcbbSdrh ** Each database file to be accessed by the system is an instance 852001bbcbbSdrh ** of the following structure. There are normally two of these structures 853001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 854a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 855a69d9168Sdrh ** databases may be attached. 856001bbcbbSdrh */ 857001bbcbbSdrh struct Db { 858001bbcbbSdrh char *zName; /* Name of this database */ 859001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 860467bcf36Sshane u8 safety_level; /* How aggressive at syncing data to disk */ 861e501b89aSdanielk1977 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 862da184236Sdanielk1977 }; 863da184236Sdanielk1977 864da184236Sdanielk1977 /* 865da184236Sdanielk1977 ** An instance of the following structure stores a database schema. 8662120608eSdrh ** 8672120608eSdrh ** Most Schema objects are associated with a Btree. The exception is 8682120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 8692120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple 8702120608eSdrh ** Btrees that refer to the same underlying BtShared object. 8712120608eSdrh ** 8722120608eSdrh ** Schema objects are automatically deallocated when the last Btree that 8732120608eSdrh ** references them is destroyed. The TEMP Schema is manually freed by 8742120608eSdrh ** sqlite3_close(). 8752120608eSdrh * 8762120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order 8772120608eSdrh ** to access Schema content. This implies that the thread must also be 8782120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 87955a0959aSdrh ** For a TEMP Schema, only the connection mutex is required. 880da184236Sdanielk1977 */ 881e501b89aSdanielk1977 struct Schema { 882001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 883c2a75551Sdrh int iGeneration; /* Generation counter. Incremented with each change */ 884d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 885d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 886d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 8871da40a38Sdan Hash fkeyHash; /* All foreign keys by referenced table name */ 8884794f735Sdrh Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 889da184236Sdanielk1977 u8 file_format; /* Schema format version for this file */ 8908079a0d3Sdrh u8 enc; /* Text encoding used by this database */ 8912c5e35ffSdrh u16 schemaFlags; /* Flags associated with this schema */ 89214db2665Sdanielk1977 int cache_size; /* Number of pages to use in the cache */ 893001bbcbbSdrh }; 89475897234Sdrh 89575897234Sdrh /* 8968bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 897a2460e07Sdrh ** Db.pSchema->flags field. 8988bf8dc92Sdrh */ 8992c5e35ffSdrh #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P)) 9002c5e35ffSdrh #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0) 9012c5e35ffSdrh #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P) 9022c5e35ffSdrh #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P) 9038bf8dc92Sdrh 9048bf8dc92Sdrh /* 905a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field. 9068bf8dc92Sdrh ** 9078bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 9088bf8dc92Sdrh ** read into internal hash tables. 9098bf8dc92Sdrh ** 9108bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 9118bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 9128bf8dc92Sdrh ** changes and so the view will need to be reset. 9138bf8dc92Sdrh */ 914124b27e6Sdrh #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 915124b27e6Sdrh #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 916b82e7edaSdanielk1977 #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */ 9178bf8dc92Sdrh 918caa639f4Sdrh /* 919caa639f4Sdrh ** The number of different kinds of things that can be limited 920caa639f4Sdrh ** using the sqlite3_limit() interface. 921caa639f4Sdrh */ 922417168adSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_TRIGGER_DEPTH+1) 9238bf8dc92Sdrh 9248bf8dc92Sdrh /* 925633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used 926467bcf36Sshane ** to satisfy small transient memory allocation requests for objects 927633e6d57Sdrh ** associated with a particular database connection. The use of 928633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement 929633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing 930633e6d57Sdrh ** SQL statements. 931633e6d57Sdrh ** 932633e6d57Sdrh ** The Lookaside structure holds configuration information about the 933633e6d57Sdrh ** lookaside malloc subsystem. Each available memory allocation in 934633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot 935633e6d57Sdrh ** objects. 936d9da78a2Sdrh ** 937d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated 938d9da78a2Sdrh ** with a particular database connection. Hence, schema information cannot 939d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information 940d9da78a2Sdrh ** is shared by multiple database connections. Therefore, while parsing 941d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that 942d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects. 943633e6d57Sdrh */ 944633e6d57Sdrh struct Lookaside { 945633e6d57Sdrh u16 sz; /* Size of each buffer in bytes */ 946d9da78a2Sdrh u8 bEnabled; /* False to disable new lookaside allocations */ 947e9d1c720Sdrh u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 948633e6d57Sdrh int nOut; /* Number of buffers currently checked out */ 949633e6d57Sdrh int mxOut; /* Highwater mark for nOut */ 9500b12e7f8Sdrh int anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 9517d10d5a6Sdrh LookasideSlot *pFree; /* List of available buffers */ 952633e6d57Sdrh void *pStart; /* First byte of available memory space */ 953633e6d57Sdrh void *pEnd; /* First byte past end of available space */ 954633e6d57Sdrh }; 955633e6d57Sdrh struct LookasideSlot { 956633e6d57Sdrh LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 957633e6d57Sdrh }; 958633e6d57Sdrh 959633e6d57Sdrh /* 96070a8ca3cSdrh ** A hash table for function definitions. 96170a8ca3cSdrh ** 96270a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 96370a8ca3cSdrh ** Collisions are on the FuncDef.pHash chain. 96470a8ca3cSdrh */ 96570a8ca3cSdrh struct FuncDefHash { 96670a8ca3cSdrh FuncDef *a[23]; /* Hash table for functions */ 96770a8ca3cSdrh }; 96870a8ca3cSdrh 96970a8ca3cSdrh /* 970a2460e07Sdrh ** Each database connection is an instance of the following structure. 97175897234Sdrh */ 9729bb575fdSdrh struct sqlite3 { 97390f6a5beSdrh sqlite3_vfs *pVfs; /* OS Interface */ 974a451017dSdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 975a451017dSdrh CollSeq *pDfltColl; /* The default collating sequence (BINARY) */ 976a451017dSdrh sqlite3_mutex *mutex; /* Connection mutex */ 977001bbcbbSdrh Db *aDb; /* All backends */ 978a451017dSdrh int nDb; /* Number of backends currently in use */ 979467bcf36Sshane int flags; /* Miscellaneous flags. See below */ 980a451017dSdrh i64 lastRowid; /* ROWID of most recent insert (see above) */ 9819b4c59faSdrh i64 szMmap; /* Default mmap_size setting */ 982522c26fbSdrh unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 983fcd35c7bSdrh int errCode; /* Most recent error code (SQLITE_*) */ 9844ac285a1Sdrh int errMask; /* & result codes with this before returning */ 985a5759677Sdrh u16 dbOptFlags; /* Flags to enable/disable optimizations */ 986fcd35c7bSdrh u8 autoCommit; /* The auto-commit flag. */ 98790f5ecb3Sdrh u8 temp_store; /* 1: file 2: memory 0: default */ 98817435752Sdrh u8 mallocFailed; /* True if we have seen a malloc failure */ 9893b02013eSdrh u8 dfltLockMode; /* Default locking-mode for attached dbs */ 99098757157Sdrh signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 991a7564663Sdrh u8 suppressErr; /* Do not issue error messages if true */ 992b061d058Sdan u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */ 993a451017dSdrh u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 994f653d782Sdanielk1977 int nextPagesize; /* Pagesize after VACUUM if >0 */ 99564202cfeSdanielk1977 u32 magic; /* Magic number for detect library misuse */ 996b28af71aSdanielk1977 int nChange; /* Value returned by sqlite3_changes() */ 997b28af71aSdanielk1977 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 998caa639f4Sdrh int aLimit[SQLITE_N_LIMIT]; /* Limits */ 9994adee20fSdanielk1977 struct sqlite3InitInfo { /* Information used during initialization */ 10001d85d931Sdrh int newTnum; /* Rootpage of table being initialized */ 1001a451017dSdrh u8 iDb; /* Which db file is being initialized */ 10021d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 10033d5f74b2Sdrh u8 orphanTrigger; /* Last statement is orphaned TEMP trigger */ 10041d85d931Sdrh } init; 10051713afb0Sdrh int nVdbeActive; /* Number of VDBEs currently running */ 10064f7d3a5fSdrh int nVdbeRead; /* Number of active VDBEs that read or write */ 10074f7d3a5fSdrh int nVdbeWrite; /* Number of active VDBEs that read and write */ 10084f7d3a5fSdrh int nVdbeExec; /* Number of nested calls to VdbeExec() */ 1009a451017dSdrh int nExtension; /* Number of loaded extensions */ 1010a451017dSdrh void **aExtension; /* Array of shared library handles */ 101118de4824Sdrh void (*xTrace)(void*,const char*); /* Trace function */ 101218de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 101319e2d37fSdrh void (*xProfile)(void*,const char*,u64); /* Profiling function */ 101419e2d37fSdrh void *pProfileArg; /* Argument to profile function */ 1015fcd35c7bSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 1016fcd35c7bSdrh int (*xCommitCallback)(void*); /* Invoked at every commit. */ 101771fd80bfSdanielk1977 void *pRollbackArg; /* Argument to xRollbackCallback() */ 101871fd80bfSdanielk1977 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 101994eb6a14Sdanielk1977 void *pUpdateArg; 102094eb6a14Sdanielk1977 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 10215cf53537Sdan #ifndef SQLITE_OMIT_WAL 10227ed91f23Sdrh int (*xWalCallback)(void *, sqlite3 *, const char *, int); 10237ed91f23Sdrh void *pWalArg; 10245cf53537Sdan #endif 1025fcd35c7bSdrh void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 1026fcd35c7bSdrh void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 1027fcd35c7bSdrh void *pCollNeededArg; 1028fcd35c7bSdrh sqlite3_value *pErr; /* Most recent error message */ 1029881feaa0Sdrh union { 103039001e75Sdrh volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 1031881feaa0Sdrh double notUsed1; /* Spacer */ 1032881feaa0Sdrh } u1; 1033633e6d57Sdrh Lookaside lookaside; /* Lookaside malloc configuration */ 1034ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 1035e22a334bSdrh int (*xAuth)(void*,int,const char*,const char*,const char*,const char*); 1036e22a334bSdrh /* Access authorization function */ 1037ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 1038ed6c8671Sdrh #endif 1039348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 1040348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 1041348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 10428f8c65f7Sdrh unsigned nProgressOps; /* Number of opcodes for progress callback */ 1043348bb5d6Sdanielk1977 #endif 1044b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 1045a451017dSdrh int nVTrans; /* Allocated size of aVTrans */ 1046b9bb7c18Sdrh Hash aModule; /* populated by sqlite3_create_module() */ 1047b061d058Sdan VtabCtx *pVtabCtx; /* Context for active vtab connect/create */ 1048595a523aSdanielk1977 VTable **aVTrans; /* Virtual tables with open transactions */ 1049595a523aSdanielk1977 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 10506b456a2bSdanielk1977 #endif 105170a8ca3cSdrh FuncDefHash aFunc; /* Hash table of connection functions */ 1052fcd35c7bSdrh Hash aCollSeq; /* All collating sequences */ 1053fcd35c7bSdrh BusyHandler busyHandler; /* Busy callback */ 1054fcd35c7bSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 1055fd7f0452Sdanielk1977 Savepoint *pSavepoint; /* List of active savepoints */ 1056a451017dSdrh int busyTimeout; /* Busy handler timeout, in msec */ 1057fd7f0452Sdanielk1977 int nSavepoint; /* Number of non-transaction savepoints */ 1058bd43455cSdanielk1977 int nStatement; /* Number of nested statement-transactions */ 10591da40a38Sdan i64 nDeferredCons; /* Net deferred constraints this transaction. */ 1060648e2643Sdrh i64 nDeferredImmCons; /* Net deferred immediate constraints */ 1061d46def77Sdan int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 1062404ca075Sdanielk1977 1063404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 1064404ca075Sdanielk1977 /* The following variables are all protected by the STATIC_MASTER 1065404ca075Sdanielk1977 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 106665a73badSdrh ** 106765a73badSdrh ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 106865a73badSdrh ** unlock so that it can proceed. 106965a73badSdrh ** 107065a73badSdrh ** When X.pBlockingConnection==Y, that means that something that X tried 107165a73badSdrh ** tried to do recently failed with an SQLITE_LOCKED error due to locks 107265a73badSdrh ** held by Y. 1073404ca075Sdanielk1977 */ 1074404ca075Sdanielk1977 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 1075404ca075Sdanielk1977 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 1076404ca075Sdanielk1977 void *pUnlockArg; /* Argument to xUnlockNotify */ 1077404ca075Sdanielk1977 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 1078404ca075Sdanielk1977 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 1079404ca075Sdanielk1977 #endif 108075897234Sdrh }; 108175897234Sdrh 108203b808a6Sdrh /* 108303b808a6Sdrh ** A macro to discover the encoding of a database. 108403b808a6Sdrh */ 108514db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc) 108614db2665Sdanielk1977 108775897234Sdrh /* 108807096f68Sdrh ** Possible values for the sqlite3.flags. 108975897234Sdrh */ 10907e5418e4Sdrh #define SQLITE_VdbeTrace 0x00000001 /* True to trace VDBE execution */ 10917e5418e4Sdrh #define SQLITE_InternChanges 0x00000002 /* Uncommitted Hash table changes */ 109240c3941cSdrh #define SQLITE_FullFSync 0x00000004 /* Use full fsync on the backend */ 109340c3941cSdrh #define SQLITE_CkptFullFSync 0x00000008 /* Use full fsync for checkpoint */ 109440c3941cSdrh #define SQLITE_CacheSpill 0x00000010 /* OK to spill pager cache */ 109540c3941cSdrh #define SQLITE_FullColNames 0x00000020 /* Show full column names on SELECT */ 109640c3941cSdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 109740c3941cSdrh #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */ 10981bee3d7bSdrh /* DELETE, or UPDATE and return */ 10991bee3d7bSdrh /* the count using a callback. */ 110040c3941cSdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 11016a535340Sdrh /* result set is empty */ 110240c3941cSdrh #define SQLITE_SqlTrace 0x00000200 /* Debug print SQL as it executes */ 110340c3941cSdrh #define SQLITE_VdbeListing 0x00000400 /* Debug listings of VDBE programs */ 110440c3941cSdrh #define SQLITE_WriteSchema 0x00000800 /* OK to update SQLITE_MASTER */ 110540c3941cSdrh #define SQLITE_VdbeAddopTrace 0x00001000 /* Trace sqlite3VdbeAddOp() calls */ 110640c3941cSdrh #define SQLITE_IgnoreChecks 0x00002000 /* Do not enforce check constraints */ 110740c3941cSdrh #define SQLITE_ReadUncommitted 0x0004000 /* For shared-cache mode */ 110840c3941cSdrh #define SQLITE_LegacyFileFmt 0x00008000 /* Create new databases in format 1 */ 110940c3941cSdrh #define SQLITE_RecoveryMode 0x00010000 /* Ignore schema errors */ 111040c3941cSdrh #define SQLITE_ReverseOrder 0x00020000 /* Reverse unordered SELECTs */ 111140c3941cSdrh #define SQLITE_RecTriggers 0x00040000 /* Enable recursive triggers */ 111240c3941cSdrh #define SQLITE_ForeignKeys 0x00080000 /* Enforce foreign key constraints */ 111340c3941cSdrh #define SQLITE_AutoIndex 0x00100000 /* Enable automatic indexes */ 111440c3941cSdrh #define SQLITE_PreferBuiltin 0x00200000 /* Preference to built-in funcs */ 111540c3941cSdrh #define SQLITE_LoadExtension 0x00400000 /* Enable load_extension */ 111640c3941cSdrh #define SQLITE_EnableTrigger 0x00800000 /* True to enable triggers */ 111740c3941cSdrh #define SQLITE_DeferFKs 0x01000000 /* Defer all FK constraints */ 111840c3941cSdrh #define SQLITE_QueryOnly 0x02000000 /* Disable database changes */ 111984e55a80Sdrh #define SQLITE_VdbeEQP 0x04000000 /* Debug EXPLAIN QUERY PLAN */ 1120b1eaa718Sdrh 112107096f68Sdrh 112207096f68Sdrh /* 11237e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the 11247e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to 11257e5418e4Sdrh ** selectively disable various optimizations. 112607096f68Sdrh */ 11277e5418e4Sdrh #define SQLITE_QueryFlattener 0x0001 /* Query flattening */ 11287e5418e4Sdrh #define SQLITE_ColumnCache 0x0002 /* Column cache */ 11297e5418e4Sdrh #define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */ 11307e5418e4Sdrh #define SQLITE_FactorOutConst 0x0008 /* Constant factoring */ 1131762c1c40Sdrh /* not used 0x0010 // Was: SQLITE_IdxRealAsInt */ 11327e5418e4Sdrh #define SQLITE_DistinctOpt 0x0020 /* DISTINCT using indexes */ 11337e5418e4Sdrh #define SQLITE_CoverIdxScan 0x0040 /* Covering index scans */ 1134a9e3fc05Sdrh #define SQLITE_OrderByIdxJoin 0x0080 /* ORDER BY of joins via index */ 1135a5759677Sdrh #define SQLITE_SubqCoroutine 0x0100 /* Evaluate subqueries as coroutines */ 1136eb5bc926Sdrh #define SQLITE_Transitive 0x0200 /* Transitive constraints */ 11371031bd99Sdrh #define SQLITE_OmitNoopJoin 0x0400 /* Omit unused tables in joins */ 113840aa936fSdrh #define SQLITE_Stat3 0x0800 /* Use the SQLITE_STAT3 table */ 1139add5ce30Sdrh #define SQLITE_AdjustOutEst 0x1000 /* Adjust output estimates using WHERE */ 1140a5759677Sdrh #define SQLITE_AllOpts 0xffff /* All optimizations */ 11417e5418e4Sdrh 11427e5418e4Sdrh /* 11437e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled. 11447e5418e4Sdrh */ 11457e5418e4Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST 11467e5418e4Sdrh #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0) 11477e5418e4Sdrh #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0) 11487e5418e4Sdrh #else 11497e5418e4Sdrh #define OptimizationDisabled(db, mask) 0 11507e5418e4Sdrh #define OptimizationEnabled(db, mask) 1 11517e5418e4Sdrh #endif 115234c68fbaSdanielk1977 115358b9576bSdrh /* 1154d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization 1155d9f158e7Sdrh ** code. The argument is a Parse object for the code generator. 1156d9f158e7Sdrh */ 1157aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor) 1158d9f158e7Sdrh 1159d9f158e7Sdrh /* 1160247be43dSdrh ** Possible values for the sqlite.magic field. 1161247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 1162247be43dSdrh ** than being distinct from one another. 1163247be43dSdrh */ 1164247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 1165247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 11667e8b848aSdrh #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 1167247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 1168247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 11694245c405Sdrh #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */ 1170247be43dSdrh 1171247be43dSdrh /* 11720bce8354Sdrh ** Each SQL function is defined by an instance of the following 11730bce8354Sdrh ** structure. A pointer to this structure is stored in the sqlite.aFunc 11748e0a2f90Sdrh ** hash table. When multiple functions have the same name, the hash table 11758e0a2f90Sdrh ** points to a linked list of these structures. 11762803757aSdrh */ 11770bce8354Sdrh struct FuncDef { 1178e82f5d04Sdrh i16 nArg; /* Number of arguments. -1 means unlimited */ 1179d36e1041Sdrh u16 funcFlags; /* Some combination of SQLITE_FUNC_* */ 11801350b030Sdrh void *pUserData; /* User data parameter */ 11810bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 1182f9b596ebSdrh void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */ 1183f9b596ebSdrh void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */ 1184467bcf36Sshane void (*xFinalize)(sqlite3_context*); /* Aggregate finalizer */ 11858c0a791aSdanielk1977 char *zName; /* SQL name of the function. */ 118670a8ca3cSdrh FuncDef *pHash; /* Next with a different name but the same hash */ 1187d2199f0fSdan FuncDestructor *pDestructor; /* Reference counted destructor function */ 1188d2199f0fSdan }; 1189d2199f0fSdan 1190d2199f0fSdan /* 1191d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as 1192d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When 1193d2199f0fSdan ** create_function_v2() is called to create a function with a destructor, 1194d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to 1195d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether 1196d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 1197d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated 1198d2199f0fSdan ** FuncDestructor. 1199d2199f0fSdan ** 1200d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference 1201d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor 1202d2199f0fSdan ** is invoked and the FuncDestructor structure freed. 1203d2199f0fSdan */ 1204d2199f0fSdan struct FuncDestructor { 1205d2199f0fSdan int nRef; 1206d2199f0fSdan void (*xDestroy)(void *); 1207d2199f0fSdan void *pUserData; 12088e0a2f90Sdrh }; 12092803757aSdrh 12102803757aSdrh /* 1211a748fdccSdrh ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF 1212a748fdccSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. There 1213a748fdccSdrh ** are assert() statements in the code to verify this. 12147d10d5a6Sdrh */ 1215d36e1041Sdrh #define SQLITE_FUNC_ENCMASK 0x003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */ 1216d36e1041Sdrh #define SQLITE_FUNC_LIKE 0x004 /* Candidate for the LIKE optimization */ 1217d36e1041Sdrh #define SQLITE_FUNC_CASE 0x008 /* Case-sensitive LIKE-type function */ 1218d36e1041Sdrh #define SQLITE_FUNC_EPHEM 0x010 /* Ephemeral. Delete with VDBE */ 1219d36e1041Sdrh #define SQLITE_FUNC_NEEDCOLL 0x020 /* sqlite3GetFuncCollSeq() might be called */ 1220d36e1041Sdrh #define SQLITE_FUNC_LENGTH 0x040 /* Built-in length() function */ 1221d36e1041Sdrh #define SQLITE_FUNC_TYPEOF 0x080 /* Built-in typeof() function */ 1222d36e1041Sdrh #define SQLITE_FUNC_COUNT 0x100 /* Built-in count(*) aggregate */ 1223d36e1041Sdrh #define SQLITE_FUNC_COALESCE 0x200 /* Built-in coalesce() or ifnull() */ 1224d36e1041Sdrh #define SQLITE_FUNC_UNLIKELY 0x400 /* Built-in unlikely() function */ 1225b1fba286Sdrh #define SQLITE_FUNC_CONSTANT 0x800 /* Constant inputs give a constant output */ 12267d10d5a6Sdrh 12277d10d5a6Sdrh /* 1228777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1229777c5386Sdrh ** used to create the initializers for the FuncDef structures. 1230777c5386Sdrh ** 1231777c5386Sdrh ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1232777c5386Sdrh ** Used to create a scalar function definition of a function zName 1233777c5386Sdrh ** implemented by C function xFunc that accepts nArg arguments. The 1234777c5386Sdrh ** value passed as iArg is cast to a (void*) and made available 1235777c5386Sdrh ** as the user-data (sqlite3_user_data()) for the function. If 1236f7bca574Sdrh ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1237777c5386Sdrh ** 1238b1fba286Sdrh ** VFUNCTION(zName, nArg, iArg, bNC, xFunc) 1239b1fba286Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag. 1240b1fba286Sdrh ** 1241777c5386Sdrh ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1242777c5386Sdrh ** Used to create an aggregate function definition implemented by 1243777c5386Sdrh ** the C functions xStep and xFinal. The first four parameters 1244777c5386Sdrh ** are interpreted in the same way as the first 4 parameters to 1245777c5386Sdrh ** FUNCTION(). 1246777c5386Sdrh ** 1247777c5386Sdrh ** LIKEFUNC(zName, nArg, pArg, flags) 1248777c5386Sdrh ** Used to create a scalar function definition of a function zName 1249777c5386Sdrh ** that accepts nArg arguments and is implemented by a call to C 1250777c5386Sdrh ** function likeFunc. Argument pArg is cast to a (void *) and made 1251777c5386Sdrh ** available as the function user-data (sqlite3_user_data()). The 1252777c5386Sdrh ** FuncDef.flags variable is set to the value passed as the flags 1253777c5386Sdrh ** parameter. 1254777c5386Sdrh */ 1255777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1256b1fba286Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1257b1fba286Sdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0} 1258b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1259d36e1041Sdrh {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 1260a748fdccSdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0} 1261a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \ 1262b1fba286Sdrh {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\ 12636ac78a0dSdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0} 126421717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 1265b1fba286Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 12666ac78a0dSdrh pArg, 0, xFunc, 0, 0, #zName, 0, 0} 1267777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \ 1268b1fba286Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \ 1269b1fba286Sdrh (void *)arg, 0, likeFunc, 0, 0, #zName, 0, 0} 1270777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \ 1271d36e1041Sdrh {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \ 12726ac78a0dSdrh SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0} 1273777c5386Sdrh 1274fd7f0452Sdanielk1977 /* 1275fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at 1276fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently 1277fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe 1278fd7f0452Sdanielk1977 ** OP_Savepoint instruction. 1279fd7f0452Sdanielk1977 */ 1280fd7f0452Sdanielk1977 struct Savepoint { 1281fd7f0452Sdanielk1977 char *zName; /* Savepoint name (nul-terminated) */ 1282fcb9f7adSdrh i64 nDeferredCons; /* Number of deferred fk violations */ 1283648e2643Sdrh i64 nDeferredImmCons; /* Number of deferred imm fk. */ 1284fd7f0452Sdanielk1977 Savepoint *pNext; /* Parent savepoint (if any) */ 1285fd7f0452Sdanielk1977 }; 1286fd7f0452Sdanielk1977 1287fd7f0452Sdanielk1977 /* 1288fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(), 1289fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction. 1290fd7f0452Sdanielk1977 */ 1291fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN 0 1292fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE 1 1293fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK 2 1294fd7f0452Sdanielk1977 1295777c5386Sdrh 1296777c5386Sdrh /* 1297d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an 1298d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule 1299d1ab1ba5Sdanielk1977 ** hash table. 1300d1ab1ba5Sdanielk1977 */ 1301d1ab1ba5Sdanielk1977 struct Module { 1302d1ab1ba5Sdanielk1977 const sqlite3_module *pModule; /* Callback pointers */ 1303d1ab1ba5Sdanielk1977 const char *zName; /* Name passed to create_module() */ 1304d1ab1ba5Sdanielk1977 void *pAux; /* pAux passed to create_module() */ 1305832a58a6Sdanielk1977 void (*xDestroy)(void *); /* Module destructor function */ 1306d1ab1ba5Sdanielk1977 }; 1307d1ab1ba5Sdanielk1977 1308d1ab1ba5Sdanielk1977 /* 1309967e8b73Sdrh ** information about each column of an SQL table is held in an instance 13107020f651Sdrh ** of this structure. 13117020f651Sdrh */ 13127020f651Sdrh struct Column { 13137020f651Sdrh char *zName; /* Name of this column */ 13147977a17fSdanielk1977 Expr *pDflt; /* Default value of this column */ 1315b7916a78Sdrh char *zDflt; /* Original text of the default value */ 1316382c0247Sdrh char *zType; /* Data type for this column */ 1317b3bf556eSdanielk1977 char *zColl; /* Collating sequence. If NULL, use the default */ 1318a371ace4Sdrh u8 notNull; /* An OE_ code for handling a NOT NULL constraint */ 1319a37cdde0Sdanielk1977 char affinity; /* One of the SQLITE_AFF_... values */ 1320fdaac671Sdrh u8 szEst; /* Estimated size of this column. INT==1 */ 1321fdaac671Sdrh u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */ 13227020f651Sdrh }; 13237020f651Sdrh 1324a371ace4Sdrh /* Allowed values for Column.colFlags: 1325a371ace4Sdrh */ 1326a371ace4Sdrh #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */ 1327a371ace4Sdrh #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */ 1328a371ace4Sdrh 13297020f651Sdrh /* 1330a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following 13310202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and 13320202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence. 1333a9fd84b0Sdrh ** 1334e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the 13350202b29eSdanielk1977 ** collating sequence is undefined. Indices built on an undefined 13360202b29eSdanielk1977 ** collating sequence may not be read or written. 1337a9fd84b0Sdrh */ 1338a9fd84b0Sdrh struct CollSeq { 13390202b29eSdanielk1977 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 1340466be56bSdanielk1977 u8 enc; /* Text encoding handled by xCmp() */ 1341a9fd84b0Sdrh void *pUser; /* First argument to xCmp() */ 13420202b29eSdanielk1977 int (*xCmp)(void*,int, const void*, int, const void*); 1343a9808b31Sdanielk1977 void (*xDel)(void*); /* Destructor for pUser */ 1344a9fd84b0Sdrh }; 1345a9fd84b0Sdrh 1346a9fd84b0Sdrh /* 1347d3d39e93Sdrh ** A sort order can be either ASC or DESC. 13488e2ca029Sdrh */ 13498e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 1350d3d39e93Sdrh #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 13518e2ca029Sdrh 13528e2ca029Sdrh /* 1353a37cdde0Sdanielk1977 ** Column affinity types. 13548a51256cSdrh ** 13558a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 13568a51256cSdrh ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 13577d10d5a6Sdrh ** the speed a little by numbering the values consecutively. 13588a51256cSdrh ** 13598a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'. That way, 13608a51256cSdrh ** when multiple affinity types are concatenated into a string and 136166a5167bSdrh ** used as the P4 operand, they will be more readable. 13628a51256cSdrh ** 13638a51256cSdrh ** Note also that the numeric types are grouped together so that testing 13648a51256cSdrh ** for a numeric type is a single comparison. 1365a37cdde0Sdanielk1977 */ 13668a51256cSdrh #define SQLITE_AFF_TEXT 'a' 13678a51256cSdrh #define SQLITE_AFF_NONE 'b' 13688a51256cSdrh #define SQLITE_AFF_NUMERIC 'c' 13698a51256cSdrh #define SQLITE_AFF_INTEGER 'd' 13708a51256cSdrh #define SQLITE_AFF_REAL 'e' 1371a37cdde0Sdanielk1977 13728a51256cSdrh #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 1373a37cdde0Sdanielk1977 1374a37cdde0Sdanielk1977 /* 137535573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an 137635573356Sdrh ** affinity value. 137735573356Sdrh */ 137835573356Sdrh #define SQLITE_AFF_MASK 0x67 137935573356Sdrh 138035573356Sdrh /* 138135573356Sdrh ** Additional bit values that can be ORed with an affinity without 138235573356Sdrh ** changing the affinity. 13833d77dee9Sdrh ** 13843d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL. 13853d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison 13863d77dee9Sdrh ** operator is NULL. It is added to certain comparison operators to 13873d77dee9Sdrh ** prove that the operands are always NOT NULL. 138835573356Sdrh */ 138935573356Sdrh #define SQLITE_JUMPIFNULL 0x08 /* jumps if either operand is NULL */ 139093a960a0Sdrh #define SQLITE_STOREP2 0x10 /* Store result in reg[P2] rather than jump */ 13916a2fe093Sdrh #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 13923d77dee9Sdrh #define SQLITE_NOTNULL 0x88 /* Assert that operands are never NULL */ 139335573356Sdrh 139435573356Sdrh /* 1395595a523aSdanielk1977 ** An object of this type is created for each virtual table present in 1396595a523aSdanielk1977 ** the database schema. 1397595a523aSdanielk1977 ** 1398595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this 1399595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared 1400595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique 1401595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table 1402595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between 1403595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database 1404595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database 1405595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method 1406595a523aSdanielk1977 ** during initialization internally. This database connection handle may 14079bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables 1408595a523aSdanielk1977 ** within the database. So that they appear as part of the callers 1409595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database 1410595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table. 1411595a523aSdanielk1977 ** 1412595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared 1413595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by 1414595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object. 1415595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual 1416595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the 1417595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct 1418595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query. 1419595a523aSdanielk1977 ** 1420595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the 1421595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not 1422595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 1423595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to 1424595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the 1425595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 1426595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done 1427595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 1428595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an 1429595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 1430595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex. 1431595a523aSdanielk1977 ** 1432595a523aSdanielk1977 ** The memory for objects of this type is always allocated by 1433595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 1434595a523aSdanielk1977 ** the first argument. 1435595a523aSdanielk1977 */ 1436595a523aSdanielk1977 struct VTable { 1437595a523aSdanielk1977 sqlite3 *db; /* Database connection associated with this table */ 1438595a523aSdanielk1977 Module *pMod; /* Pointer to module implementation */ 1439595a523aSdanielk1977 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 1440595a523aSdanielk1977 int nRef; /* Number of pointers to this structure */ 1441b061d058Sdan u8 bConstraint; /* True if constraints are supported */ 1442addd8f87Sdrh int iSavepoint; /* Depth of the SAVEPOINT stack */ 1443595a523aSdanielk1977 VTable *pNext; /* Next in linked list (see above) */ 1444595a523aSdanielk1977 }; 1445595a523aSdanielk1977 1446595a523aSdanielk1977 /* 144722f70c32Sdrh ** Each SQL table is represented in memory by an instance of the 144822f70c32Sdrh ** following structure. 144922f70c32Sdrh ** 1450d24cc427Sdrh ** Table.zName is the name of the table. The case of the original 145122f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for 145222f70c32Sdrh ** comparisons. 145322f70c32Sdrh ** 1454d24cc427Sdrh ** Table.nCol is the number of columns in this table. Table.aCol is a 145522f70c32Sdrh ** pointer to an array of Column structures, one for each column. 145622f70c32Sdrh ** 1457d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of 1458d24cc427Sdrh ** the column that is that key. Otherwise Table.iPKey is negative. Note 145922f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to 146022f70c32Sdrh ** be set. An INTEGER PRIMARY KEY is used as the rowid for each row of 146122f70c32Sdrh ** the table. If a table has no INTEGER PRIMARY KEY, then a random rowid 14627d10d5a6Sdrh ** is generated for each row of the table. TF_HasPrimaryKey is set if 146322f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise. 146422f70c32Sdrh ** 1465d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the 1466d24cc427Sdrh ** database file. If Table.iDb is the index of the database table backend 1467d24cc427Sdrh ** in sqlite.aDb[]. 0 is for the main database and 1 is for the file that 14687d10d5a6Sdrh ** holds temporary tables and indices. If TF_Ephemeral is set 14697d10d5a6Sdrh ** then the table is stored in a file that is automatically deleted 1470d24cc427Sdrh ** when the VDBE cursor to the table is closed. In this case Table.tnum 147122f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root 147222f70c32Sdrh ** page number. Transient tables are used to hold the results of a 147322f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause 147422f70c32Sdrh ** of a SELECT statement. 147575897234Sdrh */ 147675897234Sdrh struct Table { 14777d10d5a6Sdrh char *zName; /* Name of the table or view */ 14787020f651Sdrh Column *aCol; /* Information about each column */ 1479967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 1480a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 1481c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 14823d1bfeaaSdanielk1977 char *zColAff; /* String defining the affinity of each column */ 1483ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK 14842938f924Sdrh ExprList *pCheck; /* All CHECK constraints */ 1485ffe07b2dSdrh #endif 1486cfc9df76Sdan LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */ 1487d815f17dSdrh int tnum; /* Root BTree node for this table (see note above) */ 1488d815f17dSdrh i16 iPKey; /* If not negative, use aCol[iPKey] as the primary key */ 1489d815f17dSdrh i16 nCol; /* Number of columns in this table */ 1490d815f17dSdrh u16 nRef; /* Number of pointers to this Table */ 1491bf539c4dSdrh LogEst szTabRow; /* Estimated size of each table row in bytes */ 1492dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT 1493dbd9486dSdrh LogEst costMult; /* Cost multiplier for using this table */ 1494dbd9486dSdrh #endif 1495d815f17dSdrh u8 tabFlags; /* Mask of TF_* values */ 1496d815f17dSdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 149719a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE 14987d10d5a6Sdrh int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 149919a8e7e8Sdanielk1977 #endif 1500e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 1501b9bb7c18Sdrh int nModuleArg; /* Number of arguments to the module */ 1502b9bb7c18Sdrh char **azModuleArg; /* Text of all module args. [0] is module name */ 1503d815f17dSdrh VTable *pVTable; /* List of VTable objects. */ 1504e09daa90Sdrh #endif 15052f886d1dSdanielk1977 Trigger *pTrigger; /* List of triggers stored in pSchema */ 1506728b5779Sdrh Schema *pSchema; /* Schema that contains this table */ 1507588a9a1aSdrh Table *pNextZombie; /* Next on the Parse.pZombieTab list */ 150875897234Sdrh }; 150975897234Sdrh 151075897234Sdrh /* 15118ce7184bSdan ** Allowed values for Table.tabFlags. 15127d10d5a6Sdrh */ 15137d10d5a6Sdrh #define TF_Readonly 0x01 /* Read-only system table */ 1514467bcf36Sshane #define TF_Ephemeral 0x02 /* An ephemeral table */ 15157d10d5a6Sdrh #define TF_HasPrimaryKey 0x04 /* Table has a primary key */ 15167d10d5a6Sdrh #define TF_Autoincrement 0x08 /* Integer primary key is autoincrement */ 15177d10d5a6Sdrh #define TF_Virtual 0x10 /* Is a virtual table */ 151881eba73eSdrh #define TF_WithoutRowid 0x20 /* No rowid used. PRIMARY KEY is the key */ 15197d10d5a6Sdrh 15207d10d5a6Sdrh 15217d10d5a6Sdrh /* 15224cbdda9eSdrh ** Test to see whether or not a table is a virtual table. This is 15234cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual 15244cbdda9eSdrh ** table support is omitted from the build. 15254cbdda9eSdrh */ 15264cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 15277d10d5a6Sdrh # define IsVirtual(X) (((X)->tabFlags & TF_Virtual)!=0) 1528a371ace4Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 15294cbdda9eSdrh #else 15304cbdda9eSdrh # define IsVirtual(X) 0 1531034ca14fSdanielk1977 # define IsHiddenColumn(X) 0 15324cbdda9eSdrh #endif 15334cbdda9eSdrh 1534ec95c441Sdrh /* Does the table have a rowid */ 1535ec95c441Sdrh #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0) 1536ec95c441Sdrh 15374cbdda9eSdrh /* 1538c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 1539c2eef3b3Sdrh ** 1540c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 1541c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 1542c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 1543c2eef3b3Sdrh ** Consider this example: 1544c2eef3b3Sdrh ** 1545c2eef3b3Sdrh ** CREATE TABLE ex1( 1546c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 1547c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 1548c2eef3b3Sdrh ** ); 1549c2eef3b3Sdrh ** 1550c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 1551bd50a926Sdrh ** Equivalent names: 1552bd50a926Sdrh ** 1553bd50a926Sdrh ** from-table == child-table 1554bd50a926Sdrh ** to-table == parent-table 1555c2eef3b3Sdrh ** 1556c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 1557c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 1558e61922a6Sdrh ** the from-table is created. The existence of the to-table is not checked. 1559bd50a926Sdrh ** 1560bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey. 1561bd50a926Sdrh ** 1562bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist) 1563bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z. 1564c2eef3b3Sdrh */ 1565c2eef3b3Sdrh struct FKey { 15661f638cebSdrh Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 1567bd50a926Sdrh FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */ 15681f638cebSdrh char *zTo; /* Name of table that the key points to (aka: Parent) */ 1569bd50a926Sdrh FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */ 1570bd50a926Sdrh FKey *pPrevTo; /* Previous with the same zTo */ 1571c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 15724c429839Sdrh /* EV: R-30323-21917 */ 1573c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 15748099ce6fSdan u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 15758099ce6fSdan Trigger *apTrigger[2];/* Triggers for aAction[] actions */ 1576e61922a6Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 1577e61922a6Sdrh int iFrom; /* Index of column in pFrom */ 1578bd50a926Sdrh char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */ 1579e61922a6Sdrh } aCol[1]; /* One entry for each of nCol columns */ 1580c2eef3b3Sdrh }; 1581c2eef3b3Sdrh 1582c2eef3b3Sdrh /* 1583aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint 158422f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 15850bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 15861c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 15871c92853dSdrh ** fails and any prior changes from that one operation are backed out, 15881c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 15891c92853dSdrh ** the operation in progress stops and returns an error code. But prior 15901c92853dSdrh ** changes due to the same operation are not backed out and no rollback 15911c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 15921c92853dSdrh ** error is not inserted or updated. Processing continues and no error 15931c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 15941c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 15951c92853dSdrh ** update can proceed. Processing continues and no error is reported. 15961c92853dSdrh ** 1597c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys. 1598c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 1599c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 1600c2eef3b3Sdrh ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the 1601c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 1602c2eef3b3Sdrh ** foreign key. 1603c2eef3b3Sdrh ** 1604968af52aSdrh ** The following symbolic values are used to record which type 16051c92853dSdrh ** of action to take. 16069cfcf5d4Sdrh */ 16079cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 16081c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 16091c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 16101c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 16111c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 16121c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 1613c2eef3b3Sdrh 1614c2eef3b3Sdrh #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 1615c2eef3b3Sdrh #define OE_SetNull 7 /* Set the foreign key value to NULL */ 1616c2eef3b3Sdrh #define OE_SetDflt 8 /* Set the foreign key value to its default */ 1617c2eef3b3Sdrh #define OE_Cascade 9 /* Cascade the changes */ 1618c2eef3b3Sdrh 1619c28c4e50Sdrh #define OE_Default 10 /* Do whatever the default action is */ 16209cfcf5d4Sdrh 1621d3d39e93Sdrh 1622d3d39e93Sdrh /* 1623d3d39e93Sdrh ** An instance of the following structure is passed as the first 1624d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the 1625d3d39e93Sdrh ** comparison of the two index keys. 1626323df790Sdrh ** 1627323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots. There 1628323df790Sdrh ** are nField slots for the columns of an index then one extra slot 1629323df790Sdrh ** for the rowid at the end. 1630d3d39e93Sdrh */ 1631d3d39e93Sdrh struct KeyInfo { 16322ec2fb22Sdrh u32 nRef; /* Number of references to this KeyInfo object */ 16339b8d0272Sdrh u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 1634ad124329Sdrh u16 nField; /* Number of key columns in the index */ 1635ad124329Sdrh u16 nXField; /* Number of columns beyond the key columns */ 16362ec2fb22Sdrh sqlite3 *db; /* The database connection */ 1637323df790Sdrh u8 *aSortOrder; /* Sort order for each column. */ 1638d3d39e93Sdrh CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 1639d3d39e93Sdrh }; 1640d3d39e93Sdrh 16419cfcf5d4Sdrh /* 1642e63d9991Sdrh ** An instance of the following structure holds information about a 1643e63d9991Sdrh ** single index record that has already been parsed out into individual 1644e63d9991Sdrh ** values. 1645e63d9991Sdrh ** 1646e63d9991Sdrh ** A record is an object that contains one or more fields of data. 1647e63d9991Sdrh ** Records are used to store the content of a table row and to store 1648e63d9991Sdrh ** the key of an index. A blob encoding of a record is created by 1649467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 1650e63d9991Sdrh ** OP_Column opcode. 1651e63d9991Sdrh ** 1652e63d9991Sdrh ** This structure holds a record that has already been disassembled 1653467bcf36Sshane ** into its constituent fields. 16543833e934Sdan ** 16553833e934Sdan ** The r1 and r2 member variables are only used by the optimized comparison 16563833e934Sdan ** functions vdbeRecordCompareInt() and vdbeRecordCompareString(). 1657e63d9991Sdrh */ 1658e63d9991Sdrh struct UnpackedRecord { 1659e63d9991Sdrh KeyInfo *pKeyInfo; /* Collation and sort-order information */ 1660e63d9991Sdrh u16 nField; /* Number of entries in apMem[] */ 1661a9e0aeb5Sdrh i8 default_rc; /* Comparison result if keys are equal */ 1662a1f7c0a2Sdrh u8 isCorrupt; /* Corruption detected by xRecordCompare() */ 1663e63d9991Sdrh Mem *aMem; /* Values */ 16643833e934Sdan int r1; /* Value to return if (lhs > rhs) */ 16653833e934Sdan int r2; /* Value to return if (rhs < lhs) */ 1666e63d9991Sdrh }; 1667e63d9991Sdrh 1668e63d9991Sdrh 1669e63d9991Sdrh /* 167066b89c8fSdrh ** Each SQL index is represented in memory by an 167175897234Sdrh ** instance of the following structure. 1672967e8b73Sdrh ** 1673967e8b73Sdrh ** The columns of the table that are to be indexed are described 1674967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 1675967e8b73Sdrh ** we have the following table and index: 1676967e8b73Sdrh ** 1677967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 1678967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 1679967e8b73Sdrh ** 1680967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 1681967e8b73Sdrh ** three columns in the table. In the Index structure describing 1682967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 1683967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 1684967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 1685967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 1686967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 1687ea1ba17cSdrh ** 1688ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 1689ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 1690ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 1691ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 1692ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 1693ea1ba17cSdrh ** element. 169475897234Sdrh */ 169575897234Sdrh struct Index { 169675897234Sdrh char *zName; /* Name of this index */ 1697bbbdc83bSdrh i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */ 1698cfc9df76Sdan LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */ 1699967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 1700a37cdde0Sdanielk1977 char *zColAff; /* String defining the affinity of each column */ 170175897234Sdrh Index *pNext; /* The next index associated with the same table */ 1702b3bf556eSdanielk1977 Schema *pSchema; /* Schema containing this index */ 1703b376daebSdrh u8 *aSortOrder; /* for each column: True==DESC, False==ASC */ 1704b3bf556eSdanielk1977 char **azColl; /* Array of collation sequence names for index */ 17051fe0537eSdrh Expr *pPartIdxWhere; /* WHERE clause for partial indices */ 17062ec2fb22Sdrh KeyInfo *pKeyInfo; /* A KeyInfo object suitable for this index */ 1707b376daebSdrh int tnum; /* DB Page containing root of this index */ 1708bf539c4dSdrh LogEst szIdxRow; /* Estimated average row size in bytes */ 1709bbbdc83bSdrh u16 nKeyCol; /* Number of columns forming the key */ 1710bbbdc83bSdrh u16 nColumn; /* Number of columns stored in the index */ 1711bf539c4dSdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 171248dd1d8eSdrh unsigned idxType:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */ 1713b376daebSdrh unsigned bUnordered:1; /* Use this index for == or IN queries only */ 17147699d1c4Sdrh unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */ 17157f9c5dbfSdrh unsigned isResized:1; /* True if resizeIndexObject() has been called */ 1716ec95c441Sdrh unsigned isCovering:1; /* True if this is a covering index */ 17171435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4 17182b9cf669Sdrh int nSample; /* Number of elements in aSample[] */ 17198ad169abSdan int nSampleCol; /* Size of IndexSample.anEq[] and so on */ 1720eea568d6Sdan tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */ 1721faacf17cSdrh IndexSample *aSample; /* Samples of the left-most key */ 1722faacf17cSdrh #endif 172302fa4696Sdan }; 172402fa4696Sdan 172502fa4696Sdan /* 172648dd1d8eSdrh ** Allowed values for Index.idxType 172748dd1d8eSdrh */ 172848dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */ 172948dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */ 173048dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */ 173148dd1d8eSdrh 173248dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */ 173348dd1d8eSdrh #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY) 173448dd1d8eSdrh 17355f1d1d9cSdrh /* Return true if index X is a UNIQUE index */ 17365f1d1d9cSdrh #define IsUniqueIndex(X) ((X)->onError!=OE_None) 17375f1d1d9cSdrh 173848dd1d8eSdrh /* 173974e7c8f5Sdrh ** Each sample stored in the sqlite_stat3 table is represented in memory 174074e7c8f5Sdrh ** using a structure of this type. See documentation at the top of the 174174e7c8f5Sdrh ** analyze.c source file for additional information. 174202fa4696Sdan */ 174302fa4696Sdan struct IndexSample { 1744f52bb8d3Sdan void *p; /* Pointer to sampled record */ 1745f52bb8d3Sdan int n; /* Size of record in bytes */ 1746f52bb8d3Sdan tRowcnt *anEq; /* Est. number of rows where the key equals this sample */ 1747f52bb8d3Sdan tRowcnt *anLt; /* Est. number of rows where key is less than this sample */ 1748f52bb8d3Sdan tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */ 174975897234Sdrh }; 175075897234Sdrh 175175897234Sdrh /* 175275897234Sdrh ** Each token coming out of the lexer is an instance of 17534b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 17544efc4754Sdrh ** 17554efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and 1756467bcf36Sshane ** may contain random values. Do not make any assumptions about Token.dyn 17574efc4754Sdrh ** and Token.n when Token.z==0. 175875897234Sdrh */ 175975897234Sdrh struct Token { 1760b7916a78Sdrh const char *z; /* Text of the token. Not NULL-terminated! */ 1761b7916a78Sdrh unsigned int n; /* Number of characters in this token */ 176275897234Sdrh }; 176375897234Sdrh 176475897234Sdrh /* 176513449892Sdrh ** An instance of this structure contains information needed to generate 176613449892Sdrh ** code for a SELECT that contains aggregate functions. 176713449892Sdrh ** 176813449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 176913449892Sdrh ** pointer to this structure. The Expr.iColumn field is the index in 177013449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 177113449892Sdrh ** code for that node. 177213449892Sdrh ** 177313449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 177413449892Sdrh ** original Select structure that describes the SELECT statement. These 177513449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure. 177613449892Sdrh */ 177713449892Sdrh struct AggInfo { 177813449892Sdrh u8 directMode; /* Direct rendering mode means take data directly 177913449892Sdrh ** from source tables rather than from accumulators */ 178013449892Sdrh u8 useSortingIdx; /* In direct mode, reference the sorting index rather 178113449892Sdrh ** than the source table */ 178213449892Sdrh int sortingIdx; /* Cursor number of the sorting index */ 17835134d135Sdan int sortingIdxPTab; /* Cursor number of pseudo-table */ 178413449892Sdrh int nSortingColumn; /* Number of columns in the sorting index */ 17857e61d18eSdrh int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */ 1786a451017dSdrh ExprList *pGroupBy; /* The group by clause */ 178713449892Sdrh struct AggInfo_col { /* For each column used in source tables */ 17880817d0dfSdanielk1977 Table *pTab; /* Source table */ 178913449892Sdrh int iTable; /* Cursor number of the source table */ 179013449892Sdrh int iColumn; /* Column number within the source table */ 179113449892Sdrh int iSorterColumn; /* Column number in the sorting index */ 179213449892Sdrh int iMem; /* Memory location that acts as accumulator */ 17935774b806Sdrh Expr *pExpr; /* The original expression */ 179413449892Sdrh } *aCol; 179513449892Sdrh int nColumn; /* Number of used entries in aCol[] */ 179613449892Sdrh int nAccumulator; /* Number of columns that show through to the output. 179713449892Sdrh ** Additional columns are used only as parameters to 179813449892Sdrh ** aggregate functions */ 179913449892Sdrh struct AggInfo_func { /* For each aggregate function */ 180013449892Sdrh Expr *pExpr; /* Expression encoding the function */ 180113449892Sdrh FuncDef *pFunc; /* The aggregate function implementation */ 180213449892Sdrh int iMem; /* Memory location that acts as accumulator */ 1803467bcf36Sshane int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 180413449892Sdrh } *aFunc; 180513449892Sdrh int nFunc; /* Number of entries in aFunc[] */ 180613449892Sdrh }; 180713449892Sdrh 180813449892Sdrh /* 18098677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 18108677d308Sdrh ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 18118677d308Sdrh ** than 32767 we have to make it 32-bit. 16-bit is preferred because 18128677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user 18138677d308Sdrh ** in systems with lots of prepared statements. And few applications 18148677d308Sdrh ** need more than about 10 or 20 variables. But some extreme users want 18158677d308Sdrh ** to have prepared statements with over 32767 variables, and for them 18168677d308Sdrh ** the option is available (at compile-time). 18178677d308Sdrh */ 18188677d308Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<=32767 1819481aa74eSdrh typedef i16 ynVar; 18208677d308Sdrh #else 18218677d308Sdrh typedef int ynVar; 18228677d308Sdrh #endif 18238677d308Sdrh 18248677d308Sdrh /* 182575897234Sdrh ** Each node of an expression in the parse tree is an instance 182622f70c32Sdrh ** of this structure. 182722f70c32Sdrh ** 182822f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 182922f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 183022f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 183122f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 183222f70c32Sdrh ** tree. 183322f70c32Sdrh ** 18346ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 18356ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 18366ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 18376ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 18386ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function. 183922f70c32Sdrh ** 18406ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 18416ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL. 18426ab3a2ecSdanielk1977 ** 18436ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 18446ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 18456ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 18466ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 18476ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 18486ab3a2ecSdanielk1977 ** valid. 184922f70c32Sdrh ** 185022f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 185122f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 185222f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 185322f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 185422f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 185522f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 185622f70c32Sdrh ** it can be accessed after all aggregates are computed. 185722f70c32Sdrh ** 18586ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark 18596ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index 18606ab3a2ecSdanielk1977 ** number for that variable. 186122f70c32Sdrh ** 18621398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer 18631398ad36Sdrh ** register number containing the result of the subquery. If the 18641398ad36Sdrh ** subquery gives a constant result, then iTable is -1. If the subquery 18651398ad36Sdrh ** gives a different answer at different times during statement processing 18661398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery. 18671398ad36Sdrh ** 1868aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from 1869aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 1870aee18ef8Sdanielk1977 ** corresponding table definition. 18716ab3a2ecSdanielk1977 ** 18726ab3a2ecSdanielk1977 ** ALLOCATION NOTES: 18736ab3a2ecSdanielk1977 ** 187412ffee8cSdrh ** Expr objects can use a lot of memory space in database schema. To 187512ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be 187612ffee8cSdrh ** truncated. And to reduce the number of memory allocations, sometimes 187712ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation, 187833e619fcSdrh ** together with Expr.zToken strings. 18796ab3a2ecSdanielk1977 ** 1880b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when 188112ffee8cSdrh ** an Expr object is truncated. When EP_Reduced is set, then all 188212ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 188312ffee8cSdrh ** are contained within the same memory allocation. Note, however, that 188412ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 188512ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set. 188675897234Sdrh */ 188775897234Sdrh struct Expr { 18881cc093c2Sdrh u8 op; /* Operation performed by this node */ 1889a9fd84b0Sdrh char affinity; /* The affinity of the column or 0 if not a column */ 1890c5cd1249Sdrh u32 flags; /* Various flags. EP_* See below */ 189133e619fcSdrh union { 1892b7916a78Sdrh char *zToken; /* Token value. Zero terminated and dequoted */ 1893d50ffc41Sdrh int iValue; /* Non-negative integer value if EP_IntValue */ 189433e619fcSdrh } u; 18956ab3a2ecSdanielk1977 18966ab3a2ecSdanielk1977 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 18976ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 18986ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 18996ab3a2ecSdanielk1977 *********************************************************************/ 19006ab3a2ecSdanielk1977 19016ab3a2ecSdanielk1977 Expr *pLeft; /* Left subnode */ 19026ab3a2ecSdanielk1977 Expr *pRight; /* Right subnode */ 19036ab3a2ecSdanielk1977 union { 1904c5cd1249Sdrh ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */ 1905c5cd1249Sdrh Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */ 19066ab3a2ecSdanielk1977 } x; 19076ab3a2ecSdanielk1977 19086ab3a2ecSdanielk1977 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 19096ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 19106ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 19116ab3a2ecSdanielk1977 *********************************************************************/ 19126ab3a2ecSdanielk1977 19136ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0 19146ec65491Sdrh int nHeight; /* Height of the tree headed by this node */ 19156ec65491Sdrh #endif 1916b7916a78Sdrh int iTable; /* TK_COLUMN: cursor number of table holding column 19172832ad42Sdan ** TK_REGISTER: register number 1918cca9f3d2Sdrh ** TK_TRIGGER: 1 -> new, 0 -> old 1919a4c3c87eSdrh ** EP_Unlikely: 1000 times likelihood */ 19208677d308Sdrh ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 1921937d0deaSdan ** TK_VARIABLE: variable number (always >= 1). */ 1922b7916a78Sdrh i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 1923b7916a78Sdrh i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 1924030796dfSdrh u8 op2; /* TK_REGISTER: original value of Expr.op 1925030796dfSdrh ** TK_COLUMN: the value of p5 for OP_Column 1926030796dfSdrh ** TK_AGG_FUNCTION: nesting depth */ 192713449892Sdrh AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 19287d10d5a6Sdrh Table *pTab; /* Table for TK_COLUMN expressions. */ 192975897234Sdrh }; 193075897234Sdrh 193175897234Sdrh /* 19321f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 19331f16230bSdrh */ 1934c5cd1249Sdrh #define EP_FromJoin 0x000001 /* Originated in ON or USING clause of a join */ 1935c5cd1249Sdrh #define EP_Agg 0x000002 /* Contains one or more aggregate functions */ 1936c5cd1249Sdrh #define EP_Resolved 0x000004 /* IDs have been resolved to COLUMNs */ 1937c5cd1249Sdrh #define EP_Error 0x000008 /* Expression contains one or more errors */ 1938c5cd1249Sdrh #define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */ 1939c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */ 1940c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */ 1941c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */ 1942fbb24d10Sdrh #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */ 1943fbb24d10Sdrh #define EP_Generic 0x000200 /* Ignore COLLATE or affinity on this tree */ 1944c5cd1249Sdrh #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */ 1945c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */ 1946a4c3c87eSdrh #define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */ 1947c5cd1249Sdrh #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */ 1948c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */ 1949c5cd1249Sdrh #define EP_Static 0x008000 /* Held in memory not obtained from malloc() */ 1950c5cd1249Sdrh #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */ 1951ebb6a65dSdrh #define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */ 1952a4c3c87eSdrh #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */ 1953b1fba286Sdrh #define EP_Constant 0x080000 /* Node is a constant */ 195433e619fcSdrh 195533e619fcSdrh /* 19561f16230bSdrh ** These macros can be used to test, set, or clear bits in the 19571f16230bSdrh ** Expr.flags field. 19581f16230bSdrh */ 1959c5cd1249Sdrh #define ExprHasProperty(E,P) (((E)->flags&(P))!=0) 1960c5cd1249Sdrh #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P)) 19611f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 19621f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 19631f16230bSdrh 1964ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation, 1965ebb6a65dSdrh ** and Accreditation only. It works like ExprSetProperty() during VVA 1966ebb6a65dSdrh ** processes but is a no-op for delivery. 1967ebb6a65dSdrh */ 1968ebb6a65dSdrh #ifdef SQLITE_DEBUG 1969ebb6a65dSdrh # define ExprSetVVAProperty(E,P) (E)->flags|=(P) 1970ebb6a65dSdrh #else 1971ebb6a65dSdrh # define ExprSetVVAProperty(E,P) 1972ebb6a65dSdrh #endif 1973ebb6a65dSdrh 19741f16230bSdrh /* 19756ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr 19766ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 19776ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set. 19786ab3a2ecSdanielk1977 */ 197912ffee8cSdrh #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 198012ffee8cSdrh #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 1981b7916a78Sdrh #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 19826ab3a2ecSdanielk1977 19836ab3a2ecSdanielk1977 /* 19846ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment 19856ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details. 19866ab3a2ecSdanielk1977 */ 198712ffee8cSdrh #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 19886ab3a2ecSdanielk1977 19896ab3a2ecSdanielk1977 /* 199075897234Sdrh ** A list of expressions. Each expression may optionally have a 199175897234Sdrh ** name. An expr/name combination can be used in several ways, such 199275897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 199375897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 1994ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 199575897234Sdrh ** field is not used. 19960dde4739Sdrh ** 19970dde4739Sdrh ** By default the Expr.zSpan field holds a human-readable description of 19980dde4739Sdrh ** the expression that is used in the generation of error messages and 19990dde4739Sdrh ** column labels. In this case, Expr.zSpan is typically the text of a 20000dde4739Sdrh ** column expression as it exists in a SELECT statement. However, if 20010dde4739Sdrh ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name 20023e3f1a5bSdrh ** of the result column in the form: DATABASE.TABLE.COLUMN. This later 20033e3f1a5bSdrh ** form is used for name resolution with nested FROM clauses. 200475897234Sdrh */ 200575897234Sdrh struct ExprList { 200675897234Sdrh int nExpr; /* Number of expressions on the list */ 2007d872bb18Sdrh struct ExprList_item { /* For each expression in the list */ 200875897234Sdrh Expr *pExpr; /* The list of expressions */ 200975897234Sdrh char *zName; /* Token associated with this expression */ 2010b7916a78Sdrh char *zSpan; /* Original text of the expression */ 20118e2ca029Sdrh u8 sortOrder; /* 1 for DESC or 0 for ASC */ 20120dde4739Sdrh unsigned done :1; /* A flag to indicate when processing is finished */ 20133e3f1a5bSdrh unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */ 2014d673cddaSdrh unsigned reusable :1; /* Constant expression is reusable */ 2015c2acc4e4Sdrh union { 2016c2acc4e4Sdrh struct { 20174b3ac73cSdrh u16 iOrderByCol; /* For ORDER BY, column number in result set */ 20188b213899Sdrh u16 iAlias; /* Index into Parse.aAlias[] for zName */ 2019c2acc4e4Sdrh } x; 2020c2acc4e4Sdrh int iConstExprReg; /* Register in which Expr value is cached */ 2021c2acc4e4Sdrh } u; 2022d872bb18Sdrh } *a; /* Alloc a power of two greater or equal to nExpr */ 202375897234Sdrh }; 202475897234Sdrh 202575897234Sdrh /* 2026b7916a78Sdrh ** An instance of this structure is used by the parser to record both 2027b7916a78Sdrh ** the parse tree for an expression and the span of input text for an 2028b7916a78Sdrh ** expression. 2029b7916a78Sdrh */ 2030b7916a78Sdrh struct ExprSpan { 2031b7916a78Sdrh Expr *pExpr; /* The expression parse tree */ 2032b7916a78Sdrh const char *zStart; /* First character of input text */ 2033b7916a78Sdrh const char *zEnd; /* One character past the end of input text */ 2034b7916a78Sdrh }; 2035b7916a78Sdrh 2036b7916a78Sdrh /* 2037ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 2038ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 2039ad3cab52Sdrh ** 2040ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 2041ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 2042ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 2043ad3cab52Sdrh ** 2044ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 2045ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 2046ad3cab52Sdrh ** 2047ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 2048ad3cab52Sdrh ** 2049ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 205075897234Sdrh */ 205175897234Sdrh struct IdList { 20526d4abfbeSdrh struct IdList_item { 2053ad3cab52Sdrh char *zName; /* Name of the identifier */ 2054967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 2055ad3cab52Sdrh } *a; 205613449892Sdrh int nId; /* Number of identifiers on the list */ 2057ad3cab52Sdrh }; 2058ad3cab52Sdrh 2059ad3cab52Sdrh /* 206051669863Sdrh ** The bitmask datatype defined below is used for various optimizations. 2061ca83ac51Sdrh ** 2062ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of 2063ca83ac51Sdrh ** tables in a join to 32 instead of 64. But it also reduces the size 2064ca83ac51Sdrh ** of the library by 738 bytes on ix86. 206551669863Sdrh */ 2066ca83ac51Sdrh typedef u64 Bitmask; 206751669863Sdrh 206851669863Sdrh /* 206900e13613Sdanielk1977 ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 207000e13613Sdanielk1977 */ 207100e13613Sdanielk1977 #define BMS ((int)(sizeof(Bitmask)*8)) 207200e13613Sdanielk1977 207300e13613Sdanielk1977 /* 20747699d1c4Sdrh ** A bit in a Bitmask 20757699d1c4Sdrh */ 20767699d1c4Sdrh #define MASKBIT(n) (((Bitmask)1)<<(n)) 2077693e6719Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n)) 20787699d1c4Sdrh 20797699d1c4Sdrh /* 2080ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement. 2081ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of 2082ad3cab52Sdrh ** the SrcList.a[] array. 2083d24cc427Sdrh ** 2084d24cc427Sdrh ** With the addition of multiple database support, the following structure 2085d24cc427Sdrh ** can also be used to describe a particular table such as the table that 2086d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 2087d24cc427Sdrh ** such a table must be a simple name: ID. But in SQLite, the table can 2088d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 2089c49de5d9Sdrh ** 2090c49de5d9Sdrh ** The jointype starts out showing the join type between the current table 2091c49de5d9Sdrh ** and the next table on the list. The parser builds the list this way. 2092c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 2093c49de5d9Sdrh ** jointype expresses the join between the table and the previous table. 20942a6a7eebSdrh ** 20952a6a7eebSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table 20962a6a7eebSdrh ** contains more than 63 columns and the 64-th or later column is used. 2097ad3cab52Sdrh */ 2098ad3cab52Sdrh struct SrcList { 20996d1626ebSdrh int nSrc; /* Number of tables or subqueries in the FROM clause */ 21006d1626ebSdrh u32 nAlloc; /* Number of entries allocated in a[] below */ 2101ad3cab52Sdrh struct SrcList_item { 210241fb5cd1Sdan Schema *pSchema; /* Schema to which this item is fixed */ 2103113088ecSdrh char *zDatabase; /* Name of database holding this table */ 2104ad3cab52Sdrh char *zName; /* Name of the table */ 2105ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 2106daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 2107daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 21085b6a9ed4Sdrh int addrFillSub; /* Address of subroutine to manifest a subquery */ 21095b6a9ed4Sdrh int regReturn; /* Register holding return address of addrFillSub */ 21105f612295Sdrh int regResult; /* Registers holding results of a co-routine */ 2111c49de5d9Sdrh u8 jointype; /* Type of join between this able and the previous */ 211221172c4cSdrh unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */ 211321172c4cSdrh unsigned isCorrelated :1; /* True if sub-query is correlated */ 211421172c4cSdrh unsigned viaCoroutine :1; /* Implemented as a co-routine */ 2115f43fe6e9Sdan unsigned isRecursive :1; /* True for recursive reference in WITH */ 2116ce7e189dSdan #ifndef SQLITE_OMIT_EXPLAIN 2117ce7e189dSdan u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */ 2118ce7e189dSdan #endif 2119e68fbe79Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 2120ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 2121ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 2122cd38d520Sdanielk1977 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 212385574e31Sdanielk1977 char *zIndex; /* Identifier from "INDEXED BY <zIndex>" clause */ 212485574e31Sdanielk1977 Index *pIndex; /* Index structure corresponding to zIndex, if any */ 2125113088ecSdrh } a[1]; /* One entry for each identifier on the list */ 212675897234Sdrh }; 212775897234Sdrh 212875897234Sdrh /* 212901f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 213001f3f253Sdrh */ 213101f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 21323dec223cSdrh #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 21333dec223cSdrh #define JT_NATURAL 0x0004 /* True for a "natural" join */ 21343dec223cSdrh #define JT_LEFT 0x0008 /* Left outer join */ 21353dec223cSdrh #define JT_RIGHT 0x0010 /* Right outer join */ 21363dec223cSdrh #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 21373dec223cSdrh #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 213801f3f253Sdrh 2139111a6a7dSdrh 2140111a6a7dSdrh /* 2141336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 2142336a5300Sdrh ** and the WhereInfo.wctrlFlags member. 214308c88eb0Sdrh */ 21446df2acd2Sdrh #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 21456df2acd2Sdrh #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 21466df2acd2Sdrh #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 21476df2acd2Sdrh #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 2148336a5300Sdrh #define WHERE_DUPLICATES_OK 0x0008 /* Ok to return a row more than once */ 21499ef61f4fSdrh #define WHERE_OMIT_OPEN_CLOSE 0x0010 /* Table cursors are already open */ 21509ef61f4fSdrh #define WHERE_FORCE_TABLE 0x0020 /* Do not use an index-only search */ 21519ef61f4fSdrh #define WHERE_ONETABLE_ONLY 0x0040 /* Only code the 1st table in pTabList */ 21529ef61f4fSdrh #define WHERE_AND_ONLY 0x0080 /* Don't use indices for OR terms */ 2153319f677dSdrh #define WHERE_GROUPBY 0x0100 /* pOrderBy is really a GROUP BY */ 21544f402f26Sdrh #define WHERE_DISTINCTBY 0x0200 /* pOrderby is really a DISTINCT clause */ 21556457a353Sdrh #define WHERE_WANT_DISTINCT 0x0400 /* All output needs to be distinct */ 2156374cd78cSdan #define WHERE_SORTBYGROUP 0x0800 /* Support sqlite3WhereIsSorted() */ 21573526319bSdrh #define WHERE_REOPEN_IDX 0x1000 /* Try to use OP_ReopenIdx */ 2158a9d1ccb9Sdanielk1977 21594f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct() 21604f402f26Sdrh */ 2161e8e4af76Sdrh #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */ 2162ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */ 2163ae651d61Sdrh #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */ 2164e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */ 216538cc40c2Sdan 216675897234Sdrh /* 2167b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column 2168b3bce662Sdanielk1977 ** names. The context consists of a list of tables (the pSrcList) field and 2169b3bce662Sdanielk1977 ** a list of named expression (pEList). The named expression list may 2170b3bce662Sdanielk1977 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 2171b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 2172b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for 2173b3bce662Sdanielk1977 ** other statements. 2174b3bce662Sdanielk1977 ** 2175b3bce662Sdanielk1977 ** NameContexts can be nested. When resolving names, the inner-most 2176b3bce662Sdanielk1977 ** context is searched first. If no match is found, the next outer 2177b3bce662Sdanielk1977 ** context is checked. If there is still no match, the next context 2178b3bce662Sdanielk1977 ** is checked. This process continues until either a match is found 2179b3bce662Sdanielk1977 ** or all contexts are check. When a match is found, the nRef member of 2180b3bce662Sdanielk1977 ** the context containing the match is incremented. 2181b3bce662Sdanielk1977 ** 2182b3bce662Sdanielk1977 ** Each subquery gets a new NameContext. The pNext field points to the 2183b3bce662Sdanielk1977 ** NameContext in the parent query. Thus the process of scanning the 2184b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer 2185b3bce662Sdanielk1977 ** subqueries looking for a match. 2186b3bce662Sdanielk1977 */ 2187b3bce662Sdanielk1977 struct NameContext { 2188b3bce662Sdanielk1977 Parse *pParse; /* The parser */ 2189b3bce662Sdanielk1977 SrcList *pSrcList; /* One or more tables used to resolve names */ 219026080d92Sdrh ExprList *pEList; /* Optional list of result-set columns */ 219113449892Sdrh AggInfo *pAggInfo; /* Information about aggregates at this level */ 2192b3bce662Sdanielk1977 NameContext *pNext; /* Next outer name context. NULL for outermost */ 2193a51009b2Sdrh int nRef; /* Number of names resolved by this context */ 2194a51009b2Sdrh int nErr; /* Number of errors encountered while resolving names */ 2195a51009b2Sdrh u8 ncFlags; /* Zero or more NC_* flags defined below */ 2196b3bce662Sdanielk1977 }; 2197b3bce662Sdanielk1977 2198b3bce662Sdanielk1977 /* 2199a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field. 2200a51009b2Sdrh */ 2201a51009b2Sdrh #define NC_AllowAgg 0x01 /* Aggregate functions are allowed here */ 2202a51009b2Sdrh #define NC_HasAgg 0x02 /* One or more aggregate functions seen */ 2203a51009b2Sdrh #define NC_IsCheck 0x04 /* True if resolving names in a CHECK constraint */ 22043a8c4be7Sdrh #define NC_InAggFunc 0x08 /* True if analyzing arguments to an agg func */ 2205e35463b3Sdrh #define NC_PartIdx 0x10 /* True if resolving a partial index WHERE */ 2206a51009b2Sdrh 2207a51009b2Sdrh /* 22089bb61fe7Sdrh ** An instance of the following structure contains all information 22099bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 2210a76b5dfcSdrh ** 2211d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0. 2212d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the 2213d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not 2214d11d382cSdrh ** offset). But later on, nLimit and nOffset become the memory locations 2215d11d382cSdrh ** in the VDBE that record the limit and offset counters. 22160342b1f5Sdrh ** 2217b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 22180342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in 221966a5167bSdrh ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 22200342b1f5Sdrh ** the number of columns in P2 can be computed at the same time 2221b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not 22220342b1f5Sdrh ** enough information about the compound query is known at that point. 2223b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 22242c79733fSdrh ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating 22250342b1f5Sdrh ** sequences for the ORDER BY clause. 22269bb61fe7Sdrh */ 22279bb61fe7Sdrh struct Select { 22289bb61fe7Sdrh ExprList *pEList; /* The fields of the result */ 22297b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 22307d10d5a6Sdrh u16 selFlags; /* Various SF_* values */ 2231a451017dSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 2232079a3072Sdrh int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */ 2233c63367efSdrh u64 nSelectRow; /* Estimated number of result rows */ 2234ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 22359bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 22369bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 22379bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 22389bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 2239967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 22401e281291Sdrh Select *pNext; /* Next select to the left in a compound */ 2241a2dc3b1aSdanielk1977 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 2242a2dc3b1aSdanielk1977 Expr *pOffset; /* OFFSET expression. NULL means not used. */ 22434e9119d9Sdan With *pWith; /* WITH clause attached to this select. Or NULL. */ 22449bb61fe7Sdrh }; 22459bb61fe7Sdrh 22469bb61fe7Sdrh /* 22477d10d5a6Sdrh ** Allowed values for Select.selFlags. The "SF" prefix stands for 22487d10d5a6Sdrh ** "Select Flag". 22497d10d5a6Sdrh */ 225021172c4cSdrh #define SF_Distinct 0x0001 /* Output should be DISTINCT */ 225121172c4cSdrh #define SF_Resolved 0x0002 /* Identifiers have been resolved */ 225221172c4cSdrh #define SF_Aggregate 0x0004 /* Contains aggregate functions */ 225321172c4cSdrh #define SF_UsesEphemeral 0x0008 /* Uses the OpenEphemeral opcode */ 225421172c4cSdrh #define SF_Expanded 0x0010 /* sqlite3SelectExpand() called on this */ 225521172c4cSdrh #define SF_HasTypeInfo 0x0020 /* FROM subqueries have Table metadata */ 2256079a3072Sdrh /* 0x0040 NOT USED */ 225721172c4cSdrh #define SF_Values 0x0080 /* Synthesized from VALUES clause */ 2258079a3072Sdrh /* 0x0100 NOT USED */ 2259832ee3d4Sdrh #define SF_NestedFrom 0x0200 /* Part of a parenthesized FROM clause */ 2260d58d3278Sdrh #define SF_MaybeConvert 0x0400 /* Need convertCompoundSelectToSubquery() */ 2261eae73fbfSdan #define SF_Recursive 0x0800 /* The recursive part of a recursive CTE */ 2262d227a291Sdrh #define SF_Compound 0x1000 /* Part of a compound query */ 22637d10d5a6Sdrh 22647d10d5a6Sdrh 22657d10d5a6Sdrh /* 2266340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined 2267340309fdSdrh ** by one of the following macros. The "SRT" prefix means "SELECT Result 2268340309fdSdrh ** Type". 2269340309fdSdrh ** 2270340309fdSdrh ** SRT_Union Store results as a key in a temporary index 2271340309fdSdrh ** identified by pDest->iSDParm. 2272340309fdSdrh ** 2273340309fdSdrh ** SRT_Except Remove results from the temporary index pDest->iSDParm. 2274340309fdSdrh ** 2275340309fdSdrh ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result 2276340309fdSdrh ** set is not empty. 2277340309fdSdrh ** 2278340309fdSdrh ** SRT_Discard Throw the results away. This is used by SELECT 2279340309fdSdrh ** statements within triggers whose only purpose is 2280340309fdSdrh ** the side-effects of functions. 2281340309fdSdrh ** 2282340309fdSdrh ** All of the above are free to ignore their ORDER BY clause. Those that 2283340309fdSdrh ** follow must honor the ORDER BY clause. 2284340309fdSdrh ** 2285340309fdSdrh ** SRT_Output Generate a row of output (using the OP_ResultRow 2286340309fdSdrh ** opcode) for each row in the result set. 2287340309fdSdrh ** 2288340309fdSdrh ** SRT_Mem Only valid if the result is a single column. 2289340309fdSdrh ** Store the first column of the first result row 2290340309fdSdrh ** in register pDest->iSDParm then abandon the rest 2291340309fdSdrh ** of the query. This destination implies "LIMIT 1". 2292340309fdSdrh ** 2293340309fdSdrh ** SRT_Set The result must be a single column. Store each 2294340309fdSdrh ** row of result as the key in table pDest->iSDParm. 2295340309fdSdrh ** Apply the affinity pDest->affSdst before storing 2296340309fdSdrh ** results. Used to implement "IN (SELECT ...)". 2297340309fdSdrh ** 2298340309fdSdrh ** SRT_EphemTab Create an temporary table pDest->iSDParm and store 2299340309fdSdrh ** the result there. The cursor is left open after 2300340309fdSdrh ** returning. This is like SRT_Table except that 2301340309fdSdrh ** this destination uses OP_OpenEphemeral to create 2302340309fdSdrh ** the table first. 2303340309fdSdrh ** 2304340309fdSdrh ** SRT_Coroutine Generate a co-routine that returns a new row of 2305340309fdSdrh ** results each time it is invoked. The entry point 2306340309fdSdrh ** of the co-routine is stored in register pDest->iSDParm 2307340309fdSdrh ** and the result row is stored in pDest->nDest registers 2308340309fdSdrh ** starting with pDest->iSdst. 2309340309fdSdrh ** 2310781def29Sdrh ** SRT_Table Store results in temporary table pDest->iSDParm. 23118e1ee88cSdrh ** SRT_Fifo This is like SRT_EphemTab except that the table 23128e1ee88cSdrh ** is assumed to already be open. SRT_Fifo has 23138e1ee88cSdrh ** the additional property of being able to ignore 23148e1ee88cSdrh ** the ORDER BY clause. 2315781def29Sdrh ** 23168e1ee88cSdrh ** SRT_DistFifo Store results in a temporary table pDest->iSDParm. 2317340309fdSdrh ** But also use temporary table pDest->iSDParm+1 as 2318340309fdSdrh ** a record of all prior results and ignore any duplicate 23198e1ee88cSdrh ** rows. Name means: "Distinct Fifo". 2320781def29Sdrh ** 2321781def29Sdrh ** SRT_Queue Store results in priority queue pDest->iSDParm (really 2322781def29Sdrh ** an index). Append a sequence number so that all entries 2323781def29Sdrh ** are distinct. 2324781def29Sdrh ** 2325781def29Sdrh ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if 2326781def29Sdrh ** the same record has never been stored before. The 2327781def29Sdrh ** index at pDest->iSDParm+1 hold all prior stores. 2328fef5208cSdrh */ 232913449892Sdrh #define SRT_Union 1 /* Store result as keys in an index */ 233013449892Sdrh #define SRT_Except 2 /* Remove result from a UNION index */ 23319ed1dfa8Sdanielk1977 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 23329ed1dfa8Sdanielk1977 #define SRT_Discard 4 /* Do not save the results anywhere */ 23338e1ee88cSdrh #define SRT_Fifo 5 /* Store result as data with an automatic rowid */ 23348e1ee88cSdrh #define SRT_DistFifo 6 /* Like SRT_Fifo, but unique results only */ 23358e1ee88cSdrh #define SRT_Queue 7 /* Store result in an queue */ 23368e1ee88cSdrh #define SRT_DistQueue 8 /* Like SRT_Queue, but unique results only */ 2337fef5208cSdrh 233813449892Sdrh /* The ORDER BY clause is ignored for all of the above */ 23398e1ee88cSdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue) 234013449892Sdrh 23418e1ee88cSdrh #define SRT_Output 9 /* Output each row of result */ 23428e1ee88cSdrh #define SRT_Mem 10 /* Store result in a memory cell */ 23438e1ee88cSdrh #define SRT_Set 11 /* Store results as keys in an index */ 23448e1ee88cSdrh #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */ 23458e1ee88cSdrh #define SRT_Coroutine 13 /* Generate a single row of result */ 23468e1ee88cSdrh #define SRT_Table 14 /* Store result as data with an automatic rowid */ 23472282792aSdrh 23482282792aSdrh /* 2349634d81deSdrh ** An instance of this object describes where to put of the results of 2350634d81deSdrh ** a SELECT statement. 23516c8c8ce0Sdanielk1977 */ 23526c8c8ce0Sdanielk1977 struct SelectDest { 2353634d81deSdrh u8 eDest; /* How to dispose of the results. On of SRT_* above. */ 2354634d81deSdrh char affSdst; /* Affinity used when eDest==SRT_Set */ 23552b596da8Sdrh int iSDParm; /* A parameter used by the eDest disposal method */ 23562b596da8Sdrh int iSdst; /* Base register where results are written */ 23572b596da8Sdrh int nSdst; /* Number of registers allocated */ 2358fe1c6bb9Sdrh ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */ 23596c8c8ce0Sdanielk1977 }; 23606c8c8ce0Sdanielk1977 23616c8c8ce0Sdanielk1977 /* 23620b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT 23630b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p 23640b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that 23650b9f50d8Sdrh ** the code generator needs. We have to keep per-table autoincrement 23660b9f50d8Sdrh ** information in case inserts are down within triggers. Triggers do not 23670b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the 23680b9f50d8Sdrh ** loading and saving of autoincrement information. 23690b9f50d8Sdrh */ 23700b9f50d8Sdrh struct AutoincInfo { 23710b9f50d8Sdrh AutoincInfo *pNext; /* Next info block in a list of them all */ 23720b9f50d8Sdrh Table *pTab; /* Table this info block refers to */ 23730b9f50d8Sdrh int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 23740b9f50d8Sdrh int regCtr; /* Memory register holding the rowid counter */ 23750b9f50d8Sdrh }; 23760b9f50d8Sdrh 23770b9f50d8Sdrh /* 2378ceea3321Sdrh ** Size of the column cache 2379ceea3321Sdrh */ 2380ceea3321Sdrh #ifndef SQLITE_N_COLCACHE 2381ceea3321Sdrh # define SQLITE_N_COLCACHE 10 2382ceea3321Sdrh #endif 2383ceea3321Sdrh 23842832ad42Sdan /* 23852832ad42Sdan ** At least one instance of the following structure is created for each 23862832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 23872832ad42Sdan ** statement. All such objects are stored in the linked list headed at 23882832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been 23892832ad42Sdan ** completed. 23902832ad42Sdan ** 23912832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger 23922832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 23932832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 23942832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same 23952832ad42Sdan ** values for both pTrigger and orconf. 239665a7cd16Sdan ** 2397bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 239865a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT 2399bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 2400bb5f168fSdan ** a mask of new.* columns used by the program. 24012832ad42Sdan */ 24022832ad42Sdan struct TriggerPrg { 24032832ad42Sdan Trigger *pTrigger; /* Trigger this program was coded from */ 24042832ad42Sdan TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 2405a451017dSdrh SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 2406a451017dSdrh int orconf; /* Default ON CONFLICT policy */ 2407a451017dSdrh u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 2408165921a7Sdan }; 2409165921a7Sdan 241064123585Sdrh /* 241164123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases. 241264123585Sdrh */ 241301c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30 2414a7ab6d81Sdrh typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8]; 2415a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0) 2416a7ab6d81Sdrh # define DbMaskZero(M) memset((M),0,sizeof(M)) 2417a7ab6d81Sdrh # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7)) 2418a7ab6d81Sdrh # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M) 2419a7ab6d81Sdrh # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0) 242001c7dc88Sdrh #else 242164123585Sdrh typedef unsigned int yDbMask; 2422a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0) 2423a7ab6d81Sdrh # define DbMaskZero(M) (M)=0 2424a7ab6d81Sdrh # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I)) 2425a7ab6d81Sdrh # define DbMaskAllZero(M) (M)==0 2426a7ab6d81Sdrh # define DbMaskNonZero(M) (M)!=0 242701c7dc88Sdrh #endif 242801c7dc88Sdrh 2429ceea3321Sdrh /* 2430f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 2431f57b3399Sdrh ** the parser and down into all the parser action routine in order to 2432f57b3399Sdrh ** carry around information that is global to the entire parse. 2433f1974846Sdrh ** 2434f1974846Sdrh ** The structure is divided into two parts. When the parser and code 2435f1974846Sdrh ** generate call themselves recursively, the first part of the structure 2436f1974846Sdrh ** is constant but the second part is reset at the beginning and end of 2437f1974846Sdrh ** each recursion. 2438c00da105Sdanielk1977 ** 2439c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache 2440c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 2441c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being 2442c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the 2443c00da105Sdanielk1977 ** list. 244475897234Sdrh */ 244575897234Sdrh struct Parse { 24469bb575fdSdrh sqlite3 *db; /* The main database structure */ 244775897234Sdrh char *zErrMsg; /* An error message */ 244875897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 2449a451017dSdrh int rc; /* Return code from execution */ 2450836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 2451a6ecd338Sdrh u8 checkSchema; /* Causes schema cookie check after an error */ 2452205f48e6Sdrh u8 nested; /* Number of nested calls to the parser/code generator */ 2453892d3179Sdrh u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 2454a451017dSdrh u8 isMultiWrite; /* True if statement may modify/insert multiple rows */ 2455a451017dSdrh u8 mayAbort; /* True if statement may throw an ABORT exception */ 2456d58d3278Sdrh u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */ 2457aceb31b1Sdrh u8 okConstFactor; /* OK to factor out constants */ 2458892d3179Sdrh int aTempReg[8]; /* Holding area for temporary registers */ 2459892d3179Sdrh int nRangeReg; /* Size of the temporary register block */ 2460892d3179Sdrh int iRangeReg; /* First register in temporary register block */ 246175897234Sdrh int nErr; /* Number of errors seen */ 2462832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 246319a775c2Sdrh int nMem; /* Number of memory cells used so far */ 2464fef5208cSdrh int nSet; /* Number of sets used so far */ 24651d8cb21fSdan int nOnce; /* Number of OP_Once instructions so far */ 246673d5b8f5Sdrh int nOpAlloc; /* Number of slots allocated for Vdbe.aOp[] */ 246761019c78Sdrh int iFixedOp; /* Never back out opcodes iFixedOp-1 or earlier */ 2468aa9b8963Sdrh int ckBase; /* Base register of data during check constraints */ 2469b2b9d3d7Sdrh int iPartIdxTab; /* Table corresponding to a partial index */ 2470ceea3321Sdrh int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */ 2471ceea3321Sdrh int iCacheCnt; /* Counter used to generate aColCache[].lru values */ 24727df89c8cSdrh int nLabel; /* Number of labels used */ 24737df89c8cSdrh int *aLabel; /* Space to hold the labels */ 24742f7794c1Sdrh struct yColCache { 2475e55cbd72Sdrh int iTable; /* Table cursor number */ 24767df89c8cSdrh i16 iColumn; /* Table column number */ 2477ceea3321Sdrh u8 tempReg; /* iReg is a temp register that needs to be freed */ 2478ceea3321Sdrh int iLevel; /* Nesting level */ 2479ceea3321Sdrh int iReg; /* Reg with value of this column. 0 means none. */ 2480ceea3321Sdrh int lru; /* Least recently used entry has the smallest value */ 2481ceea3321Sdrh } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */ 2482f30a969bSdrh ExprList *pConstExpr;/* Constant expressions */ 24837df89c8cSdrh Token constraintName;/* Name of the constraint currently being parsed */ 248464123585Sdrh yDbMask writeMask; /* Start a write transaction on these databases */ 248564123585Sdrh yDbMask cookieMask; /* Bitmask of schema verified databases */ 2486c797d4dcSdrh int cookieValue[SQLITE_MAX_ATTACHED+2]; /* Values of cookies to verify */ 2487a451017dSdrh int regRowid; /* Register holding rowid of CREATE TABLE entry */ 2488a451017dSdrh int regRoot; /* Register holding root page number for new objects */ 2489a451017dSdrh int nMaxArg; /* Max args passed to user function by sub-program */ 2490c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 2491c00da105Sdanielk1977 int nTableLock; /* Number of locks in aTableLock */ 2492c00da105Sdanielk1977 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 2493c00da105Sdanielk1977 #endif 24940b9f50d8Sdrh AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 2495f1974846Sdrh 2496165921a7Sdan /* Information used while coding trigger programs. */ 249765a7cd16Sdan Parse *pToplevel; /* Parse structure for main program (or NULL) */ 2498165921a7Sdan Table *pTriggerTab; /* Table triggers are being coded for */ 2499c6bd4e4aSdrh int addrCrTab; /* Address of OP_CreateTable opcode on CREATE TABLE */ 2500c6bd4e4aSdrh int addrSkipPK; /* Address of instruction to skip PRIMARY KEY index */ 25014f402f26Sdrh u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */ 250265a7cd16Sdan u32 oldmask; /* Mask of old.* columns referenced */ 2503bb5f168fSdan u32 newmask; /* Mask of new.* columns referenced */ 250465a7cd16Sdan u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 250565a7cd16Sdan u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 2506d66c8309Sdan u8 disableTriggers; /* True to disable triggers */ 2507165921a7Sdan 25087df89c8cSdrh /************************************************************************ 25097df89c8cSdrh ** Above is constant between recursions. Below is reset before and after 25107df89c8cSdrh ** each recursion. The boundary between these two regions is determined 25117df89c8cSdrh ** using offsetof(Parse,nVar) so the nVar field must be the first field 25127df89c8cSdrh ** in the recursive region. 25137df89c8cSdrh ************************************************************************/ 2514f1974846Sdrh 2515f1974846Sdrh int nVar; /* Number of '?' variables seen in the SQL so far */ 2516124c0b49Sdrh int nzVar; /* Number of available slots in azVar[] */ 25177f9c5dbfSdrh u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */ 25187df89c8cSdrh u8 bFreeWith; /* True if pWith should be freed with parser */ 2519a451017dSdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 2520a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 2521a451017dSdrh u8 declareVtab; /* True if inside sqlite3_declare_vtab() */ 2522a451017dSdrh int nVtabLock; /* Number of virtual tables to lock */ 2523a451017dSdrh #endif 2524a451017dSdrh int nAlias; /* Number of aliased result set columns */ 2525a451017dSdrh int nHeight; /* Expression tree height of current sub-select */ 2526a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN 2527a451017dSdrh int iSelectId; /* ID of current select for EXPLAIN output */ 2528a451017dSdrh int iNextSelectId; /* Next available select ID for EXPLAIN output */ 2529a451017dSdrh #endif 2530124c0b49Sdrh char **azVar; /* Pointers to names of parameters */ 2531937d0deaSdan Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 2532f1974846Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 2533f1974846Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 2534f1974846Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 2535f1974846Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 2536a451017dSdrh Token sNameToken; /* Token with unqualified schema object name */ 2537a451017dSdrh Token sLastToken; /* The last token parsed */ 2538b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 253933b3933cSdanielk1977 Token sArg; /* Complete text of a module argument */ 25404f3dd150Sdrh Table **apVtabLock; /* Pointer to virtual tables needing locking */ 2541b9bb7c18Sdrh #endif 2542588a9a1aSdrh Table *pZombieTab; /* List of Table objects to delete after code gen */ 25432832ad42Sdan TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 25444e9119d9Sdan With *pWith; /* Current WITH clause, or NULL */ 254575897234Sdrh }; 254675897234Sdrh 2547a451017dSdrh /* 2548a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call. 2549a451017dSdrh */ 25507e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE 25517e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB 0 25527e6ebfb2Sdanielk1977 #else 25537e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB (pParse->declareVtab) 25547e6ebfb2Sdanielk1977 #endif 25557e6ebfb2Sdanielk1977 2556d99bc930Sdanielk1977 /* 255785e2096fSdrh ** An instance of the following structure can be declared on a stack and used 255885e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 255985e2096fSdrh */ 256085e2096fSdrh struct AuthContext { 256185e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 256285e2096fSdrh Parse *pParse; /* The Parse structure */ 256385e2096fSdrh }; 256485e2096fSdrh 256585e2096fSdrh /* 2566a748fdccSdrh ** Bitfield flags for P5 value in various opcodes. 2567b0c374ffSrdc */ 25683e9ca094Sdrh #define OPFLAG_NCHANGE 0x01 /* Set to update db->nChange */ 25693e9ca094Sdrh #define OPFLAG_LASTROWID 0x02 /* Set to update db->lastRowid */ 25703e9ca094Sdrh #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 25713e9ca094Sdrh #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 25723e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 25733e9ca094Sdrh #define OPFLAG_CLEARCACHE 0x20 /* Clear pseudo-table cache in OP_Column */ 2574a748fdccSdrh #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */ 2575a748fdccSdrh #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */ 2576428c218cSdan #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */ 2577428c218cSdan #define OPFLAG_P2ISREG 0x02 /* P2 to OP_Open** is a register number */ 2578953f7611Sdrh #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */ 2579b0c374ffSrdc 2580b0c374ffSrdc /* 2581d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 2582d99bc930Sdanielk1977 * struct Trigger. 2583d99bc930Sdanielk1977 * 2584d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 25859bb575fdSdrh * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 2586d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 2587d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 2588ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 2589ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 2590ad3cab52Sdrh * struct Table. 2591d99bc930Sdanielk1977 * 2592ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 2593ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 2594d99bc930Sdanielk1977 */ 2595d99bc930Sdanielk1977 struct Trigger { 2596165921a7Sdan char *zName; /* The name of the trigger */ 2597d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 2598f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 2599dca76841Sdrh u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 2600467bcf36Sshane Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 2601d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 2602d99bc930Sdanielk1977 the <column-list> is stored here */ 2603e501b89aSdanielk1977 Schema *pSchema; /* Schema containing the trigger */ 2604e501b89aSdanielk1977 Schema *pTabSchema; /* Schema containing the table */ 2605d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 2606d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 2607c3f9bad2Sdanielk1977 }; 2608d99bc930Sdanielk1977 2609d99bc930Sdanielk1977 /* 2610dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger. The following constants 2611dca76841Sdrh ** determine which. 2612dca76841Sdrh ** 2613dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER. 2614dca76841Sdrh ** In that cases, the constants below can be ORed together. 2615dca76841Sdrh */ 2616dca76841Sdrh #define TRIGGER_BEFORE 1 2617dca76841Sdrh #define TRIGGER_AFTER 2 2618dca76841Sdrh 2619dca76841Sdrh /* 2620d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 2621d99bc930Sdanielk1977 * that is a part of a trigger-program. 2622d99bc930Sdanielk1977 * 2623d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 2624d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 2625d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 2626d99bc930Sdanielk1977 * the first step of the trigger-program. 2627d99bc930Sdanielk1977 * 2628d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 2629d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 2630d99bc930Sdanielk1977 * value of "op" as follows: 2631d99bc930Sdanielk1977 * 2632d99bc930Sdanielk1977 * (op == TK_INSERT) 2633d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 2634d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 2635d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 2636b7916a78Sdrh * target -> A token holding the quoted name of the table to insert into. 2637d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 2638d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 2639d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 2640ad3cab52Sdrh * statement, then this stores the column-names to be 2641ad3cab52Sdrh * inserted into. 2642d99bc930Sdanielk1977 * 2643d99bc930Sdanielk1977 * (op == TK_DELETE) 2644b7916a78Sdrh * target -> A token holding the quoted name of the table to delete from. 2645d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 2646d99bc930Sdanielk1977 * Otherwise NULL. 2647d99bc930Sdanielk1977 * 2648d99bc930Sdanielk1977 * (op == TK_UPDATE) 2649b7916a78Sdrh * target -> A token holding the quoted name of the table to update rows of. 2650d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 2651d99bc930Sdanielk1977 * Otherwise NULL. 2652d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 26534adee20fSdanielk1977 * them to. See sqlite3Update() documentation of "pChanges" 2654ad3cab52Sdrh * argument. 2655d99bc930Sdanielk1977 * 2656d99bc930Sdanielk1977 */ 2657c3f9bad2Sdanielk1977 struct TriggerStep { 2658b1819a0bSdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */ 2659b1819a0bSdrh u8 orconf; /* OE_Rollback etc. */ 2660a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 2661b1819a0bSdrh Select *pSelect; /* SELECT statment or RHS of INSERT INTO .. SELECT ... */ 2662b1819a0bSdrh Token target; /* Target table for DELETE, UPDATE, INSERT */ 2663b1819a0bSdrh Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 266475593d96Sdrh ExprList *pExprList; /* SET clause for UPDATE. */ 2665b1819a0bSdrh IdList *pIdList; /* Column names for INSERT */ 2666c3f9bad2Sdanielk1977 TriggerStep *pNext; /* Next in the link-list */ 2667187e4c6aSdrh TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 2668c3f9bad2Sdanielk1977 }; 2669c3f9bad2Sdanielk1977 2670d99bc930Sdanielk1977 /* 2671f26e09c8Sdrh ** The following structure contains information used by the sqliteFix... 2672f26e09c8Sdrh ** routines as they walk the parse tree to make database references 2673f26e09c8Sdrh ** explicit. 2674f26e09c8Sdrh */ 2675f26e09c8Sdrh typedef struct DbFixer DbFixer; 2676f26e09c8Sdrh struct DbFixer { 2677f26e09c8Sdrh Parse *pParse; /* The parsing context. Error messages written here */ 267841fb5cd1Sdan Schema *pSchema; /* Fix items to this schema */ 267946539d7cSdan int bVarOnly; /* Check for variable references only */ 2680f26e09c8Sdrh const char *zDb; /* Make sure all objects are contained in this database */ 2681f26e09c8Sdrh const char *zType; /* Type of the container - used for error messages */ 2682f26e09c8Sdrh const Token *pName; /* Name of the container - used for error messages */ 2683f26e09c8Sdrh }; 2684f26e09c8Sdrh 2685f26e09c8Sdrh /* 2686ade86483Sdrh ** An objected used to accumulate the text of a string where we 2687ade86483Sdrh ** do not necessarily know how big the string will be in the end. 2688ade86483Sdrh */ 2689ade86483Sdrh struct StrAccum { 2690633e6d57Sdrh sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 2691ade86483Sdrh char *zBase; /* A base allocation. Not from malloc. */ 2692ade86483Sdrh char *zText; /* The string collected so far */ 2693ade86483Sdrh int nChar; /* Length of the string so far */ 2694ade86483Sdrh int nAlloc; /* Amount of space allocated in zText */ 2695bb4957f8Sdrh int mxAlloc; /* Maximum allowed string length */ 2696b975598eSdrh u8 useMalloc; /* 0: none, 1: sqlite3DbMalloc, 2: sqlite3_malloc */ 2697b49bc86aSdrh u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */ 2698ade86483Sdrh }; 2699b49bc86aSdrh #define STRACCUM_NOMEM 1 2700b49bc86aSdrh #define STRACCUM_TOOBIG 2 2701ade86483Sdrh 2702ade86483Sdrh /* 2703234c39dfSdrh ** A pointer to this structure is used to communicate information 2704234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 2705234c39dfSdrh */ 2706234c39dfSdrh typedef struct { 27079bb575fdSdrh sqlite3 *db; /* The database being initialized */ 2708234c39dfSdrh char **pzErrMsg; /* Error message stored here */ 2709a451017dSdrh int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 271015ca1df1Sdrh int rc; /* Result code stored here */ 2711234c39dfSdrh } InitData; 2712234c39dfSdrh 2713b6c29897Sdrh /* 271440257ffdSdrh ** Structure containing global configuration data for the SQLite library. 271533589797Sdrh ** 271633589797Sdrh ** This structure also contains some state information. 271740257ffdSdrh */ 271840257ffdSdrh struct Sqlite3Config { 2719fec00eabSdrh int bMemstat; /* True to enable memory status */ 2720fec00eabSdrh int bCoreMutex; /* True to enable core mutexing */ 2721fec00eabSdrh int bFullMutex; /* True to enable full mutexing */ 2722cd74b611Sdan int bOpenUri; /* True to interpret filenames as URIs */ 2723de9a7b8aSdrh int bUseCis; /* Use covering indices for full-scans */ 27240a687d12Sdrh int mxStrlen; /* Maximum string length */ 272509fe6143Sdrh int neverCorrupt; /* Database is always well-formed */ 2726633e6d57Sdrh int szLookaside; /* Default lookaside buffer size */ 2727633e6d57Sdrh int nLookaside; /* Default lookaside buffer count */ 2728fec00eabSdrh sqlite3_mem_methods m; /* Low-level memory allocation interface */ 27296d2ab0e4Sdanielk1977 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 273022e21ff4Sdan sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */ 273140257ffdSdrh void *pHeap; /* Heap storage space */ 273233589797Sdrh int nHeap; /* Size of pHeap[] */ 273333589797Sdrh int mnReq, mxReq; /* Min and max heap requests sizes */ 27349b4c59faSdrh sqlite3_int64 szMmap; /* mmap() space per open file */ 27359b4c59faSdrh sqlite3_int64 mxMmap; /* Maximum value for szMmap */ 273633589797Sdrh void *pScratch; /* Scratch memory */ 273733589797Sdrh int szScratch; /* Size of each scratch buffer */ 273833589797Sdrh int nScratch; /* Number of scratch buffers */ 273933589797Sdrh void *pPage; /* Page cache memory */ 274033589797Sdrh int szPage; /* Size of each page in pPage[] */ 274133589797Sdrh int nPage; /* Number of pages in pPage[] */ 27421875f7a3Sdrh int mxParserStack; /* maximum depth of the parser stack */ 27431875f7a3Sdrh int sharedCacheEnabled; /* true if shared-cache mode enabled */ 27441875f7a3Sdrh /* The above might be initialized to non-zero. The following need to always 27451875f7a3Sdrh ** initially be zero, however. */ 274671bc31c6Sdanielk1977 int isInit; /* True after initialization has finished */ 2747502b4e00Sdanielk1977 int inProgress; /* True while initialization in progress */ 2748e1ab2193Sdan int isMutexInit; /* True after mutexes are initialized */ 274971bc31c6Sdanielk1977 int isMallocInit; /* True after malloc is initialized */ 2750e1ab2193Sdan int isPCacheInit; /* True after malloc is initialized */ 275193ed56d9Sdrh int nRefInitMutex; /* Number of users of pInitMutex */ 2752c007f61bSdrh sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 27533f280701Sdrh void (*xLog)(void*,int,const char*); /* Function for logging */ 27543f280701Sdrh void *pLogArg; /* First argument to xLog() */ 2755ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG 2756ac455939Sdan void(*xSqllog)(void*,sqlite3*,const char*, int); 2757ac455939Sdan void *pSqllogArg; 2758ac455939Sdan #endif 2759688852abSdrh #ifdef SQLITE_VDBE_COVERAGE 2760688852abSdrh /* The following callback (if not NULL) is invoked on every VDBE branch 2761688852abSdrh ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE. 2762688852abSdrh */ 2763688852abSdrh void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx); /* Callback */ 2764688852abSdrh void *pVdbeBranchArg; /* 1st argument */ 2765688852abSdrh #endif 2766c007f61bSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST 2767c007f61bSdrh int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */ 2768c007f61bSdrh #endif 2769c007f61bSdrh int bLocaltimeFault; /* True to fail localtime() calls */ 277040257ffdSdrh }; 277140257ffdSdrh 277240257ffdSdrh /* 277309fe6143Sdrh ** This macro is used inside of assert() statements to indicate that 277409fe6143Sdrh ** the assert is only valid on a well-formed database. Instead of: 277509fe6143Sdrh ** 277609fe6143Sdrh ** assert( X ); 277709fe6143Sdrh ** 277809fe6143Sdrh ** One writes: 277909fe6143Sdrh ** 2780b2023665Sdrh ** assert( X || CORRUPT_DB ); 278109fe6143Sdrh ** 2782b2023665Sdrh ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate 2783b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt. 2784b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special 2785b2023665Sdrh ** sqlite3_test_control(). This enables assert() statements to prove 2786b2023665Sdrh ** things that are always true for well-formed databases. 278709fe6143Sdrh */ 2788b2023665Sdrh #define CORRUPT_DB (sqlite3Config.neverCorrupt==0) 278909fe6143Sdrh 279009fe6143Sdrh /* 27917d10d5a6Sdrh ** Context pointer passed down through the tree-walk. 27927d10d5a6Sdrh */ 27937d10d5a6Sdrh struct Walker { 27947d10d5a6Sdrh int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 27957d10d5a6Sdrh int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 2796b290f117Sdan void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */ 27977d10d5a6Sdrh Parse *pParse; /* Parser context. */ 2798030796dfSdrh int walkerDepth; /* Number of subqueries */ 27997d10d5a6Sdrh union { /* Extra data for callback */ 28007d10d5a6Sdrh NameContext *pNC; /* Naming context */ 28017d10d5a6Sdrh int i; /* Integer value */ 2802374fdce4Sdrh SrcList *pSrcList; /* FROM clause */ 2803030796dfSdrh struct SrcCount *pSrcCount; /* Counting column references */ 28047d10d5a6Sdrh } u; 28057d10d5a6Sdrh }; 28067d10d5a6Sdrh 28077d10d5a6Sdrh /* Forward declarations */ 28087d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*); 28097d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*); 28107d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*); 28117d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*); 28127d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*); 28137d10d5a6Sdrh 28147d10d5a6Sdrh /* 28157d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their 28167d10d5a6Sdrh ** callbacks. 28177d10d5a6Sdrh */ 28182bf90f1eSdrh #define WRC_Continue 0 /* Continue down into children */ 28192bf90f1eSdrh #define WRC_Prune 1 /* Omit children but continue walking siblings */ 28202bf90f1eSdrh #define WRC_Abort 2 /* Abandon the tree walk */ 28217d10d5a6Sdrh 28227d10d5a6Sdrh /* 2823eae73fbfSdan ** An instance of this structure represents a set of one or more CTEs 2824c49832c2Sdrh ** (common table expressions) created by a single WITH clause. 28257d562dbeSdan */ 28267d562dbeSdan struct With { 2827c49832c2Sdrh int nCte; /* Number of CTEs in the WITH clause */ 28284e9119d9Sdan With *pOuter; /* Containing WITH clause, or NULL */ 2829c49832c2Sdrh struct Cte { /* For each CTE in the WITH clause.... */ 28304e9119d9Sdan char *zName; /* Name of this CTE */ 28314e9119d9Sdan ExprList *pCols; /* List of explicit column names, or NULL */ 2832c49832c2Sdrh Select *pSelect; /* The definition of this CTE */ 2833f2655fe8Sdan const char *zErr; /* Error message for circular references */ 28347d562dbeSdan } a[1]; 28357d562dbeSdan }; 28367d562dbeSdan 28377d562dbeSdan /* 283866150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character, 283966150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character. 28404a919118Sdrh */ 28414a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) { \ 28424a919118Sdrh if( (*(zIn++))>=0xc0 ){ \ 28434a919118Sdrh while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 28444a919118Sdrh } \ 28454a919118Sdrh } 28464a919118Sdrh 28474a919118Sdrh /* 28489978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with 28499978c97eSdrh ** the same name but without the _BKPT suffix. These macros invoke 28509978c97eSdrh ** routines that report the line-number on which the error originated 28519978c97eSdrh ** using sqlite3_log(). The routines also provide a convenient place 28529978c97eSdrh ** to set a debugger breakpoint. 285349285708Sdrh */ 28549978c97eSdrh int sqlite3CorruptError(int); 28559978c97eSdrh int sqlite3MisuseError(int); 28569978c97eSdrh int sqlite3CantopenError(int); 28579978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 28589978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 28599978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 28609978c97eSdrh 286149285708Sdrh 286249285708Sdrh /* 2863b4a1fed2Sdrh ** FTS4 is really an extension for FTS3. It is enabled using the 2864b4a1fed2Sdrh ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also all 2865b4a1fed2Sdrh ** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3. 2866b4a1fed2Sdrh */ 2867b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 2868b4a1fed2Sdrh # define SQLITE_ENABLE_FTS3 2869b4a1fed2Sdrh #endif 2870b4a1fed2Sdrh 2871b4a1fed2Sdrh /* 287279f02cefSdrh ** The ctype.h header is needed for non-ASCII systems. It is also 287379f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation. 287479f02cefSdrh */ 287579f02cefSdrh #if !defined(SQLITE_ASCII) || \ 287679f02cefSdrh (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 287779f02cefSdrh # include <ctype.h> 287879f02cefSdrh #endif 287979f02cefSdrh 288079f02cefSdrh /* 288178ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(), 288278ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 288378ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale. 288478ca0e7eSdanielk1977 */ 288578ca0e7eSdanielk1977 #ifdef SQLITE_ASCII 288678ca0e7eSdanielk1977 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 288778ca0e7eSdanielk1977 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 2888dc86e2b2Sdrh # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 2889dc86e2b2Sdrh # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 289078ca0e7eSdanielk1977 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 289178ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 289278ca0e7eSdanielk1977 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 289378ca0e7eSdanielk1977 #else 289478ca0e7eSdanielk1977 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 289578ca0e7eSdanielk1977 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 289678ca0e7eSdanielk1977 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 2897dc86e2b2Sdrh # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 289878ca0e7eSdanielk1977 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 289978ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 290078ca0e7eSdanielk1977 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 290178ca0e7eSdanielk1977 #endif 290278ca0e7eSdanielk1977 290378ca0e7eSdanielk1977 /* 290475897234Sdrh ** Internal function prototypes 290575897234Sdrh */ 29063fa97302Sdrh #define sqlite3StrICmp sqlite3_stricmp 2907ea678832Sdrh int sqlite3Strlen30(const char*); 2908ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp 29092e588c75Sdanielk1977 291040257ffdSdrh int sqlite3MallocInit(void); 2911fec00eabSdrh void sqlite3MallocEnd(void); 2912fec00eabSdrh void *sqlite3Malloc(int); 2913fec00eabSdrh void *sqlite3MallocZero(int); 2914fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int); 2915fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int); 291617435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*); 291717435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int); 2918fec00eabSdrh void *sqlite3Realloc(void*, int); 291997c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int); 2920a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int); 2921633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*); 2922a7a8e14bSdanielk1977 int sqlite3MallocSize(void*); 2923633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*); 2924facf0307Sdrh void *sqlite3ScratchMalloc(int); 2925facf0307Sdrh void sqlite3ScratchFree(void*); 2926facf0307Sdrh void *sqlite3PageMalloc(int); 2927facf0307Sdrh void sqlite3PageFree(void*); 2928fec00eabSdrh void sqlite3MemSetDefault(void); 2929171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 293050d1b5f3Sdrh int sqlite3HeapNearlyFull(void); 29312e588c75Sdanielk1977 2932e7b34707Sdrh /* 2933e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make 2934e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects. By default, 2935e7b34707Sdrh ** obtain space from malloc(). 2936e7b34707Sdrh ** 2937e7b34707Sdrh ** The alloca() routine never returns NULL. This will cause code paths 2938e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable. 2939e7b34707Sdrh */ 2940e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA 2941e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) alloca(N) 2942e7b34707Sdrh # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 2943e7b34707Sdrh # define sqlite3StackFree(D,P) 2944e7b34707Sdrh #else 2945e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 2946e7b34707Sdrh # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 2947e7b34707Sdrh # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 2948e7b34707Sdrh #endif 2949e7b34707Sdrh 2950f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS3 2951f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 2952f3d3c27aSdanielk1977 #endif 2953f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5 2954f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 2955f3d3c27aSdanielk1977 #endif 2956f3d3c27aSdanielk1977 2957f3d3c27aSdanielk1977 295818472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT 2959558814f8Sdan sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 2960558814f8Sdan sqlite3_mutex_methods const *sqlite3NoopMutex(void); 296159f8c08eSdanielk1977 sqlite3_mutex *sqlite3MutexAlloc(int); 2962d025174fSdanielk1977 int sqlite3MutexInit(void); 2963d025174fSdanielk1977 int sqlite3MutexEnd(void); 296465bbf29eSdrh #endif 29656d2ab0e4Sdanielk1977 2966f7141990Sdrh int sqlite3StatusValue(int); 2967f7141990Sdrh void sqlite3StatusAdd(int, int); 2968f7141990Sdrh void sqlite3StatusSet(int, int); 2969f7141990Sdrh 297085c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT 29710de3ae95Sdrh int sqlite3IsNaN(double); 297285c8f291Sdrh #else 297385c8f291Sdrh # define sqlite3IsNaN(X) 0 297485c8f291Sdrh #endif 29750de3ae95Sdrh 2976a5c1416dSdrh /* 2977a5c1416dSdrh ** An instance of the following structure holds information about SQL 2978a5c1416dSdrh ** functions arguments that are the parameters to the printf() function. 2979a5c1416dSdrh */ 2980a5c1416dSdrh struct PrintfArguments { 2981a5c1416dSdrh int nArg; /* Total number of arguments */ 2982a5c1416dSdrh int nUsed; /* Number of arguments used so far */ 2983a5c1416dSdrh sqlite3_value **apArg; /* The argument values */ 2984a5c1416dSdrh }; 2985a5c1416dSdrh 2986a5c1416dSdrh #define SQLITE_PRINTF_INTERNAL 0x01 2987a5c1416dSdrh #define SQLITE_PRINTF_SQLFUNC 0x02 2988a5c1416dSdrh void sqlite3VXPrintf(StrAccum*, u32, const char*, va_list); 2989a5c1416dSdrh void sqlite3XPrintf(StrAccum*, u32, const char*, ...); 299017435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...); 299117435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 2992633e6d57Sdrh char *sqlite3MAppendf(sqlite3*,char*,const char*,...); 299387cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG) 2994e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...); 2995d919fe17Sdrh #endif 2996d919fe17Sdrh #if defined(SQLITE_TEST) 2997e8f52c50Sdrh void *sqlite3TestTextToPtr(const char*); 299887cc3b31Sdrh #endif 29997e02e5e6Sdrh 30007e02e5e6Sdrh /* Output formatting for SQLITE_TESTCTRL_EXPLAIN */ 3001678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN) 30027e02e5e6Sdrh void sqlite3ExplainBegin(Vdbe*); 30037e02e5e6Sdrh void sqlite3ExplainPrintf(Vdbe*, const char*, ...); 30047e02e5e6Sdrh void sqlite3ExplainNL(Vdbe*); 30057e02e5e6Sdrh void sqlite3ExplainPush(Vdbe*); 30067e02e5e6Sdrh void sqlite3ExplainPop(Vdbe*); 30077e02e5e6Sdrh void sqlite3ExplainFinish(Vdbe*); 30087e02e5e6Sdrh void sqlite3ExplainSelect(Vdbe*, Select*); 30097e02e5e6Sdrh void sqlite3ExplainExpr(Vdbe*, Expr*); 30107e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe*, ExprList*); 30117e02e5e6Sdrh const char *sqlite3VdbeExplanation(Vdbe*); 30127e02e5e6Sdrh #else 30137e02e5e6Sdrh # define sqlite3ExplainBegin(X) 30147e02e5e6Sdrh # define sqlite3ExplainSelect(A,B) 30157e02e5e6Sdrh # define sqlite3ExplainExpr(A,B) 30167e02e5e6Sdrh # define sqlite3ExplainExprList(A,B) 30177e02e5e6Sdrh # define sqlite3ExplainFinish(X) 30187e02e5e6Sdrh # define sqlite3VdbeExplanation(X) 0 30197e02e5e6Sdrh #endif 30207e02e5e6Sdrh 30217e02e5e6Sdrh 3022f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...); 30234adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...); 302424fb627aSdrh int sqlite3Dequote(char*); 30252646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int); 30264adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **); 302780242055Sdrh void sqlite3FinishCoding(Parse*); 3028892d3179Sdrh int sqlite3GetTempReg(Parse*); 3029892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int); 3030892d3179Sdrh int sqlite3GetTempRange(Parse*,int); 3031892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int); 3032cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*); 3033b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 3034b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*); 3035b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 303617435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*); 30371e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*); 303817435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*); 3039fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*); 3040633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*); 3041b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 3042b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 3043b7916a78Sdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*); 3044633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*); 30459bb575fdSdrh int sqlite3Init(sqlite3*, char**); 3046234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**); 304791cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 304881028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*); 304981028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int); 305081028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*); 30514adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int); 30529bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*); 30537d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*); 3054c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int); 30554415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*); 30564415628aSdrh i16 sqlite3ColumnOfIndex(Index*, i16); 3057f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 30584adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*); 30594adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int); 3060fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 3061ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*); 3062487e262fSdrh void sqlite3AddColumnType(Parse*,Token*); 3063b7916a78Sdrh void sqlite3AddDefaultValue(Parse*,ExprSpan*); 306439002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*); 30655969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*); 3066522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*, 3067522c26fbSdrh sqlite3_vfs**,char**,char **); 3068421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*); 30691d8cb21fSdan int sqlite3CodeOnce(Parse *); 3070b7f9164eSdrh 3071c007f61bSdrh #ifdef SQLITE_OMIT_BUILTIN_TEST 3072c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK 3073c007f61bSdrh #else 3074c007f61bSdrh int sqlite3FaultSim(int); 3075c007f61bSdrh #endif 3076c007f61bSdrh 3077f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32); 3078f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32); 3079f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32); 3080e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*); 3081f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*); 3082bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*); 30833088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*); 3084f5e7bb51Sdrh 30853d4501e5Sdrh RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int); 30863d4501e5Sdrh void sqlite3RowSetClear(RowSet*); 30873d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64); 3088d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64); 30893d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*); 30903d4501e5Sdrh 3091fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int); 3092fe3fcbe2Sdanielk1977 3093fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 30944adee20fSdanielk1977 int sqlite3ViewGetColumnNames(Parse*,Table*); 3095b7f9164eSdrh #else 3096b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0 3097b7f9164eSdrh #endif 3098b7f9164eSdrh 3099a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30 3100a7ab6d81Sdrh int sqlite3DbMaskAllZero(yDbMask); 3101a7ab6d81Sdrh #endif 3102a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int); 3103faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int); 31041feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*); 31050b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT 31060b9f50d8Sdrh void sqlite3AutoincrementBegin(Parse *pParse); 31070b9f50d8Sdrh void sqlite3AutoincrementEnd(Parse *pParse); 31080b9f50d8Sdrh #else 31090b9f50d8Sdrh # define sqlite3AutoincrementBegin(X) 31100b9f50d8Sdrh # define sqlite3AutoincrementEnd(X) 31110b9f50d8Sdrh #endif 311275593d96Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int); 31136c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*); 311417435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*); 31154adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*); 3116a78c22c4Sdrh SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int); 311717435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*); 3118b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 311985574e31Sdanielk1977 Token*, Select*, Expr*, IdList*); 3120b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 3121b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *); 312261dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*); 31234adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 3124633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*); 3125633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*); 3126bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**); 31271da40a38Sdan Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 31288a9789b6Sdrh Expr*, int, int); 31294d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int); 31307d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*); 313117435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 3132832ee3d4Sdrh Expr*,ExprList*,u16,Expr*,Expr*); 3133633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*); 31344adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*); 31354adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int); 3136c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 3137273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 313849ffdbf4Sshane Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*); 31394281bd42Sshane #endif 31404adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*); 31414adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int); 314246ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int); 31434adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*); 3144c63367efSdrh u64 sqlite3WhereOutputRowCount(WhereInfo*); 31456f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*); 31466f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*); 3147374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*); 31486f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*); 31496f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*); 3150fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*); 3151a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8); 31525c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 3153b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int); 3154ceea3321Sdrh void sqlite3ExprCacheStore(Parse*, int, int, int); 3155ceea3321Sdrh void sqlite3ExprCachePush(Parse*); 3156d2490904Sdrh void sqlite3ExprCachePop(Parse*); 3157f49f3523Sdrh void sqlite3ExprCacheRemove(Parse*, int, int); 3158ceea3321Sdrh void sqlite3ExprCacheClear(Parse*); 3159da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int); 316005a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int); 316105a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int); 3162d673cddaSdrh void sqlite3ExprCodeAtInit(Parse*, Expr*, int, u8); 31632dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 3164678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int); 316505a86c5cSdrh void sqlite3ExprCodeAndCache(Parse*, Expr*, int); 3166d1a01edaSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, u8); 3167d1a01edaSdrh #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */ 3168d1a01edaSdrh #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */ 31694adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 31704adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 31719bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*); 3172ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*); 317341fb5cd1Sdan Table *sqlite3LocateTableItem(Parse*,int isView,struct SrcList_item *); 31749bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 31759bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 31769bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 317774161705Sdrh void sqlite3Vacuum(Parse*); 31789bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*); 317917435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*); 3180619a1305Sdrh int sqlite3ExprCompare(Expr*, Expr*, int); 3181619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int); 31824bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr*, Expr*, int); 3183d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 3184d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 3185030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*); 31864adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*); 31872fa1868fSdrh void sqlite3PrngSaveState(void); 31882fa1868fSdrh void sqlite3PrngRestoreState(void); 31890f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int); 31904adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int); 319157966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb); 3192684917c2Sdrh void sqlite3BeginTransaction(Parse*, int); 31934adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*); 31944adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*); 3195fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*); 3196fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *); 31974245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*); 31984adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*); 31990a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*); 3200eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*); 32014adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*); 3202039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*); 3203039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 32044adee20fSdanielk1977 int sqlite3IsRowid(const char*); 3205392ee21dSdrh void sqlite3GenerateRowDelete(Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8); 320626198bb4Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*); 32071c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int); 320887744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int); 3209f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int, 3210f8ffb278Sdrh u8,u8,int,int*); 321126198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int); 32126a53499aSdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int, u8*, int*, int*); 32134adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int); 3214ff738bceSdrh void sqlite3MultiWrite(Parse*); 3215e0af83acSdan void sqlite3MayAbort(Parse*); 3216f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8); 3217f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*); 3218f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*); 32196ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 32206ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 32216ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 322217435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*); 32236ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int); 322470a8ca3cSdrh void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*); 322589d5d6a2Sdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,u8); 32269bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*); 3227777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void); 322870a8ca3cSdrh void sqlite3RegisterGlobalFunctions(void); 32297e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*); 32307e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*); 32319cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int); 3232fa4e62f3Sshane 3233fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 32342a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int); 3235fa4e62f3Sshane #endif 3236b7f9164eSdrh 3237b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER 3238ef2cb63eSdanielk1977 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 323960218d2aSdrh Expr*,int, int); 32404adee20fSdanielk1977 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 3241fdd48a76Sdrh void sqlite3DropTrigger(Parse*, SrcList*, int); 324274161705Sdrh void sqlite3DropTriggerPtr(Parse*, Trigger*); 32432f886d1dSdanielk1977 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 32442f886d1dSdanielk1977 Trigger *sqlite3TriggerList(Parse *, Table *); 3245165921a7Sdan void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 324694d7f50aSdan int, int, int); 32471da40a38Sdan void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 3248dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 3249633e6d57Sdrh void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 325017435752Sdrh TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*); 325117435752Sdrh TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*, 325275593d96Sdrh Select*,u8); 32535eff7cf0Sshane TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8); 325417435752Sdrh TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*); 3255633e6d57Sdrh void sqlite3DeleteTrigger(sqlite3*, Trigger*); 3256b7f9164eSdrh void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 3257bb5f168fSdan u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 325865a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 3259b7f9164eSdrh #else 326062c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0 3261633e6d57Sdrh # define sqlite3DeleteTrigger(A,B) 3262cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B) 3263b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 326494d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 326575cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 32662943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0 326765a7cd16Sdan # define sqlite3ParseToplevel(p) p 3268bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 3269b7f9164eSdrh #endif 3270b7f9164eSdrh 32714adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 32720202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 32734adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int); 3274ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 3275728b5779Sdrh void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 32764adee20fSdanielk1977 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 32774adee20fSdanielk1977 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 32784adee20fSdanielk1977 void sqlite3AuthContextPop(AuthContext*); 327902470b20Sdan int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 3280ed6c8671Sdrh #else 3281b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d) 32824adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 32834adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c) 32844adee20fSdanielk1977 # define sqlite3AuthContextPop(a) ((void)(a)) 3285ed6c8671Sdrh #endif 3286f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 3287f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*); 3288d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 32894adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*); 32904adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*); 32914adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*); 32924adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*); 32934adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 32949339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8); 3295fec19aadSdrh int sqlite3GetInt32(const char *, int*); 329660ac3f42Sdrh int sqlite3Atoi(const char*); 3297ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar); 3298ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte); 329942610961Sdrh u32 sqlite3Utf8Read(const u8**); 3300bf539c4dSdrh LogEst sqlite3LogEst(u64); 3301bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst); 3302bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 3303bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double); 3304bf539c4dSdrh #endif 3305bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst); 33063f8d5cfcSshane 33073f8d5cfcSshane /* 33083f8d5cfcSshane ** Routines to read and write variable-length integers. These used to 33093f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c 3310*2f2b2b85Sdrh ** file. 33113f8d5cfcSshane */ 3312192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64); 33131bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *); 33141bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *); 3315192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v); 33163f8d5cfcSshane 33173f8d5cfcSshane /* 3318*2f2b2b85Sdrh ** The common case is for a varint to be a single byte. They following 3319*2f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call 3320*2f2b2b85Sdrh ** the procedure for larger varints. 33213f8d5cfcSshane */ 33224bde3702Sdrh #define getVarint32(A,B) \ 33234bde3702Sdrh (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B))) 33244bde3702Sdrh #define putVarint32(A,B) \ 33254bde3702Sdrh (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\ 3326*2f2b2b85Sdrh sqlite3PutVarint((A),(B))) 33273f8d5cfcSshane #define getVarint sqlite3GetVarint 33283f8d5cfcSshane #define putVarint sqlite3PutVarint 33293f8d5cfcSshane 33303f8d5cfcSshane 333169f8bb9cSdan const char *sqlite3IndexAffinityStr(Vdbe *, Index *); 333257bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int); 3333e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2); 3334e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity); 3335bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr); 33369339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8); 33379296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*); 333813f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...); 333913f40da3Sdrh void sqlite3Error(sqlite3*,int); 3340ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 3341cd74b611Sdan u8 sqlite3HexToInt(int h); 3342ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 3343dd08ca0fSmistachkin 3344685e3c48Sdrh #if defined(SQLITE_TEST) 3345f2c1c99fSmistachkin const char *sqlite3ErrName(int); 3346dd08ca0fSmistachkin #endif 3347dd08ca0fSmistachkin 3348f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int); 33498a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse); 3350c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 3351c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 33527cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr); 33534ef7efadSdrh Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*); 33540a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*); 33550a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*); 33567cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *); 3357d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *); 3358b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int); 3359158b9cb9Sdrh int sqlite3AddInt64(i64*,i64); 3360158b9cb9Sdrh int sqlite3SubInt64(i64*,i64); 3361158b9cb9Sdrh int sqlite3MulInt64(i64*,i64); 3362d50ffc41Sdrh int sqlite3AbsInt32(int); 336381cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES 336481cc5163Sdrh void sqlite3FileSuffix3(const char*, char*); 336581cc5163Sdrh #else 336681cc5163Sdrh # define sqlite3FileSuffix3(X,Y) 336781cc5163Sdrh #endif 3368eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8); 33694e6af134Sdanielk1977 3370b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8); 3371b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8); 3372b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 33731e536953Sdanielk1977 void(*)(void*)); 3374a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*); 33754e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*); 33761e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *); 3377b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 33781e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 3379b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 338046c99e0fSdrh #ifndef SQLITE_AMALGAMATION 3381a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[]; 33824e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[]; 338378ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[]; 3384094430ebSdrh extern const Token sqlite3IntTokens[]; 3385075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 3386075c23afSdanielk1977 extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions; 3387f83dc1efSdrh #ifndef SQLITE_OMIT_WSD 3388ddb68e17Sdrh extern int sqlite3PendingByte; 338946c99e0fSdrh #endif 3390f83dc1efSdrh #endif 3391cdf011dcSdrh void sqlite3RootPageMoved(sqlite3*, int, int, int); 33924343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*); 3393545f587fSdrh void sqlite3AlterFunctions(void); 33949fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 33959fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *); 33962958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...); 3397d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*); 33981450bc6eSdrh int sqlite3CodeSubselect(Parse *, Expr *, int, int); 33997d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*); 34003e3f1a5bSdrh int sqlite3MatchSpanName(const char*, const char*, const char*, const char*); 34017d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*); 34027d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 34033780be11Sdrh void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*); 34047d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 3405c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 340619a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *); 340719a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 340879e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*); 3409fdaac671Sdrh char sqlite3AffinityType(const char*, u8*); 34109f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*); 3411a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*); 3412ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*); 34130410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *); 3414cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB); 3415d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*); 341651147baaSdrh void sqlite3DefaultRowEst(Index*); 341755ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int); 3418d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 3419fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int); 3420b6ee6607Sdrh void sqlite3SchemaClear(void *); 34211e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 3422e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 3423ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int); 34242ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*); 34252ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*); 34262ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*); 34272ec2fb22Sdrh #ifdef SQLITE_DEBUG 34282ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*); 34292ec2fb22Sdrh #endif 3430771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 3431771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), 3432d2199f0fSdan void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*), 3433d2199f0fSdan FuncDestructor *pDestructor 3434d2199f0fSdan ); 343554f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int); 3436ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *); 343769dab1d3Sdrh 3438f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int); 3439ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int); 3440a6353a3fSdrh void sqlite3StrAccumAppendAll(StrAccum*,const char*); 34417e02e5e6Sdrh void sqlite3AppendSpace(StrAccum*,int); 3442ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*); 3443ade86483Sdrh void sqlite3StrAccumReset(StrAccum*); 34441013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int); 3445f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 34461e536953Sdanielk1977 34470410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *); 34480410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 34490410302eSdanielk1977 34501435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4 34519fecc546Sdrh void sqlite3AnalyzeFunctions(void); 345287cd9321Sdan int sqlite3Stat4ProbeSetValue(Parse*,Index*,UnpackedRecord**,Expr*,u8,int,int*); 3453b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**); 34547a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*); 3455b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**); 34569fecc546Sdrh #endif 34577a419235Sdan 345895bdbbbdSdrh /* 345995bdbbbdSdrh ** The interface to the LEMON-generated parser 346095bdbbbdSdrh */ 346195bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t)); 346295bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*)); 346395bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*); 3464ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH 3465ec424a5bSdrh int sqlite3ParserStackPeak(void*); 3466ec424a5bSdrh #endif 346795bdbbbdSdrh 34687aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*); 346969dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION 3470f1952c5dSdrh void sqlite3CloseExtensions(sqlite3*); 347169dab1d3Sdrh #else 347269dab1d3Sdrh # define sqlite3CloseExtensions(X) 347369dab1d3Sdrh #endif 3474e3026636Sdanielk1977 3475c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 3476c00da105Sdanielk1977 void sqlite3TableLock(Parse *, int, int, u8, const char *); 3477c00da105Sdanielk1977 #else 3478c00da105Sdanielk1977 #define sqlite3TableLock(v,w,x,y,z) 3479c00da105Sdanielk1977 #endif 3480c00da105Sdanielk1977 348153c14021Sdrh #ifdef SQLITE_TEST 348253c14021Sdrh int sqlite3Utf8To8(unsigned char*); 348353c14021Sdrh #endif 348453c14021Sdrh 3485b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE 3486595a523aSdanielk1977 # define sqlite3VtabClear(Y) 34879dbee7dcSdanielk1977 # define sqlite3VtabSync(X,Y) SQLITE_OK 3488f9e7dda7Sdanielk1977 # define sqlite3VtabRollback(X) 3489f9e7dda7Sdanielk1977 # define sqlite3VtabCommit(X) 3490093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) 0 3491595a523aSdanielk1977 # define sqlite3VtabLock(X) 3492595a523aSdanielk1977 # define sqlite3VtabUnlock(X) 3493595a523aSdanielk1977 # define sqlite3VtabUnlockList(X) 3494a311b803Sdan # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK 3495c3c8dac7Sdrh # define sqlite3GetVTable(X,Y) ((VTable*)0) 3496b9bb7c18Sdrh #else 34971feeaed2Sdan void sqlite3VtabClear(sqlite3 *db, Table*); 3498bba02a95Sdan void sqlite3VtabDisconnect(sqlite3 *db, Table *p); 3499016f7811Sdan int sqlite3VtabSync(sqlite3 *db, Vdbe*); 3500f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db); 3501f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db); 3502595a523aSdanielk1977 void sqlite3VtabLock(VTable *); 3503595a523aSdanielk1977 void sqlite3VtabUnlock(VTable *); 3504595a523aSdanielk1977 void sqlite3VtabUnlockList(sqlite3*); 3505a311b803Sdan int sqlite3VtabSavepoint(sqlite3 *, int, int); 3506016f7811Sdan void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*); 3507c3c8dac7Sdrh VTable *sqlite3GetVTable(sqlite3*, Table*); 3508093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 3509b9bb7c18Sdrh #endif 35104f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*); 3511b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int); 3512b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*); 3513b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*); 3514b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*); 351578efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 35167e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*); 35179e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 3518595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *); 35191e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 3520b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**); 352195a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*); 35225f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 35234a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 3524f30a969bSdrh void sqlite3ParserReset(Parse*); 3525b900aaf3Sdrh int sqlite3Reprepare(Vdbe*); 3526b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 3527bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *); 35281c514148Sdrh int sqlite3TempInMemory(const sqlite3*); 352928e5386fSdan const char *sqlite3JournalModename(int); 353006a2d825Sdan #ifndef SQLITE_OMIT_WAL 3531cdc1f049Sdan int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 3532b033d8b9Sdrh int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 353306a2d825Sdan #endif 35348b471863Sdrh #ifndef SQLITE_OMIT_CTE 35354e9119d9Sdan With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*); 35367d562dbeSdan void sqlite3WithDelete(sqlite3*,With*); 3537b290f117Sdan void sqlite3WithPush(Parse*, With*, u8); 35384e9119d9Sdan #else 3539b290f117Sdan #define sqlite3WithPush(x,y,z) 3540eede6a53Sdan #define sqlite3WithDelete(x,y) 35418b471863Sdrh #endif 3542d829335eSdanielk1977 354375cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by 354475cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 354575cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but 354675cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 354775cbd984Sdan ** this case foreign keys are parsed, but no other functionality is 354875cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system). 354975cbd984Sdan */ 355075cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 35518ff2d956Sdan void sqlite3FkCheck(Parse*, Table*, int, int, int*, int); 3552d66c8309Sdan void sqlite3FkDropTable(Parse*, SrcList *, Table*); 35538ff2d956Sdan void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int); 3554e7a94d81Sdan int sqlite3FkRequired(Parse*, Table*, int*, int); 3555e7a94d81Sdan u32 sqlite3FkOldmask(Parse*, Table*); 3556432cc5b9Sdan FKey *sqlite3FkReferences(Table *); 35571da40a38Sdan #else 35588ff2d956Sdan #define sqlite3FkActions(a,b,c,d,e,f) 355967896cefSdan #define sqlite3FkCheck(a,b,c,d,e,f) 3560d66c8309Sdan #define sqlite3FkDropTable(a,b,c) 3561e7a94d81Sdan #define sqlite3FkOldmask(a,b) 0 356267896cefSdan #define sqlite3FkRequired(a,b,c,d) 0 35631da40a38Sdan #endif 356475cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY 35651feeaed2Sdan void sqlite3FkDelete(sqlite3 *, Table*); 35666c5b915fSdrh int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**); 356775cbd984Sdan #else 35681feeaed2Sdan #define sqlite3FkDelete(a,b) 35696c5b915fSdrh #define sqlite3FkLocateIndex(a,b,c,d,e) 357075cbd984Sdan #endif 357175cbd984Sdan 3572643167ffSdrh 3573643167ffSdrh /* 3574643167ffSdrh ** Available fault injectors. Should be numbered beginning with 0. 3575643167ffSdrh */ 3576643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC 0 35777e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT 1 3578643167ffSdrh 3579643167ffSdrh /* 3580ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign" 3581ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST 3582ef05f2dfSdanielk1977 ** is not defined. 3583643167ffSdrh */ 35843088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST 35852d1d86fbSdanielk1977 void sqlite3BeginBenignMalloc(void); 35862d1d86fbSdanielk1977 void sqlite3EndBenignMalloc(void); 3587643167ffSdrh #else 35882d1d86fbSdanielk1977 #define sqlite3BeginBenignMalloc() 3589867d05a0Sdanielk1977 #define sqlite3EndBenignMalloc() 3590643167ffSdrh #endif 3591643167ffSdrh 35923a85625dSdrh /* 35933a85625dSdrh ** Allowed return values from sqlite3FindInIndex() 35943a85625dSdrh */ 35953a85625dSdrh #define IN_INDEX_ROWID 1 /* Search the rowid of the table */ 35963a85625dSdrh #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */ 35973a85625dSdrh #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */ 35983a85625dSdrh #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */ 3599bb53ecb1Sdrh #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */ 36003a85625dSdrh /* 36013a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex(). 36023a85625dSdrh */ 3603bb53ecb1Sdrh #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */ 3604bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */ 3605bb53ecb1Sdrh #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */ 36063a85625dSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*); 36079a96b668Sdanielk1977 3608c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE 3609c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 3610c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *); 3611f55b8998Sdanielk1977 int sqlite3JournalCreate(sqlite3_file *); 36123de0f184Sdan int sqlite3JournalExists(sqlite3_file *p); 3613c7b6017cSdanielk1977 #else 3614c7b6017cSdanielk1977 #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile) 36153de0f184Sdan #define sqlite3JournalExists(p) 1 3616c7b6017cSdanielk1977 #endif 3617c7b6017cSdanielk1977 3618b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *); 36193a5990abSdrh int sqlite3MemJournalSize(void); 3620b3175389Sdanielk1977 int sqlite3IsMemJournal(sqlite3_file *); 3621b3175389Sdanielk1977 36220224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 36234b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p); 3624fc976065Sdanielk1977 int sqlite3SelectExprHeight(Select *); 36257d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse*, int); 3626fc976065Sdanielk1977 #else 36274b5255acSdanielk1977 #define sqlite3ExprSetHeight(x,y) 36280224d26dSdrh #define sqlite3SelectExprHeight(x) 0 36297d10d5a6Sdrh #define sqlite3ExprCheckHeight(x,y) 3630fc976065Sdanielk1977 #endif 3631fc976065Sdanielk1977 3632a3152895Sdrh u32 sqlite3Get4byte(const u8*); 3633a3152895Sdrh void sqlite3Put4byte(u8*, u32); 3634a3152895Sdrh 3635404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 3636404ca075Sdanielk1977 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 3637404ca075Sdanielk1977 void sqlite3ConnectionUnlocked(sqlite3 *db); 3638404ca075Sdanielk1977 void sqlite3ConnectionClosed(sqlite3 *db); 3639404ca075Sdanielk1977 #else 3640404ca075Sdanielk1977 #define sqlite3ConnectionBlocked(x,y) 3641404ca075Sdanielk1977 #define sqlite3ConnectionUnlocked(x) 3642404ca075Sdanielk1977 #define sqlite3ConnectionClosed(x) 3643404ca075Sdanielk1977 #endif 3644404ca075Sdanielk1977 36456e736838Sdrh #ifdef SQLITE_DEBUG 36466e736838Sdrh void sqlite3ParserTrace(FILE*, char *); 36476e736838Sdrh #endif 36486e736838Sdrh 3649b0603416Sdrh /* 3650b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable 36513a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to 3652b0603416Sdrh ** print I/O tracing messages. 3653b0603416Sdrh */ 3654b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE 36553a00f907Smlcreech # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 3656b4622b60Sdanielk1977 void sqlite3VdbeIOTraceSql(Vdbe*); 3657e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...); 3658b0603416Sdrh #else 3659b0603416Sdrh # define IOTRACE(A) 3660b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X) 3661b0603416Sdrh #endif 3662b0603416Sdrh 3663107b56e8Sdrh /* 3664107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator 3665107b56e8Sdrh ** only. They are used to verify that different "types" of memory 3666107b56e8Sdrh ** allocations are properly tracked by the system. 3667107b56e8Sdrh ** 3668107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 3669107b56e8Sdrh ** the MEMTYPE_* macros defined below. The type must be a bitmask with 3670107b56e8Sdrh ** a single bit set. 3671107b56e8Sdrh ** 3672107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second 3673107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 3674107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 3675107b56e8Sdrh ** 3676174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second 3677174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 3678107b56e8Sdrh ** 3679107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP 3680174b9a16Sdrh ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 3681174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was 3682174b9a16Sdrh ** too large or lookaside was already full. It is important to verify 3683174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not 3684174b9a16Sdrh ** passed back to non-lookaside free() routines. Asserts such as the 3685174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify 3686174b9a16Sdrh ** this constraint. 3687107b56e8Sdrh ** 3688107b56e8Sdrh ** All of this is no-op for a production build. It only comes into 3689107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used. 3690107b56e8Sdrh */ 3691107b56e8Sdrh #ifdef SQLITE_MEMDEBUG 3692107b56e8Sdrh void sqlite3MemdebugSetType(void*,u8); 3693107b56e8Sdrh int sqlite3MemdebugHasType(void*,u8); 3694174b9a16Sdrh int sqlite3MemdebugNoType(void*,u8); 3695107b56e8Sdrh #else 3696107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y) /* no-op */ 3697107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y) 1 3698174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y) 1 3699e3026636Sdanielk1977 #endif 3700107b56e8Sdrh #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 3701174b9a16Sdrh #define MEMTYPE_LOOKASIDE 0x02 /* Might have been lookaside memory */ 3702107b56e8Sdrh #define MEMTYPE_SCRATCH 0x04 /* Scratch allocations */ 3703107b56e8Sdrh #define MEMTYPE_PCACHE 0x08 /* Page cache allocations */ 3704174b9a16Sdrh #define MEMTYPE_DB 0x10 /* Uses sqlite3DbMalloc, not sqlite_malloc */ 3705107b56e8Sdrh 3706107b56e8Sdrh #endif /* _SQLITEINT_H_ */ 3707