xref: /sqlite-3.40.0/src/sqliteInt.h (revision c3dcdba3)
175897234Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
375897234Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
675897234Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
1075897234Sdrh **
1175897234Sdrh *************************************************************************
1275897234Sdrh ** Internal interface definitions for SQLite.
1375897234Sdrh **
1475897234Sdrh */
1543f58d6aSdrh #ifndef SQLITEINT_H
1643f58d6aSdrh #define SQLITEINT_H
1771674ce9Sdrh 
18396794f0Sdrh /* Special Comments:
19396794f0Sdrh **
20396794f0Sdrh ** Some comments have special meaning to the tools that measure test
21396794f0Sdrh ** coverage:
22396794f0Sdrh **
23396794f0Sdrh **    NO_TEST                     - The branches on this line are not
24396794f0Sdrh **                                  measured by branch coverage.  This is
25396794f0Sdrh **                                  used on lines of code that actually
26396794f0Sdrh **                                  implement parts of coverage testing.
27396794f0Sdrh **
28396794f0Sdrh **    OPTIMIZATION-IF-TRUE        - This branch is allowed to alway be false
29396794f0Sdrh **                                  and the correct answer is still obtained,
30396794f0Sdrh **                                  though perhaps more slowly.
31396794f0Sdrh **
32396794f0Sdrh **    OPTIMIZATION-IF-FALSE       - This branch is allowed to alway be true
33396794f0Sdrh **                                  and the correct answer is still obtained,
34396794f0Sdrh **                                  though perhaps more slowly.
35396794f0Sdrh **
36396794f0Sdrh **    PREVENTS-HARMLESS-OVERREAD  - This branch prevents a buffer overread
37396794f0Sdrh **                                  that would be harmless and undetectable
38396794f0Sdrh **                                  if it did occur.
39396794f0Sdrh **
40396794f0Sdrh ** In all cases, the special comment must be enclosed in the usual
41396794f0Sdrh ** slash-asterisk...asterisk-slash comment marks, with no spaces between the
42396794f0Sdrh ** asterisks and the comment text.
43396794f0Sdrh */
44396794f0Sdrh 
45bd0ae111Smlcreech /*
467617e4a8Smistachkin ** Make sure the Tcl calling convention macro is defined.  This macro is
477617e4a8Smistachkin ** only used by test code and Tcl integration code.
487617e4a8Smistachkin */
497617e4a8Smistachkin #ifndef SQLITE_TCLAPI
507617e4a8Smistachkin #  define SQLITE_TCLAPI
517617e4a8Smistachkin #endif
5271674ce9Sdrh 
53bd0ae111Smlcreech /*
542318d338Smistachkin ** Include the header file used to customize the compiler options for MSVC.
552318d338Smistachkin ** This should be done first so that it can successfully prevent spurious
562318d338Smistachkin ** compiler warnings due to subsequent content in this file and other files
572318d338Smistachkin ** that are included by this file.
582318d338Smistachkin */
592318d338Smistachkin #include "msvc.h"
602318d338Smistachkin 
612318d338Smistachkin /*
628cd5b254Sdrh ** Special setup for VxWorks
638cd5b254Sdrh */
648cd5b254Sdrh #include "vxworks.h"
658cd5b254Sdrh 
668cd5b254Sdrh /*
672210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the
682210dcc6Sdrh ** underlying operating system supports it.  If the OS lacks
692210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops.
702210dcc6Sdrh **
712210dcc6Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
722210dcc6Sdrh ** system #includes.  Hence, this block of code must be the very first
732210dcc6Sdrh ** code in all source files.
742210dcc6Sdrh **
752210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
762210dcc6Sdrh ** on the compiler command line.  This is necessary if you are compiling
772210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
782210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
792210dcc6Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
802210dcc6Sdrh ** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
812210dcc6Sdrh ** portability you should omit LFS.
822210dcc6Sdrh **
83dddf6978Sdrh ** The previous paragraph was written in 2005.  (This paragraph is written
84dddf6978Sdrh ** on 2008-11-28.) These days, all Linux kernels support large files, so
85dddf6978Sdrh ** you should probably leave LFS enabled.  But some embedded platforms might
86dddf6978Sdrh ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
87dddf6978Sdrh **
882210dcc6Sdrh ** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
892210dcc6Sdrh */
902210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS
912210dcc6Sdrh # define _LARGE_FILE       1
922210dcc6Sdrh # ifndef _FILE_OFFSET_BITS
932210dcc6Sdrh #   define _FILE_OFFSET_BITS 64
942210dcc6Sdrh # endif
952210dcc6Sdrh # define _LARGEFILE_SOURCE 1
962210dcc6Sdrh #endif
972210dcc6Sdrh 
98dc5ece86Sdrh /* The GCC_VERSION and MSVC_VERSION macros are used to
99a39284bfSdrh ** conditionally include optimizations for each of these compilers.  A
100a39284bfSdrh ** value of 0 means that compiler is not being used.  The
101a39284bfSdrh ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific
102a39284bfSdrh ** optimizations, and hence set all compiler macros to 0
103dc5ece86Sdrh **
104dc5ece86Sdrh ** There was once also a CLANG_VERSION macro.  However, we learn that the
105dc5ece86Sdrh ** version numbers in clang are for "marketing" only and are inconsistent
106dc5ece86Sdrh ** and unreliable.  Fortunately, all versions of clang also recognize the
107dc5ece86Sdrh ** gcc version numbers and have reasonable settings for gcc version numbers,
108dc5ece86Sdrh ** so the GCC_VERSION macro will be set to a correct non-zero value even
109dc5ece86Sdrh ** when compiling with clang.
110a39284bfSdrh */
111a39284bfSdrh #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
112ad265296Sdrh # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
113ad265296Sdrh #else
114ad265296Sdrh # define GCC_VERSION 0
115ad265296Sdrh #endif
116a39284bfSdrh #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
117a39284bfSdrh # define MSVC_VERSION _MSC_VER
118a39284bfSdrh #else
119a39284bfSdrh # define MSVC_VERSION 0
120a39284bfSdrh #endif
121ad265296Sdrh 
12233ac4c8bSmistachkin /* Needed for various definitions... */
12333ac4c8bSmistachkin #if defined(__GNUC__) && !defined(_GNU_SOURCE)
12433ac4c8bSmistachkin # define _GNU_SOURCE
12533ac4c8bSmistachkin #endif
12633ac4c8bSmistachkin 
12733ac4c8bSmistachkin #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
12833ac4c8bSmistachkin # define _BSD_SOURCE
12933ac4c8bSmistachkin #endif
13033ac4c8bSmistachkin 
1312210dcc6Sdrh /*
132a7b3b635Smistachkin ** For MinGW, check to see if we can include the header file containing its
133a7b3b635Smistachkin ** version information, among other things.  Normally, this internal MinGW
134a7b3b635Smistachkin ** header file would [only] be included automatically by other MinGW header
135a7b3b635Smistachkin ** files; however, the contained version information is now required by this
136a7b3b635Smistachkin ** header file to work around binary compatibility issues (see below) and
137a7b3b635Smistachkin ** this is the only known way to reliably obtain it.  This entire #if block
138a7b3b635Smistachkin ** would be completely unnecessary if there was any other way of detecting
139a7b3b635Smistachkin ** MinGW via their preprocessor (e.g. if they customized their GCC to define
140a7b3b635Smistachkin ** some MinGW-specific macros).  When compiling for MinGW, either the
141a7b3b635Smistachkin ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
142a7b3b635Smistachkin ** defined; otherwise, detection of conditions specific to MinGW will be
143a7b3b635Smistachkin ** disabled.
144a7b3b635Smistachkin */
145a7b3b635Smistachkin #if defined(_HAVE_MINGW_H)
146a7b3b635Smistachkin # include "mingw.h"
147a7b3b635Smistachkin #elif defined(_HAVE__MINGW_H)
148a7b3b635Smistachkin # include "_mingw.h"
149a7b3b635Smistachkin #endif
150a7b3b635Smistachkin 
151a7b3b635Smistachkin /*
152a7b3b635Smistachkin ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
153a7b3b635Smistachkin ** define is required to maintain binary compatibility with the MSVC runtime
154a7b3b635Smistachkin ** library in use (e.g. for Windows XP).
155a7b3b635Smistachkin */
156a7b3b635Smistachkin #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
157a7b3b635Smistachkin     defined(_WIN32) && !defined(_WIN64) && \
15865acf373Smistachkin     defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
159a7b3b635Smistachkin     defined(__MSVCRT__)
160a7b3b635Smistachkin # define _USE_32BIT_TIME_T
161a7b3b635Smistachkin #endif
162a7b3b635Smistachkin 
1635e990beaSdrh /* The public SQLite interface.  The _FILE_OFFSET_BITS macro must appear
1640d71d121Smistachkin ** first in QNX.  Also, the _USE_32BIT_TIME_T macro must appear first for
1650d71d121Smistachkin ** MinGW.
1665e990beaSdrh */
1675e990beaSdrh #include "sqlite3.h"
1685e990beaSdrh 
169bd0ae111Smlcreech /*
1701e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
1711e12d43bSmlcreech ** autoconf-based build
172bd0ae111Smlcreech */
1737f2d1cd2Sdrh #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H)
17498dc4b1aSmlcreech #include "config.h"
1757f2d1cd2Sdrh #define SQLITECONFIG_H 1
1761e12d43bSmlcreech #endif
1771e12d43bSmlcreech 
178bb4957f8Sdrh #include "sqliteLimit.h"
17998dc4b1aSmlcreech 
180e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
181e2965827Sdrh #if defined(__BORLANDC__)
182e2965827Sdrh #pragma warn -rch /* unreachable code */
183e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
184e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
185e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
186467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */
187e2965827Sdrh #endif
188e2965827Sdrh 
18998dc4b1aSmlcreech /*
19006af763eSdrh ** Include standard header files as necessary
19106af763eSdrh */
19206af763eSdrh #ifdef HAVE_STDINT_H
19306af763eSdrh #include <stdint.h>
19406af763eSdrh #endif
19506af763eSdrh #ifdef HAVE_INTTYPES_H
19606af763eSdrh #include <inttypes.h>
19706af763eSdrh #endif
19806af763eSdrh 
199a2460e07Sdrh /*
200c05a9a8aSdrh ** The following macros are used to cast pointers to integers and
201c05a9a8aSdrh ** integers to pointers.  The way you do this varies from one compiler
202c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements
203c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers.
204875e9e7dSdrh **
205c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type.
206c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or
207c05a9a8aSdrh ** if it is available, it requires an #include of specific headers
208c92271c5Sdrh ** that vary from one machine to the next.
209875e9e7dSdrh **
210875e9e7dSdrh ** Ticket #3860:  The llvm-gcc-4.2 compiler from Apple chokes on
211875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct.  But MSVC chokes on ((void*)(X)).
2125e49edcaSdrh ** So we have to define the macros in different ways depending on the
213875e9e7dSdrh ** compiler.
2141fc4129dSshane */
215c05a9a8aSdrh #if defined(__PTRDIFF_TYPE__)  /* This case should work for GCC */
216c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(__PTRDIFF_TYPE__)(X))
217c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(__PTRDIFF_TYPE__)(X))
218c05a9a8aSdrh #elif !defined(__GNUC__)       /* Works for compilers other than LLVM */
219c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)&((char*)0)[X])
220c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(((char*)X)-(char*)0))
221c05a9a8aSdrh #elif defined(HAVE_STDINT_H)   /* Use this case if we have ANSI headers */
222367882c2Sdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(intptr_t)(X))
223367882c2Sdrh # define SQLITE_PTR_TO_INT(X)  ((int)(intptr_t)(X))
224c05a9a8aSdrh #else                          /* Generates a warning - but it always works */
225875e9e7dSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(X))
226875e9e7dSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(X))
227367882c2Sdrh #endif
22871674ce9Sdrh 
229e5e7a901Sdrh /*
23014a924a5Sdrh ** A macro to hint to the compiler that a function should not be
23114a924a5Sdrh ** inlined.
23214a924a5Sdrh */
23314a924a5Sdrh #if defined(__GNUC__)
23414a924a5Sdrh #  define SQLITE_NOINLINE  __attribute__((noinline))
235ab993380Sdrh #elif defined(_MSC_VER) && _MSC_VER>=1310
23614a924a5Sdrh #  define SQLITE_NOINLINE  __declspec(noinline)
23714a924a5Sdrh #else
23814a924a5Sdrh #  define SQLITE_NOINLINE
23914a924a5Sdrh #endif
24014a924a5Sdrh 
24114a924a5Sdrh /*
242647ca46fSmistachkin ** Make sure that the compiler intrinsics we desire are enabled when
24360e08078Smistachkin ** compiling with an appropriate version of MSVC unless prevented by
24460e08078Smistachkin ** the SQLITE_DISABLE_INTRINSIC define.
245647ca46fSmistachkin */
24660e08078Smistachkin #if !defined(SQLITE_DISABLE_INTRINSIC)
24711f69b87Smistachkin #  if defined(_MSC_VER) && _MSC_VER>=1400
2489895f735Smistachkin #    if !defined(_WIN32_WCE)
249647ca46fSmistachkin #      include <intrin.h>
250647ca46fSmistachkin #      pragma intrinsic(_byteswap_ushort)
251647ca46fSmistachkin #      pragma intrinsic(_byteswap_ulong)
252a39284bfSdrh #      pragma intrinsic(_byteswap_uint64)
2538d9837acSmistachkin #      pragma intrinsic(_ReadWriteBarrier)
2549895f735Smistachkin #    else
2559895f735Smistachkin #      include <cmnintrin.h>
2569895f735Smistachkin #    endif
257647ca46fSmistachkin #  endif
25860e08078Smistachkin #endif
259647ca46fSmistachkin 
260647ca46fSmistachkin /*
26138c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
26238c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never
26338c67c36Sdrh ** threadsafe.  1 means the library is serialized which is the highest
264f7b5496eSdrh ** level of threadsafety.  2 means the library is multithreaded - multiple
26538c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same
26638c67c36Sdrh ** database connection at the same time.
26738c67c36Sdrh **
268e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
26938c67c36Sdrh ** We support that for legacy.
270814aad61Sdan **
271814aad61Sdan ** To ensure that the correct value of "THREADSAFE" is reported when querying
272814aad61Sdan ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this
273814aad61Sdan ** logic is partially replicated in ctime.c. If it is updated here, it should
274814aad61Sdan ** also be updated there.
275e5e7a901Sdrh */
276e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
277e5e7a901Sdrh # if defined(THREADSAFE)
278e5e7a901Sdrh #   define SQLITE_THREADSAFE THREADSAFE
279e5e7a901Sdrh # else
28038c67c36Sdrh #   define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
281e5e7a901Sdrh # endif
282e5e7a901Sdrh #endif
283e5e7a901Sdrh 
28467080617Sdrh /*
285cb15f35fSdrh ** Powersafe overwrite is on by default.  But can be turned off using
286cb15f35fSdrh ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
287cb15f35fSdrh */
288cb15f35fSdrh #ifndef SQLITE_POWERSAFE_OVERWRITE
289cb15f35fSdrh # define SQLITE_POWERSAFE_OVERWRITE 1
290cb15f35fSdrh #endif
291cb15f35fSdrh 
292cb15f35fSdrh /*
293d1dcb234Sdrh ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
294d1dcb234Sdrh ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
295d1dcb234Sdrh ** which case memory allocation statistics are disabled by default.
2960a732f59Sdanielk1977 */
2970a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
2980a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1
2990a732f59Sdanielk1977 #endif
3000a732f59Sdanielk1977 
3010a732f59Sdanielk1977 /*
3020d18020bSdrh ** Exactly one of the following macros must be defined in order to
3030d18020bSdrh ** specify which memory allocation subsystem to use.
3040d18020bSdrh **
3050d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
3061b186a99Smistachkin **     SQLITE_WIN32_MALLOC           // Use Win32 native heap API
307d1b0afc3Sdrh **     SQLITE_ZERO_MALLOC            // Use a stub allocator that always fails
3080d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
309a2460e07Sdrh **
310753c5444Smistachkin ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
311753c5444Smistachkin ** assert() macro is enabled, each call into the Win32 native heap subsystem
312753c5444Smistachkin ** will cause HeapValidate to be called.  If heap validation should fail, an
313753c5444Smistachkin ** assertion will be triggered.
314753c5444Smistachkin **
3150d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
3160d18020bSdrh ** the default.
3170d18020bSdrh */
318d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
319d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
320d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
321d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)>1
322d1b0afc3Sdrh # error "Two or more of the following compile-time configuration options\
32320b1ff07Smistachkin  are defined but at most one is allowed:\
324d1b0afc3Sdrh  SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
325d1b0afc3Sdrh  SQLITE_ZERO_MALLOC"
3260d18020bSdrh #endif
327d1b0afc3Sdrh #if defined(SQLITE_SYSTEM_MALLOC) \
328d1b0afc3Sdrh   + defined(SQLITE_WIN32_MALLOC) \
329d1b0afc3Sdrh   + defined(SQLITE_ZERO_MALLOC) \
330d1b0afc3Sdrh   + defined(SQLITE_MEMDEBUG)==0
3310d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
3320d18020bSdrh #endif
3330d18020bSdrh 
3340d18020bSdrh /*
3358a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
336eee4c8caSdrh ** sizes of memory allocations below this value where possible.
337eee4c8caSdrh */
3388a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
339eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
340eee4c8caSdrh #endif
341eee4c8caSdrh 
342eee4c8caSdrh /*
34367080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
34440b521f8Sdrh ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
34540b521f8Sdrh ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
34640b521f8Sdrh ** it.
34767080617Sdrh */
34840b521f8Sdrh #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
34940b521f8Sdrh #  define _XOPEN_SOURCE 600
35067080617Sdrh #endif
351e3026636Sdanielk1977 
3527d10d5a6Sdrh /*
3531b28b893Sdrh ** NDEBUG and SQLITE_DEBUG are opposites.  It should always be true that
3541b28b893Sdrh ** defined(NDEBUG)==!defined(SQLITE_DEBUG).  If this is not currently true,
3551b28b893Sdrh ** make it true by defining or undefining NDEBUG.
3561b28b893Sdrh **
357443dbcf5Sdrh ** Setting NDEBUG makes the code smaller and faster by disabling the
358443dbcf5Sdrh ** assert() statements in the code.  So we want the default action
3591b28b893Sdrh ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
3601b28b893Sdrh ** is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
3614b529d97Sdrh ** feature.
3624b529d97Sdrh */
363289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
3644b529d97Sdrh # define NDEBUG 1
3654b529d97Sdrh #endif
3661b28b893Sdrh #if defined(NDEBUG) && defined(SQLITE_DEBUG)
3671b28b893Sdrh # undef NDEBUG
3681b28b893Sdrh #endif
3694b529d97Sdrh 
3706402250eSdrh /*
371c7379ce4Sdrh ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
372c7379ce4Sdrh */
373c7379ce4Sdrh #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
374c7379ce4Sdrh # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
375c7379ce4Sdrh #endif
376c7379ce4Sdrh 
377c7379ce4Sdrh /*
37847c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing.  When
37947c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to
38047c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to
38147c3b3e0Sdrh ** get full branch coverage.  The testcase() macro is inserted
38247c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple
38347c3b3e0Sdrh ** condition/decision coverage is inadequate.  For example, testcase()
38447c3b3e0Sdrh ** can be used to make sure boundary values are tested.  For
38547c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit
38647c3b3e0Sdrh ** is significant and used at least once.  On switch statements
38747c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase()
38847c3b3e0Sdrh ** can insure that all cases are evaluated.
38947c3b3e0Sdrh **
39047c3b3e0Sdrh */
39147c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST
39247c3b3e0Sdrh   void sqlite3Coverage(int);
39347c3b3e0Sdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
39447c3b3e0Sdrh #else
39547c3b3e0Sdrh # define testcase(X)
3968f941bc7Sdrh #endif
3978f941bc7Sdrh 
3988f941bc7Sdrh /*
3998f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or
4008f941bc7Sdrh ** other bits of code that are needed to support the arguments
4018f941bc7Sdrh ** within testcase() and assert() macros.
4028f941bc7Sdrh */
4038f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
4048f941bc7Sdrh # define TESTONLY(X)  X
4058f941bc7Sdrh #else
40647c3b3e0Sdrh # define TESTONLY(X)
40747c3b3e0Sdrh #endif
40847c3b3e0Sdrh 
40947c3b3e0Sdrh /*
4106149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization
4116149526cSdrh ** to setup for a later assert() statement.  We do not want this code to
4126149526cSdrh ** appear when assert() is disabled.  The following macro is therefore
4136149526cSdrh ** used to contain that setup code.  The "VVA" acronym stands for
4146149526cSdrh ** "Verification, Validation, and Accreditation".  In other words, the
4156149526cSdrh ** code within VVA_ONLY() will only run during verification processes.
4166149526cSdrh */
4176149526cSdrh #ifndef NDEBUG
4186149526cSdrh # define VVA_ONLY(X)  X
4196149526cSdrh #else
4206149526cSdrh # define VVA_ONLY(X)
4216149526cSdrh #endif
4226149526cSdrh 
4236149526cSdrh /*
42447c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which
42547c3b3e0Sdrh ** are intended to always be true or false, respectively.  Such
42647c3b3e0Sdrh ** expressions could be omitted from the code completely.  But they
42747c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience
42847c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
42947c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first
43047c3b3e0Sdrh ** hint of unplanned behavior.
43147c3b3e0Sdrh **
43247c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code.
43347c3b3e0Sdrh **
43447c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
435443dbcf5Sdrh ** be true and false so that the unreachable code they specify will
43647c3b3e0Sdrh ** not be counted as untested code.
43747c3b3e0Sdrh */
4385f65ff27Sdrh #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST)
43947c3b3e0Sdrh # define ALWAYS(X)      (1)
44047c3b3e0Sdrh # define NEVER(X)       (0)
44147c3b3e0Sdrh #elif !defined(NDEBUG)
4422de80f4cSdrh # define ALWAYS(X)      ((X)?1:(assert(0),0))
4432de80f4cSdrh # define NEVER(X)       ((X)?(assert(0),1):0)
44447c3b3e0Sdrh #else
44547c3b3e0Sdrh # define ALWAYS(X)      (X)
44647c3b3e0Sdrh # define NEVER(X)       (X)
44747c3b3e0Sdrh #endif
44847c3b3e0Sdrh 
44947c3b3e0Sdrh /*
4502f65b2f5Sdrh ** Some conditionals are optimizations only.  In other words, if the
4512f65b2f5Sdrh ** conditionals are replaced with a constant 1 (true) or 0 (false) then
4522f65b2f5Sdrh ** the correct answer is still obtained, though perhaps not as quickly.
4532f65b2f5Sdrh **
4542f65b2f5Sdrh ** The following macros mark these optimizations conditionals.
4552f65b2f5Sdrh */
4562f65b2f5Sdrh #if defined(SQLITE_MUTATION_TEST)
4572f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X)  (1)
4582f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (0)
4592f65b2f5Sdrh #else
4602f65b2f5Sdrh # define OK_IF_ALWAYS_TRUE(X)  (X)
4612f65b2f5Sdrh # define OK_IF_ALWAYS_FALSE(X) (X)
4622f65b2f5Sdrh #endif
4632f65b2f5Sdrh 
4642f65b2f5Sdrh /*
465dad300d8Sdrh ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
466dad300d8Sdrh ** defined.  We need to defend against those failures when testing with
467dad300d8Sdrh ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
468dad300d8Sdrh ** during a normal build.  The following macro can be used to disable tests
469dad300d8Sdrh ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
470dad300d8Sdrh */
471dad300d8Sdrh #if defined(SQLITE_TEST_REALLOC_STRESS)
472dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  (X)
473dad300d8Sdrh #elif !defined(NDEBUG)
474dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  ((X)?(assert(0),1):0)
475dad300d8Sdrh #else
476dad300d8Sdrh # define ONLY_IF_REALLOC_STRESS(X)  (0)
477dad300d8Sdrh #endif
478dad300d8Sdrh 
479dad300d8Sdrh /*
4800cbcffa7Smistachkin ** Declarations used for tracing the operating system interfaces.
4810cbcffa7Smistachkin */
482b10f22a1Smistachkin #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
483b10f22a1Smistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
4840cbcffa7Smistachkin   extern int sqlite3OSTrace;
4850cbcffa7Smistachkin # define OSTRACE(X)          if( sqlite3OSTrace ) sqlite3DebugPrintf X
4860cbcffa7Smistachkin # define SQLITE_HAVE_OS_TRACE
4870cbcffa7Smistachkin #else
4880cbcffa7Smistachkin # define OSTRACE(X)
4890cbcffa7Smistachkin # undef  SQLITE_HAVE_OS_TRACE
4900cbcffa7Smistachkin #endif
4910cbcffa7Smistachkin 
4920cbcffa7Smistachkin /*
4935824d44bSmistachkin ** Is the sqlite3ErrName() function needed in the build?  Currently,
4945824d44bSmistachkin ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
4955824d44bSmistachkin ** OSTRACE is enabled), and by several "test*.c" files (which are
4965824d44bSmistachkin ** compiled using SQLITE_TEST).
4975824d44bSmistachkin */
4985824d44bSmistachkin #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
4995824d44bSmistachkin     (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
5005824d44bSmistachkin # define SQLITE_NEED_ERR_NAME
5015824d44bSmistachkin #else
5025824d44bSmistachkin # undef  SQLITE_NEED_ERR_NAME
5035824d44bSmistachkin #endif
5045824d44bSmistachkin 
5055824d44bSmistachkin /*
5067c621fb9Sdrh ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
5077c621fb9Sdrh */
5087c621fb9Sdrh #ifdef SQLITE_OMIT_EXPLAIN
5097c621fb9Sdrh # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
5107c621fb9Sdrh #endif
5117c621fb9Sdrh 
5127c621fb9Sdrh /*
51360ec914cSpeter.d.reid ** Return true (non-zero) if the input is an integer that is too large
5143e8e7ecbSdrh ** to fit in 32-bits.  This macro is used inside of various testcase()
5153e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support.
5163e8e7ecbSdrh */
517b31a6afaSdan #define IS_BIG_INT(X)  (((X)&~(i64)0xffffffff)!=0)
5183e8e7ecbSdrh 
5193e8e7ecbSdrh /*
52047c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean
52147c3b3e0Sdrh ** expression that is usually false.  Macro likely() surrounds
522443dbcf5Sdrh ** a boolean expression that is usually true.  These hints could,
523443dbcf5Sdrh ** in theory, be used by the compiler to generate better code, but
524443dbcf5Sdrh ** currently they are just comments for human readers.
52547c3b3e0Sdrh */
526443dbcf5Sdrh #define likely(X)    (X)
527443dbcf5Sdrh #define unlikely(X)  (X)
52847c3b3e0Sdrh 
529beae3194Sdrh #include "hash.h"
53075897234Sdrh #include "parse.h"
53175897234Sdrh #include <stdio.h>
53275897234Sdrh #include <stdlib.h>
53375897234Sdrh #include <string.h>
53475897234Sdrh #include <assert.h>
53552370e2cSdrh #include <stddef.h>
53675897234Sdrh 
537967e8b73Sdrh /*
5388674e492Sdrh ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY.
5398674e492Sdrh ** This allows better measurements of where memcpy() is used when running
5408674e492Sdrh ** cachegrind.  But this macro version of memcpy() is very slow so it
5418674e492Sdrh ** should not be used in production.  This is a performance measurement
5428674e492Sdrh ** hack only.
5438674e492Sdrh */
5448674e492Sdrh #ifdef SQLITE_INLINE_MEMCPY
5458674e492Sdrh # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\
5468674e492Sdrh                         int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);}
5478674e492Sdrh #endif
5488674e492Sdrh 
5498674e492Sdrh /*
550b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
551b37df7b9Sdrh ** substitute integer for floating-point
552b37df7b9Sdrh */
553b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
554b37df7b9Sdrh # define double sqlite_int64
5558b307fbfSdrh # define float sqlite_int64
556b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
557d1167393Sdrh # ifndef SQLITE_BIG_DBL
558cdaca55eSdrh #   define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
559d1167393Sdrh # endif
560b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
561b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
562110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
5630b3bf924Sdrh # undef SQLITE_HAVE_ISNAN
564b37df7b9Sdrh #endif
565d1167393Sdrh #ifndef SQLITE_BIG_DBL
566d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
567d1167393Sdrh #endif
568b37df7b9Sdrh 
569b37df7b9Sdrh /*
57053c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
57153c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
57253c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
57353c0f748Sdanielk1977 */
57453c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
57553c0f748Sdanielk1977 #define OMIT_TEMPDB 1
57653c0f748Sdanielk1977 #else
57753c0f748Sdanielk1977 #define OMIT_TEMPDB 0
57853c0f748Sdanielk1977 #endif
57953c0f748Sdanielk1977 
58053c0f748Sdanielk1977 /*
581d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
582d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
583d946db00Sdrh ** the default file format for new databases and the maximum file format
584d946db00Sdrh ** that the library can read.
585d946db00Sdrh */
586d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
587d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
588bf3f5f8dSdrh # define SQLITE_DEFAULT_FILE_FORMAT 4
589d946db00Sdrh #endif
590d946db00Sdrh 
591a2460e07Sdrh /*
592a2460e07Sdrh ** Determine whether triggers are recursive by default.  This can be
593a2460e07Sdrh ** changed at run-time using a pragma.
594a2460e07Sdrh */
5955bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
5965bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
5975bde73c4Sdan #endif
5985bde73c4Sdan 
599d946db00Sdrh /*
600b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
60149766d6cSdrh ** on the command-line
60249766d6cSdrh */
603b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
604b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
60549766d6cSdrh #endif
60649766d6cSdrh 
60749766d6cSdrh /*
608b3f56fdbSdan ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
609b3f56fdbSdan ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
610b3f56fdbSdan ** to zero.
611b3f56fdbSdan */
6126b2129aaSdrh #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
613b3f56fdbSdan # undef SQLITE_MAX_WORKER_THREADS
614028696c4Sdrh # define SQLITE_MAX_WORKER_THREADS 0
615b3f56fdbSdan #endif
616b3f56fdbSdan #ifndef SQLITE_MAX_WORKER_THREADS
6176b2129aaSdrh # define SQLITE_MAX_WORKER_THREADS 8
618b3f56fdbSdan #endif
619a09c8855Sdrh #ifndef SQLITE_DEFAULT_WORKER_THREADS
620a09c8855Sdrh # define SQLITE_DEFAULT_WORKER_THREADS 0
621a09c8855Sdrh #endif
622a09c8855Sdrh #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
623a09c8855Sdrh # undef SQLITE_MAX_WORKER_THREADS
624a09c8855Sdrh # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
625a09c8855Sdrh #endif
626b3f56fdbSdan 
6274297c7c4Sdrh /*
6284297c7c4Sdrh ** The default initial allocation for the pagecache when using separate
6294297c7c4Sdrh ** pagecaches for each database connection.  A positive number is the
6304297c7c4Sdrh ** number of pages.  A negative number N translations means that a buffer
6314297c7c4Sdrh ** of -1024*N bytes is allocated and used for as many pages as it will hold.
63283a4f47dSdrh **
63383a4f47dSdrh ** The default value of "20" was choosen to minimize the run-time of the
63483a4f47dSdrh ** speedtest1 test program with options: --shrink-memory --reprepare
6354297c7c4Sdrh */
6364297c7c4Sdrh #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
63783a4f47dSdrh # define SQLITE_DEFAULT_PCACHE_INITSZ 20
6384297c7c4Sdrh #endif
6394297c7c4Sdrh 
640d83f7ca1Sdan /*
6412e3a5a81Sdan ** Default value for the SQLITE_CONFIG_SORTERREF_SIZE option.
6422e3a5a81Sdan */
6432e3a5a81Sdan #ifndef SQLITE_DEFAULT_SORTERREF_SIZE
6442e3a5a81Sdan # define SQLITE_DEFAULT_SORTERREF_SIZE 0x7fffffff
6452e3a5a81Sdan #endif
6462e3a5a81Sdan 
6472e3a5a81Sdan /*
6482df9478fSdrh ** The compile-time options SQLITE_MMAP_READWRITE and
6492df9478fSdrh ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another.
6502df9478fSdrh ** You must choose one or the other (or neither) but not both.
6512df9478fSdrh */
6522df9478fSdrh #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
6532df9478fSdrh #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE
6542df9478fSdrh #endif
6552df9478fSdrh 
6562df9478fSdrh /*
657f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
658f1974846Sdrh ** ourselves.
659f1974846Sdrh */
660f1974846Sdrh #ifndef offsetof
661f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
662f1974846Sdrh #endif
663f1974846Sdrh 
664f1974846Sdrh /*
665e1e2e9acSdrh ** Macros to compute minimum and maximum of two numbers.
666e1e2e9acSdrh */
66713969f5aSdrh #ifndef MIN
668e1e2e9acSdrh # define MIN(A,B) ((A)<(B)?(A):(B))
66913969f5aSdrh #endif
67013969f5aSdrh #ifndef MAX
671e1e2e9acSdrh # define MAX(A,B) ((A)>(B)?(A):(B))
67213969f5aSdrh #endif
673e1e2e9acSdrh 
674e1e2e9acSdrh /*
6754fa4a54fSdrh ** Swap two objects of type TYPE.
6764fa4a54fSdrh */
6774fa4a54fSdrh #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
6784fa4a54fSdrh 
6794fa4a54fSdrh /*
6809b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
6819b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
6829b8f447bSdrh */
6839b8f447bSdrh #if 'A' == '\301'
6849b8f447bSdrh # define SQLITE_EBCDIC 1
6859b8f447bSdrh #else
6869b8f447bSdrh # define SQLITE_ASCII 1
6879b8f447bSdrh #endif
6889b8f447bSdrh 
6899b8f447bSdrh /*
6905a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
6915a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
6925a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
6935a2c2c20Sdrh **
6945a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
69541a2b48bSdrh */
6965a2c2c20Sdrh #ifndef UINT32_TYPE
697dda5b68cSmlcreech # ifdef HAVE_UINT32_T
698dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
699dda5b68cSmlcreech # else
7005a2c2c20Sdrh #  define UINT32_TYPE unsigned int
7015a2c2c20Sdrh # endif
702dda5b68cSmlcreech #endif
7035a2c2c20Sdrh #ifndef UINT16_TYPE
704dda5b68cSmlcreech # ifdef HAVE_UINT16_T
705dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
706dda5b68cSmlcreech # else
7075a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
7085a2c2c20Sdrh # endif
709dda5b68cSmlcreech #endif
710939a16d6Sdrh #ifndef INT16_TYPE
711dda5b68cSmlcreech # ifdef HAVE_INT16_T
712dda5b68cSmlcreech #  define INT16_TYPE int16_t
713dda5b68cSmlcreech # else
714939a16d6Sdrh #  define INT16_TYPE short int
715939a16d6Sdrh # endif
716dda5b68cSmlcreech #endif
7175a2c2c20Sdrh #ifndef UINT8_TYPE
718dda5b68cSmlcreech # ifdef HAVE_UINT8_T
719dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
720dda5b68cSmlcreech # else
7215a2c2c20Sdrh #  define UINT8_TYPE unsigned char
7225a2c2c20Sdrh # endif
723dda5b68cSmlcreech #endif
724905793e2Sdrh #ifndef INT8_TYPE
725dda5b68cSmlcreech # ifdef HAVE_INT8_T
726dda5b68cSmlcreech #  define INT8_TYPE int8_t
727dda5b68cSmlcreech # else
728905793e2Sdrh #  define INT8_TYPE signed char
729905793e2Sdrh # endif
730dda5b68cSmlcreech #endif
731efad9995Sdrh #ifndef LONGDOUBLE_TYPE
732efad9995Sdrh # define LONGDOUBLE_TYPE long double
733efad9995Sdrh #endif
734efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
73527436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
7365a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
7375a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
738939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
7395a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
74070a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
7415a2c2c20Sdrh 
7425a2c2c20Sdrh /*
74335cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
74435cd643cSdrh ** that can be stored in a u32 without loss of data.  The value
74535cd643cSdrh ** is 0x00000000ffffffff.  But because of quirks of some compilers, we
74635cd643cSdrh ** have to specify the value in the less intuitive manner shown:
74735cd643cSdrh */
74835cd643cSdrh #define SQLITE_MAX_U32  ((((u64)1)<<32)-1)
74935cd643cSdrh 
75035cd643cSdrh /*
751faacf17cSdrh ** The datatype used to store estimates of the number of rows in a
752faacf17cSdrh ** table or index.  This is an unsigned integer type.  For 99.9% of
753faacf17cSdrh ** the world, a 32-bit integer is sufficient.  But a 64-bit integer
754faacf17cSdrh ** can be used at compile-time if desired.
755faacf17cSdrh */
756faacf17cSdrh #ifdef SQLITE_64BIT_STATS
757faacf17cSdrh  typedef u64 tRowcnt;    /* 64-bit only if requested at compile-time */
758faacf17cSdrh #else
759faacf17cSdrh  typedef u32 tRowcnt;    /* 32-bit is the default */
760faacf17cSdrh #endif
761faacf17cSdrh 
762faacf17cSdrh /*
763bf539c4dSdrh ** Estimated quantities used for query planning are stored as 16-bit
764bf539c4dSdrh ** logarithms.  For quantity X, the value stored is 10*log2(X).  This
765bf539c4dSdrh ** gives a possible range of values of approximately 1.0e986 to 1e-986.
766bf539c4dSdrh ** But the allowed values are "grainy".  Not every value is representable.
767bf539c4dSdrh ** For example, quantities 16 and 17 are both represented by a LogEst
76897d38983Sdrh ** of 40.  However, since LogEst quantities are suppose to be estimates,
769bf539c4dSdrh ** not exact values, this imprecision is not a problem.
770bf539c4dSdrh **
771224155ddSdrh ** "LogEst" is short for "Logarithmic Estimate".
772bf539c4dSdrh **
773bf539c4dSdrh ** Examples:
774bf539c4dSdrh **      1 -> 0              20 -> 43          10000 -> 132
775bf539c4dSdrh **      2 -> 10             25 -> 46          25000 -> 146
776bf539c4dSdrh **      3 -> 16            100 -> 66        1000000 -> 199
777bf539c4dSdrh **      4 -> 20           1000 -> 99        1048576 -> 200
778bf539c4dSdrh **     10 -> 33           1024 -> 100    4294967296 -> 320
779bf539c4dSdrh **
780bf539c4dSdrh ** The LogEst can be negative to indicate fractional values.
781bf539c4dSdrh ** Examples:
782bf539c4dSdrh **
783bf539c4dSdrh **    0.5 -> -10           0.1 -> -33        0.0625 -> -40
784bf539c4dSdrh */
785bf539c4dSdrh typedef INT16_TYPE LogEst;
786bf539c4dSdrh 
787bf539c4dSdrh /*
7882b4905c8Sdrh ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
7892b4905c8Sdrh */
7902b4905c8Sdrh #ifndef SQLITE_PTRSIZE
7912b4905c8Sdrh # if defined(__SIZEOF_POINTER__)
7922b4905c8Sdrh #   define SQLITE_PTRSIZE __SIZEOF_POINTER__
7932b4905c8Sdrh # elif defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
79488edc6c7Smistachkin        defined(_M_ARM)   || defined(__arm__)    || defined(__x86)   ||    \
79588edc6c7Smistachkin       (defined(__TOS_AIX__) && !defined(__64BIT__))
7962b4905c8Sdrh #   define SQLITE_PTRSIZE 4
7972b4905c8Sdrh # else
7982b4905c8Sdrh #   define SQLITE_PTRSIZE 8
7992b4905c8Sdrh # endif
8002b4905c8Sdrh #endif
8012b4905c8Sdrh 
8023bfa7e82Sdrh /* The uptr type is an unsigned integer large enough to hold a pointer
8033bfa7e82Sdrh */
8043bfa7e82Sdrh #if defined(HAVE_STDINT_H)
8053bfa7e82Sdrh   typedef uintptr_t uptr;
8063bfa7e82Sdrh #elif SQLITE_PTRSIZE==4
8073bfa7e82Sdrh   typedef u32 uptr;
8083bfa7e82Sdrh #else
8093bfa7e82Sdrh   typedef u64 uptr;
8103bfa7e82Sdrh #endif
8113bfa7e82Sdrh 
8123bfa7e82Sdrh /*
8133bfa7e82Sdrh ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
8143bfa7e82Sdrh ** something between S (inclusive) and E (exclusive).
8153bfa7e82Sdrh **
8163bfa7e82Sdrh ** In other words, S is a buffer and E is a pointer to the first byte after
8173bfa7e82Sdrh ** the end of buffer S.  This macro returns true if P points to something
8183bfa7e82Sdrh ** contained within the buffer S.
8193bfa7e82Sdrh */
8203bfa7e82Sdrh #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
8213bfa7e82Sdrh 
8223bfa7e82Sdrh 
8232b4905c8Sdrh /*
824bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
82571794dbaSdrh ** and whether or not that determination is run-time or compile-time.
82671794dbaSdrh **
82771794dbaSdrh ** For best performance, an attempt is made to guess at the byte-order
82871794dbaSdrh ** using C-preprocessor macros.  If that is unsuccessful, or if
829a39284bfSdrh ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined
83071794dbaSdrh ** at run-time.
831bbd42a6dSdrh */
832a39284bfSdrh #ifndef SQLITE_BYTEORDER
833a39284bfSdrh # if defined(i386)     || defined(__i386__)   || defined(_M_IX86) ||    \
83471794dbaSdrh      defined(__x86_64) || defined(__x86_64__) || defined(_M_X64)  ||    \
83571794dbaSdrh      defined(_M_AMD64) || defined(_M_ARM)     || defined(__x86)   ||    \
836ba3a4072Sdrh      defined(__arm__)  || defined(_M_ARM64)
8372cf4acbdSdrh #   define SQLITE_BYTEORDER    1234
838a39284bfSdrh # elif defined(sparc)    || defined(__ppc__)
83971794dbaSdrh #   define SQLITE_BYTEORDER    4321
840a39284bfSdrh # else
841a39284bfSdrh #   define SQLITE_BYTEORDER 0
842a39284bfSdrh # endif
843a39284bfSdrh #endif
844a39284bfSdrh #if SQLITE_BYTEORDER==4321
84571794dbaSdrh # define SQLITE_BIGENDIAN    1
84671794dbaSdrh # define SQLITE_LITTLEENDIAN 0
84771794dbaSdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16BE
848a39284bfSdrh #elif SQLITE_BYTEORDER==1234
849a39284bfSdrh # define SQLITE_BIGENDIAN    0
850a39284bfSdrh # define SQLITE_LITTLEENDIAN 1
851a39284bfSdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
852a39284bfSdrh #else
853e1462a76Sdrh # ifdef SQLITE_AMALGAMATION
854e1462a76Sdrh   const int sqlite3one = 1;
855e1462a76Sdrh # else
856e1462a76Sdrh   extern const int sqlite3one;
857e1462a76Sdrh # endif
8589c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
8599c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
86038def054Sdrh # define SQLITE_UTF16NATIVE  (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
86138def054Sdrh #endif
862bbd42a6dSdrh 
863bbd42a6dSdrh /*
8640f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
8650f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
8660f050353Sdrh ** compilers.
8670f050353Sdrh */
8680f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
8690f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
8700f050353Sdrh 
8710f050353Sdrh /*
872be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8.  This is used
873be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures.
874be229650Sdanielk1977 */
875bc73971dSdanielk1977 #define ROUND8(x)     (((x)+7)&~7)
876bc73971dSdanielk1977 
877bc73971dSdanielk1977 /*
878bc73971dSdanielk1977 ** Round down to the nearest multiple of 8
879bc73971dSdanielk1977 */
880bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7)
881be229650Sdanielk1977 
882be229650Sdanielk1977 /*
8838e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary.  This
8848e14c596Sdrh ** macro is used only within assert() to verify that the code gets
8858e14c596Sdrh ** all alignment restrictions correct.
8868e14c596Sdrh **
8878e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
88860ec914cSpeter.d.reid ** underlying malloc() implementation might return us 4-byte aligned
8898e14c596Sdrh ** pointers.  In that case, only verify 4-byte alignment.
890ea598cbdSdrh */
8918e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
8928e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&3)==0)
8938e14c596Sdrh #else
894ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&7)==0)
8958e14c596Sdrh #endif
896ea598cbdSdrh 
897188d4884Sdrh /*
8989b4c59faSdrh ** Disable MMAP on platforms where it is known to not work
899188d4884Sdrh */
900188d4884Sdrh #if defined(__OpenBSD__) || defined(__QNXNTO__)
9019b4c59faSdrh # undef SQLITE_MAX_MMAP_SIZE
9029b4c59faSdrh # define SQLITE_MAX_MMAP_SIZE 0
903188d4884Sdrh #endif
904188d4884Sdrh 
9059b4c59faSdrh /*
9069b4c59faSdrh ** Default maximum size of memory used by memory-mapped I/O in the VFS
9079b4c59faSdrh */
9089b4c59faSdrh #ifdef __APPLE__
9099b4c59faSdrh # include <TargetConditionals.h>
9109b4c59faSdrh #endif
9119b4c59faSdrh #ifndef SQLITE_MAX_MMAP_SIZE
9129b4c59faSdrh # if defined(__linux__) \
9139b4c59faSdrh   || defined(_WIN32) \
9149b4c59faSdrh   || (defined(__APPLE__) && defined(__MACH__)) \
9153e9dd938Sdrh   || defined(__sun) \
9163e9dd938Sdrh   || defined(__FreeBSD__) \
9173e9dd938Sdrh   || defined(__DragonFly__)
9182bba8c24Sdrh #   define SQLITE_MAX_MMAP_SIZE 0x7fff0000  /* 2147418112 */
9199b4c59faSdrh # else
9209b4c59faSdrh #   define SQLITE_MAX_MMAP_SIZE 0
9219b4c59faSdrh # endif
9229b4c59faSdrh #endif
9239b4c59faSdrh 
9249b4c59faSdrh /*
9259b4c59faSdrh ** The default MMAP_SIZE is zero on all platforms.  Or, even if a larger
9269b4c59faSdrh ** default MMAP_SIZE is specified at compile-time, make sure that it does
9279b4c59faSdrh ** not exceed the maximum mmap size.
9289b4c59faSdrh */
9299b4c59faSdrh #ifndef SQLITE_DEFAULT_MMAP_SIZE
9309b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE 0
9319b4c59faSdrh #endif
9329b4c59faSdrh #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
9339b4c59faSdrh # undef SQLITE_DEFAULT_MMAP_SIZE
9349b4c59faSdrh # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
9359b4c59faSdrh #endif
936e7b34707Sdrh 
937ea598cbdSdrh /*
9381435a9a1Sdrh ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
9391435a9a1Sdrh ** Priority is given to SQLITE_ENABLE_STAT4.  If either are defined, also
9401435a9a1Sdrh ** define SQLITE_ENABLE_STAT3_OR_STAT4
9411435a9a1Sdrh */
9421435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT4
9431435a9a1Sdrh # undef SQLITE_ENABLE_STAT3
9441435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
9451435a9a1Sdrh #elif SQLITE_ENABLE_STAT3
9461435a9a1Sdrh # define SQLITE_ENABLE_STAT3_OR_STAT4 1
9471435a9a1Sdrh #elif SQLITE_ENABLE_STAT3_OR_STAT4
9481435a9a1Sdrh # undef SQLITE_ENABLE_STAT3_OR_STAT4
9491435a9a1Sdrh #endif
9501435a9a1Sdrh 
9511435a9a1Sdrh /*
952abd4c723Sdrh ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
953abd4c723Sdrh ** the Select query generator tracing logic is turned on.
954abd4c723Sdrh */
955997a4debSdrh #if defined(SQLITE_ENABLE_SELECTTRACE)
956abd4c723Sdrh # define SELECTTRACE_ENABLED 1
957abd4c723Sdrh #else
958abd4c723Sdrh # define SELECTTRACE_ENABLED 0
959abd4c723Sdrh #endif
960abd4c723Sdrh 
961abd4c723Sdrh /*
96290f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
96390f5ecb3Sdrh ** callback for a given sqlite handle.
96490f5ecb3Sdrh **
96590f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
96690f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
96790f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
96890f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
96990f5ecb3Sdrh */
97090f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
97190f5ecb3Sdrh struct BusyHandler {
97280262896Sdrh   int (*xBusyHandler)(void *,int);  /* The busy callback */
97380262896Sdrh   void *pBusyArg;                   /* First arg to busy callback */
974a4afb65cSdrh   int nBusy;                        /* Incremented with each busy call */
975f0119b2eSdrh   u8 bExtraFileArg;                 /* Include sqlite3_file as callback arg */
97690f5ecb3Sdrh };
97790f5ecb3Sdrh 
97890f5ecb3Sdrh /*
97975897234Sdrh ** Name of the master database table.  The master database table
98075897234Sdrh ** is a special table that holds the names and attributes of all
98175897234Sdrh ** user tables and indices.
98275897234Sdrh */
98375897234Sdrh #define MASTER_NAME       "sqlite_master"
984e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
98575897234Sdrh 
98675897234Sdrh /*
9878e150818Sdanielk1977 ** The root-page of the master database table.
9888e150818Sdanielk1977 */
9898e150818Sdanielk1977 #define MASTER_ROOT       1
9908e150818Sdanielk1977 
9918e150818Sdanielk1977 /*
992ed6c8671Sdrh ** The name of the schema table.
993ed6c8671Sdrh */
99453c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
995ed6c8671Sdrh 
996ed6c8671Sdrh /*
99775897234Sdrh ** A convenience macro that returns the number of elements in
99875897234Sdrh ** an array.
99975897234Sdrh */
100023432976Sdanielk1977 #define ArraySize(X)    ((int)(sizeof(X)/sizeof(X[0])))
100175897234Sdrh 
100275897234Sdrh /*
10037a5bcc0fSdrh ** Determine if the argument is a power of two
10047a5bcc0fSdrh */
10057a5bcc0fSdrh #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
10067a5bcc0fSdrh 
10077a5bcc0fSdrh /*
1008633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
1009aa538a58Sdrh ** The sqlite3DbFree() routine requires two parameters instead of the
1010aa538a58Sdrh ** one parameter that destructors normally want.  So we have to introduce
1011aa538a58Sdrh ** this magic value that the code knows to handle differently.  Any
1012aa538a58Sdrh ** pointer will work here as long as it is distinct from SQLITE_STATIC
1013aa538a58Sdrh ** and SQLITE_TRANSIENT.
1014633e6d57Sdrh */
1015aa538a58Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3MallocSize)
1016633e6d57Sdrh 
101778f82d1eSdrh /*
101878f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
101978f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables.
102078f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from
102178f82d1eSdrh ** the heap.  When WSD is unsupported, the variable declarations scattered
102278f82d1eSdrh ** throughout the SQLite code must become constants instead.  The SQLITE_WSD
102378f82d1eSdrh ** macro is used for this purpose.  And instead of referencing the variable
102478f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated
102578f82d1eSdrh ** buffer that holds real variable.  The constant is also the initializer
102678f82d1eSdrh ** for the run-time allocated buffer.
102778f82d1eSdrh **
10282479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
102978f82d1eSdrh ** macros become no-ops and have zero performance impact.
103078f82d1eSdrh */
1031075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD
1032075c23afSdanielk1977   #define SQLITE_WSD const
1033075c23afSdanielk1977   #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
1034075c23afSdanielk1977   #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
1035d1d38488Sdrh   int sqlite3_wsd_init(int N, int J);
1036d1d38488Sdrh   void *sqlite3_wsd_find(void *K, int L);
1037075c23afSdanielk1977 #else
1038075c23afSdanielk1977   #define SQLITE_WSD
1039075c23afSdanielk1977   #define GLOBAL(t,v) v
1040075c23afSdanielk1977   #define sqlite3GlobalConfig sqlite3Config
1041075c23afSdanielk1977 #endif
1042075c23afSdanielk1977 
1043f3d3c27aSdanielk1977 /*
1044f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to
1045f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately
1046f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when
1047f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the
1048f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the
1049f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate,
1050f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere.
1051f3d3c27aSdanielk1977 **
1052f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function,
1053f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
1054f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to
1055f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options.
1056f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these
1057f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions.
1058f3d3c27aSdanielk1977 */
105962c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x)
1060f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
106162c14b34Sdanielk1977 
1062633e6d57Sdrh /*
106375897234Sdrh ** Forward references to structures
106475897234Sdrh */
106513449892Sdrh typedef struct AggInfo AggInfo;
1066fe05af87Sdrh typedef struct AuthContext AuthContext;
10670b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo;
1068f5e7bb51Sdrh typedef struct Bitvec Bitvec;
1069fe05af87Sdrh typedef struct CollSeq CollSeq;
10707020f651Sdrh typedef struct Column Column;
1071fe05af87Sdrh typedef struct Db Db;
1072e501b89aSdanielk1977 typedef struct Schema Schema;
107375897234Sdrh typedef struct Expr Expr;
107475897234Sdrh typedef struct ExprList ExprList;
1075c2eef3b3Sdrh typedef struct FKey FKey;
1076d2199f0fSdan typedef struct FuncDestructor FuncDestructor;
1077fe05af87Sdrh typedef struct FuncDef FuncDef;
107870a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
1079fe05af87Sdrh typedef struct IdList IdList;
1080fe05af87Sdrh typedef struct Index Index;
108102fa4696Sdan typedef struct IndexSample IndexSample;
10828d059845Sdanielk1977 typedef struct KeyClass KeyClass;
1083d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
1084633e6d57Sdrh typedef struct Lookaside Lookaside;
1085633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
1086d1ab1ba5Sdanielk1977 typedef struct Module Module;
1087626a879aSdrh typedef struct NameContext NameContext;
1088fe05af87Sdrh typedef struct Parse Parse;
108946c47d46Sdan typedef struct PreUpdate PreUpdate;
1090a5c1416dSdrh typedef struct PrintfArguments PrintfArguments;
1091cf8f2895Sdan typedef struct RenameToken RenameToken;
1092a2460e07Sdrh typedef struct RowSet RowSet;
1093fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint;
1094fe05af87Sdrh typedef struct Select Select;
1095f51446a3Sdrh typedef struct SQLiteThread SQLiteThread;
1096634d81deSdrh typedef struct SelectDest SelectDest;
1097fe05af87Sdrh typedef struct SrcList SrcList;
10980cdbe1aeSdrh typedef struct sqlite3_str StrAccum; /* Internal alias for sqlite3_str */
1099fe05af87Sdrh typedef struct Table Table;
1100c00da105Sdanielk1977 typedef struct TableLock TableLock;
1101fe05af87Sdrh typedef struct Token Token;
11024fa4a54fSdrh typedef struct TreeView TreeView;
1103a2460e07Sdrh typedef struct Trigger Trigger;
11042832ad42Sdan typedef struct TriggerPrg TriggerPrg;
1105fe05af87Sdrh typedef struct TriggerStep TriggerStep;
1106e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
110746d2e5c3Sdrh typedef struct Upsert Upsert;
1108595a523aSdanielk1977 typedef struct VTable VTable;
1109b061d058Sdan typedef struct VtabCtx VtabCtx;
11107d10d5a6Sdrh typedef struct Walker Walker;
1111fe05af87Sdrh typedef struct WhereInfo WhereInfo;
111286fb6e17Sdan typedef struct Window Window;
11137d562dbeSdan typedef struct With With;
1114d3d39e93Sdrh 
11151fe3ac73Sdrh 
11161fe3ac73Sdrh /*
11171fe3ac73Sdrh ** The bitmask datatype defined below is used for various optimizations.
11181fe3ac73Sdrh **
11191fe3ac73Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
11201fe3ac73Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
11211fe3ac73Sdrh ** of the library by 738 bytes on ix86.
11221fe3ac73Sdrh */
11231fe3ac73Sdrh #ifdef SQLITE_BITMASK_TYPE
11241fe3ac73Sdrh   typedef SQLITE_BITMASK_TYPE Bitmask;
11251fe3ac73Sdrh #else
11261fe3ac73Sdrh   typedef u64 Bitmask;
11271fe3ac73Sdrh #endif
11281fe3ac73Sdrh 
11291fe3ac73Sdrh /*
11301fe3ac73Sdrh ** The number of bits in a Bitmask.  "BMS" means "BitMask Size".
11311fe3ac73Sdrh */
11321fe3ac73Sdrh #define BMS  ((int)(sizeof(Bitmask)*8))
11331fe3ac73Sdrh 
11341fe3ac73Sdrh /*
11351fe3ac73Sdrh ** A bit in a Bitmask
11361fe3ac73Sdrh */
11371fe3ac73Sdrh #define MASKBIT(n)   (((Bitmask)1)<<(n))
11381fe3ac73Sdrh #define MASKBIT32(n) (((unsigned int)1)<<(n))
11391fe3ac73Sdrh #define ALLBITS      ((Bitmask)-1)
11401fe3ac73Sdrh 
11419bf755ccSdrh /* A VList object records a mapping between parameters/variables/wildcards
11429bf755ccSdrh ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer
11439bf755ccSdrh ** variable number associated with that parameter.  See the format description
11449bf755ccSdrh ** on the sqlite3VListAdd() routine for more information.  A VList is really
11459bf755ccSdrh ** just an array of integers.
11469bf755ccSdrh */
11479bf755ccSdrh typedef int VList;
11489bf755ccSdrh 
11492dca4ac1Sdanielk1977 /*
11502dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
11512dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
11522dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
11532dca4ac1Sdanielk1977 */
11542dca4ac1Sdanielk1977 #include "btree.h"
11552dca4ac1Sdanielk1977 #include "vdbe.h"
11562dca4ac1Sdanielk1977 #include "pager.h"
11578c0a791aSdanielk1977 #include "pcache.h"
11581cc5ed81Sdanielk1977 #include "os.h"
1159c7ce76afSdrh #include "mutex.h"
11601cc5ed81Sdanielk1977 
116133b104afSdrh /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
116233b104afSdrh ** synchronous setting to EXTRA.  It is no longer supported.
116333b104afSdrh */
116433b104afSdrh #ifdef SQLITE_EXTRA_DURABLE
116533b104afSdrh # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
116633b104afSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 3
116733b104afSdrh #endif
116833b104afSdrh 
116950a1a5aaSdrh /*
1170c2ae2073Sdrh ** Default synchronous levels.
1171c2ae2073Sdrh **
1172c2ae2073Sdrh ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
1173c2ae2073Sdrh ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
1174c2ae2073Sdrh **
1175c2ae2073Sdrh **           PAGER_SYNCHRONOUS       DEFAULT_SYNCHRONOUS
1176c2ae2073Sdrh **   OFF           1                         0
1177c2ae2073Sdrh **   NORMAL        2                         1
1178c2ae2073Sdrh **   FULL          3                         2
1179c2ae2073Sdrh **   EXTRA         4                         3
1180c2ae2073Sdrh **
1181c2ae2073Sdrh ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
1182c2ae2073Sdrh ** In other words, the zero-based numbers are used for all external interfaces
1183c2ae2073Sdrh ** and the one-based values are used internally.
118450a1a5aaSdrh */
118550a1a5aaSdrh #ifndef SQLITE_DEFAULT_SYNCHRONOUS
11863e7d012eSdrh # define SQLITE_DEFAULT_SYNCHRONOUS 2
118750a1a5aaSdrh #endif
118850a1a5aaSdrh #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
118950a1a5aaSdrh # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
119050a1a5aaSdrh #endif
1191eee4c8caSdrh 
1192001bbcbbSdrh /*
1193001bbcbbSdrh ** Each database file to be accessed by the system is an instance
1194001bbcbbSdrh ** of the following structure.  There are normally two of these structures
1195001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
1196a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
1197a69d9168Sdrh ** databases may be attached.
1198001bbcbbSdrh */
1199001bbcbbSdrh struct Db {
120069c33826Sdrh   char *zDbSName;      /* Name of this database. (schema name, not filename) */
1201001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
1202467bcf36Sshane   u8 safety_level;     /* How aggressive at syncing data to disk */
120350a1a5aaSdrh   u8 bSyncSet;         /* True if "PRAGMA synchronous=N" has been run */
1204e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
1205da184236Sdanielk1977 };
1206da184236Sdanielk1977 
1207da184236Sdanielk1977 /*
1208da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
12092120608eSdrh **
12102120608eSdrh ** Most Schema objects are associated with a Btree.  The exception is
12112120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
12122120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple
12132120608eSdrh ** Btrees that refer to the same underlying BtShared object.
12142120608eSdrh **
12152120608eSdrh ** Schema objects are automatically deallocated when the last Btree that
12162120608eSdrh ** references them is destroyed.   The TEMP Schema is manually freed by
12172120608eSdrh ** sqlite3_close().
12182120608eSdrh *
12192120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order
12202120608eSdrh ** to access Schema content.  This implies that the thread must also be
12212120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
122255a0959aSdrh ** For a TEMP Schema, only the connection mutex is required.
1223da184236Sdanielk1977 */
1224e501b89aSdanielk1977 struct Schema {
1225001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
1226c2a75551Sdrh   int iGeneration;     /* Generation counter.  Incremented with each change */
1227d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
1228d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
1229d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
12301da40a38Sdan   Hash fkeyHash;       /* All foreign keys by referenced table name */
12314794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
1232da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
12338079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
12342c5e35ffSdrh   u16 schemaFlags;     /* Flags associated with this schema */
123514db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
1236001bbcbbSdrh };
123775897234Sdrh 
123875897234Sdrh /*
12398bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
1240a2460e07Sdrh ** Db.pSchema->flags field.
12418bf8dc92Sdrh */
12422c5e35ffSdrh #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
12432c5e35ffSdrh #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
12442c5e35ffSdrh #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->schemaFlags|=(P)
12452c5e35ffSdrh #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->schemaFlags&=~(P)
12468bf8dc92Sdrh 
12478bf8dc92Sdrh /*
1248a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field.
12498bf8dc92Sdrh **
12508bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
12518bf8dc92Sdrh ** read into internal hash tables.
12528bf8dc92Sdrh **
12538bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
12548bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
12558bf8dc92Sdrh ** changes and so the view will need to be reset.
12568bf8dc92Sdrh */
1257124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
1258124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
1259b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
1260dc6b41edSdrh #define DB_ResetWanted     0x0008  /* Reset the schema when nSchemaLock==0 */
12618bf8dc92Sdrh 
1262caa639f4Sdrh /*
1263caa639f4Sdrh ** The number of different kinds of things that can be limited
1264caa639f4Sdrh ** using the sqlite3_limit() interface.
1265caa639f4Sdrh */
1266111544cbSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
12678bf8dc92Sdrh 
12688bf8dc92Sdrh /*
1269633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
1270467bcf36Sshane ** to satisfy small transient memory allocation requests for objects
1271633e6d57Sdrh ** associated with a particular database connection.  The use of
1272633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
1273633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
1274633e6d57Sdrh ** SQL statements.
1275633e6d57Sdrh **
1276633e6d57Sdrh ** The Lookaside structure holds configuration information about the
1277633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
1278633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
1279633e6d57Sdrh ** objects.
1280d9da78a2Sdrh **
1281d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated
1282d9da78a2Sdrh ** with a particular database connection.  Hence, schema information cannot
1283d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information
1284d9da78a2Sdrh ** is shared by multiple database connections.  Therefore, while parsing
1285d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that
1286d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects.
1287633e6d57Sdrh */
1288633e6d57Sdrh struct Lookaside {
12894a642b60Sdrh   u32 bDisable;           /* Only operate the lookaside when zero */
1290633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
1291e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
129252fb8e19Sdrh   u32 nSlot;              /* Number of lookaside slots allocated */
129352fb8e19Sdrh   u32 anStat[3];          /* 0: hits.  1: size misses.  2: full misses */
129452fb8e19Sdrh   LookasideSlot *pInit;   /* List of buffers not previously used */
12957d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
1296633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
1297633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
1298633e6d57Sdrh };
1299633e6d57Sdrh struct LookasideSlot {
1300633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
1301633e6d57Sdrh };
1302633e6d57Sdrh 
1303633e6d57Sdrh /*
130480738d9cSdrh ** A hash table for built-in function definitions.  (Application-defined
130580738d9cSdrh ** functions use a regular table table from hash.h.)
130670a8ca3cSdrh **
130770a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
1308a60c6301Sdrh ** Collisions are on the FuncDef.u.pHash chain.  Use the SQLITE_FUNC_HASH()
1309a60c6301Sdrh ** macro to compute a hash on the function name.
131070a8ca3cSdrh */
131180738d9cSdrh #define SQLITE_FUNC_HASH_SZ 23
131270a8ca3cSdrh struct FuncDefHash {
131380738d9cSdrh   FuncDef *a[SQLITE_FUNC_HASH_SZ];       /* Hash table for functions */
131470a8ca3cSdrh };
13158bee11a4Smistachkin #define SQLITE_FUNC_HASH(C,L) (((C)+(L))%SQLITE_FUNC_HASH_SZ)
131670a8ca3cSdrh 
1317d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1318d4530979Sdrh /*
1319d4530979Sdrh ** Information held in the "sqlite3" database connection object and used
1320d4530979Sdrh ** to manage user authentication.
1321d4530979Sdrh */
1322d4530979Sdrh typedef struct sqlite3_userauth sqlite3_userauth;
1323d4530979Sdrh struct sqlite3_userauth {
1324e933b83fSdrh   u8 authLevel;                 /* Current authentication level */
1325d4530979Sdrh   int nAuthPW;                  /* Size of the zAuthPW in bytes */
1326d4530979Sdrh   char *zAuthPW;                /* Password used to authenticate */
1327d4530979Sdrh   char *zAuthUser;              /* User name used to authenticate */
1328d4530979Sdrh };
1329d4530979Sdrh 
1330e933b83fSdrh /* Allowed values for sqlite3_userauth.authLevel */
1331e933b83fSdrh #define UAUTH_Unknown     0     /* Authentication not yet checked */
1332e933b83fSdrh #define UAUTH_Fail        1     /* User authentication failed */
1333e933b83fSdrh #define UAUTH_User        2     /* Authenticated as a normal user */
1334e933b83fSdrh #define UAUTH_Admin       3     /* Authenticated as an administrator */
1335d4530979Sdrh 
1336d4530979Sdrh /* Functions used only by user authorization logic */
1337d4530979Sdrh int sqlite3UserAuthTable(const char*);
1338e933b83fSdrh int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
13397883ecfcSdrh void sqlite3UserAuthInit(sqlite3*);
1340f442e33eSdrh void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
1341f442e33eSdrh 
1342d4530979Sdrh #endif /* SQLITE_USER_AUTHENTICATION */
1343d4530979Sdrh 
134432c6a48bSdrh /*
134532c6a48bSdrh ** typedef for the authorization callback function.
134632c6a48bSdrh */
134732c6a48bSdrh #ifdef SQLITE_USER_AUTHENTICATION
134832c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
134932c6a48bSdrh                                const char*, const char*);
135032c6a48bSdrh #else
135132c6a48bSdrh   typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
135232c6a48bSdrh                                const char*);
135332c6a48bSdrh #endif
135432c6a48bSdrh 
13553d2a529dSdrh #ifndef SQLITE_OMIT_DEPRECATED
13563d2a529dSdrh /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing
13573d2a529dSdrh ** in the style of sqlite3_trace()
13583d2a529dSdrh */
135904c6747aSdrh #define SQLITE_TRACE_LEGACY          0x40     /* Use the legacy xTrace */
136004c6747aSdrh #define SQLITE_TRACE_XPROFILE        0x80     /* Use the legacy xProfile */
13613d2a529dSdrh #else
13623d2a529dSdrh #define SQLITE_TRACE_LEGACY          0
136304c6747aSdrh #define SQLITE_TRACE_XPROFILE        0
13643d2a529dSdrh #endif /* SQLITE_OMIT_DEPRECATED */
136504c6747aSdrh #define SQLITE_TRACE_NONLEGACY_MASK  0x0f     /* Normal flags */
13663d2a529dSdrh 
1367d4530979Sdrh 
136870a8ca3cSdrh /*
1369a2460e07Sdrh ** Each database connection is an instance of the following structure.
137075897234Sdrh */
13719bb575fdSdrh struct sqlite3 {
137290f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
1373a451017dSdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
1374a451017dSdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
1375a451017dSdrh   sqlite3_mutex *mutex;         /* Connection mutex */
1376001bbcbbSdrh   Db *aDb;                      /* All backends */
1377a451017dSdrh   int nDb;                      /* Number of backends currently in use */
13788257aa8dSdrh   u32 mDbFlags;                 /* flags recording internal state */
1379fd748c64Sdrh   u64 flags;                    /* flags settable by pragmas. See below */
1380a451017dSdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
13819b4c59faSdrh   i64 szMmap;                   /* Default mmap_size setting */
1382dc6b41edSdrh   u32 nSchemaLock;              /* Do not reset the schema when non-zero */
1383522c26fbSdrh   unsigned int openFlags;       /* Flags passed to sqlite3_vfs.xOpen() */
1384fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
13854ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
13861b9f2141Sdrh   int iSysErrno;                /* Errno value from last system error */
1387a5759677Sdrh   u16 dbOptFlags;               /* Flags to enable/disable optimizations */
13889bd3cc46Sdrh   u8 enc;                       /* Text encoding */
1389fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
139090f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
139117435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
13924a642b60Sdrh   u8 bBenignMalloc;             /* Do not require OOMs if true */
13933b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
139498757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
1395a7564663Sdrh   u8 suppressErr;               /* Do not issue error messages if true */
1396b061d058Sdan   u8 vtabOnConflict;            /* Value to return for s3_vtab_on_conflict() */
1397a451017dSdrh   u8 isTransactionSavepoint;    /* True if the outermost savepoint is a TS */
13983d2a529dSdrh   u8 mTrace;                    /* zero or more SQLITE_TRACE flags */
1399b2c8559fSdrh   u8 noSharedCache;             /* True if no shared-cache backends */
1400bce04148Sdrh   u8 nSqlExec;                  /* Number of pending OP_SqlExec opcodes */
1401f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
140264202cfeSdanielk1977   u32 magic;                    /* Magic number for detect library misuse */
1403b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
1404b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
1405caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
14068930c2abSdan   int nMaxSorterMmap;           /* Maximum size of regions mapped by sorter */
14074adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
14081d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
1409a451017dSdrh     u8 iDb;                     /* Which db file is being initialized */
14101d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
1411e616735cSdrh     unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */
1412e616735cSdrh     unsigned imposterTable : 1; /* Building an imposter table */
1413e616735cSdrh     unsigned reopenMemdb : 1;   /* ATTACH is really a reopen using MemDB */
14141d85d931Sdrh   } init;
14151713afb0Sdrh   int nVdbeActive;              /* Number of VDBEs currently running */
14164f7d3a5fSdrh   int nVdbeRead;                /* Number of active VDBEs that read or write */
14174f7d3a5fSdrh   int nVdbeWrite;               /* Number of active VDBEs that read and write */
14184f7d3a5fSdrh   int nVdbeExec;                /* Number of nested calls to VdbeExec() */
1419086723a4Sdrh   int nVDestroy;                /* Number of active OP_VDestroy operations */
1420a451017dSdrh   int nExtension;               /* Number of loaded extensions */
1421a451017dSdrh   void **aExtension;            /* Array of shared library handles */
1422fca760c8Sdrh   int (*xTrace)(u32,void*,void*,void*);     /* Trace function */
142318de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
142404c6747aSdrh #ifndef SQLITE_OMIT_DEPRECATED
142519e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
142619e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
142704c6747aSdrh #endif
1428fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
1429fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
143071fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
143171fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
143294eb6a14Sdanielk1977   void *pUpdateArg;
143394eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
14341cf19758Sdrh   Parse *pParse;                /* Current parse */
14359b1c62d4Sdrh #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
143646c47d46Sdan   void *pPreUpdateArg;          /* First argument to xPreUpdateCallback */
143746c47d46Sdan   void (*xPreUpdateCallback)(   /* Registered using sqlite3_preupdate_hook() */
143846c47d46Sdan     void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
143946c47d46Sdan   );
144046c47d46Sdan   PreUpdate *pPreUpdate;        /* Context for active pre-update callback */
14419b1c62d4Sdrh #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
14425cf53537Sdan #ifndef SQLITE_OMIT_WAL
14437ed91f23Sdrh   int (*xWalCallback)(void *, sqlite3 *, const char *, int);
14447ed91f23Sdrh   void *pWalArg;
14455cf53537Sdan #endif
1446fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
1447fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
1448fcd35c7bSdrh   void *pCollNeededArg;
1449fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
1450881feaa0Sdrh   union {
145139001e75Sdrh     volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
1452881feaa0Sdrh     double notUsed1;            /* Spacer */
1453881feaa0Sdrh   } u1;
1454633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
1455ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
145632c6a48bSdrh   sqlite3_xauth xAuth;          /* Access authorization function */
1457ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
1458ed6c8671Sdrh #endif
1459348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1460348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
1461348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
14628f8c65f7Sdrh   unsigned nProgressOps;        /* Number of opcodes for progress callback */
1463348bb5d6Sdanielk1977 #endif
1464b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1465a451017dSdrh   int nVTrans;                  /* Allocated size of aVTrans */
1466b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
1467b061d058Sdan   VtabCtx *pVtabCtx;            /* Context for active vtab connect/create */
1468595a523aSdanielk1977   VTable **aVTrans;             /* Virtual tables with open transactions */
1469595a523aSdanielk1977   VTable *pDisconnect;          /* Disconnect these in next sqlite3_prepare() */
14706b456a2bSdanielk1977 #endif
147180738d9cSdrh   Hash aFunc;                   /* Hash table of connection functions */
1472fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
1473fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
1474fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
1475fd7f0452Sdanielk1977   Savepoint *pSavepoint;        /* List of active savepoints */
1476a451017dSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
1477fd7f0452Sdanielk1977   int nSavepoint;               /* Number of non-transaction savepoints */
1478bd43455cSdanielk1977   int nStatement;               /* Number of nested statement-transactions  */
14791da40a38Sdan   i64 nDeferredCons;            /* Net deferred constraints this transaction. */
1480648e2643Sdrh   i64 nDeferredImmCons;         /* Net deferred immediate constraints */
1481d46def77Sdan   int *pnBytesFreed;            /* If not NULL, increment this in DbFree() */
1482404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
1483404ca075Sdanielk1977   /* The following variables are all protected by the STATIC_MASTER
1484404ca075Sdanielk1977   ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
148565a73badSdrh   **
148665a73badSdrh   ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
148765a73badSdrh   ** unlock so that it can proceed.
148865a73badSdrh   **
148965a73badSdrh   ** When X.pBlockingConnection==Y, that means that something that X tried
149065a73badSdrh   ** tried to do recently failed with an SQLITE_LOCKED error due to locks
149165a73badSdrh   ** held by Y.
1492404ca075Sdanielk1977   */
1493404ca075Sdanielk1977   sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
1494404ca075Sdanielk1977   sqlite3 *pUnlockConnection;           /* Connection to watch for unlock */
1495404ca075Sdanielk1977   void *pUnlockArg;                     /* Argument to xUnlockNotify */
1496404ca075Sdanielk1977   void (*xUnlockNotify)(void **, int);  /* Unlock notify callback */
1497404ca075Sdanielk1977   sqlite3 *pNextBlocked;        /* Next in list of all blocked connections */
1498404ca075Sdanielk1977 #endif
1499d4530979Sdrh #ifdef SQLITE_USER_AUTHENTICATION
1500d4530979Sdrh   sqlite3_userauth auth;        /* User authentication information */
1501d4530979Sdrh #endif
150275897234Sdrh };
150375897234Sdrh 
150403b808a6Sdrh /*
150503b808a6Sdrh ** A macro to discover the encoding of a database.
150603b808a6Sdrh */
15079bd3cc46Sdrh #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
15089bd3cc46Sdrh #define ENC(db)        ((db)->enc)
150914db2665Sdanielk1977 
151075897234Sdrh /*
151107096f68Sdrh ** Possible values for the sqlite3.flags.
151249711600Sdrh **
151349711600Sdrh ** Value constraints (enforced via assert()):
151449711600Sdrh **      SQLITE_FullFSync     == PAGER_FULLFSYNC
151549711600Sdrh **      SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
151649711600Sdrh **      SQLITE_CacheSpill    == PAGER_CACHE_SPILL
151775897234Sdrh */
1518169dd928Sdrh #define SQLITE_WriteSchema    0x00000001  /* OK to update SQLITE_MASTER */
1519169dd928Sdrh #define SQLITE_LegacyFileFmt  0x00000002  /* Create new databases in format 1 */
15206841b1cbSdrh #define SQLITE_FullColNames   0x00000004  /* Show full column names on SELECT */
15216841b1cbSdrh #define SQLITE_FullFSync      0x00000008  /* Use full fsync on the backend */
15226841b1cbSdrh #define SQLITE_CkptFullFSync  0x00000010  /* Use full fsync for checkpoint */
15236841b1cbSdrh #define SQLITE_CacheSpill     0x00000020  /* OK to spill pager cache */
152440c3941cSdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
152540c3941cSdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
15261bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
15271bee3d7bSdrh                                           /*   the count using a callback. */
152840c3941cSdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
15296a535340Sdrh                                           /*   result set is empty */
1530169dd928Sdrh #define SQLITE_IgnoreChecks   0x00000200  /* Do not enforce check constraints */
1531169dd928Sdrh #define SQLITE_ReadUncommit   0x00000400  /* READ UNCOMMITTED in shared-cache */
1532169dd928Sdrh #define SQLITE_NoCkptOnClose  0x00000800  /* No checkpoint on close()/DETACH */
1533169dd928Sdrh #define SQLITE_ReverseOrder   0x00001000  /* Reverse unordered SELECTs */
1534169dd928Sdrh #define SQLITE_RecTriggers    0x00002000  /* Enable recursive triggers */
1535169dd928Sdrh #define SQLITE_ForeignKeys    0x00004000  /* Enforce foreign key constraints  */
1536169dd928Sdrh #define SQLITE_AutoIndex      0x00008000  /* Enable automatic indexes */
1537169dd928Sdrh #define SQLITE_LoadExtension  0x00010000  /* Enable load_extension */
15388257aa8dSdrh #define SQLITE_LoadExtFunc    0x00020000  /* Enable load_extension() SQL func */
15398257aa8dSdrh #define SQLITE_EnableTrigger  0x00040000  /* True to enable triggers */
15408257aa8dSdrh #define SQLITE_DeferFKs       0x00080000  /* Defer all FK constraints */
15418257aa8dSdrh #define SQLITE_QueryOnly      0x00100000  /* Disable database changes */
15428257aa8dSdrh #define SQLITE_CellSizeCk     0x00200000  /* Check btree cell sizes on load */
15438257aa8dSdrh #define SQLITE_Fts3Tokenizer  0x00400000  /* Enable fts3_tokenizer(2) */
15448257aa8dSdrh #define SQLITE_EnableQPSG     0x00800000  /* Query Planner Stability Guarantee*/
154536e31c69Sdrh #define SQLITE_TriggerEQP     0x01000000  /* Show trigger EXPLAIN QUERY PLAN */
15460314cf3aSdrh #define SQLITE_ResetDatabase  0x02000000  /* Reset the database */
1547674b8942Sdan #define SQLITE_LegacyAlter    0x04000000  /* Legacy ALTER TABLE behaviour */
1548fd748c64Sdrh #define SQLITE_NoSchemaError  0x08000000  /* Do not report schema parse errors*/
1549a296cda0Sdrh #define SQLITE_Defensive      0x10000000  /* Input SQL is likely hostile */
155036e31c69Sdrh 
1551169dd928Sdrh /* Flags used only if debugging */
1552fd748c64Sdrh #define HI(X)  ((u64)(X)<<32)
1553169dd928Sdrh #ifdef SQLITE_DEBUG
1554fd748c64Sdrh #define SQLITE_SqlTrace       HI(0x0001)  /* Debug print SQL as it executes */
1555fd748c64Sdrh #define SQLITE_VdbeListing    HI(0x0002)  /* Debug listings of VDBE progs */
1556fd748c64Sdrh #define SQLITE_VdbeTrace      HI(0x0004)  /* True to trace VDBE execution */
1557fd748c64Sdrh #define SQLITE_VdbeAddopTrace HI(0x0008)  /* Trace sqlite3VdbeAddOp() calls */
1558fd748c64Sdrh #define SQLITE_VdbeEQP        HI(0x0010)  /* Debug EXPLAIN QUERY PLAN */
15599b747068Sdrh #define SQLITE_ParserTrace    HI(0x0020)  /* PRAGMA parser_trace=ON */
1560169dd928Sdrh #endif
1561b1eaa718Sdrh 
15628257aa8dSdrh /*
15638257aa8dSdrh ** Allowed values for sqlite3.mDbFlags
15648257aa8dSdrh */
15658257aa8dSdrh #define DBFLAG_SchemaChange   0x0001  /* Uncommitted Hash table changes */
15668257aa8dSdrh #define DBFLAG_PreferBuiltin  0x0002  /* Preference to built-in funcs */
15678257aa8dSdrh #define DBFLAG_Vacuum         0x0004  /* Currently in a VACUUM */
15684e61e883Sdrh #define DBFLAG_VacuumInto     0x0008  /* Currently running VACUUM INTO */
15694e61e883Sdrh #define DBFLAG_SchemaKnownOk  0x0010  /* Schema is known to be valid */
157007096f68Sdrh 
157107096f68Sdrh /*
15727e5418e4Sdrh ** Bits of the sqlite3.dbOptFlags field that are used by the
15737e5418e4Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
15747e5418e4Sdrh ** selectively disable various optimizations.
157507096f68Sdrh */
15767e5418e4Sdrh #define SQLITE_QueryFlattener 0x0001   /* Query flattening */
157794809086Sdrh #define SQLITE_WindowFunc     0x0002   /* Use xInverse for window functions */
15787e5418e4Sdrh #define SQLITE_GroupByOrder   0x0004   /* GROUPBY cover of ORDERBY */
15797e5418e4Sdrh #define SQLITE_FactorOutConst 0x0008   /* Constant factoring */
158025c221ebSdrh #define SQLITE_DistinctOpt    0x0010   /* DISTINCT using indexes */
158125c221ebSdrh #define SQLITE_CoverIdxScan   0x0020   /* Covering index scans */
158225c221ebSdrh #define SQLITE_OrderByIdxJoin 0x0040   /* ORDER BY of joins via index */
158325c221ebSdrh #define SQLITE_Transitive     0x0080   /* Transitive constraints */
158425c221ebSdrh #define SQLITE_OmitNoopJoin   0x0100   /* Omit unused tables in joins */
158524ae373aSdrh #define SQLITE_CountOfView    0x0200   /* The count-of-view optimization */
158624ae373aSdrh #define SQLITE_CursorHints    0x0400   /* Add OP_CursorHint opcodes */
1587d7d71470Sdrh #define SQLITE_Stat34         0x0800   /* Use STAT3 or STAT4 data */
158824ae373aSdrh    /* TH3 expects the Stat34  ^^^^^^ value to be 0x0800.  Don't change it */
15892d277bb5Sdrh #define SQLITE_PushDown       0x1000   /* The push-down optimization */
15902589787cSdrh #define SQLITE_SimplifyJoin   0x2000   /* Convert LEFT JOIN to JOIN */
1591e8825519Sdan #define SQLITE_SkipScan       0x4000   /* Skip-scans */
1592660ee556Sdrh #define SQLITE_PropagateConst 0x8000   /* The constant propagation opt */
1593a5759677Sdrh #define SQLITE_AllOpts        0xffff   /* All optimizations */
15947e5418e4Sdrh 
15957e5418e4Sdrh /*
15967e5418e4Sdrh ** Macros for testing whether or not optimizations are enabled or disabled.
15977e5418e4Sdrh */
15987e5418e4Sdrh #define OptimizationDisabled(db, mask)  (((db)->dbOptFlags&(mask))!=0)
15997e5418e4Sdrh #define OptimizationEnabled(db, mask)   (((db)->dbOptFlags&(mask))==0)
160034c68fbaSdanielk1977 
160158b9576bSdrh /*
1602d9f158e7Sdrh ** Return true if it OK to factor constant expressions into the initialization
1603d9f158e7Sdrh ** code. The argument is a Parse object for the code generator.
1604d9f158e7Sdrh */
1605aceb31b1Sdrh #define ConstFactorOk(P) ((P)->okConstFactor)
1606d9f158e7Sdrh 
1607d9f158e7Sdrh /*
1608247be43dSdrh ** Possible values for the sqlite.magic field.
1609247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
1610247be43dSdrh ** than being distinct from one another.
1611247be43dSdrh */
1612247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
1613247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
16147e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
1615247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
1616247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
16174245c405Sdrh #define SQLITE_MAGIC_ZOMBIE   0x64cffc7f  /* Close with last statement close */
1618247be43dSdrh 
1619247be43dSdrh /*
16200bce8354Sdrh ** Each SQL function is defined by an instance of the following
162180738d9cSdrh ** structure.  For global built-in functions (ex: substr(), max(), count())
162280738d9cSdrh ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
162380738d9cSdrh ** For per-connection application-defined functions, a pointer to this
162480738d9cSdrh ** structure is held in the db->aHash hash table.
162580738d9cSdrh **
162680738d9cSdrh ** The u.pHash field is used by the global built-ins.  The u.pDestructor
162780738d9cSdrh ** field is used by per-connection app-def functions.
16282803757aSdrh */
16290bce8354Sdrh struct FuncDef {
163080738d9cSdrh   i8 nArg;             /* Number of arguments.  -1 means unlimited */
1631dfa552f4Sdan   u32 funcFlags;       /* Some combination of SQLITE_FUNC_* */
16321350b030Sdrh   void *pUserData;     /* User data parameter */
16330bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
16342d80151fSdrh   void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
16352d80151fSdrh   void (*xFinalize)(sqlite3_context*);                  /* Agg finalizer */
163686fb6e17Sdan   void (*xValue)(sqlite3_context*);                     /* Current agg value */
163786fb6e17Sdan   void (*xInverse)(sqlite3_context*,int,sqlite3_value**); /* inverse agg-step */
16386ad224e9Sdrh   const char *zName;   /* SQL name of the function. */
163980738d9cSdrh   union {
164070a8ca3cSdrh     FuncDef *pHash;      /* Next with a different name but the same hash */
1641d2199f0fSdan     FuncDestructor *pDestructor;   /* Reference counted destructor function */
164280738d9cSdrh   } u;
1643d2199f0fSdan };
1644d2199f0fSdan 
1645d2199f0fSdan /*
1646d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as
1647d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When
1648d2199f0fSdan ** create_function_v2() is called to create a function with a destructor,
1649d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to
1650d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether
1651d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
1652d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated
1653d2199f0fSdan ** FuncDestructor.
1654d2199f0fSdan **
1655d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference
1656d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor
1657d2199f0fSdan ** is invoked and the FuncDestructor structure freed.
1658d2199f0fSdan */
1659d2199f0fSdan struct FuncDestructor {
1660d2199f0fSdan   int nRef;
1661d2199f0fSdan   void (*xDestroy)(void *);
1662d2199f0fSdan   void *pUserData;
16638e0a2f90Sdrh };
16642803757aSdrh 
16652803757aSdrh /*
1666a748fdccSdrh ** Possible values for FuncDef.flags.  Note that the _LENGTH and _TYPEOF
16677977fa3aSdrh ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG.  And
16687977fa3aSdrh ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC.  There
1669a748fdccSdrh ** are assert() statements in the code to verify this.
167049711600Sdrh **
167149711600Sdrh ** Value constraints (enforced via assert()):
167249711600Sdrh **     SQLITE_FUNC_MINMAX    ==  NC_MinMaxAgg      == SF_MinMaxAgg
167349711600Sdrh **     SQLITE_FUNC_LENGTH    ==  OPFLAG_LENGTHARG
167449711600Sdrh **     SQLITE_FUNC_TYPEOF    ==  OPFLAG_TYPEOFARG
167549711600Sdrh **     SQLITE_FUNC_CONSTANT  ==  SQLITE_DETERMINISTIC from the API
167649711600Sdrh **     SQLITE_FUNC_ENCMASK   depends on SQLITE_UTF* macros in the API
16777d10d5a6Sdrh */
16781d85e405Sdrh #define SQLITE_FUNC_ENCMASK  0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
16791d85e405Sdrh #define SQLITE_FUNC_LIKE     0x0004 /* Candidate for the LIKE optimization */
16801d85e405Sdrh #define SQLITE_FUNC_CASE     0x0008 /* Case-sensitive LIKE-type function */
16811d85e405Sdrh #define SQLITE_FUNC_EPHEM    0x0010 /* Ephemeral.  Delete with VDBE */
16821d85e405Sdrh #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
16831d85e405Sdrh #define SQLITE_FUNC_LENGTH   0x0040 /* Built-in length() function */
16841d85e405Sdrh #define SQLITE_FUNC_TYPEOF   0x0080 /* Built-in typeof() function */
16851d85e405Sdrh #define SQLITE_FUNC_COUNT    0x0100 /* Built-in count(*) aggregate */
16861d85e405Sdrh #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */
16871d85e405Sdrh #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
16881d85e405Sdrh #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
16899588ad95Sdrh #define SQLITE_FUNC_MINMAX   0x1000 /* True for min() and max() aggregates */
1690a7f910b5Sdrh #define SQLITE_FUNC_SLOCHNG  0x2000 /* "Slow Change". Value constant during a
1691a7f910b5Sdrh                                     ** single query - might change over time */
1692a1a523a5Sdrh #define SQLITE_FUNC_AFFINITY 0x4000 /* Built-in affinity() function */
1693092457b1Sdrh #define SQLITE_FUNC_OFFSET   0x8000 /* Built-in sqlite_offset() function */
1694eea8eb6dSdrh #define SQLITE_FUNC_WINDOW   0x00010000 /* Built-in window-only function */
1695eea8eb6dSdrh #define SQLITE_FUNC_INTERNAL 0x00040000 /* For use by NestedParse() only */
16967d10d5a6Sdrh 
16977d10d5a6Sdrh /*
1698777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1699777c5386Sdrh ** used to create the initializers for the FuncDef structures.
1700777c5386Sdrh **
1701777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
1702777c5386Sdrh **     Used to create a scalar function definition of a function zName
1703777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
1704777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
1705777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
1706f7bca574Sdrh **     argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1707777c5386Sdrh **
1708b1fba286Sdrh **   VFUNCTION(zName, nArg, iArg, bNC, xFunc)
1709b1fba286Sdrh **     Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
1710b1fba286Sdrh **
17111d85e405Sdrh **   DFUNCTION(zName, nArg, iArg, bNC, xFunc)
17121d85e405Sdrh **     Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
1713a7f910b5Sdrh **     adds the SQLITE_FUNC_SLOCHNG flag.  Used for date & time functions
171403bf26d9Sdrh **     and functions like sqlite_version() that can change, but not during
17153e34eabcSdrh **     a single query.  The iArg is ignored.  The user-data is always set
17163e34eabcSdrh **     to a NULL pointer.  The bNC parameter is not used.
17173e34eabcSdrh **
17183e34eabcSdrh **   PURE_DATE(zName, nArg, iArg, bNC, xFunc)
17193e34eabcSdrh **     Used for "pure" date/time functions, this macro is like DFUNCTION
17203e34eabcSdrh **     except that it does set the SQLITE_FUNC_CONSTANT flags.  iArg is
17213e34eabcSdrh **     ignored and the user-data for these functions is set to an
17223e34eabcSdrh **     arbitrary non-NULL pointer.  The bNC parameter is not used.
17231d85e405Sdrh **
1724777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1725777c5386Sdrh **     Used to create an aggregate function definition implemented by
1726777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
1727777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
1728777c5386Sdrh **     FUNCTION().
1729777c5386Sdrh **
173086fb6e17Sdan **   WFUNCTION(zName, nArg, iArg, xStep, xFinal, xValue, xInverse)
173186fb6e17Sdan **     Used to create an aggregate function definition implemented by
173286fb6e17Sdan **     the C functions xStep and xFinal. The first four parameters
173386fb6e17Sdan **     are interpreted in the same way as the first 4 parameters to
173486fb6e17Sdan **     FUNCTION().
173586fb6e17Sdan **
1736777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
1737777c5386Sdrh **     Used to create a scalar function definition of a function zName
1738777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
1739777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
1740777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
1741777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
1742777c5386Sdrh **     parameter.
1743777c5386Sdrh */
1744777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
1745b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
174686fb6e17Sdan    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
1747b1fba286Sdrh #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
1748d36e1041Sdrh   {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
174986fb6e17Sdan    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
17501d85e405Sdrh #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
17513e34eabcSdrh   {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \
175286fb6e17Sdan    0, 0, xFunc, 0, 0, 0, #zName, {0} }
17533e34eabcSdrh #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \
17543e34eabcSdrh   {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \
175586fb6e17Sdan    (void*)&sqlite3Config, 0, xFunc, 0, 0, 0, #zName, {0} }
1756a748fdccSdrh #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
1757b1fba286Sdrh   {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
175886fb6e17Sdan    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, 0, #zName, {0} }
175921717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
1760a7f910b5Sdrh   {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
176186fb6e17Sdan    pArg, 0, xFunc, 0, 0, 0, #zName, }
1762777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
1763b1fba286Sdrh   {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
176486fb6e17Sdan    (void *)arg, 0, likeFunc, 0, 0, 0, #zName, {0} }
1765e2f781b9Sdan #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue) \
1766d36e1041Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
1767e2f781b9Sdan    SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,0,#zName, {0}}
17689588ad95Sdrh #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
17699588ad95Sdrh   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
1770e2f781b9Sdan    SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xFinal,0,#zName, {0}}
17716fb2b54cSdan #define WAGGREGATE(zName, nArg, arg, nc, xStep, xFinal, xValue, xInverse, f) \
17726fb2b54cSdan   {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|f, \
177303854d2eSdan    SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,xValue,xInverse,#zName, {0}}
1774eea8eb6dSdrh #define INTERNAL_FUNCTION(zName, nArg, xFunc) \
1775eea8eb6dSdrh   {nArg, SQLITE_FUNC_INTERNAL|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \
1776eea8eb6dSdrh    0, 0, xFunc, 0, 0, 0, #zName, {0} }
1777eea8eb6dSdrh 
1778777c5386Sdrh 
1779fd7f0452Sdanielk1977 /*
1780fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at
1781fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently
1782fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe
1783fd7f0452Sdanielk1977 ** OP_Savepoint instruction.
1784fd7f0452Sdanielk1977 */
1785fd7f0452Sdanielk1977 struct Savepoint {
1786fd7f0452Sdanielk1977   char *zName;                        /* Savepoint name (nul-terminated) */
1787fcb9f7adSdrh   i64 nDeferredCons;                  /* Number of deferred fk violations */
1788648e2643Sdrh   i64 nDeferredImmCons;               /* Number of deferred imm fk. */
1789fd7f0452Sdanielk1977   Savepoint *pNext;                   /* Parent savepoint (if any) */
1790fd7f0452Sdanielk1977 };
1791fd7f0452Sdanielk1977 
1792fd7f0452Sdanielk1977 /*
1793fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(),
1794fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction.
1795fd7f0452Sdanielk1977 */
1796fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN      0
1797fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE    1
1798fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK   2
1799fd7f0452Sdanielk1977 
1800777c5386Sdrh 
1801777c5386Sdrh /*
1802d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
1803d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
1804d1ab1ba5Sdanielk1977 ** hash table.
1805d1ab1ba5Sdanielk1977 */
1806d1ab1ba5Sdanielk1977 struct Module {
1807d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
1808d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
1809d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
1810832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
181151be3873Sdrh   Table *pEpoTab;                      /* Eponymous table for this module */
1812d1ab1ba5Sdanielk1977 };
1813d1ab1ba5Sdanielk1977 
1814d1ab1ba5Sdanielk1977 /*
1815967e8b73Sdrh ** information about each column of an SQL table is held in an instance
18167020f651Sdrh ** of this structure.
18177020f651Sdrh */
18187020f651Sdrh struct Column {
181994eaafa9Sdrh   char *zName;     /* Name of this column, \000, then the type */
18207977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
1821b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
1822a371ace4Sdrh   u8 notNull;      /* An OE_ code for handling a NOT NULL constraint */
1823a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
1824e5520e2fSdrh   u8 szEst;        /* Estimated size of value in this column. sizeof(INT)==1 */
1825fdaac671Sdrh   u8 colFlags;     /* Boolean properties.  See COLFLAG_ defines below */
18267020f651Sdrh };
18277020f651Sdrh 
1828a371ace4Sdrh /* Allowed values for Column.colFlags:
1829a371ace4Sdrh */
1830a371ace4Sdrh #define COLFLAG_PRIMKEY  0x0001    /* Column is part of the primary key */
1831a371ace4Sdrh #define COLFLAG_HIDDEN   0x0002    /* A hidden column in a virtual table */
1832d7564865Sdrh #define COLFLAG_HASTYPE  0x0004    /* Type name follows column name */
183326e731ccSdan #define COLFLAG_UNIQUE   0x0008    /* Column def contains "UNIQUE" or "PK" */
18342e3a5a81Sdan #define COLFLAG_SORTERREF 0x0010   /* Use sorter-refs with this column */
1835a371ace4Sdrh 
18367020f651Sdrh /*
1837a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
18380202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
18390202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
1840a9fd84b0Sdrh **
1841e6f1e760Sdrh ** If CollSeq.xCmp is NULL, it means that the
18420202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
18430202b29eSdanielk1977 ** collating sequence may not be read or written.
1844a9fd84b0Sdrh */
1845a9fd84b0Sdrh struct CollSeq {
18460202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
1847466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
1848a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
18490202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
1850a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
1851a9fd84b0Sdrh };
1852a9fd84b0Sdrh 
1853a9fd84b0Sdrh /*
1854d3d39e93Sdrh ** A sort order can be either ASC or DESC.
18558e2ca029Sdrh */
18568e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
1857d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
1858bc622bc0Sdrh #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
18598e2ca029Sdrh 
18608e2ca029Sdrh /*
1861a37cdde0Sdanielk1977 ** Column affinity types.
18628a51256cSdrh **
18638a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
18648a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
18657d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
18668a51256cSdrh **
18674583c37cSdrh ** But rather than start with 0 or 1, we begin with 'A'.  That way,
18688a51256cSdrh ** when multiple affinity types are concatenated into a string and
186966a5167bSdrh ** used as the P4 operand, they will be more readable.
18708a51256cSdrh **
18718a51256cSdrh ** Note also that the numeric types are grouped together so that testing
187205883a34Sdrh ** for a numeric type is a single comparison.  And the BLOB type is first.
1873a37cdde0Sdanielk1977 */
187405883a34Sdrh #define SQLITE_AFF_BLOB     'A'
18754583c37cSdrh #define SQLITE_AFF_TEXT     'B'
18764583c37cSdrh #define SQLITE_AFF_NUMERIC  'C'
18774583c37cSdrh #define SQLITE_AFF_INTEGER  'D'
18784583c37cSdrh #define SQLITE_AFF_REAL     'E'
1879a37cdde0Sdanielk1977 
18808a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
1881a37cdde0Sdanielk1977 
1882a37cdde0Sdanielk1977 /*
188335573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
188435573356Sdrh ** affinity value.
188535573356Sdrh */
18864583c37cSdrh #define SQLITE_AFF_MASK     0x47
188735573356Sdrh 
188835573356Sdrh /*
188935573356Sdrh ** Additional bit values that can be ORed with an affinity without
189035573356Sdrh ** changing the affinity.
18913d77dee9Sdrh **
18923d77dee9Sdrh ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
18933d77dee9Sdrh ** It causes an assert() to fire if either operand to a comparison
18943d77dee9Sdrh ** operator is NULL.  It is added to certain comparison operators to
18953d77dee9Sdrh ** prove that the operands are always NOT NULL.
189635573356Sdrh */
189779752b6eSdrh #define SQLITE_KEEPNULL     0x08  /* Used by vector == or <> */
18984583c37cSdrh #define SQLITE_JUMPIFNULL   0x10  /* jumps if either operand is NULL */
18994583c37cSdrh #define SQLITE_STOREP2      0x20  /* Store result in reg[P2] rather than jump */
19006a2fe093Sdrh #define SQLITE_NULLEQ       0x80  /* NULL=NULL */
19014583c37cSdrh #define SQLITE_NOTNULL      0x90  /* Assert that operands are never NULL */
190235573356Sdrh 
190335573356Sdrh /*
1904595a523aSdanielk1977 ** An object of this type is created for each virtual table present in
1905595a523aSdanielk1977 ** the database schema.
1906595a523aSdanielk1977 **
1907595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this
1908595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared
1909595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique
1910595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table
1911595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between
1912595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database
1913595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database
1914595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method
1915595a523aSdanielk1977 ** during initialization internally. This database connection handle may
19169bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables
1917595a523aSdanielk1977 ** within the database. So that they appear as part of the callers
1918595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database
1919595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table.
1920595a523aSdanielk1977 **
1921595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared
1922595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by
1923595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object.
1924595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual
1925595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the
1926595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct
1927595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query.
1928595a523aSdanielk1977 **
1929595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the
1930595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not
1931595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1932595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to
1933595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the
1934595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
1935595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done
1936595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1937595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an
1938595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1939595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex.
1940595a523aSdanielk1977 **
1941595a523aSdanielk1977 ** The memory for objects of this type is always allocated by
1942595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1943595a523aSdanielk1977 ** the first argument.
1944595a523aSdanielk1977 */
1945595a523aSdanielk1977 struct VTable {
1946595a523aSdanielk1977   sqlite3 *db;              /* Database connection associated with this table */
1947595a523aSdanielk1977   Module *pMod;             /* Pointer to module implementation */
1948595a523aSdanielk1977   sqlite3_vtab *pVtab;      /* Pointer to vtab instance */
1949595a523aSdanielk1977   int nRef;                 /* Number of pointers to this structure */
1950b061d058Sdan   u8 bConstraint;           /* True if constraints are supported */
1951addd8f87Sdrh   int iSavepoint;           /* Depth of the SAVEPOINT stack */
1952595a523aSdanielk1977   VTable *pNext;            /* Next in linked list (see above) */
1953595a523aSdanielk1977 };
1954595a523aSdanielk1977 
1955595a523aSdanielk1977 /*
19565789d1a4Sdrh ** The schema for each SQL table and view is represented in memory
19575789d1a4Sdrh ** by an instance of the following structure.
195875897234Sdrh */
195975897234Sdrh struct Table {
19607d10d5a6Sdrh   char *zName;         /* Name of the table or view */
19617020f651Sdrh   Column *aCol;        /* Information about each column */
1962967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
1963a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
1964c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
19653d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
19662938f924Sdrh   ExprList *pCheck;    /* All CHECK constraints */
19678981b904Sdrh                        /*   ... also used as column name list in a VIEW */
19685789d1a4Sdrh   int tnum;            /* Root BTree page for this table */
196979df7782Sdrh   u32 nTabRef;         /* Number of pointers to this Table */
19706f271a42Sdrh   u32 tabFlags;        /* Mask of TF_* values */
19715789d1a4Sdrh   i16 iPKey;           /* If not negative, use aCol[iPKey] as the rowid */
1972d815f17dSdrh   i16 nCol;            /* Number of columns in this table */
19735789d1a4Sdrh   LogEst nRowLogEst;   /* Estimated rows in table - from sqlite_stat1 table */
1974bf539c4dSdrh   LogEst szTabRow;     /* Estimated size of each table row in bytes */
1975dbd9486dSdrh #ifdef SQLITE_ENABLE_COSTMULT
1976dbd9486dSdrh   LogEst costMult;     /* Cost multiplier for using this table */
1977dbd9486dSdrh #endif
1978d815f17dSdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
197919a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
19807d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
198119a8e7e8Sdanielk1977 #endif
1982e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1983b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
19848a48b9c0Sdrh   char **azModuleArg;  /* 0: module 1: schema 2: vtab name 3...: args */
1985d815f17dSdrh   VTable *pVTable;     /* List of VTable objects. */
1986e09daa90Sdrh #endif
19872f886d1dSdanielk1977   Trigger *pTrigger;   /* List of triggers stored in pSchema */
1988728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
1989588a9a1aSdrh   Table *pNextZombie;  /* Next on the Parse.pZombieTab list */
199075897234Sdrh };
199175897234Sdrh 
199275897234Sdrh /*
19938ce7184bSdan ** Allowed values for Table.tabFlags.
1994a21f78b9Sdrh **
199580090f92Sdrh ** TF_OOOHidden applies to tables or view that have hidden columns that are
1996a21f78b9Sdrh ** followed by non-hidden columns.  Example:  "CREATE VIRTUAL TABLE x USING
1997a21f78b9Sdrh ** vtab1(a HIDDEN, b);".  Since "b" is a non-hidden column but "a" is hidden,
1998a21f78b9Sdrh ** the TF_OOOHidden attribute would apply in this case.  Such tables require
1999a21f78b9Sdrh ** special handling during INSERT processing.
20007d10d5a6Sdrh */
200133bec3f5Sdrh #define TF_Readonly        0x0001    /* Read-only system table */
200233bec3f5Sdrh #define TF_Ephemeral       0x0002    /* An ephemeral table */
200333bec3f5Sdrh #define TF_HasPrimaryKey   0x0004    /* Table has a primary key */
200433bec3f5Sdrh #define TF_Autoincrement   0x0008    /* Integer primary key is autoincrement */
2005a3928dd7Sdrh #define TF_HasStat1        0x0010    /* nRowLogEst set from sqlite_stat1 */
200633bec3f5Sdrh #define TF_WithoutRowid    0x0020    /* No rowid.  PRIMARY KEY is the key */
200733bec3f5Sdrh #define TF_NoVisibleRowid  0x0040    /* No user-visible "rowid" column */
200833bec3f5Sdrh #define TF_OOOHidden       0x0080    /* Out-of-Order hidden columns */
20095e98e838Sdrh #define TF_StatsUsed       0x0100    /* Query planner decisions affected by
2010a3928dd7Sdrh                                      ** Index.aiRowLogEst[] values */
2011114ce7a4Sdrh #define TF_HasNotNull      0x0200    /* Contains NOT NULL constraints */
201284c501baSdrh #define TF_Shadow          0x0400    /* True for a shadow table */
20137d10d5a6Sdrh 
20147d10d5a6Sdrh /*
20154cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
20164cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
20174cbdda9eSdrh ** table support is omitted from the build.
20184cbdda9eSdrh */
20194cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
202044266ec6Sdrh #  define IsVirtual(X)      ((X)->nModuleArg)
20214cbdda9eSdrh #else
20224cbdda9eSdrh #  define IsVirtual(X)      0
20234cbdda9eSdrh #endif
20244cbdda9eSdrh 
202503d69a68Sdrh /*
202603d69a68Sdrh ** Macros to determine if a column is hidden.  IsOrdinaryHiddenColumn()
202703d69a68Sdrh ** only works for non-virtual tables (ordinary tables and views) and is
202803d69a68Sdrh ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined.  The
202903d69a68Sdrh ** IsHiddenColumn() macro is general purpose.
203003d69a68Sdrh */
203103d69a68Sdrh #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
203203d69a68Sdrh #  define IsHiddenColumn(X)         (((X)->colFlags & COLFLAG_HIDDEN)!=0)
203303d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
203418f8e734Sdrh #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
203503d69a68Sdrh #  define IsHiddenColumn(X)         (((X)->colFlags & COLFLAG_HIDDEN)!=0)
203603d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) 0
203703d69a68Sdrh #else
203803d69a68Sdrh #  define IsHiddenColumn(X)         0
203903d69a68Sdrh #  define IsOrdinaryHiddenColumn(X) 0
204003d69a68Sdrh #endif
204103d69a68Sdrh 
204203d69a68Sdrh 
2043ec95c441Sdrh /* Does the table have a rowid */
2044ec95c441Sdrh #define HasRowid(X)     (((X)->tabFlags & TF_WithoutRowid)==0)
2045fccda8a1Sdrh #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
2046ec95c441Sdrh 
20474cbdda9eSdrh /*
2048c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
2049c2eef3b3Sdrh **
2050c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
2051c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
2052c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
2053c2eef3b3Sdrh ** Consider this example:
2054c2eef3b3Sdrh **
2055c2eef3b3Sdrh **     CREATE TABLE ex1(
2056c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
2057c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
2058c2eef3b3Sdrh **     );
2059c2eef3b3Sdrh **
2060c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
2061bd50a926Sdrh ** Equivalent names:
2062bd50a926Sdrh **
2063bd50a926Sdrh **     from-table == child-table
2064bd50a926Sdrh **       to-table == parent-table
2065c2eef3b3Sdrh **
2066c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
2067c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
2068e61922a6Sdrh ** the from-table is created.  The existence of the to-table is not checked.
2069bd50a926Sdrh **
2070bd50a926Sdrh ** The list of all parents for child Table X is held at X.pFKey.
2071bd50a926Sdrh **
2072bd50a926Sdrh ** A list of all children for a table named Z (which might not even exist)
2073bd50a926Sdrh ** is held in Schema.fkeyHash with a hash key of Z.
2074c2eef3b3Sdrh */
2075c2eef3b3Sdrh struct FKey {
20761f638cebSdrh   Table *pFrom;     /* Table containing the REFERENCES clause (aka: Child) */
2077bd50a926Sdrh   FKey *pNextFrom;  /* Next FKey with the same in pFrom. Next parent of pFrom */
20781f638cebSdrh   char *zTo;        /* Name of table that the key points to (aka: Parent) */
2079bd50a926Sdrh   FKey *pNextTo;    /* Next with the same zTo. Next child of zTo. */
2080bd50a926Sdrh   FKey *pPrevTo;    /* Previous with the same zTo */
2081c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
20824c429839Sdrh   /* EV: R-30323-21917 */
2083c2eef3b3Sdrh   u8 isDeferred;       /* True if constraint checking is deferred till COMMIT */
20848099ce6fSdan   u8 aAction[2];        /* ON DELETE and ON UPDATE actions, respectively */
20858099ce6fSdan   Trigger *apTrigger[2];/* Triggers for aAction[] actions */
2086e61922a6Sdrh   struct sColMap {      /* Mapping of columns in pFrom to columns in zTo */
2087e61922a6Sdrh     int iFrom;            /* Index of column in pFrom */
2088bd50a926Sdrh     char *zCol;           /* Name of column in zTo.  If NULL use PRIMARY KEY */
2089e61922a6Sdrh   } aCol[1];            /* One entry for each of nCol columns */
2090c2eef3b3Sdrh };
2091c2eef3b3Sdrh 
2092c2eef3b3Sdrh /*
2093aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
209422f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
20950bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
20961c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
20971c92853dSdrh ** fails and any prior changes from that one operation are backed out,
20981c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
20991c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
21001c92853dSdrh ** changes due to the same operation are not backed out and no rollback
21011c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
21021c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
21031c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
21041c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
21051c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
21061c92853dSdrh **
2107c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
2108c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
2109c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
2110c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
2111c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
2112c2eef3b3Sdrh ** foreign key.
2113c2eef3b3Sdrh **
2114968af52aSdrh ** The following symbolic values are used to record which type
21151c92853dSdrh ** of action to take.
21169cfcf5d4Sdrh */
21179cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
21181c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
21191c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
21201c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
21211c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
21221c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
2123c8a0c90bSdrh #define OE_Update   6   /* Process as a DO UPDATE in an upsert */
2124c8a0c90bSdrh #define OE_Restrict 7   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
2125c8a0c90bSdrh #define OE_SetNull  8   /* Set the foreign key value to NULL */
2126c8a0c90bSdrh #define OE_SetDflt  9   /* Set the foreign key value to its default */
2127c8a0c90bSdrh #define OE_Cascade  10  /* Cascade the changes */
2128c8a0c90bSdrh #define OE_Default  11  /* Do whatever the default action is */
21299cfcf5d4Sdrh 
2130d3d39e93Sdrh 
2131d3d39e93Sdrh /*
2132d3d39e93Sdrh ** An instance of the following structure is passed as the first
2133d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
2134d3d39e93Sdrh ** comparison of the two index keys.
2135323df790Sdrh **
2136323df790Sdrh ** Note that aSortOrder[] and aColl[] have nField+1 slots.  There
2137323df790Sdrh ** are nField slots for the columns of an index then one extra slot
2138323df790Sdrh ** for the rowid at the end.
2139d3d39e93Sdrh */
2140d3d39e93Sdrh struct KeyInfo {
21412ec2fb22Sdrh   u32 nRef;           /* Number of references to this KeyInfo object */
21429b8d0272Sdrh   u8 enc;             /* Text encoding - one of the SQLITE_UTF* values */
2143a485ad19Sdrh   u16 nKeyField;      /* Number of key columns in the index */
2144a485ad19Sdrh   u16 nAllField;      /* Total columns, including key plus others */
21452ec2fb22Sdrh   sqlite3 *db;        /* The database connection */
2146323df790Sdrh   u8 *aSortOrder;     /* Sort order for each column. */
2147d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
2148d3d39e93Sdrh };
2149d3d39e93Sdrh 
21509cfcf5d4Sdrh /*
2151b1d607deSdrh ** This object holds a record which has been parsed out into individual
2152b1d607deSdrh ** fields, for the purposes of doing a comparison.
2153e63d9991Sdrh **
2154e63d9991Sdrh ** A record is an object that contains one or more fields of data.
2155e63d9991Sdrh ** Records are used to store the content of a table row and to store
2156e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
2157467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
2158e63d9991Sdrh ** OP_Column opcode.
2159e63d9991Sdrh **
2160b1d607deSdrh ** An instance of this object serves as a "key" for doing a search on
2161b1d607deSdrh ** an index b+tree. The goal of the search is to find the entry that
2162b1d607deSdrh ** is closed to the key described by this object.  This object might hold
2163b1d607deSdrh ** just a prefix of the key.  The number of fields is given by
2164b1d607deSdrh ** pKeyInfo->nField.
21653833e934Sdan **
2166b1d607deSdrh ** The r1 and r2 fields are the values to return if this key is less than
2167b1d607deSdrh ** or greater than a key in the btree, respectively.  These are normally
2168b1d607deSdrh ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
2169b1d607deSdrh ** is in DESC order.
2170b1d607deSdrh **
2171b1d607deSdrh ** The key comparison functions actually return default_rc when they find
2172b1d607deSdrh ** an equals comparison.  default_rc can be -1, 0, or +1.  If there are
2173b1d607deSdrh ** multiple entries in the b-tree with the same key (when only looking
2174b1d607deSdrh ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
2175b1d607deSdrh ** cause the search to find the last match, or +1 to cause the search to
2176b1d607deSdrh ** find the first match.
2177b1d607deSdrh **
2178b1d607deSdrh ** The key comparison functions will set eqSeen to true if they ever
2179b1d607deSdrh ** get and equal results when comparing this structure to a b-tree record.
2180b1d607deSdrh ** When default_rc!=0, the search might end up on the record immediately
2181b1d607deSdrh ** before the first match or immediately after the last match.  The
2182b1d607deSdrh ** eqSeen field will indicate whether or not an exact match exists in the
2183b1d607deSdrh ** b-tree.
2184e63d9991Sdrh */
2185e63d9991Sdrh struct UnpackedRecord {
2186e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
218770528d78Sdrh   Mem *aMem;          /* Values */
2188e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
2189a9e0aeb5Sdrh   i8 default_rc;      /* Comparison result if keys are equal */
219038fdead8Sdan   u8 errCode;         /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
219161ffb2cdSdrh   i8 r1;              /* Value to return if (lhs < rhs) */
219261ffb2cdSdrh   i8 r2;              /* Value to return if (lhs > rhs) */
219370528d78Sdrh   u8 eqSeen;          /* True if an equality comparison has been seen */
2194e63d9991Sdrh };
2195e63d9991Sdrh 
2196e63d9991Sdrh 
2197e63d9991Sdrh /*
219866b89c8fSdrh ** Each SQL index is represented in memory by an
219975897234Sdrh ** instance of the following structure.
2200967e8b73Sdrh **
2201967e8b73Sdrh ** The columns of the table that are to be indexed are described
2202967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
2203967e8b73Sdrh ** we have the following table and index:
2204967e8b73Sdrh **
2205967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
2206967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
2207967e8b73Sdrh **
2208967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
2209967e8b73Sdrh ** three columns in the table.  In the Index structure describing
2210967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
2211967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
2212967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
2213967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
2214967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
2215ea1ba17cSdrh **
2216ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
2217ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
2218ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
2219ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
2220ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
2221ea1ba17cSdrh ** element.
2222c5b73585Sdan **
2223c5b73585Sdan ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
2224c5b73585Sdan ** generate VDBE code (as opposed to parsing one read from an sqlite_master
2225c5b73585Sdan ** table as part of parsing an existing database schema), transient instances
2226c5b73585Sdan ** of this structure may be created. In this case the Index.tnum variable is
2227c5b73585Sdan ** used to store the address of a VDBE instruction, not a database page
2228c5b73585Sdan ** number (it cannot - the database page is not allocated until the VDBE
2229c5b73585Sdan ** program is executed). See convertToWithoutRowidTable() for details.
223075897234Sdrh */
223175897234Sdrh struct Index {
223275897234Sdrh   char *zName;             /* Name of this index */
2233bbbdc83bSdrh   i16 *aiColumn;           /* Which columns are used by this index.  1st is 0 */
2234cfc9df76Sdan   LogEst *aiRowLogEst;     /* From ANALYZE: Est. rows selected by each column */
2235967e8b73Sdrh   Table *pTable;           /* The SQL table being indexed */
2236a37cdde0Sdanielk1977   char *zColAff;           /* String defining the affinity of each column */
223775897234Sdrh   Index *pNext;            /* The next index associated with the same table */
2238b3bf556eSdanielk1977   Schema *pSchema;         /* Schema containing this index */
2239b376daebSdrh   u8 *aSortOrder;          /* for each column: True==DESC, False==ASC */
2240f19aa5faSdrh   const char **azColl;     /* Array of collation sequence names for index */
22411fe0537eSdrh   Expr *pPartIdxWhere;     /* WHERE clause for partial indices */
22421f9ca2c8Sdrh   ExprList *aColExpr;      /* Column expressions */
2243b376daebSdrh   int tnum;                /* DB Page containing root of this index */
2244bf539c4dSdrh   LogEst szIdxRow;         /* Estimated average row size in bytes */
2245bbbdc83bSdrh   u16 nKeyCol;             /* Number of columns forming the key */
2246bbbdc83bSdrh   u16 nColumn;             /* Number of columns stored in the index */
2247bf539c4dSdrh   u8 onError;              /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
22485f913ecbSdrh   unsigned idxType:2;      /* 0:Normal 1:UNIQUE, 2:PRIMARY KEY, 3:IPK */
2249b376daebSdrh   unsigned bUnordered:1;   /* Use this index for == or IN queries only */
22507699d1c4Sdrh   unsigned uniqNotNull:1;  /* True if UNIQUE and NOT NULL for all columns */
22517f9c5dbfSdrh   unsigned isResized:1;    /* True if resizeIndexObject() has been called */
2252ec95c441Sdrh   unsigned isCovering:1;   /* True if this is a covering index */
2253f9df2fbdSdrh   unsigned noSkipScan:1;   /* Do not try to use skip-scan if true */
2254a3928dd7Sdrh   unsigned hasStat1:1;     /* aiRowLogEst values come from sqlite_stat1 */
22557e8515d8Sdrh   unsigned bNoQuery:1;     /* Do not use this index to optimize queries */
22561435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
22572b9cf669Sdrh   int nSample;             /* Number of elements in aSample[] */
22588ad169abSdan   int nSampleCol;          /* Size of IndexSample.anEq[] and so on */
2259eea568d6Sdan   tRowcnt *aAvgEq;         /* Average nEq values for keys not in aSample */
2260faacf17cSdrh   IndexSample *aSample;    /* Samples of the left-most key */
22619f07cf7bSdrh   tRowcnt *aiRowEst;       /* Non-logarithmic stat1 data for this index */
22629f07cf7bSdrh   tRowcnt nRowEst0;        /* Non-logarithmic number of rows in the index */
2263faacf17cSdrh #endif
22641fe3ac73Sdrh   Bitmask colNotIdxed;     /* 0 for unindexed columns in pTab */
226502fa4696Sdan };
226602fa4696Sdan 
226702fa4696Sdan /*
226848dd1d8eSdrh ** Allowed values for Index.idxType
226948dd1d8eSdrh */
227048dd1d8eSdrh #define SQLITE_IDXTYPE_APPDEF      0   /* Created using CREATE INDEX */
227148dd1d8eSdrh #define SQLITE_IDXTYPE_UNIQUE      1   /* Implements a UNIQUE constraint */
227248dd1d8eSdrh #define SQLITE_IDXTYPE_PRIMARYKEY  2   /* Is the PRIMARY KEY for the table */
22735f913ecbSdrh #define SQLITE_IDXTYPE_IPK         3   /* INTEGER PRIMARY KEY index */
227448dd1d8eSdrh 
227548dd1d8eSdrh /* Return true if index X is a PRIMARY KEY index */
227648dd1d8eSdrh #define IsPrimaryKeyIndex(X)  ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
227748dd1d8eSdrh 
22785f1d1d9cSdrh /* Return true if index X is a UNIQUE index */
22795f1d1d9cSdrh #define IsUniqueIndex(X)      ((X)->onError!=OE_None)
22805f1d1d9cSdrh 
22814b92f98cSdrh /* The Index.aiColumn[] values are normally positive integer.  But
22824b92f98cSdrh ** there are some negative values that have special meaning:
22834b92f98cSdrh */
22844b92f98cSdrh #define XN_ROWID     (-1)     /* Indexed column is the rowid */
22854b92f98cSdrh #define XN_EXPR      (-2)     /* Indexed column is an expression */
22864b92f98cSdrh 
228748dd1d8eSdrh /*
228874e7c8f5Sdrh ** Each sample stored in the sqlite_stat3 table is represented in memory
228974e7c8f5Sdrh ** using a structure of this type.  See documentation at the top of the
229074e7c8f5Sdrh ** analyze.c source file for additional information.
229102fa4696Sdan */
229202fa4696Sdan struct IndexSample {
2293f52bb8d3Sdan   void *p;          /* Pointer to sampled record */
2294f52bb8d3Sdan   int n;            /* Size of record in bytes */
2295f52bb8d3Sdan   tRowcnt *anEq;    /* Est. number of rows where the key equals this sample */
2296f52bb8d3Sdan   tRowcnt *anLt;    /* Est. number of rows where key is less than this sample */
2297f52bb8d3Sdan   tRowcnt *anDLt;   /* Est. number of distinct keys less than this sample */
229875897234Sdrh };
229975897234Sdrh 
230075897234Sdrh /*
23018bee11a4Smistachkin ** Possible values to use within the flags argument to sqlite3GetToken().
23028bee11a4Smistachkin */
23038bee11a4Smistachkin #define SQLITE_TOKEN_QUOTED    0x1 /* Token is a quoted identifier. */
23048bee11a4Smistachkin #define SQLITE_TOKEN_KEYWORD   0x2 /* Token is a keyword. */
23058bee11a4Smistachkin 
23068bee11a4Smistachkin /*
230775897234Sdrh ** Each token coming out of the lexer is an instance of
23084b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
23094efc4754Sdrh **
23104a2c747cSdrh ** The memory that "z" points to is owned by other objects.  Take care
23114a2c747cSdrh ** that the owner of the "z" string does not deallocate the string before
23124a2c747cSdrh ** the Token goes out of scope!  Very often, the "z" points to some place
23134a2c747cSdrh ** in the middle of the Parse.zSql text.  But it might also point to a
23144a2c747cSdrh ** static string.
231575897234Sdrh */
231675897234Sdrh struct Token {
2317b7916a78Sdrh   const char *z;     /* Text of the token.  Not NULL-terminated! */
2318b7916a78Sdrh   unsigned int n;    /* Number of characters in this token */
231975897234Sdrh };
232075897234Sdrh 
232175897234Sdrh /*
232213449892Sdrh ** An instance of this structure contains information needed to generate
232313449892Sdrh ** code for a SELECT that contains aggregate functions.
232413449892Sdrh **
232513449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
232613449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
232713449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
232813449892Sdrh ** code for that node.
232913449892Sdrh **
233013449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
233113449892Sdrh ** original Select structure that describes the SELECT statement.  These
233213449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
233313449892Sdrh */
233413449892Sdrh struct AggInfo {
233513449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
233613449892Sdrh                           ** from source tables rather than from accumulators */
233713449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
233813449892Sdrh                           ** than the source table */
233913449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
23405134d135Sdan   int sortingIdxPTab;     /* Cursor number of pseudo-table */
234113449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
23427e61d18eSdrh   int mnReg, mxReg;       /* Range of registers allocated for aCol and aFunc */
2343a451017dSdrh   ExprList *pGroupBy;     /* The group by clause */
234413449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
23450817d0dfSdanielk1977     Table *pTab;             /* Source table */
234613449892Sdrh     int iTable;              /* Cursor number of the source table */
234713449892Sdrh     int iColumn;             /* Column number within the source table */
234813449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
234913449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
23505774b806Sdrh     Expr *pExpr;             /* The original expression */
235113449892Sdrh   } *aCol;
235213449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
235313449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
235413449892Sdrh                           ** Additional columns are used only as parameters to
235513449892Sdrh                           ** aggregate functions */
235613449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
235713449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
235813449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
235913449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
2360467bcf36Sshane     int iDistinct;           /* Ephemeral table used to enforce DISTINCT */
236113449892Sdrh   } *aFunc;
236213449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
236313449892Sdrh };
236413449892Sdrh 
236513449892Sdrh /*
23668677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
23678677d308Sdrh ** Usually it is 16-bits.  But if SQLITE_MAX_VARIABLE_NUMBER is greater
23688677d308Sdrh ** than 32767 we have to make it 32-bit.  16-bit is preferred because
23698677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user
23708677d308Sdrh ** in systems with lots of prepared statements.  And few applications
23718677d308Sdrh ** need more than about 10 or 20 variables.  But some extreme users want
23728677d308Sdrh ** to have prepared statements with over 32767 variables, and for them
23738677d308Sdrh ** the option is available (at compile-time).
23748677d308Sdrh */
23758677d308Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<=32767
2376481aa74eSdrh typedef i16 ynVar;
23778677d308Sdrh #else
23788677d308Sdrh typedef int ynVar;
23798677d308Sdrh #endif
23808677d308Sdrh 
23818677d308Sdrh /*
238275897234Sdrh ** Each node of an expression in the parse tree is an instance
238322f70c32Sdrh ** of this structure.
238422f70c32Sdrh **
238522f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused
238622f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer
238722f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused
238822f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
238922f70c32Sdrh ** tree.
239022f70c32Sdrh **
23916ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
23926ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
23936ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
23946ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
23956ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function.
239622f70c32Sdrh **
23976ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
23986ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL.
23996ab3a2ecSdanielk1977 **
24006ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
24016ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
24026ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
24036ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
24046ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
24056ab3a2ecSdanielk1977 ** valid.
240622f70c32Sdrh **
240722f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
240822f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
240922f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
241022f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
241122f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
241222f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
241322f70c32Sdrh ** it can be accessed after all aggregates are computed.
241422f70c32Sdrh **
24156ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark
24166ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index
24176ab3a2ecSdanielk1977 ** number for that variable.
241822f70c32Sdrh **
24191398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
24201398ad36Sdrh ** register number containing the result of the subquery.  If the
24211398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
24221398ad36Sdrh ** gives a different answer at different times during statement processing
24231398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
24241398ad36Sdrh **
2425aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
2426aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
2427aee18ef8Sdanielk1977 ** corresponding table definition.
24286ab3a2ecSdanielk1977 **
24296ab3a2ecSdanielk1977 ** ALLOCATION NOTES:
24306ab3a2ecSdanielk1977 **
243112ffee8cSdrh ** Expr objects can use a lot of memory space in database schema.  To
243212ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be
243312ffee8cSdrh ** truncated.  And to reduce the number of memory allocations, sometimes
243412ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation,
243533e619fcSdrh ** together with Expr.zToken strings.
24366ab3a2ecSdanielk1977 **
2437b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when
243812ffee8cSdrh ** an Expr object is truncated.  When EP_Reduced is set, then all
243912ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
244012ffee8cSdrh ** are contained within the same memory allocation.  Note, however, that
244112ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
244212ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set.
244375897234Sdrh */
244475897234Sdrh struct Expr {
24451cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
2446a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
2447c5cd1249Sdrh   u32 flags;             /* Various flags.  EP_* See below */
244833e619fcSdrh   union {
2449b7916a78Sdrh     char *zToken;          /* Token value. Zero terminated and dequoted */
2450d50ffc41Sdrh     int iValue;            /* Non-negative integer value if EP_IntValue */
245133e619fcSdrh   } u;
24526ab3a2ecSdanielk1977 
24536ab3a2ecSdanielk1977   /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
24546ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
24556ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
24566ab3a2ecSdanielk1977   *********************************************************************/
24576ab3a2ecSdanielk1977 
24586ab3a2ecSdanielk1977   Expr *pLeft;           /* Left subnode */
24596ab3a2ecSdanielk1977   Expr *pRight;          /* Right subnode */
24606ab3a2ecSdanielk1977   union {
2461c5cd1249Sdrh     ExprList *pList;     /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
2462c5cd1249Sdrh     Select *pSelect;     /* EP_xIsSelect and op = IN, EXISTS, SELECT */
24636ab3a2ecSdanielk1977   } x;
24646ab3a2ecSdanielk1977 
24656ab3a2ecSdanielk1977   /* If the EP_Reduced flag is set in the Expr.flags mask, then no
24666ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
24676ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
24686ab3a2ecSdanielk1977   *********************************************************************/
24696ab3a2ecSdanielk1977 
24706ec65491Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
24716ec65491Sdrh   int nHeight;           /* Height of the tree headed by this node */
24726ec65491Sdrh #endif
2473b7916a78Sdrh   int iTable;            /* TK_COLUMN: cursor number of table holding column
24742832ad42Sdan                          ** TK_REGISTER: register number
2475cca9f3d2Sdrh                          ** TK_TRIGGER: 1 -> new, 0 -> old
2476fc7f27b9Sdrh                          ** EP_Unlikely:  134217728 times likelihood
2477fc7f27b9Sdrh                          ** TK_SELECT: 1st register of result vector */
24788677d308Sdrh   ynVar iColumn;         /* TK_COLUMN: column index.  -1 for rowid.
2479fc7f27b9Sdrh                          ** TK_VARIABLE: variable number (always >= 1).
2480fc7f27b9Sdrh                          ** TK_SELECT_COLUMN: column of the result vector */
2481b7916a78Sdrh   i16 iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
2482b7916a78Sdrh   i16 iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
2483030796dfSdrh   u8 op2;                /* TK_REGISTER: original value of Expr.op
2484030796dfSdrh                          ** TK_COLUMN: the value of p5 for OP_Column
2485030796dfSdrh                          ** TK_AGG_FUNCTION: nesting depth */
248613449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
2487eda079cdSdrh   union {
2488eda079cdSdrh     Table *pTab;           /* TK_COLUMN: Table containing column. Can be NULL
24894dd89d5aSdrh                            ** for a column of an index on an expression */
2490eda079cdSdrh     Window *pWin;          /* TK_FUNCTION: Window definition for the func */
24912c04131cSdrh     struct {               /* TK_IN, TK_SELECT, and TK_EXISTS */
24922c04131cSdrh       int iAddr;             /* Subroutine entry address */
24932c04131cSdrh       int regReturn;         /* Register used to hold return address */
24942c04131cSdrh     } sub;
2495eda079cdSdrh   } y;
249675897234Sdrh };
249775897234Sdrh 
249875897234Sdrh /*
24991f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
2500d137f4e6Sdrh ** Value restrictions:
2501d137f4e6Sdrh **
2502d137f4e6Sdrh **          EP_Agg == NC_HasAgg == SF_HasAgg
2503d137f4e6Sdrh **          EP_Win == NC_HasWin
25041f16230bSdrh */
250572673a24Sdrh #define EP_FromJoin  0x000001 /* Originates in ON/USING clause of outer join */
2506d137f4e6Sdrh #define EP_Distinct  0x000002 /* Aggregate function with DISTINCT keyword */
2507fca23557Sdrh #define EP_HasFunc   0x000004 /* Contains one or more functions of any kind */
2508efad2e23Sdrh #define EP_FixedCol  0x000008 /* TK_Column with a known fixed value */
2509d137f4e6Sdrh #define EP_Agg       0x000010 /* Contains one or more aggregate functions */
2510c5cd1249Sdrh #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
2511c5cd1249Sdrh #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
2512c5cd1249Sdrh #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
2513fbb24d10Sdrh #define EP_Collate   0x000100 /* Tree contains a TK_COLLATE operator */
2514fbb24d10Sdrh #define EP_Generic   0x000200 /* Ignore COLLATE or affinity on this tree */
2515c5cd1249Sdrh #define EP_IntValue  0x000400 /* Integer value contained in u.iValue */
2516c5cd1249Sdrh #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
2517a4c3c87eSdrh #define EP_Skip      0x001000 /* COLLATE, AS, or UNLIKELY */
2518c5cd1249Sdrh #define EP_Reduced   0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
2519c5cd1249Sdrh #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
2520d137f4e6Sdrh #define EP_Win       0x008000 /* Contains window functions */
2521c5cd1249Sdrh #define EP_MemToken  0x010000 /* Need to sqlite3DbFree() Expr.zToken */
2522ebb6a65dSdrh #define EP_NoReduce  0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
2523a4c3c87eSdrh #define EP_Unlikely  0x040000 /* unlikely() or likelihood() function */
2524a7f910b5Sdrh #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
252572673a24Sdrh #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
2526885a5b03Sdrh #define EP_Subquery  0x200000 /* Tree contains a TK_SELECT operator */
25270b8d255cSdrh #define EP_Alias     0x400000 /* Is an alias for a result set column */
2528209bc522Sdrh #define EP_Leaf      0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */
2529eda079cdSdrh #define EP_WinFunc  0x1000000 /* TK_FUNCTION with Expr.y.pWin set */
25302c04131cSdrh #define EP_Subrtn   0x2000000 /* Uses Expr.y.sub. TK_IN, _SELECT, or _EXISTS */
253151d35b0fSdrh #define EP_Quoted   0x4000000 /* TK_ID was originally quoted */
2532d137f4e6Sdrh #define EP_Static   0x8000000 /* Held in memory not obtained from malloc() */
2533885a5b03Sdrh 
2534885a5b03Sdrh /*
2535fca23557Sdrh ** The EP_Propagate mask is a set of properties that automatically propagate
2536fca23557Sdrh ** upwards into parent nodes.
2537885a5b03Sdrh */
2538fca23557Sdrh #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc)
253933e619fcSdrh 
254033e619fcSdrh /*
25411f16230bSdrh ** These macros can be used to test, set, or clear bits in the
25421f16230bSdrh ** Expr.flags field.
25431f16230bSdrh */
2544c5cd1249Sdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))!=0)
2545c5cd1249Sdrh #define ExprHasAllProperty(E,P)  (((E)->flags&(P))==(P))
25461f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
25471f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
25481f16230bSdrh 
2549ebb6a65dSdrh /* The ExprSetVVAProperty() macro is used for Verification, Validation,
2550ebb6a65dSdrh ** and Accreditation only.  It works like ExprSetProperty() during VVA
2551ebb6a65dSdrh ** processes but is a no-op for delivery.
2552ebb6a65dSdrh */
2553ebb6a65dSdrh #ifdef SQLITE_DEBUG
2554ebb6a65dSdrh # define ExprSetVVAProperty(E,P)  (E)->flags|=(P)
2555ebb6a65dSdrh #else
2556ebb6a65dSdrh # define ExprSetVVAProperty(E,P)
2557ebb6a65dSdrh #endif
2558ebb6a65dSdrh 
25591f16230bSdrh /*
25606ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr
25616ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
25626ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set.
25636ab3a2ecSdanielk1977 */
256412ffee8cSdrh #define EXPR_FULLSIZE           sizeof(Expr)           /* Full size */
256512ffee8cSdrh #define EXPR_REDUCEDSIZE        offsetof(Expr,iTable)  /* Common features */
2566b7916a78Sdrh #define EXPR_TOKENONLYSIZE      offsetof(Expr,pLeft)   /* Fewer features */
25676ab3a2ecSdanielk1977 
25686ab3a2ecSdanielk1977 /*
25696ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment
25706ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details.
25716ab3a2ecSdanielk1977 */
257212ffee8cSdrh #define EXPRDUP_REDUCE         0x0001  /* Used reduced-size Expr nodes */
25736ab3a2ecSdanielk1977 
25746ab3a2ecSdanielk1977 /*
257575897234Sdrh ** A list of expressions.  Each expression may optionally have a
257675897234Sdrh ** name.  An expr/name combination can be used in several ways, such
257775897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
257875897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
2579ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
258075897234Sdrh ** field is not used.
25810dde4739Sdrh **
25820dde4739Sdrh ** By default the Expr.zSpan field holds a human-readable description of
25830dde4739Sdrh ** the expression that is used in the generation of error messages and
25840dde4739Sdrh ** column labels.  In this case, Expr.zSpan is typically the text of a
25850dde4739Sdrh ** column expression as it exists in a SELECT statement.  However, if
25860dde4739Sdrh ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
25873e3f1a5bSdrh ** of the result column in the form: DATABASE.TABLE.COLUMN.  This later
25883e3f1a5bSdrh ** form is used for name resolution with nested FROM clauses.
258975897234Sdrh */
259075897234Sdrh struct ExprList {
259175897234Sdrh   int nExpr;             /* Number of expressions on the list */
2592d872bb18Sdrh   struct ExprList_item { /* For each expression in the list */
2593c5f4816fSdrh     Expr *pExpr;            /* The parse tree for this expression */
259475897234Sdrh     char *zName;            /* Token associated with this expression */
2595b7916a78Sdrh     char *zSpan;            /* Original text of the expression */
25968e2ca029Sdrh     u8 sortOrder;           /* 1 for DESC or 0 for ASC */
25970dde4739Sdrh     unsigned done :1;       /* A flag to indicate when processing is finished */
25983e3f1a5bSdrh     unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
2599d673cddaSdrh     unsigned reusable :1;   /* Constant expression is reusable */
260024e25d32Sdan     unsigned bSorterRef :1; /* Defer evaluation until after sorting */
2601c2acc4e4Sdrh     union {
2602c2acc4e4Sdrh       struct {
26034b3ac73cSdrh         u16 iOrderByCol;      /* For ORDER BY, column number in result set */
26048b213899Sdrh         u16 iAlias;           /* Index into Parse.aAlias[] for zName */
2605c2acc4e4Sdrh       } x;
2606c2acc4e4Sdrh       int iConstExprReg;      /* Register in which Expr value is cached */
2607c2acc4e4Sdrh     } u;
260843606175Sdrh   } a[1];                  /* One slot for each expression in the list */
260975897234Sdrh };
261075897234Sdrh 
261175897234Sdrh /*
2612ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
2613ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
2614ad3cab52Sdrh **
2615ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
2616ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
2617ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
2618ad3cab52Sdrh **
2619ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
2620ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
2621ad3cab52Sdrh **
2622ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
2623ad3cab52Sdrh **
2624ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
262575897234Sdrh */
262675897234Sdrh struct IdList {
26276d4abfbeSdrh   struct IdList_item {
2628ad3cab52Sdrh     char *zName;      /* Name of the identifier */
2629967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
2630ad3cab52Sdrh   } *a;
263113449892Sdrh   int nId;         /* Number of identifiers on the list */
2632ad3cab52Sdrh };
2633ad3cab52Sdrh 
2634ad3cab52Sdrh /*
2635ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
2636ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
2637ad3cab52Sdrh ** the SrcList.a[] array.
2638d24cc427Sdrh **
2639d24cc427Sdrh ** With the addition of multiple database support, the following structure
2640d24cc427Sdrh ** can also be used to describe a particular table such as the table that
2641d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
2642d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
2643d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
2644c49de5d9Sdrh **
2645c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
2646c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
2647c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
2648c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
26492a6a7eebSdrh **
26502a6a7eebSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table
26512a6a7eebSdrh ** contains more than 63 columns and the 64-th or later column is used.
2652ad3cab52Sdrh */
2653ad3cab52Sdrh struct SrcList {
26546d1626ebSdrh   int nSrc;        /* Number of tables or subqueries in the FROM clause */
26556d1626ebSdrh   u32 nAlloc;      /* Number of entries allocated in a[] below */
2656ad3cab52Sdrh   struct SrcList_item {
265741fb5cd1Sdan     Schema *pSchema;  /* Schema to which this item is fixed */
2658113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
2659ad3cab52Sdrh     char *zName;      /* Name of the table */
2660ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
2661daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
2662daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
26635b6a9ed4Sdrh     int addrFillSub;  /* Address of subroutine to manifest a subquery */
26645b6a9ed4Sdrh     int regReturn;    /* Register holding return address of addrFillSub */
26655f612295Sdrh     int regResult;    /* Registers holding results of a co-routine */
26668a48b9c0Sdrh     struct {
26676b922881Sdrh       u8 jointype;      /* Type of join between this table and the previous */
266821172c4cSdrh       unsigned notIndexed :1;    /* True if there is a NOT INDEXED clause */
26698a48b9c0Sdrh       unsigned isIndexedBy :1;   /* True if there is an INDEXED BY clause */
26708a48b9c0Sdrh       unsigned isTabFunc :1;     /* True if table-valued-function syntax */
267121172c4cSdrh       unsigned isCorrelated :1;  /* True if sub-query is correlated */
267221172c4cSdrh       unsigned viaCoroutine :1;  /* Implemented as a co-routine */
2673f43fe6e9Sdan       unsigned isRecursive :1;   /* True for recursive reference in WITH */
26748a48b9c0Sdrh     } fg;
2675e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
2676ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
2677ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
2678cd38d520Sdanielk1977     Bitmask colUsed;  /* Bit N (1<<N) set if column N of pTab is used */
26798a48b9c0Sdrh     union {
2680d62fbb50Sdrh       char *zIndexedBy;    /* Identifier from "INDEXED BY <zIndex>" clause */
26818a48b9c0Sdrh       ExprList *pFuncArg;  /* Arguments to table-valued-function */
26828a48b9c0Sdrh     } u1;
26838a48b9c0Sdrh     Index *pIBIndex;  /* Index structure corresponding to u1.zIndexedBy */
2684113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
268575897234Sdrh };
268675897234Sdrh 
268775897234Sdrh /*
268801f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
268901f3f253Sdrh */
269001f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
26913dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
26923dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
26933dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
26943dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
26953dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
26963dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
269701f3f253Sdrh 
2698111a6a7dSdrh 
2699111a6a7dSdrh /*
2700336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
2701336a5300Sdrh ** and the WhereInfo.wctrlFlags member.
270249711600Sdrh **
270349711600Sdrh ** Value constraints (enforced via assert()):
270449711600Sdrh **     WHERE_USE_LIMIT  == SF_FixedLimit
270508c88eb0Sdrh */
27066df2acd2Sdrh #define WHERE_ORDERBY_NORMAL   0x0000 /* No-op */
27076df2acd2Sdrh #define WHERE_ORDERBY_MIN      0x0001 /* ORDER BY processing for min() func */
27086df2acd2Sdrh #define WHERE_ORDERBY_MAX      0x0002 /* ORDER BY processing for max() func */
27096df2acd2Sdrh #define WHERE_ONEPASS_DESIRED  0x0004 /* Want to do one-pass UPDATE/DELETE */
2710ce943bc8Sdrh #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */
2711ce943bc8Sdrh #define WHERE_DUPLICATES_OK    0x0010 /* Ok to return a row more than once */
2712bc5eac00Sdrh #define WHERE_OR_SUBCLAUSE     0x0020 /* Processing a sub-WHERE as part of
2713bc5eac00Sdrh                                       ** the OR optimization  */
2714ce943bc8Sdrh #define WHERE_GROUPBY          0x0040 /* pOrderBy is really a GROUP BY */
2715ce943bc8Sdrh #define WHERE_DISTINCTBY       0x0080 /* pOrderby is really a DISTINCT clause */
2716ce943bc8Sdrh #define WHERE_WANT_DISTINCT    0x0100 /* All output needs to be distinct */
2717ce943bc8Sdrh #define WHERE_SORTBYGROUP      0x0200 /* Support sqlite3WhereIsSorted() */
2718ce943bc8Sdrh #define WHERE_SEEK_TABLE       0x0400 /* Do not defer seeks on main table */
2719d711e522Sdrh #define WHERE_ORDERBY_LIMIT    0x0800 /* ORDERBY+LIMIT on the inner loop */
2720f64ece14Sdan #define WHERE_SEEK_UNIQ_TABLE  0x1000 /* Do not defer seeks if unique */
2721ce943bc8Sdrh                         /*     0x2000    not currently used */
2722bc5eac00Sdrh #define WHERE_USE_LIMIT        0x4000 /* Use the LIMIT in cost estimates */
2723ce943bc8Sdrh                         /*     0x8000    not currently used */
2724a9d1ccb9Sdanielk1977 
27254f402f26Sdrh /* Allowed return values from sqlite3WhereIsDistinct()
27264f402f26Sdrh */
2727e8e4af76Sdrh #define WHERE_DISTINCT_NOOP      0  /* DISTINCT keyword not used */
2728ae651d61Sdrh #define WHERE_DISTINCT_UNIQUE    1  /* No duplicates */
2729ae651d61Sdrh #define WHERE_DISTINCT_ORDERED   2  /* All duplicates are adjacent */
2730e8e4af76Sdrh #define WHERE_DISTINCT_UNORDERED 3  /* Duplicates are scattered */
273138cc40c2Sdan 
273275897234Sdrh /*
2733b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
2734b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
2735b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
2736b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
2737b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
2738b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
2739b3bce662Sdanielk1977 ** other statements.
2740b3bce662Sdanielk1977 **
2741b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
2742b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
2743b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
2744b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
2745b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
2746b3bce662Sdanielk1977 ** the context containing the match is incremented.
2747b3bce662Sdanielk1977 **
2748b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
2749b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
2750b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
2751b3bce662Sdanielk1977 ** subqueries looking for a match.
2752b3bce662Sdanielk1977 */
2753b3bce662Sdanielk1977 struct NameContext {
2754b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
2755b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
275625c3b8caSdrh   union {
275726080d92Sdrh     ExprList *pEList;    /* Optional list of result-set columns */
275813449892Sdrh     AggInfo *pAggInfo;   /* Information about aggregates at this level */
2759eac9fabbSdrh     Upsert *pUpsert;     /* ON CONFLICT clause information from an upsert */
276025c3b8caSdrh   } uNC;
2761b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
2762a51009b2Sdrh   int nRef;            /* Number of names resolved by this context */
2763a51009b2Sdrh   int nErr;            /* Number of errors encountered while resolving names */
27649588ad95Sdrh   u16 ncFlags;         /* Zero or more NC_* flags defined below */
2765e3bf632cSdan   Select *pWinSelect;  /* SELECT statement for any window functions */
2766b3bce662Sdanielk1977 };
2767b3bce662Sdanielk1977 
2768b3bce662Sdanielk1977 /*
2769a51009b2Sdrh ** Allowed values for the NameContext, ncFlags field.
27709588ad95Sdrh **
277149711600Sdrh ** Value constraints (all checked via assert()):
2772d137f4e6Sdrh **    NC_HasAgg    == SF_HasAgg    == EP_Agg
277349711600Sdrh **    NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
2774d137f4e6Sdrh **    NC_HasWin    == EP_Win
27759588ad95Sdrh **
2776a51009b2Sdrh */
27779588ad95Sdrh #define NC_AllowAgg  0x0001  /* Aggregate functions are allowed here */
277849711600Sdrh #define NC_PartIdx   0x0002  /* True if resolving a partial index WHERE */
27799588ad95Sdrh #define NC_IsCheck   0x0004  /* True if resolving names in a CHECK constraint */
27809588ad95Sdrh #define NC_InAggFunc 0x0008  /* True if analyzing arguments to an agg func */
278149711600Sdrh #define NC_HasAgg    0x0010  /* One or more aggregate functions seen */
2782a514b8ebSdrh #define NC_IdxExpr   0x0020  /* True if resolving columns of CREATE INDEX */
278391da7072Sdrh #define NC_VarSelect 0x0040  /* A correlated subquery has been seen */
278425c3b8caSdrh #define NC_UEList    0x0080  /* True if uNC.pEList is used */
278525c3b8caSdrh #define NC_UAggInfo  0x0100  /* True if uNC.pAggInfo is used */
2786eac9fabbSdrh #define NC_UUpsert   0x0200  /* True if uNC.pUpsert is used */
27879588ad95Sdrh #define NC_MinMaxAgg 0x1000  /* min/max aggregates seen.  See note above */
2788fca23557Sdrh #define NC_Complex   0x2000  /* True if a function or subquery seen */
278986fb6e17Sdan #define NC_AllowWin  0x4000  /* Window functions are allowed here */
27904ded26a5Sdan #define NC_HasWin    0x8000  /* One or more window functions seen */
2791a51009b2Sdrh 
2792a51009b2Sdrh /*
279346d2e5c3Sdrh ** An instance of the following object describes a single ON CONFLICT
2794e9c2e772Sdrh ** clause in an upsert.
2795788d55aaSdrh **
2796788d55aaSdrh ** The pUpsertTarget field is only set if the ON CONFLICT clause includes
2797788d55aaSdrh ** conflict-target clause.  (In "ON CONFLICT(a,b)" the "(a,b)" is the
2798e9c2e772Sdrh ** conflict-target clause.)  The pUpsertTargetWhere is the optional
2799e9c2e772Sdrh ** WHERE clause used to identify partial unique indexes.
2800788d55aaSdrh **
2801788d55aaSdrh ** pUpsertSet is the list of column=expr terms of the UPDATE statement.
2802788d55aaSdrh ** The pUpsertSet field is NULL for a ON CONFLICT DO NOTHING.  The
2803788d55aaSdrh ** pUpsertWhere is the WHERE clause for the UPDATE and is NULL if the
2804788d55aaSdrh ** WHERE clause is omitted.
280546d2e5c3Sdrh */
280646d2e5c3Sdrh struct Upsert {
280746d2e5c3Sdrh   ExprList *pUpsertTarget;  /* Optional description of conflicting index */
2808e9c2e772Sdrh   Expr *pUpsertTargetWhere; /* WHERE clause for partial index targets */
280946d2e5c3Sdrh   ExprList *pUpsertSet;     /* The SET clause from an ON CONFLICT UPDATE */
2810dab0eb58Sdrh   Expr *pUpsertWhere;       /* WHERE clause for the ON CONFLICT UPDATE */
28117fc3aba8Sdrh   /* The fields above comprise the parse tree for the upsert clause.
28127fc3aba8Sdrh   ** The fields below are used to transfer information from the INSERT
28137fc3aba8Sdrh   ** processing down into the UPDATE processing while generating code.
28147fc3aba8Sdrh   ** Upsert owns the memory allocated above, but not the memory below. */
28154751b87fSdrh   Index *pUpsertIdx;        /* Constraint that pUpsertTarget identifies */
28160b30a116Sdrh   SrcList *pUpsertSrc;      /* Table to be updated */
2817eac9fabbSdrh   int regData;              /* First register holding array of VALUES */
28187fc3aba8Sdrh   int iDataCur;             /* Index of the data cursor */
28197fc3aba8Sdrh   int iIdxCur;              /* Index of the first index cursor */
282046d2e5c3Sdrh };
282146d2e5c3Sdrh 
282246d2e5c3Sdrh /*
28239bb61fe7Sdrh ** An instance of the following structure contains all information
28249bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
2825a76b5dfcSdrh **
2826bbd4ae5aSdrh ** See the header comment on the computeLimitRegisters() routine for a
2827bbd4ae5aSdrh ** detailed description of the meaning of the iLimit and iOffset fields.
28280342b1f5Sdrh **
2829b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
28300342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
283166a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
28320342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
2833b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
28340342b1f5Sdrh ** enough information about the compound query is known at that point.
2835b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
28362c79733fSdrh ** for the result set.  The KeyInfo for addrOpenEphm[2] contains collating
28370342b1f5Sdrh ** sequences for the ORDER BY clause.
28389bb61fe7Sdrh */
28399bb61fe7Sdrh struct Select {
28409bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
28417b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
2842c3489bbfSdrh   LogEst nSelectRow;     /* Estimated number of result rows */
2843c3489bbfSdrh   u32 selFlags;          /* Various SF_* values */
2844a451017dSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
2845fef37760Sdrh   u32 selId;             /* Unique identifier number for this SELECT */
2846079a3072Sdrh   int addrOpenEphm[2];   /* OP_OpenEphem opcodes related to this select */
2847ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
28489bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
28499bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
28509bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
28519bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
2852967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
28531e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
2854a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
28554e9119d9Sdan   With *pWith;           /* WITH clause attached to this select. Or NULL. */
285667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
285786fb6e17Sdan   Window *pWin;          /* List of window functions */
2858e3bf632cSdan   Window *pWinDefn;      /* List of named window definitions */
285967a9b8edSdan #endif
28609bb61fe7Sdrh };
28619bb61fe7Sdrh 
28629bb61fe7Sdrh /*
28637d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
28647d10d5a6Sdrh ** "Select Flag".
286549711600Sdrh **
286649711600Sdrh ** Value constraints (all checked via assert())
286749711600Sdrh **     SF_HasAgg     == NC_HasAgg
286849711600Sdrh **     SF_MinMaxAgg  == NC_MinMaxAgg     == SQLITE_FUNC_MINMAX
286949711600Sdrh **     SF_FixedLimit == WHERE_USE_LIMIT
28707d10d5a6Sdrh */
2871c3489bbfSdrh #define SF_Distinct       0x00001  /* Output should be DISTINCT */
2872c3489bbfSdrh #define SF_All            0x00002  /* Includes the ALL keyword */
2873c3489bbfSdrh #define SF_Resolved       0x00004  /* Identifiers have been resolved */
287449711600Sdrh #define SF_Aggregate      0x00008  /* Contains agg functions or a GROUP BY */
287549711600Sdrh #define SF_HasAgg         0x00010  /* Contains aggregate functions */
287649711600Sdrh #define SF_UsesEphemeral  0x00020  /* Uses the OpenEphemeral opcode */
287749711600Sdrh #define SF_Expanded       0x00040  /* sqlite3SelectExpand() called on this */
287849711600Sdrh #define SF_HasTypeInfo    0x00080  /* FROM subqueries have Table metadata */
287949711600Sdrh #define SF_Compound       0x00100  /* Part of a compound query */
288049711600Sdrh #define SF_Values         0x00200  /* Synthesized from VALUES clause */
288149711600Sdrh #define SF_MultiValue     0x00400  /* Single VALUES term with multiple rows */
288249711600Sdrh #define SF_NestedFrom     0x00800  /* Part of a parenthesized FROM clause */
2883c3489bbfSdrh #define SF_MinMaxAgg      0x01000  /* Aggregate containing min() or max() */
2884c3489bbfSdrh #define SF_Recursive      0x02000  /* The recursive part of a recursive CTE */
2885c3489bbfSdrh #define SF_FixedLimit     0x04000  /* nSelectRow set by a constant LIMIT */
288649711600Sdrh #define SF_MaybeConvert   0x08000  /* Need convertCompoundSelectToSubquery() */
288749711600Sdrh #define SF_Converted      0x10000  /* By convertCompoundSelectToSubquery() */
288849711600Sdrh #define SF_IncludeHidden  0x20000  /* Include hidden columns in output */
288903c3905fSdrh #define SF_ComplexResult  0x40000  /* Result contains subquery or function */
28907d10d5a6Sdrh 
28917d10d5a6Sdrh /*
2892340309fdSdrh ** The results of a SELECT can be distributed in several ways, as defined
2893340309fdSdrh ** by one of the following macros.  The "SRT" prefix means "SELECT Result
2894340309fdSdrh ** Type".
2895340309fdSdrh **
2896340309fdSdrh **     SRT_Union       Store results as a key in a temporary index
2897340309fdSdrh **                     identified by pDest->iSDParm.
2898340309fdSdrh **
2899340309fdSdrh **     SRT_Except      Remove results from the temporary index pDest->iSDParm.
2900340309fdSdrh **
2901340309fdSdrh **     SRT_Exists      Store a 1 in memory cell pDest->iSDParm if the result
2902340309fdSdrh **                     set is not empty.
2903340309fdSdrh **
2904340309fdSdrh **     SRT_Discard     Throw the results away.  This is used by SELECT
2905340309fdSdrh **                     statements within triggers whose only purpose is
2906340309fdSdrh **                     the side-effects of functions.
2907340309fdSdrh **
2908340309fdSdrh ** All of the above are free to ignore their ORDER BY clause. Those that
2909340309fdSdrh ** follow must honor the ORDER BY clause.
2910340309fdSdrh **
2911340309fdSdrh **     SRT_Output      Generate a row of output (using the OP_ResultRow
2912340309fdSdrh **                     opcode) for each row in the result set.
2913340309fdSdrh **
2914340309fdSdrh **     SRT_Mem         Only valid if the result is a single column.
2915340309fdSdrh **                     Store the first column of the first result row
2916340309fdSdrh **                     in register pDest->iSDParm then abandon the rest
2917340309fdSdrh **                     of the query.  This destination implies "LIMIT 1".
2918340309fdSdrh **
2919340309fdSdrh **     SRT_Set         The result must be a single column.  Store each
2920340309fdSdrh **                     row of result as the key in table pDest->iSDParm.
2921340309fdSdrh **                     Apply the affinity pDest->affSdst before storing
2922340309fdSdrh **                     results.  Used to implement "IN (SELECT ...)".
2923340309fdSdrh **
2924340309fdSdrh **     SRT_EphemTab    Create an temporary table pDest->iSDParm and store
2925340309fdSdrh **                     the result there. The cursor is left open after
2926340309fdSdrh **                     returning.  This is like SRT_Table except that
2927340309fdSdrh **                     this destination uses OP_OpenEphemeral to create
2928340309fdSdrh **                     the table first.
2929340309fdSdrh **
2930340309fdSdrh **     SRT_Coroutine   Generate a co-routine that returns a new row of
2931340309fdSdrh **                     results each time it is invoked.  The entry point
2932340309fdSdrh **                     of the co-routine is stored in register pDest->iSDParm
2933340309fdSdrh **                     and the result row is stored in pDest->nDest registers
2934340309fdSdrh **                     starting with pDest->iSdst.
2935340309fdSdrh **
2936781def29Sdrh **     SRT_Table       Store results in temporary table pDest->iSDParm.
29378e1ee88cSdrh **     SRT_Fifo        This is like SRT_EphemTab except that the table
29388e1ee88cSdrh **                     is assumed to already be open.  SRT_Fifo has
29398e1ee88cSdrh **                     the additional property of being able to ignore
29408e1ee88cSdrh **                     the ORDER BY clause.
2941781def29Sdrh **
29428e1ee88cSdrh **     SRT_DistFifo    Store results in a temporary table pDest->iSDParm.
2943340309fdSdrh **                     But also use temporary table pDest->iSDParm+1 as
2944340309fdSdrh **                     a record of all prior results and ignore any duplicate
29458e1ee88cSdrh **                     rows.  Name means:  "Distinct Fifo".
2946781def29Sdrh **
2947781def29Sdrh **     SRT_Queue       Store results in priority queue pDest->iSDParm (really
2948781def29Sdrh **                     an index).  Append a sequence number so that all entries
2949781def29Sdrh **                     are distinct.
2950781def29Sdrh **
2951781def29Sdrh **     SRT_DistQueue   Store results in priority queue pDest->iSDParm only if
2952781def29Sdrh **                     the same record has never been stored before.  The
2953781def29Sdrh **                     index at pDest->iSDParm+1 hold all prior stores.
2954fef5208cSdrh */
295513449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
295613449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
29579ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
29589ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
29598e1ee88cSdrh #define SRT_Fifo         5  /* Store result as data with an automatic rowid */
29608e1ee88cSdrh #define SRT_DistFifo     6  /* Like SRT_Fifo, but unique results only */
29618e1ee88cSdrh #define SRT_Queue        7  /* Store result in an queue */
29628e1ee88cSdrh #define SRT_DistQueue    8  /* Like SRT_Queue, but unique results only */
2963fef5208cSdrh 
296413449892Sdrh /* The ORDER BY clause is ignored for all of the above */
29658e1ee88cSdrh #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
296613449892Sdrh 
29678e1ee88cSdrh #define SRT_Output       9  /* Output each row of result */
29688e1ee88cSdrh #define SRT_Mem         10  /* Store result in a memory cell */
29698e1ee88cSdrh #define SRT_Set         11  /* Store results as keys in an index */
29708e1ee88cSdrh #define SRT_EphemTab    12  /* Create transient tab and store like SRT_Table */
29718e1ee88cSdrh #define SRT_Coroutine   13  /* Generate a single row of result */
29728e1ee88cSdrh #define SRT_Table       14  /* Store result as data with an automatic rowid */
29732282792aSdrh 
29742282792aSdrh /*
2975634d81deSdrh ** An instance of this object describes where to put of the results of
2976634d81deSdrh ** a SELECT statement.
29776c8c8ce0Sdanielk1977 */
29786c8c8ce0Sdanielk1977 struct SelectDest {
2979634d81deSdrh   u8 eDest;            /* How to dispose of the results.  On of SRT_* above. */
29802b596da8Sdrh   int iSDParm;         /* A parameter used by the eDest disposal method */
29812b596da8Sdrh   int iSdst;           /* Base register where results are written */
29822b596da8Sdrh   int nSdst;           /* Number of registers allocated */
2983a8b9793cSdrh   char *zAffSdst;      /* Affinity used when eDest==SRT_Set */
2984fe1c6bb9Sdrh   ExprList *pOrderBy;  /* Key columns for SRT_Queue and SRT_DistQueue */
29856c8c8ce0Sdanielk1977 };
29866c8c8ce0Sdanielk1977 
29876c8c8ce0Sdanielk1977 /*
29880b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT
29890b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p
29900b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that
29910b9f50d8Sdrh ** the code generator needs.  We have to keep per-table autoincrement
29921b32554bSdrh ** information in case inserts are done within triggers.  Triggers do not
29930b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the
29940b9f50d8Sdrh ** loading and saving of autoincrement information.
29950b9f50d8Sdrh */
29960b9f50d8Sdrh struct AutoincInfo {
29970b9f50d8Sdrh   AutoincInfo *pNext;   /* Next info block in a list of them all */
29980b9f50d8Sdrh   Table *pTab;          /* Table this info block refers to */
29990b9f50d8Sdrh   int iDb;              /* Index in sqlite3.aDb[] of database holding pTab */
30000b9f50d8Sdrh   int regCtr;           /* Memory register holding the rowid counter */
30010b9f50d8Sdrh };
30020b9f50d8Sdrh 
30030b9f50d8Sdrh /*
30042832ad42Sdan ** At least one instance of the following structure is created for each
30052832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
30062832ad42Sdan ** statement. All such objects are stored in the linked list headed at
30072832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been
30082832ad42Sdan ** completed.
30092832ad42Sdan **
30102832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger
30112832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
30122832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
30132832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same
30142832ad42Sdan ** values for both pTrigger and orconf.
301565a7cd16Sdan **
3016bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
301765a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT
3018bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
3019bb5f168fSdan ** a mask of new.* columns used by the program.
30202832ad42Sdan */
30212832ad42Sdan struct TriggerPrg {
30222832ad42Sdan   Trigger *pTrigger;      /* Trigger this program was coded from */
30232832ad42Sdan   TriggerPrg *pNext;      /* Next entry in Parse.pTriggerPrg list */
3024a451017dSdrh   SubProgram *pProgram;   /* Program implementing pTrigger/orconf */
3025a451017dSdrh   int orconf;             /* Default ON CONFLICT policy */
3026a451017dSdrh   u32 aColmask[2];        /* Masks of old.*, new.* columns accessed */
3027165921a7Sdan };
3028165921a7Sdan 
302964123585Sdrh /*
303064123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases.
303164123585Sdrh */
303201c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30
3033a7ab6d81Sdrh   typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
3034a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)[(I)/8]&(1<<((I)&7)))!=0)
3035a7ab6d81Sdrh # define DbMaskZero(M)      memset((M),0,sizeof(M))
3036a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)[(I)/8]|=(1<<((I)&7))
3037a7ab6d81Sdrh # define DbMaskAllZero(M)   sqlite3DbMaskAllZero(M)
3038a7ab6d81Sdrh # define DbMaskNonZero(M)   (sqlite3DbMaskAllZero(M)==0)
303901c7dc88Sdrh #else
304064123585Sdrh   typedef unsigned int yDbMask;
3041a7ab6d81Sdrh # define DbMaskTest(M,I)    (((M)&(((yDbMask)1)<<(I)))!=0)
3042a7ab6d81Sdrh # define DbMaskZero(M)      (M)=0
3043a7ab6d81Sdrh # define DbMaskSet(M,I)     (M)|=(((yDbMask)1)<<(I))
3044a7ab6d81Sdrh # define DbMaskAllZero(M)   (M)==0
3045a7ab6d81Sdrh # define DbMaskNonZero(M)   (M)!=0
304601c7dc88Sdrh #endif
304701c7dc88Sdrh 
3048ceea3321Sdrh /*
3049f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
3050f57b3399Sdrh ** the parser and down into all the parser action routine in order to
3051f57b3399Sdrh ** carry around information that is global to the entire parse.
3052f1974846Sdrh **
3053f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
3054f1974846Sdrh ** generate call themselves recursively, the first part of the structure
3055f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
3056f1974846Sdrh ** each recursion.
3057c00da105Sdanielk1977 **
3058c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
3059c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
3060c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
3061c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
3062c00da105Sdanielk1977 ** list.
306375897234Sdrh */
306475897234Sdrh struct Parse {
30659bb575fdSdrh   sqlite3 *db;         /* The main database structure */
306675897234Sdrh   char *zErrMsg;       /* An error message */
306775897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
3068a451017dSdrh   int rc;              /* Return code from execution */
3069836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
3070a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
3071205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
3072892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
3073a451017dSdrh   u8 isMultiWrite;     /* True if statement may modify/insert multiple rows */
3074a451017dSdrh   u8 mayAbort;         /* True if statement may throw an ABORT exception */
3075d58d3278Sdrh   u8 hasCompound;      /* Need to invoke convertCompoundSelectToSubquery() */
3076aceb31b1Sdrh   u8 okConstFactor;    /* OK to factor out constants */
30774a642b60Sdrh   u8 disableLookaside; /* Number of times lookaside has been disabled */
30781ea0443cSdan   u8 disableVtab;      /* Disable all virtual tables for this parse */
3079892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
3080892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
308175897234Sdrh   int nErr;            /* Number of errors seen */
3082832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
308319a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
3084bd57308eSdrh   int szOpAlloc;       /* Bytes of memory space allocated for Vdbe.aOp[] */
30857e8515d8Sdrh   int iSelfTab;        /* Table associated with an index on expr, or negative
30866e97f8ecSdrh                        ** of the base register during check-constraint eval */
3087d1d158bfSdrh   int nLabel;          /* The *negative* of the number of labels used */
3088ec4ccdbcSdrh   int nLabelAlloc;     /* Number of slots in aLabel */
30897df89c8cSdrh   int *aLabel;         /* Space to hold the labels */
3090f30a969bSdrh   ExprList *pConstExpr;/* Constant expressions */
30917df89c8cSdrh   Token constraintName;/* Name of the constraint currently being parsed */
309264123585Sdrh   yDbMask writeMask;   /* Start a write transaction on these databases */
309364123585Sdrh   yDbMask cookieMask;  /* Bitmask of schema verified databases */
3094a451017dSdrh   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
3095a451017dSdrh   int regRoot;         /* Register holding root page number for new objects */
3096a451017dSdrh   int nMaxArg;         /* Max args passed to user function by sub-program */
3097fef37760Sdrh   int nSelect;         /* Number of SELECT stmts. Counter for Select.selId */
3098c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
3099c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
3100c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
3101c00da105Sdanielk1977 #endif
31020b9f50d8Sdrh   AutoincInfo *pAinc;  /* Information about AUTOINCREMENT counters */
310365a7cd16Sdan   Parse *pToplevel;    /* Parse structure for main program (or NULL) */
3104165921a7Sdan   Table *pTriggerTab;  /* Table triggers are being coded for */
31051cf19758Sdrh   Parse *pParentParse; /* Parent parser if this parser is nested */
31060f3f7664Sdrh   int addrCrTab;       /* Address of OP_CreateBtree opcode on CREATE TABLE */
31074f402f26Sdrh   u32 nQueryLoop;      /* Est number of iterations of a query (10*log2(N)) */
310865a7cd16Sdan   u32 oldmask;         /* Mask of old.* columns referenced */
3109bb5f168fSdan   u32 newmask;         /* Mask of new.* columns referenced */
311065a7cd16Sdan   u8 eTriggerOp;       /* TK_UPDATE, TK_INSERT or TK_DELETE */
311165a7cd16Sdan   u8 eOrconf;          /* Default ON CONFLICT policy for trigger steps */
3112d66c8309Sdan   u8 disableTriggers;  /* True to disable triggers */
3113165921a7Sdan 
3114445f3d56Sdrh   /**************************************************************************
3115445f3d56Sdrh   ** Fields above must be initialized to zero.  The fields that follow,
3116445f3d56Sdrh   ** down to the beginning of the recursive section, do not need to be
3117445f3d56Sdrh   ** initialized as they will be set before being used.  The boundary is
311802ceed05Sdrh   ** determined by offsetof(Parse,aTempReg).
3119445f3d56Sdrh   **************************************************************************/
3120445f3d56Sdrh 
3121445f3d56Sdrh   int aTempReg[8];        /* Holding area for temporary registers */
3122445f3d56Sdrh   Token sNameToken;       /* Token with unqualified schema object name */
3123cd9af608Sdrh 
31247df89c8cSdrh   /************************************************************************
31257df89c8cSdrh   ** Above is constant between recursions.  Below is reset before and after
31267df89c8cSdrh   ** each recursion.  The boundary between these two regions is determined
3127588429a8Sdrh   ** using offsetof(Parse,sLastToken) so the sLastToken field must be the
3128588429a8Sdrh   ** first field in the recursive region.
31297df89c8cSdrh   ************************************************************************/
3130f1974846Sdrh 
3131588429a8Sdrh   Token sLastToken;       /* The last token parsed */
31326d664b4bSdrh   ynVar nVar;               /* Number of '?' variables seen in the SQL so far */
31337f9c5dbfSdrh   u8 iPkSortOrder;          /* ASC or DESC for INTEGER PRIMARY KEY */
3134a451017dSdrh   u8 explain;               /* True if the EXPLAIN flag is found on the query */
3135905f9816Sdan #if !(defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE))
3136cf8f2895Sdan   u8 eParseMode;            /* PARSE_MODE_XXX constant */
3137cf8f2895Sdan #endif
3138a451017dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3139a451017dSdrh   int nVtabLock;            /* Number of virtual tables to lock */
3140a451017dSdrh #endif
3141a451017dSdrh   int nHeight;              /* Expression tree height of current sub-select */
3142a451017dSdrh #ifndef SQLITE_OMIT_EXPLAIN
3143e2ca99c9Sdrh   int addrExplain;          /* Address of current OP_Explain opcode */
3144a451017dSdrh #endif
31459bf755ccSdrh   VList *pVList;            /* Mapping between variable names and numbers */
3146937d0deaSdan   Vdbe *pReprepare;         /* VM being reprepared (sqlite3Reprepare()) */
3147f1974846Sdrh   const char *zTail;        /* All SQL text past the last semicolon parsed */
3148f1974846Sdrh   Table *pNewTable;         /* A table being constructed by CREATE TABLE */
3149885eeb67Sdrh   Index *pNewIndex;         /* An index being constructed by CREATE INDEX.
3150885eeb67Sdrh                             ** Also used to hold redundant UNIQUE constraints
3151885eeb67Sdrh                             ** during a RENAME COLUMN */
3152f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
3153f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
3154b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
315533b3933cSdanielk1977   Token sArg;               /* Complete text of a module argument */
31564f3dd150Sdrh   Table **apVtabLock;       /* Pointer to virtual tables needing locking */
3157b9bb7c18Sdrh #endif
3158588a9a1aSdrh   Table *pZombieTab;        /* List of Table objects to delete after code gen */
31592832ad42Sdan   TriggerPrg *pTriggerPrg;  /* Linked list of coded triggers */
31604e9119d9Sdan   With *pWith;              /* Current WITH clause, or NULL */
31616e772266Sdrh   With *pWithToFree;        /* Free this WITH object at the end of the parse */
3162cf8f2895Sdan #ifndef SQLITE_OMIT_ALTERTABLE
31634a2c747cSdrh   RenameToken *pRename;     /* Tokens subject to renaming by ALTER TABLE */
3164cf8f2895Sdan #endif
316575897234Sdrh };
316675897234Sdrh 
3167cf8f2895Sdan #define PARSE_MODE_NORMAL        0
3168cf8f2895Sdan #define PARSE_MODE_DECLARE_VTAB  1
3169cf8f2895Sdan #define PARSE_MODE_RENAME_COLUMN 2
3170c9461eccSdan #define PARSE_MODE_RENAME_TABLE  3
3171cf8f2895Sdan 
3172a451017dSdrh /*
3173cd9af608Sdrh ** Sizes and pointers of various parts of the Parse object.
3174cd9af608Sdrh */
317502ceed05Sdrh #define PARSE_HDR_SZ offsetof(Parse,aTempReg) /* Recursive part w/o aColCache*/
3176588429a8Sdrh #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken)    /* Recursive part */
3177cd9af608Sdrh #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */
3178cd9af608Sdrh #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ)  /* Pointer to tail */
3179cd9af608Sdrh 
3180cd9af608Sdrh /*
3181a451017dSdrh ** Return true if currently inside an sqlite3_declare_vtab() call.
3182a451017dSdrh */
31837e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
31847e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
31857e6ebfb2Sdanielk1977 #else
3186cf8f2895Sdan   #define IN_DECLARE_VTAB (pParse->eParseMode==PARSE_MODE_DECLARE_VTAB)
3187cf8f2895Sdan #endif
3188cf8f2895Sdan 
3189cf8f2895Sdan #if defined(SQLITE_OMIT_ALTERTABLE)
3190c9461eccSdan   #define IN_RENAME_OBJECT 0
3191cf8f2895Sdan #else
3192c9461eccSdan   #define IN_RENAME_OBJECT (pParse->eParseMode>=PARSE_MODE_RENAME_COLUMN)
3193cf8f2895Sdan #endif
3194cf8f2895Sdan 
3195cf8f2895Sdan #if defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_OMIT_ALTERTABLE)
3196cf8f2895Sdan   #define IN_SPECIAL_PARSE 0
3197cf8f2895Sdan #else
3198cf8f2895Sdan   #define IN_SPECIAL_PARSE (pParse->eParseMode!=PARSE_MODE_NORMAL)
31997e6ebfb2Sdanielk1977 #endif
32007e6ebfb2Sdanielk1977 
3201d99bc930Sdanielk1977 /*
320285e2096fSdrh ** An instance of the following structure can be declared on a stack and used
320385e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
320485e2096fSdrh */
320585e2096fSdrh struct AuthContext {
320685e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
320785e2096fSdrh   Parse *pParse;              /* The Parse structure */
320885e2096fSdrh };
320985e2096fSdrh 
321085e2096fSdrh /*
3211a748fdccSdrh ** Bitfield flags for P5 value in various opcodes.
321249711600Sdrh **
321349711600Sdrh ** Value constraints (enforced via assert()):
321449711600Sdrh **    OPFLAG_LENGTHARG    == SQLITE_FUNC_LENGTH
321549711600Sdrh **    OPFLAG_TYPEOFARG    == SQLITE_FUNC_TYPEOF
321649711600Sdrh **    OPFLAG_BULKCSR      == BTREE_BULKLOAD
321749711600Sdrh **    OPFLAG_SEEKEQ       == BTREE_SEEK_EQ
321849711600Sdrh **    OPFLAG_FORDELETE    == BTREE_FORDELETE
321949711600Sdrh **    OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
322049711600Sdrh **    OPFLAG_AUXDELETE    == BTREE_AUXDELETE
3221b0c374ffSrdc */
3222e807bdbaSdrh #define OPFLAG_NCHANGE       0x01    /* OP_Insert: Set to update db->nChange */
3223e807bdbaSdrh                                      /* Also used in P2 (not P5) of OP_Delete */
322409d00b2fSdrh #define OPFLAG_NOCHNG        0x01    /* OP_VColumn nochange for UPDATE */
322597348b37Sdrh #define OPFLAG_EPHEM         0x01    /* OP_Column: Ephemeral output is ok */
3226f91c1318Sdan #define OPFLAG_LASTROWID     0x20    /* Set to update db->lastRowid */
32273e9ca094Sdrh #define OPFLAG_ISUPDATE      0x04    /* This OP_Insert is an sql UPDATE */
32283e9ca094Sdrh #define OPFLAG_APPEND        0x08    /* This is likely to be an append */
32293e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10    /* Try to avoid a seek in BtreeInsert() */
323046c47d46Sdan #define OPFLAG_ISNOOP        0x40    /* OP_Delete does pre-update-hook only */
3231a748fdccSdrh #define OPFLAG_LENGTHARG     0x40    /* OP_Column only used for length() */
3232a748fdccSdrh #define OPFLAG_TYPEOFARG     0x80    /* OP_Column only used for typeof() */
3233428c218cSdan #define OPFLAG_BULKCSR       0x01    /* OP_Open** used to open bulk cursor */
3234e0997b34Sdrh #define OPFLAG_SEEKEQ        0x02    /* OP_Open** cursor uses EQ seek only */
32359c0c57a4Sdrh #define OPFLAG_FORDELETE     0x08    /* OP_Open should use BTREE_FORDELETE */
3236fd261ec6Sdan #define OPFLAG_P2ISREG       0x10    /* P2 to OP_Open** is a register number */
3237953f7611Sdrh #define OPFLAG_PERMUTE       0x01    /* OP_Compare: use the permutation */
3238f91c1318Sdan #define OPFLAG_SAVEPOSITION  0x02    /* OP_Delete/Insert: save cursor pos */
3239def19e3bSdrh #define OPFLAG_AUXDELETE     0x04    /* OP_Delete: index in a DELETE op */
324041fb367aSdrh #define OPFLAG_NOCHNG_MAGIC  0x6d    /* OP_MakeRecord: serialtype 10 is ok */
3241b0c374ffSrdc 
3242b0c374ffSrdc /*
3243d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
3244d99bc930Sdanielk1977  * struct Trigger.
3245d99bc930Sdanielk1977  *
3246d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
32479bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
3248d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
3249d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
3250ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
3251ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
3252ad3cab52Sdrh  *    struct Table.
3253d99bc930Sdanielk1977  *
3254ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
3255ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
3256d99bc930Sdanielk1977  */
3257d99bc930Sdanielk1977 struct Trigger {
3258165921a7Sdan   char *zName;            /* The name of the trigger                        */
3259d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
3260f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
3261dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
3262467bcf36Sshane   Expr *pWhen;            /* The WHEN clause of the expression (may be NULL) */
3263d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
3264d99bc930Sdanielk1977                              the <column-list> is stored here */
3265e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
3266e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
3267d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
3268d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
3269c3f9bad2Sdanielk1977 };
3270d99bc930Sdanielk1977 
3271d99bc930Sdanielk1977 /*
3272dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
3273dca76841Sdrh ** determine which.
3274dca76841Sdrh **
3275dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
3276dca76841Sdrh ** In that cases, the constants below can be ORed together.
3277dca76841Sdrh */
3278dca76841Sdrh #define TRIGGER_BEFORE  1
3279dca76841Sdrh #define TRIGGER_AFTER   2
3280dca76841Sdrh 
3281dca76841Sdrh /*
3282d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
3283d99bc930Sdanielk1977  * that is a part of a trigger-program.
3284d99bc930Sdanielk1977  *
3285d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
3286d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
3287d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
3288d99bc930Sdanielk1977  * the first step of the trigger-program.
3289d99bc930Sdanielk1977  *
3290d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
3291d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
3292d99bc930Sdanielk1977  * value of "op" as follows:
3293d99bc930Sdanielk1977  *
3294d99bc930Sdanielk1977  * (op == TK_INSERT)
3295d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
3296d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
3297d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
329846408354Sdan  * zTarget   -> Dequoted name of the table to insert into.
3299d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
3300d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
3301d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
3302ad3cab52Sdrh  *              statement, then this stores the column-names to be
3303ad3cab52Sdrh  *              inserted into.
3304d99bc930Sdanielk1977  *
3305d99bc930Sdanielk1977  * (op == TK_DELETE)
330646408354Sdan  * zTarget   -> Dequoted name of the table to delete from.
3307d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
3308d99bc930Sdanielk1977  *              Otherwise NULL.
3309d99bc930Sdanielk1977  *
3310d99bc930Sdanielk1977  * (op == TK_UPDATE)
331146408354Sdan  * zTarget   -> Dequoted name of the table to update.
3312d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
3313d99bc930Sdanielk1977  *              Otherwise NULL.
3314d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
33154adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
3316ad3cab52Sdrh  *              argument.
3317d99bc930Sdanielk1977  *
3318d99bc930Sdanielk1977  */
3319c3f9bad2Sdanielk1977 struct TriggerStep {
3320b1819a0bSdrh   u8 op;               /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
3321b1819a0bSdrh   u8 orconf;           /* OE_Rollback etc. */
3322a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
332346408354Sdan   Select *pSelect;     /* SELECT statement or RHS of INSERT INTO SELECT ... */
332446408354Sdan   char *zTarget;       /* Target table for DELETE, UPDATE, INSERT */
3325b1819a0bSdrh   Expr *pWhere;        /* The WHERE clause for DELETE or UPDATE steps */
332646d2e5c3Sdrh   ExprList *pExprList; /* SET clause for UPDATE */
3327b1819a0bSdrh   IdList *pIdList;     /* Column names for INSERT */
332846d2e5c3Sdrh   Upsert *pUpsert;     /* Upsert clauses on an INSERT */
3329f259df5fSdrh   char *zSpan;         /* Original SQL text of this command */
3330c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
3331187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
3332c3f9bad2Sdanielk1977 };
3333c3f9bad2Sdanielk1977 
3334d99bc930Sdanielk1977 /*
3335f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
3336f26e09c8Sdrh ** routines as they walk the parse tree to make database references
3337f26e09c8Sdrh ** explicit.
3338f26e09c8Sdrh */
3339f26e09c8Sdrh typedef struct DbFixer DbFixer;
3340f26e09c8Sdrh struct DbFixer {
3341f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
334241fb5cd1Sdan   Schema *pSchema;    /* Fix items to this schema */
334346539d7cSdan   int bVarOnly;       /* Check for variable references only */
3344f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
3345f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
3346f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
3347f26e09c8Sdrh };
3348f26e09c8Sdrh 
3349f26e09c8Sdrh /*
3350ade86483Sdrh ** An objected used to accumulate the text of a string where we
3351ade86483Sdrh ** do not necessarily know how big the string will be in the end.
3352ade86483Sdrh */
33530cdbe1aeSdrh struct sqlite3_str {
3354633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
3355ade86483Sdrh   char *zText;         /* The string collected so far */
3356fa385edfSdrh   u32  nAlloc;         /* Amount of space allocated in zText */
3357fa385edfSdrh   u32  mxAlloc;        /* Maximum allowed allocation.  0 for no malloc usage */
33583f18e6d7Sdrh   u32  nChar;          /* Length of the string so far */
33590cdbe1aeSdrh   u8   accError;       /* SQLITE_NOMEM or SQLITE_TOOBIG */
33605f4a686fSdrh   u8   printfFlags;    /* SQLITE_PRINTF flags below */
3361ade86483Sdrh };
33625f4a686fSdrh #define SQLITE_PRINTF_INTERNAL 0x01  /* Internal-use-only converters allowed */
33635f4a686fSdrh #define SQLITE_PRINTF_SQLFUNC  0x02  /* SQL function arguments to VXPrintf */
33645f4a686fSdrh #define SQLITE_PRINTF_MALLOCED 0x04  /* True if xText is allocated space */
33655f4a686fSdrh 
33665f4a686fSdrh #define isMalloced(X)  (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
33675f4a686fSdrh 
3368ade86483Sdrh 
3369ade86483Sdrh /*
3370234c39dfSdrh ** A pointer to this structure is used to communicate information
3371234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
3372234c39dfSdrh */
3373234c39dfSdrh typedef struct {
33749bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
3375234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
3376a451017dSdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
337715ca1df1Sdrh   int rc;             /* Result code stored here */
3378987db767Sdan   u32 mInitFlags;     /* Flags controlling error messages */
33796b86e51eSdrh   u32 nInitRow;       /* Number of rows processed */
3380234c39dfSdrh } InitData;
3381234c39dfSdrh 
3382b6c29897Sdrh /*
3383987db767Sdan ** Allowed values for mInitFlags
3384987db767Sdan */
3385987db767Sdan #define INITFLAG_AlterTable   0x0001  /* This is a reparse after ALTER TABLE */
3386987db767Sdan 
3387987db767Sdan /*
338840257ffdSdrh ** Structure containing global configuration data for the SQLite library.
338933589797Sdrh **
339033589797Sdrh ** This structure also contains some state information.
339140257ffdSdrh */
339240257ffdSdrh struct Sqlite3Config {
3393fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
3394fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
3395fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
3396cd74b611Sdan   int bOpenUri;                     /* True to interpret filenames as URIs */
3397de9a7b8aSdrh   int bUseCis;                      /* Use covering indices for full-scans */
3398b2a0f75cSdrh   int bSmallMalloc;                 /* Avoid large memory allocations if true */
33990a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
340009fe6143Sdrh   int neverCorrupt;                 /* Database is always well-formed */
3401633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
3402633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
34038c71a98cSdrh   int nStmtSpill;                   /* Stmt-journal spill-to-disk threshold */
3404fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
34056d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
340622e21ff4Sdan   sqlite3_pcache_methods2 pcache2;  /* Low-level page-cache interface */
340740257ffdSdrh   void *pHeap;                      /* Heap storage space */
340833589797Sdrh   int nHeap;                        /* Size of pHeap[] */
340933589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
34109b4c59faSdrh   sqlite3_int64 szMmap;             /* mmap() space per open file */
34119b4c59faSdrh   sqlite3_int64 mxMmap;             /* Maximum value for szMmap */
341233589797Sdrh   void *pPage;                      /* Page cache memory */
341333589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
341433589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
34151875f7a3Sdrh   int mxParserStack;                /* maximum depth of the parser stack */
34161875f7a3Sdrh   int sharedCacheEnabled;           /* true if shared-cache mode enabled */
34173bd1791dSdrh   u32 szPma;                        /* Maximum Sorter PMA size */
34181875f7a3Sdrh   /* The above might be initialized to non-zero.  The following need to always
34191875f7a3Sdrh   ** initially be zero, however. */
342071bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
3421502b4e00Sdanielk1977   int inProgress;                   /* True while initialization in progress */
3422e1ab2193Sdan   int isMutexInit;                  /* True after mutexes are initialized */
342371bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
3424e1ab2193Sdan   int isPCacheInit;                 /* True after malloc is initialized */
342593ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
3426c007f61bSdrh   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
34273f280701Sdrh   void (*xLog)(void*,int,const char*); /* Function for logging */
34283f280701Sdrh   void *pLogArg;                       /* First argument to xLog() */
3429ac455939Sdan #ifdef SQLITE_ENABLE_SQLLOG
3430ac455939Sdan   void(*xSqllog)(void*,sqlite3*,const char*, int);
3431ac455939Sdan   void *pSqllogArg;
3432ac455939Sdan #endif
3433688852abSdrh #ifdef SQLITE_VDBE_COVERAGE
3434688852abSdrh   /* The following callback (if not NULL) is invoked on every VDBE branch
3435688852abSdrh   ** operation.  Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
3436688852abSdrh   */
34377083a487Sdrh   void (*xVdbeBranch)(void*,unsigned iSrcLine,u8 eThis,u8 eMx);  /* Callback */
3438688852abSdrh   void *pVdbeBranchArg;                                     /* 1st argument */
3439688852abSdrh #endif
344023a88595Sdrh #ifdef SQLITE_ENABLE_DESERIALIZE
344123a88595Sdrh   sqlite3_int64 mxMemdbSize;        /* Default max memdb size */
344223a88595Sdrh #endif
3443d12602a9Sdrh #ifndef SQLITE_UNTESTABLE
3444c007f61bSdrh   int (*xTestCallback)(int);        /* Invoked by sqlite3FaultSim() */
3445c007f61bSdrh #endif
3446c007f61bSdrh   int bLocaltimeFault;              /* True to fail localtime() calls */
3447eea8eb6dSdrh   int bInternalFunctions;           /* Internal SQL functions are visible */
34489e5eb9c8Sdrh   int iOnceResetThreshold;          /* When to reset OP_Once counters */
34492e3a5a81Sdan   u32 szSorterRef;                  /* Min size in bytes to use sorter-refs */
345040257ffdSdrh };
345140257ffdSdrh 
345240257ffdSdrh /*
345309fe6143Sdrh ** This macro is used inside of assert() statements to indicate that
345409fe6143Sdrh ** the assert is only valid on a well-formed database.  Instead of:
345509fe6143Sdrh **
345609fe6143Sdrh **     assert( X );
345709fe6143Sdrh **
345809fe6143Sdrh ** One writes:
345909fe6143Sdrh **
3460b2023665Sdrh **     assert( X || CORRUPT_DB );
346109fe6143Sdrh **
3462b2023665Sdrh ** CORRUPT_DB is true during normal operation.  CORRUPT_DB does not indicate
3463b2023665Sdrh ** that the database is definitely corrupt, only that it might be corrupt.
3464b2023665Sdrh ** For most test cases, CORRUPT_DB is set to false using a special
3465b2023665Sdrh ** sqlite3_test_control().  This enables assert() statements to prove
3466b2023665Sdrh ** things that are always true for well-formed databases.
346709fe6143Sdrh */
3468b2023665Sdrh #define CORRUPT_DB  (sqlite3Config.neverCorrupt==0)
346909fe6143Sdrh 
347009fe6143Sdrh /*
34717d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
34727d10d5a6Sdrh */
34737d10d5a6Sdrh struct Walker {
34749bfb024dSdrh   Parse *pParse;                            /* Parser context.  */
34757d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
34767d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
3477b290f117Sdan   void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
3478030796dfSdrh   int walkerDepth;                          /* Number of subqueries */
3479059b2d50Sdrh   u8 eCode;                                 /* A small processing code */
34807d10d5a6Sdrh   union {                                   /* Extra data for callback */
34817d10d5a6Sdrh     NameContext *pNC;                         /* Naming context */
3482059b2d50Sdrh     int n;                                    /* A counter */
3483059b2d50Sdrh     int iCur;                                 /* A cursor number */
3484374fdce4Sdrh     SrcList *pSrcList;                        /* FROM clause */
3485030796dfSdrh     struct SrcCount *pSrcCount;               /* Counting column references */
34862f2b0278Sdrh     struct CCurHint *pCCurHint;               /* Used by codeCursorHint() */
34872a0b527bSdrh     int *aiCol;                               /* array of column indexes */
34882409f8a1Sdrh     struct IdxCover *pIdxCover;               /* Check for index coverage */
3489cd0abc24Sdrh     struct IdxExprTrans *pIdxTrans;           /* Convert idxed expr to column */
3490ab31a845Sdan     ExprList *pGroupBy;                       /* GROUP BY clause */
3491cd0abc24Sdrh     Select *pSelect;                          /* HAVING to WHERE clause ctx */
349286fb6e17Sdan     struct WindowRewrite *pRewrite;           /* Window rewrite context */
3493660ee556Sdrh     struct WhereConst *pConst;                /* WHERE clause constants */
3494cf8f2895Sdan     struct RenameCtx *pRename;                /* RENAME COLUMN context */
34957d10d5a6Sdrh   } u;
34967d10d5a6Sdrh };
34977d10d5a6Sdrh 
34987d10d5a6Sdrh /* Forward declarations */
34997d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
35007d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
35017d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
35027d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
35037d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
35045b88bc4bSdrh int sqlite3ExprWalkNoop(Walker*, Expr*);
3505979dd1beSdrh int sqlite3SelectWalkNoop(Walker*, Select*);
35067e6f980bSdrh int sqlite3SelectWalkFail(Walker*, Select*);
3507979dd1beSdrh #ifdef SQLITE_DEBUG
3508979dd1beSdrh void sqlite3SelectWalkAssert2(Walker*, Select*);
3509979dd1beSdrh #endif
35107d10d5a6Sdrh 
35117d10d5a6Sdrh /*
35127d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
35137d10d5a6Sdrh ** callbacks.
35147d10d5a6Sdrh */
35152bf90f1eSdrh #define WRC_Continue    0   /* Continue down into children */
35162bf90f1eSdrh #define WRC_Prune       1   /* Omit children but continue walking siblings */
35172bf90f1eSdrh #define WRC_Abort       2   /* Abandon the tree walk */
35187d10d5a6Sdrh 
35197d10d5a6Sdrh /*
3520eae73fbfSdan ** An instance of this structure represents a set of one or more CTEs
3521c49832c2Sdrh ** (common table expressions) created by a single WITH clause.
35227d562dbeSdan */
35237d562dbeSdan struct With {
3524c49832c2Sdrh   int nCte;                       /* Number of CTEs in the WITH clause */
35254e9119d9Sdan   With *pOuter;                   /* Containing WITH clause, or NULL */
3526c49832c2Sdrh   struct Cte {                    /* For each CTE in the WITH clause.... */
35274e9119d9Sdan     char *zName;                    /* Name of this CTE */
35284e9119d9Sdan     ExprList *pCols;                /* List of explicit column names, or NULL */
3529c49832c2Sdrh     Select *pSelect;                /* The definition of this CTE */
35300576bc59Sdrh     const char *zCteErr;            /* Error message for circular references */
35317d562dbeSdan   } a[1];
35327d562dbeSdan };
35337d562dbeSdan 
35344fa4a54fSdrh #ifdef SQLITE_DEBUG
35354fa4a54fSdrh /*
35364fa4a54fSdrh ** An instance of the TreeView object is used for printing the content of
35374fa4a54fSdrh ** data structures on sqlite3DebugPrintf() using a tree-like view.
35384fa4a54fSdrh */
35394fa4a54fSdrh struct TreeView {
35404fa4a54fSdrh   int iLevel;             /* Which level of the tree we are on */
3541b08cd3f3Sdrh   u8  bLine[100];         /* Draw vertical in column i if bLine[i] is true */
35424fa4a54fSdrh };
35434fa4a54fSdrh #endif /* SQLITE_DEBUG */
35444fa4a54fSdrh 
35459a94722dSdan /*
3546fc15f4c5Sdrh ** This object is used in various ways, all related to window functions
3547a1fd4b52Sdrh **
3548a1fd4b52Sdrh **   (1) A single instance of this structure is attached to the
3549a1fd4b52Sdrh **       the Expr.pWin field for each window function in an expression tree.
3550a1fd4b52Sdrh **       This object holds the information contained in the OVER clause,
3551a1fd4b52Sdrh **       plus additional fields used during code generation.
3552a1fd4b52Sdrh **
3553a1fd4b52Sdrh **   (2) All window functions in a single SELECT form a linked-list
3554a1fd4b52Sdrh **       attached to Select.pWin.  The Window.pFunc and Window.pExpr
3555a1fd4b52Sdrh **       fields point back to the expression that is the window function.
3556a1fd4b52Sdrh **
3557a1fd4b52Sdrh **   (3) The terms of the WINDOW clause of a SELECT are instances of this
3558a1fd4b52Sdrh **       object on a linked list attached to Select.pWinDefn.
3559a1fd4b52Sdrh **
3560a1fd4b52Sdrh ** The uses (1) and (2) are really the same Window object that just happens
3561fc15f4c5Sdrh ** to be accessible in two different ways.  Use case (3) are separate objects.
35629a94722dSdan */
356386fb6e17Sdan struct Window {
3564e3bf632cSdan   char *zName;            /* Name of window (may be NULL) */
3565e7c9ca41Sdan   char *zBase;            /* Name of base window for chaining (may be NULL) */
3566e3bf632cSdan   ExprList *pPartition;   /* PARTITION BY clause */
3567e3bf632cSdan   ExprList *pOrderBy;     /* ORDER BY clause */
3568fc15f4c5Sdrh   u8 eFrmType;            /* TK_RANGE, TK_GROUPS, TK_ROWS, or 0 */
356986fb6e17Sdan   u8 eStart;              /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */
357086fb6e17Sdan   u8 eEnd;                /* UNBOUNDED, CURRENT, PRECEDING or FOLLOWING */
3571e7c9ca41Sdan   u8 bImplicitFrame;      /* True if frame was implicitly specified */
3572fc15f4c5Sdrh   u8 eExclude;            /* TK_NO, TK_CURRENT, TK_TIES, TK_GROUP, or 0 */
357386fb6e17Sdan   Expr *pStart;           /* Expression for "<expr> PRECEDING" */
357486fb6e17Sdan   Expr *pEnd;             /* Expression for "<expr> FOLLOWING" */
357586fb6e17Sdan   Window *pNextWin;       /* Next window function belonging to this SELECT */
3576a1fd4b52Sdrh   Expr *pFilter;          /* The FILTER expression */
3577a1fd4b52Sdrh   FuncDef *pFunc;         /* The function */
3578b0225bc5Sdrh   int iEphCsr;            /* Partition buffer or Peer buffer */
357986fb6e17Sdan   int regAccum;
358086fb6e17Sdan   int regResult;
3581c9a8668aSdan   int csrApp;             /* Function cursor (used by min/max) */
3582c9a8668aSdan   int regApp;             /* Function register (also used by min/max) */
3583b6f2deacSdan   int regPart;            /* Array of registers for PARTITION BY values */
358486fb6e17Sdan   Expr *pOwner;           /* Expression object this window is attached to */
358586fb6e17Sdan   int nBufferCol;         /* Number of columns in buffer table */
358686fb6e17Sdan   int iArgCol;            /* Offset of first argument for this function */
3587bf84515aSdan   int regOne;             /* Register containing constant value 1 */
3588a0f6b833Sdan   int regStartRowid;
3589a0f6b833Sdan   int regEndRowid;
359086fb6e17Sdan };
359186fb6e17Sdan 
359267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
359386fb6e17Sdan void sqlite3WindowDelete(sqlite3*, Window*);
3594e3bf632cSdan void sqlite3WindowListDelete(sqlite3 *db, Window *p);
3595d35300f9Sdan Window *sqlite3WindowAlloc(Parse*, int, int, Expr*, int , Expr*, u8);
359686fb6e17Sdan void sqlite3WindowAttach(Parse*, Expr*, Window*);
3597e2f781b9Sdan int sqlite3WindowCompare(Parse*, Window*, Window*);
3598f9eae18bSdan void sqlite3WindowCodeInit(Parse*, Window*);
3599dacf1de9Sdan void sqlite3WindowCodeStep(Parse*, Select*, WhereInfo*, int, int);
3600dfa552f4Sdan int sqlite3WindowRewrite(Parse*, Select*);
3601dfa552f4Sdan int sqlite3ExpandSubquery(Parse*, struct SrcList_item*);
3602e3bf632cSdan void sqlite3WindowUpdate(Parse*, Window*, Window*, FuncDef*);
36032a11bb23Sdan Window *sqlite3WindowDup(sqlite3 *db, Expr *pOwner, Window *p);
3604c95f38d4Sdan Window *sqlite3WindowListDup(sqlite3 *db, Window *p);
36059a94722dSdan void sqlite3WindowFunctions(void);
3606e7c9ca41Sdan void sqlite3WindowChain(Parse*, Window*, Window*);
3607e7c9ca41Sdan Window *sqlite3WindowAssemble(Parse*, Window*, ExprList*, ExprList*, Token*);
360867a9b8edSdan #else
360967a9b8edSdan # define sqlite3WindowDelete(a,b)
361067a9b8edSdan # define sqlite3WindowFunctions()
361167a9b8edSdan # define sqlite3WindowAttach(a,b,c)
361267a9b8edSdan #endif
361386fb6e17Sdan 
36147d562dbeSdan /*
361566150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
361666150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
36174a919118Sdrh */
36184a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
36194a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
36204a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
36214a919118Sdrh   }                                                    \
36224a919118Sdrh }
36234a919118Sdrh 
36244a919118Sdrh /*
36259978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with
36269978c97eSdrh ** the same name but without the _BKPT suffix.  These macros invoke
36279978c97eSdrh ** routines that report the line-number on which the error originated
36289978c97eSdrh ** using sqlite3_log().  The routines also provide a convenient place
36299978c97eSdrh ** to set a debugger breakpoint.
363049285708Sdrh */
3631eebf2f57Sdan int sqlite3ReportError(int iErr, int lineno, const char *zType);
36329978c97eSdrh int sqlite3CorruptError(int);
36339978c97eSdrh int sqlite3MisuseError(int);
36349978c97eSdrh int sqlite3CantopenError(int);
36359978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
36369978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
36379978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
363832c49904Sdrh #ifdef SQLITE_DEBUG
363932c49904Sdrh   int sqlite3NomemError(int);
364032c49904Sdrh   int sqlite3IoerrnomemError(int);
3641cc97ca4cSdrh   int sqlite3CorruptPgnoError(int,Pgno);
3642fad3039cSmistachkin # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
3643fad3039cSmistachkin # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
3644cc97ca4cSdrh # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P))
364532c49904Sdrh #else
364632c49904Sdrh # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
364732c49904Sdrh # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
3648cc97ca4cSdrh # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__)
364932c49904Sdrh #endif
36509978c97eSdrh 
36514553f6eaSdrh /*
36524553f6eaSdrh ** FTS3 and FTS4 both require virtual table support
36534553f6eaSdrh */
36544553f6eaSdrh #if defined(SQLITE_OMIT_VIRTUALTABLE)
36554553f6eaSdrh # undef SQLITE_ENABLE_FTS3
36564553f6eaSdrh # undef SQLITE_ENABLE_FTS4
36574553f6eaSdrh #endif
365849285708Sdrh 
365949285708Sdrh /*
3660b4a1fed2Sdrh ** FTS4 is really an extension for FTS3.  It is enabled using the
366160ec914cSpeter.d.reid ** SQLITE_ENABLE_FTS3 macro.  But to avoid confusion we also call
366260ec914cSpeter.d.reid ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
3663b4a1fed2Sdrh */
3664b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
36650ede9ebeSdrh # define SQLITE_ENABLE_FTS3 1
3666b4a1fed2Sdrh #endif
3667b4a1fed2Sdrh 
3668b4a1fed2Sdrh /*
366979f02cefSdrh ** The ctype.h header is needed for non-ASCII systems.  It is also
367079f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation.
367179f02cefSdrh */
367279f02cefSdrh #if !defined(SQLITE_ASCII) || \
367379f02cefSdrh     (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
367479f02cefSdrh # include <ctype.h>
367579f02cefSdrh #endif
367679f02cefSdrh 
367779f02cefSdrh /*
367878ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(),
367978ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
368078ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale.
368178ca0e7eSdanielk1977 */
368278ca0e7eSdanielk1977 #ifdef SQLITE_ASCII
368378ca0e7eSdanielk1977 # define sqlite3Toupper(x)  ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
368478ca0e7eSdanielk1977 # define sqlite3Isspace(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
3685dc86e2b2Sdrh # define sqlite3Isalnum(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
3686dc86e2b2Sdrh # define sqlite3Isalpha(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
368778ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
368878ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
368978ca0e7eSdanielk1977 # define sqlite3Tolower(x)   (sqlite3UpperToLower[(unsigned char)(x)])
3690244b9d6eSdrh # define sqlite3Isquote(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
369178ca0e7eSdanielk1977 #else
369278ca0e7eSdanielk1977 # define sqlite3Toupper(x)   toupper((unsigned char)(x))
369378ca0e7eSdanielk1977 # define sqlite3Isspace(x)   isspace((unsigned char)(x))
369478ca0e7eSdanielk1977 # define sqlite3Isalnum(x)   isalnum((unsigned char)(x))
3695dc86e2b2Sdrh # define sqlite3Isalpha(x)   isalpha((unsigned char)(x))
369678ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   isdigit((unsigned char)(x))
369778ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  isxdigit((unsigned char)(x))
369878ca0e7eSdanielk1977 # define sqlite3Tolower(x)   tolower((unsigned char)(x))
3699244b9d6eSdrh # define sqlite3Isquote(x)   ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
370078ca0e7eSdanielk1977 #endif
370197348b37Sdrh int sqlite3IsIdChar(u8);
370278ca0e7eSdanielk1977 
370378ca0e7eSdanielk1977 /*
370475897234Sdrh ** Internal function prototypes
370575897234Sdrh */
370680738d9cSdrh int sqlite3StrICmp(const char*,const char*);
3707ea678832Sdrh int sqlite3Strlen30(const char*);
37087301e774Sdrh #define sqlite3Strlen30NN(C) (strlen(C)&0x3fffffff)
3709d7564865Sdrh char *sqlite3ColumnType(Column*,char*);
3710ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp
37112e588c75Sdanielk1977 
371240257ffdSdrh int sqlite3MallocInit(void);
3713fec00eabSdrh void sqlite3MallocEnd(void);
3714da4ca9d1Sdrh void *sqlite3Malloc(u64);
3715da4ca9d1Sdrh void *sqlite3MallocZero(u64);
3716da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3*, u64);
3717da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3*, u64);
3718575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3*, u64);
371917435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
3720da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
37219b2e0435Sdrh char *sqlite3DbSpanDup(sqlite3*,const char*,const char*);
3722da4ca9d1Sdrh void *sqlite3Realloc(void*, u64);
3723da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
3724da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *, void *, u64);
3725633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
3726dbd6a7dcSdrh void sqlite3DbFreeNN(sqlite3*, void*);
3727a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
3728633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
3729facf0307Sdrh void *sqlite3PageMalloc(int);
3730facf0307Sdrh void sqlite3PageFree(void*);
3731fec00eabSdrh void sqlite3MemSetDefault(void);
3732d12602a9Sdrh #ifndef SQLITE_UNTESTABLE
3733171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
3734f5ed7ad6Sdrh #endif
373550d1b5f3Sdrh int sqlite3HeapNearlyFull(void);
37362e588c75Sdanielk1977 
3737e7b34707Sdrh /*
3738e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make
3739e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects.  By default,
3740e7b34707Sdrh ** obtain space from malloc().
3741e7b34707Sdrh **
3742e7b34707Sdrh ** The alloca() routine never returns NULL.  This will cause code paths
3743e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable.
3744e7b34707Sdrh */
3745e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA
3746e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   alloca(N)
3747e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  memset(alloca(N), 0, N)
3748e7b34707Sdrh # define sqlite3StackFree(D,P)
3749e7b34707Sdrh #else
3750e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   sqlite3DbMallocRaw(D,N)
3751e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  sqlite3DbMallocZero(D,N)
3752e7b34707Sdrh # define sqlite3StackFree(D,P)       sqlite3DbFree(D,P)
3753e7b34707Sdrh #endif
3754e7b34707Sdrh 
37555d513ba0Sdrh /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together.  If they
37565d513ba0Sdrh ** are, disable MEMSYS3
37575d513ba0Sdrh */
3758f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5
3759f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
37605d513ba0Sdrh #undef SQLITE_ENABLE_MEMSYS3
37615d513ba0Sdrh #endif
37625d513ba0Sdrh #ifdef SQLITE_ENABLE_MEMSYS3
37635d513ba0Sdrh const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
3764f3d3c27aSdanielk1977 #endif
3765f3d3c27aSdanielk1977 
3766f3d3c27aSdanielk1977 
376718472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT
3768558814f8Sdan   sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
3769558814f8Sdan   sqlite3_mutex_methods const *sqlite3NoopMutex(void);
377059f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
3771d025174fSdanielk1977   int sqlite3MutexInit(void);
3772d025174fSdanielk1977   int sqlite3MutexEnd(void);
377365bbf29eSdrh #endif
37740e8729dbSdrh #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
37756081c1dbSdrh   void sqlite3MemoryBarrier(void);
37760e8729dbSdrh #else
377704abf087Smistachkin # define sqlite3MemoryBarrier()
3778f7141990Sdrh #endif
3779f7141990Sdrh 
3780af89fe66Sdrh sqlite3_int64 sqlite3StatusValue(int);
3781af89fe66Sdrh void sqlite3StatusUp(int, int);
3782af89fe66Sdrh void sqlite3StatusDown(int, int);
3783b02392e6Sdrh void sqlite3StatusHighwater(int, int);
378452fb8e19Sdrh int sqlite3LookasideUsed(sqlite3*,int*);
3785f7141990Sdrh 
3786af89fe66Sdrh /* Access to mutexes used by sqlite3_status() */
3787af89fe66Sdrh sqlite3_mutex *sqlite3Pcache1Mutex(void);
3788af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void);
3789af89fe66Sdrh 
379061f8e86fSdan #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT)
37918385becfSdan void sqlite3MutexWarnOnContention(sqlite3_mutex*);
37928385becfSdan #else
37938385becfSdan # define sqlite3MutexWarnOnContention(x)
37948385becfSdan #endif
37958385becfSdan 
379685c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
37970de3ae95Sdrh   int sqlite3IsNaN(double);
379885c8f291Sdrh #else
379985c8f291Sdrh # define sqlite3IsNaN(X)  0
380085c8f291Sdrh #endif
38010de3ae95Sdrh 
3802a5c1416dSdrh /*
3803a5c1416dSdrh ** An instance of the following structure holds information about SQL
3804a5c1416dSdrh ** functions arguments that are the parameters to the printf() function.
3805a5c1416dSdrh */
3806a5c1416dSdrh struct PrintfArguments {
3807a5c1416dSdrh   int nArg;                /* Total number of arguments */
3808a5c1416dSdrh   int nUsed;               /* Number of arguments used so far */
3809a5c1416dSdrh   sqlite3_value **apArg;   /* The argument values */
3810a5c1416dSdrh };
3811a5c1416dSdrh 
381217435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
381317435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
381402b0e267Smistachkin #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
3815e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
3816d919fe17Sdrh #endif
3817d919fe17Sdrh #if defined(SQLITE_TEST)
3818e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
381987cc3b31Sdrh #endif
38207e02e5e6Sdrh 
38214fa4a54fSdrh #if defined(SQLITE_DEBUG)
38224fa4a54fSdrh   void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
3823db97e562Sdrh   void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*);
38244fa4a54fSdrh   void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
3825145d0a35Sdrh   void sqlite3TreeViewSrcList(TreeView*, const SrcList*);
38264fa4a54fSdrh   void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
38272476a6f2Sdrh   void sqlite3TreeViewWith(TreeView*, const With*, u8);
3828a1fd4b52Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
3829a1fd4b52Sdrh   void sqlite3TreeViewWindow(TreeView*, const Window*, u8);
3830a1fd4b52Sdrh   void sqlite3TreeViewWinFunc(TreeView*, const Window*, u8);
3831a1fd4b52Sdrh #endif
38327e02e5e6Sdrh #endif
38337e02e5e6Sdrh 
38347e02e5e6Sdrh 
383522c17b8bSdrh void sqlite3SetString(char **, sqlite3*, const char*);
38364adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
3837*c3dcdba3Sdrh int sqlite3ErrorToParser(sqlite3*,int);
3838244b9d6eSdrh void sqlite3Dequote(char*);
383951d35b0fSdrh void sqlite3DequoteExpr(Expr*);
384040aced5cSdrh void sqlite3TokenInit(Token*,char*);
38412646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
38424adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
384380242055Sdrh void sqlite3FinishCoding(Parse*);
3844892d3179Sdrh int sqlite3GetTempReg(Parse*);
3845892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
3846892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
3847892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
3848cdc69557Sdrh void sqlite3ClearTempRegCache(Parse*);
3849bb9b5f26Sdrh #ifdef SQLITE_DEBUG
3850bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse*,int,int);
3851bb9b5f26Sdrh #endif
3852b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
3853b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*);
3854b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
3855abfd35eaSdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*);
385608de4f79Sdrh void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
38571e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
3858954733b3Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*, int);
3859de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32);
3860633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
3861b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
3862a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*);
3863bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList*,int);
3864b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
38651be266baSdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*);
3866633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
38672308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList*);
38688d40673cSdrh int sqlite3IndexHasDuplicateRootPage(Index*);
38699bb575fdSdrh int sqlite3Init(sqlite3*, char**);
3870234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
3871987db767Sdan int sqlite3InitOne(sqlite3*, int, char**, u32);
387291cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
38732fcc1590Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
38742fcc1590Sdrh Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName);
38752fcc1590Sdrh #endif
387681028a45Sdrh void sqlite3ResetAllSchemasOfConnection(sqlite3*);
387781028a45Sdrh void sqlite3ResetOneSchema(sqlite3*,int);
387881028a45Sdrh void sqlite3CollapseDatabaseArray(sqlite3*);
38799bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
388051be3873Sdrh void sqlite3DeleteColumnNames(sqlite3*,Table*);
38818981b904Sdrh int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
3882ed06a131Sdrh void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*);
38837d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
3884c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
38854415628aSdrh Index *sqlite3PrimaryKeyIndex(Table*);
38864415628aSdrh i16 sqlite3ColumnOfIndex(Index*, i16);
3887f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
3888e6110505Sdrh #if SQLITE_ENABLE_HIDDEN_COLUMNS
3889ba68f8f3Sdan   void sqlite3ColumnPropertiesFromName(Table*, Column*);
3890e6110505Sdrh #else
3891e6110505Sdrh # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
3892e6110505Sdrh #endif
38932881ab62Sdrh void sqlite3AddColumn(Parse*,Token*,Token*);
38944adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
3895fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
3896ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
38971be266baSdrh void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*);
389839002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
38995969da4aSdrh void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
3900522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*,
3901522c26fbSdrh                     sqlite3_vfs**,char**,char **);
3902e5989723Sdrh #ifdef SQLITE_HAS_CODEC
3903e5989723Sdrh   int sqlite3CodecQueryParameters(sqlite3*,const char*,const char*);
3904e5989723Sdrh #else
3905e5989723Sdrh # define sqlite3CodecQueryParameters(A,B,C) 0
3906e5989723Sdrh #endif
3907421377e6Sdrh Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
3908b7f9164eSdrh 
3909d12602a9Sdrh #ifdef SQLITE_UNTESTABLE
3910c007f61bSdrh # define sqlite3FaultSim(X) SQLITE_OK
3911c007f61bSdrh #else
3912c007f61bSdrh   int sqlite3FaultSim(int);
3913c007f61bSdrh #endif
3914c007f61bSdrh 
3915f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
3916f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
391782ef8775Sdrh int sqlite3BitvecTestNotNull(Bitvec*, u32);
3918f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
3919e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*);
3920f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
3921bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*);
3922d12602a9Sdrh #ifndef SQLITE_UNTESTABLE
39233088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
3924f5ed7ad6Sdrh #endif
3925f5e7bb51Sdrh 
39269d67afc4Sdrh RowSet *sqlite3RowSetInit(sqlite3*);
39279d67afc4Sdrh void sqlite3RowSetDelete(void*);
39289d67afc4Sdrh void sqlite3RowSetClear(void*);
39293d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64);
3930d83cad23Sdrh int sqlite3RowSetTest(RowSet*, int iBatch, i64);
39313d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*);
39323d4501e5Sdrh 
39338981b904Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
3934fe3fcbe2Sdanielk1977 
3935fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
39364adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
3937b7f9164eSdrh #else
3938b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
3939b7f9164eSdrh #endif
3940b7f9164eSdrh 
3941a7ab6d81Sdrh #if SQLITE_MAX_ATTACHED>30
3942a7ab6d81Sdrh   int sqlite3DbMaskAllZero(yDbMask);
3943a7ab6d81Sdrh #endif
3944a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
3945faacf17cSdrh void sqlite3CodeDropTable(Parse*, Table*, int, int);
39461feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*);
3947cf8f2895Sdan void sqlite3FreeIndex(sqlite3*, Index*);
39480b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT
39490b9f50d8Sdrh   void sqlite3AutoincrementBegin(Parse *pParse);
39500b9f50d8Sdrh   void sqlite3AutoincrementEnd(Parse *pParse);
39510b9f50d8Sdrh #else
39520b9f50d8Sdrh # define sqlite3AutoincrementBegin(X)
39530b9f50d8Sdrh # define sqlite3AutoincrementEnd(X)
39540b9f50d8Sdrh #endif
395546d2e5c3Sdrh void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int, Upsert*);
39566c535158Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
39575496d6a2Sdan IdList *sqlite3IdListAppend(Parse*, IdList*, Token*);
39584adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
395929c992cbSdrh SrcList *sqlite3SrcListEnlarge(Parse*, SrcList*, int, int);
396029c992cbSdrh SrcList *sqlite3SrcListAppend(Parse*, SrcList*, Token*, Token*);
3961b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
396285574e31Sdanielk1977                                       Token*, Select*, Expr*, IdList*);
3963b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
396401d230ceSdrh void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
3965b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
396661dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
39674adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
3968633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
3969633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
3970bbbdc83bSdrh Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
397162340f84Sdrh void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
397262340f84Sdrh                           Expr*, int, int, u8);
39734d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
39747d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
397517435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
39768c0833fbSdrh                          Expr*,ExprList*,u32,Expr*);
3977633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
39784adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
39794adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
3980c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
3981273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
39828c0833fbSdrh Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*);
39834281bd42Sshane #endif
39848c0833fbSdrh void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*);
3985eac9fabbSdrh void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*,
3986eac9fabbSdrh                    Upsert*);
398746ec5b63Sdrh WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
39884adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
3989c3489bbfSdrh LogEst sqlite3WhereOutputRowCount(WhereInfo*);
39906f32848dSdrh int sqlite3WhereIsDistinct(WhereInfo*);
39916f32848dSdrh int sqlite3WhereIsOrdered(WhereInfo*);
39926ee5a7b4Sdrh int sqlite3WhereOrderByLimitOptLabel(WhereInfo*);
3993374cd78cSdan int sqlite3WhereIsSorted(WhereInfo*);
39946f32848dSdrh int sqlite3WhereContinueLabel(WhereInfo*);
39956f32848dSdrh int sqlite3WhereBreakLabel(WhereInfo*);
3996fc8d4f96Sdrh int sqlite3WhereOkOnePass(WhereInfo*, int*);
3997b0264eecSdrh #define ONEPASS_OFF      0        /* Use of ONEPASS not allowed */
3998b0264eecSdrh #define ONEPASS_SINGLE   1        /* ONEPASS valid for a single row update */
3999b0264eecSdrh #define ONEPASS_MULTI    2        /* ONEPASS is valid for multiple rows */
40001f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
4001a748fdccSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
40025c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
4003b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
400405a86c5cSdrh void sqlite3ExprCode(Parse*, Expr*, int);
40051c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse*, Expr*, int);
400605a86c5cSdrh void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
4007ad879ffdSdrh int sqlite3ExprCodeAtInit(Parse*, Expr*, int);
40082dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
4009678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
401005a86c5cSdrh void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
40115579d59fSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
4012d1a01edaSdrh #define SQLITE_ECEL_DUP      0x01  /* Deep, not shallow copies */
4013d1a01edaSdrh #define SQLITE_ECEL_FACTOR   0x02  /* Factor out constant terms */
40145579d59fSdrh #define SQLITE_ECEL_REF      0x04  /* Use ExprList.u.x.iOrderByCol */
4015257c13faSdan #define SQLITE_ECEL_OMITREF  0x08  /* Omit if ExprList.u.x.iOrderByCol */
40164adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
40174adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
401872bc8208Sdrh void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
40199bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
40204d249e61Sdrh #define LOCATE_VIEW    0x01
40214d249e61Sdrh #define LOCATE_NOERR   0x02
40224d249e61Sdrh Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*);
40234d249e61Sdrh Table *sqlite3LocateTableItem(Parse*,u32 flags,struct SrcList_item *);
40249bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
40259bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
40269bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
40272f6239edSdrh void sqlite3Vacuum(Parse*,Token*,Expr*);
40282f6239edSdrh int sqlite3RunVacuum(char**, sqlite3*, int, sqlite3_value*);
402917435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
40305aa550cfSdan int sqlite3ExprCompare(Parse*,Expr*, Expr*, int);
4031f9463dfbSdrh int sqlite3ExprCompareSkip(Expr*, Expr*, int);
4032619a1305Sdrh int sqlite3ExprListCompare(ExprList*, ExprList*, int);
40335aa550cfSdan int sqlite3ExprImpliesExpr(Parse*,Expr*, Expr*, int);
40342589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr*,int);
4035d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
4036d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
40372409f8a1Sdrh int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx);
4038030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
40394adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
4040d12602a9Sdrh #ifndef SQLITE_UNTESTABLE
40412fa1868fSdrh void sqlite3PrngSaveState(void);
40422fa1868fSdrh void sqlite3PrngRestoreState(void);
4043f5ed7ad6Sdrh #endif
40440f198a74Sdrh void sqlite3RollbackAll(sqlite3*,int);
40454adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
404657966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
4047684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
404807a3b11aSdrh void sqlite3EndTransaction(Parse*,int);
4049fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*);
4050fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *);
40514245c405Sdrh void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
4052171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr*);
405396acafbeSdrh int sqlite3ExprTruthValue(const Expr*);
40544adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
40550a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
4056feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr*, u8);
4057ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*);
4058059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr*,int);
4059ffc648cfSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
40605b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr*);
4061ffc648cfSdrh #endif
40624adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
4063039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*);
4064039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
40654adee20fSdanielk1977 int sqlite3IsRowid(const char*);
4066f0ee1d3cSdan void sqlite3GenerateRowDelete(
4067f0ee1d3cSdan     Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
4068f0ee1d3cSdan void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
40691c2c0b77Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
407087744513Sdrh void sqlite3ResolvePartIdxLabel(Parse*,int);
4071e9816d82Sdrh int sqlite3ExprReferencesUpdatedColumn(Expr*,int*,int);
4072f8ffb278Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
4073788d55aaSdrh                                      u8,u8,int,int*,int*,Upsert*);
4074d447dcedSdrh #ifdef SQLITE_ENABLE_NULL_TRIM
4075585ce192Sdrh   void sqlite3SetMakeRecordP5(Vdbe*,Table*);
4076d447dcedSdrh #else
4077d447dcedSdrh # define sqlite3SetMakeRecordP5(A,B)
4078d447dcedSdrh #endif
407926198bb4Sdrh void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
4080fd261ec6Sdan int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
40814adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
4082ff738bceSdrh void sqlite3MultiWrite(Parse*);
4083e0af83acSdan void sqlite3MayAbort(Parse*);
4084f9c8ce3cSdrh void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
4085f9c8ce3cSdrh void sqlite3UniqueConstraint(Parse*, int, Index*);
4086f9c8ce3cSdrh void sqlite3RowidConstraint(Parse*, int, Table*);
40876ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
40886ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
40896ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
409017435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
40916ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int);
409219efd0dbSdrh FuncDef *sqlite3FunctionSearch(int,const char*);
409380738d9cSdrh void sqlite3InsertBuiltinFuncs(FuncDef*,int);
409480738d9cSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
409580738d9cSdrh void sqlite3RegisterBuiltinFunctions(void);
4096777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
409780738d9cSdrh void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
40987e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
40997e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
41009cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
4101fa4e62f3Sshane 
4102fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
41038c0833fbSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int);
4104fa4e62f3Sshane #endif
4105b7f9164eSdrh 
4106b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
4107ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
410860218d2aSdrh                            Expr*,int, int);
41094adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
4110fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
411174161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
41122f886d1dSdanielk1977   Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
41132f886d1dSdanielk1977   Trigger *sqlite3TriggerList(Parse *, Table *);
4114165921a7Sdan   void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
411594d7f50aSdan                             int, int, int);
41161da40a38Sdan   void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
4117dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
4118633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
4119f259df5fSdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*,
4120f259df5fSdrh                                         const char*,const char*);
41215be60c55Sdan   TriggerStep *sqlite3TriggerInsertStep(Parse*,Token*, IdList*,
412246d2e5c3Sdrh                                         Select*,u8,Upsert*,
41232c2e844aSdrh                                         const char*,const char*);
41245be60c55Sdan   TriggerStep *sqlite3TriggerUpdateStep(Parse*,Token*,ExprList*, Expr*, u8,
4125f259df5fSdrh                                         const char*,const char*);
41265be60c55Sdan   TriggerStep *sqlite3TriggerDeleteStep(Parse*,Token*, Expr*,
4127f259df5fSdrh                                         const char*,const char*);
4128633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
4129b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
4130bb5f168fSdan   u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
413165a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
4132c149f18fSdrh # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
4133b7f9164eSdrh #else
413462c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0
4135633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
4136cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
4137b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
413894d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
413975cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
41402943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0
414165a7cd16Sdan # define sqlite3ParseToplevel(p) p
4142c149f18fSdrh # define sqlite3IsToplevel(p) 1
4143bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
4144b7f9164eSdrh #endif
4145b7f9164eSdrh 
41464adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
41470202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
41484adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
4149ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
4150728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
41514adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
41524adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
41534adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
415402470b20Sdan   int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
4155ed6c8671Sdrh #else
4156b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
41574adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
41584adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
41594adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
4160ed6c8671Sdrh #endif
4161f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
4162f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
4163d100f691Sdrh void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
41644adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
41654adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
41664adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
41674adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
41684adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
41699339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8);
4170fec19aadSdrh int sqlite3GetInt32(const char *, int*);
417160ac3f42Sdrh int sqlite3Atoi(const char*);
4172f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16
4173ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
4174f0f44b79Sdrh #endif
4175ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
417642610961Sdrh u32 sqlite3Utf8Read(const u8**);
4177bf539c4dSdrh LogEst sqlite3LogEst(u64);
4178bf539c4dSdrh LogEst sqlite3LogEstAdd(LogEst,LogEst);
4179bf539c4dSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4180bf539c4dSdrh LogEst sqlite3LogEstFromDouble(double);
4181bf539c4dSdrh #endif
418214bfd991Sdrh #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
4183d566c951Sdrh     defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
4184d566c951Sdrh     defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
4185bf539c4dSdrh u64 sqlite3LogEstToInt(LogEst);
4186d566c951Sdrh #endif
41879bf755ccSdrh VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int);
41889bf755ccSdrh const char *sqlite3VListNumToName(VList*,int);
41899bf755ccSdrh int sqlite3VListNameToNum(VList*,const char*,int);
41903f8d5cfcSshane 
41913f8d5cfcSshane /*
41923f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
41933f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
41942f2b2b85Sdrh ** file.
41953f8d5cfcSshane */
4196192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
41971bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *);
41981bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *);
4199192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
42003f8d5cfcSshane 
42013f8d5cfcSshane /*
42022f2b2b85Sdrh ** The common case is for a varint to be a single byte.  They following
42032f2b2b85Sdrh ** macros handle the common case without a procedure call, but then call
42042f2b2b85Sdrh ** the procedure for larger varints.
42053f8d5cfcSshane */
42064bde3702Sdrh #define getVarint32(A,B)  \
42074bde3702Sdrh   (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
42084bde3702Sdrh #define putVarint32(A,B)  \
42094bde3702Sdrh   (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
42102f2b2b85Sdrh   sqlite3PutVarint((A),(B)))
42113f8d5cfcSshane #define getVarint    sqlite3GetVarint
42123f8d5cfcSshane #define putVarint    sqlite3PutVarint
42133f8d5cfcSshane 
42143f8d5cfcSshane 
4215e9107698Sdrh const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
421657bf4a8eSdrh void sqlite3TableAffinity(Vdbe*, Table*, int);
4217e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
4218e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
42190dfa4f6fSdrh char sqlite3TableColumnAffinity(Table*,int);
4220bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
42219339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8);
42229296c18aSdrh int sqlite3DecOrHexToI64(const char*, i64*);
422313f40da3Sdrh void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
422413f40da3Sdrh void sqlite3Error(sqlite3*,int);
42251b9f2141Sdrh void sqlite3SystemError(sqlite3*,int);
4226ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
4227cd74b611Sdan u8 sqlite3HexToInt(int h);
4228ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
4229dd08ca0fSmistachkin 
42305824d44bSmistachkin #if defined(SQLITE_NEED_ERR_NAME)
4231f2c1c99fSmistachkin const char *sqlite3ErrName(int);
4232dd08ca0fSmistachkin #endif
4233dd08ca0fSmistachkin 
42349c6396ecSdrh #ifdef SQLITE_ENABLE_DESERIALIZE
4235ac442f41Sdrh int sqlite3MemdbInit(void);
4236ac442f41Sdrh #endif
4237ac442f41Sdrh 
4238f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
42398a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
4240c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
4241efad2e23Sdrh int sqlite3IsBinary(const CollSeq*);
4242c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
42437cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
424470efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr);
424570efa84dSdrh int sqlite3ExprCollSeqMatch(Parse*,Expr*,Expr*);
424680103fc6Sdan Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
42470a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
42480a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr*);
42497cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
42500f1c2eb5Sdrh int sqlite3WritableSchema(sqlite3*);
4251d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
4252b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
4253158b9cb9Sdrh int sqlite3AddInt64(i64*,i64);
4254158b9cb9Sdrh int sqlite3SubInt64(i64*,i64);
4255158b9cb9Sdrh int sqlite3MulInt64(i64*,i64);
4256d50ffc41Sdrh int sqlite3AbsInt32(int);
425781cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES
425881cc5163Sdrh void sqlite3FileSuffix3(const char*, char*);
425981cc5163Sdrh #else
426081cc5163Sdrh # define sqlite3FileSuffix3(X,Y)
426181cc5163Sdrh #endif
4262eac5bd78Sdrh u8 sqlite3GetBoolean(const char *z,u8);
42634e6af134Sdanielk1977 
4264b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
4265b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
4266b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
42671e536953Sdanielk1977                         void(*)(void*));
4268a3cc007dSdrh void sqlite3ValueSetNull(sqlite3_value*);
42694e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
42701e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
4271f0f44b79Sdrh #ifndef SQLITE_OMIT_UTF16
4272b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
4273f0f44b79Sdrh #endif
42741e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
4275b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
427646c99e0fSdrh #ifndef SQLITE_AMALGAMATION
4277a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[];
4278f19aa5faSdrh extern const char sqlite3StrBINARY[];
42794e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
428078ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[];
4281094430ebSdrh extern const Token sqlite3IntTokens[];
4282075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
428380738d9cSdrh extern FuncDefHash sqlite3BuiltinFunctions;
4284f83dc1efSdrh #ifndef SQLITE_OMIT_WSD
4285ddb68e17Sdrh extern int sqlite3PendingByte;
428646c99e0fSdrh #endif
4287f83dc1efSdrh #endif
428835043cc3Sdrh #ifdef VDBE_PROFILE
428935043cc3Sdrh extern sqlite3_uint64 sqlite3NProfileCnt;
429035043cc3Sdrh #endif
4291cdf011dcSdrh void sqlite3RootPageMoved(sqlite3*, int, int, int);
42924343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
4293545f587fSdrh void sqlite3AlterFunctions(void);
42949fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
4295cf8f2895Sdan void sqlite3AlterRenameColumn(Parse*, SrcList*, Token*, Token*);
42969fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
42972958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
4298ba968dbfSdrh void sqlite3ExpirePreparedStatements(sqlite3*, int);
429950ef6716Sdrh void sqlite3CodeRhsOfIN(Parse*, Expr*, int);
430085bcdce2Sdrh int sqlite3CodeSubselect(Parse*, Expr*);
43017d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
4302923cadb1Sdan void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
43033e3f1a5bSdrh int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
43047d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
430501d230ceSdrh int sqlite3ResolveExprListNames(NameContext*, ExprList*);
43067d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
4307ee751fabSdrh int sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
43087d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
4309c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
431019a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
431119a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
431207e95233Sdan void *sqlite3RenameTokenMap(Parse*, void*, Token*);
431307e95233Sdan void sqlite3RenameTokenRemap(Parse*, void *pTo, void *pFrom);
43148900a48bSdan void sqlite3RenameExprUnmap(Parse*, Expr*);
4315e8ab40d2Sdan void sqlite3RenameExprlistUnmap(Parse*, ExprList*);
431679e72a50Sdrh CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
43172e3a5a81Sdan char sqlite3AffinityType(const char*, Column*);
43189f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
4319f0119b2eSdrh int sqlite3InvokeBusyHandler(BusyHandler*, sqlite3_file*);
4320ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
43210410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *);
4322cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
4323d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*);
432451147baaSdrh void sqlite3DefaultRowEst(Index*);
432555ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
4326d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
4327b6ee6607Sdrh void sqlite3SchemaClear(void *);
43281e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
4329e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
4330ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
43312ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo*);
43322ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
43332ec2fb22Sdrh KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
4334f9eae18bSdan KeyInfo *sqlite3KeyInfoFromExprList(Parse*, ExprList*, int, int);
4335f9eae18bSdan 
43362ec2fb22Sdrh #ifdef SQLITE_DEBUG
43372ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo*);
43382ec2fb22Sdrh #endif
4339771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
4340771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
4341660af939Sdan   void (*)(sqlite3_context*,int,sqlite3_value **),
4342660af939Sdan   void (*)(sqlite3_context*),
4343660af939Sdan   void (*)(sqlite3_context*),
4344660af939Sdan   void (*)(sqlite3_context*,int,sqlite3_value **),
4345d2199f0fSdan   FuncDestructor *pDestructor
4346d2199f0fSdan );
434792011847Sdrh void sqlite3NoopDestructor(void*);
43484a642b60Sdrh void sqlite3OomFault(sqlite3*);
43494a642b60Sdrh void sqlite3OomClear(sqlite3*);
435054f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
4351ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
435269dab1d3Sdrh 
4353c0490572Sdrh void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
4354ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
43551013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
4356f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
43571e536953Sdanielk1977 
43580410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *);
43590410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
43600410302eSdanielk1977 
4361f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4362f9b2e05cSdan int sqlite3ExprCheckIN(Parse*, Expr*);
4363f9b2e05cSdan #else
4364f9b2e05cSdan # define sqlite3ExprCheckIN(x,y) SQLITE_OK
4365f9b2e05cSdan #endif
4366f9b2e05cSdan 
43671435a9a1Sdrh #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
43689fecc546Sdrh void sqlite3AnalyzeFunctions(void);
4369d66e5794Sdan int sqlite3Stat4ProbeSetValue(
4370d66e5794Sdan     Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*);
4371b0b8290eSdan int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
43727a419235Sdan void sqlite3Stat4ProbeFree(UnpackedRecord*);
4373b0b8290eSdan int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
4374d66e5794Sdan char sqlite3IndexColumnAffinity(sqlite3*, Index*, int);
43759fecc546Sdrh #endif
43767a419235Sdan 
437795bdbbbdSdrh /*
437895bdbbbdSdrh ** The interface to the LEMON-generated parser
437995bdbbbdSdrh */
4380d26cc541Sdrh #ifndef SQLITE_AMALGAMATION
4381fb32c44eSdrh   void *sqlite3ParserAlloc(void*(*)(u64), Parse*);
438295bdbbbdSdrh   void sqlite3ParserFree(void*, void(*)(void*));
4383d26cc541Sdrh #endif
4384fb32c44eSdrh void sqlite3Parser(void*, int, Token);
438559ff4251Sdan int sqlite3ParserFallback(int);
4386ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
4387ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
4388ec424a5bSdrh #endif
438995bdbbbdSdrh 
43907aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*);
439169dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
4392f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
439369dab1d3Sdrh #else
439469dab1d3Sdrh # define sqlite3CloseExtensions(X)
439569dab1d3Sdrh #endif
4396e3026636Sdanielk1977 
4397c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
4398c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
4399c00da105Sdanielk1977 #else
4400c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
4401c00da105Sdanielk1977 #endif
4402c00da105Sdanielk1977 
440353c14021Sdrh #ifdef SQLITE_TEST
440453c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
440553c14021Sdrh #endif
440653c14021Sdrh 
4407b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
4408595a523aSdanielk1977 #  define sqlite3VtabClear(Y)
44099dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
4410f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
4411f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
4412093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) 0
4413595a523aSdanielk1977 #  define sqlite3VtabLock(X)
4414595a523aSdanielk1977 #  define sqlite3VtabUnlock(X)
4415595a523aSdanielk1977 #  define sqlite3VtabUnlockList(X)
4416a311b803Sdan #  define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
4417c3c8dac7Sdrh #  define sqlite3GetVTable(X,Y)  ((VTable*)0)
4418b9bb7c18Sdrh #else
44191feeaed2Sdan    void sqlite3VtabClear(sqlite3 *db, Table*);
4420bba02a95Sdan    void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
4421016f7811Sdan    int sqlite3VtabSync(sqlite3 *db, Vdbe*);
4422f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
4423f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
4424595a523aSdanielk1977    void sqlite3VtabLock(VTable *);
4425595a523aSdanielk1977    void sqlite3VtabUnlock(VTable *);
4426595a523aSdanielk1977    void sqlite3VtabUnlockList(sqlite3*);
4427a311b803Sdan    int sqlite3VtabSavepoint(sqlite3 *, int, int);
4428016f7811Sdan    void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
4429c3c8dac7Sdrh    VTable *sqlite3GetVTable(sqlite3*, Table*);
44302fcc1590Sdrh    Module *sqlite3VtabCreateModule(
44312fcc1590Sdrh      sqlite3*,
44322fcc1590Sdrh      const char*,
44332fcc1590Sdrh      const sqlite3_module*,
44342fcc1590Sdrh      void*,
44352fcc1590Sdrh      void(*)(void*)
44362fcc1590Sdrh    );
4437093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
4438b9bb7c18Sdrh #endif
443951be3873Sdrh int sqlite3VtabEponymousTableInit(Parse*,Module*);
444051be3873Sdrh void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
44414f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
4442b421b894Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
4443b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
4444b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
4445b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
444678efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
44477e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
44489e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
4449595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *);
44501e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
445195a7b3e3Sdrh sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
44525f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
44534a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
4454f30a969bSdrh void sqlite3ParserReset(Parse*);
44558bee11a4Smistachkin #ifdef SQLITE_ENABLE_NORMALIZE
44561a6c2b1dSdrh char *sqlite3Normalize(Vdbe*, const char*);
44578bee11a4Smistachkin #endif
4458b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
4459b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
4460bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
44611c514148Sdrh int sqlite3TempInMemory(const sqlite3*);
446228e5386fSdan const char *sqlite3JournalModename(int);
446306a2d825Sdan #ifndef SQLITE_OMIT_WAL
4464cdc1f049Sdan   int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
4465b033d8b9Sdrh   int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
446606a2d825Sdan #endif
44678b471863Sdrh #ifndef SQLITE_OMIT_CTE
44684e9119d9Sdan   With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
44697d562dbeSdan   void sqlite3WithDelete(sqlite3*,With*);
4470b290f117Sdan   void sqlite3WithPush(Parse*, With*, u8);
44714e9119d9Sdan #else
4472b290f117Sdan #define sqlite3WithPush(x,y,z)
4473eede6a53Sdan #define sqlite3WithDelete(x,y)
44748b471863Sdrh #endif
447546d2e5c3Sdrh #ifndef SQLITE_OMIT_UPSERT
4476e9c2e772Sdrh   Upsert *sqlite3UpsertNew(sqlite3*,ExprList*,Expr*,ExprList*,Expr*);
447746d2e5c3Sdrh   void sqlite3UpsertDelete(sqlite3*,Upsert*);
447846d2e5c3Sdrh   Upsert *sqlite3UpsertDup(sqlite3*,Upsert*);
4479e9c2e772Sdrh   int sqlite3UpsertAnalyzeTarget(Parse*,SrcList*,Upsert*);
44802cc00423Sdan   void sqlite3UpsertDoUpdate(Parse*,Upsert*,Table*,Index*,int);
448146d2e5c3Sdrh #else
44825412eb51Sdrh #define sqlite3UpsertNew(v,w,x,y,z) ((Upsert*)0)
448346d2e5c3Sdrh #define sqlite3UpsertDelete(x,y)
448446d2e5c3Sdrh #define sqlite3UpsertDup(x,y)       ((Upsert*)0)
448546d2e5c3Sdrh #endif
448646d2e5c3Sdrh 
4487d829335eSdanielk1977 
448875cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by
448975cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
449075cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but
449175cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
449275cbd984Sdan ** this case foreign keys are parsed, but no other functionality is
449375cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system).
449475cbd984Sdan */
449575cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
44968ff2d956Sdan   void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
4497d66c8309Sdan   void sqlite3FkDropTable(Parse*, SrcList *, Table*);
44988ff2d956Sdan   void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
4499e7a94d81Sdan   int sqlite3FkRequired(Parse*, Table*, int*, int);
4500e7a94d81Sdan   u32 sqlite3FkOldmask(Parse*, Table*);
4501432cc5b9Sdan   FKey *sqlite3FkReferences(Table *);
45021da40a38Sdan #else
45038ff2d956Sdan   #define sqlite3FkActions(a,b,c,d,e,f)
450467896cefSdan   #define sqlite3FkCheck(a,b,c,d,e,f)
4505d66c8309Sdan   #define sqlite3FkDropTable(a,b,c)
4506e7a94d81Sdan   #define sqlite3FkOldmask(a,b)         0
450767896cefSdan   #define sqlite3FkRequired(a,b,c,d)    0
4508e7eeeb99Sdan   #define sqlite3FkReferences(a)        0
45091da40a38Sdan #endif
451075cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY
45111feeaed2Sdan   void sqlite3FkDelete(sqlite3 *, Table*);
45126c5b915fSdrh   int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
451375cbd984Sdan #else
45141feeaed2Sdan   #define sqlite3FkDelete(a,b)
45156c5b915fSdrh   #define sqlite3FkLocateIndex(a,b,c,d,e)
451675cbd984Sdan #endif
451775cbd984Sdan 
4518643167ffSdrh 
4519643167ffSdrh /*
4520643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
4521643167ffSdrh */
4522643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
45237e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
4524643167ffSdrh 
4525643167ffSdrh /*
4526ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
4527d12602a9Sdrh ** malloc failures. This is only present if SQLITE_UNTESTABLE
4528ef05f2dfSdanielk1977 ** is not defined.
4529643167ffSdrh */
4530d12602a9Sdrh #ifndef SQLITE_UNTESTABLE
45312d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
45322d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
4533643167ffSdrh #else
45342d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
4535867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
4536643167ffSdrh #endif
4537643167ffSdrh 
45383a85625dSdrh /*
45393a85625dSdrh ** Allowed return values from sqlite3FindInIndex()
45403a85625dSdrh */
45413a85625dSdrh #define IN_INDEX_ROWID        1   /* Search the rowid of the table */
45423a85625dSdrh #define IN_INDEX_EPH          2   /* Search an ephemeral b-tree */
45433a85625dSdrh #define IN_INDEX_INDEX_ASC    3   /* Existing index ASCENDING */
45443a85625dSdrh #define IN_INDEX_INDEX_DESC   4   /* Existing index DESCENDING */
4545bb53ecb1Sdrh #define IN_INDEX_NOOP         5   /* No table available. Use comparisons */
45463a85625dSdrh /*
45473a85625dSdrh ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
45483a85625dSdrh */
4549bb53ecb1Sdrh #define IN_INDEX_NOOP_OK     0x0001  /* OK to return IN_INDEX_NOOP */
4550bb53ecb1Sdrh #define IN_INDEX_MEMBERSHIP  0x0002  /* IN operator used for membership test */
4551bb53ecb1Sdrh #define IN_INDEX_LOOP        0x0004  /* IN operator used as a loop */
45522c04131cSdrh int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*, int*);
45539a96b668Sdanielk1977 
4554c7b6017cSdanielk1977 int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
4555c7b6017cSdanielk1977 int sqlite3JournalSize(sqlite3_vfs *);
4556d67a9770Sdan #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
4557d67a9770Sdan  || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
4558f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
4559c7b6017cSdanielk1977 #endif
4560c7b6017cSdanielk1977 
45612491de28Sdan int sqlite3JournalIsInMemory(sqlite3_file *p);
4562b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *);
4563b3175389Sdanielk1977 
45642308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
45650224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
4566fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
45677d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
4568fc976065Sdanielk1977 #else
45690224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
45707d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
4571fc976065Sdanielk1977 #endif
4572fc976065Sdanielk1977 
4573a3152895Sdrh u32 sqlite3Get4byte(const u8*);
4574a3152895Sdrh void sqlite3Put4byte(u8*, u32);
4575a3152895Sdrh 
4576404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
4577404ca075Sdanielk1977   void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
4578404ca075Sdanielk1977   void sqlite3ConnectionUnlocked(sqlite3 *db);
4579404ca075Sdanielk1977   void sqlite3ConnectionClosed(sqlite3 *db);
4580404ca075Sdanielk1977 #else
4581404ca075Sdanielk1977   #define sqlite3ConnectionBlocked(x,y)
4582404ca075Sdanielk1977   #define sqlite3ConnectionUnlocked(x)
4583404ca075Sdanielk1977   #define sqlite3ConnectionClosed(x)
4584404ca075Sdanielk1977 #endif
4585404ca075Sdanielk1977 
45866e736838Sdrh #ifdef SQLITE_DEBUG
45876e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
45886e736838Sdrh #endif
45890d9de99cSdrh #if defined(YYCOVERAGE)
45900d9de99cSdrh   int sqlite3ParserCoverage(FILE*);
45910d9de99cSdrh #endif
45926e736838Sdrh 
4593b0603416Sdrh /*
4594b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
45953a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
4596b0603416Sdrh ** print I/O tracing messages.
4597b0603416Sdrh */
4598b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
45993a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
4600b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
46019871a933Smistachkin SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
4602b0603416Sdrh #else
4603b0603416Sdrh # define IOTRACE(A)
4604b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
4605b0603416Sdrh #endif
4606b0603416Sdrh 
4607107b56e8Sdrh /*
4608107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator
4609107b56e8Sdrh ** only.  They are used to verify that different "types" of memory
4610107b56e8Sdrh ** allocations are properly tracked by the system.
4611107b56e8Sdrh **
4612107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
4613107b56e8Sdrh ** the MEMTYPE_* macros defined below.  The type must be a bitmask with
4614107b56e8Sdrh ** a single bit set.
4615107b56e8Sdrh **
4616107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second
4617107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
4618107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
4619107b56e8Sdrh **
4620174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second
4621174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
4622107b56e8Sdrh **
4623107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP
4624174b9a16Sdrh ** and MEMTYPE_LOOKASIDE.  If an allocation is MEMTYPE_LOOKASIDE, that means
4625174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was
4626174b9a16Sdrh ** too large or lookaside was already full.  It is important to verify
4627174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not
4628174b9a16Sdrh ** passed back to non-lookaside free() routines.  Asserts such as the
4629174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify
4630174b9a16Sdrh ** this constraint.
4631107b56e8Sdrh **
4632107b56e8Sdrh ** All of this is no-op for a production build.  It only comes into
4633107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used.
4634107b56e8Sdrh */
4635107b56e8Sdrh #ifdef SQLITE_MEMDEBUG
4636107b56e8Sdrh   void sqlite3MemdebugSetType(void*,u8);
4637107b56e8Sdrh   int sqlite3MemdebugHasType(void*,u8);
4638174b9a16Sdrh   int sqlite3MemdebugNoType(void*,u8);
4639107b56e8Sdrh #else
4640107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y)  /* no-op */
4641107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y)  1
4642174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y)   1
4643e3026636Sdanielk1977 #endif
4644107b56e8Sdrh #define MEMTYPE_HEAP       0x01  /* General heap allocations */
4645d231aa3aSdrh #define MEMTYPE_LOOKASIDE  0x02  /* Heap that might have been lookaside */
4646b2a0f75cSdrh #define MEMTYPE_PCACHE     0x04  /* Page cache allocations */
4647107b56e8Sdrh 
4648f51446a3Sdrh /*
4649f51446a3Sdrh ** Threading interface
4650f51446a3Sdrh */
4651bf20a35dSdrh #if SQLITE_MAX_WORKER_THREADS>0
4652f51446a3Sdrh int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
4653f51446a3Sdrh int sqlite3ThreadJoin(SQLiteThread*, void**);
4654bf20a35dSdrh #endif
4655f51446a3Sdrh 
4656a43c8c8aSdrh #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST)
4657a43c8c8aSdrh int sqlite3DbpageRegister(sqlite3*);
4658a43c8c8aSdrh #endif
46593e0327d5Sdrh #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
46603e0327d5Sdrh int sqlite3DbstatRegister(sqlite3*);
46613e0327d5Sdrh #endif
4662107b56e8Sdrh 
466371c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr);
4664625015e0Sdan int sqlite3ExprIsVector(Expr *pExpr);
4665fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr*, int);
4666a1251bc4Sdrh Expr *sqlite3ExprForVectorField(Parse*,Expr*,int);
466744c5604cSdan void sqlite3VectorErrorMsg(Parse*, Expr*);
466871c57db0Sdan 
46698999798eSdrh #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
4670da1f49b8Sdan const char **sqlite3CompileOptions(int *pnOpt);
46718999798eSdrh #endif
4672da1f49b8Sdan 
467343f58d6aSdrh #endif /* SQLITEINT_H */
4674