xref: /sqlite-3.40.0/src/vdbeInt.h (revision 0fe7e7d9)
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 hasBeenDuped:1;    /* This cursor was source or target of OP_OpenDup */
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 
138 /*
139 ** A value for VdbeCursor.cacheStatus that means the cache is always invalid.
140 */
141 #define CACHE_STALE 0
142 
143 /*
144 ** When a sub-program is executed (OP_Program), a structure of this type
145 ** is allocated to store the current value of the program counter, as
146 ** well as the current memory cell array and various other frame specific
147 ** values stored in the Vdbe struct. When the sub-program is finished,
148 ** these values are copied back to the Vdbe from the VdbeFrame structure,
149 ** restoring the state of the VM to as it was before the sub-program
150 ** began executing.
151 **
152 ** The memory for a VdbeFrame object is allocated and managed by a memory
153 ** cell in the parent (calling) frame. When the memory cell is deleted or
154 ** overwritten, the VdbeFrame object is not freed immediately. Instead, it
155 ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame
156 ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing
157 ** this instead of deleting the VdbeFrame immediately is to avoid recursive
158 ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the
159 ** child frame are released.
160 **
161 ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is
162 ** set to NULL if the currently executing frame is the main program.
163 */
164 typedef struct VdbeFrame VdbeFrame;
165 struct VdbeFrame {
166   Vdbe *v;                /* VM this frame belongs to */
167   VdbeFrame *pParent;     /* Parent of this frame, or NULL if parent is main */
168   Op *aOp;                /* Program instructions for parent frame */
169   i64 *anExec;            /* Event counters from parent frame */
170   Mem *aMem;              /* Array of memory cells for parent frame */
171   VdbeCursor **apCsr;     /* Array of Vdbe cursors for parent frame */
172   u8 *aOnce;              /* Bitmask used by OP_Once */
173   void *token;            /* Copy of SubProgram.token */
174   i64 lastRowid;          /* Last insert rowid (sqlite3.lastRowid) */
175   AuxData *pAuxData;      /* Linked list of auxdata allocations */
176 #if SQLITE_DEBUG
177   u32 iFrameMagic;        /* magic number for sanity checking */
178 #endif
179   int nCursor;            /* Number of entries in apCsr */
180   int pc;                 /* Program Counter in parent (calling) frame */
181   int nOp;                /* Size of aOp array */
182   int nMem;               /* Number of entries in aMem */
183   int nChildMem;          /* Number of memory cells for child frame */
184   int nChildCsr;          /* Number of cursors for child frame */
185   i64 nChange;            /* Statement changes (Vdbe.nChange)     */
186   i64 nDbChange;          /* Value of db->nChange */
187 };
188 
189 /* Magic number for sanity checking on VdbeFrame objects */
190 #define SQLITE_FRAME_MAGIC 0x879fb71e
191 
192 /*
193 ** Return a pointer to the array of registers allocated for use
194 ** by a VdbeFrame.
195 */
196 #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))])
197 
198 /* Magic number for Mem.uTemp when it is acting as as the cache for the
199 ** IN(...) iterator for sqlite3_vtab_in_next()
200 */
201 #define SQLITE_VTAB_IN_MAGIC 0xd3ab12ec
202 
203 
204 /*
205 ** Internally, the vdbe manipulates nearly all SQL values as Mem
206 ** structures. Each Mem struct may cache multiple representations (string,
207 ** integer etc.) of the same value.
208 */
209 struct sqlite3_value {
210   union MemValue {
211     double r;           /* Real value used when MEM_Real is set in flags */
212     i64 i;              /* Integer value used when MEM_Int is set in flags */
213     int nZero;          /* Extra zero bytes when MEM_Zero and MEM_Blob set */
214     const char *zPType; /* Pointer type when MEM_Term|MEM_Subtype|MEM_Null */
215     FuncDef *pDef;      /* Used only when flags==MEM_Agg */
216     sqlite3_value *pVal;/* Current value for xFilter IN(...) iterator */
217   } u;
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   int n;              /* Number of characters in string value, excluding '\0' */
222   char *z;            /* String or BLOB value */
223   /* ShallowCopy only needs to copy the information above */
224   char *zMalloc;      /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */
225   int szMalloc;       /* Size of the zMalloc allocation */
226   u32 uTemp;          /* Transient storage for serial_type in OP_MakeRecord */
227   sqlite3 *db;        /* The associated database connection */
228   void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */
229 #ifdef SQLITE_DEBUG
230   Mem *pScopyFrom;    /* This Mem is a shallow copy of pScopyFrom */
231   u16 mScopyFlags;    /* flags value immediately after the shallow copy */
232 #endif
233 };
234 
235 /*
236 ** Size of struct Mem not including the Mem.zMalloc member or anything that
237 ** follows.
238 */
239 #define MEMCELLSIZE offsetof(Mem,zMalloc)
240 
241 /* One or more of the following flags are set to indicate the validOK
242 ** representations of the value stored in the Mem struct.
243 **
244 ** If the MEM_Null flag is set, then the value is an SQL NULL value.
245 ** For a pointer type created using sqlite3_bind_pointer() or
246 ** sqlite3_result_pointer() the MEM_Term and MEM_Subtype flags are also set.
247 **
248 ** If the MEM_Str flag is set then Mem.z points at a string representation.
249 ** Usually this is encoded in the same unicode encoding as the main
250 ** database (see below for exceptions). If the MEM_Term flag is also
251 ** set, then the string is nul terminated. The MEM_Int and MEM_Real
252 ** flags may coexist with the MEM_Str flag.
253 */
254 #define MEM_Null      0x0001   /* Value is NULL (or a pointer) */
255 #define MEM_Str       0x0002   /* Value is a string */
256 #define MEM_Int       0x0004   /* Value is an integer */
257 #define MEM_Real      0x0008   /* Value is a real number */
258 #define MEM_Blob      0x0010   /* Value is a BLOB */
259 #define MEM_IntReal   0x0020   /* MEM_Int that stringifies like MEM_Real */
260 #define MEM_AffMask   0x003f   /* Mask of affinity bits */
261 #define MEM_FromBind  0x0040   /* Value originates from sqlite3_bind() */
262 #define MEM_Undefined 0x0080   /* Value is undefined */
263 #define MEM_Cleared   0x0100   /* NULL set by OP_Null, not from data */
264 #define MEM_TypeMask  0xc1bf   /* Mask of type bits */
265 
266 
267 /* Whenever Mem contains a valid string or blob representation, one of
268 ** the following flags must be set to determine the memory management
269 ** policy for Mem.z.  The MEM_Term flag tells us whether or not the
270 ** string is \000 or \u0000 terminated
271 */
272 #define MEM_Term      0x0200   /* String in Mem.z is zero terminated */
273 #define MEM_Dyn       0x0400   /* Need to call Mem.xDel() on Mem.z */
274 #define MEM_Static    0x0800   /* Mem.z points to a static string */
275 #define MEM_Ephem     0x1000   /* Mem.z points to an ephemeral string */
276 #define MEM_Agg       0x2000   /* Mem.z points to an agg function context */
277 #define MEM_Zero      0x4000   /* Mem.i contains count of 0s appended to blob */
278 #define MEM_Subtype   0x8000   /* Mem.eSubtype is valid */
279 #ifdef SQLITE_OMIT_INCRBLOB
280   #undef MEM_Zero
281   #define MEM_Zero 0x0000
282 #endif
283 
284 /* Return TRUE if Mem X contains dynamically allocated content - anything
285 ** that needs to be deallocated to avoid a leak.
286 */
287 #define VdbeMemDynamic(X)  \
288   (((X)->flags&(MEM_Agg|MEM_Dyn))!=0)
289 
290 /*
291 ** Clear any existing type flags from a Mem and replace them with f
292 */
293 #define MemSetTypeFlag(p, f) \
294    ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f)
295 
296 /*
297 ** True if Mem X is a NULL-nochng type.
298 */
299 #define MemNullNochng(X) \
300   (((X)->flags&MEM_TypeMask)==(MEM_Null|MEM_Zero) \
301     && (X)->n==0 && (X)->u.nZero==0)
302 
303 /*
304 ** Return true if a memory cell is not marked as invalid.  This macro
305 ** is for use inside assert() statements only.
306 */
307 #ifdef SQLITE_DEBUG
308 #define memIsValid(M)  ((M)->flags & MEM_Undefined)==0
309 #endif
310 
311 /*
312 ** Each auxiliary data pointer stored by a user defined function
313 ** implementation calling sqlite3_set_auxdata() is stored in an instance
314 ** of this structure. All such structures associated with a single VM
315 ** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed
316 ** when the VM is halted (if not before).
317 */
318 struct AuxData {
319   int iAuxOp;                     /* Instruction number of OP_Function opcode */
320   int iAuxArg;                    /* Index of function argument. */
321   void *pAux;                     /* Aux data pointer */
322   void (*xDeleteAux)(void*);      /* Destructor for the aux data */
323   AuxData *pNextAux;              /* Next element in list */
324 };
325 
326 /*
327 ** The "context" argument for an installable function.  A pointer to an
328 ** instance of this structure is the first argument to the routines used
329 ** implement the SQL functions.
330 **
331 ** There is a typedef for this structure in sqlite.h.  So all routines,
332 ** even the public interface to SQLite, can use a pointer to this structure.
333 ** But this file is the only place where the internal details of this
334 ** structure are known.
335 **
336 ** This structure is defined inside of vdbeInt.h because it uses substructures
337 ** (Mem) which are only defined there.
338 */
339 struct sqlite3_context {
340   Mem *pOut;              /* The return value is stored here */
341   FuncDef *pFunc;         /* Pointer to function information */
342   Mem *pMem;              /* Memory cell used to store aggregate context */
343   Vdbe *pVdbe;            /* The VM that owns this context */
344   int iOp;                /* Instruction number of OP_Function */
345   int isError;            /* Error code returned by the function. */
346   u8 skipFlag;            /* Skip accumulator loading if true */
347   u8 argc;                /* Number of arguments */
348   sqlite3_value *argv[1]; /* Argument set */
349 };
350 
351 /* A bitfield type for use inside of structures.  Always follow with :N where
352 ** N is the number of bits.
353 */
354 typedef unsigned bft;  /* Bit Field Type */
355 
356 /* The ScanStatus object holds a single value for the
357 ** sqlite3_stmt_scanstatus() interface.
358 */
359 typedef struct ScanStatus ScanStatus;
360 struct ScanStatus {
361   int addrExplain;                /* OP_Explain for loop */
362   int addrLoop;                   /* Address of "loops" counter */
363   int addrVisit;                  /* Address of "rows visited" counter */
364   int iSelectID;                  /* The "Select-ID" for this loop */
365   LogEst nEst;                    /* Estimated output rows per loop */
366   char *zName;                    /* Name of table or index */
367 };
368 
369 /* The DblquoteStr object holds the text of a double-quoted
370 ** string for a prepared statement.  A linked list of these objects
371 ** is constructed during statement parsing and is held on Vdbe.pDblStr.
372 ** When computing a normalized SQL statement for an SQL statement, that
373 ** list is consulted for each double-quoted identifier to see if the
374 ** identifier should really be a string literal.
375 */
376 typedef struct DblquoteStr DblquoteStr;
377 struct DblquoteStr {
378   DblquoteStr *pNextStr;   /* Next string literal in the list */
379   char z[8];               /* Dequoted value for the string */
380 };
381 
382 /*
383 ** An instance of the virtual machine.  This structure contains the complete
384 ** state of the virtual machine.
385 **
386 ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare()
387 ** is really a pointer to an instance of this structure.
388 */
389 struct Vdbe {
390   sqlite3 *db;            /* The database connection that owns this statement */
391   Vdbe *pPrev,*pNext;     /* Linked list of VDBEs with the same Vdbe.db */
392   Parse *pParse;          /* Parsing context used to create this Vdbe */
393   ynVar nVar;             /* Number of entries in aVar[] */
394   u32 iVdbeMagic;         /* Magic number defining state of the SQL statement */
395   int nMem;               /* Number of memory locations currently allocated */
396   int nCursor;            /* Number of slots in apCsr[] */
397   u32 cacheCtr;           /* VdbeCursor row cache generation counter */
398   int pc;                 /* The program counter */
399   int rc;                 /* Value to return */
400   i64 nChange;            /* Number of db changes made since last reset */
401   int iStatement;         /* Statement number (or 0 if has no opened stmt) */
402   i64 iCurrentTime;       /* Value of julianday('now') for this statement */
403   i64 nFkConstraint;      /* Number of imm. FK constraints this VM */
404   i64 nStmtDefCons;       /* Number of def. constraints when stmt started */
405   i64 nStmtDefImmCons;    /* Number of def. imm constraints when stmt started */
406   Mem *aMem;              /* The memory locations */
407   Mem **apArg;            /* Arguments to currently executing user function */
408   VdbeCursor **apCsr;     /* One element of this array for each open cursor */
409   Mem *aVar;              /* Values for the OP_Variable opcode. */
410 
411   /* When allocating a new Vdbe object, all of the fields below should be
412   ** initialized to zero or NULL */
413 
414   Op *aOp;                /* Space to hold the virtual machine's program */
415   int nOp;                /* Number of instructions in the program */
416   int nOpAlloc;           /* Slots allocated for aOp[] */
417   Mem *aColName;          /* Column names to return */
418   Mem *pResultSet;        /* Pointer to an array of results */
419   char *zErrMsg;          /* Error message written here */
420   VList *pVList;          /* Name of variables */
421 #ifndef SQLITE_OMIT_TRACE
422   i64 startTime;          /* Time when query started - used for profiling */
423 #endif
424 #ifdef SQLITE_DEBUG
425   int rcApp;              /* errcode set by sqlite3_result_error_code() */
426   u32 nWrite;             /* Number of write operations that have occurred */
427 #endif
428   u16 nResColumn;         /* Number of columns in one row of the result set */
429   u8 errorAction;         /* Recovery action to do in case of an error */
430   u8 minWriteFileFormat;  /* Minimum file format for writable database files */
431   u8 prepFlags;           /* SQLITE_PREPARE_* flags */
432   u8 doingRerun;          /* True if rerunning after an auto-reprepare */
433   bft expired:2;          /* 1: recompile VM immediately  2: when convenient */
434   bft explain:2;          /* True if EXPLAIN present on SQL command */
435   bft changeCntOn:1;      /* True to update the change-counter */
436   bft runOnlyOnce:1;      /* Automatically expire on reset */
437   bft usesStmtJournal:1;  /* True if uses a statement journal */
438   bft readOnly:1;         /* True for statements that do not write */
439   bft bIsReader:1;        /* True for statements that read */
440   yDbMask btreeMask;      /* Bitmask of db->aDb[] entries referenced */
441   yDbMask lockMask;       /* Subset of btreeMask that requires a lock */
442   u32 aCounter[9];        /* Counters used by sqlite3_stmt_status() */
443   char *zSql;             /* Text of the SQL statement that generated this */
444 #ifdef SQLITE_ENABLE_NORMALIZE
445   char *zNormSql;         /* Normalization of the associated SQL statement */
446   DblquoteStr *pDblStr;   /* List of double-quoted string literals */
447 #endif
448   void *pFree;            /* Free this when deleting the vdbe */
449   VdbeFrame *pFrame;      /* Parent frame */
450   VdbeFrame *pDelFrame;   /* List of frame objects to free on VM reset */
451   int nFrame;             /* Number of frames in pFrame list */
452   u32 expmask;            /* Binding to these vars invalidates VM */
453   SubProgram *pProgram;   /* Linked list of all sub-programs used by VM */
454   AuxData *pAuxData;      /* Linked list of auxdata allocations */
455 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
456   i64 *anExec;            /* Number of times each op has been executed */
457   int nScan;              /* Entries in aScan[] */
458   ScanStatus *aScan;      /* Scan definitions for sqlite3_stmt_scanstatus() */
459 #endif
460 };
461 
462 /*
463 ** The following are allowed values for Vdbe.magic
464 */
465 #define VDBE_MAGIC_INIT     0x16bceaa5    /* Building a VDBE program */
466 #define VDBE_MAGIC_RUN      0x2df20da3    /* VDBE is ready to execute */
467 #define VDBE_MAGIC_HALT     0x319c2973    /* VDBE has completed execution */
468 #define VDBE_MAGIC_RESET    0x48fa9f76    /* Reset and ready to run again */
469 #define VDBE_MAGIC_DEAD     0x5606c3c8    /* The VDBE has been deallocated */
470 
471 /*
472 ** Structure used to store the context required by the
473 ** sqlite3_preupdate_*() API functions.
474 */
475 struct PreUpdate {
476   Vdbe *v;
477   VdbeCursor *pCsr;               /* Cursor to read old values from */
478   int op;                         /* One of SQLITE_INSERT, UPDATE, DELETE */
479   u8 *aRecord;                    /* old.* database record */
480   KeyInfo keyinfo;
481   UnpackedRecord *pUnpacked;      /* Unpacked version of aRecord[] */
482   UnpackedRecord *pNewUnpacked;   /* Unpacked version of new.* record */
483   int iNewReg;                    /* Register for new.* values */
484   int iBlobWrite;                 /* Value returned by preupdate_blobwrite() */
485   i64 iKey1;                      /* First key value passed to hook */
486   i64 iKey2;                      /* Second key value passed to hook */
487   Mem *aNew;                      /* Array of new.* values */
488   Table *pTab;                    /* Schema object being upated */
489   Index *pPk;                     /* PK index if pTab is WITHOUT ROWID */
490 };
491 
492 /*
493 ** Function prototypes
494 */
495 void sqlite3VdbeError(Vdbe*, const char *, ...);
496 void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*);
497 void sqliteVdbePopStack(Vdbe*,int);
498 int SQLITE_NOINLINE sqlite3VdbeFinishMoveto(VdbeCursor*);
499 int sqlite3VdbeCursorMoveto(VdbeCursor**, u32*);
500 int sqlite3VdbeCursorRestore(VdbeCursor*);
501 u32 sqlite3VdbeSerialTypeLen(u32);
502 u8 sqlite3VdbeOneByteSerialTypeLen(u8);
503 u32 sqlite3VdbeSerialPut(unsigned char*, Mem*, u32);
504 void sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
505 void sqlite3VdbeDeleteAuxData(sqlite3*, AuxData**, int, int);
506 
507 int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
508 int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*);
509 int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*);
510 int sqlite3VdbeExec(Vdbe*);
511 #if !defined(SQLITE_OMIT_EXPLAIN) || defined(SQLITE_ENABLE_BYTECODE_VTAB)
512 int sqlite3VdbeNextOpcode(Vdbe*,Mem*,int,int*,int*,Op**);
513 char *sqlite3VdbeDisplayP4(sqlite3*,Op*);
514 #endif
515 #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
516 char *sqlite3VdbeDisplayComment(sqlite3*,const Op*,const char*);
517 #endif
518 #if !defined(SQLITE_OMIT_EXPLAIN)
519 int sqlite3VdbeList(Vdbe*);
520 #endif
521 int sqlite3VdbeHalt(Vdbe*);
522 int sqlite3VdbeChangeEncoding(Mem *, int);
523 int sqlite3VdbeMemTooBig(Mem*);
524 int sqlite3VdbeMemCopy(Mem*, const Mem*);
525 void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
526 void sqlite3VdbeMemMove(Mem*, Mem*);
527 int sqlite3VdbeMemNulTerminate(Mem*);
528 int sqlite3VdbeMemSetStr(Mem*, const char*, i64, u8, void(*)(void*));
529 void sqlite3VdbeMemSetInt64(Mem*, i64);
530 #ifdef SQLITE_OMIT_FLOATING_POINT
531 # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64
532 #else
533   void sqlite3VdbeMemSetDouble(Mem*, double);
534 #endif
535 void sqlite3VdbeMemSetPointer(Mem*, void*, const char*, void(*)(void*));
536 void sqlite3VdbeMemInit(Mem*,sqlite3*,u16);
537 void sqlite3VdbeMemSetNull(Mem*);
538 #ifndef SQLITE_OMIT_INCRBLOB
539 void sqlite3VdbeMemSetZeroBlob(Mem*,int);
540 #else
541 int sqlite3VdbeMemSetZeroBlob(Mem*,int);
542 #endif
543 #ifdef SQLITE_DEBUG
544 int sqlite3VdbeMemIsRowSet(const Mem*);
545 #endif
546 int sqlite3VdbeMemSetRowSet(Mem*);
547 int sqlite3VdbeMemMakeWriteable(Mem*);
548 int sqlite3VdbeMemStringify(Mem*, u8, u8);
549 int sqlite3IntFloatCompare(i64,double);
550 i64 sqlite3VdbeIntValue(const Mem*);
551 int sqlite3VdbeMemIntegerify(Mem*);
552 double sqlite3VdbeRealValue(Mem*);
553 int sqlite3VdbeBooleanValue(Mem*, int ifNull);
554 void sqlite3VdbeIntegerAffinity(Mem*);
555 int sqlite3VdbeMemRealify(Mem*);
556 int sqlite3VdbeMemNumerify(Mem*);
557 int sqlite3VdbeMemCast(Mem*,u8,u8);
558 int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,Mem*);
559 int sqlite3VdbeMemFromBtreeZeroOffset(BtCursor*,u32,Mem*);
560 void sqlite3VdbeMemRelease(Mem *p);
561 int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
562 #ifndef SQLITE_OMIT_WINDOWFUNC
563 int sqlite3VdbeMemAggValue(Mem*, Mem*, FuncDef*);
564 #endif
565 #if !defined(SQLITE_OMIT_EXPLAIN) || defined(SQLITE_ENABLE_BYTECODE_VTAB)
566 const char *sqlite3OpcodeName(int);
567 #endif
568 int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
569 int sqlite3VdbeMemClearAndResize(Mem *pMem, int n);
570 int sqlite3VdbeCloseStatement(Vdbe *, int);
571 #ifdef SQLITE_DEBUG
572 int sqlite3VdbeFrameIsValid(VdbeFrame*);
573 #endif
574 void sqlite3VdbeFrameMemDel(void*);      /* Destructor on Mem */
575 void sqlite3VdbeFrameDelete(VdbeFrame*); /* Actually deletes the Frame */
576 int sqlite3VdbeFrameRestore(VdbeFrame *);
577 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
578 void sqlite3VdbePreUpdateHook(
579     Vdbe*,VdbeCursor*,int,const char*,Table*,i64,int,int);
580 #endif
581 int sqlite3VdbeTransferError(Vdbe *p);
582 
583 int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *);
584 void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *);
585 void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *);
586 int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *);
587 int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *);
588 int sqlite3VdbeSorterRewind(const VdbeCursor *, int *);
589 int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *);
590 int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *);
591 
592 #ifdef SQLITE_DEBUG
593   void sqlite3VdbeIncrWriteCounter(Vdbe*, VdbeCursor*);
594   void sqlite3VdbeAssertAbortable(Vdbe*);
595 #else
596 # define sqlite3VdbeIncrWriteCounter(V,C)
597 # define sqlite3VdbeAssertAbortable(V)
598 #endif
599 
600 #if !defined(SQLITE_OMIT_SHARED_CACHE)
601   void sqlite3VdbeEnter(Vdbe*);
602 #else
603 # define sqlite3VdbeEnter(X)
604 #endif
605 
606 #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
607   void sqlite3VdbeLeave(Vdbe*);
608 #else
609 # define sqlite3VdbeLeave(X)
610 #endif
611 
612 #ifdef SQLITE_DEBUG
613 void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*);
614 int sqlite3VdbeCheckMemInvariants(Mem*);
615 #endif
616 
617 #ifndef SQLITE_OMIT_FOREIGN_KEY
618 int sqlite3VdbeCheckFk(Vdbe *, int);
619 #else
620 # define sqlite3VdbeCheckFk(p,i) 0
621 #endif
622 
623 #ifdef SQLITE_DEBUG
624   void sqlite3VdbePrintSql(Vdbe*);
625   void sqlite3VdbeMemPrettyPrint(Mem *pMem, StrAccum *pStr);
626 #endif
627 #ifndef SQLITE_OMIT_UTF16
628   int sqlite3VdbeMemTranslate(Mem*, u8);
629   int sqlite3VdbeMemHandleBom(Mem *pMem);
630 #endif
631 
632 #ifndef SQLITE_OMIT_INCRBLOB
633   int sqlite3VdbeMemExpandBlob(Mem *);
634   #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
635 #else
636   #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
637   #define ExpandBlob(P) SQLITE_OK
638 #endif
639 
640 #endif /* !defined(SQLITE_VDBEINT_H) */
641