xref: /sqlite-3.40.0/src/sqliteInt.h (revision c5499bef)
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*c5499befSdrh ** @(#) $Id: sqliteInt.h,v 1.687 2008/04/01 15:06:34 drh 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"
24bb4957f8Sdrh #include "sqliteLimit.h"
2598dc4b1aSmlcreech 
2698dc4b1aSmlcreech /* Needed for various definitions... */
2798dc4b1aSmlcreech #define _GNU_SOURCE
2898dc4b1aSmlcreech 
2998dc4b1aSmlcreech /*
3098dc4b1aSmlcreech ** Include standard header files as necessary
3198dc4b1aSmlcreech */
3298dc4b1aSmlcreech #ifdef HAVE_STDINT_H
3398dc4b1aSmlcreech #include <stdint.h>
3498dc4b1aSmlcreech #endif
3598dc4b1aSmlcreech #ifdef HAVE_INTTYPES_H
3698dc4b1aSmlcreech #include <inttypes.h>
37bd0ae111Smlcreech #endif
38b87057f2Smlcreech 
3998dc4b1aSmlcreech /*
4098dc4b1aSmlcreech ** If possible, use the C99 intptr_t type to define an integral type of
4198dc4b1aSmlcreech ** equivalent size to a pointer.  (Technically it's >= sizeof(void *), but
4298dc4b1aSmlcreech ** practically it's == sizeof(void *)).  We fall back to an int if this type
4398dc4b1aSmlcreech ** isn't defined.
4498dc4b1aSmlcreech */
4598dc4b1aSmlcreech #ifdef HAVE_INTPTR_T
4698dc4b1aSmlcreech   typedef intptr_t sqlite3_intptr_t;
4798dc4b1aSmlcreech #else
48a9e852b6Smlcreech   typedef int sqlite3_intptr_t;
49a9e852b6Smlcreech #endif
50a9e852b6Smlcreech 
51*c5499befSdrh /*
52*c5499befSdrh ** A macro used to aid in coverage testing.  When doing coverage
53*c5499befSdrh ** testing, the condition inside the argument must be evaluated
54*c5499befSdrh ** both true and false in order to get full branch coverage.
55*c5499befSdrh ** This macro can be inserted to ensure adequate test coverage
56*c5499befSdrh ** in places where simple condition/decision coverage is inadequate.
57*c5499befSdrh */
58*c5499befSdrh #ifdef SQLITE_COVERAGE_TEST
59*c5499befSdrh   void sqlite3Coverage(int);
60*c5499befSdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
61*c5499befSdrh #else
62*c5499befSdrh # define testcase(X)
63*c5499befSdrh #endif
64*c5499befSdrh 
6598dc4b1aSmlcreech 
6671674ce9Sdrh /*
67b6dbc000Sdrh ** The macro unlikely() is a hint that surrounds a boolean
68b6dbc000Sdrh ** expression that is usually false.  Macro likely() surrounds
69b6dbc000Sdrh ** a boolean expression that is usually true.  GCC is able to
70b6dbc000Sdrh ** use these hints to generate better code, sometimes.
71b6dbc000Sdrh */
724bbf464fSdrh #if defined(__GNUC__) && 0
73b6dbc000Sdrh # define likely(X)    __builtin_expect((X),1)
74b6dbc000Sdrh # define unlikely(X)  __builtin_expect((X),0)
75b6dbc000Sdrh #else
76b6dbc000Sdrh # define likely(X)    !!(X)
77b6dbc000Sdrh # define unlikely(X)  !!(X)
78b6dbc000Sdrh #endif
79b6dbc000Sdrh 
80b6dbc000Sdrh 
81b6dbc000Sdrh /*
8271674ce9Sdrh ** These #defines should enable >2GB file support on Posix if the
8371674ce9Sdrh ** underlying operating system supports it.  If the OS lacks
8471674ce9Sdrh ** large file support, or if the OS is windows, these should be no-ops.
8571674ce9Sdrh **
8671674ce9Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
8771674ce9Sdrh ** system #includes.  Hence, this block of code must be the very first
8871674ce9Sdrh ** code in all source files.
8971674ce9Sdrh **
9071674ce9Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
9171674ce9Sdrh ** on the compiler command line.  This is necessary if you are compiling
9271674ce9Sdrh ** on a recent machine (ex: RedHat 7.2) but you want your code to work
9371674ce9Sdrh ** on an older machine (ex: RedHat 6.0).  If you compile on RedHat 7.2
9471674ce9Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
9571674ce9Sdrh ** in RedHat 6.0, so the code won't work.  Hence, for maximum binary
9671674ce9Sdrh ** portability you should omit LFS.
9771674ce9Sdrh **
9871674ce9Sdrh ** Similar is true for MacOS.  LFS is only supported on MacOS 9 and later.
9971674ce9Sdrh */
10071674ce9Sdrh #ifndef SQLITE_DISABLE_LFS
10171674ce9Sdrh # define _LARGE_FILE       1
10271674ce9Sdrh # ifndef _FILE_OFFSET_BITS
10371674ce9Sdrh #   define _FILE_OFFSET_BITS 64
10471674ce9Sdrh # endif
10571674ce9Sdrh # define _LARGEFILE_SOURCE 1
10671674ce9Sdrh #endif
10771674ce9Sdrh 
10871674ce9Sdrh 
109e5e7a901Sdrh /*
110e5e7a901Sdrh ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
111e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
112e5e7a901Sdrh ** We support that for legacy
113e5e7a901Sdrh */
114e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
115e5e7a901Sdrh #if defined(THREADSAFE)
116e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE
117e5e7a901Sdrh #else
118e5e7a901Sdrh # define SQLITE_THREADSAFE 1
119e5e7a901Sdrh #endif
120e5e7a901Sdrh #endif
121e5e7a901Sdrh 
12267080617Sdrh /*
1230d18020bSdrh ** Exactly one of the following macros must be defined in order to
1240d18020bSdrh ** specify which memory allocation subsystem to use.
1250d18020bSdrh **
1260d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
1270d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
1280d18020bSdrh **     SQLITE_MEMORY_SIZE            // internal allocator #1
1290d18020bSdrh **     SQLITE_MMAP_HEAP_SIZE         // internal mmap() allocator
1300d18020bSdrh **     SQLITE_POW2_MEMORY_SIZE       // internal power-of-two allocator
1310d18020bSdrh **
1320d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
1330d18020bSdrh ** the default.
1340d18020bSdrh */
1350d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1360d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1370d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)>1
1380d18020bSdrh # error "At most one of the following compile-time configuration options\
1390d18020bSdrh  is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
1400d18020bSdrh  SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
1410d18020bSdrh #endif
1420d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1430d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1440d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)==0
1450d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
1460d18020bSdrh #endif
1470d18020bSdrh 
1480d18020bSdrh /*
149eee4c8caSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
150eee4c8caSdrh ** sizes of memory allocations below this value where possible.
151eee4c8caSdrh */
152eee4c8caSdrh #if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
153eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
154eee4c8caSdrh #endif
155eee4c8caSdrh 
156eee4c8caSdrh /*
15767080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
15867080617Sdrh ** recursive mutexes on most unix systems.  But Mac OS X is different.
15967080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
16067080617Sdrh ** so it is omitted there.  See ticket #2673.
161e5e7a901Sdrh **
162e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
163e5e7a901Sdrh ** implemented on some systems.  So we avoid defining it at all
164e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are
165e5e7a901Sdrh ** not doing a threadsafe build.  Ticket #2681.
1669e0ebbfaSdrh **
1679e0ebbfaSdrh ** See also ticket #2741.
16867080617Sdrh */
169ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
170058897a9Sdrh #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
17167080617Sdrh #endif
172e3026636Sdanielk1977 
1734f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
1744f0c5878Sdrh # include <tcl.h>
175824d7c18Sdrh #endif
176824d7c18Sdrh 
177824d7c18Sdrh /*
1784b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
179b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
1804b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
1814b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
1824b529d97Sdrh ** feature.
1834b529d97Sdrh */
184289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
1854b529d97Sdrh # define NDEBUG 1
1864b529d97Sdrh #endif
1874b529d97Sdrh 
1881d482dd9Sdrh #include "sqlite3.h"
189beae3194Sdrh #include "hash.h"
19075897234Sdrh #include "parse.h"
19175897234Sdrh #include <stdio.h>
19275897234Sdrh #include <stdlib.h>
19375897234Sdrh #include <string.h>
19475897234Sdrh #include <assert.h>
19552370e2cSdrh #include <stddef.h>
19675897234Sdrh 
1977cd6927eSdrh #define sqlite3_isnan(X)  ((X)!=(X))
1987361cb1fSdrh 
199967e8b73Sdrh /*
200b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
201b37df7b9Sdrh ** substitute integer for floating-point
202b37df7b9Sdrh */
203b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
204b37df7b9Sdrh # define double sqlite_int64
205b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
206d1167393Sdrh # ifndef SQLITE_BIG_DBL
207b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
208d1167393Sdrh # endif
209b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
210b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
211110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
212b37df7b9Sdrh #endif
213d1167393Sdrh #ifndef SQLITE_BIG_DBL
214d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
215d1167393Sdrh #endif
216b37df7b9Sdrh 
217b37df7b9Sdrh /*
21853c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
21953c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
22053c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
22153c0f748Sdanielk1977 */
22253c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
22353c0f748Sdanielk1977 #define OMIT_TEMPDB 1
22453c0f748Sdanielk1977 #else
22553c0f748Sdanielk1977 #define OMIT_TEMPDB 0
22653c0f748Sdanielk1977 #endif
22753c0f748Sdanielk1977 
22853c0f748Sdanielk1977 /*
2290bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
2300bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
2310bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
2320bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
2330bd1f4eaSdrh ** is the way things are suppose to work.
2340bd1f4eaSdrh **
2350bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
2360bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
2370bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
2380bd1f4eaSdrh ** work.
2390bd1f4eaSdrh */
2400bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
2410bd1f4eaSdrh 
2420bd1f4eaSdrh /*
243d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
244d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
245d946db00Sdrh ** the default file format for new databases and the maximum file format
246d946db00Sdrh ** that the library can read.
247d946db00Sdrh */
248d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
249d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
25076fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
251d946db00Sdrh #endif
252d946db00Sdrh 
253d946db00Sdrh /*
25449766d6cSdrh ** Provide a default value for TEMP_STORE in case it is not specified
25549766d6cSdrh ** on the command-line
25649766d6cSdrh */
25749766d6cSdrh #ifndef TEMP_STORE
25849766d6cSdrh # define TEMP_STORE 1
25949766d6cSdrh #endif
26049766d6cSdrh 
26149766d6cSdrh /*
262f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
263f1974846Sdrh ** ourselves.
264f1974846Sdrh */
265f1974846Sdrh #ifndef offsetof
266f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
267f1974846Sdrh #endif
268f1974846Sdrh 
269f1974846Sdrh /*
2709b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
2719b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
2729b8f447bSdrh */
2739b8f447bSdrh #if 'A' == '\301'
2749b8f447bSdrh # define SQLITE_EBCDIC 1
2759b8f447bSdrh #else
2769b8f447bSdrh # define SQLITE_ASCII 1
2779b8f447bSdrh #endif
2789b8f447bSdrh 
2799b8f447bSdrh /*
2805a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
2815a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
2825a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
2835a2c2c20Sdrh **
2845a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
28541a2b48bSdrh */
2865a2c2c20Sdrh #ifndef UINT32_TYPE
287dda5b68cSmlcreech # ifdef HAVE_UINT32_T
288dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
289dda5b68cSmlcreech # else
2905a2c2c20Sdrh #  define UINT32_TYPE unsigned int
2915a2c2c20Sdrh # endif
292dda5b68cSmlcreech #endif
2935a2c2c20Sdrh #ifndef UINT16_TYPE
294dda5b68cSmlcreech # ifdef HAVE_UINT16_T
295dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
296dda5b68cSmlcreech # else
2975a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
2985a2c2c20Sdrh # endif
299dda5b68cSmlcreech #endif
300939a16d6Sdrh #ifndef INT16_TYPE
301dda5b68cSmlcreech # ifdef HAVE_INT16_T
302dda5b68cSmlcreech #  define INT16_TYPE int16_t
303dda5b68cSmlcreech # else
304939a16d6Sdrh #  define INT16_TYPE short int
305939a16d6Sdrh # endif
306dda5b68cSmlcreech #endif
3075a2c2c20Sdrh #ifndef UINT8_TYPE
308dda5b68cSmlcreech # ifdef HAVE_UINT8_T
309dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
310dda5b68cSmlcreech # else
3115a2c2c20Sdrh #  define UINT8_TYPE unsigned char
3125a2c2c20Sdrh # endif
313dda5b68cSmlcreech #endif
314905793e2Sdrh #ifndef INT8_TYPE
315dda5b68cSmlcreech # ifdef HAVE_INT8_T
316dda5b68cSmlcreech #  define INT8_TYPE int8_t
317dda5b68cSmlcreech # else
318905793e2Sdrh #  define INT8_TYPE signed char
319905793e2Sdrh # endif
320dda5b68cSmlcreech #endif
321efad9995Sdrh #ifndef LONGDOUBLE_TYPE
322efad9995Sdrh # define LONGDOUBLE_TYPE long double
323efad9995Sdrh #endif
324efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
32527436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
3265a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
3275a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
328939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
3295a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
330905793e2Sdrh typedef UINT8_TYPE i8;             /* 1-byte signed integer */
3315a2c2c20Sdrh 
3325a2c2c20Sdrh /*
333bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
334bbd42a6dSdrh ** evaluated at runtime.
335bbd42a6dSdrh */
33646c99e0fSdrh #ifdef SQLITE_AMALGAMATION
3377ff4a45eSmlcreech const int sqlite3one;
33846c99e0fSdrh #else
339bbd42a6dSdrh extern const int sqlite3one;
34046c99e0fSdrh #endif
34138def054Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)
34238def054Sdrh # define SQLITE_BIGENDIAN    0
34338def054Sdrh # define SQLITE_LITTLEENDIAN 1
34438def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
34538def054Sdrh #else
3469c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
3479c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
34838def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
34938def054Sdrh #endif
350bbd42a6dSdrh 
351bbd42a6dSdrh /*
35290f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
35390f5ecb3Sdrh ** callback for a given sqlite handle.
35490f5ecb3Sdrh **
35590f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
35690f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
35790f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
35890f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
35990f5ecb3Sdrh */
36090f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
36190f5ecb3Sdrh struct BusyHandler {
36290f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
36390f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
364a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
36590f5ecb3Sdrh };
36690f5ecb3Sdrh 
36790f5ecb3Sdrh /*
36875897234Sdrh ** Name of the master database table.  The master database table
36975897234Sdrh ** is a special table that holds the names and attributes of all
37075897234Sdrh ** user tables and indices.
37175897234Sdrh */
37275897234Sdrh #define MASTER_NAME       "sqlite_master"
373e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
37475897234Sdrh 
37575897234Sdrh /*
3768e150818Sdanielk1977 ** The root-page of the master database table.
3778e150818Sdanielk1977 */
3788e150818Sdanielk1977 #define MASTER_ROOT       1
3798e150818Sdanielk1977 
3808e150818Sdanielk1977 /*
381ed6c8671Sdrh ** The name of the schema table.
382ed6c8671Sdrh */
38353c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
384ed6c8671Sdrh 
385ed6c8671Sdrh /*
38675897234Sdrh ** A convenience macro that returns the number of elements in
38775897234Sdrh ** an array.
38875897234Sdrh */
38975897234Sdrh #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
39075897234Sdrh 
39175897234Sdrh /*
39275897234Sdrh ** Forward references to structures
39375897234Sdrh */
39413449892Sdrh typedef struct AggInfo AggInfo;
395fe05af87Sdrh typedef struct AuthContext AuthContext;
396f5e7bb51Sdrh typedef struct Bitvec Bitvec;
397fe05af87Sdrh typedef struct CollSeq CollSeq;
3987020f651Sdrh typedef struct Column Column;
399fe05af87Sdrh typedef struct Db Db;
400e501b89aSdanielk1977 typedef struct Schema Schema;
40175897234Sdrh typedef struct Expr Expr;
40275897234Sdrh typedef struct ExprList ExprList;
403c2eef3b3Sdrh typedef struct FKey FKey;
404fe05af87Sdrh typedef struct FuncDef FuncDef;
405fe05af87Sdrh typedef struct IdList IdList;
406fe05af87Sdrh typedef struct Index Index;
4078d059845Sdanielk1977 typedef struct KeyClass KeyClass;
408d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
409d1ab1ba5Sdanielk1977 typedef struct Module Module;
410626a879aSdrh typedef struct NameContext NameContext;
411fe05af87Sdrh typedef struct Parse Parse;
412fe05af87Sdrh typedef struct Select Select;
413fe05af87Sdrh typedef struct SrcList SrcList;
414ade86483Sdrh typedef struct StrAccum StrAccum;
415fe05af87Sdrh typedef struct Table Table;
416c00da105Sdanielk1977 typedef struct TableLock TableLock;
417fe05af87Sdrh typedef struct Token Token;
418fe05af87Sdrh typedef struct TriggerStack TriggerStack;
419fe05af87Sdrh typedef struct TriggerStep TriggerStep;
420fe05af87Sdrh typedef struct Trigger Trigger;
421fe05af87Sdrh typedef struct WhereInfo WhereInfo;
422fe05af87Sdrh typedef struct WhereLevel WhereLevel;
423d3d39e93Sdrh 
4242dca4ac1Sdanielk1977 /*
4252dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
4262dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
4272dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
4282dca4ac1Sdanielk1977 */
4292dca4ac1Sdanielk1977 #include "btree.h"
4302dca4ac1Sdanielk1977 #include "vdbe.h"
4312dca4ac1Sdanielk1977 #include "pager.h"
4322dca4ac1Sdanielk1977 
4331cc5ed81Sdanielk1977 #include "os.h"
434c7ce76afSdrh #include "mutex.h"
4351cc5ed81Sdanielk1977 
436eee4c8caSdrh 
437001bbcbbSdrh /*
438001bbcbbSdrh ** Each database file to be accessed by the system is an instance
439001bbcbbSdrh ** of the following structure.  There are normally two of these structures
440001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
441a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
442a69d9168Sdrh ** databases may be attached.
443001bbcbbSdrh */
444001bbcbbSdrh struct Db {
445001bbcbbSdrh   char *zName;         /* Name of this database */
446001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
447da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
448da184236Sdanielk1977   u8 safety_level;     /* How aggressive at synching data to disk */
449da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
450da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
451e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
452da184236Sdanielk1977 };
453da184236Sdanielk1977 
454da184236Sdanielk1977 /*
455da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
456a04a34ffSdanielk1977 **
457a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the
458a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table
459a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection
460a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been
461a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated,
462a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare
463a04a34ffSdanielk1977 ** statements.
464da184236Sdanielk1977 */
465e501b89aSdanielk1977 struct Schema {
466001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
467d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
468d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
469d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
470d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
4714794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
472da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
4738079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
474da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
47514db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
476a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
477a04a34ffSdanielk1977   sqlite3 *db;         /* "Owner" connection. See comment above */
478a04a34ffSdanielk1977 #endif
479001bbcbbSdrh };
48075897234Sdrh 
48175897234Sdrh /*
4828bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
4838bf8dc92Sdrh ** Db.flags field.
4848bf8dc92Sdrh */
485da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
486da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
487da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
488da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
4898bf8dc92Sdrh 
4908bf8dc92Sdrh /*
4918bf8dc92Sdrh ** Allowed values for the DB.flags field.
4928bf8dc92Sdrh **
4938bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
4948bf8dc92Sdrh ** read into internal hash tables.
4958bf8dc92Sdrh **
4968bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
4978bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
4988bf8dc92Sdrh ** changes and so the view will need to be reset.
4998bf8dc92Sdrh */
500124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
501124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
502b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
5038bf8dc92Sdrh 
504caa639f4Sdrh /*
505caa639f4Sdrh ** The number of different kinds of things that can be limited
506caa639f4Sdrh ** using the sqlite3_limit() interface.
507caa639f4Sdrh */
508caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
5098bf8dc92Sdrh 
5108bf8dc92Sdrh /*
511c9b84a1fSdrh ** Each database is an instance of the following structure.
512c9b84a1fSdrh **
513b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
514b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
515b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
516b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
517b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
518b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
519b0c374ffSrdc **
520b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
5216f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
522b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
523b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
524b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
525b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
526b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
527b0c374ffSrdc ** affect the value of lsChange.
528b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
529b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
5306622cce3Sdanielk1977 **
5316622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
5326622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
5336622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
5346622cce3Sdanielk1977 ** consistently.
53575897234Sdrh */
5369bb575fdSdrh struct sqlite3 {
53790f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
538001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
539001bbcbbSdrh   Db *aDb;                      /* All backends */
5408c82b350Sdrh   int flags;                    /* Miscellanous flags. See below */
54133f4e02aSdrh   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
542fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
5434ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
544fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
54590f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
54617435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
54798757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
548f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
5492803757aSdrh   int nTable;                   /* Number of tables in the database */
550d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
551f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
552f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
553247be43dSdrh   int magic;                    /* Magic number for detect library misuse */
554b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
555b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
556d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
557caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
5584adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
5591d85d931Sdrh     int iDb;                    /* When back is being initialized */
5601d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
5611d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
5621d85d931Sdrh   } init;
563f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
564761df87eSdrh   void **aExtension;            /* Array of shared libraray handles */
565326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
5661d850a72Sdanielk1977   int activeVdbeCnt;            /* Number of vdbes currently executing */
56718de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
56818de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
56919e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
57019e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
571fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
572fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
57371fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
57471fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
57594eb6a14Sdanielk1977   void *pUpdateArg;
57694eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
577fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
578fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
579fcd35c7bSdrh   void *pCollNeededArg;
580fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
581fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
582fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
583881feaa0Sdrh   union {
584881feaa0Sdrh     int isInterrupted;          /* True if sqlite3_interrupt has been called */
585881feaa0Sdrh     double notUsed1;            /* Spacer */
586881feaa0Sdrh   } u1;
587ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
588e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
589e22a334bSdrh                                 /* Access authorization function */
590ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
591ed6c8671Sdrh #endif
592348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
593348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
594348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
595348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
596348bb5d6Sdanielk1977 #endif
597b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
598b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
5997e6ebfb2Sdanielk1977   Table *pVTab;                 /* vtab with active Connect/Create method */
600f9e7dda7Sdanielk1977   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
601f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
6026b456a2bSdanielk1977 #endif
603fcd35c7bSdrh   Hash aFunc;                   /* All functions that can be in SQL exprs */
604fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
605fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
60697903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
607fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
6087e900abfSdanielk1977 #ifdef SQLITE_SSE
6097e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
6107e900abfSdanielk1977 #endif
61141483468Sdanielk1977   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
61275897234Sdrh };
61375897234Sdrh 
61403b808a6Sdrh /*
61503b808a6Sdrh ** A macro to discover the encoding of a database.
61603b808a6Sdrh */
61714db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
61814db2665Sdanielk1977 
61975897234Sdrh /*
6208bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
6218bf8dc92Sdrh **
6228bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
6238bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
6248bf8dc92Sdrh ** transaction is active on that particular database file.
62575897234Sdrh */
6264c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
627c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
6285e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
629382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
630fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
631fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
6321bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
6331bee3d7bSdrh                                           /*   the count using a callback. */
634fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
6356a535340Sdrh                                           /*   result set is empty */
63635d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
63735d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
638f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
6397bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
6407bec505eSdrh                                           ** accessing read-only databases */
6410cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
642da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
643e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
644ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
645c2e87a3eSdrh #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
64658b9576bSdrh 
64734c68fbaSdanielk1977 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
6484a50aac5Sdrh #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
6494a50aac5Sdrh #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
65034c68fbaSdanielk1977 
65158b9576bSdrh /*
652247be43dSdrh ** Possible values for the sqlite.magic field.
653247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
654247be43dSdrh ** than being distinct from one another.
655247be43dSdrh */
656247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
657247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
6587e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
659247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
660247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
661247be43dSdrh 
662247be43dSdrh /*
6630bce8354Sdrh ** Each SQL function is defined by an instance of the following
6640bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
6658e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
6668e0a2f90Sdrh ** points to a linked list of these structures.
6672803757aSdrh */
6680bce8354Sdrh struct FuncDef {
66955ef4d97Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
670d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
67155ef4d97Sdrh   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
67255ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
6731350b030Sdrh   void *pUserData;     /* User data parameter */
6740bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
675f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
676f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
677f9b596ebSdrh   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
67855ef4d97Sdrh   char zName[1];       /* SQL name of the function.  MUST BE LAST */
6798e0a2f90Sdrh };
6802803757aSdrh 
6812803757aSdrh /*
682d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
683d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
684d1ab1ba5Sdanielk1977 ** hash table.
685d1ab1ba5Sdanielk1977 */
686d1ab1ba5Sdanielk1977 struct Module {
687d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
688d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
689d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
690832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
691d1ab1ba5Sdanielk1977 };
692d1ab1ba5Sdanielk1977 
693d1ab1ba5Sdanielk1977 /*
69455ef4d97Sdrh ** Possible values for FuncDef.flags
69555ef4d97Sdrh */
696d64fe2f3Sdrh #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
697d64fe2f3Sdrh #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
698b7f6f68fSdrh #define SQLITE_FUNC_EPHEM  0x04  /* Ephermeral.  Delete with VDBE */
69955ef4d97Sdrh 
70055ef4d97Sdrh /*
701967e8b73Sdrh ** information about each column of an SQL table is held in an instance
7027020f651Sdrh ** of this structure.
7037020f651Sdrh */
7047020f651Sdrh struct Column {
7057020f651Sdrh   char *zName;     /* Name of this column */
7067977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
707382c0247Sdrh   char *zType;     /* Data type for this column */
708b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
7094a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
71078100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
711a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
712034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
713034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
714034ca14fSdanielk1977 #endif
7157020f651Sdrh };
7167020f651Sdrh 
7177020f651Sdrh /*
718a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
7190202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
7200202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
721a9fd84b0Sdrh **
7220202b29eSdanielk1977 ** There may two seperate implementations of the collation function, one
7230202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
7240202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
7250202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
7260202b29eSdanielk1977 ** the version that will require the least expensive encoding
727b3bf556eSdanielk1977 ** translations, if any.
7280202b29eSdanielk1977 **
7290202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
7300202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
7310202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
7320202b29eSdanielk1977 ** xCmp16.
7330202b29eSdanielk1977 **
7340202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
7350202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
7360202b29eSdanielk1977 ** collating sequence may not be read or written.
737a9fd84b0Sdrh */
738a9fd84b0Sdrh struct CollSeq {
7390202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
740466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
741d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
742a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
7430202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
744a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
745a9fd84b0Sdrh };
746a9fd84b0Sdrh 
747a9fd84b0Sdrh /*
748d64fe2f3Sdrh ** Allowed values of CollSeq flags:
749d64fe2f3Sdrh */
750d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
751d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
752d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
753d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
754d64fe2f3Sdrh 
755d64fe2f3Sdrh /*
756d3d39e93Sdrh ** A sort order can be either ASC or DESC.
7578e2ca029Sdrh */
7588e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
759d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
7608e2ca029Sdrh 
7618e2ca029Sdrh /*
762a37cdde0Sdanielk1977 ** Column affinity types.
7638a51256cSdrh **
7648a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
7658a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
7668a51256cSdrh ** the speed a little by number the values consecutively.
7678a51256cSdrh **
7688a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
7698a51256cSdrh ** when multiple affinity types are concatenated into a string and
77066a5167bSdrh ** used as the P4 operand, they will be more readable.
7718a51256cSdrh **
7728a51256cSdrh ** Note also that the numeric types are grouped together so that testing
7738a51256cSdrh ** for a numeric type is a single comparison.
774a37cdde0Sdanielk1977 */
7758a51256cSdrh #define SQLITE_AFF_TEXT     'a'
7768a51256cSdrh #define SQLITE_AFF_NONE     'b'
7778a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
7788a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
7798a51256cSdrh #define SQLITE_AFF_REAL     'e'
780a37cdde0Sdanielk1977 
7818a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
782a37cdde0Sdanielk1977 
783a37cdde0Sdanielk1977 /*
78435573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
78535573356Sdrh ** affinity value.
78635573356Sdrh */
78735573356Sdrh #define SQLITE_AFF_MASK     0x67
78835573356Sdrh 
78935573356Sdrh /*
79035573356Sdrh ** Additional bit values that can be ORed with an affinity without
79135573356Sdrh ** changing the affinity.
79235573356Sdrh */
79335573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
79435573356Sdrh #define SQLITE_NULLEQUAL    0x10  /* compare NULLs equal */
79535573356Sdrh #define SQLITE_STOREP2      0x80  /* Store result in reg[P2] rather than jump */
79635573356Sdrh 
79735573356Sdrh /*
79822f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
79922f70c32Sdrh ** following structure.
80022f70c32Sdrh **
801d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
80222f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
80322f70c32Sdrh ** comparisons.
80422f70c32Sdrh **
805d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
80622f70c32Sdrh ** pointer to an array of Column structures, one for each column.
80722f70c32Sdrh **
808d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
809d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
81022f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
81122f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
81222f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
813d24cc427Sdrh ** is generated for each row of the table.  Table.hasPrimKey is true if
81422f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
81522f70c32Sdrh **
816d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
817d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
818d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
819b9bb7c18Sdrh ** holds temporary tables and indices.  If Table.isEphem
82022f70c32Sdrh ** is true, then the table is stored in a file that is automatically deleted
821d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
82222f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
82322f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
82422f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
82522f70c32Sdrh ** of a SELECT statement.
82675897234Sdrh */
82775897234Sdrh struct Table {
82875897234Sdrh   char *zName;     /* Name of the table */
82975897234Sdrh   int nCol;        /* Number of columns in this table */
8307020f651Sdrh   Column *aCol;    /* Information about each column */
831c8392586Sdrh   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
832967e8b73Sdrh   Index *pIndex;   /* List of SQL indexes on this table. */
83322f70c32Sdrh   int tnum;        /* Root BTree node for this table (see note above) */
834a76b5dfcSdrh   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
835ed8a3bb1Sdrh   int nRef;          /* Number of pointers to this Table */
836c3f9bad2Sdanielk1977   Trigger *pTrigger; /* List of SQL triggers on this table */
837c2eef3b3Sdrh   FKey *pFKey;       /* Linked list of all foreign keys in this table */
8383d1bfeaaSdanielk1977   char *zColAff;     /* String defining the affinity of each column */
839ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
840ffe07b2dSdrh   Expr *pCheck;      /* The AND of all CHECK constraints */
841ffe07b2dSdrh #endif
84219a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
84319a8e7e8Sdanielk1977   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
84419a8e7e8Sdanielk1977 #endif
8451914619aSdrh   u8 readOnly;     /* True if this table should not be written by the user */
8461914619aSdrh   u8 isEphem;      /* True if created using OP_OpenEphermeral */
8471914619aSdrh   u8 hasPrimKey;   /* True if there exists a primary key */
8481914619aSdrh   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
8491914619aSdrh   u8 autoInc;      /* True if the integer primary key is autoincrement */
850e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
8511914619aSdrh   u8 isVirtual;             /* True if this is a virtual table */
8521914619aSdrh   u8 isCommit;              /* True once the CREATE TABLE has been committed */
853d1ab1ba5Sdanielk1977   Module *pMod;             /* Pointer to the implementation of the module */
854b9bb7c18Sdrh   sqlite3_vtab *pVtab;      /* Pointer to the module instance */
855b9bb7c18Sdrh   int nModuleArg;           /* Number of arguments to the module */
856b9bb7c18Sdrh   char **azModuleArg;       /* Text of all module args. [0] is module name */
857e09daa90Sdrh #endif
858728b5779Sdrh   Schema *pSchema;          /* Schema that contains this table */
85975897234Sdrh };
86075897234Sdrh 
86175897234Sdrh /*
8624cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
8634cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
8644cbdda9eSdrh ** table support is omitted from the build.
8654cbdda9eSdrh */
8664cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
8674cbdda9eSdrh #  define IsVirtual(X)      ((X)->isVirtual)
868034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
8694cbdda9eSdrh #else
8704cbdda9eSdrh #  define IsVirtual(X)      0
871034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
8724cbdda9eSdrh #endif
8734cbdda9eSdrh 
8744cbdda9eSdrh /*
875c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
876c2eef3b3Sdrh **
877c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
878c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
879c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
880c2eef3b3Sdrh ** Consider this example:
881c2eef3b3Sdrh **
882c2eef3b3Sdrh **     CREATE TABLE ex1(
883c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
884c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
885c2eef3b3Sdrh **     );
886c2eef3b3Sdrh **
887c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
888c2eef3b3Sdrh **
889c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
890c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
891c2eef3b3Sdrh ** the from-table is created.  The existance of the to-table is not checked
892c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
893c2eef3b3Sdrh **
894ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
895c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
896c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
897c2eef3b3Sdrh ** field.
898c2eef3b3Sdrh */
899c2eef3b3Sdrh struct FKey {
900c2eef3b3Sdrh   Table *pFrom;     /* The table that constains the REFERENCES clause */
901c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
902c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
903c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
904c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
905c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
906c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
907c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
908c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
909c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
910c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
911c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
912c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
913c2eef3b3Sdrh };
914c2eef3b3Sdrh 
915c2eef3b3Sdrh /*
916aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
91722f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
9180bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
9191c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
9201c92853dSdrh ** fails and any prior changes from that one operation are backed out,
9211c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
9221c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
9231c92853dSdrh ** changes due to the same operation are not backed out and no rollback
9241c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
9251c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
9261c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
9271c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
9281c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
9291c92853dSdrh **
930c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
931c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
932c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
933c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
934c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
935c2eef3b3Sdrh ** foreign key.
936c2eef3b3Sdrh **
937968af52aSdrh ** The following symbolic values are used to record which type
9381c92853dSdrh ** of action to take.
9399cfcf5d4Sdrh */
9409cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
9411c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
9421c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
9431c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
9441c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
9451c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
946c2eef3b3Sdrh 
947c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
948c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
949c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
950c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
951c2eef3b3Sdrh 
952c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
9539cfcf5d4Sdrh 
954d3d39e93Sdrh 
955d3d39e93Sdrh /*
956d3d39e93Sdrh ** An instance of the following structure is passed as the first
957d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
958d3d39e93Sdrh ** comparison of the two index keys.
959d3d39e93Sdrh **
960d3d39e93Sdrh ** If the KeyInfo.incrKey value is true and the comparison would
9617e62779aSdrh ** otherwise be equal, then return a result as if the second key
9627e62779aSdrh ** were larger.
963d3d39e93Sdrh */
964d3d39e93Sdrh struct KeyInfo {
965b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
966b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
967d3d39e93Sdrh   u8 incrKey;         /* Increase 2nd key by epsilon before comparison */
9689a96b668Sdanielk1977   u8 prefixIsEqual;   /* Treat a prefix as equal */
969d3d39e93Sdrh   int nField;         /* Number of entries in aColl[] */
970d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
971d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
972d3d39e93Sdrh };
973d3d39e93Sdrh 
9749cfcf5d4Sdrh /*
97566b89c8fSdrh ** Each SQL index is represented in memory by an
97675897234Sdrh ** instance of the following structure.
977967e8b73Sdrh **
978967e8b73Sdrh ** The columns of the table that are to be indexed are described
979967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
980967e8b73Sdrh ** we have the following table and index:
981967e8b73Sdrh **
982967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
983967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
984967e8b73Sdrh **
985967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
986967e8b73Sdrh ** three columns in the table.  In the Index structure describing
987967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
988967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
989967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
990967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
991967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
992ea1ba17cSdrh **
993ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
994ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
995ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
996ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
997ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
998ea1ba17cSdrh ** element.
99975897234Sdrh */
100075897234Sdrh struct Index {
100175897234Sdrh   char *zName;     /* Name of this index */
1002967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1003967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
10048b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1005967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1006be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
10079cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1008485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1009a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
101075897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1011b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1012b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1013b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
101475897234Sdrh };
101575897234Sdrh 
101675897234Sdrh /*
101775897234Sdrh ** Each token coming out of the lexer is an instance of
10184b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
10194efc4754Sdrh **
10204efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
10214efc4754Sdrh ** may contain random values.  Do not make any assuptions about Token.dyn
10224efc4754Sdrh ** and Token.n when Token.z==0.
102375897234Sdrh */
102475897234Sdrh struct Token {
10254c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
10264b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
10276977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
102875897234Sdrh };
102975897234Sdrh 
103075897234Sdrh /*
103113449892Sdrh ** An instance of this structure contains information needed to generate
103213449892Sdrh ** code for a SELECT that contains aggregate functions.
103313449892Sdrh **
103413449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
103513449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
103613449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
103713449892Sdrh ** code for that node.
103813449892Sdrh **
103913449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
104013449892Sdrh ** original Select structure that describes the SELECT statement.  These
104113449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
104213449892Sdrh */
104313449892Sdrh struct AggInfo {
104413449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
104513449892Sdrh                           ** from source tables rather than from accumulators */
104613449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
104713449892Sdrh                           ** than the source table */
104813449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
104913449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
105013449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
105113449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
10520817d0dfSdanielk1977     Table *pTab;             /* Source table */
105313449892Sdrh     int iTable;              /* Cursor number of the source table */
105413449892Sdrh     int iColumn;             /* Column number within the source table */
105513449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
105613449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
10575774b806Sdrh     Expr *pExpr;             /* The original expression */
105813449892Sdrh   } *aCol;
105913449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
106013449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
106113449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
106213449892Sdrh                           ** Additional columns are used only as parameters to
106313449892Sdrh                           ** aggregate functions */
106413449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
106513449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
106613449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
106713449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1068b9bb7c18Sdrh     int iDistinct;           /* Ephermeral table used to enforce DISTINCT */
106913449892Sdrh   } *aFunc;
107013449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
107113449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
107213449892Sdrh };
107313449892Sdrh 
107413449892Sdrh /*
107575897234Sdrh ** Each node of an expression in the parse tree is an instance
107622f70c32Sdrh ** of this structure.
107722f70c32Sdrh **
107822f70c32Sdrh ** Expr.op is the opcode.  The integer parser token codes are reused
107922f70c32Sdrh ** as opcodes here.  For example, the parser defines TK_GE to be an integer
108022f70c32Sdrh ** code representing the ">=" operator.  This same integer code is reused
108122f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
108222f70c32Sdrh ** tree.
108322f70c32Sdrh **
108422f70c32Sdrh ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
108522f70c32Sdrh ** of argument if the expression is a function.
108622f70c32Sdrh **
10874b59ab5eSdrh ** Expr.token is the operator token for this node.  For some expressions
10884b59ab5eSdrh ** that have subexpressions, Expr.token can be the complete text that gave
10894b59ab5eSdrh ** rise to the Expr.  In the latter case, the token is marked as being
10904b59ab5eSdrh ** a compound token.
109122f70c32Sdrh **
109222f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
109322f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
109422f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
109522f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
109622f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
109722f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
109822f70c32Sdrh ** it can be accessed after all aggregates are computed.
109922f70c32Sdrh **
110022f70c32Sdrh ** If the expression is a function, the Expr.iTable is an integer code
11017c972decSdrh ** representing which function.  If the expression is an unbound variable
11027c972decSdrh ** marker (a question mark character '?' in the original SQL) then the
11037c972decSdrh ** Expr.iTable holds the index number for that variable.
110422f70c32Sdrh **
11051398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
11061398ad36Sdrh ** register number containing the result of the subquery.  If the
11071398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
11081398ad36Sdrh ** gives a different answer at different times during statement processing
11091398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
11101398ad36Sdrh **
111122f70c32Sdrh ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
111222f70c32Sdrh ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
111322f70c32Sdrh ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
111422f70c32Sdrh ** operand.
1115aee18ef8Sdanielk1977 **
1116aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1117aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1118aee18ef8Sdanielk1977 ** corresponding table definition.
111975897234Sdrh */
112075897234Sdrh struct Expr {
11211cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1122a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
11236a03a1c5Sdrh   u16 flags;             /* Various flags.  See below */
1124f2bc013cSdrh   CollSeq *pColl;        /* The collation type of the column or 0 */
112575897234Sdrh   Expr *pLeft, *pRight;  /* Left and right subnodes */
1126d99f7068Sdrh   ExprList *pList;       /* A list of expressions used as function arguments
1127d99f7068Sdrh                          ** or in "<expr> IN (<expr-list)" */
112875897234Sdrh   Token token;           /* An operand token */
11296977fea8Sdrh   Token span;            /* Complete text of the expression */
1130967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
11318e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
113213449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
113313449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
113422d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1135d99f7068Sdrh   Select *pSelect;       /* When the expression is a sub-select.  Also the
1136d99f7068Sdrh                          ** right side of "<expr> IN (<select>)" */
1137aee18ef8Sdanielk1977   Table *pTab;           /* Table for OP_Column expressions. */
1138728b5779Sdrh /*  Schema *pSchema; */
1139e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1140fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1141fc976065Sdanielk1977 #endif
114275897234Sdrh };
114375897234Sdrh 
114475897234Sdrh /*
11451f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
11461f16230bSdrh */
1147678ccce8Sdrh #define EP_FromJoin   0x0001  /* Originated in ON or USING clause of a join */
1148678ccce8Sdrh #define EP_Agg        0x0002  /* Contains one or more aggregate functions */
1149678ccce8Sdrh #define EP_Resolved   0x0004  /* IDs have been resolved to COLUMNs */
1150678ccce8Sdrh #define EP_Error      0x0008  /* Expression contains one or more errors */
1151678ccce8Sdrh #define EP_Distinct   0x0010  /* Aggregate function with DISTINCT keyword */
1152678ccce8Sdrh #define EP_VarSelect  0x0020  /* pSelect is correlated, not constant */
1153678ccce8Sdrh #define EP_Dequoted   0x0040  /* True if the string has been dequoted */
1154678ccce8Sdrh #define EP_InfixFunc  0x0080  /* True for an infix function: LIKE, GLOB, etc */
1155678ccce8Sdrh #define EP_ExpCollate 0x0100  /* Collating sequence specified explicitly */
1156da250ea5Sdrh #define EP_AnyAff     0x0200  /* Can take a cached column of any affinity */
11571f16230bSdrh 
11581f16230bSdrh /*
11591f16230bSdrh ** These macros can be used to test, set, or clear bits in the
11601f16230bSdrh ** Expr.flags field.
11611f16230bSdrh */
11621f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
11631f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
11641f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
11651f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
11661f16230bSdrh 
11671f16230bSdrh /*
116875897234Sdrh ** A list of expressions.  Each expression may optionally have a
116975897234Sdrh ** name.  An expr/name combination can be used in several ways, such
117075897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
117175897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1172ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
117375897234Sdrh ** field is not used.
117475897234Sdrh */
117575897234Sdrh struct ExprList {
117675897234Sdrh   int nExpr;             /* Number of expressions on the list */
11774305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
11789d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
11796d4abfbeSdrh   struct ExprList_item {
118075897234Sdrh     Expr *pExpr;           /* The list of expressions */
118175897234Sdrh     char *zName;           /* Token associated with this expression */
11828e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
11838e2ca029Sdrh     u8 isAgg;              /* True if this is an aggregate like count(*) */
11848e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
118575897234Sdrh   } *a;                  /* One entry for each expression */
118675897234Sdrh };
118775897234Sdrh 
118875897234Sdrh /*
1189ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1190ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1191ad3cab52Sdrh **
1192ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1193ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1194ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1195ad3cab52Sdrh **
1196ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1197ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1198ad3cab52Sdrh **
1199ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1200ad3cab52Sdrh **
1201ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
120275897234Sdrh */
120375897234Sdrh struct IdList {
12046d4abfbeSdrh   struct IdList_item {
1205ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1206967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1207ad3cab52Sdrh   } *a;
120813449892Sdrh   int nId;         /* Number of identifiers on the list */
120913449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1210ad3cab52Sdrh };
1211ad3cab52Sdrh 
1212ad3cab52Sdrh /*
121351669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1214ca83ac51Sdrh **
1215ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1216ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1217ca83ac51Sdrh ** of the library by 738 bytes on ix86.
121851669863Sdrh */
1219ca83ac51Sdrh typedef u64 Bitmask;
122051669863Sdrh 
122151669863Sdrh /*
1222ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1223ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1224ad3cab52Sdrh ** the SrcList.a[] array.
1225d24cc427Sdrh **
1226d24cc427Sdrh ** With the addition of multiple database support, the following structure
1227d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1228d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1229d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1230d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1231c49de5d9Sdrh **
1232c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1233c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1234c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1235c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
1236ad3cab52Sdrh */
1237ad3cab52Sdrh struct SrcList {
1238939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1239939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1240ad3cab52Sdrh   struct SrcList_item {
1241113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1242ad3cab52Sdrh     char *zName;      /* Name of the table */
1243ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1244daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1245daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
12461787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1247c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1248e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1249ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1250ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
125151669863Sdrh     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1252113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
125375897234Sdrh };
125475897234Sdrh 
125575897234Sdrh /*
125601f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
125701f3f253Sdrh */
125801f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
12593dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
12603dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
12613dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
12623dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
12633dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
12643dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
126501f3f253Sdrh 
126601f3f253Sdrh /*
12676b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
12686b56344dSdrh ** structure contains a single instance of this structure.  This structure
12696b56344dSdrh ** is intended to be private the the where.c module and should not be
12706b56344dSdrh ** access or modified by other modules.
12716d209d8bSdrh **
12726d209d8bSdrh ** The pIdxInfo and pBestIdx fields are used to help pick the best
12736d209d8bSdrh ** index on a virtual table.  The pIdxInfo pointer contains indexing
12746d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
12756d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
12766d209d8bSdrh ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
12776d209d8bSdrh ** FROM clause ordering.  This is a little confusing so I will repeat
12786d209d8bSdrh ** it in different words.  WhereInfo.a[i].pIdxInfo is index information
12796d209d8bSdrh ** for WhereInfo.pTabList.a[i].  WhereInfo.a[i].pBestInfo is the
12806d209d8bSdrh ** index information for the i-th loop of the join.  pBestInfo is always
12816d209d8bSdrh ** either NULL or a copy of some pIdxInfo.  So for cleanup it is
12826d209d8bSdrh ** sufficient to free all of the pIdxInfo pointers.
12836d209d8bSdrh **
12846b56344dSdrh */
12856b56344dSdrh struct WhereLevel {
128629dda4aeSdrh   int iFrom;            /* Which entry in the FROM clause */
128729dda4aeSdrh   int flags;            /* Flags associated with this level */
128851147baaSdrh   int iMem;             /* First memory cell used by this level */
128929dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
12909012bcbcSdrh   Index *pIdx;          /* Index used.  NULL if no index */
12919012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
12929012bcbcSdrh   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
12936b56344dSdrh   int brk;              /* Jump here to break out of the loop */
129472e8fa42Sdrh   int nxt;              /* Jump here to start the next IN combination */
12956b56344dSdrh   int cont;             /* Jump here to continue with the next loop cycle */
1296ad2d8307Sdrh   int top;              /* First instruction of interior of the loop */
129729dda4aeSdrh   int op, p1, p2;       /* Opcode used to terminate the loop */
129851147baaSdrh   int nEq;              /* Number of == or IN constraints on this loop */
1299e23399fcSdrh   int nIn;              /* Number of IN operators constraining this loop */
130072e8fa42Sdrh   struct InLoop {
130172e8fa42Sdrh     int iCur;              /* The VDBE cursor used by this IN operator */
130272e8fa42Sdrh     int topAddr;           /* Top of the IN loop */
130372e8fa42Sdrh   } *aInLoop;           /* Information about each nested IN operator */
13046d209d8bSdrh   sqlite3_index_info *pBestIdx;  /* Index information for this level */
13056d209d8bSdrh 
13066d209d8bSdrh   /* The following field is really not part of the current level.  But
13076d209d8bSdrh   ** we need a place to cache index information for each table in the
13086d209d8bSdrh   ** FROM clause and the WhereLevel structure is a convenient place.
13096d209d8bSdrh   */
13106d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
13116b56344dSdrh };
13126b56344dSdrh 
1313a9d1ccb9Sdanielk1977 #define ORDERBY_NORMAL 0
1314a9d1ccb9Sdanielk1977 #define ORDERBY_MIN    1
1315a9d1ccb9Sdanielk1977 #define ORDERBY_MAX    2
1316a9d1ccb9Sdanielk1977 
13176b56344dSdrh /*
131875897234Sdrh ** The WHERE clause processing routine has two halves.  The
131975897234Sdrh ** first part does the start of the WHERE loop and the second
132075897234Sdrh ** half does the tail of the WHERE loop.  An instance of
132175897234Sdrh ** this structure is returned by the first half and passed
132275897234Sdrh ** into the second half to give some continuity.
132375897234Sdrh */
132475897234Sdrh struct WhereInfo {
132575897234Sdrh   Parse *pParse;
1326ad3cab52Sdrh   SrcList *pTabList;   /* List of tables in the join */
13279012bcbcSdrh   int iTop;            /* The very beginning of the WHERE loop */
132819a775c2Sdrh   int iContinue;       /* Jump here to continue with next record */
132919a775c2Sdrh   int iBreak;          /* Jump here to break out of the loop */
13306b56344dSdrh   int nLevel;          /* Number of nested loop */
13316d209d8bSdrh   sqlite3_index_info **apInfo;  /* Array of pointers to index info structures */
13326b56344dSdrh   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
133375897234Sdrh };
133475897234Sdrh 
133575897234Sdrh /*
1336b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1337b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1338b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1339b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1340b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1341b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1342b3bce662Sdanielk1977 ** other statements.
1343b3bce662Sdanielk1977 **
1344b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1345b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1346b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1347b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1348b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1349b3bce662Sdanielk1977 ** the context containing the match is incremented.
1350b3bce662Sdanielk1977 **
1351b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1352b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1353b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1354b3bce662Sdanielk1977 ** subqueries looking for a match.
1355b3bce662Sdanielk1977 */
1356b3bce662Sdanielk1977 struct NameContext {
1357b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1358b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1359b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1360b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1361b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1362b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
136313449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
136406f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1365b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
136613449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1367b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1368b3bce662Sdanielk1977 };
1369b3bce662Sdanielk1977 
1370b3bce662Sdanielk1977 /*
13719bb61fe7Sdrh ** An instance of the following structure contains all information
13729bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1373a76b5dfcSdrh **
1374d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1375d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1376d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1377d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1378d11d382cSdrh ** in the VDBE that record the limit and offset counters.
13790342b1f5Sdrh **
1380b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
13810342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
138266a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
13830342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
1384b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
13850342b1f5Sdrh ** enough information about the compound query is known at that point.
1386b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1387b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
13880342b1f5Sdrh ** sequences for the ORDER BY clause.
13899bb61fe7Sdrh */
13909bb61fe7Sdrh struct Select {
13919bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
13927b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
13937b58daeaSdrh   u8 isDistinct;         /* True if the DISTINCT keyword is present */
13940342b1f5Sdrh   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
13950342b1f5Sdrh   u8 isAgg;              /* True if this is an aggregate query */
1396b9bb7c18Sdrh   u8 usesEphm;           /* True if uses an OpenEphemeral opcode */
13974b14b4d7Sdrh   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
13986c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
1399ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
14009bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
14019bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
14029bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
14039bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1404967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
14051e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
14060342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1407a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1408a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
14097b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1410b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
14119bb61fe7Sdrh };
14129bb61fe7Sdrh 
14139bb61fe7Sdrh /*
1414fef5208cSdrh ** The results of a select can be distributed in several ways.
1415fef5208cSdrh */
141613449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
141713449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
14189ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
14199ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
1420fef5208cSdrh 
142113449892Sdrh /* The ORDER BY clause is ignored for all of the above */
14226c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
142313449892Sdrh 
14249ed1dfa8Sdanielk1977 #define SRT_Callback     5  /* Invoke a callback with each row of result */
14259ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
14269ed1dfa8Sdanielk1977 #define SRT_Set          7  /* Store non-null results as keys in an index */
14279ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
14289ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
14299ed1dfa8Sdanielk1977 #define SRT_Subroutine  10  /* Call a subroutine to handle results */
14302282792aSdrh 
14312282792aSdrh /*
14326c8c8ce0Sdanielk1977 ** A structure used to customize the behaviour of sqlite3Select(). See
14336c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
14346c8c8ce0Sdanielk1977 */
14356c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
14366c8c8ce0Sdanielk1977 struct SelectDest {
1437477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
1438477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
14396c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
14401013c932Sdrh   int iMem;         /* Base register where results are written */
1441ad27e761Sdrh   int nMem;         /* Number of registers allocated */
14426c8c8ce0Sdanielk1977 };
14436c8c8ce0Sdanielk1977 
14446c8c8ce0Sdanielk1977 /*
1445f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1446f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1447f57b3399Sdrh ** carry around information that is global to the entire parse.
1448f1974846Sdrh **
1449f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1450f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1451f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1452f1974846Sdrh ** each recursion.
1453c00da105Sdanielk1977 **
1454c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1455c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1456c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1457c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1458c00da105Sdanielk1977 ** list.
145975897234Sdrh */
146075897234Sdrh struct Parse {
14619bb575fdSdrh   sqlite3 *db;         /* The main database structure */
14624c504391Sdrh   int rc;              /* Return code from execution */
146375897234Sdrh   char *zErrMsg;       /* An error message */
146475897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1465836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1466e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1467a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1468205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
14697e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1470892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
14712dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
1472892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
1473892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
1474892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
147575897234Sdrh   int nErr;            /* Number of errors seen */
1476832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
147719a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1478fef5208cSdrh   int nSet;            /* Number of sets used so far */
1479aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
1480e55cbd72Sdrh   int disableColCache; /* True to disable adding to column cache */
1481e55cbd72Sdrh   int nColCache;       /* Number of entries in the column cache */
1482e55cbd72Sdrh   int iColCache;       /* Next entry of the cache to replace */
14832f7794c1Sdrh   struct yColCache {
1484e55cbd72Sdrh     int iTable;           /* Table cursor number */
1485e55cbd72Sdrh     int iColumn;          /* Table column number */
1486da250ea5Sdrh     char affChange;       /* True if this register has had an affinity change */
1487e55cbd72Sdrh     int iReg;             /* Register holding value of this column */
1488e55cbd72Sdrh   } aColCache[10];     /* One for each valid column cache entry */
148980242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1490fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1491fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1492c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1493c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1494c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1495c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1496c00da105Sdanielk1977 #endif
1497cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
1498cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
1499f1974846Sdrh 
1500f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1501f1974846Sdrh   ** each recursion */
1502f1974846Sdrh 
1503f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1504f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1505f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1506f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1507f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1508f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1509f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1510f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1511f1974846Sdrh   const char *zSql;    /* All SQL text */
1512f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1513f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1514f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1515f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1516f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1517b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
151833b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
15197e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
1520f9e7dda7Sdanielk1977   Table *pVirtualLock;       /* Require virtual table lock on this table */
1521b9bb7c18Sdrh #endif
1522e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1523fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
1524fc976065Sdanielk1977 #endif
152575897234Sdrh };
152675897234Sdrh 
15277e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
15287e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
15297e6ebfb2Sdanielk1977 #else
15307e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
15317e6ebfb2Sdanielk1977 #endif
15327e6ebfb2Sdanielk1977 
1533d99bc930Sdanielk1977 /*
153485e2096fSdrh ** An instance of the following structure can be declared on a stack and used
153585e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
153685e2096fSdrh */
153785e2096fSdrh struct AuthContext {
153885e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
153985e2096fSdrh   Parse *pParse;              /* The Parse structure */
154085e2096fSdrh };
154185e2096fSdrh 
154285e2096fSdrh /*
1543f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1544b0c374ffSrdc */
1545b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1546b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
154794eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1548e4d90813Sdrh #define OPFLAG_APPEND    8    /* This is likely to be an append */
1549b0c374ffSrdc 
1550b0c374ffSrdc /*
1551d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1552d99bc930Sdanielk1977  * struct Trigger.
1553d99bc930Sdanielk1977  *
1554d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
15559bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1556d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1557d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1558ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1559ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1560ad3cab52Sdrh  *    struct Table.
1561d99bc930Sdanielk1977  *
1562ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1563ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1564d99bc930Sdanielk1977  */
1565d99bc930Sdanielk1977 struct Trigger {
1566d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1567d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1568f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1569dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1570d99bc930Sdanielk1977   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1571d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1572d99bc930Sdanielk1977                              the <column-list> is stored here */
15734312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1574e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1575e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1576d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1577d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1578c3f9bad2Sdanielk1977 };
1579d99bc930Sdanielk1977 
1580d99bc930Sdanielk1977 /*
1581dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1582dca76841Sdrh ** determine which.
1583dca76841Sdrh **
1584dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1585dca76841Sdrh ** In that cases, the constants below can be ORed together.
1586dca76841Sdrh */
1587dca76841Sdrh #define TRIGGER_BEFORE  1
1588dca76841Sdrh #define TRIGGER_AFTER   2
1589dca76841Sdrh 
1590dca76841Sdrh /*
1591d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
1592d99bc930Sdanielk1977  * that is a part of a trigger-program.
1593d99bc930Sdanielk1977  *
1594d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
1595d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
1596d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
1597d99bc930Sdanielk1977  * the first step of the trigger-program.
1598d99bc930Sdanielk1977  *
1599d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1600d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
1601d99bc930Sdanielk1977  * value of "op" as follows:
1602d99bc930Sdanielk1977  *
1603d99bc930Sdanielk1977  * (op == TK_INSERT)
1604d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
1605d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1606d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1607d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
1608d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1609d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
1610d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1611ad3cab52Sdrh  *              statement, then this stores the column-names to be
1612ad3cab52Sdrh  *              inserted into.
1613d99bc930Sdanielk1977  *
1614d99bc930Sdanielk1977  * (op == TK_DELETE)
1615d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
1616d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1617d99bc930Sdanielk1977  *              Otherwise NULL.
1618d99bc930Sdanielk1977  *
1619d99bc930Sdanielk1977  * (op == TK_UPDATE)
1620d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
1621d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1622d99bc930Sdanielk1977  *              Otherwise NULL.
1623d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
16244adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
1625ad3cab52Sdrh  *              argument.
1626d99bc930Sdanielk1977  *
1627d99bc930Sdanielk1977  */
1628c3f9bad2Sdanielk1977 struct TriggerStep {
1629c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1630d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
1631a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
1632c3f9bad2Sdanielk1977 
1633c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
1634c3f9bad2Sdanielk1977                           INSERT steps (when pExprList == 0) */
1635c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1636c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1637c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1638c3f9bad2Sdanielk1977                            INSERT steps (when pSelect == 0)         */
1639c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
1640c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
1641187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1642c3f9bad2Sdanielk1977 };
1643c3f9bad2Sdanielk1977 
1644d99bc930Sdanielk1977 /*
1645d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
1646d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
1647d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
1648d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
1649d99bc930Sdanielk1977  *
1650d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
1651d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
1652d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
1653d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1654d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1655d99bc930Sdanielk1977  *
1656d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
1657d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1658d99bc930Sdanielk1977  * specified for individual triggers steps is used.
1659d99bc930Sdanielk1977  *
1660d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1661d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
1662d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1663d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
1664d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
1665d99bc930Sdanielk1977  * trigger continues.
1666d99bc930Sdanielk1977  *
1667d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
1668d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1669d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
1670d99bc930Sdanielk1977  */
1671d99bc930Sdanielk1977 struct TriggerStack {
1672d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
1673d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1674d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
16758f2c54e6Sdanielk1977   u32 newColMask;
16768f2c54e6Sdanielk1977   u32 oldColMask;
1677d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
16786f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1679e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
1680e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1681c3f9bad2Sdanielk1977 };
1682c3f9bad2Sdanielk1977 
1683d99bc930Sdanielk1977 /*
1684f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
1685f26e09c8Sdrh ** routines as they walk the parse tree to make database references
1686f26e09c8Sdrh ** explicit.
1687f26e09c8Sdrh */
1688f26e09c8Sdrh typedef struct DbFixer DbFixer;
1689f26e09c8Sdrh struct DbFixer {
1690f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
1691f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
1692f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
1693f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
1694f26e09c8Sdrh };
1695f26e09c8Sdrh 
1696f26e09c8Sdrh /*
1697ade86483Sdrh ** An objected used to accumulate the text of a string where we
1698ade86483Sdrh ** do not necessarily know how big the string will be in the end.
1699ade86483Sdrh */
1700ade86483Sdrh struct StrAccum {
1701ade86483Sdrh   char *zBase;     /* A base allocation.  Not from malloc. */
1702ade86483Sdrh   char *zText;     /* The string collected so far */
1703ade86483Sdrh   int  nChar;      /* Length of the string so far */
1704ade86483Sdrh   int  nAlloc;     /* Amount of space allocated in zText */
1705bb4957f8Sdrh   int  mxAlloc;        /* Maximum allowed string length */
1706ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
1707ade86483Sdrh   u8   useMalloc;      /* True if zText is enlargable using realloc */
1708ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
1709ade86483Sdrh };
1710ade86483Sdrh 
1711ade86483Sdrh /*
1712234c39dfSdrh ** A pointer to this structure is used to communicate information
1713234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1714234c39dfSdrh */
1715234c39dfSdrh typedef struct {
17169bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
1717ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
1718234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
171915ca1df1Sdrh   int rc;             /* Result code stored here */
1720234c39dfSdrh } InitData;
1721234c39dfSdrh 
1722b6c29897Sdrh /*
172366150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
172466150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
17254a919118Sdrh */
17264a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
17274a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
17284a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
17294a919118Sdrh   }                                                    \
17304a919118Sdrh }
17314a919118Sdrh 
17324a919118Sdrh /*
173349285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
173449285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
173549285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
173649285708Sdrh ** corruption is first detected.
173749285708Sdrh */
173849285708Sdrh #ifdef SQLITE_DEBUG
17396e736838Sdrh   int sqlite3Corrupt(void);
174049285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1741e5fe690dSdrh # define DEBUGONLY(X)        X
174249285708Sdrh #else
174349285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1744e5fe690dSdrh # define DEBUGONLY(X)
174549285708Sdrh #endif
174649285708Sdrh 
174749285708Sdrh /*
174875897234Sdrh ** Internal function prototypes
174975897234Sdrh */
17504adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
17514adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
17528a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
17532e588c75Sdanielk1977 
175417435752Sdrh void *sqlite3MallocZero(unsigned);
175517435752Sdrh void *sqlite3DbMallocZero(sqlite3*, unsigned);
175617435752Sdrh void *sqlite3DbMallocRaw(sqlite3*, unsigned);
1757bdb4383aSdrh char *sqlite3StrDup(const char*);
1758bdb4383aSdrh char *sqlite3StrNDup(const char*, int);
175917435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
176017435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
176197c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
1762a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
1763a7a8e14bSdanielk1977 int sqlite3MallocSize(void *);
17642e588c75Sdanielk1977 
176517435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
176617435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
176787cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1768e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
1769d919fe17Sdrh #endif
1770d919fe17Sdrh #if defined(SQLITE_TEST)
1771fe63d1c9Sdrh   void *sqlite3TextToPtr(const char*);
177287cc3b31Sdrh #endif
177341f5852eSdrh void sqlite3SetString(char **, ...);
17744adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
1775a073384fSdrh void sqlite3ErrorClear(Parse*);
17764adee20fSdanielk1977 void sqlite3Dequote(char*);
177717435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*);
17782646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
17794adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
178080242055Sdrh void sqlite3FinishCoding(Parse*);
1781892d3179Sdrh int sqlite3GetTempReg(Parse*);
1782892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
1783892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
1784892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
1785a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
178617435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
17874e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
17881e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
17894adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
179017435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
1791fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
17924adee20fSdanielk1977 void sqlite3ExprDelete(Expr*);
179317435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
17944adee20fSdanielk1977 void sqlite3ExprListDelete(ExprList*);
17959bb575fdSdrh int sqlite3Init(sqlite3*, char**);
1796234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
179791cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
17989bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
17994adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
18009bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
18014adee20fSdanielk1977 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1802c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
1803f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
18044adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
18054adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
1806fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1807ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
1808487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
18097977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
181039002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
181119a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1812b7f9164eSdrh 
1813f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
1814f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
1815f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
1816f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32);
1817f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
18183088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
1819f5e7bb51Sdrh 
1820fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
1821fe3fcbe2Sdanielk1977 
1822fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
18234adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
1824b7f9164eSdrh #else
1825b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
1826b7f9164eSdrh #endif
1827b7f9164eSdrh 
1828a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
1829a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*);
18304adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
183117435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
183217435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
18334adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
183417435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
183517435752Sdrh SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
183661dfc31dSdrh                                       Select*, Expr*, IdList*);
183761dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
18384adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
18394adee20fSdanielk1977 void sqlite3IdListDelete(IdList*);
18404adee20fSdanielk1977 void sqlite3SrcListDelete(SrcList*);
18410202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
18424d91a701Sdrh                         Token*, int, int);
18434d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
18446c8c8ce0Sdanielk1977 int sqlite3Select(Parse*, Select*, SelectDest*, Select*, int, int*, char *aff);
184517435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
184617435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
18474adee20fSdanielk1977 void sqlite3SelectDelete(Select*);
18484adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
18494adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
1850c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
18514adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
18524adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1853a9d1ccb9Sdanielk1977 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8);
18544adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
1855da250ea5Sdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
1856e55cbd72Sdrh void sqlite3ExprCodeMove(Parse*, int, int);
1857e55cbd72Sdrh void sqlite3ExprClearColumnCache(Parse*, int);
1858da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
1859652fbf55Sdrh int sqlite3ExprWritableRegister(Parse*,int,int);
1860389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
18612dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
1862678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
18632dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
1864678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*);
1865389a1adbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int);
18664adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
18674adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
18689bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
1869ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
18709bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
18719bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
18729bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
187374161705Sdrh void sqlite3Vacuum(Parse*);
18749bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
187517435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
18764adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
1877b3bce662Sdanielk1977 int sqlite3ExprResolveNames(NameContext *, Expr *);
1878d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1879d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
18804adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
18811e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*);
18822fa1868fSdrh void sqlite3PrngSaveState(void);
18832fa1868fSdrh void sqlite3PrngRestoreState(void);
18842fa1868fSdrh void sqlite3PrngResetState(void);
18859bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
18864adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
1887684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
18884adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
18894adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
18904adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
18910a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
1892eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
18934adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
18944adee20fSdanielk1977 int sqlite3IsRowid(const char*);
18952d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
18962d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
1897e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
189804adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
189904adf416Sdrh                                      int*,int,int,int,int);
190004adf416Sdrh void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*,int,int,int,int);
1901aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
19024adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
190317435752Sdrh Expr *sqlite3ExprDup(sqlite3*,Expr*);
190417435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*);
190517435752Sdrh ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
190617435752Sdrh SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
190717435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
190817435752Sdrh Select *sqlite3SelectDup(sqlite3*,Select*);
19099bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
19109bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
19119bb575fdSdrh void sqlite3RegisterDateTimeFunctions(sqlite3*);
19127e8b848aSdrh #ifdef SQLITE_DEBUG
19139bb575fdSdrh   int sqlite3SafetyOn(sqlite3*);
19149bb575fdSdrh   int sqlite3SafetyOff(sqlite3*);
19157e8b848aSdrh #else
19167e8b848aSdrh # define sqlite3SafetyOn(A) 0
19177e8b848aSdrh # define sqlite3SafetyOff(A) 0
19187e8b848aSdrh #endif
19197e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
19207e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
19219cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
19220f35a6b5Sdrh void sqlite3MaterializeView(Parse*, Select*, Expr*, u32, int);
1923b7f9164eSdrh 
1924b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
1925ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
192660218d2aSdrh                            Expr*,int, int);
19274adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1928fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
192974161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
1930dca76841Sdrh   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
19314adee20fSdanielk1977   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
19328f2c54e6Sdanielk1977                            int, int, u32*, u32*);
1933dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
19344adee20fSdanielk1977   void sqlite3DeleteTriggerStep(TriggerStep*);
193517435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
193617435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
193717435752Sdrh                                         ExprList*,Select*,int);
193817435752Sdrh   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
193917435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
19404adee20fSdanielk1977   void sqlite3DeleteTrigger(Trigger*);
1941b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
19421f12107aSdanielk1977   void sqlite3SelectMask(Parse *, Select *, u32);
1943b7f9164eSdrh #else
1944b7f9164eSdrh # define sqlite3TriggersExist(A,B,C,D,E,F) 0
1945b7f9164eSdrh # define sqlite3DeleteTrigger(A)
1946cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
1947b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
19488f2c54e6Sdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K) 0
19491f12107aSdanielk1977 # define sqlite3SelectMask(A, B, C)
1950b7f9164eSdrh #endif
1951b7f9164eSdrh 
19524adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
19530202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
19544adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
1955ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
1956728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
19574adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
19584adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
19594adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
1960ed6c8671Sdrh #else
1961b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
19624adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
19634adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
19644adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
1965ed6c8671Sdrh #endif
1966f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1967f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
19689bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
196933f4e02aSdrh                        int omitJournal, int nCache, int flags, Btree **ppBtree);
19704adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
19714adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
19724adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
19734adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
19744adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
19754adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1976487e262fSdrh int sqlite3AtoF(const char *z, double*);
19776f8a503dSdanielk1977 char *sqlite3_snprintf(int,char*,const char*,...);
1978fec19aadSdrh int sqlite3GetInt32(const char *, int*);
1979598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int);
1980ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
1981ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
198266150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**);
1983192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char *, u64);
198490e4d95dSdanielk1977 int sqlite3GetVarint(const unsigned char *, u64 *);
19856d2fb154Sdrh int sqlite3GetVarint32(const unsigned char *, u32 *);
1986192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
1987a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
1988a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
1989e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
1990e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
1991bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
1992b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*);
19939bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
1994ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
1995ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
1996f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
19978a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
19989bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
19990202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
20007cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
20018b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
20027cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2003d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2004b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
20054e6af134Sdanielk1977 
2006b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2007b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2008b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
20091e536953Sdanielk1977                         void(*)(void*));
20104e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
20111e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
20121e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
20131e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2014b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
201546c99e0fSdrh #ifndef SQLITE_AMALGAMATION
20164e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
201746c99e0fSdrh #endif
2018a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
20194343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
20201f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
20219fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
20229fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
20232958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2024d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
2025b3bce662Sdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *);
2026b3bce662Sdanielk1977 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
2027aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
202819a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
202919a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
20304dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
20318a51256cSdrh char sqlite3AffinityType(const Token*);
20329f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2033a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2034ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
2035cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
203651147baaSdrh void sqlite3DefaultRowEst(Index*);
203755ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2038d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
2039f744bb56Sdanielk1977 void sqlite3AttachFunctions(sqlite3 *);
2040fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
2041da184236Sdanielk1977 void sqlite3SchemaFree(void *);
20421e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
2043e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
2044b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
2045771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2046771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
2047771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
204854f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
2049ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
205069dab1d3Sdrh 
2051ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2052ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
2053ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
20541013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
20551e536953Sdanielk1977 
205695bdbbbdSdrh /*
205795bdbbbdSdrh ** The interface to the LEMON-generated parser
205895bdbbbdSdrh */
205995bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
206095bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
206195bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
206295bdbbbdSdrh 
2063caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*);
206469dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
2065f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
206669dab1d3Sdrh #else
206769dab1d3Sdrh # define sqlite3CloseExtensions(X)
206869dab1d3Sdrh #endif
2069e3026636Sdanielk1977 
2070c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2071c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
2072c00da105Sdanielk1977 #else
2073c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
2074c00da105Sdanielk1977 #endif
2075c00da105Sdanielk1977 
207653c14021Sdrh #ifdef SQLITE_TEST
207753c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
207853c14021Sdrh #endif
207953c14021Sdrh 
2080b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
2081b9bb7c18Sdrh #  define sqlite3VtabClear(X)
2082f9e7dda7Sdanielk1977 #  define sqlite3VtabSync(X,Y) (Y)
2083f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
2084f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
2085b9bb7c18Sdrh #else
2086707205d1Sdrh    void sqlite3VtabClear(Table*);
2087f9e7dda7Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, int rc);
2088f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
2089f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
2090b9bb7c18Sdrh #endif
2091189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*);
2092a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
2093b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2094b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
2095b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
2096b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
209778efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
20987e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
20999e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
2100f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
21011e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
2102b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
2103b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
2104b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
2105bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
2106b9bb7c18Sdrh 
2107643167ffSdrh 
2108643167ffSdrh /*
2109643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
2110643167ffSdrh */
2111643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
21127e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
2113643167ffSdrh 
2114643167ffSdrh /*
2115643167ffSdrh ** The interface to the fault injector subsystem.  If the fault injector
2116643167ffSdrh ** mechanism is disabled at compile-time then set up macros so that no
2117643167ffSdrh ** unnecessary code is generated.
2118643167ffSdrh */
21193088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
2120643167ffSdrh   void sqlite3FaultConfig(int,int,int);
2121643167ffSdrh   int sqlite3FaultFailures(int);
2122643167ffSdrh   int sqlite3FaultBenignFailures(int);
2123643167ffSdrh   int sqlite3FaultPending(int);
2124643167ffSdrh   void sqlite3FaultBenign(int,int);
2125643167ffSdrh   int sqlite3FaultStep(int);
2126643167ffSdrh #else
2127643167ffSdrh # define sqlite3FaultConfig(A,B,C)
2128643167ffSdrh # define sqlite3FaultFailures(A)         0
2129643167ffSdrh # define sqlite3FaultBenignFailures(A)   0
2130643167ffSdrh # define sqlite3FaultPending(A)          (-1)
2131643167ffSdrh # define sqlite3FaultBenign(A,B)
2132643167ffSdrh # define sqlite3FaultStep(A)             0
2133643167ffSdrh #endif
2134643167ffSdrh 
2135643167ffSdrh 
2136643167ffSdrh 
21379a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
21389a96b668Sdanielk1977 #define IN_INDEX_EPH             2
21399a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
21409a96b668Sdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int);
21419a96b668Sdanielk1977 
2142c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
2143c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2144c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
2145f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
2146c7b6017cSdanielk1977 #else
2147c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2148c7b6017cSdanielk1977 #endif
2149c7b6017cSdanielk1977 
2150e6a58a4eSdanielk1977 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
2151fc976065Sdanielk1977   void sqlite3ExprSetHeight(Expr *);
2152fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
2153fc976065Sdanielk1977 #else
2154fc976065Sdanielk1977   #define sqlite3ExprSetHeight(x)
2155fc976065Sdanielk1977 #endif
2156fc976065Sdanielk1977 
2157a3152895Sdrh u32 sqlite3Get4byte(const u8*);
2158a3152895Sdrh void sqlite3Put4byte(u8*, u32);
2159a3152895Sdrh 
2160fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
2161fd9a0a45Sdanielk1977 #include "sseInt.h"
2162fd9a0a45Sdanielk1977 #endif
2163fd9a0a45Sdanielk1977 
21646e736838Sdrh #ifdef SQLITE_DEBUG
21656e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
21666e736838Sdrh #endif
21676e736838Sdrh 
2168b0603416Sdrh /*
2169b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
21703a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
2171b0603416Sdrh ** print I/O tracing messages.
2172b0603416Sdrh */
2173b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
21743a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
2175b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
2176b0603416Sdrh #else
2177b0603416Sdrh # define IOTRACE(A)
2178b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
2179b0603416Sdrh #endif
21803a00f907Smlcreech SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
2181b0603416Sdrh 
2182e3026636Sdanielk1977 #endif
2183