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 */ 1543f58d6aSdrh #ifndef SQLITEINT_H 1643f58d6aSdrh #define SQLITEINT_H 1771674ce9Sdrh 18396794f0Sdrh /* Special Comments: 19396794f0Sdrh ** 20396794f0Sdrh ** Some comments have special meaning to the tools that measure test 21396794f0Sdrh ** coverage: 22396794f0Sdrh ** 23396794f0Sdrh ** NO_TEST - The branches on this line are not 24396794f0Sdrh ** measured by branch coverage. This is 25396794f0Sdrh ** used on lines of code that actually 26396794f0Sdrh ** implement parts of coverage testing. 27396794f0Sdrh ** 28396794f0Sdrh ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false 29396794f0Sdrh ** and the correct answer is still obtained, 30396794f0Sdrh ** though perhaps more slowly. 31396794f0Sdrh ** 32396794f0Sdrh ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true 33396794f0Sdrh ** and the correct answer is still obtained, 34396794f0Sdrh ** though perhaps more slowly. 35396794f0Sdrh ** 36396794f0Sdrh ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread 37396794f0Sdrh ** that would be harmless and undetectable 38396794f0Sdrh ** if it did occur. 39396794f0Sdrh ** 40396794f0Sdrh ** In all cases, the special comment must be enclosed in the usual 41396794f0Sdrh ** slash-asterisk...asterisk-slash comment marks, with no spaces between the 42396794f0Sdrh ** asterisks and the comment text. 43396794f0Sdrh */ 44396794f0Sdrh 45bd0ae111Smlcreech /* 467617e4a8Smistachkin ** Make sure the Tcl calling convention macro is defined. This macro is 477617e4a8Smistachkin ** only used by test code and Tcl integration code. 487617e4a8Smistachkin */ 497617e4a8Smistachkin #ifndef SQLITE_TCLAPI 507617e4a8Smistachkin # define SQLITE_TCLAPI 517617e4a8Smistachkin #endif 5271674ce9Sdrh 53bd0ae111Smlcreech /* 542318d338Smistachkin ** Include the header file used to customize the compiler options for MSVC. 552318d338Smistachkin ** This should be done first so that it can successfully prevent spurious 562318d338Smistachkin ** compiler warnings due to subsequent content in this file and other files 572318d338Smistachkin ** that are included by this file. 582318d338Smistachkin */ 592318d338Smistachkin #include "msvc.h" 602318d338Smistachkin 612318d338Smistachkin /* 628cd5b254Sdrh ** Special setup for VxWorks 638cd5b254Sdrh */ 648cd5b254Sdrh #include "vxworks.h" 658cd5b254Sdrh 668cd5b254Sdrh /* 672210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the 682210dcc6Sdrh ** underlying operating system supports it. If the OS lacks 692210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops. 702210dcc6Sdrh ** 712210dcc6Sdrh ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 722210dcc6Sdrh ** system #includes. Hence, this block of code must be the very first 732210dcc6Sdrh ** code in all source files. 742210dcc6Sdrh ** 752210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 762210dcc6Sdrh ** on the compiler command line. This is necessary if you are compiling 772210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work 782210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2 792210dcc6Sdrh ** without this option, LFS is enable. But LFS does not exist in the kernel 802210dcc6Sdrh ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary 812210dcc6Sdrh ** portability you should omit LFS. 822210dcc6Sdrh ** 83dddf6978Sdrh ** The previous paragraph was written in 2005. (This paragraph is written 84dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so 85dddf6978Sdrh ** you should probably leave LFS enabled. But some embedded platforms might 86dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful. 87dddf6978Sdrh ** 882210dcc6Sdrh ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later. 892210dcc6Sdrh */ 902210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS 912210dcc6Sdrh # define _LARGE_FILE 1 922210dcc6Sdrh # ifndef _FILE_OFFSET_BITS 932210dcc6Sdrh # define _FILE_OFFSET_BITS 64 942210dcc6Sdrh # endif 952210dcc6Sdrh # define _LARGEFILE_SOURCE 1 962210dcc6Sdrh #endif 972210dcc6Sdrh 98dc5ece86Sdrh /* The GCC_VERSION and MSVC_VERSION macros are used to 99a39284bfSdrh ** conditionally include optimizations for each of these compilers. A 100a39284bfSdrh ** value of 0 means that compiler is not being used. The 101a39284bfSdrh ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific 102a39284bfSdrh ** optimizations, and hence set all compiler macros to 0 103dc5ece86Sdrh ** 104dc5ece86Sdrh ** There was once also a CLANG_VERSION macro. However, we learn that the 105dc5ece86Sdrh ** version numbers in clang are for "marketing" only and are inconsistent 106dc5ece86Sdrh ** and unreliable. Fortunately, all versions of clang also recognize the 107dc5ece86Sdrh ** gcc version numbers and have reasonable settings for gcc version numbers, 108dc5ece86Sdrh ** so the GCC_VERSION macro will be set to a correct non-zero value even 109dc5ece86Sdrh ** when compiling with clang. 110a39284bfSdrh */ 111a39284bfSdrh #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC) 112ad265296Sdrh # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__) 113ad265296Sdrh #else 114ad265296Sdrh # define GCC_VERSION 0 115ad265296Sdrh #endif 116a39284bfSdrh #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC) 117a39284bfSdrh # define MSVC_VERSION _MSC_VER 118a39284bfSdrh #else 119a39284bfSdrh # define MSVC_VERSION 0 120a39284bfSdrh #endif 121ad265296Sdrh 122d97a4c00Smistachkin /* 123d97a4c00Smistachkin ** Some C99 functions in "math.h" are only present for MSVC when its version 124d97a4c00Smistachkin ** is associated with Visual Studio 2013 or higher. 125d97a4c00Smistachkin */ 126d97a4c00Smistachkin #ifndef SQLITE_HAVE_C99_MATH_FUNCS 127d97a4c00Smistachkin # if MSVC_VERSION==0 || MSVC_VERSION>=1800 128d97a4c00Smistachkin # define SQLITE_HAVE_C99_MATH_FUNCS (1) 129d97a4c00Smistachkin # else 130d97a4c00Smistachkin # define SQLITE_HAVE_C99_MATH_FUNCS (0) 131d97a4c00Smistachkin # endif 132d97a4c00Smistachkin #endif 133d97a4c00Smistachkin 13433ac4c8bSmistachkin /* Needed for various definitions... */ 13533ac4c8bSmistachkin #if defined(__GNUC__) && !defined(_GNU_SOURCE) 13633ac4c8bSmistachkin # define _GNU_SOURCE 13733ac4c8bSmistachkin #endif 13833ac4c8bSmistachkin 13933ac4c8bSmistachkin #if defined(__OpenBSD__) && !defined(_BSD_SOURCE) 14033ac4c8bSmistachkin # define _BSD_SOURCE 14133ac4c8bSmistachkin #endif 14233ac4c8bSmistachkin 1432210dcc6Sdrh /* 14408b92086Sdrh ** Macro to disable warnings about missing "break" at the end of a "case". 14508b92086Sdrh */ 14608b92086Sdrh #if GCC_VERSION>=7000000 14708b92086Sdrh # define deliberate_fall_through __attribute__((fallthrough)); 14808b92086Sdrh #else 14908b92086Sdrh # define deliberate_fall_through 15008b92086Sdrh #endif 15108b92086Sdrh 15208b92086Sdrh /* 153a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its 154a7b3b635Smistachkin ** version information, among other things. Normally, this internal MinGW 155a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header 156a7b3b635Smistachkin ** files; however, the contained version information is now required by this 157a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and 158a7b3b635Smistachkin ** this is the only known way to reliably obtain it. This entire #if block 159a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting 160a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define 161a7b3b635Smistachkin ** some MinGW-specific macros). When compiling for MinGW, either the 162a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be 163a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be 164a7b3b635Smistachkin ** disabled. 165a7b3b635Smistachkin */ 166a7b3b635Smistachkin #if defined(_HAVE_MINGW_H) 167a7b3b635Smistachkin # include "mingw.h" 168a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H) 169a7b3b635Smistachkin # include "_mingw.h" 170a7b3b635Smistachkin #endif 171a7b3b635Smistachkin 172a7b3b635Smistachkin /* 173a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T 174a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime 175a7b3b635Smistachkin ** library in use (e.g. for Windows XP). 176a7b3b635Smistachkin */ 177a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \ 178a7b3b635Smistachkin defined(_WIN32) && !defined(_WIN64) && \ 17965acf373Smistachkin defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \ 180a7b3b635Smistachkin defined(__MSVCRT__) 181a7b3b635Smistachkin # define _USE_32BIT_TIME_T 182a7b3b635Smistachkin #endif 183a7b3b635Smistachkin 1845e990beaSdrh /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear 1850d71d121Smistachkin ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for 1860d71d121Smistachkin ** MinGW. 1875e990beaSdrh */ 1885e990beaSdrh #include "sqlite3.h" 1895e990beaSdrh 190bd0ae111Smlcreech /* 1911e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the 1921e12d43bSmlcreech ** autoconf-based build 193bd0ae111Smlcreech */ 1947f2d1cd2Sdrh #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H) 19598dc4b1aSmlcreech #include "config.h" 1967f2d1cd2Sdrh #define SQLITECONFIG_H 1 1971e12d43bSmlcreech #endif 1981e12d43bSmlcreech 199bb4957f8Sdrh #include "sqliteLimit.h" 20098dc4b1aSmlcreech 201e2965827Sdrh /* Disable nuisance warnings on Borland compilers */ 202e2965827Sdrh #if defined(__BORLANDC__) 203e2965827Sdrh #pragma warn -rch /* unreachable code */ 204e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */ 205e2965827Sdrh #pragma warn -aus /* Assigned value is never used */ 206e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */ 207467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */ 208e2965827Sdrh #endif 209e2965827Sdrh 21098dc4b1aSmlcreech /* 211892edb69Sdan ** WAL mode depends on atomic aligned 32-bit loads and stores in a few 212892edb69Sdan ** places. The following macros try to make this explicit. 213892edb69Sdan */ 214b5538941Sdan #ifndef __has_extension 215b5538941Sdan # define __has_extension(x) 0 /* compatibility with non-clang compilers */ 216892edb69Sdan #endif 2174ee492f1Sdrh #if GCC_VERSION>=4007000 || \ 2184ee492f1Sdrh (__has_extension(c_atomic) && __has_extension(c_atomic_store_n)) 219892edb69Sdan # define AtomicLoad(PTR) __atomic_load_n((PTR),__ATOMIC_RELAXED) 220892edb69Sdan # define AtomicStore(PTR,VAL) __atomic_store_n((PTR),(VAL),__ATOMIC_RELAXED) 221892edb69Sdan #else 222892edb69Sdan # define AtomicLoad(PTR) (*(PTR)) 223892edb69Sdan # define AtomicStore(PTR,VAL) (*(PTR) = (VAL)) 224892edb69Sdan #endif 225892edb69Sdan 226892edb69Sdan /* 22706af763eSdrh ** Include standard header files as necessary 22806af763eSdrh */ 22906af763eSdrh #ifdef HAVE_STDINT_H 23006af763eSdrh #include <stdint.h> 23106af763eSdrh #endif 23206af763eSdrh #ifdef HAVE_INTTYPES_H 23306af763eSdrh #include <inttypes.h> 23406af763eSdrh #endif 23506af763eSdrh 236a2460e07Sdrh /* 237c05a9a8aSdrh ** The following macros are used to cast pointers to integers and 238c05a9a8aSdrh ** integers to pointers. The way you do this varies from one compiler 239c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements 240c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers. 241875e9e7dSdrh ** 242c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type. 243c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or 244c05a9a8aSdrh ** if it is available, it requires an #include of specific headers 245c92271c5Sdrh ** that vary from one machine to the next. 246875e9e7dSdrh ** 247875e9e7dSdrh ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 248875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 2495e49edcaSdrh ** So we have to define the macros in different ways depending on the 250875e9e7dSdrh ** compiler. 2511fc4129dSshane */ 2524509ffa3Sdrh #if defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 2534509ffa3Sdrh # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 2544509ffa3Sdrh # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 2554509ffa3Sdrh #elif defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 256c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 257c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 258c05a9a8aSdrh #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 259c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 260c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 261c05a9a8aSdrh #else /* Generates a warning - but it always works */ 262875e9e7dSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 263875e9e7dSdrh # define SQLITE_PTR_TO_INT(X) ((int)(X)) 264367882c2Sdrh #endif 26571674ce9Sdrh 266e5e7a901Sdrh /* 26714a924a5Sdrh ** A macro to hint to the compiler that a function should not be 26814a924a5Sdrh ** inlined. 26914a924a5Sdrh */ 27014a924a5Sdrh #if defined(__GNUC__) 27114a924a5Sdrh # define SQLITE_NOINLINE __attribute__((noinline)) 272ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310 27314a924a5Sdrh # define SQLITE_NOINLINE __declspec(noinline) 27414a924a5Sdrh #else 27514a924a5Sdrh # define SQLITE_NOINLINE 27614a924a5Sdrh #endif 27714a924a5Sdrh 27814a924a5Sdrh /* 279647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when 28060e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by 28160e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define. 282647ca46fSmistachkin */ 28360e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC) 28411f69b87Smistachkin # if defined(_MSC_VER) && _MSC_VER>=1400 2859895f735Smistachkin # if !defined(_WIN32_WCE) 286647ca46fSmistachkin # include <intrin.h> 287647ca46fSmistachkin # pragma intrinsic(_byteswap_ushort) 288647ca46fSmistachkin # pragma intrinsic(_byteswap_ulong) 289a39284bfSdrh # pragma intrinsic(_byteswap_uint64) 2908d9837acSmistachkin # pragma intrinsic(_ReadWriteBarrier) 2919895f735Smistachkin # else 2929895f735Smistachkin # include <cmnintrin.h> 2939895f735Smistachkin # endif 294647ca46fSmistachkin # endif 29560e08078Smistachkin #endif 296647ca46fSmistachkin 297647ca46fSmistachkin /* 29838c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 29938c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never 30038c67c36Sdrh ** threadsafe. 1 means the library is serialized which is the highest 301f7b5496eSdrh ** level of threadsafety. 2 means the library is multithreaded - multiple 30238c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same 30338c67c36Sdrh ** database connection at the same time. 30438c67c36Sdrh ** 305e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro. 30638c67c36Sdrh ** We support that for legacy. 307814aad61Sdan ** 308814aad61Sdan ** To ensure that the correct value of "THREADSAFE" is reported when querying 309814aad61Sdan ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this 310814aad61Sdan ** logic is partially replicated in ctime.c. If it is updated here, it should 311814aad61Sdan ** also be updated there. 312e5e7a901Sdrh */ 313e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE) 314e5e7a901Sdrh # if defined(THREADSAFE) 315e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE 316e5e7a901Sdrh # else 31738c67c36Sdrh # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 318e5e7a901Sdrh # endif 319e5e7a901Sdrh #endif 320e5e7a901Sdrh 32167080617Sdrh /* 322cb15f35fSdrh ** Powersafe overwrite is on by default. But can be turned off using 323cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option. 324cb15f35fSdrh */ 325cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE 326cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1 327cb15f35fSdrh #endif 328cb15f35fSdrh 329cb15f35fSdrh /* 330d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by 331d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in 332d1dcb234Sdrh ** which case memory allocation statistics are disabled by default. 3330a732f59Sdanielk1977 */ 3340a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 3350a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1 3360a732f59Sdanielk1977 #endif 3370a732f59Sdanielk1977 3380a732f59Sdanielk1977 /* 3390d18020bSdrh ** Exactly one of the following macros must be defined in order to 3400d18020bSdrh ** specify which memory allocation subsystem to use. 3410d18020bSdrh ** 3420d18020bSdrh ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 3431b186a99Smistachkin ** SQLITE_WIN32_MALLOC // Use Win32 native heap API 344d1b0afc3Sdrh ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails 3450d18020bSdrh ** SQLITE_MEMDEBUG // Debugging version of system malloc() 346a2460e07Sdrh ** 347753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the 348753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem 349753c5444Smistachkin ** will cause HeapValidate to be called. If heap validation should fail, an 350753c5444Smistachkin ** assertion will be triggered. 351753c5444Smistachkin ** 3520d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 3530d18020bSdrh ** the default. 3540d18020bSdrh */ 355d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 356d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 357d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 358d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)>1 359d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\ 36020b1ff07Smistachkin are defined but at most one is allowed:\ 361d1b0afc3Sdrh SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\ 362d1b0afc3Sdrh SQLITE_ZERO_MALLOC" 3630d18020bSdrh #endif 364d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 365d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 366d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 367d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)==0 3680d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1 3690d18020bSdrh #endif 3700d18020bSdrh 3710d18020bSdrh /* 3728a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 373eee4c8caSdrh ** sizes of memory allocations below this value where possible. 374eee4c8caSdrh */ 3758a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 376eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024 377eee4c8caSdrh #endif 378eee4c8caSdrh 379eee4c8caSdrh /* 38067080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable 38140b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD. 38240b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit 38340b521f8Sdrh ** it. 38467080617Sdrh */ 38540b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) 38640b521f8Sdrh # define _XOPEN_SOURCE 600 38767080617Sdrh #endif 388e3026636Sdanielk1977 3897d10d5a6Sdrh /* 3901b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that 3911b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true, 3921b28b893Sdrh ** make it true by defining or undefining NDEBUG. 3931b28b893Sdrh ** 394443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the 395443dbcf5Sdrh ** assert() statements in the code. So we want the default action 3961b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG 3971b28b893Sdrh ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out 3984b529d97Sdrh ** feature. 3994b529d97Sdrh */ 400289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 4014b529d97Sdrh # define NDEBUG 1 4024b529d97Sdrh #endif 4031b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG) 4041b28b893Sdrh # undef NDEBUG 4051b28b893Sdrh #endif 4064b529d97Sdrh 4076402250eSdrh /* 408c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on. 409c7379ce4Sdrh */ 410c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG) 411c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1 412c7379ce4Sdrh #endif 413c7379ce4Sdrh 414c7379ce4Sdrh /* 41547c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing. When 41647c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to 41747c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to 41847c3b3e0Sdrh ** get full branch coverage. The testcase() macro is inserted 41947c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple 42047c3b3e0Sdrh ** condition/decision coverage is inadequate. For example, testcase() 42147c3b3e0Sdrh ** can be used to make sure boundary values are tested. For 42247c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit 42347c3b3e0Sdrh ** is significant and used at least once. On switch statements 42447c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase() 42547c3b3e0Sdrh ** can insure that all cases are evaluated. 42647c3b3e0Sdrh ** 42747c3b3e0Sdrh */ 42847c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST 42947c3b3e0Sdrh void sqlite3Coverage(int); 43047c3b3e0Sdrh # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 43147c3b3e0Sdrh #else 43247c3b3e0Sdrh # define testcase(X) 4338f941bc7Sdrh #endif 4348f941bc7Sdrh 4358f941bc7Sdrh /* 4368f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or 4378f941bc7Sdrh ** other bits of code that are needed to support the arguments 4388f941bc7Sdrh ** within testcase() and assert() macros. 4398f941bc7Sdrh */ 4408f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 4418f941bc7Sdrh # define TESTONLY(X) X 4428f941bc7Sdrh #else 44347c3b3e0Sdrh # define TESTONLY(X) 44447c3b3e0Sdrh #endif 44547c3b3e0Sdrh 44647c3b3e0Sdrh /* 4476149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization 4486149526cSdrh ** to setup for a later assert() statement. We do not want this code to 4496149526cSdrh ** appear when assert() is disabled. The following macro is therefore 4506149526cSdrh ** used to contain that setup code. The "VVA" acronym stands for 4516149526cSdrh ** "Verification, Validation, and Accreditation". In other words, the 4526149526cSdrh ** code within VVA_ONLY() will only run during verification processes. 4536149526cSdrh */ 4546149526cSdrh #ifndef NDEBUG 4556149526cSdrh # define VVA_ONLY(X) X 4566149526cSdrh #else 4576149526cSdrh # define VVA_ONLY(X) 4586149526cSdrh #endif 4596149526cSdrh 4606149526cSdrh /* 46147c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which 46247c3b3e0Sdrh ** are intended to always be true or false, respectively. Such 46347c3b3e0Sdrh ** expressions could be omitted from the code completely. But they 46447c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience 46547c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing" 46647c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first 46747c3b3e0Sdrh ** hint of unplanned behavior. 46847c3b3e0Sdrh ** 46947c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code. 47047c3b3e0Sdrh ** 47147c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to 472443dbcf5Sdrh ** be true and false so that the unreachable code they specify will 47347c3b3e0Sdrh ** not be counted as untested code. 47447c3b3e0Sdrh */ 4755f65ff27Sdrh #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST) 47647c3b3e0Sdrh # define ALWAYS(X) (1) 47747c3b3e0Sdrh # define NEVER(X) (0) 47847c3b3e0Sdrh #elif !defined(NDEBUG) 4792de80f4cSdrh # define ALWAYS(X) ((X)?1:(assert(0),0)) 4802de80f4cSdrh # define NEVER(X) ((X)?(assert(0),1):0) 48147c3b3e0Sdrh #else 48247c3b3e0Sdrh # define ALWAYS(X) (X) 48347c3b3e0Sdrh # define NEVER(X) (X) 48447c3b3e0Sdrh #endif 48547c3b3e0Sdrh 48647c3b3e0Sdrh /* 487a2d50283Sdrh ** The harmless(X) macro indicates that expression X is usually false 488a2d50283Sdrh ** but can be true without causing any problems, but we don't know of 489a2d50283Sdrh ** any way to cause X to be true. 490a2d50283Sdrh ** 491a2d50283Sdrh ** In debugging and testing builds, this macro will abort if X is ever 492a2d50283Sdrh ** true. In this way, developers are alerted to a possible test case 493a2d50283Sdrh ** that causes X to be true. If a harmless macro ever fails, that is 494a2d50283Sdrh ** an opportunity to change the macro into a testcase() and add a new 495a2d50283Sdrh ** test case to the test suite. 496a2d50283Sdrh ** 497a2d50283Sdrh ** For normal production builds, harmless(X) is a no-op, since it does 498a2d50283Sdrh ** not matter whether expression X is true or false. 499a2d50283Sdrh */ 500a2d50283Sdrh #ifdef SQLITE_DEBUG 501a2d50283Sdrh # define harmless(X) assert(!(X)); 502a2d50283Sdrh #else 503a2d50283Sdrh # define harmless(X) 504a2d50283Sdrh #endif 505a2d50283Sdrh 506a2d50283Sdrh /* 5072f65b2f5Sdrh ** Some conditionals are optimizations only. In other words, if the 5082f65b2f5Sdrh ** conditionals are replaced with a constant 1 (true) or 0 (false) then 5092f65b2f5Sdrh ** the correct answer is still obtained, though perhaps not as quickly. 5102f65b2f5Sdrh ** 5112f65b2f5Sdrh ** The following macros mark these optimizations conditionals. 5122f65b2f5Sdrh */ 5132f65b2f5Sdrh #if defined(SQLITE_MUTATION_TEST) 5142f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (1) 5152f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (0) 5162f65b2f5Sdrh #else 5172f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (X) 5182f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (X) 5192f65b2f5Sdrh #endif 5202f65b2f5Sdrh 5212f65b2f5Sdrh /* 522dad300d8Sdrh ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is 523dad300d8Sdrh ** defined. We need to defend against those failures when testing with 524dad300d8Sdrh ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches 525dad300d8Sdrh ** during a normal build. The following macro can be used to disable tests 526dad300d8Sdrh ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set. 527dad300d8Sdrh */ 528dad300d8Sdrh #if defined(SQLITE_TEST_REALLOC_STRESS) 529dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (X) 530dad300d8Sdrh #elif !defined(NDEBUG) 531dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0) 532dad300d8Sdrh #else 533dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (0) 534dad300d8Sdrh #endif 535dad300d8Sdrh 536dad300d8Sdrh /* 5370cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces. 5380cbcffa7Smistachkin */ 539b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \ 540b10f22a1Smistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5410cbcffa7Smistachkin extern int sqlite3OSTrace; 5420cbcffa7Smistachkin # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X 5430cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE 5440cbcffa7Smistachkin #else 5450cbcffa7Smistachkin # define OSTRACE(X) 5460cbcffa7Smistachkin # undef SQLITE_HAVE_OS_TRACE 5470cbcffa7Smistachkin #endif 5480cbcffa7Smistachkin 5490cbcffa7Smistachkin /* 5505824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build? Currently, 5515824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when 5525824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are 5535824d44bSmistachkin ** compiled using SQLITE_TEST). 5545824d44bSmistachkin */ 5555824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \ 5565824d44bSmistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5575824d44bSmistachkin # define SQLITE_NEED_ERR_NAME 5585824d44bSmistachkin #else 5595824d44bSmistachkin # undef SQLITE_NEED_ERR_NAME 5605824d44bSmistachkin #endif 5615824d44bSmistachkin 5625824d44bSmistachkin /* 5637c621fb9Sdrh ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN 5647c621fb9Sdrh */ 5657c621fb9Sdrh #ifdef SQLITE_OMIT_EXPLAIN 5667c621fb9Sdrh # undef SQLITE_ENABLE_EXPLAIN_COMMENTS 5677c621fb9Sdrh #endif 5687c621fb9Sdrh 5697c621fb9Sdrh /* 57060ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large 5713e8e7ecbSdrh ** to fit in 32-bits. This macro is used inside of various testcase() 5723e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support. 5733e8e7ecbSdrh */ 574b31a6afaSdan #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 5753e8e7ecbSdrh 5763e8e7ecbSdrh /* 57747c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean 57847c3b3e0Sdrh ** expression that is usually false. Macro likely() surrounds 579443dbcf5Sdrh ** a boolean expression that is usually true. These hints could, 580443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but 581443dbcf5Sdrh ** currently they are just comments for human readers. 58247c3b3e0Sdrh */ 583443dbcf5Sdrh #define likely(X) (X) 584443dbcf5Sdrh #define unlikely(X) (X) 58547c3b3e0Sdrh 586beae3194Sdrh #include "hash.h" 58775897234Sdrh #include "parse.h" 58875897234Sdrh #include <stdio.h> 58975897234Sdrh #include <stdlib.h> 59075897234Sdrh #include <string.h> 59175897234Sdrh #include <assert.h> 59252370e2cSdrh #include <stddef.h> 59375897234Sdrh 594967e8b73Sdrh /* 5958674e492Sdrh ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY. 5968674e492Sdrh ** This allows better measurements of where memcpy() is used when running 5978674e492Sdrh ** cachegrind. But this macro version of memcpy() is very slow so it 5988674e492Sdrh ** should not be used in production. This is a performance measurement 5998674e492Sdrh ** hack only. 6008674e492Sdrh */ 6018674e492Sdrh #ifdef SQLITE_INLINE_MEMCPY 6028674e492Sdrh # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\ 6038674e492Sdrh int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);} 6048674e492Sdrh #endif 6058674e492Sdrh 6068674e492Sdrh /* 607b37df7b9Sdrh ** If compiling for a processor that lacks floating point support, 608b37df7b9Sdrh ** substitute integer for floating-point 609b37df7b9Sdrh */ 610b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT 611b37df7b9Sdrh # define double sqlite_int64 6128b307fbfSdrh # define float sqlite_int64 613b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64 614d1167393Sdrh # ifndef SQLITE_BIG_DBL 615cdaca55eSdrh # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 616d1167393Sdrh # endif 617b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1 618b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1 619110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 6200b3bf924Sdrh # undef SQLITE_HAVE_ISNAN 621b37df7b9Sdrh #endif 622d1167393Sdrh #ifndef SQLITE_BIG_DBL 623d1167393Sdrh # define SQLITE_BIG_DBL (1e99) 624d1167393Sdrh #endif 625b37df7b9Sdrh 626b37df7b9Sdrh /* 62753c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 62853c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler 62953c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements. 63053c0f748Sdanielk1977 */ 63153c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB 63253c0f748Sdanielk1977 #define OMIT_TEMPDB 1 63353c0f748Sdanielk1977 #else 63453c0f748Sdanielk1977 #define OMIT_TEMPDB 0 63553c0f748Sdanielk1977 #endif 63653c0f748Sdanielk1977 63753c0f748Sdanielk1977 /* 638d946db00Sdrh ** The "file format" number is an integer that is incremented whenever 639d946db00Sdrh ** the VDBE-level file format changes. The following macros define the 640d946db00Sdrh ** the default file format for new databases and the maximum file format 641d946db00Sdrh ** that the library can read. 642d946db00Sdrh */ 643d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4 644d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT 645bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4 646d946db00Sdrh #endif 647d946db00Sdrh 648a2460e07Sdrh /* 649a2460e07Sdrh ** Determine whether triggers are recursive by default. This can be 650a2460e07Sdrh ** changed at run-time using a pragma. 651a2460e07Sdrh */ 6525bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 6535bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 6545bde73c4Sdan #endif 6555bde73c4Sdan 656d946db00Sdrh /* 657b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 65849766d6cSdrh ** on the command-line 65949766d6cSdrh */ 660b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE 661b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1 66249766d6cSdrh #endif 66349766d6cSdrh 66449766d6cSdrh /* 665b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if 666b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it 667b3f56fdbSdan ** to zero. 668b3f56fdbSdan */ 6696b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0 670b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS 671028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0 672b3f56fdbSdan #endif 673b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS 6746b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8 675b3f56fdbSdan #endif 676a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS 677a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0 678a09c8855Sdrh #endif 679a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS 680a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS 681a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS 682a09c8855Sdrh #endif 683b3f56fdbSdan 6844297c7c4Sdrh /* 6854297c7c4Sdrh ** The default initial allocation for the pagecache when using separate 6864297c7c4Sdrh ** pagecaches for each database connection. A positive number is the 6874297c7c4Sdrh ** number of pages. A negative number N translations means that a buffer 6884297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold. 68983a4f47dSdrh ** 69083a4f47dSdrh ** The default value of "20" was choosen to minimize the run-time of the 69183a4f47dSdrh ** speedtest1 test program with options: --shrink-memory --reprepare 6924297c7c4Sdrh */ 6934297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ 69483a4f47dSdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 20 6954297c7c4Sdrh #endif 6964297c7c4Sdrh 697d83f7ca1Sdan /* 6982e3a5a81Sdan ** Default value for the SQLITE_CONFIG_SORTERREF_SIZE option. 6992e3a5a81Sdan */ 7002e3a5a81Sdan #ifndef SQLITE_DEFAULT_SORTERREF_SIZE 7012e3a5a81Sdan # define SQLITE_DEFAULT_SORTERREF_SIZE 0x7fffffff 7022e3a5a81Sdan #endif 7032e3a5a81Sdan 7042e3a5a81Sdan /* 7052df9478fSdrh ** The compile-time options SQLITE_MMAP_READWRITE and 7062df9478fSdrh ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another. 7072df9478fSdrh ** You must choose one or the other (or neither) but not both. 7082df9478fSdrh */ 7092df9478fSdrh #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 7102df9478fSdrh #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE 7112df9478fSdrh #endif 7122df9478fSdrh 7132df9478fSdrh /* 714f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it 715f1974846Sdrh ** ourselves. 716f1974846Sdrh */ 717f1974846Sdrh #ifndef offsetof 718f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 719f1974846Sdrh #endif 720f1974846Sdrh 721f1974846Sdrh /* 722e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers. 723e1e2e9acSdrh */ 72413969f5aSdrh #ifndef MIN 725e1e2e9acSdrh # define MIN(A,B) ((A)<(B)?(A):(B)) 72613969f5aSdrh #endif 72713969f5aSdrh #ifndef MAX 728e1e2e9acSdrh # define MAX(A,B) ((A)>(B)?(A):(B)) 72913969f5aSdrh #endif 730e1e2e9acSdrh 731e1e2e9acSdrh /* 7324fa4a54fSdrh ** Swap two objects of type TYPE. 7334fa4a54fSdrh */ 7344fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;} 7354fa4a54fSdrh 7364fa4a54fSdrh /* 7379b8f447bSdrh ** Check to see if this machine uses EBCDIC. (Yes, believe it or 7389b8f447bSdrh ** not, there are still machines out there that use EBCDIC.) 7399b8f447bSdrh */ 7409b8f447bSdrh #if 'A' == '\301' 7419b8f447bSdrh # define SQLITE_EBCDIC 1 7429b8f447bSdrh #else 7439b8f447bSdrh # define SQLITE_ASCII 1 7449b8f447bSdrh #endif 7459b8f447bSdrh 7469b8f447bSdrh /* 7475a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 7485a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 7495a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 7505a2c2c20Sdrh ** 7515a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 75241a2b48bSdrh */ 7535a2c2c20Sdrh #ifndef UINT32_TYPE 754dda5b68cSmlcreech # ifdef HAVE_UINT32_T 755dda5b68cSmlcreech # define UINT32_TYPE uint32_t 756dda5b68cSmlcreech # else 7575a2c2c20Sdrh # define UINT32_TYPE unsigned int 7585a2c2c20Sdrh # endif 759dda5b68cSmlcreech #endif 7605a2c2c20Sdrh #ifndef UINT16_TYPE 761dda5b68cSmlcreech # ifdef HAVE_UINT16_T 762dda5b68cSmlcreech # define UINT16_TYPE uint16_t 763dda5b68cSmlcreech # else 7645a2c2c20Sdrh # define UINT16_TYPE unsigned short int 7655a2c2c20Sdrh # endif 766dda5b68cSmlcreech #endif 767939a16d6Sdrh #ifndef INT16_TYPE 768dda5b68cSmlcreech # ifdef HAVE_INT16_T 769dda5b68cSmlcreech # define INT16_TYPE int16_t 770dda5b68cSmlcreech # else 771939a16d6Sdrh # define INT16_TYPE short int 772939a16d6Sdrh # endif 773dda5b68cSmlcreech #endif 7745a2c2c20Sdrh #ifndef UINT8_TYPE 775dda5b68cSmlcreech # ifdef HAVE_UINT8_T 776dda5b68cSmlcreech # define UINT8_TYPE uint8_t 777dda5b68cSmlcreech # else 7785a2c2c20Sdrh # define UINT8_TYPE unsigned char 7795a2c2c20Sdrh # endif 780dda5b68cSmlcreech #endif 781905793e2Sdrh #ifndef INT8_TYPE 782dda5b68cSmlcreech # ifdef HAVE_INT8_T 783dda5b68cSmlcreech # define INT8_TYPE int8_t 784dda5b68cSmlcreech # else 785905793e2Sdrh # define INT8_TYPE signed char 786905793e2Sdrh # endif 787dda5b68cSmlcreech #endif 788efad9995Sdrh #ifndef LONGDOUBLE_TYPE 789efad9995Sdrh # define LONGDOUBLE_TYPE long double 790efad9995Sdrh #endif 791efad9995Sdrh typedef sqlite_int64 i64; /* 8-byte signed integer */ 79227436af7Sdrh typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 7935a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 7945a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 795939a16d6Sdrh typedef INT16_TYPE i16; /* 2-byte signed integer */ 7965a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 79770a8ca3cSdrh typedef INT8_TYPE i8; /* 1-byte signed integer */ 7985a2c2c20Sdrh 7995a2c2c20Sdrh /* 80035cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 80135cd643cSdrh ** that can be stored in a u32 without loss of data. The value 80235cd643cSdrh ** is 0x00000000ffffffff. But because of quirks of some compilers, we 80335cd643cSdrh ** have to specify the value in the less intuitive manner shown: 80435cd643cSdrh */ 80535cd643cSdrh #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 80635cd643cSdrh 80735cd643cSdrh /* 808faacf17cSdrh ** The datatype used to store estimates of the number of rows in a 809faacf17cSdrh ** table or index. This is an unsigned integer type. For 99.9% of 810faacf17cSdrh ** the world, a 32-bit integer is sufficient. But a 64-bit integer 811faacf17cSdrh ** can be used at compile-time if desired. 812faacf17cSdrh */ 813faacf17cSdrh #ifdef SQLITE_64BIT_STATS 814faacf17cSdrh typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */ 815faacf17cSdrh #else 816faacf17cSdrh typedef u32 tRowcnt; /* 32-bit is the default */ 817faacf17cSdrh #endif 818faacf17cSdrh 819faacf17cSdrh /* 820bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit 821bf539c4dSdrh ** logarithms. For quantity X, the value stored is 10*log2(X). This 822bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986. 823bf539c4dSdrh ** But the allowed values are "grainy". Not every value is representable. 824bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst 82597d38983Sdrh ** of 40. However, since LogEst quantities are suppose to be estimates, 826bf539c4dSdrh ** not exact values, this imprecision is not a problem. 827bf539c4dSdrh ** 828224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate". 829bf539c4dSdrh ** 830bf539c4dSdrh ** Examples: 831bf539c4dSdrh ** 1 -> 0 20 -> 43 10000 -> 132 832bf539c4dSdrh ** 2 -> 10 25 -> 46 25000 -> 146 833bf539c4dSdrh ** 3 -> 16 100 -> 66 1000000 -> 199 834bf539c4dSdrh ** 4 -> 20 1000 -> 99 1048576 -> 200 835bf539c4dSdrh ** 10 -> 33 1024 -> 100 4294967296 -> 320 836bf539c4dSdrh ** 837bf539c4dSdrh ** The LogEst can be negative to indicate fractional values. 838bf539c4dSdrh ** Examples: 839bf539c4dSdrh ** 840bf539c4dSdrh ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40 841bf539c4dSdrh */ 842bf539c4dSdrh typedef INT16_TYPE LogEst; 843bf539c4dSdrh 844bf539c4dSdrh /* 8452b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer 8462b4905c8Sdrh */ 8472b4905c8Sdrh #ifndef SQLITE_PTRSIZE 8482b4905c8Sdrh # if defined(__SIZEOF_POINTER__) 8492b4905c8Sdrh # define SQLITE_PTRSIZE __SIZEOF_POINTER__ 8502b4905c8Sdrh # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 85188edc6c7Smistachkin defined(_M_ARM) || defined(__arm__) || defined(__x86) || \ 85288edc6c7Smistachkin (defined(__TOS_AIX__) && !defined(__64BIT__)) 8532b4905c8Sdrh # define SQLITE_PTRSIZE 4 8542b4905c8Sdrh # else 8552b4905c8Sdrh # define SQLITE_PTRSIZE 8 8562b4905c8Sdrh # endif 8572b4905c8Sdrh #endif 8582b4905c8Sdrh 8593bfa7e82Sdrh /* The uptr type is an unsigned integer large enough to hold a pointer 8603bfa7e82Sdrh */ 8613bfa7e82Sdrh #if defined(HAVE_STDINT_H) 8623bfa7e82Sdrh typedef uintptr_t uptr; 8633bfa7e82Sdrh #elif SQLITE_PTRSIZE==4 8643bfa7e82Sdrh typedef u32 uptr; 8653bfa7e82Sdrh #else 8663bfa7e82Sdrh typedef u64 uptr; 8673bfa7e82Sdrh #endif 8683bfa7e82Sdrh 8693bfa7e82Sdrh /* 8703bfa7e82Sdrh ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to 8713bfa7e82Sdrh ** something between S (inclusive) and E (exclusive). 8723bfa7e82Sdrh ** 8733bfa7e82Sdrh ** In other words, S is a buffer and E is a pointer to the first byte after 8743bfa7e82Sdrh ** the end of buffer S. This macro returns true if P points to something 8753bfa7e82Sdrh ** contained within the buffer S. 8763bfa7e82Sdrh */ 8773bfa7e82Sdrh #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E))) 8783bfa7e82Sdrh 8793bfa7e82Sdrh 8802b4905c8Sdrh /* 881bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian, 88271794dbaSdrh ** and whether or not that determination is run-time or compile-time. 88371794dbaSdrh ** 88471794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order 88571794dbaSdrh ** using C-preprocessor macros. If that is unsuccessful, or if 886a39284bfSdrh ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined 88771794dbaSdrh ** at run-time. 888bbd42a6dSdrh */ 889a39284bfSdrh #ifndef SQLITE_BYTEORDER 890a39284bfSdrh # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 89171794dbaSdrh defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \ 89271794dbaSdrh defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \ 893acd6bb5fSdrh defined(__ARMEL__) || defined(__AARCH64EL__) || defined(_M_ARM64) 8942cf4acbdSdrh # define SQLITE_BYTEORDER 1234 895acd6bb5fSdrh # elif defined(sparc) || defined(__ppc__) || \ 896acd6bb5fSdrh defined(__ARMEB__) || defined(__AARCH64EB__) 89771794dbaSdrh # define SQLITE_BYTEORDER 4321 898a39284bfSdrh # else 899a39284bfSdrh # define SQLITE_BYTEORDER 0 900a39284bfSdrh # endif 901a39284bfSdrh #endif 902a39284bfSdrh #if SQLITE_BYTEORDER==4321 90371794dbaSdrh # define SQLITE_BIGENDIAN 1 90471794dbaSdrh # define SQLITE_LITTLEENDIAN 0 90571794dbaSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16BE 906a39284bfSdrh #elif SQLITE_BYTEORDER==1234 907a39284bfSdrh # define SQLITE_BIGENDIAN 0 908a39284bfSdrh # define SQLITE_LITTLEENDIAN 1 909a39284bfSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 910a39284bfSdrh #else 911e1462a76Sdrh # ifdef SQLITE_AMALGAMATION 912e1462a76Sdrh const int sqlite3one = 1; 913e1462a76Sdrh # else 914e1462a76Sdrh extern const int sqlite3one; 915e1462a76Sdrh # endif 9169c054830Sdrh # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 9179c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 91838def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 91938def054Sdrh #endif 920bbd42a6dSdrh 921bbd42a6dSdrh /* 9220f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers. 9230f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit 9240f050353Sdrh ** compilers. 9250f050353Sdrh */ 9260f050353Sdrh #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 927d1d89140Sdrh #define LARGEST_UINT64 (0xffffffff|(((u64)0xffffffff)<<32)) 9280f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 9290f050353Sdrh 9300f050353Sdrh /* 931be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8. This is used 932be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures. 933be229650Sdanielk1977 */ 934bc73971dSdanielk1977 #define ROUND8(x) (((x)+7)&~7) 935bc73971dSdanielk1977 936bc73971dSdanielk1977 /* 937bc73971dSdanielk1977 ** Round down to the nearest multiple of 8 938bc73971dSdanielk1977 */ 939bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7) 940be229650Sdanielk1977 941be229650Sdanielk1977 /* 9428e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary. This 9438e14c596Sdrh ** macro is used only within assert() to verify that the code gets 9448e14c596Sdrh ** all alignment restrictions correct. 9458e14c596Sdrh ** 9468e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 94760ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned 9488e14c596Sdrh ** pointers. In that case, only verify 4-byte alignment. 949ea598cbdSdrh */ 9508e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 9518e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 9528e14c596Sdrh #else 953ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 9548e14c596Sdrh #endif 955ea598cbdSdrh 956188d4884Sdrh /* 9579b4c59faSdrh ** Disable MMAP on platforms where it is known to not work 958188d4884Sdrh */ 959188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__) 9609b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE 9619b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 962188d4884Sdrh #endif 963188d4884Sdrh 9649b4c59faSdrh /* 9659b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS 9669b4c59faSdrh */ 9679b4c59faSdrh #ifdef __APPLE__ 9689b4c59faSdrh # include <TargetConditionals.h> 9699b4c59faSdrh #endif 9709b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE 9719b4c59faSdrh # if defined(__linux__) \ 9729b4c59faSdrh || defined(_WIN32) \ 9739b4c59faSdrh || (defined(__APPLE__) && defined(__MACH__)) \ 9743e9dd938Sdrh || defined(__sun) \ 9753e9dd938Sdrh || defined(__FreeBSD__) \ 9763e9dd938Sdrh || defined(__DragonFly__) 9772bba8c24Sdrh # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */ 9789b4c59faSdrh # else 9799b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 9809b4c59faSdrh # endif 9819b4c59faSdrh #endif 9829b4c59faSdrh 9839b4c59faSdrh /* 9849b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger 9859b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does 9869b4c59faSdrh ** not exceed the maximum mmap size. 9879b4c59faSdrh */ 9889b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE 9899b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0 9909b4c59faSdrh #endif 9919b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE 9929b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE 9939b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE 9949b4c59faSdrh #endif 995e7b34707Sdrh 996ea598cbdSdrh /* 997abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not 998abd4c723Sdrh ** the Select query generator tracing logic is turned on. 999abd4c723Sdrh */ 1000c0622a4dSdrh #if !defined(SQLITE_AMALGAMATION) 1001c0622a4dSdrh extern u32 sqlite3SelectTrace; 1002abd4c723Sdrh #endif 1003c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1004c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_SELECTTRACE)) 10059216de8aSdrh # define SELECTTRACE_ENABLED 1 10069216de8aSdrh # define SELECTTRACE(K,P,S,X) \ 1007c0622a4dSdrh if(sqlite3SelectTrace&(K)) \ 10089216de8aSdrh sqlite3DebugPrintf("%u/%d/%p: ",(S)->selId,(P)->addrExplain,(S)),\ 10099216de8aSdrh sqlite3DebugPrintf X 10109216de8aSdrh #else 10119216de8aSdrh # define SELECTTRACE(K,P,S,X) 10129216de8aSdrh # define SELECTTRACE_ENABLED 0 10139216de8aSdrh #endif 1014abd4c723Sdrh 1015abd4c723Sdrh /* 1016c0622a4dSdrh ** Macros for "wheretrace" 1017c0622a4dSdrh */ 10188e2b9c2aSdrh extern u32 sqlite3WhereTrace; 1019c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1020c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE)) 1021c0622a4dSdrh # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X 1022c0622a4dSdrh # define WHERETRACE_ENABLED 1 1023c0622a4dSdrh #else 1024c0622a4dSdrh # define WHERETRACE(K,X) 1025c0622a4dSdrh #endif 1026c0622a4dSdrh 1027c0622a4dSdrh 1028c0622a4dSdrh /* 102990f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler 103090f5ecb3Sdrh ** callback for a given sqlite handle. 103190f5ecb3Sdrh ** 103290f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy 103390f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite 103490f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 103590f5ecb3Sdrh ** callback is currently invoked only from within pager.c. 103690f5ecb3Sdrh */ 103790f5ecb3Sdrh typedef struct BusyHandler BusyHandler; 103890f5ecb3Sdrh struct BusyHandler { 103980262896Sdrh int (*xBusyHandler)(void *,int); /* The busy callback */ 104080262896Sdrh void *pBusyArg; /* First arg to busy callback */ 1041a4afb65cSdrh int nBusy; /* Incremented with each busy call */ 104290f5ecb3Sdrh }; 104390f5ecb3Sdrh 104490f5ecb3Sdrh /* 1045ccb2113aSdrh ** Name of table that holds the database schema. 104675897234Sdrh */ 1047346a70caSdrh #define DFLT_SCHEMA_TABLE "sqlite_master" 1048346a70caSdrh #define DFLT_TEMP_SCHEMA_TABLE "sqlite_temp_master" 1049346a70caSdrh #define ALT_SCHEMA_TABLE "sqlite_schema" 1050346a70caSdrh #define ALT_TEMP_SCHEMA_TABLE "sqlite_temp_schema" 1051346a70caSdrh 105275897234Sdrh 105375897234Sdrh /* 1054346a70caSdrh ** The root-page of the schema table. 10558e150818Sdanielk1977 */ 1056346a70caSdrh #define SCHEMA_ROOT 1 10578e150818Sdanielk1977 10588e150818Sdanielk1977 /* 1059346a70caSdrh ** The name of the schema table. The name is different for TEMP. 1060ed6c8671Sdrh */ 1061346a70caSdrh #define SCHEMA_TABLE(x) \ 1062346a70caSdrh ((!OMIT_TEMPDB)&&(x==1)?DFLT_TEMP_SCHEMA_TABLE:DFLT_SCHEMA_TABLE) 1063ed6c8671Sdrh 1064ed6c8671Sdrh /* 106575897234Sdrh ** A convenience macro that returns the number of elements in 106675897234Sdrh ** an array. 106775897234Sdrh */ 106823432976Sdanielk1977 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 106975897234Sdrh 107075897234Sdrh /* 10717a5bcc0fSdrh ** Determine if the argument is a power of two 10727a5bcc0fSdrh */ 10737a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0) 10747a5bcc0fSdrh 10757a5bcc0fSdrh /* 1076633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree(). 1077aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the 1078aa538a58Sdrh ** one parameter that destructors normally want. So we have to introduce 1079aa538a58Sdrh ** this magic value that the code knows to handle differently. Any 1080aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC 1081aa538a58Sdrh ** and SQLITE_TRANSIENT. 1082633e6d57Sdrh */ 108308b92086Sdrh #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3OomFault) 1084633e6d57Sdrh 108578f82d1eSdrh /* 108678f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 108778f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables. 108878f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from 108978f82d1eSdrh ** the heap. When WSD is unsupported, the variable declarations scattered 109078f82d1eSdrh ** throughout the SQLite code must become constants instead. The SQLITE_WSD 109178f82d1eSdrh ** macro is used for this purpose. And instead of referencing the variable 109278f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated 109378f82d1eSdrh ** buffer that holds real variable. The constant is also the initializer 109478f82d1eSdrh ** for the run-time allocated buffer. 109578f82d1eSdrh ** 10962479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 109778f82d1eSdrh ** macros become no-ops and have zero performance impact. 109878f82d1eSdrh */ 1099075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD 1100075c23afSdanielk1977 #define SQLITE_WSD const 1101075c23afSdanielk1977 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 1102075c23afSdanielk1977 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 1103d1d38488Sdrh int sqlite3_wsd_init(int N, int J); 1104d1d38488Sdrh void *sqlite3_wsd_find(void *K, int L); 1105075c23afSdanielk1977 #else 1106075c23afSdanielk1977 #define SQLITE_WSD 1107075c23afSdanielk1977 #define GLOBAL(t,v) v 1108075c23afSdanielk1977 #define sqlite3GlobalConfig sqlite3Config 1109075c23afSdanielk1977 #endif 1110075c23afSdanielk1977 1111f3d3c27aSdanielk1977 /* 1112f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to 1113f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately 1114f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when 1115f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the 1116f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the 1117f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate, 1118f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere. 1119f3d3c27aSdanielk1977 ** 1120f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function, 1121f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 1122f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to 1123f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options. 1124f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these 1125f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions. 1126f3d3c27aSdanielk1977 */ 112762c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x) 1128f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 112962c14b34Sdanielk1977 1130633e6d57Sdrh /* 113175897234Sdrh ** Forward references to structures 113275897234Sdrh */ 113313449892Sdrh typedef struct AggInfo AggInfo; 1134fe05af87Sdrh typedef struct AuthContext AuthContext; 11350b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo; 1136f5e7bb51Sdrh typedef struct Bitvec Bitvec; 1137fe05af87Sdrh typedef struct CollSeq CollSeq; 11387020f651Sdrh typedef struct Column Column; 1139f824b41eSdrh typedef struct Cte Cte; 1140*a79e2a2dSdrh typedef struct CteUse CteUse; 1141fe05af87Sdrh typedef struct Db Db; 1142f380c3f1Sdan typedef struct DbFixer DbFixer; 1143e501b89aSdanielk1977 typedef struct Schema Schema; 114475897234Sdrh typedef struct Expr Expr; 114575897234Sdrh typedef struct ExprList ExprList; 1146c2eef3b3Sdrh typedef struct FKey FKey; 1147d2199f0fSdan typedef struct FuncDestructor FuncDestructor; 1148fe05af87Sdrh typedef struct FuncDef FuncDef; 114970a8ca3cSdrh typedef struct FuncDefHash FuncDefHash; 1150fe05af87Sdrh typedef struct IdList IdList; 1151fe05af87Sdrh typedef struct Index Index; 115202fa4696Sdan typedef struct IndexSample IndexSample; 11538d059845Sdanielk1977 typedef struct KeyClass KeyClass; 1154d3d39e93Sdrh typedef struct KeyInfo KeyInfo; 1155633e6d57Sdrh typedef struct Lookaside Lookaside; 1156633e6d57Sdrh typedef struct LookasideSlot LookasideSlot; 1157d1ab1ba5Sdanielk1977 typedef struct Module Module; 1158626a879aSdrh typedef struct NameContext NameContext; 1159fe05af87Sdrh typedef struct Parse Parse; 1160cf3c078fSdrh typedef struct ParseCleanup ParseCleanup; 116146c47d46Sdan typedef struct PreUpdate PreUpdate; 1162a5c1416dSdrh typedef struct PrintfArguments PrintfArguments; 1163cf8f2895Sdan typedef struct RenameToken RenameToken; 1164b8352479Sdrh typedef struct Returning Returning; 1165a2460e07Sdrh typedef struct RowSet RowSet; 1166fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint; 1167fe05af87Sdrh typedef struct Select Select; 1168f51446a3Sdrh typedef struct SQLiteThread SQLiteThread; 1169634d81deSdrh typedef struct SelectDest SelectDest; 11707601294aSdrh typedef struct SrcItem SrcItem; 1171fe05af87Sdrh typedef struct SrcList SrcList; 11720cdbe1aeSdrh typedef struct sqlite3_str StrAccum; /* Internal alias for sqlite3_str */ 1173fe05af87Sdrh typedef struct Table Table; 1174c00da105Sdanielk1977 typedef struct TableLock TableLock; 1175fe05af87Sdrh typedef struct Token Token; 11764fa4a54fSdrh typedef struct TreeView TreeView; 1177a2460e07Sdrh typedef struct Trigger Trigger; 11782832ad42Sdan typedef struct TriggerPrg TriggerPrg; 1179fe05af87Sdrh typedef struct TriggerStep TriggerStep; 1180e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord; 118146d2e5c3Sdrh typedef struct Upsert Upsert; 1182595a523aSdanielk1977 typedef struct VTable VTable; 1183b061d058Sdan typedef struct VtabCtx VtabCtx; 11847d10d5a6Sdrh typedef struct Walker Walker; 1185fe05af87Sdrh typedef struct WhereInfo WhereInfo; 118686fb6e17Sdan typedef struct Window Window; 11877d562dbeSdan typedef struct With With; 1188d3d39e93Sdrh 11891fe3ac73Sdrh 11901fe3ac73Sdrh /* 11911fe3ac73Sdrh ** The bitmask datatype defined below is used for various optimizations. 11921fe3ac73Sdrh ** 11931fe3ac73Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of 11941fe3ac73Sdrh ** tables in a join to 32 instead of 64. But it also reduces the size 11951fe3ac73Sdrh ** of the library by 738 bytes on ix86. 11961fe3ac73Sdrh */ 11971fe3ac73Sdrh #ifdef SQLITE_BITMASK_TYPE 11981fe3ac73Sdrh typedef SQLITE_BITMASK_TYPE Bitmask; 11991fe3ac73Sdrh #else 12001fe3ac73Sdrh typedef u64 Bitmask; 12011fe3ac73Sdrh #endif 12021fe3ac73Sdrh 12031fe3ac73Sdrh /* 12041fe3ac73Sdrh ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 12051fe3ac73Sdrh */ 12061fe3ac73Sdrh #define BMS ((int)(sizeof(Bitmask)*8)) 12071fe3ac73Sdrh 12081fe3ac73Sdrh /* 12091fe3ac73Sdrh ** A bit in a Bitmask 12101fe3ac73Sdrh */ 12111fe3ac73Sdrh #define MASKBIT(n) (((Bitmask)1)<<(n)) 1212b945bcdaSdrh #define MASKBIT64(n) (((u64)1)<<(n)) 12131fe3ac73Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n)) 12141fe3ac73Sdrh #define ALLBITS ((Bitmask)-1) 12151fe3ac73Sdrh 12169bf755ccSdrh /* A VList object records a mapping between parameters/variables/wildcards 12179bf755ccSdrh ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer 12189bf755ccSdrh ** variable number associated with that parameter. See the format description 12199bf755ccSdrh ** on the sqlite3VListAdd() routine for more information. A VList is really 12209bf755ccSdrh ** just an array of integers. 12219bf755ccSdrh */ 12229bf755ccSdrh typedef int VList; 12239bf755ccSdrh 12242dca4ac1Sdanielk1977 /* 12252dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 12262dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 12272dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above. 12282dca4ac1Sdanielk1977 */ 1229e9261dbdSdrh #include "pager.h" 12302dca4ac1Sdanielk1977 #include "btree.h" 12312dca4ac1Sdanielk1977 #include "vdbe.h" 12328c0a791aSdanielk1977 #include "pcache.h" 12331cc5ed81Sdanielk1977 #include "os.h" 1234c7ce76afSdrh #include "mutex.h" 12351cc5ed81Sdanielk1977 123633b104afSdrh /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default 123733b104afSdrh ** synchronous setting to EXTRA. It is no longer supported. 123833b104afSdrh */ 123933b104afSdrh #ifdef SQLITE_EXTRA_DURABLE 124033b104afSdrh # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE 124133b104afSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 3 124233b104afSdrh #endif 124333b104afSdrh 124450a1a5aaSdrh /* 1245c2ae2073Sdrh ** Default synchronous levels. 1246c2ae2073Sdrh ** 1247c2ae2073Sdrh ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ 1248c2ae2073Sdrh ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1. 1249c2ae2073Sdrh ** 1250c2ae2073Sdrh ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS 1251c2ae2073Sdrh ** OFF 1 0 1252c2ae2073Sdrh ** NORMAL 2 1 1253c2ae2073Sdrh ** FULL 3 2 1254c2ae2073Sdrh ** EXTRA 4 3 1255c2ae2073Sdrh ** 1256c2ae2073Sdrh ** The "PRAGMA synchronous" statement also uses the zero-based numbers. 1257c2ae2073Sdrh ** In other words, the zero-based numbers are used for all external interfaces 1258c2ae2073Sdrh ** and the one-based values are used internally. 125950a1a5aaSdrh */ 126050a1a5aaSdrh #ifndef SQLITE_DEFAULT_SYNCHRONOUS 12613e7d012eSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 2 126250a1a5aaSdrh #endif 126350a1a5aaSdrh #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS 126450a1a5aaSdrh # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS 126550a1a5aaSdrh #endif 1266eee4c8caSdrh 1267001bbcbbSdrh /* 1268001bbcbbSdrh ** Each database file to be accessed by the system is an instance 1269001bbcbbSdrh ** of the following structure. There are normally two of these structures 1270001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 1271a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 1272a69d9168Sdrh ** databases may be attached. 1273001bbcbbSdrh */ 1274001bbcbbSdrh struct Db { 127569c33826Sdrh char *zDbSName; /* Name of this database. (schema name, not filename) */ 1276001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 1277467bcf36Sshane u8 safety_level; /* How aggressive at syncing data to disk */ 127850a1a5aaSdrh u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */ 1279e501b89aSdanielk1977 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 1280da184236Sdanielk1977 }; 1281da184236Sdanielk1977 1282da184236Sdanielk1977 /* 1283da184236Sdanielk1977 ** An instance of the following structure stores a database schema. 12842120608eSdrh ** 12852120608eSdrh ** Most Schema objects are associated with a Btree. The exception is 12862120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 12872120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple 12882120608eSdrh ** Btrees that refer to the same underlying BtShared object. 12892120608eSdrh ** 12902120608eSdrh ** Schema objects are automatically deallocated when the last Btree that 12912120608eSdrh ** references them is destroyed. The TEMP Schema is manually freed by 12922120608eSdrh ** sqlite3_close(). 12932120608eSdrh * 12942120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order 12952120608eSdrh ** to access Schema content. This implies that the thread must also be 12962120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 129755a0959aSdrh ** For a TEMP Schema, only the connection mutex is required. 1298da184236Sdanielk1977 */ 1299e501b89aSdanielk1977 struct Schema { 1300001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 1301c2a75551Sdrh int iGeneration; /* Generation counter. Incremented with each change */ 1302d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 1303d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 1304d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 13051da40a38Sdan Hash fkeyHash; /* All foreign keys by referenced table name */ 13064794f735Sdrh Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 1307da184236Sdanielk1977 u8 file_format; /* Schema format version for this file */ 13088079a0d3Sdrh u8 enc; /* Text encoding used by this database */ 13092c5e35ffSdrh u16 schemaFlags; /* Flags associated with this schema */ 131014db2665Sdanielk1977 int cache_size; /* Number of pages to use in the cache */ 1311001bbcbbSdrh }; 131275897234Sdrh 131375897234Sdrh /* 13148bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 1315a2460e07Sdrh ** Db.pSchema->flags field. 13168bf8dc92Sdrh */ 13172c5e35ffSdrh #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P)) 13182c5e35ffSdrh #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0) 13192c5e35ffSdrh #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P) 13202c5e35ffSdrh #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P) 13218bf8dc92Sdrh 13228bf8dc92Sdrh /* 1323a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field. 13248bf8dc92Sdrh ** 13258bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 13268bf8dc92Sdrh ** read into internal hash tables. 13278bf8dc92Sdrh ** 13288bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 13298bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 13308bf8dc92Sdrh ** changes and so the view will need to be reset. 13318bf8dc92Sdrh */ 1332124b27e6Sdrh #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 1333124b27e6Sdrh #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 1334dc6b41edSdrh #define DB_ResetWanted 0x0008 /* Reset the schema when nSchemaLock==0 */ 13358bf8dc92Sdrh 1336caa639f4Sdrh /* 1337caa639f4Sdrh ** The number of different kinds of things that can be limited 1338caa639f4Sdrh ** using the sqlite3_limit() interface. 1339caa639f4Sdrh */ 1340111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1) 13418bf8dc92Sdrh 13428bf8dc92Sdrh /* 1343633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used 1344467bcf36Sshane ** to satisfy small transient memory allocation requests for objects 1345633e6d57Sdrh ** associated with a particular database connection. The use of 1346633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement 1347633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing 1348633e6d57Sdrh ** SQL statements. 1349633e6d57Sdrh ** 1350633e6d57Sdrh ** The Lookaside structure holds configuration information about the 1351633e6d57Sdrh ** lookaside malloc subsystem. Each available memory allocation in 1352633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot 1353633e6d57Sdrh ** objects. 1354d9da78a2Sdrh ** 1355d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated 1356d9da78a2Sdrh ** with a particular database connection. Hence, schema information cannot 1357d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information 1358d9da78a2Sdrh ** is shared by multiple database connections. Therefore, while parsing 1359d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that 1360d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects. 136131f69626Sdrh ** 136231f69626Sdrh ** New lookaside allocations are only allowed if bDisable==0. When 136331f69626Sdrh ** bDisable is greater than zero, sz is set to zero which effectively 136431f69626Sdrh ** disables lookaside without adding a new test for the bDisable flag 136531f69626Sdrh ** in a performance-critical path. sz should be set by to szTrue whenever 136631f69626Sdrh ** bDisable changes back to zero. 1367e6068027Sdrh ** 1368e6068027Sdrh ** Lookaside buffers are initially held on the pInit list. As they are 1369e6068027Sdrh ** used and freed, they are added back to the pFree list. New allocations 1370e6068027Sdrh ** come off of pFree first, then pInit as a fallback. This dual-list 1371e6068027Sdrh ** allows use to compute a high-water mark - the maximum number of allocations 1372e6068027Sdrh ** outstanding at any point in the past - by subtracting the number of 1373e6068027Sdrh ** allocations on the pInit list from the total number of allocations. 1374e6068027Sdrh ** 1375cf014f6cSdrh ** Enhancement on 2019-12-12: Two-size-lookaside 1376e6068027Sdrh ** The default lookaside configuration is 100 slots of 1200 bytes each. 1377e6068027Sdrh ** The larger slot sizes are important for performance, but they waste 1378e6068027Sdrh ** a lot of space, as most lookaside allocations are less than 128 bytes. 1379cf014f6cSdrh ** The two-size-lookaside enhancement breaks up the lookaside allocation 1380cf014f6cSdrh ** into two pools: One of 128-byte slots and the other of the default size 1381cf014f6cSdrh ** (1200-byte) slots. Allocations are filled from the small-pool first, 1382e6068027Sdrh ** failing over to the full-size pool if that does not work. Thus more 1383e6068027Sdrh ** lookaside slots are available while also using less memory. 1384e6068027Sdrh ** This enhancement can be omitted by compiling with 1385cf014f6cSdrh ** SQLITE_OMIT_TWOSIZE_LOOKASIDE. 1386633e6d57Sdrh */ 1387633e6d57Sdrh struct Lookaside { 13884a642b60Sdrh u32 bDisable; /* Only operate the lookaside when zero */ 1389633e6d57Sdrh u16 sz; /* Size of each buffer in bytes */ 139031f69626Sdrh u16 szTrue; /* True value of sz, even if disabled */ 1391e9d1c720Sdrh u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 139252fb8e19Sdrh u32 nSlot; /* Number of lookaside slots allocated */ 139352fb8e19Sdrh u32 anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 139452fb8e19Sdrh LookasideSlot *pInit; /* List of buffers not previously used */ 13957d10d5a6Sdrh LookasideSlot *pFree; /* List of available buffers */ 1396cf014f6cSdrh #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1397cf014f6cSdrh LookasideSlot *pSmallInit; /* List of small buffers not prediously used */ 1398cf014f6cSdrh LookasideSlot *pSmallFree; /* List of available small buffers */ 1399e6068027Sdrh void *pMiddle; /* First byte past end of full-size buffers and 1400cf014f6cSdrh ** the first byte of LOOKASIDE_SMALL buffers */ 1401cf014f6cSdrh #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */ 1402633e6d57Sdrh void *pStart; /* First byte of available memory space */ 1403633e6d57Sdrh void *pEnd; /* First byte past end of available space */ 1404633e6d57Sdrh }; 1405633e6d57Sdrh struct LookasideSlot { 1406633e6d57Sdrh LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 1407633e6d57Sdrh }; 1408633e6d57Sdrh 140931f69626Sdrh #define DisableLookaside db->lookaside.bDisable++;db->lookaside.sz=0 141031f69626Sdrh #define EnableLookaside db->lookaside.bDisable--;\ 141131f69626Sdrh db->lookaside.sz=db->lookaside.bDisable?0:db->lookaside.szTrue 141231f69626Sdrh 1413cf014f6cSdrh /* Size of the smaller allocations in two-size lookside */ 1414cf014f6cSdrh #ifdef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1415cf014f6cSdrh # define LOOKASIDE_SMALL 0 1416e6068027Sdrh #else 1417cf014f6cSdrh # define LOOKASIDE_SMALL 128 1418e6068027Sdrh #endif 14190225d819Sdrh 1420633e6d57Sdrh /* 142180738d9cSdrh ** A hash table for built-in function definitions. (Application-defined 142280738d9cSdrh ** functions use a regular table table from hash.h.) 142370a8ca3cSdrh ** 142470a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 1425a60c6301Sdrh ** Collisions are on the FuncDef.u.pHash chain. Use the SQLITE_FUNC_HASH() 1426a60c6301Sdrh ** macro to compute a hash on the function name. 142770a8ca3cSdrh */ 142880738d9cSdrh #define SQLITE_FUNC_HASH_SZ 23 142970a8ca3cSdrh struct FuncDefHash { 143080738d9cSdrh FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */ 143170a8ca3cSdrh }; 14328bee11a4Smistachkin #define SQLITE_FUNC_HASH(C,L) (((C)+(L))%SQLITE_FUNC_HASH_SZ) 143370a8ca3cSdrh 1434d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1435d4530979Sdrh /* 1436d4530979Sdrh ** Information held in the "sqlite3" database connection object and used 1437d4530979Sdrh ** to manage user authentication. 1438d4530979Sdrh */ 1439d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth; 1440d4530979Sdrh struct sqlite3_userauth { 1441e933b83fSdrh u8 authLevel; /* Current authentication level */ 1442d4530979Sdrh int nAuthPW; /* Size of the zAuthPW in bytes */ 1443d4530979Sdrh char *zAuthPW; /* Password used to authenticate */ 1444d4530979Sdrh char *zAuthUser; /* User name used to authenticate */ 1445d4530979Sdrh }; 1446d4530979Sdrh 1447e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */ 1448e933b83fSdrh #define UAUTH_Unknown 0 /* Authentication not yet checked */ 1449e933b83fSdrh #define UAUTH_Fail 1 /* User authentication failed */ 1450e933b83fSdrh #define UAUTH_User 2 /* Authenticated as a normal user */ 1451e933b83fSdrh #define UAUTH_Admin 3 /* Authenticated as an administrator */ 1452d4530979Sdrh 1453d4530979Sdrh /* Functions used only by user authorization logic */ 1454d4530979Sdrh int sqlite3UserAuthTable(const char*); 1455e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*); 14567883ecfcSdrh void sqlite3UserAuthInit(sqlite3*); 1457f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**); 1458f442e33eSdrh 1459d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */ 1460d4530979Sdrh 146132c6a48bSdrh /* 146232c6a48bSdrh ** typedef for the authorization callback function. 146332c6a48bSdrh */ 146432c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION 146532c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 146632c6a48bSdrh const char*, const char*); 146732c6a48bSdrh #else 146832c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 146932c6a48bSdrh const char*); 147032c6a48bSdrh #endif 147132c6a48bSdrh 14723d2a529dSdrh #ifndef SQLITE_OMIT_DEPRECATED 14733d2a529dSdrh /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing 14743d2a529dSdrh ** in the style of sqlite3_trace() 14753d2a529dSdrh */ 147604c6747aSdrh #define SQLITE_TRACE_LEGACY 0x40 /* Use the legacy xTrace */ 147704c6747aSdrh #define SQLITE_TRACE_XPROFILE 0x80 /* Use the legacy xProfile */ 14783d2a529dSdrh #else 14793d2a529dSdrh #define SQLITE_TRACE_LEGACY 0 148004c6747aSdrh #define SQLITE_TRACE_XPROFILE 0 14813d2a529dSdrh #endif /* SQLITE_OMIT_DEPRECATED */ 148204c6747aSdrh #define SQLITE_TRACE_NONLEGACY_MASK 0x0f /* Normal flags */ 14833d2a529dSdrh 1484d4530979Sdrh 148570a8ca3cSdrh /* 1486a2460e07Sdrh ** Each database connection is an instance of the following structure. 148775897234Sdrh */ 14889bb575fdSdrh struct sqlite3 { 148990f6a5beSdrh sqlite3_vfs *pVfs; /* OS Interface */ 1490a451017dSdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 149142a630b1Sdrh CollSeq *pDfltColl; /* BINARY collseq for the database encoding */ 1492a451017dSdrh sqlite3_mutex *mutex; /* Connection mutex */ 1493001bbcbbSdrh Db *aDb; /* All backends */ 1494a451017dSdrh int nDb; /* Number of backends currently in use */ 14958257aa8dSdrh u32 mDbFlags; /* flags recording internal state */ 1496fd748c64Sdrh u64 flags; /* flags settable by pragmas. See below */ 1497a451017dSdrh i64 lastRowid; /* ROWID of most recent insert (see above) */ 14989b4c59faSdrh i64 szMmap; /* Default mmap_size setting */ 1499dc6b41edSdrh u32 nSchemaLock; /* Do not reset the schema when non-zero */ 1500522c26fbSdrh unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 1501fcd35c7bSdrh int errCode; /* Most recent error code (SQLITE_*) */ 15024ac285a1Sdrh int errMask; /* & result codes with this before returning */ 15031b9f2141Sdrh int iSysErrno; /* Errno value from last system error */ 1504af7b7653Sdrh u32 dbOptFlags; /* Flags to enable/disable optimizations */ 15059bd3cc46Sdrh u8 enc; /* Text encoding */ 1506fcd35c7bSdrh u8 autoCommit; /* The auto-commit flag. */ 150790f5ecb3Sdrh u8 temp_store; /* 1: file 2: memory 0: default */ 150817435752Sdrh u8 mallocFailed; /* True if we have seen a malloc failure */ 15094a642b60Sdrh u8 bBenignMalloc; /* Do not require OOMs if true */ 15103b02013eSdrh u8 dfltLockMode; /* Default locking-mode for attached dbs */ 151198757157Sdrh signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 1512a7564663Sdrh u8 suppressErr; /* Do not issue error messages if true */ 1513b061d058Sdan u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */ 1514a451017dSdrh u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 15153d2a529dSdrh u8 mTrace; /* zero or more SQLITE_TRACE flags */ 1516b2c8559fSdrh u8 noSharedCache; /* True if no shared-cache backends */ 1517bce04148Sdrh u8 nSqlExec; /* Number of pending OP_SqlExec opcodes */ 1518f653d782Sdanielk1977 int nextPagesize; /* Pagesize after VACUUM if >0 */ 151964202cfeSdanielk1977 u32 magic; /* Magic number for detect library misuse */ 1520b28af71aSdanielk1977 int nChange; /* Value returned by sqlite3_changes() */ 1521b28af71aSdanielk1977 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 1522caa639f4Sdrh int aLimit[SQLITE_N_LIMIT]; /* Limits */ 15238930c2abSdan int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */ 15244adee20fSdanielk1977 struct sqlite3InitInfo { /* Information used during initialization */ 1525abc38158Sdrh Pgno newTnum; /* Rootpage of table being initialized */ 1526a451017dSdrh u8 iDb; /* Which db file is being initialized */ 15271d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 1528e616735cSdrh unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */ 1529e616735cSdrh unsigned imposterTable : 1; /* Building an imposter table */ 1530e616735cSdrh unsigned reopenMemdb : 1; /* ATTACH is really a reopen using MemDB */ 1531c5a93d4cSdrh char **azInit; /* "type", "name", and "tbl_name" columns */ 15321d85d931Sdrh } init; 15331713afb0Sdrh int nVdbeActive; /* Number of VDBEs currently running */ 15344f7d3a5fSdrh int nVdbeRead; /* Number of active VDBEs that read or write */ 15354f7d3a5fSdrh int nVdbeWrite; /* Number of active VDBEs that read and write */ 15364f7d3a5fSdrh int nVdbeExec; /* Number of nested calls to VdbeExec() */ 1537086723a4Sdrh int nVDestroy; /* Number of active OP_VDestroy operations */ 1538a451017dSdrh int nExtension; /* Number of loaded extensions */ 1539a451017dSdrh void **aExtension; /* Array of shared library handles */ 154008b92086Sdrh union { 154108b92086Sdrh void (*xLegacy)(void*,const char*); /* Legacy trace function */ 154208b92086Sdrh int (*xV2)(u32,void*,void*,void*); /* V2 Trace function */ 154308b92086Sdrh } trace; 154418de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 154504c6747aSdrh #ifndef SQLITE_OMIT_DEPRECATED 154619e2d37fSdrh void (*xProfile)(void*,const char*,u64); /* Profiling function */ 154719e2d37fSdrh void *pProfileArg; /* Argument to profile function */ 154804c6747aSdrh #endif 1549fcd35c7bSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 1550fcd35c7bSdrh int (*xCommitCallback)(void*); /* Invoked at every commit. */ 155171fd80bfSdanielk1977 void *pRollbackArg; /* Argument to xRollbackCallback() */ 155271fd80bfSdanielk1977 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 155394eb6a14Sdanielk1977 void *pUpdateArg; 155494eb6a14Sdanielk1977 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 15551cf19758Sdrh Parse *pParse; /* Current parse */ 15569b1c62d4Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK 155746c47d46Sdan void *pPreUpdateArg; /* First argument to xPreUpdateCallback */ 155846c47d46Sdan void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */ 155946c47d46Sdan void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64 156046c47d46Sdan ); 156146c47d46Sdan PreUpdate *pPreUpdate; /* Context for active pre-update callback */ 15629b1c62d4Sdrh #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */ 15635cf53537Sdan #ifndef SQLITE_OMIT_WAL 15647ed91f23Sdrh int (*xWalCallback)(void *, sqlite3 *, const char *, int); 15657ed91f23Sdrh void *pWalArg; 15665cf53537Sdan #endif 1567fcd35c7bSdrh void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 1568fcd35c7bSdrh void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 1569fcd35c7bSdrh void *pCollNeededArg; 1570fcd35c7bSdrh sqlite3_value *pErr; /* Most recent error message */ 1571881feaa0Sdrh union { 157239001e75Sdrh volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 1573881feaa0Sdrh double notUsed1; /* Spacer */ 1574881feaa0Sdrh } u1; 1575633e6d57Sdrh Lookaside lookaside; /* Lookaside malloc configuration */ 1576ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 157732c6a48bSdrh sqlite3_xauth xAuth; /* Access authorization function */ 1578ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 1579ed6c8671Sdrh #endif 1580348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 1581348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 1582348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 15838f8c65f7Sdrh unsigned nProgressOps; /* Number of opcodes for progress callback */ 1584348bb5d6Sdanielk1977 #endif 1585b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 1586a451017dSdrh int nVTrans; /* Allocated size of aVTrans */ 1587b9bb7c18Sdrh Hash aModule; /* populated by sqlite3_create_module() */ 1588b061d058Sdan VtabCtx *pVtabCtx; /* Context for active vtab connect/create */ 1589595a523aSdanielk1977 VTable **aVTrans; /* Virtual tables with open transactions */ 1590595a523aSdanielk1977 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 15916b456a2bSdanielk1977 #endif 159280738d9cSdrh Hash aFunc; /* Hash table of connection functions */ 1593fcd35c7bSdrh Hash aCollSeq; /* All collating sequences */ 1594fcd35c7bSdrh BusyHandler busyHandler; /* Busy callback */ 1595fcd35c7bSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 1596fd7f0452Sdanielk1977 Savepoint *pSavepoint; /* List of active savepoints */ 159749a76a8fSdrh int nAnalysisLimit; /* Number of index rows to ANALYZE */ 1598a451017dSdrh int busyTimeout; /* Busy handler timeout, in msec */ 1599fd7f0452Sdanielk1977 int nSavepoint; /* Number of non-transaction savepoints */ 1600bd43455cSdanielk1977 int nStatement; /* Number of nested statement-transactions */ 16011da40a38Sdan i64 nDeferredCons; /* Net deferred constraints this transaction. */ 1602648e2643Sdrh i64 nDeferredImmCons; /* Net deferred immediate constraints */ 1603d46def77Sdan int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 1604404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 1605ccb2113aSdrh /* The following variables are all protected by the STATIC_MAIN 1606404ca075Sdanielk1977 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 160765a73badSdrh ** 160865a73badSdrh ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 160965a73badSdrh ** unlock so that it can proceed. 161065a73badSdrh ** 161165a73badSdrh ** When X.pBlockingConnection==Y, that means that something that X tried 161265a73badSdrh ** tried to do recently failed with an SQLITE_LOCKED error due to locks 161365a73badSdrh ** held by Y. 1614404ca075Sdanielk1977 */ 1615404ca075Sdanielk1977 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 1616404ca075Sdanielk1977 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 1617404ca075Sdanielk1977 void *pUnlockArg; /* Argument to xUnlockNotify */ 1618404ca075Sdanielk1977 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 1619404ca075Sdanielk1977 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 1620404ca075Sdanielk1977 #endif 1621d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1622d4530979Sdrh sqlite3_userauth auth; /* User authentication information */ 1623d4530979Sdrh #endif 162475897234Sdrh }; 162575897234Sdrh 162603b808a6Sdrh /* 162703b808a6Sdrh ** A macro to discover the encoding of a database. 162803b808a6Sdrh */ 16299bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc) 16309bd3cc46Sdrh #define ENC(db) ((db)->enc) 163114db2665Sdanielk1977 163275897234Sdrh /* 1633b945bcdaSdrh ** A u64 constant where the lower 32 bits are all zeros. Only the 1634b945bcdaSdrh ** upper 32 bits are included in the argument. Necessary because some 1635b945bcdaSdrh ** C-compilers still do not accept LL integer literals. 1636b945bcdaSdrh */ 1637b945bcdaSdrh #define HI(X) ((u64)(X)<<32) 1638b945bcdaSdrh 1639b945bcdaSdrh /* 164007096f68Sdrh ** Possible values for the sqlite3.flags. 164149711600Sdrh ** 164249711600Sdrh ** Value constraints (enforced via assert()): 164349711600Sdrh ** SQLITE_FullFSync == PAGER_FULLFSYNC 164449711600Sdrh ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC 164549711600Sdrh ** SQLITE_CacheSpill == PAGER_CACHE_SPILL 164675897234Sdrh */ 1647ccb2113aSdrh #define SQLITE_WriteSchema 0x00000001 /* OK to update SQLITE_SCHEMA */ 1648169dd928Sdrh #define SQLITE_LegacyFileFmt 0x00000002 /* Create new databases in format 1 */ 16496841b1cbSdrh #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */ 16506841b1cbSdrh #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */ 16516841b1cbSdrh #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */ 16526841b1cbSdrh #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */ 165340c3941cSdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 1654b77da374Sdrh #define SQLITE_TrustedSchema 0x00000080 /* Allow unsafe functions and 16552928a15bSdrh ** vtabs in the schema definition */ 165667c82653Sdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 165767c82653Sdrh /* result set is empty */ 1658169dd928Sdrh #define SQLITE_IgnoreChecks 0x00000200 /* Do not enforce check constraints */ 1659169dd928Sdrh #define SQLITE_ReadUncommit 0x00000400 /* READ UNCOMMITTED in shared-cache */ 1660169dd928Sdrh #define SQLITE_NoCkptOnClose 0x00000800 /* No checkpoint on close()/DETACH */ 1661169dd928Sdrh #define SQLITE_ReverseOrder 0x00001000 /* Reverse unordered SELECTs */ 1662169dd928Sdrh #define SQLITE_RecTriggers 0x00002000 /* Enable recursive triggers */ 1663169dd928Sdrh #define SQLITE_ForeignKeys 0x00004000 /* Enforce foreign key constraints */ 1664169dd928Sdrh #define SQLITE_AutoIndex 0x00008000 /* Enable automatic indexes */ 1665169dd928Sdrh #define SQLITE_LoadExtension 0x00010000 /* Enable load_extension */ 16668257aa8dSdrh #define SQLITE_LoadExtFunc 0x00020000 /* Enable load_extension() SQL func */ 16678257aa8dSdrh #define SQLITE_EnableTrigger 0x00040000 /* True to enable triggers */ 16688257aa8dSdrh #define SQLITE_DeferFKs 0x00080000 /* Defer all FK constraints */ 16698257aa8dSdrh #define SQLITE_QueryOnly 0x00100000 /* Disable database changes */ 16708257aa8dSdrh #define SQLITE_CellSizeCk 0x00200000 /* Check btree cell sizes on load */ 16718257aa8dSdrh #define SQLITE_Fts3Tokenizer 0x00400000 /* Enable fts3_tokenizer(2) */ 16728257aa8dSdrh #define SQLITE_EnableQPSG 0x00800000 /* Query Planner Stability Guarantee*/ 167336e31c69Sdrh #define SQLITE_TriggerEQP 0x01000000 /* Show trigger EXPLAIN QUERY PLAN */ 16740314cf3aSdrh #define SQLITE_ResetDatabase 0x02000000 /* Reset the database */ 1675674b8942Sdan #define SQLITE_LegacyAlter 0x04000000 /* Legacy ALTER TABLE behaviour */ 1676fd748c64Sdrh #define SQLITE_NoSchemaError 0x08000000 /* Do not report schema parse errors*/ 1677a296cda0Sdrh #define SQLITE_Defensive 0x10000000 /* Input SQL is likely hostile */ 1678d0ff601cSdrh #define SQLITE_DqsDDL 0x20000000 /* dbl-quoted strings allowed in DDL*/ 1679d0ff601cSdrh #define SQLITE_DqsDML 0x40000000 /* dbl-quoted strings allowed in DML*/ 168011d88e68Sdrh #define SQLITE_EnableView 0x80000000 /* Enable the use of views */ 1681b945bcdaSdrh #define SQLITE_CountRows HI(0x00001) /* Count rows changed by INSERT, */ 1682b945bcdaSdrh /* DELETE, or UPDATE and return */ 1683b945bcdaSdrh /* the count using a callback. */ 168436e31c69Sdrh 1685169dd928Sdrh /* Flags used only if debugging */ 1686169dd928Sdrh #ifdef SQLITE_DEBUG 168711d88e68Sdrh #define SQLITE_SqlTrace HI(0x0100000) /* Debug print SQL as it executes */ 168811d88e68Sdrh #define SQLITE_VdbeListing HI(0x0200000) /* Debug listings of VDBE progs */ 168911d88e68Sdrh #define SQLITE_VdbeTrace HI(0x0400000) /* True to trace VDBE execution */ 169011d88e68Sdrh #define SQLITE_VdbeAddopTrace HI(0x0800000) /* Trace sqlite3VdbeAddOp() calls */ 169111d88e68Sdrh #define SQLITE_VdbeEQP HI(0x1000000) /* Debug EXPLAIN QUERY PLAN */ 169211d88e68Sdrh #define SQLITE_ParserTrace HI(0x2000000) /* PRAGMA parser_trace=ON */ 1693169dd928Sdrh #endif 1694b1eaa718Sdrh 16958257aa8dSdrh /* 16968257aa8dSdrh ** Allowed values for sqlite3.mDbFlags 16978257aa8dSdrh */ 16988257aa8dSdrh #define DBFLAG_SchemaChange 0x0001 /* Uncommitted Hash table changes */ 16998257aa8dSdrh #define DBFLAG_PreferBuiltin 0x0002 /* Preference to built-in funcs */ 17008257aa8dSdrh #define DBFLAG_Vacuum 0x0004 /* Currently in a VACUUM */ 17014e61e883Sdrh #define DBFLAG_VacuumInto 0x0008 /* Currently running VACUUM INTO */ 17024e61e883Sdrh #define DBFLAG_SchemaKnownOk 0x0010 /* Schema is known to be valid */ 1703171c50ecSdrh #define DBFLAG_InternalFunc 0x0020 /* Allow use of internal functions */ 17040ea2d42aSdan #define DBFLAG_EncodingFixed 0x0040 /* No longer possible to change enc. */ 170507096f68Sdrh 170607096f68Sdrh /* 17077e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the 17087e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to 17097e5418e4Sdrh ** selectively disable various optimizations. 171007096f68Sdrh */ 1711af7b7653Sdrh #define SQLITE_QueryFlattener 0x00000001 /* Query flattening */ 1712af7b7653Sdrh #define SQLITE_WindowFunc 0x00000002 /* Use xInverse for window functions */ 1713af7b7653Sdrh #define SQLITE_GroupByOrder 0x00000004 /* GROUPBY cover of ORDERBY */ 1714af7b7653Sdrh #define SQLITE_FactorOutConst 0x00000008 /* Constant factoring */ 1715af7b7653Sdrh #define SQLITE_DistinctOpt 0x00000010 /* DISTINCT using indexes */ 1716af7b7653Sdrh #define SQLITE_CoverIdxScan 0x00000020 /* Covering index scans */ 1717af7b7653Sdrh #define SQLITE_OrderByIdxJoin 0x00000040 /* ORDER BY of joins via index */ 1718af7b7653Sdrh #define SQLITE_Transitive 0x00000080 /* Transitive constraints */ 1719af7b7653Sdrh #define SQLITE_OmitNoopJoin 0x00000100 /* Omit unused tables in joins */ 1720af7b7653Sdrh #define SQLITE_CountOfView 0x00000200 /* The count-of-view optimization */ 1721af7b7653Sdrh #define SQLITE_CursorHints 0x00000400 /* Add OP_CursorHint opcodes */ 1722af7b7653Sdrh #define SQLITE_Stat4 0x00000800 /* Use STAT4 data */ 1723af7b7653Sdrh /* TH3 expects this value ^^^^^^^^^^ to be 0x0000800. Don't change it */ 1724af7b7653Sdrh #define SQLITE_PushDown 0x00001000 /* The push-down optimization */ 1725af7b7653Sdrh #define SQLITE_SimplifyJoin 0x00002000 /* Convert LEFT JOIN to JOIN */ 1726af7b7653Sdrh #define SQLITE_SkipScan 0x00004000 /* Skip-scans */ 1727af7b7653Sdrh #define SQLITE_PropagateConst 0x00008000 /* The constant propagation opt */ 1728af7b7653Sdrh #define SQLITE_MinMaxOpt 0x00010000 /* The min/max optimization */ 172919ef211dSdrh #define SQLITE_ExistsToIN 0x00020000 /* The EXISTS-to-IN optimization */ 1730af7b7653Sdrh #define SQLITE_AllOpts 0xffffffff /* All optimizations */ 17317e5418e4Sdrh 17327e5418e4Sdrh /* 17337e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled. 17347e5418e4Sdrh */ 17357e5418e4Sdrh #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0) 17367e5418e4Sdrh #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0) 173734c68fbaSdanielk1977 173858b9576bSdrh /* 1739d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization 1740d9f158e7Sdrh ** code. The argument is a Parse object for the code generator. 1741d9f158e7Sdrh */ 1742aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor) 1743d9f158e7Sdrh 1744d9f158e7Sdrh /* 1745247be43dSdrh ** Possible values for the sqlite.magic field. 1746247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 1747247be43dSdrh ** than being distinct from one another. 1748247be43dSdrh */ 1749247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 1750247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 17517e8b848aSdrh #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 1752247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 1753247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 17544245c405Sdrh #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */ 1755247be43dSdrh 1756247be43dSdrh /* 17570bce8354Sdrh ** Each SQL function is defined by an instance of the following 175880738d9cSdrh ** structure. For global built-in functions (ex: substr(), max(), count()) 175980738d9cSdrh ** a pointer to this structure is held in the sqlite3BuiltinFunctions object. 176080738d9cSdrh ** For per-connection application-defined functions, a pointer to this 176180738d9cSdrh ** structure is held in the db->aHash hash table. 176280738d9cSdrh ** 176380738d9cSdrh ** The u.pHash field is used by the global built-ins. The u.pDestructor 176480738d9cSdrh ** field is used by per-connection app-def functions. 17652803757aSdrh */ 17660bce8354Sdrh struct FuncDef { 176780738d9cSdrh i8 nArg; /* Number of arguments. -1 means unlimited */ 1768dfa552f4Sdan u32 funcFlags; /* Some combination of SQLITE_FUNC_* */ 17691350b030Sdrh void *pUserData; /* User data parameter */ 17700bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 17712d80151fSdrh void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */ 17722d80151fSdrh void (*xFinalize)(sqlite3_context*); /* Agg finalizer */ 177386fb6e17Sdan void (*xValue)(sqlite3_context*); /* Current agg value */ 177486fb6e17Sdan void (*xInverse)(sqlite3_context*,int,sqlite3_value**); /* inverse agg-step */ 17756ad224e9Sdrh const char *zName; /* SQL name of the function. */ 177680738d9cSdrh union { 177770a8ca3cSdrh FuncDef *pHash; /* Next with a different name but the same hash */ 1778d2199f0fSdan FuncDestructor *pDestructor; /* Reference counted destructor function */ 177980738d9cSdrh } u; 1780d2199f0fSdan }; 1781d2199f0fSdan 1782d2199f0fSdan /* 1783d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as 1784d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When 1785d2199f0fSdan ** create_function_v2() is called to create a function with a destructor, 1786d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to 1787d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether 1788d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 1789d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated 1790d2199f0fSdan ** FuncDestructor. 1791d2199f0fSdan ** 1792d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference 1793d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor 1794d2199f0fSdan ** is invoked and the FuncDestructor structure freed. 1795d2199f0fSdan */ 1796d2199f0fSdan struct FuncDestructor { 1797d2199f0fSdan int nRef; 1798d2199f0fSdan void (*xDestroy)(void *); 1799d2199f0fSdan void *pUserData; 18008e0a2f90Sdrh }; 18012803757aSdrh 18022803757aSdrh /* 1803a748fdccSdrh ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF 18047977fa3aSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And 18057977fa3aSdrh ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There 1806a748fdccSdrh ** are assert() statements in the code to verify this. 180749711600Sdrh ** 180849711600Sdrh ** Value constraints (enforced via assert()): 180949711600Sdrh ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg 181049711600Sdrh ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG 181149711600Sdrh ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG 181249711600Sdrh ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API 181342d2fce7Sdrh ** SQLITE_FUNC_DIRECT == SQLITE_DIRECTONLY from the API 18144be621e1Sdrh ** SQLITE_FUNC_UNSAFE == SQLITE_INNOCUOUS 181549711600Sdrh ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API 18167d10d5a6Sdrh */ 18171d85e405Sdrh #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */ 18181d85e405Sdrh #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */ 18191d85e405Sdrh #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */ 18201d85e405Sdrh #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */ 18211d85e405Sdrh #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/ 18221d85e405Sdrh #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */ 18231d85e405Sdrh #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */ 18241d85e405Sdrh #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */ 1825ffe421c7Sdrh /* 0x0200 -- available for reuse */ 18261d85e405Sdrh #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */ 18271d85e405Sdrh #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */ 18289588ad95Sdrh #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */ 1829a7f910b5Sdrh #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a 1830a7f910b5Sdrh ** single query - might change over time */ 183125c4296bSdrh #define SQLITE_FUNC_TEST 0x4000 /* Built-in testing functions */ 1832092457b1Sdrh #define SQLITE_FUNC_OFFSET 0x8000 /* Built-in sqlite_offset() function */ 1833eea8eb6dSdrh #define SQLITE_FUNC_WINDOW 0x00010000 /* Built-in window-only function */ 1834eea8eb6dSdrh #define SQLITE_FUNC_INTERNAL 0x00040000 /* For use by NestedParse() only */ 183542d2fce7Sdrh #define SQLITE_FUNC_DIRECT 0x00080000 /* Not for use in TRIGGERs or VIEWs */ 1836e2ba6df9Sdan #define SQLITE_FUNC_SUBTYPE 0x00100000 /* Result likely to have sub-type */ 18374be621e1Sdrh #define SQLITE_FUNC_UNSAFE 0x00200000 /* Function has side effects */ 1838c4ad8499Sdrh #define SQLITE_FUNC_INLINE 0x00400000 /* Functions implemented in-line */ 1839c4ad8499Sdrh 184025c4296bSdrh /* Identifier numbers for each in-line function */ 1841171c50ecSdrh #define INLINEFUNC_coalesce 0 1842171c50ecSdrh #define INLINEFUNC_implies_nonnull_row 1 1843171c50ecSdrh #define INLINEFUNC_expr_implies_expr 2 1844171c50ecSdrh #define INLINEFUNC_expr_compare 3 1845171c50ecSdrh #define INLINEFUNC_affinity 4 18463c0e606bSdrh #define INLINEFUNC_iif 5 1847171c50ecSdrh #define INLINEFUNC_unlikely 99 /* Default case */ 18487d10d5a6Sdrh 18497d10d5a6Sdrh /* 1850777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1851777c5386Sdrh ** used to create the initializers for the FuncDef structures. 1852777c5386Sdrh ** 1853777c5386Sdrh ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1854777c5386Sdrh ** Used to create a scalar function definition of a function zName 1855777c5386Sdrh ** implemented by C function xFunc that accepts nArg arguments. The 1856777c5386Sdrh ** value passed as iArg is cast to a (void*) and made available 1857777c5386Sdrh ** as the user-data (sqlite3_user_data()) for the function. If 1858f7bca574Sdrh ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1859777c5386Sdrh ** 1860b1fba286Sdrh ** VFUNCTION(zName, nArg, iArg, bNC, xFunc) 1861b1fba286Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag. 1862b1fba286Sdrh ** 186364de2a5fSdrh ** SFUNCTION(zName, nArg, iArg, bNC, xFunc) 186464de2a5fSdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 186564de2a5fSdrh ** adds the SQLITE_DIRECTONLY flag. 186664de2a5fSdrh ** 186725c4296bSdrh ** INLINE_FUNC(zName, nArg, iFuncId, mFlags) 186825c4296bSdrh ** zName is the name of a function that is implemented by in-line 186925c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 187025c4296bSdrh ** parameter determines the function id. The mFlags parameter is 187125c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 187225c4296bSdrh ** 187325c4296bSdrh ** TEST_FUNC(zName, nArg, iFuncId, mFlags) 187425c4296bSdrh ** zName is the name of a test-only function implemented by in-line 187525c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 187625c4296bSdrh ** parameter determines the function id. The mFlags parameter is 187725c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 187825c4296bSdrh ** 18791d85e405Sdrh ** DFUNCTION(zName, nArg, iArg, bNC, xFunc) 18801d85e405Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 1881a7f910b5Sdrh ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions 188203bf26d9Sdrh ** and functions like sqlite_version() that can change, but not during 18833e34eabcSdrh ** a single query. The iArg is ignored. The user-data is always set 18843e34eabcSdrh ** to a NULL pointer. The bNC parameter is not used. 18853e34eabcSdrh ** 1886f6e904bdSdrh ** MFUNCTION(zName, nArg, xPtr, xFunc) 1887f6e904bdSdrh ** For math-library functions. xPtr is an arbitrary pointer. 1888f6e904bdSdrh ** 18893e34eabcSdrh ** PURE_DATE(zName, nArg, iArg, bNC, xFunc) 18903e34eabcSdrh ** Used for "pure" date/time functions, this macro is like DFUNCTION 18913e34eabcSdrh ** except that it does set the SQLITE_FUNC_CONSTANT flags. iArg is 18923e34eabcSdrh ** ignored and the user-data for these functions is set to an 18933e34eabcSdrh ** arbitrary non-NULL pointer. The bNC parameter is not used. 18941d85e405Sdrh ** 1895777c5386Sdrh ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1896777c5386Sdrh ** Used to create an aggregate function definition implemented by 1897777c5386Sdrh ** the C functions xStep and xFinal. The first four parameters 1898777c5386Sdrh ** are interpreted in the same way as the first 4 parameters to 1899777c5386Sdrh ** FUNCTION(). 1900777c5386Sdrh ** 190186fb6e17Sdan ** WFUNCTION(zName, nArg, iArg, xStep, xFinal, xValue, xInverse) 190286fb6e17Sdan ** Used to create an aggregate function definition implemented by 190386fb6e17Sdan ** the C functions xStep and xFinal. The first four parameters 190486fb6e17Sdan ** are interpreted in the same way as the first 4 parameters to 190586fb6e17Sdan ** FUNCTION(). 190686fb6e17Sdan ** 1907777c5386Sdrh ** LIKEFUNC(zName, nArg, pArg, flags) 1908777c5386Sdrh ** Used to create a scalar function definition of a function zName 1909777c5386Sdrh ** that accepts nArg arguments and is implemented by a call to C 1910777c5386Sdrh ** function likeFunc. Argument pArg is cast to a (void *) and made 1911777c5386Sdrh ** available as the function user-data (sqlite3_user_data()). The 1912777c5386Sdrh ** FuncDef.flags variable is set to the value passed as the flags 1913777c5386Sdrh ** parameter. 1914777c5386Sdrh */ 1915777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19164be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 191786fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1918b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1919d36e1041Sdrh {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 192086fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 192164de2a5fSdrh #define SFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 192279d5bc80Sdrh {nArg, SQLITE_UTF8|SQLITE_DIRECTONLY|SQLITE_FUNC_UNSAFE, \ 192364de2a5fSdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1924f6e904bdSdrh #define MFUNCTION(zName, nArg, xPtr, xFunc) \ 1925f6e904bdSdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8, \ 1926f6e904bdSdrh xPtr, 0, xFunc, 0, 0, 0, #zName, {0} } 192725c4296bSdrh #define INLINE_FUNC(zName, nArg, iArg, mFlags) \ 19284be621e1Sdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 192925c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 193025c4296bSdrh #define TEST_FUNC(zName, nArg, iArg, mFlags) \ 193125c4296bSdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INTERNAL|SQLITE_FUNC_TEST| \ 19324be621e1Sdrh SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 193325c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 19341d85e405Sdrh #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19354be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \ 193686fb6e17Sdan 0, 0, xFunc, 0, 0, 0, #zName, {0} } 19373e34eabcSdrh #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \ 19384be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 193986fb6e17Sdan (void*)&sqlite3Config, 0, xFunc, 0, 0, 0, #zName, {0} } 1940a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \ 19414be621e1Sdrh {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\ 194286fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 194321717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 19444be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 194586fb6e17Sdan pArg, 0, xFunc, 0, 0, 0, #zName, } 1946777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \ 19474be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \ 194886fb6e17Sdan (void *)arg, 0, likeFunc, 0, 0, 0, #zName, {0} } 19496fb2b54cSdan #define WAGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue, xInverse, f) \ 19506fb2b54cSdan {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|f, \ 195103854d2eSdan SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,xInverse,#zName, {0}} 1952eea8eb6dSdrh #define INTERNAL_FUNCTION(zName, nArg, xFunc) \ 1953eea8eb6dSdrh {nArg, SQLITE_FUNC_INTERNAL|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 1954eea8eb6dSdrh 0, 0, xFunc, 0, 0, 0, #zName, {0} } 1955eea8eb6dSdrh 1956777c5386Sdrh 1957fd7f0452Sdanielk1977 /* 1958fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at 1959fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently 1960fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe 1961fd7f0452Sdanielk1977 ** OP_Savepoint instruction. 1962fd7f0452Sdanielk1977 */ 1963fd7f0452Sdanielk1977 struct Savepoint { 1964fd7f0452Sdanielk1977 char *zName; /* Savepoint name (nul-terminated) */ 1965fcb9f7adSdrh i64 nDeferredCons; /* Number of deferred fk violations */ 1966648e2643Sdrh i64 nDeferredImmCons; /* Number of deferred imm fk. */ 1967fd7f0452Sdanielk1977 Savepoint *pNext; /* Parent savepoint (if any) */ 1968fd7f0452Sdanielk1977 }; 1969fd7f0452Sdanielk1977 1970fd7f0452Sdanielk1977 /* 1971fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(), 1972fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction. 1973fd7f0452Sdanielk1977 */ 1974fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN 0 1975fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE 1 1976fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK 2 1977fd7f0452Sdanielk1977 1978777c5386Sdrh 1979777c5386Sdrh /* 1980d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an 1981d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule 1982d1ab1ba5Sdanielk1977 ** hash table. 1983d1ab1ba5Sdanielk1977 */ 1984d1ab1ba5Sdanielk1977 struct Module { 1985d1ab1ba5Sdanielk1977 const sqlite3_module *pModule; /* Callback pointers */ 1986d1ab1ba5Sdanielk1977 const char *zName; /* Name passed to create_module() */ 1987cc5979dbSdrh int nRefModule; /* Number of pointers to this object */ 1988d1ab1ba5Sdanielk1977 void *pAux; /* pAux passed to create_module() */ 1989832a58a6Sdanielk1977 void (*xDestroy)(void *); /* Module destructor function */ 199051be3873Sdrh Table *pEpoTab; /* Eponymous table for this module */ 1991d1ab1ba5Sdanielk1977 }; 1992d1ab1ba5Sdanielk1977 1993d1ab1ba5Sdanielk1977 /* 1994b9bcf7caSdrh ** Information about each column of an SQL table is held in an instance 1995b9bcf7caSdrh ** of the Column structure, in the Table.aCol[] array. 1996b9bcf7caSdrh ** 1997b9bcf7caSdrh ** Definitions: 1998b9bcf7caSdrh ** 1999b9bcf7caSdrh ** "table column index" This is the index of the column in the 2000b9bcf7caSdrh ** Table.aCol[] array, and also the index of 2001b9bcf7caSdrh ** the column in the original CREATE TABLE stmt. 2002b9bcf7caSdrh ** 2003b9bcf7caSdrh ** "storage column index" This is the index of the column in the 2004b9bcf7caSdrh ** record BLOB generated by the OP_MakeRecord 2005b9bcf7caSdrh ** opcode. The storage column index is less than 2006b9bcf7caSdrh ** or equal to the table column index. It is 2007b9bcf7caSdrh ** equal if and only if there are no VIRTUAL 2008b9bcf7caSdrh ** columns to the left. 20097020f651Sdrh */ 20107020f651Sdrh struct Column { 201194eaafa9Sdrh char *zName; /* Name of this column, \000, then the type */ 201281f7b372Sdrh Expr *pDflt; /* Default value or GENERATED ALWAYS AS value */ 2013b3bf556eSdanielk1977 char *zColl; /* Collating sequence. If NULL, use the default */ 2014a371ace4Sdrh u8 notNull; /* An OE_ code for handling a NOT NULL constraint */ 2015a37cdde0Sdanielk1977 char affinity; /* One of the SQLITE_AFF_... values */ 2016e5520e2fSdrh u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */ 2017d44390c8Sdrh u8 hName; /* Column name hash for faster lookup */ 20189942ef0dSdrh u16 colFlags; /* Boolean properties. See COLFLAG_ defines below */ 20197020f651Sdrh }; 20207020f651Sdrh 20216f6e60ddSdrh /* Allowed values for Column.colFlags. 20226f6e60ddSdrh ** 20236f6e60ddSdrh ** Constraints: 20246f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 20256f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 20266f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 2027a371ace4Sdrh */ 2028a371ace4Sdrh #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */ 2029a371ace4Sdrh #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */ 2030d7564865Sdrh #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */ 203126e731ccSdan #define COLFLAG_UNIQUE 0x0008 /* Column def contains "UNIQUE" or "PK" */ 20322e3a5a81Sdan #define COLFLAG_SORTERREF 0x0010 /* Use sorter-refs with this column */ 203381f7b372Sdrh #define COLFLAG_VIRTUAL 0x0020 /* GENERATED ALWAYS AS ... VIRTUAL */ 203481f7b372Sdrh #define COLFLAG_STORED 0x0040 /* GENERATED ALWAYS AS ... STORED */ 203512bf7127Sdrh #define COLFLAG_NOTAVAIL 0x0080 /* STORED column not yet calculated */ 203612bf7127Sdrh #define COLFLAG_BUSY 0x0100 /* Blocks recursion on GENERATED columns */ 2037c27ea2aeSdrh #define COLFLAG_GENERATED 0x0060 /* Combo: _STORED, _VIRTUAL */ 20387e508f1eSdrh #define COLFLAG_NOINSERT 0x0062 /* Combo: _HIDDEN, _STORED, _VIRTUAL */ 2039a371ace4Sdrh 20407020f651Sdrh /* 2041a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following 20420202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and 20430202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence. 2044a9fd84b0Sdrh ** 2045e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the 20460202b29eSdanielk1977 ** collating sequence is undefined. Indices built on an undefined 20470202b29eSdanielk1977 ** collating sequence may not be read or written. 2048a9fd84b0Sdrh */ 2049a9fd84b0Sdrh struct CollSeq { 20500202b29eSdanielk1977 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 2051466be56bSdanielk1977 u8 enc; /* Text encoding handled by xCmp() */ 2052a9fd84b0Sdrh void *pUser; /* First argument to xCmp() */ 20530202b29eSdanielk1977 int (*xCmp)(void*,int, const void*, int, const void*); 2054a9808b31Sdanielk1977 void (*xDel)(void*); /* Destructor for pUser */ 2055a9fd84b0Sdrh }; 2056a9fd84b0Sdrh 2057a9fd84b0Sdrh /* 2058d3d39e93Sdrh ** A sort order can be either ASC or DESC. 20598e2ca029Sdrh */ 20608e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 2061d3d39e93Sdrh #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 2062bc622bc0Sdrh #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */ 20638e2ca029Sdrh 20648e2ca029Sdrh /* 2065a37cdde0Sdanielk1977 ** Column affinity types. 20668a51256cSdrh ** 20678a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 20688a51256cSdrh ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 20697d10d5a6Sdrh ** the speed a little by numbering the values consecutively. 20708a51256cSdrh ** 20714583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'. That way, 20728a51256cSdrh ** when multiple affinity types are concatenated into a string and 207366a5167bSdrh ** used as the P4 operand, they will be more readable. 20748a51256cSdrh ** 20758a51256cSdrh ** Note also that the numeric types are grouped together so that testing 207605883a34Sdrh ** for a numeric type is a single comparison. And the BLOB type is first. 2077a37cdde0Sdanielk1977 */ 207896fb16eeSdrh #define SQLITE_AFF_NONE 0x40 /* '@' */ 207996fb16eeSdrh #define SQLITE_AFF_BLOB 0x41 /* 'A' */ 208096fb16eeSdrh #define SQLITE_AFF_TEXT 0x42 /* 'B' */ 208196fb16eeSdrh #define SQLITE_AFF_NUMERIC 0x43 /* 'C' */ 208296fb16eeSdrh #define SQLITE_AFF_INTEGER 0x44 /* 'D' */ 208396fb16eeSdrh #define SQLITE_AFF_REAL 0x45 /* 'E' */ 2084a37cdde0Sdanielk1977 20858a51256cSdrh #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 2086a37cdde0Sdanielk1977 2087a37cdde0Sdanielk1977 /* 208835573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an 208935573356Sdrh ** affinity value. 209035573356Sdrh */ 20914583c37cSdrh #define SQLITE_AFF_MASK 0x47 209235573356Sdrh 209335573356Sdrh /* 209435573356Sdrh ** Additional bit values that can be ORed with an affinity without 209535573356Sdrh ** changing the affinity. 20963d77dee9Sdrh ** 20973d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL. 20983d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison 20993d77dee9Sdrh ** operator is NULL. It is added to certain comparison operators to 21003d77dee9Sdrh ** prove that the operands are always NOT NULL. 210135573356Sdrh */ 210279752b6eSdrh #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */ 21034583c37cSdrh #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */ 21044583c37cSdrh #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */ 21056a2fe093Sdrh #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 21064583c37cSdrh #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */ 210735573356Sdrh 210835573356Sdrh /* 2109595a523aSdanielk1977 ** An object of this type is created for each virtual table present in 2110595a523aSdanielk1977 ** the database schema. 2111595a523aSdanielk1977 ** 2112595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this 2113595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared 2114595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique 2115595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table 2116595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between 2117595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database 2118595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database 2119595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method 2120595a523aSdanielk1977 ** during initialization internally. This database connection handle may 21219bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables 2122595a523aSdanielk1977 ** within the database. So that they appear as part of the callers 2123595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database 2124595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table. 2125595a523aSdanielk1977 ** 2126595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared 2127595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by 2128595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object. 2129595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual 2130595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the 2131595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct 2132595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query. 2133595a523aSdanielk1977 ** 2134595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the 2135595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not 2136595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 2137595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to 2138595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the 2139595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 2140595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done 2141595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 2142595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an 2143595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 2144595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex. 2145595a523aSdanielk1977 ** 2146595a523aSdanielk1977 ** The memory for objects of this type is always allocated by 2147595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 2148595a523aSdanielk1977 ** the first argument. 2149595a523aSdanielk1977 */ 2150595a523aSdanielk1977 struct VTable { 2151595a523aSdanielk1977 sqlite3 *db; /* Database connection associated with this table */ 2152595a523aSdanielk1977 Module *pMod; /* Pointer to module implementation */ 2153595a523aSdanielk1977 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 2154595a523aSdanielk1977 int nRef; /* Number of pointers to this structure */ 2155b061d058Sdan u8 bConstraint; /* True if constraints are supported */ 21562928a15bSdrh u8 eVtabRisk; /* Riskiness of allowing hacker access */ 2157addd8f87Sdrh int iSavepoint; /* Depth of the SAVEPOINT stack */ 2158595a523aSdanielk1977 VTable *pNext; /* Next in linked list (see above) */ 2159595a523aSdanielk1977 }; 2160595a523aSdanielk1977 21612928a15bSdrh /* Allowed values for VTable.eVtabRisk 21622928a15bSdrh */ 21632928a15bSdrh #define SQLITE_VTABRISK_Low 0 21642928a15bSdrh #define SQLITE_VTABRISK_Normal 1 21652928a15bSdrh #define SQLITE_VTABRISK_High 2 21662928a15bSdrh 2167595a523aSdanielk1977 /* 21685789d1a4Sdrh ** The schema for each SQL table and view is represented in memory 21695789d1a4Sdrh ** by an instance of the following structure. 217075897234Sdrh */ 217175897234Sdrh struct Table { 21727d10d5a6Sdrh char *zName; /* Name of the table or view */ 21737020f651Sdrh Column *aCol; /* Information about each column */ 2174967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 2175a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 2176c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 21773d1bfeaaSdanielk1977 char *zColAff; /* String defining the affinity of each column */ 21782938f924Sdrh ExprList *pCheck; /* All CHECK constraints */ 21798981b904Sdrh /* ... also used as column name list in a VIEW */ 2180abc38158Sdrh Pgno tnum; /* Root BTree page for this table */ 218179df7782Sdrh u32 nTabRef; /* Number of pointers to this Table */ 21826f271a42Sdrh u32 tabFlags; /* Mask of TF_* values */ 21835789d1a4Sdrh i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */ 2184d815f17dSdrh i16 nCol; /* Number of columns in this table */ 21850b0b3a95Sdrh i16 nNVCol; /* Number of columns that are not VIRTUAL */ 21865789d1a4Sdrh LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */ 2187bf539c4dSdrh LogEst szTabRow; /* Estimated size of each table row in bytes */ 2188dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT 2189dbd9486dSdrh LogEst costMult; /* Cost multiplier for using this table */ 2190dbd9486dSdrh #endif 2191d815f17dSdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 219219a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE 21937d10d5a6Sdrh int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 219419a8e7e8Sdanielk1977 #endif 2195e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 2196b9bb7c18Sdrh int nModuleArg; /* Number of arguments to the module */ 21978a48b9c0Sdrh char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */ 2198d815f17dSdrh VTable *pVTable; /* List of VTable objects. */ 2199e09daa90Sdrh #endif 22002f886d1dSdanielk1977 Trigger *pTrigger; /* List of triggers stored in pSchema */ 2201728b5779Sdrh Schema *pSchema; /* Schema that contains this table */ 220275897234Sdrh }; 220375897234Sdrh 220475897234Sdrh /* 22058ce7184bSdan ** Allowed values for Table.tabFlags. 2206a21f78b9Sdrh ** 220780090f92Sdrh ** TF_OOOHidden applies to tables or view that have hidden columns that are 2208a21f78b9Sdrh ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING 2209a21f78b9Sdrh ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden, 2210a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case. Such tables require 2211c1431144Sdrh ** special handling during INSERT processing. The "OOO" means "Out Of Order". 2212c1431144Sdrh ** 2213c1431144Sdrh ** Constraints: 2214c1431144Sdrh ** 22156f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 22166f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 22176f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 22187d10d5a6Sdrh */ 221933bec3f5Sdrh #define TF_Readonly 0x0001 /* Read-only system table */ 22206f6e60ddSdrh #define TF_HasHidden 0x0002 /* Has one or more hidden columns */ 222133bec3f5Sdrh #define TF_HasPrimaryKey 0x0004 /* Table has a primary key */ 222233bec3f5Sdrh #define TF_Autoincrement 0x0008 /* Integer primary key is autoincrement */ 2223a3928dd7Sdrh #define TF_HasStat1 0x0010 /* nRowLogEst set from sqlite_stat1 */ 2224c1431144Sdrh #define TF_HasVirtual 0x0020 /* Has one or more VIRTUAL columns */ 2225c1431144Sdrh #define TF_HasStored 0x0040 /* Has one or more STORED columns */ 2226427b96aeSdrh #define TF_HasGenerated 0x0060 /* Combo: HasVirtual + HasStored */ 2227c1431144Sdrh #define TF_WithoutRowid 0x0080 /* No rowid. PRIMARY KEY is the key */ 22285e98e838Sdrh #define TF_StatsUsed 0x0100 /* Query planner decisions affected by 2229a3928dd7Sdrh ** Index.aiRowLogEst[] values */ 2230c1431144Sdrh #define TF_NoVisibleRowid 0x0200 /* No user-visible "rowid" column */ 2231c1431144Sdrh #define TF_OOOHidden 0x0400 /* Out-of-Order hidden columns */ 2232c1431144Sdrh #define TF_HasNotNull 0x0800 /* Contains NOT NULL constraints */ 2233c1431144Sdrh #define TF_Shadow 0x1000 /* True for a shadow table */ 223440386968Sdrh #define TF_HasStat4 0x2000 /* STAT4 info available for this table */ 22356f6e60ddSdrh #define TF_Ephemeral 0x4000 /* An ephemeral table */ 22367d10d5a6Sdrh 22377d10d5a6Sdrh /* 22384cbdda9eSdrh ** Test to see whether or not a table is a virtual table. This is 22394cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual 22404cbdda9eSdrh ** table support is omitted from the build. 22414cbdda9eSdrh */ 22424cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 224344266ec6Sdrh # define IsVirtual(X) ((X)->nModuleArg) 224478d1d225Sdrh # define ExprIsVtab(X) \ 224578d1d225Sdrh ((X)->op==TK_COLUMN && (X)->y.pTab!=0 && (X)->y.pTab->nModuleArg) 22464cbdda9eSdrh #else 22474cbdda9eSdrh # define IsVirtual(X) 0 224878d1d225Sdrh # define ExprIsVtab(X) 0 22494cbdda9eSdrh #endif 22504cbdda9eSdrh 225103d69a68Sdrh /* 225203d69a68Sdrh ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn() 225303d69a68Sdrh ** only works for non-virtual tables (ordinary tables and views) and is 225403d69a68Sdrh ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The 225503d69a68Sdrh ** IsHiddenColumn() macro is general purpose. 225603d69a68Sdrh */ 225703d69a68Sdrh #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS) 225803d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 225903d69a68Sdrh # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 226018f8e734Sdrh #elif !defined(SQLITE_OMIT_VIRTUALTABLE) 226103d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 226203d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 226303d69a68Sdrh #else 226403d69a68Sdrh # define IsHiddenColumn(X) 0 226503d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 226603d69a68Sdrh #endif 226703d69a68Sdrh 226803d69a68Sdrh 2269ec95c441Sdrh /* Does the table have a rowid */ 2270ec95c441Sdrh #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0) 2271fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0) 2272ec95c441Sdrh 22734cbdda9eSdrh /* 2274c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 2275c2eef3b3Sdrh ** 2276c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 2277c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 2278c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 2279c2eef3b3Sdrh ** Consider this example: 2280c2eef3b3Sdrh ** 2281c2eef3b3Sdrh ** CREATE TABLE ex1( 2282c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 2283c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 2284c2eef3b3Sdrh ** ); 2285c2eef3b3Sdrh ** 2286c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 2287bd50a926Sdrh ** Equivalent names: 2288bd50a926Sdrh ** 2289bd50a926Sdrh ** from-table == child-table 2290bd50a926Sdrh ** to-table == parent-table 2291c2eef3b3Sdrh ** 2292c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 2293c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 2294e61922a6Sdrh ** the from-table is created. The existence of the to-table is not checked. 2295bd50a926Sdrh ** 2296bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey. 2297bd50a926Sdrh ** 2298bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist) 2299bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z. 2300c2eef3b3Sdrh */ 2301c2eef3b3Sdrh struct FKey { 23021f638cebSdrh Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 2303bd50a926Sdrh FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */ 23041f638cebSdrh char *zTo; /* Name of table that the key points to (aka: Parent) */ 2305bd50a926Sdrh FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */ 2306bd50a926Sdrh FKey *pPrevTo; /* Previous with the same zTo */ 2307c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 23084c429839Sdrh /* EV: R-30323-21917 */ 2309c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 23108099ce6fSdan u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 23118099ce6fSdan Trigger *apTrigger[2];/* Triggers for aAction[] actions */ 2312e61922a6Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 2313e61922a6Sdrh int iFrom; /* Index of column in pFrom */ 2314bd50a926Sdrh char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */ 2315e61922a6Sdrh } aCol[1]; /* One entry for each of nCol columns */ 2316c2eef3b3Sdrh }; 2317c2eef3b3Sdrh 2318c2eef3b3Sdrh /* 2319aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint 232022f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 23210bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 23221c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 23231c92853dSdrh ** fails and any prior changes from that one operation are backed out, 23241c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 23251c92853dSdrh ** the operation in progress stops and returns an error code. But prior 23261c92853dSdrh ** changes due to the same operation are not backed out and no rollback 23271c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 23281c92853dSdrh ** error is not inserted or updated. Processing continues and no error 23291c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 23301c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 23311c92853dSdrh ** update can proceed. Processing continues and no error is reported. 23325602777eSdrh ** UPDATE applies to insert operations only and means that the insert 23335602777eSdrh ** is omitted and the DO UPDATE clause of an upsert is run instead. 23341c92853dSdrh ** 23355602777eSdrh ** RESTRICT, SETNULL, SETDFLT, and CASCADE actions apply only to foreign keys. 2336c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 2337c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 23385602777eSdrh ** key is set to NULL. SETDFLT means that the foreign key is set 23395602777eSdrh ** to its default value. CASCADE means that a DELETE or UPDATE of the 2340c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 2341c2eef3b3Sdrh ** foreign key. 2342c2eef3b3Sdrh ** 23435602777eSdrh ** The OE_Default value is a place holder that means to use whatever 23445602777eSdrh ** conflict resolution algorthm is required from context. 23455602777eSdrh ** 2346968af52aSdrh ** The following symbolic values are used to record which type 23475602777eSdrh ** of conflict resolution action to take. 23489cfcf5d4Sdrh */ 23499cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 23501c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 23511c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 23521c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 23531c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 23541c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 2355c8a0c90bSdrh #define OE_Update 6 /* Process as a DO UPDATE in an upsert */ 2356c8a0c90bSdrh #define OE_Restrict 7 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 2357c8a0c90bSdrh #define OE_SetNull 8 /* Set the foreign key value to NULL */ 2358c8a0c90bSdrh #define OE_SetDflt 9 /* Set the foreign key value to its default */ 2359c8a0c90bSdrh #define OE_Cascade 10 /* Cascade the changes */ 2360c8a0c90bSdrh #define OE_Default 11 /* Do whatever the default action is */ 23619cfcf5d4Sdrh 2362d3d39e93Sdrh 2363d3d39e93Sdrh /* 2364d3d39e93Sdrh ** An instance of the following structure is passed as the first 2365d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the 2366d3d39e93Sdrh ** comparison of the two index keys. 2367323df790Sdrh ** 2368323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots. There 2369323df790Sdrh ** are nField slots for the columns of an index then one extra slot 2370323df790Sdrh ** for the rowid at the end. 2371d3d39e93Sdrh */ 2372d3d39e93Sdrh struct KeyInfo { 23732ec2fb22Sdrh u32 nRef; /* Number of references to this KeyInfo object */ 23749b8d0272Sdrh u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 2375a485ad19Sdrh u16 nKeyField; /* Number of key columns in the index */ 2376a485ad19Sdrh u16 nAllField; /* Total columns, including key plus others */ 23772ec2fb22Sdrh sqlite3 *db; /* The database connection */ 23786e11892dSdan u8 *aSortFlags; /* Sort order for each column. */ 2379d3d39e93Sdrh CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 2380d3d39e93Sdrh }; 2381d3d39e93Sdrh 2382905d4729Sdrh /* 2383905d4729Sdrh ** Allowed bit values for entries in the KeyInfo.aSortFlags[] array. 2384905d4729Sdrh */ 2385905d4729Sdrh #define KEYINFO_ORDER_DESC 0x01 /* DESC sort order */ 2386905d4729Sdrh #define KEYINFO_ORDER_BIGNULL 0x02 /* NULL is larger than any other value */ 23876e11892dSdan 23889cfcf5d4Sdrh /* 2389b1d607deSdrh ** This object holds a record which has been parsed out into individual 2390b1d607deSdrh ** fields, for the purposes of doing a comparison. 2391e63d9991Sdrh ** 2392e63d9991Sdrh ** A record is an object that contains one or more fields of data. 2393e63d9991Sdrh ** Records are used to store the content of a table row and to store 2394e63d9991Sdrh ** the key of an index. A blob encoding of a record is created by 2395467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 2396e63d9991Sdrh ** OP_Column opcode. 2397e63d9991Sdrh ** 2398b1d607deSdrh ** An instance of this object serves as a "key" for doing a search on 2399b1d607deSdrh ** an index b+tree. The goal of the search is to find the entry that 2400b1d607deSdrh ** is closed to the key described by this object. This object might hold 2401b1d607deSdrh ** just a prefix of the key. The number of fields is given by 2402b1d607deSdrh ** pKeyInfo->nField. 24033833e934Sdan ** 2404b1d607deSdrh ** The r1 and r2 fields are the values to return if this key is less than 2405b1d607deSdrh ** or greater than a key in the btree, respectively. These are normally 2406b1d607deSdrh ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree 2407b1d607deSdrh ** is in DESC order. 2408b1d607deSdrh ** 2409b1d607deSdrh ** The key comparison functions actually return default_rc when they find 2410b1d607deSdrh ** an equals comparison. default_rc can be -1, 0, or +1. If there are 2411b1d607deSdrh ** multiple entries in the b-tree with the same key (when only looking 2412b1d607deSdrh ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to 2413b1d607deSdrh ** cause the search to find the last match, or +1 to cause the search to 2414b1d607deSdrh ** find the first match. 2415b1d607deSdrh ** 2416b1d607deSdrh ** The key comparison functions will set eqSeen to true if they ever 2417b1d607deSdrh ** get and equal results when comparing this structure to a b-tree record. 2418b1d607deSdrh ** When default_rc!=0, the search might end up on the record immediately 2419b1d607deSdrh ** before the first match or immediately after the last match. The 2420b1d607deSdrh ** eqSeen field will indicate whether or not an exact match exists in the 2421b1d607deSdrh ** b-tree. 2422e63d9991Sdrh */ 2423e63d9991Sdrh struct UnpackedRecord { 2424e63d9991Sdrh KeyInfo *pKeyInfo; /* Collation and sort-order information */ 242570528d78Sdrh Mem *aMem; /* Values */ 2426e63d9991Sdrh u16 nField; /* Number of entries in apMem[] */ 2427a9e0aeb5Sdrh i8 default_rc; /* Comparison result if keys are equal */ 242838fdead8Sdan u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */ 242961ffb2cdSdrh i8 r1; /* Value to return if (lhs < rhs) */ 243061ffb2cdSdrh i8 r2; /* Value to return if (lhs > rhs) */ 243170528d78Sdrh u8 eqSeen; /* True if an equality comparison has been seen */ 2432e63d9991Sdrh }; 2433e63d9991Sdrh 2434e63d9991Sdrh 2435e63d9991Sdrh /* 243666b89c8fSdrh ** Each SQL index is represented in memory by an 243775897234Sdrh ** instance of the following structure. 2438967e8b73Sdrh ** 2439967e8b73Sdrh ** The columns of the table that are to be indexed are described 2440967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 2441967e8b73Sdrh ** we have the following table and index: 2442967e8b73Sdrh ** 2443967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 2444967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 2445967e8b73Sdrh ** 2446967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 2447967e8b73Sdrh ** three columns in the table. In the Index structure describing 2448967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 2449967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 2450967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 2451967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 2452967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 2453ea1ba17cSdrh ** 2454ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 2455ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 2456ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 2457ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 2458ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 2459ea1ba17cSdrh ** element. 2460c5b73585Sdan ** 2461c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to 2462ccb2113aSdrh ** generate VDBE code (as opposed to parsing one read from an sqlite_schema 2463c5b73585Sdan ** table as part of parsing an existing database schema), transient instances 2464c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is 2465c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page 2466c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE 2467c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details. 246875897234Sdrh */ 246975897234Sdrh struct Index { 247075897234Sdrh char *zName; /* Name of this index */ 2471bbbdc83bSdrh i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */ 2472cfc9df76Sdan LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */ 2473967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 2474a37cdde0Sdanielk1977 char *zColAff; /* String defining the affinity of each column */ 247575897234Sdrh Index *pNext; /* The next index associated with the same table */ 2476b3bf556eSdanielk1977 Schema *pSchema; /* Schema containing this index */ 2477b376daebSdrh u8 *aSortOrder; /* for each column: True==DESC, False==ASC */ 2478f19aa5faSdrh const char **azColl; /* Array of collation sequence names for index */ 24791fe0537eSdrh Expr *pPartIdxWhere; /* WHERE clause for partial indices */ 24801f9ca2c8Sdrh ExprList *aColExpr; /* Column expressions */ 2481abc38158Sdrh Pgno tnum; /* DB Page containing root of this index */ 2482bf539c4dSdrh LogEst szIdxRow; /* Estimated average row size in bytes */ 2483bbbdc83bSdrh u16 nKeyCol; /* Number of columns forming the key */ 2484bbbdc83bSdrh u16 nColumn; /* Number of columns stored in the index */ 2485bf539c4dSdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 24865f913ecbSdrh unsigned idxType:2; /* 0:Normal 1:UNIQUE, 2:PRIMARY KEY, 3:IPK */ 2487b376daebSdrh unsigned bUnordered:1; /* Use this index for == or IN queries only */ 24887699d1c4Sdrh unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */ 24897f9c5dbfSdrh unsigned isResized:1; /* True if resizeIndexObject() has been called */ 2490ec95c441Sdrh unsigned isCovering:1; /* True if this is a covering index */ 2491f9df2fbdSdrh unsigned noSkipScan:1; /* Do not try to use skip-scan if true */ 2492a3928dd7Sdrh unsigned hasStat1:1; /* aiRowLogEst values come from sqlite_stat1 */ 24937e8515d8Sdrh unsigned bNoQuery:1; /* Do not use this index to optimize queries */ 2494bf9ff256Sdrh unsigned bAscKeyBug:1; /* True if the bba7b69f9849b5bf bug applies */ 2495c7476735Sdrh unsigned bHasVCol:1; /* Index references one or more VIRTUAL columns */ 2496175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 24972b9cf669Sdrh int nSample; /* Number of elements in aSample[] */ 24988ad169abSdan int nSampleCol; /* Size of IndexSample.anEq[] and so on */ 2499eea568d6Sdan tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */ 2500faacf17cSdrh IndexSample *aSample; /* Samples of the left-most key */ 25019f07cf7bSdrh tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */ 25029f07cf7bSdrh tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */ 2503faacf17cSdrh #endif 25041fe3ac73Sdrh Bitmask colNotIdxed; /* 0 for unindexed columns in pTab */ 250502fa4696Sdan }; 250602fa4696Sdan 250702fa4696Sdan /* 250848dd1d8eSdrh ** Allowed values for Index.idxType 250948dd1d8eSdrh */ 251048dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */ 251148dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */ 251248dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */ 25135f913ecbSdrh #define SQLITE_IDXTYPE_IPK 3 /* INTEGER PRIMARY KEY index */ 251448dd1d8eSdrh 251548dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */ 251648dd1d8eSdrh #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY) 251748dd1d8eSdrh 25185f1d1d9cSdrh /* Return true if index X is a UNIQUE index */ 25195f1d1d9cSdrh #define IsUniqueIndex(X) ((X)->onError!=OE_None) 25205f1d1d9cSdrh 25214b92f98cSdrh /* The Index.aiColumn[] values are normally positive integer. But 25224b92f98cSdrh ** there are some negative values that have special meaning: 25234b92f98cSdrh */ 25244b92f98cSdrh #define XN_ROWID (-1) /* Indexed column is the rowid */ 25254b92f98cSdrh #define XN_EXPR (-2) /* Indexed column is an expression */ 25264b92f98cSdrh 252748dd1d8eSdrh /* 2528175b8f06Sdrh ** Each sample stored in the sqlite_stat4 table is represented in memory 252974e7c8f5Sdrh ** using a structure of this type. See documentation at the top of the 253074e7c8f5Sdrh ** analyze.c source file for additional information. 253102fa4696Sdan */ 253202fa4696Sdan struct IndexSample { 2533f52bb8d3Sdan void *p; /* Pointer to sampled record */ 2534f52bb8d3Sdan int n; /* Size of record in bytes */ 2535f52bb8d3Sdan tRowcnt *anEq; /* Est. number of rows where the key equals this sample */ 2536f52bb8d3Sdan tRowcnt *anLt; /* Est. number of rows where key is less than this sample */ 2537f52bb8d3Sdan tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */ 253875897234Sdrh }; 253975897234Sdrh 254075897234Sdrh /* 25418bee11a4Smistachkin ** Possible values to use within the flags argument to sqlite3GetToken(). 25428bee11a4Smistachkin */ 25438bee11a4Smistachkin #define SQLITE_TOKEN_QUOTED 0x1 /* Token is a quoted identifier. */ 25448bee11a4Smistachkin #define SQLITE_TOKEN_KEYWORD 0x2 /* Token is a keyword. */ 25458bee11a4Smistachkin 25468bee11a4Smistachkin /* 254775897234Sdrh ** Each token coming out of the lexer is an instance of 25484b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 25494efc4754Sdrh ** 25504a2c747cSdrh ** The memory that "z" points to is owned by other objects. Take care 25514a2c747cSdrh ** that the owner of the "z" string does not deallocate the string before 25524a2c747cSdrh ** the Token goes out of scope! Very often, the "z" points to some place 25534a2c747cSdrh ** in the middle of the Parse.zSql text. But it might also point to a 25544a2c747cSdrh ** static string. 255575897234Sdrh */ 255675897234Sdrh struct Token { 2557b7916a78Sdrh const char *z; /* Text of the token. Not NULL-terminated! */ 2558b7916a78Sdrh unsigned int n; /* Number of characters in this token */ 255975897234Sdrh }; 256075897234Sdrh 256175897234Sdrh /* 256213449892Sdrh ** An instance of this structure contains information needed to generate 256313449892Sdrh ** code for a SELECT that contains aggregate functions. 256413449892Sdrh ** 256513449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 256616dc07f7Sdrh ** pointer to this structure. The Expr.iAgg field is the index in 256713449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 256813449892Sdrh ** code for that node. 256913449892Sdrh ** 257013449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 257113449892Sdrh ** original Select structure that describes the SELECT statement. These 257213449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure. 257313449892Sdrh */ 257413449892Sdrh struct AggInfo { 257513449892Sdrh u8 directMode; /* Direct rendering mode means take data directly 257613449892Sdrh ** from source tables rather than from accumulators */ 257713449892Sdrh u8 useSortingIdx; /* In direct mode, reference the sorting index rather 257813449892Sdrh ** than the source table */ 257913449892Sdrh int sortingIdx; /* Cursor number of the sorting index */ 25805134d135Sdan int sortingIdxPTab; /* Cursor number of pseudo-table */ 258113449892Sdrh int nSortingColumn; /* Number of columns in the sorting index */ 25827e61d18eSdrh int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */ 2583a451017dSdrh ExprList *pGroupBy; /* The group by clause */ 258413449892Sdrh struct AggInfo_col { /* For each column used in source tables */ 25850817d0dfSdanielk1977 Table *pTab; /* Source table */ 258681185a51Sdrh Expr *pCExpr; /* The original expression */ 258713449892Sdrh int iTable; /* Cursor number of the source table */ 258813449892Sdrh int iMem; /* Memory location that acts as accumulator */ 258989636628Sdrh i16 iColumn; /* Column number within the source table */ 259089636628Sdrh i16 iSorterColumn; /* Column number in the sorting index */ 259113449892Sdrh } *aCol; 259213449892Sdrh int nColumn; /* Number of used entries in aCol[] */ 259313449892Sdrh int nAccumulator; /* Number of columns that show through to the output. 259413449892Sdrh ** Additional columns are used only as parameters to 259513449892Sdrh ** aggregate functions */ 259613449892Sdrh struct AggInfo_func { /* For each aggregate function */ 259781185a51Sdrh Expr *pFExpr; /* Expression encoding the function */ 259813449892Sdrh FuncDef *pFunc; /* The aggregate function implementation */ 259913449892Sdrh int iMem; /* Memory location that acts as accumulator */ 2600467bcf36Sshane int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 260113449892Sdrh } *aFunc; 260213449892Sdrh int nFunc; /* Number of entries in aFunc[] */ 2603e26d428aSdrh u32 selId; /* Select to which this AggInfo belongs */ 260413449892Sdrh }; 260513449892Sdrh 260613449892Sdrh /* 26078677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 26088677d308Sdrh ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 26098677d308Sdrh ** than 32767 we have to make it 32-bit. 16-bit is preferred because 26108677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user 26118677d308Sdrh ** in systems with lots of prepared statements. And few applications 26128677d308Sdrh ** need more than about 10 or 20 variables. But some extreme users want 2613efdba1a8Sdrh ** to have prepared statements with over 32766 variables, and for them 26148677d308Sdrh ** the option is available (at compile-time). 26158677d308Sdrh */ 2616efdba1a8Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<32767 2617481aa74eSdrh typedef i16 ynVar; 26188677d308Sdrh #else 26198677d308Sdrh typedef int ynVar; 26208677d308Sdrh #endif 26218677d308Sdrh 26228677d308Sdrh /* 262375897234Sdrh ** Each node of an expression in the parse tree is an instance 262422f70c32Sdrh ** of this structure. 262522f70c32Sdrh ** 262622f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 262722f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 262822f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 262922f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 263022f70c32Sdrh ** tree. 263122f70c32Sdrh ** 26326ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 26336ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 26346ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 26356ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 26366ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function. 263722f70c32Sdrh ** 26386ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 26396ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL. 26406ab3a2ecSdanielk1977 ** 26416ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 26426ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 26436ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 26446ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 26456ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 26466ab3a2ecSdanielk1977 ** valid. 264722f70c32Sdrh ** 264822f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 264922f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 265022f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 265122f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 265222f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 265322f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 265422f70c32Sdrh ** it can be accessed after all aggregates are computed. 265522f70c32Sdrh ** 26566ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark 26576ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index 26586ab3a2ecSdanielk1977 ** number for that variable. 265922f70c32Sdrh ** 26601398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer 26611398ad36Sdrh ** register number containing the result of the subquery. If the 26621398ad36Sdrh ** subquery gives a constant result, then iTable is -1. If the subquery 26631398ad36Sdrh ** gives a different answer at different times during statement processing 26641398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery. 26651398ad36Sdrh ** 2666aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from 2667aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 2668aee18ef8Sdanielk1977 ** corresponding table definition. 26696ab3a2ecSdanielk1977 ** 26706ab3a2ecSdanielk1977 ** ALLOCATION NOTES: 26716ab3a2ecSdanielk1977 ** 267212ffee8cSdrh ** Expr objects can use a lot of memory space in database schema. To 267312ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be 267412ffee8cSdrh ** truncated. And to reduce the number of memory allocations, sometimes 267512ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation, 267633e619fcSdrh ** together with Expr.zToken strings. 26776ab3a2ecSdanielk1977 ** 2678b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when 267912ffee8cSdrh ** an Expr object is truncated. When EP_Reduced is set, then all 268012ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 268112ffee8cSdrh ** are contained within the same memory allocation. Note, however, that 268212ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 268312ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set. 268475897234Sdrh */ 268575897234Sdrh struct Expr { 26861cc093c2Sdrh u8 op; /* Operation performed by this node */ 26871194904bSdrh char affExpr; /* affinity, or RAISE type */ 268820cee7d0Sdrh u8 op2; /* TK_REGISTER/TK_TRUTH: original value of Expr.op 268920cee7d0Sdrh ** TK_COLUMN: the value of p5 for OP_Column 269020cee7d0Sdrh ** TK_AGG_FUNCTION: nesting depth 269120cee7d0Sdrh ** TK_FUNCTION: NC_SelfRef flag if needs OP_PureFunc */ 2692e7375bfaSdrh #ifdef SQLITE_DEBUG 2693e7375bfaSdrh u8 vvaFlags; /* Verification flags. */ 2694e7375bfaSdrh #endif 2695c5cd1249Sdrh u32 flags; /* Various flags. EP_* See below */ 269633e619fcSdrh union { 2697b7916a78Sdrh char *zToken; /* Token value. Zero terminated and dequoted */ 2698d50ffc41Sdrh int iValue; /* Non-negative integer value if EP_IntValue */ 269933e619fcSdrh } u; 27006ab3a2ecSdanielk1977 27016ab3a2ecSdanielk1977 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 27026ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27036ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27046ab3a2ecSdanielk1977 *********************************************************************/ 27056ab3a2ecSdanielk1977 27066ab3a2ecSdanielk1977 Expr *pLeft; /* Left subnode */ 27076ab3a2ecSdanielk1977 Expr *pRight; /* Right subnode */ 27086ab3a2ecSdanielk1977 union { 2709c5cd1249Sdrh ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */ 2710c5cd1249Sdrh Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */ 27116ab3a2ecSdanielk1977 } x; 27126ab3a2ecSdanielk1977 27136ab3a2ecSdanielk1977 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 27146ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27156ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27166ab3a2ecSdanielk1977 *********************************************************************/ 27176ab3a2ecSdanielk1977 27186ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0 27196ec65491Sdrh int nHeight; /* Height of the tree headed by this node */ 27206ec65491Sdrh #endif 2721b7916a78Sdrh int iTable; /* TK_COLUMN: cursor number of table holding column 27222832ad42Sdan ** TK_REGISTER: register number 2723cca9f3d2Sdrh ** TK_TRIGGER: 1 -> new, 0 -> old 2724fc7f27b9Sdrh ** EP_Unlikely: 134217728 times likelihood 2725818a3b54Sdrh ** TK_IN: ephemerial table holding RHS 2726554a9dc7Sdrh ** TK_SELECT_COLUMN: Number of columns on the LHS 2727fc7f27b9Sdrh ** TK_SELECT: 1st register of result vector */ 27288677d308Sdrh ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 2729fc7f27b9Sdrh ** TK_VARIABLE: variable number (always >= 1). 2730fc7f27b9Sdrh ** TK_SELECT_COLUMN: column of the result vector */ 2731b7916a78Sdrh i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 2732961a7260Sdan int iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 273313449892Sdrh AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 2734eda079cdSdrh union { 2735eda079cdSdrh Table *pTab; /* TK_COLUMN: Table containing column. Can be NULL 27364dd89d5aSdrh ** for a column of an index on an expression */ 27374f9adee2Sdan Window *pWin; /* EP_WinFunc: Window/Filter defn for a function */ 27382c04131cSdrh struct { /* TK_IN, TK_SELECT, and TK_EXISTS */ 27392c04131cSdrh int iAddr; /* Subroutine entry address */ 27402c04131cSdrh int regReturn; /* Register used to hold return address */ 27412c04131cSdrh } sub; 2742eda079cdSdrh } y; 274375897234Sdrh }; 274475897234Sdrh 274575897234Sdrh /* 27461f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 2747d137f4e6Sdrh ** Value restrictions: 2748d137f4e6Sdrh ** 2749d137f4e6Sdrh ** EP_Agg == NC_HasAgg == SF_HasAgg 2750d137f4e6Sdrh ** EP_Win == NC_HasWin 27511f16230bSdrh */ 275272673a24Sdrh #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */ 2753d137f4e6Sdrh #define EP_Distinct 0x000002 /* Aggregate function with DISTINCT keyword */ 2754fca23557Sdrh #define EP_HasFunc 0x000004 /* Contains one or more functions of any kind */ 2755efad2e23Sdrh #define EP_FixedCol 0x000008 /* TK_Column with a known fixed value */ 2756d137f4e6Sdrh #define EP_Agg 0x000010 /* Contains one or more aggregate functions */ 2757c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */ 2758c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */ 2759c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */ 2760fbb24d10Sdrh #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */ 2761898c527eSdrh #define EP_Commuted 0x000200 /* Comparison operator has been commuted */ 2762c5cd1249Sdrh #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */ 2763c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */ 2764a7d6db6aSdrh #define EP_Skip 0x001000 /* Operator does not contribute to affinity */ 2765c5cd1249Sdrh #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */ 2766c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */ 2767d137f4e6Sdrh #define EP_Win 0x008000 /* Contains window functions */ 2768c5cd1249Sdrh #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */ 276946fe138dSdrh #define EP_IfNullRow 0x020000 /* The TK_IF_NULL_ROW opcode */ 2770a4c3c87eSdrh #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */ 2771a7f910b5Sdrh #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */ 277272673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */ 2773885a5b03Sdrh #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */ 277429f6a365Sdrh /* 0x400000 // Available */ 2775209bc522Sdrh #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */ 2776eda079cdSdrh #define EP_WinFunc 0x1000000 /* TK_FUNCTION with Expr.y.pWin set */ 27772c04131cSdrh #define EP_Subrtn 0x2000000 /* Uses Expr.y.sub. TK_IN, _SELECT, or _EXISTS */ 277851d35b0fSdrh #define EP_Quoted 0x4000000 /* TK_ID was originally quoted */ 2779d137f4e6Sdrh #define EP_Static 0x8000000 /* Held in memory not obtained from malloc() */ 2780ad31727fSdrh #define EP_IsTrue 0x10000000 /* Always has boolean value of TRUE */ 2781ad31727fSdrh #define EP_IsFalse 0x20000000 /* Always has boolean value of FALSE */ 2782ccb2113aSdrh #define EP_FromDDL 0x40000000 /* Originates from sqlite_schema */ 2783e7375bfaSdrh /* 0x80000000 // Available */ 2784885a5b03Sdrh 2785885a5b03Sdrh /* 2786fca23557Sdrh ** The EP_Propagate mask is a set of properties that automatically propagate 2787fca23557Sdrh ** upwards into parent nodes. 2788885a5b03Sdrh */ 2789fca23557Sdrh #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc) 279033e619fcSdrh 279133e619fcSdrh /* 27921f16230bSdrh ** These macros can be used to test, set, or clear bits in the 27931f16230bSdrh ** Expr.flags field. 27941f16230bSdrh */ 2795c5cd1249Sdrh #define ExprHasProperty(E,P) (((E)->flags&(P))!=0) 2796c5cd1249Sdrh #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P)) 27971f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 27981f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 2799ad31727fSdrh #define ExprAlwaysTrue(E) (((E)->flags&(EP_FromJoin|EP_IsTrue))==EP_IsTrue) 2800ad31727fSdrh #define ExprAlwaysFalse(E) (((E)->flags&(EP_FromJoin|EP_IsFalse))==EP_IsFalse) 28011f16230bSdrh 2802e7375bfaSdrh 2803e7375bfaSdrh /* Flags for use with Expr.vvaFlags 2804e7375bfaSdrh */ 2805e7375bfaSdrh #define EP_NoReduce 0x01 /* Cannot EXPRDUP_REDUCE this Expr */ 2806e7375bfaSdrh #define EP_Immutable 0x02 /* Do not change this Expr node */ 2807e7375bfaSdrh 2808ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation, 2809ebb6a65dSdrh ** and Accreditation only. It works like ExprSetProperty() during VVA 2810ebb6a65dSdrh ** processes but is a no-op for delivery. 2811ebb6a65dSdrh */ 2812ebb6a65dSdrh #ifdef SQLITE_DEBUG 2813e7375bfaSdrh # define ExprSetVVAProperty(E,P) (E)->vvaFlags|=(P) 2814e7375bfaSdrh # define ExprHasVVAProperty(E,P) (((E)->vvaFlags&(P))!=0) 2815e7375bfaSdrh # define ExprClearVVAProperties(E) (E)->vvaFlags = 0 2816ebb6a65dSdrh #else 2817ebb6a65dSdrh # define ExprSetVVAProperty(E,P) 2818e7375bfaSdrh # define ExprHasVVAProperty(E,P) 0 2819e7375bfaSdrh # define ExprClearVVAProperties(E) 2820ebb6a65dSdrh #endif 2821ebb6a65dSdrh 28221f16230bSdrh /* 28236ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr 28246ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 28256ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set. 28266ab3a2ecSdanielk1977 */ 282712ffee8cSdrh #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 282812ffee8cSdrh #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 2829b7916a78Sdrh #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 28306ab3a2ecSdanielk1977 28316ab3a2ecSdanielk1977 /* 28326ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment 28336ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details. 28346ab3a2ecSdanielk1977 */ 283512ffee8cSdrh #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 28366ab3a2ecSdanielk1977 28376ab3a2ecSdanielk1977 /* 28384f9adee2Sdan ** True if the expression passed as an argument was a function with 28394f9adee2Sdan ** an OVER() clause (a window function). 28404f9adee2Sdan */ 28413703edf1Sdan #ifdef SQLITE_OMIT_WINDOWFUNC 28423703edf1Sdan # define IsWindowFunc(p) 0 28433703edf1Sdan #else 28444f9adee2Sdan # define IsWindowFunc(p) ( \ 28454f9adee2Sdan ExprHasProperty((p), EP_WinFunc) && p->y.pWin->eFrmType!=TK_FILTER \ 28464f9adee2Sdan ) 28473703edf1Sdan #endif 28484f9adee2Sdan 28494f9adee2Sdan /* 285075897234Sdrh ** A list of expressions. Each expression may optionally have a 285175897234Sdrh ** name. An expr/name combination can be used in several ways, such 285275897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 285375897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 2854ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 285575897234Sdrh ** field is not used. 28560dde4739Sdrh ** 2857cbb9da33Sdrh ** In order to try to keep memory usage down, the Expr.a.zEName field 2858cbb9da33Sdrh ** is used for multiple purposes: 2859cbb9da33Sdrh ** 2860c4938ea2Sdrh ** eEName Usage 2861c4938ea2Sdrh ** ---------- ------------------------- 2862c4938ea2Sdrh ** ENAME_NAME (1) the AS of result set column 2863cbb9da33Sdrh ** (2) COLUMN= of an UPDATE 2864cbb9da33Sdrh ** 2865c4938ea2Sdrh ** ENAME_TAB DB.TABLE.NAME used to resolve names 2866cbb9da33Sdrh ** of subqueries 2867cbb9da33Sdrh ** 2868c4938ea2Sdrh ** ENAME_SPAN Text of the original result set 2869cbb9da33Sdrh ** expression. 287075897234Sdrh */ 287175897234Sdrh struct ExprList { 287275897234Sdrh int nExpr; /* Number of expressions on the list */ 2873d872bb18Sdrh struct ExprList_item { /* For each expression in the list */ 2874c5f4816fSdrh Expr *pExpr; /* The parse tree for this expression */ 287541cee668Sdrh char *zEName; /* Token associated with this expression */ 28769105fd51Sdan u8 sortFlags; /* Mask of KEYINFO_ORDER_* flags */ 2877cbb9da33Sdrh unsigned eEName :2; /* Meaning of zEName */ 28780dde4739Sdrh unsigned done :1; /* A flag to indicate when processing is finished */ 2879d673cddaSdrh unsigned reusable :1; /* Constant expression is reusable */ 288024e25d32Sdan unsigned bSorterRef :1; /* Defer evaluation until after sorting */ 28819105fd51Sdan unsigned bNulls: 1; /* True if explicit "NULLS FIRST/LAST" */ 2882c2acc4e4Sdrh union { 2883c2acc4e4Sdrh struct { 28844b3ac73cSdrh u16 iOrderByCol; /* For ORDER BY, column number in result set */ 28858b213899Sdrh u16 iAlias; /* Index into Parse.aAlias[] for zName */ 2886c2acc4e4Sdrh } x; 2887c2acc4e4Sdrh int iConstExprReg; /* Register in which Expr value is cached */ 2888c2acc4e4Sdrh } u; 288943606175Sdrh } a[1]; /* One slot for each expression in the list */ 289075897234Sdrh }; 289175897234Sdrh 289275897234Sdrh /* 2893cbb9da33Sdrh ** Allowed values for Expr.a.eEName 2894cbb9da33Sdrh */ 2895cbb9da33Sdrh #define ENAME_NAME 0 /* The AS clause of a result set */ 2896cbb9da33Sdrh #define ENAME_SPAN 1 /* Complete text of the result set expression */ 2897cbb9da33Sdrh #define ENAME_TAB 2 /* "DB.TABLE.NAME" for the result set */ 2898cbb9da33Sdrh 2899cbb9da33Sdrh /* 2900ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 2901ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 2902ad3cab52Sdrh ** 2903ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 2904ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 2905ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 2906ad3cab52Sdrh ** 2907ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 2908ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 2909ad3cab52Sdrh ** 2910ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 2911ad3cab52Sdrh ** 2912ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 291375897234Sdrh */ 291475897234Sdrh struct IdList { 29156d4abfbeSdrh struct IdList_item { 2916ad3cab52Sdrh char *zName; /* Name of the identifier */ 2917967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 2918ad3cab52Sdrh } *a; 291913449892Sdrh int nId; /* Number of identifiers on the list */ 2920ad3cab52Sdrh }; 2921ad3cab52Sdrh 2922ad3cab52Sdrh /* 29237601294aSdrh ** The SrcItem object represents a single term in the FROM clause of a query. 29247601294aSdrh ** The SrcList object is mostly an array of SrcItems. 2925ad3cab52Sdrh */ 29267601294aSdrh struct SrcItem { 292741fb5cd1Sdan Schema *pSchema; /* Schema to which this item is fixed */ 2928113088ecSdrh char *zDatabase; /* Name of database holding this table */ 2929ad3cab52Sdrh char *zName; /* Name of the table */ 2930ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 2931daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 2932daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 29335b6a9ed4Sdrh int addrFillSub; /* Address of subroutine to manifest a subquery */ 29345b6a9ed4Sdrh int regReturn; /* Register holding return address of addrFillSub */ 29355f612295Sdrh int regResult; /* Registers holding results of a co-routine */ 29368a48b9c0Sdrh struct { 29376b922881Sdrh u8 jointype; /* Type of join between this table and the previous */ 293821172c4cSdrh unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */ 29398a48b9c0Sdrh unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */ 29408a48b9c0Sdrh unsigned isTabFunc :1; /* True if table-valued-function syntax */ 294121172c4cSdrh unsigned isCorrelated :1; /* True if sub-query is correlated */ 294221172c4cSdrh unsigned viaCoroutine :1; /* Implemented as a co-routine */ 2943f43fe6e9Sdan unsigned isRecursive :1; /* True for recursive reference in WITH */ 2944ccb2113aSdrh unsigned fromDDL :1; /* Comes from sqlite_schema */ 2945*a79e2a2dSdrh unsigned isCte :1; /* This is a CTE */ 29468a48b9c0Sdrh } fg; 2947e68fbe79Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 2948ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 2949ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 2950cd38d520Sdanielk1977 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 29518a48b9c0Sdrh union { 2952d62fbb50Sdrh char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */ 29538a48b9c0Sdrh ExprList *pFuncArg; /* Arguments to table-valued-function */ 29548a48b9c0Sdrh } u1; 2955*a79e2a2dSdrh union { 29568a48b9c0Sdrh Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */ 2957*a79e2a2dSdrh CteUse *pCteUse; /* CTE Usage info info fg.isCte is true */ 2958*a79e2a2dSdrh } u2; 29597601294aSdrh }; 29607601294aSdrh 29617601294aSdrh /* 29627601294aSdrh ** The following structure describes the FROM clause of a SELECT statement. 29637601294aSdrh ** Each table or subquery in the FROM clause is a separate element of 29647601294aSdrh ** the SrcList.a[] array. 29657601294aSdrh ** 29667601294aSdrh ** With the addition of multiple database support, the following structure 29677601294aSdrh ** can also be used to describe a particular table such as the table that 29687601294aSdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 29697601294aSdrh ** such a table must be a simple name: ID. But in SQLite, the table can 29707601294aSdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 29717601294aSdrh ** 29727601294aSdrh ** The jointype starts out showing the join type between the current table 29737601294aSdrh ** and the next table on the list. The parser builds the list this way. 29747601294aSdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 29757601294aSdrh ** jointype expresses the join between the table and the previous table. 29767601294aSdrh ** 29777601294aSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table 29787601294aSdrh ** contains more than 63 columns and the 64-th or later column is used. 29797601294aSdrh */ 29807601294aSdrh struct SrcList { 29817601294aSdrh int nSrc; /* Number of tables or subqueries in the FROM clause */ 29827601294aSdrh u32 nAlloc; /* Number of entries allocated in a[] below */ 29837601294aSdrh SrcItem a[1]; /* One entry for each identifier on the list */ 298475897234Sdrh }; 298575897234Sdrh 298675897234Sdrh /* 298701f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 298801f3f253Sdrh */ 298901f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 29903dec223cSdrh #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 29913dec223cSdrh #define JT_NATURAL 0x0004 /* True for a "natural" join */ 29923dec223cSdrh #define JT_LEFT 0x0008 /* Left outer join */ 29933dec223cSdrh #define JT_RIGHT 0x0010 /* Right outer join */ 29943dec223cSdrh #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 29953dec223cSdrh #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 299601f3f253Sdrh 2997111a6a7dSdrh 2998111a6a7dSdrh /* 2999336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 3000336a5300Sdrh ** and the WhereInfo.wctrlFlags member. 300149711600Sdrh ** 300249711600Sdrh ** Value constraints (enforced via assert()): 300349711600Sdrh ** WHERE_USE_LIMIT == SF_FixedLimit 300408c88eb0Sdrh */ 30056df2acd2Sdrh #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 30066df2acd2Sdrh #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 30076df2acd2Sdrh #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 30086df2acd2Sdrh #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 3009ce943bc8Sdrh #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */ 3010ce943bc8Sdrh #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */ 3011bc5eac00Sdrh #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of 3012bc5eac00Sdrh ** the OR optimization */ 3013ce943bc8Sdrh #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */ 3014ce943bc8Sdrh #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */ 3015ce943bc8Sdrh #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */ 3016ce943bc8Sdrh #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */ 301768c0c710Sdrh /* 0x0400 not currently used */ 3018d711e522Sdrh #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */ 301968c0c710Sdrh /* 0x1000 not currently used */ 3020ce943bc8Sdrh /* 0x2000 not currently used */ 3021bc5eac00Sdrh #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */ 3022ce943bc8Sdrh /* 0x8000 not currently used */ 3023a9d1ccb9Sdanielk1977 30244f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct() 30254f402f26Sdrh */ 3026e8e4af76Sdrh #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */ 3027ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */ 3028ae651d61Sdrh #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */ 3029e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */ 303038cc40c2Sdan 303175897234Sdrh /* 3032b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column 3033b3bce662Sdanielk1977 ** names. The context consists of a list of tables (the pSrcList) field and 3034b3bce662Sdanielk1977 ** a list of named expression (pEList). The named expression list may 3035b3bce662Sdanielk1977 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 3036b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 3037b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for 3038b3bce662Sdanielk1977 ** other statements. 3039b3bce662Sdanielk1977 ** 3040b3bce662Sdanielk1977 ** NameContexts can be nested. When resolving names, the inner-most 3041b3bce662Sdanielk1977 ** context is searched first. If no match is found, the next outer 3042b3bce662Sdanielk1977 ** context is checked. If there is still no match, the next context 3043b3bce662Sdanielk1977 ** is checked. This process continues until either a match is found 3044b3bce662Sdanielk1977 ** or all contexts are check. When a match is found, the nRef member of 3045b3bce662Sdanielk1977 ** the context containing the match is incremented. 3046b3bce662Sdanielk1977 ** 3047b3bce662Sdanielk1977 ** Each subquery gets a new NameContext. The pNext field points to the 3048b3bce662Sdanielk1977 ** NameContext in the parent query. Thus the process of scanning the 3049b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer 3050b3bce662Sdanielk1977 ** subqueries looking for a match. 3051b3bce662Sdanielk1977 */ 3052b3bce662Sdanielk1977 struct NameContext { 3053b3bce662Sdanielk1977 Parse *pParse; /* The parser */ 3054b3bce662Sdanielk1977 SrcList *pSrcList; /* One or more tables used to resolve names */ 305525c3b8caSdrh union { 305626080d92Sdrh ExprList *pEList; /* Optional list of result-set columns */ 305713449892Sdrh AggInfo *pAggInfo; /* Information about aggregates at this level */ 3058eac9fabbSdrh Upsert *pUpsert; /* ON CONFLICT clause information from an upsert */ 3059552562c4Sdrh int iBaseReg; /* For TK_REGISTER when parsing RETURNING */ 306025c3b8caSdrh } uNC; 3061b3bce662Sdanielk1977 NameContext *pNext; /* Next outer name context. NULL for outermost */ 3062a51009b2Sdrh int nRef; /* Number of names resolved by this context */ 3063a51009b2Sdrh int nErr; /* Number of errors encountered while resolving names */ 30640d92571dSdan int ncFlags; /* Zero or more NC_* flags defined below */ 3065e3bf632cSdan Select *pWinSelect; /* SELECT statement for any window functions */ 3066b3bce662Sdanielk1977 }; 3067b3bce662Sdanielk1977 3068b3bce662Sdanielk1977 /* 3069a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field. 30709588ad95Sdrh ** 307149711600Sdrh ** Value constraints (all checked via assert()): 3072d137f4e6Sdrh ** NC_HasAgg == SF_HasAgg == EP_Agg 307349711600Sdrh ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX 3074d137f4e6Sdrh ** NC_HasWin == EP_Win 30759588ad95Sdrh ** 3076a51009b2Sdrh */ 307781f7b372Sdrh #define NC_AllowAgg 0x00001 /* Aggregate functions are allowed here */ 307881f7b372Sdrh #define NC_PartIdx 0x00002 /* True if resolving a partial index WHERE */ 307981f7b372Sdrh #define NC_IsCheck 0x00004 /* True if resolving a CHECK constraint */ 308020cee7d0Sdrh #define NC_GenCol 0x00008 /* True for a GENERATED ALWAYS AS clause */ 308181f7b372Sdrh #define NC_HasAgg 0x00010 /* One or more aggregate functions seen */ 308281f7b372Sdrh #define NC_IdxExpr 0x00020 /* True if resolving columns of CREATE INDEX */ 308320cee7d0Sdrh #define NC_SelfRef 0x0002e /* Combo: PartIdx, isCheck, GenCol, and IdxExpr */ 308481f7b372Sdrh #define NC_VarSelect 0x00040 /* A correlated subquery has been seen */ 308581f7b372Sdrh #define NC_UEList 0x00080 /* True if uNC.pEList is used */ 308681f7b372Sdrh #define NC_UAggInfo 0x00100 /* True if uNC.pAggInfo is used */ 308781f7b372Sdrh #define NC_UUpsert 0x00200 /* True if uNC.pUpsert is used */ 3088552562c4Sdrh #define NC_UBaseReg 0x00400 /* True if uNC.iBaseReg is used */ 308981f7b372Sdrh #define NC_MinMaxAgg 0x01000 /* min/max aggregates seen. See note above */ 309081f7b372Sdrh #define NC_Complex 0x02000 /* True if a function or subquery seen */ 309181f7b372Sdrh #define NC_AllowWin 0x04000 /* Window functions are allowed here */ 309281f7b372Sdrh #define NC_HasWin 0x08000 /* One or more window functions seen */ 3093d0ff601cSdrh #define NC_IsDDL 0x10000 /* Resolving names in a CREATE statement */ 309420cee7d0Sdrh #define NC_InAggFunc 0x20000 /* True if analyzing arguments to an agg func */ 3095ccb2113aSdrh #define NC_FromDDL 0x40000 /* SQL text comes from sqlite_schema */ 3096a51009b2Sdrh 3097a51009b2Sdrh /* 309846d2e5c3Sdrh ** An instance of the following object describes a single ON CONFLICT 3099e9c2e772Sdrh ** clause in an upsert. 3100788d55aaSdrh ** 3101788d55aaSdrh ** The pUpsertTarget field is only set if the ON CONFLICT clause includes 3102788d55aaSdrh ** conflict-target clause. (In "ON CONFLICT(a,b)" the "(a,b)" is the 3103e9c2e772Sdrh ** conflict-target clause.) The pUpsertTargetWhere is the optional 3104e9c2e772Sdrh ** WHERE clause used to identify partial unique indexes. 3105788d55aaSdrh ** 3106788d55aaSdrh ** pUpsertSet is the list of column=expr terms of the UPDATE statement. 3107788d55aaSdrh ** The pUpsertSet field is NULL for a ON CONFLICT DO NOTHING. The 3108788d55aaSdrh ** pUpsertWhere is the WHERE clause for the UPDATE and is NULL if the 3109788d55aaSdrh ** WHERE clause is omitted. 311046d2e5c3Sdrh */ 311146d2e5c3Sdrh struct Upsert { 31125602777eSdrh ExprList *pUpsertTarget; /* Optional description of conflict target */ 3113e9c2e772Sdrh Expr *pUpsertTargetWhere; /* WHERE clause for partial index targets */ 311446d2e5c3Sdrh ExprList *pUpsertSet; /* The SET clause from an ON CONFLICT UPDATE */ 3115dab0eb58Sdrh Expr *pUpsertWhere; /* WHERE clause for the ON CONFLICT UPDATE */ 31162549e4ccSdrh Upsert *pNextUpsert; /* Next ON CONFLICT clause in the list */ 3117255c1c15Sdrh u8 isDoUpdate; /* True for DO UPDATE. False for DO NOTHING */ 3118e84ad92fSdrh /* Above this point is the parse tree for the ON CONFLICT clauses. 3119e84ad92fSdrh ** The next group of fields stores intermediate data. */ 3120daf2761cSdrh void *pToFree; /* Free memory when deleting the Upsert object */ 3121e84ad92fSdrh /* All fields above are owned by the Upsert object and must be freed 3122e84ad92fSdrh ** when the Upsert is destroyed. The fields below are used to transfer 3123e84ad92fSdrh ** information from the INSERT processing down into the UPDATE processing 3124e84ad92fSdrh ** while generating code. The fields below are owned by the INSERT 3125e84ad92fSdrh ** statement and will be freed by INSERT processing. */ 312691f2717fSdrh Index *pUpsertIdx; /* UNIQUE constraint specified by pUpsertTarget */ 31270b30a116Sdrh SrcList *pUpsertSrc; /* Table to be updated */ 3128eac9fabbSdrh int regData; /* First register holding array of VALUES */ 31297fc3aba8Sdrh int iDataCur; /* Index of the data cursor */ 31307fc3aba8Sdrh int iIdxCur; /* Index of the first index cursor */ 313146d2e5c3Sdrh }; 313246d2e5c3Sdrh 313346d2e5c3Sdrh /* 31349bb61fe7Sdrh ** An instance of the following structure contains all information 31359bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 3136a76b5dfcSdrh ** 3137bbd4ae5aSdrh ** See the header comment on the computeLimitRegisters() routine for a 3138bbd4ae5aSdrh ** detailed description of the meaning of the iLimit and iOffset fields. 31390342b1f5Sdrh ** 3140b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 31410342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in 314266a5167bSdrh ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 31430342b1f5Sdrh ** the number of columns in P2 can be computed at the same time 3144b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not 31450342b1f5Sdrh ** enough information about the compound query is known at that point. 3146b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 31472c79733fSdrh ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating 31480342b1f5Sdrh ** sequences for the ORDER BY clause. 31499bb61fe7Sdrh */ 31509bb61fe7Sdrh struct Select { 31517b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 3152c3489bbfSdrh LogEst nSelectRow; /* Estimated number of result rows */ 3153c3489bbfSdrh u32 selFlags; /* Various SF_* values */ 3154a451017dSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 3155fef37760Sdrh u32 selId; /* Unique identifier number for this SELECT */ 3156079a3072Sdrh int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */ 3157a9ebfe20Sdrh ExprList *pEList; /* The fields of the result */ 3158ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 31599bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 31609bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 31619bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 31629bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 3163967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 31641e281291Sdrh Select *pNext; /* Next select to the left in a compound */ 3165a2dc3b1aSdanielk1977 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 31664e9119d9Sdan With *pWith; /* WITH clause attached to this select. Or NULL. */ 316767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 316886fb6e17Sdan Window *pWin; /* List of window functions */ 3169e3bf632cSdan Window *pWinDefn; /* List of named window definitions */ 317067a9b8edSdan #endif 31719bb61fe7Sdrh }; 31729bb61fe7Sdrh 31739bb61fe7Sdrh /* 31747d10d5a6Sdrh ** Allowed values for Select.selFlags. The "SF" prefix stands for 31757d10d5a6Sdrh ** "Select Flag". 317649711600Sdrh ** 317749711600Sdrh ** Value constraints (all checked via assert()) 317849711600Sdrh ** SF_HasAgg == NC_HasAgg 317949711600Sdrh ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX 318049711600Sdrh ** SF_FixedLimit == WHERE_USE_LIMIT 31817d10d5a6Sdrh */ 3182ba01634cSdrh #define SF_Distinct 0x0000001 /* Output should be DISTINCT */ 3183ba01634cSdrh #define SF_All 0x0000002 /* Includes the ALL keyword */ 3184ba01634cSdrh #define SF_Resolved 0x0000004 /* Identifiers have been resolved */ 3185ba01634cSdrh #define SF_Aggregate 0x0000008 /* Contains agg functions or a GROUP BY */ 3186ba01634cSdrh #define SF_HasAgg 0x0000010 /* Contains aggregate functions */ 3187ba01634cSdrh #define SF_UsesEphemeral 0x0000020 /* Uses the OpenEphemeral opcode */ 3188ba01634cSdrh #define SF_Expanded 0x0000040 /* sqlite3SelectExpand() called on this */ 3189ba01634cSdrh #define SF_HasTypeInfo 0x0000080 /* FROM subqueries have Table metadata */ 3190ba01634cSdrh #define SF_Compound 0x0000100 /* Part of a compound query */ 3191ba01634cSdrh #define SF_Values 0x0000200 /* Synthesized from VALUES clause */ 3192ba01634cSdrh #define SF_MultiValue 0x0000400 /* Single VALUES term with multiple rows */ 3193ba01634cSdrh #define SF_NestedFrom 0x0000800 /* Part of a parenthesized FROM clause */ 3194ba01634cSdrh #define SF_MinMaxAgg 0x0001000 /* Aggregate containing min() or max() */ 3195ba01634cSdrh #define SF_Recursive 0x0002000 /* The recursive part of a recursive CTE */ 3196ba01634cSdrh #define SF_FixedLimit 0x0004000 /* nSelectRow set by a constant LIMIT */ 3197ba01634cSdrh #define SF_MaybeConvert 0x0008000 /* Need convertCompoundSelectToSubquery() */ 3198ba01634cSdrh #define SF_Converted 0x0010000 /* By convertCompoundSelectToSubquery() */ 3199ba01634cSdrh #define SF_IncludeHidden 0x0020000 /* Include hidden columns in output */ 3200ba01634cSdrh #define SF_ComplexResult 0x0040000 /* Result contains subquery or function */ 3201ba01634cSdrh #define SF_WhereBegin 0x0080000 /* Really a WhereBegin() call. Debug Only */ 3202ba01634cSdrh #define SF_WinRewrite 0x0100000 /* Window function rewrite accomplished */ 320338096961Sdan #define SF_View 0x0200000 /* SELECT statement is a view */ 3204b7cbf5c1Sdrh #define SF_NoopOrderBy 0x0400000 /* ORDER BY is ignored for this query */ 320507ca7d61Sdan #define SF_UpdateFrom 0x0800000 /* Statement is an UPDATE...FROM */ 32068794c68aSdrh #define SF_PushDown 0x1000000 /* SELECT has be modified by push-down opt */ 32077d10d5a6Sdrh 32087d10d5a6Sdrh /* 3209340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined 3210340309fdSdrh ** by one of the following macros. The "SRT" prefix means "SELECT Result 3211340309fdSdrh ** Type". 3212340309fdSdrh ** 3213340309fdSdrh ** SRT_Union Store results as a key in a temporary index 3214340309fdSdrh ** identified by pDest->iSDParm. 3215340309fdSdrh ** 3216340309fdSdrh ** SRT_Except Remove results from the temporary index pDest->iSDParm. 3217340309fdSdrh ** 3218340309fdSdrh ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result 3219340309fdSdrh ** set is not empty. 3220340309fdSdrh ** 3221340309fdSdrh ** SRT_Discard Throw the results away. This is used by SELECT 3222340309fdSdrh ** statements within triggers whose only purpose is 3223340309fdSdrh ** the side-effects of functions. 3224340309fdSdrh ** 3225340309fdSdrh ** SRT_Output Generate a row of output (using the OP_ResultRow 3226340309fdSdrh ** opcode) for each row in the result set. 3227340309fdSdrh ** 3228340309fdSdrh ** SRT_Mem Only valid if the result is a single column. 3229340309fdSdrh ** Store the first column of the first result row 3230340309fdSdrh ** in register pDest->iSDParm then abandon the rest 3231340309fdSdrh ** of the query. This destination implies "LIMIT 1". 3232340309fdSdrh ** 3233340309fdSdrh ** SRT_Set The result must be a single column. Store each 3234340309fdSdrh ** row of result as the key in table pDest->iSDParm. 3235340309fdSdrh ** Apply the affinity pDest->affSdst before storing 3236340309fdSdrh ** results. Used to implement "IN (SELECT ...)". 3237340309fdSdrh ** 3238340309fdSdrh ** SRT_EphemTab Create an temporary table pDest->iSDParm and store 3239340309fdSdrh ** the result there. The cursor is left open after 3240340309fdSdrh ** returning. This is like SRT_Table except that 3241340309fdSdrh ** this destination uses OP_OpenEphemeral to create 3242340309fdSdrh ** the table first. 3243340309fdSdrh ** 3244340309fdSdrh ** SRT_Coroutine Generate a co-routine that returns a new row of 3245340309fdSdrh ** results each time it is invoked. The entry point 3246340309fdSdrh ** of the co-routine is stored in register pDest->iSDParm 3247340309fdSdrh ** and the result row is stored in pDest->nDest registers 3248340309fdSdrh ** starting with pDest->iSdst. 3249340309fdSdrh ** 3250781def29Sdrh ** SRT_Table Store results in temporary table pDest->iSDParm. 32518e1ee88cSdrh ** SRT_Fifo This is like SRT_EphemTab except that the table 32528e1ee88cSdrh ** is assumed to already be open. SRT_Fifo has 32538e1ee88cSdrh ** the additional property of being able to ignore 32548e1ee88cSdrh ** the ORDER BY clause. 3255781def29Sdrh ** 32568e1ee88cSdrh ** SRT_DistFifo Store results in a temporary table pDest->iSDParm. 3257340309fdSdrh ** But also use temporary table pDest->iSDParm+1 as 3258340309fdSdrh ** a record of all prior results and ignore any duplicate 32598e1ee88cSdrh ** rows. Name means: "Distinct Fifo". 3260781def29Sdrh ** 3261781def29Sdrh ** SRT_Queue Store results in priority queue pDest->iSDParm (really 3262781def29Sdrh ** an index). Append a sequence number so that all entries 3263781def29Sdrh ** are distinct. 3264781def29Sdrh ** 3265781def29Sdrh ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if 3266781def29Sdrh ** the same record has never been stored before. The 3267781def29Sdrh ** index at pDest->iSDParm+1 hold all prior stores. 3268243210b7Sdan ** 3269243210b7Sdan ** SRT_Upfrom Store results in the temporary table already opened by 3270243210b7Sdan ** pDest->iSDParm. If (pDest->iSDParm<0), then the temp 3271243210b7Sdan ** table is an intkey table - in this case the first 3272243210b7Sdan ** column returned by the SELECT is used as the integer 3273243210b7Sdan ** key. If (pDest->iSDParm>0), then the table is an index 3274243210b7Sdan ** table. (pDest->iSDParm) is the number of key columns in 3275243210b7Sdan ** each index record in this case. 3276fef5208cSdrh */ 327713449892Sdrh #define SRT_Union 1 /* Store result as keys in an index */ 327813449892Sdrh #define SRT_Except 2 /* Remove result from a UNION index */ 32799ed1dfa8Sdanielk1977 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 32809ed1dfa8Sdanielk1977 #define SRT_Discard 4 /* Do not save the results anywhere */ 3281f1ea4255Sdrh #define SRT_DistFifo 5 /* Like SRT_Fifo, but unique results only */ 3282f1ea4255Sdrh #define SRT_DistQueue 6 /* Like SRT_Queue, but unique results only */ 3283f1ea4255Sdrh 3284f1ea4255Sdrh /* The DISTINCT clause is ignored for all of the above. Not that 3285f1ea4255Sdrh ** IgnorableDistinct() implies IgnorableOrderby() */ 3286f1ea4255Sdrh #define IgnorableDistinct(X) ((X->eDest)<=SRT_DistQueue) 3287f1ea4255Sdrh 32888e1ee88cSdrh #define SRT_Queue 7 /* Store result in an queue */ 3289f1ea4255Sdrh #define SRT_Fifo 8 /* Store result as data with an automatic rowid */ 3290fef5208cSdrh 329113449892Sdrh /* The ORDER BY clause is ignored for all of the above */ 3292f1ea4255Sdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_Fifo) 329313449892Sdrh 32948e1ee88cSdrh #define SRT_Output 9 /* Output each row of result */ 32958e1ee88cSdrh #define SRT_Mem 10 /* Store result in a memory cell */ 32968e1ee88cSdrh #define SRT_Set 11 /* Store results as keys in an index */ 32978e1ee88cSdrh #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */ 32988e1ee88cSdrh #define SRT_Coroutine 13 /* Generate a single row of result */ 32998e1ee88cSdrh #define SRT_Table 14 /* Store result as data with an automatic rowid */ 3300f2972b60Sdan #define SRT_Upfrom 15 /* Store result as data with rowid */ 33012282792aSdrh 33022282792aSdrh /* 3303634d81deSdrh ** An instance of this object describes where to put of the results of 3304634d81deSdrh ** a SELECT statement. 33056c8c8ce0Sdanielk1977 */ 33066c8c8ce0Sdanielk1977 struct SelectDest { 33079ed322d6Sdan u8 eDest; /* How to dispose of the results. One of SRT_* above. */ 33082b596da8Sdrh int iSDParm; /* A parameter used by the eDest disposal method */ 33099ed322d6Sdan int iSDParm2; /* A second parameter for the eDest disposal method */ 33102b596da8Sdrh int iSdst; /* Base register where results are written */ 33112b596da8Sdrh int nSdst; /* Number of registers allocated */ 3312a8b9793cSdrh char *zAffSdst; /* Affinity used when eDest==SRT_Set */ 3313fe1c6bb9Sdrh ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */ 33146c8c8ce0Sdanielk1977 }; 33156c8c8ce0Sdanielk1977 33166c8c8ce0Sdanielk1977 /* 33170b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT 33180b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p 33190b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that 33200b9f50d8Sdrh ** the code generator needs. We have to keep per-table autoincrement 33211b32554bSdrh ** information in case inserts are done within triggers. Triggers do not 33220b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the 33230b9f50d8Sdrh ** loading and saving of autoincrement information. 33240b9f50d8Sdrh */ 33250b9f50d8Sdrh struct AutoincInfo { 33260b9f50d8Sdrh AutoincInfo *pNext; /* Next info block in a list of them all */ 33270b9f50d8Sdrh Table *pTab; /* Table this info block refers to */ 33280b9f50d8Sdrh int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 33290b9f50d8Sdrh int regCtr; /* Memory register holding the rowid counter */ 33300b9f50d8Sdrh }; 33310b9f50d8Sdrh 33320b9f50d8Sdrh /* 33332832ad42Sdan ** At least one instance of the following structure is created for each 33342832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 33352832ad42Sdan ** statement. All such objects are stored in the linked list headed at 33362832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been 33372832ad42Sdan ** completed. 33382832ad42Sdan ** 33392832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger 33402832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 33412832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 33422832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same 33432832ad42Sdan ** values for both pTrigger and orconf. 334465a7cd16Sdan ** 3345bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 334665a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT 3347bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 3348bb5f168fSdan ** a mask of new.* columns used by the program. 33492832ad42Sdan */ 33502832ad42Sdan struct TriggerPrg { 33512832ad42Sdan Trigger *pTrigger; /* Trigger this program was coded from */ 33522832ad42Sdan TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 3353a451017dSdrh SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 3354a451017dSdrh int orconf; /* Default ON CONFLICT policy */ 3355a451017dSdrh u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 3356165921a7Sdan }; 3357165921a7Sdan 335864123585Sdrh /* 335964123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases. 336064123585Sdrh */ 336101c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30 3362a7ab6d81Sdrh typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8]; 3363a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0) 3364a7ab6d81Sdrh # define DbMaskZero(M) memset((M),0,sizeof(M)) 3365a7ab6d81Sdrh # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7)) 3366a7ab6d81Sdrh # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M) 3367a7ab6d81Sdrh # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0) 336801c7dc88Sdrh #else 336964123585Sdrh typedef unsigned int yDbMask; 3370a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0) 3371a7ab6d81Sdrh # define DbMaskZero(M) (M)=0 3372a7ab6d81Sdrh # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I)) 3373a7ab6d81Sdrh # define DbMaskAllZero(M) (M)==0 3374a7ab6d81Sdrh # define DbMaskNonZero(M) (M)!=0 337501c7dc88Sdrh #endif 337601c7dc88Sdrh 3377ceea3321Sdrh /* 3378cf3c078fSdrh ** An instance of the ParseCleanup object specifies an operation that 3379cf3c078fSdrh ** should be performed after parsing to deallocation resources obtained 3380cf3c078fSdrh ** during the parse and which are no longer needed. 3381cf3c078fSdrh */ 3382cf3c078fSdrh struct ParseCleanup { 3383cf3c078fSdrh ParseCleanup *pNext; /* Next cleanup task */ 3384cf3c078fSdrh void *pPtr; /* Pointer to object to deallocate */ 3385cf3c078fSdrh void (*xCleanup)(sqlite3*,void*); /* Deallocation routine */ 3386cf3c078fSdrh }; 3387cf3c078fSdrh 3388cf3c078fSdrh /* 3389f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 3390f57b3399Sdrh ** the parser and down into all the parser action routine in order to 3391f57b3399Sdrh ** carry around information that is global to the entire parse. 3392f1974846Sdrh ** 3393f1974846Sdrh ** The structure is divided into two parts. When the parser and code 3394f1974846Sdrh ** generate call themselves recursively, the first part of the structure 3395f1974846Sdrh ** is constant but the second part is reset at the beginning and end of 3396f1974846Sdrh ** each recursion. 3397c00da105Sdanielk1977 ** 3398c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache 3399c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 3400c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being 3401c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the 3402c00da105Sdanielk1977 ** list. 340375897234Sdrh */ 340475897234Sdrh struct Parse { 34059bb575fdSdrh sqlite3 *db; /* The main database structure */ 340675897234Sdrh char *zErrMsg; /* An error message */ 340775897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 3408a451017dSdrh int rc; /* Return code from execution */ 3409836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 3410a6ecd338Sdrh u8 checkSchema; /* Causes schema cookie check after an error */ 3411205f48e6Sdrh u8 nested; /* Number of nested calls to the parser/code generator */ 3412892d3179Sdrh u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 3413a451017dSdrh u8 isMultiWrite; /* True if statement may modify/insert multiple rows */ 3414a451017dSdrh u8 mayAbort; /* True if statement may throw an ABORT exception */ 3415d58d3278Sdrh u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */ 3416aceb31b1Sdrh u8 okConstFactor; /* OK to factor out constants */ 34174a642b60Sdrh u8 disableLookaside; /* Number of times lookaside has been disabled */ 34181ea0443cSdan u8 disableVtab; /* Disable all virtual tables for this parse */ 341921d4f5b5Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST) 342021d4f5b5Sdrh u8 earlyCleanup; /* OOM inside sqlite3ParserAddCleanup() */ 342121d4f5b5Sdrh #endif 3422892d3179Sdrh int nRangeReg; /* Size of the temporary register block */ 3423892d3179Sdrh int iRangeReg; /* First register in temporary register block */ 342475897234Sdrh int nErr; /* Number of errors seen */ 3425832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 342619a775c2Sdrh int nMem; /* Number of memory cells used so far */ 3427bd57308eSdrh int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */ 34287e8515d8Sdrh int iSelfTab; /* Table associated with an index on expr, or negative 34296e97f8ecSdrh ** of the base register during check-constraint eval */ 3430d1d158bfSdrh int nLabel; /* The *negative* of the number of labels used */ 3431ec4ccdbcSdrh int nLabelAlloc; /* Number of slots in aLabel */ 34327df89c8cSdrh int *aLabel; /* Space to hold the labels */ 3433f30a969bSdrh ExprList *pConstExpr;/* Constant expressions */ 34347df89c8cSdrh Token constraintName;/* Name of the constraint currently being parsed */ 343564123585Sdrh yDbMask writeMask; /* Start a write transaction on these databases */ 343664123585Sdrh yDbMask cookieMask; /* Bitmask of schema verified databases */ 3437a451017dSdrh int regRowid; /* Register holding rowid of CREATE TABLE entry */ 3438a451017dSdrh int regRoot; /* Register holding root page number for new objects */ 3439a451017dSdrh int nMaxArg; /* Max args passed to user function by sub-program */ 3440fef37760Sdrh int nSelect; /* Number of SELECT stmts. Counter for Select.selId */ 3441c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 3442c00da105Sdanielk1977 int nTableLock; /* Number of locks in aTableLock */ 3443c00da105Sdanielk1977 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 3444c00da105Sdanielk1977 #endif 34450b9f50d8Sdrh AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 344665a7cd16Sdan Parse *pToplevel; /* Parse structure for main program (or NULL) */ 3447165921a7Sdan Table *pTriggerTab; /* Table triggers are being coded for */ 34481cf19758Sdrh Parse *pParentParse; /* Parent parser if this parser is nested */ 3449381bdaccSdrh union { 3450381bdaccSdrh int addrCrTab; /* Address of OP_CreateBtree on CREATE TABLE */ 3451381bdaccSdrh Returning *pReturning; /* The RETURNING clause */ 3452381bdaccSdrh } u1; 34534f402f26Sdrh u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */ 345465a7cd16Sdan u32 oldmask; /* Mask of old.* columns referenced */ 3455bb5f168fSdan u32 newmask; /* Mask of new.* columns referenced */ 345665a7cd16Sdan u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 3457b8352479Sdrh u8 bReturning; /* Coding a RETURNING trigger */ 345865a7cd16Sdan u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 3459d66c8309Sdan u8 disableTriggers; /* True to disable triggers */ 3460165921a7Sdan 3461445f3d56Sdrh /************************************************************************** 3462445f3d56Sdrh ** Fields above must be initialized to zero. The fields that follow, 3463445f3d56Sdrh ** down to the beginning of the recursive section, do not need to be 3464445f3d56Sdrh ** initialized as they will be set before being used. The boundary is 346502ceed05Sdrh ** determined by offsetof(Parse,aTempReg). 3466445f3d56Sdrh **************************************************************************/ 3467445f3d56Sdrh 3468445f3d56Sdrh int aTempReg[8]; /* Holding area for temporary registers */ 3469445f3d56Sdrh Token sNameToken; /* Token with unqualified schema object name */ 3470cd9af608Sdrh 34717df89c8cSdrh /************************************************************************ 34727df89c8cSdrh ** Above is constant between recursions. Below is reset before and after 34737df89c8cSdrh ** each recursion. The boundary between these two regions is determined 3474588429a8Sdrh ** using offsetof(Parse,sLastToken) so the sLastToken field must be the 3475588429a8Sdrh ** first field in the recursive region. 34767df89c8cSdrh ************************************************************************/ 3477f1974846Sdrh 3478588429a8Sdrh Token sLastToken; /* The last token parsed */ 34796d664b4bSdrh ynVar nVar; /* Number of '?' variables seen in the SQL so far */ 34807f9c5dbfSdrh u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */ 3481a451017dSdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 3482cf8f2895Sdan u8 eParseMode; /* PARSE_MODE_XXX constant */ 3483a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 3484a451017dSdrh int nVtabLock; /* Number of virtual tables to lock */ 3485a451017dSdrh #endif 3486a451017dSdrh int nHeight; /* Expression tree height of current sub-select */ 3487a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN 3488e2ca99c9Sdrh int addrExplain; /* Address of current OP_Explain opcode */ 3489a451017dSdrh #endif 34909bf755ccSdrh VList *pVList; /* Mapping between variable names and numbers */ 3491937d0deaSdan Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 3492f1974846Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 3493f1974846Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 3494885eeb67Sdrh Index *pNewIndex; /* An index being constructed by CREATE INDEX. 3495885eeb67Sdrh ** Also used to hold redundant UNIQUE constraints 3496885eeb67Sdrh ** during a RENAME COLUMN */ 3497f1974846Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 3498f1974846Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 3499b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 350033b3933cSdanielk1977 Token sArg; /* Complete text of a module argument */ 35014f3dd150Sdrh Table **apVtabLock; /* Pointer to virtual tables needing locking */ 3502b9bb7c18Sdrh #endif 35032832ad42Sdan TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 35044e9119d9Sdan With *pWith; /* Current WITH clause, or NULL */ 3505cf3c078fSdrh ParseCleanup *pCleanup; /* List of cleanup operations to run after parse */ 3506cf8f2895Sdan #ifndef SQLITE_OMIT_ALTERTABLE 35074a2c747cSdrh RenameToken *pRename; /* Tokens subject to renaming by ALTER TABLE */ 3508cf8f2895Sdan #endif 350975897234Sdrh }; 351075897234Sdrh 3511cf8f2895Sdan #define PARSE_MODE_NORMAL 0 3512cf8f2895Sdan #define PARSE_MODE_DECLARE_VTAB 1 3513e6dc1e5bSdan #define PARSE_MODE_RENAME 2 3514e6dc1e5bSdan #define PARSE_MODE_UNMAP 3 3515cf8f2895Sdan 3516a451017dSdrh /* 3517cd9af608Sdrh ** Sizes and pointers of various parts of the Parse object. 3518cd9af608Sdrh */ 351902ceed05Sdrh #define PARSE_HDR_SZ offsetof(Parse,aTempReg) /* Recursive part w/o aColCache*/ 3520588429a8Sdrh #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */ 3521cd9af608Sdrh #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */ 3522cd9af608Sdrh #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */ 3523cd9af608Sdrh 3524cd9af608Sdrh /* 3525a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call. 3526a451017dSdrh */ 35277e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE 35287e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB 0 35297e6ebfb2Sdanielk1977 #else 3530cf8f2895Sdan #define IN_DECLARE_VTAB (pParse->eParseMode==PARSE_MODE_DECLARE_VTAB) 3531cf8f2895Sdan #endif 3532cf8f2895Sdan 3533cf8f2895Sdan #if defined(SQLITE_OMIT_ALTERTABLE) 3534c9461eccSdan #define IN_RENAME_OBJECT 0 3535cf8f2895Sdan #else 3536e6dc1e5bSdan #define IN_RENAME_OBJECT (pParse->eParseMode>=PARSE_MODE_RENAME) 3537cf8f2895Sdan #endif 3538cf8f2895Sdan 3539cf8f2895Sdan #if defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE) 3540cf8f2895Sdan #define IN_SPECIAL_PARSE 0 3541cf8f2895Sdan #else 3542cf8f2895Sdan #define IN_SPECIAL_PARSE (pParse->eParseMode!=PARSE_MODE_NORMAL) 35437e6ebfb2Sdanielk1977 #endif 35447e6ebfb2Sdanielk1977 3545d99bc930Sdanielk1977 /* 354685e2096fSdrh ** An instance of the following structure can be declared on a stack and used 354785e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 354885e2096fSdrh */ 354985e2096fSdrh struct AuthContext { 355085e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 355185e2096fSdrh Parse *pParse; /* The Parse structure */ 355285e2096fSdrh }; 355385e2096fSdrh 355485e2096fSdrh /* 3555a748fdccSdrh ** Bitfield flags for P5 value in various opcodes. 355649711600Sdrh ** 355749711600Sdrh ** Value constraints (enforced via assert()): 355849711600Sdrh ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH 355949711600Sdrh ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF 356049711600Sdrh ** OPFLAG_BULKCSR == BTREE_BULKLOAD 356149711600Sdrh ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ 356249711600Sdrh ** OPFLAG_FORDELETE == BTREE_FORDELETE 356349711600Sdrh ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION 356449711600Sdrh ** OPFLAG_AUXDELETE == BTREE_AUXDELETE 3565b0c374ffSrdc */ 3566e807bdbaSdrh #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */ 3567e807bdbaSdrh /* Also used in P2 (not P5) of OP_Delete */ 356809d00b2fSdrh #define OPFLAG_NOCHNG 0x01 /* OP_VColumn nochange for UPDATE */ 356997348b37Sdrh #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */ 3570f91c1318Sdan #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */ 35713e9ca094Sdrh #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 35723e9ca094Sdrh #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 35733e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 357446c47d46Sdan #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */ 3575a748fdccSdrh #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */ 3576a748fdccSdrh #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */ 3577428c218cSdan #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */ 3578e0997b34Sdrh #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */ 35799c0c57a4Sdrh #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */ 3580fd261ec6Sdan #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */ 3581953f7611Sdrh #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */ 3582f91c1318Sdan #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */ 3583def19e3bSdrh #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */ 358441fb367aSdrh #define OPFLAG_NOCHNG_MAGIC 0x6d /* OP_MakeRecord: serialtype 10 is ok */ 35857aae7358Sdan #define OPFLAG_PREFORMAT 0x80 /* OP_Insert uses preformatted cell */ 3586b0c374ffSrdc 3587b0c374ffSrdc /* 3588d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 3589d99bc930Sdanielk1977 * struct Trigger. 3590d99bc930Sdanielk1977 * 3591d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 35929bb575fdSdrh * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 3593d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 3594d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 3595ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 3596ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 3597ad3cab52Sdrh * struct Table. 3598d99bc930Sdanielk1977 * 3599ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 3600ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 3601d99bc930Sdanielk1977 */ 3602d99bc930Sdanielk1977 struct Trigger { 3603165921a7Sdan char *zName; /* The name of the trigger */ 3604d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 3605f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 3606dca76841Sdrh u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 3607b8352479Sdrh u8 bReturning; /* This trigger implements a RETURNING clause */ 3608467bcf36Sshane Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 3609d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 3610d99bc930Sdanielk1977 the <column-list> is stored here */ 3611e501b89aSdanielk1977 Schema *pSchema; /* Schema containing the trigger */ 3612e501b89aSdanielk1977 Schema *pTabSchema; /* Schema containing the table */ 3613d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 3614d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 3615c3f9bad2Sdanielk1977 }; 3616d99bc930Sdanielk1977 3617d99bc930Sdanielk1977 /* 3618dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger. The following constants 3619dca76841Sdrh ** determine which. 3620dca76841Sdrh ** 3621dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER. 3622dca76841Sdrh ** In that cases, the constants below can be ORed together. 3623dca76841Sdrh */ 3624dca76841Sdrh #define TRIGGER_BEFORE 1 3625dca76841Sdrh #define TRIGGER_AFTER 2 3626dca76841Sdrh 3627dca76841Sdrh /* 3628d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 3629d99bc930Sdanielk1977 * that is a part of a trigger-program. 3630d99bc930Sdanielk1977 * 3631d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 3632d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 3633d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 3634d99bc930Sdanielk1977 * the first step of the trigger-program. 3635d99bc930Sdanielk1977 * 3636d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 3637d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 3638d99bc930Sdanielk1977 * value of "op" as follows: 3639d99bc930Sdanielk1977 * 3640d99bc930Sdanielk1977 * (op == TK_INSERT) 3641d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 3642d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 3643d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 364446408354Sdan * zTarget -> Dequoted name of the table to insert into. 3645d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 3646d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 3647d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 3648ad3cab52Sdrh * statement, then this stores the column-names to be 3649ad3cab52Sdrh * inserted into. 3650d99bc930Sdanielk1977 * 3651d99bc930Sdanielk1977 * (op == TK_DELETE) 365246408354Sdan * zTarget -> Dequoted name of the table to delete from. 3653d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 3654d99bc930Sdanielk1977 * Otherwise NULL. 3655d99bc930Sdanielk1977 * 3656d99bc930Sdanielk1977 * (op == TK_UPDATE) 365746408354Sdan * zTarget -> Dequoted name of the table to update. 3658d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 3659d99bc930Sdanielk1977 * Otherwise NULL. 3660d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 36614adee20fSdanielk1977 * them to. See sqlite3Update() documentation of "pChanges" 3662ad3cab52Sdrh * argument. 3663d99bc930Sdanielk1977 * 3664d99bc930Sdanielk1977 */ 3665c3f9bad2Sdanielk1977 struct TriggerStep { 3666dac9a5f7Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT, 3667dac9a5f7Sdrh ** or TK_RETURNING */ 3668b1819a0bSdrh u8 orconf; /* OE_Rollback etc. */ 3669a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 367046408354Sdan Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */ 367146408354Sdan char *zTarget; /* Target table for DELETE, UPDATE, INSERT */ 3672e7877b2dSdan SrcList *pFrom; /* FROM clause for UPDATE statement (if any) */ 3673b1819a0bSdrh Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 3674381bdaccSdrh ExprList *pExprList; /* SET clause for UPDATE, or RETURNING clause */ 3675b1819a0bSdrh IdList *pIdList; /* Column names for INSERT */ 367646d2e5c3Sdrh Upsert *pUpsert; /* Upsert clauses on an INSERT */ 3677f259df5fSdrh char *zSpan; /* Original SQL text of this command */ 3678c3f9bad2Sdanielk1977 TriggerStep *pNext; /* Next in the link-list */ 3679187e4c6aSdrh TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 3680c3f9bad2Sdanielk1977 }; 3681c3f9bad2Sdanielk1977 3682d99bc930Sdanielk1977 /* 3683b8352479Sdrh ** Information about a RETURNING clause 3684b8352479Sdrh */ 3685b8352479Sdrh struct Returning { 3686b8352479Sdrh Parse *pParse; /* The parse that includes the RETURNING clause */ 3687b8352479Sdrh ExprList *pReturnEL; /* List of expressions to return */ 3688b8352479Sdrh Trigger retTrig; /* The transient trigger that implements RETURNING */ 3689b8352479Sdrh TriggerStep retTStep; /* The trigger step */ 3690381bdaccSdrh int iRetCur; /* Transient table holding RETURNING results */ 3691381bdaccSdrh int nRetCol; /* Number of in pReturnEL after expansion */ 3692552562c4Sdrh int iRetReg; /* Register array for holding a row of RETURNING */ 3693b8352479Sdrh }; 3694b8352479Sdrh 3695b8352479Sdrh /* 3696ade86483Sdrh ** An objected used to accumulate the text of a string where we 3697ade86483Sdrh ** do not necessarily know how big the string will be in the end. 3698ade86483Sdrh */ 36990cdbe1aeSdrh struct sqlite3_str { 3700633e6d57Sdrh sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 3701ade86483Sdrh char *zText; /* The string collected so far */ 3702fa385edfSdrh u32 nAlloc; /* Amount of space allocated in zText */ 3703fa385edfSdrh u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */ 37043f18e6d7Sdrh u32 nChar; /* Length of the string so far */ 37050cdbe1aeSdrh u8 accError; /* SQLITE_NOMEM or SQLITE_TOOBIG */ 37065f4a686fSdrh u8 printfFlags; /* SQLITE_PRINTF flags below */ 3707ade86483Sdrh }; 37085f4a686fSdrh #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */ 37095f4a686fSdrh #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */ 37105f4a686fSdrh #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */ 37115f4a686fSdrh 37125f4a686fSdrh #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0) 37135f4a686fSdrh 3714ade86483Sdrh 3715ade86483Sdrh /* 3716234c39dfSdrh ** A pointer to this structure is used to communicate information 3717234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 3718234c39dfSdrh */ 3719234c39dfSdrh typedef struct { 37209bb575fdSdrh sqlite3 *db; /* The database being initialized */ 3721234c39dfSdrh char **pzErrMsg; /* Error message stored here */ 3722a451017dSdrh int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 372315ca1df1Sdrh int rc; /* Result code stored here */ 3724987db767Sdan u32 mInitFlags; /* Flags controlling error messages */ 37256b86e51eSdrh u32 nInitRow; /* Number of rows processed */ 37263b3ddbaeSdrh Pgno mxPage; /* Maximum page number. 0 for no limit. */ 3727234c39dfSdrh } InitData; 3728234c39dfSdrh 3729b6c29897Sdrh /* 3730987db767Sdan ** Allowed values for mInitFlags 3731987db767Sdan */ 37326a5a13dfSdan #define INITFLAG_AlterRename 0x0001 /* Reparse after a RENAME */ 37336a5a13dfSdan #define INITFLAG_AlterDrop 0x0002 /* Reparse after a DROP COLUMN */ 3734987db767Sdan 3735987db767Sdan /* 373640257ffdSdrh ** Structure containing global configuration data for the SQLite library. 373733589797Sdrh ** 373833589797Sdrh ** This structure also contains some state information. 373940257ffdSdrh */ 374040257ffdSdrh struct Sqlite3Config { 3741fec00eabSdrh int bMemstat; /* True to enable memory status */ 374230842990Sdrh u8 bCoreMutex; /* True to enable core mutexing */ 374330842990Sdrh u8 bFullMutex; /* True to enable full mutexing */ 374430842990Sdrh u8 bOpenUri; /* True to interpret filenames as URIs */ 374530842990Sdrh u8 bUseCis; /* Use covering indices for full-scans */ 374630842990Sdrh u8 bSmallMalloc; /* Avoid large memory allocations if true */ 374730842990Sdrh u8 bExtraSchemaChecks; /* Verify type,name,tbl_name in schema */ 37480a687d12Sdrh int mxStrlen; /* Maximum string length */ 374909fe6143Sdrh int neverCorrupt; /* Database is always well-formed */ 3750633e6d57Sdrh int szLookaside; /* Default lookaside buffer size */ 3751633e6d57Sdrh int nLookaside; /* Default lookaside buffer count */ 37528c71a98cSdrh int nStmtSpill; /* Stmt-journal spill-to-disk threshold */ 3753fec00eabSdrh sqlite3_mem_methods m; /* Low-level memory allocation interface */ 37546d2ab0e4Sdanielk1977 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 375522e21ff4Sdan sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */ 375640257ffdSdrh void *pHeap; /* Heap storage space */ 375733589797Sdrh int nHeap; /* Size of pHeap[] */ 375833589797Sdrh int mnReq, mxReq; /* Min and max heap requests sizes */ 37599b4c59faSdrh sqlite3_int64 szMmap; /* mmap() space per open file */ 37609b4c59faSdrh sqlite3_int64 mxMmap; /* Maximum value for szMmap */ 376133589797Sdrh void *pPage; /* Page cache memory */ 376233589797Sdrh int szPage; /* Size of each page in pPage[] */ 376333589797Sdrh int nPage; /* Number of pages in pPage[] */ 37641875f7a3Sdrh int mxParserStack; /* maximum depth of the parser stack */ 37651875f7a3Sdrh int sharedCacheEnabled; /* true if shared-cache mode enabled */ 37663bd1791dSdrh u32 szPma; /* Maximum Sorter PMA size */ 37671875f7a3Sdrh /* The above might be initialized to non-zero. The following need to always 37681875f7a3Sdrh ** initially be zero, however. */ 376971bc31c6Sdanielk1977 int isInit; /* True after initialization has finished */ 3770502b4e00Sdanielk1977 int inProgress; /* True while initialization in progress */ 3771e1ab2193Sdan int isMutexInit; /* True after mutexes are initialized */ 377271bc31c6Sdanielk1977 int isMallocInit; /* True after malloc is initialized */ 3773e1ab2193Sdan int isPCacheInit; /* True after malloc is initialized */ 377493ed56d9Sdrh int nRefInitMutex; /* Number of users of pInitMutex */ 3775c007f61bSdrh sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 37763f280701Sdrh void (*xLog)(void*,int,const char*); /* Function for logging */ 37773f280701Sdrh void *pLogArg; /* First argument to xLog() */ 3778ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG 3779ac455939Sdan void(*xSqllog)(void*,sqlite3*,const char*, int); 3780ac455939Sdan void *pSqllogArg; 3781ac455939Sdan #endif 3782688852abSdrh #ifdef SQLITE_VDBE_COVERAGE 3783688852abSdrh /* The following callback (if not NULL) is invoked on every VDBE branch 3784688852abSdrh ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE. 3785688852abSdrh */ 37867083a487Sdrh void (*xVdbeBranch)(void*,unsigned iSrcLine,u8 eThis,u8 eMx); /* Callback */ 3787688852abSdrh void *pVdbeBranchArg; /* 1st argument */ 3788688852abSdrh #endif 378923a88595Sdrh #ifdef SQLITE_ENABLE_DESERIALIZE 379023a88595Sdrh sqlite3_int64 mxMemdbSize; /* Default max memdb size */ 379123a88595Sdrh #endif 3792d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 3793c007f61bSdrh int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */ 3794c007f61bSdrh #endif 3795c007f61bSdrh int bLocaltimeFault; /* True to fail localtime() calls */ 37969e5eb9c8Sdrh int iOnceResetThreshold; /* When to reset OP_Once counters */ 37972e3a5a81Sdan u32 szSorterRef; /* Min size in bytes to use sorter-refs */ 3798ade54d68Sdrh unsigned int iPrngSeed; /* Alternative fixed seed for the PRNG */ 379940257ffdSdrh }; 380040257ffdSdrh 380140257ffdSdrh /* 380209fe6143Sdrh ** This macro is used inside of assert() statements to indicate that 380309fe6143Sdrh ** the assert is only valid on a well-formed database. Instead of: 380409fe6143Sdrh ** 380509fe6143Sdrh ** assert( X ); 380609fe6143Sdrh ** 380709fe6143Sdrh ** One writes: 380809fe6143Sdrh ** 3809b2023665Sdrh ** assert( X || CORRUPT_DB ); 381009fe6143Sdrh ** 3811b2023665Sdrh ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate 3812b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt. 3813b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special 3814b2023665Sdrh ** sqlite3_test_control(). This enables assert() statements to prove 3815b2023665Sdrh ** things that are always true for well-formed databases. 381609fe6143Sdrh */ 3817b2023665Sdrh #define CORRUPT_DB (sqlite3Config.neverCorrupt==0) 381809fe6143Sdrh 381909fe6143Sdrh /* 38207d10d5a6Sdrh ** Context pointer passed down through the tree-walk. 38217d10d5a6Sdrh */ 38227d10d5a6Sdrh struct Walker { 38239bfb024dSdrh Parse *pParse; /* Parser context. */ 38247d10d5a6Sdrh int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 38257d10d5a6Sdrh int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 3826b290f117Sdan void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */ 3827030796dfSdrh int walkerDepth; /* Number of subqueries */ 3828dfa15270Sdrh u16 eCode; /* A small processing code */ 38297d10d5a6Sdrh union { /* Extra data for callback */ 38307d10d5a6Sdrh NameContext *pNC; /* Naming context */ 3831059b2d50Sdrh int n; /* A counter */ 3832059b2d50Sdrh int iCur; /* A cursor number */ 3833374fdce4Sdrh SrcList *pSrcList; /* FROM clause */ 3834030796dfSdrh struct SrcCount *pSrcCount; /* Counting column references */ 38352f2b0278Sdrh struct CCurHint *pCCurHint; /* Used by codeCursorHint() */ 38362a0b527bSdrh int *aiCol; /* array of column indexes */ 38372409f8a1Sdrh struct IdxCover *pIdxCover; /* Check for index coverage */ 3838cd0abc24Sdrh struct IdxExprTrans *pIdxTrans; /* Convert idxed expr to column */ 3839ab31a845Sdan ExprList *pGroupBy; /* GROUP BY clause */ 3840cd0abc24Sdrh Select *pSelect; /* HAVING to WHERE clause ctx */ 384186fb6e17Sdan struct WindowRewrite *pRewrite; /* Window rewrite context */ 3842660ee556Sdrh struct WhereConst *pConst; /* WHERE clause constants */ 3843cf8f2895Sdan struct RenameCtx *pRename; /* RENAME COLUMN context */ 3844dfa15270Sdrh struct Table *pTab; /* Table of generated column */ 38457601294aSdrh SrcItem *pSrcItem; /* A single FROM clause item */ 3846f380c3f1Sdan DbFixer *pFix; 38477d10d5a6Sdrh } u; 38487d10d5a6Sdrh }; 38497d10d5a6Sdrh 3850f380c3f1Sdan /* 3851f380c3f1Sdan ** The following structure contains information used by the sqliteFix... 3852f380c3f1Sdan ** routines as they walk the parse tree to make database references 3853f380c3f1Sdan ** explicit. 3854f380c3f1Sdan */ 3855f380c3f1Sdan struct DbFixer { 3856f380c3f1Sdan Parse *pParse; /* The parsing context. Error messages written here */ 3857f380c3f1Sdan Walker w; /* Walker object */ 3858f380c3f1Sdan Schema *pSchema; /* Fix items to this schema */ 3859f380c3f1Sdan u8 bTemp; /* True for TEMP schema entries */ 3860f380c3f1Sdan const char *zDb; /* Make sure all objects are contained in this database */ 3861f380c3f1Sdan const char *zType; /* Type of the container - used for error messages */ 3862f380c3f1Sdan const Token *pName; /* Name of the container - used for error messages */ 3863f380c3f1Sdan }; 3864f380c3f1Sdan 38657d10d5a6Sdrh /* Forward declarations */ 38667d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*); 38677d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*); 38687d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*); 38697d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*); 38707d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*); 38715b88bc4bSdrh int sqlite3ExprWalkNoop(Walker*, Expr*); 3872979dd1beSdrh int sqlite3SelectWalkNoop(Walker*, Select*); 38737e6f980bSdrh int sqlite3SelectWalkFail(Walker*, Select*); 3874e40cc16bSdrh int sqlite3WalkerDepthIncrease(Walker*,Select*); 3875e40cc16bSdrh void sqlite3WalkerDepthDecrease(Walker*,Select*); 3876e40cc16bSdrh 3877979dd1beSdrh #ifdef SQLITE_DEBUG 3878979dd1beSdrh void sqlite3SelectWalkAssert2(Walker*, Select*); 3879979dd1beSdrh #endif 38807d10d5a6Sdrh 38817d10d5a6Sdrh /* 38827d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their 38837d10d5a6Sdrh ** callbacks. 38847d10d5a6Sdrh */ 38852bf90f1eSdrh #define WRC_Continue 0 /* Continue down into children */ 38862bf90f1eSdrh #define WRC_Prune 1 /* Omit children but continue walking siblings */ 38872bf90f1eSdrh #define WRC_Abort 2 /* Abandon the tree walk */ 38887d10d5a6Sdrh 38897d10d5a6Sdrh /* 3890f824b41eSdrh ** A single common table expression 38917d562dbeSdan */ 3892f824b41eSdrh struct Cte { 38934e9119d9Sdan char *zName; /* Name of this CTE */ 38944e9119d9Sdan ExprList *pCols; /* List of explicit column names, or NULL */ 3895c49832c2Sdrh Select *pSelect; /* The definition of this CTE */ 38960576bc59Sdrh const char *zCteErr; /* Error message for circular references */ 3897*a79e2a2dSdrh CteUse *pUse; /* Usage information for this CTE */ 3898f824b41eSdrh }; 3899f824b41eSdrh 3900f824b41eSdrh /* 3901f824b41eSdrh ** An instance of the With object represents a WITH clause containing 3902f824b41eSdrh ** one or more CTEs (common table expressions). 3903f824b41eSdrh */ 3904f824b41eSdrh struct With { 3905f824b41eSdrh int nCte; /* Number of CTEs in the WITH clause */ 3906f824b41eSdrh With *pOuter; /* Containing WITH clause, or NULL */ 3907f824b41eSdrh Cte a[1]; /* For each CTE in the WITH clause.... */ 39087d562dbeSdan }; 39097d562dbeSdan 3910*a79e2a2dSdrh /* 3911*a79e2a2dSdrh ** The Cte object is not guaranteed to persist for the entire duration 3912*a79e2a2dSdrh ** of code generation. (The query flattener or other parser tree 3913*a79e2a2dSdrh ** edits might delete it.) The following object records information 3914*a79e2a2dSdrh ** about each Common Table Expression that must be preserved for the 3915*a79e2a2dSdrh ** duration of the parse. 3916*a79e2a2dSdrh ** 3917*a79e2a2dSdrh ** The CteUse objects are freed using sqlite3ParserAddCleanup() rather 3918*a79e2a2dSdrh ** than sqlite3SelectDelete(), which is what enables them to persist 3919*a79e2a2dSdrh ** until the end of code generation. 3920*a79e2a2dSdrh */ 3921*a79e2a2dSdrh struct CteUse { 3922*a79e2a2dSdrh int nUse; /* Number of users of this CTE */ 3923*a79e2a2dSdrh int addrM9e; /* Start of subroutine to compute materialization */ 3924*a79e2a2dSdrh int regRtn; /* Return address register for addrM9e subroutine */ 3925*a79e2a2dSdrh int iCur; /* Ephemeral table holding the materialization */ 3926*a79e2a2dSdrh LogEst nRowEst; /* Estimated number of rows in the table */ 3927*a79e2a2dSdrh }; 3928*a79e2a2dSdrh 3929*a79e2a2dSdrh 39304fa4a54fSdrh #ifdef SQLITE_DEBUG 39314fa4a54fSdrh /* 39324fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of 39334fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view. 39344fa4a54fSdrh */ 39354fa4a54fSdrh struct TreeView { 39364fa4a54fSdrh int iLevel; /* Which level of the tree we are on */ 3937b08cd3f3Sdrh u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */ 39384fa4a54fSdrh }; 39394fa4a54fSdrh #endif /* SQLITE_DEBUG */ 39404fa4a54fSdrh 39419a94722dSdan /* 3942df9d3244Sdan ** This object is used in various ways, most (but not all) related to window 3943df9d3244Sdan ** functions. 3944a1fd4b52Sdrh ** 3945a1fd4b52Sdrh ** (1) A single instance of this structure is attached to the 3946df9d3244Sdan ** the Expr.y.pWin field for each window function in an expression tree. 3947a1fd4b52Sdrh ** This object holds the information contained in the OVER clause, 3948a1fd4b52Sdrh ** plus additional fields used during code generation. 3949a1fd4b52Sdrh ** 3950a1fd4b52Sdrh ** (2) All window functions in a single SELECT form a linked-list 3951a1fd4b52Sdrh ** attached to Select.pWin. The Window.pFunc and Window.pExpr 3952a1fd4b52Sdrh ** fields point back to the expression that is the window function. 3953a1fd4b52Sdrh ** 3954a1fd4b52Sdrh ** (3) The terms of the WINDOW clause of a SELECT are instances of this 3955a1fd4b52Sdrh ** object on a linked list attached to Select.pWinDefn. 3956a1fd4b52Sdrh ** 3957df9d3244Sdan ** (4) For an aggregate function with a FILTER clause, an instance 3958df9d3244Sdan ** of this object is stored in Expr.y.pWin with eFrmType set to 3959df9d3244Sdan ** TK_FILTER. In this case the only field used is Window.pFilter. 3960df9d3244Sdan ** 3961a1fd4b52Sdrh ** The uses (1) and (2) are really the same Window object that just happens 3962fc15f4c5Sdrh ** to be accessible in two different ways. Use case (3) are separate objects. 39639a94722dSdan */ 396486fb6e17Sdan struct Window { 3965e3bf632cSdan char *zName; /* Name of window (may be NULL) */ 3966e7c9ca41Sdan char *zBase; /* Name of base window for chaining (may be NULL) */ 3967e3bf632cSdan ExprList *pPartition; /* PARTITION BY clause */ 3968e3bf632cSdan ExprList *pOrderBy; /* ORDER BY clause */ 3969fc15f4c5Sdrh u8 eFrmType; /* TK_RANGE, TK_GROUPS, TK_ROWS, or 0 */ 397086fb6e17Sdan u8 eStart; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 397186fb6e17Sdan u8 eEnd; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 3972e7c9ca41Sdan u8 bImplicitFrame; /* True if frame was implicitly specified */ 3973fc15f4c5Sdrh u8 eExclude; /* TK_NO, TK_CURRENT, TK_TIES, TK_GROUP, or 0 */ 397486fb6e17Sdan Expr *pStart; /* Expression for "<expr> PRECEDING" */ 397586fb6e17Sdan Expr *pEnd; /* Expression for "<expr> FOLLOWING" */ 397675b0821eSdan Window **ppThis; /* Pointer to this object in Select.pWin list */ 397786fb6e17Sdan Window *pNextWin; /* Next window function belonging to this SELECT */ 3978a1fd4b52Sdrh Expr *pFilter; /* The FILTER expression */ 3979a1fd4b52Sdrh FuncDef *pFunc; /* The function */ 3980b0225bc5Sdrh int iEphCsr; /* Partition buffer or Peer buffer */ 3981d44c617aSdrh int regAccum; /* Accumulator */ 3982d44c617aSdrh int regResult; /* Interim result */ 3983c9a8668aSdan int csrApp; /* Function cursor (used by min/max) */ 3984c9a8668aSdan int regApp; /* Function register (also used by min/max) */ 3985b6f2deacSdan int regPart; /* Array of registers for PARTITION BY values */ 398686fb6e17Sdan Expr *pOwner; /* Expression object this window is attached to */ 398786fb6e17Sdan int nBufferCol; /* Number of columns in buffer table */ 398886fb6e17Sdan int iArgCol; /* Offset of first argument for this function */ 3989bf84515aSdan int regOne; /* Register containing constant value 1 */ 3990a0f6b833Sdan int regStartRowid; 3991a0f6b833Sdan int regEndRowid; 3992d44c617aSdrh u8 bExprArgs; /* Defer evaluation of window function arguments 3993d44c617aSdrh ** due to the SQLITE_SUBTYPE flag */ 399486fb6e17Sdan }; 399586fb6e17Sdan 399667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 399786fb6e17Sdan void sqlite3WindowDelete(sqlite3*, Window*); 3998e2094572Sdrh void sqlite3WindowUnlinkFromSelect(Window*); 3999e3bf632cSdan void sqlite3WindowListDelete(sqlite3 *db, Window *p); 4000d35300f9Sdan Window *sqlite3WindowAlloc(Parse*, int, int, Expr*, int , Expr*, u8); 400186fb6e17Sdan void sqlite3WindowAttach(Parse*, Expr*, Window*); 4002a3fcc000Sdan void sqlite3WindowLink(Select *pSel, Window *pWin); 40034f9adee2Sdan int sqlite3WindowCompare(Parse*, Window*, Window*, int); 40044ea562eeSdan void sqlite3WindowCodeInit(Parse*, Select*); 4005dacf1de9Sdan void sqlite3WindowCodeStep(Parse*, Select*, WhereInfo*, int, int); 4006dfa552f4Sdan int sqlite3WindowRewrite(Parse*, Select*); 4007e3bf632cSdan void sqlite3WindowUpdate(Parse*, Window*, Window*, FuncDef*); 40082a11bb23Sdan Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p); 4009c95f38d4Sdan Window *sqlite3WindowListDup(sqlite3 *db, Window *p); 40109a94722dSdan void sqlite3WindowFunctions(void); 4011e7c9ca41Sdan void sqlite3WindowChain(Parse*, Window*, Window*); 4012e7c9ca41Sdan Window *sqlite3WindowAssemble(Parse*, Window*, ExprList*, ExprList*, Token*); 401367a9b8edSdan #else 401467a9b8edSdan # define sqlite3WindowDelete(a,b) 401567a9b8edSdan # define sqlite3WindowFunctions() 401667a9b8edSdan # define sqlite3WindowAttach(a,b,c) 401767a9b8edSdan #endif 401886fb6e17Sdan 40197d562dbeSdan /* 402066150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character, 402166150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character. 40224a919118Sdrh */ 40234a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) { \ 40244a919118Sdrh if( (*(zIn++))>=0xc0 ){ \ 40254a919118Sdrh while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 40264a919118Sdrh } \ 40274a919118Sdrh } 40284a919118Sdrh 40294a919118Sdrh /* 40309978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with 40319978c97eSdrh ** the same name but without the _BKPT suffix. These macros invoke 40329978c97eSdrh ** routines that report the line-number on which the error originated 40339978c97eSdrh ** using sqlite3_log(). The routines also provide a convenient place 40349978c97eSdrh ** to set a debugger breakpoint. 403549285708Sdrh */ 4036eebf2f57Sdan int sqlite3ReportError(int iErr, int lineno, const char *zType); 40379978c97eSdrh int sqlite3CorruptError(int); 40389978c97eSdrh int sqlite3MisuseError(int); 40399978c97eSdrh int sqlite3CantopenError(int); 40409978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 40419978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 40429978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 404332c49904Sdrh #ifdef SQLITE_DEBUG 404432c49904Sdrh int sqlite3NomemError(int); 404532c49904Sdrh int sqlite3IoerrnomemError(int); 4046fad3039cSmistachkin # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__) 4047fad3039cSmistachkin # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__) 404832c49904Sdrh #else 404932c49904Sdrh # define SQLITE_NOMEM_BKPT SQLITE_NOMEM 405032c49904Sdrh # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM 40513cdc8205Sdan #endif 40523cdc8205Sdan #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO) 40533cdc8205Sdan int sqlite3CorruptPgnoError(int,Pgno); 40543cdc8205Sdan # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P)) 40553cdc8205Sdan #else 4056cc97ca4cSdrh # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__) 405732c49904Sdrh #endif 40589978c97eSdrh 40594553f6eaSdrh /* 40604553f6eaSdrh ** FTS3 and FTS4 both require virtual table support 40614553f6eaSdrh */ 40624553f6eaSdrh #if defined(SQLITE_OMIT_VIRTUALTABLE) 40634553f6eaSdrh # undef SQLITE_ENABLE_FTS3 40644553f6eaSdrh # undef SQLITE_ENABLE_FTS4 40654553f6eaSdrh #endif 406649285708Sdrh 406749285708Sdrh /* 4068b4a1fed2Sdrh ** FTS4 is really an extension for FTS3. It is enabled using the 406960ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call 407060ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3. 4071b4a1fed2Sdrh */ 4072b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 40730ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1 4074b4a1fed2Sdrh #endif 4075b4a1fed2Sdrh 4076b4a1fed2Sdrh /* 407779f02cefSdrh ** The ctype.h header is needed for non-ASCII systems. It is also 407879f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation. 407979f02cefSdrh */ 408079f02cefSdrh #if !defined(SQLITE_ASCII) || \ 408179f02cefSdrh (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 408279f02cefSdrh # include <ctype.h> 408379f02cefSdrh #endif 408479f02cefSdrh 408579f02cefSdrh /* 408678ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(), 408778ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 408878ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale. 408978ca0e7eSdanielk1977 */ 409078ca0e7eSdanielk1977 #ifdef SQLITE_ASCII 409178ca0e7eSdanielk1977 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 409278ca0e7eSdanielk1977 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 4093dc86e2b2Sdrh # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 4094dc86e2b2Sdrh # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 409578ca0e7eSdanielk1977 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 409678ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 409778ca0e7eSdanielk1977 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 4098244b9d6eSdrh # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80) 409978ca0e7eSdanielk1977 #else 410078ca0e7eSdanielk1977 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 410178ca0e7eSdanielk1977 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 410278ca0e7eSdanielk1977 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 4103dc86e2b2Sdrh # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 410478ca0e7eSdanielk1977 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 410578ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 410678ca0e7eSdanielk1977 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 4107244b9d6eSdrh # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`') 410878ca0e7eSdanielk1977 #endif 410997348b37Sdrh int sqlite3IsIdChar(u8); 411078ca0e7eSdanielk1977 411178ca0e7eSdanielk1977 /* 411275897234Sdrh ** Internal function prototypes 411375897234Sdrh */ 411480738d9cSdrh int sqlite3StrICmp(const char*,const char*); 4115ea678832Sdrh int sqlite3Strlen30(const char*); 41167301e774Sdrh #define sqlite3Strlen30NN(C) (strlen(C)&0x3fffffff) 4117d7564865Sdrh char *sqlite3ColumnType(Column*,char*); 4118ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp 41192e588c75Sdanielk1977 412040257ffdSdrh int sqlite3MallocInit(void); 4121fec00eabSdrh void sqlite3MallocEnd(void); 4122da4ca9d1Sdrh void *sqlite3Malloc(u64); 4123da4ca9d1Sdrh void *sqlite3MallocZero(u64); 4124da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64); 4125da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64); 4126575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3*, u64); 412717435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*); 4128da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64); 41299b2e0435Sdrh char *sqlite3DbSpanDup(sqlite3*,const char*,const char*); 4130da4ca9d1Sdrh void *sqlite3Realloc(void*, u64); 4131da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64); 4132da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64); 4133633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*); 4134dbd6a7dcSdrh void sqlite3DbFreeNN(sqlite3*, void*); 4135a7a8e14bSdanielk1977 int sqlite3MallocSize(void*); 4136633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*); 4137facf0307Sdrh void *sqlite3PageMalloc(int); 4138facf0307Sdrh void sqlite3PageFree(void*); 4139fec00eabSdrh void sqlite3MemSetDefault(void); 4140d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 4141171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 4142f5ed7ad6Sdrh #endif 414350d1b5f3Sdrh int sqlite3HeapNearlyFull(void); 41442e588c75Sdanielk1977 4145e7b34707Sdrh /* 4146e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make 4147e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects. By default, 4148e7b34707Sdrh ** obtain space from malloc(). 4149e7b34707Sdrh ** 4150e7b34707Sdrh ** The alloca() routine never returns NULL. This will cause code paths 4151e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable. 4152e7b34707Sdrh */ 4153e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA 4154e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) alloca(N) 4155e7b34707Sdrh # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 4156e7b34707Sdrh # define sqlite3StackFree(D,P) 4157e7b34707Sdrh #else 4158e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 4159e7b34707Sdrh # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 4160e7b34707Sdrh # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 4161e7b34707Sdrh #endif 4162e7b34707Sdrh 41635d513ba0Sdrh /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they 41645d513ba0Sdrh ** are, disable MEMSYS3 41655d513ba0Sdrh */ 4166f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5 4167f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 41685d513ba0Sdrh #undef SQLITE_ENABLE_MEMSYS3 41695d513ba0Sdrh #endif 41705d513ba0Sdrh #ifdef SQLITE_ENABLE_MEMSYS3 41715d513ba0Sdrh const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 4172f3d3c27aSdanielk1977 #endif 4173f3d3c27aSdanielk1977 4174f3d3c27aSdanielk1977 417518472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT 4176558814f8Sdan sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 4177558814f8Sdan sqlite3_mutex_methods const *sqlite3NoopMutex(void); 417859f8c08eSdanielk1977 sqlite3_mutex *sqlite3MutexAlloc(int); 4179d025174fSdanielk1977 int sqlite3MutexInit(void); 4180d025174fSdanielk1977 int sqlite3MutexEnd(void); 418165bbf29eSdrh #endif 41820e8729dbSdrh #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP) 41836081c1dbSdrh void sqlite3MemoryBarrier(void); 41840e8729dbSdrh #else 418504abf087Smistachkin # define sqlite3MemoryBarrier() 4186f7141990Sdrh #endif 4187f7141990Sdrh 4188af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int); 4189af89fe66Sdrh void sqlite3StatusUp(int, int); 4190af89fe66Sdrh void sqlite3StatusDown(int, int); 4191b02392e6Sdrh void sqlite3StatusHighwater(int, int); 419252fb8e19Sdrh int sqlite3LookasideUsed(sqlite3*,int*); 4193f7141990Sdrh 4194af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */ 4195af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void); 4196af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void); 4197af89fe66Sdrh 419861f8e86fSdan #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT) 41998385becfSdan void sqlite3MutexWarnOnContention(sqlite3_mutex*); 42008385becfSdan #else 42018385becfSdan # define sqlite3MutexWarnOnContention(x) 42028385becfSdan #endif 42038385becfSdan 420485c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT 420505921223Sdrh # define EXP754 (((u64)0x7ff)<<52) 420605921223Sdrh # define MAN754 ((((u64)1)<<52)-1) 420705921223Sdrh # define IsNaN(X) (((X)&EXP754)==EXP754 && ((X)&MAN754)!=0) 42080de3ae95Sdrh int sqlite3IsNaN(double); 420985c8f291Sdrh #else 421005921223Sdrh # define IsNaN(X) 0 421185c8f291Sdrh # define sqlite3IsNaN(X) 0 421285c8f291Sdrh #endif 42130de3ae95Sdrh 4214a5c1416dSdrh /* 4215a5c1416dSdrh ** An instance of the following structure holds information about SQL 4216a5c1416dSdrh ** functions arguments that are the parameters to the printf() function. 4217a5c1416dSdrh */ 4218a5c1416dSdrh struct PrintfArguments { 4219a5c1416dSdrh int nArg; /* Total number of arguments */ 4220a5c1416dSdrh int nUsed; /* Number of arguments used so far */ 4221a5c1416dSdrh sqlite3_value **apArg; /* The argument values */ 4222a5c1416dSdrh }; 4223a5c1416dSdrh 422417435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...); 422517435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 422602b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE) 4227e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...); 4228d919fe17Sdrh #endif 4229d919fe17Sdrh #if defined(SQLITE_TEST) 4230e8f52c50Sdrh void *sqlite3TestTextToPtr(const char*); 423187cc3b31Sdrh #endif 42327e02e5e6Sdrh 42334fa4a54fSdrh #if defined(SQLITE_DEBUG) 42344fa4a54fSdrh void sqlite3TreeViewExpr(TreeView*, const Expr*, u8); 4235db97e562Sdrh void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*); 42364fa4a54fSdrh void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*); 4237145d0a35Sdrh void sqlite3TreeViewSrcList(TreeView*, const SrcList*); 42384fa4a54fSdrh void sqlite3TreeViewSelect(TreeView*, const Select*, u8); 42392476a6f2Sdrh void sqlite3TreeViewWith(TreeView*, const With*, u8); 4240a1fd4b52Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC 4241a1fd4b52Sdrh void sqlite3TreeViewWindow(TreeView*, const Window*, u8); 4242a1fd4b52Sdrh void sqlite3TreeViewWinFunc(TreeView*, const Window*, u8); 4243a1fd4b52Sdrh #endif 42447e02e5e6Sdrh #endif 42457e02e5e6Sdrh 42467e02e5e6Sdrh 424722c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*); 42484adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...); 4249c3dcdba3Sdrh int sqlite3ErrorToParser(sqlite3*,int); 4250244b9d6eSdrh void sqlite3Dequote(char*); 425151d35b0fSdrh void sqlite3DequoteExpr(Expr*); 425240aced5cSdrh void sqlite3TokenInit(Token*,char*); 42532646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int); 42544adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **); 425580242055Sdrh void sqlite3FinishCoding(Parse*); 4256892d3179Sdrh int sqlite3GetTempReg(Parse*); 4257892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int); 4258892d3179Sdrh int sqlite3GetTempRange(Parse*,int); 4259892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int); 4260cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*); 4261bb9b5f26Sdrh #ifdef SQLITE_DEBUG 4262bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse*,int,int); 4263bb9b5f26Sdrh #endif 4264b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 4265b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*); 4266b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 4267abfd35eaSdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*); 426808de4f79Sdrh void sqlite3PExprAddSelect(Parse*, Expr*, Select*); 4269d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse*,Expr*, Expr*); 427017180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr*); 4271954733b3Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*, int); 42720dfa5255Sdrh void sqlite3ExprFunctionUsable(Parse*,Expr*,FuncDef*); 4273de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32); 4274633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*); 42758e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse*, Expr*); 4276b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 4277a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*); 42786e11892dSdan void sqlite3ExprListSetSortOrder(ExprList*,int,int); 4279b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 42801be266baSdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*); 4281633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*); 42822308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*); 42838d40673cSdrh int sqlite3IndexHasDuplicateRootPage(Index*); 42849bb575fdSdrh int sqlite3Init(sqlite3*, char**); 4285234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**); 4286987db767Sdan int sqlite3InitOne(sqlite3*, int, char**, u32); 428791cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 42882fcc1590Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 42892fcc1590Sdrh Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName); 42902fcc1590Sdrh #endif 429181028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*); 429281028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int); 429381028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*); 42949bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*); 429551be3873Sdrh void sqlite3DeleteColumnNames(sqlite3*,Table*); 42968981b904Sdrh int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**); 429781506b88Sdrh void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*,char); 429881506b88Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*,char); 4299346a70caSdrh void sqlite3OpenSchemaTable(Parse *, int); 43004415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*); 4301b9bcf7caSdrh i16 sqlite3TableColumnToIndex(Index*, i16); 430281f7b372Sdrh #ifdef SQLITE_OMIT_GENERATED_COLUMNS 4303b9bcf7caSdrh # define sqlite3TableColumnToStorage(T,X) (X) /* No-op pass-through */ 4304b9bcf7caSdrh # define sqlite3StorageColumnToTable(T,X) (X) /* No-op pass-through */ 430581f7b372Sdrh #else 4306b9bcf7caSdrh i16 sqlite3TableColumnToStorage(Table*, i16); 4307b9bcf7caSdrh i16 sqlite3StorageColumnToTable(Table*, i16); 430881f7b372Sdrh #endif 4309f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 4310e6110505Sdrh #if SQLITE_ENABLE_HIDDEN_COLUMNS 4311ba68f8f3Sdan void sqlite3ColumnPropertiesFromName(Table*, Column*); 4312e6110505Sdrh #else 4313e6110505Sdrh # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */ 4314e6110505Sdrh #endif 43152881ab62Sdrh void sqlite3AddColumn(Parse*,Token*,Token*); 43164adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int); 4317fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 431892e21ef0Sdrh void sqlite3AddCheckConstraint(Parse*, Expr*, const char*, const char*); 43191be266baSdrh void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*); 432039002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*); 432181f7b372Sdrh void sqlite3AddGenerated(Parse*,Expr*,Token*); 43225969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*); 43232053f313Sdrh void sqlite3AddReturning(Parse*,ExprList*); 4324522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*, 4325522c26fbSdrh sqlite3_vfs**,char**,char **); 4326e5989723Sdrh #define sqlite3CodecQueryParameters(A,B,C) 0 4327421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*); 4328b7f9164eSdrh 4329d12602a9Sdrh #ifdef SQLITE_UNTESTABLE 4330c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK 4331c007f61bSdrh #else 4332c007f61bSdrh int sqlite3FaultSim(int); 4333c007f61bSdrh #endif 4334c007f61bSdrh 4335f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32); 4336f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32); 433782ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32); 4338f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32); 4339e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*); 4340f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*); 4341bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*); 4342d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 43433088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*); 4344f5ed7ad6Sdrh #endif 4345f5e7bb51Sdrh 43469d67afc4Sdrh RowSet *sqlite3RowSetInit(sqlite3*); 43479d67afc4Sdrh void sqlite3RowSetDelete(void*); 43489d67afc4Sdrh void sqlite3RowSetClear(void*); 43493d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64); 4350d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64); 43513d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*); 43523d4501e5Sdrh 43538981b904Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int); 4354fe3fcbe2Sdanielk1977 4355fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 43564adee20fSdanielk1977 int sqlite3ViewGetColumnNames(Parse*,Table*); 4357b7f9164eSdrh #else 4358b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0 4359b7f9164eSdrh #endif 4360b7f9164eSdrh 4361a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30 4362a7ab6d81Sdrh int sqlite3DbMaskAllZero(yDbMask); 4363a7ab6d81Sdrh #endif 4364a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int); 4365faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int); 43661feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*); 4367cf8f2895Sdan void sqlite3FreeIndex(sqlite3*, Index*); 43680b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT 43690b9f50d8Sdrh void sqlite3AutoincrementBegin(Parse *pParse); 43700b9f50d8Sdrh void sqlite3AutoincrementEnd(Parse *pParse); 43710b9f50d8Sdrh #else 43720b9f50d8Sdrh # define sqlite3AutoincrementBegin(X) 43730b9f50d8Sdrh # define sqlite3AutoincrementEnd(X) 43740b9f50d8Sdrh #endif 437546d2e5c3Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int, Upsert*); 4376c1431144Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4377dd6cc9b5Sdrh void sqlite3ComputeGeneratedColumns(Parse*, int, Table*); 4378c1431144Sdrh #endif 43796c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*); 43805496d6a2Sdan IdList *sqlite3IdListAppend(Parse*, IdList*, Token*); 43814adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*); 438229c992cbSdrh SrcList *sqlite3SrcListEnlarge(Parse*, SrcList*, int, int); 438369887c99Sdan SrcList *sqlite3SrcListAppendList(Parse *pParse, SrcList *p1, SrcList *p2); 438429c992cbSdrh SrcList *sqlite3SrcListAppend(Parse*, SrcList*, Token*, Token*); 4385b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 438685574e31Sdanielk1977 Token*, Select*, Expr*, IdList*); 4387b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 438801d230ceSdrh void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*); 43897601294aSdrh int sqlite3IndexedByLookup(Parse *, SrcItem *); 439061dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*); 43914adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 4392633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*); 4393633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*); 4394bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**); 439562340f84Sdrh void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 439662340f84Sdrh Expr*, int, int, u8); 43974d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int); 43987d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*); 439917435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 44008c0833fbSdrh Expr*,ExprList*,u32,Expr*); 4401633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*); 44024adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*); 44034adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int); 4404c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 4405273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 44068c0833fbSdrh Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*); 44074281bd42Sshane #endif 44088c0833fbSdrh void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*); 4409eac9fabbSdrh void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*, 4410eac9fabbSdrh Upsert*); 441146ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int); 44124adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*); 4413c3489bbfSdrh LogEst sqlite3WhereOutputRowCount(WhereInfo*); 44146f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*); 44156f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*); 44166ee5a7b4Sdrh int sqlite3WhereOrderByLimitOptLabel(WhereInfo*); 4417d193057aSdrh void sqlite3WhereMinMaxOptEarlyOut(Vdbe*,WhereInfo*); 4418374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*); 44196f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*); 44206f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*); 4421fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*); 4422b0264eecSdrh #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */ 4423b0264eecSdrh #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */ 4424b0264eecSdrh #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */ 4425be3da241Sdrh int sqlite3WhereUsesDeferredSeek(WhereInfo*); 44261f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int); 4427a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8); 44286df9c4b9Sdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 4429b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int); 443005a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int); 4431e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4432e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(Parse*, Column*, int); 4433e70fa7feSdrh #endif 44341c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse*, Expr*, int); 443505a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int); 44369b258c54Sdrh int sqlite3ExprCodeRunJustOnce(Parse*, Expr*, int); 44372dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 4438678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int); 44395579d59fSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8); 4440d1a01edaSdrh #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */ 4441d1a01edaSdrh #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */ 44425579d59fSdrh #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */ 4443257c13faSdan #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */ 44444adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 44454adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 444672bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int); 44479bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*); 44484d249e61Sdrh #define LOCATE_VIEW 0x01 44494d249e61Sdrh #define LOCATE_NOERR 0x02 44504d249e61Sdrh Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*); 44517601294aSdrh Table *sqlite3LocateTableItem(Parse*,u32 flags,SrcItem *); 44529bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 44539bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 44549bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 44552f6239edSdrh void sqlite3Vacuum(Parse*,Token*,Expr*); 44562f6239edSdrh int sqlite3RunVacuum(char**, sqlite3*, int, sqlite3_value*); 445717435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*); 44585aa550cfSdan int sqlite3ExprCompare(Parse*,Expr*, Expr*, int); 4459f9463dfbSdrh int sqlite3ExprCompareSkip(Expr*, Expr*, int); 4460619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int); 44615aa550cfSdan int sqlite3ExprImpliesExpr(Parse*,Expr*, Expr*, int); 44622589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr*,int); 446389636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker*,Parse*); 4464d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 4465d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 44662409f8a1Sdrh int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx); 4467030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*); 44684adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*); 4469d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 44702fa1868fSdrh void sqlite3PrngSaveState(void); 44712fa1868fSdrh void sqlite3PrngRestoreState(void); 4472f5ed7ad6Sdrh #endif 44730f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int); 44744adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int); 447557966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb); 4476684917c2Sdrh void sqlite3BeginTransaction(Parse*, int); 447707a3b11aSdrh void sqlite3EndTransaction(Parse*,int); 4478fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*); 4479fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *); 44804245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*); 44810cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char*); 4482171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr*); 448396acafbeSdrh int sqlite3ExprTruthValue(const Expr*); 44844adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*); 44850a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*); 4486feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8); 4487ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*); 4488059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int); 4489ffc648cfSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS 44905b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr*); 4491ffc648cfSdrh #endif 44924adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*); 4493039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*); 4494039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 44954adee20fSdanielk1977 int sqlite3IsRowid(const char*); 4496f0ee1d3cSdan void sqlite3GenerateRowDelete( 4497f0ee1d3cSdan Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int); 4498f0ee1d3cSdan void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int); 44991c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int); 450087744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int); 4501e9816d82Sdrh int sqlite3ExprReferencesUpdatedColumn(Expr*,int*,int); 4502f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int, 4503788d55aaSdrh u8,u8,int,int*,int*,Upsert*); 4504d447dcedSdrh #ifdef SQLITE_ENABLE_NULL_TRIM 4505585ce192Sdrh void sqlite3SetMakeRecordP5(Vdbe*,Table*); 4506d447dcedSdrh #else 4507d447dcedSdrh # define sqlite3SetMakeRecordP5(A,B) 4508d447dcedSdrh #endif 450926198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int); 4510fd261ec6Sdan int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*); 45114adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int); 4512ff738bceSdrh void sqlite3MultiWrite(Parse*); 4513e0af83acSdan void sqlite3MayAbort(Parse*); 4514f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8); 4515f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*); 4516f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*); 45176ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 45186ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 45196ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 452017435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*); 45216ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int); 452219efd0dbSdrh FuncDef *sqlite3FunctionSearch(int,const char*); 452380738d9cSdrh void sqlite3InsertBuiltinFuncs(FuncDef*,int); 452480738d9cSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8); 452580738d9cSdrh void sqlite3RegisterBuiltinFunctions(void); 4526777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void); 452780738d9cSdrh void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*); 45287e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*); 45297e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*); 45309cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int); 4531fa4e62f3Sshane 4532fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 45338c0833fbSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int); 4534fa4e62f3Sshane #endif 4535b7f9164eSdrh 4536b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER 4537ef2cb63eSdanielk1977 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 453860218d2aSdrh Expr*,int, int); 45394adee20fSdanielk1977 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 4540fdd48a76Sdrh void sqlite3DropTrigger(Parse*, SrcList*, int); 454174161705Sdrh void sqlite3DropTriggerPtr(Parse*, Trigger*); 45422f886d1dSdanielk1977 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 45432f886d1dSdanielk1977 Trigger *sqlite3TriggerList(Parse *, Table *); 4544165921a7Sdan void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 454594d7f50aSdan int, int, int); 45461da40a38Sdan void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 4547dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 4548633e6d57Sdrh void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 4549f259df5fSdrh TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*, 4550f259df5fSdrh const char*,const char*); 45515be60c55Sdan TriggerStep *sqlite3TriggerInsertStep(Parse*,Token*, IdList*, 455246d2e5c3Sdrh Select*,u8,Upsert*, 45532c2e844aSdrh const char*,const char*); 4554e7877b2dSdan TriggerStep *sqlite3TriggerUpdateStep(Parse*,Token*,SrcList*,ExprList*, 4555e7877b2dSdan Expr*, u8, const char*,const char*); 45565be60c55Sdan TriggerStep *sqlite3TriggerDeleteStep(Parse*,Token*, Expr*, 4557f259df5fSdrh const char*,const char*); 4558633e6d57Sdrh void sqlite3DeleteTrigger(sqlite3*, Trigger*); 4559b7f9164eSdrh void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 4560bb5f168fSdan u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 4561e7877b2dSdan SrcList *sqlite3TriggerStepSrc(Parse*, TriggerStep*); 456265a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 4563c149f18fSdrh # define sqlite3IsToplevel(p) ((p)->pToplevel==0) 4564b7f9164eSdrh #else 456562c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0 4566633e6d57Sdrh # define sqlite3DeleteTrigger(A,B) 4567cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B) 4568b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 456994d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 457075cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 45712943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0 457265a7cd16Sdan # define sqlite3ParseToplevel(p) p 4573c149f18fSdrh # define sqlite3IsToplevel(p) 1 4574bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 4575e7877b2dSdan # define sqlite3TriggerStepSrc(A,B) 0 4576b7f9164eSdrh #endif 4577b7f9164eSdrh 45784adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 45796e6d9833Sdan int sqlite3ColumnIndex(Table *pTab, const char *zCol); 45808103a036Sdrh void sqlite3SetJoinExpr(Expr*,int); 45810202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 45824adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int); 4583ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 4584728b5779Sdrh void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 45854adee20fSdanielk1977 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 45864adee20fSdanielk1977 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 45874adee20fSdanielk1977 void sqlite3AuthContextPop(AuthContext*); 458802470b20Sdan int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 4589ed6c8671Sdrh #else 4590b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d) 45914adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 45924adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c) 45934adee20fSdanielk1977 # define sqlite3AuthContextPop(a) ((void)(a)) 4594ed6c8671Sdrh #endif 4595465c2b89Sdan int sqlite3DbIsNamed(sqlite3 *db, int iDb, const char *zName); 4596f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 4597f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*); 4598d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 45994adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*); 46004adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*); 46014adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*); 46024adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 46038a3884efSdrh int sqlite3RealSameAsInt(double,sqlite3_int64); 460482b0f106Sdrh void sqlite3Int64ToText(i64,char*); 46059339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8); 4606fec19aadSdrh int sqlite3GetInt32(const char *, int*); 4607abc38158Sdrh int sqlite3GetUInt32(const char*, u32*); 460860ac3f42Sdrh int sqlite3Atoi(const char*); 4609f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4610ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar); 4611f0f44b79Sdrh #endif 4612ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte); 461342610961Sdrh u32 sqlite3Utf8Read(const u8**); 4614bf539c4dSdrh LogEst sqlite3LogEst(u64); 4615bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst); 4616bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4617bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double); 4618bf539c4dSdrh #endif 461914bfd991Sdrh #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \ 4620175b8f06Sdrh defined(SQLITE_ENABLE_STAT4) || \ 4621d566c951Sdrh defined(SQLITE_EXPLAIN_ESTIMATED_ROWS) 4622bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst); 4623d566c951Sdrh #endif 46249bf755ccSdrh VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int); 46259bf755ccSdrh const char *sqlite3VListNumToName(VList*,int); 46269bf755ccSdrh int sqlite3VListNameToNum(VList*,const char*,int); 46273f8d5cfcSshane 46283f8d5cfcSshane /* 46293f8d5cfcSshane ** Routines to read and write variable-length integers. These used to 46303f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c 46312f2b2b85Sdrh ** file. 46323f8d5cfcSshane */ 4633192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64); 46341bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *); 46351bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *); 4636192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v); 46373f8d5cfcSshane 46383f8d5cfcSshane /* 46392f2b2b85Sdrh ** The common case is for a varint to be a single byte. They following 46402f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call 46412f2b2b85Sdrh ** the procedure for larger varints. 46423f8d5cfcSshane */ 46434bde3702Sdrh #define getVarint32(A,B) \ 46444bde3702Sdrh (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B))) 464502a95eb9Sdrh #define getVarint32NR(A,B) \ 464602a95eb9Sdrh B=(u32)*(A);if(B>=0x80)sqlite3GetVarint32((A),(u32*)&(B)) 46474bde3702Sdrh #define putVarint32(A,B) \ 46484bde3702Sdrh (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\ 46492f2b2b85Sdrh sqlite3PutVarint((A),(B))) 46503f8d5cfcSshane #define getVarint sqlite3GetVarint 46513f8d5cfcSshane #define putVarint sqlite3PutVarint 46523f8d5cfcSshane 46533f8d5cfcSshane 4654e9107698Sdrh const char *sqlite3IndexAffinityStr(sqlite3*, Index*); 465557bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int); 4656e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2); 4657e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity); 46580dfa4f6fSdrh char sqlite3TableColumnAffinity(Table*,int); 4659e7375bfaSdrh char sqlite3ExprAffinity(const Expr *pExpr); 46609339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8); 46619296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*); 466213f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...); 466313f40da3Sdrh void sqlite3Error(sqlite3*,int); 466488efc796Sdrh void sqlite3ErrorClear(sqlite3*); 46651b9f2141Sdrh void sqlite3SystemError(sqlite3*,int); 4666ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 4667cd74b611Sdan u8 sqlite3HexToInt(int h); 4668ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 4669dd08ca0fSmistachkin 46705824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME) 4671f2c1c99fSmistachkin const char *sqlite3ErrName(int); 4672dd08ca0fSmistachkin #endif 4673dd08ca0fSmistachkin 46749c6396ecSdrh #ifdef SQLITE_ENABLE_DESERIALIZE 4675ac442f41Sdrh int sqlite3MemdbInit(void); 4676ac442f41Sdrh #endif 4677ac442f41Sdrh 4678f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int); 46798a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse); 4680c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 4681efad2e23Sdrh int sqlite3IsBinary(const CollSeq*); 4682c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 468342a630b1Sdrh void sqlite3SetTextEncoding(sqlite3 *db, u8); 4684e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr); 4685e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr); 4686e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse*,const Expr*,const Expr*); 468780103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int); 46880a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*); 46890a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*); 46900d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr*); 46917cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *); 46920f1c2eb5Sdrh int sqlite3WritableSchema(sqlite3*); 4693c5a93d4cSdrh int sqlite3CheckObjectName(Parse*, const char*,const char*,const char*); 4694b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int); 4695158b9cb9Sdrh int sqlite3AddInt64(i64*,i64); 4696158b9cb9Sdrh int sqlite3SubInt64(i64*,i64); 4697158b9cb9Sdrh int sqlite3MulInt64(i64*,i64); 4698d50ffc41Sdrh int sqlite3AbsInt32(int); 469981cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES 470081cc5163Sdrh void sqlite3FileSuffix3(const char*, char*); 470181cc5163Sdrh #else 470281cc5163Sdrh # define sqlite3FileSuffix3(X,Y) 470381cc5163Sdrh #endif 4704eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8); 47054e6af134Sdanielk1977 4706b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8); 4707b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8); 4708b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 47091e536953Sdanielk1977 void(*)(void*)); 4710a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*); 47114e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*); 47120c8f4038Sdrh #ifndef SQLITE_UNTESTABLE 47130c8f4038Sdrh void sqlite3ResultIntReal(sqlite3_context*); 47140c8f4038Sdrh #endif 47151e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *); 4716f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4717b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 4718f0f44b79Sdrh #endif 47191e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 4720b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 472146c99e0fSdrh #ifndef SQLITE_AMALGAMATION 4722a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[]; 4723f19aa5faSdrh extern const char sqlite3StrBINARY[]; 47244e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[]; 472578ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[]; 4726075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 472780738d9cSdrh extern FuncDefHash sqlite3BuiltinFunctions; 4728f83dc1efSdrh #ifndef SQLITE_OMIT_WSD 4729ddb68e17Sdrh extern int sqlite3PendingByte; 473046c99e0fSdrh #endif 47319216de8aSdrh #endif /* SQLITE_AMALGAMATION */ 473235043cc3Sdrh #ifdef VDBE_PROFILE 473335043cc3Sdrh extern sqlite3_uint64 sqlite3NProfileCnt; 473435043cc3Sdrh #endif 4735abc38158Sdrh void sqlite3RootPageMoved(sqlite3*, int, Pgno, Pgno); 47364343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*); 4737545f587fSdrh void sqlite3AlterFunctions(void); 47389fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 4739cf8f2895Sdan void sqlite3AlterRenameColumn(Parse*, SrcList*, Token*, Token*); 47409fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *); 47412958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...); 4742ba968dbfSdrh void sqlite3ExpirePreparedStatements(sqlite3*, int); 474350ef6716Sdrh void sqlite3CodeRhsOfIN(Parse*, Expr*, int); 474485bcdce2Sdrh int sqlite3CodeSubselect(Parse*, Expr*); 47457d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*); 47467601294aSdrh int sqlite3ExpandSubquery(Parse*, SrcItem*); 4747923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p); 4748c4938ea2Sdrh int sqlite3MatchEName( 4749c4938ea2Sdrh const struct ExprList_item*, 4750c4938ea2Sdrh const char*, 4751c4938ea2Sdrh const char*, 4752c4938ea2Sdrh const char* 4753c4938ea2Sdrh ); 475474a07986Sdrh Bitmask sqlite3ExprColUsed(Expr*); 4755d44390c8Sdrh u8 sqlite3StrIHash(const char*); 47567d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*); 475701d230ceSdrh int sqlite3ResolveExprListNames(NameContext*, ExprList*); 47587d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 4759ee751fabSdrh int sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*); 47607d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 4761c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 476219a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *); 476319a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 47646e6d9833Sdan void sqlite3AlterDropColumn(Parse*, SrcList*, Token*); 476507e95233Sdan void *sqlite3RenameTokenMap(Parse*, void*, Token*); 476607e95233Sdan void sqlite3RenameTokenRemap(Parse*, void *pTo, void *pFrom); 47678900a48bSdan void sqlite3RenameExprUnmap(Parse*, Expr*); 4768e8ab40d2Sdan void sqlite3RenameExprlistUnmap(Parse*, ExprList*); 476979e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*); 47702e3a5a81Sdan char sqlite3AffinityType(const char*, Column*); 47719f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*); 4772783e159eSdrh int sqlite3InvokeBusyHandler(BusyHandler*); 4773ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*); 47740410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *); 4775cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB); 4776d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*); 477751147baaSdrh void sqlite3DefaultRowEst(Index*); 477855ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int); 4779d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 4780b6ee6607Sdrh void sqlite3SchemaClear(void *); 47811e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 4782e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 4783ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int); 47842ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*); 47852ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*); 47862ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*); 4787f9eae18bSdan KeyInfo *sqlite3KeyInfoFromExprList(Parse*, ExprList*, int, int); 47889105fd51Sdan int sqlite3HasExplicitNulls(Parse*, ExprList*); 4789f9eae18bSdan 47902ec2fb22Sdrh #ifdef SQLITE_DEBUG 47912ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*); 47922ec2fb22Sdrh #endif 4793771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 4794771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), 4795660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4796660af939Sdan void (*)(sqlite3_context*), 4797660af939Sdan void (*)(sqlite3_context*), 4798660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4799d2199f0fSdan FuncDestructor *pDestructor 4800d2199f0fSdan ); 480192011847Sdrh void sqlite3NoopDestructor(void*); 48024a642b60Sdrh void sqlite3OomFault(sqlite3*); 48034a642b60Sdrh void sqlite3OomClear(sqlite3*); 480454f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int); 4805ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *); 480669dab1d3Sdrh 4807c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int); 4808ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*); 48091013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int); 4810f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 48111e536953Sdanielk1977 48120410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *); 48130410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 48140410302eSdanielk1977 4815f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY 4816f9b2e05cSdan int sqlite3ExprCheckIN(Parse*, Expr*); 4817f9b2e05cSdan #else 4818f9b2e05cSdan # define sqlite3ExprCheckIN(x,y) SQLITE_OK 4819f9b2e05cSdan #endif 4820f9b2e05cSdan 4821175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 4822d66e5794Sdan int sqlite3Stat4ProbeSetValue( 4823d66e5794Sdan Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*); 4824b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**); 48257a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*); 4826b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**); 4827d66e5794Sdan char sqlite3IndexColumnAffinity(sqlite3*, Index*, int); 48289fecc546Sdrh #endif 48297a419235Sdan 483095bdbbbdSdrh /* 483195bdbbbdSdrh ** The interface to the LEMON-generated parser 483295bdbbbdSdrh */ 4833d26cc541Sdrh #ifndef SQLITE_AMALGAMATION 4834fb32c44eSdrh void *sqlite3ParserAlloc(void*(*)(u64), Parse*); 483595bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*)); 4836d26cc541Sdrh #endif 4837fb32c44eSdrh void sqlite3Parser(void*, int, Token); 483859ff4251Sdan int sqlite3ParserFallback(int); 4839ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH 4840ec424a5bSdrh int sqlite3ParserStackPeak(void*); 4841ec424a5bSdrh #endif 484295bdbbbdSdrh 48437aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*); 484469dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION 4845f1952c5dSdrh void sqlite3CloseExtensions(sqlite3*); 484669dab1d3Sdrh #else 484769dab1d3Sdrh # define sqlite3CloseExtensions(X) 484869dab1d3Sdrh #endif 4849e3026636Sdanielk1977 4850c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 4851abc38158Sdrh void sqlite3TableLock(Parse *, int, Pgno, u8, const char *); 4852c00da105Sdanielk1977 #else 4853c00da105Sdanielk1977 #define sqlite3TableLock(v,w,x,y,z) 4854c00da105Sdanielk1977 #endif 4855c00da105Sdanielk1977 485653c14021Sdrh #ifdef SQLITE_TEST 485753c14021Sdrh int sqlite3Utf8To8(unsigned char*); 485853c14021Sdrh #endif 485953c14021Sdrh 4860b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE 4861595a523aSdanielk1977 # define sqlite3VtabClear(Y) 48629dbee7dcSdanielk1977 # define sqlite3VtabSync(X,Y) SQLITE_OK 4863f9e7dda7Sdanielk1977 # define sqlite3VtabRollback(X) 4864f9e7dda7Sdanielk1977 # define sqlite3VtabCommit(X) 4865093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) 0 4866595a523aSdanielk1977 # define sqlite3VtabLock(X) 4867595a523aSdanielk1977 # define sqlite3VtabUnlock(X) 4868cc5979dbSdrh # define sqlite3VtabModuleUnref(D,X) 4869595a523aSdanielk1977 # define sqlite3VtabUnlockList(X) 4870a311b803Sdan # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK 4871c3c8dac7Sdrh # define sqlite3GetVTable(X,Y) ((VTable*)0) 4872b9bb7c18Sdrh #else 48731feeaed2Sdan void sqlite3VtabClear(sqlite3 *db, Table*); 4874bba02a95Sdan void sqlite3VtabDisconnect(sqlite3 *db, Table *p); 4875016f7811Sdan int sqlite3VtabSync(sqlite3 *db, Vdbe*); 4876f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db); 4877f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db); 4878595a523aSdanielk1977 void sqlite3VtabLock(VTable *); 4879595a523aSdanielk1977 void sqlite3VtabUnlock(VTable *); 4880cc5979dbSdrh void sqlite3VtabModuleUnref(sqlite3*,Module*); 4881595a523aSdanielk1977 void sqlite3VtabUnlockList(sqlite3*); 4882a311b803Sdan int sqlite3VtabSavepoint(sqlite3 *, int, int); 4883016f7811Sdan void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*); 4884c3c8dac7Sdrh VTable *sqlite3GetVTable(sqlite3*, Table*); 48852fcc1590Sdrh Module *sqlite3VtabCreateModule( 48862fcc1590Sdrh sqlite3*, 48872fcc1590Sdrh const char*, 48882fcc1590Sdrh const sqlite3_module*, 48892fcc1590Sdrh void*, 48902fcc1590Sdrh void(*)(void*) 48912fcc1590Sdrh ); 4892093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 4893b9bb7c18Sdrh #endif 4894070ae3beSdrh int sqlite3ReadOnlyShadowTables(sqlite3 *db); 4895527cbd4aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4896527cbd4aSdrh int sqlite3ShadowTableName(sqlite3 *db, const char *zName); 48973d863b5eSdrh int sqlite3IsShadowTableOf(sqlite3*,Table*,const char*); 4898527cbd4aSdrh #else 4899527cbd4aSdrh # define sqlite3ShadowTableName(A,B) 0 49003d863b5eSdrh # define sqlite3IsShadowTableOf(A,B,C) 0 4901527cbd4aSdrh #endif 490251be3873Sdrh int sqlite3VtabEponymousTableInit(Parse*,Module*); 490351be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3*,Module*); 49044f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*); 4905b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int); 4906b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*); 4907b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*); 4908b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*); 490978efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 49107e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*); 49119e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 4912595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *); 49131e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 491495a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*); 49155f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 49164a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 4917f30a969bSdrh void sqlite3ParserReset(Parse*); 4918*a79e2a2dSdrh void *sqlite3ParserAddCleanup(Parse*,void(*)(sqlite3*,void*),void*); 49198bee11a4Smistachkin #ifdef SQLITE_ENABLE_NORMALIZE 49201a6c2b1dSdrh char *sqlite3Normalize(Vdbe*, const char*); 49218bee11a4Smistachkin #endif 4922b900aaf3Sdrh int sqlite3Reprepare(Vdbe*); 4923b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 4924e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse*,const Expr*); 4925e7375bfaSdrh CollSeq *sqlite3BinaryCompareCollSeq(Parse *, const Expr*, const Expr*); 49261c514148Sdrh int sqlite3TempInMemory(const sqlite3*); 492728e5386fSdan const char *sqlite3JournalModename(int); 492806a2d825Sdan #ifndef SQLITE_OMIT_WAL 4929cdc1f049Sdan int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 4930b033d8b9Sdrh int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 493106a2d825Sdan #endif 49328b471863Sdrh #ifndef SQLITE_OMIT_CTE 4933f824b41eSdrh Cte *sqlite3CteNew(Parse*,Token*,ExprList*,Select*); 4934f824b41eSdrh void sqlite3CteDelete(sqlite3*,Cte*); 4935f824b41eSdrh With *sqlite3WithAdd(Parse*,With*,Cte*); 49367d562dbeSdan void sqlite3WithDelete(sqlite3*,With*); 4937b290f117Sdan void sqlite3WithPush(Parse*, With*, u8); 49384e9119d9Sdan #else 4939f824b41eSdrh # define sqlite3CteNew(P,T,E,S) ((void*)0) 4940f824b41eSdrh # define sqlite3CteDelete(D,C) 4941f824b41eSdrh # define sqlite3CteWithAdd(P,W,C) ((void*)0) 4942eede6a53Sdan # define sqlite3WithDelete(x,y) 4943f824b41eSdrh # define sqlite3WithPush(x,y,z) 49448b471863Sdrh #endif 494546d2e5c3Sdrh #ifndef SQLITE_OMIT_UPSERT 49462549e4ccSdrh Upsert *sqlite3UpsertNew(sqlite3*,ExprList*,Expr*,ExprList*,Expr*,Upsert*); 494746d2e5c3Sdrh void sqlite3UpsertDelete(sqlite3*,Upsert*); 494846d2e5c3Sdrh Upsert *sqlite3UpsertDup(sqlite3*,Upsert*); 4949e9c2e772Sdrh int sqlite3UpsertAnalyzeTarget(Parse*,SrcList*,Upsert*); 49502cc00423Sdan void sqlite3UpsertDoUpdate(Parse*,Upsert*,Table*,Index*,int); 495161e280adSdrh Upsert *sqlite3UpsertOfIndex(Upsert*,Index*); 495261e280adSdrh int sqlite3UpsertNextIsIPK(Upsert*); 495346d2e5c3Sdrh #else 49542549e4ccSdrh #define sqlite3UpsertNew(u,v,w,x,y,z) ((Upsert*)0) 495546d2e5c3Sdrh #define sqlite3UpsertDelete(x,y) 495646d2e5c3Sdrh #define sqlite3UpsertDup(x,y) ((Upsert*)0) 495761e280adSdrh #define sqlite3UpsertOfIndex(x,y) ((Upsert*)0) 495861e280adSdrh #define sqlite3UpsertNextIsIPK(x) 0 495946d2e5c3Sdrh #endif 496046d2e5c3Sdrh 4961d829335eSdanielk1977 496275cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by 496375cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 496475cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but 496575cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 496675cbd984Sdan ** this case foreign keys are parsed, but no other functionality is 496775cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system). 496875cbd984Sdan */ 496975cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 49708ff2d956Sdan void sqlite3FkCheck(Parse*, Table*, int, int, int*, int); 4971d66c8309Sdan void sqlite3FkDropTable(Parse*, SrcList *, Table*); 49728ff2d956Sdan void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int); 4973e7a94d81Sdan int sqlite3FkRequired(Parse*, Table*, int*, int); 4974e7a94d81Sdan u32 sqlite3FkOldmask(Parse*, Table*); 4975432cc5b9Sdan FKey *sqlite3FkReferences(Table *); 49761da40a38Sdan #else 49778ff2d956Sdan #define sqlite3FkActions(a,b,c,d,e,f) 497867896cefSdan #define sqlite3FkCheck(a,b,c,d,e,f) 4979d66c8309Sdan #define sqlite3FkDropTable(a,b,c) 4980e7a94d81Sdan #define sqlite3FkOldmask(a,b) 0 498167896cefSdan #define sqlite3FkRequired(a,b,c,d) 0 4982e7eeeb99Sdan #define sqlite3FkReferences(a) 0 49831da40a38Sdan #endif 498475cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY 49851feeaed2Sdan void sqlite3FkDelete(sqlite3 *, Table*); 49866c5b915fSdrh int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**); 498775cbd984Sdan #else 49881feeaed2Sdan #define sqlite3FkDelete(a,b) 49896c5b915fSdrh #define sqlite3FkLocateIndex(a,b,c,d,e) 499075cbd984Sdan #endif 499175cbd984Sdan 4992643167ffSdrh 4993643167ffSdrh /* 4994643167ffSdrh ** Available fault injectors. Should be numbered beginning with 0. 4995643167ffSdrh */ 4996643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC 0 49977e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT 1 4998643167ffSdrh 4999643167ffSdrh /* 5000ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign" 5001d12602a9Sdrh ** malloc failures. This is only present if SQLITE_UNTESTABLE 5002ef05f2dfSdanielk1977 ** is not defined. 5003643167ffSdrh */ 5004d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 50052d1d86fbSdanielk1977 void sqlite3BeginBenignMalloc(void); 50062d1d86fbSdanielk1977 void sqlite3EndBenignMalloc(void); 5007643167ffSdrh #else 50082d1d86fbSdanielk1977 #define sqlite3BeginBenignMalloc() 5009867d05a0Sdanielk1977 #define sqlite3EndBenignMalloc() 5010643167ffSdrh #endif 5011643167ffSdrh 50123a85625dSdrh /* 50133a85625dSdrh ** Allowed return values from sqlite3FindInIndex() 50143a85625dSdrh */ 50153a85625dSdrh #define IN_INDEX_ROWID 1 /* Search the rowid of the table */ 50163a85625dSdrh #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */ 50173a85625dSdrh #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */ 50183a85625dSdrh #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */ 5019bb53ecb1Sdrh #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */ 50203a85625dSdrh /* 50213a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex(). 50223a85625dSdrh */ 5023bb53ecb1Sdrh #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */ 5024bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */ 5025bb53ecb1Sdrh #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */ 50262c04131cSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*, int*); 50279a96b668Sdanielk1977 5028c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 5029c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *); 5030d67a9770Sdan #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \ 5031d67a9770Sdan || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 5032f55b8998Sdanielk1977 int sqlite3JournalCreate(sqlite3_file *); 5033c7b6017cSdanielk1977 #endif 5034c7b6017cSdanielk1977 50352491de28Sdan int sqlite3JournalIsInMemory(sqlite3_file *p); 5036b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *); 5037b3175389Sdanielk1977 50382308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p); 50390224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 5040fc976065Sdanielk1977 int sqlite3SelectExprHeight(Select *); 50417d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse*, int); 5042fc976065Sdanielk1977 #else 50430224d26dSdrh #define sqlite3SelectExprHeight(x) 0 50447d10d5a6Sdrh #define sqlite3ExprCheckHeight(x,y) 5045fc976065Sdanielk1977 #endif 5046fc976065Sdanielk1977 5047a3152895Sdrh u32 sqlite3Get4byte(const u8*); 5048a3152895Sdrh void sqlite3Put4byte(u8*, u32); 5049a3152895Sdrh 5050404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 5051404ca075Sdanielk1977 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 5052404ca075Sdanielk1977 void sqlite3ConnectionUnlocked(sqlite3 *db); 5053404ca075Sdanielk1977 void sqlite3ConnectionClosed(sqlite3 *db); 5054404ca075Sdanielk1977 #else 5055404ca075Sdanielk1977 #define sqlite3ConnectionBlocked(x,y) 5056404ca075Sdanielk1977 #define sqlite3ConnectionUnlocked(x) 5057404ca075Sdanielk1977 #define sqlite3ConnectionClosed(x) 5058404ca075Sdanielk1977 #endif 5059404ca075Sdanielk1977 50606e736838Sdrh #ifdef SQLITE_DEBUG 50616e736838Sdrh void sqlite3ParserTrace(FILE*, char *); 50626e736838Sdrh #endif 50630d9de99cSdrh #if defined(YYCOVERAGE) 50640d9de99cSdrh int sqlite3ParserCoverage(FILE*); 50650d9de99cSdrh #endif 50666e736838Sdrh 5067b0603416Sdrh /* 5068b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable 50693a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to 5070b0603416Sdrh ** print I/O tracing messages. 5071b0603416Sdrh */ 5072b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE 50733a00f907Smlcreech # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 5074b4622b60Sdanielk1977 void sqlite3VdbeIOTraceSql(Vdbe*); 50759871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...); 5076b0603416Sdrh #else 5077b0603416Sdrh # define IOTRACE(A) 5078b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X) 5079b0603416Sdrh #endif 5080b0603416Sdrh 5081107b56e8Sdrh /* 5082107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator 5083107b56e8Sdrh ** only. They are used to verify that different "types" of memory 5084107b56e8Sdrh ** allocations are properly tracked by the system. 5085107b56e8Sdrh ** 5086107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 5087107b56e8Sdrh ** the MEMTYPE_* macros defined below. The type must be a bitmask with 5088107b56e8Sdrh ** a single bit set. 5089107b56e8Sdrh ** 5090107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second 5091107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5092107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 5093107b56e8Sdrh ** 5094174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second 5095174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5096107b56e8Sdrh ** 5097107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP 5098174b9a16Sdrh ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 5099174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was 5100174b9a16Sdrh ** too large or lookaside was already full. It is important to verify 5101174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not 5102174b9a16Sdrh ** passed back to non-lookaside free() routines. Asserts such as the 5103174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify 5104174b9a16Sdrh ** this constraint. 5105107b56e8Sdrh ** 5106107b56e8Sdrh ** All of this is no-op for a production build. It only comes into 5107107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used. 5108107b56e8Sdrh */ 5109107b56e8Sdrh #ifdef SQLITE_MEMDEBUG 5110107b56e8Sdrh void sqlite3MemdebugSetType(void*,u8); 5111107b56e8Sdrh int sqlite3MemdebugHasType(void*,u8); 5112174b9a16Sdrh int sqlite3MemdebugNoType(void*,u8); 5113107b56e8Sdrh #else 5114107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y) /* no-op */ 5115107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y) 1 5116174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y) 1 5117e3026636Sdanielk1977 #endif 5118107b56e8Sdrh #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 5119d231aa3aSdrh #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */ 5120b2a0f75cSdrh #define MEMTYPE_PCACHE 0x04 /* Page cache allocations */ 5121107b56e8Sdrh 5122f51446a3Sdrh /* 5123f51446a3Sdrh ** Threading interface 5124f51446a3Sdrh */ 5125bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0 5126f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*); 5127f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**); 5128bf20a35dSdrh #endif 5129f51446a3Sdrh 5130a43c8c8aSdrh #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST) 5131a43c8c8aSdrh int sqlite3DbpageRegister(sqlite3*); 5132a43c8c8aSdrh #endif 51333e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST) 51343e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*); 51353e0327d5Sdrh #endif 5136107b56e8Sdrh 513771c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr); 5138625015e0Sdan int sqlite3ExprIsVector(Expr *pExpr); 5139fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr*, int); 5140a1251bc4Sdrh Expr *sqlite3ExprForVectorField(Parse*,Expr*,int); 514144c5604cSdan void sqlite3VectorErrorMsg(Parse*, Expr*); 514271c57db0Sdan 51438999798eSdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 5144da1f49b8Sdan const char **sqlite3CompileOptions(int *pnOpt); 51458999798eSdrh #endif 5146da1f49b8Sdan 514743f58d6aSdrh #endif /* SQLITEINT_H */ 5148