xref: /sqlite-3.40.0/src/sqliteInt.h (revision 8b213899)
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*8b213899Sdrh ** @(#) $Id: sqliteInt.h,v 1.762 2008/08/29 02:14:03 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 
2117d10d5a6Sdrh /*
2127d10d5a6Sdrh ** The TCL headers are only needed when compiling the TCL bindings.
2137d10d5a6Sdrh */
2144f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
2154f0c5878Sdrh # include <tcl.h>
216824d7c18Sdrh #endif
217824d7c18Sdrh 
218824d7c18Sdrh /*
2194b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
220b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
2214b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
2224b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
2234b529d97Sdrh ** feature.
2244b529d97Sdrh */
225289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
2264b529d97Sdrh # define NDEBUG 1
2274b529d97Sdrh #endif
2284b529d97Sdrh 
2291d482dd9Sdrh #include "sqlite3.h"
230beae3194Sdrh #include "hash.h"
23175897234Sdrh #include "parse.h"
23275897234Sdrh #include <stdio.h>
23375897234Sdrh #include <stdlib.h>
23475897234Sdrh #include <string.h>
23575897234Sdrh #include <assert.h>
23652370e2cSdrh #include <stddef.h>
23775897234Sdrh 
238967e8b73Sdrh /*
239b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
240b37df7b9Sdrh ** substitute integer for floating-point
241b37df7b9Sdrh */
242b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
243b37df7b9Sdrh # define double sqlite_int64
244b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
245d1167393Sdrh # ifndef SQLITE_BIG_DBL
246b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
247d1167393Sdrh # endif
248b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
249b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
250110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
251b37df7b9Sdrh #endif
252d1167393Sdrh #ifndef SQLITE_BIG_DBL
253d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
254d1167393Sdrh #endif
255b37df7b9Sdrh 
256b37df7b9Sdrh /*
25753c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
25853c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
25953c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
26053c0f748Sdanielk1977 */
26153c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
26253c0f748Sdanielk1977 #define OMIT_TEMPDB 1
26353c0f748Sdanielk1977 #else
26453c0f748Sdanielk1977 #define OMIT_TEMPDB 0
26553c0f748Sdanielk1977 #endif
26653c0f748Sdanielk1977 
26753c0f748Sdanielk1977 /*
2680bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
2690bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
2700bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
2710bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
2720bd1f4eaSdrh ** is the way things are suppose to work.
2730bd1f4eaSdrh **
2740bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
2750bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
2760bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
2770bd1f4eaSdrh ** work.
2780bd1f4eaSdrh */
2790bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
2800bd1f4eaSdrh 
2810bd1f4eaSdrh /*
282d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
283d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
284d946db00Sdrh ** the default file format for new databases and the maximum file format
285d946db00Sdrh ** that the library can read.
286d946db00Sdrh */
287d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
288d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
28976fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
290d946db00Sdrh #endif
291d946db00Sdrh 
292d946db00Sdrh /*
293b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
29449766d6cSdrh ** on the command-line
29549766d6cSdrh */
296b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
297b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
29849766d6cSdrh #endif
29949766d6cSdrh 
30049766d6cSdrh /*
301f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
302f1974846Sdrh ** ourselves.
303f1974846Sdrh */
304f1974846Sdrh #ifndef offsetof
305f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
306f1974846Sdrh #endif
307f1974846Sdrh 
308f1974846Sdrh /*
3099b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
3109b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
3119b8f447bSdrh */
3129b8f447bSdrh #if 'A' == '\301'
3139b8f447bSdrh # define SQLITE_EBCDIC 1
3149b8f447bSdrh #else
3159b8f447bSdrh # define SQLITE_ASCII 1
3169b8f447bSdrh #endif
3179b8f447bSdrh 
3189b8f447bSdrh /*
3195a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
3205a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
3215a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
3225a2c2c20Sdrh **
3235a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
32441a2b48bSdrh */
3255a2c2c20Sdrh #ifndef UINT32_TYPE
326dda5b68cSmlcreech # ifdef HAVE_UINT32_T
327dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
328dda5b68cSmlcreech # else
3295a2c2c20Sdrh #  define UINT32_TYPE unsigned int
3305a2c2c20Sdrh # endif
331dda5b68cSmlcreech #endif
3325a2c2c20Sdrh #ifndef UINT16_TYPE
333dda5b68cSmlcreech # ifdef HAVE_UINT16_T
334dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
335dda5b68cSmlcreech # else
3365a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
3375a2c2c20Sdrh # endif
338dda5b68cSmlcreech #endif
339939a16d6Sdrh #ifndef INT16_TYPE
340dda5b68cSmlcreech # ifdef HAVE_INT16_T
341dda5b68cSmlcreech #  define INT16_TYPE int16_t
342dda5b68cSmlcreech # else
343939a16d6Sdrh #  define INT16_TYPE short int
344939a16d6Sdrh # endif
345dda5b68cSmlcreech #endif
3465a2c2c20Sdrh #ifndef UINT8_TYPE
347dda5b68cSmlcreech # ifdef HAVE_UINT8_T
348dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
349dda5b68cSmlcreech # else
3505a2c2c20Sdrh #  define UINT8_TYPE unsigned char
3515a2c2c20Sdrh # endif
352dda5b68cSmlcreech #endif
353905793e2Sdrh #ifndef INT8_TYPE
354dda5b68cSmlcreech # ifdef HAVE_INT8_T
355dda5b68cSmlcreech #  define INT8_TYPE int8_t
356dda5b68cSmlcreech # else
357905793e2Sdrh #  define INT8_TYPE signed char
358905793e2Sdrh # endif
359dda5b68cSmlcreech #endif
360efad9995Sdrh #ifndef LONGDOUBLE_TYPE
361efad9995Sdrh # define LONGDOUBLE_TYPE long double
362efad9995Sdrh #endif
363efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
36427436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
3655a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
3665a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
367939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
3685a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
36970a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
3705a2c2c20Sdrh 
3715a2c2c20Sdrh /*
372bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
373bbd42a6dSdrh ** evaluated at runtime.
374bbd42a6dSdrh */
37546c99e0fSdrh #ifdef SQLITE_AMALGAMATION
3767ff4a45eSmlcreech const int sqlite3one;
37746c99e0fSdrh #else
378bbd42a6dSdrh extern const int sqlite3one;
37946c99e0fSdrh #endif
38038def054Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)
38138def054Sdrh # define SQLITE_BIGENDIAN    0
38238def054Sdrh # define SQLITE_LITTLEENDIAN 1
38338def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
38438def054Sdrh #else
3859c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
3869c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
38738def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
38838def054Sdrh #endif
389bbd42a6dSdrh 
390bbd42a6dSdrh /*
3910f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
3920f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
3930f050353Sdrh ** compilers.
3940f050353Sdrh */
3950f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
3960f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
3970f050353Sdrh 
3980f050353Sdrh /*
39990f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
40090f5ecb3Sdrh ** callback for a given sqlite handle.
40190f5ecb3Sdrh **
40290f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
40390f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
40490f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
40590f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
40690f5ecb3Sdrh */
40790f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
40890f5ecb3Sdrh struct BusyHandler {
40990f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
41090f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
411a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
41290f5ecb3Sdrh };
41390f5ecb3Sdrh 
41490f5ecb3Sdrh /*
41575897234Sdrh ** Name of the master database table.  The master database table
41675897234Sdrh ** is a special table that holds the names and attributes of all
41775897234Sdrh ** user tables and indices.
41875897234Sdrh */
41975897234Sdrh #define MASTER_NAME       "sqlite_master"
420e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
42175897234Sdrh 
42275897234Sdrh /*
4238e150818Sdanielk1977 ** The root-page of the master database table.
4248e150818Sdanielk1977 */
4258e150818Sdanielk1977 #define MASTER_ROOT       1
4268e150818Sdanielk1977 
4278e150818Sdanielk1977 /*
428ed6c8671Sdrh ** The name of the schema table.
429ed6c8671Sdrh */
43053c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
431ed6c8671Sdrh 
432ed6c8671Sdrh /*
43375897234Sdrh ** A convenience macro that returns the number of elements in
43475897234Sdrh ** an array.
43575897234Sdrh */
43675897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
43775897234Sdrh 
43875897234Sdrh /*
439633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
440633e6d57Sdrh ** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
441633e6d57Sdrh */
442633e6d57Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3DbFree)
443633e6d57Sdrh 
444633e6d57Sdrh /*
44575897234Sdrh ** Forward references to structures
44675897234Sdrh */
44713449892Sdrh typedef struct AggInfo AggInfo;
448fe05af87Sdrh typedef struct AuthContext AuthContext;
449f5e7bb51Sdrh typedef struct Bitvec Bitvec;
450fe05af87Sdrh typedef struct CollSeq CollSeq;
4517020f651Sdrh typedef struct Column Column;
452fe05af87Sdrh typedef struct Db Db;
453e501b89aSdanielk1977 typedef struct Schema Schema;
45475897234Sdrh typedef struct Expr Expr;
45575897234Sdrh typedef struct ExprList ExprList;
456c2eef3b3Sdrh typedef struct FKey FKey;
457fe05af87Sdrh typedef struct FuncDef FuncDef;
45870a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
459fe05af87Sdrh typedef struct IdList IdList;
460fe05af87Sdrh typedef struct Index Index;
4618d059845Sdanielk1977 typedef struct KeyClass KeyClass;
462d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
463633e6d57Sdrh typedef struct Lookaside Lookaside;
464633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
465d1ab1ba5Sdanielk1977 typedef struct Module Module;
466626a879aSdrh typedef struct NameContext NameContext;
467fe05af87Sdrh typedef struct Parse Parse;
468fe05af87Sdrh typedef struct Select Select;
469fe05af87Sdrh typedef struct SrcList SrcList;
470ade86483Sdrh typedef struct StrAccum StrAccum;
471fe05af87Sdrh typedef struct Table Table;
472c00da105Sdanielk1977 typedef struct TableLock TableLock;
473fe05af87Sdrh typedef struct Token Token;
474fe05af87Sdrh typedef struct TriggerStack TriggerStack;
475fe05af87Sdrh typedef struct TriggerStep TriggerStep;
476fe05af87Sdrh typedef struct Trigger Trigger;
477e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
4787d10d5a6Sdrh typedef struct Walker Walker;
479fe05af87Sdrh typedef struct WhereInfo WhereInfo;
480fe05af87Sdrh typedef struct WhereLevel WhereLevel;
481d3d39e93Sdrh 
4822dca4ac1Sdanielk1977 /*
4832dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
4842dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
4852dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
4862dca4ac1Sdanielk1977 */
4872dca4ac1Sdanielk1977 #include "btree.h"
4882dca4ac1Sdanielk1977 #include "vdbe.h"
4892dca4ac1Sdanielk1977 #include "pager.h"
4908c0a791aSdanielk1977 #include "pcache.h"
4912dca4ac1Sdanielk1977 
4921cc5ed81Sdanielk1977 #include "os.h"
493c7ce76afSdrh #include "mutex.h"
4941cc5ed81Sdanielk1977 
495eee4c8caSdrh 
496001bbcbbSdrh /*
497001bbcbbSdrh ** Each database file to be accessed by the system is an instance
498001bbcbbSdrh ** of the following structure.  There are normally two of these structures
499001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
500a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
501a69d9168Sdrh ** databases may be attached.
502001bbcbbSdrh */
503001bbcbbSdrh struct Db {
504001bbcbbSdrh   char *zName;         /* Name of this database */
505001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
506da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
507da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
508da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
509da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
510e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
511da184236Sdanielk1977 };
512da184236Sdanielk1977 
513da184236Sdanielk1977 /*
514da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
515a04a34ffSdanielk1977 **
516a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the
517a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table
518a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection
519a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been
520a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated,
521a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare
522a04a34ffSdanielk1977 ** statements.
523da184236Sdanielk1977 */
524e501b89aSdanielk1977 struct Schema {
525001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
526d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
527d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
528d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
529d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
5304794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
531da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
5328079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
533da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
53414db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
535a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
536a04a34ffSdanielk1977   sqlite3 *db;         /* "Owner" connection. See comment above */
537a04a34ffSdanielk1977 #endif
538001bbcbbSdrh };
53975897234Sdrh 
54075897234Sdrh /*
5418bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
5428bf8dc92Sdrh ** Db.flags field.
5438bf8dc92Sdrh */
544da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
545da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
546da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
547da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
5488bf8dc92Sdrh 
5498bf8dc92Sdrh /*
5508bf8dc92Sdrh ** Allowed values for the DB.flags field.
5518bf8dc92Sdrh **
5528bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
5538bf8dc92Sdrh ** read into internal hash tables.
5548bf8dc92Sdrh **
5558bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
5568bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
5578bf8dc92Sdrh ** changes and so the view will need to be reset.
5588bf8dc92Sdrh */
559124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
560124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
561b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
5628bf8dc92Sdrh 
563caa639f4Sdrh /*
564caa639f4Sdrh ** The number of different kinds of things that can be limited
565caa639f4Sdrh ** using the sqlite3_limit() interface.
566caa639f4Sdrh */
567caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
5688bf8dc92Sdrh 
5698bf8dc92Sdrh /*
570633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
571633e6d57Sdrh ** to satisify small transient memory allocation requests for objects
572633e6d57Sdrh ** associated with a particular database connection.  The use of
573633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
574633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
575633e6d57Sdrh ** SQL statements.
576633e6d57Sdrh **
577633e6d57Sdrh ** The Lookaside structure holds configuration information about the
578633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
579633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
580633e6d57Sdrh ** objects.
581633e6d57Sdrh */
582633e6d57Sdrh struct Lookaside {
583633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
584633e6d57Sdrh   u8 bEnabled;            /* True if use lookaside.  False to ignore it */
585e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
586633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
587633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
5887d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
589633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
590633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
591633e6d57Sdrh };
592633e6d57Sdrh struct LookasideSlot {
593633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
594633e6d57Sdrh };
595633e6d57Sdrh 
596633e6d57Sdrh /*
59770a8ca3cSdrh ** A hash table for function definitions.
59870a8ca3cSdrh **
59970a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
60070a8ca3cSdrh ** Collisions are on the FuncDef.pHash chain.
60170a8ca3cSdrh */
60270a8ca3cSdrh struct FuncDefHash {
60370a8ca3cSdrh   FuncDef *a[23];       /* Hash table for functions */
60470a8ca3cSdrh };
60570a8ca3cSdrh 
60670a8ca3cSdrh /*
607c9b84a1fSdrh ** Each database is an instance of the following structure.
608c9b84a1fSdrh **
609b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
610b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
611b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
612b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
613b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
614b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
615b0c374ffSrdc **
616b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
6176f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
618b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
619b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
620b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
621b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
622b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
623b0c374ffSrdc ** affect the value of lsChange.
624b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
625b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
6266622cce3Sdanielk1977 **
6276622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
6286622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
6296622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
6306622cce3Sdanielk1977 ** consistently.
63175897234Sdrh */
6329bb575fdSdrh struct sqlite3 {
63390f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
634001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
635001bbcbbSdrh   Db *aDb;                      /* All backends */
6368c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
63733f4e02aSdrh   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
638fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
6394ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
640fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
64190f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
64217435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
6433b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
6443b02013eSdrh   u8 dfltJournalMode;           /* Default journal mode for attached dbs */
64598757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
646f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
6472803757aSdrh   int nTable;                   /* Number of tables in the database */
648d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
649f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
650f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
651247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
652b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
653b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
654d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
655caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
6564adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
6571d85d931Sdrh     int iDb;                    /* When back is being initialized */
6581d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
6591d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
6601d85d931Sdrh   } init;
661f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
662761df87eSdrh   void **aExtension;            /* Array of shared libraray handles */
663326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
6641d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
66518de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
66618de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
66719e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
66819e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
669fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
670fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
67171fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
67271fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
67394eb6a14Sdanielk1977   void *pUpdateArg;
67494eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
675fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
676fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
677fcd35c7bSdrh   void *pCollNeededArg;
678fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
679fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
680fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
681881feaa0Sdrh   union {
682881feaa0Sdrh     int isInterrupted;          /* True if sqlite3_interrupt has been called */
683881feaa0Sdrh     double notUsed1;            /* Spacer */
684881feaa0Sdrh   } u1;
685633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
686ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
687e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
688e22a334bSdrh                                 /* Access authorization function */
689ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
690ed6c8671Sdrh #endif
691348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
692348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
693348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
694348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
695348bb5d6Sdanielk1977 #endif
696b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
697b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
6987e6ebfb2Sdanielk1977   Table *pVTab;                 /* vtab with active Connect/Create method */
699f9e7dda7Sdanielk1977   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
700f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
7016b456a2bSdanielk1977 #endif
70270a8ca3cSdrh   FuncDefHash aFunc;            /* Hash table of connection functions */
703fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
704fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
70597903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
706fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
7077e900abfSdanielk1977 #ifdef SQLITE_SSE
7087e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
7097e900abfSdanielk1977 #endif
71075897234Sdrh };
71175897234Sdrh 
71203b808a6Sdrh /*
71303b808a6Sdrh ** A macro to discover the encoding of a database.
71403b808a6Sdrh */
71514db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
71614db2665Sdanielk1977 
71775897234Sdrh /*
7188bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
7198bf8dc92Sdrh **
7208bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
7218bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
7228bf8dc92Sdrh ** transaction is active on that particular database file.
72375897234Sdrh */
7244c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
725c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
7265e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
727382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
728fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
729fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
7301bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
7311bee3d7bSdrh                                           /*   the count using a callback. */
732fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
7336a535340Sdrh                                           /*   result set is empty */
73435d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
73535d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
736f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
7377bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
7387bec505eSdrh                                           ** accessing read-only databases */
7390cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
740da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
741e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
742ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
743c2e87a3eSdrh #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
74458b9576bSdrh 
74534c68fbaSdanielk1977 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
7464a50aac5Sdrh #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
7474a50aac5Sdrh #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
74834c68fbaSdanielk1977 
74958b9576bSdrh /*
750247be43dSdrh ** Possible values for the sqlite.magic field.
751247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
752247be43dSdrh ** than being distinct from one another.
753247be43dSdrh */
754247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
755247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
7567e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
757247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
758247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
759247be43dSdrh 
760247be43dSdrh /*
7610bce8354Sdrh ** Each SQL function is defined by an instance of the following
7620bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
7638e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
7648e0a2f90Sdrh ** points to a linked list of these structures.
7652803757aSdrh */
7660bce8354Sdrh struct FuncDef {
76770a8ca3cSdrh   i8 nArg;             /* Number of arguments.  -1 means unlimited */
768d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
76955ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
77055ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
7711350b030Sdrh   void *pUserData;     /* User data parameter */
7720bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
773f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
774f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
775f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
7768c0a791aSdanielk1977   char *zName;         /* SQL name of the function. */
77770a8ca3cSdrh   FuncDef *pHash;      /* Next with a different name but the same hash */
7788e0a2f90Sdrh };
7792803757aSdrh 
7802803757aSdrh /*
7817d10d5a6Sdrh ** Possible values for FuncDef.flags
7827d10d5a6Sdrh */
7837d10d5a6Sdrh #define SQLITE_FUNC_LIKE     0x01  /* Candidate for the LIKE optimization */
7847d10d5a6Sdrh #define SQLITE_FUNC_CASE     0x02  /* Case-sensitive LIKE-type function */
7857d10d5a6Sdrh #define SQLITE_FUNC_EPHEM    0x04  /* Ephermeral.  Delete with VDBE */
7867d10d5a6Sdrh 
7877d10d5a6Sdrh /*
788777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
789777c5386Sdrh ** used to create the initializers for the FuncDef structures.
790777c5386Sdrh **
791777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
792777c5386Sdrh **     Used to create a scalar function definition of a function zName
793777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
794777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
795777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
796777c5386Sdrh **     argument bNC is true, then the FuncDef.needCollate flag is set.
797777c5386Sdrh **
798777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
799777c5386Sdrh **     Used to create an aggregate function definition implemented by
800777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
801777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
802777c5386Sdrh **     FUNCTION().
803777c5386Sdrh **
804777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
805777c5386Sdrh **     Used to create a scalar function definition of a function zName
806777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
807777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
808777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
809777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
810777c5386Sdrh **     parameter.
811777c5386Sdrh */
812777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
813777c5386Sdrh   {nArg, SQLITE_UTF8, bNC, 0, SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName}
814777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
815777c5386Sdrh   {nArg, SQLITE_UTF8, 0, flags, (void *)arg, 0, likeFunc, 0, 0, #zName}
816777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
817777c5386Sdrh   {nArg, SQLITE_UTF8, nc, 0, SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal, #zName}
818777c5386Sdrh 
819777c5386Sdrh 
820777c5386Sdrh /*
821d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
822d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
823d1ab1ba5Sdanielk1977 ** hash table.
824d1ab1ba5Sdanielk1977 */
825d1ab1ba5Sdanielk1977 struct Module {
826d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
827d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
828d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
829832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
830d1ab1ba5Sdanielk1977 };
831d1ab1ba5Sdanielk1977 
832d1ab1ba5Sdanielk1977 /*
833967e8b73Sdrh ** information about each column of an SQL table is held in an instance
8347020f651Sdrh ** of this structure.
8357020f651Sdrh */
8367020f651Sdrh struct Column {
8377020f651Sdrh   char *zName;     /* Name of this column */
8387977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
839382c0247Sdrh   char *zType;     /* Data type for this column */
840b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
8414a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
84278100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
843a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
844034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
845034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
846034ca14fSdanielk1977 #endif
8477020f651Sdrh };
8487020f651Sdrh 
8497020f651Sdrh /*
850a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
8510202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
8520202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
853a9fd84b0Sdrh **
8540202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
8550202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
8560202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
8570202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
8580202b29eSdanielk1977 ** the version that will require the least expensive encoding
859b3bf556eSdanielk1977 ** translations, if any.
8600202b29eSdanielk1977 **
8610202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
8620202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
8630202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
8640202b29eSdanielk1977 ** xCmp16.
8650202b29eSdanielk1977 **
8660202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
8670202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
8680202b29eSdanielk1977 ** collating sequence may not be read or written.
869a9fd84b0Sdrh */
870a9fd84b0Sdrh struct CollSeq {
8710202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
872466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
873d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
874a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
8750202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
876a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
877a9fd84b0Sdrh };
878a9fd84b0Sdrh 
879a9fd84b0Sdrh /*
8807d10d5a6Sdrh ** Allowed values of CollSeq.type:
881d64fe2f3Sdrh */
882d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
883d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
884d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
885d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
886d64fe2f3Sdrh 
887d64fe2f3Sdrh /*
888d3d39e93Sdrh ** A sort order can be either ASC or DESC.
8898e2ca029Sdrh */
8908e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
891d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
8928e2ca029Sdrh 
8938e2ca029Sdrh /*
894a37cdde0Sdanielk1977 ** Column affinity types.
8958a51256cSdrh **
8968a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
8978a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
8987d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
8998a51256cSdrh **
9008a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
9018a51256cSdrh ** when multiple affinity types are concatenated into a string and
90266a5167bSdrh ** used as the P4 operand, they will be more readable.
9038a51256cSdrh **
9048a51256cSdrh ** Note also that the numeric types are grouped together so that testing
9058a51256cSdrh ** for a numeric type is a single comparison.
906a37cdde0Sdanielk1977 */
9078a51256cSdrh #define SQLITE_AFF_TEXT     'a'
9088a51256cSdrh #define SQLITE_AFF_NONE     'b'
9098a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
9108a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
9118a51256cSdrh #define SQLITE_AFF_REAL     'e'
912a37cdde0Sdanielk1977 
9138a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
914a37cdde0Sdanielk1977 
915a37cdde0Sdanielk1977 /*
91635573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
91735573356Sdrh ** affinity value.
91835573356Sdrh */
91935573356Sdrh #define SQLITE_AFF_MASK     0x67
92035573356Sdrh 
92135573356Sdrh /*
92235573356Sdrh ** Additional bit values that can be ORed with an affinity without
92335573356Sdrh ** changing the affinity.
92435573356Sdrh */
92535573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
92693a960a0Sdrh #define SQLITE_STOREP2      0x10  /* Store result in reg[P2] rather than jump */
92735573356Sdrh 
92835573356Sdrh /*
92922f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
93022f70c32Sdrh ** following structure.
93122f70c32Sdrh **
932d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
93322f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
93422f70c32Sdrh ** comparisons.
93522f70c32Sdrh **
936d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
93722f70c32Sdrh ** pointer to an array of Column structures, one for each column.
93822f70c32Sdrh **
939d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
940d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
94122f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
94222f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
94322f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
9447d10d5a6Sdrh ** is generated for each row of the table.  TF_HasPrimaryKey is set if
94522f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
94622f70c32Sdrh **
947d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
948d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
949d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
9507d10d5a6Sdrh ** holds temporary tables and indices.  If TF_Ephemeral is set
9517d10d5a6Sdrh ** then the table is stored in a file that is automatically deleted
952d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
95322f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
95422f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
95522f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
95622f70c32Sdrh ** of a SELECT statement.
95775897234Sdrh */
95875897234Sdrh struct Table {
959633e6d57Sdrh   sqlite3 *db;         /* Associated database connection.  Might be NULL. */
9607d10d5a6Sdrh   char *zName;         /* Name of the table or view */
9617d10d5a6Sdrh   int iPKey;           /* If not negative, use aCol[iPKey] as the primary key */
96275897234Sdrh   int nCol;            /* Number of columns in this table */
9637020f651Sdrh   Column *aCol;        /* Information about each column */
964967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
96522f70c32Sdrh   int tnum;            /* Root BTree node for this table (see note above) */
966a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
9677d10d5a6Sdrh   u16 nRef;            /* Number of pointers to this Table */
9687d10d5a6Sdrh   u8 tabFlags;         /* Mask of TF_* values */
9697d10d5a6Sdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
970c3f9bad2Sdanielk1977   Trigger *pTrigger;   /* List of SQL triggers on this table */
971c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
9723d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
973ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
974ffe07b2dSdrh   Expr *pCheck;        /* The AND of all CHECK constraints */
975ffe07b2dSdrh #endif
97619a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
9777d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
97819a8e7e8Sdanielk1977 #endif
979e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
980d1ab1ba5Sdanielk1977   Module *pMod;        /* Pointer to the implementation of the module */
981b9bb7c18Sdrh   sqlite3_vtab *pVtab; /* Pointer to the module instance */
982b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
983b9bb7c18Sdrh   char **azModuleArg;  /* Text of all module args. [0] is module name */
984e09daa90Sdrh #endif
985728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
98675897234Sdrh };
98775897234Sdrh 
98875897234Sdrh /*
9897d10d5a6Sdrh ** Allowed values for Tabe.tabFlags.
9907d10d5a6Sdrh */
9917d10d5a6Sdrh #define TF_Readonly        0x01    /* Read-only system table */
9927d10d5a6Sdrh #define TF_Ephemeral       0x02    /* An emphermal table */
9937d10d5a6Sdrh #define TF_HasPrimaryKey   0x04    /* Table has a primary key */
9947d10d5a6Sdrh #define TF_Autoincrement   0x08    /* Integer primary key is autoincrement */
9957d10d5a6Sdrh #define TF_Virtual         0x10    /* Is a virtual table */
9967d10d5a6Sdrh #define TF_NeedMetadata    0x20    /* aCol[].zType and aCol[].pColl missing */
9977d10d5a6Sdrh 
9987d10d5a6Sdrh 
9997d10d5a6Sdrh 
10007d10d5a6Sdrh /*
10014cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
10024cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
10034cbdda9eSdrh ** table support is omitted from the build.
10044cbdda9eSdrh */
10054cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
10067d10d5a6Sdrh #  define IsVirtual(X)      (((X)->tabFlags & TF_Virtual)!=0)
1007034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
10084cbdda9eSdrh #else
10094cbdda9eSdrh #  define IsVirtual(X)      0
1010034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
10114cbdda9eSdrh #endif
10124cbdda9eSdrh 
10134cbdda9eSdrh /*
1014c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
1015c2eef3b3Sdrh **
1016c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
1017c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
1018c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
1019c2eef3b3Sdrh ** Consider this example:
1020c2eef3b3Sdrh **
1021c2eef3b3Sdrh **     CREATE TABLE ex1(
1022c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
1023c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1024c2eef3b3Sdrh **     );
1025c2eef3b3Sdrh **
1026c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1027c2eef3b3Sdrh **
1028c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
1029c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
1030c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
1031c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
1032c2eef3b3Sdrh **
1033ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
1034c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
1035c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
1036c2eef3b3Sdrh ** field.
1037c2eef3b3Sdrh */
1038c2eef3b3Sdrh struct FKey {
1039c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
1040c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
1041c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
1042c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
1043c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
1044c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
1045c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
1046c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
1047c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
1048c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
1049c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
1050c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
1051c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
1052c2eef3b3Sdrh };
1053c2eef3b3Sdrh 
1054c2eef3b3Sdrh /*
1055aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
105622f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
10570bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
10581c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
10591c92853dSdrh ** fails and any prior changes from that one operation are backed out,
10601c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
10611c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
10621c92853dSdrh ** changes due to the same operation are not backed out and no rollback
10631c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
10641c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
10651c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
10661c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
10671c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
10681c92853dSdrh **
1069c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1070c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1071c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1072c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1073c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1074c2eef3b3Sdrh ** foreign key.
1075c2eef3b3Sdrh **
1076968af52aSdrh ** The following symbolic values are used to record which type
10771c92853dSdrh ** of action to take.
10789cfcf5d4Sdrh */
10799cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
10801c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
10811c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
10821c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
10831c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
10841c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1085c2eef3b3Sdrh 
1086c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1087c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1088c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1089c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1090c2eef3b3Sdrh 
1091c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
10929cfcf5d4Sdrh 
1093d3d39e93Sdrh 
1094d3d39e93Sdrh /*
1095d3d39e93Sdrh ** An instance of the following structure is passed as the first
1096d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1097d3d39e93Sdrh ** comparison of the two index keys.
1098d3d39e93Sdrh */
1099d3d39e93Sdrh struct KeyInfo {
1100b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
1101b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
1102e63d9991Sdrh   u16 nField;         /* Number of entries in aColl[] */
1103d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
1104d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1105d3d39e93Sdrh };
1106d3d39e93Sdrh 
11079cfcf5d4Sdrh /*
1108e63d9991Sdrh ** An instance of the following structure holds information about a
1109e63d9991Sdrh ** single index record that has already been parsed out into individual
1110e63d9991Sdrh ** values.
1111e63d9991Sdrh **
1112e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1113e63d9991Sdrh ** Records are used to store the content of a table row and to store
1114e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1115e63d9991Sdrh ** the OP_MakeRecord opcode of the VDBE and is disassemblied by the
1116e63d9991Sdrh ** OP_Column opcode.
1117e63d9991Sdrh **
1118e63d9991Sdrh ** This structure holds a record that has already been disassembled
1119e63d9991Sdrh ** into its constitutent fields.
1120e63d9991Sdrh */
1121e63d9991Sdrh struct UnpackedRecord {
1122e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
1123e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1124e63d9991Sdrh   u16 flags;          /* Boolean settings.  UNPACKED_... below */
1125e63d9991Sdrh   Mem *aMem;          /* Values */
1126e63d9991Sdrh };
1127e63d9991Sdrh 
1128e63d9991Sdrh /*
1129e63d9991Sdrh ** Allowed values of UnpackedRecord.flags
1130e63d9991Sdrh */
1131e63d9991Sdrh #define UNPACKED_NEED_FREE     0x0001  /* Memory is from sqlite3Malloc() */
1132e63d9991Sdrh #define UNPACKED_NEED_DESTROY  0x0002  /* apMem[]s should all be destroyed */
1133e63d9991Sdrh #define UNPACKED_IGNORE_ROWID  0x0004  /* Ignore trailing rowid on key1 */
1134e63d9991Sdrh #define UNPACKED_INCRKEY       0x0008  /* Make this key an epsilon larger */
1135e63d9991Sdrh #define UNPACKED_PREFIX_MATCH  0x0010  /* A prefix match is considered OK */
1136e63d9991Sdrh 
1137e63d9991Sdrh /*
113866b89c8fSdrh ** Each SQL index is represented in memory by an
113975897234Sdrh ** instance of the following structure.
1140967e8b73Sdrh **
1141967e8b73Sdrh ** The columns of the table that are to be indexed are described
1142967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1143967e8b73Sdrh ** we have the following table and index:
1144967e8b73Sdrh **
1145967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1146967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1147967e8b73Sdrh **
1148967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1149967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1150967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1151967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1152967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1153967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1154967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1155ea1ba17cSdrh **
1156ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1157ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1158ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1159ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1160ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1161ea1ba17cSdrh ** element.
116275897234Sdrh */
116375897234Sdrh struct Index {
116475897234Sdrh   char *zName;     /* Name of this index */
1165967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1166967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
11678b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1168967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1169be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
11709cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1171485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1172a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
117375897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1174b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1175b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1176b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
117775897234Sdrh };
117875897234Sdrh 
117975897234Sdrh /*
118075897234Sdrh ** Each token coming out of the lexer is an instance of
11814b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
11824efc4754Sdrh **
11834efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
11844efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
11854efc4754Sdrh ** and Token.n when Token.z==0.
118675897234Sdrh */
118775897234Sdrh struct Token {
11884c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
11894b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
11906977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
119175897234Sdrh };
119275897234Sdrh 
119375897234Sdrh /*
119413449892Sdrh ** An instance of this structure contains information needed to generate
119513449892Sdrh ** code for a SELECT that contains aggregate functions.
119613449892Sdrh **
119713449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
119813449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
119913449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
120013449892Sdrh ** code for that node.
120113449892Sdrh **
120213449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
120313449892Sdrh ** original Select structure that describes the SELECT statement.  These
120413449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
120513449892Sdrh */
120613449892Sdrh struct AggInfo {
120713449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
120813449892Sdrh                           ** from source tables rather than from accumulators */
120913449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
121013449892Sdrh                           ** than the source table */
121113449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
121213449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
121313449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
121413449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
12150817d0dfSdanielk1977     Table *pTab;             /* Source table */
121613449892Sdrh     int iTable;              /* Cursor number of the source table */
121713449892Sdrh     int iColumn;             /* Column number within the source table */
121813449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
121913449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
12205774b806Sdrh     Expr *pExpr;             /* The original expression */
122113449892Sdrh   } *aCol;
122213449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
122313449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
122413449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
122513449892Sdrh                           ** Additional columns are used only as parameters to
122613449892Sdrh                           ** aggregate functions */
122713449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
122813449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
122913449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
123013449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1231b9bb7c18Sdrh     int iDistinct;           /* Ephermeral table used to enforce DISTINCT */
123213449892Sdrh   } *aFunc;
123313449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
123413449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
123513449892Sdrh };
123613449892Sdrh 
123713449892Sdrh /*
123875897234Sdrh ** Each node of an expression in the parse tree is an instance
123922f70c32Sdrh ** of this structure.
124022f70c32Sdrh **
124122f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
124222f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
124322f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
124422f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
124522f70c32Sdrh ** tree.
124622f70c32Sdrh **
124722f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
124822f70c32Sdrh ** of argument if the expression is a function.
124922f70c32Sdrh **
12504b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
12514b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
12524b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
12534b59ab5eSdrh ** a compound token.
125422f70c32Sdrh **
125522f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
125622f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
125722f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
125822f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
125922f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
126022f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
126122f70c32Sdrh ** it can be accessed after all aggregates are computed.
126222f70c32Sdrh **
126322f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
12647c972decSdrh ** representing which function.  If the expression is an unbound variable
12657c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
12667c972decSdrh ** Expr.iTable holds the index number for that variable.
126722f70c32Sdrh **
12681398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
12691398ad36Sdrh ** register number containing the result of the subquery.  If the
12701398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
12711398ad36Sdrh ** gives a different answer at different times during statement processing
12721398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
12731398ad36Sdrh **
127422f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
127522f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
127622f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
127722f70c32Sdrh ** operand.
1278aee18ef8Sdanielk1977 **
1279aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1280aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1281aee18ef8Sdanielk1977 ** corresponding table definition.
128275897234Sdrh */
128375897234Sdrh struct Expr {
12841cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1285a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
12866a03a1c5Sdrh   u16 flags;             /* Various flags.  See below */
1287f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
128875897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
1289d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
1290d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
129175897234Sdrh   Token token;           /* An operand token */
12926977fea8Sdrh   Token span;            /* Complete text of the expression */
1293967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
12948e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
129513449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
129613449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
129722d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1298d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
1299d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
13007d10d5a6Sdrh   Table *pTab;           /* Table for TK_COLUMN expressions. */
13010224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
1302fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1303fc976065Sdanielk1977 #endif
130475897234Sdrh };
130575897234Sdrh 
130675897234Sdrh /*
13071f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
13081f16230bSdrh */
1309678ccce8Sdrh #define EP_FromJoin   0x0001  /* Originated in ON or USING clause of a join */
1310678ccce8Sdrh #define EP_Agg        0x0002  /* Contains one or more aggregate functions */
1311678ccce8Sdrh #define EP_Resolved   0x0004  /* IDs have been resolved to COLUMNs */
1312678ccce8Sdrh #define EP_Error      0x0008  /* Expression contains one or more errors */
1313678ccce8Sdrh #define EP_Distinct   0x0010  /* Aggregate function with DISTINCT keyword */
1314678ccce8Sdrh #define EP_VarSelect  0x0020  /* pSelect is correlated, not constant */
1315678ccce8Sdrh #define EP_Dequoted   0x0040  /* True if the string has been dequoted */
1316678ccce8Sdrh #define EP_InfixFunc  0x0080  /* True for an infix function: LIKE, GLOB, etc */
1317678ccce8Sdrh #define EP_ExpCollate 0x0100  /* Collating sequence specified explicitly */
1318da250ea5Sdrh #define EP_AnyAff     0x0200  /* Can take a cached column of any affinity */
131947de955eSdrh #define EP_FixedDest  0x0400  /* Result needed in a specific register */
132092b01d53Sdrh #define EP_IntValue   0x0800  /* Integer value contained in iTable */
13211f16230bSdrh /*
13221f16230bSdrh ** These macros can be used to test, set, or clear bits in the
13231f16230bSdrh ** Expr.flags field.
13241f16230bSdrh */
13251f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
13261f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
13271f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
13281f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
13291f16230bSdrh 
13301f16230bSdrh /*
133175897234Sdrh ** A list of expressions.  Each expression may optionally have a
133275897234Sdrh ** name.  An expr/name combination can be used in several ways, such
133375897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
133475897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1335ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
133675897234Sdrh ** field is not used.
133775897234Sdrh */
133875897234Sdrh struct ExprList {
133975897234Sdrh   int nExpr;             /* Number of expressions on the list */
13404305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
13419d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
13426d4abfbeSdrh   struct ExprList_item {
134375897234Sdrh     Expr *pExpr;           /* The list of expressions */
134475897234Sdrh     char *zName;           /* Token associated with this expression */
13458e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
13468e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
13477d10d5a6Sdrh     u16 iCol;              /* For ORDER BY, column number in result set */
1348*8b213899Sdrh     u16 iAlias;            /* Index into Parse.aAlias[] for zName */
134975897234Sdrh   } *a;                  /* One entry for each expression */
135075897234Sdrh };
135175897234Sdrh 
135275897234Sdrh /*
1353ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1354ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1355ad3cab52Sdrh **
1356ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1357ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1358ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1359ad3cab52Sdrh **
1360ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1361ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1362ad3cab52Sdrh **
1363ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1364ad3cab52Sdrh **
1365ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
136675897234Sdrh */
136775897234Sdrh struct IdList {
13686d4abfbeSdrh   struct IdList_item {
1369ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1370967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1371ad3cab52Sdrh   } *a;
137213449892Sdrh   int nId;         /* Number of identifiers on the list */
137313449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1374ad3cab52Sdrh };
1375ad3cab52Sdrh 
1376ad3cab52Sdrh /*
137751669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1378ca83ac51Sdrh **
1379ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1380ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1381ca83ac51Sdrh ** of the library by 738 bytes on ix86.
138251669863Sdrh */
1383ca83ac51Sdrh typedef u64 Bitmask;
138451669863Sdrh 
138551669863Sdrh /*
1386ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1387ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1388ad3cab52Sdrh ** the SrcList.a[] array.
1389d24cc427Sdrh **
1390d24cc427Sdrh ** With the addition of multiple database support, the following structure
1391d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1392d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1393d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1394d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1395c49de5d9Sdrh **
1396c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1397c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1398c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1399c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
1400ad3cab52Sdrh */
1401ad3cab52Sdrh struct SrcList {
1402939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1403939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1404ad3cab52Sdrh   struct SrcList_item {
1405113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1406ad3cab52Sdrh     char *zName;      /* Name of the table */
1407ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1408daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1409daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
14101787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1411c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1412e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1413ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1414ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
141551669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1416113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
141775897234Sdrh };
141875897234Sdrh 
141975897234Sdrh /*
142001f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
142101f3f253Sdrh */
142201f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
14233dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
14243dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
14253dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
14263dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
14273dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
14283dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
142901f3f253Sdrh 
143001f3f253Sdrh /*
14316b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
14326b56344dSdrh ** structure contains a single instance of this structure.  This structure
14336b56344dSdrh ** is intended to be private the the where.c module and should not be
14346b56344dSdrh ** access or modified by other modules.
14356d209d8bSdrh **
14366d209d8bSdrh ** The pIdxInfo and pBestIdx fields are used to help pick the best
14376d209d8bSdrh ** index on a virtual table.  The pIdxInfo pointer contains indexing
14386d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
14396d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
14406d209d8bSdrh ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
14416d209d8bSdrh ** FROM clause ordering.  This is a little confusing so I will repeat
14426d209d8bSdrh ** it in different words.  WhereInfo.a[i].pIdxInfo is index information
14436d209d8bSdrh ** for WhereInfo.pTabList.a[i].  WhereInfo.a[i].pBestInfo is the
14446d209d8bSdrh ** index information for the i-th loop of the join.  pBestInfo is always
14456d209d8bSdrh ** either NULL or a copy of some pIdxInfo.  So for cleanup it is
14466d209d8bSdrh ** sufficient to free all of the pIdxInfo pointers.
14476d209d8bSdrh **
14486b56344dSdrh */
14496b56344dSdrh struct WhereLevel {
145029dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
145129dda4aeSdrh   int flags;            /* Flags associated with this level */
145251147baaSdrh   int iMem;             /* First memory cell used by this level */
145329dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
14549012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
14559012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
14569012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
14576b56344dSdrh   int brk;              /* Jump here to break out of the loop */
145872e8fa42Sdrh   int nxt;              /* Jump here to start the next IN combination */
14596b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1460ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
146129dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
146251147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1463e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
146472e8fa42Sdrh   struct InLoop {
146572e8fa42Sdrh     int iCur;              /* The VDBE cursor used by this IN operator */
146672e8fa42Sdrh     int topAddr;           /* Top of the IN loop */
146772e8fa42Sdrh   } *aInLoop;           /* Information about each nested IN operator */
14686d209d8bSdrh   sqlite3_index_info *pBestIdx;  /* Index information for this level */
14696d209d8bSdrh 
14706d209d8bSdrh   /* The following field is really not part of the current level.  But
14716d209d8bSdrh   ** we need a place to cache index information for each table in the
14726d209d8bSdrh   ** FROM clause and the WhereLevel structure is a convenient place.
14736d209d8bSdrh   */
14746d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
14756b56344dSdrh };
14766b56344dSdrh 
147708c88eb0Sdrh /*
147808c88eb0Sdrh ** Flags appropriate for the wflags parameter of sqlite3WhereBegin().
147908c88eb0Sdrh */
148008c88eb0Sdrh #define WHERE_ORDERBY_NORMAL     0   /* No-op */
148108c88eb0Sdrh #define WHERE_ORDERBY_MIN        1   /* ORDER BY processing for min() func */
148208c88eb0Sdrh #define WHERE_ORDERBY_MAX        2   /* ORDER BY processing for max() func */
148308c88eb0Sdrh #define WHERE_ONEPASS_DESIRED    4   /* Want to do one-pass UPDATE/DELETE */
1484a9d1ccb9Sdanielk1977 
14856b56344dSdrh /*
148675897234Sdrh ** The WHERE clause processing routine has two halves.  The
148775897234Sdrh ** first part does the start of the WHERE loop and the second
148875897234Sdrh ** half does the tail of the WHERE loop.  An instance of
148975897234Sdrh ** this structure is returned by the first half and passed
149075897234Sdrh ** into the second half to give some continuity.
149175897234Sdrh */
149275897234Sdrh struct WhereInfo {
149308c88eb0Sdrh   Parse *pParse;       /* Parsing and code generating context */
149408c88eb0Sdrh   u8 okOnePass;        /* Ok to use one-pass algorithm for UPDATE or DELETE */
1495ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
14969012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
149719a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
149819a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
14996b56344dSdrh   int nLevel;          /* Number of nested loop */
15006d209d8bSdrh   sqlite3_index_info **apInfo;  /* Array of pointers to index info structures */
15016b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
150275897234Sdrh };
150375897234Sdrh 
150475897234Sdrh /*
1505b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1506b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1507b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1508b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1509b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1510b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1511b3bce662Sdanielk1977 ** other statements.
1512b3bce662Sdanielk1977 **
1513b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1514b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1515b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1516b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1517b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1518b3bce662Sdanielk1977 ** the context containing the match is incremented.
1519b3bce662Sdanielk1977 **
1520b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1521b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1522b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1523b3bce662Sdanielk1977 ** subqueries looking for a match.
1524b3bce662Sdanielk1977 */
1525b3bce662Sdanielk1977 struct NameContext {
1526b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1527b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1528b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1529b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1530b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1531b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
153213449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
153306f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1534b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
153513449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1536b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1537b3bce662Sdanielk1977 };
1538b3bce662Sdanielk1977 
1539b3bce662Sdanielk1977 /*
15409bb61fe7Sdrh ** An instance of the following structure contains all information
15419bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1542a76b5dfcSdrh **
1543d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1544d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1545d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1546d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1547d11d382cSdrh ** in the VDBE that record the limit and offset counters.
15480342b1f5Sdrh **
1549b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
15500342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
155166a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
15520342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
1553b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
15540342b1f5Sdrh ** enough information about the compound query is known at that point.
1555b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1556b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
15570342b1f5Sdrh ** sequences for the ORDER BY clause.
15589bb61fe7Sdrh */
15599bb61fe7Sdrh struct Select {
15609bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
15617b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
15626c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
15637d10d5a6Sdrh   u16 selFlags;          /* Various SF_* values */
1564ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
15659bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
15669bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
15679bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
15689bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1569967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
15701e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
15710342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1572a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1573a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
15747b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1575b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
15769bb61fe7Sdrh };
15779bb61fe7Sdrh 
15789bb61fe7Sdrh /*
15797d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
15807d10d5a6Sdrh ** "Select Flag".
15817d10d5a6Sdrh */
15827d10d5a6Sdrh #define SF_Distinct        0x0001  /* Output should be DISTINCT */
15837d10d5a6Sdrh #define SF_Resolved        0x0002  /* Identifiers have been resolved */
15847d10d5a6Sdrh #define SF_Aggregate       0x0004  /* Contains aggregate functions */
15857d10d5a6Sdrh #define SF_UsesEphemeral   0x0008  /* Uses the OpenEphemeral opcode */
15867d10d5a6Sdrh #define SF_Expanded        0x0010  /* sqlite3SelectExpand() called on this */
15877d10d5a6Sdrh #define SF_HasTypeInfo     0x0020  /* FROM subqueries have Table metadata */
15887d10d5a6Sdrh 
15897d10d5a6Sdrh 
15907d10d5a6Sdrh /*
15917d10d5a6Sdrh ** The results of a select can be distributed in several ways.  The
15927d10d5a6Sdrh ** "SRT" prefix means "SELECT Result Type".
1593fef5208cSdrh */
159413449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
159513449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
15969ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
15979ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
1598fef5208cSdrh 
159913449892Sdrh /* The ORDER BY clause is ignored for all of the above */
16006c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
160113449892Sdrh 
16027d10d5a6Sdrh #define SRT_Output       5  /* Output each row of result */
16039ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
16040cdc022eSdanielk1977 #define SRT_Set          7  /* Store results as keys in an index */
16059ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
16069ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
1607e00ee6ebSdrh #define SRT_Coroutine   10  /* Generate a single row of result */
16082282792aSdrh 
16092282792aSdrh /*
16106c8c8ce0Sdanielk1977 ** A structure used to customize the behaviour of sqlite3Select(). See
16116c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
16126c8c8ce0Sdanielk1977 */
16136c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
16146c8c8ce0Sdanielk1977 struct SelectDest {
1615477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
1616477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
16176c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
16181013c932Sdrh   int iMem;         /* Base register where results are written */
1619ad27e761Sdrh   int nMem;         /* Number of registers allocated */
16206c8c8ce0Sdanielk1977 };
16216c8c8ce0Sdanielk1977 
16226c8c8ce0Sdanielk1977 /*
1623f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1624f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1625f57b3399Sdrh ** carry around information that is global to the entire parse.
1626f1974846Sdrh **
1627f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1628f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1629f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1630f1974846Sdrh ** each recursion.
1631c00da105Sdanielk1977 **
1632c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1633c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1634c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1635c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1636c00da105Sdanielk1977 ** list.
163775897234Sdrh */
163875897234Sdrh struct Parse {
16399bb575fdSdrh   sqlite3 *db;         /* The main database structure */
16404c504391Sdrh   int rc;              /* Return code from execution */
164175897234Sdrh   char *zErrMsg;       /* An error message */
164275897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1643836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1644e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1645a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1646205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
16477e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1648892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
16492dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
1650892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
1651892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
1652892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
165375897234Sdrh   int nErr;            /* Number of errors seen */
1654832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
165519a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1656fef5208cSdrh   int nSet;            /* Number of sets used so far */
1657aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
1658e55cbd72Sdrh   int disableColCache; /* True to disable adding to column cache */
1659e55cbd72Sdrh   int nColCache;       /* Number of entries in the column cache */
1660e55cbd72Sdrh   int iColCache;       /* Next entry of the cache to replace */
16612f7794c1Sdrh   struct yColCache {
1662e55cbd72Sdrh     int iTable;           /* Table cursor number */
1663e55cbd72Sdrh     int iColumn;          /* Table column number */
1664da250ea5Sdrh     char affChange;       /* True if this register has had an affinity change */
1665e55cbd72Sdrh     int iReg;             /* Register holding value of this column */
1666e55cbd72Sdrh   } aColCache[10];     /* One for each valid column cache entry */
166780242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1668fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1669fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1670c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1671c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1672c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1673c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1674c00da105Sdanielk1977 #endif
1675cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
1676cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
1677f1974846Sdrh 
1678f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1679f1974846Sdrh   ** each recursion */
1680f1974846Sdrh 
1681f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1682f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1683f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1684f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1685*8b213899Sdrh   int nAlias;          /* Number of aliased result set columns */
1686*8b213899Sdrh   int *aAlias;         /* Register used to hold aliased result */
1687f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1688f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1689f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1690f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1691f1974846Sdrh   const char *zSql;    /* All SQL text */
1692f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1693f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1694f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1695f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1696f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1697b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
169833b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
16997e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
17004f3dd150Sdrh   int nVtabLock;             /* Number of virtual tables to lock */
17014f3dd150Sdrh   Table **apVtabLock;        /* Pointer to virtual tables needing locking */
1702b9bb7c18Sdrh #endif
1703fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
170475897234Sdrh };
170575897234Sdrh 
17067e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
17077e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
17087e6ebfb2Sdanielk1977 #else
17097e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
17107e6ebfb2Sdanielk1977 #endif
17117e6ebfb2Sdanielk1977 
1712d99bc930Sdanielk1977 /*
171385e2096fSdrh ** An instance of the following structure can be declared on a stack and used
171485e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
171585e2096fSdrh */
171685e2096fSdrh struct AuthContext {
171785e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
171885e2096fSdrh   Parse *pParse;              /* The Parse structure */
171985e2096fSdrh };
172085e2096fSdrh 
172185e2096fSdrh /*
1722f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1723b0c374ffSrdc */
1724b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1725b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
172694eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1727e4d90813Sdrh #define OPFLAG_APPEND    8    /* This is likely to be an append */
1728b0c374ffSrdc 
1729b0c374ffSrdc /*
1730d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1731d99bc930Sdanielk1977  * struct Trigger.
1732d99bc930Sdanielk1977  *
1733d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
17349bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1735d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1736d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1737ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1738ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1739ad3cab52Sdrh  *    struct Table.
1740d99bc930Sdanielk1977  *
1741ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1742ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1743d99bc930Sdanielk1977  */
1744d99bc930Sdanielk1977 struct Trigger {
1745d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1746d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1747f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1748dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1749d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1750d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1751d99bc930Sdanielk1977                              the <column-list> is stored here */
17524312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1753e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1754e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1755d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1756d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1757c3f9bad2Sdanielk1977 };
1758d99bc930Sdanielk1977 
1759d99bc930Sdanielk1977 /*
1760dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1761dca76841Sdrh ** determine which.
1762dca76841Sdrh **
1763dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1764dca76841Sdrh ** In that cases, the constants below can be ORed together.
1765dca76841Sdrh */
1766dca76841Sdrh #define TRIGGER_BEFORE  1
1767dca76841Sdrh #define TRIGGER_AFTER   2
1768dca76841Sdrh 
1769dca76841Sdrh /*
1770d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1771d99bc930Sdanielk1977  * that is a part of a trigger-program.
1772d99bc930Sdanielk1977  *
1773d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1774d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1775d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1776d99bc930Sdanielk1977  * the first step of the trigger-program.
1777d99bc930Sdanielk1977  *
1778d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1779d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1780d99bc930Sdanielk1977  * value of "op" as follows:
1781d99bc930Sdanielk1977  *
1782d99bc930Sdanielk1977  * (op == TK_INSERT)
1783d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1784d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1785d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1786d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1787d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1788d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1789d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1790ad3cab52Sdrh  *              statement, then this stores the column-names to be
1791ad3cab52Sdrh  *              inserted into.
1792d99bc930Sdanielk1977  *
1793d99bc930Sdanielk1977  * (op == TK_DELETE)
1794d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1795d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1796d99bc930Sdanielk1977  *              Otherwise NULL.
1797d99bc930Sdanielk1977  *
1798d99bc930Sdanielk1977  * (op == TK_UPDATE)
1799d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1800d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1801d99bc930Sdanielk1977  *              Otherwise NULL.
1802d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
18034adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1804ad3cab52Sdrh  *              argument.
1805d99bc930Sdanielk1977  *
1806d99bc930Sdanielk1977  */
1807c3f9bad2Sdanielk1977 struct TriggerStep {
1808c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1809d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1810a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1811c3f9bad2Sdanielk1977 
1812c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1813c3f9bad2Sdanielk1977                           INSERT steps (when pExprList == 0) */
1814c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1815c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1816c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1817c3f9bad2Sdanielk1977                            INSERT steps (when pSelect == 0)         */
1818c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1819c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
1820187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1821c3f9bad2Sdanielk1977 };
1822c3f9bad2Sdanielk1977 
1823d99bc930Sdanielk1977 /*
1824d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1825d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1826d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1827d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1828d99bc930Sdanielk1977  *
1829d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1830d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1831d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1832d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1833d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1834d99bc930Sdanielk1977  *
1835d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1836d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1837d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1838d99bc930Sdanielk1977  *
1839d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1840d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1841d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1842d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1843d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1844d99bc930Sdanielk1977  * trigger continues.
1845d99bc930Sdanielk1977  *
1846d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1847d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1848d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1849d99bc930Sdanielk1977  */
1850d99bc930Sdanielk1977 struct TriggerStack {
1851d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1852d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1853d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
18548f2c54e6Sdanielk1977   u32 newColMask;
18558f2c54e6Sdanielk1977   u32 oldColMask;
1856d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
18576f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1858e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1859e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1860c3f9bad2Sdanielk1977 };
1861c3f9bad2Sdanielk1977 
1862d99bc930Sdanielk1977 /*
1863f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1864f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1865f26e09c8Sdrh ** explicit.
1866f26e09c8Sdrh */
1867f26e09c8Sdrh typedef struct DbFixer DbFixer;
1868f26e09c8Sdrh struct DbFixer {
1869f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1870f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1871f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1872f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1873f26e09c8Sdrh };
1874f26e09c8Sdrh 
1875f26e09c8Sdrh /*
1876ade86483Sdrh ** An objected used to accumulate the text of a string where we
1877ade86483Sdrh ** do not necessarily know how big the string will be in the end.
1878ade86483Sdrh */
1879ade86483Sdrh struct StrAccum {
1880633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
1881ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
1882ade86483Sdrh   char *zText;         /* The string collected so far */
1883ade86483Sdrh   int  nChar;          /* Length of the string so far */
1884ade86483Sdrh   int  nAlloc;         /* Amount of space allocated in zText */
1885bb4957f8Sdrh   int  mxAlloc;        /* Maximum allowed string length */
1886ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
1887ade86483Sdrh   u8   useMalloc;      /* True if zText is enlargable using realloc */
1888ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
1889ade86483Sdrh };
1890ade86483Sdrh 
1891ade86483Sdrh /*
1892234c39dfSdrh ** A pointer to this structure is used to communicate information
1893234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1894234c39dfSdrh */
1895234c39dfSdrh typedef struct {
18969bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1897ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
1898234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
189915ca1df1Sdrh   int rc;             /* Result code stored here */
1900234c39dfSdrh } InitData;
1901234c39dfSdrh 
1902b6c29897Sdrh /*
190340257ffdSdrh ** Structure containing global configuration data for the SQLite library.
190433589797Sdrh **
190533589797Sdrh ** This structure also contains some state information.
190640257ffdSdrh */
190740257ffdSdrh struct Sqlite3Config {
1908fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
1909fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
1910fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
19110a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
1912633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
1913633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
1914fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
19156d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
191640257ffdSdrh   void *pHeap;                      /* Heap storage space */
191733589797Sdrh   int nHeap;                        /* Size of pHeap[] */
191833589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
191933589797Sdrh   void *pScratch;                   /* Scratch memory */
192033589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
192133589797Sdrh   int nScratch;                     /* Number of scratch buffers */
192233589797Sdrh   void *pPage;                      /* Page cache memory */
192333589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
192433589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
192571bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
192671bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
192771bc31c6Sdanielk1977   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
192893ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
192931fab4f3Sdanielk1977   int nSmall;                       /* alloc size threshold used by mem6.c */
1930ec424a5bSdrh   int mxParserStack;                /* maximum depth of the parser stack */
193140257ffdSdrh };
193240257ffdSdrh 
193340257ffdSdrh /*
19347d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
19357d10d5a6Sdrh */
19367d10d5a6Sdrh struct Walker {
19377d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
19387d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
19397d10d5a6Sdrh   Parse *pParse;                            /* Parser context.  */
19407d10d5a6Sdrh   union {                                   /* Extra data for callback */
19417d10d5a6Sdrh     NameContext *pNC;                          /* Naming context */
19427d10d5a6Sdrh     int i;                                     /* Integer value */
19437d10d5a6Sdrh   } u;
19447d10d5a6Sdrh };
19457d10d5a6Sdrh 
19467d10d5a6Sdrh /* Forward declarations */
19477d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
19487d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
19497d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
19507d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
19517d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
19527d10d5a6Sdrh 
19537d10d5a6Sdrh /*
19547d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
19557d10d5a6Sdrh ** callbacks.
19567d10d5a6Sdrh */
19577d10d5a6Sdrh #define WRC_Continue    0
19587d10d5a6Sdrh #define WRC_Prune       1
19597d10d5a6Sdrh #define WRC_Abort       2
19607d10d5a6Sdrh 
19617d10d5a6Sdrh /*
196266150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
196366150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
19644a919118Sdrh */
19654a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
19664a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
19674a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
19684a919118Sdrh   }                                                    \
19694a919118Sdrh }
19704a919118Sdrh 
19714a919118Sdrh /*
197249285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
197349285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
197449285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
197549285708Sdrh ** corruption is first detected.
197649285708Sdrh */
197749285708Sdrh #ifdef SQLITE_DEBUG
19786e736838Sdrh   int sqlite3Corrupt(void);
197949285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
198049285708Sdrh #else
198149285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
198249285708Sdrh #endif
198349285708Sdrh 
198449285708Sdrh /*
198575897234Sdrh ** Internal function prototypes
198675897234Sdrh */
19874adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
19884adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
19898a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
19900a687d12Sdrh int sqlite3Strlen(sqlite3*, const char*);
19912e588c75Sdanielk1977 
199240257ffdSdrh int sqlite3MallocInit(void);
1993fec00eabSdrh void sqlite3MallocEnd(void);
1994fec00eabSdrh void *sqlite3Malloc(int);
1995fec00eabSdrh void *sqlite3MallocZero(int);
1996fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int);
1997fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int);
199817435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
199917435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
2000fec00eabSdrh void *sqlite3Realloc(void*, int);
200197c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
2002a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
2003633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
2004a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
2005633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
2006facf0307Sdrh void *sqlite3ScratchMalloc(int);
2007facf0307Sdrh void sqlite3ScratchFree(void*);
2008facf0307Sdrh void *sqlite3PageMalloc(int);
2009facf0307Sdrh void sqlite3PageFree(void*);
2010fec00eabSdrh void sqlite3MemSetDefault(void);
201131fab4f3Sdanielk1977 const sqlite3_mem_methods *sqlite3MemGetDefault(void);
20125099be5eSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
20130d84e5b2Sdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
20142d34081dSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys6(void);
2015171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
20162e588c75Sdanielk1977 
201765bbf29eSdrh #ifndef SQLITE_MUTEX_NOOP
20186d2ab0e4Sdanielk1977   sqlite3_mutex_methods *sqlite3DefaultMutex(void);
201959f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
2020d025174fSdanielk1977   int sqlite3MutexInit(void);
2021d025174fSdanielk1977   int sqlite3MutexEnd(void);
202265bbf29eSdrh #endif
20236d2ab0e4Sdanielk1977 
2024f7141990Sdrh int sqlite3StatusValue(int);
2025f7141990Sdrh void sqlite3StatusAdd(int, int);
2026f7141990Sdrh void sqlite3StatusSet(int, int);
2027f7141990Sdrh 
20280de3ae95Sdrh int sqlite3IsNaN(double);
20290de3ae95Sdrh 
2030f089aa45Sdrh void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
203117435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
20328c0a791aSdanielk1977 char *sqlite3MAppendf(sqlite3 *, char *, const char *, ...);
203317435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
2034633e6d57Sdrh char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
203587cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2036e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
2037d919fe17Sdrh #endif
2038d919fe17Sdrh #if defined(SQLITE_TEST)
2039e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
204087cc3b31Sdrh #endif
2041f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...);
20424adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
2043a073384fSdrh void sqlite3ErrorClear(Parse*);
20444adee20fSdanielk1977 void sqlite3Dequote(char*);
204517435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*);
20462646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
20474adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
204880242055Sdrh void sqlite3FinishCoding(Parse*);
2049892d3179Sdrh int sqlite3GetTempReg(Parse*);
2050892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
2051892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
2052892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
2053a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
205417435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
20554e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
20561e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
20574adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
205817435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
2059fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
2060633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
206117435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
2062633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
20639bb575fdSdrh int sqlite3Init(sqlite3*, char**);
2064234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
206591cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
20669bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
20674adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
20689bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
20697d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
2070c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
2071f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
20724adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
20734adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
2074fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
2075ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
2076487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
20777977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
207839002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
207919a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
2080b7f9164eSdrh 
2081f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
2082f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
2083f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
2084f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32);
2085f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
20863088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
2087f5e7bb51Sdrh 
2088fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
2089fe3fcbe2Sdanielk1977 
2090fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
20914adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
2092b7f9164eSdrh #else
2093b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
2094b7f9164eSdrh #endif
2095b7f9164eSdrh 
2096a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
2097a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*);
20984adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
209917435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
210017435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
21014adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
210217435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
210317435752Sdrh SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
210461dfc31dSdrh                                       Select*, Expr*, IdList*);
210561dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
21064adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
2107633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
2108633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
21090202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
21104d91a701Sdrh                         Token*, int, int);
21114d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
21127d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
211317435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
211417435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
2115633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
21164adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
21174adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
2118c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
21194adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
21204adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
2121a9d1ccb9Sdanielk1977 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
21224adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
2123da250ea5Sdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
2124b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
212592b01d53Sdrh void sqlite3ExprCodeCopy(Parse*, int, int, int);
2126e55cbd72Sdrh void sqlite3ExprClearColumnCache(Parse*, int);
2127da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
2128652fbf55Sdrh int sqlite3ExprWritableRegister(Parse*,int,int);
2129191b54cbSdrh void sqlite3ExprHardCopy(Parse*,int,int);
2130389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
21312dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
2132678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
21332dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
2134678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*);
2135191b54cbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
21364adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
21374adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
21389bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
2139ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
21409bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
21419bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
21429bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
214374161705Sdrh void sqlite3Vacuum(Parse*);
21449bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
214517435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
21464adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
2147d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2148d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
21494adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
21501e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*);
21512fa1868fSdrh void sqlite3PrngSaveState(void);
21522fa1868fSdrh void sqlite3PrngRestoreState(void);
21532fa1868fSdrh void sqlite3PrngResetState(void);
21549bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
21554adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
2156684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
21574adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
21584adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
21594adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
21600a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
2161eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
21624adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
21634adee20fSdanielk1977 int sqlite3IsRowid(const char*);
21642d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
21652d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
2166e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
216704adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
216804adf416Sdrh                                      int*,int,int,int,int);
216904adf416Sdrh void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
2170aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
21714adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
217217435752Sdrh Expr *sqlite3ExprDup(sqlite3*,Expr*);
217317435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*);
217417435752Sdrh ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
217517435752Sdrh SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
217617435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
217717435752Sdrh Select *sqlite3SelectDup(sqlite3*,Select*);
217870a8ca3cSdrh void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
21799bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
21809bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
2181777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
218270a8ca3cSdrh void sqlite3RegisterGlobalFunctions(void);
21838c0a791aSdanielk1977 int sqlite3GetBuiltinFunction(const char *, int, FuncDef **);
21847e8b848aSdrh #ifdef SQLITE_DEBUG
21859bb575fdSdrh   int sqlite3SafetyOn(sqlite3*);
21869bb575fdSdrh   int sqlite3SafetyOff(sqlite3*);
21877e8b848aSdrh #else
21887e8b848aSdrh # define sqlite3SafetyOn(A) 0
21897e8b848aSdrh # define sqlite3SafetyOff(A) 0
21907e8b848aSdrh #endif
21917e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
21927e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
21939cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
21942a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
2195b7f9164eSdrh 
2196b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
2197ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
219860218d2aSdrh                            Expr*,int, int);
21994adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
2200fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
220174161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
2202dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
22034adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
22048f2c54e6Sdanielk1977                            int, int, u32*, u32*);
2205dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
2206633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
220717435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
220817435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
220917435752Sdrh                                         ExprList*,Select*,int);
221017435752Sdrh   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
221117435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
2212633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
2213b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2214b7f9164eSdrh #else
2215b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
2216633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
2217cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
2218b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
22198f2c54e6Sdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
2220b7f9164eSdrh #endif
2221b7f9164eSdrh 
22224adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
22230202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
22244adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
2225ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
2226728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
22274adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
22284adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
22294adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
2230ed6c8671Sdrh #else
2231b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
22324adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
22334adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
22344adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
2235ed6c8671Sdrh #endif
2236f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2237f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
22389bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
223933f4e02aSdrh                        int omitJournal, int nCache, int flags, Btree **ppBtree);
22404adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
22414adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
22424adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
22434adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
22444adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
22454adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
2246487e262fSdrh int sqlite3AtoF(const char *z, double*);
22476f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
2248fec19aadSdrh int sqlite3GetInt32(const char *, int*);
2249598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int);
2250ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
2251ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
225266150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**);
22533f8d5cfcSshane 
22543f8d5cfcSshane /*
22553f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
22563f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
2257952856adSshane ** file.  Code should use the MACRO forms below, as the Varint32 versions
2258952856adSshane ** are coded to assume the single byte case is already handled (which
2259952856adSshane ** the MACRO form does).
22603f8d5cfcSshane */
2261192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
226235b5a33eSdrh int sqlite3PutVarint32(unsigned char*, u32);
226390e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
22646d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
2265192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
22663f8d5cfcSshane 
22673f8d5cfcSshane /*
22683f8d5cfcSshane ** The header of a record consists of a sequence variable-length integers.
22693f8d5cfcSshane ** These integers are almost always small and are encoded as a single byte.
22703f8d5cfcSshane ** The following macros take advantage this fact to provide a fast encode
22713f8d5cfcSshane ** and decode of the integers in a record header.  It is faster for the common
22723f8d5cfcSshane ** case where the integer is a single byte.  It is a little slower when the
22733f8d5cfcSshane ** integer is two or more bytes.  But overall it is faster.
22743f8d5cfcSshane **
22753f8d5cfcSshane ** The following expressions are equivalent:
22763f8d5cfcSshane **
22773f8d5cfcSshane **     x = sqlite3GetVarint32( A, &B );
22783f8d5cfcSshane **     x = sqlite3PutVarint32( A, B );
22793f8d5cfcSshane **
22803f8d5cfcSshane **     x = getVarint32( A, B );
22813f8d5cfcSshane **     x = putVarint32( A, B );
22823f8d5cfcSshane **
22833f8d5cfcSshane */
22843f8d5cfcSshane #define getVarint32(A,B)  ((*(A)<(unsigned char)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), &(B)))
22853f8d5cfcSshane #define putVarint32(A,B)  (((B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
22863f8d5cfcSshane #define getVarint    sqlite3GetVarint
22873f8d5cfcSshane #define putVarint    sqlite3PutVarint
22883f8d5cfcSshane 
22893f8d5cfcSshane 
2290a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
2291a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
2292e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
2293e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
2294bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
2295b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*);
22969bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
2297ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
2298ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
2299f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
23008a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
23019bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
23020202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
23037cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
23048b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
23057cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2306d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2307b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
23084e6af134Sdanielk1977 
2309b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2310b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2311b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
23121e536953Sdanielk1977                         void(*)(void*));
23134e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
23141e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
23151e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
23161e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2317b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
231846c99e0fSdrh #ifndef SQLITE_AMALGAMATION
23194e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
232040257ffdSdrh extern struct Sqlite3Config sqlite3Config;
2321777c5386Sdrh extern FuncDefHash sqlite3GlobalFunctions;
232246c99e0fSdrh #endif
2323a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
23244343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
23251f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
23269fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
23279fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
23282958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2329d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
23300cdc022eSdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *, int);
23317d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
23327d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
23337d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
23347d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
2335aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
233619a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
233719a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
23384dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
23398a51256cSdrh char sqlite3AffinityType(const Token*);
23409f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2341a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2342ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
2343cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
234451147baaSdrh void sqlite3DefaultRowEst(Index*);
234555ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2346d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
2347f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
2348fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
2349da184236Sdanielk1977 void sqlite3SchemaFree(void *);
23501e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
2351e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
2352b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
2353771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2354771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
2355771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
235654f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
2357ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
235869dab1d3Sdrh 
2359f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int);
2360ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2361ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
2362ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
23631013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
23641e536953Sdanielk1977 
236595bdbbbdSdrh /*
236695bdbbbdSdrh ** The interface to the LEMON-generated parser
236795bdbbbdSdrh */
236895bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
236995bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
237095bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
2371ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
2372ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
2373ec424a5bSdrh #endif
237495bdbbbdSdrh 
2375caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*);
237669dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
2377f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
237869dab1d3Sdrh #else
237969dab1d3Sdrh # define sqlite3CloseExtensions(X)
238069dab1d3Sdrh #endif
2381e3026636Sdanielk1977 
2382c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2383c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
2384c00da105Sdanielk1977 #else
2385c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
2386c00da105Sdanielk1977 #endif
2387c00da105Sdanielk1977 
238853c14021Sdrh #ifdef SQLITE_TEST
238953c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
239053c14021Sdrh #endif
239153c14021Sdrh 
2392b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
2393b9bb7c18Sdrh #  define sqlite3VtabClear(X)
23949dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
2395f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
2396f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
2397b9bb7c18Sdrh #else
2398707205d1Sdrh    void sqlite3VtabClear(Table*);
23993e3a84d3Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, char **);
2400f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
2401f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
2402b9bb7c18Sdrh #endif
24034f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
2404189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*);
2405a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
2406b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2407b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
2408b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
2409b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
241078efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
24117e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
24129e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
2413f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
24141e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
2415b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
2416b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
2417b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
2418bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
2419b9bb7c18Sdrh 
2420643167ffSdrh 
2421643167ffSdrh /*
2422643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
2423643167ffSdrh */
2424643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
24257e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
2426643167ffSdrh 
2427643167ffSdrh /*
2428ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
2429ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
2430ef05f2dfSdanielk1977 ** is not defined.
2431643167ffSdrh */
24323088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
24332d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
24342d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
2435643167ffSdrh #else
24362d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
2437867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
2438643167ffSdrh #endif
2439643167ffSdrh 
24409a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
24419a96b668Sdanielk1977 #define IN_INDEX_EPH             2
24429a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
24430cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int*);
24449a96b668Sdanielk1977 
2445c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
2446c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2447c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
2448f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
2449c7b6017cSdanielk1977 #else
2450c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2451c7b6017cSdanielk1977 #endif
2452c7b6017cSdanielk1977 
24530224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
24544b5255acSdanielk1977   void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
2455fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
24567d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
2457fc976065Sdanielk1977 #else
24584b5255acSdanielk1977   #define sqlite3ExprSetHeight(x,y)
24590224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
24607d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
2461fc976065Sdanielk1977 #endif
2462fc976065Sdanielk1977 
2463a3152895Sdrh u32 sqlite3Get4byte(const u8*);
2464a3152895Sdrh void sqlite3Put4byte(u8*, u32);
2465a3152895Sdrh 
2466fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
2467fd9a0a45Sdanielk1977 #include "sseInt.h"
2468fd9a0a45Sdanielk1977 #endif
2469fd9a0a45Sdanielk1977 
24706e736838Sdrh #ifdef SQLITE_DEBUG
24716e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
24726e736838Sdrh #endif
24736e736838Sdrh 
2474b0603416Sdrh /*
2475b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
24763a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
2477b0603416Sdrh ** print I/O tracing messages.
2478b0603416Sdrh */
2479b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
24803a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
2481b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
2482e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
2483b0603416Sdrh #else
2484b0603416Sdrh # define IOTRACE(A)
2485b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
2486b0603416Sdrh #endif
2487b0603416Sdrh 
2488e3026636Sdanielk1977 #endif
2489