175897234Sdrh /* 2b19a2bc6Sdrh ** 2001 September 15 375897234Sdrh ** 4b19a2bc6Sdrh ** The author disclaims copyright to this source code. In place of 5b19a2bc6Sdrh ** a legal notice, here is a blessing: 675897234Sdrh ** 7b19a2bc6Sdrh ** May you do good and not evil. 8b19a2bc6Sdrh ** May you find forgiveness for yourself and forgive others. 9b19a2bc6Sdrh ** May you share freely, never taking more than you give. 1075897234Sdrh ** 1175897234Sdrh ************************************************************************* 1275897234Sdrh ** Internal interface definitions for SQLite. 1375897234Sdrh ** 1475897234Sdrh */ 1543f58d6aSdrh #ifndef SQLITEINT_H 1643f58d6aSdrh #define SQLITEINT_H 1771674ce9Sdrh 18396794f0Sdrh /* Special Comments: 19396794f0Sdrh ** 20396794f0Sdrh ** Some comments have special meaning to the tools that measure test 21396794f0Sdrh ** coverage: 22396794f0Sdrh ** 23396794f0Sdrh ** NO_TEST - The branches on this line are not 24396794f0Sdrh ** measured by branch coverage. This is 25396794f0Sdrh ** used on lines of code that actually 26396794f0Sdrh ** implement parts of coverage testing. 27396794f0Sdrh ** 28396794f0Sdrh ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false 29396794f0Sdrh ** and the correct answer is still obtained, 30396794f0Sdrh ** though perhaps more slowly. 31396794f0Sdrh ** 32396794f0Sdrh ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true 33396794f0Sdrh ** and the correct answer is still obtained, 34396794f0Sdrh ** though perhaps more slowly. 35396794f0Sdrh ** 36396794f0Sdrh ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread 37396794f0Sdrh ** that would be harmless and undetectable 38396794f0Sdrh ** if it did occur. 39396794f0Sdrh ** 40396794f0Sdrh ** In all cases, the special comment must be enclosed in the usual 41396794f0Sdrh ** slash-asterisk...asterisk-slash comment marks, with no spaces between the 42396794f0Sdrh ** asterisks and the comment text. 43396794f0Sdrh */ 44396794f0Sdrh 45bd0ae111Smlcreech /* 467617e4a8Smistachkin ** Make sure the Tcl calling convention macro is defined. This macro is 477617e4a8Smistachkin ** only used by test code and Tcl integration code. 487617e4a8Smistachkin */ 497617e4a8Smistachkin #ifndef SQLITE_TCLAPI 507617e4a8Smistachkin # define SQLITE_TCLAPI 517617e4a8Smistachkin #endif 5271674ce9Sdrh 53bd0ae111Smlcreech /* 542318d338Smistachkin ** Include the header file used to customize the compiler options for MSVC. 552318d338Smistachkin ** This should be done first so that it can successfully prevent spurious 562318d338Smistachkin ** compiler warnings due to subsequent content in this file and other files 572318d338Smistachkin ** that are included by this file. 582318d338Smistachkin */ 592318d338Smistachkin #include "msvc.h" 602318d338Smistachkin 612318d338Smistachkin /* 628cd5b254Sdrh ** Special setup for VxWorks 638cd5b254Sdrh */ 648cd5b254Sdrh #include "vxworks.h" 658cd5b254Sdrh 668cd5b254Sdrh /* 672210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the 682210dcc6Sdrh ** underlying operating system supports it. If the OS lacks 692210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops. 702210dcc6Sdrh ** 712210dcc6Sdrh ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any 722210dcc6Sdrh ** system #includes. Hence, this block of code must be the very first 732210dcc6Sdrh ** code in all source files. 742210dcc6Sdrh ** 752210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch 762210dcc6Sdrh ** on the compiler command line. This is necessary if you are compiling 772210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work 782210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2 792210dcc6Sdrh ** without this option, LFS is enable. But LFS does not exist in the kernel 802210dcc6Sdrh ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary 812210dcc6Sdrh ** portability you should omit LFS. 822210dcc6Sdrh ** 83dddf6978Sdrh ** The previous paragraph was written in 2005. (This paragraph is written 84dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so 85dddf6978Sdrh ** you should probably leave LFS enabled. But some embedded platforms might 86dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful. 87dddf6978Sdrh ** 882210dcc6Sdrh ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later. 892210dcc6Sdrh */ 902210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS 912210dcc6Sdrh # define _LARGE_FILE 1 922210dcc6Sdrh # ifndef _FILE_OFFSET_BITS 932210dcc6Sdrh # define _FILE_OFFSET_BITS 64 942210dcc6Sdrh # endif 952210dcc6Sdrh # define _LARGEFILE_SOURCE 1 962210dcc6Sdrh #endif 972210dcc6Sdrh 98dc5ece86Sdrh /* The GCC_VERSION and MSVC_VERSION macros are used to 99a39284bfSdrh ** conditionally include optimizations for each of these compilers. A 100a39284bfSdrh ** value of 0 means that compiler is not being used. The 101a39284bfSdrh ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific 102a39284bfSdrh ** optimizations, and hence set all compiler macros to 0 103dc5ece86Sdrh ** 104dc5ece86Sdrh ** There was once also a CLANG_VERSION macro. However, we learn that the 105dc5ece86Sdrh ** version numbers in clang are for "marketing" only and are inconsistent 106dc5ece86Sdrh ** and unreliable. Fortunately, all versions of clang also recognize the 107dc5ece86Sdrh ** gcc version numbers and have reasonable settings for gcc version numbers, 108dc5ece86Sdrh ** so the GCC_VERSION macro will be set to a correct non-zero value even 109dc5ece86Sdrh ** when compiling with clang. 110a39284bfSdrh */ 111a39284bfSdrh #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC) 112ad265296Sdrh # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__) 113ad265296Sdrh #else 114ad265296Sdrh # define GCC_VERSION 0 115ad265296Sdrh #endif 116a39284bfSdrh #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC) 117a39284bfSdrh # define MSVC_VERSION _MSC_VER 118a39284bfSdrh #else 119a39284bfSdrh # define MSVC_VERSION 0 120a39284bfSdrh #endif 121ad265296Sdrh 122d97a4c00Smistachkin /* 123d97a4c00Smistachkin ** Some C99 functions in "math.h" are only present for MSVC when its version 124d97a4c00Smistachkin ** is associated with Visual Studio 2013 or higher. 125d97a4c00Smistachkin */ 126d97a4c00Smistachkin #ifndef SQLITE_HAVE_C99_MATH_FUNCS 127d97a4c00Smistachkin # if MSVC_VERSION==0 || MSVC_VERSION>=1800 128d97a4c00Smistachkin # define SQLITE_HAVE_C99_MATH_FUNCS (1) 129d97a4c00Smistachkin # else 130d97a4c00Smistachkin # define SQLITE_HAVE_C99_MATH_FUNCS (0) 131d97a4c00Smistachkin # endif 132d97a4c00Smistachkin #endif 133d97a4c00Smistachkin 13433ac4c8bSmistachkin /* Needed for various definitions... */ 13533ac4c8bSmistachkin #if defined(__GNUC__) && !defined(_GNU_SOURCE) 13633ac4c8bSmistachkin # define _GNU_SOURCE 13733ac4c8bSmistachkin #endif 13833ac4c8bSmistachkin 13933ac4c8bSmistachkin #if defined(__OpenBSD__) && !defined(_BSD_SOURCE) 14033ac4c8bSmistachkin # define _BSD_SOURCE 14133ac4c8bSmistachkin #endif 14233ac4c8bSmistachkin 1432210dcc6Sdrh /* 14408b92086Sdrh ** Macro to disable warnings about missing "break" at the end of a "case". 14508b92086Sdrh */ 14608b92086Sdrh #if GCC_VERSION>=7000000 14708b92086Sdrh # define deliberate_fall_through __attribute__((fallthrough)); 14808b92086Sdrh #else 14908b92086Sdrh # define deliberate_fall_through 15008b92086Sdrh #endif 15108b92086Sdrh 15208b92086Sdrh /* 153a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its 154a7b3b635Smistachkin ** version information, among other things. Normally, this internal MinGW 155a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header 156a7b3b635Smistachkin ** files; however, the contained version information is now required by this 157a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and 158a7b3b635Smistachkin ** this is the only known way to reliably obtain it. This entire #if block 159a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting 160a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define 161a7b3b635Smistachkin ** some MinGW-specific macros). When compiling for MinGW, either the 162a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be 163a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be 164a7b3b635Smistachkin ** disabled. 165a7b3b635Smistachkin */ 166a7b3b635Smistachkin #if defined(_HAVE_MINGW_H) 167a7b3b635Smistachkin # include "mingw.h" 168a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H) 169a7b3b635Smistachkin # include "_mingw.h" 170a7b3b635Smistachkin #endif 171a7b3b635Smistachkin 172a7b3b635Smistachkin /* 173a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T 174a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime 175a7b3b635Smistachkin ** library in use (e.g. for Windows XP). 176a7b3b635Smistachkin */ 177a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \ 178a7b3b635Smistachkin defined(_WIN32) && !defined(_WIN64) && \ 17965acf373Smistachkin defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \ 180a7b3b635Smistachkin defined(__MSVCRT__) 181a7b3b635Smistachkin # define _USE_32BIT_TIME_T 182a7b3b635Smistachkin #endif 183a7b3b635Smistachkin 1845e990beaSdrh /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear 1850d71d121Smistachkin ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for 1860d71d121Smistachkin ** MinGW. 1875e990beaSdrh */ 1885e990beaSdrh #include "sqlite3.h" 1895e990beaSdrh 190bd0ae111Smlcreech /* 1911e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the 1921e12d43bSmlcreech ** autoconf-based build 193bd0ae111Smlcreech */ 1947f2d1cd2Sdrh #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H) 19598dc4b1aSmlcreech #include "config.h" 1967f2d1cd2Sdrh #define SQLITECONFIG_H 1 1971e12d43bSmlcreech #endif 1981e12d43bSmlcreech 199bb4957f8Sdrh #include "sqliteLimit.h" 20098dc4b1aSmlcreech 201e2965827Sdrh /* Disable nuisance warnings on Borland compilers */ 202e2965827Sdrh #if defined(__BORLANDC__) 203e2965827Sdrh #pragma warn -rch /* unreachable code */ 204e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */ 205e2965827Sdrh #pragma warn -aus /* Assigned value is never used */ 206e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */ 207467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */ 208e2965827Sdrh #endif 209e2965827Sdrh 21098dc4b1aSmlcreech /* 211892edb69Sdan ** WAL mode depends on atomic aligned 32-bit loads and stores in a few 212892edb69Sdan ** places. The following macros try to make this explicit. 213892edb69Sdan */ 214b5538941Sdan #ifndef __has_extension 215b5538941Sdan # define __has_extension(x) 0 /* compatibility with non-clang compilers */ 216892edb69Sdan #endif 2174ee492f1Sdrh #if GCC_VERSION>=4007000 || \ 2184ee492f1Sdrh (__has_extension(c_atomic) && __has_extension(c_atomic_store_n)) 219892edb69Sdan # define AtomicLoad(PTR) __atomic_load_n((PTR),__ATOMIC_RELAXED) 220892edb69Sdan # define AtomicStore(PTR,VAL) __atomic_store_n((PTR),(VAL),__ATOMIC_RELAXED) 221892edb69Sdan #else 222892edb69Sdan # define AtomicLoad(PTR) (*(PTR)) 223892edb69Sdan # define AtomicStore(PTR,VAL) (*(PTR) = (VAL)) 224892edb69Sdan #endif 225892edb69Sdan 226892edb69Sdan /* 22706af763eSdrh ** Include standard header files as necessary 22806af763eSdrh */ 22906af763eSdrh #ifdef HAVE_STDINT_H 23006af763eSdrh #include <stdint.h> 23106af763eSdrh #endif 23206af763eSdrh #ifdef HAVE_INTTYPES_H 23306af763eSdrh #include <inttypes.h> 23406af763eSdrh #endif 23506af763eSdrh 236a2460e07Sdrh /* 237c05a9a8aSdrh ** The following macros are used to cast pointers to integers and 238c05a9a8aSdrh ** integers to pointers. The way you do this varies from one compiler 239c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements 240c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers. 241875e9e7dSdrh ** 242c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type. 243c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or 244c05a9a8aSdrh ** if it is available, it requires an #include of specific headers 245c92271c5Sdrh ** that vary from one machine to the next. 246875e9e7dSdrh ** 247875e9e7dSdrh ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on 248875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)). 2495e49edcaSdrh ** So we have to define the macros in different ways depending on the 250875e9e7dSdrh ** compiler. 2511fc4129dSshane */ 2524509ffa3Sdrh #if defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */ 2534509ffa3Sdrh # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X)) 2544509ffa3Sdrh # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X)) 2554509ffa3Sdrh #elif defined(__PTRDIFF_TYPE__) /* This case should work for GCC */ 256c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X)) 257c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X)) 258c05a9a8aSdrh #elif !defined(__GNUC__) /* Works for compilers other than LLVM */ 259c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) 260c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0)) 261c05a9a8aSdrh #else /* Generates a warning - but it always works */ 262875e9e7dSdrh # define SQLITE_INT_TO_PTR(X) ((void*)(X)) 263875e9e7dSdrh # define SQLITE_PTR_TO_INT(X) ((int)(X)) 264367882c2Sdrh #endif 26571674ce9Sdrh 266e5e7a901Sdrh /* 26714a924a5Sdrh ** A macro to hint to the compiler that a function should not be 26814a924a5Sdrh ** inlined. 26914a924a5Sdrh */ 27014a924a5Sdrh #if defined(__GNUC__) 27114a924a5Sdrh # define SQLITE_NOINLINE __attribute__((noinline)) 272ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310 27314a924a5Sdrh # define SQLITE_NOINLINE __declspec(noinline) 27414a924a5Sdrh #else 27514a924a5Sdrh # define SQLITE_NOINLINE 27614a924a5Sdrh #endif 27714a924a5Sdrh 27814a924a5Sdrh /* 279647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when 28060e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by 28160e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define. 282647ca46fSmistachkin */ 28360e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC) 28411f69b87Smistachkin # if defined(_MSC_VER) && _MSC_VER>=1400 2859895f735Smistachkin # if !defined(_WIN32_WCE) 286647ca46fSmistachkin # include <intrin.h> 287647ca46fSmistachkin # pragma intrinsic(_byteswap_ushort) 288647ca46fSmistachkin # pragma intrinsic(_byteswap_ulong) 289a39284bfSdrh # pragma intrinsic(_byteswap_uint64) 2908d9837acSmistachkin # pragma intrinsic(_ReadWriteBarrier) 2919895f735Smistachkin # else 2929895f735Smistachkin # include <cmnintrin.h> 2939895f735Smistachkin # endif 294647ca46fSmistachkin # endif 29560e08078Smistachkin #endif 296647ca46fSmistachkin 297647ca46fSmistachkin /* 29838c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2. 29938c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never 30038c67c36Sdrh ** threadsafe. 1 means the library is serialized which is the highest 301f7b5496eSdrh ** level of threadsafety. 2 means the library is multithreaded - multiple 30238c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same 30338c67c36Sdrh ** database connection at the same time. 30438c67c36Sdrh ** 305e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro. 30638c67c36Sdrh ** We support that for legacy. 307814aad61Sdan ** 308814aad61Sdan ** To ensure that the correct value of "THREADSAFE" is reported when querying 309814aad61Sdan ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this 310814aad61Sdan ** logic is partially replicated in ctime.c. If it is updated here, it should 311814aad61Sdan ** also be updated there. 312e5e7a901Sdrh */ 313e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE) 314e5e7a901Sdrh # if defined(THREADSAFE) 315e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE 316e5e7a901Sdrh # else 31738c67c36Sdrh # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */ 318e5e7a901Sdrh # endif 319e5e7a901Sdrh #endif 320e5e7a901Sdrh 32167080617Sdrh /* 322cb15f35fSdrh ** Powersafe overwrite is on by default. But can be turned off using 323cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option. 324cb15f35fSdrh */ 325cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE 326cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1 327cb15f35fSdrh #endif 328cb15f35fSdrh 329cb15f35fSdrh /* 330d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by 331d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in 332d1dcb234Sdrh ** which case memory allocation statistics are disabled by default. 3330a732f59Sdanielk1977 */ 3340a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS) 3350a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1 3360a732f59Sdanielk1977 #endif 3370a732f59Sdanielk1977 3380a732f59Sdanielk1977 /* 3390d18020bSdrh ** Exactly one of the following macros must be defined in order to 3400d18020bSdrh ** specify which memory allocation subsystem to use. 3410d18020bSdrh ** 3420d18020bSdrh ** SQLITE_SYSTEM_MALLOC // Use normal system malloc() 3431b186a99Smistachkin ** SQLITE_WIN32_MALLOC // Use Win32 native heap API 344d1b0afc3Sdrh ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails 3450d18020bSdrh ** SQLITE_MEMDEBUG // Debugging version of system malloc() 346a2460e07Sdrh ** 347753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the 348753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem 349753c5444Smistachkin ** will cause HeapValidate to be called. If heap validation should fail, an 350753c5444Smistachkin ** assertion will be triggered. 351753c5444Smistachkin ** 3520d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as 3530d18020bSdrh ** the default. 3540d18020bSdrh */ 355d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 356d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 357d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 358d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)>1 359d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\ 36020b1ff07Smistachkin are defined but at most one is allowed:\ 361d1b0afc3Sdrh SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\ 362d1b0afc3Sdrh SQLITE_ZERO_MALLOC" 3630d18020bSdrh #endif 364d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \ 365d1b0afc3Sdrh + defined(SQLITE_WIN32_MALLOC) \ 366d1b0afc3Sdrh + defined(SQLITE_ZERO_MALLOC) \ 367d1b0afc3Sdrh + defined(SQLITE_MEMDEBUG)==0 3680d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1 3690d18020bSdrh #endif 3700d18020bSdrh 3710d18020bSdrh /* 3728a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the 373eee4c8caSdrh ** sizes of memory allocations below this value where possible. 374eee4c8caSdrh */ 3758a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT) 376eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024 377eee4c8caSdrh #endif 378eee4c8caSdrh 379eee4c8caSdrh /* 38067080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable 38140b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD. 38240b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit 38340b521f8Sdrh ** it. 38467080617Sdrh */ 38540b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) 38640b521f8Sdrh # define _XOPEN_SOURCE 600 38767080617Sdrh #endif 388e3026636Sdanielk1977 3897d10d5a6Sdrh /* 3901b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that 3911b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true, 3921b28b893Sdrh ** make it true by defining or undefining NDEBUG. 3931b28b893Sdrh ** 394443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the 395443dbcf5Sdrh ** assert() statements in the code. So we want the default action 3961b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG 3971b28b893Sdrh ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out 3984b529d97Sdrh ** feature. 3994b529d97Sdrh */ 400289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG) 4014b529d97Sdrh # define NDEBUG 1 4024b529d97Sdrh #endif 4031b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG) 4041b28b893Sdrh # undef NDEBUG 4051b28b893Sdrh #endif 4064b529d97Sdrh 4076402250eSdrh /* 408c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on. 409c7379ce4Sdrh */ 410c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG) 411c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1 412c7379ce4Sdrh #endif 413c7379ce4Sdrh 414c7379ce4Sdrh /* 41547c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing. When 41647c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to 41747c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to 41847c3b3e0Sdrh ** get full branch coverage. The testcase() macro is inserted 41947c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple 42047c3b3e0Sdrh ** condition/decision coverage is inadequate. For example, testcase() 42147c3b3e0Sdrh ** can be used to make sure boundary values are tested. For 42247c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit 42347c3b3e0Sdrh ** is significant and used at least once. On switch statements 42447c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase() 42547c3b3e0Sdrh ** can insure that all cases are evaluated. 42647c3b3e0Sdrh ** 42747c3b3e0Sdrh */ 42847c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST 42947c3b3e0Sdrh void sqlite3Coverage(int); 43047c3b3e0Sdrh # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); } 43147c3b3e0Sdrh #else 43247c3b3e0Sdrh # define testcase(X) 4338f941bc7Sdrh #endif 4348f941bc7Sdrh 4358f941bc7Sdrh /* 4368f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or 4378f941bc7Sdrh ** other bits of code that are needed to support the arguments 4388f941bc7Sdrh ** within testcase() and assert() macros. 4398f941bc7Sdrh */ 4408f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST) 4418f941bc7Sdrh # define TESTONLY(X) X 4428f941bc7Sdrh #else 44347c3b3e0Sdrh # define TESTONLY(X) 44447c3b3e0Sdrh #endif 44547c3b3e0Sdrh 44647c3b3e0Sdrh /* 4476149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization 4486149526cSdrh ** to setup for a later assert() statement. We do not want this code to 4496149526cSdrh ** appear when assert() is disabled. The following macro is therefore 4506149526cSdrh ** used to contain that setup code. The "VVA" acronym stands for 4516149526cSdrh ** "Verification, Validation, and Accreditation". In other words, the 4526149526cSdrh ** code within VVA_ONLY() will only run during verification processes. 4536149526cSdrh */ 4546149526cSdrh #ifndef NDEBUG 4556149526cSdrh # define VVA_ONLY(X) X 4566149526cSdrh #else 4576149526cSdrh # define VVA_ONLY(X) 4586149526cSdrh #endif 4596149526cSdrh 4606149526cSdrh /* 46147c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which 46247c3b3e0Sdrh ** are intended to always be true or false, respectively. Such 46347c3b3e0Sdrh ** expressions could be omitted from the code completely. But they 46447c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience 46547c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing" 46647c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first 46747c3b3e0Sdrh ** hint of unplanned behavior. 46847c3b3e0Sdrh ** 46947c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code. 47047c3b3e0Sdrh ** 47147c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to 472443dbcf5Sdrh ** be true and false so that the unreachable code they specify will 47347c3b3e0Sdrh ** not be counted as untested code. 47447c3b3e0Sdrh */ 4755f65ff27Sdrh #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST) 47647c3b3e0Sdrh # define ALWAYS(X) (1) 47747c3b3e0Sdrh # define NEVER(X) (0) 47847c3b3e0Sdrh #elif !defined(NDEBUG) 4792de80f4cSdrh # define ALWAYS(X) ((X)?1:(assert(0),0)) 4802de80f4cSdrh # define NEVER(X) ((X)?(assert(0),1):0) 48147c3b3e0Sdrh #else 48247c3b3e0Sdrh # define ALWAYS(X) (X) 48347c3b3e0Sdrh # define NEVER(X) (X) 48447c3b3e0Sdrh #endif 48547c3b3e0Sdrh 48647c3b3e0Sdrh /* 487a2d50283Sdrh ** The harmless(X) macro indicates that expression X is usually false 488a2d50283Sdrh ** but can be true without causing any problems, but we don't know of 489a2d50283Sdrh ** any way to cause X to be true. 490a2d50283Sdrh ** 491a2d50283Sdrh ** In debugging and testing builds, this macro will abort if X is ever 492a2d50283Sdrh ** true. In this way, developers are alerted to a possible test case 493a2d50283Sdrh ** that causes X to be true. If a harmless macro ever fails, that is 494a2d50283Sdrh ** an opportunity to change the macro into a testcase() and add a new 495a2d50283Sdrh ** test case to the test suite. 496a2d50283Sdrh ** 497a2d50283Sdrh ** For normal production builds, harmless(X) is a no-op, since it does 498a2d50283Sdrh ** not matter whether expression X is true or false. 499a2d50283Sdrh */ 500a2d50283Sdrh #ifdef SQLITE_DEBUG 501a2d50283Sdrh # define harmless(X) assert(!(X)); 502a2d50283Sdrh #else 503a2d50283Sdrh # define harmless(X) 504a2d50283Sdrh #endif 505a2d50283Sdrh 506a2d50283Sdrh /* 5072f65b2f5Sdrh ** Some conditionals are optimizations only. In other words, if the 5082f65b2f5Sdrh ** conditionals are replaced with a constant 1 (true) or 0 (false) then 5092f65b2f5Sdrh ** the correct answer is still obtained, though perhaps not as quickly. 5102f65b2f5Sdrh ** 5112f65b2f5Sdrh ** The following macros mark these optimizations conditionals. 5122f65b2f5Sdrh */ 5132f65b2f5Sdrh #if defined(SQLITE_MUTATION_TEST) 5142f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (1) 5152f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (0) 5162f65b2f5Sdrh #else 5172f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X) (X) 5182f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (X) 5192f65b2f5Sdrh #endif 5202f65b2f5Sdrh 5212f65b2f5Sdrh /* 522dad300d8Sdrh ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is 523dad300d8Sdrh ** defined. We need to defend against those failures when testing with 524dad300d8Sdrh ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches 525dad300d8Sdrh ** during a normal build. The following macro can be used to disable tests 526dad300d8Sdrh ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set. 527dad300d8Sdrh */ 528dad300d8Sdrh #if defined(SQLITE_TEST_REALLOC_STRESS) 529dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (X) 530dad300d8Sdrh #elif !defined(NDEBUG) 531dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0) 532dad300d8Sdrh #else 533dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X) (0) 534dad300d8Sdrh #endif 535dad300d8Sdrh 536dad300d8Sdrh /* 5370cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces. 5380cbcffa7Smistachkin */ 539b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \ 540b10f22a1Smistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5410cbcffa7Smistachkin extern int sqlite3OSTrace; 5420cbcffa7Smistachkin # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X 5430cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE 5440cbcffa7Smistachkin #else 5450cbcffa7Smistachkin # define OSTRACE(X) 5460cbcffa7Smistachkin # undef SQLITE_HAVE_OS_TRACE 5470cbcffa7Smistachkin #endif 5480cbcffa7Smistachkin 5490cbcffa7Smistachkin /* 5505824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build? Currently, 5515824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when 5525824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are 5535824d44bSmistachkin ** compiled using SQLITE_TEST). 5545824d44bSmistachkin */ 5555824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \ 5565824d44bSmistachkin (defined(SQLITE_DEBUG) && SQLITE_OS_WIN) 5575824d44bSmistachkin # define SQLITE_NEED_ERR_NAME 5585824d44bSmistachkin #else 5595824d44bSmistachkin # undef SQLITE_NEED_ERR_NAME 5605824d44bSmistachkin #endif 5615824d44bSmistachkin 5625824d44bSmistachkin /* 5637c621fb9Sdrh ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN 5647c621fb9Sdrh */ 5657c621fb9Sdrh #ifdef SQLITE_OMIT_EXPLAIN 5667c621fb9Sdrh # undef SQLITE_ENABLE_EXPLAIN_COMMENTS 5677c621fb9Sdrh #endif 5687c621fb9Sdrh 5697c621fb9Sdrh /* 57060ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large 5713e8e7ecbSdrh ** to fit in 32-bits. This macro is used inside of various testcase() 5723e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support. 5733e8e7ecbSdrh */ 574b31a6afaSdan #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0) 5753e8e7ecbSdrh 5763e8e7ecbSdrh /* 57747c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean 57847c3b3e0Sdrh ** expression that is usually false. Macro likely() surrounds 579443dbcf5Sdrh ** a boolean expression that is usually true. These hints could, 580443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but 581443dbcf5Sdrh ** currently they are just comments for human readers. 58247c3b3e0Sdrh */ 583443dbcf5Sdrh #define likely(X) (X) 584443dbcf5Sdrh #define unlikely(X) (X) 58547c3b3e0Sdrh 586beae3194Sdrh #include "hash.h" 58775897234Sdrh #include "parse.h" 58875897234Sdrh #include <stdio.h> 58975897234Sdrh #include <stdlib.h> 59075897234Sdrh #include <string.h> 59175897234Sdrh #include <assert.h> 59252370e2cSdrh #include <stddef.h> 59375897234Sdrh 594967e8b73Sdrh /* 5958674e492Sdrh ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY. 5968674e492Sdrh ** This allows better measurements of where memcpy() is used when running 5978674e492Sdrh ** cachegrind. But this macro version of memcpy() is very slow so it 5988674e492Sdrh ** should not be used in production. This is a performance measurement 5998674e492Sdrh ** hack only. 6008674e492Sdrh */ 6018674e492Sdrh #ifdef SQLITE_INLINE_MEMCPY 6028674e492Sdrh # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\ 6038674e492Sdrh int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);} 6048674e492Sdrh #endif 6058674e492Sdrh 6068674e492Sdrh /* 607b37df7b9Sdrh ** If compiling for a processor that lacks floating point support, 608b37df7b9Sdrh ** substitute integer for floating-point 609b37df7b9Sdrh */ 610b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT 611b37df7b9Sdrh # define double sqlite_int64 6128b307fbfSdrh # define float sqlite_int64 613b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64 614d1167393Sdrh # ifndef SQLITE_BIG_DBL 615cdaca55eSdrh # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50) 616d1167393Sdrh # endif 617b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1 618b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1 619110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT 6200b3bf924Sdrh # undef SQLITE_HAVE_ISNAN 621b37df7b9Sdrh #endif 622d1167393Sdrh #ifndef SQLITE_BIG_DBL 623d1167393Sdrh # define SQLITE_BIG_DBL (1e99) 624d1167393Sdrh #endif 625b37df7b9Sdrh 626b37df7b9Sdrh /* 62753c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0 62853c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler 62953c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements. 63053c0f748Sdanielk1977 */ 63153c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB 63253c0f748Sdanielk1977 #define OMIT_TEMPDB 1 63353c0f748Sdanielk1977 #else 63453c0f748Sdanielk1977 #define OMIT_TEMPDB 0 63553c0f748Sdanielk1977 #endif 63653c0f748Sdanielk1977 63753c0f748Sdanielk1977 /* 638d946db00Sdrh ** The "file format" number is an integer that is incremented whenever 639d946db00Sdrh ** the VDBE-level file format changes. The following macros define the 640d946db00Sdrh ** the default file format for new databases and the maximum file format 641d946db00Sdrh ** that the library can read. 642d946db00Sdrh */ 643d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4 644d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT 645bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4 646d946db00Sdrh #endif 647d946db00Sdrh 648a2460e07Sdrh /* 649a2460e07Sdrh ** Determine whether triggers are recursive by default. This can be 650a2460e07Sdrh ** changed at run-time using a pragma. 651a2460e07Sdrh */ 6525bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS 6535bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0 6545bde73c4Sdan #endif 6555bde73c4Sdan 656d946db00Sdrh /* 657b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified 65849766d6cSdrh ** on the command-line 65949766d6cSdrh */ 660b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE 661b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1 66249766d6cSdrh #endif 66349766d6cSdrh 66449766d6cSdrh /* 665b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if 666b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it 667b3f56fdbSdan ** to zero. 668b3f56fdbSdan */ 6696b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0 670b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS 671028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0 672b3f56fdbSdan #endif 673b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS 6746b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8 675b3f56fdbSdan #endif 676a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS 677a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0 678a09c8855Sdrh #endif 679a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS 680a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS 681a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS 682a09c8855Sdrh #endif 683b3f56fdbSdan 6844297c7c4Sdrh /* 6854297c7c4Sdrh ** The default initial allocation for the pagecache when using separate 6864297c7c4Sdrh ** pagecaches for each database connection. A positive number is the 6874297c7c4Sdrh ** number of pages. A negative number N translations means that a buffer 6884297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold. 68983a4f47dSdrh ** 69083a4f47dSdrh ** The default value of "20" was choosen to minimize the run-time of the 69183a4f47dSdrh ** speedtest1 test program with options: --shrink-memory --reprepare 6924297c7c4Sdrh */ 6934297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ 69483a4f47dSdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 20 6954297c7c4Sdrh #endif 6964297c7c4Sdrh 697d83f7ca1Sdan /* 6982e3a5a81Sdan ** Default value for the SQLITE_CONFIG_SORTERREF_SIZE option. 6992e3a5a81Sdan */ 7002e3a5a81Sdan #ifndef SQLITE_DEFAULT_SORTERREF_SIZE 7012e3a5a81Sdan # define SQLITE_DEFAULT_SORTERREF_SIZE 0x7fffffff 7022e3a5a81Sdan #endif 7032e3a5a81Sdan 7042e3a5a81Sdan /* 7052df9478fSdrh ** The compile-time options SQLITE_MMAP_READWRITE and 7062df9478fSdrh ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another. 7072df9478fSdrh ** You must choose one or the other (or neither) but not both. 7082df9478fSdrh */ 7092df9478fSdrh #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 7102df9478fSdrh #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE 7112df9478fSdrh #endif 7122df9478fSdrh 7132df9478fSdrh /* 714f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it 715f1974846Sdrh ** ourselves. 716f1974846Sdrh */ 717f1974846Sdrh #ifndef offsetof 718f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD)) 719f1974846Sdrh #endif 720f1974846Sdrh 721f1974846Sdrh /* 722e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers. 723e1e2e9acSdrh */ 72413969f5aSdrh #ifndef MIN 725e1e2e9acSdrh # define MIN(A,B) ((A)<(B)?(A):(B)) 72613969f5aSdrh #endif 72713969f5aSdrh #ifndef MAX 728e1e2e9acSdrh # define MAX(A,B) ((A)>(B)?(A):(B)) 72913969f5aSdrh #endif 730e1e2e9acSdrh 731e1e2e9acSdrh /* 7324fa4a54fSdrh ** Swap two objects of type TYPE. 7334fa4a54fSdrh */ 7344fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;} 7354fa4a54fSdrh 7364fa4a54fSdrh /* 7379b8f447bSdrh ** Check to see if this machine uses EBCDIC. (Yes, believe it or 7389b8f447bSdrh ** not, there are still machines out there that use EBCDIC.) 7399b8f447bSdrh */ 7409b8f447bSdrh #if 'A' == '\301' 7419b8f447bSdrh # define SQLITE_EBCDIC 1 7429b8f447bSdrh #else 7439b8f447bSdrh # define SQLITE_ASCII 1 7449b8f447bSdrh #endif 7459b8f447bSdrh 7469b8f447bSdrh /* 7475a2c2c20Sdrh ** Integers of known sizes. These typedefs might change for architectures 7485a2c2c20Sdrh ** where the sizes very. Preprocessor macros are available so that the 7495a2c2c20Sdrh ** types can be conveniently redefined at compile-type. Like this: 7505a2c2c20Sdrh ** 7515a2c2c20Sdrh ** cc '-DUINTPTR_TYPE=long long int' ... 75241a2b48bSdrh */ 7535a2c2c20Sdrh #ifndef UINT32_TYPE 754dda5b68cSmlcreech # ifdef HAVE_UINT32_T 755dda5b68cSmlcreech # define UINT32_TYPE uint32_t 756dda5b68cSmlcreech # else 7575a2c2c20Sdrh # define UINT32_TYPE unsigned int 7585a2c2c20Sdrh # endif 759dda5b68cSmlcreech #endif 7605a2c2c20Sdrh #ifndef UINT16_TYPE 761dda5b68cSmlcreech # ifdef HAVE_UINT16_T 762dda5b68cSmlcreech # define UINT16_TYPE uint16_t 763dda5b68cSmlcreech # else 7645a2c2c20Sdrh # define UINT16_TYPE unsigned short int 7655a2c2c20Sdrh # endif 766dda5b68cSmlcreech #endif 767939a16d6Sdrh #ifndef INT16_TYPE 768dda5b68cSmlcreech # ifdef HAVE_INT16_T 769dda5b68cSmlcreech # define INT16_TYPE int16_t 770dda5b68cSmlcreech # else 771939a16d6Sdrh # define INT16_TYPE short int 772939a16d6Sdrh # endif 773dda5b68cSmlcreech #endif 7745a2c2c20Sdrh #ifndef UINT8_TYPE 775dda5b68cSmlcreech # ifdef HAVE_UINT8_T 776dda5b68cSmlcreech # define UINT8_TYPE uint8_t 777dda5b68cSmlcreech # else 7785a2c2c20Sdrh # define UINT8_TYPE unsigned char 7795a2c2c20Sdrh # endif 780dda5b68cSmlcreech #endif 781905793e2Sdrh #ifndef INT8_TYPE 782dda5b68cSmlcreech # ifdef HAVE_INT8_T 783dda5b68cSmlcreech # define INT8_TYPE int8_t 784dda5b68cSmlcreech # else 785905793e2Sdrh # define INT8_TYPE signed char 786905793e2Sdrh # endif 787dda5b68cSmlcreech #endif 788efad9995Sdrh #ifndef LONGDOUBLE_TYPE 789efad9995Sdrh # define LONGDOUBLE_TYPE long double 790efad9995Sdrh #endif 791efad9995Sdrh typedef sqlite_int64 i64; /* 8-byte signed integer */ 79227436af7Sdrh typedef sqlite_uint64 u64; /* 8-byte unsigned integer */ 7935a2c2c20Sdrh typedef UINT32_TYPE u32; /* 4-byte unsigned integer */ 7945a2c2c20Sdrh typedef UINT16_TYPE u16; /* 2-byte unsigned integer */ 795939a16d6Sdrh typedef INT16_TYPE i16; /* 2-byte signed integer */ 7965a2c2c20Sdrh typedef UINT8_TYPE u8; /* 1-byte unsigned integer */ 79770a8ca3cSdrh typedef INT8_TYPE i8; /* 1-byte signed integer */ 7985a2c2c20Sdrh 7995a2c2c20Sdrh /* 80035cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value 80135cd643cSdrh ** that can be stored in a u32 without loss of data. The value 80235cd643cSdrh ** is 0x00000000ffffffff. But because of quirks of some compilers, we 80335cd643cSdrh ** have to specify the value in the less intuitive manner shown: 80435cd643cSdrh */ 80535cd643cSdrh #define SQLITE_MAX_U32 ((((u64)1)<<32)-1) 80635cd643cSdrh 80735cd643cSdrh /* 808faacf17cSdrh ** The datatype used to store estimates of the number of rows in a 809faacf17cSdrh ** table or index. This is an unsigned integer type. For 99.9% of 810faacf17cSdrh ** the world, a 32-bit integer is sufficient. But a 64-bit integer 811faacf17cSdrh ** can be used at compile-time if desired. 812faacf17cSdrh */ 813faacf17cSdrh #ifdef SQLITE_64BIT_STATS 814faacf17cSdrh typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */ 815faacf17cSdrh #else 816faacf17cSdrh typedef u32 tRowcnt; /* 32-bit is the default */ 817faacf17cSdrh #endif 818faacf17cSdrh 819faacf17cSdrh /* 820bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit 821bf539c4dSdrh ** logarithms. For quantity X, the value stored is 10*log2(X). This 822bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986. 823bf539c4dSdrh ** But the allowed values are "grainy". Not every value is representable. 824bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst 82597d38983Sdrh ** of 40. However, since LogEst quantities are suppose to be estimates, 826bf539c4dSdrh ** not exact values, this imprecision is not a problem. 827bf539c4dSdrh ** 828224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate". 829bf539c4dSdrh ** 830bf539c4dSdrh ** Examples: 831bf539c4dSdrh ** 1 -> 0 20 -> 43 10000 -> 132 832bf539c4dSdrh ** 2 -> 10 25 -> 46 25000 -> 146 833bf539c4dSdrh ** 3 -> 16 100 -> 66 1000000 -> 199 834bf539c4dSdrh ** 4 -> 20 1000 -> 99 1048576 -> 200 835bf539c4dSdrh ** 10 -> 33 1024 -> 100 4294967296 -> 320 836bf539c4dSdrh ** 837bf539c4dSdrh ** The LogEst can be negative to indicate fractional values. 838bf539c4dSdrh ** Examples: 839bf539c4dSdrh ** 840bf539c4dSdrh ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40 841bf539c4dSdrh */ 842bf539c4dSdrh typedef INT16_TYPE LogEst; 843bf539c4dSdrh 844bf539c4dSdrh /* 8452b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer 8462b4905c8Sdrh */ 8472b4905c8Sdrh #ifndef SQLITE_PTRSIZE 8482b4905c8Sdrh # if defined(__SIZEOF_POINTER__) 8492b4905c8Sdrh # define SQLITE_PTRSIZE __SIZEOF_POINTER__ 8502b4905c8Sdrh # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 85188edc6c7Smistachkin defined(_M_ARM) || defined(__arm__) || defined(__x86) || \ 85288edc6c7Smistachkin (defined(__TOS_AIX__) && !defined(__64BIT__)) 8532b4905c8Sdrh # define SQLITE_PTRSIZE 4 8542b4905c8Sdrh # else 8552b4905c8Sdrh # define SQLITE_PTRSIZE 8 8562b4905c8Sdrh # endif 8572b4905c8Sdrh #endif 8582b4905c8Sdrh 8593bfa7e82Sdrh /* The uptr type is an unsigned integer large enough to hold a pointer 8603bfa7e82Sdrh */ 8613bfa7e82Sdrh #if defined(HAVE_STDINT_H) 8623bfa7e82Sdrh typedef uintptr_t uptr; 8633bfa7e82Sdrh #elif SQLITE_PTRSIZE==4 8643bfa7e82Sdrh typedef u32 uptr; 8653bfa7e82Sdrh #else 8663bfa7e82Sdrh typedef u64 uptr; 8673bfa7e82Sdrh #endif 8683bfa7e82Sdrh 8693bfa7e82Sdrh /* 8703bfa7e82Sdrh ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to 8713bfa7e82Sdrh ** something between S (inclusive) and E (exclusive). 8723bfa7e82Sdrh ** 8733bfa7e82Sdrh ** In other words, S is a buffer and E is a pointer to the first byte after 8743bfa7e82Sdrh ** the end of buffer S. This macro returns true if P points to something 8753bfa7e82Sdrh ** contained within the buffer S. 8763bfa7e82Sdrh */ 8773bfa7e82Sdrh #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E))) 8783bfa7e82Sdrh 8793bfa7e82Sdrh 8802b4905c8Sdrh /* 881bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian, 88271794dbaSdrh ** and whether or not that determination is run-time or compile-time. 88371794dbaSdrh ** 88471794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order 88571794dbaSdrh ** using C-preprocessor macros. If that is unsuccessful, or if 886a39284bfSdrh ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined 88771794dbaSdrh ** at run-time. 888bbd42a6dSdrh */ 889a39284bfSdrh #ifndef SQLITE_BYTEORDER 890a39284bfSdrh # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \ 89171794dbaSdrh defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \ 89271794dbaSdrh defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \ 893acd6bb5fSdrh defined(__ARMEL__) || defined(__AARCH64EL__) || defined(_M_ARM64) 8942cf4acbdSdrh # define SQLITE_BYTEORDER 1234 895acd6bb5fSdrh # elif defined(sparc) || defined(__ppc__) || \ 896acd6bb5fSdrh defined(__ARMEB__) || defined(__AARCH64EB__) 89771794dbaSdrh # define SQLITE_BYTEORDER 4321 898a39284bfSdrh # else 899a39284bfSdrh # define SQLITE_BYTEORDER 0 900a39284bfSdrh # endif 901a39284bfSdrh #endif 902a39284bfSdrh #if SQLITE_BYTEORDER==4321 90371794dbaSdrh # define SQLITE_BIGENDIAN 1 90471794dbaSdrh # define SQLITE_LITTLEENDIAN 0 90571794dbaSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16BE 906a39284bfSdrh #elif SQLITE_BYTEORDER==1234 907a39284bfSdrh # define SQLITE_BIGENDIAN 0 908a39284bfSdrh # define SQLITE_LITTLEENDIAN 1 909a39284bfSdrh # define SQLITE_UTF16NATIVE SQLITE_UTF16LE 910a39284bfSdrh #else 911e1462a76Sdrh # ifdef SQLITE_AMALGAMATION 912e1462a76Sdrh const int sqlite3one = 1; 913e1462a76Sdrh # else 914e1462a76Sdrh extern const int sqlite3one; 915e1462a76Sdrh # endif 9169c054830Sdrh # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0) 9179c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1) 91838def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE) 91938def054Sdrh #endif 920bbd42a6dSdrh 921bbd42a6dSdrh /* 9220f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers. 9230f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit 9240f050353Sdrh ** compilers. 9250f050353Sdrh */ 9260f050353Sdrh #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32)) 927d1d89140Sdrh #define LARGEST_UINT64 (0xffffffff|(((u64)0xffffffff)<<32)) 9280f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64) 9290f050353Sdrh 9300f050353Sdrh /* 931be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8. This is used 932be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures. 933be229650Sdanielk1977 */ 934bc73971dSdanielk1977 #define ROUND8(x) (((x)+7)&~7) 935bc73971dSdanielk1977 936bc73971dSdanielk1977 /* 937bc73971dSdanielk1977 ** Round down to the nearest multiple of 8 938bc73971dSdanielk1977 */ 939bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7) 940be229650Sdanielk1977 941be229650Sdanielk1977 /* 9428e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary. This 9438e14c596Sdrh ** macro is used only within assert() to verify that the code gets 9448e14c596Sdrh ** all alignment restrictions correct. 9458e14c596Sdrh ** 9468e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the 94760ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned 9488e14c596Sdrh ** pointers. In that case, only verify 4-byte alignment. 949ea598cbdSdrh */ 9508e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC 9518e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0) 9528e14c596Sdrh #else 953ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0) 9548e14c596Sdrh #endif 955ea598cbdSdrh 956188d4884Sdrh /* 9579b4c59faSdrh ** Disable MMAP on platforms where it is known to not work 958188d4884Sdrh */ 959188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__) 9609b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE 9619b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 962188d4884Sdrh #endif 963188d4884Sdrh 9649b4c59faSdrh /* 9659b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS 9669b4c59faSdrh */ 9679b4c59faSdrh #ifdef __APPLE__ 9689b4c59faSdrh # include <TargetConditionals.h> 9699b4c59faSdrh #endif 9709b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE 9719b4c59faSdrh # if defined(__linux__) \ 9729b4c59faSdrh || defined(_WIN32) \ 9739b4c59faSdrh || (defined(__APPLE__) && defined(__MACH__)) \ 9743e9dd938Sdrh || defined(__sun) \ 9753e9dd938Sdrh || defined(__FreeBSD__) \ 9763e9dd938Sdrh || defined(__DragonFly__) 9772bba8c24Sdrh # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */ 9789b4c59faSdrh # else 9799b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0 9809b4c59faSdrh # endif 9819b4c59faSdrh #endif 9829b4c59faSdrh 9839b4c59faSdrh /* 9849b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger 9859b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does 9869b4c59faSdrh ** not exceed the maximum mmap size. 9879b4c59faSdrh */ 9889b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE 9899b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0 9909b4c59faSdrh #endif 9919b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE 9929b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE 9939b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE 9949b4c59faSdrh #endif 995e7b34707Sdrh 996ea598cbdSdrh /* 997abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not 998abd4c723Sdrh ** the Select query generator tracing logic is turned on. 999abd4c723Sdrh */ 1000c0622a4dSdrh #if !defined(SQLITE_AMALGAMATION) 1001c0622a4dSdrh extern u32 sqlite3SelectTrace; 1002abd4c723Sdrh #endif 1003c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1004c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_SELECTTRACE)) 10059216de8aSdrh # define SELECTTRACE_ENABLED 1 10069216de8aSdrh # define SELECTTRACE(K,P,S,X) \ 1007c0622a4dSdrh if(sqlite3SelectTrace&(K)) \ 10089216de8aSdrh sqlite3DebugPrintf("%u/%d/%p: ",(S)->selId,(P)->addrExplain,(S)),\ 10099216de8aSdrh sqlite3DebugPrintf X 10109216de8aSdrh #else 10119216de8aSdrh # define SELECTTRACE(K,P,S,X) 10129216de8aSdrh # define SELECTTRACE_ENABLED 0 10139216de8aSdrh #endif 1014abd4c723Sdrh 1015abd4c723Sdrh /* 1016c0622a4dSdrh ** Macros for "wheretrace" 1017c0622a4dSdrh */ 10188e2b9c2aSdrh extern u32 sqlite3WhereTrace; 1019c0622a4dSdrh #if defined(SQLITE_DEBUG) \ 1020c0622a4dSdrh && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE)) 1021c0622a4dSdrh # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X 1022c0622a4dSdrh # define WHERETRACE_ENABLED 1 1023c0622a4dSdrh #else 1024c0622a4dSdrh # define WHERETRACE(K,X) 1025c0622a4dSdrh #endif 1026c0622a4dSdrh 1027c0622a4dSdrh 1028c0622a4dSdrh /* 102990f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler 103090f5ecb3Sdrh ** callback for a given sqlite handle. 103190f5ecb3Sdrh ** 103290f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy 103390f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite 103490f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler 103590f5ecb3Sdrh ** callback is currently invoked only from within pager.c. 103690f5ecb3Sdrh */ 103790f5ecb3Sdrh typedef struct BusyHandler BusyHandler; 103890f5ecb3Sdrh struct BusyHandler { 103980262896Sdrh int (*xBusyHandler)(void *,int); /* The busy callback */ 104080262896Sdrh void *pBusyArg; /* First arg to busy callback */ 1041a4afb65cSdrh int nBusy; /* Incremented with each busy call */ 104290f5ecb3Sdrh }; 104390f5ecb3Sdrh 104490f5ecb3Sdrh /* 1045ccb2113aSdrh ** Name of table that holds the database schema. 104675897234Sdrh */ 1047346a70caSdrh #define DFLT_SCHEMA_TABLE "sqlite_master" 1048346a70caSdrh #define DFLT_TEMP_SCHEMA_TABLE "sqlite_temp_master" 1049346a70caSdrh #define ALT_SCHEMA_TABLE "sqlite_schema" 1050346a70caSdrh #define ALT_TEMP_SCHEMA_TABLE "sqlite_temp_schema" 1051346a70caSdrh 105275897234Sdrh 105375897234Sdrh /* 1054346a70caSdrh ** The root-page of the schema table. 10558e150818Sdanielk1977 */ 1056346a70caSdrh #define SCHEMA_ROOT 1 10578e150818Sdanielk1977 10588e150818Sdanielk1977 /* 1059346a70caSdrh ** The name of the schema table. The name is different for TEMP. 1060ed6c8671Sdrh */ 1061346a70caSdrh #define SCHEMA_TABLE(x) \ 1062346a70caSdrh ((!OMIT_TEMPDB)&&(x==1)?DFLT_TEMP_SCHEMA_TABLE:DFLT_SCHEMA_TABLE) 1063ed6c8671Sdrh 1064ed6c8671Sdrh /* 106575897234Sdrh ** A convenience macro that returns the number of elements in 106675897234Sdrh ** an array. 106775897234Sdrh */ 106823432976Sdanielk1977 #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0]))) 106975897234Sdrh 107075897234Sdrh /* 10717a5bcc0fSdrh ** Determine if the argument is a power of two 10727a5bcc0fSdrh */ 10737a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0) 10747a5bcc0fSdrh 10757a5bcc0fSdrh /* 1076633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree(). 1077aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the 1078aa538a58Sdrh ** one parameter that destructors normally want. So we have to introduce 1079aa538a58Sdrh ** this magic value that the code knows to handle differently. Any 1080aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC 1081aa538a58Sdrh ** and SQLITE_TRANSIENT. 1082633e6d57Sdrh */ 108308b92086Sdrh #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3OomFault) 1084633e6d57Sdrh 108578f82d1eSdrh /* 108678f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does 108778f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables. 108878f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from 108978f82d1eSdrh ** the heap. When WSD is unsupported, the variable declarations scattered 109078f82d1eSdrh ** throughout the SQLite code must become constants instead. The SQLITE_WSD 109178f82d1eSdrh ** macro is used for this purpose. And instead of referencing the variable 109278f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated 109378f82d1eSdrh ** buffer that holds real variable. The constant is also the initializer 109478f82d1eSdrh ** for the run-time allocated buffer. 109578f82d1eSdrh ** 10962479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL 109778f82d1eSdrh ** macros become no-ops and have zero performance impact. 109878f82d1eSdrh */ 1099075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD 1100075c23afSdanielk1977 #define SQLITE_WSD const 1101075c23afSdanielk1977 #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v))) 1102075c23afSdanielk1977 #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config) 1103d1d38488Sdrh int sqlite3_wsd_init(int N, int J); 1104d1d38488Sdrh void *sqlite3_wsd_find(void *K, int L); 1105075c23afSdanielk1977 #else 1106075c23afSdanielk1977 #define SQLITE_WSD 1107075c23afSdanielk1977 #define GLOBAL(t,v) v 1108075c23afSdanielk1977 #define sqlite3GlobalConfig sqlite3Config 1109075c23afSdanielk1977 #endif 1110075c23afSdanielk1977 1111f3d3c27aSdanielk1977 /* 1112f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to 1113f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately 1114f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when 1115f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the 1116f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the 1117f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate, 1118f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere. 1119f3d3c27aSdanielk1977 ** 1120f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function, 1121f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer. 1122f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to 1123f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options. 1124f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these 1125f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions. 1126f3d3c27aSdanielk1977 */ 112762c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x) 1128f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y) 112962c14b34Sdanielk1977 1130633e6d57Sdrh /* 113175897234Sdrh ** Forward references to structures 113275897234Sdrh */ 113313449892Sdrh typedef struct AggInfo AggInfo; 1134fe05af87Sdrh typedef struct AuthContext AuthContext; 11350b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo; 1136f5e7bb51Sdrh typedef struct Bitvec Bitvec; 1137fe05af87Sdrh typedef struct CollSeq CollSeq; 11387020f651Sdrh typedef struct Column Column; 1139f824b41eSdrh typedef struct Cte Cte; 1140a79e2a2dSdrh typedef struct CteUse CteUse; 1141fe05af87Sdrh typedef struct Db Db; 1142f380c3f1Sdan typedef struct DbFixer DbFixer; 1143e501b89aSdanielk1977 typedef struct Schema Schema; 114475897234Sdrh typedef struct Expr Expr; 114575897234Sdrh typedef struct ExprList ExprList; 1146c2eef3b3Sdrh typedef struct FKey FKey; 1147d2199f0fSdan typedef struct FuncDestructor FuncDestructor; 1148fe05af87Sdrh typedef struct FuncDef FuncDef; 114970a8ca3cSdrh typedef struct FuncDefHash FuncDefHash; 1150fe05af87Sdrh typedef struct IdList IdList; 1151fe05af87Sdrh typedef struct Index Index; 115202fa4696Sdan typedef struct IndexSample IndexSample; 11538d059845Sdanielk1977 typedef struct KeyClass KeyClass; 1154d3d39e93Sdrh typedef struct KeyInfo KeyInfo; 1155633e6d57Sdrh typedef struct Lookaside Lookaside; 1156633e6d57Sdrh typedef struct LookasideSlot LookasideSlot; 1157d1ab1ba5Sdanielk1977 typedef struct Module Module; 1158626a879aSdrh typedef struct NameContext NameContext; 1159fe05af87Sdrh typedef struct Parse Parse; 1160cf3c078fSdrh typedef struct ParseCleanup ParseCleanup; 116146c47d46Sdan typedef struct PreUpdate PreUpdate; 1162a5c1416dSdrh typedef struct PrintfArguments PrintfArguments; 1163cf8f2895Sdan typedef struct RenameToken RenameToken; 1164b8352479Sdrh typedef struct Returning Returning; 1165a2460e07Sdrh typedef struct RowSet RowSet; 1166fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint; 1167fe05af87Sdrh typedef struct Select Select; 1168f51446a3Sdrh typedef struct SQLiteThread SQLiteThread; 1169634d81deSdrh typedef struct SelectDest SelectDest; 11707601294aSdrh typedef struct SrcItem SrcItem; 1171fe05af87Sdrh typedef struct SrcList SrcList; 11720cdbe1aeSdrh typedef struct sqlite3_str StrAccum; /* Internal alias for sqlite3_str */ 1173fe05af87Sdrh typedef struct Table Table; 1174c00da105Sdanielk1977 typedef struct TableLock TableLock; 1175fe05af87Sdrh typedef struct Token Token; 11764fa4a54fSdrh typedef struct TreeView TreeView; 1177a2460e07Sdrh typedef struct Trigger Trigger; 11782832ad42Sdan typedef struct TriggerPrg TriggerPrg; 1179fe05af87Sdrh typedef struct TriggerStep TriggerStep; 1180e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord; 118146d2e5c3Sdrh typedef struct Upsert Upsert; 1182595a523aSdanielk1977 typedef struct VTable VTable; 1183b061d058Sdan typedef struct VtabCtx VtabCtx; 11847d10d5a6Sdrh typedef struct Walker Walker; 1185fe05af87Sdrh typedef struct WhereInfo WhereInfo; 118686fb6e17Sdan typedef struct Window Window; 11877d562dbeSdan typedef struct With With; 1188d3d39e93Sdrh 11891fe3ac73Sdrh 11901fe3ac73Sdrh /* 11911fe3ac73Sdrh ** The bitmask datatype defined below is used for various optimizations. 11921fe3ac73Sdrh ** 11931fe3ac73Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of 11941fe3ac73Sdrh ** tables in a join to 32 instead of 64. But it also reduces the size 11951fe3ac73Sdrh ** of the library by 738 bytes on ix86. 11961fe3ac73Sdrh */ 11971fe3ac73Sdrh #ifdef SQLITE_BITMASK_TYPE 11981fe3ac73Sdrh typedef SQLITE_BITMASK_TYPE Bitmask; 11991fe3ac73Sdrh #else 12001fe3ac73Sdrh typedef u64 Bitmask; 12011fe3ac73Sdrh #endif 12021fe3ac73Sdrh 12031fe3ac73Sdrh /* 12041fe3ac73Sdrh ** The number of bits in a Bitmask. "BMS" means "BitMask Size". 12051fe3ac73Sdrh */ 12061fe3ac73Sdrh #define BMS ((int)(sizeof(Bitmask)*8)) 12071fe3ac73Sdrh 12081fe3ac73Sdrh /* 12091fe3ac73Sdrh ** A bit in a Bitmask 12101fe3ac73Sdrh */ 12111fe3ac73Sdrh #define MASKBIT(n) (((Bitmask)1)<<(n)) 1212b945bcdaSdrh #define MASKBIT64(n) (((u64)1)<<(n)) 12131fe3ac73Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n)) 12141fe3ac73Sdrh #define ALLBITS ((Bitmask)-1) 12151fe3ac73Sdrh 12169bf755ccSdrh /* A VList object records a mapping between parameters/variables/wildcards 12179bf755ccSdrh ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer 12189bf755ccSdrh ** variable number associated with that parameter. See the format description 12199bf755ccSdrh ** on the sqlite3VListAdd() routine for more information. A VList is really 12209bf755ccSdrh ** just an array of integers. 12219bf755ccSdrh */ 12229bf755ccSdrh typedef int VList; 12239bf755ccSdrh 12242dca4ac1Sdanielk1977 /* 12252dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and 12262dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque 12272dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above. 12282dca4ac1Sdanielk1977 */ 1229e9261dbdSdrh #include "pager.h" 12302dca4ac1Sdanielk1977 #include "btree.h" 12312dca4ac1Sdanielk1977 #include "vdbe.h" 12328c0a791aSdanielk1977 #include "pcache.h" 12331cc5ed81Sdanielk1977 #include "os.h" 1234c7ce76afSdrh #include "mutex.h" 12351cc5ed81Sdanielk1977 123633b104afSdrh /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default 123733b104afSdrh ** synchronous setting to EXTRA. It is no longer supported. 123833b104afSdrh */ 123933b104afSdrh #ifdef SQLITE_EXTRA_DURABLE 124033b104afSdrh # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE 124133b104afSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 3 124233b104afSdrh #endif 124333b104afSdrh 124450a1a5aaSdrh /* 1245c2ae2073Sdrh ** Default synchronous levels. 1246c2ae2073Sdrh ** 1247c2ae2073Sdrh ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ 1248c2ae2073Sdrh ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1. 1249c2ae2073Sdrh ** 1250c2ae2073Sdrh ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS 1251c2ae2073Sdrh ** OFF 1 0 1252c2ae2073Sdrh ** NORMAL 2 1 1253c2ae2073Sdrh ** FULL 3 2 1254c2ae2073Sdrh ** EXTRA 4 3 1255c2ae2073Sdrh ** 1256c2ae2073Sdrh ** The "PRAGMA synchronous" statement also uses the zero-based numbers. 1257c2ae2073Sdrh ** In other words, the zero-based numbers are used for all external interfaces 1258c2ae2073Sdrh ** and the one-based values are used internally. 125950a1a5aaSdrh */ 126050a1a5aaSdrh #ifndef SQLITE_DEFAULT_SYNCHRONOUS 12613e7d012eSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 2 126250a1a5aaSdrh #endif 126350a1a5aaSdrh #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS 126450a1a5aaSdrh # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS 126550a1a5aaSdrh #endif 1266eee4c8caSdrh 1267001bbcbbSdrh /* 1268001bbcbbSdrh ** Each database file to be accessed by the system is an instance 1269001bbcbbSdrh ** of the following structure. There are normally two of these structures 1270001bbcbbSdrh ** in the sqlite.aDb[] array. aDb[0] is the main database file and 1271a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables. Additional 1272a69d9168Sdrh ** databases may be attached. 1273001bbcbbSdrh */ 1274001bbcbbSdrh struct Db { 127569c33826Sdrh char *zDbSName; /* Name of this database. (schema name, not filename) */ 1276001bbcbbSdrh Btree *pBt; /* The B*Tree structure for this database file */ 1277467bcf36Sshane u8 safety_level; /* How aggressive at syncing data to disk */ 127850a1a5aaSdrh u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */ 1279e501b89aSdanielk1977 Schema *pSchema; /* Pointer to database schema (possibly shared) */ 1280da184236Sdanielk1977 }; 1281da184236Sdanielk1977 1282da184236Sdanielk1977 /* 1283da184236Sdanielk1977 ** An instance of the following structure stores a database schema. 12842120608eSdrh ** 12852120608eSdrh ** Most Schema objects are associated with a Btree. The exception is 12862120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing. 12872120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple 12882120608eSdrh ** Btrees that refer to the same underlying BtShared object. 12892120608eSdrh ** 12902120608eSdrh ** Schema objects are automatically deallocated when the last Btree that 12912120608eSdrh ** references them is destroyed. The TEMP Schema is manually freed by 12922120608eSdrh ** sqlite3_close(). 12932120608eSdrh * 12942120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order 12952120608eSdrh ** to access Schema content. This implies that the thread must also be 12962120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree. 129755a0959aSdrh ** For a TEMP Schema, only the connection mutex is required. 1298da184236Sdanielk1977 */ 1299e501b89aSdanielk1977 struct Schema { 1300001bbcbbSdrh int schema_cookie; /* Database schema version number for this file */ 1301c2a75551Sdrh int iGeneration; /* Generation counter. Incremented with each change */ 1302d24cc427Sdrh Hash tblHash; /* All tables indexed by name */ 1303d24cc427Sdrh Hash idxHash; /* All (named) indices indexed by name */ 1304d24cc427Sdrh Hash trigHash; /* All triggers indexed by name */ 13051da40a38Sdan Hash fkeyHash; /* All foreign keys by referenced table name */ 13064794f735Sdrh Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */ 1307da184236Sdanielk1977 u8 file_format; /* Schema format version for this file */ 13088079a0d3Sdrh u8 enc; /* Text encoding used by this database */ 13092c5e35ffSdrh u16 schemaFlags; /* Flags associated with this schema */ 131014db2665Sdanielk1977 int cache_size; /* Number of pages to use in the cache */ 1311001bbcbbSdrh }; 131275897234Sdrh 131375897234Sdrh /* 13148bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the 1315a2460e07Sdrh ** Db.pSchema->flags field. 13168bf8dc92Sdrh */ 13172c5e35ffSdrh #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P)) 13182c5e35ffSdrh #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0) 13192c5e35ffSdrh #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P) 13202c5e35ffSdrh #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P) 13218bf8dc92Sdrh 13228bf8dc92Sdrh /* 1323a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field. 13248bf8dc92Sdrh ** 13258bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been 13268bf8dc92Sdrh ** read into internal hash tables. 13278bf8dc92Sdrh ** 13288bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that 13298bf8dc92Sdrh ** have been filled out. If the schema changes, these column names might 13308bf8dc92Sdrh ** changes and so the view will need to be reset. 13318bf8dc92Sdrh */ 1332124b27e6Sdrh #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */ 1333124b27e6Sdrh #define DB_UnresetViews 0x0002 /* Some views have defined column names */ 1334dc6b41edSdrh #define DB_ResetWanted 0x0008 /* Reset the schema when nSchemaLock==0 */ 13358bf8dc92Sdrh 1336caa639f4Sdrh /* 1337caa639f4Sdrh ** The number of different kinds of things that can be limited 1338caa639f4Sdrh ** using the sqlite3_limit() interface. 1339caa639f4Sdrh */ 1340111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1) 13418bf8dc92Sdrh 13428bf8dc92Sdrh /* 1343633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used 1344467bcf36Sshane ** to satisfy small transient memory allocation requests for objects 1345633e6d57Sdrh ** associated with a particular database connection. The use of 1346633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement 1347633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing 1348633e6d57Sdrh ** SQL statements. 1349633e6d57Sdrh ** 1350633e6d57Sdrh ** The Lookaside structure holds configuration information about the 1351633e6d57Sdrh ** lookaside malloc subsystem. Each available memory allocation in 1352633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot 1353633e6d57Sdrh ** objects. 1354d9da78a2Sdrh ** 1355d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated 1356d9da78a2Sdrh ** with a particular database connection. Hence, schema information cannot 1357d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information 1358d9da78a2Sdrh ** is shared by multiple database connections. Therefore, while parsing 1359d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that 1360d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects. 136131f69626Sdrh ** 136231f69626Sdrh ** New lookaside allocations are only allowed if bDisable==0. When 136331f69626Sdrh ** bDisable is greater than zero, sz is set to zero which effectively 136431f69626Sdrh ** disables lookaside without adding a new test for the bDisable flag 136531f69626Sdrh ** in a performance-critical path. sz should be set by to szTrue whenever 136631f69626Sdrh ** bDisable changes back to zero. 1367e6068027Sdrh ** 1368e6068027Sdrh ** Lookaside buffers are initially held on the pInit list. As they are 1369e6068027Sdrh ** used and freed, they are added back to the pFree list. New allocations 1370e6068027Sdrh ** come off of pFree first, then pInit as a fallback. This dual-list 1371e6068027Sdrh ** allows use to compute a high-water mark - the maximum number of allocations 1372e6068027Sdrh ** outstanding at any point in the past - by subtracting the number of 1373e6068027Sdrh ** allocations on the pInit list from the total number of allocations. 1374e6068027Sdrh ** 1375cf014f6cSdrh ** Enhancement on 2019-12-12: Two-size-lookaside 1376e6068027Sdrh ** The default lookaside configuration is 100 slots of 1200 bytes each. 1377e6068027Sdrh ** The larger slot sizes are important for performance, but they waste 1378e6068027Sdrh ** a lot of space, as most lookaside allocations are less than 128 bytes. 1379cf014f6cSdrh ** The two-size-lookaside enhancement breaks up the lookaside allocation 1380cf014f6cSdrh ** into two pools: One of 128-byte slots and the other of the default size 1381cf014f6cSdrh ** (1200-byte) slots. Allocations are filled from the small-pool first, 1382e6068027Sdrh ** failing over to the full-size pool if that does not work. Thus more 1383e6068027Sdrh ** lookaside slots are available while also using less memory. 1384e6068027Sdrh ** This enhancement can be omitted by compiling with 1385cf014f6cSdrh ** SQLITE_OMIT_TWOSIZE_LOOKASIDE. 1386633e6d57Sdrh */ 1387633e6d57Sdrh struct Lookaside { 13884a642b60Sdrh u32 bDisable; /* Only operate the lookaside when zero */ 1389633e6d57Sdrh u16 sz; /* Size of each buffer in bytes */ 139031f69626Sdrh u16 szTrue; /* True value of sz, even if disabled */ 1391e9d1c720Sdrh u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */ 139252fb8e19Sdrh u32 nSlot; /* Number of lookaside slots allocated */ 139352fb8e19Sdrh u32 anStat[3]; /* 0: hits. 1: size misses. 2: full misses */ 139452fb8e19Sdrh LookasideSlot *pInit; /* List of buffers not previously used */ 13957d10d5a6Sdrh LookasideSlot *pFree; /* List of available buffers */ 1396cf014f6cSdrh #ifndef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1397cf014f6cSdrh LookasideSlot *pSmallInit; /* List of small buffers not prediously used */ 1398cf014f6cSdrh LookasideSlot *pSmallFree; /* List of available small buffers */ 1399e6068027Sdrh void *pMiddle; /* First byte past end of full-size buffers and 1400cf014f6cSdrh ** the first byte of LOOKASIDE_SMALL buffers */ 1401cf014f6cSdrh #endif /* SQLITE_OMIT_TWOSIZE_LOOKASIDE */ 1402633e6d57Sdrh void *pStart; /* First byte of available memory space */ 1403633e6d57Sdrh void *pEnd; /* First byte past end of available space */ 1404633e6d57Sdrh }; 1405633e6d57Sdrh struct LookasideSlot { 1406633e6d57Sdrh LookasideSlot *pNext; /* Next buffer in the list of free buffers */ 1407633e6d57Sdrh }; 1408633e6d57Sdrh 140931f69626Sdrh #define DisableLookaside db->lookaside.bDisable++;db->lookaside.sz=0 141031f69626Sdrh #define EnableLookaside db->lookaside.bDisable--;\ 141131f69626Sdrh db->lookaside.sz=db->lookaside.bDisable?0:db->lookaside.szTrue 141231f69626Sdrh 1413cf014f6cSdrh /* Size of the smaller allocations in two-size lookside */ 1414cf014f6cSdrh #ifdef SQLITE_OMIT_TWOSIZE_LOOKASIDE 1415cf014f6cSdrh # define LOOKASIDE_SMALL 0 1416e6068027Sdrh #else 1417cf014f6cSdrh # define LOOKASIDE_SMALL 128 1418e6068027Sdrh #endif 14190225d819Sdrh 1420633e6d57Sdrh /* 142180738d9cSdrh ** A hash table for built-in function definitions. (Application-defined 142280738d9cSdrh ** functions use a regular table table from hash.h.) 142370a8ca3cSdrh ** 142470a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots. 1425a60c6301Sdrh ** Collisions are on the FuncDef.u.pHash chain. Use the SQLITE_FUNC_HASH() 1426a60c6301Sdrh ** macro to compute a hash on the function name. 142770a8ca3cSdrh */ 142880738d9cSdrh #define SQLITE_FUNC_HASH_SZ 23 142970a8ca3cSdrh struct FuncDefHash { 143080738d9cSdrh FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */ 143170a8ca3cSdrh }; 14328bee11a4Smistachkin #define SQLITE_FUNC_HASH(C,L) (((C)+(L))%SQLITE_FUNC_HASH_SZ) 143370a8ca3cSdrh 1434d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1435d4530979Sdrh /* 1436d4530979Sdrh ** Information held in the "sqlite3" database connection object and used 1437d4530979Sdrh ** to manage user authentication. 1438d4530979Sdrh */ 1439d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth; 1440d4530979Sdrh struct sqlite3_userauth { 1441e933b83fSdrh u8 authLevel; /* Current authentication level */ 1442d4530979Sdrh int nAuthPW; /* Size of the zAuthPW in bytes */ 1443d4530979Sdrh char *zAuthPW; /* Password used to authenticate */ 1444d4530979Sdrh char *zAuthUser; /* User name used to authenticate */ 1445d4530979Sdrh }; 1446d4530979Sdrh 1447e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */ 1448e933b83fSdrh #define UAUTH_Unknown 0 /* Authentication not yet checked */ 1449e933b83fSdrh #define UAUTH_Fail 1 /* User authentication failed */ 1450e933b83fSdrh #define UAUTH_User 2 /* Authenticated as a normal user */ 1451e933b83fSdrh #define UAUTH_Admin 3 /* Authenticated as an administrator */ 1452d4530979Sdrh 1453d4530979Sdrh /* Functions used only by user authorization logic */ 1454d4530979Sdrh int sqlite3UserAuthTable(const char*); 1455e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*); 14567883ecfcSdrh void sqlite3UserAuthInit(sqlite3*); 1457f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**); 1458f442e33eSdrh 1459d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */ 1460d4530979Sdrh 146132c6a48bSdrh /* 146232c6a48bSdrh ** typedef for the authorization callback function. 146332c6a48bSdrh */ 146432c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION 146532c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 146632c6a48bSdrh const char*, const char*); 146732c6a48bSdrh #else 146832c6a48bSdrh typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*, 146932c6a48bSdrh const char*); 147032c6a48bSdrh #endif 147132c6a48bSdrh 14723d2a529dSdrh #ifndef SQLITE_OMIT_DEPRECATED 14733d2a529dSdrh /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing 14743d2a529dSdrh ** in the style of sqlite3_trace() 14753d2a529dSdrh */ 147604c6747aSdrh #define SQLITE_TRACE_LEGACY 0x40 /* Use the legacy xTrace */ 147704c6747aSdrh #define SQLITE_TRACE_XPROFILE 0x80 /* Use the legacy xProfile */ 14783d2a529dSdrh #else 14793d2a529dSdrh #define SQLITE_TRACE_LEGACY 0 148004c6747aSdrh #define SQLITE_TRACE_XPROFILE 0 14813d2a529dSdrh #endif /* SQLITE_OMIT_DEPRECATED */ 148204c6747aSdrh #define SQLITE_TRACE_NONLEGACY_MASK 0x0f /* Normal flags */ 14833d2a529dSdrh 1484099b385dSdrh /* 1485099b385dSdrh ** Maximum number of sqlite3.aDb[] entries. This is the number of attached 1486099b385dSdrh ** databases plus 2 for "main" and "temp". 1487099b385dSdrh */ 1488099b385dSdrh #define SQLITE_MAX_DB (SQLITE_MAX_ATTACHED+2) 1489d4530979Sdrh 149070a8ca3cSdrh /* 1491a2460e07Sdrh ** Each database connection is an instance of the following structure. 149275897234Sdrh */ 14939bb575fdSdrh struct sqlite3 { 149490f6a5beSdrh sqlite3_vfs *pVfs; /* OS Interface */ 1495a451017dSdrh struct Vdbe *pVdbe; /* List of active virtual machines */ 149642a630b1Sdrh CollSeq *pDfltColl; /* BINARY collseq for the database encoding */ 1497a451017dSdrh sqlite3_mutex *mutex; /* Connection mutex */ 1498001bbcbbSdrh Db *aDb; /* All backends */ 1499a451017dSdrh int nDb; /* Number of backends currently in use */ 15008257aa8dSdrh u32 mDbFlags; /* flags recording internal state */ 1501fd748c64Sdrh u64 flags; /* flags settable by pragmas. See below */ 1502a451017dSdrh i64 lastRowid; /* ROWID of most recent insert (see above) */ 15039b4c59faSdrh i64 szMmap; /* Default mmap_size setting */ 1504dc6b41edSdrh u32 nSchemaLock; /* Do not reset the schema when non-zero */ 1505522c26fbSdrh unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */ 1506fcd35c7bSdrh int errCode; /* Most recent error code (SQLITE_*) */ 15074ac285a1Sdrh int errMask; /* & result codes with this before returning */ 15081b9f2141Sdrh int iSysErrno; /* Errno value from last system error */ 1509af7b7653Sdrh u32 dbOptFlags; /* Flags to enable/disable optimizations */ 15109bd3cc46Sdrh u8 enc; /* Text encoding */ 1511fcd35c7bSdrh u8 autoCommit; /* The auto-commit flag. */ 151290f5ecb3Sdrh u8 temp_store; /* 1: file 2: memory 0: default */ 151317435752Sdrh u8 mallocFailed; /* True if we have seen a malloc failure */ 15144a642b60Sdrh u8 bBenignMalloc; /* Do not require OOMs if true */ 15153b02013eSdrh u8 dfltLockMode; /* Default locking-mode for attached dbs */ 151698757157Sdrh signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */ 1517a7564663Sdrh u8 suppressErr; /* Do not issue error messages if true */ 1518b061d058Sdan u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */ 1519a451017dSdrh u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */ 15203d2a529dSdrh u8 mTrace; /* zero or more SQLITE_TRACE flags */ 1521b2c8559fSdrh u8 noSharedCache; /* True if no shared-cache backends */ 1522bce04148Sdrh u8 nSqlExec; /* Number of pending OP_SqlExec opcodes */ 1523f653d782Sdanielk1977 int nextPagesize; /* Pagesize after VACUUM if >0 */ 152464202cfeSdanielk1977 u32 magic; /* Magic number for detect library misuse */ 1525b28af71aSdanielk1977 int nChange; /* Value returned by sqlite3_changes() */ 1526b28af71aSdanielk1977 int nTotalChange; /* Value returned by sqlite3_total_changes() */ 1527caa639f4Sdrh int aLimit[SQLITE_N_LIMIT]; /* Limits */ 15288930c2abSdan int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */ 15294adee20fSdanielk1977 struct sqlite3InitInfo { /* Information used during initialization */ 1530abc38158Sdrh Pgno newTnum; /* Rootpage of table being initialized */ 1531a451017dSdrh u8 iDb; /* Which db file is being initialized */ 15321d85d931Sdrh u8 busy; /* TRUE if currently initializing */ 1533e616735cSdrh unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */ 1534e616735cSdrh unsigned imposterTable : 1; /* Building an imposter table */ 1535e616735cSdrh unsigned reopenMemdb : 1; /* ATTACH is really a reopen using MemDB */ 1536c5a93d4cSdrh char **azInit; /* "type", "name", and "tbl_name" columns */ 15371d85d931Sdrh } init; 15381713afb0Sdrh int nVdbeActive; /* Number of VDBEs currently running */ 15394f7d3a5fSdrh int nVdbeRead; /* Number of active VDBEs that read or write */ 15404f7d3a5fSdrh int nVdbeWrite; /* Number of active VDBEs that read and write */ 15414f7d3a5fSdrh int nVdbeExec; /* Number of nested calls to VdbeExec() */ 1542086723a4Sdrh int nVDestroy; /* Number of active OP_VDestroy operations */ 1543a451017dSdrh int nExtension; /* Number of loaded extensions */ 1544a451017dSdrh void **aExtension; /* Array of shared library handles */ 154508b92086Sdrh union { 154608b92086Sdrh void (*xLegacy)(void*,const char*); /* Legacy trace function */ 154708b92086Sdrh int (*xV2)(u32,void*,void*,void*); /* V2 Trace function */ 154808b92086Sdrh } trace; 154918de4824Sdrh void *pTraceArg; /* Argument to the trace function */ 155004c6747aSdrh #ifndef SQLITE_OMIT_DEPRECATED 155119e2d37fSdrh void (*xProfile)(void*,const char*,u64); /* Profiling function */ 155219e2d37fSdrh void *pProfileArg; /* Argument to profile function */ 155304c6747aSdrh #endif 1554fcd35c7bSdrh void *pCommitArg; /* Argument to xCommitCallback() */ 1555fcd35c7bSdrh int (*xCommitCallback)(void*); /* Invoked at every commit. */ 155671fd80bfSdanielk1977 void *pRollbackArg; /* Argument to xRollbackCallback() */ 155771fd80bfSdanielk1977 void (*xRollbackCallback)(void*); /* Invoked at every commit. */ 155894eb6a14Sdanielk1977 void *pUpdateArg; 155994eb6a14Sdanielk1977 void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64); 15601cf19758Sdrh Parse *pParse; /* Current parse */ 15619b1c62d4Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK 156246c47d46Sdan void *pPreUpdateArg; /* First argument to xPreUpdateCallback */ 156346c47d46Sdan void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */ 156446c47d46Sdan void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64 156546c47d46Sdan ); 156646c47d46Sdan PreUpdate *pPreUpdate; /* Context for active pre-update callback */ 15679b1c62d4Sdrh #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */ 15685cf53537Sdan #ifndef SQLITE_OMIT_WAL 15697ed91f23Sdrh int (*xWalCallback)(void *, sqlite3 *, const char *, int); 15707ed91f23Sdrh void *pWalArg; 15715cf53537Sdan #endif 1572fcd35c7bSdrh void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*); 1573fcd35c7bSdrh void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*); 1574fcd35c7bSdrh void *pCollNeededArg; 1575fcd35c7bSdrh sqlite3_value *pErr; /* Most recent error message */ 1576881feaa0Sdrh union { 157739001e75Sdrh volatile int isInterrupted; /* True if sqlite3_interrupt has been called */ 1578881feaa0Sdrh double notUsed1; /* Spacer */ 1579881feaa0Sdrh } u1; 1580633e6d57Sdrh Lookaside lookaside; /* Lookaside malloc configuration */ 1581ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 158232c6a48bSdrh sqlite3_xauth xAuth; /* Access authorization function */ 1583ed6c8671Sdrh void *pAuthArg; /* 1st argument to the access auth function */ 1584ed6c8671Sdrh #endif 1585348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK 1586348bb5d6Sdanielk1977 int (*xProgress)(void *); /* The progress callback */ 1587348bb5d6Sdanielk1977 void *pProgressArg; /* Argument to the progress callback */ 15888f8c65f7Sdrh unsigned nProgressOps; /* Number of opcodes for progress callback */ 1589348bb5d6Sdanielk1977 #endif 1590b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 1591a451017dSdrh int nVTrans; /* Allocated size of aVTrans */ 1592b9bb7c18Sdrh Hash aModule; /* populated by sqlite3_create_module() */ 1593b061d058Sdan VtabCtx *pVtabCtx; /* Context for active vtab connect/create */ 1594595a523aSdanielk1977 VTable **aVTrans; /* Virtual tables with open transactions */ 1595595a523aSdanielk1977 VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */ 15966b456a2bSdanielk1977 #endif 159780738d9cSdrh Hash aFunc; /* Hash table of connection functions */ 1598fcd35c7bSdrh Hash aCollSeq; /* All collating sequences */ 1599fcd35c7bSdrh BusyHandler busyHandler; /* Busy callback */ 1600fcd35c7bSdrh Db aDbStatic[2]; /* Static space for the 2 default backends */ 1601fd7f0452Sdanielk1977 Savepoint *pSavepoint; /* List of active savepoints */ 160249a76a8fSdrh int nAnalysisLimit; /* Number of index rows to ANALYZE */ 1603a451017dSdrh int busyTimeout; /* Busy handler timeout, in msec */ 1604fd7f0452Sdanielk1977 int nSavepoint; /* Number of non-transaction savepoints */ 1605bd43455cSdanielk1977 int nStatement; /* Number of nested statement-transactions */ 16061da40a38Sdan i64 nDeferredCons; /* Net deferred constraints this transaction. */ 1607648e2643Sdrh i64 nDeferredImmCons; /* Net deferred immediate constraints */ 1608d46def77Sdan int *pnBytesFreed; /* If not NULL, increment this in DbFree() */ 1609404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 1610ccb2113aSdrh /* The following variables are all protected by the STATIC_MAIN 1611404ca075Sdanielk1977 ** mutex, not by sqlite3.mutex. They are used by code in notify.c. 161265a73badSdrh ** 161365a73badSdrh ** When X.pUnlockConnection==Y, that means that X is waiting for Y to 161465a73badSdrh ** unlock so that it can proceed. 161565a73badSdrh ** 161665a73badSdrh ** When X.pBlockingConnection==Y, that means that something that X tried 161765a73badSdrh ** tried to do recently failed with an SQLITE_LOCKED error due to locks 161865a73badSdrh ** held by Y. 1619404ca075Sdanielk1977 */ 1620404ca075Sdanielk1977 sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */ 1621404ca075Sdanielk1977 sqlite3 *pUnlockConnection; /* Connection to watch for unlock */ 1622404ca075Sdanielk1977 void *pUnlockArg; /* Argument to xUnlockNotify */ 1623404ca075Sdanielk1977 void (*xUnlockNotify)(void **, int); /* Unlock notify callback */ 1624404ca075Sdanielk1977 sqlite3 *pNextBlocked; /* Next in list of all blocked connections */ 1625404ca075Sdanielk1977 #endif 1626d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION 1627d4530979Sdrh sqlite3_userauth auth; /* User authentication information */ 1628d4530979Sdrh #endif 162975897234Sdrh }; 163075897234Sdrh 163103b808a6Sdrh /* 163203b808a6Sdrh ** A macro to discover the encoding of a database. 163303b808a6Sdrh */ 16349bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc) 16359bd3cc46Sdrh #define ENC(db) ((db)->enc) 163614db2665Sdanielk1977 163775897234Sdrh /* 1638b945bcdaSdrh ** A u64 constant where the lower 32 bits are all zeros. Only the 1639b945bcdaSdrh ** upper 32 bits are included in the argument. Necessary because some 1640b945bcdaSdrh ** C-compilers still do not accept LL integer literals. 1641b945bcdaSdrh */ 1642b945bcdaSdrh #define HI(X) ((u64)(X)<<32) 1643b945bcdaSdrh 1644b945bcdaSdrh /* 164507096f68Sdrh ** Possible values for the sqlite3.flags. 164649711600Sdrh ** 164749711600Sdrh ** Value constraints (enforced via assert()): 164849711600Sdrh ** SQLITE_FullFSync == PAGER_FULLFSYNC 164949711600Sdrh ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC 165049711600Sdrh ** SQLITE_CacheSpill == PAGER_CACHE_SPILL 165175897234Sdrh */ 1652ccb2113aSdrh #define SQLITE_WriteSchema 0x00000001 /* OK to update SQLITE_SCHEMA */ 1653169dd928Sdrh #define SQLITE_LegacyFileFmt 0x00000002 /* Create new databases in format 1 */ 16546841b1cbSdrh #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */ 16556841b1cbSdrh #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */ 16566841b1cbSdrh #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */ 16576841b1cbSdrh #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */ 165840c3941cSdrh #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */ 1659b77da374Sdrh #define SQLITE_TrustedSchema 0x00000080 /* Allow unsafe functions and 16602928a15bSdrh ** vtabs in the schema definition */ 166167c82653Sdrh #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */ 166267c82653Sdrh /* result set is empty */ 1663169dd928Sdrh #define SQLITE_IgnoreChecks 0x00000200 /* Do not enforce check constraints */ 1664169dd928Sdrh #define SQLITE_ReadUncommit 0x00000400 /* READ UNCOMMITTED in shared-cache */ 1665169dd928Sdrh #define SQLITE_NoCkptOnClose 0x00000800 /* No checkpoint on close()/DETACH */ 1666169dd928Sdrh #define SQLITE_ReverseOrder 0x00001000 /* Reverse unordered SELECTs */ 1667169dd928Sdrh #define SQLITE_RecTriggers 0x00002000 /* Enable recursive triggers */ 1668169dd928Sdrh #define SQLITE_ForeignKeys 0x00004000 /* Enforce foreign key constraints */ 1669169dd928Sdrh #define SQLITE_AutoIndex 0x00008000 /* Enable automatic indexes */ 1670169dd928Sdrh #define SQLITE_LoadExtension 0x00010000 /* Enable load_extension */ 16718257aa8dSdrh #define SQLITE_LoadExtFunc 0x00020000 /* Enable load_extension() SQL func */ 16728257aa8dSdrh #define SQLITE_EnableTrigger 0x00040000 /* True to enable triggers */ 16738257aa8dSdrh #define SQLITE_DeferFKs 0x00080000 /* Defer all FK constraints */ 16748257aa8dSdrh #define SQLITE_QueryOnly 0x00100000 /* Disable database changes */ 16758257aa8dSdrh #define SQLITE_CellSizeCk 0x00200000 /* Check btree cell sizes on load */ 16768257aa8dSdrh #define SQLITE_Fts3Tokenizer 0x00400000 /* Enable fts3_tokenizer(2) */ 16778257aa8dSdrh #define SQLITE_EnableQPSG 0x00800000 /* Query Planner Stability Guarantee*/ 167836e31c69Sdrh #define SQLITE_TriggerEQP 0x01000000 /* Show trigger EXPLAIN QUERY PLAN */ 16790314cf3aSdrh #define SQLITE_ResetDatabase 0x02000000 /* Reset the database */ 1680674b8942Sdan #define SQLITE_LegacyAlter 0x04000000 /* Legacy ALTER TABLE behaviour */ 1681fd748c64Sdrh #define SQLITE_NoSchemaError 0x08000000 /* Do not report schema parse errors*/ 1682a296cda0Sdrh #define SQLITE_Defensive 0x10000000 /* Input SQL is likely hostile */ 1683d0ff601cSdrh #define SQLITE_DqsDDL 0x20000000 /* dbl-quoted strings allowed in DDL*/ 1684d0ff601cSdrh #define SQLITE_DqsDML 0x40000000 /* dbl-quoted strings allowed in DML*/ 168511d88e68Sdrh #define SQLITE_EnableView 0x80000000 /* Enable the use of views */ 1686b945bcdaSdrh #define SQLITE_CountRows HI(0x00001) /* Count rows changed by INSERT, */ 1687b945bcdaSdrh /* DELETE, or UPDATE and return */ 1688b945bcdaSdrh /* the count using a callback. */ 168936e31c69Sdrh 1690169dd928Sdrh /* Flags used only if debugging */ 1691169dd928Sdrh #ifdef SQLITE_DEBUG 169211d88e68Sdrh #define SQLITE_SqlTrace HI(0x0100000) /* Debug print SQL as it executes */ 169311d88e68Sdrh #define SQLITE_VdbeListing HI(0x0200000) /* Debug listings of VDBE progs */ 169411d88e68Sdrh #define SQLITE_VdbeTrace HI(0x0400000) /* True to trace VDBE execution */ 169511d88e68Sdrh #define SQLITE_VdbeAddopTrace HI(0x0800000) /* Trace sqlite3VdbeAddOp() calls */ 169611d88e68Sdrh #define SQLITE_VdbeEQP HI(0x1000000) /* Debug EXPLAIN QUERY PLAN */ 169711d88e68Sdrh #define SQLITE_ParserTrace HI(0x2000000) /* PRAGMA parser_trace=ON */ 1698169dd928Sdrh #endif 1699b1eaa718Sdrh 17008257aa8dSdrh /* 17018257aa8dSdrh ** Allowed values for sqlite3.mDbFlags 17028257aa8dSdrh */ 17038257aa8dSdrh #define DBFLAG_SchemaChange 0x0001 /* Uncommitted Hash table changes */ 17048257aa8dSdrh #define DBFLAG_PreferBuiltin 0x0002 /* Preference to built-in funcs */ 17058257aa8dSdrh #define DBFLAG_Vacuum 0x0004 /* Currently in a VACUUM */ 17064e61e883Sdrh #define DBFLAG_VacuumInto 0x0008 /* Currently running VACUUM INTO */ 17074e61e883Sdrh #define DBFLAG_SchemaKnownOk 0x0010 /* Schema is known to be valid */ 1708171c50ecSdrh #define DBFLAG_InternalFunc 0x0020 /* Allow use of internal functions */ 17090ea2d42aSdan #define DBFLAG_EncodingFixed 0x0040 /* No longer possible to change enc. */ 171007096f68Sdrh 171107096f68Sdrh /* 17127e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the 17137e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to 17147e5418e4Sdrh ** selectively disable various optimizations. 171507096f68Sdrh */ 1716af7b7653Sdrh #define SQLITE_QueryFlattener 0x00000001 /* Query flattening */ 1717af7b7653Sdrh #define SQLITE_WindowFunc 0x00000002 /* Use xInverse for window functions */ 1718af7b7653Sdrh #define SQLITE_GroupByOrder 0x00000004 /* GROUPBY cover of ORDERBY */ 1719af7b7653Sdrh #define SQLITE_FactorOutConst 0x00000008 /* Constant factoring */ 1720af7b7653Sdrh #define SQLITE_DistinctOpt 0x00000010 /* DISTINCT using indexes */ 1721af7b7653Sdrh #define SQLITE_CoverIdxScan 0x00000020 /* Covering index scans */ 1722af7b7653Sdrh #define SQLITE_OrderByIdxJoin 0x00000040 /* ORDER BY of joins via index */ 1723af7b7653Sdrh #define SQLITE_Transitive 0x00000080 /* Transitive constraints */ 1724af7b7653Sdrh #define SQLITE_OmitNoopJoin 0x00000100 /* Omit unused tables in joins */ 1725af7b7653Sdrh #define SQLITE_CountOfView 0x00000200 /* The count-of-view optimization */ 1726af7b7653Sdrh #define SQLITE_CursorHints 0x00000400 /* Add OP_CursorHint opcodes */ 1727af7b7653Sdrh #define SQLITE_Stat4 0x00000800 /* Use STAT4 data */ 1728af7b7653Sdrh /* TH3 expects this value ^^^^^^^^^^ to be 0x0000800. Don't change it */ 1729af7b7653Sdrh #define SQLITE_PushDown 0x00001000 /* The push-down optimization */ 1730af7b7653Sdrh #define SQLITE_SimplifyJoin 0x00002000 /* Convert LEFT JOIN to JOIN */ 1731af7b7653Sdrh #define SQLITE_SkipScan 0x00004000 /* Skip-scans */ 1732af7b7653Sdrh #define SQLITE_PropagateConst 0x00008000 /* The constant propagation opt */ 1733af7b7653Sdrh #define SQLITE_MinMaxOpt 0x00010000 /* The min/max optimization */ 173419ef211dSdrh #define SQLITE_ExistsToIN 0x00020000 /* The EXISTS-to-IN optimization */ 1735af7b7653Sdrh #define SQLITE_AllOpts 0xffffffff /* All optimizations */ 17367e5418e4Sdrh 17377e5418e4Sdrh /* 17387e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled. 17397e5418e4Sdrh */ 17407e5418e4Sdrh #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0) 17417e5418e4Sdrh #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0) 174234c68fbaSdanielk1977 174358b9576bSdrh /* 1744d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization 1745d9f158e7Sdrh ** code. The argument is a Parse object for the code generator. 1746d9f158e7Sdrh */ 1747aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor) 1748d9f158e7Sdrh 1749d9f158e7Sdrh /* 1750247be43dSdrh ** Possible values for the sqlite.magic field. 1751247be43dSdrh ** The numbers are obtained at random and have no special meaning, other 1752247be43dSdrh ** than being distinct from one another. 1753247be43dSdrh */ 1754247be43dSdrh #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */ 1755247be43dSdrh #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */ 17567e8b848aSdrh #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */ 1757247be43dSdrh #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */ 1758247be43dSdrh #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */ 17594245c405Sdrh #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */ 1760247be43dSdrh 1761247be43dSdrh /* 17620bce8354Sdrh ** Each SQL function is defined by an instance of the following 176380738d9cSdrh ** structure. For global built-in functions (ex: substr(), max(), count()) 176480738d9cSdrh ** a pointer to this structure is held in the sqlite3BuiltinFunctions object. 176580738d9cSdrh ** For per-connection application-defined functions, a pointer to this 176680738d9cSdrh ** structure is held in the db->aHash hash table. 176780738d9cSdrh ** 176880738d9cSdrh ** The u.pHash field is used by the global built-ins. The u.pDestructor 176980738d9cSdrh ** field is used by per-connection app-def functions. 17702803757aSdrh */ 17710bce8354Sdrh struct FuncDef { 177280738d9cSdrh i8 nArg; /* Number of arguments. -1 means unlimited */ 1773dfa552f4Sdan u32 funcFlags; /* Some combination of SQLITE_FUNC_* */ 17741350b030Sdrh void *pUserData; /* User data parameter */ 17750bce8354Sdrh FuncDef *pNext; /* Next function with same name */ 17762d80151fSdrh void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */ 17772d80151fSdrh void (*xFinalize)(sqlite3_context*); /* Agg finalizer */ 177886fb6e17Sdan void (*xValue)(sqlite3_context*); /* Current agg value */ 177986fb6e17Sdan void (*xInverse)(sqlite3_context*,int,sqlite3_value**); /* inverse agg-step */ 17806ad224e9Sdrh const char *zName; /* SQL name of the function. */ 178180738d9cSdrh union { 178270a8ca3cSdrh FuncDef *pHash; /* Next with a different name but the same hash */ 1783d2199f0fSdan FuncDestructor *pDestructor; /* Reference counted destructor function */ 178480738d9cSdrh } u; 1785d2199f0fSdan }; 1786d2199f0fSdan 1787d2199f0fSdan /* 1788d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as 1789d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When 1790d2199f0fSdan ** create_function_v2() is called to create a function with a destructor, 1791d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to 1792d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether 1793d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor 1794d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated 1795d2199f0fSdan ** FuncDestructor. 1796d2199f0fSdan ** 1797d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference 1798d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor 1799d2199f0fSdan ** is invoked and the FuncDestructor structure freed. 1800d2199f0fSdan */ 1801d2199f0fSdan struct FuncDestructor { 1802d2199f0fSdan int nRef; 1803d2199f0fSdan void (*xDestroy)(void *); 1804d2199f0fSdan void *pUserData; 18058e0a2f90Sdrh }; 18062803757aSdrh 18072803757aSdrh /* 1808a748fdccSdrh ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF 18097977fa3aSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And 18107977fa3aSdrh ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There 1811a748fdccSdrh ** are assert() statements in the code to verify this. 181249711600Sdrh ** 181349711600Sdrh ** Value constraints (enforced via assert()): 181449711600Sdrh ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg 181549711600Sdrh ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG 181649711600Sdrh ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG 181749711600Sdrh ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API 181842d2fce7Sdrh ** SQLITE_FUNC_DIRECT == SQLITE_DIRECTONLY from the API 18194be621e1Sdrh ** SQLITE_FUNC_UNSAFE == SQLITE_INNOCUOUS 182049711600Sdrh ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API 18217d10d5a6Sdrh */ 18221d85e405Sdrh #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */ 18231d85e405Sdrh #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */ 18241d85e405Sdrh #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */ 18251d85e405Sdrh #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */ 18261d85e405Sdrh #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/ 18271d85e405Sdrh #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */ 18281d85e405Sdrh #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */ 18291d85e405Sdrh #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */ 1830ffe421c7Sdrh /* 0x0200 -- available for reuse */ 18311d85e405Sdrh #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */ 18321d85e405Sdrh #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */ 18339588ad95Sdrh #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */ 1834a7f910b5Sdrh #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a 1835a7f910b5Sdrh ** single query - might change over time */ 183625c4296bSdrh #define SQLITE_FUNC_TEST 0x4000 /* Built-in testing functions */ 1837092457b1Sdrh #define SQLITE_FUNC_OFFSET 0x8000 /* Built-in sqlite_offset() function */ 1838eea8eb6dSdrh #define SQLITE_FUNC_WINDOW 0x00010000 /* Built-in window-only function */ 1839eea8eb6dSdrh #define SQLITE_FUNC_INTERNAL 0x00040000 /* For use by NestedParse() only */ 184042d2fce7Sdrh #define SQLITE_FUNC_DIRECT 0x00080000 /* Not for use in TRIGGERs or VIEWs */ 1841e2ba6df9Sdan #define SQLITE_FUNC_SUBTYPE 0x00100000 /* Result likely to have sub-type */ 18424be621e1Sdrh #define SQLITE_FUNC_UNSAFE 0x00200000 /* Function has side effects */ 1843c4ad8499Sdrh #define SQLITE_FUNC_INLINE 0x00400000 /* Functions implemented in-line */ 1844c4ad8499Sdrh 184525c4296bSdrh /* Identifier numbers for each in-line function */ 1846171c50ecSdrh #define INLINEFUNC_coalesce 0 1847171c50ecSdrh #define INLINEFUNC_implies_nonnull_row 1 1848171c50ecSdrh #define INLINEFUNC_expr_implies_expr 2 1849171c50ecSdrh #define INLINEFUNC_expr_compare 3 1850171c50ecSdrh #define INLINEFUNC_affinity 4 18513c0e606bSdrh #define INLINEFUNC_iif 5 1852171c50ecSdrh #define INLINEFUNC_unlikely 99 /* Default case */ 18537d10d5a6Sdrh 18547d10d5a6Sdrh /* 1855777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are 1856777c5386Sdrh ** used to create the initializers for the FuncDef structures. 1857777c5386Sdrh ** 1858777c5386Sdrh ** FUNCTION(zName, nArg, iArg, bNC, xFunc) 1859777c5386Sdrh ** Used to create a scalar function definition of a function zName 1860777c5386Sdrh ** implemented by C function xFunc that accepts nArg arguments. The 1861777c5386Sdrh ** value passed as iArg is cast to a (void*) and made available 1862777c5386Sdrh ** as the user-data (sqlite3_user_data()) for the function. If 1863f7bca574Sdrh ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set. 1864777c5386Sdrh ** 1865b1fba286Sdrh ** VFUNCTION(zName, nArg, iArg, bNC, xFunc) 1866b1fba286Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag. 1867b1fba286Sdrh ** 186864de2a5fSdrh ** SFUNCTION(zName, nArg, iArg, bNC, xFunc) 186964de2a5fSdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 187064de2a5fSdrh ** adds the SQLITE_DIRECTONLY flag. 187164de2a5fSdrh ** 187225c4296bSdrh ** INLINE_FUNC(zName, nArg, iFuncId, mFlags) 187325c4296bSdrh ** zName is the name of a function that is implemented by in-line 187425c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 187525c4296bSdrh ** parameter determines the function id. The mFlags parameter is 187625c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 187725c4296bSdrh ** 187825c4296bSdrh ** TEST_FUNC(zName, nArg, iFuncId, mFlags) 187925c4296bSdrh ** zName is the name of a test-only function implemented by in-line 188025c4296bSdrh ** byte code rather than by the usual callbacks. The iFuncId 188125c4296bSdrh ** parameter determines the function id. The mFlags parameter is 188225c4296bSdrh ** optional SQLITE_FUNC_ flags for this function. 188325c4296bSdrh ** 18841d85e405Sdrh ** DFUNCTION(zName, nArg, iArg, bNC, xFunc) 18851d85e405Sdrh ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and 1886a7f910b5Sdrh ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions 188703bf26d9Sdrh ** and functions like sqlite_version() that can change, but not during 18883e34eabcSdrh ** a single query. The iArg is ignored. The user-data is always set 18893e34eabcSdrh ** to a NULL pointer. The bNC parameter is not used. 18903e34eabcSdrh ** 1891f6e904bdSdrh ** MFUNCTION(zName, nArg, xPtr, xFunc) 1892f6e904bdSdrh ** For math-library functions. xPtr is an arbitrary pointer. 1893f6e904bdSdrh ** 18943e34eabcSdrh ** PURE_DATE(zName, nArg, iArg, bNC, xFunc) 18953e34eabcSdrh ** Used for "pure" date/time functions, this macro is like DFUNCTION 18963e34eabcSdrh ** except that it does set the SQLITE_FUNC_CONSTANT flags. iArg is 18973e34eabcSdrh ** ignored and the user-data for these functions is set to an 18983e34eabcSdrh ** arbitrary non-NULL pointer. The bNC parameter is not used. 18991d85e405Sdrh ** 1900777c5386Sdrh ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal) 1901777c5386Sdrh ** Used to create an aggregate function definition implemented by 1902777c5386Sdrh ** the C functions xStep and xFinal. The first four parameters 1903777c5386Sdrh ** are interpreted in the same way as the first 4 parameters to 1904777c5386Sdrh ** FUNCTION(). 1905777c5386Sdrh ** 190686fb6e17Sdan ** WFUNCTION(zName, nArg, iArg, xStep, xFinal, xValue, xInverse) 190786fb6e17Sdan ** Used to create an aggregate function definition implemented by 190886fb6e17Sdan ** the C functions xStep and xFinal. The first four parameters 190986fb6e17Sdan ** are interpreted in the same way as the first 4 parameters to 191086fb6e17Sdan ** FUNCTION(). 191186fb6e17Sdan ** 1912777c5386Sdrh ** LIKEFUNC(zName, nArg, pArg, flags) 1913777c5386Sdrh ** Used to create a scalar function definition of a function zName 1914777c5386Sdrh ** that accepts nArg arguments and is implemented by a call to C 1915777c5386Sdrh ** function likeFunc. Argument pArg is cast to a (void *) and made 1916777c5386Sdrh ** available as the function user-data (sqlite3_user_data()). The 1917777c5386Sdrh ** FuncDef.flags variable is set to the value passed as the flags 1918777c5386Sdrh ** parameter. 1919777c5386Sdrh */ 1920777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19214be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 192286fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1923b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 1924d36e1041Sdrh {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 192586fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 192664de2a5fSdrh #define SFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 192779d5bc80Sdrh {nArg, SQLITE_UTF8|SQLITE_DIRECTONLY|SQLITE_FUNC_UNSAFE, \ 192864de2a5fSdrh SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 1929f6e904bdSdrh #define MFUNCTION(zName, nArg, xPtr, xFunc) \ 1930f6e904bdSdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8, \ 1931f6e904bdSdrh xPtr, 0, xFunc, 0, 0, 0, #zName, {0} } 193225c4296bSdrh #define INLINE_FUNC(zName, nArg, iArg, mFlags) \ 19334be621e1Sdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 193425c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 193525c4296bSdrh #define TEST_FUNC(zName, nArg, iArg, mFlags) \ 193625c4296bSdrh {nArg, SQLITE_UTF8|SQLITE_FUNC_INTERNAL|SQLITE_FUNC_TEST| \ 19374be621e1Sdrh SQLITE_FUNC_INLINE|SQLITE_FUNC_CONSTANT|(mFlags), \ 193825c4296bSdrh SQLITE_INT_TO_PTR(iArg), 0, noopFunc, 0, 0, 0, #zName, {0} } 19391d85e405Sdrh #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \ 19404be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \ 194186fb6e17Sdan 0, 0, xFunc, 0, 0, 0, #zName, {0} } 19423e34eabcSdrh #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \ 19434be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 194486fb6e17Sdan (void*)&sqlite3Config, 0, xFunc, 0, 0, 0, #zName, {0} } 1945a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \ 19464be621e1Sdrh {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\ 194786fb6e17Sdan SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} } 194821717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \ 19494be621e1Sdrh {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \ 195086fb6e17Sdan pArg, 0, xFunc, 0, 0, 0, #zName, } 1951777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \ 19524be621e1Sdrh {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \ 195386fb6e17Sdan (void *)arg, 0, likeFunc, 0, 0, 0, #zName, {0} } 19546fb2b54cSdan #define WAGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue, xInverse, f) \ 19556fb2b54cSdan {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|f, \ 195603854d2eSdan SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,xInverse,#zName, {0}} 1957eea8eb6dSdrh #define INTERNAL_FUNCTION(zName, nArg, xFunc) \ 1958eea8eb6dSdrh {nArg, SQLITE_FUNC_INTERNAL|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \ 1959eea8eb6dSdrh 0, 0, xFunc, 0, 0, 0, #zName, {0} } 1960eea8eb6dSdrh 1961777c5386Sdrh 1962fd7f0452Sdanielk1977 /* 1963fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at 1964fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently 1965fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe 1966fd7f0452Sdanielk1977 ** OP_Savepoint instruction. 1967fd7f0452Sdanielk1977 */ 1968fd7f0452Sdanielk1977 struct Savepoint { 1969fd7f0452Sdanielk1977 char *zName; /* Savepoint name (nul-terminated) */ 1970fcb9f7adSdrh i64 nDeferredCons; /* Number of deferred fk violations */ 1971648e2643Sdrh i64 nDeferredImmCons; /* Number of deferred imm fk. */ 1972fd7f0452Sdanielk1977 Savepoint *pNext; /* Parent savepoint (if any) */ 1973fd7f0452Sdanielk1977 }; 1974fd7f0452Sdanielk1977 1975fd7f0452Sdanielk1977 /* 1976fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(), 1977fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction. 1978fd7f0452Sdanielk1977 */ 1979fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN 0 1980fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE 1 1981fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK 2 1982fd7f0452Sdanielk1977 1983777c5386Sdrh 1984777c5386Sdrh /* 1985d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an 1986d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule 1987d1ab1ba5Sdanielk1977 ** hash table. 1988d1ab1ba5Sdanielk1977 */ 1989d1ab1ba5Sdanielk1977 struct Module { 1990d1ab1ba5Sdanielk1977 const sqlite3_module *pModule; /* Callback pointers */ 1991d1ab1ba5Sdanielk1977 const char *zName; /* Name passed to create_module() */ 1992cc5979dbSdrh int nRefModule; /* Number of pointers to this object */ 1993d1ab1ba5Sdanielk1977 void *pAux; /* pAux passed to create_module() */ 1994832a58a6Sdanielk1977 void (*xDestroy)(void *); /* Module destructor function */ 199551be3873Sdrh Table *pEpoTab; /* Eponymous table for this module */ 1996d1ab1ba5Sdanielk1977 }; 1997d1ab1ba5Sdanielk1977 1998d1ab1ba5Sdanielk1977 /* 1999b9bcf7caSdrh ** Information about each column of an SQL table is held in an instance 2000b9bcf7caSdrh ** of the Column structure, in the Table.aCol[] array. 2001b9bcf7caSdrh ** 2002b9bcf7caSdrh ** Definitions: 2003b9bcf7caSdrh ** 2004b9bcf7caSdrh ** "table column index" This is the index of the column in the 2005b9bcf7caSdrh ** Table.aCol[] array, and also the index of 2006b9bcf7caSdrh ** the column in the original CREATE TABLE stmt. 2007b9bcf7caSdrh ** 2008b9bcf7caSdrh ** "storage column index" This is the index of the column in the 2009b9bcf7caSdrh ** record BLOB generated by the OP_MakeRecord 2010b9bcf7caSdrh ** opcode. The storage column index is less than 2011b9bcf7caSdrh ** or equal to the table column index. It is 2012b9bcf7caSdrh ** equal if and only if there are no VIRTUAL 2013b9bcf7caSdrh ** columns to the left. 20147020f651Sdrh */ 20157020f651Sdrh struct Column { 201694eaafa9Sdrh char *zName; /* Name of this column, \000, then the type */ 201781f7b372Sdrh Expr *pDflt; /* Default value or GENERATED ALWAYS AS value */ 2018b3bf556eSdanielk1977 char *zColl; /* Collating sequence. If NULL, use the default */ 2019a371ace4Sdrh u8 notNull; /* An OE_ code for handling a NOT NULL constraint */ 2020a37cdde0Sdanielk1977 char affinity; /* One of the SQLITE_AFF_... values */ 2021e5520e2fSdrh u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */ 2022d44390c8Sdrh u8 hName; /* Column name hash for faster lookup */ 20239942ef0dSdrh u16 colFlags; /* Boolean properties. See COLFLAG_ defines below */ 20247020f651Sdrh }; 20257020f651Sdrh 20266f6e60ddSdrh /* Allowed values for Column.colFlags. 20276f6e60ddSdrh ** 20286f6e60ddSdrh ** Constraints: 20296f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 20306f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 20316f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 2032a371ace4Sdrh */ 2033a371ace4Sdrh #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */ 2034a371ace4Sdrh #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */ 2035d7564865Sdrh #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */ 203626e731ccSdan #define COLFLAG_UNIQUE 0x0008 /* Column def contains "UNIQUE" or "PK" */ 20372e3a5a81Sdan #define COLFLAG_SORTERREF 0x0010 /* Use sorter-refs with this column */ 203881f7b372Sdrh #define COLFLAG_VIRTUAL 0x0020 /* GENERATED ALWAYS AS ... VIRTUAL */ 203981f7b372Sdrh #define COLFLAG_STORED 0x0040 /* GENERATED ALWAYS AS ... STORED */ 204012bf7127Sdrh #define COLFLAG_NOTAVAIL 0x0080 /* STORED column not yet calculated */ 204112bf7127Sdrh #define COLFLAG_BUSY 0x0100 /* Blocks recursion on GENERATED columns */ 2042c27ea2aeSdrh #define COLFLAG_GENERATED 0x0060 /* Combo: _STORED, _VIRTUAL */ 20437e508f1eSdrh #define COLFLAG_NOINSERT 0x0062 /* Combo: _HIDDEN, _STORED, _VIRTUAL */ 2044a371ace4Sdrh 20457020f651Sdrh /* 2046a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following 20470202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and 20480202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence. 2049a9fd84b0Sdrh ** 2050e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the 20510202b29eSdanielk1977 ** collating sequence is undefined. Indices built on an undefined 20520202b29eSdanielk1977 ** collating sequence may not be read or written. 2053a9fd84b0Sdrh */ 2054a9fd84b0Sdrh struct CollSeq { 20550202b29eSdanielk1977 char *zName; /* Name of the collating sequence, UTF-8 encoded */ 2056466be56bSdanielk1977 u8 enc; /* Text encoding handled by xCmp() */ 2057a9fd84b0Sdrh void *pUser; /* First argument to xCmp() */ 20580202b29eSdanielk1977 int (*xCmp)(void*,int, const void*, int, const void*); 2059a9808b31Sdanielk1977 void (*xDel)(void*); /* Destructor for pUser */ 2060a9fd84b0Sdrh }; 2061a9fd84b0Sdrh 2062a9fd84b0Sdrh /* 2063d3d39e93Sdrh ** A sort order can be either ASC or DESC. 20648e2ca029Sdrh */ 20658e2ca029Sdrh #define SQLITE_SO_ASC 0 /* Sort in ascending order */ 2066d3d39e93Sdrh #define SQLITE_SO_DESC 1 /* Sort in ascending order */ 2067bc622bc0Sdrh #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */ 20688e2ca029Sdrh 20698e2ca029Sdrh /* 2070a37cdde0Sdanielk1977 ** Column affinity types. 20718a51256cSdrh ** 20728a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and 20738a51256cSdrh ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve 20747d10d5a6Sdrh ** the speed a little by numbering the values consecutively. 20758a51256cSdrh ** 20764583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'. That way, 20778a51256cSdrh ** when multiple affinity types are concatenated into a string and 207866a5167bSdrh ** used as the P4 operand, they will be more readable. 20798a51256cSdrh ** 20808a51256cSdrh ** Note also that the numeric types are grouped together so that testing 208105883a34Sdrh ** for a numeric type is a single comparison. And the BLOB type is first. 2082a37cdde0Sdanielk1977 */ 208396fb16eeSdrh #define SQLITE_AFF_NONE 0x40 /* '@' */ 208496fb16eeSdrh #define SQLITE_AFF_BLOB 0x41 /* 'A' */ 208596fb16eeSdrh #define SQLITE_AFF_TEXT 0x42 /* 'B' */ 208696fb16eeSdrh #define SQLITE_AFF_NUMERIC 0x43 /* 'C' */ 208796fb16eeSdrh #define SQLITE_AFF_INTEGER 0x44 /* 'D' */ 208896fb16eeSdrh #define SQLITE_AFF_REAL 0x45 /* 'E' */ 2089a37cdde0Sdanielk1977 20908a51256cSdrh #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC) 2091a37cdde0Sdanielk1977 2092a37cdde0Sdanielk1977 /* 209335573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an 209435573356Sdrh ** affinity value. 209535573356Sdrh */ 20964583c37cSdrh #define SQLITE_AFF_MASK 0x47 209735573356Sdrh 209835573356Sdrh /* 209935573356Sdrh ** Additional bit values that can be ORed with an affinity without 210035573356Sdrh ** changing the affinity. 21013d77dee9Sdrh ** 21023d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL. 21033d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison 21043d77dee9Sdrh ** operator is NULL. It is added to certain comparison operators to 21053d77dee9Sdrh ** prove that the operands are always NOT NULL. 210635573356Sdrh */ 210779752b6eSdrh #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */ 21084583c37cSdrh #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */ 21094583c37cSdrh #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */ 21106a2fe093Sdrh #define SQLITE_NULLEQ 0x80 /* NULL=NULL */ 21114583c37cSdrh #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */ 211235573356Sdrh 211335573356Sdrh /* 2114595a523aSdanielk1977 ** An object of this type is created for each virtual table present in 2115595a523aSdanielk1977 ** the database schema. 2116595a523aSdanielk1977 ** 2117595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this 2118595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared 2119595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique 2120595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table 2121595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between 2122595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database 2123595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database 2124595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method 2125595a523aSdanielk1977 ** during initialization internally. This database connection handle may 21269bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables 2127595a523aSdanielk1977 ** within the database. So that they appear as part of the callers 2128595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database 2129595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table. 2130595a523aSdanielk1977 ** 2131595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared 2132595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by 2133595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object. 2134595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual 2135595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the 2136595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct 2137595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query. 2138595a523aSdanielk1977 ** 2139595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the 2140595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not 2141595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed 2142595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to 2143595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the 2144595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected 2145595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done 2146595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes. 2147595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an 2148595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect 2149595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex. 2150595a523aSdanielk1977 ** 2151595a523aSdanielk1977 ** The memory for objects of this type is always allocated by 2152595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as 2153595a523aSdanielk1977 ** the first argument. 2154595a523aSdanielk1977 */ 2155595a523aSdanielk1977 struct VTable { 2156595a523aSdanielk1977 sqlite3 *db; /* Database connection associated with this table */ 2157595a523aSdanielk1977 Module *pMod; /* Pointer to module implementation */ 2158595a523aSdanielk1977 sqlite3_vtab *pVtab; /* Pointer to vtab instance */ 2159595a523aSdanielk1977 int nRef; /* Number of pointers to this structure */ 2160b061d058Sdan u8 bConstraint; /* True if constraints are supported */ 21612928a15bSdrh u8 eVtabRisk; /* Riskiness of allowing hacker access */ 2162addd8f87Sdrh int iSavepoint; /* Depth of the SAVEPOINT stack */ 2163595a523aSdanielk1977 VTable *pNext; /* Next in linked list (see above) */ 2164595a523aSdanielk1977 }; 2165595a523aSdanielk1977 21662928a15bSdrh /* Allowed values for VTable.eVtabRisk 21672928a15bSdrh */ 21682928a15bSdrh #define SQLITE_VTABRISK_Low 0 21692928a15bSdrh #define SQLITE_VTABRISK_Normal 1 21702928a15bSdrh #define SQLITE_VTABRISK_High 2 21712928a15bSdrh 2172595a523aSdanielk1977 /* 21735789d1a4Sdrh ** The schema for each SQL table and view is represented in memory 21745789d1a4Sdrh ** by an instance of the following structure. 217575897234Sdrh */ 217675897234Sdrh struct Table { 21777d10d5a6Sdrh char *zName; /* Name of the table or view */ 21787020f651Sdrh Column *aCol; /* Information about each column */ 2179967e8b73Sdrh Index *pIndex; /* List of SQL indexes on this table. */ 2180a76b5dfcSdrh Select *pSelect; /* NULL for tables. Points to definition if a view. */ 2181c2eef3b3Sdrh FKey *pFKey; /* Linked list of all foreign keys in this table */ 21823d1bfeaaSdanielk1977 char *zColAff; /* String defining the affinity of each column */ 21832938f924Sdrh ExprList *pCheck; /* All CHECK constraints */ 21848981b904Sdrh /* ... also used as column name list in a VIEW */ 2185abc38158Sdrh Pgno tnum; /* Root BTree page for this table */ 218679df7782Sdrh u32 nTabRef; /* Number of pointers to this Table */ 21876f271a42Sdrh u32 tabFlags; /* Mask of TF_* values */ 21885789d1a4Sdrh i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */ 2189d815f17dSdrh i16 nCol; /* Number of columns in this table */ 21900b0b3a95Sdrh i16 nNVCol; /* Number of columns that are not VIRTUAL */ 21915789d1a4Sdrh LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */ 2192bf539c4dSdrh LogEst szTabRow; /* Estimated size of each table row in bytes */ 2193dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT 2194dbd9486dSdrh LogEst costMult; /* Cost multiplier for using this table */ 2195dbd9486dSdrh #endif 2196d815f17dSdrh u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */ 219719a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE 21987d10d5a6Sdrh int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */ 219919a8e7e8Sdanielk1977 #endif 2200e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 2201b9bb7c18Sdrh int nModuleArg; /* Number of arguments to the module */ 22028a48b9c0Sdrh char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */ 2203d815f17dSdrh VTable *pVTable; /* List of VTable objects. */ 2204e09daa90Sdrh #endif 22052f886d1dSdanielk1977 Trigger *pTrigger; /* List of triggers stored in pSchema */ 2206728b5779Sdrh Schema *pSchema; /* Schema that contains this table */ 220775897234Sdrh }; 220875897234Sdrh 220975897234Sdrh /* 22108ce7184bSdan ** Allowed values for Table.tabFlags. 2211a21f78b9Sdrh ** 221280090f92Sdrh ** TF_OOOHidden applies to tables or view that have hidden columns that are 2213a21f78b9Sdrh ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING 2214a21f78b9Sdrh ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden, 2215a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case. Such tables require 2216c1431144Sdrh ** special handling during INSERT processing. The "OOO" means "Out Of Order". 2217c1431144Sdrh ** 2218c1431144Sdrh ** Constraints: 2219c1431144Sdrh ** 22206f6e60ddSdrh ** TF_HasVirtual == COLFLAG_VIRTUAL 22216f6e60ddSdrh ** TF_HasStored == COLFLAG_STORED 22226f6e60ddSdrh ** TF_HasHidden == COLFLAG_HIDDEN 22237d10d5a6Sdrh */ 222433bec3f5Sdrh #define TF_Readonly 0x0001 /* Read-only system table */ 22256f6e60ddSdrh #define TF_HasHidden 0x0002 /* Has one or more hidden columns */ 222633bec3f5Sdrh #define TF_HasPrimaryKey 0x0004 /* Table has a primary key */ 222733bec3f5Sdrh #define TF_Autoincrement 0x0008 /* Integer primary key is autoincrement */ 2228a3928dd7Sdrh #define TF_HasStat1 0x0010 /* nRowLogEst set from sqlite_stat1 */ 2229c1431144Sdrh #define TF_HasVirtual 0x0020 /* Has one or more VIRTUAL columns */ 2230c1431144Sdrh #define TF_HasStored 0x0040 /* Has one or more STORED columns */ 2231427b96aeSdrh #define TF_HasGenerated 0x0060 /* Combo: HasVirtual + HasStored */ 2232c1431144Sdrh #define TF_WithoutRowid 0x0080 /* No rowid. PRIMARY KEY is the key */ 22335e98e838Sdrh #define TF_StatsUsed 0x0100 /* Query planner decisions affected by 2234a3928dd7Sdrh ** Index.aiRowLogEst[] values */ 2235c1431144Sdrh #define TF_NoVisibleRowid 0x0200 /* No user-visible "rowid" column */ 2236c1431144Sdrh #define TF_OOOHidden 0x0400 /* Out-of-Order hidden columns */ 2237c1431144Sdrh #define TF_HasNotNull 0x0800 /* Contains NOT NULL constraints */ 2238c1431144Sdrh #define TF_Shadow 0x1000 /* True for a shadow table */ 223940386968Sdrh #define TF_HasStat4 0x2000 /* STAT4 info available for this table */ 22406f6e60ddSdrh #define TF_Ephemeral 0x4000 /* An ephemeral table */ 22417d10d5a6Sdrh 22427d10d5a6Sdrh /* 22434cbdda9eSdrh ** Test to see whether or not a table is a virtual table. This is 22444cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual 22454cbdda9eSdrh ** table support is omitted from the build. 22464cbdda9eSdrh */ 22474cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 224844266ec6Sdrh # define IsVirtual(X) ((X)->nModuleArg) 224978d1d225Sdrh # define ExprIsVtab(X) \ 225078d1d225Sdrh ((X)->op==TK_COLUMN && (X)->y.pTab!=0 && (X)->y.pTab->nModuleArg) 22514cbdda9eSdrh #else 22524cbdda9eSdrh # define IsVirtual(X) 0 225378d1d225Sdrh # define ExprIsVtab(X) 0 22544cbdda9eSdrh #endif 22554cbdda9eSdrh 225603d69a68Sdrh /* 225703d69a68Sdrh ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn() 225803d69a68Sdrh ** only works for non-virtual tables (ordinary tables and views) and is 225903d69a68Sdrh ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The 226003d69a68Sdrh ** IsHiddenColumn() macro is general purpose. 226103d69a68Sdrh */ 226203d69a68Sdrh #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS) 226303d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 226403d69a68Sdrh # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 226518f8e734Sdrh #elif !defined(SQLITE_OMIT_VIRTUALTABLE) 226603d69a68Sdrh # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0) 226703d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 226803d69a68Sdrh #else 226903d69a68Sdrh # define IsHiddenColumn(X) 0 227003d69a68Sdrh # define IsOrdinaryHiddenColumn(X) 0 227103d69a68Sdrh #endif 227203d69a68Sdrh 227303d69a68Sdrh 2274ec95c441Sdrh /* Does the table have a rowid */ 2275ec95c441Sdrh #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0) 2276fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0) 2277ec95c441Sdrh 22784cbdda9eSdrh /* 2279c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure. 2280c2eef3b3Sdrh ** 2281c2eef3b3Sdrh ** A foreign key is associated with two tables. The "from" table is 2282c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign 2283c2eef3b3Sdrh ** key. The "to" table is the table that is named in the REFERENCES clause. 2284c2eef3b3Sdrh ** Consider this example: 2285c2eef3b3Sdrh ** 2286c2eef3b3Sdrh ** CREATE TABLE ex1( 2287c2eef3b3Sdrh ** a INTEGER PRIMARY KEY, 2288c2eef3b3Sdrh ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x) 2289c2eef3b3Sdrh ** ); 2290c2eef3b3Sdrh ** 2291c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2". 2292bd50a926Sdrh ** Equivalent names: 2293bd50a926Sdrh ** 2294bd50a926Sdrh ** from-table == child-table 2295bd50a926Sdrh ** to-table == parent-table 2296c2eef3b3Sdrh ** 2297c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure 2298c2eef3b3Sdrh ** which is attached to the from-table. The to-table need not exist when 2299e61922a6Sdrh ** the from-table is created. The existence of the to-table is not checked. 2300bd50a926Sdrh ** 2301bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey. 2302bd50a926Sdrh ** 2303bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist) 2304bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z. 2305c2eef3b3Sdrh */ 2306c2eef3b3Sdrh struct FKey { 23071f638cebSdrh Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */ 2308bd50a926Sdrh FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */ 23091f638cebSdrh char *zTo; /* Name of table that the key points to (aka: Parent) */ 2310bd50a926Sdrh FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */ 2311bd50a926Sdrh FKey *pPrevTo; /* Previous with the same zTo */ 2312c2eef3b3Sdrh int nCol; /* Number of columns in this key */ 23134c429839Sdrh /* EV: R-30323-21917 */ 2314c2eef3b3Sdrh u8 isDeferred; /* True if constraint checking is deferred till COMMIT */ 23158099ce6fSdan u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */ 23168099ce6fSdan Trigger *apTrigger[2];/* Triggers for aAction[] actions */ 2317e61922a6Sdrh struct sColMap { /* Mapping of columns in pFrom to columns in zTo */ 2318e61922a6Sdrh int iFrom; /* Index of column in pFrom */ 2319bd50a926Sdrh char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */ 2320e61922a6Sdrh } aCol[1]; /* One entry for each of nCol columns */ 2321c2eef3b3Sdrh }; 2322c2eef3b3Sdrh 2323c2eef3b3Sdrh /* 2324aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint 232522f70c32Sdrh ** error. ROLLBACK processing means that a constraint violation 23260bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction 23271c92853dSdrh ** to be rolled back. ABORT processing means the operation in process 23281c92853dSdrh ** fails and any prior changes from that one operation are backed out, 23291c92853dSdrh ** but the transaction is not rolled back. FAIL processing means that 23301c92853dSdrh ** the operation in progress stops and returns an error code. But prior 23311c92853dSdrh ** changes due to the same operation are not backed out and no rollback 23321c92853dSdrh ** occurs. IGNORE means that the particular row that caused the constraint 23331c92853dSdrh ** error is not inserted or updated. Processing continues and no error 23341c92853dSdrh ** is returned. REPLACE means that preexisting database rows that caused 23351c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or 23361c92853dSdrh ** update can proceed. Processing continues and no error is reported. 23375602777eSdrh ** UPDATE applies to insert operations only and means that the insert 23385602777eSdrh ** is omitted and the DO UPDATE clause of an upsert is run instead. 23391c92853dSdrh ** 23405602777eSdrh ** RESTRICT, SETNULL, SETDFLT, and CASCADE actions apply only to foreign keys. 2341c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the 2342c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign 23435602777eSdrh ** key is set to NULL. SETDFLT means that the foreign key is set 23445602777eSdrh ** to its default value. CASCADE means that a DELETE or UPDATE of the 2345c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the 2346c2eef3b3Sdrh ** foreign key. 2347c2eef3b3Sdrh ** 23485602777eSdrh ** The OE_Default value is a place holder that means to use whatever 23495602777eSdrh ** conflict resolution algorthm is required from context. 23505602777eSdrh ** 2351968af52aSdrh ** The following symbolic values are used to record which type 23525602777eSdrh ** of conflict resolution action to take. 23539cfcf5d4Sdrh */ 23549cfcf5d4Sdrh #define OE_None 0 /* There is no constraint to check */ 23551c92853dSdrh #define OE_Rollback 1 /* Fail the operation and rollback the transaction */ 23561c92853dSdrh #define OE_Abort 2 /* Back out changes but do no rollback transaction */ 23571c92853dSdrh #define OE_Fail 3 /* Stop the operation but leave all prior changes */ 23581c92853dSdrh #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */ 23591c92853dSdrh #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */ 2360c8a0c90bSdrh #define OE_Update 6 /* Process as a DO UPDATE in an upsert */ 2361c8a0c90bSdrh #define OE_Restrict 7 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */ 2362c8a0c90bSdrh #define OE_SetNull 8 /* Set the foreign key value to NULL */ 2363c8a0c90bSdrh #define OE_SetDflt 9 /* Set the foreign key value to its default */ 2364c8a0c90bSdrh #define OE_Cascade 10 /* Cascade the changes */ 2365c8a0c90bSdrh #define OE_Default 11 /* Do whatever the default action is */ 23669cfcf5d4Sdrh 2367d3d39e93Sdrh 2368d3d39e93Sdrh /* 2369d3d39e93Sdrh ** An instance of the following structure is passed as the first 2370d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the 2371d3d39e93Sdrh ** comparison of the two index keys. 2372323df790Sdrh ** 2373323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots. There 2374323df790Sdrh ** are nField slots for the columns of an index then one extra slot 2375323df790Sdrh ** for the rowid at the end. 2376d3d39e93Sdrh */ 2377d3d39e93Sdrh struct KeyInfo { 23782ec2fb22Sdrh u32 nRef; /* Number of references to this KeyInfo object */ 23799b8d0272Sdrh u8 enc; /* Text encoding - one of the SQLITE_UTF* values */ 2380a485ad19Sdrh u16 nKeyField; /* Number of key columns in the index */ 2381a485ad19Sdrh u16 nAllField; /* Total columns, including key plus others */ 23822ec2fb22Sdrh sqlite3 *db; /* The database connection */ 23836e11892dSdan u8 *aSortFlags; /* Sort order for each column. */ 2384d3d39e93Sdrh CollSeq *aColl[1]; /* Collating sequence for each term of the key */ 2385d3d39e93Sdrh }; 2386d3d39e93Sdrh 2387905d4729Sdrh /* 2388905d4729Sdrh ** Allowed bit values for entries in the KeyInfo.aSortFlags[] array. 2389905d4729Sdrh */ 2390905d4729Sdrh #define KEYINFO_ORDER_DESC 0x01 /* DESC sort order */ 2391905d4729Sdrh #define KEYINFO_ORDER_BIGNULL 0x02 /* NULL is larger than any other value */ 23926e11892dSdan 23939cfcf5d4Sdrh /* 2394b1d607deSdrh ** This object holds a record which has been parsed out into individual 2395b1d607deSdrh ** fields, for the purposes of doing a comparison. 2396e63d9991Sdrh ** 2397e63d9991Sdrh ** A record is an object that contains one or more fields of data. 2398e63d9991Sdrh ** Records are used to store the content of a table row and to store 2399e63d9991Sdrh ** the key of an index. A blob encoding of a record is created by 2400467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the 2401e63d9991Sdrh ** OP_Column opcode. 2402e63d9991Sdrh ** 2403b1d607deSdrh ** An instance of this object serves as a "key" for doing a search on 2404b1d607deSdrh ** an index b+tree. The goal of the search is to find the entry that 2405b1d607deSdrh ** is closed to the key described by this object. This object might hold 2406b1d607deSdrh ** just a prefix of the key. The number of fields is given by 2407b1d607deSdrh ** pKeyInfo->nField. 24083833e934Sdan ** 2409b1d607deSdrh ** The r1 and r2 fields are the values to return if this key is less than 2410b1d607deSdrh ** or greater than a key in the btree, respectively. These are normally 2411b1d607deSdrh ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree 2412b1d607deSdrh ** is in DESC order. 2413b1d607deSdrh ** 2414b1d607deSdrh ** The key comparison functions actually return default_rc when they find 2415b1d607deSdrh ** an equals comparison. default_rc can be -1, 0, or +1. If there are 2416b1d607deSdrh ** multiple entries in the b-tree with the same key (when only looking 2417b1d607deSdrh ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to 2418b1d607deSdrh ** cause the search to find the last match, or +1 to cause the search to 2419b1d607deSdrh ** find the first match. 2420b1d607deSdrh ** 2421b1d607deSdrh ** The key comparison functions will set eqSeen to true if they ever 2422b1d607deSdrh ** get and equal results when comparing this structure to a b-tree record. 2423b1d607deSdrh ** When default_rc!=0, the search might end up on the record immediately 2424b1d607deSdrh ** before the first match or immediately after the last match. The 2425b1d607deSdrh ** eqSeen field will indicate whether or not an exact match exists in the 2426b1d607deSdrh ** b-tree. 2427e63d9991Sdrh */ 2428e63d9991Sdrh struct UnpackedRecord { 2429e63d9991Sdrh KeyInfo *pKeyInfo; /* Collation and sort-order information */ 243070528d78Sdrh Mem *aMem; /* Values */ 2431e63d9991Sdrh u16 nField; /* Number of entries in apMem[] */ 2432a9e0aeb5Sdrh i8 default_rc; /* Comparison result if keys are equal */ 243338fdead8Sdan u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */ 243461ffb2cdSdrh i8 r1; /* Value to return if (lhs < rhs) */ 243561ffb2cdSdrh i8 r2; /* Value to return if (lhs > rhs) */ 243670528d78Sdrh u8 eqSeen; /* True if an equality comparison has been seen */ 2437e63d9991Sdrh }; 2438e63d9991Sdrh 2439e63d9991Sdrh 2440e63d9991Sdrh /* 244166b89c8fSdrh ** Each SQL index is represented in memory by an 244275897234Sdrh ** instance of the following structure. 2443967e8b73Sdrh ** 2444967e8b73Sdrh ** The columns of the table that are to be indexed are described 2445967e8b73Sdrh ** by the aiColumn[] field of this structure. For example, suppose 2446967e8b73Sdrh ** we have the following table and index: 2447967e8b73Sdrh ** 2448967e8b73Sdrh ** CREATE TABLE Ex1(c1 int, c2 int, c3 text); 2449967e8b73Sdrh ** CREATE INDEX Ex2 ON Ex1(c3,c1); 2450967e8b73Sdrh ** 2451967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are 2452967e8b73Sdrh ** three columns in the table. In the Index structure describing 2453967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed. 2454967e8b73Sdrh ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the 2455967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[]. 2456967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in 2457967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0. 2458ea1ba17cSdrh ** 2459ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns 2460ea1ba17cSdrh ** must be unique and what to do if they are not. When Index.onError=OE_None, 2461ea1ba17cSdrh ** it means this is not a unique index. Otherwise it is a unique index 2462ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution 2463ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique 2464ea1ba17cSdrh ** element. 2465c5b73585Sdan ** 2466c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to 2467ccb2113aSdrh ** generate VDBE code (as opposed to parsing one read from an sqlite_schema 2468c5b73585Sdan ** table as part of parsing an existing database schema), transient instances 2469c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is 2470c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page 2471c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE 2472c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details. 247375897234Sdrh */ 247475897234Sdrh struct Index { 247575897234Sdrh char *zName; /* Name of this index */ 2476bbbdc83bSdrh i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */ 2477cfc9df76Sdan LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */ 2478967e8b73Sdrh Table *pTable; /* The SQL table being indexed */ 2479a37cdde0Sdanielk1977 char *zColAff; /* String defining the affinity of each column */ 248075897234Sdrh Index *pNext; /* The next index associated with the same table */ 2481b3bf556eSdanielk1977 Schema *pSchema; /* Schema containing this index */ 2482b376daebSdrh u8 *aSortOrder; /* for each column: True==DESC, False==ASC */ 2483f19aa5faSdrh const char **azColl; /* Array of collation sequence names for index */ 24841fe0537eSdrh Expr *pPartIdxWhere; /* WHERE clause for partial indices */ 24851f9ca2c8Sdrh ExprList *aColExpr; /* Column expressions */ 2486abc38158Sdrh Pgno tnum; /* DB Page containing root of this index */ 2487bf539c4dSdrh LogEst szIdxRow; /* Estimated average row size in bytes */ 2488bbbdc83bSdrh u16 nKeyCol; /* Number of columns forming the key */ 2489bbbdc83bSdrh u16 nColumn; /* Number of columns stored in the index */ 2490bf539c4dSdrh u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */ 24915f913ecbSdrh unsigned idxType:2; /* 0:Normal 1:UNIQUE, 2:PRIMARY KEY, 3:IPK */ 2492b376daebSdrh unsigned bUnordered:1; /* Use this index for == or IN queries only */ 24937699d1c4Sdrh unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */ 24947f9c5dbfSdrh unsigned isResized:1; /* True if resizeIndexObject() has been called */ 2495ec95c441Sdrh unsigned isCovering:1; /* True if this is a covering index */ 2496f9df2fbdSdrh unsigned noSkipScan:1; /* Do not try to use skip-scan if true */ 2497a3928dd7Sdrh unsigned hasStat1:1; /* aiRowLogEst values come from sqlite_stat1 */ 24987e8515d8Sdrh unsigned bNoQuery:1; /* Do not use this index to optimize queries */ 2499bf9ff256Sdrh unsigned bAscKeyBug:1; /* True if the bba7b69f9849b5bf bug applies */ 2500c7476735Sdrh unsigned bHasVCol:1; /* Index references one or more VIRTUAL columns */ 2501175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 25022b9cf669Sdrh int nSample; /* Number of elements in aSample[] */ 25038ad169abSdan int nSampleCol; /* Size of IndexSample.anEq[] and so on */ 2504eea568d6Sdan tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */ 2505faacf17cSdrh IndexSample *aSample; /* Samples of the left-most key */ 25069f07cf7bSdrh tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */ 25079f07cf7bSdrh tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */ 2508faacf17cSdrh #endif 25091fe3ac73Sdrh Bitmask colNotIdxed; /* 0 for unindexed columns in pTab */ 251002fa4696Sdan }; 251102fa4696Sdan 251202fa4696Sdan /* 251348dd1d8eSdrh ** Allowed values for Index.idxType 251448dd1d8eSdrh */ 251548dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */ 251648dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */ 251748dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */ 25185f913ecbSdrh #define SQLITE_IDXTYPE_IPK 3 /* INTEGER PRIMARY KEY index */ 251948dd1d8eSdrh 252048dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */ 252148dd1d8eSdrh #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY) 252248dd1d8eSdrh 25235f1d1d9cSdrh /* Return true if index X is a UNIQUE index */ 25245f1d1d9cSdrh #define IsUniqueIndex(X) ((X)->onError!=OE_None) 25255f1d1d9cSdrh 25264b92f98cSdrh /* The Index.aiColumn[] values are normally positive integer. But 25274b92f98cSdrh ** there are some negative values that have special meaning: 25284b92f98cSdrh */ 25294b92f98cSdrh #define XN_ROWID (-1) /* Indexed column is the rowid */ 25304b92f98cSdrh #define XN_EXPR (-2) /* Indexed column is an expression */ 25314b92f98cSdrh 253248dd1d8eSdrh /* 2533175b8f06Sdrh ** Each sample stored in the sqlite_stat4 table is represented in memory 253474e7c8f5Sdrh ** using a structure of this type. See documentation at the top of the 253574e7c8f5Sdrh ** analyze.c source file for additional information. 253602fa4696Sdan */ 253702fa4696Sdan struct IndexSample { 2538f52bb8d3Sdan void *p; /* Pointer to sampled record */ 2539f52bb8d3Sdan int n; /* Size of record in bytes */ 2540f52bb8d3Sdan tRowcnt *anEq; /* Est. number of rows where the key equals this sample */ 2541f52bb8d3Sdan tRowcnt *anLt; /* Est. number of rows where key is less than this sample */ 2542f52bb8d3Sdan tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */ 254375897234Sdrh }; 254475897234Sdrh 254575897234Sdrh /* 25468bee11a4Smistachkin ** Possible values to use within the flags argument to sqlite3GetToken(). 25478bee11a4Smistachkin */ 25488bee11a4Smistachkin #define SQLITE_TOKEN_QUOTED 0x1 /* Token is a quoted identifier. */ 25498bee11a4Smistachkin #define SQLITE_TOKEN_KEYWORD 0x2 /* Token is a keyword. */ 25508bee11a4Smistachkin 25518bee11a4Smistachkin /* 255275897234Sdrh ** Each token coming out of the lexer is an instance of 25534b59ab5eSdrh ** this structure. Tokens are also used as part of an expression. 25544efc4754Sdrh ** 25554a2c747cSdrh ** The memory that "z" points to is owned by other objects. Take care 25564a2c747cSdrh ** that the owner of the "z" string does not deallocate the string before 25574a2c747cSdrh ** the Token goes out of scope! Very often, the "z" points to some place 25584a2c747cSdrh ** in the middle of the Parse.zSql text. But it might also point to a 25594a2c747cSdrh ** static string. 256075897234Sdrh */ 256175897234Sdrh struct Token { 2562b7916a78Sdrh const char *z; /* Text of the token. Not NULL-terminated! */ 2563b7916a78Sdrh unsigned int n; /* Number of characters in this token */ 256475897234Sdrh }; 256575897234Sdrh 256675897234Sdrh /* 256713449892Sdrh ** An instance of this structure contains information needed to generate 256813449892Sdrh ** code for a SELECT that contains aggregate functions. 256913449892Sdrh ** 257013449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a 257116dc07f7Sdrh ** pointer to this structure. The Expr.iAgg field is the index in 257213449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate 257313449892Sdrh ** code for that node. 257413449892Sdrh ** 257513449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the 257613449892Sdrh ** original Select structure that describes the SELECT statement. These 257713449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure. 257813449892Sdrh */ 257913449892Sdrh struct AggInfo { 258013449892Sdrh u8 directMode; /* Direct rendering mode means take data directly 258113449892Sdrh ** from source tables rather than from accumulators */ 258213449892Sdrh u8 useSortingIdx; /* In direct mode, reference the sorting index rather 258313449892Sdrh ** than the source table */ 258413449892Sdrh int sortingIdx; /* Cursor number of the sorting index */ 25855134d135Sdan int sortingIdxPTab; /* Cursor number of pseudo-table */ 258613449892Sdrh int nSortingColumn; /* Number of columns in the sorting index */ 25877e61d18eSdrh int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */ 2588a451017dSdrh ExprList *pGroupBy; /* The group by clause */ 258913449892Sdrh struct AggInfo_col { /* For each column used in source tables */ 25900817d0dfSdanielk1977 Table *pTab; /* Source table */ 259181185a51Sdrh Expr *pCExpr; /* The original expression */ 259213449892Sdrh int iTable; /* Cursor number of the source table */ 259313449892Sdrh int iMem; /* Memory location that acts as accumulator */ 259489636628Sdrh i16 iColumn; /* Column number within the source table */ 259589636628Sdrh i16 iSorterColumn; /* Column number in the sorting index */ 259613449892Sdrh } *aCol; 259713449892Sdrh int nColumn; /* Number of used entries in aCol[] */ 259813449892Sdrh int nAccumulator; /* Number of columns that show through to the output. 259913449892Sdrh ** Additional columns are used only as parameters to 260013449892Sdrh ** aggregate functions */ 260113449892Sdrh struct AggInfo_func { /* For each aggregate function */ 260281185a51Sdrh Expr *pFExpr; /* Expression encoding the function */ 260313449892Sdrh FuncDef *pFunc; /* The aggregate function implementation */ 260413449892Sdrh int iMem; /* Memory location that acts as accumulator */ 2605467bcf36Sshane int iDistinct; /* Ephemeral table used to enforce DISTINCT */ 2606*9bfafa89Sdan int iDistAddr; /* Address of OP_OpenEphemeral */ 260713449892Sdrh } *aFunc; 260813449892Sdrh int nFunc; /* Number of entries in aFunc[] */ 2609e26d428aSdrh u32 selId; /* Select to which this AggInfo belongs */ 261013449892Sdrh }; 261113449892Sdrh 261213449892Sdrh /* 26138677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit. 26148677d308Sdrh ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater 26158677d308Sdrh ** than 32767 we have to make it 32-bit. 16-bit is preferred because 26168677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user 26178677d308Sdrh ** in systems with lots of prepared statements. And few applications 26188677d308Sdrh ** need more than about 10 or 20 variables. But some extreme users want 2619efdba1a8Sdrh ** to have prepared statements with over 32766 variables, and for them 26208677d308Sdrh ** the option is available (at compile-time). 26218677d308Sdrh */ 2622efdba1a8Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<32767 2623481aa74eSdrh typedef i16 ynVar; 26248677d308Sdrh #else 26258677d308Sdrh typedef int ynVar; 26268677d308Sdrh #endif 26278677d308Sdrh 26288677d308Sdrh /* 262975897234Sdrh ** Each node of an expression in the parse tree is an instance 263022f70c32Sdrh ** of this structure. 263122f70c32Sdrh ** 263222f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused 263322f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer 263422f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused 263522f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression 263622f70c32Sdrh ** tree. 263722f70c32Sdrh ** 26386ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB, 26396ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If 26406ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the 26416ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION), 26426ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function. 264322f70c32Sdrh ** 26446ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a 26456ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL. 26466ab3a2ecSdanielk1977 ** 26476ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function, 26486ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)". 26496ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of 26506ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the 26516ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is 26526ab3a2ecSdanielk1977 ** valid. 265322f70c32Sdrh ** 265422f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table. 265522f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is 265622f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and 265722f70c32Sdrh ** Expr.iColumn is the column number for the specific column. If the 265822f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the 265922f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that 266022f70c32Sdrh ** it can be accessed after all aggregates are computed. 266122f70c32Sdrh ** 26626ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark 26636ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index 26646ab3a2ecSdanielk1977 ** number for that variable. 266522f70c32Sdrh ** 26661398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer 26671398ad36Sdrh ** register number containing the result of the subquery. If the 26681398ad36Sdrh ** subquery gives a constant result, then iTable is -1. If the subquery 26691398ad36Sdrh ** gives a different answer at different times during statement processing 26701398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery. 26711398ad36Sdrh ** 2672aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from 2673aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the 2674aee18ef8Sdanielk1977 ** corresponding table definition. 26756ab3a2ecSdanielk1977 ** 26766ab3a2ecSdanielk1977 ** ALLOCATION NOTES: 26776ab3a2ecSdanielk1977 ** 267812ffee8cSdrh ** Expr objects can use a lot of memory space in database schema. To 267912ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be 268012ffee8cSdrh ** truncated. And to reduce the number of memory allocations, sometimes 268112ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation, 268233e619fcSdrh ** together with Expr.zToken strings. 26836ab3a2ecSdanielk1977 ** 2684b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when 268512ffee8cSdrh ** an Expr object is truncated. When EP_Reduced is set, then all 268612ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees 268712ffee8cSdrh ** are contained within the same memory allocation. Note, however, that 268812ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately 268912ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set. 269075897234Sdrh */ 269175897234Sdrh struct Expr { 26921cc093c2Sdrh u8 op; /* Operation performed by this node */ 26931194904bSdrh char affExpr; /* affinity, or RAISE type */ 269420cee7d0Sdrh u8 op2; /* TK_REGISTER/TK_TRUTH: original value of Expr.op 269520cee7d0Sdrh ** TK_COLUMN: the value of p5 for OP_Column 269620cee7d0Sdrh ** TK_AGG_FUNCTION: nesting depth 269720cee7d0Sdrh ** TK_FUNCTION: NC_SelfRef flag if needs OP_PureFunc */ 2698e7375bfaSdrh #ifdef SQLITE_DEBUG 2699e7375bfaSdrh u8 vvaFlags; /* Verification flags. */ 2700e7375bfaSdrh #endif 2701c5cd1249Sdrh u32 flags; /* Various flags. EP_* See below */ 270233e619fcSdrh union { 2703b7916a78Sdrh char *zToken; /* Token value. Zero terminated and dequoted */ 2704d50ffc41Sdrh int iValue; /* Non-negative integer value if EP_IntValue */ 270533e619fcSdrh } u; 27066ab3a2ecSdanielk1977 27076ab3a2ecSdanielk1977 /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no 27086ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27096ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27106ab3a2ecSdanielk1977 *********************************************************************/ 27116ab3a2ecSdanielk1977 27126ab3a2ecSdanielk1977 Expr *pLeft; /* Left subnode */ 27136ab3a2ecSdanielk1977 Expr *pRight; /* Right subnode */ 27146ab3a2ecSdanielk1977 union { 2715c5cd1249Sdrh ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */ 2716c5cd1249Sdrh Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */ 27176ab3a2ecSdanielk1977 } x; 27186ab3a2ecSdanielk1977 27196ab3a2ecSdanielk1977 /* If the EP_Reduced flag is set in the Expr.flags mask, then no 27206ab3a2ecSdanielk1977 ** space is allocated for the fields below this point. An attempt to 27216ab3a2ecSdanielk1977 ** access them will result in a segfault or malfunction. 27226ab3a2ecSdanielk1977 *********************************************************************/ 27236ab3a2ecSdanielk1977 27246ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0 27256ec65491Sdrh int nHeight; /* Height of the tree headed by this node */ 27266ec65491Sdrh #endif 2727b7916a78Sdrh int iTable; /* TK_COLUMN: cursor number of table holding column 27282832ad42Sdan ** TK_REGISTER: register number 2729cca9f3d2Sdrh ** TK_TRIGGER: 1 -> new, 0 -> old 2730fc7f27b9Sdrh ** EP_Unlikely: 134217728 times likelihood 2731818a3b54Sdrh ** TK_IN: ephemerial table holding RHS 2732554a9dc7Sdrh ** TK_SELECT_COLUMN: Number of columns on the LHS 2733fc7f27b9Sdrh ** TK_SELECT: 1st register of result vector */ 27348677d308Sdrh ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid. 2735fc7f27b9Sdrh ** TK_VARIABLE: variable number (always >= 1). 2736fc7f27b9Sdrh ** TK_SELECT_COLUMN: column of the result vector */ 2737b7916a78Sdrh i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */ 2738961a7260Sdan int iRightJoinTable; /* If EP_FromJoin, the right table of the join */ 273913449892Sdrh AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */ 2740eda079cdSdrh union { 2741eda079cdSdrh Table *pTab; /* TK_COLUMN: Table containing column. Can be NULL 27424dd89d5aSdrh ** for a column of an index on an expression */ 27434f9adee2Sdan Window *pWin; /* EP_WinFunc: Window/Filter defn for a function */ 27442c04131cSdrh struct { /* TK_IN, TK_SELECT, and TK_EXISTS */ 27452c04131cSdrh int iAddr; /* Subroutine entry address */ 27462c04131cSdrh int regReturn; /* Register used to hold return address */ 27472c04131cSdrh } sub; 2748eda079cdSdrh } y; 274975897234Sdrh }; 275075897234Sdrh 275175897234Sdrh /* 27521f16230bSdrh ** The following are the meanings of bits in the Expr.flags field. 2753d137f4e6Sdrh ** Value restrictions: 2754d137f4e6Sdrh ** 2755d137f4e6Sdrh ** EP_Agg == NC_HasAgg == SF_HasAgg 2756d137f4e6Sdrh ** EP_Win == NC_HasWin 27571f16230bSdrh */ 275872673a24Sdrh #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */ 2759d137f4e6Sdrh #define EP_Distinct 0x000002 /* Aggregate function with DISTINCT keyword */ 2760fca23557Sdrh #define EP_HasFunc 0x000004 /* Contains one or more functions of any kind */ 2761efad2e23Sdrh #define EP_FixedCol 0x000008 /* TK_Column with a known fixed value */ 2762d137f4e6Sdrh #define EP_Agg 0x000010 /* Contains one or more aggregate functions */ 2763c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */ 2764c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */ 2765c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */ 2766fbb24d10Sdrh #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */ 2767898c527eSdrh #define EP_Commuted 0x000200 /* Comparison operator has been commuted */ 2768c5cd1249Sdrh #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */ 2769c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */ 2770a7d6db6aSdrh #define EP_Skip 0x001000 /* Operator does not contribute to affinity */ 2771c5cd1249Sdrh #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */ 2772c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */ 2773d137f4e6Sdrh #define EP_Win 0x008000 /* Contains window functions */ 2774c5cd1249Sdrh #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */ 277546fe138dSdrh #define EP_IfNullRow 0x020000 /* The TK_IF_NULL_ROW opcode */ 2776a4c3c87eSdrh #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */ 2777a7f910b5Sdrh #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */ 277872673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */ 2779885a5b03Sdrh #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */ 278029f6a365Sdrh /* 0x400000 // Available */ 2781209bc522Sdrh #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */ 2782eda079cdSdrh #define EP_WinFunc 0x1000000 /* TK_FUNCTION with Expr.y.pWin set */ 27832c04131cSdrh #define EP_Subrtn 0x2000000 /* Uses Expr.y.sub. TK_IN, _SELECT, or _EXISTS */ 278451d35b0fSdrh #define EP_Quoted 0x4000000 /* TK_ID was originally quoted */ 2785d137f4e6Sdrh #define EP_Static 0x8000000 /* Held in memory not obtained from malloc() */ 2786ad31727fSdrh #define EP_IsTrue 0x10000000 /* Always has boolean value of TRUE */ 2787ad31727fSdrh #define EP_IsFalse 0x20000000 /* Always has boolean value of FALSE */ 2788ccb2113aSdrh #define EP_FromDDL 0x40000000 /* Originates from sqlite_schema */ 2789e7375bfaSdrh /* 0x80000000 // Available */ 2790885a5b03Sdrh 2791885a5b03Sdrh /* 2792fca23557Sdrh ** The EP_Propagate mask is a set of properties that automatically propagate 2793fca23557Sdrh ** upwards into parent nodes. 2794885a5b03Sdrh */ 2795fca23557Sdrh #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc) 279633e619fcSdrh 279733e619fcSdrh /* 27981f16230bSdrh ** These macros can be used to test, set, or clear bits in the 27991f16230bSdrh ** Expr.flags field. 28001f16230bSdrh */ 2801c5cd1249Sdrh #define ExprHasProperty(E,P) (((E)->flags&(P))!=0) 2802c5cd1249Sdrh #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P)) 28031f16230bSdrh #define ExprSetProperty(E,P) (E)->flags|=(P) 28041f16230bSdrh #define ExprClearProperty(E,P) (E)->flags&=~(P) 2805ad31727fSdrh #define ExprAlwaysTrue(E) (((E)->flags&(EP_FromJoin|EP_IsTrue))==EP_IsTrue) 2806ad31727fSdrh #define ExprAlwaysFalse(E) (((E)->flags&(EP_FromJoin|EP_IsFalse))==EP_IsFalse) 28071f16230bSdrh 2808e7375bfaSdrh 2809e7375bfaSdrh /* Flags for use with Expr.vvaFlags 2810e7375bfaSdrh */ 2811e7375bfaSdrh #define EP_NoReduce 0x01 /* Cannot EXPRDUP_REDUCE this Expr */ 2812e7375bfaSdrh #define EP_Immutable 0x02 /* Do not change this Expr node */ 2813e7375bfaSdrh 2814ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation, 2815ebb6a65dSdrh ** and Accreditation only. It works like ExprSetProperty() during VVA 2816ebb6a65dSdrh ** processes but is a no-op for delivery. 2817ebb6a65dSdrh */ 2818ebb6a65dSdrh #ifdef SQLITE_DEBUG 2819e7375bfaSdrh # define ExprSetVVAProperty(E,P) (E)->vvaFlags|=(P) 2820e7375bfaSdrh # define ExprHasVVAProperty(E,P) (((E)->vvaFlags&(P))!=0) 2821e7375bfaSdrh # define ExprClearVVAProperties(E) (E)->vvaFlags = 0 2822ebb6a65dSdrh #else 2823ebb6a65dSdrh # define ExprSetVVAProperty(E,P) 2824e7375bfaSdrh # define ExprHasVVAProperty(E,P) 0 2825e7375bfaSdrh # define ExprClearVVAProperties(E) 2826ebb6a65dSdrh #endif 2827ebb6a65dSdrh 28281f16230bSdrh /* 28296ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr 28306ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags 28316ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set. 28326ab3a2ecSdanielk1977 */ 283312ffee8cSdrh #define EXPR_FULLSIZE sizeof(Expr) /* Full size */ 283412ffee8cSdrh #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */ 2835b7916a78Sdrh #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */ 28366ab3a2ecSdanielk1977 28376ab3a2ecSdanielk1977 /* 28386ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment 28396ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details. 28406ab3a2ecSdanielk1977 */ 284112ffee8cSdrh #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */ 28426ab3a2ecSdanielk1977 28436ab3a2ecSdanielk1977 /* 28444f9adee2Sdan ** True if the expression passed as an argument was a function with 28454f9adee2Sdan ** an OVER() clause (a window function). 28464f9adee2Sdan */ 28473703edf1Sdan #ifdef SQLITE_OMIT_WINDOWFUNC 28483703edf1Sdan # define IsWindowFunc(p) 0 28493703edf1Sdan #else 28504f9adee2Sdan # define IsWindowFunc(p) ( \ 28514f9adee2Sdan ExprHasProperty((p), EP_WinFunc) && p->y.pWin->eFrmType!=TK_FILTER \ 28524f9adee2Sdan ) 28533703edf1Sdan #endif 28544f9adee2Sdan 28554f9adee2Sdan /* 285675897234Sdrh ** A list of expressions. Each expression may optionally have a 285775897234Sdrh ** name. An expr/name combination can be used in several ways, such 285875897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the 285975897234Sdrh ** list of "ID = expr" items in an UPDATE. A list of expressions can 2860ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName 286175897234Sdrh ** field is not used. 28620dde4739Sdrh ** 2863cbb9da33Sdrh ** In order to try to keep memory usage down, the Expr.a.zEName field 2864cbb9da33Sdrh ** is used for multiple purposes: 2865cbb9da33Sdrh ** 2866c4938ea2Sdrh ** eEName Usage 2867c4938ea2Sdrh ** ---------- ------------------------- 2868c4938ea2Sdrh ** ENAME_NAME (1) the AS of result set column 2869cbb9da33Sdrh ** (2) COLUMN= of an UPDATE 2870cbb9da33Sdrh ** 2871c4938ea2Sdrh ** ENAME_TAB DB.TABLE.NAME used to resolve names 2872cbb9da33Sdrh ** of subqueries 2873cbb9da33Sdrh ** 2874c4938ea2Sdrh ** ENAME_SPAN Text of the original result set 2875cbb9da33Sdrh ** expression. 287675897234Sdrh */ 287775897234Sdrh struct ExprList { 287875897234Sdrh int nExpr; /* Number of expressions on the list */ 2879d872bb18Sdrh struct ExprList_item { /* For each expression in the list */ 2880c5f4816fSdrh Expr *pExpr; /* The parse tree for this expression */ 288141cee668Sdrh char *zEName; /* Token associated with this expression */ 28829105fd51Sdan u8 sortFlags; /* Mask of KEYINFO_ORDER_* flags */ 2883cbb9da33Sdrh unsigned eEName :2; /* Meaning of zEName */ 28840dde4739Sdrh unsigned done :1; /* A flag to indicate when processing is finished */ 2885d673cddaSdrh unsigned reusable :1; /* Constant expression is reusable */ 288624e25d32Sdan unsigned bSorterRef :1; /* Defer evaluation until after sorting */ 28879105fd51Sdan unsigned bNulls: 1; /* True if explicit "NULLS FIRST/LAST" */ 2888c2acc4e4Sdrh union { 2889c2acc4e4Sdrh struct { 28904b3ac73cSdrh u16 iOrderByCol; /* For ORDER BY, column number in result set */ 28918b213899Sdrh u16 iAlias; /* Index into Parse.aAlias[] for zName */ 2892c2acc4e4Sdrh } x; 2893c2acc4e4Sdrh int iConstExprReg; /* Register in which Expr value is cached */ 2894c2acc4e4Sdrh } u; 289543606175Sdrh } a[1]; /* One slot for each expression in the list */ 289675897234Sdrh }; 289775897234Sdrh 289875897234Sdrh /* 2899cbb9da33Sdrh ** Allowed values for Expr.a.eEName 2900cbb9da33Sdrh */ 2901cbb9da33Sdrh #define ENAME_NAME 0 /* The AS clause of a result set */ 2902cbb9da33Sdrh #define ENAME_SPAN 1 /* Complete text of the result set expression */ 2903cbb9da33Sdrh #define ENAME_TAB 2 /* "DB.TABLE.NAME" for the result set */ 2904cbb9da33Sdrh 2905cbb9da33Sdrh /* 2906ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers, 2907ad3cab52Sdrh ** such as the list "a,b,c" in the following statements: 2908ad3cab52Sdrh ** 2909ad3cab52Sdrh ** INSERT INTO t(a,b,c) VALUES ...; 2910ad3cab52Sdrh ** CREATE INDEX idx ON t(a,b,c); 2911ad3cab52Sdrh ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...; 2912ad3cab52Sdrh ** 2913ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of 2914ad3cab52Sdrh ** column names after a table name in an INSERT statement. In the statement 2915ad3cab52Sdrh ** 2916ad3cab52Sdrh ** INSERT INTO t(a,b,c) ... 2917ad3cab52Sdrh ** 2918ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k. 291975897234Sdrh */ 292075897234Sdrh struct IdList { 29216d4abfbeSdrh struct IdList_item { 2922ad3cab52Sdrh char *zName; /* Name of the identifier */ 2923967e8b73Sdrh int idx; /* Index in some Table.aCol[] of a column named zName */ 2924ad3cab52Sdrh } *a; 292513449892Sdrh int nId; /* Number of identifiers on the list */ 2926ad3cab52Sdrh }; 2927ad3cab52Sdrh 2928ad3cab52Sdrh /* 29297601294aSdrh ** The SrcItem object represents a single term in the FROM clause of a query. 29307601294aSdrh ** The SrcList object is mostly an array of SrcItems. 2931ad3cab52Sdrh */ 29327601294aSdrh struct SrcItem { 293341fb5cd1Sdan Schema *pSchema; /* Schema to which this item is fixed */ 2934113088ecSdrh char *zDatabase; /* Name of database holding this table */ 2935ad3cab52Sdrh char *zName; /* Name of the table */ 2936ad3cab52Sdrh char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */ 2937daffd0e5Sdrh Table *pTab; /* An SQL table corresponding to zName */ 2938daffd0e5Sdrh Select *pSelect; /* A SELECT statement used in place of a table name */ 29395b6a9ed4Sdrh int addrFillSub; /* Address of subroutine to manifest a subquery */ 29405b6a9ed4Sdrh int regReturn; /* Register holding return address of addrFillSub */ 29415f612295Sdrh int regResult; /* Registers holding results of a co-routine */ 29428a48b9c0Sdrh struct { 29436b922881Sdrh u8 jointype; /* Type of join between this table and the previous */ 294421172c4cSdrh unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */ 29458a48b9c0Sdrh unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */ 29468a48b9c0Sdrh unsigned isTabFunc :1; /* True if table-valued-function syntax */ 294721172c4cSdrh unsigned isCorrelated :1; /* True if sub-query is correlated */ 294821172c4cSdrh unsigned viaCoroutine :1; /* Implemented as a co-routine */ 2949f43fe6e9Sdan unsigned isRecursive :1; /* True for recursive reference in WITH */ 2950ccb2113aSdrh unsigned fromDDL :1; /* Comes from sqlite_schema */ 2951a79e2a2dSdrh unsigned isCte :1; /* This is a CTE */ 29528a48b9c0Sdrh } fg; 2953e68fbe79Sdrh int iCursor; /* The VDBE cursor number used to access this table */ 2954ad3cab52Sdrh Expr *pOn; /* The ON clause of a join */ 2955ad3cab52Sdrh IdList *pUsing; /* The USING clause of a join */ 2956cd38d520Sdanielk1977 Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */ 29578a48b9c0Sdrh union { 2958d62fbb50Sdrh char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */ 29598a48b9c0Sdrh ExprList *pFuncArg; /* Arguments to table-valued-function */ 29608a48b9c0Sdrh } u1; 2961a79e2a2dSdrh union { 29628a48b9c0Sdrh Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */ 2963a79e2a2dSdrh CteUse *pCteUse; /* CTE Usage info info fg.isCte is true */ 2964a79e2a2dSdrh } u2; 29657601294aSdrh }; 29667601294aSdrh 29677601294aSdrh /* 29687601294aSdrh ** The following structure describes the FROM clause of a SELECT statement. 29697601294aSdrh ** Each table or subquery in the FROM clause is a separate element of 29707601294aSdrh ** the SrcList.a[] array. 29717601294aSdrh ** 29727601294aSdrh ** With the addition of multiple database support, the following structure 29737601294aSdrh ** can also be used to describe a particular table such as the table that 29747601294aSdrh ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL, 29757601294aSdrh ** such a table must be a simple name: ID. But in SQLite, the table can 29767601294aSdrh ** now be identified by a database name, a dot, then the table name: ID.ID. 29777601294aSdrh ** 29787601294aSdrh ** The jointype starts out showing the join type between the current table 29797601294aSdrh ** and the next table on the list. The parser builds the list this way. 29807601294aSdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each 29817601294aSdrh ** jointype expresses the join between the table and the previous table. 29827601294aSdrh ** 29837601294aSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table 29847601294aSdrh ** contains more than 63 columns and the 64-th or later column is used. 29857601294aSdrh */ 29867601294aSdrh struct SrcList { 29877601294aSdrh int nSrc; /* Number of tables or subqueries in the FROM clause */ 29887601294aSdrh u32 nAlloc; /* Number of entries allocated in a[] below */ 29897601294aSdrh SrcItem a[1]; /* One entry for each identifier on the list */ 299075897234Sdrh }; 299175897234Sdrh 299275897234Sdrh /* 299301f3f253Sdrh ** Permitted values of the SrcList.a.jointype field 299401f3f253Sdrh */ 299501f3f253Sdrh #define JT_INNER 0x0001 /* Any kind of inner or cross join */ 29963dec223cSdrh #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */ 29973dec223cSdrh #define JT_NATURAL 0x0004 /* True for a "natural" join */ 29983dec223cSdrh #define JT_LEFT 0x0008 /* Left outer join */ 29993dec223cSdrh #define JT_RIGHT 0x0010 /* Right outer join */ 30003dec223cSdrh #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */ 30013dec223cSdrh #define JT_ERROR 0x0040 /* unknown or unsupported join type */ 300201f3f253Sdrh 3003111a6a7dSdrh 3004111a6a7dSdrh /* 3005336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin() 3006336a5300Sdrh ** and the WhereInfo.wctrlFlags member. 300749711600Sdrh ** 300849711600Sdrh ** Value constraints (enforced via assert()): 300949711600Sdrh ** WHERE_USE_LIMIT == SF_FixedLimit 301008c88eb0Sdrh */ 30116df2acd2Sdrh #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */ 30126df2acd2Sdrh #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */ 30136df2acd2Sdrh #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */ 30146df2acd2Sdrh #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */ 3015ce943bc8Sdrh #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */ 3016ce943bc8Sdrh #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */ 3017bc5eac00Sdrh #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of 3018bc5eac00Sdrh ** the OR optimization */ 3019ce943bc8Sdrh #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */ 3020ce943bc8Sdrh #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */ 3021ce943bc8Sdrh #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */ 3022ce943bc8Sdrh #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */ 302368c0c710Sdrh /* 0x0400 not currently used */ 3024d711e522Sdrh #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */ 302568c0c710Sdrh /* 0x1000 not currently used */ 3026ce943bc8Sdrh /* 0x2000 not currently used */ 3027bc5eac00Sdrh #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */ 3028ce943bc8Sdrh /* 0x8000 not currently used */ 3029a9d1ccb9Sdanielk1977 30304f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct() 30314f402f26Sdrh */ 3032e8e4af76Sdrh #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */ 3033ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */ 3034ae651d61Sdrh #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */ 3035e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */ 303638cc40c2Sdan 303775897234Sdrh /* 3038b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column 3039b3bce662Sdanielk1977 ** names. The context consists of a list of tables (the pSrcList) field and 3040b3bce662Sdanielk1977 ** a list of named expression (pEList). The named expression list may 3041b3bce662Sdanielk1977 ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or 3042b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE. The 3043b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for 3044b3bce662Sdanielk1977 ** other statements. 3045b3bce662Sdanielk1977 ** 3046b3bce662Sdanielk1977 ** NameContexts can be nested. When resolving names, the inner-most 3047b3bce662Sdanielk1977 ** context is searched first. If no match is found, the next outer 3048b3bce662Sdanielk1977 ** context is checked. If there is still no match, the next context 3049b3bce662Sdanielk1977 ** is checked. This process continues until either a match is found 3050b3bce662Sdanielk1977 ** or all contexts are check. When a match is found, the nRef member of 3051b3bce662Sdanielk1977 ** the context containing the match is incremented. 3052b3bce662Sdanielk1977 ** 3053b3bce662Sdanielk1977 ** Each subquery gets a new NameContext. The pNext field points to the 3054b3bce662Sdanielk1977 ** NameContext in the parent query. Thus the process of scanning the 3055b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer 3056b3bce662Sdanielk1977 ** subqueries looking for a match. 3057b3bce662Sdanielk1977 */ 3058b3bce662Sdanielk1977 struct NameContext { 3059b3bce662Sdanielk1977 Parse *pParse; /* The parser */ 3060b3bce662Sdanielk1977 SrcList *pSrcList; /* One or more tables used to resolve names */ 306125c3b8caSdrh union { 306226080d92Sdrh ExprList *pEList; /* Optional list of result-set columns */ 306313449892Sdrh AggInfo *pAggInfo; /* Information about aggregates at this level */ 3064eac9fabbSdrh Upsert *pUpsert; /* ON CONFLICT clause information from an upsert */ 3065552562c4Sdrh int iBaseReg; /* For TK_REGISTER when parsing RETURNING */ 306625c3b8caSdrh } uNC; 3067b3bce662Sdanielk1977 NameContext *pNext; /* Next outer name context. NULL for outermost */ 3068a51009b2Sdrh int nRef; /* Number of names resolved by this context */ 3069a51009b2Sdrh int nErr; /* Number of errors encountered while resolving names */ 30700d92571dSdan int ncFlags; /* Zero or more NC_* flags defined below */ 3071e3bf632cSdan Select *pWinSelect; /* SELECT statement for any window functions */ 3072b3bce662Sdanielk1977 }; 3073b3bce662Sdanielk1977 3074b3bce662Sdanielk1977 /* 3075a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field. 30769588ad95Sdrh ** 307749711600Sdrh ** Value constraints (all checked via assert()): 3078d137f4e6Sdrh ** NC_HasAgg == SF_HasAgg == EP_Agg 307949711600Sdrh ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX 3080d137f4e6Sdrh ** NC_HasWin == EP_Win 30819588ad95Sdrh ** 3082a51009b2Sdrh */ 308381f7b372Sdrh #define NC_AllowAgg 0x00001 /* Aggregate functions are allowed here */ 308481f7b372Sdrh #define NC_PartIdx 0x00002 /* True if resolving a partial index WHERE */ 308581f7b372Sdrh #define NC_IsCheck 0x00004 /* True if resolving a CHECK constraint */ 308620cee7d0Sdrh #define NC_GenCol 0x00008 /* True for a GENERATED ALWAYS AS clause */ 308781f7b372Sdrh #define NC_HasAgg 0x00010 /* One or more aggregate functions seen */ 308881f7b372Sdrh #define NC_IdxExpr 0x00020 /* True if resolving columns of CREATE INDEX */ 308920cee7d0Sdrh #define NC_SelfRef 0x0002e /* Combo: PartIdx, isCheck, GenCol, and IdxExpr */ 309081f7b372Sdrh #define NC_VarSelect 0x00040 /* A correlated subquery has been seen */ 309181f7b372Sdrh #define NC_UEList 0x00080 /* True if uNC.pEList is used */ 309281f7b372Sdrh #define NC_UAggInfo 0x00100 /* True if uNC.pAggInfo is used */ 309381f7b372Sdrh #define NC_UUpsert 0x00200 /* True if uNC.pUpsert is used */ 3094552562c4Sdrh #define NC_UBaseReg 0x00400 /* True if uNC.iBaseReg is used */ 309581f7b372Sdrh #define NC_MinMaxAgg 0x01000 /* min/max aggregates seen. See note above */ 309681f7b372Sdrh #define NC_Complex 0x02000 /* True if a function or subquery seen */ 309781f7b372Sdrh #define NC_AllowWin 0x04000 /* Window functions are allowed here */ 309881f7b372Sdrh #define NC_HasWin 0x08000 /* One or more window functions seen */ 3099d0ff601cSdrh #define NC_IsDDL 0x10000 /* Resolving names in a CREATE statement */ 310020cee7d0Sdrh #define NC_InAggFunc 0x20000 /* True if analyzing arguments to an agg func */ 3101ccb2113aSdrh #define NC_FromDDL 0x40000 /* SQL text comes from sqlite_schema */ 3102a51009b2Sdrh 3103a51009b2Sdrh /* 310446d2e5c3Sdrh ** An instance of the following object describes a single ON CONFLICT 3105e9c2e772Sdrh ** clause in an upsert. 3106788d55aaSdrh ** 3107788d55aaSdrh ** The pUpsertTarget field is only set if the ON CONFLICT clause includes 3108788d55aaSdrh ** conflict-target clause. (In "ON CONFLICT(a,b)" the "(a,b)" is the 3109e9c2e772Sdrh ** conflict-target clause.) The pUpsertTargetWhere is the optional 3110e9c2e772Sdrh ** WHERE clause used to identify partial unique indexes. 3111788d55aaSdrh ** 3112788d55aaSdrh ** pUpsertSet is the list of column=expr terms of the UPDATE statement. 3113788d55aaSdrh ** The pUpsertSet field is NULL for a ON CONFLICT DO NOTHING. The 3114788d55aaSdrh ** pUpsertWhere is the WHERE clause for the UPDATE and is NULL if the 3115788d55aaSdrh ** WHERE clause is omitted. 311646d2e5c3Sdrh */ 311746d2e5c3Sdrh struct Upsert { 31185602777eSdrh ExprList *pUpsertTarget; /* Optional description of conflict target */ 3119e9c2e772Sdrh Expr *pUpsertTargetWhere; /* WHERE clause for partial index targets */ 312046d2e5c3Sdrh ExprList *pUpsertSet; /* The SET clause from an ON CONFLICT UPDATE */ 3121dab0eb58Sdrh Expr *pUpsertWhere; /* WHERE clause for the ON CONFLICT UPDATE */ 31222549e4ccSdrh Upsert *pNextUpsert; /* Next ON CONFLICT clause in the list */ 3123255c1c15Sdrh u8 isDoUpdate; /* True for DO UPDATE. False for DO NOTHING */ 3124e84ad92fSdrh /* Above this point is the parse tree for the ON CONFLICT clauses. 3125e84ad92fSdrh ** The next group of fields stores intermediate data. */ 3126daf2761cSdrh void *pToFree; /* Free memory when deleting the Upsert object */ 3127e84ad92fSdrh /* All fields above are owned by the Upsert object and must be freed 3128e84ad92fSdrh ** when the Upsert is destroyed. The fields below are used to transfer 3129e84ad92fSdrh ** information from the INSERT processing down into the UPDATE processing 3130e84ad92fSdrh ** while generating code. The fields below are owned by the INSERT 3131e84ad92fSdrh ** statement and will be freed by INSERT processing. */ 313291f2717fSdrh Index *pUpsertIdx; /* UNIQUE constraint specified by pUpsertTarget */ 31330b30a116Sdrh SrcList *pUpsertSrc; /* Table to be updated */ 3134eac9fabbSdrh int regData; /* First register holding array of VALUES */ 31357fc3aba8Sdrh int iDataCur; /* Index of the data cursor */ 31367fc3aba8Sdrh int iIdxCur; /* Index of the first index cursor */ 313746d2e5c3Sdrh }; 313846d2e5c3Sdrh 313946d2e5c3Sdrh /* 31409bb61fe7Sdrh ** An instance of the following structure contains all information 31419bb61fe7Sdrh ** needed to generate code for a single SELECT statement. 3142a76b5dfcSdrh ** 3143bbd4ae5aSdrh ** See the header comment on the computeLimitRegisters() routine for a 3144bbd4ae5aSdrh ** detailed description of the meaning of the iLimit and iOffset fields. 31450342b1f5Sdrh ** 3146b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes. 31470342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in 314866a5167bSdrh ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor 31490342b1f5Sdrh ** the number of columns in P2 can be computed at the same time 3150b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not 31510342b1f5Sdrh ** enough information about the compound query is known at that point. 3152b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences 31532c79733fSdrh ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating 31540342b1f5Sdrh ** sequences for the ORDER BY clause. 31559bb61fe7Sdrh */ 31569bb61fe7Sdrh struct Select { 31577b58daeaSdrh u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */ 3158c3489bbfSdrh LogEst nSelectRow; /* Estimated number of result rows */ 3159c3489bbfSdrh u32 selFlags; /* Various SF_* values */ 3160a451017dSdrh int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */ 3161fef37760Sdrh u32 selId; /* Unique identifier number for this SELECT */ 3162079a3072Sdrh int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */ 3163a9ebfe20Sdrh ExprList *pEList; /* The fields of the result */ 3164ad3cab52Sdrh SrcList *pSrc; /* The FROM clause */ 31659bb61fe7Sdrh Expr *pWhere; /* The WHERE clause */ 31669bb61fe7Sdrh ExprList *pGroupBy; /* The GROUP BY clause */ 31679bb61fe7Sdrh Expr *pHaving; /* The HAVING clause */ 31689bb61fe7Sdrh ExprList *pOrderBy; /* The ORDER BY clause */ 3169967e8b73Sdrh Select *pPrior; /* Prior select in a compound select statement */ 31701e281291Sdrh Select *pNext; /* Next select to the left in a compound */ 3171a2dc3b1aSdanielk1977 Expr *pLimit; /* LIMIT expression. NULL means not used. */ 31724e9119d9Sdan With *pWith; /* WITH clause attached to this select. Or NULL. */ 317367a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 317486fb6e17Sdan Window *pWin; /* List of window functions */ 3175e3bf632cSdan Window *pWinDefn; /* List of named window definitions */ 317667a9b8edSdan #endif 31779bb61fe7Sdrh }; 31789bb61fe7Sdrh 31799bb61fe7Sdrh /* 31807d10d5a6Sdrh ** Allowed values for Select.selFlags. The "SF" prefix stands for 31817d10d5a6Sdrh ** "Select Flag". 318249711600Sdrh ** 318349711600Sdrh ** Value constraints (all checked via assert()) 318449711600Sdrh ** SF_HasAgg == NC_HasAgg 318549711600Sdrh ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX 318649711600Sdrh ** SF_FixedLimit == WHERE_USE_LIMIT 31877d10d5a6Sdrh */ 3188ba01634cSdrh #define SF_Distinct 0x0000001 /* Output should be DISTINCT */ 3189ba01634cSdrh #define SF_All 0x0000002 /* Includes the ALL keyword */ 3190ba01634cSdrh #define SF_Resolved 0x0000004 /* Identifiers have been resolved */ 3191ba01634cSdrh #define SF_Aggregate 0x0000008 /* Contains agg functions or a GROUP BY */ 3192ba01634cSdrh #define SF_HasAgg 0x0000010 /* Contains aggregate functions */ 3193ba01634cSdrh #define SF_UsesEphemeral 0x0000020 /* Uses the OpenEphemeral opcode */ 3194ba01634cSdrh #define SF_Expanded 0x0000040 /* sqlite3SelectExpand() called on this */ 3195ba01634cSdrh #define SF_HasTypeInfo 0x0000080 /* FROM subqueries have Table metadata */ 3196ba01634cSdrh #define SF_Compound 0x0000100 /* Part of a compound query */ 3197ba01634cSdrh #define SF_Values 0x0000200 /* Synthesized from VALUES clause */ 3198ba01634cSdrh #define SF_MultiValue 0x0000400 /* Single VALUES term with multiple rows */ 3199ba01634cSdrh #define SF_NestedFrom 0x0000800 /* Part of a parenthesized FROM clause */ 3200ba01634cSdrh #define SF_MinMaxAgg 0x0001000 /* Aggregate containing min() or max() */ 3201ba01634cSdrh #define SF_Recursive 0x0002000 /* The recursive part of a recursive CTE */ 3202ba01634cSdrh #define SF_FixedLimit 0x0004000 /* nSelectRow set by a constant LIMIT */ 3203ba01634cSdrh #define SF_MaybeConvert 0x0008000 /* Need convertCompoundSelectToSubquery() */ 3204ba01634cSdrh #define SF_Converted 0x0010000 /* By convertCompoundSelectToSubquery() */ 3205ba01634cSdrh #define SF_IncludeHidden 0x0020000 /* Include hidden columns in output */ 3206ba01634cSdrh #define SF_ComplexResult 0x0040000 /* Result contains subquery or function */ 3207ba01634cSdrh #define SF_WhereBegin 0x0080000 /* Really a WhereBegin() call. Debug Only */ 3208ba01634cSdrh #define SF_WinRewrite 0x0100000 /* Window function rewrite accomplished */ 320938096961Sdan #define SF_View 0x0200000 /* SELECT statement is a view */ 3210b7cbf5c1Sdrh #define SF_NoopOrderBy 0x0400000 /* ORDER BY is ignored for this query */ 321107ca7d61Sdan #define SF_UpdateFrom 0x0800000 /* Statement is an UPDATE...FROM */ 32128794c68aSdrh #define SF_PushDown 0x1000000 /* SELECT has be modified by push-down opt */ 3213903fdd48Sdan #define SF_MultiPart 0x2000000 /* Has multiple incompatible PARTITIONs */ 32147d10d5a6Sdrh 32157d10d5a6Sdrh /* 3216340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined 3217340309fdSdrh ** by one of the following macros. The "SRT" prefix means "SELECT Result 3218340309fdSdrh ** Type". 3219340309fdSdrh ** 3220340309fdSdrh ** SRT_Union Store results as a key in a temporary index 3221340309fdSdrh ** identified by pDest->iSDParm. 3222340309fdSdrh ** 3223340309fdSdrh ** SRT_Except Remove results from the temporary index pDest->iSDParm. 3224340309fdSdrh ** 3225340309fdSdrh ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result 3226340309fdSdrh ** set is not empty. 3227340309fdSdrh ** 3228340309fdSdrh ** SRT_Discard Throw the results away. This is used by SELECT 3229340309fdSdrh ** statements within triggers whose only purpose is 3230340309fdSdrh ** the side-effects of functions. 3231340309fdSdrh ** 3232340309fdSdrh ** SRT_Output Generate a row of output (using the OP_ResultRow 3233340309fdSdrh ** opcode) for each row in the result set. 3234340309fdSdrh ** 3235340309fdSdrh ** SRT_Mem Only valid if the result is a single column. 3236340309fdSdrh ** Store the first column of the first result row 3237340309fdSdrh ** in register pDest->iSDParm then abandon the rest 3238340309fdSdrh ** of the query. This destination implies "LIMIT 1". 3239340309fdSdrh ** 3240340309fdSdrh ** SRT_Set The result must be a single column. Store each 3241340309fdSdrh ** row of result as the key in table pDest->iSDParm. 3242340309fdSdrh ** Apply the affinity pDest->affSdst before storing 3243340309fdSdrh ** results. Used to implement "IN (SELECT ...)". 3244340309fdSdrh ** 3245340309fdSdrh ** SRT_EphemTab Create an temporary table pDest->iSDParm and store 3246340309fdSdrh ** the result there. The cursor is left open after 3247340309fdSdrh ** returning. This is like SRT_Table except that 3248340309fdSdrh ** this destination uses OP_OpenEphemeral to create 3249340309fdSdrh ** the table first. 3250340309fdSdrh ** 3251340309fdSdrh ** SRT_Coroutine Generate a co-routine that returns a new row of 3252340309fdSdrh ** results each time it is invoked. The entry point 3253340309fdSdrh ** of the co-routine is stored in register pDest->iSDParm 3254340309fdSdrh ** and the result row is stored in pDest->nDest registers 3255340309fdSdrh ** starting with pDest->iSdst. 3256340309fdSdrh ** 3257781def29Sdrh ** SRT_Table Store results in temporary table pDest->iSDParm. 32588e1ee88cSdrh ** SRT_Fifo This is like SRT_EphemTab except that the table 32598e1ee88cSdrh ** is assumed to already be open. SRT_Fifo has 32608e1ee88cSdrh ** the additional property of being able to ignore 32618e1ee88cSdrh ** the ORDER BY clause. 3262781def29Sdrh ** 32638e1ee88cSdrh ** SRT_DistFifo Store results in a temporary table pDest->iSDParm. 3264340309fdSdrh ** But also use temporary table pDest->iSDParm+1 as 3265340309fdSdrh ** a record of all prior results and ignore any duplicate 32668e1ee88cSdrh ** rows. Name means: "Distinct Fifo". 3267781def29Sdrh ** 3268781def29Sdrh ** SRT_Queue Store results in priority queue pDest->iSDParm (really 3269781def29Sdrh ** an index). Append a sequence number so that all entries 3270781def29Sdrh ** are distinct. 3271781def29Sdrh ** 3272781def29Sdrh ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if 3273781def29Sdrh ** the same record has never been stored before. The 3274781def29Sdrh ** index at pDest->iSDParm+1 hold all prior stores. 3275243210b7Sdan ** 3276243210b7Sdan ** SRT_Upfrom Store results in the temporary table already opened by 3277243210b7Sdan ** pDest->iSDParm. If (pDest->iSDParm<0), then the temp 3278243210b7Sdan ** table is an intkey table - in this case the first 3279243210b7Sdan ** column returned by the SELECT is used as the integer 3280243210b7Sdan ** key. If (pDest->iSDParm>0), then the table is an index 3281243210b7Sdan ** table. (pDest->iSDParm) is the number of key columns in 3282243210b7Sdan ** each index record in this case. 3283fef5208cSdrh */ 328413449892Sdrh #define SRT_Union 1 /* Store result as keys in an index */ 328513449892Sdrh #define SRT_Except 2 /* Remove result from a UNION index */ 32869ed1dfa8Sdanielk1977 #define SRT_Exists 3 /* Store 1 if the result is not empty */ 32879ed1dfa8Sdanielk1977 #define SRT_Discard 4 /* Do not save the results anywhere */ 3288f1ea4255Sdrh #define SRT_DistFifo 5 /* Like SRT_Fifo, but unique results only */ 3289f1ea4255Sdrh #define SRT_DistQueue 6 /* Like SRT_Queue, but unique results only */ 3290f1ea4255Sdrh 3291f1ea4255Sdrh /* The DISTINCT clause is ignored for all of the above. Not that 3292f1ea4255Sdrh ** IgnorableDistinct() implies IgnorableOrderby() */ 3293f1ea4255Sdrh #define IgnorableDistinct(X) ((X->eDest)<=SRT_DistQueue) 3294f1ea4255Sdrh 32958e1ee88cSdrh #define SRT_Queue 7 /* Store result in an queue */ 3296f1ea4255Sdrh #define SRT_Fifo 8 /* Store result as data with an automatic rowid */ 3297fef5208cSdrh 329813449892Sdrh /* The ORDER BY clause is ignored for all of the above */ 3299f1ea4255Sdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_Fifo) 330013449892Sdrh 33018e1ee88cSdrh #define SRT_Output 9 /* Output each row of result */ 33028e1ee88cSdrh #define SRT_Mem 10 /* Store result in a memory cell */ 33038e1ee88cSdrh #define SRT_Set 11 /* Store results as keys in an index */ 33048e1ee88cSdrh #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */ 33058e1ee88cSdrh #define SRT_Coroutine 13 /* Generate a single row of result */ 33068e1ee88cSdrh #define SRT_Table 14 /* Store result as data with an automatic rowid */ 3307f2972b60Sdan #define SRT_Upfrom 15 /* Store result as data with rowid */ 33082282792aSdrh 33092282792aSdrh /* 3310634d81deSdrh ** An instance of this object describes where to put of the results of 3311634d81deSdrh ** a SELECT statement. 33126c8c8ce0Sdanielk1977 */ 33136c8c8ce0Sdanielk1977 struct SelectDest { 33149ed322d6Sdan u8 eDest; /* How to dispose of the results. One of SRT_* above. */ 33152b596da8Sdrh int iSDParm; /* A parameter used by the eDest disposal method */ 33169ed322d6Sdan int iSDParm2; /* A second parameter for the eDest disposal method */ 33172b596da8Sdrh int iSdst; /* Base register where results are written */ 33182b596da8Sdrh int nSdst; /* Number of registers allocated */ 3319a8b9793cSdrh char *zAffSdst; /* Affinity used when eDest==SRT_Set */ 3320fe1c6bb9Sdrh ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */ 33216c8c8ce0Sdanielk1977 }; 33226c8c8ce0Sdanielk1977 33236c8c8ce0Sdanielk1977 /* 33240b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT 33250b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p 33260b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that 33270b9f50d8Sdrh ** the code generator needs. We have to keep per-table autoincrement 33281b32554bSdrh ** information in case inserts are done within triggers. Triggers do not 33290b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the 33300b9f50d8Sdrh ** loading and saving of autoincrement information. 33310b9f50d8Sdrh */ 33320b9f50d8Sdrh struct AutoincInfo { 33330b9f50d8Sdrh AutoincInfo *pNext; /* Next info block in a list of them all */ 33340b9f50d8Sdrh Table *pTab; /* Table this info block refers to */ 33350b9f50d8Sdrh int iDb; /* Index in sqlite3.aDb[] of database holding pTab */ 33360b9f50d8Sdrh int regCtr; /* Memory register holding the rowid counter */ 33370b9f50d8Sdrh }; 33380b9f50d8Sdrh 33390b9f50d8Sdrh /* 33402832ad42Sdan ** At least one instance of the following structure is created for each 33412832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE 33422832ad42Sdan ** statement. All such objects are stored in the linked list headed at 33432832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been 33442832ad42Sdan ** completed. 33452832ad42Sdan ** 33462832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger 33472832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of 33482832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable. 33492832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same 33502832ad42Sdan ** values for both pTrigger and orconf. 335165a7cd16Sdan ** 3352bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns 335365a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT 3354bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to 3355bb5f168fSdan ** a mask of new.* columns used by the program. 33562832ad42Sdan */ 33572832ad42Sdan struct TriggerPrg { 33582832ad42Sdan Trigger *pTrigger; /* Trigger this program was coded from */ 33592832ad42Sdan TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */ 3360a451017dSdrh SubProgram *pProgram; /* Program implementing pTrigger/orconf */ 3361a451017dSdrh int orconf; /* Default ON CONFLICT policy */ 3362a451017dSdrh u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */ 3363165921a7Sdan }; 3364165921a7Sdan 336564123585Sdrh /* 336664123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases. 336764123585Sdrh */ 336801c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30 3369a7ab6d81Sdrh typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8]; 3370a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0) 3371a7ab6d81Sdrh # define DbMaskZero(M) memset((M),0,sizeof(M)) 3372a7ab6d81Sdrh # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7)) 3373a7ab6d81Sdrh # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M) 3374a7ab6d81Sdrh # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0) 337501c7dc88Sdrh #else 337664123585Sdrh typedef unsigned int yDbMask; 3377a7ab6d81Sdrh # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0) 3378a7ab6d81Sdrh # define DbMaskZero(M) (M)=0 3379a7ab6d81Sdrh # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I)) 3380a7ab6d81Sdrh # define DbMaskAllZero(M) (M)==0 3381a7ab6d81Sdrh # define DbMaskNonZero(M) (M)!=0 338201c7dc88Sdrh #endif 338301c7dc88Sdrh 3384ceea3321Sdrh /* 3385cf3c078fSdrh ** An instance of the ParseCleanup object specifies an operation that 3386cf3c078fSdrh ** should be performed after parsing to deallocation resources obtained 3387cf3c078fSdrh ** during the parse and which are no longer needed. 3388cf3c078fSdrh */ 3389cf3c078fSdrh struct ParseCleanup { 3390cf3c078fSdrh ParseCleanup *pNext; /* Next cleanup task */ 3391cf3c078fSdrh void *pPtr; /* Pointer to object to deallocate */ 3392cf3c078fSdrh void (*xCleanup)(sqlite3*,void*); /* Deallocation routine */ 3393cf3c078fSdrh }; 3394cf3c078fSdrh 3395cf3c078fSdrh /* 3396f57b3399Sdrh ** An SQL parser context. A copy of this structure is passed through 3397f57b3399Sdrh ** the parser and down into all the parser action routine in order to 3398f57b3399Sdrh ** carry around information that is global to the entire parse. 3399f1974846Sdrh ** 3400f1974846Sdrh ** The structure is divided into two parts. When the parser and code 3401f1974846Sdrh ** generate call themselves recursively, the first part of the structure 3402f1974846Sdrh ** is constant but the second part is reset at the beginning and end of 3403f1974846Sdrh ** each recursion. 3404c00da105Sdanielk1977 ** 3405c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache 3406c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are 3407c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being 3408c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the 3409c00da105Sdanielk1977 ** list. 341075897234Sdrh */ 341175897234Sdrh struct Parse { 34129bb575fdSdrh sqlite3 *db; /* The main database structure */ 341375897234Sdrh char *zErrMsg; /* An error message */ 341475897234Sdrh Vdbe *pVdbe; /* An engine for executing database bytecode */ 3415a451017dSdrh int rc; /* Return code from execution */ 3416836faa48Sdrh u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */ 3417a6ecd338Sdrh u8 checkSchema; /* Causes schema cookie check after an error */ 3418205f48e6Sdrh u8 nested; /* Number of nested calls to the parser/code generator */ 3419892d3179Sdrh u8 nTempReg; /* Number of temporary registers in aTempReg[] */ 3420a451017dSdrh u8 isMultiWrite; /* True if statement may modify/insert multiple rows */ 3421a451017dSdrh u8 mayAbort; /* True if statement may throw an ABORT exception */ 3422d58d3278Sdrh u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */ 3423aceb31b1Sdrh u8 okConstFactor; /* OK to factor out constants */ 34244a642b60Sdrh u8 disableLookaside; /* Number of times lookaside has been disabled */ 34251ea0443cSdan u8 disableVtab; /* Disable all virtual tables for this parse */ 342621d4f5b5Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST) 342721d4f5b5Sdrh u8 earlyCleanup; /* OOM inside sqlite3ParserAddCleanup() */ 342821d4f5b5Sdrh #endif 3429892d3179Sdrh int nRangeReg; /* Size of the temporary register block */ 3430892d3179Sdrh int iRangeReg; /* First register in temporary register block */ 343175897234Sdrh int nErr; /* Number of errors seen */ 3432832508b7Sdrh int nTab; /* Number of previously allocated VDBE cursors */ 343319a775c2Sdrh int nMem; /* Number of memory cells used so far */ 3434bd57308eSdrh int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */ 34357e8515d8Sdrh int iSelfTab; /* Table associated with an index on expr, or negative 34366e97f8ecSdrh ** of the base register during check-constraint eval */ 3437d1d158bfSdrh int nLabel; /* The *negative* of the number of labels used */ 3438ec4ccdbcSdrh int nLabelAlloc; /* Number of slots in aLabel */ 34397df89c8cSdrh int *aLabel; /* Space to hold the labels */ 3440f30a969bSdrh ExprList *pConstExpr;/* Constant expressions */ 34417df89c8cSdrh Token constraintName;/* Name of the constraint currently being parsed */ 344264123585Sdrh yDbMask writeMask; /* Start a write transaction on these databases */ 344364123585Sdrh yDbMask cookieMask; /* Bitmask of schema verified databases */ 3444a451017dSdrh int regRowid; /* Register holding rowid of CREATE TABLE entry */ 3445a451017dSdrh int regRoot; /* Register holding root page number for new objects */ 3446a451017dSdrh int nMaxArg; /* Max args passed to user function by sub-program */ 3447fef37760Sdrh int nSelect; /* Number of SELECT stmts. Counter for Select.selId */ 3448c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 3449c00da105Sdanielk1977 int nTableLock; /* Number of locks in aTableLock */ 3450c00da105Sdanielk1977 TableLock *aTableLock; /* Required table locks for shared-cache mode */ 3451c00da105Sdanielk1977 #endif 34520b9f50d8Sdrh AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */ 345365a7cd16Sdan Parse *pToplevel; /* Parse structure for main program (or NULL) */ 3454165921a7Sdan Table *pTriggerTab; /* Table triggers are being coded for */ 34551cf19758Sdrh Parse *pParentParse; /* Parent parser if this parser is nested */ 3456381bdaccSdrh union { 3457381bdaccSdrh int addrCrTab; /* Address of OP_CreateBtree on CREATE TABLE */ 3458381bdaccSdrh Returning *pReturning; /* The RETURNING clause */ 3459381bdaccSdrh } u1; 34604f402f26Sdrh u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */ 346165a7cd16Sdan u32 oldmask; /* Mask of old.* columns referenced */ 3462bb5f168fSdan u32 newmask; /* Mask of new.* columns referenced */ 346365a7cd16Sdan u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */ 3464b8352479Sdrh u8 bReturning; /* Coding a RETURNING trigger */ 346565a7cd16Sdan u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */ 3466d66c8309Sdan u8 disableTriggers; /* True to disable triggers */ 3467165921a7Sdan 3468445f3d56Sdrh /************************************************************************** 3469445f3d56Sdrh ** Fields above must be initialized to zero. The fields that follow, 3470445f3d56Sdrh ** down to the beginning of the recursive section, do not need to be 3471445f3d56Sdrh ** initialized as they will be set before being used. The boundary is 347202ceed05Sdrh ** determined by offsetof(Parse,aTempReg). 3473445f3d56Sdrh **************************************************************************/ 3474445f3d56Sdrh 3475445f3d56Sdrh int aTempReg[8]; /* Holding area for temporary registers */ 3476445f3d56Sdrh Token sNameToken; /* Token with unqualified schema object name */ 3477cd9af608Sdrh 34787df89c8cSdrh /************************************************************************ 34797df89c8cSdrh ** Above is constant between recursions. Below is reset before and after 34807df89c8cSdrh ** each recursion. The boundary between these two regions is determined 3481588429a8Sdrh ** using offsetof(Parse,sLastToken) so the sLastToken field must be the 3482588429a8Sdrh ** first field in the recursive region. 34837df89c8cSdrh ************************************************************************/ 3484f1974846Sdrh 3485588429a8Sdrh Token sLastToken; /* The last token parsed */ 34866d664b4bSdrh ynVar nVar; /* Number of '?' variables seen in the SQL so far */ 34877f9c5dbfSdrh u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */ 3488a451017dSdrh u8 explain; /* True if the EXPLAIN flag is found on the query */ 3489cf8f2895Sdan u8 eParseMode; /* PARSE_MODE_XXX constant */ 3490a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 3491a451017dSdrh int nVtabLock; /* Number of virtual tables to lock */ 3492a451017dSdrh #endif 3493a451017dSdrh int nHeight; /* Expression tree height of current sub-select */ 3494a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN 3495e2ca99c9Sdrh int addrExplain; /* Address of current OP_Explain opcode */ 3496a451017dSdrh #endif 34979bf755ccSdrh VList *pVList; /* Mapping between variable names and numbers */ 3498937d0deaSdan Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */ 3499f1974846Sdrh const char *zTail; /* All SQL text past the last semicolon parsed */ 3500f1974846Sdrh Table *pNewTable; /* A table being constructed by CREATE TABLE */ 3501885eeb67Sdrh Index *pNewIndex; /* An index being constructed by CREATE INDEX. 3502885eeb67Sdrh ** Also used to hold redundant UNIQUE constraints 3503885eeb67Sdrh ** during a RENAME COLUMN */ 3504f1974846Sdrh Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */ 3505f1974846Sdrh const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */ 3506b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 350733b3933cSdanielk1977 Token sArg; /* Complete text of a module argument */ 35084f3dd150Sdrh Table **apVtabLock; /* Pointer to virtual tables needing locking */ 3509b9bb7c18Sdrh #endif 35102832ad42Sdan TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */ 35114e9119d9Sdan With *pWith; /* Current WITH clause, or NULL */ 3512cf3c078fSdrh ParseCleanup *pCleanup; /* List of cleanup operations to run after parse */ 3513cf8f2895Sdan #ifndef SQLITE_OMIT_ALTERTABLE 35144a2c747cSdrh RenameToken *pRename; /* Tokens subject to renaming by ALTER TABLE */ 3515cf8f2895Sdan #endif 351675897234Sdrh }; 351775897234Sdrh 3518cf8f2895Sdan #define PARSE_MODE_NORMAL 0 3519cf8f2895Sdan #define PARSE_MODE_DECLARE_VTAB 1 3520e6dc1e5bSdan #define PARSE_MODE_RENAME 2 3521e6dc1e5bSdan #define PARSE_MODE_UNMAP 3 3522cf8f2895Sdan 3523a451017dSdrh /* 3524cd9af608Sdrh ** Sizes and pointers of various parts of the Parse object. 3525cd9af608Sdrh */ 352602ceed05Sdrh #define PARSE_HDR_SZ offsetof(Parse,aTempReg) /* Recursive part w/o aColCache*/ 3527588429a8Sdrh #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */ 3528cd9af608Sdrh #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */ 3529cd9af608Sdrh #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */ 3530cd9af608Sdrh 3531cd9af608Sdrh /* 3532a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call. 3533a451017dSdrh */ 35347e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE 35357e6ebfb2Sdanielk1977 #define IN_DECLARE_VTAB 0 35367e6ebfb2Sdanielk1977 #else 3537cf8f2895Sdan #define IN_DECLARE_VTAB (pParse->eParseMode==PARSE_MODE_DECLARE_VTAB) 3538cf8f2895Sdan #endif 3539cf8f2895Sdan 3540cf8f2895Sdan #if defined(SQLITE_OMIT_ALTERTABLE) 3541c9461eccSdan #define IN_RENAME_OBJECT 0 3542cf8f2895Sdan #else 3543e6dc1e5bSdan #define IN_RENAME_OBJECT (pParse->eParseMode>=PARSE_MODE_RENAME) 3544cf8f2895Sdan #endif 3545cf8f2895Sdan 3546cf8f2895Sdan #if defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE) 3547cf8f2895Sdan #define IN_SPECIAL_PARSE 0 3548cf8f2895Sdan #else 3549cf8f2895Sdan #define IN_SPECIAL_PARSE (pParse->eParseMode!=PARSE_MODE_NORMAL) 35507e6ebfb2Sdanielk1977 #endif 35517e6ebfb2Sdanielk1977 3552d99bc930Sdanielk1977 /* 355385e2096fSdrh ** An instance of the following structure can be declared on a stack and used 355485e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later. 355585e2096fSdrh */ 355685e2096fSdrh struct AuthContext { 355785e2096fSdrh const char *zAuthContext; /* Put saved Parse.zAuthContext here */ 355885e2096fSdrh Parse *pParse; /* The Parse structure */ 355985e2096fSdrh }; 356085e2096fSdrh 356185e2096fSdrh /* 3562a748fdccSdrh ** Bitfield flags for P5 value in various opcodes. 356349711600Sdrh ** 356449711600Sdrh ** Value constraints (enforced via assert()): 356549711600Sdrh ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH 356649711600Sdrh ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF 356749711600Sdrh ** OPFLAG_BULKCSR == BTREE_BULKLOAD 356849711600Sdrh ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ 356949711600Sdrh ** OPFLAG_FORDELETE == BTREE_FORDELETE 357049711600Sdrh ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION 357149711600Sdrh ** OPFLAG_AUXDELETE == BTREE_AUXDELETE 3572b0c374ffSrdc */ 3573e807bdbaSdrh #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */ 3574e807bdbaSdrh /* Also used in P2 (not P5) of OP_Delete */ 357509d00b2fSdrh #define OPFLAG_NOCHNG 0x01 /* OP_VColumn nochange for UPDATE */ 357697348b37Sdrh #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */ 3577f91c1318Sdan #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */ 35783e9ca094Sdrh #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */ 35793e9ca094Sdrh #define OPFLAG_APPEND 0x08 /* This is likely to be an append */ 35803e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */ 358146c47d46Sdan #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */ 3582a748fdccSdrh #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */ 3583a748fdccSdrh #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */ 3584428c218cSdan #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */ 3585e0997b34Sdrh #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */ 35869c0c57a4Sdrh #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */ 3587fd261ec6Sdan #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */ 3588953f7611Sdrh #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */ 3589f91c1318Sdan #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */ 3590def19e3bSdrh #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */ 359141fb367aSdrh #define OPFLAG_NOCHNG_MAGIC 0x6d /* OP_MakeRecord: serialtype 10 is ok */ 35927aae7358Sdan #define OPFLAG_PREFORMAT 0x80 /* OP_Insert uses preformatted cell */ 3593b0c374ffSrdc 3594b0c374ffSrdc /* 3595d99bc930Sdanielk1977 * Each trigger present in the database schema is stored as an instance of 3596d99bc930Sdanielk1977 * struct Trigger. 3597d99bc930Sdanielk1977 * 3598d99bc930Sdanielk1977 * Pointers to instances of struct Trigger are stored in two ways. 35999bb575fdSdrh * 1. In the "trigHash" hash table (part of the sqlite3* that represents the 3600d99bc930Sdanielk1977 * database). This allows Trigger structures to be retrieved by name. 3601d99bc930Sdanielk1977 * 2. All triggers associated with a single table form a linked list, using the 3602ad3cab52Sdrh * pNext member of struct Trigger. A pointer to the first element of the 3603ad3cab52Sdrh * linked list is stored as the "pTrigger" member of the associated 3604ad3cab52Sdrh * struct Table. 3605d99bc930Sdanielk1977 * 3606ad3cab52Sdrh * The "step_list" member points to the first element of a linked list 3607ad3cab52Sdrh * containing the SQL statements specified as the trigger program. 3608d99bc930Sdanielk1977 */ 3609d99bc930Sdanielk1977 struct Trigger { 3610165921a7Sdan char *zName; /* The name of the trigger */ 3611d99bc930Sdanielk1977 char *table; /* The table or view to which the trigger applies */ 3612f0f258b1Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */ 3613dca76841Sdrh u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */ 3614b8352479Sdrh u8 bReturning; /* This trigger implements a RETURNING clause */ 3615467bcf36Sshane Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */ 3616d99bc930Sdanielk1977 IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger, 3617d99bc930Sdanielk1977 the <column-list> is stored here */ 3618e501b89aSdanielk1977 Schema *pSchema; /* Schema containing the trigger */ 3619e501b89aSdanielk1977 Schema *pTabSchema; /* Schema containing the table */ 3620d99bc930Sdanielk1977 TriggerStep *step_list; /* Link list of trigger program steps */ 3621d99bc930Sdanielk1977 Trigger *pNext; /* Next trigger associated with the table */ 3622c3f9bad2Sdanielk1977 }; 3623d99bc930Sdanielk1977 3624d99bc930Sdanielk1977 /* 3625dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger. The following constants 3626dca76841Sdrh ** determine which. 3627dca76841Sdrh ** 3628dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER. 3629dca76841Sdrh ** In that cases, the constants below can be ORed together. 3630dca76841Sdrh */ 3631dca76841Sdrh #define TRIGGER_BEFORE 1 3632dca76841Sdrh #define TRIGGER_AFTER 2 3633dca76841Sdrh 3634dca76841Sdrh /* 3635d99bc930Sdanielk1977 * An instance of struct TriggerStep is used to store a single SQL statement 3636d99bc930Sdanielk1977 * that is a part of a trigger-program. 3637d99bc930Sdanielk1977 * 3638d99bc930Sdanielk1977 * Instances of struct TriggerStep are stored in a singly linked list (linked 3639d99bc930Sdanielk1977 * using the "pNext" member) referenced by the "step_list" member of the 3640d99bc930Sdanielk1977 * associated struct Trigger instance. The first element of the linked list is 3641d99bc930Sdanielk1977 * the first step of the trigger-program. 3642d99bc930Sdanielk1977 * 3643d99bc930Sdanielk1977 * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or 3644d99bc930Sdanielk1977 * "SELECT" statement. The meanings of the other members is determined by the 3645d99bc930Sdanielk1977 * value of "op" as follows: 3646d99bc930Sdanielk1977 * 3647d99bc930Sdanielk1977 * (op == TK_INSERT) 3648d99bc930Sdanielk1977 * orconf -> stores the ON CONFLICT algorithm 3649d99bc930Sdanielk1977 * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then 3650d99bc930Sdanielk1977 * this stores a pointer to the SELECT statement. Otherwise NULL. 365146408354Sdan * zTarget -> Dequoted name of the table to insert into. 3652d99bc930Sdanielk1977 * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then 3653d99bc930Sdanielk1977 * this stores values to be inserted. Otherwise NULL. 3654d99bc930Sdanielk1977 * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ... 3655ad3cab52Sdrh * statement, then this stores the column-names to be 3656ad3cab52Sdrh * inserted into. 3657d99bc930Sdanielk1977 * 3658d99bc930Sdanielk1977 * (op == TK_DELETE) 365946408354Sdan * zTarget -> Dequoted name of the table to delete from. 3660d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the DELETE statement if one is specified. 3661d99bc930Sdanielk1977 * Otherwise NULL. 3662d99bc930Sdanielk1977 * 3663d99bc930Sdanielk1977 * (op == TK_UPDATE) 366446408354Sdan * zTarget -> Dequoted name of the table to update. 3665d99bc930Sdanielk1977 * pWhere -> The WHERE clause of the UPDATE statement if one is specified. 3666d99bc930Sdanielk1977 * Otherwise NULL. 3667d99bc930Sdanielk1977 * pExprList -> A list of the columns to update and the expressions to update 36684adee20fSdanielk1977 * them to. See sqlite3Update() documentation of "pChanges" 3669ad3cab52Sdrh * argument. 3670d99bc930Sdanielk1977 * 3671d99bc930Sdanielk1977 */ 3672c3f9bad2Sdanielk1977 struct TriggerStep { 3673dac9a5f7Sdrh u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT, 3674dac9a5f7Sdrh ** or TK_RETURNING */ 3675b1819a0bSdrh u8 orconf; /* OE_Rollback etc. */ 3676a69d9168Sdrh Trigger *pTrig; /* The trigger that this step is a part of */ 367746408354Sdan Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */ 367846408354Sdan char *zTarget; /* Target table for DELETE, UPDATE, INSERT */ 3679e7877b2dSdan SrcList *pFrom; /* FROM clause for UPDATE statement (if any) */ 3680b1819a0bSdrh Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */ 3681381bdaccSdrh ExprList *pExprList; /* SET clause for UPDATE, or RETURNING clause */ 3682b1819a0bSdrh IdList *pIdList; /* Column names for INSERT */ 368346d2e5c3Sdrh Upsert *pUpsert; /* Upsert clauses on an INSERT */ 3684f259df5fSdrh char *zSpan; /* Original SQL text of this command */ 3685c3f9bad2Sdanielk1977 TriggerStep *pNext; /* Next in the link-list */ 3686187e4c6aSdrh TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */ 3687c3f9bad2Sdanielk1977 }; 3688c3f9bad2Sdanielk1977 3689d99bc930Sdanielk1977 /* 3690b8352479Sdrh ** Information about a RETURNING clause 3691b8352479Sdrh */ 3692b8352479Sdrh struct Returning { 3693b8352479Sdrh Parse *pParse; /* The parse that includes the RETURNING clause */ 3694b8352479Sdrh ExprList *pReturnEL; /* List of expressions to return */ 3695b8352479Sdrh Trigger retTrig; /* The transient trigger that implements RETURNING */ 3696b8352479Sdrh TriggerStep retTStep; /* The trigger step */ 3697381bdaccSdrh int iRetCur; /* Transient table holding RETURNING results */ 3698381bdaccSdrh int nRetCol; /* Number of in pReturnEL after expansion */ 3699552562c4Sdrh int iRetReg; /* Register array for holding a row of RETURNING */ 3700b8352479Sdrh }; 3701b8352479Sdrh 3702b8352479Sdrh /* 3703ade86483Sdrh ** An objected used to accumulate the text of a string where we 3704ade86483Sdrh ** do not necessarily know how big the string will be in the end. 3705ade86483Sdrh */ 37060cdbe1aeSdrh struct sqlite3_str { 3707633e6d57Sdrh sqlite3 *db; /* Optional database for lookaside. Can be NULL */ 3708ade86483Sdrh char *zText; /* The string collected so far */ 3709fa385edfSdrh u32 nAlloc; /* Amount of space allocated in zText */ 3710fa385edfSdrh u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */ 37113f18e6d7Sdrh u32 nChar; /* Length of the string so far */ 37120cdbe1aeSdrh u8 accError; /* SQLITE_NOMEM or SQLITE_TOOBIG */ 37135f4a686fSdrh u8 printfFlags; /* SQLITE_PRINTF flags below */ 3714ade86483Sdrh }; 37155f4a686fSdrh #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */ 37165f4a686fSdrh #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */ 37175f4a686fSdrh #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */ 37185f4a686fSdrh 37195f4a686fSdrh #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0) 37205f4a686fSdrh 3721ade86483Sdrh 3722ade86483Sdrh /* 3723234c39dfSdrh ** A pointer to this structure is used to communicate information 3724234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback. 3725234c39dfSdrh */ 3726234c39dfSdrh typedef struct { 37279bb575fdSdrh sqlite3 *db; /* The database being initialized */ 3728234c39dfSdrh char **pzErrMsg; /* Error message stored here */ 3729a451017dSdrh int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */ 373015ca1df1Sdrh int rc; /* Result code stored here */ 3731987db767Sdan u32 mInitFlags; /* Flags controlling error messages */ 37326b86e51eSdrh u32 nInitRow; /* Number of rows processed */ 37333b3ddbaeSdrh Pgno mxPage; /* Maximum page number. 0 for no limit. */ 3734234c39dfSdrh } InitData; 3735234c39dfSdrh 3736b6c29897Sdrh /* 3737987db767Sdan ** Allowed values for mInitFlags 3738987db767Sdan */ 37396a5a13dfSdan #define INITFLAG_AlterRename 0x0001 /* Reparse after a RENAME */ 37406a5a13dfSdan #define INITFLAG_AlterDrop 0x0002 /* Reparse after a DROP COLUMN */ 3741987db767Sdan 3742987db767Sdan /* 374340257ffdSdrh ** Structure containing global configuration data for the SQLite library. 374433589797Sdrh ** 374533589797Sdrh ** This structure also contains some state information. 374640257ffdSdrh */ 374740257ffdSdrh struct Sqlite3Config { 3748fec00eabSdrh int bMemstat; /* True to enable memory status */ 374930842990Sdrh u8 bCoreMutex; /* True to enable core mutexing */ 375030842990Sdrh u8 bFullMutex; /* True to enable full mutexing */ 375130842990Sdrh u8 bOpenUri; /* True to interpret filenames as URIs */ 375230842990Sdrh u8 bUseCis; /* Use covering indices for full-scans */ 375330842990Sdrh u8 bSmallMalloc; /* Avoid large memory allocations if true */ 375430842990Sdrh u8 bExtraSchemaChecks; /* Verify type,name,tbl_name in schema */ 37550a687d12Sdrh int mxStrlen; /* Maximum string length */ 375609fe6143Sdrh int neverCorrupt; /* Database is always well-formed */ 3757633e6d57Sdrh int szLookaside; /* Default lookaside buffer size */ 3758633e6d57Sdrh int nLookaside; /* Default lookaside buffer count */ 37598c71a98cSdrh int nStmtSpill; /* Stmt-journal spill-to-disk threshold */ 3760fec00eabSdrh sqlite3_mem_methods m; /* Low-level memory allocation interface */ 37616d2ab0e4Sdanielk1977 sqlite3_mutex_methods mutex; /* Low-level mutex interface */ 376222e21ff4Sdan sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */ 376340257ffdSdrh void *pHeap; /* Heap storage space */ 376433589797Sdrh int nHeap; /* Size of pHeap[] */ 376533589797Sdrh int mnReq, mxReq; /* Min and max heap requests sizes */ 37669b4c59faSdrh sqlite3_int64 szMmap; /* mmap() space per open file */ 37679b4c59faSdrh sqlite3_int64 mxMmap; /* Maximum value for szMmap */ 376833589797Sdrh void *pPage; /* Page cache memory */ 376933589797Sdrh int szPage; /* Size of each page in pPage[] */ 377033589797Sdrh int nPage; /* Number of pages in pPage[] */ 37711875f7a3Sdrh int mxParserStack; /* maximum depth of the parser stack */ 37721875f7a3Sdrh int sharedCacheEnabled; /* true if shared-cache mode enabled */ 37733bd1791dSdrh u32 szPma; /* Maximum Sorter PMA size */ 37741875f7a3Sdrh /* The above might be initialized to non-zero. The following need to always 37751875f7a3Sdrh ** initially be zero, however. */ 377671bc31c6Sdanielk1977 int isInit; /* True after initialization has finished */ 3777502b4e00Sdanielk1977 int inProgress; /* True while initialization in progress */ 3778e1ab2193Sdan int isMutexInit; /* True after mutexes are initialized */ 377971bc31c6Sdanielk1977 int isMallocInit; /* True after malloc is initialized */ 3780e1ab2193Sdan int isPCacheInit; /* True after malloc is initialized */ 378193ed56d9Sdrh int nRefInitMutex; /* Number of users of pInitMutex */ 3782c007f61bSdrh sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */ 37833f280701Sdrh void (*xLog)(void*,int,const char*); /* Function for logging */ 37843f280701Sdrh void *pLogArg; /* First argument to xLog() */ 3785ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG 3786ac455939Sdan void(*xSqllog)(void*,sqlite3*,const char*, int); 3787ac455939Sdan void *pSqllogArg; 3788ac455939Sdan #endif 3789688852abSdrh #ifdef SQLITE_VDBE_COVERAGE 3790688852abSdrh /* The following callback (if not NULL) is invoked on every VDBE branch 3791688852abSdrh ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE. 3792688852abSdrh */ 37937083a487Sdrh void (*xVdbeBranch)(void*,unsigned iSrcLine,u8 eThis,u8 eMx); /* Callback */ 3794688852abSdrh void *pVdbeBranchArg; /* 1st argument */ 3795688852abSdrh #endif 379623a88595Sdrh #ifdef SQLITE_ENABLE_DESERIALIZE 379723a88595Sdrh sqlite3_int64 mxMemdbSize; /* Default max memdb size */ 379823a88595Sdrh #endif 3799d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 3800c007f61bSdrh int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */ 3801c007f61bSdrh #endif 3802c007f61bSdrh int bLocaltimeFault; /* True to fail localtime() calls */ 38039e5eb9c8Sdrh int iOnceResetThreshold; /* When to reset OP_Once counters */ 38042e3a5a81Sdan u32 szSorterRef; /* Min size in bytes to use sorter-refs */ 3805ade54d68Sdrh unsigned int iPrngSeed; /* Alternative fixed seed for the PRNG */ 380640257ffdSdrh }; 380740257ffdSdrh 380840257ffdSdrh /* 380909fe6143Sdrh ** This macro is used inside of assert() statements to indicate that 381009fe6143Sdrh ** the assert is only valid on a well-formed database. Instead of: 381109fe6143Sdrh ** 381209fe6143Sdrh ** assert( X ); 381309fe6143Sdrh ** 381409fe6143Sdrh ** One writes: 381509fe6143Sdrh ** 3816b2023665Sdrh ** assert( X || CORRUPT_DB ); 381709fe6143Sdrh ** 3818b2023665Sdrh ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate 3819b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt. 3820b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special 3821b2023665Sdrh ** sqlite3_test_control(). This enables assert() statements to prove 3822b2023665Sdrh ** things that are always true for well-formed databases. 382309fe6143Sdrh */ 3824b2023665Sdrh #define CORRUPT_DB (sqlite3Config.neverCorrupt==0) 382509fe6143Sdrh 382609fe6143Sdrh /* 38277d10d5a6Sdrh ** Context pointer passed down through the tree-walk. 38287d10d5a6Sdrh */ 38297d10d5a6Sdrh struct Walker { 38309bfb024dSdrh Parse *pParse; /* Parser context. */ 38317d10d5a6Sdrh int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */ 38327d10d5a6Sdrh int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */ 3833b290f117Sdan void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */ 3834030796dfSdrh int walkerDepth; /* Number of subqueries */ 3835dfa15270Sdrh u16 eCode; /* A small processing code */ 38367d10d5a6Sdrh union { /* Extra data for callback */ 38377d10d5a6Sdrh NameContext *pNC; /* Naming context */ 3838059b2d50Sdrh int n; /* A counter */ 3839059b2d50Sdrh int iCur; /* A cursor number */ 3840374fdce4Sdrh SrcList *pSrcList; /* FROM clause */ 3841030796dfSdrh struct SrcCount *pSrcCount; /* Counting column references */ 38422f2b0278Sdrh struct CCurHint *pCCurHint; /* Used by codeCursorHint() */ 38432a0b527bSdrh int *aiCol; /* array of column indexes */ 38442409f8a1Sdrh struct IdxCover *pIdxCover; /* Check for index coverage */ 3845cd0abc24Sdrh struct IdxExprTrans *pIdxTrans; /* Convert idxed expr to column */ 3846ab31a845Sdan ExprList *pGroupBy; /* GROUP BY clause */ 3847cd0abc24Sdrh Select *pSelect; /* HAVING to WHERE clause ctx */ 384886fb6e17Sdan struct WindowRewrite *pRewrite; /* Window rewrite context */ 3849660ee556Sdrh struct WhereConst *pConst; /* WHERE clause constants */ 3850cf8f2895Sdan struct RenameCtx *pRename; /* RENAME COLUMN context */ 3851dfa15270Sdrh struct Table *pTab; /* Table of generated column */ 38527601294aSdrh SrcItem *pSrcItem; /* A single FROM clause item */ 3853f380c3f1Sdan DbFixer *pFix; 38547d10d5a6Sdrh } u; 38557d10d5a6Sdrh }; 38567d10d5a6Sdrh 3857f380c3f1Sdan /* 3858f380c3f1Sdan ** The following structure contains information used by the sqliteFix... 3859f380c3f1Sdan ** routines as they walk the parse tree to make database references 3860f380c3f1Sdan ** explicit. 3861f380c3f1Sdan */ 3862f380c3f1Sdan struct DbFixer { 3863f380c3f1Sdan Parse *pParse; /* The parsing context. Error messages written here */ 3864f380c3f1Sdan Walker w; /* Walker object */ 3865f380c3f1Sdan Schema *pSchema; /* Fix items to this schema */ 3866f380c3f1Sdan u8 bTemp; /* True for TEMP schema entries */ 3867f380c3f1Sdan const char *zDb; /* Make sure all objects are contained in this database */ 3868f380c3f1Sdan const char *zType; /* Type of the container - used for error messages */ 3869f380c3f1Sdan const Token *pName; /* Name of the container - used for error messages */ 3870f380c3f1Sdan }; 3871f380c3f1Sdan 38727d10d5a6Sdrh /* Forward declarations */ 38737d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*); 38747d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*); 38757d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*); 38767d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*); 38777d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*); 38785b88bc4bSdrh int sqlite3ExprWalkNoop(Walker*, Expr*); 3879979dd1beSdrh int sqlite3SelectWalkNoop(Walker*, Select*); 38807e6f980bSdrh int sqlite3SelectWalkFail(Walker*, Select*); 3881e40cc16bSdrh int sqlite3WalkerDepthIncrease(Walker*,Select*); 3882e40cc16bSdrh void sqlite3WalkerDepthDecrease(Walker*,Select*); 3883e40cc16bSdrh 3884979dd1beSdrh #ifdef SQLITE_DEBUG 3885979dd1beSdrh void sqlite3SelectWalkAssert2(Walker*, Select*); 3886979dd1beSdrh #endif 38877d10d5a6Sdrh 38887d10d5a6Sdrh /* 38897d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their 38907d10d5a6Sdrh ** callbacks. 38917d10d5a6Sdrh */ 38922bf90f1eSdrh #define WRC_Continue 0 /* Continue down into children */ 38932bf90f1eSdrh #define WRC_Prune 1 /* Omit children but continue walking siblings */ 38942bf90f1eSdrh #define WRC_Abort 2 /* Abandon the tree walk */ 38957d10d5a6Sdrh 38967d10d5a6Sdrh /* 3897f824b41eSdrh ** A single common table expression 38987d562dbeSdan */ 3899f824b41eSdrh struct Cte { 39004e9119d9Sdan char *zName; /* Name of this CTE */ 39014e9119d9Sdan ExprList *pCols; /* List of explicit column names, or NULL */ 3902c49832c2Sdrh Select *pSelect; /* The definition of this CTE */ 39030576bc59Sdrh const char *zCteErr; /* Error message for circular references */ 3904a79e2a2dSdrh CteUse *pUse; /* Usage information for this CTE */ 3905745912efSdrh u8 eM10d; /* The MATERIALIZED flag */ 3906f824b41eSdrh }; 3907f824b41eSdrh 3908f824b41eSdrh /* 3909745912efSdrh ** Allowed values for the materialized flag (eM10d): 3910745912efSdrh */ 3911745912efSdrh #define M10d_Yes 0 /* AS MATERIALIZED */ 3912745912efSdrh #define M10d_Any 1 /* Not specified. Query planner's choice */ 3913745912efSdrh #define M10d_No 2 /* AS NOT MATERIALIZED */ 3914745912efSdrh 3915745912efSdrh /* 3916f824b41eSdrh ** An instance of the With object represents a WITH clause containing 3917f824b41eSdrh ** one or more CTEs (common table expressions). 3918f824b41eSdrh */ 3919f824b41eSdrh struct With { 3920f824b41eSdrh int nCte; /* Number of CTEs in the WITH clause */ 3921f824b41eSdrh With *pOuter; /* Containing WITH clause, or NULL */ 3922f824b41eSdrh Cte a[1]; /* For each CTE in the WITH clause.... */ 39237d562dbeSdan }; 39247d562dbeSdan 3925a79e2a2dSdrh /* 3926a79e2a2dSdrh ** The Cte object is not guaranteed to persist for the entire duration 3927a79e2a2dSdrh ** of code generation. (The query flattener or other parser tree 3928a79e2a2dSdrh ** edits might delete it.) The following object records information 3929a79e2a2dSdrh ** about each Common Table Expression that must be preserved for the 3930a79e2a2dSdrh ** duration of the parse. 3931a79e2a2dSdrh ** 3932a79e2a2dSdrh ** The CteUse objects are freed using sqlite3ParserAddCleanup() rather 3933a79e2a2dSdrh ** than sqlite3SelectDelete(), which is what enables them to persist 3934a79e2a2dSdrh ** until the end of code generation. 3935a79e2a2dSdrh */ 3936a79e2a2dSdrh struct CteUse { 3937a79e2a2dSdrh int nUse; /* Number of users of this CTE */ 3938a79e2a2dSdrh int addrM9e; /* Start of subroutine to compute materialization */ 3939a79e2a2dSdrh int regRtn; /* Return address register for addrM9e subroutine */ 3940a79e2a2dSdrh int iCur; /* Ephemeral table holding the materialization */ 3941a79e2a2dSdrh LogEst nRowEst; /* Estimated number of rows in the table */ 3942745912efSdrh u8 eM10d; /* The MATERIALIZED flag */ 3943a79e2a2dSdrh }; 3944a79e2a2dSdrh 3945a79e2a2dSdrh 39464fa4a54fSdrh #ifdef SQLITE_DEBUG 39474fa4a54fSdrh /* 39484fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of 39494fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view. 39504fa4a54fSdrh */ 39514fa4a54fSdrh struct TreeView { 39524fa4a54fSdrh int iLevel; /* Which level of the tree we are on */ 3953b08cd3f3Sdrh u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */ 39544fa4a54fSdrh }; 39554fa4a54fSdrh #endif /* SQLITE_DEBUG */ 39564fa4a54fSdrh 39579a94722dSdan /* 3958df9d3244Sdan ** This object is used in various ways, most (but not all) related to window 3959df9d3244Sdan ** functions. 3960a1fd4b52Sdrh ** 3961a1fd4b52Sdrh ** (1) A single instance of this structure is attached to the 3962df9d3244Sdan ** the Expr.y.pWin field for each window function in an expression tree. 3963a1fd4b52Sdrh ** This object holds the information contained in the OVER clause, 3964a1fd4b52Sdrh ** plus additional fields used during code generation. 3965a1fd4b52Sdrh ** 3966a1fd4b52Sdrh ** (2) All window functions in a single SELECT form a linked-list 3967a1fd4b52Sdrh ** attached to Select.pWin. The Window.pFunc and Window.pExpr 3968a1fd4b52Sdrh ** fields point back to the expression that is the window function. 3969a1fd4b52Sdrh ** 3970a1fd4b52Sdrh ** (3) The terms of the WINDOW clause of a SELECT are instances of this 3971a1fd4b52Sdrh ** object on a linked list attached to Select.pWinDefn. 3972a1fd4b52Sdrh ** 3973df9d3244Sdan ** (4) For an aggregate function with a FILTER clause, an instance 3974df9d3244Sdan ** of this object is stored in Expr.y.pWin with eFrmType set to 3975df9d3244Sdan ** TK_FILTER. In this case the only field used is Window.pFilter. 3976df9d3244Sdan ** 3977a1fd4b52Sdrh ** The uses (1) and (2) are really the same Window object that just happens 3978fc15f4c5Sdrh ** to be accessible in two different ways. Use case (3) are separate objects. 39799a94722dSdan */ 398086fb6e17Sdan struct Window { 3981e3bf632cSdan char *zName; /* Name of window (may be NULL) */ 3982e7c9ca41Sdan char *zBase; /* Name of base window for chaining (may be NULL) */ 3983e3bf632cSdan ExprList *pPartition; /* PARTITION BY clause */ 3984e3bf632cSdan ExprList *pOrderBy; /* ORDER BY clause */ 3985fc15f4c5Sdrh u8 eFrmType; /* TK_RANGE, TK_GROUPS, TK_ROWS, or 0 */ 398686fb6e17Sdan u8 eStart; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 398786fb6e17Sdan u8 eEnd; /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */ 3988e7c9ca41Sdan u8 bImplicitFrame; /* True if frame was implicitly specified */ 3989fc15f4c5Sdrh u8 eExclude; /* TK_NO, TK_CURRENT, TK_TIES, TK_GROUP, or 0 */ 399086fb6e17Sdan Expr *pStart; /* Expression for "<expr> PRECEDING" */ 399186fb6e17Sdan Expr *pEnd; /* Expression for "<expr> FOLLOWING" */ 399275b0821eSdan Window **ppThis; /* Pointer to this object in Select.pWin list */ 399386fb6e17Sdan Window *pNextWin; /* Next window function belonging to this SELECT */ 3994a1fd4b52Sdrh Expr *pFilter; /* The FILTER expression */ 3995a1fd4b52Sdrh FuncDef *pFunc; /* The function */ 3996b0225bc5Sdrh int iEphCsr; /* Partition buffer or Peer buffer */ 3997d44c617aSdrh int regAccum; /* Accumulator */ 3998d44c617aSdrh int regResult; /* Interim result */ 3999c9a8668aSdan int csrApp; /* Function cursor (used by min/max) */ 4000c9a8668aSdan int regApp; /* Function register (also used by min/max) */ 4001b6f2deacSdan int regPart; /* Array of registers for PARTITION BY values */ 400286fb6e17Sdan Expr *pOwner; /* Expression object this window is attached to */ 400386fb6e17Sdan int nBufferCol; /* Number of columns in buffer table */ 400486fb6e17Sdan int iArgCol; /* Offset of first argument for this function */ 4005bf84515aSdan int regOne; /* Register containing constant value 1 */ 4006a0f6b833Sdan int regStartRowid; 4007a0f6b833Sdan int regEndRowid; 4008d44c617aSdrh u8 bExprArgs; /* Defer evaluation of window function arguments 4009d44c617aSdrh ** due to the SQLITE_SUBTYPE flag */ 401086fb6e17Sdan }; 401186fb6e17Sdan 401267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC 401386fb6e17Sdan void sqlite3WindowDelete(sqlite3*, Window*); 4014e2094572Sdrh void sqlite3WindowUnlinkFromSelect(Window*); 4015e3bf632cSdan void sqlite3WindowListDelete(sqlite3 *db, Window *p); 4016d35300f9Sdan Window *sqlite3WindowAlloc(Parse*, int, int, Expr*, int , Expr*, u8); 401786fb6e17Sdan void sqlite3WindowAttach(Parse*, Expr*, Window*); 4018a3fcc000Sdan void sqlite3WindowLink(Select *pSel, Window *pWin); 40194f9adee2Sdan int sqlite3WindowCompare(Parse*, Window*, Window*, int); 40204ea562eeSdan void sqlite3WindowCodeInit(Parse*, Select*); 4021dacf1de9Sdan void sqlite3WindowCodeStep(Parse*, Select*, WhereInfo*, int, int); 4022dfa552f4Sdan int sqlite3WindowRewrite(Parse*, Select*); 4023e3bf632cSdan void sqlite3WindowUpdate(Parse*, Window*, Window*, FuncDef*); 40242a11bb23Sdan Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p); 4025c95f38d4Sdan Window *sqlite3WindowListDup(sqlite3 *db, Window *p); 40269a94722dSdan void sqlite3WindowFunctions(void); 4027e7c9ca41Sdan void sqlite3WindowChain(Parse*, Window*, Window*); 4028e7c9ca41Sdan Window *sqlite3WindowAssemble(Parse*, Window*, ExprList*, ExprList*, Token*); 402967a9b8edSdan #else 403067a9b8edSdan # define sqlite3WindowDelete(a,b) 403167a9b8edSdan # define sqlite3WindowFunctions() 403267a9b8edSdan # define sqlite3WindowAttach(a,b,c) 403367a9b8edSdan #endif 403486fb6e17Sdan 40357d562dbeSdan /* 403666150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character, 403766150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character. 40384a919118Sdrh */ 40394a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) { \ 40404a919118Sdrh if( (*(zIn++))>=0xc0 ){ \ 40414a919118Sdrh while( (*zIn & 0xc0)==0x80 ){ zIn++; } \ 40424a919118Sdrh } \ 40434a919118Sdrh } 40444a919118Sdrh 40454a919118Sdrh /* 40469978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with 40479978c97eSdrh ** the same name but without the _BKPT suffix. These macros invoke 40489978c97eSdrh ** routines that report the line-number on which the error originated 40499978c97eSdrh ** using sqlite3_log(). The routines also provide a convenient place 40509978c97eSdrh ** to set a debugger breakpoint. 405149285708Sdrh */ 4052eebf2f57Sdan int sqlite3ReportError(int iErr, int lineno, const char *zType); 40539978c97eSdrh int sqlite3CorruptError(int); 40549978c97eSdrh int sqlite3MisuseError(int); 40559978c97eSdrh int sqlite3CantopenError(int); 40569978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__) 40579978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__) 40589978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__) 405932c49904Sdrh #ifdef SQLITE_DEBUG 406032c49904Sdrh int sqlite3NomemError(int); 406132c49904Sdrh int sqlite3IoerrnomemError(int); 4062fad3039cSmistachkin # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__) 4063fad3039cSmistachkin # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__) 406432c49904Sdrh #else 406532c49904Sdrh # define SQLITE_NOMEM_BKPT SQLITE_NOMEM 406632c49904Sdrh # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM 40673cdc8205Sdan #endif 40683cdc8205Sdan #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_CORRUPT_PGNO) 40693cdc8205Sdan int sqlite3CorruptPgnoError(int,Pgno); 40703cdc8205Sdan # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P)) 40713cdc8205Sdan #else 4072cc97ca4cSdrh # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__) 407332c49904Sdrh #endif 40749978c97eSdrh 40754553f6eaSdrh /* 40764553f6eaSdrh ** FTS3 and FTS4 both require virtual table support 40774553f6eaSdrh */ 40784553f6eaSdrh #if defined(SQLITE_OMIT_VIRTUALTABLE) 40794553f6eaSdrh # undef SQLITE_ENABLE_FTS3 40804553f6eaSdrh # undef SQLITE_ENABLE_FTS4 40814553f6eaSdrh #endif 408249285708Sdrh 408349285708Sdrh /* 4084b4a1fed2Sdrh ** FTS4 is really an extension for FTS3. It is enabled using the 408560ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call 408660ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3. 4087b4a1fed2Sdrh */ 4088b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3) 40890ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1 4090b4a1fed2Sdrh #endif 4091b4a1fed2Sdrh 4092b4a1fed2Sdrh /* 409379f02cefSdrh ** The ctype.h header is needed for non-ASCII systems. It is also 409479f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation. 409579f02cefSdrh */ 409679f02cefSdrh #if !defined(SQLITE_ASCII) || \ 409779f02cefSdrh (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION)) 409879f02cefSdrh # include <ctype.h> 409979f02cefSdrh #endif 410079f02cefSdrh 410179f02cefSdrh /* 410278ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(), 410378ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The 410478ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale. 410578ca0e7eSdanielk1977 */ 410678ca0e7eSdanielk1977 #ifdef SQLITE_ASCII 410778ca0e7eSdanielk1977 # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20)) 410878ca0e7eSdanielk1977 # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01) 4109dc86e2b2Sdrh # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06) 4110dc86e2b2Sdrh # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02) 411178ca0e7eSdanielk1977 # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04) 411278ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08) 411378ca0e7eSdanielk1977 # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)]) 4114244b9d6eSdrh # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80) 411578ca0e7eSdanielk1977 #else 411678ca0e7eSdanielk1977 # define sqlite3Toupper(x) toupper((unsigned char)(x)) 411778ca0e7eSdanielk1977 # define sqlite3Isspace(x) isspace((unsigned char)(x)) 411878ca0e7eSdanielk1977 # define sqlite3Isalnum(x) isalnum((unsigned char)(x)) 4119dc86e2b2Sdrh # define sqlite3Isalpha(x) isalpha((unsigned char)(x)) 412078ca0e7eSdanielk1977 # define sqlite3Isdigit(x) isdigit((unsigned char)(x)) 412178ca0e7eSdanielk1977 # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x)) 412278ca0e7eSdanielk1977 # define sqlite3Tolower(x) tolower((unsigned char)(x)) 4123244b9d6eSdrh # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`') 412478ca0e7eSdanielk1977 #endif 412597348b37Sdrh int sqlite3IsIdChar(u8); 412678ca0e7eSdanielk1977 412778ca0e7eSdanielk1977 /* 412875897234Sdrh ** Internal function prototypes 412975897234Sdrh */ 413080738d9cSdrh int sqlite3StrICmp(const char*,const char*); 4131ea678832Sdrh int sqlite3Strlen30(const char*); 41327301e774Sdrh #define sqlite3Strlen30NN(C) (strlen(C)&0x3fffffff) 4133d7564865Sdrh char *sqlite3ColumnType(Column*,char*); 4134ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp 41352e588c75Sdanielk1977 413640257ffdSdrh int sqlite3MallocInit(void); 4137fec00eabSdrh void sqlite3MallocEnd(void); 4138da4ca9d1Sdrh void *sqlite3Malloc(u64); 4139da4ca9d1Sdrh void *sqlite3MallocZero(u64); 4140da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64); 4141da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64); 4142575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3*, u64); 414317435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*); 4144da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64); 41459b2e0435Sdrh char *sqlite3DbSpanDup(sqlite3*,const char*,const char*); 4146da4ca9d1Sdrh void *sqlite3Realloc(void*, u64); 4147da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64); 4148da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64); 4149633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*); 4150dbd6a7dcSdrh void sqlite3DbFreeNN(sqlite3*, void*); 4151a7a8e14bSdanielk1977 int sqlite3MallocSize(void*); 4152633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*); 4153facf0307Sdrh void *sqlite3PageMalloc(int); 4154facf0307Sdrh void sqlite3PageFree(void*); 4155fec00eabSdrh void sqlite3MemSetDefault(void); 4156d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 4157171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void)); 4158f5ed7ad6Sdrh #endif 415950d1b5f3Sdrh int sqlite3HeapNearlyFull(void); 41602e588c75Sdanielk1977 4161e7b34707Sdrh /* 4162e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make 4163e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects. By default, 4164e7b34707Sdrh ** obtain space from malloc(). 4165e7b34707Sdrh ** 4166e7b34707Sdrh ** The alloca() routine never returns NULL. This will cause code paths 4167e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable. 4168e7b34707Sdrh */ 4169e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA 4170e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) alloca(N) 4171e7b34707Sdrh # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N) 4172e7b34707Sdrh # define sqlite3StackFree(D,P) 4173e7b34707Sdrh #else 4174e7b34707Sdrh # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N) 4175e7b34707Sdrh # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N) 4176e7b34707Sdrh # define sqlite3StackFree(D,P) sqlite3DbFree(D,P) 4177e7b34707Sdrh #endif 4178e7b34707Sdrh 41795d513ba0Sdrh /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they 41805d513ba0Sdrh ** are, disable MEMSYS3 41815d513ba0Sdrh */ 4182f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5 4183f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void); 41845d513ba0Sdrh #undef SQLITE_ENABLE_MEMSYS3 41855d513ba0Sdrh #endif 41865d513ba0Sdrh #ifdef SQLITE_ENABLE_MEMSYS3 41875d513ba0Sdrh const sqlite3_mem_methods *sqlite3MemGetMemsys3(void); 4188f3d3c27aSdanielk1977 #endif 4189f3d3c27aSdanielk1977 4190f3d3c27aSdanielk1977 419118472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT 4192558814f8Sdan sqlite3_mutex_methods const *sqlite3DefaultMutex(void); 4193558814f8Sdan sqlite3_mutex_methods const *sqlite3NoopMutex(void); 419459f8c08eSdanielk1977 sqlite3_mutex *sqlite3MutexAlloc(int); 4195d025174fSdanielk1977 int sqlite3MutexInit(void); 4196d025174fSdanielk1977 int sqlite3MutexEnd(void); 419765bbf29eSdrh #endif 41980e8729dbSdrh #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP) 41996081c1dbSdrh void sqlite3MemoryBarrier(void); 42000e8729dbSdrh #else 420104abf087Smistachkin # define sqlite3MemoryBarrier() 4202f7141990Sdrh #endif 4203f7141990Sdrh 4204af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int); 4205af89fe66Sdrh void sqlite3StatusUp(int, int); 4206af89fe66Sdrh void sqlite3StatusDown(int, int); 4207b02392e6Sdrh void sqlite3StatusHighwater(int, int); 420852fb8e19Sdrh int sqlite3LookasideUsed(sqlite3*,int*); 4209f7141990Sdrh 4210af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */ 4211af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void); 4212af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void); 4213af89fe66Sdrh 421461f8e86fSdan #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT) 42158385becfSdan void sqlite3MutexWarnOnContention(sqlite3_mutex*); 42168385becfSdan #else 42178385becfSdan # define sqlite3MutexWarnOnContention(x) 42188385becfSdan #endif 42198385becfSdan 422085c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT 422105921223Sdrh # define EXP754 (((u64)0x7ff)<<52) 422205921223Sdrh # define MAN754 ((((u64)1)<<52)-1) 422305921223Sdrh # define IsNaN(X) (((X)&EXP754)==EXP754 && ((X)&MAN754)!=0) 42240de3ae95Sdrh int sqlite3IsNaN(double); 422585c8f291Sdrh #else 422605921223Sdrh # define IsNaN(X) 0 422785c8f291Sdrh # define sqlite3IsNaN(X) 0 422885c8f291Sdrh #endif 42290de3ae95Sdrh 4230a5c1416dSdrh /* 4231a5c1416dSdrh ** An instance of the following structure holds information about SQL 4232a5c1416dSdrh ** functions arguments that are the parameters to the printf() function. 4233a5c1416dSdrh */ 4234a5c1416dSdrh struct PrintfArguments { 4235a5c1416dSdrh int nArg; /* Total number of arguments */ 4236a5c1416dSdrh int nUsed; /* Number of arguments used so far */ 4237a5c1416dSdrh sqlite3_value **apArg; /* The argument values */ 4238a5c1416dSdrh }; 4239a5c1416dSdrh 424017435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...); 424117435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list); 424202b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE) 4243e54ca3feSdrh void sqlite3DebugPrintf(const char*, ...); 4244d919fe17Sdrh #endif 4245d919fe17Sdrh #if defined(SQLITE_TEST) 4246e8f52c50Sdrh void *sqlite3TestTextToPtr(const char*); 424787cc3b31Sdrh #endif 42487e02e5e6Sdrh 42494fa4a54fSdrh #if defined(SQLITE_DEBUG) 42504fa4a54fSdrh void sqlite3TreeViewExpr(TreeView*, const Expr*, u8); 4251db97e562Sdrh void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*); 42524fa4a54fSdrh void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*); 4253145d0a35Sdrh void sqlite3TreeViewSrcList(TreeView*, const SrcList*); 42544fa4a54fSdrh void sqlite3TreeViewSelect(TreeView*, const Select*, u8); 42552476a6f2Sdrh void sqlite3TreeViewWith(TreeView*, const With*, u8); 4256a1fd4b52Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC 4257a1fd4b52Sdrh void sqlite3TreeViewWindow(TreeView*, const Window*, u8); 4258a1fd4b52Sdrh void sqlite3TreeViewWinFunc(TreeView*, const Window*, u8); 4259a1fd4b52Sdrh #endif 42607e02e5e6Sdrh #endif 42617e02e5e6Sdrh 42627e02e5e6Sdrh 426322c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*); 42644adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...); 4265c3dcdba3Sdrh int sqlite3ErrorToParser(sqlite3*,int); 4266244b9d6eSdrh void sqlite3Dequote(char*); 426751d35b0fSdrh void sqlite3DequoteExpr(Expr*); 426840aced5cSdrh void sqlite3TokenInit(Token*,char*); 42692646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int); 42704adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **); 427180242055Sdrh void sqlite3FinishCoding(Parse*); 4272892d3179Sdrh int sqlite3GetTempReg(Parse*); 4273892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int); 4274892d3179Sdrh int sqlite3GetTempRange(Parse*,int); 4275892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int); 4276cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*); 4277bb9b5f26Sdrh #ifdef SQLITE_DEBUG 4278bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse*,int,int); 4279bb9b5f26Sdrh #endif 4280b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int); 4281b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*); 4282b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*); 4283abfd35eaSdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*); 428408de4f79Sdrh void sqlite3PExprAddSelect(Parse*, Expr*, Select*); 4285d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse*,Expr*, Expr*); 428617180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr*); 4287954733b3Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*, int); 42880dfa5255Sdrh void sqlite3ExprFunctionUsable(Parse*,Expr*,FuncDef*); 4289de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32); 4290633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*); 42918e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse*, Expr*); 4292b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*); 4293a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*); 42946e11892dSdan void sqlite3ExprListSetSortOrder(ExprList*,int,int); 4295b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int); 42961be266baSdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*); 4297633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*); 42982308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*); 42998d40673cSdrh int sqlite3IndexHasDuplicateRootPage(Index*); 43009bb575fdSdrh int sqlite3Init(sqlite3*, char**); 4301234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**); 4302987db767Sdan int sqlite3InitOne(sqlite3*, int, char**, u32); 430391cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int); 43042fcc1590Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 43052fcc1590Sdrh Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName); 43062fcc1590Sdrh #endif 430781028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*); 430881028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int); 430981028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*); 43109bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*); 431151be3873Sdrh void sqlite3DeleteColumnNames(sqlite3*,Table*); 43128981b904Sdrh int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**); 431381506b88Sdrh void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*,char); 431481506b88Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*,char); 4315346a70caSdrh void sqlite3OpenSchemaTable(Parse *, int); 43164415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*); 4317b9bcf7caSdrh i16 sqlite3TableColumnToIndex(Index*, i16); 431881f7b372Sdrh #ifdef SQLITE_OMIT_GENERATED_COLUMNS 4319b9bcf7caSdrh # define sqlite3TableColumnToStorage(T,X) (X) /* No-op pass-through */ 4320b9bcf7caSdrh # define sqlite3StorageColumnToTable(T,X) (X) /* No-op pass-through */ 432181f7b372Sdrh #else 4322b9bcf7caSdrh i16 sqlite3TableColumnToStorage(Table*, i16); 4323b9bcf7caSdrh i16 sqlite3StorageColumnToTable(Table*, i16); 432481f7b372Sdrh #endif 4325f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int); 4326e6110505Sdrh #if SQLITE_ENABLE_HIDDEN_COLUMNS 4327ba68f8f3Sdan void sqlite3ColumnPropertiesFromName(Table*, Column*); 4328e6110505Sdrh #else 4329e6110505Sdrh # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */ 4330e6110505Sdrh #endif 43312881ab62Sdrh void sqlite3AddColumn(Parse*,Token*,Token*); 43324adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int); 4333fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int); 433492e21ef0Sdrh void sqlite3AddCheckConstraint(Parse*, Expr*, const char*, const char*); 43351be266baSdrh void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*); 433639002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*); 433781f7b372Sdrh void sqlite3AddGenerated(Parse*,Expr*,Token*); 43385969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*); 43392053f313Sdrh void sqlite3AddReturning(Parse*,ExprList*); 4340522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*, 4341522c26fbSdrh sqlite3_vfs**,char**,char **); 4342e5989723Sdrh #define sqlite3CodecQueryParameters(A,B,C) 0 4343421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*); 4344b7f9164eSdrh 4345d12602a9Sdrh #ifdef SQLITE_UNTESTABLE 4346c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK 4347c007f61bSdrh #else 4348c007f61bSdrh int sqlite3FaultSim(int); 4349c007f61bSdrh #endif 4350c007f61bSdrh 4351f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32); 4352f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32); 435382ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32); 4354f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32); 4355e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*); 4356f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*); 4357bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*); 4358d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 43593088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*); 4360f5ed7ad6Sdrh #endif 4361f5e7bb51Sdrh 43629d67afc4Sdrh RowSet *sqlite3RowSetInit(sqlite3*); 43639d67afc4Sdrh void sqlite3RowSetDelete(void*); 43649d67afc4Sdrh void sqlite3RowSetClear(void*); 43653d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64); 4366d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64); 43673d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*); 43683d4501e5Sdrh 43698981b904Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int); 4370fe3fcbe2Sdanielk1977 4371fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) 43724adee20fSdanielk1977 int sqlite3ViewGetColumnNames(Parse*,Table*); 4373b7f9164eSdrh #else 4374b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0 4375b7f9164eSdrh #endif 4376b7f9164eSdrh 4377a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30 4378a7ab6d81Sdrh int sqlite3DbMaskAllZero(yDbMask); 4379a7ab6d81Sdrh #endif 4380a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int); 4381faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int); 43821feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*); 4383cf8f2895Sdan void sqlite3FreeIndex(sqlite3*, Index*); 43840b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT 43850b9f50d8Sdrh void sqlite3AutoincrementBegin(Parse *pParse); 43860b9f50d8Sdrh void sqlite3AutoincrementEnd(Parse *pParse); 43870b9f50d8Sdrh #else 43880b9f50d8Sdrh # define sqlite3AutoincrementBegin(X) 43890b9f50d8Sdrh # define sqlite3AutoincrementEnd(X) 43900b9f50d8Sdrh #endif 439146d2e5c3Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int, Upsert*); 4392c1431144Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4393dd6cc9b5Sdrh void sqlite3ComputeGeneratedColumns(Parse*, int, Table*); 4394c1431144Sdrh #endif 43956c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*); 43965496d6a2Sdan IdList *sqlite3IdListAppend(Parse*, IdList*, Token*); 43974adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*); 439829c992cbSdrh SrcList *sqlite3SrcListEnlarge(Parse*, SrcList*, int, int); 439969887c99Sdan SrcList *sqlite3SrcListAppendList(Parse *pParse, SrcList *p1, SrcList *p2); 440029c992cbSdrh SrcList *sqlite3SrcListAppend(Parse*, SrcList*, Token*, Token*); 4401b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, 440285574e31Sdanielk1977 Token*, Select*, Expr*, IdList*); 4403b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *); 440401d230ceSdrh void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*); 44057601294aSdrh int sqlite3IndexedByLookup(Parse *, SrcItem *); 440661dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*); 44074adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*); 4408633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*); 4409633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*); 4410bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**); 441162340f84Sdrh void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*, 441262340f84Sdrh Expr*, int, int, u8); 44134d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int); 44147d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*); 441517435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*, 44168c0833fbSdrh Expr*,ExprList*,u32,Expr*); 4417633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*); 44184adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*); 44194adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int); 4420c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int); 4421273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY) 44228c0833fbSdrh Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*); 44234281bd42Sshane #endif 44248c0833fbSdrh void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*); 4425eac9fabbSdrh void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*, 4426eac9fabbSdrh Upsert*); 442746ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int); 44284adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*); 4429c3489bbfSdrh LogEst sqlite3WhereOutputRowCount(WhereInfo*); 44306f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*); 44316f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*); 44326ee5a7b4Sdrh int sqlite3WhereOrderByLimitOptLabel(WhereInfo*); 4433d193057aSdrh void sqlite3WhereMinMaxOptEarlyOut(Vdbe*,WhereInfo*); 4434374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*); 44356f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*); 44366f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*); 4437fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*); 4438b0264eecSdrh #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */ 4439b0264eecSdrh #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */ 4440b0264eecSdrh #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */ 4441be3da241Sdrh int sqlite3WhereUsesDeferredSeek(WhereInfo*); 44421f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int); 4443a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8); 44446df9c4b9Sdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int); 4445b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int); 444605a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int); 4447e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS 4448e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(Parse*, Column*, int); 4449e70fa7feSdrh #endif 44501c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse*, Expr*, int); 445105a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int); 44529b258c54Sdrh int sqlite3ExprCodeRunJustOnce(Parse*, Expr*, int); 44532dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*); 4454678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int); 44555579d59fSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8); 4456d1a01edaSdrh #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */ 4457d1a01edaSdrh #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */ 44585579d59fSdrh #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */ 4459257c13faSdan #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */ 44604adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int); 44614adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int); 446272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int); 44639bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*); 44644d249e61Sdrh #define LOCATE_VIEW 0x01 44654d249e61Sdrh #define LOCATE_NOERR 0x02 44664d249e61Sdrh Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*); 44677601294aSdrh Table *sqlite3LocateTableItem(Parse*,u32 flags,SrcItem *); 44689bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*); 44699bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*); 44709bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*); 44712f6239edSdrh void sqlite3Vacuum(Parse*,Token*,Expr*); 44722f6239edSdrh int sqlite3RunVacuum(char**, sqlite3*, int, sqlite3_value*); 447317435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*); 44745aa550cfSdan int sqlite3ExprCompare(Parse*,Expr*, Expr*, int); 4475f9463dfbSdrh int sqlite3ExprCompareSkip(Expr*, Expr*, int); 4476619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int); 44775aa550cfSdan int sqlite3ExprImpliesExpr(Parse*,Expr*, Expr*, int); 44782589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr*,int); 447989636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker*,Parse*); 4480d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*); 4481d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*); 44822409f8a1Sdrh int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx); 4483030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*); 44844adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*); 4485d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 44862fa1868fSdrh void sqlite3PrngSaveState(void); 44872fa1868fSdrh void sqlite3PrngRestoreState(void); 4488f5ed7ad6Sdrh #endif 44890f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int); 44904adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int); 449157966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb); 4492684917c2Sdrh void sqlite3BeginTransaction(Parse*, int); 449307a3b11aSdrh void sqlite3EndTransaction(Parse*,int); 4494fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*); 4495fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *); 44964245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*); 44970cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char*); 4498171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr*); 449996acafbeSdrh int sqlite3ExprTruthValue(const Expr*); 45004adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*); 45010a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*); 4502feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8); 4503ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*); 4504059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int); 4505ffc648cfSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS 45065b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr*); 4507ffc648cfSdrh #endif 45084adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*); 4509039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*); 4510039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char); 45114adee20fSdanielk1977 int sqlite3IsRowid(const char*); 4512f0ee1d3cSdan void sqlite3GenerateRowDelete( 4513f0ee1d3cSdan Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int); 4514f0ee1d3cSdan void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int); 45151c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int); 451687744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int); 4517e9816d82Sdrh int sqlite3ExprReferencesUpdatedColumn(Expr*,int*,int); 4518f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int, 4519788d55aaSdrh u8,u8,int,int*,int*,Upsert*); 4520d447dcedSdrh #ifdef SQLITE_ENABLE_NULL_TRIM 4521585ce192Sdrh void sqlite3SetMakeRecordP5(Vdbe*,Table*); 4522d447dcedSdrh #else 4523d447dcedSdrh # define sqlite3SetMakeRecordP5(A,B) 4524d447dcedSdrh #endif 452526198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int); 4526fd261ec6Sdan int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*); 45274adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int); 4528ff738bceSdrh void sqlite3MultiWrite(Parse*); 4529e0af83acSdan void sqlite3MayAbort(Parse*); 4530f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8); 4531f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*); 4532f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*); 45336ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int); 45346ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int); 45356ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int); 453617435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*); 45376ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int); 453819efd0dbSdrh FuncDef *sqlite3FunctionSearch(int,const char*); 453980738d9cSdrh void sqlite3InsertBuiltinFuncs(FuncDef*,int); 454080738d9cSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8); 454180738d9cSdrh void sqlite3RegisterBuiltinFunctions(void); 4542777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void); 454380738d9cSdrh void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*); 45447e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*); 45457e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*); 45469cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int); 4547fa4e62f3Sshane 4548fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) 45498c0833fbSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int); 4550fa4e62f3Sshane #endif 4551b7f9164eSdrh 4552b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER 4553ef2cb63eSdanielk1977 void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*, 455460218d2aSdrh Expr*,int, int); 45554adee20fSdanielk1977 void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*); 4556fdd48a76Sdrh void sqlite3DropTrigger(Parse*, SrcList*, int); 455774161705Sdrh void sqlite3DropTriggerPtr(Parse*, Trigger*); 45582f886d1dSdanielk1977 Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask); 45592f886d1dSdanielk1977 Trigger *sqlite3TriggerList(Parse *, Table *); 4560165921a7Sdan void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *, 456194d7f50aSdan int, int, int); 45621da40a38Sdan void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int); 4563dc379456Sdrh void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*); 4564633e6d57Sdrh void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*); 4565f259df5fSdrh TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*, 4566f259df5fSdrh const char*,const char*); 45675be60c55Sdan TriggerStep *sqlite3TriggerInsertStep(Parse*,Token*, IdList*, 456846d2e5c3Sdrh Select*,u8,Upsert*, 45692c2e844aSdrh const char*,const char*); 4570e7877b2dSdan TriggerStep *sqlite3TriggerUpdateStep(Parse*,Token*,SrcList*,ExprList*, 4571e7877b2dSdan Expr*, u8, const char*,const char*); 45725be60c55Sdan TriggerStep *sqlite3TriggerDeleteStep(Parse*,Token*, Expr*, 4573f259df5fSdrh const char*,const char*); 4574633e6d57Sdrh void sqlite3DeleteTrigger(sqlite3*, Trigger*); 4575b7f9164eSdrh void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*); 4576bb5f168fSdan u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int); 4577e7877b2dSdan SrcList *sqlite3TriggerStepSrc(Parse*, TriggerStep*); 457865a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p)) 4579c149f18fSdrh # define sqlite3IsToplevel(p) ((p)->pToplevel==0) 4580b7f9164eSdrh #else 458162c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0 4582633e6d57Sdrh # define sqlite3DeleteTrigger(A,B) 4583cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B) 4584b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C) 458594d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 458675cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F) 45872943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0 458865a7cd16Sdan # define sqlite3ParseToplevel(p) p 4589c149f18fSdrh # define sqlite3IsToplevel(p) 1 4590bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0 4591e7877b2dSdan # define sqlite3TriggerStepSrc(A,B) 0 4592b7f9164eSdrh #endif 4593b7f9164eSdrh 45944adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*); 45956e6d9833Sdan int sqlite3ColumnIndex(Table *pTab, const char *zCol); 45968103a036Sdrh void sqlite3SetJoinExpr(Expr*,int); 45970202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int); 45984adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int); 4599ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION 4600728b5779Sdrh void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*); 46014adee20fSdanielk1977 int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*); 46024adee20fSdanielk1977 void sqlite3AuthContextPush(Parse*, AuthContext*, const char*); 46034adee20fSdanielk1977 void sqlite3AuthContextPop(AuthContext*); 460402470b20Sdan int sqlite3AuthReadCol(Parse*, const char *, const char *, int); 4605ed6c8671Sdrh #else 4606b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d) 46074adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK 46084adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c) 46094adee20fSdanielk1977 # define sqlite3AuthContextPop(a) ((void)(a)) 4610ed6c8671Sdrh #endif 4611465c2b89Sdan int sqlite3DbIsNamed(sqlite3 *db, int iDb, const char *zName); 4612f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*); 4613f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*); 4614d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*); 46154adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*); 46164adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*); 46174adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*); 46184adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*); 46198a3884efSdrh int sqlite3RealSameAsInt(double,sqlite3_int64); 462082b0f106Sdrh void sqlite3Int64ToText(i64,char*); 46219339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8); 4622fec19aadSdrh int sqlite3GetInt32(const char *, int*); 4623abc38158Sdrh int sqlite3GetUInt32(const char*, u32*); 462460ac3f42Sdrh int sqlite3Atoi(const char*); 4625f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4626ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar); 4627f0f44b79Sdrh #endif 4628ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte); 462942610961Sdrh u32 sqlite3Utf8Read(const u8**); 4630bf539c4dSdrh LogEst sqlite3LogEst(u64); 4631bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst); 4632bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4633bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double); 4634bf539c4dSdrh #endif 463514bfd991Sdrh #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \ 4636175b8f06Sdrh defined(SQLITE_ENABLE_STAT4) || \ 4637d566c951Sdrh defined(SQLITE_EXPLAIN_ESTIMATED_ROWS) 4638bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst); 4639d566c951Sdrh #endif 46409bf755ccSdrh VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int); 46419bf755ccSdrh const char *sqlite3VListNumToName(VList*,int); 46429bf755ccSdrh int sqlite3VListNameToNum(VList*,const char*,int); 46433f8d5cfcSshane 46443f8d5cfcSshane /* 46453f8d5cfcSshane ** Routines to read and write variable-length integers. These used to 46463f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c 46472f2b2b85Sdrh ** file. 46483f8d5cfcSshane */ 4649192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64); 46501bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *); 46511bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *); 4652192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v); 46533f8d5cfcSshane 46543f8d5cfcSshane /* 46552f2b2b85Sdrh ** The common case is for a varint to be a single byte. They following 46562f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call 46572f2b2b85Sdrh ** the procedure for larger varints. 46583f8d5cfcSshane */ 46594bde3702Sdrh #define getVarint32(A,B) \ 46604bde3702Sdrh (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B))) 466102a95eb9Sdrh #define getVarint32NR(A,B) \ 466202a95eb9Sdrh B=(u32)*(A);if(B>=0x80)sqlite3GetVarint32((A),(u32*)&(B)) 46634bde3702Sdrh #define putVarint32(A,B) \ 46644bde3702Sdrh (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\ 46652f2b2b85Sdrh sqlite3PutVarint((A),(B))) 46663f8d5cfcSshane #define getVarint sqlite3GetVarint 46673f8d5cfcSshane #define putVarint sqlite3PutVarint 46683f8d5cfcSshane 46693f8d5cfcSshane 4670e9107698Sdrh const char *sqlite3IndexAffinityStr(sqlite3*, Index*); 467157bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int); 4672e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2); 4673e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity); 46740dfa4f6fSdrh char sqlite3TableColumnAffinity(Table*,int); 4675e7375bfaSdrh char sqlite3ExprAffinity(const Expr *pExpr); 46769339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8); 46779296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*); 467813f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...); 467913f40da3Sdrh void sqlite3Error(sqlite3*,int); 468088efc796Sdrh void sqlite3ErrorClear(sqlite3*); 46811b9f2141Sdrh void sqlite3SystemError(sqlite3*,int); 4682ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n); 4683cd74b611Sdan u8 sqlite3HexToInt(int h); 4684ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **); 4685dd08ca0fSmistachkin 46865824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME) 4687f2c1c99fSmistachkin const char *sqlite3ErrName(int); 4688dd08ca0fSmistachkin #endif 4689dd08ca0fSmistachkin 46909c6396ecSdrh #ifdef SQLITE_ENABLE_DESERIALIZE 4691ac442f41Sdrh int sqlite3MemdbInit(void); 4692ac442f41Sdrh #endif 4693ac442f41Sdrh 4694f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int); 46958a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse); 4696c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int); 4697efad2e23Sdrh int sqlite3IsBinary(const CollSeq*); 4698c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName); 469942a630b1Sdrh void sqlite3SetTextEncoding(sqlite3 *db, u8); 4700e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr); 4701e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr); 4702e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse*,const Expr*,const Expr*); 470380103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int); 47040a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*); 47050a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*); 47060d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr*); 47077cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *); 47080f1c2eb5Sdrh int sqlite3WritableSchema(sqlite3*); 4709c5a93d4cSdrh int sqlite3CheckObjectName(Parse*, const char*,const char*,const char*); 4710b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int); 4711158b9cb9Sdrh int sqlite3AddInt64(i64*,i64); 4712158b9cb9Sdrh int sqlite3SubInt64(i64*,i64); 4713158b9cb9Sdrh int sqlite3MulInt64(i64*,i64); 4714d50ffc41Sdrh int sqlite3AbsInt32(int); 471581cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES 471681cc5163Sdrh void sqlite3FileSuffix3(const char*, char*); 471781cc5163Sdrh #else 471881cc5163Sdrh # define sqlite3FileSuffix3(X,Y) 471981cc5163Sdrh #endif 4720eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8); 47214e6af134Sdanielk1977 4722b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8); 4723b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8); 4724b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8, 47251e536953Sdanielk1977 void(*)(void*)); 4726a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*); 47274e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*); 47280c8f4038Sdrh #ifndef SQLITE_UNTESTABLE 47290c8f4038Sdrh void sqlite3ResultIntReal(sqlite3_context*); 47300c8f4038Sdrh #endif 47311e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *); 4732f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16 4733b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8); 4734f0f44b79Sdrh #endif 47351e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **); 4736b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8); 473746c99e0fSdrh #ifndef SQLITE_AMALGAMATION 4738a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[]; 4739f19aa5faSdrh extern const char sqlite3StrBINARY[]; 47404e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[]; 474178ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[]; 4742075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config; 474380738d9cSdrh extern FuncDefHash sqlite3BuiltinFunctions; 4744f83dc1efSdrh #ifndef SQLITE_OMIT_WSD 4745ddb68e17Sdrh extern int sqlite3PendingByte; 474646c99e0fSdrh #endif 47479216de8aSdrh #endif /* SQLITE_AMALGAMATION */ 474835043cc3Sdrh #ifdef VDBE_PROFILE 474935043cc3Sdrh extern sqlite3_uint64 sqlite3NProfileCnt; 475035043cc3Sdrh #endif 4751abc38158Sdrh void sqlite3RootPageMoved(sqlite3*, int, Pgno, Pgno); 47524343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*); 4753545f587fSdrh void sqlite3AlterFunctions(void); 47549fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*); 4755cf8f2895Sdan void sqlite3AlterRenameColumn(Parse*, SrcList*, Token*, Token*); 47569fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *); 47572958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...); 4758ba968dbfSdrh void sqlite3ExpirePreparedStatements(sqlite3*, int); 475950ef6716Sdrh void sqlite3CodeRhsOfIN(Parse*, Expr*, int); 476085bcdce2Sdrh int sqlite3CodeSubselect(Parse*, Expr*); 47617d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*); 47627601294aSdrh int sqlite3ExpandSubquery(Parse*, SrcItem*); 4763923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p); 4764c4938ea2Sdrh int sqlite3MatchEName( 4765c4938ea2Sdrh const struct ExprList_item*, 4766c4938ea2Sdrh const char*, 4767c4938ea2Sdrh const char*, 4768c4938ea2Sdrh const char* 4769c4938ea2Sdrh ); 477074a07986Sdrh Bitmask sqlite3ExprColUsed(Expr*); 4771d44390c8Sdrh u8 sqlite3StrIHash(const char*); 47727d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*); 477301d230ceSdrh int sqlite3ResolveExprListNames(NameContext*, ExprList*); 47747d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*); 4775ee751fabSdrh int sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*); 47767d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*); 4777c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int); 477819a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *); 477919a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *); 47806e6d9833Sdan void sqlite3AlterDropColumn(Parse*, SrcList*, Token*); 478107e95233Sdan void *sqlite3RenameTokenMap(Parse*, void*, Token*); 478207e95233Sdan void sqlite3RenameTokenRemap(Parse*, void *pTo, void *pFrom); 47838900a48bSdan void sqlite3RenameExprUnmap(Parse*, Expr*); 4784e8ab40d2Sdan void sqlite3RenameExprlistUnmap(Parse*, ExprList*); 478579e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*); 47862e3a5a81Sdan char sqlite3AffinityType(const char*, Column*); 47879f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*); 4788783e159eSdrh int sqlite3InvokeBusyHandler(BusyHandler*); 4789ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*); 47900410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *); 4791cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB); 4792d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*); 479351147baaSdrh void sqlite3DefaultRowEst(Index*); 479455ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int); 4795d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*); 4796b6ee6607Sdrh void sqlite3SchemaClear(void *); 47971e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *); 4798e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *); 4799ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int); 48002ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*); 48012ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*); 48022ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*); 4803f9eae18bSdan KeyInfo *sqlite3KeyInfoFromExprList(Parse*, ExprList*, int, int); 4804aae0f74eSdrh const char *sqlite3SelectOpName(int); 48059105fd51Sdan int sqlite3HasExplicitNulls(Parse*, ExprList*); 4806f9eae18bSdan 48072ec2fb22Sdrh #ifdef SQLITE_DEBUG 48082ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*); 48092ec2fb22Sdrh #endif 4810771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *, 4811771151b6Sdanielk1977 void (*)(sqlite3_context*,int,sqlite3_value **), 4812660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4813660af939Sdan void (*)(sqlite3_context*), 4814660af939Sdan void (*)(sqlite3_context*), 4815660af939Sdan void (*)(sqlite3_context*,int,sqlite3_value **), 4816d2199f0fSdan FuncDestructor *pDestructor 4817d2199f0fSdan ); 481892011847Sdrh void sqlite3NoopDestructor(void*); 48194a642b60Sdrh void sqlite3OomFault(sqlite3*); 48204a642b60Sdrh void sqlite3OomClear(sqlite3*); 482154f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int); 4822ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *); 482369dab1d3Sdrh 4824c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int); 4825ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*); 48261013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int); 4827f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int); 48281e536953Sdanielk1977 48290410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *); 48300410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *); 48310410302eSdanielk1977 4832f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY 4833f9b2e05cSdan int sqlite3ExprCheckIN(Parse*, Expr*); 4834f9b2e05cSdan #else 4835f9b2e05cSdan # define sqlite3ExprCheckIN(x,y) SQLITE_OK 4836f9b2e05cSdan #endif 4837f9b2e05cSdan 4838175b8f06Sdrh #ifdef SQLITE_ENABLE_STAT4 4839d66e5794Sdan int sqlite3Stat4ProbeSetValue( 4840d66e5794Sdan Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*); 4841b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**); 48427a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*); 4843b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**); 4844d66e5794Sdan char sqlite3IndexColumnAffinity(sqlite3*, Index*, int); 48459fecc546Sdrh #endif 48467a419235Sdan 484795bdbbbdSdrh /* 484895bdbbbdSdrh ** The interface to the LEMON-generated parser 484995bdbbbdSdrh */ 4850d26cc541Sdrh #ifndef SQLITE_AMALGAMATION 4851fb32c44eSdrh void *sqlite3ParserAlloc(void*(*)(u64), Parse*); 485295bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*)); 4853d26cc541Sdrh #endif 4854fb32c44eSdrh void sqlite3Parser(void*, int, Token); 485559ff4251Sdan int sqlite3ParserFallback(int); 4856ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH 4857ec424a5bSdrh int sqlite3ParserStackPeak(void*); 4858ec424a5bSdrh #endif 485995bdbbbdSdrh 48607aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*); 486169dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION 4862f1952c5dSdrh void sqlite3CloseExtensions(sqlite3*); 486369dab1d3Sdrh #else 486469dab1d3Sdrh # define sqlite3CloseExtensions(X) 486569dab1d3Sdrh #endif 4866e3026636Sdanielk1977 4867c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE 4868abc38158Sdrh void sqlite3TableLock(Parse *, int, Pgno, u8, const char *); 4869c00da105Sdanielk1977 #else 4870c00da105Sdanielk1977 #define sqlite3TableLock(v,w,x,y,z) 4871c00da105Sdanielk1977 #endif 4872c00da105Sdanielk1977 487353c14021Sdrh #ifdef SQLITE_TEST 487453c14021Sdrh int sqlite3Utf8To8(unsigned char*); 487553c14021Sdrh #endif 487653c14021Sdrh 4877b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE 4878595a523aSdanielk1977 # define sqlite3VtabClear(Y) 48799dbee7dcSdanielk1977 # define sqlite3VtabSync(X,Y) SQLITE_OK 4880f9e7dda7Sdanielk1977 # define sqlite3VtabRollback(X) 4881f9e7dda7Sdanielk1977 # define sqlite3VtabCommit(X) 4882093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) 0 4883595a523aSdanielk1977 # define sqlite3VtabLock(X) 4884595a523aSdanielk1977 # define sqlite3VtabUnlock(X) 4885cc5979dbSdrh # define sqlite3VtabModuleUnref(D,X) 4886595a523aSdanielk1977 # define sqlite3VtabUnlockList(X) 4887a311b803Sdan # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK 4888c3c8dac7Sdrh # define sqlite3GetVTable(X,Y) ((VTable*)0) 4889b9bb7c18Sdrh #else 48901feeaed2Sdan void sqlite3VtabClear(sqlite3 *db, Table*); 4891bba02a95Sdan void sqlite3VtabDisconnect(sqlite3 *db, Table *p); 4892016f7811Sdan int sqlite3VtabSync(sqlite3 *db, Vdbe*); 4893f9e7dda7Sdanielk1977 int sqlite3VtabRollback(sqlite3 *db); 4894f9e7dda7Sdanielk1977 int sqlite3VtabCommit(sqlite3 *db); 4895595a523aSdanielk1977 void sqlite3VtabLock(VTable *); 4896595a523aSdanielk1977 void sqlite3VtabUnlock(VTable *); 4897cc5979dbSdrh void sqlite3VtabModuleUnref(sqlite3*,Module*); 4898595a523aSdanielk1977 void sqlite3VtabUnlockList(sqlite3*); 4899a311b803Sdan int sqlite3VtabSavepoint(sqlite3 *, int, int); 4900016f7811Sdan void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*); 4901c3c8dac7Sdrh VTable *sqlite3GetVTable(sqlite3*, Table*); 49022fcc1590Sdrh Module *sqlite3VtabCreateModule( 49032fcc1590Sdrh sqlite3*, 49042fcc1590Sdrh const char*, 49052fcc1590Sdrh const sqlite3_module*, 49062fcc1590Sdrh void*, 49072fcc1590Sdrh void(*)(void*) 49082fcc1590Sdrh ); 4909093e0f6fSdanielk1977 # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0) 4910b9bb7c18Sdrh #endif 4911070ae3beSdrh int sqlite3ReadOnlyShadowTables(sqlite3 *db); 4912527cbd4aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE 4913527cbd4aSdrh int sqlite3ShadowTableName(sqlite3 *db, const char *zName); 49143d863b5eSdrh int sqlite3IsShadowTableOf(sqlite3*,Table*,const char*); 4915527cbd4aSdrh #else 4916527cbd4aSdrh # define sqlite3ShadowTableName(A,B) 0 49173d863b5eSdrh # define sqlite3IsShadowTableOf(A,B,C) 0 4918527cbd4aSdrh #endif 491951be3873Sdrh int sqlite3VtabEponymousTableInit(Parse*,Module*); 492051be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3*,Module*); 49214f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*); 4922b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int); 4923b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*); 4924b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*); 4925b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*); 492678efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **); 49277e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*); 49289e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *); 4929595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *); 49301e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*); 493195a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*); 49325f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int); 49334a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *); 4934f30a969bSdrh void sqlite3ParserReset(Parse*); 4935a79e2a2dSdrh void *sqlite3ParserAddCleanup(Parse*,void(*)(sqlite3*,void*),void*); 49368bee11a4Smistachkin #ifdef SQLITE_ENABLE_NORMALIZE 49371a6c2b1dSdrh char *sqlite3Normalize(Vdbe*, const char*); 49388bee11a4Smistachkin #endif 4939b900aaf3Sdrh int sqlite3Reprepare(Vdbe*); 4940b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*); 4941e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse*,const Expr*); 4942e7375bfaSdrh CollSeq *sqlite3BinaryCompareCollSeq(Parse *, const Expr*, const Expr*); 49431c514148Sdrh int sqlite3TempInMemory(const sqlite3*); 494428e5386fSdan const char *sqlite3JournalModename(int); 494506a2d825Sdan #ifndef SQLITE_OMIT_WAL 4946cdc1f049Sdan int sqlite3Checkpoint(sqlite3*, int, int, int*, int*); 4947b033d8b9Sdrh int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int); 494806a2d825Sdan #endif 49498b471863Sdrh #ifndef SQLITE_OMIT_CTE 4950745912efSdrh Cte *sqlite3CteNew(Parse*,Token*,ExprList*,Select*,u8); 4951f824b41eSdrh void sqlite3CteDelete(sqlite3*,Cte*); 4952f824b41eSdrh With *sqlite3WithAdd(Parse*,With*,Cte*); 49537d562dbeSdan void sqlite3WithDelete(sqlite3*,With*); 4954b290f117Sdan void sqlite3WithPush(Parse*, With*, u8); 49554e9119d9Sdan #else 4956f824b41eSdrh # define sqlite3CteNew(P,T,E,S) ((void*)0) 4957f824b41eSdrh # define sqlite3CteDelete(D,C) 4958f824b41eSdrh # define sqlite3CteWithAdd(P,W,C) ((void*)0) 4959eede6a53Sdan # define sqlite3WithDelete(x,y) 4960f824b41eSdrh # define sqlite3WithPush(x,y,z) 49618b471863Sdrh #endif 496246d2e5c3Sdrh #ifndef SQLITE_OMIT_UPSERT 49632549e4ccSdrh Upsert *sqlite3UpsertNew(sqlite3*,ExprList*,Expr*,ExprList*,Expr*,Upsert*); 496446d2e5c3Sdrh void sqlite3UpsertDelete(sqlite3*,Upsert*); 496546d2e5c3Sdrh Upsert *sqlite3UpsertDup(sqlite3*,Upsert*); 4966e9c2e772Sdrh int sqlite3UpsertAnalyzeTarget(Parse*,SrcList*,Upsert*); 49672cc00423Sdan void sqlite3UpsertDoUpdate(Parse*,Upsert*,Table*,Index*,int); 496861e280adSdrh Upsert *sqlite3UpsertOfIndex(Upsert*,Index*); 496961e280adSdrh int sqlite3UpsertNextIsIPK(Upsert*); 497046d2e5c3Sdrh #else 49712549e4ccSdrh #define sqlite3UpsertNew(u,v,w,x,y,z) ((Upsert*)0) 497246d2e5c3Sdrh #define sqlite3UpsertDelete(x,y) 497346d2e5c3Sdrh #define sqlite3UpsertDup(x,y) ((Upsert*)0) 497461e280adSdrh #define sqlite3UpsertOfIndex(x,y) ((Upsert*)0) 497561e280adSdrh #define sqlite3UpsertNextIsIPK(x) 0 497646d2e5c3Sdrh #endif 497746d2e5c3Sdrh 4978d829335eSdanielk1977 497975cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by 498075cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign 498175cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but 498275cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In 498375cbd984Sdan ** this case foreign keys are parsed, but no other functionality is 498475cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system). 498575cbd984Sdan */ 498675cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER) 49878ff2d956Sdan void sqlite3FkCheck(Parse*, Table*, int, int, int*, int); 4988d66c8309Sdan void sqlite3FkDropTable(Parse*, SrcList *, Table*); 49898ff2d956Sdan void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int); 4990e7a94d81Sdan int sqlite3FkRequired(Parse*, Table*, int*, int); 4991e7a94d81Sdan u32 sqlite3FkOldmask(Parse*, Table*); 4992432cc5b9Sdan FKey *sqlite3FkReferences(Table *); 49931da40a38Sdan #else 49948ff2d956Sdan #define sqlite3FkActions(a,b,c,d,e,f) 499567896cefSdan #define sqlite3FkCheck(a,b,c,d,e,f) 4996d66c8309Sdan #define sqlite3FkDropTable(a,b,c) 4997e7a94d81Sdan #define sqlite3FkOldmask(a,b) 0 499867896cefSdan #define sqlite3FkRequired(a,b,c,d) 0 4999e7eeeb99Sdan #define sqlite3FkReferences(a) 0 50001da40a38Sdan #endif 500175cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY 50021feeaed2Sdan void sqlite3FkDelete(sqlite3 *, Table*); 50036c5b915fSdrh int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**); 500475cbd984Sdan #else 50051feeaed2Sdan #define sqlite3FkDelete(a,b) 50066c5b915fSdrh #define sqlite3FkLocateIndex(a,b,c,d,e) 500775cbd984Sdan #endif 500875cbd984Sdan 5009643167ffSdrh 5010643167ffSdrh /* 5011643167ffSdrh ** Available fault injectors. Should be numbered beginning with 0. 5012643167ffSdrh */ 5013643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC 0 50147e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT 1 5015643167ffSdrh 5016643167ffSdrh /* 5017ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign" 5018d12602a9Sdrh ** malloc failures. This is only present if SQLITE_UNTESTABLE 5019ef05f2dfSdanielk1977 ** is not defined. 5020643167ffSdrh */ 5021d12602a9Sdrh #ifndef SQLITE_UNTESTABLE 50222d1d86fbSdanielk1977 void sqlite3BeginBenignMalloc(void); 50232d1d86fbSdanielk1977 void sqlite3EndBenignMalloc(void); 5024643167ffSdrh #else 50252d1d86fbSdanielk1977 #define sqlite3BeginBenignMalloc() 5026867d05a0Sdanielk1977 #define sqlite3EndBenignMalloc() 5027643167ffSdrh #endif 5028643167ffSdrh 50293a85625dSdrh /* 50303a85625dSdrh ** Allowed return values from sqlite3FindInIndex() 50313a85625dSdrh */ 50323a85625dSdrh #define IN_INDEX_ROWID 1 /* Search the rowid of the table */ 50333a85625dSdrh #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */ 50343a85625dSdrh #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */ 50353a85625dSdrh #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */ 5036bb53ecb1Sdrh #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */ 50373a85625dSdrh /* 50383a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex(). 50393a85625dSdrh */ 5040bb53ecb1Sdrh #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */ 5041bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */ 5042bb53ecb1Sdrh #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */ 50432c04131cSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*, int*); 50449a96b668Sdanielk1977 5045c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int); 5046c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *); 5047d67a9770Sdan #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \ 5048d67a9770Sdan || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE) 5049f55b8998Sdanielk1977 int sqlite3JournalCreate(sqlite3_file *); 5050c7b6017cSdanielk1977 #endif 5051c7b6017cSdanielk1977 50522491de28Sdan int sqlite3JournalIsInMemory(sqlite3_file *p); 5053b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *); 5054b3175389Sdanielk1977 50552308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p); 50560224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0 5057fc976065Sdanielk1977 int sqlite3SelectExprHeight(Select *); 50587d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse*, int); 5059fc976065Sdanielk1977 #else 50600224d26dSdrh #define sqlite3SelectExprHeight(x) 0 50617d10d5a6Sdrh #define sqlite3ExprCheckHeight(x,y) 5062fc976065Sdanielk1977 #endif 5063fc976065Sdanielk1977 5064a3152895Sdrh u32 sqlite3Get4byte(const u8*); 5065a3152895Sdrh void sqlite3Put4byte(u8*, u32); 5066a3152895Sdrh 5067404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY 5068404ca075Sdanielk1977 void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *); 5069404ca075Sdanielk1977 void sqlite3ConnectionUnlocked(sqlite3 *db); 5070404ca075Sdanielk1977 void sqlite3ConnectionClosed(sqlite3 *db); 5071404ca075Sdanielk1977 #else 5072404ca075Sdanielk1977 #define sqlite3ConnectionBlocked(x,y) 5073404ca075Sdanielk1977 #define sqlite3ConnectionUnlocked(x) 5074404ca075Sdanielk1977 #define sqlite3ConnectionClosed(x) 5075404ca075Sdanielk1977 #endif 5076404ca075Sdanielk1977 50776e736838Sdrh #ifdef SQLITE_DEBUG 50786e736838Sdrh void sqlite3ParserTrace(FILE*, char *); 50796e736838Sdrh #endif 50800d9de99cSdrh #if defined(YYCOVERAGE) 50810d9de99cSdrh int sqlite3ParserCoverage(FILE*); 50820d9de99cSdrh #endif 50836e736838Sdrh 5084b0603416Sdrh /* 5085b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable 50863a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to 5087b0603416Sdrh ** print I/O tracing messages. 5088b0603416Sdrh */ 5089b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE 50903a00f907Smlcreech # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; } 5091b4622b60Sdanielk1977 void sqlite3VdbeIOTraceSql(Vdbe*); 50929871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...); 5093b0603416Sdrh #else 5094b0603416Sdrh # define IOTRACE(A) 5095b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X) 5096b0603416Sdrh #endif 5097b0603416Sdrh 5098107b56e8Sdrh /* 5099107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator 5100107b56e8Sdrh ** only. They are used to verify that different "types" of memory 5101107b56e8Sdrh ** allocations are properly tracked by the system. 5102107b56e8Sdrh ** 5103107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of 5104107b56e8Sdrh ** the MEMTYPE_* macros defined below. The type must be a bitmask with 5105107b56e8Sdrh ** a single bit set. 5106107b56e8Sdrh ** 5107107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second 5108107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5109107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements. 5110107b56e8Sdrh ** 5111174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second 5112174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType(). 5113107b56e8Sdrh ** 5114107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP 5115174b9a16Sdrh ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means 5116174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was 5117174b9a16Sdrh ** too large or lookaside was already full. It is important to verify 5118174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not 5119174b9a16Sdrh ** passed back to non-lookaside free() routines. Asserts such as the 5120174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify 5121174b9a16Sdrh ** this constraint. 5122107b56e8Sdrh ** 5123107b56e8Sdrh ** All of this is no-op for a production build. It only comes into 5124107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used. 5125107b56e8Sdrh */ 5126107b56e8Sdrh #ifdef SQLITE_MEMDEBUG 5127107b56e8Sdrh void sqlite3MemdebugSetType(void*,u8); 5128107b56e8Sdrh int sqlite3MemdebugHasType(void*,u8); 5129174b9a16Sdrh int sqlite3MemdebugNoType(void*,u8); 5130107b56e8Sdrh #else 5131107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y) /* no-op */ 5132107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y) 1 5133174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y) 1 5134e3026636Sdanielk1977 #endif 5135107b56e8Sdrh #define MEMTYPE_HEAP 0x01 /* General heap allocations */ 5136d231aa3aSdrh #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */ 5137b2a0f75cSdrh #define MEMTYPE_PCACHE 0x04 /* Page cache allocations */ 5138107b56e8Sdrh 5139f51446a3Sdrh /* 5140f51446a3Sdrh ** Threading interface 5141f51446a3Sdrh */ 5142bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0 5143f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*); 5144f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**); 5145bf20a35dSdrh #endif 5146f51446a3Sdrh 5147a43c8c8aSdrh #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST) 5148a43c8c8aSdrh int sqlite3DbpageRegister(sqlite3*); 5149a43c8c8aSdrh #endif 51503e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST) 51513e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*); 51523e0327d5Sdrh #endif 5153107b56e8Sdrh 515471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr); 5155625015e0Sdan int sqlite3ExprIsVector(Expr *pExpr); 5156fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr*, int); 5157a1251bc4Sdrh Expr *sqlite3ExprForVectorField(Parse*,Expr*,int); 515844c5604cSdan void sqlite3VectorErrorMsg(Parse*, Expr*); 515971c57db0Sdan 51608999798eSdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS 5161da1f49b8Sdan const char **sqlite3CompileOptions(int *pnOpt); 51628999798eSdrh #endif 5163da1f49b8Sdan 516443f58d6aSdrh #endif /* SQLITEINT_H */ 5165