xref: /sqlite-3.40.0/src/sqliteInt.h (revision bd43455c)
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*bd43455cSdanielk1977 ** @(#) $Id: sqliteInt.h,v 1.843 2009/03/18 10:33:01 danielk1977 Exp $
1575897234Sdrh */
16e3026636Sdanielk1977 #ifndef _SQLITEINT_H_
17e3026636Sdanielk1977 #define _SQLITEINT_H_
1871674ce9Sdrh 
19bd0ae111Smlcreech /*
201e12d43bSmlcreech ** Include the configuration header output by 'configure' if we're using the
211e12d43bSmlcreech ** autoconf-based build
22bd0ae111Smlcreech */
231e12d43bSmlcreech #ifdef _HAVE_SQLITE_CONFIG_H
2498dc4b1aSmlcreech #include "config.h"
251e12d43bSmlcreech #endif
261e12d43bSmlcreech 
27bb4957f8Sdrh #include "sqliteLimit.h"
2898dc4b1aSmlcreech 
29e2965827Sdrh /* Disable nuisance warnings on Borland compilers */
30e2965827Sdrh #if defined(__BORLANDC__)
31e2965827Sdrh #pragma warn -rch /* unreachable code */
32e2965827Sdrh #pragma warn -ccc /* Condition is always true or false */
33e2965827Sdrh #pragma warn -aus /* Assigned value is never used */
34e2965827Sdrh #pragma warn -csu /* Comparing signed and unsigned */
35467bcf36Sshane #pragma warn -spa /* Suspicious pointer arithmetic */
36e2965827Sdrh #endif
37e2965827Sdrh 
3898dc4b1aSmlcreech /* Needed for various definitions... */
3960323418Sdrh #ifndef _GNU_SOURCE
4098dc4b1aSmlcreech # define _GNU_SOURCE
4160323418Sdrh #endif
4298dc4b1aSmlcreech 
4398dc4b1aSmlcreech /*
4406af763eSdrh ** Include standard header files as necessary
4506af763eSdrh */
4606af763eSdrh #ifdef HAVE_STDINT_H
4706af763eSdrh #include <stdint.h>
4806af763eSdrh #endif
4906af763eSdrh #ifdef HAVE_INTTYPES_H
5006af763eSdrh #include <inttypes.h>
5106af763eSdrh #endif
5206af763eSdrh 
5306af763eSdrh /*
541fc4129dSshane  * This macro is used to "hide" some ugliness in casting an int
551fc4129dSshane  * value to a ptr value under the MSVC 64-bit compiler.   Casting
561fc4129dSshane  * non 64-bit values to ptr types results in a "hard" error with
571fc4129dSshane  * the MSVC 64-bit compiler which this attempts to avoid.
581fc4129dSshane  *
591fc4129dSshane  * A simple compiler pragma or casting sequence could not be found
601fc4129dSshane  * to correct this in all situations, so this macro was introduced.
611fc4129dSshane  *
621fc4129dSshane  * It could be argued that the intptr_t type could be used in this
631fc4129dSshane  * case, but that type is not available on all compilers, or
641fc4129dSshane  * requires the #include of specific headers which differs between
651fc4129dSshane  * platforms.
661fc4129dSshane  */
671fc4129dSshane #define SQLITE_INT_TO_PTR(X)   ((void*)&((char*)0)[X])
681fc4129dSshane #define SQLITE_PTR_TO_INT(X)   ((int)(((char*)X)-(char*)0))
69b6dbc000Sdrh 
70b6dbc000Sdrh /*
71467bcf36Sshane ** These #defines should enable >2GB file support on POSIX if the
7271674ce9Sdrh ** underlying operating system supports it.  If the OS lacks
7371674ce9Sdrh ** large file support, or if the OS is windows, these should be no-ops.
7471674ce9Sdrh **
7571674ce9Sdrh ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
7671674ce9Sdrh ** system #includes.  Hence, this block of code must be the very first
7771674ce9Sdrh ** code in all source files.
7871674ce9Sdrh **
7971674ce9Sdrh ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
8071674ce9Sdrh ** on the compiler command line.  This is necessary if you are compiling
8171674ce9Sdrh ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
8271674ce9Sdrh ** on an older machine (ex: Red Hat 6.0).  If you compile on Red Hat 7.2
8371674ce9Sdrh ** without this option, LFS is enable.  But LFS does not exist in the kernel
8471674ce9Sdrh ** in Red Hat 6.0, so the code won't work.  Hence, for maximum binary
8571674ce9Sdrh ** portability you should omit LFS.
8671674ce9Sdrh **
87467bcf36Sshane ** Similar is true for Mac OS X.  LFS is only supported on Mac OS X 9 and later.
8871674ce9Sdrh */
8971674ce9Sdrh #ifndef SQLITE_DISABLE_LFS
9071674ce9Sdrh # define _LARGE_FILE       1
9171674ce9Sdrh # ifndef _FILE_OFFSET_BITS
9271674ce9Sdrh #   define _FILE_OFFSET_BITS 64
9371674ce9Sdrh # endif
9471674ce9Sdrh # define _LARGEFILE_SOURCE 1
9571674ce9Sdrh #endif
9671674ce9Sdrh 
9771674ce9Sdrh 
98e5e7a901Sdrh /*
99e5e7a901Sdrh ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
100e5e7a901Sdrh ** Older versions of SQLite used an optional THREADSAFE macro.
101e5e7a901Sdrh ** We support that for legacy
102e5e7a901Sdrh */
103e5e7a901Sdrh #if !defined(SQLITE_THREADSAFE)
104e5e7a901Sdrh #if defined(THREADSAFE)
105e5e7a901Sdrh # define SQLITE_THREADSAFE THREADSAFE
106e5e7a901Sdrh #else
107e5e7a901Sdrh # define SQLITE_THREADSAFE 1
108e5e7a901Sdrh #endif
109e5e7a901Sdrh #endif
110e5e7a901Sdrh 
11167080617Sdrh /*
1120a732f59Sdanielk1977 ** The SQLITE_DEFAULT_MEMSTATUS macro must be defined as either 0 or 1.
1130a732f59Sdanielk1977 ** It determines whether or not the features related to
114467bcf36Sshane ** SQLITE_CONFIG_MEMSTATUS are available by default or not. This value can
1150a732f59Sdanielk1977 ** be overridden at runtime using the sqlite3_config() API.
1160a732f59Sdanielk1977 */
1170a732f59Sdanielk1977 #if !defined(SQLITE_DEFAULT_MEMSTATUS)
1180a732f59Sdanielk1977 # define SQLITE_DEFAULT_MEMSTATUS 1
1190a732f59Sdanielk1977 #endif
1200a732f59Sdanielk1977 
1210a732f59Sdanielk1977 /*
1220d18020bSdrh ** Exactly one of the following macros must be defined in order to
1230d18020bSdrh ** specify which memory allocation subsystem to use.
1240d18020bSdrh **
1250d18020bSdrh **     SQLITE_SYSTEM_MALLOC          // Use normal system malloc()
1260d18020bSdrh **     SQLITE_MEMDEBUG               // Debugging version of system malloc()
1270d18020bSdrh **     SQLITE_MEMORY_SIZE            // internal allocator #1
1280d18020bSdrh **     SQLITE_MMAP_HEAP_SIZE         // internal mmap() allocator
1290d18020bSdrh **     SQLITE_POW2_MEMORY_SIZE       // internal power-of-two allocator
1300d18020bSdrh **
1310d18020bSdrh ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
1320d18020bSdrh ** the default.
1330d18020bSdrh */
1340d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1350d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1360d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)>1
1370d18020bSdrh # error "At most one of the following compile-time configuration options\
1380d18020bSdrh  is allows: SQLITE_SYSTEM_MALLOC, SQLITE_MEMDEBUG, SQLITE_MEMORY_SIZE,\
1390d18020bSdrh  SQLITE_MMAP_HEAP_SIZE, SQLITE_POW2_MEMORY_SIZE"
1400d18020bSdrh #endif
1410d18020bSdrh #if defined(SQLITE_SYSTEM_MALLOC)+defined(SQLITE_MEMDEBUG)+\
1420d18020bSdrh     defined(SQLITE_MEMORY_SIZE)+defined(SQLITE_MMAP_HEAP_SIZE)+\
1430d18020bSdrh     defined(SQLITE_POW2_MEMORY_SIZE)==0
1440d18020bSdrh # define SQLITE_SYSTEM_MALLOC 1
1450d18020bSdrh #endif
1460d18020bSdrh 
1470d18020bSdrh /*
148eee4c8caSdrh ** If SQLITE_MALLOC_SOFT_LIMIT is defined, then try to keep the
149eee4c8caSdrh ** sizes of memory allocations below this value where possible.
150eee4c8caSdrh */
151eee4c8caSdrh #if defined(SQLITE_POW2_MEMORY_SIZE) && !defined(SQLITE_MALLOC_SOFT_LIMIT)
152eee4c8caSdrh # define SQLITE_MALLOC_SOFT_LIMIT 1024
153eee4c8caSdrh #endif
154eee4c8caSdrh 
155eee4c8caSdrh /*
15667080617Sdrh ** We need to define _XOPEN_SOURCE as follows in order to enable
157467bcf36Sshane ** recursive mutexes on most Unix systems.  But Mac OS X is different.
15867080617Sdrh ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
15967080617Sdrh ** so it is omitted there.  See ticket #2673.
160e5e7a901Sdrh **
161e5e7a901Sdrh ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
162e5e7a901Sdrh ** implemented on some systems.  So we avoid defining it at all
163e5e7a901Sdrh ** if it is already defined or if it is unneeded because we are
164e5e7a901Sdrh ** not doing a threadsafe build.  Ticket #2681.
1659e0ebbfaSdrh **
1669e0ebbfaSdrh ** See also ticket #2741.
16767080617Sdrh */
168ee99b90dSaswift #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__) && SQLITE_THREADSAFE
169058897a9Sdrh #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
17067080617Sdrh #endif
171e3026636Sdanielk1977 
1727d10d5a6Sdrh /*
1737d10d5a6Sdrh ** The TCL headers are only needed when compiling the TCL bindings.
1747d10d5a6Sdrh */
1754f0c5878Sdrh #if defined(SQLITE_TCL) || defined(TCLSH)
1764f0c5878Sdrh # include <tcl.h>
177824d7c18Sdrh #endif
178824d7c18Sdrh 
179824d7c18Sdrh /*
1804b529d97Sdrh ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
181b27795c1Sdrh ** Setting NDEBUG makes the code smaller and run faster.  So the following
1824b529d97Sdrh ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
1834b529d97Sdrh ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
1844b529d97Sdrh ** feature.
1854b529d97Sdrh */
186289ab076Sdrh #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
1874b529d97Sdrh # define NDEBUG 1
1884b529d97Sdrh #endif
1894b529d97Sdrh 
1906402250eSdrh /*
19147c3b3e0Sdrh ** The testcase() macro is used to aid in coverage testing.  When
19247c3b3e0Sdrh ** doing coverage testing, the condition inside the argument to
19347c3b3e0Sdrh ** testcase() must be evaluated both true and false in order to
19447c3b3e0Sdrh ** get full branch coverage.  The testcase() macro is inserted
19547c3b3e0Sdrh ** to help ensure adequate test coverage in places where simple
19647c3b3e0Sdrh ** condition/decision coverage is inadequate.  For example, testcase()
19747c3b3e0Sdrh ** can be used to make sure boundary values are tested.  For
19847c3b3e0Sdrh ** bitmask tests, testcase() can be used to make sure each bit
19947c3b3e0Sdrh ** is significant and used at least once.  On switch statements
20047c3b3e0Sdrh ** where multiple cases go to the same block of code, testcase()
20147c3b3e0Sdrh ** can insure that all cases are evaluated.
20247c3b3e0Sdrh **
20347c3b3e0Sdrh */
20447c3b3e0Sdrh #ifdef SQLITE_COVERAGE_TEST
20547c3b3e0Sdrh   void sqlite3Coverage(int);
20647c3b3e0Sdrh # define testcase(X)  if( X ){ sqlite3Coverage(__LINE__); }
20747c3b3e0Sdrh #else
20847c3b3e0Sdrh # define testcase(X)
2098f941bc7Sdrh #endif
2108f941bc7Sdrh 
2118f941bc7Sdrh /*
2128f941bc7Sdrh ** The TESTONLY macro is used to enclose variable declarations or
2138f941bc7Sdrh ** other bits of code that are needed to support the arguments
2148f941bc7Sdrh ** within testcase() and assert() macros.
2158f941bc7Sdrh */
2168f941bc7Sdrh #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
2178f941bc7Sdrh # define TESTONLY(X)  X
2188f941bc7Sdrh #else
21947c3b3e0Sdrh # define TESTONLY(X)
22047c3b3e0Sdrh #endif
22147c3b3e0Sdrh 
22247c3b3e0Sdrh /*
22347c3b3e0Sdrh ** The ALWAYS and NEVER macros surround boolean expressions which
22447c3b3e0Sdrh ** are intended to always be true or false, respectively.  Such
22547c3b3e0Sdrh ** expressions could be omitted from the code completely.  But they
22647c3b3e0Sdrh ** are included in a few cases in order to enhance the resilience
22747c3b3e0Sdrh ** of SQLite to unexpected behavior - to make the code "self-healing"
22847c3b3e0Sdrh ** or "ductile" rather than being "brittle" and crashing at the first
22947c3b3e0Sdrh ** hint of unplanned behavior.
23047c3b3e0Sdrh **
23147c3b3e0Sdrh ** In other words, ALWAYS and NEVER are added for defensive code.
23247c3b3e0Sdrh **
23347c3b3e0Sdrh ** When doing coverage testing ALWAYS and NEVER are hard-coded to
23447c3b3e0Sdrh ** be true and false so that the unreachable code then specify will
23547c3b3e0Sdrh ** not be counted as untested code.
23647c3b3e0Sdrh */
23747c3b3e0Sdrh #if defined(SQLITE_COVERAGE_TEST)
23847c3b3e0Sdrh # define ALWAYS(X)      (1)
23947c3b3e0Sdrh # define NEVER(X)       (0)
24047c3b3e0Sdrh #elif !defined(NDEBUG)
24147c3b3e0Sdrh   int sqlite3Assert(void);
24247c3b3e0Sdrh # define ALWAYS(X)      ((X)?1:sqlite3Assert())
24347c3b3e0Sdrh # define NEVER(X)       ((X)?sqlite3Assert():0)
24447c3b3e0Sdrh #else
24547c3b3e0Sdrh # define ALWAYS(X)      (X)
24647c3b3e0Sdrh # define NEVER(X)       (X)
24747c3b3e0Sdrh #endif
24847c3b3e0Sdrh 
24947c3b3e0Sdrh /*
25047c3b3e0Sdrh ** The macro unlikely() is a hint that surrounds a boolean
25147c3b3e0Sdrh ** expression that is usually false.  Macro likely() surrounds
25247c3b3e0Sdrh ** a boolean expression that is usually true.  GCC is able to
25347c3b3e0Sdrh ** use these hints to generate better code, sometimes.
25447c3b3e0Sdrh */
25547c3b3e0Sdrh #if defined(__GNUC__) && 0
25647c3b3e0Sdrh # define likely(X)    __builtin_expect((X),1)
25747c3b3e0Sdrh # define unlikely(X)  __builtin_expect((X),0)
25847c3b3e0Sdrh #else
25947c3b3e0Sdrh # define likely(X)    !!(X)
26047c3b3e0Sdrh # define unlikely(X)  !!(X)
26147c3b3e0Sdrh #endif
26247c3b3e0Sdrh 
26347c3b3e0Sdrh /*
2646402250eSdrh ** Sometimes we need a small amount of code such as a variable initialization
2656402250eSdrh ** to setup for a later assert() statement.  We do not want this code to
2666402250eSdrh ** appear when assert() is disabled.  The following macro is therefore
2676402250eSdrh ** used to contain that setup code.  The "VVA" acronym stands for
2686402250eSdrh ** "Verification, Validation, and Accreditation".  In other words, the
2696402250eSdrh ** code within VVA_ONLY() will only run during verification processes.
2706402250eSdrh */
2716402250eSdrh #ifndef NDEBUG
2726402250eSdrh # define VVA_ONLY(X)  X
2736402250eSdrh #else
2746402250eSdrh # define VVA_ONLY(X)
2756402250eSdrh #endif
2766402250eSdrh 
2771d482dd9Sdrh #include "sqlite3.h"
278beae3194Sdrh #include "hash.h"
27975897234Sdrh #include "parse.h"
28075897234Sdrh #include <stdio.h>
28175897234Sdrh #include <stdlib.h>
28275897234Sdrh #include <string.h>
28375897234Sdrh #include <assert.h>
28452370e2cSdrh #include <stddef.h>
28575897234Sdrh 
286967e8b73Sdrh /*
287b37df7b9Sdrh ** If compiling for a processor that lacks floating point support,
288b37df7b9Sdrh ** substitute integer for floating-point
289b37df7b9Sdrh */
290b37df7b9Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
291b37df7b9Sdrh # define double sqlite_int64
292b37df7b9Sdrh # define LONGDOUBLE_TYPE sqlite_int64
293d1167393Sdrh # ifndef SQLITE_BIG_DBL
294b37df7b9Sdrh #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
295d1167393Sdrh # endif
296b37df7b9Sdrh # define SQLITE_OMIT_DATETIME_FUNCS 1
297b37df7b9Sdrh # define SQLITE_OMIT_TRACE 1
298110daac9Sdrh # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
299b37df7b9Sdrh #endif
300d1167393Sdrh #ifndef SQLITE_BIG_DBL
301d1167393Sdrh # define SQLITE_BIG_DBL (1e99)
302d1167393Sdrh #endif
303b37df7b9Sdrh 
304b37df7b9Sdrh /*
30553c0f748Sdanielk1977 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
30653c0f748Sdanielk1977 ** afterward. Having this macro allows us to cause the C compiler
30753c0f748Sdanielk1977 ** to omit code used by TEMP tables without messy #ifndef statements.
30853c0f748Sdanielk1977 */
30953c0f748Sdanielk1977 #ifdef SQLITE_OMIT_TEMPDB
31053c0f748Sdanielk1977 #define OMIT_TEMPDB 1
31153c0f748Sdanielk1977 #else
31253c0f748Sdanielk1977 #define OMIT_TEMPDB 0
31353c0f748Sdanielk1977 #endif
31453c0f748Sdanielk1977 
31553c0f748Sdanielk1977 /*
3160bd1f4eaSdrh ** If the following macro is set to 1, then NULL values are considered
3170bd1f4eaSdrh ** distinct when determining whether or not two entries are the same
3180bd1f4eaSdrh ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
3190bd1f4eaSdrh ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
3200bd1f4eaSdrh ** is the way things are suppose to work.
3210bd1f4eaSdrh **
3220bd1f4eaSdrh ** If the following macro is set to 0, the NULLs are indistinct for
3230bd1f4eaSdrh ** a UNIQUE index.  In this mode, you can only have a single NULL entry
3240bd1f4eaSdrh ** for a column declared UNIQUE.  This is the way Informix and SQL Server
3250bd1f4eaSdrh ** work.
3260bd1f4eaSdrh */
3270bd1f4eaSdrh #define NULL_DISTINCT_FOR_UNIQUE 1
3280bd1f4eaSdrh 
3290bd1f4eaSdrh /*
330d946db00Sdrh ** The "file format" number is an integer that is incremented whenever
331d946db00Sdrh ** the VDBE-level file format changes.  The following macros define the
332d946db00Sdrh ** the default file format for new databases and the maximum file format
333d946db00Sdrh ** that the library can read.
334d946db00Sdrh */
335d946db00Sdrh #define SQLITE_MAX_FILE_FORMAT 4
336d946db00Sdrh #ifndef SQLITE_DEFAULT_FILE_FORMAT
33776fe8032Sdrh # define SQLITE_DEFAULT_FILE_FORMAT 1
338d946db00Sdrh #endif
339d946db00Sdrh 
340d946db00Sdrh /*
341b06a0b67Sdanielk1977 ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
34249766d6cSdrh ** on the command-line
34349766d6cSdrh */
344b06a0b67Sdanielk1977 #ifndef SQLITE_TEMP_STORE
345b06a0b67Sdanielk1977 # define SQLITE_TEMP_STORE 1
34649766d6cSdrh #endif
34749766d6cSdrh 
34849766d6cSdrh /*
349f1974846Sdrh ** GCC does not define the offsetof() macro so we'll have to do it
350f1974846Sdrh ** ourselves.
351f1974846Sdrh */
352f1974846Sdrh #ifndef offsetof
353f1974846Sdrh #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
354f1974846Sdrh #endif
355f1974846Sdrh 
356f1974846Sdrh /*
3579b8f447bSdrh ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
3589b8f447bSdrh ** not, there are still machines out there that use EBCDIC.)
3599b8f447bSdrh */
3609b8f447bSdrh #if 'A' == '\301'
3619b8f447bSdrh # define SQLITE_EBCDIC 1
3629b8f447bSdrh #else
3639b8f447bSdrh # define SQLITE_ASCII 1
3649b8f447bSdrh #endif
3659b8f447bSdrh 
3669b8f447bSdrh /*
3675a2c2c20Sdrh ** Integers of known sizes.  These typedefs might change for architectures
3685a2c2c20Sdrh ** where the sizes very.  Preprocessor macros are available so that the
3695a2c2c20Sdrh ** types can be conveniently redefined at compile-type.  Like this:
3705a2c2c20Sdrh **
3715a2c2c20Sdrh **         cc '-DUINTPTR_TYPE=long long int' ...
37241a2b48bSdrh */
3735a2c2c20Sdrh #ifndef UINT32_TYPE
374dda5b68cSmlcreech # ifdef HAVE_UINT32_T
375dda5b68cSmlcreech #  define UINT32_TYPE uint32_t
376dda5b68cSmlcreech # else
3775a2c2c20Sdrh #  define UINT32_TYPE unsigned int
3785a2c2c20Sdrh # endif
379dda5b68cSmlcreech #endif
3805a2c2c20Sdrh #ifndef UINT16_TYPE
381dda5b68cSmlcreech # ifdef HAVE_UINT16_T
382dda5b68cSmlcreech #  define UINT16_TYPE uint16_t
383dda5b68cSmlcreech # else
3845a2c2c20Sdrh #  define UINT16_TYPE unsigned short int
3855a2c2c20Sdrh # endif
386dda5b68cSmlcreech #endif
387939a16d6Sdrh #ifndef INT16_TYPE
388dda5b68cSmlcreech # ifdef HAVE_INT16_T
389dda5b68cSmlcreech #  define INT16_TYPE int16_t
390dda5b68cSmlcreech # else
391939a16d6Sdrh #  define INT16_TYPE short int
392939a16d6Sdrh # endif
393dda5b68cSmlcreech #endif
3945a2c2c20Sdrh #ifndef UINT8_TYPE
395dda5b68cSmlcreech # ifdef HAVE_UINT8_T
396dda5b68cSmlcreech #  define UINT8_TYPE uint8_t
397dda5b68cSmlcreech # else
3985a2c2c20Sdrh #  define UINT8_TYPE unsigned char
3995a2c2c20Sdrh # endif
400dda5b68cSmlcreech #endif
401905793e2Sdrh #ifndef INT8_TYPE
402dda5b68cSmlcreech # ifdef HAVE_INT8_T
403dda5b68cSmlcreech #  define INT8_TYPE int8_t
404dda5b68cSmlcreech # else
405905793e2Sdrh #  define INT8_TYPE signed char
406905793e2Sdrh # endif
407dda5b68cSmlcreech #endif
408efad9995Sdrh #ifndef LONGDOUBLE_TYPE
409efad9995Sdrh # define LONGDOUBLE_TYPE long double
410efad9995Sdrh #endif
411efad9995Sdrh typedef sqlite_int64 i64;          /* 8-byte signed integer */
41227436af7Sdrh typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
4135a2c2c20Sdrh typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
4145a2c2c20Sdrh typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
415939a16d6Sdrh typedef INT16_TYPE i16;            /* 2-byte signed integer */
4165a2c2c20Sdrh typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
41770a8ca3cSdrh typedef INT8_TYPE i8;              /* 1-byte signed integer */
4185a2c2c20Sdrh 
4195a2c2c20Sdrh /*
420bbd42a6dSdrh ** Macros to determine whether the machine is big or little endian,
421bbd42a6dSdrh ** evaluated at runtime.
422bbd42a6dSdrh */
42346c99e0fSdrh #ifdef SQLITE_AMALGAMATION
424b3190c15Sdrh const int sqlite3one = 1;
42546c99e0fSdrh #else
426bbd42a6dSdrh extern const int sqlite3one;
42746c99e0fSdrh #endif
428189077f3Sdrh #if defined(i386) || defined(__i386__) || defined(_M_IX86)\
429189077f3Sdrh                              || defined(__x86_64) || defined(__x86_64__)
43038def054Sdrh # define SQLITE_BIGENDIAN    0
43138def054Sdrh # define SQLITE_LITTLEENDIAN 1
43238def054Sdrh # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
43338def054Sdrh #else
4349c054830Sdrh # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
4359c054830Sdrh # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
43638def054Sdrh # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
43738def054Sdrh #endif
438bbd42a6dSdrh 
439bbd42a6dSdrh /*
4400f050353Sdrh ** Constants for the largest and smallest possible 64-bit signed integers.
4410f050353Sdrh ** These macros are designed to work correctly on both 32-bit and 64-bit
4420f050353Sdrh ** compilers.
4430f050353Sdrh */
4440f050353Sdrh #define LARGEST_INT64  (0xffffffff|(((i64)0x7fffffff)<<32))
4450f050353Sdrh #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
4460f050353Sdrh 
4470f050353Sdrh /*
44890f5ecb3Sdrh ** An instance of the following structure is used to store the busy-handler
44990f5ecb3Sdrh ** callback for a given sqlite handle.
45090f5ecb3Sdrh **
45190f5ecb3Sdrh ** The sqlite.busyHandler member of the sqlite struct contains the busy
45290f5ecb3Sdrh ** callback for the database handle. Each pager opened via the sqlite
45390f5ecb3Sdrh ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
45490f5ecb3Sdrh ** callback is currently invoked only from within pager.c.
45590f5ecb3Sdrh */
45690f5ecb3Sdrh typedef struct BusyHandler BusyHandler;
45790f5ecb3Sdrh struct BusyHandler {
45890f5ecb3Sdrh   int (*xFunc)(void *,int);  /* The busy callback */
45990f5ecb3Sdrh   void *pArg;                /* First arg to busy callback */
460a4afb65cSdrh   int nBusy;                 /* Incremented with each busy call */
46190f5ecb3Sdrh };
46290f5ecb3Sdrh 
46390f5ecb3Sdrh /*
46475897234Sdrh ** Name of the master database table.  The master database table
46575897234Sdrh ** is a special table that holds the names and attributes of all
46675897234Sdrh ** user tables and indices.
46775897234Sdrh */
46875897234Sdrh #define MASTER_NAME       "sqlite_master"
469e0bc4048Sdrh #define TEMP_MASTER_NAME  "sqlite_temp_master"
47075897234Sdrh 
47175897234Sdrh /*
4728e150818Sdanielk1977 ** The root-page of the master database table.
4738e150818Sdanielk1977 */
4748e150818Sdanielk1977 #define MASTER_ROOT       1
4758e150818Sdanielk1977 
4768e150818Sdanielk1977 /*
477ed6c8671Sdrh ** The name of the schema table.
478ed6c8671Sdrh */
47953c0f748Sdanielk1977 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
480ed6c8671Sdrh 
481ed6c8671Sdrh /*
48275897234Sdrh ** A convenience macro that returns the number of elements in
48375897234Sdrh ** an array.
48475897234Sdrh */
48523432976Sdanielk1977 #define ArraySize(X)    ((int)(sizeof(X)/sizeof(X[0])))
48675897234Sdrh 
48775897234Sdrh /*
488633e6d57Sdrh ** The following value as a destructor means to use sqlite3DbFree().
489633e6d57Sdrh ** This is an internal extension to SQLITE_STATIC and SQLITE_TRANSIENT.
490633e6d57Sdrh */
491633e6d57Sdrh #define SQLITE_DYNAMIC   ((sqlite3_destructor_type)sqlite3DbFree)
492633e6d57Sdrh 
49378f82d1eSdrh /*
49478f82d1eSdrh ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
49578f82d1eSdrh ** not support Writable Static Data (WSD) such as global and static variables.
49678f82d1eSdrh ** All variables must either be on the stack or dynamically allocated from
49778f82d1eSdrh ** the heap.  When WSD is unsupported, the variable declarations scattered
49878f82d1eSdrh ** throughout the SQLite code must become constants instead.  The SQLITE_WSD
49978f82d1eSdrh ** macro is used for this purpose.  And instead of referencing the variable
50078f82d1eSdrh ** directly, we use its constant as a key to lookup the run-time allocated
50178f82d1eSdrh ** buffer that holds real variable.  The constant is also the initializer
50278f82d1eSdrh ** for the run-time allocated buffer.
50378f82d1eSdrh **
5042479de3aSshane ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
50578f82d1eSdrh ** macros become no-ops and have zero performance impact.
50678f82d1eSdrh */
507075c23afSdanielk1977 #ifdef SQLITE_OMIT_WSD
508075c23afSdanielk1977   #define SQLITE_WSD const
509075c23afSdanielk1977   #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
510075c23afSdanielk1977   #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
511d1d38488Sdrh   int sqlite3_wsd_init(int N, int J);
512d1d38488Sdrh   void *sqlite3_wsd_find(void *K, int L);
513075c23afSdanielk1977 #else
514075c23afSdanielk1977   #define SQLITE_WSD
515075c23afSdanielk1977   #define GLOBAL(t,v) v
516075c23afSdanielk1977   #define sqlite3GlobalConfig sqlite3Config
517075c23afSdanielk1977 #endif
518075c23afSdanielk1977 
519f3d3c27aSdanielk1977 /*
520f3d3c27aSdanielk1977 ** The following macros are used to suppress compiler warnings and to
521f3d3c27aSdanielk1977 ** make it clear to human readers when a function parameter is deliberately
522f3d3c27aSdanielk1977 ** left unused within the body of a function. This usually happens when
523f3d3c27aSdanielk1977 ** a function is called via a function pointer. For example the
524f3d3c27aSdanielk1977 ** implementation of an SQL aggregate step callback may not use the
525f3d3c27aSdanielk1977 ** parameter indicating the number of arguments passed to the aggregate,
526f3d3c27aSdanielk1977 ** if it knows that this is enforced elsewhere.
527f3d3c27aSdanielk1977 **
528f3d3c27aSdanielk1977 ** When a function parameter is not used at all within the body of a function,
529f3d3c27aSdanielk1977 ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
530f3d3c27aSdanielk1977 ** However, these macros may also be used to suppress warnings related to
531f3d3c27aSdanielk1977 ** parameters that may or may not be used depending on compilation options.
532f3d3c27aSdanielk1977 ** For example those parameters only used in assert() statements. In these
533f3d3c27aSdanielk1977 ** cases the parameters are named as per the usual conventions.
534f3d3c27aSdanielk1977 */
53562c14b34Sdanielk1977 #define UNUSED_PARAMETER(x) (void)(x)
536f3d3c27aSdanielk1977 #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
53762c14b34Sdanielk1977 
538633e6d57Sdrh /*
53975897234Sdrh ** Forward references to structures
54075897234Sdrh */
54113449892Sdrh typedef struct AggInfo AggInfo;
542fe05af87Sdrh typedef struct AuthContext AuthContext;
543f5e7bb51Sdrh typedef struct Bitvec Bitvec;
5443d4501e5Sdrh typedef struct RowSet RowSet;
545fe05af87Sdrh typedef struct CollSeq CollSeq;
5467020f651Sdrh typedef struct Column Column;
547fe05af87Sdrh typedef struct Db Db;
548e501b89aSdanielk1977 typedef struct Schema Schema;
54975897234Sdrh typedef struct Expr Expr;
55075897234Sdrh typedef struct ExprList ExprList;
551c2eef3b3Sdrh typedef struct FKey FKey;
552fe05af87Sdrh typedef struct FuncDef FuncDef;
55370a8ca3cSdrh typedef struct FuncDefHash FuncDefHash;
554fe05af87Sdrh typedef struct IdList IdList;
555fe05af87Sdrh typedef struct Index Index;
5568d059845Sdanielk1977 typedef struct KeyClass KeyClass;
557d3d39e93Sdrh typedef struct KeyInfo KeyInfo;
558633e6d57Sdrh typedef struct Lookaside Lookaside;
559633e6d57Sdrh typedef struct LookasideSlot LookasideSlot;
560d1ab1ba5Sdanielk1977 typedef struct Module Module;
561626a879aSdrh typedef struct NameContext NameContext;
562fe05af87Sdrh typedef struct Parse Parse;
563fd7f0452Sdanielk1977 typedef struct Savepoint Savepoint;
564fe05af87Sdrh typedef struct Select Select;
565fe05af87Sdrh typedef struct SrcList SrcList;
566ade86483Sdrh typedef struct StrAccum StrAccum;
567fe05af87Sdrh typedef struct Table Table;
568c00da105Sdanielk1977 typedef struct TableLock TableLock;
569fe05af87Sdrh typedef struct Token Token;
570fe05af87Sdrh typedef struct TriggerStack TriggerStack;
571fe05af87Sdrh typedef struct TriggerStep TriggerStep;
572fe05af87Sdrh typedef struct Trigger Trigger;
573e63d9991Sdrh typedef struct UnpackedRecord UnpackedRecord;
5747d10d5a6Sdrh typedef struct Walker Walker;
575111a6a7dSdrh typedef struct WherePlan WherePlan;
576fe05af87Sdrh typedef struct WhereInfo WhereInfo;
577fe05af87Sdrh typedef struct WhereLevel WhereLevel;
578d3d39e93Sdrh 
5792dca4ac1Sdanielk1977 /*
5802dca4ac1Sdanielk1977 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
5812dca4ac1Sdanielk1977 ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
5822dca4ac1Sdanielk1977 ** pointer types (i.e. FuncDef) defined above.
5832dca4ac1Sdanielk1977 */
5842dca4ac1Sdanielk1977 #include "btree.h"
5852dca4ac1Sdanielk1977 #include "vdbe.h"
5862dca4ac1Sdanielk1977 #include "pager.h"
5878c0a791aSdanielk1977 #include "pcache.h"
5882dca4ac1Sdanielk1977 
5891cc5ed81Sdanielk1977 #include "os.h"
590c7ce76afSdrh #include "mutex.h"
5911cc5ed81Sdanielk1977 
592eee4c8caSdrh 
593001bbcbbSdrh /*
594001bbcbbSdrh ** Each database file to be accessed by the system is an instance
595001bbcbbSdrh ** of the following structure.  There are normally two of these structures
596001bbcbbSdrh ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
597a69d9168Sdrh ** aDb[1] is the database file used to hold temporary tables.  Additional
598a69d9168Sdrh ** databases may be attached.
599001bbcbbSdrh */
600001bbcbbSdrh struct Db {
601001bbcbbSdrh   char *zName;         /* Name of this database */
602001bbcbbSdrh   Btree *pBt;          /* The B*Tree structure for this database file */
603da184236Sdanielk1977   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
604467bcf36Sshane   u8 safety_level;     /* How aggressive at syncing data to disk */
605da184236Sdanielk1977   void *pAux;               /* Auxiliary data.  Usually NULL */
606da184236Sdanielk1977   void (*xFreeAux)(void*);  /* Routine to free pAux */
607e501b89aSdanielk1977   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
608da184236Sdanielk1977 };
609da184236Sdanielk1977 
610da184236Sdanielk1977 /*
611da184236Sdanielk1977 ** An instance of the following structure stores a database schema.
612a04a34ffSdanielk1977 **
613a04a34ffSdanielk1977 ** If there are no virtual tables configured in this schema, the
614a04a34ffSdanielk1977 ** Schema.db variable is set to NULL. After the first virtual table
615a04a34ffSdanielk1977 ** has been added, it is set to point to the database connection
616a04a34ffSdanielk1977 ** used to create the connection. Once a virtual table has been
617a04a34ffSdanielk1977 ** added to the Schema structure and the Schema.db variable populated,
618a04a34ffSdanielk1977 ** only that database connection may use the Schema to prepare
619a04a34ffSdanielk1977 ** statements.
620da184236Sdanielk1977 */
621e501b89aSdanielk1977 struct Schema {
622001bbcbbSdrh   int schema_cookie;   /* Database schema version number for this file */
623d24cc427Sdrh   Hash tblHash;        /* All tables indexed by name */
624d24cc427Sdrh   Hash idxHash;        /* All (named) indices indexed by name */
625d24cc427Sdrh   Hash trigHash;       /* All triggers indexed by name */
626d24cc427Sdrh   Hash aFKey;          /* Foreign keys indexed by to-table */
6274794f735Sdrh   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
628da184236Sdanielk1977   u8 file_format;      /* Schema format version for this file */
6298079a0d3Sdrh   u8 enc;              /* Text encoding used by this database */
630da184236Sdanielk1977   u16 flags;           /* Flags associated with this schema */
63114db2665Sdanielk1977   int cache_size;      /* Number of pages to use in the cache */
632a04a34ffSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
633a04a34ffSdanielk1977   sqlite3 *db;         /* "Owner" connection. See comment above */
634a04a34ffSdanielk1977 #endif
635001bbcbbSdrh };
63675897234Sdrh 
63775897234Sdrh /*
6388bf8dc92Sdrh ** These macros can be used to test, set, or clear bits in the
6398bf8dc92Sdrh ** Db.flags field.
6408bf8dc92Sdrh */
641da184236Sdanielk1977 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
642da184236Sdanielk1977 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
643da184236Sdanielk1977 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
644da184236Sdanielk1977 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
6458bf8dc92Sdrh 
6468bf8dc92Sdrh /*
6478bf8dc92Sdrh ** Allowed values for the DB.flags field.
6488bf8dc92Sdrh **
6498bf8dc92Sdrh ** The DB_SchemaLoaded flag is set after the database schema has been
6508bf8dc92Sdrh ** read into internal hash tables.
6518bf8dc92Sdrh **
6528bf8dc92Sdrh ** DB_UnresetViews means that one or more views have column names that
6538bf8dc92Sdrh ** have been filled out.  If the schema changes, these column names might
6548bf8dc92Sdrh ** changes and so the view will need to be reset.
6558bf8dc92Sdrh */
656124b27e6Sdrh #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
657124b27e6Sdrh #define DB_UnresetViews    0x0002  /* Some views have defined column names */
658b82e7edaSdanielk1977 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
6598bf8dc92Sdrh 
660caa639f4Sdrh /*
661caa639f4Sdrh ** The number of different kinds of things that can be limited
662caa639f4Sdrh ** using the sqlite3_limit() interface.
663caa639f4Sdrh */
664caa639f4Sdrh #define SQLITE_N_LIMIT (SQLITE_LIMIT_VARIABLE_NUMBER+1)
6658bf8dc92Sdrh 
6668bf8dc92Sdrh /*
667633e6d57Sdrh ** Lookaside malloc is a set of fixed-size buffers that can be used
668467bcf36Sshane ** to satisfy small transient memory allocation requests for objects
669633e6d57Sdrh ** associated with a particular database connection.  The use of
670633e6d57Sdrh ** lookaside malloc provides a significant performance enhancement
671633e6d57Sdrh ** (approx 10%) by avoiding numerous malloc/free requests while parsing
672633e6d57Sdrh ** SQL statements.
673633e6d57Sdrh **
674633e6d57Sdrh ** The Lookaside structure holds configuration information about the
675633e6d57Sdrh ** lookaside malloc subsystem.  Each available memory allocation in
676633e6d57Sdrh ** the lookaside subsystem is stored on a linked list of LookasideSlot
677633e6d57Sdrh ** objects.
678633e6d57Sdrh */
679633e6d57Sdrh struct Lookaside {
680633e6d57Sdrh   u16 sz;                 /* Size of each buffer in bytes */
681633e6d57Sdrh   u8 bEnabled;            /* True if use lookaside.  False to ignore it */
682e9d1c720Sdrh   u8 bMalloced;           /* True if pStart obtained from sqlite3_malloc() */
683633e6d57Sdrh   int nOut;               /* Number of buffers currently checked out */
684633e6d57Sdrh   int mxOut;              /* Highwater mark for nOut */
6857d10d5a6Sdrh   LookasideSlot *pFree;   /* List of available buffers */
686633e6d57Sdrh   void *pStart;           /* First byte of available memory space */
687633e6d57Sdrh   void *pEnd;             /* First byte past end of available space */
688633e6d57Sdrh };
689633e6d57Sdrh struct LookasideSlot {
690633e6d57Sdrh   LookasideSlot *pNext;    /* Next buffer in the list of free buffers */
691633e6d57Sdrh };
692633e6d57Sdrh 
693633e6d57Sdrh /*
69470a8ca3cSdrh ** A hash table for function definitions.
69570a8ca3cSdrh **
69670a8ca3cSdrh ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
69770a8ca3cSdrh ** Collisions are on the FuncDef.pHash chain.
69870a8ca3cSdrh */
69970a8ca3cSdrh struct FuncDefHash {
70070a8ca3cSdrh   FuncDef *a[23];       /* Hash table for functions */
70170a8ca3cSdrh };
70270a8ca3cSdrh 
70370a8ca3cSdrh /*
704c9b84a1fSdrh ** Each database is an instance of the following structure.
705c9b84a1fSdrh **
706b0c374ffSrdc ** The sqlite.lastRowid records the last insert rowid generated by an
707b0c374ffSrdc ** insert statement.  Inserts on views do not affect its value.  Each
708b0c374ffSrdc ** trigger has its own context, so that lastRowid can be updated inside
709b0c374ffSrdc ** triggers as usual.  The previous value will be restored once the trigger
710b0c374ffSrdc ** exits.  Upon entering a before or instead of trigger, lastRowid is no
711b0c374ffSrdc ** longer (since after version 2.8.12) reset to -1.
712b0c374ffSrdc **
713b0c374ffSrdc ** The sqlite.nChange does not count changes within triggers and keeps no
7146f8a503dSdanielk1977 ** context.  It is reset at start of sqlite3_exec.
715b0c374ffSrdc ** The sqlite.lsChange represents the number of changes made by the last
716b0c374ffSrdc ** insert, update, or delete statement.  It remains constant throughout the
717b0c374ffSrdc ** length of a statement and is then updated by OP_SetCounts.  It keeps a
718b0c374ffSrdc ** context stack just like lastRowid so that the count of changes
719b0c374ffSrdc ** within a trigger is not seen outside the trigger.  Changes to views do not
720b0c374ffSrdc ** affect the value of lsChange.
721b0c374ffSrdc ** The sqlite.csChange keeps track of the number of current changes (since
722b0c374ffSrdc ** the last statement) and is used to update sqlite_lsChange.
7236622cce3Sdanielk1977 **
7246622cce3Sdanielk1977 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
7256622cce3Sdanielk1977 ** store the most recent error code and, if applicable, string. The
7266622cce3Sdanielk1977 ** internal function sqlite3Error() is used to set these variables
7276622cce3Sdanielk1977 ** consistently.
72875897234Sdrh */
7299bb575fdSdrh struct sqlite3 {
73090f6a5beSdrh   sqlite3_vfs *pVfs;            /* OS Interface */
731001bbcbbSdrh   int nDb;                      /* Number of backends currently in use */
732001bbcbbSdrh   Db *aDb;                      /* All backends */
733467bcf36Sshane   int flags;                    /* Miscellaneous flags. See below */
73433f4e02aSdrh   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
735fcd35c7bSdrh   int errCode;                  /* Most recent error code (SQLITE_*) */
7364ac285a1Sdrh   int errMask;                  /* & result codes with this before returning */
737fcd35c7bSdrh   u8 autoCommit;                /* The auto-commit flag. */
73890f5ecb3Sdrh   u8 temp_store;                /* 1: file 2: memory 0: default */
73917435752Sdrh   u8 mallocFailed;              /* True if we have seen a malloc failure */
7403b02013eSdrh   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
7413b02013eSdrh   u8 dfltJournalMode;           /* Default journal mode for attached dbs */
74298757157Sdrh   signed char nextAutovac;      /* Autovac setting after VACUUM if >=0 */
743f653d782Sdanielk1977   int nextPagesize;             /* Pagesize after VACUUM if >0 */
7442803757aSdrh   int nTable;                   /* Number of tables in the database */
745d3d39e93Sdrh   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
746f328bc80Sdrh   i64 lastRowid;                /* ROWID of most recent insert (see above) */
747f328bc80Sdrh   i64 priorNewRowid;            /* Last randomly generated ROWID */
74864202cfeSdanielk1977   u32 magic;                    /* Magic number for detect library misuse */
749b28af71aSdanielk1977   int nChange;                  /* Value returned by sqlite3_changes() */
750b28af71aSdanielk1977   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
751d677b3d6Sdrh   sqlite3_mutex *mutex;         /* Connection mutex */
752caa639f4Sdrh   int aLimit[SQLITE_N_LIMIT];   /* Limits */
7534adee20fSdanielk1977   struct sqlite3InitInfo {      /* Information used during initialization */
7541d85d931Sdrh     int iDb;                    /* When back is being initialized */
7551d85d931Sdrh     int newTnum;                /* Rootpage of table being initialized */
7561d85d931Sdrh     u8 busy;                    /* TRUE if currently initializing */
7571d85d931Sdrh   } init;
758f1952c5dSdrh   int nExtension;               /* Number of loaded extensions */
759467bcf36Sshane   void **aExtension;            /* Array of shared library handles */
760326dce74Sdrh   struct Vdbe *pVdbe;           /* List of active virtual machines */
761467bcf36Sshane   int activeVdbeCnt;            /* Number of VDBEs currently executing */
762ad4a4b80Sdrh   int writeVdbeCnt;             /* Number of active VDBEs that are writing */
76318de4824Sdrh   void (*xTrace)(void*,const char*);        /* Trace function */
76418de4824Sdrh   void *pTraceArg;                          /* Argument to the trace function */
76519e2d37fSdrh   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
76619e2d37fSdrh   void *pProfileArg;                        /* Argument to profile function */
767fcd35c7bSdrh   void *pCommitArg;                 /* Argument to xCommitCallback() */
768fcd35c7bSdrh   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
76971fd80bfSdanielk1977   void *pRollbackArg;               /* Argument to xRollbackCallback() */
77071fd80bfSdanielk1977   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
77194eb6a14Sdanielk1977   void *pUpdateArg;
77294eb6a14Sdanielk1977   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
773fcd35c7bSdrh   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
774fcd35c7bSdrh   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
775fcd35c7bSdrh   void *pCollNeededArg;
776fcd35c7bSdrh   sqlite3_value *pErr;          /* Most recent error message */
777fcd35c7bSdrh   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
778fcd35c7bSdrh   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
779881feaa0Sdrh   union {
78039001e75Sdrh     volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
781881feaa0Sdrh     double notUsed1;            /* Spacer */
782881feaa0Sdrh   } u1;
783633e6d57Sdrh   Lookaside lookaside;          /* Lookaside malloc configuration */
784ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
785e22a334bSdrh   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
786e22a334bSdrh                                 /* Access authorization function */
787ed6c8671Sdrh   void *pAuthArg;               /* 1st argument to the access auth function */
788ed6c8671Sdrh #endif
789348bb5d6Sdanielk1977 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
790348bb5d6Sdanielk1977   int (*xProgress)(void *);     /* The progress callback */
791348bb5d6Sdanielk1977   void *pProgressArg;           /* Argument to the progress callback */
792348bb5d6Sdanielk1977   int nProgressOps;             /* Number of opcodes for progress callback */
793348bb5d6Sdanielk1977 #endif
794b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
795b9bb7c18Sdrh   Hash aModule;                 /* populated by sqlite3_create_module() */
7967e6ebfb2Sdanielk1977   Table *pVTab;                 /* vtab with active Connect/Create method */
797f9e7dda7Sdanielk1977   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
798f9e7dda7Sdanielk1977   int nVTrans;                  /* Allocated size of aVTrans */
7996b456a2bSdanielk1977 #endif
80070a8ca3cSdrh   FuncDefHash aFunc;            /* Hash table of connection functions */
801fcd35c7bSdrh   Hash aCollSeq;                /* All collating sequences */
802fcd35c7bSdrh   BusyHandler busyHandler;      /* Busy callback */
80397903fefSdrh   int busyTimeout;              /* Busy handler timeout, in msec */
804fcd35c7bSdrh   Db aDbStatic[2];              /* Static space for the 2 default backends */
8057e900abfSdanielk1977 #ifdef SQLITE_SSE
8067e900abfSdanielk1977   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
8077e900abfSdanielk1977 #endif
808fd7f0452Sdanielk1977   Savepoint *pSavepoint;        /* List of active savepoints */
809fd7f0452Sdanielk1977   int nSavepoint;               /* Number of non-transaction savepoints */
810*bd43455cSdanielk1977   int nStatement;               /* Number of nested statement-transactions  */
811fd7f0452Sdanielk1977   u8 isTransactionSavepoint;    /* True if the outermost savepoint is a TS */
812404ca075Sdanielk1977 
813404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
814404ca075Sdanielk1977   /* The following variables are all protected by the STATIC_MASTER
815404ca075Sdanielk1977   ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
816404ca075Sdanielk1977   */
817404ca075Sdanielk1977   sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
818404ca075Sdanielk1977   sqlite3 *pUnlockConnection;           /* Connection to watch for unlock */
819404ca075Sdanielk1977   void *pUnlockArg;                     /* Argument to xUnlockNotify */
820404ca075Sdanielk1977   void (*xUnlockNotify)(void **, int);  /* Unlock notify callback */
821404ca075Sdanielk1977   sqlite3 *pNextBlocked;        /* Next in list of all blocked connections */
822404ca075Sdanielk1977 #endif
82375897234Sdrh };
82475897234Sdrh 
82503b808a6Sdrh /*
82603b808a6Sdrh ** A macro to discover the encoding of a database.
82703b808a6Sdrh */
82814db2665Sdanielk1977 #define ENC(db) ((db)->aDb[0].pSchema->enc)
82914db2665Sdanielk1977 
83075897234Sdrh /*
8318bf8dc92Sdrh ** Possible values for the sqlite.flags and or Db.flags fields.
8328bf8dc92Sdrh **
8338bf8dc92Sdrh ** On sqlite.flags, the SQLITE_InTrans value means that we have
8348bf8dc92Sdrh ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
8358bf8dc92Sdrh ** transaction is active on that particular database file.
83675897234Sdrh */
8374c504391Sdrh #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
838c4a3c779Sdrh #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
8395e00f6c7Sdrh #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
840382c0247Sdrh #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
841fcabd464Sdrh #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
842fcabd464Sdrh #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
8431bee3d7bSdrh                                           /*   DELETE, or UPDATE and return */
8441bee3d7bSdrh                                           /*   the count using a callback. */
845fcabd464Sdrh #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
8466a535340Sdrh                                           /*   result set is empty */
84735d4c2f4Sdrh #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
84835d4c2f4Sdrh #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
849f404083eSdrh #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
8507bec505eSdrh #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
8517bec505eSdrh                                           ** accessing read-only databases */
8520cd2d4c9Sdrh #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
853da184236Sdanielk1977 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
854e321c29aSdrh #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
855ac530b1aSdrh #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
856c2e87a3eSdrh #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
85758b9576bSdrh 
85834c68fbaSdanielk1977 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
8594a50aac5Sdrh #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
8604a50aac5Sdrh #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
861853799a2Sdrh #define SQLITE_CommitBusy     0x00200000  /* In the process of committing */
862699b3d4fSdrh #define SQLITE_ReverseOrder   0x00400000  /* Reverse unordered SELECTs */
86334c68fbaSdanielk1977 
86458b9576bSdrh /*
865247be43dSdrh ** Possible values for the sqlite.magic field.
866247be43dSdrh ** The numbers are obtained at random and have no special meaning, other
867247be43dSdrh ** than being distinct from one another.
868247be43dSdrh */
869247be43dSdrh #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
870247be43dSdrh #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
8717e8b848aSdrh #define SQLITE_MAGIC_SICK     0x4b771290  /* Error and awaiting close */
872247be43dSdrh #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
873247be43dSdrh #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
874247be43dSdrh 
875247be43dSdrh /*
8760bce8354Sdrh ** Each SQL function is defined by an instance of the following
8770bce8354Sdrh ** structure.  A pointer to this structure is stored in the sqlite.aFunc
8788e0a2f90Sdrh ** hash table.  When multiple functions have the same name, the hash table
8798e0a2f90Sdrh ** points to a linked list of these structures.
8802803757aSdrh */
8810bce8354Sdrh struct FuncDef {
882e82f5d04Sdrh   i16 nArg;            /* Number of arguments.  -1 means unlimited */
883d8123366Sdanielk1977   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
88455ef4d97Sdrh   u8 flags;            /* Some combination of SQLITE_FUNC_* */
8851350b030Sdrh   void *pUserData;     /* User data parameter */
8860bce8354Sdrh   FuncDef *pNext;      /* Next function with same name */
887f9b596ebSdrh   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
888f9b596ebSdrh   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
889467bcf36Sshane   void (*xFinalize)(sqlite3_context*);                /* Aggregate finalizer */
8908c0a791aSdanielk1977   char *zName;         /* SQL name of the function. */
89170a8ca3cSdrh   FuncDef *pHash;      /* Next with a different name but the same hash */
8928e0a2f90Sdrh };
8932803757aSdrh 
8942803757aSdrh /*
8957d10d5a6Sdrh ** Possible values for FuncDef.flags
8967d10d5a6Sdrh */
8977d10d5a6Sdrh #define SQLITE_FUNC_LIKE     0x01 /* Candidate for the LIKE optimization */
8987d10d5a6Sdrh #define SQLITE_FUNC_CASE     0x02 /* Case-sensitive LIKE-type function */
899467bcf36Sshane #define SQLITE_FUNC_EPHEM    0x04 /* Ephemeral.  Delete with VDBE */
900e82f5d04Sdrh #define SQLITE_FUNC_NEEDCOLL 0x08 /* sqlite3GetFuncCollSeq() might be called */
901d1fa7bcaSdrh #define SQLITE_FUNC_PRIVATE  0x10 /* Allowed for internal use only */
902a5533162Sdanielk1977 #define SQLITE_FUNC_COUNT    0x20 /* Built-in count(*) aggregate */
9037d10d5a6Sdrh 
9047d10d5a6Sdrh /*
905777c5386Sdrh ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
906777c5386Sdrh ** used to create the initializers for the FuncDef structures.
907777c5386Sdrh **
908777c5386Sdrh **   FUNCTION(zName, nArg, iArg, bNC, xFunc)
909777c5386Sdrh **     Used to create a scalar function definition of a function zName
910777c5386Sdrh **     implemented by C function xFunc that accepts nArg arguments. The
911777c5386Sdrh **     value passed as iArg is cast to a (void*) and made available
912777c5386Sdrh **     as the user-data (sqlite3_user_data()) for the function. If
913777c5386Sdrh **     argument bNC is true, then the FuncDef.needCollate flag is set.
914777c5386Sdrh **
915777c5386Sdrh **   AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
916777c5386Sdrh **     Used to create an aggregate function definition implemented by
917777c5386Sdrh **     the C functions xStep and xFinal. The first four parameters
918777c5386Sdrh **     are interpreted in the same way as the first 4 parameters to
919777c5386Sdrh **     FUNCTION().
920777c5386Sdrh **
921777c5386Sdrh **   LIKEFUNC(zName, nArg, pArg, flags)
922777c5386Sdrh **     Used to create a scalar function definition of a function zName
923777c5386Sdrh **     that accepts nArg arguments and is implemented by a call to C
924777c5386Sdrh **     function likeFunc. Argument pArg is cast to a (void *) and made
925777c5386Sdrh **     available as the function user-data (sqlite3_user_data()). The
926777c5386Sdrh **     FuncDef.flags variable is set to the value passed as the flags
927777c5386Sdrh **     parameter.
928777c5386Sdrh */
929777c5386Sdrh #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
930cdcfe95cSdanielk1977   {nArg, SQLITE_UTF8, bNC*8, SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, 0, #zName, 0}
93121717ed6Sdrh #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
932cdcfe95cSdanielk1977   {nArg, SQLITE_UTF8, bNC*8, pArg, 0, xFunc, 0, 0, #zName, 0}
933777c5386Sdrh #define LIKEFUNC(zName, nArg, arg, flags) \
934cdcfe95cSdanielk1977   {nArg, SQLITE_UTF8, flags, (void *)arg, 0, likeFunc, 0, 0, #zName, 0}
935777c5386Sdrh #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
936cdcfe95cSdanielk1977   {nArg, SQLITE_UTF8, nc*8, SQLITE_INT_TO_PTR(arg), 0, 0, xStep,xFinal,#zName,0}
937777c5386Sdrh 
938fd7f0452Sdanielk1977 /*
939fd7f0452Sdanielk1977 ** All current savepoints are stored in a linked list starting at
940fd7f0452Sdanielk1977 ** sqlite3.pSavepoint. The first element in the list is the most recently
941fd7f0452Sdanielk1977 ** opened savepoint. Savepoints are added to the list by the vdbe
942fd7f0452Sdanielk1977 ** OP_Savepoint instruction.
943fd7f0452Sdanielk1977 */
944fd7f0452Sdanielk1977 struct Savepoint {
945fd7f0452Sdanielk1977   char *zName;                        /* Savepoint name (nul-terminated) */
946fd7f0452Sdanielk1977   Savepoint *pNext;                   /* Parent savepoint (if any) */
947fd7f0452Sdanielk1977 };
948fd7f0452Sdanielk1977 
949fd7f0452Sdanielk1977 /*
950fd7f0452Sdanielk1977 ** The following are used as the second parameter to sqlite3Savepoint(),
951fd7f0452Sdanielk1977 ** and as the P1 argument to the OP_Savepoint instruction.
952fd7f0452Sdanielk1977 */
953fd7f0452Sdanielk1977 #define SAVEPOINT_BEGIN      0
954fd7f0452Sdanielk1977 #define SAVEPOINT_RELEASE    1
955fd7f0452Sdanielk1977 #define SAVEPOINT_ROLLBACK   2
956fd7f0452Sdanielk1977 
957777c5386Sdrh 
958777c5386Sdrh /*
959d1ab1ba5Sdanielk1977 ** Each SQLite module (virtual table definition) is defined by an
960d1ab1ba5Sdanielk1977 ** instance of the following structure, stored in the sqlite3.aModule
961d1ab1ba5Sdanielk1977 ** hash table.
962d1ab1ba5Sdanielk1977 */
963d1ab1ba5Sdanielk1977 struct Module {
964d1ab1ba5Sdanielk1977   const sqlite3_module *pModule;       /* Callback pointers */
965d1ab1ba5Sdanielk1977   const char *zName;                   /* Name passed to create_module() */
966d1ab1ba5Sdanielk1977   void *pAux;                          /* pAux passed to create_module() */
967832a58a6Sdanielk1977   void (*xDestroy)(void *);            /* Module destructor function */
968d1ab1ba5Sdanielk1977 };
969d1ab1ba5Sdanielk1977 
970d1ab1ba5Sdanielk1977 /*
971967e8b73Sdrh ** information about each column of an SQL table is held in an instance
9727020f651Sdrh ** of this structure.
9737020f651Sdrh */
9747020f651Sdrh struct Column {
9757020f651Sdrh   char *zName;     /* Name of this column */
9767977a17fSdanielk1977   Expr *pDflt;     /* Default value of this column */
977382c0247Sdrh   char *zType;     /* Data type for this column */
978b3bf556eSdanielk1977   char *zColl;     /* Collating sequence.  If NULL, use the default */
9794a32431cSdrh   u8 notNull;      /* True if there is a NOT NULL constraint */
98078100cc9Sdrh   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
981a37cdde0Sdanielk1977   char affinity;   /* One of the SQLITE_AFF_... values */
982034ca14fSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
983034ca14fSdanielk1977   u8 isHidden;     /* True if this column is 'hidden' */
984034ca14fSdanielk1977 #endif
9857020f651Sdrh };
9867020f651Sdrh 
9877020f651Sdrh /*
988a9fd84b0Sdrh ** A "Collating Sequence" is defined by an instance of the following
9890202b29eSdanielk1977 ** structure. Conceptually, a collating sequence consists of a name and
9900202b29eSdanielk1977 ** a comparison routine that defines the order of that sequence.
991a9fd84b0Sdrh **
992467bcf36Sshane ** There may two separate implementations of the collation function, one
9930202b29eSdanielk1977 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
9940202b29eSdanielk1977 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
9950202b29eSdanielk1977 ** native byte order. When a collation sequence is invoked, SQLite selects
9960202b29eSdanielk1977 ** the version that will require the least expensive encoding
997b3bf556eSdanielk1977 ** translations, if any.
9980202b29eSdanielk1977 **
9990202b29eSdanielk1977 ** The CollSeq.pUser member variable is an extra parameter that passed in
10000202b29eSdanielk1977 ** as the first argument to the UTF-8 comparison function, xCmp.
10010202b29eSdanielk1977 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
10020202b29eSdanielk1977 ** xCmp16.
10030202b29eSdanielk1977 **
10040202b29eSdanielk1977 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
10050202b29eSdanielk1977 ** collating sequence is undefined.  Indices built on an undefined
10060202b29eSdanielk1977 ** collating sequence may not be read or written.
1007a9fd84b0Sdrh */
1008a9fd84b0Sdrh struct CollSeq {
10090202b29eSdanielk1977   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
1010466be56bSdanielk1977   u8 enc;               /* Text encoding handled by xCmp() */
1011d64fe2f3Sdrh   u8 type;              /* One of the SQLITE_COLL_... values below */
1012a9fd84b0Sdrh   void *pUser;          /* First argument to xCmp() */
10130202b29eSdanielk1977   int (*xCmp)(void*,int, const void*, int, const void*);
1014a9808b31Sdanielk1977   void (*xDel)(void*);  /* Destructor for pUser */
1015a9fd84b0Sdrh };
1016a9fd84b0Sdrh 
1017a9fd84b0Sdrh /*
10187d10d5a6Sdrh ** Allowed values of CollSeq.type:
1019d64fe2f3Sdrh */
1020d64fe2f3Sdrh #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
1021d64fe2f3Sdrh #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
1022d64fe2f3Sdrh #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
1023d64fe2f3Sdrh #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
1024d64fe2f3Sdrh 
1025d64fe2f3Sdrh /*
1026d3d39e93Sdrh ** A sort order can be either ASC or DESC.
10278e2ca029Sdrh */
10288e2ca029Sdrh #define SQLITE_SO_ASC       0  /* Sort in ascending order */
1029d3d39e93Sdrh #define SQLITE_SO_DESC      1  /* Sort in ascending order */
10308e2ca029Sdrh 
10318e2ca029Sdrh /*
1032a37cdde0Sdanielk1977 ** Column affinity types.
10338a51256cSdrh **
10348a51256cSdrh ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
10358a51256cSdrh ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
10367d10d5a6Sdrh ** the speed a little by numbering the values consecutively.
10378a51256cSdrh **
10388a51256cSdrh ** But rather than start with 0 or 1, we begin with 'a'.  That way,
10398a51256cSdrh ** when multiple affinity types are concatenated into a string and
104066a5167bSdrh ** used as the P4 operand, they will be more readable.
10418a51256cSdrh **
10428a51256cSdrh ** Note also that the numeric types are grouped together so that testing
10438a51256cSdrh ** for a numeric type is a single comparison.
1044a37cdde0Sdanielk1977 */
10458a51256cSdrh #define SQLITE_AFF_TEXT     'a'
10468a51256cSdrh #define SQLITE_AFF_NONE     'b'
10478a51256cSdrh #define SQLITE_AFF_NUMERIC  'c'
10488a51256cSdrh #define SQLITE_AFF_INTEGER  'd'
10498a51256cSdrh #define SQLITE_AFF_REAL     'e'
1050a37cdde0Sdanielk1977 
10518a51256cSdrh #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
1052a37cdde0Sdanielk1977 
1053a37cdde0Sdanielk1977 /*
105435573356Sdrh ** The SQLITE_AFF_MASK values masks off the significant bits of an
105535573356Sdrh ** affinity value.
105635573356Sdrh */
105735573356Sdrh #define SQLITE_AFF_MASK     0x67
105835573356Sdrh 
105935573356Sdrh /*
106035573356Sdrh ** Additional bit values that can be ORed with an affinity without
106135573356Sdrh ** changing the affinity.
106235573356Sdrh */
106335573356Sdrh #define SQLITE_JUMPIFNULL   0x08  /* jumps if either operand is NULL */
106493a960a0Sdrh #define SQLITE_STOREP2      0x10  /* Store result in reg[P2] rather than jump */
106535573356Sdrh 
106635573356Sdrh /*
106722f70c32Sdrh ** Each SQL table is represented in memory by an instance of the
106822f70c32Sdrh ** following structure.
106922f70c32Sdrh **
1070d24cc427Sdrh ** Table.zName is the name of the table.  The case of the original
107122f70c32Sdrh ** CREATE TABLE statement is stored, but case is not significant for
107222f70c32Sdrh ** comparisons.
107322f70c32Sdrh **
1074d24cc427Sdrh ** Table.nCol is the number of columns in this table.  Table.aCol is a
107522f70c32Sdrh ** pointer to an array of Column structures, one for each column.
107622f70c32Sdrh **
1077d24cc427Sdrh ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
1078d24cc427Sdrh ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
107922f70c32Sdrh ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
108022f70c32Sdrh ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
108122f70c32Sdrh ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
10827d10d5a6Sdrh ** is generated for each row of the table.  TF_HasPrimaryKey is set if
108322f70c32Sdrh ** the table has any PRIMARY KEY, INTEGER or otherwise.
108422f70c32Sdrh **
1085d24cc427Sdrh ** Table.tnum is the page number for the root BTree page of the table in the
1086d24cc427Sdrh ** database file.  If Table.iDb is the index of the database table backend
1087d24cc427Sdrh ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
10887d10d5a6Sdrh ** holds temporary tables and indices.  If TF_Ephemeral is set
10897d10d5a6Sdrh ** then the table is stored in a file that is automatically deleted
1090d24cc427Sdrh ** when the VDBE cursor to the table is closed.  In this case Table.tnum
109122f70c32Sdrh ** refers VDBE cursor number that holds the table open, not to the root
109222f70c32Sdrh ** page number.  Transient tables are used to hold the results of a
109322f70c32Sdrh ** sub-query that appears instead of a real table name in the FROM clause
109422f70c32Sdrh ** of a SELECT statement.
109575897234Sdrh */
109675897234Sdrh struct Table {
1097633e6d57Sdrh   sqlite3 *db;         /* Associated database connection.  Might be NULL. */
10987d10d5a6Sdrh   char *zName;         /* Name of the table or view */
10997d10d5a6Sdrh   int iPKey;           /* If not negative, use aCol[iPKey] as the primary key */
110075897234Sdrh   int nCol;            /* Number of columns in this table */
11017020f651Sdrh   Column *aCol;        /* Information about each column */
1102967e8b73Sdrh   Index *pIndex;       /* List of SQL indexes on this table. */
110322f70c32Sdrh   int tnum;            /* Root BTree node for this table (see note above) */
1104a76b5dfcSdrh   Select *pSelect;     /* NULL for tables.  Points to definition if a view. */
11057d10d5a6Sdrh   u16 nRef;            /* Number of pointers to this Table */
11067d10d5a6Sdrh   u8 tabFlags;         /* Mask of TF_* values */
11077d10d5a6Sdrh   u8 keyConf;          /* What to do in case of uniqueness conflict on iPKey */
1108c2eef3b3Sdrh   FKey *pFKey;         /* Linked list of all foreign keys in this table */
11093d1bfeaaSdanielk1977   char *zColAff;       /* String defining the affinity of each column */
1110ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
1111ffe07b2dSdrh   Expr *pCheck;        /* The AND of all CHECK constraints */
1112ffe07b2dSdrh #endif
111319a8e7e8Sdanielk1977 #ifndef SQLITE_OMIT_ALTERTABLE
11147d10d5a6Sdrh   int addColOffset;    /* Offset in CREATE TABLE stmt to add a new column */
111519a8e7e8Sdanielk1977 #endif
1116e09daa90Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1117d1ab1ba5Sdanielk1977   Module *pMod;        /* Pointer to the implementation of the module */
1118b9bb7c18Sdrh   sqlite3_vtab *pVtab; /* Pointer to the module instance */
1119b9bb7c18Sdrh   int nModuleArg;      /* Number of arguments to the module */
1120b9bb7c18Sdrh   char **azModuleArg;  /* Text of all module args. [0] is module name */
1121e09daa90Sdrh #endif
11222f886d1dSdanielk1977   Trigger *pTrigger;   /* List of triggers stored in pSchema */
1123728b5779Sdrh   Schema *pSchema;     /* Schema that contains this table */
1124588a9a1aSdrh   Table *pNextZombie;  /* Next on the Parse.pZombieTab list */
112575897234Sdrh };
112675897234Sdrh 
112775897234Sdrh /*
11287d10d5a6Sdrh ** Allowed values for Tabe.tabFlags.
11297d10d5a6Sdrh */
11307d10d5a6Sdrh #define TF_Readonly        0x01    /* Read-only system table */
1131467bcf36Sshane #define TF_Ephemeral       0x02    /* An ephemeral table */
11327d10d5a6Sdrh #define TF_HasPrimaryKey   0x04    /* Table has a primary key */
11337d10d5a6Sdrh #define TF_Autoincrement   0x08    /* Integer primary key is autoincrement */
11347d10d5a6Sdrh #define TF_Virtual         0x10    /* Is a virtual table */
11357d10d5a6Sdrh #define TF_NeedMetadata    0x20    /* aCol[].zType and aCol[].pColl missing */
11367d10d5a6Sdrh 
11377d10d5a6Sdrh 
11387d10d5a6Sdrh 
11397d10d5a6Sdrh /*
11404cbdda9eSdrh ** Test to see whether or not a table is a virtual table.  This is
11414cbdda9eSdrh ** done as a macro so that it will be optimized out when virtual
11424cbdda9eSdrh ** table support is omitted from the build.
11434cbdda9eSdrh */
11444cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
11457d10d5a6Sdrh #  define IsVirtual(X)      (((X)->tabFlags & TF_Virtual)!=0)
1146034ca14fSdanielk1977 #  define IsHiddenColumn(X) ((X)->isHidden)
11474cbdda9eSdrh #else
11484cbdda9eSdrh #  define IsVirtual(X)      0
1149034ca14fSdanielk1977 #  define IsHiddenColumn(X) 0
11504cbdda9eSdrh #endif
11514cbdda9eSdrh 
11524cbdda9eSdrh /*
1153c2eef3b3Sdrh ** Each foreign key constraint is an instance of the following structure.
1154c2eef3b3Sdrh **
1155c2eef3b3Sdrh ** A foreign key is associated with two tables.  The "from" table is
1156c2eef3b3Sdrh ** the table that contains the REFERENCES clause that creates the foreign
1157c2eef3b3Sdrh ** key.  The "to" table is the table that is named in the REFERENCES clause.
1158c2eef3b3Sdrh ** Consider this example:
1159c2eef3b3Sdrh **
1160c2eef3b3Sdrh **     CREATE TABLE ex1(
1161c2eef3b3Sdrh **       a INTEGER PRIMARY KEY,
1162c2eef3b3Sdrh **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
1163c2eef3b3Sdrh **     );
1164c2eef3b3Sdrh **
1165c2eef3b3Sdrh ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
1166c2eef3b3Sdrh **
1167c2eef3b3Sdrh ** Each REFERENCES clause generates an instance of the following structure
1168c2eef3b3Sdrh ** which is attached to the from-table.  The to-table need not exist when
1169467bcf36Sshane ** the from-table is created.  The existence of the to-table is not checked
1170c2eef3b3Sdrh ** until an attempt is made to insert data into the from-table.
1171c2eef3b3Sdrh **
1172ea1ba17cSdrh ** The sqlite.aFKey hash table stores pointers to this structure
1173c2eef3b3Sdrh ** given the name of a to-table.  For each to-table, all foreign keys
1174c2eef3b3Sdrh ** associated with that table are on a linked list using the FKey.pNextTo
1175c2eef3b3Sdrh ** field.
1176c2eef3b3Sdrh */
1177c2eef3b3Sdrh struct FKey {
1178467bcf36Sshane   Table *pFrom;     /* The table that contains the REFERENCES clause */
1179c2eef3b3Sdrh   FKey *pNextFrom;  /* Next foreign key in pFrom */
1180c2eef3b3Sdrh   char *zTo;        /* Name of table that the key points to */
1181c2eef3b3Sdrh   FKey *pNextTo;    /* Next foreign key that points to zTo */
1182c2eef3b3Sdrh   int nCol;         /* Number of columns in this key */
1183c2eef3b3Sdrh   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
1184c2eef3b3Sdrh     int iFrom;         /* Index of column in pFrom */
1185c2eef3b3Sdrh     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
1186c2eef3b3Sdrh   } *aCol;          /* One entry for each of nCol column s */
1187c2eef3b3Sdrh   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
1188c2eef3b3Sdrh   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
1189c2eef3b3Sdrh   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
1190c2eef3b3Sdrh   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
1191c2eef3b3Sdrh };
1192c2eef3b3Sdrh 
1193c2eef3b3Sdrh /*
1194aaa40c1cSdanielk1977 ** SQLite supports many different ways to resolve a constraint
119522f70c32Sdrh ** error.  ROLLBACK processing means that a constraint violation
11960bd1f4eaSdrh ** causes the operation in process to fail and for the current transaction
11971c92853dSdrh ** to be rolled back.  ABORT processing means the operation in process
11981c92853dSdrh ** fails and any prior changes from that one operation are backed out,
11991c92853dSdrh ** but the transaction is not rolled back.  FAIL processing means that
12001c92853dSdrh ** the operation in progress stops and returns an error code.  But prior
12011c92853dSdrh ** changes due to the same operation are not backed out and no rollback
12021c92853dSdrh ** occurs.  IGNORE means that the particular row that caused the constraint
12031c92853dSdrh ** error is not inserted or updated.  Processing continues and no error
12041c92853dSdrh ** is returned.  REPLACE means that preexisting database rows that caused
12051c92853dSdrh ** a UNIQUE constraint violation are removed so that the new insert or
12061c92853dSdrh ** update can proceed.  Processing continues and no error is reported.
12071c92853dSdrh **
1208c2eef3b3Sdrh ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
1209c2eef3b3Sdrh ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
1210c2eef3b3Sdrh ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
1211c2eef3b3Sdrh ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
1212c2eef3b3Sdrh ** referenced table row is propagated into the row that holds the
1213c2eef3b3Sdrh ** foreign key.
1214c2eef3b3Sdrh **
1215968af52aSdrh ** The following symbolic values are used to record which type
12161c92853dSdrh ** of action to take.
12179cfcf5d4Sdrh */
12189cfcf5d4Sdrh #define OE_None     0   /* There is no constraint to check */
12191c92853dSdrh #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
12201c92853dSdrh #define OE_Abort    2   /* Back out changes but do no rollback transaction */
12211c92853dSdrh #define OE_Fail     3   /* Stop the operation but leave all prior changes */
12221c92853dSdrh #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
12231c92853dSdrh #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
1224c2eef3b3Sdrh 
1225c2eef3b3Sdrh #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
1226c2eef3b3Sdrh #define OE_SetNull  7   /* Set the foreign key value to NULL */
1227c2eef3b3Sdrh #define OE_SetDflt  8   /* Set the foreign key value to its default */
1228c2eef3b3Sdrh #define OE_Cascade  9   /* Cascade the changes */
1229c2eef3b3Sdrh 
1230c2eef3b3Sdrh #define OE_Default  99  /* Do whatever the default action is */
12319cfcf5d4Sdrh 
1232d3d39e93Sdrh 
1233d3d39e93Sdrh /*
1234d3d39e93Sdrh ** An instance of the following structure is passed as the first
1235d3d39e93Sdrh ** argument to sqlite3VdbeKeyCompare and is used to control the
1236d3d39e93Sdrh ** comparison of the two index keys.
1237d3d39e93Sdrh */
1238d3d39e93Sdrh struct KeyInfo {
1239b21c8cd4Sdrh   sqlite3 *db;        /* The database connection */
1240b1bc9531Sdanielk1977   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
1241e63d9991Sdrh   u16 nField;         /* Number of entries in aColl[] */
1242d2d4a6b0Sdrh   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
1243d3d39e93Sdrh   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
1244d3d39e93Sdrh };
1245d3d39e93Sdrh 
12469cfcf5d4Sdrh /*
1247e63d9991Sdrh ** An instance of the following structure holds information about a
1248e63d9991Sdrh ** single index record that has already been parsed out into individual
1249e63d9991Sdrh ** values.
1250e63d9991Sdrh **
1251e63d9991Sdrh ** A record is an object that contains one or more fields of data.
1252e63d9991Sdrh ** Records are used to store the content of a table row and to store
1253e63d9991Sdrh ** the key of an index.  A blob encoding of a record is created by
1254467bcf36Sshane ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
1255e63d9991Sdrh ** OP_Column opcode.
1256e63d9991Sdrh **
1257e63d9991Sdrh ** This structure holds a record that has already been disassembled
1258467bcf36Sshane ** into its constituent fields.
1259e63d9991Sdrh */
1260e63d9991Sdrh struct UnpackedRecord {
1261e63d9991Sdrh   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
1262e63d9991Sdrh   u16 nField;         /* Number of entries in apMem[] */
1263e63d9991Sdrh   u16 flags;          /* Boolean settings.  UNPACKED_... below */
1264e63d9991Sdrh   Mem *aMem;          /* Values */
1265e63d9991Sdrh };
1266e63d9991Sdrh 
1267e63d9991Sdrh /*
1268e63d9991Sdrh ** Allowed values of UnpackedRecord.flags
1269e63d9991Sdrh */
1270e63d9991Sdrh #define UNPACKED_NEED_FREE     0x0001  /* Memory is from sqlite3Malloc() */
1271e63d9991Sdrh #define UNPACKED_NEED_DESTROY  0x0002  /* apMem[]s should all be destroyed */
1272e63d9991Sdrh #define UNPACKED_IGNORE_ROWID  0x0004  /* Ignore trailing rowid on key1 */
1273e63d9991Sdrh #define UNPACKED_INCRKEY       0x0008  /* Make this key an epsilon larger */
1274e63d9991Sdrh #define UNPACKED_PREFIX_MATCH  0x0010  /* A prefix match is considered OK */
1275e63d9991Sdrh 
1276e63d9991Sdrh /*
127766b89c8fSdrh ** Each SQL index is represented in memory by an
127875897234Sdrh ** instance of the following structure.
1279967e8b73Sdrh **
1280967e8b73Sdrh ** The columns of the table that are to be indexed are described
1281967e8b73Sdrh ** by the aiColumn[] field of this structure.  For example, suppose
1282967e8b73Sdrh ** we have the following table and index:
1283967e8b73Sdrh **
1284967e8b73Sdrh **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
1285967e8b73Sdrh **     CREATE INDEX Ex2 ON Ex1(c3,c1);
1286967e8b73Sdrh **
1287967e8b73Sdrh ** In the Table structure describing Ex1, nCol==3 because there are
1288967e8b73Sdrh ** three columns in the table.  In the Index structure describing
1289967e8b73Sdrh ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
1290967e8b73Sdrh ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
1291967e8b73Sdrh ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
1292967e8b73Sdrh ** The second column to be indexed (c1) has an index of 0 in
1293967e8b73Sdrh ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
1294ea1ba17cSdrh **
1295ea1ba17cSdrh ** The Index.onError field determines whether or not the indexed columns
1296ea1ba17cSdrh ** must be unique and what to do if they are not.  When Index.onError=OE_None,
1297ea1ba17cSdrh ** it means this is not a unique index.  Otherwise it is a unique index
1298ea1ba17cSdrh ** and the value of Index.onError indicate the which conflict resolution
1299ea1ba17cSdrh ** algorithm to employ whenever an attempt is made to insert a non-unique
1300ea1ba17cSdrh ** element.
130175897234Sdrh */
130275897234Sdrh struct Index {
130375897234Sdrh   char *zName;     /* Name of this index */
1304967e8b73Sdrh   int nColumn;     /* Number of columns in the table used by this index */
1305967e8b73Sdrh   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
13068b3d990bSdrh   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
1307967e8b73Sdrh   Table *pTable;   /* The SQL table being indexed */
1308be0072d2Sdrh   int tnum;        /* Page containing root of this index in database file */
13099cfcf5d4Sdrh   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
1310485b39b4Sdrh   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
1311a37cdde0Sdanielk1977   char *zColAff;   /* String defining the affinity of each column */
131275897234Sdrh   Index *pNext;    /* The next index associated with the same table */
1313b3bf556eSdanielk1977   Schema *pSchema; /* Schema containing this index */
1314b3bf556eSdanielk1977   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
1315b3bf556eSdanielk1977   char **azColl;   /* Array of collation sequence names for index */
131675897234Sdrh };
131775897234Sdrh 
131875897234Sdrh /*
131975897234Sdrh ** Each token coming out of the lexer is an instance of
13204b59ab5eSdrh ** this structure.  Tokens are also used as part of an expression.
13214efc4754Sdrh **
13224efc4754Sdrh ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
1323467bcf36Sshane ** may contain random values.  Do not make any assumptions about Token.dyn
13244efc4754Sdrh ** and Token.n when Token.z==0.
132575897234Sdrh */
132675897234Sdrh struct Token {
13274c755c0fSdrh   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
13284b59ab5eSdrh   unsigned dyn  : 1;      /* True for malloced memory, false for static */
13296977fea8Sdrh   unsigned n    : 31;     /* Number of characters in this token */
133075897234Sdrh };
133175897234Sdrh 
133275897234Sdrh /*
133313449892Sdrh ** An instance of this structure contains information needed to generate
133413449892Sdrh ** code for a SELECT that contains aggregate functions.
133513449892Sdrh **
133613449892Sdrh ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
133713449892Sdrh ** pointer to this structure.  The Expr.iColumn field is the index in
133813449892Sdrh ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
133913449892Sdrh ** code for that node.
134013449892Sdrh **
134113449892Sdrh ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
134213449892Sdrh ** original Select structure that describes the SELECT statement.  These
134313449892Sdrh ** fields do not need to be freed when deallocating the AggInfo structure.
134413449892Sdrh */
134513449892Sdrh struct AggInfo {
134613449892Sdrh   u8 directMode;          /* Direct rendering mode means take data directly
134713449892Sdrh                           ** from source tables rather than from accumulators */
134813449892Sdrh   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
134913449892Sdrh                           ** than the source table */
135013449892Sdrh   int sortingIdx;         /* Cursor number of the sorting index */
135113449892Sdrh   ExprList *pGroupBy;     /* The group by clause */
135213449892Sdrh   int nSortingColumn;     /* Number of columns in the sorting index */
135313449892Sdrh   struct AggInfo_col {    /* For each column used in source tables */
13540817d0dfSdanielk1977     Table *pTab;             /* Source table */
135513449892Sdrh     int iTable;              /* Cursor number of the source table */
135613449892Sdrh     int iColumn;             /* Column number within the source table */
135713449892Sdrh     int iSorterColumn;       /* Column number in the sorting index */
135813449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
13595774b806Sdrh     Expr *pExpr;             /* The original expression */
136013449892Sdrh   } *aCol;
136113449892Sdrh   int nColumn;            /* Number of used entries in aCol[] */
136213449892Sdrh   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
136313449892Sdrh   int nAccumulator;       /* Number of columns that show through to the output.
136413449892Sdrh                           ** Additional columns are used only as parameters to
136513449892Sdrh                           ** aggregate functions */
136613449892Sdrh   struct AggInfo_func {   /* For each aggregate function */
136713449892Sdrh     Expr *pExpr;             /* Expression encoding the function */
136813449892Sdrh     FuncDef *pFunc;          /* The aggregate function implementation */
136913449892Sdrh     int iMem;                /* Memory location that acts as accumulator */
1370467bcf36Sshane     int iDistinct;           /* Ephemeral table used to enforce DISTINCT */
137113449892Sdrh   } *aFunc;
137213449892Sdrh   int nFunc;              /* Number of entries in aFunc[] */
137313449892Sdrh   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
137413449892Sdrh };
137513449892Sdrh 
137613449892Sdrh /*
137775897234Sdrh ** Each node of an expression in the parse tree is an instance
137822f70c32Sdrh ** of this structure.
137922f70c32Sdrh **
138022f70c32Sdrh ** Expr.op is the opcode. The integer parser token codes are reused
138122f70c32Sdrh ** as opcodes here. For example, the parser defines TK_GE to be an integer
138222f70c32Sdrh ** code representing the ">=" operator. This same integer code is reused
138322f70c32Sdrh ** to represent the greater-than-or-equal-to operator in the expression
138422f70c32Sdrh ** tree.
138522f70c32Sdrh **
13866ab3a2ecSdanielk1977 ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
13876ab3a2ecSdanielk1977 ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
13886ab3a2ecSdanielk1977 ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
13896ab3a2ecSdanielk1977 ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
13906ab3a2ecSdanielk1977 ** then Expr.token contains the name of the function.
139122f70c32Sdrh **
13926ab3a2ecSdanielk1977 ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
13936ab3a2ecSdanielk1977 ** binary operator. Either or both may be NULL.
13946ab3a2ecSdanielk1977 **
13956ab3a2ecSdanielk1977 ** Expr.x.pList is a list of arguments if the expression is an SQL function,
13966ab3a2ecSdanielk1977 ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
13976ab3a2ecSdanielk1977 ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
13986ab3a2ecSdanielk1977 ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
13996ab3a2ecSdanielk1977 ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
14006ab3a2ecSdanielk1977 ** valid.
140122f70c32Sdrh **
140222f70c32Sdrh ** An expression of the form ID or ID.ID refers to a column in a table.
140322f70c32Sdrh ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
140422f70c32Sdrh ** the integer cursor number of a VDBE cursor pointing to that table and
140522f70c32Sdrh ** Expr.iColumn is the column number for the specific column.  If the
140622f70c32Sdrh ** expression is used as a result in an aggregate SELECT, then the
140722f70c32Sdrh ** value is also stored in the Expr.iAgg column in the aggregate so that
140822f70c32Sdrh ** it can be accessed after all aggregates are computed.
140922f70c32Sdrh **
14106ab3a2ecSdanielk1977 ** If the expression is an unbound variable marker (a question mark
14116ab3a2ecSdanielk1977 ** character '?' in the original SQL) then the Expr.iTable holds the index
14126ab3a2ecSdanielk1977 ** number for that variable.
141322f70c32Sdrh **
14141398ad36Sdrh ** If the expression is a subquery then Expr.iColumn holds an integer
14151398ad36Sdrh ** register number containing the result of the subquery.  If the
14161398ad36Sdrh ** subquery gives a constant result, then iTable is -1.  If the subquery
14171398ad36Sdrh ** gives a different answer at different times during statement processing
14181398ad36Sdrh ** then iTable is the address of a subroutine that computes the subquery.
14191398ad36Sdrh **
1420aee18ef8Sdanielk1977 ** If the Expr is of type OP_Column, and the table it is selecting from
1421aee18ef8Sdanielk1977 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1422aee18ef8Sdanielk1977 ** corresponding table definition.
14236ab3a2ecSdanielk1977 **
14246ab3a2ecSdanielk1977 ** ALLOCATION NOTES:
14256ab3a2ecSdanielk1977 **
14266ab3a2ecSdanielk1977 ** Expr structures may be stored as part of the in-memory database schema,
14276ab3a2ecSdanielk1977 ** for example as part of trigger, view or table definitions. In this case,
14286ab3a2ecSdanielk1977 ** the amount of memory consumed by complex expressions may be significant.
14296ab3a2ecSdanielk1977 ** For this reason, less than sizeof(Expr) bytes may be allocated for some
14306ab3a2ecSdanielk1977 ** Expr structs stored as part of the in-memory database schema.
14316ab3a2ecSdanielk1977 **
14326ab3a2ecSdanielk1977 ** If the EP_Reduced flag is set in Expr.flags, then only EXPR_REDUCEDSIZE
14336ab3a2ecSdanielk1977 ** bytes of space are allocated for the expression structure. This is enough
14346ab3a2ecSdanielk1977 ** space to store all fields up to and including the "Token span;" field.
14356ab3a2ecSdanielk1977 **
14366ab3a2ecSdanielk1977 ** If the EP_TokenOnly flag is set in Expr.flags, then only EXPR_TOKENONLYSIZE
14376ab3a2ecSdanielk1977 ** bytes of space are allocated for the expression structure. This is enough
14386ab3a2ecSdanielk1977 ** space to store all fields up to and including the "Token token;" field.
143975897234Sdrh */
144075897234Sdrh struct Expr {
14411cc093c2Sdrh   u8 op;                 /* Operation performed by this node */
1442a9fd84b0Sdrh   char affinity;         /* The affinity of the column or 0 if not a column */
14436a03a1c5Sdrh   u16 flags;             /* Various flags.  See below */
144475897234Sdrh   Token token;           /* An operand token */
14456ab3a2ecSdanielk1977 
14466ab3a2ecSdanielk1977   /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
14476ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
14486ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
14496ab3a2ecSdanielk1977   *********************************************************************/
14506ab3a2ecSdanielk1977 
14516977fea8Sdrh   Token span;            /* Complete text of the expression */
14526ab3a2ecSdanielk1977 
14536ab3a2ecSdanielk1977   /* If the EP_SpanOnly flag is set in the Expr.flags mask, then no
14546ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
14556ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
14566ab3a2ecSdanielk1977   *********************************************************************/
14576ab3a2ecSdanielk1977 
14586ab3a2ecSdanielk1977   Expr *pLeft;           /* Left subnode */
14596ab3a2ecSdanielk1977   Expr *pRight;          /* Right subnode */
14606ab3a2ecSdanielk1977   union {
14616ab3a2ecSdanielk1977     ExprList *pList;     /* Function arguments or in "<expr> IN (<expr-list)" */
14626ab3a2ecSdanielk1977     Select *pSelect;     /* Used for sub-selects and "<expr> IN (<select>)" */
14636ab3a2ecSdanielk1977   } x;
14646ab3a2ecSdanielk1977   CollSeq *pColl;        /* The collation type of the column or 0 */
14656ab3a2ecSdanielk1977 
14666ab3a2ecSdanielk1977   /* If the EP_Reduced flag is set in the Expr.flags mask, then no
14676ab3a2ecSdanielk1977   ** space is allocated for the fields below this point. An attempt to
14686ab3a2ecSdanielk1977   ** access them will result in a segfault or malfunction.
14696ab3a2ecSdanielk1977   *********************************************************************/
14706ab3a2ecSdanielk1977 
1471967e8b73Sdrh   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
14728e2ca029Sdrh                          ** iColumn-th field of the iTable-th table. */
147313449892Sdrh   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
147413449892Sdrh   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
147522d6a53aSdrh   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
14767d10d5a6Sdrh   Table *pTab;           /* Table for TK_COLUMN expressions. */
14770224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
1478fc976065Sdanielk1977   int nHeight;           /* Height of the tree headed by this node */
1479fc976065Sdanielk1977 #endif
148075897234Sdrh };
148175897234Sdrh 
148275897234Sdrh /*
14831f16230bSdrh ** The following are the meanings of bits in the Expr.flags field.
14841f16230bSdrh */
1485678ccce8Sdrh #define EP_FromJoin   0x0001  /* Originated in ON or USING clause of a join */
1486678ccce8Sdrh #define EP_Agg        0x0002  /* Contains one or more aggregate functions */
1487678ccce8Sdrh #define EP_Resolved   0x0004  /* IDs have been resolved to COLUMNs */
1488678ccce8Sdrh #define EP_Error      0x0008  /* Expression contains one or more errors */
1489678ccce8Sdrh #define EP_Distinct   0x0010  /* Aggregate function with DISTINCT keyword */
1490678ccce8Sdrh #define EP_VarSelect  0x0020  /* pSelect is correlated, not constant */
1491678ccce8Sdrh #define EP_Dequoted   0x0040  /* True if the string has been dequoted */
1492678ccce8Sdrh #define EP_InfixFunc  0x0080  /* True for an infix function: LIKE, GLOB, etc */
1493678ccce8Sdrh #define EP_ExpCollate 0x0100  /* Collating sequence specified explicitly */
1494da250ea5Sdrh #define EP_AnyAff     0x0200  /* Can take a cached column of any affinity */
149547de955eSdrh #define EP_FixedDest  0x0400  /* Result needed in a specific register */
149692b01d53Sdrh #define EP_IntValue   0x0800  /* Integer value contained in iTable */
14976ab3a2ecSdanielk1977 #define EP_xIsSelect  0x1000  /* x.pSelect is valid (otherwise x.pList is) */
14986ab3a2ecSdanielk1977 
14996ab3a2ecSdanielk1977 #define EP_Reduced    0x2000  /* Expr struct is EXPR_REDUCEDSIZE bytes only */
15006ab3a2ecSdanielk1977 #define EP_TokenOnly  0x4000  /* Expr struct is EXPR_TOKENONLYSIZE bytes only */
15016ab3a2ecSdanielk1977 #define EP_SpanOnly   0x8000  /* Expr struct is EXPR_SPANONLYSIZE bytes only */
15026ab3a2ecSdanielk1977 
15031f16230bSdrh /*
15041f16230bSdrh ** These macros can be used to test, set, or clear bits in the
15051f16230bSdrh ** Expr.flags field.
15061f16230bSdrh */
15071f16230bSdrh #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
15081f16230bSdrh #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
15091f16230bSdrh #define ExprSetProperty(E,P)     (E)->flags|=(P)
15101f16230bSdrh #define ExprClearProperty(E,P)   (E)->flags&=~(P)
15111f16230bSdrh 
15121f16230bSdrh /*
15136ab3a2ecSdanielk1977 ** Macros to determine the number of bytes required by a normal Expr
15146ab3a2ecSdanielk1977 ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
15156ab3a2ecSdanielk1977 ** and an Expr struct with the EP_TokenOnly flag set.
15166ab3a2ecSdanielk1977 */
15176ab3a2ecSdanielk1977 #define EXPR_FULLSIZE           sizeof(Expr)
1518ce6fa170Sshane #define EXPR_REDUCEDSIZE        offsetof(Expr,iTable)
1519ce6fa170Sshane #define EXPR_TOKENONLYSIZE      offsetof(Expr,span)
1520ce6fa170Sshane #define EXPR_SPANONLYSIZE       offsetof(Expr,pLeft)
15216ab3a2ecSdanielk1977 
15226ab3a2ecSdanielk1977 /*
15236ab3a2ecSdanielk1977 ** Flags passed to the sqlite3ExprDup() function. See the header comment
15246ab3a2ecSdanielk1977 ** above sqlite3ExprDup() for details.
15256ab3a2ecSdanielk1977 */
15266ab3a2ecSdanielk1977 #define EXPRDUP_REDUCE         0x0001
15276ab3a2ecSdanielk1977 #define EXPRDUP_SPAN           0x0002
152821822c58Sdanielk1977 #define EXPRDUP_DISTINCTSPAN   0x0004
15296ab3a2ecSdanielk1977 
15306ab3a2ecSdanielk1977 /*
153175897234Sdrh ** A list of expressions.  Each expression may optionally have a
153275897234Sdrh ** name.  An expr/name combination can be used in several ways, such
153375897234Sdrh ** as the list of "expr AS ID" fields following a "SELECT" or in the
153475897234Sdrh ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1535ad3cab52Sdrh ** also be used as the argument to a function, in which case the a.zName
153675897234Sdrh ** field is not used.
153775897234Sdrh */
153875897234Sdrh struct ExprList {
153975897234Sdrh   int nExpr;             /* Number of expressions on the list */
15404305d103Sdrh   int nAlloc;            /* Number of entries allocated below */
15419d2985c7Sdrh   int iECursor;          /* VDBE Cursor associated with this ExprList */
15426d4abfbeSdrh   struct ExprList_item {
154375897234Sdrh     Expr *pExpr;           /* The list of expressions */
154475897234Sdrh     char *zName;           /* Token associated with this expression */
15458e2ca029Sdrh     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
15468e2ca029Sdrh     u8 done;               /* A flag to indicate when processing is finished */
15477d10d5a6Sdrh     u16 iCol;              /* For ORDER BY, column number in result set */
15488b213899Sdrh     u16 iAlias;            /* Index into Parse.aAlias[] for zName */
154975897234Sdrh   } *a;                  /* One entry for each expression */
155075897234Sdrh };
155175897234Sdrh 
155275897234Sdrh /*
1553ad3cab52Sdrh ** An instance of this structure can hold a simple list of identifiers,
1554ad3cab52Sdrh ** such as the list "a,b,c" in the following statements:
1555ad3cab52Sdrh **
1556ad3cab52Sdrh **      INSERT INTO t(a,b,c) VALUES ...;
1557ad3cab52Sdrh **      CREATE INDEX idx ON t(a,b,c);
1558ad3cab52Sdrh **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1559ad3cab52Sdrh **
1560ad3cab52Sdrh ** The IdList.a.idx field is used when the IdList represents the list of
1561ad3cab52Sdrh ** column names after a table name in an INSERT statement.  In the statement
1562ad3cab52Sdrh **
1563ad3cab52Sdrh **     INSERT INTO t(a,b,c) ...
1564ad3cab52Sdrh **
1565ad3cab52Sdrh ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
156675897234Sdrh */
156775897234Sdrh struct IdList {
15686d4abfbeSdrh   struct IdList_item {
1569ad3cab52Sdrh     char *zName;      /* Name of the identifier */
1570967e8b73Sdrh     int idx;          /* Index in some Table.aCol[] of a column named zName */
1571ad3cab52Sdrh   } *a;
157213449892Sdrh   int nId;         /* Number of identifiers on the list */
157313449892Sdrh   int nAlloc;      /* Number of entries allocated for a[] below */
1574ad3cab52Sdrh };
1575ad3cab52Sdrh 
1576ad3cab52Sdrh /*
157751669863Sdrh ** The bitmask datatype defined below is used for various optimizations.
1578ca83ac51Sdrh **
1579ca83ac51Sdrh ** Changing this from a 64-bit to a 32-bit type limits the number of
1580ca83ac51Sdrh ** tables in a join to 32 instead of 64.  But it also reduces the size
1581ca83ac51Sdrh ** of the library by 738 bytes on ix86.
158251669863Sdrh */
1583ca83ac51Sdrh typedef u64 Bitmask;
158451669863Sdrh 
158551669863Sdrh /*
158600e13613Sdanielk1977 ** The number of bits in a Bitmask.  "BMS" means "BitMask Size".
158700e13613Sdanielk1977 */
158800e13613Sdanielk1977 #define BMS  ((int)(sizeof(Bitmask)*8))
158900e13613Sdanielk1977 
159000e13613Sdanielk1977 /*
1591ad3cab52Sdrh ** The following structure describes the FROM clause of a SELECT statement.
1592ad3cab52Sdrh ** Each table or subquery in the FROM clause is a separate element of
1593ad3cab52Sdrh ** the SrcList.a[] array.
1594d24cc427Sdrh **
1595d24cc427Sdrh ** With the addition of multiple database support, the following structure
1596d24cc427Sdrh ** can also be used to describe a particular table such as the table that
1597d24cc427Sdrh ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1598d24cc427Sdrh ** such a table must be a simple name: ID.  But in SQLite, the table can
1599d24cc427Sdrh ** now be identified by a database name, a dot, then the table name: ID.ID.
1600c49de5d9Sdrh **
1601c49de5d9Sdrh ** The jointype starts out showing the join type between the current table
1602c49de5d9Sdrh ** and the next table on the list.  The parser builds the list this way.
1603c49de5d9Sdrh ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1604c49de5d9Sdrh ** jointype expresses the join between the table and the previous table.
1605ad3cab52Sdrh */
1606ad3cab52Sdrh struct SrcList {
1607939a16d6Sdrh   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1608939a16d6Sdrh   i16 nAlloc;      /* Number of entries allocated in a[] below */
1609ad3cab52Sdrh   struct SrcList_item {
1610113088ecSdrh     char *zDatabase;  /* Name of database holding this table */
1611ad3cab52Sdrh     char *zName;      /* Name of the table */
1612ad3cab52Sdrh     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1613daffd0e5Sdrh     Table *pTab;      /* An SQL table corresponding to zName */
1614daffd0e5Sdrh     Select *pSelect;  /* A SELECT statement used in place of a table name */
16151787ccabSdanielk1977     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1616c49de5d9Sdrh     u8 jointype;      /* Type of join between this able and the previous */
1617dd5f5a62Sdrh     u8 notIndexed;    /* True if there is a NOT INDEXED clause */
1618e68fbe79Sdrh     int iCursor;      /* The VDBE cursor number used to access this table */
1619ad3cab52Sdrh     Expr *pOn;        /* The ON clause of a join */
1620ad3cab52Sdrh     IdList *pUsing;   /* The USING clause of a join */
1621cd38d520Sdanielk1977     Bitmask colUsed;  /* Bit N (1<<N) set if column N of pTab is used */
162285574e31Sdanielk1977     char *zIndex;     /* Identifier from "INDEXED BY <zIndex>" clause */
162385574e31Sdanielk1977     Index *pIndex;    /* Index structure corresponding to zIndex, if any */
1624113088ecSdrh   } a[1];             /* One entry for each identifier on the list */
162575897234Sdrh };
162675897234Sdrh 
162775897234Sdrh /*
162801f3f253Sdrh ** Permitted values of the SrcList.a.jointype field
162901f3f253Sdrh */
163001f3f253Sdrh #define JT_INNER     0x0001    /* Any kind of inner or cross join */
16313dec223cSdrh #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
16323dec223cSdrh #define JT_NATURAL   0x0004    /* True for a "natural" join */
16333dec223cSdrh #define JT_LEFT      0x0008    /* Left outer join */
16343dec223cSdrh #define JT_RIGHT     0x0010    /* Right outer join */
16353dec223cSdrh #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
16363dec223cSdrh #define JT_ERROR     0x0040    /* unknown or unsupported join type */
163701f3f253Sdrh 
1638111a6a7dSdrh 
1639111a6a7dSdrh /*
1640111a6a7dSdrh ** A WherePlan object holds information that describes a lookup
1641111a6a7dSdrh ** strategy.
1642111a6a7dSdrh **
1643111a6a7dSdrh ** This object is intended to be opaque outside of the where.c module.
1644111a6a7dSdrh ** It is included here only so that that compiler will know how big it
1645111a6a7dSdrh ** is.  None of the fields in this object should be used outside of
1646111a6a7dSdrh ** the where.c module.
1647111a6a7dSdrh **
1648111a6a7dSdrh ** Within the union, pIdx is only used when wsFlags&WHERE_INDEXED is true.
1649111a6a7dSdrh ** pTerm is only used when wsFlags&WHERE_MULTI_OR is true.  And pVtabIdx
1650111a6a7dSdrh ** is only used when wsFlags&WHERE_VIRTUALTABLE is true.  It is never the
1651111a6a7dSdrh ** case that more than one of these conditions is true.
1652111a6a7dSdrh */
1653111a6a7dSdrh struct WherePlan {
1654111a6a7dSdrh   u32 wsFlags;                   /* WHERE_* flags that describe the strategy */
1655111a6a7dSdrh   u32 nEq;                       /* Number of == constraints */
1656111a6a7dSdrh   union {
1657111a6a7dSdrh     Index *pIdx;                   /* Index when WHERE_INDEXED is true */
1658111a6a7dSdrh     struct WhereTerm *pTerm;       /* WHERE clause term for OR-search */
1659111a6a7dSdrh     sqlite3_index_info *pVtabIdx;  /* Virtual table index to use */
1660111a6a7dSdrh   } u;
1661111a6a7dSdrh };
1662111a6a7dSdrh 
166301f3f253Sdrh /*
16646b56344dSdrh ** For each nested loop in a WHERE clause implementation, the WhereInfo
16656b56344dSdrh ** structure contains a single instance of this structure.  This structure
16666b56344dSdrh ** is intended to be private the the where.c module and should not be
16676b56344dSdrh ** access or modified by other modules.
16686d209d8bSdrh **
1669111a6a7dSdrh ** The pIdxInfo field is used to help pick the best index on a
1670111a6a7dSdrh ** virtual table.  The pIdxInfo pointer contains indexing
16716d209d8bSdrh ** information for the i-th table in the FROM clause before reordering.
16726d209d8bSdrh ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1673111a6a7dSdrh ** All other information in the i-th WhereLevel object for the i-th table
1674111a6a7dSdrh ** after FROM clause ordering.
16756b56344dSdrh */
16766b56344dSdrh struct WhereLevel {
1677111a6a7dSdrh   WherePlan plan;       /* query plan for this element of the FROM clause */
167829dda4aeSdrh   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
16799012bcbcSdrh   int iTabCur;          /* The VDBE cursor used to access the table */
1680467bcf36Sshane   int iIdxCur;          /* The VDBE cursor used to access pIdx */
1681b3190c15Sdrh   int addrBrk;          /* Jump here to break out of the loop */
1682b3190c15Sdrh   int addrNxt;          /* Jump here to start the next IN combination */
1683b3190c15Sdrh   int addrCont;         /* Jump here to continue with the next loop cycle */
1684b3190c15Sdrh   int addrFirst;        /* First instruction of interior of the loop */
1685700a2261Sdrh   u8 iFrom;             /* Which entry in the FROM clause */
1686111a6a7dSdrh   u8 op, p5;            /* Opcode and P5 of the opcode that ends the loop */
1687111a6a7dSdrh   int p1, p2;           /* Operands of the opcode used to ends the loop */
1688111a6a7dSdrh   union {               /* Information that depends on plan.wsFlags */
1689111a6a7dSdrh     struct {
1690111a6a7dSdrh       int nIn;              /* Number of entries in aInLoop[] */
169172e8fa42Sdrh       struct InLoop {
169272e8fa42Sdrh         int iCur;              /* The VDBE cursor used by this IN operator */
1693b3190c15Sdrh         int addrInTop;         /* Top of the IN loop */
169472e8fa42Sdrh       } *aInLoop;           /* Information about each nested IN operator */
1695111a6a7dSdrh     } in;                 /* Used when plan.wsFlags&WHERE_IN_ABLE */
1696111a6a7dSdrh   } u;
16976d209d8bSdrh 
16986d209d8bSdrh   /* The following field is really not part of the current level.  But
1699111a6a7dSdrh   ** we need a place to cache virtual table index information for each
1700111a6a7dSdrh   ** virtual table in the FROM clause and the WhereLevel structure is
1701111a6a7dSdrh   ** a convenient place since there is one WhereLevel for each FROM clause
1702111a6a7dSdrh   ** element.
17036d209d8bSdrh   */
17046d209d8bSdrh   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
17056b56344dSdrh };
17066b56344dSdrh 
170708c88eb0Sdrh /*
1708165be38bSdrh ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin().
170908c88eb0Sdrh */
17106df2acd2Sdrh #define WHERE_ORDERBY_NORMAL   0x0000 /* No-op */
17116df2acd2Sdrh #define WHERE_ORDERBY_MIN      0x0001 /* ORDER BY processing for min() func */
17126df2acd2Sdrh #define WHERE_ORDERBY_MAX      0x0002 /* ORDER BY processing for max() func */
17136df2acd2Sdrh #define WHERE_ONEPASS_DESIRED  0x0004 /* Want to do one-pass UPDATE/DELETE */
17146df2acd2Sdrh #define WHERE_FILL_ROWSET      0x0008  /* Save results in a RowSet object */
17156df2acd2Sdrh #define WHERE_OMIT_OPEN        0x0010  /* Table cursor are already open */
17166df2acd2Sdrh #define WHERE_OMIT_CLOSE       0x0020  /* Omit close of table & index cursors */
1717a9d1ccb9Sdanielk1977 
17186b56344dSdrh /*
171975897234Sdrh ** The WHERE clause processing routine has two halves.  The
172075897234Sdrh ** first part does the start of the WHERE loop and the second
172175897234Sdrh ** half does the tail of the WHERE loop.  An instance of
172275897234Sdrh ** this structure is returned by the first half and passed
172375897234Sdrh ** into the second half to give some continuity.
172475897234Sdrh */
172575897234Sdrh struct WhereInfo {
172608c88eb0Sdrh   Parse *pParse;       /* Parsing and code generating context */
17276df2acd2Sdrh   u16 wctrlFlags;      /* Flags originally passed to sqlite3WhereBegin() */
172808c88eb0Sdrh   u8 okOnePass;        /* Ok to use one-pass algorithm for UPDATE or DELETE */
172923d04d5aSdrh   int regRowSet;                 /* Store rowids in this rowset if >=0 */
1730ad3cab52Sdrh   SrcList *pTabList;             /* List of tables in the join */
17319012bcbcSdrh   int iTop;                      /* The very beginning of the WHERE loop */
173219a775c2Sdrh   int iContinue;                 /* Jump here to continue with next record */
173319a775c2Sdrh   int iBreak;                    /* Jump here to break out of the loop */
17346b56344dSdrh   int nLevel;                    /* Number of nested loop */
1735111a6a7dSdrh   struct WhereClause *pWC;       /* Decomposition of the WHERE clause */
1736111a6a7dSdrh   WhereLevel a[1];               /* Information about each nest loop in WHERE */
173775897234Sdrh };
173875897234Sdrh 
173975897234Sdrh /*
1740b3bce662Sdanielk1977 ** A NameContext defines a context in which to resolve table and column
1741b3bce662Sdanielk1977 ** names.  The context consists of a list of tables (the pSrcList) field and
1742b3bce662Sdanielk1977 ** a list of named expression (pEList).  The named expression list may
1743b3bce662Sdanielk1977 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1744b3bce662Sdanielk1977 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1745b3bce662Sdanielk1977 ** pEList corresponds to the result set of a SELECT and is NULL for
1746b3bce662Sdanielk1977 ** other statements.
1747b3bce662Sdanielk1977 **
1748b3bce662Sdanielk1977 ** NameContexts can be nested.  When resolving names, the inner-most
1749b3bce662Sdanielk1977 ** context is searched first.  If no match is found, the next outer
1750b3bce662Sdanielk1977 ** context is checked.  If there is still no match, the next context
1751b3bce662Sdanielk1977 ** is checked.  This process continues until either a match is found
1752b3bce662Sdanielk1977 ** or all contexts are check.  When a match is found, the nRef member of
1753b3bce662Sdanielk1977 ** the context containing the match is incremented.
1754b3bce662Sdanielk1977 **
1755b3bce662Sdanielk1977 ** Each subquery gets a new NameContext.  The pNext field points to the
1756b3bce662Sdanielk1977 ** NameContext in the parent query.  Thus the process of scanning the
1757b3bce662Sdanielk1977 ** NameContext list corresponds to searching through successively outer
1758b3bce662Sdanielk1977 ** subqueries looking for a match.
1759b3bce662Sdanielk1977 */
1760b3bce662Sdanielk1977 struct NameContext {
1761b3bce662Sdanielk1977   Parse *pParse;       /* The parser */
1762b3bce662Sdanielk1977   SrcList *pSrcList;   /* One or more tables used to resolve names */
1763b3bce662Sdanielk1977   ExprList *pEList;    /* Optional list of named expressions */
1764b3bce662Sdanielk1977   int nRef;            /* Number of names resolved by this context */
1765b3bce662Sdanielk1977   int nErr;            /* Number of errors encountered while resolving names */
1766b3bce662Sdanielk1977   u8 allowAgg;         /* Aggregate functions allowed here */
176713449892Sdrh   u8 hasAgg;           /* True if aggregates are seen */
176806f6541eSdrh   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1769b3bce662Sdanielk1977   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
177013449892Sdrh   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1771b3bce662Sdanielk1977   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1772b3bce662Sdanielk1977 };
1773b3bce662Sdanielk1977 
1774b3bce662Sdanielk1977 /*
17759bb61fe7Sdrh ** An instance of the following structure contains all information
17769bb61fe7Sdrh ** needed to generate code for a single SELECT statement.
1777a76b5dfcSdrh **
1778d11d382cSdrh ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1779d11d382cSdrh ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1780d11d382cSdrh ** limit and nOffset to the value of the offset (or 0 if there is not
1781d11d382cSdrh ** offset).  But later on, nLimit and nOffset become the memory locations
1782d11d382cSdrh ** in the VDBE that record the limit and offset counters.
17830342b1f5Sdrh **
1784b9bb7c18Sdrh ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
17850342b1f5Sdrh ** These addresses must be stored so that we can go back and fill in
178666a5167bSdrh ** the P4_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
17870342b1f5Sdrh ** the number of columns in P2 can be computed at the same time
1788b9bb7c18Sdrh ** as the OP_OpenEphm instruction is coded because not
17890342b1f5Sdrh ** enough information about the compound query is known at that point.
1790b9bb7c18Sdrh ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1791b9bb7c18Sdrh ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
17920342b1f5Sdrh ** sequences for the ORDER BY clause.
17939bb61fe7Sdrh */
17949bb61fe7Sdrh struct Select {
17959bb61fe7Sdrh   ExprList *pEList;      /* The fields of the result */
17967b58daeaSdrh   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
17976c1426fdSdrh   char affinity;         /* MakeRecord with this affinity for SRT_Set */
17987d10d5a6Sdrh   u16 selFlags;          /* Various SF_* values */
1799ad3cab52Sdrh   SrcList *pSrc;         /* The FROM clause */
18009bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause */
18019bb61fe7Sdrh   ExprList *pGroupBy;    /* The GROUP BY clause */
18029bb61fe7Sdrh   Expr *pHaving;         /* The HAVING clause */
18039bb61fe7Sdrh   ExprList *pOrderBy;    /* The ORDER BY clause */
1804967e8b73Sdrh   Select *pPrior;        /* Prior select in a compound select statement */
18051e281291Sdrh   Select *pNext;         /* Next select to the left in a compound */
18060342b1f5Sdrh   Select *pRightmost;    /* Right-most select in a compound select statement */
1807a2dc3b1aSdanielk1977   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1808a2dc3b1aSdanielk1977   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
18097b58daeaSdrh   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1810b9bb7c18Sdrh   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
18119bb61fe7Sdrh };
18129bb61fe7Sdrh 
18139bb61fe7Sdrh /*
18147d10d5a6Sdrh ** Allowed values for Select.selFlags.  The "SF" prefix stands for
18157d10d5a6Sdrh ** "Select Flag".
18167d10d5a6Sdrh */
18177d10d5a6Sdrh #define SF_Distinct        0x0001  /* Output should be DISTINCT */
18187d10d5a6Sdrh #define SF_Resolved        0x0002  /* Identifiers have been resolved */
18197d10d5a6Sdrh #define SF_Aggregate       0x0004  /* Contains aggregate functions */
18207d10d5a6Sdrh #define SF_UsesEphemeral   0x0008  /* Uses the OpenEphemeral opcode */
18217d10d5a6Sdrh #define SF_Expanded        0x0010  /* sqlite3SelectExpand() called on this */
18227d10d5a6Sdrh #define SF_HasTypeInfo     0x0020  /* FROM subqueries have Table metadata */
18237d10d5a6Sdrh 
18247d10d5a6Sdrh 
18257d10d5a6Sdrh /*
18267d10d5a6Sdrh ** The results of a select can be distributed in several ways.  The
18277d10d5a6Sdrh ** "SRT" prefix means "SELECT Result Type".
1828fef5208cSdrh */
182913449892Sdrh #define SRT_Union        1  /* Store result as keys in an index */
183013449892Sdrh #define SRT_Except       2  /* Remove result from a UNION index */
18319ed1dfa8Sdanielk1977 #define SRT_Exists       3  /* Store 1 if the result is not empty */
18329ed1dfa8Sdanielk1977 #define SRT_Discard      4  /* Do not save the results anywhere */
1833fef5208cSdrh 
183413449892Sdrh /* The ORDER BY clause is ignored for all of the above */
18356c8c8ce0Sdanielk1977 #define IgnorableOrderby(X) ((X->eDest)<=SRT_Discard)
183613449892Sdrh 
18377d10d5a6Sdrh #define SRT_Output       5  /* Output each row of result */
18389ed1dfa8Sdanielk1977 #define SRT_Mem          6  /* Store result in a memory cell */
18390cdc022eSdanielk1977 #define SRT_Set          7  /* Store results as keys in an index */
18409ed1dfa8Sdanielk1977 #define SRT_Table        8  /* Store result as data with an automatic rowid */
18419ed1dfa8Sdanielk1977 #define SRT_EphemTab     9  /* Create transient tab and store like SRT_Table */
1842e00ee6ebSdrh #define SRT_Coroutine   10  /* Generate a single row of result */
18432282792aSdrh 
18442282792aSdrh /*
1845467bcf36Sshane ** A structure used to customize the behavior of sqlite3Select(). See
18466c8c8ce0Sdanielk1977 ** comments above sqlite3Select() for details.
18476c8c8ce0Sdanielk1977 */
18486c8c8ce0Sdanielk1977 typedef struct SelectDest SelectDest;
18496c8c8ce0Sdanielk1977 struct SelectDest {
1850477df4b3Sdrh   u8 eDest;         /* How to dispose of the results */
1851477df4b3Sdrh   u8 affinity;      /* Affinity used when eDest==SRT_Set */
18526c8c8ce0Sdanielk1977   int iParm;        /* A parameter used by the eDest disposal method */
18531013c932Sdrh   int iMem;         /* Base register where results are written */
1854ad27e761Sdrh   int nMem;         /* Number of registers allocated */
18556c8c8ce0Sdanielk1977 };
18566c8c8ce0Sdanielk1977 
18576c8c8ce0Sdanielk1977 /*
1858f57b3399Sdrh ** An SQL parser context.  A copy of this structure is passed through
1859f57b3399Sdrh ** the parser and down into all the parser action routine in order to
1860f57b3399Sdrh ** carry around information that is global to the entire parse.
1861f1974846Sdrh **
1862f1974846Sdrh ** The structure is divided into two parts.  When the parser and code
1863f1974846Sdrh ** generate call themselves recursively, the first part of the structure
1864f1974846Sdrh ** is constant but the second part is reset at the beginning and end of
1865f1974846Sdrh ** each recursion.
1866c00da105Sdanielk1977 **
1867c00da105Sdanielk1977 ** The nTableLock and aTableLock variables are only used if the shared-cache
1868c00da105Sdanielk1977 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1869c00da105Sdanielk1977 ** used to store the set of table-locks required by the statement being
1870c00da105Sdanielk1977 ** compiled. Function sqlite3TableLock() is used to add entries to the
1871c00da105Sdanielk1977 ** list.
187275897234Sdrh */
187375897234Sdrh struct Parse {
18749bb575fdSdrh   sqlite3 *db;         /* The main database structure */
18754c504391Sdrh   int rc;              /* Return code from execution */
187675897234Sdrh   char *zErrMsg;       /* An error message */
187775897234Sdrh   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1878836faa48Sdrh   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1879e0bc4048Sdrh   u8 nameClash;        /* A permanent table name clashes with temp table name */
1880a6ecd338Sdrh   u8 checkSchema;      /* Causes schema cookie check after an error */
1881205f48e6Sdrh   u8 nested;           /* Number of nested calls to the parser/code generator */
18827e326c09Sdrh   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1883892d3179Sdrh   u8 nTempReg;         /* Number of temporary registers in aTempReg[] */
18842dcef11bSdrh   u8 nTempInUse;       /* Number of aTempReg[] currently checked out */
1885892d3179Sdrh   int aTempReg[8];     /* Holding area for temporary registers */
1886892d3179Sdrh   int nRangeReg;       /* Size of the temporary register block */
1887892d3179Sdrh   int iRangeReg;       /* First register in temporary register block */
188875897234Sdrh   int nErr;            /* Number of errors seen */
1889832508b7Sdrh   int nTab;            /* Number of previously allocated VDBE cursors */
189019a775c2Sdrh   int nMem;            /* Number of memory cells used so far */
1891fef5208cSdrh   int nSet;            /* Number of sets used so far */
1892aa9b8963Sdrh   int ckBase;          /* Base register of data during check constraints */
1893e55cbd72Sdrh   int disableColCache; /* True to disable adding to column cache */
1894e55cbd72Sdrh   int nColCache;       /* Number of entries in the column cache */
1895e55cbd72Sdrh   int iColCache;       /* Next entry of the cache to replace */
18962f7794c1Sdrh   struct yColCache {
1897e55cbd72Sdrh     int iTable;           /* Table cursor number */
1898e55cbd72Sdrh     int iColumn;          /* Table column number */
1899da250ea5Sdrh     char affChange;       /* True if this register has had an affinity change */
1900e55cbd72Sdrh     int iReg;             /* Register holding value of this column */
1901e55cbd72Sdrh   } aColCache[10];     /* One for each valid column cache entry */
190280242055Sdrh   u32 writeMask;       /* Start a write transaction on these databases */
1903fcd35c7bSdrh   u32 cookieMask;      /* Bitmask of schema verified databases */
1904fcd35c7bSdrh   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1905c797d4dcSdrh   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1906c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
1907c00da105Sdanielk1977   int nTableLock;        /* Number of locks in aTableLock */
1908c00da105Sdanielk1977   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1909c00da105Sdanielk1977 #endif
1910cac336adSdanielk1977   int regRowid;        /* Register holding rowid of CREATE TABLE entry */
1911cac336adSdanielk1977   int regRoot;         /* Register holding root page number for new objects */
1912f1974846Sdrh 
1913f1974846Sdrh   /* Above is constant between recursions.  Below is reset before and after
1914f1974846Sdrh   ** each recursion */
1915f1974846Sdrh 
1916f1974846Sdrh   int nVar;            /* Number of '?' variables seen in the SQL so far */
1917f1974846Sdrh   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1918f1974846Sdrh   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1919f1974846Sdrh   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
19208b213899Sdrh   int nAlias;          /* Number of aliased result set columns */
1921555f8de7Sdrh   int nAliasAlloc;     /* Number of allocated slots for aAlias[] */
19228b213899Sdrh   int *aAlias;         /* Register used to hold aliased result */
1923f1974846Sdrh   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1924f1974846Sdrh   Token sErrToken;     /* The token at which the error occurred */
1925f1974846Sdrh   Token sNameToken;    /* Token with unqualified schema object name */
1926f1974846Sdrh   Token sLastToken;    /* The last token parsed */
1927f1974846Sdrh   const char *zSql;    /* All SQL text */
1928f1974846Sdrh   const char *zTail;   /* All SQL text past the last semicolon parsed */
1929f1974846Sdrh   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1930f1974846Sdrh   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1931f1974846Sdrh   TriggerStack *trigStack;  /* Trigger actions being coded */
1932f1974846Sdrh   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1933b9bb7c18Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
193433b3933cSdanielk1977   Token sArg;                /* Complete text of a module argument */
19357e6ebfb2Sdanielk1977   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
19364f3dd150Sdrh   int nVtabLock;             /* Number of virtual tables to lock */
19374f3dd150Sdrh   Table **apVtabLock;        /* Pointer to virtual tables needing locking */
1938b9bb7c18Sdrh #endif
1939fc976065Sdanielk1977   int nHeight;            /* Expression tree height of current sub-select */
1940588a9a1aSdrh   Table *pZombieTab;      /* List of Table objects to delete after code gen */
194175897234Sdrh };
194275897234Sdrh 
19437e6ebfb2Sdanielk1977 #ifdef SQLITE_OMIT_VIRTUALTABLE
19447e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB 0
19457e6ebfb2Sdanielk1977 #else
19467e6ebfb2Sdanielk1977   #define IN_DECLARE_VTAB (pParse->declareVtab)
19477e6ebfb2Sdanielk1977 #endif
19487e6ebfb2Sdanielk1977 
1949d99bc930Sdanielk1977 /*
195085e2096fSdrh ** An instance of the following structure can be declared on a stack and used
195185e2096fSdrh ** to save the Parse.zAuthContext value so that it can be restored later.
195285e2096fSdrh */
195385e2096fSdrh struct AuthContext {
195485e2096fSdrh   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
195585e2096fSdrh   Parse *pParse;              /* The Parse structure */
195685e2096fSdrh };
195785e2096fSdrh 
195885e2096fSdrh /*
1959f0863fe5Sdrh ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1960b0c374ffSrdc */
1961b0c374ffSrdc #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1962b0c374ffSrdc #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
196394eb6a14Sdanielk1977 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1964e4d90813Sdrh #define OPFLAG_APPEND    8    /* This is likely to be an append */
1965b0c374ffSrdc 
1966b0c374ffSrdc /*
1967d99bc930Sdanielk1977  * Each trigger present in the database schema is stored as an instance of
1968d99bc930Sdanielk1977  * struct Trigger.
1969d99bc930Sdanielk1977  *
1970d99bc930Sdanielk1977  * Pointers to instances of struct Trigger are stored in two ways.
19719bb575fdSdrh  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1972d99bc930Sdanielk1977  *    database). This allows Trigger structures to be retrieved by name.
1973d99bc930Sdanielk1977  * 2. All triggers associated with a single table form a linked list, using the
1974ad3cab52Sdrh  *    pNext member of struct Trigger. A pointer to the first element of the
1975ad3cab52Sdrh  *    linked list is stored as the "pTrigger" member of the associated
1976ad3cab52Sdrh  *    struct Table.
1977d99bc930Sdanielk1977  *
1978ad3cab52Sdrh  * The "step_list" member points to the first element of a linked list
1979ad3cab52Sdrh  * containing the SQL statements specified as the trigger program.
1980d99bc930Sdanielk1977  */
1981d99bc930Sdanielk1977 struct Trigger {
1982d99bc930Sdanielk1977   char *name;             /* The name of the trigger                        */
1983d99bc930Sdanielk1977   char *table;            /* The table or view to which the trigger applies */
1984f0f258b1Sdrh   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1985dca76841Sdrh   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1986467bcf36Sshane   Expr *pWhen;            /* The WHEN clause of the expression (may be NULL) */
1987d99bc930Sdanielk1977   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1988d99bc930Sdanielk1977                              the <column-list> is stored here */
19894312db55Sdrh   Token nameToken;        /* Token containing zName. Use during parsing only */
1990e501b89aSdanielk1977   Schema *pSchema;        /* Schema containing the trigger */
1991e501b89aSdanielk1977   Schema *pTabSchema;     /* Schema containing the table */
1992d99bc930Sdanielk1977   TriggerStep *step_list; /* Link list of trigger program steps             */
1993d99bc930Sdanielk1977   Trigger *pNext;         /* Next trigger associated with the table */
1994c3f9bad2Sdanielk1977 };
1995d99bc930Sdanielk1977 
1996d99bc930Sdanielk1977 /*
1997dca76841Sdrh ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1998dca76841Sdrh ** determine which.
1999dca76841Sdrh **
2000dca76841Sdrh ** If there are multiple triggers, you might of some BEFORE and some AFTER.
2001dca76841Sdrh ** In that cases, the constants below can be ORed together.
2002dca76841Sdrh */
2003dca76841Sdrh #define TRIGGER_BEFORE  1
2004dca76841Sdrh #define TRIGGER_AFTER   2
2005dca76841Sdrh 
2006dca76841Sdrh /*
2007d99bc930Sdanielk1977  * An instance of struct TriggerStep is used to store a single SQL statement
2008d99bc930Sdanielk1977  * that is a part of a trigger-program.
2009d99bc930Sdanielk1977  *
2010d99bc930Sdanielk1977  * Instances of struct TriggerStep are stored in a singly linked list (linked
2011d99bc930Sdanielk1977  * using the "pNext" member) referenced by the "step_list" member of the
2012d99bc930Sdanielk1977  * associated struct Trigger instance. The first element of the linked list is
2013d99bc930Sdanielk1977  * the first step of the trigger-program.
2014d99bc930Sdanielk1977  *
2015d99bc930Sdanielk1977  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
2016d99bc930Sdanielk1977  * "SELECT" statement. The meanings of the other members is determined by the
2017d99bc930Sdanielk1977  * value of "op" as follows:
2018d99bc930Sdanielk1977  *
2019d99bc930Sdanielk1977  * (op == TK_INSERT)
2020d99bc930Sdanielk1977  * orconf    -> stores the ON CONFLICT algorithm
2021d99bc930Sdanielk1977  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
2022d99bc930Sdanielk1977  *              this stores a pointer to the SELECT statement. Otherwise NULL.
2023d99bc930Sdanielk1977  * target    -> A token holding the name of the table to insert into.
2024d99bc930Sdanielk1977  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
2025d99bc930Sdanielk1977  *              this stores values to be inserted. Otherwise NULL.
2026d99bc930Sdanielk1977  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
2027ad3cab52Sdrh  *              statement, then this stores the column-names to be
2028ad3cab52Sdrh  *              inserted into.
2029d99bc930Sdanielk1977  *
2030d99bc930Sdanielk1977  * (op == TK_DELETE)
2031d99bc930Sdanielk1977  * target    -> A token holding the name of the table to delete from.
2032d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
2033d99bc930Sdanielk1977  *              Otherwise NULL.
2034d99bc930Sdanielk1977  *
2035d99bc930Sdanielk1977  * (op == TK_UPDATE)
2036d99bc930Sdanielk1977  * target    -> A token holding the name of the table to update rows of.
2037d99bc930Sdanielk1977  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
2038d99bc930Sdanielk1977  *              Otherwise NULL.
2039d99bc930Sdanielk1977  * pExprList -> A list of the columns to update and the expressions to update
20404adee20fSdanielk1977  *              them to. See sqlite3Update() documentation of "pChanges"
2041ad3cab52Sdrh  *              argument.
2042d99bc930Sdanielk1977  *
2043d99bc930Sdanielk1977  */
2044c3f9bad2Sdanielk1977 struct TriggerStep {
2045c3f9bad2Sdanielk1977   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
2046d99bc930Sdanielk1977   int orconf;          /* OE_Rollback etc. */
2047a69d9168Sdrh   Trigger *pTrig;      /* The trigger that this step is a part of */
2048c3f9bad2Sdanielk1977 
2049c3f9bad2Sdanielk1977   Select *pSelect;     /* Valid for SELECT and sometimes
2050c3f9bad2Sdanielk1977                           INSERT steps (when pExprList == 0) */
2051c3f9bad2Sdanielk1977   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
2052c3f9bad2Sdanielk1977   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
2053c3f9bad2Sdanielk1977   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
2054c3f9bad2Sdanielk1977                            INSERT steps (when pSelect == 0)         */
2055c3f9bad2Sdanielk1977   IdList *pIdList;     /* Valid for INSERT statements only */
2056c3f9bad2Sdanielk1977   TriggerStep *pNext;  /* Next in the link-list */
2057187e4c6aSdrh   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
2058c3f9bad2Sdanielk1977 };
2059c3f9bad2Sdanielk1977 
2060d99bc930Sdanielk1977 /*
2061d99bc930Sdanielk1977  * An instance of struct TriggerStack stores information required during code
2062d99bc930Sdanielk1977  * generation of a single trigger program. While the trigger program is being
2063d99bc930Sdanielk1977  * coded, its associated TriggerStack instance is pointed to by the
2064d99bc930Sdanielk1977  * "pTriggerStack" member of the Parse structure.
2065d99bc930Sdanielk1977  *
2066d99bc930Sdanielk1977  * The pTab member points to the table that triggers are being coded on. The
2067d99bc930Sdanielk1977  * newIdx member contains the index of the vdbe cursor that points at the temp
2068d99bc930Sdanielk1977  * table that stores the new.* references. If new.* references are not valid
2069d99bc930Sdanielk1977  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
2070d99bc930Sdanielk1977  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
2071d99bc930Sdanielk1977  *
2072d99bc930Sdanielk1977  * The ON CONFLICT policy to be used for the trigger program steps is stored
2073d99bc930Sdanielk1977  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
2074d99bc930Sdanielk1977  * specified for individual triggers steps is used.
2075d99bc930Sdanielk1977  *
2076d99bc930Sdanielk1977  * struct TriggerStack has a "pNext" member, to allow linked lists to be
2077d99bc930Sdanielk1977  * constructed. When coding nested triggers (triggers fired by other triggers)
2078d99bc930Sdanielk1977  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
2079d99bc930Sdanielk1977  * pointer. Once the nested trigger has been coded, the pNext value is restored
2080d99bc930Sdanielk1977  * to the pTriggerStack member of the Parse stucture and coding of the parent
2081d99bc930Sdanielk1977  * trigger continues.
2082d99bc930Sdanielk1977  *
2083d99bc930Sdanielk1977  * Before a nested trigger is coded, the linked list pointed to by the
2084d99bc930Sdanielk1977  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
2085d99bc930Sdanielk1977  * recursively. If this condition is detected, the nested trigger is not coded.
2086d99bc930Sdanielk1977  */
2087d99bc930Sdanielk1977 struct TriggerStack {
2088d99bc930Sdanielk1977   Table *pTab;         /* Table that triggers are currently being coded on */
2089d99bc930Sdanielk1977   int newIdx;          /* Index of vdbe cursor to "new" temp table */
2090d99bc930Sdanielk1977   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
20918f2c54e6Sdanielk1977   u32 newColMask;
20928f2c54e6Sdanielk1977   u32 oldColMask;
2093d99bc930Sdanielk1977   int orconf;          /* Current orconf policy */
20946f34903eSdanielk1977   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
2095e22a334bSdrh   Trigger *pTrigger;   /* The trigger currently being coded */
2096e22a334bSdrh   TriggerStack *pNext; /* Next trigger down on the trigger stack */
2097c3f9bad2Sdanielk1977 };
2098c3f9bad2Sdanielk1977 
2099d99bc930Sdanielk1977 /*
2100f26e09c8Sdrh ** The following structure contains information used by the sqliteFix...
2101f26e09c8Sdrh ** routines as they walk the parse tree to make database references
2102f26e09c8Sdrh ** explicit.
2103f26e09c8Sdrh */
2104f26e09c8Sdrh typedef struct DbFixer DbFixer;
2105f26e09c8Sdrh struct DbFixer {
2106f26e09c8Sdrh   Parse *pParse;      /* The parsing context.  Error messages written here */
2107f26e09c8Sdrh   const char *zDb;    /* Make sure all objects are contained in this database */
2108f26e09c8Sdrh   const char *zType;  /* Type of the container - used for error messages */
2109f26e09c8Sdrh   const Token *pName; /* Name of the container - used for error messages */
2110f26e09c8Sdrh };
2111f26e09c8Sdrh 
2112f26e09c8Sdrh /*
2113ade86483Sdrh ** An objected used to accumulate the text of a string where we
2114ade86483Sdrh ** do not necessarily know how big the string will be in the end.
2115ade86483Sdrh */
2116ade86483Sdrh struct StrAccum {
2117633e6d57Sdrh   sqlite3 *db;         /* Optional database for lookaside.  Can be NULL */
2118ade86483Sdrh   char *zBase;         /* A base allocation.  Not from malloc. */
2119ade86483Sdrh   char *zText;         /* The string collected so far */
2120ade86483Sdrh   int  nChar;          /* Length of the string so far */
2121ade86483Sdrh   int  nAlloc;         /* Amount of space allocated in zText */
2122bb4957f8Sdrh   int  mxAlloc;        /* Maximum allowed string length */
2123ade86483Sdrh   u8   mallocFailed;   /* Becomes true if any memory allocation fails */
2124467bcf36Sshane   u8   useMalloc;      /* True if zText is enlargeable using realloc */
2125ade86483Sdrh   u8   tooBig;         /* Becomes true if string size exceeds limits */
2126ade86483Sdrh };
2127ade86483Sdrh 
2128ade86483Sdrh /*
2129234c39dfSdrh ** A pointer to this structure is used to communicate information
2130234c39dfSdrh ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
2131234c39dfSdrh */
2132234c39dfSdrh typedef struct {
21339bb575fdSdrh   sqlite3 *db;        /* The database being initialized */
2134ece3c728Sdrh   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
2135234c39dfSdrh   char **pzErrMsg;    /* Error message stored here */
213615ca1df1Sdrh   int rc;             /* Result code stored here */
2137234c39dfSdrh } InitData;
2138234c39dfSdrh 
2139b6c29897Sdrh /*
214040257ffdSdrh ** Structure containing global configuration data for the SQLite library.
214133589797Sdrh **
214233589797Sdrh ** This structure also contains some state information.
214340257ffdSdrh */
214440257ffdSdrh struct Sqlite3Config {
2145fec00eabSdrh   int bMemstat;                     /* True to enable memory status */
2146fec00eabSdrh   int bCoreMutex;                   /* True to enable core mutexing */
2147fec00eabSdrh   int bFullMutex;                   /* True to enable full mutexing */
21480a687d12Sdrh   int mxStrlen;                     /* Maximum string length */
2149633e6d57Sdrh   int szLookaside;                  /* Default lookaside buffer size */
2150633e6d57Sdrh   int nLookaside;                   /* Default lookaside buffer count */
2151fec00eabSdrh   sqlite3_mem_methods m;            /* Low-level memory allocation interface */
21526d2ab0e4Sdanielk1977   sqlite3_mutex_methods mutex;      /* Low-level mutex interface */
2153bc2ca9ebSdanielk1977   sqlite3_pcache_methods pcache;    /* Low-level page-cache interface */
215440257ffdSdrh   void *pHeap;                      /* Heap storage space */
215533589797Sdrh   int nHeap;                        /* Size of pHeap[] */
215633589797Sdrh   int mnReq, mxReq;                 /* Min and max heap requests sizes */
215733589797Sdrh   void *pScratch;                   /* Scratch memory */
215833589797Sdrh   int szScratch;                    /* Size of each scratch buffer */
215933589797Sdrh   int nScratch;                     /* Number of scratch buffers */
216033589797Sdrh   void *pPage;                      /* Page cache memory */
216133589797Sdrh   int szPage;                       /* Size of each page in pPage[] */
216233589797Sdrh   int nPage;                        /* Number of pages in pPage[] */
21631875f7a3Sdrh   int mxParserStack;                /* maximum depth of the parser stack */
21641875f7a3Sdrh   int sharedCacheEnabled;           /* true if shared-cache mode enabled */
21651875f7a3Sdrh   /* The above might be initialized to non-zero.  The following need to always
21661875f7a3Sdrh   ** initially be zero, however. */
216771bc31c6Sdanielk1977   int isInit;                       /* True after initialization has finished */
2168502b4e00Sdanielk1977   int inProgress;                   /* True while initialization in progress */
216971bc31c6Sdanielk1977   int isMallocInit;                 /* True after malloc is initialized */
217071bc31c6Sdanielk1977   sqlite3_mutex *pInitMutex;        /* Mutex used by sqlite3_initialize() */
217193ed56d9Sdrh   int nRefInitMutex;                /* Number of users of pInitMutex */
217240257ffdSdrh };
217340257ffdSdrh 
217440257ffdSdrh /*
21757d10d5a6Sdrh ** Context pointer passed down through the tree-walk.
21767d10d5a6Sdrh */
21777d10d5a6Sdrh struct Walker {
21787d10d5a6Sdrh   int (*xExprCallback)(Walker*, Expr*);     /* Callback for expressions */
21797d10d5a6Sdrh   int (*xSelectCallback)(Walker*,Select*);  /* Callback for SELECTs */
21807d10d5a6Sdrh   Parse *pParse;                            /* Parser context.  */
21817d10d5a6Sdrh   union {                                   /* Extra data for callback */
21827d10d5a6Sdrh     NameContext *pNC;                          /* Naming context */
21837d10d5a6Sdrh     int i;                                     /* Integer value */
21847d10d5a6Sdrh   } u;
21857d10d5a6Sdrh };
21867d10d5a6Sdrh 
21877d10d5a6Sdrh /* Forward declarations */
21887d10d5a6Sdrh int sqlite3WalkExpr(Walker*, Expr*);
21897d10d5a6Sdrh int sqlite3WalkExprList(Walker*, ExprList*);
21907d10d5a6Sdrh int sqlite3WalkSelect(Walker*, Select*);
21917d10d5a6Sdrh int sqlite3WalkSelectExpr(Walker*, Select*);
21927d10d5a6Sdrh int sqlite3WalkSelectFrom(Walker*, Select*);
21937d10d5a6Sdrh 
21947d10d5a6Sdrh /*
21957d10d5a6Sdrh ** Return code from the parse-tree walking primitives and their
21967d10d5a6Sdrh ** callbacks.
21977d10d5a6Sdrh */
21982bf90f1eSdrh #define WRC_Continue    0   /* Continue down into children */
21992bf90f1eSdrh #define WRC_Prune       1   /* Omit children but continue walking siblings */
22002bf90f1eSdrh #define WRC_Abort       2   /* Abandon the tree walk */
22017d10d5a6Sdrh 
22027d10d5a6Sdrh /*
220366150956Sdrh ** Assuming zIn points to the first byte of a UTF-8 character,
220466150956Sdrh ** advance zIn to point to the first byte of the next UTF-8 character.
22054a919118Sdrh */
22064a919118Sdrh #define SQLITE_SKIP_UTF8(zIn) {                        \
22074a919118Sdrh   if( (*(zIn++))>=0xc0 ){                              \
22084a919118Sdrh     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
22094a919118Sdrh   }                                                    \
22104a919118Sdrh }
22114a919118Sdrh 
22124a919118Sdrh /*
221349285708Sdrh ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
221449285708Sdrh ** builds) or a function call (for debugging).  If it is a function call,
221549285708Sdrh ** it allows the operator to set a breakpoint at the spot where database
221649285708Sdrh ** corruption is first detected.
221749285708Sdrh */
221849285708Sdrh #ifdef SQLITE_DEBUG
22196e736838Sdrh   int sqlite3Corrupt(void);
222049285708Sdrh # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
222149285708Sdrh #else
222249285708Sdrh # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
222349285708Sdrh #endif
222449285708Sdrh 
222549285708Sdrh /*
222678ca0e7eSdanielk1977 ** The following macros mimic the standard library functions toupper(),
222778ca0e7eSdanielk1977 ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
222878ca0e7eSdanielk1977 ** sqlite versions only work for ASCII characters, regardless of locale.
222978ca0e7eSdanielk1977 */
223078ca0e7eSdanielk1977 #ifdef SQLITE_ASCII
223178ca0e7eSdanielk1977 # define sqlite3Toupper(x)  ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
223278ca0e7eSdanielk1977 # define sqlite3Isspace(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
2233dc86e2b2Sdrh # define sqlite3Isalnum(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
2234dc86e2b2Sdrh # define sqlite3Isalpha(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
223578ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
223678ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
223778ca0e7eSdanielk1977 # define sqlite3Tolower(x)   (sqlite3UpperToLower[(unsigned char)(x)])
223878ca0e7eSdanielk1977 #else
223978ca0e7eSdanielk1977 # include <ctype.h>
224078ca0e7eSdanielk1977 # define sqlite3Toupper(x)   toupper((unsigned char)(x))
224178ca0e7eSdanielk1977 # define sqlite3Isspace(x)   isspace((unsigned char)(x))
224278ca0e7eSdanielk1977 # define sqlite3Isalnum(x)   isalnum((unsigned char)(x))
2243dc86e2b2Sdrh # define sqlite3Isalpha(x)   isalpha((unsigned char)(x))
224478ca0e7eSdanielk1977 # define sqlite3Isdigit(x)   isdigit((unsigned char)(x))
224578ca0e7eSdanielk1977 # define sqlite3Isxdigit(x)  isxdigit((unsigned char)(x))
224678ca0e7eSdanielk1977 # define sqlite3Tolower(x)   tolower((unsigned char)(x))
224778ca0e7eSdanielk1977 #endif
224878ca0e7eSdanielk1977 
224978ca0e7eSdanielk1977 /*
225075897234Sdrh ** Internal function prototypes
225175897234Sdrh */
22524adee20fSdanielk1977 int sqlite3StrICmp(const char *, const char *);
22534adee20fSdanielk1977 int sqlite3StrNICmp(const char *, const char *, int);
22548a6b5411Sdanielk1977 int sqlite3IsNumber(const char*, int*, u8);
22550a687d12Sdrh int sqlite3Strlen(sqlite3*, const char*);
2256ea678832Sdrh int sqlite3Strlen30(const char*);
22572e588c75Sdanielk1977 
225840257ffdSdrh int sqlite3MallocInit(void);
2259fec00eabSdrh void sqlite3MallocEnd(void);
2260fec00eabSdrh void *sqlite3Malloc(int);
2261fec00eabSdrh void *sqlite3MallocZero(int);
2262fec00eabSdrh void *sqlite3DbMallocZero(sqlite3*, int);
2263fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3*, int);
226417435752Sdrh char *sqlite3DbStrDup(sqlite3*,const char*);
226517435752Sdrh char *sqlite3DbStrNDup(sqlite3*,const char*, int);
2266fec00eabSdrh void *sqlite3Realloc(void*, int);
226797c8ec32Sdrh void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
2268a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *, void *, int);
2269633e6d57Sdrh void sqlite3DbFree(sqlite3*, void*);
2270a7a8e14bSdanielk1977 int sqlite3MallocSize(void*);
2271633e6d57Sdrh int sqlite3DbMallocSize(sqlite3*, void*);
2272facf0307Sdrh void *sqlite3ScratchMalloc(int);
2273facf0307Sdrh void sqlite3ScratchFree(void*);
2274facf0307Sdrh void *sqlite3PageMalloc(int);
2275facf0307Sdrh void sqlite3PageFree(void*);
2276fec00eabSdrh void sqlite3MemSetDefault(void);
2277171bfed3Sdanielk1977 void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
22784a27a286Sshane int sqlite3MemoryAlarm(void (*)(void*, sqlite3_int64, int), void*, sqlite3_int64);
22792e588c75Sdanielk1977 
2280f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS3
2281f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
2282f3d3c27aSdanielk1977 #endif
2283f3d3c27aSdanielk1977 #ifdef SQLITE_ENABLE_MEMSYS5
2284f3d3c27aSdanielk1977 const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
2285f3d3c27aSdanielk1977 #endif
2286f3d3c27aSdanielk1977 
2287f3d3c27aSdanielk1977 
228818472fa7Sdrh #ifndef SQLITE_MUTEX_OMIT
22896d2ab0e4Sdanielk1977   sqlite3_mutex_methods *sqlite3DefaultMutex(void);
229059f8c08eSdanielk1977   sqlite3_mutex *sqlite3MutexAlloc(int);
2291d025174fSdanielk1977   int sqlite3MutexInit(void);
2292d025174fSdanielk1977   int sqlite3MutexEnd(void);
229365bbf29eSdrh #endif
22946d2ab0e4Sdanielk1977 
2295f7141990Sdrh int sqlite3StatusValue(int);
2296f7141990Sdrh void sqlite3StatusAdd(int, int);
2297f7141990Sdrh void sqlite3StatusSet(int, int);
2298f7141990Sdrh 
22990de3ae95Sdrh int sqlite3IsNaN(double);
23000de3ae95Sdrh 
2301f089aa45Sdrh void sqlite3VXPrintf(StrAccum*, int, const char*, va_list);
230217435752Sdrh char *sqlite3MPrintf(sqlite3*,const char*, ...);
230317435752Sdrh char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
2304633e6d57Sdrh char *sqlite3MAppendf(sqlite3*,char*,const char*,...);
230587cc3b31Sdrh #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
2306e54ca3feSdrh   void sqlite3DebugPrintf(const char*, ...);
2307d919fe17Sdrh #endif
2308d919fe17Sdrh #if defined(SQLITE_TEST)
2309e8f52c50Sdrh   void *sqlite3TestTextToPtr(const char*);
231087cc3b31Sdrh #endif
2311f089aa45Sdrh void sqlite3SetString(char **, sqlite3*, const char*, ...);
23124adee20fSdanielk1977 void sqlite3ErrorMsg(Parse*, const char*, ...);
2313a073384fSdrh void sqlite3ErrorClear(Parse*);
23144adee20fSdanielk1977 void sqlite3Dequote(char*);
231517435752Sdrh void sqlite3DequoteExpr(sqlite3*, Expr*);
23162646da7eSdrh int sqlite3KeywordCode(const unsigned char*, int);
23174adee20fSdanielk1977 int sqlite3RunParser(Parse*, const char*, char **);
231880242055Sdrh void sqlite3FinishCoding(Parse*);
2319892d3179Sdrh int sqlite3GetTempReg(Parse*);
2320892d3179Sdrh void sqlite3ReleaseTempReg(Parse*,int);
2321892d3179Sdrh int sqlite3GetTempRange(Parse*,int);
2322892d3179Sdrh void sqlite3ReleaseTempRange(Parse*,int,int);
2323a1644fd8Sdanielk1977 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
232417435752Sdrh Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
23254e0cff60Sdrh Expr *sqlite3RegisterExpr(Parse*,Token*);
23261e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
23274adee20fSdanielk1977 void sqlite3ExprSpan(Expr*,Token*,Token*);
232817435752Sdrh Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
2329fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse*, Expr*);
233010fe840eSdrh void sqlite3ExprClear(sqlite3*, Expr*);
2331633e6d57Sdrh void sqlite3ExprDelete(sqlite3*, Expr*);
233217435752Sdrh ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
2333633e6d57Sdrh void sqlite3ExprListDelete(sqlite3*, ExprList*);
23349bb575fdSdrh int sqlite3Init(sqlite3*, char**);
2335234c39dfSdrh int sqlite3InitCallback(void*, int, char**, char**);
233691cf71b0Sdanielk1977 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
23379bb575fdSdrh void sqlite3ResetInternalSchema(sqlite3*, int);
23384adee20fSdanielk1977 void sqlite3BeginParse(Parse*,int);
23399bb575fdSdrh void sqlite3CommitInternalChanges(sqlite3*);
23407d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse*,Select*);
2341c00da105Sdanielk1977 void sqlite3OpenMasterTable(Parse *, int);
2342f1a381e7Sdanielk1977 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
23434adee20fSdanielk1977 void sqlite3AddColumn(Parse*,Token*);
23444adee20fSdanielk1977 void sqlite3AddNotNull(Parse*, int);
2345fdd6e85aSdrh void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
2346ffe07b2dSdrh void sqlite3AddCheckConstraint(Parse*, Expr*);
2347487e262fSdrh void sqlite3AddColumnType(Parse*,Token*);
23487977a17fSdanielk1977 void sqlite3AddDefaultValue(Parse*,Expr*);
234939002505Sdanielk1977 void sqlite3AddCollateType(Parse*, Token*);
235019a8e7e8Sdanielk1977 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
2351b7f9164eSdrh 
2352f5e7bb51Sdrh Bitvec *sqlite3BitvecCreate(u32);
2353f5e7bb51Sdrh int sqlite3BitvecTest(Bitvec*, u32);
2354f5e7bb51Sdrh int sqlite3BitvecSet(Bitvec*, u32);
2355f5e7bb51Sdrh void sqlite3BitvecClear(Bitvec*, u32);
2356f5e7bb51Sdrh void sqlite3BitvecDestroy(Bitvec*);
2357bea2a948Sdanielk1977 u32 sqlite3BitvecSize(Bitvec*);
23583088d59eSdrh int sqlite3BitvecBuiltinTest(int,int*);
2359f5e7bb51Sdrh 
23603d4501e5Sdrh RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
23613d4501e5Sdrh void sqlite3RowSetClear(RowSet*);
23623d4501e5Sdrh void sqlite3RowSetInsert(RowSet*, i64);
23633d4501e5Sdrh int sqlite3RowSetNext(RowSet*, i64*);
23643d4501e5Sdrh 
2365fdd48a76Sdrh void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
2366fe3fcbe2Sdanielk1977 
2367fe3fcbe2Sdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
23684adee20fSdanielk1977   int sqlite3ViewGetColumnNames(Parse*,Table*);
2369b7f9164eSdrh #else
2370b7f9164eSdrh # define sqlite3ViewGetColumnNames(A,B) 0
2371b7f9164eSdrh #endif
2372b7f9164eSdrh 
2373a073384fSdrh void sqlite3DropTable(Parse*, SrcList*, int, int);
2374a04a34ffSdanielk1977 void sqlite3DeleteTable(Table*);
23754adee20fSdanielk1977 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
237617435752Sdrh void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
237717435752Sdrh IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
23784adee20fSdanielk1977 int sqlite3IdListIndex(IdList*,const char*);
2379a78c22c4Sdrh SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
238017435752Sdrh SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
2381b1c685b0Sdanielk1977 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
238285574e31Sdanielk1977                                       Token*, Select*, Expr*, IdList*);
2383b1c685b0Sdanielk1977 void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
2384b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
238561dfc31dSdrh void sqlite3SrcListShiftJoinType(SrcList*);
23864adee20fSdanielk1977 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
2387633e6d57Sdrh void sqlite3IdListDelete(sqlite3*, IdList*);
2388633e6d57Sdrh void sqlite3SrcListDelete(sqlite3*, SrcList*);
23890202b29eSdanielk1977 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
23904d91a701Sdrh                         Token*, int, int);
23914d91a701Sdrh void sqlite3DropIndex(Parse*, SrcList*, int);
23927d10d5a6Sdrh int sqlite3Select(Parse*, Select*, SelectDest*);
239317435752Sdrh Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
239417435752Sdrh                          Expr*,ExprList*,int,Expr*,Expr*);
2395633e6d57Sdrh void sqlite3SelectDelete(sqlite3*, Select*);
23964adee20fSdanielk1977 Table *sqlite3SrcListLookup(Parse*, SrcList*);
23974adee20fSdanielk1977 int sqlite3IsReadOnly(Parse*, Table*, int);
2398c00da105Sdanielk1977 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
2399273f619bSshane #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
240049ffdbf4Sshane Expr *sqlite3LimitWhere(Parse *, SrcList *, Expr *, ExprList *, Expr *, Expr *, char *);
24014281bd42Sshane #endif
24024adee20fSdanielk1977 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
24034adee20fSdanielk1977 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
240423d04d5aSdrh WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**, u8, int);
24054adee20fSdanielk1977 void sqlite3WhereEnd(WhereInfo*);
2406da250ea5Sdrh int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, int);
2407b21e7c70Sdrh void sqlite3ExprCodeMove(Parse*, int, int, int);
240892b01d53Sdrh void sqlite3ExprCodeCopy(Parse*, int, int, int);
2409e55cbd72Sdrh void sqlite3ExprClearColumnCache(Parse*, int);
2410da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse*, int, int);
2411d1fa7bcaSdrh void sqlite3ExprWritableRegister(Parse*,int);
2412191b54cbSdrh void sqlite3ExprHardCopy(Parse*,int,int);
2413389a1adbSdrh int sqlite3ExprCode(Parse*, Expr*, int);
24142dcef11bSdrh int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
2415678ccce8Sdrh int sqlite3ExprCodeTarget(Parse*, Expr*, int);
24162dcef11bSdrh int sqlite3ExprCodeAndCache(Parse*, Expr*, int);
2417678ccce8Sdrh void sqlite3ExprCodeConstants(Parse*, Expr*);
2418191b54cbSdrh int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int);
24194adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
24204adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
24219bb575fdSdrh Table *sqlite3FindTable(sqlite3*,const char*, const char*);
2422ca424114Sdrh Table *sqlite3LocateTable(Parse*,int isView,const char*, const char*);
24239bb575fdSdrh Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
24249bb575fdSdrh void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
24259bb575fdSdrh void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
242674161705Sdrh void sqlite3Vacuum(Parse*);
24279bb575fdSdrh int sqlite3RunVacuum(char**, sqlite3*);
242817435752Sdrh char *sqlite3NameFromToken(sqlite3*, Token*);
24294adee20fSdanielk1977 int sqlite3ExprCompare(Expr*, Expr*);
2430d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
2431d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
24324adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse*);
24331e536953Sdanielk1977 Expr *sqlite3CreateIdExpr(Parse *, const char*);
24342fa1868fSdrh void sqlite3PrngSaveState(void);
24352fa1868fSdrh void sqlite3PrngRestoreState(void);
24362fa1868fSdrh void sqlite3PrngResetState(void);
24379bb575fdSdrh void sqlite3RollbackAll(sqlite3*);
24384adee20fSdanielk1977 void sqlite3CodeVerifySchema(Parse*, int);
2439684917c2Sdrh void sqlite3BeginTransaction(Parse*, int);
24404adee20fSdanielk1977 void sqlite3CommitTransaction(Parse*);
24414adee20fSdanielk1977 void sqlite3RollbackTransaction(Parse*);
2442fd7f0452Sdanielk1977 void sqlite3Savepoint(Parse*, int, Token*);
2443fd7f0452Sdanielk1977 void sqlite3CloseSavepoints(sqlite3 *);
24444adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr*);
24450a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr*);
2446eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr*);
24474adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr*, int*);
24484adee20fSdanielk1977 int sqlite3IsRowid(const char*);
24492d401ab8Sdrh void sqlite3GenerateRowDelete(Parse*, Table*, int, int, int);
24502d401ab8Sdrh void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int*);
2451e14006d0Sdrh int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int);
245204adf416Sdrh void sqlite3GenerateConstraintChecks(Parse*,Table*,int,int,
245304adf416Sdrh                                      int*,int,int,int,int);
245462c14b34Sdanielk1977 void sqlite3CompleteInsertion(Parse*, Table*, int, int, int*, int, int, int);
2455aa9b8963Sdrh int sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
24564adee20fSdanielk1977 void sqlite3BeginWriteOperation(Parse*, int, int);
24576ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
245817435752Sdrh void sqlite3TokenCopy(sqlite3*,Token*, Token*);
24596ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
24606ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
246117435752Sdrh IdList *sqlite3IdListDup(sqlite3*,IdList*);
24626ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3*,Select*,int);
246370a8ca3cSdrh void sqlite3FuncDefInsert(FuncDefHash*, FuncDef*);
24649bb575fdSdrh FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
24659bb575fdSdrh void sqlite3RegisterBuiltinFunctions(sqlite3*);
2466777c5386Sdrh void sqlite3RegisterDateTimeFunctions(void);
246770a8ca3cSdrh void sqlite3RegisterGlobalFunctions(void);
24687e8b848aSdrh #ifdef SQLITE_DEBUG
24699bb575fdSdrh   int sqlite3SafetyOn(sqlite3*);
24709bb575fdSdrh   int sqlite3SafetyOff(sqlite3*);
24717e8b848aSdrh #else
24727e8b848aSdrh # define sqlite3SafetyOn(A) 0
24737e8b848aSdrh # define sqlite3SafetyOff(A) 0
24747e8b848aSdrh #endif
24757e8b848aSdrh int sqlite3SafetyCheckOk(sqlite3*);
24767e8b848aSdrh int sqlite3SafetyCheckSickOrOk(sqlite3*);
24779cbf3425Sdrh void sqlite3ChangeCookie(Parse*, int);
2478fa4e62f3Sshane 
2479fa4e62f3Sshane #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
24802a5d825eSdrh void sqlite3MaterializeView(Parse*, Table*, Expr*, int);
2481fa4e62f3Sshane #endif
2482b7f9164eSdrh 
2483b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
2484ef2cb63eSdanielk1977   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
248560218d2aSdrh                            Expr*,int, int);
24864adee20fSdanielk1977   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
2487fdd48a76Sdrh   void sqlite3DropTrigger(Parse*, SrcList*, int);
248874161705Sdrh   void sqlite3DropTriggerPtr(Parse*, Trigger*);
24892f886d1dSdanielk1977   Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
24902f886d1dSdanielk1977   Trigger *sqlite3TriggerList(Parse *, Table *);
24912f886d1dSdanielk1977   int sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
24922f886d1dSdanielk1977                             int, int, int, int, u32*, u32*);
2493dc379456Sdrh   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
2494633e6d57Sdrh   void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
249517435752Sdrh   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
249617435752Sdrh   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
249717435752Sdrh                                         ExprList*,Select*,int);
249817435752Sdrh   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
249917435752Sdrh   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
2500633e6d57Sdrh   void sqlite3DeleteTrigger(sqlite3*, Trigger*);
2501b7f9164eSdrh   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
2502b7f9164eSdrh #else
250362c14b34Sdanielk1977 # define sqlite3TriggersExist(B,C,D,E,F) 0
2504633e6d57Sdrh # define sqlite3DeleteTrigger(A,B)
2505cdd536f0Sdrh # define sqlite3DropTriggerPtr(A,B)
2506b7f9164eSdrh # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
25072f886d1dSdanielk1977 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I,J,K,L) 0
2508b7f9164eSdrh #endif
2509b7f9164eSdrh 
25104adee20fSdanielk1977 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
25110202b29eSdanielk1977 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
25124adee20fSdanielk1977 void sqlite3DeferForeignKey(Parse*, int);
2513ed6c8671Sdrh #ifndef SQLITE_OMIT_AUTHORIZATION
2514728b5779Sdrh   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
25154adee20fSdanielk1977   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
25164adee20fSdanielk1977   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
25174adee20fSdanielk1977   void sqlite3AuthContextPop(AuthContext*);
2518ed6c8671Sdrh #else
2519b5258c3dSdanielk1977 # define sqlite3AuthRead(a,b,c,d)
25204adee20fSdanielk1977 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
25214adee20fSdanielk1977 # define sqlite3AuthContextPush(a,b,c)
25224adee20fSdanielk1977 # define sqlite3AuthContextPop(a)  ((void)(a))
2523ed6c8671Sdrh #endif
2524f744bb56Sdanielk1977 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
2525f744bb56Sdanielk1977 void sqlite3Detach(Parse*, Expr*);
25269bb575fdSdrh int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
252733f4e02aSdrh                        int omitJournal, int nCache, int flags, Btree **ppBtree);
25284adee20fSdanielk1977 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
25294adee20fSdanielk1977 int sqlite3FixSrcList(DbFixer*, SrcList*);
25304adee20fSdanielk1977 int sqlite3FixSelect(DbFixer*, Select*);
25314adee20fSdanielk1977 int sqlite3FixExpr(DbFixer*, Expr*);
25324adee20fSdanielk1977 int sqlite3FixExprList(DbFixer*, ExprList*);
25334adee20fSdanielk1977 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
2534487e262fSdrh int sqlite3AtoF(const char *z, double*);
2535fec19aadSdrh int sqlite3GetInt32(const char *, int*);
2536598f1340Sdrh int sqlite3FitsIn64Bits(const char *, int);
2537ee85813cSdrh int sqlite3Utf16ByteLen(const void *pData, int nChar);
2538ee85813cSdrh int sqlite3Utf8CharLen(const char *pData, int nByte);
253966150956Sdrh int sqlite3Utf8Read(const u8*, const u8*, const u8**);
25403f8d5cfcSshane 
25413f8d5cfcSshane /*
25423f8d5cfcSshane ** Routines to read and write variable-length integers.  These used to
25433f8d5cfcSshane ** be defined locally, but now we use the varint routines in the util.c
2544952856adSshane ** file.  Code should use the MACRO forms below, as the Varint32 versions
2545952856adSshane ** are coded to assume the single byte case is already handled (which
2546952856adSshane ** the MACRO form does).
25473f8d5cfcSshane */
2548192ac1dcSdanielk1977 int sqlite3PutVarint(unsigned char*, u64);
254935b5a33eSdrh int sqlite3PutVarint32(unsigned char*, u32);
25501bd10f8aSdrh u8 sqlite3GetVarint(const unsigned char *, u64 *);
25511bd10f8aSdrh u8 sqlite3GetVarint32(const unsigned char *, u32 *);
2552192ac1dcSdanielk1977 int sqlite3VarintLen(u64 v);
25533f8d5cfcSshane 
25543f8d5cfcSshane /*
25553f8d5cfcSshane ** The header of a record consists of a sequence variable-length integers.
25563f8d5cfcSshane ** These integers are almost always small and are encoded as a single byte.
25573f8d5cfcSshane ** The following macros take advantage this fact to provide a fast encode
25583f8d5cfcSshane ** and decode of the integers in a record header.  It is faster for the common
25593f8d5cfcSshane ** case where the integer is a single byte.  It is a little slower when the
25603f8d5cfcSshane ** integer is two or more bytes.  But overall it is faster.
25613f8d5cfcSshane **
25623f8d5cfcSshane ** The following expressions are equivalent:
25633f8d5cfcSshane **
25643f8d5cfcSshane **     x = sqlite3GetVarint32( A, &B );
25653f8d5cfcSshane **     x = sqlite3PutVarint32( A, B );
25663f8d5cfcSshane **
25673f8d5cfcSshane **     x = getVarint32( A, B );
25683f8d5cfcSshane **     x = putVarint32( A, B );
25693f8d5cfcSshane **
25703f8d5cfcSshane */
25711bd10f8aSdrh #define getVarint32(A,B)  (u8)((*(A)<(u8)0x80) ? ((B) = (u32)*(A)),1 : sqlite3GetVarint32((A), (u32 *)&(B)))
25721bd10f8aSdrh #define putVarint32(A,B)  (u8)(((u32)(B)<(u32)0x80) ? (*(A) = (unsigned char)(B)),1 : sqlite3PutVarint32((A), (B)))
25733f8d5cfcSshane #define getVarint    sqlite3GetVarint
25743f8d5cfcSshane #define putVarint    sqlite3PutVarint
25753f8d5cfcSshane 
25763f8d5cfcSshane 
2577a37cdde0Sdanielk1977 void sqlite3IndexAffinityStr(Vdbe *, Index *);
2578a37cdde0Sdanielk1977 void sqlite3TableAffinityStr(Vdbe *, Table *);
2579e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
2580e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
2581bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr);
2582b6a9eceaSdrh int sqlite3Atoi64(const char*, i64*);
25839bb575fdSdrh void sqlite3Error(sqlite3*, int, const char*,...);
2584ca48c90fSdrh void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
2585ef2cb63eSdanielk1977 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
2586f20b21c8Sdanielk1977 const char *sqlite3ErrStr(int);
25878a41449eSdanielk1977 int sqlite3ReadSchema(Parse *pParse);
25889bb575fdSdrh CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
25890202b29eSdanielk1977 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
25907cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
25918b4c40d8Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
25927cedc8d4Sdanielk1977 int sqlite3CheckCollSeq(Parse *, CollSeq *);
2593d8123366Sdanielk1977 int sqlite3CheckObjectName(Parse *, const char *);
2594b28af71aSdanielk1977 void sqlite3VdbeSetChanges(sqlite3 *, int);
25954e6af134Sdanielk1977 
2596b21c8cd4Sdrh const void *sqlite3ValueText(sqlite3_value*, u8);
2597b21c8cd4Sdrh int sqlite3ValueBytes(sqlite3_value*, u8);
2598b21c8cd4Sdrh void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
25991e536953Sdanielk1977                         void(*)(void*));
26004e6af134Sdanielk1977 void sqlite3ValueFree(sqlite3_value*);
26011e536953Sdanielk1977 sqlite3_value *sqlite3ValueNew(sqlite3 *);
26021e536953Sdanielk1977 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
26031e536953Sdanielk1977 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
2604b21c8cd4Sdrh void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
260546c99e0fSdrh #ifndef SQLITE_AMALGAMATION
26064e5ffc5fSdrh extern const unsigned char sqlite3UpperToLower[];
260778ca0e7eSdanielk1977 extern const unsigned char sqlite3CtypeMap[];
2608075c23afSdanielk1977 extern SQLITE_WSD struct Sqlite3Config sqlite3Config;
2609075c23afSdanielk1977 extern SQLITE_WSD FuncDefHash sqlite3GlobalFunctions;
2610ddb68e17Sdrh extern int sqlite3PendingByte;
261146c99e0fSdrh #endif
2612a0bf2652Sdanielk1977 void sqlite3RootPageMoved(Db*, int, int);
26134343fea2Sdrh void sqlite3Reindex(Parse*, Token*, Token*);
26141f01ec1bSdrh void sqlite3AlterFunctions(sqlite3*);
26159fd2a9a0Sdanielk1977 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
26169fd2a9a0Sdanielk1977 int sqlite3GetToken(const unsigned char *, int *);
26172958a4e6Sdrh void sqlite3NestedParse(Parse*, const char*, ...);
2618d89bd007Sdrh void sqlite3ExpirePreparedStatements(sqlite3*);
261941a05b7bSdanielk1977 void sqlite3CodeSubselect(Parse *, Expr *, int, int);
26207d10d5a6Sdrh void sqlite3SelectPrep(Parse*, Select*, NameContext*);
26217d10d5a6Sdrh int sqlite3ResolveExprNames(NameContext*, Expr*);
26227d10d5a6Sdrh void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
26237d10d5a6Sdrh int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
2624aee18ef8Sdanielk1977 void sqlite3ColumnDefault(Vdbe *, Table *, int);
262519a8e7e8Sdanielk1977 void sqlite3AlterFinishAddColumn(Parse *, Token *);
262619a8e7e8Sdanielk1977 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
26274dade037Sdanielk1977 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
26288a51256cSdrh char sqlite3AffinityType(const Token*);
26299f18e8a0Sdrh void sqlite3Analyze(Parse*, Token*, Token*);
2630a4afb65cSdrh int sqlite3InvokeBusyHandler(BusyHandler*);
2631ff2d5ea4Sdrh int sqlite3FindDb(sqlite3*, Token*);
26320410302eSdanielk1977 int sqlite3FindDbName(sqlite3 *, const char *);
2633cf1be45fSdrh int sqlite3AnalysisLoad(sqlite3*,int iDB);
263451147baaSdrh void sqlite3DefaultRowEst(Index*);
263555ef4d97Sdrh void sqlite3RegisterLikeFunctions(sqlite3*, int);
2636d64fe2f3Sdrh int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
2637fdd6e85aSdrh void sqlite3MinimumFileFormat(Parse*, int, int);
2638da184236Sdanielk1977 void sqlite3SchemaFree(void *);
26391e536953Sdanielk1977 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
2640e501b89aSdanielk1977 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
2641b3bf556eSdanielk1977 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
2642771151b6Sdanielk1977 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
2643771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **),
2644771151b6Sdanielk1977   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
264554f0198eSdanielk1977 int sqlite3ApiExit(sqlite3 *db, int);
2646ddfb2f03Sdanielk1977 int sqlite3OpenTempDatabase(Parse *);
264769dab1d3Sdrh 
2648f089aa45Sdrh void sqlite3StrAccumInit(StrAccum*, char*, int, int);
2649ade86483Sdrh void sqlite3StrAccumAppend(StrAccum*,const char*,int);
2650ade86483Sdrh char *sqlite3StrAccumFinish(StrAccum*);
2651ade86483Sdrh void sqlite3StrAccumReset(StrAccum*);
26521013c932Sdrh void sqlite3SelectDestInit(SelectDest*,int,int);
26531e536953Sdanielk1977 
26540410302eSdanielk1977 void sqlite3BackupRestart(sqlite3_backup *);
26550410302eSdanielk1977 void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
26560410302eSdanielk1977 
265795bdbbbdSdrh /*
265895bdbbbdSdrh ** The interface to the LEMON-generated parser
265995bdbbbdSdrh */
266095bdbbbdSdrh void *sqlite3ParserAlloc(void*(*)(size_t));
266195bdbbbdSdrh void sqlite3ParserFree(void*, void(*)(void*));
266295bdbbbdSdrh void sqlite3Parser(void*, int, Token, Parse*);
2663ec424a5bSdrh #ifdef YYTRACKMAXSTACKDEPTH
2664ec424a5bSdrh   int sqlite3ParserStackPeak(void*);
2665ec424a5bSdrh #endif
266695bdbbbdSdrh 
2667caa639f4Sdrh int sqlite3AutoLoadExtensions(sqlite3*);
266869dab1d3Sdrh #ifndef SQLITE_OMIT_LOAD_EXTENSION
2669f1952c5dSdrh   void sqlite3CloseExtensions(sqlite3*);
267069dab1d3Sdrh #else
267169dab1d3Sdrh # define sqlite3CloseExtensions(X)
267269dab1d3Sdrh #endif
2673e3026636Sdanielk1977 
2674c00da105Sdanielk1977 #ifndef SQLITE_OMIT_SHARED_CACHE
2675c00da105Sdanielk1977   void sqlite3TableLock(Parse *, int, int, u8, const char *);
2676c00da105Sdanielk1977 #else
2677c00da105Sdanielk1977   #define sqlite3TableLock(v,w,x,y,z)
2678c00da105Sdanielk1977 #endif
2679c00da105Sdanielk1977 
268053c14021Sdrh #ifdef SQLITE_TEST
268153c14021Sdrh   int sqlite3Utf8To8(unsigned char*);
268253c14021Sdrh #endif
268353c14021Sdrh 
2684b9bb7c18Sdrh #ifdef SQLITE_OMIT_VIRTUALTABLE
2685b9bb7c18Sdrh #  define sqlite3VtabClear(X)
26869dbee7dcSdanielk1977 #  define sqlite3VtabSync(X,Y) SQLITE_OK
2687f9e7dda7Sdanielk1977 #  define sqlite3VtabRollback(X)
2688f9e7dda7Sdanielk1977 #  define sqlite3VtabCommit(X)
2689093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) 0
2690b9bb7c18Sdrh #else
2691707205d1Sdrh    void sqlite3VtabClear(Table*);
26923e3a84d3Sdanielk1977    int sqlite3VtabSync(sqlite3 *db, char **);
2693f9e7dda7Sdanielk1977    int sqlite3VtabRollback(sqlite3 *db);
2694f9e7dda7Sdanielk1977    int sqlite3VtabCommit(sqlite3 *db);
2695093e0f6fSdanielk1977 #  define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
2696b9bb7c18Sdrh #endif
26974f3dd150Sdrh void sqlite3VtabMakeWritable(Parse*,Table*);
2698189d4afaSdrh void sqlite3VtabLock(sqlite3_vtab*);
2699a04a34ffSdanielk1977 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
2700b9bb7c18Sdrh void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
2701b9bb7c18Sdrh void sqlite3VtabFinishParse(Parse*, Token*);
2702b9bb7c18Sdrh void sqlite3VtabArgInit(Parse*);
2703b9bb7c18Sdrh void sqlite3VtabArgExtend(Parse*, Token*);
270478efaba1Sdanielk1977 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
27057e6ebfb2Sdanielk1977 int sqlite3VtabCallConnect(Parse*, Table*);
27069e39ce87Sdanielk1977 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
2707f9e7dda7Sdanielk1977 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
27081e536953Sdanielk1977 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
2709b7481e70Sdrh void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
27104a27a286Sshane int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
2711b900aaf3Sdrh int sqlite3Reprepare(Vdbe*);
2712b1a6c3c1Sdrh void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
2713bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
2714b9bb7c18Sdrh 
2715643167ffSdrh 
2716643167ffSdrh /*
2717643167ffSdrh ** Available fault injectors.  Should be numbered beginning with 0.
2718643167ffSdrh */
2719643167ffSdrh #define SQLITE_FAULTINJECTOR_MALLOC     0
27207e8b848aSdrh #define SQLITE_FAULTINJECTOR_COUNT      1
2721643167ffSdrh 
2722643167ffSdrh /*
2723ef05f2dfSdanielk1977 ** The interface to the code in fault.c used for identifying "benign"
2724ef05f2dfSdanielk1977 ** malloc failures. This is only present if SQLITE_OMIT_BUILTIN_TEST
2725ef05f2dfSdanielk1977 ** is not defined.
2726643167ffSdrh */
27273088d59eSdrh #ifndef SQLITE_OMIT_BUILTIN_TEST
27282d1d86fbSdanielk1977   void sqlite3BeginBenignMalloc(void);
27292d1d86fbSdanielk1977   void sqlite3EndBenignMalloc(void);
2730643167ffSdrh #else
27312d1d86fbSdanielk1977   #define sqlite3BeginBenignMalloc()
2732867d05a0Sdanielk1977   #define sqlite3EndBenignMalloc()
2733643167ffSdrh #endif
2734643167ffSdrh 
27359a96b668Sdanielk1977 #define IN_INDEX_ROWID           1
27369a96b668Sdanielk1977 #define IN_INDEX_EPH             2
27379a96b668Sdanielk1977 #define IN_INDEX_INDEX           3
27380cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *, Expr *, int*);
27399a96b668Sdanielk1977 
2740c7b6017cSdanielk1977 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
2741c7b6017cSdanielk1977   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
2742c7b6017cSdanielk1977   int sqlite3JournalSize(sqlite3_vfs *);
2743f55b8998Sdanielk1977   int sqlite3JournalCreate(sqlite3_file *);
2744c7b6017cSdanielk1977 #else
2745c7b6017cSdanielk1977   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
2746c7b6017cSdanielk1977 #endif
2747c7b6017cSdanielk1977 
2748b3175389Sdanielk1977 void sqlite3MemJournalOpen(sqlite3_file *);
27493a5990abSdrh int sqlite3MemJournalSize(void);
2750b3175389Sdanielk1977 int sqlite3IsMemJournal(sqlite3_file *);
2751b3175389Sdanielk1977 
27520224d26dSdrh #if SQLITE_MAX_EXPR_DEPTH>0
27534b5255acSdanielk1977   void sqlite3ExprSetHeight(Parse *pParse, Expr *p);
2754fc976065Sdanielk1977   int sqlite3SelectExprHeight(Select *);
27557d10d5a6Sdrh   int sqlite3ExprCheckHeight(Parse*, int);
2756fc976065Sdanielk1977 #else
27574b5255acSdanielk1977   #define sqlite3ExprSetHeight(x,y)
27580224d26dSdrh   #define sqlite3SelectExprHeight(x) 0
27597d10d5a6Sdrh   #define sqlite3ExprCheckHeight(x,y)
2760fc976065Sdanielk1977 #endif
2761fc976065Sdanielk1977 
2762a3152895Sdrh u32 sqlite3Get4byte(const u8*);
2763a3152895Sdrh void sqlite3Put4byte(u8*, u32);
2764a3152895Sdrh 
2765404ca075Sdanielk1977 #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
2766404ca075Sdanielk1977   void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
2767404ca075Sdanielk1977   void sqlite3ConnectionUnlocked(sqlite3 *db);
2768404ca075Sdanielk1977   void sqlite3ConnectionClosed(sqlite3 *db);
2769404ca075Sdanielk1977 #else
2770404ca075Sdanielk1977   #define sqlite3ConnectionBlocked(x,y)
2771404ca075Sdanielk1977   #define sqlite3ConnectionUnlocked(x)
2772404ca075Sdanielk1977   #define sqlite3ConnectionClosed(x)
2773404ca075Sdanielk1977 #endif
2774404ca075Sdanielk1977 
2775404ca075Sdanielk1977 
2776fd9a0a45Sdanielk1977 #ifdef SQLITE_SSE
2777fd9a0a45Sdanielk1977 #include "sseInt.h"
2778fd9a0a45Sdanielk1977 #endif
2779fd9a0a45Sdanielk1977 
27806e736838Sdrh #ifdef SQLITE_DEBUG
27816e736838Sdrh   void sqlite3ParserTrace(FILE*, char *);
27826e736838Sdrh #endif
27836e736838Sdrh 
2784b0603416Sdrh /*
2785b0603416Sdrh ** If the SQLITE_ENABLE IOTRACE exists then the global variable
27863a00f907Smlcreech ** sqlite3IoTrace is a pointer to a printf-like routine used to
2787b0603416Sdrh ** print I/O tracing messages.
2788b0603416Sdrh */
2789b0603416Sdrh #ifdef SQLITE_ENABLE_IOTRACE
27903a00f907Smlcreech # define IOTRACE(A)  if( sqlite3IoTrace ){ sqlite3IoTrace A; }
2791b4622b60Sdanielk1977   void sqlite3VdbeIOTraceSql(Vdbe*);
2792e265b084Sdrh SQLITE_EXTERN void (*sqlite3IoTrace)(const char*,...);
2793b0603416Sdrh #else
2794b0603416Sdrh # define IOTRACE(A)
2795b4622b60Sdanielk1977 # define sqlite3VdbeIOTraceSql(X)
2796b0603416Sdrh #endif
2797b0603416Sdrh 
2798e3026636Sdanielk1977 #endif
2799