blob: b53952fd44bbaca9a23e8ee3bd0e2166d0bdbd26 [file] [log] [blame]
drh9a324642003-09-06 20:12:01 +00001/*
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*/
drh4e78be62007-01-26 21:08:04 +000018#ifndef _VDBEINT_H_
19#define _VDBEINT_H_
drh9a324642003-09-06 20:12:01 +000020
21/*
drh60625312013-04-06 18:06:51 +000022** 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/*
drhf7e36902015-08-13 21:32:41 +000030** 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# define VDBE_DISPLAY_P4 1
36#else
37# define VDBE_DISPLAY_P4 0
38#endif
39
40/*
drh9a324642003-09-06 20:12:01 +000041** SQL is translated into a sequence of instructions to be
42** executed by a virtual machine. Each instruction is an instance
43** of the following structure.
44*/
45typedef struct VdbeOp Op;
46
47/*
48** Boolean values
49*/
drh14da87f2013-11-20 21:51:33 +000050typedef unsigned Bool;
drh9a324642003-09-06 20:12:01 +000051
dana20fde62011-07-12 14:28:05 +000052/* Opaque type used by code in vdbesort.c */
53typedef struct VdbeSorter VdbeSorter;
54
drh7e02e5e2011-12-06 19:44:51 +000055/* Opaque type used by the explainer */
56typedef struct Explain Explain;
57
dan0c547792013-07-18 17:12:08 +000058/* Elements of the linked list at Vdbe.pAuxData */
59typedef struct AuxData AuxData;
60
drhc960dcb2015-11-20 19:22:01 +000061/* Types of VDBE cursors */
62#define CURTYPE_BTREE 0
63#define CURTYPE_SORTER 1
64#define CURTYPE_VTAB 2
65#define CURTYPE_PSEUDO 3
66
drh9a324642003-09-06 20:12:01 +000067/*
drhc960dcb2015-11-20 19:22:01 +000068** A VdbeCursor is an superclass (a wrapper) for various cursor objects:
drh5cc10232013-11-21 01:04:02 +000069**
drhc960dcb2015-11-20 19:22:01 +000070** * A b-tree cursor
71** - In the main database or in an ephemeral database
72** - On either an index or a table
73** * A sorter
74** * A virtual table
75** * A one-row "pseudotable" stored in a single register
drh9a324642003-09-06 20:12:01 +000076*/
dande892d92016-01-29 19:29:45 +000077typedef struct VdbeCursor VdbeCursor;
drhdfe88ec2008-11-03 20:55:06 +000078struct VdbeCursor {
drhc960dcb2015-11-20 19:22:01 +000079 u8 eCurType; /* One of the CURTYPE_* values above */
drh79353db2013-11-20 02:53:58 +000080 i8 iDb; /* Index of cursor database in db->aDb[] (or -1) */
drh1fd522f2013-11-21 00:10:35 +000081 u8 nullRow; /* True if pointing to a row with no data */
drh1fd522f2013-11-21 00:10:35 +000082 u8 deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */
drhc960dcb2015-11-20 19:22:01 +000083 u8 isTable; /* True for rowid tables. False for indexes */
84#ifdef SQLITE_DEBUG
85 u8 seekOp; /* Most recent seek operation on this cursor */
drhb89aeb62016-01-27 15:49:32 +000086 u8 wrFlag; /* The wrFlag argument to sqlite3BtreeCursor() */
drhc960dcb2015-11-20 19:22:01 +000087#endif
drh079a3072014-03-19 14:10:55 +000088 Bool isEphemeral:1; /* True for an ephemeral table */
drh14da87f2013-11-20 21:51:33 +000089 Bool useRandomRowid:1;/* Generate new record numbers semi-randomly */
drh26bcc7c2016-02-26 04:13:39 +000090 Bool isOrdered:1; /* True if the table is not BTREE_UNORDERED */
drh35263192014-07-22 20:02:19 +000091 Pgno pgnoRoot; /* Root page of the open btree cursor */
drhc960dcb2015-11-20 19:22:01 +000092 i16 nField; /* Number of fields in the header */
93 u16 nHdrParsed; /* Number of header fields parsed so far */
94 union {
95 BtCursor *pCursor; /* CURTYPE_BTREE. Btree cursor */
96 sqlite3_vtab_cursor *pVCur; /* CURTYPE_VTAB. Vtab cursor */
97 int pseudoTableReg; /* CURTYPE_PSEUDO. Reg holding content. */
98 VdbeSorter *pSorter; /* CURTYPE_SORTER. Sorter object */
99 } uc;
100 Btree *pBt; /* Separate file holding temporary table */
101 KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */
102 int seekResult; /* Result of previous sqlite3BtreeMoveto() */
drh2e5de2f2011-01-07 02:50:40 +0000103 i64 seqCount; /* Sequence counter */
104 i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */
drh945d3022016-01-29 20:58:40 +0000105 VdbeCursor *pAltCursor; /* Associated index cursor from which to read */
106 int *aAltMap; /* Mapping from table to index column numbers */
drh97bae792015-06-05 15:59:57 +0000107#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
108 u64 maskUsed; /* Mask of columns used by this cursor */
109#endif
drh9188b382004-05-14 21:12:22 +0000110
111 /* Cached information about the header for the data record that the
drh3e9ca092009-09-08 01:14:48 +0000112 ** cursor is currently pointing to. Only valid if cacheStatus matches
113 ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of
114 ** CACHE_STALE and so setting cacheStatus=CACHE_STALE guarantees that
115 ** the cache is out of date.
116 **
drh76873ab2006-01-07 18:48:26 +0000117 ** aRow might point to (ephemeral) data for the current row, or it might
118 ** be NULL.
119 */
drh3e9ca092009-09-08 01:14:48 +0000120 u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */
drh399af1d2013-11-20 17:25:55 +0000121 u32 payloadSize; /* Total number of bytes in the record */
drh399af1d2013-11-20 17:25:55 +0000122 u32 szRow; /* Byte available in aRow */
123 u32 iHdrOffset; /* Offset to next unparsed byte of the header */
drh399af1d2013-11-20 17:25:55 +0000124 const u8 *aRow; /* Data for the current row, if all on one page */
drhb53a5a92014-10-12 22:37:22 +0000125 u32 *aOffset; /* Pointer to aType[nField] */
drh5cc10232013-11-21 01:04:02 +0000126 u32 aType[1]; /* Type values for all entries in the record */
127 /* 2*nField extra array elements allocated for aType[], beyond the one
128 ** static element declared in the structure. nField total array slots for
129 ** aType[] and nField+1 array slots for aOffset[] */
drh9a324642003-09-06 20:12:01 +0000130};
drh9a324642003-09-06 20:12:01 +0000131
dan65a7cd12009-09-01 12:16:01 +0000132/*
133** When a sub-program is executed (OP_Program), a structure of this type
134** is allocated to store the current value of the program counter, as
135** well as the current memory cell array and various other frame specific
136** values stored in the Vdbe struct. When the sub-program is finished,
137** these values are copied back to the Vdbe from the VdbeFrame structure,
138** restoring the state of the VM to as it was before the sub-program
139** began executing.
140**
dan27106572010-12-01 08:04:47 +0000141** The memory for a VdbeFrame object is allocated and managed by a memory
142** cell in the parent (calling) frame. When the memory cell is deleted or
143** overwritten, the VdbeFrame object is not freed immediately. Instead, it
144** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame
145** list is deleted when the VM is reset in VdbeHalt(). The reason for doing
146** this instead of deleting the VdbeFrame immediately is to avoid recursive
147** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the
148** child frame are released.
149**
150** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is
151** set to NULL if the currently executing frame is the main program.
dan65a7cd12009-09-01 12:16:01 +0000152*/
dan165921a2009-08-28 18:53:45 +0000153typedef struct VdbeFrame VdbeFrame;
154struct VdbeFrame {
155 Vdbe *v; /* VM this frame belongs to */
drh3fb757b2012-02-02 21:02:43 +0000156 VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */
dan27106572010-12-01 08:04:47 +0000157 Op *aOp; /* Program instructions for parent frame */
dan43764a82014-11-01 21:00:04 +0000158 i64 *anExec; /* Event counters from parent frame */
dan27106572010-12-01 08:04:47 +0000159 Mem *aMem; /* Array of memory cells for parent frame */
dan1d8cb212011-12-09 13:24:16 +0000160 u8 *aOnceFlag; /* Array of OP_Once flags for parent frame */
dan27106572010-12-01 08:04:47 +0000161 VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */
dan165921a2009-08-28 18:53:45 +0000162 void *token; /* Copy of SubProgram.token */
drh3fb757b2012-02-02 21:02:43 +0000163 i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
dan32001322016-02-19 18:54:29 +0000164 AuxData *pAuxData; /* Linked list of auxdata allocations */
drh928d9c62013-02-07 09:33:56 +0000165 int nCursor; /* Number of entries in apCsr */
drh3fb757b2012-02-02 21:02:43 +0000166 int pc; /* Program Counter in parent (calling) frame */
167 int nOp; /* Size of aOp array */
168 int nMem; /* Number of entries in aMem */
169 int nOnceFlag; /* Number of entries in aOnceFlag */
dan165921a2009-08-28 18:53:45 +0000170 int nChildMem; /* Number of memory cells for child frame */
171 int nChildCsr; /* Number of cursors for child frame */
danc3da6672014-10-28 18:24:16 +0000172 int nChange; /* Statement changes (Vdbe.nChange) */
173 int nDbChange; /* Value of db->nChange */
dan165921a2009-08-28 18:53:45 +0000174};
175
176#define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))])
177
drh9a324642003-09-06 20:12:01 +0000178/*
drhdfe88ec2008-11-03 20:55:06 +0000179** A value for VdbeCursor.cacheValid that means the cache is always invalid.
drh76873ab2006-01-07 18:48:26 +0000180*/
181#define CACHE_STALE 0
182
183/*
danielk19777e18c252004-05-25 11:47:24 +0000184** Internally, the vdbe manipulates nearly all SQL values as Mem
185** structures. Each Mem struct may cache multiple representations (string,
drh2e5de2f2011-01-07 02:50:40 +0000186** integer etc.) of the same value.
drh9a324642003-09-06 20:12:01 +0000187*/
188struct Mem {
drh74eaba42014-09-18 17:52:15 +0000189 union MemValue {
mistachkin26c79a02014-09-18 18:55:47 +0000190 double r; /* Real value used when MEM_Real is set in flags */
drh2e5de2f2011-01-07 02:50:40 +0000191 i64 i; /* Integer value used when MEM_Int is set in flags */
drh8df32842008-12-09 02:51:23 +0000192 int nZero; /* Used when bit MEM_Zero is set in flags */
drh3c024d62007-03-30 11:23:45 +0000193 FuncDef *pDef; /* Used only when flags==MEM_Agg */
drh3d4501e2008-12-04 20:40:10 +0000194 RowSet *pRowSet; /* Used only when flags==MEM_RowSet */
dan165921a2009-08-28 18:53:45 +0000195 VdbeFrame *pFrame; /* Used when flags==MEM_Frame */
drh3c024d62007-03-30 11:23:45 +0000196 } u;
drh69174eb2004-05-26 23:43:11 +0000197 u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
drhfdf972a2007-05-02 13:30:27 +0000198 u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */
drhbcdf78a2015-09-10 20:34:56 +0000199 u8 eSubtype; /* Subtype for this value */
drh035e5632014-09-16 14:16:31 +0000200 int n; /* Number of characters in string value, excluding '\0' */
drh035e5632014-09-16 14:16:31 +0000201 char *z; /* String or BLOB value */
drh035e5632014-09-16 14:16:31 +0000202 /* ShallowCopy only needs to copy the information above */
drh17bcb102014-09-18 21:25:33 +0000203 char *zMalloc; /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */
204 int szMalloc; /* Size of the zMalloc allocation */
drhfacf47a2014-10-13 20:12:47 +0000205 u32 uTemp; /* Transient storage for serial_type in OP_MakeRecord */
drh035e5632014-09-16 14:16:31 +0000206 sqlite3 *db; /* The associated database connection */
drhd3b74202014-09-17 16:41:15 +0000207 void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */
drh2b4ded92010-09-27 21:09:31 +0000208#ifdef SQLITE_DEBUG
209 Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */
210 void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */
211#endif
drh9a324642003-09-06 20:12:01 +0000212};
drh9a324642003-09-06 20:12:01 +0000213
drh4f03f412015-05-20 21:28:32 +0000214/*
215** Size of struct Mem not including the Mem.zMalloc member or anything that
216** follows.
217*/
218#define MEMCELLSIZE offsetof(Mem,zMalloc)
219
drh69174eb2004-05-26 23:43:11 +0000220/* One or more of the following flags are set to indicate the validOK
danielk1977b77f5da2004-05-26 13:27:00 +0000221** representations of the value stored in the Mem struct.
drh3dc0b8e2004-05-10 12:07:10 +0000222**
danielk1977b77f5da2004-05-26 13:27:00 +0000223** If the MEM_Null flag is set, then the value is an SQL NULL value.
224** No other flags may be set in this case.
drh3dc0b8e2004-05-10 12:07:10 +0000225**
danielk1977b77f5da2004-05-26 13:27:00 +0000226** If the MEM_Str flag is set then Mem.z points at a string representation.
227** Usually this is encoded in the same unicode encoding as the main
228** database (see below for exceptions). If the MEM_Term flag is also
229** set, then the string is nul terminated. The MEM_Int and MEM_Real
230** flags may coexist with the MEM_Str flag.
drh9a324642003-09-06 20:12:01 +0000231*/
drh00706be2004-01-30 14:49:16 +0000232#define MEM_Null 0x0001 /* Value is NULL */
233#define MEM_Str 0x0002 /* Value is a string */
234#define MEM_Int 0x0004 /* Value is an integer */
235#define MEM_Real 0x0008 /* Value is a real number */
drh3dc0b8e2004-05-10 12:07:10 +0000236#define MEM_Blob 0x0010 /* Value is a BLOB */
mistachkinafc14f72014-03-05 01:29:18 +0000237#define MEM_AffMask 0x001f /* Mask of affinity bits */
drh3d4501e2008-12-04 20:40:10 +0000238#define MEM_RowSet 0x0020 /* Value is a RowSet object */
dan165921a2009-08-28 18:53:45 +0000239#define MEM_Frame 0x0040 /* Value is a VdbeFrame object */
drha5750cf2014-02-07 13:20:31 +0000240#define MEM_Undefined 0x0080 /* Value is undefined */
drh053a1282012-09-19 21:15:46 +0000241#define MEM_Cleared 0x0100 /* NULL set by OP_Null, not from data */
dan5b6c8e42016-01-30 15:46:03 +0000242#define MEM_TypeMask 0x81ff /* Mask of type bits */
drh053a1282012-09-19 21:15:46 +0000243
danielk1977a7a8e142008-02-13 18:25:27 +0000244
danielk1977b77f5da2004-05-26 13:27:00 +0000245/* Whenever Mem contains a valid string or blob representation, one of
246** the following flags must be set to determine the memory management
drh69174eb2004-05-26 23:43:11 +0000247** policy for Mem.z. The MEM_Term flag tells us whether or not the
248** string is \000 or \u0000 terminated
danielk1977b77f5da2004-05-26 13:27:00 +0000249*/
drh3d4501e2008-12-04 20:40:10 +0000250#define MEM_Term 0x0200 /* String rep is nul terminated */
drhc91b2fd2014-03-01 18:13:23 +0000251#define MEM_Dyn 0x0400 /* Need to call Mem.xDel() on Mem.z */
drh3d4501e2008-12-04 20:40:10 +0000252#define MEM_Static 0x0800 /* Mem.z points to a static string */
253#define MEM_Ephem 0x1000 /* Mem.z points to an ephemeral string */
254#define MEM_Agg 0x2000 /* Mem.z points to an agg function context */
255#define MEM_Zero 0x4000 /* Mem.i contains count of 0s appended to blob */
dan5b6c8e42016-01-30 15:46:03 +0000256#define MEM_Subtype 0x8000 /* Mem.eSubtype is valid */
danielk1977246ad312007-05-16 14:23:00 +0000257#ifdef SQLITE_OMIT_INCRBLOB
258 #undef MEM_Zero
259 #define MEM_Zero 0x0000
260#endif
261
dan5b6c8e42016-01-30 15:46:03 +0000262/* Return TRUE if Mem X contains dynamically allocated content - anything
263** that needs to be deallocated to avoid a leak.
264*/
265#define VdbeMemDynamic(X) \
266 (((X)->flags&(MEM_Agg|MEM_Dyn|MEM_RowSet|MEM_Frame))!=0)
267
drh3d4501e2008-12-04 20:40:10 +0000268/*
269** Clear any existing type flags from a Mem and replace them with f
270*/
drh68ac65e2009-01-05 18:02:27 +0000271#define MemSetTypeFlag(p, f) \
272 ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f)
drh3d4501e2008-12-04 20:40:10 +0000273
drh2b4ded92010-09-27 21:09:31 +0000274/*
275** Return true if a memory cell is not marked as invalid. This macro
276** is for use inside assert() statements only.
277*/
278#ifdef SQLITE_DEBUG
drha5750cf2014-02-07 13:20:31 +0000279#define memIsValid(M) ((M)->flags & MEM_Undefined)==0
drh2b4ded92010-09-27 21:09:31 +0000280#endif
281
dan0c547792013-07-18 17:12:08 +0000282/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000283** Each auxiliary data pointer stored by a user defined function
dan0c547792013-07-18 17:12:08 +0000284** implementation calling sqlite3_set_auxdata() is stored in an instance
285** of this structure. All such structures associated with a single VM
286** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed
287** when the VM is halted (if not before).
drh998da3a2004-06-19 15:22:56 +0000288*/
dan0c547792013-07-18 17:12:08 +0000289struct AuxData {
290 int iOp; /* Instruction number of OP_Function opcode */
291 int iArg; /* Index of function argument. */
292 void *pAux; /* Aux data pointer */
293 void (*xDelete)(void *); /* Destructor for the aux data */
294 AuxData *pNext; /* Next element in list */
danielk1977682f68b2004-06-05 10:22:17 +0000295};
danielk1977682f68b2004-06-05 10:22:17 +0000296
drh9a324642003-09-06 20:12:01 +0000297/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000298** The "context" argument for an installable function. A pointer to an
drh9a324642003-09-06 20:12:01 +0000299** instance of this structure is the first argument to the routines used
300** implement the SQL functions.
301**
302** There is a typedef for this structure in sqlite.h. So all routines,
303** even the public interface to SQLite, can use a pointer to this structure.
304** But this file is the only place where the internal details of this
305** structure are known.
306**
drhabfcea22005-09-06 20:36:48 +0000307** This structure is defined inside of vdbeInt.h because it uses substructures
drh00706be2004-01-30 14:49:16 +0000308** (Mem) which are only defined there.
drh9a324642003-09-06 20:12:01 +0000309*/
danielk19770ae8b832004-05-25 12:05:56 +0000310struct sqlite3_context {
drh9c7c9132015-06-26 18:16:52 +0000311 Mem *pOut; /* The return value is stored here */
312 FuncDef *pFunc; /* Pointer to function information */
313 Mem *pMem; /* Memory cell used to store aggregate context */
314 Vdbe *pVdbe; /* The VM that owns this context */
315 int iOp; /* Instruction number of OP_Function */
316 int isError; /* Error code returned by the function. */
317 u8 skipFlag; /* Skip accumulator loading if true */
318 u8 fErrorOrAux; /* isError!=0 or pVdbe->pAuxData modified */
319 u8 argc; /* Number of arguments */
320 sqlite3_value *argv[1]; /* Argument set */
drh9a324642003-09-06 20:12:01 +0000321};
322
323/*
drh7e02e5e2011-12-06 19:44:51 +0000324** An Explain object accumulates indented output which is helpful
325** in describing recursive data structures.
326*/
327struct Explain {
328 Vdbe *pVdbe; /* Attach the explanation to this Vdbe */
329 StrAccum str; /* The string being accumulated */
330 int nIndent; /* Number of elements in aIndent */
331 u16 aIndent[100]; /* Levels of indentation */
332 char zBase[100]; /* Initial space */
333};
334
drh37f58e92012-09-04 21:34:26 +0000335/* A bitfield type for use inside of structures. Always follow with :N where
336** N is the number of bits.
337*/
338typedef unsigned bft; /* Bit Field Type */
339
dan037b5322014-11-03 11:25:32 +0000340typedef struct ScanStatus ScanStatus;
341struct ScanStatus {
dan6f9702e2014-11-01 20:38:06 +0000342 int addrExplain; /* OP_Explain for loop */
343 int addrLoop; /* Address of "loops" counter */
344 int addrVisit; /* Address of "rows visited" counter */
drhc6652b12014-11-06 04:42:20 +0000345 int iSelectID; /* The "Select-ID" for this loop */
drh518140e2014-11-06 03:55:10 +0000346 LogEst nEst; /* Estimated output rows per loop */
dan6f9702e2014-11-01 20:38:06 +0000347 char *zName; /* Name of table or index */
348};
349
drh7e02e5e2011-12-06 19:44:51 +0000350/*
drh9a324642003-09-06 20:12:01 +0000351** An instance of the virtual machine. This structure contains the complete
352** state of the virtual machine.
353**
drh2e5de2f2011-01-07 02:50:40 +0000354** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare()
drh9a324642003-09-06 20:12:01 +0000355** is really a pointer to an instance of this structure.
356*/
357struct Vdbe {
drh8bfdf722009-06-19 14:06:03 +0000358 sqlite3 *db; /* The database connection that owns this statement */
drh8bfdf722009-06-19 14:06:03 +0000359 Op *aOp; /* Space to hold the virtual machine's program */
drh2e5de2f2011-01-07 02:50:40 +0000360 Mem *aMem; /* The memory locations */
drh8bfdf722009-06-19 14:06:03 +0000361 Mem **apArg; /* Arguments to currently executing user function */
362 Mem *aColName; /* Column names to return */
363 Mem *pResultSet; /* Pointer to an array of results */
drh9ac79622013-12-18 15:11:47 +0000364 Parse *pParse; /* Parsing context used to create this Vdbe */
drh2e5de2f2011-01-07 02:50:40 +0000365 int nMem; /* Number of memory locations currently allocated */
366 int nOp; /* Number of instructions in the program */
drh928d9c62013-02-07 09:33:56 +0000367 int nCursor; /* Number of slots in apCsr[] */
drh2e5de2f2011-01-07 02:50:40 +0000368 u32 magic; /* Magic number for sanity checking */
369 char *zErrMsg; /* Error message written here */
370 Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
drh8bfdf722009-06-19 14:06:03 +0000371 VdbeCursor **apCsr; /* One element of this array for each open cursor */
drh8bfdf722009-06-19 14:06:03 +0000372 Mem *aVar; /* Values for the OP_Variable opcode. */
373 char **azVar; /* Name of variables */
drh2e5de2f2011-01-07 02:50:40 +0000374 ynVar nVar; /* Number of entries in aVar[] */
drh124c0b42011-06-01 18:15:55 +0000375 ynVar nzVar; /* Number of entries in azVar[] */
drh3e9ca092009-09-08 01:14:48 +0000376 u32 cacheCtr; /* VdbeCursor row cache generation counter */
drh9a324642003-09-06 20:12:01 +0000377 int pc; /* The program counter */
378 int rc; /* Value to return */
drh983b5ee2015-02-13 12:05:56 +0000379#ifdef SQLITE_DEBUG
380 int rcApp; /* errcode set by sqlite3_result_error_code() */
381#endif
drh73d5b8f2013-12-23 19:09:07 +0000382 u16 nResColumn; /* Number of columns in one row of the result set */
drh2e5de2f2011-01-07 02:50:40 +0000383 u8 errorAction; /* Recovery action to do in case of an error */
drhd946db02005-12-29 19:23:06 +0000384 u8 minWriteFileFormat; /* Minimum file format for writable database files */
drh37f58e92012-09-04 21:34:26 +0000385 bft explain:2; /* True if EXPLAIN present on SQL command */
drh37f58e92012-09-04 21:34:26 +0000386 bft changeCntOn:1; /* True to update the change-counter */
387 bft expired:1; /* True if the VM needs to be recompiled */
388 bft runOnlyOnce:1; /* Automatically expire on reset */
389 bft usesStmtJournal:1; /* True if uses a statement journal */
drh9e92a472013-06-27 17:40:30 +0000390 bft readOnly:1; /* True for statements that do not write */
drh1713afb2013-06-28 01:24:57 +0000391 bft bIsReader:1; /* True for statements that read */
drh37f58e92012-09-04 21:34:26 +0000392 bft isPrepareV2:1; /* True if prepared with prepare_v2() */
393 bft doingRerun:1; /* True if rerunning after an auto-reprepare */
drh91b48aa2004-06-30 11:14:18 +0000394 int nChange; /* Number of db changes made since last reset */
drh64123582011-04-02 20:01:02 +0000395 yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */
drhdc5b0472011-04-06 22:05:53 +0000396 yDbMask lockMask; /* Subset of btreeMask that requires a lock */
drh2e5de2f2011-01-07 02:50:40 +0000397 int iStatement; /* Statement number (or 0 if has not opened stmt) */
drh9b47ee32013-08-20 03:13:51 +0000398 u32 aCounter[5]; /* Counters used by sqlite3_stmt_status() */
drh2e5de2f2011-01-07 02:50:40 +0000399#ifndef SQLITE_OMIT_TRACE
400 i64 startTime; /* Time when query started - used for profiling */
401#endif
drh95a7b3e2013-09-16 12:57:19 +0000402 i64 iCurrentTime; /* Value of julianday('now') for this statement */
dan32b09f22009-09-23 17:29:59 +0000403 i64 nFkConstraint; /* Number of imm. FK constraints this VM */
dan1da40a32009-09-19 17:00:31 +0000404 i64 nStmtDefCons; /* Number of def. constraints when stmt started */
drh648e2642013-07-11 15:03:32 +0000405 i64 nStmtDefImmCons; /* Number of def. imm constraints when stmt started */
drh2e5de2f2011-01-07 02:50:40 +0000406 char *zSql; /* Text of the SQL statement that generated this */
407 void *pFree; /* Free this when deleting the vdbe */
dan165921a2009-08-28 18:53:45 +0000408 VdbeFrame *pFrame; /* Parent frame */
dan27106572010-12-01 08:04:47 +0000409 VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */
dan165921a2009-08-28 18:53:45 +0000410 int nFrame; /* Number of frames in pFrame list */
dan937d0de2009-10-15 18:35:38 +0000411 u32 expmask; /* Binding to these vars invalidates VM */
dand19c9332010-07-26 12:05:17 +0000412 SubProgram *pProgram; /* Linked list of all sub-programs used by VM */
dan1d8cb212011-12-09 13:24:16 +0000413 int nOnceFlag; /* Size of array aOnceFlag[] */
414 u8 *aOnceFlag; /* Flags for OP_Once */
dan0c547792013-07-18 17:12:08 +0000415 AuxData *pAuxData; /* Linked list of auxdata allocations */
dan6f9702e2014-11-01 20:38:06 +0000416#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
417 i64 *anExec; /* Number of times each op has been executed */
418 int nScan; /* Entries in aScan[] */
dan037b5322014-11-03 11:25:32 +0000419 ScanStatus *aScan; /* Scan definitions for sqlite3_stmt_scanstatus() */
dan6f9702e2014-11-01 20:38:06 +0000420#endif
drh9a324642003-09-06 20:12:01 +0000421};
422
423/*
424** The following are allowed values for Vdbe.magic
425*/
426#define VDBE_MAGIC_INIT 0x26bceaa5 /* Building a VDBE program */
427#define VDBE_MAGIC_RUN 0xbdf20da3 /* VDBE is ready to execute */
428#define VDBE_MAGIC_HALT 0x519c2973 /* VDBE has completed execution */
429#define VDBE_MAGIC_DEAD 0xb606c3c8 /* The VDBE has been deallocated */
430
431/*
drh9a324642003-09-06 20:12:01 +0000432** Function prototypes
433*/
drh22c17b82015-05-15 04:13:15 +0000434void sqlite3VdbeError(Vdbe*, const char *, ...);
drhdfe88ec2008-11-03 20:55:06 +0000435void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*);
drh9a324642003-09-06 20:12:01 +0000436void sqliteVdbePopStack(Vdbe*,int);
dande892d92016-01-29 19:29:45 +0000437int sqlite3VdbeCursorMoveto(VdbeCursor**, int*);
drhc22284f2014-10-13 16:02:20 +0000438int sqlite3VdbeCursorRestore(VdbeCursor*);
danielk19778b60e0f2005-01-12 09:10:39 +0000439#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
danielk19774adee202004-05-08 08:23:19 +0000440void sqlite3VdbePrintOp(FILE*, int, Op*);
drh9a324642003-09-06 20:12:01 +0000441#endif
drh35cd6432009-06-05 14:17:21 +0000442u32 sqlite3VdbeSerialTypeLen(u32);
drhfaf37272015-10-16 14:23:42 +0000443u8 sqlite3VdbeOneByteSerialTypeLen(u8);
drhbe37c122015-10-16 14:54:17 +0000444u32 sqlite3VdbeSerialType(Mem*, int, u32*);
drha9ab4812013-12-11 11:00:44 +0000445u32 sqlite3VdbeSerialPut(unsigned char*, Mem*, u32);
drh35cd6432009-06-05 14:17:21 +0000446u32 sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
drhb9626cf2016-02-22 16:04:31 +0000447void sqlite3VdbeDeleteAuxData(sqlite3*, AuxData**, int, int);
danielk19774adee202004-05-08 08:23:19 +0000448
danielk1977189621d2004-05-09 23:23:56 +0000449int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
drhd3b74202014-09-17 16:41:15 +0000450int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*);
451int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*);
danielk1977106bb232004-05-21 10:08:53 +0000452int sqlite3VdbeExec(Vdbe*);
453int sqlite3VdbeList(Vdbe*);
drh92f02c32004-09-02 14:57:08 +0000454int sqlite3VdbeHalt(Vdbe*);
drhb21c8cd2007-08-21 19:33:56 +0000455int sqlite3VdbeChangeEncoding(Mem *, int);
drh023ae032007-05-08 12:12:16 +0000456int sqlite3VdbeMemTooBig(Mem*);
drhb21c8cd2007-08-21 19:33:56 +0000457int sqlite3VdbeMemCopy(Mem*, const Mem*);
drhfebe1062004-08-28 18:17:48 +0000458void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
drh643167f2008-01-22 21:30:53 +0000459void sqlite3VdbeMemMove(Mem*, Mem*);
drhb21c8cd2007-08-21 19:33:56 +0000460int sqlite3VdbeMemNulTerminate(Mem*);
461int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
drhefad9992004-06-22 12:13:55 +0000462void sqlite3VdbeMemSetInt64(Mem*, i64);
drh7ec5ea92010-01-13 00:04:13 +0000463#ifdef SQLITE_OMIT_FLOATING_POINT
464# define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64
465#else
466 void sqlite3VdbeMemSetDouble(Mem*, double);
467#endif
drhd3b74202014-09-17 16:41:15 +0000468void sqlite3VdbeMemInit(Mem*,sqlite3*,u16);
drhf4479502004-05-27 03:12:53 +0000469void sqlite3VdbeMemSetNull(Mem*);
drhb026e052007-05-02 01:34:31 +0000470void sqlite3VdbeMemSetZeroBlob(Mem*,int);
drh3d4501e2008-12-04 20:40:10 +0000471void sqlite3VdbeMemSetRowSet(Mem*);
drhb21c8cd2007-08-21 19:33:56 +0000472int sqlite3VdbeMemMakeWriteable(Mem*);
drhbd9507c2014-08-23 17:21:37 +0000473int sqlite3VdbeMemStringify(Mem*, u8, u8);
drh6a6124e2004-06-27 01:56:33 +0000474i64 sqlite3VdbeIntValue(Mem*);
drheb2e1762004-05-27 01:53:56 +0000475int sqlite3VdbeMemIntegerify(Mem*);
drh6a6124e2004-06-27 01:56:33 +0000476double sqlite3VdbeRealValue(Mem*);
drh8df447f2005-11-01 15:48:24 +0000477void sqlite3VdbeIntegerAffinity(Mem*);
drheb2e1762004-05-27 01:53:56 +0000478int sqlite3VdbeMemRealify(Mem*);
drh8a512562005-11-14 22:29:05 +0000479int sqlite3VdbeMemNumerify(Mem*);
drh4169e432014-08-25 20:11:52 +0000480void sqlite3VdbeMemCast(Mem*,u8,u8);
drh501932c2013-11-21 21:59:53 +0000481int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,int,Mem*);
danielk1977d8123362004-06-12 09:25:12 +0000482void sqlite3VdbeMemRelease(Mem *p);
drh90669c12006-01-20 15:45:36 +0000483int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
drh46c99e02007-08-27 23:26:59 +0000484const char *sqlite3OpcodeName(int);
danielk1977a7a8e142008-02-13 18:25:27 +0000485int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
drh322f2852014-09-19 00:43:39 +0000486int sqlite3VdbeMemClearAndResize(Mem *pMem, int n);
danielk1977bd434552009-03-18 10:33:00 +0000487int sqlite3VdbeCloseStatement(Vdbe *, int);
dan165921a2009-08-28 18:53:45 +0000488void sqlite3VdbeFrameDelete(VdbeFrame*);
489int sqlite3VdbeFrameRestore(VdbeFrame *);
dan029ead62011-10-27 15:19:58 +0000490int sqlite3VdbeTransferError(Vdbe *p);
drhe54e0512011-04-05 17:31:56 +0000491
danfad9f9a2014-04-01 18:41:51 +0000492int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *);
drh65ea12c2014-03-19 17:41:36 +0000493void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *);
dana20fde62011-07-12 14:28:05 +0000494void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *);
drhc041c162012-07-24 19:46:38 +0000495int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *);
496int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *, int *);
drh958d2612014-04-18 13:40:07 +0000497int sqlite3VdbeSorterRewind(const VdbeCursor *, int *);
498int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *);
drh1153c7b2013-11-01 22:02:56 +0000499int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *);
dan7fe62702011-08-02 10:56:22 +0000500
dan20d876f2016-01-07 16:06:22 +0000501#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhe54e0512011-04-05 17:31:56 +0000502 void sqlite3VdbeEnter(Vdbe*);
drhe54e0512011-04-05 17:31:56 +0000503#else
504# define sqlite3VdbeEnter(X)
dan20d876f2016-01-07 16:06:22 +0000505#endif
506
507#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
508 void sqlite3VdbeLeave(Vdbe*);
509#else
drhe54e0512011-04-05 17:31:56 +0000510# define sqlite3VdbeLeave(X)
511#endif
drh46c99e02007-08-27 23:26:59 +0000512
drh2b4ded92010-09-27 21:09:31 +0000513#ifdef SQLITE_DEBUG
drhe4c88c02012-01-04 12:57:45 +0000514void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*);
drh75fd0542014-03-01 16:24:44 +0000515int sqlite3VdbeCheckMemInvariants(Mem*);
drh2b4ded92010-09-27 21:09:31 +0000516#endif
517
dan1da40a32009-09-19 17:00:31 +0000518#ifndef SQLITE_OMIT_FOREIGN_KEY
dan8a2fff72009-09-23 18:07:22 +0000519int sqlite3VdbeCheckFk(Vdbe *, int);
dan1da40a32009-09-19 17:00:31 +0000520#else
dan8a2fff72009-09-23 18:07:22 +0000521# define sqlite3VdbeCheckFk(p,i) 0
dan1da40a32009-09-19 17:00:31 +0000522#endif
523
drhb21c8cd2007-08-21 19:33:56 +0000524int sqlite3VdbeMemTranslate(Mem*, u8);
drh87cc3b32007-05-08 21:45:27 +0000525#ifdef SQLITE_DEBUG
526 void sqlite3VdbePrintSql(Vdbe*);
527 void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf);
528#endif
drhb21c8cd2007-08-21 19:33:56 +0000529int sqlite3VdbeMemHandleBom(Mem *pMem);
drh4e78be62007-01-26 21:08:04 +0000530
danielk1977246ad312007-05-16 14:23:00 +0000531#ifndef SQLITE_OMIT_INCRBLOB
drhb21c8cd2007-08-21 19:33:56 +0000532 int sqlite3VdbeMemExpandBlob(Mem *);
drh45d29302012-01-08 22:18:33 +0000533 #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
danielk1977246ad312007-05-16 14:23:00 +0000534#else
drhb21c8cd2007-08-21 19:33:56 +0000535 #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
drh45d29302012-01-08 22:18:33 +0000536 #define ExpandBlob(P) SQLITE_OK
danielk1977246ad312007-05-16 14:23:00 +0000537#endif
538
drh4e78be62007-01-26 21:08:04 +0000539#endif /* !defined(_VDBEINT_H_) */