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