src/vdbeInt.h

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