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