xref: /sqlite-3.40.0/src/sqliteInt.h (revision 0a32fa6d)
175897234Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
375897234Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
675897234Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
1075897234Sdrh **
1175897234Sdrh *************************************************************************
1275897234Sdrh ** Internal interface definitions for SQLite.
1375897234Sdrh **
1475897234Sdrh */
15e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
16e3026636Sdanielk1977 #define _SQLITEINT_H_
1771674ce9Sdrh 
18bd0ae111Smlcreech /*
192210dcc6Sdrh ** These #defines should enable >2GB file support on POSIX if the
202210dcc6Sdrh ** underlying operating system supports it.  If the OS lacks
212210dcc6Sdrh ** large file support, or if the OS is windows, these should be no-ops.
222210dcc6Sdrh **
232210dcc6Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
242210dcc6Sdrh ** system #includes.  Hence, this block of code must be the very first
252210dcc6Sdrh ** code in all source files.
262210dcc6Sdrh **
272210dcc6Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
282210dcc6Sdrh ** on the compiler command line.  This is necessary if you are compiling
292210dcc6Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
302210dcc6Sdrh ** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
312210dcc6Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
322210dcc6Sdrh ** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
332210dcc6Sdrh ** portability you should omit LFS.
342210dcc6Sdrh **
352210dcc6Sdrh ** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
362210dcc6Sdrh */
372210dcc6Sdrh #ifndef SQLITE_DISABLE_LFS
382210dcc6Sdrh # define _LARGE_FILE       1
392210dcc6Sdrh # ifndef _FILE_OFFSET_BITS
402210dcc6Sdrh #   define _FILE_OFFSET_BITS 64
412210dcc6Sdrh # endif
422210dcc6Sdrh # define _LARGEFILE_SOURCE 1
432210dcc6Sdrh #endif
442210dcc6Sdrh 
452210dcc6Sdrh /*
461e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
471e12d43bSmlcreech ** autoconf-based build
48bd0ae111Smlcreech */
491e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H
5098dc4b1aSmlcreech #include "config.h"
511e12d43bSmlcreech #endif
521e12d43bSmlcreech 
53bb4957f8Sdrh #include "sqliteLimit.h"
5498dc4b1aSmlcreech 
55e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
56e2965827Sdrh #if defined(__BORLANDC__)
57e2965827Sdrh #pragma warn -rch /* unreachable code */
58e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
59e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
60e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
61467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */
62e2965827Sdrh #endif
63e2965827Sdrh 
6498dc4b1aSmlcreech /* Needed for various definitions... */
6560323418Sdrh #ifndef _GNU_SOURCE
6698dc4b1aSmlcreech # define _GNU_SOURCE
6760323418Sdrh #endif
6898dc4b1aSmlcreech 
6998dc4b1aSmlcreech /*
7006af763eSdrh ** Include standard header files as necessary
7106af763eSdrh */
7206af763eSdrh #ifdef HAVE_STDINT_H
7306af763eSdrh #include <stdint.h>
7406af763eSdrh #endif
7506af763eSdrh #ifdef HAVE_INTTYPES_H
7606af763eSdrh #include <inttypes.h>
7706af763eSdrh #endif
7806af763eSdrh 
79a2460e07Sdrh /*
80a2460e07Sdrh ** The number of samples of an index that SQLite takes in order to
81a2460e07Sdrh ** construct a histogram of the table content when running ANALYZE
82a2460e07Sdrh ** and with SQLITE_ENABLE_STAT2
83a2460e07Sdrh */
8402fa4696Sdan #define SQLITE_INDEX_SAMPLES 10
8502fa4696Sdan 
8606af763eSdrh /*
87c05a9a8aSdrh ** The following macros are used to cast pointers to integers and
88c05a9a8aSdrh ** integers to pointers.  The way you do this varies from one compiler
89c05a9a8aSdrh ** to the next, so we have developed the following set of #if statements
90c05a9a8aSdrh ** to generate appropriate macros for a wide range of compilers.
91875e9e7dSdrh **
92c05a9a8aSdrh ** The correct "ANSI" way to do this is to use the intptr_t type.
93c05a9a8aSdrh ** Unfortunately, that typedef is not available on all compilers, or
94c05a9a8aSdrh ** if it is available, it requires an #include of specific headers
95c92271c5Sdrh ** that vary from one machine to the next.
96875e9e7dSdrh **
97875e9e7dSdrh ** Ticket #3860:  The llvm-gcc-4.2 compiler from Apple chokes on
98875e9e7dSdrh ** the ((void*)&((char*)0)[X]) construct.  But MSVC chokes on ((void*)(X)).
995e49edcaSdrh ** So we have to define the macros in different ways depending on the
100875e9e7dSdrh ** compiler.
1011fc4129dSshane */
102c05a9a8aSdrh #if defined(__PTRDIFF_TYPE__)  /* This case should work for GCC */
103c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(__PTRDIFF_TYPE__)(X))
104c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(__PTRDIFF_TYPE__)(X))
105c05a9a8aSdrh #elif !defined(__GNUC__)       /* Works for compilers other than LLVM */
106c05a9a8aSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)&((char*)0)[X])
107c05a9a8aSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(((char*)X)-(char*)0))
108c05a9a8aSdrh #elif defined(HAVE_STDINT_H)   /* Use this case if we have ANSI headers */
109367882c2Sdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(intptr_t)(X))
110367882c2Sdrh # define SQLITE_PTR_TO_INT(X)  ((int)(intptr_t)(X))
111c05a9a8aSdrh #else                          /* Generates a warning - but it always works */
112875e9e7dSdrh # define SQLITE_INT_TO_PTR(X)  ((void*)(X))
113875e9e7dSdrh # define SQLITE_PTR_TO_INT(X)  ((int)(X))
114367882c2Sdrh #endif
11571674ce9Sdrh 
116e5e7a901Sdrh /*
11738c67c36Sdrh ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
11838c67c36Sdrh ** 0 means mutexes are permanently disable and the library is never
11938c67c36Sdrh ** threadsafe.  1 means the library is serialized which is the highest
12038c67c36Sdrh ** level of threadsafety.  2 means the libary is multithreaded - multiple
12138c67c36Sdrh ** threads can use SQLite as long as no two threads try to use the same
12238c67c36Sdrh ** database connection at the same time.
12338c67c36Sdrh **
124e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
12538c67c36Sdrh ** We support that for legacy.
126e5e7a901Sdrh */
127e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
128e5e7a901Sdrh #if defined(THREADSAFE)
129e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE
130e5e7a901Sdrh #else
13138c67c36Sdrh # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
132e5e7a901Sdrh #endif
133e5e7a901Sdrh #endif
134e5e7a901Sdrh 
13567080617Sdrh /*
1360a732f59Sdanielk1977 ** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1.
1370a732f59Sdanielk1977 ** It determines whether or not the features related to
138467bcf36Sshane ** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can
1390a732f59Sdanielk1977 ** be overridden at runtime using the sqlite3_config() API.
1400a732f59Sdanielk1977 */
1410a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
1420a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1
1430a732f59Sdanielk1977 #endif
1440a732f59Sdanielk1977 
1450a732f59Sdanielk1977 /*
1460d18020bSdrh ** Exactly one of the following macros must be defined in order to
1470d18020bSdrh ** specify which memory allocation subsystem to use.
1480d18020bSdrh **
1490d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
1500d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
151a2460e07Sdrh **
152a2460e07Sdrh ** (Historical note:  There used to be several other options, but we've
153a2460e07Sdrh ** pared it down to just these two.)
1540d18020bSdrh **
1550d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
1560d18020bSdrh ** the default.
1570d18020bSdrh */
158a2460e07Sdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)>1
1590d18020bSdrh # error "At most one of the following compile-time configuration options\
160a2460e07Sdrh  is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG"
1610d18020bSdrh #endif
162a2460e07Sdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)==0
1630d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
1640d18020bSdrh #endif
1650d18020bSdrh 
1660d18020bSdrh /*
1678a1e594cSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
168eee4c8caSdrh ** sizes of memory allocations below this value where possible.
169eee4c8caSdrh */
1708a1e594cSdrh #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
171eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
172eee4c8caSdrh #endif
173eee4c8caSdrh 
174eee4c8caSdrh /*
17567080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
176467bcf36Sshane ** recursive mutexes on most Unix systems.  But Mac OS X is different.
17767080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
17867080617Sdrh ** so it is omitted there.  See ticket #2673.
179e5e7a901Sdrh **
180e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
181e5e7a901Sdrh ** implemented on some systems.  So we avoid defining it at all
182e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are
183e5e7a901Sdrh ** not doing a threadsafe build.  Ticket #2681.
1849e0ebbfaSdrh **
1859e0ebbfaSdrh ** See also ticket #2741.
18667080617Sdrh */
187ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
188058897a9Sdrh #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
18967080617Sdrh #endif
190e3026636Sdanielk1977 
1917d10d5a6Sdrh /*
1927d10d5a6Sdrh ** The TCL headers are only needed when compiling the TCL bindings.
1937d10d5a6Sdrh */
1944f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
1954f0c5878Sdrh # include <tcl.h>
196824d7c18Sdrh #endif
197824d7c18Sdrh 
198824d7c18Sdrh /*
1994b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
200b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
2014b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
2024b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
2034b529d97Sdrh ** feature.
2044b529d97Sdrh */
205289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
2064b529d97Sdrh # define NDEBUG 1
2074b529d97Sdrh #endif
2084b529d97Sdrh 
2096402250eSdrh /*
21047c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing.  When
21147c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to
21247c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to
21347c3b3e0Sdrh ** get full branch coverage.  The testcase() macro is inserted
21447c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple
21547c3b3e0Sdrh ** condition/decision coverage is inadequate.  For example, testcase()
21647c3b3e0Sdrh ** can be used to make sure boundary values are tested.  For
21747c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit
21847c3b3e0Sdrh ** is significant and used at least once.  On switch statements
21947c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase()
22047c3b3e0Sdrh ** can insure that all cases are evaluated.
22147c3b3e0Sdrh **
22247c3b3e0Sdrh */
22347c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST
22447c3b3e0Sdrh   void sqlite3Coverage(int);
22547c3b3e0Sdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
22647c3b3e0Sdrh #else
22747c3b3e0Sdrh # define testcase(X)
2288f941bc7Sdrh #endif
2298f941bc7Sdrh 
2308f941bc7Sdrh /*
2318f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or
2328f941bc7Sdrh ** other bits of code that are needed to support the arguments
2338f941bc7Sdrh ** within testcase() and assert() macros.
2348f941bc7Sdrh */
2358f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
2368f941bc7Sdrh # define TESTONLY(X)  X
2378f941bc7Sdrh #else
23847c3b3e0Sdrh # define TESTONLY(X)
23947c3b3e0Sdrh #endif
24047c3b3e0Sdrh 
24147c3b3e0Sdrh /*
2426149526cSdrh ** Sometimes we need a small amount of code such as a variable initialization
2436149526cSdrh ** to setup for a later assert() statement.  We do not want this code to
2446149526cSdrh ** appear when assert() is disabled.  The following macro is therefore
2456149526cSdrh ** used to contain that setup code.  The "VVA" acronym stands for
2466149526cSdrh ** "Verification, Validation, and Accreditation".  In other words, the
2476149526cSdrh ** code within VVA_ONLY() will only run during verification processes.
2486149526cSdrh */
2496149526cSdrh #ifndef NDEBUG
2506149526cSdrh # define VVA_ONLY(X)  X
2516149526cSdrh #else
2526149526cSdrh # define VVA_ONLY(X)
2536149526cSdrh #endif
2546149526cSdrh 
2556149526cSdrh /*
25647c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which
25747c3b3e0Sdrh ** are intended to always be true or false, respectively.  Such
25847c3b3e0Sdrh ** expressions could be omitted from the code completely.  But they
25947c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience
26047c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
26147c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first
26247c3b3e0Sdrh ** hint of unplanned behavior.
26347c3b3e0Sdrh **
26447c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code.
26547c3b3e0Sdrh **
26647c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
26747c3b3e0Sdrh ** be true and false so that the unreachable code then specify will
26847c3b3e0Sdrh ** not be counted as untested code.
26947c3b3e0Sdrh */
27047c3b3e0Sdrh #if defined(SQLITE_COVERAGE_TEST)
27147c3b3e0Sdrh # define ALWAYS(X)      (1)
27247c3b3e0Sdrh # define NEVER(X)       (0)
27347c3b3e0Sdrh #elif !defined(NDEBUG)
2742de80f4cSdrh # define ALWAYS(X)      ((X)?1:(assert(0),0))
2752de80f4cSdrh # define NEVER(X)       ((X)?(assert(0),1):0)
27647c3b3e0Sdrh #else
27747c3b3e0Sdrh # define ALWAYS(X)      (X)
27847c3b3e0Sdrh # define NEVER(X)       (X)
27947c3b3e0Sdrh #endif
28047c3b3e0Sdrh 
28147c3b3e0Sdrh /*
2823e8e7ecbSdrh ** Return true (non-zero) if the input is a integer that is too large
2833e8e7ecbSdrh ** to fit in 32-bits.  This macro is used inside of various testcase()
2843e8e7ecbSdrh ** macros to verify that we have tested SQLite for large-file support.
2853e8e7ecbSdrh */
286b31a6afaSdan #define IS_BIG_INT(X)  (((X)&~(i64)0xffffffff)!=0)
2873e8e7ecbSdrh 
2883e8e7ecbSdrh /*
28947c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean
29047c3b3e0Sdrh ** expression that is usually false.  Macro likely() surrounds
29147c3b3e0Sdrh ** a boolean expression that is usually true.  GCC is able to
29247c3b3e0Sdrh ** use these hints to generate better code, sometimes.
29347c3b3e0Sdrh */
29447c3b3e0Sdrh #if defined(__GNUC__) && 0
29547c3b3e0Sdrh # define likely(X)    __builtin_expect((X),1)
29647c3b3e0Sdrh # define unlikely(X)  __builtin_expect((X),0)
29747c3b3e0Sdrh #else
29847c3b3e0Sdrh # define likely(X)    !!(X)
29947c3b3e0Sdrh # define unlikely(X)  !!(X)
30047c3b3e0Sdrh #endif
30147c3b3e0Sdrh 
3021d482dd9Sdrh #include "sqlite3.h"
303beae3194Sdrh #include "hash.h"
30475897234Sdrh #include "parse.h"
30575897234Sdrh #include <stdio.h>
30675897234Sdrh #include <stdlib.h>
30775897234Sdrh #include <string.h>
30875897234Sdrh #include <assert.h>
30952370e2cSdrh #include <stddef.h>
31075897234Sdrh 
311967e8b73Sdrh /*
312b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
313b37df7b9Sdrh ** substitute integer for floating-point
314b37df7b9Sdrh */
315b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
316b37df7b9Sdrh # define double sqlite_int64
3178b307fbfSdrh # define float sqlite_int64
318b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
319d1167393Sdrh # ifndef SQLITE_BIG_DBL
320cdaca55eSdrh #   define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
321d1167393Sdrh # endif
322b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
323b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
324110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
3250b3bf924Sdrh # undef SQLITE_HAVE_ISNAN
326b37df7b9Sdrh #endif
327d1167393Sdrh #ifndef SQLITE_BIG_DBL
328d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
329d1167393Sdrh #endif
330b37df7b9Sdrh 
331b37df7b9Sdrh /*
33253c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
33353c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
33453c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
33553c0f748Sdanielk1977 */
33653c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
33753c0f748Sdanielk1977 #define OMIT_TEMPDB 1
33853c0f748Sdanielk1977 #else
33953c0f748Sdanielk1977 #define OMIT_TEMPDB 0
34053c0f748Sdanielk1977 #endif
34153c0f748Sdanielk1977 
34253c0f748Sdanielk1977 /*
343d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
344d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
345d946db00Sdrh ** the default file format for new databases and the maximum file format
346d946db00Sdrh ** that the library can read.
347d946db00Sdrh */
348d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
349d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
35076fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
351d946db00Sdrh #endif
352d946db00Sdrh 
353a2460e07Sdrh /*
354a2460e07Sdrh ** Determine whether triggers are recursive by default.  This can be
355a2460e07Sdrh ** changed at run-time using a pragma.
356a2460e07Sdrh */
3575bde73c4Sdan #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
3585bde73c4Sdan # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
3595bde73c4Sdan #endif
3605bde73c4Sdan 
361d946db00Sdrh /*
362b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
36349766d6cSdrh ** on the command-line
36449766d6cSdrh */
365b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
366b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
36749766d6cSdrh #endif
36849766d6cSdrh 
36949766d6cSdrh /*
370f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
371f1974846Sdrh ** ourselves.
372f1974846Sdrh */
373f1974846Sdrh #ifndef offsetof
374f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
375f1974846Sdrh #endif
376f1974846Sdrh 
377f1974846Sdrh /*
3789b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
3799b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
3809b8f447bSdrh */
3819b8f447bSdrh #if 'A' == '\301'
3829b8f447bSdrh # define SQLITE_EBCDIC 1
3839b8f447bSdrh #else
3849b8f447bSdrh # define SQLITE_ASCII 1
3859b8f447bSdrh #endif
3869b8f447bSdrh 
3879b8f447bSdrh /*
3885a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
3895a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
3905a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
3915a2c2c20Sdrh **
3925a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
39341a2b48bSdrh */
3945a2c2c20Sdrh #ifndef UINT32_TYPE
395dda5b68cSmlcreech # ifdef HAVE_UINT32_T
396dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
397dda5b68cSmlcreech # else
3985a2c2c20Sdrh #  define UINT32_TYPE unsigned int
3995a2c2c20Sdrh # endif
400dda5b68cSmlcreech #endif
4015a2c2c20Sdrh #ifndef UINT16_TYPE
402dda5b68cSmlcreech # ifdef HAVE_UINT16_T
403dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
404dda5b68cSmlcreech # else
4055a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
4065a2c2c20Sdrh # endif
407dda5b68cSmlcreech #endif
408939a16d6Sdrh #ifndef INT16_TYPE
409dda5b68cSmlcreech # ifdef HAVE_INT16_T
410dda5b68cSmlcreech #  define INT16_TYPE int16_t
411dda5b68cSmlcreech # else
412939a16d6Sdrh #  define INT16_TYPE short int
413939a16d6Sdrh # endif
414dda5b68cSmlcreech #endif
4155a2c2c20Sdrh #ifndef UINT8_TYPE
416dda5b68cSmlcreech # ifdef HAVE_UINT8_T
417dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
418dda5b68cSmlcreech # else
4195a2c2c20Sdrh #  define UINT8_TYPE unsigned char
4205a2c2c20Sdrh # endif
421dda5b68cSmlcreech #endif
422905793e2Sdrh #ifndef INT8_TYPE
423dda5b68cSmlcreech # ifdef HAVE_INT8_T
424dda5b68cSmlcreech #  define INT8_TYPE int8_t
425dda5b68cSmlcreech # else
426905793e2Sdrh #  define INT8_TYPE signed char
427905793e2Sdrh # endif
428dda5b68cSmlcreech #endif
429efad9995Sdrh #ifndef LONGDOUBLE_TYPE
430efad9995Sdrh # define LONGDOUBLE_TYPE long double
431efad9995Sdrh #endif
432efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
43327436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
4345a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
4355a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
436939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
4375a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
43870a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
4395a2c2c20Sdrh 
4405a2c2c20Sdrh /*
44135cd643cSdrh ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
44235cd643cSdrh ** that can be stored in a u32 without loss of data.  The value
44335cd643cSdrh ** is 0x00000000ffffffff.  But because of quirks of some compilers, we
44435cd643cSdrh ** have to specify the value in the less intuitive manner shown:
44535cd643cSdrh */
44635cd643cSdrh #define SQLITE_MAX_U32  ((((u64)1)<<32)-1)
44735cd643cSdrh 
44835cd643cSdrh /*
449bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
450bbd42a6dSdrh ** evaluated at runtime.
451bbd42a6dSdrh */
45246c99e0fSdrh #ifdef SQLITE_AMALGAMATION
453b3190c15Sdrh const int sqlite3one = 1;
45446c99e0fSdrh #else
455bbd42a6dSdrh extern const int sqlite3one;
45646c99e0fSdrh #endif
457189077f3Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)\
458189077f3Sdrh                              || defined(__x86_64) || defined(__x86_64__)
45938def054Sdrh # define SQLITE_BIGENDIAN    0
46038def054Sdrh # define SQLITE_LITTLEENDIAN 1
46138def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
46238def054Sdrh #else
4639c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
4649c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
46538def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
46638def054Sdrh #endif
467bbd42a6dSdrh 
468bbd42a6dSdrh /*
4690f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
4700f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
4710f050353Sdrh ** compilers.
4720f050353Sdrh */
4730f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
4740f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
4750f050353Sdrh 
4760f050353Sdrh /*
477be229650Sdanielk1977 ** Round up a number to the next larger multiple of 8.  This is used
478be229650Sdanielk1977 ** to force 8-byte alignment on 64-bit architectures.
479be229650Sdanielk1977 */
480bc73971dSdanielk1977 #define ROUND8(x)     (((x)+7)&~7)
481bc73971dSdanielk1977 
482bc73971dSdanielk1977 /*
483bc73971dSdanielk1977 ** Round down to the nearest multiple of 8
484bc73971dSdanielk1977 */
485bc73971dSdanielk1977 #define ROUNDDOWN8(x) ((x)&~7)
486be229650Sdanielk1977 
487be229650Sdanielk1977 /*
4888e14c596Sdrh ** Assert that the pointer X is aligned to an 8-byte boundary.  This
4898e14c596Sdrh ** macro is used only within assert() to verify that the code gets
4908e14c596Sdrh ** all alignment restrictions correct.
4918e14c596Sdrh **
4928e14c596Sdrh ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
4938e14c596Sdrh ** underlying malloc() implemention might return us 4-byte aligned
4948e14c596Sdrh ** pointers.  In that case, only verify 4-byte alignment.
495ea598cbdSdrh */
4968e14c596Sdrh #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
4978e14c596Sdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&3)==0)
4988e14c596Sdrh #else
499ea598cbdSdrh # define EIGHT_BYTE_ALIGNMENT(X)   ((((char*)(X) - (char*)0)&7)==0)
5008e14c596Sdrh #endif
501ea598cbdSdrh 
502e7b34707Sdrh 
503ea598cbdSdrh /*
50490f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
50590f5ecb3Sdrh ** callback for a given sqlite handle.
50690f5ecb3Sdrh **
50790f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
50890f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
50990f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
51090f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
51190f5ecb3Sdrh */
51290f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
51390f5ecb3Sdrh struct BusyHandler {
51490f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
51590f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
516a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
51790f5ecb3Sdrh };
51890f5ecb3Sdrh 
51990f5ecb3Sdrh /*
52075897234Sdrh ** Name of the master database table.  The master database table
52175897234Sdrh ** is a special table that holds the names and attributes of all
52275897234Sdrh ** user tables and indices.
52375897234Sdrh */
52475897234Sdrh #define MASTER_NAME       "sqlite_master"
525e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
52675897234Sdrh 
52775897234Sdrh /*
5288e150818Sdanielk1977 ** The root-page of the master database table.
5298e150818Sdanielk1977 */
5308e150818Sdanielk1977 #define MASTER_ROOT       1
5318e150818Sdanielk1977 
5328e150818Sdanielk1977 /*
533ed6c8671Sdrh ** The name of the schema table.
534ed6c8671Sdrh */
53553c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
536ed6c8671Sdrh 
537ed6c8671Sdrh /*
53875897234Sdrh ** A convenience macro that returns the number of elements in
53975897234Sdrh ** an array.
54075897234Sdrh */
54123432976Sdanielk1977 #define ArraySize(X)    ((int)(sizeof(X)/sizeof(X[0])))
54275897234Sdrh 
54375897234Sdrh /*
544633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
545633e6d57Sdrh ** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
546633e6d57Sdrh */
547633e6d57Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3DbFree)
548633e6d57Sdrh 
54978f82d1eSdrh /*
55078f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
55178f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables.
55278f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from
55378f82d1eSdrh ** the heap.  When WSD is unsupported, the variable declarations scattered
55478f82d1eSdrh ** throughout the SQLite code must become constants instead.  The SQLITE_WSD
55578f82d1eSdrh ** macro is used for this purpose.  And instead of referencing the variable
55678f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated
55778f82d1eSdrh ** buffer that holds real variable.  The constant is also the initializer
55878f82d1eSdrh ** for the run-time allocated buffer.
55978f82d1eSdrh **
5602479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
56178f82d1eSdrh ** macros become no-ops and have zero performance impact.
56278f82d1eSdrh */
563075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD
564075c23afSdanielk1977   #define SQLITE_WSD const
565075c23afSdanielk1977   #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
566075c23afSdanielk1977   #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
567d1d38488Sdrh   int sqlite3_wsd_init(int N, int J);
568d1d38488Sdrh   void *sqlite3_wsd_find(void *K, int L);
569075c23afSdanielk1977 #else
570075c23afSdanielk1977   #define SQLITE_WSD
571075c23afSdanielk1977   #define GLOBAL(t,v) v
572075c23afSdanielk1977   #define sqlite3GlobalConfig sqlite3Config
573075c23afSdanielk1977 #endif
574075c23afSdanielk1977 
575f3d3c27aSdanielk1977 /*
576f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to
577f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately
578f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when
579f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the
580f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the
581f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate,
582f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere.
583f3d3c27aSdanielk1977 **
584f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function,
585f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
586f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to
587f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options.
588f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these
589f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions.
590f3d3c27aSdanielk1977 */
59162c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x)
592f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
59362c14b34Sdanielk1977 
594633e6d57Sdrh /*
59575897234Sdrh ** Forward references to structures
59675897234Sdrh */
59713449892Sdrh typedef struct AggInfo AggInfo;
598fe05af87Sdrh typedef struct AuthContext AuthContext;
5990b9f50d8Sdrh typedef struct AutoincInfo AutoincInfo;
600f5e7bb51Sdrh typedef struct Bitvec Bitvec;
601fe05af87Sdrh typedef struct CollSeq CollSeq;
6027020f651Sdrh typedef struct Column Column;
603fe05af87Sdrh typedef struct Db Db;
604e501b89aSdanielk1977 typedef struct Schema Schema;
60575897234Sdrh typedef struct Expr Expr;
60675897234Sdrh typedef struct ExprList ExprList;
607b7916a78Sdrh typedef struct ExprSpan ExprSpan;
608c2eef3b3Sdrh typedef struct FKey FKey;
609d2199f0fSdan typedef struct FuncDestructor FuncDestructor;
610fe05af87Sdrh typedef struct FuncDef FuncDef;
61170a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
612fe05af87Sdrh typedef struct IdList IdList;
613fe05af87Sdrh typedef struct Index Index;
61402fa4696Sdan typedef struct IndexSample IndexSample;
6158d059845Sdanielk1977 typedef struct KeyClass KeyClass;
616d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
617633e6d57Sdrh typedef struct Lookaside Lookaside;
618633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
619d1ab1ba5Sdanielk1977 typedef struct Module Module;
620626a879aSdrh typedef struct NameContext NameContext;
621fe05af87Sdrh typedef struct Parse Parse;
622a2460e07Sdrh typedef struct RowSet RowSet;
623fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint;
624fe05af87Sdrh typedef struct Select Select;
625fe05af87Sdrh typedef struct SrcList SrcList;
626ade86483Sdrh typedef struct StrAccum StrAccum;
627fe05af87Sdrh typedef struct Table Table;
628c00da105Sdanielk1977 typedef struct TableLock TableLock;
629fe05af87Sdrh typedef struct Token Token;
630a2460e07Sdrh typedef struct Trigger Trigger;
6312832ad42Sdan typedef struct TriggerPrg TriggerPrg;
632fe05af87Sdrh typedef struct TriggerStep TriggerStep;
633e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
634595a523aSdanielk1977 typedef struct VTable VTable;
635b061d058Sdan typedef struct VtabCtx VtabCtx;
6367d10d5a6Sdrh typedef struct Walker Walker;
637111a6a7dSdrh typedef struct WherePlan WherePlan;
638fe05af87Sdrh typedef struct WhereInfo WhereInfo;
639fe05af87Sdrh typedef struct WhereLevel WhereLevel;
640d3d39e93Sdrh 
6412dca4ac1Sdanielk1977 /*
6422dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
6432dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
6442dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
6452dca4ac1Sdanielk1977 */
6462dca4ac1Sdanielk1977 #include "btree.h"
6472dca4ac1Sdanielk1977 #include "vdbe.h"
6482dca4ac1Sdanielk1977 #include "pager.h"
6498c0a791aSdanielk1977 #include "pcache.h"
6502dca4ac1Sdanielk1977 
6511cc5ed81Sdanielk1977 #include "os.h"
652c7ce76afSdrh #include "mutex.h"
6531cc5ed81Sdanielk1977 
654eee4c8caSdrh 
655001bbcbbSdrh /*
656001bbcbbSdrh ** Each database file to be accessed by the system is an instance
657001bbcbbSdrh ** of the following structure.  There are normally two of these structures
658001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
659a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
660a69d9168Sdrh ** databases may be attached.
661001bbcbbSdrh */
662001bbcbbSdrh struct Db {
663001bbcbbSdrh   char *zName;         /* Name of this database */
664001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
665da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
666467bcf36Sshane   u8 safety_level;     /* How aggressive at syncing data to disk */
667e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
668da184236Sdanielk1977 };
669da184236Sdanielk1977 
670da184236Sdanielk1977 /*
671da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
6722120608eSdrh **
6732120608eSdrh ** Most Schema objects are associated with a Btree.  The exception is
6742120608eSdrh ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
6752120608eSdrh ** In shared cache mode, a single Schema object can be shared by multiple
6762120608eSdrh ** Btrees that refer to the same underlying BtShared object.
6772120608eSdrh **
6782120608eSdrh ** Schema objects are automatically deallocated when the last Btree that
6792120608eSdrh ** references them is destroyed.   The TEMP Schema is manually freed by
6802120608eSdrh ** sqlite3_close().
6812120608eSdrh *
6822120608eSdrh ** A thread must be holding a mutex on the corresponding Btree in order
6832120608eSdrh ** to access Schema content.  This implies that the thread must also be
6842120608eSdrh ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
68555a0959aSdrh ** For a TEMP Schema, only the connection mutex is required.
686da184236Sdanielk1977 */
687e501b89aSdanielk1977 struct Schema {
688001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
689c2a75551Sdrh   int iGeneration;     /* Generation counter.  Incremented with each change */
690d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
691d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
692d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
6931da40a38Sdan   Hash fkeyHash;       /* All foreign keys by referenced table name */
6944794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
695da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
6968079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
697da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
69814db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
699001bbcbbSdrh };
70075897234Sdrh 
70175897234Sdrh /*
7028bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
703a2460e07Sdrh ** Db.pSchema->flags field.
7048bf8dc92Sdrh */
705da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
706da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
707da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
708da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
7098bf8dc92Sdrh 
7108bf8dc92Sdrh /*
711a2460e07Sdrh ** Allowed values for the DB.pSchema->flags field.
7128bf8dc92Sdrh **
7138bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
7148bf8dc92Sdrh ** read into internal hash tables.
7158bf8dc92Sdrh **
7168bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
7178bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
7188bf8dc92Sdrh ** changes and so the view will need to be reset.
7198bf8dc92Sdrh */
720124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
721124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
722b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
7238bf8dc92Sdrh 
724caa639f4Sdrh /*
725caa639f4Sdrh ** The number of different kinds of things that can be limited
726caa639f4Sdrh ** using the sqlite3_limit() interface.
727caa639f4Sdrh */
728417168adSdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_TRIGGER_DEPTH+1)
7298bf8dc92Sdrh 
7308bf8dc92Sdrh /*
731633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
732467bcf36Sshane ** to satisfy small transient memory allocation requests for objects
733633e6d57Sdrh ** associated with a particular database connection.  The use of
734633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
735633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
736633e6d57Sdrh ** SQL statements.
737633e6d57Sdrh **
738633e6d57Sdrh ** The Lookaside structure holds configuration information about the
739633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
740633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
741633e6d57Sdrh ** objects.
742d9da78a2Sdrh **
743d9da78a2Sdrh ** Lookaside allocations are only allowed for objects that are associated
744d9da78a2Sdrh ** with a particular database connection.  Hence, schema information cannot
745d9da78a2Sdrh ** be stored in lookaside because in shared cache mode the schema information
746d9da78a2Sdrh ** is shared by multiple database connections.  Therefore, while parsing
747d9da78a2Sdrh ** schema information, the Lookaside.bEnabled flag is cleared so that
748d9da78a2Sdrh ** lookaside allocations are not used to construct the schema objects.
749633e6d57Sdrh */
750633e6d57Sdrh struct Lookaside {
751633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
752d9da78a2Sdrh   u8 bEnabled;            /* False to disable new lookaside allocations */
753e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
754633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
755633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
7560b12e7f8Sdrh   int anStat[3];          /* 0: hits.  1: size misses.  2: full misses */
7577d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
758633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
759633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
760633e6d57Sdrh };
761633e6d57Sdrh struct LookasideSlot {
762633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
763633e6d57Sdrh };
764633e6d57Sdrh 
765633e6d57Sdrh /*
76670a8ca3cSdrh ** A hash table for function definitions.
76770a8ca3cSdrh **
76870a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
76970a8ca3cSdrh ** Collisions are on the FuncDef.pHash chain.
77070a8ca3cSdrh */
77170a8ca3cSdrh struct FuncDefHash {
77270a8ca3cSdrh   FuncDef *a[23];       /* Hash table for functions */
77370a8ca3cSdrh };
77470a8ca3cSdrh 
77570a8ca3cSdrh /*
776a2460e07Sdrh ** Each database connection is an instance of the following structure.
777c9b84a1fSdrh **
778b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
779b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
780b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
781b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
782b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
783b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
784b0c374ffSrdc **
785b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
7866f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
787b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
788b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
789b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
790b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
791b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
792b0c374ffSrdc ** affect the value of lsChange.
793b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
794b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
7956622cce3Sdanielk1977 **
7966622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
7976622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
7986622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
7996622cce3Sdanielk1977 ** consistently.
80075897234Sdrh */
8019bb575fdSdrh struct sqlite3 {
80290f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
803001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
804001bbcbbSdrh   Db *aDb;                      /* All backends */
805467bcf36Sshane   int flags;                    /* Miscellaneous flags. See below */
806522c26fbSdrh   unsigned int openFlags;       /* Flags passed to sqlite3_vfs.xOpen() */
807fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
8084ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
809fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
81090f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
81117435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
8123b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
81398757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
814a7564663Sdrh   u8 suppressErr;               /* Do not issue error messages if true */
815b061d058Sdan   u8 vtabOnConflict;            /* Value to return for s3_vtab_on_conflict() */
816f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
8172803757aSdrh   int nTable;                   /* Number of tables in the database */
818d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
819f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
82064202cfeSdanielk1977   u32 magic;                    /* Magic number for detect library misuse */
821b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
822b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
823d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
824caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
8254adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
8261d85d931Sdrh     int iDb;                    /* When back is being initialized */
8271d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
8281d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
8293d5f74b2Sdrh     u8 orphanTrigger;           /* Last statement is orphaned TEMP trigger */
8301d85d931Sdrh   } init;
831f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
832467bcf36Sshane   void **aExtension;            /* Array of shared library handles */
833326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
834467bcf36Sshane   int activeVdbeCnt;            /* Number of VDBEs currently executing */
835ad4a4b80Sdrh   int writeVdbeCnt;             /* Number of active VDBEs that are writing */
83627381bd5Sdan   int vdbeExecCnt;              /* Number of nested calls to VdbeExec() */
83718de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
83818de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
83919e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
84019e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
841fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
842fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
84371fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
84471fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
84594eb6a14Sdanielk1977   void *pUpdateArg;
84694eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
8475cf53537Sdan #ifndef SQLITE_OMIT_WAL
8487ed91f23Sdrh   int (*xWalCallback)(void *, sqlite3 *, const char *, int);
8497ed91f23Sdrh   void *pWalArg;
8505cf53537Sdan #endif
851fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
852fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
853fcd35c7bSdrh   void *pCollNeededArg;
854fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
855fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
856fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
857881feaa0Sdrh   union {
85839001e75Sdrh     volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
859881feaa0Sdrh     double notUsed1;            /* Spacer */
860881feaa0Sdrh   } u1;
861633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
862ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
863e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
864e22a334bSdrh                                 /* Access authorization function */
865ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
866ed6c8671Sdrh #endif
867348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
868348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
869348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
870348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
871348bb5d6Sdanielk1977 #endif
872b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
873b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
874b061d058Sdan   VtabCtx *pVtabCtx;            /* Context for active vtab connect/create */
875595a523aSdanielk1977   VTable **aVTrans;             /* Virtual tables with open transactions */
876f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
877595a523aSdanielk1977   VTable *pDisconnect;    /* Disconnect these in next sqlite3_prepare() */
8786b456a2bSdanielk1977 #endif
87970a8ca3cSdrh   FuncDefHash aFunc;            /* Hash table of connection functions */
880fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
881fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
88297903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
883fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
884fd7f0452Sdanielk1977   Savepoint *pSavepoint;        /* List of active savepoints */
885fd7f0452Sdanielk1977   int nSavepoint;               /* Number of non-transaction savepoints */
886bd43455cSdanielk1977   int nStatement;               /* Number of nested statement-transactions  */
887fd7f0452Sdanielk1977   u8 isTransactionSavepoint;    /* True if the outermost savepoint is a TS */
8881da40a38Sdan   i64 nDeferredCons;            /* Net deferred constraints this transaction. */
889d46def77Sdan   int *pnBytesFreed;            /* If not NULL, increment this in DbFree() */
890404ca075Sdanielk1977 
891404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
892404ca075Sdanielk1977   /* The following variables are all protected by the STATIC_MASTER
893404ca075Sdanielk1977   ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
89465a73badSdrh   **
89565a73badSdrh   ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
89665a73badSdrh   ** unlock so that it can proceed.
89765a73badSdrh   **
89865a73badSdrh   ** When X.pBlockingConnection==Y, that means that something that X tried
89965a73badSdrh   ** tried to do recently failed with an SQLITE_LOCKED error due to locks
90065a73badSdrh   ** held by Y.
901404ca075Sdanielk1977   */
902404ca075Sdanielk1977   sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
903404ca075Sdanielk1977   sqlite3 *pUnlockConnection;           /* Connection to watch for unlock */
904404ca075Sdanielk1977   void *pUnlockArg;                     /* Argument to xUnlockNotify */
905404ca075Sdanielk1977   void (*xUnlockNotify)(void **, int);  /* Unlock notify callback */
906404ca075Sdanielk1977   sqlite3 *pNextBlocked;        /* Next in list of all blocked connections */
907404ca075Sdanielk1977 #endif
90875897234Sdrh };
90975897234Sdrh 
91003b808a6Sdrh /*
91103b808a6Sdrh ** A macro to discover the encoding of a database.
91203b808a6Sdrh */
91314db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
91414db2665Sdanielk1977 
91575897234Sdrh /*
91607096f68Sdrh ** Possible values for the sqlite3.flags.
91775897234Sdrh */
91807096f68Sdrh #define SQLITE_VdbeTrace      0x00000100  /* True to trace VDBE execution */
91907096f68Sdrh #define SQLITE_InternChanges  0x00000200  /* Uncommitted Hash table changes */
92007096f68Sdrh #define SQLITE_FullColNames   0x00000400  /* Show full column names on SELECT */
92107096f68Sdrh #define SQLITE_ShortColNames  0x00000800  /* Show short columns names */
92207096f68Sdrh #define SQLITE_CountRows      0x00001000  /* Count rows changed by INSERT, */
9231bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
9241bee3d7bSdrh                                           /*   the count using a callback. */
92507096f68Sdrh #define SQLITE_NullCallback   0x00002000  /* Invoke the callback once if the */
9266a535340Sdrh                                           /*   result set is empty */
92707096f68Sdrh #define SQLITE_SqlTrace       0x00004000  /* Debug print SQL as it executes */
92807096f68Sdrh #define SQLITE_VdbeListing    0x00008000  /* Debug listings of VDBE programs */
92907096f68Sdrh #define SQLITE_WriteSchema    0x00010000  /* OK to update SQLITE_MASTER */
93007096f68Sdrh #define SQLITE_NoReadlock     0x00020000  /* Readlocks are omitted when
9317bec505eSdrh                                           ** accessing read-only databases */
93207096f68Sdrh #define SQLITE_IgnoreChecks   0x00040000  /* Do not enforce check constraints */
93307096f68Sdrh #define SQLITE_ReadUncommitted 0x0080000  /* For shared-cache mode */
93407096f68Sdrh #define SQLITE_LegacyFileFmt  0x00100000  /* Create new databases in format 1 */
93507096f68Sdrh #define SQLITE_FullFSync      0x00200000  /* Use full fsync on the backend */
936c97d8463Sdrh #define SQLITE_CkptFullFSync  0x00400000  /* Use full fsync for checkpoint */
93707096f68Sdrh #define SQLITE_RecoveryMode   0x00800000  /* Ignore schema errors */
93807096f68Sdrh #define SQLITE_ReverseOrder   0x01000000  /* Reverse unordered SELECTs */
93907096f68Sdrh #define SQLITE_RecTriggers    0x02000000  /* Enable recursive triggers */
94007096f68Sdrh #define SQLITE_ForeignKeys    0x04000000  /* Enforce foreign key constraints  */
941c6339081Sdrh #define SQLITE_AutoIndex      0x08000000  /* Enable automatic indexes */
942545f587fSdrh #define SQLITE_PreferBuiltin  0x10000000  /* Preference to built-in funcs */
943c97d8463Sdrh #define SQLITE_LoadExtension  0x20000000  /* Enable load_extension */
944e83cafd2Sdrh #define SQLITE_EnableTrigger  0x40000000  /* True to enable triggers */
94507096f68Sdrh 
94607096f68Sdrh /*
94707096f68Sdrh ** Bits of the sqlite3.flags field that are used by the
94807096f68Sdrh ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface.
94907096f68Sdrh ** These must be the low-order bits of the flags field.
95007096f68Sdrh */
95107096f68Sdrh #define SQLITE_QueryFlattener 0x01        /* Disable query flattening */
952b6da74ebSdrh #define SQLITE_ColumnCache    0x02        /* Disable the column cache */
953b6da74ebSdrh #define SQLITE_IndexSort      0x04        /* Disable indexes for sorting */
954b6da74ebSdrh #define SQLITE_IndexSearch    0x08        /* Disable indexes for searching */
955b6da74ebSdrh #define SQLITE_IndexCover     0x10        /* Disable index covering table */
9568c6f666bSdrh #define SQLITE_GroupByOrder   0x20        /* Disable GROUPBY cover of ORDERBY */
957f58ee7f1Sdrh #define SQLITE_FactorOutConst 0x40        /* Disable factoring out constants */
9588c6f666bSdrh #define SQLITE_OptMask        0xff        /* Mask of all disablable opts */
95934c68fbaSdanielk1977 
96058b9576bSdrh /*
961247be43dSdrh ** Possible values for the sqlite.magic field.
962247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
963247be43dSdrh ** than being distinct from one another.
964247be43dSdrh */
965247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
966247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
9677e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
968247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
969247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
970247be43dSdrh 
971247be43dSdrh /*
9720bce8354Sdrh ** Each SQL function is defined by an instance of the following
9730bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
9748e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
9758e0a2f90Sdrh ** points to a linked list of these structures.
9762803757aSdrh */
9770bce8354Sdrh struct FuncDef {
978e82f5d04Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
979d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
98055ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
9811350b030Sdrh   void *pUserData;     /* User data parameter */
9820bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
983f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
984f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
985467bcf36Sshane   void (*xFinalize)(sqlite3_context*);                /* Aggregate finalizer */
9868c0a791aSdanielk1977   char *zName;         /* SQL name of the function. */
98770a8ca3cSdrh   FuncDef *pHash;      /* Next with a different name but the same hash */
988d2199f0fSdan   FuncDestructor *pDestructor;   /* Reference counted destructor function */
989d2199f0fSdan };
990d2199f0fSdan 
991d2199f0fSdan /*
992d2199f0fSdan ** This structure encapsulates a user-function destructor callback (as
993d2199f0fSdan ** configured using create_function_v2()) and a reference counter. When
994d2199f0fSdan ** create_function_v2() is called to create a function with a destructor,
995d2199f0fSdan ** a single object of this type is allocated. FuncDestructor.nRef is set to
996d2199f0fSdan ** the number of FuncDef objects created (either 1 or 3, depending on whether
997d2199f0fSdan ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
998d2199f0fSdan ** member of each of the new FuncDef objects is set to point to the allocated
999d2199f0fSdan ** FuncDestructor.
1000d2199f0fSdan **
1001d2199f0fSdan ** Thereafter, when one of the FuncDef objects is deleted, the reference
1002d2199f0fSdan ** count on this object is decremented. When it reaches 0, the destructor
1003d2199f0fSdan ** is invoked and the FuncDestructor structure freed.
1004d2199f0fSdan */
1005d2199f0fSdan struct FuncDestructor {
1006d2199f0fSdan   int nRef;
1007d2199f0fSdan   void (*xDestroy)(void *);
1008d2199f0fSdan   void *pUserData;
10098e0a2f90Sdrh };
10102803757aSdrh 
10112803757aSdrh /*
10127d10d5a6Sdrh ** Possible values for FuncDef.flags
10137d10d5a6Sdrh */
10147d10d5a6Sdrh #define SQLITE_FUNC_LIKE     0x01 /* Candidate for the LIKE optimization */
10157d10d5a6Sdrh #define SQLITE_FUNC_CASE     0x02 /* Case-sensitive LIKE-type function */
1016467bcf36Sshane #define SQLITE_FUNC_EPHEM    0x04 /* Ephemeral.  Delete with VDBE */
1017e82f5d04Sdrh #define SQLITE_FUNC_NEEDCOLL 0x08 /* sqlite3GetFuncCollSeq() might be called */
1018d1fa7bcaSdrh #define SQLITE_FUNC_PRIVATE  0x10 /* Allowed for internal use only */
1019a5533162Sdanielk1977 #define SQLITE_FUNC_COUNT    0x20 /* Built-in count(*) aggregate */
1020ae6bb957Sdrh #define SQLITE_FUNC_COALESCE 0x40 /* Built-in coalesce() or ifnull() function */
10217d10d5a6Sdrh 
10227d10d5a6Sdrh /*
1023777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
1024777c5386Sdrh ** used to create the initializers for the FuncDef structures.
1025777c5386Sdrh **
1026777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
1027777c5386Sdrh **     Used to create a scalar function definition of a function zName
1028777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
1029777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
1030777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
1031f7bca574Sdrh **     argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
1032777c5386Sdrh **
1033777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
1034777c5386Sdrh **     Used to create an aggregate function definition implemented by
1035777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
1036777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
1037777c5386Sdrh **     FUNCTION().
1038777c5386Sdrh **
1039777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
1040777c5386Sdrh **     Used to create a scalar function definition of a function zName
1041777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
1042777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
1043777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
1044777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
1045777c5386Sdrh **     parameter.
1046777c5386Sdrh */
1047777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
1048f7bca574Sdrh   {nArg, SQLITE_UTF8, bNC*SQLITE_FUNC_NEEDCOLL, \
10496ac78a0dSdrh    SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0, 0}
105021717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
1051f7bca574Sdrh   {nArg, SQLITE_UTF8, bNC*SQLITE_FUNC_NEEDCOLL, \
10526ac78a0dSdrh    pArg, 0, xFunc, 0, 0, #zName, 0, 0}
1053777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
10546ac78a0dSdrh   {nArg, SQLITE_UTF8, flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0, 0}
1055777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
1056f7bca574Sdrh   {nArg, SQLITE_UTF8, nc*SQLITE_FUNC_NEEDCOLL, \
10576ac78a0dSdrh    SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0,0}
1058777c5386Sdrh 
1059fd7f0452Sdanielk1977 /*
1060fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at
1061fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently
1062fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe
1063fd7f0452Sdanielk1977 ** OP_Savepoint instruction.
1064fd7f0452Sdanielk1977 */
1065fd7f0452Sdanielk1977 struct Savepoint {
1066fd7f0452Sdanielk1977   char *zName;                        /* Savepoint name (nul-terminated) */
1067fcb9f7adSdrh   i64 nDeferredCons;                  /* Number of deferred fk violations */
1068fd7f0452Sdanielk1977   Savepoint *pNext;                   /* Parent savepoint (if any) */
1069fd7f0452Sdanielk1977 };
1070fd7f0452Sdanielk1977 
1071fd7f0452Sdanielk1977 /*
1072fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(),
1073fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction.
1074fd7f0452Sdanielk1977 */
1075fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN      0
1076fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE    1
1077fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK   2
1078fd7f0452Sdanielk1977 
1079777c5386Sdrh 
1080777c5386Sdrh /*
1081d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
1082d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
1083d1ab1ba5Sdanielk1977 ** hash table.
1084d1ab1ba5Sdanielk1977 */
1085d1ab1ba5Sdanielk1977 struct Module {
1086d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
1087d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
1088d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
1089832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
1090d1ab1ba5Sdanielk1977 };
1091d1ab1ba5Sdanielk1977 
1092d1ab1ba5Sdanielk1977 /*
1093967e8b73Sdrh ** information about each column of an SQL table is held in an instance
10947020f651Sdrh ** of this structure.
10957020f651Sdrh */
10967020f651Sdrh struct Column {
10977020f651Sdrh   char *zName;     /* Name of this column */
10987977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
1099b7916a78Sdrh   char *zDflt;     /* Original text of the default value */
1100382c0247Sdrh   char *zType;     /* Data type for this column */
1101b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
11024a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
110378100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
1104a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
1105034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
1106034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
1107034ca14fSdanielk1977 #endif
11087020f651Sdrh };
11097020f651Sdrh 
11107020f651Sdrh /*
1111a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
11120202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
11130202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
1114a9fd84b0Sdrh **
1115467bcf36Sshane ** There may two separate implementations of the collation function, one
11160202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
11170202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
11180202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
11190202b29eSdanielk1977 ** the version that will require the least expensive encoding
1120b3bf556eSdanielk1977 ** translations, if any.
11210202b29eSdanielk1977 **
11220202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
11230202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
11240202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
11250202b29eSdanielk1977 ** xCmp16.
11260202b29eSdanielk1977 **
11270202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
11280202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
11290202b29eSdanielk1977 ** collating sequence may not be read or written.
1130a9fd84b0Sdrh */
1131a9fd84b0Sdrh struct CollSeq {
11320202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
1133466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
1134d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
1135a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
11360202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
1137a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
1138a9fd84b0Sdrh };
1139a9fd84b0Sdrh 
1140a9fd84b0Sdrh /*
11417d10d5a6Sdrh ** Allowed values of CollSeq.type:
1142d64fe2f3Sdrh */
1143d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
1144d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
1145d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
1146d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
1147d64fe2f3Sdrh 
1148d64fe2f3Sdrh /*
1149d3d39e93Sdrh ** A sort order can be either ASC or DESC.
11508e2ca029Sdrh */
11518e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
1152d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
11538e2ca029Sdrh 
11548e2ca029Sdrh /*
1155a37cdde0Sdanielk1977 ** Column affinity types.
11568a51256cSdrh **
11578a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
11588a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
11597d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
11608a51256cSdrh **
11618a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
11628a51256cSdrh ** when multiple affinity types are concatenated into a string and
116366a5167bSdrh ** used as the P4 operand, they will be more readable.
11648a51256cSdrh **
11658a51256cSdrh ** Note also that the numeric types are grouped together so that testing
11668a51256cSdrh ** for a numeric type is a single comparison.
1167a37cdde0Sdanielk1977 */
11688a51256cSdrh #define SQLITE_AFF_TEXT     'a'
11698a51256cSdrh #define SQLITE_AFF_NONE     'b'
11708a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
11718a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
11728a51256cSdrh #define SQLITE_AFF_REAL     'e'
1173a37cdde0Sdanielk1977 
11748a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
1175a37cdde0Sdanielk1977 
1176a37cdde0Sdanielk1977 /*
117735573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
117835573356Sdrh ** affinity value.
117935573356Sdrh */
118035573356Sdrh #define SQLITE_AFF_MASK     0x67
118135573356Sdrh 
118235573356Sdrh /*
118335573356Sdrh ** Additional bit values that can be ORed with an affinity without
118435573356Sdrh ** changing the affinity.
118535573356Sdrh */
118635573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
118793a960a0Sdrh #define SQLITE_STOREP2      0x10  /* Store result in reg[P2] rather than jump */
11886a2fe093Sdrh #define SQLITE_NULLEQ       0x80  /* NULL=NULL */
118935573356Sdrh 
119035573356Sdrh /*
1191595a523aSdanielk1977 ** An object of this type is created for each virtual table present in
1192595a523aSdanielk1977 ** the database schema.
1193595a523aSdanielk1977 **
1194595a523aSdanielk1977 ** If the database schema is shared, then there is one instance of this
1195595a523aSdanielk1977 ** structure for each database connection (sqlite3*) that uses the shared
1196595a523aSdanielk1977 ** schema. This is because each database connection requires its own unique
1197595a523aSdanielk1977 ** instance of the sqlite3_vtab* handle used to access the virtual table
1198595a523aSdanielk1977 ** implementation. sqlite3_vtab* handles can not be shared between
1199595a523aSdanielk1977 ** database connections, even when the rest of the in-memory database
1200595a523aSdanielk1977 ** schema is shared, as the implementation often stores the database
1201595a523aSdanielk1977 ** connection handle passed to it via the xConnect() or xCreate() method
1202595a523aSdanielk1977 ** during initialization internally. This database connection handle may
12039bbc2e28Sdrh ** then be used by the virtual table implementation to access real tables
1204595a523aSdanielk1977 ** within the database. So that they appear as part of the callers
1205595a523aSdanielk1977 ** transaction, these accesses need to be made via the same database
1206595a523aSdanielk1977 ** connection as that used to execute SQL operations on the virtual table.
1207595a523aSdanielk1977 **
1208595a523aSdanielk1977 ** All VTable objects that correspond to a single table in a shared
1209595a523aSdanielk1977 ** database schema are initially stored in a linked-list pointed to by
1210595a523aSdanielk1977 ** the Table.pVTable member variable of the corresponding Table object.
1211595a523aSdanielk1977 ** When an sqlite3_prepare() operation is required to access the virtual
1212595a523aSdanielk1977 ** table, it searches the list for the VTable that corresponds to the
1213595a523aSdanielk1977 ** database connection doing the preparing so as to use the correct
1214595a523aSdanielk1977 ** sqlite3_vtab* handle in the compiled query.
1215595a523aSdanielk1977 **
1216595a523aSdanielk1977 ** When an in-memory Table object is deleted (for example when the
1217595a523aSdanielk1977 ** schema is being reloaded for some reason), the VTable objects are not
1218595a523aSdanielk1977 ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
1219595a523aSdanielk1977 ** immediately. Instead, they are moved from the Table.pVTable list to
1220595a523aSdanielk1977 ** another linked list headed by the sqlite3.pDisconnect member of the
1221595a523aSdanielk1977 ** corresponding sqlite3 structure. They are then deleted/xDisconnected
1222595a523aSdanielk1977 ** next time a statement is prepared using said sqlite3*. This is done
1223595a523aSdanielk1977 ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
1224595a523aSdanielk1977 ** Refer to comments above function sqlite3VtabUnlockList() for an
1225595a523aSdanielk1977 ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
1226595a523aSdanielk1977 ** list without holding the corresponding sqlite3.mutex mutex.
1227595a523aSdanielk1977 **
1228595a523aSdanielk1977 ** The memory for objects of this type is always allocated by
1229595a523aSdanielk1977 ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
1230595a523aSdanielk1977 ** the first argument.
1231595a523aSdanielk1977 */
1232595a523aSdanielk1977 struct VTable {
1233595a523aSdanielk1977   sqlite3 *db;              /* Database connection associated with this table */
1234595a523aSdanielk1977   Module *pMod;             /* Pointer to module implementation */
1235595a523aSdanielk1977   sqlite3_vtab *pVtab;      /* Pointer to vtab instance */
1236595a523aSdanielk1977   int nRef;                 /* Number of pointers to this structure */
1237b061d058Sdan   u8 bConstraint;           /* True if constraints are supported */
1238addd8f87Sdrh   int iSavepoint;           /* Depth of the SAVEPOINT stack */
1239595a523aSdanielk1977   VTable *pNext;            /* Next in linked list (see above) */
1240595a523aSdanielk1977 };
1241595a523aSdanielk1977 
1242595a523aSdanielk1977 /*
124322f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
124422f70c32Sdrh ** following structure.
124522f70c32Sdrh **
1246d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
124722f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
124822f70c32Sdrh ** comparisons.
124922f70c32Sdrh **
1250d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
125122f70c32Sdrh ** pointer to an array of Column structures, one for each column.
125222f70c32Sdrh **
1253d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
1254d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
125522f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
125622f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
125722f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
12587d10d5a6Sdrh ** is generated for each row of the table.  TF_HasPrimaryKey is set if
125922f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
126022f70c32Sdrh **
1261d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
1262d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
1263d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
12647d10d5a6Sdrh ** holds temporary tables and indices.  If TF_Ephemeral is set
12657d10d5a6Sdrh ** then the table is stored in a file that is automatically deleted
1266d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
126722f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
126822f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
126922f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
127022f70c32Sdrh ** of a SELECT statement.
127175897234Sdrh */
127275897234Sdrh struct Table {
12737d10d5a6Sdrh   char *zName;         /* Name of the table or view */
12747d10d5a6Sdrh   int iPKey;           /* If not negative, use aCol[iPKey] as the primary key */
127575897234Sdrh   int nCol;            /* Number of columns in this table */
12767020f651Sdrh   Column *aCol;        /* Information about each column */
1277967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
127822f70c32Sdrh   int tnum;            /* Root BTree node for this table (see note above) */
127915564055Sdrh   unsigned nRowEst;    /* Estimated rows in table - from sqlite_stat1 table */
1280a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
12817d10d5a6Sdrh   u16 nRef;            /* Number of pointers to this Table */
12827d10d5a6Sdrh   u8 tabFlags;         /* Mask of TF_* values */
12837d10d5a6Sdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
1284c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
12853d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
1286ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
1287ffe07b2dSdrh   Expr *pCheck;        /* The AND of all CHECK constraints */
1288ffe07b2dSdrh #endif
128919a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
12907d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
129119a8e7e8Sdanielk1977 #endif
1292e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1293595a523aSdanielk1977   VTable *pVTable;     /* List of VTable objects. */
1294b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
1295b9bb7c18Sdrh   char **azModuleArg;  /* Text of all module args. [0] is module name */
1296e09daa90Sdrh #endif
12972f886d1dSdanielk1977   Trigger *pTrigger;   /* List of triggers stored in pSchema */
1298728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
1299588a9a1aSdrh   Table *pNextZombie;  /* Next on the Parse.pZombieTab list */
130075897234Sdrh };
130175897234Sdrh 
130275897234Sdrh /*
13037d10d5a6Sdrh ** Allowed values for Tabe.tabFlags.
13047d10d5a6Sdrh */
13057d10d5a6Sdrh #define TF_Readonly        0x01    /* Read-only system table */
1306467bcf36Sshane #define TF_Ephemeral       0x02    /* An ephemeral table */
13077d10d5a6Sdrh #define TF_HasPrimaryKey   0x04    /* Table has a primary key */
13087d10d5a6Sdrh #define TF_Autoincrement   0x08    /* Integer primary key is autoincrement */
13097d10d5a6Sdrh #define TF_Virtual         0x10    /* Is a virtual table */
13107d10d5a6Sdrh #define TF_NeedMetadata    0x20    /* aCol[].zType and aCol[].pColl missing */
13117d10d5a6Sdrh 
13127d10d5a6Sdrh 
13137d10d5a6Sdrh 
13147d10d5a6Sdrh /*
13154cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
13164cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
13174cbdda9eSdrh ** table support is omitted from the build.
13184cbdda9eSdrh */
13194cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
13207d10d5a6Sdrh #  define IsVirtual(X)      (((X)->tabFlags & TF_Virtual)!=0)
1321034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
13224cbdda9eSdrh #else
13234cbdda9eSdrh #  define IsVirtual(X)      0
1324034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
13254cbdda9eSdrh #endif
13264cbdda9eSdrh 
13274cbdda9eSdrh /*
1328c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
1329c2eef3b3Sdrh **
1330c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
1331c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
1332c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
1333c2eef3b3Sdrh ** Consider this example:
1334c2eef3b3Sdrh **
1335c2eef3b3Sdrh **     CREATE TABLE ex1(
1336c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
1337c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1338c2eef3b3Sdrh **     );
1339c2eef3b3Sdrh **
1340c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1341c2eef3b3Sdrh **
1342c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
1343c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
1344e61922a6Sdrh ** the from-table is created.  The existence of the to-table is not checked.
1345c2eef3b3Sdrh */
1346c2eef3b3Sdrh struct FKey {
13471f638cebSdrh   Table *pFrom;     /* Table containing the REFERENCES clause (aka: Child) */
1348c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
13491f638cebSdrh   char *zTo;        /* Name of table that the key points to (aka: Parent) */
13501da40a38Sdan   FKey *pNextTo;    /* Next foreign key on table named zTo */
13511da40a38Sdan   FKey *pPrevTo;    /* Previous foreign key on table named zTo */
1352c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
13534c429839Sdrh   /* EV: R-30323-21917 */
1354c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
13558099ce6fSdan   u8 aAction[2];          /* ON DELETE and ON UPDATE actions, respectively */
13568099ce6fSdan   Trigger *apTrigger[2];  /* Triggers for aAction[] actions */
1357e61922a6Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
1358e61922a6Sdrh     int iFrom;         /* Index of column in pFrom */
1359e61922a6Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
1360e61922a6Sdrh   } aCol[1];        /* One entry for each of nCol column s */
1361c2eef3b3Sdrh };
1362c2eef3b3Sdrh 
1363c2eef3b3Sdrh /*
1364aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
136522f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
13660bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
13671c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
13681c92853dSdrh ** fails and any prior changes from that one operation are backed out,
13691c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
13701c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
13711c92853dSdrh ** changes due to the same operation are not backed out and no rollback
13721c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
13731c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
13741c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
13751c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
13761c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
13771c92853dSdrh **
1378c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1379c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1380c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1381c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1382c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1383c2eef3b3Sdrh ** foreign key.
1384c2eef3b3Sdrh **
1385968af52aSdrh ** The following symbolic values are used to record which type
13861c92853dSdrh ** of action to take.
13879cfcf5d4Sdrh */
13889cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
13891c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
13901c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
13911c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
13921c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
13931c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1394c2eef3b3Sdrh 
1395c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1396c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1397c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1398c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1399c2eef3b3Sdrh 
1400c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
14019cfcf5d4Sdrh 
1402d3d39e93Sdrh 
1403d3d39e93Sdrh /*
1404d3d39e93Sdrh ** An instance of the following structure is passed as the first
1405d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1406d3d39e93Sdrh ** comparison of the two index keys.
1407d3d39e93Sdrh */
1408d3d39e93Sdrh struct KeyInfo {
1409b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
14109b8d0272Sdrh   u8 enc;             /* Text encoding - one of the SQLITE_UTF* values */
1411e63d9991Sdrh   u16 nField;         /* Number of entries in aColl[] */
14123bb9b93fSdrh   u8 *aSortOrder;     /* Sort order for each column.  May be NULL */
1413d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1414d3d39e93Sdrh };
1415d3d39e93Sdrh 
14169cfcf5d4Sdrh /*
1417e63d9991Sdrh ** An instance of the following structure holds information about a
1418e63d9991Sdrh ** single index record that has already been parsed out into individual
1419e63d9991Sdrh ** values.
1420e63d9991Sdrh **
1421e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1422e63d9991Sdrh ** Records are used to store the content of a table row and to store
1423e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1424467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
1425e63d9991Sdrh ** OP_Column opcode.
1426e63d9991Sdrh **
1427e63d9991Sdrh ** This structure holds a record that has already been disassembled
1428467bcf36Sshane ** into its constituent fields.
1429e63d9991Sdrh */
1430e63d9991Sdrh struct UnpackedRecord {
1431e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
1432e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1433e63d9991Sdrh   u16 flags;          /* Boolean settings.  UNPACKED_... below */
1434de630353Sdanielk1977   i64 rowid;          /* Used by UNPACKED_PREFIX_SEARCH */
1435e63d9991Sdrh   Mem *aMem;          /* Values */
1436e63d9991Sdrh };
1437e63d9991Sdrh 
1438e63d9991Sdrh /*
1439e63d9991Sdrh ** Allowed values of UnpackedRecord.flags
1440e63d9991Sdrh */
1441e63d9991Sdrh #define UNPACKED_NEED_FREE     0x0001  /* Memory is from sqlite3Malloc() */
1442e63d9991Sdrh #define UNPACKED_NEED_DESTROY  0x0002  /* apMem[]s should all be destroyed */
1443e63d9991Sdrh #define UNPACKED_IGNORE_ROWID  0x0004  /* Ignore trailing rowid on key1 */
1444e63d9991Sdrh #define UNPACKED_INCRKEY       0x0008  /* Make this key an epsilon larger */
1445e63d9991Sdrh #define UNPACKED_PREFIX_MATCH  0x0010  /* A prefix match is considered OK */
1446de630353Sdanielk1977 #define UNPACKED_PREFIX_SEARCH 0x0020  /* A prefix match is considered OK */
1447e63d9991Sdrh 
1448e63d9991Sdrh /*
144966b89c8fSdrh ** Each SQL index is represented in memory by an
145075897234Sdrh ** instance of the following structure.
1451967e8b73Sdrh **
1452967e8b73Sdrh ** The columns of the table that are to be indexed are described
1453967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1454967e8b73Sdrh ** we have the following table and index:
1455967e8b73Sdrh **
1456967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1457967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1458967e8b73Sdrh **
1459967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1460967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1461967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1462967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1463967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1464967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1465967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1466ea1ba17cSdrh **
1467ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1468ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1469ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1470ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1471ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1472ea1ba17cSdrh ** element.
147375897234Sdrh */
147475897234Sdrh struct Index {
147575897234Sdrh   char *zName;     /* Name of this index */
1476967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1477967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
14788b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1479967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1480be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
14819cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1482485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1483d6ee353cSdrh   u8 bUnordered;   /* Use this index for == or IN queries only */
1484a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
148575897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1486b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1487b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1488b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
148902fa4696Sdan   IndexSample *aSample;    /* Array of SQLITE_INDEX_SAMPLES samples */
149002fa4696Sdan };
149102fa4696Sdan 
149202fa4696Sdan /*
149302fa4696Sdan ** Each sample stored in the sqlite_stat2 table is represented in memory
149402fa4696Sdan ** using a structure of this type.
149502fa4696Sdan */
149602fa4696Sdan struct IndexSample {
149702fa4696Sdan   union {
149802fa4696Sdan     char *z;        /* Value if eType is SQLITE_TEXT or SQLITE_BLOB */
149902fa4696Sdan     double r;       /* Value if eType is SQLITE_FLOAT or SQLITE_INTEGER */
150002fa4696Sdan   } u;
150102fa4696Sdan   u8 eType;         /* SQLITE_NULL, SQLITE_INTEGER ... etc. */
150202fa4696Sdan   u8 nByte;         /* Size in byte of text or blob. */
150375897234Sdrh };
150475897234Sdrh 
150575897234Sdrh /*
150675897234Sdrh ** Each token coming out of the lexer is an instance of
15074b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
15084efc4754Sdrh **
15094efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
1510467bcf36Sshane ** may contain random values.  Do not make any assumptions about Token.dyn
15114efc4754Sdrh ** and Token.n when Token.z==0.
151275897234Sdrh */
151375897234Sdrh struct Token {
1514b7916a78Sdrh   const char *z;     /* Text of the token.  Not NULL-terminated! */
1515b7916a78Sdrh   unsigned int n;    /* Number of characters in this token */
151675897234Sdrh };
151775897234Sdrh 
151875897234Sdrh /*
151913449892Sdrh ** An instance of this structure contains information needed to generate
152013449892Sdrh ** code for a SELECT that contains aggregate functions.
152113449892Sdrh **
152213449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
152313449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
152413449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
152513449892Sdrh ** code for that node.
152613449892Sdrh **
152713449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
152813449892Sdrh ** original Select structure that describes the SELECT statement.  These
152913449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
153013449892Sdrh */
153113449892Sdrh struct AggInfo {
153213449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
153313449892Sdrh                           ** from source tables rather than from accumulators */
153413449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
153513449892Sdrh                           ** than the source table */
153613449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
153713449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
153813449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
153913449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
15400817d0dfSdanielk1977     Table *pTab;             /* Source table */
154113449892Sdrh     int iTable;              /* Cursor number of the source table */
154213449892Sdrh     int iColumn;             /* Column number within the source table */
154313449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
154413449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
15455774b806Sdrh     Expr *pExpr;             /* The original expression */
154613449892Sdrh   } *aCol;
154713449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
154813449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
154913449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
155013449892Sdrh                           ** Additional columns are used only as parameters to
155113449892Sdrh                           ** aggregate functions */
155213449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
155313449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
155413449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
155513449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1556467bcf36Sshane     int iDistinct;           /* Ephemeral table used to enforce DISTINCT */
155713449892Sdrh   } *aFunc;
155813449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
155913449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
156013449892Sdrh };
156113449892Sdrh 
156213449892Sdrh /*
15638677d308Sdrh ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
15648677d308Sdrh ** Usually it is 16-bits.  But if SQLITE_MAX_VARIABLE_NUMBER is greater
15658677d308Sdrh ** than 32767 we have to make it 32-bit.  16-bit is preferred because
15668677d308Sdrh ** it uses less memory in the Expr object, which is a big memory user
15678677d308Sdrh ** in systems with lots of prepared statements.  And few applications
15688677d308Sdrh ** need more than about 10 or 20 variables.  But some extreme users want
15698677d308Sdrh ** to have prepared statements with over 32767 variables, and for them
15708677d308Sdrh ** the option is available (at compile-time).
15718677d308Sdrh */
15728677d308Sdrh #if SQLITE_MAX_VARIABLE_NUMBER<=32767
1573481aa74eSdrh typedef i16 ynVar;
15748677d308Sdrh #else
15758677d308Sdrh typedef int ynVar;
15768677d308Sdrh #endif
15778677d308Sdrh 
15788677d308Sdrh /*
157975897234Sdrh ** Each node of an expression in the parse tree is an instance
158022f70c32Sdrh ** of this structure.
158122f70c32Sdrh **
158222f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused
158322f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer
158422f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused
158522f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
158622f70c32Sdrh ** tree.
158722f70c32Sdrh **
15886ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
15896ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
15906ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
15916ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
15926ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function.
159322f70c32Sdrh **
15946ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
15956ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL.
15966ab3a2ecSdanielk1977 **
15976ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
15986ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
15996ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
16006ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
16016ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
16026ab3a2ecSdanielk1977 ** valid.
160322f70c32Sdrh **
160422f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
160522f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
160622f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
160722f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
160822f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
160922f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
161022f70c32Sdrh ** it can be accessed after all aggregates are computed.
161122f70c32Sdrh **
16126ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark
16136ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index
16146ab3a2ecSdanielk1977 ** number for that variable.
161522f70c32Sdrh **
16161398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
16171398ad36Sdrh ** register number containing the result of the subquery.  If the
16181398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
16191398ad36Sdrh ** gives a different answer at different times during statement processing
16201398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
16211398ad36Sdrh **
1622aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1623aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1624aee18ef8Sdanielk1977 ** corresponding table definition.
16256ab3a2ecSdanielk1977 **
16266ab3a2ecSdanielk1977 ** ALLOCATION NOTES:
16276ab3a2ecSdanielk1977 **
162812ffee8cSdrh ** Expr objects can use a lot of memory space in database schema.  To
162912ffee8cSdrh ** help reduce memory requirements, sometimes an Expr object will be
163012ffee8cSdrh ** truncated.  And to reduce the number of memory allocations, sometimes
163112ffee8cSdrh ** two or more Expr objects will be stored in a single memory allocation,
163233e619fcSdrh ** together with Expr.zToken strings.
16336ab3a2ecSdanielk1977 **
1634b7916a78Sdrh ** If the EP_Reduced and EP_TokenOnly flags are set when
163512ffee8cSdrh ** an Expr object is truncated.  When EP_Reduced is set, then all
163612ffee8cSdrh ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
163712ffee8cSdrh ** are contained within the same memory allocation.  Note, however, that
163812ffee8cSdrh ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
163912ffee8cSdrh ** allocated, regardless of whether or not EP_Reduced is set.
164075897234Sdrh */
164175897234Sdrh struct Expr {
16421cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1643a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
16441af466ebSdrh   u16 flags;             /* Various flags.  EP_* See below */
164533e619fcSdrh   union {
1646b7916a78Sdrh     char *zToken;          /* Token value. Zero terminated and dequoted */
1647d50ffc41Sdrh     int iValue;            /* Non-negative integer value if EP_IntValue */
164833e619fcSdrh   } u;
16496ab3a2ecSdanielk1977 
16506ab3a2ecSdanielk1977   /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
16516ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
16526ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
16536ab3a2ecSdanielk1977   *********************************************************************/
16546ab3a2ecSdanielk1977 
16556ab3a2ecSdanielk1977   Expr *pLeft;           /* Left subnode */
16566ab3a2ecSdanielk1977   Expr *pRight;          /* Right subnode */
16576ab3a2ecSdanielk1977   union {
16586ab3a2ecSdanielk1977     ExprList *pList;     /* Function arguments or in "<expr> IN (<expr-list)" */
16596ab3a2ecSdanielk1977     Select *pSelect;     /* Used for sub-selects and "<expr> IN (<select>)" */
16606ab3a2ecSdanielk1977   } x;
16616ab3a2ecSdanielk1977   CollSeq *pColl;        /* The collation type of the column or 0 */
16626ab3a2ecSdanielk1977 
16636ab3a2ecSdanielk1977   /* If the EP_Reduced flag is set in the Expr.flags mask, then no
16646ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
16656ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
16666ab3a2ecSdanielk1977   *********************************************************************/
16676ab3a2ecSdanielk1977 
1668b7916a78Sdrh   int iTable;            /* TK_COLUMN: cursor number of table holding column
16692832ad42Sdan                          ** TK_REGISTER: register number
16702832ad42Sdan                          ** TK_TRIGGER: 1 -> new, 0 -> old */
16718677d308Sdrh   ynVar iColumn;         /* TK_COLUMN: column index.  -1 for rowid.
1672937d0deaSdan                          ** TK_VARIABLE: variable number (always >= 1). */
1673b7916a78Sdrh   i16 iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
1674b7916a78Sdrh   i16 iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1675fcd4a150Sdan   u8 flags2;             /* Second set of flags.  EP2_... */
1676fcd4a150Sdan   u8 op2;                /* If a TK_REGISTER, the original value of Expr.op */
167713449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
16787d10d5a6Sdrh   Table *pTab;           /* Table for TK_COLUMN expressions. */
16790224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
1680fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1681fc976065Sdanielk1977 #endif
168275897234Sdrh };
168375897234Sdrh 
168475897234Sdrh /*
16851f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
16861f16230bSdrh */
1687678ccce8Sdrh #define EP_FromJoin   0x0001  /* Originated in ON or USING clause of a join */
1688678ccce8Sdrh #define EP_Agg        0x0002  /* Contains one or more aggregate functions */
1689678ccce8Sdrh #define EP_Resolved   0x0004  /* IDs have been resolved to COLUMNs */
1690678ccce8Sdrh #define EP_Error      0x0008  /* Expression contains one or more errors */
1691678ccce8Sdrh #define EP_Distinct   0x0010  /* Aggregate function with DISTINCT keyword */
1692678ccce8Sdrh #define EP_VarSelect  0x0020  /* pSelect is correlated, not constant */
169324fb627aSdrh #define EP_DblQuoted  0x0040  /* token.z was originally in "..." */
1694678ccce8Sdrh #define EP_InfixFunc  0x0080  /* True for an infix function: LIKE, GLOB, etc */
1695678ccce8Sdrh #define EP_ExpCollate 0x0100  /* Collating sequence specified explicitly */
1696b6da74ebSdrh #define EP_FixedDest  0x0200  /* Result needed in a specific register */
1697b6da74ebSdrh #define EP_IntValue   0x0400  /* Integer value contained in u.iValue */
1698b6da74ebSdrh #define EP_xIsSelect  0x0800  /* x.pSelect is valid (otherwise x.pList is) */
16996ab3a2ecSdanielk1977 
1700b6da74ebSdrh #define EP_Reduced    0x1000  /* Expr struct is EXPR_REDUCEDSIZE bytes only */
1701b6da74ebSdrh #define EP_TokenOnly  0x2000  /* Expr struct is EXPR_TOKENONLYSIZE bytes only */
1702b6da74ebSdrh #define EP_Static     0x4000  /* Held in memory not obtained from malloc() */
17036ab3a2ecSdanielk1977 
17041f16230bSdrh /*
1705b7916a78Sdrh ** The following are the meanings of bits in the Expr.flags2 field.
17061af466ebSdrh */
170733e619fcSdrh #define EP2_MallocedToken  0x0001  /* Need to sqlite3DbFree() Expr.zToken */
170833e619fcSdrh #define EP2_Irreducible    0x0002  /* Cannot EXPRDUP_REDUCE this Expr */
170933e619fcSdrh 
171033e619fcSdrh /*
171133e619fcSdrh ** The pseudo-routine sqlite3ExprSetIrreducible sets the EP2_Irreducible
171233e619fcSdrh ** flag on an expression structure.  This flag is used for VV&A only.  The
171333e619fcSdrh ** routine is implemented as a macro that only works when in debugging mode,
171433e619fcSdrh ** so as not to burden production code.
171533e619fcSdrh */
171633e619fcSdrh #ifdef SQLITE_DEBUG
171733e619fcSdrh # define ExprSetIrreducible(X)  (X)->flags2 |= EP2_Irreducible
171833e619fcSdrh #else
171933e619fcSdrh # define ExprSetIrreducible(X)
172033e619fcSdrh #endif
17211af466ebSdrh 
17221af466ebSdrh /*
17231f16230bSdrh ** These macros can be used to test, set, or clear bits in the
17241f16230bSdrh ** Expr.flags field.
17251f16230bSdrh */
17261f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
17271f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
17281f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
17291f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
17301f16230bSdrh 
17311f16230bSdrh /*
17326ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr
17336ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
17346ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set.
17356ab3a2ecSdanielk1977 */
173612ffee8cSdrh #define EXPR_FULLSIZE           sizeof(Expr)           /* Full size */
173712ffee8cSdrh #define EXPR_REDUCEDSIZE        offsetof(Expr,iTable)  /* Common features */
1738b7916a78Sdrh #define EXPR_TOKENONLYSIZE      offsetof(Expr,pLeft)   /* Fewer features */
17396ab3a2ecSdanielk1977 
17406ab3a2ecSdanielk1977 /*
17416ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment
17426ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details.
17436ab3a2ecSdanielk1977 */
174412ffee8cSdrh #define EXPRDUP_REDUCE         0x0001  /* Used reduced-size Expr nodes */
17456ab3a2ecSdanielk1977 
17466ab3a2ecSdanielk1977 /*
174775897234Sdrh ** A list of expressions.  Each expression may optionally have a
174875897234Sdrh ** name.  An expr/name combination can be used in several ways, such
174975897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
175075897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1751ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
175275897234Sdrh ** field is not used.
175375897234Sdrh */
175475897234Sdrh struct ExprList {
175575897234Sdrh   int nExpr;             /* Number of expressions on the list */
17564305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
17579d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
17586d4abfbeSdrh   struct ExprList_item {
175975897234Sdrh     Expr *pExpr;           /* The list of expressions */
176075897234Sdrh     char *zName;           /* Token associated with this expression */
1761b7916a78Sdrh     char *zSpan;           /* Original text of the expression */
17628e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
17638e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
17647d10d5a6Sdrh     u16 iCol;              /* For ORDER BY, column number in result set */
17658b213899Sdrh     u16 iAlias;            /* Index into Parse.aAlias[] for zName */
176675897234Sdrh   } *a;                  /* One entry for each expression */
176775897234Sdrh };
176875897234Sdrh 
176975897234Sdrh /*
1770b7916a78Sdrh ** An instance of this structure is used by the parser to record both
1771b7916a78Sdrh ** the parse tree for an expression and the span of input text for an
1772b7916a78Sdrh ** expression.
1773b7916a78Sdrh */
1774b7916a78Sdrh struct ExprSpan {
1775b7916a78Sdrh   Expr *pExpr;          /* The expression parse tree */
1776b7916a78Sdrh   const char *zStart;   /* First character of input text */
1777b7916a78Sdrh   const char *zEnd;     /* One character past the end of input text */
1778b7916a78Sdrh };
1779b7916a78Sdrh 
1780b7916a78Sdrh /*
1781ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1782ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1783ad3cab52Sdrh **
1784ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1785ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1786ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1787ad3cab52Sdrh **
1788ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1789ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1790ad3cab52Sdrh **
1791ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1792ad3cab52Sdrh **
1793ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
179475897234Sdrh */
179575897234Sdrh struct IdList {
17966d4abfbeSdrh   struct IdList_item {
1797ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1798967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1799ad3cab52Sdrh   } *a;
180013449892Sdrh   int nId;         /* Number of identifiers on the list */
180113449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1802ad3cab52Sdrh };
1803ad3cab52Sdrh 
1804ad3cab52Sdrh /*
180551669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1806ca83ac51Sdrh **
1807ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1808ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1809ca83ac51Sdrh ** of the library by 738 bytes on ix86.
181051669863Sdrh */
1811ca83ac51Sdrh typedef u64 Bitmask;
181251669863Sdrh 
181351669863Sdrh /*
181400e13613Sdanielk1977 ** The number of bits in a Bitmask.  "BMS" means "BitMask Size".
181500e13613Sdanielk1977 */
181600e13613Sdanielk1977 #define BMS  ((int)(sizeof(Bitmask)*8))
181700e13613Sdanielk1977 
181800e13613Sdanielk1977 /*
1819ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1820ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1821ad3cab52Sdrh ** the SrcList.a[] array.
1822d24cc427Sdrh **
1823d24cc427Sdrh ** With the addition of multiple database support, the following structure
1824d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1825d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1826d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1827d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1828c49de5d9Sdrh **
1829c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1830c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1831c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1832c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
18332a6a7eebSdrh **
18342a6a7eebSdrh ** In the colUsed field, the high-order bit (bit 63) is set if the table
18352a6a7eebSdrh ** contains more than 63 columns and the 64-th or later column is used.
1836ad3cab52Sdrh */
1837ad3cab52Sdrh struct SrcList {
1838939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1839939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1840ad3cab52Sdrh   struct SrcList_item {
1841113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1842ad3cab52Sdrh     char *zName;      /* Name of the table */
1843ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1844daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1845daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
18461787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1847c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1848dd5f5a62Sdrh     u8 notIndexed;    /* True if there is a NOT INDEXED clause */
1849ce7e189dSdan #ifndef SQLITE_OMIT_EXPLAIN
1850ce7e189dSdan     u8 iSelectId;     /* If pSelect!=0, the id of the sub-select in EQP */
1851ce7e189dSdan #endif
1852e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1853ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1854ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
1855cd38d520Sdanielk1977     Bitmask colUsed;  /* Bit N (1<<N) set if column N of pTab is used */
185685574e31Sdanielk1977     char *zIndex;     /* Identifier from "INDEXED BY <zIndex>" clause */
185785574e31Sdanielk1977     Index *pIndex;    /* Index structure corresponding to zIndex, if any */
1858113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
185975897234Sdrh };
186075897234Sdrh 
186175897234Sdrh /*
186201f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
186301f3f253Sdrh */
186401f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
18653dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
18663dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
18673dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
18683dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
18693dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
18703dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
187101f3f253Sdrh 
1872111a6a7dSdrh 
1873111a6a7dSdrh /*
1874111a6a7dSdrh ** A WherePlan object holds information that describes a lookup
1875111a6a7dSdrh ** strategy.
1876111a6a7dSdrh **
1877111a6a7dSdrh ** This object is intended to be opaque outside of the where.c module.
1878111a6a7dSdrh ** It is included here only so that that compiler will know how big it
1879111a6a7dSdrh ** is.  None of the fields in this object should be used outside of
1880111a6a7dSdrh ** the where.c module.
1881111a6a7dSdrh **
1882111a6a7dSdrh ** Within the union, pIdx is only used when wsFlags&WHERE_INDEXED is true.
1883111a6a7dSdrh ** pTerm is only used when wsFlags&WHERE_MULTI_OR is true.  And pVtabIdx
1884111a6a7dSdrh ** is only used when wsFlags&WHERE_VIRTUALTABLE is true.  It is never the
1885111a6a7dSdrh ** case that more than one of these conditions is true.
1886111a6a7dSdrh */
1887111a6a7dSdrh struct WherePlan {
1888111a6a7dSdrh   u32 wsFlags;                   /* WHERE_* flags that describe the strategy */
1889111a6a7dSdrh   u32 nEq;                       /* Number of == constraints */
18902ce22453Sdan   double nRow;                   /* Estimated number of rows (for EQP) */
1891111a6a7dSdrh   union {
1892111a6a7dSdrh     Index *pIdx;                   /* Index when WHERE_INDEXED is true */
1893111a6a7dSdrh     struct WhereTerm *pTerm;       /* WHERE clause term for OR-search */
1894111a6a7dSdrh     sqlite3_index_info *pVtabIdx;  /* Virtual table index to use */
1895111a6a7dSdrh   } u;
1896111a6a7dSdrh };
1897111a6a7dSdrh 
189801f3f253Sdrh /*
18996b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
19006b56344dSdrh ** structure contains a single instance of this structure.  This structure
19016b56344dSdrh ** is intended to be private the the where.c module and should not be
19026b56344dSdrh ** access or modified by other modules.
19036d209d8bSdrh **
1904111a6a7dSdrh ** The pIdxInfo field is used to help pick the best index on a
1905111a6a7dSdrh ** virtual table.  The pIdxInfo pointer contains indexing
19066d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
19076d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1908111a6a7dSdrh ** All other information in the i-th WhereLevel object for the i-th table
1909111a6a7dSdrh ** after FROM clause ordering.
19106b56344dSdrh */
19116b56344dSdrh struct WhereLevel {
1912111a6a7dSdrh   WherePlan plan;       /* query plan for this element of the FROM clause */
191329dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
19149012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
1915467bcf36Sshane   int iIdxCur;          /* The VDBE cursor used to access pIdx */
1916b3190c15Sdrh   int addrBrk;          /* Jump here to break out of the loop */
1917b3190c15Sdrh   int addrNxt;          /* Jump here to start the next IN combination */
1918b3190c15Sdrh   int addrCont;         /* Jump here to continue with the next loop cycle */
1919b3190c15Sdrh   int addrFirst;        /* First instruction of interior of the loop */
1920700a2261Sdrh   u8 iFrom;             /* Which entry in the FROM clause */
1921111a6a7dSdrh   u8 op, p5;            /* Opcode and P5 of the opcode that ends the loop */
1922111a6a7dSdrh   int p1, p2;           /* Operands of the opcode used to ends the loop */
1923111a6a7dSdrh   union {               /* Information that depends on plan.wsFlags */
1924111a6a7dSdrh     struct {
1925111a6a7dSdrh       int nIn;              /* Number of entries in aInLoop[] */
192672e8fa42Sdrh       struct InLoop {
192772e8fa42Sdrh         int iCur;              /* The VDBE cursor used by this IN operator */
1928b3190c15Sdrh         int addrInTop;         /* Top of the IN loop */
192972e8fa42Sdrh       } *aInLoop;           /* Information about each nested IN operator */
1930111a6a7dSdrh     } in;                 /* Used when plan.wsFlags&WHERE_IN_ABLE */
1931111a6a7dSdrh   } u;
19326d209d8bSdrh 
19336d209d8bSdrh   /* The following field is really not part of the current level.  But
1934111a6a7dSdrh   ** we need a place to cache virtual table index information for each
1935111a6a7dSdrh   ** virtual table in the FROM clause and the WhereLevel structure is
1936111a6a7dSdrh   ** a convenient place since there is one WhereLevel for each FROM clause
1937111a6a7dSdrh   ** element.
19386d209d8bSdrh   */
19396d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
19406b56344dSdrh };
19416b56344dSdrh 
194208c88eb0Sdrh /*
1943336a5300Sdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
1944336a5300Sdrh ** and the WhereInfo.wctrlFlags member.
194508c88eb0Sdrh */
19466df2acd2Sdrh #define WHERE_ORDERBY_NORMAL   0x0000 /* No-op */
19476df2acd2Sdrh #define WHERE_ORDERBY_MIN      0x0001 /* ORDER BY processing for min() func */
19486df2acd2Sdrh #define WHERE_ORDERBY_MAX      0x0002 /* ORDER BY processing for max() func */
19496df2acd2Sdrh #define WHERE_ONEPASS_DESIRED  0x0004 /* Want to do one-pass UPDATE/DELETE */
1950336a5300Sdrh #define WHERE_DUPLICATES_OK    0x0008 /* Ok to return a row more than once */
19518b307fbfSdrh #define WHERE_OMIT_OPEN        0x0010 /* Table cursors are already open */
19526df2acd2Sdrh #define WHERE_OMIT_CLOSE       0x0020 /* Omit close of table & index cursors */
1953336a5300Sdrh #define WHERE_FORCE_TABLE      0x0040 /* Do not use an index-only search */
1954c01a3c17Sdrh #define WHERE_ONETABLE_ONLY    0x0080 /* Only code the 1st table in pTabList */
1955a9d1ccb9Sdanielk1977 
19566b56344dSdrh /*
195775897234Sdrh ** The WHERE clause processing routine has two halves.  The
195875897234Sdrh ** first part does the start of the WHERE loop and the second
195975897234Sdrh ** half does the tail of the WHERE loop.  An instance of
196075897234Sdrh ** this structure is returned by the first half and passed
196175897234Sdrh ** into the second half to give some continuity.
196275897234Sdrh */
196375897234Sdrh struct WhereInfo {
196408c88eb0Sdrh   Parse *pParse;       /* Parsing and code generating context */
19656df2acd2Sdrh   u16 wctrlFlags;      /* Flags originally passed to sqlite3WhereBegin() */
196608c88eb0Sdrh   u8 okOnePass;        /* Ok to use one-pass algorithm for UPDATE or DELETE */
1967c01a3c17Sdrh   u8 untestedTerms;    /* Not all WHERE terms resolved by outer loop */
1968ad3cab52Sdrh   SrcList *pTabList;             /* List of tables in the join */
19699012bcbcSdrh   int iTop;                      /* The very beginning of the WHERE loop */
197019a775c2Sdrh   int iContinue;                 /* Jump here to continue with next record */
197119a775c2Sdrh   int iBreak;                    /* Jump here to break out of the loop */
19726b56344dSdrh   int nLevel;                    /* Number of nested loop */
1973111a6a7dSdrh   struct WhereClause *pWC;       /* Decomposition of the WHERE clause */
19748b307fbfSdrh   double savedNQueryLoop;        /* pParse->nQueryLoop outside the WHERE loop */
197595aa47b1Sdrh   double nRowOut;                /* Estimated number of output rows */
1976111a6a7dSdrh   WhereLevel a[1];               /* Information about each nest loop in WHERE */
197775897234Sdrh };
197875897234Sdrh 
197975897234Sdrh /*
1980b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1981b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1982b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1983b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1984b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1985b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1986b3bce662Sdanielk1977 ** other statements.
1987b3bce662Sdanielk1977 **
1988b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1989b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1990b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1991b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1992b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1993b3bce662Sdanielk1977 ** the context containing the match is incremented.
1994b3bce662Sdanielk1977 **
1995b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1996b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1997b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1998b3bce662Sdanielk1977 ** subqueries looking for a match.
1999b3bce662Sdanielk1977 */
2000b3bce662Sdanielk1977 struct NameContext {
2001b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
2002b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
2003b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
2004b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
2005b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
2006b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
200713449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
200806f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
2009b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
201013449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
2011b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
2012b3bce662Sdanielk1977 };
2013b3bce662Sdanielk1977 
2014b3bce662Sdanielk1977 /*
20159bb61fe7Sdrh ** An instance of the following structure contains all information
20169bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
2017a76b5dfcSdrh **
2018d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
2019d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
2020d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
2021d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
2022d11d382cSdrh ** in the VDBE that record the limit and offset counters.
20230342b1f5Sdrh **
2024b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
20250342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
202666a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
20270342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
2028b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
20290342b1f5Sdrh ** enough information about the compound query is known at that point.
2030b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
2031b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
20320342b1f5Sdrh ** sequences for the ORDER BY clause.
20339bb61fe7Sdrh */
20349bb61fe7Sdrh struct Select {
20359bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
20367b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
20376c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
20387d10d5a6Sdrh   u16 selFlags;          /* Various SF_* values */
2039ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
20409bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
20419bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
20429bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
20439bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
2044967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
20451e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
20460342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
2047a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
2048a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
20497b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
2050b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
205195aa47b1Sdrh   double nSelectRow;     /* Estimated number of result rows */
20529bb61fe7Sdrh };
20539bb61fe7Sdrh 
20549bb61fe7Sdrh /*
20557d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
20567d10d5a6Sdrh ** "Select Flag".
20577d10d5a6Sdrh */
20587d10d5a6Sdrh #define SF_Distinct        0x0001  /* Output should be DISTINCT */
20597d10d5a6Sdrh #define SF_Resolved        0x0002  /* Identifiers have been resolved */
20607d10d5a6Sdrh #define SF_Aggregate       0x0004  /* Contains aggregate functions */
20617d10d5a6Sdrh #define SF_UsesEphemeral   0x0008  /* Uses the OpenEphemeral opcode */
20627d10d5a6Sdrh #define SF_Expanded        0x0010  /* sqlite3SelectExpand() called on this */
20637d10d5a6Sdrh #define SF_HasTypeInfo     0x0020  /* FROM subqueries have Table metadata */
20647d10d5a6Sdrh 
20657d10d5a6Sdrh 
20667d10d5a6Sdrh /*
20677d10d5a6Sdrh ** The results of a select can be distributed in several ways.  The
20687d10d5a6Sdrh ** "SRT" prefix means "SELECT Result Type".
2069fef5208cSdrh */
207013449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
207113449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
20729ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
20739ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
2074fef5208cSdrh 
207513449892Sdrh /* The ORDER BY clause is ignored for all of the above */
20766c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
207713449892Sdrh 
20787d10d5a6Sdrh #define SRT_Output       5  /* Output each row of result */
20799ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
20800cdc022eSdanielk1977 #define SRT_Set          7  /* Store results as keys in an index */
20819ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
20829ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
2083e00ee6ebSdrh #define SRT_Coroutine   10  /* Generate a single row of result */
20842282792aSdrh 
20852282792aSdrh /*
2086467bcf36Sshane ** A structure used to customize the behavior of sqlite3Select(). See
20876c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
20886c8c8ce0Sdanielk1977 */
20896c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
20906c8c8ce0Sdanielk1977 struct SelectDest {
2091477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
2092477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
20936c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
20941013c932Sdrh   int iMem;         /* Base register where results are written */
2095ad27e761Sdrh   int nMem;         /* Number of registers allocated */
20966c8c8ce0Sdanielk1977 };
20976c8c8ce0Sdanielk1977 
20986c8c8ce0Sdanielk1977 /*
20990b9f50d8Sdrh ** During code generation of statements that do inserts into AUTOINCREMENT
21000b9f50d8Sdrh ** tables, the following information is attached to the Table.u.autoInc.p
21010b9f50d8Sdrh ** pointer of each autoincrement table to record some side information that
21020b9f50d8Sdrh ** the code generator needs.  We have to keep per-table autoincrement
21030b9f50d8Sdrh ** information in case inserts are down within triggers.  Triggers do not
21040b9f50d8Sdrh ** normally coordinate their activities, but we do need to coordinate the
21050b9f50d8Sdrh ** loading and saving of autoincrement information.
21060b9f50d8Sdrh */
21070b9f50d8Sdrh struct AutoincInfo {
21080b9f50d8Sdrh   AutoincInfo *pNext;   /* Next info block in a list of them all */
21090b9f50d8Sdrh   Table *pTab;          /* Table this info block refers to */
21100b9f50d8Sdrh   int iDb;              /* Index in sqlite3.aDb[] of database holding pTab */
21110b9f50d8Sdrh   int regCtr;           /* Memory register holding the rowid counter */
21120b9f50d8Sdrh };
21130b9f50d8Sdrh 
21140b9f50d8Sdrh /*
2115ceea3321Sdrh ** Size of the column cache
2116ceea3321Sdrh */
2117ceea3321Sdrh #ifndef SQLITE_N_COLCACHE
2118ceea3321Sdrh # define SQLITE_N_COLCACHE 10
2119ceea3321Sdrh #endif
2120ceea3321Sdrh 
21212832ad42Sdan /*
21222832ad42Sdan ** At least one instance of the following structure is created for each
21232832ad42Sdan ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
21242832ad42Sdan ** statement. All such objects are stored in the linked list headed at
21252832ad42Sdan ** Parse.pTriggerPrg and deleted once statement compilation has been
21262832ad42Sdan ** completed.
21272832ad42Sdan **
21282832ad42Sdan ** A Vdbe sub-program that implements the body and WHEN clause of trigger
21292832ad42Sdan ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
21302832ad42Sdan ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
21312832ad42Sdan ** The Parse.pTriggerPrg list never contains two entries with the same
21322832ad42Sdan ** values for both pTrigger and orconf.
213365a7cd16Sdan **
2134bb5f168fSdan ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
213565a7cd16Sdan ** accessed (or set to 0 for triggers fired as a result of INSERT
2136bb5f168fSdan ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
2137bb5f168fSdan ** a mask of new.* columns used by the program.
21382832ad42Sdan */
21392832ad42Sdan struct TriggerPrg {
21402832ad42Sdan   Trigger *pTrigger;      /* Trigger this program was coded from */
2141165921a7Sdan   int orconf;             /* Default ON CONFLICT policy */
21422832ad42Sdan   SubProgram *pProgram;   /* Program implementing pTrigger/orconf */
2143bb5f168fSdan   u32 aColmask[2];        /* Masks of old.*, new.* columns accessed */
21442832ad42Sdan   TriggerPrg *pNext;      /* Next entry in Parse.pTriggerPrg list */
2145165921a7Sdan };
2146165921a7Sdan 
214764123585Sdrh /*
214864123585Sdrh ** The yDbMask datatype for the bitmask of all attached databases.
214964123585Sdrh */
215001c7dc88Sdrh #if SQLITE_MAX_ATTACHED>30
215164123585Sdrh   typedef sqlite3_uint64 yDbMask;
215201c7dc88Sdrh #else
215364123585Sdrh   typedef unsigned int yDbMask;
215401c7dc88Sdrh #endif
215501c7dc88Sdrh 
2156ceea3321Sdrh /*
2157f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
2158f57b3399Sdrh ** the parser and down into all the parser action routine in order to
2159f57b3399Sdrh ** carry around information that is global to the entire parse.
2160f1974846Sdrh **
2161f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
2162f1974846Sdrh ** generate call themselves recursively, the first part of the structure
2163f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
2164f1974846Sdrh ** each recursion.
2165c00da105Sdanielk1977 **
2166c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
2167c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
2168c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
2169c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
2170c00da105Sdanielk1977 ** list.
217175897234Sdrh */
217275897234Sdrh struct Parse {
21739bb575fdSdrh   sqlite3 *db;         /* The main database structure */
21744c504391Sdrh   int rc;              /* Return code from execution */
217575897234Sdrh   char *zErrMsg;       /* An error message */
217675897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
2177836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
2178e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
2179a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
2180205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
21817e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
2182892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
21832dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
2184892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
2185892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
2186892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
218775897234Sdrh   int nErr;            /* Number of errors seen */
2188832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
218919a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
2190fef5208cSdrh   int nSet;            /* Number of sets used so far */
2191aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
2192ceea3321Sdrh   int iCacheLevel;     /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
2193ceea3321Sdrh   int iCacheCnt;       /* Counter used to generate aColCache[].lru values */
2194ceea3321Sdrh   u8 nColCache;        /* Number of entries in the column cache */
2195ceea3321Sdrh   u8 iColCache;        /* Next entry of the cache to replace */
21962f7794c1Sdrh   struct yColCache {
2197e55cbd72Sdrh     int iTable;           /* Table cursor number */
2198e55cbd72Sdrh     int iColumn;          /* Table column number */
2199ceea3321Sdrh     u8 tempReg;           /* iReg is a temp register that needs to be freed */
2200ceea3321Sdrh     int iLevel;           /* Nesting level */
2201ceea3321Sdrh     int iReg;             /* Reg with value of this column. 0 means none. */
2202ceea3321Sdrh     int lru;              /* Least recently used entry has the smallest value */
2203ceea3321Sdrh   } aColCache[SQLITE_N_COLCACHE];  /* One for each column cache entry */
220464123585Sdrh   yDbMask writeMask;   /* Start a write transaction on these databases */
220564123585Sdrh   yDbMask cookieMask;  /* Bitmask of schema verified databases */
2206e0af83acSdan   u8 isMultiWrite;     /* True if statement may affect/insert multiple rows */
2207e0af83acSdan   u8 mayAbort;         /* True if statement may throw an ABORT exception */
2208fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
2209c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
2210c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2211c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
2212c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
2213c00da105Sdanielk1977 #endif
2214cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
2215cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
22160b9f50d8Sdrh   AutoincInfo *pAinc;  /* Information about AUTOINCREMENT counters */
221765a7cd16Sdan   int nMaxArg;         /* Max args passed to user function by sub-program */
2218f1974846Sdrh 
2219165921a7Sdan   /* Information used while coding trigger programs. */
222065a7cd16Sdan   Parse *pToplevel;    /* Parse structure for main program (or NULL) */
2221165921a7Sdan   Table *pTriggerTab;  /* Table triggers are being coded for */
222265a7cd16Sdan   u32 oldmask;         /* Mask of old.* columns referenced */
2223bb5f168fSdan   u32 newmask;         /* Mask of new.* columns referenced */
222465a7cd16Sdan   u8 eTriggerOp;       /* TK_UPDATE, TK_INSERT or TK_DELETE */
222565a7cd16Sdan   u8 eOrconf;          /* Default ON CONFLICT policy for trigger steps */
2226d66c8309Sdan   u8 disableTriggers;  /* True to disable triggers */
22278b307fbfSdrh   double nQueryLoop;   /* Estimated number of iterations of a query */
2228165921a7Sdan 
2229f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
2230f1974846Sdrh   ** each recursion */
2231f1974846Sdrh 
2232f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
2233124c0b49Sdrh   int nzVar;           /* Number of available slots in azVar[] */
2234124c0b49Sdrh   char **azVar;        /* Pointers to names of parameters */
2235937d0deaSdan   Vdbe *pReprepare;    /* VM being reprepared (sqlite3Reprepare()) */
22368b213899Sdrh   int nAlias;          /* Number of aliased result set columns */
2237555f8de7Sdrh   int nAliasAlloc;     /* Number of allocated slots for aAlias[] */
22388b213899Sdrh   int *aAlias;         /* Register used to hold aliased result */
2239f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
2240f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
2241f1974846Sdrh   Token sLastToken;    /* The last token parsed */
2242f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
2243f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
2244f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
2245f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
2246b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
224733b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
22487e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
22494f3dd150Sdrh   int nVtabLock;             /* Number of virtual tables to lock */
22504f3dd150Sdrh   Table **apVtabLock;        /* Pointer to virtual tables needing locking */
2251b9bb7c18Sdrh #endif
2252fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
2253588a9a1aSdrh   Table *pZombieTab;      /* List of Table objects to delete after code gen */
22542832ad42Sdan   TriggerPrg *pTriggerPrg;    /* Linked list of coded triggers */
22552ce22453Sdan 
22562ce22453Sdan #ifndef SQLITE_OMIT_EXPLAIN
22572ce22453Sdan   int iSelectId;
22582ce22453Sdan   int iNextSelectId;
22592ce22453Sdan #endif
226075897234Sdrh };
226175897234Sdrh 
22627e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
22637e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
22647e6ebfb2Sdanielk1977 #else
22657e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
22667e6ebfb2Sdanielk1977 #endif
22677e6ebfb2Sdanielk1977 
2268d99bc930Sdanielk1977 /*
226985e2096fSdrh ** An instance of the following structure can be declared on a stack and used
227085e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
227185e2096fSdrh */
227285e2096fSdrh struct AuthContext {
227385e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
227485e2096fSdrh   Parse *pParse;              /* The Parse structure */
227585e2096fSdrh };
227685e2096fSdrh 
227785e2096fSdrh /*
2278de630353Sdanielk1977 ** Bitfield flags for P5 value in OP_Insert and OP_Delete
2279b0c374ffSrdc */
22803e9ca094Sdrh #define OPFLAG_NCHANGE       0x01    /* Set to update db->nChange */
22813e9ca094Sdrh #define OPFLAG_LASTROWID     0x02    /* Set to update db->lastRowid */
22823e9ca094Sdrh #define OPFLAG_ISUPDATE      0x04    /* This OP_Insert is an sql UPDATE */
22833e9ca094Sdrh #define OPFLAG_APPEND        0x08    /* This is likely to be an append */
22843e9ca094Sdrh #define OPFLAG_USESEEKRESULT 0x10    /* Try to avoid a seek in BtreeInsert() */
22853e9ca094Sdrh #define OPFLAG_CLEARCACHE    0x20    /* Clear pseudo-table cache in OP_Column */
2286b0c374ffSrdc 
2287b0c374ffSrdc /*
2288d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
2289d99bc930Sdanielk1977  * struct Trigger.
2290d99bc930Sdanielk1977  *
2291d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
22929bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
2293d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
2294d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
2295ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
2296ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
2297ad3cab52Sdrh  *    struct Table.
2298d99bc930Sdanielk1977  *
2299ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
2300ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
2301d99bc930Sdanielk1977  */
2302d99bc930Sdanielk1977 struct Trigger {
2303165921a7Sdan   char *zName;            /* The name of the trigger                        */
2304d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
2305f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
2306dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
2307467bcf36Sshane   Expr *pWhen;            /* The WHEN clause of the expression (may be NULL) */
2308d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
2309d99bc930Sdanielk1977                              the <column-list> is stored here */
2310e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
2311e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
2312d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
2313d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
2314c3f9bad2Sdanielk1977 };
2315d99bc930Sdanielk1977 
2316d99bc930Sdanielk1977 /*
2317dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
2318dca76841Sdrh ** determine which.
2319dca76841Sdrh **
2320dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
2321dca76841Sdrh ** In that cases, the constants below can be ORed together.
2322dca76841Sdrh */
2323dca76841Sdrh #define TRIGGER_BEFORE  1
2324dca76841Sdrh #define TRIGGER_AFTER   2
2325dca76841Sdrh 
2326dca76841Sdrh /*
2327d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
2328d99bc930Sdanielk1977  * that is a part of a trigger-program.
2329d99bc930Sdanielk1977  *
2330d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
2331d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
2332d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
2333d99bc930Sdanielk1977  * the first step of the trigger-program.
2334d99bc930Sdanielk1977  *
2335d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
2336d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
2337d99bc930Sdanielk1977  * value of "op" as follows:
2338d99bc930Sdanielk1977  *
2339d99bc930Sdanielk1977  * (op == TK_INSERT)
2340d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
2341d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
2342d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
2343b7916a78Sdrh  * target    -> A token holding the quoted name of the table to insert into.
2344d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
2345d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
2346d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
2347ad3cab52Sdrh  *              statement, then this stores the column-names to be
2348ad3cab52Sdrh  *              inserted into.
2349d99bc930Sdanielk1977  *
2350d99bc930Sdanielk1977  * (op == TK_DELETE)
2351b7916a78Sdrh  * target    -> A token holding the quoted name of the table to delete from.
2352d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
2353d99bc930Sdanielk1977  *              Otherwise NULL.
2354d99bc930Sdanielk1977  *
2355d99bc930Sdanielk1977  * (op == TK_UPDATE)
2356b7916a78Sdrh  * target    -> A token holding the quoted name of the table to update rows of.
2357d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
2358d99bc930Sdanielk1977  *              Otherwise NULL.
2359d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
23604adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
2361ad3cab52Sdrh  *              argument.
2362d99bc930Sdanielk1977  *
2363d99bc930Sdanielk1977  */
2364c3f9bad2Sdanielk1977 struct TriggerStep {
2365b1819a0bSdrh   u8 op;               /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
2366b1819a0bSdrh   u8 orconf;           /* OE_Rollback etc. */
2367a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
2368b1819a0bSdrh   Select *pSelect;     /* SELECT statment or RHS of INSERT INTO .. SELECT ... */
2369b1819a0bSdrh   Token target;        /* Target table for DELETE, UPDATE, INSERT */
2370b1819a0bSdrh   Expr *pWhere;        /* The WHERE clause for DELETE or UPDATE steps */
2371b1819a0bSdrh   ExprList *pExprList; /* SET clause for UPDATE.  VALUES clause for INSERT */
2372b1819a0bSdrh   IdList *pIdList;     /* Column names for INSERT */
2373c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
2374187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
2375c3f9bad2Sdanielk1977 };
2376c3f9bad2Sdanielk1977 
2377d99bc930Sdanielk1977 /*
2378f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
2379f26e09c8Sdrh ** routines as they walk the parse tree to make database references
2380f26e09c8Sdrh ** explicit.
2381f26e09c8Sdrh */
2382f26e09c8Sdrh typedef struct DbFixer DbFixer;
2383f26e09c8Sdrh struct DbFixer {
2384f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
2385f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
2386f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
2387f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
2388f26e09c8Sdrh };
2389f26e09c8Sdrh 
2390f26e09c8Sdrh /*
2391ade86483Sdrh ** An objected used to accumulate the text of a string where we
2392ade86483Sdrh ** do not necessarily know how big the string will be in the end.
2393ade86483Sdrh */
2394ade86483Sdrh struct StrAccum {
2395633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
2396ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
2397ade86483Sdrh   char *zText;         /* The string collected so far */
2398ade86483Sdrh   int  nChar;          /* Length of the string so far */
2399ade86483Sdrh   int  nAlloc;         /* Amount of space allocated in zText */
2400bb4957f8Sdrh   int  mxAlloc;        /* Maximum allowed string length */
2401ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
2402b975598eSdrh   u8   useMalloc;      /* 0: none,  1: sqlite3DbMalloc,  2: sqlite3_malloc */
2403ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
2404ade86483Sdrh };
2405ade86483Sdrh 
2406ade86483Sdrh /*
2407234c39dfSdrh ** A pointer to this structure is used to communicate information
2408234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2409234c39dfSdrh */
2410234c39dfSdrh typedef struct {
24119bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
2412ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
2413234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
241415ca1df1Sdrh   int rc;             /* Result code stored here */
2415234c39dfSdrh } InitData;
2416234c39dfSdrh 
2417b6c29897Sdrh /*
241840257ffdSdrh ** Structure containing global configuration data for the SQLite library.
241933589797Sdrh **
242033589797Sdrh ** This structure also contains some state information.
242140257ffdSdrh */
242240257ffdSdrh struct Sqlite3Config {
2423fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
2424fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
2425fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
2426cd74b611Sdan   int bOpenUri;                     /* True to interpret filenames as URIs */
24270a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
2428633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
2429633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
2430fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
24316d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
2432bc2ca9ebSdanielk1977   sqlite3_pcache_methods pcache;    /* Low-level page-cache interface */
243340257ffdSdrh   void *pHeap;                      /* Heap storage space */
243433589797Sdrh   int nHeap;                        /* Size of pHeap[] */
243533589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
243633589797Sdrh   void *pScratch;                   /* Scratch memory */
243733589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
243833589797Sdrh   int nScratch;                     /* Number of scratch buffers */
243933589797Sdrh   void *pPage;                      /* Page cache memory */
244033589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
244133589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
24421875f7a3Sdrh   int mxParserStack;                /* maximum depth of the parser stack */
24431875f7a3Sdrh   int sharedCacheEnabled;           /* true if shared-cache mode enabled */
24441875f7a3Sdrh   /* The above might be initialized to non-zero.  The following need to always
24451875f7a3Sdrh   ** initially be zero, however. */
244671bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
2447502b4e00Sdanielk1977   int inProgress;                   /* True while initialization in progress */
2448e1ab2193Sdan   int isMutexInit;                  /* True after mutexes are initialized */
244971bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
2450e1ab2193Sdan   int isPCacheInit;                 /* True after malloc is initialized */
245171bc31c6Sdanielk1977   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
245293ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
24533f280701Sdrh   void (*xLog)(void*,int,const char*); /* Function for logging */
24543f280701Sdrh   void *pLogArg;                       /* First argument to xLog() */
245540257ffdSdrh };
245640257ffdSdrh 
245740257ffdSdrh /*
24587d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
24597d10d5a6Sdrh */
24607d10d5a6Sdrh struct Walker {
24617d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
24627d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
24637d10d5a6Sdrh   Parse *pParse;                            /* Parser context.  */
24647d10d5a6Sdrh   union {                                   /* Extra data for callback */
24657d10d5a6Sdrh     NameContext *pNC;                          /* Naming context */
24667d10d5a6Sdrh     int i;                                     /* Integer value */
24677d10d5a6Sdrh   } u;
24687d10d5a6Sdrh };
24697d10d5a6Sdrh 
24707d10d5a6Sdrh /* Forward declarations */
24717d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
24727d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
24737d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
24747d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
24757d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
24767d10d5a6Sdrh 
24777d10d5a6Sdrh /*
24787d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
24797d10d5a6Sdrh ** callbacks.
24807d10d5a6Sdrh */
24812bf90f1eSdrh #define WRC_Continue    0   /* Continue down into children */
24822bf90f1eSdrh #define WRC_Prune       1   /* Omit children but continue walking siblings */
24832bf90f1eSdrh #define WRC_Abort       2   /* Abandon the tree walk */
24847d10d5a6Sdrh 
24857d10d5a6Sdrh /*
248666150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
248766150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
24884a919118Sdrh */
24894a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
24904a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
24914a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
24924a919118Sdrh   }                                                    \
24934a919118Sdrh }
24944a919118Sdrh 
24954a919118Sdrh /*
24969978c97eSdrh ** The SQLITE_*_BKPT macros are substitutes for the error codes with
24979978c97eSdrh ** the same name but without the _BKPT suffix.  These macros invoke
24989978c97eSdrh ** routines that report the line-number on which the error originated
24999978c97eSdrh ** using sqlite3_log().  The routines also provide a convenient place
25009978c97eSdrh ** to set a debugger breakpoint.
250149285708Sdrh */
25029978c97eSdrh int sqlite3CorruptError(int);
25039978c97eSdrh int sqlite3MisuseError(int);
25049978c97eSdrh int sqlite3CantopenError(int);
25059978c97eSdrh #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
25069978c97eSdrh #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
25079978c97eSdrh #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
25089978c97eSdrh 
250949285708Sdrh 
251049285708Sdrh /*
2511b4a1fed2Sdrh ** FTS4 is really an extension for FTS3.  It is enabled using the
2512b4a1fed2Sdrh ** SQLITE_ENABLE_FTS3 macro.  But to avoid confusion we also all
2513b4a1fed2Sdrh ** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3.
2514b4a1fed2Sdrh */
2515b4a1fed2Sdrh #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
2516b4a1fed2Sdrh # define SQLITE_ENABLE_FTS3
2517b4a1fed2Sdrh #endif
2518b4a1fed2Sdrh 
2519b4a1fed2Sdrh /*
252079f02cefSdrh ** The ctype.h header is needed for non-ASCII systems.  It is also
252179f02cefSdrh ** needed by FTS3 when FTS3 is included in the amalgamation.
252279f02cefSdrh */
252379f02cefSdrh #if !defined(SQLITE_ASCII) || \
252479f02cefSdrh     (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
252579f02cefSdrh # include <ctype.h>
252679f02cefSdrh #endif
252779f02cefSdrh 
252879f02cefSdrh /*
252978ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(),
253078ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
253178ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale.
253278ca0e7eSdanielk1977 */
253378ca0e7eSdanielk1977 #ifdef SQLITE_ASCII
253478ca0e7eSdanielk1977 # define sqlite3Toupper(x)  ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
253578ca0e7eSdanielk1977 # define sqlite3Isspace(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
2536dc86e2b2Sdrh # define sqlite3Isalnum(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
2537dc86e2b2Sdrh # define sqlite3Isalpha(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
253878ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
253978ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
254078ca0e7eSdanielk1977 # define sqlite3Tolower(x)   (sqlite3UpperToLower[(unsigned char)(x)])
254178ca0e7eSdanielk1977 #else
254278ca0e7eSdanielk1977 # define sqlite3Toupper(x)   toupper((unsigned char)(x))
254378ca0e7eSdanielk1977 # define sqlite3Isspace(x)   isspace((unsigned char)(x))
254478ca0e7eSdanielk1977 # define sqlite3Isalnum(x)   isalnum((unsigned char)(x))
2545dc86e2b2Sdrh # define sqlite3Isalpha(x)   isalpha((unsigned char)(x))
254678ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   isdigit((unsigned char)(x))
254778ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  isxdigit((unsigned char)(x))
254878ca0e7eSdanielk1977 # define sqlite3Tolower(x)   tolower((unsigned char)(x))
254978ca0e7eSdanielk1977 #endif
255078ca0e7eSdanielk1977 
255178ca0e7eSdanielk1977 /*
255275897234Sdrh ** Internal function prototypes
255375897234Sdrh */
25544adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
2555ea678832Sdrh int sqlite3Strlen30(const char*);
2556ee0484c1Sdanielk1977 #define sqlite3StrNICmp sqlite3_strnicmp
25572e588c75Sdanielk1977 
255840257ffdSdrh int sqlite3MallocInit(void);
2559fec00eabSdrh void sqlite3MallocEnd(void);
2560fec00eabSdrh void *sqlite3Malloc(int);
2561fec00eabSdrh void *sqlite3MallocZero(int);
2562fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int);
2563fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int);
256417435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
256517435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
2566fec00eabSdrh void *sqlite3Realloc(void*, int);
256797c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
2568a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
2569633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
2570a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
2571633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
2572facf0307Sdrh void *sqlite3ScratchMalloc(int);
2573facf0307Sdrh void sqlite3ScratchFree(void*);
2574facf0307Sdrh void *sqlite3PageMalloc(int);
2575facf0307Sdrh void sqlite3PageFree(void*);
2576fec00eabSdrh void sqlite3MemSetDefault(void);
2577171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
257850d1b5f3Sdrh int sqlite3HeapNearlyFull(void);
25792e588c75Sdanielk1977 
2580e7b34707Sdrh /*
2581e7b34707Sdrh ** On systems with ample stack space and that support alloca(), make
2582e7b34707Sdrh ** use of alloca() to obtain space for large automatic objects.  By default,
2583e7b34707Sdrh ** obtain space from malloc().
2584e7b34707Sdrh **
2585e7b34707Sdrh ** The alloca() routine never returns NULL.  This will cause code paths
2586e7b34707Sdrh ** that deal with sqlite3StackAlloc() failures to be unreachable.
2587e7b34707Sdrh */
2588e7b34707Sdrh #ifdef SQLITE_USE_ALLOCA
2589e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   alloca(N)
2590e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  memset(alloca(N), 0, N)
2591e7b34707Sdrh # define sqlite3StackFree(D,P)
2592e7b34707Sdrh #else
2593e7b34707Sdrh # define sqlite3StackAllocRaw(D,N)   sqlite3DbMallocRaw(D,N)
2594e7b34707Sdrh # define sqlite3StackAllocZero(D,N)  sqlite3DbMallocZero(D,N)
2595e7b34707Sdrh # define sqlite3StackFree(D,P)       sqlite3DbFree(D,P)
2596e7b34707Sdrh #endif
2597e7b34707Sdrh 
2598f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS3
2599f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
2600f3d3c27aSdanielk1977 #endif
2601f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5
2602f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
2603f3d3c27aSdanielk1977 #endif
2604f3d3c27aSdanielk1977 
2605f3d3c27aSdanielk1977 
260618472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT
2607558814f8Sdan   sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
2608558814f8Sdan   sqlite3_mutex_methods const *sqlite3NoopMutex(void);
260959f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
2610d025174fSdanielk1977   int sqlite3MutexInit(void);
2611d025174fSdanielk1977   int sqlite3MutexEnd(void);
261265bbf29eSdrh #endif
26136d2ab0e4Sdanielk1977 
2614f7141990Sdrh int sqlite3StatusValue(int);
2615f7141990Sdrh void sqlite3StatusAdd(int, int);
2616f7141990Sdrh void sqlite3StatusSet(int, int);
2617f7141990Sdrh 
261885c8f291Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
26190de3ae95Sdrh   int sqlite3IsNaN(double);
262085c8f291Sdrh #else
262185c8f291Sdrh # define sqlite3IsNaN(X)  0
262285c8f291Sdrh #endif
26230de3ae95Sdrh 
2624f089aa45Sdrh void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
2625c7bc4fdeSdrh #ifndef SQLITE_OMIT_TRACE
2626c7bc4fdeSdrh void sqlite3XPrintf(StrAccum*, const char*, ...);
2627c7bc4fdeSdrh #endif
262817435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
262917435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
2630633e6d57Sdrh char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
263187cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2632e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
2633d919fe17Sdrh #endif
2634d919fe17Sdrh #if defined(SQLITE_TEST)
2635e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
263687cc3b31Sdrh #endif
2637f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...);
26384adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
263924fb627aSdrh int sqlite3Dequote(char*);
26402646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
26414adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
264280242055Sdrh void sqlite3FinishCoding(Parse*);
2643892d3179Sdrh int sqlite3GetTempReg(Parse*);
2644892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
2645892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
2646892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
2647b7916a78Sdrh Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
2648b7916a78Sdrh Expr *sqlite3Expr(sqlite3*,int,const char*);
2649b7916a78Sdrh void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
265017435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
26511e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
265217435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
2653fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
2654633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
2655b7916a78Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
2656b7916a78Sdrh void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
2657b7916a78Sdrh void sqlite3ExprListSetSpan(Parse*,ExprList*,ExprSpan*);
2658633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
26599bb575fdSdrh int sqlite3Init(sqlite3*, char**);
2660234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
266191cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
26629bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
26634adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
26649bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
26657d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
2666c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
2667f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
26684adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
26694adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
2670fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
2671ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
2672487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
2673b7916a78Sdrh void sqlite3AddDefaultValue(Parse*,ExprSpan*);
267439002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
267519a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
2676522c26fbSdrh int sqlite3ParseUri(const char*,const char*,unsigned int*,
2677522c26fbSdrh                     sqlite3_vfs**,char**,char **);
2678b7f9164eSdrh 
2679f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
2680f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
2681f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
2682e98c9049Sdrh void sqlite3BitvecClear(Bitvec*, u32, void*);
2683f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
2684bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*);
26853088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
2686f5e7bb51Sdrh 
26873d4501e5Sdrh RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
26883d4501e5Sdrh void sqlite3RowSetClear(RowSet*);
26893d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64);
2690733bf1b1Sdrh int sqlite3RowSetTest(RowSet*, u8 iBatch, i64);
26913d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*);
26923d4501e5Sdrh 
2693fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
2694fe3fcbe2Sdanielk1977 
2695fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
26964adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
2697b7f9164eSdrh #else
2698b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
2699b7f9164eSdrh #endif
2700b7f9164eSdrh 
2701a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
27021feeaed2Sdan void sqlite3DeleteTable(sqlite3*, Table*);
27030b9f50d8Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT
27040b9f50d8Sdrh   void sqlite3AutoincrementBegin(Parse *pParse);
27050b9f50d8Sdrh   void sqlite3AutoincrementEnd(Parse *pParse);
27060b9f50d8Sdrh #else
27070b9f50d8Sdrh # define sqlite3AutoincrementBegin(X)
27080b9f50d8Sdrh # define sqlite3AutoincrementEnd(X)
27090b9f50d8Sdrh #endif
27104adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
271117435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
271217435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
27134adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
2714a78c22c4Sdrh SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
271517435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
2716b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
271785574e31Sdanielk1977                                       Token*, Select*, Expr*, IdList*);
2718b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
2719b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
272061dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
27214adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
2722633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
2723633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
27241da40a38Sdan Index *sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
27254d91a701Sdrh                         Token*, int, int);
27264d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
27277d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
272817435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
272917435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
2730633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
27314adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
27324adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
2733c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
2734273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
273549ffdbf4Sshane Expr *sqlite3LimitWhere(Parse *, SrcList *, Expr *, ExprList *, Expr *, Expr *, char *);
27364281bd42Sshane #endif
27374adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
27384adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
2739336a5300Sdrh WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u16);
27404adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
2741b6da74ebSdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int);
27425c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
2743b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
274492b01d53Sdrh void sqlite3ExprCodeCopy(Parse*, int, int, int);
2745ceea3321Sdrh void sqlite3ExprCacheStore(Parse*, int, int, int);
2746ceea3321Sdrh void sqlite3ExprCachePush(Parse*);
2747ceea3321Sdrh void sqlite3ExprCachePop(Parse*, int);
2748f49f3523Sdrh void sqlite3ExprCacheRemove(Parse*, int, int);
2749ceea3321Sdrh void sqlite3ExprCacheClear(Parse*);
2750da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
2751389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
27522dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
2753678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
27542dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
2755678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*);
2756191b54cbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
27574adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
27584adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
27599bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
2760ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
27619bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
27629bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
27639bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
276474161705Sdrh void sqlite3Vacuum(Parse*);
27659bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
276617435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
27674adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
27688c6f666bSdrh int sqlite3ExprListCompare(ExprList*, ExprList*);
2769d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2770d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
27714adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
27722fa1868fSdrh void sqlite3PrngSaveState(void);
27732fa1868fSdrh void sqlite3PrngRestoreState(void);
27742fa1868fSdrh void sqlite3PrngResetState(void);
27759bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
27764adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
277757966753Sdan void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
2778684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
27794adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
27804adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
2781fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*);
2782fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *);
27834adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
27840a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
2785eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
27864adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
2787039fc32eSdrh int sqlite3ExprCanBeNull(const Expr*);
27882f2855b6Sdrh void sqlite3ExprCodeIsNullJump(Vdbe*, const Expr*, int, int);
2789039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
27904adee20fSdanielk1977 int sqlite3IsRowid(const char*);
27912283d46cSdan void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int, Trigger *, int);
27922d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
2793e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
279404adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
2795de630353Sdanielk1977                                      int*,int,int,int,int,int*);
27962832ad42Sdan void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int);
2797aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
27984adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
2799ff738bceSdrh void sqlite3MultiWrite(Parse*);
2800e0af83acSdan void sqlite3MayAbort(Parse*);
2801e0af83acSdan void sqlite3HaltConstraint(Parse*, int, char*, int);
28026ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
28036ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
28046ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
280517435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
28066ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int);
280770a8ca3cSdrh void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
28089bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
28099bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
2810777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
281170a8ca3cSdrh void sqlite3RegisterGlobalFunctions(void);
28127e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
28137e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
28149cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
2815fa4e62f3Sshane 
2816fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
28172a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
2818fa4e62f3Sshane #endif
2819b7f9164eSdrh 
2820b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
2821ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
282260218d2aSdrh                            Expr*,int, int);
28234adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
2824fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
282574161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
28262f886d1dSdanielk1977   Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
28272f886d1dSdanielk1977   Trigger *sqlite3TriggerList(Parse *, Table *);
2828165921a7Sdan   void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
282994d7f50aSdan                             int, int, int);
28301da40a38Sdan   void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
2831dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
2832633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
283317435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
283417435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
28355eff7cf0Sshane                                         ExprList*,Select*,u8);
28365eff7cf0Sshane   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8);
283717435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
2838633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
2839b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2840bb5f168fSdan   u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
284165a7cd16Sdan # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
2842b7f9164eSdrh #else
284362c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0
2844633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
2845cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
2846b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
284794d7f50aSdan # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
284875cbd984Sdan # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
28492943c372Sdanielk1977 # define sqlite3TriggerList(X, Y) 0
285065a7cd16Sdan # define sqlite3ParseToplevel(p) p
2851bb5f168fSdan # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
2852b7f9164eSdrh #endif
2853b7f9164eSdrh 
28544adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
28550202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
28564adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
2857ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
2858728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
28594adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
28604adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
28614adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
286202470b20Sdan   int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
2863ed6c8671Sdrh #else
2864b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
28654adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
28664adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
28674adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
2868ed6c8671Sdrh #endif
2869f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2870f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
28714adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
28724adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
28734adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
28744adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
28754adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
28764adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
28779339da1fSdrh int sqlite3AtoF(const char *z, double*, int, u8);
2878fec19aadSdrh int sqlite3GetInt32(const char *, int*);
287960ac3f42Sdrh int sqlite3Atoi(const char*);
2880ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
2881ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
2882*0a32fa6dSdrh u32 sqlite3Utf8Read(const u8*, const u8**);
28833f8d5cfcSshane 
28843f8d5cfcSshane /*
28853f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
28863f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
2887952856adSshane ** file.  Code should use the MACRO forms below, as the Varint32 versions
2888952856adSshane ** are coded to assume the single byte case is already handled (which
2889952856adSshane ** the MACRO form does).
28903f8d5cfcSshane */
2891192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
289235b5a33eSdrh int sqlite3PutVarint32(unsigned char*, u32);
28931bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *);
28941bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *);
2895192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
28963f8d5cfcSshane 
28973f8d5cfcSshane /*
28983f8d5cfcSshane ** The header of a record consists of a sequence variable-length integers.
28993f8d5cfcSshane ** These integers are almost always small and are encoded as a single byte.
29003f8d5cfcSshane ** The following macros take advantage this fact to provide a fast encode
29013f8d5cfcSshane ** and decode of the integers in a record header.  It is faster for the common
29023f8d5cfcSshane ** case where the integer is a single byte.  It is a little slower when the
29033f8d5cfcSshane ** integer is two or more bytes.  But overall it is faster.
29043f8d5cfcSshane **
29053f8d5cfcSshane ** The following expressions are equivalent:
29063f8d5cfcSshane **
29073f8d5cfcSshane **     x = sqlite3GetVarint32( A, &B );
29083f8d5cfcSshane **     x = sqlite3PutVarint32( A, B );
29093f8d5cfcSshane **
29103f8d5cfcSshane **     x = getVarint32( A, B );
29113f8d5cfcSshane **     x = putVarint32( A, B );
29123f8d5cfcSshane **
29133f8d5cfcSshane */
29141bd10f8aSdrh #define getVarint32(A,B)  (u8)((*(A)<(u8)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), (u32 *)&(B)))
29151bd10f8aSdrh #define putVarint32(A,B)  (u8)(((u32)(B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
29163f8d5cfcSshane #define getVarint    sqlite3GetVarint
29173f8d5cfcSshane #define putVarint    sqlite3PutVarint
29183f8d5cfcSshane 
29193f8d5cfcSshane 
292069f8bb9cSdan const char *sqlite3IndexAffinityStr(Vdbe *, Index *);
2921a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
2922e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
2923e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
2924bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
29259339da1fSdrh int sqlite3Atoi64(const char*, i64*, int, u8);
29269bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
2927ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
2928cd74b611Sdan u8 sqlite3HexToInt(int h);
2929ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
2930f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
29318a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
2932c4a64facSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
2933c4a64facSdrh CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
29347cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
29358342e49fSdrh Expr *sqlite3ExprSetColl(Expr*, CollSeq*);
29368342e49fSdrh Expr *sqlite3ExprSetCollByToken(Parse *pParse, Expr*, Token*);
29377cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2938d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2939b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
2940158b9cb9Sdrh int sqlite3AddInt64(i64*,i64);
2941158b9cb9Sdrh int sqlite3SubInt64(i64*,i64);
2942158b9cb9Sdrh int sqlite3MulInt64(i64*,i64);
2943d50ffc41Sdrh int sqlite3AbsInt32(int);
294481cc5163Sdrh #ifdef SQLITE_ENABLE_8_3_NAMES
294581cc5163Sdrh void sqlite3FileSuffix3(const char*, char*);
294681cc5163Sdrh #else
294781cc5163Sdrh # define sqlite3FileSuffix3(X,Y)
294881cc5163Sdrh #endif
294981cc5163Sdrh u8 sqlite3GetBoolean(const char *z);
29504e6af134Sdanielk1977 
2951b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2952b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2953b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
29541e536953Sdanielk1977                         void(*)(void*));
29554e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
29561e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
2957b7dca7d7Sdan char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
295869188d9aSdan #ifdef SQLITE_ENABLE_STAT2
2959cea72b2dSshane char *sqlite3Utf8to16(sqlite3 *, u8, char *, int, int *);
296069188d9aSdan #endif
29611e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2962b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
296346c99e0fSdrh #ifndef SQLITE_AMALGAMATION
2964a6c2ed91Sdrh extern const unsigned char sqlite3OpcodeProperty[];
29654e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
296678ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[];
2967094430ebSdrh extern const Token sqlite3IntTokens[];
2968075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
2969075c23afSdanielk1977 extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
2970f83dc1efSdrh #ifndef SQLITE_OMIT_WSD
2971ddb68e17Sdrh extern int sqlite3PendingByte;
297246c99e0fSdrh #endif
2973f83dc1efSdrh #endif
2974cdf011dcSdrh void sqlite3RootPageMoved(sqlite3*, int, int, int);
29754343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
2976545f587fSdrh void sqlite3AlterFunctions(void);
29779fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
29789fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
29792958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2980d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
29811450bc6eSdrh int sqlite3CodeSubselect(Parse *, Expr *, int, int);
29827d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
29837d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
29847d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
29857d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
2986c7538b5fSdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
298719a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
298819a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
2989cea72b2dSshane CollSeq *sqlite3GetCollSeq(sqlite3*, u8, CollSeq *, const char*);
2990b7916a78Sdrh char sqlite3AffinityType(const char*);
29919f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2992a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2993ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
29940410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *);
2995cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
2996d46def77Sdan void sqlite3DeleteIndexSamples(sqlite3*,Index*);
299751147baaSdrh void sqlite3DefaultRowEst(Index*);
299855ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2999d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
3000fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
3001b6ee6607Sdrh void sqlite3SchemaClear(void *);
30021e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
3003e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
3004b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
3005771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
3006771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
3007d2199f0fSdan   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
3008d2199f0fSdan   FuncDestructor *pDestructor
3009d2199f0fSdan );
301054f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
3011ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
301269dab1d3Sdrh 
3013f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int);
3014ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
3015ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
3016ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
30171013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
3018f7b0b0adSdan Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
30191e536953Sdanielk1977 
30200410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *);
30210410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
30220410302eSdanielk1977 
302395bdbbbdSdrh /*
302495bdbbbdSdrh ** The interface to the LEMON-generated parser
302595bdbbbdSdrh */
302695bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
302795bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
302895bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
3029ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
3030ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
3031ec424a5bSdrh #endif
303295bdbbbdSdrh 
30337aaa8786Sdrh void sqlite3AutoLoadExtensions(sqlite3*);
303469dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
3035f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
303669dab1d3Sdrh #else
303769dab1d3Sdrh # define sqlite3CloseExtensions(X)
303869dab1d3Sdrh #endif
3039e3026636Sdanielk1977 
3040c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
3041c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
3042c00da105Sdanielk1977 #else
3043c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
3044c00da105Sdanielk1977 #endif
3045c00da105Sdanielk1977 
304653c14021Sdrh #ifdef SQLITE_TEST
304753c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
304853c14021Sdrh #endif
304953c14021Sdrh 
3050b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
3051595a523aSdanielk1977 #  define sqlite3VtabClear(Y)
30529dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
3053f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
3054f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
3055093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) 0
3056595a523aSdanielk1977 #  define sqlite3VtabLock(X)
3057595a523aSdanielk1977 #  define sqlite3VtabUnlock(X)
3058595a523aSdanielk1977 #  define sqlite3VtabUnlockList(X)
3059a311b803Sdan #  define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
3060b9bb7c18Sdrh #else
30611feeaed2Sdan    void sqlite3VtabClear(sqlite3 *db, Table*);
30623e3a84d3Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, char **);
3063f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
3064f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
3065595a523aSdanielk1977    void sqlite3VtabLock(VTable *);
3066595a523aSdanielk1977    void sqlite3VtabUnlock(VTable *);
3067595a523aSdanielk1977    void sqlite3VtabUnlockList(sqlite3*);
3068a311b803Sdan    int sqlite3VtabSavepoint(sqlite3 *, int, int);
3069093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
3070b9bb7c18Sdrh #endif
30714f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
3072b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
3073b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
3074b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
3075b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
307678efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
30777e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
30789e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
3079595a523aSdanielk1977 int sqlite3VtabBegin(sqlite3 *, VTable *);
30801e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
3081b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
30825f18a221Sdrh int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
30834a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
3084b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
3085b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
3086bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
30871c514148Sdrh int sqlite3TempInMemory(const sqlite3*);
3088595a523aSdanielk1977 VTable *sqlite3GetVTable(sqlite3*, Table*);
308928e5386fSdan const char *sqlite3JournalModename(int);
3090cdc1f049Sdan int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
3091b033d8b9Sdrh int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
3092d829335eSdanielk1977 
309375cbd984Sdan /* Declarations for functions in fkey.c. All of these are replaced by
309475cbd984Sdan ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
309575cbd984Sdan ** key functionality is available. If OMIT_TRIGGER is defined but
309675cbd984Sdan ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
309775cbd984Sdan ** this case foreign keys are parsed, but no other functionality is
309875cbd984Sdan ** provided (enforcement of FK constraints requires the triggers sub-system).
309975cbd984Sdan */
310075cbd984Sdan #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
3101e7a94d81Sdan   void sqlite3FkCheck(Parse*, Table*, int, int);
3102d66c8309Sdan   void sqlite3FkDropTable(Parse*, SrcList *, Table*);
31031da40a38Sdan   void sqlite3FkActions(Parse*, Table*, ExprList*, int);
3104e7a94d81Sdan   int sqlite3FkRequired(Parse*, Table*, int*, int);
3105e7a94d81Sdan   u32 sqlite3FkOldmask(Parse*, Table*);
3106432cc5b9Sdan   FKey *sqlite3FkReferences(Table *);
31071da40a38Sdan #else
31081da40a38Sdan   #define sqlite3FkActions(a,b,c,d)
3109e7a94d81Sdan   #define sqlite3FkCheck(a,b,c,d)
3110d66c8309Sdan   #define sqlite3FkDropTable(a,b,c)
3111e7a94d81Sdan   #define sqlite3FkOldmask(a,b)      0
3112e7a94d81Sdan   #define sqlite3FkRequired(a,b,c,d) 0
31131da40a38Sdan #endif
311475cbd984Sdan #ifndef SQLITE_OMIT_FOREIGN_KEY
31151feeaed2Sdan   void sqlite3FkDelete(sqlite3 *, Table*);
311675cbd984Sdan #else
31171feeaed2Sdan   #define sqlite3FkDelete(a,b)
311875cbd984Sdan #endif
311975cbd984Sdan 
3120643167ffSdrh 
3121643167ffSdrh /*
3122643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
3123643167ffSdrh */
3124643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
31257e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
3126643167ffSdrh 
3127643167ffSdrh /*
3128ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
3129ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
3130ef05f2dfSdanielk1977 ** is not defined.
3131643167ffSdrh */
31323088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
31332d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
31342d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
3135643167ffSdrh #else
31362d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
3137867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
3138643167ffSdrh #endif
3139643167ffSdrh 
31409a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
31419a96b668Sdanielk1977 #define IN_INDEX_EPH             2
31429a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
31430cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int*);
31449a96b668Sdanielk1977 
3145c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
3146c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
3147c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
3148f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
3149c7b6017cSdanielk1977 #else
3150c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
3151c7b6017cSdanielk1977 #endif
3152c7b6017cSdanielk1977 
3153b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *);
31543a5990abSdrh int sqlite3MemJournalSize(void);
3155b3175389Sdanielk1977 int sqlite3IsMemJournal(sqlite3_file *);
3156b3175389Sdanielk1977 
31570224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
31584b5255acSdanielk1977   void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
3159fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
31607d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
3161fc976065Sdanielk1977 #else
31624b5255acSdanielk1977   #define sqlite3ExprSetHeight(x,y)
31630224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
31647d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
3165fc976065Sdanielk1977 #endif
3166fc976065Sdanielk1977 
3167a3152895Sdrh u32 sqlite3Get4byte(const u8*);
3168a3152895Sdrh void sqlite3Put4byte(u8*, u32);
3169a3152895Sdrh 
3170404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
3171404ca075Sdanielk1977   void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
3172404ca075Sdanielk1977   void sqlite3ConnectionUnlocked(sqlite3 *db);
3173404ca075Sdanielk1977   void sqlite3ConnectionClosed(sqlite3 *db);
3174404ca075Sdanielk1977 #else
3175404ca075Sdanielk1977   #define sqlite3ConnectionBlocked(x,y)
3176404ca075Sdanielk1977   #define sqlite3ConnectionUnlocked(x)
3177404ca075Sdanielk1977   #define sqlite3ConnectionClosed(x)
3178404ca075Sdanielk1977 #endif
3179404ca075Sdanielk1977 
31806e736838Sdrh #ifdef SQLITE_DEBUG
31816e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
31826e736838Sdrh #endif
31836e736838Sdrh 
3184b0603416Sdrh /*
3185b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
31863a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
3187b0603416Sdrh ** print I/O tracing messages.
3188b0603416Sdrh */
3189b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
31903a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
3191b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
3192e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
3193b0603416Sdrh #else
3194b0603416Sdrh # define IOTRACE(A)
3195b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
3196b0603416Sdrh #endif
3197b0603416Sdrh 
3198107b56e8Sdrh /*
3199107b56e8Sdrh ** These routines are available for the mem2.c debugging memory allocator
3200107b56e8Sdrh ** only.  They are used to verify that different "types" of memory
3201107b56e8Sdrh ** allocations are properly tracked by the system.
3202107b56e8Sdrh **
3203107b56e8Sdrh ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
3204107b56e8Sdrh ** the MEMTYPE_* macros defined below.  The type must be a bitmask with
3205107b56e8Sdrh ** a single bit set.
3206107b56e8Sdrh **
3207107b56e8Sdrh ** sqlite3MemdebugHasType() returns true if any of the bits in its second
3208107b56e8Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
3209107b56e8Sdrh ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
3210107b56e8Sdrh **
3211174b9a16Sdrh ** sqlite3MemdebugNoType() returns true if none of the bits in its second
3212174b9a16Sdrh ** argument match the type set by the previous sqlite3MemdebugSetType().
3213107b56e8Sdrh **
3214107b56e8Sdrh ** Perhaps the most important point is the difference between MEMTYPE_HEAP
3215174b9a16Sdrh ** and MEMTYPE_LOOKASIDE.  If an allocation is MEMTYPE_LOOKASIDE, that means
3216174b9a16Sdrh ** it might have been allocated by lookaside, except the allocation was
3217174b9a16Sdrh ** too large or lookaside was already full.  It is important to verify
3218174b9a16Sdrh ** that allocations that might have been satisfied by lookaside are not
3219174b9a16Sdrh ** passed back to non-lookaside free() routines.  Asserts such as the
3220174b9a16Sdrh ** example above are placed on the non-lookaside free() routines to verify
3221174b9a16Sdrh ** this constraint.
3222107b56e8Sdrh **
3223107b56e8Sdrh ** All of this is no-op for a production build.  It only comes into
3224107b56e8Sdrh ** play when the SQLITE_MEMDEBUG compile-time option is used.
3225107b56e8Sdrh */
3226107b56e8Sdrh #ifdef SQLITE_MEMDEBUG
3227107b56e8Sdrh   void sqlite3MemdebugSetType(void*,u8);
3228107b56e8Sdrh   int sqlite3MemdebugHasType(void*,u8);
3229174b9a16Sdrh   int sqlite3MemdebugNoType(void*,u8);
3230107b56e8Sdrh #else
3231107b56e8Sdrh # define sqlite3MemdebugSetType(X,Y)  /* no-op */
3232107b56e8Sdrh # define sqlite3MemdebugHasType(X,Y)  1
3233174b9a16Sdrh # define sqlite3MemdebugNoType(X,Y)   1
3234e3026636Sdanielk1977 #endif
3235107b56e8Sdrh #define MEMTYPE_HEAP       0x01  /* General heap allocations */
3236174b9a16Sdrh #define MEMTYPE_LOOKASIDE  0x02  /* Might have been lookaside memory */
3237107b56e8Sdrh #define MEMTYPE_SCRATCH    0x04  /* Scratch allocations */
3238107b56e8Sdrh #define MEMTYPE_PCACHE     0x08  /* Page cache allocations */
3239174b9a16Sdrh #define MEMTYPE_DB         0x10  /* Uses sqlite3DbMalloc, not sqlite_malloc */
3240107b56e8Sdrh 
3241107b56e8Sdrh #endif /* _SQLITEINT_H_ */
3242