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