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