xref: /sqlite-3.40.0/src/sqliteInt.h (revision cd7274ce)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** Internal interface definitions for SQLite.
13 **
14 ** @(#) $Id: sqliteInt.h,v 1.618 2007/11/12 09:50:26 danielk1977 Exp $
15 */
16 #ifndef _SQLITEINT_H_
17 #define _SQLITEINT_H_
18 
19 /*
20 ** These #defines should enable >2GB file support on Posix if the
21 ** underlying operating system supports it.  If the OS lacks
22 ** large file support, or if the OS is windows, these should be no-ops.
23 **
24 ** Ticket #2739:  The _LARGEFILE_SOURCE macro must appear before any
25 ** system #includes.  Hence, this block of code must be the very first
26 ** code in all source files.
27 **
28 ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
29 ** on the compiler command line.  This is necessary if you are compiling
30 ** on a recent machine (ex: RedHat 7.2) but you want your code to work
31 ** on an older machine (ex: RedHat 6.0).  If you compile on RedHat 7.2
32 ** without this option, LFS is enable.  But LFS does not exist in the kernel
33 ** in RedHat 6.0, so the code won't work.  Hence, for maximum binary
34 ** portability you should omit LFS.
35 **
36 ** Similar is true for MacOS.  LFS is only supported on MacOS 9 and later.
37 */
38 #ifndef SQLITE_DISABLE_LFS
39 # define _LARGE_FILE       1
40 # ifndef _FILE_OFFSET_BITS
41 #   define _FILE_OFFSET_BITS 64
42 # endif
43 # define _LARGEFILE_SOURCE 1
44 #endif
45 
46 
47 #include "sqliteLimit.h"
48 
49 /*
50 ** For testing purposes, the various size limit constants are really
51 ** variables that we can modify in the testfixture.
52 */
53 #ifdef SQLITE_TEST
54   #undef SQLITE_MAX_LENGTH
55   #undef SQLITE_MAX_COLUMN
56   #undef SQLITE_MAX_SQL_LENGTH
57   #undef SQLITE_MAX_EXPR_DEPTH
58   #undef SQLITE_MAX_COMPOUND_SELECT
59   #undef SQLITE_MAX_VDBE_OP
60   #undef SQLITE_MAX_FUNCTION_ARG
61   #undef SQLITE_MAX_VARIABLE_NUMBER
62   #undef SQLITE_MAX_PAGE_SIZE
63   #undef SQLITE_MAX_PAGE_COUNT
64   #undef SQLITE_MAX_LIKE_PATTERN_LENGTH
65 
66   #define SQLITE_MAX_LENGTH              sqlite3MAX_LENGTH
67   #define SQLITE_MAX_COLUMN              sqlite3MAX_COLUMN
68   #define SQLITE_MAX_SQL_LENGTH          sqlite3MAX_SQL_LENGTH
69   #define SQLITE_MAX_EXPR_DEPTH          sqlite3MAX_EXPR_DEPTH
70   #define SQLITE_MAX_COMPOUND_SELECT     sqlite3MAX_COMPOUND_SELECT
71   #define SQLITE_MAX_VDBE_OP             sqlite3MAX_VDBE_OP
72   #define SQLITE_MAX_FUNCTION_ARG        sqlite3MAX_FUNCTION_ARG
73   #define SQLITE_MAX_VARIABLE_NUMBER     sqlite3MAX_VARIABLE_NUMBER
74   #define SQLITE_MAX_PAGE_SIZE           sqlite3MAX_PAGE_SIZE
75   #define SQLITE_MAX_PAGE_COUNT          sqlite3MAX_PAGE_COUNT
76   #define SQLITE_MAX_LIKE_PATTERN_LENGTH sqlite3MAX_LIKE_PATTERN_LENGTH
77 
78   extern int sqlite3MAX_LENGTH;
79   extern int sqlite3MAX_COLUMN;
80   extern int sqlite3MAX_SQL_LENGTH;
81   extern int sqlite3MAX_EXPR_DEPTH;
82   extern int sqlite3MAX_COMPOUND_SELECT;
83   extern int sqlite3MAX_VDBE_OP;
84   extern int sqlite3MAX_FUNCTION_ARG;
85   extern int sqlite3MAX_VARIABLE_NUMBER;
86   extern int sqlite3MAX_PAGE_SIZE;
87   extern int sqlite3MAX_PAGE_COUNT;
88   extern int sqlite3MAX_LIKE_PATTERN_LENGTH;
89 #endif
90 
91 
92 /*
93 ** The SQLITE_THREADSAFE macro must be defined as either 0 or 1.
94 ** Older versions of SQLite used an optional THREADSAFE macro.
95 ** We support that for legacy
96 */
97 #if !defined(SQLITE_THREADSAFE)
98 #if defined(THREADSAFE)
99 # define SQLITE_THREADSAFE THREADSAFE
100 #else
101 # define SQLITE_THREADSAFE 1
102 #endif
103 #endif
104 
105 /*
106 ** We need to define _XOPEN_SOURCE as follows in order to enable
107 ** recursive mutexes on most unix systems.  But Mac OS X is different.
108 ** The _XOPEN_SOURCE define causes problems for Mac OS X we are told,
109 ** so it is omitted there.  See ticket #2673.
110 **
111 ** Later we learn that _XOPEN_SOURCE is poorly or incorrectly
112 ** implemented on some systems.  So we avoid defining it at all
113 ** if it is already defined or if it is unneeded because we are
114 ** not doing a threadsafe build.  Ticket #2681.
115 **
116 ** See also ticket #2741.
117 */
118 #if !defined(_XOPEN_SOURCE) && !defined(__MACOS__) && SQLITE_THREADSAFE
119 #  define _XOPEN_SOURCE 500  /* Needed to enable pthread recursive mutexes */
120 #endif
121 
122 #if defined(SQLITE_TCL) || defined(TCLSH)
123 # include <tcl.h>
124 #endif
125 
126 /*
127 ** Many people are failing to set -DNDEBUG=1 when compiling SQLite.
128 ** Setting NDEBUG makes the code smaller and run faster.  So the following
129 ** lines are added to automatically set NDEBUG unless the -DSQLITE_DEBUG=1
130 ** option is set.  Thus NDEBUG becomes an opt-in rather than an opt-out
131 ** feature.
132 */
133 #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
134 # define NDEBUG 1
135 #endif
136 
137 #include "sqlite3.h"
138 #include "hash.h"
139 #include "parse.h"
140 #include <stdio.h>
141 #include <stdlib.h>
142 #include <string.h>
143 #include <assert.h>
144 #include <stddef.h>
145 
146 #define sqlite3_isnan(X)  ((X)!=(X))
147 
148 /*
149 ** If compiling for a processor that lacks floating point support,
150 ** substitute integer for floating-point
151 */
152 #ifdef SQLITE_OMIT_FLOATING_POINT
153 # define double sqlite_int64
154 # define LONGDOUBLE_TYPE sqlite_int64
155 # ifndef SQLITE_BIG_DBL
156 #   define SQLITE_BIG_DBL (0x7fffffffffffffff)
157 # endif
158 # define SQLITE_OMIT_DATETIME_FUNCS 1
159 # define SQLITE_OMIT_TRACE 1
160 # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
161 #endif
162 #ifndef SQLITE_BIG_DBL
163 # define SQLITE_BIG_DBL (1e99)
164 #endif
165 
166 /*
167 ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
168 ** afterward. Having this macro allows us to cause the C compiler
169 ** to omit code used by TEMP tables without messy #ifndef statements.
170 */
171 #ifdef SQLITE_OMIT_TEMPDB
172 #define OMIT_TEMPDB 1
173 #else
174 #define OMIT_TEMPDB 0
175 #endif
176 
177 /*
178 ** If the following macro is set to 1, then NULL values are considered
179 ** distinct when determining whether or not two entries are the same
180 ** in a UNIQUE index.  This is the way PostgreSQL, Oracle, DB2, MySQL,
181 ** OCELOT, and Firebird all work.  The SQL92 spec explicitly says this
182 ** is the way things are suppose to work.
183 **
184 ** If the following macro is set to 0, the NULLs are indistinct for
185 ** a UNIQUE index.  In this mode, you can only have a single NULL entry
186 ** for a column declared UNIQUE.  This is the way Informix and SQL Server
187 ** work.
188 */
189 #define NULL_DISTINCT_FOR_UNIQUE 1
190 
191 /*
192 ** The "file format" number is an integer that is incremented whenever
193 ** the VDBE-level file format changes.  The following macros define the
194 ** the default file format for new databases and the maximum file format
195 ** that the library can read.
196 */
197 #define SQLITE_MAX_FILE_FORMAT 4
198 #ifndef SQLITE_DEFAULT_FILE_FORMAT
199 # define SQLITE_DEFAULT_FILE_FORMAT 1
200 #endif
201 
202 /*
203 ** Provide a default value for TEMP_STORE in case it is not specified
204 ** on the command-line
205 */
206 #ifndef TEMP_STORE
207 # define TEMP_STORE 1
208 #endif
209 
210 /*
211 ** GCC does not define the offsetof() macro so we'll have to do it
212 ** ourselves.
213 */
214 #ifndef offsetof
215 #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
216 #endif
217 
218 /*
219 ** Check to see if this machine uses EBCDIC.  (Yes, believe it or
220 ** not, there are still machines out there that use EBCDIC.)
221 */
222 #if 'A' == '\301'
223 # define SQLITE_EBCDIC 1
224 #else
225 # define SQLITE_ASCII 1
226 #endif
227 
228 /*
229 ** Integers of known sizes.  These typedefs might change for architectures
230 ** where the sizes very.  Preprocessor macros are available so that the
231 ** types can be conveniently redefined at compile-type.  Like this:
232 **
233 **         cc '-DUINTPTR_TYPE=long long int' ...
234 */
235 #ifndef UINT32_TYPE
236 # define UINT32_TYPE unsigned int
237 #endif
238 #ifndef UINT16_TYPE
239 # define UINT16_TYPE unsigned short int
240 #endif
241 #ifndef INT16_TYPE
242 # define INT16_TYPE short int
243 #endif
244 #ifndef UINT8_TYPE
245 # define UINT8_TYPE unsigned char
246 #endif
247 #ifndef INT8_TYPE
248 # define INT8_TYPE signed char
249 #endif
250 #ifndef LONGDOUBLE_TYPE
251 # define LONGDOUBLE_TYPE long double
252 #endif
253 typedef sqlite_int64 i64;          /* 8-byte signed integer */
254 typedef sqlite_uint64 u64;         /* 8-byte unsigned integer */
255 typedef UINT32_TYPE u32;           /* 4-byte unsigned integer */
256 typedef UINT16_TYPE u16;           /* 2-byte unsigned integer */
257 typedef INT16_TYPE i16;            /* 2-byte signed integer */
258 typedef UINT8_TYPE u8;             /* 1-byte unsigned integer */
259 typedef UINT8_TYPE i8;             /* 1-byte signed integer */
260 
261 /*
262 ** Macros to determine whether the machine is big or little endian,
263 ** evaluated at runtime.
264 */
265 #ifdef SQLITE_AMALGAMATION
266 const int sqlite3One;
267 #else
268 extern const int sqlite3one;
269 #endif
270 #if defined(i386) || defined(__i386__) || defined(_M_IX86)
271 # define SQLITE_BIGENDIAN    0
272 # define SQLITE_LITTLEENDIAN 1
273 # define SQLITE_UTF16NATIVE  SQLITE_UTF16LE
274 #else
275 # define SQLITE_BIGENDIAN    (*(char *)(&sqlite3one)==0)
276 # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
277 # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
278 #endif
279 
280 /*
281 ** An instance of the following structure is used to store the busy-handler
282 ** callback for a given sqlite handle.
283 **
284 ** The sqlite.busyHandler member of the sqlite struct contains the busy
285 ** callback for the database handle. Each pager opened via the sqlite
286 ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
287 ** callback is currently invoked only from within pager.c.
288 */
289 typedef struct BusyHandler BusyHandler;
290 struct BusyHandler {
291   int (*xFunc)(void *,int);  /* The busy callback */
292   void *pArg;                /* First arg to busy callback */
293   int nBusy;                 /* Incremented with each busy call */
294 };
295 
296 /*
297 ** Defer sourcing vdbe.h and btree.h until after the "u8" and
298 ** "BusyHandler typedefs.
299 */
300 #include "btree.h"
301 #include "vdbe.h"
302 #include "pager.h"
303 
304 
305 /*
306 ** Name of the master database table.  The master database table
307 ** is a special table that holds the names and attributes of all
308 ** user tables and indices.
309 */
310 #define MASTER_NAME       "sqlite_master"
311 #define TEMP_MASTER_NAME  "sqlite_temp_master"
312 
313 /*
314 ** The root-page of the master database table.
315 */
316 #define MASTER_ROOT       1
317 
318 /*
319 ** The name of the schema table.
320 */
321 #define SCHEMA_TABLE(x)  ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
322 
323 /*
324 ** A convenience macro that returns the number of elements in
325 ** an array.
326 */
327 #define ArraySize(X)    (sizeof(X)/sizeof(X[0]))
328 
329 /*
330 ** Forward references to structures
331 */
332 typedef struct AggInfo AggInfo;
333 typedef struct AuthContext AuthContext;
334 typedef struct CollSeq CollSeq;
335 typedef struct Column Column;
336 typedef struct Db Db;
337 typedef struct Schema Schema;
338 typedef struct Expr Expr;
339 typedef struct ExprList ExprList;
340 typedef struct FKey FKey;
341 typedef struct FuncDef FuncDef;
342 typedef struct IdList IdList;
343 typedef struct Index Index;
344 typedef struct KeyClass KeyClass;
345 typedef struct KeyInfo KeyInfo;
346 typedef struct Module Module;
347 typedef struct NameContext NameContext;
348 typedef struct Parse Parse;
349 typedef struct Select Select;
350 typedef struct SrcList SrcList;
351 typedef struct Table Table;
352 typedef struct TableLock TableLock;
353 typedef struct Token Token;
354 typedef struct TriggerStack TriggerStack;
355 typedef struct TriggerStep TriggerStep;
356 typedef struct Trigger Trigger;
357 typedef struct WhereInfo WhereInfo;
358 typedef struct WhereLevel WhereLevel;
359 
360 #include "os.h"
361 #include "mutex.h"
362 
363 /*
364 ** Each database file to be accessed by the system is an instance
365 ** of the following structure.  There are normally two of these structures
366 ** in the sqlite.aDb[] array.  aDb[0] is the main database file and
367 ** aDb[1] is the database file used to hold temporary tables.  Additional
368 ** databases may be attached.
369 */
370 struct Db {
371   char *zName;         /* Name of this database */
372   Btree *pBt;          /* The B*Tree structure for this database file */
373   u8 inTrans;          /* 0: not writable.  1: Transaction.  2: Checkpoint */
374   u8 safety_level;     /* How aggressive at synching data to disk */
375   void *pAux;               /* Auxiliary data.  Usually NULL */
376   void (*xFreeAux)(void*);  /* Routine to free pAux */
377   Schema *pSchema;     /* Pointer to database schema (possibly shared) */
378 };
379 
380 /*
381 ** An instance of the following structure stores a database schema.
382 **
383 ** If there are no virtual tables configured in this schema, the
384 ** Schema.db variable is set to NULL. After the first virtual table
385 ** has been added, it is set to point to the database connection
386 ** used to create the connection. Once a virtual table has been
387 ** added to the Schema structure and the Schema.db variable populated,
388 ** only that database connection may use the Schema to prepare
389 ** statements.
390 */
391 struct Schema {
392   int schema_cookie;   /* Database schema version number for this file */
393   Hash tblHash;        /* All tables indexed by name */
394   Hash idxHash;        /* All (named) indices indexed by name */
395   Hash trigHash;       /* All triggers indexed by name */
396   Hash aFKey;          /* Foreign keys indexed by to-table */
397   Table *pSeqTab;      /* The sqlite_sequence table used by AUTOINCREMENT */
398   u8 file_format;      /* Schema format version for this file */
399   u8 enc;              /* Text encoding used by this database */
400   u16 flags;           /* Flags associated with this schema */
401   int cache_size;      /* Number of pages to use in the cache */
402 #ifndef SQLITE_OMIT_VIRTUALTABLE
403   sqlite3 *db;         /* "Owner" connection. See comment above */
404 #endif
405 };
406 
407 /*
408 ** These macros can be used to test, set, or clear bits in the
409 ** Db.flags field.
410 */
411 #define DbHasProperty(D,I,P)     (((D)->aDb[I].pSchema->flags&(P))==(P))
412 #define DbHasAnyProperty(D,I,P)  (((D)->aDb[I].pSchema->flags&(P))!=0)
413 #define DbSetProperty(D,I,P)     (D)->aDb[I].pSchema->flags|=(P)
414 #define DbClearProperty(D,I,P)   (D)->aDb[I].pSchema->flags&=~(P)
415 
416 /*
417 ** Allowed values for the DB.flags field.
418 **
419 ** The DB_SchemaLoaded flag is set after the database schema has been
420 ** read into internal hash tables.
421 **
422 ** DB_UnresetViews means that one or more views have column names that
423 ** have been filled out.  If the schema changes, these column names might
424 ** changes and so the view will need to be reset.
425 */
426 #define DB_SchemaLoaded    0x0001  /* The schema has been loaded */
427 #define DB_UnresetViews    0x0002  /* Some views have defined column names */
428 #define DB_Empty           0x0004  /* The file is empty (length 0 bytes) */
429 
430 
431 /*
432 ** Each database is an instance of the following structure.
433 **
434 ** The sqlite.lastRowid records the last insert rowid generated by an
435 ** insert statement.  Inserts on views do not affect its value.  Each
436 ** trigger has its own context, so that lastRowid can be updated inside
437 ** triggers as usual.  The previous value will be restored once the trigger
438 ** exits.  Upon entering a before or instead of trigger, lastRowid is no
439 ** longer (since after version 2.8.12) reset to -1.
440 **
441 ** The sqlite.nChange does not count changes within triggers and keeps no
442 ** context.  It is reset at start of sqlite3_exec.
443 ** The sqlite.lsChange represents the number of changes made by the last
444 ** insert, update, or delete statement.  It remains constant throughout the
445 ** length of a statement and is then updated by OP_SetCounts.  It keeps a
446 ** context stack just like lastRowid so that the count of changes
447 ** within a trigger is not seen outside the trigger.  Changes to views do not
448 ** affect the value of lsChange.
449 ** The sqlite.csChange keeps track of the number of current changes (since
450 ** the last statement) and is used to update sqlite_lsChange.
451 **
452 ** The member variables sqlite.errCode, sqlite.zErrMsg and sqlite.zErrMsg16
453 ** store the most recent error code and, if applicable, string. The
454 ** internal function sqlite3Error() is used to set these variables
455 ** consistently.
456 */
457 struct sqlite3 {
458   sqlite3_vfs *pVfs;            /* OS Interface */
459   int nDb;                      /* Number of backends currently in use */
460   Db *aDb;                      /* All backends */
461   int flags;                    /* Miscellanous flags. See below */
462   int openFlags;                /* Flags passed to sqlite3_vfs.xOpen() */
463   int errCode;                  /* Most recent error code (SQLITE_*) */
464   int errMask;                  /* & result codes with this before returning */
465   u8 autoCommit;                /* The auto-commit flag. */
466   u8 temp_store;                /* 1: file 2: memory 0: default */
467   u8 mallocFailed;              /* True if we have seen a malloc failure */
468   int nTable;                   /* Number of tables in the database */
469   CollSeq *pDfltColl;           /* The default collating sequence (BINARY) */
470   i64 lastRowid;                /* ROWID of most recent insert (see above) */
471   i64 priorNewRowid;            /* Last randomly generated ROWID */
472   int magic;                    /* Magic number for detect library misuse */
473   int nChange;                  /* Value returned by sqlite3_changes() */
474   int nTotalChange;             /* Value returned by sqlite3_total_changes() */
475   sqlite3_mutex *mutex;         /* Connection mutex */
476   struct sqlite3InitInfo {      /* Information used during initialization */
477     int iDb;                    /* When back is being initialized */
478     int newTnum;                /* Rootpage of table being initialized */
479     u8 busy;                    /* TRUE if currently initializing */
480   } init;
481   int nExtension;               /* Number of loaded extensions */
482   void **aExtension;            /* Array of shared libraray handles */
483   struct Vdbe *pVdbe;           /* List of active virtual machines */
484   int activeVdbeCnt;            /* Number of vdbes currently executing */
485   void (*xTrace)(void*,const char*);        /* Trace function */
486   void *pTraceArg;                          /* Argument to the trace function */
487   void (*xProfile)(void*,const char*,u64);  /* Profiling function */
488   void *pProfileArg;                        /* Argument to profile function */
489   void *pCommitArg;                 /* Argument to xCommitCallback() */
490   int (*xCommitCallback)(void*);    /* Invoked at every commit. */
491   void *pRollbackArg;               /* Argument to xRollbackCallback() */
492   void (*xRollbackCallback)(void*); /* Invoked at every commit. */
493   void *pUpdateArg;
494   void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
495   void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
496   void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
497   void *pCollNeededArg;
498   sqlite3_value *pErr;          /* Most recent error message */
499   char *zErrMsg;                /* Most recent error message (UTF-8 encoded) */
500   char *zErrMsg16;              /* Most recent error message (UTF-16 encoded) */
501   union {
502     int isInterrupted;          /* True if sqlite3_interrupt has been called */
503     double notUsed1;            /* Spacer */
504   } u1;
505 #ifndef SQLITE_OMIT_AUTHORIZATION
506   int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
507                                 /* Access authorization function */
508   void *pAuthArg;               /* 1st argument to the access auth function */
509 #endif
510 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
511   int (*xProgress)(void *);     /* The progress callback */
512   void *pProgressArg;           /* Argument to the progress callback */
513   int nProgressOps;             /* Number of opcodes for progress callback */
514 #endif
515 #ifndef SQLITE_OMIT_VIRTUALTABLE
516   Hash aModule;                 /* populated by sqlite3_create_module() */
517   Table *pVTab;                 /* vtab with active Connect/Create method */
518   sqlite3_vtab **aVTrans;       /* Virtual tables with open transactions */
519   int nVTrans;                  /* Allocated size of aVTrans */
520 #endif
521   Hash aFunc;                   /* All functions that can be in SQL exprs */
522   Hash aCollSeq;                /* All collating sequences */
523   BusyHandler busyHandler;      /* Busy callback */
524   int busyTimeout;              /* Busy handler timeout, in msec */
525   Db aDbStatic[2];              /* Static space for the 2 default backends */
526 #ifdef SQLITE_SSE
527   sqlite3_stmt *pFetch;         /* Used by SSE to fetch stored statements */
528 #endif
529   u8 dfltLockMode;              /* Default locking-mode for attached dbs */
530 };
531 
532 /*
533 ** A macro to discover the encoding of a database.
534 */
535 #define ENC(db) ((db)->aDb[0].pSchema->enc)
536 
537 /*
538 ** Possible values for the sqlite.flags and or Db.flags fields.
539 **
540 ** On sqlite.flags, the SQLITE_InTrans value means that we have
541 ** executed a BEGIN.  On Db.flags, SQLITE_InTrans means a statement
542 ** transaction is active on that particular database file.
543 */
544 #define SQLITE_VdbeTrace      0x00000001  /* True to trace VDBE execution */
545 #define SQLITE_InTrans        0x00000008  /* True if in a transaction */
546 #define SQLITE_InternChanges  0x00000010  /* Uncommitted Hash table changes */
547 #define SQLITE_FullColNames   0x00000020  /* Show full column names on SELECT */
548 #define SQLITE_ShortColNames  0x00000040  /* Show short columns names */
549 #define SQLITE_CountRows      0x00000080  /* Count rows changed by INSERT, */
550                                           /*   DELETE, or UPDATE and return */
551                                           /*   the count using a callback. */
552 #define SQLITE_NullCallback   0x00000100  /* Invoke the callback once if the */
553                                           /*   result set is empty */
554 #define SQLITE_SqlTrace       0x00000200  /* Debug print SQL as it executes */
555 #define SQLITE_VdbeListing    0x00000400  /* Debug listings of VDBE programs */
556 #define SQLITE_WriteSchema    0x00000800  /* OK to update SQLITE_MASTER */
557 #define SQLITE_NoReadlock     0x00001000  /* Readlocks are omitted when
558                                           ** accessing read-only databases */
559 #define SQLITE_IgnoreChecks   0x00002000  /* Do not enforce check constraints */
560 #define SQLITE_ReadUncommitted 0x00004000 /* For shared-cache mode */
561 #define SQLITE_LegacyFileFmt  0x00008000  /* Create new databases in format 1 */
562 #define SQLITE_FullFSync      0x00010000  /* Use full fsync on the backend */
563 #define SQLITE_LoadExtension  0x00020000  /* Enable load_extension */
564 
565 #define SQLITE_RecoveryMode   0x00040000  /* Ignore schema errors */
566 #define SQLITE_SharedCache    0x00080000  /* Cache sharing is enabled */
567 #define SQLITE_Vtab           0x00100000  /* There exists a virtual table */
568 
569 /*
570 ** Possible values for the sqlite.magic field.
571 ** The numbers are obtained at random and have no special meaning, other
572 ** than being distinct from one another.
573 */
574 #define SQLITE_MAGIC_OPEN     0xa029a697  /* Database is open */
575 #define SQLITE_MAGIC_CLOSED   0x9f3c2d33  /* Database is closed */
576 #define SQLITE_MAGIC_BUSY     0xf03b7906  /* Database currently in use */
577 #define SQLITE_MAGIC_ERROR    0xb5357930  /* An SQLITE_MISUSE error occurred */
578 
579 /*
580 ** Each SQL function is defined by an instance of the following
581 ** structure.  A pointer to this structure is stored in the sqlite.aFunc
582 ** hash table.  When multiple functions have the same name, the hash table
583 ** points to a linked list of these structures.
584 */
585 struct FuncDef {
586   i16 nArg;            /* Number of arguments.  -1 means unlimited */
587   u8 iPrefEnc;         /* Preferred text encoding (SQLITE_UTF8, 16LE, 16BE) */
588   u8 needCollSeq;      /* True if sqlite3GetFuncCollSeq() might be called */
589   u8 flags;            /* Some combination of SQLITE_FUNC_* */
590   void *pUserData;     /* User data parameter */
591   FuncDef *pNext;      /* Next function with same name */
592   void (*xFunc)(sqlite3_context*,int,sqlite3_value**); /* Regular function */
593   void (*xStep)(sqlite3_context*,int,sqlite3_value**); /* Aggregate step */
594   void (*xFinalize)(sqlite3_context*);                /* Aggregate finializer */
595   char zName[1];       /* SQL name of the function.  MUST BE LAST */
596 };
597 
598 /*
599 ** Each SQLite module (virtual table definition) is defined by an
600 ** instance of the following structure, stored in the sqlite3.aModule
601 ** hash table.
602 */
603 struct Module {
604   const sqlite3_module *pModule;       /* Callback pointers */
605   const char *zName;                   /* Name passed to create_module() */
606   void *pAux;                          /* pAux passed to create_module() */
607   void (*xDestroy)(void *);            /* Module destructor function */
608 };
609 
610 /*
611 ** Possible values for FuncDef.flags
612 */
613 #define SQLITE_FUNC_LIKE   0x01  /* Candidate for the LIKE optimization */
614 #define SQLITE_FUNC_CASE   0x02  /* Case-sensitive LIKE-type function */
615 #define SQLITE_FUNC_EPHEM  0x04  /* Ephermeral.  Delete with VDBE */
616 
617 /*
618 ** information about each column of an SQL table is held in an instance
619 ** of this structure.
620 */
621 struct Column {
622   char *zName;     /* Name of this column */
623   Expr *pDflt;     /* Default value of this column */
624   char *zType;     /* Data type for this column */
625   char *zColl;     /* Collating sequence.  If NULL, use the default */
626   u8 notNull;      /* True if there is a NOT NULL constraint */
627   u8 isPrimKey;    /* True if this column is part of the PRIMARY KEY */
628   char affinity;   /* One of the SQLITE_AFF_... values */
629 #ifndef SQLITE_OMIT_VIRTUALTABLE
630   u8 isHidden;     /* True if this column is 'hidden' */
631 #endif
632 };
633 
634 /*
635 ** A "Collating Sequence" is defined by an instance of the following
636 ** structure. Conceptually, a collating sequence consists of a name and
637 ** a comparison routine that defines the order of that sequence.
638 **
639 ** There may two seperate implementations of the collation function, one
640 ** that processes text in UTF-8 encoding (CollSeq.xCmp) and another that
641 ** processes text encoded in UTF-16 (CollSeq.xCmp16), using the machine
642 ** native byte order. When a collation sequence is invoked, SQLite selects
643 ** the version that will require the least expensive encoding
644 ** translations, if any.
645 **
646 ** The CollSeq.pUser member variable is an extra parameter that passed in
647 ** as the first argument to the UTF-8 comparison function, xCmp.
648 ** CollSeq.pUser16 is the equivalent for the UTF-16 comparison function,
649 ** xCmp16.
650 **
651 ** If both CollSeq.xCmp and CollSeq.xCmp16 are NULL, it means that the
652 ** collating sequence is undefined.  Indices built on an undefined
653 ** collating sequence may not be read or written.
654 */
655 struct CollSeq {
656   char *zName;          /* Name of the collating sequence, UTF-8 encoded */
657   u8 enc;               /* Text encoding handled by xCmp() */
658   u8 type;              /* One of the SQLITE_COLL_... values below */
659   void *pUser;          /* First argument to xCmp() */
660   int (*xCmp)(void*,int, const void*, int, const void*);
661   void (*xDel)(void*);  /* Destructor for pUser */
662 };
663 
664 /*
665 ** Allowed values of CollSeq flags:
666 */
667 #define SQLITE_COLL_BINARY  1  /* The default memcmp() collating sequence */
668 #define SQLITE_COLL_NOCASE  2  /* The built-in NOCASE collating sequence */
669 #define SQLITE_COLL_REVERSE 3  /* The built-in REVERSE collating sequence */
670 #define SQLITE_COLL_USER    0  /* Any other user-defined collating sequence */
671 
672 /*
673 ** A sort order can be either ASC or DESC.
674 */
675 #define SQLITE_SO_ASC       0  /* Sort in ascending order */
676 #define SQLITE_SO_DESC      1  /* Sort in ascending order */
677 
678 /*
679 ** Column affinity types.
680 **
681 ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
682 ** 't' for SQLITE_AFF_TEXT.  But we can save a little space and improve
683 ** the speed a little by number the values consecutively.
684 **
685 ** But rather than start with 0 or 1, we begin with 'a'.  That way,
686 ** when multiple affinity types are concatenated into a string and
687 ** used as the P3 operand, they will be more readable.
688 **
689 ** Note also that the numeric types are grouped together so that testing
690 ** for a numeric type is a single comparison.
691 */
692 #define SQLITE_AFF_TEXT     'a'
693 #define SQLITE_AFF_NONE     'b'
694 #define SQLITE_AFF_NUMERIC  'c'
695 #define SQLITE_AFF_INTEGER  'd'
696 #define SQLITE_AFF_REAL     'e'
697 
698 #define sqlite3IsNumericAffinity(X)  ((X)>=SQLITE_AFF_NUMERIC)
699 
700 /*
701 ** Each SQL table is represented in memory by an instance of the
702 ** following structure.
703 **
704 ** Table.zName is the name of the table.  The case of the original
705 ** CREATE TABLE statement is stored, but case is not significant for
706 ** comparisons.
707 **
708 ** Table.nCol is the number of columns in this table.  Table.aCol is a
709 ** pointer to an array of Column structures, one for each column.
710 **
711 ** If the table has an INTEGER PRIMARY KEY, then Table.iPKey is the index of
712 ** the column that is that key.   Otherwise Table.iPKey is negative.  Note
713 ** that the datatype of the PRIMARY KEY must be INTEGER for this field to
714 ** be set.  An INTEGER PRIMARY KEY is used as the rowid for each row of
715 ** the table.  If a table has no INTEGER PRIMARY KEY, then a random rowid
716 ** is generated for each row of the table.  Table.hasPrimKey is true if
717 ** the table has any PRIMARY KEY, INTEGER or otherwise.
718 **
719 ** Table.tnum is the page number for the root BTree page of the table in the
720 ** database file.  If Table.iDb is the index of the database table backend
721 ** in sqlite.aDb[].  0 is for the main database and 1 is for the file that
722 ** holds temporary tables and indices.  If Table.isEphem
723 ** is true, then the table is stored in a file that is automatically deleted
724 ** when the VDBE cursor to the table is closed.  In this case Table.tnum
725 ** refers VDBE cursor number that holds the table open, not to the root
726 ** page number.  Transient tables are used to hold the results of a
727 ** sub-query that appears instead of a real table name in the FROM clause
728 ** of a SELECT statement.
729 */
730 struct Table {
731   char *zName;     /* Name of the table */
732   int nCol;        /* Number of columns in this table */
733   Column *aCol;    /* Information about each column */
734   int iPKey;       /* If not less then 0, use aCol[iPKey] as the primary key */
735   Index *pIndex;   /* List of SQL indexes on this table. */
736   int tnum;        /* Root BTree node for this table (see note above) */
737   Select *pSelect; /* NULL for tables.  Points to definition if a view. */
738   int nRef;          /* Number of pointers to this Table */
739   Trigger *pTrigger; /* List of SQL triggers on this table */
740   FKey *pFKey;       /* Linked list of all foreign keys in this table */
741   char *zColAff;     /* String defining the affinity of each column */
742 #ifndef SQLITE_OMIT_CHECK
743   Expr *pCheck;      /* The AND of all CHECK constraints */
744 #endif
745 #ifndef SQLITE_OMIT_ALTERTABLE
746   int addColOffset;  /* Offset in CREATE TABLE statement to add a new column */
747 #endif
748   u8 readOnly;     /* True if this table should not be written by the user */
749   u8 isEphem;      /* True if created using OP_OpenEphermeral */
750   u8 hasPrimKey;   /* True if there exists a primary key */
751   u8 keyConf;      /* What to do in case of uniqueness conflict on iPKey */
752   u8 autoInc;      /* True if the integer primary key is autoincrement */
753 #ifndef SQLITE_OMIT_VIRTUALTABLE
754   u8 isVirtual;             /* True if this is a virtual table */
755   u8 isCommit;              /* True once the CREATE TABLE has been committed */
756   Module *pMod;             /* Pointer to the implementation of the module */
757   sqlite3_vtab *pVtab;      /* Pointer to the module instance */
758   int nModuleArg;           /* Number of arguments to the module */
759   char **azModuleArg;       /* Text of all module args. [0] is module name */
760 #endif
761   Schema *pSchema;          /* Schema that contains this table */
762 };
763 
764 /*
765 ** Test to see whether or not a table is a virtual table.  This is
766 ** done as a macro so that it will be optimized out when virtual
767 ** table support is omitted from the build.
768 */
769 #ifndef SQLITE_OMIT_VIRTUALTABLE
770 #  define IsVirtual(X)      ((X)->isVirtual)
771 #  define IsHiddenColumn(X) ((X)->isHidden)
772 #else
773 #  define IsVirtual(X)      0
774 #  define IsHiddenColumn(X) 0
775 #endif
776 
777 /*
778 ** Each foreign key constraint is an instance of the following structure.
779 **
780 ** A foreign key is associated with two tables.  The "from" table is
781 ** the table that contains the REFERENCES clause that creates the foreign
782 ** key.  The "to" table is the table that is named in the REFERENCES clause.
783 ** Consider this example:
784 **
785 **     CREATE TABLE ex1(
786 **       a INTEGER PRIMARY KEY,
787 **       b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
788 **     );
789 **
790 ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
791 **
792 ** Each REFERENCES clause generates an instance of the following structure
793 ** which is attached to the from-table.  The to-table need not exist when
794 ** the from-table is created.  The existance of the to-table is not checked
795 ** until an attempt is made to insert data into the from-table.
796 **
797 ** The sqlite.aFKey hash table stores pointers to this structure
798 ** given the name of a to-table.  For each to-table, all foreign keys
799 ** associated with that table are on a linked list using the FKey.pNextTo
800 ** field.
801 */
802 struct FKey {
803   Table *pFrom;     /* The table that constains the REFERENCES clause */
804   FKey *pNextFrom;  /* Next foreign key in pFrom */
805   char *zTo;        /* Name of table that the key points to */
806   FKey *pNextTo;    /* Next foreign key that points to zTo */
807   int nCol;         /* Number of columns in this key */
808   struct sColMap {  /* Mapping of columns in pFrom to columns in zTo */
809     int iFrom;         /* Index of column in pFrom */
810     char *zCol;        /* Name of column in zTo.  If 0 use PRIMARY KEY */
811   } *aCol;          /* One entry for each of nCol column s */
812   u8 isDeferred;    /* True if constraint checking is deferred till COMMIT */
813   u8 updateConf;    /* How to resolve conflicts that occur on UPDATE */
814   u8 deleteConf;    /* How to resolve conflicts that occur on DELETE */
815   u8 insertConf;    /* How to resolve conflicts that occur on INSERT */
816 };
817 
818 /*
819 ** SQLite supports many different ways to resolve a constraint
820 ** error.  ROLLBACK processing means that a constraint violation
821 ** causes the operation in process to fail and for the current transaction
822 ** to be rolled back.  ABORT processing means the operation in process
823 ** fails and any prior changes from that one operation are backed out,
824 ** but the transaction is not rolled back.  FAIL processing means that
825 ** the operation in progress stops and returns an error code.  But prior
826 ** changes due to the same operation are not backed out and no rollback
827 ** occurs.  IGNORE means that the particular row that caused the constraint
828 ** error is not inserted or updated.  Processing continues and no error
829 ** is returned.  REPLACE means that preexisting database rows that caused
830 ** a UNIQUE constraint violation are removed so that the new insert or
831 ** update can proceed.  Processing continues and no error is reported.
832 **
833 ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
834 ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
835 ** same as ROLLBACK for DEFERRED keys.  SETNULL means that the foreign
836 ** key is set to NULL.  CASCADE means that a DELETE or UPDATE of the
837 ** referenced table row is propagated into the row that holds the
838 ** foreign key.
839 **
840 ** The following symbolic values are used to record which type
841 ** of action to take.
842 */
843 #define OE_None     0   /* There is no constraint to check */
844 #define OE_Rollback 1   /* Fail the operation and rollback the transaction */
845 #define OE_Abort    2   /* Back out changes but do no rollback transaction */
846 #define OE_Fail     3   /* Stop the operation but leave all prior changes */
847 #define OE_Ignore   4   /* Ignore the error. Do not do the INSERT or UPDATE */
848 #define OE_Replace  5   /* Delete existing record, then do INSERT or UPDATE */
849 
850 #define OE_Restrict 6   /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
851 #define OE_SetNull  7   /* Set the foreign key value to NULL */
852 #define OE_SetDflt  8   /* Set the foreign key value to its default */
853 #define OE_Cascade  9   /* Cascade the changes */
854 
855 #define OE_Default  99  /* Do whatever the default action is */
856 
857 
858 /*
859 ** An instance of the following structure is passed as the first
860 ** argument to sqlite3VdbeKeyCompare and is used to control the
861 ** comparison of the two index keys.
862 **
863 ** If the KeyInfo.incrKey value is true and the comparison would
864 ** otherwise be equal, then return a result as if the second key
865 ** were larger.
866 */
867 struct KeyInfo {
868   sqlite3 *db;        /* The database connection */
869   u8 enc;             /* Text encoding - one of the TEXT_Utf* values */
870   u8 incrKey;         /* Increase 2nd key by epsilon before comparison */
871   int nField;         /* Number of entries in aColl[] */
872   u8 *aSortOrder;     /* If defined an aSortOrder[i] is true, sort DESC */
873   CollSeq *aColl[1];  /* Collating sequence for each term of the key */
874 };
875 
876 /*
877 ** Each SQL index is represented in memory by an
878 ** instance of the following structure.
879 **
880 ** The columns of the table that are to be indexed are described
881 ** by the aiColumn[] field of this structure.  For example, suppose
882 ** we have the following table and index:
883 **
884 **     CREATE TABLE Ex1(c1 int, c2 int, c3 text);
885 **     CREATE INDEX Ex2 ON Ex1(c3,c1);
886 **
887 ** In the Table structure describing Ex1, nCol==3 because there are
888 ** three columns in the table.  In the Index structure describing
889 ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
890 ** The value of aiColumn is {2, 0}.  aiColumn[0]==2 because the
891 ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
892 ** The second column to be indexed (c1) has an index of 0 in
893 ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
894 **
895 ** The Index.onError field determines whether or not the indexed columns
896 ** must be unique and what to do if they are not.  When Index.onError=OE_None,
897 ** it means this is not a unique index.  Otherwise it is a unique index
898 ** and the value of Index.onError indicate the which conflict resolution
899 ** algorithm to employ whenever an attempt is made to insert a non-unique
900 ** element.
901 */
902 struct Index {
903   char *zName;     /* Name of this index */
904   int nColumn;     /* Number of columns in the table used by this index */
905   int *aiColumn;   /* Which columns are used by this index.  1st is 0 */
906   unsigned *aiRowEst; /* Result of ANALYZE: Est. rows selected by each column */
907   Table *pTable;   /* The SQL table being indexed */
908   int tnum;        /* Page containing root of this index in database file */
909   u8 onError;      /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
910   u8 autoIndex;    /* True if is automatically created (ex: by UNIQUE) */
911   char *zColAff;   /* String defining the affinity of each column */
912   Index *pNext;    /* The next index associated with the same table */
913   Schema *pSchema; /* Schema containing this index */
914   u8 *aSortOrder;  /* Array of size Index.nColumn. True==DESC, False==ASC */
915   char **azColl;   /* Array of collation sequence names for index */
916 };
917 
918 /*
919 ** Each token coming out of the lexer is an instance of
920 ** this structure.  Tokens are also used as part of an expression.
921 **
922 ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
923 ** may contain random values.  Do not make any assuptions about Token.dyn
924 ** and Token.n when Token.z==0.
925 */
926 struct Token {
927   const unsigned char *z; /* Text of the token.  Not NULL-terminated! */
928   unsigned dyn  : 1;      /* True for malloced memory, false for static */
929   unsigned n    : 31;     /* Number of characters in this token */
930 };
931 
932 /*
933 ** An instance of this structure contains information needed to generate
934 ** code for a SELECT that contains aggregate functions.
935 **
936 ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
937 ** pointer to this structure.  The Expr.iColumn field is the index in
938 ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
939 ** code for that node.
940 **
941 ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
942 ** original Select structure that describes the SELECT statement.  These
943 ** fields do not need to be freed when deallocating the AggInfo structure.
944 */
945 struct AggInfo {
946   u8 directMode;          /* Direct rendering mode means take data directly
947                           ** from source tables rather than from accumulators */
948   u8 useSortingIdx;       /* In direct mode, reference the sorting index rather
949                           ** than the source table */
950   int sortingIdx;         /* Cursor number of the sorting index */
951   ExprList *pGroupBy;     /* The group by clause */
952   int nSortingColumn;     /* Number of columns in the sorting index */
953   struct AggInfo_col {    /* For each column used in source tables */
954     Table *pTab;             /* Source table */
955     int iTable;              /* Cursor number of the source table */
956     int iColumn;             /* Column number within the source table */
957     int iSorterColumn;       /* Column number in the sorting index */
958     int iMem;                /* Memory location that acts as accumulator */
959     Expr *pExpr;             /* The original expression */
960   } *aCol;
961   int nColumn;            /* Number of used entries in aCol[] */
962   int nColumnAlloc;       /* Number of slots allocated for aCol[] */
963   int nAccumulator;       /* Number of columns that show through to the output.
964                           ** Additional columns are used only as parameters to
965                           ** aggregate functions */
966   struct AggInfo_func {   /* For each aggregate function */
967     Expr *pExpr;             /* Expression encoding the function */
968     FuncDef *pFunc;          /* The aggregate function implementation */
969     int iMem;                /* Memory location that acts as accumulator */
970     int iDistinct;           /* Ephermeral table used to enforce DISTINCT */
971   } *aFunc;
972   int nFunc;              /* Number of entries in aFunc[] */
973   int nFuncAlloc;         /* Number of slots allocated for aFunc[] */
974 };
975 
976 /*
977 ** Each node of an expression in the parse tree is an instance
978 ** of this structure.
979 **
980 ** Expr.op is the opcode.  The integer parser token codes are reused
981 ** as opcodes here.  For example, the parser defines TK_GE to be an integer
982 ** code representing the ">=" operator.  This same integer code is reused
983 ** to represent the greater-than-or-equal-to operator in the expression
984 ** tree.
985 **
986 ** Expr.pRight and Expr.pLeft are subexpressions.  Expr.pList is a list
987 ** of argument if the expression is a function.
988 **
989 ** Expr.token is the operator token for this node.  For some expressions
990 ** that have subexpressions, Expr.token can be the complete text that gave
991 ** rise to the Expr.  In the latter case, the token is marked as being
992 ** a compound token.
993 **
994 ** An expression of the form ID or ID.ID refers to a column in a table.
995 ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
996 ** the integer cursor number of a VDBE cursor pointing to that table and
997 ** Expr.iColumn is the column number for the specific column.  If the
998 ** expression is used as a result in an aggregate SELECT, then the
999 ** value is also stored in the Expr.iAgg column in the aggregate so that
1000 ** it can be accessed after all aggregates are computed.
1001 **
1002 ** If the expression is a function, the Expr.iTable is an integer code
1003 ** representing which function.  If the expression is an unbound variable
1004 ** marker (a question mark character '?' in the original SQL) then the
1005 ** Expr.iTable holds the index number for that variable.
1006 **
1007 ** If the expression is a subquery then Expr.iColumn holds an integer
1008 ** register number containing the result of the subquery.  If the
1009 ** subquery gives a constant result, then iTable is -1.  If the subquery
1010 ** gives a different answer at different times during statement processing
1011 ** then iTable is the address of a subroutine that computes the subquery.
1012 **
1013 ** The Expr.pSelect field points to a SELECT statement.  The SELECT might
1014 ** be the right operand of an IN operator.  Or, if a scalar SELECT appears
1015 ** in an expression the opcode is TK_SELECT and Expr.pSelect is the only
1016 ** operand.
1017 **
1018 ** If the Expr is of type OP_Column, and the table it is selecting from
1019 ** is a disk table or the "old.*" pseudo-table, then pTab points to the
1020 ** corresponding table definition.
1021 */
1022 struct Expr {
1023   u8 op;                 /* Operation performed by this node */
1024   char affinity;         /* The affinity of the column or 0 if not a column */
1025   u16 flags;             /* Various flags.  See below */
1026   CollSeq *pColl;        /* The collation type of the column or 0 */
1027   Expr *pLeft, *pRight;  /* Left and right subnodes */
1028   ExprList *pList;       /* A list of expressions used as function arguments
1029                          ** or in "<expr> IN (<expr-list)" */
1030   Token token;           /* An operand token */
1031   Token span;            /* Complete text of the expression */
1032   int iTable, iColumn;   /* When op==TK_COLUMN, then this expr node means the
1033                          ** iColumn-th field of the iTable-th table. */
1034   AggInfo *pAggInfo;     /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
1035   int iAgg;              /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
1036   int iRightJoinTable;   /* If EP_FromJoin, the right table of the join */
1037   Select *pSelect;       /* When the expression is a sub-select.  Also the
1038                          ** right side of "<expr> IN (<select>)" */
1039   Table *pTab;           /* Table for OP_Column expressions. */
1040 /*  Schema *pSchema; */
1041 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1042   int nHeight;           /* Height of the tree headed by this node */
1043 #endif
1044 };
1045 
1046 /*
1047 ** The following are the meanings of bits in the Expr.flags field.
1048 */
1049 #define EP_FromJoin     0x01  /* Originated in ON or USING clause of a join */
1050 #define EP_Agg          0x02  /* Contains one or more aggregate functions */
1051 #define EP_Resolved     0x04  /* IDs have been resolved to COLUMNs */
1052 #define EP_Error        0x08  /* Expression contains one or more errors */
1053 #define EP_Distinct     0x10  /* Aggregate function with DISTINCT keyword */
1054 #define EP_VarSelect    0x20  /* pSelect is correlated, not constant */
1055 #define EP_Dequoted     0x40  /* True if the string has been dequoted */
1056 #define EP_InfixFunc    0x80  /* True for an infix function: LIKE, GLOB, etc */
1057 #define EP_ExpCollate  0x100  /* Collating sequence specified explicitly */
1058 
1059 /*
1060 ** These macros can be used to test, set, or clear bits in the
1061 ** Expr.flags field.
1062 */
1063 #define ExprHasProperty(E,P)     (((E)->flags&(P))==(P))
1064 #define ExprHasAnyProperty(E,P)  (((E)->flags&(P))!=0)
1065 #define ExprSetProperty(E,P)     (E)->flags|=(P)
1066 #define ExprClearProperty(E,P)   (E)->flags&=~(P)
1067 
1068 /*
1069 ** A list of expressions.  Each expression may optionally have a
1070 ** name.  An expr/name combination can be used in several ways, such
1071 ** as the list of "expr AS ID" fields following a "SELECT" or in the
1072 ** list of "ID = expr" items in an UPDATE.  A list of expressions can
1073 ** also be used as the argument to a function, in which case the a.zName
1074 ** field is not used.
1075 */
1076 struct ExprList {
1077   int nExpr;             /* Number of expressions on the list */
1078   int nAlloc;            /* Number of entries allocated below */
1079   int iECursor;          /* VDBE Cursor associated with this ExprList */
1080   struct ExprList_item {
1081     Expr *pExpr;           /* The list of expressions */
1082     char *zName;           /* Token associated with this expression */
1083     u8 sortOrder;          /* 1 for DESC or 0 for ASC */
1084     u8 isAgg;              /* True if this is an aggregate like count(*) */
1085     u8 done;               /* A flag to indicate when processing is finished */
1086   } *a;                  /* One entry for each expression */
1087 };
1088 
1089 /*
1090 ** An instance of this structure can hold a simple list of identifiers,
1091 ** such as the list "a,b,c" in the following statements:
1092 **
1093 **      INSERT INTO t(a,b,c) VALUES ...;
1094 **      CREATE INDEX idx ON t(a,b,c);
1095 **      CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
1096 **
1097 ** The IdList.a.idx field is used when the IdList represents the list of
1098 ** column names after a table name in an INSERT statement.  In the statement
1099 **
1100 **     INSERT INTO t(a,b,c) ...
1101 **
1102 ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
1103 */
1104 struct IdList {
1105   struct IdList_item {
1106     char *zName;      /* Name of the identifier */
1107     int idx;          /* Index in some Table.aCol[] of a column named zName */
1108   } *a;
1109   int nId;         /* Number of identifiers on the list */
1110   int nAlloc;      /* Number of entries allocated for a[] below */
1111 };
1112 
1113 /*
1114 ** The bitmask datatype defined below is used for various optimizations.
1115 **
1116 ** Changing this from a 64-bit to a 32-bit type limits the number of
1117 ** tables in a join to 32 instead of 64.  But it also reduces the size
1118 ** of the library by 738 bytes on ix86.
1119 */
1120 typedef u64 Bitmask;
1121 
1122 /*
1123 ** The following structure describes the FROM clause of a SELECT statement.
1124 ** Each table or subquery in the FROM clause is a separate element of
1125 ** the SrcList.a[] array.
1126 **
1127 ** With the addition of multiple database support, the following structure
1128 ** can also be used to describe a particular table such as the table that
1129 ** is modified by an INSERT, DELETE, or UPDATE statement.  In standard SQL,
1130 ** such a table must be a simple name: ID.  But in SQLite, the table can
1131 ** now be identified by a database name, a dot, then the table name: ID.ID.
1132 **
1133 ** The jointype starts out showing the join type between the current table
1134 ** and the next table on the list.  The parser builds the list this way.
1135 ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
1136 ** jointype expresses the join between the table and the previous table.
1137 */
1138 struct SrcList {
1139   i16 nSrc;        /* Number of tables or subqueries in the FROM clause */
1140   i16 nAlloc;      /* Number of entries allocated in a[] below */
1141   struct SrcList_item {
1142     char *zDatabase;  /* Name of database holding this table */
1143     char *zName;      /* Name of the table */
1144     char *zAlias;     /* The "B" part of a "A AS B" phrase.  zName is the "A" */
1145     Table *pTab;      /* An SQL table corresponding to zName */
1146     Select *pSelect;  /* A SELECT statement used in place of a table name */
1147     u8 isPopulated;   /* Temporary table associated with SELECT is populated */
1148     u8 jointype;      /* Type of join between this able and the previous */
1149     int iCursor;      /* The VDBE cursor number used to access this table */
1150     Expr *pOn;        /* The ON clause of a join */
1151     IdList *pUsing;   /* The USING clause of a join */
1152     Bitmask colUsed;  /* Bit N (1<<N) set if column N or pTab is used */
1153   } a[1];             /* One entry for each identifier on the list */
1154 };
1155 
1156 /*
1157 ** Permitted values of the SrcList.a.jointype field
1158 */
1159 #define JT_INNER     0x0001    /* Any kind of inner or cross join */
1160 #define JT_CROSS     0x0002    /* Explicit use of the CROSS keyword */
1161 #define JT_NATURAL   0x0004    /* True for a "natural" join */
1162 #define JT_LEFT      0x0008    /* Left outer join */
1163 #define JT_RIGHT     0x0010    /* Right outer join */
1164 #define JT_OUTER     0x0020    /* The "OUTER" keyword is present */
1165 #define JT_ERROR     0x0040    /* unknown or unsupported join type */
1166 
1167 /*
1168 ** For each nested loop in a WHERE clause implementation, the WhereInfo
1169 ** structure contains a single instance of this structure.  This structure
1170 ** is intended to be private the the where.c module and should not be
1171 ** access or modified by other modules.
1172 **
1173 ** The pIdxInfo and pBestIdx fields are used to help pick the best
1174 ** index on a virtual table.  The pIdxInfo pointer contains indexing
1175 ** information for the i-th table in the FROM clause before reordering.
1176 ** All the pIdxInfo pointers are freed by whereInfoFree() in where.c.
1177 ** The pBestIdx pointer is a copy of pIdxInfo for the i-th table after
1178 ** FROM clause ordering.  This is a little confusing so I will repeat
1179 ** it in different words.  WhereInfo.a[i].pIdxInfo is index information
1180 ** for WhereInfo.pTabList.a[i].  WhereInfo.a[i].pBestInfo is the
1181 ** index information for the i-th loop of the join.  pBestInfo is always
1182 ** either NULL or a copy of some pIdxInfo.  So for cleanup it is
1183 ** sufficient to free all of the pIdxInfo pointers.
1184 **
1185 */
1186 struct WhereLevel {
1187   int iFrom;            /* Which entry in the FROM clause */
1188   int flags;            /* Flags associated with this level */
1189   int iMem;             /* First memory cell used by this level */
1190   int iLeftJoin;        /* Memory cell used to implement LEFT OUTER JOIN */
1191   Index *pIdx;          /* Index used.  NULL if no index */
1192   int iTabCur;          /* The VDBE cursor used to access the table */
1193   int iIdxCur;          /* The VDBE cursor used to acesss pIdx */
1194   int brk;              /* Jump here to break out of the loop */
1195   int nxt;              /* Jump here to start the next IN combination */
1196   int cont;             /* Jump here to continue with the next loop cycle */
1197   int top;              /* First instruction of interior of the loop */
1198   int op, p1, p2;       /* Opcode used to terminate the loop */
1199   int nEq;              /* Number of == or IN constraints on this loop */
1200   int nIn;              /* Number of IN operators constraining this loop */
1201   struct InLoop {
1202     int iCur;              /* The VDBE cursor used by this IN operator */
1203     int topAddr;           /* Top of the IN loop */
1204   } *aInLoop;           /* Information about each nested IN operator */
1205   sqlite3_index_info *pBestIdx;  /* Index information for this level */
1206 
1207   /* The following field is really not part of the current level.  But
1208   ** we need a place to cache index information for each table in the
1209   ** FROM clause and the WhereLevel structure is a convenient place.
1210   */
1211   sqlite3_index_info *pIdxInfo;  /* Index info for n-th source table */
1212 };
1213 
1214 /*
1215 ** The WHERE clause processing routine has two halves.  The
1216 ** first part does the start of the WHERE loop and the second
1217 ** half does the tail of the WHERE loop.  An instance of
1218 ** this structure is returned by the first half and passed
1219 ** into the second half to give some continuity.
1220 */
1221 struct WhereInfo {
1222   Parse *pParse;
1223   SrcList *pTabList;   /* List of tables in the join */
1224   int iTop;            /* The very beginning of the WHERE loop */
1225   int iContinue;       /* Jump here to continue with next record */
1226   int iBreak;          /* Jump here to break out of the loop */
1227   int nLevel;          /* Number of nested loop */
1228   sqlite3_index_info **apInfo;  /* Array of pointers to index info structures */
1229   WhereLevel a[1];     /* Information about each nest loop in the WHERE */
1230 };
1231 
1232 /*
1233 ** A NameContext defines a context in which to resolve table and column
1234 ** names.  The context consists of a list of tables (the pSrcList) field and
1235 ** a list of named expression (pEList).  The named expression list may
1236 ** be NULL.  The pSrc corresponds to the FROM clause of a SELECT or
1237 ** to the table being operated on by INSERT, UPDATE, or DELETE.  The
1238 ** pEList corresponds to the result set of a SELECT and is NULL for
1239 ** other statements.
1240 **
1241 ** NameContexts can be nested.  When resolving names, the inner-most
1242 ** context is searched first.  If no match is found, the next outer
1243 ** context is checked.  If there is still no match, the next context
1244 ** is checked.  This process continues until either a match is found
1245 ** or all contexts are check.  When a match is found, the nRef member of
1246 ** the context containing the match is incremented.
1247 **
1248 ** Each subquery gets a new NameContext.  The pNext field points to the
1249 ** NameContext in the parent query.  Thus the process of scanning the
1250 ** NameContext list corresponds to searching through successively outer
1251 ** subqueries looking for a match.
1252 */
1253 struct NameContext {
1254   Parse *pParse;       /* The parser */
1255   SrcList *pSrcList;   /* One or more tables used to resolve names */
1256   ExprList *pEList;    /* Optional list of named expressions */
1257   int nRef;            /* Number of names resolved by this context */
1258   int nErr;            /* Number of errors encountered while resolving names */
1259   u8 allowAgg;         /* Aggregate functions allowed here */
1260   u8 hasAgg;           /* True if aggregates are seen */
1261   u8 isCheck;          /* True if resolving names in a CHECK constraint */
1262   int nDepth;          /* Depth of subquery recursion. 1 for no recursion */
1263   AggInfo *pAggInfo;   /* Information about aggregates at this level */
1264   NameContext *pNext;  /* Next outer name context.  NULL for outermost */
1265 };
1266 
1267 /*
1268 ** An instance of the following structure contains all information
1269 ** needed to generate code for a single SELECT statement.
1270 **
1271 ** nLimit is set to -1 if there is no LIMIT clause.  nOffset is set to 0.
1272 ** If there is a LIMIT clause, the parser sets nLimit to the value of the
1273 ** limit and nOffset to the value of the offset (or 0 if there is not
1274 ** offset).  But later on, nLimit and nOffset become the memory locations
1275 ** in the VDBE that record the limit and offset counters.
1276 **
1277 ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
1278 ** These addresses must be stored so that we can go back and fill in
1279 ** the P3_KEYINFO and P2 parameters later.  Neither the KeyInfo nor
1280 ** the number of columns in P2 can be computed at the same time
1281 ** as the OP_OpenEphm instruction is coded because not
1282 ** enough information about the compound query is known at that point.
1283 ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
1284 ** for the result set.  The KeyInfo for addrOpenTran[2] contains collating
1285 ** sequences for the ORDER BY clause.
1286 */
1287 struct Select {
1288   ExprList *pEList;      /* The fields of the result */
1289   u8 op;                 /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
1290   u8 isDistinct;         /* True if the DISTINCT keyword is present */
1291   u8 isResolved;         /* True once sqlite3SelectResolve() has run. */
1292   u8 isAgg;              /* True if this is an aggregate query */
1293   u8 usesEphm;           /* True if uses an OpenEphemeral opcode */
1294   u8 disallowOrderBy;    /* Do not allow an ORDER BY to be attached if TRUE */
1295   char affinity;         /* MakeRecord with this affinity for SRT_Set */
1296   SrcList *pSrc;         /* The FROM clause */
1297   Expr *pWhere;          /* The WHERE clause */
1298   ExprList *pGroupBy;    /* The GROUP BY clause */
1299   Expr *pHaving;         /* The HAVING clause */
1300   ExprList *pOrderBy;    /* The ORDER BY clause */
1301   Select *pPrior;        /* Prior select in a compound select statement */
1302   Select *pRightmost;    /* Right-most select in a compound select statement */
1303   Expr *pLimit;          /* LIMIT expression. NULL means not used. */
1304   Expr *pOffset;         /* OFFSET expression. NULL means not used. */
1305   int iLimit, iOffset;   /* Memory registers holding LIMIT & OFFSET counters */
1306   int addrOpenEphm[3];   /* OP_OpenEphem opcodes related to this select */
1307 };
1308 
1309 /*
1310 ** The results of a select can be distributed in several ways.
1311 */
1312 #define SRT_Union        1  /* Store result as keys in an index */
1313 #define SRT_Except       2  /* Remove result from a UNION index */
1314 #define SRT_Discard      3  /* Do not save the results anywhere */
1315 
1316 /* The ORDER BY clause is ignored for all of the above */
1317 #define IgnorableOrderby(X) (X<=SRT_Discard)
1318 
1319 #define SRT_Callback     4  /* Invoke a callback with each row of result */
1320 #define SRT_Mem          5  /* Store result in a memory cell */
1321 #define SRT_Set          6  /* Store non-null results as keys in an index */
1322 #define SRT_Table        7  /* Store result as data with an automatic rowid */
1323 #define SRT_EphemTab     8  /* Create transient tab and store like SRT_Table */
1324 #define SRT_Subroutine   9  /* Call a subroutine to handle results */
1325 #define SRT_Exists      10  /* Store 1 if the result is not empty */
1326 
1327 /*
1328 ** An SQL parser context.  A copy of this structure is passed through
1329 ** the parser and down into all the parser action routine in order to
1330 ** carry around information that is global to the entire parse.
1331 **
1332 ** The structure is divided into two parts.  When the parser and code
1333 ** generate call themselves recursively, the first part of the structure
1334 ** is constant but the second part is reset at the beginning and end of
1335 ** each recursion.
1336 **
1337 ** The nTableLock and aTableLock variables are only used if the shared-cache
1338 ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
1339 ** used to store the set of table-locks required by the statement being
1340 ** compiled. Function sqlite3TableLock() is used to add entries to the
1341 ** list.
1342 */
1343 struct Parse {
1344   sqlite3 *db;         /* The main database structure */
1345   int rc;              /* Return code from execution */
1346   char *zErrMsg;       /* An error message */
1347   Vdbe *pVdbe;         /* An engine for executing database bytecode */
1348   u8 colNamesSet;      /* TRUE after OP_ColumnName has been issued to pVdbe */
1349   u8 nameClash;        /* A permanent table name clashes with temp table name */
1350   u8 checkSchema;      /* Causes schema cookie check after an error */
1351   u8 nested;           /* Number of nested calls to the parser/code generator */
1352   u8 parseError;       /* True after a parsing error.  Ticket #1794 */
1353   int nErr;            /* Number of errors seen */
1354   int nTab;            /* Number of previously allocated VDBE cursors */
1355   int nMem;            /* Number of memory cells used so far */
1356   int nSet;            /* Number of sets used so far */
1357   int ckOffset;        /* Stack offset to data used by CHECK constraints */
1358   u32 writeMask;       /* Start a write transaction on these databases */
1359   u32 cookieMask;      /* Bitmask of schema verified databases */
1360   int cookieGoto;      /* Address of OP_Goto to cookie verifier subroutine */
1361   int cookieValue[SQLITE_MAX_ATTACHED+2];  /* Values of cookies to verify */
1362 #ifndef SQLITE_OMIT_SHARED_CACHE
1363   int nTableLock;        /* Number of locks in aTableLock */
1364   TableLock *aTableLock; /* Required table locks for shared-cache mode */
1365 #endif
1366 
1367   /* Above is constant between recursions.  Below is reset before and after
1368   ** each recursion */
1369 
1370   int nVar;            /* Number of '?' variables seen in the SQL so far */
1371   int nVarExpr;        /* Number of used slots in apVarExpr[] */
1372   int nVarExprAlloc;   /* Number of allocated slots in apVarExpr[] */
1373   Expr **apVarExpr;    /* Pointers to :aaa and $aaaa wildcard expressions */
1374   u8 explain;          /* True if the EXPLAIN flag is found on the query */
1375   Token sErrToken;     /* The token at which the error occurred */
1376   Token sNameToken;    /* Token with unqualified schema object name */
1377   Token sLastToken;    /* The last token parsed */
1378   const char *zSql;    /* All SQL text */
1379   const char *zTail;   /* All SQL text past the last semicolon parsed */
1380   Table *pNewTable;    /* A table being constructed by CREATE TABLE */
1381   Trigger *pNewTrigger;     /* Trigger under construct by a CREATE TRIGGER */
1382   TriggerStack *trigStack;  /* Trigger actions being coded */
1383   const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
1384 #ifndef SQLITE_OMIT_VIRTUALTABLE
1385   Token sArg;                /* Complete text of a module argument */
1386   u8 declareVtab;            /* True if inside sqlite3_declare_vtab() */
1387   Table *pVirtualLock;       /* Require virtual table lock on this table */
1388 #endif
1389 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1390   int nHeight;            /* Expression tree height of current sub-select */
1391 #endif
1392 };
1393 
1394 #ifdef SQLITE_OMIT_VIRTUALTABLE
1395   #define IN_DECLARE_VTAB 0
1396 #else
1397   #define IN_DECLARE_VTAB (pParse->declareVtab)
1398 #endif
1399 
1400 /*
1401 ** An instance of the following structure can be declared on a stack and used
1402 ** to save the Parse.zAuthContext value so that it can be restored later.
1403 */
1404 struct AuthContext {
1405   const char *zAuthContext;   /* Put saved Parse.zAuthContext here */
1406   Parse *pParse;              /* The Parse structure */
1407 };
1408 
1409 /*
1410 ** Bitfield flags for P2 value in OP_Insert and OP_Delete
1411 */
1412 #define OPFLAG_NCHANGE   1    /* Set to update db->nChange */
1413 #define OPFLAG_LASTROWID 2    /* Set to update db->lastRowid */
1414 #define OPFLAG_ISUPDATE  4    /* This OP_Insert is an sql UPDATE */
1415 #define OPFLAG_APPEND    8    /* This is likely to be an append */
1416 
1417 /*
1418  * Each trigger present in the database schema is stored as an instance of
1419  * struct Trigger.
1420  *
1421  * Pointers to instances of struct Trigger are stored in two ways.
1422  * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
1423  *    database). This allows Trigger structures to be retrieved by name.
1424  * 2. All triggers associated with a single table form a linked list, using the
1425  *    pNext member of struct Trigger. A pointer to the first element of the
1426  *    linked list is stored as the "pTrigger" member of the associated
1427  *    struct Table.
1428  *
1429  * The "step_list" member points to the first element of a linked list
1430  * containing the SQL statements specified as the trigger program.
1431  */
1432 struct Trigger {
1433   char *name;             /* The name of the trigger                        */
1434   char *table;            /* The table or view to which the trigger applies */
1435   u8 op;                  /* One of TK_DELETE, TK_UPDATE, TK_INSERT         */
1436   u8 tr_tm;               /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
1437   Expr *pWhen;            /* The WHEN clause of the expresion (may be NULL) */
1438   IdList *pColumns;       /* If this is an UPDATE OF <column-list> trigger,
1439                              the <column-list> is stored here */
1440   Token nameToken;        /* Token containing zName. Use during parsing only */
1441   Schema *pSchema;        /* Schema containing the trigger */
1442   Schema *pTabSchema;     /* Schema containing the table */
1443   TriggerStep *step_list; /* Link list of trigger program steps             */
1444   Trigger *pNext;         /* Next trigger associated with the table */
1445 };
1446 
1447 /*
1448 ** A trigger is either a BEFORE or an AFTER trigger.  The following constants
1449 ** determine which.
1450 **
1451 ** If there are multiple triggers, you might of some BEFORE and some AFTER.
1452 ** In that cases, the constants below can be ORed together.
1453 */
1454 #define TRIGGER_BEFORE  1
1455 #define TRIGGER_AFTER   2
1456 
1457 /*
1458  * An instance of struct TriggerStep is used to store a single SQL statement
1459  * that is a part of a trigger-program.
1460  *
1461  * Instances of struct TriggerStep are stored in a singly linked list (linked
1462  * using the "pNext" member) referenced by the "step_list" member of the
1463  * associated struct Trigger instance. The first element of the linked list is
1464  * the first step of the trigger-program.
1465  *
1466  * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
1467  * "SELECT" statement. The meanings of the other members is determined by the
1468  * value of "op" as follows:
1469  *
1470  * (op == TK_INSERT)
1471  * orconf    -> stores the ON CONFLICT algorithm
1472  * pSelect   -> If this is an INSERT INTO ... SELECT ... statement, then
1473  *              this stores a pointer to the SELECT statement. Otherwise NULL.
1474  * target    -> A token holding the name of the table to insert into.
1475  * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
1476  *              this stores values to be inserted. Otherwise NULL.
1477  * pIdList   -> If this is an INSERT INTO ... (<column-names>) VALUES ...
1478  *              statement, then this stores the column-names to be
1479  *              inserted into.
1480  *
1481  * (op == TK_DELETE)
1482  * target    -> A token holding the name of the table to delete from.
1483  * pWhere    -> The WHERE clause of the DELETE statement if one is specified.
1484  *              Otherwise NULL.
1485  *
1486  * (op == TK_UPDATE)
1487  * target    -> A token holding the name of the table to update rows of.
1488  * pWhere    -> The WHERE clause of the UPDATE statement if one is specified.
1489  *              Otherwise NULL.
1490  * pExprList -> A list of the columns to update and the expressions to update
1491  *              them to. See sqlite3Update() documentation of "pChanges"
1492  *              argument.
1493  *
1494  */
1495 struct TriggerStep {
1496   int op;              /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
1497   int orconf;          /* OE_Rollback etc. */
1498   Trigger *pTrig;      /* The trigger that this step is a part of */
1499 
1500   Select *pSelect;     /* Valid for SELECT and sometimes
1501                           INSERT steps (when pExprList == 0) */
1502   Token target;        /* Valid for DELETE, UPDATE, INSERT steps */
1503   Expr *pWhere;        /* Valid for DELETE, UPDATE steps */
1504   ExprList *pExprList; /* Valid for UPDATE statements and sometimes
1505                            INSERT steps (when pSelect == 0)         */
1506   IdList *pIdList;     /* Valid for INSERT statements only */
1507   TriggerStep *pNext;  /* Next in the link-list */
1508   TriggerStep *pLast;  /* Last element in link-list. Valid for 1st elem only */
1509 };
1510 
1511 /*
1512  * An instance of struct TriggerStack stores information required during code
1513  * generation of a single trigger program. While the trigger program is being
1514  * coded, its associated TriggerStack instance is pointed to by the
1515  * "pTriggerStack" member of the Parse structure.
1516  *
1517  * The pTab member points to the table that triggers are being coded on. The
1518  * newIdx member contains the index of the vdbe cursor that points at the temp
1519  * table that stores the new.* references. If new.* references are not valid
1520  * for the trigger being coded (for example an ON DELETE trigger), then newIdx
1521  * is set to -1. The oldIdx member is analogous to newIdx, for old.* references.
1522  *
1523  * The ON CONFLICT policy to be used for the trigger program steps is stored
1524  * as the orconf member. If this is OE_Default, then the ON CONFLICT clause
1525  * specified for individual triggers steps is used.
1526  *
1527  * struct TriggerStack has a "pNext" member, to allow linked lists to be
1528  * constructed. When coding nested triggers (triggers fired by other triggers)
1529  * each nested trigger stores its parent trigger's TriggerStack as the "pNext"
1530  * pointer. Once the nested trigger has been coded, the pNext value is restored
1531  * to the pTriggerStack member of the Parse stucture and coding of the parent
1532  * trigger continues.
1533  *
1534  * Before a nested trigger is coded, the linked list pointed to by the
1535  * pTriggerStack is scanned to ensure that the trigger is not about to be coded
1536  * recursively. If this condition is detected, the nested trigger is not coded.
1537  */
1538 struct TriggerStack {
1539   Table *pTab;         /* Table that triggers are currently being coded on */
1540   int newIdx;          /* Index of vdbe cursor to "new" temp table */
1541   int oldIdx;          /* Index of vdbe cursor to "old" temp table */
1542   int orconf;          /* Current orconf policy */
1543   int ignoreJump;      /* where to jump to for a RAISE(IGNORE) */
1544   Trigger *pTrigger;   /* The trigger currently being coded */
1545   TriggerStack *pNext; /* Next trigger down on the trigger stack */
1546 };
1547 
1548 /*
1549 ** The following structure contains information used by the sqliteFix...
1550 ** routines as they walk the parse tree to make database references
1551 ** explicit.
1552 */
1553 typedef struct DbFixer DbFixer;
1554 struct DbFixer {
1555   Parse *pParse;      /* The parsing context.  Error messages written here */
1556   const char *zDb;    /* Make sure all objects are contained in this database */
1557   const char *zType;  /* Type of the container - used for error messages */
1558   const Token *pName; /* Name of the container - used for error messages */
1559 };
1560 
1561 /*
1562 ** A pointer to this structure is used to communicate information
1563 ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
1564 */
1565 typedef struct {
1566   sqlite3 *db;        /* The database being initialized */
1567   int iDb;            /* 0 for main database.  1 for TEMP, 2.. for ATTACHed */
1568   char **pzErrMsg;    /* Error message stored here */
1569   int rc;             /* Result code stored here */
1570 } InitData;
1571 
1572 /*
1573 ** Assuming zIn points to the first byte of a UTF-8 character,
1574 ** advance zIn to point to the first byte of the next UTF-8 character.
1575 */
1576 #define SQLITE_SKIP_UTF8(zIn) {                        \
1577   if( (*(zIn++))>=0xc0 ){                              \
1578     while( (*zIn & 0xc0)==0x80 ){ zIn++; }             \
1579   }                                                    \
1580 }
1581 
1582 /*
1583 ** The SQLITE_CORRUPT_BKPT macro can be either a constant (for production
1584 ** builds) or a function call (for debugging).  If it is a function call,
1585 ** it allows the operator to set a breakpoint at the spot where database
1586 ** corruption is first detected.
1587 */
1588 #ifdef SQLITE_DEBUG
1589   int sqlite3Corrupt(void);
1590 # define SQLITE_CORRUPT_BKPT sqlite3Corrupt()
1591 #else
1592 # define SQLITE_CORRUPT_BKPT SQLITE_CORRUPT
1593 #endif
1594 
1595 /*
1596 ** Internal function prototypes
1597 */
1598 int sqlite3StrICmp(const char *, const char *);
1599 int sqlite3StrNICmp(const char *, const char *, int);
1600 int sqlite3IsNumber(const char*, int*, u8);
1601 
1602 void *sqlite3MallocZero(unsigned);
1603 void *sqlite3DbMallocZero(sqlite3*, unsigned);
1604 void *sqlite3DbMallocRaw(sqlite3*, unsigned);
1605 char *sqlite3StrDup(const char*);
1606 char *sqlite3StrNDup(const char*, int);
1607 char *sqlite3DbStrDup(sqlite3*,const char*);
1608 char *sqlite3DbStrNDup(sqlite3*,const char*, int);
1609 void *sqlite3DbReallocOrFree(sqlite3 *, void *, int);
1610 void *sqlite3DbRealloc(sqlite3 *, void *, int);
1611 
1612 char *sqlite3MPrintf(sqlite3*,const char*, ...);
1613 char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
1614 #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
1615   void sqlite3DebugPrintf(const char*, ...);
1616   void *sqlite3TextToPtr(const char*);
1617 #endif
1618 void sqlite3SetString(char **, ...);
1619 void sqlite3ErrorMsg(Parse*, const char*, ...);
1620 void sqlite3ErrorClear(Parse*);
1621 void sqlite3Dequote(char*);
1622 void sqlite3DequoteExpr(sqlite3*, Expr*);
1623 int sqlite3KeywordCode(const unsigned char*, int);
1624 int sqlite3RunParser(Parse*, const char*, char **);
1625 void sqlite3FinishCoding(Parse*);
1626 Expr *sqlite3Expr(sqlite3*, int, Expr*, Expr*, const Token*);
1627 Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*, const Token*);
1628 Expr *sqlite3RegisterExpr(Parse*,Token*);
1629 Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
1630 void sqlite3ExprSpan(Expr*,Token*,Token*);
1631 Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
1632 void sqlite3ExprAssignVarNumber(Parse*, Expr*);
1633 void sqlite3ExprDelete(Expr*);
1634 ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*,Token*);
1635 void sqlite3ExprListDelete(ExprList*);
1636 int sqlite3Init(sqlite3*, char**);
1637 int sqlite3InitCallback(void*, int, char**, char**);
1638 void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
1639 void sqlite3ResetInternalSchema(sqlite3*, int);
1640 void sqlite3BeginParse(Parse*,int);
1641 void sqlite3CommitInternalChanges(sqlite3*);
1642 Table *sqlite3ResultSetOfSelect(Parse*,char*,Select*);
1643 void sqlite3OpenMasterTable(Parse *, int);
1644 void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
1645 void sqlite3AddColumn(Parse*,Token*);
1646 void sqlite3AddNotNull(Parse*, int);
1647 void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
1648 void sqlite3AddCheckConstraint(Parse*, Expr*);
1649 void sqlite3AddColumnType(Parse*,Token*);
1650 void sqlite3AddDefaultValue(Parse*,Expr*);
1651 void sqlite3AddCollateType(Parse*, Token*);
1652 void sqlite3EndTable(Parse*,Token*,Token*,Select*);
1653 
1654 void sqlite3CreateView(Parse*,Token*,Token*,Token*,Select*,int,int);
1655 
1656 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
1657   int sqlite3ViewGetColumnNames(Parse*,Table*);
1658 #else
1659 # define sqlite3ViewGetColumnNames(A,B) 0
1660 #endif
1661 
1662 void sqlite3DropTable(Parse*, SrcList*, int, int);
1663 void sqlite3DeleteTable(Table*);
1664 void sqlite3Insert(Parse*, SrcList*, ExprList*, Select*, IdList*, int);
1665 void *sqlite3ArrayAllocate(sqlite3*,void*,int,int,int*,int*,int*);
1666 IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
1667 int sqlite3IdListIndex(IdList*,const char*);
1668 SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
1669 SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*, Token*,
1670                                       Select*, Expr*, IdList*);
1671 void sqlite3SrcListShiftJoinType(SrcList*);
1672 void sqlite3SrcListAssignCursors(Parse*, SrcList*);
1673 void sqlite3IdListDelete(IdList*);
1674 void sqlite3SrcListDelete(SrcList*);
1675 void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
1676                         Token*, int, int);
1677 void sqlite3DropIndex(Parse*, SrcList*, int);
1678 int sqlite3Select(Parse*, Select*, int, int, Select*, int, int*, char *aff);
1679 Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
1680                          Expr*,ExprList*,int,Expr*,Expr*);
1681 void sqlite3SelectDelete(Select*);
1682 Table *sqlite3SrcListLookup(Parse*, SrcList*);
1683 int sqlite3IsReadOnly(Parse*, Table*, int);
1684 void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
1685 void sqlite3DeleteFrom(Parse*, SrcList*, Expr*);
1686 void sqlite3Update(Parse*, SrcList*, ExprList*, Expr*, int);
1687 WhereInfo *sqlite3WhereBegin(Parse*, SrcList*, Expr*, ExprList**);
1688 void sqlite3WhereEnd(WhereInfo*);
1689 void sqlite3ExprCodeGetColumn(Vdbe*, Table*, int, int);
1690 void sqlite3ExprCode(Parse*, Expr*);
1691 void sqlite3ExprCodeAndCache(Parse*, Expr*);
1692 int sqlite3ExprCodeExprList(Parse*, ExprList*);
1693 void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
1694 void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
1695 Table *sqlite3FindTable(sqlite3*,const char*, const char*);
1696 Table *sqlite3LocateTable(Parse*,const char*, const char*);
1697 Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
1698 void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
1699 void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
1700 void sqlite3Vacuum(Parse*);
1701 int sqlite3RunVacuum(char**, sqlite3*);
1702 char *sqlite3NameFromToken(sqlite3*, Token*);
1703 int sqlite3ExprCompare(Expr*, Expr*);
1704 int sqlite3ExprResolveNames(NameContext *, Expr *);
1705 int sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
1706 int sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
1707 Vdbe *sqlite3GetVdbe(Parse*);
1708 Expr *sqlite3CreateIdExpr(Parse *, const char*);
1709 void sqlite3Randomness(int, void*);
1710 void sqlite3RollbackAll(sqlite3*);
1711 void sqlite3CodeVerifySchema(Parse*, int);
1712 void sqlite3BeginTransaction(Parse*, int);
1713 void sqlite3CommitTransaction(Parse*);
1714 void sqlite3RollbackTransaction(Parse*);
1715 int sqlite3ExprIsConstant(Expr*);
1716 int sqlite3ExprIsConstantNotJoin(Expr*);
1717 int sqlite3ExprIsConstantOrFunction(Expr*);
1718 int sqlite3ExprIsInteger(Expr*, int*);
1719 int sqlite3IsRowid(const char*);
1720 void sqlite3GenerateRowDelete(sqlite3*, Vdbe*, Table*, int, int);
1721 void sqlite3GenerateRowIndexDelete(Vdbe*, Table*, int, char*);
1722 void sqlite3GenerateIndexKey(Vdbe*, Index*, int);
1723 void sqlite3GenerateConstraintChecks(Parse*,Table*,int,char*,int,int,int,int);
1724 void sqlite3CompleteInsertion(Parse*, Table*, int, char*, int, int, int, int);
1725 void sqlite3OpenTableAndIndices(Parse*, Table*, int, int);
1726 void sqlite3BeginWriteOperation(Parse*, int, int);
1727 Expr *sqlite3ExprDup(sqlite3*,Expr*);
1728 void sqlite3TokenCopy(sqlite3*,Token*, Token*);
1729 ExprList *sqlite3ExprListDup(sqlite3*,ExprList*);
1730 SrcList *sqlite3SrcListDup(sqlite3*,SrcList*);
1731 IdList *sqlite3IdListDup(sqlite3*,IdList*);
1732 Select *sqlite3SelectDup(sqlite3*,Select*);
1733 FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,int,u8,int);
1734 void sqlite3RegisterBuiltinFunctions(sqlite3*);
1735 void sqlite3RegisterDateTimeFunctions(sqlite3*);
1736 int sqlite3SafetyOn(sqlite3*);
1737 int sqlite3SafetyOff(sqlite3*);
1738 int sqlite3SafetyCheck(sqlite3*);
1739 void sqlite3ChangeCookie(sqlite3*, Vdbe*, int);
1740 
1741 #ifndef SQLITE_OMIT_TRIGGER
1742   void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
1743                            Expr*,int, int);
1744   void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
1745   void sqlite3DropTrigger(Parse*, SrcList*, int);
1746   void sqlite3DropTriggerPtr(Parse*, Trigger*);
1747   int sqlite3TriggersExist(Parse*, Table*, int, ExprList*);
1748   int sqlite3CodeRowTrigger(Parse*, int, ExprList*, int, Table *, int, int,
1749                            int, int);
1750   void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
1751   void sqlite3DeleteTriggerStep(TriggerStep*);
1752   TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*);
1753   TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
1754                                         ExprList*,Select*,int);
1755   TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, int);
1756   TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*);
1757   void sqlite3DeleteTrigger(Trigger*);
1758   void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
1759 #else
1760 # define sqlite3TriggersExist(A,B,C,D,E,F) 0
1761 # define sqlite3DeleteTrigger(A)
1762 # define sqlite3DropTriggerPtr(A,B)
1763 # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
1764 # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I) 0
1765 #endif
1766 
1767 int sqlite3JoinType(Parse*, Token*, Token*, Token*);
1768 void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
1769 void sqlite3DeferForeignKey(Parse*, int);
1770 #ifndef SQLITE_OMIT_AUTHORIZATION
1771   void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
1772   int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
1773   void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
1774   void sqlite3AuthContextPop(AuthContext*);
1775 #else
1776 # define sqlite3AuthRead(a,b,c,d)
1777 # define sqlite3AuthCheck(a,b,c,d,e)    SQLITE_OK
1778 # define sqlite3AuthContextPush(a,b,c)
1779 # define sqlite3AuthContextPop(a)  ((void)(a))
1780 #endif
1781 void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
1782 void sqlite3Detach(Parse*, Expr*);
1783 int sqlite3BtreeFactory(const sqlite3 *db, const char *zFilename,
1784                        int omitJournal, int nCache, int flags, Btree **ppBtree);
1785 int sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
1786 int sqlite3FixSrcList(DbFixer*, SrcList*);
1787 int sqlite3FixSelect(DbFixer*, Select*);
1788 int sqlite3FixExpr(DbFixer*, Expr*);
1789 int sqlite3FixExprList(DbFixer*, ExprList*);
1790 int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
1791 int sqlite3AtoF(const char *z, double*);
1792 char *sqlite3_snprintf(int,char*,const char*,...);
1793 int sqlite3GetInt32(const char *, int*);
1794 int sqlite3FitsIn64Bits(const char *, int);
1795 int sqlite3Utf16ByteLen(const void *pData, int nChar);
1796 int sqlite3Utf8CharLen(const char *pData, int nByte);
1797 int sqlite3Utf8Read(const u8*, const u8*, const u8**);
1798 int sqlite3PutVarint(unsigned char *, u64);
1799 int sqlite3GetVarint(const unsigned char *, u64 *);
1800 int sqlite3GetVarint32(const unsigned char *, u32 *);
1801 int sqlite3VarintLen(u64 v);
1802 void sqlite3IndexAffinityStr(Vdbe *, Index *);
1803 void sqlite3TableAffinityStr(Vdbe *, Table *);
1804 char sqlite3CompareAffinity(Expr *pExpr, char aff2);
1805 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
1806 char sqlite3ExprAffinity(Expr *pExpr);
1807 int sqlite3Atoi64(const char*, i64*);
1808 void sqlite3Error(sqlite3*, int, const char*,...);
1809 void *sqlite3HexToBlob(sqlite3*, const char *z);
1810 int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
1811 const char *sqlite3ErrStr(int);
1812 int sqlite3ReadSchema(Parse *pParse);
1813 CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char *,int,int);
1814 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName, int nName);
1815 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
1816 Expr *sqlite3ExprSetColl(Parse *pParse, Expr *, Token *);
1817 int sqlite3CheckCollSeq(Parse *, CollSeq *);
1818 int sqlite3CheckObjectName(Parse *, const char *);
1819 void sqlite3VdbeSetChanges(sqlite3 *, int);
1820 
1821 const void *sqlite3ValueText(sqlite3_value*, u8);
1822 int sqlite3ValueBytes(sqlite3_value*, u8);
1823 void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
1824                         void(*)(void*));
1825 void sqlite3ValueFree(sqlite3_value*);
1826 sqlite3_value *sqlite3ValueNew(sqlite3 *);
1827 char *sqlite3Utf16to8(sqlite3 *, const void*, int);
1828 int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
1829 void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
1830 #ifndef SQLITE_AMALGAMATION
1831 extern const unsigned char sqlite3UpperToLower[];
1832 #endif
1833 void sqlite3RootPageMoved(Db*, int, int);
1834 void sqlite3Reindex(Parse*, Token*, Token*);
1835 void sqlite3AlterFunctions(sqlite3*);
1836 void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
1837 int sqlite3GetToken(const unsigned char *, int *);
1838 void sqlite3NestedParse(Parse*, const char*, ...);
1839 void sqlite3ExpirePreparedStatements(sqlite3*);
1840 void sqlite3CodeSubselect(Parse *, Expr *);
1841 int sqlite3SelectResolve(Parse *, Select *, NameContext *);
1842 void sqlite3ColumnDefault(Vdbe *, Table *, int);
1843 void sqlite3AlterFinishAddColumn(Parse *, Token *);
1844 void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
1845 CollSeq *sqlite3GetCollSeq(sqlite3*, CollSeq *, const char *, int);
1846 char sqlite3AffinityType(const Token*);
1847 void sqlite3Analyze(Parse*, Token*, Token*);
1848 int sqlite3InvokeBusyHandler(BusyHandler*);
1849 int sqlite3FindDb(sqlite3*, Token*);
1850 int sqlite3AnalysisLoad(sqlite3*,int iDB);
1851 void sqlite3DefaultRowEst(Index*);
1852 void sqlite3RegisterLikeFunctions(sqlite3*, int);
1853 int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
1854 void sqlite3AttachFunctions(sqlite3 *);
1855 void sqlite3MinimumFileFormat(Parse*, int, int);
1856 void sqlite3SchemaFree(void *);
1857 Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
1858 int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
1859 KeyInfo *sqlite3IndexKeyinfo(Parse *, Index *);
1860 int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
1861   void (*)(sqlite3_context*,int,sqlite3_value **),
1862   void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*));
1863 int sqlite3ApiExit(sqlite3 *db, int);
1864 void sqlite3AbortOtherActiveVdbes(sqlite3 *, Vdbe *);
1865 int sqlite3OpenTempDatabase(Parse *);
1866 
1867 
1868 /*
1869 ** The interface to the LEMON-generated parser
1870 */
1871 void *sqlite3ParserAlloc(void*(*)(size_t));
1872 void sqlite3ParserFree(void*, void(*)(void*));
1873 void sqlite3Parser(void*, int, Token, Parse*);
1874 
1875 #ifndef SQLITE_OMIT_LOAD_EXTENSION
1876   void sqlite3CloseExtensions(sqlite3*);
1877   int sqlite3AutoLoadExtensions(sqlite3*);
1878 #else
1879 # define sqlite3CloseExtensions(X)
1880 # define sqlite3AutoLoadExtensions(X)  SQLITE_OK
1881 #endif
1882 
1883 #ifndef SQLITE_OMIT_SHARED_CACHE
1884   void sqlite3TableLock(Parse *, int, int, u8, const char *);
1885 #else
1886   #define sqlite3TableLock(v,w,x,y,z)
1887 #endif
1888 
1889 #ifdef SQLITE_TEST
1890   int sqlite3Utf8To8(unsigned char*);
1891 #endif
1892 
1893 /*
1894 ** The MallocDisallow() and MallocAllow() routines are like asserts.
1895 ** Call them around a section of code that you do not expect to do
1896 ** any memory allocation.
1897 */
1898 #ifdef SQLITE_MEMDEBUG
1899   void sqlite3MallocDisallow(void);
1900   void sqlite3MallocAllow(void);
1901   void sqlite3MallocBenignFailure(int);
1902   void sqlite3MallocEnterBenignBlock(int isBenign);
1903   void sqlite3MallocLeaveBenignBlock();
1904 #else
1905 # define sqlite3MallocDisallow()
1906 # define sqlite3MallocAllow()
1907 # define sqlite3MallocBenignFailure(x)
1908 # define sqlite3MallocEnterBenignBlock(x);
1909 # define sqlite3MallocLeaveBenignBlock();
1910 #endif
1911 
1912 
1913 #ifdef SQLITE_OMIT_VIRTUALTABLE
1914 #  define sqlite3VtabClear(X)
1915 #  define sqlite3VtabSync(X,Y) (Y)
1916 #  define sqlite3VtabRollback(X)
1917 #  define sqlite3VtabCommit(X)
1918 #else
1919    void sqlite3VtabClear(Table*);
1920    int sqlite3VtabSync(sqlite3 *db, int rc);
1921    int sqlite3VtabRollback(sqlite3 *db);
1922    int sqlite3VtabCommit(sqlite3 *db);
1923 #endif
1924 void sqlite3VtabLock(sqlite3_vtab*);
1925 void sqlite3VtabUnlock(sqlite3*, sqlite3_vtab*);
1926 void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*);
1927 void sqlite3VtabFinishParse(Parse*, Token*);
1928 void sqlite3VtabArgInit(Parse*);
1929 void sqlite3VtabArgExtend(Parse*, Token*);
1930 int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
1931 int sqlite3VtabCallConnect(Parse*, Table*);
1932 int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
1933 int sqlite3VtabBegin(sqlite3 *, sqlite3_vtab *);
1934 FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
1935 void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
1936 int sqlite3Reprepare(Vdbe*);
1937 void sqlite3ExprListCheckLength(Parse*, ExprList*, int, const char*);
1938 CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
1939 
1940 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
1941   int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
1942   int sqlite3JournalSize(sqlite3_vfs *);
1943   int sqlite3JournalCreate(sqlite3_file *);
1944 #else
1945   #define sqlite3JournalSize(pVfs) ((pVfs)->szOsFile)
1946 #endif
1947 
1948 #if defined(SQLITE_TEST) || SQLITE_MAX_EXPR_DEPTH>0
1949   void sqlite3ExprSetHeight(Expr *);
1950   int sqlite3SelectExprHeight(Select *);
1951 #else
1952   #define sqlite3ExprSetHeight(x)
1953 #endif
1954 
1955 u32 sqlite3Get4byte(const u8*);
1956 void sqlite3Put4byte(u8*, u32);
1957 
1958 #ifdef SQLITE_SSE
1959 #include "sseInt.h"
1960 #endif
1961 
1962 #ifdef SQLITE_DEBUG
1963   void sqlite3ParserTrace(FILE*, char *);
1964 #endif
1965 
1966 /*
1967 ** If the SQLITE_ENABLE IOTRACE exists then the global variable
1968 ** sqlite3_io_trace is a pointer to a printf-like routine used to
1969 ** print I/O tracing messages.
1970 */
1971 #ifdef SQLITE_ENABLE_IOTRACE
1972 # define IOTRACE(A)  if( sqlite3_io_trace ){ sqlite3_io_trace A; }
1973   void sqlite3VdbeIOTraceSql(Vdbe*);
1974 #else
1975 # define IOTRACE(A)
1976 # define sqlite3VdbeIOTraceSql(X)
1977 #endif
1978 SQLITE_EXTERN void (*sqlite3_io_trace)(const char*,...);
1979 
1980 #endif
1981