sl@0: /* sl@0: ** 2001 September 15 sl@0: ** sl@0: ** The author disclaims copyright to this source code. In place of sl@0: ** a legal notice, here is a blessing: sl@0: ** sl@0: ** May you do good and not evil. sl@0: ** May you find forgiveness for yourself and forgive others. sl@0: ** May you share freely, never taking more than you give. sl@0: ** sl@0: ************************************************************************* sl@0: ** Header file for the Virtual DataBase Engine (VDBE) sl@0: ** sl@0: ** This header defines the interface to the virtual database engine sl@0: ** or VDBE. The VDBE implements an abstract machine that runs a sl@0: ** simple program to access and modify the underlying database. sl@0: ** sl@0: ** $Id: vdbe.h,v 1.138 2008/08/20 22:06:48 drh Exp $ sl@0: */ sl@0: #ifndef _SQLITE_VDBE_H_ sl@0: #define _SQLITE_VDBE_H_ sl@0: #include sl@0: sl@0: /* sl@0: ** A single VDBE is an opaque structure named "Vdbe". Only routines sl@0: ** in the source file sqliteVdbe.c are allowed to see the insides sl@0: ** of this structure. sl@0: */ sl@0: typedef struct Vdbe Vdbe; sl@0: sl@0: /* sl@0: ** The names of the following types declared in vdbeInt.h are required sl@0: ** for the VdbeOp definition. sl@0: */ sl@0: typedef struct VdbeFunc VdbeFunc; sl@0: typedef struct Mem Mem; sl@0: sl@0: /* sl@0: ** A single instruction of the virtual machine has an opcode sl@0: ** and as many as three operands. The instruction is recorded sl@0: ** as an instance of the following structure: sl@0: */ sl@0: struct VdbeOp { sl@0: u8 opcode; /* What operation to perform */ sl@0: signed char p4type; /* One of the P4_xxx constants for p4 */ sl@0: u8 opflags; /* Not currently used */ sl@0: u8 p5; /* Fifth parameter is an unsigned character */ sl@0: int p1; /* First operand */ sl@0: int p2; /* Second parameter (often the jump destination) */ sl@0: int p3; /* The third parameter */ sl@0: union { /* forth parameter */ sl@0: int i; /* Integer value if p4type==P4_INT32 */ sl@0: void *p; /* Generic pointer */ sl@0: char *z; /* Pointer to data for string (char array) types */ sl@0: i64 *pI64; /* Used when p4type is P4_INT64 */ sl@0: double *pReal; /* Used when p4type is P4_REAL */ sl@0: FuncDef *pFunc; /* Used when p4type is P4_FUNCDEF */ sl@0: VdbeFunc *pVdbeFunc; /* Used when p4type is P4_VDBEFUNC */ sl@0: CollSeq *pColl; /* Used when p4type is P4_COLLSEQ */ sl@0: Mem *pMem; /* Used when p4type is P4_MEM */ sl@0: sqlite3_vtab *pVtab; /* Used when p4type is P4_VTAB */ sl@0: KeyInfo *pKeyInfo; /* Used when p4type is P4_KEYINFO */ sl@0: int *ai; /* Used when p4type is P4_INTARRAY */ sl@0: } p4; sl@0: #ifdef SQLITE_DEBUG sl@0: char *zComment; /* Comment to improve readability */ sl@0: #endif sl@0: #ifdef VDBE_PROFILE sl@0: int cnt; /* Number of times this instruction was executed */ sl@0: u64 cycles; /* Total time spent executing this instruction */ sl@0: #endif sl@0: }; sl@0: typedef struct VdbeOp VdbeOp; sl@0: sl@0: /* sl@0: ** A smaller version of VdbeOp used for the VdbeAddOpList() function because sl@0: ** it takes up less space. sl@0: */ sl@0: struct VdbeOpList { sl@0: u8 opcode; /* What operation to perform */ sl@0: signed char p1; /* First operand */ sl@0: signed char p2; /* Second parameter (often the jump destination) */ sl@0: signed char p3; /* Third parameter */ sl@0: }; sl@0: typedef struct VdbeOpList VdbeOpList; sl@0: sl@0: /* sl@0: ** Allowed values of VdbeOp.p3type sl@0: */ sl@0: #define P4_NOTUSED 0 /* The P4 parameter is not used */ sl@0: #define P4_DYNAMIC (-1) /* Pointer to a string obtained from sqliteMalloc() */ sl@0: #define P4_STATIC (-2) /* Pointer to a static string */ sl@0: #define P4_COLLSEQ (-4) /* P4 is a pointer to a CollSeq structure */ sl@0: #define P4_FUNCDEF (-5) /* P4 is a pointer to a FuncDef structure */ sl@0: #define P4_KEYINFO (-6) /* P4 is a pointer to a KeyInfo structure */ sl@0: #define P4_VDBEFUNC (-7) /* P4 is a pointer to a VdbeFunc structure */ sl@0: #define P4_MEM (-8) /* P4 is a pointer to a Mem* structure */ sl@0: #define P4_TRANSIENT (-9) /* P4 is a pointer to a transient string */ sl@0: #define P4_VTAB (-10) /* P4 is a pointer to an sqlite3_vtab structure */ sl@0: #define P4_MPRINTF (-11) /* P4 is a string obtained from sqlite3_mprintf() */ sl@0: #define P4_REAL (-12) /* P4 is a 64-bit floating point value */ sl@0: #define P4_INT64 (-13) /* P4 is a 64-bit signed integer */ sl@0: #define P4_INT32 (-14) /* P4 is a 32-bit signed integer */ sl@0: #define P4_INTARRAY (-15) /* P4 is a vector of 32-bit integers */ sl@0: sl@0: /* When adding a P4 argument using P4_KEYINFO, a copy of the KeyInfo structure sl@0: ** is made. That copy is freed when the Vdbe is finalized. But if the sl@0: ** argument is P4_KEYINFO_HANDOFF, the passed in pointer is used. It still sl@0: ** gets freed when the Vdbe is finalized so it still should be obtained sl@0: ** from a single sqliteMalloc(). But no copy is made and the calling sl@0: ** function should *not* try to free the KeyInfo. sl@0: */ sl@0: #define P4_KEYINFO_HANDOFF (-16) sl@0: #define P4_KEYINFO_STATIC (-17) sl@0: sl@0: /* sl@0: ** The Vdbe.aColName array contains 5n Mem structures, where n is the sl@0: ** number of columns of data returned by the statement. sl@0: */ sl@0: #define COLNAME_NAME 0 sl@0: #define COLNAME_DECLTYPE 1 sl@0: #define COLNAME_DATABASE 2 sl@0: #define COLNAME_TABLE 3 sl@0: #define COLNAME_COLUMN 4 sl@0: #ifdef SQLITE_ENABLE_COLUMN_METADATA sl@0: # define COLNAME_N 5 /* Number of COLNAME_xxx symbols */ sl@0: #else sl@0: # ifdef SQLITE_OMIT_DECLTYPE sl@0: # define COLNAME_N 1 /* Store only the name */ sl@0: # else sl@0: # define COLNAME_N 2 /* Store the name and decltype */ sl@0: # endif sl@0: #endif sl@0: sl@0: /* sl@0: ** The following macro converts a relative address in the p2 field sl@0: ** of a VdbeOp structure into a negative number so that sl@0: ** sqlite3VdbeAddOpList() knows that the address is relative. Calling sl@0: ** the macro again restores the address. sl@0: */ sl@0: #define ADDR(X) (-1-(X)) sl@0: sl@0: /* sl@0: ** The makefile scans the vdbe.c source file and creates the "opcodes.h" sl@0: ** header file that defines a number for each opcode used by the VDBE. sl@0: */ sl@0: #include "opcodes.h" sl@0: sl@0: /* sl@0: ** Prototypes for the VDBE interface. See comments on the implementation sl@0: ** for a description of what each of these routines does. sl@0: */ sl@0: Vdbe *sqlite3VdbeCreate(sqlite3*); sl@0: int sqlite3VdbeAddOp0(Vdbe*,int); sl@0: int sqlite3VdbeAddOp1(Vdbe*,int,int); sl@0: int sqlite3VdbeAddOp2(Vdbe*,int,int,int); sl@0: int sqlite3VdbeAddOp3(Vdbe*,int,int,int,int); sl@0: int sqlite3VdbeAddOp4(Vdbe*,int,int,int,int,const char *zP4,int); sl@0: int sqlite3VdbeAddOpList(Vdbe*, int nOp, VdbeOpList const *aOp); sl@0: void sqlite3VdbeChangeP1(Vdbe*, int addr, int P1); sl@0: void sqlite3VdbeChangeP2(Vdbe*, int addr, int P2); sl@0: void sqlite3VdbeChangeP3(Vdbe*, int addr, int P3); sl@0: void sqlite3VdbeChangeP5(Vdbe*, u8 P5); sl@0: void sqlite3VdbeJumpHere(Vdbe*, int addr); sl@0: void sqlite3VdbeChangeToNoop(Vdbe*, int addr, int N); sl@0: void sqlite3VdbeChangeP4(Vdbe*, int addr, const char *zP4, int N); sl@0: void sqlite3VdbeUsesBtree(Vdbe*, int); sl@0: VdbeOp *sqlite3VdbeGetOp(Vdbe*, int); sl@0: int sqlite3VdbeMakeLabel(Vdbe*); sl@0: void sqlite3VdbeDelete(Vdbe*); sl@0: void sqlite3VdbeMakeReady(Vdbe*,int,int,int,int); sl@0: int sqlite3VdbeFinalize(Vdbe*); sl@0: void sqlite3VdbeResolveLabel(Vdbe*, int); sl@0: int sqlite3VdbeCurrentAddr(Vdbe*); sl@0: #ifdef SQLITE_DEBUG sl@0: void sqlite3VdbeTrace(Vdbe*,FILE*); sl@0: #endif sl@0: void sqlite3VdbeResetStepResult(Vdbe*); sl@0: int sqlite3VdbeReset(Vdbe*); sl@0: void sqlite3VdbeSetNumCols(Vdbe*,int); sl@0: int sqlite3VdbeSetColName(Vdbe*, int, int, const char *, int); sl@0: void sqlite3VdbeCountChanges(Vdbe*); sl@0: sqlite3 *sqlite3VdbeDb(Vdbe*); sl@0: void sqlite3VdbeSetSql(Vdbe*, const char *z, int n); sl@0: void sqlite3VdbeSwap(Vdbe*,Vdbe*); sl@0: sl@0: #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT sl@0: int sqlite3VdbeReleaseMemory(int); sl@0: #endif sl@0: UnpackedRecord *sqlite3VdbeRecordUnpack(KeyInfo*,int,const void*, sl@0: UnpackedRecord*,int); sl@0: void sqlite3VdbeDeleteUnpackedRecord(UnpackedRecord*); sl@0: int sqlite3VdbeRecordCompare(int,const void*,UnpackedRecord*); sl@0: sl@0: sl@0: #ifndef NDEBUG sl@0: void sqlite3VdbeComment(Vdbe*, const char*, ...); sl@0: # define VdbeComment(X) sqlite3VdbeComment X sl@0: void sqlite3VdbeNoopComment(Vdbe*, const char*, ...); sl@0: # define VdbeNoopComment(X) sqlite3VdbeNoopComment X sl@0: #else sl@0: # define VdbeComment(X) sl@0: # define VdbeNoopComment(X) sl@0: #endif sl@0: sl@0: #endif