xref: /sqlite-3.40.0/src/sqliteInt.h (revision f653d782)
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*f653d782Sdanielk1977 ** @(#) $Id: sqliteInt.h,v 1.676 2008/03/20 11:04:21 danielk1977 Exp $
1575897234Sdrh */
16e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
17e3026636Sdanielk1977 #define _SQLITEINT_H_
1871674ce9Sdrh 
19bd0ae111Smlcreech /*
2098dc4b1aSmlcreech ** Include the configuration header output by 'configure' if it was run
2198dc4b1aSmlcreech ** (otherwise we get an empty default).
22bd0ae111Smlcreech */
2398dc4b1aSmlcreech #include "config.h"
2498dc4b1aSmlcreech 
2598dc4b1aSmlcreech /* Needed for various definitions... */
2698dc4b1aSmlcreech #define _GNU_SOURCE
2798dc4b1aSmlcreech 
2898dc4b1aSmlcreech /*
2998dc4b1aSmlcreech ** Include standard header files as necessary
3098dc4b1aSmlcreech */
3198dc4b1aSmlcreech #ifdef HAVE_STDINT_H
3298dc4b1aSmlcreech #include <stdint.h>
3398dc4b1aSmlcreech #endif
3498dc4b1aSmlcreech #ifdef HAVE_INTTYPES_H
3598dc4b1aSmlcreech #include <inttypes.h>
36bd0ae111Smlcreech #endif
37b87057f2Smlcreech 
3898dc4b1aSmlcreech /*
3998dc4b1aSmlcreech ** If possible, use the C99 intptr_t type to define an integral type of
4098dc4b1aSmlcreech ** equivalent size to a pointer.  (Technically it's >= sizeof(void *), but
4198dc4b1aSmlcreech ** practically it's == sizeof(void *)).  We fall back to an int if this type
4298dc4b1aSmlcreech ** isn't defined.
4398dc4b1aSmlcreech */
4498dc4b1aSmlcreech #ifdef HAVE_INTPTR_T
4598dc4b1aSmlcreech   typedef intptr_t sqlite3_intptr_t;
4698dc4b1aSmlcreech #else
47a9e852b6Smlcreech   typedef int sqlite3_intptr_t;
48a9e852b6Smlcreech #endif
49a9e852b6Smlcreech 
5098dc4b1aSmlcreech 
5171674ce9Sdrh /*
52b6dbc000Sdrh ** The macro unlikely() is a hint that surrounds a boolean
53b6dbc000Sdrh ** expression that is usually false.  Macro likely() surrounds
54b6dbc000Sdrh ** a boolean expression that is usually true.  GCC is able to
55b6dbc000Sdrh ** use these hints to generate better code, sometimes.
56b6dbc000Sdrh */
574bbf464fSdrh #if defined(__GNUC__) && 0
58b6dbc000Sdrh # define likely(X)    __builtin_expect((X),1)
59b6dbc000Sdrh # define unlikely(X)  __builtin_expect((X),0)
60b6dbc000Sdrh #else
61b6dbc000Sdrh # define likely(X)    !!(X)
62b6dbc000Sdrh # define unlikely(X)  !!(X)
63b6dbc000Sdrh #endif
64b6dbc000Sdrh 
65b6dbc000Sdrh 
66b6dbc000Sdrh /*
6771674ce9Sdrh ** These #defines should enable >2GB file support on Posix if the
6871674ce9Sdrh ** underlying operating system supports it.  If the OS lacks
6971674ce9Sdrh ** large file support, or if the OS is windows, these should be no-ops.
7071674ce9Sdrh **
7171674ce9Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
7271674ce9Sdrh ** system #includes.  Hence, this block of code must be the very first
7371674ce9Sdrh ** code in all source files.
7471674ce9Sdrh **
7571674ce9Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
7671674ce9Sdrh ** on the compiler command line.  This is necessary if you are compiling
7771674ce9Sdrh ** on a recent machine (ex: RedHat 7.2) but you want your code to work
7871674ce9Sdrh ** on an older machine (ex: RedHat 6.0).  If you compile on RedHat 7.2
7971674ce9Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
8071674ce9Sdrh ** in RedHat 6.0, so the code won't work.  Hence, for maximum binary
8171674ce9Sdrh ** portability you should omit LFS.
8271674ce9Sdrh **
8371674ce9Sdrh ** Similar is true for MacOS.  LFS is only supported on MacOS 9 and later.
8471674ce9Sdrh */
8571674ce9Sdrh #ifndef SQLITE_DISABLE_LFS
8671674ce9Sdrh # define _LARGE_FILE       1
8771674ce9Sdrh # ifndef _FILE_OFFSET_BITS
8871674ce9Sdrh #   define _FILE_OFFSET_BITS 64
8971674ce9Sdrh # endif
9071674ce9Sdrh # define _LARGEFILE_SOURCE 1
9171674ce9Sdrh #endif
9271674ce9Sdrh 
9371674ce9Sdrh 
94c551dd80Sdrh #include "sqliteLimit.h"
95c797d4dcSdrh 
9633f4e02aSdrh /*
9733f4e02aSdrh ** For testing purposes, the various size limit constants are really
9833f4e02aSdrh ** variables that we can modify in the testfixture.
9933f4e02aSdrh */
100e6a58a4eSdanielk1977 #ifdef SQLITE_TEST
101e6a58a4eSdanielk1977   #undef SQLITE_MAX_LENGTH
102e6a58a4eSdanielk1977   #undef SQLITE_MAX_COLUMN
103e6a58a4eSdanielk1977   #undef SQLITE_MAX_SQL_LENGTH
104e6a58a4eSdanielk1977   #undef SQLITE_MAX_EXPR_DEPTH
105e6a58a4eSdanielk1977   #undef SQLITE_MAX_COMPOUND_SELECT
106e6a58a4eSdanielk1977   #undef SQLITE_MAX_VDBE_OP
107e6a58a4eSdanielk1977   #undef SQLITE_MAX_FUNCTION_ARG
108e6a58a4eSdanielk1977   #undef SQLITE_MAX_VARIABLE_NUMBER
109e6a58a4eSdanielk1977   #undef SQLITE_MAX_PAGE_SIZE
110e6a58a4eSdanielk1977   #undef SQLITE_MAX_PAGE_COUNT
111e6a58a4eSdanielk1977   #undef SQLITE_MAX_LIKE_PATTERN_LENGTH
112e6a58a4eSdanielk1977 
113e6a58a4eSdanielk1977   #define SQLITE_MAX_LENGTH              sqlite3MAX_LENGTH
114e6a58a4eSdanielk1977   #define SQLITE_MAX_COLUMN              sqlite3MAX_COLUMN
115e6a58a4eSdanielk1977   #define SQLITE_MAX_SQL_LENGTH          sqlite3MAX_SQL_LENGTH
116e6a58a4eSdanielk1977   #define SQLITE_MAX_EXPR_DEPTH          sqlite3MAX_EXPR_DEPTH
117e6a58a4eSdanielk1977   #define SQLITE_MAX_COMPOUND_SELECT     sqlite3MAX_COMPOUND_SELECT
118e6a58a4eSdanielk1977   #define SQLITE_MAX_VDBE_OP             sqlite3MAX_VDBE_OP
119e6a58a4eSdanielk1977   #define SQLITE_MAX_FUNCTION_ARG        sqlite3MAX_FUNCTION_ARG
120e6a58a4eSdanielk1977   #define SQLITE_MAX_VARIABLE_NUMBER     sqlite3MAX_VARIABLE_NUMBER
121e6a58a4eSdanielk1977   #define SQLITE_MAX_PAGE_SIZE           sqlite3MAX_PAGE_SIZE
122e6a58a4eSdanielk1977   #define SQLITE_MAX_PAGE_COUNT          sqlite3MAX_PAGE_COUNT
123e6a58a4eSdanielk1977   #define SQLITE_MAX_LIKE_PATTERN_LENGTH sqlite3MAX_LIKE_PATTERN_LENGTH
124e6a58a4eSdanielk1977 
125e6a58a4eSdanielk1977   extern int sqlite3MAX_LENGTH;
126e6a58a4eSdanielk1977   extern int sqlite3MAX_COLUMN;
127e6a58a4eSdanielk1977   extern int sqlite3MAX_SQL_LENGTH;
128e6a58a4eSdanielk1977   extern int sqlite3MAX_EXPR_DEPTH;
129e6a58a4eSdanielk1977   extern int sqlite3MAX_COMPOUND_SELECT;
130e6a58a4eSdanielk1977   extern int sqlite3MAX_VDBE_OP;
131e6a58a4eSdanielk1977   extern int sqlite3MAX_FUNCTION_ARG;
132e6a58a4eSdanielk1977   extern int sqlite3MAX_VARIABLE_NUMBER;
133e6a58a4eSdanielk1977   extern int sqlite3MAX_PAGE_SIZE;
134e6a58a4eSdanielk1977   extern int sqlite3MAX_PAGE_COUNT;
135e6a58a4eSdanielk1977   extern int sqlite3MAX_LIKE_PATTERN_LENGTH;
136e6a58a4eSdanielk1977 #endif
137e6a58a4eSdanielk1977 
138e5e7a901Sdrh 
139e5e7a901Sdrh /*
140e5e7a901Sdrh ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
141e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
142e5e7a901Sdrh ** We support that for legacy
143e5e7a901Sdrh */
144e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
145e5e7a901Sdrh #if defined(THREADSAFE)
146e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE
147e5e7a901Sdrh #else
148e5e7a901Sdrh # define SQLITE_THREADSAFE 1
149e5e7a901Sdrh #endif
150e5e7a901Sdrh #endif
151e5e7a901Sdrh 
15267080617Sdrh /*
1530d18020bSdrh ** Exactly one of the following macros must be defined in order to
1540d18020bSdrh ** specify which memory allocation subsystem to use.
1550d18020bSdrh **
1560d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
1570d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
1580d18020bSdrh **     SQLITE_MEMORY_SIZE            // internal allocator #1
1590d18020bSdrh **     SQLITE_MMAP_HEAP_SIZE         // internal mmap() allocator
1600d18020bSdrh **     SQLITE_POW2_MEMORY_SIZE       // internal power-of-two allocator
1610d18020bSdrh **
1620d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
1630d18020bSdrh ** the default.
1640d18020bSdrh */
1650d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1660d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1670d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)>1
1680d18020bSdrh # error "At most one of the following compile-time configuration options\
1690d18020bSdrh  is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
1700d18020bSdrh  SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
1710d18020bSdrh #endif
1720d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1730d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1740d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)==0
1750d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
1760d18020bSdrh #endif
1770d18020bSdrh 
1780d18020bSdrh /*
179eee4c8caSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
180eee4c8caSdrh ** sizes of memory allocations below this value where possible.
181eee4c8caSdrh */
182eee4c8caSdrh #if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
183eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
184eee4c8caSdrh #endif
185eee4c8caSdrh 
186eee4c8caSdrh /*
18767080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
18867080617Sdrh ** recursive mutexes on most unix systems.  But Mac OS X is different.
18967080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
19067080617Sdrh ** so it is omitted there.  See ticket #2673.
191e5e7a901Sdrh **
192e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
193e5e7a901Sdrh ** implemented on some systems.  So we avoid defining it at all
194e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are
195e5e7a901Sdrh ** not doing a threadsafe build.  Ticket #2681.
1969e0ebbfaSdrh **
1979e0ebbfaSdrh ** See also ticket #2741.
19867080617Sdrh */
199ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
200058897a9Sdrh #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
20167080617Sdrh #endif
202e3026636Sdanielk1977 
2034f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
2044f0c5878Sdrh # include <tcl.h>
205824d7c18Sdrh #endif
206824d7c18Sdrh 
207824d7c18Sdrh /*
2084b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
209b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
2104b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
2114b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
2124b529d97Sdrh ** feature.
2134b529d97Sdrh */
214289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
2154b529d97Sdrh # define NDEBUG 1
2164b529d97Sdrh #endif
2174b529d97Sdrh 
2181d482dd9Sdrh #include "sqlite3.h"
219beae3194Sdrh #include "hash.h"
22075897234Sdrh #include "parse.h"
22175897234Sdrh #include <stdio.h>
22275897234Sdrh #include <stdlib.h>
22375897234Sdrh #include <string.h>
22475897234Sdrh #include <assert.h>
22552370e2cSdrh #include <stddef.h>
22675897234Sdrh 
2277cd6927eSdrh #define sqlite3_isnan(X)  ((X)!=(X))
2287361cb1fSdrh 
229967e8b73Sdrh /*
230b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
231b37df7b9Sdrh ** substitute integer for floating-point
232b37df7b9Sdrh */
233b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
234b37df7b9Sdrh # define double sqlite_int64
235b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
236d1167393Sdrh # ifndef SQLITE_BIG_DBL
237b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
238d1167393Sdrh # endif
239b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
240b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
241110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
242b37df7b9Sdrh #endif
243d1167393Sdrh #ifndef SQLITE_BIG_DBL
244d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
245d1167393Sdrh #endif
246b37df7b9Sdrh 
247b37df7b9Sdrh /*
24853c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
24953c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
25053c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
25153c0f748Sdanielk1977 */
25253c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
25353c0f748Sdanielk1977 #define OMIT_TEMPDB 1
25453c0f748Sdanielk1977 #else
25553c0f748Sdanielk1977 #define OMIT_TEMPDB 0
25653c0f748Sdanielk1977 #endif
25753c0f748Sdanielk1977 
25853c0f748Sdanielk1977 /*
2590bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
2600bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
2610bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
2620bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
2630bd1f4eaSdrh ** is the way things are suppose to work.
2640bd1f4eaSdrh **
2650bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
2660bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
2670bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
2680bd1f4eaSdrh ** work.
2690bd1f4eaSdrh */
2700bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
2710bd1f4eaSdrh 
2720bd1f4eaSdrh /*
273d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
274d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
275d946db00Sdrh ** the default file format for new databases and the maximum file format
276d946db00Sdrh ** that the library can read.
277d946db00Sdrh */
278d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
279d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
28076fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
281d946db00Sdrh #endif
282d946db00Sdrh 
283d946db00Sdrh /*
28449766d6cSdrh ** Provide a default value for TEMP_STORE in case it is not specified
28549766d6cSdrh ** on the command-line
28649766d6cSdrh */
28749766d6cSdrh #ifndef TEMP_STORE
28849766d6cSdrh # define TEMP_STORE 1
28949766d6cSdrh #endif
29049766d6cSdrh 
29149766d6cSdrh /*
292f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
293f1974846Sdrh ** ourselves.
294f1974846Sdrh */
295f1974846Sdrh #ifndef offsetof
296f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
297f1974846Sdrh #endif
298f1974846Sdrh 
299f1974846Sdrh /*
3009b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
3019b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
3029b8f447bSdrh */
3039b8f447bSdrh #if 'A' == '\301'
3049b8f447bSdrh # define SQLITE_EBCDIC 1
3059b8f447bSdrh #else
3069b8f447bSdrh # define SQLITE_ASCII 1
3079b8f447bSdrh #endif
3089b8f447bSdrh 
3099b8f447bSdrh /*
3105a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
3115a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
3125a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
3135a2c2c20Sdrh **
3145a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
31541a2b48bSdrh */
3165a2c2c20Sdrh #ifndef UINT32_TYPE
317dda5b68cSmlcreech # ifdef HAVE_UINT32_T
318dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
319dda5b68cSmlcreech # else
3205a2c2c20Sdrh #  define UINT32_TYPE unsigned int
3215a2c2c20Sdrh # endif
322dda5b68cSmlcreech #endif
3235a2c2c20Sdrh #ifndef UINT16_TYPE
324dda5b68cSmlcreech # ifdef HAVE_UINT16_T
325dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
326dda5b68cSmlcreech # else
3275a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
3285a2c2c20Sdrh # endif
329dda5b68cSmlcreech #endif
330939a16d6Sdrh #ifndef INT16_TYPE
331dda5b68cSmlcreech # ifdef HAVE_INT16_T
332dda5b68cSmlcreech #  define INT16_TYPE int16_t
333dda5b68cSmlcreech # else
334939a16d6Sdrh #  define INT16_TYPE short int
335939a16d6Sdrh # endif
336dda5b68cSmlcreech #endif
3375a2c2c20Sdrh #ifndef UINT8_TYPE
338dda5b68cSmlcreech # ifdef HAVE_UINT8_T
339dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
340dda5b68cSmlcreech # else
3415a2c2c20Sdrh #  define UINT8_TYPE unsigned char
3425a2c2c20Sdrh # endif
343dda5b68cSmlcreech #endif
344905793e2Sdrh #ifndef INT8_TYPE
345dda5b68cSmlcreech # ifdef HAVE_INT8_T
346dda5b68cSmlcreech #  define INT8_TYPE int8_t
347dda5b68cSmlcreech # else
348905793e2Sdrh #  define INT8_TYPE signed char
349905793e2Sdrh # endif
350dda5b68cSmlcreech #endif
351efad9995Sdrh #ifndef LONGDOUBLE_TYPE
352efad9995Sdrh # define LONGDOUBLE_TYPE long double
353efad9995Sdrh #endif
354efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
35527436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
3565a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
3575a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
358939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
3595a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
360905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
3615a2c2c20Sdrh 
3625a2c2c20Sdrh /*
363bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
364bbd42a6dSdrh ** evaluated at runtime.
365bbd42a6dSdrh */
36646c99e0fSdrh #ifdef SQLITE_AMALGAMATION
3677ff4a45eSmlcreech const int sqlite3one;
36846c99e0fSdrh #else
369bbd42a6dSdrh extern const int sqlite3one;
37046c99e0fSdrh #endif
37138def054Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)
37238def054Sdrh # define SQLITE_BIGENDIAN    0
37338def054Sdrh # define SQLITE_LITTLEENDIAN 1
37438def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
37538def054Sdrh #else
3769c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
3779c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
37838def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
37938def054Sdrh #endif
380bbd42a6dSdrh 
381bbd42a6dSdrh /*
38290f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
38390f5ecb3Sdrh ** callback for a given sqlite handle.
38490f5ecb3Sdrh **
38590f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
38690f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
38790f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
38890f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
38990f5ecb3Sdrh */
39090f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
39190f5ecb3Sdrh struct BusyHandler {
39290f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
39390f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
394a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
39590f5ecb3Sdrh };
39690f5ecb3Sdrh 
39790f5ecb3Sdrh /*
39875897234Sdrh ** Name of the master database table.  The master database table
39975897234Sdrh ** is a special table that holds the names and attributes of all
40075897234Sdrh ** user tables and indices.
40175897234Sdrh */
40275897234Sdrh #define MASTER_NAME       "sqlite_master"
403e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
40475897234Sdrh 
40575897234Sdrh /*
4068e150818Sdanielk1977 ** The root-page of the master database table.
4078e150818Sdanielk1977 */
4088e150818Sdanielk1977 #define MASTER_ROOT       1
4098e150818Sdanielk1977 
4108e150818Sdanielk1977 /*
411ed6c8671Sdrh ** The name of the schema table.
412ed6c8671Sdrh */
41353c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
414ed6c8671Sdrh 
415ed6c8671Sdrh /*
41675897234Sdrh ** A convenience macro that returns the number of elements in
41775897234Sdrh ** an array.
41875897234Sdrh */
41975897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
42075897234Sdrh 
42175897234Sdrh /*
42275897234Sdrh ** Forward references to structures
42375897234Sdrh */
42413449892Sdrh typedef struct AggInfo AggInfo;
425fe05af87Sdrh typedef struct AuthContext AuthContext;
426f5e7bb51Sdrh typedef struct Bitvec Bitvec;
427fe05af87Sdrh typedef struct CollSeq CollSeq;
4287020f651Sdrh typedef struct Column Column;
429fe05af87Sdrh typedef struct Db Db;
430e501b89aSdanielk1977 typedef struct Schema Schema;
43175897234Sdrh typedef struct Expr Expr;
43275897234Sdrh typedef struct ExprList ExprList;
433c2eef3b3Sdrh typedef struct FKey FKey;
434fe05af87Sdrh typedef struct FuncDef FuncDef;
435fe05af87Sdrh typedef struct IdList IdList;
436fe05af87Sdrh typedef struct Index Index;
4378d059845Sdanielk1977 typedef struct KeyClass KeyClass;
438d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
439d1ab1ba5Sdanielk1977 typedef struct Module Module;
440626a879aSdrh typedef struct NameContext NameContext;
441fe05af87Sdrh typedef struct Parse Parse;
442fe05af87Sdrh typedef struct Select Select;
443fe05af87Sdrh typedef struct SrcList SrcList;
444ade86483Sdrh typedef struct StrAccum StrAccum;
445fe05af87Sdrh typedef struct Table Table;
446c00da105Sdanielk1977 typedef struct TableLock TableLock;
447fe05af87Sdrh typedef struct Token Token;
448fe05af87Sdrh typedef struct TriggerStack TriggerStack;
449fe05af87Sdrh typedef struct TriggerStep TriggerStep;
450fe05af87Sdrh typedef struct Trigger Trigger;
451fe05af87Sdrh typedef struct WhereInfo WhereInfo;
452fe05af87Sdrh typedef struct WhereLevel WhereLevel;
453d3d39e93Sdrh 
4542dca4ac1Sdanielk1977 /*
4552dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
4562dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
4572dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
4582dca4ac1Sdanielk1977 */
4592dca4ac1Sdanielk1977 #include "btree.h"
4602dca4ac1Sdanielk1977 #include "vdbe.h"
4612dca4ac1Sdanielk1977 #include "pager.h"
4622dca4ac1Sdanielk1977 
4631cc5ed81Sdanielk1977 #include "os.h"
464c7ce76afSdrh #include "mutex.h"
4651cc5ed81Sdanielk1977 
466eee4c8caSdrh 
467001bbcbbSdrh /*
468001bbcbbSdrh ** Each database file to be accessed by the system is an instance
469001bbcbbSdrh ** of the following structure.  There are normally two of these structures
470001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
471a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
472a69d9168Sdrh ** databases may be attached.
473001bbcbbSdrh */
474001bbcbbSdrh struct Db {
475001bbcbbSdrh   char *zName;         /* Name of this database */
476001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
477da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
478da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
479da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
480da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
481e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
482da184236Sdanielk1977 };
483da184236Sdanielk1977 
484da184236Sdanielk1977 /*
485da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
486a04a34ffSdanielk1977 **
487a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the
488a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table
489a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection
490a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been
491a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated,
492a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare
493a04a34ffSdanielk1977 ** statements.
494da184236Sdanielk1977 */
495e501b89aSdanielk1977 struct Schema {
496001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
497d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
498d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
499d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
500d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
5014794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
502da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
5038079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
504da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
50514db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
506a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
507a04a34ffSdanielk1977   sqlite3 *db;         /* "Owner" connection. See comment above */
508a04a34ffSdanielk1977 #endif
509001bbcbbSdrh };
51075897234Sdrh 
51175897234Sdrh /*
5128bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
5138bf8dc92Sdrh ** Db.flags field.
5148bf8dc92Sdrh */
515da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
516da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
517da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
518da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
5198bf8dc92Sdrh 
5208bf8dc92Sdrh /*
5218bf8dc92Sdrh ** Allowed values for the DB.flags field.
5228bf8dc92Sdrh **
5238bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
5248bf8dc92Sdrh ** read into internal hash tables.
5258bf8dc92Sdrh **
5268bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
5278bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
5288bf8dc92Sdrh ** changes and so the view will need to be reset.
5298bf8dc92Sdrh */
530124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
531124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
532b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
5338bf8dc92Sdrh 
534caa639f4Sdrh /*
535caa639f4Sdrh ** The number of different kinds of things that can be limited
536caa639f4Sdrh ** using the sqlite3_limit() interface.
537caa639f4Sdrh */
538caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
5398bf8dc92Sdrh 
5408bf8dc92Sdrh /*
541c9b84a1fSdrh ** Each database is an instance of the following structure.
542c9b84a1fSdrh **
543b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
544b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
545b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
546b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
547b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
548b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
549b0c374ffSrdc **
550b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
5516f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
552b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
553b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
554b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
555b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
556b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
557b0c374ffSrdc ** affect the value of lsChange.
558b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
559b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
5606622cce3Sdanielk1977 **
5616622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
5626622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
5636622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
5646622cce3Sdanielk1977 ** consistently.
56575897234Sdrh */
5669bb575fdSdrh struct sqlite3 {
56790f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
568001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
569001bbcbbSdrh   Db *aDb;                      /* All backends */
5708c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
57133f4e02aSdrh   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
572fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
5734ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
574fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
57590f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
57617435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
57798757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
578*f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
5792803757aSdrh   int nTable;                   /* Number of tables in the database */
580d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
581f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
582f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
583247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
584b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
585b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
586d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
587caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
5884adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
5891d85d931Sdrh     int iDb;                    /* When back is being initialized */
5901d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
5911d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
5921d85d931Sdrh   } init;
593f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
594761df87eSdrh   void **aExtension;            /* Array of shared libraray handles */
595326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
5961d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
59718de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
59818de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
59919e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
60019e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
601fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
602fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
60371fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
60471fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
60594eb6a14Sdanielk1977   void *pUpdateArg;
60694eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
607fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
608fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
609fcd35c7bSdrh   void *pCollNeededArg;
610fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
611fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
612fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
613881feaa0Sdrh   union {
614881feaa0Sdrh     int isInterrupted;          /* True if sqlite3_interrupt has been called */
615881feaa0Sdrh     double notUsed1;            /* Spacer */
616881feaa0Sdrh   } u1;
617ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
618e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
619e22a334bSdrh                                 /* Access authorization function */
620ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
621ed6c8671Sdrh #endif
622348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
623348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
624348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
625348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
626348bb5d6Sdanielk1977 #endif
627b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
628b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
6297e6ebfb2Sdanielk1977   Table *pVTab;                 /* vtab with active Connect/Create method */
630f9e7dda7Sdanielk1977   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
631f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
6326b456a2bSdanielk1977 #endif
633fcd35c7bSdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
634fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
635fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
63697903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
637fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
6387e900abfSdanielk1977 #ifdef SQLITE_SSE
6397e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
6407e900abfSdanielk1977 #endif
64141483468Sdanielk1977   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
64275897234Sdrh };
64375897234Sdrh 
64403b808a6Sdrh /*
64503b808a6Sdrh ** A macro to discover the encoding of a database.
64603b808a6Sdrh */
64714db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
64814db2665Sdanielk1977 
64975897234Sdrh /*
6508bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
6518bf8dc92Sdrh **
6528bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
6538bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
6548bf8dc92Sdrh ** transaction is active on that particular database file.
65575897234Sdrh */
6564c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
657c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
6585e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
659382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
660fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
661fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
6621bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
6631bee3d7bSdrh                                           /*   the count using a callback. */
664fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
6656a535340Sdrh                                           /*   result set is empty */
66635d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
66735d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
668f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
6697bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
6707bec505eSdrh                                           ** accessing read-only databases */
6710cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
672da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
673e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
674ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
675c2e87a3eSdrh #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
67658b9576bSdrh 
67734c68fbaSdanielk1977 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
6784a50aac5Sdrh #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
6794a50aac5Sdrh #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
68034c68fbaSdanielk1977 
68158b9576bSdrh /*
682247be43dSdrh ** Possible values for the sqlite.magic field.
683247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
684247be43dSdrh ** than being distinct from one another.
685247be43dSdrh */
686247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
687247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
6887e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
689247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
690247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
691247be43dSdrh 
692247be43dSdrh /*
6930bce8354Sdrh ** Each SQL function is defined by an instance of the following
6940bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
6958e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
6968e0a2f90Sdrh ** points to a linked list of these structures.
6972803757aSdrh */
6980bce8354Sdrh struct FuncDef {
69955ef4d97Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
700d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
70155ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
70255ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
7031350b030Sdrh   void *pUserData;     /* User data parameter */
7040bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
705f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
706f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
707f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
70855ef4d97Sdrh   char zName[1];       /* SQL name of the function.  MUST BE LAST */
7098e0a2f90Sdrh };
7102803757aSdrh 
7112803757aSdrh /*
712d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
713d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
714d1ab1ba5Sdanielk1977 ** hash table.
715d1ab1ba5Sdanielk1977 */
716d1ab1ba5Sdanielk1977 struct Module {
717d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
718d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
719d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
720832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
721d1ab1ba5Sdanielk1977 };
722d1ab1ba5Sdanielk1977 
723d1ab1ba5Sdanielk1977 /*
72455ef4d97Sdrh ** Possible values for FuncDef.flags
72555ef4d97Sdrh */
726d64fe2f3Sdrh #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
727d64fe2f3Sdrh #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
728b7f6f68fSdrh #define SQLITE_FUNC_EPHEM  0x04  /* Ephermeral.  Delete with VDBE */
72955ef4d97Sdrh 
73055ef4d97Sdrh /*
731967e8b73Sdrh ** information about each column of an SQL table is held in an instance
7327020f651Sdrh ** of this structure.
7337020f651Sdrh */
7347020f651Sdrh struct Column {
7357020f651Sdrh   char *zName;     /* Name of this column */
7367977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
737382c0247Sdrh   char *zType;     /* Data type for this column */
738b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
7394a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
74078100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
741a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
742034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
743034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
744034ca14fSdanielk1977 #endif
7457020f651Sdrh };
7467020f651Sdrh 
7477020f651Sdrh /*
748a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
7490202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
7500202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
751a9fd84b0Sdrh **
7520202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
7530202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
7540202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
7550202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
7560202b29eSdanielk1977 ** the version that will require the least expensive encoding
757b3bf556eSdanielk1977 ** translations, if any.
7580202b29eSdanielk1977 **
7590202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
7600202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
7610202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
7620202b29eSdanielk1977 ** xCmp16.
7630202b29eSdanielk1977 **
7640202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
7650202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
7660202b29eSdanielk1977 ** collating sequence may not be read or written.
767a9fd84b0Sdrh */
768a9fd84b0Sdrh struct CollSeq {
7690202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
770466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
771d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
772a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
7730202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
774a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
775a9fd84b0Sdrh };
776a9fd84b0Sdrh 
777a9fd84b0Sdrh /*
778d64fe2f3Sdrh ** Allowed values of CollSeq flags:
779d64fe2f3Sdrh */
780d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
781d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
782d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
783d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
784d64fe2f3Sdrh 
785d64fe2f3Sdrh /*
786d3d39e93Sdrh ** A sort order can be either ASC or DESC.
7878e2ca029Sdrh */
7888e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
789d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
7908e2ca029Sdrh 
7918e2ca029Sdrh /*
792a37cdde0Sdanielk1977 ** Column affinity types.
7938a51256cSdrh **
7948a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
7958a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
7968a51256cSdrh ** the speed a little by number the values consecutively.
7978a51256cSdrh **
7988a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
7998a51256cSdrh ** when multiple affinity types are concatenated into a string and
80066a5167bSdrh ** used as the P4 operand, they will be more readable.
8018a51256cSdrh **
8028a51256cSdrh ** Note also that the numeric types are grouped together so that testing
8038a51256cSdrh ** for a numeric type is a single comparison.
804a37cdde0Sdanielk1977 */
8058a51256cSdrh #define SQLITE_AFF_TEXT     'a'
8068a51256cSdrh #define SQLITE_AFF_NONE     'b'
8078a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
8088a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
8098a51256cSdrh #define SQLITE_AFF_REAL     'e'
810a37cdde0Sdanielk1977 
8118a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
812a37cdde0Sdanielk1977 
813a37cdde0Sdanielk1977 /*
81435573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
81535573356Sdrh ** affinity value.
81635573356Sdrh */
81735573356Sdrh #define SQLITE_AFF_MASK     0x67
81835573356Sdrh 
81935573356Sdrh /*
82035573356Sdrh ** Additional bit values that can be ORed with an affinity without
82135573356Sdrh ** changing the affinity.
82235573356Sdrh */
82335573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
82435573356Sdrh #define SQLITE_NULLEQUAL    0x10  /* compare NULLs equal */
82535573356Sdrh #define SQLITE_STOREP2      0x80  /* Store result in reg[P2] rather than jump */
82635573356Sdrh 
82735573356Sdrh /*
82822f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
82922f70c32Sdrh ** following structure.
83022f70c32Sdrh **
831d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
83222f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
83322f70c32Sdrh ** comparisons.
83422f70c32Sdrh **
835d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
83622f70c32Sdrh ** pointer to an array of Column structures, one for each column.
83722f70c32Sdrh **
838d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
839d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
84022f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
84122f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
84222f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
843d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
84422f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
84522f70c32Sdrh **
846d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
847d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
848d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
849b9bb7c18Sdrh ** holds temporary tables and indices.  If Table.isEphem
85022f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
851d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
85222f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
85322f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
85422f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
85522f70c32Sdrh ** of a SELECT statement.
85675897234Sdrh */
85775897234Sdrh struct Table {
85875897234Sdrh   char *zName;     /* Name of the table */
85975897234Sdrh   int nCol;        /* Number of columns in this table */
8607020f651Sdrh   Column *aCol;    /* Information about each column */
861c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
862967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
86322f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
864a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
865ed8a3bb1Sdrh   int nRef;          /* Number of pointers to this Table */
866c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
867c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
8683d1bfeaaSdanielk1977   char *zColAff;     /* String defining the affinity of each column */
869ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
870ffe07b2dSdrh   Expr *pCheck;      /* The AND of all CHECK constraints */
871ffe07b2dSdrh #endif
87219a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
87319a8e7e8Sdanielk1977   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
87419a8e7e8Sdanielk1977 #endif
8751914619aSdrh   u8 readOnly;     /* True if this table should not be written by the user */
8761914619aSdrh   u8 isEphem;      /* True if created using OP_OpenEphermeral */
8771914619aSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
8781914619aSdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
8791914619aSdrh   u8 autoInc;      /* True if the integer primary key is autoincrement */
880e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
8811914619aSdrh   u8 isVirtual;             /* True if this is a virtual table */
8821914619aSdrh   u8 isCommit;              /* True once the CREATE TABLE has been committed */
883d1ab1ba5Sdanielk1977   Module *pMod;             /* Pointer to the implementation of the module */
884b9bb7c18Sdrh   sqlite3_vtab *pVtab;      /* Pointer to the module instance */
885b9bb7c18Sdrh   int nModuleArg;           /* Number of arguments to the module */
886b9bb7c18Sdrh   char **azModuleArg;       /* Text of all module args. [0] is module name */
887e09daa90Sdrh #endif
888728b5779Sdrh   Schema *pSchema;          /* Schema that contains this table */
88975897234Sdrh };
89075897234Sdrh 
89175897234Sdrh /*
8924cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
8934cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
8944cbdda9eSdrh ** table support is omitted from the build.
8954cbdda9eSdrh */
8964cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
8974cbdda9eSdrh #  define IsVirtual(X)      ((X)->isVirtual)
898034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
8994cbdda9eSdrh #else
9004cbdda9eSdrh #  define IsVirtual(X)      0
901034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
9024cbdda9eSdrh #endif
9034cbdda9eSdrh 
9044cbdda9eSdrh /*
905c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
906c2eef3b3Sdrh **
907c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
908c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
909c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
910c2eef3b3Sdrh ** Consider this example:
911c2eef3b3Sdrh **
912c2eef3b3Sdrh **     CREATE TABLE ex1(
913c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
914c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
915c2eef3b3Sdrh **     );
916c2eef3b3Sdrh **
917c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
918c2eef3b3Sdrh **
919c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
920c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
921c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
922c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
923c2eef3b3Sdrh **
924ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
925c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
926c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
927c2eef3b3Sdrh ** field.
928c2eef3b3Sdrh */
929c2eef3b3Sdrh struct FKey {
930c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
931c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
932c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
933c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
934c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
935c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
936c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
937c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
938c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
939c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
940c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
941c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
942c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
943c2eef3b3Sdrh };
944c2eef3b3Sdrh 
945c2eef3b3Sdrh /*
946aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
94722f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
9480bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
9491c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
9501c92853dSdrh ** fails and any prior changes from that one operation are backed out,
9511c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
9521c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
9531c92853dSdrh ** changes due to the same operation are not backed out and no rollback
9541c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
9551c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
9561c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
9571c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
9581c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
9591c92853dSdrh **
960c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
961c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
962c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
963c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
964c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
965c2eef3b3Sdrh ** foreign key.
966c2eef3b3Sdrh **
967968af52aSdrh ** The following symbolic values are used to record which type
9681c92853dSdrh ** of action to take.
9699cfcf5d4Sdrh */
9709cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
9711c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
9721c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
9731c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
9741c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
9751c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
976c2eef3b3Sdrh 
977c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
978c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
979c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
980c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
981c2eef3b3Sdrh 
982c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
9839cfcf5d4Sdrh 
984d3d39e93Sdrh 
985d3d39e93Sdrh /*
986d3d39e93Sdrh ** An instance of the following structure is passed as the first
987d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
988d3d39e93Sdrh ** comparison of the two index keys.
989d3d39e93Sdrh **
990d3d39e93Sdrh ** If the KeyInfo.incrKey value is true and the comparison would
9917e62779aSdrh ** otherwise be equal, then return a result as if the second key
9927e62779aSdrh ** were larger.
993d3d39e93Sdrh */
994d3d39e93Sdrh struct KeyInfo {
995b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
996b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
997d3d39e93Sdrh   u8 incrKey;         /* Increase 2nd key by epsilon before comparison */
9989a96b668Sdanielk1977   u8 prefixIsEqual;   /* Treat a prefix as equal */
999d3d39e93Sdrh   int nField;         /* Number of entries in aColl[] */
1000d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
1001d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1002d3d39e93Sdrh };
1003d3d39e93Sdrh 
10049cfcf5d4Sdrh /*
100566b89c8fSdrh ** Each SQL index is represented in memory by an
100675897234Sdrh ** instance of the following structure.
1007967e8b73Sdrh **
1008967e8b73Sdrh ** The columns of the table that are to be indexed are described
1009967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1010967e8b73Sdrh ** we have the following table and index:
1011967e8b73Sdrh **
1012967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1013967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1014967e8b73Sdrh **
1015967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1016967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1017967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1018967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1019967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1020967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1021967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1022ea1ba17cSdrh **
1023ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1024ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1025ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1026ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1027ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1028ea1ba17cSdrh ** element.
102975897234Sdrh */
103075897234Sdrh struct Index {
103175897234Sdrh   char *zName;     /* Name of this index */
1032967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1033967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
10348b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1035967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1036be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
10379cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1038485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1039a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
104075897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1041b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1042b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1043b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
104475897234Sdrh };
104575897234Sdrh 
104675897234Sdrh /*
104775897234Sdrh ** Each token coming out of the lexer is an instance of
10484b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
10494efc4754Sdrh **
10504efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
10514efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
10524efc4754Sdrh ** and Token.n when Token.z==0.
105375897234Sdrh */
105475897234Sdrh struct Token {
10554c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
10564b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
10576977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
105875897234Sdrh };
105975897234Sdrh 
106075897234Sdrh /*
106113449892Sdrh ** An instance of this structure contains information needed to generate
106213449892Sdrh ** code for a SELECT that contains aggregate functions.
106313449892Sdrh **
106413449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
106513449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
106613449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
106713449892Sdrh ** code for that node.
106813449892Sdrh **
106913449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
107013449892Sdrh ** original Select structure that describes the SELECT statement.  These
107113449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
107213449892Sdrh */
107313449892Sdrh struct AggInfo {
107413449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
107513449892Sdrh                           ** from source tables rather than from accumulators */
107613449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
107713449892Sdrh                           ** than the source table */
107813449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
107913449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
108013449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
108113449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
10820817d0dfSdanielk1977     Table *pTab;             /* Source table */
108313449892Sdrh     int iTable;              /* Cursor number of the source table */
108413449892Sdrh     int iColumn;             /* Column number within the source table */
108513449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
108613449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
10875774b806Sdrh     Expr *pExpr;             /* The original expression */
108813449892Sdrh   } *aCol;
108913449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
109013449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
109113449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
109213449892Sdrh                           ** Additional columns are used only as parameters to
109313449892Sdrh                           ** aggregate functions */
109413449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
109513449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
109613449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
109713449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1098b9bb7c18Sdrh     int iDistinct;           /* Ephermeral table used to enforce DISTINCT */
109913449892Sdrh   } *aFunc;
110013449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
110113449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
110213449892Sdrh };
110313449892Sdrh 
110413449892Sdrh /*
110575897234Sdrh ** Each node of an expression in the parse tree is an instance
110622f70c32Sdrh ** of this structure.
110722f70c32Sdrh **
110822f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
110922f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
111022f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
111122f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
111222f70c32Sdrh ** tree.
111322f70c32Sdrh **
111422f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
111522f70c32Sdrh ** of argument if the expression is a function.
111622f70c32Sdrh **
11174b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
11184b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
11194b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
11204b59ab5eSdrh ** a compound token.
112122f70c32Sdrh **
112222f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
112322f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
112422f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
112522f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
112622f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
112722f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
112822f70c32Sdrh ** it can be accessed after all aggregates are computed.
112922f70c32Sdrh **
113022f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
11317c972decSdrh ** representing which function.  If the expression is an unbound variable
11327c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
11337c972decSdrh ** Expr.iTable holds the index number for that variable.
113422f70c32Sdrh **
11351398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
11361398ad36Sdrh ** register number containing the result of the subquery.  If the
11371398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
11381398ad36Sdrh ** gives a different answer at different times during statement processing
11391398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
11401398ad36Sdrh **
114122f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
114222f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
114322f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
114422f70c32Sdrh ** operand.
1145aee18ef8Sdanielk1977 **
1146aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1147aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1148aee18ef8Sdanielk1977 ** corresponding table definition.
114975897234Sdrh */
115075897234Sdrh struct Expr {
11511cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1152a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
11536a03a1c5Sdrh   u16 flags;             /* Various flags.  See below */
1154f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
115575897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
1156d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
1157d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
115875897234Sdrh   Token token;           /* An operand token */
11596977fea8Sdrh   Token span;            /* Complete text of the expression */
1160967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
11618e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
116213449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
116313449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
116422d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1165d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
1166d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
1167aee18ef8Sdanielk1977   Table *pTab;           /* Table for OP_Column expressions. */
1168728b5779Sdrh /*  Schema *pSchema; */
1169e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1170fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1171fc976065Sdanielk1977 #endif
117275897234Sdrh };
117375897234Sdrh 
117475897234Sdrh /*
11751f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
11761f16230bSdrh */
1177392e597cSdrh #define EP_FromJoin     0x01  /* Originated in ON or USING clause of a join */
1178392e597cSdrh #define EP_Agg          0x02  /* Contains one or more aggregate functions */
1179392e597cSdrh #define EP_Resolved     0x04  /* IDs have been resolved to COLUMNs */
1180392e597cSdrh #define EP_Error        0x08  /* Expression contains one or more errors */
1181fd357974Sdrh #define EP_Distinct     0x10  /* Aggregate function with DISTINCT keyword */
1182392e597cSdrh #define EP_VarSelect    0x20  /* pSelect is correlated, not constant */
1183d2687b77Sdrh #define EP_Dequoted     0x40  /* True if the string has been dequoted */
11846a03a1c5Sdrh #define EP_InfixFunc    0x80  /* True for an infix function: LIKE, GLOB, etc */
11858b4c40d8Sdrh #define EP_ExpCollate  0x100  /* Collating sequence specified explicitly */
11861f16230bSdrh 
11871f16230bSdrh /*
11881f16230bSdrh ** These macros can be used to test, set, or clear bits in the
11891f16230bSdrh ** Expr.flags field.
11901f16230bSdrh */
11911f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
11921f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
11931f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
11941f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
11951f16230bSdrh 
11961f16230bSdrh /*
119775897234Sdrh ** A list of expressions.  Each expression may optionally have a
119875897234Sdrh ** name.  An expr/name combination can be used in several ways, such
119975897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
120075897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1201ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
120275897234Sdrh ** field is not used.
120375897234Sdrh */
120475897234Sdrh struct ExprList {
120575897234Sdrh   int nExpr;             /* Number of expressions on the list */
12064305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
12079d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
12086d4abfbeSdrh   struct ExprList_item {
120975897234Sdrh     Expr *pExpr;           /* The list of expressions */
121075897234Sdrh     char *zName;           /* Token associated with this expression */
12118e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
12128e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
12138e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
121475897234Sdrh   } *a;                  /* One entry for each expression */
121575897234Sdrh };
121675897234Sdrh 
121775897234Sdrh /*
1218ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1219ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1220ad3cab52Sdrh **
1221ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1222ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1223ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1224ad3cab52Sdrh **
1225ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1226ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1227ad3cab52Sdrh **
1228ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1229ad3cab52Sdrh **
1230ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
123175897234Sdrh */
123275897234Sdrh struct IdList {
12336d4abfbeSdrh   struct IdList_item {
1234ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1235967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1236ad3cab52Sdrh   } *a;
123713449892Sdrh   int nId;         /* Number of identifiers on the list */
123813449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1239ad3cab52Sdrh };
1240ad3cab52Sdrh 
1241ad3cab52Sdrh /*
124251669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1243ca83ac51Sdrh **
1244ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1245ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1246ca83ac51Sdrh ** of the library by 738 bytes on ix86.
124751669863Sdrh */
1248ca83ac51Sdrh typedef u64 Bitmask;
124951669863Sdrh 
125051669863Sdrh /*
1251ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1252ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1253ad3cab52Sdrh ** the SrcList.a[] array.
1254d24cc427Sdrh **
1255d24cc427Sdrh ** With the addition of multiple database support, the following structure
1256d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1257d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1258d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1259d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1260c49de5d9Sdrh **
1261c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1262c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1263c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1264c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
1265ad3cab52Sdrh */
1266ad3cab52Sdrh struct SrcList {
1267939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1268939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1269ad3cab52Sdrh   struct SrcList_item {
1270113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1271ad3cab52Sdrh     char *zName;      /* Name of the table */
1272ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1273daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1274daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
12751787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1276c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1277e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1278ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1279ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
128051669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1281113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
128275897234Sdrh };
128375897234Sdrh 
128475897234Sdrh /*
128501f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
128601f3f253Sdrh */
128701f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
12883dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
12893dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
12903dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
12913dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
12923dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
12933dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
129401f3f253Sdrh 
129501f3f253Sdrh /*
12966b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
12976b56344dSdrh ** structure contains a single instance of this structure.  This structure
12986b56344dSdrh ** is intended to be private the the where.c module and should not be
12996b56344dSdrh ** access or modified by other modules.
13006d209d8bSdrh **
13016d209d8bSdrh ** The pIdxInfo and pBestIdx fields are used to help pick the best
13026d209d8bSdrh ** index on a virtual table.  The pIdxInfo pointer contains indexing
13036d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
13046d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
13056d209d8bSdrh ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
13066d209d8bSdrh ** FROM clause ordering.  This is a little confusing so I will repeat
13076d209d8bSdrh ** it in different words.  WhereInfo.a[i].pIdxInfo is index information
13086d209d8bSdrh ** for WhereInfo.pTabList.a[i].  WhereInfo.a[i].pBestInfo is the
13096d209d8bSdrh ** index information for the i-th loop of the join.  pBestInfo is always
13106d209d8bSdrh ** either NULL or a copy of some pIdxInfo.  So for cleanup it is
13116d209d8bSdrh ** sufficient to free all of the pIdxInfo pointers.
13126d209d8bSdrh **
13136b56344dSdrh */
13146b56344dSdrh struct WhereLevel {
131529dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
131629dda4aeSdrh   int flags;            /* Flags associated with this level */
131751147baaSdrh   int iMem;             /* First memory cell used by this level */
131829dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
13199012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
13209012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
13219012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
13226b56344dSdrh   int brk;              /* Jump here to break out of the loop */
132372e8fa42Sdrh   int nxt;              /* Jump here to start the next IN combination */
13246b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1325ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
132629dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
132751147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1328e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
132972e8fa42Sdrh   struct InLoop {
133072e8fa42Sdrh     int iCur;              /* The VDBE cursor used by this IN operator */
133172e8fa42Sdrh     int topAddr;           /* Top of the IN loop */
133272e8fa42Sdrh   } *aInLoop;           /* Information about each nested IN operator */
13336d209d8bSdrh   sqlite3_index_info *pBestIdx;  /* Index information for this level */
13346d209d8bSdrh 
13356d209d8bSdrh   /* The following field is really not part of the current level.  But
13366d209d8bSdrh   ** we need a place to cache index information for each table in the
13376d209d8bSdrh   ** FROM clause and the WhereLevel structure is a convenient place.
13386d209d8bSdrh   */
13396d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
13406b56344dSdrh };
13416b56344dSdrh 
1342a9d1ccb9Sdanielk1977 #define ORDERBY_NORMAL 0
1343a9d1ccb9Sdanielk1977 #define ORDERBY_MIN    1
1344a9d1ccb9Sdanielk1977 #define ORDERBY_MAX    2
1345a9d1ccb9Sdanielk1977 
13466b56344dSdrh /*
134775897234Sdrh ** The WHERE clause processing routine has two halves.  The
134875897234Sdrh ** first part does the start of the WHERE loop and the second
134975897234Sdrh ** half does the tail of the WHERE loop.  An instance of
135075897234Sdrh ** this structure is returned by the first half and passed
135175897234Sdrh ** into the second half to give some continuity.
135275897234Sdrh */
135375897234Sdrh struct WhereInfo {
135475897234Sdrh   Parse *pParse;
1355ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
13569012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
135719a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
135819a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
13596b56344dSdrh   int nLevel;          /* Number of nested loop */
13606d209d8bSdrh   sqlite3_index_info **apInfo;  /* Array of pointers to index info structures */
13616b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
136275897234Sdrh };
136375897234Sdrh 
136475897234Sdrh /*
1365b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1366b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1367b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1368b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1369b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1370b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1371b3bce662Sdanielk1977 ** other statements.
1372b3bce662Sdanielk1977 **
1373b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1374b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1375b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1376b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1377b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1378b3bce662Sdanielk1977 ** the context containing the match is incremented.
1379b3bce662Sdanielk1977 **
1380b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1381b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1382b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1383b3bce662Sdanielk1977 ** subqueries looking for a match.
1384b3bce662Sdanielk1977 */
1385b3bce662Sdanielk1977 struct NameContext {
1386b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1387b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1388b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1389b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1390b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1391b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
139213449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
139306f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1394b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
139513449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1396b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1397b3bce662Sdanielk1977 };
1398b3bce662Sdanielk1977 
1399b3bce662Sdanielk1977 /*
14009bb61fe7Sdrh ** An instance of the following structure contains all information
14019bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1402a76b5dfcSdrh **
1403d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1404d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1405d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1406d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1407d11d382cSdrh ** in the VDBE that record the limit and offset counters.
14080342b1f5Sdrh **
1409b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
14100342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
141166a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
14120342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
1413b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
14140342b1f5Sdrh ** enough information about the compound query is known at that point.
1415b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1416b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
14170342b1f5Sdrh ** sequences for the ORDER BY clause.
14189bb61fe7Sdrh */
14199bb61fe7Sdrh struct Select {
14209bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
14217b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
14227b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
14230342b1f5Sdrh   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
14240342b1f5Sdrh   u8 isAgg;              /* True if this is an aggregate query */
1425b9bb7c18Sdrh   u8 usesEphm;           /* True if uses an OpenEphemeral opcode */
14264b14b4d7Sdrh   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
14276c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
1428ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
14299bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
14309bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
14319bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
14329bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1433967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
14341e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
14350342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1436a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1437a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
14387b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1439b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
14409bb61fe7Sdrh };
14419bb61fe7Sdrh 
14429bb61fe7Sdrh /*
1443fef5208cSdrh ** The results of a select can be distributed in several ways.
1444fef5208cSdrh */
144513449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
144613449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
14479ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
14489ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
1449fef5208cSdrh 
145013449892Sdrh /* The ORDER BY clause is ignored for all of the above */
14516c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
145213449892Sdrh 
14539ed1dfa8Sdanielk1977 #define SRT_Callback     5  /* Invoke a callback with each row of result */
14549ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
14559ed1dfa8Sdanielk1977 #define SRT_Set          7  /* Store non-null results as keys in an index */
14569ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
14579ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
14589ed1dfa8Sdanielk1977 #define SRT_Subroutine  10  /* Call a subroutine to handle results */
14592282792aSdrh 
14602282792aSdrh /*
14616c8c8ce0Sdanielk1977 ** A structure used to customize the behaviour of sqlite3Select(). See
14626c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
14636c8c8ce0Sdanielk1977 */
14646c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
14656c8c8ce0Sdanielk1977 struct SelectDest {
1466477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
1467477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
14686c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
14691013c932Sdrh   int iMem;         /* Base register where results are written */
14706c8c8ce0Sdanielk1977 };
14716c8c8ce0Sdanielk1977 
14726c8c8ce0Sdanielk1977 /*
1473f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1474f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1475f57b3399Sdrh ** carry around information that is global to the entire parse.
1476f1974846Sdrh **
1477f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1478f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1479f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1480f1974846Sdrh ** each recursion.
1481c00da105Sdanielk1977 **
1482c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1483c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1484c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1485c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1486c00da105Sdanielk1977 ** list.
148775897234Sdrh */
148875897234Sdrh struct Parse {
14899bb575fdSdrh   sqlite3 *db;         /* The main database structure */
14904c504391Sdrh   int rc;              /* Return code from execution */
149175897234Sdrh   char *zErrMsg;       /* An error message */
149275897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1493836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1494e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1495a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1496205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
14977e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1498892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
14992dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
1500892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
1501892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
1502892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
150375897234Sdrh   int nErr;            /* Number of errors seen */
1504832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
150519a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1506fef5208cSdrh   int nSet;            /* Number of sets used so far */
1507aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
150880242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1509fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1510fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1511c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1512c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1513c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1514c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1515c00da105Sdanielk1977 #endif
1516cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
1517cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
1518f1974846Sdrh 
1519f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1520f1974846Sdrh   ** each recursion */
1521f1974846Sdrh 
1522f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1523f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1524f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1525f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1526f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1527f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1528f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1529f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1530f1974846Sdrh   const char *zSql;    /* All SQL text */
1531f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1532f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1533f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1534f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1535f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1536b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
153733b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
15387e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
1539f9e7dda7Sdanielk1977   Table *pVirtualLock;       /* Require virtual table lock on this table */
1540b9bb7c18Sdrh #endif
1541e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1542fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
1543fc976065Sdanielk1977 #endif
154475897234Sdrh };
154575897234Sdrh 
15467e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
15477e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
15487e6ebfb2Sdanielk1977 #else
15497e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
15507e6ebfb2Sdanielk1977 #endif
15517e6ebfb2Sdanielk1977 
1552d99bc930Sdanielk1977 /*
155385e2096fSdrh ** An instance of the following structure can be declared on a stack and used
155485e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
155585e2096fSdrh */
155685e2096fSdrh struct AuthContext {
155785e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
155885e2096fSdrh   Parse *pParse;              /* The Parse structure */
155985e2096fSdrh };
156085e2096fSdrh 
156185e2096fSdrh /*
1562f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1563b0c374ffSrdc */
1564b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1565b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
156694eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1567e4d90813Sdrh #define OPFLAG_APPEND    8    /* This is likely to be an append */
1568b0c374ffSrdc 
1569b0c374ffSrdc /*
1570d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1571d99bc930Sdanielk1977  * struct Trigger.
1572d99bc930Sdanielk1977  *
1573d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
15749bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1575d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1576d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1577ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1578ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1579ad3cab52Sdrh  *    struct Table.
1580d99bc930Sdanielk1977  *
1581ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1582ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1583d99bc930Sdanielk1977  */
1584d99bc930Sdanielk1977 struct Trigger {
1585d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1586d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1587f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1588dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1589d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1590d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1591d99bc930Sdanielk1977                              the <column-list> is stored here */
15924312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1593e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1594e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1595d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1596d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1597c3f9bad2Sdanielk1977 };
1598d99bc930Sdanielk1977 
1599d99bc930Sdanielk1977 /*
1600dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1601dca76841Sdrh ** determine which.
1602dca76841Sdrh **
1603dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1604dca76841Sdrh ** In that cases, the constants below can be ORed together.
1605dca76841Sdrh */
1606dca76841Sdrh #define TRIGGER_BEFORE  1
1607dca76841Sdrh #define TRIGGER_AFTER   2
1608dca76841Sdrh 
1609dca76841Sdrh /*
1610d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1611d99bc930Sdanielk1977  * that is a part of a trigger-program.
1612d99bc930Sdanielk1977  *
1613d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1614d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1615d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1616d99bc930Sdanielk1977  * the first step of the trigger-program.
1617d99bc930Sdanielk1977  *
1618d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1619d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1620d99bc930Sdanielk1977  * value of "op" as follows:
1621d99bc930Sdanielk1977  *
1622d99bc930Sdanielk1977  * (op == TK_INSERT)
1623d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1624d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1625d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1626d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1627d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1628d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1629d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1630ad3cab52Sdrh  *              statement, then this stores the column-names to be
1631ad3cab52Sdrh  *              inserted into.
1632d99bc930Sdanielk1977  *
1633d99bc930Sdanielk1977  * (op == TK_DELETE)
1634d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1635d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1636d99bc930Sdanielk1977  *              Otherwise NULL.
1637d99bc930Sdanielk1977  *
1638d99bc930Sdanielk1977  * (op == TK_UPDATE)
1639d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1640d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1641d99bc930Sdanielk1977  *              Otherwise NULL.
1642d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
16434adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1644ad3cab52Sdrh  *              argument.
1645d99bc930Sdanielk1977  *
1646d99bc930Sdanielk1977  */
1647c3f9bad2Sdanielk1977 struct TriggerStep {
1648c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1649d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1650a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1651c3f9bad2Sdanielk1977 
1652c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1653c3f9bad2Sdanielk1977                           INSERT steps (when pExprList == 0) */
1654c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1655c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1656c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1657c3f9bad2Sdanielk1977                            INSERT steps (when pSelect == 0)         */
1658c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1659c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
1660187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1661c3f9bad2Sdanielk1977 };
1662c3f9bad2Sdanielk1977 
1663d99bc930Sdanielk1977 /*
1664d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1665d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1666d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1667d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1668d99bc930Sdanielk1977  *
1669d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1670d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1671d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1672d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1673d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1674d99bc930Sdanielk1977  *
1675d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1676d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1677d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1678d99bc930Sdanielk1977  *
1679d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1680d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1681d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1682d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1683d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1684d99bc930Sdanielk1977  * trigger continues.
1685d99bc930Sdanielk1977  *
1686d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1687d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1688d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1689d99bc930Sdanielk1977  */
1690d99bc930Sdanielk1977 struct TriggerStack {
1691d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1692d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1693d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
16948f2c54e6Sdanielk1977   u32 newColMask;
16958f2c54e6Sdanielk1977   u32 oldColMask;
1696d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
16976f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1698e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1699e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1700c3f9bad2Sdanielk1977 };
1701c3f9bad2Sdanielk1977 
1702d99bc930Sdanielk1977 /*
1703f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1704f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1705f26e09c8Sdrh ** explicit.
1706f26e09c8Sdrh */
1707f26e09c8Sdrh typedef struct DbFixer DbFixer;
1708f26e09c8Sdrh struct DbFixer {
1709f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1710f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1711f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1712f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1713f26e09c8Sdrh };
1714f26e09c8Sdrh 
1715f26e09c8Sdrh /*
1716ade86483Sdrh ** An objected used to accumulate the text of a string where we
1717ade86483Sdrh ** do not necessarily know how big the string will be in the end.
1718ade86483Sdrh */
1719ade86483Sdrh struct StrAccum {
1720ade86483Sdrh   char *zBase;     /* A base allocation.  Not from malloc. */
1721ade86483Sdrh   char *zText;     /* The string collected so far */
1722ade86483Sdrh   int  nChar;      /* Length of the string so far */
1723ade86483Sdrh   int  nAlloc;     /* Amount of space allocated in zText */
1724ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
1725ade86483Sdrh   u8   useMalloc;      /* True if zText is enlargable using realloc */
1726ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
1727ade86483Sdrh };
1728ade86483Sdrh 
1729ade86483Sdrh /*
1730234c39dfSdrh ** A pointer to this structure is used to communicate information
1731234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1732234c39dfSdrh */
1733234c39dfSdrh typedef struct {
17349bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1735ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
1736234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
173715ca1df1Sdrh   int rc;             /* Result code stored here */
1738234c39dfSdrh } InitData;
1739234c39dfSdrh 
1740b6c29897Sdrh /*
174166150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
174266150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
17434a919118Sdrh */
17444a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
17454a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
17464a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
17474a919118Sdrh   }                                                    \
17484a919118Sdrh }
17494a919118Sdrh 
17504a919118Sdrh /*
175149285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
175249285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
175349285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
175449285708Sdrh ** corruption is first detected.
175549285708Sdrh */
175649285708Sdrh #ifdef SQLITE_DEBUG
17576e736838Sdrh   int sqlite3Corrupt(void);
175849285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1759e5fe690dSdrh # define DEBUGONLY(X)        X
176049285708Sdrh #else
176149285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1762e5fe690dSdrh # define DEBUGONLY(X)
176349285708Sdrh #endif
176449285708Sdrh 
176549285708Sdrh /*
176675897234Sdrh ** Internal function prototypes
176775897234Sdrh */
17684adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
17694adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
17708a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
17712e588c75Sdanielk1977 
177217435752Sdrh void *sqlite3MallocZero(unsigned);
177317435752Sdrh void *sqlite3DbMallocZero(sqlite3*, unsigned);
177417435752Sdrh void *sqlite3DbMallocRaw(sqlite3*, unsigned);
1775bdb4383aSdrh char *sqlite3StrDup(const char*);
1776bdb4383aSdrh char *sqlite3StrNDup(const char*, int);
177717435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
177817435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
177997c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
1780a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
1781a7a8e14bSdanielk1977 int sqlite3MallocSize(void *);
17822e588c75Sdanielk1977 
178317435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
178417435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
178587cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1786e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
1787d919fe17Sdrh #endif
1788d919fe17Sdrh #if defined(SQLITE_TEST)
1789fe63d1c9Sdrh   void *sqlite3TextToPtr(const char*);
179087cc3b31Sdrh #endif
179141f5852eSdrh void sqlite3SetString(char **, ...);
17924adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
1793a073384fSdrh void sqlite3ErrorClear(Parse*);
17944adee20fSdanielk1977 void sqlite3Dequote(char*);
179517435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*);
17962646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
17974adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
179880242055Sdrh void sqlite3FinishCoding(Parse*);
1799892d3179Sdrh int sqlite3GetTempReg(Parse*);
1800892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
1801892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
1802892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
1803a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
180417435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
18054e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
18061e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
18074adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
180817435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
1809fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
18104adee20fSdanielk1977 void sqlite3ExprDelete(Expr*);
181117435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
18124adee20fSdanielk1977 void sqlite3ExprListDelete(ExprList*);
18139bb575fdSdrh int sqlite3Init(sqlite3*, char**);
1814234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
181591cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
18169bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
18174adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
18189bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
18194adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1820c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
1821f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
18224adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
18234adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
1824fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1825ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
1826487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
18277977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
182839002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
182919a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1830b7f9164eSdrh 
1831f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
1832f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
1833f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
1834f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32);
1835f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
1836f5e7bb51Sdrh 
1837fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
1838fe3fcbe2Sdanielk1977 
1839fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
18404adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
1841b7f9164eSdrh #else
1842b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
1843b7f9164eSdrh #endif
1844b7f9164eSdrh 
1845a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
1846a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*);
18474adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
184817435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
184917435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
18504adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
185117435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
185217435752Sdrh SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
185361dfc31dSdrh                                       Select*, Expr*, IdList*);
185461dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
18554adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
18564adee20fSdanielk1977 void sqlite3IdListDelete(IdList*);
18574adee20fSdanielk1977 void sqlite3SrcListDelete(SrcList*);
18580202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
18594d91a701Sdrh                         Token*, int, int);
18604d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
18616c8c8ce0Sdanielk1977 int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*, char *aff);
186217435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
186317435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
18644adee20fSdanielk1977 void sqlite3SelectDelete(Select*);
18654adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
18664adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
1867c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
18684adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
18694adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1870a9d1ccb9Sdanielk1977 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
18714adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
18722133d822Sdrh void sqlite3ExprCodeGetColumn(Vdbe*, Table*, int, int, int);
1873389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
18742dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
18752dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
1876389a1adbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int);
18774adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
18784adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
18799bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
1880ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
18819bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
18829bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
18839bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
188474161705Sdrh void sqlite3Vacuum(Parse*);
18859bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
188617435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
18874adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
1888b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *);
1889d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1890d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
18914adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
18921e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*);
18932fa1868fSdrh void sqlite3PrngSaveState(void);
18942fa1868fSdrh void sqlite3PrngRestoreState(void);
18952fa1868fSdrh void sqlite3PrngResetState(void);
18969bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
18974adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
1898684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
18994adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
19004adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
19014adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
19020a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
1903eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
19044adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
19054adee20fSdanielk1977 int sqlite3IsRowid(const char*);
19062d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
19072d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
19082d401ab8Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int);
190904adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
191004adf416Sdrh                                      int*,int,int,int,int);
191104adf416Sdrh void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
1912aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
19134adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
191417435752Sdrh Expr *sqlite3ExprDup(sqlite3*,Expr*);
191517435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*);
191617435752Sdrh ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
191717435752Sdrh SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
191817435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
191917435752Sdrh Select *sqlite3SelectDup(sqlite3*,Select*);
19209bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
19219bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
19229bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*);
19237e8b848aSdrh #ifdef SQLITE_DEBUG
19249bb575fdSdrh   int sqlite3SafetyOn(sqlite3*);
19259bb575fdSdrh   int sqlite3SafetyOff(sqlite3*);
19267e8b848aSdrh #else
19277e8b848aSdrh # define sqlite3SafetyOn(A) 0
19287e8b848aSdrh # define sqlite3SafetyOff(A) 0
19297e8b848aSdrh #endif
19307e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
19317e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
19329cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
19330f35a6b5Sdrh void sqlite3MaterializeView(Parse*, Select*, Expr*, u32, int);
1934b7f9164eSdrh 
1935b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
1936ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
193760218d2aSdrh                            Expr*,int, int);
19384adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1939fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
194074161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
1941dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
19424adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
19438f2c54e6Sdanielk1977                            int, int, u32*, u32*);
1944dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
19454adee20fSdanielk1977   void sqlite3DeleteTriggerStep(TriggerStep*);
194617435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
194717435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
194817435752Sdrh                                         ExprList*,Select*,int);
194917435752Sdrh   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
195017435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
19514adee20fSdanielk1977   void sqlite3DeleteTrigger(Trigger*);
1952b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
19531f12107aSdanielk1977   void sqlite3SelectMask(Parse *, Select *, u32);
1954b7f9164eSdrh #else
1955b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
1956b7f9164eSdrh # define sqlite3DeleteTrigger(A)
1957cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
1958b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
19598f2c54e6Sdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
19601f12107aSdanielk1977 # define sqlite3SelectMask(A, B, C)
1961b7f9164eSdrh #endif
1962b7f9164eSdrh 
19634adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
19640202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
19654adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
1966ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
1967728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
19684adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
19694adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
19704adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
1971ed6c8671Sdrh #else
1972b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
19734adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
19744adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
19754adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
1976ed6c8671Sdrh #endif
1977f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1978f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
19799bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
198033f4e02aSdrh                        int omitJournal, int nCache, int flags, Btree **ppBtree);
19814adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
19824adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
19834adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
19844adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
19854adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
19864adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1987487e262fSdrh int sqlite3AtoF(const char *z, double*);
19886f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
1989fec19aadSdrh int sqlite3GetInt32(const char *, int*);
1990598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int);
1991ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
1992ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
199366150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**);
1994192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char *, u64);
199590e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
19966d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
1997192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
1998a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
1999a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
2000e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
2001e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
2002bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
2003b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*);
20049bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
2005ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
2006ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
2007f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
20088a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
20099bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
20100202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
20117cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
20128b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
20137cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2014d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2015b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
20164e6af134Sdanielk1977 
2017b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2018b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2019b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
20201e536953Sdanielk1977                         void(*)(void*));
20214e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
20221e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
20231e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
20241e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2025b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
202646c99e0fSdrh #ifndef SQLITE_AMALGAMATION
20274e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
202846c99e0fSdrh #endif
2029a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
20304343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
20311f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
20329fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
20339fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
20342958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2035d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
2036b3bce662Sdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *);
2037b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
2038aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
203919a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
204019a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
20414dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
20428a51256cSdrh char sqlite3AffinityType(const Token*);
20439f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2044a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2045ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
2046cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
204751147baaSdrh void sqlite3DefaultRowEst(Index*);
204855ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2049d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
2050f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
2051fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
2052da184236Sdanielk1977 void sqlite3SchemaFree(void *);
20531e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
2054e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
2055b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
2056771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2057771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
2058771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
205954f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
2060ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
206169dab1d3Sdrh 
2062ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2063ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
2064ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
20651013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
20661e536953Sdanielk1977 
206795bdbbbdSdrh /*
206895bdbbbdSdrh ** The interface to the LEMON-generated parser
206995bdbbbdSdrh */
207095bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
207195bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
207295bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
207395bdbbbdSdrh 
2074caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*);
207569dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
2076f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
207769dab1d3Sdrh #else
207869dab1d3Sdrh # define sqlite3CloseExtensions(X)
207969dab1d3Sdrh #endif
2080e3026636Sdanielk1977 
2081c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2082c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
2083c00da105Sdanielk1977 #else
2084c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
2085c00da105Sdanielk1977 #endif
2086c00da105Sdanielk1977 
208753c14021Sdrh #ifdef SQLITE_TEST
208853c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
208953c14021Sdrh #endif
209053c14021Sdrh 
2091b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
2092b9bb7c18Sdrh #  define sqlite3VtabClear(X)
2093f9e7dda7Sdanielk1977 #  define sqlite3VtabSync(X,Y) (Y)
2094f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
2095f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
2096b9bb7c18Sdrh #else
2097707205d1Sdrh    void sqlite3VtabClear(Table*);
2098f9e7dda7Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, int rc);
2099f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
2100f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
2101b9bb7c18Sdrh #endif
2102189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*);
2103a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
2104b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2105b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
2106b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
2107b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
210878efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
21097e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
21109e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
2111f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
21121e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
2113b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
2114b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
21157a15a4beSdanielk1977 void sqlite3ExprListCheckLength(Parse*, ExprList*, int, const char*);
2116bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
2117b9bb7c18Sdrh 
2118643167ffSdrh 
2119643167ffSdrh /*
2120643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
2121643167ffSdrh */
2122643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
21237e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
2124643167ffSdrh 
2125643167ffSdrh /*
2126643167ffSdrh ** The interface to the fault injector subsystem.  If the fault injector
2127643167ffSdrh ** mechanism is disabled at compile-time then set up macros so that no
2128643167ffSdrh ** unnecessary code is generated.
2129643167ffSdrh */
21302fa1868fSdrh #ifndef SQLITE_OMIT_TESTLOGIC
2131643167ffSdrh   void sqlite3FaultConfig(int,int,int);
2132643167ffSdrh   int sqlite3FaultFailures(int);
2133643167ffSdrh   int sqlite3FaultBenignFailures(int);
2134643167ffSdrh   int sqlite3FaultPending(int);
2135643167ffSdrh   void sqlite3FaultBenign(int,int);
2136643167ffSdrh   int sqlite3FaultStep(int);
2137643167ffSdrh #else
2138643167ffSdrh # define sqlite3FaultConfig(A,B,C)
2139643167ffSdrh # define sqlite3FaultFailures(A)         0
2140643167ffSdrh # define sqlite3FaultBenignFailures(A)   0
2141643167ffSdrh # define sqlite3FaultPending(A)          (-1)
2142643167ffSdrh # define sqlite3FaultBenign(A,B)
2143643167ffSdrh # define sqlite3FaultStep(A)             0
2144643167ffSdrh #endif
2145643167ffSdrh 
2146643167ffSdrh 
2147643167ffSdrh 
21489a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
21499a96b668Sdanielk1977 #define IN_INDEX_EPH             2
21509a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
21519a96b668Sdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int);
21529a96b668Sdanielk1977 
2153c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
2154c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2155c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
2156f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
2157c7b6017cSdanielk1977 #else
2158c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2159c7b6017cSdanielk1977 #endif
2160c7b6017cSdanielk1977 
2161e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
2162fc976065Sdanielk1977   void sqlite3ExprSetHeight(Expr *);
2163fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
2164fc976065Sdanielk1977 #else
2165fc976065Sdanielk1977   #define sqlite3ExprSetHeight(x)
2166fc976065Sdanielk1977 #endif
2167fc976065Sdanielk1977 
2168a3152895Sdrh u32 sqlite3Get4byte(const u8*);
2169a3152895Sdrh void sqlite3Put4byte(u8*, u32);
2170a3152895Sdrh 
2171fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
2172fd9a0a45Sdanielk1977 #include "sseInt.h"
2173fd9a0a45Sdanielk1977 #endif
2174fd9a0a45Sdanielk1977 
21756e736838Sdrh #ifdef SQLITE_DEBUG
21766e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
21776e736838Sdrh #endif
21786e736838Sdrh 
2179b0603416Sdrh /*
2180b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
21813a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
2182b0603416Sdrh ** print I/O tracing messages.
2183b0603416Sdrh */
2184b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
21853a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
2186b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
2187b0603416Sdrh #else
2188b0603416Sdrh # define IOTRACE(A)
2189b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
2190b0603416Sdrh #endif
21913a00f907Smlcreech SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
2192b0603416Sdrh 
2193e3026636Sdanielk1977 #endif
2194