xref: /sqlite-3.40.0/src/sqliteInt.h (revision 60e08078)
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 /*
192318d338Smistachkin ** Include the header file used to customize the compiler options for MSVC.
202318d338Smistachkin ** This should be done first so that it can successfully prevent spurious
212318d338Smistachkin ** compiler warnings due to subsequent content in this file and other files
222318d338Smistachkin ** that are included by this file.
232318d338Smistachkin */
242318d338Smistachkin #include "msvc.h"
252318d338Smistachkin 
262318d338Smistachkin /*
278cd5b254Sdrh ** Special setup for VxWorks
288cd5b254Sdrh */
298cd5b254Sdrh #include "vxworks.h"
308cd5b254Sdrh 
318cd5b254Sdrh /*
322210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the
332210dcc6Sdrh ** underlying operating system supports it.  If the OS lacks
342210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops.
352210dcc6Sdrh **
362210dcc6Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
372210dcc6Sdrh ** system #includes.  Hence, this block of code must be the very first
382210dcc6Sdrh ** code in all source files.
392210dcc6Sdrh **
402210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
412210dcc6Sdrh ** on the compiler command line.  This is necessary if you are compiling
422210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
432210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
442210dcc6Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
452210dcc6Sdrh ** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
462210dcc6Sdrh ** portability you should omit LFS.
472210dcc6Sdrh **
48dddf6978Sdrh ** The previous paragraph was written in 2005.  (This paragraph is written
49dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so
50dddf6978Sdrh ** you should probably leave LFS enabled.  But some embedded platforms might
51dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
52dddf6978Sdrh **
532210dcc6Sdrh ** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
542210dcc6Sdrh */
552210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS
562210dcc6Sdrh # define _LARGE_FILE       1
572210dcc6Sdrh # ifndef _FILE_OFFSET_BITS
582210dcc6Sdrh #   define _FILE_OFFSET_BITS 64
592210dcc6Sdrh # endif
602210dcc6Sdrh # define _LARGEFILE_SOURCE 1
612210dcc6Sdrh #endif
622210dcc6Sdrh 
63ad265296Sdrh /* What version of GCC is being used.  0 means GCC is not being used */
64ad265296Sdrh #ifdef __GNUC__
65ad265296Sdrh # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
66ad265296Sdrh #else
67ad265296Sdrh # define GCC_VERSION 0
68ad265296Sdrh #endif
69ad265296Sdrh 
7033ac4c8bSmistachkin /* Needed for various definitions... */
7133ac4c8bSmistachkin #if defined(__GNUC__) && !defined(_GNU_SOURCE)
7233ac4c8bSmistachkin # define _GNU_SOURCE
7333ac4c8bSmistachkin #endif
7433ac4c8bSmistachkin 
7533ac4c8bSmistachkin #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
7633ac4c8bSmistachkin # define _BSD_SOURCE
7733ac4c8bSmistachkin #endif
7833ac4c8bSmistachkin 
792210dcc6Sdrh /*
80a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its
81a7b3b635Smistachkin ** version information, among other things.  Normally, this internal MinGW
82a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header
83a7b3b635Smistachkin ** files; however, the contained version information is now required by this
84a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and
85a7b3b635Smistachkin ** this is the only known way to reliably obtain it.  This entire #if block
86a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting
87a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define
88a7b3b635Smistachkin ** some MinGW-specific macros).  When compiling for MinGW, either the
89a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
90a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be
91a7b3b635Smistachkin ** disabled.
92a7b3b635Smistachkin */
93a7b3b635Smistachkin #if defined(_HAVE_MINGW_H)
94a7b3b635Smistachkin # include "mingw.h"
95a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H)
96a7b3b635Smistachkin # include "_mingw.h"
97a7b3b635Smistachkin #endif
98a7b3b635Smistachkin 
99a7b3b635Smistachkin /*
100a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
101a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime
102a7b3b635Smistachkin ** library in use (e.g. for Windows XP).
103a7b3b635Smistachkin */
104a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
105a7b3b635Smistachkin     defined(_WIN32) && !defined(_WIN64) && \
10665acf373Smistachkin     defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
107a7b3b635Smistachkin     defined(__MSVCRT__)
108a7b3b635Smistachkin # define _USE_32BIT_TIME_T
109a7b3b635Smistachkin #endif
110a7b3b635Smistachkin 
1115e990beaSdrh /* The public SQLite interface.  The _FILE_OFFSET_BITS macro must appear
1120d71d121Smistachkin ** first in QNX.  Also, the _USE_32BIT_TIME_T macro must appear first for
1130d71d121Smistachkin ** MinGW.
1145e990beaSdrh */
1155e990beaSdrh #include "sqlite3.h"
1165e990beaSdrh 
117bd0ae111Smlcreech /*
1181e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
1191e12d43bSmlcreech ** autoconf-based build
120bd0ae111Smlcreech */
1211e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H
12298dc4b1aSmlcreech #include "config.h"
1231e12d43bSmlcreech #endif
1241e12d43bSmlcreech 
125bb4957f8Sdrh #include "sqliteLimit.h"
12698dc4b1aSmlcreech 
127e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
128e2965827Sdrh #if defined(__BORLANDC__)
129e2965827Sdrh #pragma warn -rch /* unreachable code */
130e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
131e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
132e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
133467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */
134e2965827Sdrh #endif
135e2965827Sdrh 
13698dc4b1aSmlcreech /*
13706af763eSdrh ** Include standard header files as necessary
13806af763eSdrh */
13906af763eSdrh #ifdef HAVE_STDINT_H
14006af763eSdrh #include <stdint.h>
14106af763eSdrh #endif
14206af763eSdrh #ifdef HAVE_INTTYPES_H
14306af763eSdrh #include <inttypes.h>
14406af763eSdrh #endif
14506af763eSdrh 
146a2460e07Sdrh /*
147c05a9a8aSdrh ** The following macros are used to cast pointers to integers and
148c05a9a8aSdrh ** integers to pointers.  The way you do this varies from one compiler
149c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements
150c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers.
151875e9e7dSdrh **
152c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type.
153c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or
154c05a9a8aSdrh ** if it is available, it requires an #include of specific headers
155c92271c5Sdrh ** that vary from one machine to the next.
156875e9e7dSdrh **
157875e9e7dSdrh ** Ticket #3860:  The llvm-gcc-4.2 compiler from Apple chokes on
158875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct.  But MSVC chokes on ((void*)(X)).
1595e49edcaSdrh ** So we have to define the macros in different ways depending on the
160875e9e7dSdrh ** compiler.
1611fc4129dSshane */
162c05a9a8aSdrh #if defined(__PTRDIFF_TYPE__)  /* This case should work for GCC */
163c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(__PTRDIFF_TYPE__)(X))
164c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(__PTRDIFF_TYPE__)(X))
165c05a9a8aSdrh #elif !defined(__GNUC__)       /* Works for compilers other than LLVM */
166c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)&((char*)0)[X])
167c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(((char*)X)-(char*)0))
168c05a9a8aSdrh #elif defined(HAVE_STDINT_H)   /* Use this case if we have ANSI headers */
169367882c2Sdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(intptr_t)(X))
170367882c2Sdrh # define SQLITE_PTR_TO_INT(X)  ((int)(intptr_t)(X))
171c05a9a8aSdrh #else                          /* Generates a warning - but it always works */
172875e9e7dSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(X))
173875e9e7dSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(X))
174367882c2Sdrh #endif
17571674ce9Sdrh 
176e5e7a901Sdrh /*
17714a924a5Sdrh ** A macro to hint to the compiler that a function should not be
17814a924a5Sdrh ** inlined.
17914a924a5Sdrh */
18014a924a5Sdrh #if defined(__GNUC__)
18114a924a5Sdrh #  define SQLITE_NOINLINE  __attribute__((noinline))
182ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310
18314a924a5Sdrh #  define SQLITE_NOINLINE  __declspec(noinline)
18414a924a5Sdrh #else
18514a924a5Sdrh #  define SQLITE_NOINLINE
18614a924a5Sdrh #endif
18714a924a5Sdrh 
18814a924a5Sdrh /*
189647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when
190*60e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by
191*60e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define.
192647ca46fSmistachkin */
193*60e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC)
1949895f735Smistachkin #  if defined(_MSC_VER) && _MSC_VER>=1300
1959895f735Smistachkin #    if !defined(_WIN32_WCE)
196647ca46fSmistachkin #      include <intrin.h>
197647ca46fSmistachkin #      pragma intrinsic(_byteswap_ushort)
198647ca46fSmistachkin #      pragma intrinsic(_byteswap_ulong)
1999895f735Smistachkin #    else
2009895f735Smistachkin #      include <cmnintrin.h>
2019895f735Smistachkin #    endif
202647ca46fSmistachkin #  endif
203*60e08078Smistachkin #endif
204647ca46fSmistachkin 
205647ca46fSmistachkin /*
20638c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
20738c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never
20838c67c36Sdrh ** threadsafe.  1 means the library is serialized which is the highest
209f7b5496eSdrh ** level of threadsafety.  2 means the library is multithreaded - multiple
21038c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same
21138c67c36Sdrh ** database connection at the same time.
21238c67c36Sdrh **
213e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
21438c67c36Sdrh ** We support that for legacy.
215e5e7a901Sdrh */
216e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
217e5e7a901Sdrh # if defined(THREADSAFE)
218e5e7a901Sdrh #   define SQLITE_THREADSAFE THREADSAFE
219e5e7a901Sdrh # else
22038c67c36Sdrh #   define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
221e5e7a901Sdrh # endif
222e5e7a901Sdrh #endif
223e5e7a901Sdrh 
22467080617Sdrh /*
225cb15f35fSdrh ** Powersafe overwrite is on by default.  But can be turned off using
226cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
227cb15f35fSdrh */
228cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE
229cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1
230cb15f35fSdrh #endif
231cb15f35fSdrh 
232cb15f35fSdrh /*
233d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
234d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
235d1dcb234Sdrh ** which case memory allocation statistics are disabled by default.
2360a732f59Sdanielk1977 */
2370a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
2380a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1
2390a732f59Sdanielk1977 #endif
2400a732f59Sdanielk1977 
2410a732f59Sdanielk1977 /*
2420d18020bSdrh ** Exactly one of the following macros must be defined in order to
2430d18020bSdrh ** specify which memory allocation subsystem to use.
2440d18020bSdrh **
2450d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
2461b186a99Smistachkin **     SQLITE_WIN32_MALLOC           // Use Win32 native heap API
247d1b0afc3Sdrh **     SQLITE_ZERO_MALLOC            // Use a stub allocator that always fails
2480d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
249a2460e07Sdrh **
250753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
251753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem
252753c5444Smistachkin ** will cause HeapValidate to be called.  If heap validation should fail, an
253753c5444Smistachkin ** assertion will be triggered.
254753c5444Smistachkin **
2550d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
2560d18020bSdrh ** the default.
2570d18020bSdrh */
258d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
259d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
260d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
261d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)>1
262d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\
26320b1ff07Smistachkin  are defined but at most one is allowed:\
264d1b0afc3Sdrh  SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
265d1b0afc3Sdrh  SQLITE_ZERO_MALLOC"
2660d18020bSdrh #endif
267d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
268d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
269d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
270d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)==0
2710d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
2720d18020bSdrh #endif
2730d18020bSdrh 
2740d18020bSdrh /*
2758a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
276eee4c8caSdrh ** sizes of memory allocations below this value where possible.
277eee4c8caSdrh */
2788a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
279eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
280eee4c8caSdrh #endif
281eee4c8caSdrh 
282eee4c8caSdrh /*
28367080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
28440b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
28540b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
28640b521f8Sdrh ** it.
28767080617Sdrh */
28840b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
28940b521f8Sdrh #  define _XOPEN_SOURCE 600
290824d7c18Sdrh #endif
291824d7c18Sdrh 
292824d7c18Sdrh /*
2931b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites.  It should always be true that
2941b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG).  If this is not currently true,
2951b28b893Sdrh ** make it true by defining or undefining NDEBUG.
2961b28b893Sdrh **
297443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the
298443dbcf5Sdrh ** assert() statements in the code.  So we want the default action
2991b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
3001b28b893Sdrh ** is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
3014b529d97Sdrh ** feature.
3024b529d97Sdrh */
303289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
3044b529d97Sdrh # define NDEBUG 1
3054b529d97Sdrh #endif
3061b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG)
3071b28b893Sdrh # undef NDEBUG
3081b28b893Sdrh #endif
3094b529d97Sdrh 
3106402250eSdrh /*
311c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
312c7379ce4Sdrh */
313c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
314c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
315c7379ce4Sdrh #endif
316c7379ce4Sdrh 
317c7379ce4Sdrh /*
31847c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing.  When
31947c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to
32047c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to
32147c3b3e0Sdrh ** get full branch coverage.  The testcase() macro is inserted
32247c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple
32347c3b3e0Sdrh ** condition/decision coverage is inadequate.  For example, testcase()
32447c3b3e0Sdrh ** can be used to make sure boundary values are tested.  For
32547c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit
32647c3b3e0Sdrh ** is significant and used at least once.  On switch statements
32747c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase()
32847c3b3e0Sdrh ** can insure that all cases are evaluated.
32947c3b3e0Sdrh **
33047c3b3e0Sdrh */
33147c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST
33247c3b3e0Sdrh   void sqlite3Coverage(int);
33347c3b3e0Sdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
33447c3b3e0Sdrh #else
33547c3b3e0Sdrh # define testcase(X)
3368f941bc7Sdrh #endif
3378f941bc7Sdrh 
3388f941bc7Sdrh /*
3398f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or
3408f941bc7Sdrh ** other bits of code that are needed to support the arguments
3418f941bc7Sdrh ** within testcase() and assert() macros.
3428f941bc7Sdrh */
3438f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
3448f941bc7Sdrh # define TESTONLY(X)  X
3458f941bc7Sdrh #else
34647c3b3e0Sdrh # define TESTONLY(X)
34747c3b3e0Sdrh #endif
34847c3b3e0Sdrh 
34947c3b3e0Sdrh /*
3506149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization
3516149526cSdrh ** to setup for a later assert() statement.  We do not want this code to
3526149526cSdrh ** appear when assert() is disabled.  The following macro is therefore
3536149526cSdrh ** used to contain that setup code.  The "VVA" acronym stands for
3546149526cSdrh ** "Verification, Validation, and Accreditation".  In other words, the
3556149526cSdrh ** code within VVA_ONLY() will only run during verification processes.
3566149526cSdrh */
3576149526cSdrh #ifndef NDEBUG
3586149526cSdrh # define VVA_ONLY(X)  X
3596149526cSdrh #else
3606149526cSdrh # define VVA_ONLY(X)
3616149526cSdrh #endif
3626149526cSdrh 
3636149526cSdrh /*
36447c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which
36547c3b3e0Sdrh ** are intended to always be true or false, respectively.  Such
36647c3b3e0Sdrh ** expressions could be omitted from the code completely.  But they
36747c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience
36847c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
36947c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first
37047c3b3e0Sdrh ** hint of unplanned behavior.
37147c3b3e0Sdrh **
37247c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code.
37347c3b3e0Sdrh **
37447c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
375443dbcf5Sdrh ** be true and false so that the unreachable code they specify will
37647c3b3e0Sdrh ** not be counted as untested code.
37747c3b3e0Sdrh */
37847c3b3e0Sdrh #if defined(SQLITE_COVERAGE_TEST)
37947c3b3e0Sdrh # define ALWAYS(X)      (1)
38047c3b3e0Sdrh # define NEVER(X)       (0)
38147c3b3e0Sdrh #elif !defined(NDEBUG)
3822de80f4cSdrh # define ALWAYS(X)      ((X)?1:(assert(0),0))
3832de80f4cSdrh # define NEVER(X)       ((X)?(assert(0),1):0)
38447c3b3e0Sdrh #else
38547c3b3e0Sdrh # define ALWAYS(X)      (X)
38647c3b3e0Sdrh # define NEVER(X)       (X)
38747c3b3e0Sdrh #endif
38847c3b3e0Sdrh 
38947c3b3e0Sdrh /*
3900cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces.
3910cbcffa7Smistachkin */
392b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
393b10f22a1Smistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
3940cbcffa7Smistachkin   extern int sqlite3OSTrace;
3950cbcffa7Smistachkin # define OSTRACE(X)          if( sqlite3OSTrace ) sqlite3DebugPrintf X
3960cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE
3970cbcffa7Smistachkin #else
3980cbcffa7Smistachkin # define OSTRACE(X)
3990cbcffa7Smistachkin # undef  SQLITE_HAVE_OS_TRACE
4000cbcffa7Smistachkin #endif
4010cbcffa7Smistachkin 
4020cbcffa7Smistachkin /*
4035824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build?  Currently,
4045824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
4055824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are
4065824d44bSmistachkin ** compiled using SQLITE_TEST).
4075824d44bSmistachkin */
4085824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
4095824d44bSmistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
4105824d44bSmistachkin # define SQLITE_NEED_ERR_NAME
4115824d44bSmistachkin #else
4125824d44bSmistachkin # undef  SQLITE_NEED_ERR_NAME
4135824d44bSmistachkin #endif
4145824d44bSmistachkin 
4155824d44bSmistachkin /*
41660ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large
4173e8e7ecbSdrh ** to fit in 32-bits.  This macro is used inside of various testcase()
4183e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support.
4193e8e7ecbSdrh */
420b31a6afaSdan #define IS_BIG_INT(X)  (((X)&~(i64)0xffffffff)!=0)
4213e8e7ecbSdrh 
4223e8e7ecbSdrh /*
42347c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean
42447c3b3e0Sdrh ** expression that is usually false.  Macro likely() surrounds
425443dbcf5Sdrh ** a boolean expression that is usually true.  These hints could,
426443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but
427443dbcf5Sdrh ** currently they are just comments for human readers.
42847c3b3e0Sdrh */
429443dbcf5Sdrh #define likely(X)    (X)
430443dbcf5Sdrh #define unlikely(X)  (X)
43147c3b3e0Sdrh 
432beae3194Sdrh #include "hash.h"
43375897234Sdrh #include "parse.h"
43475897234Sdrh #include <stdio.h>
43575897234Sdrh #include <stdlib.h>
43675897234Sdrh #include <string.h>
43775897234Sdrh #include <assert.h>
43852370e2cSdrh #include <stddef.h>
43975897234Sdrh 
440967e8b73Sdrh /*
441b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
442b37df7b9Sdrh ** substitute integer for floating-point
443b37df7b9Sdrh */
444b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
445b37df7b9Sdrh # define double sqlite_int64
4468b307fbfSdrh # define float sqlite_int64
447b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
448d1167393Sdrh # ifndef SQLITE_BIG_DBL
449cdaca55eSdrh #   define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
450d1167393Sdrh # endif
451b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
452b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
453110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
4540b3bf924Sdrh # undef SQLITE_HAVE_ISNAN
455b37df7b9Sdrh #endif
456d1167393Sdrh #ifndef SQLITE_BIG_DBL
457d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
458d1167393Sdrh #endif
459b37df7b9Sdrh 
460b37df7b9Sdrh /*
46153c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
46253c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
46353c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
46453c0f748Sdanielk1977 */
46553c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
46653c0f748Sdanielk1977 #define OMIT_TEMPDB 1
46753c0f748Sdanielk1977 #else
46853c0f748Sdanielk1977 #define OMIT_TEMPDB 0
46953c0f748Sdanielk1977 #endif
47053c0f748Sdanielk1977 
47153c0f748Sdanielk1977 /*
472d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
473d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
474d946db00Sdrh ** the default file format for new databases and the maximum file format
475d946db00Sdrh ** that the library can read.
476d946db00Sdrh */
477d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
478d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
479bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4
480d946db00Sdrh #endif
481d946db00Sdrh 
482a2460e07Sdrh /*
483a2460e07Sdrh ** Determine whether triggers are recursive by default.  This can be
484a2460e07Sdrh ** changed at run-time using a pragma.
485a2460e07Sdrh */
4865bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
4875bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
4885bde73c4Sdan #endif
4895bde73c4Sdan 
490d946db00Sdrh /*
491b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
49249766d6cSdrh ** on the command-line
49349766d6cSdrh */
494b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
495b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
496d16d0bc5Sdrh # define SQLITE_TEMP_STORE_xc 1  /* Exclude from ctime.c */
49749766d6cSdrh #endif
49849766d6cSdrh 
49949766d6cSdrh /*
500b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
501b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
502b3f56fdbSdan ** to zero.
503b3f56fdbSdan */
5046b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
505b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS
506028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0
507b3f56fdbSdan #endif
508b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS
5096b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8
510b3f56fdbSdan #endif
511a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS
512a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0
513a09c8855Sdrh #endif
514a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
515a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS
516a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
517a09c8855Sdrh #endif
518b3f56fdbSdan 
5194297c7c4Sdrh /*
5204297c7c4Sdrh ** The default initial allocation for the pagecache when using separate
5214297c7c4Sdrh ** pagecaches for each database connection.  A positive number is the
5224297c7c4Sdrh ** number of pages.  A negative number N translations means that a buffer
5234297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold.
5244297c7c4Sdrh */
5254297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
5264297c7c4Sdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 100
5274297c7c4Sdrh #endif
5284297c7c4Sdrh 
529b3f56fdbSdan 
530b3f56fdbSdan /*
531f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
532f1974846Sdrh ** ourselves.
533f1974846Sdrh */
534f1974846Sdrh #ifndef offsetof
535f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
536f1974846Sdrh #endif
537f1974846Sdrh 
538f1974846Sdrh /*
539e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers.
540e1e2e9acSdrh */
541e1e2e9acSdrh #define MIN(A,B) ((A)<(B)?(A):(B))
542e1e2e9acSdrh #define MAX(A,B) ((A)>(B)?(A):(B))
543e1e2e9acSdrh 
544e1e2e9acSdrh /*
5454fa4a54fSdrh ** Swap two objects of type TYPE.
5464fa4a54fSdrh */
5474fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
5484fa4a54fSdrh 
5494fa4a54fSdrh /*
5509b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
5519b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
5529b8f447bSdrh */
5539b8f447bSdrh #if 'A' == '\301'
5549b8f447bSdrh # define SQLITE_EBCDIC 1
5559b8f447bSdrh #else
5569b8f447bSdrh # define SQLITE_ASCII 1
5579b8f447bSdrh #endif
5589b8f447bSdrh 
5599b8f447bSdrh /*
5605a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
5615a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
5625a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
5635a2c2c20Sdrh **
5645a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
56541a2b48bSdrh */
5665a2c2c20Sdrh #ifndef UINT32_TYPE
567dda5b68cSmlcreech # ifdef HAVE_UINT32_T
568dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
569dda5b68cSmlcreech # else
5705a2c2c20Sdrh #  define UINT32_TYPE unsigned int
5715a2c2c20Sdrh # endif
572dda5b68cSmlcreech #endif
5735a2c2c20Sdrh #ifndef UINT16_TYPE
574dda5b68cSmlcreech # ifdef HAVE_UINT16_T
575dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
576dda5b68cSmlcreech # else
5775a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
5785a2c2c20Sdrh # endif
579dda5b68cSmlcreech #endif
580939a16d6Sdrh #ifndef INT16_TYPE
581dda5b68cSmlcreech # ifdef HAVE_INT16_T
582dda5b68cSmlcreech #  define INT16_TYPE int16_t
583dda5b68cSmlcreech # else
584939a16d6Sdrh #  define INT16_TYPE short int
585939a16d6Sdrh # endif
586dda5b68cSmlcreech #endif
5875a2c2c20Sdrh #ifndef UINT8_TYPE
588dda5b68cSmlcreech # ifdef HAVE_UINT8_T
589dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
590dda5b68cSmlcreech # else
5915a2c2c20Sdrh #  define UINT8_TYPE unsigned char
5925a2c2c20Sdrh # endif
593dda5b68cSmlcreech #endif
594905793e2Sdrh #ifndef INT8_TYPE
595dda5b68cSmlcreech # ifdef HAVE_INT8_T
596dda5b68cSmlcreech #  define INT8_TYPE int8_t
597dda5b68cSmlcreech # else
598905793e2Sdrh #  define INT8_TYPE signed char
599905793e2Sdrh # endif
600dda5b68cSmlcreech #endif
601efad9995Sdrh #ifndef LONGDOUBLE_TYPE
602efad9995Sdrh # define LONGDOUBLE_TYPE long double
603efad9995Sdrh #endif
604efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
60527436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
6065a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
6075a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
608939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
6095a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
61070a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
6115a2c2c20Sdrh 
6125a2c2c20Sdrh /*
61335cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
61435cd643cSdrh ** that can be stored in a u32 without loss of data.  The value
61535cd643cSdrh ** is 0x00000000ffffffff.  But because of quirks of some compilers, we
61635cd643cSdrh ** have to specify the value in the less intuitive manner shown:
61735cd643cSdrh */
61835cd643cSdrh #define SQLITE_MAX_U32  ((((u64)1)<<32)-1)
61935cd643cSdrh 
62035cd643cSdrh /*
621faacf17cSdrh ** The datatype used to store estimates of the number of rows in a
622faacf17cSdrh ** table or index.  This is an unsigned integer type.  For 99.9% of
623faacf17cSdrh ** the world, a 32-bit integer is sufficient.  But a 64-bit integer
624faacf17cSdrh ** can be used at compile-time if desired.
625faacf17cSdrh */
626faacf17cSdrh #ifdef SQLITE_64BIT_STATS
627faacf17cSdrh  typedef u64 tRowcnt;    /* 64-bit only if requested at compile-time */
628faacf17cSdrh #else
629faacf17cSdrh  typedef u32 tRowcnt;    /* 32-bit is the default */
630faacf17cSdrh #endif
631faacf17cSdrh 
632faacf17cSdrh /*
633bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit
634bf539c4dSdrh ** logarithms.  For quantity X, the value stored is 10*log2(X).  This
635bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986.
636bf539c4dSdrh ** But the allowed values are "grainy".  Not every value is representable.
637bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst
63897d38983Sdrh ** of 40.  However, since LogEst quantities are suppose to be estimates,
639bf539c4dSdrh ** not exact values, this imprecision is not a problem.
640bf539c4dSdrh **
641224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate".
642bf539c4dSdrh **
643bf539c4dSdrh ** Examples:
644bf539c4dSdrh **      1 -> 0              20 -> 43          10000 -> 132
645bf539c4dSdrh **      2 -> 10             25 -> 46          25000 -> 146
646bf539c4dSdrh **      3 -> 16            100 -> 66        1000000 -> 199
647bf539c4dSdrh **      4 -> 20           1000 -> 99        1048576 -> 200
648bf539c4dSdrh **     10 -> 33           1024 -> 100    4294967296 -> 320
649bf539c4dSdrh **
650bf539c4dSdrh ** The LogEst can be negative to indicate fractional values.
651bf539c4dSdrh ** Examples:
652bf539c4dSdrh **
653bf539c4dSdrh **    0.5 -> -10           0.1 -> -33        0.0625 -> -40
654bf539c4dSdrh */
655bf539c4dSdrh typedef INT16_TYPE LogEst;
656bf539c4dSdrh 
657bf539c4dSdrh /*
6582b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
6592b4905c8Sdrh */
6602b4905c8Sdrh #ifndef SQLITE_PTRSIZE
6612b4905c8Sdrh # if defined(__SIZEOF_POINTER__)
6622b4905c8Sdrh #   define SQLITE_PTRSIZE __SIZEOF_POINTER__
6632b4905c8Sdrh # elif defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
6642b4905c8Sdrh        defined(_M_ARM)   || defined(__arm__)    || defined(__x86)
6652b4905c8Sdrh #   define SQLITE_PTRSIZE 4
6662b4905c8Sdrh # else
6672b4905c8Sdrh #   define SQLITE_PTRSIZE 8
6682b4905c8Sdrh # endif
6692b4905c8Sdrh #endif
6702b4905c8Sdrh 
6712b4905c8Sdrh /*
672bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
67371794dbaSdrh ** and whether or not that determination is run-time or compile-time.
67471794dbaSdrh **
67571794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order
67671794dbaSdrh ** using C-preprocessor macros.  If that is unsuccessful, or if
67771794dbaSdrh ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined
67871794dbaSdrh ** at run-time.
679bbd42a6dSdrh */
68046c99e0fSdrh #ifdef SQLITE_AMALGAMATION
681b3190c15Sdrh const int sqlite3one = 1;
68246c99e0fSdrh #else
683bbd42a6dSdrh extern const int sqlite3one;
68446c99e0fSdrh #endif
68571794dbaSdrh #if (defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
68671794dbaSdrh      defined(__x86_64) || defined(__x86_64__) || defined(_M_X64)  ||    \
68771794dbaSdrh      defined(_M_AMD64) || defined(_M_ARM)     || defined(__x86)   ||    \
68871794dbaSdrh      defined(__arm__)) && !defined(SQLITE_RUNTIME_BYTEORDER)
6892cf4acbdSdrh # define SQLITE_BYTEORDER    1234
69038def054Sdrh # define SQLITE_BIGENDIAN    0
69138def054Sdrh # define SQLITE_LITTLEENDIAN 1
69238def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
69371794dbaSdrh #endif
69471794dbaSdrh #if (defined(sparc)    || defined(__ppc__))  \
69571794dbaSdrh     && !defined(SQLITE_RUNTIME_BYTEORDER)
69671794dbaSdrh # define SQLITE_BYTEORDER    4321
69771794dbaSdrh # define SQLITE_BIGENDIAN    1
69871794dbaSdrh # define SQLITE_LITTLEENDIAN 0
69971794dbaSdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16BE
70071794dbaSdrh #endif
70171794dbaSdrh #if !defined(SQLITE_BYTEORDER)
7022cf4acbdSdrh # define SQLITE_BYTEORDER    0     /* 0 means "unknown at compile-time" */
7039c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
7049c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
70538def054Sdrh # define SQLITE_UTF16NATIVE  (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
70638def054Sdrh #endif
707bbd42a6dSdrh 
708bbd42a6dSdrh /*
7090f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
7100f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
7110f050353Sdrh ** compilers.
7120f050353Sdrh */
7130f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
7140f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
7150f050353Sdrh 
7160f050353Sdrh /*
717be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8.  This is used
718be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures.
719be229650Sdanielk1977 */
720bc73971dSdanielk1977 #define ROUND8(x)     (((x)+7)&~7)
721bc73971dSdanielk1977 
722bc73971dSdanielk1977 /*
723bc73971dSdanielk1977 ** Round down to the nearest multiple of 8
724bc73971dSdanielk1977 */
725bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7)
726be229650Sdanielk1977 
727be229650Sdanielk1977 /*
7288e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary.  This
7298e14c596Sdrh ** macro is used only within assert() to verify that the code gets
7308e14c596Sdrh ** all alignment restrictions correct.
7318e14c596Sdrh **
7328e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
73360ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned
7348e14c596Sdrh ** pointers.  In that case, only verify 4-byte alignment.
735ea598cbdSdrh */
7368e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
7378e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&3)==0)
7388e14c596Sdrh #else
739ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&7)==0)
7408e14c596Sdrh #endif
741ea598cbdSdrh 
742188d4884Sdrh /*
7439b4c59faSdrh ** Disable MMAP on platforms where it is known to not work
744188d4884Sdrh */
745188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__)
7469b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE
7479b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0
748188d4884Sdrh #endif
749188d4884Sdrh 
7509b4c59faSdrh /*
7519b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS
7529b4c59faSdrh */
7539b4c59faSdrh #ifdef __APPLE__
7549b4c59faSdrh # include <TargetConditionals.h>
7559b4c59faSdrh # if TARGET_OS_IPHONE
7569b4c59faSdrh #   undef SQLITE_MAX_MMAP_SIZE
7579b4c59faSdrh #   define SQLITE_MAX_MMAP_SIZE 0
7589b4c59faSdrh # endif
7599b4c59faSdrh #endif
7609b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE
7619b4c59faSdrh # if defined(__linux__) \
7629b4c59faSdrh   || defined(_WIN32) \
7639b4c59faSdrh   || (defined(__APPLE__) && defined(__MACH__)) \
7643e9dd938Sdrh   || defined(__sun) \
7653e9dd938Sdrh   || defined(__FreeBSD__) \
7663e9dd938Sdrh   || defined(__DragonFly__)
7672bba8c24Sdrh #   define SQLITE_MAX_MMAP_SIZE 0x7fff0000  /* 2147418112 */
7689b4c59faSdrh # else
7699b4c59faSdrh #   define SQLITE_MAX_MMAP_SIZE 0
7709b4c59faSdrh # endif
771d16d0bc5Sdrh # define SQLITE_MAX_MMAP_SIZE_xc 1 /* exclude from ctime.c */
7729b4c59faSdrh #endif
7739b4c59faSdrh 
7749b4c59faSdrh /*
7759b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms.  Or, even if a larger
7769b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does
7779b4c59faSdrh ** not exceed the maximum mmap size.
7789b4c59faSdrh */
7799b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE
7809b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0
781d16d0bc5Sdrh # define SQLITE_DEFAULT_MMAP_SIZE_xc 1  /* Exclude from ctime.c */
7829b4c59faSdrh #endif
7839b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
7849b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE
7859b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
7869b4c59faSdrh #endif
787e7b34707Sdrh 
788ea598cbdSdrh /*
7891435a9a1Sdrh ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
7901435a9a1Sdrh ** Priority is given to SQLITE_ENABLE_STAT4.  If either are defined, also
7911435a9a1Sdrh ** define SQLITE_ENABLE_STAT3_OR_STAT4
7921435a9a1Sdrh */
7931435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT4
7941435a9a1Sdrh # undef SQLITE_ENABLE_STAT3
7951435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
7961435a9a1Sdrh #elif SQLITE_ENABLE_STAT3
7971435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
7981435a9a1Sdrh #elif SQLITE_ENABLE_STAT3_OR_STAT4
7991435a9a1Sdrh # undef SQLITE_ENABLE_STAT3_OR_STAT4
8001435a9a1Sdrh #endif
80190f5ecb3Sdrh 
80290f5ecb3Sdrh /*
803abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
804abd4c723Sdrh ** the Select query generator tracing logic is turned on.
805abd4c723Sdrh */
8069300adbcSdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_ENABLE_SELECTTRACE)
807abd4c723Sdrh # define SELECTTRACE_ENABLED 1
808abd4c723Sdrh #else
809abd4c723Sdrh # define SELECTTRACE_ENABLED 0
810abd4c723Sdrh #endif
811abd4c723Sdrh 
812abd4c723Sdrh /*
81390f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
81490f5ecb3Sdrh ** callback for a given sqlite handle.
81590f5ecb3Sdrh **
81690f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
81790f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
81890f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
81990f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
82090f5ecb3Sdrh */
82190f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
82290f5ecb3Sdrh struct BusyHandler {
82390f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
82490f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
825a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
82690f5ecb3Sdrh };
82790f5ecb3Sdrh 
82890f5ecb3Sdrh /*
82975897234Sdrh ** Name of the master database table.  The master database table
83075897234Sdrh ** is a special table that holds the names and attributes of all
83175897234Sdrh ** user tables and indices.
83275897234Sdrh */
83375897234Sdrh #define MASTER_NAME       "sqlite_master"
834e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
83575897234Sdrh 
83675897234Sdrh /*
8378e150818Sdanielk1977 ** The root-page of the master database table.
8388e150818Sdanielk1977 */
8398e150818Sdanielk1977 #define MASTER_ROOT       1
8408e150818Sdanielk1977 
8418e150818Sdanielk1977 /*
842ed6c8671Sdrh ** The name of the schema table.
843ed6c8671Sdrh */
84453c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
845ed6c8671Sdrh 
846ed6c8671Sdrh /*
84775897234Sdrh ** A convenience macro that returns the number of elements in
84875897234Sdrh ** an array.
84975897234Sdrh */
85023432976Sdanielk1977 #define ArraySize(X)    ((int)(sizeof(X)/sizeof(X[0])))
85175897234Sdrh 
85275897234Sdrh /*
8537a5bcc0fSdrh ** Determine if the argument is a power of two
8547a5bcc0fSdrh */
8557a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
8567a5bcc0fSdrh 
8577a5bcc0fSdrh /*
858633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
859aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the
860aa538a58Sdrh ** one parameter that destructors normally want.  So we have to introduce
861aa538a58Sdrh ** this magic value that the code knows to handle differently.  Any
862aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC
863aa538a58Sdrh ** and SQLITE_TRANSIENT.
864633e6d57Sdrh */
865aa538a58Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3MallocSize)
866633e6d57Sdrh 
86778f82d1eSdrh /*
86878f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
86978f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables.
87078f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from
87178f82d1eSdrh ** the heap.  When WSD is unsupported, the variable declarations scattered
87278f82d1eSdrh ** throughout the SQLite code must become constants instead.  The SQLITE_WSD
87378f82d1eSdrh ** macro is used for this purpose.  And instead of referencing the variable
87478f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated
87578f82d1eSdrh ** buffer that holds real variable.  The constant is also the initializer
87678f82d1eSdrh ** for the run-time allocated buffer.
87778f82d1eSdrh **
8782479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
87978f82d1eSdrh ** macros become no-ops and have zero performance impact.
88078f82d1eSdrh */
881075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD
882075c23afSdanielk1977   #define SQLITE_WSD const
883075c23afSdanielk1977   #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
884075c23afSdanielk1977   #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
885d1d38488Sdrh   int sqlite3_wsd_init(int N, int J);
886d1d38488Sdrh   void *sqlite3_wsd_find(void *K, int L);
887075c23afSdanielk1977 #else
888075c23afSdanielk1977   #define SQLITE_WSD
889075c23afSdanielk1977   #define GLOBAL(t,v) v
890075c23afSdanielk1977   #define sqlite3GlobalConfig sqlite3Config
891075c23afSdanielk1977 #endif
892075c23afSdanielk1977 
893f3d3c27aSdanielk1977 /*
894f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to
895f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately
896f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when
897f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the
898f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the
899f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate,
900f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere.
901f3d3c27aSdanielk1977 **
902f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function,
903f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
904f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to
905f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options.
906f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these
907f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions.
908f3d3c27aSdanielk1977 */
90962c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x)
910f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
91162c14b34Sdanielk1977 
912633e6d57Sdrh /*
91375897234Sdrh ** Forward references to structures
91475897234Sdrh */
91513449892Sdrh typedef struct AggInfo AggInfo;
916fe05af87Sdrh typedef struct AuthContext AuthContext;
9170b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo;
918f5e7bb51Sdrh typedef struct Bitvec Bitvec;
919fe05af87Sdrh typedef struct CollSeq CollSeq;
9207020f651Sdrh typedef struct Column Column;
921fe05af87Sdrh typedef struct Db Db;
922e501b89aSdanielk1977 typedef struct Schema Schema;
92375897234Sdrh typedef struct Expr Expr;
92475897234Sdrh typedef struct ExprList ExprList;
925b7916a78Sdrh typedef struct ExprSpan ExprSpan;
926c2eef3b3Sdrh typedef struct FKey FKey;
927d2199f0fSdan typedef struct FuncDestructor FuncDestructor;
928fe05af87Sdrh typedef struct FuncDef FuncDef;
92970a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
930fe05af87Sdrh typedef struct IdList IdList;
931fe05af87Sdrh typedef struct Index Index;
93202fa4696Sdan typedef struct IndexSample IndexSample;
9338d059845Sdanielk1977 typedef struct KeyClass KeyClass;
934d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
935633e6d57Sdrh typedef struct Lookaside Lookaside;
936633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
937d1ab1ba5Sdanielk1977 typedef struct Module Module;
938626a879aSdrh typedef struct NameContext NameContext;
939fe05af87Sdrh typedef struct Parse Parse;
940a5c1416dSdrh typedef struct PrintfArguments PrintfArguments;
941a2460e07Sdrh typedef struct RowSet RowSet;
942fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint;
943fe05af87Sdrh typedef struct Select Select;
944f51446a3Sdrh typedef struct SQLiteThread SQLiteThread;
945634d81deSdrh typedef struct SelectDest SelectDest;
946fe05af87Sdrh typedef struct SrcList SrcList;
947ade86483Sdrh typedef struct StrAccum StrAccum;
948fe05af87Sdrh typedef struct Table Table;
949c00da105Sdanielk1977 typedef struct TableLock TableLock;
950fe05af87Sdrh typedef struct Token Token;
9514fa4a54fSdrh typedef struct TreeView TreeView;
952a2460e07Sdrh typedef struct Trigger Trigger;
9532832ad42Sdan typedef struct TriggerPrg TriggerPrg;
954fe05af87Sdrh typedef struct TriggerStep TriggerStep;
955e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
956595a523aSdanielk1977 typedef struct VTable VTable;
957b061d058Sdan typedef struct VtabCtx VtabCtx;
9587d10d5a6Sdrh typedef struct Walker Walker;
959fe05af87Sdrh typedef struct WhereInfo WhereInfo;
9607d562dbeSdan typedef struct With With;
961d3d39e93Sdrh 
9622dca4ac1Sdanielk1977 /*
9632dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
9642dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
9652dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
9662dca4ac1Sdanielk1977 */
9672dca4ac1Sdanielk1977 #include "btree.h"
9682dca4ac1Sdanielk1977 #include "vdbe.h"
9692dca4ac1Sdanielk1977 #include "pager.h"
9708c0a791aSdanielk1977 #include "pcache.h"
9712dca4ac1Sdanielk1977 
9721cc5ed81Sdanielk1977 #include "os.h"
973c7ce76afSdrh #include "mutex.h"
9741cc5ed81Sdanielk1977 
975eee4c8caSdrh 
976001bbcbbSdrh /*
977001bbcbbSdrh ** Each database file to be accessed by the system is an instance
978001bbcbbSdrh ** of the following structure.  There are normally two of these structures
979001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
980a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
981a69d9168Sdrh ** databases may be attached.
982001bbcbbSdrh */
983001bbcbbSdrh struct Db {
984001bbcbbSdrh   char *zName;         /* Name of this database */
985001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
986467bcf36Sshane   u8 safety_level;     /* How aggressive at syncing data to disk */
987e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
988da184236Sdanielk1977 };
989da184236Sdanielk1977 
990da184236Sdanielk1977 /*
991da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
9922120608eSdrh **
9932120608eSdrh ** Most Schema objects are associated with a Btree.  The exception is
9942120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
9952120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple
9962120608eSdrh ** Btrees that refer to the same underlying BtShared object.
9972120608eSdrh **
9982120608eSdrh ** Schema objects are automatically deallocated when the last Btree that
9992120608eSdrh ** references them is destroyed.   The TEMP Schema is manually freed by
10002120608eSdrh ** sqlite3_close().
10012120608eSdrh *
10022120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order
10032120608eSdrh ** to access Schema content.  This implies that the thread must also be
10042120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
100555a0959aSdrh ** For a TEMP Schema, only the connection mutex is required.
1006da184236Sdanielk1977 */
1007e501b89aSdanielk1977 struct Schema {
1008001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
1009c2a75551Sdrh   int iGeneration;     /* Generation counter.  Incremented with each change */
1010d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
1011d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
1012d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
10131da40a38Sdan   Hash fkeyHash;       /* All foreign keys by referenced table name */
10144794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
1015da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
10168079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
10172c5e35ffSdrh   u16 schemaFlags;     /* Flags associated with this schema */
101814db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
1019001bbcbbSdrh };
102075897234Sdrh 
102175897234Sdrh /*
10228bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
1023a2460e07Sdrh ** Db.pSchema->flags field.
10248bf8dc92Sdrh */
10252c5e35ffSdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
10262c5e35ffSdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
10272c5e35ffSdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->schemaFlags|=(P)
10282c5e35ffSdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->schemaFlags&=~(P)
10298bf8dc92Sdrh 
10308bf8dc92Sdrh /*
1031a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field.
10328bf8dc92Sdrh **
10338bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
10348bf8dc92Sdrh ** read into internal hash tables.
10358bf8dc92Sdrh **
10368bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
10378bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
10388bf8dc92Sdrh ** changes and so the view will need to be reset.
10398bf8dc92Sdrh */
1040124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
1041124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
1042b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
10438bf8dc92Sdrh 
1044caa639f4Sdrh /*
1045caa639f4Sdrh ** The number of different kinds of things that can be limited
1046caa639f4Sdrh ** using the sqlite3_limit() interface.
1047caa639f4Sdrh */
1048111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
10498bf8dc92Sdrh 
10508bf8dc92Sdrh /*
1051633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
1052467bcf36Sshane ** to satisfy small transient memory allocation requests for objects
1053633e6d57Sdrh ** associated with a particular database connection.  The use of
1054633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
1055633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
1056633e6d57Sdrh ** SQL statements.
1057633e6d57Sdrh **
1058633e6d57Sdrh ** The Lookaside structure holds configuration information about the
1059633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
1060633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
1061633e6d57Sdrh ** objects.
1062d9da78a2Sdrh **
1063d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated
1064d9da78a2Sdrh ** with a particular database connection.  Hence, schema information cannot
1065d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information
1066d9da78a2Sdrh ** is shared by multiple database connections.  Therefore, while parsing
1067d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that
1068d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects.
1069633e6d57Sdrh */
1070633e6d57Sdrh struct Lookaside {
1071633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
1072d9da78a2Sdrh   u8 bEnabled;            /* False to disable new lookaside allocations */
1073e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
1074633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
1075633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
10760b12e7f8Sdrh   int anStat[3];          /* 0: hits.  1: size misses.  2: full misses */
10777d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
1078633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
1079633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
1080633e6d57Sdrh };
1081633e6d57Sdrh struct LookasideSlot {
1082633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
1083633e6d57Sdrh };
1084633e6d57Sdrh 
1085633e6d57Sdrh /*
108670a8ca3cSdrh ** A hash table for function definitions.
108770a8ca3cSdrh **
108870a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
108970a8ca3cSdrh ** Collisions are on the FuncDef.pHash chain.
109070a8ca3cSdrh */
109170a8ca3cSdrh struct FuncDefHash {
109270a8ca3cSdrh   FuncDef *a[23];       /* Hash table for functions */
109370a8ca3cSdrh };
109470a8ca3cSdrh 
1095d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1096d4530979Sdrh /*
1097d4530979Sdrh ** Information held in the "sqlite3" database connection object and used
1098d4530979Sdrh ** to manage user authentication.
1099d4530979Sdrh */
1100d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth;
1101d4530979Sdrh struct sqlite3_userauth {
1102e933b83fSdrh   u8 authLevel;                 /* Current authentication level */
1103d4530979Sdrh   int nAuthPW;                  /* Size of the zAuthPW in bytes */
1104d4530979Sdrh   char *zAuthPW;                /* Password used to authenticate */
1105d4530979Sdrh   char *zAuthUser;              /* User name used to authenticate */
1106d4530979Sdrh };
1107d4530979Sdrh 
1108e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */
1109e933b83fSdrh #define UAUTH_Unknown     0     /* Authentication not yet checked */
1110e933b83fSdrh #define UAUTH_Fail        1     /* User authentication failed */
1111e933b83fSdrh #define UAUTH_User        2     /* Authenticated as a normal user */
1112e933b83fSdrh #define UAUTH_Admin       3     /* Authenticated as an administrator */
1113d4530979Sdrh 
1114d4530979Sdrh /* Functions used only by user authorization logic */
1115d4530979Sdrh int sqlite3UserAuthTable(const char*);
1116e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
11177883ecfcSdrh void sqlite3UserAuthInit(sqlite3*);
1118f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
1119f442e33eSdrh 
1120d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */
1121d4530979Sdrh 
112232c6a48bSdrh /*
112332c6a48bSdrh ** typedef for the authorization callback function.
112432c6a48bSdrh */
112532c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION
112632c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
112732c6a48bSdrh                                const char*, const char*);
112832c6a48bSdrh #else
112932c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
113032c6a48bSdrh                                const char*);
113132c6a48bSdrh #endif
113232c6a48bSdrh 
1133d4530979Sdrh 
113470a8ca3cSdrh /*
1135a2460e07Sdrh ** Each database connection is an instance of the following structure.
113675897234Sdrh */
11379bb575fdSdrh struct sqlite3 {
113890f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
1139a451017dSdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
1140a451017dSdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
1141a451017dSdrh   sqlite3_mutex *mutex;         /* Connection mutex */
1142001bbcbbSdrh   Db *aDb;                      /* All backends */
1143a451017dSdrh   int nDb;                      /* Number of backends currently in use */
1144467bcf36Sshane   int flags;                    /* Miscellaneous flags. See below */
1145a451017dSdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
11469b4c59faSdrh   i64 szMmap;                   /* Default mmap_size setting */
1147522c26fbSdrh   unsigned int openFlags;       /* Flags passed to sqlite3_vfs.xOpen() */
1148fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
11494ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
1150a5759677Sdrh   u16 dbOptFlags;               /* Flags to enable/disable optimizations */
11519bd3cc46Sdrh   u8 enc;                       /* Text encoding */
1152fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
115390f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
115417435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
11553b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
115698757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
1157a7564663Sdrh   u8 suppressErr;               /* Do not issue error messages if true */
1158b061d058Sdan   u8 vtabOnConflict;            /* Value to return for s3_vtab_on_conflict() */
1159a451017dSdrh   u8 isTransactionSavepoint;    /* True if the outermost savepoint is a TS */
1160f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
116164202cfeSdanielk1977   u32 magic;                    /* Magic number for detect library misuse */
1162b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
1163b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
1164caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
11658930c2abSdan   int nMaxSorterMmap;           /* Maximum size of regions mapped by sorter */
11664adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
11671d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
1168a451017dSdrh     u8 iDb;                     /* Which db file is being initialized */
11691d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
11703d5f74b2Sdrh     u8 orphanTrigger;           /* Last statement is orphaned TEMP trigger */
11711ffede8cSdrh     u8 imposterTable;           /* Building an imposter table */
11721d85d931Sdrh   } init;
11731713afb0Sdrh   int nVdbeActive;              /* Number of VDBEs currently running */
11744f7d3a5fSdrh   int nVdbeRead;                /* Number of active VDBEs that read or write */
11754f7d3a5fSdrh   int nVdbeWrite;               /* Number of active VDBEs that read and write */
11764f7d3a5fSdrh   int nVdbeExec;                /* Number of nested calls to VdbeExec() */
1177086723a4Sdrh   int nVDestroy;                /* Number of active OP_VDestroy operations */
1178a451017dSdrh   int nExtension;               /* Number of loaded extensions */
1179a451017dSdrh   void **aExtension;            /* Array of shared library handles */
118018de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
118118de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
118219e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
118319e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
1184fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
1185fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
118671fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
118771fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
118894eb6a14Sdanielk1977   void *pUpdateArg;
118994eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
11905cf53537Sdan #ifndef SQLITE_OMIT_WAL
11917ed91f23Sdrh   int (*xWalCallback)(void *, sqlite3 *, const char *, int);
11927ed91f23Sdrh   void *pWalArg;
11935cf53537Sdan #endif
1194fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
1195fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
1196fcd35c7bSdrh   void *pCollNeededArg;
1197fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
1198881feaa0Sdrh   union {
119939001e75Sdrh     volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
1200881feaa0Sdrh     double notUsed1;            /* Spacer */
1201881feaa0Sdrh   } u1;
1202633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
1203ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
120432c6a48bSdrh   sqlite3_xauth xAuth;          /* Access authorization function */
1205ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
1206ed6c8671Sdrh #endif
1207348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1208348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
1209348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
12108f8c65f7Sdrh   unsigned nProgressOps;        /* Number of opcodes for progress callback */
1211348bb5d6Sdanielk1977 #endif
1212b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1213a451017dSdrh   int nVTrans;                  /* Allocated size of aVTrans */
1214b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
1215b061d058Sdan   VtabCtx *pVtabCtx;            /* Context for active vtab connect/create */
1216595a523aSdanielk1977   VTable **aVTrans;             /* Virtual tables with open transactions */
1217595a523aSdanielk1977   VTable *pDisconnect;    /* Disconnect these in next sqlite3_prepare() */
12186b456a2bSdanielk1977 #endif
121970a8ca3cSdrh   FuncDefHash aFunc;            /* Hash table of connection functions */
1220fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
1221fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
1222fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
1223fd7f0452Sdanielk1977   Savepoint *pSavepoint;        /* List of active savepoints */
1224a451017dSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
1225fd7f0452Sdanielk1977   int nSavepoint;               /* Number of non-transaction savepoints */
1226bd43455cSdanielk1977   int nStatement;               /* Number of nested statement-transactions  */
12271da40a38Sdan   i64 nDeferredCons;            /* Net deferred constraints this transaction. */
1228648e2643Sdrh   i64 nDeferredImmCons;         /* Net deferred immediate constraints */
1229d46def77Sdan   int *pnBytesFreed;            /* If not NULL, increment this in DbFree() */
1230404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
1231404ca075Sdanielk1977   /* The following variables are all protected by the STATIC_MASTER
1232404ca075Sdanielk1977   ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
123365a73badSdrh   **
123465a73badSdrh   ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
123565a73badSdrh   ** unlock so that it can proceed.
123665a73badSdrh   **
123765a73badSdrh   ** When X.pBlockingConnection==Y, that means that something that X tried
123865a73badSdrh   ** tried to do recently failed with an SQLITE_LOCKED error due to locks
123965a73badSdrh   ** held by Y.
1240404ca075Sdanielk1977   */
1241404ca075Sdanielk1977   sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
1242404ca075Sdanielk1977   sqlite3 *pUnlockConnection;           /* Connection to watch for unlock */
1243404ca075Sdanielk1977   void *pUnlockArg;                     /* Argument to xUnlockNotify */
1244404ca075Sdanielk1977   void (*xUnlockNotify)(void **, int);  /* Unlock notify callback */
1245404ca075Sdanielk1977   sqlite3 *pNextBlocked;        /* Next in list of all blocked connections */
1246404ca075Sdanielk1977 #endif
1247d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1248d4530979Sdrh   sqlite3_userauth auth;        /* User authentication information */
1249d4530979Sdrh #endif
125075897234Sdrh };
125175897234Sdrh 
125203b808a6Sdrh /*
125303b808a6Sdrh ** A macro to discover the encoding of a database.
125403b808a6Sdrh */
12559bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
12569bd3cc46Sdrh #define ENC(db)        ((db)->enc)
125714db2665Sdanielk1977 
125875897234Sdrh /*
125907096f68Sdrh ** Possible values for the sqlite3.flags.
126075897234Sdrh */
12617e5418e4Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
12627e5418e4Sdrh #define SQLITE_InternChanges  0x00000002  /* Uncommitted Hash table changes */
126340c3941cSdrh #define SQLITE_FullFSync      0x00000004  /* Use full fsync on the backend */
126440c3941cSdrh #define SQLITE_CkptFullFSync  0x00000008  /* Use full fsync for checkpoint */
126540c3941cSdrh #define SQLITE_CacheSpill     0x00000010  /* OK to spill pager cache */
126640c3941cSdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
126740c3941cSdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
126840c3941cSdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
12691bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
12701bee3d7bSdrh                                           /*   the count using a callback. */
127140c3941cSdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
12726a535340Sdrh                                           /*   result set is empty */
127340c3941cSdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
127440c3941cSdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
127540c3941cSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
127640c3941cSdrh #define SQLITE_VdbeAddopTrace 0x00001000  /* Trace sqlite3VdbeAddOp() calls */
127740c3941cSdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
127840c3941cSdrh #define SQLITE_ReadUncommitted 0x0004000  /* For shared-cache mode */
127940c3941cSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
128040c3941cSdrh #define SQLITE_RecoveryMode   0x00010000  /* Ignore schema errors */
128140c3941cSdrh #define SQLITE_ReverseOrder   0x00020000  /* Reverse unordered SELECTs */
128240c3941cSdrh #define SQLITE_RecTriggers    0x00040000  /* Enable recursive triggers */
128340c3941cSdrh #define SQLITE_ForeignKeys    0x00080000  /* Enforce foreign key constraints  */
128440c3941cSdrh #define SQLITE_AutoIndex      0x00100000  /* Enable automatic indexes */
128540c3941cSdrh #define SQLITE_PreferBuiltin  0x00200000  /* Preference to built-in funcs */
128640c3941cSdrh #define SQLITE_LoadExtension  0x00400000  /* Enable load_extension */
128740c3941cSdrh #define SQLITE_EnableTrigger  0x00800000  /* True to enable triggers */
128840c3941cSdrh #define SQLITE_DeferFKs       0x01000000  /* Defer all FK constraints */
128940c3941cSdrh #define SQLITE_QueryOnly      0x02000000  /* Disable database changes */
129084e55a80Sdrh #define SQLITE_VdbeEQP        0x04000000  /* Debug EXPLAIN QUERY PLAN */
1291e34162b1Sdan #define SQLITE_Vacuum         0x08000000  /* Currently in a VACUUM */
12921421d980Sdrh #define SQLITE_CellSizeCk     0x10000000  /* Check btree cell sizes on load */
1293b1eaa718Sdrh 
129407096f68Sdrh 
129507096f68Sdrh /*
12967e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the
12977e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
12987e5418e4Sdrh ** selectively disable various optimizations.
129907096f68Sdrh */
13007e5418e4Sdrh #define SQLITE_QueryFlattener 0x0001   /* Query flattening */
13017e5418e4Sdrh #define SQLITE_ColumnCache    0x0002   /* Column cache */
13027e5418e4Sdrh #define SQLITE_GroupByOrder   0x0004   /* GROUPBY cover of ORDERBY */
13037e5418e4Sdrh #define SQLITE_FactorOutConst 0x0008   /* Constant factoring */
1304762c1c40Sdrh /*                not used    0x0010   // Was: SQLITE_IdxRealAsInt */
13057e5418e4Sdrh #define SQLITE_DistinctOpt    0x0020   /* DISTINCT using indexes */
13067e5418e4Sdrh #define SQLITE_CoverIdxScan   0x0040   /* Covering index scans */
1307a9e3fc05Sdrh #define SQLITE_OrderByIdxJoin 0x0080   /* ORDER BY of joins via index */
1308a5759677Sdrh #define SQLITE_SubqCoroutine  0x0100   /* Evaluate subqueries as coroutines */
1309eb5bc926Sdrh #define SQLITE_Transitive     0x0200   /* Transitive constraints */
13101031bd99Sdrh #define SQLITE_OmitNoopJoin   0x0400   /* Omit unused tables in joins */
1311d7d71470Sdrh #define SQLITE_Stat34         0x0800   /* Use STAT3 or STAT4 data */
1312a5759677Sdrh #define SQLITE_AllOpts        0xffff   /* All optimizations */
13137e5418e4Sdrh 
13147e5418e4Sdrh /*
13157e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled.
13167e5418e4Sdrh */
13177e5418e4Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
13187e5418e4Sdrh #define OptimizationDisabled(db, mask)  (((db)->dbOptFlags&(mask))!=0)
13197e5418e4Sdrh #define OptimizationEnabled(db, mask)   (((db)->dbOptFlags&(mask))==0)
13207e5418e4Sdrh #else
13217e5418e4Sdrh #define OptimizationDisabled(db, mask)  0
13227e5418e4Sdrh #define OptimizationEnabled(db, mask)   1
13237e5418e4Sdrh #endif
132434c68fbaSdanielk1977 
132558b9576bSdrh /*
1326d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization
1327d9f158e7Sdrh ** code. The argument is a Parse object for the code generator.
1328d9f158e7Sdrh */
1329aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor)
1330247be43dSdrh 
1331247be43dSdrh /*
1332247be43dSdrh ** Possible values for the sqlite.magic field.
1333247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
1334247be43dSdrh ** than being distinct from one another.
1335247be43dSdrh */
1336247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
1337247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
13387e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
1339247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
1340247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
13414245c405Sdrh #define SQLITE_MAGIC_ZOMBIE   0x64cffc7f  /* Close with last statement close */
1342247be43dSdrh 
1343247be43dSdrh /*
13440bce8354Sdrh ** Each SQL function is defined by an instance of the following
13450bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
13468e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
13478e0a2f90Sdrh ** points to a linked list of these structures.
13482803757aSdrh */
13490bce8354Sdrh struct FuncDef {
1350e82f5d04Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
1351d36e1041Sdrh   u16 funcFlags;       /* Some combination of SQLITE_FUNC_* */
13521350b030Sdrh   void *pUserData;     /* User data parameter */
13530bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
1354f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
1355f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
1356467bcf36Sshane   void (*xFinalize)(sqlite3_context*);                /* Aggregate finalizer */
13578c0a791aSdanielk1977   char *zName;         /* SQL name of the function. */
135870a8ca3cSdrh   FuncDef *pHash;      /* Next with a different name but the same hash */
1359d2199f0fSdan   FuncDestructor *pDestructor;   /* Reference counted destructor function */
1360d2199f0fSdan };
1361d2199f0fSdan 
1362d2199f0fSdan /*
1363d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as
1364d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When
1365d2199f0fSdan ** create_function_v2() is called to create a function with a destructor,
1366d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to
1367d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether
1368d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1369d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated
1370d2199f0fSdan ** FuncDestructor.
1371d2199f0fSdan **
1372d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference
1373d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor
1374d2199f0fSdan ** is invoked and the FuncDestructor structure freed.
1375d2199f0fSdan */
1376d2199f0fSdan struct FuncDestructor {
1377d2199f0fSdan   int nRef;
1378d2199f0fSdan   void (*xDestroy)(void *);
1379d2199f0fSdan   void *pUserData;
13808e0a2f90Sdrh };
13812803757aSdrh 
13822803757aSdrh /*
1383a748fdccSdrh ** Possible values for FuncDef.flags.  Note that the _LENGTH and _TYPEOF
1384a748fdccSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG.  There
1385a748fdccSdrh ** are assert() statements in the code to verify this.
13867d10d5a6Sdrh */
1387d36e1041Sdrh #define SQLITE_FUNC_ENCMASK  0x003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
1388d36e1041Sdrh #define SQLITE_FUNC_LIKE     0x004 /* Candidate for the LIKE optimization */
1389d36e1041Sdrh #define SQLITE_FUNC_CASE     0x008 /* Case-sensitive LIKE-type function */
1390d36e1041Sdrh #define SQLITE_FUNC_EPHEM    0x010 /* Ephemeral.  Delete with VDBE */
1391d36e1041Sdrh #define SQLITE_FUNC_NEEDCOLL 0x020 /* sqlite3GetFuncCollSeq() might be called */
1392d36e1041Sdrh #define SQLITE_FUNC_LENGTH   0x040 /* Built-in length() function */
1393d36e1041Sdrh #define SQLITE_FUNC_TYPEOF   0x080 /* Built-in typeof() function */
1394d36e1041Sdrh #define SQLITE_FUNC_COUNT    0x100 /* Built-in count(*) aggregate */
1395d36e1041Sdrh #define SQLITE_FUNC_COALESCE 0x200 /* Built-in coalesce() or ifnull() */
1396d36e1041Sdrh #define SQLITE_FUNC_UNLIKELY 0x400 /* Built-in unlikely() function */
1397b1fba286Sdrh #define SQLITE_FUNC_CONSTANT 0x800 /* Constant inputs give a constant output */
13989588ad95Sdrh #define SQLITE_FUNC_MINMAX  0x1000 /* True for min() and max() aggregates */
13997d10d5a6Sdrh 
14007d10d5a6Sdrh /*
1401777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1402777c5386Sdrh ** used to create the initializers for the FuncDef structures.
1403777c5386Sdrh **
1404777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
1405777c5386Sdrh **     Used to create a scalar function definition of a function zName
1406777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
1407777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
1408777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
1409f7bca574Sdrh **     argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1410777c5386Sdrh **
1411b1fba286Sdrh **   VFUNCTION(zName, nArg, iArg, bNC, xFunc)
1412b1fba286Sdrh **     Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
1413b1fba286Sdrh **
1414777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1415777c5386Sdrh **     Used to create an aggregate function definition implemented by
1416777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
1417777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
1418777c5386Sdrh **     FUNCTION().
1419777c5386Sdrh **
1420777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
1421777c5386Sdrh **     Used to create a scalar function definition of a function zName
1422777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
1423777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
1424777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
1425777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
1426777c5386Sdrh **     parameter.
1427777c5386Sdrh */
1428777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
1429b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1430b1fba286Sdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
1431b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1432d36e1041Sdrh   {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
1433a748fdccSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
1434a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
1435b1fba286Sdrh   {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
14366ac78a0dSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
143721717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
1438b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
14396ac78a0dSdrh    pArg, 0, xFunc, 0, 0, #zName, 0, 0}
1440777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
1441b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
1442b1fba286Sdrh    (void *)arg, 0, likeFunc, 0, 0, #zName, 0, 0}
1443777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
1444d36e1041Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
14456ac78a0dSdrh    SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0}
14469588ad95Sdrh #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
14479588ad95Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
14489588ad95Sdrh    SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0}
1449777c5386Sdrh 
1450fd7f0452Sdanielk1977 /*
1451fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at
1452fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently
1453fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe
1454fd7f0452Sdanielk1977 ** OP_Savepoint instruction.
1455fd7f0452Sdanielk1977 */
1456fd7f0452Sdanielk1977 struct Savepoint {
1457fd7f0452Sdanielk1977   char *zName;                        /* Savepoint name (nul-terminated) */
1458fcb9f7adSdrh   i64 nDeferredCons;                  /* Number of deferred fk violations */
1459648e2643Sdrh   i64 nDeferredImmCons;               /* Number of deferred imm fk. */
1460fd7f0452Sdanielk1977   Savepoint *pNext;                   /* Parent savepoint (if any) */
1461fd7f0452Sdanielk1977 };
1462fd7f0452Sdanielk1977 
1463fd7f0452Sdanielk1977 /*
1464fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(),
1465fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction.
1466fd7f0452Sdanielk1977 */
1467fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN      0
1468fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE    1
1469fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK   2
1470fd7f0452Sdanielk1977 
1471777c5386Sdrh 
1472777c5386Sdrh /*
1473d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
1474d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
1475d1ab1ba5Sdanielk1977 ** hash table.
1476d1ab1ba5Sdanielk1977 */
1477d1ab1ba5Sdanielk1977 struct Module {
1478d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
1479d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
1480d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
1481832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
1482d1ab1ba5Sdanielk1977 };
1483d1ab1ba5Sdanielk1977 
1484d1ab1ba5Sdanielk1977 /*
1485967e8b73Sdrh ** information about each column of an SQL table is held in an instance
14867020f651Sdrh ** of this structure.
14877020f651Sdrh */
14887020f651Sdrh struct Column {
14897020f651Sdrh   char *zName;     /* Name of this column */
14907977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
1491b7916a78Sdrh   char *zDflt;     /* Original text of the default value */
1492382c0247Sdrh   char *zType;     /* Data type for this column */
1493b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
1494a371ace4Sdrh   u8 notNull;      /* An OE_ code for handling a NOT NULL constraint */
1495a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
1496fdaac671Sdrh   u8 szEst;        /* Estimated size of this column.  INT==1 */
1497fdaac671Sdrh   u8 colFlags;     /* Boolean properties.  See COLFLAG_ defines below */
14987020f651Sdrh };
14997020f651Sdrh 
1500a371ace4Sdrh /* Allowed values for Column.colFlags:
1501a371ace4Sdrh */
1502a371ace4Sdrh #define COLFLAG_PRIMKEY  0x0001    /* Column is part of the primary key */
1503a371ace4Sdrh #define COLFLAG_HIDDEN   0x0002    /* A hidden column in a virtual table */
1504a371ace4Sdrh 
15057020f651Sdrh /*
1506a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
15070202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
15080202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
1509a9fd84b0Sdrh **
1510e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the
15110202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
15120202b29eSdanielk1977 ** collating sequence may not be read or written.
1513a9fd84b0Sdrh */
1514a9fd84b0Sdrh struct CollSeq {
15150202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
1516466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
1517a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
15180202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
1519a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
1520a9fd84b0Sdrh };
1521a9fd84b0Sdrh 
1522a9fd84b0Sdrh /*
1523d3d39e93Sdrh ** A sort order can be either ASC or DESC.
15248e2ca029Sdrh */
15258e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
1526d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
15278e2ca029Sdrh 
15288e2ca029Sdrh /*
1529a37cdde0Sdanielk1977 ** Column affinity types.
15308a51256cSdrh **
15318a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
15328a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
15337d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
15348a51256cSdrh **
15354583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'.  That way,
15368a51256cSdrh ** when multiple affinity types are concatenated into a string and
153766a5167bSdrh ** used as the P4 operand, they will be more readable.
15388a51256cSdrh **
15398a51256cSdrh ** Note also that the numeric types are grouped together so that testing
154005883a34Sdrh ** for a numeric type is a single comparison.  And the BLOB type is first.
1541a37cdde0Sdanielk1977 */
154205883a34Sdrh #define SQLITE_AFF_BLOB     'A'
15434583c37cSdrh #define SQLITE_AFF_TEXT     'B'
15444583c37cSdrh #define SQLITE_AFF_NUMERIC  'C'
15454583c37cSdrh #define SQLITE_AFF_INTEGER  'D'
15464583c37cSdrh #define SQLITE_AFF_REAL     'E'
1547a37cdde0Sdanielk1977 
15488a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
1549a37cdde0Sdanielk1977 
1550a37cdde0Sdanielk1977 /*
155135573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
155235573356Sdrh ** affinity value.
155335573356Sdrh */
15544583c37cSdrh #define SQLITE_AFF_MASK     0x47
155535573356Sdrh 
155635573356Sdrh /*
155735573356Sdrh ** Additional bit values that can be ORed with an affinity without
155835573356Sdrh ** changing the affinity.
15593d77dee9Sdrh **
15603d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
15613d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison
15623d77dee9Sdrh ** operator is NULL.  It is added to certain comparison operators to
15633d77dee9Sdrh ** prove that the operands are always NOT NULL.
156435573356Sdrh */
15654583c37cSdrh #define SQLITE_JUMPIFNULL   0x10  /* jumps if either operand is NULL */
15664583c37cSdrh #define SQLITE_STOREP2      0x20  /* Store result in reg[P2] rather than jump */
15676a2fe093Sdrh #define SQLITE_NULLEQ       0x80  /* NULL=NULL */
15684583c37cSdrh #define SQLITE_NOTNULL      0x90  /* Assert that operands are never NULL */
156935573356Sdrh 
157035573356Sdrh /*
1571595a523aSdanielk1977 ** An object of this type is created for each virtual table present in
1572595a523aSdanielk1977 ** the database schema.
1573595a523aSdanielk1977 **
1574595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this
1575595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared
1576595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique
1577595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table
1578595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between
1579595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database
1580595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database
1581595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method
1582595a523aSdanielk1977 ** during initialization internally. This database connection handle may
15839bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables
1584595a523aSdanielk1977 ** within the database. So that they appear as part of the callers
1585595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database
1586595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table.
1587595a523aSdanielk1977 **
1588595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared
1589595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by
1590595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object.
1591595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual
1592595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the
1593595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct
1594595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query.
1595595a523aSdanielk1977 **
1596595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the
1597595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not
1598595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1599595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to
1600595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the
1601595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
1602595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done
1603595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1604595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an
1605595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1606595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex.
1607595a523aSdanielk1977 **
1608595a523aSdanielk1977 ** The memory for objects of this type is always allocated by
1609595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1610595a523aSdanielk1977 ** the first argument.
1611595a523aSdanielk1977 */
1612595a523aSdanielk1977 struct VTable {
1613595a523aSdanielk1977   sqlite3 *db;              /* Database connection associated with this table */
1614595a523aSdanielk1977   Module *pMod;             /* Pointer to module implementation */
1615595a523aSdanielk1977   sqlite3_vtab *pVtab;      /* Pointer to vtab instance */
1616595a523aSdanielk1977   int nRef;                 /* Number of pointers to this structure */
1617b061d058Sdan   u8 bConstraint;           /* True if constraints are supported */
1618addd8f87Sdrh   int iSavepoint;           /* Depth of the SAVEPOINT stack */
1619595a523aSdanielk1977   VTable *pNext;            /* Next in linked list (see above) */
1620595a523aSdanielk1977 };
1621595a523aSdanielk1977 
1622595a523aSdanielk1977 /*
16235789d1a4Sdrh ** The schema for each SQL table and view is represented in memory
16245789d1a4Sdrh ** by an instance of the following structure.
162575897234Sdrh */
162675897234Sdrh struct Table {
16277d10d5a6Sdrh   char *zName;         /* Name of the table or view */
16287020f651Sdrh   Column *aCol;        /* Information about each column */
1629967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
1630a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
1631c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
16323d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
1633ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
16342938f924Sdrh   ExprList *pCheck;    /* All CHECK constraints */
1635ffe07b2dSdrh #endif
16365789d1a4Sdrh   int tnum;            /* Root BTree page for this table */
16375789d1a4Sdrh   i16 iPKey;           /* If not negative, use aCol[iPKey] as the rowid */
1638d815f17dSdrh   i16 nCol;            /* Number of columns in this table */
1639d815f17dSdrh   u16 nRef;            /* Number of pointers to this Table */
16405789d1a4Sdrh   LogEst nRowLogEst;   /* Estimated rows in table - from sqlite_stat1 table */
1641bf539c4dSdrh   LogEst szTabRow;     /* Estimated size of each table row in bytes */
1642dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT
1643dbd9486dSdrh   LogEst costMult;     /* Cost multiplier for using this table */
1644dbd9486dSdrh #endif
1645d815f17dSdrh   u8 tabFlags;         /* Mask of TF_* values */
1646d815f17dSdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
164719a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
16487d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
164919a8e7e8Sdanielk1977 #endif
1650e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1651b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
1652b9bb7c18Sdrh   char **azModuleArg;  /* Text of all module args. [0] is module name */
1653d815f17dSdrh   VTable *pVTable;     /* List of VTable objects. */
1654e09daa90Sdrh #endif
16552f886d1dSdanielk1977   Trigger *pTrigger;   /* List of triggers stored in pSchema */
1656728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
1657588a9a1aSdrh   Table *pNextZombie;  /* Next on the Parse.pZombieTab list */
165875897234Sdrh };
165975897234Sdrh 
166075897234Sdrh /*
16618ce7184bSdan ** Allowed values for Table.tabFlags.
1662a21f78b9Sdrh **
1663a21f78b9Sdrh ** TF_OOOHidden applies to virtual tables that have hidden columns that are
1664a21f78b9Sdrh ** followed by non-hidden columns.  Example:  "CREATE VIRTUAL TABLE x USING
1665a21f78b9Sdrh ** vtab1(a HIDDEN, b);".  Since "b" is a non-hidden column but "a" is hidden,
1666a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case.  Such tables require
1667a21f78b9Sdrh ** special handling during INSERT processing.
16687d10d5a6Sdrh */
16697d10d5a6Sdrh #define TF_Readonly        0x01    /* Read-only system table */
1670467bcf36Sshane #define TF_Ephemeral       0x02    /* An ephemeral table */
16717d10d5a6Sdrh #define TF_HasPrimaryKey   0x04    /* Table has a primary key */
16727d10d5a6Sdrh #define TF_Autoincrement   0x08    /* Integer primary key is autoincrement */
16737d10d5a6Sdrh #define TF_Virtual         0x10    /* Is a virtual table */
1674fccda8a1Sdrh #define TF_WithoutRowid    0x20    /* No rowid.  PRIMARY KEY is the key */
1675fccda8a1Sdrh #define TF_NoVisibleRowid  0x40    /* No user-visible "rowid" column */
1676fccda8a1Sdrh #define TF_OOOHidden       0x80    /* Out-of-Order hidden columns */
16777d10d5a6Sdrh 
16787d10d5a6Sdrh 
16797d10d5a6Sdrh /*
16804cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
16814cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
16824cbdda9eSdrh ** table support is omitted from the build.
16834cbdda9eSdrh */
16844cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
16857d10d5a6Sdrh #  define IsVirtual(X)      (((X)->tabFlags & TF_Virtual)!=0)
1686a371ace4Sdrh #  define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
16874cbdda9eSdrh #else
16884cbdda9eSdrh #  define IsVirtual(X)      0
1689034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
16904cbdda9eSdrh #endif
16914cbdda9eSdrh 
1692ec95c441Sdrh /* Does the table have a rowid */
1693ec95c441Sdrh #define HasRowid(X)     (((X)->tabFlags & TF_WithoutRowid)==0)
1694fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
1695ec95c441Sdrh 
16964cbdda9eSdrh /*
1697c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
1698c2eef3b3Sdrh **
1699c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
1700c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
1701c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
1702c2eef3b3Sdrh ** Consider this example:
1703c2eef3b3Sdrh **
1704c2eef3b3Sdrh **     CREATE TABLE ex1(
1705c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
1706c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1707c2eef3b3Sdrh **     );
1708c2eef3b3Sdrh **
1709c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1710bd50a926Sdrh ** Equivalent names:
1711bd50a926Sdrh **
1712bd50a926Sdrh **     from-table == child-table
1713bd50a926Sdrh **       to-table == parent-table
1714c2eef3b3Sdrh **
1715c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
1716c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
1717e61922a6Sdrh ** the from-table is created.  The existence of the to-table is not checked.
1718bd50a926Sdrh **
1719bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey.
1720bd50a926Sdrh **
1721bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist)
1722bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z.
1723c2eef3b3Sdrh */
1724c2eef3b3Sdrh struct FKey {
17251f638cebSdrh   Table *pFrom;     /* Table containing the REFERENCES clause (aka: Child) */
1726bd50a926Sdrh   FKey *pNextFrom;  /* Next FKey with the same in pFrom. Next parent of pFrom */
17271f638cebSdrh   char *zTo;        /* Name of table that the key points to (aka: Parent) */
1728bd50a926Sdrh   FKey *pNextTo;    /* Next with the same zTo. Next child of zTo. */
1729bd50a926Sdrh   FKey *pPrevTo;    /* Previous with the same zTo */
1730c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
17314c429839Sdrh   /* EV: R-30323-21917 */
1732c2eef3b3Sdrh   u8 isDeferred;       /* True if constraint checking is deferred till COMMIT */
17338099ce6fSdan   u8 aAction[2];        /* ON DELETE and ON UPDATE actions, respectively */
17348099ce6fSdan   Trigger *apTrigger[2];/* Triggers for aAction[] actions */
1735e61922a6Sdrh   struct sColMap {      /* Mapping of columns in pFrom to columns in zTo */
1736e61922a6Sdrh     int iFrom;            /* Index of column in pFrom */
1737bd50a926Sdrh     char *zCol;           /* Name of column in zTo.  If NULL use PRIMARY KEY */
1738e61922a6Sdrh   } aCol[1];            /* One entry for each of nCol columns */
1739c2eef3b3Sdrh };
1740c2eef3b3Sdrh 
1741c2eef3b3Sdrh /*
1742aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
174322f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
17440bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
17451c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
17461c92853dSdrh ** fails and any prior changes from that one operation are backed out,
17471c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
17481c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
17491c92853dSdrh ** changes due to the same operation are not backed out and no rollback
17501c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
17511c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
17521c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
17531c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
17541c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
17551c92853dSdrh **
1756c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1757c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1758c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1759c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1760c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1761c2eef3b3Sdrh ** foreign key.
1762c2eef3b3Sdrh **
1763968af52aSdrh ** The following symbolic values are used to record which type
17641c92853dSdrh ** of action to take.
17659cfcf5d4Sdrh */
17669cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
17671c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
17681c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
17691c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
17701c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
17711c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1772c2eef3b3Sdrh 
1773c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1774c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1775c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1776c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1777c2eef3b3Sdrh 
1778c28c4e50Sdrh #define OE_Default  10  /* Do whatever the default action is */
17799cfcf5d4Sdrh 
1780d3d39e93Sdrh 
1781d3d39e93Sdrh /*
1782d3d39e93Sdrh ** An instance of the following structure is passed as the first
1783d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1784d3d39e93Sdrh ** comparison of the two index keys.
1785323df790Sdrh **
1786323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots.  There
1787323df790Sdrh ** are nField slots for the columns of an index then one extra slot
1788323df790Sdrh ** for the rowid at the end.
1789d3d39e93Sdrh */
1790d3d39e93Sdrh struct KeyInfo {
17912ec2fb22Sdrh   u32 nRef;           /* Number of references to this KeyInfo object */
17929b8d0272Sdrh   u8 enc;             /* Text encoding - one of the SQLITE_UTF* values */
1793ad124329Sdrh   u16 nField;         /* Number of key columns in the index */
1794ad124329Sdrh   u16 nXField;        /* Number of columns beyond the key columns */
17952ec2fb22Sdrh   sqlite3 *db;        /* The database connection */
1796323df790Sdrh   u8 *aSortOrder;     /* Sort order for each column. */
1797d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1798d3d39e93Sdrh };
1799d3d39e93Sdrh 
18009cfcf5d4Sdrh /*
1801e63d9991Sdrh ** An instance of the following structure holds information about a
1802e63d9991Sdrh ** single index record that has already been parsed out into individual
1803e63d9991Sdrh ** values.
1804e63d9991Sdrh **
1805e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1806e63d9991Sdrh ** Records are used to store the content of a table row and to store
1807e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1808467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
1809e63d9991Sdrh ** OP_Column opcode.
1810e63d9991Sdrh **
1811e63d9991Sdrh ** This structure holds a record that has already been disassembled
1812467bcf36Sshane ** into its constituent fields.
18133833e934Sdan **
18143833e934Sdan ** The r1 and r2 member variables are only used by the optimized comparison
18153833e934Sdan ** functions vdbeRecordCompareInt() and vdbeRecordCompareString().
1816e63d9991Sdrh */
1817e63d9991Sdrh struct UnpackedRecord {
1818e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
1819e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1820a9e0aeb5Sdrh   i8 default_rc;      /* Comparison result if keys are equal */
182138fdead8Sdan   u8 errCode;         /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
1822e63d9991Sdrh   Mem *aMem;          /* Values */
18233833e934Sdan   int r1;             /* Value to return if (lhs > rhs) */
18243833e934Sdan   int r2;             /* Value to return if (rhs < lhs) */
1825e63d9991Sdrh };
1826e63d9991Sdrh 
1827e63d9991Sdrh 
1828e63d9991Sdrh /*
182966b89c8fSdrh ** Each SQL index is represented in memory by an
183075897234Sdrh ** instance of the following structure.
1831967e8b73Sdrh **
1832967e8b73Sdrh ** The columns of the table that are to be indexed are described
1833967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1834967e8b73Sdrh ** we have the following table and index:
1835967e8b73Sdrh **
1836967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1837967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1838967e8b73Sdrh **
1839967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1840967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1841967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1842967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1843967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1844967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1845967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1846ea1ba17cSdrh **
1847ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1848ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1849ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1850ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1851ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1852ea1ba17cSdrh ** element.
1853c5b73585Sdan **
1854c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
1855c5b73585Sdan ** generate VDBE code (as opposed to parsing one read from an sqlite_master
1856c5b73585Sdan ** table as part of parsing an existing database schema), transient instances
1857c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is
1858c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page
1859c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE
1860c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details.
186175897234Sdrh */
186275897234Sdrh struct Index {
186375897234Sdrh   char *zName;             /* Name of this index */
1864bbbdc83bSdrh   i16 *aiColumn;           /* Which columns are used by this index.  1st is 0 */
1865cfc9df76Sdan   LogEst *aiRowLogEst;     /* From ANALYZE: Est. rows selected by each column */
1866967e8b73Sdrh   Table *pTable;           /* The SQL table being indexed */
1867a37cdde0Sdanielk1977   char *zColAff;           /* String defining the affinity of each column */
186875897234Sdrh   Index *pNext;            /* The next index associated with the same table */
1869b3bf556eSdanielk1977   Schema *pSchema;         /* Schema containing this index */
1870b376daebSdrh   u8 *aSortOrder;          /* for each column: True==DESC, False==ASC */
1871b3bf556eSdanielk1977   char **azColl;           /* Array of collation sequence names for index */
18721fe0537eSdrh   Expr *pPartIdxWhere;     /* WHERE clause for partial indices */
1873b376daebSdrh   int tnum;                /* DB Page containing root of this index */
1874bf539c4dSdrh   LogEst szIdxRow;         /* Estimated average row size in bytes */
1875bbbdc83bSdrh   u16 nKeyCol;             /* Number of columns forming the key */
1876bbbdc83bSdrh   u16 nColumn;             /* Number of columns stored in the index */
1877a451017dSdrh   u8 onError;              /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
187848dd1d8eSdrh   unsigned idxType:2;      /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
1879b376daebSdrh   unsigned bUnordered:1;   /* Use this index for == or IN queries only */
18807699d1c4Sdrh   unsigned uniqNotNull:1;  /* True if UNIQUE and NOT NULL for all columns */
18817f9c5dbfSdrh   unsigned isResized:1;    /* True if resizeIndexObject() has been called */
1882ec95c441Sdrh   unsigned isCovering:1;   /* True if this is a covering index */
1883f9df2fbdSdrh   unsigned noSkipScan:1;   /* Do not try to use skip-scan if true */
18841435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
18852b9cf669Sdrh   int nSample;             /* Number of elements in aSample[] */
18868ad169abSdan   int nSampleCol;          /* Size of IndexSample.anEq[] and so on */
1887eea568d6Sdan   tRowcnt *aAvgEq;         /* Average nEq values for keys not in aSample */
1888faacf17cSdrh   IndexSample *aSample;    /* Samples of the left-most key */
18899f07cf7bSdrh   tRowcnt *aiRowEst;       /* Non-logarithmic stat1 data for this index */
18909f07cf7bSdrh   tRowcnt nRowEst0;        /* Non-logarithmic number of rows in the index */
1891faacf17cSdrh #endif
189202fa4696Sdan };
189302fa4696Sdan 
189402fa4696Sdan /*
189548dd1d8eSdrh ** Allowed values for Index.idxType
189648dd1d8eSdrh */
189748dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF      0   /* Created using CREATE INDEX */
189848dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE      1   /* Implements a UNIQUE constraint */
189948dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY  2   /* Is the PRIMARY KEY for the table */
190048dd1d8eSdrh 
190148dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */
190248dd1d8eSdrh #define IsPrimaryKeyIndex(X)  ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
190348dd1d8eSdrh 
19045f1d1d9cSdrh /* Return true if index X is a UNIQUE index */
19055f1d1d9cSdrh #define IsUniqueIndex(X)      ((X)->onError!=OE_None)
19065f1d1d9cSdrh 
190748dd1d8eSdrh /*
190874e7c8f5Sdrh ** Each sample stored in the sqlite_stat3 table is represented in memory
190974e7c8f5Sdrh ** using a structure of this type.  See documentation at the top of the
191074e7c8f5Sdrh ** analyze.c source file for additional information.
191102fa4696Sdan */
191202fa4696Sdan struct IndexSample {
1913f52bb8d3Sdan   void *p;          /* Pointer to sampled record */
1914f52bb8d3Sdan   int n;            /* Size of record in bytes */
1915f52bb8d3Sdan   tRowcnt *anEq;    /* Est. number of rows where the key equals this sample */
1916f52bb8d3Sdan   tRowcnt *anLt;    /* Est. number of rows where key is less than this sample */
1917f52bb8d3Sdan   tRowcnt *anDLt;   /* Est. number of distinct keys less than this sample */
191875897234Sdrh };
191975897234Sdrh 
192075897234Sdrh /*
192175897234Sdrh ** Each token coming out of the lexer is an instance of
19224b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
19234efc4754Sdrh **
19244efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
1925467bcf36Sshane ** may contain random values.  Do not make any assumptions about Token.dyn
19264efc4754Sdrh ** and Token.n when Token.z==0.
192775897234Sdrh */
192875897234Sdrh struct Token {
1929b7916a78Sdrh   const char *z;     /* Text of the token.  Not NULL-terminated! */
1930b7916a78Sdrh   unsigned int n;    /* Number of characters in this token */
193175897234Sdrh };
193275897234Sdrh 
193375897234Sdrh /*
193413449892Sdrh ** An instance of this structure contains information needed to generate
193513449892Sdrh ** code for a SELECT that contains aggregate functions.
193613449892Sdrh **
193713449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
193813449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
193913449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
194013449892Sdrh ** code for that node.
194113449892Sdrh **
194213449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
194313449892Sdrh ** original Select structure that describes the SELECT statement.  These
194413449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
194513449892Sdrh */
194613449892Sdrh struct AggInfo {
194713449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
194813449892Sdrh                           ** from source tables rather than from accumulators */
194913449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
195013449892Sdrh                           ** than the source table */
195113449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
19525134d135Sdan   int sortingIdxPTab;     /* Cursor number of pseudo-table */
195313449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
19547e61d18eSdrh   int mnReg, mxReg;       /* Range of registers allocated for aCol and aFunc */
1955a451017dSdrh   ExprList *pGroupBy;     /* The group by clause */
195613449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
19570817d0dfSdanielk1977     Table *pTab;             /* Source table */
195813449892Sdrh     int iTable;              /* Cursor number of the source table */
195913449892Sdrh     int iColumn;             /* Column number within the source table */
196013449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
196113449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
19625774b806Sdrh     Expr *pExpr;             /* The original expression */
196313449892Sdrh   } *aCol;
196413449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
196513449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
196613449892Sdrh                           ** Additional columns are used only as parameters to
196713449892Sdrh                           ** aggregate functions */
196813449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
196913449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
197013449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
197113449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1972467bcf36Sshane     int iDistinct;           /* Ephemeral table used to enforce DISTINCT */
197313449892Sdrh   } *aFunc;
197413449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
197513449892Sdrh };
197613449892Sdrh 
197713449892Sdrh /*
19788677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
19798677d308Sdrh ** Usually it is 16-bits.  But if SQLITE_MAX_VARIABLE_NUMBER is greater
19808677d308Sdrh ** than 32767 we have to make it 32-bit.  16-bit is preferred because
19818677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user
19828677d308Sdrh ** in systems with lots of prepared statements.  And few applications
19838677d308Sdrh ** need more than about 10 or 20 variables.  But some extreme users want
19848677d308Sdrh ** to have prepared statements with over 32767 variables, and for them
19858677d308Sdrh ** the option is available (at compile-time).
19868677d308Sdrh */
19878677d308Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<=32767
1988481aa74eSdrh typedef i16 ynVar;
19898677d308Sdrh #else
19908677d308Sdrh typedef int ynVar;
19918677d308Sdrh #endif
19928677d308Sdrh 
19938677d308Sdrh /*
199475897234Sdrh ** Each node of an expression in the parse tree is an instance
199522f70c32Sdrh ** of this structure.
199622f70c32Sdrh **
199722f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused
199822f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer
199922f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused
200022f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
200122f70c32Sdrh ** tree.
200222f70c32Sdrh **
20036ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
20046ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
20056ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
20066ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
20076ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function.
200822f70c32Sdrh **
20096ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
20106ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL.
20116ab3a2ecSdanielk1977 **
20126ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
20136ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
20146ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
20156ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
20166ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
20176ab3a2ecSdanielk1977 ** valid.
201822f70c32Sdrh **
201922f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
202022f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
202122f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
202222f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
202322f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
202422f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
202522f70c32Sdrh ** it can be accessed after all aggregates are computed.
202622f70c32Sdrh **
20276ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark
20286ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index
20296ab3a2ecSdanielk1977 ** number for that variable.
203022f70c32Sdrh **
20311398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
20321398ad36Sdrh ** register number containing the result of the subquery.  If the
20331398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
20341398ad36Sdrh ** gives a different answer at different times during statement processing
20351398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
20361398ad36Sdrh **
2037aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
2038aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
2039aee18ef8Sdanielk1977 ** corresponding table definition.
20406ab3a2ecSdanielk1977 **
20416ab3a2ecSdanielk1977 ** ALLOCATION NOTES:
20426ab3a2ecSdanielk1977 **
204312ffee8cSdrh ** Expr objects can use a lot of memory space in database schema.  To
204412ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be
204512ffee8cSdrh ** truncated.  And to reduce the number of memory allocations, sometimes
204612ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation,
204733e619fcSdrh ** together with Expr.zToken strings.
20486ab3a2ecSdanielk1977 **
2049b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when
205012ffee8cSdrh ** an Expr object is truncated.  When EP_Reduced is set, then all
205112ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
205212ffee8cSdrh ** are contained within the same memory allocation.  Note, however, that
205312ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
205412ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set.
205575897234Sdrh */
205675897234Sdrh struct Expr {
20571cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
2058a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
2059c5cd1249Sdrh   u32 flags;             /* Various flags.  EP_* See below */
206033e619fcSdrh   union {
2061b7916a78Sdrh     char *zToken;          /* Token value. Zero terminated and dequoted */
2062d50ffc41Sdrh     int iValue;            /* Non-negative integer value if EP_IntValue */
206333e619fcSdrh   } u;
20646ab3a2ecSdanielk1977 
20656ab3a2ecSdanielk1977   /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
20666ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
20676ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
20686ab3a2ecSdanielk1977   *********************************************************************/
20696ab3a2ecSdanielk1977 
20706ab3a2ecSdanielk1977   Expr *pLeft;           /* Left subnode */
20716ab3a2ecSdanielk1977   Expr *pRight;          /* Right subnode */
20726ab3a2ecSdanielk1977   union {
2073c5cd1249Sdrh     ExprList *pList;     /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
2074c5cd1249Sdrh     Select *pSelect;     /* EP_xIsSelect and op = IN, EXISTS, SELECT */
20756ab3a2ecSdanielk1977   } x;
20766ab3a2ecSdanielk1977 
20776ab3a2ecSdanielk1977   /* If the EP_Reduced flag is set in the Expr.flags mask, then no
20786ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
20796ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
20806ab3a2ecSdanielk1977   *********************************************************************/
20816ab3a2ecSdanielk1977 
20826ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
20836ec65491Sdrh   int nHeight;           /* Height of the tree headed by this node */
20846ec65491Sdrh #endif
2085b7916a78Sdrh   int iTable;            /* TK_COLUMN: cursor number of table holding column
20862832ad42Sdan                          ** TK_REGISTER: register number
2087cca9f3d2Sdrh                          ** TK_TRIGGER: 1 -> new, 0 -> old
2088d05ab6aaSdrh                          ** EP_Unlikely:  134217728 times likelihood */
20898677d308Sdrh   ynVar iColumn;         /* TK_COLUMN: column index.  -1 for rowid.
2090937d0deaSdan                          ** TK_VARIABLE: variable number (always >= 1). */
2091b7916a78Sdrh   i16 iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
2092b7916a78Sdrh   i16 iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
2093030796dfSdrh   u8 op2;                /* TK_REGISTER: original value of Expr.op
2094030796dfSdrh                          ** TK_COLUMN: the value of p5 for OP_Column
2095030796dfSdrh                          ** TK_AGG_FUNCTION: nesting depth */
209613449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
20977d10d5a6Sdrh   Table *pTab;           /* Table for TK_COLUMN expressions. */
209875897234Sdrh };
209975897234Sdrh 
210075897234Sdrh /*
21011f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
21021f16230bSdrh */
210372673a24Sdrh #define EP_FromJoin  0x000001 /* Originates in ON/USING clause of outer join */
2104c5cd1249Sdrh #define EP_Agg       0x000002 /* Contains one or more aggregate functions */
2105c5cd1249Sdrh #define EP_Resolved  0x000004 /* IDs have been resolved to COLUMNs */
2106c5cd1249Sdrh #define EP_Error     0x000008 /* Expression contains one or more errors */
2107c5cd1249Sdrh #define EP_Distinct  0x000010 /* Aggregate function with DISTINCT keyword */
2108c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
2109c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
2110c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
2111fbb24d10Sdrh #define EP_Collate   0x000100 /* Tree contains a TK_COLLATE operator */
2112fbb24d10Sdrh #define EP_Generic   0x000200 /* Ignore COLLATE or affinity on this tree */
2113c5cd1249Sdrh #define EP_IntValue  0x000400 /* Integer value contained in u.iValue */
2114c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
2115a4c3c87eSdrh #define EP_Skip      0x001000 /* COLLATE, AS, or UNLIKELY */
2116c5cd1249Sdrh #define EP_Reduced   0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
2117c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
2118c5cd1249Sdrh #define EP_Static    0x008000 /* Held in memory not obtained from malloc() */
2119c5cd1249Sdrh #define EP_MemToken  0x010000 /* Need to sqlite3DbFree() Expr.zToken */
2120ebb6a65dSdrh #define EP_NoReduce  0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
2121a4c3c87eSdrh #define EP_Unlikely  0x040000 /* unlikely() or likelihood() function */
212263f84573Sdrh #define EP_ConstFunc 0x080000 /* Node is a SQLITE_FUNC_CONSTANT function */
212372673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
2124885a5b03Sdrh #define EP_Subquery  0x200000 /* Tree contains a TK_SELECT operator */
2125885a5b03Sdrh 
2126885a5b03Sdrh /*
2127885a5b03Sdrh ** Combinations of two or more EP_* flags
2128885a5b03Sdrh */
2129885a5b03Sdrh #define EP_Propagate (EP_Collate|EP_Subquery) /* Propagate these bits up tree */
21301af466ebSdrh 
21311af466ebSdrh /*
21321f16230bSdrh ** These macros can be used to test, set, or clear bits in the
21331f16230bSdrh ** Expr.flags field.
21341f16230bSdrh */
2135c5cd1249Sdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))!=0)
2136c5cd1249Sdrh #define ExprHasAllProperty(E,P)  (((E)->flags&(P))==(P))
21371f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
21381f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
21391f16230bSdrh 
2140ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation,
2141ebb6a65dSdrh ** and Accreditation only.  It works like ExprSetProperty() during VVA
2142ebb6a65dSdrh ** processes but is a no-op for delivery.
2143ebb6a65dSdrh */
2144ebb6a65dSdrh #ifdef SQLITE_DEBUG
2145ebb6a65dSdrh # define ExprSetVVAProperty(E,P)  (E)->flags|=(P)
2146ebb6a65dSdrh #else
2147ebb6a65dSdrh # define ExprSetVVAProperty(E,P)
2148ebb6a65dSdrh #endif
2149ebb6a65dSdrh 
21501f16230bSdrh /*
21516ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr
21526ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
21536ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set.
21546ab3a2ecSdanielk1977 */
215512ffee8cSdrh #define EXPR_FULLSIZE           sizeof(Expr)           /* Full size */
215612ffee8cSdrh #define EXPR_REDUCEDSIZE        offsetof(Expr,iTable)  /* Common features */
2157b7916a78Sdrh #define EXPR_TOKENONLYSIZE      offsetof(Expr,pLeft)   /* Fewer features */
21586ab3a2ecSdanielk1977 
21596ab3a2ecSdanielk1977 /*
21606ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment
21616ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details.
21626ab3a2ecSdanielk1977 */
216312ffee8cSdrh #define EXPRDUP_REDUCE         0x0001  /* Used reduced-size Expr nodes */
21646ab3a2ecSdanielk1977 
21656ab3a2ecSdanielk1977 /*
216675897234Sdrh ** A list of expressions.  Each expression may optionally have a
216775897234Sdrh ** name.  An expr/name combination can be used in several ways, such
216875897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
216975897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
2170ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
217175897234Sdrh ** field is not used.
21720dde4739Sdrh **
21730dde4739Sdrh ** By default the Expr.zSpan field holds a human-readable description of
21740dde4739Sdrh ** the expression that is used in the generation of error messages and
21750dde4739Sdrh ** column labels.  In this case, Expr.zSpan is typically the text of a
21760dde4739Sdrh ** column expression as it exists in a SELECT statement.  However, if
21770dde4739Sdrh ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
21783e3f1a5bSdrh ** of the result column in the form: DATABASE.TABLE.COLUMN.  This later
21793e3f1a5bSdrh ** form is used for name resolution with nested FROM clauses.
218075897234Sdrh */
218175897234Sdrh struct ExprList {
218275897234Sdrh   int nExpr;             /* Number of expressions on the list */
2183d872bb18Sdrh   struct ExprList_item { /* For each expression in the list */
218475897234Sdrh     Expr *pExpr;            /* The list of expressions */
218575897234Sdrh     char *zName;            /* Token associated with this expression */
2186b7916a78Sdrh     char *zSpan;            /* Original text of the expression */
21878e2ca029Sdrh     u8 sortOrder;           /* 1 for DESC or 0 for ASC */
21880dde4739Sdrh     unsigned done :1;       /* A flag to indicate when processing is finished */
21893e3f1a5bSdrh     unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
2190d673cddaSdrh     unsigned reusable :1;   /* Constant expression is reusable */
2191c2acc4e4Sdrh     union {
2192c2acc4e4Sdrh       struct {
21934b3ac73cSdrh         u16 iOrderByCol;      /* For ORDER BY, column number in result set */
21948b213899Sdrh         u16 iAlias;           /* Index into Parse.aAlias[] for zName */
2195c2acc4e4Sdrh       } x;
2196c2acc4e4Sdrh       int iConstExprReg;      /* Register in which Expr value is cached */
2197c2acc4e4Sdrh     } u;
2198d872bb18Sdrh   } *a;                  /* Alloc a power of two greater or equal to nExpr */
219975897234Sdrh };
220075897234Sdrh 
220175897234Sdrh /*
2202b7916a78Sdrh ** An instance of this structure is used by the parser to record both
2203b7916a78Sdrh ** the parse tree for an expression and the span of input text for an
2204b7916a78Sdrh ** expression.
2205b7916a78Sdrh */
2206b7916a78Sdrh struct ExprSpan {
2207b7916a78Sdrh   Expr *pExpr;          /* The expression parse tree */
2208b7916a78Sdrh   const char *zStart;   /* First character of input text */
2209b7916a78Sdrh   const char *zEnd;     /* One character past the end of input text */
2210b7916a78Sdrh };
2211b7916a78Sdrh 
2212b7916a78Sdrh /*
2213ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
2214ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
2215ad3cab52Sdrh **
2216ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
2217ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
2218ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
2219ad3cab52Sdrh **
2220ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
2221ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
2222ad3cab52Sdrh **
2223ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
2224ad3cab52Sdrh **
2225ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
222675897234Sdrh */
222775897234Sdrh struct IdList {
22286d4abfbeSdrh   struct IdList_item {
2229ad3cab52Sdrh     char *zName;      /* Name of the identifier */
2230967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
2231ad3cab52Sdrh   } *a;
223213449892Sdrh   int nId;         /* Number of identifiers on the list */
2233ad3cab52Sdrh };
2234ad3cab52Sdrh 
2235ad3cab52Sdrh /*
223651669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
2237ca83ac51Sdrh **
2238ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
2239ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
2240ca83ac51Sdrh ** of the library by 738 bytes on ix86.
224151669863Sdrh */
2242ca83ac51Sdrh typedef u64 Bitmask;
224351669863Sdrh 
224451669863Sdrh /*
224500e13613Sdanielk1977 ** The number of bits in a Bitmask.  "BMS" means "BitMask Size".
224600e13613Sdanielk1977 */
224700e13613Sdanielk1977 #define BMS  ((int)(sizeof(Bitmask)*8))
224800e13613Sdanielk1977 
224900e13613Sdanielk1977 /*
22507699d1c4Sdrh ** A bit in a Bitmask
22517699d1c4Sdrh */
22527699d1c4Sdrh #define MASKBIT(n)   (((Bitmask)1)<<(n))
2253693e6719Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n))
22547699d1c4Sdrh 
22557699d1c4Sdrh /*
2256ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
2257ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
2258ad3cab52Sdrh ** the SrcList.a[] array.
2259d24cc427Sdrh **
2260d24cc427Sdrh ** With the addition of multiple database support, the following structure
2261d24cc427Sdrh ** can also be used to describe a particular table such as the table that
2262d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
2263d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
2264d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
2265c49de5d9Sdrh **
2266c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
2267c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
2268c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
2269c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
22702a6a7eebSdrh **
22712a6a7eebSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table
22722a6a7eebSdrh ** contains more than 63 columns and the 64-th or later column is used.
2273ad3cab52Sdrh */
2274ad3cab52Sdrh struct SrcList {
22756d1626ebSdrh   int nSrc;        /* Number of tables or subqueries in the FROM clause */
22766d1626ebSdrh   u32 nAlloc;      /* Number of entries allocated in a[] below */
2277ad3cab52Sdrh   struct SrcList_item {
227841fb5cd1Sdan     Schema *pSchema;  /* Schema to which this item is fixed */
2279113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
2280ad3cab52Sdrh     char *zName;      /* Name of the table */
2281ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
2282daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
2283daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
22845b6a9ed4Sdrh     int addrFillSub;  /* Address of subroutine to manifest a subquery */
22855b6a9ed4Sdrh     int regReturn;    /* Register holding return address of addrFillSub */
22865f612295Sdrh     int regResult;    /* Registers holding results of a co-routine */
2287c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
228821172c4cSdrh     unsigned notIndexed :1;    /* True if there is a NOT INDEXED clause */
228921172c4cSdrh     unsigned isCorrelated :1;  /* True if sub-query is correlated */
229021172c4cSdrh     unsigned viaCoroutine :1;  /* Implemented as a co-routine */
2291f43fe6e9Sdan     unsigned isRecursive :1;   /* True for recursive reference in WITH */
2292ce7e189dSdan #ifndef SQLITE_OMIT_EXPLAIN
2293ce7e189dSdan     u8 iSelectId;     /* If pSelect!=0, the id of the sub-select in EQP */
2294ce7e189dSdan #endif
2295e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
2296ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
2297ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
2298cd38d520Sdanielk1977     Bitmask colUsed;  /* Bit N (1<<N) set if column N of pTab is used */
2299d62fbb50Sdrh     char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */
230085574e31Sdanielk1977     Index *pIndex;    /* Index structure corresponding to zIndex, if any */
2301113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
230275897234Sdrh };
230375897234Sdrh 
230475897234Sdrh /*
230501f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
230601f3f253Sdrh */
230701f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
23083dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
23093dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
23103dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
23113dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
23123dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
23133dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
231401f3f253Sdrh 
2315111a6a7dSdrh 
2316111a6a7dSdrh /*
2317336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
2318336a5300Sdrh ** and the WhereInfo.wctrlFlags member.
231908c88eb0Sdrh */
23206df2acd2Sdrh #define WHERE_ORDERBY_NORMAL   0x0000 /* No-op */
23216df2acd2Sdrh #define WHERE_ORDERBY_MIN      0x0001 /* ORDER BY processing for min() func */
23226df2acd2Sdrh #define WHERE_ORDERBY_MAX      0x0002 /* ORDER BY processing for max() func */
23236df2acd2Sdrh #define WHERE_ONEPASS_DESIRED  0x0004 /* Want to do one-pass UPDATE/DELETE */
2324336a5300Sdrh #define WHERE_DUPLICATES_OK    0x0008 /* Ok to return a row more than once */
23259ef61f4fSdrh #define WHERE_OMIT_OPEN_CLOSE  0x0010 /* Table cursors are already open */
23269ef61f4fSdrh #define WHERE_FORCE_TABLE      0x0020 /* Do not use an index-only search */
23279ef61f4fSdrh #define WHERE_ONETABLE_ONLY    0x0040 /* Only code the 1st table in pTabList */
23288e8e7ef3Sdrh #define WHERE_NO_AUTOINDEX     0x0080 /* Disallow automatic indexes */
2329319f677dSdrh #define WHERE_GROUPBY          0x0100 /* pOrderBy is really a GROUP BY */
23304f402f26Sdrh #define WHERE_DISTINCTBY       0x0200 /* pOrderby is really a DISTINCT clause */
23316457a353Sdrh #define WHERE_WANT_DISTINCT    0x0400 /* All output needs to be distinct */
2332374cd78cSdan #define WHERE_SORTBYGROUP      0x0800 /* Support sqlite3WhereIsSorted() */
23333526319bSdrh #define WHERE_REOPEN_IDX       0x1000 /* Try to use OP_ReopenIdx */
2334a9d1ccb9Sdanielk1977 
23354f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct()
233675897234Sdrh */
2337e8e4af76Sdrh #define WHERE_DISTINCT_NOOP      0  /* DISTINCT keyword not used */
2338ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE    1  /* No duplicates */
2339ae651d61Sdrh #define WHERE_DISTINCT_ORDERED   2  /* All duplicates are adjacent */
2340e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3  /* Duplicates are scattered */
234138cc40c2Sdan 
234275897234Sdrh /*
2343b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
2344b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
2345b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
2346b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
2347b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
2348b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
2349b3bce662Sdanielk1977 ** other statements.
2350b3bce662Sdanielk1977 **
2351b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
2352b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
2353b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
2354b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
2355b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
2356b3bce662Sdanielk1977 ** the context containing the match is incremented.
2357b3bce662Sdanielk1977 **
2358b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
2359b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
2360b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
2361b3bce662Sdanielk1977 ** subqueries looking for a match.
2362b3bce662Sdanielk1977 */
2363b3bce662Sdanielk1977 struct NameContext {
2364b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
2365b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
236626080d92Sdrh   ExprList *pEList;    /* Optional list of result-set columns */
236713449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
2368b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
2369a51009b2Sdrh   int nRef;            /* Number of names resolved by this context */
2370a51009b2Sdrh   int nErr;            /* Number of errors encountered while resolving names */
23719588ad95Sdrh   u16 ncFlags;         /* Zero or more NC_* flags defined below */
2372b3bce662Sdanielk1977 };
2373b3bce662Sdanielk1977 
2374b3bce662Sdanielk1977 /*
2375a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field.
23769588ad95Sdrh **
23779588ad95Sdrh ** Note:  NC_MinMaxAgg must have the same value as SF_MinMaxAgg and
23789588ad95Sdrh ** SQLITE_FUNC_MINMAX.
23799588ad95Sdrh **
2380a51009b2Sdrh */
23819588ad95Sdrh #define NC_AllowAgg  0x0001  /* Aggregate functions are allowed here */
23829588ad95Sdrh #define NC_HasAgg    0x0002  /* One or more aggregate functions seen */
23839588ad95Sdrh #define NC_IsCheck   0x0004  /* True if resolving names in a CHECK constraint */
23849588ad95Sdrh #define NC_InAggFunc 0x0008  /* True if analyzing arguments to an agg func */
23859588ad95Sdrh #define NC_PartIdx   0x0010  /* True if resolving a partial index WHERE */
23869588ad95Sdrh #define NC_MinMaxAgg 0x1000  /* min/max aggregates seen.  See note above */
2387a51009b2Sdrh 
2388a51009b2Sdrh /*
23899bb61fe7Sdrh ** An instance of the following structure contains all information
23909bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
2391a76b5dfcSdrh **
2392d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
2393d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
2394d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
2395d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
2396d11d382cSdrh ** in the VDBE that record the limit and offset counters.
23970342b1f5Sdrh **
2398b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
23990342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
240066a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
24010342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
2402b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
24030342b1f5Sdrh ** enough information about the compound query is known at that point.
2404b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
24052c79733fSdrh ** for the result set.  The KeyInfo for addrOpenEphm[2] contains collating
24060342b1f5Sdrh ** sequences for the ORDER BY clause.
24079bb61fe7Sdrh */
24089bb61fe7Sdrh struct Select {
24099bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
24107b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
24117d10d5a6Sdrh   u16 selFlags;          /* Various SF_* values */
2412a451017dSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
2413abd4c723Sdrh #if SELECTTRACE_ENABLED
2414eb9b884cSdrh   char zSelName[12];     /* Symbolic name of this SELECT use for debugging */
2415abd4c723Sdrh #endif
2416079a3072Sdrh   int addrOpenEphm[2];   /* OP_OpenEphem opcodes related to this select */
2417c63367efSdrh   u64 nSelectRow;        /* Estimated number of result rows */
2418ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
24199bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
24209bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
24219bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
24229bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
2423967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
24241e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
2425a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
2426a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
24274e9119d9Sdan   With *pWith;           /* WITH clause attached to this select. Or NULL. */
24289bb61fe7Sdrh };
24299bb61fe7Sdrh 
24309bb61fe7Sdrh /*
24317d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
24327d10d5a6Sdrh ** "Select Flag".
24337d10d5a6Sdrh */
243421172c4cSdrh #define SF_Distinct        0x0001  /* Output should be DISTINCT */
24357cea7f95Sdrh #define SF_All             0x0002  /* Includes the ALL keyword */
24367cea7f95Sdrh #define SF_Resolved        0x0004  /* Identifiers have been resolved */
24377cea7f95Sdrh #define SF_Aggregate       0x0008  /* Contains aggregate functions */
24387cea7f95Sdrh #define SF_UsesEphemeral   0x0010  /* Uses the OpenEphemeral opcode */
24397cea7f95Sdrh #define SF_Expanded        0x0020  /* sqlite3SelectExpand() called on this */
24407cea7f95Sdrh #define SF_HasTypeInfo     0x0040  /* FROM subqueries have Table metadata */
24417cea7f95Sdrh #define SF_Compound        0x0080  /* Part of a compound query */
24427cea7f95Sdrh #define SF_Values          0x0100  /* Synthesized from VALUES clause */
24437cea7f95Sdrh #define SF_MultiValue      0x0200  /* Single VALUES term with multiple rows */
24447cea7f95Sdrh #define SF_NestedFrom      0x0400  /* Part of a parenthesized FROM clause */
24457cea7f95Sdrh #define SF_MaybeConvert    0x0800  /* Need convertCompoundSelectToSubquery() */
24469588ad95Sdrh #define SF_MinMaxAgg       0x1000  /* Aggregate containing min() or max() */
24477cea7f95Sdrh #define SF_Recursive       0x2000  /* The recursive part of a recursive CTE */
24487cea7f95Sdrh #define SF_Converted       0x4000  /* By convertCompoundSelectToSubquery() */
24497d10d5a6Sdrh 
24507d10d5a6Sdrh 
24517d10d5a6Sdrh /*
2452340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined
2453340309fdSdrh ** by one of the following macros.  The "SRT" prefix means "SELECT Result
2454340309fdSdrh ** Type".
2455340309fdSdrh **
2456340309fdSdrh **     SRT_Union       Store results as a key in a temporary index
2457340309fdSdrh **                     identified by pDest->iSDParm.
2458340309fdSdrh **
2459340309fdSdrh **     SRT_Except      Remove results from the temporary index pDest->iSDParm.
2460340309fdSdrh **
2461340309fdSdrh **     SRT_Exists      Store a 1 in memory cell pDest->iSDParm if the result
2462340309fdSdrh **                     set is not empty.
2463340309fdSdrh **
2464340309fdSdrh **     SRT_Discard     Throw the results away.  This is used by SELECT
2465340309fdSdrh **                     statements within triggers whose only purpose is
2466340309fdSdrh **                     the side-effects of functions.
2467340309fdSdrh **
2468340309fdSdrh ** All of the above are free to ignore their ORDER BY clause. Those that
2469340309fdSdrh ** follow must honor the ORDER BY clause.
2470340309fdSdrh **
2471340309fdSdrh **     SRT_Output      Generate a row of output (using the OP_ResultRow
2472340309fdSdrh **                     opcode) for each row in the result set.
2473340309fdSdrh **
2474340309fdSdrh **     SRT_Mem         Only valid if the result is a single column.
2475340309fdSdrh **                     Store the first column of the first result row
2476340309fdSdrh **                     in register pDest->iSDParm then abandon the rest
2477340309fdSdrh **                     of the query.  This destination implies "LIMIT 1".
2478340309fdSdrh **
2479340309fdSdrh **     SRT_Set         The result must be a single column.  Store each
2480340309fdSdrh **                     row of result as the key in table pDest->iSDParm.
2481340309fdSdrh **                     Apply the affinity pDest->affSdst before storing
2482340309fdSdrh **                     results.  Used to implement "IN (SELECT ...)".
2483340309fdSdrh **
2484340309fdSdrh **     SRT_EphemTab    Create an temporary table pDest->iSDParm and store
2485340309fdSdrh **                     the result there. The cursor is left open after
2486340309fdSdrh **                     returning.  This is like SRT_Table except that
2487340309fdSdrh **                     this destination uses OP_OpenEphemeral to create
2488340309fdSdrh **                     the table first.
2489340309fdSdrh **
2490340309fdSdrh **     SRT_Coroutine   Generate a co-routine that returns a new row of
2491340309fdSdrh **                     results each time it is invoked.  The entry point
2492340309fdSdrh **                     of the co-routine is stored in register pDest->iSDParm
2493340309fdSdrh **                     and the result row is stored in pDest->nDest registers
2494340309fdSdrh **                     starting with pDest->iSdst.
2495340309fdSdrh **
2496781def29Sdrh **     SRT_Table       Store results in temporary table pDest->iSDParm.
24978e1ee88cSdrh **     SRT_Fifo        This is like SRT_EphemTab except that the table
24988e1ee88cSdrh **                     is assumed to already be open.  SRT_Fifo has
24998e1ee88cSdrh **                     the additional property of being able to ignore
25008e1ee88cSdrh **                     the ORDER BY clause.
2501781def29Sdrh **
25028e1ee88cSdrh **     SRT_DistFifo    Store results in a temporary table pDest->iSDParm.
2503340309fdSdrh **                     But also use temporary table pDest->iSDParm+1 as
2504340309fdSdrh **                     a record of all prior results and ignore any duplicate
25058e1ee88cSdrh **                     rows.  Name means:  "Distinct Fifo".
2506781def29Sdrh **
2507781def29Sdrh **     SRT_Queue       Store results in priority queue pDest->iSDParm (really
2508781def29Sdrh **                     an index).  Append a sequence number so that all entries
2509781def29Sdrh **                     are distinct.
2510781def29Sdrh **
2511781def29Sdrh **     SRT_DistQueue   Store results in priority queue pDest->iSDParm only if
2512781def29Sdrh **                     the same record has never been stored before.  The
2513781def29Sdrh **                     index at pDest->iSDParm+1 hold all prior stores.
2514fef5208cSdrh */
251513449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
251613449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
25179ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
25189ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
25198e1ee88cSdrh #define SRT_Fifo         5  /* Store result as data with an automatic rowid */
25208e1ee88cSdrh #define SRT_DistFifo     6  /* Like SRT_Fifo, but unique results only */
25218e1ee88cSdrh #define SRT_Queue        7  /* Store result in an queue */
25228e1ee88cSdrh #define SRT_DistQueue    8  /* Like SRT_Queue, but unique results only */
2523fef5208cSdrh 
252413449892Sdrh /* The ORDER BY clause is ignored for all of the above */
25258e1ee88cSdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
252613449892Sdrh 
25278e1ee88cSdrh #define SRT_Output       9  /* Output each row of result */
25288e1ee88cSdrh #define SRT_Mem         10  /* Store result in a memory cell */
25298e1ee88cSdrh #define SRT_Set         11  /* Store results as keys in an index */
25308e1ee88cSdrh #define SRT_EphemTab    12  /* Create transient tab and store like SRT_Table */
25318e1ee88cSdrh #define SRT_Coroutine   13  /* Generate a single row of result */
25328e1ee88cSdrh #define SRT_Table       14  /* Store result as data with an automatic rowid */
25332282792aSdrh 
25342282792aSdrh /*
2535634d81deSdrh ** An instance of this object describes where to put of the results of
2536634d81deSdrh ** a SELECT statement.
25376c8c8ce0Sdanielk1977 */
25386c8c8ce0Sdanielk1977 struct SelectDest {
2539634d81deSdrh   u8 eDest;            /* How to dispose of the results.  On of SRT_* above. */
2540634d81deSdrh   char affSdst;        /* Affinity used when eDest==SRT_Set */
25412b596da8Sdrh   int iSDParm;         /* A parameter used by the eDest disposal method */
25422b596da8Sdrh   int iSdst;           /* Base register where results are written */
25432b596da8Sdrh   int nSdst;           /* Number of registers allocated */
2544fe1c6bb9Sdrh   ExprList *pOrderBy;  /* Key columns for SRT_Queue and SRT_DistQueue */
25456c8c8ce0Sdanielk1977 };
25466c8c8ce0Sdanielk1977 
25476c8c8ce0Sdanielk1977 /*
25480b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT
25490b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p
25500b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that
25510b9f50d8Sdrh ** the code generator needs.  We have to keep per-table autoincrement
25520b9f50d8Sdrh ** information in case inserts are down within triggers.  Triggers do not
25530b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the
25540b9f50d8Sdrh ** loading and saving of autoincrement information.
25550b9f50d8Sdrh */
25560b9f50d8Sdrh struct AutoincInfo {
25570b9f50d8Sdrh   AutoincInfo *pNext;   /* Next info block in a list of them all */
25580b9f50d8Sdrh   Table *pTab;          /* Table this info block refers to */
25590b9f50d8Sdrh   int iDb;              /* Index in sqlite3.aDb[] of database holding pTab */
25600b9f50d8Sdrh   int regCtr;           /* Memory register holding the rowid counter */
25610b9f50d8Sdrh };
25620b9f50d8Sdrh 
25630b9f50d8Sdrh /*
2564ceea3321Sdrh ** Size of the column cache
2565ceea3321Sdrh */
2566ceea3321Sdrh #ifndef SQLITE_N_COLCACHE
2567ceea3321Sdrh # define SQLITE_N_COLCACHE 10
2568ceea3321Sdrh #endif
2569ceea3321Sdrh 
25702832ad42Sdan /*
25712832ad42Sdan ** At least one instance of the following structure is created for each
25722832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
25732832ad42Sdan ** statement. All such objects are stored in the linked list headed at
25742832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been
25752832ad42Sdan ** completed.
25762832ad42Sdan **
25772832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger
25782832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
25792832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
25802832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same
25812832ad42Sdan ** values for both pTrigger and orconf.
258265a7cd16Sdan **
2583bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
258465a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT
2585bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
2586bb5f168fSdan ** a mask of new.* columns used by the program.
25872832ad42Sdan */
25882832ad42Sdan struct TriggerPrg {
25892832ad42Sdan   Trigger *pTrigger;      /* Trigger this program was coded from */
25902832ad42Sdan   TriggerPrg *pNext;      /* Next entry in Parse.pTriggerPrg list */
2591a451017dSdrh   SubProgram *pProgram;   /* Program implementing pTrigger/orconf */
2592a451017dSdrh   int orconf;             /* Default ON CONFLICT policy */
2593a451017dSdrh   u32 aColmask[2];        /* Masks of old.*, new.* columns accessed */
2594165921a7Sdan };
2595165921a7Sdan 
259664123585Sdrh /*
259764123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases.
259864123585Sdrh */
259901c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30
2600a7ab6d81Sdrh   typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
2601a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)[(I)/8]&(1<<((I)&7)))!=0)
2602a7ab6d81Sdrh # define DbMaskZero(M)      memset((M),0,sizeof(M))
2603a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)[(I)/8]|=(1<<((I)&7))
2604a7ab6d81Sdrh # define DbMaskAllZero(M)   sqlite3DbMaskAllZero(M)
2605a7ab6d81Sdrh # define DbMaskNonZero(M)   (sqlite3DbMaskAllZero(M)==0)
260601c7dc88Sdrh #else
260764123585Sdrh   typedef unsigned int yDbMask;
2608a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)&(((yDbMask)1)<<(I)))!=0)
2609a7ab6d81Sdrh # define DbMaskZero(M)      (M)=0
2610a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)|=(((yDbMask)1)<<(I))
2611a7ab6d81Sdrh # define DbMaskAllZero(M)   (M)==0
2612a7ab6d81Sdrh # define DbMaskNonZero(M)   (M)!=0
261301c7dc88Sdrh #endif
261401c7dc88Sdrh 
2615ceea3321Sdrh /*
2616f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
2617f57b3399Sdrh ** the parser and down into all the parser action routine in order to
2618f57b3399Sdrh ** carry around information that is global to the entire parse.
2619f1974846Sdrh **
2620f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
2621f1974846Sdrh ** generate call themselves recursively, the first part of the structure
2622f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
2623f1974846Sdrh ** each recursion.
2624c00da105Sdanielk1977 **
2625c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
2626c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
2627c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
2628c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
2629c00da105Sdanielk1977 ** list.
263075897234Sdrh */
263175897234Sdrh struct Parse {
26329bb575fdSdrh   sqlite3 *db;         /* The main database structure */
263375897234Sdrh   char *zErrMsg;       /* An error message */
263475897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
2635a451017dSdrh   int rc;              /* Return code from execution */
2636836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
2637a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
2638205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
2639892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
2640a451017dSdrh   u8 isMultiWrite;     /* True if statement may modify/insert multiple rows */
2641a451017dSdrh   u8 mayAbort;         /* True if statement may throw an ABORT exception */
2642d58d3278Sdrh   u8 hasCompound;      /* Need to invoke convertCompoundSelectToSubquery() */
2643aceb31b1Sdrh   u8 okConstFactor;    /* OK to factor out constants */
2644892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
2645892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
2646892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
264775897234Sdrh   int nErr;            /* Number of errors seen */
2648832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
264919a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
2650fef5208cSdrh   int nSet;            /* Number of sets used so far */
26511d8cb21fSdan   int nOnce;           /* Number of OP_Once instructions so far */
265273d5b8f5Sdrh   int nOpAlloc;        /* Number of slots allocated for Vdbe.aOp[] */
265361019c78Sdrh   int iFixedOp;        /* Never back out opcodes iFixedOp-1 or earlier */
2654aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
2655b2b9d3d7Sdrh   int iPartIdxTab;     /* Table corresponding to a partial index */
2656ceea3321Sdrh   int iCacheLevel;     /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
2657ceea3321Sdrh   int iCacheCnt;       /* Counter used to generate aColCache[].lru values */
26587df89c8cSdrh   int nLabel;          /* Number of labels used */
26597df89c8cSdrh   int *aLabel;         /* Space to hold the labels */
26602f7794c1Sdrh   struct yColCache {
2661e55cbd72Sdrh     int iTable;           /* Table cursor number */
26627df89c8cSdrh     i16 iColumn;          /* Table column number */
2663ceea3321Sdrh     u8 tempReg;           /* iReg is a temp register that needs to be freed */
2664ceea3321Sdrh     int iLevel;           /* Nesting level */
2665ceea3321Sdrh     int iReg;             /* Reg with value of this column. 0 means none. */
2666ceea3321Sdrh     int lru;              /* Least recently used entry has the smallest value */
2667ceea3321Sdrh   } aColCache[SQLITE_N_COLCACHE];  /* One for each column cache entry */
2668f30a969bSdrh   ExprList *pConstExpr;/* Constant expressions */
26697df89c8cSdrh   Token constraintName;/* Name of the constraint currently being parsed */
267064123585Sdrh   yDbMask writeMask;   /* Start a write transaction on these databases */
267164123585Sdrh   yDbMask cookieMask;  /* Bitmask of schema verified databases */
2672c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
2673a451017dSdrh   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
2674a451017dSdrh   int regRoot;         /* Register holding root page number for new objects */
2675a451017dSdrh   int nMaxArg;         /* Max args passed to user function by sub-program */
2676abd4c723Sdrh #if SELECTTRACE_ENABLED
2677abd4c723Sdrh   int nSelect;         /* Number of SELECT statements seen */
2678eb9b884cSdrh   int nSelectIndent;   /* How far to indent SELECTTRACE() output */
2679abd4c723Sdrh #endif
2680c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2681c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
2682c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
2683c00da105Sdanielk1977 #endif
26840b9f50d8Sdrh   AutoincInfo *pAinc;  /* Information about AUTOINCREMENT counters */
2685f1974846Sdrh 
2686165921a7Sdan   /* Information used while coding trigger programs. */
268765a7cd16Sdan   Parse *pToplevel;    /* Parse structure for main program (or NULL) */
2688165921a7Sdan   Table *pTriggerTab;  /* Table triggers are being coded for */
2689c6bd4e4aSdrh   int addrCrTab;       /* Address of OP_CreateTable opcode on CREATE TABLE */
26904f402f26Sdrh   u32 nQueryLoop;      /* Est number of iterations of a query (10*log2(N)) */
269165a7cd16Sdan   u32 oldmask;         /* Mask of old.* columns referenced */
2692bb5f168fSdan   u32 newmask;         /* Mask of new.* columns referenced */
269365a7cd16Sdan   u8 eTriggerOp;       /* TK_UPDATE, TK_INSERT or TK_DELETE */
269465a7cd16Sdan   u8 eOrconf;          /* Default ON CONFLICT policy for trigger steps */
2695d66c8309Sdan   u8 disableTriggers;  /* True to disable triggers */
2696165921a7Sdan 
26977df89c8cSdrh   /************************************************************************
26987df89c8cSdrh   ** Above is constant between recursions.  Below is reset before and after
26997df89c8cSdrh   ** each recursion.  The boundary between these two regions is determined
27007df89c8cSdrh   ** using offsetof(Parse,nVar) so the nVar field must be the first field
27017df89c8cSdrh   ** in the recursive region.
27027df89c8cSdrh   ************************************************************************/
2703f1974846Sdrh 
2704f1974846Sdrh   int nVar;                 /* Number of '?' variables seen in the SQL so far */
2705124c0b49Sdrh   int nzVar;                /* Number of available slots in azVar[] */
27067f9c5dbfSdrh   u8 iPkSortOrder;          /* ASC or DESC for INTEGER PRIMARY KEY */
27077df89c8cSdrh   u8 bFreeWith;             /* True if pWith should be freed with parser */
2708a451017dSdrh   u8 explain;               /* True if the EXPLAIN flag is found on the query */
2709a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2710a451017dSdrh   u8 declareVtab;           /* True if inside sqlite3_declare_vtab() */
2711a451017dSdrh   int nVtabLock;            /* Number of virtual tables to lock */
2712a451017dSdrh #endif
2713a451017dSdrh   int nAlias;               /* Number of aliased result set columns */
2714a451017dSdrh   int nHeight;              /* Expression tree height of current sub-select */
2715a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN
2716a451017dSdrh   int iSelectId;            /* ID of current select for EXPLAIN output */
2717a451017dSdrh   int iNextSelectId;        /* Next available select ID for EXPLAIN output */
2718a451017dSdrh #endif
2719124c0b49Sdrh   char **azVar;             /* Pointers to names of parameters */
2720937d0deaSdan   Vdbe *pReprepare;         /* VM being reprepared (sqlite3Reprepare()) */
2721f1974846Sdrh   const char *zTail;        /* All SQL text past the last semicolon parsed */
2722f1974846Sdrh   Table *pNewTable;         /* A table being constructed by CREATE TABLE */
2723f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
2724f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
2725a451017dSdrh   Token sNameToken;         /* Token with unqualified schema object name */
2726a451017dSdrh   Token sLastToken;         /* The last token parsed */
2727b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
272833b3933cSdanielk1977   Token sArg;               /* Complete text of a module argument */
27294f3dd150Sdrh   Table **apVtabLock;       /* Pointer to virtual tables needing locking */
2730b9bb7c18Sdrh #endif
2731588a9a1aSdrh   Table *pZombieTab;        /* List of Table objects to delete after code gen */
27322832ad42Sdan   TriggerPrg *pTriggerPrg;  /* Linked list of coded triggers */
27334e9119d9Sdan   With *pWith;              /* Current WITH clause, or NULL */
273475897234Sdrh };
273575897234Sdrh 
2736a451017dSdrh /*
2737a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call.
2738a451017dSdrh */
27397e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
27407e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
27417e6ebfb2Sdanielk1977 #else
27427e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
27437e6ebfb2Sdanielk1977 #endif
27447e6ebfb2Sdanielk1977 
2745d99bc930Sdanielk1977 /*
274685e2096fSdrh ** An instance of the following structure can be declared on a stack and used
274785e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
274885e2096fSdrh */
274985e2096fSdrh struct AuthContext {
275085e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
275185e2096fSdrh   Parse *pParse;              /* The Parse structure */
275285e2096fSdrh };
275385e2096fSdrh 
275485e2096fSdrh /*
2755a748fdccSdrh ** Bitfield flags for P5 value in various opcodes.
2756b0c374ffSrdc */
27573e9ca094Sdrh #define OPFLAG_NCHANGE       0x01    /* Set to update db->nChange */
275897348b37Sdrh #define OPFLAG_EPHEM         0x01    /* OP_Column: Ephemeral output is ok */
27593e9ca094Sdrh #define OPFLAG_LASTROWID     0x02    /* Set to update db->lastRowid */
27603e9ca094Sdrh #define OPFLAG_ISUPDATE      0x04    /* This OP_Insert is an sql UPDATE */
27613e9ca094Sdrh #define OPFLAG_APPEND        0x08    /* This is likely to be an append */
27623e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10    /* Try to avoid a seek in BtreeInsert() */
2763a748fdccSdrh #define OPFLAG_LENGTHARG     0x40    /* OP_Column only used for length() */
2764a748fdccSdrh #define OPFLAG_TYPEOFARG     0x80    /* OP_Column only used for typeof() */
2765428c218cSdan #define OPFLAG_BULKCSR       0x01    /* OP_Open** used to open bulk cursor */
2766e0997b34Sdrh #define OPFLAG_SEEKEQ        0x02    /* OP_Open** cursor uses EQ seek only */
2767e0997b34Sdrh #define OPFLAG_P2ISREG       0x04    /* P2 to OP_Open** is a register number */
2768953f7611Sdrh #define OPFLAG_PERMUTE       0x01    /* OP_Compare: use the permutation */
2769b0c374ffSrdc 
2770b0c374ffSrdc /*
2771d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
2772d99bc930Sdanielk1977  * struct Trigger.
2773d99bc930Sdanielk1977  *
2774d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
27759bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
2776d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
2777d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
2778ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
2779ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
2780ad3cab52Sdrh  *    struct Table.
2781d99bc930Sdanielk1977  *
2782ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
2783ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
2784d99bc930Sdanielk1977  */
2785d99bc930Sdanielk1977 struct Trigger {
2786165921a7Sdan   char *zName;            /* The name of the trigger                        */
2787d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
2788f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
2789dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
2790467bcf36Sshane   Expr *pWhen;            /* The WHEN clause of the expression (may be NULL) */
2791d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
2792d99bc930Sdanielk1977                              the <column-list> is stored here */
2793e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
2794e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
2795d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
2796d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
2797c3f9bad2Sdanielk1977 };
2798d99bc930Sdanielk1977 
2799d99bc930Sdanielk1977 /*
2800dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
2801dca76841Sdrh ** determine which.
2802dca76841Sdrh **
2803dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
2804dca76841Sdrh ** In that cases, the constants below can be ORed together.
2805dca76841Sdrh */
2806dca76841Sdrh #define TRIGGER_BEFORE  1
2807dca76841Sdrh #define TRIGGER_AFTER   2
2808dca76841Sdrh 
2809dca76841Sdrh /*
2810d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
2811d99bc930Sdanielk1977  * that is a part of a trigger-program.
2812d99bc930Sdanielk1977  *
2813d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
2814d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
2815d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
2816d99bc930Sdanielk1977  * the first step of the trigger-program.
2817d99bc930Sdanielk1977  *
2818d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
2819d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
2820d99bc930Sdanielk1977  * value of "op" as follows:
2821d99bc930Sdanielk1977  *
2822d99bc930Sdanielk1977  * (op == TK_INSERT)
2823d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
2824d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
2825d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
282646408354Sdan  * zTarget   -> Dequoted name of the table to insert into.
2827d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
2828d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
2829d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
2830ad3cab52Sdrh  *              statement, then this stores the column-names to be
2831ad3cab52Sdrh  *              inserted into.
2832d99bc930Sdanielk1977  *
2833d99bc930Sdanielk1977  * (op == TK_DELETE)
283446408354Sdan  * zTarget   -> Dequoted name of the table to delete from.
2835d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
2836d99bc930Sdanielk1977  *              Otherwise NULL.
2837d99bc930Sdanielk1977  *
2838d99bc930Sdanielk1977  * (op == TK_UPDATE)
283946408354Sdan  * zTarget   -> Dequoted name of the table to update.
2840d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
2841d99bc930Sdanielk1977  *              Otherwise NULL.
2842d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
28434adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
2844ad3cab52Sdrh  *              argument.
2845d99bc930Sdanielk1977  *
2846d99bc930Sdanielk1977  */
2847c3f9bad2Sdanielk1977 struct TriggerStep {
2848b1819a0bSdrh   u8 op;               /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
2849b1819a0bSdrh   u8 orconf;           /* OE_Rollback etc. */
2850a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
285146408354Sdan   Select *pSelect;     /* SELECT statement or RHS of INSERT INTO SELECT ... */
285246408354Sdan   char *zTarget;       /* Target table for DELETE, UPDATE, INSERT */
2853b1819a0bSdrh   Expr *pWhere;        /* The WHERE clause for DELETE or UPDATE steps */
285475593d96Sdrh   ExprList *pExprList; /* SET clause for UPDATE. */
2855b1819a0bSdrh   IdList *pIdList;     /* Column names for INSERT */
2856c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
2857187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
2858c3f9bad2Sdanielk1977 };
2859c3f9bad2Sdanielk1977 
2860d99bc930Sdanielk1977 /*
2861f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
2862f26e09c8Sdrh ** routines as they walk the parse tree to make database references
2863f26e09c8Sdrh ** explicit.
2864f26e09c8Sdrh */
2865f26e09c8Sdrh typedef struct DbFixer DbFixer;
2866f26e09c8Sdrh struct DbFixer {
2867f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
286841fb5cd1Sdan   Schema *pSchema;    /* Fix items to this schema */
286946539d7cSdan   int bVarOnly;       /* Check for variable references only */
2870f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
2871f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
2872f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
2873f26e09c8Sdrh };
2874f26e09c8Sdrh 
2875f26e09c8Sdrh /*
2876ade86483Sdrh ** An objected used to accumulate the text of a string where we
2877ade86483Sdrh ** do not necessarily know how big the string will be in the end.
2878ade86483Sdrh */
2879ade86483Sdrh struct StrAccum {
2880633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
2881ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
2882ade86483Sdrh   char *zText;         /* The string collected so far */
2883ade86483Sdrh   int  nChar;          /* Length of the string so far */
2884ade86483Sdrh   int  nAlloc;         /* Amount of space allocated in zText */
2885c0490572Sdrh   int  mxAlloc;        /* Maximum allowed allocation.  0 for no malloc usage */
2886b49bc86aSdrh   u8   accError;       /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
2887ade86483Sdrh };
2888b49bc86aSdrh #define STRACCUM_NOMEM   1
2889b49bc86aSdrh #define STRACCUM_TOOBIG  2
2890ade86483Sdrh 
2891ade86483Sdrh /*
2892234c39dfSdrh ** A pointer to this structure is used to communicate information
2893234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2894234c39dfSdrh */
2895234c39dfSdrh typedef struct {
28969bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
2897234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
2898a451017dSdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
289915ca1df1Sdrh   int rc;             /* Result code stored here */
2900234c39dfSdrh } InitData;
2901234c39dfSdrh 
2902b6c29897Sdrh /*
290340257ffdSdrh ** Structure containing global configuration data for the SQLite library.
290433589797Sdrh **
290533589797Sdrh ** This structure also contains some state information.
290640257ffdSdrh */
290740257ffdSdrh struct Sqlite3Config {
2908fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
2909fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
2910fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
2911cd74b611Sdan   int bOpenUri;                     /* True to interpret filenames as URIs */
2912de9a7b8aSdrh   int bUseCis;                      /* Use covering indices for full-scans */
29130a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
291409fe6143Sdrh   int neverCorrupt;                 /* Database is always well-formed */
2915633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
2916633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
2917fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
29186d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
291922e21ff4Sdan   sqlite3_pcache_methods2 pcache2;  /* Low-level page-cache interface */
292040257ffdSdrh   void *pHeap;                      /* Heap storage space */
292133589797Sdrh   int nHeap;                        /* Size of pHeap[] */
292233589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
29239b4c59faSdrh   sqlite3_int64 szMmap;             /* mmap() space per open file */
29249b4c59faSdrh   sqlite3_int64 mxMmap;             /* Maximum value for szMmap */
292533589797Sdrh   void *pScratch;                   /* Scratch memory */
292633589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
292733589797Sdrh   int nScratch;                     /* Number of scratch buffers */
292833589797Sdrh   void *pPage;                      /* Page cache memory */
292933589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
293033589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
29311875f7a3Sdrh   int mxParserStack;                /* maximum depth of the parser stack */
29321875f7a3Sdrh   int sharedCacheEnabled;           /* true if shared-cache mode enabled */
29333bd1791dSdrh   u32 szPma;                        /* Maximum Sorter PMA size */
29341875f7a3Sdrh   /* The above might be initialized to non-zero.  The following need to always
29351875f7a3Sdrh   ** initially be zero, however. */
293671bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
2937502b4e00Sdanielk1977   int inProgress;                   /* True while initialization in progress */
2938e1ab2193Sdan   int isMutexInit;                  /* True after mutexes are initialized */
293971bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
2940e1ab2193Sdan   int isPCacheInit;                 /* True after malloc is initialized */
294193ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
2942c007f61bSdrh   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
29433f280701Sdrh   void (*xLog)(void*,int,const char*); /* Function for logging */
29443f280701Sdrh   void *pLogArg;                       /* First argument to xLog() */
2945ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG
2946ac455939Sdan   void(*xSqllog)(void*,sqlite3*,const char*, int);
2947ac455939Sdan   void *pSqllogArg;
2948ac455939Sdan #endif
2949688852abSdrh #ifdef SQLITE_VDBE_COVERAGE
2950688852abSdrh   /* The following callback (if not NULL) is invoked on every VDBE branch
2951688852abSdrh   ** operation.  Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
2952688852abSdrh   */
2953688852abSdrh   void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx);  /* Callback */
2954688852abSdrh   void *pVdbeBranchArg;                                     /* 1st argument */
2955688852abSdrh #endif
2956c007f61bSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
2957c007f61bSdrh   int (*xTestCallback)(int);        /* Invoked by sqlite3FaultSim() */
2958c007f61bSdrh #endif
2959c007f61bSdrh   int bLocaltimeFault;              /* True to fail localtime() calls */
296040257ffdSdrh };
296140257ffdSdrh 
296240257ffdSdrh /*
296309fe6143Sdrh ** This macro is used inside of assert() statements to indicate that
296409fe6143Sdrh ** the assert is only valid on a well-formed database.  Instead of:
296509fe6143Sdrh **
296609fe6143Sdrh **     assert( X );
296709fe6143Sdrh **
296809fe6143Sdrh ** One writes:
296909fe6143Sdrh **
2970b2023665Sdrh **     assert( X || CORRUPT_DB );
297109fe6143Sdrh **
2972b2023665Sdrh ** CORRUPT_DB is true during normal operation.  CORRUPT_DB does not indicate
2973b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt.
2974b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special
2975b2023665Sdrh ** sqlite3_test_control().  This enables assert() statements to prove
2976b2023665Sdrh ** things that are always true for well-formed databases.
297709fe6143Sdrh */
2978b2023665Sdrh #define CORRUPT_DB  (sqlite3Config.neverCorrupt==0)
297909fe6143Sdrh 
298009fe6143Sdrh /*
29817d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
29827d10d5a6Sdrh */
29837d10d5a6Sdrh struct Walker {
29847d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
29857d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
2986b290f117Sdan   void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
29877d10d5a6Sdrh   Parse *pParse;                            /* Parser context.  */
2988030796dfSdrh   int walkerDepth;                          /* Number of subqueries */
2989059b2d50Sdrh   u8 eCode;                                 /* A small processing code */
29907d10d5a6Sdrh   union {                                   /* Extra data for callback */
29917d10d5a6Sdrh     NameContext *pNC;                          /* Naming context */
2992059b2d50Sdrh     int n;                                     /* A counter */
2993059b2d50Sdrh     int iCur;                                  /* A cursor number */
2994374fdce4Sdrh     SrcList *pSrcList;                         /* FROM clause */
2995030796dfSdrh     struct SrcCount *pSrcCount;                /* Counting column references */
29967d10d5a6Sdrh   } u;
29977d10d5a6Sdrh };
29987d10d5a6Sdrh 
29997d10d5a6Sdrh /* Forward declarations */
30007d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
30017d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
30027d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
30037d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
30047d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
30057d10d5a6Sdrh 
30067d10d5a6Sdrh /*
30077d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
30087d10d5a6Sdrh ** callbacks.
30097d10d5a6Sdrh */
30102bf90f1eSdrh #define WRC_Continue    0   /* Continue down into children */
30112bf90f1eSdrh #define WRC_Prune       1   /* Omit children but continue walking siblings */
30122bf90f1eSdrh #define WRC_Abort       2   /* Abandon the tree walk */
30137d10d5a6Sdrh 
30147d10d5a6Sdrh /*
3015eae73fbfSdan ** An instance of this structure represents a set of one or more CTEs
3016c49832c2Sdrh ** (common table expressions) created by a single WITH clause.
30177d562dbeSdan */
30187d562dbeSdan struct With {
3019c49832c2Sdrh   int nCte;                       /* Number of CTEs in the WITH clause */
30204e9119d9Sdan   With *pOuter;                   /* Containing WITH clause, or NULL */
3021c49832c2Sdrh   struct Cte {                    /* For each CTE in the WITH clause.... */
30224e9119d9Sdan     char *zName;                    /* Name of this CTE */
30234e9119d9Sdan     ExprList *pCols;                /* List of explicit column names, or NULL */
3024c49832c2Sdrh     Select *pSelect;                /* The definition of this CTE */
3025f2655fe8Sdan     const char *zErr;               /* Error message for circular references */
30267d562dbeSdan   } a[1];
30277d562dbeSdan };
30287d562dbeSdan 
30294fa4a54fSdrh #ifdef SQLITE_DEBUG
30304fa4a54fSdrh /*
30314fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of
30324fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view.
30334fa4a54fSdrh */
30344fa4a54fSdrh struct TreeView {
30354fa4a54fSdrh   int iLevel;             /* Which level of the tree we are on */
3036b08cd3f3Sdrh   u8  bLine[100];         /* Draw vertical in column i if bLine[i] is true */
30374fa4a54fSdrh };
30384fa4a54fSdrh #endif /* SQLITE_DEBUG */
30394fa4a54fSdrh 
30407d562dbeSdan /*
304166150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
304266150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
30434a919118Sdrh */
30444a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
30454a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
30464a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
30474a919118Sdrh   }                                                    \
30484a919118Sdrh }
30494a919118Sdrh 
30504a919118Sdrh /*
30519978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with
30529978c97eSdrh ** the same name but without the _BKPT suffix.  These macros invoke
30539978c97eSdrh ** routines that report the line-number on which the error originated
30549978c97eSdrh ** using sqlite3_log().  The routines also provide a convenient place
30559978c97eSdrh ** to set a debugger breakpoint.
305649285708Sdrh */
30579978c97eSdrh int sqlite3CorruptError(int);
30589978c97eSdrh int sqlite3MisuseError(int);
30599978c97eSdrh int sqlite3CantopenError(int);
30609978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
30619978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
30629978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
30639978c97eSdrh 
306449285708Sdrh 
306549285708Sdrh /*
3066b4a1fed2Sdrh ** FTS4 is really an extension for FTS3.  It is enabled using the
306760ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro.  But to avoid confusion we also call
306860ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
3069b4a1fed2Sdrh */
3070b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
30710ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1
3072b4a1fed2Sdrh #endif
3073b4a1fed2Sdrh 
3074b4a1fed2Sdrh /*
307579f02cefSdrh ** The ctype.h header is needed for non-ASCII systems.  It is also
307679f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation.
307779f02cefSdrh */
307879f02cefSdrh #if !defined(SQLITE_ASCII) || \
307979f02cefSdrh     (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
308079f02cefSdrh # include <ctype.h>
308179f02cefSdrh #endif
308279f02cefSdrh 
308379f02cefSdrh /*
308478ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(),
308578ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
308678ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale.
308778ca0e7eSdanielk1977 */
308878ca0e7eSdanielk1977 #ifdef SQLITE_ASCII
308978ca0e7eSdanielk1977 # define sqlite3Toupper(x)  ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
309078ca0e7eSdanielk1977 # define sqlite3Isspace(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
3091dc86e2b2Sdrh # define sqlite3Isalnum(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
3092dc86e2b2Sdrh # define sqlite3Isalpha(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
309378ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
309478ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
309578ca0e7eSdanielk1977 # define sqlite3Tolower(x)   (sqlite3UpperToLower[(unsigned char)(x)])
309678ca0e7eSdanielk1977 #else
309778ca0e7eSdanielk1977 # define sqlite3Toupper(x)   toupper((unsigned char)(x))
309878ca0e7eSdanielk1977 # define sqlite3Isspace(x)   isspace((unsigned char)(x))
309978ca0e7eSdanielk1977 # define sqlite3Isalnum(x)   isalnum((unsigned char)(x))
3100dc86e2b2Sdrh # define sqlite3Isalpha(x)   isalpha((unsigned char)(x))
310178ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   isdigit((unsigned char)(x))
310278ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  isxdigit((unsigned char)(x))
310378ca0e7eSdanielk1977 # define sqlite3Tolower(x)   tolower((unsigned char)(x))
310478ca0e7eSdanielk1977 #endif
3105f5ed7ad6Sdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
310697348b37Sdrh int sqlite3IsIdChar(u8);
3107f5ed7ad6Sdrh #endif
310878ca0e7eSdanielk1977 
310978ca0e7eSdanielk1977 /*
311075897234Sdrh ** Internal function prototypes
311175897234Sdrh */
31123fa97302Sdrh #define sqlite3StrICmp sqlite3_stricmp
3113ea678832Sdrh int sqlite3Strlen30(const char*);
3114ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp
31152e588c75Sdanielk1977 
311640257ffdSdrh int sqlite3MallocInit(void);
3117fec00eabSdrh void sqlite3MallocEnd(void);
3118da4ca9d1Sdrh void *sqlite3Malloc(u64);
3119da4ca9d1Sdrh void *sqlite3MallocZero(u64);
3120da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64);
3121da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64);
312217435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
3123da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
3124da4ca9d1Sdrh void *sqlite3Realloc(void*, u64);
3125da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
3126da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64);
3127633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
3128a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
3129633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
3130facf0307Sdrh void *sqlite3ScratchMalloc(int);
3131facf0307Sdrh void sqlite3ScratchFree(void*);
3132facf0307Sdrh void *sqlite3PageMalloc(int);
3133facf0307Sdrh void sqlite3PageFree(void*);
3134fec00eabSdrh void sqlite3MemSetDefault(void);
3135f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
3136171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
3137f5ed7ad6Sdrh #endif
313850d1b5f3Sdrh int sqlite3HeapNearlyFull(void);
31392e588c75Sdanielk1977 
3140e7b34707Sdrh /*
3141e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make
3142e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects.  By default,
3143e7b34707Sdrh ** obtain space from malloc().
3144e7b34707Sdrh **
3145e7b34707Sdrh ** The alloca() routine never returns NULL.  This will cause code paths
3146e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable.
3147e7b34707Sdrh */
3148e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA
3149e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   alloca(N)
3150e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  memset(alloca(N), 0, N)
3151e7b34707Sdrh # define sqlite3StackFree(D,P)
3152e7b34707Sdrh #else
3153e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   sqlite3DbMallocRaw(D,N)
3154e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  sqlite3DbMallocZero(D,N)
3155e7b34707Sdrh # define sqlite3StackFree(D,P)       sqlite3DbFree(D,P)
3156e7b34707Sdrh #endif
3157e7b34707Sdrh 
3158f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS3
3159f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
3160f3d3c27aSdanielk1977 #endif
3161f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5
3162f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
3163f3d3c27aSdanielk1977 #endif
3164f3d3c27aSdanielk1977 
3165f3d3c27aSdanielk1977 
316618472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT
3167558814f8Sdan   sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
3168558814f8Sdan   sqlite3_mutex_methods const *sqlite3NoopMutex(void);
316959f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
3170d025174fSdanielk1977   int sqlite3MutexInit(void);
3171d025174fSdanielk1977   int sqlite3MutexEnd(void);
317265bbf29eSdrh #endif
31736d2ab0e4Sdanielk1977 
3174af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int);
3175af89fe66Sdrh void sqlite3StatusUp(int, int);
3176af89fe66Sdrh void sqlite3StatusDown(int, int);
3177f7141990Sdrh void sqlite3StatusSet(int, int);
3178f7141990Sdrh 
3179af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */
3180af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void);
3181af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void);
3182af89fe66Sdrh 
318385c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
31840de3ae95Sdrh   int sqlite3IsNaN(double);
318585c8f291Sdrh #else
318685c8f291Sdrh # define sqlite3IsNaN(X)  0
318785c8f291Sdrh #endif
31880de3ae95Sdrh 
3189a5c1416dSdrh /*
3190a5c1416dSdrh ** An instance of the following structure holds information about SQL
3191a5c1416dSdrh ** functions arguments that are the parameters to the printf() function.
3192a5c1416dSdrh */
3193a5c1416dSdrh struct PrintfArguments {
3194a5c1416dSdrh   int nArg;                /* Total number of arguments */
3195a5c1416dSdrh   int nUsed;               /* Number of arguments used so far */
3196a5c1416dSdrh   sqlite3_value **apArg;   /* The argument values */
3197a5c1416dSdrh };
3198a5c1416dSdrh 
3199a5c1416dSdrh #define SQLITE_PRINTF_INTERNAL 0x01
3200a5c1416dSdrh #define SQLITE_PRINTF_SQLFUNC  0x02
3201a5c1416dSdrh void sqlite3VXPrintf(StrAccum*, u32, const char*, va_list);
3202a5c1416dSdrh void sqlite3XPrintf(StrAccum*, u32, const char*, ...);
320317435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
320417435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
320502b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
3206e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
3207d919fe17Sdrh #endif
3208d919fe17Sdrh #if defined(SQLITE_TEST)
3209e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
321087cc3b31Sdrh #endif
32117e02e5e6Sdrh 
32124fa4a54fSdrh #if defined(SQLITE_DEBUG)
32134fa4a54fSdrh   void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
32144fa4a54fSdrh   void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
32154fa4a54fSdrh   void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
32167e02e5e6Sdrh #endif
32177e02e5e6Sdrh 
32187e02e5e6Sdrh 
321922c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*);
32204adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
322124fb627aSdrh int sqlite3Dequote(char*);
32222646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
32234adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
322480242055Sdrh void sqlite3FinishCoding(Parse*);
3225892d3179Sdrh int sqlite3GetTempReg(Parse*);
3226892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
3227892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
3228892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
3229cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*);
3230b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
3231b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*);
3232b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
323317435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
32341e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
323517435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
3236fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
3237633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
3238b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
3239b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
3240b7916a78Sdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
3241633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
32422308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*);
32439bb575fdSdrh int sqlite3Init(sqlite3*, char**);
3244234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
324591cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
324681028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*);
324781028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int);
324881028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*);
32494adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
32509bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
32517d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
3252c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
32534415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*);
32544415628aSdrh i16 sqlite3ColumnOfIndex(Index*, i16);
3255f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
32564adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
32574adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
3258fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
3259ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
3260487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
3261b7916a78Sdrh void sqlite3AddDefaultValue(Parse*,ExprSpan*);
326239002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
32635969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
3264522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*,
3265522c26fbSdrh                     sqlite3_vfs**,char**,char **);
3266421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
32671d8cb21fSdan int sqlite3CodeOnce(Parse *);
3268b7f9164eSdrh 
3269c007f61bSdrh #ifdef SQLITE_OMIT_BUILTIN_TEST
3270c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK
3271c007f61bSdrh #else
3272c007f61bSdrh   int sqlite3FaultSim(int);
3273c007f61bSdrh #endif
3274c007f61bSdrh 
3275f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
3276f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
327782ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32);
3278f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
3279e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*);
3280f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
3281bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*);
3282f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
32833088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
3284f5ed7ad6Sdrh #endif
3285f5e7bb51Sdrh 
32863d4501e5Sdrh RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
32873d4501e5Sdrh void sqlite3RowSetClear(RowSet*);
32883d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64);
3289d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64);
32903d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*);
32913d4501e5Sdrh 
3292fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
3293fe3fcbe2Sdanielk1977 
3294fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
32954adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
3296b7f9164eSdrh #else
3297b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
3298b7f9164eSdrh #endif
3299b7f9164eSdrh 
3300a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30
3301a7ab6d81Sdrh   int sqlite3DbMaskAllZero(yDbMask);
3302a7ab6d81Sdrh #endif
3303a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
3304faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int);
33051feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*);
33060b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT
33070b9f50d8Sdrh   void sqlite3AutoincrementBegin(Parse *pParse);
33080b9f50d8Sdrh   void sqlite3AutoincrementEnd(Parse *pParse);
33090b9f50d8Sdrh #else
33100b9f50d8Sdrh # define sqlite3AutoincrementBegin(X)
33110b9f50d8Sdrh # define sqlite3AutoincrementEnd(X)
33120b9f50d8Sdrh #endif
331375593d96Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int);
33146c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
331517435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
33164adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
3317a78c22c4Sdrh SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
331817435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
3319b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
332085574e31Sdanielk1977                                       Token*, Select*, Expr*, IdList*);
3321b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
3322b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
332361dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
33244adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
3325633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
3326633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
3327bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
33281da40a38Sdan Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
33298a9789b6Sdrh                           Expr*, int, int);
33304d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
33317d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
333217435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
3333832ee3d4Sdrh                          Expr*,ExprList*,u16,Expr*,Expr*);
3334633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
33354adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
33364adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
3337c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
3338273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
333949ffdbf4Sshane Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,Expr*,char*);
33404281bd42Sshane #endif
33414adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
33424adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
334346ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
33444adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
3345c63367efSdrh u64 sqlite3WhereOutputRowCount(WhereInfo*);
33466f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*);
33476f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*);
3348374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*);
33496f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*);
33506f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*);
3351fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*);
3352a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
33535c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
3354b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
3355ceea3321Sdrh void sqlite3ExprCacheStore(Parse*, int, int, int);
3356ceea3321Sdrh void sqlite3ExprCachePush(Parse*);
3357d2490904Sdrh void sqlite3ExprCachePop(Parse*);
3358f49f3523Sdrh void sqlite3ExprCacheRemove(Parse*, int, int);
3359ceea3321Sdrh void sqlite3ExprCacheClear(Parse*);
3360da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
336105a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int);
336205a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
3363d673cddaSdrh void sqlite3ExprCodeAtInit(Parse*, Expr*, int, u8);
33642dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
3365678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
336605a86c5cSdrh void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
3367d1a01edaSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, u8);
3368d1a01edaSdrh #define SQLITE_ECEL_DUP      0x01  /* Deep, not shallow copies */
3369d1a01edaSdrh #define SQLITE_ECEL_FACTOR   0x02  /* Factor out constant terms */
33704adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
33714adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
337272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
33739bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
3374ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
337541fb5cd1Sdan Table *sqlite3LocateTableItem(Parse*,int isView,struct SrcList_item *);
33769bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
33779bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
33789bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
337974161705Sdrh void sqlite3Vacuum(Parse*);
33809bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
338117435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
3382619a1305Sdrh int sqlite3ExprCompare(Expr*, Expr*, int);
3383619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int);
33844bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr*, Expr*, int);
3385d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
3386d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
3387030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
33884adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
3389f5ed7ad6Sdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
33902fa1868fSdrh void sqlite3PrngSaveState(void);
33912fa1868fSdrh void sqlite3PrngRestoreState(void);
3392f5ed7ad6Sdrh #endif
33930f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int);
33944adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
339557966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
3396684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
33974adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
33984adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
3399fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*);
3400fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *);
34014245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
34024adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
34030a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
3404feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8);
3405059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int);
34064adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
3407039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*);
3408039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
34094adee20fSdanielk1977 int sqlite3IsRowid(const char*);
3410392ee21dSdrh void sqlite3GenerateRowDelete(Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8);
341126198bb4Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*);
34121c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
341387744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int);
3414f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
3415f8ffb278Sdrh                                      u8,u8,int,int*);
341626198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
34176a53499aSdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int, u8*, int*, int*);
34184adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
3419ff738bceSdrh void sqlite3MultiWrite(Parse*);
3420e0af83acSdan void sqlite3MayAbort(Parse*);
3421f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
3422f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*);
3423f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*);
34246ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
34256ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
34266ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
342717435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
34286ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int);
3429eb9b884cSdrh #if SELECTTRACE_ENABLED
3430eb9b884cSdrh void sqlite3SelectSetName(Select*,const char*);
3431eb9b884cSdrh #else
3432eb9b884cSdrh # define sqlite3SelectSetName(A,B)
3433eb9b884cSdrh #endif
343470a8ca3cSdrh void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
343589d5d6a2Sdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,u8);
34369bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
3437777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
343870a8ca3cSdrh void sqlite3RegisterGlobalFunctions(void);
34397e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
34407e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
34419cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
3442fa4e62f3Sshane 
3443fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
34442a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
3445fa4e62f3Sshane #endif
3446b7f9164eSdrh 
3447b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
3448ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
344960218d2aSdrh                            Expr*,int, int);
34504adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
3451fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
345274161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
34532f886d1dSdanielk1977   Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
34542f886d1dSdanielk1977   Trigger *sqlite3TriggerList(Parse *, Table *);
3455165921a7Sdan   void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
345694d7f50aSdan                             int, int, int);
34571da40a38Sdan   void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
3458dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
3459633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
346017435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
346117435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
346275593d96Sdrh                                         Select*,u8);
34635eff7cf0Sshane   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
346417435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
3465633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
3466b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
3467bb5f168fSdan   u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
346865a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
3469b7f9164eSdrh #else
347062c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0
3471633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
3472cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
3473b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
347494d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
347575cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
34762943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0
347765a7cd16Sdan # define sqlite3ParseToplevel(p) p
3478bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
3479b7f9164eSdrh #endif
3480b7f9164eSdrh 
34814adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
34820202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
34834adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
3484ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
3485728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
34864adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
34874adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
34884adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
348902470b20Sdan   int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
3490ed6c8671Sdrh #else
3491b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
34924adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
34934adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
34944adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
3495ed6c8671Sdrh #endif
3496f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
3497f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
3498d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
34994adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
35004adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
35014adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
35024adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
35034adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
35049339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8);
3505fec19aadSdrh int sqlite3GetInt32(const char *, int*);
350660ac3f42Sdrh int sqlite3Atoi(const char*);
3507ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
3508ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
350942610961Sdrh u32 sqlite3Utf8Read(const u8**);
3510bf539c4dSdrh LogEst sqlite3LogEst(u64);
3511bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst);
3512bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3513bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double);
3514bf539c4dSdrh #endif
3515bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst);
35163f8d5cfcSshane 
35173f8d5cfcSshane /*
35183f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
35193f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
35202f2b2b85Sdrh ** file.
35213f8d5cfcSshane */
3522192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
35231bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *);
35241bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *);
3525192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
35263f8d5cfcSshane 
35273f8d5cfcSshane /*
35282f2b2b85Sdrh ** The common case is for a varint to be a single byte.  They following
35292f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call
35302f2b2b85Sdrh ** the procedure for larger varints.
35313f8d5cfcSshane */
35324bde3702Sdrh #define getVarint32(A,B)  \
35334bde3702Sdrh   (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
35344bde3702Sdrh #define putVarint32(A,B)  \
35354bde3702Sdrh   (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
35362f2b2b85Sdrh   sqlite3PutVarint((A),(B)))
35373f8d5cfcSshane #define getVarint    sqlite3GetVarint
35383f8d5cfcSshane #define putVarint    sqlite3PutVarint
35393f8d5cfcSshane 
35403f8d5cfcSshane 
354169f8bb9cSdan const char *sqlite3IndexAffinityStr(Vdbe *, Index *);
354257bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int);
3543e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
3544e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
3545bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
35469339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8);
35479296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*);
354813f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
354913f40da3Sdrh void sqlite3Error(sqlite3*,int);
3550ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
3551cd74b611Sdan u8 sqlite3HexToInt(int h);
3552ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
3553dd08ca0fSmistachkin 
35545824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME)
3555f2c1c99fSmistachkin const char *sqlite3ErrName(int);
3556dd08ca0fSmistachkin #endif
3557dd08ca0fSmistachkin 
3558f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
35598a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
3560c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
3561c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
35627cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
356380103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
35640a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
35650a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*);
35667cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
3567d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
3568b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
3569158b9cb9Sdrh int sqlite3AddInt64(i64*,i64);
3570158b9cb9Sdrh int sqlite3SubInt64(i64*,i64);
3571158b9cb9Sdrh int sqlite3MulInt64(i64*,i64);
3572d50ffc41Sdrh int sqlite3AbsInt32(int);
357381cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES
357481cc5163Sdrh void sqlite3FileSuffix3(const char*, char*);
357581cc5163Sdrh #else
357681cc5163Sdrh # define sqlite3FileSuffix3(X,Y)
357781cc5163Sdrh #endif
3578eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8);
35794e6af134Sdanielk1977 
3580b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
3581b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
3582b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
35831e536953Sdanielk1977                         void(*)(void*));
3584a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*);
35854e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
35861e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
3587b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
35881e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
3589b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
359046c99e0fSdrh #ifndef SQLITE_AMALGAMATION
3591a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[];
35924e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
359378ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[];
3594094430ebSdrh extern const Token sqlite3IntTokens[];
3595075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
3596075c23afSdanielk1977 extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
3597f83dc1efSdrh #ifndef SQLITE_OMIT_WSD
3598ddb68e17Sdrh extern int sqlite3PendingByte;
359946c99e0fSdrh #endif
3600f83dc1efSdrh #endif
3601cdf011dcSdrh void sqlite3RootPageMoved(sqlite3*, int, int, int);
36024343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
3603545f587fSdrh void sqlite3AlterFunctions(void);
36049fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
36059fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
36062958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
3607d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
36081450bc6eSdrh int sqlite3CodeSubselect(Parse *, Expr *, int, int);
36097d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
3610923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
36113e3f1a5bSdrh int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
36127d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
36137d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
36143780be11Sdrh void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
36157d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
3616c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
361719a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
361819a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
361979e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
3620fdaac671Sdrh char sqlite3AffinityType(const char*, u8*);
36219f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
3622a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
3623ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
36240410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *);
3625cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
3626d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*);
362751147baaSdrh void sqlite3DefaultRowEst(Index*);
362855ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
3629d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
3630fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
3631b6ee6607Sdrh void sqlite3SchemaClear(void *);
36321e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
3633e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
3634ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
36352ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*);
36362ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
36372ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
36382ec2fb22Sdrh #ifdef SQLITE_DEBUG
36392ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*);
36402ec2fb22Sdrh #endif
3641771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
3642771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
3643d2199f0fSdan   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
3644d2199f0fSdan   FuncDestructor *pDestructor
3645d2199f0fSdan );
364654f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
3647ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
364869dab1d3Sdrh 
3649c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
3650ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
3651a6353a3fSdrh void sqlite3StrAccumAppendAll(StrAccum*,const char*);
3652af8f513fSdrh void sqlite3AppendChar(StrAccum*,int,char);
3653ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
3654ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
36551013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
3656f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
36571e536953Sdanielk1977 
36580410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *);
36590410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
36600410302eSdanielk1977 
36611435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
36629fecc546Sdrh void sqlite3AnalyzeFunctions(void);
366387cd9321Sdan int sqlite3Stat4ProbeSetValue(Parse*,Index*,UnpackedRecord**,Expr*,u8,int,int*);
3664b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
36657a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*);
3666b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
36679fecc546Sdrh #endif
36687a419235Sdan 
366995bdbbbdSdrh /*
367095bdbbbdSdrh ** The interface to the LEMON-generated parser
367195bdbbbdSdrh */
3672fb046e76Sdrh void *sqlite3ParserAlloc(void*(*)(u64));
367395bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
367495bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
3675ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
3676ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
3677ec424a5bSdrh #endif
367895bdbbbdSdrh 
36797aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*);
368069dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
3681f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
368269dab1d3Sdrh #else
368369dab1d3Sdrh # define sqlite3CloseExtensions(X)
368469dab1d3Sdrh #endif
3685e3026636Sdanielk1977 
3686c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
3687c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
3688c00da105Sdanielk1977 #else
3689c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
3690c00da105Sdanielk1977 #endif
3691c00da105Sdanielk1977 
369253c14021Sdrh #ifdef SQLITE_TEST
369353c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
369453c14021Sdrh #endif
369553c14021Sdrh 
3696b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
3697595a523aSdanielk1977 #  define sqlite3VtabClear(Y)
36989dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
3699f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
3700f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
3701093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) 0
3702595a523aSdanielk1977 #  define sqlite3VtabLock(X)
3703595a523aSdanielk1977 #  define sqlite3VtabUnlock(X)
3704595a523aSdanielk1977 #  define sqlite3VtabUnlockList(X)
3705a311b803Sdan #  define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
3706c3c8dac7Sdrh #  define sqlite3GetVTable(X,Y)  ((VTable*)0)
3707b9bb7c18Sdrh #else
37081feeaed2Sdan    void sqlite3VtabClear(sqlite3 *db, Table*);
3709bba02a95Sdan    void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
3710016f7811Sdan    int sqlite3VtabSync(sqlite3 *db, Vdbe*);
3711f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
3712f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
3713595a523aSdanielk1977    void sqlite3VtabLock(VTable *);
3714595a523aSdanielk1977    void sqlite3VtabUnlock(VTable *);
3715595a523aSdanielk1977    void sqlite3VtabUnlockList(sqlite3*);
3716a311b803Sdan    int sqlite3VtabSavepoint(sqlite3 *, int, int);
3717016f7811Sdan    void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
3718c3c8dac7Sdrh    VTable *sqlite3GetVTable(sqlite3*, Table*);
3719093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
3720b9bb7c18Sdrh #endif
37214f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
3722b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
3723b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
3724b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
3725b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
372678efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
37277e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
37289e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
3729595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *);
37301e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
3731b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
373295a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
37335f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
37344a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
3735f30a969bSdrh void sqlite3ParserReset(Parse*);
3736b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
3737b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
3738bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
37391c514148Sdrh int sqlite3TempInMemory(const sqlite3*);
374028e5386fSdan const char *sqlite3JournalModename(int);
374106a2d825Sdan #ifndef SQLITE_OMIT_WAL
3742cdc1f049Sdan   int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
3743b033d8b9Sdrh   int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
374406a2d825Sdan #endif
37458b471863Sdrh #ifndef SQLITE_OMIT_CTE
37464e9119d9Sdan   With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
37477d562dbeSdan   void sqlite3WithDelete(sqlite3*,With*);
3748b290f117Sdan   void sqlite3WithPush(Parse*, With*, u8);
37494e9119d9Sdan #else
3750b290f117Sdan #define sqlite3WithPush(x,y,z)
3751eede6a53Sdan #define sqlite3WithDelete(x,y)
37528b471863Sdrh #endif
3753d829335eSdanielk1977 
375475cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by
375575cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
375675cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but
375775cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
375875cbd984Sdan ** this case foreign keys are parsed, but no other functionality is
375975cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system).
376075cbd984Sdan */
376175cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
37628ff2d956Sdan   void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
3763d66c8309Sdan   void sqlite3FkDropTable(Parse*, SrcList *, Table*);
37648ff2d956Sdan   void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
3765e7a94d81Sdan   int sqlite3FkRequired(Parse*, Table*, int*, int);
3766e7a94d81Sdan   u32 sqlite3FkOldmask(Parse*, Table*);
3767432cc5b9Sdan   FKey *sqlite3FkReferences(Table *);
37681da40a38Sdan #else
37698ff2d956Sdan   #define sqlite3FkActions(a,b,c,d,e,f)
377067896cefSdan   #define sqlite3FkCheck(a,b,c,d,e,f)
3771d66c8309Sdan   #define sqlite3FkDropTable(a,b,c)
3772e7a94d81Sdan   #define sqlite3FkOldmask(a,b)         0
3773e7a94d81Sdan   #define sqlite3FkRequired(a,b,c,d)    0
37741da40a38Sdan #endif
377575cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY
37761feeaed2Sdan   void sqlite3FkDelete(sqlite3 *, Table*);
37776c5b915fSdrh   int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
377875cbd984Sdan #else
37791feeaed2Sdan   #define sqlite3FkDelete(a,b)
37806c5b915fSdrh   #define sqlite3FkLocateIndex(a,b,c,d,e)
378175cbd984Sdan #endif
378275cbd984Sdan 
3783643167ffSdrh 
3784643167ffSdrh /*
3785643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
3786643167ffSdrh */
3787643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
37887e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
3789643167ffSdrh 
3790643167ffSdrh /*
3791ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
3792ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
3793ef05f2dfSdanielk1977 ** is not defined.
3794643167ffSdrh */
37953088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
37962d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
37972d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
3798643167ffSdrh #else
37992d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
3800867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
3801643167ffSdrh #endif
3802643167ffSdrh 
38033a85625dSdrh /*
38043a85625dSdrh ** Allowed return values from sqlite3FindInIndex()
38053a85625dSdrh */
38063a85625dSdrh #define IN_INDEX_ROWID        1   /* Search the rowid of the table */
38073a85625dSdrh #define IN_INDEX_EPH          2   /* Search an ephemeral b-tree */
38083a85625dSdrh #define IN_INDEX_INDEX_ASC    3   /* Existing index ASCENDING */
38093a85625dSdrh #define IN_INDEX_INDEX_DESC   4   /* Existing index DESCENDING */
3810bb53ecb1Sdrh #define IN_INDEX_NOOP         5   /* No table available. Use comparisons */
38113a85625dSdrh /*
38123a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
38133a85625dSdrh */
3814bb53ecb1Sdrh #define IN_INDEX_NOOP_OK     0x0001  /* OK to return IN_INDEX_NOOP */
3815bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP  0x0002  /* IN operator used for membership test */
3816bb53ecb1Sdrh #define IN_INDEX_LOOP        0x0004  /* IN operator used as a loop */
38173a85625dSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*);
38189a96b668Sdanielk1977 
3819c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
3820c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
3821c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
3822f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
38233de0f184Sdan   int sqlite3JournalExists(sqlite3_file *p);
3824c7b6017cSdanielk1977 #else
3825c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
38263de0f184Sdan   #define sqlite3JournalExists(p) 1
3827c7b6017cSdanielk1977 #endif
3828c7b6017cSdanielk1977 
3829b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *);
38303a5990abSdrh int sqlite3MemJournalSize(void);
3831b3175389Sdanielk1977 int sqlite3IsMemJournal(sqlite3_file *);
3832b3175389Sdanielk1977 
38332308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
38340224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
3835fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
38367d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
3837fc976065Sdanielk1977 #else
38380224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
38397d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
3840fc976065Sdanielk1977 #endif
3841fc976065Sdanielk1977 
3842a3152895Sdrh u32 sqlite3Get4byte(const u8*);
3843a3152895Sdrh void sqlite3Put4byte(u8*, u32);
3844a3152895Sdrh 
3845404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
3846404ca075Sdanielk1977   void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
3847404ca075Sdanielk1977   void sqlite3ConnectionUnlocked(sqlite3 *db);
3848404ca075Sdanielk1977   void sqlite3ConnectionClosed(sqlite3 *db);
3849404ca075Sdanielk1977 #else
3850404ca075Sdanielk1977   #define sqlite3ConnectionBlocked(x,y)
3851404ca075Sdanielk1977   #define sqlite3ConnectionUnlocked(x)
3852404ca075Sdanielk1977   #define sqlite3ConnectionClosed(x)
3853404ca075Sdanielk1977 #endif
3854404ca075Sdanielk1977 
38556e736838Sdrh #ifdef SQLITE_DEBUG
38566e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
38576e736838Sdrh #endif
38586e736838Sdrh 
3859b0603416Sdrh /*
3860b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
38613a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
3862b0603416Sdrh ** print I/O tracing messages.
3863b0603416Sdrh */
3864b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
38653a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
3866b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
38679871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
3868b0603416Sdrh #else
3869b0603416Sdrh # define IOTRACE(A)
3870b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
3871b0603416Sdrh #endif
3872b0603416Sdrh 
3873107b56e8Sdrh /*
3874107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator
3875107b56e8Sdrh ** only.  They are used to verify that different "types" of memory
3876107b56e8Sdrh ** allocations are properly tracked by the system.
3877107b56e8Sdrh **
3878107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
3879107b56e8Sdrh ** the MEMTYPE_* macros defined below.  The type must be a bitmask with
3880107b56e8Sdrh ** a single bit set.
3881107b56e8Sdrh **
3882107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second
3883107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
3884107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
3885107b56e8Sdrh **
3886174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second
3887174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
3888107b56e8Sdrh **
3889107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP
3890174b9a16Sdrh ** and MEMTYPE_LOOKASIDE.  If an allocation is MEMTYPE_LOOKASIDE, that means
3891174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was
3892174b9a16Sdrh ** too large or lookaside was already full.  It is important to verify
3893174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not
3894174b9a16Sdrh ** passed back to non-lookaside free() routines.  Asserts such as the
3895174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify
3896174b9a16Sdrh ** this constraint.
3897107b56e8Sdrh **
3898107b56e8Sdrh ** All of this is no-op for a production build.  It only comes into
3899107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used.
3900107b56e8Sdrh */
3901107b56e8Sdrh #ifdef SQLITE_MEMDEBUG
3902107b56e8Sdrh   void sqlite3MemdebugSetType(void*,u8);
3903107b56e8Sdrh   int sqlite3MemdebugHasType(void*,u8);
3904174b9a16Sdrh   int sqlite3MemdebugNoType(void*,u8);
3905107b56e8Sdrh #else
3906107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y)  /* no-op */
3907107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y)  1
3908174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y)   1
3909e3026636Sdanielk1977 #endif
3910107b56e8Sdrh #define MEMTYPE_HEAP       0x01  /* General heap allocations */
3911d231aa3aSdrh #define MEMTYPE_LOOKASIDE  0x02  /* Heap that might have been lookaside */
3912107b56e8Sdrh #define MEMTYPE_SCRATCH    0x04  /* Scratch allocations */
3913107b56e8Sdrh #define MEMTYPE_PCACHE     0x08  /* Page cache allocations */
3914107b56e8Sdrh 
3915f51446a3Sdrh /*
3916f51446a3Sdrh ** Threading interface
3917f51446a3Sdrh */
3918bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0
3919f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
3920f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**);
3921bf20a35dSdrh #endif
3922f51446a3Sdrh 
39233e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
39243e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*);
39253e0327d5Sdrh #endif
39263e0327d5Sdrh 
3927107b56e8Sdrh #endif /* _SQLITEINT_H_ */
3928