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 184f382e1dcSlarrybr /* Optionally #include a user-defined header, whereby compilation options 185f382e1dcSlarrybr ** may be set prior to where they take effect, but after platform setup. 186b523159fSmistachkin ** If SQLITE_CUSTOM_INCLUDE=? is defined, its value names the #include 187b523159fSmistachkin ** file. 188f382e1dcSlarrybr */ 189b523159fSmistachkin #ifdef SQLITE_CUSTOM_INCLUDE 190f382e1dcSlarrybr # define INC_STRINGIFY_(f) #f 191f382e1dcSlarrybr # define INC_STRINGIFY(f) INC_STRINGIFY_(f) 192b523159fSmistachkin # include INC_STRINGIFY(SQLITE_CUSTOM_INCLUDE) 193f382e1dcSlarrybr #endif 194f382e1dcSlarrybr 1955e990beaSdrh /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear 1960d71d121Smistachkin ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for 1970d71d121Smistachkin ** MinGW. 1985e990beaSdrh */ 1995e990beaSdrh #include "sqlite3.h" 2005e990beaSdrh 201bd0ae111Smlcreech /* 2021e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the 2031e12d43bSmlcreech ** autoconf-based build 204bd0ae111Smlcreech */ 2057f2d1cd2Sdrh #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H) 20698dc4b1aSmlcreech #include "config.h" 2077f2d1cd2Sdrh #define SQLITECONFIG_H 1 2081e12d43bSmlcreech #endif 2091e12d43bSmlcreech 210bb4957f8Sdrh #include "sqliteLimit.h" 21198dc4b1aSmlcreech 212e2965827Sdrh /* Disable nuisance warnings on Borland compilers */ 213e2965827Sdrh #if defined(__BORLANDC__) 214e2965827Sdrh #pragma warn -rch /* unreachable code */ 215e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */ 216e2965827Sdrh #pragma warn -aus /* Assigned value is never used */ 217e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */ 218467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */ 219e2965827Sdrh #endif 220e2965827Sdrh 22198dc4b1aSmlcreech /* 222892edb69Sdan ** WAL mode depends on atomic aligned 32-bit loads and stores in a few 223892edb69Sdan ** places. The following macros try to make this explicit. 224892edb69Sdan */ 225b5538941Sdan #ifndef __has_extension 226b5538941Sdan # define __has_extension(x) 0 /* compatibility with non-clang compilers */ 227892edb69Sdan #endif 2280f56f891Sdan #if GCC_VERSION>=4007000 || __has_extension(c_atomic) 229a612c1c9Sdrh # define SQLITE_ATOMIC_INTRINSICS 1 230892edb69Sdan # define AtomicLoad(PTR) __atomic_load_n((PTR),__ATOMIC_RELAXED) 231892edb69Sdan # define AtomicStore(PTR,VAL) __atomic_store_n((PTR),(VAL),__ATOMIC_RELAXED) 232892edb69Sdan #else 233a612c1c9Sdrh # define SQLITE_ATOMIC_INTRINSICS 0 234892edb69Sdan # define AtomicLoad(PTR) (*(PTR)) 235892edb69Sdan # define AtomicStore(PTR,VAL) (*(PTR) = (VAL)) 236892edb69Sdan #endif 237892edb69Sdan 238892edb69Sdan /* 23906af763eSdrh ** Include standard header files as necessary 24006af763eSdrh */ 24106af763eSdrh #ifdef HAVE_STDINT_H 24206af763eSdrh #include <stdint.h> 24306af763eSdrh #endif 24406af763eSdrh #ifdef HAVE_INTTYPES_H 24506af763eSdrh #include <inttypes.h> 24606af763eSdrh #endif 24706af763eSdrh 248a2460e07Sdrh /* 249c05a9a8aSdrh ** The following macros are used to cast pointers to integers and 250c05a9a8aSdrh ** integers to pointers. The way you do this varies from one compiler 251c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements 252c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers. 253875e9e7dSdrh ** 254c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type. 255c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or 256c05a9a8aSdrh ** if it is available, it requires an #include of specific headers 257c92271c5Sdrh ** that vary from one machine to the next. 258875e9e7dSdrh ** 259875e9e7dSdrh ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 260875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 2615e49edcaSdrh ** So we have to define the macros in different ways depending on the 262875e9e7dSdrh ** compiler. 2631fc4129dSshane */ 2644509ffa3Sdrh #if defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 2654509ffa3Sdrh # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 2664509ffa3Sdrh # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 2674509ffa3Sdrh #elif defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 268c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 269c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 270c05a9a8aSdrh #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 271c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 272c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 273c05a9a8aSdrh #else /* Generates a warning - but it always works */ 274875e9e7dSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 275875e9e7dSdrh # define SQLITE_PTR_TO_INT(X) ((int)(X)) 276367882c2Sdrh #endif 27771674ce9Sdrh 278e5e7a901Sdrh /* 27914a924a5Sdrh ** A macro to hint to the compiler that a function should not be 28014a924a5Sdrh ** inlined. 28114a924a5Sdrh */ 28214a924a5Sdrh #if defined(__GNUC__) 28314a924a5Sdrh # define SQLITE_NOINLINE __attribute__((noinline)) 284ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310 28514a924a5Sdrh # define SQLITE_NOINLINE __declspec(noinline) 28614a924a5Sdrh #else 28714a924a5Sdrh # define SQLITE_NOINLINE 28814a924a5Sdrh #endif 28914a924a5Sdrh 29014a924a5Sdrh /* 291647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when 29260e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by 29360e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define. 294647ca46fSmistachkin */ 29560e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC) 29611f69b87Smistachkin # if defined(_MSC_VER) && _MSC_VER>=1400 2979895f735Smistachkin # if !defined(_WIN32_WCE) 298647ca46fSmistachkin # include <intrin.h> 299647ca46fSmistachkin # pragma intrinsic(_byteswap_ushort) 300647ca46fSmistachkin # pragma intrinsic(_byteswap_ulong) 301a39284bfSdrh # pragma intrinsic(_byteswap_uint64) 3028d9837acSmistachkin # pragma intrinsic(_ReadWriteBarrier) 3039895f735Smistachkin # else 3049895f735Smistachkin # include <cmnintrin.h> 3059895f735Smistachkin # endif 306647ca46fSmistachkin # endif 30760e08078Smistachkin #endif 308647ca46fSmistachkin 309647ca46fSmistachkin /* 31038c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 31138c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never 31238c67c36Sdrh ** threadsafe. 1 means the library is serialized which is the highest 313f7b5496eSdrh ** level of threadsafety. 2 means the library is multithreaded - multiple 31438c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same 31538c67c36Sdrh ** database connection at the same time. 31638c67c36Sdrh ** 317e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro. 31838c67c36Sdrh ** We support that for legacy. 319814aad61Sdan ** 320814aad61Sdan ** To ensure that the correct value of "THREADSAFE" is reported when querying 321814aad61Sdan ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this 322814aad61Sdan ** logic is partially replicated in ctime.c. If it is updated here, it should 323814aad61Sdan ** also be updated there. 324e5e7a901Sdrh */ 325e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE) 326e5e7a901Sdrh # if defined(THREADSAFE) 327e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE 328e5e7a901Sdrh # else 32938c67c36Sdrh # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 330e5e7a901Sdrh # endif 331e5e7a901Sdrh #endif 332e5e7a901Sdrh 33367080617Sdrh /* 334cb15f35fSdrh ** Powersafe overwrite is on by default. But can be turned off using 335cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option. 336cb15f35fSdrh */ 337cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE 338cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1 339cb15f35fSdrh #endif 340cb15f35fSdrh 341cb15f35fSdrh /* 342d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by 343d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in 344d1dcb234Sdrh ** which case memory allocation statistics are disabled by default. 3450a732f59Sdanielk1977 */ 3460a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 3470a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1 3480a732f59Sdanielk1977 #endif 3490a732f59Sdanielk1977 3500a732f59Sdanielk1977 /* 3510d18020bSdrh ** Exactly one of the following macros must be defined in order to 3520d18020bSdrh ** specify which memory allocation subsystem to use. 3530d18020bSdrh ** 3540d18020bSdrh ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 3551b186a99Smistachkin ** SQLITE_WIN32_MALLOC // Use Win32 native heap API 356d1b0afc3Sdrh ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails 3570d18020bSdrh ** SQLITE_MEMDEBUG // Debugging version of system malloc() 358a2460e07Sdrh ** 359753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the 360753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem 361753c5444Smistachkin ** will cause HeapValidate to be called. If heap validation should fail, an 362753c5444Smistachkin ** assertion will be triggered. 363753c5444Smistachkin ** 3640d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 3650d18020bSdrh ** the default. 3660d18020bSdrh */ 367d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 368d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 369d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 370d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)>1 371d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\ 37220b1ff07Smistachkin are defined but at most one is allowed:\ 373d1b0afc3Sdrh SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\ 374d1b0afc3Sdrh SQLITE_ZERO_MALLOC" 3750d18020bSdrh #endif 376d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 377d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 378d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 379d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)==0 3800d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1 3810d18020bSdrh #endif 3820d18020bSdrh 3830d18020bSdrh /* 3848a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 385eee4c8caSdrh ** sizes of memory allocations below this value where possible. 386eee4c8caSdrh */ 3878a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 388eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024 389eee4c8caSdrh #endif 390eee4c8caSdrh 391eee4c8caSdrh /* 39267080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable 39340b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD. 39440b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit 39540b521f8Sdrh ** it. 39667080617Sdrh */ 39740b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) 39840b521f8Sdrh # define _XOPEN_SOURCE 600 39967080617Sdrh #endif 400e3026636Sdanielk1977 4017d10d5a6Sdrh /* 4021b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that 4031b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true, 4041b28b893Sdrh ** make it true by defining or undefining NDEBUG. 4051b28b893Sdrh ** 406443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the 407443dbcf5Sdrh ** assert() statements in the code. So we want the default action 4081b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG 4091b28b893Sdrh ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out 4104b529d97Sdrh ** feature. 4114b529d97Sdrh */ 412289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 4134b529d97Sdrh # define NDEBUG 1 4144b529d97Sdrh #endif 4151b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG) 4161b28b893Sdrh # undef NDEBUG 4171b28b893Sdrh #endif 4184b529d97Sdrh 4196402250eSdrh /* 420c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on. 421c7379ce4Sdrh */ 422c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG) 423c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1 424c7379ce4Sdrh #endif 425c7379ce4Sdrh 426c7379ce4Sdrh /* 42747c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing. When 42847c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to 42947c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to 43047c3b3e0Sdrh ** get full branch coverage. The testcase() macro is inserted 43147c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple 43247c3b3e0Sdrh ** condition/decision coverage is inadequate. For example, testcase() 43347c3b3e0Sdrh ** can be used to make sure boundary values are tested. For 43447c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit 43547c3b3e0Sdrh ** is significant and used at least once. On switch statements 43647c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase() 43747c3b3e0Sdrh ** can insure that all cases are evaluated. 43847c3b3e0Sdrh ** 43947c3b3e0Sdrh */ 44047c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST 44147c3b3e0Sdrh void sqlite3Coverage(int); 44247c3b3e0Sdrh # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 44347c3b3e0Sdrh #else 44447c3b3e0Sdrh # define testcase(X) 4458f941bc7Sdrh #endif 4468f941bc7Sdrh 4478f941bc7Sdrh /* 4488f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or 4498f941bc7Sdrh ** other bits of code that are needed to support the arguments 4508f941bc7Sdrh ** within testcase() and assert() macros. 4518f941bc7Sdrh */ 4528f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 4538f941bc7Sdrh # define TESTONLY(X) X 4548f941bc7Sdrh #else 45547c3b3e0Sdrh # define TESTONLY(X) 45647c3b3e0Sdrh #endif 45747c3b3e0Sdrh 45847c3b3e0Sdrh /* 4596149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization 4606149526cSdrh ** to setup for a later assert() statement. We do not want this code to 4616149526cSdrh ** appear when assert() is disabled. The following macro is therefore 4626149526cSdrh ** used to contain that setup code. The "VVA" acronym stands for 4636149526cSdrh ** "Verification, Validation, and Accreditation". In other words, the 4646149526cSdrh ** code within VVA_ONLY() will only run during verification processes. 4656149526cSdrh */ 4666149526cSdrh #ifndef NDEBUG 4676149526cSdrh # define VVA_ONLY(X) X 4686149526cSdrh #else 4696149526cSdrh # define VVA_ONLY(X) 4706149526cSdrh #endif 4716149526cSdrh 4726149526cSdrh /* 47347c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which 47447c3b3e0Sdrh ** are intended to always be true or false, respectively. Such 47547c3b3e0Sdrh ** expressions could be omitted from the code completely. But they 47647c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience 47747c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing" 47847c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first 47947c3b3e0Sdrh ** hint of unplanned behavior. 48047c3b3e0Sdrh ** 48147c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code. 48247c3b3e0Sdrh ** 48347c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to 484443dbcf5Sdrh ** be true and false so that the unreachable code they specify will 48547c3b3e0Sdrh ** not be counted as untested code. 48647c3b3e0Sdrh */ 4875f65ff27Sdrh #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST) 48847c3b3e0Sdrh # define ALWAYS(X) (1) 48947c3b3e0Sdrh # define NEVER(X) (0) 49047c3b3e0Sdrh #elif !defined(NDEBUG) 4912de80f4cSdrh # define ALWAYS(X) ((X)?1:(assert(0),0)) 4922de80f4cSdrh # define NEVER(X) ((X)?(assert(0),1):0) 49347c3b3e0Sdrh #else 49447c3b3e0Sdrh # define ALWAYS(X) (X) 49547c3b3e0Sdrh # define NEVER(X) (X) 49647c3b3e0Sdrh #endif 49747c3b3e0Sdrh 49847c3b3e0Sdrh /* 499a2d50283Sdrh ** The harmless(X) macro indicates that expression X is usually false 500a2d50283Sdrh ** but can be true without causing any problems, but we don't know of 501a2d50283Sdrh ** any way to cause X to be true. 502a2d50283Sdrh ** 503a2d50283Sdrh ** In debugging and testing builds, this macro will abort if X is ever 504a2d50283Sdrh ** true. In this way, developers are alerted to a possible test case 505a2d50283Sdrh ** that causes X to be true. If a harmless macro ever fails, that is 506a2d50283Sdrh ** an opportunity to change the macro into a testcase() and add a new 507a2d50283Sdrh ** test case to the test suite. 508a2d50283Sdrh ** 509a2d50283Sdrh ** For normal production builds, harmless(X) is a no-op, since it does 510a2d50283Sdrh ** not matter whether expression X is true or false. 511a2d50283Sdrh */ 512a2d50283Sdrh #ifdef SQLITE_DEBUG 513a2d50283Sdrh # define harmless(X) assert(!(X)); 514a2d50283Sdrh #else 515a2d50283Sdrh # define harmless(X) 516a2d50283Sdrh #endif 517a2d50283Sdrh 518a2d50283Sdrh /* 5192f65b2f5Sdrh ** Some conditionals are optimizations only. In other words, if the 5202f65b2f5Sdrh ** conditionals are replaced with a constant 1 (true) or 0 (false) then 5212f65b2f5Sdrh ** the correct answer is still obtained, though perhaps not as quickly. 5222f65b2f5Sdrh ** 5232f65b2f5Sdrh ** The following macros mark these optimizations conditionals. 5242f65b2f5Sdrh */ 5252f65b2f5Sdrh #if defined(SQLITE_MUTATION_TEST) 5262f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (1) 5272f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (0) 5282f65b2f5Sdrh #else 5292f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (X) 5302f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (X) 5312f65b2f5Sdrh #endif 5322f65b2f5Sdrh 5332f65b2f5Sdrh /* 534dad300d8Sdrh ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is 535dad300d8Sdrh ** defined. We need to defend against those failures when testing with 536dad300d8Sdrh ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches 537dad300d8Sdrh ** during a normal build. The following macro can be used to disable tests 538dad300d8Sdrh ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set. 539dad300d8Sdrh */ 540dad300d8Sdrh #if defined(SQLITE_TEST_REALLOC_STRESS) 541dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (X) 542dad300d8Sdrh #elif !defined(NDEBUG) 543dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0) 544dad300d8Sdrh #else 545dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (0) 546dad300d8Sdrh #endif 547dad300d8Sdrh 548dad300d8Sdrh /* 5490cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces. 5500cbcffa7Smistachkin */ 551b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \ 552b10f22a1Smistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5530cbcffa7Smistachkin extern int sqlite3OSTrace; 5540cbcffa7Smistachkin # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X 5550cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE 5560cbcffa7Smistachkin #else 5570cbcffa7Smistachkin # define OSTRACE(X) 5580cbcffa7Smistachkin # undef SQLITE_HAVE_OS_TRACE 5590cbcffa7Smistachkin #endif 5600cbcffa7Smistachkin 5610cbcffa7Smistachkin /* 5625824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build? Currently, 5635824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when 5645824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are 5655824d44bSmistachkin ** compiled using SQLITE_TEST). 5665824d44bSmistachkin */ 5675824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \ 5685824d44bSmistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5695824d44bSmistachkin # define SQLITE_NEED_ERR_NAME 5705824d44bSmistachkin #else 5715824d44bSmistachkin # undef SQLITE_NEED_ERR_NAME 5725824d44bSmistachkin #endif 5735824d44bSmistachkin 5745824d44bSmistachkin /* 5757c621fb9Sdrh ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN 5767c621fb9Sdrh */ 5777c621fb9Sdrh #ifdef SQLITE_OMIT_EXPLAIN 5787c621fb9Sdrh # undef SQLITE_ENABLE_EXPLAIN_COMMENTS 5797c621fb9Sdrh #endif 5807c621fb9Sdrh 5817c621fb9Sdrh /* 58260ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large 5833e8e7ecbSdrh ** to fit in 32-bits. This macro is used inside of various testcase() 5843e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support. 5853e8e7ecbSdrh */ 586b31a6afaSdan #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 5873e8e7ecbSdrh 5883e8e7ecbSdrh /* 58947c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean 59047c3b3e0Sdrh ** expression that is usually false. Macro likely() surrounds 591443dbcf5Sdrh ** a boolean expression that is usually true. These hints could, 592443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but 593443dbcf5Sdrh ** currently they are just comments for human readers. 59447c3b3e0Sdrh */ 595443dbcf5Sdrh #define likely(X) (X) 596443dbcf5Sdrh #define unlikely(X) (X) 59747c3b3e0Sdrh 598beae3194Sdrh #include "hash.h" 59975897234Sdrh #include "parse.h" 60075897234Sdrh #include <stdio.h> 60175897234Sdrh #include <stdlib.h> 60275897234Sdrh #include <string.h> 60375897234Sdrh #include <assert.h> 60452370e2cSdrh #include <stddef.h> 60575897234Sdrh 606967e8b73Sdrh /* 6078674e492Sdrh ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY. 6088674e492Sdrh ** This allows better measurements of where memcpy() is used when running 6098674e492Sdrh ** cachegrind. But this macro version of memcpy() is very slow so it 6108674e492Sdrh ** should not be used in production. This is a performance measurement 6118674e492Sdrh ** hack only. 6128674e492Sdrh */ 6138674e492Sdrh #ifdef SQLITE_INLINE_MEMCPY 6148674e492Sdrh # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\ 6158674e492Sdrh int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);} 6168674e492Sdrh #endif 6178674e492Sdrh 6188674e492Sdrh /* 619b37df7b9Sdrh ** If compiling for a processor that lacks floating point support, 620b37df7b9Sdrh ** substitute integer for floating-point 621b37df7b9Sdrh */ 622b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT 623b37df7b9Sdrh # define double sqlite_int64 6248b307fbfSdrh # define float sqlite_int64 625b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64 626d1167393Sdrh # ifndef SQLITE_BIG_DBL 627cdaca55eSdrh # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 628d1167393Sdrh # endif 629b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1 630b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1 631110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 6320b3bf924Sdrh # undef SQLITE_HAVE_ISNAN 633b37df7b9Sdrh #endif 634d1167393Sdrh #ifndef SQLITE_BIG_DBL 635d1167393Sdrh # define SQLITE_BIG_DBL (1e99) 636d1167393Sdrh #endif 637b37df7b9Sdrh 638b37df7b9Sdrh /* 63953c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 64053c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler 64153c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements. 64253c0f748Sdanielk1977 */ 64353c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB 64453c0f748Sdanielk1977 #define OMIT_TEMPDB 1 64553c0f748Sdanielk1977 #else 64653c0f748Sdanielk1977 #define OMIT_TEMPDB 0 64753c0f748Sdanielk1977 #endif 64853c0f748Sdanielk1977 64953c0f748Sdanielk1977 /* 650d946db00Sdrh ** The "file format" number is an integer that is incremented whenever 651d946db00Sdrh ** the VDBE-level file format changes. The following macros define the 652d946db00Sdrh ** the default file format for new databases and the maximum file format 653d946db00Sdrh ** that the library can read. 654d946db00Sdrh */ 655d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4 656d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT 657bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4 658d946db00Sdrh #endif 659d946db00Sdrh 660a2460e07Sdrh /* 661a2460e07Sdrh ** Determine whether triggers are recursive by default. This can be 662a2460e07Sdrh ** changed at run-time using a pragma. 663a2460e07Sdrh */ 6645bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 6655bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 6665bde73c4Sdan #endif 6675bde73c4Sdan 668d946db00Sdrh /* 669b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 67049766d6cSdrh ** on the command-line 67149766d6cSdrh */ 672b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE 673b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1 67449766d6cSdrh #endif 67549766d6cSdrh 67649766d6cSdrh /* 677b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if 678b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it 679b3f56fdbSdan ** to zero. 680b3f56fdbSdan */ 6816b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0 682b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS 683028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0 684b3f56fdbSdan #endif 685b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS 6866b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8 687b3f56fdbSdan #endif 688a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS 689a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0 690a09c8855Sdrh #endif 691a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS 692a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS 693a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS 694a09c8855Sdrh #endif 695b3f56fdbSdan 6964297c7c4Sdrh /* 6974297c7c4Sdrh ** The default initial allocation for the pagecache when using separate 6984297c7c4Sdrh ** pagecaches for each database connection. A positive number is the 6994297c7c4Sdrh ** number of pages. A negative number N translations means that a buffer 7004297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold. 70183a4f47dSdrh ** 70283a4f47dSdrh ** The default value of "20" was choosen to minimize the run-time of the 70383a4f47dSdrh ** speedtest1 test program with options: --shrink-memory --reprepare 7044297c7c4Sdrh */ 7054297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ 70683a4f47dSdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 20 7074297c7c4Sdrh #endif 7084297c7c4Sdrh 709d83f7ca1Sdan /* 7102e3a5a81Sdan ** Default value for the SQLITE_CONFIG_SORTERREF_SIZE option. 7112e3a5a81Sdan */ 7122e3a5a81Sdan #ifndef SQLITE_DEFAULT_SORTERREF_SIZE 7132e3a5a81Sdan # define SQLITE_DEFAULT_SORTERREF_SIZE 0x7fffffff 7142e3a5a81Sdan #endif 7152e3a5a81Sdan 7162e3a5a81Sdan /* 7172df9478fSdrh ** The compile-time options SQLITE_MMAP_READWRITE and 7182df9478fSdrh ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another. 7192df9478fSdrh ** You must choose one or the other (or neither) but not both. 7202df9478fSdrh */ 7212df9478fSdrh #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 7222df9478fSdrh #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE 7232df9478fSdrh #endif 7242df9478fSdrh 7252df9478fSdrh /* 726f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it 727f1974846Sdrh ** ourselves. 728f1974846Sdrh */ 729f1974846Sdrh #ifndef offsetof 730f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 731f1974846Sdrh #endif 732f1974846Sdrh 733f1974846Sdrh /* 734e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers. 735e1e2e9acSdrh */ 73613969f5aSdrh #ifndef MIN 737e1e2e9acSdrh # define MIN(A,B) ((A)<(B)?(A):(B)) 73813969f5aSdrh #endif 73913969f5aSdrh #ifndef MAX 740e1e2e9acSdrh # define MAX(A,B) ((A)>(B)?(A):(B)) 74113969f5aSdrh #endif 742e1e2e9acSdrh 743e1e2e9acSdrh /* 7444fa4a54fSdrh ** Swap two objects of type TYPE. 7454fa4a54fSdrh */ 7464fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;} 7474fa4a54fSdrh 7484fa4a54fSdrh /* 7499b8f447bSdrh ** Check to see if this machine uses EBCDIC. (Yes, believe it or 7509b8f447bSdrh ** not, there are still machines out there that use EBCDIC.) 7519b8f447bSdrh */ 7529b8f447bSdrh #if 'A' == '\301' 7539b8f447bSdrh # define SQLITE_EBCDIC 1 7549b8f447bSdrh #else 7559b8f447bSdrh # define SQLITE_ASCII 1 7569b8f447bSdrh #endif 7579b8f447bSdrh 7589b8f447bSdrh /* 7595a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 7605a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 7615a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 7625a2c2c20Sdrh ** 7635a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 76441a2b48bSdrh */ 7655a2c2c20Sdrh #ifndef UINT32_TYPE 766dda5b68cSmlcreech # ifdef HAVE_UINT32_T 767dda5b68cSmlcreech # define UINT32_TYPE uint32_t 768dda5b68cSmlcreech # else 7695a2c2c20Sdrh # define UINT32_TYPE unsigned int 7705a2c2c20Sdrh # endif 771dda5b68cSmlcreech #endif 7725a2c2c20Sdrh #ifndef UINT16_TYPE 773dda5b68cSmlcreech # ifdef HAVE_UINT16_T 774dda5b68cSmlcreech # define UINT16_TYPE uint16_t 775dda5b68cSmlcreech # else 7765a2c2c20Sdrh # define UINT16_TYPE unsigned short int 7775a2c2c20Sdrh # endif 778dda5b68cSmlcreech #endif 779939a16d6Sdrh #ifndef INT16_TYPE 780dda5b68cSmlcreech # ifdef HAVE_INT16_T 781dda5b68cSmlcreech # define INT16_TYPE int16_t 782dda5b68cSmlcreech # else 783939a16d6Sdrh # define INT16_TYPE short int 784939a16d6Sdrh # endif 785dda5b68cSmlcreech #endif 7865a2c2c20Sdrh #ifndef UINT8_TYPE 787dda5b68cSmlcreech # ifdef HAVE_UINT8_T 788dda5b68cSmlcreech # define UINT8_TYPE uint8_t 789dda5b68cSmlcreech # else 7905a2c2c20Sdrh # define UINT8_TYPE unsigned char 7915a2c2c20Sdrh # endif 792dda5b68cSmlcreech #endif 793905793e2Sdrh #ifndef INT8_TYPE 794dda5b68cSmlcreech # ifdef HAVE_INT8_T 795dda5b68cSmlcreech # define INT8_TYPE int8_t 796dda5b68cSmlcreech # else 797905793e2Sdrh # define INT8_TYPE signed char 798905793e2Sdrh # endif 799dda5b68cSmlcreech #endif 800efad9995Sdrh #ifndef LONGDOUBLE_TYPE 801efad9995Sdrh # define LONGDOUBLE_TYPE long double 802efad9995Sdrh #endif 803efad9995Sdrh typedef sqlite_int64 i64; /* 8-byte signed integer */ 80427436af7Sdrh typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 8055a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 8065a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 807939a16d6Sdrh typedef INT16_TYPE i16; /* 2-byte signed integer */ 8085a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 80970a8ca3cSdrh typedef INT8_TYPE i8; /* 1-byte signed integer */ 8105a2c2c20Sdrh 8115a2c2c20Sdrh /* 81235cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 81335cd643cSdrh ** that can be stored in a u32 without loss of data. The value 81435cd643cSdrh ** is 0x00000000ffffffff. But because of quirks of some compilers, we 81535cd643cSdrh ** have to specify the value in the less intuitive manner shown: 81635cd643cSdrh */ 81735cd643cSdrh #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 81835cd643cSdrh 81935cd643cSdrh /* 820faacf17cSdrh ** The datatype used to store estimates of the number of rows in a 821faacf17cSdrh ** table or index. This is an unsigned integer type. For 99.9% of 822faacf17cSdrh ** the world, a 32-bit integer is sufficient. But a 64-bit integer 823faacf17cSdrh ** can be used at compile-time if desired. 824faacf17cSdrh */ 825faacf17cSdrh #ifdef SQLITE_64BIT_STATS 826faacf17cSdrh typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */ 827faacf17cSdrh #else 828faacf17cSdrh typedef u32 tRowcnt; /* 32-bit is the default */ 829faacf17cSdrh #endif 830faacf17cSdrh 831faacf17cSdrh /* 832bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit 833bf539c4dSdrh ** logarithms. For quantity X, the value stored is 10*log2(X). This 834bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986. 835bf539c4dSdrh ** But the allowed values are "grainy". Not every value is representable. 836bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst 83797d38983Sdrh ** of 40. However, since LogEst quantities are suppose to be estimates, 838bf539c4dSdrh ** not exact values, this imprecision is not a problem. 839bf539c4dSdrh ** 840224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate". 841bf539c4dSdrh ** 842bf539c4dSdrh ** Examples: 843bf539c4dSdrh ** 1 -> 0 20 -> 43 10000 -> 132 844bf539c4dSdrh ** 2 -> 10 25 -> 46 25000 -> 146 845bf539c4dSdrh ** 3 -> 16 100 -> 66 1000000 -> 199 846bf539c4dSdrh ** 4 -> 20 1000 -> 99 1048576 -> 200 847bf539c4dSdrh ** 10 -> 33 1024 -> 100 4294967296 -> 320 848bf539c4dSdrh ** 849bf539c4dSdrh ** The LogEst can be negative to indicate fractional values. 850bf539c4dSdrh ** Examples: 851bf539c4dSdrh ** 852bf539c4dSdrh ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40 853bf539c4dSdrh */ 854bf539c4dSdrh typedef INT16_TYPE LogEst; 855bf539c4dSdrh 856bf539c4dSdrh /* 8572b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer 8582b4905c8Sdrh */ 8592b4905c8Sdrh #ifndef SQLITE_PTRSIZE 8602b4905c8Sdrh # if defined(__SIZEOF_POINTER__) 8612b4905c8Sdrh # define SQLITE_PTRSIZE __SIZEOF_POINTER__ 8622b4905c8Sdrh # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 86388edc6c7Smistachkin defined(_M_ARM) || defined(__arm__) || defined(__x86) || \ 86488edc6c7Smistachkin (defined(__TOS_AIX__) && !defined(__64BIT__)) 8652b4905c8Sdrh # define SQLITE_PTRSIZE 4 8662b4905c8Sdrh # else 8672b4905c8Sdrh # define SQLITE_PTRSIZE 8 8682b4905c8Sdrh # endif 8692b4905c8Sdrh #endif 8702b4905c8Sdrh 8713bfa7e82Sdrh /* The uptr type is an unsigned integer large enough to hold a pointer 8723bfa7e82Sdrh */ 8733bfa7e82Sdrh #if defined(HAVE_STDINT_H) 8743bfa7e82Sdrh typedef uintptr_t uptr; 8753bfa7e82Sdrh #elif SQLITE_PTRSIZE==4 8763bfa7e82Sdrh typedef u32 uptr; 8773bfa7e82Sdrh #else 8783bfa7e82Sdrh typedef u64 uptr; 8793bfa7e82Sdrh #endif 8803bfa7e82Sdrh 8813bfa7e82Sdrh /* 8823bfa7e82Sdrh ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to 8833bfa7e82Sdrh ** something between S (inclusive) and E (exclusive). 8843bfa7e82Sdrh ** 8853bfa7e82Sdrh ** In other words, S is a buffer and E is a pointer to the first byte after 8863bfa7e82Sdrh ** the end of buffer S. This macro returns true if P points to something 8873bfa7e82Sdrh ** contained within the buffer S. 8883bfa7e82Sdrh */ 8893bfa7e82Sdrh #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E))) 8903bfa7e82Sdrh 8913bfa7e82Sdrh 8922b4905c8Sdrh /* 893bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian, 89471794dbaSdrh ** and whether or not that determination is run-time or compile-time. 89571794dbaSdrh ** 89671794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order 89771794dbaSdrh ** using C-preprocessor macros. If that is unsuccessful, or if 898a39284bfSdrh ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined 89971794dbaSdrh ** at run-time. 900bbd42a6dSdrh */ 901a39284bfSdrh #ifndef SQLITE_BYTEORDER 902a39284bfSdrh # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 90371794dbaSdrh defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \ 90471794dbaSdrh defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \ 905acd6bb5fSdrh defined(__ARMEL__) || defined(__AARCH64EL__) || defined(_M_ARM64) 9062cf4acbdSdrh # define SQLITE_BYTEORDER 1234 907acd6bb5fSdrh # elif defined(sparc) || defined(__ppc__) || \ 908acd6bb5fSdrh defined(__ARMEB__) || defined(__AARCH64EB__) 90971794dbaSdrh # define SQLITE_BYTEORDER 4321 910a39284bfSdrh # else 911a39284bfSdrh # define SQLITE_BYTEORDER 0 912a39284bfSdrh # endif 913a39284bfSdrh #endif 914a39284bfSdrh #if SQLITE_BYTEORDER==4321 91571794dbaSdrh # define SQLITE_BIGENDIAN 1 91671794dbaSdrh # define SQLITE_LITTLEENDIAN 0 91771794dbaSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16BE 918a39284bfSdrh #elif SQLITE_BYTEORDER==1234 919a39284bfSdrh # define SQLITE_BIGENDIAN 0 920a39284bfSdrh # define SQLITE_LITTLEENDIAN 1 921a39284bfSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 922a39284bfSdrh #else 923e1462a76Sdrh # ifdef SQLITE_AMALGAMATION 924e1462a76Sdrh const int sqlite3one = 1; 925e1462a76Sdrh # else 926e1462a76Sdrh extern const int sqlite3one; 927e1462a76Sdrh # endif 9289c054830Sdrh # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 9299c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 93038def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 93138def054Sdrh #endif 932bbd42a6dSdrh 933bbd42a6dSdrh /* 9340f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers. 9350f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit 9360f050353Sdrh ** compilers. 9370f050353Sdrh */ 9380f050353Sdrh #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 939d1d89140Sdrh #define LARGEST_UINT64 (0xffffffff|(((u64)0xffffffff)<<32)) 9400f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 9410f050353Sdrh 9420f050353Sdrh /* 943be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8. This is used 944be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures. 945be229650Sdanielk1977 */ 946bc73971dSdanielk1977 #define ROUND8(x) (((x)+7)&~7) 947bc73971dSdanielk1977 948bc73971dSdanielk1977 /* 949bc73971dSdanielk1977 ** Round down to the nearest multiple of 8 950bc73971dSdanielk1977 */ 951bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7) 952be229650Sdanielk1977 953be229650Sdanielk1977 /* 9548e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary. This 9558e14c596Sdrh ** macro is used only within assert() to verify that the code gets 9568e14c596Sdrh ** all alignment restrictions correct. 9578e14c596Sdrh ** 9588e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 95960ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned 9608e14c596Sdrh ** pointers. In that case, only verify 4-byte alignment. 961ea598cbdSdrh */ 9628e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 9638e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 9648e14c596Sdrh #else 965ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 9668e14c596Sdrh #endif 967ea598cbdSdrh 968188d4884Sdrh /* 9699b4c59faSdrh ** Disable MMAP on platforms where it is known to not work 970188d4884Sdrh */ 971188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__) 9729b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE 9739b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 974188d4884Sdrh #endif 975188d4884Sdrh 9769b4c59faSdrh /* 9779b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS 9789b4c59faSdrh */ 9799b4c59faSdrh #ifdef __APPLE__ 9809b4c59faSdrh # include <TargetConditionals.h> 9819b4c59faSdrh #endif 9829b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE 9839b4c59faSdrh # if defined(__linux__) \ 9849b4c59faSdrh || defined(_WIN32) \ 9859b4c59faSdrh || (defined(__APPLE__) && defined(__MACH__)) \ 9863e9dd938Sdrh || defined(__sun) \ 9873e9dd938Sdrh || defined(__FreeBSD__) \ 9883e9dd938Sdrh || defined(__DragonFly__) 9892bba8c24Sdrh # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */ 9909b4c59faSdrh # else 9919b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 9929b4c59faSdrh # endif 9939b4c59faSdrh #endif 9949b4c59faSdrh 9959b4c59faSdrh /* 9969b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger 9979b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does 9989b4c59faSdrh ** not exceed the maximum mmap size. 9999b4c59faSdrh */ 10009b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE 10019b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0 10029b4c59faSdrh #endif 10039b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE 10049b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE 10059b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE 10069b4c59faSdrh #endif 1007e7b34707Sdrh 1008ea598cbdSdrh /* 1009abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not 1010abd4c723Sdrh ** the Select query generator tracing logic is turned on. 1011abd4c723Sdrh */ 1012c0622a4dSdrh #if !defined(SQLITE_AMALGAMATION) 1013c0622a4dSdrh extern u32 sqlite3SelectTrace; 1014abd4c723Sdrh #endif 1015c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1016c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_SELECTTRACE)) 10179216de8aSdrh # define SELECTTRACE_ENABLED 1 10189216de8aSdrh # define SELECTTRACE(K,P,S,X) \ 1019c0622a4dSdrh if(sqlite3SelectTrace&(K)) \ 10209216de8aSdrh sqlite3DebugPrintf("%u/%d/%p: ",(S)->selId,(P)->addrExplain,(S)),\ 10219216de8aSdrh sqlite3DebugPrintf X 10229216de8aSdrh #else 10239216de8aSdrh # define SELECTTRACE(K,P,S,X) 10249216de8aSdrh # define SELECTTRACE_ENABLED 0 10259216de8aSdrh #endif 1026abd4c723Sdrh 1027abd4c723Sdrh /* 1028c0622a4dSdrh ** Macros for "wheretrace" 1029c0622a4dSdrh */ 10308e2b9c2aSdrh extern u32 sqlite3WhereTrace; 1031c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1032c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE)) 1033c0622a4dSdrh # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X 1034c0622a4dSdrh # define WHERETRACE_ENABLED 1 1035c0622a4dSdrh #else 1036c0622a4dSdrh # define WHERETRACE(K,X) 1037c0622a4dSdrh #endif 1038c0622a4dSdrh 1039c0622a4dSdrh 1040c0622a4dSdrh /* 104190f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler 104290f5ecb3Sdrh ** callback for a given sqlite handle. 104390f5ecb3Sdrh ** 104490f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy 104590f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite 104690f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 104790f5ecb3Sdrh ** callback is currently invoked only from within pager.c. 104890f5ecb3Sdrh */ 104990f5ecb3Sdrh typedef struct BusyHandler BusyHandler; 105090f5ecb3Sdrh struct BusyHandler { 105180262896Sdrh int (*xBusyHandler)(void *,int); /* The busy callback */ 105280262896Sdrh void *pBusyArg; /* First arg to busy callback */ 1053a4afb65cSdrh int nBusy; /* Incremented with each busy call */ 105490f5ecb3Sdrh }; 105590f5ecb3Sdrh 105690f5ecb3Sdrh /* 1057ccb2113aSdrh ** Name of table that holds the database schema. 105875897234Sdrh */ 1059346a70caSdrh #define DFLT_SCHEMA_TABLE "sqlite_master" 1060346a70caSdrh #define DFLT_TEMP_SCHEMA_TABLE "sqlite_temp_master" 1061346a70caSdrh #define ALT_SCHEMA_TABLE "sqlite_schema" 1062346a70caSdrh #define ALT_TEMP_SCHEMA_TABLE "sqlite_temp_schema" 1063346a70caSdrh 106475897234Sdrh 106575897234Sdrh /* 1066346a70caSdrh ** The root-page of the schema table. 10678e150818Sdanielk1977 */ 1068346a70caSdrh #define SCHEMA_ROOT 1 10698e150818Sdanielk1977 10708e150818Sdanielk1977 /* 1071346a70caSdrh ** The name of the schema table. The name is different for TEMP. 1072ed6c8671Sdrh */ 1073346a70caSdrh #define SCHEMA_TABLE(x) \ 1074346a70caSdrh ((!OMIT_TEMPDB)&&(x==1)?DFLT_TEMP_SCHEMA_TABLE:DFLT_SCHEMA_TABLE) 1075ed6c8671Sdrh 1076ed6c8671Sdrh /* 107775897234Sdrh ** A convenience macro that returns the number of elements in 107875897234Sdrh ** an array. 107975897234Sdrh */ 108023432976Sdanielk1977 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 108175897234Sdrh 108275897234Sdrh /* 10837a5bcc0fSdrh ** Determine if the argument is a power of two 10847a5bcc0fSdrh */ 10857a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0) 10867a5bcc0fSdrh 10877a5bcc0fSdrh /* 1088633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree(). 1089aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the 1090aa538a58Sdrh ** one parameter that destructors normally want. So we have to introduce 1091aa538a58Sdrh ** this magic value that the code knows to handle differently. Any 1092aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC 1093aa538a58Sdrh ** and SQLITE_TRANSIENT. 1094633e6d57Sdrh */ 109508b92086Sdrh #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3OomFault) 1096633e6d57Sdrh 109778f82d1eSdrh /* 109878f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 109978f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables. 110078f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from 110178f82d1eSdrh ** the heap. When WSD is unsupported, the variable declarations scattered 110278f82d1eSdrh ** throughout the SQLite code must become constants instead. The SQLITE_WSD 110378f82d1eSdrh ** macro is used for this purpose. And instead of referencing the variable 110478f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated 110578f82d1eSdrh ** buffer that holds real variable. The constant is also the initializer 110678f82d1eSdrh ** for the run-time allocated buffer. 110778f82d1eSdrh ** 11082479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 110978f82d1eSdrh ** macros become no-ops and have zero performance impact. 111078f82d1eSdrh */ 1111075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD 1112075c23afSdanielk1977 #define SQLITE_WSD const 1113075c23afSdanielk1977 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 1114075c23afSdanielk1977 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 1115d1d38488Sdrh int sqlite3_wsd_init(int N, int J); 1116d1d38488Sdrh void *sqlite3_wsd_find(void *K, int L); 1117075c23afSdanielk1977 #else 1118075c23afSdanielk1977 #define SQLITE_WSD 1119075c23afSdanielk1977 #define GLOBAL(t,v) v 1120075c23afSdanielk1977 #define sqlite3GlobalConfig sqlite3Config 1121075c23afSdanielk1977 #endif 1122075c23afSdanielk1977 1123f3d3c27aSdanielk1977 /* 1124f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to 1125f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately 1126f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when 1127f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the 1128f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the 1129f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate, 1130f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere. 1131f3d3c27aSdanielk1977 ** 1132f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function, 1133f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 1134f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to 1135f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options. 1136f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these 1137f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions. 1138f3d3c27aSdanielk1977 */ 113962c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x) 1140f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 114162c14b34Sdanielk1977 1142633e6d57Sdrh /* 114375897234Sdrh ** Forward references to structures 114475897234Sdrh */ 114513449892Sdrh typedef struct AggInfo AggInfo; 1146fe05af87Sdrh typedef struct AuthContext AuthContext; 11470b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo; 1148f5e7bb51Sdrh typedef struct Bitvec Bitvec; 1149fe05af87Sdrh typedef struct CollSeq CollSeq; 11507020f651Sdrh typedef struct Column Column; 1151f824b41eSdrh typedef struct Cte Cte; 1152a79e2a2dSdrh typedef struct CteUse CteUse; 1153fe05af87Sdrh typedef struct Db Db; 1154f380c3f1Sdan typedef struct DbFixer DbFixer; 1155e501b89aSdanielk1977 typedef struct Schema Schema; 115675897234Sdrh typedef struct Expr Expr; 115775897234Sdrh typedef struct ExprList ExprList; 1158c2eef3b3Sdrh typedef struct FKey FKey; 1159d2199f0fSdan typedef struct FuncDestructor FuncDestructor; 1160fe05af87Sdrh typedef struct FuncDef FuncDef; 116170a8ca3cSdrh typedef struct FuncDefHash FuncDefHash; 1162fe05af87Sdrh typedef struct IdList IdList; 1163fe05af87Sdrh typedef struct Index Index; 116402fa4696Sdan typedef struct IndexSample IndexSample; 11658d059845Sdanielk1977 typedef struct KeyClass KeyClass; 1166d3d39e93Sdrh typedef struct KeyInfo KeyInfo; 1167633e6d57Sdrh typedef struct Lookaside Lookaside; 1168633e6d57Sdrh typedef struct LookasideSlot LookasideSlot; 1169d1ab1ba5Sdanielk1977 typedef struct Module Module; 1170626a879aSdrh typedef struct NameContext NameContext; 1171fe05af87Sdrh typedef struct Parse Parse; 1172cf3c078fSdrh typedef struct ParseCleanup ParseCleanup; 117346c47d46Sdan typedef struct PreUpdate PreUpdate; 1174a5c1416dSdrh typedef struct PrintfArguments PrintfArguments; 1175cf8f2895Sdan typedef struct RenameToken RenameToken; 1176b8352479Sdrh typedef struct Returning Returning; 1177a2460e07Sdrh typedef struct RowSet RowSet; 1178fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint; 1179fe05af87Sdrh typedef struct Select Select; 1180f51446a3Sdrh typedef struct SQLiteThread SQLiteThread; 1181634d81deSdrh typedef struct SelectDest SelectDest; 11827601294aSdrh typedef struct SrcItem SrcItem; 1183fe05af87Sdrh typedef struct SrcList SrcList; 11840cdbe1aeSdrh typedef struct sqlite3_str StrAccum; /* Internal alias for sqlite3_str */ 1185fe05af87Sdrh typedef struct Table Table; 1186c00da105Sdanielk1977 typedef struct TableLock TableLock; 1187fe05af87Sdrh typedef struct Token Token; 11884fa4a54fSdrh typedef struct TreeView TreeView; 1189a2460e07Sdrh typedef struct Trigger Trigger; 11902832ad42Sdan typedef struct TriggerPrg TriggerPrg; 1191fe05af87Sdrh typedef struct TriggerStep TriggerStep; 1192e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord; 119346d2e5c3Sdrh typedef struct Upsert Upsert; 1194595a523aSdanielk1977 typedef struct VTable VTable; 1195b061d058Sdan typedef struct VtabCtx VtabCtx; 11967d10d5a6Sdrh typedef struct Walker Walker; 1197fe05af87Sdrh typedef struct WhereInfo WhereInfo; 119886fb6e17Sdan typedef struct Window Window; 11997d562dbeSdan typedef struct With With; 1200d3d39e93Sdrh 12011fe3ac73Sdrh 12021fe3ac73Sdrh /* 12031fe3ac73Sdrh ** The bitmask datatype defined below is used for various optimizations. 12041fe3ac73Sdrh ** 12051fe3ac73Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of 12061fe3ac73Sdrh ** tables in a join to 32 instead of 64. But it also reduces the size 12071fe3ac73Sdrh ** of the library by 738 bytes on ix86. 12081fe3ac73Sdrh */ 12091fe3ac73Sdrh #ifdef SQLITE_BITMASK_TYPE 12101fe3ac73Sdrh typedef SQLITE_BITMASK_TYPE Bitmask; 12111fe3ac73Sdrh #else 12121fe3ac73Sdrh typedef u64 Bitmask; 12131fe3ac73Sdrh #endif 12141fe3ac73Sdrh 12151fe3ac73Sdrh /* 12161fe3ac73Sdrh ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 12171fe3ac73Sdrh */ 12181fe3ac73Sdrh #define BMS ((int)(sizeof(Bitmask)*8)) 12191fe3ac73Sdrh 12201fe3ac73Sdrh /* 12211fe3ac73Sdrh ** A bit in a Bitmask 12221fe3ac73Sdrh */ 12231fe3ac73Sdrh #define MASKBIT(n) (((Bitmask)1)<<(n)) 1224b945bcdaSdrh #define MASKBIT64(n) (((u64)1)<<(n)) 12251fe3ac73Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n)) 12261fe3ac73Sdrh #define ALLBITS ((Bitmask)-1) 12271fe3ac73Sdrh 12289bf755ccSdrh /* A VList object records a mapping between parameters/variables/wildcards 12299bf755ccSdrh ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer 12309bf755ccSdrh ** variable number associated with that parameter. See the format description 12319bf755ccSdrh ** on the sqlite3VListAdd() routine for more information. A VList is really 12329bf755ccSdrh ** just an array of integers. 12339bf755ccSdrh */ 12349bf755ccSdrh typedef int VList; 12359bf755ccSdrh 12362dca4ac1Sdanielk1977 /* 12372dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 12382dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 12392dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above. 12402dca4ac1Sdanielk1977 */ 1241e9261dbdSdrh #include "pager.h" 12422dca4ac1Sdanielk1977 #include "btree.h" 12432dca4ac1Sdanielk1977 #include "vdbe.h" 12448c0a791aSdanielk1977 #include "pcache.h" 12451cc5ed81Sdanielk1977 #include "os.h" 1246c7ce76afSdrh #include "mutex.h" 12471cc5ed81Sdanielk1977 124833b104afSdrh /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default 124933b104afSdrh ** synchronous setting to EXTRA. It is no longer supported. 125033b104afSdrh */ 125133b104afSdrh #ifdef SQLITE_EXTRA_DURABLE 125233b104afSdrh # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE 125333b104afSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 3 125433b104afSdrh #endif 125533b104afSdrh 125650a1a5aaSdrh /* 1257c2ae2073Sdrh ** Default synchronous levels. 1258c2ae2073Sdrh ** 1259c2ae2073Sdrh ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ 1260c2ae2073Sdrh ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1. 1261c2ae2073Sdrh ** 1262c2ae2073Sdrh ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS 1263c2ae2073Sdrh ** OFF 1 0 1264c2ae2073Sdrh ** NORMAL 2 1 1265c2ae2073Sdrh ** FULL 3 2 1266c2ae2073Sdrh ** EXTRA 4 3 1267c2ae2073Sdrh ** 1268c2ae2073Sdrh ** The "PRAGMA synchronous" statement also uses the zero-based numbers. 1269c2ae2073Sdrh ** In other words, the zero-based numbers are used for all external interfaces 1270c2ae2073Sdrh ** and the one-based values are used internally. 127150a1a5aaSdrh */ 127250a1a5aaSdrh #ifndef SQLITE_DEFAULT_SYNCHRONOUS 12733e7d012eSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 2 127450a1a5aaSdrh #endif 127550a1a5aaSdrh #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS 127650a1a5aaSdrh # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS 127750a1a5aaSdrh #endif 1278eee4c8caSdrh 1279001bbcbbSdrh /* 1280001bbcbbSdrh ** Each database file to be accessed by the system is an instance 1281001bbcbbSdrh ** of the following structure. There are normally two of these structures 1282001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 1283a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 1284a69d9168Sdrh ** databases may be attached. 1285001bbcbbSdrh */ 1286001bbcbbSdrh struct Db { 128769c33826Sdrh char *zDbSName; /* Name of this database. (schema name, not filename) */ 1288001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 1289467bcf36Sshane u8 safety_level; /* How aggressive at syncing data to disk */ 129050a1a5aaSdrh u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */ 1291e501b89aSdanielk1977 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 1292da184236Sdanielk1977 }; 1293da184236Sdanielk1977 1294da184236Sdanielk1977 /* 1295da184236Sdanielk1977 ** An instance of the following structure stores a database schema. 12962120608eSdrh ** 12972120608eSdrh ** Most Schema objects are associated with a Btree. The exception is 12982120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 12992120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple 13002120608eSdrh ** Btrees that refer to the same underlying BtShared object. 13012120608eSdrh ** 13022120608eSdrh ** Schema objects are automatically deallocated when the last Btree that 13032120608eSdrh ** references them is destroyed. The TEMP Schema is manually freed by 13042120608eSdrh ** sqlite3_close(). 13052120608eSdrh * 13062120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order 13072120608eSdrh ** to access Schema content. This implies that the thread must also be 13082120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 130955a0959aSdrh ** For a TEMP Schema, only the connection mutex is required. 1310da184236Sdanielk1977 */ 1311e501b89aSdanielk1977 struct Schema { 1312001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 1313c2a75551Sdrh int iGeneration; /* Generation counter. Incremented with each change */ 1314d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 1315d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 1316d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 13171da40a38Sdan Hash fkeyHash; /* All foreign keys by referenced table name */ 13184794f735Sdrh Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 1319da184236Sdanielk1977 u8 file_format; /* Schema format version for this file */ 13208079a0d3Sdrh u8 enc; /* Text encoding used by this database */ 13212c5e35ffSdrh u16 schemaFlags; /* Flags associated with this schema */ 132214db2665Sdanielk1977 int cache_size; /* Number of pages to use in the cache */ 1323001bbcbbSdrh }; 132475897234Sdrh 132575897234Sdrh /* 13268bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 1327a2460e07Sdrh ** Db.pSchema->flags field. 13288bf8dc92Sdrh */ 13292c5e35ffSdrh #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P)) 13302c5e35ffSdrh #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0) 13312c5e35ffSdrh #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P) 13322c5e35ffSdrh #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P) 13338bf8dc92Sdrh 13348bf8dc92Sdrh /* 1335a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field. 13368bf8dc92Sdrh ** 13378bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 13388bf8dc92Sdrh ** read into internal hash tables. 13398bf8dc92Sdrh ** 13408bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 13418bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 13428bf8dc92Sdrh ** changes and so the view will need to be reset. 13438bf8dc92Sdrh */ 1344124b27e6Sdrh #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 1345124b27e6Sdrh #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 1346dc6b41edSdrh #define DB_ResetWanted 0x0008 /* Reset the schema when nSchemaLock==0 */ 13478bf8dc92Sdrh 1348caa639f4Sdrh /* 1349caa639f4Sdrh ** The number of different kinds of things that can be limited 1350caa639f4Sdrh ** using the sqlite3_limit() interface. 1351caa639f4Sdrh */ 1352111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1) 13538bf8dc92Sdrh 13548bf8dc92Sdrh /* 1355633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used 1356467bcf36Sshane ** to satisfy small transient memory allocation requests for objects 1357633e6d57Sdrh ** associated with a particular database connection. The use of 1358633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement 1359633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing 1360633e6d57Sdrh ** SQL statements. 1361633e6d57Sdrh ** 1362633e6d57Sdrh ** The Lookaside structure holds configuration information about the 1363633e6d57Sdrh ** lookaside malloc subsystem. Each available memory allocation in 1364633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot 1365633e6d57Sdrh ** objects. 1366d9da78a2Sdrh ** 1367d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated 1368d9da78a2Sdrh ** with a particular database connection. Hence, schema information cannot 1369d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information 1370d9da78a2Sdrh ** is shared by multiple database connections. Therefore, while parsing 1371d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that 1372d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects. 137331f69626Sdrh ** 137431f69626Sdrh ** New lookaside allocations are only allowed if bDisable==0. When 137531f69626Sdrh ** bDisable is greater than zero, sz is set to zero which effectively 137631f69626Sdrh ** disables lookaside without adding a new test for the bDisable flag 137731f69626Sdrh ** in a performance-critical path. sz should be set by to szTrue whenever 137831f69626Sdrh ** bDisable changes back to zero. 1379e6068027Sdrh ** 1380e6068027Sdrh ** Lookaside buffers are initially held on the pInit list. As they are 1381e6068027Sdrh ** used and freed, they are added back to the pFree list. New allocations 1382e6068027Sdrh ** come off of pFree first, then pInit as a fallback. This dual-list 1383e6068027Sdrh ** allows use to compute a high-water mark - the maximum number of allocations 1384e6068027Sdrh ** outstanding at any point in the past - by subtracting the number of 1385e6068027Sdrh ** allocations on the pInit list from the total number of allocations. 1386e6068027Sdrh ** 1387cf014f6cSdrh ** Enhancement on 2019-12-12: Two-size-lookaside 1388e6068027Sdrh ** The default lookaside configuration is 100 slots of 1200 bytes each. 1389e6068027Sdrh ** The larger slot sizes are important for performance, but they waste 1390e6068027Sdrh ** a lot of space, as most lookaside allocations are less than 128 bytes. 1391cf014f6cSdrh ** The two-size-lookaside enhancement breaks up the lookaside allocation 1392cf014f6cSdrh ** into two pools: One of 128-byte slots and the other of the default size 1393cf014f6cSdrh ** (1200-byte) slots. Allocations are filled from the small-pool first, 1394e6068027Sdrh ** failing over to the full-size pool if that does not work. Thus more 1395e6068027Sdrh ** lookaside slots are available while also using less memory. 1396e6068027Sdrh ** This enhancement can be omitted by compiling with 1397cf014f6cSdrh ** SQLITE_OMIT_TWOSIZE_LOOKASIDE. 1398633e6d57Sdrh */ 1399633e6d57Sdrh struct Lookaside { 14004a642b60Sdrh u32 bDisable; /* Only operate the lookaside when zero */ 1401633e6d57Sdrh u16 sz; /* Size of each buffer in bytes */ 140231f69626Sdrh u16 szTrue; /* True value of sz, even if disabled */ 1403e9d1c720Sdrh u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 140452fb8e19Sdrh u32 nSlot; /* Number of lookaside slots allocated */ 140552fb8e19Sdrh u32 anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 140652fb8e19Sdrh LookasideSlot *pInit; /* List of buffers not previously used */ 14077d10d5a6Sdrh LookasideSlot *pFree; /* List of available buffers */ 1408cf014f6cSdrh #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1409cf014f6cSdrh LookasideSlot *pSmallInit; /* List of small buffers not prediously used */ 1410cf014f6cSdrh LookasideSlot *pSmallFree; /* List of available small buffers */ 1411e6068027Sdrh void *pMiddle; /* First byte past end of full-size buffers and 1412cf014f6cSdrh ** the first byte of LOOKASIDE_SMALL buffers */ 1413cf014f6cSdrh #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */ 1414633e6d57Sdrh void *pStart; /* First byte of available memory space */ 1415633e6d57Sdrh void *pEnd; /* First byte past end of available space */ 1416633e6d57Sdrh }; 1417633e6d57Sdrh struct LookasideSlot { 1418633e6d57Sdrh LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 1419633e6d57Sdrh }; 1420633e6d57Sdrh 142131f69626Sdrh #define DisableLookaside db->lookaside.bDisable++;db->lookaside.sz=0 142231f69626Sdrh #define EnableLookaside db->lookaside.bDisable--;\ 142331f69626Sdrh db->lookaside.sz=db->lookaside.bDisable?0:db->lookaside.szTrue 142431f69626Sdrh 1425cf014f6cSdrh /* Size of the smaller allocations in two-size lookside */ 1426cf014f6cSdrh #ifdef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1427cf014f6cSdrh # define LOOKASIDE_SMALL 0 1428e6068027Sdrh #else 1429cf014f6cSdrh # define LOOKASIDE_SMALL 128 1430e6068027Sdrh #endif 14310225d819Sdrh 1432633e6d57Sdrh /* 143380738d9cSdrh ** A hash table for built-in function definitions. (Application-defined 143480738d9cSdrh ** functions use a regular table table from hash.h.) 143570a8ca3cSdrh ** 143670a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 1437a60c6301Sdrh ** Collisions are on the FuncDef.u.pHash chain. Use the SQLITE_FUNC_HASH() 1438a60c6301Sdrh ** macro to compute a hash on the function name. 143970a8ca3cSdrh */ 144080738d9cSdrh #define SQLITE_FUNC_HASH_SZ 23 144170a8ca3cSdrh struct FuncDefHash { 144280738d9cSdrh FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */ 144370a8ca3cSdrh }; 14448bee11a4Smistachkin #define SQLITE_FUNC_HASH(C,L) (((C)+(L))%SQLITE_FUNC_HASH_SZ) 144570a8ca3cSdrh 1446d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1447d4530979Sdrh /* 1448d4530979Sdrh ** Information held in the "sqlite3" database connection object and used 1449d4530979Sdrh ** to manage user authentication. 1450d4530979Sdrh */ 1451d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth; 1452d4530979Sdrh struct sqlite3_userauth { 1453e933b83fSdrh u8 authLevel; /* Current authentication level */ 1454d4530979Sdrh int nAuthPW; /* Size of the zAuthPW in bytes */ 1455d4530979Sdrh char *zAuthPW; /* Password used to authenticate */ 1456d4530979Sdrh char *zAuthUser; /* User name used to authenticate */ 1457d4530979Sdrh }; 1458d4530979Sdrh 1459e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */ 1460e933b83fSdrh #define UAUTH_Unknown 0 /* Authentication not yet checked */ 1461e933b83fSdrh #define UAUTH_Fail 1 /* User authentication failed */ 1462e933b83fSdrh #define UAUTH_User 2 /* Authenticated as a normal user */ 1463e933b83fSdrh #define UAUTH_Admin 3 /* Authenticated as an administrator */ 1464d4530979Sdrh 1465d4530979Sdrh /* Functions used only by user authorization logic */ 1466d4530979Sdrh int sqlite3UserAuthTable(const char*); 1467e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*); 14687883ecfcSdrh void sqlite3UserAuthInit(sqlite3*); 1469f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**); 1470f442e33eSdrh 1471d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */ 1472d4530979Sdrh 147332c6a48bSdrh /* 147432c6a48bSdrh ** typedef for the authorization callback function. 147532c6a48bSdrh */ 147632c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION 147732c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 147832c6a48bSdrh const char*, const char*); 147932c6a48bSdrh #else 148032c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 148132c6a48bSdrh const char*); 148232c6a48bSdrh #endif 148332c6a48bSdrh 14843d2a529dSdrh #ifndef SQLITE_OMIT_DEPRECATED 14853d2a529dSdrh /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing 14863d2a529dSdrh ** in the style of sqlite3_trace() 14873d2a529dSdrh */ 148804c6747aSdrh #define SQLITE_TRACE_LEGACY 0x40 /* Use the legacy xTrace */ 148904c6747aSdrh #define SQLITE_TRACE_XPROFILE 0x80 /* Use the legacy xProfile */ 14903d2a529dSdrh #else 14913d2a529dSdrh #define SQLITE_TRACE_LEGACY 0 149204c6747aSdrh #define SQLITE_TRACE_XPROFILE 0 14933d2a529dSdrh #endif /* SQLITE_OMIT_DEPRECATED */ 149404c6747aSdrh #define SQLITE_TRACE_NONLEGACY_MASK 0x0f /* Normal flags */ 14953d2a529dSdrh 1496099b385dSdrh /* 1497099b385dSdrh ** Maximum number of sqlite3.aDb[] entries. This is the number of attached 1498099b385dSdrh ** databases plus 2 for "main" and "temp". 1499099b385dSdrh */ 1500099b385dSdrh #define SQLITE_MAX_DB (SQLITE_MAX_ATTACHED+2) 1501d4530979Sdrh 150270a8ca3cSdrh /* 1503a2460e07Sdrh ** Each database connection is an instance of the following structure. 150475897234Sdrh */ 15059bb575fdSdrh struct sqlite3 { 150690f6a5beSdrh sqlite3_vfs *pVfs; /* OS Interface */ 1507a451017dSdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 150842a630b1Sdrh CollSeq *pDfltColl; /* BINARY collseq for the database encoding */ 1509a451017dSdrh sqlite3_mutex *mutex; /* Connection mutex */ 1510001bbcbbSdrh Db *aDb; /* All backends */ 1511a451017dSdrh int nDb; /* Number of backends currently in use */ 15128257aa8dSdrh u32 mDbFlags; /* flags recording internal state */ 1513fd748c64Sdrh u64 flags; /* flags settable by pragmas. See below */ 1514a451017dSdrh i64 lastRowid; /* ROWID of most recent insert (see above) */ 15159b4c59faSdrh i64 szMmap; /* Default mmap_size setting */ 1516dc6b41edSdrh u32 nSchemaLock; /* Do not reset the schema when non-zero */ 1517522c26fbSdrh unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 1518fcd35c7bSdrh int errCode; /* Most recent error code (SQLITE_*) */ 15194ac285a1Sdrh int errMask; /* & result codes with this before returning */ 15201b9f2141Sdrh int iSysErrno; /* Errno value from last system error */ 1521af7b7653Sdrh u32 dbOptFlags; /* Flags to enable/disable optimizations */ 15229bd3cc46Sdrh u8 enc; /* Text encoding */ 1523fcd35c7bSdrh u8 autoCommit; /* The auto-commit flag. */ 152490f5ecb3Sdrh u8 temp_store; /* 1: file 2: memory 0: default */ 152517435752Sdrh u8 mallocFailed; /* True if we have seen a malloc failure */ 15264a642b60Sdrh u8 bBenignMalloc; /* Do not require OOMs if true */ 15273b02013eSdrh u8 dfltLockMode; /* Default locking-mode for attached dbs */ 152898757157Sdrh signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 1529a7564663Sdrh u8 suppressErr; /* Do not issue error messages if true */ 1530b061d058Sdan u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */ 1531a451017dSdrh u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 15323d2a529dSdrh u8 mTrace; /* zero or more SQLITE_TRACE flags */ 1533b2c8559fSdrh u8 noSharedCache; /* True if no shared-cache backends */ 1534bce04148Sdrh u8 nSqlExec; /* Number of pending OP_SqlExec opcodes */ 1535f653d782Sdanielk1977 int nextPagesize; /* Pagesize after VACUUM if >0 */ 153664202cfeSdanielk1977 u32 magic; /* Magic number for detect library misuse */ 15372c718873Sdan i64 nChange; /* Value returned by sqlite3_changes() */ 15382c718873Sdan i64 nTotalChange; /* Value returned by sqlite3_total_changes() */ 1539caa639f4Sdrh int aLimit[SQLITE_N_LIMIT]; /* Limits */ 15408930c2abSdan int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */ 15414adee20fSdanielk1977 struct sqlite3InitInfo { /* Information used during initialization */ 1542abc38158Sdrh Pgno newTnum; /* Rootpage of table being initialized */ 1543a451017dSdrh u8 iDb; /* Which db file is being initialized */ 15441d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 1545e616735cSdrh unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */ 1546e616735cSdrh unsigned imposterTable : 1; /* Building an imposter table */ 1547e616735cSdrh unsigned reopenMemdb : 1; /* ATTACH is really a reopen using MemDB */ 1548c5a93d4cSdrh char **azInit; /* "type", "name", and "tbl_name" columns */ 15491d85d931Sdrh } init; 15501713afb0Sdrh int nVdbeActive; /* Number of VDBEs currently running */ 15514f7d3a5fSdrh int nVdbeRead; /* Number of active VDBEs that read or write */ 15524f7d3a5fSdrh int nVdbeWrite; /* Number of active VDBEs that read and write */ 15534f7d3a5fSdrh int nVdbeExec; /* Number of nested calls to VdbeExec() */ 1554086723a4Sdrh int nVDestroy; /* Number of active OP_VDestroy operations */ 1555a451017dSdrh int nExtension; /* Number of loaded extensions */ 1556a451017dSdrh void **aExtension; /* Array of shared library handles */ 155708b92086Sdrh union { 155808b92086Sdrh void (*xLegacy)(void*,const char*); /* Legacy trace function */ 155908b92086Sdrh int (*xV2)(u32,void*,void*,void*); /* V2 Trace function */ 156008b92086Sdrh } trace; 156118de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 156204c6747aSdrh #ifndef SQLITE_OMIT_DEPRECATED 156319e2d37fSdrh void (*xProfile)(void*,const char*,u64); /* Profiling function */ 156419e2d37fSdrh void *pProfileArg; /* Argument to profile function */ 156504c6747aSdrh #endif 1566fcd35c7bSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 1567fcd35c7bSdrh int (*xCommitCallback)(void*); /* Invoked at every commit. */ 156871fd80bfSdanielk1977 void *pRollbackArg; /* Argument to xRollbackCallback() */ 156971fd80bfSdanielk1977 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 157094eb6a14Sdanielk1977 void *pUpdateArg; 157194eb6a14Sdanielk1977 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 15721cf19758Sdrh Parse *pParse; /* Current parse */ 15739b1c62d4Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK 157446c47d46Sdan void *pPreUpdateArg; /* First argument to xPreUpdateCallback */ 157546c47d46Sdan void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */ 157646c47d46Sdan void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64 157746c47d46Sdan ); 157846c47d46Sdan PreUpdate *pPreUpdate; /* Context for active pre-update callback */ 15799b1c62d4Sdrh #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */ 15805cf53537Sdan #ifndef SQLITE_OMIT_WAL 15817ed91f23Sdrh int (*xWalCallback)(void *, sqlite3 *, const char *, int); 15827ed91f23Sdrh void *pWalArg; 15835cf53537Sdan #endif 1584fcd35c7bSdrh void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 1585fcd35c7bSdrh void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 1586fcd35c7bSdrh void *pCollNeededArg; 1587fcd35c7bSdrh sqlite3_value *pErr; /* Most recent error message */ 1588881feaa0Sdrh union { 158939001e75Sdrh volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 1590881feaa0Sdrh double notUsed1; /* Spacer */ 1591881feaa0Sdrh } u1; 1592633e6d57Sdrh Lookaside lookaside; /* Lookaside malloc configuration */ 1593ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 159432c6a48bSdrh sqlite3_xauth xAuth; /* Access authorization function */ 1595ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 1596ed6c8671Sdrh #endif 1597348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 1598348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 1599348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 16008f8c65f7Sdrh unsigned nProgressOps; /* Number of opcodes for progress callback */ 1601348bb5d6Sdanielk1977 #endif 1602b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 1603a451017dSdrh int nVTrans; /* Allocated size of aVTrans */ 1604b9bb7c18Sdrh Hash aModule; /* populated by sqlite3_create_module() */ 1605b061d058Sdan VtabCtx *pVtabCtx; /* Context for active vtab connect/create */ 1606595a523aSdanielk1977 VTable **aVTrans; /* Virtual tables with open transactions */ 1607595a523aSdanielk1977 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 16086b456a2bSdanielk1977 #endif 160980738d9cSdrh Hash aFunc; /* Hash table of connection functions */ 1610fcd35c7bSdrh Hash aCollSeq; /* All collating sequences */ 1611fcd35c7bSdrh BusyHandler busyHandler; /* Busy callback */ 1612fcd35c7bSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 1613fd7f0452Sdanielk1977 Savepoint *pSavepoint; /* List of active savepoints */ 161449a76a8fSdrh int nAnalysisLimit; /* Number of index rows to ANALYZE */ 1615a451017dSdrh int busyTimeout; /* Busy handler timeout, in msec */ 1616fd7f0452Sdanielk1977 int nSavepoint; /* Number of non-transaction savepoints */ 1617bd43455cSdanielk1977 int nStatement; /* Number of nested statement-transactions */ 16181da40a38Sdan i64 nDeferredCons; /* Net deferred constraints this transaction. */ 1619648e2643Sdrh i64 nDeferredImmCons; /* Net deferred immediate constraints */ 1620d46def77Sdan int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 1621404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 1622ccb2113aSdrh /* The following variables are all protected by the STATIC_MAIN 1623404ca075Sdanielk1977 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 162465a73badSdrh ** 162565a73badSdrh ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 162665a73badSdrh ** unlock so that it can proceed. 162765a73badSdrh ** 162865a73badSdrh ** When X.pBlockingConnection==Y, that means that something that X tried 162965a73badSdrh ** tried to do recently failed with an SQLITE_LOCKED error due to locks 163065a73badSdrh ** held by Y. 1631404ca075Sdanielk1977 */ 1632404ca075Sdanielk1977 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 1633404ca075Sdanielk1977 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 1634404ca075Sdanielk1977 void *pUnlockArg; /* Argument to xUnlockNotify */ 1635404ca075Sdanielk1977 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 1636404ca075Sdanielk1977 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 1637404ca075Sdanielk1977 #endif 1638d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1639d4530979Sdrh sqlite3_userauth auth; /* User authentication information */ 1640d4530979Sdrh #endif 164175897234Sdrh }; 164275897234Sdrh 164303b808a6Sdrh /* 164403b808a6Sdrh ** A macro to discover the encoding of a database. 164503b808a6Sdrh */ 16469bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc) 16479bd3cc46Sdrh #define ENC(db) ((db)->enc) 164814db2665Sdanielk1977 164975897234Sdrh /* 1650b945bcdaSdrh ** A u64 constant where the lower 32 bits are all zeros. Only the 1651b945bcdaSdrh ** upper 32 bits are included in the argument. Necessary because some 1652b945bcdaSdrh ** C-compilers still do not accept LL integer literals. 1653b945bcdaSdrh */ 1654b945bcdaSdrh #define HI(X) ((u64)(X)<<32) 1655b945bcdaSdrh 1656b945bcdaSdrh /* 165707096f68Sdrh ** Possible values for the sqlite3.flags. 165849711600Sdrh ** 165949711600Sdrh ** Value constraints (enforced via assert()): 166049711600Sdrh ** SQLITE_FullFSync == PAGER_FULLFSYNC 166149711600Sdrh ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC 166249711600Sdrh ** SQLITE_CacheSpill == PAGER_CACHE_SPILL 166375897234Sdrh */ 1664ccb2113aSdrh #define SQLITE_WriteSchema 0x00000001 /* OK to update SQLITE_SCHEMA */ 1665169dd928Sdrh #define SQLITE_LegacyFileFmt 0x00000002 /* Create new databases in format 1 */ 16666841b1cbSdrh #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */ 16676841b1cbSdrh #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */ 16686841b1cbSdrh #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */ 16696841b1cbSdrh #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */ 167040c3941cSdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 1671b77da374Sdrh #define SQLITE_TrustedSchema 0x00000080 /* Allow unsafe functions and 16722928a15bSdrh ** vtabs in the schema definition */ 167367c82653Sdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 167467c82653Sdrh /* result set is empty */ 1675169dd928Sdrh #define SQLITE_IgnoreChecks 0x00000200 /* Do not enforce check constraints */ 1676169dd928Sdrh #define SQLITE_ReadUncommit 0x00000400 /* READ UNCOMMITTED in shared-cache */ 1677169dd928Sdrh #define SQLITE_NoCkptOnClose 0x00000800 /* No checkpoint on close()/DETACH */ 1678169dd928Sdrh #define SQLITE_ReverseOrder 0x00001000 /* Reverse unordered SELECTs */ 1679169dd928Sdrh #define SQLITE_RecTriggers 0x00002000 /* Enable recursive triggers */ 1680169dd928Sdrh #define SQLITE_ForeignKeys 0x00004000 /* Enforce foreign key constraints */ 1681169dd928Sdrh #define SQLITE_AutoIndex 0x00008000 /* Enable automatic indexes */ 1682169dd928Sdrh #define SQLITE_LoadExtension 0x00010000 /* Enable load_extension */ 16838257aa8dSdrh #define SQLITE_LoadExtFunc 0x00020000 /* Enable load_extension() SQL func */ 16848257aa8dSdrh #define SQLITE_EnableTrigger 0x00040000 /* True to enable triggers */ 16858257aa8dSdrh #define SQLITE_DeferFKs 0x00080000 /* Defer all FK constraints */ 16868257aa8dSdrh #define SQLITE_QueryOnly 0x00100000 /* Disable database changes */ 16878257aa8dSdrh #define SQLITE_CellSizeCk 0x00200000 /* Check btree cell sizes on load */ 16888257aa8dSdrh #define SQLITE_Fts3Tokenizer 0x00400000 /* Enable fts3_tokenizer(2) */ 16898257aa8dSdrh #define SQLITE_EnableQPSG 0x00800000 /* Query Planner Stability Guarantee*/ 169036e31c69Sdrh #define SQLITE_TriggerEQP 0x01000000 /* Show trigger EXPLAIN QUERY PLAN */ 16910314cf3aSdrh #define SQLITE_ResetDatabase 0x02000000 /* Reset the database */ 1692674b8942Sdan #define SQLITE_LegacyAlter 0x04000000 /* Legacy ALTER TABLE behaviour */ 1693fd748c64Sdrh #define SQLITE_NoSchemaError 0x08000000 /* Do not report schema parse errors*/ 1694a296cda0Sdrh #define SQLITE_Defensive 0x10000000 /* Input SQL is likely hostile */ 1695d0ff601cSdrh #define SQLITE_DqsDDL 0x20000000 /* dbl-quoted strings allowed in DDL*/ 1696d0ff601cSdrh #define SQLITE_DqsDML 0x40000000 /* dbl-quoted strings allowed in DML*/ 169711d88e68Sdrh #define SQLITE_EnableView 0x80000000 /* Enable the use of views */ 1698b945bcdaSdrh #define SQLITE_CountRows HI(0x00001) /* Count rows changed by INSERT, */ 1699b945bcdaSdrh /* DELETE, or UPDATE and return */ 1700b945bcdaSdrh /* the count using a callback. */ 170136e31c69Sdrh 1702169dd928Sdrh /* Flags used only if debugging */ 1703169dd928Sdrh #ifdef SQLITE_DEBUG 170411d88e68Sdrh #define SQLITE_SqlTrace HI(0x0100000) /* Debug print SQL as it executes */ 170511d88e68Sdrh #define SQLITE_VdbeListing HI(0x0200000) /* Debug listings of VDBE progs */ 170611d88e68Sdrh #define SQLITE_VdbeTrace HI(0x0400000) /* True to trace VDBE execution */ 170711d88e68Sdrh #define SQLITE_VdbeAddopTrace HI(0x0800000) /* Trace sqlite3VdbeAddOp() calls */ 170811d88e68Sdrh #define SQLITE_VdbeEQP HI(0x1000000) /* Debug EXPLAIN QUERY PLAN */ 170911d88e68Sdrh #define SQLITE_ParserTrace HI(0x2000000) /* PRAGMA parser_trace=ON */ 1710169dd928Sdrh #endif 1711b1eaa718Sdrh 17128257aa8dSdrh /* 17138257aa8dSdrh ** Allowed values for sqlite3.mDbFlags 17148257aa8dSdrh */ 17158257aa8dSdrh #define DBFLAG_SchemaChange 0x0001 /* Uncommitted Hash table changes */ 17168257aa8dSdrh #define DBFLAG_PreferBuiltin 0x0002 /* Preference to built-in funcs */ 17178257aa8dSdrh #define DBFLAG_Vacuum 0x0004 /* Currently in a VACUUM */ 17184e61e883Sdrh #define DBFLAG_VacuumInto 0x0008 /* Currently running VACUUM INTO */ 17194e61e883Sdrh #define DBFLAG_SchemaKnownOk 0x0010 /* Schema is known to be valid */ 1720171c50ecSdrh #define DBFLAG_InternalFunc 0x0020 /* Allow use of internal functions */ 17210ea2d42aSdan #define DBFLAG_EncodingFixed 0x0040 /* No longer possible to change enc. */ 172207096f68Sdrh 172307096f68Sdrh /* 17247e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the 17257e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to 17267e5418e4Sdrh ** selectively disable various optimizations. 172707096f68Sdrh */ 1728af7b7653Sdrh #define SQLITE_QueryFlattener 0x00000001 /* Query flattening */ 1729af7b7653Sdrh #define SQLITE_WindowFunc 0x00000002 /* Use xInverse for window functions */ 1730af7b7653Sdrh #define SQLITE_GroupByOrder 0x00000004 /* GROUPBY cover of ORDERBY */ 1731af7b7653Sdrh #define SQLITE_FactorOutConst 0x00000008 /* Constant factoring */ 1732af7b7653Sdrh #define SQLITE_DistinctOpt 0x00000010 /* DISTINCT using indexes */ 1733af7b7653Sdrh #define SQLITE_CoverIdxScan 0x00000020 /* Covering index scans */ 1734af7b7653Sdrh #define SQLITE_OrderByIdxJoin 0x00000040 /* ORDER BY of joins via index */ 1735af7b7653Sdrh #define SQLITE_Transitive 0x00000080 /* Transitive constraints */ 1736af7b7653Sdrh #define SQLITE_OmitNoopJoin 0x00000100 /* Omit unused tables in joins */ 1737af7b7653Sdrh #define SQLITE_CountOfView 0x00000200 /* The count-of-view optimization */ 1738af7b7653Sdrh #define SQLITE_CursorHints 0x00000400 /* Add OP_CursorHint opcodes */ 1739af7b7653Sdrh #define SQLITE_Stat4 0x00000800 /* Use STAT4 data */ 1740af7b7653Sdrh /* TH3 expects this value ^^^^^^^^^^ to be 0x0000800. Don't change it */ 1741af7b7653Sdrh #define SQLITE_PushDown 0x00001000 /* The push-down optimization */ 1742af7b7653Sdrh #define SQLITE_SimplifyJoin 0x00002000 /* Convert LEFT JOIN to JOIN */ 1743af7b7653Sdrh #define SQLITE_SkipScan 0x00004000 /* Skip-scans */ 1744af7b7653Sdrh #define SQLITE_PropagateConst 0x00008000 /* The constant propagation opt */ 1745af7b7653Sdrh #define SQLITE_MinMaxOpt 0x00010000 /* The min/max optimization */ 17463074faabSdrh #define SQLITE_SeekScan 0x00020000 /* The OP_SeekScan optimization */ 1747*bb301231Sdrh #define SQLITE_OmitOrderBy 0x00040000 /* Omit pointless ORDER BY */ 1748af7b7653Sdrh #define SQLITE_AllOpts 0xffffffff /* All optimizations */ 17497e5418e4Sdrh 17507e5418e4Sdrh /* 17517e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled. 17527e5418e4Sdrh */ 17537e5418e4Sdrh #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0) 17547e5418e4Sdrh #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0) 175534c68fbaSdanielk1977 175658b9576bSdrh /* 1757d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization 1758d9f158e7Sdrh ** code. The argument is a Parse object for the code generator. 1759d9f158e7Sdrh */ 1760aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor) 1761d9f158e7Sdrh 1762d9f158e7Sdrh /* 1763247be43dSdrh ** Possible values for the sqlite.magic field. 1764247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 1765247be43dSdrh ** than being distinct from one another. 1766247be43dSdrh */ 1767247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 1768247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 17697e8b848aSdrh #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 1770247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 1771247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 17724245c405Sdrh #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */ 1773247be43dSdrh 1774247be43dSdrh /* 17750bce8354Sdrh ** Each SQL function is defined by an instance of the following 177680738d9cSdrh ** structure. For global built-in functions (ex: substr(), max(), count()) 177780738d9cSdrh ** a pointer to this structure is held in the sqlite3BuiltinFunctions object. 177880738d9cSdrh ** For per-connection application-defined functions, a pointer to this 177980738d9cSdrh ** structure is held in the db->aHash hash table. 178080738d9cSdrh ** 178180738d9cSdrh ** The u.pHash field is used by the global built-ins. The u.pDestructor 178280738d9cSdrh ** field is used by per-connection app-def functions. 17832803757aSdrh */ 17840bce8354Sdrh struct FuncDef { 178580738d9cSdrh i8 nArg; /* Number of arguments. -1 means unlimited */ 1786dfa552f4Sdan u32 funcFlags; /* Some combination of SQLITE_FUNC_* */ 17871350b030Sdrh void *pUserData; /* User data parameter */ 17880bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 17892d80151fSdrh void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */ 17902d80151fSdrh void (*xFinalize)(sqlite3_context*); /* Agg finalizer */ 179186fb6e17Sdan void (*xValue)(sqlite3_context*); /* Current agg value */ 179286fb6e17Sdan void (*xInverse)(sqlite3_context*,int,sqlite3_value**); /* inverse agg-step */ 17936ad224e9Sdrh const char *zName; /* SQL name of the function. */ 179480738d9cSdrh union { 179570a8ca3cSdrh FuncDef *pHash; /* Next with a different name but the same hash */ 1796d2199f0fSdan FuncDestructor *pDestructor; /* Reference counted destructor function */ 179780738d9cSdrh } u; 1798d2199f0fSdan }; 1799d2199f0fSdan 1800d2199f0fSdan /* 1801d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as 1802d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When 1803d2199f0fSdan ** create_function_v2() is called to create a function with a destructor, 1804d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to 1805d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether 1806d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 1807d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated 1808d2199f0fSdan ** FuncDestructor. 1809d2199f0fSdan ** 1810d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference 1811d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor 1812d2199f0fSdan ** is invoked and the FuncDestructor structure freed. 1813d2199f0fSdan */ 1814d2199f0fSdan struct FuncDestructor { 1815d2199f0fSdan int nRef; 1816d2199f0fSdan void (*xDestroy)(void *); 1817d2199f0fSdan void *pUserData; 18188e0a2f90Sdrh }; 18192803757aSdrh 18202803757aSdrh /* 1821a748fdccSdrh ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF 18227977fa3aSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And 18237977fa3aSdrh ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There 1824a748fdccSdrh ** are assert() statements in the code to verify this. 182549711600Sdrh ** 182649711600Sdrh ** Value constraints (enforced via assert()): 182749711600Sdrh ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg 1828*bb301231Sdrh ** SQLITE_FUNC_ANYORDER == NC_OrderAgg == SF_OrderByReqd 182949711600Sdrh ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG 183049711600Sdrh ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG 183149711600Sdrh ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API 183242d2fce7Sdrh ** SQLITE_FUNC_DIRECT == SQLITE_DIRECTONLY from the API 18334be621e1Sdrh ** SQLITE_FUNC_UNSAFE == SQLITE_INNOCUOUS 183449711600Sdrh ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API 18357d10d5a6Sdrh */ 18361d85e405Sdrh #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */ 18371d85e405Sdrh #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */ 18381d85e405Sdrh #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */ 18391d85e405Sdrh #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */ 18401d85e405Sdrh #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/ 18411d85e405Sdrh #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */ 18421d85e405Sdrh #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */ 18431d85e405Sdrh #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */ 1844ffe421c7Sdrh /* 0x0200 -- available for reuse */ 18451d85e405Sdrh #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */ 18461d85e405Sdrh #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */ 18479588ad95Sdrh #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */ 1848a7f910b5Sdrh #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a 1849a7f910b5Sdrh ** single query - might change over time */ 185025c4296bSdrh #define SQLITE_FUNC_TEST 0x4000 /* Built-in testing functions */ 1851092457b1Sdrh #define SQLITE_FUNC_OFFSET 0x8000 /* Built-in sqlite_offset() function */ 1852eea8eb6dSdrh #define SQLITE_FUNC_WINDOW 0x00010000 /* Built-in window-only function */ 1853eea8eb6dSdrh #define SQLITE_FUNC_INTERNAL 0x00040000 /* For use by NestedParse() only */ 185442d2fce7Sdrh #define SQLITE_FUNC_DIRECT 0x00080000 /* Not for use in TRIGGERs or VIEWs */ 1855e2ba6df9Sdan #define SQLITE_FUNC_SUBTYPE 0x00100000 /* Result likely to have sub-type */ 18564be621e1Sdrh #define SQLITE_FUNC_UNSAFE 0x00200000 /* Function has side effects */ 1857c4ad8499Sdrh #define SQLITE_FUNC_INLINE 0x00400000 /* Functions implemented in-line */ 1858*bb301231Sdrh #define SQLITE_FUNC_ANYORDER 0x08000000 /* count/min/max aggregate */ 1859c4ad8499Sdrh 186025c4296bSdrh /* Identifier numbers for each in-line function */ 1861171c50ecSdrh #define INLINEFUNC_coalesce 0 1862171c50ecSdrh #define INLINEFUNC_implies_nonnull_row 1 1863171c50ecSdrh #define INLINEFUNC_expr_implies_expr 2 1864171c50ecSdrh #define INLINEFUNC_expr_compare 3 1865171c50ecSdrh #define INLINEFUNC_affinity 4 18663c0e606bSdrh #define INLINEFUNC_iif 5 1867171c50ecSdrh #define INLINEFUNC_unlikely 99 /* Default case */ 18687d10d5a6Sdrh 18697d10d5a6Sdrh /* 1870777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1871777c5386Sdrh ** used to create the initializers for the FuncDef structures. 1872777c5386Sdrh ** 1873777c5386Sdrh ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1874777c5386Sdrh ** Used to create a scalar function definition of a function zName 1875777c5386Sdrh ** implemented by C function xFunc that accepts nArg arguments. The 1876777c5386Sdrh ** value passed as iArg is cast to a (void*) and made available 1877777c5386Sdrh ** as the user-data (sqlite3_user_data()) for the function. If 1878f7bca574Sdrh ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1879777c5386Sdrh ** 1880b1fba286Sdrh ** VFUNCTION(zName, nArg, iArg, bNC, xFunc) 1881b1fba286Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag. 1882b1fba286Sdrh ** 188364de2a5fSdrh ** SFUNCTION(zName, nArg, iArg, bNC, xFunc) 188464de2a5fSdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 188564de2a5fSdrh ** adds the SQLITE_DIRECTONLY flag. 188664de2a5fSdrh ** 188725c4296bSdrh ** INLINE_FUNC(zName, nArg, iFuncId, mFlags) 188825c4296bSdrh ** zName is the name of a function that is implemented by in-line 188925c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 189025c4296bSdrh ** parameter determines the function id. The mFlags parameter is 189125c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 189225c4296bSdrh ** 189325c4296bSdrh ** TEST_FUNC(zName, nArg, iFuncId, mFlags) 189425c4296bSdrh ** zName is the name of a test-only function implemented by in-line 189525c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 189625c4296bSdrh ** parameter determines the function id. The mFlags parameter is 189725c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 189825c4296bSdrh ** 18991d85e405Sdrh ** DFUNCTION(zName, nArg, iArg, bNC, xFunc) 19001d85e405Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 1901a7f910b5Sdrh ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions 190203bf26d9Sdrh ** and functions like sqlite_version() that can change, but not during 19033e34eabcSdrh ** a single query. The iArg is ignored. The user-data is always set 19043e34eabcSdrh ** to a NULL pointer. The bNC parameter is not used. 19053e34eabcSdrh ** 1906f6e904bdSdrh ** MFUNCTION(zName, nArg, xPtr, xFunc) 1907f6e904bdSdrh ** For math-library functions. xPtr is an arbitrary pointer. 1908f6e904bdSdrh ** 19093e34eabcSdrh ** PURE_DATE(zName, nArg, iArg, bNC, xFunc) 19103e34eabcSdrh ** Used for "pure" date/time functions, this macro is like DFUNCTION 19113e34eabcSdrh ** except that it does set the SQLITE_FUNC_CONSTANT flags. iArg is 19123e34eabcSdrh ** ignored and the user-data for these functions is set to an 19133e34eabcSdrh ** arbitrary non-NULL pointer. The bNC parameter is not used. 19141d85e405Sdrh ** 1915777c5386Sdrh ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1916777c5386Sdrh ** Used to create an aggregate function definition implemented by 1917777c5386Sdrh ** the C functions xStep and xFinal. The first four parameters 1918777c5386Sdrh ** are interpreted in the same way as the first 4 parameters to 1919777c5386Sdrh ** FUNCTION(). 1920777c5386Sdrh ** 192186fb6e17Sdan ** WFUNCTION(zName, nArg, iArg, xStep, xFinal, xValue, xInverse) 192286fb6e17Sdan ** Used to create an aggregate function definition implemented by 192386fb6e17Sdan ** the C functions xStep and xFinal. The first four parameters 192486fb6e17Sdan ** are interpreted in the same way as the first 4 parameters to 192586fb6e17Sdan ** FUNCTION(). 192686fb6e17Sdan ** 1927777c5386Sdrh ** LIKEFUNC(zName, nArg, pArg, flags) 1928777c5386Sdrh ** Used to create a scalar function definition of a function zName 1929777c5386Sdrh ** that accepts nArg arguments and is implemented by a call to C 1930777c5386Sdrh ** function likeFunc. Argument pArg is cast to a (void *) and made 1931777c5386Sdrh ** available as the function user-data (sqlite3_user_data()). The 1932777c5386Sdrh ** FuncDef.flags variable is set to the value passed as the flags 1933777c5386Sdrh ** parameter. 1934777c5386Sdrh */ 1935777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19364be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 193786fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1938b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1939d36e1041Sdrh {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 194086fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 194164de2a5fSdrh #define SFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 194279d5bc80Sdrh {nArg, SQLITE_UTF8|SQLITE_DIRECTONLY|SQLITE_FUNC_UNSAFE, \ 194364de2a5fSdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1944f6e904bdSdrh #define MFUNCTION(zName, nArg, xPtr, xFunc) \ 1945f6e904bdSdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8, \ 1946f6e904bdSdrh xPtr, 0, xFunc, 0, 0, 0, #zName, {0} } 194725c4296bSdrh #define INLINE_FUNC(zName, nArg, iArg, mFlags) \ 19484be621e1Sdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 194925c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 195025c4296bSdrh #define TEST_FUNC(zName, nArg, iArg, mFlags) \ 195125c4296bSdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INTERNAL|SQLITE_FUNC_TEST| \ 19524be621e1Sdrh SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 195325c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 19541d85e405Sdrh #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19554be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \ 195686fb6e17Sdan 0, 0, xFunc, 0, 0, 0, #zName, {0} } 19573e34eabcSdrh #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \ 19584be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 195986fb6e17Sdan (void*)&sqlite3Config, 0, xFunc, 0, 0, 0, #zName, {0} } 1960a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \ 19614be621e1Sdrh {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\ 196286fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 196321717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 19644be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 196586fb6e17Sdan pArg, 0, xFunc, 0, 0, 0, #zName, } 1966777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \ 19674be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \ 196886fb6e17Sdan (void *)arg, 0, likeFunc, 0, 0, 0, #zName, {0} } 19696fb2b54cSdan #define WAGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue, xInverse, f) \ 19706fb2b54cSdan {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|f, \ 197103854d2eSdan SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,xInverse,#zName, {0}} 1972eea8eb6dSdrh #define INTERNAL_FUNCTION(zName, nArg, xFunc) \ 1973eea8eb6dSdrh {nArg, SQLITE_FUNC_INTERNAL|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 1974eea8eb6dSdrh 0, 0, xFunc, 0, 0, 0, #zName, {0} } 1975eea8eb6dSdrh 1976777c5386Sdrh 1977fd7f0452Sdanielk1977 /* 1978fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at 1979fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently 1980fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe 1981fd7f0452Sdanielk1977 ** OP_Savepoint instruction. 1982fd7f0452Sdanielk1977 */ 1983fd7f0452Sdanielk1977 struct Savepoint { 1984fd7f0452Sdanielk1977 char *zName; /* Savepoint name (nul-terminated) */ 1985fcb9f7adSdrh i64 nDeferredCons; /* Number of deferred fk violations */ 1986648e2643Sdrh i64 nDeferredImmCons; /* Number of deferred imm fk. */ 1987fd7f0452Sdanielk1977 Savepoint *pNext; /* Parent savepoint (if any) */ 1988fd7f0452Sdanielk1977 }; 1989fd7f0452Sdanielk1977 1990fd7f0452Sdanielk1977 /* 1991fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(), 1992fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction. 1993fd7f0452Sdanielk1977 */ 1994fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN 0 1995fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE 1 1996fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK 2 1997fd7f0452Sdanielk1977 1998777c5386Sdrh 1999777c5386Sdrh /* 2000d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an 2001d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule 2002d1ab1ba5Sdanielk1977 ** hash table. 2003d1ab1ba5Sdanielk1977 */ 2004d1ab1ba5Sdanielk1977 struct Module { 2005d1ab1ba5Sdanielk1977 const sqlite3_module *pModule; /* Callback pointers */ 2006d1ab1ba5Sdanielk1977 const char *zName; /* Name passed to create_module() */ 2007cc5979dbSdrh int nRefModule; /* Number of pointers to this object */ 2008d1ab1ba5Sdanielk1977 void *pAux; /* pAux passed to create_module() */ 2009832a58a6Sdanielk1977 void (*xDestroy)(void *); /* Module destructor function */ 201051be3873Sdrh Table *pEpoTab; /* Eponymous table for this module */ 2011d1ab1ba5Sdanielk1977 }; 2012d1ab1ba5Sdanielk1977 2013d1ab1ba5Sdanielk1977 /* 2014b9bcf7caSdrh ** Information about each column of an SQL table is held in an instance 2015b9bcf7caSdrh ** of the Column structure, in the Table.aCol[] array. 2016b9bcf7caSdrh ** 2017b9bcf7caSdrh ** Definitions: 2018b9bcf7caSdrh ** 2019b9bcf7caSdrh ** "table column index" This is the index of the column in the 2020b9bcf7caSdrh ** Table.aCol[] array, and also the index of 2021b9bcf7caSdrh ** the column in the original CREATE TABLE stmt. 2022b9bcf7caSdrh ** 2023b9bcf7caSdrh ** "storage column index" This is the index of the column in the 2024b9bcf7caSdrh ** record BLOB generated by the OP_MakeRecord 2025b9bcf7caSdrh ** opcode. The storage column index is less than 2026b9bcf7caSdrh ** or equal to the table column index. It is 2027b9bcf7caSdrh ** equal if and only if there are no VIRTUAL 2028b9bcf7caSdrh ** columns to the left. 20297020f651Sdrh */ 20307020f651Sdrh struct Column { 203194eaafa9Sdrh char *zName; /* Name of this column, \000, then the type */ 203281f7b372Sdrh Expr *pDflt; /* Default value or GENERATED ALWAYS AS value */ 2033b3bf556eSdanielk1977 char *zColl; /* Collating sequence. If NULL, use the default */ 2034a371ace4Sdrh u8 notNull; /* An OE_ code for handling a NOT NULL constraint */ 2035a37cdde0Sdanielk1977 char affinity; /* One of the SQLITE_AFF_... values */ 2036e5520e2fSdrh u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */ 2037d44390c8Sdrh u8 hName; /* Column name hash for faster lookup */ 20389942ef0dSdrh u16 colFlags; /* Boolean properties. See COLFLAG_ defines below */ 20397020f651Sdrh }; 20407020f651Sdrh 20416f6e60ddSdrh /* Allowed values for Column.colFlags. 20426f6e60ddSdrh ** 20436f6e60ddSdrh ** Constraints: 20446f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 20456f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 20466f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 2047a371ace4Sdrh */ 2048a371ace4Sdrh #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */ 2049a371ace4Sdrh #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */ 2050d7564865Sdrh #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */ 205126e731ccSdan #define COLFLAG_UNIQUE 0x0008 /* Column def contains "UNIQUE" or "PK" */ 20522e3a5a81Sdan #define COLFLAG_SORTERREF 0x0010 /* Use sorter-refs with this column */ 205381f7b372Sdrh #define COLFLAG_VIRTUAL 0x0020 /* GENERATED ALWAYS AS ... VIRTUAL */ 205481f7b372Sdrh #define COLFLAG_STORED 0x0040 /* GENERATED ALWAYS AS ... STORED */ 205512bf7127Sdrh #define COLFLAG_NOTAVAIL 0x0080 /* STORED column not yet calculated */ 205612bf7127Sdrh #define COLFLAG_BUSY 0x0100 /* Blocks recursion on GENERATED columns */ 2057c27ea2aeSdrh #define COLFLAG_GENERATED 0x0060 /* Combo: _STORED, _VIRTUAL */ 20587e508f1eSdrh #define COLFLAG_NOINSERT 0x0062 /* Combo: _HIDDEN, _STORED, _VIRTUAL */ 2059a371ace4Sdrh 20607020f651Sdrh /* 2061a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following 20620202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and 20630202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence. 2064a9fd84b0Sdrh ** 2065e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the 20660202b29eSdanielk1977 ** collating sequence is undefined. Indices built on an undefined 20670202b29eSdanielk1977 ** collating sequence may not be read or written. 2068a9fd84b0Sdrh */ 2069a9fd84b0Sdrh struct CollSeq { 20700202b29eSdanielk1977 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 2071466be56bSdanielk1977 u8 enc; /* Text encoding handled by xCmp() */ 2072a9fd84b0Sdrh void *pUser; /* First argument to xCmp() */ 20730202b29eSdanielk1977 int (*xCmp)(void*,int, const void*, int, const void*); 2074a9808b31Sdanielk1977 void (*xDel)(void*); /* Destructor for pUser */ 2075a9fd84b0Sdrh }; 2076a9fd84b0Sdrh 2077a9fd84b0Sdrh /* 2078d3d39e93Sdrh ** A sort order can be either ASC or DESC. 20798e2ca029Sdrh */ 20808e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 2081d3d39e93Sdrh #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 2082bc622bc0Sdrh #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */ 20838e2ca029Sdrh 20848e2ca029Sdrh /* 2085a37cdde0Sdanielk1977 ** Column affinity types. 20868a51256cSdrh ** 20878a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 20888a51256cSdrh ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 20897d10d5a6Sdrh ** the speed a little by numbering the values consecutively. 20908a51256cSdrh ** 20914583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'. That way, 20928a51256cSdrh ** when multiple affinity types are concatenated into a string and 209366a5167bSdrh ** used as the P4 operand, they will be more readable. 20948a51256cSdrh ** 20958a51256cSdrh ** Note also that the numeric types are grouped together so that testing 209605883a34Sdrh ** for a numeric type is a single comparison. And the BLOB type is first. 2097a37cdde0Sdanielk1977 */ 209896fb16eeSdrh #define SQLITE_AFF_NONE 0x40 /* '@' */ 209996fb16eeSdrh #define SQLITE_AFF_BLOB 0x41 /* 'A' */ 210096fb16eeSdrh #define SQLITE_AFF_TEXT 0x42 /* 'B' */ 210196fb16eeSdrh #define SQLITE_AFF_NUMERIC 0x43 /* 'C' */ 210296fb16eeSdrh #define SQLITE_AFF_INTEGER 0x44 /* 'D' */ 210396fb16eeSdrh #define SQLITE_AFF_REAL 0x45 /* 'E' */ 2104a37cdde0Sdanielk1977 21058a51256cSdrh #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 2106a37cdde0Sdanielk1977 2107a37cdde0Sdanielk1977 /* 210835573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an 210935573356Sdrh ** affinity value. 211035573356Sdrh */ 21114583c37cSdrh #define SQLITE_AFF_MASK 0x47 211235573356Sdrh 211335573356Sdrh /* 211435573356Sdrh ** Additional bit values that can be ORed with an affinity without 211535573356Sdrh ** changing the affinity. 21163d77dee9Sdrh ** 21173d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL. 21183d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison 21193d77dee9Sdrh ** operator is NULL. It is added to certain comparison operators to 21203d77dee9Sdrh ** prove that the operands are always NOT NULL. 212135573356Sdrh */ 21224583c37cSdrh #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */ 21236a2fe093Sdrh #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 21244583c37cSdrh #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */ 212535573356Sdrh 212635573356Sdrh /* 2127595a523aSdanielk1977 ** An object of this type is created for each virtual table present in 2128595a523aSdanielk1977 ** the database schema. 2129595a523aSdanielk1977 ** 2130595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this 2131595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared 2132595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique 2133595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table 2134595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between 2135595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database 2136595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database 2137595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method 2138595a523aSdanielk1977 ** during initialization internally. This database connection handle may 21399bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables 2140595a523aSdanielk1977 ** within the database. So that they appear as part of the callers 2141595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database 2142595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table. 2143595a523aSdanielk1977 ** 2144595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared 2145595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by 2146595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object. 2147595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual 2148595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the 2149595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct 2150595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query. 2151595a523aSdanielk1977 ** 2152595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the 2153595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not 2154595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 2155595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to 2156595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the 2157595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 2158595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done 2159595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 2160595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an 2161595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 2162595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex. 2163595a523aSdanielk1977 ** 2164595a523aSdanielk1977 ** The memory for objects of this type is always allocated by 2165595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 2166595a523aSdanielk1977 ** the first argument. 2167595a523aSdanielk1977 */ 2168595a523aSdanielk1977 struct VTable { 2169595a523aSdanielk1977 sqlite3 *db; /* Database connection associated with this table */ 2170595a523aSdanielk1977 Module *pMod; /* Pointer to module implementation */ 2171595a523aSdanielk1977 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 2172595a523aSdanielk1977 int nRef; /* Number of pointers to this structure */ 2173b061d058Sdan u8 bConstraint; /* True if constraints are supported */ 21742928a15bSdrh u8 eVtabRisk; /* Riskiness of allowing hacker access */ 2175addd8f87Sdrh int iSavepoint; /* Depth of the SAVEPOINT stack */ 2176595a523aSdanielk1977 VTable *pNext; /* Next in linked list (see above) */ 2177595a523aSdanielk1977 }; 2178595a523aSdanielk1977 21792928a15bSdrh /* Allowed values for VTable.eVtabRisk 21802928a15bSdrh */ 21812928a15bSdrh #define SQLITE_VTABRISK_Low 0 21822928a15bSdrh #define SQLITE_VTABRISK_Normal 1 21832928a15bSdrh #define SQLITE_VTABRISK_High 2 21842928a15bSdrh 2185595a523aSdanielk1977 /* 21865789d1a4Sdrh ** The schema for each SQL table and view is represented in memory 21875789d1a4Sdrh ** by an instance of the following structure. 218875897234Sdrh */ 218975897234Sdrh struct Table { 21907d10d5a6Sdrh char *zName; /* Name of the table or view */ 21917020f651Sdrh Column *aCol; /* Information about each column */ 2192967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 2193a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 2194c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 21953d1bfeaaSdanielk1977 char *zColAff; /* String defining the affinity of each column */ 21962938f924Sdrh ExprList *pCheck; /* All CHECK constraints */ 21978981b904Sdrh /* ... also used as column name list in a VIEW */ 2198abc38158Sdrh Pgno tnum; /* Root BTree page for this table */ 219979df7782Sdrh u32 nTabRef; /* Number of pointers to this Table */ 22006f271a42Sdrh u32 tabFlags; /* Mask of TF_* values */ 22015789d1a4Sdrh i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */ 2202d815f17dSdrh i16 nCol; /* Number of columns in this table */ 22030b0b3a95Sdrh i16 nNVCol; /* Number of columns that are not VIRTUAL */ 22045789d1a4Sdrh LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */ 2205bf539c4dSdrh LogEst szTabRow; /* Estimated size of each table row in bytes */ 2206dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT 2207dbd9486dSdrh LogEst costMult; /* Cost multiplier for using this table */ 2208dbd9486dSdrh #endif 2209d815f17dSdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 221019a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE 22117d10d5a6Sdrh int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 221219a8e7e8Sdanielk1977 #endif 2213e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 2214b9bb7c18Sdrh int nModuleArg; /* Number of arguments to the module */ 22158a48b9c0Sdrh char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */ 2216d815f17dSdrh VTable *pVTable; /* List of VTable objects. */ 2217e09daa90Sdrh #endif 22182f886d1dSdanielk1977 Trigger *pTrigger; /* List of triggers stored in pSchema */ 2219728b5779Sdrh Schema *pSchema; /* Schema that contains this table */ 222075897234Sdrh }; 222175897234Sdrh 222275897234Sdrh /* 22238ce7184bSdan ** Allowed values for Table.tabFlags. 2224a21f78b9Sdrh ** 222580090f92Sdrh ** TF_OOOHidden applies to tables or view that have hidden columns that are 2226a21f78b9Sdrh ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING 2227a21f78b9Sdrh ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden, 2228a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case. Such tables require 2229c1431144Sdrh ** special handling during INSERT processing. The "OOO" means "Out Of Order". 2230c1431144Sdrh ** 2231c1431144Sdrh ** Constraints: 2232c1431144Sdrh ** 22336f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 22346f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 22356f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 22367d10d5a6Sdrh */ 223733bec3f5Sdrh #define TF_Readonly 0x0001 /* Read-only system table */ 22386f6e60ddSdrh #define TF_HasHidden 0x0002 /* Has one or more hidden columns */ 223933bec3f5Sdrh #define TF_HasPrimaryKey 0x0004 /* Table has a primary key */ 224033bec3f5Sdrh #define TF_Autoincrement 0x0008 /* Integer primary key is autoincrement */ 2241a3928dd7Sdrh #define TF_HasStat1 0x0010 /* nRowLogEst set from sqlite_stat1 */ 2242c1431144Sdrh #define TF_HasVirtual 0x0020 /* Has one or more VIRTUAL columns */ 2243c1431144Sdrh #define TF_HasStored 0x0040 /* Has one or more STORED columns */ 2244427b96aeSdrh #define TF_HasGenerated 0x0060 /* Combo: HasVirtual + HasStored */ 2245c1431144Sdrh #define TF_WithoutRowid 0x0080 /* No rowid. PRIMARY KEY is the key */ 22465e98e838Sdrh #define TF_StatsUsed 0x0100 /* Query planner decisions affected by 2247a3928dd7Sdrh ** Index.aiRowLogEst[] values */ 2248c1431144Sdrh #define TF_NoVisibleRowid 0x0200 /* No user-visible "rowid" column */ 2249c1431144Sdrh #define TF_OOOHidden 0x0400 /* Out-of-Order hidden columns */ 2250c1431144Sdrh #define TF_HasNotNull 0x0800 /* Contains NOT NULL constraints */ 2251c1431144Sdrh #define TF_Shadow 0x1000 /* True for a shadow table */ 225240386968Sdrh #define TF_HasStat4 0x2000 /* STAT4 info available for this table */ 22536f6e60ddSdrh #define TF_Ephemeral 0x4000 /* An ephemeral table */ 22543d8c92d0Sdrh #define TF_Eponymous 0x8000 /* An eponymous virtual table */ 22557d10d5a6Sdrh 22567d10d5a6Sdrh /* 22574cbdda9eSdrh ** Test to see whether or not a table is a virtual table. This is 22584cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual 22594cbdda9eSdrh ** table support is omitted from the build. 22604cbdda9eSdrh */ 22614cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 226244266ec6Sdrh # define IsVirtual(X) ((X)->nModuleArg) 226378d1d225Sdrh # define ExprIsVtab(X) \ 226478d1d225Sdrh ((X)->op==TK_COLUMN && (X)->y.pTab!=0 && (X)->y.pTab->nModuleArg) 22654cbdda9eSdrh #else 22664cbdda9eSdrh # define IsVirtual(X) 0 226778d1d225Sdrh # define ExprIsVtab(X) 0 22684cbdda9eSdrh #endif 22694cbdda9eSdrh 227003d69a68Sdrh /* 227103d69a68Sdrh ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn() 227203d69a68Sdrh ** only works for non-virtual tables (ordinary tables and views) and is 227303d69a68Sdrh ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The 227403d69a68Sdrh ** IsHiddenColumn() macro is general purpose. 227503d69a68Sdrh */ 227603d69a68Sdrh #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS) 227703d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 227803d69a68Sdrh # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 227918f8e734Sdrh #elif !defined(SQLITE_OMIT_VIRTUALTABLE) 228003d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 228103d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 228203d69a68Sdrh #else 228303d69a68Sdrh # define IsHiddenColumn(X) 0 228403d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 228503d69a68Sdrh #endif 228603d69a68Sdrh 228703d69a68Sdrh 2288ec95c441Sdrh /* Does the table have a rowid */ 2289ec95c441Sdrh #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0) 2290fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0) 2291ec95c441Sdrh 22924cbdda9eSdrh /* 2293c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 2294c2eef3b3Sdrh ** 2295c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 2296c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 2297c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 2298c2eef3b3Sdrh ** Consider this example: 2299c2eef3b3Sdrh ** 2300c2eef3b3Sdrh ** CREATE TABLE ex1( 2301c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 2302c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 2303c2eef3b3Sdrh ** ); 2304c2eef3b3Sdrh ** 2305c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 2306bd50a926Sdrh ** Equivalent names: 2307bd50a926Sdrh ** 2308bd50a926Sdrh ** from-table == child-table 2309bd50a926Sdrh ** to-table == parent-table 2310c2eef3b3Sdrh ** 2311c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 2312c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 2313e61922a6Sdrh ** the from-table is created. The existence of the to-table is not checked. 2314bd50a926Sdrh ** 2315bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey. 2316bd50a926Sdrh ** 2317bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist) 2318bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z. 2319c2eef3b3Sdrh */ 2320c2eef3b3Sdrh struct FKey { 23211f638cebSdrh Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 2322bd50a926Sdrh FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */ 23231f638cebSdrh char *zTo; /* Name of table that the key points to (aka: Parent) */ 2324bd50a926Sdrh FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */ 2325bd50a926Sdrh FKey *pPrevTo; /* Previous with the same zTo */ 2326c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 23274c429839Sdrh /* EV: R-30323-21917 */ 2328c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 23298099ce6fSdan u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 23308099ce6fSdan Trigger *apTrigger[2];/* Triggers for aAction[] actions */ 2331e61922a6Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 2332e61922a6Sdrh int iFrom; /* Index of column in pFrom */ 2333bd50a926Sdrh char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */ 2334e61922a6Sdrh } aCol[1]; /* One entry for each of nCol columns */ 2335c2eef3b3Sdrh }; 2336c2eef3b3Sdrh 2337c2eef3b3Sdrh /* 2338aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint 233922f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 23400bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 23411c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 23421c92853dSdrh ** fails and any prior changes from that one operation are backed out, 23431c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 23441c92853dSdrh ** the operation in progress stops and returns an error code. But prior 23451c92853dSdrh ** changes due to the same operation are not backed out and no rollback 23461c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 23471c92853dSdrh ** error is not inserted or updated. Processing continues and no error 23481c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 23491c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 23501c92853dSdrh ** update can proceed. Processing continues and no error is reported. 23515602777eSdrh ** UPDATE applies to insert operations only and means that the insert 23525602777eSdrh ** is omitted and the DO UPDATE clause of an upsert is run instead. 23531c92853dSdrh ** 23545602777eSdrh ** RESTRICT, SETNULL, SETDFLT, and CASCADE actions apply only to foreign keys. 2355c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 2356c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 23575602777eSdrh ** key is set to NULL. SETDFLT means that the foreign key is set 23585602777eSdrh ** to its default value. CASCADE means that a DELETE or UPDATE of the 2359c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 2360c2eef3b3Sdrh ** foreign key. 2361c2eef3b3Sdrh ** 23625602777eSdrh ** The OE_Default value is a place holder that means to use whatever 23635602777eSdrh ** conflict resolution algorthm is required from context. 23645602777eSdrh ** 2365968af52aSdrh ** The following symbolic values are used to record which type 23665602777eSdrh ** of conflict resolution action to take. 23679cfcf5d4Sdrh */ 23689cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 23691c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 23701c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 23711c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 23721c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 23731c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 2374c8a0c90bSdrh #define OE_Update 6 /* Process as a DO UPDATE in an upsert */ 2375c8a0c90bSdrh #define OE_Restrict 7 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 2376c8a0c90bSdrh #define OE_SetNull 8 /* Set the foreign key value to NULL */ 2377c8a0c90bSdrh #define OE_SetDflt 9 /* Set the foreign key value to its default */ 2378c8a0c90bSdrh #define OE_Cascade 10 /* Cascade the changes */ 2379c8a0c90bSdrh #define OE_Default 11 /* Do whatever the default action is */ 23809cfcf5d4Sdrh 2381d3d39e93Sdrh 2382d3d39e93Sdrh /* 2383d3d39e93Sdrh ** An instance of the following structure is passed as the first 2384d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the 2385d3d39e93Sdrh ** comparison of the two index keys. 2386323df790Sdrh ** 2387323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots. There 2388323df790Sdrh ** are nField slots for the columns of an index then one extra slot 2389323df790Sdrh ** for the rowid at the end. 2390d3d39e93Sdrh */ 2391d3d39e93Sdrh struct KeyInfo { 23922ec2fb22Sdrh u32 nRef; /* Number of references to this KeyInfo object */ 23939b8d0272Sdrh u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 2394a485ad19Sdrh u16 nKeyField; /* Number of key columns in the index */ 2395a485ad19Sdrh u16 nAllField; /* Total columns, including key plus others */ 23962ec2fb22Sdrh sqlite3 *db; /* The database connection */ 23976e11892dSdan u8 *aSortFlags; /* Sort order for each column. */ 2398d3d39e93Sdrh CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 2399d3d39e93Sdrh }; 2400d3d39e93Sdrh 2401905d4729Sdrh /* 2402905d4729Sdrh ** Allowed bit values for entries in the KeyInfo.aSortFlags[] array. 2403905d4729Sdrh */ 2404905d4729Sdrh #define KEYINFO_ORDER_DESC 0x01 /* DESC sort order */ 2405905d4729Sdrh #define KEYINFO_ORDER_BIGNULL 0x02 /* NULL is larger than any other value */ 24066e11892dSdan 24079cfcf5d4Sdrh /* 2408b1d607deSdrh ** This object holds a record which has been parsed out into individual 2409b1d607deSdrh ** fields, for the purposes of doing a comparison. 2410e63d9991Sdrh ** 2411e63d9991Sdrh ** A record is an object that contains one or more fields of data. 2412e63d9991Sdrh ** Records are used to store the content of a table row and to store 2413e63d9991Sdrh ** the key of an index. A blob encoding of a record is created by 2414467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 2415e63d9991Sdrh ** OP_Column opcode. 2416e63d9991Sdrh ** 2417b1d607deSdrh ** An instance of this object serves as a "key" for doing a search on 2418b1d607deSdrh ** an index b+tree. The goal of the search is to find the entry that 2419b1d607deSdrh ** is closed to the key described by this object. This object might hold 2420b1d607deSdrh ** just a prefix of the key. The number of fields is given by 2421b1d607deSdrh ** pKeyInfo->nField. 24223833e934Sdan ** 2423b1d607deSdrh ** The r1 and r2 fields are the values to return if this key is less than 2424b1d607deSdrh ** or greater than a key in the btree, respectively. These are normally 2425b1d607deSdrh ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree 2426b1d607deSdrh ** is in DESC order. 2427b1d607deSdrh ** 2428b1d607deSdrh ** The key comparison functions actually return default_rc when they find 2429b1d607deSdrh ** an equals comparison. default_rc can be -1, 0, or +1. If there are 2430b1d607deSdrh ** multiple entries in the b-tree with the same key (when only looking 2431b1d607deSdrh ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to 2432b1d607deSdrh ** cause the search to find the last match, or +1 to cause the search to 2433b1d607deSdrh ** find the first match. 2434b1d607deSdrh ** 2435b1d607deSdrh ** The key comparison functions will set eqSeen to true if they ever 2436b1d607deSdrh ** get and equal results when comparing this structure to a b-tree record. 2437b1d607deSdrh ** When default_rc!=0, the search might end up on the record immediately 2438b1d607deSdrh ** before the first match or immediately after the last match. The 2439b1d607deSdrh ** eqSeen field will indicate whether or not an exact match exists in the 2440b1d607deSdrh ** b-tree. 2441e63d9991Sdrh */ 2442e63d9991Sdrh struct UnpackedRecord { 2443e63d9991Sdrh KeyInfo *pKeyInfo; /* Collation and sort-order information */ 244470528d78Sdrh Mem *aMem; /* Values */ 2445e63d9991Sdrh u16 nField; /* Number of entries in apMem[] */ 2446a9e0aeb5Sdrh i8 default_rc; /* Comparison result if keys are equal */ 244738fdead8Sdan u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */ 244861ffb2cdSdrh i8 r1; /* Value to return if (lhs < rhs) */ 244961ffb2cdSdrh i8 r2; /* Value to return if (lhs > rhs) */ 245070528d78Sdrh u8 eqSeen; /* True if an equality comparison has been seen */ 2451e63d9991Sdrh }; 2452e63d9991Sdrh 2453e63d9991Sdrh 2454e63d9991Sdrh /* 245566b89c8fSdrh ** Each SQL index is represented in memory by an 245675897234Sdrh ** instance of the following structure. 2457967e8b73Sdrh ** 2458967e8b73Sdrh ** The columns of the table that are to be indexed are described 2459967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 2460967e8b73Sdrh ** we have the following table and index: 2461967e8b73Sdrh ** 2462967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 2463967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 2464967e8b73Sdrh ** 2465967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 2466967e8b73Sdrh ** three columns in the table. In the Index structure describing 2467967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 2468967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 2469967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 2470967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 2471967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 2472ea1ba17cSdrh ** 2473ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 2474ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 2475ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 2476ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 2477ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 2478ea1ba17cSdrh ** element. 2479c5b73585Sdan ** 2480c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to 2481ccb2113aSdrh ** generate VDBE code (as opposed to parsing one read from an sqlite_schema 2482c5b73585Sdan ** table as part of parsing an existing database schema), transient instances 2483c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is 2484c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page 2485c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE 2486c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details. 248775897234Sdrh */ 248875897234Sdrh struct Index { 248975897234Sdrh char *zName; /* Name of this index */ 2490bbbdc83bSdrh i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */ 2491cfc9df76Sdan LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */ 2492967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 2493a37cdde0Sdanielk1977 char *zColAff; /* String defining the affinity of each column */ 249475897234Sdrh Index *pNext; /* The next index associated with the same table */ 2495b3bf556eSdanielk1977 Schema *pSchema; /* Schema containing this index */ 2496b376daebSdrh u8 *aSortOrder; /* for each column: True==DESC, False==ASC */ 2497f19aa5faSdrh const char **azColl; /* Array of collation sequence names for index */ 24981fe0537eSdrh Expr *pPartIdxWhere; /* WHERE clause for partial indices */ 24991f9ca2c8Sdrh ExprList *aColExpr; /* Column expressions */ 2500abc38158Sdrh Pgno tnum; /* DB Page containing root of this index */ 2501bf539c4dSdrh LogEst szIdxRow; /* Estimated average row size in bytes */ 2502bbbdc83bSdrh u16 nKeyCol; /* Number of columns forming the key */ 2503bbbdc83bSdrh u16 nColumn; /* Number of columns stored in the index */ 2504bf539c4dSdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 25055f913ecbSdrh unsigned idxType:2; /* 0:Normal 1:UNIQUE, 2:PRIMARY KEY, 3:IPK */ 2506b376daebSdrh unsigned bUnordered:1; /* Use this index for == or IN queries only */ 25077699d1c4Sdrh unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */ 25087f9c5dbfSdrh unsigned isResized:1; /* True if resizeIndexObject() has been called */ 2509ec95c441Sdrh unsigned isCovering:1; /* True if this is a covering index */ 2510f9df2fbdSdrh unsigned noSkipScan:1; /* Do not try to use skip-scan if true */ 2511a3928dd7Sdrh unsigned hasStat1:1; /* aiRowLogEst values come from sqlite_stat1 */ 25127e8515d8Sdrh unsigned bNoQuery:1; /* Do not use this index to optimize queries */ 2513bf9ff256Sdrh unsigned bAscKeyBug:1; /* True if the bba7b69f9849b5bf bug applies */ 2514c7476735Sdrh unsigned bHasVCol:1; /* Index references one or more VIRTUAL columns */ 2515175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 25162b9cf669Sdrh int nSample; /* Number of elements in aSample[] */ 25178ad169abSdan int nSampleCol; /* Size of IndexSample.anEq[] and so on */ 2518eea568d6Sdan tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */ 2519faacf17cSdrh IndexSample *aSample; /* Samples of the left-most key */ 25209f07cf7bSdrh tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */ 25219f07cf7bSdrh tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */ 2522faacf17cSdrh #endif 25231fe3ac73Sdrh Bitmask colNotIdxed; /* 0 for unindexed columns in pTab */ 252402fa4696Sdan }; 252502fa4696Sdan 252602fa4696Sdan /* 252748dd1d8eSdrh ** Allowed values for Index.idxType 252848dd1d8eSdrh */ 252948dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */ 253048dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */ 253148dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */ 25325f913ecbSdrh #define SQLITE_IDXTYPE_IPK 3 /* INTEGER PRIMARY KEY index */ 253348dd1d8eSdrh 253448dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */ 253548dd1d8eSdrh #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY) 253648dd1d8eSdrh 25375f1d1d9cSdrh /* Return true if index X is a UNIQUE index */ 25385f1d1d9cSdrh #define IsUniqueIndex(X) ((X)->onError!=OE_None) 25395f1d1d9cSdrh 25404b92f98cSdrh /* The Index.aiColumn[] values are normally positive integer. But 25414b92f98cSdrh ** there are some negative values that have special meaning: 25424b92f98cSdrh */ 25434b92f98cSdrh #define XN_ROWID (-1) /* Indexed column is the rowid */ 25444b92f98cSdrh #define XN_EXPR (-2) /* Indexed column is an expression */ 25454b92f98cSdrh 254648dd1d8eSdrh /* 2547175b8f06Sdrh ** Each sample stored in the sqlite_stat4 table is represented in memory 254874e7c8f5Sdrh ** using a structure of this type. See documentation at the top of the 254974e7c8f5Sdrh ** analyze.c source file for additional information. 255002fa4696Sdan */ 255102fa4696Sdan struct IndexSample { 2552f52bb8d3Sdan void *p; /* Pointer to sampled record */ 2553f52bb8d3Sdan int n; /* Size of record in bytes */ 2554f52bb8d3Sdan tRowcnt *anEq; /* Est. number of rows where the key equals this sample */ 2555f52bb8d3Sdan tRowcnt *anLt; /* Est. number of rows where key is less than this sample */ 2556f52bb8d3Sdan tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */ 255775897234Sdrh }; 255875897234Sdrh 255975897234Sdrh /* 25608bee11a4Smistachkin ** Possible values to use within the flags argument to sqlite3GetToken(). 25618bee11a4Smistachkin */ 25628bee11a4Smistachkin #define SQLITE_TOKEN_QUOTED 0x1 /* Token is a quoted identifier. */ 25638bee11a4Smistachkin #define SQLITE_TOKEN_KEYWORD 0x2 /* Token is a keyword. */ 25648bee11a4Smistachkin 25658bee11a4Smistachkin /* 256675897234Sdrh ** Each token coming out of the lexer is an instance of 25674b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 25684efc4754Sdrh ** 25694a2c747cSdrh ** The memory that "z" points to is owned by other objects. Take care 25704a2c747cSdrh ** that the owner of the "z" string does not deallocate the string before 25714a2c747cSdrh ** the Token goes out of scope! Very often, the "z" points to some place 25724a2c747cSdrh ** in the middle of the Parse.zSql text. But it might also point to a 25734a2c747cSdrh ** static string. 257475897234Sdrh */ 257575897234Sdrh struct Token { 2576b7916a78Sdrh const char *z; /* Text of the token. Not NULL-terminated! */ 2577b7916a78Sdrh unsigned int n; /* Number of characters in this token */ 257875897234Sdrh }; 257975897234Sdrh 258075897234Sdrh /* 258113449892Sdrh ** An instance of this structure contains information needed to generate 258213449892Sdrh ** code for a SELECT that contains aggregate functions. 258313449892Sdrh ** 258413449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 258516dc07f7Sdrh ** pointer to this structure. The Expr.iAgg field is the index in 258613449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 258713449892Sdrh ** code for that node. 258813449892Sdrh ** 258913449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 259013449892Sdrh ** original Select structure that describes the SELECT statement. These 259113449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure. 259213449892Sdrh */ 259313449892Sdrh struct AggInfo { 259413449892Sdrh u8 directMode; /* Direct rendering mode means take data directly 259513449892Sdrh ** from source tables rather than from accumulators */ 259613449892Sdrh u8 useSortingIdx; /* In direct mode, reference the sorting index rather 259713449892Sdrh ** than the source table */ 259813449892Sdrh int sortingIdx; /* Cursor number of the sorting index */ 25995134d135Sdan int sortingIdxPTab; /* Cursor number of pseudo-table */ 260013449892Sdrh int nSortingColumn; /* Number of columns in the sorting index */ 26017e61d18eSdrh int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */ 2602a451017dSdrh ExprList *pGroupBy; /* The group by clause */ 260313449892Sdrh struct AggInfo_col { /* For each column used in source tables */ 26040817d0dfSdanielk1977 Table *pTab; /* Source table */ 260581185a51Sdrh Expr *pCExpr; /* The original expression */ 260613449892Sdrh int iTable; /* Cursor number of the source table */ 260713449892Sdrh int iMem; /* Memory location that acts as accumulator */ 260889636628Sdrh i16 iColumn; /* Column number within the source table */ 260989636628Sdrh i16 iSorterColumn; /* Column number in the sorting index */ 261013449892Sdrh } *aCol; 261113449892Sdrh int nColumn; /* Number of used entries in aCol[] */ 261213449892Sdrh int nAccumulator; /* Number of columns that show through to the output. 261313449892Sdrh ** Additional columns are used only as parameters to 261413449892Sdrh ** aggregate functions */ 261513449892Sdrh struct AggInfo_func { /* For each aggregate function */ 261681185a51Sdrh Expr *pFExpr; /* Expression encoding the function */ 261713449892Sdrh FuncDef *pFunc; /* The aggregate function implementation */ 261813449892Sdrh int iMem; /* Memory location that acts as accumulator */ 2619467bcf36Sshane int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 26209bfafa89Sdan int iDistAddr; /* Address of OP_OpenEphemeral */ 262113449892Sdrh } *aFunc; 262213449892Sdrh int nFunc; /* Number of entries in aFunc[] */ 2623e26d428aSdrh u32 selId; /* Select to which this AggInfo belongs */ 262413449892Sdrh }; 262513449892Sdrh 262613449892Sdrh /* 26278677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 26288677d308Sdrh ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 26298677d308Sdrh ** than 32767 we have to make it 32-bit. 16-bit is preferred because 26308677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user 26318677d308Sdrh ** in systems with lots of prepared statements. And few applications 26328677d308Sdrh ** need more than about 10 or 20 variables. But some extreme users want 2633efdba1a8Sdrh ** to have prepared statements with over 32766 variables, and for them 26348677d308Sdrh ** the option is available (at compile-time). 26358677d308Sdrh */ 2636efdba1a8Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<32767 2637481aa74eSdrh typedef i16 ynVar; 26388677d308Sdrh #else 26398677d308Sdrh typedef int ynVar; 26408677d308Sdrh #endif 26418677d308Sdrh 26428677d308Sdrh /* 264375897234Sdrh ** Each node of an expression in the parse tree is an instance 264422f70c32Sdrh ** of this structure. 264522f70c32Sdrh ** 264622f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 264722f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 264822f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 264922f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 265022f70c32Sdrh ** tree. 265122f70c32Sdrh ** 26526ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 26536ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 26546ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 26556ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 26566ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function. 265722f70c32Sdrh ** 26586ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 26596ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL. 26606ab3a2ecSdanielk1977 ** 26616ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 26626ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 26636ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 26646ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 26656ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 26666ab3a2ecSdanielk1977 ** valid. 266722f70c32Sdrh ** 266822f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 266922f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 267022f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 267122f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 267222f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 267322f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 267422f70c32Sdrh ** it can be accessed after all aggregates are computed. 267522f70c32Sdrh ** 26766ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark 26776ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index 26786ab3a2ecSdanielk1977 ** number for that variable. 267922f70c32Sdrh ** 26801398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer 26811398ad36Sdrh ** register number containing the result of the subquery. If the 26821398ad36Sdrh ** subquery gives a constant result, then iTable is -1. If the subquery 26831398ad36Sdrh ** gives a different answer at different times during statement processing 26841398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery. 26851398ad36Sdrh ** 2686aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from 2687aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 2688aee18ef8Sdanielk1977 ** corresponding table definition. 26896ab3a2ecSdanielk1977 ** 26906ab3a2ecSdanielk1977 ** ALLOCATION NOTES: 26916ab3a2ecSdanielk1977 ** 269212ffee8cSdrh ** Expr objects can use a lot of memory space in database schema. To 269312ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be 269412ffee8cSdrh ** truncated. And to reduce the number of memory allocations, sometimes 269512ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation, 269633e619fcSdrh ** together with Expr.zToken strings. 26976ab3a2ecSdanielk1977 ** 2698b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when 269912ffee8cSdrh ** an Expr object is truncated. When EP_Reduced is set, then all 270012ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 270112ffee8cSdrh ** are contained within the same memory allocation. Note, however, that 270212ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 270312ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set. 270475897234Sdrh */ 270575897234Sdrh struct Expr { 27061cc093c2Sdrh u8 op; /* Operation performed by this node */ 27071194904bSdrh char affExpr; /* affinity, or RAISE type */ 270820cee7d0Sdrh u8 op2; /* TK_REGISTER/TK_TRUTH: original value of Expr.op 270920cee7d0Sdrh ** TK_COLUMN: the value of p5 for OP_Column 271020cee7d0Sdrh ** TK_AGG_FUNCTION: nesting depth 271120cee7d0Sdrh ** TK_FUNCTION: NC_SelfRef flag if needs OP_PureFunc */ 2712e7375bfaSdrh #ifdef SQLITE_DEBUG 2713e7375bfaSdrh u8 vvaFlags; /* Verification flags. */ 2714e7375bfaSdrh #endif 2715c5cd1249Sdrh u32 flags; /* Various flags. EP_* See below */ 271633e619fcSdrh union { 2717b7916a78Sdrh char *zToken; /* Token value. Zero terminated and dequoted */ 2718d50ffc41Sdrh int iValue; /* Non-negative integer value if EP_IntValue */ 271933e619fcSdrh } u; 27206ab3a2ecSdanielk1977 27216ab3a2ecSdanielk1977 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 27226ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27236ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27246ab3a2ecSdanielk1977 *********************************************************************/ 27256ab3a2ecSdanielk1977 27266ab3a2ecSdanielk1977 Expr *pLeft; /* Left subnode */ 27276ab3a2ecSdanielk1977 Expr *pRight; /* Right subnode */ 27286ab3a2ecSdanielk1977 union { 2729c5cd1249Sdrh ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */ 2730c5cd1249Sdrh Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */ 27316ab3a2ecSdanielk1977 } x; 27326ab3a2ecSdanielk1977 27336ab3a2ecSdanielk1977 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 27346ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27356ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27366ab3a2ecSdanielk1977 *********************************************************************/ 27376ab3a2ecSdanielk1977 27386ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0 27396ec65491Sdrh int nHeight; /* Height of the tree headed by this node */ 27406ec65491Sdrh #endif 2741b7916a78Sdrh int iTable; /* TK_COLUMN: cursor number of table holding column 27422832ad42Sdan ** TK_REGISTER: register number 2743cca9f3d2Sdrh ** TK_TRIGGER: 1 -> new, 0 -> old 2744fc7f27b9Sdrh ** EP_Unlikely: 134217728 times likelihood 2745818a3b54Sdrh ** TK_IN: ephemerial table holding RHS 2746554a9dc7Sdrh ** TK_SELECT_COLUMN: Number of columns on the LHS 2747fc7f27b9Sdrh ** TK_SELECT: 1st register of result vector */ 27488677d308Sdrh ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 2749fc7f27b9Sdrh ** TK_VARIABLE: variable number (always >= 1). 2750fc7f27b9Sdrh ** TK_SELECT_COLUMN: column of the result vector */ 2751b7916a78Sdrh i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 2752961a7260Sdan int iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 275313449892Sdrh AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 2754eda079cdSdrh union { 2755eda079cdSdrh Table *pTab; /* TK_COLUMN: Table containing column. Can be NULL 27564dd89d5aSdrh ** for a column of an index on an expression */ 27574f9adee2Sdan Window *pWin; /* EP_WinFunc: Window/Filter defn for a function */ 27582c04131cSdrh struct { /* TK_IN, TK_SELECT, and TK_EXISTS */ 27592c04131cSdrh int iAddr; /* Subroutine entry address */ 27602c04131cSdrh int regReturn; /* Register used to hold return address */ 27612c04131cSdrh } sub; 2762eda079cdSdrh } y; 276375897234Sdrh }; 276475897234Sdrh 276575897234Sdrh /* 27661f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 2767d137f4e6Sdrh ** Value restrictions: 2768d137f4e6Sdrh ** 2769d137f4e6Sdrh ** EP_Agg == NC_HasAgg == SF_HasAgg 2770d137f4e6Sdrh ** EP_Win == NC_HasWin 27711f16230bSdrh */ 277272673a24Sdrh #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */ 2773d137f4e6Sdrh #define EP_Distinct 0x000002 /* Aggregate function with DISTINCT keyword */ 2774fca23557Sdrh #define EP_HasFunc 0x000004 /* Contains one or more functions of any kind */ 2775efad2e23Sdrh #define EP_FixedCol 0x000008 /* TK_Column with a known fixed value */ 2776d137f4e6Sdrh #define EP_Agg 0x000010 /* Contains one or more aggregate functions */ 2777c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */ 2778c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */ 2779c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */ 2780fbb24d10Sdrh #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */ 2781898c527eSdrh #define EP_Commuted 0x000200 /* Comparison operator has been commuted */ 2782c5cd1249Sdrh #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */ 2783c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */ 2784a7d6db6aSdrh #define EP_Skip 0x001000 /* Operator does not contribute to affinity */ 2785c5cd1249Sdrh #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */ 2786c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */ 2787d137f4e6Sdrh #define EP_Win 0x008000 /* Contains window functions */ 2788c5cd1249Sdrh #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */ 278946fe138dSdrh #define EP_IfNullRow 0x020000 /* The TK_IF_NULL_ROW opcode */ 2790a4c3c87eSdrh #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */ 2791a7f910b5Sdrh #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */ 279272673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */ 2793885a5b03Sdrh #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */ 279429f6a365Sdrh /* 0x400000 // Available */ 2795209bc522Sdrh #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */ 2796eda079cdSdrh #define EP_WinFunc 0x1000000 /* TK_FUNCTION with Expr.y.pWin set */ 27972c04131cSdrh #define EP_Subrtn 0x2000000 /* Uses Expr.y.sub. TK_IN, _SELECT, or _EXISTS */ 279851d35b0fSdrh #define EP_Quoted 0x4000000 /* TK_ID was originally quoted */ 2799d137f4e6Sdrh #define EP_Static 0x8000000 /* Held in memory not obtained from malloc() */ 2800ad31727fSdrh #define EP_IsTrue 0x10000000 /* Always has boolean value of TRUE */ 2801ad31727fSdrh #define EP_IsFalse 0x20000000 /* Always has boolean value of FALSE */ 2802ccb2113aSdrh #define EP_FromDDL 0x40000000 /* Originates from sqlite_schema */ 2803e7375bfaSdrh /* 0x80000000 // Available */ 2804885a5b03Sdrh 2805885a5b03Sdrh /* 2806fca23557Sdrh ** The EP_Propagate mask is a set of properties that automatically propagate 2807fca23557Sdrh ** upwards into parent nodes. 2808885a5b03Sdrh */ 2809fca23557Sdrh #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc) 281033e619fcSdrh 281133e619fcSdrh /* 28121f16230bSdrh ** These macros can be used to test, set, or clear bits in the 28131f16230bSdrh ** Expr.flags field. 28141f16230bSdrh */ 2815c5cd1249Sdrh #define ExprHasProperty(E,P) (((E)->flags&(P))!=0) 2816c5cd1249Sdrh #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P)) 28171f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 28181f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 2819ad31727fSdrh #define ExprAlwaysTrue(E) (((E)->flags&(EP_FromJoin|EP_IsTrue))==EP_IsTrue) 2820ad31727fSdrh #define ExprAlwaysFalse(E) (((E)->flags&(EP_FromJoin|EP_IsFalse))==EP_IsFalse) 28211f16230bSdrh 2822e7375bfaSdrh 2823e7375bfaSdrh /* Flags for use with Expr.vvaFlags 2824e7375bfaSdrh */ 2825e7375bfaSdrh #define EP_NoReduce 0x01 /* Cannot EXPRDUP_REDUCE this Expr */ 2826e7375bfaSdrh #define EP_Immutable 0x02 /* Do not change this Expr node */ 2827e7375bfaSdrh 2828ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation, 2829ebb6a65dSdrh ** and Accreditation only. It works like ExprSetProperty() during VVA 2830ebb6a65dSdrh ** processes but is a no-op for delivery. 2831ebb6a65dSdrh */ 2832ebb6a65dSdrh #ifdef SQLITE_DEBUG 2833e7375bfaSdrh # define ExprSetVVAProperty(E,P) (E)->vvaFlags|=(P) 2834e7375bfaSdrh # define ExprHasVVAProperty(E,P) (((E)->vvaFlags&(P))!=0) 2835e7375bfaSdrh # define ExprClearVVAProperties(E) (E)->vvaFlags = 0 2836ebb6a65dSdrh #else 2837ebb6a65dSdrh # define ExprSetVVAProperty(E,P) 2838e7375bfaSdrh # define ExprHasVVAProperty(E,P) 0 2839e7375bfaSdrh # define ExprClearVVAProperties(E) 2840ebb6a65dSdrh #endif 2841ebb6a65dSdrh 28421f16230bSdrh /* 28436ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr 28446ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 28456ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set. 28466ab3a2ecSdanielk1977 */ 284712ffee8cSdrh #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 284812ffee8cSdrh #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 2849b7916a78Sdrh #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 28506ab3a2ecSdanielk1977 28516ab3a2ecSdanielk1977 /* 28526ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment 28536ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details. 28546ab3a2ecSdanielk1977 */ 285512ffee8cSdrh #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 28566ab3a2ecSdanielk1977 28576ab3a2ecSdanielk1977 /* 28584f9adee2Sdan ** True if the expression passed as an argument was a function with 28594f9adee2Sdan ** an OVER() clause (a window function). 28604f9adee2Sdan */ 28613703edf1Sdan #ifdef SQLITE_OMIT_WINDOWFUNC 28623703edf1Sdan # define IsWindowFunc(p) 0 28633703edf1Sdan #else 28644f9adee2Sdan # define IsWindowFunc(p) ( \ 28654f9adee2Sdan ExprHasProperty((p), EP_WinFunc) && p->y.pWin->eFrmType!=TK_FILTER \ 28664f9adee2Sdan ) 28673703edf1Sdan #endif 28684f9adee2Sdan 28694f9adee2Sdan /* 287075897234Sdrh ** A list of expressions. Each expression may optionally have a 287175897234Sdrh ** name. An expr/name combination can be used in several ways, such 287275897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 287375897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 2874ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 287575897234Sdrh ** field is not used. 28760dde4739Sdrh ** 2877cbb9da33Sdrh ** In order to try to keep memory usage down, the Expr.a.zEName field 2878cbb9da33Sdrh ** is used for multiple purposes: 2879cbb9da33Sdrh ** 2880c4938ea2Sdrh ** eEName Usage 2881c4938ea2Sdrh ** ---------- ------------------------- 2882c4938ea2Sdrh ** ENAME_NAME (1) the AS of result set column 2883cbb9da33Sdrh ** (2) COLUMN= of an UPDATE 2884cbb9da33Sdrh ** 2885c4938ea2Sdrh ** ENAME_TAB DB.TABLE.NAME used to resolve names 2886cbb9da33Sdrh ** of subqueries 2887cbb9da33Sdrh ** 2888c4938ea2Sdrh ** ENAME_SPAN Text of the original result set 2889cbb9da33Sdrh ** expression. 289075897234Sdrh */ 289175897234Sdrh struct ExprList { 289275897234Sdrh int nExpr; /* Number of expressions on the list */ 289350e43c50Sdrh int nAlloc; /* Number of a[] slots allocated */ 2894d872bb18Sdrh struct ExprList_item { /* For each expression in the list */ 2895c5f4816fSdrh Expr *pExpr; /* The parse tree for this expression */ 289641cee668Sdrh char *zEName; /* Token associated with this expression */ 28979105fd51Sdan u8 sortFlags; /* Mask of KEYINFO_ORDER_* flags */ 2898cbb9da33Sdrh unsigned eEName :2; /* Meaning of zEName */ 28990dde4739Sdrh unsigned done :1; /* A flag to indicate when processing is finished */ 2900d673cddaSdrh unsigned reusable :1; /* Constant expression is reusable */ 290124e25d32Sdan unsigned bSorterRef :1; /* Defer evaluation until after sorting */ 29029105fd51Sdan unsigned bNulls: 1; /* True if explicit "NULLS FIRST/LAST" */ 2903c2acc4e4Sdrh union { 2904c2acc4e4Sdrh struct { 29054b3ac73cSdrh u16 iOrderByCol; /* For ORDER BY, column number in result set */ 29068b213899Sdrh u16 iAlias; /* Index into Parse.aAlias[] for zName */ 2907c2acc4e4Sdrh } x; 2908c2acc4e4Sdrh int iConstExprReg; /* Register in which Expr value is cached */ 2909c2acc4e4Sdrh } u; 291043606175Sdrh } a[1]; /* One slot for each expression in the list */ 291175897234Sdrh }; 291275897234Sdrh 291375897234Sdrh /* 2914cbb9da33Sdrh ** Allowed values for Expr.a.eEName 2915cbb9da33Sdrh */ 2916cbb9da33Sdrh #define ENAME_NAME 0 /* The AS clause of a result set */ 2917cbb9da33Sdrh #define ENAME_SPAN 1 /* Complete text of the result set expression */ 2918cbb9da33Sdrh #define ENAME_TAB 2 /* "DB.TABLE.NAME" for the result set */ 2919cbb9da33Sdrh 2920cbb9da33Sdrh /* 2921ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 2922ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 2923ad3cab52Sdrh ** 2924ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 2925ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 2926ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 2927ad3cab52Sdrh ** 2928ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 2929ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 2930ad3cab52Sdrh ** 2931ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 2932ad3cab52Sdrh ** 2933ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 293475897234Sdrh */ 293575897234Sdrh struct IdList { 29366d4abfbeSdrh struct IdList_item { 2937ad3cab52Sdrh char *zName; /* Name of the identifier */ 2938967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 2939ad3cab52Sdrh } *a; 294013449892Sdrh int nId; /* Number of identifiers on the list */ 2941ad3cab52Sdrh }; 2942ad3cab52Sdrh 2943ad3cab52Sdrh /* 29447601294aSdrh ** The SrcItem object represents a single term in the FROM clause of a query. 29457601294aSdrh ** The SrcList object is mostly an array of SrcItems. 2946ad3cab52Sdrh */ 29477601294aSdrh struct SrcItem { 294841fb5cd1Sdan Schema *pSchema; /* Schema to which this item is fixed */ 2949113088ecSdrh char *zDatabase; /* Name of database holding this table */ 2950ad3cab52Sdrh char *zName; /* Name of the table */ 2951ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 2952daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 2953daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 29545b6a9ed4Sdrh int addrFillSub; /* Address of subroutine to manifest a subquery */ 29555b6a9ed4Sdrh int regReturn; /* Register holding return address of addrFillSub */ 29565f612295Sdrh int regResult; /* Registers holding results of a co-routine */ 29578a48b9c0Sdrh struct { 29586b922881Sdrh u8 jointype; /* Type of join between this table and the previous */ 295921172c4cSdrh unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */ 29608a48b9c0Sdrh unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */ 29618a48b9c0Sdrh unsigned isTabFunc :1; /* True if table-valued-function syntax */ 296221172c4cSdrh unsigned isCorrelated :1; /* True if sub-query is correlated */ 296321172c4cSdrh unsigned viaCoroutine :1; /* Implemented as a co-routine */ 2964f43fe6e9Sdan unsigned isRecursive :1; /* True for recursive reference in WITH */ 2965ccb2113aSdrh unsigned fromDDL :1; /* Comes from sqlite_schema */ 2966a79e2a2dSdrh unsigned isCte :1; /* This is a CTE */ 2967cd1499f4Sdrh unsigned notCte :1; /* This item may not match a CTE */ 29688a48b9c0Sdrh } fg; 2969e68fbe79Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 2970ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 2971ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 2972cd38d520Sdanielk1977 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 29738a48b9c0Sdrh union { 2974d62fbb50Sdrh char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */ 29758a48b9c0Sdrh ExprList *pFuncArg; /* Arguments to table-valued-function */ 29768a48b9c0Sdrh } u1; 2977a79e2a2dSdrh union { 29788a48b9c0Sdrh Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */ 2979a79e2a2dSdrh CteUse *pCteUse; /* CTE Usage info info fg.isCte is true */ 2980a79e2a2dSdrh } u2; 29817601294aSdrh }; 29827601294aSdrh 29837601294aSdrh /* 29847601294aSdrh ** The following structure describes the FROM clause of a SELECT statement. 29857601294aSdrh ** Each table or subquery in the FROM clause is a separate element of 29867601294aSdrh ** the SrcList.a[] array. 29877601294aSdrh ** 29887601294aSdrh ** With the addition of multiple database support, the following structure 29897601294aSdrh ** can also be used to describe a particular table such as the table that 29907601294aSdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 29917601294aSdrh ** such a table must be a simple name: ID. But in SQLite, the table can 29927601294aSdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 29937601294aSdrh ** 29947601294aSdrh ** The jointype starts out showing the join type between the current table 29957601294aSdrh ** and the next table on the list. The parser builds the list this way. 29967601294aSdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 29977601294aSdrh ** jointype expresses the join between the table and the previous table. 29987601294aSdrh ** 29997601294aSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table 30007601294aSdrh ** contains more than 63 columns and the 64-th or later column is used. 30017601294aSdrh */ 30027601294aSdrh struct SrcList { 30037601294aSdrh int nSrc; /* Number of tables or subqueries in the FROM clause */ 30047601294aSdrh u32 nAlloc; /* Number of entries allocated in a[] below */ 30057601294aSdrh SrcItem a[1]; /* One entry for each identifier on the list */ 300675897234Sdrh }; 300775897234Sdrh 300875897234Sdrh /* 300901f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 301001f3f253Sdrh */ 301101f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 30123dec223cSdrh #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 30133dec223cSdrh #define JT_NATURAL 0x0004 /* True for a "natural" join */ 30143dec223cSdrh #define JT_LEFT 0x0008 /* Left outer join */ 30153dec223cSdrh #define JT_RIGHT 0x0010 /* Right outer join */ 30163dec223cSdrh #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 30173dec223cSdrh #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 301801f3f253Sdrh 3019111a6a7dSdrh 3020111a6a7dSdrh /* 3021336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 3022336a5300Sdrh ** and the WhereInfo.wctrlFlags member. 302349711600Sdrh ** 302449711600Sdrh ** Value constraints (enforced via assert()): 302549711600Sdrh ** WHERE_USE_LIMIT == SF_FixedLimit 302608c88eb0Sdrh */ 30276df2acd2Sdrh #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 30286df2acd2Sdrh #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 30296df2acd2Sdrh #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 30306df2acd2Sdrh #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 3031ce943bc8Sdrh #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */ 3032ce943bc8Sdrh #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */ 3033bc5eac00Sdrh #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of 3034bc5eac00Sdrh ** the OR optimization */ 3035ce943bc8Sdrh #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */ 3036ce943bc8Sdrh #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */ 3037ce943bc8Sdrh #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */ 3038ce943bc8Sdrh #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */ 3039f330d53fSdan #define WHERE_AGG_DISTINCT 0x0400 /* Query is "SELECT agg(DISTINCT ...)" */ 3040d711e522Sdrh #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */ 304168c0c710Sdrh /* 0x1000 not currently used */ 3042ce943bc8Sdrh /* 0x2000 not currently used */ 3043bc5eac00Sdrh #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */ 3044ce943bc8Sdrh /* 0x8000 not currently used */ 3045a9d1ccb9Sdanielk1977 30464f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct() 30474f402f26Sdrh */ 3048e8e4af76Sdrh #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */ 3049ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */ 3050ae651d61Sdrh #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */ 3051e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */ 305238cc40c2Sdan 305375897234Sdrh /* 3054b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column 3055b3bce662Sdanielk1977 ** names. The context consists of a list of tables (the pSrcList) field and 3056b3bce662Sdanielk1977 ** a list of named expression (pEList). The named expression list may 3057b3bce662Sdanielk1977 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 3058b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 3059b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for 3060b3bce662Sdanielk1977 ** other statements. 3061b3bce662Sdanielk1977 ** 3062b3bce662Sdanielk1977 ** NameContexts can be nested. When resolving names, the inner-most 3063b3bce662Sdanielk1977 ** context is searched first. If no match is found, the next outer 3064b3bce662Sdanielk1977 ** context is checked. If there is still no match, the next context 3065b3bce662Sdanielk1977 ** is checked. This process continues until either a match is found 3066b3bce662Sdanielk1977 ** or all contexts are check. When a match is found, the nRef member of 3067b3bce662Sdanielk1977 ** the context containing the match is incremented. 3068b3bce662Sdanielk1977 ** 3069b3bce662Sdanielk1977 ** Each subquery gets a new NameContext. The pNext field points to the 3070b3bce662Sdanielk1977 ** NameContext in the parent query. Thus the process of scanning the 3071b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer 3072b3bce662Sdanielk1977 ** subqueries looking for a match. 3073b3bce662Sdanielk1977 */ 3074b3bce662Sdanielk1977 struct NameContext { 3075b3bce662Sdanielk1977 Parse *pParse; /* The parser */ 3076b3bce662Sdanielk1977 SrcList *pSrcList; /* One or more tables used to resolve names */ 307725c3b8caSdrh union { 307826080d92Sdrh ExprList *pEList; /* Optional list of result-set columns */ 307913449892Sdrh AggInfo *pAggInfo; /* Information about aggregates at this level */ 3080eac9fabbSdrh Upsert *pUpsert; /* ON CONFLICT clause information from an upsert */ 3081552562c4Sdrh int iBaseReg; /* For TK_REGISTER when parsing RETURNING */ 308225c3b8caSdrh } uNC; 3083b3bce662Sdanielk1977 NameContext *pNext; /* Next outer name context. NULL for outermost */ 3084a51009b2Sdrh int nRef; /* Number of names resolved by this context */ 3085050611a7Sdrh int nNcErr; /* Number of errors encountered while resolving names */ 30860d92571dSdan int ncFlags; /* Zero or more NC_* flags defined below */ 3087e3bf632cSdan Select *pWinSelect; /* SELECT statement for any window functions */ 3088b3bce662Sdanielk1977 }; 3089b3bce662Sdanielk1977 3090b3bce662Sdanielk1977 /* 3091a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field. 30929588ad95Sdrh ** 309349711600Sdrh ** Value constraints (all checked via assert()): 3094d137f4e6Sdrh ** NC_HasAgg == SF_HasAgg == EP_Agg 309549711600Sdrh ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX 3096*bb301231Sdrh ** NC_OrderAgg == SF_OrderByReqd == SQLITE_FUNC_ANYORDER 3097d137f4e6Sdrh ** NC_HasWin == EP_Win 30989588ad95Sdrh ** 3099a51009b2Sdrh */ 3100*bb301231Sdrh #define NC_AllowAgg 0x000001 /* Aggregate functions are allowed here */ 3101*bb301231Sdrh #define NC_PartIdx 0x000002 /* True if resolving a partial index WHERE */ 3102*bb301231Sdrh #define NC_IsCheck 0x000004 /* True if resolving a CHECK constraint */ 3103*bb301231Sdrh #define NC_GenCol 0x000008 /* True for a GENERATED ALWAYS AS clause */ 3104*bb301231Sdrh #define NC_HasAgg 0x000010 /* One or more aggregate functions seen */ 3105*bb301231Sdrh #define NC_IdxExpr 0x000020 /* True if resolving columns of CREATE INDEX */ 3106*bb301231Sdrh #define NC_SelfRef 0x00002e /* Combo: PartIdx, isCheck, GenCol, and IdxExpr */ 3107*bb301231Sdrh #define NC_VarSelect 0x000040 /* A correlated subquery has been seen */ 3108*bb301231Sdrh #define NC_UEList 0x000080 /* True if uNC.pEList is used */ 3109*bb301231Sdrh #define NC_UAggInfo 0x000100 /* True if uNC.pAggInfo is used */ 3110*bb301231Sdrh #define NC_UUpsert 0x000200 /* True if uNC.pUpsert is used */ 3111*bb301231Sdrh #define NC_UBaseReg 0x000400 /* True if uNC.iBaseReg is used */ 3112*bb301231Sdrh #define NC_MinMaxAgg 0x001000 /* min/max aggregates seen. See note above */ 3113*bb301231Sdrh #define NC_Complex 0x002000 /* True if a function or subquery seen */ 3114*bb301231Sdrh #define NC_AllowWin 0x004000 /* Window functions are allowed here */ 3115*bb301231Sdrh #define NC_HasWin 0x008000 /* One or more window functions seen */ 3116*bb301231Sdrh #define NC_IsDDL 0x010000 /* Resolving names in a CREATE statement */ 3117*bb301231Sdrh #define NC_InAggFunc 0x020000 /* True if analyzing arguments to an agg func */ 3118*bb301231Sdrh #define NC_FromDDL 0x040000 /* SQL text comes from sqlite_schema */ 3119*bb301231Sdrh #define NC_NoSelect 0x080000 /* Do not descend into sub-selects */ 3120*bb301231Sdrh #define NC_OrderAgg 0x8000000 /* Has an aggregate other than count/min/max */ 3121a51009b2Sdrh 3122a51009b2Sdrh /* 312346d2e5c3Sdrh ** An instance of the following object describes a single ON CONFLICT 3124e9c2e772Sdrh ** clause in an upsert. 3125788d55aaSdrh ** 3126788d55aaSdrh ** The pUpsertTarget field is only set if the ON CONFLICT clause includes 3127788d55aaSdrh ** conflict-target clause. (In "ON CONFLICT(a,b)" the "(a,b)" is the 3128e9c2e772Sdrh ** conflict-target clause.) The pUpsertTargetWhere is the optional 3129e9c2e772Sdrh ** WHERE clause used to identify partial unique indexes. 3130788d55aaSdrh ** 3131788d55aaSdrh ** pUpsertSet is the list of column=expr terms of the UPDATE statement. 3132788d55aaSdrh ** The pUpsertSet field is NULL for a ON CONFLICT DO NOTHING. The 3133788d55aaSdrh ** pUpsertWhere is the WHERE clause for the UPDATE and is NULL if the 3134788d55aaSdrh ** WHERE clause is omitted. 313546d2e5c3Sdrh */ 313646d2e5c3Sdrh struct Upsert { 31375602777eSdrh ExprList *pUpsertTarget; /* Optional description of conflict target */ 3138e9c2e772Sdrh Expr *pUpsertTargetWhere; /* WHERE clause for partial index targets */ 313946d2e5c3Sdrh ExprList *pUpsertSet; /* The SET clause from an ON CONFLICT UPDATE */ 3140dab0eb58Sdrh Expr *pUpsertWhere; /* WHERE clause for the ON CONFLICT UPDATE */ 31412549e4ccSdrh Upsert *pNextUpsert; /* Next ON CONFLICT clause in the list */ 3142255c1c15Sdrh u8 isDoUpdate; /* True for DO UPDATE. False for DO NOTHING */ 3143e84ad92fSdrh /* Above this point is the parse tree for the ON CONFLICT clauses. 3144e84ad92fSdrh ** The next group of fields stores intermediate data. */ 3145daf2761cSdrh void *pToFree; /* Free memory when deleting the Upsert object */ 3146e84ad92fSdrh /* All fields above are owned by the Upsert object and must be freed 3147e84ad92fSdrh ** when the Upsert is destroyed. The fields below are used to transfer 3148e84ad92fSdrh ** information from the INSERT processing down into the UPDATE processing 3149e84ad92fSdrh ** while generating code. The fields below are owned by the INSERT 3150e84ad92fSdrh ** statement and will be freed by INSERT processing. */ 315191f2717fSdrh Index *pUpsertIdx; /* UNIQUE constraint specified by pUpsertTarget */ 31520b30a116Sdrh SrcList *pUpsertSrc; /* Table to be updated */ 3153eac9fabbSdrh int regData; /* First register holding array of VALUES */ 31547fc3aba8Sdrh int iDataCur; /* Index of the data cursor */ 31557fc3aba8Sdrh int iIdxCur; /* Index of the first index cursor */ 315646d2e5c3Sdrh }; 315746d2e5c3Sdrh 315846d2e5c3Sdrh /* 31599bb61fe7Sdrh ** An instance of the following structure contains all information 31609bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 3161a76b5dfcSdrh ** 3162bbd4ae5aSdrh ** See the header comment on the computeLimitRegisters() routine for a 3163bbd4ae5aSdrh ** detailed description of the meaning of the iLimit and iOffset fields. 31640342b1f5Sdrh ** 3165b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 31660342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in 316766a5167bSdrh ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 31680342b1f5Sdrh ** the number of columns in P2 can be computed at the same time 3169b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not 31700342b1f5Sdrh ** enough information about the compound query is known at that point. 3171b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 31722c79733fSdrh ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating 31730342b1f5Sdrh ** sequences for the ORDER BY clause. 31749bb61fe7Sdrh */ 31759bb61fe7Sdrh struct Select { 31767b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 3177c3489bbfSdrh LogEst nSelectRow; /* Estimated number of result rows */ 3178c3489bbfSdrh u32 selFlags; /* Various SF_* values */ 3179a451017dSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 3180fef37760Sdrh u32 selId; /* Unique identifier number for this SELECT */ 3181079a3072Sdrh int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */ 3182a9ebfe20Sdrh ExprList *pEList; /* The fields of the result */ 3183ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 31849bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 31859bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 31869bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 31879bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 3188967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 31891e281291Sdrh Select *pNext; /* Next select to the left in a compound */ 3190a2dc3b1aSdanielk1977 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 31914e9119d9Sdan With *pWith; /* WITH clause attached to this select. Or NULL. */ 319267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 319386fb6e17Sdan Window *pWin; /* List of window functions */ 3194e3bf632cSdan Window *pWinDefn; /* List of named window definitions */ 319567a9b8edSdan #endif 31969bb61fe7Sdrh }; 31979bb61fe7Sdrh 31989bb61fe7Sdrh /* 31997d10d5a6Sdrh ** Allowed values for Select.selFlags. The "SF" prefix stands for 32007d10d5a6Sdrh ** "Select Flag". 320149711600Sdrh ** 320249711600Sdrh ** Value constraints (all checked via assert()) 320349711600Sdrh ** SF_HasAgg == NC_HasAgg 320449711600Sdrh ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX 3205*bb301231Sdrh ** SF_OrderByReqd == NC_OrderAgg == SQLITE_FUNC_ANYORDER 320649711600Sdrh ** SF_FixedLimit == WHERE_USE_LIMIT 32077d10d5a6Sdrh */ 3208ba01634cSdrh #define SF_Distinct 0x0000001 /* Output should be DISTINCT */ 3209ba01634cSdrh #define SF_All 0x0000002 /* Includes the ALL keyword */ 3210ba01634cSdrh #define SF_Resolved 0x0000004 /* Identifiers have been resolved */ 3211ba01634cSdrh #define SF_Aggregate 0x0000008 /* Contains agg functions or a GROUP BY */ 3212ba01634cSdrh #define SF_HasAgg 0x0000010 /* Contains aggregate functions */ 3213ba01634cSdrh #define SF_UsesEphemeral 0x0000020 /* Uses the OpenEphemeral opcode */ 3214ba01634cSdrh #define SF_Expanded 0x0000040 /* sqlite3SelectExpand() called on this */ 3215ba01634cSdrh #define SF_HasTypeInfo 0x0000080 /* FROM subqueries have Table metadata */ 3216ba01634cSdrh #define SF_Compound 0x0000100 /* Part of a compound query */ 3217ba01634cSdrh #define SF_Values 0x0000200 /* Synthesized from VALUES clause */ 3218ba01634cSdrh #define SF_MultiValue 0x0000400 /* Single VALUES term with multiple rows */ 3219ba01634cSdrh #define SF_NestedFrom 0x0000800 /* Part of a parenthesized FROM clause */ 3220ba01634cSdrh #define SF_MinMaxAgg 0x0001000 /* Aggregate containing min() or max() */ 3221ba01634cSdrh #define SF_Recursive 0x0002000 /* The recursive part of a recursive CTE */ 3222ba01634cSdrh #define SF_FixedLimit 0x0004000 /* nSelectRow set by a constant LIMIT */ 3223ba01634cSdrh #define SF_MaybeConvert 0x0008000 /* Need convertCompoundSelectToSubquery() */ 3224ba01634cSdrh #define SF_Converted 0x0010000 /* By convertCompoundSelectToSubquery() */ 3225ba01634cSdrh #define SF_IncludeHidden 0x0020000 /* Include hidden columns in output */ 3226ba01634cSdrh #define SF_ComplexResult 0x0040000 /* Result contains subquery or function */ 3227ba01634cSdrh #define SF_WhereBegin 0x0080000 /* Really a WhereBegin() call. Debug Only */ 3228ba01634cSdrh #define SF_WinRewrite 0x0100000 /* Window function rewrite accomplished */ 322938096961Sdan #define SF_View 0x0200000 /* SELECT statement is a view */ 3230b7cbf5c1Sdrh #define SF_NoopOrderBy 0x0400000 /* ORDER BY is ignored for this query */ 32315daf69e5Sdan #define SF_UFSrcCheck 0x0800000 /* Check pSrc as required by UPDATE...FROM */ 32328794c68aSdrh #define SF_PushDown 0x1000000 /* SELECT has be modified by push-down opt */ 3233903fdd48Sdan #define SF_MultiPart 0x2000000 /* Has multiple incompatible PARTITIONs */ 3234ac67f567Sdan #define SF_CopyCte 0x4000000 /* SELECT statement is a copy of a CTE */ 3235*bb301231Sdrh #define SF_OrderByReqd 0x8000000 /* The ORDER BY clause may not be purged */ 32367d10d5a6Sdrh 32377d10d5a6Sdrh /* 3238340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined 3239340309fdSdrh ** by one of the following macros. The "SRT" prefix means "SELECT Result 3240340309fdSdrh ** Type". 3241340309fdSdrh ** 3242340309fdSdrh ** SRT_Union Store results as a key in a temporary index 3243340309fdSdrh ** identified by pDest->iSDParm. 3244340309fdSdrh ** 3245340309fdSdrh ** SRT_Except Remove results from the temporary index pDest->iSDParm. 3246340309fdSdrh ** 3247340309fdSdrh ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result 3248340309fdSdrh ** set is not empty. 3249340309fdSdrh ** 3250340309fdSdrh ** SRT_Discard Throw the results away. This is used by SELECT 3251340309fdSdrh ** statements within triggers whose only purpose is 3252340309fdSdrh ** the side-effects of functions. 3253340309fdSdrh ** 3254340309fdSdrh ** SRT_Output Generate a row of output (using the OP_ResultRow 3255340309fdSdrh ** opcode) for each row in the result set. 3256340309fdSdrh ** 3257340309fdSdrh ** SRT_Mem Only valid if the result is a single column. 3258340309fdSdrh ** Store the first column of the first result row 3259340309fdSdrh ** in register pDest->iSDParm then abandon the rest 3260340309fdSdrh ** of the query. This destination implies "LIMIT 1". 3261340309fdSdrh ** 3262340309fdSdrh ** SRT_Set The result must be a single column. Store each 3263340309fdSdrh ** row of result as the key in table pDest->iSDParm. 3264340309fdSdrh ** Apply the affinity pDest->affSdst before storing 3265340309fdSdrh ** results. Used to implement "IN (SELECT ...)". 3266340309fdSdrh ** 3267340309fdSdrh ** SRT_EphemTab Create an temporary table pDest->iSDParm and store 3268340309fdSdrh ** the result there. The cursor is left open after 3269340309fdSdrh ** returning. This is like SRT_Table except that 3270340309fdSdrh ** this destination uses OP_OpenEphemeral to create 3271340309fdSdrh ** the table first. 3272340309fdSdrh ** 3273340309fdSdrh ** SRT_Coroutine Generate a co-routine that returns a new row of 3274340309fdSdrh ** results each time it is invoked. The entry point 3275340309fdSdrh ** of the co-routine is stored in register pDest->iSDParm 3276340309fdSdrh ** and the result row is stored in pDest->nDest registers 3277340309fdSdrh ** starting with pDest->iSdst. 3278340309fdSdrh ** 3279781def29Sdrh ** SRT_Table Store results in temporary table pDest->iSDParm. 32808e1ee88cSdrh ** SRT_Fifo This is like SRT_EphemTab except that the table 32818e1ee88cSdrh ** is assumed to already be open. SRT_Fifo has 32828e1ee88cSdrh ** the additional property of being able to ignore 32838e1ee88cSdrh ** the ORDER BY clause. 3284781def29Sdrh ** 32858e1ee88cSdrh ** SRT_DistFifo Store results in a temporary table pDest->iSDParm. 3286340309fdSdrh ** But also use temporary table pDest->iSDParm+1 as 3287340309fdSdrh ** a record of all prior results and ignore any duplicate 32888e1ee88cSdrh ** rows. Name means: "Distinct Fifo". 3289781def29Sdrh ** 3290781def29Sdrh ** SRT_Queue Store results in priority queue pDest->iSDParm (really 3291781def29Sdrh ** an index). Append a sequence number so that all entries 3292781def29Sdrh ** are distinct. 3293781def29Sdrh ** 3294781def29Sdrh ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if 3295781def29Sdrh ** the same record has never been stored before. The 3296781def29Sdrh ** index at pDest->iSDParm+1 hold all prior stores. 3297243210b7Sdan ** 3298243210b7Sdan ** SRT_Upfrom Store results in the temporary table already opened by 3299243210b7Sdan ** pDest->iSDParm. If (pDest->iSDParm<0), then the temp 3300243210b7Sdan ** table is an intkey table - in this case the first 3301243210b7Sdan ** column returned by the SELECT is used as the integer 3302243210b7Sdan ** key. If (pDest->iSDParm>0), then the table is an index 3303243210b7Sdan ** table. (pDest->iSDParm) is the number of key columns in 3304243210b7Sdan ** each index record in this case. 3305fef5208cSdrh */ 330613449892Sdrh #define SRT_Union 1 /* Store result as keys in an index */ 330713449892Sdrh #define SRT_Except 2 /* Remove result from a UNION index */ 33089ed1dfa8Sdanielk1977 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 33099ed1dfa8Sdanielk1977 #define SRT_Discard 4 /* Do not save the results anywhere */ 3310f1ea4255Sdrh #define SRT_DistFifo 5 /* Like SRT_Fifo, but unique results only */ 3311f1ea4255Sdrh #define SRT_DistQueue 6 /* Like SRT_Queue, but unique results only */ 3312f1ea4255Sdrh 3313f1ea4255Sdrh /* The DISTINCT clause is ignored for all of the above. Not that 3314f1ea4255Sdrh ** IgnorableDistinct() implies IgnorableOrderby() */ 3315f1ea4255Sdrh #define IgnorableDistinct(X) ((X->eDest)<=SRT_DistQueue) 3316f1ea4255Sdrh 33178e1ee88cSdrh #define SRT_Queue 7 /* Store result in an queue */ 3318f1ea4255Sdrh #define SRT_Fifo 8 /* Store result as data with an automatic rowid */ 3319fef5208cSdrh 332013449892Sdrh /* The ORDER BY clause is ignored for all of the above */ 3321f1ea4255Sdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_Fifo) 332213449892Sdrh 33238e1ee88cSdrh #define SRT_Output 9 /* Output each row of result */ 33248e1ee88cSdrh #define SRT_Mem 10 /* Store result in a memory cell */ 33258e1ee88cSdrh #define SRT_Set 11 /* Store results as keys in an index */ 33268e1ee88cSdrh #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */ 33278e1ee88cSdrh #define SRT_Coroutine 13 /* Generate a single row of result */ 33288e1ee88cSdrh #define SRT_Table 14 /* Store result as data with an automatic rowid */ 3329f2972b60Sdan #define SRT_Upfrom 15 /* Store result as data with rowid */ 33302282792aSdrh 33312282792aSdrh /* 3332634d81deSdrh ** An instance of this object describes where to put of the results of 3333634d81deSdrh ** a SELECT statement. 33346c8c8ce0Sdanielk1977 */ 33356c8c8ce0Sdanielk1977 struct SelectDest { 33369ed322d6Sdan u8 eDest; /* How to dispose of the results. One of SRT_* above. */ 33372b596da8Sdrh int iSDParm; /* A parameter used by the eDest disposal method */ 33389ed322d6Sdan int iSDParm2; /* A second parameter for the eDest disposal method */ 33392b596da8Sdrh int iSdst; /* Base register where results are written */ 33402b596da8Sdrh int nSdst; /* Number of registers allocated */ 3341a8b9793cSdrh char *zAffSdst; /* Affinity used when eDest==SRT_Set */ 3342fe1c6bb9Sdrh ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */ 33436c8c8ce0Sdanielk1977 }; 33446c8c8ce0Sdanielk1977 33456c8c8ce0Sdanielk1977 /* 33460b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT 33470b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p 33480b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that 33490b9f50d8Sdrh ** the code generator needs. We have to keep per-table autoincrement 33501b32554bSdrh ** information in case inserts are done within triggers. Triggers do not 33510b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the 33520b9f50d8Sdrh ** loading and saving of autoincrement information. 33530b9f50d8Sdrh */ 33540b9f50d8Sdrh struct AutoincInfo { 33550b9f50d8Sdrh AutoincInfo *pNext; /* Next info block in a list of them all */ 33560b9f50d8Sdrh Table *pTab; /* Table this info block refers to */ 33570b9f50d8Sdrh int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 33580b9f50d8Sdrh int regCtr; /* Memory register holding the rowid counter */ 33590b9f50d8Sdrh }; 33600b9f50d8Sdrh 33610b9f50d8Sdrh /* 33622832ad42Sdan ** At least one instance of the following structure is created for each 33632832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 33642832ad42Sdan ** statement. All such objects are stored in the linked list headed at 33652832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been 33662832ad42Sdan ** completed. 33672832ad42Sdan ** 33682832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger 33692832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 33702832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 33712832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same 33722832ad42Sdan ** values for both pTrigger and orconf. 337365a7cd16Sdan ** 3374bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 337565a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT 3376bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 3377bb5f168fSdan ** a mask of new.* columns used by the program. 33782832ad42Sdan */ 33792832ad42Sdan struct TriggerPrg { 33802832ad42Sdan Trigger *pTrigger; /* Trigger this program was coded from */ 33812832ad42Sdan TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 3382a451017dSdrh SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 3383a451017dSdrh int orconf; /* Default ON CONFLICT policy */ 3384a451017dSdrh u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 3385165921a7Sdan }; 3386165921a7Sdan 338764123585Sdrh /* 338864123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases. 338964123585Sdrh */ 339001c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30 3391a7ab6d81Sdrh typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8]; 3392a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0) 3393a7ab6d81Sdrh # define DbMaskZero(M) memset((M),0,sizeof(M)) 3394a7ab6d81Sdrh # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7)) 3395a7ab6d81Sdrh # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M) 3396a7ab6d81Sdrh # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0) 339701c7dc88Sdrh #else 339864123585Sdrh typedef unsigned int yDbMask; 3399a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0) 3400a7ab6d81Sdrh # define DbMaskZero(M) (M)=0 3401a7ab6d81Sdrh # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I)) 3402a7ab6d81Sdrh # define DbMaskAllZero(M) (M)==0 3403a7ab6d81Sdrh # define DbMaskNonZero(M) (M)!=0 340401c7dc88Sdrh #endif 340501c7dc88Sdrh 3406ceea3321Sdrh /* 3407cf3c078fSdrh ** An instance of the ParseCleanup object specifies an operation that 3408cf3c078fSdrh ** should be performed after parsing to deallocation resources obtained 3409cf3c078fSdrh ** during the parse and which are no longer needed. 3410cf3c078fSdrh */ 3411cf3c078fSdrh struct ParseCleanup { 3412cf3c078fSdrh ParseCleanup *pNext; /* Next cleanup task */ 3413cf3c078fSdrh void *pPtr; /* Pointer to object to deallocate */ 3414cf3c078fSdrh void (*xCleanup)(sqlite3*,void*); /* Deallocation routine */ 3415cf3c078fSdrh }; 3416cf3c078fSdrh 3417cf3c078fSdrh /* 3418f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 3419f57b3399Sdrh ** the parser and down into all the parser action routine in order to 3420f57b3399Sdrh ** carry around information that is global to the entire parse. 3421f1974846Sdrh ** 3422f1974846Sdrh ** The structure is divided into two parts. When the parser and code 3423f1974846Sdrh ** generate call themselves recursively, the first part of the structure 3424f1974846Sdrh ** is constant but the second part is reset at the beginning and end of 3425f1974846Sdrh ** each recursion. 3426c00da105Sdanielk1977 ** 3427c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache 3428c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 3429c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being 3430c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the 3431c00da105Sdanielk1977 ** list. 343275897234Sdrh */ 343375897234Sdrh struct Parse { 34349bb575fdSdrh sqlite3 *db; /* The main database structure */ 343575897234Sdrh char *zErrMsg; /* An error message */ 343675897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 3437a451017dSdrh int rc; /* Return code from execution */ 3438836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 3439a6ecd338Sdrh u8 checkSchema; /* Causes schema cookie check after an error */ 3440205f48e6Sdrh u8 nested; /* Number of nested calls to the parser/code generator */ 3441892d3179Sdrh u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 3442a451017dSdrh u8 isMultiWrite; /* True if statement may modify/insert multiple rows */ 3443a451017dSdrh u8 mayAbort; /* True if statement may throw an ABORT exception */ 3444d58d3278Sdrh u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */ 3445aceb31b1Sdrh u8 okConstFactor; /* OK to factor out constants */ 34464a642b60Sdrh u8 disableLookaside; /* Number of times lookaside has been disabled */ 34471ea0443cSdan u8 disableVtab; /* Disable all virtual tables for this parse */ 344821d4f5b5Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST) 344921d4f5b5Sdrh u8 earlyCleanup; /* OOM inside sqlite3ParserAddCleanup() */ 345021d4f5b5Sdrh #endif 3451892d3179Sdrh int nRangeReg; /* Size of the temporary register block */ 3452892d3179Sdrh int iRangeReg; /* First register in temporary register block */ 345375897234Sdrh int nErr; /* Number of errors seen */ 3454832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 345519a775c2Sdrh int nMem; /* Number of memory cells used so far */ 3456bd57308eSdrh int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */ 34577e8515d8Sdrh int iSelfTab; /* Table associated with an index on expr, or negative 34586e97f8ecSdrh ** of the base register during check-constraint eval */ 3459d1d158bfSdrh int nLabel; /* The *negative* of the number of labels used */ 3460ec4ccdbcSdrh int nLabelAlloc; /* Number of slots in aLabel */ 34617df89c8cSdrh int *aLabel; /* Space to hold the labels */ 3462f30a969bSdrh ExprList *pConstExpr;/* Constant expressions */ 34637df89c8cSdrh Token constraintName;/* Name of the constraint currently being parsed */ 346464123585Sdrh yDbMask writeMask; /* Start a write transaction on these databases */ 346564123585Sdrh yDbMask cookieMask; /* Bitmask of schema verified databases */ 3466a451017dSdrh int regRowid; /* Register holding rowid of CREATE TABLE entry */ 3467a451017dSdrh int regRoot; /* Register holding root page number for new objects */ 3468a451017dSdrh int nMaxArg; /* Max args passed to user function by sub-program */ 3469fef37760Sdrh int nSelect; /* Number of SELECT stmts. Counter for Select.selId */ 3470c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 3471c00da105Sdanielk1977 int nTableLock; /* Number of locks in aTableLock */ 3472c00da105Sdanielk1977 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 3473c00da105Sdanielk1977 #endif 34740b9f50d8Sdrh AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 347565a7cd16Sdan Parse *pToplevel; /* Parse structure for main program (or NULL) */ 3476165921a7Sdan Table *pTriggerTab; /* Table triggers are being coded for */ 34771cf19758Sdrh Parse *pParentParse; /* Parent parser if this parser is nested */ 3478381bdaccSdrh union { 3479381bdaccSdrh int addrCrTab; /* Address of OP_CreateBtree on CREATE TABLE */ 3480381bdaccSdrh Returning *pReturning; /* The RETURNING clause */ 3481381bdaccSdrh } u1; 34824f402f26Sdrh u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */ 348365a7cd16Sdan u32 oldmask; /* Mask of old.* columns referenced */ 3484bb5f168fSdan u32 newmask; /* Mask of new.* columns referenced */ 348565a7cd16Sdan u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 3486b8352479Sdrh u8 bReturning; /* Coding a RETURNING trigger */ 348765a7cd16Sdan u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 3488d66c8309Sdan u8 disableTriggers; /* True to disable triggers */ 3489165921a7Sdan 3490445f3d56Sdrh /************************************************************************** 3491445f3d56Sdrh ** Fields above must be initialized to zero. The fields that follow, 3492445f3d56Sdrh ** down to the beginning of the recursive section, do not need to be 3493445f3d56Sdrh ** initialized as they will be set before being used. The boundary is 349402ceed05Sdrh ** determined by offsetof(Parse,aTempReg). 3495445f3d56Sdrh **************************************************************************/ 3496445f3d56Sdrh 3497445f3d56Sdrh int aTempReg[8]; /* Holding area for temporary registers */ 3498445f3d56Sdrh Token sNameToken; /* Token with unqualified schema object name */ 3499cd9af608Sdrh 35007df89c8cSdrh /************************************************************************ 35017df89c8cSdrh ** Above is constant between recursions. Below is reset before and after 35027df89c8cSdrh ** each recursion. The boundary between these two regions is determined 3503588429a8Sdrh ** using offsetof(Parse,sLastToken) so the sLastToken field must be the 3504588429a8Sdrh ** first field in the recursive region. 35057df89c8cSdrh ************************************************************************/ 3506f1974846Sdrh 3507588429a8Sdrh Token sLastToken; /* The last token parsed */ 35086d664b4bSdrh ynVar nVar; /* Number of '?' variables seen in the SQL so far */ 35097f9c5dbfSdrh u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */ 3510a451017dSdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 3511cf8f2895Sdan u8 eParseMode; /* PARSE_MODE_XXX constant */ 3512a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 3513a451017dSdrh int nVtabLock; /* Number of virtual tables to lock */ 3514a451017dSdrh #endif 3515a451017dSdrh int nHeight; /* Expression tree height of current sub-select */ 3516a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN 3517e2ca99c9Sdrh int addrExplain; /* Address of current OP_Explain opcode */ 3518a451017dSdrh #endif 35199bf755ccSdrh VList *pVList; /* Mapping between variable names and numbers */ 3520937d0deaSdan Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 3521f1974846Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 3522f1974846Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 3523885eeb67Sdrh Index *pNewIndex; /* An index being constructed by CREATE INDEX. 3524885eeb67Sdrh ** Also used to hold redundant UNIQUE constraints 3525885eeb67Sdrh ** during a RENAME COLUMN */ 3526f1974846Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 3527f1974846Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 3528b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 352933b3933cSdanielk1977 Token sArg; /* Complete text of a module argument */ 35304f3dd150Sdrh Table **apVtabLock; /* Pointer to virtual tables needing locking */ 3531b9bb7c18Sdrh #endif 35322832ad42Sdan TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 35334e9119d9Sdan With *pWith; /* Current WITH clause, or NULL */ 3534cf3c078fSdrh ParseCleanup *pCleanup; /* List of cleanup operations to run after parse */ 3535cf8f2895Sdan #ifndef SQLITE_OMIT_ALTERTABLE 35364a2c747cSdrh RenameToken *pRename; /* Tokens subject to renaming by ALTER TABLE */ 3537cf8f2895Sdan #endif 353875897234Sdrh }; 353975897234Sdrh 3540cf8f2895Sdan #define PARSE_MODE_NORMAL 0 3541cf8f2895Sdan #define PARSE_MODE_DECLARE_VTAB 1 3542e6dc1e5bSdan #define PARSE_MODE_RENAME 2 3543e6dc1e5bSdan #define PARSE_MODE_UNMAP 3 3544cf8f2895Sdan 3545a451017dSdrh /* 3546cd9af608Sdrh ** Sizes and pointers of various parts of the Parse object. 3547cd9af608Sdrh */ 354802ceed05Sdrh #define PARSE_HDR_SZ offsetof(Parse,aTempReg) /* Recursive part w/o aColCache*/ 3549588429a8Sdrh #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */ 3550cd9af608Sdrh #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */ 3551cd9af608Sdrh #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */ 3552cd9af608Sdrh 3553cd9af608Sdrh /* 3554a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call. 3555a451017dSdrh */ 35567e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE 35577e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB 0 35587e6ebfb2Sdanielk1977 #else 3559cf8f2895Sdan #define IN_DECLARE_VTAB (pParse->eParseMode==PARSE_MODE_DECLARE_VTAB) 3560cf8f2895Sdan #endif 3561cf8f2895Sdan 3562cf8f2895Sdan #if defined(SQLITE_OMIT_ALTERTABLE) 3563c9461eccSdan #define IN_RENAME_OBJECT 0 3564cf8f2895Sdan #else 3565e6dc1e5bSdan #define IN_RENAME_OBJECT (pParse->eParseMode>=PARSE_MODE_RENAME) 3566cf8f2895Sdan #endif 3567cf8f2895Sdan 3568cf8f2895Sdan #if defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE) 3569cf8f2895Sdan #define IN_SPECIAL_PARSE 0 3570cf8f2895Sdan #else 3571cf8f2895Sdan #define IN_SPECIAL_PARSE (pParse->eParseMode!=PARSE_MODE_NORMAL) 35727e6ebfb2Sdanielk1977 #endif 35737e6ebfb2Sdanielk1977 3574d99bc930Sdanielk1977 /* 357585e2096fSdrh ** An instance of the following structure can be declared on a stack and used 357685e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 357785e2096fSdrh */ 357885e2096fSdrh struct AuthContext { 357985e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 358085e2096fSdrh Parse *pParse; /* The Parse structure */ 358185e2096fSdrh }; 358285e2096fSdrh 358385e2096fSdrh /* 3584a748fdccSdrh ** Bitfield flags for P5 value in various opcodes. 358549711600Sdrh ** 358649711600Sdrh ** Value constraints (enforced via assert()): 358749711600Sdrh ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH 358849711600Sdrh ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF 358949711600Sdrh ** OPFLAG_BULKCSR == BTREE_BULKLOAD 359049711600Sdrh ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ 359149711600Sdrh ** OPFLAG_FORDELETE == BTREE_FORDELETE 359249711600Sdrh ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION 359349711600Sdrh ** OPFLAG_AUXDELETE == BTREE_AUXDELETE 3594b0c374ffSrdc */ 3595e807bdbaSdrh #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */ 3596e807bdbaSdrh /* Also used in P2 (not P5) of OP_Delete */ 359709d00b2fSdrh #define OPFLAG_NOCHNG 0x01 /* OP_VColumn nochange for UPDATE */ 359897348b37Sdrh #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */ 3599f91c1318Sdan #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */ 36003e9ca094Sdrh #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 36013e9ca094Sdrh #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 36023e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 360346c47d46Sdan #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */ 3604a748fdccSdrh #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */ 3605a748fdccSdrh #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */ 3606428c218cSdan #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */ 3607e0997b34Sdrh #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */ 36089c0c57a4Sdrh #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */ 3609fd261ec6Sdan #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */ 3610953f7611Sdrh #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */ 3611f91c1318Sdan #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */ 3612def19e3bSdrh #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */ 361341fb367aSdrh #define OPFLAG_NOCHNG_MAGIC 0x6d /* OP_MakeRecord: serialtype 10 is ok */ 36147aae7358Sdan #define OPFLAG_PREFORMAT 0x80 /* OP_Insert uses preformatted cell */ 3615b0c374ffSrdc 3616b0c374ffSrdc /* 3617d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 3618d99bc930Sdanielk1977 * struct Trigger. 3619d99bc930Sdanielk1977 * 3620d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 36219bb575fdSdrh * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 3622d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 3623d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 3624ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 3625ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 3626ad3cab52Sdrh * struct Table. 3627d99bc930Sdanielk1977 * 3628ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 3629ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 3630d99bc930Sdanielk1977 */ 3631d99bc930Sdanielk1977 struct Trigger { 3632165921a7Sdan char *zName; /* The name of the trigger */ 3633d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 3634f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 3635dca76841Sdrh u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 3636b8352479Sdrh u8 bReturning; /* This trigger implements a RETURNING clause */ 3637467bcf36Sshane Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 3638d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 3639d99bc930Sdanielk1977 the <column-list> is stored here */ 3640e501b89aSdanielk1977 Schema *pSchema; /* Schema containing the trigger */ 3641e501b89aSdanielk1977 Schema *pTabSchema; /* Schema containing the table */ 3642d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 3643d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 3644c3f9bad2Sdanielk1977 }; 3645d99bc930Sdanielk1977 3646d99bc930Sdanielk1977 /* 3647dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger. The following constants 3648dca76841Sdrh ** determine which. 3649dca76841Sdrh ** 3650dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER. 3651dca76841Sdrh ** In that cases, the constants below can be ORed together. 3652dca76841Sdrh */ 3653dca76841Sdrh #define TRIGGER_BEFORE 1 3654dca76841Sdrh #define TRIGGER_AFTER 2 3655dca76841Sdrh 3656dca76841Sdrh /* 3657d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 3658d99bc930Sdanielk1977 * that is a part of a trigger-program. 3659d99bc930Sdanielk1977 * 3660d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 3661d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 3662d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 3663d99bc930Sdanielk1977 * the first step of the trigger-program. 3664d99bc930Sdanielk1977 * 3665d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 3666d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 3667d99bc930Sdanielk1977 * value of "op" as follows: 3668d99bc930Sdanielk1977 * 3669d99bc930Sdanielk1977 * (op == TK_INSERT) 3670d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 3671d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 3672d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 367346408354Sdan * zTarget -> Dequoted name of the table to insert into. 3674d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 3675d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 3676d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 3677ad3cab52Sdrh * statement, then this stores the column-names to be 3678ad3cab52Sdrh * inserted into. 3679d99bc930Sdanielk1977 * 3680d99bc930Sdanielk1977 * (op == TK_DELETE) 368146408354Sdan * zTarget -> Dequoted name of the table to delete from. 3682d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 3683d99bc930Sdanielk1977 * Otherwise NULL. 3684d99bc930Sdanielk1977 * 3685d99bc930Sdanielk1977 * (op == TK_UPDATE) 368646408354Sdan * zTarget -> Dequoted name of the table to update. 3687d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 3688d99bc930Sdanielk1977 * Otherwise NULL. 3689d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 36904adee20fSdanielk1977 * them to. See sqlite3Update() documentation of "pChanges" 3691ad3cab52Sdrh * argument. 3692d99bc930Sdanielk1977 * 3693d99bc930Sdanielk1977 */ 3694c3f9bad2Sdanielk1977 struct TriggerStep { 3695dac9a5f7Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT, 3696dac9a5f7Sdrh ** or TK_RETURNING */ 3697b1819a0bSdrh u8 orconf; /* OE_Rollback etc. */ 3698a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 369946408354Sdan Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */ 370046408354Sdan char *zTarget; /* Target table for DELETE, UPDATE, INSERT */ 3701e7877b2dSdan SrcList *pFrom; /* FROM clause for UPDATE statement (if any) */ 3702b1819a0bSdrh Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 3703381bdaccSdrh ExprList *pExprList; /* SET clause for UPDATE, or RETURNING clause */ 3704b1819a0bSdrh IdList *pIdList; /* Column names for INSERT */ 370546d2e5c3Sdrh Upsert *pUpsert; /* Upsert clauses on an INSERT */ 3706f259df5fSdrh char *zSpan; /* Original SQL text of this command */ 3707c3f9bad2Sdanielk1977 TriggerStep *pNext; /* Next in the link-list */ 3708187e4c6aSdrh TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 3709c3f9bad2Sdanielk1977 }; 3710c3f9bad2Sdanielk1977 3711d99bc930Sdanielk1977 /* 3712b8352479Sdrh ** Information about a RETURNING clause 3713b8352479Sdrh */ 3714b8352479Sdrh struct Returning { 3715b8352479Sdrh Parse *pParse; /* The parse that includes the RETURNING clause */ 3716b8352479Sdrh ExprList *pReturnEL; /* List of expressions to return */ 3717b8352479Sdrh Trigger retTrig; /* The transient trigger that implements RETURNING */ 3718b8352479Sdrh TriggerStep retTStep; /* The trigger step */ 3719381bdaccSdrh int iRetCur; /* Transient table holding RETURNING results */ 3720381bdaccSdrh int nRetCol; /* Number of in pReturnEL after expansion */ 3721552562c4Sdrh int iRetReg; /* Register array for holding a row of RETURNING */ 3722b8352479Sdrh }; 3723b8352479Sdrh 3724b8352479Sdrh /* 3725ade86483Sdrh ** An objected used to accumulate the text of a string where we 3726ade86483Sdrh ** do not necessarily know how big the string will be in the end. 3727ade86483Sdrh */ 37280cdbe1aeSdrh struct sqlite3_str { 3729633e6d57Sdrh sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 3730ade86483Sdrh char *zText; /* The string collected so far */ 3731fa385edfSdrh u32 nAlloc; /* Amount of space allocated in zText */ 3732fa385edfSdrh u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */ 37333f18e6d7Sdrh u32 nChar; /* Length of the string so far */ 37340cdbe1aeSdrh u8 accError; /* SQLITE_NOMEM or SQLITE_TOOBIG */ 37355f4a686fSdrh u8 printfFlags; /* SQLITE_PRINTF flags below */ 3736ade86483Sdrh }; 37375f4a686fSdrh #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */ 37385f4a686fSdrh #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */ 37395f4a686fSdrh #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */ 37405f4a686fSdrh 37415f4a686fSdrh #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0) 37425f4a686fSdrh 3743ade86483Sdrh 3744ade86483Sdrh /* 3745234c39dfSdrh ** A pointer to this structure is used to communicate information 3746234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 3747234c39dfSdrh */ 3748234c39dfSdrh typedef struct { 37499bb575fdSdrh sqlite3 *db; /* The database being initialized */ 3750234c39dfSdrh char **pzErrMsg; /* Error message stored here */ 3751a451017dSdrh int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 375215ca1df1Sdrh int rc; /* Result code stored here */ 3753987db767Sdan u32 mInitFlags; /* Flags controlling error messages */ 37546b86e51eSdrh u32 nInitRow; /* Number of rows processed */ 37553b3ddbaeSdrh Pgno mxPage; /* Maximum page number. 0 for no limit. */ 3756234c39dfSdrh } InitData; 3757234c39dfSdrh 3758b6c29897Sdrh /* 3759987db767Sdan ** Allowed values for mInitFlags 3760987db767Sdan */ 37616a5a13dfSdan #define INITFLAG_AlterRename 0x0001 /* Reparse after a RENAME */ 37626a5a13dfSdan #define INITFLAG_AlterDrop 0x0002 /* Reparse after a DROP COLUMN */ 3763987db767Sdan 3764f3c1256aSdrh /* Tuning parameters are set using SQLITE_TESTCTRL_TUNE and are controlled 3765f3c1256aSdrh ** on debug-builds of the CLI using ".testctrl tune ID VALUE". Tuning 3766f3c1256aSdrh ** parameters are for temporary use during development, to help find 3767f3c1256aSdrh ** optimial values for parameters in the query planner. The should not 3768f3c1256aSdrh ** be used on trunk check-ins. They are a temporary mechanism available 3769f3c1256aSdrh ** for transient development builds only. 37702d26cfccSdrh ** 37712d26cfccSdrh ** Tuning parameters are numbered starting with 1. 3772f3c1256aSdrh */ 3773f3c1256aSdrh #define SQLITE_NTUNE 6 /* Should be zero for all trunk check-ins */ 3774f3c1256aSdrh #ifdef SQLITE_DEBUG 37752d26cfccSdrh # define Tuning(X) (sqlite3Config.aTune[(X)-1]) 3776f3c1256aSdrh #else 3777f3c1256aSdrh # define Tuning(X) 0 3778f3c1256aSdrh #endif 3779f3c1256aSdrh 3780987db767Sdan /* 378140257ffdSdrh ** Structure containing global configuration data for the SQLite library. 378233589797Sdrh ** 378333589797Sdrh ** This structure also contains some state information. 378440257ffdSdrh */ 378540257ffdSdrh struct Sqlite3Config { 3786fec00eabSdrh int bMemstat; /* True to enable memory status */ 378730842990Sdrh u8 bCoreMutex; /* True to enable core mutexing */ 378830842990Sdrh u8 bFullMutex; /* True to enable full mutexing */ 378930842990Sdrh u8 bOpenUri; /* True to interpret filenames as URIs */ 379030842990Sdrh u8 bUseCis; /* Use covering indices for full-scans */ 379130842990Sdrh u8 bSmallMalloc; /* Avoid large memory allocations if true */ 379230842990Sdrh u8 bExtraSchemaChecks; /* Verify type,name,tbl_name in schema */ 37930a687d12Sdrh int mxStrlen; /* Maximum string length */ 379409fe6143Sdrh int neverCorrupt; /* Database is always well-formed */ 3795633e6d57Sdrh int szLookaside; /* Default lookaside buffer size */ 3796633e6d57Sdrh int nLookaside; /* Default lookaside buffer count */ 37978c71a98cSdrh int nStmtSpill; /* Stmt-journal spill-to-disk threshold */ 3798fec00eabSdrh sqlite3_mem_methods m; /* Low-level memory allocation interface */ 37996d2ab0e4Sdanielk1977 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 380022e21ff4Sdan sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */ 380140257ffdSdrh void *pHeap; /* Heap storage space */ 380233589797Sdrh int nHeap; /* Size of pHeap[] */ 380333589797Sdrh int mnReq, mxReq; /* Min and max heap requests sizes */ 38049b4c59faSdrh sqlite3_int64 szMmap; /* mmap() space per open file */ 38059b4c59faSdrh sqlite3_int64 mxMmap; /* Maximum value for szMmap */ 380633589797Sdrh void *pPage; /* Page cache memory */ 380733589797Sdrh int szPage; /* Size of each page in pPage[] */ 380833589797Sdrh int nPage; /* Number of pages in pPage[] */ 38091875f7a3Sdrh int mxParserStack; /* maximum depth of the parser stack */ 38101875f7a3Sdrh int sharedCacheEnabled; /* true if shared-cache mode enabled */ 38113bd1791dSdrh u32 szPma; /* Maximum Sorter PMA size */ 38121875f7a3Sdrh /* The above might be initialized to non-zero. The following need to always 38131875f7a3Sdrh ** initially be zero, however. */ 381471bc31c6Sdanielk1977 int isInit; /* True after initialization has finished */ 3815502b4e00Sdanielk1977 int inProgress; /* True while initialization in progress */ 3816e1ab2193Sdan int isMutexInit; /* True after mutexes are initialized */ 381771bc31c6Sdanielk1977 int isMallocInit; /* True after malloc is initialized */ 3818e1ab2193Sdan int isPCacheInit; /* True after malloc is initialized */ 381993ed56d9Sdrh int nRefInitMutex; /* Number of users of pInitMutex */ 3820c007f61bSdrh sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 38213f280701Sdrh void (*xLog)(void*,int,const char*); /* Function for logging */ 38223f280701Sdrh void *pLogArg; /* First argument to xLog() */ 3823ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG 3824ac455939Sdan void(*xSqllog)(void*,sqlite3*,const char*, int); 3825ac455939Sdan void *pSqllogArg; 3826ac455939Sdan #endif 3827688852abSdrh #ifdef SQLITE_VDBE_COVERAGE 3828688852abSdrh /* The following callback (if not NULL) is invoked on every VDBE branch 3829688852abSdrh ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE. 3830688852abSdrh */ 38317083a487Sdrh void (*xVdbeBranch)(void*,unsigned iSrcLine,u8 eThis,u8 eMx); /* Callback */ 3832688852abSdrh void *pVdbeBranchArg; /* 1st argument */ 3833688852abSdrh #endif 38348d889afcSdrh #ifndef SQLITE_OMIT_DESERIALIZE 383523a88595Sdrh sqlite3_int64 mxMemdbSize; /* Default max memdb size */ 383623a88595Sdrh #endif 3837d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 3838c007f61bSdrh int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */ 3839c007f61bSdrh #endif 3840c007f61bSdrh int bLocaltimeFault; /* True to fail localtime() calls */ 38419e5eb9c8Sdrh int iOnceResetThreshold; /* When to reset OP_Once counters */ 38422e3a5a81Sdan u32 szSorterRef; /* Min size in bytes to use sorter-refs */ 3843ade54d68Sdrh unsigned int iPrngSeed; /* Alternative fixed seed for the PRNG */ 3844f3c1256aSdrh /* vvvv--- must be last ---vvv */ 3845f3c1256aSdrh #ifdef SQLITE_DEBUG 3846f3c1256aSdrh sqlite3_int64 aTune[SQLITE_NTUNE]; /* Tuning parameters */ 3847f3c1256aSdrh #endif 384840257ffdSdrh }; 384940257ffdSdrh 385040257ffdSdrh /* 385109fe6143Sdrh ** This macro is used inside of assert() statements to indicate that 385209fe6143Sdrh ** the assert is only valid on a well-formed database. Instead of: 385309fe6143Sdrh ** 385409fe6143Sdrh ** assert( X ); 385509fe6143Sdrh ** 385609fe6143Sdrh ** One writes: 385709fe6143Sdrh ** 3858b2023665Sdrh ** assert( X || CORRUPT_DB ); 385909fe6143Sdrh ** 3860b2023665Sdrh ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate 3861b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt. 3862b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special 3863b2023665Sdrh ** sqlite3_test_control(). This enables assert() statements to prove 3864b2023665Sdrh ** things that are always true for well-formed databases. 386509fe6143Sdrh */ 3866b2023665Sdrh #define CORRUPT_DB (sqlite3Config.neverCorrupt==0) 386709fe6143Sdrh 386809fe6143Sdrh /* 38697d10d5a6Sdrh ** Context pointer passed down through the tree-walk. 38707d10d5a6Sdrh */ 38717d10d5a6Sdrh struct Walker { 38729bfb024dSdrh Parse *pParse; /* Parser context. */ 38737d10d5a6Sdrh int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 38747d10d5a6Sdrh int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 3875b290f117Sdan void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */ 3876030796dfSdrh int walkerDepth; /* Number of subqueries */ 3877dfa15270Sdrh u16 eCode; /* A small processing code */ 38787d10d5a6Sdrh union { /* Extra data for callback */ 38797d10d5a6Sdrh NameContext *pNC; /* Naming context */ 3880059b2d50Sdrh int n; /* A counter */ 3881059b2d50Sdrh int iCur; /* A cursor number */ 3882374fdce4Sdrh SrcList *pSrcList; /* FROM clause */ 3883030796dfSdrh struct SrcCount *pSrcCount; /* Counting column references */ 38842f2b0278Sdrh struct CCurHint *pCCurHint; /* Used by codeCursorHint() */ 38852a0b527bSdrh int *aiCol; /* array of column indexes */ 38862409f8a1Sdrh struct IdxCover *pIdxCover; /* Check for index coverage */ 3887cd0abc24Sdrh struct IdxExprTrans *pIdxTrans; /* Convert idxed expr to column */ 3888ab31a845Sdan ExprList *pGroupBy; /* GROUP BY clause */ 3889cd0abc24Sdrh Select *pSelect; /* HAVING to WHERE clause ctx */ 389086fb6e17Sdan struct WindowRewrite *pRewrite; /* Window rewrite context */ 3891660ee556Sdrh struct WhereConst *pConst; /* WHERE clause constants */ 3892cf8f2895Sdan struct RenameCtx *pRename; /* RENAME COLUMN context */ 3893dfa15270Sdrh struct Table *pTab; /* Table of generated column */ 38947601294aSdrh SrcItem *pSrcItem; /* A single FROM clause item */ 3895f380c3f1Sdan DbFixer *pFix; 38967d10d5a6Sdrh } u; 38977d10d5a6Sdrh }; 38987d10d5a6Sdrh 3899f380c3f1Sdan /* 3900f380c3f1Sdan ** The following structure contains information used by the sqliteFix... 3901f380c3f1Sdan ** routines as they walk the parse tree to make database references 3902f380c3f1Sdan ** explicit. 3903f380c3f1Sdan */ 3904f380c3f1Sdan struct DbFixer { 3905f380c3f1Sdan Parse *pParse; /* The parsing context. Error messages written here */ 3906f380c3f1Sdan Walker w; /* Walker object */ 3907f380c3f1Sdan Schema *pSchema; /* Fix items to this schema */ 3908f380c3f1Sdan u8 bTemp; /* True for TEMP schema entries */ 3909f380c3f1Sdan const char *zDb; /* Make sure all objects are contained in this database */ 3910f380c3f1Sdan const char *zType; /* Type of the container - used for error messages */ 3911f380c3f1Sdan const Token *pName; /* Name of the container - used for error messages */ 3912f380c3f1Sdan }; 3913f380c3f1Sdan 39147d10d5a6Sdrh /* Forward declarations */ 39157d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*); 39167d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*); 39177d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*); 39187d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*); 39197d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*); 39205b88bc4bSdrh int sqlite3ExprWalkNoop(Walker*, Expr*); 3921979dd1beSdrh int sqlite3SelectWalkNoop(Walker*, Select*); 39227e6f980bSdrh int sqlite3SelectWalkFail(Walker*, Select*); 3923e40cc16bSdrh int sqlite3WalkerDepthIncrease(Walker*,Select*); 3924e40cc16bSdrh void sqlite3WalkerDepthDecrease(Walker*,Select*); 39255e8e7464Sdrh void sqlite3WalkWinDefnDummyCallback(Walker*,Select*); 3926e40cc16bSdrh 3927979dd1beSdrh #ifdef SQLITE_DEBUG 3928979dd1beSdrh void sqlite3SelectWalkAssert2(Walker*, Select*); 3929979dd1beSdrh #endif 39307d10d5a6Sdrh 3931be12083bSdan #ifndef SQLITE_OMIT_CTE 3932be12083bSdan void sqlite3SelectPopWith(Walker*, Select*); 3933be12083bSdan #else 3934be12083bSdan # define sqlite3SelectPopWith 0 3935be12083bSdan #endif 3936be12083bSdan 39377d10d5a6Sdrh /* 39387d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their 39397d10d5a6Sdrh ** callbacks. 39407d10d5a6Sdrh */ 39412bf90f1eSdrh #define WRC_Continue 0 /* Continue down into children */ 39422bf90f1eSdrh #define WRC_Prune 1 /* Omit children but continue walking siblings */ 39432bf90f1eSdrh #define WRC_Abort 2 /* Abandon the tree walk */ 39447d10d5a6Sdrh 39457d10d5a6Sdrh /* 3946f824b41eSdrh ** A single common table expression 39477d562dbeSdan */ 3948f824b41eSdrh struct Cte { 39494e9119d9Sdan char *zName; /* Name of this CTE */ 39504e9119d9Sdan ExprList *pCols; /* List of explicit column names, or NULL */ 3951c49832c2Sdrh Select *pSelect; /* The definition of this CTE */ 39520576bc59Sdrh const char *zCteErr; /* Error message for circular references */ 3953a79e2a2dSdrh CteUse *pUse; /* Usage information for this CTE */ 3954745912efSdrh u8 eM10d; /* The MATERIALIZED flag */ 3955f824b41eSdrh }; 3956f824b41eSdrh 3957f824b41eSdrh /* 3958745912efSdrh ** Allowed values for the materialized flag (eM10d): 3959745912efSdrh */ 3960745912efSdrh #define M10d_Yes 0 /* AS MATERIALIZED */ 3961745912efSdrh #define M10d_Any 1 /* Not specified. Query planner's choice */ 3962745912efSdrh #define M10d_No 2 /* AS NOT MATERIALIZED */ 3963745912efSdrh 3964745912efSdrh /* 3965f824b41eSdrh ** An instance of the With object represents a WITH clause containing 3966f824b41eSdrh ** one or more CTEs (common table expressions). 3967f824b41eSdrh */ 3968f824b41eSdrh struct With { 3969f824b41eSdrh int nCte; /* Number of CTEs in the WITH clause */ 397090bc36fbSdan int bView; /* Belongs to the outermost Select of a view */ 3971f824b41eSdrh With *pOuter; /* Containing WITH clause, or NULL */ 3972f824b41eSdrh Cte a[1]; /* For each CTE in the WITH clause.... */ 39737d562dbeSdan }; 39747d562dbeSdan 3975a79e2a2dSdrh /* 3976a79e2a2dSdrh ** The Cte object is not guaranteed to persist for the entire duration 3977a79e2a2dSdrh ** of code generation. (The query flattener or other parser tree 3978a79e2a2dSdrh ** edits might delete it.) The following object records information 3979a79e2a2dSdrh ** about each Common Table Expression that must be preserved for the 3980a79e2a2dSdrh ** duration of the parse. 3981a79e2a2dSdrh ** 3982a79e2a2dSdrh ** The CteUse objects are freed using sqlite3ParserAddCleanup() rather 3983a79e2a2dSdrh ** than sqlite3SelectDelete(), which is what enables them to persist 3984a79e2a2dSdrh ** until the end of code generation. 3985a79e2a2dSdrh */ 3986a79e2a2dSdrh struct CteUse { 3987a79e2a2dSdrh int nUse; /* Number of users of this CTE */ 3988a79e2a2dSdrh int addrM9e; /* Start of subroutine to compute materialization */ 3989a79e2a2dSdrh int regRtn; /* Return address register for addrM9e subroutine */ 3990a79e2a2dSdrh int iCur; /* Ephemeral table holding the materialization */ 3991a79e2a2dSdrh LogEst nRowEst; /* Estimated number of rows in the table */ 3992745912efSdrh u8 eM10d; /* The MATERIALIZED flag */ 3993a79e2a2dSdrh }; 3994a79e2a2dSdrh 3995a79e2a2dSdrh 39964fa4a54fSdrh #ifdef SQLITE_DEBUG 39974fa4a54fSdrh /* 39984fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of 39994fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view. 40004fa4a54fSdrh */ 40014fa4a54fSdrh struct TreeView { 40024fa4a54fSdrh int iLevel; /* Which level of the tree we are on */ 4003b08cd3f3Sdrh u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */ 40044fa4a54fSdrh }; 40054fa4a54fSdrh #endif /* SQLITE_DEBUG */ 40064fa4a54fSdrh 40079a94722dSdan /* 4008df9d3244Sdan ** This object is used in various ways, most (but not all) related to window 4009df9d3244Sdan ** functions. 4010a1fd4b52Sdrh ** 4011a1fd4b52Sdrh ** (1) A single instance of this structure is attached to the 4012df9d3244Sdan ** the Expr.y.pWin field for each window function in an expression tree. 4013a1fd4b52Sdrh ** This object holds the information contained in the OVER clause, 4014a1fd4b52Sdrh ** plus additional fields used during code generation. 4015a1fd4b52Sdrh ** 4016a1fd4b52Sdrh ** (2) All window functions in a single SELECT form a linked-list 4017a1fd4b52Sdrh ** attached to Select.pWin. The Window.pFunc and Window.pExpr 4018a1fd4b52Sdrh ** fields point back to the expression that is the window function. 4019a1fd4b52Sdrh ** 4020a1fd4b52Sdrh ** (3) The terms of the WINDOW clause of a SELECT are instances of this 4021a1fd4b52Sdrh ** object on a linked list attached to Select.pWinDefn. 4022a1fd4b52Sdrh ** 4023df9d3244Sdan ** (4) For an aggregate function with a FILTER clause, an instance 4024df9d3244Sdan ** of this object is stored in Expr.y.pWin with eFrmType set to 4025df9d3244Sdan ** TK_FILTER. In this case the only field used is Window.pFilter. 4026df9d3244Sdan ** 4027a1fd4b52Sdrh ** The uses (1) and (2) are really the same Window object that just happens 4028fc15f4c5Sdrh ** to be accessible in two different ways. Use case (3) are separate objects. 40299a94722dSdan */ 403086fb6e17Sdan struct Window { 4031e3bf632cSdan char *zName; /* Name of window (may be NULL) */ 4032e7c9ca41Sdan char *zBase; /* Name of base window for chaining (may be NULL) */ 4033e3bf632cSdan ExprList *pPartition; /* PARTITION BY clause */ 4034e3bf632cSdan ExprList *pOrderBy; /* ORDER BY clause */ 4035fc15f4c5Sdrh u8 eFrmType; /* TK_RANGE, TK_GROUPS, TK_ROWS, or 0 */ 403686fb6e17Sdan u8 eStart; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 403786fb6e17Sdan u8 eEnd; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 4038e7c9ca41Sdan u8 bImplicitFrame; /* True if frame was implicitly specified */ 4039fc15f4c5Sdrh u8 eExclude; /* TK_NO, TK_CURRENT, TK_TIES, TK_GROUP, or 0 */ 404086fb6e17Sdan Expr *pStart; /* Expression for "<expr> PRECEDING" */ 404186fb6e17Sdan Expr *pEnd; /* Expression for "<expr> FOLLOWING" */ 404275b0821eSdan Window **ppThis; /* Pointer to this object in Select.pWin list */ 404386fb6e17Sdan Window *pNextWin; /* Next window function belonging to this SELECT */ 4044a1fd4b52Sdrh Expr *pFilter; /* The FILTER expression */ 4045a1fd4b52Sdrh FuncDef *pFunc; /* The function */ 4046b0225bc5Sdrh int iEphCsr; /* Partition buffer or Peer buffer */ 4047d44c617aSdrh int regAccum; /* Accumulator */ 4048d44c617aSdrh int regResult; /* Interim result */ 4049c9a8668aSdan int csrApp; /* Function cursor (used by min/max) */ 4050c9a8668aSdan int regApp; /* Function register (also used by min/max) */ 4051b6f2deacSdan int regPart; /* Array of registers for PARTITION BY values */ 405286fb6e17Sdan Expr *pOwner; /* Expression object this window is attached to */ 405386fb6e17Sdan int nBufferCol; /* Number of columns in buffer table */ 405486fb6e17Sdan int iArgCol; /* Offset of first argument for this function */ 4055bf84515aSdan int regOne; /* Register containing constant value 1 */ 4056a0f6b833Sdan int regStartRowid; 4057a0f6b833Sdan int regEndRowid; 4058d44c617aSdrh u8 bExprArgs; /* Defer evaluation of window function arguments 4059d44c617aSdrh ** due to the SQLITE_SUBTYPE flag */ 406086fb6e17Sdan }; 406186fb6e17Sdan 406267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 406386fb6e17Sdan void sqlite3WindowDelete(sqlite3*, Window*); 4064e2094572Sdrh void sqlite3WindowUnlinkFromSelect(Window*); 4065e3bf632cSdan void sqlite3WindowListDelete(sqlite3 *db, Window *p); 4066d35300f9Sdan Window *sqlite3WindowAlloc(Parse*, int, int, Expr*, int , Expr*, u8); 406786fb6e17Sdan void sqlite3WindowAttach(Parse*, Expr*, Window*); 4068a3fcc000Sdan void sqlite3WindowLink(Select *pSel, Window *pWin); 40694f9adee2Sdan int sqlite3WindowCompare(Parse*, Window*, Window*, int); 40704ea562eeSdan void sqlite3WindowCodeInit(Parse*, Select*); 4071dacf1de9Sdan void sqlite3WindowCodeStep(Parse*, Select*, WhereInfo*, int, int); 4072dfa552f4Sdan int sqlite3WindowRewrite(Parse*, Select*); 4073e3bf632cSdan void sqlite3WindowUpdate(Parse*, Window*, Window*, FuncDef*); 40742a11bb23Sdan Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p); 4075c95f38d4Sdan Window *sqlite3WindowListDup(sqlite3 *db, Window *p); 40769a94722dSdan void sqlite3WindowFunctions(void); 4077e7c9ca41Sdan void sqlite3WindowChain(Parse*, Window*, Window*); 4078e7c9ca41Sdan Window *sqlite3WindowAssemble(Parse*, Window*, ExprList*, ExprList*, Token*); 407967a9b8edSdan #else 408067a9b8edSdan # define sqlite3WindowDelete(a,b) 408167a9b8edSdan # define sqlite3WindowFunctions() 408267a9b8edSdan # define sqlite3WindowAttach(a,b,c) 408367a9b8edSdan #endif 408486fb6e17Sdan 40857d562dbeSdan /* 408666150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character, 408766150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character. 40884a919118Sdrh */ 40894a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) { \ 40904a919118Sdrh if( (*(zIn++))>=0xc0 ){ \ 40914a919118Sdrh while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 40924a919118Sdrh } \ 40934a919118Sdrh } 40944a919118Sdrh 40954a919118Sdrh /* 40969978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with 40979978c97eSdrh ** the same name but without the _BKPT suffix. These macros invoke 40989978c97eSdrh ** routines that report the line-number on which the error originated 40999978c97eSdrh ** using sqlite3_log(). The routines also provide a convenient place 41009978c97eSdrh ** to set a debugger breakpoint. 410149285708Sdrh */ 4102eebf2f57Sdan int sqlite3ReportError(int iErr, int lineno, const char *zType); 41039978c97eSdrh int sqlite3CorruptError(int); 41049978c97eSdrh int sqlite3MisuseError(int); 41059978c97eSdrh int sqlite3CantopenError(int); 41069978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 41079978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 41089978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 410932c49904Sdrh #ifdef SQLITE_DEBUG 411032c49904Sdrh int sqlite3NomemError(int); 411132c49904Sdrh int sqlite3IoerrnomemError(int); 4112fad3039cSmistachkin # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__) 4113fad3039cSmistachkin # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__) 411432c49904Sdrh #else 411532c49904Sdrh # define SQLITE_NOMEM_BKPT SQLITE_NOMEM 411632c49904Sdrh # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM 41173cdc8205Sdan #endif 41183cdc8205Sdan #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO) 41193cdc8205Sdan int sqlite3CorruptPgnoError(int,Pgno); 41203cdc8205Sdan # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P)) 41213cdc8205Sdan #else 4122cc97ca4cSdrh # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__) 412332c49904Sdrh #endif 41249978c97eSdrh 41254553f6eaSdrh /* 41264553f6eaSdrh ** FTS3 and FTS4 both require virtual table support 41274553f6eaSdrh */ 41284553f6eaSdrh #if defined(SQLITE_OMIT_VIRTUALTABLE) 41294553f6eaSdrh # undef SQLITE_ENABLE_FTS3 41304553f6eaSdrh # undef SQLITE_ENABLE_FTS4 41314553f6eaSdrh #endif 413249285708Sdrh 413349285708Sdrh /* 4134b4a1fed2Sdrh ** FTS4 is really an extension for FTS3. It is enabled using the 413560ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call 413660ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3. 4137b4a1fed2Sdrh */ 4138b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 41390ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1 4140b4a1fed2Sdrh #endif 4141b4a1fed2Sdrh 4142b4a1fed2Sdrh /* 414379f02cefSdrh ** The ctype.h header is needed for non-ASCII systems. It is also 414479f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation. 414579f02cefSdrh */ 414679f02cefSdrh #if !defined(SQLITE_ASCII) || \ 414779f02cefSdrh (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 414879f02cefSdrh # include <ctype.h> 414979f02cefSdrh #endif 415079f02cefSdrh 415179f02cefSdrh /* 415278ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(), 415378ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 415478ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale. 415578ca0e7eSdanielk1977 */ 415678ca0e7eSdanielk1977 #ifdef SQLITE_ASCII 415778ca0e7eSdanielk1977 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 415878ca0e7eSdanielk1977 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 4159dc86e2b2Sdrh # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 4160dc86e2b2Sdrh # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 416178ca0e7eSdanielk1977 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 416278ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 416378ca0e7eSdanielk1977 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 4164244b9d6eSdrh # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80) 416578ca0e7eSdanielk1977 #else 416678ca0e7eSdanielk1977 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 416778ca0e7eSdanielk1977 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 416878ca0e7eSdanielk1977 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 4169dc86e2b2Sdrh # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 417078ca0e7eSdanielk1977 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 417178ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 417278ca0e7eSdanielk1977 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 4173244b9d6eSdrh # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`') 417478ca0e7eSdanielk1977 #endif 417597348b37Sdrh int sqlite3IsIdChar(u8); 417678ca0e7eSdanielk1977 417778ca0e7eSdanielk1977 /* 417875897234Sdrh ** Internal function prototypes 417975897234Sdrh */ 418080738d9cSdrh int sqlite3StrICmp(const char*,const char*); 4181ea678832Sdrh int sqlite3Strlen30(const char*); 41827301e774Sdrh #define sqlite3Strlen30NN(C) (strlen(C)&0x3fffffff) 4183d7564865Sdrh char *sqlite3ColumnType(Column*,char*); 4184ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp 41852e588c75Sdanielk1977 418640257ffdSdrh int sqlite3MallocInit(void); 4187fec00eabSdrh void sqlite3MallocEnd(void); 4188da4ca9d1Sdrh void *sqlite3Malloc(u64); 4189da4ca9d1Sdrh void *sqlite3MallocZero(u64); 4190da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64); 4191da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64); 4192575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3*, u64); 419317435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*); 4194da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64); 41959b2e0435Sdrh char *sqlite3DbSpanDup(sqlite3*,const char*,const char*); 4196da4ca9d1Sdrh void *sqlite3Realloc(void*, u64); 4197da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64); 4198da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64); 4199633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*); 4200dbd6a7dcSdrh void sqlite3DbFreeNN(sqlite3*, void*); 4201a7a8e14bSdanielk1977 int sqlite3MallocSize(void*); 4202633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*); 4203facf0307Sdrh void *sqlite3PageMalloc(int); 4204facf0307Sdrh void sqlite3PageFree(void*); 4205fec00eabSdrh void sqlite3MemSetDefault(void); 4206d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 4207171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 4208f5ed7ad6Sdrh #endif 420950d1b5f3Sdrh int sqlite3HeapNearlyFull(void); 42102e588c75Sdanielk1977 4211e7b34707Sdrh /* 4212e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make 4213e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects. By default, 4214e7b34707Sdrh ** obtain space from malloc(). 4215e7b34707Sdrh ** 4216e7b34707Sdrh ** The alloca() routine never returns NULL. This will cause code paths 4217e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable. 4218e7b34707Sdrh */ 4219e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA 4220e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) alloca(N) 4221e7b34707Sdrh # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 4222e7b34707Sdrh # define sqlite3StackFree(D,P) 4223e7b34707Sdrh #else 4224e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 4225e7b34707Sdrh # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 4226e7b34707Sdrh # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 4227e7b34707Sdrh #endif 4228e7b34707Sdrh 42295d513ba0Sdrh /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they 42305d513ba0Sdrh ** are, disable MEMSYS3 42315d513ba0Sdrh */ 4232f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5 4233f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 42345d513ba0Sdrh #undef SQLITE_ENABLE_MEMSYS3 42355d513ba0Sdrh #endif 42365d513ba0Sdrh #ifdef SQLITE_ENABLE_MEMSYS3 42375d513ba0Sdrh const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 4238f3d3c27aSdanielk1977 #endif 4239f3d3c27aSdanielk1977 4240f3d3c27aSdanielk1977 424118472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT 4242558814f8Sdan sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 4243558814f8Sdan sqlite3_mutex_methods const *sqlite3NoopMutex(void); 424459f8c08eSdanielk1977 sqlite3_mutex *sqlite3MutexAlloc(int); 4245d025174fSdanielk1977 int sqlite3MutexInit(void); 4246d025174fSdanielk1977 int sqlite3MutexEnd(void); 424765bbf29eSdrh #endif 42480e8729dbSdrh #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP) 42496081c1dbSdrh void sqlite3MemoryBarrier(void); 42500e8729dbSdrh #else 425104abf087Smistachkin # define sqlite3MemoryBarrier() 4252f7141990Sdrh #endif 4253f7141990Sdrh 4254af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int); 4255af89fe66Sdrh void sqlite3StatusUp(int, int); 4256af89fe66Sdrh void sqlite3StatusDown(int, int); 4257b02392e6Sdrh void sqlite3StatusHighwater(int, int); 425852fb8e19Sdrh int sqlite3LookasideUsed(sqlite3*,int*); 4259f7141990Sdrh 4260af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */ 4261af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void); 4262af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void); 4263af89fe66Sdrh 426461f8e86fSdan #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT) 42658385becfSdan void sqlite3MutexWarnOnContention(sqlite3_mutex*); 42668385becfSdan #else 42678385becfSdan # define sqlite3MutexWarnOnContention(x) 42688385becfSdan #endif 42698385becfSdan 427085c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT 427105921223Sdrh # define EXP754 (((u64)0x7ff)<<52) 427205921223Sdrh # define MAN754 ((((u64)1)<<52)-1) 427305921223Sdrh # define IsNaN(X) (((X)&EXP754)==EXP754 && ((X)&MAN754)!=0) 42740de3ae95Sdrh int sqlite3IsNaN(double); 427585c8f291Sdrh #else 427605921223Sdrh # define IsNaN(X) 0 427785c8f291Sdrh # define sqlite3IsNaN(X) 0 427885c8f291Sdrh #endif 42790de3ae95Sdrh 4280a5c1416dSdrh /* 4281a5c1416dSdrh ** An instance of the following structure holds information about SQL 4282a5c1416dSdrh ** functions arguments that are the parameters to the printf() function. 4283a5c1416dSdrh */ 4284a5c1416dSdrh struct PrintfArguments { 4285a5c1416dSdrh int nArg; /* Total number of arguments */ 4286a5c1416dSdrh int nUsed; /* Number of arguments used so far */ 4287a5c1416dSdrh sqlite3_value **apArg; /* The argument values */ 4288a5c1416dSdrh }; 4289a5c1416dSdrh 429017435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...); 429117435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 429202b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE) 4293e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...); 4294d919fe17Sdrh #endif 4295d919fe17Sdrh #if defined(SQLITE_TEST) 4296e8f52c50Sdrh void *sqlite3TestTextToPtr(const char*); 429787cc3b31Sdrh #endif 42987e02e5e6Sdrh 42994fa4a54fSdrh #if defined(SQLITE_DEBUG) 43004fa4a54fSdrh void sqlite3TreeViewExpr(TreeView*, const Expr*, u8); 4301db97e562Sdrh void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*); 43024fa4a54fSdrh void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*); 4303145d0a35Sdrh void sqlite3TreeViewSrcList(TreeView*, const SrcList*); 43044fa4a54fSdrh void sqlite3TreeViewSelect(TreeView*, const Select*, u8); 43052476a6f2Sdrh void sqlite3TreeViewWith(TreeView*, const With*, u8); 4306a1fd4b52Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC 4307a1fd4b52Sdrh void sqlite3TreeViewWindow(TreeView*, const Window*, u8); 4308a1fd4b52Sdrh void sqlite3TreeViewWinFunc(TreeView*, const Window*, u8); 4309a1fd4b52Sdrh #endif 43107e02e5e6Sdrh #endif 43117e02e5e6Sdrh 43127e02e5e6Sdrh 431322c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*); 43144adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...); 4315c3dcdba3Sdrh int sqlite3ErrorToParser(sqlite3*,int); 4316244b9d6eSdrh void sqlite3Dequote(char*); 431751d35b0fSdrh void sqlite3DequoteExpr(Expr*); 431840aced5cSdrh void sqlite3TokenInit(Token*,char*); 43192646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int); 43204adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **); 432180242055Sdrh void sqlite3FinishCoding(Parse*); 4322892d3179Sdrh int sqlite3GetTempReg(Parse*); 4323892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int); 4324892d3179Sdrh int sqlite3GetTempRange(Parse*,int); 4325892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int); 4326cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*); 4327bb9b5f26Sdrh #ifdef SQLITE_DEBUG 4328bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse*,int,int); 4329bb9b5f26Sdrh #endif 4330b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 4331b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*); 4332b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 4333abfd35eaSdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*); 433408de4f79Sdrh void sqlite3PExprAddSelect(Parse*, Expr*, Select*); 4335d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse*,Expr*, Expr*); 433617180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr*); 4337954733b3Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*, int); 43380dfa5255Sdrh void sqlite3ExprFunctionUsable(Parse*,Expr*,FuncDef*); 4339de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32); 4340633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*); 4341b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse*, Expr*); 43428e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse*, Expr*); 4343b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 4344a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*); 434574777f99Sdan Select *sqlite3ExprListToValues(Parse*, int, ExprList*); 43466e11892dSdan void sqlite3ExprListSetSortOrder(ExprList*,int,int); 4347b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 43481be266baSdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*); 4349633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*); 43502308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*); 43518d40673cSdrh int sqlite3IndexHasDuplicateRootPage(Index*); 43529bb575fdSdrh int sqlite3Init(sqlite3*, char**); 4353234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**); 4354987db767Sdan int sqlite3InitOne(sqlite3*, int, char**, u32); 435591cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 43562fcc1590Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 43572fcc1590Sdrh Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName); 43582fcc1590Sdrh #endif 435981028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*); 436081028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int); 436181028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*); 43629bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*); 436351be3873Sdrh void sqlite3DeleteColumnNames(sqlite3*,Table*); 43649088186bSdrh void sqlite3GenerateColumnNames(Parse *pParse, Select *pSelect); 43658981b904Sdrh int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**); 436681506b88Sdrh void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*,char); 436781506b88Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*,char); 4368346a70caSdrh void sqlite3OpenSchemaTable(Parse *, int); 43694415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*); 4370b9bcf7caSdrh i16 sqlite3TableColumnToIndex(Index*, i16); 437181f7b372Sdrh #ifdef SQLITE_OMIT_GENERATED_COLUMNS 4372b9bcf7caSdrh # define sqlite3TableColumnToStorage(T,X) (X) /* No-op pass-through */ 4373b9bcf7caSdrh # define sqlite3StorageColumnToTable(T,X) (X) /* No-op pass-through */ 437481f7b372Sdrh #else 4375b9bcf7caSdrh i16 sqlite3TableColumnToStorage(Table*, i16); 4376b9bcf7caSdrh i16 sqlite3StorageColumnToTable(Table*, i16); 437781f7b372Sdrh #endif 4378f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 4379e6110505Sdrh #if SQLITE_ENABLE_HIDDEN_COLUMNS 4380ba68f8f3Sdan void sqlite3ColumnPropertiesFromName(Table*, Column*); 4381e6110505Sdrh #else 4382e6110505Sdrh # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */ 4383e6110505Sdrh #endif 43842881ab62Sdrh void sqlite3AddColumn(Parse*,Token*,Token*); 43854adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int); 4386fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 438792e21ef0Sdrh void sqlite3AddCheckConstraint(Parse*, Expr*, const char*, const char*); 43881be266baSdrh void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*); 438939002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*); 439081f7b372Sdrh void sqlite3AddGenerated(Parse*,Expr*,Token*); 43915969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*); 43922053f313Sdrh void sqlite3AddReturning(Parse*,ExprList*); 4393522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*, 4394522c26fbSdrh sqlite3_vfs**,char**,char **); 4395e5989723Sdrh #define sqlite3CodecQueryParameters(A,B,C) 0 4396421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*); 4397b7f9164eSdrh 4398d12602a9Sdrh #ifdef SQLITE_UNTESTABLE 4399c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK 4400c007f61bSdrh #else 4401c007f61bSdrh int sqlite3FaultSim(int); 4402c007f61bSdrh #endif 4403c007f61bSdrh 4404f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32); 4405f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32); 440682ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32); 4407f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32); 4408e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*); 4409f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*); 4410bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*); 4411d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 44123088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*); 4413f5ed7ad6Sdrh #endif 4414f5e7bb51Sdrh 44159d67afc4Sdrh RowSet *sqlite3RowSetInit(sqlite3*); 44169d67afc4Sdrh void sqlite3RowSetDelete(void*); 44179d67afc4Sdrh void sqlite3RowSetClear(void*); 44183d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64); 4419d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64); 44203d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*); 44213d4501e5Sdrh 44228981b904Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int); 4423fe3fcbe2Sdanielk1977 4424fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 44254adee20fSdanielk1977 int sqlite3ViewGetColumnNames(Parse*,Table*); 4426b7f9164eSdrh #else 4427b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0 4428b7f9164eSdrh #endif 4429b7f9164eSdrh 4430a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30 4431a7ab6d81Sdrh int sqlite3DbMaskAllZero(yDbMask); 4432a7ab6d81Sdrh #endif 4433a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int); 4434faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int); 44351feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*); 4436cf8f2895Sdan void sqlite3FreeIndex(sqlite3*, Index*); 44370b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT 44380b9f50d8Sdrh void sqlite3AutoincrementBegin(Parse *pParse); 44390b9f50d8Sdrh void sqlite3AutoincrementEnd(Parse *pParse); 44400b9f50d8Sdrh #else 44410b9f50d8Sdrh # define sqlite3AutoincrementBegin(X) 44420b9f50d8Sdrh # define sqlite3AutoincrementEnd(X) 44430b9f50d8Sdrh #endif 444446d2e5c3Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int, Upsert*); 4445c1431144Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4446dd6cc9b5Sdrh void sqlite3ComputeGeneratedColumns(Parse*, int, Table*); 4447c1431144Sdrh #endif 44486c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*); 44495496d6a2Sdan IdList *sqlite3IdListAppend(Parse*, IdList*, Token*); 44504adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*); 445129c992cbSdrh SrcList *sqlite3SrcListEnlarge(Parse*, SrcList*, int, int); 445269887c99Sdan SrcList *sqlite3SrcListAppendList(Parse *pParse, SrcList *p1, SrcList *p2); 445329c992cbSdrh SrcList *sqlite3SrcListAppend(Parse*, SrcList*, Token*, Token*); 4454b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 445585574e31Sdanielk1977 Token*, Select*, Expr*, IdList*); 4456b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 445701d230ceSdrh void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*); 44587601294aSdrh int sqlite3IndexedByLookup(Parse *, SrcItem *); 445961dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*); 44604adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 4461633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*); 4462633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*); 4463bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**); 446462340f84Sdrh void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 446562340f84Sdrh Expr*, int, int, u8); 44664d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int); 44677d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*); 446817435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 44698c0833fbSdrh Expr*,ExprList*,u32,Expr*); 4470633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*); 44714adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*); 44724adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int); 4473c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 4474273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 44758c0833fbSdrh Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*); 44764281bd42Sshane #endif 44778c0833fbSdrh void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*); 4478eac9fabbSdrh void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*, 4479eac9fabbSdrh Upsert*); 448046ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int); 44814adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*); 4482c3489bbfSdrh LogEst sqlite3WhereOutputRowCount(WhereInfo*); 44836f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*); 44846f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*); 44856ee5a7b4Sdrh int sqlite3WhereOrderByLimitOptLabel(WhereInfo*); 4486d193057aSdrh void sqlite3WhereMinMaxOptEarlyOut(Vdbe*,WhereInfo*); 4487374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*); 44886f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*); 44896f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*); 4490fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*); 4491b0264eecSdrh #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */ 4492b0264eecSdrh #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */ 4493b0264eecSdrh #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */ 4494be3da241Sdrh int sqlite3WhereUsesDeferredSeek(WhereInfo*); 44951f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int); 4496a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8); 44976df9c4b9Sdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 4498b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int); 449905a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int); 4500e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4501e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(Parse*, Column*, int); 4502e70fa7feSdrh #endif 45031c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse*, Expr*, int); 450405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int); 45059b258c54Sdrh int sqlite3ExprCodeRunJustOnce(Parse*, Expr*, int); 45062dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 4507678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int); 45085579d59fSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8); 4509d1a01edaSdrh #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */ 4510d1a01edaSdrh #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */ 45115579d59fSdrh #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */ 4512257c13faSdan #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */ 45134adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 45144adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 451572bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int); 45169bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*); 45174d249e61Sdrh #define LOCATE_VIEW 0x01 45184d249e61Sdrh #define LOCATE_NOERR 0x02 45194d249e61Sdrh Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*); 45207601294aSdrh Table *sqlite3LocateTableItem(Parse*,u32 flags,SrcItem *); 45219bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 45229bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 45239bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 45242f6239edSdrh void sqlite3Vacuum(Parse*,Token*,Expr*); 45252f6239edSdrh int sqlite3RunVacuum(char**, sqlite3*, int, sqlite3_value*); 452617435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*); 45275aa550cfSdan int sqlite3ExprCompare(Parse*,Expr*, Expr*, int); 4528f9463dfbSdrh int sqlite3ExprCompareSkip(Expr*, Expr*, int); 4529619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int); 45305aa550cfSdan int sqlite3ExprImpliesExpr(Parse*,Expr*, Expr*, int); 45312589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr*,int); 453289636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker*,Parse*); 4533d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 4534d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 45352409f8a1Sdrh int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx); 4536030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*); 45374adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*); 4538d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 45392fa1868fSdrh void sqlite3PrngSaveState(void); 45402fa1868fSdrh void sqlite3PrngRestoreState(void); 4541f5ed7ad6Sdrh #endif 45420f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int); 45434adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int); 454457966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb); 4545684917c2Sdrh void sqlite3BeginTransaction(Parse*, int); 454607a3b11aSdrh void sqlite3EndTransaction(Parse*,int); 4547fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*); 4548fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *); 45494245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*); 45500cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char*); 4551171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr*); 455296acafbeSdrh int sqlite3ExprTruthValue(const Expr*); 45534adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*); 45540a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*); 4555feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8); 4556ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*); 4557059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int); 4558ffc648cfSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS 45595b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr*); 4560ffc648cfSdrh #endif 45614adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*); 4562039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*); 4563039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 45644adee20fSdanielk1977 int sqlite3IsRowid(const char*); 4565f0ee1d3cSdan void sqlite3GenerateRowDelete( 4566f0ee1d3cSdan Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int); 4567f0ee1d3cSdan void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int); 45681c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int); 456987744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int); 4570e9816d82Sdrh int sqlite3ExprReferencesUpdatedColumn(Expr*,int*,int); 4571f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int, 4572788d55aaSdrh u8,u8,int,int*,int*,Upsert*); 4573d447dcedSdrh #ifdef SQLITE_ENABLE_NULL_TRIM 4574585ce192Sdrh void sqlite3SetMakeRecordP5(Vdbe*,Table*); 4575d447dcedSdrh #else 4576d447dcedSdrh # define sqlite3SetMakeRecordP5(A,B) 4577d447dcedSdrh #endif 457826198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int); 4579fd261ec6Sdan int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*); 45804adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int); 4581ff738bceSdrh void sqlite3MultiWrite(Parse*); 4582e0af83acSdan void sqlite3MayAbort(Parse*); 4583f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8); 4584f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*); 4585f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*); 45866ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 45876ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 45886ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 458917435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*); 45906ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int); 459119efd0dbSdrh FuncDef *sqlite3FunctionSearch(int,const char*); 459280738d9cSdrh void sqlite3InsertBuiltinFuncs(FuncDef*,int); 459380738d9cSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8); 459480738d9cSdrh void sqlite3RegisterBuiltinFunctions(void); 4595777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void); 459680738d9cSdrh void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*); 45977e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*); 45987e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*); 45999cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int); 460026d61e5aSdan With *sqlite3WithDup(sqlite3 *db, With *p); 4601fa4e62f3Sshane 4602fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 46038c0833fbSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int); 4604fa4e62f3Sshane #endif 4605b7f9164eSdrh 4606b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER 4607ef2cb63eSdanielk1977 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 460860218d2aSdrh Expr*,int, int); 46094adee20fSdanielk1977 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 4610fdd48a76Sdrh void sqlite3DropTrigger(Parse*, SrcList*, int); 461174161705Sdrh void sqlite3DropTriggerPtr(Parse*, Trigger*); 46122f886d1dSdanielk1977 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 46132f886d1dSdanielk1977 Trigger *sqlite3TriggerList(Parse *, Table *); 4614165921a7Sdan void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 461594d7f50aSdan int, int, int); 46161da40a38Sdan void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 4617dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 4618633e6d57Sdrh void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 4619f259df5fSdrh TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*, 4620f259df5fSdrh const char*,const char*); 46215be60c55Sdan TriggerStep *sqlite3TriggerInsertStep(Parse*,Token*, IdList*, 462246d2e5c3Sdrh Select*,u8,Upsert*, 46232c2e844aSdrh const char*,const char*); 4624e7877b2dSdan TriggerStep *sqlite3TriggerUpdateStep(Parse*,Token*,SrcList*,ExprList*, 4625e7877b2dSdan Expr*, u8, const char*,const char*); 46265be60c55Sdan TriggerStep *sqlite3TriggerDeleteStep(Parse*,Token*, Expr*, 4627f259df5fSdrh const char*,const char*); 4628633e6d57Sdrh void sqlite3DeleteTrigger(sqlite3*, Trigger*); 4629b7f9164eSdrh void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 4630bb5f168fSdan u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 4631e7877b2dSdan SrcList *sqlite3TriggerStepSrc(Parse*, TriggerStep*); 463265a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 4633c149f18fSdrh # define sqlite3IsToplevel(p) ((p)->pToplevel==0) 4634b7f9164eSdrh #else 463562c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0 4636633e6d57Sdrh # define sqlite3DeleteTrigger(A,B) 4637cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B) 4638b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 463994d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 464075cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 46412943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0 464265a7cd16Sdan # define sqlite3ParseToplevel(p) p 4643c149f18fSdrh # define sqlite3IsToplevel(p) 1 4644bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 4645e7877b2dSdan # define sqlite3TriggerStepSrc(A,B) 0 4646b7f9164eSdrh #endif 4647b7f9164eSdrh 46484adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 46496e6d9833Sdan int sqlite3ColumnIndex(Table *pTab, const char *zCol); 46508103a036Sdrh void sqlite3SetJoinExpr(Expr*,int); 46510202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 46524adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int); 4653ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 4654728b5779Sdrh void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 46554adee20fSdanielk1977 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 46564adee20fSdanielk1977 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 46574adee20fSdanielk1977 void sqlite3AuthContextPop(AuthContext*); 465802470b20Sdan int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 4659ed6c8671Sdrh #else 4660b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d) 46614adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 46624adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c) 46634adee20fSdanielk1977 # define sqlite3AuthContextPop(a) ((void)(a)) 4664ed6c8671Sdrh #endif 4665465c2b89Sdan int sqlite3DbIsNamed(sqlite3 *db, int iDb, const char *zName); 4666f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 4667f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*); 4668d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 46694adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*); 46704adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*); 46714adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*); 46724adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 46738a3884efSdrh int sqlite3RealSameAsInt(double,sqlite3_int64); 467482b0f106Sdrh void sqlite3Int64ToText(i64,char*); 46759339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8); 4676fec19aadSdrh int sqlite3GetInt32(const char *, int*); 4677abc38158Sdrh int sqlite3GetUInt32(const char*, u32*); 467860ac3f42Sdrh int sqlite3Atoi(const char*); 4679f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4680ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar); 4681f0f44b79Sdrh #endif 4682ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte); 468342610961Sdrh u32 sqlite3Utf8Read(const u8**); 4684bf539c4dSdrh LogEst sqlite3LogEst(u64); 4685bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst); 4686bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4687bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double); 4688bf539c4dSdrh #endif 468914bfd991Sdrh #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \ 4690175b8f06Sdrh defined(SQLITE_ENABLE_STAT4) || \ 4691d566c951Sdrh defined(SQLITE_EXPLAIN_ESTIMATED_ROWS) 4692bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst); 4693d566c951Sdrh #endif 46949bf755ccSdrh VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int); 46959bf755ccSdrh const char *sqlite3VListNumToName(VList*,int); 46969bf755ccSdrh int sqlite3VListNameToNum(VList*,const char*,int); 46973f8d5cfcSshane 46983f8d5cfcSshane /* 46993f8d5cfcSshane ** Routines to read and write variable-length integers. These used to 47003f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c 47012f2b2b85Sdrh ** file. 47023f8d5cfcSshane */ 4703192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64); 47041bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *); 47051bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *); 4706192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v); 47073f8d5cfcSshane 47083f8d5cfcSshane /* 47092f2b2b85Sdrh ** The common case is for a varint to be a single byte. They following 47102f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call 47112f2b2b85Sdrh ** the procedure for larger varints. 47123f8d5cfcSshane */ 47134bde3702Sdrh #define getVarint32(A,B) \ 47144bde3702Sdrh (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B))) 471502a95eb9Sdrh #define getVarint32NR(A,B) \ 471602a95eb9Sdrh B=(u32)*(A);if(B>=0x80)sqlite3GetVarint32((A),(u32*)&(B)) 47174bde3702Sdrh #define putVarint32(A,B) \ 47184bde3702Sdrh (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\ 47192f2b2b85Sdrh sqlite3PutVarint((A),(B))) 47203f8d5cfcSshane #define getVarint sqlite3GetVarint 47213f8d5cfcSshane #define putVarint sqlite3PutVarint 47223f8d5cfcSshane 47233f8d5cfcSshane 4724e9107698Sdrh const char *sqlite3IndexAffinityStr(sqlite3*, Index*); 472557bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int); 4726e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2); 4727e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity); 47280dfa4f6fSdrh char sqlite3TableColumnAffinity(Table*,int); 4729e7375bfaSdrh char sqlite3ExprAffinity(const Expr *pExpr); 47309339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8); 47319296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*); 473213f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...); 473313f40da3Sdrh void sqlite3Error(sqlite3*,int); 473488efc796Sdrh void sqlite3ErrorClear(sqlite3*); 47351b9f2141Sdrh void sqlite3SystemError(sqlite3*,int); 4736ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 4737cd74b611Sdan u8 sqlite3HexToInt(int h); 4738ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 4739dd08ca0fSmistachkin 47405824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME) 4741f2c1c99fSmistachkin const char *sqlite3ErrName(int); 4742dd08ca0fSmistachkin #endif 4743dd08ca0fSmistachkin 47448d889afcSdrh #ifndef SQLITE_OMIT_DESERIALIZE 4745ac442f41Sdrh int sqlite3MemdbInit(void); 4746ac442f41Sdrh #endif 4747ac442f41Sdrh 4748f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int); 47498a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse); 4750c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 4751efad2e23Sdrh int sqlite3IsBinary(const CollSeq*); 4752c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 475342a630b1Sdrh void sqlite3SetTextEncoding(sqlite3 *db, u8); 4754e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr); 4755e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr); 4756e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse*,const Expr*,const Expr*); 475780103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int); 47580a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*); 47590a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*); 47600d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr*); 47617cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *); 47620f1c2eb5Sdrh int sqlite3WritableSchema(sqlite3*); 4763c5a93d4cSdrh int sqlite3CheckObjectName(Parse*, const char*,const char*,const char*); 47642c718873Sdan void sqlite3VdbeSetChanges(sqlite3 *, i64); 4765158b9cb9Sdrh int sqlite3AddInt64(i64*,i64); 4766158b9cb9Sdrh int sqlite3SubInt64(i64*,i64); 4767158b9cb9Sdrh int sqlite3MulInt64(i64*,i64); 4768d50ffc41Sdrh int sqlite3AbsInt32(int); 476981cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES 477081cc5163Sdrh void sqlite3FileSuffix3(const char*, char*); 477181cc5163Sdrh #else 477281cc5163Sdrh # define sqlite3FileSuffix3(X,Y) 477381cc5163Sdrh #endif 4774eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8); 47754e6af134Sdanielk1977 4776b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8); 4777b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8); 4778b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 47791e536953Sdanielk1977 void(*)(void*)); 4780a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*); 47814e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*); 47820c8f4038Sdrh #ifndef SQLITE_UNTESTABLE 47830c8f4038Sdrh void sqlite3ResultIntReal(sqlite3_context*); 47840c8f4038Sdrh #endif 47851e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *); 4786f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4787b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 4788f0f44b79Sdrh #endif 47891e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 4790b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 479146c99e0fSdrh #ifndef SQLITE_AMALGAMATION 4792a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[]; 4793f19aa5faSdrh extern const char sqlite3StrBINARY[]; 47944e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[]; 47951af3fd56Sdrh extern const unsigned char *sqlite3aLTb; 47961af3fd56Sdrh extern const unsigned char *sqlite3aEQb; 47971af3fd56Sdrh extern const unsigned char *sqlite3aGTb; 479878ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[]; 4799075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 480080738d9cSdrh extern FuncDefHash sqlite3BuiltinFunctions; 4801f83dc1efSdrh #ifndef SQLITE_OMIT_WSD 4802ddb68e17Sdrh extern int sqlite3PendingByte; 480346c99e0fSdrh #endif 48049216de8aSdrh #endif /* SQLITE_AMALGAMATION */ 480535043cc3Sdrh #ifdef VDBE_PROFILE 480635043cc3Sdrh extern sqlite3_uint64 sqlite3NProfileCnt; 480735043cc3Sdrh #endif 4808abc38158Sdrh void sqlite3RootPageMoved(sqlite3*, int, Pgno, Pgno); 48094343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*); 4810545f587fSdrh void sqlite3AlterFunctions(void); 48119fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 4812cf8f2895Sdan void sqlite3AlterRenameColumn(Parse*, SrcList*, Token*, Token*); 48139fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *); 48142958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...); 4815ba968dbfSdrh void sqlite3ExpirePreparedStatements(sqlite3*, int); 481650ef6716Sdrh void sqlite3CodeRhsOfIN(Parse*, Expr*, int); 481785bcdce2Sdrh int sqlite3CodeSubselect(Parse*, Expr*); 48187d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*); 48197601294aSdrh int sqlite3ExpandSubquery(Parse*, SrcItem*); 4820923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p); 4821c4938ea2Sdrh int sqlite3MatchEName( 4822c4938ea2Sdrh const struct ExprList_item*, 4823c4938ea2Sdrh const char*, 4824c4938ea2Sdrh const char*, 4825c4938ea2Sdrh const char* 4826c4938ea2Sdrh ); 482774a07986Sdrh Bitmask sqlite3ExprColUsed(Expr*); 4828d44390c8Sdrh u8 sqlite3StrIHash(const char*); 48297d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*); 483001d230ceSdrh int sqlite3ResolveExprListNames(NameContext*, ExprList*); 48317d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 4832ee751fabSdrh int sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*); 48337d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 4834c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 483519a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *); 483619a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 48376e6d9833Sdan void sqlite3AlterDropColumn(Parse*, SrcList*, Token*); 483807e95233Sdan void *sqlite3RenameTokenMap(Parse*, void*, Token*); 483907e95233Sdan void sqlite3RenameTokenRemap(Parse*, void *pTo, void *pFrom); 48408900a48bSdan void sqlite3RenameExprUnmap(Parse*, Expr*); 4841e8ab40d2Sdan void sqlite3RenameExprlistUnmap(Parse*, ExprList*); 484279e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*); 48432e3a5a81Sdan char sqlite3AffinityType(const char*, Column*); 48449f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*); 4845783e159eSdrh int sqlite3InvokeBusyHandler(BusyHandler*); 4846ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*); 48470410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *); 4848cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB); 4849d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*); 485051147baaSdrh void sqlite3DefaultRowEst(Index*); 485155ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int); 4852d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 4853b6ee6607Sdrh void sqlite3SchemaClear(void *); 48541e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 4855e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 4856ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int); 48572ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*); 48582ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*); 48592ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*); 4860f9eae18bSdan KeyInfo *sqlite3KeyInfoFromExprList(Parse*, ExprList*, int, int); 4861aae0f74eSdrh const char *sqlite3SelectOpName(int); 48629105fd51Sdan int sqlite3HasExplicitNulls(Parse*, ExprList*); 4863f9eae18bSdan 48642ec2fb22Sdrh #ifdef SQLITE_DEBUG 48652ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*); 48662ec2fb22Sdrh #endif 4867771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 4868771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), 4869660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4870660af939Sdan void (*)(sqlite3_context*), 4871660af939Sdan void (*)(sqlite3_context*), 4872660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4873d2199f0fSdan FuncDestructor *pDestructor 4874d2199f0fSdan ); 487592011847Sdrh void sqlite3NoopDestructor(void*); 48764a642b60Sdrh void sqlite3OomFault(sqlite3*); 48774a642b60Sdrh void sqlite3OomClear(sqlite3*); 487854f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int); 4879ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *); 488069dab1d3Sdrh 4881c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int); 4882ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*); 48831013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int); 4884f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 48851e536953Sdanielk1977 48860410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *); 48870410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 48880410302eSdanielk1977 4889f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY 4890f9b2e05cSdan int sqlite3ExprCheckIN(Parse*, Expr*); 4891f9b2e05cSdan #else 4892f9b2e05cSdan # define sqlite3ExprCheckIN(x,y) SQLITE_OK 4893f9b2e05cSdan #endif 4894f9b2e05cSdan 4895175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 4896d66e5794Sdan int sqlite3Stat4ProbeSetValue( 4897d66e5794Sdan Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*); 4898b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**); 48997a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*); 4900b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**); 4901d66e5794Sdan char sqlite3IndexColumnAffinity(sqlite3*, Index*, int); 49029fecc546Sdrh #endif 49037a419235Sdan 490495bdbbbdSdrh /* 490595bdbbbdSdrh ** The interface to the LEMON-generated parser 490695bdbbbdSdrh */ 4907d26cc541Sdrh #ifndef SQLITE_AMALGAMATION 4908fb32c44eSdrh void *sqlite3ParserAlloc(void*(*)(u64), Parse*); 490995bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*)); 4910d26cc541Sdrh #endif 4911fb32c44eSdrh void sqlite3Parser(void*, int, Token); 491259ff4251Sdan int sqlite3ParserFallback(int); 4913ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH 4914ec424a5bSdrh int sqlite3ParserStackPeak(void*); 4915ec424a5bSdrh #endif 491695bdbbbdSdrh 49177aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*); 491869dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION 4919f1952c5dSdrh void sqlite3CloseExtensions(sqlite3*); 492069dab1d3Sdrh #else 492169dab1d3Sdrh # define sqlite3CloseExtensions(X) 492269dab1d3Sdrh #endif 4923e3026636Sdanielk1977 4924c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 4925abc38158Sdrh void sqlite3TableLock(Parse *, int, Pgno, u8, const char *); 4926c00da105Sdanielk1977 #else 4927c00da105Sdanielk1977 #define sqlite3TableLock(v,w,x,y,z) 4928c00da105Sdanielk1977 #endif 4929c00da105Sdanielk1977 493053c14021Sdrh #ifdef SQLITE_TEST 493153c14021Sdrh int sqlite3Utf8To8(unsigned char*); 493253c14021Sdrh #endif 493353c14021Sdrh 4934b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE 4935595a523aSdanielk1977 # define sqlite3VtabClear(Y) 49369dbee7dcSdanielk1977 # define sqlite3VtabSync(X,Y) SQLITE_OK 4937f9e7dda7Sdanielk1977 # define sqlite3VtabRollback(X) 4938f9e7dda7Sdanielk1977 # define sqlite3VtabCommit(X) 4939093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) 0 4940595a523aSdanielk1977 # define sqlite3VtabLock(X) 4941595a523aSdanielk1977 # define sqlite3VtabUnlock(X) 4942cc5979dbSdrh # define sqlite3VtabModuleUnref(D,X) 4943595a523aSdanielk1977 # define sqlite3VtabUnlockList(X) 4944a311b803Sdan # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK 4945c3c8dac7Sdrh # define sqlite3GetVTable(X,Y) ((VTable*)0) 4946b9bb7c18Sdrh #else 49471feeaed2Sdan void sqlite3VtabClear(sqlite3 *db, Table*); 4948bba02a95Sdan void sqlite3VtabDisconnect(sqlite3 *db, Table *p); 4949016f7811Sdan int sqlite3VtabSync(sqlite3 *db, Vdbe*); 4950f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db); 4951f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db); 4952595a523aSdanielk1977 void sqlite3VtabLock(VTable *); 4953595a523aSdanielk1977 void sqlite3VtabUnlock(VTable *); 4954cc5979dbSdrh void sqlite3VtabModuleUnref(sqlite3*,Module*); 4955595a523aSdanielk1977 void sqlite3VtabUnlockList(sqlite3*); 4956a311b803Sdan int sqlite3VtabSavepoint(sqlite3 *, int, int); 4957016f7811Sdan void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*); 4958c3c8dac7Sdrh VTable *sqlite3GetVTable(sqlite3*, Table*); 49592fcc1590Sdrh Module *sqlite3VtabCreateModule( 49602fcc1590Sdrh sqlite3*, 49612fcc1590Sdrh const char*, 49622fcc1590Sdrh const sqlite3_module*, 49632fcc1590Sdrh void*, 49642fcc1590Sdrh void(*)(void*) 49652fcc1590Sdrh ); 4966093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 4967b9bb7c18Sdrh #endif 4968070ae3beSdrh int sqlite3ReadOnlyShadowTables(sqlite3 *db); 4969527cbd4aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4970527cbd4aSdrh int sqlite3ShadowTableName(sqlite3 *db, const char *zName); 49713d863b5eSdrh int sqlite3IsShadowTableOf(sqlite3*,Table*,const char*); 4972527cbd4aSdrh #else 4973527cbd4aSdrh # define sqlite3ShadowTableName(A,B) 0 49743d863b5eSdrh # define sqlite3IsShadowTableOf(A,B,C) 0 4975527cbd4aSdrh #endif 497651be3873Sdrh int sqlite3VtabEponymousTableInit(Parse*,Module*); 497751be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3*,Module*); 49784f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*); 4979b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int); 4980b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*); 4981b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*); 4982b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*); 498378efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 49847e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*); 49859e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 4986595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *); 49871e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 498895a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*); 49895f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 49904a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 4991f30a969bSdrh void sqlite3ParserReset(Parse*); 4992a79e2a2dSdrh void *sqlite3ParserAddCleanup(Parse*,void(*)(sqlite3*,void*),void*); 49938bee11a4Smistachkin #ifdef SQLITE_ENABLE_NORMALIZE 49941a6c2b1dSdrh char *sqlite3Normalize(Vdbe*, const char*); 49958bee11a4Smistachkin #endif 4996b900aaf3Sdrh int sqlite3Reprepare(Vdbe*); 4997b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 4998e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse*,const Expr*); 4999e7375bfaSdrh CollSeq *sqlite3BinaryCompareCollSeq(Parse *, const Expr*, const Expr*); 50001c514148Sdrh int sqlite3TempInMemory(const sqlite3*); 500128e5386fSdan const char *sqlite3JournalModename(int); 500206a2d825Sdan #ifndef SQLITE_OMIT_WAL 5003cdc1f049Sdan int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 5004b033d8b9Sdrh int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 500506a2d825Sdan #endif 50068b471863Sdrh #ifndef SQLITE_OMIT_CTE 5007745912efSdrh Cte *sqlite3CteNew(Parse*,Token*,ExprList*,Select*,u8); 5008f824b41eSdrh void sqlite3CteDelete(sqlite3*,Cte*); 5009f824b41eSdrh With *sqlite3WithAdd(Parse*,With*,Cte*); 50107d562dbeSdan void sqlite3WithDelete(sqlite3*,With*); 501124ce9446Sdrh With *sqlite3WithPush(Parse*, With*, u8); 50124e9119d9Sdan #else 5013f824b41eSdrh # define sqlite3CteNew(P,T,E,S) ((void*)0) 5014f824b41eSdrh # define sqlite3CteDelete(D,C) 5015f824b41eSdrh # define sqlite3CteWithAdd(P,W,C) ((void*)0) 5016eede6a53Sdan # define sqlite3WithDelete(x,y) 5017f824b41eSdrh # define sqlite3WithPush(x,y,z) 50188b471863Sdrh #endif 501946d2e5c3Sdrh #ifndef SQLITE_OMIT_UPSERT 50202549e4ccSdrh Upsert *sqlite3UpsertNew(sqlite3*,ExprList*,Expr*,ExprList*,Expr*,Upsert*); 502146d2e5c3Sdrh void sqlite3UpsertDelete(sqlite3*,Upsert*); 502246d2e5c3Sdrh Upsert *sqlite3UpsertDup(sqlite3*,Upsert*); 5023e9c2e772Sdrh int sqlite3UpsertAnalyzeTarget(Parse*,SrcList*,Upsert*); 50242cc00423Sdan void sqlite3UpsertDoUpdate(Parse*,Upsert*,Table*,Index*,int); 502561e280adSdrh Upsert *sqlite3UpsertOfIndex(Upsert*,Index*); 502661e280adSdrh int sqlite3UpsertNextIsIPK(Upsert*); 502746d2e5c3Sdrh #else 50282549e4ccSdrh #define sqlite3UpsertNew(u,v,w,x,y,z) ((Upsert*)0) 502946d2e5c3Sdrh #define sqlite3UpsertDelete(x,y) 503046d2e5c3Sdrh #define sqlite3UpsertDup(x,y) ((Upsert*)0) 503161e280adSdrh #define sqlite3UpsertOfIndex(x,y) ((Upsert*)0) 503261e280adSdrh #define sqlite3UpsertNextIsIPK(x) 0 503346d2e5c3Sdrh #endif 503446d2e5c3Sdrh 5035d829335eSdanielk1977 503675cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by 503775cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 503875cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but 503975cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 504075cbd984Sdan ** this case foreign keys are parsed, but no other functionality is 504175cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system). 504275cbd984Sdan */ 504375cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 50448ff2d956Sdan void sqlite3FkCheck(Parse*, Table*, int, int, int*, int); 5045d66c8309Sdan void sqlite3FkDropTable(Parse*, SrcList *, Table*); 50468ff2d956Sdan void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int); 5047e7a94d81Sdan int sqlite3FkRequired(Parse*, Table*, int*, int); 5048e7a94d81Sdan u32 sqlite3FkOldmask(Parse*, Table*); 5049432cc5b9Sdan FKey *sqlite3FkReferences(Table *); 50501da40a38Sdan #else 50518ff2d956Sdan #define sqlite3FkActions(a,b,c,d,e,f) 505267896cefSdan #define sqlite3FkCheck(a,b,c,d,e,f) 5053d66c8309Sdan #define sqlite3FkDropTable(a,b,c) 5054e7a94d81Sdan #define sqlite3FkOldmask(a,b) 0 505567896cefSdan #define sqlite3FkRequired(a,b,c,d) 0 5056e7eeeb99Sdan #define sqlite3FkReferences(a) 0 50571da40a38Sdan #endif 505875cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY 50591feeaed2Sdan void sqlite3FkDelete(sqlite3 *, Table*); 50606c5b915fSdrh int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**); 506175cbd984Sdan #else 50621feeaed2Sdan #define sqlite3FkDelete(a,b) 50636c5b915fSdrh #define sqlite3FkLocateIndex(a,b,c,d,e) 506475cbd984Sdan #endif 506575cbd984Sdan 5066643167ffSdrh 5067643167ffSdrh /* 5068643167ffSdrh ** Available fault injectors. Should be numbered beginning with 0. 5069643167ffSdrh */ 5070643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC 0 50717e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT 1 5072643167ffSdrh 5073643167ffSdrh /* 5074ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign" 5075d12602a9Sdrh ** malloc failures. This is only present if SQLITE_UNTESTABLE 5076ef05f2dfSdanielk1977 ** is not defined. 5077643167ffSdrh */ 5078d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 50792d1d86fbSdanielk1977 void sqlite3BeginBenignMalloc(void); 50802d1d86fbSdanielk1977 void sqlite3EndBenignMalloc(void); 5081643167ffSdrh #else 50822d1d86fbSdanielk1977 #define sqlite3BeginBenignMalloc() 5083867d05a0Sdanielk1977 #define sqlite3EndBenignMalloc() 5084643167ffSdrh #endif 5085643167ffSdrh 50863a85625dSdrh /* 50873a85625dSdrh ** Allowed return values from sqlite3FindInIndex() 50883a85625dSdrh */ 50893a85625dSdrh #define IN_INDEX_ROWID 1 /* Search the rowid of the table */ 50903a85625dSdrh #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */ 50913a85625dSdrh #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */ 50923a85625dSdrh #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */ 5093bb53ecb1Sdrh #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */ 50943a85625dSdrh /* 50953a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex(). 50963a85625dSdrh */ 5097bb53ecb1Sdrh #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */ 5098bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */ 5099bb53ecb1Sdrh #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */ 51002c04131cSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*, int*); 51019a96b668Sdanielk1977 5102c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 5103c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *); 5104d67a9770Sdan #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \ 5105d67a9770Sdan || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 5106f55b8998Sdanielk1977 int sqlite3JournalCreate(sqlite3_file *); 5107c7b6017cSdanielk1977 #endif 5108c7b6017cSdanielk1977 51092491de28Sdan int sqlite3JournalIsInMemory(sqlite3_file *p); 5110b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *); 5111b3175389Sdanielk1977 51122308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p); 51130224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 5114fc976065Sdanielk1977 int sqlite3SelectExprHeight(Select *); 51157d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse*, int); 5116fc976065Sdanielk1977 #else 51170224d26dSdrh #define sqlite3SelectExprHeight(x) 0 51187d10d5a6Sdrh #define sqlite3ExprCheckHeight(x,y) 5119fc976065Sdanielk1977 #endif 5120fc976065Sdanielk1977 5121a3152895Sdrh u32 sqlite3Get4byte(const u8*); 5122a3152895Sdrh void sqlite3Put4byte(u8*, u32); 5123a3152895Sdrh 5124404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 5125404ca075Sdanielk1977 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 5126404ca075Sdanielk1977 void sqlite3ConnectionUnlocked(sqlite3 *db); 5127404ca075Sdanielk1977 void sqlite3ConnectionClosed(sqlite3 *db); 5128404ca075Sdanielk1977 #else 5129404ca075Sdanielk1977 #define sqlite3ConnectionBlocked(x,y) 5130404ca075Sdanielk1977 #define sqlite3ConnectionUnlocked(x) 5131404ca075Sdanielk1977 #define sqlite3ConnectionClosed(x) 5132404ca075Sdanielk1977 #endif 5133404ca075Sdanielk1977 51346e736838Sdrh #ifdef SQLITE_DEBUG 51356e736838Sdrh void sqlite3ParserTrace(FILE*, char *); 51366e736838Sdrh #endif 51370d9de99cSdrh #if defined(YYCOVERAGE) 51380d9de99cSdrh int sqlite3ParserCoverage(FILE*); 51390d9de99cSdrh #endif 51406e736838Sdrh 5141b0603416Sdrh /* 5142b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable 51433a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to 5144b0603416Sdrh ** print I/O tracing messages. 5145b0603416Sdrh */ 5146b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE 51473a00f907Smlcreech # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 5148b4622b60Sdanielk1977 void sqlite3VdbeIOTraceSql(Vdbe*); 51499871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...); 5150b0603416Sdrh #else 5151b0603416Sdrh # define IOTRACE(A) 5152b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X) 5153b0603416Sdrh #endif 5154b0603416Sdrh 5155107b56e8Sdrh /* 5156107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator 5157107b56e8Sdrh ** only. They are used to verify that different "types" of memory 5158107b56e8Sdrh ** allocations are properly tracked by the system. 5159107b56e8Sdrh ** 5160107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 5161107b56e8Sdrh ** the MEMTYPE_* macros defined below. The type must be a bitmask with 5162107b56e8Sdrh ** a single bit set. 5163107b56e8Sdrh ** 5164107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second 5165107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5166107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 5167107b56e8Sdrh ** 5168174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second 5169174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5170107b56e8Sdrh ** 5171107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP 5172174b9a16Sdrh ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 5173174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was 5174174b9a16Sdrh ** too large or lookaside was already full. It is important to verify 5175174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not 5176174b9a16Sdrh ** passed back to non-lookaside free() routines. Asserts such as the 5177174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify 5178174b9a16Sdrh ** this constraint. 5179107b56e8Sdrh ** 5180107b56e8Sdrh ** All of this is no-op for a production build. It only comes into 5181107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used. 5182107b56e8Sdrh */ 5183107b56e8Sdrh #ifdef SQLITE_MEMDEBUG 5184107b56e8Sdrh void sqlite3MemdebugSetType(void*,u8); 5185107b56e8Sdrh int sqlite3MemdebugHasType(void*,u8); 5186174b9a16Sdrh int sqlite3MemdebugNoType(void*,u8); 5187107b56e8Sdrh #else 5188107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y) /* no-op */ 5189107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y) 1 5190174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y) 1 5191e3026636Sdanielk1977 #endif 5192107b56e8Sdrh #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 5193d231aa3aSdrh #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */ 5194b2a0f75cSdrh #define MEMTYPE_PCACHE 0x04 /* Page cache allocations */ 5195107b56e8Sdrh 5196f51446a3Sdrh /* 5197f51446a3Sdrh ** Threading interface 5198f51446a3Sdrh */ 5199bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0 5200f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*); 5201f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**); 5202bf20a35dSdrh #endif 5203f51446a3Sdrh 5204a43c8c8aSdrh #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST) 5205a43c8c8aSdrh int sqlite3DbpageRegister(sqlite3*); 5206a43c8c8aSdrh #endif 52073e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST) 52083e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*); 52093e0327d5Sdrh #endif 5210107b56e8Sdrh 521171c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr); 5212625015e0Sdan int sqlite3ExprIsVector(Expr *pExpr); 5213fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr*, int); 521410f08270Sdrh Expr *sqlite3ExprForVectorField(Parse*,Expr*,int,int); 521544c5604cSdan void sqlite3VectorErrorMsg(Parse*, Expr*); 521671c57db0Sdan 52178999798eSdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 5218da1f49b8Sdan const char **sqlite3CompileOptions(int *pnOpt); 52198999798eSdrh #endif 5220da1f49b8Sdan 522143f58d6aSdrh #endif /* SQLITEINT_H */ 5222