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