4
** The author disclaims copyright to this source code. In place of
5
** a legal notice, here is a blessing:
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.
11
*************************************************************************
12
** This is the header file for information that is private to the
13
** VDBE. This information used to all be at the top of the single
14
** source code file "vdbe.c". When that file became too big (over
15
** 6000 lines long) it was split up into several smaller files and
16
** this header information was factored out.
20
** intToKey() and keyToInt() used to transform the rowid. But with
21
** the latest versions of the design they are no-ops.
23
#define keyToInt(X) (X)
24
#define intToKey(X) (X)
27
** The makefile scans the vdbe.c source file and creates the following
28
** array of string constants which are the names of all VDBE opcodes. This
29
** array is defined in a separate source code file named opcode.c which is
30
** automatically generated by the makefile.
32
extern char *sqlite3OpcodeNames[];
35
** SQL is translated into a sequence of instructions to be
36
** executed by a virtual machine. Each instruction is an instance
37
** of the following structure.
39
typedef struct VdbeOp Op;
44
typedef unsigned char Bool;
47
** A cursor is a pointer into a single BTree within a database file.
48
** The cursor can seek to a BTree entry with a particular key, or
49
** loop over all entries of the Btree. You can also insert new BTree
50
** entries or retrieve the key or data from the entry that the cursor
51
** is currently pointing to.
53
** Every cursor that the virtual machine has open is represented by an
54
** instance of the following structure.
56
** If the Cursor.isTriggerRow flag is set it means that this cursor is
57
** really a single row that represents the NEW or OLD pseudo-table of
58
** a row trigger. The data for the row is stored in Cursor.pData and
59
** the rowid is in Cursor.iKey.
62
BtCursor *pCursor; /* The cursor structure of the backend */
63
i64 lastRecno; /* Last recno from a Next or NextIdx operation */
64
i64 nextRowid; /* Next rowid returned by OP_NewRowid */
65
Bool zeroed; /* True if zeroed out and ready for reuse */
66
Bool recnoIsValid; /* True if lastRecno is valid */
67
Bool keyAsData; /* The OP_Column command works on key instead of data */
68
Bool atFirst; /* True if pointing to first entry */
69
Bool useRandomRowid; /* Generate new record numbers semi-randomly */
70
Bool nullRow; /* True if pointing to a row with no data */
71
Bool nextRowidValid; /* True if the nextRowid field is valid */
72
Bool pseudoTable; /* This is a NEW or OLD pseudo-tables of a trigger */
73
Bool deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */
74
Bool intKey; /* True if the table requires integer keys */
75
Bool zeroData; /* True if table contains keys only - no data */
76
u8 bogusIncrKey; /* Something for pIncrKey to point to if pKeyInfo==0 */
77
i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */
78
Btree *pBt; /* Separate file holding temporary table */
79
int nData; /* Number of bytes in pData */
80
char *pData; /* Data for a NEW or OLD pseudo-table */
81
i64 iKey; /* Key for the NEW or OLD pseudo-table row */
82
u8 *pIncrKey; /* Pointer to pKeyInfo->incrKey */
83
KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */
84
int nField; /* Number of fields in the header */
86
/* Cached information about the header for the data record that the
87
** cursor is currently pointing to. Only valid if cacheValid is true.
88
** zRow might point to (ephemeral) data for the current row, or it might
90
Bool cacheValid; /* True if the cache is valid */
91
int payloadSize; /* Total number of bytes in the record */
92
u32 *aType; /* Type values for all entries in the record */
93
u32 *aOffset; /* Cached offsets to the start of each columns data */
94
u8 *aRow; /* Data for the current row, if all on one page */
96
typedef struct Cursor Cursor;
99
** Number of bytes of string storage space available to each stack
100
** layer without having to malloc. NBFS is short for Number of Bytes
106
** Internally, the vdbe manipulates nearly all SQL values as Mem
107
** structures. Each Mem struct may cache multiple representations (string,
108
** integer etc.) of the same value. A value (and therefore Mem structure)
109
** has the following properties:
111
** Each value has a manifest type. The manifest type of the value stored
112
** in a Mem struct is returned by the MemType(Mem*) macro. The type is
113
** one of SQLITE_NULL, SQLITE_INTEGER, SQLITE_REAL, SQLITE_TEXT or
117
i64 i; /* Integer value */
118
int n; /* Number of characters in string value, including '\0' */
119
u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
120
u8 type; /* One of MEM_Null, MEM_Str, etc. */
121
u8 enc; /* TEXT_Utf8, TEXT_Utf16le, or TEXT_Utf16be */
122
double r; /* Real value */
123
char *z; /* String or BLOB value */
124
void (*xDel)(void *); /* If not null, call this function to delete Mem.z */
125
char zShort[NBFS]; /* Space for short strings */
127
typedef struct Mem Mem;
130
** A sorter builds a list of elements to be sorted. Each element of
131
** the list is an instance of the following structure.
133
typedef struct Sorter Sorter;
135
int nKey; /* Number of bytes in the key */
136
char *zKey; /* The key by which we will sort */
138
Sorter *pNext; /* Next in the list */
142
** Number of buckets used for merge-sort.
146
/* One or more of the following flags are set to indicate the validOK
147
** representations of the value stored in the Mem struct.
149
** If the MEM_Null flag is set, then the value is an SQL NULL value.
150
** No other flags may be set in this case.
152
** If the MEM_Str flag is set then Mem.z points at a string representation.
153
** Usually this is encoded in the same unicode encoding as the main
154
** database (see below for exceptions). If the MEM_Term flag is also
155
** set, then the string is nul terminated. The MEM_Int and MEM_Real
156
** flags may coexist with the MEM_Str flag.
158
** Multiple of these values can appear in Mem.flags. But only one
159
** at a time can appear in Mem.type.
161
#define MEM_Null 0x0001 /* Value is NULL */
162
#define MEM_Str 0x0002 /* Value is a string */
163
#define MEM_Int 0x0004 /* Value is an integer */
164
#define MEM_Real 0x0008 /* Value is a real number */
165
#define MEM_Blob 0x0010 /* Value is a BLOB */
167
/* Whenever Mem contains a valid string or blob representation, one of
168
** the following flags must be set to determine the memory management
169
** policy for Mem.z. The MEM_Term flag tells us whether or not the
170
** string is \000 or \u0000 terminated
172
#define MEM_Term 0x0020 /* String rep is nul terminated */
173
#define MEM_Dyn 0x0040 /* Need to call sqliteFree() on Mem.z */
174
#define MEM_Static 0x0080 /* Mem.z points to a static string */
175
#define MEM_Ephem 0x0100 /* Mem.z points to an ephemeral string */
176
#define MEM_Short 0x0200 /* Mem.z points to Mem.zShort */
178
/* The following MEM_ value appears only in AggElem.aMem.s.flag fields.
179
** It indicates that the corresponding AggElem.aMem.z points to a
180
** aggregate function context that needs to be finalized.
182
#define MEM_AggCtx 0x0400 /* Mem.z points to an agg function context */
185
/* A VdbeFunc is just a FuncDef (defined in sqliteInt.h) that contains
186
** additional information about auxiliary information bound to arguments
187
** of the function. This is used to implement the sqlite3_get_auxdata()
188
** and sqlite3_set_auxdata() APIs. The "auxdata" is some auxiliary data
189
** that can be associated with a constant argument to a function. This
190
** allows functions such as "regexp" to compile their constant regular
191
** expression argument once and reused the compiled code for multiple
195
FuncDef *pFunc; /* The definition of the function */
196
int nAux; /* Number of entries allocated for apAux[] */
198
void *pAux; /* Aux data for the i-th argument */
199
void (*xDelete)(void *); /* Destructor for the aux data */
200
} apAux[1]; /* One slot for each function argument */
202
typedef struct VdbeFunc VdbeFunc;
205
** The "context" argument for a installable function. A pointer to an
206
** instance of this structure is the first argument to the routines used
207
** implement the SQL functions.
209
** There is a typedef for this structure in sqlite.h. So all routines,
210
** even the public interface to SQLite, can use a pointer to this structure.
211
** But this file is the only place where the internal details of this
212
** structure are known.
214
** This structure is defined inside of vdbe.c because it uses substructures
215
** (Mem) which are only defined there.
217
struct sqlite3_context {
218
FuncDef *pFunc; /* Pointer to function information. MUST BE FIRST */
219
VdbeFunc *pVdbeFunc; /* Auxilary data, if created. */
220
Mem s; /* The return value is stored here */
221
void *pAgg; /* Aggregate context */
222
u8 isError; /* Set to true for an error */
223
u8 isStep; /* Current in the step function */
224
int cnt; /* Number of times that the step function has been called */
229
** An Agg structure describes an Aggregator. Each Agg consists of
230
** zero or more Aggregator elements (AggElem). Each AggElem contains
231
** a key and one or more values. The values are used in processing
232
** aggregate functions in a SELECT. The key is used to implement
233
** the GROUP BY clause of a select.
235
typedef struct Agg Agg;
236
typedef struct AggElem AggElem;
238
int nMem; /* Number of values stored in each AggElem */
239
AggElem *pCurrent; /* The AggElem currently in focus */
240
FuncDef **apFunc; /* Information about aggregate functions */
241
Btree *pBtree; /* The tmp. btree used to group elements, if required. */
242
BtCursor *pCsr; /* Read/write cursor to the table in pBtree */
243
int nTab; /* Root page of the table in pBtree */
244
u8 searching; /* True between the first AggNext and AggReset */
247
char *zKey; /* The key to this AggElem */
248
int nKey; /* Number of bytes in the key, including '\0' at end */
249
Mem aMem[1]; /* The values for this AggElem */
253
** A Set structure is used for quick testing to see if a value
254
** is part of a small set. Sets are used to implement code like
256
** x.y IN ('hi','hoo','hum')
258
typedef struct Set Set;
260
Hash hash; /* A set is just a hash table */
261
HashElem *prev; /* Previously accessed hash elemen */
265
** A Keylist is a bunch of keys into a table. The keylist can
266
** grow without bound. The keylist stores the ROWIDs of database
267
** records that need to be deleted or updated.
269
typedef struct Keylist Keylist;
271
int nKey; /* Number of slots in aKey[] */
272
int nUsed; /* Next unwritten slot in aKey[] */
273
int nRead; /* Next unread slot in aKey[] */
274
Keylist *pNext; /* Next block of keys */
275
i64 aKey[1]; /* One or more keys. Extra space allocated as needed */
279
** A Context stores the last insert rowid, the last statement change count,
280
** and the current statement change count (i.e. changes since last statement).
281
** Elements of Context structure type make up the ContextStack, which is
282
** updated by the ContextPush and ContextPop opcodes (used by triggers)
284
typedef struct Context Context;
286
int lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
287
int nChange; /* Statement changes (Vdbe.nChanges) */
291
** An instance of the virtual machine. This structure contains the complete
292
** state of the virtual machine.
294
** The "sqlite3_stmt" structure pointer that is returned by sqlite3_compile()
295
** is really a pointer to an instance of this structure.
298
sqlite3 *db; /* The whole database */
299
Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
300
FILE *trace; /* Write an execution trace here, if not NULL */
301
int nOp; /* Number of instructions in the program */
302
int nOpAlloc; /* Number of slots allocated for aOp[] */
303
Op *aOp; /* Space to hold the virtual machine's program */
304
int nLabel; /* Number of labels used */
305
int nLabelAlloc; /* Number of slots allocated in aLabel[] */
306
int *aLabel; /* Space to hold the labels */
307
Mem *aStack; /* The operand stack, except string values */
308
Mem *pTos; /* Top entry in the operand stack */
309
Mem **apArg; /* Arguments to currently executing user function */
310
Mem *aColName; /* Column names to return */
311
int nCursor; /* Number of slots in apCsr[] */
312
Cursor **apCsr; /* One element of this array for each open cursor */
313
Sorter *pSort; /* A linked list of objects to be sorted */
314
int nVar; /* Number of entries in aVar[] */
315
Mem *aVar; /* Values for the OP_Variable opcode. */
316
char **azVar; /* Name of variables */
317
int okVar; /* True if azVar[] has been initialized */
318
int magic; /* Magic number for sanity checking */
319
int nMem; /* Number of memory locations currently allocated */
320
Mem *aMem; /* The memory locations */
321
Agg agg; /* Aggregate information */
322
int nCallback; /* Number of callbacks invoked so far */
323
Keylist *pList; /* A list of ROWIDs */
324
int keylistStackDepth; /* The size of the "keylist" stack */
325
Keylist **keylistStack; /* The stack used by opcodes ListPush & ListPop */
326
int contextStackDepth; /* The size of the "context" stack */
327
Context *contextStack; /* Stack used by opcodes ContextPush & ContextPop*/
328
int pc; /* The program counter */
329
int rc; /* Value to return */
330
unsigned uniqueCnt; /* Used by OP_MakeRecord when P2!=0 */
331
int errorAction; /* Recovery action to do in case of an error */
332
int inTempTrans; /* True if temp database is transactioned */
333
int returnStack[100]; /* Return address stack for OP_Gosub & OP_Return */
334
int returnDepth; /* Next unused element in returnStack[] */
335
int nResColumn; /* Number of columns in one row of the result set */
336
char **azResColumn; /* Values for one row of result */
337
int popStack; /* Pop the stack this much on entry to VdbeExec() */
338
char *zErrMsg; /* Error message written here */
339
u8 resOnStack; /* True if there are result values on the stack */
340
u8 explain; /* True if EXPLAIN present on SQL command */
341
u8 changeCntOn; /* True to update the change-counter */
342
u8 aborted; /* True if ROLLBACK in another VM causes an abort */
343
int nChange; /* Number of db changes made since last reset */
347
** The following are allowed values for Vdbe.magic
349
#define VDBE_MAGIC_INIT 0x26bceaa5 /* Building a VDBE program */
350
#define VDBE_MAGIC_RUN 0xbdf20da3 /* VDBE is ready to execute */
351
#define VDBE_MAGIC_HALT 0x519c2973 /* VDBE has completed execution */
352
#define VDBE_MAGIC_DEAD 0xb606c3c8 /* The VDBE has been deallocated */
355
** Function prototypes
357
void sqlite3VdbeFreeCursor(Cursor*);
358
void sqlite3VdbeSorterReset(Vdbe*);
359
int sqlite3VdbeAggReset(sqlite3*, Agg *, KeyInfo *);
360
void sqlite3VdbeKeylistFree(Keylist*);
361
void sqliteVdbePopStack(Vdbe*,int);
362
int sqlite3VdbeCursorMoveto(Cursor*);
363
#if !defined(NDEBUG) || defined(VDBE_PROFILE)
364
void sqlite3VdbePrintOp(FILE*, int, Op*);
366
void sqlite3VdbePrintSql(Vdbe*);
367
int sqlite3VdbeSerialTypeLen(u32);
368
u32 sqlite3VdbeSerialType(Mem*);
369
int sqlite3VdbeSerialPut(unsigned char*, Mem*);
370
int sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
371
void sqlite3VdbeDeleteAuxData(VdbeFunc*, int);
373
int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
374
int sqlite3VdbeIdxKeyCompare(Cursor*, int , const unsigned char*, int*);
375
int sqlite3VdbeIdxRowid(BtCursor *, i64 *);
376
int sqlite3MemCompare(const Mem*, const Mem*, const CollSeq*);
377
int sqlite3VdbeRecordCompare(void*,int,const void*,int, const void*);
378
int sqlite3VdbeIdxRowidLen(int,const u8*);
379
int sqlite3VdbeExec(Vdbe*);
380
int sqlite3VdbeList(Vdbe*);
381
int sqlite3VdbeHalt(Vdbe*);
382
int sqlite3VdbeChangeEncoding(Mem *, int);
383
int sqlite3VdbeMemCopy(Mem*, const Mem*);
384
void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
385
int sqlite3VdbeMemMove(Mem*, Mem*);
386
int sqlite3VdbeMemNulTerminate(Mem*);
387
int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
388
void sqlite3VdbeMemSetInt64(Mem*, i64);
389
void sqlite3VdbeMemSetDouble(Mem*, double);
390
void sqlite3VdbeMemSetNull(Mem*);
391
int sqlite3VdbeMemMakeWriteable(Mem*);
392
int sqlite3VdbeMemDynamicify(Mem*);
393
int sqlite3VdbeMemStringify(Mem*, int);
394
i64 sqlite3VdbeIntValue(Mem*);
395
int sqlite3VdbeMemIntegerify(Mem*);
396
double sqlite3VdbeRealValue(Mem*);
397
int sqlite3VdbeMemRealify(Mem*);
398
int sqlite3VdbeMemFromBtree(BtCursor*,int,int,int,Mem*);
399
void sqlite3VdbeMemRelease(Mem *p);
401
void sqlite3VdbeMemSanity(Mem*, u8);
403
int sqlite3VdbeMemTranslate(Mem*, u8);
404
void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf, int nBuf);
405
int sqlite3VdbeMemHandleBom(Mem *pMem);
added
removed
kexi/3rdparty/kexisql3/src/vdbeInt.h
