xref: /sqlite-3.40.0/src/vdbe.c (revision 4249b3f5)
1 /*
2 ** 2001 September 15
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 ** The code in this file implements execution method of the
13 ** Virtual Database Engine (VDBE).  A separate file ("vdbeaux.c")
14 ** handles housekeeping details such as creating and deleting
15 ** VDBE instances.  This file is solely interested in executing
16 ** the VDBE program.
17 **
18 ** In the external interface, an "sqlite3_stmt*" is an opaque pointer
19 ** to a VDBE.
20 **
21 ** The SQL parser generates a program which is then executed by
22 ** the VDBE to do the work of the SQL statement.  VDBE programs are
23 ** similar in form to assembly language.  The program consists of
24 ** a linear sequence of operations.  Each operation has an opcode
25 ** and 5 operands.  Operands P1, P2, and P3 are integers.  Operand P4
26 ** is a null-terminated string.  Operand P5 is an unsigned character.
27 ** Few opcodes use all 5 operands.
28 **
29 ** Computation results are stored on a set of registers numbered beginning
30 ** with 1 and going up to Vdbe.nMem.  Each register can store
31 ** either an integer, a null-terminated string, a floating point
32 ** number, or the SQL "NULL" value.  An implicit conversion from one
33 ** type to the other occurs as necessary.
34 **
35 ** Most of the code in this file is taken up by the sqlite3VdbeExec()
36 ** function which does the work of interpreting a VDBE program.
37 ** But other routines are also provided to help in building up
38 ** a program instruction by instruction.
39 **
40 ** Various scripts scan this source file in order to generate HTML
41 ** documentation, headers files, or other derived files.  The formatting
42 ** of the code in this file is, therefore, important.  See other comments
43 ** in this file for details.  If in doubt, do not deviate from existing
44 ** commenting and indentation practices when changing or adding code.
45 **
46 ** $Id: vdbe.c,v 1.761 2008/07/11 21:02:54 drh Exp $
47 */
48 #include "sqliteInt.h"
49 #include <ctype.h>
50 #include "vdbeInt.h"
51 
52 /*
53 ** The following global variable is incremented every time a cursor
54 ** moves, either by the OP_MoveXX, OP_Next, or OP_Prev opcodes.  The test
55 ** procedures use this information to make sure that indices are
56 ** working correctly.  This variable has no function other than to
57 ** help verify the correct operation of the library.
58 */
59 #ifdef SQLITE_TEST
60 int sqlite3_search_count = 0;
61 #endif
62 
63 /*
64 ** When this global variable is positive, it gets decremented once before
65 ** each instruction in the VDBE.  When reaches zero, the u1.isInterrupted
66 ** field of the sqlite3 structure is set in order to simulate and interrupt.
67 **
68 ** This facility is used for testing purposes only.  It does not function
69 ** in an ordinary build.
70 */
71 #ifdef SQLITE_TEST
72 int sqlite3_interrupt_count = 0;
73 #endif
74 
75 /*
76 ** The next global variable is incremented each type the OP_Sort opcode
77 ** is executed.  The test procedures use this information to make sure that
78 ** sorting is occurring or not occurring at appropriate times.   This variable
79 ** has no function other than to help verify the correct operation of the
80 ** library.
81 */
82 #ifdef SQLITE_TEST
83 int sqlite3_sort_count = 0;
84 #endif
85 
86 /*
87 ** The next global variable records the size of the largest MEM_Blob
88 ** or MEM_Str that has been used by a VDBE opcode.  The test procedures
89 ** use this information to make sure that the zero-blob functionality
90 ** is working correctly.   This variable has no function other than to
91 ** help verify the correct operation of the library.
92 */
93 #ifdef SQLITE_TEST
94 int sqlite3_max_blobsize = 0;
95 static void updateMaxBlobsize(Mem *p){
96   if( (p->flags & (MEM_Str|MEM_Blob))!=0 && p->n>sqlite3_max_blobsize ){
97     sqlite3_max_blobsize = p->n;
98   }
99 }
100 #endif
101 
102 /*
103 ** Test a register to see if it exceeds the current maximum blob size.
104 ** If it does, record the new maximum blob size.
105 */
106 #if defined(SQLITE_TEST) && !defined(SQLITE_OMIT_BUILTIN_TEST)
107 # define UPDATE_MAX_BLOBSIZE(P)  updateMaxBlobsize(P)
108 #else
109 # define UPDATE_MAX_BLOBSIZE(P)
110 #endif
111 
112 /*
113 ** Release the memory associated with a register.  This
114 ** leaves the Mem.flags field in an inconsistent state.
115 */
116 #define Release(P) if((P)->flags&MEM_Dyn){ sqlite3VdbeMemRelease(P); }
117 
118 /*
119 ** Convert the given register into a string if it isn't one
120 ** already. Return non-zero if a malloc() fails.
121 */
122 #define Stringify(P, enc) \
123    if(((P)->flags&(MEM_Str|MEM_Blob))==0 && sqlite3VdbeMemStringify(P,enc)) \
124      { goto no_mem; }
125 
126 /*
127 ** An ephemeral string value (signified by the MEM_Ephem flag) contains
128 ** a pointer to a dynamically allocated string where some other entity
129 ** is responsible for deallocating that string.  Because the register
130 ** does not control the string, it might be deleted without the register
131 ** knowing it.
132 **
133 ** This routine converts an ephemeral string into a dynamically allocated
134 ** string that the register itself controls.  In other words, it
135 ** converts an MEM_Ephem string into an MEM_Dyn string.
136 */
137 #define Deephemeralize(P) \
138    if( ((P)->flags&MEM_Ephem)!=0 \
139        && sqlite3VdbeMemMakeWriteable(P) ){ goto no_mem;}
140 
141 /*
142 ** Call sqlite3VdbeMemExpandBlob() on the supplied value (type Mem*)
143 ** P if required.
144 */
145 #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
146 
147 /*
148 ** Argument pMem points at a register that will be passed to a
149 ** user-defined function or returned to the user as the result of a query.
150 ** The second argument, 'db_enc' is the text encoding used by the vdbe for
151 ** register variables.  This routine sets the pMem->enc and pMem->type
152 ** variables used by the sqlite3_value_*() routines.
153 */
154 #define storeTypeInfo(A,B) _storeTypeInfo(A)
155 static void _storeTypeInfo(Mem *pMem){
156   int flags = pMem->flags;
157   if( flags & MEM_Null ){
158     pMem->type = SQLITE_NULL;
159   }
160   else if( flags & MEM_Int ){
161     pMem->type = SQLITE_INTEGER;
162   }
163   else if( flags & MEM_Real ){
164     pMem->type = SQLITE_FLOAT;
165   }
166   else if( flags & MEM_Str ){
167     pMem->type = SQLITE_TEXT;
168   }else{
169     pMem->type = SQLITE_BLOB;
170   }
171 }
172 
173 /*
174 ** Properties of opcodes.  The OPFLG_INITIALIZER macro is
175 ** created by mkopcodeh.awk during compilation.  Data is obtained
176 ** from the comments following the "case OP_xxxx:" statements in
177 ** this file.
178 */
179 static unsigned char opcodeProperty[] = OPFLG_INITIALIZER;
180 
181 /*
182 ** Return true if an opcode has any of the OPFLG_xxx properties
183 ** specified by mask.
184 */
185 int sqlite3VdbeOpcodeHasProperty(int opcode, int mask){
186   assert( opcode>0 && opcode<sizeof(opcodeProperty) );
187   return (opcodeProperty[opcode]&mask)!=0;
188 }
189 
190 /*
191 ** Allocate cursor number iCur.  Return a pointer to it.  Return NULL
192 ** if we run out of memory.
193 */
194 static Cursor *allocateCursor(
195   Vdbe *p,
196   int iCur,
197   Op *pOp,
198   int iDb,
199   int isBtreeCursor
200 ){
201   /* Find the memory cell that will be used to store the blob of memory
202   ** required for this Cursor structure. It is convenient to use a
203   ** vdbe memory cell to manage the memory allocation required for a
204   ** Cursor structure for the following reasons:
205   **
206   **   * Sometimes cursor numbers are used for a couple of different
207   **     purposes in a vdbe program. The different uses might require
208   **     different sized allocations. Memory cells provide growable
209   **     allocations.
210   **
211   **   * When using ENABLE_MEMORY_MANAGEMENT, memory cell buffers can
212   **     be freed lazily via the sqlite3_release_memory() API. This
213   **     minimizes the number of malloc calls made by the system.
214   **
215   ** Memory cells for cursors are allocated at the top of the address
216   ** space. Memory cell (p->nMem) corresponds to cursor 0. Space for
217   ** cursor 1 is managed by memory cell (p->nMem-1), etc.
218   */
219   Mem *pMem = &p->aMem[p->nMem-iCur];
220 
221   int nByte;
222   Cursor *pCx = 0;
223   /* If the opcode of pOp is OP_SetNumColumns, then pOp->p2 contains
224   ** the number of fields in the records contained in the table or
225   ** index being opened. Use this to reserve space for the
226   ** Cursor.aType[] array.
227   */
228   int nField = 0;
229   if( pOp->opcode==OP_SetNumColumns || pOp->opcode==OP_OpenEphemeral ){
230     nField = pOp->p2;
231   }
232   nByte =
233       sizeof(Cursor) +
234       (isBtreeCursor?sqlite3BtreeCursorSize():0) +
235       2*nField*sizeof(u32);
236 
237   assert( iCur<p->nCursor );
238   if( p->apCsr[iCur] ){
239     sqlite3VdbeFreeCursor(p, p->apCsr[iCur]);
240     p->apCsr[iCur] = 0;
241   }
242   if( SQLITE_OK==sqlite3VdbeMemGrow(pMem, nByte, 0) ){
243     p->apCsr[iCur] = pCx = (Cursor *)pMem->z;
244     memset(pMem->z, 0, nByte);
245     pCx->iDb = iDb;
246     pCx->nField = nField;
247     if( nField ){
248       pCx->aType = (u32 *)&pMem->z[sizeof(Cursor)];
249     }
250     if( isBtreeCursor ){
251       pCx->pCursor = (BtCursor *)&pMem->z[sizeof(Cursor)+2*nField*sizeof(u32)];
252     }
253   }
254   return pCx;
255 }
256 
257 /*
258 ** Try to convert a value into a numeric representation if we can
259 ** do so without loss of information.  In other words, if the string
260 ** looks like a number, convert it into a number.  If it does not
261 ** look like a number, leave it alone.
262 */
263 static void applyNumericAffinity(Mem *pRec){
264   if( (pRec->flags & (MEM_Real|MEM_Int))==0 ){
265     int realnum;
266     sqlite3VdbeMemNulTerminate(pRec);
267     if( (pRec->flags&MEM_Str)
268          && sqlite3IsNumber(pRec->z, &realnum, pRec->enc) ){
269       i64 value;
270       sqlite3VdbeChangeEncoding(pRec, SQLITE_UTF8);
271       if( !realnum && sqlite3Atoi64(pRec->z, &value) ){
272         pRec->u.i = value;
273         MemSetTypeFlag(pRec, MEM_Int);
274       }else{
275         sqlite3VdbeMemRealify(pRec);
276       }
277     }
278   }
279 }
280 
281 /*
282 ** Processing is determine by the affinity parameter:
283 **
284 ** SQLITE_AFF_INTEGER:
285 ** SQLITE_AFF_REAL:
286 ** SQLITE_AFF_NUMERIC:
287 **    Try to convert pRec to an integer representation or a
288 **    floating-point representation if an integer representation
289 **    is not possible.  Note that the integer representation is
290 **    always preferred, even if the affinity is REAL, because
291 **    an integer representation is more space efficient on disk.
292 **
293 ** SQLITE_AFF_TEXT:
294 **    Convert pRec to a text representation.
295 **
296 ** SQLITE_AFF_NONE:
297 **    No-op.  pRec is unchanged.
298 */
299 static void applyAffinity(
300   Mem *pRec,          /* The value to apply affinity to */
301   char affinity,      /* The affinity to be applied */
302   u8 enc              /* Use this text encoding */
303 ){
304   if( affinity==SQLITE_AFF_TEXT ){
305     /* Only attempt the conversion to TEXT if there is an integer or real
306     ** representation (blob and NULL do not get converted) but no string
307     ** representation.
308     */
309     if( 0==(pRec->flags&MEM_Str) && (pRec->flags&(MEM_Real|MEM_Int)) ){
310       sqlite3VdbeMemStringify(pRec, enc);
311     }
312     pRec->flags &= ~(MEM_Real|MEM_Int);
313   }else if( affinity!=SQLITE_AFF_NONE ){
314     assert( affinity==SQLITE_AFF_INTEGER || affinity==SQLITE_AFF_REAL
315              || affinity==SQLITE_AFF_NUMERIC );
316     applyNumericAffinity(pRec);
317     if( pRec->flags & MEM_Real ){
318       sqlite3VdbeIntegerAffinity(pRec);
319     }
320   }
321 }
322 
323 /*
324 ** Try to convert the type of a function argument or a result column
325 ** into a numeric representation.  Use either INTEGER or REAL whichever
326 ** is appropriate.  But only do the conversion if it is possible without
327 ** loss of information and return the revised type of the argument.
328 **
329 ** This is an EXPERIMENTAL api and is subject to change or removal.
330 */
331 int sqlite3_value_numeric_type(sqlite3_value *pVal){
332   Mem *pMem = (Mem*)pVal;
333   applyNumericAffinity(pMem);
334   storeTypeInfo(pMem, 0);
335   return pMem->type;
336 }
337 
338 /*
339 ** Exported version of applyAffinity(). This one works on sqlite3_value*,
340 ** not the internal Mem* type.
341 */
342 void sqlite3ValueApplyAffinity(
343   sqlite3_value *pVal,
344   u8 affinity,
345   u8 enc
346 ){
347   applyAffinity((Mem *)pVal, affinity, enc);
348 }
349 
350 #ifdef SQLITE_DEBUG
351 /*
352 ** Write a nice string representation of the contents of cell pMem
353 ** into buffer zBuf, length nBuf.
354 */
355 void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf){
356   char *zCsr = zBuf;
357   int f = pMem->flags;
358 
359   static const char *const encnames[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
360 
361   if( f&MEM_Blob ){
362     int i;
363     char c;
364     if( f & MEM_Dyn ){
365       c = 'z';
366       assert( (f & (MEM_Static|MEM_Ephem))==0 );
367     }else if( f & MEM_Static ){
368       c = 't';
369       assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
370     }else if( f & MEM_Ephem ){
371       c = 'e';
372       assert( (f & (MEM_Static|MEM_Dyn))==0 );
373     }else{
374       c = 's';
375     }
376 
377     sqlite3_snprintf(100, zCsr, "%c", c);
378     zCsr += strlen(zCsr);
379     sqlite3_snprintf(100, zCsr, "%d[", pMem->n);
380     zCsr += strlen(zCsr);
381     for(i=0; i<16 && i<pMem->n; i++){
382       sqlite3_snprintf(100, zCsr, "%02X", ((int)pMem->z[i] & 0xFF));
383       zCsr += strlen(zCsr);
384     }
385     for(i=0; i<16 && i<pMem->n; i++){
386       char z = pMem->z[i];
387       if( z<32 || z>126 ) *zCsr++ = '.';
388       else *zCsr++ = z;
389     }
390 
391     sqlite3_snprintf(100, zCsr, "]%s", encnames[pMem->enc]);
392     zCsr += strlen(zCsr);
393     if( f & MEM_Zero ){
394       sqlite3_snprintf(100, zCsr,"+%lldz",pMem->u.i);
395       zCsr += strlen(zCsr);
396     }
397     *zCsr = '\0';
398   }else if( f & MEM_Str ){
399     int j, k;
400     zBuf[0] = ' ';
401     if( f & MEM_Dyn ){
402       zBuf[1] = 'z';
403       assert( (f & (MEM_Static|MEM_Ephem))==0 );
404     }else if( f & MEM_Static ){
405       zBuf[1] = 't';
406       assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
407     }else if( f & MEM_Ephem ){
408       zBuf[1] = 'e';
409       assert( (f & (MEM_Static|MEM_Dyn))==0 );
410     }else{
411       zBuf[1] = 's';
412     }
413     k = 2;
414     sqlite3_snprintf(100, &zBuf[k], "%d", pMem->n);
415     k += strlen(&zBuf[k]);
416     zBuf[k++] = '[';
417     for(j=0; j<15 && j<pMem->n; j++){
418       u8 c = pMem->z[j];
419       if( c>=0x20 && c<0x7f ){
420         zBuf[k++] = c;
421       }else{
422         zBuf[k++] = '.';
423       }
424     }
425     zBuf[k++] = ']';
426     sqlite3_snprintf(100,&zBuf[k], encnames[pMem->enc]);
427     k += strlen(&zBuf[k]);
428     zBuf[k++] = 0;
429   }
430 }
431 #endif
432 
433 #ifdef SQLITE_DEBUG
434 /*
435 ** Print the value of a register for tracing purposes:
436 */
437 static void memTracePrint(FILE *out, Mem *p){
438   if( p->flags & MEM_Null ){
439     fprintf(out, " NULL");
440   }else if( (p->flags & (MEM_Int|MEM_Str))==(MEM_Int|MEM_Str) ){
441     fprintf(out, " si:%lld", p->u.i);
442   }else if( p->flags & MEM_Int ){
443     fprintf(out, " i:%lld", p->u.i);
444   }else if( p->flags & MEM_Real ){
445     fprintf(out, " r:%g", p->r);
446   }else{
447     char zBuf[200];
448     sqlite3VdbeMemPrettyPrint(p, zBuf);
449     fprintf(out, " ");
450     fprintf(out, "%s", zBuf);
451   }
452 }
453 static void registerTrace(FILE *out, int iReg, Mem *p){
454   fprintf(out, "REG[%d] = ", iReg);
455   memTracePrint(out, p);
456   fprintf(out, "\n");
457 }
458 #endif
459 
460 #ifdef SQLITE_DEBUG
461 #  define REGISTER_TRACE(R,M) if(p->trace)registerTrace(p->trace,R,M)
462 #else
463 #  define REGISTER_TRACE(R,M)
464 #endif
465 
466 
467 #ifdef VDBE_PROFILE
468 
469 /*
470 ** hwtime.h contains inline assembler code for implementing
471 ** high-performance timing routines.
472 */
473 #include "hwtime.h"
474 
475 #endif
476 
477 /*
478 ** The CHECK_FOR_INTERRUPT macro defined here looks to see if the
479 ** sqlite3_interrupt() routine has been called.  If it has been, then
480 ** processing of the VDBE program is interrupted.
481 **
482 ** This macro added to every instruction that does a jump in order to
483 ** implement a loop.  This test used to be on every single instruction,
484 ** but that meant we more testing that we needed.  By only testing the
485 ** flag on jump instructions, we get a (small) speed improvement.
486 */
487 #define CHECK_FOR_INTERRUPT \
488    if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
489 
490 #ifdef SQLITE_DEBUG
491 static int fileExists(sqlite3 *db, const char *zFile){
492   int res = 0;
493   int rc = SQLITE_OK;
494 #ifdef SQLITE_TEST
495   /* If we are currently testing IO errors, then do not call OsAccess() to
496   ** test for the presence of zFile. This is because any IO error that
497   ** occurs here will not be reported, causing the test to fail.
498   */
499   extern int sqlite3_io_error_pending;
500   if( sqlite3_io_error_pending<=0 )
501 #endif
502     rc = sqlite3OsAccess(db->pVfs, zFile, SQLITE_ACCESS_EXISTS, &res);
503   return (res && rc==SQLITE_OK);
504 }
505 #endif
506 
507 /*
508 ** Execute as much of a VDBE program as we can then return.
509 **
510 ** sqlite3VdbeMakeReady() must be called before this routine in order to
511 ** close the program with a final OP_Halt and to set up the callbacks
512 ** and the error message pointer.
513 **
514 ** Whenever a row or result data is available, this routine will either
515 ** invoke the result callback (if there is one) or return with
516 ** SQLITE_ROW.
517 **
518 ** If an attempt is made to open a locked database, then this routine
519 ** will either invoke the busy callback (if there is one) or it will
520 ** return SQLITE_BUSY.
521 **
522 ** If an error occurs, an error message is written to memory obtained
523 ** from sqlite3_malloc() and p->zErrMsg is made to point to that memory.
524 ** The error code is stored in p->rc and this routine returns SQLITE_ERROR.
525 **
526 ** If the callback ever returns non-zero, then the program exits
527 ** immediately.  There will be no error message but the p->rc field is
528 ** set to SQLITE_ABORT and this routine will return SQLITE_ERROR.
529 **
530 ** A memory allocation error causes p->rc to be set to SQLITE_NOMEM and this
531 ** routine to return SQLITE_ERROR.
532 **
533 ** Other fatal errors return SQLITE_ERROR.
534 **
535 ** After this routine has finished, sqlite3VdbeFinalize() should be
536 ** used to clean up the mess that was left behind.
537 */
538 int sqlite3VdbeExec(
539   Vdbe *p                    /* The VDBE */
540 ){
541   int pc;                    /* The program counter */
542   Op *pOp;                   /* Current operation */
543   int rc = SQLITE_OK;        /* Value to return */
544   sqlite3 *db = p->db;       /* The database */
545   u8 encoding = ENC(db);     /* The database encoding */
546   Mem *pIn1, *pIn2, *pIn3;   /* Input operands */
547   Mem *pOut;                 /* Output operand */
548   u8 opProperty;
549   int iCompare = 0;          /* Result of last OP_Compare operation */
550   int *aPermute = 0;         /* Permuation of columns for OP_Compare */
551 #ifdef VDBE_PROFILE
552   u64 start;                 /* CPU clock count at start of opcode */
553   int origPc;                /* Program counter at start of opcode */
554 #endif
555 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
556   int nProgressOps = 0;      /* Opcodes executed since progress callback. */
557 #endif
558 
559   assert( p->magic==VDBE_MAGIC_RUN );  /* sqlite3_step() verifies this */
560   assert( db->magic==SQLITE_MAGIC_BUSY );
561   sqlite3BtreeMutexArrayEnter(&p->aMutex);
562   if( p->rc==SQLITE_NOMEM ){
563     /* This happens if a malloc() inside a call to sqlite3_column_text() or
564     ** sqlite3_column_text16() failed.  */
565     goto no_mem;
566   }
567   assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY );
568   p->rc = SQLITE_OK;
569   assert( p->explain==0 );
570   p->pResultSet = 0;
571   db->busyHandler.nBusy = 0;
572   CHECK_FOR_INTERRUPT;
573   sqlite3VdbeIOTraceSql(p);
574 #ifdef SQLITE_DEBUG
575   sqlite3BeginBenignMalloc();
576   if( p->pc==0
577    && ((p->db->flags & SQLITE_VdbeListing) || fileExists(db, "vdbe_explain"))
578   ){
579     int i;
580     printf("VDBE Program Listing:\n");
581     sqlite3VdbePrintSql(p);
582     for(i=0; i<p->nOp; i++){
583       sqlite3VdbePrintOp(stdout, i, &p->aOp[i]);
584     }
585   }
586   if( fileExists(db, "vdbe_trace") ){
587     p->trace = stdout;
588   }
589   sqlite3EndBenignMalloc();
590 #endif
591   for(pc=p->pc; rc==SQLITE_OK; pc++){
592     assert( pc>=0 && pc<p->nOp );
593     if( db->mallocFailed ) goto no_mem;
594 #ifdef VDBE_PROFILE
595     origPc = pc;
596     start = sqlite3Hwtime();
597 #endif
598     pOp = &p->aOp[pc];
599 
600     /* Only allow tracing if SQLITE_DEBUG is defined.
601     */
602 #ifdef SQLITE_DEBUG
603     if( p->trace ){
604       if( pc==0 ){
605         printf("VDBE Execution Trace:\n");
606         sqlite3VdbePrintSql(p);
607       }
608       sqlite3VdbePrintOp(p->trace, pc, pOp);
609     }
610     if( p->trace==0 && pc==0 ){
611       sqlite3BeginBenignMalloc();
612       if( fileExists(db, "vdbe_sqltrace") ){
613         sqlite3VdbePrintSql(p);
614       }
615       sqlite3EndBenignMalloc();
616     }
617 #endif
618 
619 
620     /* Check to see if we need to simulate an interrupt.  This only happens
621     ** if we have a special test build.
622     */
623 #ifdef SQLITE_TEST
624     if( sqlite3_interrupt_count>0 ){
625       sqlite3_interrupt_count--;
626       if( sqlite3_interrupt_count==0 ){
627         sqlite3_interrupt(db);
628       }
629     }
630 #endif
631 
632 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
633     /* Call the progress callback if it is configured and the required number
634     ** of VDBE ops have been executed (either since this invocation of
635     ** sqlite3VdbeExec() or since last time the progress callback was called).
636     ** If the progress callback returns non-zero, exit the virtual machine with
637     ** a return code SQLITE_ABORT.
638     */
639     if( db->xProgress ){
640       if( db->nProgressOps==nProgressOps ){
641         int prc;
642         if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
643         prc =db->xProgress(db->pProgressArg);
644         if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
645         if( prc!=0 ){
646           rc = SQLITE_INTERRUPT;
647           goto vdbe_error_halt;
648         }
649         nProgressOps = 0;
650       }
651       nProgressOps++;
652     }
653 #endif
654 
655     /* Do common setup processing for any opcode that is marked
656     ** with the "out2-prerelease" tag.  Such opcodes have a single
657     ** output which is specified by the P2 parameter.  The P2 register
658     ** is initialized to a NULL.
659     */
660     opProperty = opcodeProperty[pOp->opcode];
661     if( (opProperty & OPFLG_OUT2_PRERELEASE)!=0 ){
662       assert( pOp->p2>0 );
663       assert( pOp->p2<=p->nMem );
664       pOut = &p->aMem[pOp->p2];
665       sqlite3VdbeMemReleaseExternal(pOut);
666       pOut->flags = MEM_Null;
667     }else
668 
669     /* Do common setup for opcodes marked with one of the following
670     ** combinations of properties.
671     **
672     **           in1
673     **           in1 in2
674     **           in1 in2 out3
675     **           in1 in3
676     **
677     ** Variables pIn1, pIn2, and pIn3 are made to point to appropriate
678     ** registers for inputs.  Variable pOut points to the output register.
679     */
680     if( (opProperty & OPFLG_IN1)!=0 ){
681       assert( pOp->p1>0 );
682       assert( pOp->p1<=p->nMem );
683       pIn1 = &p->aMem[pOp->p1];
684       REGISTER_TRACE(pOp->p1, pIn1);
685       if( (opProperty & OPFLG_IN2)!=0 ){
686         assert( pOp->p2>0 );
687         assert( pOp->p2<=p->nMem );
688         pIn2 = &p->aMem[pOp->p2];
689         REGISTER_TRACE(pOp->p2, pIn2);
690         if( (opProperty & OPFLG_OUT3)!=0 ){
691           assert( pOp->p3>0 );
692           assert( pOp->p3<=p->nMem );
693           pOut = &p->aMem[pOp->p3];
694         }
695       }else if( (opProperty & OPFLG_IN3)!=0 ){
696         assert( pOp->p3>0 );
697         assert( pOp->p3<=p->nMem );
698         pIn3 = &p->aMem[pOp->p3];
699         REGISTER_TRACE(pOp->p3, pIn3);
700       }
701     }else if( (opProperty & OPFLG_IN2)!=0 ){
702       assert( pOp->p2>0 );
703       assert( pOp->p2<=p->nMem );
704       pIn2 = &p->aMem[pOp->p2];
705       REGISTER_TRACE(pOp->p2, pIn2);
706     }else if( (opProperty & OPFLG_IN3)!=0 ){
707       assert( pOp->p3>0 );
708       assert( pOp->p3<=p->nMem );
709       pIn3 = &p->aMem[pOp->p3];
710       REGISTER_TRACE(pOp->p3, pIn3);
711     }
712 
713     switch( pOp->opcode ){
714 
715 /*****************************************************************************
716 ** What follows is a massive switch statement where each case implements a
717 ** separate instruction in the virtual machine.  If we follow the usual
718 ** indentation conventions, each case should be indented by 6 spaces.  But
719 ** that is a lot of wasted space on the left margin.  So the code within
720 ** the switch statement will break with convention and be flush-left. Another
721 ** big comment (similar to this one) will mark the point in the code where
722 ** we transition back to normal indentation.
723 **
724 ** The formatting of each case is important.  The makefile for SQLite
725 ** generates two C files "opcodes.h" and "opcodes.c" by scanning this
726 ** file looking for lines that begin with "case OP_".  The opcodes.h files
727 ** will be filled with #defines that give unique integer values to each
728 ** opcode and the opcodes.c file is filled with an array of strings where
729 ** each string is the symbolic name for the corresponding opcode.  If the
730 ** case statement is followed by a comment of the form "/# same as ... #/"
731 ** that comment is used to determine the particular value of the opcode.
732 **
733 ** Other keywords in the comment that follows each case are used to
734 ** construct the OPFLG_INITIALIZER value that initializes opcodeProperty[].
735 ** Keywords include: in1, in2, in3, out2_prerelease, out2, out3.  See
736 ** the mkopcodeh.awk script for additional information.
737 **
738 ** Documentation about VDBE opcodes is generated by scanning this file
739 ** for lines of that contain "Opcode:".  That line and all subsequent
740 ** comment lines are used in the generation of the opcode.html documentation
741 ** file.
742 **
743 ** SUMMARY:
744 **
745 **     Formatting is important to scripts that scan this file.
746 **     Do not deviate from the formatting style currently in use.
747 **
748 *****************************************************************************/
749 
750 /* Opcode:  Goto * P2 * * *
751 **
752 ** An unconditional jump to address P2.
753 ** The next instruction executed will be
754 ** the one at index P2 from the beginning of
755 ** the program.
756 */
757 case OP_Goto: {             /* jump */
758   CHECK_FOR_INTERRUPT;
759   pc = pOp->p2 - 1;
760   break;
761 }
762 
763 /* Opcode:  Gosub P1 P2 * * *
764 **
765 ** Write the current address onto register P1
766 ** and then jump to address P2.
767 */
768 case OP_Gosub: {            /* jump */
769   assert( pOp->p1>0 );
770   assert( pOp->p1<=p->nMem );
771   pIn1 = &p->aMem[pOp->p1];
772   assert( (pIn1->flags & MEM_Dyn)==0 );
773   pIn1->flags = MEM_Int;
774   pIn1->u.i = pc;
775   REGISTER_TRACE(pOp->p1, pIn1);
776   pc = pOp->p2 - 1;
777   break;
778 }
779 
780 /* Opcode:  Return P1 * * * *
781 **
782 ** Jump to the next instruction after the address in register P1.
783 */
784 case OP_Return: {           /* in1 */
785   assert( pIn1->flags & MEM_Int );
786   pc = pIn1->u.i;
787   break;
788 }
789 
790 /* Opcode:  Yield P1 * * * *
791 **
792 ** Swap the program counter with the value in register P1.
793 */
794 case OP_Yield: {
795   int pcDest;
796   assert( pOp->p1>0 );
797   assert( pOp->p1<=p->nMem );
798   pIn1 = &p->aMem[pOp->p1];
799   assert( (pIn1->flags & MEM_Dyn)==0 );
800   pIn1->flags = MEM_Int;
801   pcDest = pIn1->u.i;
802   pIn1->u.i = pc;
803   REGISTER_TRACE(pOp->p1, pIn1);
804   pc = pcDest;
805   break;
806 }
807 
808 
809 /* Opcode:  Halt P1 P2 * P4 *
810 **
811 ** Exit immediately.  All open cursors, Fifos, etc are closed
812 ** automatically.
813 **
814 ** P1 is the result code returned by sqlite3_exec(), sqlite3_reset(),
815 ** or sqlite3_finalize().  For a normal halt, this should be SQLITE_OK (0).
816 ** For errors, it can be some other value.  If P1!=0 then P2 will determine
817 ** whether or not to rollback the current transaction.  Do not rollback
818 ** if P2==OE_Fail. Do the rollback if P2==OE_Rollback.  If P2==OE_Abort,
819 ** then back out all changes that have occurred during this execution of the
820 ** VDBE, but do not rollback the transaction.
821 **
822 ** If P4 is not null then it is an error message string.
823 **
824 ** There is an implied "Halt 0 0 0" instruction inserted at the very end of
825 ** every program.  So a jump past the last instruction of the program
826 ** is the same as executing Halt.
827 */
828 case OP_Halt: {
829   p->rc = pOp->p1;
830   p->pc = pc;
831   p->errorAction = pOp->p2;
832   if( pOp->p4.z ){
833     sqlite3SetString(&p->zErrMsg, db, "%s", pOp->p4.z);
834   }
835   rc = sqlite3VdbeHalt(p);
836   assert( rc==SQLITE_BUSY || rc==SQLITE_OK );
837   if( rc==SQLITE_BUSY ){
838     p->rc = rc = SQLITE_BUSY;
839   }else{
840     rc = p->rc ? SQLITE_ERROR : SQLITE_DONE;
841   }
842   goto vdbe_return;
843 }
844 
845 /* Opcode: Integer P1 P2 * * *
846 **
847 ** The 32-bit integer value P1 is written into register P2.
848 */
849 case OP_Integer: {         /* out2-prerelease */
850   pOut->flags = MEM_Int;
851   pOut->u.i = pOp->p1;
852   break;
853 }
854 
855 /* Opcode: Int64 * P2 * P4 *
856 **
857 ** P4 is a pointer to a 64-bit integer value.
858 ** Write that value into register P2.
859 */
860 case OP_Int64: {           /* out2-prerelease */
861   assert( pOp->p4.pI64!=0 );
862   pOut->flags = MEM_Int;
863   pOut->u.i = *pOp->p4.pI64;
864   break;
865 }
866 
867 /* Opcode: Real * P2 * P4 *
868 **
869 ** P4 is a pointer to a 64-bit floating point value.
870 ** Write that value into register P2.
871 */
872 case OP_Real: {            /* same as TK_FLOAT, out2-prerelease */
873   pOut->flags = MEM_Real;
874   assert( !sqlite3IsNaN(*pOp->p4.pReal) );
875   pOut->r = *pOp->p4.pReal;
876   break;
877 }
878 
879 /* Opcode: String8 * P2 * P4 *
880 **
881 ** P4 points to a nul terminated UTF-8 string. This opcode is transformed
882 ** into an OP_String before it is executed for the first time.
883 */
884 case OP_String8: {         /* same as TK_STRING, out2-prerelease */
885   assert( pOp->p4.z!=0 );
886   pOp->opcode = OP_String;
887   pOp->p1 = strlen(pOp->p4.z);
888 
889 #ifndef SQLITE_OMIT_UTF16
890   if( encoding!=SQLITE_UTF8 ){
891     sqlite3VdbeMemSetStr(pOut, pOp->p4.z, -1, SQLITE_UTF8, SQLITE_STATIC);
892     if( SQLITE_OK!=sqlite3VdbeChangeEncoding(pOut, encoding) ) goto no_mem;
893     if( SQLITE_OK!=sqlite3VdbeMemDynamicify(pOut) ) goto no_mem;
894     pOut->zMalloc = 0;
895     pOut->flags |= MEM_Static;
896     pOut->flags &= ~MEM_Dyn;
897     if( pOp->p4type==P4_DYNAMIC ){
898       sqlite3_free(pOp->p4.z);
899     }
900     pOp->p4type = P4_DYNAMIC;
901     pOp->p4.z = pOut->z;
902     pOp->p1 = pOut->n;
903     if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
904       goto too_big;
905     }
906     UPDATE_MAX_BLOBSIZE(pOut);
907     break;
908   }
909 #endif
910   if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
911     goto too_big;
912   }
913   /* Fall through to the next case, OP_String */
914 }
915 
916 /* Opcode: String P1 P2 * P4 *
917 **
918 ** The string value P4 of length P1 (bytes) is stored in register P2.
919 */
920 case OP_String: {          /* out2-prerelease */
921   assert( pOp->p4.z!=0 );
922   pOut->flags = MEM_Str|MEM_Static|MEM_Term;
923   pOut->z = pOp->p4.z;
924   pOut->n = pOp->p1;
925   pOut->enc = encoding;
926   UPDATE_MAX_BLOBSIZE(pOut);
927   break;
928 }
929 
930 /* Opcode: Null * P2 * * *
931 **
932 ** Write a NULL into register P2.
933 */
934 case OP_Null: {           /* out2-prerelease */
935   break;
936 }
937 
938 
939 #ifndef SQLITE_OMIT_BLOB_LITERAL
940 /* Opcode: Blob P1 P2 * P4
941 **
942 ** P4 points to a blob of data P1 bytes long.  Store this
943 ** blob in register P2. This instruction is not coded directly
944 ** by the compiler. Instead, the compiler layer specifies
945 ** an OP_HexBlob opcode, with the hex string representation of
946 ** the blob as P4. This opcode is transformed to an OP_Blob
947 ** the first time it is executed.
948 */
949 case OP_Blob: {                /* out2-prerelease */
950   assert( pOp->p1 <= SQLITE_MAX_LENGTH );
951   sqlite3VdbeMemSetStr(pOut, pOp->p4.z, pOp->p1, 0, 0);
952   pOut->enc = encoding;
953   UPDATE_MAX_BLOBSIZE(pOut);
954   break;
955 }
956 #endif /* SQLITE_OMIT_BLOB_LITERAL */
957 
958 /* Opcode: Variable P1 P2 * * *
959 **
960 ** The value of variable P1 is written into register P2. A variable is
961 ** an unknown in the original SQL string as handed to sqlite3_compile().
962 ** Any occurrence of the '?' character in the original SQL is considered
963 ** a variable.  Variables in the SQL string are number from left to
964 ** right beginning with 1.  The values of variables are set using the
965 ** sqlite3_bind() API.
966 */
967 case OP_Variable: {           /* out2-prerelease */
968   int j = pOp->p1 - 1;
969   Mem *pVar;
970   assert( j>=0 && j<p->nVar );
971 
972   pVar = &p->aVar[j];
973   if( sqlite3VdbeMemTooBig(pVar) ){
974     goto too_big;
975   }
976   sqlite3VdbeMemShallowCopy(pOut, &p->aVar[j], MEM_Static);
977   UPDATE_MAX_BLOBSIZE(pOut);
978   break;
979 }
980 
981 /* Opcode: Move P1 P2 P3 * *
982 **
983 ** Move the values in register P1..P1+P3-1 over into
984 ** registers P2..P2+P3-1.  Registers P1..P1+P1-1 are
985 ** left holding a NULL.  It is an error for register ranges
986 ** P1..P1+P3-1 and P2..P2+P3-1 to overlap.
987 */
988 case OP_Move: {
989   char *zMalloc;
990   int n = pOp->p3;
991   int p1 = pOp->p1;
992   int p2 = pOp->p2;
993   assert( n>0 );
994   assert( p1>0 );
995   assert( p1+n<p->nMem );
996   pIn1 = &p->aMem[p1];
997   assert( p2>0 );
998   assert( p2+n<p->nMem );
999   pOut = &p->aMem[p2];
1000   assert( p1+n<=p2 || p2+n<=p1 );
1001   while( n-- ){
1002     zMalloc = pOut->zMalloc;
1003     pOut->zMalloc = 0;
1004     sqlite3VdbeMemMove(pOut, pIn1);
1005     pIn1->zMalloc = zMalloc;
1006     REGISTER_TRACE(p2++, pOut);
1007     pIn1++;
1008     pOut++;
1009   }
1010   break;
1011 }
1012 
1013 /* Opcode: Copy P1 P2 * * *
1014 **
1015 ** Make a copy of register P1 into register P2.
1016 **
1017 ** This instruction makes a deep copy of the value.  A duplicate
1018 ** is made of any string or blob constant.  See also OP_SCopy.
1019 */
1020 case OP_Copy: {
1021   assert( pOp->p1>0 );
1022   assert( pOp->p1<=p->nMem );
1023   pIn1 = &p->aMem[pOp->p1];
1024   assert( pOp->p2>0 );
1025   assert( pOp->p2<=p->nMem );
1026   pOut = &p->aMem[pOp->p2];
1027   assert( pOut!=pIn1 );
1028   sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
1029   Deephemeralize(pOut);
1030   REGISTER_TRACE(pOp->p2, pOut);
1031   break;
1032 }
1033 
1034 /* Opcode: SCopy P1 P2 * * *
1035 **
1036 ** Make a shallow copy of register P1 into register P2.
1037 **
1038 ** This instruction makes a shallow copy of the value.  If the value
1039 ** is a string or blob, then the copy is only a pointer to the
1040 ** original and hence if the original changes so will the copy.
1041 ** Worse, if the original is deallocated, the copy becomes invalid.
1042 ** Thus the program must guarantee that the original will not change
1043 ** during the lifetime of the copy.  Use OP_Copy to make a complete
1044 ** copy.
1045 */
1046 case OP_SCopy: {
1047   assert( pOp->p1>0 );
1048   assert( pOp->p1<=p->nMem );
1049   pIn1 = &p->aMem[pOp->p1];
1050   REGISTER_TRACE(pOp->p1, pIn1);
1051   assert( pOp->p2>0 );
1052   assert( pOp->p2<=p->nMem );
1053   pOut = &p->aMem[pOp->p2];
1054   assert( pOut!=pIn1 );
1055   sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
1056   REGISTER_TRACE(pOp->p2, pOut);
1057   break;
1058 }
1059 
1060 /* Opcode: ResultRow P1 P2 * * *
1061 **
1062 ** The registers P1 through P1+P2-1 contain a single row of
1063 ** results. This opcode causes the sqlite3_step() call to terminate
1064 ** with an SQLITE_ROW return code and it sets up the sqlite3_stmt
1065 ** structure to provide access to the top P1 values as the result
1066 ** row.
1067 */
1068 case OP_ResultRow: {
1069   Mem *pMem;
1070   int i;
1071   assert( p->nResColumn==pOp->p2 );
1072   assert( pOp->p1>0 );
1073   assert( pOp->p1+pOp->p2<=p->nMem );
1074 
1075   /* Invalidate all ephemeral cursor row caches */
1076   p->cacheCtr = (p->cacheCtr + 2)|1;
1077 
1078   /* Make sure the results of the current row are \000 terminated
1079   ** and have an assigned type.  The results are de-ephemeralized as
1080   ** as side effect.
1081   */
1082   pMem = p->pResultSet = &p->aMem[pOp->p1];
1083   for(i=0; i<pOp->p2; i++){
1084     sqlite3VdbeMemNulTerminate(&pMem[i]);
1085     storeTypeInfo(&pMem[i], encoding);
1086     REGISTER_TRACE(pOp->p1+i, &pMem[i]);
1087   }
1088   if( db->mallocFailed ) goto no_mem;
1089 
1090   /* Return SQLITE_ROW
1091   */
1092   p->nCallback++;
1093   p->pc = pc + 1;
1094   rc = SQLITE_ROW;
1095   goto vdbe_return;
1096 }
1097 
1098 /* Opcode: Concat P1 P2 P3 * *
1099 **
1100 ** Add the text in register P1 onto the end of the text in
1101 ** register P2 and store the result in register P3.
1102 ** If either the P1 or P2 text are NULL then store NULL in P3.
1103 **
1104 **   P3 = P2 || P1
1105 **
1106 ** It is illegal for P1 and P3 to be the same register. Sometimes,
1107 ** if P3 is the same register as P2, the implementation is able
1108 ** to avoid a memcpy().
1109 */
1110 case OP_Concat: {           /* same as TK_CONCAT, in1, in2, out3 */
1111   i64 nByte;
1112 
1113   assert( pIn1!=pOut );
1114   if( (pIn1->flags | pIn2->flags) & MEM_Null ){
1115     sqlite3VdbeMemSetNull(pOut);
1116     break;
1117   }
1118   ExpandBlob(pIn1);
1119   Stringify(pIn1, encoding);
1120   ExpandBlob(pIn2);
1121   Stringify(pIn2, encoding);
1122   nByte = pIn1->n + pIn2->n;
1123   if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
1124     goto too_big;
1125   }
1126   MemSetTypeFlag(pOut, MEM_Str);
1127   if( sqlite3VdbeMemGrow(pOut, nByte+2, pOut==pIn2) ){
1128     goto no_mem;
1129   }
1130   if( pOut!=pIn2 ){
1131     memcpy(pOut->z, pIn2->z, pIn2->n);
1132   }
1133   memcpy(&pOut->z[pIn2->n], pIn1->z, pIn1->n);
1134   pOut->z[nByte] = 0;
1135   pOut->z[nByte+1] = 0;
1136   pOut->flags |= MEM_Term;
1137   pOut->n = nByte;
1138   pOut->enc = encoding;
1139   UPDATE_MAX_BLOBSIZE(pOut);
1140   break;
1141 }
1142 
1143 /* Opcode: Add P1 P2 P3 * *
1144 **
1145 ** Add the value in register P1 to the value in register P2
1146 ** and store the result in register P3.
1147 ** If either input is NULL, the result is NULL.
1148 */
1149 /* Opcode: Multiply P1 P2 P3 * *
1150 **
1151 **
1152 ** Multiply the value in register P1 by the value in register P2
1153 ** and store the result in register P3.
1154 ** If either input is NULL, the result is NULL.
1155 */
1156 /* Opcode: Subtract P1 P2 P3 * *
1157 **
1158 ** Subtract the value in register P1 from the value in register P2
1159 ** and store the result in register P3.
1160 ** If either input is NULL, the result is NULL.
1161 */
1162 /* Opcode: Divide P1 P2 P3 * *
1163 **
1164 ** Divide the value in register P1 by the value in register P2
1165 ** and store the result in register P3.  If the value in register P2
1166 ** is zero, then the result is NULL.
1167 ** If either input is NULL, the result is NULL.
1168 */
1169 /* Opcode: Remainder P1 P2 P3 * *
1170 **
1171 ** Compute the remainder after integer division of the value in
1172 ** register P1 by the value in register P2 and store the result in P3.
1173 ** If the value in register P2 is zero the result is NULL.
1174 ** If either operand is NULL, the result is NULL.
1175 */
1176 case OP_Add:                   /* same as TK_PLUS, in1, in2, out3 */
1177 case OP_Subtract:              /* same as TK_MINUS, in1, in2, out3 */
1178 case OP_Multiply:              /* same as TK_STAR, in1, in2, out3 */
1179 case OP_Divide:                /* same as TK_SLASH, in1, in2, out3 */
1180 case OP_Remainder: {           /* same as TK_REM, in1, in2, out3 */
1181   int flags;
1182   flags = pIn1->flags | pIn2->flags;
1183   if( (flags & MEM_Null)!=0 ) goto arithmetic_result_is_null;
1184   if( (pIn1->flags & pIn2->flags & MEM_Int)==MEM_Int ){
1185     i64 a, b;
1186     a = pIn1->u.i;
1187     b = pIn2->u.i;
1188     switch( pOp->opcode ){
1189       case OP_Add:         b += a;       break;
1190       case OP_Subtract:    b -= a;       break;
1191       case OP_Multiply:    b *= a;       break;
1192       case OP_Divide: {
1193         if( a==0 ) goto arithmetic_result_is_null;
1194         /* Dividing the largest possible negative 64-bit integer (1<<63) by
1195         ** -1 returns an integer too large to store in a 64-bit data-type. On
1196         ** some architectures, the value overflows to (1<<63). On others,
1197         ** a SIGFPE is issued. The following statement normalizes this
1198         ** behavior so that all architectures behave as if integer
1199         ** overflow occurred.
1200         */
1201         if( a==-1 && b==SMALLEST_INT64 ) a = 1;
1202         b /= a;
1203         break;
1204       }
1205       default: {
1206         if( a==0 ) goto arithmetic_result_is_null;
1207         if( a==-1 ) a = 1;
1208         b %= a;
1209         break;
1210       }
1211     }
1212     pOut->u.i = b;
1213     MemSetTypeFlag(pOut, MEM_Int);
1214   }else{
1215     double a, b;
1216     a = sqlite3VdbeRealValue(pIn1);
1217     b = sqlite3VdbeRealValue(pIn2);
1218     switch( pOp->opcode ){
1219       case OP_Add:         b += a;       break;
1220       case OP_Subtract:    b -= a;       break;
1221       case OP_Multiply:    b *= a;       break;
1222       case OP_Divide: {
1223         if( a==0.0 ) goto arithmetic_result_is_null;
1224         b /= a;
1225         break;
1226       }
1227       default: {
1228         i64 ia = (i64)a;
1229         i64 ib = (i64)b;
1230         if( ia==0 ) goto arithmetic_result_is_null;
1231         if( ia==-1 ) ia = 1;
1232         b = ib % ia;
1233         break;
1234       }
1235     }
1236     if( sqlite3IsNaN(b) ){
1237       goto arithmetic_result_is_null;
1238     }
1239     pOut->r = b;
1240     MemSetTypeFlag(pOut, MEM_Real);
1241     if( (flags & MEM_Real)==0 ){
1242       sqlite3VdbeIntegerAffinity(pOut);
1243     }
1244   }
1245   break;
1246 
1247 arithmetic_result_is_null:
1248   sqlite3VdbeMemSetNull(pOut);
1249   break;
1250 }
1251 
1252 /* Opcode: CollSeq * * P4
1253 **
1254 ** P4 is a pointer to a CollSeq struct. If the next call to a user function
1255 ** or aggregate calls sqlite3GetFuncCollSeq(), this collation sequence will
1256 ** be returned. This is used by the built-in min(), max() and nullif()
1257 ** functions.
1258 **
1259 ** The interface used by the implementation of the aforementioned functions
1260 ** to retrieve the collation sequence set by this opcode is not available
1261 ** publicly, only to user functions defined in func.c.
1262 */
1263 case OP_CollSeq: {
1264   assert( pOp->p4type==P4_COLLSEQ );
1265   break;
1266 }
1267 
1268 /* Opcode: Function P1 P2 P3 P4 P5
1269 **
1270 ** Invoke a user function (P4 is a pointer to a Function structure that
1271 ** defines the function) with P5 arguments taken from register P2 and
1272 ** successors.  The result of the function is stored in register P3.
1273 ** Register P3 must not be one of the function inputs.
1274 **
1275 ** P1 is a 32-bit bitmask indicating whether or not each argument to the
1276 ** function was determined to be constant at compile time. If the first
1277 ** argument was constant then bit 0 of P1 is set. This is used to determine
1278 ** whether meta data associated with a user function argument using the
1279 ** sqlite3_set_auxdata() API may be safely retained until the next
1280 ** invocation of this opcode.
1281 **
1282 ** See also: AggStep and AggFinal
1283 */
1284 case OP_Function: {
1285   int i;
1286   Mem *pArg;
1287   sqlite3_context ctx;
1288   sqlite3_value **apVal;
1289   int n = pOp->p5;
1290 
1291   apVal = p->apArg;
1292   assert( apVal || n==0 );
1293 
1294   assert( n==0 || (pOp->p2>0 && pOp->p2+n<=p->nMem) );
1295   assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
1296   pArg = &p->aMem[pOp->p2];
1297   for(i=0; i<n; i++, pArg++){
1298     apVal[i] = pArg;
1299     storeTypeInfo(pArg, encoding);
1300     REGISTER_TRACE(pOp->p2, pArg);
1301   }
1302 
1303   assert( pOp->p4type==P4_FUNCDEF || pOp->p4type==P4_VDBEFUNC );
1304   if( pOp->p4type==P4_FUNCDEF ){
1305     ctx.pFunc = pOp->p4.pFunc;
1306     ctx.pVdbeFunc = 0;
1307   }else{
1308     ctx.pVdbeFunc = (VdbeFunc*)pOp->p4.pVdbeFunc;
1309     ctx.pFunc = ctx.pVdbeFunc->pFunc;
1310   }
1311 
1312   assert( pOp->p3>0 && pOp->p3<=p->nMem );
1313   pOut = &p->aMem[pOp->p3];
1314   ctx.s.flags = MEM_Null;
1315   ctx.s.db = db;
1316   ctx.s.xDel = 0;
1317   ctx.s.zMalloc = 0;
1318 
1319   /* The output cell may already have a buffer allocated. Move
1320   ** the pointer to ctx.s so in case the user-function can use
1321   ** the already allocated buffer instead of allocating a new one.
1322   */
1323   sqlite3VdbeMemMove(&ctx.s, pOut);
1324   MemSetTypeFlag(&ctx.s, MEM_Null);
1325 
1326   ctx.isError = 0;
1327   if( ctx.pFunc->needCollSeq ){
1328     assert( pOp>p->aOp );
1329     assert( pOp[-1].p4type==P4_COLLSEQ );
1330     assert( pOp[-1].opcode==OP_CollSeq );
1331     ctx.pColl = pOp[-1].p4.pColl;
1332   }
1333   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
1334   (*ctx.pFunc->xFunc)(&ctx, n, apVal);
1335   if( sqlite3SafetyOn(db) ){
1336     sqlite3VdbeMemRelease(&ctx.s);
1337     goto abort_due_to_misuse;
1338   }
1339   if( db->mallocFailed ){
1340     /* Even though a malloc() has failed, the implementation of the
1341     ** user function may have called an sqlite3_result_XXX() function
1342     ** to return a value. The following call releases any resources
1343     ** associated with such a value.
1344     **
1345     ** Note: Maybe MemRelease() should be called if sqlite3SafetyOn()
1346     ** fails also (the if(...) statement above). But if people are
1347     ** misusing sqlite, they have bigger problems than a leaked value.
1348     */
1349     sqlite3VdbeMemRelease(&ctx.s);
1350     goto no_mem;
1351   }
1352 
1353   /* If any auxiliary data functions have been called by this user function,
1354   ** immediately call the destructor for any non-static values.
1355   */
1356   if( ctx.pVdbeFunc ){
1357     sqlite3VdbeDeleteAuxData(ctx.pVdbeFunc, pOp->p1);
1358     pOp->p4.pVdbeFunc = ctx.pVdbeFunc;
1359     pOp->p4type = P4_VDBEFUNC;
1360   }
1361 
1362   /* If the function returned an error, throw an exception */
1363   if( ctx.isError ){
1364     sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3_value_text(&ctx.s));
1365     rc = ctx.isError;
1366   }
1367 
1368   /* Copy the result of the function into register P3 */
1369   sqlite3VdbeChangeEncoding(&ctx.s, encoding);
1370   sqlite3VdbeMemMove(pOut, &ctx.s);
1371   if( sqlite3VdbeMemTooBig(pOut) ){
1372     goto too_big;
1373   }
1374   REGISTER_TRACE(pOp->p3, pOut);
1375   UPDATE_MAX_BLOBSIZE(pOut);
1376   break;
1377 }
1378 
1379 /* Opcode: BitAnd P1 P2 P3 * *
1380 **
1381 ** Take the bit-wise AND of the values in register P1 and P2 and
1382 ** store the result in register P3.
1383 ** If either input is NULL, the result is NULL.
1384 */
1385 /* Opcode: BitOr P1 P2 P3 * *
1386 **
1387 ** Take the bit-wise OR of the values in register P1 and P2 and
1388 ** store the result in register P3.
1389 ** If either input is NULL, the result is NULL.
1390 */
1391 /* Opcode: ShiftLeft P1 P2 P3 * *
1392 **
1393 ** Shift the integer value in register P2 to the left by the
1394 ** number of bits specified by the integer in regiser P1.
1395 ** Store the result in register P3.
1396 ** If either input is NULL, the result is NULL.
1397 */
1398 /* Opcode: ShiftRight P1 P2 P3 * *
1399 **
1400 ** Shift the integer value in register P2 to the right by the
1401 ** number of bits specified by the integer in register P1.
1402 ** Store the result in register P3.
1403 ** If either input is NULL, the result is NULL.
1404 */
1405 case OP_BitAnd:                 /* same as TK_BITAND, in1, in2, out3 */
1406 case OP_BitOr:                  /* same as TK_BITOR, in1, in2, out3 */
1407 case OP_ShiftLeft:              /* same as TK_LSHIFT, in1, in2, out3 */
1408 case OP_ShiftRight: {           /* same as TK_RSHIFT, in1, in2, out3 */
1409   i64 a, b;
1410 
1411   if( (pIn1->flags | pIn2->flags) & MEM_Null ){
1412     sqlite3VdbeMemSetNull(pOut);
1413     break;
1414   }
1415   a = sqlite3VdbeIntValue(pIn2);
1416   b = sqlite3VdbeIntValue(pIn1);
1417   switch( pOp->opcode ){
1418     case OP_BitAnd:      a &= b;     break;
1419     case OP_BitOr:       a |= b;     break;
1420     case OP_ShiftLeft:   a <<= b;    break;
1421     default:  assert( pOp->opcode==OP_ShiftRight );
1422                          a >>= b;    break;
1423   }
1424   pOut->u.i = a;
1425   MemSetTypeFlag(pOut, MEM_Int);
1426   break;
1427 }
1428 
1429 /* Opcode: AddImm  P1 P2 * * *
1430 **
1431 ** Add the constant P2 to the value in register P1.
1432 ** The result is always an integer.
1433 **
1434 ** To force any register to be an integer, just add 0.
1435 */
1436 case OP_AddImm: {            /* in1 */
1437   sqlite3VdbeMemIntegerify(pIn1);
1438   pIn1->u.i += pOp->p2;
1439   break;
1440 }
1441 
1442 /* Opcode: ForceInt P1 P2 P3 * *
1443 **
1444 ** Convert value in register P1 into an integer.  If the value
1445 ** in P1 is not numeric (meaning that is is a NULL or a string that
1446 ** does not look like an integer or floating point number) then
1447 ** jump to P2.  If the value in P1 is numeric then
1448 ** convert it into the least integer that is greater than or equal to its
1449 ** current value if P3==0, or to the least integer that is strictly
1450 ** greater than its current value if P3==1.
1451 */
1452 case OP_ForceInt: {            /* jump, in1 */
1453   i64 v;
1454   applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
1455   if( (pIn1->flags & (MEM_Int|MEM_Real))==0 ){
1456     pc = pOp->p2 - 1;
1457     break;
1458   }
1459   if( pIn1->flags & MEM_Int ){
1460     v = pIn1->u.i + (pOp->p3!=0);
1461   }else{
1462     assert( pIn1->flags & MEM_Real );
1463     v = (sqlite3_int64)pIn1->r;
1464     if( pIn1->r>(double)v ) v++;
1465     if( pOp->p3 && pIn1->r==(double)v ) v++;
1466   }
1467   pIn1->u.i = v;
1468   MemSetTypeFlag(pIn1, MEM_Int);
1469   break;
1470 }
1471 
1472 /* Opcode: MustBeInt P1 P2 * * *
1473 **
1474 ** Force the value in register P1 to be an integer.  If the value
1475 ** in P1 is not an integer and cannot be converted into an integer
1476 ** without data loss, then jump immediately to P2, or if P2==0
1477 ** raise an SQLITE_MISMATCH exception.
1478 */
1479 case OP_MustBeInt: {            /* jump, in1 */
1480   applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
1481   if( (pIn1->flags & MEM_Int)==0 ){
1482     if( pOp->p2==0 ){
1483       rc = SQLITE_MISMATCH;
1484       goto abort_due_to_error;
1485     }else{
1486       pc = pOp->p2 - 1;
1487     }
1488   }else{
1489     MemSetTypeFlag(pIn1, MEM_Int);
1490   }
1491   break;
1492 }
1493 
1494 /* Opcode: RealAffinity P1 * * * *
1495 **
1496 ** If register P1 holds an integer convert it to a real value.
1497 **
1498 ** This opcode is used when extracting information from a column that
1499 ** has REAL affinity.  Such column values may still be stored as
1500 ** integers, for space efficiency, but after extraction we want them
1501 ** to have only a real value.
1502 */
1503 case OP_RealAffinity: {                  /* in1 */
1504   if( pIn1->flags & MEM_Int ){
1505     sqlite3VdbeMemRealify(pIn1);
1506   }
1507   break;
1508 }
1509 
1510 #ifndef SQLITE_OMIT_CAST
1511 /* Opcode: ToText P1 * * * *
1512 **
1513 ** Force the value in register P1 to be text.
1514 ** If the value is numeric, convert it to a string using the
1515 ** equivalent of printf().  Blob values are unchanged and
1516 ** are afterwards simply interpreted as text.
1517 **
1518 ** A NULL value is not changed by this routine.  It remains NULL.
1519 */
1520 case OP_ToText: {                  /* same as TK_TO_TEXT, in1 */
1521   if( pIn1->flags & MEM_Null ) break;
1522   assert( MEM_Str==(MEM_Blob>>3) );
1523   pIn1->flags |= (pIn1->flags&MEM_Blob)>>3;
1524   applyAffinity(pIn1, SQLITE_AFF_TEXT, encoding);
1525   rc = ExpandBlob(pIn1);
1526   assert( pIn1->flags & MEM_Str || db->mallocFailed );
1527   pIn1->flags &= ~(MEM_Int|MEM_Real|MEM_Blob);
1528   UPDATE_MAX_BLOBSIZE(pIn1);
1529   break;
1530 }
1531 
1532 /* Opcode: ToBlob P1 * * * *
1533 **
1534 ** Force the value in register P1 to be a BLOB.
1535 ** If the value is numeric, convert it to a string first.
1536 ** Strings are simply reinterpreted as blobs with no change
1537 ** to the underlying data.
1538 **
1539 ** A NULL value is not changed by this routine.  It remains NULL.
1540 */
1541 case OP_ToBlob: {                  /* same as TK_TO_BLOB, in1 */
1542   if( pIn1->flags & MEM_Null ) break;
1543   if( (pIn1->flags & MEM_Blob)==0 ){
1544     applyAffinity(pIn1, SQLITE_AFF_TEXT, encoding);
1545     assert( pIn1->flags & MEM_Str || db->mallocFailed );
1546   }
1547   MemSetTypeFlag(pIn1, MEM_Blob);
1548   UPDATE_MAX_BLOBSIZE(pIn1);
1549   break;
1550 }
1551 
1552 /* Opcode: ToNumeric P1 * * * *
1553 **
1554 ** Force the value in register P1 to be numeric (either an
1555 ** integer or a floating-point number.)
1556 ** If the value is text or blob, try to convert it to an using the
1557 ** equivalent of atoi() or atof() and store 0 if no such conversion
1558 ** is possible.
1559 **
1560 ** A NULL value is not changed by this routine.  It remains NULL.
1561 */
1562 case OP_ToNumeric: {                  /* same as TK_TO_NUMERIC, in1 */
1563   if( (pIn1->flags & (MEM_Null|MEM_Int|MEM_Real))==0 ){
1564     sqlite3VdbeMemNumerify(pIn1);
1565   }
1566   break;
1567 }
1568 #endif /* SQLITE_OMIT_CAST */
1569 
1570 /* Opcode: ToInt P1 * * * *
1571 **
1572 ** Force the value in register P1 be an integer.  If
1573 ** The value is currently a real number, drop its fractional part.
1574 ** If the value is text or blob, try to convert it to an integer using the
1575 ** equivalent of atoi() and store 0 if no such conversion is possible.
1576 **
1577 ** A NULL value is not changed by this routine.  It remains NULL.
1578 */
1579 case OP_ToInt: {                  /* same as TK_TO_INT, in1 */
1580   if( (pIn1->flags & MEM_Null)==0 ){
1581     sqlite3VdbeMemIntegerify(pIn1);
1582   }
1583   break;
1584 }
1585 
1586 #ifndef SQLITE_OMIT_CAST
1587 /* Opcode: ToReal P1 * * * *
1588 **
1589 ** Force the value in register P1 to be a floating point number.
1590 ** If The value is currently an integer, convert it.
1591 ** If the value is text or blob, try to convert it to an integer using the
1592 ** equivalent of atoi() and store 0.0 if no such conversion is possible.
1593 **
1594 ** A NULL value is not changed by this routine.  It remains NULL.
1595 */
1596 case OP_ToReal: {                  /* same as TK_TO_REAL, in1 */
1597   if( (pIn1->flags & MEM_Null)==0 ){
1598     sqlite3VdbeMemRealify(pIn1);
1599   }
1600   break;
1601 }
1602 #endif /* SQLITE_OMIT_CAST */
1603 
1604 /* Opcode: Lt P1 P2 P3 P4 P5
1605 **
1606 ** Compare the values in register P1 and P3.  If reg(P3)<reg(P1) then
1607 ** jump to address P2.
1608 **
1609 ** If the SQLITE_JUMPIFNULL bit of P5 is set and either reg(P1) or
1610 ** reg(P3) is NULL then take the jump.  If the SQLITE_JUMPIFNULL
1611 ** bit is clear then fall thru if either operand is NULL.
1612 **
1613 ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
1614 ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
1615 ** to coerce both inputs according to this affinity before the
1616 ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
1617 ** affinity is used. Note that the affinity conversions are stored
1618 ** back into the input registers P1 and P3.  So this opcode can cause
1619 ** persistent changes to registers P1 and P3.
1620 **
1621 ** Once any conversions have taken place, and neither value is NULL,
1622 ** the values are compared. If both values are blobs then memcmp() is
1623 ** used to determine the results of the comparison.  If both values
1624 ** are text, then the appropriate collating function specified in
1625 ** P4 is  used to do the comparison.  If P4 is not specified then
1626 ** memcmp() is used to compare text string.  If both values are
1627 ** numeric, then a numeric comparison is used. If the two values
1628 ** are of different types, then numbers are considered less than
1629 ** strings and strings are considered less than blobs.
1630 **
1631 ** If the SQLITE_STOREP2 bit of P5 is set, then do not jump.  Instead,
1632 ** store a boolean result (either 0, or 1, or NULL) in register P2.
1633 */
1634 /* Opcode: Ne P1 P2 P3 P4 P5
1635 **
1636 ** This works just like the Lt opcode except that the jump is taken if
1637 ** the operands in registers P1 and P3 are not equal.  See the Lt opcode for
1638 ** additional information.
1639 */
1640 /* Opcode: Eq P1 P2 P3 P4 P5
1641 **
1642 ** This works just like the Lt opcode except that the jump is taken if
1643 ** the operands in registers P1 and P3 are equal.
1644 ** See the Lt opcode for additional information.
1645 */
1646 /* Opcode: Le P1 P2 P3 P4 P5
1647 **
1648 ** This works just like the Lt opcode except that the jump is taken if
1649 ** the content of register P3 is less than or equal to the content of
1650 ** register P1.  See the Lt opcode for additional information.
1651 */
1652 /* Opcode: Gt P1 P2 P3 P4 P5
1653 **
1654 ** This works just like the Lt opcode except that the jump is taken if
1655 ** the content of register P3 is greater than the content of
1656 ** register P1.  See the Lt opcode for additional information.
1657 */
1658 /* Opcode: Ge P1 P2 P3 P4 P5
1659 **
1660 ** This works just like the Lt opcode except that the jump is taken if
1661 ** the content of register P3 is greater than or equal to the content of
1662 ** register P1.  See the Lt opcode for additional information.
1663 */
1664 case OP_Eq:               /* same as TK_EQ, jump, in1, in3 */
1665 case OP_Ne:               /* same as TK_NE, jump, in1, in3 */
1666 case OP_Lt:               /* same as TK_LT, jump, in1, in3 */
1667 case OP_Le:               /* same as TK_LE, jump, in1, in3 */
1668 case OP_Gt:               /* same as TK_GT, jump, in1, in3 */
1669 case OP_Ge: {             /* same as TK_GE, jump, in1, in3 */
1670   int flags;
1671   int res;
1672   char affinity;
1673 
1674   flags = pIn1->flags|pIn3->flags;
1675 
1676   if( flags&MEM_Null ){
1677     /* If either operand is NULL then the result is always NULL.
1678     ** The jump is taken if the SQLITE_JUMPIFNULL bit is set.
1679     */
1680     if( pOp->p5 & SQLITE_STOREP2 ){
1681       pOut = &p->aMem[pOp->p2];
1682       MemSetTypeFlag(pOut, MEM_Null);
1683       REGISTER_TRACE(pOp->p2, pOut);
1684     }else if( pOp->p5 & SQLITE_JUMPIFNULL ){
1685       pc = pOp->p2-1;
1686     }
1687     break;
1688   }
1689 
1690   affinity = pOp->p5 & SQLITE_AFF_MASK;
1691   if( affinity ){
1692     applyAffinity(pIn1, affinity, encoding);
1693     applyAffinity(pIn3, affinity, encoding);
1694   }
1695 
1696   assert( pOp->p4type==P4_COLLSEQ || pOp->p4.pColl==0 );
1697   ExpandBlob(pIn1);
1698   ExpandBlob(pIn3);
1699   res = sqlite3MemCompare(pIn3, pIn1, pOp->p4.pColl);
1700   switch( pOp->opcode ){
1701     case OP_Eq:    res = res==0;     break;
1702     case OP_Ne:    res = res!=0;     break;
1703     case OP_Lt:    res = res<0;      break;
1704     case OP_Le:    res = res<=0;     break;
1705     case OP_Gt:    res = res>0;      break;
1706     default:       res = res>=0;     break;
1707   }
1708 
1709   if( pOp->p5 & SQLITE_STOREP2 ){
1710     pOut = &p->aMem[pOp->p2];
1711     MemSetTypeFlag(pOut, MEM_Int);
1712     pOut->u.i = res;
1713     REGISTER_TRACE(pOp->p2, pOut);
1714   }else if( res ){
1715     pc = pOp->p2-1;
1716   }
1717   break;
1718 }
1719 
1720 /* Opcode: Permutation * * * P4 *
1721 **
1722 ** Set the permuation used by the OP_Compare operator to be the array
1723 ** of integers in P4.
1724 **
1725 ** The permutation is only valid until the next OP_Permutation, OP_Compare,
1726 ** OP_Halt, or OP_ResultRow.  Typically the OP_Permutation should occur
1727 ** immediately prior to the OP_Compare.
1728 */
1729 case OP_Permutation: {
1730   assert( pOp->p4type==P4_INTARRAY );
1731   assert( pOp->p4.ai );
1732   aPermute = pOp->p4.ai;
1733   break;
1734 }
1735 
1736 /* Opcode: Compare P1 P2 P3 P4 *
1737 **
1738 ** Compare to vectors of registers in reg(P1)..reg(P1+P3-1) (all this
1739 ** one "A") and in reg(P2)..reg(P2+P3-1) ("B").  Save the result of
1740 ** the comparison for use by the next OP_Jump instruct.
1741 **
1742 ** P4 is a KeyInfo structure that defines collating sequences and sort
1743 ** orders for the comparison.  The permutation applies to registers
1744 ** only.  The KeyInfo elements are used sequentially.
1745 **
1746 ** The comparison is a sort comparison, so NULLs compare equal,
1747 ** NULLs are less than numbers, numbers are less than strings,
1748 ** and strings are less than blobs.
1749 */
1750 case OP_Compare: {
1751   int n = pOp->p3;
1752   int i, p1, p2;
1753   const KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
1754   assert( n>0 );
1755   assert( pKeyInfo!=0 );
1756   p1 = pOp->p1;
1757   assert( p1>0 && p1+n-1<p->nMem );
1758   p2 = pOp->p2;
1759   assert( p2>0 && p2+n-1<p->nMem );
1760   for(i=0; i<n; i++){
1761     int idx = aPermute ? aPermute[i] : i;
1762     CollSeq *pColl;    /* Collating sequence to use on this term */
1763     int bRev;          /* True for DESCENDING sort order */
1764     REGISTER_TRACE(p1+idx, &p->aMem[p1+idx]);
1765     REGISTER_TRACE(p2+idx, &p->aMem[p2+idx]);
1766     assert( i<pKeyInfo->nField );
1767     pColl = pKeyInfo->aColl[i];
1768     bRev = pKeyInfo->aSortOrder[i];
1769     iCompare = sqlite3MemCompare(&p->aMem[p1+idx], &p->aMem[p2+idx], pColl);
1770     if( iCompare ){
1771       if( bRev ) iCompare = -iCompare;
1772       break;
1773     }
1774   }
1775   aPermute = 0;
1776   break;
1777 }
1778 
1779 /* Opcode: Jump P1 P2 P3 * *
1780 **
1781 ** Jump to the instruction at address P1, P2, or P3 depending on whether
1782 ** in the most recent OP_Compare instruction the P1 vector was less than
1783 ** equal to, or greater than the P2 vector, respectively.
1784 */
1785 case OP_Jump: {             /* jump */
1786   if( iCompare<0 ){
1787     pc = pOp->p1 - 1;
1788   }else if( iCompare==0 ){
1789     pc = pOp->p2 - 1;
1790   }else{
1791     pc = pOp->p3 - 1;
1792   }
1793   break;
1794 }
1795 
1796 /* Opcode: And P1 P2 P3 * *
1797 **
1798 ** Take the logical AND of the values in registers P1 and P2 and
1799 ** write the result into register P3.
1800 **
1801 ** If either P1 or P2 is 0 (false) then the result is 0 even if
1802 ** the other input is NULL.  A NULL and true or two NULLs give
1803 ** a NULL output.
1804 */
1805 /* Opcode: Or P1 P2 P3 * *
1806 **
1807 ** Take the logical OR of the values in register P1 and P2 and
1808 ** store the answer in register P3.
1809 **
1810 ** If either P1 or P2 is nonzero (true) then the result is 1 (true)
1811 ** even if the other input is NULL.  A NULL and false or two NULLs
1812 ** give a NULL output.
1813 */
1814 case OP_And:              /* same as TK_AND, in1, in2, out3 */
1815 case OP_Or: {             /* same as TK_OR, in1, in2, out3 */
1816   int v1, v2;    /* 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
1817 
1818   if( pIn1->flags & MEM_Null ){
1819     v1 = 2;
1820   }else{
1821     v1 = sqlite3VdbeIntValue(pIn1)!=0;
1822   }
1823   if( pIn2->flags & MEM_Null ){
1824     v2 = 2;
1825   }else{
1826     v2 = sqlite3VdbeIntValue(pIn2)!=0;
1827   }
1828   if( pOp->opcode==OP_And ){
1829     static const unsigned char and_logic[] = { 0, 0, 0, 0, 1, 2, 0, 2, 2 };
1830     v1 = and_logic[v1*3+v2];
1831   }else{
1832     static const unsigned char or_logic[] = { 0, 1, 2, 1, 1, 1, 2, 1, 2 };
1833     v1 = or_logic[v1*3+v2];
1834   }
1835   if( v1==2 ){
1836     MemSetTypeFlag(pOut, MEM_Null);
1837   }else{
1838     pOut->u.i = v1;
1839     MemSetTypeFlag(pOut, MEM_Int);
1840   }
1841   break;
1842 }
1843 
1844 /* Opcode: Not P1 * * * *
1845 **
1846 ** Interpret the value in register P1 as a boolean value.  Replace it
1847 ** with its complement.  If the value in register P1 is NULL its value
1848 ** is unchanged.
1849 */
1850 case OP_Not: {                /* same as TK_NOT, in1 */
1851   if( pIn1->flags & MEM_Null ) break;  /* Do nothing to NULLs */
1852   sqlite3VdbeMemIntegerify(pIn1);
1853   pIn1->u.i = !pIn1->u.i;
1854   assert( pIn1->flags&MEM_Int );
1855   break;
1856 }
1857 
1858 /* Opcode: BitNot P1 * * * *
1859 **
1860 ** Interpret the content of register P1 as an integer.  Replace it
1861 ** with its ones-complement.  If the value is originally NULL, leave
1862 ** it unchanged.
1863 */
1864 case OP_BitNot: {             /* same as TK_BITNOT, in1 */
1865   if( pIn1->flags & MEM_Null ) break;  /* Do nothing to NULLs */
1866   sqlite3VdbeMemIntegerify(pIn1);
1867   pIn1->u.i = ~pIn1->u.i;
1868   assert( pIn1->flags&MEM_Int );
1869   break;
1870 }
1871 
1872 /* Opcode: If P1 P2 P3 * *
1873 **
1874 ** Jump to P2 if the value in register P1 is true.  The value is
1875 ** is considered true if it is numeric and non-zero.  If the value
1876 ** in P1 is NULL then take the jump if P3 is true.
1877 */
1878 /* Opcode: IfNot P1 P2 P3 * *
1879 **
1880 ** Jump to P2 if the value in register P1 is False.  The value is
1881 ** is considered true if it has a numeric value of zero.  If the value
1882 ** in P1 is NULL then take the jump if P3 is true.
1883 */
1884 case OP_If:                 /* jump, in1 */
1885 case OP_IfNot: {            /* jump, in1 */
1886   int c;
1887   if( pIn1->flags & MEM_Null ){
1888     c = pOp->p3;
1889   }else{
1890 #ifdef SQLITE_OMIT_FLOATING_POINT
1891     c = sqlite3VdbeIntValue(pIn1);
1892 #else
1893     c = sqlite3VdbeRealValue(pIn1)!=0.0;
1894 #endif
1895     if( pOp->opcode==OP_IfNot ) c = !c;
1896   }
1897   if( c ){
1898     pc = pOp->p2-1;
1899   }
1900   break;
1901 }
1902 
1903 /* Opcode: IsNull P1 P2 P3 * *
1904 **
1905 ** Jump to P2 if the value in register P1 is NULL.  If P3 is greater
1906 ** than zero, then check all values reg(P1), reg(P1+1),
1907 ** reg(P1+2), ..., reg(P1+P3-1).
1908 */
1909 case OP_IsNull: {            /* same as TK_ISNULL, jump, in1 */
1910   int n = pOp->p3;
1911   assert( pOp->p3==0 || pOp->p1>0 );
1912   do{
1913     if( (pIn1->flags & MEM_Null)!=0 ){
1914       pc = pOp->p2 - 1;
1915       break;
1916     }
1917     pIn1++;
1918   }while( --n > 0 );
1919   break;
1920 }
1921 
1922 /* Opcode: NotNull P1 P2 * * *
1923 **
1924 ** Jump to P2 if the value in register P1 is not NULL.
1925 */
1926 case OP_NotNull: {            /* same as TK_NOTNULL, jump, in1 */
1927   if( (pIn1->flags & MEM_Null)==0 ){
1928     pc = pOp->p2 - 1;
1929   }
1930   break;
1931 }
1932 
1933 /* Opcode: SetNumColumns * P2 * * *
1934 **
1935 ** This opcode sets the number of columns for the cursor opened by the
1936 ** following instruction to P2.
1937 **
1938 ** An OP_SetNumColumns is only useful if it occurs immediately before
1939 ** one of the following opcodes:
1940 **
1941 **     OpenRead
1942 **     OpenWrite
1943 **     OpenPseudo
1944 **
1945 ** If the OP_Column opcode is to be executed on a cursor, then
1946 ** this opcode must be present immediately before the opcode that
1947 ** opens the cursor.
1948 */
1949 case OP_SetNumColumns: {
1950   break;
1951 }
1952 
1953 /* Opcode: Column P1 P2 P3 P4 *
1954 **
1955 ** Interpret the data that cursor P1 points to as a structure built using
1956 ** the MakeRecord instruction.  (See the MakeRecord opcode for additional
1957 ** information about the format of the data.)  Extract the P2-th column
1958 ** from this record.  If there are less that (P2+1)
1959 ** values in the record, extract a NULL.
1960 **
1961 ** The value extracted is stored in register P3.
1962 **
1963 ** If the KeyAsData opcode has previously executed on this cursor, then the
1964 ** field might be extracted from the key rather than the data.
1965 **
1966 ** If the column contains fewer than P2 fields, then extract a NULL.  Or,
1967 ** if the P4 argument is a P4_MEM use the value of the P4 argument as
1968 ** the result.
1969 */
1970 case OP_Column: {
1971   u32 payloadSize;   /* Number of bytes in the record */
1972   int p1 = pOp->p1;  /* P1 value of the opcode */
1973   int p2 = pOp->p2;  /* column number to retrieve */
1974   Cursor *pC = 0;    /* The VDBE cursor */
1975   char *zRec;        /* Pointer to complete record-data */
1976   BtCursor *pCrsr;   /* The BTree cursor */
1977   u32 *aType;        /* aType[i] holds the numeric type of the i-th column */
1978   u32 *aOffset;      /* aOffset[i] is offset to start of data for i-th column */
1979   u32 nField;        /* number of fields in the record */
1980   int len;           /* The length of the serialized data for the column */
1981   int i;             /* Loop counter */
1982   char *zData;       /* Part of the record being decoded */
1983   Mem *pDest;        /* Where to write the extracted value */
1984   Mem sMem;          /* For storing the record being decoded */
1985 
1986   sMem.flags = 0;
1987   sMem.db = 0;
1988   sMem.zMalloc = 0;
1989   assert( p1<p->nCursor );
1990   assert( pOp->p3>0 && pOp->p3<=p->nMem );
1991   pDest = &p->aMem[pOp->p3];
1992   MemSetTypeFlag(pDest, MEM_Null);
1993 
1994   /* This block sets the variable payloadSize to be the total number of
1995   ** bytes in the record.
1996   **
1997   ** zRec is set to be the complete text of the record if it is available.
1998   ** The complete record text is always available for pseudo-tables
1999   ** If the record is stored in a cursor, the complete record text
2000   ** might be available in the  pC->aRow cache.  Or it might not be.
2001   ** If the data is unavailable,  zRec is set to NULL.
2002   **
2003   ** We also compute the number of columns in the record.  For cursors,
2004   ** the number of columns is stored in the Cursor.nField element.
2005   */
2006   pC = p->apCsr[p1];
2007   assert( pC!=0 );
2008 #ifndef SQLITE_OMIT_VIRTUALTABLE
2009   assert( pC->pVtabCursor==0 );
2010 #endif
2011   if( pC->pCursor!=0 ){
2012     /* The record is stored in a B-Tree */
2013     rc = sqlite3VdbeCursorMoveto(pC);
2014     if( rc ) goto abort_due_to_error;
2015     zRec = 0;
2016     pCrsr = pC->pCursor;
2017     if( pC->nullRow ){
2018       payloadSize = 0;
2019     }else if( pC->cacheStatus==p->cacheCtr ){
2020       payloadSize = pC->payloadSize;
2021       zRec = (char*)pC->aRow;
2022     }else if( pC->isIndex ){
2023       i64 payloadSize64;
2024       sqlite3BtreeKeySize(pCrsr, &payloadSize64);
2025       payloadSize = payloadSize64;
2026     }else{
2027       sqlite3BtreeDataSize(pCrsr, &payloadSize);
2028     }
2029     nField = pC->nField;
2030   }else{
2031     assert( pC->pseudoTable );
2032     /* The record is the sole entry of a pseudo-table */
2033     payloadSize = pC->nData;
2034     zRec = pC->pData;
2035     pC->cacheStatus = CACHE_STALE;
2036     assert( payloadSize==0 || zRec!=0 );
2037     nField = pC->nField;
2038     pCrsr = 0;
2039   }
2040 
2041   /* If payloadSize is 0, then just store a NULL */
2042   if( payloadSize==0 ){
2043     assert( pDest->flags&MEM_Null );
2044     goto op_column_out;
2045   }
2046   if( payloadSize>db->aLimit[SQLITE_LIMIT_LENGTH] ){
2047     goto too_big;
2048   }
2049 
2050   assert( p2<nField );
2051 
2052   /* Read and parse the table header.  Store the results of the parse
2053   ** into the record header cache fields of the cursor.
2054   */
2055   aType = pC->aType;
2056   if( pC->cacheStatus==p->cacheCtr ){
2057     aOffset = pC->aOffset;
2058   }else{
2059     u8 *zIdx;        /* Index into header */
2060     u8 *zEndHdr;     /* Pointer to first byte after the header */
2061     u32 offset;      /* Offset into the data */
2062     int szHdrSz;     /* Size of the header size field at start of record */
2063     int avail;       /* Number of bytes of available data */
2064 
2065     assert(aType);
2066     pC->aOffset = aOffset = &aType[nField];
2067     pC->payloadSize = payloadSize;
2068     pC->cacheStatus = p->cacheCtr;
2069 
2070     /* Figure out how many bytes are in the header */
2071     if( zRec ){
2072       zData = zRec;
2073     }else{
2074       if( pC->isIndex ){
2075         zData = (char*)sqlite3BtreeKeyFetch(pCrsr, &avail);
2076       }else{
2077         zData = (char*)sqlite3BtreeDataFetch(pCrsr, &avail);
2078       }
2079       /* If KeyFetch()/DataFetch() managed to get the entire payload,
2080       ** save the payload in the pC->aRow cache.  That will save us from
2081       ** having to make additional calls to fetch the content portion of
2082       ** the record.
2083       */
2084       if( avail>=payloadSize ){
2085         zRec = zData;
2086         pC->aRow = (u8*)zData;
2087       }else{
2088         pC->aRow = 0;
2089       }
2090     }
2091     /* The following assert is true in all cases accept when
2092     ** the database file has been corrupted externally.
2093     **    assert( zRec!=0 || avail>=payloadSize || avail>=9 ); */
2094     szHdrSz = getVarint32((u8*)zData, offset);
2095 
2096     /* The KeyFetch() or DataFetch() above are fast and will get the entire
2097     ** record header in most cases.  But they will fail to get the complete
2098     ** record header if the record header does not fit on a single page
2099     ** in the B-Tree.  When that happens, use sqlite3VdbeMemFromBtree() to
2100     ** acquire the complete header text.
2101     */
2102     if( !zRec && avail<offset ){
2103       sMem.flags = 0;
2104       sMem.db = 0;
2105       rc = sqlite3VdbeMemFromBtree(pCrsr, 0, offset, pC->isIndex, &sMem);
2106       if( rc!=SQLITE_OK ){
2107         goto op_column_out;
2108       }
2109       zData = sMem.z;
2110     }
2111     zEndHdr = (u8 *)&zData[offset];
2112     zIdx = (u8 *)&zData[szHdrSz];
2113 
2114     /* Scan the header and use it to fill in the aType[] and aOffset[]
2115     ** arrays.  aType[i] will contain the type integer for the i-th
2116     ** column and aOffset[i] will contain the offset from the beginning
2117     ** of the record to the start of the data for the i-th column
2118     */
2119     for(i=0; i<nField; i++){
2120       if( zIdx<zEndHdr ){
2121         aOffset[i] = offset;
2122         zIdx += getVarint32(zIdx, aType[i]);
2123         offset += sqlite3VdbeSerialTypeLen(aType[i]);
2124       }else{
2125         /* If i is less that nField, then there are less fields in this
2126         ** record than SetNumColumns indicated there are columns in the
2127         ** table. Set the offset for any extra columns not present in
2128         ** the record to 0. This tells code below to store a NULL
2129         ** instead of deserializing a value from the record.
2130         */
2131         aOffset[i] = 0;
2132       }
2133     }
2134     sqlite3VdbeMemRelease(&sMem);
2135     sMem.flags = MEM_Null;
2136 
2137     /* If we have read more header data than was contained in the header,
2138     ** or if the end of the last field appears to be past the end of the
2139     ** record, or if the end of the last field appears to be before the end
2140     ** of the record (when all fields present), then we must be dealing
2141     ** with a corrupt database.
2142     */
2143     if( zIdx>zEndHdr || offset>payloadSize || (zIdx==zEndHdr && offset!=payloadSize) ){
2144       rc = SQLITE_CORRUPT_BKPT;
2145       goto op_column_out;
2146     }
2147   }
2148 
2149   /* Get the column information. If aOffset[p2] is non-zero, then
2150   ** deserialize the value from the record. If aOffset[p2] is zero,
2151   ** then there are not enough fields in the record to satisfy the
2152   ** request.  In this case, set the value NULL or to P4 if P4 is
2153   ** a pointer to a Mem object.
2154   */
2155   if( aOffset[p2] ){
2156     assert( rc==SQLITE_OK );
2157     if( zRec ){
2158       if( pDest->flags&MEM_Dyn ){
2159         sqlite3VdbeSerialGet((u8 *)&zRec[aOffset[p2]], aType[p2], &sMem);
2160         sMem.db = db;
2161         rc = sqlite3VdbeMemCopy(pDest, &sMem);
2162         assert( !(sMem.flags&MEM_Dyn) );
2163         if( rc!=SQLITE_OK ){
2164           goto op_column_out;
2165         }
2166       }else{
2167         sqlite3VdbeSerialGet((u8 *)&zRec[aOffset[p2]], aType[p2], pDest);
2168       }
2169     }else{
2170       len = sqlite3VdbeSerialTypeLen(aType[p2]);
2171       sqlite3VdbeMemMove(&sMem, pDest);
2172       rc = sqlite3VdbeMemFromBtree(pCrsr, aOffset[p2], len, pC->isIndex, &sMem);
2173       if( rc!=SQLITE_OK ){
2174         goto op_column_out;
2175       }
2176       zData = sMem.z;
2177       sqlite3VdbeSerialGet((u8*)zData, aType[p2], pDest);
2178     }
2179     pDest->enc = encoding;
2180   }else{
2181     if( pOp->p4type==P4_MEM ){
2182       sqlite3VdbeMemShallowCopy(pDest, pOp->p4.pMem, MEM_Static);
2183     }else{
2184       assert( pDest->flags&MEM_Null );
2185     }
2186   }
2187 
2188   /* If we dynamically allocated space to hold the data (in the
2189   ** sqlite3VdbeMemFromBtree() call above) then transfer control of that
2190   ** dynamically allocated space over to the pDest structure.
2191   ** This prevents a memory copy.
2192   */
2193   if( sMem.zMalloc ){
2194     assert( sMem.z==sMem.zMalloc );
2195     assert( !(pDest->flags & MEM_Dyn) );
2196     assert( !(pDest->flags & (MEM_Blob|MEM_Str)) || pDest->z==sMem.z );
2197     pDest->flags &= ~(MEM_Ephem|MEM_Static);
2198     pDest->flags |= MEM_Term;
2199     pDest->z = sMem.z;
2200     pDest->zMalloc = sMem.zMalloc;
2201   }
2202 
2203   rc = sqlite3VdbeMemMakeWriteable(pDest);
2204 
2205 op_column_out:
2206   UPDATE_MAX_BLOBSIZE(pDest);
2207   REGISTER_TRACE(pOp->p3, pDest);
2208   break;
2209 }
2210 
2211 /* Opcode: Affinity P1 P2 * P4 *
2212 **
2213 ** Apply affinities to a range of P2 registers starting with P1.
2214 **
2215 ** P4 is a string that is P2 characters long. The nth character of the
2216 ** string indicates the column affinity that should be used for the nth
2217 ** memory cell in the range.
2218 */
2219 case OP_Affinity: {
2220   char *zAffinity = pOp->p4.z;
2221   Mem *pData0 = &p->aMem[pOp->p1];
2222   Mem *pLast = &pData0[pOp->p2-1];
2223   Mem *pRec;
2224 
2225   for(pRec=pData0; pRec<=pLast; pRec++){
2226     ExpandBlob(pRec);
2227     applyAffinity(pRec, zAffinity[pRec-pData0], encoding);
2228   }
2229   break;
2230 }
2231 
2232 /* Opcode: MakeRecord P1 P2 P3 P4 *
2233 **
2234 ** Convert P2 registers beginning with P1 into a single entry
2235 ** suitable for use as a data record in a database table or as a key
2236 ** in an index.  The details of the format are irrelevant as long as
2237 ** the OP_Column opcode can decode the record later.
2238 ** Refer to source code comments for the details of the record
2239 ** format.
2240 **
2241 ** P4 may be a string that is P2 characters long.  The nth character of the
2242 ** string indicates the column affinity that should be used for the nth
2243 ** field of the index key.
2244 **
2245 ** The mapping from character to affinity is given by the SQLITE_AFF_
2246 ** macros defined in sqliteInt.h.
2247 **
2248 ** If P4 is NULL then all index fields have the affinity NONE.
2249 */
2250 case OP_MakeRecord: {
2251   /* Assuming the record contains N fields, the record format looks
2252   ** like this:
2253   **
2254   ** ------------------------------------------------------------------------
2255   ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
2256   ** ------------------------------------------------------------------------
2257   **
2258   ** Data(0) is taken from register P1.  Data(1) comes from register P1+1
2259   ** and so froth.
2260   **
2261   ** Each type field is a varint representing the serial type of the
2262   ** corresponding data element (see sqlite3VdbeSerialType()). The
2263   ** hdr-size field is also a varint which is the offset from the beginning
2264   ** of the record to data0.
2265   */
2266   u8 *zNewRecord;        /* A buffer to hold the data for the new record */
2267   Mem *pRec;             /* The new record */
2268   u64 nData = 0;         /* Number of bytes of data space */
2269   int nHdr = 0;          /* Number of bytes of header space */
2270   u64 nByte = 0;         /* Data space required for this record */
2271   int nZero = 0;         /* Number of zero bytes at the end of the record */
2272   int nVarint;           /* Number of bytes in a varint */
2273   u32 serial_type;       /* Type field */
2274   Mem *pData0;           /* First field to be combined into the record */
2275   Mem *pLast;            /* Last field of the record */
2276   int nField;            /* Number of fields in the record */
2277   char *zAffinity;       /* The affinity string for the record */
2278   int file_format;       /* File format to use for encoding */
2279   int i;                 /* Space used in zNewRecord[] */
2280 
2281   nField = pOp->p1;
2282   zAffinity = pOp->p4.z;
2283   assert( nField>0 && pOp->p2>0 && pOp->p2+nField<=p->nMem );
2284   pData0 = &p->aMem[nField];
2285   nField = pOp->p2;
2286   pLast = &pData0[nField-1];
2287   file_format = p->minWriteFileFormat;
2288 
2289   /* Loop through the elements that will make up the record to figure
2290   ** out how much space is required for the new record.
2291   */
2292   for(pRec=pData0; pRec<=pLast; pRec++){
2293     int len;
2294     if( zAffinity ){
2295       applyAffinity(pRec, zAffinity[pRec-pData0], encoding);
2296     }
2297     if( pRec->flags&MEM_Zero && pRec->n>0 ){
2298       sqlite3VdbeMemExpandBlob(pRec);
2299     }
2300     serial_type = sqlite3VdbeSerialType(pRec, file_format);
2301     len = sqlite3VdbeSerialTypeLen(serial_type);
2302     nData += len;
2303     nHdr += sqlite3VarintLen(serial_type);
2304     if( pRec->flags & MEM_Zero ){
2305       /* Only pure zero-filled BLOBs can be input to this Opcode.
2306       ** We do not allow blobs with a prefix and a zero-filled tail. */
2307       nZero += pRec->u.i;
2308     }else if( len ){
2309       nZero = 0;
2310     }
2311   }
2312 
2313   /* Add the initial header varint and total the size */
2314   nHdr += nVarint = sqlite3VarintLen(nHdr);
2315   if( nVarint<sqlite3VarintLen(nHdr) ){
2316     nHdr++;
2317   }
2318   nByte = nHdr+nData-nZero;
2319   if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
2320     goto too_big;
2321   }
2322 
2323   /* Make sure the output register has a buffer large enough to store
2324   ** the new record. The output register (pOp->p3) is not allowed to
2325   ** be one of the input registers (because the following call to
2326   ** sqlite3VdbeMemGrow() could clobber the value before it is used).
2327   */
2328   assert( pOp->p3<pOp->p1 || pOp->p3>=pOp->p1+pOp->p2 );
2329   pOut = &p->aMem[pOp->p3];
2330   if( sqlite3VdbeMemGrow(pOut, nByte, 0) ){
2331     goto no_mem;
2332   }
2333   zNewRecord = (u8 *)pOut->z;
2334 
2335   /* Write the record */
2336   i = putVarint32(zNewRecord, nHdr);
2337   for(pRec=pData0; pRec<=pLast; pRec++){
2338     serial_type = sqlite3VdbeSerialType(pRec, file_format);
2339     i += putVarint32(&zNewRecord[i], serial_type);      /* serial type */
2340   }
2341   for(pRec=pData0; pRec<=pLast; pRec++){  /* serial data */
2342     i += sqlite3VdbeSerialPut(&zNewRecord[i], nByte-i, pRec, file_format);
2343   }
2344   assert( i==nByte );
2345 
2346   assert( pOp->p3>0 && pOp->p3<=p->nMem );
2347   pOut->n = nByte;
2348   pOut->flags = MEM_Blob | MEM_Dyn;
2349   pOut->xDel = 0;
2350   if( nZero ){
2351     pOut->u.i = nZero;
2352     pOut->flags |= MEM_Zero;
2353   }
2354   pOut->enc = SQLITE_UTF8;  /* In case the blob is ever converted to text */
2355   REGISTER_TRACE(pOp->p3, pOut);
2356   UPDATE_MAX_BLOBSIZE(pOut);
2357   break;
2358 }
2359 
2360 /* Opcode: Statement P1 * * * *
2361 **
2362 ** Begin an individual statement transaction which is part of a larger
2363 ** transaction.  This is needed so that the statement
2364 ** can be rolled back after an error without having to roll back the
2365 ** entire transaction.  The statement transaction will automatically
2366 ** commit when the VDBE halts.
2367 **
2368 ** If the database connection is currently in autocommit mode (that
2369 ** is to say, if it is in between BEGIN and COMMIT)
2370 ** and if there are no other active statements on the same database
2371 ** connection, then this operation is a no-op.  No statement transaction
2372 ** is needed since any error can use the normal ROLLBACK process to
2373 ** undo changes.
2374 **
2375 ** If a statement transaction is started, then a statement journal file
2376 ** will be allocated and initialized.
2377 **
2378 ** The statement is begun on the database file with index P1.  The main
2379 ** database file has an index of 0 and the file used for temporary tables
2380 ** has an index of 1.
2381 */
2382 case OP_Statement: {
2383   if( db->autoCommit==0 || db->activeVdbeCnt>1 ){
2384     int i = pOp->p1;
2385     Btree *pBt;
2386     assert( i>=0 && i<db->nDb );
2387     assert( db->aDb[i].pBt!=0 );
2388     pBt = db->aDb[i].pBt;
2389     assert( sqlite3BtreeIsInTrans(pBt) );
2390     assert( (p->btreeMask & (1<<i))!=0 );
2391     if( !sqlite3BtreeIsInStmt(pBt) ){
2392       rc = sqlite3BtreeBeginStmt(pBt);
2393       p->openedStatement = 1;
2394     }
2395   }
2396   break;
2397 }
2398 
2399 /* Opcode: AutoCommit P1 P2 * * *
2400 **
2401 ** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
2402 ** back any currently active btree transactions. If there are any active
2403 ** VMs (apart from this one), then the COMMIT or ROLLBACK statement fails.
2404 **
2405 ** This instruction causes the VM to halt.
2406 */
2407 case OP_AutoCommit: {
2408   u8 i = pOp->p1;
2409   u8 rollback = pOp->p2;
2410 
2411   assert( i==1 || i==0 );
2412   assert( i==1 || rollback==0 );
2413 
2414   assert( db->activeVdbeCnt>0 );  /* At least this one VM is active */
2415 
2416   if( db->activeVdbeCnt>1 && i && !db->autoCommit ){
2417     /* If this instruction implements a COMMIT or ROLLBACK, other VMs are
2418     ** still running, and a transaction is active, return an error indicating
2419     ** that the other VMs must complete first.
2420     */
2421     sqlite3SetString(&p->zErrMsg, db, "cannot %s transaction - "
2422         "SQL statements in progress",
2423         rollback ? "rollback" : "commit");
2424     rc = SQLITE_ERROR;
2425   }else if( i!=db->autoCommit ){
2426     if( pOp->p2 ){
2427       assert( i==1 );
2428       sqlite3RollbackAll(db);
2429       db->autoCommit = 1;
2430     }else{
2431       db->autoCommit = i;
2432       if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
2433         p->pc = pc;
2434         db->autoCommit = 1-i;
2435         p->rc = rc = SQLITE_BUSY;
2436         goto vdbe_return;
2437       }
2438     }
2439     if( p->rc==SQLITE_OK ){
2440       rc = SQLITE_DONE;
2441     }else{
2442       rc = SQLITE_ERROR;
2443     }
2444     goto vdbe_return;
2445   }else{
2446     sqlite3SetString(&p->zErrMsg, db,
2447         (!i)?"cannot start a transaction within a transaction":(
2448         (rollback)?"cannot rollback - no transaction is active":
2449                    "cannot commit - no transaction is active"));
2450 
2451     rc = SQLITE_ERROR;
2452   }
2453   break;
2454 }
2455 
2456 /* Opcode: Transaction P1 P2 * * *
2457 **
2458 ** Begin a transaction.  The transaction ends when a Commit or Rollback
2459 ** opcode is encountered.  Depending on the ON CONFLICT setting, the
2460 ** transaction might also be rolled back if an error is encountered.
2461 **
2462 ** P1 is the index of the database file on which the transaction is
2463 ** started.  Index 0 is the main database file and index 1 is the
2464 ** file used for temporary tables.  Indices of 2 or more are used for
2465 ** attached databases.
2466 **
2467 ** If P2 is non-zero, then a write-transaction is started.  A RESERVED lock is
2468 ** obtained on the database file when a write-transaction is started.  No
2469 ** other process can start another write transaction while this transaction is
2470 ** underway.  Starting a write transaction also creates a rollback journal. A
2471 ** write transaction must be started before any changes can be made to the
2472 ** database.  If P2 is 2 or greater then an EXCLUSIVE lock is also obtained
2473 ** on the file.
2474 **
2475 ** If P2 is zero, then a read-lock is obtained on the database file.
2476 */
2477 case OP_Transaction: {
2478   int i = pOp->p1;
2479   Btree *pBt;
2480 
2481   assert( i>=0 && i<db->nDb );
2482   assert( (p->btreeMask & (1<<i))!=0 );
2483   pBt = db->aDb[i].pBt;
2484 
2485   if( pBt ){
2486     rc = sqlite3BtreeBeginTrans(pBt, pOp->p2);
2487     if( rc==SQLITE_BUSY ){
2488       p->pc = pc;
2489       p->rc = rc = SQLITE_BUSY;
2490       goto vdbe_return;
2491     }
2492     if( rc!=SQLITE_OK && rc!=SQLITE_READONLY /* && rc!=SQLITE_BUSY */ ){
2493       goto abort_due_to_error;
2494     }
2495   }
2496   break;
2497 }
2498 
2499 /* Opcode: ReadCookie P1 P2 P3 * *
2500 **
2501 ** Read cookie number P3 from database P1 and write it into register P2.
2502 ** P3==0 is the schema version.  P3==1 is the database format.
2503 ** P3==2 is the recommended pager cache size, and so forth.  P1==0 is
2504 ** the main database file and P1==1 is the database file used to store
2505 ** temporary tables.
2506 **
2507 ** If P1 is negative, then this is a request to read the size of a
2508 ** databases free-list. P3 must be set to 1 in this case. The actual
2509 ** database accessed is ((P1+1)*-1). For example, a P1 parameter of -1
2510 ** corresponds to database 0 ("main"), a P1 of -2 is database 1 ("temp").
2511 **
2512 ** There must be a read-lock on the database (either a transaction
2513 ** must be started or there must be an open cursor) before
2514 ** executing this instruction.
2515 */
2516 case OP_ReadCookie: {               /* out2-prerelease */
2517   int iMeta;
2518   int iDb = pOp->p1;
2519   int iCookie = pOp->p3;
2520 
2521   assert( pOp->p3<SQLITE_N_BTREE_META );
2522   if( iDb<0 ){
2523     iDb = (-1*(iDb+1));
2524     iCookie *= -1;
2525   }
2526   assert( iDb>=0 && iDb<db->nDb );
2527   assert( db->aDb[iDb].pBt!=0 );
2528   assert( (p->btreeMask & (1<<iDb))!=0 );
2529   /* The indexing of meta values at the schema layer is off by one from
2530   ** the indexing in the btree layer.  The btree considers meta[0] to
2531   ** be the number of free pages in the database (a read-only value)
2532   ** and meta[1] to be the schema cookie.  The schema layer considers
2533   ** meta[1] to be the schema cookie.  So we have to shift the index
2534   ** by one in the following statement.
2535   */
2536   rc = sqlite3BtreeGetMeta(db->aDb[iDb].pBt, 1 + iCookie, (u32 *)&iMeta);
2537   pOut->u.i = iMeta;
2538   MemSetTypeFlag(pOut, MEM_Int);
2539   break;
2540 }
2541 
2542 /* Opcode: SetCookie P1 P2 P3 * *
2543 **
2544 ** Write the content of register P3 (interpreted as an integer)
2545 ** into cookie number P2 of database P1.
2546 ** P2==0 is the schema version.  P2==1 is the database format.
2547 ** P2==2 is the recommended pager cache size, and so forth.  P1==0 is
2548 ** the main database file and P1==1 is the database file used to store
2549 ** temporary tables.
2550 **
2551 ** A transaction must be started before executing this opcode.
2552 */
2553 case OP_SetCookie: {       /* in3 */
2554   Db *pDb;
2555   assert( pOp->p2<SQLITE_N_BTREE_META );
2556   assert( pOp->p1>=0 && pOp->p1<db->nDb );
2557   assert( (p->btreeMask & (1<<pOp->p1))!=0 );
2558   pDb = &db->aDb[pOp->p1];
2559   assert( pDb->pBt!=0 );
2560   sqlite3VdbeMemIntegerify(pIn3);
2561   /* See note about index shifting on OP_ReadCookie */
2562   rc = sqlite3BtreeUpdateMeta(pDb->pBt, 1+pOp->p2, (int)pIn3->u.i);
2563   if( pOp->p2==0 ){
2564     /* When the schema cookie changes, record the new cookie internally */
2565     pDb->pSchema->schema_cookie = pIn3->u.i;
2566     db->flags |= SQLITE_InternChanges;
2567   }else if( pOp->p2==1 ){
2568     /* Record changes in the file format */
2569     pDb->pSchema->file_format = pIn3->u.i;
2570   }
2571   if( pOp->p1==1 ){
2572     /* Invalidate all prepared statements whenever the TEMP database
2573     ** schema is changed.  Ticket #1644 */
2574     sqlite3ExpirePreparedStatements(db);
2575   }
2576   break;
2577 }
2578 
2579 /* Opcode: VerifyCookie P1 P2 *
2580 **
2581 ** Check the value of global database parameter number 0 (the
2582 ** schema version) and make sure it is equal to P2.
2583 ** P1 is the database number which is 0 for the main database file
2584 ** and 1 for the file holding temporary tables and some higher number
2585 ** for auxiliary databases.
2586 **
2587 ** The cookie changes its value whenever the database schema changes.
2588 ** This operation is used to detect when that the cookie has changed
2589 ** and that the current process needs to reread the schema.
2590 **
2591 ** Either a transaction needs to have been started or an OP_Open needs
2592 ** to be executed (to establish a read lock) before this opcode is
2593 ** invoked.
2594 */
2595 case OP_VerifyCookie: {
2596   int iMeta;
2597   Btree *pBt;
2598   assert( pOp->p1>=0 && pOp->p1<db->nDb );
2599   assert( (p->btreeMask & (1<<pOp->p1))!=0 );
2600   pBt = db->aDb[pOp->p1].pBt;
2601   if( pBt ){
2602     rc = sqlite3BtreeGetMeta(pBt, 1, (u32 *)&iMeta);
2603   }else{
2604     rc = SQLITE_OK;
2605     iMeta = 0;
2606   }
2607   if( rc==SQLITE_OK && iMeta!=pOp->p2 ){
2608     sqlite3_free(p->zErrMsg);
2609     p->zErrMsg = sqlite3DbStrDup(db, "database schema has changed");
2610     /* If the schema-cookie from the database file matches the cookie
2611     ** stored with the in-memory representation of the schema, do
2612     ** not reload the schema from the database file.
2613     **
2614     ** If virtual-tables are in use, this is not just an optimization.
2615     ** Often, v-tables store their data in other SQLite tables, which
2616     ** are queried from within xNext() and other v-table methods using
2617     ** prepared queries. If such a query is out-of-date, we do not want to
2618     ** discard the database schema, as the user code implementing the
2619     ** v-table would have to be ready for the sqlite3_vtab structure itself
2620     ** to be invalidated whenever sqlite3_step() is called from within
2621     ** a v-table method.
2622     */
2623     if( db->aDb[pOp->p1].pSchema->schema_cookie!=iMeta ){
2624       sqlite3ResetInternalSchema(db, pOp->p1);
2625     }
2626 
2627     sqlite3ExpirePreparedStatements(db);
2628     rc = SQLITE_SCHEMA;
2629   }
2630   break;
2631 }
2632 
2633 /* Opcode: OpenRead P1 P2 P3 P4 P5
2634 **
2635 ** Open a read-only cursor for the database table whose root page is
2636 ** P2 in a database file.  The database file is determined by P3.
2637 ** P3==0 means the main database, P3==1 means the database used for
2638 ** temporary tables, and P3>1 means used the corresponding attached
2639 ** database.  Give the new cursor an identifier of P1.  The P1
2640 ** values need not be contiguous but all P1 values should be small integers.
2641 ** It is an error for P1 to be negative.
2642 **
2643 ** If P5!=0 then use the content of register P2 as the root page, not
2644 ** the value of P2 itself.
2645 **
2646 ** There will be a read lock on the database whenever there is an
2647 ** open cursor.  If the database was unlocked prior to this instruction
2648 ** then a read lock is acquired as part of this instruction.  A read
2649 ** lock allows other processes to read the database but prohibits
2650 ** any other process from modifying the database.  The read lock is
2651 ** released when all cursors are closed.  If this instruction attempts
2652 ** to get a read lock but fails, the script terminates with an
2653 ** SQLITE_BUSY error code.
2654 **
2655 ** The P4 value is a pointer to a KeyInfo structure that defines the
2656 ** content and collating sequence of indices.  P4 is NULL for cursors
2657 ** that are not pointing to indices.
2658 **
2659 ** See also OpenWrite.
2660 */
2661 /* Opcode: OpenWrite P1 P2 P3 P4 P5
2662 **
2663 ** Open a read/write cursor named P1 on the table or index whose root
2664 ** page is P2.  Or if P5!=0 use the content of register P2 to find the
2665 ** root page.
2666 **
2667 ** The P4 value is a pointer to a KeyInfo structure that defines the
2668 ** content and collating sequence of indices.  P4 is NULL for cursors
2669 ** that are not pointing to indices.
2670 **
2671 ** This instruction works just like OpenRead except that it opens the cursor
2672 ** in read/write mode.  For a given table, there can be one or more read-only
2673 ** cursors or a single read/write cursor but not both.
2674 **
2675 ** See also OpenRead.
2676 */
2677 case OP_OpenRead:
2678 case OP_OpenWrite: {
2679   int i = pOp->p1;
2680   int p2 = pOp->p2;
2681   int iDb = pOp->p3;
2682   int wrFlag;
2683   Btree *pX;
2684   Cursor *pCur;
2685   Db *pDb;
2686 
2687   assert( iDb>=0 && iDb<db->nDb );
2688   assert( (p->btreeMask & (1<<iDb))!=0 );
2689   pDb = &db->aDb[iDb];
2690   pX = pDb->pBt;
2691   assert( pX!=0 );
2692   if( pOp->opcode==OP_OpenWrite ){
2693     wrFlag = 1;
2694     if( pDb->pSchema->file_format < p->minWriteFileFormat ){
2695       p->minWriteFileFormat = pDb->pSchema->file_format;
2696     }
2697   }else{
2698     wrFlag = 0;
2699   }
2700   if( pOp->p5 ){
2701     assert( p2>0 );
2702     assert( p2<=p->nMem );
2703     pIn2 = &p->aMem[p2];
2704     sqlite3VdbeMemIntegerify(pIn2);
2705     p2 = pIn2->u.i;
2706     assert( p2>=2 );
2707   }
2708   assert( i>=0 );
2709   pCur = allocateCursor(p, i, &pOp[-1], iDb, 1);
2710   if( pCur==0 ) goto no_mem;
2711   pCur->nullRow = 1;
2712   rc = sqlite3BtreeCursor(pX, p2, wrFlag, pOp->p4.p, pCur->pCursor);
2713   if( pOp->p4type==P4_KEYINFO ){
2714     pCur->pKeyInfo = pOp->p4.pKeyInfo;
2715     pCur->pIncrKey = &pCur->pKeyInfo->incrKey;
2716     pCur->pKeyInfo->enc = ENC(p->db);
2717   }else{
2718     pCur->pKeyInfo = 0;
2719     pCur->pIncrKey = &pCur->bogusIncrKey;
2720   }
2721   switch( rc ){
2722     case SQLITE_BUSY: {
2723       p->pc = pc;
2724       p->rc = rc = SQLITE_BUSY;
2725       goto vdbe_return;
2726     }
2727     case SQLITE_OK: {
2728       int flags = sqlite3BtreeFlags(pCur->pCursor);
2729       /* Sanity checking.  Only the lower four bits of the flags byte should
2730       ** be used.  Bit 3 (mask 0x08) is unpredictable.  The lower 3 bits
2731       ** (mask 0x07) should be either 5 (intkey+leafdata for tables) or
2732       ** 2 (zerodata for indices).  If these conditions are not met it can
2733       ** only mean that we are dealing with a corrupt database file
2734       */
2735       if( (flags & 0xf0)!=0 || ((flags & 0x07)!=5 && (flags & 0x07)!=2) ){
2736         rc = SQLITE_CORRUPT_BKPT;
2737         goto abort_due_to_error;
2738       }
2739       pCur->isTable = (flags & BTREE_INTKEY)!=0;
2740       pCur->isIndex = (flags & BTREE_ZERODATA)!=0;
2741       /* If P4==0 it means we are expected to open a table.  If P4!=0 then
2742       ** we expect to be opening an index.  If this is not what happened,
2743       ** then the database is corrupt
2744       */
2745       if( (pCur->isTable && pOp->p4type==P4_KEYINFO)
2746        || (pCur->isIndex && pOp->p4type!=P4_KEYINFO) ){
2747         rc = SQLITE_CORRUPT_BKPT;
2748         goto abort_due_to_error;
2749       }
2750       break;
2751     }
2752     case SQLITE_EMPTY: {
2753       pCur->isTable = pOp->p4type!=P4_KEYINFO;
2754       pCur->isIndex = !pCur->isTable;
2755       pCur->pCursor = 0;
2756       rc = SQLITE_OK;
2757       break;
2758     }
2759     default: {
2760       goto abort_due_to_error;
2761     }
2762   }
2763   break;
2764 }
2765 
2766 /* Opcode: OpenEphemeral P1 P2 * P4 *
2767 **
2768 ** Open a new cursor P1 to a transient table.
2769 ** The cursor is always opened read/write even if
2770 ** the main database is read-only.  The transient or virtual
2771 ** table is deleted automatically when the cursor is closed.
2772 **
2773 ** P2 is the number of columns in the virtual table.
2774 ** The cursor points to a BTree table if P4==0 and to a BTree index
2775 ** if P4 is not 0.  If P4 is not NULL, it points to a KeyInfo structure
2776 ** that defines the format of keys in the index.
2777 **
2778 ** This opcode was once called OpenTemp.  But that created
2779 ** confusion because the term "temp table", might refer either
2780 ** to a TEMP table at the SQL level, or to a table opened by
2781 ** this opcode.  Then this opcode was call OpenVirtual.  But
2782 ** that created confusion with the whole virtual-table idea.
2783 */
2784 case OP_OpenEphemeral: {
2785   int i = pOp->p1;
2786   Cursor *pCx;
2787   static const int openFlags =
2788       SQLITE_OPEN_READWRITE |
2789       SQLITE_OPEN_CREATE |
2790       SQLITE_OPEN_EXCLUSIVE |
2791       SQLITE_OPEN_DELETEONCLOSE |
2792       SQLITE_OPEN_TRANSIENT_DB;
2793 
2794   assert( i>=0 );
2795   pCx = allocateCursor(p, i, pOp, -1, 1);
2796   if( pCx==0 ) goto no_mem;
2797   pCx->nullRow = 1;
2798   rc = sqlite3BtreeFactory(db, 0, 1, SQLITE_DEFAULT_TEMP_CACHE_SIZE, openFlags,
2799                            &pCx->pBt);
2800   if( rc==SQLITE_OK ){
2801     rc = sqlite3BtreeBeginTrans(pCx->pBt, 1);
2802   }
2803   if( rc==SQLITE_OK ){
2804     /* If a transient index is required, create it by calling
2805     ** sqlite3BtreeCreateTable() with the BTREE_ZERODATA flag before
2806     ** opening it. If a transient table is required, just use the
2807     ** automatically created table with root-page 1 (an INTKEY table).
2808     */
2809     if( pOp->p4.pKeyInfo ){
2810       int pgno;
2811       assert( pOp->p4type==P4_KEYINFO );
2812       rc = sqlite3BtreeCreateTable(pCx->pBt, &pgno, BTREE_ZERODATA);
2813       if( rc==SQLITE_OK ){
2814         assert( pgno==MASTER_ROOT+1 );
2815         rc = sqlite3BtreeCursor(pCx->pBt, pgno, 1,
2816                                 (KeyInfo*)pOp->p4.z, pCx->pCursor);
2817         pCx->pKeyInfo = pOp->p4.pKeyInfo;
2818         pCx->pKeyInfo->enc = ENC(p->db);
2819         pCx->pIncrKey = &pCx->pKeyInfo->incrKey;
2820       }
2821       pCx->isTable = 0;
2822     }else{
2823       rc = sqlite3BtreeCursor(pCx->pBt, MASTER_ROOT, 1, 0, pCx->pCursor);
2824       pCx->isTable = 1;
2825       pCx->pIncrKey = &pCx->bogusIncrKey;
2826     }
2827   }
2828   pCx->isIndex = !pCx->isTable;
2829   break;
2830 }
2831 
2832 /* Opcode: OpenPseudo P1 P2 * * *
2833 **
2834 ** Open a new cursor that points to a fake table that contains a single
2835 ** row of data.  Any attempt to write a second row of data causes the
2836 ** first row to be deleted.  All data is deleted when the cursor is
2837 ** closed.
2838 **
2839 ** A pseudo-table created by this opcode is useful for holding the
2840 ** NEW or OLD tables in a trigger.  Also used to hold the a single
2841 ** row output from the sorter so that the row can be decomposed into
2842 ** individual columns using the OP_Column opcode.
2843 **
2844 ** When OP_Insert is executed to insert a row in to the pseudo table,
2845 ** the pseudo-table cursor may or may not make it's own copy of the
2846 ** original row data. If P2 is 0, then the pseudo-table will copy the
2847 ** original row data. Otherwise, a pointer to the original memory cell
2848 ** is stored. In this case, the vdbe program must ensure that the
2849 ** memory cell containing the row data is not overwritten until the
2850 ** pseudo table is closed (or a new row is inserted into it).
2851 */
2852 case OP_OpenPseudo: {
2853   int i = pOp->p1;
2854   Cursor *pCx;
2855   assert( i>=0 );
2856   pCx = allocateCursor(p, i, &pOp[-1], -1, 0);
2857   if( pCx==0 ) goto no_mem;
2858   pCx->nullRow = 1;
2859   pCx->pseudoTable = 1;
2860   pCx->ephemPseudoTable = pOp->p2;
2861   pCx->pIncrKey = &pCx->bogusIncrKey;
2862   pCx->isTable = 1;
2863   pCx->isIndex = 0;
2864   break;
2865 }
2866 
2867 /* Opcode: Close P1 * * * *
2868 **
2869 ** Close a cursor previously opened as P1.  If P1 is not
2870 ** currently open, this instruction is a no-op.
2871 */
2872 case OP_Close: {
2873   int i = pOp->p1;
2874   assert( i>=0 && i<p->nCursor );
2875   sqlite3VdbeFreeCursor(p, p->apCsr[i]);
2876   p->apCsr[i] = 0;
2877   break;
2878 }
2879 
2880 /* Opcode: MoveGe P1 P2 P3 P4 *
2881 **
2882 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
2883 ** use the integer value in register P3 as a key. If cursor P1 refers
2884 ** to an SQL index, then P3 is the first in an array of P4 registers
2885 ** that are used as an unpacked index key.
2886 **
2887 ** Reposition cursor P1 so that  it points to the smallest entry that
2888 ** is greater than or equal to the key value. If there are no records
2889 ** greater than or equal to the key and P2 is not zero, then jump to P2.
2890 **
2891 ** A special feature of this opcode (and different from the
2892 ** related OP_MoveGt, OP_MoveLt, and OP_MoveLe) is that if P2 is
2893 ** zero and P1 is an SQL table (a b-tree with integer keys) then
2894 ** the seek is deferred until it is actually needed.  It might be
2895 ** the case that the cursor is never accessed.  By deferring the
2896 ** seek, we avoid unnecessary seeks.
2897 **
2898 ** See also: Found, NotFound, Distinct, MoveLt, MoveGt, MoveLe
2899 */
2900 /* Opcode: MoveGt P1 P2 P3 P4 *
2901 **
2902 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
2903 ** use the integer value in register P3 as a key. If cursor P1 refers
2904 ** to an SQL index, then P3 is the first in an array of P4 registers
2905 ** that are used as an unpacked index key.
2906 **
2907 ** Reposition cursor P1 so that  it points to the smallest entry that
2908 ** is greater than the key value. If there are no records greater than
2909 ** the key and P2 is not zero, then jump to P2.
2910 **
2911 ** See also: Found, NotFound, Distinct, MoveLt, MoveGe, MoveLe
2912 */
2913 /* Opcode: MoveLt P1 P2 P3 P4 *
2914 **
2915 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
2916 ** use the integer value in register P3 as a key. If cursor P1 refers
2917 ** to an SQL index, then P3 is the first in an array of P4 registers
2918 ** that are used as an unpacked index key.
2919 **
2920 ** Reposition cursor P1 so that  it points to the largest entry that
2921 ** is less than the key value. If there are no records less than
2922 ** the key and P2 is not zero, then jump to P2.
2923 **
2924 ** See also: Found, NotFound, Distinct, MoveGt, MoveGe, MoveLe
2925 */
2926 /* Opcode: MoveLe P1 P2 P3 P4 *
2927 **
2928 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
2929 ** use the integer value in register P3 as a key. If cursor P1 refers
2930 ** to an SQL index, then P3 is the first in an array of P4 registers
2931 ** that are used as an unpacked index key.
2932 **
2933 ** Reposition cursor P1 so that it points to the largest entry that
2934 ** is less than or equal to the key value. If there are no records
2935 ** less than or equal to the key and P2 is not zero, then jump to P2.
2936 **
2937 ** See also: Found, NotFound, Distinct, MoveGt, MoveGe, MoveLt
2938 */
2939 case OP_MoveLt:         /* jump, in3 */
2940 case OP_MoveLe:         /* jump, in3 */
2941 case OP_MoveGe:         /* jump, in3 */
2942 case OP_MoveGt: {       /* jump, in3 */
2943   int i = pOp->p1;
2944   Cursor *pC;
2945 
2946   assert( i>=0 && i<p->nCursor );
2947   pC = p->apCsr[i];
2948   assert( pC!=0 );
2949   if( pC->pCursor!=0 ){
2950     int res, oc;
2951     oc = pOp->opcode;
2952     pC->nullRow = 0;
2953     *pC->pIncrKey = oc==OP_MoveGt || oc==OP_MoveLe;
2954     if( pC->isTable ){
2955       i64 iKey = sqlite3VdbeIntValue(pIn3);
2956       if( pOp->p2==0 ){
2957         assert( pOp->opcode==OP_MoveGe );
2958         pC->movetoTarget = iKey;
2959         pC->rowidIsValid = 0;
2960         pC->deferredMoveto = 1;
2961         break;
2962       }
2963       rc = sqlite3BtreeMoveto(pC->pCursor, 0, 0, (u64)iKey, 0, &res);
2964       if( rc!=SQLITE_OK ){
2965         goto abort_due_to_error;
2966       }
2967       pC->lastRowid = iKey;
2968       pC->rowidIsValid = res==0;
2969     }else{
2970       UnpackedRecord r;
2971       int nField = pOp->p4.i;
2972       assert( pOp->p4type==P4_INT32 );
2973       assert( nField>0 );
2974       r.pKeyInfo = pC->pKeyInfo;
2975       r.nField = nField;
2976       r.needFree = 0;
2977       r.needDestroy = 0;
2978       r.aMem = &p->aMem[pOp->p3];
2979       rc = sqlite3BtreeMoveto(pC->pCursor, 0, &r, 0, 0, &res);
2980       if( rc!=SQLITE_OK ){
2981         goto abort_due_to_error;
2982       }
2983       pC->rowidIsValid = 0;
2984     }
2985     pC->deferredMoveto = 0;
2986     pC->cacheStatus = CACHE_STALE;
2987     *pC->pIncrKey = 0;
2988 #ifdef SQLITE_TEST
2989     sqlite3_search_count++;
2990 #endif
2991     if( oc==OP_MoveGe || oc==OP_MoveGt ){
2992       if( res<0 ){
2993         rc = sqlite3BtreeNext(pC->pCursor, &res);
2994         if( rc!=SQLITE_OK ) goto abort_due_to_error;
2995         pC->rowidIsValid = 0;
2996       }else{
2997         res = 0;
2998       }
2999     }else{
3000       assert( oc==OP_MoveLt || oc==OP_MoveLe );
3001       if( res>=0 ){
3002         rc = sqlite3BtreePrevious(pC->pCursor, &res);
3003         if( rc!=SQLITE_OK ) goto abort_due_to_error;
3004         pC->rowidIsValid = 0;
3005       }else{
3006         /* res might be negative because the table is empty.  Check to
3007         ** see if this is the case.
3008         */
3009         res = sqlite3BtreeEof(pC->pCursor);
3010       }
3011     }
3012     assert( pOp->p2>0 );
3013     if( res ){
3014       pc = pOp->p2 - 1;
3015     }
3016   }else if( !pC->pseudoTable ){
3017     /* This happens when attempting to open the sqlite3_master table
3018     ** for read access returns SQLITE_EMPTY. In this case always
3019     ** take the jump (since there are no records in the table).
3020     */
3021     pc = pOp->p2 - 1;
3022   }
3023   break;
3024 }
3025 
3026 /* Opcode: Found P1 P2 P3 * *
3027 **
3028 ** Register P3 holds a blob constructed by MakeRecord.  P1 is an index.
3029 ** If an entry that matches the value in register p3 exists in P1 then
3030 ** jump to P2.  If the P3 value does not match any entry in P1
3031 ** then fall thru.  The P1 cursor is left pointing at the matching entry
3032 ** if it exists.
3033 **
3034 ** This instruction is used to implement the IN operator where the
3035 ** left-hand side is a SELECT statement.  P1 may be a true index, or it
3036 ** may be a temporary index that holds the results of the SELECT
3037 ** statement.   This instruction is also used to implement the
3038 ** DISTINCT keyword in SELECT statements.
3039 **
3040 ** This instruction checks if index P1 contains a record for which
3041 ** the first N serialized values exactly match the N serialized values
3042 ** in the record in register P3, where N is the total number of values in
3043 ** the P3 record (the P3 record is a prefix of the P1 record).
3044 **
3045 ** See also: NotFound, MoveTo, IsUnique, NotExists
3046 */
3047 /* Opcode: NotFound P1 P2 P3 * *
3048 **
3049 ** Register P3 holds a blob constructed by MakeRecord.  P1 is
3050 ** an index.  If no entry exists in P1 that matches the blob then jump
3051 ** to P2.  If an entry does existing, fall through.  The cursor is left
3052 ** pointing to the entry that matches.
3053 **
3054 ** See also: Found, MoveTo, NotExists, IsUnique
3055 */
3056 case OP_NotFound:       /* jump, in3 */
3057 case OP_Found: {        /* jump, in3 */
3058   int i = pOp->p1;
3059   int alreadyExists = 0;
3060   Cursor *pC;
3061   assert( i>=0 && i<p->nCursor );
3062   assert( p->apCsr[i]!=0 );
3063   if( (pC = p->apCsr[i])->pCursor!=0 ){
3064     int res;
3065     assert( pC->isTable==0 );
3066     assert( pIn3->flags & MEM_Blob );
3067     if( pOp->opcode==OP_Found ){
3068       pC->pKeyInfo->prefixIsEqual = 1;
3069     }
3070     rc = sqlite3BtreeMoveto(pC->pCursor, pIn3->z, 0, pIn3->n, 0, &res);
3071     pC->pKeyInfo->prefixIsEqual = 0;
3072     if( rc!=SQLITE_OK ){
3073       break;
3074     }
3075     alreadyExists = (res==0);
3076     pC->deferredMoveto = 0;
3077     pC->cacheStatus = CACHE_STALE;
3078   }
3079   if( pOp->opcode==OP_Found ){
3080     if( alreadyExists ) pc = pOp->p2 - 1;
3081   }else{
3082     if( !alreadyExists ) pc = pOp->p2 - 1;
3083   }
3084   break;
3085 }
3086 
3087 /* Opcode: IsUnique P1 P2 P3 P4 *
3088 **
3089 ** The P3 register contains an integer record number.  Call this
3090 ** record number R.  The P4 register contains an index key created
3091 ** using MakeIdxRec.  Call it K.
3092 **
3093 ** P1 is an index.  So it has no data and its key consists of a
3094 ** record generated by OP_MakeRecord where the last field is the
3095 ** rowid of the entry that the index refers to.
3096 **
3097 ** This instruction asks if there is an entry in P1 where the
3098 ** fields matches K but the rowid is different from R.
3099 ** If there is no such entry, then there is an immediate
3100 ** jump to P2.  If any entry does exist where the index string
3101 ** matches K but the record number is not R, then the record
3102 ** number for that entry is written into P3 and control
3103 ** falls through to the next instruction.
3104 **
3105 ** See also: NotFound, NotExists, Found
3106 */
3107 case OP_IsUnique: {        /* jump, in3 */
3108   int i = pOp->p1;
3109   Cursor *pCx;
3110   BtCursor *pCrsr;
3111   Mem *pK;
3112   i64 R;
3113 
3114   /* Pop the value R off the top of the stack
3115   */
3116   assert( pOp->p4type==P4_INT32 );
3117   assert( pOp->p4.i>0 && pOp->p4.i<=p->nMem );
3118   pK = &p->aMem[pOp->p4.i];
3119   sqlite3VdbeMemIntegerify(pIn3);
3120   R = pIn3->u.i;
3121   assert( i>=0 && i<p->nCursor );
3122   pCx = p->apCsr[i];
3123   assert( pCx!=0 );
3124   pCrsr = pCx->pCursor;
3125   if( pCrsr!=0 ){
3126     int res;
3127     i64 v;         /* The record number on the P1 entry that matches K */
3128     char *zKey;    /* The value of K */
3129     int nKey;      /* Number of bytes in K */
3130     int len;       /* Number of bytes in K without the rowid at the end */
3131     int szRowid;   /* Size of the rowid column at the end of zKey */
3132 
3133     /* Make sure K is a string and make zKey point to K
3134     */
3135     assert( pK->flags & MEM_Blob );
3136     zKey = pK->z;
3137     nKey = pK->n;
3138 
3139     szRowid = sqlite3VdbeIdxRowidLen((u8*)zKey);
3140     len = nKey-szRowid;
3141 
3142     /* Search for an entry in P1 where all but the last four bytes match K.
3143     ** If there is no such entry, jump immediately to P2.
3144     */
3145     assert( pCx->deferredMoveto==0 );
3146     pCx->cacheStatus = CACHE_STALE;
3147     rc = sqlite3BtreeMoveto(pCrsr, zKey, 0, len, 0, &res);
3148     if( rc!=SQLITE_OK ){
3149       goto abort_due_to_error;
3150     }
3151     if( res<0 ){
3152       rc = sqlite3BtreeNext(pCrsr, &res);
3153       if( res ){
3154         pc = pOp->p2 - 1;
3155         break;
3156       }
3157     }
3158     rc = sqlite3VdbeIdxKeyCompare(pCx, 0, len, (u8*)zKey, &res);
3159     if( rc!=SQLITE_OK ) goto abort_due_to_error;
3160     if( res>0 ){
3161       pc = pOp->p2 - 1;
3162       break;
3163     }
3164 
3165     /* At this point, pCrsr is pointing to an entry in P1 where all but
3166     ** the final entry (the rowid) matches K.  Check to see if the
3167     ** final rowid column is different from R.  If it equals R then jump
3168     ** immediately to P2.
3169     */
3170     rc = sqlite3VdbeIdxRowid(pCrsr, &v);
3171     if( rc!=SQLITE_OK ){
3172       goto abort_due_to_error;
3173     }
3174     if( v==R ){
3175       pc = pOp->p2 - 1;
3176       break;
3177     }
3178 
3179     /* The final varint of the key is different from R.  Store it back
3180     ** into register R3.  (The record number of an entry that violates
3181     ** a UNIQUE constraint.)
3182     */
3183     pIn3->u.i = v;
3184     assert( pIn3->flags&MEM_Int );
3185   }
3186   break;
3187 }
3188 
3189 /* Opcode: NotExists P1 P2 P3 * *
3190 **
3191 ** Use the content of register P3 as a integer key.  If a record
3192 ** with that key does not exist in table of P1, then jump to P2.
3193 ** If the record does exist, then fall thru.  The cursor is left
3194 ** pointing to the record if it exists.
3195 **
3196 ** The difference between this operation and NotFound is that this
3197 ** operation assumes the key is an integer and that P1 is a table whereas
3198 ** NotFound assumes key is a blob constructed from MakeRecord and
3199 ** P1 is an index.
3200 **
3201 ** See also: Found, MoveTo, NotFound, IsUnique
3202 */
3203 case OP_NotExists: {        /* jump, in3 */
3204   int i = pOp->p1;
3205   Cursor *pC;
3206   BtCursor *pCrsr;
3207   assert( i>=0 && i<p->nCursor );
3208   assert( p->apCsr[i]!=0 );
3209   if( (pCrsr = (pC = p->apCsr[i])->pCursor)!=0 ){
3210     int res;
3211     u64 iKey;
3212     assert( pIn3->flags & MEM_Int );
3213     assert( p->apCsr[i]->isTable );
3214     iKey = intToKey(pIn3->u.i);
3215     rc = sqlite3BtreeMoveto(pCrsr, 0, 0, iKey, 0,&res);
3216     pC->lastRowid = pIn3->u.i;
3217     pC->rowidIsValid = res==0;
3218     pC->nullRow = 0;
3219     pC->cacheStatus = CACHE_STALE;
3220     /* res might be uninitialized if rc!=SQLITE_OK.  But if rc!=SQLITE_OK
3221     ** processing is about to abort so we really do not care whether or not
3222     ** the following jump is taken.  (In other words, do not stress over
3223     ** the error that valgrind sometimes shows on the next statement when
3224     ** running ioerr.test and similar failure-recovery test scripts.) */
3225     if( res!=0 ){
3226       pc = pOp->p2 - 1;
3227       assert( pC->rowidIsValid==0 );
3228     }
3229   }else if( !pC->pseudoTable ){
3230     /* This happens when an attempt to open a read cursor on the
3231     ** sqlite_master table returns SQLITE_EMPTY.
3232     */
3233     assert( pC->isTable );
3234     pc = pOp->p2 - 1;
3235     assert( pC->rowidIsValid==0 );
3236   }
3237   break;
3238 }
3239 
3240 /* Opcode: Sequence P1 P2 * * *
3241 **
3242 ** Find the next available sequence number for cursor P1.
3243 ** Write the sequence number into register P2.
3244 ** The sequence number on the cursor is incremented after this
3245 ** instruction.
3246 */
3247 case OP_Sequence: {           /* out2-prerelease */
3248   int i = pOp->p1;
3249   assert( i>=0 && i<p->nCursor );
3250   assert( p->apCsr[i]!=0 );
3251   pOut->u.i = p->apCsr[i]->seqCount++;
3252   MemSetTypeFlag(pOut, MEM_Int);
3253   break;
3254 }
3255 
3256 
3257 /* Opcode: NewRowid P1 P2 P3 * *
3258 **
3259 ** Get a new integer record number (a.k.a "rowid") used as the key to a table.
3260 ** The record number is not previously used as a key in the database
3261 ** table that cursor P1 points to.  The new record number is written
3262 ** written to register P2.
3263 **
3264 ** If P3>0 then P3 is a register that holds the largest previously
3265 ** generated record number.  No new record numbers are allowed to be less
3266 ** than this value.  When this value reaches its maximum, a SQLITE_FULL
3267 ** error is generated.  The P3 register is updated with the generated
3268 ** record number.  This P3 mechanism is used to help implement the
3269 ** AUTOINCREMENT feature.
3270 */
3271 case OP_NewRowid: {           /* out2-prerelease */
3272   int i = pOp->p1;
3273   i64 v = 0;
3274   Cursor *pC;
3275   assert( i>=0 && i<p->nCursor );
3276   assert( p->apCsr[i]!=0 );
3277   if( (pC = p->apCsr[i])->pCursor==0 ){
3278     /* The zero initialization above is all that is needed */
3279   }else{
3280     /* The next rowid or record number (different terms for the same
3281     ** thing) is obtained in a two-step algorithm.
3282     **
3283     ** First we attempt to find the largest existing rowid and add one
3284     ** to that.  But if the largest existing rowid is already the maximum
3285     ** positive integer, we have to fall through to the second
3286     ** probabilistic algorithm
3287     **
3288     ** The second algorithm is to select a rowid at random and see if
3289     ** it already exists in the table.  If it does not exist, we have
3290     ** succeeded.  If the random rowid does exist, we select a new one
3291     ** and try again, up to 1000 times.
3292     **
3293     ** For a table with less than 2 billion entries, the probability
3294     ** of not finding a unused rowid is about 1.0e-300.  This is a
3295     ** non-zero probability, but it is still vanishingly small and should
3296     ** never cause a problem.  You are much, much more likely to have a
3297     ** hardware failure than for this algorithm to fail.
3298     **
3299     ** The analysis in the previous paragraph assumes that you have a good
3300     ** source of random numbers.  Is a library function like lrand48()
3301     ** good enough?  Maybe. Maybe not. It's hard to know whether there
3302     ** might be subtle bugs is some implementations of lrand48() that
3303     ** could cause problems. To avoid uncertainty, SQLite uses its own
3304     ** random number generator based on the RC4 algorithm.
3305     **
3306     ** To promote locality of reference for repetitive inserts, the
3307     ** first few attempts at choosing a random rowid pick values just a little
3308     ** larger than the previous rowid.  This has been shown experimentally
3309     ** to double the speed of the COPY operation.
3310     */
3311     int res, rx=SQLITE_OK, cnt;
3312     i64 x;
3313     cnt = 0;
3314     if( (sqlite3BtreeFlags(pC->pCursor)&(BTREE_INTKEY|BTREE_ZERODATA)) !=
3315           BTREE_INTKEY ){
3316       rc = SQLITE_CORRUPT_BKPT;
3317       goto abort_due_to_error;
3318     }
3319     assert( (sqlite3BtreeFlags(pC->pCursor) & BTREE_INTKEY)!=0 );
3320     assert( (sqlite3BtreeFlags(pC->pCursor) & BTREE_ZERODATA)==0 );
3321 
3322 #ifdef SQLITE_32BIT_ROWID
3323 #   define MAX_ROWID 0x7fffffff
3324 #else
3325     /* Some compilers complain about constants of the form 0x7fffffffffffffff.
3326     ** Others complain about 0x7ffffffffffffffffLL.  The following macro seems
3327     ** to provide the constant while making all compilers happy.
3328     */
3329 #   define MAX_ROWID  ( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
3330 #endif
3331 
3332     if( !pC->useRandomRowid ){
3333       if( pC->nextRowidValid ){
3334         v = pC->nextRowid;
3335       }else{
3336         rc = sqlite3BtreeLast(pC->pCursor, &res);
3337         if( rc!=SQLITE_OK ){
3338           goto abort_due_to_error;
3339         }
3340         if( res ){
3341           v = 1;
3342         }else{
3343           sqlite3BtreeKeySize(pC->pCursor, &v);
3344           v = keyToInt(v);
3345           if( v==MAX_ROWID ){
3346             pC->useRandomRowid = 1;
3347           }else{
3348             v++;
3349           }
3350         }
3351       }
3352 
3353 #ifndef SQLITE_OMIT_AUTOINCREMENT
3354       if( pOp->p3 ){
3355         Mem *pMem;
3356         assert( pOp->p3>0 && pOp->p3<=p->nMem ); /* P3 is a valid memory cell */
3357         pMem = &p->aMem[pOp->p3];
3358 	REGISTER_TRACE(pOp->p3, pMem);
3359         sqlite3VdbeMemIntegerify(pMem);
3360         assert( (pMem->flags & MEM_Int)!=0 );  /* mem(P3) holds an integer */
3361         if( pMem->u.i==MAX_ROWID || pC->useRandomRowid ){
3362           rc = SQLITE_FULL;
3363           goto abort_due_to_error;
3364         }
3365         if( v<pMem->u.i+1 ){
3366           v = pMem->u.i + 1;
3367         }
3368         pMem->u.i = v;
3369       }
3370 #endif
3371 
3372       if( v<MAX_ROWID ){
3373         pC->nextRowidValid = 1;
3374         pC->nextRowid = v+1;
3375       }else{
3376         pC->nextRowidValid = 0;
3377       }
3378     }
3379     if( pC->useRandomRowid ){
3380       assert( pOp->p3==0 );  /* SQLITE_FULL must have occurred prior to this */
3381       v = db->priorNewRowid;
3382       cnt = 0;
3383       do{
3384         if( cnt==0 && (v&0xffffff)==v ){
3385           v++;
3386         }else{
3387           sqlite3_randomness(sizeof(v), &v);
3388           if( cnt<5 ) v &= 0xffffff;
3389         }
3390         if( v==0 ) continue;
3391         x = intToKey(v);
3392         rx = sqlite3BtreeMoveto(pC->pCursor, 0, 0, (u64)x, 0, &res);
3393         cnt++;
3394       }while( cnt<100 && rx==SQLITE_OK && res==0 );
3395       db->priorNewRowid = v;
3396       if( rx==SQLITE_OK && res==0 ){
3397         rc = SQLITE_FULL;
3398         goto abort_due_to_error;
3399       }
3400     }
3401     pC->rowidIsValid = 0;
3402     pC->deferredMoveto = 0;
3403     pC->cacheStatus = CACHE_STALE;
3404   }
3405   MemSetTypeFlag(pOut, MEM_Int);
3406   pOut->u.i = v;
3407   break;
3408 }
3409 
3410 /* Opcode: Insert P1 P2 P3 P4 P5
3411 **
3412 ** Write an entry into the table of cursor P1.  A new entry is
3413 ** created if it doesn't already exist or the data for an existing
3414 ** entry is overwritten.  The data is the value stored register
3415 ** number P2. The key is stored in register P3. The key must
3416 ** be an integer.
3417 **
3418 ** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
3419 ** incremented (otherwise not).  If the OPFLAG_LASTROWID flag of P5 is set,
3420 ** then rowid is stored for subsequent return by the
3421 ** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
3422 **
3423 ** Parameter P4 may point to a string containing the table-name, or
3424 ** may be NULL. If it is not NULL, then the update-hook
3425 ** (sqlite3.xUpdateCallback) is invoked following a successful insert.
3426 **
3427 ** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
3428 ** allocated, then ownership of P2 is transferred to the pseudo-cursor
3429 ** and register P2 becomes ephemeral.  If the cursor is changed, the
3430 ** value of register P2 will then change.  Make sure this does not
3431 ** cause any problems.)
3432 **
3433 ** This instruction only works on tables.  The equivalent instruction
3434 ** for indices is OP_IdxInsert.
3435 */
3436 case OP_Insert: {
3437   Mem *pData = &p->aMem[pOp->p2];
3438   Mem *pKey = &p->aMem[pOp->p3];
3439 
3440   i64 iKey;   /* The integer ROWID or key for the record to be inserted */
3441   int i = pOp->p1;
3442   Cursor *pC;
3443   assert( i>=0 && i<p->nCursor );
3444   pC = p->apCsr[i];
3445   assert( pC!=0 );
3446   assert( pC->pCursor!=0 || pC->pseudoTable );
3447   assert( pKey->flags & MEM_Int );
3448   assert( pC->isTable );
3449   REGISTER_TRACE(pOp->p2, pData);
3450   REGISTER_TRACE(pOp->p3, pKey);
3451 
3452   iKey = intToKey(pKey->u.i);
3453   if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
3454   if( pOp->p5 & OPFLAG_LASTROWID ) db->lastRowid = pKey->u.i;
3455   if( pC->nextRowidValid && pKey->u.i>=pC->nextRowid ){
3456     pC->nextRowidValid = 0;
3457   }
3458   if( pData->flags & MEM_Null ){
3459     pData->z = 0;
3460     pData->n = 0;
3461   }else{
3462     assert( pData->flags & (MEM_Blob|MEM_Str) );
3463   }
3464   if( pC->pseudoTable ){
3465     if( !pC->ephemPseudoTable ){
3466       sqlite3_free(pC->pData);
3467     }
3468     pC->iKey = iKey;
3469     pC->nData = pData->n;
3470     if( pData->z==pData->zMalloc || pC->ephemPseudoTable ){
3471       pC->pData = pData->z;
3472       if( !pC->ephemPseudoTable ){
3473         pData->flags &= ~MEM_Dyn;
3474         pData->flags |= MEM_Ephem;
3475         pData->zMalloc = 0;
3476       }
3477     }else{
3478       pC->pData = sqlite3Malloc( pC->nData+2 );
3479       if( !pC->pData ) goto no_mem;
3480       memcpy(pC->pData, pData->z, pC->nData);
3481       pC->pData[pC->nData] = 0;
3482       pC->pData[pC->nData+1] = 0;
3483     }
3484     pC->nullRow = 0;
3485   }else{
3486     int nZero;
3487     if( pData->flags & MEM_Zero ){
3488       nZero = pData->u.i;
3489     }else{
3490       nZero = 0;
3491     }
3492     rc = sqlite3BtreeInsert(pC->pCursor, 0, iKey,
3493                             pData->z, pData->n, nZero,
3494                             pOp->p5 & OPFLAG_APPEND);
3495   }
3496 
3497   pC->rowidIsValid = 0;
3498   pC->deferredMoveto = 0;
3499   pC->cacheStatus = CACHE_STALE;
3500 
3501   /* Invoke the update-hook if required. */
3502   if( rc==SQLITE_OK && db->xUpdateCallback && pOp->p4.z ){
3503     const char *zDb = db->aDb[pC->iDb].zName;
3504     const char *zTbl = pOp->p4.z;
3505     int op = ((pOp->p5 & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_INSERT);
3506     assert( pC->isTable );
3507     db->xUpdateCallback(db->pUpdateArg, op, zDb, zTbl, iKey);
3508     assert( pC->iDb>=0 );
3509   }
3510   break;
3511 }
3512 
3513 /* Opcode: Delete P1 P2 * P4 *
3514 **
3515 ** Delete the record at which the P1 cursor is currently pointing.
3516 **
3517 ** The cursor will be left pointing at either the next or the previous
3518 ** record in the table. If it is left pointing at the next record, then
3519 ** the next Next instruction will be a no-op.  Hence it is OK to delete
3520 ** a record from within an Next loop.
3521 **
3522 ** If the OPFLAG_NCHANGE flag of P2 is set, then the row change count is
3523 ** incremented (otherwise not).
3524 **
3525 ** P1 must not be pseudo-table.  It has to be a real table with
3526 ** multiple rows.
3527 **
3528 ** If P4 is not NULL, then it is the name of the table that P1 is
3529 ** pointing to.  The update hook will be invoked, if it exists.
3530 ** If P4 is not NULL then the P1 cursor must have been positioned
3531 ** using OP_NotFound prior to invoking this opcode.
3532 */
3533 case OP_Delete: {
3534   int i = pOp->p1;
3535   i64 iKey;
3536   Cursor *pC;
3537 
3538   assert( i>=0 && i<p->nCursor );
3539   pC = p->apCsr[i];
3540   assert( pC!=0 );
3541   assert( pC->pCursor!=0 );  /* Only valid for real tables, no pseudotables */
3542 
3543   /* If the update-hook will be invoked, set iKey to the rowid of the
3544   ** row being deleted.
3545   */
3546   if( db->xUpdateCallback && pOp->p4.z ){
3547     assert( pC->isTable );
3548     assert( pC->rowidIsValid );  /* lastRowid set by previous OP_NotFound */
3549     iKey = pC->lastRowid;
3550   }
3551 
3552   rc = sqlite3VdbeCursorMoveto(pC);
3553   if( rc ) goto abort_due_to_error;
3554   rc = sqlite3BtreeDelete(pC->pCursor);
3555   pC->nextRowidValid = 0;
3556   pC->cacheStatus = CACHE_STALE;
3557 
3558   /* Invoke the update-hook if required. */
3559   if( rc==SQLITE_OK && db->xUpdateCallback && pOp->p4.z ){
3560     const char *zDb = db->aDb[pC->iDb].zName;
3561     const char *zTbl = pOp->p4.z;
3562     db->xUpdateCallback(db->pUpdateArg, SQLITE_DELETE, zDb, zTbl, iKey);
3563     assert( pC->iDb>=0 );
3564   }
3565   if( pOp->p2 & OPFLAG_NCHANGE ) p->nChange++;
3566   break;
3567 }
3568 
3569 /* Opcode: ResetCount P1 * *
3570 **
3571 ** This opcode resets the VMs internal change counter to 0. If P1 is true,
3572 ** then the value of the change counter is copied to the database handle
3573 ** change counter (returned by subsequent calls to sqlite3_changes())
3574 ** before it is reset. This is used by trigger programs.
3575 */
3576 case OP_ResetCount: {
3577   if( pOp->p1 ){
3578     sqlite3VdbeSetChanges(db, p->nChange);
3579   }
3580   p->nChange = 0;
3581   break;
3582 }
3583 
3584 /* Opcode: RowData P1 P2 * * *
3585 **
3586 ** Write into register P2 the complete row data for cursor P1.
3587 ** There is no interpretation of the data.
3588 ** It is just copied onto the P2 register exactly as
3589 ** it is found in the database file.
3590 **
3591 ** If the P1 cursor must be pointing to a valid row (not a NULL row)
3592 ** of a real table, not a pseudo-table.
3593 */
3594 /* Opcode: RowKey P1 P2 * * *
3595 **
3596 ** Write into register P2 the complete row key for cursor P1.
3597 ** There is no interpretation of the data.
3598 ** The key is copied onto the P3 register exactly as
3599 ** it is found in the database file.
3600 **
3601 ** If the P1 cursor must be pointing to a valid row (not a NULL row)
3602 ** of a real table, not a pseudo-table.
3603 */
3604 case OP_RowKey:
3605 case OP_RowData: {
3606   int i = pOp->p1;
3607   Cursor *pC;
3608   BtCursor *pCrsr;
3609   u32 n;
3610 
3611   pOut = &p->aMem[pOp->p2];
3612 
3613   /* Note that RowKey and RowData are really exactly the same instruction */
3614   assert( i>=0 && i<p->nCursor );
3615   pC = p->apCsr[i];
3616   assert( pC->isTable || pOp->opcode==OP_RowKey );
3617   assert( pC->isIndex || pOp->opcode==OP_RowData );
3618   assert( pC!=0 );
3619   assert( pC->nullRow==0 );
3620   assert( pC->pseudoTable==0 );
3621   assert( pC->pCursor!=0 );
3622   pCrsr = pC->pCursor;
3623   rc = sqlite3VdbeCursorMoveto(pC);
3624   if( rc ) goto abort_due_to_error;
3625   if( pC->isIndex ){
3626     i64 n64;
3627     assert( !pC->isTable );
3628     sqlite3BtreeKeySize(pCrsr, &n64);
3629     if( n64>db->aLimit[SQLITE_LIMIT_LENGTH] ){
3630       goto too_big;
3631     }
3632     n = n64;
3633   }else{
3634     sqlite3BtreeDataSize(pCrsr, &n);
3635     if( n>db->aLimit[SQLITE_LIMIT_LENGTH] ){
3636       goto too_big;
3637     }
3638   }
3639   if( sqlite3VdbeMemGrow(pOut, n, 0) ){
3640     goto no_mem;
3641   }
3642   pOut->n = n;
3643   MemSetTypeFlag(pOut, MEM_Blob);
3644   if( pC->isIndex ){
3645     rc = sqlite3BtreeKey(pCrsr, 0, n, pOut->z);
3646   }else{
3647     rc = sqlite3BtreeData(pCrsr, 0, n, pOut->z);
3648   }
3649   pOut->enc = SQLITE_UTF8;  /* In case the blob is ever cast to text */
3650   UPDATE_MAX_BLOBSIZE(pOut);
3651   break;
3652 }
3653 
3654 /* Opcode: Rowid P1 P2 * * *
3655 **
3656 ** Store in register P2 an integer which is the key of the table entry that
3657 ** P1 is currently point to.
3658 */
3659 case OP_Rowid: {                 /* out2-prerelease */
3660   int i = pOp->p1;
3661   Cursor *pC;
3662   i64 v;
3663 
3664   assert( i>=0 && i<p->nCursor );
3665   pC = p->apCsr[i];
3666   assert( pC!=0 );
3667   rc = sqlite3VdbeCursorMoveto(pC);
3668   if( rc ) goto abort_due_to_error;
3669   if( pC->rowidIsValid ){
3670     v = pC->lastRowid;
3671   }else if( pC->pseudoTable ){
3672     v = keyToInt(pC->iKey);
3673   }else if( pC->nullRow ){
3674     /* Leave the rowid set to a NULL */
3675     break;
3676   }else{
3677     assert( pC->pCursor!=0 );
3678     sqlite3BtreeKeySize(pC->pCursor, &v);
3679     v = keyToInt(v);
3680   }
3681   pOut->u.i = v;
3682   MemSetTypeFlag(pOut, MEM_Int);
3683   break;
3684 }
3685 
3686 /* Opcode: NullRow P1 * * * *
3687 **
3688 ** Move the cursor P1 to a null row.  Any OP_Column operations
3689 ** that occur while the cursor is on the null row will always
3690 ** write a NULL.
3691 */
3692 case OP_NullRow: {
3693   int i = pOp->p1;
3694   Cursor *pC;
3695 
3696   assert( i>=0 && i<p->nCursor );
3697   pC = p->apCsr[i];
3698   assert( pC!=0 );
3699   pC->nullRow = 1;
3700   pC->rowidIsValid = 0;
3701   break;
3702 }
3703 
3704 /* Opcode: Last P1 P2 * * *
3705 **
3706 ** The next use of the Rowid or Column or Next instruction for P1
3707 ** will refer to the last entry in the database table or index.
3708 ** If the table or index is empty and P2>0, then jump immediately to P2.
3709 ** If P2 is 0 or if the table or index is not empty, fall through
3710 ** to the following instruction.
3711 */
3712 case OP_Last: {        /* jump */
3713   int i = pOp->p1;
3714   Cursor *pC;
3715   BtCursor *pCrsr;
3716   int res;
3717 
3718   assert( i>=0 && i<p->nCursor );
3719   pC = p->apCsr[i];
3720   assert( pC!=0 );
3721   pCrsr = pC->pCursor;
3722   assert( pCrsr!=0 );
3723   rc = sqlite3BtreeLast(pCrsr, &res);
3724   pC->nullRow = res;
3725   pC->deferredMoveto = 0;
3726   pC->cacheStatus = CACHE_STALE;
3727   if( res && pOp->p2>0 ){
3728     pc = pOp->p2 - 1;
3729   }
3730   break;
3731 }
3732 
3733 
3734 /* Opcode: Sort P1 P2 * * *
3735 **
3736 ** This opcode does exactly the same thing as OP_Rewind except that
3737 ** it increments an undocumented global variable used for testing.
3738 **
3739 ** Sorting is accomplished by writing records into a sorting index,
3740 ** then rewinding that index and playing it back from beginning to
3741 ** end.  We use the OP_Sort opcode instead of OP_Rewind to do the
3742 ** rewinding so that the global variable will be incremented and
3743 ** regression tests can determine whether or not the optimizer is
3744 ** correctly optimizing out sorts.
3745 */
3746 case OP_Sort: {        /* jump */
3747 #ifdef SQLITE_TEST
3748   sqlite3_sort_count++;
3749   sqlite3_search_count--;
3750 #endif
3751   /* Fall through into OP_Rewind */
3752 }
3753 /* Opcode: Rewind P1 P2 * * *
3754 **
3755 ** The next use of the Rowid or Column or Next instruction for P1
3756 ** will refer to the first entry in the database table or index.
3757 ** If the table or index is empty and P2>0, then jump immediately to P2.
3758 ** If P2 is 0 or if the table or index is not empty, fall through
3759 ** to the following instruction.
3760 */
3761 case OP_Rewind: {        /* jump */
3762   int i = pOp->p1;
3763   Cursor *pC;
3764   BtCursor *pCrsr;
3765   int res;
3766 
3767   assert( i>=0 && i<p->nCursor );
3768   pC = p->apCsr[i];
3769   assert( pC!=0 );
3770   if( (pCrsr = pC->pCursor)!=0 ){
3771     rc = sqlite3BtreeFirst(pCrsr, &res);
3772     pC->atFirst = res==0;
3773     pC->deferredMoveto = 0;
3774     pC->cacheStatus = CACHE_STALE;
3775   }else{
3776     res = 1;
3777   }
3778   pC->nullRow = res;
3779   assert( pOp->p2>0 && pOp->p2<p->nOp );
3780   if( res ){
3781     pc = pOp->p2 - 1;
3782   }
3783   break;
3784 }
3785 
3786 /* Opcode: Next P1 P2 * * *
3787 **
3788 ** Advance cursor P1 so that it points to the next key/data pair in its
3789 ** table or index.  If there are no more key/value pairs then fall through
3790 ** to the following instruction.  But if the cursor advance was successful,
3791 ** jump immediately to P2.
3792 **
3793 ** The P1 cursor must be for a real table, not a pseudo-table.
3794 **
3795 ** See also: Prev
3796 */
3797 /* Opcode: Prev P1 P2 * * *
3798 **
3799 ** Back up cursor P1 so that it points to the previous key/data pair in its
3800 ** table or index.  If there is no previous key/value pairs then fall through
3801 ** to the following instruction.  But if the cursor backup was successful,
3802 ** jump immediately to P2.
3803 **
3804 ** The P1 cursor must be for a real table, not a pseudo-table.
3805 */
3806 case OP_Prev:          /* jump */
3807 case OP_Next: {        /* jump */
3808   Cursor *pC;
3809   BtCursor *pCrsr;
3810   int res;
3811 
3812   CHECK_FOR_INTERRUPT;
3813   assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3814   pC = p->apCsr[pOp->p1];
3815   if( pC==0 ){
3816     break;  /* See ticket #2273 */
3817   }
3818   pCrsr = pC->pCursor;
3819   assert( pCrsr );
3820   res = 1;
3821   assert( pC->deferredMoveto==0 );
3822   rc = pOp->opcode==OP_Next ? sqlite3BtreeNext(pCrsr, &res) :
3823                               sqlite3BtreePrevious(pCrsr, &res);
3824   pC->nullRow = res;
3825   pC->cacheStatus = CACHE_STALE;
3826   if( res==0 ){
3827     pc = pOp->p2 - 1;
3828 #ifdef SQLITE_TEST
3829     sqlite3_search_count++;
3830 #endif
3831   }
3832   pC->rowidIsValid = 0;
3833   break;
3834 }
3835 
3836 /* Opcode: IdxInsert P1 P2 P3 * *
3837 **
3838 ** Register P2 holds a SQL index key made using the
3839 ** MakeIdxRec instructions.  This opcode writes that key
3840 ** into the index P1.  Data for the entry is nil.
3841 **
3842 ** P3 is a flag that provides a hint to the b-tree layer that this
3843 ** insert is likely to be an append.
3844 **
3845 ** This instruction only works for indices.  The equivalent instruction
3846 ** for tables is OP_Insert.
3847 */
3848 case OP_IdxInsert: {        /* in2 */
3849   int i = pOp->p1;
3850   Cursor *pC;
3851   BtCursor *pCrsr;
3852   assert( i>=0 && i<p->nCursor );
3853   assert( p->apCsr[i]!=0 );
3854   assert( pIn2->flags & MEM_Blob );
3855   if( (pCrsr = (pC = p->apCsr[i])->pCursor)!=0 ){
3856     assert( pC->isTable==0 );
3857     rc = ExpandBlob(pIn2);
3858     if( rc==SQLITE_OK ){
3859       int nKey = pIn2->n;
3860       const char *zKey = pIn2->z;
3861       rc = sqlite3BtreeInsert(pCrsr, zKey, nKey, "", 0, 0, pOp->p3);
3862       assert( pC->deferredMoveto==0 );
3863       pC->cacheStatus = CACHE_STALE;
3864     }
3865   }
3866   break;
3867 }
3868 
3869 /* Opcode: IdxDeleteM P1 P2 P3 * *
3870 **
3871 ** The content of P3 registers starting at register P2 form
3872 ** an unpacked index key. This opcode removes that entry from the
3873 ** index opened by cursor P1.
3874 */
3875 case OP_IdxDelete: {
3876   int i = pOp->p1;
3877   Cursor *pC;
3878   BtCursor *pCrsr;
3879   assert( pOp->p3>0 );
3880   assert( pOp->p2>0 && pOp->p2+pOp->p3<=p->nMem );
3881   assert( i>=0 && i<p->nCursor );
3882   assert( p->apCsr[i]!=0 );
3883   if( (pCrsr = (pC = p->apCsr[i])->pCursor)!=0 ){
3884     int res;
3885     UnpackedRecord r;
3886     r.pKeyInfo = pC->pKeyInfo;
3887     r.nField = pOp->p3;
3888     r.needFree = 0;
3889     r.needDestroy = 0;
3890     r.aMem = &p->aMem[pOp->p2];
3891     rc = sqlite3BtreeMoveto(pCrsr, 0, &r, 0, 0, &res);
3892     if( rc==SQLITE_OK && res==0 ){
3893       rc = sqlite3BtreeDelete(pCrsr);
3894     }
3895     assert( pC->deferredMoveto==0 );
3896     pC->cacheStatus = CACHE_STALE;
3897   }
3898   break;
3899 }
3900 
3901 /* Opcode: IdxRowid P1 P2 * * *
3902 **
3903 ** Write into register P2 an integer which is the last entry in the record at
3904 ** the end of the index key pointed to by cursor P1.  This integer should be
3905 ** the rowid of the table entry to which this index entry points.
3906 **
3907 ** See also: Rowid, MakeIdxRec.
3908 */
3909 case OP_IdxRowid: {              /* out2-prerelease */
3910   int i = pOp->p1;
3911   BtCursor *pCrsr;
3912   Cursor *pC;
3913 
3914   assert( i>=0 && i<p->nCursor );
3915   assert( p->apCsr[i]!=0 );
3916   if( (pCrsr = (pC = p->apCsr[i])->pCursor)!=0 ){
3917     i64 rowid;
3918 
3919     assert( pC->deferredMoveto==0 );
3920     assert( pC->isTable==0 );
3921     if( !pC->nullRow ){
3922       rc = sqlite3VdbeIdxRowid(pCrsr, &rowid);
3923       if( rc!=SQLITE_OK ){
3924         goto abort_due_to_error;
3925       }
3926       MemSetTypeFlag(pOut, MEM_Int);
3927       pOut->u.i = rowid;
3928     }
3929   }
3930   break;
3931 }
3932 
3933 /* Opcode: IdxGE P1 P2 P3 P4 P5
3934 **
3935 ** The P4 register values beginning with P3 form an unpacked index
3936 ** key that omits the ROWID.  Compare this key value against the index
3937 ** that P1 is currently pointing to, ignoring the ROWID on the P1 index.
3938 **
3939 ** If the P1 index entry is greater than or equal to the key value
3940 ** then jump to P2.  Otherwise fall through to the next instruction.
3941 **
3942 ** If P5 is non-zero then the key value is increased by an epsilon
3943 ** prior to the comparison.  This make the opcode work like IdxGT except
3944 ** that if the key from register P3 is a prefix of the key in the cursor,
3945 ** the result is false whereas it would be true with IdxGT.
3946 */
3947 /* Opcode: IdxLT P1 P2 P3 * P5
3948 **
3949 ** The P4 register values beginning with P3 form an unpacked index
3950 ** key that omits the ROWID.  Compare this key value against the index
3951 ** that P1 is currently pointing to, ignoring the ROWID on the P1 index.
3952 **
3953 ** If the P1 index entry is less than the key value then jump to P2.
3954 ** Otherwise fall through to the next instruction.
3955 **
3956 ** If P5 is non-zero then the key value is increased by an epsilon prior
3957 ** to the comparison.  This makes the opcode work like IdxLE.
3958 */
3959 case OP_IdxLT:          /* jump, in3 */
3960 case OP_IdxGE: {        /* jump, in3 */
3961   int i= pOp->p1;
3962   Cursor *pC;
3963 
3964   assert( i>=0 && i<p->nCursor );
3965   assert( p->apCsr[i]!=0 );
3966   if( (pC = p->apCsr[i])->pCursor!=0 ){
3967     int res;
3968     UnpackedRecord r;
3969     assert( pC->deferredMoveto==0 );
3970     assert( pOp->p5==0 || pOp->p5==1 );
3971     assert( pOp->p4type==P4_INT32 );
3972     r.pKeyInfo = pC->pKeyInfo;
3973     r.nField = pOp->p4.i;
3974     r.needFree = 0;
3975     r.needDestroy = 0;
3976     r.aMem = &p->aMem[pOp->p3];
3977     *pC->pIncrKey = pOp->p5;
3978     rc = sqlite3VdbeIdxKeyCompare(pC, &r, 0, 0, &res);
3979     *pC->pIncrKey = 0;
3980     if( pOp->opcode==OP_IdxLT ){
3981       res = -res;
3982     }else{
3983       assert( pOp->opcode==OP_IdxGE );
3984       res++;
3985     }
3986     if( res>0 ){
3987       pc = pOp->p2 - 1 ;
3988     }
3989   }
3990   break;
3991 }
3992 
3993 /* Opcode: Destroy P1 P2 P3 * *
3994 **
3995 ** Delete an entire database table or index whose root page in the database
3996 ** file is given by P1.
3997 **
3998 ** The table being destroyed is in the main database file if P3==0.  If
3999 ** P3==1 then the table to be clear is in the auxiliary database file
4000 ** that is used to store tables create using CREATE TEMPORARY TABLE.
4001 **
4002 ** If AUTOVACUUM is enabled then it is possible that another root page
4003 ** might be moved into the newly deleted root page in order to keep all
4004 ** root pages contiguous at the beginning of the database.  The former
4005 ** value of the root page that moved - its value before the move occurred -
4006 ** is stored in register P2.  If no page
4007 ** movement was required (because the table being dropped was already
4008 ** the last one in the database) then a zero is stored in register P2.
4009 ** If AUTOVACUUM is disabled then a zero is stored in register P2.
4010 **
4011 ** See also: Clear
4012 */
4013 case OP_Destroy: {     /* out2-prerelease */
4014   int iMoved;
4015   int iCnt;
4016 #ifndef SQLITE_OMIT_VIRTUALTABLE
4017   Vdbe *pVdbe;
4018   iCnt = 0;
4019   for(pVdbe=db->pVdbe; pVdbe; pVdbe=pVdbe->pNext){
4020     if( pVdbe->magic==VDBE_MAGIC_RUN && pVdbe->inVtabMethod<2 && pVdbe->pc>=0 ){
4021       iCnt++;
4022     }
4023   }
4024 #else
4025   iCnt = db->activeVdbeCnt;
4026 #endif
4027   if( iCnt>1 ){
4028     rc = SQLITE_LOCKED;
4029     p->errorAction = OE_Abort;
4030   }else{
4031     int iDb = pOp->p3;
4032     assert( iCnt==1 );
4033     assert( (p->btreeMask & (1<<iDb))!=0 );
4034     rc = sqlite3BtreeDropTable(db->aDb[iDb].pBt, pOp->p1, &iMoved);
4035     MemSetTypeFlag(pOut, MEM_Int);
4036     pOut->u.i = iMoved;
4037 #ifndef SQLITE_OMIT_AUTOVACUUM
4038     if( rc==SQLITE_OK && iMoved!=0 ){
4039       sqlite3RootPageMoved(&db->aDb[iDb], iMoved, pOp->p1);
4040     }
4041 #endif
4042   }
4043   break;
4044 }
4045 
4046 /* Opcode: Clear P1 P2 *
4047 **
4048 ** Delete all contents of the database table or index whose root page
4049 ** in the database file is given by P1.  But, unlike Destroy, do not
4050 ** remove the table or index from the database file.
4051 **
4052 ** The table being clear is in the main database file if P2==0.  If
4053 ** P2==1 then the table to be clear is in the auxiliary database file
4054 ** that is used to store tables create using CREATE TEMPORARY TABLE.
4055 **
4056 ** See also: Destroy
4057 */
4058 case OP_Clear: {
4059   assert( (p->btreeMask & (1<<pOp->p2))!=0 );
4060   rc = sqlite3BtreeClearTable(db->aDb[pOp->p2].pBt, pOp->p1);
4061   break;
4062 }
4063 
4064 /* Opcode: CreateTable P1 P2 * * *
4065 **
4066 ** Allocate a new table in the main database file if P1==0 or in the
4067 ** auxiliary database file if P1==1 or in an attached database if
4068 ** P1>1.  Write the root page number of the new table into
4069 ** register P2
4070 **
4071 ** The difference between a table and an index is this:  A table must
4072 ** have a 4-byte integer key and can have arbitrary data.  An index
4073 ** has an arbitrary key but no data.
4074 **
4075 ** See also: CreateIndex
4076 */
4077 /* Opcode: CreateIndex P1 P2 * * *
4078 **
4079 ** Allocate a new index in the main database file if P1==0 or in the
4080 ** auxiliary database file if P1==1 or in an attached database if
4081 ** P1>1.  Write the root page number of the new table into
4082 ** register P2.
4083 **
4084 ** See documentation on OP_CreateTable for additional information.
4085 */
4086 case OP_CreateIndex:            /* out2-prerelease */
4087 case OP_CreateTable: {          /* out2-prerelease */
4088   int pgno;
4089   int flags;
4090   Db *pDb;
4091   assert( pOp->p1>=0 && pOp->p1<db->nDb );
4092   assert( (p->btreeMask & (1<<pOp->p1))!=0 );
4093   pDb = &db->aDb[pOp->p1];
4094   assert( pDb->pBt!=0 );
4095   if( pOp->opcode==OP_CreateTable ){
4096     /* flags = BTREE_INTKEY; */
4097     flags = BTREE_LEAFDATA|BTREE_INTKEY;
4098   }else{
4099     flags = BTREE_ZERODATA;
4100   }
4101   rc = sqlite3BtreeCreateTable(pDb->pBt, &pgno, flags);
4102   if( rc==SQLITE_OK ){
4103     pOut->u.i = pgno;
4104     MemSetTypeFlag(pOut, MEM_Int);
4105   }
4106   break;
4107 }
4108 
4109 /* Opcode: ParseSchema P1 P2 * P4 *
4110 **
4111 ** Read and parse all entries from the SQLITE_MASTER table of database P1
4112 ** that match the WHERE clause P4.  P2 is the "force" flag.   Always do
4113 ** the parsing if P2 is true.  If P2 is false, then this routine is a
4114 ** no-op if the schema is not currently loaded.  In other words, if P2
4115 ** is false, the SQLITE_MASTER table is only parsed if the rest of the
4116 ** schema is already loaded into the symbol table.
4117 **
4118 ** This opcode invokes the parser to create a new virtual machine,
4119 ** then runs the new virtual machine.  It is thus a re-entrant opcode.
4120 */
4121 case OP_ParseSchema: {
4122   char *zSql;
4123   int iDb = pOp->p1;
4124   const char *zMaster;
4125   InitData initData;
4126 
4127   assert( iDb>=0 && iDb<db->nDb );
4128   if( !pOp->p2 && !DbHasProperty(db, iDb, DB_SchemaLoaded) ){
4129     break;
4130   }
4131   zMaster = SCHEMA_TABLE(iDb);
4132   initData.db = db;
4133   initData.iDb = pOp->p1;
4134   initData.pzErrMsg = &p->zErrMsg;
4135   zSql = sqlite3MPrintf(db,
4136      "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s",
4137      db->aDb[iDb].zName, zMaster, pOp->p4.z);
4138   if( zSql==0 ) goto no_mem;
4139   (void)sqlite3SafetyOff(db);
4140   assert( db->init.busy==0 );
4141   db->init.busy = 1;
4142   assert( !db->mallocFailed );
4143   rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
4144   if( rc==SQLITE_ABORT ) rc = initData.rc;
4145   sqlite3_free(zSql);
4146   db->init.busy = 0;
4147   (void)sqlite3SafetyOn(db);
4148   if( rc==SQLITE_NOMEM ){
4149     goto no_mem;
4150   }
4151   break;
4152 }
4153 
4154 #if !defined(SQLITE_OMIT_ANALYZE) && !defined(SQLITE_OMIT_PARSER)
4155 /* Opcode: LoadAnalysis P1 * * * *
4156 **
4157 ** Read the sqlite_stat1 table for database P1 and load the content
4158 ** of that table into the internal index hash table.  This will cause
4159 ** the analysis to be used when preparing all subsequent queries.
4160 */
4161 case OP_LoadAnalysis: {
4162   int iDb = pOp->p1;
4163   assert( iDb>=0 && iDb<db->nDb );
4164   rc = sqlite3AnalysisLoad(db, iDb);
4165   break;
4166 }
4167 #endif /* !defined(SQLITE_OMIT_ANALYZE) && !defined(SQLITE_OMIT_PARSER)  */
4168 
4169 /* Opcode: DropTable P1 * * P4 *
4170 **
4171 ** Remove the internal (in-memory) data structures that describe
4172 ** the table named P4 in database P1.  This is called after a table
4173 ** is dropped in order to keep the internal representation of the
4174 ** schema consistent with what is on disk.
4175 */
4176 case OP_DropTable: {
4177   sqlite3UnlinkAndDeleteTable(db, pOp->p1, pOp->p4.z);
4178   break;
4179 }
4180 
4181 /* Opcode: DropIndex P1 * * P4 *
4182 **
4183 ** Remove the internal (in-memory) data structures that describe
4184 ** the index named P4 in database P1.  This is called after an index
4185 ** is dropped in order to keep the internal representation of the
4186 ** schema consistent with what is on disk.
4187 */
4188 case OP_DropIndex: {
4189   sqlite3UnlinkAndDeleteIndex(db, pOp->p1, pOp->p4.z);
4190   break;
4191 }
4192 
4193 /* Opcode: DropTrigger P1 * * P4 *
4194 **
4195 ** Remove the internal (in-memory) data structures that describe
4196 ** the trigger named P4 in database P1.  This is called after a trigger
4197 ** is dropped in order to keep the internal representation of the
4198 ** schema consistent with what is on disk.
4199 */
4200 case OP_DropTrigger: {
4201   sqlite3UnlinkAndDeleteTrigger(db, pOp->p1, pOp->p4.z);
4202   break;
4203 }
4204 
4205 
4206 #ifndef SQLITE_OMIT_INTEGRITY_CHECK
4207 /* Opcode: IntegrityCk P1 P2 P3 * P5
4208 **
4209 ** Do an analysis of the currently open database.  Store in
4210 ** register P1 the text of an error message describing any problems.
4211 ** If no problems are found, store a NULL in register P1.
4212 **
4213 ** The register P3 contains the maximum number of allowed errors.
4214 ** At most reg(P3) errors will be reported.
4215 ** In other words, the analysis stops as soon as reg(P1) errors are
4216 ** seen.  Reg(P1) is updated with the number of errors remaining.
4217 **
4218 ** The root page numbers of all tables in the database are integer
4219 ** stored in reg(P1), reg(P1+1), reg(P1+2), ....  There are P2 tables
4220 ** total.
4221 **
4222 ** If P5 is not zero, the check is done on the auxiliary database
4223 ** file, not the main database file.
4224 **
4225 ** This opcode is used to implement the integrity_check pragma.
4226 */
4227 case OP_IntegrityCk: {
4228   int nRoot;      /* Number of tables to check.  (Number of root pages.) */
4229   int *aRoot;     /* Array of rootpage numbers for tables to be checked */
4230   int j;          /* Loop counter */
4231   int nErr;       /* Number of errors reported */
4232   char *z;        /* Text of the error report */
4233   Mem *pnErr;     /* Register keeping track of errors remaining */
4234 
4235   nRoot = pOp->p2;
4236   assert( nRoot>0 );
4237   aRoot = sqlite3Malloc( sizeof(int)*(nRoot+1) );
4238   if( aRoot==0 ) goto no_mem;
4239   assert( pOp->p3>0 && pOp->p3<=p->nMem );
4240   pnErr = &p->aMem[pOp->p3];
4241   assert( (pnErr->flags & MEM_Int)!=0 );
4242   assert( (pnErr->flags & (MEM_Str|MEM_Blob))==0 );
4243   pIn1 = &p->aMem[pOp->p1];
4244   for(j=0; j<nRoot; j++){
4245     aRoot[j] = sqlite3VdbeIntValue(&pIn1[j]);
4246   }
4247   aRoot[j] = 0;
4248   assert( pOp->p5<db->nDb );
4249   assert( (p->btreeMask & (1<<pOp->p5))!=0 );
4250   z = sqlite3BtreeIntegrityCheck(db->aDb[pOp->p5].pBt, aRoot, nRoot,
4251                                  pnErr->u.i, &nErr);
4252   pnErr->u.i -= nErr;
4253   sqlite3VdbeMemSetNull(pIn1);
4254   if( nErr==0 ){
4255     assert( z==0 );
4256   }else{
4257     sqlite3VdbeMemSetStr(pIn1, z, -1, SQLITE_UTF8, sqlite3_free);
4258   }
4259   UPDATE_MAX_BLOBSIZE(pIn1);
4260   sqlite3VdbeChangeEncoding(pIn1, encoding);
4261   sqlite3_free(aRoot);
4262   break;
4263 }
4264 #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
4265 
4266 /* Opcode: FifoWrite P1 * * * *
4267 **
4268 ** Write the integer from register P1 into the Fifo.
4269 */
4270 case OP_FifoWrite: {        /* in1 */
4271   if( sqlite3VdbeFifoPush(&p->sFifo, sqlite3VdbeIntValue(pIn1))==SQLITE_NOMEM ){
4272     goto no_mem;
4273   }
4274   break;
4275 }
4276 
4277 /* Opcode: FifoRead P1 P2 * * *
4278 **
4279 ** Attempt to read a single integer from the Fifo.  Store that
4280 ** integer in register P1.
4281 **
4282 ** If the Fifo is empty jump to P2.
4283 */
4284 case OP_FifoRead: {         /* jump */
4285   CHECK_FOR_INTERRUPT;
4286   assert( pOp->p1>0 && pOp->p1<=p->nMem );
4287   pOut = &p->aMem[pOp->p1];
4288   MemSetTypeFlag(pOut, MEM_Int);
4289   if( sqlite3VdbeFifoPop(&p->sFifo, &pOut->u.i)==SQLITE_DONE ){
4290     pc = pOp->p2 - 1;
4291   }
4292   break;
4293 }
4294 
4295 #ifndef SQLITE_OMIT_TRIGGER
4296 /* Opcode: ContextPush * * *
4297 **
4298 ** Save the current Vdbe context such that it can be restored by a ContextPop
4299 ** opcode. The context stores the last insert row id, the last statement change
4300 ** count, and the current statement change count.
4301 */
4302 case OP_ContextPush: {
4303   int i = p->contextStackTop++;
4304   Context *pContext;
4305 
4306   assert( i>=0 );
4307   /* FIX ME: This should be allocated as part of the vdbe at compile-time */
4308   if( i>=p->contextStackDepth ){
4309     p->contextStackDepth = i+1;
4310     p->contextStack = sqlite3DbReallocOrFree(db, p->contextStack,
4311                                           sizeof(Context)*(i+1));
4312     if( p->contextStack==0 ) goto no_mem;
4313   }
4314   pContext = &p->contextStack[i];
4315   pContext->lastRowid = db->lastRowid;
4316   pContext->nChange = p->nChange;
4317   pContext->sFifo = p->sFifo;
4318   sqlite3VdbeFifoInit(&p->sFifo);
4319   break;
4320 }
4321 
4322 /* Opcode: ContextPop * * *
4323 **
4324 ** Restore the Vdbe context to the state it was in when contextPush was last
4325 ** executed. The context stores the last insert row id, the last statement
4326 ** change count, and the current statement change count.
4327 */
4328 case OP_ContextPop: {
4329   Context *pContext = &p->contextStack[--p->contextStackTop];
4330   assert( p->contextStackTop>=0 );
4331   db->lastRowid = pContext->lastRowid;
4332   p->nChange = pContext->nChange;
4333   sqlite3VdbeFifoClear(&p->sFifo);
4334   p->sFifo = pContext->sFifo;
4335   break;
4336 }
4337 #endif /* #ifndef SQLITE_OMIT_TRIGGER */
4338 
4339 #ifndef SQLITE_OMIT_AUTOINCREMENT
4340 /* Opcode: MemMax P1 P2 * * *
4341 **
4342 ** Set the value of register P1 to the maximum of its current value
4343 ** and the value in register P2.
4344 **
4345 ** This instruction throws an error if the memory cell is not initially
4346 ** an integer.
4347 */
4348 case OP_MemMax: {        /* in1, in2 */
4349   sqlite3VdbeMemIntegerify(pIn1);
4350   sqlite3VdbeMemIntegerify(pIn2);
4351   if( pIn1->u.i<pIn2->u.i){
4352     pIn1->u.i = pIn2->u.i;
4353   }
4354   break;
4355 }
4356 #endif /* SQLITE_OMIT_AUTOINCREMENT */
4357 
4358 /* Opcode: IfPos P1 P2 * * *
4359 **
4360 ** If the value of register P1 is 1 or greater, jump to P2.
4361 **
4362 ** It is illegal to use this instruction on a register that does
4363 ** not contain an integer.  An assertion fault will result if you try.
4364 */
4365 case OP_IfPos: {        /* jump, in1 */
4366   assert( pIn1->flags&MEM_Int );
4367   if( pIn1->u.i>0 ){
4368      pc = pOp->p2 - 1;
4369   }
4370   break;
4371 }
4372 
4373 /* Opcode: IfNeg P1 P2 * * *
4374 **
4375 ** If the value of register P1 is less than zero, jump to P2.
4376 **
4377 ** It is illegal to use this instruction on a register that does
4378 ** not contain an integer.  An assertion fault will result if you try.
4379 */
4380 case OP_IfNeg: {        /* jump, in1 */
4381   assert( pIn1->flags&MEM_Int );
4382   if( pIn1->u.i<0 ){
4383      pc = pOp->p2 - 1;
4384   }
4385   break;
4386 }
4387 
4388 /* Opcode: IfZero P1 P2 * * *
4389 **
4390 ** If the value of register P1 is exactly 0, jump to P2.
4391 **
4392 ** It is illegal to use this instruction on a register that does
4393 ** not contain an integer.  An assertion fault will result if you try.
4394 */
4395 case OP_IfZero: {        /* jump, in1 */
4396   assert( pIn1->flags&MEM_Int );
4397   if( pIn1->u.i==0 ){
4398      pc = pOp->p2 - 1;
4399   }
4400   break;
4401 }
4402 
4403 /* Opcode: AggStep * P2 P3 P4 P5
4404 **
4405 ** Execute the step function for an aggregate.  The
4406 ** function has P5 arguments.   P4 is a pointer to the FuncDef
4407 ** structure that specifies the function.  Use register
4408 ** P3 as the accumulator.
4409 **
4410 ** The P5 arguments are taken from register P2 and its
4411 ** successors.
4412 */
4413 case OP_AggStep: {
4414   int n = pOp->p5;
4415   int i;
4416   Mem *pMem, *pRec;
4417   sqlite3_context ctx;
4418   sqlite3_value **apVal;
4419 
4420   assert( n>=0 );
4421   pRec = &p->aMem[pOp->p2];
4422   apVal = p->apArg;
4423   assert( apVal || n==0 );
4424   for(i=0; i<n; i++, pRec++){
4425     apVal[i] = pRec;
4426     storeTypeInfo(pRec, encoding);
4427   }
4428   ctx.pFunc = pOp->p4.pFunc;
4429   assert( pOp->p3>0 && pOp->p3<=p->nMem );
4430   ctx.pMem = pMem = &p->aMem[pOp->p3];
4431   pMem->n++;
4432   ctx.s.flags = MEM_Null;
4433   ctx.s.z = 0;
4434   ctx.s.zMalloc = 0;
4435   ctx.s.xDel = 0;
4436   ctx.s.db = db;
4437   ctx.isError = 0;
4438   ctx.pColl = 0;
4439   if( ctx.pFunc->needCollSeq ){
4440     assert( pOp>p->aOp );
4441     assert( pOp[-1].p4type==P4_COLLSEQ );
4442     assert( pOp[-1].opcode==OP_CollSeq );
4443     ctx.pColl = pOp[-1].p4.pColl;
4444   }
4445   (ctx.pFunc->xStep)(&ctx, n, apVal);
4446   if( ctx.isError ){
4447     sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3_value_text(&ctx.s));
4448     rc = ctx.isError;
4449   }
4450   sqlite3VdbeMemRelease(&ctx.s);
4451   break;
4452 }
4453 
4454 /* Opcode: AggFinal P1 P2 * P4 *
4455 **
4456 ** Execute the finalizer function for an aggregate.  P1 is
4457 ** the memory location that is the accumulator for the aggregate.
4458 **
4459 ** P2 is the number of arguments that the step function takes and
4460 ** P4 is a pointer to the FuncDef for this function.  The P2
4461 ** argument is not used by this opcode.  It is only there to disambiguate
4462 ** functions that can take varying numbers of arguments.  The
4463 ** P4 argument is only needed for the degenerate case where
4464 ** the step function was not previously called.
4465 */
4466 case OP_AggFinal: {
4467   Mem *pMem;
4468   assert( pOp->p1>0 && pOp->p1<=p->nMem );
4469   pMem = &p->aMem[pOp->p1];
4470   assert( (pMem->flags & ~(MEM_Null|MEM_Agg))==0 );
4471   rc = sqlite3VdbeMemFinalize(pMem, pOp->p4.pFunc);
4472   if( rc==SQLITE_ERROR ){
4473     sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3_value_text(pMem));
4474   }
4475   sqlite3VdbeChangeEncoding(pMem, encoding);
4476   UPDATE_MAX_BLOBSIZE(pMem);
4477   if( sqlite3VdbeMemTooBig(pMem) ){
4478     goto too_big;
4479   }
4480   break;
4481 }
4482 
4483 
4484 #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
4485 /* Opcode: Vacuum * * * * *
4486 **
4487 ** Vacuum the entire database.  This opcode will cause other virtual
4488 ** machines to be created and run.  It may not be called from within
4489 ** a transaction.
4490 */
4491 case OP_Vacuum: {
4492   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4493   rc = sqlite3RunVacuum(&p->zErrMsg, db);
4494   if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4495   break;
4496 }
4497 #endif
4498 
4499 #if !defined(SQLITE_OMIT_AUTOVACUUM)
4500 /* Opcode: IncrVacuum P1 P2 * * *
4501 **
4502 ** Perform a single step of the incremental vacuum procedure on
4503 ** the P1 database. If the vacuum has finished, jump to instruction
4504 ** P2. Otherwise, fall through to the next instruction.
4505 */
4506 case OP_IncrVacuum: {        /* jump */
4507   Btree *pBt;
4508 
4509   assert( pOp->p1>=0 && pOp->p1<db->nDb );
4510   assert( (p->btreeMask & (1<<pOp->p1))!=0 );
4511   pBt = db->aDb[pOp->p1].pBt;
4512   rc = sqlite3BtreeIncrVacuum(pBt);
4513   if( rc==SQLITE_DONE ){
4514     pc = pOp->p2 - 1;
4515     rc = SQLITE_OK;
4516   }
4517   break;
4518 }
4519 #endif
4520 
4521 /* Opcode: Expire P1 * * * *
4522 **
4523 ** Cause precompiled statements to become expired. An expired statement
4524 ** fails with an error code of SQLITE_SCHEMA if it is ever executed
4525 ** (via sqlite3_step()).
4526 **
4527 ** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
4528 ** then only the currently executing statement is affected.
4529 */
4530 case OP_Expire: {
4531   if( !pOp->p1 ){
4532     sqlite3ExpirePreparedStatements(db);
4533   }else{
4534     p->expired = 1;
4535   }
4536   break;
4537 }
4538 
4539 #ifndef SQLITE_OMIT_SHARED_CACHE
4540 /* Opcode: TableLock P1 P2 P3 P4 *
4541 **
4542 ** Obtain a lock on a particular table. This instruction is only used when
4543 ** the shared-cache feature is enabled.
4544 **
4545 ** If P1 is  the index of the database in sqlite3.aDb[] of the database
4546 ** on which the lock is acquired.  A readlock is obtained if P3==0 or
4547 ** a write lock if P3==1.
4548 **
4549 ** P2 contains the root-page of the table to lock.
4550 **
4551 ** P4 contains a pointer to the name of the table being locked. This is only
4552 ** used to generate an error message if the lock cannot be obtained.
4553 */
4554 case OP_TableLock: {
4555   int p1 = pOp->p1;
4556   u8 isWriteLock = pOp->p3;
4557   assert( p1>=0 && p1<db->nDb );
4558   assert( (p->btreeMask & (1<<p1))!=0 );
4559   assert( isWriteLock==0 || isWriteLock==1 );
4560   rc = sqlite3BtreeLockTable(db->aDb[p1].pBt, pOp->p2, isWriteLock);
4561   if( rc==SQLITE_LOCKED ){
4562     const char *z = pOp->p4.z;
4563     sqlite3SetString(&p->zErrMsg, db, "database table is locked: %s", z);
4564   }
4565   break;
4566 }
4567 #endif /* SQLITE_OMIT_SHARED_CACHE */
4568 
4569 #ifndef SQLITE_OMIT_VIRTUALTABLE
4570 /* Opcode: VBegin * * * P4 *
4571 **
4572 ** P4 a pointer to an sqlite3_vtab structure. Call the xBegin method
4573 ** for that table.
4574 */
4575 case OP_VBegin: {
4576   rc = sqlite3VtabBegin(db, pOp->p4.pVtab);
4577   break;
4578 }
4579 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4580 
4581 #ifndef SQLITE_OMIT_VIRTUALTABLE
4582 /* Opcode: VCreate P1 * * P4 *
4583 **
4584 ** P4 is the name of a virtual table in database P1. Call the xCreate method
4585 ** for that table.
4586 */
4587 case OP_VCreate: {
4588   rc = sqlite3VtabCallCreate(db, pOp->p1, pOp->p4.z, &p->zErrMsg);
4589   break;
4590 }
4591 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4592 
4593 #ifndef SQLITE_OMIT_VIRTUALTABLE
4594 /* Opcode: VDestroy P1 * * P4 *
4595 **
4596 ** P4 is the name of a virtual table in database P1.  Call the xDestroy method
4597 ** of that table.
4598 */
4599 case OP_VDestroy: {
4600   p->inVtabMethod = 2;
4601   rc = sqlite3VtabCallDestroy(db, pOp->p1, pOp->p4.z);
4602   p->inVtabMethod = 0;
4603   break;
4604 }
4605 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4606 
4607 #ifndef SQLITE_OMIT_VIRTUALTABLE
4608 /* Opcode: VOpen P1 * * P4 *
4609 **
4610 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
4611 ** P1 is a cursor number.  This opcode opens a cursor to the virtual
4612 ** table and stores that cursor in P1.
4613 */
4614 case OP_VOpen: {
4615   Cursor *pCur = 0;
4616   sqlite3_vtab_cursor *pVtabCursor = 0;
4617 
4618   sqlite3_vtab *pVtab = pOp->p4.pVtab;
4619   sqlite3_module *pModule = (sqlite3_module *)pVtab->pModule;
4620 
4621   assert(pVtab && pModule);
4622   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4623   rc = pModule->xOpen(pVtab, &pVtabCursor);
4624   if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4625   if( SQLITE_OK==rc ){
4626     /* Initialize sqlite3_vtab_cursor base class */
4627     pVtabCursor->pVtab = pVtab;
4628 
4629     /* Initialise vdbe cursor object */
4630     pCur = allocateCursor(p, pOp->p1, &pOp[-1], -1, 0);
4631     if( pCur ){
4632       pCur->pVtabCursor = pVtabCursor;
4633       pCur->pModule = pVtabCursor->pVtab->pModule;
4634     }else{
4635       db->mallocFailed = 1;
4636       pModule->xClose(pVtabCursor);
4637     }
4638   }
4639   break;
4640 }
4641 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4642 
4643 #ifndef SQLITE_OMIT_VIRTUALTABLE
4644 /* Opcode: VFilter P1 P2 P3 P4 *
4645 **
4646 ** P1 is a cursor opened using VOpen.  P2 is an address to jump to if
4647 ** the filtered result set is empty.
4648 **
4649 ** P4 is either NULL or a string that was generated by the xBestIndex
4650 ** method of the module.  The interpretation of the P4 string is left
4651 ** to the module implementation.
4652 **
4653 ** This opcode invokes the xFilter method on the virtual table specified
4654 ** by P1.  The integer query plan parameter to xFilter is stored in register
4655 ** P3. Register P3+1 stores the argc parameter to be passed to the
4656 ** xFilter method. Registers P3+2..P3+1+argc are the argc
4657 ** additional parameters which are passed to
4658 ** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
4659 **
4660 ** A jump is made to P2 if the result set after filtering would be empty.
4661 */
4662 case OP_VFilter: {   /* jump */
4663   int nArg;
4664   int iQuery;
4665   const sqlite3_module *pModule;
4666   Mem *pQuery = &p->aMem[pOp->p3];
4667   Mem *pArgc = &pQuery[1];
4668 
4669   Cursor *pCur = p->apCsr[pOp->p1];
4670 
4671   REGISTER_TRACE(pOp->p3, pQuery);
4672   assert( pCur->pVtabCursor );
4673   pModule = pCur->pVtabCursor->pVtab->pModule;
4674 
4675   /* Grab the index number and argc parameters */
4676   assert( (pQuery->flags&MEM_Int)!=0 && pArgc->flags==MEM_Int );
4677   nArg = pArgc->u.i;
4678   iQuery = pQuery->u.i;
4679 
4680   /* Invoke the xFilter method */
4681   {
4682     int res = 0;
4683     int i;
4684     Mem **apArg = p->apArg;
4685     for(i = 0; i<nArg; i++){
4686       apArg[i] = &pArgc[i+1];
4687       storeTypeInfo(apArg[i], 0);
4688     }
4689 
4690     if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4691     p->inVtabMethod = 1;
4692     rc = pModule->xFilter(pCur->pVtabCursor, iQuery, pOp->p4.z, nArg, apArg);
4693     p->inVtabMethod = 0;
4694     if( rc==SQLITE_OK ){
4695       res = pModule->xEof(pCur->pVtabCursor);
4696     }
4697     if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4698 
4699     if( res ){
4700       pc = pOp->p2 - 1;
4701     }
4702   }
4703   pCur->nullRow = 0;
4704 
4705   break;
4706 }
4707 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4708 
4709 #ifndef SQLITE_OMIT_VIRTUALTABLE
4710 /* Opcode: VRowid P1 P2 * * *
4711 **
4712 ** Store into register P2  the rowid of
4713 ** the virtual-table that the P1 cursor is pointing to.
4714 */
4715 case OP_VRowid: {             /* out2-prerelease */
4716   const sqlite3_module *pModule;
4717   sqlite_int64 iRow;
4718   Cursor *pCur = p->apCsr[pOp->p1];
4719 
4720   assert( pCur->pVtabCursor );
4721   if( pCur->nullRow ){
4722     break;
4723   }
4724   pModule = pCur->pVtabCursor->pVtab->pModule;
4725   assert( pModule->xRowid );
4726   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4727   rc = pModule->xRowid(pCur->pVtabCursor, &iRow);
4728   if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4729   MemSetTypeFlag(pOut, MEM_Int);
4730   pOut->u.i = iRow;
4731   break;
4732 }
4733 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4734 
4735 #ifndef SQLITE_OMIT_VIRTUALTABLE
4736 /* Opcode: VColumn P1 P2 P3 * *
4737 **
4738 ** Store the value of the P2-th column of
4739 ** the row of the virtual-table that the
4740 ** P1 cursor is pointing to into register P3.
4741 */
4742 case OP_VColumn: {
4743   const sqlite3_module *pModule;
4744   Mem *pDest;
4745   sqlite3_context sContext;
4746 
4747   Cursor *pCur = p->apCsr[pOp->p1];
4748   assert( pCur->pVtabCursor );
4749   assert( pOp->p3>0 && pOp->p3<=p->nMem );
4750   pDest = &p->aMem[pOp->p3];
4751   if( pCur->nullRow ){
4752     sqlite3VdbeMemSetNull(pDest);
4753     break;
4754   }
4755   pModule = pCur->pVtabCursor->pVtab->pModule;
4756   assert( pModule->xColumn );
4757   memset(&sContext, 0, sizeof(sContext));
4758 
4759   /* The output cell may already have a buffer allocated. Move
4760   ** the current contents to sContext.s so in case the user-function
4761   ** can use the already allocated buffer instead of allocating a
4762   ** new one.
4763   */
4764   sqlite3VdbeMemMove(&sContext.s, pDest);
4765   MemSetTypeFlag(&sContext.s, MEM_Null);
4766 
4767   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4768   rc = pModule->xColumn(pCur->pVtabCursor, &sContext, pOp->p2);
4769 
4770   /* Copy the result of the function to the P3 register. We
4771   ** do this regardless of whether or not an error occured to ensure any
4772   ** dynamic allocation in sContext.s (a Mem struct) is  released.
4773   */
4774   sqlite3VdbeChangeEncoding(&sContext.s, encoding);
4775   REGISTER_TRACE(pOp->p3, pDest);
4776   sqlite3VdbeMemMove(pDest, &sContext.s);
4777   UPDATE_MAX_BLOBSIZE(pDest);
4778 
4779   if( sqlite3SafetyOn(db) ){
4780     goto abort_due_to_misuse;
4781   }
4782   if( sqlite3VdbeMemTooBig(pDest) ){
4783     goto too_big;
4784   }
4785   break;
4786 }
4787 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4788 
4789 #ifndef SQLITE_OMIT_VIRTUALTABLE
4790 /* Opcode: VNext P1 P2 * * *
4791 **
4792 ** Advance virtual table P1 to the next row in its result set and
4793 ** jump to instruction P2.  Or, if the virtual table has reached
4794 ** the end of its result set, then fall through to the next instruction.
4795 */
4796 case OP_VNext: {   /* jump */
4797   const sqlite3_module *pModule;
4798   int res = 0;
4799 
4800   Cursor *pCur = p->apCsr[pOp->p1];
4801   assert( pCur->pVtabCursor );
4802   if( pCur->nullRow ){
4803     break;
4804   }
4805   pModule = pCur->pVtabCursor->pVtab->pModule;
4806   assert( pModule->xNext );
4807 
4808   /* Invoke the xNext() method of the module. There is no way for the
4809   ** underlying implementation to return an error if one occurs during
4810   ** xNext(). Instead, if an error occurs, true is returned (indicating that
4811   ** data is available) and the error code returned when xColumn or
4812   ** some other method is next invoked on the save virtual table cursor.
4813   */
4814   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4815   p->inVtabMethod = 1;
4816   rc = pModule->xNext(pCur->pVtabCursor);
4817   p->inVtabMethod = 0;
4818   if( rc==SQLITE_OK ){
4819     res = pModule->xEof(pCur->pVtabCursor);
4820   }
4821   if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4822 
4823   if( !res ){
4824     /* If there is data, jump to P2 */
4825     pc = pOp->p2 - 1;
4826   }
4827   break;
4828 }
4829 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4830 
4831 #ifndef SQLITE_OMIT_VIRTUALTABLE
4832 /* Opcode: VRename P1 * * P4 *
4833 **
4834 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
4835 ** This opcode invokes the corresponding xRename method. The value
4836 ** in register P1 is passed as the zName argument to the xRename method.
4837 */
4838 case OP_VRename: {
4839   sqlite3_vtab *pVtab = pOp->p4.pVtab;
4840   Mem *pName = &p->aMem[pOp->p1];
4841   assert( pVtab->pModule->xRename );
4842   REGISTER_TRACE(pOp->p1, pName);
4843 
4844   Stringify(pName, encoding);
4845 
4846   if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4847   sqlite3VtabLock(pVtab);
4848   rc = pVtab->pModule->xRename(pVtab, pName->z);
4849   sqlite3VtabUnlock(db, pVtab);
4850   if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4851 
4852   break;
4853 }
4854 #endif
4855 
4856 #ifndef SQLITE_OMIT_VIRTUALTABLE
4857 /* Opcode: VUpdate P1 P2 P3 P4 *
4858 **
4859 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
4860 ** This opcode invokes the corresponding xUpdate method. P2 values
4861 ** are contiguous memory cells starting at P3 to pass to the xUpdate
4862 ** invocation. The value in register (P3+P2-1) corresponds to the
4863 ** p2th element of the argv array passed to xUpdate.
4864 **
4865 ** The xUpdate method will do a DELETE or an INSERT or both.
4866 ** The argv[0] element (which corresponds to memory cell P3)
4867 ** is the rowid of a row to delete.  If argv[0] is NULL then no
4868 ** deletion occurs.  The argv[1] element is the rowid of the new
4869 ** row.  This can be NULL to have the virtual table select the new
4870 ** rowid for itself.  The subsequent elements in the array are
4871 ** the values of columns in the new row.
4872 **
4873 ** If P2==1 then no insert is performed.  argv[0] is the rowid of
4874 ** a row to delete.
4875 **
4876 ** P1 is a boolean flag. If it is set to true and the xUpdate call
4877 ** is successful, then the value returned by sqlite3_last_insert_rowid()
4878 ** is set to the value of the rowid for the row just inserted.
4879 */
4880 case OP_VUpdate: {
4881   sqlite3_vtab *pVtab = pOp->p4.pVtab;
4882   sqlite3_module *pModule = (sqlite3_module *)pVtab->pModule;
4883   int nArg = pOp->p2;
4884   assert( pOp->p4type==P4_VTAB );
4885   if( pModule->xUpdate==0 ){
4886     sqlite3SetString(&p->zErrMsg, db, "read-only table");
4887     rc = SQLITE_ERROR;
4888   }else{
4889     int i;
4890     sqlite_int64 rowid;
4891     Mem **apArg = p->apArg;
4892     Mem *pX = &p->aMem[pOp->p3];
4893     for(i=0; i<nArg; i++){
4894       storeTypeInfo(pX, 0);
4895       apArg[i] = pX;
4896       pX++;
4897     }
4898     if( sqlite3SafetyOff(db) ) goto abort_due_to_misuse;
4899     sqlite3VtabLock(pVtab);
4900     rc = pModule->xUpdate(pVtab, nArg, apArg, &rowid);
4901     sqlite3VtabUnlock(db, pVtab);
4902     if( sqlite3SafetyOn(db) ) goto abort_due_to_misuse;
4903     if( pOp->p1 && rc==SQLITE_OK ){
4904       assert( nArg>1 && apArg[0] && (apArg[0]->flags&MEM_Null) );
4905       db->lastRowid = rowid;
4906     }
4907     p->nChange++;
4908   }
4909   break;
4910 }
4911 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4912 
4913 #ifndef  SQLITE_OMIT_PAGER_PRAGMAS
4914 /* Opcode: Pagecount P1 P2 * * *
4915 **
4916 ** Write the current number of pages in database P1 to memory cell P2.
4917 */
4918 case OP_Pagecount: {            /* out2-prerelease */
4919   int p1 = pOp->p1;
4920   int nPage;
4921   Pager *pPager = sqlite3BtreePager(db->aDb[p1].pBt);
4922 
4923   rc = sqlite3PagerPagecount(pPager, &nPage);
4924   if( rc==SQLITE_OK ){
4925     pOut->flags = MEM_Int;
4926     pOut->u.i = nPage;
4927   }
4928   break;
4929 }
4930 #endif
4931 
4932 #ifndef SQLITE_OMIT_TRACE
4933 /* Opcode: Trace * * * P4 *
4934 **
4935 ** If tracing is enabled (by the sqlite3_trace()) interface, then
4936 ** the UTF-8 string contained in P4 is emitted on the trace callback.
4937 */
4938 case OP_Trace: {
4939   if( pOp->p4.z ){
4940     if( db->xTrace ){
4941       db->xTrace(db->pTraceArg, pOp->p4.z);
4942     }
4943 #ifdef SQLITE_DEBUG
4944     if( (db->flags & SQLITE_SqlTrace)!=0 ){
4945       sqlite3DebugPrintf("SQL-trace: %s\n", pOp->p4.z);
4946     }
4947 #endif /* SQLITE_DEBUG */
4948   }
4949   break;
4950 }
4951 #endif
4952 
4953 
4954 /* Opcode: Noop * * * * *
4955 **
4956 ** Do nothing.  This instruction is often useful as a jump
4957 ** destination.
4958 */
4959 /*
4960 ** The magic Explain opcode are only inserted when explain==2 (which
4961 ** is to say when the EXPLAIN QUERY PLAN syntax is used.)
4962 ** This opcode records information from the optimizer.  It is the
4963 ** the same as a no-op.  This opcodesnever appears in a real VM program.
4964 */
4965 default: {          /* This is really OP_Noop and OP_Explain */
4966   break;
4967 }
4968 
4969 /*****************************************************************************
4970 ** The cases of the switch statement above this line should all be indented
4971 ** by 6 spaces.  But the left-most 6 spaces have been removed to improve the
4972 ** readability.  From this point on down, the normal indentation rules are
4973 ** restored.
4974 *****************************************************************************/
4975     }
4976 
4977 #ifdef VDBE_PROFILE
4978     {
4979       u64 elapsed = sqlite3Hwtime() - start;
4980       pOp->cycles += elapsed;
4981       pOp->cnt++;
4982 #if 0
4983         fprintf(stdout, "%10llu ", elapsed);
4984         sqlite3VdbePrintOp(stdout, origPc, &p->aOp[origPc]);
4985 #endif
4986     }
4987 #endif
4988 
4989     /* The following code adds nothing to the actual functionality
4990     ** of the program.  It is only here for testing and debugging.
4991     ** On the other hand, it does burn CPU cycles every time through
4992     ** the evaluator loop.  So we can leave it out when NDEBUG is defined.
4993     */
4994 #ifndef NDEBUG
4995     assert( pc>=-1 && pc<p->nOp );
4996 
4997 #ifdef SQLITE_DEBUG
4998     if( p->trace ){
4999       if( rc!=0 ) fprintf(p->trace,"rc=%d\n",rc);
5000       if( opProperty & OPFLG_OUT2_PRERELEASE ){
5001         registerTrace(p->trace, pOp->p2, pOut);
5002       }
5003       if( opProperty & OPFLG_OUT3 ){
5004         registerTrace(p->trace, pOp->p3, pOut);
5005       }
5006     }
5007 #endif  /* SQLITE_DEBUG */
5008 #endif  /* NDEBUG */
5009   }  /* The end of the for(;;) loop the loops through opcodes */
5010 
5011   /* If we reach this point, it means that execution is finished with
5012   ** an error of some kind.
5013   */
5014 vdbe_error_halt:
5015   assert( rc );
5016   p->rc = rc;
5017   sqlite3VdbeHalt(p);
5018   if( rc==SQLITE_IOERR_NOMEM ) db->mallocFailed = 1;
5019   rc = SQLITE_ERROR;
5020 
5021   /* This is the only way out of this procedure.  We have to
5022   ** release the mutexes on btrees that were acquired at the
5023   ** top. */
5024 vdbe_return:
5025   sqlite3BtreeMutexArrayLeave(&p->aMutex);
5026   return rc;
5027 
5028   /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
5029   ** is encountered.
5030   */
5031 too_big:
5032   sqlite3SetString(&p->zErrMsg, db, "string or blob too big");
5033   rc = SQLITE_TOOBIG;
5034   goto vdbe_error_halt;
5035 
5036   /* Jump to here if a malloc() fails.
5037   */
5038 no_mem:
5039   db->mallocFailed = 1;
5040   sqlite3SetString(&p->zErrMsg, db, "out of memory");
5041   rc = SQLITE_NOMEM;
5042   goto vdbe_error_halt;
5043 
5044   /* Jump to here for an SQLITE_MISUSE error.
5045   */
5046 abort_due_to_misuse:
5047   rc = SQLITE_MISUSE;
5048   /* Fall thru into abort_due_to_error */
5049 
5050   /* Jump to here for any other kind of fatal error.  The "rc" variable
5051   ** should hold the error number.
5052   */
5053 abort_due_to_error:
5054   assert( p->zErrMsg==0 );
5055   if( db->mallocFailed ) rc = SQLITE_NOMEM;
5056   if( rc!=SQLITE_IOERR_NOMEM ){
5057     sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3ErrStr(rc));
5058   }
5059   goto vdbe_error_halt;
5060 
5061   /* Jump to here if the sqlite3_interrupt() API sets the interrupt
5062   ** flag.
5063   */
5064 abort_due_to_interrupt:
5065   assert( db->u1.isInterrupted );
5066   rc = SQLITE_INTERRUPT;
5067   p->rc = rc;
5068   sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3ErrStr(rc));
5069   goto vdbe_error_halt;
5070 }
5071