Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(142)

Side by Side Diff: third_party/sqlite/sqlite-src-3080704/src/vdbeInt.h

Issue 883353008: [sql] Import reference version of SQLite 3.8.7.4. (Closed) Base URL: http://chromium.googlesource.com/chromium/src.git@master
Patch Set: Hold back encoding change which is messing up patch. Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 /* 1 /*
2 ** 2003 September 6 2 ** 2003 September 6
3 ** 3 **
4 ** The author disclaims copyright to this source code. In place of 4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing: 5 ** a legal notice, here is a blessing:
6 ** 6 **
7 ** May you do good and not evil. 7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others. 8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give. 9 ** May you share freely, never taking more than you give.
10 ** 10 **
11 ************************************************************************* 11 *************************************************************************
12 ** This is the header file for information that is private to the 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 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 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 15 ** 6000 lines long) it was split up into several smaller files and
16 ** this header information was factored out. 16 ** this header information was factored out.
17 */ 17 */
18 #ifndef _VDBEINT_H_ 18 #ifndef _VDBEINT_H_
19 #define _VDBEINT_H_ 19 #define _VDBEINT_H_
20 20
21 /* 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 /*
22 ** SQL is translated into a sequence of instructions to be 30 ** SQL is translated into a sequence of instructions to be
23 ** executed by a virtual machine. Each instruction is an instance 31 ** executed by a virtual machine. Each instruction is an instance
24 ** of the following structure. 32 ** of the following structure.
25 */ 33 */
26 typedef struct VdbeOp Op; 34 typedef struct VdbeOp Op;
27 35
28 /* 36 /*
29 ** Boolean values 37 ** Boolean values
30 */ 38 */
31 typedef unsigned char Bool; 39 typedef unsigned Bool;
40
41 /* Opaque type used by code in vdbesort.c */
42 typedef struct VdbeSorter VdbeSorter;
43
44 /* Opaque type used by the explainer */
45 typedef struct Explain Explain;
46
47 /* Elements of the linked list at Vdbe.pAuxData */
48 typedef struct AuxData AuxData;
32 49
33 /* 50 /*
34 ** A cursor is a pointer into a single BTree within a database file. 51 ** A cursor is a pointer into a single BTree within a database file.
35 ** The cursor can seek to a BTree entry with a particular key, or 52 ** The cursor can seek to a BTree entry with a particular key, or
36 ** loop over all entries of the Btree. You can also insert new BTree 53 ** loop over all entries of the Btree. You can also insert new BTree
37 ** entries or retrieve the key or data from the entry that the cursor 54 ** entries or retrieve the key or data from the entry that the cursor
38 ** is currently pointing to. 55 ** is currently pointing to.
56 **
57 ** Cursors can also point to virtual tables, sorters, or "pseudo-tables".
58 ** A pseudo-table is a single-row table implemented by registers.
39 ** 59 **
40 ** Every cursor that the virtual machine has open is represented by an 60 ** Every cursor that the virtual machine has open is represented by an
41 ** instance of the following structure. 61 ** instance of the following structure.
42 */ 62 */
43 struct VdbeCursor { 63 struct VdbeCursor {
44 BtCursor *pCursor; /* The cursor structure of the backend */ 64 BtCursor *pCursor; /* The cursor structure of the backend */
45 Btree *pBt; /* Separate file holding temporary table */ 65 Btree *pBt; /* Separate file holding temporary table */
46 KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */ 66 KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */
47 int iDb; /* Index of cursor database in db->aDb[] (or -1) */ 67 int seekResult; /* Result of previous sqlite3BtreeMoveto() */
48 int pseudoTableReg; /* Register holding pseudotable content. */ 68 int pseudoTableReg; /* Register holding pseudotable content. */
49 int nField; /* Number of fields in the header */ 69 i16 nField; /* Number of fields in the header */
50 Bool zeroed; /* True if zeroed out and ready for reuse */ 70 u16 nHdrParsed; /* Number of header fields parsed so far */
51 Bool rowidIsValid; /* True if lastRowid is valid */ 71 #ifdef SQLITE_DEBUG
52 Bool atFirst; /* True if pointing to first entry */ 72 u8 seekOp; /* Most recent seek operation on this cursor */
53 Bool useRandomRowid; /* Generate new record numbers semi-randomly */ 73 #endif
54 Bool nullRow; /* True if pointing to a row with no data */ 74 i8 iDb; /* Index of cursor database in db->aDb[] (or -1) */
55 Bool deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */ 75 u8 nullRow; /* True if pointing to a row with no data */
56 Bool isTable; /* True if a table requiring integer keys */ 76 u8 deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */
57 Bool isIndex; /* True if an index containing keys only - no data */ 77 Bool isEphemeral:1; /* True for an ephemeral table */
58 Bool isOrdered; /* True if the underlying table is BTREE_UNORDERED */ 78 Bool useRandomRowid:1;/* Generate new record numbers semi-randomly */
79 Bool isTable:1; /* True if a table requiring integer keys */
80 Bool isOrdered:1; /* True if the underlying table is BTREE_UNORDERED */
81 Pgno pgnoRoot; /* Root page of the open btree cursor */
59 sqlite3_vtab_cursor *pVtabCursor; /* The cursor for a virtual table */ 82 sqlite3_vtab_cursor *pVtabCursor; /* The cursor for a virtual table */
60 const sqlite3_module *pModule; /* Module for cursor pVtabCursor */
61 i64 seqCount; /* Sequence counter */ 83 i64 seqCount; /* Sequence counter */
62 i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */ 84 i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */
63 i64 lastRowid; /* Last rowid from a Next or NextIdx operation */ 85 VdbeSorter *pSorter; /* Sorter object for OP_SorterOpen cursors */
64
65 /* Result of last sqlite3BtreeMoveto() done by an OP_NotExists or
66 ** OP_IsUnique opcode on this cursor. */
67 int seekResult;
68 86
69 /* Cached information about the header for the data record that the 87 /* Cached information about the header for the data record that the
70 ** cursor is currently pointing to. Only valid if cacheStatus matches 88 ** cursor is currently pointing to. Only valid if cacheStatus matches
71 ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of 89 ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of
72 ** CACHE_STALE and so setting cacheStatus=CACHE_STALE guarantees that 90 ** CACHE_STALE and so setting cacheStatus=CACHE_STALE guarantees that
73 ** the cache is out of date. 91 ** the cache is out of date.
74 ** 92 **
75 ** aRow might point to (ephemeral) data for the current row, or it might 93 ** aRow might point to (ephemeral) data for the current row, or it might
76 ** be NULL. 94 ** be NULL.
77 */ 95 */
78 u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */ 96 u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */
79 int payloadSize; /* Total number of bytes in the record */ 97 u32 payloadSize; /* Total number of bytes in the record */
80 u32 *aType; /* Type values for all entries in the record */ 98 u32 szRow; /* Byte available in aRow */
81 u32 *aOffset; /* Cached offsets to the start of each columns data */ 99 u32 iHdrOffset; /* Offset to next unparsed byte of the header */
82 u8 *aRow; /* Data for the current row, if all on one page */ 100 const u8 *aRow; /* Data for the current row, if all on one page */
101 u32 *aOffset; /* Pointer to aType[nField] */
102 u32 aType[1]; /* Type values for all entries in the record */
103 /* 2*nField extra array elements allocated for aType[], beyond the one
104 ** static element declared in the structure. nField total array slots for
105 ** aType[] and nField+1 array slots for aOffset[] */
83 }; 106 };
84 typedef struct VdbeCursor VdbeCursor; 107 typedef struct VdbeCursor VdbeCursor;
85 108
86 /* 109 /*
87 ** When a sub-program is executed (OP_Program), a structure of this type 110 ** When a sub-program is executed (OP_Program), a structure of this type
88 ** is allocated to store the current value of the program counter, as 111 ** is allocated to store the current value of the program counter, as
89 ** well as the current memory cell array and various other frame specific 112 ** well as the current memory cell array and various other frame specific
90 ** values stored in the Vdbe struct. When the sub-program is finished, 113 ** values stored in the Vdbe struct. When the sub-program is finished,
91 ** these values are copied back to the Vdbe from the VdbeFrame structure, 114 ** these values are copied back to the Vdbe from the VdbeFrame structure,
92 ** restoring the state of the VM to as it was before the sub-program 115 ** restoring the state of the VM to as it was before the sub-program
93 ** began executing. 116 ** began executing.
94 ** 117 **
95 ** The memory for a VdbeFrame object is allocated and managed by a memory 118 ** The memory for a VdbeFrame object is allocated and managed by a memory
96 ** cell in the parent (calling) frame. When the memory cell is deleted or 119 ** cell in the parent (calling) frame. When the memory cell is deleted or
97 ** overwritten, the VdbeFrame object is not freed immediately. Instead, it 120 ** overwritten, the VdbeFrame object is not freed immediately. Instead, it
98 ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame 121 ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame
99 ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing 122 ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing
100 ** this instead of deleting the VdbeFrame immediately is to avoid recursive 123 ** this instead of deleting the VdbeFrame immediately is to avoid recursive
101 ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the 124 ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the
102 ** child frame are released. 125 ** child frame are released.
103 ** 126 **
104 ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is 127 ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is
105 ** set to NULL if the currently executing frame is the main program. 128 ** set to NULL if the currently executing frame is the main program.
106 */ 129 */
107 typedef struct VdbeFrame VdbeFrame; 130 typedef struct VdbeFrame VdbeFrame;
108 struct VdbeFrame { 131 struct VdbeFrame {
109 Vdbe *v; /* VM this frame belongs to */ 132 Vdbe *v; /* VM this frame belongs to */
133 VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */
134 Op *aOp; /* Program instructions for parent frame */
135 Mem *aMem; /* Array of memory cells for parent frame */
136 u8 *aOnceFlag; /* Array of OP_Once flags for parent frame */
137 VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */
138 void *token; /* Copy of SubProgram.token */
139 i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
140 int nCursor; /* Number of entries in apCsr */
110 int pc; /* Program Counter in parent (calling) frame */ 141 int pc; /* Program Counter in parent (calling) frame */
111 Op *aOp; /* Program instructions for parent frame */
112 int nOp; /* Size of aOp array */ 142 int nOp; /* Size of aOp array */
113 Mem *aMem; /* Array of memory cells for parent frame */
114 int nMem; /* Number of entries in aMem */ 143 int nMem; /* Number of entries in aMem */
115 VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */ 144 int nOnceFlag; /* Number of entries in aOnceFlag */
116 u16 nCursor; /* Number of entries in apCsr */
117 void *token; /* Copy of SubProgram.token */
118 int nChildMem; /* Number of memory cells for child frame */ 145 int nChildMem; /* Number of memory cells for child frame */
119 int nChildCsr; /* Number of cursors for child frame */ 146 int nChildCsr; /* Number of cursors for child frame */
120 i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
121 int nChange; /* Statement changes (Vdbe.nChanges) */ 147 int nChange; /* Statement changes (Vdbe.nChanges) */
122 VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */
123 }; 148 };
124 149
125 #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))]) 150 #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))])
126 151
127 /* 152 /*
128 ** A value for VdbeCursor.cacheValid that means the cache is always invalid. 153 ** A value for VdbeCursor.cacheValid that means the cache is always invalid.
129 */ 154 */
130 #define CACHE_STALE 0 155 #define CACHE_STALE 0
131 156
132 /* 157 /*
133 ** Internally, the vdbe manipulates nearly all SQL values as Mem 158 ** Internally, the vdbe manipulates nearly all SQL values as Mem
134 ** structures. Each Mem struct may cache multiple representations (string, 159 ** structures. Each Mem struct may cache multiple representations (string,
135 ** integer etc.) of the same value. 160 ** integer etc.) of the same value.
136 */ 161 */
137 struct Mem { 162 struct Mem {
138 sqlite3 *db; /* The associated database connection */ 163 union MemValue {
139 char *z; /* String or BLOB value */ 164 double r; /* Real value used when MEM_Real is set in flags */
140 double r; /* Real value */
141 union {
142 i64 i; /* Integer value used when MEM_Int is set in flags */ 165 i64 i; /* Integer value used when MEM_Int is set in flags */
143 int nZero; /* Used when bit MEM_Zero is set in flags */ 166 int nZero; /* Used when bit MEM_Zero is set in flags */
144 FuncDef *pDef; /* Used only when flags==MEM_Agg */ 167 FuncDef *pDef; /* Used only when flags==MEM_Agg */
145 RowSet *pRowSet; /* Used only when flags==MEM_RowSet */ 168 RowSet *pRowSet; /* Used only when flags==MEM_RowSet */
146 VdbeFrame *pFrame; /* Used when flags==MEM_Frame */ 169 VdbeFrame *pFrame; /* Used when flags==MEM_Frame */
147 } u; 170 } u;
171 u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
172 u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */
148 int n; /* Number of characters in string value, excluding '\0' */ 173 int n; /* Number of characters in string value, excluding '\0' */
149 u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */ 174 char *z; /* String or BLOB value */
150 u8 type; /* One of SQLITE_NULL, SQLITE_TEXT, SQLITE_INTEGER, etc */ 175 /* ShallowCopy only needs to copy the information above */
151 u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */ 176 char *zMalloc; /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */
177 int szMalloc; /* Size of the zMalloc allocation */
178 u32 uTemp; /* Transient storage for serial_type in OP_MakeRecord */
179 sqlite3 *db; /* The associated database connection */
180 void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */
152 #ifdef SQLITE_DEBUG 181 #ifdef SQLITE_DEBUG
153 Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */ 182 Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */
154 void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */ 183 void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */
155 #endif 184 #endif
156 void (*xDel)(void *); /* If not null, call this function to delete Mem.z */
157 char *zMalloc; /* Dynamic buffer allocated by sqlite3_malloc() */
158 }; 185 };
159 186
160 /* One or more of the following flags are set to indicate the validOK 187 /* One or more of the following flags are set to indicate the validOK
161 ** representations of the value stored in the Mem struct. 188 ** representations of the value stored in the Mem struct.
162 ** 189 **
163 ** If the MEM_Null flag is set, then the value is an SQL NULL value. 190 ** If the MEM_Null flag is set, then the value is an SQL NULL value.
164 ** No other flags may be set in this case. 191 ** No other flags may be set in this case.
165 ** 192 **
166 ** If the MEM_Str flag is set then Mem.z points at a string representation. 193 ** If the MEM_Str flag is set then Mem.z points at a string representation.
167 ** Usually this is encoded in the same unicode encoding as the main 194 ** Usually this is encoded in the same unicode encoding as the main
168 ** database (see below for exceptions). If the MEM_Term flag is also 195 ** database (see below for exceptions). If the MEM_Term flag is also
169 ** set, then the string is nul terminated. The MEM_Int and MEM_Real 196 ** set, then the string is nul terminated. The MEM_Int and MEM_Real
170 ** flags may coexist with the MEM_Str flag. 197 ** flags may coexist with the MEM_Str flag.
171 */ 198 */
172 #define MEM_Null 0x0001 /* Value is NULL */ 199 #define MEM_Null 0x0001 /* Value is NULL */
173 #define MEM_Str 0x0002 /* Value is a string */ 200 #define MEM_Str 0x0002 /* Value is a string */
174 #define MEM_Int 0x0004 /* Value is an integer */ 201 #define MEM_Int 0x0004 /* Value is an integer */
175 #define MEM_Real 0x0008 /* Value is a real number */ 202 #define MEM_Real 0x0008 /* Value is a real number */
176 #define MEM_Blob 0x0010 /* Value is a BLOB */ 203 #define MEM_Blob 0x0010 /* Value is a BLOB */
204 #define MEM_AffMask 0x001f /* Mask of affinity bits */
177 #define MEM_RowSet 0x0020 /* Value is a RowSet object */ 205 #define MEM_RowSet 0x0020 /* Value is a RowSet object */
178 #define MEM_Frame 0x0040 /* Value is a VdbeFrame object */ 206 #define MEM_Frame 0x0040 /* Value is a VdbeFrame object */
179 #define MEM_Invalid 0x0080 /* Value is undefined */ 207 #define MEM_Undefined 0x0080 /* Value is undefined */
180 #define MEM_TypeMask 0x00ff /* Mask of type bits */ 208 #define MEM_Cleared 0x0100 /* NULL set by OP_Null, not from data */
209 #define MEM_TypeMask 0x01ff /* Mask of type bits */
210
181 211
182 /* Whenever Mem contains a valid string or blob representation, one of 212 /* Whenever Mem contains a valid string or blob representation, one of
183 ** the following flags must be set to determine the memory management 213 ** the following flags must be set to determine the memory management
184 ** policy for Mem.z. The MEM_Term flag tells us whether or not the 214 ** policy for Mem.z. The MEM_Term flag tells us whether or not the
185 ** string is \000 or \u0000 terminated 215 ** string is \000 or \u0000 terminated
186 */ 216 */
187 #define MEM_Term 0x0200 /* String rep is nul terminated */ 217 #define MEM_Term 0x0200 /* String rep is nul terminated */
188 #define MEM_Dyn 0x0400 /* Need to call sqliteFree() on Mem.z */ 218 #define MEM_Dyn 0x0400 /* Need to call Mem.xDel() on Mem.z */
189 #define MEM_Static 0x0800 /* Mem.z points to a static string */ 219 #define MEM_Static 0x0800 /* Mem.z points to a static string */
190 #define MEM_Ephem 0x1000 /* Mem.z points to an ephemeral string */ 220 #define MEM_Ephem 0x1000 /* Mem.z points to an ephemeral string */
191 #define MEM_Agg 0x2000 /* Mem.z points to an agg function context */ 221 #define MEM_Agg 0x2000 /* Mem.z points to an agg function context */
192 #define MEM_Zero 0x4000 /* Mem.i contains count of 0s appended to blob */ 222 #define MEM_Zero 0x4000 /* Mem.i contains count of 0s appended to blob */
193 #ifdef SQLITE_OMIT_INCRBLOB 223 #ifdef SQLITE_OMIT_INCRBLOB
194 #undef MEM_Zero 224 #undef MEM_Zero
195 #define MEM_Zero 0x0000 225 #define MEM_Zero 0x0000
196 #endif 226 #endif
197 227
198 /* 228 /*
199 ** Clear any existing type flags from a Mem and replace them with f 229 ** Clear any existing type flags from a Mem and replace them with f
200 */ 230 */
201 #define MemSetTypeFlag(p, f) \ 231 #define MemSetTypeFlag(p, f) \
202 ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f) 232 ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f)
203 233
204 /* 234 /*
205 ** Return true if a memory cell is not marked as invalid. This macro 235 ** Return true if a memory cell is not marked as invalid. This macro
206 ** is for use inside assert() statements only. 236 ** is for use inside assert() statements only.
207 */ 237 */
208 #ifdef SQLITE_DEBUG 238 #ifdef SQLITE_DEBUG
209 #define memIsValid(M) ((M)->flags & MEM_Invalid)==0 239 #define memIsValid(M) ((M)->flags & MEM_Undefined)==0
210 #endif 240 #endif
211 241
212 242 /*
213 /* A VdbeFunc is just a FuncDef (defined in sqliteInt.h) that contains 243 ** Each auxiliary data pointer stored by a user defined function
214 ** additional information about auxiliary information bound to arguments 244 ** implementation calling sqlite3_set_auxdata() is stored in an instance
215 ** of the function. This is used to implement the sqlite3_get_auxdata() 245 ** of this structure. All such structures associated with a single VM
216 ** and sqlite3_set_auxdata() APIs. The "auxdata" is some auxiliary data 246 ** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed
217 ** that can be associated with a constant argument to a function. This 247 ** when the VM is halted (if not before).
218 ** allows functions such as "regexp" to compile their constant regular
219 ** expression argument once and reused the compiled code for multiple
220 ** invocations.
221 */ 248 */
222 struct VdbeFunc { 249 struct AuxData {
223 FuncDef *pFunc; /* The definition of the function */ 250 int iOp; /* Instruction number of OP_Function opcode */
224 int nAux; /* Number of entries allocated for apAux[] */ 251 int iArg; /* Index of function argument. */
225 struct AuxData { 252 void *pAux; /* Aux data pointer */
226 void *pAux; /* Aux data for the i-th argument */ 253 void (*xDelete)(void *); /* Destructor for the aux data */
227 void (*xDelete)(void *); /* Destructor for the aux data */ 254 AuxData *pNext; /* Next element in list */
228 } apAux[1]; /* One slot for each function argument */
229 }; 255 };
230 256
231 /* 257 /*
232 ** The "context" argument for a installable function. A pointer to an 258 ** The "context" argument for an installable function. A pointer to an
233 ** instance of this structure is the first argument to the routines used 259 ** instance of this structure is the first argument to the routines used
234 ** implement the SQL functions. 260 ** implement the SQL functions.
235 ** 261 **
236 ** There is a typedef for this structure in sqlite.h. So all routines, 262 ** There is a typedef for this structure in sqlite.h. So all routines,
237 ** even the public interface to SQLite, can use a pointer to this structure. 263 ** even the public interface to SQLite, can use a pointer to this structure.
238 ** But this file is the only place where the internal details of this 264 ** But this file is the only place where the internal details of this
239 ** structure are known. 265 ** structure are known.
240 ** 266 **
241 ** This structure is defined inside of vdbeInt.h because it uses substructures 267 ** This structure is defined inside of vdbeInt.h because it uses substructures
242 ** (Mem) which are only defined there. 268 ** (Mem) which are only defined there.
243 */ 269 */
244 struct sqlite3_context { 270 struct sqlite3_context {
245 FuncDef *pFunc; /* Pointer to function information. MUST BE FIRST */ 271 Mem *pOut; /* The return value is stored here */
246 VdbeFunc *pVdbeFunc; /* Auxilary data, if created. */ 272 FuncDef *pFunc; /* Pointer to function information */
247 Mem s; /* The return value is stored here */
248 Mem *pMem; /* Memory cell used to store aggregate context */ 273 Mem *pMem; /* Memory cell used to store aggregate context */
274 Vdbe *pVdbe; /* The VM that owns this context */
275 int iOp; /* Instruction number of OP_Function */
249 int isError; /* Error code returned by the function. */ 276 int isError; /* Error code returned by the function. */
250 CollSeq *pColl; /* Collating sequence */ 277 u8 skipFlag; /* Skip accumulator loading if true */
278 u8 fErrorOrAux; /* isError!=0 or pVdbe->pAuxData modified */
251 }; 279 };
252 280
253 /* 281 /*
282 ** An Explain object accumulates indented output which is helpful
283 ** in describing recursive data structures.
284 */
285 struct Explain {
286 Vdbe *pVdbe; /* Attach the explanation to this Vdbe */
287 StrAccum str; /* The string being accumulated */
288 int nIndent; /* Number of elements in aIndent */
289 u16 aIndent[100]; /* Levels of indentation */
290 char zBase[100]; /* Initial space */
291 };
292
293 /* A bitfield type for use inside of structures. Always follow with :N where
294 ** N is the number of bits.
295 */
296 typedef unsigned bft; /* Bit Field Type */
297
298 /*
254 ** An instance of the virtual machine. This structure contains the complete 299 ** An instance of the virtual machine. This structure contains the complete
255 ** state of the virtual machine. 300 ** state of the virtual machine.
256 ** 301 **
257 ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare() 302 ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare()
258 ** is really a pointer to an instance of this structure. 303 ** is really a pointer to an instance of this structure.
259 ** 304 **
260 ** The Vdbe.inVtabMethod variable is set to non-zero for the duration of 305 ** The Vdbe.inVtabMethod variable is set to non-zero for the duration of
261 ** any virtual table method invocations made by the vdbe program. It is 306 ** any virtual table method invocations made by the vdbe program. It is
262 ** set to 2 for xDestroy method calls and 1 for all other methods. This 307 ** set to 2 for xDestroy method calls and 1 for all other methods. This
263 ** variable is used for two purposes: to allow xDestroy methods to execute 308 ** variable is used for two purposes: to allow xDestroy methods to execute
264 ** "DROP TABLE" statements and to prevent some nasty side effects of 309 ** "DROP TABLE" statements and to prevent some nasty side effects of
265 ** malloc failure when SQLite is invoked recursively by a virtual table 310 ** malloc failure when SQLite is invoked recursively by a virtual table
266 ** method function. 311 ** method function.
267 */ 312 */
268 struct Vdbe { 313 struct Vdbe {
269 sqlite3 *db; /* The database connection that owns this statement */ 314 sqlite3 *db; /* The database connection that owns this statement */
270 Op *aOp; /* Space to hold the virtual machine's program */ 315 Op *aOp; /* Space to hold the virtual machine's program */
271 Mem *aMem; /* The memory locations */ 316 Mem *aMem; /* The memory locations */
272 Mem **apArg; /* Arguments to currently executing user function */ 317 Mem **apArg; /* Arguments to currently executing user function */
273 Mem *aColName; /* Column names to return */ 318 Mem *aColName; /* Column names to return */
274 Mem *pResultSet; /* Pointer to an array of results */ 319 Mem *pResultSet; /* Pointer to an array of results */
320 Parse *pParse; /* Parsing context used to create this Vdbe */
275 int nMem; /* Number of memory locations currently allocated */ 321 int nMem; /* Number of memory locations currently allocated */
276 int nOp; /* Number of instructions in the program */ 322 int nOp; /* Number of instructions in the program */
277 int nOpAlloc; /* Number of slots allocated for aOp[] */ 323 int nCursor; /* Number of slots in apCsr[] */
278 int nLabel; /* Number of labels used */
279 int nLabelAlloc; /* Number of slots allocated in aLabel[] */
280 int *aLabel; /* Space to hold the labels */
281 u16 nResColumn; /* Number of columns in one row of the result set */
282 u16 nCursor; /* Number of slots in apCsr[] */
283 u32 magic; /* Magic number for sanity checking */ 324 u32 magic; /* Magic number for sanity checking */
284 char *zErrMsg; /* Error message written here */ 325 char *zErrMsg; /* Error message written here */
285 Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */ 326 Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
286 VdbeCursor **apCsr; /* One element of this array for each open cursor */ 327 VdbeCursor **apCsr; /* One element of this array for each open cursor */
287 Mem *aVar; /* Values for the OP_Variable opcode. */ 328 Mem *aVar; /* Values for the OP_Variable opcode. */
288 char **azVar; /* Name of variables */ 329 char **azVar; /* Name of variables */
289 ynVar nVar; /* Number of entries in aVar[] */ 330 ynVar nVar; /* Number of entries in aVar[] */
331 ynVar nzVar; /* Number of entries in azVar[] */
290 u32 cacheCtr; /* VdbeCursor row cache generation counter */ 332 u32 cacheCtr; /* VdbeCursor row cache generation counter */
291 int pc; /* The program counter */ 333 int pc; /* The program counter */
292 int rc; /* Value to return */ 334 int rc; /* Value to return */
335 u16 nResColumn; /* Number of columns in one row of the result set */
293 u8 errorAction; /* Recovery action to do in case of an error */ 336 u8 errorAction; /* Recovery action to do in case of an error */
294 u8 okVar; /* True if azVar[] has been initialized */
295 u8 explain; /* True if EXPLAIN present on SQL command */
296 u8 changeCntOn; /* True to update the change-counter */
297 u8 expired; /* True if the VM needs to be recompiled */
298 u8 runOnlyOnce; /* Automatically expire on reset */
299 u8 minWriteFileFormat; /* Minimum file format for writable database files */ 337 u8 minWriteFileFormat; /* Minimum file format for writable database files */
300 u8 inVtabMethod; /* See comments above */ 338 bft explain:2; /* True if EXPLAIN present on SQL command */
301 u8 usesStmtJournal; /* True if uses a statement journal */ 339 bft inVtabMethod:2; /* See comments above */
302 u8 readOnly; /* True for read-only statements */ 340 bft changeCntOn:1; /* True to update the change-counter */
303 u8 isPrepareV2; /* True if prepared with prepare_v2() */ 341 bft expired:1; /* True if the VM needs to be recompiled */
342 bft runOnlyOnce:1; /* Automatically expire on reset */
343 bft usesStmtJournal:1; /* True if uses a statement journal */
344 bft readOnly:1; /* True for statements that do not write */
345 bft bIsReader:1; /* True for statements that read */
346 bft isPrepareV2:1; /* True if prepared with prepare_v2() */
347 bft doingRerun:1; /* True if rerunning after an auto-reprepare */
304 int nChange; /* Number of db changes made since last reset */ 348 int nChange; /* Number of db changes made since last reset */
305 yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */ 349 yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */
306 yDbMask lockMask; /* Subset of btreeMask that requires a lock */ 350 yDbMask lockMask; /* Subset of btreeMask that requires a lock */
307 int iStatement; /* Statement number (or 0 if has not opened stmt) */ 351 int iStatement; /* Statement number (or 0 if has not opened stmt) */
308 int aCounter[3]; /* Counters used by sqlite3_stmt_status() */ 352 u32 aCounter[5]; /* Counters used by sqlite3_stmt_status() */
309 #ifndef SQLITE_OMIT_TRACE 353 #ifndef SQLITE_OMIT_TRACE
310 i64 startTime; /* Time when query started - used for profiling */ 354 i64 startTime; /* Time when query started - used for profiling */
311 #endif 355 #endif
356 i64 iCurrentTime; /* Value of julianday('now') for this statement */
312 i64 nFkConstraint; /* Number of imm. FK constraints this VM */ 357 i64 nFkConstraint; /* Number of imm. FK constraints this VM */
313 i64 nStmtDefCons; /* Number of def. constraints when stmt started */ 358 i64 nStmtDefCons; /* Number of def. constraints when stmt started */
359 i64 nStmtDefImmCons; /* Number of def. imm constraints when stmt started */
314 char *zSql; /* Text of the SQL statement that generated this */ 360 char *zSql; /* Text of the SQL statement that generated this */
315 void *pFree; /* Free this when deleting the vdbe */ 361 void *pFree; /* Free this when deleting the vdbe */
316 #ifdef SQLITE_DEBUG
317 FILE *trace; /* Write an execution trace here, if not NULL */
318 #endif
319 VdbeFrame *pFrame; /* Parent frame */ 362 VdbeFrame *pFrame; /* Parent frame */
320 VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */ 363 VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */
321 int nFrame; /* Number of frames in pFrame list */ 364 int nFrame; /* Number of frames in pFrame list */
322 u32 expmask; /* Binding to these vars invalidates VM */ 365 u32 expmask; /* Binding to these vars invalidates VM */
323 SubProgram *pProgram; /* Linked list of all sub-programs used by VM */ 366 SubProgram *pProgram; /* Linked list of all sub-programs used by VM */
367 int nOnceFlag; /* Size of array aOnceFlag[] */
368 u8 *aOnceFlag; /* Flags for OP_Once */
369 AuxData *pAuxData; /* Linked list of auxdata allocations */
324 }; 370 };
325 371
326 /* 372 /*
327 ** The following are allowed values for Vdbe.magic 373 ** The following are allowed values for Vdbe.magic
328 */ 374 */
329 #define VDBE_MAGIC_INIT 0x26bceaa5 /* Building a VDBE program */ 375 #define VDBE_MAGIC_INIT 0x26bceaa5 /* Building a VDBE program */
330 #define VDBE_MAGIC_RUN 0xbdf20da3 /* VDBE is ready to execute */ 376 #define VDBE_MAGIC_RUN 0xbdf20da3 /* VDBE is ready to execute */
331 #define VDBE_MAGIC_HALT 0x519c2973 /* VDBE has completed execution */ 377 #define VDBE_MAGIC_HALT 0x519c2973 /* VDBE has completed execution */
332 #define VDBE_MAGIC_DEAD 0xb606c3c8 /* The VDBE has been deallocated */ 378 #define VDBE_MAGIC_DEAD 0xb606c3c8 /* The VDBE has been deallocated */
333 379
334 /* 380 /*
335 ** Function prototypes 381 ** Function prototypes
336 */ 382 */
337 void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*); 383 void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*);
338 void sqliteVdbePopStack(Vdbe*,int); 384 void sqliteVdbePopStack(Vdbe*,int);
339 int sqlite3VdbeCursorMoveto(VdbeCursor*); 385 int sqlite3VdbeCursorMoveto(VdbeCursor*);
386 int sqlite3VdbeCursorRestore(VdbeCursor*);
340 #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE) 387 #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
341 void sqlite3VdbePrintOp(FILE*, int, Op*); 388 void sqlite3VdbePrintOp(FILE*, int, Op*);
342 #endif 389 #endif
343 u32 sqlite3VdbeSerialTypeLen(u32); 390 u32 sqlite3VdbeSerialTypeLen(u32);
344 u32 sqlite3VdbeSerialType(Mem*, int); 391 u32 sqlite3VdbeSerialType(Mem*, int);
345 u32 sqlite3VdbeSerialPut(unsigned char*, int, Mem*, int); 392 u32 sqlite3VdbeSerialPut(unsigned char*, Mem*, u32);
346 u32 sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*); 393 u32 sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
347 void sqlite3VdbeDeleteAuxData(VdbeFunc*, int); 394 void sqlite3VdbeDeleteAuxData(Vdbe*, int, int);
348 395
349 int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *); 396 int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
350 int sqlite3VdbeIdxKeyCompare(VdbeCursor*,UnpackedRecord*,int*); 397 int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*);
351 int sqlite3VdbeIdxRowid(sqlite3*, BtCursor *, i64 *); 398 int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*);
352 int sqlite3MemCompare(const Mem*, const Mem*, const CollSeq*);
353 int sqlite3VdbeExec(Vdbe*); 399 int sqlite3VdbeExec(Vdbe*);
354 int sqlite3VdbeList(Vdbe*); 400 int sqlite3VdbeList(Vdbe*);
355 int sqlite3VdbeHalt(Vdbe*); 401 int sqlite3VdbeHalt(Vdbe*);
356 int sqlite3VdbeChangeEncoding(Mem *, int); 402 int sqlite3VdbeChangeEncoding(Mem *, int);
357 int sqlite3VdbeMemTooBig(Mem*); 403 int sqlite3VdbeMemTooBig(Mem*);
358 int sqlite3VdbeMemCopy(Mem*, const Mem*); 404 int sqlite3VdbeMemCopy(Mem*, const Mem*);
359 void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int); 405 void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
360 void sqlite3VdbeMemMove(Mem*, Mem*); 406 void sqlite3VdbeMemMove(Mem*, Mem*);
361 int sqlite3VdbeMemNulTerminate(Mem*); 407 int sqlite3VdbeMemNulTerminate(Mem*);
362 int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*)); 408 int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
363 void sqlite3VdbeMemSetInt64(Mem*, i64); 409 void sqlite3VdbeMemSetInt64(Mem*, i64);
364 #ifdef SQLITE_OMIT_FLOATING_POINT 410 #ifdef SQLITE_OMIT_FLOATING_POINT
365 # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64 411 # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64
366 #else 412 #else
367 void sqlite3VdbeMemSetDouble(Mem*, double); 413 void sqlite3VdbeMemSetDouble(Mem*, double);
368 #endif 414 #endif
415 void sqlite3VdbeMemInit(Mem*,sqlite3*,u16);
369 void sqlite3VdbeMemSetNull(Mem*); 416 void sqlite3VdbeMemSetNull(Mem*);
370 void sqlite3VdbeMemSetZeroBlob(Mem*,int); 417 void sqlite3VdbeMemSetZeroBlob(Mem*,int);
371 void sqlite3VdbeMemSetRowSet(Mem*); 418 void sqlite3VdbeMemSetRowSet(Mem*);
372 int sqlite3VdbeMemMakeWriteable(Mem*); 419 int sqlite3VdbeMemMakeWriteable(Mem*);
373 int sqlite3VdbeMemStringify(Mem*, int); 420 int sqlite3VdbeMemStringify(Mem*, u8, u8);
374 i64 sqlite3VdbeIntValue(Mem*); 421 i64 sqlite3VdbeIntValue(Mem*);
375 int sqlite3VdbeMemIntegerify(Mem*); 422 int sqlite3VdbeMemIntegerify(Mem*);
376 double sqlite3VdbeRealValue(Mem*); 423 double sqlite3VdbeRealValue(Mem*);
377 void sqlite3VdbeIntegerAffinity(Mem*); 424 void sqlite3VdbeIntegerAffinity(Mem*);
378 int sqlite3VdbeMemRealify(Mem*); 425 int sqlite3VdbeMemRealify(Mem*);
379 int sqlite3VdbeMemNumerify(Mem*); 426 int sqlite3VdbeMemNumerify(Mem*);
380 int sqlite3VdbeMemFromBtree(BtCursor*,int,int,int,Mem*); 427 void sqlite3VdbeMemCast(Mem*,u8,u8);
428 int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,int,Mem*);
381 void sqlite3VdbeMemRelease(Mem *p); 429 void sqlite3VdbeMemRelease(Mem *p);
382 void sqlite3VdbeMemReleaseExternal(Mem *p); 430 #define VdbeMemDynamic(X) \
431 (((X)->flags&(MEM_Agg|MEM_Dyn|MEM_RowSet|MEM_Frame))!=0)
383 int sqlite3VdbeMemFinalize(Mem*, FuncDef*); 432 int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
384 const char *sqlite3OpcodeName(int); 433 const char *sqlite3OpcodeName(int);
385 int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve); 434 int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
435 int sqlite3VdbeMemClearAndResize(Mem *pMem, int n);
386 int sqlite3VdbeCloseStatement(Vdbe *, int); 436 int sqlite3VdbeCloseStatement(Vdbe *, int);
387 void sqlite3VdbeFrameDelete(VdbeFrame*); 437 void sqlite3VdbeFrameDelete(VdbeFrame*);
388 int sqlite3VdbeFrameRestore(VdbeFrame *); 438 int sqlite3VdbeFrameRestore(VdbeFrame *);
389 void sqlite3VdbeMemStoreType(Mem *pMem); 439 int sqlite3VdbeTransferError(Vdbe *p);
440
441 int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *);
442 void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *);
443 void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *);
444 int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *);
445 int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *, int *);
446 int sqlite3VdbeSorterRewind(const VdbeCursor *, int *);
447 int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *);
448 int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *);
390 449
391 #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0 450 #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
392 void sqlite3VdbeEnter(Vdbe*); 451 void sqlite3VdbeEnter(Vdbe*);
393 void sqlite3VdbeLeave(Vdbe*); 452 void sqlite3VdbeLeave(Vdbe*);
394 #else 453 #else
395 # define sqlite3VdbeEnter(X) 454 # define sqlite3VdbeEnter(X)
396 # define sqlite3VdbeLeave(X) 455 # define sqlite3VdbeLeave(X)
397 #endif 456 #endif
398 457
399 #ifdef SQLITE_DEBUG 458 #ifdef SQLITE_DEBUG
400 void sqlite3VdbeMemPrepareToChange(Vdbe*,Mem*); 459 void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*);
460 int sqlite3VdbeCheckMemInvariants(Mem*);
401 #endif 461 #endif
402 462
403 #ifndef SQLITE_OMIT_FOREIGN_KEY 463 #ifndef SQLITE_OMIT_FOREIGN_KEY
404 int sqlite3VdbeCheckFk(Vdbe *, int); 464 int sqlite3VdbeCheckFk(Vdbe *, int);
405 #else 465 #else
406 # define sqlite3VdbeCheckFk(p,i) 0 466 # define sqlite3VdbeCheckFk(p,i) 0
407 #endif 467 #endif
408 468
409 int sqlite3VdbeMemTranslate(Mem*, u8); 469 int sqlite3VdbeMemTranslate(Mem*, u8);
410 #ifdef SQLITE_DEBUG 470 #ifdef SQLITE_DEBUG
411 void sqlite3VdbePrintSql(Vdbe*); 471 void sqlite3VdbePrintSql(Vdbe*);
412 void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf); 472 void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf);
413 #endif 473 #endif
414 int sqlite3VdbeMemHandleBom(Mem *pMem); 474 int sqlite3VdbeMemHandleBom(Mem *pMem);
415 475
416 #ifndef SQLITE_OMIT_INCRBLOB 476 #ifndef SQLITE_OMIT_INCRBLOB
417 int sqlite3VdbeMemExpandBlob(Mem *); 477 int sqlite3VdbeMemExpandBlob(Mem *);
478 #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
418 #else 479 #else
419 #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK 480 #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
481 #define ExpandBlob(P) SQLITE_OK
420 #endif 482 #endif
421 483
422 #endif /* !defined(_VDBEINT_H_) */ 484 #endif /* !defined(_VDBEINT_H_) */
OLDNEW
« no previous file with comments | « third_party/sqlite/sqlite-src-3080704/src/vdbe.c ('k') | third_party/sqlite/sqlite-src-3080704/src/vdbeapi.c » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698