1 | /* |
2 | ** 2003 September 6 |
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 | ** 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. |
17 | */ |
18 | #ifndef SQLITE_VDBEINT_H |
19 | #define SQLITE_VDBEINT_H |
20 | |
21 | /* |
22 | ** The maximum number of times that a statement will try to reparse |
23 | ** itself before giving up and returning SQLITE_SCHEMA. |
24 | */ |
25 | #ifndef SQLITE_MAX_SCHEMA_RETRY |
26 | # define SQLITE_MAX_SCHEMA_RETRY 50 |
27 | #endif |
28 | |
29 | /* |
30 | ** VDBE_DISPLAY_P4 is true or false depending on whether or not the |
31 | ** "explain" P4 display logic is enabled. |
32 | */ |
33 | #if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) \ |
34 | || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG) \ |
35 | || defined(SQLITE_ENABLE_BYTECODE_VTAB) |
36 | # define VDBE_DISPLAY_P4 1 |
37 | #else |
38 | # define VDBE_DISPLAY_P4 0 |
39 | #endif |
40 | |
41 | /* |
42 | ** SQL is translated into a sequence of instructions to be |
43 | ** executed by a virtual machine. Each instruction is an instance |
44 | ** of the following structure. |
45 | */ |
46 | typedef struct VdbeOp Op; |
47 | |
48 | /* |
49 | ** Boolean values |
50 | */ |
51 | typedef unsigned Bool; |
52 | |
53 | /* Opaque type used by code in vdbesort.c */ |
54 | typedef struct VdbeSorter VdbeSorter; |
55 | |
56 | /* Elements of the linked list at Vdbe.pAuxData */ |
57 | typedef struct AuxData AuxData; |
58 | |
59 | /* Types of VDBE cursors */ |
60 | #define CURTYPE_BTREE 0 |
61 | #define CURTYPE_SORTER 1 |
62 | #define CURTYPE_VTAB 2 |
63 | #define CURTYPE_PSEUDO 3 |
64 | |
65 | /* |
66 | ** A VdbeCursor is an superclass (a wrapper) for various cursor objects: |
67 | ** |
68 | ** * A b-tree cursor |
69 | ** - In the main database or in an ephemeral database |
70 | ** - On either an index or a table |
71 | ** * A sorter |
72 | ** * A virtual table |
73 | ** * A one-row "pseudotable" stored in a single register |
74 | */ |
75 | typedef struct VdbeCursor VdbeCursor; |
76 | struct VdbeCursor { |
77 | u8 eCurType; /* One of the CURTYPE_* values above */ |
78 | i8 iDb; /* Index of cursor database in db->aDb[] */ |
79 | u8 nullRow; /* True if pointing to a row with no data */ |
80 | u8 deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */ |
81 | u8 isTable; /* True for rowid tables. False for indexes */ |
82 | #ifdef SQLITE_DEBUG |
83 | u8 seekOp; /* Most recent seek operation on this cursor */ |
84 | u8 wrFlag; /* The wrFlag argument to sqlite3BtreeCursor() */ |
85 | #endif |
86 | Bool isEphemeral:1; /* True for an ephemeral table */ |
87 | Bool useRandomRowid:1; /* Generate new record numbers semi-randomly */ |
88 | Bool isOrdered:1; /* True if the table is not BTREE_UNORDERED */ |
89 | Bool noReuse:1; /* OpenEphemeral may not reuse this cursor */ |
90 | u16 seekHit; /* See the OP_SeekHit and OP_IfNoHope opcodes */ |
91 | union { /* pBtx for isEphermeral. pAltMap otherwise */ |
92 | Btree *pBtx; /* Separate file holding temporary table */ |
93 | u32 *aAltMap; /* Mapping from table to index column numbers */ |
94 | } ub; |
95 | i64 seqCount; /* Sequence counter */ |
96 | |
97 | /* Cached OP_Column parse information is only valid if cacheStatus matches |
98 | ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of |
99 | ** CACHE_STALE (0) and so setting cacheStatus=CACHE_STALE guarantees that |
100 | ** the cache is out of date. */ |
101 | u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */ |
102 | int seekResult; /* Result of previous sqlite3BtreeMoveto() or 0 |
103 | ** if there have been no prior seeks on the cursor. */ |
104 | /* seekResult does not distinguish between "no seeks have ever occurred |
105 | ** on this cursor" and "the most recent seek was an exact match". |
106 | ** For CURTYPE_PSEUDO, seekResult is the register holding the record */ |
107 | |
108 | /* When a new VdbeCursor is allocated, only the fields above are zeroed. |
109 | ** The fields that follow are uninitialized, and must be individually |
110 | ** initialized prior to first use. */ |
111 | VdbeCursor *pAltCursor; /* Associated index cursor from which to read */ |
112 | union { |
113 | BtCursor *pCursor; /* CURTYPE_BTREE or _PSEUDO. Btree cursor */ |
114 | sqlite3_vtab_cursor *pVCur; /* CURTYPE_VTAB. Vtab cursor */ |
115 | VdbeSorter *pSorter; /* CURTYPE_SORTER. Sorter object */ |
116 | } uc; |
117 | KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */ |
118 | u32 iHdrOffset; /* Offset to next unparsed byte of the header */ |
119 | Pgno pgnoRoot; /* Root page of the open btree cursor */ |
120 | i16 nField; /* Number of fields in the header */ |
121 | u16 nHdrParsed; /* Number of header fields parsed so far */ |
122 | i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */ |
123 | u32 *aOffset; /* Pointer to aType[nField] */ |
124 | const u8 *aRow; /* Data for the current row, if all on one page */ |
125 | u32 payloadSize; /* Total number of bytes in the record */ |
126 | u32 szRow; /* Byte available in aRow */ |
127 | #ifdef SQLITE_ENABLE_COLUMN_USED_MASK |
128 | u64 maskUsed; /* Mask of columns used by this cursor */ |
129 | #endif |
130 | |
131 | /* 2*nField extra array elements allocated for aType[], beyond the one |
132 | ** static element declared in the structure. nField total array slots for |
133 | ** aType[] and nField+1 array slots for aOffset[] */ |
134 | u32 aType[1]; /* Type values record decode. MUST BE LAST */ |
135 | }; |
136 | |
137 | /* Return true if P is a null-only cursor |
138 | */ |
139 | #define IsNullCursor(P) \ |
140 | ((P)->eCurType==CURTYPE_PSEUDO && (P)->nullRow && (P)->seekResult==0) |
141 | |
142 | |
143 | /* |
144 | ** A value for VdbeCursor.cacheStatus that means the cache is always invalid. |
145 | */ |
146 | #define CACHE_STALE 0 |
147 | |
148 | /* |
149 | ** When a sub-program is executed (OP_Program), a structure of this type |
150 | ** is allocated to store the current value of the program counter, as |
151 | ** well as the current memory cell array and various other frame specific |
152 | ** values stored in the Vdbe struct. When the sub-program is finished, |
153 | ** these values are copied back to the Vdbe from the VdbeFrame structure, |
154 | ** restoring the state of the VM to as it was before the sub-program |
155 | ** began executing. |
156 | ** |
157 | ** The memory for a VdbeFrame object is allocated and managed by a memory |
158 | ** cell in the parent (calling) frame. When the memory cell is deleted or |
159 | ** overwritten, the VdbeFrame object is not freed immediately. Instead, it |
160 | ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame |
161 | ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing |
162 | ** this instead of deleting the VdbeFrame immediately is to avoid recursive |
163 | ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the |
164 | ** child frame are released. |
165 | ** |
166 | ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is |
167 | ** set to NULL if the currently executing frame is the main program. |
168 | */ |
169 | typedef struct VdbeFrame VdbeFrame; |
170 | struct VdbeFrame { |
171 | Vdbe *v; /* VM this frame belongs to */ |
172 | VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */ |
173 | Op *aOp; /* Program instructions for parent frame */ |
174 | i64 *anExec; /* Event counters from parent frame */ |
175 | Mem *aMem; /* Array of memory cells for parent frame */ |
176 | VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */ |
177 | u8 *aOnce; /* Bitmask used by OP_Once */ |
178 | void *token; /* Copy of SubProgram.token */ |
179 | i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */ |
180 | AuxData *pAuxData; /* Linked list of auxdata allocations */ |
181 | #if SQLITE_DEBUG |
182 | u32 iFrameMagic; /* magic number for sanity checking */ |
183 | #endif |
184 | int nCursor; /* Number of entries in apCsr */ |
185 | int pc; /* Program Counter in parent (calling) frame */ |
186 | int nOp; /* Size of aOp array */ |
187 | int nMem; /* Number of entries in aMem */ |
188 | int nChildMem; /* Number of memory cells for child frame */ |
189 | int nChildCsr; /* Number of cursors for child frame */ |
190 | i64 nChange; /* Statement changes (Vdbe.nChange) */ |
191 | i64 nDbChange; /* Value of db->nChange */ |
192 | }; |
193 | |
194 | /* Magic number for sanity checking on VdbeFrame objects */ |
195 | #define SQLITE_FRAME_MAGIC 0x879fb71e |
196 | |
197 | /* |
198 | ** Return a pointer to the array of registers allocated for use |
199 | ** by a VdbeFrame. |
200 | */ |
201 | #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))]) |
202 | |
203 | /* |
204 | ** Internally, the vdbe manipulates nearly all SQL values as Mem |
205 | ** structures. Each Mem struct may cache multiple representations (string, |
206 | ** integer etc.) of the same value. |
207 | */ |
208 | struct sqlite3_value { |
209 | union MemValue { |
210 | double r; /* Real value used when MEM_Real is set in flags */ |
211 | i64 i; /* Integer value used when MEM_Int is set in flags */ |
212 | int nZero; /* Extra zero bytes when MEM_Zero and MEM_Blob set */ |
213 | const char *zPType; /* Pointer type when MEM_Term|MEM_Subtype|MEM_Null */ |
214 | FuncDef *pDef; /* Used only when flags==MEM_Agg */ |
215 | } u; |
216 | char *z; /* String or BLOB value */ |
217 | int n; /* Number of characters in string value, excluding '\0' */ |
218 | u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */ |
219 | u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */ |
220 | u8 eSubtype; /* Subtype for this value */ |
221 | /* ShallowCopy only needs to copy the information above */ |
222 | sqlite3 *db; /* The associated database connection */ |
223 | int szMalloc; /* Size of the zMalloc allocation */ |
224 | u32 uTemp; /* Transient storage for serial_type in OP_MakeRecord */ |
225 | char *zMalloc; /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */ |
226 | void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */ |
227 | #ifdef SQLITE_DEBUG |
228 | Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */ |
229 | u16 mScopyFlags; /* flags value immediately after the shallow copy */ |
230 | #endif |
231 | }; |
232 | |
233 | /* |
234 | ** Size of struct Mem not including the Mem.zMalloc member or anything that |
235 | ** follows. |
236 | */ |
237 | #define MEMCELLSIZE offsetof(Mem,db) |
238 | |
239 | /* One or more of the following flags are set to indicate the |
240 | ** representations of the value stored in the Mem struct. |
241 | ** |
242 | ** * MEM_Null An SQL NULL value |
243 | ** |
244 | ** * MEM_Null|MEM_Zero An SQL NULL with the virtual table |
245 | ** UPDATE no-change flag set |
246 | ** |
247 | ** * MEM_Null|MEM_Term| An SQL NULL, but also contains a |
248 | ** MEM_Subtype pointer accessible using |
249 | ** sqlite3_value_pointer(). |
250 | ** |
251 | ** * MEM_Null|MEM_Cleared Special SQL NULL that compares non-equal |
252 | ** to other NULLs even using the IS operator. |
253 | ** |
254 | ** * MEM_Str A string, stored in Mem.z with |
255 | ** length Mem.n. Zero-terminated if |
256 | ** MEM_Term is set. This flag is |
257 | ** incompatible with MEM_Blob and |
258 | ** MEM_Null, but can appear with MEM_Int, |
259 | ** MEM_Real, and MEM_IntReal. |
260 | ** |
261 | ** * MEM_Blob A blob, stored in Mem.z length Mem.n. |
262 | ** Incompatible with MEM_Str, MEM_Null, |
263 | ** MEM_Int, MEM_Real, and MEM_IntReal. |
264 | ** |
265 | ** * MEM_Blob|MEM_Zero A blob in Mem.z of length Mem.n plus |
266 | ** MEM.u.i extra 0x00 bytes at the end. |
267 | ** |
268 | ** * MEM_Int Integer stored in Mem.u.i. |
269 | ** |
270 | ** * MEM_Real Real stored in Mem.u.r. |
271 | ** |
272 | ** * MEM_IntReal Real stored as an integer in Mem.u.i. |
273 | ** |
274 | ** If the MEM_Null flag is set, then the value is an SQL NULL value. |
275 | ** For a pointer type created using sqlite3_bind_pointer() or |
276 | ** sqlite3_result_pointer() the MEM_Term and MEM_Subtype flags are also set. |
277 | ** |
278 | ** If the MEM_Str flag is set then Mem.z points at a string representation. |
279 | ** Usually this is encoded in the same unicode encoding as the main |
280 | ** database (see below for exceptions). If the MEM_Term flag is also |
281 | ** set, then the string is nul terminated. The MEM_Int and MEM_Real |
282 | ** flags may coexist with the MEM_Str flag. |
283 | */ |
284 | #define MEM_Undefined 0x0000 /* Value is undefined */ |
285 | #define MEM_Null 0x0001 /* Value is NULL (or a pointer) */ |
286 | #define MEM_Str 0x0002 /* Value is a string */ |
287 | #define MEM_Int 0x0004 /* Value is an integer */ |
288 | #define MEM_Real 0x0008 /* Value is a real number */ |
289 | #define MEM_Blob 0x0010 /* Value is a BLOB */ |
290 | #define MEM_IntReal 0x0020 /* MEM_Int that stringifies like MEM_Real */ |
291 | #define MEM_AffMask 0x003f /* Mask of affinity bits */ |
292 | |
293 | /* Extra bits that modify the meanings of the core datatypes above |
294 | */ |
295 | #define MEM_FromBind 0x0040 /* Value originates from sqlite3_bind() */ |
296 | /* 0x0080 // Available */ |
297 | #define MEM_Cleared 0x0100 /* NULL set by OP_Null, not from data */ |
298 | #define MEM_Term 0x0200 /* String in Mem.z is zero terminated */ |
299 | #define MEM_Zero 0x0400 /* Mem.i contains count of 0s appended to blob */ |
300 | #define MEM_Subtype 0x0800 /* Mem.eSubtype is valid */ |
301 | #define MEM_TypeMask 0x0dbf /* Mask of type bits */ |
302 | |
303 | /* Bits that determine the storage for Mem.z for a string or blob or |
304 | ** aggregate accumulator. |
305 | */ |
306 | #define MEM_Dyn 0x1000 /* Need to call Mem.xDel() on Mem.z */ |
307 | #define MEM_Static 0x2000 /* Mem.z points to a static string */ |
308 | #define MEM_Ephem 0x4000 /* Mem.z points to an ephemeral string */ |
309 | #define MEM_Agg 0x8000 /* Mem.z points to an agg function context */ |
310 | |
311 | /* Return TRUE if Mem X contains dynamically allocated content - anything |
312 | ** that needs to be deallocated to avoid a leak. |
313 | */ |
314 | #define VdbeMemDynamic(X) \ |
315 | (((X)->flags&(MEM_Agg|MEM_Dyn))!=0) |
316 | |
317 | /* |
318 | ** Clear any existing type flags from a Mem and replace them with f |
319 | */ |
320 | #define MemSetTypeFlag(p, f) \ |
321 | ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f) |
322 | |
323 | /* |
324 | ** True if Mem X is a NULL-nochng type. |
325 | */ |
326 | #define MemNullNochng(X) \ |
327 | (((X)->flags&MEM_TypeMask)==(MEM_Null|MEM_Zero) \ |
328 | && (X)->n==0 && (X)->u.nZero==0) |
329 | |
330 | /* |
331 | ** Return true if a memory cell has been initialized and is valid. |
332 | ** is for use inside assert() statements only. |
333 | ** |
334 | ** A Memory cell is initialized if at least one of the |
335 | ** MEM_Null, MEM_Str, MEM_Int, MEM_Real, MEM_Blob, or MEM_IntReal bits |
336 | ** is set. It is "undefined" if all those bits are zero. |
337 | */ |
338 | #ifdef SQLITE_DEBUG |
339 | #define memIsValid(M) ((M)->flags & MEM_AffMask)!=0 |
340 | #endif |
341 | |
342 | /* |
343 | ** Each auxiliary data pointer stored by a user defined function |
344 | ** implementation calling sqlite3_set_auxdata() is stored in an instance |
345 | ** of this structure. All such structures associated with a single VM |
346 | ** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed |
347 | ** when the VM is halted (if not before). |
348 | */ |
349 | struct AuxData { |
350 | int iAuxOp; /* Instruction number of OP_Function opcode */ |
351 | int iAuxArg; /* Index of function argument. */ |
352 | void *pAux; /* Aux data pointer */ |
353 | void (*xDeleteAux)(void*); /* Destructor for the aux data */ |
354 | AuxData *pNextAux; /* Next element in list */ |
355 | }; |
356 | |
357 | /* |
358 | ** The "context" argument for an installable function. A pointer to an |
359 | ** instance of this structure is the first argument to the routines used |
360 | ** implement the SQL functions. |
361 | ** |
362 | ** There is a typedef for this structure in sqlite.h. So all routines, |
363 | ** even the public interface to SQLite, can use a pointer to this structure. |
364 | ** But this file is the only place where the internal details of this |
365 | ** structure are known. |
366 | ** |
367 | ** This structure is defined inside of vdbeInt.h because it uses substructures |
368 | ** (Mem) which are only defined there. |
369 | */ |
370 | struct sqlite3_context { |
371 | Mem *pOut; /* The return value is stored here */ |
372 | FuncDef *pFunc; /* Pointer to function information */ |
373 | Mem *pMem; /* Memory cell used to store aggregate context */ |
374 | Vdbe *pVdbe; /* The VM that owns this context */ |
375 | int iOp; /* Instruction number of OP_Function */ |
376 | int isError; /* Error code returned by the function. */ |
377 | u8 enc; /* Encoding to use for results */ |
378 | u8 skipFlag; /* Skip accumulator loading if true */ |
379 | u8 argc; /* Number of arguments */ |
380 | sqlite3_value *argv[1]; /* Argument set */ |
381 | }; |
382 | |
383 | /* A bitfield type for use inside of structures. Always follow with :N where |
384 | ** N is the number of bits. |
385 | */ |
386 | typedef unsigned bft; /* Bit Field Type */ |
387 | |
388 | /* The ScanStatus object holds a single value for the |
389 | ** sqlite3_stmt_scanstatus() interface. |
390 | */ |
391 | typedef struct ScanStatus ScanStatus; |
392 | struct ScanStatus { |
393 | int addrExplain; /* OP_Explain for loop */ |
394 | int addrLoop; /* Address of "loops" counter */ |
395 | int addrVisit; /* Address of "rows visited" counter */ |
396 | int iSelectID; /* The "Select-ID" for this loop */ |
397 | LogEst nEst; /* Estimated output rows per loop */ |
398 | char *zName; /* Name of table or index */ |
399 | }; |
400 | |
401 | /* The DblquoteStr object holds the text of a double-quoted |
402 | ** string for a prepared statement. A linked list of these objects |
403 | ** is constructed during statement parsing and is held on Vdbe.pDblStr. |
404 | ** When computing a normalized SQL statement for an SQL statement, that |
405 | ** list is consulted for each double-quoted identifier to see if the |
406 | ** identifier should really be a string literal. |
407 | */ |
408 | typedef struct DblquoteStr DblquoteStr; |
409 | struct DblquoteStr { |
410 | DblquoteStr *pNextStr; /* Next string literal in the list */ |
411 | char z[8]; /* Dequoted value for the string */ |
412 | }; |
413 | |
414 | /* |
415 | ** An instance of the virtual machine. This structure contains the complete |
416 | ** state of the virtual machine. |
417 | ** |
418 | ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare() |
419 | ** is really a pointer to an instance of this structure. |
420 | */ |
421 | struct Vdbe { |
422 | sqlite3 *db; /* The database connection that owns this statement */ |
423 | Vdbe **ppVPrev,*pVNext; /* Linked list of VDBEs with the same Vdbe.db */ |
424 | Parse *pParse; /* Parsing context used to create this Vdbe */ |
425 | ynVar nVar; /* Number of entries in aVar[] */ |
426 | int nMem; /* Number of memory locations currently allocated */ |
427 | int nCursor; /* Number of slots in apCsr[] */ |
428 | u32 cacheCtr; /* VdbeCursor row cache generation counter */ |
429 | int pc; /* The program counter */ |
430 | int rc; /* Value to return */ |
431 | i64 nChange; /* Number of db changes made since last reset */ |
432 | int iStatement; /* Statement number (or 0 if has no opened stmt) */ |
433 | i64 iCurrentTime; /* Value of julianday('now') for this statement */ |
434 | i64 nFkConstraint; /* Number of imm. FK constraints this VM */ |
435 | i64 nStmtDefCons; /* Number of def. constraints when stmt started */ |
436 | i64 nStmtDefImmCons; /* Number of def. imm constraints when stmt started */ |
437 | Mem *aMem; /* The memory locations */ |
438 | Mem **apArg; /* Arguments to currently executing user function */ |
439 | VdbeCursor **apCsr; /* One element of this array for each open cursor */ |
440 | Mem *aVar; /* Values for the OP_Variable opcode. */ |
441 | |
442 | /* When allocating a new Vdbe object, all of the fields below should be |
443 | ** initialized to zero or NULL */ |
444 | |
445 | Op *aOp; /* Space to hold the virtual machine's program */ |
446 | int nOp; /* Number of instructions in the program */ |
447 | int nOpAlloc; /* Slots allocated for aOp[] */ |
448 | Mem *aColName; /* Column names to return */ |
449 | Mem *pResultSet; /* Pointer to an array of results */ |
450 | char *zErrMsg; /* Error message written here */ |
451 | VList *pVList; /* Name of variables */ |
452 | #ifndef SQLITE_OMIT_TRACE |
453 | i64 startTime; /* Time when query started - used for profiling */ |
454 | #endif |
455 | #ifdef SQLITE_DEBUG |
456 | int rcApp; /* errcode set by sqlite3_result_error_code() */ |
457 | u32 nWrite; /* Number of write operations that have occurred */ |
458 | #endif |
459 | u16 nResColumn; /* Number of columns in one row of the result set */ |
460 | u8 errorAction; /* Recovery action to do in case of an error */ |
461 | u8 minWriteFileFormat; /* Minimum file format for writable database files */ |
462 | u8 prepFlags; /* SQLITE_PREPARE_* flags */ |
463 | u8 eVdbeState; /* On of the VDBE_*_STATE values */ |
464 | bft expired:2; /* 1: recompile VM immediately 2: when convenient */ |
465 | bft explain:2; /* True if EXPLAIN present on SQL command */ |
466 | bft changeCntOn:1; /* True to update the change-counter */ |
467 | bft usesStmtJournal:1; /* True if uses a statement journal */ |
468 | bft readOnly:1; /* True for statements that do not write */ |
469 | bft bIsReader:1; /* True for statements that read */ |
470 | yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */ |
471 | yDbMask lockMask; /* Subset of btreeMask that requires a lock */ |
472 | u32 aCounter[9]; /* Counters used by sqlite3_stmt_status() */ |
473 | char *zSql; /* Text of the SQL statement that generated this */ |
474 | #ifdef SQLITE_ENABLE_NORMALIZE |
475 | char *zNormSql; /* Normalization of the associated SQL statement */ |
476 | DblquoteStr *pDblStr; /* List of double-quoted string literals */ |
477 | #endif |
478 | void *pFree; /* Free this when deleting the vdbe */ |
479 | VdbeFrame *pFrame; /* Parent frame */ |
480 | VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */ |
481 | int nFrame; /* Number of frames in pFrame list */ |
482 | u32 expmask; /* Binding to these vars invalidates VM */ |
483 | SubProgram *pProgram; /* Linked list of all sub-programs used by VM */ |
484 | AuxData *pAuxData; /* Linked list of auxdata allocations */ |
485 | #ifdef SQLITE_ENABLE_STMT_SCANSTATUS |
486 | i64 *anExec; /* Number of times each op has been executed */ |
487 | int nScan; /* Entries in aScan[] */ |
488 | ScanStatus *aScan; /* Scan definitions for sqlite3_stmt_scanstatus() */ |
489 | #endif |
490 | }; |
491 | |
492 | /* |
493 | ** The following are allowed values for Vdbe.eVdbeState |
494 | */ |
495 | #define VDBE_INIT_STATE 0 /* Prepared statement under construction */ |
496 | #define VDBE_READY_STATE 1 /* Ready to run but not yet started */ |
497 | #define VDBE_RUN_STATE 2 /* Run in progress */ |
498 | #define VDBE_HALT_STATE 3 /* Finished. Need reset() or finalize() */ |
499 | |
500 | /* |
501 | ** Structure used to store the context required by the |
502 | ** sqlite3_preupdate_*() API functions. |
503 | */ |
504 | struct PreUpdate { |
505 | Vdbe *v; |
506 | VdbeCursor *pCsr; /* Cursor to read old values from */ |
507 | int op; /* One of SQLITE_INSERT, UPDATE, DELETE */ |
508 | u8 *aRecord; /* old.* database record */ |
509 | KeyInfo keyinfo; |
510 | UnpackedRecord *pUnpacked; /* Unpacked version of aRecord[] */ |
511 | UnpackedRecord *pNewUnpacked; /* Unpacked version of new.* record */ |
512 | int iNewReg; /* Register for new.* values */ |
513 | int iBlobWrite; /* Value returned by preupdate_blobwrite() */ |
514 | i64 iKey1; /* First key value passed to hook */ |
515 | i64 iKey2; /* Second key value passed to hook */ |
516 | Mem *aNew; /* Array of new.* values */ |
517 | Table *pTab; /* Schema object being upated */ |
518 | Index *pPk; /* PK index if pTab is WITHOUT ROWID */ |
519 | }; |
520 | |
521 | /* |
522 | ** An instance of this object is used to pass an vector of values into |
523 | ** OP_VFilter, the xFilter method of a virtual table. The vector is the |
524 | ** set of values on the right-hand side of an IN constraint. |
525 | ** |
526 | ** The value as passed into xFilter is an sqlite3_value with a "pointer" |
527 | ** type, such as is generated by sqlite3_result_pointer() and read by |
528 | ** sqlite3_value_pointer. Such values have MEM_Term|MEM_Subtype|MEM_Null |
529 | ** and a subtype of 'p'. The sqlite3_vtab_in_first() and _next() interfaces |
530 | ** know how to use this object to step through all the values in the |
531 | ** right operand of the IN constraint. |
532 | */ |
533 | typedef struct ValueList ValueList; |
534 | struct ValueList { |
535 | BtCursor *pCsr; /* An ephemeral table holding all values */ |
536 | sqlite3_value *pOut; /* Register to hold each decoded output value */ |
537 | }; |
538 | |
539 | /* Size of content associated with serial types that fit into a |
540 | ** single-byte varint. |
541 | */ |
542 | #ifndef SQLITE_AMALGAMATION |
543 | extern const u8 sqlite3SmallTypeSizes[]; |
544 | #endif |
545 | |
546 | /* |
547 | ** Function prototypes |
548 | */ |
549 | void sqlite3VdbeError(Vdbe*, const char *, ...); |
550 | void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*); |
551 | void sqlite3VdbeFreeCursorNN(Vdbe*,VdbeCursor*); |
552 | void sqliteVdbePopStack(Vdbe*,int); |
553 | int SQLITE_NOINLINE sqlite3VdbeHandleMovedCursor(VdbeCursor *p); |
554 | int SQLITE_NOINLINE sqlite3VdbeFinishMoveto(VdbeCursor*); |
555 | int sqlite3VdbeCursorRestore(VdbeCursor*); |
556 | u32 sqlite3VdbeSerialTypeLen(u32); |
557 | u8 sqlite3VdbeOneByteSerialTypeLen(u8); |
558 | #ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT |
559 | u64 sqlite3FloatSwap(u64 in); |
560 | # define swapMixedEndianFloat(X) X = sqlite3FloatSwap(X) |
561 | #else |
562 | # define swapMixedEndianFloat(X) |
563 | #endif |
564 | void sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*); |
565 | void sqlite3VdbeDeleteAuxData(sqlite3*, AuxData**, int, int); |
566 | |
567 | int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *); |
568 | int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*); |
569 | int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*); |
570 | int sqlite3VdbeExec(Vdbe*); |
571 | #if !defined(SQLITE_OMIT_EXPLAIN) || defined(SQLITE_ENABLE_BYTECODE_VTAB) |
572 | int sqlite3VdbeNextOpcode(Vdbe*,Mem*,int,int*,int*,Op**); |
573 | char *sqlite3VdbeDisplayP4(sqlite3*,Op*); |
574 | #endif |
575 | #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) |
576 | char *(sqlite3*,const Op*,const char*); |
577 | #endif |
578 | #if !defined(SQLITE_OMIT_EXPLAIN) |
579 | int sqlite3VdbeList(Vdbe*); |
580 | #endif |
581 | int sqlite3VdbeHalt(Vdbe*); |
582 | int sqlite3VdbeChangeEncoding(Mem *, int); |
583 | int sqlite3VdbeMemTooBig(Mem*); |
584 | int sqlite3VdbeMemCopy(Mem*, const Mem*); |
585 | void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int); |
586 | void sqlite3VdbeMemMove(Mem*, Mem*); |
587 | int sqlite3VdbeMemNulTerminate(Mem*); |
588 | int sqlite3VdbeMemSetStr(Mem*, const char*, i64, u8, void(*)(void*)); |
589 | void sqlite3VdbeMemSetInt64(Mem*, i64); |
590 | #ifdef SQLITE_OMIT_FLOATING_POINT |
591 | # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64 |
592 | #else |
593 | void sqlite3VdbeMemSetDouble(Mem*, double); |
594 | #endif |
595 | void sqlite3VdbeMemSetPointer(Mem*, void*, const char*, void(*)(void*)); |
596 | void sqlite3VdbeMemInit(Mem*,sqlite3*,u16); |
597 | void sqlite3VdbeMemSetNull(Mem*); |
598 | #ifndef SQLITE_OMIT_INCRBLOB |
599 | void sqlite3VdbeMemSetZeroBlob(Mem*,int); |
600 | #else |
601 | int sqlite3VdbeMemSetZeroBlob(Mem*,int); |
602 | #endif |
603 | #ifdef SQLITE_DEBUG |
604 | int sqlite3VdbeMemIsRowSet(const Mem*); |
605 | #endif |
606 | int sqlite3VdbeMemSetRowSet(Mem*); |
607 | int sqlite3VdbeMemMakeWriteable(Mem*); |
608 | int sqlite3VdbeMemStringify(Mem*, u8, u8); |
609 | int sqlite3IntFloatCompare(i64,double); |
610 | i64 sqlite3VdbeIntValue(const Mem*); |
611 | int sqlite3VdbeMemIntegerify(Mem*); |
612 | double sqlite3VdbeRealValue(Mem*); |
613 | int sqlite3VdbeBooleanValue(Mem*, int ifNull); |
614 | void sqlite3VdbeIntegerAffinity(Mem*); |
615 | int sqlite3VdbeMemRealify(Mem*); |
616 | int sqlite3VdbeMemNumerify(Mem*); |
617 | int sqlite3VdbeMemCast(Mem*,u8,u8); |
618 | int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,Mem*); |
619 | int sqlite3VdbeMemFromBtreeZeroOffset(BtCursor*,u32,Mem*); |
620 | void sqlite3VdbeMemRelease(Mem *p); |
621 | void sqlite3VdbeMemReleaseMalloc(Mem*p); |
622 | int sqlite3VdbeMemFinalize(Mem*, FuncDef*); |
623 | #ifndef SQLITE_OMIT_WINDOWFUNC |
624 | int sqlite3VdbeMemAggValue(Mem*, Mem*, FuncDef*); |
625 | #endif |
626 | #if !defined(SQLITE_OMIT_EXPLAIN) || defined(SQLITE_ENABLE_BYTECODE_VTAB) |
627 | const char *sqlite3OpcodeName(int); |
628 | #endif |
629 | int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve); |
630 | int sqlite3VdbeMemClearAndResize(Mem *pMem, int n); |
631 | int sqlite3VdbeCloseStatement(Vdbe *, int); |
632 | #ifdef SQLITE_DEBUG |
633 | int sqlite3VdbeFrameIsValid(VdbeFrame*); |
634 | #endif |
635 | void sqlite3VdbeFrameMemDel(void*); /* Destructor on Mem */ |
636 | void sqlite3VdbeFrameDelete(VdbeFrame*); /* Actually deletes the Frame */ |
637 | int sqlite3VdbeFrameRestore(VdbeFrame *); |
638 | #ifdef SQLITE_ENABLE_PREUPDATE_HOOK |
639 | void sqlite3VdbePreUpdateHook( |
640 | Vdbe*,VdbeCursor*,int,const char*,Table*,i64,int,int); |
641 | #endif |
642 | int sqlite3VdbeTransferError(Vdbe *p); |
643 | |
644 | int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *); |
645 | void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *); |
646 | void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *); |
647 | int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *); |
648 | int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *); |
649 | int sqlite3VdbeSorterRewind(const VdbeCursor *, int *); |
650 | int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *); |
651 | int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *); |
652 | |
653 | #ifdef SQLITE_DEBUG |
654 | void sqlite3VdbeIncrWriteCounter(Vdbe*, VdbeCursor*); |
655 | void sqlite3VdbeAssertAbortable(Vdbe*); |
656 | #else |
657 | # define sqlite3VdbeIncrWriteCounter(V,C) |
658 | # define sqlite3VdbeAssertAbortable(V) |
659 | #endif |
660 | |
661 | #if !defined(SQLITE_OMIT_SHARED_CACHE) |
662 | void sqlite3VdbeEnter(Vdbe*); |
663 | #else |
664 | # define sqlite3VdbeEnter(X) |
665 | #endif |
666 | |
667 | #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0 |
668 | void sqlite3VdbeLeave(Vdbe*); |
669 | #else |
670 | # define sqlite3VdbeLeave(X) |
671 | #endif |
672 | |
673 | #ifdef SQLITE_DEBUG |
674 | void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*); |
675 | int sqlite3VdbeCheckMemInvariants(Mem*); |
676 | #endif |
677 | |
678 | #ifndef SQLITE_OMIT_FOREIGN_KEY |
679 | int sqlite3VdbeCheckFk(Vdbe *, int); |
680 | #else |
681 | # define sqlite3VdbeCheckFk(p,i) 0 |
682 | #endif |
683 | |
684 | #ifdef SQLITE_DEBUG |
685 | void sqlite3VdbePrintSql(Vdbe*); |
686 | void sqlite3VdbeMemPrettyPrint(Mem *pMem, StrAccum *pStr); |
687 | #endif |
688 | #ifndef SQLITE_OMIT_UTF16 |
689 | int sqlite3VdbeMemTranslate(Mem*, u8); |
690 | int sqlite3VdbeMemHandleBom(Mem *pMem); |
691 | #endif |
692 | |
693 | #ifndef SQLITE_OMIT_INCRBLOB |
694 | int sqlite3VdbeMemExpandBlob(Mem *); |
695 | #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0) |
696 | #else |
697 | #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK |
698 | #define ExpandBlob(P) SQLITE_OK |
699 | #endif |
700 | |
701 | #endif /* !defined(SQLITE_VDBEINT_H) */ |
702 | |