vdbeInt.h
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:19k
源码类别:

数据库系统

开发平台:

C/C++

  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 _VDBEINT_H_
  19. #define _VDBEINT_H_
  20. /*
  21. ** intToKey() and keyToInt() used to transform the rowid.  But with
  22. ** the latest versions of the design they are no-ops.
  23. */
  24. #define keyToInt(X)   (X)
  25. #define intToKey(X)   (X)
  26. /*
  27. ** SQL is translated into a sequence of instructions to be
  28. ** executed by a virtual machine.  Each instruction is an instance
  29. ** of the following structure.
  30. */
  31. typedef struct VdbeOp Op;
  32. /*
  33. ** Boolean values
  34. */
  35. typedef unsigned char Bool;
  36. /*
  37. ** A cursor is a pointer into a single BTree within a database file.
  38. ** The cursor can seek to a BTree entry with a particular key, or
  39. ** loop over all entries of the Btree.  You can also insert new BTree
  40. ** entries or retrieve the key or data from the entry that the cursor
  41. ** is currently pointing to.
  42. ** 
  43. ** Every cursor that the virtual machine has open is represented by an
  44. ** instance of the following structure.
  45. **
  46. ** If the Cursor.isTriggerRow flag is set it means that this cursor is
  47. ** really a single row that represents the NEW or OLD pseudo-table of
  48. ** a row trigger.  The data for the row is stored in Cursor.pData and
  49. ** the rowid is in Cursor.iKey.
  50. */
  51. struct Cursor {
  52.   BtCursor *pCursor;    /* The cursor structure of the backend */
  53.   int iDb;              /* Index of cursor database in db->aDb[] (or -1) */
  54.   i64 lastRowid;        /* Last rowid from a Next or NextIdx operation */
  55.   i64 nextRowid;        /* Next rowid returned by OP_NewRowid */
  56.   Bool zeroed;          /* True if zeroed out and ready for reuse */
  57.   Bool rowidIsValid;    /* True if lastRowid is valid */
  58.   Bool atFirst;         /* True if pointing to first entry */
  59.   Bool useRandomRowid;  /* Generate new record numbers semi-randomly */
  60.   Bool nullRow;         /* True if pointing to a row with no data */
  61.   Bool nextRowidValid;  /* True if the nextRowid field is valid */
  62.   Bool pseudoTable;     /* This is a NEW or OLD pseudo-tables of a trigger */
  63.   Bool ephemPseudoTable;
  64.   Bool deferredMoveto;  /* A call to sqlite3BtreeMoveto() is needed */
  65.   Bool isTable;         /* True if a table requiring integer keys */
  66.   Bool isIndex;         /* True if an index containing keys only - no data */
  67.   u8 bogusIncrKey;      /* Something for pIncrKey to point to if pKeyInfo==0 */
  68.   i64 movetoTarget;     /* Argument to the deferred sqlite3BtreeMoveto() */
  69.   Btree *pBt;           /* Separate file holding temporary table */
  70.   int nData;            /* Number of bytes in pData */
  71.   char *pData;          /* Data for a NEW or OLD pseudo-table */
  72.   i64 iKey;             /* Key for the NEW or OLD pseudo-table row */
  73.   u8 *pIncrKey;         /* Pointer to pKeyInfo->incrKey */
  74.   KeyInfo *pKeyInfo;    /* Info about index keys needed by index cursors */
  75.   int nField;           /* Number of fields in the header */
  76.   i64 seqCount;         /* Sequence counter */
  77.   sqlite3_vtab_cursor *pVtabCursor;  /* The cursor for a virtual table */
  78.   const sqlite3_module *pModule;     /* Module for cursor pVtabCursor */
  79.   /* Cached information about the header for the data record that the
  80.   ** cursor is currently pointing to.  Only valid if cacheValid is true.
  81.   ** aRow might point to (ephemeral) data for the current row, or it might
  82.   ** be NULL.
  83.   */
  84.   int cacheStatus;      /* Cache is valid if this matches Vdbe.cacheCtr */
  85.   int payloadSize;      /* Total number of bytes in the record */
  86.   u32 *aType;           /* Type values for all entries in the record */
  87.   u32 *aOffset;         /* Cached offsets to the start of each columns data */
  88.   u8 *aRow;             /* Data for the current row, if all on one page */
  89. };
  90. typedef struct Cursor Cursor;
  91. /*
  92. ** A value for Cursor.cacheValid that means the cache is always invalid.
  93. */
  94. #define CACHE_STALE 0
  95. /*
  96. ** Internally, the vdbe manipulates nearly all SQL values as Mem
  97. ** structures. Each Mem struct may cache multiple representations (string,
  98. ** integer etc.) of the same value.  A value (and therefore Mem structure)
  99. ** has the following properties:
  100. **
  101. ** Each value has a manifest type. The manifest type of the value stored
  102. ** in a Mem struct is returned by the MemType(Mem*) macro. The type is
  103. ** one of SQLITE_NULL, SQLITE_INTEGER, SQLITE_REAL, SQLITE_TEXT or
  104. ** SQLITE_BLOB.
  105. */
  106. struct Mem {
  107.   union {
  108.     i64 i;              /* Integer value. Or FuncDef* when flags==MEM_Agg */
  109.     FuncDef *pDef;      /* Used only when flags==MEM_Agg */
  110.   } u;
  111.   double r;           /* Real value */
  112.   sqlite3 *db;        /* The associated database connection */
  113.   char *z;            /* String or BLOB value */
  114.   int n;              /* Number of characters in string value, excluding '' */
  115.   u16 flags;          /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
  116.   u8  type;           /* One of SQLITE_NULL, SQLITE_TEXT, SQLITE_INTEGER, etc */
  117.   u8  enc;            /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */
  118.   void (*xDel)(void *);  /* If not null, call this function to delete Mem.z */
  119.   char *zMalloc;      /* Dynamic buffer allocated by sqlite3_malloc() */
  120. };
  121. /* One or more of the following flags are set to indicate the validOK
  122. ** representations of the value stored in the Mem struct.
  123. **
  124. ** If the MEM_Null flag is set, then the value is an SQL NULL value.
  125. ** No other flags may be set in this case.
  126. **
  127. ** If the MEM_Str flag is set then Mem.z points at a string representation.
  128. ** Usually this is encoded in the same unicode encoding as the main
  129. ** database (see below for exceptions). If the MEM_Term flag is also
  130. ** set, then the string is nul terminated. The MEM_Int and MEM_Real 
  131. ** flags may coexist with the MEM_Str flag.
  132. **
  133. ** Multiple of these values can appear in Mem.flags.  But only one
  134. ** at a time can appear in Mem.type.
  135. */
  136. #define MEM_Null      0x0001   /* Value is NULL */
  137. #define MEM_Str       0x0002   /* Value is a string */
  138. #define MEM_Int       0x0004   /* Value is an integer */
  139. #define MEM_Real      0x0008   /* Value is a real number */
  140. #define MEM_Blob      0x0010   /* Value is a BLOB */
  141. #define MemSetTypeFlag(p, f) 
  142.   ((p)->flags = ((p)->flags&~(MEM_Int|MEM_Real|MEM_Null|MEM_Blob|MEM_Str))|f)
  143. /* Whenever Mem contains a valid string or blob representation, one of
  144. ** the following flags must be set to determine the memory management
  145. ** policy for Mem.z.  The MEM_Term flag tells us whether or not the
  146. ** string is 00 or u0000 terminated
  147. */
  148. #define MEM_Term      0x0020   /* String rep is nul terminated */
  149. #define MEM_Dyn       0x0040   /* Need to call sqliteFree() on Mem.z */
  150. #define MEM_Static    0x0080   /* Mem.z points to a static string */
  151. #define MEM_Ephem     0x0100   /* Mem.z points to an ephemeral string */
  152. #define MEM_Agg       0x0400   /* Mem.z points to an agg function context */
  153. #define MEM_Zero      0x0800   /* Mem.i contains count of 0s appended to blob */
  154. #ifdef SQLITE_OMIT_INCRBLOB
  155.   #undef MEM_Zero
  156.   #define MEM_Zero 0x0000
  157. #endif
  158. /* A VdbeFunc is just a FuncDef (defined in sqliteInt.h) that contains
  159. ** additional information about auxiliary information bound to arguments
  160. ** of the function.  This is used to implement the sqlite3_get_auxdata()
  161. ** and sqlite3_set_auxdata() APIs.  The "auxdata" is some auxiliary data
  162. ** that can be associated with a constant argument to a function.  This
  163. ** allows functions such as "regexp" to compile their constant regular
  164. ** expression argument once and reused the compiled code for multiple
  165. ** invocations.
  166. */
  167. struct VdbeFunc {
  168.   FuncDef *pFunc;               /* The definition of the function */
  169.   int nAux;                     /* Number of entries allocated for apAux[] */
  170.   struct AuxData {
  171.     void *pAux;                   /* Aux data for the i-th argument */
  172.     void (*xDelete)(void *);      /* Destructor for the aux data */
  173.   } apAux[1];                   /* One slot for each function argument */
  174. };
  175. /*
  176. ** The "context" argument for a installable function.  A pointer to an
  177. ** instance of this structure is the first argument to the routines used
  178. ** implement the SQL functions.
  179. **
  180. ** There is a typedef for this structure in sqlite.h.  So all routines,
  181. ** even the public interface to SQLite, can use a pointer to this structure.
  182. ** But this file is the only place where the internal details of this
  183. ** structure are known.
  184. **
  185. ** This structure is defined inside of vdbeInt.h because it uses substructures
  186. ** (Mem) which are only defined there.
  187. */
  188. struct sqlite3_context {
  189.   FuncDef *pFunc;       /* Pointer to function information.  MUST BE FIRST */
  190.   VdbeFunc *pVdbeFunc;  /* Auxilary data, if created. */
  191.   Mem s;                /* The return value is stored here */
  192.   Mem *pMem;            /* Memory cell used to store aggregate context */
  193.   int isError;          /* Error code returned by the function. */
  194.   CollSeq *pColl;       /* Collating sequence */
  195. };
  196. /*
  197. ** A Set structure is used for quick testing to see if a value
  198. ** is part of a small set.  Sets are used to implement code like
  199. ** this:
  200. **            x.y IN ('hi','hoo','hum')
  201. */
  202. typedef struct Set Set;
  203. struct Set {
  204.   Hash hash;             /* A set is just a hash table */
  205.   HashElem *prev;        /* Previously accessed hash elemen */
  206. };
  207. /*
  208. ** A FifoPage structure holds a single page of valves.  Pages are arranged
  209. ** in a list.
  210. */
  211. typedef struct FifoPage FifoPage;
  212. struct FifoPage {
  213.   int nSlot;         /* Number of entries aSlot[] */
  214.   int iWrite;        /* Push the next value into this entry in aSlot[] */
  215.   int iRead;         /* Read the next value from this entry in aSlot[] */
  216.   FifoPage *pNext;   /* Next page in the fifo */
  217.   i64 aSlot[1];      /* One or more slots for rowid values */
  218. };
  219. /*
  220. ** The Fifo structure is typedef-ed in vdbeInt.h.  But the implementation
  221. ** of that structure is private to this file.
  222. **
  223. ** The Fifo structure describes the entire fifo.  
  224. */
  225. typedef struct Fifo Fifo;
  226. struct Fifo {
  227.   int nEntry;         /* Total number of entries */
  228.   FifoPage *pFirst;   /* First page on the list */
  229.   FifoPage *pLast;    /* Last page on the list */
  230. };
  231. /*
  232. ** A Context stores the last insert rowid, the last statement change count,
  233. ** and the current statement change count (i.e. changes since last statement).
  234. ** The current keylist is also stored in the context.
  235. ** Elements of Context structure type make up the ContextStack, which is
  236. ** updated by the ContextPush and ContextPop opcodes (used by triggers).
  237. ** The context is pushed before executing a trigger a popped when the
  238. ** trigger finishes.
  239. */
  240. typedef struct Context Context;
  241. struct Context {
  242.   i64 lastRowid;    /* Last insert rowid (sqlite3.lastRowid) */
  243.   int nChange;      /* Statement changes (Vdbe.nChanges)     */
  244.   Fifo sFifo;       /* Records that will participate in a DELETE or UPDATE */
  245. };
  246. /*
  247. ** An instance of the virtual machine.  This structure contains the complete
  248. ** state of the virtual machine.
  249. **
  250. ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_compile()
  251. ** is really a pointer to an instance of this structure.
  252. **
  253. ** The Vdbe.inVtabMethod variable is set to non-zero for the duration of
  254. ** any virtual table method invocations made by the vdbe program. It is
  255. ** set to 2 for xDestroy method calls and 1 for all other methods. This
  256. ** variable is used for two purposes: to allow xDestroy methods to execute
  257. ** "DROP TABLE" statements and to prevent some nasty side effects of
  258. ** malloc failure when SQLite is invoked recursively by a virtual table 
  259. ** method function.
  260. */
  261. struct Vdbe {
  262.   sqlite3 *db;        /* The whole database */
  263.   Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
  264.   int nOp;            /* Number of instructions in the program */
  265.   int nOpAlloc;       /* Number of slots allocated for aOp[] */
  266.   Op *aOp;            /* Space to hold the virtual machine's program */
  267.   int nLabel;         /* Number of labels used */
  268.   int nLabelAlloc;    /* Number of slots allocated in aLabel[] */
  269.   int *aLabel;        /* Space to hold the labels */
  270.   Mem **apArg;        /* Arguments to currently executing user function */
  271.   Mem *aColName;      /* Column names to return */
  272.   int nCursor;        /* Number of slots in apCsr[] */
  273.   Cursor **apCsr;     /* One element of this array for each open cursor */
  274.   int nVar;           /* Number of entries in aVar[] */
  275.   Mem *aVar;          /* Values for the OP_Variable opcode. */
  276.   char **azVar;       /* Name of variables */
  277.   int okVar;          /* True if azVar[] has been initialized */
  278.   int magic;              /* Magic number for sanity checking */
  279.   int nMem;               /* Number of memory locations currently allocated */
  280.   Mem *aMem;              /* The memory locations */
  281.   int nCallback;          /* Number of callbacks invoked so far */
  282.   int cacheCtr;           /* Cursor row cache generation counter */
  283.   Fifo sFifo;             /* A list of ROWIDs */
  284.   int contextStackTop;    /* Index of top element in the context stack */
  285.   int contextStackDepth;  /* The size of the "context" stack */
  286.   Context *contextStack;  /* Stack used by opcodes ContextPush & ContextPop*/
  287.   int pc;                 /* The program counter */
  288.   int rc;                 /* Value to return */
  289.   unsigned uniqueCnt;     /* Used by OP_MakeRecord when P2!=0 */
  290.   int errorAction;        /* Recovery action to do in case of an error */
  291.   int inTempTrans;        /* True if temp database is transactioned */
  292.   int returnStack[25];    /* Return address stack for OP_Gosub & OP_Return */
  293.   int returnDepth;        /* Next unused element in returnStack[] */
  294.   int nResColumn;         /* Number of columns in one row of the result set */
  295.   char **azResColumn;     /* Values for one row of result */ 
  296.   char *zErrMsg;          /* Error message written here */
  297.   Mem *pResultSet;        /* Pointer to an array of results */
  298.   u8 explain;             /* True if EXPLAIN present on SQL command */
  299.   u8 changeCntOn;         /* True to update the change-counter */
  300.   u8 aborted;             /* True if ROLLBACK in another VM causes an abort */
  301.   u8 expired;             /* True if the VM needs to be recompiled */
  302.   u8 minWriteFileFormat;  /* Minimum file format for writable database files */
  303.   u8 inVtabMethod;        /* See comments above */
  304.   int nChange;            /* Number of db changes made since last reset */
  305.   i64 startTime;          /* Time when query started - used for profiling */
  306.   int btreeMask;          /* Bitmask of db->aDb[] entries referenced */
  307.   BtreeMutexArray aMutex; /* An array of Btree used here and needing locks */
  308.   int nSql;             /* Number of bytes in zSql */
  309.   char *zSql;           /* Text of the SQL statement that generated this */
  310. #ifdef SQLITE_DEBUG
  311.   FILE *trace;        /* Write an execution trace here, if not NULL */
  312. #endif
  313.   int openedStatement;  /* True if this VM has opened a statement journal */
  314. #ifdef SQLITE_SSE
  315.   int fetchId;          /* Statement number used by sqlite3_fetch_statement */
  316.   int lru;              /* Counter used for LRU cache replacement */
  317. #endif
  318. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  319.   Vdbe *pLruPrev;
  320.   Vdbe *pLruNext;
  321. #endif
  322. };
  323. /*
  324. ** An instance of the following structure holds information about a
  325. ** single index record that has already been parsed out into individual
  326. ** values.
  327. **
  328. ** A record is an object that contains one or more fields of data.
  329. ** Records are used to store the content of a table row and to store
  330. ** the key of an index.  A blob encoding of a record is created by
  331. ** the OP_MakeRecord opcode of the VDBE and is disassemblied by the
  332. ** OP_Column opcode.
  333. **
  334. ** This structure holds a record that has already been disassembled
  335. ** into its constitutent fields.
  336. */
  337. struct UnpackedRecord {
  338.   KeyInfo *pKeyInfo;  /* Collation and sort-order information */
  339.   u16 nField;         /* Number of entries in apMem[] */
  340.   u8 needFree;        /* True if memory obtained from sqlite3_malloc() */
  341.   u8 needDestroy;     /* True if apMem[]s should be destroyed on close */
  342.   Mem *aMem;          /* Values */
  343. };
  344. /*
  345. ** The following are allowed values for Vdbe.magic
  346. */
  347. #define VDBE_MAGIC_INIT     0x26bceaa5    /* Building a VDBE program */
  348. #define VDBE_MAGIC_RUN      0xbdf20da3    /* VDBE is ready to execute */
  349. #define VDBE_MAGIC_HALT     0x519c2973    /* VDBE has completed execution */
  350. #define VDBE_MAGIC_DEAD     0xb606c3c8    /* The VDBE has been deallocated */
  351. /*
  352. ** Function prototypes
  353. */
  354. void sqlite3VdbeFreeCursor(Vdbe *, Cursor*);
  355. void sqliteVdbePopStack(Vdbe*,int);
  356. int sqlite3VdbeCursorMoveto(Cursor*);
  357. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  358. void sqlite3VdbePrintOp(FILE*, int, Op*);
  359. #endif
  360. int sqlite3VdbeSerialTypeLen(u32);
  361. u32 sqlite3VdbeSerialType(Mem*, int);
  362. int sqlite3VdbeSerialPut(unsigned char*, int, Mem*, int);
  363. int sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
  364. void sqlite3VdbeDeleteAuxData(VdbeFunc*, int);
  365. int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
  366. int sqlite3VdbeIdxKeyCompare(Cursor*,int,const unsigned char*,int*);
  367. int sqlite3VdbeIdxRowid(BtCursor *, i64 *);
  368. int sqlite3MemCompare(const Mem*, const Mem*, const CollSeq*);
  369. int sqlite3VdbeIdxRowidLen(const u8*);
  370. int sqlite3VdbeExec(Vdbe*);
  371. int sqlite3VdbeList(Vdbe*);
  372. int sqlite3VdbeHalt(Vdbe*);
  373. int sqlite3VdbeChangeEncoding(Mem *, int);
  374. int sqlite3VdbeMemTooBig(Mem*);
  375. int sqlite3VdbeMemCopy(Mem*, const Mem*);
  376. void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
  377. void sqlite3VdbeMemMove(Mem*, Mem*);
  378. int sqlite3VdbeMemNulTerminate(Mem*);
  379. int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
  380. void sqlite3VdbeMemSetInt64(Mem*, i64);
  381. void sqlite3VdbeMemSetDouble(Mem*, double);
  382. void sqlite3VdbeMemSetNull(Mem*);
  383. void sqlite3VdbeMemSetZeroBlob(Mem*,int);
  384. int sqlite3VdbeMemMakeWriteable(Mem*);
  385. int sqlite3VdbeMemDynamicify(Mem*);
  386. int sqlite3VdbeMemStringify(Mem*, int);
  387. i64 sqlite3VdbeIntValue(Mem*);
  388. int sqlite3VdbeMemIntegerify(Mem*);
  389. double sqlite3VdbeRealValue(Mem*);
  390. void sqlite3VdbeIntegerAffinity(Mem*);
  391. int sqlite3VdbeMemRealify(Mem*);
  392. int sqlite3VdbeMemNumerify(Mem*);
  393. int sqlite3VdbeMemFromBtree(BtCursor*,int,int,int,Mem*);
  394. void sqlite3VdbeMemRelease(Mem *p);
  395. void sqlite3VdbeMemReleaseExternal(Mem *p);
  396. int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
  397. const char *sqlite3OpcodeName(int);
  398. int sqlite3VdbeOpcodeHasProperty(int, int);
  399. int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
  400. int sqlite3VdbeReleaseBuffers(Vdbe *p);
  401. #ifndef NDEBUG
  402.   void sqlite3VdbeMemSanity(Mem*);
  403. #endif
  404. int sqlite3VdbeMemTranslate(Mem*, u8);
  405. #ifdef SQLITE_DEBUG
  406.   void sqlite3VdbePrintSql(Vdbe*);
  407.   void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf);
  408. #endif
  409. int sqlite3VdbeMemHandleBom(Mem *pMem);
  410. void sqlite3VdbeFifoInit(Fifo*);
  411. int sqlite3VdbeFifoPush(Fifo*, i64);
  412. int sqlite3VdbeFifoPop(Fifo*, i64*);
  413. void sqlite3VdbeFifoClear(Fifo*);
  414. #ifndef SQLITE_OMIT_INCRBLOB
  415.   int sqlite3VdbeMemExpandBlob(Mem *);
  416. #else
  417.   #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
  418. #endif
  419. #endif /* !defined(_VDBEINT_H_) */