vdbeaux.c.svn-base
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:71k
源码类别:

数据库系统

开发平台:

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 file contains code used for creating, destroying, and populating
  13. ** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)  Prior
  14. ** to version 2.8.7, all this code was combined into the vdbe.c source file.
  15. ** But that file was getting too big so this subroutines were split out.
  16. */
  17. #include "sqliteInt.h"
  18. #include <ctype.h>
  19. #include "vdbeInt.h"
  20. /*
  21. ** When debugging the code generator in a symbolic debugger, one can
  22. ** set the sqlite3VdbeAddopTrace to 1 and all opcodes will be printed
  23. ** as they are added to the instruction stream.
  24. */
  25. #ifdef SQLITE_DEBUG
  26. int sqlite3VdbeAddopTrace = 0;
  27. #endif
  28. /*
  29. ** Create a new virtual database engine.
  30. */
  31. Vdbe *sqlite3VdbeCreate(sqlite3 *db){
  32.   Vdbe *p;
  33.   p = sqlite3DbMallocZero(db, sizeof(Vdbe) );
  34.   if( p==0 ) return 0;
  35.   p->db = db;
  36.   if( db->pVdbe ){
  37.     db->pVdbe->pPrev = p;
  38.   }
  39.   p->pNext = db->pVdbe;
  40.   p->pPrev = 0;
  41.   db->pVdbe = p;
  42.   p->magic = VDBE_MAGIC_INIT;
  43.   return p;
  44. }
  45. /*
  46. ** Remember the SQL string for a prepared statement.
  47. */
  48. void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n){
  49.   if( p==0 ) return;
  50.   assert( p->zSql==0 );
  51.   p->zSql = sqlite3DbStrNDup(p->db, z, n);
  52. }
  53. /*
  54. ** Return the SQL associated with a prepared statement
  55. */
  56. const char *sqlite3_sql(sqlite3_stmt *pStmt){
  57.   return ((Vdbe *)pStmt)->zSql;
  58. }
  59. /*
  60. ** Swap all content between two VDBE structures.
  61. */
  62. void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
  63.   Vdbe tmp, *pTmp;
  64.   char *zTmp;
  65.   int nTmp;
  66.   tmp = *pA;
  67.   *pA = *pB;
  68.   *pB = tmp;
  69.   pTmp = pA->pNext;
  70.   pA->pNext = pB->pNext;
  71.   pB->pNext = pTmp;
  72.   pTmp = pA->pPrev;
  73.   pA->pPrev = pB->pPrev;
  74.   pB->pPrev = pTmp;
  75.   zTmp = pA->zSql;
  76.   pA->zSql = pB->zSql;
  77.   pB->zSql = zTmp;
  78.   nTmp = pA->nSql;
  79.   pA->nSql = pB->nSql;
  80.   pB->nSql = nTmp;
  81. }
  82. #ifdef SQLITE_DEBUG
  83. /*
  84. ** Turn tracing on or off
  85. */
  86. void sqlite3VdbeTrace(Vdbe *p, FILE *trace){
  87.   p->trace = trace;
  88. }
  89. #endif
  90. /*
  91. ** Resize the Vdbe.aOp array so that it contains at least N
  92. ** elements.
  93. **
  94. ** If an out-of-memory error occurs while resizing the array,
  95. ** Vdbe.aOp and Vdbe.nOpAlloc remain unchanged (this is so that
  96. ** any opcodes already allocated can be correctly deallocated
  97. ** along with the rest of the Vdbe).
  98. */
  99. static void resizeOpArray(Vdbe *p, int N){
  100.   VdbeOp *pNew;
  101.   pNew = sqlite3DbRealloc(p->db, p->aOp, N*sizeof(Op));
  102.   if( pNew ){
  103.     p->nOpAlloc = N;
  104.     p->aOp = pNew;
  105.   }
  106. }
  107. /*
  108. ** Add a new instruction to the list of instructions current in the
  109. ** VDBE.  Return the address of the new instruction.
  110. **
  111. ** Parameters:
  112. **
  113. **    p               Pointer to the VDBE
  114. **
  115. **    op              The opcode for this instruction
  116. **
  117. **    p1, p2, p3      Operands
  118. **
  119. ** Use the sqlite3VdbeResolveLabel() function to fix an address and
  120. ** the sqlite3VdbeChangeP4() function to change the value of the P4
  121. ** operand.
  122. */
  123. int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
  124.   int i;
  125.   VdbeOp *pOp;
  126.   i = p->nOp;
  127.   assert( p->magic==VDBE_MAGIC_INIT );
  128.   if( p->nOpAlloc<=i ){
  129.     resizeOpArray(p, p->nOpAlloc ? p->nOpAlloc*2 : 1024/sizeof(Op));
  130.     if( p->db->mallocFailed ){
  131.       return 0;
  132.     }
  133.   }
  134.   p->nOp++;
  135.   pOp = &p->aOp[i];
  136.   pOp->opcode = op;
  137.   pOp->p5 = 0;
  138.   pOp->p1 = p1;
  139.   pOp->p2 = p2;
  140.   pOp->p3 = p3;
  141.   pOp->p4.p = 0;
  142.   pOp->p4type = P4_NOTUSED;
  143.   p->expired = 0;
  144. #ifdef SQLITE_DEBUG
  145.   pOp->zComment = 0;
  146.   if( sqlite3VdbeAddopTrace ) sqlite3VdbePrintOp(0, i, &p->aOp[i]);
  147. #endif
  148. #ifdef VDBE_PROFILE
  149.   pOp->cycles = 0;
  150.   pOp->cnt = 0;
  151. #endif
  152.   return i;
  153. }
  154. int sqlite3VdbeAddOp0(Vdbe *p, int op){
  155.   return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
  156. }
  157. int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
  158.   return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
  159. }
  160. int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
  161.   return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
  162. }
  163. /*
  164. ** Add an opcode that includes the p4 value as a pointer.
  165. */
  166. int sqlite3VdbeAddOp4(
  167.   Vdbe *p,            /* Add the opcode to this VM */
  168.   int op,             /* The new opcode */
  169.   int p1,             /* The P1 operand */
  170.   int p2,             /* The P2 operand */
  171.   int p3,             /* The P3 operand */
  172.   const char *zP4,    /* The P4 operand */
  173.   int p4type          /* P4 operand type */
  174. ){
  175.   int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  176.   sqlite3VdbeChangeP4(p, addr, zP4, p4type);
  177.   return addr;
  178. }
  179. /*
  180. ** Create a new symbolic label for an instruction that has yet to be
  181. ** coded.  The symbolic label is really just a negative number.  The
  182. ** label can be used as the P2 value of an operation.  Later, when
  183. ** the label is resolved to a specific address, the VDBE will scan
  184. ** through its operation list and change all values of P2 which match
  185. ** the label into the resolved address.
  186. **
  187. ** The VDBE knows that a P2 value is a label because labels are
  188. ** always negative and P2 values are suppose to be non-negative.
  189. ** Hence, a negative P2 value is a label that has yet to be resolved.
  190. **
  191. ** Zero is returned if a malloc() fails.
  192. */
  193. int sqlite3VdbeMakeLabel(Vdbe *p){
  194.   int i;
  195.   i = p->nLabel++;
  196.   assert( p->magic==VDBE_MAGIC_INIT );
  197.   if( i>=p->nLabelAlloc ){
  198.     p->nLabelAlloc = p->nLabelAlloc*2 + 10;
  199.     p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
  200.                                     p->nLabelAlloc*sizeof(p->aLabel[0]));
  201.   }
  202.   if( p->aLabel ){
  203.     p->aLabel[i] = -1;
  204.   }
  205.   return -1-i;
  206. }
  207. /*
  208. ** Resolve label "x" to be the address of the next instruction to
  209. ** be inserted.  The parameter "x" must have been obtained from
  210. ** a prior call to sqlite3VdbeMakeLabel().
  211. */
  212. void sqlite3VdbeResolveLabel(Vdbe *p, int x){
  213.   int j = -1-x;
  214.   assert( p->magic==VDBE_MAGIC_INIT );
  215.   assert( j>=0 && j<p->nLabel );
  216.   if( p->aLabel ){
  217.     p->aLabel[j] = p->nOp;
  218.   }
  219. }
  220. /*
  221. ** Loop through the program looking for P2 values that are negative
  222. ** on jump instructions.  Each such value is a label.  Resolve the
  223. ** label by setting the P2 value to its correct non-zero value.
  224. **
  225. ** This routine is called once after all opcodes have been inserted.
  226. **
  227. ** Variable *pMaxFuncArgs is set to the maximum value of any P2 argument 
  228. ** to an OP_Function, OP_AggStep or OP_VFilter opcode. This is used by 
  229. ** sqlite3VdbeMakeReady() to size the Vdbe.apArg[] array.
  230. **
  231. ** This routine also does the following optimization:  It scans for
  232. ** instructions that might cause a statement rollback.  Such instructions
  233. ** are:
  234. **
  235. **   *  OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
  236. **   *  OP_Destroy
  237. **   *  OP_VUpdate
  238. **   *  OP_VRename
  239. **
  240. ** If no such instruction is found, then every Statement instruction 
  241. ** is changed to a Noop.  In this way, we avoid creating the statement 
  242. ** journal file unnecessarily.
  243. */
  244. static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
  245.   int i;
  246.   int nMaxArgs = 0;
  247.   Op *pOp;
  248.   int *aLabel = p->aLabel;
  249.   int doesStatementRollback = 0;
  250.   int hasStatementBegin = 0;
  251.   for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
  252.     u8 opcode = pOp->opcode;
  253.     if( opcode==OP_Function ){
  254.       if( pOp->p5>nMaxArgs ) nMaxArgs = pOp->p5;
  255.     }else if( opcode==OP_AggStep 
  256. #ifndef SQLITE_OMIT_VIRTUALTABLE
  257.         || opcode==OP_VUpdate
  258. #endif
  259.     ){
  260.       if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
  261.     }
  262.     if( opcode==OP_Halt ){
  263.       if( pOp->p1==SQLITE_CONSTRAINT && pOp->p2==OE_Abort ){
  264.         doesStatementRollback = 1;
  265.       }
  266.     }else if( opcode==OP_Statement ){
  267.       hasStatementBegin = 1;
  268.     }else if( opcode==OP_Destroy ){
  269.       doesStatementRollback = 1;
  270. #ifndef SQLITE_OMIT_VIRTUALTABLE
  271.     }else if( opcode==OP_VUpdate || opcode==OP_VRename ){
  272.       doesStatementRollback = 1;
  273.     }else if( opcode==OP_VFilter ){
  274.       int n;
  275.       assert( p->nOp - i >= 3 );
  276.       assert( pOp[-1].opcode==OP_Integer );
  277.       n = pOp[-1].p1;
  278.       if( n>nMaxArgs ) nMaxArgs = n;
  279. #endif
  280.     }
  281.     if( sqlite3VdbeOpcodeHasProperty(opcode, OPFLG_JUMP) && pOp->p2<0 ){
  282.       assert( -1-pOp->p2<p->nLabel );
  283.       pOp->p2 = aLabel[-1-pOp->p2];
  284.     }
  285.   }
  286.   sqlite3_free(p->aLabel);
  287.   p->aLabel = 0;
  288.   *pMaxFuncArgs = nMaxArgs;
  289.   /* If we never rollback a statement transaction, then statement
  290.   ** transactions are not needed.  So change every OP_Statement
  291.   ** opcode into an OP_Noop.  This avoid a call to sqlite3OsOpenExclusive()
  292.   ** which can be expensive on some platforms.
  293.   */
  294.   if( hasStatementBegin && !doesStatementRollback ){
  295.     for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
  296.       if( pOp->opcode==OP_Statement ){
  297.         pOp->opcode = OP_Noop;
  298.       }
  299.     }
  300.   }
  301. }
  302. /*
  303. ** Return the address of the next instruction to be inserted.
  304. */
  305. int sqlite3VdbeCurrentAddr(Vdbe *p){
  306.   assert( p->magic==VDBE_MAGIC_INIT );
  307.   return p->nOp;
  308. }
  309. /*
  310. ** Add a whole list of operations to the operation stack.  Return the
  311. ** address of the first operation added.
  312. */
  313. int sqlite3VdbeAddOpList(Vdbe *p, int nOp, VdbeOpList const *aOp){
  314.   int addr;
  315.   assert( p->magic==VDBE_MAGIC_INIT );
  316.   if( p->nOp + nOp > p->nOpAlloc ){
  317.     resizeOpArray(p, p->nOpAlloc ? p->nOpAlloc*2 : 1024/sizeof(Op));
  318.     assert( p->nOp+nOp<=p->nOpAlloc || p->db->mallocFailed );
  319.   }
  320.   if( p->db->mallocFailed ){
  321.     return 0;
  322.   }
  323.   addr = p->nOp;
  324.   if( nOp>0 ){
  325.     int i;
  326.     VdbeOpList const *pIn = aOp;
  327.     for(i=0; i<nOp; i++, pIn++){
  328.       int p2 = pIn->p2;
  329.       VdbeOp *pOut = &p->aOp[i+addr];
  330.       pOut->opcode = pIn->opcode;
  331.       pOut->p1 = pIn->p1;
  332.       if( p2<0 && sqlite3VdbeOpcodeHasProperty(pOut->opcode, OPFLG_JUMP) ){
  333.         pOut->p2 = addr + ADDR(p2);
  334.       }else{
  335.         pOut->p2 = p2;
  336.       }
  337.       pOut->p3 = pIn->p3;
  338.       pOut->p4type = P4_NOTUSED;
  339.       pOut->p4.p = 0;
  340.       pOut->p5 = 0;
  341. #ifdef SQLITE_DEBUG
  342.       pOut->zComment = 0;
  343.       if( sqlite3VdbeAddopTrace ){
  344.         sqlite3VdbePrintOp(0, i+addr, &p->aOp[i+addr]);
  345.       }
  346. #endif
  347.     }
  348.     p->nOp += nOp;
  349.   }
  350.   return addr;
  351. }
  352. /*
  353. ** Change the value of the P1 operand for a specific instruction.
  354. ** This routine is useful when a large program is loaded from a
  355. ** static array using sqlite3VdbeAddOpList but we want to make a
  356. ** few minor changes to the program.
  357. */
  358. void sqlite3VdbeChangeP1(Vdbe *p, int addr, int val){
  359.   assert( p==0 || p->magic==VDBE_MAGIC_INIT );
  360.   if( p && addr>=0 && p->nOp>addr && p->aOp ){
  361.     p->aOp[addr].p1 = val;
  362.   }
  363. }
  364. /*
  365. ** Change the value of the P2 operand for a specific instruction.
  366. ** This routine is useful for setting a jump destination.
  367. */
  368. void sqlite3VdbeChangeP2(Vdbe *p, int addr, int val){
  369.   assert( p==0 || p->magic==VDBE_MAGIC_INIT );
  370.   if( p && addr>=0 && p->nOp>addr && p->aOp ){
  371.     p->aOp[addr].p2 = val;
  372.   }
  373. }
  374. /*
  375. ** Change the value of the P3 operand for a specific instruction.
  376. */
  377. void sqlite3VdbeChangeP3(Vdbe *p, int addr, int val){
  378.   assert( p==0 || p->magic==VDBE_MAGIC_INIT );
  379.   if( p && addr>=0 && p->nOp>addr && p->aOp ){
  380.     p->aOp[addr].p3 = val;
  381.   }
  382. }
  383. /*
  384. ** Change the value of the P5 operand for the most recently
  385. ** added operation.
  386. */
  387. void sqlite3VdbeChangeP5(Vdbe *p, u8 val){
  388.   assert( p==0 || p->magic==VDBE_MAGIC_INIT );
  389.   if( p && p->aOp ){
  390.     assert( p->nOp>0 );
  391.     p->aOp[p->nOp-1].p5 = val;
  392.   }
  393. }
  394. /*
  395. ** Change the P2 operand of instruction addr so that it points to
  396. ** the address of the next instruction to be coded.
  397. */
  398. void sqlite3VdbeJumpHere(Vdbe *p, int addr){
  399.   sqlite3VdbeChangeP2(p, addr, p->nOp);
  400. }
  401. /*
  402. ** If the input FuncDef structure is ephemeral, then free it.  If
  403. ** the FuncDef is not ephermal, then do nothing.
  404. */
  405. static void freeEphemeralFunction(FuncDef *pDef){
  406.   if( pDef && (pDef->flags & SQLITE_FUNC_EPHEM)!=0 ){
  407.     sqlite3_free(pDef);
  408.   }
  409. }
  410. /*
  411. ** Delete a P4 value if necessary.
  412. */
  413. static void freeP4(int p4type, void *p3){
  414.   if( p3 ){
  415.     switch( p4type ){
  416.       case P4_REAL:
  417.       case P4_INT64:
  418.       case P4_MPRINTF:
  419.       case P4_DYNAMIC:
  420.       case P4_KEYINFO:
  421.       case P4_KEYINFO_HANDOFF: {
  422.         sqlite3_free(p3);
  423.         break;
  424.       }
  425.       case P4_VDBEFUNC: {
  426.         VdbeFunc *pVdbeFunc = (VdbeFunc *)p3;
  427.         freeEphemeralFunction(pVdbeFunc->pFunc);
  428.         sqlite3VdbeDeleteAuxData(pVdbeFunc, 0);
  429.         sqlite3_free(pVdbeFunc);
  430.         break;
  431.       }
  432.       case P4_FUNCDEF: {
  433.         freeEphemeralFunction((FuncDef*)p3);
  434.         break;
  435.       }
  436.       case P4_MEM: {
  437.         sqlite3ValueFree((sqlite3_value*)p3);
  438.         break;
  439.       }
  440.     }
  441.   }
  442. }
  443. /*
  444. ** Change N opcodes starting at addr to No-ops.
  445. */
  446. void sqlite3VdbeChangeToNoop(Vdbe *p, int addr, int N){
  447.   if( p && p->aOp ){
  448.     VdbeOp *pOp = &p->aOp[addr];
  449.     while( N-- ){
  450.       freeP4(pOp->p4type, pOp->p4.p);
  451.       memset(pOp, 0, sizeof(pOp[0]));
  452.       pOp->opcode = OP_Noop;
  453.       pOp++;
  454.     }
  455.   }
  456. }
  457. /*
  458. ** Change the value of the P4 operand for a specific instruction.
  459. ** This routine is useful when a large program is loaded from a
  460. ** static array using sqlite3VdbeAddOpList but we want to make a
  461. ** few minor changes to the program.
  462. **
  463. ** If n>=0 then the P4 operand is dynamic, meaning that a copy of
  464. ** the string is made into memory obtained from sqlite3_malloc().
  465. ** A value of n==0 means copy bytes of zP4 up to and including the
  466. ** first null byte.  If n>0 then copy n+1 bytes of zP4.
  467. **
  468. ** If n==P4_KEYINFO it means that zP4 is a pointer to a KeyInfo structure.
  469. ** A copy is made of the KeyInfo structure into memory obtained from
  470. ** sqlite3_malloc, to be freed when the Vdbe is finalized.
  471. ** n==P4_KEYINFO_HANDOFF indicates that zP4 points to a KeyInfo structure
  472. ** stored in memory that the caller has obtained from sqlite3_malloc. The 
  473. ** caller should not free the allocation, it will be freed when the Vdbe is
  474. ** finalized.
  475. ** 
  476. ** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
  477. ** to a string or structure that is guaranteed to exist for the lifetime of
  478. ** the Vdbe. In these cases we can just copy the pointer.
  479. **
  480. ** If addr<0 then change P4 on the most recently inserted instruction.
  481. */
  482. void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
  483.   Op *pOp;
  484.   assert( p!=0 );
  485.   assert( p->magic==VDBE_MAGIC_INIT );
  486.   if( p->aOp==0 || p->db->mallocFailed ){
  487.     if (n != P4_KEYINFO) {
  488.       freeP4(n, (void*)*(char**)&zP4);
  489.     }
  490.     return;
  491.   }
  492.   assert( addr<p->nOp );
  493.   if( addr<0 ){
  494.     addr = p->nOp - 1;
  495.     if( addr<0 ) return;
  496.   }
  497.   pOp = &p->aOp[addr];
  498.   freeP4(pOp->p4type, pOp->p4.p);
  499.   pOp->p4.p = 0;
  500.   if( n==P4_INT32 ){
  501.     /* Note: this cast is safe, because the origin data point was an int
  502.     ** that was cast to a (const char *). */
  503.     pOp->p4.i = (int)(sqlite3_intptr_t)zP4;
  504.     pOp->p4type = n;
  505.   }else if( zP4==0 ){
  506.     pOp->p4.p = 0;
  507.     pOp->p4type = P4_NOTUSED;
  508.   }else if( n==P4_KEYINFO ){
  509.     KeyInfo *pKeyInfo;
  510.     int nField, nByte;
  511.     nField = ((KeyInfo*)zP4)->nField;
  512.     nByte = sizeof(*pKeyInfo) + (nField-1)*sizeof(pKeyInfo->aColl[0]) + nField;
  513.     pKeyInfo = sqlite3_malloc( nByte );
  514.     pOp->p4.pKeyInfo = pKeyInfo;
  515.     if( pKeyInfo ){
  516.       memcpy(pKeyInfo, zP4, nByte);
  517.       /* In the current implementation, P4_KEYINFO is only ever used on
  518.       ** KeyInfo structures that have no aSortOrder component.  Elements
  519.       ** with an aSortOrder always use P4_KEYINFO_HANDOFF.  So we do not
  520.       ** need to bother with duplicating the aSortOrder. */
  521.       assert( pKeyInfo->aSortOrder==0 );
  522. #if 0
  523.       aSortOrder = pKeyInfo->aSortOrder;
  524.       if( aSortOrder ){
  525.         pKeyInfo->aSortOrder = (unsigned char*)&pKeyInfo->aColl[nField];
  526.         memcpy(pKeyInfo->aSortOrder, aSortOrder, nField);
  527.       }
  528. #endif
  529.       pOp->p4type = P4_KEYINFO;
  530.     }else{
  531.       p->db->mallocFailed = 1;
  532.       pOp->p4type = P4_NOTUSED;
  533.     }
  534.   }else if( n==P4_KEYINFO_HANDOFF ){
  535.     pOp->p4.p = (void*)zP4;
  536.     pOp->p4type = P4_KEYINFO;
  537.   }else if( n<0 ){
  538.     pOp->p4.p = (void*)zP4;
  539.     pOp->p4type = n;
  540.   }else{
  541.     if( n==0 ) n = strlen(zP4);
  542.     pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
  543.     pOp->p4type = P4_DYNAMIC;
  544.   }
  545. }
  546. #ifndef NDEBUG
  547. /*
  548. ** Change the comment on the the most recently coded instruction.
  549. */
  550. void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
  551.   va_list ap;
  552.   assert( p->nOp>0 || p->aOp==0 );
  553.   assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
  554.   if( p->nOp ){
  555.     char **pz = &p->aOp[p->nOp-1].zComment;
  556.     va_start(ap, zFormat);
  557.     sqlite3_free(*pz);
  558.     *pz = sqlite3VMPrintf(p->db, zFormat, ap);
  559.     va_end(ap);
  560.   }
  561. }
  562. #endif
  563. /*
  564. ** Return the opcode for a given address.
  565. */
  566. VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
  567.   assert( p->magic==VDBE_MAGIC_INIT );
  568.   assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
  569.   return ((addr>=0 && addr<p->nOp)?(&p->aOp[addr]):0);
  570. }
  571. #if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) 
  572.      || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  573. /*
  574. ** Compute a string that describes the P4 parameter for an opcode.
  575. ** Use zTemp for any required temporary buffer space.
  576. */
  577. static char *displayP4(Op *pOp, char *zTemp, int nTemp){
  578.   char *zP4 = zTemp;
  579.   assert( nTemp>=20 );
  580.   switch( pOp->p4type ){
  581.     case P4_KEYINFO: {
  582.       int i, j;
  583.       KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
  584.       sqlite3_snprintf(nTemp, zTemp, "keyinfo(%d", pKeyInfo->nField);
  585.       i = strlen(zTemp);
  586.       for(j=0; j<pKeyInfo->nField; j++){
  587.         CollSeq *pColl = pKeyInfo->aColl[j];
  588.         if( pColl ){
  589.           int n = strlen(pColl->zName);
  590.           if( i+n>nTemp-6 ){
  591.             memcpy(&zTemp[i],",...",4);
  592.             break;
  593.           }
  594.           zTemp[i++] = ',';
  595.           if( pKeyInfo->aSortOrder && pKeyInfo->aSortOrder[j] ){
  596.             zTemp[i++] = '-';
  597.           }
  598.           memcpy(&zTemp[i], pColl->zName,n+1);
  599.           i += n;
  600.         }else if( i+4<nTemp-6 ){
  601.           memcpy(&zTemp[i],",nil",4);
  602.           i += 4;
  603.         }
  604.       }
  605.       zTemp[i++] = ')';
  606.       zTemp[i] = 0;
  607.       assert( i<nTemp );
  608.       break;
  609.     }
  610.     case P4_COLLSEQ: {
  611.       CollSeq *pColl = pOp->p4.pColl;
  612.       sqlite3_snprintf(nTemp, zTemp, "collseq(%.20s)", pColl->zName);
  613.       break;
  614.     }
  615.     case P4_FUNCDEF: {
  616.       FuncDef *pDef = pOp->p4.pFunc;
  617.       sqlite3_snprintf(nTemp, zTemp, "%s(%d)", pDef->zName, pDef->nArg);
  618.       break;
  619.     }
  620.     case P4_INT64: {
  621.       sqlite3_snprintf(nTemp, zTemp, "%lld", *pOp->p4.pI64);
  622.       break;
  623.     }
  624.     case P4_INT32: {
  625.       sqlite3_snprintf(nTemp, zTemp, "%d", pOp->p4.i);
  626.       break;
  627.     }
  628.     case P4_REAL: {
  629.       sqlite3_snprintf(nTemp, zTemp, "%.16g", *pOp->p4.pReal);
  630.       break;
  631.     }
  632.     case P4_MEM: {
  633.       Mem *pMem = pOp->p4.pMem;
  634.       assert( (pMem->flags & MEM_Null)==0 );
  635.       if( pMem->flags & MEM_Str ){
  636.         zP4 = pMem->z;
  637.       }else if( pMem->flags & MEM_Int ){
  638.         sqlite3_snprintf(nTemp, zTemp, "%lld", pMem->u.i);
  639.       }else if( pMem->flags & MEM_Real ){
  640.         sqlite3_snprintf(nTemp, zTemp, "%.16g", pMem->r);
  641.       }
  642.       break;
  643.     }
  644. #ifndef SQLITE_OMIT_VIRTUALTABLE
  645.     case P4_VTAB: {
  646.       sqlite3_vtab *pVtab = pOp->p4.pVtab;
  647.       sqlite3_snprintf(nTemp, zTemp, "vtab:%p:%p", pVtab, pVtab->pModule);
  648.       break;
  649.     }
  650. #endif
  651.     default: {
  652.       zP4 = pOp->p4.z;
  653.       if( zP4==0 ){
  654.         zP4 = zTemp;
  655.         zTemp[0] = 0;
  656.       }
  657.     }
  658.   }
  659.   assert( zP4!=0 );
  660.   return zP4;
  661. }
  662. #endif
  663. /*
  664. ** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
  665. **
  666. */
  667. void sqlite3VdbeUsesBtree(Vdbe *p, int i){
  668.   int mask;
  669.   assert( i>=0 && i<p->db->nDb );
  670.   assert( i<sizeof(p->btreeMask)*8 );
  671.   mask = 1<<i;
  672.   if( (p->btreeMask & mask)==0 ){
  673.     p->btreeMask |= mask;
  674.     sqlite3BtreeMutexArrayInsert(&p->aMutex, p->db->aDb[i].pBt);
  675.   }
  676. }
  677. #if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  678. /*
  679. ** Print a single opcode.  This routine is used for debugging only.
  680. */
  681. void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
  682.   char *zP4;
  683.   char zPtr[50];
  684.   static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-4s %.2X %sn";
  685.   if( pOut==0 ) pOut = stdout;
  686.   zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
  687.   fprintf(pOut, zFormat1, pc, 
  688.       sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
  689. #ifdef SQLITE_DEBUG
  690.       pOp->zComment ? pOp->zComment : ""
  691. #else
  692.       ""
  693. #endif
  694.   );
  695.   fflush(pOut);
  696. }
  697. #endif
  698. /*
  699. ** Release an array of N Mem elements
  700. */
  701. static void releaseMemArray(Mem *p, int N, int freebuffers){
  702.   if( p && N ){
  703.     sqlite3 *db = p->db;
  704.     int malloc_failed = db->mallocFailed;
  705.     while( N-->0 ){
  706.       assert( N<2 || p[0].db==p[1].db );
  707.       if( freebuffers ){
  708.         sqlite3VdbeMemRelease(p);
  709.       }else{
  710.         sqlite3VdbeMemReleaseExternal(p);
  711.       }
  712.       p->flags = MEM_Null;
  713.       p++;
  714.     }
  715.     db->mallocFailed = malloc_failed;
  716.   }
  717. }
  718. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  719. int sqlite3VdbeReleaseBuffers(Vdbe *p){
  720.   int ii;
  721.   int nFree = 0;
  722.   assert( sqlite3_mutex_held(p->db->mutex) );
  723.   for(ii=1; ii<=p->nMem; ii++){
  724.     Mem *pMem = &p->aMem[ii];
  725.     if( pMem->z && pMem->flags&MEM_Dyn ){
  726.       assert( !pMem->xDel );
  727.       nFree += sqlite3MallocSize(pMem->z);
  728.       sqlite3VdbeMemRelease(pMem);
  729.     }
  730.   }
  731.   return nFree;
  732. }
  733. #endif
  734. #ifndef SQLITE_OMIT_EXPLAIN
  735. /*
  736. ** Give a listing of the program in the virtual machine.
  737. **
  738. ** The interface is the same as sqlite3VdbeExec().  But instead of
  739. ** running the code, it invokes the callback once for each instruction.
  740. ** This feature is used to implement "EXPLAIN".
  741. **
  742. ** When p->explain==1, each instruction is listed.  When
  743. ** p->explain==2, only OP_Explain instructions are listed and these
  744. ** are shown in a different format.  p->explain==2 is used to implement
  745. ** EXPLAIN QUERY PLAN.
  746. */
  747. int sqlite3VdbeList(
  748.   Vdbe *p                   /* The VDBE */
  749. ){
  750.   sqlite3 *db = p->db;
  751.   int i;
  752.   int rc = SQLITE_OK;
  753.   Mem *pMem = p->pResultSet = &p->aMem[1];
  754.   assert( p->explain );
  755.   if( p->magic!=VDBE_MAGIC_RUN ) return SQLITE_MISUSE;
  756.   assert( db->magic==SQLITE_MAGIC_BUSY );
  757.   assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY );
  758.   /* Even though this opcode does not use dynamic strings for
  759.   ** the result, result columns may become dynamic if the user calls
  760.   ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
  761.   */
  762.   releaseMemArray(pMem, p->nMem, 1);
  763.   do{
  764.     i = p->pc++;
  765.   }while( i<p->nOp && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
  766.   if( i>=p->nOp ){
  767.     p->rc = SQLITE_OK;
  768.     rc = SQLITE_DONE;
  769.   }else if( db->u1.isInterrupted ){
  770.     p->rc = SQLITE_INTERRUPT;
  771.     rc = SQLITE_ERROR;
  772.     sqlite3SetString(&p->zErrMsg, sqlite3ErrStr(p->rc), (char*)0);
  773.   }else{
  774.     char *z;
  775.     Op *pOp = &p->aOp[i];
  776.     if( p->explain==1 ){
  777.       pMem->flags = MEM_Int;
  778.       pMem->type = SQLITE_INTEGER;
  779.       pMem->u.i = i;                                /* Program counter */
  780.       pMem++;
  781.   
  782.       pMem->flags = MEM_Static|MEM_Str|MEM_Term;
  783.       pMem->z = (char*)sqlite3OpcodeName(pOp->opcode);  /* Opcode */
  784.       assert( pMem->z!=0 );
  785.       pMem->n = strlen(pMem->z);
  786.       pMem->type = SQLITE_TEXT;
  787.       pMem->enc = SQLITE_UTF8;
  788.       pMem++;
  789.     }
  790.     pMem->flags = MEM_Int;
  791.     pMem->u.i = pOp->p1;                          /* P1 */
  792.     pMem->type = SQLITE_INTEGER;
  793.     pMem++;
  794.     pMem->flags = MEM_Int;
  795.     pMem->u.i = pOp->p2;                          /* P2 */
  796.     pMem->type = SQLITE_INTEGER;
  797.     pMem++;
  798.     if( p->explain==1 ){
  799.       pMem->flags = MEM_Int;
  800.       pMem->u.i = pOp->p3;                          /* P3 */
  801.       pMem->type = SQLITE_INTEGER;
  802.       pMem++;
  803.     }
  804.     if( sqlite3VdbeMemGrow(pMem, 32, 0) ){            /* P4 */
  805.       p->db->mallocFailed = 1;
  806.       return SQLITE_NOMEM;
  807.     }
  808.     pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
  809.     z = displayP4(pOp, pMem->z, 32);
  810.     if( z!=pMem->z ){
  811.       sqlite3VdbeMemSetStr(pMem, z, -1, SQLITE_UTF8, 0);
  812.     }else{
  813.       assert( pMem->z!=0 );
  814.       pMem->n = strlen(pMem->z);
  815.       pMem->enc = SQLITE_UTF8;
  816.     }
  817.     pMem->type = SQLITE_TEXT;
  818.     pMem++;
  819.     if( p->explain==1 ){
  820.       if( sqlite3VdbeMemGrow(pMem, 4, 0) ){
  821.         p->db->mallocFailed = 1;
  822.         return SQLITE_NOMEM;
  823.       }
  824.       pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
  825.       pMem->n = 2;
  826.       sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5);   /* P5 */
  827.       pMem->type = SQLITE_TEXT;
  828.       pMem->enc = SQLITE_UTF8;
  829.       pMem++;
  830.   
  831. #ifdef SQLITE_DEBUG
  832.       if( pOp->zComment ){
  833.         pMem->flags = MEM_Str|MEM_Term;
  834.         pMem->z = pOp->zComment;
  835.         pMem->n = strlen(pMem->z);
  836.         pMem->enc = SQLITE_UTF8;
  837.       }else
  838. #endif
  839.       {
  840.         pMem->flags = MEM_Null;                       /* Comment */
  841.         pMem->type = SQLITE_NULL;
  842.       }
  843.     }
  844.     p->nResColumn = 8 - 5*(p->explain-1);
  845.     p->rc = SQLITE_OK;
  846.     rc = SQLITE_ROW;
  847.   }
  848.   return rc;
  849. }
  850. #endif /* SQLITE_OMIT_EXPLAIN */
  851. #ifdef SQLITE_DEBUG
  852. /*
  853. ** Print the SQL that was used to generate a VDBE program.
  854. */
  855. void sqlite3VdbePrintSql(Vdbe *p){
  856.   int nOp = p->nOp;
  857.   VdbeOp *pOp;
  858.   if( nOp<1 ) return;
  859.   pOp = &p->aOp[0];
  860.   if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
  861.     const char *z = pOp->p4.z;
  862.     while( isspace(*(u8*)z) ) z++;
  863.     printf("SQL: [%s]n", z);
  864.   }
  865. }
  866. #endif
  867. #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
  868. /*
  869. ** Print an IOTRACE message showing SQL content.
  870. */
  871. void sqlite3VdbeIOTraceSql(Vdbe *p){
  872.   int nOp = p->nOp;
  873.   VdbeOp *pOp;
  874.   if( sqlite3IoTrace==0 ) return;
  875.   if( nOp<1 ) return;
  876.   pOp = &p->aOp[0];
  877.   if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
  878.     int i, j;
  879.     char z[1000];
  880.     sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
  881.     for(i=0; isspace((unsigned char)z[i]); i++){}
  882.     for(j=0; z[i]; i++){
  883.       if( isspace((unsigned char)z[i]) ){
  884.         if( z[i-1]!=' ' ){
  885.           z[j++] = ' ';
  886.         }
  887.       }else{
  888.         z[j++] = z[i];
  889.       }
  890.     }
  891.     z[j] = 0;
  892.     sqlite3IoTrace("SQL %sn", z);
  893.   }
  894. }
  895. #endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
  896. /*
  897. ** Prepare a virtual machine for execution.  This involves things such
  898. ** as allocating stack space and initializing the program counter.
  899. ** After the VDBE has be prepped, it can be executed by one or more
  900. ** calls to sqlite3VdbeExec().  
  901. **
  902. ** This is the only way to move a VDBE from VDBE_MAGIC_INIT to
  903. ** VDBE_MAGIC_RUN.
  904. */
  905. void sqlite3VdbeMakeReady(
  906.   Vdbe *p,                       /* The VDBE */
  907.   int nVar,                      /* Number of '?' see in the SQL statement */
  908.   int nMem,                      /* Number of memory cells to allocate */
  909.   int nCursor,                   /* Number of cursors to allocate */
  910.   int isExplain                  /* True if the EXPLAIN keywords is present */
  911. ){
  912.   int n;
  913.   sqlite3 *db = p->db;
  914.   assert( p!=0 );
  915.   assert( p->magic==VDBE_MAGIC_INIT );
  916.   /* There should be at least one opcode.
  917.   */
  918.   assert( p->nOp>0 );
  919.   /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. This
  920.    * is because the call to resizeOpArray() below may shrink the
  921.    * p->aOp[] array to save memory if called when in VDBE_MAGIC_RUN 
  922.    * state.
  923.    */
  924.   p->magic = VDBE_MAGIC_RUN;
  925.   /* For each cursor required, also allocate a memory cell. Memory
  926.   ** cells (nMem+1-nCursor)..nMem, inclusive, will never be used by
  927.   ** the vdbe program. Instead they are used to allocate space for
  928.   ** Cursor/BtCursor structures. The blob of memory associated with 
  929.   ** cursor 0 is stored in memory cell nMem. Memory cell (nMem-1)
  930.   ** stores the blob of memory associated with cursor 1, etc.
  931.   **
  932.   ** See also: allocateCursor().
  933.   */
  934.   nMem += nCursor;
  935.   /*
  936.   ** Allocation space for registers.
  937.   */
  938.   if( p->aMem==0 ){
  939.     int nArg;       /* Maximum number of args passed to a user function. */
  940.     resolveP2Values(p, &nArg);
  941.     /*resizeOpArray(p, p->nOp);*/
  942.     assert( nVar>=0 );
  943.     if( isExplain && nMem<10 ){
  944.       p->nMem = nMem = 10;
  945.     }
  946.     p->aMem = sqlite3DbMallocZero(db,
  947.         nMem*sizeof(Mem)               /* aMem */
  948.       + nVar*sizeof(Mem)               /* aVar */
  949.       + nArg*sizeof(Mem*)              /* apArg */
  950.       + nVar*sizeof(char*)             /* azVar */
  951.       + nCursor*sizeof(Cursor*) + 1    /* apCsr */
  952.     );
  953.     if( !db->mallocFailed ){
  954.       p->aMem--;             /* aMem[] goes from 1..nMem */
  955.       p->nMem = nMem;        /*       not from 0..nMem-1 */
  956.       p->aVar = &p->aMem[nMem+1];
  957.       p->nVar = nVar;
  958.       p->okVar = 0;
  959.       p->apArg = (Mem**)&p->aVar[nVar];
  960.       p->azVar = (char**)&p->apArg[nArg];
  961.       p->apCsr = (Cursor**)&p->azVar[nVar];
  962.       p->nCursor = nCursor;
  963.       for(n=0; n<nVar; n++){
  964.         p->aVar[n].flags = MEM_Null;
  965.         p->aVar[n].db = db;
  966.       }
  967.       for(n=1; n<=nMem; n++){
  968.         p->aMem[n].flags = MEM_Null;
  969.         p->aMem[n].db = db;
  970.       }
  971.     }
  972.   }
  973. #ifdef SQLITE_DEBUG
  974.   for(n=1; n<p->nMem; n++){
  975.     assert( p->aMem[n].db==db );
  976.   }
  977. #endif
  978.   p->pc = -1;
  979.   p->rc = SQLITE_OK;
  980.   p->uniqueCnt = 0;
  981.   p->returnDepth = 0;
  982.   p->errorAction = OE_Abort;
  983.   p->explain |= isExplain;
  984.   p->magic = VDBE_MAGIC_RUN;
  985.   p->nChange = 0;
  986.   p->cacheCtr = 1;
  987.   p->minWriteFileFormat = 255;
  988.   p->openedStatement = 0;
  989. #ifdef VDBE_PROFILE
  990.   {
  991.     int i;
  992.     for(i=0; i<p->nOp; i++){
  993.       p->aOp[i].cnt = 0;
  994.       p->aOp[i].cycles = 0;
  995.     }
  996.   }
  997. #endif
  998. }
  999. /*
  1000. ** Close a VDBE cursor and release all the resources that cursor 
  1001. ** happens to hold.
  1002. */
  1003. void sqlite3VdbeFreeCursor(Vdbe *p, Cursor *pCx){
  1004.   if( pCx==0 ){
  1005.     return;
  1006.   }
  1007.   if( pCx->pCursor ){
  1008.     sqlite3BtreeCloseCursor(pCx->pCursor);
  1009.   }
  1010.   if( pCx->pBt ){
  1011.     sqlite3BtreeClose(pCx->pBt);
  1012.   }
  1013. #ifndef SQLITE_OMIT_VIRTUALTABLE
  1014.   if( pCx->pVtabCursor ){
  1015.     sqlite3_vtab_cursor *pVtabCursor = pCx->pVtabCursor;
  1016.     const sqlite3_module *pModule = pCx->pModule;
  1017.     p->inVtabMethod = 1;
  1018.     (void)sqlite3SafetyOff(p->db);
  1019.     pModule->xClose(pVtabCursor);
  1020.     (void)sqlite3SafetyOn(p->db);
  1021.     p->inVtabMethod = 0;
  1022.   }
  1023. #endif
  1024.   if( !pCx->ephemPseudoTable ){
  1025.     sqlite3_free(pCx->pData);
  1026.   }
  1027.   /* memset(pCx, 0, sizeof(Cursor)); */
  1028.   /* sqlite3_free(pCx->aType); */
  1029.   /* sqlite3_free(pCx); */
  1030. }
  1031. /*
  1032. ** Close all cursors except for VTab cursors that are currently
  1033. ** in use.
  1034. */
  1035. static void closeAllCursorsExceptActiveVtabs(Vdbe *p){
  1036.   int i;
  1037.   if( p->apCsr==0 ) return;
  1038.   for(i=0; i<p->nCursor; i++){
  1039.     Cursor *pC = p->apCsr[i];
  1040.     if( pC && (!p->inVtabMethod || !pC->pVtabCursor) ){
  1041.       sqlite3VdbeFreeCursor(p, pC);
  1042.       p->apCsr[i] = 0;
  1043.     }
  1044.   }
  1045. }
  1046. /*
  1047. ** Clean up the VM after execution.
  1048. **
  1049. ** This routine will automatically close any cursors, lists, and/or
  1050. ** sorters that were left open.  It also deletes the values of
  1051. ** variables in the aVar[] array.
  1052. */
  1053. static void Cleanup(Vdbe *p, int freebuffers){
  1054.   int i;
  1055.   closeAllCursorsExceptActiveVtabs(p);
  1056.   for(i=1; i<=p->nMem; i++){
  1057.     MemSetTypeFlag(&p->aMem[i], MEM_Null);
  1058.   }
  1059.   releaseMemArray(&p->aMem[1], p->nMem, freebuffers);
  1060.   sqlite3VdbeFifoClear(&p->sFifo);
  1061.   if( p->contextStack ){
  1062.     for(i=0; i<p->contextStackTop; i++){
  1063.       sqlite3VdbeFifoClear(&p->contextStack[i].sFifo);
  1064.     }
  1065.     sqlite3_free(p->contextStack);
  1066.   }
  1067.   p->contextStack = 0;
  1068.   p->contextStackDepth = 0;
  1069.   p->contextStackTop = 0;
  1070.   sqlite3_free(p->zErrMsg);
  1071.   p->zErrMsg = 0;
  1072.   p->pResultSet = 0;
  1073. }
  1074. /*
  1075. ** Set the number of result columns that will be returned by this SQL
  1076. ** statement. This is now set at compile time, rather than during
  1077. ** execution of the vdbe program so that sqlite3_column_count() can
  1078. ** be called on an SQL statement before sqlite3_step().
  1079. */
  1080. void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
  1081.   Mem *pColName;
  1082.   int n;
  1083.   releaseMemArray(p->aColName, p->nResColumn*COLNAME_N, 1);
  1084.   sqlite3_free(p->aColName);
  1085.   n = nResColumn*COLNAME_N;
  1086.   p->nResColumn = nResColumn;
  1087.   p->aColName = pColName = (Mem*)sqlite3DbMallocZero(p->db, sizeof(Mem)*n );
  1088.   if( p->aColName==0 ) return;
  1089.   while( n-- > 0 ){
  1090.     pColName->flags = MEM_Null;
  1091.     pColName->db = p->db;
  1092.     pColName++;
  1093.   }
  1094. }
  1095. /*
  1096. ** Set the name of the idx'th column to be returned by the SQL statement.
  1097. ** zName must be a pointer to a nul terminated string.
  1098. **
  1099. ** This call must be made after a call to sqlite3VdbeSetNumCols().
  1100. **
  1101. ** If N==P4_STATIC  it means that zName is a pointer to a constant static
  1102. ** string and we can just copy the pointer. If it is P4_DYNAMIC, then 
  1103. ** the string is freed using sqlite3_free() when the vdbe is finished with
  1104. ** it. Otherwise, N bytes of zName are copied.
  1105. */
  1106. int sqlite3VdbeSetColName(Vdbe *p, int idx, int var, const char *zName, int N){
  1107.   int rc;
  1108.   Mem *pColName;
  1109.   assert( idx<p->nResColumn );
  1110.   assert( var<COLNAME_N );
  1111.   if( p->db->mallocFailed ) return SQLITE_NOMEM;
  1112.   assert( p->aColName!=0 );
  1113.   pColName = &(p->aColName[idx+var*p->nResColumn]);
  1114.   if( N==P4_DYNAMIC || N==P4_STATIC ){
  1115.     rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, SQLITE_STATIC);
  1116.   }else{
  1117.     rc = sqlite3VdbeMemSetStr(pColName, zName, N, SQLITE_UTF8,SQLITE_TRANSIENT);
  1118.   }
  1119.   if( rc==SQLITE_OK && N==P4_DYNAMIC ){
  1120.     pColName->flags &= (~MEM_Static);
  1121.     pColName->zMalloc = pColName->z;
  1122.   }
  1123.   return rc;
  1124. }
  1125. /*
  1126. ** A read or write transaction may or may not be active on database handle
  1127. ** db. If a transaction is active, commit it. If there is a
  1128. ** write-transaction spanning more than one database file, this routine
  1129. ** takes care of the master journal trickery.
  1130. */
  1131. static int vdbeCommit(sqlite3 *db){
  1132.   int i;
  1133.   int nTrans = 0;  /* Number of databases with an active write-transaction */
  1134.   int rc = SQLITE_OK;
  1135.   int needXcommit = 0;
  1136.   /* Before doing anything else, call the xSync() callback for any
  1137.   ** virtual module tables written in this transaction. This has to
  1138.   ** be done before determining whether a master journal file is 
  1139.   ** required, as an xSync() callback may add an attached database
  1140.   ** to the transaction.
  1141.   */
  1142.   rc = sqlite3VtabSync(db, rc);
  1143.   if( rc!=SQLITE_OK ){
  1144.     return rc;
  1145.   }
  1146.   /* This loop determines (a) if the commit hook should be invoked and
  1147.   ** (b) how many database files have open write transactions, not 
  1148.   ** including the temp database. (b) is important because if more than 
  1149.   ** one database file has an open write transaction, a master journal
  1150.   ** file is required for an atomic commit.
  1151.   */ 
  1152.   for(i=0; i<db->nDb; i++){ 
  1153.     Btree *pBt = db->aDb[i].pBt;
  1154.     if( sqlite3BtreeIsInTrans(pBt) ){
  1155.       needXcommit = 1;
  1156.       if( i!=1 ) nTrans++;
  1157.     }
  1158.   }
  1159.   /* If there are any write-transactions at all, invoke the commit hook */
  1160.   if( needXcommit && db->xCommitCallback ){
  1161.     (void)sqlite3SafetyOff(db);
  1162.     rc = db->xCommitCallback(db->pCommitArg);
  1163.     (void)sqlite3SafetyOn(db);
  1164.     if( rc ){
  1165.       return SQLITE_CONSTRAINT;
  1166.     }
  1167.   }
  1168.   /* The simple case - no more than one database file (not counting the
  1169.   ** TEMP database) has a transaction active.   There is no need for the
  1170.   ** master-journal.
  1171.   **
  1172.   ** If the return value of sqlite3BtreeGetFilename() is a zero length
  1173.   ** string, it means the main database is :memory:.  In that case we do
  1174.   ** not support atomic multi-file commits, so use the simple case then
  1175.   ** too.
  1176.   */
  1177.   if( 0==strlen(sqlite3BtreeGetFilename(db->aDb[0].pBt)) || nTrans<=1 ){
  1178.     for(i=0; rc==SQLITE_OK && i<db->nDb; i++){ 
  1179.       Btree *pBt = db->aDb[i].pBt;
  1180.       if( pBt ){
  1181.         rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
  1182.       }
  1183.     }
  1184.     /* Do the commit only if all databases successfully complete phase 1. 
  1185.     ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
  1186.     ** IO error while deleting or truncating a journal file. It is unlikely,
  1187.     ** but could happen. In this case abandon processing and return the error.
  1188.     */
  1189.     for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  1190.       Btree *pBt = db->aDb[i].pBt;
  1191.       if( pBt ){
  1192.         rc = sqlite3BtreeCommitPhaseTwo(pBt);
  1193.       }
  1194.     }
  1195.     if( rc==SQLITE_OK ){
  1196.       sqlite3VtabCommit(db);
  1197.     }
  1198.   }
  1199.   /* The complex case - There is a multi-file write-transaction active.
  1200.   ** This requires a master journal file to ensure the transaction is
  1201.   ** committed atomicly.
  1202.   */
  1203. #ifndef SQLITE_OMIT_DISKIO
  1204.   else{
  1205.     sqlite3_vfs *pVfs = db->pVfs;
  1206.     int needSync = 0;
  1207.     char *zMaster = 0;   /* File-name for the master journal */
  1208.     char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
  1209.     sqlite3_file *pMaster = 0;
  1210.     i64 offset = 0;
  1211.     /* Select a master journal file name */
  1212.     do {
  1213.       u32 random;
  1214.       sqlite3_free(zMaster);
  1215.       sqlite3_randomness(sizeof(random), &random);
  1216.       zMaster = sqlite3MPrintf(db, "%s-mj%08X", zMainFile, random&0x7fffffff);
  1217.       if( !zMaster ){
  1218.         return SQLITE_NOMEM;
  1219.       }
  1220.       rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS);
  1221.     }while( rc==1 );
  1222.     if( rc!=0 ){
  1223.       rc = SQLITE_IOERR_NOMEM;
  1224.     }else{
  1225.       /* Open the master journal. */
  1226.       rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster, 
  1227.           SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
  1228.           SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
  1229.       );
  1230.     }
  1231.     if( rc!=SQLITE_OK ){
  1232.       sqlite3_free(zMaster);
  1233.       return rc;
  1234.     }
  1235.  
  1236.     /* Write the name of each database file in the transaction into the new
  1237.     ** master journal file. If an error occurs at this point close
  1238.     ** and delete the master journal file. All the individual journal files
  1239.     ** still have 'null' as the master journal pointer, so they will roll
  1240.     ** back independently if a failure occurs.
  1241.     */
  1242.     for(i=0; i<db->nDb; i++){
  1243.       Btree *pBt = db->aDb[i].pBt;
  1244.       if( i==1 ) continue;   /* Ignore the TEMP database */
  1245.       if( sqlite3BtreeIsInTrans(pBt) ){
  1246.         char const *zFile = sqlite3BtreeGetJournalname(pBt);
  1247.         if( zFile[0]==0 ) continue;  /* Ignore :memory: databases */
  1248.         if( !needSync && !sqlite3BtreeSyncDisabled(pBt) ){
  1249.           needSync = 1;
  1250.         }
  1251.         rc = sqlite3OsWrite(pMaster, zFile, strlen(zFile)+1, offset);
  1252.         offset += strlen(zFile)+1;
  1253.         if( rc!=SQLITE_OK ){
  1254.           sqlite3OsCloseFree(pMaster);
  1255.           sqlite3OsDelete(pVfs, zMaster, 0);
  1256.           sqlite3_free(zMaster);
  1257.           return rc;
  1258.         }
  1259.       }
  1260.     }
  1261.     /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
  1262.     ** flag is set this is not required.
  1263.     */
  1264.     zMainFile = sqlite3BtreeGetDirname(db->aDb[0].pBt);
  1265.     if( (needSync 
  1266.      && (0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL))
  1267.      && (rc=sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))!=SQLITE_OK) ){
  1268.       sqlite3OsCloseFree(pMaster);
  1269.       sqlite3OsDelete(pVfs, zMaster, 0);
  1270.       sqlite3_free(zMaster);
  1271.       return rc;
  1272.     }
  1273.     /* Sync all the db files involved in the transaction. The same call
  1274.     ** sets the master journal pointer in each individual journal. If
  1275.     ** an error occurs here, do not delete the master journal file.
  1276.     **
  1277.     ** If the error occurs during the first call to
  1278.     ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
  1279.     ** master journal file will be orphaned. But we cannot delete it,
  1280.     ** in case the master journal file name was written into the journal
  1281.     ** file before the failure occured.
  1282.     */
  1283.     for(i=0; rc==SQLITE_OK && i<db->nDb; i++){ 
  1284.       Btree *pBt = db->aDb[i].pBt;
  1285.       if( pBt ){
  1286.         rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
  1287.       }
  1288.     }
  1289.     sqlite3OsCloseFree(pMaster);
  1290.     if( rc!=SQLITE_OK ){
  1291.       sqlite3_free(zMaster);
  1292.       return rc;
  1293.     }
  1294.     /* Delete the master journal file. This commits the transaction. After
  1295.     ** doing this the directory is synced again before any individual
  1296.     ** transaction files are deleted.
  1297.     */
  1298.     rc = sqlite3OsDelete(pVfs, zMaster, 1);
  1299.     sqlite3_free(zMaster);
  1300.     zMaster = 0;
  1301.     if( rc ){
  1302.       return rc;
  1303.     }
  1304.     /* All files and directories have already been synced, so the following
  1305.     ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
  1306.     ** deleting or truncating journals. If something goes wrong while
  1307.     ** this is happening we don't really care. The integrity of the
  1308.     ** transaction is already guaranteed, but some stray 'cold' journals
  1309.     ** may be lying around. Returning an error code won't help matters.
  1310.     */
  1311.     disable_simulated_io_errors();
  1312.     for(i=0; i<db->nDb; i++){ 
  1313.       Btree *pBt = db->aDb[i].pBt;
  1314.       if( pBt ){
  1315.         sqlite3BtreeCommitPhaseTwo(pBt);
  1316.       }
  1317.     }
  1318.     enable_simulated_io_errors();
  1319.     sqlite3VtabCommit(db);
  1320.   }
  1321. #endif
  1322.   return rc;
  1323. }
  1324. /* 
  1325. ** This routine checks that the sqlite3.activeVdbeCnt count variable
  1326. ** matches the number of vdbe's in the list sqlite3.pVdbe that are
  1327. ** currently active. An assertion fails if the two counts do not match.
  1328. ** This is an internal self-check only - it is not an essential processing
  1329. ** step.
  1330. **
  1331. ** This is a no-op if NDEBUG is defined.
  1332. */
  1333. #ifndef NDEBUG
  1334. static void checkActiveVdbeCnt(sqlite3 *db){
  1335.   Vdbe *p;
  1336.   int cnt = 0;
  1337.   p = db->pVdbe;
  1338.   while( p ){
  1339.     if( p->magic==VDBE_MAGIC_RUN && p->pc>=0 ){
  1340.       cnt++;
  1341.     }
  1342.     p = p->pNext;
  1343.   }
  1344.   assert( cnt==db->activeVdbeCnt );
  1345. }
  1346. #else
  1347. #define checkActiveVdbeCnt(x)
  1348. #endif
  1349. /*
  1350. ** For every Btree that in database connection db which 
  1351. ** has been modified, "trip" or invalidate each cursor in
  1352. ** that Btree might have been modified so that the cursor
  1353. ** can never be used again.  This happens when a rollback
  1354. *** occurs.  We have to trip all the other cursors, even
  1355. ** cursor from other VMs in different database connections,
  1356. ** so that none of them try to use the data at which they
  1357. ** were pointing and which now may have been changed due
  1358. ** to the rollback.
  1359. **
  1360. ** Remember that a rollback can delete tables complete and
  1361. ** reorder rootpages.  So it is not sufficient just to save
  1362. ** the state of the cursor.  We have to invalidate the cursor
  1363. ** so that it is never used again.
  1364. */
  1365. static void invalidateCursorsOnModifiedBtrees(sqlite3 *db){
  1366.   int i;
  1367.   for(i=0; i<db->nDb; i++){
  1368.     Btree *p = db->aDb[i].pBt;
  1369.     if( p && sqlite3BtreeIsInTrans(p) ){
  1370.       sqlite3BtreeTripAllCursors(p, SQLITE_ABORT);
  1371.     }
  1372.   }
  1373. }
  1374. /*
  1375. ** This routine is called the when a VDBE tries to halt.  If the VDBE
  1376. ** has made changes and is in autocommit mode, then commit those
  1377. ** changes.  If a rollback is needed, then do the rollback.
  1378. **
  1379. ** This routine is the only way to move the state of a VM from
  1380. ** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT.  It is harmless to
  1381. ** call this on a VM that is in the SQLITE_MAGIC_HALT state.
  1382. **
  1383. ** Return an error code.  If the commit could not complete because of
  1384. ** lock contention, return SQLITE_BUSY.  If SQLITE_BUSY is returned, it
  1385. ** means the close did not happen and needs to be repeated.
  1386. */
  1387. int sqlite3VdbeHalt(Vdbe *p){
  1388.   sqlite3 *db = p->db;
  1389.   int i;
  1390.   int (*xFunc)(Btree *pBt) = 0;  /* Function to call on each btree backend */
  1391.   int isSpecialError;            /* Set to true if SQLITE_NOMEM or IOERR */
  1392.   /* This function contains the logic that determines if a statement or
  1393.   ** transaction will be committed or rolled back as a result of the
  1394.   ** execution of this virtual machine. 
  1395.   **
  1396.   ** If any of the following errors occur:
  1397.   **
  1398.   **     SQLITE_NOMEM
  1399.   **     SQLITE_IOERR
  1400.   **     SQLITE_FULL
  1401.   **     SQLITE_INTERRUPT
  1402.   **
  1403.   ** Then the internal cache might have been left in an inconsistent
  1404.   ** state.  We need to rollback the statement transaction, if there is
  1405.   ** one, or the complete transaction if there is no statement transaction.
  1406.   */
  1407.   if( p->db->mallocFailed ){
  1408.     p->rc = SQLITE_NOMEM;
  1409.   }
  1410.   closeAllCursorsExceptActiveVtabs(p);
  1411.   if( p->magic!=VDBE_MAGIC_RUN ){
  1412.     return SQLITE_OK;
  1413.   }
  1414.   checkActiveVdbeCnt(db);
  1415.   /* No commit or rollback needed if the program never started */
  1416.   if( p->pc>=0 ){
  1417.     int mrc;   /* Primary error code from p->rc */
  1418.     /* Lock all btrees used by the statement */
  1419.     sqlite3BtreeMutexArrayEnter(&p->aMutex);
  1420.     /* Check for one of the special errors */
  1421.     mrc = p->rc & 0xff;
  1422.     isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
  1423.                      || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
  1424.     if( isSpecialError ){
  1425.       /* This loop does static analysis of the query to see which of the
  1426.       ** following three categories it falls into:
  1427.       **
  1428.       **     Read-only
  1429.       **     Query with statement journal
  1430.       **     Query without statement journal
  1431.       **
  1432.       ** We could do something more elegant than this static analysis (i.e.
  1433.       ** store the type of query as part of the compliation phase), but 
  1434.       ** handling malloc() or IO failure is a fairly obscure edge case so 
  1435.       ** this is probably easier. Todo: Might be an opportunity to reduce 
  1436.       ** code size a very small amount though...
  1437.       */
  1438.       int notReadOnly = 0;
  1439.       int isStatement = 0;
  1440.       assert(p->aOp || p->nOp==0);
  1441.       for(i=0; i<p->nOp; i++){ 
  1442.         switch( p->aOp[i].opcode ){
  1443.           case OP_Transaction:
  1444.             notReadOnly |= p->aOp[i].p2;
  1445.             break;
  1446.           case OP_Statement:
  1447.             isStatement = 1;
  1448.             break;
  1449.         }
  1450.       }
  1451.    
  1452.       /* If the query was read-only, we need do no rollback at all. Otherwise,
  1453.       ** proceed with the special handling.
  1454.       */
  1455.       if( notReadOnly || mrc!=SQLITE_INTERRUPT ){
  1456.         if( p->rc==SQLITE_IOERR_BLOCKED && isStatement ){
  1457.           xFunc = sqlite3BtreeRollbackStmt;
  1458.           p->rc = SQLITE_BUSY;
  1459.         } else if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && isStatement ){
  1460.           xFunc = sqlite3BtreeRollbackStmt;
  1461.         }else{
  1462.           /* We are forced to roll back the active transaction. Before doing
  1463.           ** so, abort any other statements this handle currently has active.
  1464.           */
  1465.           invalidateCursorsOnModifiedBtrees(db);
  1466.           sqlite3RollbackAll(db);
  1467.           db->autoCommit = 1;
  1468.         }
  1469.       }
  1470.     }
  1471.   
  1472.     /* If the auto-commit flag is set and this is the only active vdbe, then
  1473.     ** we do either a commit or rollback of the current transaction. 
  1474.     **
  1475.     ** Note: This block also runs if one of the special errors handled 
  1476.     ** above has occured. 
  1477.     */
  1478.     if( db->autoCommit && db->activeVdbeCnt==1 ){
  1479.       if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
  1480.         /* The auto-commit flag is true, and the vdbe program was 
  1481.         ** successful or hit an 'OR FAIL' constraint. This means a commit 
  1482.         ** is required.
  1483.         */
  1484.         int rc = vdbeCommit(db);
  1485.         if( rc==SQLITE_BUSY ){
  1486.           sqlite3BtreeMutexArrayLeave(&p->aMutex);
  1487.           return SQLITE_BUSY;
  1488.         }else if( rc!=SQLITE_OK ){
  1489.           p->rc = rc;
  1490.           sqlite3RollbackAll(db);
  1491.         }else{
  1492.           sqlite3CommitInternalChanges(db);
  1493.         }
  1494.       }else{
  1495.         sqlite3RollbackAll(db);
  1496.       }
  1497.     }else if( !xFunc ){
  1498.       if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
  1499.         if( p->openedStatement ){
  1500.           xFunc = sqlite3BtreeCommitStmt;
  1501.         } 
  1502.       }else if( p->errorAction==OE_Abort ){
  1503.         xFunc = sqlite3BtreeRollbackStmt;
  1504.       }else{
  1505.         invalidateCursorsOnModifiedBtrees(db);
  1506.         sqlite3RollbackAll(db);
  1507.         db->autoCommit = 1;
  1508.       }
  1509.     }
  1510.   
  1511.     /* If xFunc is not NULL, then it is one of sqlite3BtreeRollbackStmt or
  1512.     ** sqlite3BtreeCommitStmt. Call it once on each backend. If an error occurs
  1513.     ** and the return code is still SQLITE_OK, set the return code to the new
  1514.     ** error value.
  1515.     */
  1516.     assert(!xFunc ||
  1517.       xFunc==sqlite3BtreeCommitStmt ||
  1518.       xFunc==sqlite3BtreeRollbackStmt
  1519.     );
  1520.     for(i=0; xFunc && i<db->nDb; i++){ 
  1521.       int rc;
  1522.       Btree *pBt = db->aDb[i].pBt;
  1523.       if( pBt ){
  1524.         rc = xFunc(pBt);
  1525.         if( rc && (p->rc==SQLITE_OK || p->rc==SQLITE_CONSTRAINT) ){
  1526.           p->rc = rc;
  1527.           sqlite3SetString(&p->zErrMsg, 0);
  1528.         }
  1529.       }
  1530.     }
  1531.   
  1532.     /* If this was an INSERT, UPDATE or DELETE and the statement was committed, 
  1533.     ** set the change counter. 
  1534.     */
  1535.     if( p->changeCntOn && p->pc>=0 ){
  1536.       if( !xFunc || xFunc==sqlite3BtreeCommitStmt ){
  1537.         sqlite3VdbeSetChanges(db, p->nChange);
  1538.       }else{
  1539.         sqlite3VdbeSetChanges(db, 0);
  1540.       }
  1541.       p->nChange = 0;
  1542.     }
  1543.   
  1544.     /* Rollback or commit any schema changes that occurred. */
  1545.     if( p->rc!=SQLITE_OK && db->flags&SQLITE_InternChanges ){
  1546.       sqlite3ResetInternalSchema(db, 0);
  1547.       db->flags = (db->flags | SQLITE_InternChanges);
  1548.     }
  1549.     /* Release the locks */
  1550.     sqlite3BtreeMutexArrayLeave(&p->aMutex);
  1551.   }
  1552.   /* We have successfully halted and closed the VM.  Record this fact. */
  1553.   if( p->pc>=0 ){
  1554.     db->activeVdbeCnt--;
  1555.   }
  1556.   p->magic = VDBE_MAGIC_HALT;
  1557.   checkActiveVdbeCnt(db);
  1558.   if( p->db->mallocFailed ){
  1559.     p->rc = SQLITE_NOMEM;
  1560.   }
  1561.   checkActiveVdbeCnt(db);
  1562.   return SQLITE_OK;
  1563. }
  1564. /*
  1565. ** Each VDBE holds the result of the most recent sqlite3_step() call
  1566. ** in p->rc.  This routine sets that result back to SQLITE_OK.
  1567. */
  1568. void sqlite3VdbeResetStepResult(Vdbe *p){
  1569.   p->rc = SQLITE_OK;
  1570. }
  1571. /*
  1572. ** Clean up a VDBE after execution but do not delete the VDBE just yet.
  1573. ** Write any error messages into *pzErrMsg.  Return the result code.
  1574. **
  1575. ** After this routine is run, the VDBE should be ready to be executed
  1576. ** again.
  1577. **
  1578. ** To look at it another way, this routine resets the state of the
  1579. ** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
  1580. ** VDBE_MAGIC_INIT.
  1581. */
  1582. int sqlite3VdbeReset(Vdbe *p, int freebuffers){
  1583.   sqlite3 *db;
  1584.   db = p->db;
  1585.   /* If the VM did not run to completion or if it encountered an
  1586.   ** error, then it might not have been halted properly.  So halt
  1587.   ** it now.
  1588.   */
  1589.   (void)sqlite3SafetyOn(db);
  1590.   sqlite3VdbeHalt(p);
  1591.   (void)sqlite3SafetyOff(db);
  1592.   /* If the VDBE has be run even partially, then transfer the error code
  1593.   ** and error message from the VDBE into the main database structure.  But
  1594.   ** if the VDBE has just been set to run but has not actually executed any
  1595.   ** instructions yet, leave the main database error information unchanged.
  1596.   */
  1597.   if( p->pc>=0 ){
  1598.     if( p->zErrMsg ){
  1599.       sqlite3ValueSetStr(db->pErr,-1,p->zErrMsg,SQLITE_UTF8,sqlite3_free);
  1600.       db->errCode = p->rc;
  1601.       p->zErrMsg = 0;
  1602.     }else if( p->rc ){
  1603.       sqlite3Error(db, p->rc, 0);
  1604.     }else{
  1605.       sqlite3Error(db, SQLITE_OK, 0);
  1606.     }
  1607.   }else if( p->rc && p->expired ){
  1608.     /* The expired flag was set on the VDBE before the first call
  1609.     ** to sqlite3_step(). For consistency (since sqlite3_step() was
  1610.     ** called), set the database error in this case as well.
  1611.     */
  1612.     sqlite3Error(db, p->rc, 0);
  1613.     sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, sqlite3_free);
  1614.     p->zErrMsg = 0;
  1615.   }
  1616.   /* Reclaim all memory used by the VDBE
  1617.   */
  1618.   Cleanup(p, freebuffers);
  1619.   /* Save profiling information from this VDBE run.
  1620.   */
  1621. #ifdef VDBE_PROFILE
  1622.   {
  1623.     FILE *out = fopen("vdbe_profile.out", "a");
  1624.     if( out ){
  1625.       int i;
  1626.       fprintf(out, "---- ");
  1627.       for(i=0; i<p->nOp; i++){
  1628.         fprintf(out, "%02x", p->aOp[i].opcode);
  1629.       }
  1630.       fprintf(out, "n");
  1631.       for(i=0; i<p->nOp; i++){
  1632.         fprintf(out, "%6d %10lld %8lld ",
  1633.            p->aOp[i].cnt,
  1634.            p->aOp[i].cycles,
  1635.            p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
  1636.         );
  1637.         sqlite3VdbePrintOp(out, i, &p->aOp[i]);
  1638.       }
  1639.       fclose(out);
  1640.     }
  1641.   }
  1642. #endif
  1643.   p->magic = VDBE_MAGIC_INIT;
  1644.   p->aborted = 0;
  1645.   return p->rc & db->errMask;
  1646. }
  1647.  
  1648. /*
  1649. ** Clean up and delete a VDBE after execution.  Return an integer which is
  1650. ** the result code.  Write any error message text into *pzErrMsg.
  1651. */
  1652. int sqlite3VdbeFinalize(Vdbe *p){
  1653.   int rc = SQLITE_OK;
  1654.   if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
  1655.     rc = sqlite3VdbeReset(p, 1);
  1656.     assert( (rc & p->db->errMask)==rc );
  1657.   }else if( p->magic!=VDBE_MAGIC_INIT ){
  1658.     return SQLITE_MISUSE;
  1659.   }
  1660.   releaseMemArray(&p->aMem[1], p->nMem, 1);
  1661.   sqlite3VdbeDelete(p);
  1662.   return rc;
  1663. }
  1664. /*
  1665. ** Call the destructor for each auxdata entry in pVdbeFunc for which
  1666. ** the corresponding bit in mask is clear.  Auxdata entries beyond 31
  1667. ** are always destroyed.  To destroy all auxdata entries, call this
  1668. ** routine with mask==0.
  1669. */
  1670. void sqlite3VdbeDeleteAuxData(VdbeFunc *pVdbeFunc, int mask){
  1671.   int i;
  1672.   for(i=0; i<pVdbeFunc->nAux; i++){
  1673.     struct AuxData *pAux = &pVdbeFunc->apAux[i];
  1674.     if( (i>31 || !(mask&(1<<i))) && pAux->pAux ){
  1675.       if( pAux->xDelete ){
  1676.         pAux->xDelete(pAux->pAux);
  1677.       }
  1678.       pAux->pAux = 0;
  1679.     }
  1680.   }
  1681. }
  1682. /*
  1683. ** Delete an entire VDBE.
  1684. */
  1685. void sqlite3VdbeDelete(Vdbe *p){
  1686.   int i;
  1687.   if( p==0 ) return;
  1688.   Cleanup(p, 1);
  1689.   if( p->pPrev ){
  1690.     p->pPrev->pNext = p->pNext;
  1691.   }else{
  1692.     assert( p->db->pVdbe==p );
  1693.     p->db->pVdbe = p->pNext;
  1694.   }
  1695.   if( p->pNext ){
  1696.     p->pNext->pPrev = p->pPrev;
  1697.   }
  1698.   if( p->aOp ){
  1699.     Op *pOp = p->aOp;
  1700.     for(i=0; i<p->nOp; i++, pOp++){
  1701.       freeP4(pOp->p4type, pOp->p4.p);
  1702. #ifdef SQLITE_DEBUG
  1703.       sqlite3_free(pOp->zComment);
  1704. #endif     
  1705.     }
  1706.     sqlite3_free(p->aOp);
  1707.   }
  1708.   releaseMemArray(p->aVar, p->nVar, 1);
  1709.   sqlite3_free(p->aLabel);
  1710.   if( p->aMem ){
  1711.     sqlite3_free(&p->aMem[1]);
  1712.   }
  1713.   releaseMemArray(p->aColName, p->nResColumn*COLNAME_N, 1);
  1714.   sqlite3_free(p->aColName);
  1715.   sqlite3_free(p->zSql);
  1716.   p->magic = VDBE_MAGIC_DEAD;
  1717.   sqlite3_free(p);
  1718. }
  1719. /*
  1720. ** If a MoveTo operation is pending on the given cursor, then do that
  1721. ** MoveTo now.  Return an error code.  If no MoveTo is pending, this
  1722. ** routine does nothing and returns SQLITE_OK.
  1723. */
  1724. int sqlite3VdbeCursorMoveto(Cursor *p){
  1725.   if( p->deferredMoveto ){
  1726.     int res, rc;
  1727. #ifdef SQLITE_TEST
  1728.     extern int sqlite3_search_count;
  1729. #endif
  1730.     assert( p->isTable );
  1731.     rc = sqlite3BtreeMoveto(p->pCursor, 0, 0, p->movetoTarget, 0, &res);
  1732.     if( rc ) return rc;
  1733.     *p->pIncrKey = 0;
  1734.     p->lastRowid = keyToInt(p->movetoTarget);
  1735.     p->rowidIsValid = res==0;
  1736.     if( res<0 ){
  1737.       rc = sqlite3BtreeNext(p->pCursor, &res);
  1738.       if( rc ) return rc;
  1739.     }
  1740. #ifdef SQLITE_TEST
  1741.     sqlite3_search_count++;
  1742. #endif
  1743.     p->deferredMoveto = 0;
  1744.     p->cacheStatus = CACHE_STALE;
  1745.   }
  1746.   return SQLITE_OK;
  1747. }
  1748. /*
  1749. ** The following functions:
  1750. **
  1751. ** sqlite3VdbeSerialType()
  1752. ** sqlite3VdbeSerialTypeLen()
  1753. ** sqlite3VdbeSerialRead()
  1754. ** sqlite3VdbeSerialLen()
  1755. ** sqlite3VdbeSerialWrite()
  1756. **
  1757. ** encapsulate the code that serializes values for storage in SQLite
  1758. ** data and index records. Each serialized value consists of a
  1759. ** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
  1760. ** integer, stored as a varint.
  1761. **
  1762. ** In an SQLite index record, the serial type is stored directly before
  1763. ** the blob of data that it corresponds to. In a table record, all serial
  1764. ** types are stored at the start of the record, and the blobs of data at
  1765. ** the end. Hence these functions allow the caller to handle the
  1766. ** serial-type and data blob seperately.
  1767. **
  1768. ** The following table describes the various storage classes for data:
  1769. **
  1770. **   serial type        bytes of data      type
  1771. **   --------------     ---------------    ---------------
  1772. **      0                     0            NULL
  1773. **      1                     1            signed integer
  1774. **      2                     2            signed integer
  1775. **      3                     3            signed integer
  1776. **      4                     4            signed integer
  1777. **      5                     6            signed integer
  1778. **      6                     8            signed integer
  1779. **      7                     8            IEEE float
  1780. **      8                     0            Integer constant 0
  1781. **      9                     0            Integer constant 1
  1782. **     10,11                               reserved for expansion
  1783. **    N>=12 and even       (N-12)/2        BLOB
  1784. **    N>=13 and odd        (N-13)/2        text
  1785. **
  1786. ** The 8 and 9 types were added in 3.3.0, file format 4.  Prior versions
  1787. ** of SQLite will not understand those serial types.
  1788. */
  1789. /*
  1790. ** Return the serial-type for the value stored in pMem.
  1791. */
  1792. u32 sqlite3VdbeSerialType(Mem *pMem, int file_format){
  1793.   int flags = pMem->flags;
  1794.   int n;
  1795.   if( flags&MEM_Null ){
  1796.     return 0;
  1797.   }
  1798.   if( flags&MEM_Int ){
  1799.     /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
  1800. #   define MAX_6BYTE ((((i64)0x00001000)<<32)-1)
  1801.     i64 i = pMem->u.i;
  1802.     u64 u;
  1803.     if( file_format>=4 && (i&1)==i ){
  1804.       return 8+i;
  1805.     }
  1806.     u = i<0 ? -i : i;
  1807.     if( u<=127 ) return 1;
  1808.     if( u<=32767 ) return 2;
  1809.     if( u<=8388607 ) return 3;
  1810.     if( u<=2147483647 ) return 4;
  1811.     if( u<=MAX_6BYTE ) return 5;
  1812.     return 6;
  1813.   }
  1814.   if( flags&MEM_Real ){
  1815.     return 7;
  1816.   }
  1817.   assert( flags&(MEM_Str|MEM_Blob) );
  1818.   n = pMem->n;
  1819.   if( flags & MEM_Zero ){
  1820.     n += pMem->u.i;
  1821.   }
  1822.   assert( n>=0 );
  1823.   return ((n*2) + 12 + ((flags&MEM_Str)!=0));
  1824. }
  1825. /*
  1826. ** Return the length of the data corresponding to the supplied serial-type.
  1827. */
  1828. int sqlite3VdbeSerialTypeLen(u32 serial_type){
  1829.   if( serial_type>=12 ){
  1830.     return (serial_type-12)/2;
  1831.   }else{
  1832.     static const u8 aSize[] = { 0, 1, 2, 3, 4, 6, 8, 8, 0, 0, 0, 0 };
  1833.     return aSize[serial_type];
  1834.   }
  1835. }
  1836. /*
  1837. ** If we are on an architecture with mixed-endian floating 
  1838. ** points (ex: ARM7) then swap the lower 4 bytes with the 
  1839. ** upper 4 bytes.  Return the result.
  1840. **
  1841. ** For most architectures, this is a no-op.
  1842. **
  1843. ** (later):  It is reported to me that the mixed-endian problem
  1844. ** on ARM7 is an issue with GCC, not with the ARM7 chip.  It seems
  1845. ** that early versions of GCC stored the two words of a 64-bit
  1846. ** float in the wrong order.  And that error has been propagated
  1847. ** ever since.  The blame is not necessarily with GCC, though.
  1848. ** GCC might have just copying the problem from a prior compiler.
  1849. ** I am also told that newer versions of GCC that follow a different
  1850. ** ABI get the byte order right.
  1851. **
  1852. ** Developers using SQLite on an ARM7 should compile and run their
  1853. ** application using -DSQLITE_DEBUG=1 at least once.  With DEBUG
  1854. ** enabled, some asserts below will ensure that the byte order of
  1855. ** floating point values is correct.
  1856. **
  1857. ** (2007-08-30)  Frank van Vugt has studied this problem closely
  1858. ** and has send his findings to the SQLite developers.  Frank
  1859. ** writes that some Linux kernels offer floating point hardware
  1860. ** emulation that uses only 32-bit mantissas instead of a full 
  1861. ** 48-bits as required by the IEEE standard.  (This is the
  1862. ** CONFIG_FPE_FASTFPE option.)  On such systems, floating point
  1863. ** byte swapping becomes very complicated.  To avoid problems,
  1864. ** the necessary byte swapping is carried out using a 64-bit integer
  1865. ** rather than a 64-bit float.  Frank assures us that the code here
  1866. ** works for him.  We, the developers, have no way to independently
  1867. ** verify this, but Frank seems to know what he is talking about
  1868. ** so we trust him.
  1869. */
  1870. #ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  1871. static u64 floatSwap(u64 in){
  1872.   union {
  1873.     u64 r;
  1874.     u32 i[2];
  1875.   } u;
  1876.   u32 t;
  1877.   u.r = in;
  1878.   t = u.i[0];
  1879.   u.i[0] = u.i[1];
  1880.   u.i[1] = t;
  1881.   return u.r;
  1882. }
  1883. # define swapMixedEndianFloat(X)  X = floatSwap(X)
  1884. #else
  1885. # define swapMixedEndianFloat(X)
  1886. #endif
  1887. /*
  1888. ** Write the serialized data blob for the value stored in pMem into 
  1889. ** buf. It is assumed that the caller has allocated sufficient space.
  1890. ** Return the number of bytes written.
  1891. **
  1892. ** nBuf is the amount of space left in buf[].  nBuf must always be
  1893. ** large enough to hold the entire field.  Except, if the field is
  1894. ** a blob with a zero-filled tail, then buf[] might be just the right
  1895. ** size to hold everything except for the zero-filled tail.  If buf[]
  1896. ** is only big enough to hold the non-zero prefix, then only write that
  1897. ** prefix into buf[].  But if buf[] is large enough to hold both the
  1898. ** prefix and the tail then write the prefix and set the tail to all
  1899. ** zeros.
  1900. **
  1901. ** Return the number of bytes actually written into buf[].  The number
  1902. ** of bytes in the zero-filled tail is included in the return value only
  1903. ** if those bytes were zeroed in buf[].
  1904. */ 
  1905. int sqlite3VdbeSerialPut(u8 *buf, int nBuf, Mem *pMem, int file_format){
  1906.   u32 serial_type = sqlite3VdbeSerialType(pMem, file_format);
  1907.   int len;
  1908.   /* Integer and Real */
  1909.   if( serial_type<=7 && serial_type>0 ){
  1910.     u64 v;
  1911.     int i;
  1912.     if( serial_type==7 ){
  1913.       assert( sizeof(v)==sizeof(pMem->r) );
  1914.       memcpy(&v, &pMem->r, sizeof(v));
  1915.       swapMixedEndianFloat(v);
  1916.     }else{
  1917.       v = pMem->u.i;
  1918.     }
  1919.     len = i = sqlite3VdbeSerialTypeLen(serial_type);
  1920.     assert( len<=nBuf );
  1921.     while( i-- ){
  1922.       buf[i] = (v&0xFF);
  1923.       v >>= 8;
  1924.     }
  1925.     return len;
  1926.   }
  1927.   /* String or blob */
  1928.   if( serial_type>=12 ){
  1929.     assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.i:0)
  1930.              == sqlite3VdbeSerialTypeLen(serial_type) );
  1931.     assert( pMem->n<=nBuf );
  1932.     len = pMem->n;
  1933.     memcpy(buf, pMem->z, len);
  1934.     if( pMem->flags & MEM_Zero ){
  1935.       len += pMem->u.i;
  1936.       if( len>nBuf ){
  1937.         len = nBuf;
  1938.       }
  1939.       memset(&buf[pMem->n], 0, len-pMem->n);
  1940.     }
  1941.     return len;
  1942.   }
  1943.   /* NULL or constants 0 or 1 */
  1944.   return 0;
  1945. }
  1946. /*
  1947. ** Deserialize the data blob pointed to by buf as serial type serial_type
  1948. ** and store the result in pMem.  Return the number of bytes read.
  1949. */ 
  1950. int sqlite3VdbeSerialGet(
  1951.   const unsigned char *buf,     /* Buffer to deserialize from */
  1952.   u32 serial_type,              /* Serial type to deserialize */
  1953.   Mem *pMem                     /* Memory cell to write value into */
  1954. ){
  1955.   switch( serial_type ){
  1956.     case 10:   /* Reserved for future use */
  1957.     case 11:   /* Reserved for future use */
  1958.     case 0: {  /* NULL */
  1959.       pMem->flags = MEM_Null;
  1960.       break;
  1961.     }
  1962.     case 1: { /* 1-byte signed integer */
  1963.       pMem->u.i = (signed char)buf[0];
  1964.       pMem->flags = MEM_Int;
  1965.       return 1;
  1966.     }
  1967.     case 2: { /* 2-byte signed integer */
  1968.       pMem->u.i = (((signed char)buf[0])<<8) | buf[1];
  1969.       pMem->flags = MEM_Int;
  1970.       return 2;
  1971.     }
  1972.     case 3: { /* 3-byte signed integer */
  1973.       pMem->u.i = (((signed char)buf[0])<<16) | (buf[1]<<8) | buf[2];
  1974.       pMem->flags = MEM_Int;
  1975.       return 3;
  1976.     }
  1977.     case 4: { /* 4-byte signed integer */
  1978.       pMem->u.i = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
  1979.       pMem->flags = MEM_Int;
  1980.       return 4;
  1981.     }
  1982.     case 5: { /* 6-byte signed integer */
  1983.       u64 x = (((signed char)buf[0])<<8) | buf[1];
  1984.       u32 y = (buf[2]<<24) | (buf[3]<<16) | (buf[4]<<8) | buf[5];
  1985.       x = (x<<32) | y;
  1986.       pMem->u.i = *(i64*)&x;
  1987.       pMem->flags = MEM_Int;
  1988.       return 6;
  1989.     }
  1990.     case 6:   /* 8-byte signed integer */
  1991.     case 7: { /* IEEE floating point */
  1992.       u64 x;
  1993.       u32 y;
  1994. #if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
  1995.       /* Verify that integers and floating point values use the same
  1996.       ** byte order.  Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
  1997.       ** defined that 64-bit floating point values really are mixed
  1998.       ** endian.
  1999.       */
  2000.       static const u64 t1 = ((u64)0x3ff00000)<<32;
  2001.       static const double r1 = 1.0;
  2002.       u64 t2 = t1;
  2003.       swapMixedEndianFloat(t2);
  2004.       assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
  2005. #endif
  2006.       x = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
  2007.       y = (buf[4]<<24) | (buf[5]<<16) | (buf[6]<<8) | buf[7];
  2008.       x = (x<<32) | y;
  2009.       if( serial_type==6 ){
  2010.         pMem->u.i = *(i64*)&x;
  2011.         pMem->flags = MEM_Int;
  2012.       }else{
  2013.         assert( sizeof(x)==8 && sizeof(pMem->r)==8 );
  2014.         swapMixedEndianFloat(x);
  2015.         memcpy(&pMem->r, &x, sizeof(x));
  2016.         pMem->flags = MEM_Real;
  2017.       }
  2018.       return 8;
  2019.     }
  2020.     case 8:    /* Integer 0 */
  2021.     case 9: {  /* Integer 1 */
  2022.       pMem->u.i = serial_type-8;
  2023.       pMem->flags = MEM_Int;
  2024.       return 0;
  2025.     }
  2026.     default: {
  2027.       int len = (serial_type-12)/2;
  2028.       pMem->z = (char *)buf;
  2029.       pMem->n = len;
  2030.       pMem->xDel = 0;
  2031.       if( serial_type&0x01 ){
  2032.         pMem->flags = MEM_Str | MEM_Ephem;
  2033.       }else{
  2034.         pMem->flags = MEM_Blob | MEM_Ephem;
  2035.       }
  2036.       return len;
  2037.     }
  2038.   }
  2039.   return 0;
  2040. }
  2041. /*
  2042. ** The header of a record consists of a sequence variable-length integers.
  2043. ** These integers are almost always small and are encoded as a single byte.
  2044. ** The following macro takes advantage this fact to provide a fast decode
  2045. ** of the integers in a record header.  It is faster for the common case
  2046. ** where the integer is a single byte.  It is a little slower when the
  2047. ** integer is two or more bytes.  But overall it is faster.
  2048. **
  2049. ** The following expressions are equivalent:
  2050. **
  2051. **     x = sqlite3GetVarint32( A, &B );
  2052. **
  2053. **     x = GetVarint( A, B );
  2054. **
  2055. */
  2056. #define GetVarint(A,B)  ((B = *(A))<=0x7f ? 1 : sqlite3GetVarint32(A, &B))
  2057. /*
  2058. ** Given the nKey-byte encoding of a record in pKey[], parse the
  2059. ** record into a UnpackedRecord structure.  Return a pointer to
  2060. ** that structure.
  2061. **
  2062. ** The calling function might provide szSpace bytes of memory
  2063. ** space at pSpace.  This space can be used to hold the returned
  2064. ** VDbeParsedRecord structure if it is large enough.  If it is
  2065. ** not big enough, space is obtained from sqlite3_malloc().
  2066. **
  2067. ** The returned structure should be closed by a call to
  2068. ** sqlite3VdbeDeleteUnpackedRecord().
  2069. */ 
  2070. UnpackedRecord *sqlite3VdbeRecordUnpack(
  2071.   KeyInfo *pKeyInfo,     /* Information about the record format */
  2072.   int nKey,              /* Size of the binary record */
  2073.   const void *pKey,      /* The binary record */
  2074.   void *pSpace,          /* Space available to hold resulting object */
  2075.   int szSpace            /* Size of pSpace[] in bytes */
  2076. ){
  2077.   const unsigned char *aKey = (const unsigned char *)pKey;
  2078.   UnpackedRecord *p;
  2079.   int nByte;
  2080.   int i, idx, d;
  2081.   u32 szHdr;
  2082.   Mem *pMem;
  2083.   
  2084.   assert( sizeof(Mem)>sizeof(*p) );
  2085.   nByte = sizeof(Mem)*(pKeyInfo->nField+2);
  2086.   if( nByte>szSpace ){
  2087.     p = sqlite3DbMallocRaw(pKeyInfo->db, nByte);
  2088.     if( p==0 ) return 0;
  2089.     p->needFree = 1;
  2090.   }else{
  2091.     p = pSpace;
  2092.     p->needFree = 0;
  2093.   }
  2094.   p->pKeyInfo = pKeyInfo;
  2095.   p->nField = pKeyInfo->nField + 1;
  2096.   p->needDestroy = 1;
  2097.   p->aMem = pMem = &((Mem*)p)[1];
  2098.   idx = GetVarint(aKey, szHdr);
  2099.   d = szHdr;
  2100.   i = 0;
  2101.   while( idx<szHdr && i<p->nField ){
  2102.     u32 serial_type;
  2103.     idx += GetVarint( aKey+idx, serial_type);
  2104.     if( d>=nKey && sqlite3VdbeSerialTypeLen(serial_type)>0 ) break;
  2105.     pMem->enc = pKeyInfo->enc;
  2106.     pMem->db = pKeyInfo->db;
  2107.     pMem->flags = 0;
  2108.     pMem->zMalloc = 0;
  2109.     d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
  2110.     pMem++;
  2111.     i++;
  2112.   }
  2113.   p->nField = i;
  2114.   return (void*)p;
  2115. }
  2116. /*
  2117. ** This routine destroys a UnpackedRecord object
  2118. */
  2119. void sqlite3VdbeDeleteUnpackedRecord(UnpackedRecord *p){
  2120.   if( p ){
  2121.     if( p->needDestroy ){
  2122.       int i;
  2123.       Mem *pMem;
  2124.       for(i=0, pMem=p->aMem; i<p->nField; i++, pMem++){
  2125.         if( pMem->zMalloc ){
  2126.           sqlite3VdbeMemRelease(pMem);
  2127.         }
  2128.       }
  2129.     }
  2130.     if( p->needFree ){
  2131.       sqlite3_free(p);
  2132.     }
  2133.   }
  2134. }
  2135. /*
  2136. ** This function compares the two table rows or index records
  2137. ** specified by {nKey1, pKey1} and pPKey2.  It returns a negative, zero
  2138. ** or positive integer if {nKey1, pKey1} is less than, equal to or 
  2139. ** greater than pPKey2.  The {nKey1, pKey1} key must be a blob
  2140. ** created by th OP_MakeRecord opcode of the VDBE.  The pPKey2
  2141. ** key must be a parsed key such as obtained from
  2142. ** sqlite3VdbeParseRecord.
  2143. **
  2144. ** Key1 and Key2 do not have to contain the same number of fields.
  2145. ** But if the lengths differ, Key2 must be the shorter of the two.
  2146. **
  2147. ** Historical note: In earlier versions of this routine both Key1
  2148. ** and Key2 were blobs obtained from OP_MakeRecord.  But we found
  2149. ** that in typical use the same Key2 would be submitted multiple times
  2150. ** in a row.  So an optimization was added to parse the Key2 key
  2151. ** separately and submit the parsed version.  In this way, we avoid
  2152. ** parsing the same Key2 multiple times in a row.
  2153. */
  2154. int sqlite3VdbeRecordCompare(
  2155.   int nKey1, const void *pKey1, 
  2156.   UnpackedRecord *pPKey2
  2157. ){
  2158.   u32 d1;            /* Offset into aKey[] of next data element */
  2159.   u32 idx1;          /* Offset into aKey[] of next header element */
  2160.   u32 szHdr1;        /* Number of bytes in header */
  2161.   int i = 0;
  2162.   int nField;
  2163.   int rc = 0;
  2164.   const unsigned char *aKey1 = (const unsigned char *)pKey1;
  2165.   KeyInfo *pKeyInfo;
  2166.   Mem mem1;
  2167.   pKeyInfo = pPKey2->pKeyInfo;
  2168.   mem1.enc = pKeyInfo->enc;
  2169.   mem1.db = pKeyInfo->db;
  2170.   mem1.flags = 0;
  2171.   mem1.zMalloc = 0;
  2172.   
  2173.   idx1 = GetVarint(aKey1, szHdr1);
  2174.   d1 = szHdr1;
  2175.   nField = pKeyInfo->nField;
  2176.   while( idx1<szHdr1 && i<pPKey2->nField ){
  2177.     u32 serial_type1;
  2178.     /* Read the serial types for the next element in each key. */
  2179.     idx1 += GetVarint( aKey1+idx1, serial_type1 );
  2180.     if( d1>=nKey1 && sqlite3VdbeSerialTypeLen(serial_type1)>0 ) break;
  2181.     /* Extract the values to be compared.
  2182.     */
  2183.     d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
  2184.     /* Do the comparison
  2185.     */
  2186.     rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i],
  2187.                            i<nField ? pKeyInfo->aColl[i] : 0);
  2188.     if( rc!=0 ){
  2189.       break;
  2190.     }
  2191.     i++;
  2192.   }
  2193.   if( mem1.zMalloc ) sqlite3VdbeMemRelease(&mem1);
  2194.   /* One of the keys ran out of fields, but all the fields up to that point
  2195.   ** were equal. If the incrKey flag is true, then the second key is
  2196.   ** treated as larger.
  2197.   */
  2198.   if( rc==0 ){
  2199.     if( pKeyInfo->incrKey ){
  2200.       rc = -1;
  2201.     }else if( !pKeyInfo->prefixIsEqual ){
  2202.       if( d1<nKey1 ){
  2203.         rc = 1;
  2204.       }
  2205.     }
  2206.   }else if( pKeyInfo->aSortOrder && i<pKeyInfo->nField
  2207.                && pKeyInfo->aSortOrder[i] ){
  2208.     rc = -rc;
  2209.   }
  2210.   return rc;
  2211. }
  2212. /*
  2213. ** The argument is an index entry composed using the OP_MakeRecord opcode.
  2214. ** The last entry in this record should be an integer (specifically
  2215. ** an integer rowid).  This routine returns the number of bytes in
  2216. ** that integer.
  2217. */
  2218. int sqlite3VdbeIdxRowidLen(const u8 *aKey){
  2219.   u32 szHdr;        /* Size of the header */
  2220.   u32 typeRowid;    /* Serial type of the rowid */
  2221.   sqlite3GetVarint32(aKey, &szHdr);
  2222.   sqlite3GetVarint32(&aKey[szHdr-1], &typeRowid);
  2223.   return sqlite3VdbeSerialTypeLen(typeRowid);
  2224. }
  2225.   
  2226. /*
  2227. ** pCur points at an index entry created using the OP_MakeRecord opcode.
  2228. ** Read the rowid (the last field in the record) and store it in *rowid.
  2229. ** Return SQLITE_OK if everything works, or an error code otherwise.
  2230. */
  2231. int sqlite3VdbeIdxRowid(BtCursor *pCur, i64 *rowid){
  2232.   i64 nCellKey = 0;
  2233.   int rc;
  2234.   u32 szHdr;        /* Size of the header */
  2235.   u32 typeRowid;    /* Serial type of the rowid */
  2236.   u32 lenRowid;     /* Size of the rowid */
  2237.   Mem m, v;
  2238.   sqlite3BtreeKeySize(pCur, &nCellKey);
  2239.   if( nCellKey<=0 ){
  2240.     return SQLITE_CORRUPT_BKPT;
  2241.   }
  2242.   m.flags = 0;
  2243.   m.db = 0;
  2244.   m.zMalloc = 0;
  2245.   rc = sqlite3VdbeMemFromBtree(pCur, 0, nCellKey, 1, &m);
  2246.   if( rc ){
  2247.     return rc;
  2248.   }
  2249.   sqlite3GetVarint32((u8*)m.z, &szHdr);
  2250.   sqlite3GetVarint32((u8*)&m.z[szHdr-1], &typeRowid);
  2251.   lenRowid = sqlite3VdbeSerialTypeLen(typeRowid);
  2252.   sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
  2253.   *rowid = v.u.i;
  2254.   sqlite3VdbeMemRelease(&m);
  2255.   return SQLITE_OK;
  2256. }
  2257. /*
  2258. ** Compare the key of the index entry that cursor pC is point to against
  2259. ** the key string in pKey (of length nKey).  Write into *pRes a number
  2260. ** that is negative, zero, or positive if pC is less than, equal to,
  2261. ** or greater than pKey.  Return SQLITE_OK on success.
  2262. **
  2263. ** pKey is either created without a rowid or is truncated so that it
  2264. ** omits the rowid at the end.  The rowid at the end of the index entry
  2265. ** is ignored as well.
  2266. */
  2267. int sqlite3VdbeIdxKeyCompare(
  2268.   Cursor *pC,                 /* The cursor to compare against */
  2269.   int nKey, const u8 *pKey,   /* The key to compare */
  2270.   int *res                    /* Write the comparison result here */
  2271. ){
  2272.   i64 nCellKey = 0;
  2273.   int rc;
  2274.   BtCursor *pCur = pC->pCursor;
  2275.   int lenRowid;
  2276.   Mem m;
  2277.   UnpackedRecord *pRec;
  2278.   char zSpace[200];
  2279.   sqlite3BtreeKeySize(pCur, &nCellKey);
  2280.   if( nCellKey<=0 ){
  2281.     *res = 0;
  2282.     return SQLITE_OK;
  2283.   }
  2284.   m.db = 0;
  2285.   m.flags = 0;
  2286.   m.zMalloc = 0;
  2287.   rc = sqlite3VdbeMemFromBtree(pC->pCursor, 0, nCellKey, 1, &m);
  2288.   if( rc ){
  2289.     return rc;
  2290.   }
  2291.   lenRowid = sqlite3VdbeIdxRowidLen((u8*)m.z);
  2292.   pRec = sqlite3VdbeRecordUnpack(pC->pKeyInfo, nKey, pKey,
  2293.                                 zSpace, sizeof(zSpace));
  2294.   if( pRec==0 ){
  2295.     return SQLITE_NOMEM;
  2296.   }
  2297.   *res = sqlite3VdbeRecordCompare(m.n-lenRowid, m.z, pRec);
  2298.   sqlite3VdbeDeleteUnpackedRecord(pRec);
  2299.   sqlite3VdbeMemRelease(&m);
  2300.   return SQLITE_OK;
  2301. }
  2302. /*
  2303. ** This routine sets the value to be returned by subsequent calls to
  2304. ** sqlite3_changes() on the database handle 'db'. 
  2305. */
  2306. void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
  2307.   assert( sqlite3_mutex_held(db->mutex) );
  2308.   db->nChange = nChange;
  2309.   db->nTotalChange += nChange;
  2310. }
  2311. /*
  2312. ** Set a flag in the vdbe to update the change counter when it is finalised
  2313. ** or reset.
  2314. */
  2315. void sqlite3VdbeCountChanges(Vdbe *v){
  2316.   v->changeCntOn = 1;
  2317. }
  2318. /*
  2319. ** Mark every prepared statement associated with a database connection
  2320. ** as expired.
  2321. **
  2322. ** An expired statement means that recompilation of the statement is
  2323. ** recommend.  Statements expire when things happen that make their
  2324. ** programs obsolete.  Removing user-defined functions or collating
  2325. ** sequences, or changing an authorization function are the types of
  2326. ** things that make prepared statements obsolete.
  2327. */
  2328. void sqlite3ExpirePreparedStatements(sqlite3 *db){
  2329.   Vdbe *p;
  2330.   for(p = db->pVdbe; p; p=p->pNext){
  2331.     p->expired = 1;
  2332.   }
  2333. }
  2334. /*
  2335. ** Return the database associated with the Vdbe.
  2336. */
  2337. sqlite3 *sqlite3VdbeDb(Vdbe *v){
  2338.   return v->db;
  2339. }