xref: /sqlite-3.40.0/src/sqliteInt.h (revision 191dd061)
175897234Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
375897234Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
675897234Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
1075897234Sdrh **
1175897234Sdrh *************************************************************************
1275897234Sdrh ** Internal interface definitions for SQLite.
1375897234Sdrh **
1475897234Sdrh */
15e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
16e3026636Sdanielk1977 #define _SQLITEINT_H_
1771674ce9Sdrh 
18bd0ae111Smlcreech /*
19bfc9b3f4Smistachkin ** Make sure that rand_s() is available on Windows systems with MSVC 2005
20bfc9b3f4Smistachkin ** or higher.
21bfc9b3f4Smistachkin */
22bfc9b3f4Smistachkin #if defined(_MSC_VER) && _MSC_VER>=1400
23bfc9b3f4Smistachkin #  define _CRT_RAND_S
24bfc9b3f4Smistachkin #endif
25bfc9b3f4Smistachkin 
26bfc9b3f4Smistachkin /*
272318d338Smistachkin ** Include the header file used to customize the compiler options for MSVC.
282318d338Smistachkin ** This should be done first so that it can successfully prevent spurious
292318d338Smistachkin ** compiler warnings due to subsequent content in this file and other files
302318d338Smistachkin ** that are included by this file.
312318d338Smistachkin */
322318d338Smistachkin #include "msvc.h"
332318d338Smistachkin 
342318d338Smistachkin /*
358cd5b254Sdrh ** Special setup for VxWorks
368cd5b254Sdrh */
378cd5b254Sdrh #include "vxworks.h"
388cd5b254Sdrh 
398cd5b254Sdrh /*
402210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the
412210dcc6Sdrh ** underlying operating system supports it.  If the OS lacks
422210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops.
432210dcc6Sdrh **
442210dcc6Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
452210dcc6Sdrh ** system #includes.  Hence, this block of code must be the very first
462210dcc6Sdrh ** code in all source files.
472210dcc6Sdrh **
482210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
492210dcc6Sdrh ** on the compiler command line.  This is necessary if you are compiling
502210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
512210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
522210dcc6Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
532210dcc6Sdrh ** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
542210dcc6Sdrh ** portability you should omit LFS.
552210dcc6Sdrh **
56dddf6978Sdrh ** The previous paragraph was written in 2005.  (This paragraph is written
57dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so
58dddf6978Sdrh ** you should probably leave LFS enabled.  But some embedded platforms might
59dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
60dddf6978Sdrh **
612210dcc6Sdrh ** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
622210dcc6Sdrh */
632210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS
642210dcc6Sdrh # define _LARGE_FILE       1
652210dcc6Sdrh # ifndef _FILE_OFFSET_BITS
662210dcc6Sdrh #   define _FILE_OFFSET_BITS 64
672210dcc6Sdrh # endif
682210dcc6Sdrh # define _LARGEFILE_SOURCE 1
692210dcc6Sdrh #endif
702210dcc6Sdrh 
71ad265296Sdrh /* What version of GCC is being used.  0 means GCC is not being used */
72ad265296Sdrh #ifdef __GNUC__
73ad265296Sdrh # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
74ad265296Sdrh #else
75ad265296Sdrh # define GCC_VERSION 0
76ad265296Sdrh #endif
77ad265296Sdrh 
7833ac4c8bSmistachkin /* Needed for various definitions... */
7933ac4c8bSmistachkin #if defined(__GNUC__) && !defined(_GNU_SOURCE)
8033ac4c8bSmistachkin # define _GNU_SOURCE
8133ac4c8bSmistachkin #endif
8233ac4c8bSmistachkin 
8333ac4c8bSmistachkin #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
8433ac4c8bSmistachkin # define _BSD_SOURCE
8533ac4c8bSmistachkin #endif
8633ac4c8bSmistachkin 
872210dcc6Sdrh /*
88a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its
89a7b3b635Smistachkin ** version information, among other things.  Normally, this internal MinGW
90a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header
91a7b3b635Smistachkin ** files; however, the contained version information is now required by this
92a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and
93a7b3b635Smistachkin ** this is the only known way to reliably obtain it.  This entire #if block
94a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting
95a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define
96a7b3b635Smistachkin ** some MinGW-specific macros).  When compiling for MinGW, either the
97a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
98a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be
99a7b3b635Smistachkin ** disabled.
100a7b3b635Smistachkin */
101a7b3b635Smistachkin #if defined(_HAVE_MINGW_H)
102a7b3b635Smistachkin # include "mingw.h"
103a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H)
104a7b3b635Smistachkin # include "_mingw.h"
105a7b3b635Smistachkin #endif
106a7b3b635Smistachkin 
107a7b3b635Smistachkin /*
108a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
109a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime
110a7b3b635Smistachkin ** library in use (e.g. for Windows XP).
111a7b3b635Smistachkin */
112a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
113a7b3b635Smistachkin     defined(_WIN32) && !defined(_WIN64) && \
11465acf373Smistachkin     defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
115a7b3b635Smistachkin     defined(__MSVCRT__)
116a7b3b635Smistachkin # define _USE_32BIT_TIME_T
117a7b3b635Smistachkin #endif
118a7b3b635Smistachkin 
1195e990beaSdrh /* The public SQLite interface.  The _FILE_OFFSET_BITS macro must appear
1200d71d121Smistachkin ** first in QNX.  Also, the _USE_32BIT_TIME_T macro must appear first for
1210d71d121Smistachkin ** MinGW.
1225e990beaSdrh */
1235e990beaSdrh #include "sqlite3.h"
1245e990beaSdrh 
125bd0ae111Smlcreech /*
1261e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
1271e12d43bSmlcreech ** autoconf-based build
128bd0ae111Smlcreech */
1291e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H
13098dc4b1aSmlcreech #include "config.h"
1311e12d43bSmlcreech #endif
1321e12d43bSmlcreech 
133bb4957f8Sdrh #include "sqliteLimit.h"
13498dc4b1aSmlcreech 
135e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
136e2965827Sdrh #if defined(__BORLANDC__)
137e2965827Sdrh #pragma warn -rch /* unreachable code */
138e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
139e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
140e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
141467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */
142e2965827Sdrh #endif
143e2965827Sdrh 
14498dc4b1aSmlcreech /*
14506af763eSdrh ** Include standard header files as necessary
14606af763eSdrh */
14706af763eSdrh #ifdef HAVE_STDINT_H
14806af763eSdrh #include <stdint.h>
14906af763eSdrh #endif
15006af763eSdrh #ifdef HAVE_INTTYPES_H
15106af763eSdrh #include <inttypes.h>
15206af763eSdrh #endif
15306af763eSdrh 
154a2460e07Sdrh /*
155c05a9a8aSdrh ** The following macros are used to cast pointers to integers and
156c05a9a8aSdrh ** integers to pointers.  The way you do this varies from one compiler
157c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements
158c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers.
159875e9e7dSdrh **
160c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type.
161c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or
162c05a9a8aSdrh ** if it is available, it requires an #include of specific headers
163c92271c5Sdrh ** that vary from one machine to the next.
164875e9e7dSdrh **
165875e9e7dSdrh ** Ticket #3860:  The llvm-gcc-4.2 compiler from Apple chokes on
166875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct.  But MSVC chokes on ((void*)(X)).
1675e49edcaSdrh ** So we have to define the macros in different ways depending on the
168875e9e7dSdrh ** compiler.
1691fc4129dSshane */
170c05a9a8aSdrh #if defined(__PTRDIFF_TYPE__)  /* This case should work for GCC */
171c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(__PTRDIFF_TYPE__)(X))
172c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(__PTRDIFF_TYPE__)(X))
173c05a9a8aSdrh #elif !defined(__GNUC__)       /* Works for compilers other than LLVM */
174c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)&((char*)0)[X])
175c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(((char*)X)-(char*)0))
176c05a9a8aSdrh #elif defined(HAVE_STDINT_H)   /* Use this case if we have ANSI headers */
177367882c2Sdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(intptr_t)(X))
178367882c2Sdrh # define SQLITE_PTR_TO_INT(X)  ((int)(intptr_t)(X))
179c05a9a8aSdrh #else                          /* Generates a warning - but it always works */
180875e9e7dSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(X))
181875e9e7dSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(X))
182367882c2Sdrh #endif
18371674ce9Sdrh 
184e5e7a901Sdrh /*
18514a924a5Sdrh ** A macro to hint to the compiler that a function should not be
18614a924a5Sdrh ** inlined.
18714a924a5Sdrh */
18814a924a5Sdrh #if defined(__GNUC__)
18914a924a5Sdrh #  define SQLITE_NOINLINE  __attribute__((noinline))
190ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310
19114a924a5Sdrh #  define SQLITE_NOINLINE  __declspec(noinline)
19214a924a5Sdrh #else
19314a924a5Sdrh #  define SQLITE_NOINLINE
19414a924a5Sdrh #endif
19514a924a5Sdrh 
19614a924a5Sdrh /*
197647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when
19860e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by
19960e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define.
200647ca46fSmistachkin */
20160e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC)
2029895f735Smistachkin #  if defined(_MSC_VER) && _MSC_VER>=1300
2039895f735Smistachkin #    if !defined(_WIN32_WCE)
204647ca46fSmistachkin #      include <intrin.h>
205647ca46fSmistachkin #      pragma intrinsic(_byteswap_ushort)
206647ca46fSmistachkin #      pragma intrinsic(_byteswap_ulong)
2078d9837acSmistachkin #      pragma intrinsic(_ReadWriteBarrier)
2089895f735Smistachkin #    else
2099895f735Smistachkin #      include <cmnintrin.h>
2109895f735Smistachkin #    endif
211647ca46fSmistachkin #  endif
21260e08078Smistachkin #endif
213647ca46fSmistachkin 
214647ca46fSmistachkin /*
21538c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
21638c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never
21738c67c36Sdrh ** threadsafe.  1 means the library is serialized which is the highest
218f7b5496eSdrh ** level of threadsafety.  2 means the library is multithreaded - multiple
21938c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same
22038c67c36Sdrh ** database connection at the same time.
22138c67c36Sdrh **
222e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
22338c67c36Sdrh ** We support that for legacy.
224e5e7a901Sdrh */
225e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
226e5e7a901Sdrh # if defined(THREADSAFE)
227e5e7a901Sdrh #   define SQLITE_THREADSAFE THREADSAFE
228e5e7a901Sdrh # else
22938c67c36Sdrh #   define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
230e5e7a901Sdrh # endif
231e5e7a901Sdrh #endif
232e5e7a901Sdrh 
23367080617Sdrh /*
234cb15f35fSdrh ** Powersafe overwrite is on by default.  But can be turned off using
235cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
236cb15f35fSdrh */
237cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE
238cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1
239cb15f35fSdrh #endif
240cb15f35fSdrh 
241cb15f35fSdrh /*
242d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
243d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
244d1dcb234Sdrh ** which case memory allocation statistics are disabled by default.
2450a732f59Sdanielk1977 */
2460a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
2470a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1
2480a732f59Sdanielk1977 #endif
2490a732f59Sdanielk1977 
2500a732f59Sdanielk1977 /*
2510d18020bSdrh ** Exactly one of the following macros must be defined in order to
2520d18020bSdrh ** specify which memory allocation subsystem to use.
2530d18020bSdrh **
2540d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
2551b186a99Smistachkin **     SQLITE_WIN32_MALLOC           // Use Win32 native heap API
256d1b0afc3Sdrh **     SQLITE_ZERO_MALLOC            // Use a stub allocator that always fails
2570d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
258a2460e07Sdrh **
259753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
260753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem
261753c5444Smistachkin ** will cause HeapValidate to be called.  If heap validation should fail, an
262753c5444Smistachkin ** assertion will be triggered.
263753c5444Smistachkin **
2640d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
2650d18020bSdrh ** the default.
2660d18020bSdrh */
267d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
268d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
269d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
270d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)>1
271d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\
27220b1ff07Smistachkin  are defined but at most one is allowed:\
273d1b0afc3Sdrh  SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
274d1b0afc3Sdrh  SQLITE_ZERO_MALLOC"
2750d18020bSdrh #endif
276d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
277d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
278d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
279d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)==0
2800d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
2810d18020bSdrh #endif
2820d18020bSdrh 
2830d18020bSdrh /*
2848a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
285eee4c8caSdrh ** sizes of memory allocations below this value where possible.
286eee4c8caSdrh */
2878a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
288eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
289eee4c8caSdrh #endif
290eee4c8caSdrh 
291eee4c8caSdrh /*
29267080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
29340b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
29440b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
29540b521f8Sdrh ** it.
29667080617Sdrh */
29740b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
29840b521f8Sdrh #  define _XOPEN_SOURCE 600
29967080617Sdrh #endif
300e3026636Sdanielk1977 
3017d10d5a6Sdrh /*
3021b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites.  It should always be true that
3031b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG).  If this is not currently true,
3041b28b893Sdrh ** make it true by defining or undefining NDEBUG.
3051b28b893Sdrh **
306443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the
307443dbcf5Sdrh ** assert() statements in the code.  So we want the default action
3081b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
3091b28b893Sdrh ** is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
3104b529d97Sdrh ** feature.
3114b529d97Sdrh */
312289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
3134b529d97Sdrh # define NDEBUG 1
3144b529d97Sdrh #endif
3151b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG)
3161b28b893Sdrh # undef NDEBUG
3171b28b893Sdrh #endif
3184b529d97Sdrh 
3196402250eSdrh /*
320c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
321c7379ce4Sdrh */
322c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
323c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
324c7379ce4Sdrh #endif
325c7379ce4Sdrh 
326c7379ce4Sdrh /*
32747c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing.  When
32847c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to
32947c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to
33047c3b3e0Sdrh ** get full branch coverage.  The testcase() macro is inserted
33147c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple
33247c3b3e0Sdrh ** condition/decision coverage is inadequate.  For example, testcase()
33347c3b3e0Sdrh ** can be used to make sure boundary values are tested.  For
33447c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit
33547c3b3e0Sdrh ** is significant and used at least once.  On switch statements
33647c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase()
33747c3b3e0Sdrh ** can insure that all cases are evaluated.
33847c3b3e0Sdrh **
33947c3b3e0Sdrh */
34047c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST
34147c3b3e0Sdrh   void sqlite3Coverage(int);
34247c3b3e0Sdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
34347c3b3e0Sdrh #else
34447c3b3e0Sdrh # define testcase(X)
3458f941bc7Sdrh #endif
3468f941bc7Sdrh 
3478f941bc7Sdrh /*
3488f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or
3498f941bc7Sdrh ** other bits of code that are needed to support the arguments
3508f941bc7Sdrh ** within testcase() and assert() macros.
3518f941bc7Sdrh */
3528f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
3538f941bc7Sdrh # define TESTONLY(X)  X
3548f941bc7Sdrh #else
35547c3b3e0Sdrh # define TESTONLY(X)
35647c3b3e0Sdrh #endif
35747c3b3e0Sdrh 
35847c3b3e0Sdrh /*
3596149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization
3606149526cSdrh ** to setup for a later assert() statement.  We do not want this code to
3616149526cSdrh ** appear when assert() is disabled.  The following macro is therefore
3626149526cSdrh ** used to contain that setup code.  The "VVA" acronym stands for
3636149526cSdrh ** "Verification, Validation, and Accreditation".  In other words, the
3646149526cSdrh ** code within VVA_ONLY() will only run during verification processes.
3656149526cSdrh */
3666149526cSdrh #ifndef NDEBUG
3676149526cSdrh # define VVA_ONLY(X)  X
3686149526cSdrh #else
3696149526cSdrh # define VVA_ONLY(X)
3706149526cSdrh #endif
3716149526cSdrh 
3726149526cSdrh /*
37347c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which
37447c3b3e0Sdrh ** are intended to always be true or false, respectively.  Such
37547c3b3e0Sdrh ** expressions could be omitted from the code completely.  But they
37647c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience
37747c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
37847c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first
37947c3b3e0Sdrh ** hint of unplanned behavior.
38047c3b3e0Sdrh **
38147c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code.
38247c3b3e0Sdrh **
38347c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
384443dbcf5Sdrh ** be true and false so that the unreachable code they specify will
38547c3b3e0Sdrh ** not be counted as untested code.
38647c3b3e0Sdrh */
38747c3b3e0Sdrh #if defined(SQLITE_COVERAGE_TEST)
38847c3b3e0Sdrh # define ALWAYS(X)      (1)
38947c3b3e0Sdrh # define NEVER(X)       (0)
39047c3b3e0Sdrh #elif !defined(NDEBUG)
3912de80f4cSdrh # define ALWAYS(X)      ((X)?1:(assert(0),0))
3922de80f4cSdrh # define NEVER(X)       ((X)?(assert(0),1):0)
39347c3b3e0Sdrh #else
39447c3b3e0Sdrh # define ALWAYS(X)      (X)
39547c3b3e0Sdrh # define NEVER(X)       (X)
39647c3b3e0Sdrh #endif
39747c3b3e0Sdrh 
39847c3b3e0Sdrh /*
399dad300d8Sdrh ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
400dad300d8Sdrh ** defined.  We need to defend against those failures when testing with
401dad300d8Sdrh ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
402dad300d8Sdrh ** during a normal build.  The following macro can be used to disable tests
403dad300d8Sdrh ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
404dad300d8Sdrh */
405dad300d8Sdrh #if defined(SQLITE_TEST_REALLOC_STRESS)
406dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  (X)
407dad300d8Sdrh #elif !defined(NDEBUG)
408dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  ((X)?(assert(0),1):0)
409dad300d8Sdrh #else
410dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  (0)
411dad300d8Sdrh #endif
412dad300d8Sdrh 
413dad300d8Sdrh /*
4140cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces.
4150cbcffa7Smistachkin */
416b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
417b10f22a1Smistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
4180cbcffa7Smistachkin   extern int sqlite3OSTrace;
4190cbcffa7Smistachkin # define OSTRACE(X)          if( sqlite3OSTrace ) sqlite3DebugPrintf X
4200cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE
4210cbcffa7Smistachkin #else
4220cbcffa7Smistachkin # define OSTRACE(X)
4230cbcffa7Smistachkin # undef  SQLITE_HAVE_OS_TRACE
4240cbcffa7Smistachkin #endif
4250cbcffa7Smistachkin 
4260cbcffa7Smistachkin /*
4275824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build?  Currently,
4285824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
4295824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are
4305824d44bSmistachkin ** compiled using SQLITE_TEST).
4315824d44bSmistachkin */
4325824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
4335824d44bSmistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
4345824d44bSmistachkin # define SQLITE_NEED_ERR_NAME
4355824d44bSmistachkin #else
4365824d44bSmistachkin # undef  SQLITE_NEED_ERR_NAME
4375824d44bSmistachkin #endif
4385824d44bSmistachkin 
4395824d44bSmistachkin /*
4407c621fb9Sdrh ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
4417c621fb9Sdrh */
4427c621fb9Sdrh #ifdef SQLITE_OMIT_EXPLAIN
4437c621fb9Sdrh # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
4447c621fb9Sdrh #endif
4457c621fb9Sdrh 
4467c621fb9Sdrh /*
44760ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large
4483e8e7ecbSdrh ** to fit in 32-bits.  This macro is used inside of various testcase()
4493e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support.
4503e8e7ecbSdrh */
451b31a6afaSdan #define IS_BIG_INT(X)  (((X)&~(i64)0xffffffff)!=0)
4523e8e7ecbSdrh 
4533e8e7ecbSdrh /*
45447c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean
45547c3b3e0Sdrh ** expression that is usually false.  Macro likely() surrounds
456443dbcf5Sdrh ** a boolean expression that is usually true.  These hints could,
457443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but
458443dbcf5Sdrh ** currently they are just comments for human readers.
45947c3b3e0Sdrh */
460443dbcf5Sdrh #define likely(X)    (X)
461443dbcf5Sdrh #define unlikely(X)  (X)
46247c3b3e0Sdrh 
463beae3194Sdrh #include "hash.h"
46475897234Sdrh #include "parse.h"
46575897234Sdrh #include <stdio.h>
46675897234Sdrh #include <stdlib.h>
46775897234Sdrh #include <string.h>
46875897234Sdrh #include <assert.h>
46952370e2cSdrh #include <stddef.h>
47075897234Sdrh 
471967e8b73Sdrh /*
472b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
473b37df7b9Sdrh ** substitute integer for floating-point
474b37df7b9Sdrh */
475b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
476b37df7b9Sdrh # define double sqlite_int64
4778b307fbfSdrh # define float sqlite_int64
478b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
479d1167393Sdrh # ifndef SQLITE_BIG_DBL
480cdaca55eSdrh #   define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
481d1167393Sdrh # endif
482b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
483b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
484110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
4850b3bf924Sdrh # undef SQLITE_HAVE_ISNAN
486b37df7b9Sdrh #endif
487d1167393Sdrh #ifndef SQLITE_BIG_DBL
488d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
489d1167393Sdrh #endif
490b37df7b9Sdrh 
491b37df7b9Sdrh /*
49253c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
49353c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
49453c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
49553c0f748Sdanielk1977 */
49653c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
49753c0f748Sdanielk1977 #define OMIT_TEMPDB 1
49853c0f748Sdanielk1977 #else
49953c0f748Sdanielk1977 #define OMIT_TEMPDB 0
50053c0f748Sdanielk1977 #endif
50153c0f748Sdanielk1977 
50253c0f748Sdanielk1977 /*
503d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
504d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
505d946db00Sdrh ** the default file format for new databases and the maximum file format
506d946db00Sdrh ** that the library can read.
507d946db00Sdrh */
508d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
509d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
510bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4
511d946db00Sdrh #endif
512d946db00Sdrh 
513a2460e07Sdrh /*
514a2460e07Sdrh ** Determine whether triggers are recursive by default.  This can be
515a2460e07Sdrh ** changed at run-time using a pragma.
516a2460e07Sdrh */
5175bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
5185bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
5195bde73c4Sdan #endif
5205bde73c4Sdan 
521d946db00Sdrh /*
522b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
52349766d6cSdrh ** on the command-line
52449766d6cSdrh */
525b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
526b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
527d16d0bc5Sdrh # define SQLITE_TEMP_STORE_xc 1  /* Exclude from ctime.c */
52849766d6cSdrh #endif
52949766d6cSdrh 
53049766d6cSdrh /*
531b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
532b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
533b3f56fdbSdan ** to zero.
534b3f56fdbSdan */
5356b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
536b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS
537028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0
538b3f56fdbSdan #endif
539b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS
5406b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8
541b3f56fdbSdan #endif
542a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS
543a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0
544a09c8855Sdrh #endif
545a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
546a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS
547a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
548a09c8855Sdrh #endif
549b3f56fdbSdan 
5504297c7c4Sdrh /*
5514297c7c4Sdrh ** The default initial allocation for the pagecache when using separate
5524297c7c4Sdrh ** pagecaches for each database connection.  A positive number is the
5534297c7c4Sdrh ** number of pages.  A negative number N translations means that a buffer
5544297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold.
5554297c7c4Sdrh */
5564297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
5574297c7c4Sdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 100
5584297c7c4Sdrh #endif
5594297c7c4Sdrh 
560b3f56fdbSdan /*
561f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
562f1974846Sdrh ** ourselves.
563f1974846Sdrh */
564f1974846Sdrh #ifndef offsetof
565f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
566f1974846Sdrh #endif
567f1974846Sdrh 
568f1974846Sdrh /*
569e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers.
570e1e2e9acSdrh */
57113969f5aSdrh #ifndef MIN
572e1e2e9acSdrh # define MIN(A,B) ((A)<(B)?(A):(B))
57313969f5aSdrh #endif
57413969f5aSdrh #ifndef MAX
575e1e2e9acSdrh # define MAX(A,B) ((A)>(B)?(A):(B))
57613969f5aSdrh #endif
577e1e2e9acSdrh 
578e1e2e9acSdrh /*
5794fa4a54fSdrh ** Swap two objects of type TYPE.
5804fa4a54fSdrh */
5814fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
5824fa4a54fSdrh 
5834fa4a54fSdrh /*
5849b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
5859b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
5869b8f447bSdrh */
5879b8f447bSdrh #if 'A' == '\301'
5889b8f447bSdrh # define SQLITE_EBCDIC 1
5899b8f447bSdrh #else
5909b8f447bSdrh # define SQLITE_ASCII 1
5919b8f447bSdrh #endif
5929b8f447bSdrh 
5939b8f447bSdrh /*
5945a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
5955a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
5965a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
5975a2c2c20Sdrh **
5985a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
59941a2b48bSdrh */
6005a2c2c20Sdrh #ifndef UINT32_TYPE
601dda5b68cSmlcreech # ifdef HAVE_UINT32_T
602dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
603dda5b68cSmlcreech # else
6045a2c2c20Sdrh #  define UINT32_TYPE unsigned int
6055a2c2c20Sdrh # endif
606dda5b68cSmlcreech #endif
6075a2c2c20Sdrh #ifndef UINT16_TYPE
608dda5b68cSmlcreech # ifdef HAVE_UINT16_T
609dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
610dda5b68cSmlcreech # else
6115a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
6125a2c2c20Sdrh # endif
613dda5b68cSmlcreech #endif
614939a16d6Sdrh #ifndef INT16_TYPE
615dda5b68cSmlcreech # ifdef HAVE_INT16_T
616dda5b68cSmlcreech #  define INT16_TYPE int16_t
617dda5b68cSmlcreech # else
618939a16d6Sdrh #  define INT16_TYPE short int
619939a16d6Sdrh # endif
620dda5b68cSmlcreech #endif
6215a2c2c20Sdrh #ifndef UINT8_TYPE
622dda5b68cSmlcreech # ifdef HAVE_UINT8_T
623dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
624dda5b68cSmlcreech # else
6255a2c2c20Sdrh #  define UINT8_TYPE unsigned char
6265a2c2c20Sdrh # endif
627dda5b68cSmlcreech #endif
628905793e2Sdrh #ifndef INT8_TYPE
629dda5b68cSmlcreech # ifdef HAVE_INT8_T
630dda5b68cSmlcreech #  define INT8_TYPE int8_t
631dda5b68cSmlcreech # else
632905793e2Sdrh #  define INT8_TYPE signed char
633905793e2Sdrh # endif
634dda5b68cSmlcreech #endif
635efad9995Sdrh #ifndef LONGDOUBLE_TYPE
636efad9995Sdrh # define LONGDOUBLE_TYPE long double
637efad9995Sdrh #endif
638efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
63927436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
6405a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
6415a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
642939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
6435a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
64470a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
6455a2c2c20Sdrh 
6465a2c2c20Sdrh /*
64735cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
64835cd643cSdrh ** that can be stored in a u32 without loss of data.  The value
64935cd643cSdrh ** is 0x00000000ffffffff.  But because of quirks of some compilers, we
65035cd643cSdrh ** have to specify the value in the less intuitive manner shown:
65135cd643cSdrh */
65235cd643cSdrh #define SQLITE_MAX_U32  ((((u64)1)<<32)-1)
65335cd643cSdrh 
65435cd643cSdrh /*
655faacf17cSdrh ** The datatype used to store estimates of the number of rows in a
656faacf17cSdrh ** table or index.  This is an unsigned integer type.  For 99.9% of
657faacf17cSdrh ** the world, a 32-bit integer is sufficient.  But a 64-bit integer
658faacf17cSdrh ** can be used at compile-time if desired.
659faacf17cSdrh */
660faacf17cSdrh #ifdef SQLITE_64BIT_STATS
661faacf17cSdrh  typedef u64 tRowcnt;    /* 64-bit only if requested at compile-time */
662faacf17cSdrh #else
663faacf17cSdrh  typedef u32 tRowcnt;    /* 32-bit is the default */
664faacf17cSdrh #endif
665faacf17cSdrh 
666faacf17cSdrh /*
667bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit
668bf539c4dSdrh ** logarithms.  For quantity X, the value stored is 10*log2(X).  This
669bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986.
670bf539c4dSdrh ** But the allowed values are "grainy".  Not every value is representable.
671bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst
67297d38983Sdrh ** of 40.  However, since LogEst quantities are suppose to be estimates,
673bf539c4dSdrh ** not exact values, this imprecision is not a problem.
674bf539c4dSdrh **
675224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate".
676bf539c4dSdrh **
677bf539c4dSdrh ** Examples:
678bf539c4dSdrh **      1 -> 0              20 -> 43          10000 -> 132
679bf539c4dSdrh **      2 -> 10             25 -> 46          25000 -> 146
680bf539c4dSdrh **      3 -> 16            100 -> 66        1000000 -> 199
681bf539c4dSdrh **      4 -> 20           1000 -> 99        1048576 -> 200
682bf539c4dSdrh **     10 -> 33           1024 -> 100    4294967296 -> 320
683bf539c4dSdrh **
684bf539c4dSdrh ** The LogEst can be negative to indicate fractional values.
685bf539c4dSdrh ** Examples:
686bf539c4dSdrh **
687bf539c4dSdrh **    0.5 -> -10           0.1 -> -33        0.0625 -> -40
688bf539c4dSdrh */
689bf539c4dSdrh typedef INT16_TYPE LogEst;
690bf539c4dSdrh 
691bf539c4dSdrh /*
6922b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
6932b4905c8Sdrh */
6942b4905c8Sdrh #ifndef SQLITE_PTRSIZE
6952b4905c8Sdrh # if defined(__SIZEOF_POINTER__)
6962b4905c8Sdrh #   define SQLITE_PTRSIZE __SIZEOF_POINTER__
6972b4905c8Sdrh # elif defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
6982b4905c8Sdrh        defined(_M_ARM)   || defined(__arm__)    || defined(__x86)
6992b4905c8Sdrh #   define SQLITE_PTRSIZE 4
7002b4905c8Sdrh # else
7012b4905c8Sdrh #   define SQLITE_PTRSIZE 8
7022b4905c8Sdrh # endif
7032b4905c8Sdrh #endif
7042b4905c8Sdrh 
7053bfa7e82Sdrh /* The uptr type is an unsigned integer large enough to hold a pointer
7063bfa7e82Sdrh */
7073bfa7e82Sdrh #if defined(HAVE_STDINT_H)
7083bfa7e82Sdrh   typedef uintptr_t uptr;
7093bfa7e82Sdrh #elif SQLITE_PTRSIZE==4
7103bfa7e82Sdrh   typedef u32 uptr;
7113bfa7e82Sdrh #else
7123bfa7e82Sdrh   typedef u64 uptr;
7133bfa7e82Sdrh #endif
7143bfa7e82Sdrh 
7153bfa7e82Sdrh /*
7163bfa7e82Sdrh ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
7173bfa7e82Sdrh ** something between S (inclusive) and E (exclusive).
7183bfa7e82Sdrh **
7193bfa7e82Sdrh ** In other words, S is a buffer and E is a pointer to the first byte after
7203bfa7e82Sdrh ** the end of buffer S.  This macro returns true if P points to something
7213bfa7e82Sdrh ** contained within the buffer S.
7223bfa7e82Sdrh */
7233bfa7e82Sdrh #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
7243bfa7e82Sdrh 
7253bfa7e82Sdrh 
7262b4905c8Sdrh /*
727bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
72871794dbaSdrh ** and whether or not that determination is run-time or compile-time.
72971794dbaSdrh **
73071794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order
73171794dbaSdrh ** using C-preprocessor macros.  If that is unsuccessful, or if
73271794dbaSdrh ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined
73371794dbaSdrh ** at run-time.
734bbd42a6dSdrh */
73571794dbaSdrh #if (defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
73671794dbaSdrh      defined(__x86_64) || defined(__x86_64__) || defined(_M_X64)  ||    \
73771794dbaSdrh      defined(_M_AMD64) || defined(_M_ARM)     || defined(__x86)   ||    \
73871794dbaSdrh      defined(__arm__)) && !defined(SQLITE_RUNTIME_BYTEORDER)
7392cf4acbdSdrh # define SQLITE_BYTEORDER    1234
74038def054Sdrh # define SQLITE_BIGENDIAN    0
74138def054Sdrh # define SQLITE_LITTLEENDIAN 1
74238def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
74371794dbaSdrh #endif
74471794dbaSdrh #if (defined(sparc)    || defined(__ppc__))  \
74571794dbaSdrh     && !defined(SQLITE_RUNTIME_BYTEORDER)
74671794dbaSdrh # define SQLITE_BYTEORDER    4321
74771794dbaSdrh # define SQLITE_BIGENDIAN    1
74871794dbaSdrh # define SQLITE_LITTLEENDIAN 0
74971794dbaSdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16BE
75071794dbaSdrh #endif
75171794dbaSdrh #if !defined(SQLITE_BYTEORDER)
752e1462a76Sdrh # ifdef SQLITE_AMALGAMATION
753e1462a76Sdrh   const int sqlite3one = 1;
754e1462a76Sdrh # else
755e1462a76Sdrh   extern const int sqlite3one;
756e1462a76Sdrh # endif
7572cf4acbdSdrh # define SQLITE_BYTEORDER    0     /* 0 means "unknown at compile-time" */
7589c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
7599c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
76038def054Sdrh # define SQLITE_UTF16NATIVE  (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
76138def054Sdrh #endif
762bbd42a6dSdrh 
763bbd42a6dSdrh /*
7640f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
7650f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
7660f050353Sdrh ** compilers.
7670f050353Sdrh */
7680f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
7690f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
7700f050353Sdrh 
7710f050353Sdrh /*
772be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8.  This is used
773be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures.
774be229650Sdanielk1977 */
775bc73971dSdanielk1977 #define ROUND8(x)     (((x)+7)&~7)
776bc73971dSdanielk1977 
777bc73971dSdanielk1977 /*
778bc73971dSdanielk1977 ** Round down to the nearest multiple of 8
779bc73971dSdanielk1977 */
780bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7)
781be229650Sdanielk1977 
782be229650Sdanielk1977 /*
7838e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary.  This
7848e14c596Sdrh ** macro is used only within assert() to verify that the code gets
7858e14c596Sdrh ** all alignment restrictions correct.
7868e14c596Sdrh **
7878e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
78860ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned
7898e14c596Sdrh ** pointers.  In that case, only verify 4-byte alignment.
790ea598cbdSdrh */
7918e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
7928e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&3)==0)
7938e14c596Sdrh #else
794ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&7)==0)
7958e14c596Sdrh #endif
796ea598cbdSdrh 
797188d4884Sdrh /*
7989b4c59faSdrh ** Disable MMAP on platforms where it is known to not work
799188d4884Sdrh */
800188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__)
8019b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE
8029b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0
803188d4884Sdrh #endif
804188d4884Sdrh 
8059b4c59faSdrh /*
8069b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS
8079b4c59faSdrh */
8089b4c59faSdrh #ifdef __APPLE__
8099b4c59faSdrh # include <TargetConditionals.h>
8109b4c59faSdrh #endif
8119b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE
8129b4c59faSdrh # if defined(__linux__) \
8139b4c59faSdrh   || defined(_WIN32) \
8149b4c59faSdrh   || (defined(__APPLE__) && defined(__MACH__)) \
8153e9dd938Sdrh   || defined(__sun) \
8163e9dd938Sdrh   || defined(__FreeBSD__) \
8173e9dd938Sdrh   || defined(__DragonFly__)
8182bba8c24Sdrh #   define SQLITE_MAX_MMAP_SIZE 0x7fff0000  /* 2147418112 */
8199b4c59faSdrh # else
8209b4c59faSdrh #   define SQLITE_MAX_MMAP_SIZE 0
8219b4c59faSdrh # endif
822d16d0bc5Sdrh # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */
8239b4c59faSdrh #endif
8249b4c59faSdrh 
8259b4c59faSdrh /*
8269b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms.  Or, even if a larger
8279b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does
8289b4c59faSdrh ** not exceed the maximum mmap size.
8299b4c59faSdrh */
8309b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE
8319b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0
832d16d0bc5Sdrh # define SQLITE_DEFAULT_MMAP_SIZE_xc 1  /* Exclude from ctime.c */
8339b4c59faSdrh #endif
8349b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
8359b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE
8369b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
8379b4c59faSdrh #endif
838e7b34707Sdrh 
839ea598cbdSdrh /*
8401435a9a1Sdrh ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
8411435a9a1Sdrh ** Priority is given to SQLITE_ENABLE_STAT4.  If either are defined, also
8421435a9a1Sdrh ** define SQLITE_ENABLE_STAT3_OR_STAT4
8431435a9a1Sdrh */
8441435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT4
8451435a9a1Sdrh # undef SQLITE_ENABLE_STAT3
8461435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
8471435a9a1Sdrh #elif SQLITE_ENABLE_STAT3
8481435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
8491435a9a1Sdrh #elif SQLITE_ENABLE_STAT3_OR_STAT4
8501435a9a1Sdrh # undef SQLITE_ENABLE_STAT3_OR_STAT4
8511435a9a1Sdrh #endif
8521435a9a1Sdrh 
8531435a9a1Sdrh /*
854abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
855abd4c723Sdrh ** the Select query generator tracing logic is turned on.
856abd4c723Sdrh */
8579300adbcSdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_SELECTTRACE)
858abd4c723Sdrh # define SELECTTRACE_ENABLED 1
859abd4c723Sdrh #else
860abd4c723Sdrh # define SELECTTRACE_ENABLED 0
861abd4c723Sdrh #endif
862abd4c723Sdrh 
863abd4c723Sdrh /*
86490f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
86590f5ecb3Sdrh ** callback for a given sqlite handle.
86690f5ecb3Sdrh **
86790f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
86890f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
86990f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
87090f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
87190f5ecb3Sdrh */
87290f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
87390f5ecb3Sdrh struct BusyHandler {
87490f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
87590f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
876a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
87790f5ecb3Sdrh };
87890f5ecb3Sdrh 
87990f5ecb3Sdrh /*
88075897234Sdrh ** Name of the master database table.  The master database table
88175897234Sdrh ** is a special table that holds the names and attributes of all
88275897234Sdrh ** user tables and indices.
88375897234Sdrh */
88475897234Sdrh #define MASTER_NAME       "sqlite_master"
885e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
88675897234Sdrh 
88775897234Sdrh /*
8888e150818Sdanielk1977 ** The root-page of the master database table.
8898e150818Sdanielk1977 */
8908e150818Sdanielk1977 #define MASTER_ROOT       1
8918e150818Sdanielk1977 
8928e150818Sdanielk1977 /*
893ed6c8671Sdrh ** The name of the schema table.
894ed6c8671Sdrh */
89553c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
896ed6c8671Sdrh 
897ed6c8671Sdrh /*
89875897234Sdrh ** A convenience macro that returns the number of elements in
89975897234Sdrh ** an array.
90075897234Sdrh */
90123432976Sdanielk1977 #define ArraySize(X)    ((int)(sizeof(X)/sizeof(X[0])))
90275897234Sdrh 
90375897234Sdrh /*
9047a5bcc0fSdrh ** Determine if the argument is a power of two
9057a5bcc0fSdrh */
9067a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
9077a5bcc0fSdrh 
9087a5bcc0fSdrh /*
909633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
910aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the
911aa538a58Sdrh ** one parameter that destructors normally want.  So we have to introduce
912aa538a58Sdrh ** this magic value that the code knows to handle differently.  Any
913aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC
914aa538a58Sdrh ** and SQLITE_TRANSIENT.
915633e6d57Sdrh */
916aa538a58Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3MallocSize)
917633e6d57Sdrh 
91878f82d1eSdrh /*
91978f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
92078f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables.
92178f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from
92278f82d1eSdrh ** the heap.  When WSD is unsupported, the variable declarations scattered
92378f82d1eSdrh ** throughout the SQLite code must become constants instead.  The SQLITE_WSD
92478f82d1eSdrh ** macro is used for this purpose.  And instead of referencing the variable
92578f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated
92678f82d1eSdrh ** buffer that holds real variable.  The constant is also the initializer
92778f82d1eSdrh ** for the run-time allocated buffer.
92878f82d1eSdrh **
9292479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
93078f82d1eSdrh ** macros become no-ops and have zero performance impact.
93178f82d1eSdrh */
932075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD
933075c23afSdanielk1977   #define SQLITE_WSD const
934075c23afSdanielk1977   #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
935075c23afSdanielk1977   #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
936d1d38488Sdrh   int sqlite3_wsd_init(int N, int J);
937d1d38488Sdrh   void *sqlite3_wsd_find(void *K, int L);
938075c23afSdanielk1977 #else
939075c23afSdanielk1977   #define SQLITE_WSD
940075c23afSdanielk1977   #define GLOBAL(t,v) v
941075c23afSdanielk1977   #define sqlite3GlobalConfig sqlite3Config
942075c23afSdanielk1977 #endif
943075c23afSdanielk1977 
944f3d3c27aSdanielk1977 /*
945f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to
946f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately
947f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when
948f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the
949f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the
950f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate,
951f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere.
952f3d3c27aSdanielk1977 **
953f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function,
954f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
955f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to
956f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options.
957f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these
958f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions.
959f3d3c27aSdanielk1977 */
96062c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x)
961f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
96262c14b34Sdanielk1977 
963633e6d57Sdrh /*
96475897234Sdrh ** Forward references to structures
96575897234Sdrh */
96613449892Sdrh typedef struct AggInfo AggInfo;
967fe05af87Sdrh typedef struct AuthContext AuthContext;
9680b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo;
969f5e7bb51Sdrh typedef struct Bitvec Bitvec;
970fe05af87Sdrh typedef struct CollSeq CollSeq;
9717020f651Sdrh typedef struct Column Column;
972fe05af87Sdrh typedef struct Db Db;
973e501b89aSdanielk1977 typedef struct Schema Schema;
97475897234Sdrh typedef struct Expr Expr;
97575897234Sdrh typedef struct ExprList ExprList;
976b7916a78Sdrh typedef struct ExprSpan ExprSpan;
977c2eef3b3Sdrh typedef struct FKey FKey;
978d2199f0fSdan typedef struct FuncDestructor FuncDestructor;
979fe05af87Sdrh typedef struct FuncDef FuncDef;
98070a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
981fe05af87Sdrh typedef struct IdList IdList;
982fe05af87Sdrh typedef struct Index Index;
98302fa4696Sdan typedef struct IndexSample IndexSample;
9848d059845Sdanielk1977 typedef struct KeyClass KeyClass;
985d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
986633e6d57Sdrh typedef struct Lookaside Lookaside;
987633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
988d1ab1ba5Sdanielk1977 typedef struct Module Module;
989626a879aSdrh typedef struct NameContext NameContext;
990fe05af87Sdrh typedef struct Parse Parse;
99146c47d46Sdan typedef struct PreUpdate PreUpdate;
992a5c1416dSdrh typedef struct PrintfArguments PrintfArguments;
993a2460e07Sdrh typedef struct RowSet RowSet;
994fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint;
995fe05af87Sdrh typedef struct Select Select;
996f51446a3Sdrh typedef struct SQLiteThread SQLiteThread;
997634d81deSdrh typedef struct SelectDest SelectDest;
998fe05af87Sdrh typedef struct SrcList SrcList;
999ade86483Sdrh typedef struct StrAccum StrAccum;
1000fe05af87Sdrh typedef struct Table Table;
1001c00da105Sdanielk1977 typedef struct TableLock TableLock;
1002fe05af87Sdrh typedef struct Token Token;
10034fa4a54fSdrh typedef struct TreeView TreeView;
1004a2460e07Sdrh typedef struct Trigger Trigger;
10052832ad42Sdan typedef struct TriggerPrg TriggerPrg;
1006fe05af87Sdrh typedef struct TriggerStep TriggerStep;
1007e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
1008595a523aSdanielk1977 typedef struct VTable VTable;
1009b061d058Sdan typedef struct VtabCtx VtabCtx;
10107d10d5a6Sdrh typedef struct Walker Walker;
1011fe05af87Sdrh typedef struct WhereInfo WhereInfo;
10127d562dbeSdan typedef struct With With;
1013d3d39e93Sdrh 
10142dca4ac1Sdanielk1977 /*
10152dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
10162dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
10172dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
10182dca4ac1Sdanielk1977 */
10192dca4ac1Sdanielk1977 #include "btree.h"
10202dca4ac1Sdanielk1977 #include "vdbe.h"
10212dca4ac1Sdanielk1977 #include "pager.h"
10228c0a791aSdanielk1977 #include "pcache.h"
10231cc5ed81Sdanielk1977 #include "os.h"
1024c7ce76afSdrh #include "mutex.h"
10251cc5ed81Sdanielk1977 
102633b104afSdrh /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
102733b104afSdrh ** synchronous setting to EXTRA.  It is no longer supported.
102833b104afSdrh */
102933b104afSdrh #ifdef SQLITE_EXTRA_DURABLE
103033b104afSdrh # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
103133b104afSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 3
103233b104afSdrh #endif
103333b104afSdrh 
103450a1a5aaSdrh /*
1035c2ae2073Sdrh ** Default synchronous levels.
1036c2ae2073Sdrh **
1037c2ae2073Sdrh ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
1038c2ae2073Sdrh ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
1039c2ae2073Sdrh **
1040c2ae2073Sdrh **           PAGER_SYNCHRONOUS       DEFAULT_SYNCHRONOUS
1041c2ae2073Sdrh **   OFF           1                         0
1042c2ae2073Sdrh **   NORMAL        2                         1
1043c2ae2073Sdrh **   FULL          3                         2
1044c2ae2073Sdrh **   EXTRA         4                         3
1045c2ae2073Sdrh **
1046c2ae2073Sdrh ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
1047c2ae2073Sdrh ** In other words, the zero-based numbers are used for all external interfaces
1048c2ae2073Sdrh ** and the one-based values are used internally.
104950a1a5aaSdrh */
105050a1a5aaSdrh #ifndef SQLITE_DEFAULT_SYNCHRONOUS
1051c2ae2073Sdrh # define SQLITE_DEFAULT_SYNCHRONOUS (PAGER_SYNCHRONOUS_FULL-1)
105250a1a5aaSdrh #endif
105350a1a5aaSdrh #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
105450a1a5aaSdrh # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
105550a1a5aaSdrh #endif
1056eee4c8caSdrh 
1057001bbcbbSdrh /*
1058001bbcbbSdrh ** Each database file to be accessed by the system is an instance
1059001bbcbbSdrh ** of the following structure.  There are normally two of these structures
1060001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
1061a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
1062a69d9168Sdrh ** databases may be attached.
1063001bbcbbSdrh */
1064001bbcbbSdrh struct Db {
1065001bbcbbSdrh   char *zName;         /* Name of this database */
1066001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
1067467bcf36Sshane   u8 safety_level;     /* How aggressive at syncing data to disk */
106850a1a5aaSdrh   u8 bSyncSet;         /* True if "PRAGMA synchronous=N" has been run */
1069e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
1070da184236Sdanielk1977 };
1071da184236Sdanielk1977 
1072da184236Sdanielk1977 /*
1073da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
10742120608eSdrh **
10752120608eSdrh ** Most Schema objects are associated with a Btree.  The exception is
10762120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
10772120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple
10782120608eSdrh ** Btrees that refer to the same underlying BtShared object.
10792120608eSdrh **
10802120608eSdrh ** Schema objects are automatically deallocated when the last Btree that
10812120608eSdrh ** references them is destroyed.   The TEMP Schema is manually freed by
10822120608eSdrh ** sqlite3_close().
10832120608eSdrh *
10842120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order
10852120608eSdrh ** to access Schema content.  This implies that the thread must also be
10862120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
108755a0959aSdrh ** For a TEMP Schema, only the connection mutex is required.
1088da184236Sdanielk1977 */
1089e501b89aSdanielk1977 struct Schema {
1090001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
1091c2a75551Sdrh   int iGeneration;     /* Generation counter.  Incremented with each change */
1092d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
1093d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
1094d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
10951da40a38Sdan   Hash fkeyHash;       /* All foreign keys by referenced table name */
10964794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
1097da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
10988079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
10992c5e35ffSdrh   u16 schemaFlags;     /* Flags associated with this schema */
110014db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
1101001bbcbbSdrh };
110275897234Sdrh 
110375897234Sdrh /*
11048bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
1105a2460e07Sdrh ** Db.pSchema->flags field.
11068bf8dc92Sdrh */
11072c5e35ffSdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
11082c5e35ffSdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
11092c5e35ffSdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->schemaFlags|=(P)
11102c5e35ffSdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->schemaFlags&=~(P)
11118bf8dc92Sdrh 
11128bf8dc92Sdrh /*
1113a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field.
11148bf8dc92Sdrh **
11158bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
11168bf8dc92Sdrh ** read into internal hash tables.
11178bf8dc92Sdrh **
11188bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
11198bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
11208bf8dc92Sdrh ** changes and so the view will need to be reset.
11218bf8dc92Sdrh */
1122124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
1123124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
1124b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
11258bf8dc92Sdrh 
1126caa639f4Sdrh /*
1127caa639f4Sdrh ** The number of different kinds of things that can be limited
1128caa639f4Sdrh ** using the sqlite3_limit() interface.
1129caa639f4Sdrh */
1130111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
11318bf8dc92Sdrh 
11328bf8dc92Sdrh /*
1133633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
1134467bcf36Sshane ** to satisfy small transient memory allocation requests for objects
1135633e6d57Sdrh ** associated with a particular database connection.  The use of
1136633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
1137633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
1138633e6d57Sdrh ** SQL statements.
1139633e6d57Sdrh **
1140633e6d57Sdrh ** The Lookaside structure holds configuration information about the
1141633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
1142633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
1143633e6d57Sdrh ** objects.
1144d9da78a2Sdrh **
1145d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated
1146d9da78a2Sdrh ** with a particular database connection.  Hence, schema information cannot
1147d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information
1148d9da78a2Sdrh ** is shared by multiple database connections.  Therefore, while parsing
1149d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that
1150d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects.
1151633e6d57Sdrh */
1152633e6d57Sdrh struct Lookaside {
11534a642b60Sdrh   u32 bDisable;           /* Only operate the lookaside when zero */
1154633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
1155e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
1156633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
1157633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
11580b12e7f8Sdrh   int anStat[3];          /* 0: hits.  1: size misses.  2: full misses */
11597d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
1160633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
1161633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
1162633e6d57Sdrh };
1163633e6d57Sdrh struct LookasideSlot {
1164633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
1165633e6d57Sdrh };
1166633e6d57Sdrh 
1167633e6d57Sdrh /*
116880738d9cSdrh ** A hash table for built-in function definitions.  (Application-defined
116980738d9cSdrh ** functions use a regular table table from hash.h.)
117070a8ca3cSdrh **
117170a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
117280738d9cSdrh ** Collisions are on the FuncDef.u.pHash chain.
117370a8ca3cSdrh */
117480738d9cSdrh #define SQLITE_FUNC_HASH_SZ 23
117570a8ca3cSdrh struct FuncDefHash {
117680738d9cSdrh   FuncDef *a[SQLITE_FUNC_HASH_SZ];       /* Hash table for functions */
117770a8ca3cSdrh };
117870a8ca3cSdrh 
1179d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1180d4530979Sdrh /*
1181d4530979Sdrh ** Information held in the "sqlite3" database connection object and used
1182d4530979Sdrh ** to manage user authentication.
1183d4530979Sdrh */
1184d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth;
1185d4530979Sdrh struct sqlite3_userauth {
1186e933b83fSdrh   u8 authLevel;                 /* Current authentication level */
1187d4530979Sdrh   int nAuthPW;                  /* Size of the zAuthPW in bytes */
1188d4530979Sdrh   char *zAuthPW;                /* Password used to authenticate */
1189d4530979Sdrh   char *zAuthUser;              /* User name used to authenticate */
1190d4530979Sdrh };
1191d4530979Sdrh 
1192e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */
1193e933b83fSdrh #define UAUTH_Unknown     0     /* Authentication not yet checked */
1194e933b83fSdrh #define UAUTH_Fail        1     /* User authentication failed */
1195e933b83fSdrh #define UAUTH_User        2     /* Authenticated as a normal user */
1196e933b83fSdrh #define UAUTH_Admin       3     /* Authenticated as an administrator */
1197d4530979Sdrh 
1198d4530979Sdrh /* Functions used only by user authorization logic */
1199d4530979Sdrh int sqlite3UserAuthTable(const char*);
1200e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
12017883ecfcSdrh void sqlite3UserAuthInit(sqlite3*);
1202f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
1203f442e33eSdrh 
1204d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */
1205d4530979Sdrh 
120632c6a48bSdrh /*
120732c6a48bSdrh ** typedef for the authorization callback function.
120832c6a48bSdrh */
120932c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION
121032c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
121132c6a48bSdrh                                const char*, const char*);
121232c6a48bSdrh #else
121332c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
121432c6a48bSdrh                                const char*);
121532c6a48bSdrh #endif
121632c6a48bSdrh 
1217d4530979Sdrh 
121870a8ca3cSdrh /*
1219a2460e07Sdrh ** Each database connection is an instance of the following structure.
122075897234Sdrh */
12219bb575fdSdrh struct sqlite3 {
122290f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
1223a451017dSdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
1224a451017dSdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
1225a451017dSdrh   sqlite3_mutex *mutex;         /* Connection mutex */
1226001bbcbbSdrh   Db *aDb;                      /* All backends */
1227a451017dSdrh   int nDb;                      /* Number of backends currently in use */
1228467bcf36Sshane   int flags;                    /* Miscellaneous flags. See below */
1229a451017dSdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
12309b4c59faSdrh   i64 szMmap;                   /* Default mmap_size setting */
1231522c26fbSdrh   unsigned int openFlags;       /* Flags passed to sqlite3_vfs.xOpen() */
1232fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
12334ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
12341b9f2141Sdrh   int iSysErrno;                /* Errno value from last system error */
1235a5759677Sdrh   u16 dbOptFlags;               /* Flags to enable/disable optimizations */
12369bd3cc46Sdrh   u8 enc;                       /* Text encoding */
1237fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
123890f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
123917435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
12404a642b60Sdrh   u8 bBenignMalloc;             /* Do not require OOMs if true */
12413b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
124298757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
1243a7564663Sdrh   u8 suppressErr;               /* Do not issue error messages if true */
1244b061d058Sdan   u8 vtabOnConflict;            /* Value to return for s3_vtab_on_conflict() */
1245a451017dSdrh   u8 isTransactionSavepoint;    /* True if the outermost savepoint is a TS */
1246f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
124764202cfeSdanielk1977   u32 magic;                    /* Magic number for detect library misuse */
1248b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
1249b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
1250caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
12518930c2abSdan   int nMaxSorterMmap;           /* Maximum size of regions mapped by sorter */
12524adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
12531d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
1254a451017dSdrh     u8 iDb;                     /* Which db file is being initialized */
12551d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
12563d5f74b2Sdrh     u8 orphanTrigger;           /* Last statement is orphaned TEMP trigger */
12571ffede8cSdrh     u8 imposterTable;           /* Building an imposter table */
12581d85d931Sdrh   } init;
12591713afb0Sdrh   int nVdbeActive;              /* Number of VDBEs currently running */
12604f7d3a5fSdrh   int nVdbeRead;                /* Number of active VDBEs that read or write */
12614f7d3a5fSdrh   int nVdbeWrite;               /* Number of active VDBEs that read and write */
12624f7d3a5fSdrh   int nVdbeExec;                /* Number of nested calls to VdbeExec() */
1263086723a4Sdrh   int nVDestroy;                /* Number of active OP_VDestroy operations */
1264a451017dSdrh   int nExtension;               /* Number of loaded extensions */
1265a451017dSdrh   void **aExtension;            /* Array of shared library handles */
126618de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
126718de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
126819e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
126919e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
1270fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
1271fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
127271fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
127371fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
127494eb6a14Sdanielk1977   void *pUpdateArg;
127594eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
12769b1c62d4Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
127746c47d46Sdan   void *pPreUpdateArg;          /* First argument to xPreUpdateCallback */
127846c47d46Sdan   void (*xPreUpdateCallback)(   /* Registered using sqlite3_preupdate_hook() */
127946c47d46Sdan     void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
128046c47d46Sdan   );
128146c47d46Sdan   PreUpdate *pPreUpdate;        /* Context for active pre-update callback */
12829b1c62d4Sdrh #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
12835cf53537Sdan #ifndef SQLITE_OMIT_WAL
12847ed91f23Sdrh   int (*xWalCallback)(void *, sqlite3 *, const char *, int);
12857ed91f23Sdrh   void *pWalArg;
12865cf53537Sdan #endif
1287fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
1288fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
1289fcd35c7bSdrh   void *pCollNeededArg;
1290fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
1291881feaa0Sdrh   union {
129239001e75Sdrh     volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
1293881feaa0Sdrh     double notUsed1;            /* Spacer */
1294881feaa0Sdrh   } u1;
1295633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
1296ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
129732c6a48bSdrh   sqlite3_xauth xAuth;          /* Access authorization function */
1298ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
1299ed6c8671Sdrh #endif
1300348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1301348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
1302348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
13038f8c65f7Sdrh   unsigned nProgressOps;        /* Number of opcodes for progress callback */
1304348bb5d6Sdanielk1977 #endif
1305b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1306a451017dSdrh   int nVTrans;                  /* Allocated size of aVTrans */
1307b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
1308b061d058Sdan   VtabCtx *pVtabCtx;            /* Context for active vtab connect/create */
1309595a523aSdanielk1977   VTable **aVTrans;             /* Virtual tables with open transactions */
1310595a523aSdanielk1977   VTable *pDisconnect;    /* Disconnect these in next sqlite3_prepare() */
13116b456a2bSdanielk1977 #endif
131280738d9cSdrh   Hash aFunc;                   /* Hash table of connection functions */
1313fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
1314fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
1315fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
1316fd7f0452Sdanielk1977   Savepoint *pSavepoint;        /* List of active savepoints */
1317a451017dSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
1318fd7f0452Sdanielk1977   int nSavepoint;               /* Number of non-transaction savepoints */
1319bd43455cSdanielk1977   int nStatement;               /* Number of nested statement-transactions  */
13201da40a38Sdan   i64 nDeferredCons;            /* Net deferred constraints this transaction. */
1321cb3e4b79Sdan   i64 nDeferredImmCons;         /* Net deferred immediate constraints */
1322d46def77Sdan   int *pnBytesFreed;            /* If not NULL, increment this in DbFree() */
1323404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
1324404ca075Sdanielk1977   /* The following variables are all protected by the STATIC_MASTER
1325404ca075Sdanielk1977   ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
132665a73badSdrh   **
132765a73badSdrh   ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
132865a73badSdrh   ** unlock so that it can proceed.
132965a73badSdrh   **
133065a73badSdrh   ** When X.pBlockingConnection==Y, that means that something that X tried
133165a73badSdrh   ** tried to do recently failed with an SQLITE_LOCKED error due to locks
133265a73badSdrh   ** held by Y.
1333404ca075Sdanielk1977   */
1334404ca075Sdanielk1977   sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
1335404ca075Sdanielk1977   sqlite3 *pUnlockConnection;           /* Connection to watch for unlock */
1336404ca075Sdanielk1977   void *pUnlockArg;                     /* Argument to xUnlockNotify */
1337404ca075Sdanielk1977   void (*xUnlockNotify)(void **, int);  /* Unlock notify callback */
1338404ca075Sdanielk1977   sqlite3 *pNextBlocked;        /* Next in list of all blocked connections */
1339404ca075Sdanielk1977 #endif
1340d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1341d4530979Sdrh   sqlite3_userauth auth;        /* User authentication information */
1342d4530979Sdrh #endif
134375897234Sdrh };
134475897234Sdrh 
134503b808a6Sdrh /*
134603b808a6Sdrh ** A macro to discover the encoding of a database.
134703b808a6Sdrh */
13489bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
13499bd3cc46Sdrh #define ENC(db)        ((db)->enc)
135014db2665Sdanielk1977 
135175897234Sdrh /*
135207096f68Sdrh ** Possible values for the sqlite3.flags.
135349711600Sdrh **
135449711600Sdrh ** Value constraints (enforced via assert()):
135549711600Sdrh **      SQLITE_FullFSync     == PAGER_FULLFSYNC
135649711600Sdrh **      SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
135749711600Sdrh **      SQLITE_CacheSpill    == PAGER_CACHE_SPILL
135875897234Sdrh */
13597e5418e4Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
13607e5418e4Sdrh #define SQLITE_InternChanges  0x00000002  /* Uncommitted Hash table changes */
13616841b1cbSdrh #define SQLITE_FullColNames   0x00000004  /* Show full column names on SELECT */
13626841b1cbSdrh #define SQLITE_FullFSync      0x00000008  /* Use full fsync on the backend */
13636841b1cbSdrh #define SQLITE_CkptFullFSync  0x00000010  /* Use full fsync for checkpoint */
13646841b1cbSdrh #define SQLITE_CacheSpill     0x00000020  /* OK to spill pager cache */
136540c3941cSdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
136640c3941cSdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
13671bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
13681bee3d7bSdrh                                           /*   the count using a callback. */
136940c3941cSdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
13706a535340Sdrh                                           /*   result set is empty */
137140c3941cSdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
137240c3941cSdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
137340c3941cSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
137440c3941cSdrh #define SQLITE_VdbeAddopTrace 0x00001000  /* Trace sqlite3VdbeAddOp() calls */
137540c3941cSdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
137640c3941cSdrh #define SQLITE_ReadUncommitted 0x0004000  /* For shared-cache mode */
137740c3941cSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
137840c3941cSdrh #define SQLITE_RecoveryMode   0x00010000  /* Ignore schema errors */
137940c3941cSdrh #define SQLITE_ReverseOrder   0x00020000  /* Reverse unordered SELECTs */
138040c3941cSdrh #define SQLITE_RecTriggers    0x00040000  /* Enable recursive triggers */
138140c3941cSdrh #define SQLITE_ForeignKeys    0x00080000  /* Enforce foreign key constraints  */
138240c3941cSdrh #define SQLITE_AutoIndex      0x00100000  /* Enable automatic indexes */
138340c3941cSdrh #define SQLITE_PreferBuiltin  0x00200000  /* Preference to built-in funcs */
138440c3941cSdrh #define SQLITE_LoadExtension  0x00400000  /* Enable load_extension */
1385*191dd061Sdrh #define SQLITE_LoadExtFunc    0x00800000  /* Enable load_extension() SQL func */
1386*191dd061Sdrh #define SQLITE_EnableTrigger  0x01000000  /* True to enable triggers */
1387*191dd061Sdrh #define SQLITE_DeferFKs       0x02000000  /* Defer all FK constraints */
1388*191dd061Sdrh #define SQLITE_QueryOnly      0x04000000  /* Disable database changes */
1389*191dd061Sdrh #define SQLITE_VdbeEQP        0x08000000  /* Debug EXPLAIN QUERY PLAN */
1390*191dd061Sdrh #define SQLITE_Vacuum         0x10000000  /* Currently in a VACUUM */
1391*191dd061Sdrh #define SQLITE_CellSizeCk     0x20000000  /* Check btree cell sizes on load */
1392*191dd061Sdrh #define SQLITE_Fts3Tokenizer  0x40000000  /* Enable fts3_tokenizer(2) */
1393b1eaa718Sdrh 
139407096f68Sdrh 
139507096f68Sdrh /*
13967e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the
13977e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
13987e5418e4Sdrh ** selectively disable various optimizations.
139907096f68Sdrh */
14007e5418e4Sdrh #define SQLITE_QueryFlattener 0x0001   /* Query flattening */
14017e5418e4Sdrh #define SQLITE_ColumnCache    0x0002   /* Column cache */
14027e5418e4Sdrh #define SQLITE_GroupByOrder   0x0004   /* GROUPBY cover of ORDERBY */
14037e5418e4Sdrh #define SQLITE_FactorOutConst 0x0008   /* Constant factoring */
1404762c1c40Sdrh /*                not used    0x0010   // Was: SQLITE_IdxRealAsInt */
14057e5418e4Sdrh #define SQLITE_DistinctOpt    0x0020   /* DISTINCT using indexes */
14067e5418e4Sdrh #define SQLITE_CoverIdxScan   0x0040   /* Covering index scans */
1407a9e3fc05Sdrh #define SQLITE_OrderByIdxJoin 0x0080   /* ORDER BY of joins via index */
1408a5759677Sdrh #define SQLITE_SubqCoroutine  0x0100   /* Evaluate subqueries as coroutines */
1409eb5bc926Sdrh #define SQLITE_Transitive     0x0200   /* Transitive constraints */
14101031bd99Sdrh #define SQLITE_OmitNoopJoin   0x0400   /* Omit unused tables in joins */
1411d7d71470Sdrh #define SQLITE_Stat34         0x0800   /* Use STAT3 or STAT4 data */
141228935364Sdrh #define SQLITE_CursorHints    0x2000   /* Add OP_CursorHint opcodes */
1413a5759677Sdrh #define SQLITE_AllOpts        0xffff   /* All optimizations */
14147e5418e4Sdrh 
14157e5418e4Sdrh /*
14167e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled.
14177e5418e4Sdrh */
14187e5418e4Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
14197e5418e4Sdrh #define OptimizationDisabled(db, mask)  (((db)->dbOptFlags&(mask))!=0)
14207e5418e4Sdrh #define OptimizationEnabled(db, mask)   (((db)->dbOptFlags&(mask))==0)
14217e5418e4Sdrh #else
14227e5418e4Sdrh #define OptimizationDisabled(db, mask)  0
14237e5418e4Sdrh #define OptimizationEnabled(db, mask)   1
14247e5418e4Sdrh #endif
142534c68fbaSdanielk1977 
142658b9576bSdrh /*
1427d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization
1428d9f158e7Sdrh ** code. The argument is a Parse object for the code generator.
1429d9f158e7Sdrh */
1430aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor)
1431d9f158e7Sdrh 
1432d9f158e7Sdrh /*
1433247be43dSdrh ** Possible values for the sqlite.magic field.
1434247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
1435247be43dSdrh ** than being distinct from one another.
1436247be43dSdrh */
1437247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
1438247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
14397e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
1440247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
1441247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
14424245c405Sdrh #define SQLITE_MAGIC_ZOMBIE   0x64cffc7f  /* Close with last statement close */
1443247be43dSdrh 
1444247be43dSdrh /*
14450bce8354Sdrh ** Each SQL function is defined by an instance of the following
144680738d9cSdrh ** structure.  For global built-in functions (ex: substr(), max(), count())
144780738d9cSdrh ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
144880738d9cSdrh ** For per-connection application-defined functions, a pointer to this
144980738d9cSdrh ** structure is held in the db->aHash hash table.
145080738d9cSdrh **
145180738d9cSdrh ** The u.pHash field is used by the global built-ins.  The u.pDestructor
145280738d9cSdrh ** field is used by per-connection app-def functions.
14532803757aSdrh */
14540bce8354Sdrh struct FuncDef {
145580738d9cSdrh   i8 nArg;             /* Number of arguments.  -1 means unlimited */
1456d36e1041Sdrh   u16 funcFlags;       /* Some combination of SQLITE_FUNC_* */
14571350b030Sdrh   void *pUserData;     /* User data parameter */
14580bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
14592d80151fSdrh   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
14602d80151fSdrh   void (*xFinalize)(sqlite3_context*);                  /* Agg finalizer */
14616ad224e9Sdrh   const char *zName;   /* SQL name of the function. */
146280738d9cSdrh   union {
146370a8ca3cSdrh     FuncDef *pHash;      /* Next with a different name but the same hash */
1464d2199f0fSdan     FuncDestructor *pDestructor;   /* Reference counted destructor function */
146580738d9cSdrh   } u;
1466d2199f0fSdan };
1467d2199f0fSdan 
1468d2199f0fSdan /*
1469d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as
1470d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When
1471d2199f0fSdan ** create_function_v2() is called to create a function with a destructor,
1472d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to
1473d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether
1474d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1475d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated
1476d2199f0fSdan ** FuncDestructor.
1477d2199f0fSdan **
1478d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference
1479d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor
1480d2199f0fSdan ** is invoked and the FuncDestructor structure freed.
1481d2199f0fSdan */
1482d2199f0fSdan struct FuncDestructor {
1483d2199f0fSdan   int nRef;
1484d2199f0fSdan   void (*xDestroy)(void *);
1485d2199f0fSdan   void *pUserData;
14868e0a2f90Sdrh };
14872803757aSdrh 
14882803757aSdrh /*
1489a748fdccSdrh ** Possible values for FuncDef.flags.  Note that the _LENGTH and _TYPEOF
14907977fa3aSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG.  And
14917977fa3aSdrh ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC.  There
1492a748fdccSdrh ** are assert() statements in the code to verify this.
149349711600Sdrh **
149449711600Sdrh ** Value constraints (enforced via assert()):
149549711600Sdrh **     SQLITE_FUNC_MINMAX    ==  NC_MinMaxAgg      == SF_MinMaxAgg
149649711600Sdrh **     SQLITE_FUNC_LENGTH    ==  OPFLAG_LENGTHARG
149749711600Sdrh **     SQLITE_FUNC_TYPEOF    ==  OPFLAG_TYPEOFARG
149849711600Sdrh **     SQLITE_FUNC_CONSTANT  ==  SQLITE_DETERMINISTIC from the API
149949711600Sdrh **     SQLITE_FUNC_ENCMASK   depends on SQLITE_UTF* macros in the API
15007d10d5a6Sdrh */
15011d85e405Sdrh #define SQLITE_FUNC_ENCMASK  0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
15021d85e405Sdrh #define SQLITE_FUNC_LIKE     0x0004 /* Candidate for the LIKE optimization */
15031d85e405Sdrh #define SQLITE_FUNC_CASE     0x0008 /* Case-sensitive LIKE-type function */
15041d85e405Sdrh #define SQLITE_FUNC_EPHEM    0x0010 /* Ephemeral.  Delete with VDBE */
15051d85e405Sdrh #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
15061d85e405Sdrh #define SQLITE_FUNC_LENGTH   0x0040 /* Built-in length() function */
15071d85e405Sdrh #define SQLITE_FUNC_TYPEOF   0x0080 /* Built-in typeof() function */
15081d85e405Sdrh #define SQLITE_FUNC_COUNT    0x0100 /* Built-in count(*) aggregate */
15091d85e405Sdrh #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */
15101d85e405Sdrh #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
15111d85e405Sdrh #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
15129588ad95Sdrh #define SQLITE_FUNC_MINMAX   0x1000 /* True for min() and max() aggregates */
1513a7f910b5Sdrh #define SQLITE_FUNC_SLOCHNG  0x2000 /* "Slow Change". Value constant during a
1514a7f910b5Sdrh                                     ** single query - might change over time */
15157d10d5a6Sdrh 
15167d10d5a6Sdrh /*
1517777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1518777c5386Sdrh ** used to create the initializers for the FuncDef structures.
1519777c5386Sdrh **
1520777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
1521777c5386Sdrh **     Used to create a scalar function definition of a function zName
1522777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
1523777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
1524777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
1525f7bca574Sdrh **     argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1526777c5386Sdrh **
1527b1fba286Sdrh **   VFUNCTION(zName, nArg, iArg, bNC, xFunc)
1528b1fba286Sdrh **     Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
1529b1fba286Sdrh **
15301d85e405Sdrh **   DFUNCTION(zName, nArg, iArg, bNC, xFunc)
15311d85e405Sdrh **     Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
1532a7f910b5Sdrh **     adds the SQLITE_FUNC_SLOCHNG flag.  Used for date & time functions
153303bf26d9Sdrh **     and functions like sqlite_version() that can change, but not during
153403bf26d9Sdrh **     a single query.
15351d85e405Sdrh **
1536777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1537777c5386Sdrh **     Used to create an aggregate function definition implemented by
1538777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
1539777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
1540777c5386Sdrh **     FUNCTION().
1541777c5386Sdrh **
1542777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
1543777c5386Sdrh **     Used to create a scalar function definition of a function zName
1544777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
1545777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
1546777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
1547777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
1548777c5386Sdrh **     parameter.
1549777c5386Sdrh */
1550777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
1551b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
155280738d9cSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1553b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1554d36e1041Sdrh   {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
155580738d9cSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
15561d85e405Sdrh #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1557a7f910b5Sdrh   {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
155880738d9cSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
1559a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
1560b1fba286Sdrh   {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
156180738d9cSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
156221717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
1563a7f910b5Sdrh   {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
156480738d9cSdrh    pArg, 0, xFunc, 0, #zName, }
1565777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
1566b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
156780738d9cSdrh    (void *)arg, 0, likeFunc, 0, #zName, {0} }
1568777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
1569d36e1041Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
157080738d9cSdrh    SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
15719588ad95Sdrh #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
15729588ad95Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
157380738d9cSdrh    SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
1574777c5386Sdrh 
1575fd7f0452Sdanielk1977 /*
1576fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at
1577fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently
1578fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe
1579fd7f0452Sdanielk1977 ** OP_Savepoint instruction.
1580fd7f0452Sdanielk1977 */
1581fd7f0452Sdanielk1977 struct Savepoint {
1582fd7f0452Sdanielk1977   char *zName;                        /* Savepoint name (nul-terminated) */
1583fcb9f7adSdrh   i64 nDeferredCons;                  /* Number of deferred fk violations */
1584cb3e4b79Sdan   i64 nDeferredImmCons;               /* Number of deferred imm fk. */
1585fd7f0452Sdanielk1977   Savepoint *pNext;                   /* Parent savepoint (if any) */
1586fd7f0452Sdanielk1977 };
1587fd7f0452Sdanielk1977 
1588fd7f0452Sdanielk1977 /*
1589fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(),
1590fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction.
1591fd7f0452Sdanielk1977 */
1592fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN      0
1593fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE    1
1594fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK   2
1595fd7f0452Sdanielk1977 
1596777c5386Sdrh 
1597777c5386Sdrh /*
1598d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
1599d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
1600d1ab1ba5Sdanielk1977 ** hash table.
1601d1ab1ba5Sdanielk1977 */
1602d1ab1ba5Sdanielk1977 struct Module {
1603d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
1604d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
1605d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
1606832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
160751be3873Sdrh   Table *pEpoTab;                      /* Eponymous table for this module */
1608d1ab1ba5Sdanielk1977 };
1609d1ab1ba5Sdanielk1977 
1610d1ab1ba5Sdanielk1977 /*
1611967e8b73Sdrh ** information about each column of an SQL table is held in an instance
16127020f651Sdrh ** of this structure.
16137020f651Sdrh */
16147020f651Sdrh struct Column {
161594eaafa9Sdrh   char *zName;     /* Name of this column, \000, then the type */
16167977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
1617b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
1618a371ace4Sdrh   u8 notNull;      /* An OE_ code for handling a NOT NULL constraint */
1619a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
1620e5520e2fSdrh   u8 szEst;        /* Estimated size of value in this column. sizeof(INT)==1 */
1621fdaac671Sdrh   u8 colFlags;     /* Boolean properties.  See COLFLAG_ defines below */
16227020f651Sdrh };
16237020f651Sdrh 
1624a371ace4Sdrh /* Allowed values for Column.colFlags:
1625a371ace4Sdrh */
1626a371ace4Sdrh #define COLFLAG_PRIMKEY  0x0001    /* Column is part of the primary key */
1627a371ace4Sdrh #define COLFLAG_HIDDEN   0x0002    /* A hidden column in a virtual table */
1628d7564865Sdrh #define COLFLAG_HASTYPE  0x0004    /* Type name follows column name */
1629a371ace4Sdrh 
16307020f651Sdrh /*
1631a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
16320202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
16330202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
1634a9fd84b0Sdrh **
1635e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the
16360202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
16370202b29eSdanielk1977 ** collating sequence may not be read or written.
1638a9fd84b0Sdrh */
1639a9fd84b0Sdrh struct CollSeq {
16400202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
1641466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
1642a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
16430202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
1644a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
1645a9fd84b0Sdrh };
1646a9fd84b0Sdrh 
1647a9fd84b0Sdrh /*
1648d3d39e93Sdrh ** A sort order can be either ASC or DESC.
16498e2ca029Sdrh */
16508e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
1651d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
1652bc622bc0Sdrh #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
16538e2ca029Sdrh 
16548e2ca029Sdrh /*
1655a37cdde0Sdanielk1977 ** Column affinity types.
16568a51256cSdrh **
16578a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
16588a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
16597d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
16608a51256cSdrh **
16614583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'.  That way,
16628a51256cSdrh ** when multiple affinity types are concatenated into a string and
166366a5167bSdrh ** used as the P4 operand, they will be more readable.
16648a51256cSdrh **
16658a51256cSdrh ** Note also that the numeric types are grouped together so that testing
166605883a34Sdrh ** for a numeric type is a single comparison.  And the BLOB type is first.
1667a37cdde0Sdanielk1977 */
166805883a34Sdrh #define SQLITE_AFF_BLOB     'A'
16694583c37cSdrh #define SQLITE_AFF_TEXT     'B'
16704583c37cSdrh #define SQLITE_AFF_NUMERIC  'C'
16714583c37cSdrh #define SQLITE_AFF_INTEGER  'D'
16724583c37cSdrh #define SQLITE_AFF_REAL     'E'
1673a37cdde0Sdanielk1977 
16748a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
1675a37cdde0Sdanielk1977 
1676a37cdde0Sdanielk1977 /*
167735573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
167835573356Sdrh ** affinity value.
167935573356Sdrh */
16804583c37cSdrh #define SQLITE_AFF_MASK     0x47
168135573356Sdrh 
168235573356Sdrh /*
168335573356Sdrh ** Additional bit values that can be ORed with an affinity without
168435573356Sdrh ** changing the affinity.
16853d77dee9Sdrh **
16863d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
16873d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison
16883d77dee9Sdrh ** operator is NULL.  It is added to certain comparison operators to
16893d77dee9Sdrh ** prove that the operands are always NOT NULL.
169035573356Sdrh */
16914583c37cSdrh #define SQLITE_JUMPIFNULL   0x10  /* jumps if either operand is NULL */
16924583c37cSdrh #define SQLITE_STOREP2      0x20  /* Store result in reg[P2] rather than jump */
16936a2fe093Sdrh #define SQLITE_NULLEQ       0x80  /* NULL=NULL */
16944583c37cSdrh #define SQLITE_NOTNULL      0x90  /* Assert that operands are never NULL */
169535573356Sdrh 
169635573356Sdrh /*
1697595a523aSdanielk1977 ** An object of this type is created for each virtual table present in
1698595a523aSdanielk1977 ** the database schema.
1699595a523aSdanielk1977 **
1700595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this
1701595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared
1702595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique
1703595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table
1704595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between
1705595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database
1706595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database
1707595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method
1708595a523aSdanielk1977 ** during initialization internally. This database connection handle may
17099bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables
1710595a523aSdanielk1977 ** within the database. So that they appear as part of the callers
1711595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database
1712595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table.
1713595a523aSdanielk1977 **
1714595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared
1715595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by
1716595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object.
1717595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual
1718595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the
1719595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct
1720595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query.
1721595a523aSdanielk1977 **
1722595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the
1723595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not
1724595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1725595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to
1726595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the
1727595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
1728595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done
1729595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1730595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an
1731595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1732595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex.
1733595a523aSdanielk1977 **
1734595a523aSdanielk1977 ** The memory for objects of this type is always allocated by
1735595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1736595a523aSdanielk1977 ** the first argument.
1737595a523aSdanielk1977 */
1738595a523aSdanielk1977 struct VTable {
1739595a523aSdanielk1977   sqlite3 *db;              /* Database connection associated with this table */
1740595a523aSdanielk1977   Module *pMod;             /* Pointer to module implementation */
1741595a523aSdanielk1977   sqlite3_vtab *pVtab;      /* Pointer to vtab instance */
1742595a523aSdanielk1977   int nRef;                 /* Number of pointers to this structure */
1743b061d058Sdan   u8 bConstraint;           /* True if constraints are supported */
1744addd8f87Sdrh   int iSavepoint;           /* Depth of the SAVEPOINT stack */
1745595a523aSdanielk1977   VTable *pNext;            /* Next in linked list (see above) */
1746595a523aSdanielk1977 };
1747595a523aSdanielk1977 
1748595a523aSdanielk1977 /*
17495789d1a4Sdrh ** The schema for each SQL table and view is represented in memory
17505789d1a4Sdrh ** by an instance of the following structure.
175175897234Sdrh */
175275897234Sdrh struct Table {
17537d10d5a6Sdrh   char *zName;         /* Name of the table or view */
17547020f651Sdrh   Column *aCol;        /* Information about each column */
1755967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
1756a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
1757c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
17583d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
17592938f924Sdrh   ExprList *pCheck;    /* All CHECK constraints */
17608981b904Sdrh                        /*   ... also used as column name list in a VIEW */
17615789d1a4Sdrh   int tnum;            /* Root BTree page for this table */
17625789d1a4Sdrh   i16 iPKey;           /* If not negative, use aCol[iPKey] as the rowid */
1763d815f17dSdrh   i16 nCol;            /* Number of columns in this table */
1764d815f17dSdrh   u16 nRef;            /* Number of pointers to this Table */
17655789d1a4Sdrh   LogEst nRowLogEst;   /* Estimated rows in table - from sqlite_stat1 table */
1766bf539c4dSdrh   LogEst szTabRow;     /* Estimated size of each table row in bytes */
1767dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT
1768dbd9486dSdrh   LogEst costMult;     /* Cost multiplier for using this table */
1769dbd9486dSdrh #endif
1770d815f17dSdrh   u8 tabFlags;         /* Mask of TF_* values */
1771d815f17dSdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
177219a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
17737d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
177419a8e7e8Sdanielk1977 #endif
1775e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1776b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
17778a48b9c0Sdrh   char **azModuleArg;  /* 0: module 1: schema 2: vtab name 3...: args */
1778d815f17dSdrh   VTable *pVTable;     /* List of VTable objects. */
1779e09daa90Sdrh #endif
17802f886d1dSdanielk1977   Trigger *pTrigger;   /* List of triggers stored in pSchema */
1781728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
1782588a9a1aSdrh   Table *pNextZombie;  /* Next on the Parse.pZombieTab list */
178375897234Sdrh };
178475897234Sdrh 
178575897234Sdrh /*
17868ce7184bSdan ** Allowed values for Table.tabFlags.
1787a21f78b9Sdrh **
178880090f92Sdrh ** TF_OOOHidden applies to tables or view that have hidden columns that are
1789a21f78b9Sdrh ** followed by non-hidden columns.  Example:  "CREATE VIRTUAL TABLE x USING
1790a21f78b9Sdrh ** vtab1(a HIDDEN, b);".  Since "b" is a non-hidden column but "a" is hidden,
1791a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case.  Such tables require
1792a21f78b9Sdrh ** special handling during INSERT processing.
17937d10d5a6Sdrh */
17947d10d5a6Sdrh #define TF_Readonly        0x01    /* Read-only system table */
1795467bcf36Sshane #define TF_Ephemeral       0x02    /* An ephemeral table */
17967d10d5a6Sdrh #define TF_HasPrimaryKey   0x04    /* Table has a primary key */
17977d10d5a6Sdrh #define TF_Autoincrement   0x08    /* Integer primary key is autoincrement */
17987d10d5a6Sdrh #define TF_Virtual         0x10    /* Is a virtual table */
1799fccda8a1Sdrh #define TF_WithoutRowid    0x20    /* No rowid.  PRIMARY KEY is the key */
1800fccda8a1Sdrh #define TF_NoVisibleRowid  0x40    /* No user-visible "rowid" column */
1801fccda8a1Sdrh #define TF_OOOHidden       0x80    /* Out-of-Order hidden columns */
18027d10d5a6Sdrh 
18037d10d5a6Sdrh 
18047d10d5a6Sdrh /*
18054cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
18064cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
18074cbdda9eSdrh ** table support is omitted from the build.
18084cbdda9eSdrh */
18094cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
18107d10d5a6Sdrh #  define IsVirtual(X)      (((X)->tabFlags & TF_Virtual)!=0)
18114cbdda9eSdrh #else
18124cbdda9eSdrh #  define IsVirtual(X)      0
18134cbdda9eSdrh #endif
18144cbdda9eSdrh 
181503d69a68Sdrh /*
181603d69a68Sdrh ** Macros to determine if a column is hidden.  IsOrdinaryHiddenColumn()
181703d69a68Sdrh ** only works for non-virtual tables (ordinary tables and views) and is
181803d69a68Sdrh ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined.  The
181903d69a68Sdrh ** IsHiddenColumn() macro is general purpose.
182003d69a68Sdrh */
182103d69a68Sdrh #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
182203d69a68Sdrh #  define IsHiddenColumn(X)         (((X)->colFlags & COLFLAG_HIDDEN)!=0)
182303d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
182418f8e734Sdrh #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
182503d69a68Sdrh #  define IsHiddenColumn(X)         (((X)->colFlags & COLFLAG_HIDDEN)!=0)
182603d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) 0
182703d69a68Sdrh #else
182803d69a68Sdrh #  define IsHiddenColumn(X)         0
182903d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) 0
183003d69a68Sdrh #endif
183103d69a68Sdrh 
183203d69a68Sdrh 
1833ec95c441Sdrh /* Does the table have a rowid */
1834ec95c441Sdrh #define HasRowid(X)     (((X)->tabFlags & TF_WithoutRowid)==0)
1835fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
1836ec95c441Sdrh 
18374cbdda9eSdrh /*
1838c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
1839c2eef3b3Sdrh **
1840c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
1841c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
1842c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
1843c2eef3b3Sdrh ** Consider this example:
1844c2eef3b3Sdrh **
1845c2eef3b3Sdrh **     CREATE TABLE ex1(
1846c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
1847c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1848c2eef3b3Sdrh **     );
1849c2eef3b3Sdrh **
1850c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1851bd50a926Sdrh ** Equivalent names:
1852bd50a926Sdrh **
1853bd50a926Sdrh **     from-table == child-table
1854bd50a926Sdrh **       to-table == parent-table
1855c2eef3b3Sdrh **
1856c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
1857c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
1858e61922a6Sdrh ** the from-table is created.  The existence of the to-table is not checked.
1859bd50a926Sdrh **
1860bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey.
1861bd50a926Sdrh **
1862bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist)
1863bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z.
1864c2eef3b3Sdrh */
1865c2eef3b3Sdrh struct FKey {
18661f638cebSdrh   Table *pFrom;     /* Table containing the REFERENCES clause (aka: Child) */
1867bd50a926Sdrh   FKey *pNextFrom;  /* Next FKey with the same in pFrom. Next parent of pFrom */
18681f638cebSdrh   char *zTo;        /* Name of table that the key points to (aka: Parent) */
1869bd50a926Sdrh   FKey *pNextTo;    /* Next with the same zTo. Next child of zTo. */
1870bd50a926Sdrh   FKey *pPrevTo;    /* Previous with the same zTo */
1871c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
18724c429839Sdrh   /* EV: R-30323-21917 */
1873c2eef3b3Sdrh   u8 isDeferred;       /* True if constraint checking is deferred till COMMIT */
18748099ce6fSdan   u8 aAction[2];        /* ON DELETE and ON UPDATE actions, respectively */
18758099ce6fSdan   Trigger *apTrigger[2];/* Triggers for aAction[] actions */
1876e61922a6Sdrh   struct sColMap {      /* Mapping of columns in pFrom to columns in zTo */
1877e61922a6Sdrh     int iFrom;            /* Index of column in pFrom */
1878bd50a926Sdrh     char *zCol;           /* Name of column in zTo.  If NULL use PRIMARY KEY */
1879e61922a6Sdrh   } aCol[1];            /* One entry for each of nCol columns */
1880c2eef3b3Sdrh };
1881c2eef3b3Sdrh 
1882c2eef3b3Sdrh /*
1883aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
188422f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
18850bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
18861c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
18871c92853dSdrh ** fails and any prior changes from that one operation are backed out,
18881c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
18891c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
18901c92853dSdrh ** changes due to the same operation are not backed out and no rollback
18911c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
18921c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
18931c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
18941c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
18951c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
18961c92853dSdrh **
1897c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1898c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1899c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1900c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1901c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1902c2eef3b3Sdrh ** foreign key.
1903c2eef3b3Sdrh **
1904968af52aSdrh ** The following symbolic values are used to record which type
19051c92853dSdrh ** of action to take.
19069cfcf5d4Sdrh */
19079cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
19081c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
19091c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
19101c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
19111c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
19121c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1913c2eef3b3Sdrh 
1914c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1915c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1916c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1917c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1918c2eef3b3Sdrh 
1919c28c4e50Sdrh #define OE_Default  10  /* Do whatever the default action is */
19209cfcf5d4Sdrh 
1921d3d39e93Sdrh 
1922d3d39e93Sdrh /*
1923d3d39e93Sdrh ** An instance of the following structure is passed as the first
1924d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1925d3d39e93Sdrh ** comparison of the two index keys.
1926323df790Sdrh **
1927323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots.  There
1928323df790Sdrh ** are nField slots for the columns of an index then one extra slot
1929323df790Sdrh ** for the rowid at the end.
1930d3d39e93Sdrh */
1931d3d39e93Sdrh struct KeyInfo {
19322ec2fb22Sdrh   u32 nRef;           /* Number of references to this KeyInfo object */
19339b8d0272Sdrh   u8 enc;             /* Text encoding - one of the SQLITE_UTF* values */
1934ad124329Sdrh   u16 nField;         /* Number of key columns in the index */
1935ad124329Sdrh   u16 nXField;        /* Number of columns beyond the key columns */
19362ec2fb22Sdrh   sqlite3 *db;        /* The database connection */
1937323df790Sdrh   u8 *aSortOrder;     /* Sort order for each column. */
1938d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1939d3d39e93Sdrh };
1940d3d39e93Sdrh 
19419cfcf5d4Sdrh /*
1942b1d607deSdrh ** This object holds a record which has been parsed out into individual
1943b1d607deSdrh ** fields, for the purposes of doing a comparison.
1944e63d9991Sdrh **
1945e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1946e63d9991Sdrh ** Records are used to store the content of a table row and to store
1947e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1948467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
1949e63d9991Sdrh ** OP_Column opcode.
1950e63d9991Sdrh **
1951b1d607deSdrh ** An instance of this object serves as a "key" for doing a search on
1952b1d607deSdrh ** an index b+tree. The goal of the search is to find the entry that
1953b1d607deSdrh ** is closed to the key described by this object.  This object might hold
1954b1d607deSdrh ** just a prefix of the key.  The number of fields is given by
1955b1d607deSdrh ** pKeyInfo->nField.
19563833e934Sdan **
1957b1d607deSdrh ** The r1 and r2 fields are the values to return if this key is less than
1958b1d607deSdrh ** or greater than a key in the btree, respectively.  These are normally
1959b1d607deSdrh ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
1960b1d607deSdrh ** is in DESC order.
1961b1d607deSdrh **
1962b1d607deSdrh ** The key comparison functions actually return default_rc when they find
1963b1d607deSdrh ** an equals comparison.  default_rc can be -1, 0, or +1.  If there are
1964b1d607deSdrh ** multiple entries in the b-tree with the same key (when only looking
1965b1d607deSdrh ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
1966b1d607deSdrh ** cause the search to find the last match, or +1 to cause the search to
1967b1d607deSdrh ** find the first match.
1968b1d607deSdrh **
1969b1d607deSdrh ** The key comparison functions will set eqSeen to true if they ever
1970b1d607deSdrh ** get and equal results when comparing this structure to a b-tree record.
1971b1d607deSdrh ** When default_rc!=0, the search might end up on the record immediately
1972b1d607deSdrh ** before the first match or immediately after the last match.  The
1973b1d607deSdrh ** eqSeen field will indicate whether or not an exact match exists in the
1974b1d607deSdrh ** b-tree.
1975e63d9991Sdrh */
1976e63d9991Sdrh struct UnpackedRecord {
1977e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
197870528d78Sdrh   Mem *aMem;          /* Values */
1979e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1980a9e0aeb5Sdrh   i8 default_rc;      /* Comparison result if keys are equal */
198138fdead8Sdan   u8 errCode;         /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
198270528d78Sdrh   i8 r1;              /* Value to return if (lhs > rhs) */
198370528d78Sdrh   i8 r2;              /* Value to return if (rhs < lhs) */
198470528d78Sdrh   u8 eqSeen;          /* True if an equality comparison has been seen */
1985e63d9991Sdrh };
1986e63d9991Sdrh 
1987e63d9991Sdrh 
1988e63d9991Sdrh /*
198966b89c8fSdrh ** Each SQL index is represented in memory by an
199075897234Sdrh ** instance of the following structure.
1991967e8b73Sdrh **
1992967e8b73Sdrh ** The columns of the table that are to be indexed are described
1993967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1994967e8b73Sdrh ** we have the following table and index:
1995967e8b73Sdrh **
1996967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1997967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1998967e8b73Sdrh **
1999967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
2000967e8b73Sdrh ** three columns in the table.  In the Index structure describing
2001967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
2002967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
2003967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
2004967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
2005967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
2006ea1ba17cSdrh **
2007ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
2008ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
2009ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
2010ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
2011ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
2012ea1ba17cSdrh ** element.
2013c5b73585Sdan **
2014c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
2015c5b73585Sdan ** generate VDBE code (as opposed to parsing one read from an sqlite_master
2016c5b73585Sdan ** table as part of parsing an existing database schema), transient instances
2017c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is
2018c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page
2019c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE
2020c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details.
202175897234Sdrh */
202275897234Sdrh struct Index {
202375897234Sdrh   char *zName;             /* Name of this index */
2024bbbdc83bSdrh   i16 *aiColumn;           /* Which columns are used by this index.  1st is 0 */
2025cfc9df76Sdan   LogEst *aiRowLogEst;     /* From ANALYZE: Est. rows selected by each column */
2026967e8b73Sdrh   Table *pTable;           /* The SQL table being indexed */
2027a37cdde0Sdanielk1977   char *zColAff;           /* String defining the affinity of each column */
202875897234Sdrh   Index *pNext;            /* The next index associated with the same table */
2029b3bf556eSdanielk1977   Schema *pSchema;         /* Schema containing this index */
2030b376daebSdrh   u8 *aSortOrder;          /* for each column: True==DESC, False==ASC */
2031f19aa5faSdrh   const char **azColl;     /* Array of collation sequence names for index */
20321fe0537eSdrh   Expr *pPartIdxWhere;     /* WHERE clause for partial indices */
20331f9ca2c8Sdrh   ExprList *aColExpr;      /* Column expressions */
2034b376daebSdrh   int tnum;                /* DB Page containing root of this index */
2035bf539c4dSdrh   LogEst szIdxRow;         /* Estimated average row size in bytes */
2036bbbdc83bSdrh   u16 nKeyCol;             /* Number of columns forming the key */
2037bbbdc83bSdrh   u16 nColumn;             /* Number of columns stored in the index */
2038a451017dSdrh   u8 onError;              /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
203948dd1d8eSdrh   unsigned idxType:2;      /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
2040b376daebSdrh   unsigned bUnordered:1;   /* Use this index for == or IN queries only */
20417699d1c4Sdrh   unsigned uniqNotNull:1;  /* True if UNIQUE and NOT NULL for all columns */
20427f9c5dbfSdrh   unsigned isResized:1;    /* True if resizeIndexObject() has been called */
2043ec95c441Sdrh   unsigned isCovering:1;   /* True if this is a covering index */
2044f9df2fbdSdrh   unsigned noSkipScan:1;   /* Do not try to use skip-scan if true */
20451435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
20462b9cf669Sdrh   int nSample;             /* Number of elements in aSample[] */
20478ad169abSdan   int nSampleCol;          /* Size of IndexSample.anEq[] and so on */
2048eea568d6Sdan   tRowcnt *aAvgEq;         /* Average nEq values for keys not in aSample */
2049faacf17cSdrh   IndexSample *aSample;    /* Samples of the left-most key */
20509f07cf7bSdrh   tRowcnt *aiRowEst;       /* Non-logarithmic stat1 data for this index */
20519f07cf7bSdrh   tRowcnt nRowEst0;        /* Non-logarithmic number of rows in the index */
2052faacf17cSdrh #endif
205302fa4696Sdan };
205402fa4696Sdan 
205502fa4696Sdan /*
205648dd1d8eSdrh ** Allowed values for Index.idxType
205748dd1d8eSdrh */
205848dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF      0   /* Created using CREATE INDEX */
205948dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE      1   /* Implements a UNIQUE constraint */
206048dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY  2   /* Is the PRIMARY KEY for the table */
206148dd1d8eSdrh 
206248dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */
206348dd1d8eSdrh #define IsPrimaryKeyIndex(X)  ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
206448dd1d8eSdrh 
20655f1d1d9cSdrh /* Return true if index X is a UNIQUE index */
20665f1d1d9cSdrh #define IsUniqueIndex(X)      ((X)->onError!=OE_None)
20675f1d1d9cSdrh 
20684b92f98cSdrh /* The Index.aiColumn[] values are normally positive integer.  But
20694b92f98cSdrh ** there are some negative values that have special meaning:
20704b92f98cSdrh */
20714b92f98cSdrh #define XN_ROWID     (-1)     /* Indexed column is the rowid */
20724b92f98cSdrh #define XN_EXPR      (-2)     /* Indexed column is an expression */
20734b92f98cSdrh 
207448dd1d8eSdrh /*
207574e7c8f5Sdrh ** Each sample stored in the sqlite_stat3 table is represented in memory
207674e7c8f5Sdrh ** using a structure of this type.  See documentation at the top of the
207774e7c8f5Sdrh ** analyze.c source file for additional information.
207802fa4696Sdan */
207902fa4696Sdan struct IndexSample {
2080f52bb8d3Sdan   void *p;          /* Pointer to sampled record */
2081f52bb8d3Sdan   int n;            /* Size of record in bytes */
2082f52bb8d3Sdan   tRowcnt *anEq;    /* Est. number of rows where the key equals this sample */
2083f52bb8d3Sdan   tRowcnt *anLt;    /* Est. number of rows where key is less than this sample */
2084f52bb8d3Sdan   tRowcnt *anDLt;   /* Est. number of distinct keys less than this sample */
208575897234Sdrh };
208675897234Sdrh 
208775897234Sdrh /*
208875897234Sdrh ** Each token coming out of the lexer is an instance of
20894b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
20904efc4754Sdrh **
20914efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
2092467bcf36Sshane ** may contain random values.  Do not make any assumptions about Token.dyn
20934efc4754Sdrh ** and Token.n when Token.z==0.
209475897234Sdrh */
209575897234Sdrh struct Token {
2096b7916a78Sdrh   const char *z;     /* Text of the token.  Not NULL-terminated! */
2097b7916a78Sdrh   unsigned int n;    /* Number of characters in this token */
209875897234Sdrh };
209975897234Sdrh 
210075897234Sdrh /*
210113449892Sdrh ** An instance of this structure contains information needed to generate
210213449892Sdrh ** code for a SELECT that contains aggregate functions.
210313449892Sdrh **
210413449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
210513449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
210613449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
210713449892Sdrh ** code for that node.
210813449892Sdrh **
210913449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
211013449892Sdrh ** original Select structure that describes the SELECT statement.  These
211113449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
211213449892Sdrh */
211313449892Sdrh struct AggInfo {
211413449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
211513449892Sdrh                           ** from source tables rather than from accumulators */
211613449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
211713449892Sdrh                           ** than the source table */
211813449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
21195134d135Sdan   int sortingIdxPTab;     /* Cursor number of pseudo-table */
212013449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
21217e61d18eSdrh   int mnReg, mxReg;       /* Range of registers allocated for aCol and aFunc */
2122a451017dSdrh   ExprList *pGroupBy;     /* The group by clause */
212313449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
21240817d0dfSdanielk1977     Table *pTab;             /* Source table */
212513449892Sdrh     int iTable;              /* Cursor number of the source table */
212613449892Sdrh     int iColumn;             /* Column number within the source table */
212713449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
212813449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
21295774b806Sdrh     Expr *pExpr;             /* The original expression */
213013449892Sdrh   } *aCol;
213113449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
213213449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
213313449892Sdrh                           ** Additional columns are used only as parameters to
213413449892Sdrh                           ** aggregate functions */
213513449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
213613449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
213713449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
213813449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
2139467bcf36Sshane     int iDistinct;           /* Ephemeral table used to enforce DISTINCT */
214013449892Sdrh   } *aFunc;
214113449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
214213449892Sdrh };
214313449892Sdrh 
214413449892Sdrh /*
21458677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
21468677d308Sdrh ** Usually it is 16-bits.  But if SQLITE_MAX_VARIABLE_NUMBER is greater
21478677d308Sdrh ** than 32767 we have to make it 32-bit.  16-bit is preferred because
21488677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user
21498677d308Sdrh ** in systems with lots of prepared statements.  And few applications
21508677d308Sdrh ** need more than about 10 or 20 variables.  But some extreme users want
21518677d308Sdrh ** to have prepared statements with over 32767 variables, and for them
21528677d308Sdrh ** the option is available (at compile-time).
21538677d308Sdrh */
21548677d308Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<=32767
2155481aa74eSdrh typedef i16 ynVar;
21568677d308Sdrh #else
21578677d308Sdrh typedef int ynVar;
21588677d308Sdrh #endif
21598677d308Sdrh 
21608677d308Sdrh /*
216175897234Sdrh ** Each node of an expression in the parse tree is an instance
216222f70c32Sdrh ** of this structure.
216322f70c32Sdrh **
216422f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused
216522f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer
216622f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused
216722f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
216822f70c32Sdrh ** tree.
216922f70c32Sdrh **
21706ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
21716ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
21726ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
21736ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
21746ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function.
217522f70c32Sdrh **
21766ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
21776ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL.
21786ab3a2ecSdanielk1977 **
21796ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
21806ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
21816ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
21826ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
21836ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
21846ab3a2ecSdanielk1977 ** valid.
218522f70c32Sdrh **
218622f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
218722f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
218822f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
218922f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
219022f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
219122f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
219222f70c32Sdrh ** it can be accessed after all aggregates are computed.
219322f70c32Sdrh **
21946ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark
21956ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index
21966ab3a2ecSdanielk1977 ** number for that variable.
219722f70c32Sdrh **
21981398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
21991398ad36Sdrh ** register number containing the result of the subquery.  If the
22001398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
22011398ad36Sdrh ** gives a different answer at different times during statement processing
22021398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
22031398ad36Sdrh **
2204aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
2205aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
2206aee18ef8Sdanielk1977 ** corresponding table definition.
22076ab3a2ecSdanielk1977 **
22086ab3a2ecSdanielk1977 ** ALLOCATION NOTES:
22096ab3a2ecSdanielk1977 **
221012ffee8cSdrh ** Expr objects can use a lot of memory space in database schema.  To
221112ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be
221212ffee8cSdrh ** truncated.  And to reduce the number of memory allocations, sometimes
221312ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation,
221433e619fcSdrh ** together with Expr.zToken strings.
22156ab3a2ecSdanielk1977 **
2216b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when
221712ffee8cSdrh ** an Expr object is truncated.  When EP_Reduced is set, then all
221812ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
221912ffee8cSdrh ** are contained within the same memory allocation.  Note, however, that
222012ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
222112ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set.
222275897234Sdrh */
222375897234Sdrh struct Expr {
22241cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
2225a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
2226c5cd1249Sdrh   u32 flags;             /* Various flags.  EP_* See below */
222733e619fcSdrh   union {
2228b7916a78Sdrh     char *zToken;          /* Token value. Zero terminated and dequoted */
2229d50ffc41Sdrh     int iValue;            /* Non-negative integer value if EP_IntValue */
223033e619fcSdrh   } u;
22316ab3a2ecSdanielk1977 
22326ab3a2ecSdanielk1977   /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
22336ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
22346ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
22356ab3a2ecSdanielk1977   *********************************************************************/
22366ab3a2ecSdanielk1977 
22376ab3a2ecSdanielk1977   Expr *pLeft;           /* Left subnode */
22386ab3a2ecSdanielk1977   Expr *pRight;          /* Right subnode */
22396ab3a2ecSdanielk1977   union {
2240c5cd1249Sdrh     ExprList *pList;     /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
2241c5cd1249Sdrh     Select *pSelect;     /* EP_xIsSelect and op = IN, EXISTS, SELECT */
22426ab3a2ecSdanielk1977   } x;
22436ab3a2ecSdanielk1977 
22446ab3a2ecSdanielk1977   /* If the EP_Reduced flag is set in the Expr.flags mask, then no
22456ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
22466ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
22476ab3a2ecSdanielk1977   *********************************************************************/
22486ab3a2ecSdanielk1977 
22496ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
22506ec65491Sdrh   int nHeight;           /* Height of the tree headed by this node */
22516ec65491Sdrh #endif
2252b7916a78Sdrh   int iTable;            /* TK_COLUMN: cursor number of table holding column
22532832ad42Sdan                          ** TK_REGISTER: register number
2254cca9f3d2Sdrh                          ** TK_TRIGGER: 1 -> new, 0 -> old
2255d05ab6aaSdrh                          ** EP_Unlikely:  134217728 times likelihood */
22568677d308Sdrh   ynVar iColumn;         /* TK_COLUMN: column index.  -1 for rowid.
2257937d0deaSdan                          ** TK_VARIABLE: variable number (always >= 1). */
2258b7916a78Sdrh   i16 iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
2259b7916a78Sdrh   i16 iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
2260030796dfSdrh   u8 op2;                /* TK_REGISTER: original value of Expr.op
2261030796dfSdrh                          ** TK_COLUMN: the value of p5 for OP_Column
2262030796dfSdrh                          ** TK_AGG_FUNCTION: nesting depth */
226313449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
22647d10d5a6Sdrh   Table *pTab;           /* Table for TK_COLUMN expressions. */
226575897234Sdrh };
226675897234Sdrh 
226775897234Sdrh /*
22681f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
22691f16230bSdrh */
227072673a24Sdrh #define EP_FromJoin  0x000001 /* Originates in ON/USING clause of outer join */
2271c5cd1249Sdrh #define EP_Agg       0x000002 /* Contains one or more aggregate functions */
2272c5cd1249Sdrh #define EP_Resolved  0x000004 /* IDs have been resolved to COLUMNs */
2273c5cd1249Sdrh #define EP_Error     0x000008 /* Expression contains one or more errors */
2274c5cd1249Sdrh #define EP_Distinct  0x000010 /* Aggregate function with DISTINCT keyword */
2275c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
2276c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
2277c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
2278fbb24d10Sdrh #define EP_Collate   0x000100 /* Tree contains a TK_COLLATE operator */
2279fbb24d10Sdrh #define EP_Generic   0x000200 /* Ignore COLLATE or affinity on this tree */
2280c5cd1249Sdrh #define EP_IntValue  0x000400 /* Integer value contained in u.iValue */
2281c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
2282a4c3c87eSdrh #define EP_Skip      0x001000 /* COLLATE, AS, or UNLIKELY */
2283c5cd1249Sdrh #define EP_Reduced   0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
2284c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
2285c5cd1249Sdrh #define EP_Static    0x008000 /* Held in memory not obtained from malloc() */
2286c5cd1249Sdrh #define EP_MemToken  0x010000 /* Need to sqlite3DbFree() Expr.zToken */
2287ebb6a65dSdrh #define EP_NoReduce  0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
2288a4c3c87eSdrh #define EP_Unlikely  0x040000 /* unlikely() or likelihood() function */
2289a7f910b5Sdrh #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
229072673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
2291885a5b03Sdrh #define EP_Subquery  0x200000 /* Tree contains a TK_SELECT operator */
22920b8d255cSdrh #define EP_Alias     0x400000 /* Is an alias for a result set column */
2293885a5b03Sdrh 
2294885a5b03Sdrh /*
2295885a5b03Sdrh ** Combinations of two or more EP_* flags
2296885a5b03Sdrh */
2297885a5b03Sdrh #define EP_Propagate (EP_Collate|EP_Subquery) /* Propagate these bits up tree */
22981af466ebSdrh 
22991af466ebSdrh /*
23001f16230bSdrh ** These macros can be used to test, set, or clear bits in the
23011f16230bSdrh ** Expr.flags field.
23021f16230bSdrh */
2303c5cd1249Sdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))!=0)
2304c5cd1249Sdrh #define ExprHasAllProperty(E,P)  (((E)->flags&(P))==(P))
23051f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
23061f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
23071f16230bSdrh 
2308ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation,
2309ebb6a65dSdrh ** and Accreditation only.  It works like ExprSetProperty() during VVA
2310ebb6a65dSdrh ** processes but is a no-op for delivery.
2311ebb6a65dSdrh */
2312ebb6a65dSdrh #ifdef SQLITE_DEBUG
2313ebb6a65dSdrh # define ExprSetVVAProperty(E,P)  (E)->flags|=(P)
2314ebb6a65dSdrh #else
2315ebb6a65dSdrh # define ExprSetVVAProperty(E,P)
2316ebb6a65dSdrh #endif
2317ebb6a65dSdrh 
23181f16230bSdrh /*
23196ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr
23206ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
23216ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set.
23226ab3a2ecSdanielk1977 */
232312ffee8cSdrh #define EXPR_FULLSIZE           sizeof(Expr)           /* Full size */
232412ffee8cSdrh #define EXPR_REDUCEDSIZE        offsetof(Expr,iTable)  /* Common features */
2325b7916a78Sdrh #define EXPR_TOKENONLYSIZE      offsetof(Expr,pLeft)   /* Fewer features */
23266ab3a2ecSdanielk1977 
23276ab3a2ecSdanielk1977 /*
23286ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment
23296ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details.
23306ab3a2ecSdanielk1977 */
233112ffee8cSdrh #define EXPRDUP_REDUCE         0x0001  /* Used reduced-size Expr nodes */
23326ab3a2ecSdanielk1977 
23336ab3a2ecSdanielk1977 /*
233475897234Sdrh ** A list of expressions.  Each expression may optionally have a
233575897234Sdrh ** name.  An expr/name combination can be used in several ways, such
233675897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
233775897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
2338ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
233975897234Sdrh ** field is not used.
23400dde4739Sdrh **
23410dde4739Sdrh ** By default the Expr.zSpan field holds a human-readable description of
23420dde4739Sdrh ** the expression that is used in the generation of error messages and
23430dde4739Sdrh ** column labels.  In this case, Expr.zSpan is typically the text of a
23440dde4739Sdrh ** column expression as it exists in a SELECT statement.  However, if
23450dde4739Sdrh ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
23463e3f1a5bSdrh ** of the result column in the form: DATABASE.TABLE.COLUMN.  This later
23473e3f1a5bSdrh ** form is used for name resolution with nested FROM clauses.
234875897234Sdrh */
234975897234Sdrh struct ExprList {
235075897234Sdrh   int nExpr;             /* Number of expressions on the list */
2351d872bb18Sdrh   struct ExprList_item { /* For each expression in the list */
235275897234Sdrh     Expr *pExpr;            /* The list of expressions */
235375897234Sdrh     char *zName;            /* Token associated with this expression */
2354b7916a78Sdrh     char *zSpan;            /* Original text of the expression */
23558e2ca029Sdrh     u8 sortOrder;           /* 1 for DESC or 0 for ASC */
23560dde4739Sdrh     unsigned done :1;       /* A flag to indicate when processing is finished */
23573e3f1a5bSdrh     unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
2358d673cddaSdrh     unsigned reusable :1;   /* Constant expression is reusable */
2359c2acc4e4Sdrh     union {
2360c2acc4e4Sdrh       struct {
23614b3ac73cSdrh         u16 iOrderByCol;      /* For ORDER BY, column number in result set */
23628b213899Sdrh         u16 iAlias;           /* Index into Parse.aAlias[] for zName */
2363c2acc4e4Sdrh       } x;
2364c2acc4e4Sdrh       int iConstExprReg;      /* Register in which Expr value is cached */
2365c2acc4e4Sdrh     } u;
2366d872bb18Sdrh   } *a;                  /* Alloc a power of two greater or equal to nExpr */
236775897234Sdrh };
236875897234Sdrh 
236975897234Sdrh /*
2370b7916a78Sdrh ** An instance of this structure is used by the parser to record both
2371b7916a78Sdrh ** the parse tree for an expression and the span of input text for an
2372b7916a78Sdrh ** expression.
2373b7916a78Sdrh */
2374b7916a78Sdrh struct ExprSpan {
2375b7916a78Sdrh   Expr *pExpr;          /* The expression parse tree */
2376b7916a78Sdrh   const char *zStart;   /* First character of input text */
2377b7916a78Sdrh   const char *zEnd;     /* One character past the end of input text */
2378b7916a78Sdrh };
2379b7916a78Sdrh 
2380b7916a78Sdrh /*
2381ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
2382ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
2383ad3cab52Sdrh **
2384ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
2385ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
2386ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
2387ad3cab52Sdrh **
2388ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
2389ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
2390ad3cab52Sdrh **
2391ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
2392ad3cab52Sdrh **
2393ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
239475897234Sdrh */
239575897234Sdrh struct IdList {
23966d4abfbeSdrh   struct IdList_item {
2397ad3cab52Sdrh     char *zName;      /* Name of the identifier */
2398967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
2399ad3cab52Sdrh   } *a;
240013449892Sdrh   int nId;         /* Number of identifiers on the list */
2401ad3cab52Sdrh };
2402ad3cab52Sdrh 
2403ad3cab52Sdrh /*
240451669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
2405ca83ac51Sdrh **
2406ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
2407ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
2408ca83ac51Sdrh ** of the library by 738 bytes on ix86.
240951669863Sdrh */
24100e008967Sdrh #ifdef SQLITE_BITMASK_TYPE
24110e008967Sdrh   typedef SQLITE_BITMASK_TYPE Bitmask;
24120e008967Sdrh #else
2413ca83ac51Sdrh   typedef u64 Bitmask;
24140e008967Sdrh #endif
241551669863Sdrh 
241651669863Sdrh /*
241700e13613Sdanielk1977 ** The number of bits in a Bitmask.  "BMS" means "BitMask Size".
241800e13613Sdanielk1977 */
241900e13613Sdanielk1977 #define BMS  ((int)(sizeof(Bitmask)*8))
242000e13613Sdanielk1977 
242100e13613Sdanielk1977 /*
24227699d1c4Sdrh ** A bit in a Bitmask
24237699d1c4Sdrh */
24247699d1c4Sdrh #define MASKBIT(n)   (((Bitmask)1)<<(n))
2425693e6719Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n))
24268426e36cSdrh #define ALLBITS      ((Bitmask)-1)
24277699d1c4Sdrh 
24287699d1c4Sdrh /*
2429ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
2430ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
2431ad3cab52Sdrh ** the SrcList.a[] array.
2432d24cc427Sdrh **
2433d24cc427Sdrh ** With the addition of multiple database support, the following structure
2434d24cc427Sdrh ** can also be used to describe a particular table such as the table that
2435d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
2436d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
2437d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
2438c49de5d9Sdrh **
2439c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
2440c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
2441c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
2442c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
24432a6a7eebSdrh **
24442a6a7eebSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table
24452a6a7eebSdrh ** contains more than 63 columns and the 64-th or later column is used.
2446ad3cab52Sdrh */
2447ad3cab52Sdrh struct SrcList {
24486d1626ebSdrh   int nSrc;        /* Number of tables or subqueries in the FROM clause */
24496d1626ebSdrh   u32 nAlloc;      /* Number of entries allocated in a[] below */
2450ad3cab52Sdrh   struct SrcList_item {
245141fb5cd1Sdan     Schema *pSchema;  /* Schema to which this item is fixed */
2452113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
2453ad3cab52Sdrh     char *zName;      /* Name of the table */
2454ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
2455daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
2456daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
24575b6a9ed4Sdrh     int addrFillSub;  /* Address of subroutine to manifest a subquery */
24585b6a9ed4Sdrh     int regReturn;    /* Register holding return address of addrFillSub */
24595f612295Sdrh     int regResult;    /* Registers holding results of a co-routine */
24608a48b9c0Sdrh     struct {
2461c49de5d9Sdrh       u8 jointype;      /* Type of join between this able and the previous */
246221172c4cSdrh       unsigned notIndexed :1;    /* True if there is a NOT INDEXED clause */
24638a48b9c0Sdrh       unsigned isIndexedBy :1;   /* True if there is an INDEXED BY clause */
24648a48b9c0Sdrh       unsigned isTabFunc :1;     /* True if table-valued-function syntax */
246521172c4cSdrh       unsigned isCorrelated :1;  /* True if sub-query is correlated */
246621172c4cSdrh       unsigned viaCoroutine :1;  /* Implemented as a co-routine */
2467f43fe6e9Sdan       unsigned isRecursive :1;   /* True for recursive reference in WITH */
24688a48b9c0Sdrh     } fg;
2469ce7e189dSdan #ifndef SQLITE_OMIT_EXPLAIN
2470ce7e189dSdan     u8 iSelectId;     /* If pSelect!=0, the id of the sub-select in EQP */
2471ce7e189dSdan #endif
2472e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
2473ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
2474ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
2475cd38d520Sdanielk1977     Bitmask colUsed;  /* Bit N (1<<N) set if column N of pTab is used */
24768a48b9c0Sdrh     union {
2477d62fbb50Sdrh       char *zIndexedBy;    /* Identifier from "INDEXED BY <zIndex>" clause */
24788a48b9c0Sdrh       ExprList *pFuncArg;  /* Arguments to table-valued-function */
24798a48b9c0Sdrh     } u1;
24808a48b9c0Sdrh     Index *pIBIndex;  /* Index structure corresponding to u1.zIndexedBy */
2481113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
248275897234Sdrh };
248375897234Sdrh 
248475897234Sdrh /*
248501f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
248601f3f253Sdrh */
248701f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
24883dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
24893dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
24903dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
24913dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
24923dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
24933dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
249401f3f253Sdrh 
2495111a6a7dSdrh 
2496111a6a7dSdrh /*
2497336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
2498336a5300Sdrh ** and the WhereInfo.wctrlFlags member.
249949711600Sdrh **
250049711600Sdrh ** Value constraints (enforced via assert()):
250149711600Sdrh **     WHERE_USE_LIMIT  == SF_FixedLimit
250208c88eb0Sdrh */
25036df2acd2Sdrh #define WHERE_ORDERBY_NORMAL   0x0000 /* No-op */
25046df2acd2Sdrh #define WHERE_ORDERBY_MIN      0x0001 /* ORDER BY processing for min() func */
25056df2acd2Sdrh #define WHERE_ORDERBY_MAX      0x0002 /* ORDER BY processing for max() func */
25066df2acd2Sdrh #define WHERE_ONEPASS_DESIRED  0x0004 /* Want to do one-pass UPDATE/DELETE */
2507336a5300Sdrh #define WHERE_DUPLICATES_OK    0x0008 /* Ok to return a row more than once */
25089ef61f4fSdrh #define WHERE_OMIT_OPEN_CLOSE  0x0010 /* Table cursors are already open */
25099ef61f4fSdrh #define WHERE_FORCE_TABLE      0x0020 /* Do not use an index-only search */
25109ef61f4fSdrh #define WHERE_ONETABLE_ONLY    0x0040 /* Only code the 1st table in pTabList */
25118e8e7ef3Sdrh #define WHERE_NO_AUTOINDEX     0x0080 /* Disallow automatic indexes */
2512319f677dSdrh #define WHERE_GROUPBY          0x0100 /* pOrderBy is really a GROUP BY */
25134f402f26Sdrh #define WHERE_DISTINCTBY       0x0200 /* pOrderby is really a DISTINCT clause */
25146457a353Sdrh #define WHERE_WANT_DISTINCT    0x0400 /* All output needs to be distinct */
2515374cd78cSdan #define WHERE_SORTBYGROUP      0x0800 /* Support sqlite3WhereIsSorted() */
25163526319bSdrh #define WHERE_REOPEN_IDX       0x1000 /* Try to use OP_ReopenIdx */
2517f0ee1d3cSdan #define WHERE_ONEPASS_MULTIROW 0x2000 /* ONEPASS is ok with multiple rows */
2518c3489bbfSdrh #define WHERE_USE_LIMIT        0x4000 /* There is a constant LIMIT clause */
2519a9d1ccb9Sdanielk1977 
25204f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct()
252175897234Sdrh */
2522e8e4af76Sdrh #define WHERE_DISTINCT_NOOP      0  /* DISTINCT keyword not used */
2523ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE    1  /* No duplicates */
2524ae651d61Sdrh #define WHERE_DISTINCT_ORDERED   2  /* All duplicates are adjacent */
2525e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3  /* Duplicates are scattered */
252638cc40c2Sdan 
252775897234Sdrh /*
2528b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
2529b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
2530b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
2531b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
2532b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
2533b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
2534b3bce662Sdanielk1977 ** other statements.
2535b3bce662Sdanielk1977 **
2536b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
2537b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
2538b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
2539b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
2540b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
2541b3bce662Sdanielk1977 ** the context containing the match is incremented.
2542b3bce662Sdanielk1977 **
2543b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
2544b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
2545b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
2546b3bce662Sdanielk1977 ** subqueries looking for a match.
2547b3bce662Sdanielk1977 */
2548b3bce662Sdanielk1977 struct NameContext {
2549b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
2550b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
255126080d92Sdrh   ExprList *pEList;    /* Optional list of result-set columns */
255213449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
2553b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
2554a51009b2Sdrh   int nRef;            /* Number of names resolved by this context */
2555a51009b2Sdrh   int nErr;            /* Number of errors encountered while resolving names */
25569588ad95Sdrh   u16 ncFlags;         /* Zero or more NC_* flags defined below */
2557b3bce662Sdanielk1977 };
2558b3bce662Sdanielk1977 
2559b3bce662Sdanielk1977 /*
2560a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field.
25619588ad95Sdrh **
256249711600Sdrh ** Value constraints (all checked via assert()):
256349711600Sdrh **    NC_HasAgg    == SF_HasAgg
256449711600Sdrh **    NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
25659588ad95Sdrh **
2566a51009b2Sdrh */
25679588ad95Sdrh #define NC_AllowAgg  0x0001  /* Aggregate functions are allowed here */
256849711600Sdrh #define NC_PartIdx   0x0002  /* True if resolving a partial index WHERE */
25699588ad95Sdrh #define NC_IsCheck   0x0004  /* True if resolving names in a CHECK constraint */
25709588ad95Sdrh #define NC_InAggFunc 0x0008  /* True if analyzing arguments to an agg func */
257149711600Sdrh #define NC_HasAgg    0x0010  /* One or more aggregate functions seen */
2572a514b8ebSdrh #define NC_IdxExpr   0x0020  /* True if resolving columns of CREATE INDEX */
25739588ad95Sdrh #define NC_MinMaxAgg 0x1000  /* min/max aggregates seen.  See note above */
2574a51009b2Sdrh 
2575a51009b2Sdrh /*
25769bb61fe7Sdrh ** An instance of the following structure contains all information
25779bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
2578a76b5dfcSdrh **
2579d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
2580d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
2581d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
2582d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
2583d11d382cSdrh ** in the VDBE that record the limit and offset counters.
25840342b1f5Sdrh **
2585b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
25860342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
258766a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
25880342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
2589b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
25900342b1f5Sdrh ** enough information about the compound query is known at that point.
2591b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
25922c79733fSdrh ** for the result set.  The KeyInfo for addrOpenEphm[2] contains collating
25930342b1f5Sdrh ** sequences for the ORDER BY clause.
25949bb61fe7Sdrh */
25959bb61fe7Sdrh struct Select {
25969bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
25977b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
2598c3489bbfSdrh   LogEst nSelectRow;     /* Estimated number of result rows */
2599c3489bbfSdrh   u32 selFlags;          /* Various SF_* values */
2600a451017dSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
2601abd4c723Sdrh #if SELECTTRACE_ENABLED
2602eb9b884cSdrh   char zSelName[12];     /* Symbolic name of this SELECT use for debugging */
2603abd4c723Sdrh #endif
2604079a3072Sdrh   int addrOpenEphm[2];   /* OP_OpenEphem opcodes related to this select */
2605ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
26069bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
26079bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
26089bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
26099bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
2610967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
26111e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
2612a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
2613a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
26144e9119d9Sdan   With *pWith;           /* WITH clause attached to this select. Or NULL. */
26159bb61fe7Sdrh };
26169bb61fe7Sdrh 
26179bb61fe7Sdrh /*
26187d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
26197d10d5a6Sdrh ** "Select Flag".
262049711600Sdrh **
262149711600Sdrh ** Value constraints (all checked via assert())
262249711600Sdrh **     SF_HasAgg     == NC_HasAgg
262349711600Sdrh **     SF_MinMaxAgg  == NC_MinMaxAgg     == SQLITE_FUNC_MINMAX
262449711600Sdrh **     SF_FixedLimit == WHERE_USE_LIMIT
26257d10d5a6Sdrh */
2626c3489bbfSdrh #define SF_Distinct       0x00001  /* Output should be DISTINCT */
2627c3489bbfSdrh #define SF_All            0x00002  /* Includes the ALL keyword */
2628c3489bbfSdrh #define SF_Resolved       0x00004  /* Identifiers have been resolved */
262949711600Sdrh #define SF_Aggregate      0x00008  /* Contains agg functions or a GROUP BY */
263049711600Sdrh #define SF_HasAgg         0x00010  /* Contains aggregate functions */
263149711600Sdrh #define SF_UsesEphemeral  0x00020  /* Uses the OpenEphemeral opcode */
263249711600Sdrh #define SF_Expanded       0x00040  /* sqlite3SelectExpand() called on this */
263349711600Sdrh #define SF_HasTypeInfo    0x00080  /* FROM subqueries have Table metadata */
263449711600Sdrh #define SF_Compound       0x00100  /* Part of a compound query */
263549711600Sdrh #define SF_Values         0x00200  /* Synthesized from VALUES clause */
263649711600Sdrh #define SF_MultiValue     0x00400  /* Single VALUES term with multiple rows */
263749711600Sdrh #define SF_NestedFrom     0x00800  /* Part of a parenthesized FROM clause */
2638c3489bbfSdrh #define SF_MinMaxAgg      0x01000  /* Aggregate containing min() or max() */
2639c3489bbfSdrh #define SF_Recursive      0x02000  /* The recursive part of a recursive CTE */
2640c3489bbfSdrh #define SF_FixedLimit     0x04000  /* nSelectRow set by a constant LIMIT */
264149711600Sdrh #define SF_MaybeConvert   0x08000  /* Need convertCompoundSelectToSubquery() */
264249711600Sdrh #define SF_Converted      0x10000  /* By convertCompoundSelectToSubquery() */
264349711600Sdrh #define SF_IncludeHidden  0x20000  /* Include hidden columns in output */
26447d10d5a6Sdrh 
26457d10d5a6Sdrh 
26467d10d5a6Sdrh /*
2647340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined
2648340309fdSdrh ** by one of the following macros.  The "SRT" prefix means "SELECT Result
2649340309fdSdrh ** Type".
2650340309fdSdrh **
2651340309fdSdrh **     SRT_Union       Store results as a key in a temporary index
2652340309fdSdrh **                     identified by pDest->iSDParm.
2653340309fdSdrh **
2654340309fdSdrh **     SRT_Except      Remove results from the temporary index pDest->iSDParm.
2655340309fdSdrh **
2656340309fdSdrh **     SRT_Exists      Store a 1 in memory cell pDest->iSDParm if the result
2657340309fdSdrh **                     set is not empty.
2658340309fdSdrh **
2659340309fdSdrh **     SRT_Discard     Throw the results away.  This is used by SELECT
2660340309fdSdrh **                     statements within triggers whose only purpose is
2661340309fdSdrh **                     the side-effects of functions.
2662340309fdSdrh **
2663340309fdSdrh ** All of the above are free to ignore their ORDER BY clause. Those that
2664340309fdSdrh ** follow must honor the ORDER BY clause.
2665340309fdSdrh **
2666340309fdSdrh **     SRT_Output      Generate a row of output (using the OP_ResultRow
2667340309fdSdrh **                     opcode) for each row in the result set.
2668340309fdSdrh **
2669340309fdSdrh **     SRT_Mem         Only valid if the result is a single column.
2670340309fdSdrh **                     Store the first column of the first result row
2671340309fdSdrh **                     in register pDest->iSDParm then abandon the rest
2672340309fdSdrh **                     of the query.  This destination implies "LIMIT 1".
2673340309fdSdrh **
2674340309fdSdrh **     SRT_Set         The result must be a single column.  Store each
2675340309fdSdrh **                     row of result as the key in table pDest->iSDParm.
2676340309fdSdrh **                     Apply the affinity pDest->affSdst before storing
2677340309fdSdrh **                     results.  Used to implement "IN (SELECT ...)".
2678340309fdSdrh **
2679340309fdSdrh **     SRT_EphemTab    Create an temporary table pDest->iSDParm and store
2680340309fdSdrh **                     the result there. The cursor is left open after
2681340309fdSdrh **                     returning.  This is like SRT_Table except that
2682340309fdSdrh **                     this destination uses OP_OpenEphemeral to create
2683340309fdSdrh **                     the table first.
2684340309fdSdrh **
2685340309fdSdrh **     SRT_Coroutine   Generate a co-routine that returns a new row of
2686340309fdSdrh **                     results each time it is invoked.  The entry point
2687340309fdSdrh **                     of the co-routine is stored in register pDest->iSDParm
2688340309fdSdrh **                     and the result row is stored in pDest->nDest registers
2689340309fdSdrh **                     starting with pDest->iSdst.
2690340309fdSdrh **
2691781def29Sdrh **     SRT_Table       Store results in temporary table pDest->iSDParm.
26928e1ee88cSdrh **     SRT_Fifo        This is like SRT_EphemTab except that the table
26938e1ee88cSdrh **                     is assumed to already be open.  SRT_Fifo has
26948e1ee88cSdrh **                     the additional property of being able to ignore
26958e1ee88cSdrh **                     the ORDER BY clause.
2696781def29Sdrh **
26978e1ee88cSdrh **     SRT_DistFifo    Store results in a temporary table pDest->iSDParm.
2698340309fdSdrh **                     But also use temporary table pDest->iSDParm+1 as
2699340309fdSdrh **                     a record of all prior results and ignore any duplicate
27008e1ee88cSdrh **                     rows.  Name means:  "Distinct Fifo".
2701781def29Sdrh **
2702781def29Sdrh **     SRT_Queue       Store results in priority queue pDest->iSDParm (really
2703781def29Sdrh **                     an index).  Append a sequence number so that all entries
2704781def29Sdrh **                     are distinct.
2705781def29Sdrh **
2706781def29Sdrh **     SRT_DistQueue   Store results in priority queue pDest->iSDParm only if
2707781def29Sdrh **                     the same record has never been stored before.  The
2708781def29Sdrh **                     index at pDest->iSDParm+1 hold all prior stores.
2709fef5208cSdrh */
271013449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
271113449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
27129ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
27139ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
27148e1ee88cSdrh #define SRT_Fifo         5  /* Store result as data with an automatic rowid */
27158e1ee88cSdrh #define SRT_DistFifo     6  /* Like SRT_Fifo, but unique results only */
27168e1ee88cSdrh #define SRT_Queue        7  /* Store result in an queue */
27178e1ee88cSdrh #define SRT_DistQueue    8  /* Like SRT_Queue, but unique results only */
2718fef5208cSdrh 
271913449892Sdrh /* The ORDER BY clause is ignored for all of the above */
27208e1ee88cSdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
272113449892Sdrh 
27228e1ee88cSdrh #define SRT_Output       9  /* Output each row of result */
27238e1ee88cSdrh #define SRT_Mem         10  /* Store result in a memory cell */
27248e1ee88cSdrh #define SRT_Set         11  /* Store results as keys in an index */
27258e1ee88cSdrh #define SRT_EphemTab    12  /* Create transient tab and store like SRT_Table */
27268e1ee88cSdrh #define SRT_Coroutine   13  /* Generate a single row of result */
27278e1ee88cSdrh #define SRT_Table       14  /* Store result as data with an automatic rowid */
27282282792aSdrh 
27292282792aSdrh /*
2730634d81deSdrh ** An instance of this object describes where to put of the results of
2731634d81deSdrh ** a SELECT statement.
27326c8c8ce0Sdanielk1977 */
27336c8c8ce0Sdanielk1977 struct SelectDest {
2734634d81deSdrh   u8 eDest;            /* How to dispose of the results.  On of SRT_* above. */
2735634d81deSdrh   char affSdst;        /* Affinity used when eDest==SRT_Set */
27362b596da8Sdrh   int iSDParm;         /* A parameter used by the eDest disposal method */
27372b596da8Sdrh   int iSdst;           /* Base register where results are written */
27382b596da8Sdrh   int nSdst;           /* Number of registers allocated */
2739fe1c6bb9Sdrh   ExprList *pOrderBy;  /* Key columns for SRT_Queue and SRT_DistQueue */
27406c8c8ce0Sdanielk1977 };
27416c8c8ce0Sdanielk1977 
27426c8c8ce0Sdanielk1977 /*
27430b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT
27440b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p
27450b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that
27460b9f50d8Sdrh ** the code generator needs.  We have to keep per-table autoincrement
27471b32554bSdrh ** information in case inserts are done within triggers.  Triggers do not
27480b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the
27490b9f50d8Sdrh ** loading and saving of autoincrement information.
27500b9f50d8Sdrh */
27510b9f50d8Sdrh struct AutoincInfo {
27520b9f50d8Sdrh   AutoincInfo *pNext;   /* Next info block in a list of them all */
27530b9f50d8Sdrh   Table *pTab;          /* Table this info block refers to */
27540b9f50d8Sdrh   int iDb;              /* Index in sqlite3.aDb[] of database holding pTab */
27550b9f50d8Sdrh   int regCtr;           /* Memory register holding the rowid counter */
27560b9f50d8Sdrh };
27570b9f50d8Sdrh 
27580b9f50d8Sdrh /*
2759ceea3321Sdrh ** Size of the column cache
2760ceea3321Sdrh */
2761ceea3321Sdrh #ifndef SQLITE_N_COLCACHE
2762ceea3321Sdrh # define SQLITE_N_COLCACHE 10
2763ceea3321Sdrh #endif
2764ceea3321Sdrh 
27652832ad42Sdan /*
27662832ad42Sdan ** At least one instance of the following structure is created for each
27672832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
27682832ad42Sdan ** statement. All such objects are stored in the linked list headed at
27692832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been
27702832ad42Sdan ** completed.
27712832ad42Sdan **
27722832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger
27732832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
27742832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
27752832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same
27762832ad42Sdan ** values for both pTrigger and orconf.
277765a7cd16Sdan **
2778bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
277965a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT
2780bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
2781bb5f168fSdan ** a mask of new.* columns used by the program.
27822832ad42Sdan */
27832832ad42Sdan struct TriggerPrg {
27842832ad42Sdan   Trigger *pTrigger;      /* Trigger this program was coded from */
27852832ad42Sdan   TriggerPrg *pNext;      /* Next entry in Parse.pTriggerPrg list */
2786a451017dSdrh   SubProgram *pProgram;   /* Program implementing pTrigger/orconf */
2787a451017dSdrh   int orconf;             /* Default ON CONFLICT policy */
2788a451017dSdrh   u32 aColmask[2];        /* Masks of old.*, new.* columns accessed */
2789165921a7Sdan };
2790165921a7Sdan 
279164123585Sdrh /*
279264123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases.
279364123585Sdrh */
279401c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30
2795a7ab6d81Sdrh   typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
2796a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)[(I)/8]&(1<<((I)&7)))!=0)
2797a7ab6d81Sdrh # define DbMaskZero(M)      memset((M),0,sizeof(M))
2798a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)[(I)/8]|=(1<<((I)&7))
2799a7ab6d81Sdrh # define DbMaskAllZero(M)   sqlite3DbMaskAllZero(M)
2800a7ab6d81Sdrh # define DbMaskNonZero(M)   (sqlite3DbMaskAllZero(M)==0)
280101c7dc88Sdrh #else
280264123585Sdrh   typedef unsigned int yDbMask;
2803a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)&(((yDbMask)1)<<(I)))!=0)
2804a7ab6d81Sdrh # define DbMaskZero(M)      (M)=0
2805a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)|=(((yDbMask)1)<<(I))
2806a7ab6d81Sdrh # define DbMaskAllZero(M)   (M)==0
2807a7ab6d81Sdrh # define DbMaskNonZero(M)   (M)!=0
280801c7dc88Sdrh #endif
280901c7dc88Sdrh 
2810ceea3321Sdrh /*
2811f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
2812f57b3399Sdrh ** the parser and down into all the parser action routine in order to
2813f57b3399Sdrh ** carry around information that is global to the entire parse.
2814f1974846Sdrh **
2815f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
2816f1974846Sdrh ** generate call themselves recursively, the first part of the structure
2817f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
2818f1974846Sdrh ** each recursion.
2819c00da105Sdanielk1977 **
2820c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
2821c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
2822c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
2823c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
2824c00da105Sdanielk1977 ** list.
282575897234Sdrh */
282675897234Sdrh struct Parse {
28279bb575fdSdrh   sqlite3 *db;         /* The main database structure */
282875897234Sdrh   char *zErrMsg;       /* An error message */
282975897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
2830a451017dSdrh   int rc;              /* Return code from execution */
2831836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
2832a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
2833205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
2834892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
2835a451017dSdrh   u8 isMultiWrite;     /* True if statement may modify/insert multiple rows */
2836a451017dSdrh   u8 mayAbort;         /* True if statement may throw an ABORT exception */
2837d58d3278Sdrh   u8 hasCompound;      /* Need to invoke convertCompoundSelectToSubquery() */
2838aceb31b1Sdrh   u8 okConstFactor;    /* OK to factor out constants */
28394a642b60Sdrh   u8 disableLookaside; /* Number of times lookaside has been disabled */
2840bea119cdSdrh   u8 nColCache;        /* Number of entries in aColCache[] */
2841892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
2842892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
2843892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
284475897234Sdrh   int nErr;            /* Number of errors seen */
2845832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
284619a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
2847fef5208cSdrh   int nSet;            /* Number of sets used so far */
28481d8cb21fSdan   int nOnce;           /* Number of OP_Once instructions so far */
284973d5b8f5Sdrh   int nOpAlloc;        /* Number of slots allocated for Vdbe.aOp[] */
2850bd57308eSdrh   int szOpAlloc;       /* Bytes of memory space allocated for Vdbe.aOp[] */
285161019c78Sdrh   int iFixedOp;        /* Never back out opcodes iFixedOp-1 or earlier */
2852aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
28531f9ca2c8Sdrh   int iSelfTab;        /* Table of an index whose exprs are being coded */
2854ceea3321Sdrh   int iCacheLevel;     /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
2855ceea3321Sdrh   int iCacheCnt;       /* Counter used to generate aColCache[].lru values */
28567df89c8cSdrh   int nLabel;          /* Number of labels used */
28577df89c8cSdrh   int *aLabel;         /* Space to hold the labels */
28582f7794c1Sdrh   struct yColCache {
2859e55cbd72Sdrh     int iTable;           /* Table cursor number */
28607df89c8cSdrh     i16 iColumn;          /* Table column number */
2861ceea3321Sdrh     u8 tempReg;           /* iReg is a temp register that needs to be freed */
2862ceea3321Sdrh     int iLevel;           /* Nesting level */
2863ceea3321Sdrh     int iReg;             /* Reg with value of this column. 0 means none. */
2864ceea3321Sdrh     int lru;              /* Least recently used entry has the smallest value */
2865ceea3321Sdrh   } aColCache[SQLITE_N_COLCACHE];  /* One for each column cache entry */
2866f30a969bSdrh   ExprList *pConstExpr;/* Constant expressions */
28677df89c8cSdrh   Token constraintName;/* Name of the constraint currently being parsed */
286864123585Sdrh   yDbMask writeMask;   /* Start a write transaction on these databases */
286964123585Sdrh   yDbMask cookieMask;  /* Bitmask of schema verified databases */
2870c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
2871a451017dSdrh   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
2872a451017dSdrh   int regRoot;         /* Register holding root page number for new objects */
2873a451017dSdrh   int nMaxArg;         /* Max args passed to user function by sub-program */
2874abd4c723Sdrh #if SELECTTRACE_ENABLED
2875abd4c723Sdrh   int nSelect;         /* Number of SELECT statements seen */
2876eb9b884cSdrh   int nSelectIndent;   /* How far to indent SELECTTRACE() output */
2877abd4c723Sdrh #endif
2878c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2879c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
2880c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
2881c00da105Sdanielk1977 #endif
28820b9f50d8Sdrh   AutoincInfo *pAinc;  /* Information about AUTOINCREMENT counters */
2883f1974846Sdrh 
2884165921a7Sdan   /* Information used while coding trigger programs. */
288565a7cd16Sdan   Parse *pToplevel;    /* Parse structure for main program (or NULL) */
2886165921a7Sdan   Table *pTriggerTab;  /* Table triggers are being coded for */
2887c6bd4e4aSdrh   int addrCrTab;       /* Address of OP_CreateTable opcode on CREATE TABLE */
28884f402f26Sdrh   u32 nQueryLoop;      /* Est number of iterations of a query (10*log2(N)) */
288965a7cd16Sdan   u32 oldmask;         /* Mask of old.* columns referenced */
2890bb5f168fSdan   u32 newmask;         /* Mask of new.* columns referenced */
289165a7cd16Sdan   u8 eTriggerOp;       /* TK_UPDATE, TK_INSERT or TK_DELETE */
289265a7cd16Sdan   u8 eOrconf;          /* Default ON CONFLICT policy for trigger steps */
2893d66c8309Sdan   u8 disableTriggers;  /* True to disable triggers */
2894165921a7Sdan 
28957df89c8cSdrh   /************************************************************************
28967df89c8cSdrh   ** Above is constant between recursions.  Below is reset before and after
28977df89c8cSdrh   ** each recursion.  The boundary between these two regions is determined
28987df89c8cSdrh   ** using offsetof(Parse,nVar) so the nVar field must be the first field
28997df89c8cSdrh   ** in the recursive region.
29007df89c8cSdrh   ************************************************************************/
2901f1974846Sdrh 
29026d664b4bSdrh   ynVar nVar;               /* Number of '?' variables seen in the SQL so far */
2903124c0b49Sdrh   int nzVar;                /* Number of available slots in azVar[] */
29047f9c5dbfSdrh   u8 iPkSortOrder;          /* ASC or DESC for INTEGER PRIMARY KEY */
2905a451017dSdrh   u8 explain;               /* True if the EXPLAIN flag is found on the query */
2906a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2907a451017dSdrh   u8 declareVtab;           /* True if inside sqlite3_declare_vtab() */
2908a451017dSdrh   int nVtabLock;            /* Number of virtual tables to lock */
2909a451017dSdrh #endif
2910a451017dSdrh   int nAlias;               /* Number of aliased result set columns */
2911a451017dSdrh   int nHeight;              /* Expression tree height of current sub-select */
2912a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN
2913a451017dSdrh   int iSelectId;            /* ID of current select for EXPLAIN output */
2914a451017dSdrh   int iNextSelectId;        /* Next available select ID for EXPLAIN output */
2915a451017dSdrh #endif
2916124c0b49Sdrh   char **azVar;             /* Pointers to names of parameters */
2917937d0deaSdan   Vdbe *pReprepare;         /* VM being reprepared (sqlite3Reprepare()) */
2918f1974846Sdrh   const char *zTail;        /* All SQL text past the last semicolon parsed */
2919f1974846Sdrh   Table *pNewTable;         /* A table being constructed by CREATE TABLE */
2920f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
2921f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
2922a451017dSdrh   Token sNameToken;         /* Token with unqualified schema object name */
2923a451017dSdrh   Token sLastToken;         /* The last token parsed */
2924b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
292533b3933cSdanielk1977   Token sArg;               /* Complete text of a module argument */
29264f3dd150Sdrh   Table **apVtabLock;       /* Pointer to virtual tables needing locking */
2927b9bb7c18Sdrh #endif
2928588a9a1aSdrh   Table *pZombieTab;        /* List of Table objects to delete after code gen */
29292832ad42Sdan   TriggerPrg *pTriggerPrg;  /* Linked list of coded triggers */
29304e9119d9Sdan   With *pWith;              /* Current WITH clause, or NULL */
29316e772266Sdrh   With *pWithToFree;        /* Free this WITH object at the end of the parse */
293275897234Sdrh };
293375897234Sdrh 
2934a451017dSdrh /*
2935a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call.
2936a451017dSdrh */
29377e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
29387e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
29397e6ebfb2Sdanielk1977 #else
29407e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
29417e6ebfb2Sdanielk1977 #endif
29427e6ebfb2Sdanielk1977 
2943d99bc930Sdanielk1977 /*
294485e2096fSdrh ** An instance of the following structure can be declared on a stack and used
294585e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
294685e2096fSdrh */
294785e2096fSdrh struct AuthContext {
294885e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
294985e2096fSdrh   Parse *pParse;              /* The Parse structure */
295085e2096fSdrh };
295185e2096fSdrh 
295285e2096fSdrh /*
2953a748fdccSdrh ** Bitfield flags for P5 value in various opcodes.
295449711600Sdrh **
295549711600Sdrh ** Value constraints (enforced via assert()):
295649711600Sdrh **    OPFLAG_LENGTHARG    == SQLITE_FUNC_LENGTH
295749711600Sdrh **    OPFLAG_TYPEOFARG    == SQLITE_FUNC_TYPEOF
295849711600Sdrh **    OPFLAG_BULKCSR      == BTREE_BULKLOAD
295949711600Sdrh **    OPFLAG_SEEKEQ       == BTREE_SEEK_EQ
296049711600Sdrh **    OPFLAG_FORDELETE    == BTREE_FORDELETE
296149711600Sdrh **    OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
296249711600Sdrh **    OPFLAG_AUXDELETE    == BTREE_AUXDELETE
2963b0c374ffSrdc */
2964e807bdbaSdrh #define OPFLAG_NCHANGE       0x01    /* OP_Insert: Set to update db->nChange */
2965e807bdbaSdrh                                      /* Also used in P2 (not P5) of OP_Delete */
296697348b37Sdrh #define OPFLAG_EPHEM         0x01    /* OP_Column: Ephemeral output is ok */
29673e9ca094Sdrh #define OPFLAG_LASTROWID     0x02    /* Set to update db->lastRowid */
29683e9ca094Sdrh #define OPFLAG_ISUPDATE      0x04    /* This OP_Insert is an sql UPDATE */
29693e9ca094Sdrh #define OPFLAG_APPEND        0x08    /* This is likely to be an append */
29703e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10    /* Try to avoid a seek in BtreeInsert() */
2971c556f3c3Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
297246c47d46Sdan #define OPFLAG_ISNOOP        0x40    /* OP_Delete does pre-update-hook only */
2973c556f3c3Sdrh #endif
2974a748fdccSdrh #define OPFLAG_LENGTHARG     0x40    /* OP_Column only used for length() */
2975a748fdccSdrh #define OPFLAG_TYPEOFARG     0x80    /* OP_Column only used for typeof() */
2976428c218cSdan #define OPFLAG_BULKCSR       0x01    /* OP_Open** used to open bulk cursor */
2977e0997b34Sdrh #define OPFLAG_SEEKEQ        0x02    /* OP_Open** cursor uses EQ seek only */
29789c0c57a4Sdrh #define OPFLAG_FORDELETE     0x08    /* OP_Open should use BTREE_FORDELETE */
2979fd261ec6Sdan #define OPFLAG_P2ISREG       0x10    /* P2 to OP_Open** is a register number */
2980953f7611Sdrh #define OPFLAG_PERMUTE       0x01    /* OP_Compare: use the permutation */
2981e807bdbaSdrh #define OPFLAG_SAVEPOSITION  0x02    /* OP_Delete: keep cursor position */
2982def19e3bSdrh #define OPFLAG_AUXDELETE     0x04    /* OP_Delete: index in a DELETE op */
2983b0c374ffSrdc 
2984b0c374ffSrdc /*
2985d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
2986d99bc930Sdanielk1977  * struct Trigger.
2987d99bc930Sdanielk1977  *
2988d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
29899bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
2990d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
2991d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
2992ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
2993ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
2994ad3cab52Sdrh  *    struct Table.
2995d99bc930Sdanielk1977  *
2996ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
2997ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
2998d99bc930Sdanielk1977  */
2999d99bc930Sdanielk1977 struct Trigger {
3000165921a7Sdan   char *zName;            /* The name of the trigger                        */
3001d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
3002f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
3003dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
3004467bcf36Sshane   Expr *pWhen;            /* The WHEN clause of the expression (may be NULL) */
3005d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
3006d99bc930Sdanielk1977                              the <column-list> is stored here */
3007e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
3008e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
3009d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
3010d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
3011c3f9bad2Sdanielk1977 };
3012d99bc930Sdanielk1977 
3013d99bc930Sdanielk1977 /*
3014dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
3015dca76841Sdrh ** determine which.
3016dca76841Sdrh **
3017dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
3018dca76841Sdrh ** In that cases, the constants below can be ORed together.
3019dca76841Sdrh */
3020dca76841Sdrh #define TRIGGER_BEFORE  1
3021dca76841Sdrh #define TRIGGER_AFTER   2
3022dca76841Sdrh 
3023dca76841Sdrh /*
3024d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
3025d99bc930Sdanielk1977  * that is a part of a trigger-program.
3026d99bc930Sdanielk1977  *
3027d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
3028d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
3029d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
3030d99bc930Sdanielk1977  * the first step of the trigger-program.
3031d99bc930Sdanielk1977  *
3032d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
3033d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
3034d99bc930Sdanielk1977  * value of "op" as follows:
3035d99bc930Sdanielk1977  *
3036d99bc930Sdanielk1977  * (op == TK_INSERT)
3037d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
3038d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
3039d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
304046408354Sdan  * zTarget   -> Dequoted name of the table to insert into.
3041d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
3042d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
3043d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
3044ad3cab52Sdrh  *              statement, then this stores the column-names to be
3045ad3cab52Sdrh  *              inserted into.
3046d99bc930Sdanielk1977  *
3047d99bc930Sdanielk1977  * (op == TK_DELETE)
304846408354Sdan  * zTarget   -> Dequoted name of the table to delete from.
3049d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
3050d99bc930Sdanielk1977  *              Otherwise NULL.
3051d99bc930Sdanielk1977  *
3052d99bc930Sdanielk1977  * (op == TK_UPDATE)
305346408354Sdan  * zTarget   -> Dequoted name of the table to update.
3054d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
3055d99bc930Sdanielk1977  *              Otherwise NULL.
3056d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
30574adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
3058ad3cab52Sdrh  *              argument.
3059d99bc930Sdanielk1977  *
3060d99bc930Sdanielk1977  */
3061c3f9bad2Sdanielk1977 struct TriggerStep {
3062b1819a0bSdrh   u8 op;               /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
3063b1819a0bSdrh   u8 orconf;           /* OE_Rollback etc. */
3064a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
306546408354Sdan   Select *pSelect;     /* SELECT statement or RHS of INSERT INTO SELECT ... */
306646408354Sdan   char *zTarget;       /* Target table for DELETE, UPDATE, INSERT */
3067b1819a0bSdrh   Expr *pWhere;        /* The WHERE clause for DELETE or UPDATE steps */
306875593d96Sdrh   ExprList *pExprList; /* SET clause for UPDATE. */
3069b1819a0bSdrh   IdList *pIdList;     /* Column names for INSERT */
3070c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
3071187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
3072c3f9bad2Sdanielk1977 };
3073c3f9bad2Sdanielk1977 
3074d99bc930Sdanielk1977 /*
3075f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
3076f26e09c8Sdrh ** routines as they walk the parse tree to make database references
3077f26e09c8Sdrh ** explicit.
3078f26e09c8Sdrh */
3079f26e09c8Sdrh typedef struct DbFixer DbFixer;
3080f26e09c8Sdrh struct DbFixer {
3081f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
308241fb5cd1Sdan   Schema *pSchema;    /* Fix items to this schema */
308346539d7cSdan   int bVarOnly;       /* Check for variable references only */
3084f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
3085f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
3086f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
3087f26e09c8Sdrh };
3088f26e09c8Sdrh 
3089f26e09c8Sdrh /*
3090ade86483Sdrh ** An objected used to accumulate the text of a string where we
3091ade86483Sdrh ** do not necessarily know how big the string will be in the end.
3092ade86483Sdrh */
3093ade86483Sdrh struct StrAccum {
3094633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
3095ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
3096ade86483Sdrh   char *zText;         /* The string collected so far */
3097fa385edfSdrh   u32  nChar;          /* Length of the string so far */
3098fa385edfSdrh   u32  nAlloc;         /* Amount of space allocated in zText */
3099fa385edfSdrh   u32  mxAlloc;        /* Maximum allowed allocation.  0 for no malloc usage */
3100b49bc86aSdrh   u8   accError;       /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
31015f4a686fSdrh   u8   printfFlags;    /* SQLITE_PRINTF flags below */
3102ade86483Sdrh };
3103b49bc86aSdrh #define STRACCUM_NOMEM   1
3104b49bc86aSdrh #define STRACCUM_TOOBIG  2
31055f4a686fSdrh #define SQLITE_PRINTF_INTERNAL 0x01  /* Internal-use-only converters allowed */
31065f4a686fSdrh #define SQLITE_PRINTF_SQLFUNC  0x02  /* SQL function arguments to VXPrintf */
31075f4a686fSdrh #define SQLITE_PRINTF_MALLOCED 0x04  /* True if xText is allocated space */
31085f4a686fSdrh 
31095f4a686fSdrh #define isMalloced(X)  (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
31105f4a686fSdrh 
3111ade86483Sdrh 
3112ade86483Sdrh /*
3113234c39dfSdrh ** A pointer to this structure is used to communicate information
3114234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
3115234c39dfSdrh */
3116234c39dfSdrh typedef struct {
31179bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
3118234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
3119a451017dSdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
312015ca1df1Sdrh   int rc;             /* Result code stored here */
3121234c39dfSdrh } InitData;
3122234c39dfSdrh 
3123b6c29897Sdrh /*
312440257ffdSdrh ** Structure containing global configuration data for the SQLite library.
312533589797Sdrh **
312633589797Sdrh ** This structure also contains some state information.
312740257ffdSdrh */
312840257ffdSdrh struct Sqlite3Config {
3129fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
3130fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
3131fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
3132cd74b611Sdan   int bOpenUri;                     /* True to interpret filenames as URIs */
3133de9a7b8aSdrh   int bUseCis;                      /* Use covering indices for full-scans */
31340a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
313509fe6143Sdrh   int neverCorrupt;                 /* Database is always well-formed */
3136633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
3137633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
31388c71a98cSdrh   int nStmtSpill;                   /* Stmt-journal spill-to-disk threshold */
3139fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
31406d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
314122e21ff4Sdan   sqlite3_pcache_methods2 pcache2;  /* Low-level page-cache interface */
314240257ffdSdrh   void *pHeap;                      /* Heap storage space */
314333589797Sdrh   int nHeap;                        /* Size of pHeap[] */
314433589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
31459b4c59faSdrh   sqlite3_int64 szMmap;             /* mmap() space per open file */
31469b4c59faSdrh   sqlite3_int64 mxMmap;             /* Maximum value for szMmap */
314733589797Sdrh   void *pScratch;                   /* Scratch memory */
314833589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
314933589797Sdrh   int nScratch;                     /* Number of scratch buffers */
315033589797Sdrh   void *pPage;                      /* Page cache memory */
315133589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
315233589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
31531875f7a3Sdrh   int mxParserStack;                /* maximum depth of the parser stack */
31541875f7a3Sdrh   int sharedCacheEnabled;           /* true if shared-cache mode enabled */
31553bd1791dSdrh   u32 szPma;                        /* Maximum Sorter PMA size */
31561875f7a3Sdrh   /* The above might be initialized to non-zero.  The following need to always
31571875f7a3Sdrh   ** initially be zero, however. */
315871bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
3159502b4e00Sdanielk1977   int inProgress;                   /* True while initialization in progress */
3160e1ab2193Sdan   int isMutexInit;                  /* True after mutexes are initialized */
316171bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
3162e1ab2193Sdan   int isPCacheInit;                 /* True after malloc is initialized */
316393ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
3164c007f61bSdrh   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
31653f280701Sdrh   void (*xLog)(void*,int,const char*); /* Function for logging */
31663f280701Sdrh   void *pLogArg;                       /* First argument to xLog() */
3167ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG
3168ac455939Sdan   void(*xSqllog)(void*,sqlite3*,const char*, int);
3169ac455939Sdan   void *pSqllogArg;
3170ac455939Sdan #endif
3171688852abSdrh #ifdef SQLITE_VDBE_COVERAGE
3172688852abSdrh   /* The following callback (if not NULL) is invoked on every VDBE branch
3173688852abSdrh   ** operation.  Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
3174688852abSdrh   */
3175688852abSdrh   void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx);  /* Callback */
3176688852abSdrh   void *pVdbeBranchArg;                                     /* 1st argument */
3177688852abSdrh #endif
3178c007f61bSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
3179c007f61bSdrh   int (*xTestCallback)(int);        /* Invoked by sqlite3FaultSim() */
3180c007f61bSdrh #endif
3181c007f61bSdrh   int bLocaltimeFault;              /* True to fail localtime() calls */
318240257ffdSdrh };
318340257ffdSdrh 
318440257ffdSdrh /*
318509fe6143Sdrh ** This macro is used inside of assert() statements to indicate that
318609fe6143Sdrh ** the assert is only valid on a well-formed database.  Instead of:
318709fe6143Sdrh **
318809fe6143Sdrh **     assert( X );
318909fe6143Sdrh **
319009fe6143Sdrh ** One writes:
319109fe6143Sdrh **
3192b2023665Sdrh **     assert( X || CORRUPT_DB );
319309fe6143Sdrh **
3194b2023665Sdrh ** CORRUPT_DB is true during normal operation.  CORRUPT_DB does not indicate
3195b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt.
3196b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special
3197b2023665Sdrh ** sqlite3_test_control().  This enables assert() statements to prove
3198b2023665Sdrh ** things that are always true for well-formed databases.
319909fe6143Sdrh */
3200b2023665Sdrh #define CORRUPT_DB  (sqlite3Config.neverCorrupt==0)
320109fe6143Sdrh 
320209fe6143Sdrh /*
32037d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
32047d10d5a6Sdrh */
32057d10d5a6Sdrh struct Walker {
32069bfb024dSdrh   Parse *pParse;                            /* Parser context.  */
32077d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
32087d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
3209b290f117Sdan   void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
3210030796dfSdrh   int walkerDepth;                          /* Number of subqueries */
3211059b2d50Sdrh   u8 eCode;                                 /* A small processing code */
32127d10d5a6Sdrh   union {                                   /* Extra data for callback */
32137d10d5a6Sdrh     NameContext *pNC;                          /* Naming context */
3214059b2d50Sdrh     int n;                                     /* A counter */
3215059b2d50Sdrh     int iCur;                                  /* A cursor number */
3216374fdce4Sdrh     SrcList *pSrcList;                         /* FROM clause */
3217030796dfSdrh     struct SrcCount *pSrcCount;                /* Counting column references */
32182f2b0278Sdrh     struct CCurHint *pCCurHint;                /* Used by codeCursorHint() */
32192a0b527bSdrh     int *aiCol;                                /* array of column indexes */
32207d10d5a6Sdrh   } u;
32217d10d5a6Sdrh };
32227d10d5a6Sdrh 
32237d10d5a6Sdrh /* Forward declarations */
32247d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
32257d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
32267d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
32277d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
32287d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
32295b88bc4bSdrh int sqlite3ExprWalkNoop(Walker*, Expr*);
32307d10d5a6Sdrh 
32317d10d5a6Sdrh /*
32327d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
32337d10d5a6Sdrh ** callbacks.
32347d10d5a6Sdrh */
32352bf90f1eSdrh #define WRC_Continue    0   /* Continue down into children */
32362bf90f1eSdrh #define WRC_Prune       1   /* Omit children but continue walking siblings */
32372bf90f1eSdrh #define WRC_Abort       2   /* Abandon the tree walk */
32387d10d5a6Sdrh 
32397d10d5a6Sdrh /*
3240eae73fbfSdan ** An instance of this structure represents a set of one or more CTEs
3241c49832c2Sdrh ** (common table expressions) created by a single WITH clause.
32427d562dbeSdan */
32437d562dbeSdan struct With {
3244c49832c2Sdrh   int nCte;                       /* Number of CTEs in the WITH clause */
32454e9119d9Sdan   With *pOuter;                   /* Containing WITH clause, or NULL */
3246c49832c2Sdrh   struct Cte {                    /* For each CTE in the WITH clause.... */
32474e9119d9Sdan     char *zName;                    /* Name of this CTE */
32484e9119d9Sdan     ExprList *pCols;                /* List of explicit column names, or NULL */
3249c49832c2Sdrh     Select *pSelect;                /* The definition of this CTE */
32500576bc59Sdrh     const char *zCteErr;            /* Error message for circular references */
32517d562dbeSdan   } a[1];
32527d562dbeSdan };
32537d562dbeSdan 
32544fa4a54fSdrh #ifdef SQLITE_DEBUG
32554fa4a54fSdrh /*
32564fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of
32574fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view.
32584fa4a54fSdrh */
32594fa4a54fSdrh struct TreeView {
32604fa4a54fSdrh   int iLevel;             /* Which level of the tree we are on */
3261b08cd3f3Sdrh   u8  bLine[100];         /* Draw vertical in column i if bLine[i] is true */
32624fa4a54fSdrh };
32634fa4a54fSdrh #endif /* SQLITE_DEBUG */
32644fa4a54fSdrh 
32657d562dbeSdan /*
326666150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
326766150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
32684a919118Sdrh */
32694a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
32704a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
32714a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
32724a919118Sdrh   }                                                    \
32734a919118Sdrh }
32744a919118Sdrh 
32754a919118Sdrh /*
32769978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with
32779978c97eSdrh ** the same name but without the _BKPT suffix.  These macros invoke
32789978c97eSdrh ** routines that report the line-number on which the error originated
32799978c97eSdrh ** using sqlite3_log().  The routines also provide a convenient place
32809978c97eSdrh ** to set a debugger breakpoint.
328149285708Sdrh */
32829978c97eSdrh int sqlite3CorruptError(int);
32839978c97eSdrh int sqlite3MisuseError(int);
32849978c97eSdrh int sqlite3CantopenError(int);
32859978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
32869978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
32879978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
328832c49904Sdrh #ifdef SQLITE_DEBUG
328932c49904Sdrh   int sqlite3NomemError(int);
329032c49904Sdrh   int sqlite3IoerrnomemError(int);
3291fad3039cSmistachkin # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
3292fad3039cSmistachkin # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
329332c49904Sdrh #else
329432c49904Sdrh # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
329532c49904Sdrh # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
329632c49904Sdrh #endif
32979978c97eSdrh 
32984553f6eaSdrh /*
32994553f6eaSdrh ** FTS3 and FTS4 both require virtual table support
33004553f6eaSdrh */
33014553f6eaSdrh #if defined(SQLITE_OMIT_VIRTUALTABLE)
33024553f6eaSdrh # undef SQLITE_ENABLE_FTS3
33034553f6eaSdrh # undef SQLITE_ENABLE_FTS4
33044553f6eaSdrh #endif
330549285708Sdrh 
330649285708Sdrh /*
3307b4a1fed2Sdrh ** FTS4 is really an extension for FTS3.  It is enabled using the
330860ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro.  But to avoid confusion we also call
330960ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
3310b4a1fed2Sdrh */
3311b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
33120ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1
3313b4a1fed2Sdrh #endif
3314b4a1fed2Sdrh 
3315b4a1fed2Sdrh /*
331679f02cefSdrh ** The ctype.h header is needed for non-ASCII systems.  It is also
331779f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation.
331879f02cefSdrh */
331979f02cefSdrh #if !defined(SQLITE_ASCII) || \
332079f02cefSdrh     (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
332179f02cefSdrh # include <ctype.h>
332279f02cefSdrh #endif
332379f02cefSdrh 
332479f02cefSdrh /*
332578ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(),
332678ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
332778ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale.
332878ca0e7eSdanielk1977 */
332978ca0e7eSdanielk1977 #ifdef SQLITE_ASCII
333078ca0e7eSdanielk1977 # define sqlite3Toupper(x)  ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
333178ca0e7eSdanielk1977 # define sqlite3Isspace(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
3332dc86e2b2Sdrh # define sqlite3Isalnum(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
3333dc86e2b2Sdrh # define sqlite3Isalpha(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
333478ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
333578ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
333678ca0e7eSdanielk1977 # define sqlite3Tolower(x)   (sqlite3UpperToLower[(unsigned char)(x)])
3337244b9d6eSdrh # define sqlite3Isquote(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
333878ca0e7eSdanielk1977 #else
333978ca0e7eSdanielk1977 # define sqlite3Toupper(x)   toupper((unsigned char)(x))
334078ca0e7eSdanielk1977 # define sqlite3Isspace(x)   isspace((unsigned char)(x))
334178ca0e7eSdanielk1977 # define sqlite3Isalnum(x)   isalnum((unsigned char)(x))
3342dc86e2b2Sdrh # define sqlite3Isalpha(x)   isalpha((unsigned char)(x))
334378ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   isdigit((unsigned char)(x))
334478ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  isxdigit((unsigned char)(x))
334578ca0e7eSdanielk1977 # define sqlite3Tolower(x)   tolower((unsigned char)(x))
3346244b9d6eSdrh # define sqlite3Isquote(x)   ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
334778ca0e7eSdanielk1977 #endif
3348f5ed7ad6Sdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
334997348b37Sdrh int sqlite3IsIdChar(u8);
3350f5ed7ad6Sdrh #endif
335178ca0e7eSdanielk1977 
335278ca0e7eSdanielk1977 /*
335375897234Sdrh ** Internal function prototypes
335475897234Sdrh */
335580738d9cSdrh int sqlite3StrICmp(const char*,const char*);
3356ea678832Sdrh int sqlite3Strlen30(const char*);
3357d7564865Sdrh char *sqlite3ColumnType(Column*,char*);
3358ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp
33592e588c75Sdanielk1977 
336040257ffdSdrh int sqlite3MallocInit(void);
3361fec00eabSdrh void sqlite3MallocEnd(void);
3362da4ca9d1Sdrh void *sqlite3Malloc(u64);
3363da4ca9d1Sdrh void *sqlite3MallocZero(u64);
3364da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64);
3365da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64);
3366575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3*, u64);
336717435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
3368da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
3369da4ca9d1Sdrh void *sqlite3Realloc(void*, u64);
3370da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
3371da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64);
3372633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
3373a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
3374633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
3375facf0307Sdrh void *sqlite3ScratchMalloc(int);
3376facf0307Sdrh void sqlite3ScratchFree(void*);
3377facf0307Sdrh void *sqlite3PageMalloc(int);
3378facf0307Sdrh void sqlite3PageFree(void*);
3379fec00eabSdrh void sqlite3MemSetDefault(void);
3380f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
3381171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
3382f5ed7ad6Sdrh #endif
338350d1b5f3Sdrh int sqlite3HeapNearlyFull(void);
33842e588c75Sdanielk1977 
3385e7b34707Sdrh /*
3386e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make
3387e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects.  By default,
3388e7b34707Sdrh ** obtain space from malloc().
3389e7b34707Sdrh **
3390e7b34707Sdrh ** The alloca() routine never returns NULL.  This will cause code paths
3391e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable.
3392e7b34707Sdrh */
3393e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA
3394e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   alloca(N)
3395e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  memset(alloca(N), 0, N)
3396e7b34707Sdrh # define sqlite3StackFree(D,P)
3397e7b34707Sdrh #else
3398e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   sqlite3DbMallocRaw(D,N)
3399e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  sqlite3DbMallocZero(D,N)
3400e7b34707Sdrh # define sqlite3StackFree(D,P)       sqlite3DbFree(D,P)
3401e7b34707Sdrh #endif
3402e7b34707Sdrh 
3403f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS3
3404f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
3405f3d3c27aSdanielk1977 #endif
3406f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5
3407f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
3408f3d3c27aSdanielk1977 #endif
3409f3d3c27aSdanielk1977 
3410f3d3c27aSdanielk1977 
341118472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT
3412558814f8Sdan   sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
3413558814f8Sdan   sqlite3_mutex_methods const *sqlite3NoopMutex(void);
341459f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
3415d025174fSdanielk1977   int sqlite3MutexInit(void);
3416d025174fSdanielk1977   int sqlite3MutexEnd(void);
341765bbf29eSdrh #endif
34180e8729dbSdrh #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
34196081c1dbSdrh   void sqlite3MemoryBarrier(void);
34200e8729dbSdrh #else
342104abf087Smistachkin # define sqlite3MemoryBarrier()
3422f7141990Sdrh #endif
3423f7141990Sdrh 
3424af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int);
3425af89fe66Sdrh void sqlite3StatusUp(int, int);
3426af89fe66Sdrh void sqlite3StatusDown(int, int);
3427b02392e6Sdrh void sqlite3StatusHighwater(int, int);
3428f7141990Sdrh 
3429af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */
3430af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void);
3431af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void);
3432af89fe66Sdrh 
343385c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
34340de3ae95Sdrh   int sqlite3IsNaN(double);
343585c8f291Sdrh #else
343685c8f291Sdrh # define sqlite3IsNaN(X)  0
343785c8f291Sdrh #endif
34380de3ae95Sdrh 
3439a5c1416dSdrh /*
3440a5c1416dSdrh ** An instance of the following structure holds information about SQL
3441a5c1416dSdrh ** functions arguments that are the parameters to the printf() function.
3442a5c1416dSdrh */
3443a5c1416dSdrh struct PrintfArguments {
3444a5c1416dSdrh   int nArg;                /* Total number of arguments */
3445a5c1416dSdrh   int nUsed;               /* Number of arguments used so far */
3446a5c1416dSdrh   sqlite3_value **apArg;   /* The argument values */
3447a5c1416dSdrh };
3448a5c1416dSdrh 
34495f4a686fSdrh void sqlite3VXPrintf(StrAccum*, const char*, va_list);
34505f4a686fSdrh void sqlite3XPrintf(StrAccum*, const char*, ...);
345117435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
345217435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
345302b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
3454e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
3455d919fe17Sdrh #endif
3456d919fe17Sdrh #if defined(SQLITE_TEST)
3457e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
345887cc3b31Sdrh #endif
34597e02e5e6Sdrh 
34604fa4a54fSdrh #if defined(SQLITE_DEBUG)
34614fa4a54fSdrh   void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
34624fa4a54fSdrh   void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
34634fa4a54fSdrh   void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
34642476a6f2Sdrh   void sqlite3TreeViewWith(TreeView*, const With*, u8);
34657e02e5e6Sdrh #endif
34667e02e5e6Sdrh 
34677e02e5e6Sdrh 
346822c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*);
34694adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
3470244b9d6eSdrh void sqlite3Dequote(char*);
347140aced5cSdrh void sqlite3TokenInit(Token*,char*);
34722646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
34734adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
347480242055Sdrh void sqlite3FinishCoding(Parse*);
3475892d3179Sdrh int sqlite3GetTempReg(Parse*);
3476892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
3477892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
3478892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
3479cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*);
3480bb9b5f26Sdrh #ifdef SQLITE_DEBUG
3481bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse*,int,int);
3482bb9b5f26Sdrh #endif
3483b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
3484b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*);
3485b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
348617435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
348708de4f79Sdrh void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
34881e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
348917435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
3490fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
3491633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
3492b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
3493bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList*,int);
3494b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
3495b7916a78Sdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
3496633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
34972308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*);
34989bb575fdSdrh int sqlite3Init(sqlite3*, char**);
3499234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
350091cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
350181028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*);
350281028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int);
350381028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*);
35049bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
350551be3873Sdrh void sqlite3DeleteColumnNames(sqlite3*,Table*);
35068981b904Sdrh int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
3507ed06a131Sdrh void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*);
35087d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
3509c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
35104415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*);
35114415628aSdrh i16 sqlite3ColumnOfIndex(Index*, i16);
3512f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
3513e6110505Sdrh #if SQLITE_ENABLE_HIDDEN_COLUMNS
3514ba68f8f3Sdan   void sqlite3ColumnPropertiesFromName(Table*, Column*);
3515e6110505Sdrh #else
3516e6110505Sdrh # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
3517e6110505Sdrh #endif
35182881ab62Sdrh void sqlite3AddColumn(Parse*,Token*,Token*);
35194adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
3520fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
3521ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
3522b7916a78Sdrh void sqlite3AddDefaultValue(Parse*,ExprSpan*);
352339002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
35245969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
3525522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*,
3526522c26fbSdrh                     sqlite3_vfs**,char**,char **);
3527421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
35281d8cb21fSdan int sqlite3CodeOnce(Parse *);
3529b7f9164eSdrh 
3530c007f61bSdrh #ifdef SQLITE_OMIT_BUILTIN_TEST
3531c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK
3532c007f61bSdrh #else
3533c007f61bSdrh   int sqlite3FaultSim(int);
3534c007f61bSdrh #endif
3535c007f61bSdrh 
3536f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
3537f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
353882ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32);
3539f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
3540e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*);
3541f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
3542bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*);
3543f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
35443088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
3545f5ed7ad6Sdrh #endif
3546f5e7bb51Sdrh 
35473d4501e5Sdrh RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
35483d4501e5Sdrh void sqlite3RowSetClear(RowSet*);
35493d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64);
3550d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64);
35513d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*);
35523d4501e5Sdrh 
35538981b904Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
3554fe3fcbe2Sdanielk1977 
3555fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
35564adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
3557b7f9164eSdrh #else
3558b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
3559b7f9164eSdrh #endif
3560b7f9164eSdrh 
3561a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30
3562a7ab6d81Sdrh   int sqlite3DbMaskAllZero(yDbMask);
3563a7ab6d81Sdrh #endif
3564a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
3565faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int);
35661feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*);
35670b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT
35680b9f50d8Sdrh   void sqlite3AutoincrementBegin(Parse *pParse);
35690b9f50d8Sdrh   void sqlite3AutoincrementEnd(Parse *pParse);
35700b9f50d8Sdrh #else
35710b9f50d8Sdrh # define sqlite3AutoincrementBegin(X)
35720b9f50d8Sdrh # define sqlite3AutoincrementEnd(X)
35730b9f50d8Sdrh #endif
357475593d96Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int);
35756c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
357617435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
35774adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
3578a78c22c4Sdrh SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
357917435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
3580b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
358185574e31Sdanielk1977                                       Token*, Select*, Expr*, IdList*);
3582b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
358301d230ceSdrh void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
3584b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
358561dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
35864adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
3587633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
3588633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
3589bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
35901da40a38Sdan Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
35918a9789b6Sdrh                           Expr*, int, int);
35924d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
35937d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
359417435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
3595c3489bbfSdrh                          Expr*,ExprList*,u32,Expr*,Expr*);
3596633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
35974adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
35984adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
3599c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
3600273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
360149ffdbf4Sshane Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*);
36024281bd42Sshane #endif
36034adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
36044adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
360546ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
36064adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
3607c3489bbfSdrh LogEst sqlite3WhereOutputRowCount(WhereInfo*);
36086f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*);
36096f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*);
3610374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*);
36116f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*);
36126f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*);
3613fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*);
3614b0264eecSdrh #define ONEPASS_OFF      0        /* Use of ONEPASS not allowed */
3615b0264eecSdrh #define ONEPASS_SINGLE   1        /* ONEPASS valid for a single row update */
3616b0264eecSdrh #define ONEPASS_MULTI    2        /* ONEPASS is valid for multiple rows */
36171f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
3618a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
3619ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(Parse*, Table*, int, int, int);
36205c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
3621b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
3622ceea3321Sdrh void sqlite3ExprCacheStore(Parse*, int, int, int);
3623ceea3321Sdrh void sqlite3ExprCachePush(Parse*);
3624d2490904Sdrh void sqlite3ExprCachePop(Parse*);
3625f49f3523Sdrh void sqlite3ExprCacheRemove(Parse*, int, int);
3626ceea3321Sdrh void sqlite3ExprCacheClear(Parse*);
3627da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
362805a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int);
36291c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse*, Expr*, int);
363005a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
3631d673cddaSdrh void sqlite3ExprCodeAtInit(Parse*, Expr*, int, u8);
36322dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
3633678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
363405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
36355579d59fSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
3636d1a01edaSdrh #define SQLITE_ECEL_DUP      0x01  /* Deep, not shallow copies */
3637d1a01edaSdrh #define SQLITE_ECEL_FACTOR   0x02  /* Factor out constant terms */
36385579d59fSdrh #define SQLITE_ECEL_REF      0x04  /* Use ExprList.u.x.iOrderByCol */
36394adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
36404adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
364172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
36429bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
3643ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
364441fb5cd1Sdan Table *sqlite3LocateTableItem(Parse*,int isView,struct SrcList_item *);
36459bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
36469bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
36479bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
364874161705Sdrh void sqlite3Vacuum(Parse*);
36499bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
365017435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
3651619a1305Sdrh int sqlite3ExprCompare(Expr*, Expr*, int);
3652619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int);
36534bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr*, Expr*, int);
3654d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
3655d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
3656030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
36574adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
3658f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
36592fa1868fSdrh void sqlite3PrngSaveState(void);
36602fa1868fSdrh void sqlite3PrngRestoreState(void);
3661f5ed7ad6Sdrh #endif
36620f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int);
36634adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
366457966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
3665684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
36664adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
36674adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
3668fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*);
3669fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *);
36704245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
36714adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
36720a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
3673feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8);
3674059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int);
3675ffc648cfSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
36765b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr*);
3677ffc648cfSdrh #endif
36784adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
3679039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*);
3680039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
36814adee20fSdanielk1977 int sqlite3IsRowid(const char*);
3682f0ee1d3cSdan void sqlite3GenerateRowDelete(
3683f0ee1d3cSdan     Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
3684f0ee1d3cSdan void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
36851c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
368687744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int);
3687f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
3688bdb00225Sdrh                                      u8,u8,int,int*,int*);
368926198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
3690fd261ec6Sdan int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
36914adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
3692ff738bceSdrh void sqlite3MultiWrite(Parse*);
3693e0af83acSdan void sqlite3MayAbort(Parse*);
3694f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
3695f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*);
3696f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*);
36976ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
36986ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
36996ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
370017435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
37016ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int);
3702eb9b884cSdrh #if SELECTTRACE_ENABLED
3703eb9b884cSdrh void sqlite3SelectSetName(Select*,const char*);
3704eb9b884cSdrh #else
3705eb9b884cSdrh # define sqlite3SelectSetName(A,B)
3706eb9b884cSdrh #endif
370780738d9cSdrh void sqlite3InsertBuiltinFuncs(FuncDef*,int);
370880738d9cSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
370980738d9cSdrh void sqlite3RegisterBuiltinFunctions(void);
3710777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
371180738d9cSdrh void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
37127e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
37137e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
37149cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
3715fa4e62f3Sshane 
3716fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
37172a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
3718fa4e62f3Sshane #endif
3719b7f9164eSdrh 
3720b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
3721ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
372260218d2aSdrh                            Expr*,int, int);
37234adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
3724fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
372574161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
37262f886d1dSdanielk1977   Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
37272f886d1dSdanielk1977   Trigger *sqlite3TriggerList(Parse *, Table *);
3728165921a7Sdan   void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
372994d7f50aSdan                             int, int, int);
37301da40a38Sdan   void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
3731dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
3732633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
373317435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
373417435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
373575593d96Sdrh                                         Select*,u8);
37365eff7cf0Sshane   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
373717435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
3738633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
3739b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
3740bb5f168fSdan   u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
374165a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
3742c149f18fSdrh # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
3743b7f9164eSdrh #else
374462c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0
3745633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
3746cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
3747b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
374894d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
374975cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
37502943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0
375165a7cd16Sdan # define sqlite3ParseToplevel(p) p
3752c149f18fSdrh # define sqlite3IsToplevel(p) 1
3753bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
3754b7f9164eSdrh #endif
3755b7f9164eSdrh 
37564adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
37570202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
37584adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
3759ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
3760728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
37614adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
37624adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
37634adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
376402470b20Sdan   int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
3765ed6c8671Sdrh #else
3766b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
37674adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
37684adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
37694adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
3770ed6c8671Sdrh #endif
3771f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
3772f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
3773d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
37744adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
37754adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
37764adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
37774adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
37784adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
37799339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8);
3780fec19aadSdrh int sqlite3GetInt32(const char *, int*);
378160ac3f42Sdrh int sqlite3Atoi(const char*);
3782ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
3783ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
378442610961Sdrh u32 sqlite3Utf8Read(const u8**);
3785bf539c4dSdrh LogEst sqlite3LogEst(u64);
3786bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst);
3787bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3788bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double);
3789bf539c4dSdrh #endif
379014bfd991Sdrh #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
3791d566c951Sdrh     defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
3792d566c951Sdrh     defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
3793bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst);
3794d566c951Sdrh #endif
37953f8d5cfcSshane 
37963f8d5cfcSshane /*
37973f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
37983f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
37992f2b2b85Sdrh ** file.
38003f8d5cfcSshane */
3801192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
38021bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *);
38031bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *);
3804192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
38053f8d5cfcSshane 
38063f8d5cfcSshane /*
38072f2b2b85Sdrh ** The common case is for a varint to be a single byte.  They following
38082f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call
38092f2b2b85Sdrh ** the procedure for larger varints.
38103f8d5cfcSshane */
38114bde3702Sdrh #define getVarint32(A,B)  \
38124bde3702Sdrh   (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
38134bde3702Sdrh #define putVarint32(A,B)  \
38144bde3702Sdrh   (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
38152f2b2b85Sdrh   sqlite3PutVarint((A),(B)))
38163f8d5cfcSshane #define getVarint    sqlite3GetVarint
38173f8d5cfcSshane #define putVarint    sqlite3PutVarint
38183f8d5cfcSshane 
38193f8d5cfcSshane 
3820e9107698Sdrh const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
382157bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int);
3822e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
3823e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
3824bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
38259339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8);
38269296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*);
382713f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
382813f40da3Sdrh void sqlite3Error(sqlite3*,int);
38291b9f2141Sdrh void sqlite3SystemError(sqlite3*,int);
3830ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
3831cd74b611Sdan u8 sqlite3HexToInt(int h);
3832ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
3833dd08ca0fSmistachkin 
38345824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME)
3835f2c1c99fSmistachkin const char *sqlite3ErrName(int);
3836dd08ca0fSmistachkin #endif
3837dd08ca0fSmistachkin 
3838f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
38398a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
3840c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
3841c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
38427cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
384380103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
38440a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
38450a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*);
38467cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
3847d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
3848b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
3849158b9cb9Sdrh int sqlite3AddInt64(i64*,i64);
3850158b9cb9Sdrh int sqlite3SubInt64(i64*,i64);
3851158b9cb9Sdrh int sqlite3MulInt64(i64*,i64);
3852d50ffc41Sdrh int sqlite3AbsInt32(int);
385381cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES
385481cc5163Sdrh void sqlite3FileSuffix3(const char*, char*);
385581cc5163Sdrh #else
385681cc5163Sdrh # define sqlite3FileSuffix3(X,Y)
385781cc5163Sdrh #endif
3858eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8);
38594e6af134Sdanielk1977 
3860b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
3861b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
3862b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
38631e536953Sdanielk1977                         void(*)(void*));
3864a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*);
38654e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
38661e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
3867b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
38681e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
3869b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
387046c99e0fSdrh #ifndef SQLITE_AMALGAMATION
3871a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[];
3872f19aa5faSdrh extern const char sqlite3StrBINARY[];
38734e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
387478ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[];
3875094430ebSdrh extern const Token sqlite3IntTokens[];
3876075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
387780738d9cSdrh extern FuncDefHash sqlite3BuiltinFunctions;
3878f83dc1efSdrh #ifndef SQLITE_OMIT_WSD
3879ddb68e17Sdrh extern int sqlite3PendingByte;
388046c99e0fSdrh #endif
3881f83dc1efSdrh #endif
3882cdf011dcSdrh void sqlite3RootPageMoved(sqlite3*, int, int, int);
38834343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
3884545f587fSdrh void sqlite3AlterFunctions(void);
38859fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
38869fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
38872958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
3888d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
38891450bc6eSdrh int sqlite3CodeSubselect(Parse *, Expr *, int, int);
38907d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
3891923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
38923e3f1a5bSdrh int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
38937d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
389401d230ceSdrh int sqlite3ResolveExprListNames(NameContext*, ExprList*);
38957d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
38963780be11Sdrh void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
38977d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
3898c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
389919a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
390019a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
390179e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
3902fdaac671Sdrh char sqlite3AffinityType(const char*, u8*);
39039f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
3904a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
3905ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
39060410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *);
3907cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
3908d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*);
390951147baaSdrh void sqlite3DefaultRowEst(Index*);
391055ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
3911d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
3912b6ee6607Sdrh void sqlite3SchemaClear(void *);
39131e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
3914e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
3915ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
39162ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*);
39172ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
39182ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
39192ec2fb22Sdrh #ifdef SQLITE_DEBUG
39202ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*);
39212ec2fb22Sdrh #endif
3922771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
3923771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
3924d2199f0fSdan   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
3925d2199f0fSdan   FuncDestructor *pDestructor
3926d2199f0fSdan );
39274a642b60Sdrh void sqlite3OomFault(sqlite3*);
39284a642b60Sdrh void sqlite3OomClear(sqlite3*);
392954f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
3930ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
393169dab1d3Sdrh 
3932c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
3933ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
3934a6353a3fSdrh void sqlite3StrAccumAppendAll(StrAccum*,const char*);
3935af8f513fSdrh void sqlite3AppendChar(StrAccum*,int,char);
3936ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
3937ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
39381013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
3939f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
39401e536953Sdanielk1977 
39410410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *);
39420410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
39430410302eSdanielk1977 
39441435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
39459fecc546Sdrh void sqlite3AnalyzeFunctions(void);
394687cd9321Sdan int sqlite3Stat4ProbeSetValue(Parse*,Index*,UnpackedRecord**,Expr*,u8,int,int*);
3947b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
39487a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*);
3949b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
39509fecc546Sdrh #endif
39517a419235Sdan 
395295bdbbbdSdrh /*
395395bdbbbdSdrh ** The interface to the LEMON-generated parser
395495bdbbbdSdrh */
3955fb046e76Sdrh void *sqlite3ParserAlloc(void*(*)(u64));
395695bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
395795bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
3958ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
3959ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
3960ec424a5bSdrh #endif
396195bdbbbdSdrh 
39627aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*);
396369dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
3964f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
396569dab1d3Sdrh #else
396669dab1d3Sdrh # define sqlite3CloseExtensions(X)
396769dab1d3Sdrh #endif
3968e3026636Sdanielk1977 
3969c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
3970c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
3971c00da105Sdanielk1977 #else
3972c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
3973c00da105Sdanielk1977 #endif
3974c00da105Sdanielk1977 
397553c14021Sdrh #ifdef SQLITE_TEST
397653c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
397753c14021Sdrh #endif
397853c14021Sdrh 
3979b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
3980595a523aSdanielk1977 #  define sqlite3VtabClear(Y)
39819dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
3982f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
3983f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
3984093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) 0
3985595a523aSdanielk1977 #  define sqlite3VtabLock(X)
3986595a523aSdanielk1977 #  define sqlite3VtabUnlock(X)
3987595a523aSdanielk1977 #  define sqlite3VtabUnlockList(X)
3988a311b803Sdan #  define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
3989c3c8dac7Sdrh #  define sqlite3GetVTable(X,Y)  ((VTable*)0)
3990b9bb7c18Sdrh #else
39911feeaed2Sdan    void sqlite3VtabClear(sqlite3 *db, Table*);
3992bba02a95Sdan    void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
3993016f7811Sdan    int sqlite3VtabSync(sqlite3 *db, Vdbe*);
3994f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
3995f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
3996595a523aSdanielk1977    void sqlite3VtabLock(VTable *);
3997595a523aSdanielk1977    void sqlite3VtabUnlock(VTable *);
3998595a523aSdanielk1977    void sqlite3VtabUnlockList(sqlite3*);
3999a311b803Sdan    int sqlite3VtabSavepoint(sqlite3 *, int, int);
4000016f7811Sdan    void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
4001c3c8dac7Sdrh    VTable *sqlite3GetVTable(sqlite3*, Table*);
4002093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
4003b9bb7c18Sdrh #endif
400451be3873Sdrh int sqlite3VtabEponymousTableInit(Parse*,Module*);
400551be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
40064f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
4007b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
4008b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
4009b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
4010b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
401178efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
40127e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
40139e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
4014595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *);
40151e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
4016b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
401795a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
40185f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
40194a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
4020f30a969bSdrh void sqlite3ParserReset(Parse*);
4021b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
4022b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
4023bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
40241c514148Sdrh int sqlite3TempInMemory(const sqlite3*);
402528e5386fSdan const char *sqlite3JournalModename(int);
402606a2d825Sdan #ifndef SQLITE_OMIT_WAL
4027cdc1f049Sdan   int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
4028b033d8b9Sdrh   int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
402906a2d825Sdan #endif
40308b471863Sdrh #ifndef SQLITE_OMIT_CTE
40314e9119d9Sdan   With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
40327d562dbeSdan   void sqlite3WithDelete(sqlite3*,With*);
4033b290f117Sdan   void sqlite3WithPush(Parse*, With*, u8);
40344e9119d9Sdan #else
4035b290f117Sdan #define sqlite3WithPush(x,y,z)
4036eede6a53Sdan #define sqlite3WithDelete(x,y)
40378b471863Sdrh #endif
4038d829335eSdanielk1977 
403975cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by
404075cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
404175cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but
404275cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
404375cbd984Sdan ** this case foreign keys are parsed, but no other functionality is
404475cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system).
404575cbd984Sdan */
404675cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
40478ff2d956Sdan   void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
4048d66c8309Sdan   void sqlite3FkDropTable(Parse*, SrcList *, Table*);
40498ff2d956Sdan   void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
4050e7a94d81Sdan   int sqlite3FkRequired(Parse*, Table*, int*, int);
4051e7a94d81Sdan   u32 sqlite3FkOldmask(Parse*, Table*);
4052432cc5b9Sdan   FKey *sqlite3FkReferences(Table *);
40531da40a38Sdan #else
40548ff2d956Sdan   #define sqlite3FkActions(a,b,c,d,e,f)
405567896cefSdan   #define sqlite3FkCheck(a,b,c,d,e,f)
4056d66c8309Sdan   #define sqlite3FkDropTable(a,b,c)
4057e7a94d81Sdan   #define sqlite3FkOldmask(a,b)         0
405867896cefSdan   #define sqlite3FkRequired(a,b,c,d)    0
40591da40a38Sdan #endif
406075cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY
40611feeaed2Sdan   void sqlite3FkDelete(sqlite3 *, Table*);
40626c5b915fSdrh   int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
406375cbd984Sdan #else
40641feeaed2Sdan   #define sqlite3FkDelete(a,b)
40656c5b915fSdrh   #define sqlite3FkLocateIndex(a,b,c,d,e)
406675cbd984Sdan #endif
406775cbd984Sdan 
4068643167ffSdrh 
4069643167ffSdrh /*
4070643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
4071643167ffSdrh */
4072643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
40737e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
4074643167ffSdrh 
4075643167ffSdrh /*
4076ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
4077ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
4078ef05f2dfSdanielk1977 ** is not defined.
4079643167ffSdrh */
40803088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
40812d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
40822d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
4083643167ffSdrh #else
40842d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
4085867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
4086643167ffSdrh #endif
4087643167ffSdrh 
40883a85625dSdrh /*
40893a85625dSdrh ** Allowed return values from sqlite3FindInIndex()
40903a85625dSdrh */
40913a85625dSdrh #define IN_INDEX_ROWID        1   /* Search the rowid of the table */
40923a85625dSdrh #define IN_INDEX_EPH          2   /* Search an ephemeral b-tree */
40933a85625dSdrh #define IN_INDEX_INDEX_ASC    3   /* Existing index ASCENDING */
40943a85625dSdrh #define IN_INDEX_INDEX_DESC   4   /* Existing index DESCENDING */
4095bb53ecb1Sdrh #define IN_INDEX_NOOP         5   /* No table available. Use comparisons */
40963a85625dSdrh /*
40973a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
40983a85625dSdrh */
4099bb53ecb1Sdrh #define IN_INDEX_NOOP_OK     0x0001  /* OK to return IN_INDEX_NOOP */
4100bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP  0x0002  /* IN operator used for membership test */
4101bb53ecb1Sdrh #define IN_INDEX_LOOP        0x0004  /* IN operator used as a loop */
41023a85625dSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*);
41039a96b668Sdanielk1977 
4104c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
4105c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *);
4106ff6b8266Sdrh #ifdef SQLITE_ENABLE_ATOMIC_WRITE
4107f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
4108c7b6017cSdanielk1977 #endif
4109c7b6017cSdanielk1977 
41102491de28Sdan int sqlite3JournalIsInMemory(sqlite3_file *p);
4111b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *);
4112b3175389Sdanielk1977 
41132308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
41140224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
4115fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
41167d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
4117fc976065Sdanielk1977 #else
41180224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
41197d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
4120fc976065Sdanielk1977 #endif
4121fc976065Sdanielk1977 
4122a3152895Sdrh u32 sqlite3Get4byte(const u8*);
4123a3152895Sdrh void sqlite3Put4byte(u8*, u32);
4124a3152895Sdrh 
4125404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
4126404ca075Sdanielk1977   void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
4127404ca075Sdanielk1977   void sqlite3ConnectionUnlocked(sqlite3 *db);
4128404ca075Sdanielk1977   void sqlite3ConnectionClosed(sqlite3 *db);
4129404ca075Sdanielk1977 #else
4130404ca075Sdanielk1977   #define sqlite3ConnectionBlocked(x,y)
4131404ca075Sdanielk1977   #define sqlite3ConnectionUnlocked(x)
4132404ca075Sdanielk1977   #define sqlite3ConnectionClosed(x)
4133404ca075Sdanielk1977 #endif
4134404ca075Sdanielk1977 
41356e736838Sdrh #ifdef SQLITE_DEBUG
41366e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
41376e736838Sdrh #endif
41386e736838Sdrh 
4139b0603416Sdrh /*
4140b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
41413a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
4142b0603416Sdrh ** print I/O tracing messages.
4143b0603416Sdrh */
4144b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
41453a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
4146b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
41479871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
4148b0603416Sdrh #else
4149b0603416Sdrh # define IOTRACE(A)
4150b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
4151b0603416Sdrh #endif
4152b0603416Sdrh 
4153107b56e8Sdrh /*
4154107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator
4155107b56e8Sdrh ** only.  They are used to verify that different "types" of memory
4156107b56e8Sdrh ** allocations are properly tracked by the system.
4157107b56e8Sdrh **
4158107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
4159107b56e8Sdrh ** the MEMTYPE_* macros defined below.  The type must be a bitmask with
4160107b56e8Sdrh ** a single bit set.
4161107b56e8Sdrh **
4162107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second
4163107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
4164107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
4165107b56e8Sdrh **
4166174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second
4167174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
4168107b56e8Sdrh **
4169107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP
4170174b9a16Sdrh ** and MEMTYPE_LOOKASIDE.  If an allocation is MEMTYPE_LOOKASIDE, that means
4171174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was
4172174b9a16Sdrh ** too large or lookaside was already full.  It is important to verify
4173174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not
4174174b9a16Sdrh ** passed back to non-lookaside free() routines.  Asserts such as the
4175174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify
4176174b9a16Sdrh ** this constraint.
4177107b56e8Sdrh **
4178107b56e8Sdrh ** All of this is no-op for a production build.  It only comes into
4179107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used.
4180107b56e8Sdrh */
4181107b56e8Sdrh #ifdef SQLITE_MEMDEBUG
4182107b56e8Sdrh   void sqlite3MemdebugSetType(void*,u8);
4183107b56e8Sdrh   int sqlite3MemdebugHasType(void*,u8);
4184174b9a16Sdrh   int sqlite3MemdebugNoType(void*,u8);
4185107b56e8Sdrh #else
4186107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y)  /* no-op */
4187107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y)  1
4188174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y)   1
4189e3026636Sdanielk1977 #endif
4190107b56e8Sdrh #define MEMTYPE_HEAP       0x01  /* General heap allocations */
4191d231aa3aSdrh #define MEMTYPE_LOOKASIDE  0x02  /* Heap that might have been lookaside */
4192107b56e8Sdrh #define MEMTYPE_SCRATCH    0x04  /* Scratch allocations */
4193107b56e8Sdrh #define MEMTYPE_PCACHE     0x08  /* Page cache allocations */
4194107b56e8Sdrh 
4195f51446a3Sdrh /*
4196f51446a3Sdrh ** Threading interface
4197f51446a3Sdrh */
4198bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0
4199f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
4200f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**);
4201bf20a35dSdrh #endif
4202f51446a3Sdrh 
42033e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
42043e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*);
42053e0327d5Sdrh #endif
42063e0327d5Sdrh 
4207107b56e8Sdrh #endif /* _SQLITEINT_H_ */
4208