monotone

monotone Mtn Source Tree

Root/sqlite/sqliteInt.h

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

Archive Download this file

Branches

Tags

Quick Links:     www.monotone.ca    -     Downloads    -     Documentation    -     Wiki    -     Code Forge    -     Build Status