xref: /sqlite-3.40.0/src/sqliteInt.h (revision e63d9991)
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 **
14*e63d9991Sdrh ** @(#) $Id: sqliteInt.h,v 1.755 2008/08/13 19:11:48 drh Exp $
1575897234Sdrh */
16e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
17e3026636Sdanielk1977 #define _SQLITEINT_H_
1871674ce9Sdrh 
19bd0ae111Smlcreech /*
201e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
211e12d43bSmlcreech ** autoconf-based build
22bd0ae111Smlcreech */
231e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H
2498dc4b1aSmlcreech #include "config.h"
251e12d43bSmlcreech #endif
261e12d43bSmlcreech 
27bb4957f8Sdrh #include "sqliteLimit.h"
2898dc4b1aSmlcreech 
29e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
30e2965827Sdrh #if defined(__BORLANDC__)
31e2965827Sdrh #pragma warn -rch /* unreachable code */
32e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
33e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
34e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
35e2965827Sdrh #pragma warn -spa /* Suspicous pointer arithmetic */
36e2965827Sdrh #endif
37e2965827Sdrh 
3898dc4b1aSmlcreech /* Needed for various definitions... */
3960323418Sdrh #ifndef _GNU_SOURCE
4098dc4b1aSmlcreech # define _GNU_SOURCE
4160323418Sdrh #endif
4298dc4b1aSmlcreech 
4398dc4b1aSmlcreech /*
4406af763eSdrh ** Include standard header files as necessary
4506af763eSdrh */
4606af763eSdrh #ifdef HAVE_STDINT_H
4706af763eSdrh #include <stdint.h>
4806af763eSdrh #endif
4906af763eSdrh #ifdef HAVE_INTTYPES_H
5006af763eSdrh #include <inttypes.h>
5106af763eSdrh #endif
5206af763eSdrh 
5306af763eSdrh /*
54c5499befSdrh ** A macro used to aid in coverage testing.  When doing coverage
55c5499befSdrh ** testing, the condition inside the argument must be evaluated
56c5499befSdrh ** both true and false in order to get full branch coverage.
57c5499befSdrh ** This macro can be inserted to ensure adequate test coverage
58c5499befSdrh ** in places where simple condition/decision coverage is inadequate.
59c5499befSdrh */
60c5499befSdrh #ifdef SQLITE_COVERAGE_TEST
61c5499befSdrh   void sqlite3Coverage(int);
62c5499befSdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
63c5499befSdrh #else
64c5499befSdrh # define testcase(X)
65c5499befSdrh #endif
66c5499befSdrh 
6722c2403aSdrh /*
6834004cebSdrh ** The ALWAYS and NEVER macros surround boolean expressions which
6934004cebSdrh ** are intended to always be true or false, respectively.  Such
7034004cebSdrh ** expressions could be omitted from the code completely.  But they
7134004cebSdrh ** are included in a few cases in order to enhance the resilience
7234004cebSdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
7334004cebSdrh ** or "ductile" rather than being "brittle" and crashing at the first
7434004cebSdrh ** hint of unplanned behavior.
7522c2403aSdrh **
7634004cebSdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
7734004cebSdrh ** be true and false so that the unreachable code then specify will
7834004cebSdrh ** not be counted as untested code.
7922c2403aSdrh */
8022c2403aSdrh #ifdef SQLITE_COVERAGE_TEST
8134004cebSdrh # define ALWAYS(X)      (1)
8234004cebSdrh # define NEVER(X)       (0)
8322c2403aSdrh #else
8434004cebSdrh # define ALWAYS(X)      (X)
8534004cebSdrh # define NEVER(X)       (X)
8622c2403aSdrh #endif
8798dc4b1aSmlcreech 
8871674ce9Sdrh /*
89b6dbc000Sdrh ** The macro unlikely() is a hint that surrounds a boolean
90b6dbc000Sdrh ** expression that is usually false.  Macro likely() surrounds
91b6dbc000Sdrh ** a boolean expression that is usually true.  GCC is able to
92b6dbc000Sdrh ** use these hints to generate better code, sometimes.
93b6dbc000Sdrh */
944bbf464fSdrh #if defined(__GNUC__) && 0
95b6dbc000Sdrh # define likely(X)    __builtin_expect((X),1)
96b6dbc000Sdrh # define unlikely(X)  __builtin_expect((X),0)
97b6dbc000Sdrh #else
98b6dbc000Sdrh # define likely(X)    !!(X)
99b6dbc000Sdrh # define unlikely(X)  !!(X)
100b6dbc000Sdrh #endif
101b6dbc000Sdrh 
1021fc4129dSshane /*
1031fc4129dSshane  * This macro is used to "hide" some ugliness in casting an int
1041fc4129dSshane  * value to a ptr value under the MSVC 64-bit compiler.   Casting
1051fc4129dSshane  * non 64-bit values to ptr types results in a "hard" error with
1061fc4129dSshane  * the MSVC 64-bit compiler which this attempts to avoid.
1071fc4129dSshane  *
1081fc4129dSshane  * A simple compiler pragma or casting sequence could not be found
1091fc4129dSshane  * to correct this in all situations, so this macro was introduced.
1101fc4129dSshane  *
1111fc4129dSshane  * It could be argued that the intptr_t type could be used in this
1121fc4129dSshane  * case, but that type is not available on all compilers, or
1131fc4129dSshane  * requires the #include of specific headers which differs between
1141fc4129dSshane  * platforms.
1151fc4129dSshane  */
1161fc4129dSshane #define SQLITE_INT_TO_PTR(X)   ((void*)&((char*)0)[X])
1171fc4129dSshane #define SQLITE_PTR_TO_INT(X)   ((int)(((char*)X)-(char*)0))
118b6dbc000Sdrh 
119b6dbc000Sdrh /*
12071674ce9Sdrh ** These #defines should enable >2GB file support on Posix if the
12171674ce9Sdrh ** underlying operating system supports it.  If the OS lacks
12271674ce9Sdrh ** large file support, or if the OS is windows, these should be no-ops.
12371674ce9Sdrh **
12471674ce9Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
12571674ce9Sdrh ** system #includes.  Hence, this block of code must be the very first
12671674ce9Sdrh ** code in all source files.
12771674ce9Sdrh **
12871674ce9Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
12971674ce9Sdrh ** on the compiler command line.  This is necessary if you are compiling
13071674ce9Sdrh ** on a recent machine (ex: RedHat 7.2) but you want your code to work
13171674ce9Sdrh ** on an older machine (ex: RedHat 6.0).  If you compile on RedHat 7.2
13271674ce9Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
13371674ce9Sdrh ** in RedHat 6.0, so the code won't work.  Hence, for maximum binary
13471674ce9Sdrh ** portability you should omit LFS.
13571674ce9Sdrh **
13671674ce9Sdrh ** Similar is true for MacOS.  LFS is only supported on MacOS 9 and later.
13771674ce9Sdrh */
13871674ce9Sdrh #ifndef SQLITE_DISABLE_LFS
13971674ce9Sdrh # define _LARGE_FILE       1
14071674ce9Sdrh # ifndef _FILE_OFFSET_BITS
14171674ce9Sdrh #   define _FILE_OFFSET_BITS 64
14271674ce9Sdrh # endif
14371674ce9Sdrh # define _LARGEFILE_SOURCE 1
14471674ce9Sdrh #endif
14571674ce9Sdrh 
14671674ce9Sdrh 
147e5e7a901Sdrh /*
148e5e7a901Sdrh ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
149e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
150e5e7a901Sdrh ** We support that for legacy
151e5e7a901Sdrh */
152e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
153e5e7a901Sdrh #if defined(THREADSAFE)
154e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE
155e5e7a901Sdrh #else
156e5e7a901Sdrh # define SQLITE_THREADSAFE 1
157e5e7a901Sdrh #endif
158e5e7a901Sdrh #endif
159e5e7a901Sdrh 
16067080617Sdrh /*
1610d18020bSdrh ** Exactly one of the following macros must be defined in order to
1620d18020bSdrh ** specify which memory allocation subsystem to use.
1630d18020bSdrh **
1640d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
1650d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
1660d18020bSdrh **     SQLITE_MEMORY_SIZE            // internal allocator #1
1670d18020bSdrh **     SQLITE_MMAP_HEAP_SIZE         // internal mmap() allocator
1680d18020bSdrh **     SQLITE_POW2_MEMORY_SIZE       // internal power-of-two allocator
1690d18020bSdrh **
1700d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
1710d18020bSdrh ** the default.
1720d18020bSdrh */
1730d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1740d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1750d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)>1
1760d18020bSdrh # error "At most one of the following compile-time configuration options\
1770d18020bSdrh  is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
1780d18020bSdrh  SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
1790d18020bSdrh #endif
1800d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1810d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1820d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)==0
1830d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
1840d18020bSdrh #endif
1850d18020bSdrh 
1860d18020bSdrh /*
187eee4c8caSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
188eee4c8caSdrh ** sizes of memory allocations below this value where possible.
189eee4c8caSdrh */
190eee4c8caSdrh #if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
191eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
192eee4c8caSdrh #endif
193eee4c8caSdrh 
194eee4c8caSdrh /*
19567080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
19667080617Sdrh ** recursive mutexes on most unix systems.  But Mac OS X is different.
19767080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
19867080617Sdrh ** so it is omitted there.  See ticket #2673.
199e5e7a901Sdrh **
200e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
201e5e7a901Sdrh ** implemented on some systems.  So we avoid defining it at all
202e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are
203e5e7a901Sdrh ** not doing a threadsafe build.  Ticket #2681.
2049e0ebbfaSdrh **
2059e0ebbfaSdrh ** See also ticket #2741.
20667080617Sdrh */
207ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
208058897a9Sdrh #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
20967080617Sdrh #endif
210e3026636Sdanielk1977 
2114f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
2124f0c5878Sdrh # include <tcl.h>
213824d7c18Sdrh #endif
214824d7c18Sdrh 
215824d7c18Sdrh /*
2164b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
217b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
2184b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
2194b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
2204b529d97Sdrh ** feature.
2214b529d97Sdrh */
222289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
2234b529d97Sdrh # define NDEBUG 1
2244b529d97Sdrh #endif
2254b529d97Sdrh 
2261d482dd9Sdrh #include "sqlite3.h"
227beae3194Sdrh #include "hash.h"
22875897234Sdrh #include "parse.h"
22975897234Sdrh #include <stdio.h>
23075897234Sdrh #include <stdlib.h>
23175897234Sdrh #include <string.h>
23275897234Sdrh #include <assert.h>
23352370e2cSdrh #include <stddef.h>
23475897234Sdrh 
235967e8b73Sdrh /*
236b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
237b37df7b9Sdrh ** substitute integer for floating-point
238b37df7b9Sdrh */
239b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
240b37df7b9Sdrh # define double sqlite_int64
241b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
242d1167393Sdrh # ifndef SQLITE_BIG_DBL
243b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
244d1167393Sdrh # endif
245b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
246b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
247110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
248b37df7b9Sdrh #endif
249d1167393Sdrh #ifndef SQLITE_BIG_DBL
250d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
251d1167393Sdrh #endif
252b37df7b9Sdrh 
253b37df7b9Sdrh /*
25453c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
25553c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
25653c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
25753c0f748Sdanielk1977 */
25853c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
25953c0f748Sdanielk1977 #define OMIT_TEMPDB 1
26053c0f748Sdanielk1977 #else
26153c0f748Sdanielk1977 #define OMIT_TEMPDB 0
26253c0f748Sdanielk1977 #endif
26353c0f748Sdanielk1977 
26453c0f748Sdanielk1977 /*
2650bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
2660bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
2670bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
2680bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
2690bd1f4eaSdrh ** is the way things are suppose to work.
2700bd1f4eaSdrh **
2710bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
2720bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
2730bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
2740bd1f4eaSdrh ** work.
2750bd1f4eaSdrh */
2760bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
2770bd1f4eaSdrh 
2780bd1f4eaSdrh /*
279d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
280d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
281d946db00Sdrh ** the default file format for new databases and the maximum file format
282d946db00Sdrh ** that the library can read.
283d946db00Sdrh */
284d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
285d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
28676fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
287d946db00Sdrh #endif
288d946db00Sdrh 
289d946db00Sdrh /*
290b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
29149766d6cSdrh ** on the command-line
29249766d6cSdrh */
293b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
294b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
29549766d6cSdrh #endif
29649766d6cSdrh 
29749766d6cSdrh /*
298f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
299f1974846Sdrh ** ourselves.
300f1974846Sdrh */
301f1974846Sdrh #ifndef offsetof
302f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
303f1974846Sdrh #endif
304f1974846Sdrh 
305f1974846Sdrh /*
3069b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
3079b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
3089b8f447bSdrh */
3099b8f447bSdrh #if 'A' == '\301'
3109b8f447bSdrh # define SQLITE_EBCDIC 1
3119b8f447bSdrh #else
3129b8f447bSdrh # define SQLITE_ASCII 1
3139b8f447bSdrh #endif
3149b8f447bSdrh 
3159b8f447bSdrh /*
3165a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
3175a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
3185a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
3195a2c2c20Sdrh **
3205a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
32141a2b48bSdrh */
3225a2c2c20Sdrh #ifndef UINT32_TYPE
323dda5b68cSmlcreech # ifdef HAVE_UINT32_T
324dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
325dda5b68cSmlcreech # else
3265a2c2c20Sdrh #  define UINT32_TYPE unsigned int
3275a2c2c20Sdrh # endif
328dda5b68cSmlcreech #endif
3295a2c2c20Sdrh #ifndef UINT16_TYPE
330dda5b68cSmlcreech # ifdef HAVE_UINT16_T
331dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
332dda5b68cSmlcreech # else
3335a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
3345a2c2c20Sdrh # endif
335dda5b68cSmlcreech #endif
336939a16d6Sdrh #ifndef INT16_TYPE
337dda5b68cSmlcreech # ifdef HAVE_INT16_T
338dda5b68cSmlcreech #  define INT16_TYPE int16_t
339dda5b68cSmlcreech # else
340939a16d6Sdrh #  define INT16_TYPE short int
341939a16d6Sdrh # endif
342dda5b68cSmlcreech #endif
3435a2c2c20Sdrh #ifndef UINT8_TYPE
344dda5b68cSmlcreech # ifdef HAVE_UINT8_T
345dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
346dda5b68cSmlcreech # else
3475a2c2c20Sdrh #  define UINT8_TYPE unsigned char
3485a2c2c20Sdrh # endif
349dda5b68cSmlcreech #endif
350905793e2Sdrh #ifndef INT8_TYPE
351dda5b68cSmlcreech # ifdef HAVE_INT8_T
352dda5b68cSmlcreech #  define INT8_TYPE int8_t
353dda5b68cSmlcreech # else
354905793e2Sdrh #  define INT8_TYPE signed char
355905793e2Sdrh # endif
356dda5b68cSmlcreech #endif
357efad9995Sdrh #ifndef LONGDOUBLE_TYPE
358efad9995Sdrh # define LONGDOUBLE_TYPE long double
359efad9995Sdrh #endif
360efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
36127436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
3625a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
3635a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
364939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
3655a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
366905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
3675a2c2c20Sdrh 
3685a2c2c20Sdrh /*
369bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
370bbd42a6dSdrh ** evaluated at runtime.
371bbd42a6dSdrh */
37246c99e0fSdrh #ifdef SQLITE_AMALGAMATION
3737ff4a45eSmlcreech const int sqlite3one;
37446c99e0fSdrh #else
375bbd42a6dSdrh extern const int sqlite3one;
37646c99e0fSdrh #endif
37738def054Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)
37838def054Sdrh # define SQLITE_BIGENDIAN    0
37938def054Sdrh # define SQLITE_LITTLEENDIAN 1
38038def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
38138def054Sdrh #else
3829c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
3839c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
38438def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
38538def054Sdrh #endif
386bbd42a6dSdrh 
387bbd42a6dSdrh /*
3880f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
3890f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
3900f050353Sdrh ** compilers.
3910f050353Sdrh */
3920f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
3930f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
3940f050353Sdrh 
3950f050353Sdrh /*
39690f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
39790f5ecb3Sdrh ** callback for a given sqlite handle.
39890f5ecb3Sdrh **
39990f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
40090f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
40190f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
40290f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
40390f5ecb3Sdrh */
40490f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
40590f5ecb3Sdrh struct BusyHandler {
40690f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
40790f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
408a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
40990f5ecb3Sdrh };
41090f5ecb3Sdrh 
41190f5ecb3Sdrh /*
41275897234Sdrh ** Name of the master database table.  The master database table
41375897234Sdrh ** is a special table that holds the names and attributes of all
41475897234Sdrh ** user tables and indices.
41575897234Sdrh */
41675897234Sdrh #define MASTER_NAME       "sqlite_master"
417e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
41875897234Sdrh 
41975897234Sdrh /*
4208e150818Sdanielk1977 ** The root-page of the master database table.
4218e150818Sdanielk1977 */
4228e150818Sdanielk1977 #define MASTER_ROOT       1
4238e150818Sdanielk1977 
4248e150818Sdanielk1977 /*
425ed6c8671Sdrh ** The name of the schema table.
426ed6c8671Sdrh */
42753c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
428ed6c8671Sdrh 
429ed6c8671Sdrh /*
43075897234Sdrh ** A convenience macro that returns the number of elements in
43175897234Sdrh ** an array.
43275897234Sdrh */
43375897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
43475897234Sdrh 
43575897234Sdrh /*
436633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
437633e6d57Sdrh ** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
438633e6d57Sdrh */
439633e6d57Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3DbFree)
440633e6d57Sdrh 
441633e6d57Sdrh /*
44275897234Sdrh ** Forward references to structures
44375897234Sdrh */
44413449892Sdrh typedef struct AggInfo AggInfo;
445fe05af87Sdrh typedef struct AuthContext AuthContext;
446f5e7bb51Sdrh typedef struct Bitvec Bitvec;
447fe05af87Sdrh typedef struct CollSeq CollSeq;
4487020f651Sdrh typedef struct Column Column;
449fe05af87Sdrh typedef struct Db Db;
450e501b89aSdanielk1977 typedef struct Schema Schema;
45175897234Sdrh typedef struct Expr Expr;
45275897234Sdrh typedef struct ExprList ExprList;
453c2eef3b3Sdrh typedef struct FKey FKey;
454fe05af87Sdrh typedef struct FuncDef FuncDef;
455fe05af87Sdrh typedef struct IdList IdList;
456fe05af87Sdrh typedef struct Index Index;
4578d059845Sdanielk1977 typedef struct KeyClass KeyClass;
458d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
459633e6d57Sdrh typedef struct Lookaside Lookaside;
460633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
461d1ab1ba5Sdanielk1977 typedef struct Module Module;
462626a879aSdrh typedef struct NameContext NameContext;
463fe05af87Sdrh typedef struct Parse Parse;
464fe05af87Sdrh typedef struct Select Select;
465fe05af87Sdrh typedef struct SrcList SrcList;
466ade86483Sdrh typedef struct StrAccum StrAccum;
467fe05af87Sdrh typedef struct Table Table;
468c00da105Sdanielk1977 typedef struct TableLock TableLock;
469fe05af87Sdrh typedef struct Token Token;
470fe05af87Sdrh typedef struct TriggerStack TriggerStack;
471fe05af87Sdrh typedef struct TriggerStep TriggerStep;
472fe05af87Sdrh typedef struct Trigger Trigger;
473*e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
474fe05af87Sdrh typedef struct WhereInfo WhereInfo;
475fe05af87Sdrh typedef struct WhereLevel WhereLevel;
476d3d39e93Sdrh 
4772dca4ac1Sdanielk1977 /*
4782dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
4792dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
4802dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
4812dca4ac1Sdanielk1977 */
4822dca4ac1Sdanielk1977 #include "btree.h"
4832dca4ac1Sdanielk1977 #include "vdbe.h"
4842dca4ac1Sdanielk1977 #include "pager.h"
4852dca4ac1Sdanielk1977 
4861cc5ed81Sdanielk1977 #include "os.h"
487c7ce76afSdrh #include "mutex.h"
4881cc5ed81Sdanielk1977 
489eee4c8caSdrh 
490001bbcbbSdrh /*
491001bbcbbSdrh ** Each database file to be accessed by the system is an instance
492001bbcbbSdrh ** of the following structure.  There are normally two of these structures
493001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
494a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
495a69d9168Sdrh ** databases may be attached.
496001bbcbbSdrh */
497001bbcbbSdrh struct Db {
498001bbcbbSdrh   char *zName;         /* Name of this database */
499001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
500da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
501da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
502da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
503da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
504e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
505da184236Sdanielk1977 };
506da184236Sdanielk1977 
507da184236Sdanielk1977 /*
508da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
509a04a34ffSdanielk1977 **
510a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the
511a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table
512a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection
513a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been
514a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated,
515a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare
516a04a34ffSdanielk1977 ** statements.
517da184236Sdanielk1977 */
518e501b89aSdanielk1977 struct Schema {
519001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
520d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
521d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
522d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
523d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
5244794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
525da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
5268079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
527da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
52814db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
529a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
530a04a34ffSdanielk1977   sqlite3 *db;         /* "Owner" connection. See comment above */
531a04a34ffSdanielk1977 #endif
532001bbcbbSdrh };
53375897234Sdrh 
53475897234Sdrh /*
5358bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
5368bf8dc92Sdrh ** Db.flags field.
5378bf8dc92Sdrh */
538da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
539da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
540da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
541da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
5428bf8dc92Sdrh 
5438bf8dc92Sdrh /*
5448bf8dc92Sdrh ** Allowed values for the DB.flags field.
5458bf8dc92Sdrh **
5468bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
5478bf8dc92Sdrh ** read into internal hash tables.
5488bf8dc92Sdrh **
5498bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
5508bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
5518bf8dc92Sdrh ** changes and so the view will need to be reset.
5528bf8dc92Sdrh */
553124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
554124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
555b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
5568bf8dc92Sdrh 
557caa639f4Sdrh /*
558caa639f4Sdrh ** The number of different kinds of things that can be limited
559caa639f4Sdrh ** using the sqlite3_limit() interface.
560caa639f4Sdrh */
561caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
5628bf8dc92Sdrh 
5638bf8dc92Sdrh /*
564633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
565633e6d57Sdrh ** to satisify small transient memory allocation requests for objects
566633e6d57Sdrh ** associated with a particular database connection.  The use of
567633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
568633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
569633e6d57Sdrh ** SQL statements.
570633e6d57Sdrh **
571633e6d57Sdrh ** The Lookaside structure holds configuration information about the
572633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
573633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
574633e6d57Sdrh ** objects.
575633e6d57Sdrh */
576633e6d57Sdrh struct Lookaside {
577633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
578633e6d57Sdrh   u8 bEnabled;            /* True if use lookaside.  False to ignore it */
579e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
580633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
581633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
582633e6d57Sdrh   LookasideSlot *pFree;   /* List if available buffers */
583633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
584633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
585633e6d57Sdrh };
586633e6d57Sdrh struct LookasideSlot {
587633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
588633e6d57Sdrh };
589633e6d57Sdrh 
590633e6d57Sdrh /*
591c9b84a1fSdrh ** Each database is an instance of the following structure.
592c9b84a1fSdrh **
593b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
594b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
595b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
596b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
597b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
598b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
599b0c374ffSrdc **
600b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
6016f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
602b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
603b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
604b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
605b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
606b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
607b0c374ffSrdc ** affect the value of lsChange.
608b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
609b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
6106622cce3Sdanielk1977 **
6116622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
6126622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
6136622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
6146622cce3Sdanielk1977 ** consistently.
61575897234Sdrh */
6169bb575fdSdrh struct sqlite3 {
61790f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
618001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
619001bbcbbSdrh   Db *aDb;                      /* All backends */
6208c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
62133f4e02aSdrh   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
622fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
6234ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
624fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
62590f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
62617435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
6273b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
6283b02013eSdrh   u8 dfltJournalMode;           /* Default journal mode for attached dbs */
62998757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
630f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
6312803757aSdrh   int nTable;                   /* Number of tables in the database */
632d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
633f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
634f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
635247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
636b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
637b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
638d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
639caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
6404adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
6411d85d931Sdrh     int iDb;                    /* When back is being initialized */
6421d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
6431d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
6441d85d931Sdrh   } init;
645f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
646761df87eSdrh   void **aExtension;            /* Array of shared libraray handles */
647326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
6481d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
64918de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
65018de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
65119e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
65219e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
653fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
654fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
65571fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
65671fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
65794eb6a14Sdanielk1977   void *pUpdateArg;
65894eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
659fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
660fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
661fcd35c7bSdrh   void *pCollNeededArg;
662fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
663fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
664fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
665881feaa0Sdrh   union {
666881feaa0Sdrh     int isInterrupted;          /* True if sqlite3_interrupt has been called */
667881feaa0Sdrh     double notUsed1;            /* Spacer */
668881feaa0Sdrh   } u1;
669633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
670ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
671e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
672e22a334bSdrh                                 /* Access authorization function */
673ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
674ed6c8671Sdrh #endif
675348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
676348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
677348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
678348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
679348bb5d6Sdanielk1977 #endif
680b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
681b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
6827e6ebfb2Sdanielk1977   Table *pVTab;                 /* vtab with active Connect/Create method */
683f9e7dda7Sdanielk1977   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
684f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
6856b456a2bSdanielk1977 #endif
686fcd35c7bSdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
687fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
688fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
68997903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
690fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
6917e900abfSdanielk1977 #ifdef SQLITE_SSE
6927e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
6937e900abfSdanielk1977 #endif
69475897234Sdrh };
69575897234Sdrh 
69603b808a6Sdrh /*
69703b808a6Sdrh ** A macro to discover the encoding of a database.
69803b808a6Sdrh */
69914db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
70014db2665Sdanielk1977 
70175897234Sdrh /*
7028bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
7038bf8dc92Sdrh **
7048bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
7058bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
7068bf8dc92Sdrh ** transaction is active on that particular database file.
70775897234Sdrh */
7084c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
709c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
7105e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
711382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
712fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
713fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
7141bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
7151bee3d7bSdrh                                           /*   the count using a callback. */
716fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
7176a535340Sdrh                                           /*   result set is empty */
71835d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
71935d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
720f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
7217bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
7227bec505eSdrh                                           ** accessing read-only databases */
7230cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
724da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
725e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
726ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
727c2e87a3eSdrh #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
72858b9576bSdrh 
72934c68fbaSdanielk1977 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
7304a50aac5Sdrh #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
7314a50aac5Sdrh #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
73234c68fbaSdanielk1977 
73358b9576bSdrh /*
734247be43dSdrh ** Possible values for the sqlite.magic field.
735247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
736247be43dSdrh ** than being distinct from one another.
737247be43dSdrh */
738247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
739247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
7407e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
741247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
742247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
743247be43dSdrh 
744247be43dSdrh /*
7450bce8354Sdrh ** Each SQL function is defined by an instance of the following
7460bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
7478e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
7488e0a2f90Sdrh ** points to a linked list of these structures.
7492803757aSdrh */
7500bce8354Sdrh struct FuncDef {
75155ef4d97Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
752d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
75355ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
75455ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
7551350b030Sdrh   void *pUserData;     /* User data parameter */
7560bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
757f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
758f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
759f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
76055ef4d97Sdrh   char zName[1];       /* SQL name of the function.  MUST BE LAST */
7618e0a2f90Sdrh };
7622803757aSdrh 
7632803757aSdrh /*
764d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
765d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
766d1ab1ba5Sdanielk1977 ** hash table.
767d1ab1ba5Sdanielk1977 */
768d1ab1ba5Sdanielk1977 struct Module {
769d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
770d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
771d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
772832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
773d1ab1ba5Sdanielk1977 };
774d1ab1ba5Sdanielk1977 
775d1ab1ba5Sdanielk1977 /*
77655ef4d97Sdrh ** Possible values for FuncDef.flags
77755ef4d97Sdrh */
778d64fe2f3Sdrh #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
779d64fe2f3Sdrh #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
780b7f6f68fSdrh #define SQLITE_FUNC_EPHEM  0x04  /* Ephermeral.  Delete with VDBE */
78155ef4d97Sdrh 
78255ef4d97Sdrh /*
783967e8b73Sdrh ** information about each column of an SQL table is held in an instance
7847020f651Sdrh ** of this structure.
7857020f651Sdrh */
7867020f651Sdrh struct Column {
7877020f651Sdrh   char *zName;     /* Name of this column */
7887977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
789382c0247Sdrh   char *zType;     /* Data type for this column */
790b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
7914a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
79278100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
793a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
794034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
795034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
796034ca14fSdanielk1977 #endif
7977020f651Sdrh };
7987020f651Sdrh 
7997020f651Sdrh /*
800a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
8010202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
8020202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
803a9fd84b0Sdrh **
8040202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
8050202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
8060202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
8070202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
8080202b29eSdanielk1977 ** the version that will require the least expensive encoding
809b3bf556eSdanielk1977 ** translations, if any.
8100202b29eSdanielk1977 **
8110202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
8120202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
8130202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
8140202b29eSdanielk1977 ** xCmp16.
8150202b29eSdanielk1977 **
8160202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
8170202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
8180202b29eSdanielk1977 ** collating sequence may not be read or written.
819a9fd84b0Sdrh */
820a9fd84b0Sdrh struct CollSeq {
8210202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
822466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
823d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
824a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
8250202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
826a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
827a9fd84b0Sdrh };
828a9fd84b0Sdrh 
829a9fd84b0Sdrh /*
830d64fe2f3Sdrh ** Allowed values of CollSeq flags:
831d64fe2f3Sdrh */
832d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
833d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
834d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
835d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
836d64fe2f3Sdrh 
837d64fe2f3Sdrh /*
838d3d39e93Sdrh ** A sort order can be either ASC or DESC.
8398e2ca029Sdrh */
8408e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
841d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
8428e2ca029Sdrh 
8438e2ca029Sdrh /*
844a37cdde0Sdanielk1977 ** Column affinity types.
8458a51256cSdrh **
8468a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
8478a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
8488a51256cSdrh ** the speed a little by number the values consecutively.
8498a51256cSdrh **
8508a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
8518a51256cSdrh ** when multiple affinity types are concatenated into a string and
85266a5167bSdrh ** used as the P4 operand, they will be more readable.
8538a51256cSdrh **
8548a51256cSdrh ** Note also that the numeric types are grouped together so that testing
8558a51256cSdrh ** for a numeric type is a single comparison.
856a37cdde0Sdanielk1977 */
8578a51256cSdrh #define SQLITE_AFF_TEXT     'a'
8588a51256cSdrh #define SQLITE_AFF_NONE     'b'
8598a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
8608a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
8618a51256cSdrh #define SQLITE_AFF_REAL     'e'
862a37cdde0Sdanielk1977 
8638a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
864a37cdde0Sdanielk1977 
865a37cdde0Sdanielk1977 /*
86635573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
86735573356Sdrh ** affinity value.
86835573356Sdrh */
86935573356Sdrh #define SQLITE_AFF_MASK     0x67
87035573356Sdrh 
87135573356Sdrh /*
87235573356Sdrh ** Additional bit values that can be ORed with an affinity without
87335573356Sdrh ** changing the affinity.
87435573356Sdrh */
87535573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
87693a960a0Sdrh #define SQLITE_STOREP2      0x10  /* Store result in reg[P2] rather than jump */
87735573356Sdrh 
87835573356Sdrh /*
87922f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
88022f70c32Sdrh ** following structure.
88122f70c32Sdrh **
882d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
88322f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
88422f70c32Sdrh ** comparisons.
88522f70c32Sdrh **
886d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
88722f70c32Sdrh ** pointer to an array of Column structures, one for each column.
88822f70c32Sdrh **
889d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
890d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
89122f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
89222f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
89322f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
894d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
89522f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
89622f70c32Sdrh **
897d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
898d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
899d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
900b9bb7c18Sdrh ** holds temporary tables and indices.  If Table.isEphem
90122f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
902d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
90322f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
90422f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
90522f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
90622f70c32Sdrh ** of a SELECT statement.
90775897234Sdrh */
90875897234Sdrh struct Table {
909633e6d57Sdrh   sqlite3 *db;     /* Associated database connection.  Might be NULL. */
91075897234Sdrh   char *zName;     /* Name of the table */
91175897234Sdrh   int nCol;        /* Number of columns in this table */
9127020f651Sdrh   Column *aCol;    /* Information about each column */
913c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
914967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
91522f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
916a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
917ed8a3bb1Sdrh   int nRef;          /* Number of pointers to this Table */
918c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
919c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
9203d1bfeaaSdanielk1977   char *zColAff;     /* String defining the affinity of each column */
921ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
922ffe07b2dSdrh   Expr *pCheck;      /* The AND of all CHECK constraints */
923ffe07b2dSdrh #endif
92419a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
92519a8e7e8Sdanielk1977   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
92619a8e7e8Sdanielk1977 #endif
9271914619aSdrh   u8 readOnly;     /* True if this table should not be written by the user */
9281914619aSdrh   u8 isEphem;      /* True if created using OP_OpenEphermeral */
9291914619aSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
9301914619aSdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
9311914619aSdrh   u8 autoInc;      /* True if the integer primary key is autoincrement */
932e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
9331914619aSdrh   u8 isVirtual;             /* True if this is a virtual table */
9341914619aSdrh   u8 isCommit;              /* True once the CREATE TABLE has been committed */
935d1ab1ba5Sdanielk1977   Module *pMod;             /* Pointer to the implementation of the module */
936b9bb7c18Sdrh   sqlite3_vtab *pVtab;      /* Pointer to the module instance */
937b9bb7c18Sdrh   int nModuleArg;           /* Number of arguments to the module */
938b9bb7c18Sdrh   char **azModuleArg;       /* Text of all module args. [0] is module name */
939e09daa90Sdrh #endif
940728b5779Sdrh   Schema *pSchema;          /* Schema that contains this table */
94175897234Sdrh };
94275897234Sdrh 
94375897234Sdrh /*
9444cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
9454cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
9464cbdda9eSdrh ** table support is omitted from the build.
9474cbdda9eSdrh */
9484cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
9494cbdda9eSdrh #  define IsVirtual(X)      ((X)->isVirtual)
950034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
9514cbdda9eSdrh #else
9524cbdda9eSdrh #  define IsVirtual(X)      0
953034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
9544cbdda9eSdrh #endif
9554cbdda9eSdrh 
9564cbdda9eSdrh /*
957c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
958c2eef3b3Sdrh **
959c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
960c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
961c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
962c2eef3b3Sdrh ** Consider this example:
963c2eef3b3Sdrh **
964c2eef3b3Sdrh **     CREATE TABLE ex1(
965c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
966c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
967c2eef3b3Sdrh **     );
968c2eef3b3Sdrh **
969c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
970c2eef3b3Sdrh **
971c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
972c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
973c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
974c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
975c2eef3b3Sdrh **
976ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
977c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
978c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
979c2eef3b3Sdrh ** field.
980c2eef3b3Sdrh */
981c2eef3b3Sdrh struct FKey {
982c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
983c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
984c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
985c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
986c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
987c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
988c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
989c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
990c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
991c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
992c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
993c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
994c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
995c2eef3b3Sdrh };
996c2eef3b3Sdrh 
997c2eef3b3Sdrh /*
998aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
99922f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
10000bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
10011c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
10021c92853dSdrh ** fails and any prior changes from that one operation are backed out,
10031c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
10041c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
10051c92853dSdrh ** changes due to the same operation are not backed out and no rollback
10061c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
10071c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
10081c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
10091c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
10101c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
10111c92853dSdrh **
1012c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1013c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1014c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1015c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1016c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1017c2eef3b3Sdrh ** foreign key.
1018c2eef3b3Sdrh **
1019968af52aSdrh ** The following symbolic values are used to record which type
10201c92853dSdrh ** of action to take.
10219cfcf5d4Sdrh */
10229cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
10231c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
10241c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
10251c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
10261c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
10271c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1028c2eef3b3Sdrh 
1029c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1030c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1031c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1032c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1033c2eef3b3Sdrh 
1034c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
10359cfcf5d4Sdrh 
1036d3d39e93Sdrh 
1037d3d39e93Sdrh /*
1038d3d39e93Sdrh ** An instance of the following structure is passed as the first
1039d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1040d3d39e93Sdrh ** comparison of the two index keys.
1041d3d39e93Sdrh */
1042d3d39e93Sdrh struct KeyInfo {
1043b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
1044b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
1045*e63d9991Sdrh   u16 nField;         /* Number of entries in aColl[] */
1046d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
1047d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1048d3d39e93Sdrh };
1049d3d39e93Sdrh 
10509cfcf5d4Sdrh /*
1051*e63d9991Sdrh ** An instance of the following structure holds information about a
1052*e63d9991Sdrh ** single index record that has already been parsed out into individual
1053*e63d9991Sdrh ** values.
1054*e63d9991Sdrh **
1055*e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1056*e63d9991Sdrh ** Records are used to store the content of a table row and to store
1057*e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1058*e63d9991Sdrh ** the OP_MakeRecord opcode of the VDBE and is disassemblied by the
1059*e63d9991Sdrh ** OP_Column opcode.
1060*e63d9991Sdrh **
1061*e63d9991Sdrh ** This structure holds a record that has already been disassembled
1062*e63d9991Sdrh ** into its constitutent fields.
1063*e63d9991Sdrh */
1064*e63d9991Sdrh struct UnpackedRecord {
1065*e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
1066*e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1067*e63d9991Sdrh   u16 flags;          /* Boolean settings.  UNPACKED_... below */
1068*e63d9991Sdrh   Mem *aMem;          /* Values */
1069*e63d9991Sdrh };
1070*e63d9991Sdrh 
1071*e63d9991Sdrh /*
1072*e63d9991Sdrh ** Allowed values of UnpackedRecord.flags
1073*e63d9991Sdrh */
1074*e63d9991Sdrh #define UNPACKED_NEED_FREE     0x0001  /* Memory is from sqlite3Malloc() */
1075*e63d9991Sdrh #define UNPACKED_NEED_DESTROY  0x0002  /* apMem[]s should all be destroyed */
1076*e63d9991Sdrh #define UNPACKED_IGNORE_ROWID  0x0004  /* Ignore trailing rowid on key1 */
1077*e63d9991Sdrh #define UNPACKED_INCRKEY       0x0008  /* Make this key an epsilon larger */
1078*e63d9991Sdrh #define UNPACKED_PREFIX_MATCH  0x0010  /* A prefix match is considered OK */
1079*e63d9991Sdrh 
1080*e63d9991Sdrh /*
108166b89c8fSdrh ** Each SQL index is represented in memory by an
108275897234Sdrh ** instance of the following structure.
1083967e8b73Sdrh **
1084967e8b73Sdrh ** The columns of the table that are to be indexed are described
1085967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1086967e8b73Sdrh ** we have the following table and index:
1087967e8b73Sdrh **
1088967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1089967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1090967e8b73Sdrh **
1091967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1092967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1093967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1094967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1095967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1096967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1097967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1098ea1ba17cSdrh **
1099ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1100ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1101ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1102ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1103ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1104ea1ba17cSdrh ** element.
110575897234Sdrh */
110675897234Sdrh struct Index {
110775897234Sdrh   char *zName;     /* Name of this index */
1108967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1109967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
11108b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1111967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1112be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
11139cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1114485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1115a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
111675897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1117b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1118b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1119b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
112075897234Sdrh };
112175897234Sdrh 
112275897234Sdrh /*
112375897234Sdrh ** Each token coming out of the lexer is an instance of
11244b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
11254efc4754Sdrh **
11264efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
11274efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
11284efc4754Sdrh ** and Token.n when Token.z==0.
112975897234Sdrh */
113075897234Sdrh struct Token {
11314c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
11324b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
11336977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
113475897234Sdrh };
113575897234Sdrh 
113675897234Sdrh /*
113713449892Sdrh ** An instance of this structure contains information needed to generate
113813449892Sdrh ** code for a SELECT that contains aggregate functions.
113913449892Sdrh **
114013449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
114113449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
114213449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
114313449892Sdrh ** code for that node.
114413449892Sdrh **
114513449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
114613449892Sdrh ** original Select structure that describes the SELECT statement.  These
114713449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
114813449892Sdrh */
114913449892Sdrh struct AggInfo {
115013449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
115113449892Sdrh                           ** from source tables rather than from accumulators */
115213449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
115313449892Sdrh                           ** than the source table */
115413449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
115513449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
115613449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
115713449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
11580817d0dfSdanielk1977     Table *pTab;             /* Source table */
115913449892Sdrh     int iTable;              /* Cursor number of the source table */
116013449892Sdrh     int iColumn;             /* Column number within the source table */
116113449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
116213449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
11635774b806Sdrh     Expr *pExpr;             /* The original expression */
116413449892Sdrh   } *aCol;
116513449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
116613449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
116713449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
116813449892Sdrh                           ** Additional columns are used only as parameters to
116913449892Sdrh                           ** aggregate functions */
117013449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
117113449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
117213449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
117313449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1174b9bb7c18Sdrh     int iDistinct;           /* Ephermeral table used to enforce DISTINCT */
117513449892Sdrh   } *aFunc;
117613449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
117713449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
117813449892Sdrh };
117913449892Sdrh 
118013449892Sdrh /*
118175897234Sdrh ** Each node of an expression in the parse tree is an instance
118222f70c32Sdrh ** of this structure.
118322f70c32Sdrh **
118422f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
118522f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
118622f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
118722f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
118822f70c32Sdrh ** tree.
118922f70c32Sdrh **
119022f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
119122f70c32Sdrh ** of argument if the expression is a function.
119222f70c32Sdrh **
11934b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
11944b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
11954b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
11964b59ab5eSdrh ** a compound token.
119722f70c32Sdrh **
119822f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
119922f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
120022f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
120122f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
120222f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
120322f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
120422f70c32Sdrh ** it can be accessed after all aggregates are computed.
120522f70c32Sdrh **
120622f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
12077c972decSdrh ** representing which function.  If the expression is an unbound variable
12087c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
12097c972decSdrh ** Expr.iTable holds the index number for that variable.
121022f70c32Sdrh **
12111398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
12121398ad36Sdrh ** register number containing the result of the subquery.  If the
12131398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
12141398ad36Sdrh ** gives a different answer at different times during statement processing
12151398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
12161398ad36Sdrh **
121722f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
121822f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
121922f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
122022f70c32Sdrh ** operand.
1221aee18ef8Sdanielk1977 **
1222aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1223aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1224aee18ef8Sdanielk1977 ** corresponding table definition.
122575897234Sdrh */
122675897234Sdrh struct Expr {
12271cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1228a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
12296a03a1c5Sdrh   u16 flags;             /* Various flags.  See below */
1230f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
123175897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
1232d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
1233d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
123475897234Sdrh   Token token;           /* An operand token */
12356977fea8Sdrh   Token span;            /* Complete text of the expression */
1236967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
12378e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
123813449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
123913449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
124022d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1241d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
1242d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
1243aee18ef8Sdanielk1977   Table *pTab;           /* Table for OP_Column expressions. */
12440224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
1245fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1246fc976065Sdanielk1977 #endif
124775897234Sdrh };
124875897234Sdrh 
124975897234Sdrh /*
12501f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
12511f16230bSdrh */
1252678ccce8Sdrh #define EP_FromJoin   0x0001  /* Originated in ON or USING clause of a join */
1253678ccce8Sdrh #define EP_Agg        0x0002  /* Contains one or more aggregate functions */
1254678ccce8Sdrh #define EP_Resolved   0x0004  /* IDs have been resolved to COLUMNs */
1255678ccce8Sdrh #define EP_Error      0x0008  /* Expression contains one or more errors */
1256678ccce8Sdrh #define EP_Distinct   0x0010  /* Aggregate function with DISTINCT keyword */
1257678ccce8Sdrh #define EP_VarSelect  0x0020  /* pSelect is correlated, not constant */
1258678ccce8Sdrh #define EP_Dequoted   0x0040  /* True if the string has been dequoted */
1259678ccce8Sdrh #define EP_InfixFunc  0x0080  /* True for an infix function: LIKE, GLOB, etc */
1260678ccce8Sdrh #define EP_ExpCollate 0x0100  /* Collating sequence specified explicitly */
1261da250ea5Sdrh #define EP_AnyAff     0x0200  /* Can take a cached column of any affinity */
126247de955eSdrh #define EP_FixedDest  0x0400  /* Result needed in a specific register */
126392b01d53Sdrh #define EP_IntValue   0x0800  /* Integer value contained in iTable */
12641f16230bSdrh /*
12651f16230bSdrh ** These macros can be used to test, set, or clear bits in the
12661f16230bSdrh ** Expr.flags field.
12671f16230bSdrh */
12681f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
12691f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
12701f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
12711f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
12721f16230bSdrh 
12731f16230bSdrh /*
127475897234Sdrh ** A list of expressions.  Each expression may optionally have a
127575897234Sdrh ** name.  An expr/name combination can be used in several ways, such
127675897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
127775897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1278ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
127975897234Sdrh ** field is not used.
128075897234Sdrh */
128175897234Sdrh struct ExprList {
128275897234Sdrh   int nExpr;             /* Number of expressions on the list */
12834305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
12849d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
12856d4abfbeSdrh   struct ExprList_item {
128675897234Sdrh     Expr *pExpr;           /* The list of expressions */
128775897234Sdrh     char *zName;           /* Token associated with this expression */
12888e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
12898e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
12908e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
129175897234Sdrh   } *a;                  /* One entry for each expression */
129275897234Sdrh };
129375897234Sdrh 
129475897234Sdrh /*
1295ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1296ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1297ad3cab52Sdrh **
1298ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1299ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1300ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1301ad3cab52Sdrh **
1302ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1303ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1304ad3cab52Sdrh **
1305ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1306ad3cab52Sdrh **
1307ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
130875897234Sdrh */
130975897234Sdrh struct IdList {
13106d4abfbeSdrh   struct IdList_item {
1311ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1312967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1313ad3cab52Sdrh   } *a;
131413449892Sdrh   int nId;         /* Number of identifiers on the list */
131513449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1316ad3cab52Sdrh };
1317ad3cab52Sdrh 
1318ad3cab52Sdrh /*
131951669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1320ca83ac51Sdrh **
1321ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1322ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1323ca83ac51Sdrh ** of the library by 738 bytes on ix86.
132451669863Sdrh */
1325ca83ac51Sdrh typedef u64 Bitmask;
132651669863Sdrh 
132751669863Sdrh /*
1328ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1329ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1330ad3cab52Sdrh ** the SrcList.a[] array.
1331d24cc427Sdrh **
1332d24cc427Sdrh ** With the addition of multiple database support, the following structure
1333d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1334d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1335d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1336d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1337c49de5d9Sdrh **
1338c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1339c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1340c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1341c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
1342ad3cab52Sdrh */
1343ad3cab52Sdrh struct SrcList {
1344939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1345939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1346ad3cab52Sdrh   struct SrcList_item {
1347113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1348ad3cab52Sdrh     char *zName;      /* Name of the table */
1349ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1350daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1351daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
13521787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1353c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1354e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1355ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1356ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
135751669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1358113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
135975897234Sdrh };
136075897234Sdrh 
136175897234Sdrh /*
136201f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
136301f3f253Sdrh */
136401f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
13653dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
13663dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
13673dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
13683dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
13693dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
13703dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
137101f3f253Sdrh 
137201f3f253Sdrh /*
13736b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
13746b56344dSdrh ** structure contains a single instance of this structure.  This structure
13756b56344dSdrh ** is intended to be private the the where.c module and should not be
13766b56344dSdrh ** access or modified by other modules.
13776d209d8bSdrh **
13786d209d8bSdrh ** The pIdxInfo and pBestIdx fields are used to help pick the best
13796d209d8bSdrh ** index on a virtual table.  The pIdxInfo pointer contains indexing
13806d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
13816d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
13826d209d8bSdrh ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
13836d209d8bSdrh ** FROM clause ordering.  This is a little confusing so I will repeat
13846d209d8bSdrh ** it in different words.  WhereInfo.a[i].pIdxInfo is index information
13856d209d8bSdrh ** for WhereInfo.pTabList.a[i].  WhereInfo.a[i].pBestInfo is the
13866d209d8bSdrh ** index information for the i-th loop of the join.  pBestInfo is always
13876d209d8bSdrh ** either NULL or a copy of some pIdxInfo.  So for cleanup it is
13886d209d8bSdrh ** sufficient to free all of the pIdxInfo pointers.
13896d209d8bSdrh **
13906b56344dSdrh */
13916b56344dSdrh struct WhereLevel {
139229dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
139329dda4aeSdrh   int flags;            /* Flags associated with this level */
139451147baaSdrh   int iMem;             /* First memory cell used by this level */
139529dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
13969012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
13979012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
13989012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
13996b56344dSdrh   int brk;              /* Jump here to break out of the loop */
140072e8fa42Sdrh   int nxt;              /* Jump here to start the next IN combination */
14016b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1402ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
140329dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
140451147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1405e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
140672e8fa42Sdrh   struct InLoop {
140772e8fa42Sdrh     int iCur;              /* The VDBE cursor used by this IN operator */
140872e8fa42Sdrh     int topAddr;           /* Top of the IN loop */
140972e8fa42Sdrh   } *aInLoop;           /* Information about each nested IN operator */
14106d209d8bSdrh   sqlite3_index_info *pBestIdx;  /* Index information for this level */
14116d209d8bSdrh 
14126d209d8bSdrh   /* The following field is really not part of the current level.  But
14136d209d8bSdrh   ** we need a place to cache index information for each table in the
14146d209d8bSdrh   ** FROM clause and the WhereLevel structure is a convenient place.
14156d209d8bSdrh   */
14166d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
14176b56344dSdrh };
14186b56344dSdrh 
141908c88eb0Sdrh /*
142008c88eb0Sdrh ** Flags appropriate for the wflags parameter of sqlite3WhereBegin().
142108c88eb0Sdrh */
142208c88eb0Sdrh #define WHERE_ORDERBY_NORMAL     0   /* No-op */
142308c88eb0Sdrh #define WHERE_ORDERBY_MIN        1   /* ORDER BY processing for min() func */
142408c88eb0Sdrh #define WHERE_ORDERBY_MAX        2   /* ORDER BY processing for max() func */
142508c88eb0Sdrh #define WHERE_ONEPASS_DESIRED    4   /* Want to do one-pass UPDATE/DELETE */
1426a9d1ccb9Sdanielk1977 
14276b56344dSdrh /*
142875897234Sdrh ** The WHERE clause processing routine has two halves.  The
142975897234Sdrh ** first part does the start of the WHERE loop and the second
143075897234Sdrh ** half does the tail of the WHERE loop.  An instance of
143175897234Sdrh ** this structure is returned by the first half and passed
143275897234Sdrh ** into the second half to give some continuity.
143375897234Sdrh */
143475897234Sdrh struct WhereInfo {
143508c88eb0Sdrh   Parse *pParse;       /* Parsing and code generating context */
143608c88eb0Sdrh   u8 okOnePass;        /* Ok to use one-pass algorithm for UPDATE or DELETE */
1437ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
14389012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
143919a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
144019a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
14416b56344dSdrh   int nLevel;          /* Number of nested loop */
14426d209d8bSdrh   sqlite3_index_info **apInfo;  /* Array of pointers to index info structures */
14436b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
144475897234Sdrh };
144575897234Sdrh 
144675897234Sdrh /*
1447b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1448b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1449b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1450b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1451b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1452b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1453b3bce662Sdanielk1977 ** other statements.
1454b3bce662Sdanielk1977 **
1455b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1456b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1457b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1458b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1459b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1460b3bce662Sdanielk1977 ** the context containing the match is incremented.
1461b3bce662Sdanielk1977 **
1462b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1463b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1464b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1465b3bce662Sdanielk1977 ** subqueries looking for a match.
1466b3bce662Sdanielk1977 */
1467b3bce662Sdanielk1977 struct NameContext {
1468b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1469b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1470b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1471b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1472b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1473b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
147413449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
147506f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1476b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
147713449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1478b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1479b3bce662Sdanielk1977 };
1480b3bce662Sdanielk1977 
1481b3bce662Sdanielk1977 /*
14829bb61fe7Sdrh ** An instance of the following structure contains all information
14839bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1484a76b5dfcSdrh **
1485d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1486d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1487d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1488d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1489d11d382cSdrh ** in the VDBE that record the limit and offset counters.
14900342b1f5Sdrh **
1491b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
14920342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
149366a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
14940342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
1495b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
14960342b1f5Sdrh ** enough information about the compound query is known at that point.
1497b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1498b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
14990342b1f5Sdrh ** sequences for the ORDER BY clause.
15009bb61fe7Sdrh */
15019bb61fe7Sdrh struct Select {
15029bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
15037b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
15047b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
15050342b1f5Sdrh   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
15060342b1f5Sdrh   u8 isAgg;              /* True if this is an aggregate query */
1507b9bb7c18Sdrh   u8 usesEphm;           /* True if uses an OpenEphemeral opcode */
15084b14b4d7Sdrh   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
15096c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
1510ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
15119bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
15129bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
15139bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
15149bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1515967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
15161e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
15170342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1518a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1519a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
15207b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1521b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
15229bb61fe7Sdrh };
15239bb61fe7Sdrh 
15249bb61fe7Sdrh /*
1525fef5208cSdrh ** The results of a select can be distributed in several ways.
1526fef5208cSdrh */
152713449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
152813449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
15299ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
15309ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
1531fef5208cSdrh 
153213449892Sdrh /* The ORDER BY clause is ignored for all of the above */
15336c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
153413449892Sdrh 
15359ed1dfa8Sdanielk1977 #define SRT_Callback     5  /* Invoke a callback with each row of result */
15369ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
15370cdc022eSdanielk1977 #define SRT_Set          7  /* Store results as keys in an index */
15389ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
15399ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
1540e00ee6ebSdrh #define SRT_Coroutine   10  /* Generate a single row of result */
15412282792aSdrh 
15422282792aSdrh /*
15436c8c8ce0Sdanielk1977 ** A structure used to customize the behaviour of sqlite3Select(). See
15446c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
15456c8c8ce0Sdanielk1977 */
15466c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
15476c8c8ce0Sdanielk1977 struct SelectDest {
1548477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
1549477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
15506c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
15511013c932Sdrh   int iMem;         /* Base register where results are written */
1552ad27e761Sdrh   int nMem;         /* Number of registers allocated */
15536c8c8ce0Sdanielk1977 };
15546c8c8ce0Sdanielk1977 
15556c8c8ce0Sdanielk1977 /*
1556f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1557f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1558f57b3399Sdrh ** carry around information that is global to the entire parse.
1559f1974846Sdrh **
1560f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1561f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1562f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1563f1974846Sdrh ** each recursion.
1564c00da105Sdanielk1977 **
1565c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1566c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1567c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1568c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1569c00da105Sdanielk1977 ** list.
157075897234Sdrh */
157175897234Sdrh struct Parse {
15729bb575fdSdrh   sqlite3 *db;         /* The main database structure */
15734c504391Sdrh   int rc;              /* Return code from execution */
157475897234Sdrh   char *zErrMsg;       /* An error message */
157575897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1576836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1577e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1578a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1579205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
15807e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1581892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
15822dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
1583892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
1584892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
1585892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
158675897234Sdrh   int nErr;            /* Number of errors seen */
1587832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
158819a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1589fef5208cSdrh   int nSet;            /* Number of sets used so far */
1590aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
1591e55cbd72Sdrh   int disableColCache; /* True to disable adding to column cache */
1592e55cbd72Sdrh   int nColCache;       /* Number of entries in the column cache */
1593e55cbd72Sdrh   int iColCache;       /* Next entry of the cache to replace */
15942f7794c1Sdrh   struct yColCache {
1595e55cbd72Sdrh     int iTable;           /* Table cursor number */
1596e55cbd72Sdrh     int iColumn;          /* Table column number */
1597da250ea5Sdrh     char affChange;       /* True if this register has had an affinity change */
1598e55cbd72Sdrh     int iReg;             /* Register holding value of this column */
1599e55cbd72Sdrh   } aColCache[10];     /* One for each valid column cache entry */
160080242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1601fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1602fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1603c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1604c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1605c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1606c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1607c00da105Sdanielk1977 #endif
1608cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
1609cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
1610f1974846Sdrh 
1611f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1612f1974846Sdrh   ** each recursion */
1613f1974846Sdrh 
1614f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1615f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1616f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1617f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1618f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1619f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1620f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1621f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1622f1974846Sdrh   const char *zSql;    /* All SQL text */
1623f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1624f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1625f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1626f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1627f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1628b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
162933b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
16307e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
16314f3dd150Sdrh   int nVtabLock;             /* Number of virtual tables to lock */
16324f3dd150Sdrh   Table **apVtabLock;        /* Pointer to virtual tables needing locking */
1633b9bb7c18Sdrh #endif
1634fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
163575897234Sdrh };
163675897234Sdrh 
16377e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
16387e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
16397e6ebfb2Sdanielk1977 #else
16407e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
16417e6ebfb2Sdanielk1977 #endif
16427e6ebfb2Sdanielk1977 
1643d99bc930Sdanielk1977 /*
164485e2096fSdrh ** An instance of the following structure can be declared on a stack and used
164585e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
164685e2096fSdrh */
164785e2096fSdrh struct AuthContext {
164885e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
164985e2096fSdrh   Parse *pParse;              /* The Parse structure */
165085e2096fSdrh };
165185e2096fSdrh 
165285e2096fSdrh /*
1653f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1654b0c374ffSrdc */
1655b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1656b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
165794eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1658e4d90813Sdrh #define OPFLAG_APPEND    8    /* This is likely to be an append */
1659b0c374ffSrdc 
1660b0c374ffSrdc /*
1661d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1662d99bc930Sdanielk1977  * struct Trigger.
1663d99bc930Sdanielk1977  *
1664d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
16659bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1666d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1667d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1668ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1669ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1670ad3cab52Sdrh  *    struct Table.
1671d99bc930Sdanielk1977  *
1672ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1673ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1674d99bc930Sdanielk1977  */
1675d99bc930Sdanielk1977 struct Trigger {
1676d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1677d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1678f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1679dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1680d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1681d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1682d99bc930Sdanielk1977                              the <column-list> is stored here */
16834312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1684e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1685e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1686d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1687d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1688c3f9bad2Sdanielk1977 };
1689d99bc930Sdanielk1977 
1690d99bc930Sdanielk1977 /*
1691dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1692dca76841Sdrh ** determine which.
1693dca76841Sdrh **
1694dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1695dca76841Sdrh ** In that cases, the constants below can be ORed together.
1696dca76841Sdrh */
1697dca76841Sdrh #define TRIGGER_BEFORE  1
1698dca76841Sdrh #define TRIGGER_AFTER   2
1699dca76841Sdrh 
1700dca76841Sdrh /*
1701d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1702d99bc930Sdanielk1977  * that is a part of a trigger-program.
1703d99bc930Sdanielk1977  *
1704d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1705d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1706d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1707d99bc930Sdanielk1977  * the first step of the trigger-program.
1708d99bc930Sdanielk1977  *
1709d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1710d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1711d99bc930Sdanielk1977  * value of "op" as follows:
1712d99bc930Sdanielk1977  *
1713d99bc930Sdanielk1977  * (op == TK_INSERT)
1714d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1715d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1716d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1717d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1718d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1719d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1720d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1721ad3cab52Sdrh  *              statement, then this stores the column-names to be
1722ad3cab52Sdrh  *              inserted into.
1723d99bc930Sdanielk1977  *
1724d99bc930Sdanielk1977  * (op == TK_DELETE)
1725d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1726d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1727d99bc930Sdanielk1977  *              Otherwise NULL.
1728d99bc930Sdanielk1977  *
1729d99bc930Sdanielk1977  * (op == TK_UPDATE)
1730d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1731d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1732d99bc930Sdanielk1977  *              Otherwise NULL.
1733d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
17344adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1735ad3cab52Sdrh  *              argument.
1736d99bc930Sdanielk1977  *
1737d99bc930Sdanielk1977  */
1738c3f9bad2Sdanielk1977 struct TriggerStep {
1739c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1740d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1741a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1742c3f9bad2Sdanielk1977 
1743c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1744c3f9bad2Sdanielk1977                           INSERT steps (when pExprList == 0) */
1745c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1746c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1747c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1748c3f9bad2Sdanielk1977                            INSERT steps (when pSelect == 0)         */
1749c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1750c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
1751187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1752c3f9bad2Sdanielk1977 };
1753c3f9bad2Sdanielk1977 
1754d99bc930Sdanielk1977 /*
1755d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1756d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1757d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1758d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1759d99bc930Sdanielk1977  *
1760d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1761d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1762d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1763d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1764d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1765d99bc930Sdanielk1977  *
1766d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1767d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1768d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1769d99bc930Sdanielk1977  *
1770d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1771d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1772d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1773d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1774d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1775d99bc930Sdanielk1977  * trigger continues.
1776d99bc930Sdanielk1977  *
1777d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1778d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1779d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1780d99bc930Sdanielk1977  */
1781d99bc930Sdanielk1977 struct TriggerStack {
1782d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1783d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1784d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
17858f2c54e6Sdanielk1977   u32 newColMask;
17868f2c54e6Sdanielk1977   u32 oldColMask;
1787d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
17886f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1789e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1790e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1791c3f9bad2Sdanielk1977 };
1792c3f9bad2Sdanielk1977 
1793d99bc930Sdanielk1977 /*
1794f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1795f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1796f26e09c8Sdrh ** explicit.
1797f26e09c8Sdrh */
1798f26e09c8Sdrh typedef struct DbFixer DbFixer;
1799f26e09c8Sdrh struct DbFixer {
1800f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1801f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1802f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1803f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1804f26e09c8Sdrh };
1805f26e09c8Sdrh 
1806f26e09c8Sdrh /*
1807ade86483Sdrh ** An objected used to accumulate the text of a string where we
1808ade86483Sdrh ** do not necessarily know how big the string will be in the end.
1809ade86483Sdrh */
1810ade86483Sdrh struct StrAccum {
1811633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
1812ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
1813ade86483Sdrh   char *zText;         /* The string collected so far */
1814ade86483Sdrh   int  nChar;          /* Length of the string so far */
1815ade86483Sdrh   int  nAlloc;         /* Amount of space allocated in zText */
1816bb4957f8Sdrh   int  mxAlloc;        /* Maximum allowed string length */
1817ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
1818ade86483Sdrh   u8   useMalloc;      /* True if zText is enlargable using realloc */
1819ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
1820ade86483Sdrh };
1821ade86483Sdrh 
1822ade86483Sdrh /*
1823234c39dfSdrh ** A pointer to this structure is used to communicate information
1824234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1825234c39dfSdrh */
1826234c39dfSdrh typedef struct {
18279bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1828ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
1829234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
183015ca1df1Sdrh   int rc;             /* Result code stored here */
1831234c39dfSdrh } InitData;
1832234c39dfSdrh 
1833b6c29897Sdrh /*
183440257ffdSdrh ** Structure containing global configuration data for the SQLite library.
183533589797Sdrh **
183633589797Sdrh ** This structure also contains some state information.
183740257ffdSdrh */
183840257ffdSdrh struct Sqlite3Config {
1839fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
1840fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
1841fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
18420a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
1843633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
1844633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
1845fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
18466d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
184740257ffdSdrh   void *pHeap;                      /* Heap storage space */
184833589797Sdrh   int nHeap;                        /* Size of pHeap[] */
184933589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
185033589797Sdrh   void *pScratch;                   /* Scratch memory */
185133589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
185233589797Sdrh   int nScratch;                     /* Number of scratch buffers */
185333589797Sdrh   void *pPage;                      /* Page cache memory */
185433589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
185533589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
185671bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
185771bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
185871bc31c6Sdanielk1977   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
185993ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
186031fab4f3Sdanielk1977   int nSmall;                       /* alloc size threshold used by mem6.c */
1861ec424a5bSdrh   int mxParserStack;                /* maximum depth of the parser stack */
186240257ffdSdrh };
186340257ffdSdrh 
186440257ffdSdrh /*
186566150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
186666150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
18674a919118Sdrh */
18684a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
18694a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
18704a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
18714a919118Sdrh   }                                                    \
18724a919118Sdrh }
18734a919118Sdrh 
18744a919118Sdrh /*
187549285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
187649285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
187749285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
187849285708Sdrh ** corruption is first detected.
187949285708Sdrh */
188049285708Sdrh #ifdef SQLITE_DEBUG
18816e736838Sdrh   int sqlite3Corrupt(void);
188249285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
188349285708Sdrh #else
188449285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
188549285708Sdrh #endif
188649285708Sdrh 
188749285708Sdrh /*
188875897234Sdrh ** Internal function prototypes
188975897234Sdrh */
18904adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
18914adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
18928a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
18930a687d12Sdrh int sqlite3Strlen(sqlite3*, const char*);
18942e588c75Sdanielk1977 
189540257ffdSdrh int sqlite3MallocInit(void);
1896fec00eabSdrh void sqlite3MallocEnd(void);
1897fec00eabSdrh void *sqlite3Malloc(int);
1898fec00eabSdrh void *sqlite3MallocZero(int);
1899fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int);
1900fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int);
190117435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
190217435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
1903fec00eabSdrh void *sqlite3Realloc(void*, int);
190497c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
1905a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
1906633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
1907a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
1908633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
1909facf0307Sdrh void *sqlite3ScratchMalloc(int);
1910facf0307Sdrh void sqlite3ScratchFree(void*);
1911facf0307Sdrh void *sqlite3PageMalloc(int);
1912facf0307Sdrh void sqlite3PageFree(void*);
1913fec00eabSdrh void sqlite3MemSetDefault(void);
191431fab4f3Sdanielk1977 const sqlite3_mem_methods *sqlite3MemGetDefault(void);
19155099be5eSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
19160d84e5b2Sdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
19172d34081dSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys6(void);
1918171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
19192e588c75Sdanielk1977 
192065bbf29eSdrh #ifndef SQLITE_MUTEX_NOOP
19216d2ab0e4Sdanielk1977   sqlite3_mutex_methods *sqlite3DefaultMutex(void);
192259f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
1923d025174fSdanielk1977   int sqlite3MutexInit(void);
1924d025174fSdanielk1977   int sqlite3MutexEnd(void);
192565bbf29eSdrh #endif
19266d2ab0e4Sdanielk1977 
1927f7141990Sdrh int sqlite3StatusValue(int);
1928f7141990Sdrh void sqlite3StatusAdd(int, int);
1929f7141990Sdrh void sqlite3StatusSet(int, int);
1930f7141990Sdrh 
19310de3ae95Sdrh int sqlite3IsNaN(double);
19320de3ae95Sdrh 
1933f089aa45Sdrh void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
193417435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
193517435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
1936633e6d57Sdrh char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
193787cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1938e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
1939d919fe17Sdrh #endif
1940d919fe17Sdrh #if defined(SQLITE_TEST)
1941e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
194287cc3b31Sdrh #endif
1943f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...);
19444adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
1945a073384fSdrh void sqlite3ErrorClear(Parse*);
19464adee20fSdanielk1977 void sqlite3Dequote(char*);
194717435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*);
19482646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
19494adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
195080242055Sdrh void sqlite3FinishCoding(Parse*);
1951892d3179Sdrh int sqlite3GetTempReg(Parse*);
1952892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
1953892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
1954892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
1955a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
195617435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
19574e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
19581e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
19594adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
196017435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
1961fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
1962633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
196317435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
1964633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
19659bb575fdSdrh int sqlite3Init(sqlite3*, char**);
1966234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
196791cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
19689bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
19694adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
19709bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
19714adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1972c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
1973f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
19744adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
19754adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
1976fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1977ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
1978487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
19797977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
198039002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
198119a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1982b7f9164eSdrh 
1983f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
1984f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
1985f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
1986f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32);
1987f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
19883088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
1989f5e7bb51Sdrh 
1990fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
1991fe3fcbe2Sdanielk1977 
1992fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
19934adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
1994b7f9164eSdrh #else
1995b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
1996b7f9164eSdrh #endif
1997b7f9164eSdrh 
1998a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
1999a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*);
20004adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
200117435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
200217435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
20034adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
200417435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
200517435752Sdrh SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
200661dfc31dSdrh                                       Select*, Expr*, IdList*);
200761dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
20084adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
2009633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
2010633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
20110202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
20124d91a701Sdrh                         Token*, int, int);
20134d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
2014a9671a22Sdrh int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*);
201517435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
201617435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
2017633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
20184adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
20194adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
2020c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
20214adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
20224adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
2023a9d1ccb9Sdanielk1977 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
20244adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
2025da250ea5Sdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
2026b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
202792b01d53Sdrh void sqlite3ExprCodeCopy(Parse*, int, int, int);
2028e55cbd72Sdrh void sqlite3ExprClearColumnCache(Parse*, int);
2029da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
2030652fbf55Sdrh int sqlite3ExprWritableRegister(Parse*,int,int);
2031191b54cbSdrh void sqlite3ExprHardCopy(Parse*,int,int);
2032389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
20332dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
2034678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
20352dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
2036678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*);
2037191b54cbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
20384adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
20394adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
20409bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
2041ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
20429bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
20439bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
20449bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
204574161705Sdrh void sqlite3Vacuum(Parse*);
20469bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
204717435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
20484adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
2049b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *);
2050d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2051d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
20524adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
20531e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*);
20542fa1868fSdrh void sqlite3PrngSaveState(void);
20552fa1868fSdrh void sqlite3PrngRestoreState(void);
20562fa1868fSdrh void sqlite3PrngResetState(void);
20579bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
20584adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
2059684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
20604adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
20614adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
20624adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
20630a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
2064eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
20654adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
20664adee20fSdanielk1977 int sqlite3IsRowid(const char*);
20672d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
20682d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
2069e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
207004adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
207104adf416Sdrh                                      int*,int,int,int,int);
207204adf416Sdrh void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
2073aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
20744adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
207517435752Sdrh Expr *sqlite3ExprDup(sqlite3*,Expr*);
207617435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*);
207717435752Sdrh ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
207817435752Sdrh SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
207917435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
208017435752Sdrh Select *sqlite3SelectDup(sqlite3*,Select*);
20819bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
20829bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
20839bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*);
20847e8b848aSdrh #ifdef SQLITE_DEBUG
20859bb575fdSdrh   int sqlite3SafetyOn(sqlite3*);
20869bb575fdSdrh   int sqlite3SafetyOff(sqlite3*);
20877e8b848aSdrh #else
20887e8b848aSdrh # define sqlite3SafetyOn(A) 0
20897e8b848aSdrh # define sqlite3SafetyOff(A) 0
20907e8b848aSdrh #endif
20917e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
20927e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
20939cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
2094f93d9999Sdrh void sqlite3MaterializeView(Parse*, Select*, Expr*, int);
2095b7f9164eSdrh 
2096b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
2097ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
209860218d2aSdrh                            Expr*,int, int);
20994adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
2100fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
210174161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
2102dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
21034adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
21048f2c54e6Sdanielk1977                            int, int, u32*, u32*);
2105dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
2106633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
210717435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
210817435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
210917435752Sdrh                                         ExprList*,Select*,int);
211017435752Sdrh   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
211117435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
2112633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
2113b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2114b7f9164eSdrh #else
2115b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
2116633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
2117cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
2118b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
21198f2c54e6Sdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
2120b7f9164eSdrh #endif
2121b7f9164eSdrh 
21224adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
21230202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
21244adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
2125ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
2126728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
21274adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
21284adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
21294adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
2130ed6c8671Sdrh #else
2131b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
21324adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
21334adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
21344adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
2135ed6c8671Sdrh #endif
2136f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2137f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
21389bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
213933f4e02aSdrh                        int omitJournal, int nCache, int flags, Btree **ppBtree);
21404adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
21414adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
21424adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
21434adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
21444adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
21454adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
2146487e262fSdrh int sqlite3AtoF(const char *z, double*);
21476f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
2148fec19aadSdrh int sqlite3GetInt32(const char *, int*);
2149598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int);
2150ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
2151ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
215266150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**);
21533f8d5cfcSshane 
21543f8d5cfcSshane /*
21553f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
21563f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
2157952856adSshane ** file.  Code should use the MACRO forms below, as the Varint32 versions
2158952856adSshane ** are coded to assume the single byte case is already handled (which
2159952856adSshane ** the MACRO form does).
21603f8d5cfcSshane */
2161192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
216235b5a33eSdrh int sqlite3PutVarint32(unsigned char*, u32);
216390e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
21646d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
2165192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
21663f8d5cfcSshane 
21673f8d5cfcSshane /*
21683f8d5cfcSshane ** The header of a record consists of a sequence variable-length integers.
21693f8d5cfcSshane ** These integers are almost always small and are encoded as a single byte.
21703f8d5cfcSshane ** The following macros take advantage this fact to provide a fast encode
21713f8d5cfcSshane ** and decode of the integers in a record header.  It is faster for the common
21723f8d5cfcSshane ** case where the integer is a single byte.  It is a little slower when the
21733f8d5cfcSshane ** integer is two or more bytes.  But overall it is faster.
21743f8d5cfcSshane **
21753f8d5cfcSshane ** The following expressions are equivalent:
21763f8d5cfcSshane **
21773f8d5cfcSshane **     x = sqlite3GetVarint32( A, &B );
21783f8d5cfcSshane **     x = sqlite3PutVarint32( A, B );
21793f8d5cfcSshane **
21803f8d5cfcSshane **     x = getVarint32( A, B );
21813f8d5cfcSshane **     x = putVarint32( A, B );
21823f8d5cfcSshane **
21833f8d5cfcSshane */
21843f8d5cfcSshane #define getVarint32(A,B)  ((*(A)<(unsigned char)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), &(B)))
21853f8d5cfcSshane #define putVarint32(A,B)  (((B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
21863f8d5cfcSshane #define getVarint    sqlite3GetVarint
21873f8d5cfcSshane #define putVarint    sqlite3PutVarint
21883f8d5cfcSshane 
21893f8d5cfcSshane 
2190a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
2191a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
2192e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
2193e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
2194bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
2195b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*);
21969bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
2197ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
2198ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
2199f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
22008a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
22019bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
22020202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
22037cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
22048b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
22057cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2206d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2207b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
22084e6af134Sdanielk1977 
2209b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2210b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2211b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
22121e536953Sdanielk1977                         void(*)(void*));
22134e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
22141e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
22151e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
22161e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2217b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
221846c99e0fSdrh #ifndef SQLITE_AMALGAMATION
22194e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
222040257ffdSdrh extern struct Sqlite3Config sqlite3Config;
222146c99e0fSdrh #endif
2222a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
22234343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
22241f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
22259fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
22269fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
22272958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2228d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
22290cdc022eSdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *, int);
2230b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
2231aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
223219a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
223319a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
22344dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
22358a51256cSdrh char sqlite3AffinityType(const Token*);
22369f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2237a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2238ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
2239cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
224051147baaSdrh void sqlite3DefaultRowEst(Index*);
224155ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2242d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
2243f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
2244fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
2245da184236Sdanielk1977 void sqlite3SchemaFree(void *);
22461e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
2247e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
2248b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
2249771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2250771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
2251771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
225254f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
2253ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
225469dab1d3Sdrh 
2255f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int);
2256ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2257ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
2258ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
22591013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
22601e536953Sdanielk1977 
226195bdbbbdSdrh /*
226295bdbbbdSdrh ** The interface to the LEMON-generated parser
226395bdbbbdSdrh */
226495bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
226595bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
226695bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
2267ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
2268ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
2269ec424a5bSdrh #endif
227095bdbbbdSdrh 
2271caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*);
227269dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
2273f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
227469dab1d3Sdrh #else
227569dab1d3Sdrh # define sqlite3CloseExtensions(X)
227669dab1d3Sdrh #endif
2277e3026636Sdanielk1977 
2278c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2279c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
2280c00da105Sdanielk1977 #else
2281c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
2282c00da105Sdanielk1977 #endif
2283c00da105Sdanielk1977 
228453c14021Sdrh #ifdef SQLITE_TEST
228553c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
228653c14021Sdrh #endif
228753c14021Sdrh 
2288b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
2289b9bb7c18Sdrh #  define sqlite3VtabClear(X)
22909dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
2291f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
2292f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
2293b9bb7c18Sdrh #else
2294707205d1Sdrh    void sqlite3VtabClear(Table*);
22953e3a84d3Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, char **);
2296f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
2297f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
2298b9bb7c18Sdrh #endif
22994f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
2300189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*);
2301a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
2302b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2303b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
2304b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
2305b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
230678efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
23077e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
23089e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
2309f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
23101e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
2311b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
2312b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
2313b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
2314bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
2315b9bb7c18Sdrh 
2316643167ffSdrh 
2317643167ffSdrh /*
2318643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
2319643167ffSdrh */
2320643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
23217e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
2322643167ffSdrh 
2323643167ffSdrh /*
2324ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
2325ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
2326ef05f2dfSdanielk1977 ** is not defined.
2327643167ffSdrh */
23283088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
23292d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
23302d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
2331643167ffSdrh #else
23322d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
2333867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
2334643167ffSdrh #endif
2335643167ffSdrh 
23369a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
23379a96b668Sdanielk1977 #define IN_INDEX_EPH             2
23389a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
23390cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int*);
23409a96b668Sdanielk1977 
2341c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
2342c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2343c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
2344f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
2345c7b6017cSdanielk1977 #else
2346c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2347c7b6017cSdanielk1977 #endif
2348c7b6017cSdanielk1977 
23490224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
23504b5255acSdanielk1977   void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
2351fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
2352fc976065Sdanielk1977 #else
23534b5255acSdanielk1977   #define sqlite3ExprSetHeight(x,y)
23540224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
2355fc976065Sdanielk1977 #endif
2356fc976065Sdanielk1977 
2357a3152895Sdrh u32 sqlite3Get4byte(const u8*);
2358a3152895Sdrh void sqlite3Put4byte(u8*, u32);
2359a3152895Sdrh 
2360fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
2361fd9a0a45Sdanielk1977 #include "sseInt.h"
2362fd9a0a45Sdanielk1977 #endif
2363fd9a0a45Sdanielk1977 
23646e736838Sdrh #ifdef SQLITE_DEBUG
23656e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
23666e736838Sdrh #endif
23676e736838Sdrh 
2368b0603416Sdrh /*
2369b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
23703a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
2371b0603416Sdrh ** print I/O tracing messages.
2372b0603416Sdrh */
2373b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
23743a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
2375b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
2376e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
2377b0603416Sdrh #else
2378b0603416Sdrh # define IOTRACE(A)
2379b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
2380b0603416Sdrh #endif
2381b0603416Sdrh 
2382e3026636Sdanielk1977 #endif
2383