Change the function name to sqlite_unsupported_offset(X). Only enable the
[sqlite.git] / src / vdbe.c
blob26336d940b31c344a94399c4213d3f53513eb6ca
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.
11 *************************************************************************
12 ** The code in this file implements the function that runs the
13 ** bytecode of a prepared statement.
15 ** Various scripts scan this source file in order to generate HTML
16 ** documentation, headers files, or other derived files. The formatting
17 ** of the code in this file is, therefore, important. See other comments
18 ** in this file for details. If in doubt, do not deviate from existing
19 ** commenting and indentation practices when changing or adding code.
21 #include "sqliteInt.h"
22 #include "vdbeInt.h"
25 ** Invoke this macro on memory cells just prior to changing the
26 ** value of the cell. This macro verifies that shallow copies are
27 ** not misused. A shallow copy of a string or blob just copies a
28 ** pointer to the string or blob, not the content. If the original
29 ** is changed while the copy is still in use, the string or blob might
30 ** be changed out from under the copy. This macro verifies that nothing
31 ** like that ever happens.
33 #ifdef SQLITE_DEBUG
34 # define memAboutToChange(P,M) sqlite3VdbeMemAboutToChange(P,M)
35 #else
36 # define memAboutToChange(P,M)
37 #endif
40 ** The following global variable is incremented every time a cursor
41 ** moves, either by the OP_SeekXX, OP_Next, or OP_Prev opcodes. The test
42 ** procedures use this information to make sure that indices are
43 ** working correctly. This variable has no function other than to
44 ** help verify the correct operation of the library.
46 #ifdef SQLITE_TEST
47 int sqlite3_search_count = 0;
48 #endif
51 ** When this global variable is positive, it gets decremented once before
52 ** each instruction in the VDBE. When it reaches zero, the u1.isInterrupted
53 ** field of the sqlite3 structure is set in order to simulate an interrupt.
55 ** This facility is used for testing purposes only. It does not function
56 ** in an ordinary build.
58 #ifdef SQLITE_TEST
59 int sqlite3_interrupt_count = 0;
60 #endif
63 ** The next global variable is incremented each type the OP_Sort opcode
64 ** is executed. The test procedures use this information to make sure that
65 ** sorting is occurring or not occurring at appropriate times. This variable
66 ** has no function other than to help verify the correct operation of the
67 ** library.
69 #ifdef SQLITE_TEST
70 int sqlite3_sort_count = 0;
71 #endif
74 ** The next global variable records the size of the largest MEM_Blob
75 ** or MEM_Str that has been used by a VDBE opcode. The test procedures
76 ** use this information to make sure that the zero-blob functionality
77 ** is working correctly. This variable has no function other than to
78 ** help verify the correct operation of the library.
80 #ifdef SQLITE_TEST
81 int sqlite3_max_blobsize = 0;
82 static void updateMaxBlobsize(Mem *p){
83 if( (p->flags & (MEM_Str|MEM_Blob))!=0 && p->n>sqlite3_max_blobsize ){
84 sqlite3_max_blobsize = p->n;
87 #endif
90 ** This macro evaluates to true if either the update hook or the preupdate
91 ** hook are enabled for database connect DB.
93 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
94 # define HAS_UPDATE_HOOK(DB) ((DB)->xPreUpdateCallback||(DB)->xUpdateCallback)
95 #else
96 # define HAS_UPDATE_HOOK(DB) ((DB)->xUpdateCallback)
97 #endif
100 ** The next global variable is incremented each time the OP_Found opcode
101 ** is executed. This is used to test whether or not the foreign key
102 ** operation implemented using OP_FkIsZero is working. This variable
103 ** has no function other than to help verify the correct operation of the
104 ** library.
106 #ifdef SQLITE_TEST
107 int sqlite3_found_count = 0;
108 #endif
111 ** Test a register to see if it exceeds the current maximum blob size.
112 ** If it does, record the new maximum blob size.
114 #if defined(SQLITE_TEST) && !defined(SQLITE_UNTESTABLE)
115 # define UPDATE_MAX_BLOBSIZE(P) updateMaxBlobsize(P)
116 #else
117 # define UPDATE_MAX_BLOBSIZE(P)
118 #endif
121 ** Invoke the VDBE coverage callback, if that callback is defined. This
122 ** feature is used for test suite validation only and does not appear an
123 ** production builds.
125 ** M is an integer, 2 or 3, that indices how many different ways the
126 ** branch can go. It is usually 2. "I" is the direction the branch
127 ** goes. 0 means falls through. 1 means branch is taken. 2 means the
128 ** second alternative branch is taken.
130 ** iSrcLine is the source code line (from the __LINE__ macro) that
131 ** generated the VDBE instruction. This instrumentation assumes that all
132 ** source code is in a single file (the amalgamation). Special values 1
133 ** and 2 for the iSrcLine parameter mean that this particular branch is
134 ** always taken or never taken, respectively.
136 #if !defined(SQLITE_VDBE_COVERAGE)
137 # define VdbeBranchTaken(I,M)
138 #else
139 # define VdbeBranchTaken(I,M) vdbeTakeBranch(pOp->iSrcLine,I,M)
140 static void vdbeTakeBranch(int iSrcLine, u8 I, u8 M){
141 if( iSrcLine<=2 && ALWAYS(iSrcLine>0) ){
142 M = iSrcLine;
143 /* Assert the truth of VdbeCoverageAlwaysTaken() and
144 ** VdbeCoverageNeverTaken() */
145 assert( (M & I)==I );
146 }else{
147 if( sqlite3GlobalConfig.xVdbeBranch==0 ) return; /*NO_TEST*/
148 sqlite3GlobalConfig.xVdbeBranch(sqlite3GlobalConfig.pVdbeBranchArg,
149 iSrcLine,I,M);
152 #endif
155 ** Convert the given register into a string if it isn't one
156 ** already. Return non-zero if a malloc() fails.
158 #define Stringify(P, enc) \
159 if(((P)->flags&(MEM_Str|MEM_Blob))==0 && sqlite3VdbeMemStringify(P,enc,0)) \
160 { goto no_mem; }
163 ** An ephemeral string value (signified by the MEM_Ephem flag) contains
164 ** a pointer to a dynamically allocated string where some other entity
165 ** is responsible for deallocating that string. Because the register
166 ** does not control the string, it might be deleted without the register
167 ** knowing it.
169 ** This routine converts an ephemeral string into a dynamically allocated
170 ** string that the register itself controls. In other words, it
171 ** converts an MEM_Ephem string into a string with P.z==P.zMalloc.
173 #define Deephemeralize(P) \
174 if( ((P)->flags&MEM_Ephem)!=0 \
175 && sqlite3VdbeMemMakeWriteable(P) ){ goto no_mem;}
177 /* Return true if the cursor was opened using the OP_OpenSorter opcode. */
178 #define isSorter(x) ((x)->eCurType==CURTYPE_SORTER)
181 ** Allocate VdbeCursor number iCur. Return a pointer to it. Return NULL
182 ** if we run out of memory.
184 static VdbeCursor *allocateCursor(
185 Vdbe *p, /* The virtual machine */
186 int iCur, /* Index of the new VdbeCursor */
187 int nField, /* Number of fields in the table or index */
188 int iDb, /* Database the cursor belongs to, or -1 */
189 u8 eCurType /* Type of the new cursor */
191 /* Find the memory cell that will be used to store the blob of memory
192 ** required for this VdbeCursor structure. It is convenient to use a
193 ** vdbe memory cell to manage the memory allocation required for a
194 ** VdbeCursor structure for the following reasons:
196 ** * Sometimes cursor numbers are used for a couple of different
197 ** purposes in a vdbe program. The different uses might require
198 ** different sized allocations. Memory cells provide growable
199 ** allocations.
201 ** * When using ENABLE_MEMORY_MANAGEMENT, memory cell buffers can
202 ** be freed lazily via the sqlite3_release_memory() API. This
203 ** minimizes the number of malloc calls made by the system.
205 ** The memory cell for cursor 0 is aMem[0]. The rest are allocated from
206 ** the top of the register space. Cursor 1 is at Mem[p->nMem-1].
207 ** Cursor 2 is at Mem[p->nMem-2]. And so forth.
209 Mem *pMem = iCur>0 ? &p->aMem[p->nMem-iCur] : p->aMem;
211 int nByte;
212 VdbeCursor *pCx = 0;
213 nByte =
214 ROUND8(sizeof(VdbeCursor)) + 2*sizeof(u32)*nField +
215 (eCurType==CURTYPE_BTREE?sqlite3BtreeCursorSize():0);
217 assert( iCur>=0 && iCur<p->nCursor );
218 if( p->apCsr[iCur] ){ /*OPTIMIZATION-IF-FALSE*/
219 sqlite3VdbeFreeCursor(p, p->apCsr[iCur]);
220 p->apCsr[iCur] = 0;
222 if( SQLITE_OK==sqlite3VdbeMemClearAndResize(pMem, nByte) ){
223 p->apCsr[iCur] = pCx = (VdbeCursor*)pMem->z;
224 memset(pCx, 0, offsetof(VdbeCursor,pAltCursor));
225 pCx->eCurType = eCurType;
226 pCx->iDb = iDb;
227 pCx->nField = nField;
228 pCx->aOffset = &pCx->aType[nField];
229 if( eCurType==CURTYPE_BTREE ){
230 pCx->uc.pCursor = (BtCursor*)
231 &pMem->z[ROUND8(sizeof(VdbeCursor))+2*sizeof(u32)*nField];
232 sqlite3BtreeCursorZero(pCx->uc.pCursor);
235 return pCx;
239 ** Try to convert a value into a numeric representation if we can
240 ** do so without loss of information. In other words, if the string
241 ** looks like a number, convert it into a number. If it does not
242 ** look like a number, leave it alone.
244 ** If the bTryForInt flag is true, then extra effort is made to give
245 ** an integer representation. Strings that look like floating point
246 ** values but which have no fractional component (example: '48.00')
247 ** will have a MEM_Int representation when bTryForInt is true.
249 ** If bTryForInt is false, then if the input string contains a decimal
250 ** point or exponential notation, the result is only MEM_Real, even
251 ** if there is an exact integer representation of the quantity.
253 static void applyNumericAffinity(Mem *pRec, int bTryForInt){
254 double rValue;
255 i64 iValue;
256 u8 enc = pRec->enc;
257 assert( (pRec->flags & (MEM_Str|MEM_Int|MEM_Real))==MEM_Str );
258 if( sqlite3AtoF(pRec->z, &rValue, pRec->n, enc)==0 ) return;
259 if( 0==sqlite3Atoi64(pRec->z, &iValue, pRec->n, enc) ){
260 pRec->u.i = iValue;
261 pRec->flags |= MEM_Int;
262 }else{
263 pRec->u.r = rValue;
264 pRec->flags |= MEM_Real;
265 if( bTryForInt ) sqlite3VdbeIntegerAffinity(pRec);
270 ** Processing is determine by the affinity parameter:
272 ** SQLITE_AFF_INTEGER:
273 ** SQLITE_AFF_REAL:
274 ** SQLITE_AFF_NUMERIC:
275 ** Try to convert pRec to an integer representation or a
276 ** floating-point representation if an integer representation
277 ** is not possible. Note that the integer representation is
278 ** always preferred, even if the affinity is REAL, because
279 ** an integer representation is more space efficient on disk.
281 ** SQLITE_AFF_TEXT:
282 ** Convert pRec to a text representation.
284 ** SQLITE_AFF_BLOB:
285 ** No-op. pRec is unchanged.
287 static void applyAffinity(
288 Mem *pRec, /* The value to apply affinity to */
289 char affinity, /* The affinity to be applied */
290 u8 enc /* Use this text encoding */
292 if( affinity>=SQLITE_AFF_NUMERIC ){
293 assert( affinity==SQLITE_AFF_INTEGER || affinity==SQLITE_AFF_REAL
294 || affinity==SQLITE_AFF_NUMERIC );
295 if( (pRec->flags & MEM_Int)==0 ){ /*OPTIMIZATION-IF-FALSE*/
296 if( (pRec->flags & MEM_Real)==0 ){
297 if( pRec->flags & MEM_Str ) applyNumericAffinity(pRec,1);
298 }else{
299 sqlite3VdbeIntegerAffinity(pRec);
302 }else if( affinity==SQLITE_AFF_TEXT ){
303 /* Only attempt the conversion to TEXT if there is an integer or real
304 ** representation (blob and NULL do not get converted) but no string
305 ** representation. It would be harmless to repeat the conversion if
306 ** there is already a string rep, but it is pointless to waste those
307 ** CPU cycles. */
308 if( 0==(pRec->flags&MEM_Str) ){ /*OPTIMIZATION-IF-FALSE*/
309 if( (pRec->flags&(MEM_Real|MEM_Int)) ){
310 sqlite3VdbeMemStringify(pRec, enc, 1);
313 pRec->flags &= ~(MEM_Real|MEM_Int);
318 ** Try to convert the type of a function argument or a result column
319 ** into a numeric representation. Use either INTEGER or REAL whichever
320 ** is appropriate. But only do the conversion if it is possible without
321 ** loss of information and return the revised type of the argument.
323 int sqlite3_value_numeric_type(sqlite3_value *pVal){
324 int eType = sqlite3_value_type(pVal);
325 if( eType==SQLITE_TEXT ){
326 Mem *pMem = (Mem*)pVal;
327 applyNumericAffinity(pMem, 0);
328 eType = sqlite3_value_type(pVal);
330 return eType;
334 ** Exported version of applyAffinity(). This one works on sqlite3_value*,
335 ** not the internal Mem* type.
337 void sqlite3ValueApplyAffinity(
338 sqlite3_value *pVal,
339 u8 affinity,
340 u8 enc
342 applyAffinity((Mem *)pVal, affinity, enc);
346 ** pMem currently only holds a string type (or maybe a BLOB that we can
347 ** interpret as a string if we want to). Compute its corresponding
348 ** numeric type, if has one. Set the pMem->u.r and pMem->u.i fields
349 ** accordingly.
351 static u16 SQLITE_NOINLINE computeNumericType(Mem *pMem){
352 assert( (pMem->flags & (MEM_Int|MEM_Real))==0 );
353 assert( (pMem->flags & (MEM_Str|MEM_Blob))!=0 );
354 if( sqlite3AtoF(pMem->z, &pMem->u.r, pMem->n, pMem->enc)==0 ){
355 return 0;
357 if( sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc)==0 ){
358 return MEM_Int;
360 return MEM_Real;
364 ** Return the numeric type for pMem, either MEM_Int or MEM_Real or both or
365 ** none.
367 ** Unlike applyNumericAffinity(), this routine does not modify pMem->flags.
368 ** But it does set pMem->u.r and pMem->u.i appropriately.
370 static u16 numericType(Mem *pMem){
371 if( pMem->flags & (MEM_Int|MEM_Real) ){
372 return pMem->flags & (MEM_Int|MEM_Real);
374 if( pMem->flags & (MEM_Str|MEM_Blob) ){
375 return computeNumericType(pMem);
377 return 0;
380 #ifdef SQLITE_DEBUG
382 ** Write a nice string representation of the contents of cell pMem
383 ** into buffer zBuf, length nBuf.
385 void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf){
386 char *zCsr = zBuf;
387 int f = pMem->flags;
389 static const char *const encnames[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
391 if( f&MEM_Blob ){
392 int i;
393 char c;
394 if( f & MEM_Dyn ){
395 c = 'z';
396 assert( (f & (MEM_Static|MEM_Ephem))==0 );
397 }else if( f & MEM_Static ){
398 c = 't';
399 assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
400 }else if( f & MEM_Ephem ){
401 c = 'e';
402 assert( (f & (MEM_Static|MEM_Dyn))==0 );
403 }else{
404 c = 's';
406 *(zCsr++) = c;
407 sqlite3_snprintf(100, zCsr, "%d[", pMem->n);
408 zCsr += sqlite3Strlen30(zCsr);
409 for(i=0; i<16 && i<pMem->n; i++){
410 sqlite3_snprintf(100, zCsr, "%02X", ((int)pMem->z[i] & 0xFF));
411 zCsr += sqlite3Strlen30(zCsr);
413 for(i=0; i<16 && i<pMem->n; i++){
414 char z = pMem->z[i];
415 if( z<32 || z>126 ) *zCsr++ = '.';
416 else *zCsr++ = z;
418 *(zCsr++) = ']';
419 if( f & MEM_Zero ){
420 sqlite3_snprintf(100, zCsr,"+%dz",pMem->u.nZero);
421 zCsr += sqlite3Strlen30(zCsr);
423 *zCsr = '\0';
424 }else if( f & MEM_Str ){
425 int j, k;
426 zBuf[0] = ' ';
427 if( f & MEM_Dyn ){
428 zBuf[1] = 'z';
429 assert( (f & (MEM_Static|MEM_Ephem))==0 );
430 }else if( f & MEM_Static ){
431 zBuf[1] = 't';
432 assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
433 }else if( f & MEM_Ephem ){
434 zBuf[1] = 'e';
435 assert( (f & (MEM_Static|MEM_Dyn))==0 );
436 }else{
437 zBuf[1] = 's';
439 k = 2;
440 sqlite3_snprintf(100, &zBuf[k], "%d", pMem->n);
441 k += sqlite3Strlen30(&zBuf[k]);
442 zBuf[k++] = '[';
443 for(j=0; j<15 && j<pMem->n; j++){
444 u8 c = pMem->z[j];
445 if( c>=0x20 && c<0x7f ){
446 zBuf[k++] = c;
447 }else{
448 zBuf[k++] = '.';
451 zBuf[k++] = ']';
452 sqlite3_snprintf(100,&zBuf[k], encnames[pMem->enc]);
453 k += sqlite3Strlen30(&zBuf[k]);
454 zBuf[k++] = 0;
457 #endif
459 #ifdef SQLITE_DEBUG
461 ** Print the value of a register for tracing purposes:
463 static void memTracePrint(Mem *p){
464 if( p->flags & MEM_Undefined ){
465 printf(" undefined");
466 }else if( p->flags & MEM_Null ){
467 printf(" NULL");
468 }else if( (p->flags & (MEM_Int|MEM_Str))==(MEM_Int|MEM_Str) ){
469 printf(" si:%lld", p->u.i);
470 }else if( p->flags & MEM_Int ){
471 printf(" i:%lld", p->u.i);
472 #ifndef SQLITE_OMIT_FLOATING_POINT
473 }else if( p->flags & MEM_Real ){
474 printf(" r:%g", p->u.r);
475 #endif
476 }else if( p->flags & MEM_RowSet ){
477 printf(" (rowset)");
478 }else{
479 char zBuf[200];
480 sqlite3VdbeMemPrettyPrint(p, zBuf);
481 printf(" %s", zBuf);
483 if( p->flags & MEM_Subtype ) printf(" subtype=0x%02x", p->eSubtype);
485 static void registerTrace(int iReg, Mem *p){
486 printf("REG[%d] = ", iReg);
487 memTracePrint(p);
488 printf("\n");
489 sqlite3VdbeCheckMemInvariants(p);
491 #endif
493 #ifdef SQLITE_DEBUG
494 # define REGISTER_TRACE(R,M) if(db->flags&SQLITE_VdbeTrace)registerTrace(R,M)
495 #else
496 # define REGISTER_TRACE(R,M)
497 #endif
500 #ifdef VDBE_PROFILE
503 ** hwtime.h contains inline assembler code for implementing
504 ** high-performance timing routines.
506 #include "hwtime.h"
508 #endif
510 #ifndef NDEBUG
512 ** This function is only called from within an assert() expression. It
513 ** checks that the sqlite3.nTransaction variable is correctly set to
514 ** the number of non-transaction savepoints currently in the
515 ** linked list starting at sqlite3.pSavepoint.
517 ** Usage:
519 ** assert( checkSavepointCount(db) );
521 static int checkSavepointCount(sqlite3 *db){
522 int n = 0;
523 Savepoint *p;
524 for(p=db->pSavepoint; p; p=p->pNext) n++;
525 assert( n==(db->nSavepoint + db->isTransactionSavepoint) );
526 return 1;
528 #endif
531 ** Return the register of pOp->p2 after first preparing it to be
532 ** overwritten with an integer value.
534 static SQLITE_NOINLINE Mem *out2PrereleaseWithClear(Mem *pOut){
535 sqlite3VdbeMemSetNull(pOut);
536 pOut->flags = MEM_Int;
537 return pOut;
539 static Mem *out2Prerelease(Vdbe *p, VdbeOp *pOp){
540 Mem *pOut;
541 assert( pOp->p2>0 );
542 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
543 pOut = &p->aMem[pOp->p2];
544 memAboutToChange(p, pOut);
545 if( VdbeMemDynamic(pOut) ){ /*OPTIMIZATION-IF-FALSE*/
546 return out2PrereleaseWithClear(pOut);
547 }else{
548 pOut->flags = MEM_Int;
549 return pOut;
555 ** Execute as much of a VDBE program as we can.
556 ** This is the core of sqlite3_step().
558 int sqlite3VdbeExec(
559 Vdbe *p /* The VDBE */
561 Op *aOp = p->aOp; /* Copy of p->aOp */
562 Op *pOp = aOp; /* Current operation */
563 #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
564 Op *pOrigOp; /* Value of pOp at the top of the loop */
565 #endif
566 #ifdef SQLITE_DEBUG
567 int nExtraDelete = 0; /* Verifies FORDELETE and AUXDELETE flags */
568 #endif
569 int rc = SQLITE_OK; /* Value to return */
570 sqlite3 *db = p->db; /* The database */
571 u8 resetSchemaOnFault = 0; /* Reset schema after an error if positive */
572 u8 encoding = ENC(db); /* The database encoding */
573 int iCompare = 0; /* Result of last comparison */
574 unsigned nVmStep = 0; /* Number of virtual machine steps */
575 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
576 unsigned nProgressLimit; /* Invoke xProgress() when nVmStep reaches this */
577 #endif
578 Mem *aMem = p->aMem; /* Copy of p->aMem */
579 Mem *pIn1 = 0; /* 1st input operand */
580 Mem *pIn2 = 0; /* 2nd input operand */
581 Mem *pIn3 = 0; /* 3rd input operand */
582 Mem *pOut = 0; /* Output operand */
583 #ifdef VDBE_PROFILE
584 u64 start; /* CPU clock count at start of opcode */
585 #endif
586 /*** INSERT STACK UNION HERE ***/
588 assert( p->magic==VDBE_MAGIC_RUN ); /* sqlite3_step() verifies this */
589 sqlite3VdbeEnter(p);
590 if( p->rc==SQLITE_NOMEM ){
591 /* This happens if a malloc() inside a call to sqlite3_column_text() or
592 ** sqlite3_column_text16() failed. */
593 goto no_mem;
595 assert( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_BUSY );
596 assert( p->bIsReader || p->readOnly!=0 );
597 p->iCurrentTime = 0;
598 assert( p->explain==0 );
599 p->pResultSet = 0;
600 db->busyHandler.nBusy = 0;
601 if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
602 sqlite3VdbeIOTraceSql(p);
603 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
604 if( db->xProgress ){
605 u32 iPrior = p->aCounter[SQLITE_STMTSTATUS_VM_STEP];
606 assert( 0 < db->nProgressOps );
607 nProgressLimit = db->nProgressOps - (iPrior % db->nProgressOps);
608 }else{
609 nProgressLimit = 0xffffffff;
611 #endif
612 #ifdef SQLITE_DEBUG
613 sqlite3BeginBenignMalloc();
614 if( p->pc==0
615 && (p->db->flags & (SQLITE_VdbeListing|SQLITE_VdbeEQP|SQLITE_VdbeTrace))!=0
617 int i;
618 int once = 1;
619 sqlite3VdbePrintSql(p);
620 if( p->db->flags & SQLITE_VdbeListing ){
621 printf("VDBE Program Listing:\n");
622 for(i=0; i<p->nOp; i++){
623 sqlite3VdbePrintOp(stdout, i, &aOp[i]);
626 if( p->db->flags & SQLITE_VdbeEQP ){
627 for(i=0; i<p->nOp; i++){
628 if( aOp[i].opcode==OP_Explain ){
629 if( once ) printf("VDBE Query Plan:\n");
630 printf("%s\n", aOp[i].p4.z);
631 once = 0;
635 if( p->db->flags & SQLITE_VdbeTrace ) printf("VDBE Trace:\n");
637 sqlite3EndBenignMalloc();
638 #endif
639 for(pOp=&aOp[p->pc]; 1; pOp++){
640 /* Errors are detected by individual opcodes, with an immediate
641 ** jumps to abort_due_to_error. */
642 assert( rc==SQLITE_OK );
644 assert( pOp>=aOp && pOp<&aOp[p->nOp]);
645 #ifdef VDBE_PROFILE
646 start = sqlite3Hwtime();
647 #endif
648 nVmStep++;
649 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
650 if( p->anExec ) p->anExec[(int)(pOp-aOp)]++;
651 #endif
653 /* Only allow tracing if SQLITE_DEBUG is defined.
655 #ifdef SQLITE_DEBUG
656 if( db->flags & SQLITE_VdbeTrace ){
657 sqlite3VdbePrintOp(stdout, (int)(pOp - aOp), pOp);
659 #endif
662 /* Check to see if we need to simulate an interrupt. This only happens
663 ** if we have a special test build.
665 #ifdef SQLITE_TEST
666 if( sqlite3_interrupt_count>0 ){
667 sqlite3_interrupt_count--;
668 if( sqlite3_interrupt_count==0 ){
669 sqlite3_interrupt(db);
672 #endif
674 /* Sanity checking on other operands */
675 #ifdef SQLITE_DEBUG
677 u8 opProperty = sqlite3OpcodeProperty[pOp->opcode];
678 if( (opProperty & OPFLG_IN1)!=0 ){
679 assert( pOp->p1>0 );
680 assert( pOp->p1<=(p->nMem+1 - p->nCursor) );
681 assert( memIsValid(&aMem[pOp->p1]) );
682 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p1]) );
683 REGISTER_TRACE(pOp->p1, &aMem[pOp->p1]);
685 if( (opProperty & OPFLG_IN2)!=0 ){
686 assert( pOp->p2>0 );
687 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
688 assert( memIsValid(&aMem[pOp->p2]) );
689 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p2]) );
690 REGISTER_TRACE(pOp->p2, &aMem[pOp->p2]);
692 if( (opProperty & OPFLG_IN3)!=0 ){
693 assert( pOp->p3>0 );
694 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
695 assert( memIsValid(&aMem[pOp->p3]) );
696 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p3]) );
697 REGISTER_TRACE(pOp->p3, &aMem[pOp->p3]);
699 if( (opProperty & OPFLG_OUT2)!=0 ){
700 assert( pOp->p2>0 );
701 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
702 memAboutToChange(p, &aMem[pOp->p2]);
704 if( (opProperty & OPFLG_OUT3)!=0 ){
705 assert( pOp->p3>0 );
706 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
707 memAboutToChange(p, &aMem[pOp->p3]);
710 #endif
711 #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
712 pOrigOp = pOp;
713 #endif
715 switch( pOp->opcode ){
717 /*****************************************************************************
718 ** What follows is a massive switch statement where each case implements a
719 ** separate instruction in the virtual machine. If we follow the usual
720 ** indentation conventions, each case should be indented by 6 spaces. But
721 ** that is a lot of wasted space on the left margin. So the code within
722 ** the switch statement will break with convention and be flush-left. Another
723 ** big comment (similar to this one) will mark the point in the code where
724 ** we transition back to normal indentation.
726 ** The formatting of each case is important. The makefile for SQLite
727 ** generates two C files "opcodes.h" and "opcodes.c" by scanning this
728 ** file looking for lines that begin with "case OP_". The opcodes.h files
729 ** will be filled with #defines that give unique integer values to each
730 ** opcode and the opcodes.c file is filled with an array of strings where
731 ** each string is the symbolic name for the corresponding opcode. If the
732 ** case statement is followed by a comment of the form "/# same as ... #/"
733 ** that comment is used to determine the particular value of the opcode.
735 ** Other keywords in the comment that follows each case are used to
736 ** construct the OPFLG_INITIALIZER value that initializes opcodeProperty[].
737 ** Keywords include: in1, in2, in3, out2, out3. See
738 ** the mkopcodeh.awk script for additional information.
740 ** Documentation about VDBE opcodes is generated by scanning this file
741 ** for lines of that contain "Opcode:". That line and all subsequent
742 ** comment lines are used in the generation of the opcode.html documentation
743 ** file.
745 ** SUMMARY:
747 ** Formatting is important to scripts that scan this file.
748 ** Do not deviate from the formatting style currently in use.
750 *****************************************************************************/
752 /* Opcode: Goto * P2 * * *
754 ** An unconditional jump to address P2.
755 ** The next instruction executed will be
756 ** the one at index P2 from the beginning of
757 ** the program.
759 ** The P1 parameter is not actually used by this opcode. However, it
760 ** is sometimes set to 1 instead of 0 as a hint to the command-line shell
761 ** that this Goto is the bottom of a loop and that the lines from P2 down
762 ** to the current line should be indented for EXPLAIN output.
764 case OP_Goto: { /* jump */
765 jump_to_p2_and_check_for_interrupt:
766 pOp = &aOp[pOp->p2 - 1];
768 /* Opcodes that are used as the bottom of a loop (OP_Next, OP_Prev,
769 ** OP_VNext, or OP_SorterNext) all jump here upon
770 ** completion. Check to see if sqlite3_interrupt() has been called
771 ** or if the progress callback needs to be invoked.
773 ** This code uses unstructured "goto" statements and does not look clean.
774 ** But that is not due to sloppy coding habits. The code is written this
775 ** way for performance, to avoid having to run the interrupt and progress
776 ** checks on every opcode. This helps sqlite3_step() to run about 1.5%
777 ** faster according to "valgrind --tool=cachegrind" */
778 check_for_interrupt:
779 if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
780 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
781 /* Call the progress callback if it is configured and the required number
782 ** of VDBE ops have been executed (either since this invocation of
783 ** sqlite3VdbeExec() or since last time the progress callback was called).
784 ** If the progress callback returns non-zero, exit the virtual machine with
785 ** a return code SQLITE_ABORT.
787 if( nVmStep>=nProgressLimit && db->xProgress!=0 ){
788 assert( db->nProgressOps!=0 );
789 nProgressLimit = nVmStep + db->nProgressOps - (nVmStep%db->nProgressOps);
790 if( db->xProgress(db->pProgressArg) ){
791 rc = SQLITE_INTERRUPT;
792 goto abort_due_to_error;
795 #endif
797 break;
800 /* Opcode: Gosub P1 P2 * * *
802 ** Write the current address onto register P1
803 ** and then jump to address P2.
805 case OP_Gosub: { /* jump */
806 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
807 pIn1 = &aMem[pOp->p1];
808 assert( VdbeMemDynamic(pIn1)==0 );
809 memAboutToChange(p, pIn1);
810 pIn1->flags = MEM_Int;
811 pIn1->u.i = (int)(pOp-aOp);
812 REGISTER_TRACE(pOp->p1, pIn1);
814 /* Most jump operations do a goto to this spot in order to update
815 ** the pOp pointer. */
816 jump_to_p2:
817 pOp = &aOp[pOp->p2 - 1];
818 break;
821 /* Opcode: Return P1 * * * *
823 ** Jump to the next instruction after the address in register P1. After
824 ** the jump, register P1 becomes undefined.
826 case OP_Return: { /* in1 */
827 pIn1 = &aMem[pOp->p1];
828 assert( pIn1->flags==MEM_Int );
829 pOp = &aOp[pIn1->u.i];
830 pIn1->flags = MEM_Undefined;
831 break;
834 /* Opcode: InitCoroutine P1 P2 P3 * *
836 ** Set up register P1 so that it will Yield to the coroutine
837 ** located at address P3.
839 ** If P2!=0 then the coroutine implementation immediately follows
840 ** this opcode. So jump over the coroutine implementation to
841 ** address P2.
843 ** See also: EndCoroutine
845 case OP_InitCoroutine: { /* jump */
846 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
847 assert( pOp->p2>=0 && pOp->p2<p->nOp );
848 assert( pOp->p3>=0 && pOp->p3<p->nOp );
849 pOut = &aMem[pOp->p1];
850 assert( !VdbeMemDynamic(pOut) );
851 pOut->u.i = pOp->p3 - 1;
852 pOut->flags = MEM_Int;
853 if( pOp->p2 ) goto jump_to_p2;
854 break;
857 /* Opcode: EndCoroutine P1 * * * *
859 ** The instruction at the address in register P1 is a Yield.
860 ** Jump to the P2 parameter of that Yield.
861 ** After the jump, register P1 becomes undefined.
863 ** See also: InitCoroutine
865 case OP_EndCoroutine: { /* in1 */
866 VdbeOp *pCaller;
867 pIn1 = &aMem[pOp->p1];
868 assert( pIn1->flags==MEM_Int );
869 assert( pIn1->u.i>=0 && pIn1->u.i<p->nOp );
870 pCaller = &aOp[pIn1->u.i];
871 assert( pCaller->opcode==OP_Yield );
872 assert( pCaller->p2>=0 && pCaller->p2<p->nOp );
873 pOp = &aOp[pCaller->p2 - 1];
874 pIn1->flags = MEM_Undefined;
875 break;
878 /* Opcode: Yield P1 P2 * * *
880 ** Swap the program counter with the value in register P1. This
881 ** has the effect of yielding to a coroutine.
883 ** If the coroutine that is launched by this instruction ends with
884 ** Yield or Return then continue to the next instruction. But if
885 ** the coroutine launched by this instruction ends with
886 ** EndCoroutine, then jump to P2 rather than continuing with the
887 ** next instruction.
889 ** See also: InitCoroutine
891 case OP_Yield: { /* in1, jump */
892 int pcDest;
893 pIn1 = &aMem[pOp->p1];
894 assert( VdbeMemDynamic(pIn1)==0 );
895 pIn1->flags = MEM_Int;
896 pcDest = (int)pIn1->u.i;
897 pIn1->u.i = (int)(pOp - aOp);
898 REGISTER_TRACE(pOp->p1, pIn1);
899 pOp = &aOp[pcDest];
900 break;
903 /* Opcode: HaltIfNull P1 P2 P3 P4 P5
904 ** Synopsis: if r[P3]=null halt
906 ** Check the value in register P3. If it is NULL then Halt using
907 ** parameter P1, P2, and P4 as if this were a Halt instruction. If the
908 ** value in register P3 is not NULL, then this routine is a no-op.
909 ** The P5 parameter should be 1.
911 case OP_HaltIfNull: { /* in3 */
912 pIn3 = &aMem[pOp->p3];
913 if( (pIn3->flags & MEM_Null)==0 ) break;
914 /* Fall through into OP_Halt */
917 /* Opcode: Halt P1 P2 * P4 P5
919 ** Exit immediately. All open cursors, etc are closed
920 ** automatically.
922 ** P1 is the result code returned by sqlite3_exec(), sqlite3_reset(),
923 ** or sqlite3_finalize(). For a normal halt, this should be SQLITE_OK (0).
924 ** For errors, it can be some other value. If P1!=0 then P2 will determine
925 ** whether or not to rollback the current transaction. Do not rollback
926 ** if P2==OE_Fail. Do the rollback if P2==OE_Rollback. If P2==OE_Abort,
927 ** then back out all changes that have occurred during this execution of the
928 ** VDBE, but do not rollback the transaction.
930 ** If P4 is not null then it is an error message string.
932 ** P5 is a value between 0 and 4, inclusive, that modifies the P4 string.
934 ** 0: (no change)
935 ** 1: NOT NULL contraint failed: P4
936 ** 2: UNIQUE constraint failed: P4
937 ** 3: CHECK constraint failed: P4
938 ** 4: FOREIGN KEY constraint failed: P4
940 ** If P5 is not zero and P4 is NULL, then everything after the ":" is
941 ** omitted.
943 ** There is an implied "Halt 0 0 0" instruction inserted at the very end of
944 ** every program. So a jump past the last instruction of the program
945 ** is the same as executing Halt.
947 case OP_Halt: {
948 VdbeFrame *pFrame;
949 int pcx;
951 pcx = (int)(pOp - aOp);
952 if( pOp->p1==SQLITE_OK && p->pFrame ){
953 /* Halt the sub-program. Return control to the parent frame. */
954 pFrame = p->pFrame;
955 p->pFrame = pFrame->pParent;
956 p->nFrame--;
957 sqlite3VdbeSetChanges(db, p->nChange);
958 pcx = sqlite3VdbeFrameRestore(pFrame);
959 if( pOp->p2==OE_Ignore ){
960 /* Instruction pcx is the OP_Program that invoked the sub-program
961 ** currently being halted. If the p2 instruction of this OP_Halt
962 ** instruction is set to OE_Ignore, then the sub-program is throwing
963 ** an IGNORE exception. In this case jump to the address specified
964 ** as the p2 of the calling OP_Program. */
965 pcx = p->aOp[pcx].p2-1;
967 aOp = p->aOp;
968 aMem = p->aMem;
969 pOp = &aOp[pcx];
970 break;
972 p->rc = pOp->p1;
973 p->errorAction = (u8)pOp->p2;
974 p->pc = pcx;
975 assert( pOp->p5<=4 );
976 if( p->rc ){
977 if( pOp->p5 ){
978 static const char * const azType[] = { "NOT NULL", "UNIQUE", "CHECK",
979 "FOREIGN KEY" };
980 testcase( pOp->p5==1 );
981 testcase( pOp->p5==2 );
982 testcase( pOp->p5==3 );
983 testcase( pOp->p5==4 );
984 sqlite3VdbeError(p, "%s constraint failed", azType[pOp->p5-1]);
985 if( pOp->p4.z ){
986 p->zErrMsg = sqlite3MPrintf(db, "%z: %s", p->zErrMsg, pOp->p4.z);
988 }else{
989 sqlite3VdbeError(p, "%s", pOp->p4.z);
991 sqlite3_log(pOp->p1, "abort at %d in [%s]: %s", pcx, p->zSql, p->zErrMsg);
993 rc = sqlite3VdbeHalt(p);
994 assert( rc==SQLITE_BUSY || rc==SQLITE_OK || rc==SQLITE_ERROR );
995 if( rc==SQLITE_BUSY ){
996 p->rc = SQLITE_BUSY;
997 }else{
998 assert( rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT );
999 assert( rc==SQLITE_OK || db->nDeferredCons>0 || db->nDeferredImmCons>0 );
1000 rc = p->rc ? SQLITE_ERROR : SQLITE_DONE;
1002 goto vdbe_return;
1005 /* Opcode: Integer P1 P2 * * *
1006 ** Synopsis: r[P2]=P1
1008 ** The 32-bit integer value P1 is written into register P2.
1010 case OP_Integer: { /* out2 */
1011 pOut = out2Prerelease(p, pOp);
1012 pOut->u.i = pOp->p1;
1013 break;
1016 /* Opcode: Int64 * P2 * P4 *
1017 ** Synopsis: r[P2]=P4
1019 ** P4 is a pointer to a 64-bit integer value.
1020 ** Write that value into register P2.
1022 case OP_Int64: { /* out2 */
1023 pOut = out2Prerelease(p, pOp);
1024 assert( pOp->p4.pI64!=0 );
1025 pOut->u.i = *pOp->p4.pI64;
1026 break;
1029 #ifndef SQLITE_OMIT_FLOATING_POINT
1030 /* Opcode: Real * P2 * P4 *
1031 ** Synopsis: r[P2]=P4
1033 ** P4 is a pointer to a 64-bit floating point value.
1034 ** Write that value into register P2.
1036 case OP_Real: { /* same as TK_FLOAT, out2 */
1037 pOut = out2Prerelease(p, pOp);
1038 pOut->flags = MEM_Real;
1039 assert( !sqlite3IsNaN(*pOp->p4.pReal) );
1040 pOut->u.r = *pOp->p4.pReal;
1041 break;
1043 #endif
1045 /* Opcode: String8 * P2 * P4 *
1046 ** Synopsis: r[P2]='P4'
1048 ** P4 points to a nul terminated UTF-8 string. This opcode is transformed
1049 ** into a String opcode before it is executed for the first time. During
1050 ** this transformation, the length of string P4 is computed and stored
1051 ** as the P1 parameter.
1053 case OP_String8: { /* same as TK_STRING, out2 */
1054 assert( pOp->p4.z!=0 );
1055 pOut = out2Prerelease(p, pOp);
1056 pOp->opcode = OP_String;
1057 pOp->p1 = sqlite3Strlen30(pOp->p4.z);
1059 #ifndef SQLITE_OMIT_UTF16
1060 if( encoding!=SQLITE_UTF8 ){
1061 rc = sqlite3VdbeMemSetStr(pOut, pOp->p4.z, -1, SQLITE_UTF8, SQLITE_STATIC);
1062 assert( rc==SQLITE_OK || rc==SQLITE_TOOBIG );
1063 if( SQLITE_OK!=sqlite3VdbeChangeEncoding(pOut, encoding) ) goto no_mem;
1064 assert( pOut->szMalloc>0 && pOut->zMalloc==pOut->z );
1065 assert( VdbeMemDynamic(pOut)==0 );
1066 pOut->szMalloc = 0;
1067 pOut->flags |= MEM_Static;
1068 if( pOp->p4type==P4_DYNAMIC ){
1069 sqlite3DbFree(db, pOp->p4.z);
1071 pOp->p4type = P4_DYNAMIC;
1072 pOp->p4.z = pOut->z;
1073 pOp->p1 = pOut->n;
1075 testcase( rc==SQLITE_TOOBIG );
1076 #endif
1077 if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
1078 goto too_big;
1080 assert( rc==SQLITE_OK );
1081 /* Fall through to the next case, OP_String */
1084 /* Opcode: String P1 P2 P3 P4 P5
1085 ** Synopsis: r[P2]='P4' (len=P1)
1087 ** The string value P4 of length P1 (bytes) is stored in register P2.
1089 ** If P3 is not zero and the content of register P3 is equal to P5, then
1090 ** the datatype of the register P2 is converted to BLOB. The content is
1091 ** the same sequence of bytes, it is merely interpreted as a BLOB instead
1092 ** of a string, as if it had been CAST. In other words:
1094 ** if( P3!=0 and reg[P3]==P5 ) reg[P2] := CAST(reg[P2] as BLOB)
1096 case OP_String: { /* out2 */
1097 assert( pOp->p4.z!=0 );
1098 pOut = out2Prerelease(p, pOp);
1099 pOut->flags = MEM_Str|MEM_Static|MEM_Term;
1100 pOut->z = pOp->p4.z;
1101 pOut->n = pOp->p1;
1102 pOut->enc = encoding;
1103 UPDATE_MAX_BLOBSIZE(pOut);
1104 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
1105 if( pOp->p3>0 ){
1106 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
1107 pIn3 = &aMem[pOp->p3];
1108 assert( pIn3->flags & MEM_Int );
1109 if( pIn3->u.i==pOp->p5 ) pOut->flags = MEM_Blob|MEM_Static|MEM_Term;
1111 #endif
1112 break;
1115 /* Opcode: Null P1 P2 P3 * *
1116 ** Synopsis: r[P2..P3]=NULL
1118 ** Write a NULL into registers P2. If P3 greater than P2, then also write
1119 ** NULL into register P3 and every register in between P2 and P3. If P3
1120 ** is less than P2 (typically P3 is zero) then only register P2 is
1121 ** set to NULL.
1123 ** If the P1 value is non-zero, then also set the MEM_Cleared flag so that
1124 ** NULL values will not compare equal even if SQLITE_NULLEQ is set on
1125 ** OP_Ne or OP_Eq.
1127 case OP_Null: { /* out2 */
1128 int cnt;
1129 u16 nullFlag;
1130 pOut = out2Prerelease(p, pOp);
1131 cnt = pOp->p3-pOp->p2;
1132 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
1133 pOut->flags = nullFlag = pOp->p1 ? (MEM_Null|MEM_Cleared) : MEM_Null;
1134 pOut->n = 0;
1135 while( cnt>0 ){
1136 pOut++;
1137 memAboutToChange(p, pOut);
1138 sqlite3VdbeMemSetNull(pOut);
1139 pOut->flags = nullFlag;
1140 pOut->n = 0;
1141 cnt--;
1143 break;
1146 /* Opcode: SoftNull P1 * * * *
1147 ** Synopsis: r[P1]=NULL
1149 ** Set register P1 to have the value NULL as seen by the OP_MakeRecord
1150 ** instruction, but do not free any string or blob memory associated with
1151 ** the register, so that if the value was a string or blob that was
1152 ** previously copied using OP_SCopy, the copies will continue to be valid.
1154 case OP_SoftNull: {
1155 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
1156 pOut = &aMem[pOp->p1];
1157 pOut->flags = (pOut->flags&~(MEM_Undefined|MEM_AffMask))|MEM_Null;
1158 break;
1161 /* Opcode: Blob P1 P2 * P4 *
1162 ** Synopsis: r[P2]=P4 (len=P1)
1164 ** P4 points to a blob of data P1 bytes long. Store this
1165 ** blob in register P2.
1167 case OP_Blob: { /* out2 */
1168 assert( pOp->p1 <= SQLITE_MAX_LENGTH );
1169 pOut = out2Prerelease(p, pOp);
1170 sqlite3VdbeMemSetStr(pOut, pOp->p4.z, pOp->p1, 0, 0);
1171 pOut->enc = encoding;
1172 UPDATE_MAX_BLOBSIZE(pOut);
1173 break;
1176 /* Opcode: Variable P1 P2 * P4 *
1177 ** Synopsis: r[P2]=parameter(P1,P4)
1179 ** Transfer the values of bound parameter P1 into register P2
1181 ** If the parameter is named, then its name appears in P4.
1182 ** The P4 value is used by sqlite3_bind_parameter_name().
1184 case OP_Variable: { /* out2 */
1185 Mem *pVar; /* Value being transferred */
1187 assert( pOp->p1>0 && pOp->p1<=p->nVar );
1188 assert( pOp->p4.z==0 || pOp->p4.z==sqlite3VListNumToName(p->pVList,pOp->p1) );
1189 pVar = &p->aVar[pOp->p1 - 1];
1190 if( sqlite3VdbeMemTooBig(pVar) ){
1191 goto too_big;
1193 pOut = &aMem[pOp->p2];
1194 sqlite3VdbeMemShallowCopy(pOut, pVar, MEM_Static);
1195 UPDATE_MAX_BLOBSIZE(pOut);
1196 break;
1199 /* Opcode: Move P1 P2 P3 * *
1200 ** Synopsis: r[P2@P3]=r[P1@P3]
1202 ** Move the P3 values in register P1..P1+P3-1 over into
1203 ** registers P2..P2+P3-1. Registers P1..P1+P3-1 are
1204 ** left holding a NULL. It is an error for register ranges
1205 ** P1..P1+P3-1 and P2..P2+P3-1 to overlap. It is an error
1206 ** for P3 to be less than 1.
1208 case OP_Move: {
1209 int n; /* Number of registers left to copy */
1210 int p1; /* Register to copy from */
1211 int p2; /* Register to copy to */
1213 n = pOp->p3;
1214 p1 = pOp->p1;
1215 p2 = pOp->p2;
1216 assert( n>0 && p1>0 && p2>0 );
1217 assert( p1+n<=p2 || p2+n<=p1 );
1219 pIn1 = &aMem[p1];
1220 pOut = &aMem[p2];
1222 assert( pOut<=&aMem[(p->nMem+1 - p->nCursor)] );
1223 assert( pIn1<=&aMem[(p->nMem+1 - p->nCursor)] );
1224 assert( memIsValid(pIn1) );
1225 memAboutToChange(p, pOut);
1226 sqlite3VdbeMemMove(pOut, pIn1);
1227 #ifdef SQLITE_DEBUG
1228 if( pOut->pScopyFrom>=&aMem[p1] && pOut->pScopyFrom<pOut ){
1229 pOut->pScopyFrom += pOp->p2 - p1;
1231 #endif
1232 Deephemeralize(pOut);
1233 REGISTER_TRACE(p2++, pOut);
1234 pIn1++;
1235 pOut++;
1236 }while( --n );
1237 break;
1240 /* Opcode: Copy P1 P2 P3 * *
1241 ** Synopsis: r[P2@P3+1]=r[P1@P3+1]
1243 ** Make a copy of registers P1..P1+P3 into registers P2..P2+P3.
1245 ** This instruction makes a deep copy of the value. A duplicate
1246 ** is made of any string or blob constant. See also OP_SCopy.
1248 case OP_Copy: {
1249 int n;
1251 n = pOp->p3;
1252 pIn1 = &aMem[pOp->p1];
1253 pOut = &aMem[pOp->p2];
1254 assert( pOut!=pIn1 );
1255 while( 1 ){
1256 sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
1257 Deephemeralize(pOut);
1258 #ifdef SQLITE_DEBUG
1259 pOut->pScopyFrom = 0;
1260 #endif
1261 REGISTER_TRACE(pOp->p2+pOp->p3-n, pOut);
1262 if( (n--)==0 ) break;
1263 pOut++;
1264 pIn1++;
1266 break;
1269 /* Opcode: SCopy P1 P2 * * *
1270 ** Synopsis: r[P2]=r[P1]
1272 ** Make a shallow copy of register P1 into register P2.
1274 ** This instruction makes a shallow copy of the value. If the value
1275 ** is a string or blob, then the copy is only a pointer to the
1276 ** original and hence if the original changes so will the copy.
1277 ** Worse, if the original is deallocated, the copy becomes invalid.
1278 ** Thus the program must guarantee that the original will not change
1279 ** during the lifetime of the copy. Use OP_Copy to make a complete
1280 ** copy.
1282 case OP_SCopy: { /* out2 */
1283 pIn1 = &aMem[pOp->p1];
1284 pOut = &aMem[pOp->p2];
1285 assert( pOut!=pIn1 );
1286 sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
1287 #ifdef SQLITE_DEBUG
1288 if( pOut->pScopyFrom==0 ) pOut->pScopyFrom = pIn1;
1289 #endif
1290 break;
1293 /* Opcode: IntCopy P1 P2 * * *
1294 ** Synopsis: r[P2]=r[P1]
1296 ** Transfer the integer value held in register P1 into register P2.
1298 ** This is an optimized version of SCopy that works only for integer
1299 ** values.
1301 case OP_IntCopy: { /* out2 */
1302 pIn1 = &aMem[pOp->p1];
1303 assert( (pIn1->flags & MEM_Int)!=0 );
1304 pOut = &aMem[pOp->p2];
1305 sqlite3VdbeMemSetInt64(pOut, pIn1->u.i);
1306 break;
1309 /* Opcode: ResultRow P1 P2 * * *
1310 ** Synopsis: output=r[P1@P2]
1312 ** The registers P1 through P1+P2-1 contain a single row of
1313 ** results. This opcode causes the sqlite3_step() call to terminate
1314 ** with an SQLITE_ROW return code and it sets up the sqlite3_stmt
1315 ** structure to provide access to the r(P1)..r(P1+P2-1) values as
1316 ** the result row.
1318 case OP_ResultRow: {
1319 Mem *pMem;
1320 int i;
1321 assert( p->nResColumn==pOp->p2 );
1322 assert( pOp->p1>0 );
1323 assert( pOp->p1+pOp->p2<=(p->nMem+1 - p->nCursor)+1 );
1325 #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1326 /* Run the progress counter just before returning.
1328 if( db->xProgress!=0
1329 && nVmStep>=nProgressLimit
1330 && db->xProgress(db->pProgressArg)!=0
1332 rc = SQLITE_INTERRUPT;
1333 goto abort_due_to_error;
1335 #endif
1337 /* If this statement has violated immediate foreign key constraints, do
1338 ** not return the number of rows modified. And do not RELEASE the statement
1339 ** transaction. It needs to be rolled back. */
1340 if( SQLITE_OK!=(rc = sqlite3VdbeCheckFk(p, 0)) ){
1341 assert( db->flags&SQLITE_CountRows );
1342 assert( p->usesStmtJournal );
1343 goto abort_due_to_error;
1346 /* If the SQLITE_CountRows flag is set in sqlite3.flags mask, then
1347 ** DML statements invoke this opcode to return the number of rows
1348 ** modified to the user. This is the only way that a VM that
1349 ** opens a statement transaction may invoke this opcode.
1351 ** In case this is such a statement, close any statement transaction
1352 ** opened by this VM before returning control to the user. This is to
1353 ** ensure that statement-transactions are always nested, not overlapping.
1354 ** If the open statement-transaction is not closed here, then the user
1355 ** may step another VM that opens its own statement transaction. This
1356 ** may lead to overlapping statement transactions.
1358 ** The statement transaction is never a top-level transaction. Hence
1359 ** the RELEASE call below can never fail.
1361 assert( p->iStatement==0 || db->flags&SQLITE_CountRows );
1362 rc = sqlite3VdbeCloseStatement(p, SAVEPOINT_RELEASE);
1363 assert( rc==SQLITE_OK );
1365 /* Invalidate all ephemeral cursor row caches */
1366 p->cacheCtr = (p->cacheCtr + 2)|1;
1368 /* Make sure the results of the current row are \000 terminated
1369 ** and have an assigned type. The results are de-ephemeralized as
1370 ** a side effect.
1372 pMem = p->pResultSet = &aMem[pOp->p1];
1373 for(i=0; i<pOp->p2; i++){
1374 assert( memIsValid(&pMem[i]) );
1375 Deephemeralize(&pMem[i]);
1376 assert( (pMem[i].flags & MEM_Ephem)==0
1377 || (pMem[i].flags & (MEM_Str|MEM_Blob))==0 );
1378 sqlite3VdbeMemNulTerminate(&pMem[i]);
1379 REGISTER_TRACE(pOp->p1+i, &pMem[i]);
1381 if( db->mallocFailed ) goto no_mem;
1383 if( db->mTrace & SQLITE_TRACE_ROW ){
1384 db->xTrace(SQLITE_TRACE_ROW, db->pTraceArg, p, 0);
1387 /* Return SQLITE_ROW
1389 p->pc = (int)(pOp - aOp) + 1;
1390 rc = SQLITE_ROW;
1391 goto vdbe_return;
1394 /* Opcode: Concat P1 P2 P3 * *
1395 ** Synopsis: r[P3]=r[P2]+r[P1]
1397 ** Add the text in register P1 onto the end of the text in
1398 ** register P2 and store the result in register P3.
1399 ** If either the P1 or P2 text are NULL then store NULL in P3.
1401 ** P3 = P2 || P1
1403 ** It is illegal for P1 and P3 to be the same register. Sometimes,
1404 ** if P3 is the same register as P2, the implementation is able
1405 ** to avoid a memcpy().
1407 case OP_Concat: { /* same as TK_CONCAT, in1, in2, out3 */
1408 i64 nByte;
1410 pIn1 = &aMem[pOp->p1];
1411 pIn2 = &aMem[pOp->p2];
1412 pOut = &aMem[pOp->p3];
1413 assert( pIn1!=pOut );
1414 if( (pIn1->flags | pIn2->flags) & MEM_Null ){
1415 sqlite3VdbeMemSetNull(pOut);
1416 break;
1418 if( ExpandBlob(pIn1) || ExpandBlob(pIn2) ) goto no_mem;
1419 Stringify(pIn1, encoding);
1420 Stringify(pIn2, encoding);
1421 nByte = pIn1->n + pIn2->n;
1422 if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
1423 goto too_big;
1425 if( sqlite3VdbeMemGrow(pOut, (int)nByte+2, pOut==pIn2) ){
1426 goto no_mem;
1428 MemSetTypeFlag(pOut, MEM_Str);
1429 if( pOut!=pIn2 ){
1430 memcpy(pOut->z, pIn2->z, pIn2->n);
1432 memcpy(&pOut->z[pIn2->n], pIn1->z, pIn1->n);
1433 pOut->z[nByte]=0;
1434 pOut->z[nByte+1] = 0;
1435 pOut->flags |= MEM_Term;
1436 pOut->n = (int)nByte;
1437 pOut->enc = encoding;
1438 UPDATE_MAX_BLOBSIZE(pOut);
1439 break;
1442 /* Opcode: Add P1 P2 P3 * *
1443 ** Synopsis: r[P3]=r[P1]+r[P2]
1445 ** Add the value in register P1 to the value in register P2
1446 ** and store the result in register P3.
1447 ** If either input is NULL, the result is NULL.
1449 /* Opcode: Multiply P1 P2 P3 * *
1450 ** Synopsis: r[P3]=r[P1]*r[P2]
1453 ** Multiply the value in register P1 by the value in register P2
1454 ** and store the result in register P3.
1455 ** If either input is NULL, the result is NULL.
1457 /* Opcode: Subtract P1 P2 P3 * *
1458 ** Synopsis: r[P3]=r[P2]-r[P1]
1460 ** Subtract the value in register P1 from the value in register P2
1461 ** and store the result in register P3.
1462 ** If either input is NULL, the result is NULL.
1464 /* Opcode: Divide P1 P2 P3 * *
1465 ** Synopsis: r[P3]=r[P2]/r[P1]
1467 ** Divide the value in register P1 by the value in register P2
1468 ** and store the result in register P3 (P3=P2/P1). If the value in
1469 ** register P1 is zero, then the result is NULL. If either input is
1470 ** NULL, the result is NULL.
1472 /* Opcode: Remainder P1 P2 P3 * *
1473 ** Synopsis: r[P3]=r[P2]%r[P1]
1475 ** Compute the remainder after integer register P2 is divided by
1476 ** register P1 and store the result in register P3.
1477 ** If the value in register P1 is zero the result is NULL.
1478 ** If either operand is NULL, the result is NULL.
1480 case OP_Add: /* same as TK_PLUS, in1, in2, out3 */
1481 case OP_Subtract: /* same as TK_MINUS, in1, in2, out3 */
1482 case OP_Multiply: /* same as TK_STAR, in1, in2, out3 */
1483 case OP_Divide: /* same as TK_SLASH, in1, in2, out3 */
1484 case OP_Remainder: { /* same as TK_REM, in1, in2, out3 */
1485 char bIntint; /* Started out as two integer operands */
1486 u16 flags; /* Combined MEM_* flags from both inputs */
1487 u16 type1; /* Numeric type of left operand */
1488 u16 type2; /* Numeric type of right operand */
1489 i64 iA; /* Integer value of left operand */
1490 i64 iB; /* Integer value of right operand */
1491 double rA; /* Real value of left operand */
1492 double rB; /* Real value of right operand */
1494 pIn1 = &aMem[pOp->p1];
1495 type1 = numericType(pIn1);
1496 pIn2 = &aMem[pOp->p2];
1497 type2 = numericType(pIn2);
1498 pOut = &aMem[pOp->p3];
1499 flags = pIn1->flags | pIn2->flags;
1500 if( (type1 & type2 & MEM_Int)!=0 ){
1501 iA = pIn1->u.i;
1502 iB = pIn2->u.i;
1503 bIntint = 1;
1504 switch( pOp->opcode ){
1505 case OP_Add: if( sqlite3AddInt64(&iB,iA) ) goto fp_math; break;
1506 case OP_Subtract: if( sqlite3SubInt64(&iB,iA) ) goto fp_math; break;
1507 case OP_Multiply: if( sqlite3MulInt64(&iB,iA) ) goto fp_math; break;
1508 case OP_Divide: {
1509 if( iA==0 ) goto arithmetic_result_is_null;
1510 if( iA==-1 && iB==SMALLEST_INT64 ) goto fp_math;
1511 iB /= iA;
1512 break;
1514 default: {
1515 if( iA==0 ) goto arithmetic_result_is_null;
1516 if( iA==-1 ) iA = 1;
1517 iB %= iA;
1518 break;
1521 pOut->u.i = iB;
1522 MemSetTypeFlag(pOut, MEM_Int);
1523 }else if( (flags & MEM_Null)!=0 ){
1524 goto arithmetic_result_is_null;
1525 }else{
1526 bIntint = 0;
1527 fp_math:
1528 rA = sqlite3VdbeRealValue(pIn1);
1529 rB = sqlite3VdbeRealValue(pIn2);
1530 switch( pOp->opcode ){
1531 case OP_Add: rB += rA; break;
1532 case OP_Subtract: rB -= rA; break;
1533 case OP_Multiply: rB *= rA; break;
1534 case OP_Divide: {
1535 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
1536 if( rA==(double)0 ) goto arithmetic_result_is_null;
1537 rB /= rA;
1538 break;
1540 default: {
1541 iA = (i64)rA;
1542 iB = (i64)rB;
1543 if( iA==0 ) goto arithmetic_result_is_null;
1544 if( iA==-1 ) iA = 1;
1545 rB = (double)(iB % iA);
1546 break;
1549 #ifdef SQLITE_OMIT_FLOATING_POINT
1550 pOut->u.i = rB;
1551 MemSetTypeFlag(pOut, MEM_Int);
1552 #else
1553 if( sqlite3IsNaN(rB) ){
1554 goto arithmetic_result_is_null;
1556 pOut->u.r = rB;
1557 MemSetTypeFlag(pOut, MEM_Real);
1558 if( ((type1|type2)&MEM_Real)==0 && !bIntint ){
1559 sqlite3VdbeIntegerAffinity(pOut);
1561 #endif
1563 break;
1565 arithmetic_result_is_null:
1566 sqlite3VdbeMemSetNull(pOut);
1567 break;
1570 /* Opcode: CollSeq P1 * * P4
1572 ** P4 is a pointer to a CollSeq object. If the next call to a user function
1573 ** or aggregate calls sqlite3GetFuncCollSeq(), this collation sequence will
1574 ** be returned. This is used by the built-in min(), max() and nullif()
1575 ** functions.
1577 ** If P1 is not zero, then it is a register that a subsequent min() or
1578 ** max() aggregate will set to 1 if the current row is not the minimum or
1579 ** maximum. The P1 register is initialized to 0 by this instruction.
1581 ** The interface used by the implementation of the aforementioned functions
1582 ** to retrieve the collation sequence set by this opcode is not available
1583 ** publicly. Only built-in functions have access to this feature.
1585 case OP_CollSeq: {
1586 assert( pOp->p4type==P4_COLLSEQ );
1587 if( pOp->p1 ){
1588 sqlite3VdbeMemSetInt64(&aMem[pOp->p1], 0);
1590 break;
1593 /* Opcode: BitAnd P1 P2 P3 * *
1594 ** Synopsis: r[P3]=r[P1]&r[P2]
1596 ** Take the bit-wise AND of the values in register P1 and P2 and
1597 ** store the result in register P3.
1598 ** If either input is NULL, the result is NULL.
1600 /* Opcode: BitOr P1 P2 P3 * *
1601 ** Synopsis: r[P3]=r[P1]|r[P2]
1603 ** Take the bit-wise OR of the values in register P1 and P2 and
1604 ** store the result in register P3.
1605 ** If either input is NULL, the result is NULL.
1607 /* Opcode: ShiftLeft P1 P2 P3 * *
1608 ** Synopsis: r[P3]=r[P2]<<r[P1]
1610 ** Shift the integer value in register P2 to the left by the
1611 ** number of bits specified by the integer in register P1.
1612 ** Store the result in register P3.
1613 ** If either input is NULL, the result is NULL.
1615 /* Opcode: ShiftRight P1 P2 P3 * *
1616 ** Synopsis: r[P3]=r[P2]>>r[P1]
1618 ** Shift the integer value in register P2 to the right by the
1619 ** number of bits specified by the integer in register P1.
1620 ** Store the result in register P3.
1621 ** If either input is NULL, the result is NULL.
1623 case OP_BitAnd: /* same as TK_BITAND, in1, in2, out3 */
1624 case OP_BitOr: /* same as TK_BITOR, in1, in2, out3 */
1625 case OP_ShiftLeft: /* same as TK_LSHIFT, in1, in2, out3 */
1626 case OP_ShiftRight: { /* same as TK_RSHIFT, in1, in2, out3 */
1627 i64 iA;
1628 u64 uA;
1629 i64 iB;
1630 u8 op;
1632 pIn1 = &aMem[pOp->p1];
1633 pIn2 = &aMem[pOp->p2];
1634 pOut = &aMem[pOp->p3];
1635 if( (pIn1->flags | pIn2->flags) & MEM_Null ){
1636 sqlite3VdbeMemSetNull(pOut);
1637 break;
1639 iA = sqlite3VdbeIntValue(pIn2);
1640 iB = sqlite3VdbeIntValue(pIn1);
1641 op = pOp->opcode;
1642 if( op==OP_BitAnd ){
1643 iA &= iB;
1644 }else if( op==OP_BitOr ){
1645 iA |= iB;
1646 }else if( iB!=0 ){
1647 assert( op==OP_ShiftRight || op==OP_ShiftLeft );
1649 /* If shifting by a negative amount, shift in the other direction */
1650 if( iB<0 ){
1651 assert( OP_ShiftRight==OP_ShiftLeft+1 );
1652 op = 2*OP_ShiftLeft + 1 - op;
1653 iB = iB>(-64) ? -iB : 64;
1656 if( iB>=64 ){
1657 iA = (iA>=0 || op==OP_ShiftLeft) ? 0 : -1;
1658 }else{
1659 memcpy(&uA, &iA, sizeof(uA));
1660 if( op==OP_ShiftLeft ){
1661 uA <<= iB;
1662 }else{
1663 uA >>= iB;
1664 /* Sign-extend on a right shift of a negative number */
1665 if( iA<0 ) uA |= ((((u64)0xffffffff)<<32)|0xffffffff) << (64-iB);
1667 memcpy(&iA, &uA, sizeof(iA));
1670 pOut->u.i = iA;
1671 MemSetTypeFlag(pOut, MEM_Int);
1672 break;
1675 /* Opcode: AddImm P1 P2 * * *
1676 ** Synopsis: r[P1]=r[P1]+P2
1678 ** Add the constant P2 to the value in register P1.
1679 ** The result is always an integer.
1681 ** To force any register to be an integer, just add 0.
1683 case OP_AddImm: { /* in1 */
1684 pIn1 = &aMem[pOp->p1];
1685 memAboutToChange(p, pIn1);
1686 sqlite3VdbeMemIntegerify(pIn1);
1687 pIn1->u.i += pOp->p2;
1688 break;
1691 /* Opcode: MustBeInt P1 P2 * * *
1693 ** Force the value in register P1 to be an integer. If the value
1694 ** in P1 is not an integer and cannot be converted into an integer
1695 ** without data loss, then jump immediately to P2, or if P2==0
1696 ** raise an SQLITE_MISMATCH exception.
1698 case OP_MustBeInt: { /* jump, in1 */
1699 pIn1 = &aMem[pOp->p1];
1700 if( (pIn1->flags & MEM_Int)==0 ){
1701 applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
1702 VdbeBranchTaken((pIn1->flags&MEM_Int)==0, 2);
1703 if( (pIn1->flags & MEM_Int)==0 ){
1704 if( pOp->p2==0 ){
1705 rc = SQLITE_MISMATCH;
1706 goto abort_due_to_error;
1707 }else{
1708 goto jump_to_p2;
1712 MemSetTypeFlag(pIn1, MEM_Int);
1713 break;
1716 #ifndef SQLITE_OMIT_FLOATING_POINT
1717 /* Opcode: RealAffinity P1 * * * *
1719 ** If register P1 holds an integer convert it to a real value.
1721 ** This opcode is used when extracting information from a column that
1722 ** has REAL affinity. Such column values may still be stored as
1723 ** integers, for space efficiency, but after extraction we want them
1724 ** to have only a real value.
1726 case OP_RealAffinity: { /* in1 */
1727 pIn1 = &aMem[pOp->p1];
1728 if( pIn1->flags & MEM_Int ){
1729 sqlite3VdbeMemRealify(pIn1);
1731 break;
1733 #endif
1735 #ifndef SQLITE_OMIT_CAST
1736 /* Opcode: Cast P1 P2 * * *
1737 ** Synopsis: affinity(r[P1])
1739 ** Force the value in register P1 to be the type defined by P2.
1741 ** <ul>
1742 ** <li> P2=='A' &rarr; BLOB
1743 ** <li> P2=='B' &rarr; TEXT
1744 ** <li> P2=='C' &rarr; NUMERIC
1745 ** <li> P2=='D' &rarr; INTEGER
1746 ** <li> P2=='E' &rarr; REAL
1747 ** </ul>
1749 ** A NULL value is not changed by this routine. It remains NULL.
1751 case OP_Cast: { /* in1 */
1752 assert( pOp->p2>=SQLITE_AFF_BLOB && pOp->p2<=SQLITE_AFF_REAL );
1753 testcase( pOp->p2==SQLITE_AFF_TEXT );
1754 testcase( pOp->p2==SQLITE_AFF_BLOB );
1755 testcase( pOp->p2==SQLITE_AFF_NUMERIC );
1756 testcase( pOp->p2==SQLITE_AFF_INTEGER );
1757 testcase( pOp->p2==SQLITE_AFF_REAL );
1758 pIn1 = &aMem[pOp->p1];
1759 memAboutToChange(p, pIn1);
1760 rc = ExpandBlob(pIn1);
1761 sqlite3VdbeMemCast(pIn1, pOp->p2, encoding);
1762 UPDATE_MAX_BLOBSIZE(pIn1);
1763 if( rc ) goto abort_due_to_error;
1764 break;
1766 #endif /* SQLITE_OMIT_CAST */
1768 /* Opcode: Eq P1 P2 P3 P4 P5
1769 ** Synopsis: IF r[P3]==r[P1]
1771 ** Compare the values in register P1 and P3. If reg(P3)==reg(P1) then
1772 ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5, then
1773 ** store the result of comparison in register P2.
1775 ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
1776 ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
1777 ** to coerce both inputs according to this affinity before the
1778 ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
1779 ** affinity is used. Note that the affinity conversions are stored
1780 ** back into the input registers P1 and P3. So this opcode can cause
1781 ** persistent changes to registers P1 and P3.
1783 ** Once any conversions have taken place, and neither value is NULL,
1784 ** the values are compared. If both values are blobs then memcmp() is
1785 ** used to determine the results of the comparison. If both values
1786 ** are text, then the appropriate collating function specified in
1787 ** P4 is used to do the comparison. If P4 is not specified then
1788 ** memcmp() is used to compare text string. If both values are
1789 ** numeric, then a numeric comparison is used. If the two values
1790 ** are of different types, then numbers are considered less than
1791 ** strings and strings are considered less than blobs.
1793 ** If SQLITE_NULLEQ is set in P5 then the result of comparison is always either
1794 ** true or false and is never NULL. If both operands are NULL then the result
1795 ** of comparison is true. If either operand is NULL then the result is false.
1796 ** If neither operand is NULL the result is the same as it would be if
1797 ** the SQLITE_NULLEQ flag were omitted from P5.
1799 ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
1800 ** content of r[P2] is only changed if the new value is NULL or 0 (false).
1801 ** In other words, a prior r[P2] value will not be overwritten by 1 (true).
1803 /* Opcode: Ne P1 P2 P3 P4 P5
1804 ** Synopsis: IF r[P3]!=r[P1]
1806 ** This works just like the Eq opcode except that the jump is taken if
1807 ** the operands in registers P1 and P3 are not equal. See the Eq opcode for
1808 ** additional information.
1810 ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
1811 ** content of r[P2] is only changed if the new value is NULL or 1 (true).
1812 ** In other words, a prior r[P2] value will not be overwritten by 0 (false).
1814 /* Opcode: Lt P1 P2 P3 P4 P5
1815 ** Synopsis: IF r[P3]<r[P1]
1817 ** Compare the values in register P1 and P3. If reg(P3)<reg(P1) then
1818 ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5 store
1819 ** the result of comparison (0 or 1 or NULL) into register P2.
1821 ** If the SQLITE_JUMPIFNULL bit of P5 is set and either reg(P1) or
1822 ** reg(P3) is NULL then the take the jump. If the SQLITE_JUMPIFNULL
1823 ** bit is clear then fall through if either operand is NULL.
1825 ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
1826 ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
1827 ** to coerce both inputs according to this affinity before the
1828 ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
1829 ** affinity is used. Note that the affinity conversions are stored
1830 ** back into the input registers P1 and P3. So this opcode can cause
1831 ** persistent changes to registers P1 and P3.
1833 ** Once any conversions have taken place, and neither value is NULL,
1834 ** the values are compared. If both values are blobs then memcmp() is
1835 ** used to determine the results of the comparison. If both values
1836 ** are text, then the appropriate collating function specified in
1837 ** P4 is used to do the comparison. If P4 is not specified then
1838 ** memcmp() is used to compare text string. If both values are
1839 ** numeric, then a numeric comparison is used. If the two values
1840 ** are of different types, then numbers are considered less than
1841 ** strings and strings are considered less than blobs.
1843 /* Opcode: Le P1 P2 P3 P4 P5
1844 ** Synopsis: IF r[P3]<=r[P1]
1846 ** This works just like the Lt opcode except that the jump is taken if
1847 ** the content of register P3 is less than or equal to the content of
1848 ** register P1. See the Lt opcode for additional information.
1850 /* Opcode: Gt P1 P2 P3 P4 P5
1851 ** Synopsis: IF r[P3]>r[P1]
1853 ** This works just like the Lt opcode except that the jump is taken if
1854 ** the content of register P3 is greater than the content of
1855 ** register P1. See the Lt opcode for additional information.
1857 /* Opcode: Ge P1 P2 P3 P4 P5
1858 ** Synopsis: IF r[P3]>=r[P1]
1860 ** This works just like the Lt opcode except that the jump is taken if
1861 ** the content of register P3 is greater than or equal to the content of
1862 ** register P1. See the Lt opcode for additional information.
1864 case OP_Eq: /* same as TK_EQ, jump, in1, in3 */
1865 case OP_Ne: /* same as TK_NE, jump, in1, in3 */
1866 case OP_Lt: /* same as TK_LT, jump, in1, in3 */
1867 case OP_Le: /* same as TK_LE, jump, in1, in3 */
1868 case OP_Gt: /* same as TK_GT, jump, in1, in3 */
1869 case OP_Ge: { /* same as TK_GE, jump, in1, in3 */
1870 int res, res2; /* Result of the comparison of pIn1 against pIn3 */
1871 char affinity; /* Affinity to use for comparison */
1872 u16 flags1; /* Copy of initial value of pIn1->flags */
1873 u16 flags3; /* Copy of initial value of pIn3->flags */
1875 pIn1 = &aMem[pOp->p1];
1876 pIn3 = &aMem[pOp->p3];
1877 flags1 = pIn1->flags;
1878 flags3 = pIn3->flags;
1879 if( (flags1 | flags3)&MEM_Null ){
1880 /* One or both operands are NULL */
1881 if( pOp->p5 & SQLITE_NULLEQ ){
1882 /* If SQLITE_NULLEQ is set (which will only happen if the operator is
1883 ** OP_Eq or OP_Ne) then take the jump or not depending on whether
1884 ** or not both operands are null.
1886 assert( pOp->opcode==OP_Eq || pOp->opcode==OP_Ne );
1887 assert( (flags1 & MEM_Cleared)==0 );
1888 assert( (pOp->p5 & SQLITE_JUMPIFNULL)==0 );
1889 if( (flags1&flags3&MEM_Null)!=0
1890 && (flags3&MEM_Cleared)==0
1892 res = 0; /* Operands are equal */
1893 }else{
1894 res = 1; /* Operands are not equal */
1896 }else{
1897 /* SQLITE_NULLEQ is clear and at least one operand is NULL,
1898 ** then the result is always NULL.
1899 ** The jump is taken if the SQLITE_JUMPIFNULL bit is set.
1901 if( pOp->p5 & SQLITE_STOREP2 ){
1902 pOut = &aMem[pOp->p2];
1903 iCompare = 1; /* Operands are not equal */
1904 memAboutToChange(p, pOut);
1905 MemSetTypeFlag(pOut, MEM_Null);
1906 REGISTER_TRACE(pOp->p2, pOut);
1907 }else{
1908 VdbeBranchTaken(2,3);
1909 if( pOp->p5 & SQLITE_JUMPIFNULL ){
1910 goto jump_to_p2;
1913 break;
1915 }else{
1916 /* Neither operand is NULL. Do a comparison. */
1917 affinity = pOp->p5 & SQLITE_AFF_MASK;
1918 if( affinity>=SQLITE_AFF_NUMERIC ){
1919 if( (flags1 | flags3)&MEM_Str ){
1920 if( (flags1 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
1921 applyNumericAffinity(pIn1,0);
1922 testcase( flags3!=pIn3->flags ); /* Possible if pIn1==pIn3 */
1923 flags3 = pIn3->flags;
1925 if( (flags3 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
1926 applyNumericAffinity(pIn3,0);
1929 /* Handle the common case of integer comparison here, as an
1930 ** optimization, to avoid a call to sqlite3MemCompare() */
1931 if( (pIn1->flags & pIn3->flags & MEM_Int)!=0 ){
1932 if( pIn3->u.i > pIn1->u.i ){ res = +1; goto compare_op; }
1933 if( pIn3->u.i < pIn1->u.i ){ res = -1; goto compare_op; }
1934 res = 0;
1935 goto compare_op;
1937 }else if( affinity==SQLITE_AFF_TEXT ){
1938 if( (flags1 & MEM_Str)==0 && (flags1 & (MEM_Int|MEM_Real))!=0 ){
1939 testcase( pIn1->flags & MEM_Int );
1940 testcase( pIn1->flags & MEM_Real );
1941 sqlite3VdbeMemStringify(pIn1, encoding, 1);
1942 testcase( (flags1&MEM_Dyn) != (pIn1->flags&MEM_Dyn) );
1943 flags1 = (pIn1->flags & ~MEM_TypeMask) | (flags1 & MEM_TypeMask);
1944 assert( pIn1!=pIn3 );
1946 if( (flags3 & MEM_Str)==0 && (flags3 & (MEM_Int|MEM_Real))!=0 ){
1947 testcase( pIn3->flags & MEM_Int );
1948 testcase( pIn3->flags & MEM_Real );
1949 sqlite3VdbeMemStringify(pIn3, encoding, 1);
1950 testcase( (flags3&MEM_Dyn) != (pIn3->flags&MEM_Dyn) );
1951 flags3 = (pIn3->flags & ~MEM_TypeMask) | (flags3 & MEM_TypeMask);
1954 assert( pOp->p4type==P4_COLLSEQ || pOp->p4.pColl==0 );
1955 res = sqlite3MemCompare(pIn3, pIn1, pOp->p4.pColl);
1957 compare_op:
1958 /* At this point, res is negative, zero, or positive if reg[P1] is
1959 ** less than, equal to, or greater than reg[P3], respectively. Compute
1960 ** the answer to this operator in res2, depending on what the comparison
1961 ** operator actually is. The next block of code depends on the fact
1962 ** that the 6 comparison operators are consecutive integers in this
1963 ** order: NE, EQ, GT, LE, LT, GE */
1964 assert( OP_Eq==OP_Ne+1 ); assert( OP_Gt==OP_Ne+2 ); assert( OP_Le==OP_Ne+3 );
1965 assert( OP_Lt==OP_Ne+4 ); assert( OP_Ge==OP_Ne+5 );
1966 if( res<0 ){ /* ne, eq, gt, le, lt, ge */
1967 static const unsigned char aLTb[] = { 1, 0, 0, 1, 1, 0 };
1968 res2 = aLTb[pOp->opcode - OP_Ne];
1969 }else if( res==0 ){
1970 static const unsigned char aEQb[] = { 0, 1, 0, 1, 0, 1 };
1971 res2 = aEQb[pOp->opcode - OP_Ne];
1972 }else{
1973 static const unsigned char aGTb[] = { 1, 0, 1, 0, 0, 1 };
1974 res2 = aGTb[pOp->opcode - OP_Ne];
1977 /* Undo any changes made by applyAffinity() to the input registers. */
1978 assert( (pIn1->flags & MEM_Dyn) == (flags1 & MEM_Dyn) );
1979 pIn1->flags = flags1;
1980 assert( (pIn3->flags & MEM_Dyn) == (flags3 & MEM_Dyn) );
1981 pIn3->flags = flags3;
1983 if( pOp->p5 & SQLITE_STOREP2 ){
1984 pOut = &aMem[pOp->p2];
1985 iCompare = res;
1986 if( (pOp->p5 & SQLITE_KEEPNULL)!=0 ){
1987 /* The KEEPNULL flag prevents OP_Eq from overwriting a NULL with 1
1988 ** and prevents OP_Ne from overwriting NULL with 0. This flag
1989 ** is only used in contexts where either:
1990 ** (1) op==OP_Eq && (r[P2]==NULL || r[P2]==0)
1991 ** (2) op==OP_Ne && (r[P2]==NULL || r[P2]==1)
1992 ** Therefore it is not necessary to check the content of r[P2] for
1993 ** NULL. */
1994 assert( pOp->opcode==OP_Ne || pOp->opcode==OP_Eq );
1995 assert( res2==0 || res2==1 );
1996 testcase( res2==0 && pOp->opcode==OP_Eq );
1997 testcase( res2==1 && pOp->opcode==OP_Eq );
1998 testcase( res2==0 && pOp->opcode==OP_Ne );
1999 testcase( res2==1 && pOp->opcode==OP_Ne );
2000 if( (pOp->opcode==OP_Eq)==res2 ) break;
2002 memAboutToChange(p, pOut);
2003 MemSetTypeFlag(pOut, MEM_Int);
2004 pOut->u.i = res2;
2005 REGISTER_TRACE(pOp->p2, pOut);
2006 }else{
2007 VdbeBranchTaken(res!=0, (pOp->p5 & SQLITE_NULLEQ)?2:3);
2008 if( res2 ){
2009 goto jump_to_p2;
2012 break;
2015 /* Opcode: ElseNotEq * P2 * * *
2017 ** This opcode must immediately follow an OP_Lt or OP_Gt comparison operator.
2018 ** If result of an OP_Eq comparison on the same two operands
2019 ** would have be NULL or false (0), then then jump to P2.
2020 ** If the result of an OP_Eq comparison on the two previous operands
2021 ** would have been true (1), then fall through.
2023 case OP_ElseNotEq: { /* same as TK_ESCAPE, jump */
2024 assert( pOp>aOp );
2025 assert( pOp[-1].opcode==OP_Lt || pOp[-1].opcode==OP_Gt );
2026 assert( pOp[-1].p5 & SQLITE_STOREP2 );
2027 VdbeBranchTaken(iCompare!=0, 2);
2028 if( iCompare!=0 ) goto jump_to_p2;
2029 break;
2033 /* Opcode: Permutation * * * P4 *
2035 ** Set the permutation used by the OP_Compare operator in the next
2036 ** instruction. The permutation is stored in the P4 operand.
2038 ** The permutation is only valid until the next OP_Compare that has
2039 ** the OPFLAG_PERMUTE bit set in P5. Typically the OP_Permutation should
2040 ** occur immediately prior to the OP_Compare.
2042 ** The first integer in the P4 integer array is the length of the array
2043 ** and does not become part of the permutation.
2045 case OP_Permutation: {
2046 assert( pOp->p4type==P4_INTARRAY );
2047 assert( pOp->p4.ai );
2048 assert( pOp[1].opcode==OP_Compare );
2049 assert( pOp[1].p5 & OPFLAG_PERMUTE );
2050 break;
2053 /* Opcode: Compare P1 P2 P3 P4 P5
2054 ** Synopsis: r[P1@P3] <-> r[P2@P3]
2056 ** Compare two vectors of registers in reg(P1)..reg(P1+P3-1) (call this
2057 ** vector "A") and in reg(P2)..reg(P2+P3-1) ("B"). Save the result of
2058 ** the comparison for use by the next OP_Jump instruct.
2060 ** If P5 has the OPFLAG_PERMUTE bit set, then the order of comparison is
2061 ** determined by the most recent OP_Permutation operator. If the
2062 ** OPFLAG_PERMUTE bit is clear, then register are compared in sequential
2063 ** order.
2065 ** P4 is a KeyInfo structure that defines collating sequences and sort
2066 ** orders for the comparison. The permutation applies to registers
2067 ** only. The KeyInfo elements are used sequentially.
2069 ** The comparison is a sort comparison, so NULLs compare equal,
2070 ** NULLs are less than numbers, numbers are less than strings,
2071 ** and strings are less than blobs.
2073 case OP_Compare: {
2074 int n;
2075 int i;
2076 int p1;
2077 int p2;
2078 const KeyInfo *pKeyInfo;
2079 int idx;
2080 CollSeq *pColl; /* Collating sequence to use on this term */
2081 int bRev; /* True for DESCENDING sort order */
2082 int *aPermute; /* The permutation */
2084 if( (pOp->p5 & OPFLAG_PERMUTE)==0 ){
2085 aPermute = 0;
2086 }else{
2087 assert( pOp>aOp );
2088 assert( pOp[-1].opcode==OP_Permutation );
2089 assert( pOp[-1].p4type==P4_INTARRAY );
2090 aPermute = pOp[-1].p4.ai + 1;
2091 assert( aPermute!=0 );
2093 n = pOp->p3;
2094 pKeyInfo = pOp->p4.pKeyInfo;
2095 assert( n>0 );
2096 assert( pKeyInfo!=0 );
2097 p1 = pOp->p1;
2098 p2 = pOp->p2;
2099 #ifdef SQLITE_DEBUG
2100 if( aPermute ){
2101 int k, mx = 0;
2102 for(k=0; k<n; k++) if( aPermute[k]>mx ) mx = aPermute[k];
2103 assert( p1>0 && p1+mx<=(p->nMem+1 - p->nCursor)+1 );
2104 assert( p2>0 && p2+mx<=(p->nMem+1 - p->nCursor)+1 );
2105 }else{
2106 assert( p1>0 && p1+n<=(p->nMem+1 - p->nCursor)+1 );
2107 assert( p2>0 && p2+n<=(p->nMem+1 - p->nCursor)+1 );
2109 #endif /* SQLITE_DEBUG */
2110 for(i=0; i<n; i++){
2111 idx = aPermute ? aPermute[i] : i;
2112 assert( memIsValid(&aMem[p1+idx]) );
2113 assert( memIsValid(&aMem[p2+idx]) );
2114 REGISTER_TRACE(p1+idx, &aMem[p1+idx]);
2115 REGISTER_TRACE(p2+idx, &aMem[p2+idx]);
2116 assert( i<pKeyInfo->nKeyField );
2117 pColl = pKeyInfo->aColl[i];
2118 bRev = pKeyInfo->aSortOrder[i];
2119 iCompare = sqlite3MemCompare(&aMem[p1+idx], &aMem[p2+idx], pColl);
2120 if( iCompare ){
2121 if( bRev ) iCompare = -iCompare;
2122 break;
2125 break;
2128 /* Opcode: Jump P1 P2 P3 * *
2130 ** Jump to the instruction at address P1, P2, or P3 depending on whether
2131 ** in the most recent OP_Compare instruction the P1 vector was less than
2132 ** equal to, or greater than the P2 vector, respectively.
2134 case OP_Jump: { /* jump */
2135 if( iCompare<0 ){
2136 VdbeBranchTaken(0,3); pOp = &aOp[pOp->p1 - 1];
2137 }else if( iCompare==0 ){
2138 VdbeBranchTaken(1,3); pOp = &aOp[pOp->p2 - 1];
2139 }else{
2140 VdbeBranchTaken(2,3); pOp = &aOp[pOp->p3 - 1];
2142 break;
2145 /* Opcode: And P1 P2 P3 * *
2146 ** Synopsis: r[P3]=(r[P1] && r[P2])
2148 ** Take the logical AND of the values in registers P1 and P2 and
2149 ** write the result into register P3.
2151 ** If either P1 or P2 is 0 (false) then the result is 0 even if
2152 ** the other input is NULL. A NULL and true or two NULLs give
2153 ** a NULL output.
2155 /* Opcode: Or P1 P2 P3 * *
2156 ** Synopsis: r[P3]=(r[P1] || r[P2])
2158 ** Take the logical OR of the values in register P1 and P2 and
2159 ** store the answer in register P3.
2161 ** If either P1 or P2 is nonzero (true) then the result is 1 (true)
2162 ** even if the other input is NULL. A NULL and false or two NULLs
2163 ** give a NULL output.
2165 case OP_And: /* same as TK_AND, in1, in2, out3 */
2166 case OP_Or: { /* same as TK_OR, in1, in2, out3 */
2167 int v1; /* Left operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
2168 int v2; /* Right operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
2170 pIn1 = &aMem[pOp->p1];
2171 if( pIn1->flags & MEM_Null ){
2172 v1 = 2;
2173 }else{
2174 v1 = sqlite3VdbeIntValue(pIn1)!=0;
2176 pIn2 = &aMem[pOp->p2];
2177 if( pIn2->flags & MEM_Null ){
2178 v2 = 2;
2179 }else{
2180 v2 = sqlite3VdbeIntValue(pIn2)!=0;
2182 if( pOp->opcode==OP_And ){
2183 static const unsigned char and_logic[] = { 0, 0, 0, 0, 1, 2, 0, 2, 2 };
2184 v1 = and_logic[v1*3+v2];
2185 }else{
2186 static const unsigned char or_logic[] = { 0, 1, 2, 1, 1, 1, 2, 1, 2 };
2187 v1 = or_logic[v1*3+v2];
2189 pOut = &aMem[pOp->p3];
2190 if( v1==2 ){
2191 MemSetTypeFlag(pOut, MEM_Null);
2192 }else{
2193 pOut->u.i = v1;
2194 MemSetTypeFlag(pOut, MEM_Int);
2196 break;
2199 /* Opcode: Not P1 P2 * * *
2200 ** Synopsis: r[P2]= !r[P1]
2202 ** Interpret the value in register P1 as a boolean value. Store the
2203 ** boolean complement in register P2. If the value in register P1 is
2204 ** NULL, then a NULL is stored in P2.
2206 case OP_Not: { /* same as TK_NOT, in1, out2 */
2207 pIn1 = &aMem[pOp->p1];
2208 pOut = &aMem[pOp->p2];
2209 sqlite3VdbeMemSetNull(pOut);
2210 if( (pIn1->flags & MEM_Null)==0 ){
2211 pOut->flags = MEM_Int;
2212 pOut->u.i = !sqlite3VdbeIntValue(pIn1);
2214 break;
2217 /* Opcode: BitNot P1 P2 * * *
2218 ** Synopsis: r[P1]= ~r[P1]
2220 ** Interpret the content of register P1 as an integer. Store the
2221 ** ones-complement of the P1 value into register P2. If P1 holds
2222 ** a NULL then store a NULL in P2.
2224 case OP_BitNot: { /* same as TK_BITNOT, in1, out2 */
2225 pIn1 = &aMem[pOp->p1];
2226 pOut = &aMem[pOp->p2];
2227 sqlite3VdbeMemSetNull(pOut);
2228 if( (pIn1->flags & MEM_Null)==0 ){
2229 pOut->flags = MEM_Int;
2230 pOut->u.i = ~sqlite3VdbeIntValue(pIn1);
2232 break;
2235 /* Opcode: Once P1 P2 * * *
2237 ** Fall through to the next instruction the first time this opcode is
2238 ** encountered on each invocation of the byte-code program. Jump to P2
2239 ** on the second and all subsequent encounters during the same invocation.
2241 ** Top-level programs determine first invocation by comparing the P1
2242 ** operand against the P1 operand on the OP_Init opcode at the beginning
2243 ** of the program. If the P1 values differ, then fall through and make
2244 ** the P1 of this opcode equal to the P1 of OP_Init. If P1 values are
2245 ** the same then take the jump.
2247 ** For subprograms, there is a bitmask in the VdbeFrame that determines
2248 ** whether or not the jump should be taken. The bitmask is necessary
2249 ** because the self-altering code trick does not work for recursive
2250 ** triggers.
2252 case OP_Once: { /* jump */
2253 u32 iAddr; /* Address of this instruction */
2254 assert( p->aOp[0].opcode==OP_Init );
2255 if( p->pFrame ){
2256 iAddr = (int)(pOp - p->aOp);
2257 if( (p->pFrame->aOnce[iAddr/8] & (1<<(iAddr & 7)))!=0 ){
2258 VdbeBranchTaken(1, 2);
2259 goto jump_to_p2;
2261 p->pFrame->aOnce[iAddr/8] |= 1<<(iAddr & 7);
2262 }else{
2263 if( p->aOp[0].p1==pOp->p1 ){
2264 VdbeBranchTaken(1, 2);
2265 goto jump_to_p2;
2268 VdbeBranchTaken(0, 2);
2269 pOp->p1 = p->aOp[0].p1;
2270 break;
2273 /* Opcode: If P1 P2 P3 * *
2275 ** Jump to P2 if the value in register P1 is true. The value
2276 ** is considered true if it is numeric and non-zero. If the value
2277 ** in P1 is NULL then take the jump if and only if P3 is non-zero.
2279 /* Opcode: IfNot P1 P2 P3 * *
2281 ** Jump to P2 if the value in register P1 is False. The value
2282 ** is considered false if it has a numeric value of zero. If the value
2283 ** in P1 is NULL then take the jump if and only if P3 is non-zero.
2285 case OP_If: /* jump, in1 */
2286 case OP_IfNot: { /* jump, in1 */
2287 int c;
2288 pIn1 = &aMem[pOp->p1];
2289 if( pIn1->flags & MEM_Null ){
2290 c = pOp->p3;
2291 }else{
2292 #ifdef SQLITE_OMIT_FLOATING_POINT
2293 c = sqlite3VdbeIntValue(pIn1)!=0;
2294 #else
2295 c = sqlite3VdbeRealValue(pIn1)!=0.0;
2296 #endif
2297 if( pOp->opcode==OP_IfNot ) c = !c;
2299 VdbeBranchTaken(c!=0, 2);
2300 if( c ){
2301 goto jump_to_p2;
2303 break;
2306 /* Opcode: IsNull P1 P2 * * *
2307 ** Synopsis: if r[P1]==NULL goto P2
2309 ** Jump to P2 if the value in register P1 is NULL.
2311 case OP_IsNull: { /* same as TK_ISNULL, jump, in1 */
2312 pIn1 = &aMem[pOp->p1];
2313 VdbeBranchTaken( (pIn1->flags & MEM_Null)!=0, 2);
2314 if( (pIn1->flags & MEM_Null)!=0 ){
2315 goto jump_to_p2;
2317 break;
2320 /* Opcode: NotNull P1 P2 * * *
2321 ** Synopsis: if r[P1]!=NULL goto P2
2323 ** Jump to P2 if the value in register P1 is not NULL.
2325 case OP_NotNull: { /* same as TK_NOTNULL, jump, in1 */
2326 pIn1 = &aMem[pOp->p1];
2327 VdbeBranchTaken( (pIn1->flags & MEM_Null)==0, 2);
2328 if( (pIn1->flags & MEM_Null)==0 ){
2329 goto jump_to_p2;
2331 break;
2334 /* Opcode: IfNullRow P1 P2 P3 * *
2335 ** Synopsis: if P1.nullRow then r[P3]=NULL, goto P2
2337 ** Check the cursor P1 to see if it is currently pointing at a NULL row.
2338 ** If it is, then set register P3 to NULL and jump immediately to P2.
2339 ** If P1 is not on a NULL row, then fall through without making any
2340 ** changes.
2342 case OP_IfNullRow: { /* jump */
2343 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
2344 assert( p->apCsr[pOp->p1]!=0 );
2345 if( p->apCsr[pOp->p1]->nullRow ){
2346 sqlite3VdbeMemSetNull(aMem + pOp->p3);
2347 goto jump_to_p2;
2349 break;
2352 #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
2353 /* Opcode: Offset P1 P2 P3 * *
2354 ** Synopsis: r[P3] = sqlite_offset(P1)
2356 ** Store in register r[P3] the byte offset into the database file that is the
2357 ** start of the payload for the record at which that cursor P1 is currently
2358 ** pointing.
2360 ** P2 is the column number for the argument to the sqlite_offset() function.
2361 ** This opcode does not use P2 itself, but the P2 value is used by the
2362 ** code generator. The P1, P2, and P3 operands to this opcode are the
2363 ** as as for OP_Column.
2365 ** This opcode is only available if SQLite is compiled with the
2366 ** -DSQLITE_ENABLE_OFFSET_SQL_FUNC option.
2368 case OP_Offset: { /* out3 */
2369 VdbeCursor *pC; /* The VDBE cursor */
2370 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
2371 pC = p->apCsr[pOp->p1];
2372 pOut = &p->aMem[pOp->p3];
2373 if( pC==0 || pC->eCurType!=CURTYPE_BTREE ){
2374 sqlite3VdbeMemSetNull(pOut);
2375 }else{
2376 sqlite3VdbeMemSetInt64(pOut, sqlite3BtreeOffset(pC->uc.pCursor));
2378 break;
2380 #endif /* SQLITE_ENABLE_OFFSET_SQL_FUNC */
2382 /* Opcode: Column P1 P2 P3 P4 P5
2383 ** Synopsis: r[P3]=PX
2385 ** Interpret the data that cursor P1 points to as a structure built using
2386 ** the MakeRecord instruction. (See the MakeRecord opcode for additional
2387 ** information about the format of the data.) Extract the P2-th column
2388 ** from this record. If there are less that (P2+1)
2389 ** values in the record, extract a NULL.
2391 ** The value extracted is stored in register P3.
2393 ** If the record contains fewer than P2 fields, then extract a NULL. Or,
2394 ** if the P4 argument is a P4_MEM use the value of the P4 argument as
2395 ** the result.
2397 ** If the OPFLAG_CLEARCACHE bit is set on P5 and P1 is a pseudo-table cursor,
2398 ** then the cache of the cursor is reset prior to extracting the column.
2399 ** The first OP_Column against a pseudo-table after the value of the content
2400 ** register has changed should have this bit set.
2402 ** If the OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG bits are set on P5 then
2403 ** the result is guaranteed to only be used as the argument of a length()
2404 ** or typeof() function, respectively. The loading of large blobs can be
2405 ** skipped for length() and all content loading can be skipped for typeof().
2407 case OP_Column: {
2408 int p2; /* column number to retrieve */
2409 VdbeCursor *pC; /* The VDBE cursor */
2410 BtCursor *pCrsr; /* The BTree cursor */
2411 u32 *aOffset; /* aOffset[i] is offset to start of data for i-th column */
2412 int len; /* The length of the serialized data for the column */
2413 int i; /* Loop counter */
2414 Mem *pDest; /* Where to write the extracted value */
2415 Mem sMem; /* For storing the record being decoded */
2416 const u8 *zData; /* Part of the record being decoded */
2417 const u8 *zHdr; /* Next unparsed byte of the header */
2418 const u8 *zEndHdr; /* Pointer to first byte after the header */
2419 u64 offset64; /* 64-bit offset */
2420 u32 t; /* A type code from the record header */
2421 Mem *pReg; /* PseudoTable input register */
2423 pC = p->apCsr[pOp->p1];
2424 p2 = pOp->p2;
2426 /* If the cursor cache is stale (meaning it is not currently point at
2427 ** the correct row) then bring it up-to-date by doing the necessary
2428 ** B-Tree seek. */
2429 rc = sqlite3VdbeCursorMoveto(&pC, &p2);
2430 if( rc ) goto abort_due_to_error;
2432 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
2433 pDest = &aMem[pOp->p3];
2434 memAboutToChange(p, pDest);
2435 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
2436 assert( pC!=0 );
2437 assert( p2<pC->nField );
2438 aOffset = pC->aOffset;
2439 assert( pC->eCurType!=CURTYPE_VTAB );
2440 assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
2441 assert( pC->eCurType!=CURTYPE_SORTER );
2443 if( pC->cacheStatus!=p->cacheCtr ){ /*OPTIMIZATION-IF-FALSE*/
2444 if( pC->nullRow ){
2445 if( pC->eCurType==CURTYPE_PSEUDO ){
2446 /* For the special case of as pseudo-cursor, the seekResult field
2447 ** identifies the register that holds the record */
2448 assert( pC->seekResult>0 );
2449 pReg = &aMem[pC->seekResult];
2450 assert( pReg->flags & MEM_Blob );
2451 assert( memIsValid(pReg) );
2452 pC->payloadSize = pC->szRow = pReg->n;
2453 pC->aRow = (u8*)pReg->z;
2454 }else{
2455 sqlite3VdbeMemSetNull(pDest);
2456 goto op_column_out;
2458 }else{
2459 pCrsr = pC->uc.pCursor;
2460 assert( pC->eCurType==CURTYPE_BTREE );
2461 assert( pCrsr );
2462 assert( sqlite3BtreeCursorIsValid(pCrsr) );
2463 pC->payloadSize = sqlite3BtreePayloadSize(pCrsr);
2464 pC->aRow = sqlite3BtreePayloadFetch(pCrsr, &pC->szRow);
2465 assert( pC->szRow<=pC->payloadSize );
2466 assert( pC->szRow<=65536 ); /* Maximum page size is 64KiB */
2467 if( pC->payloadSize > (u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
2468 goto too_big;
2471 pC->cacheStatus = p->cacheCtr;
2472 pC->iHdrOffset = getVarint32(pC->aRow, aOffset[0]);
2473 pC->nHdrParsed = 0;
2476 if( pC->szRow<aOffset[0] ){ /*OPTIMIZATION-IF-FALSE*/
2477 /* pC->aRow does not have to hold the entire row, but it does at least
2478 ** need to cover the header of the record. If pC->aRow does not contain
2479 ** the complete header, then set it to zero, forcing the header to be
2480 ** dynamically allocated. */
2481 pC->aRow = 0;
2482 pC->szRow = 0;
2484 /* Make sure a corrupt database has not given us an oversize header.
2485 ** Do this now to avoid an oversize memory allocation.
2487 ** Type entries can be between 1 and 5 bytes each. But 4 and 5 byte
2488 ** types use so much data space that there can only be 4096 and 32 of
2489 ** them, respectively. So the maximum header length results from a
2490 ** 3-byte type for each of the maximum of 32768 columns plus three
2491 ** extra bytes for the header length itself. 32768*3 + 3 = 98307.
2493 if( aOffset[0] > 98307 || aOffset[0] > pC->payloadSize ){
2494 goto op_column_corrupt;
2496 }else{
2497 /* This is an optimization. By skipping over the first few tests
2498 ** (ex: pC->nHdrParsed<=p2) in the next section, we achieve a
2499 ** measurable performance gain.
2501 ** This branch is taken even if aOffset[0]==0. Such a record is never
2502 ** generated by SQLite, and could be considered corruption, but we
2503 ** accept it for historical reasons. When aOffset[0]==0, the code this
2504 ** branch jumps to reads past the end of the record, but never more
2505 ** than a few bytes. Even if the record occurs at the end of the page
2506 ** content area, the "page header" comes after the page content and so
2507 ** this overread is harmless. Similar overreads can occur for a corrupt
2508 ** database file.
2510 zData = pC->aRow;
2511 assert( pC->nHdrParsed<=p2 ); /* Conditional skipped */
2512 testcase( aOffset[0]==0 );
2513 goto op_column_read_header;
2517 /* Make sure at least the first p2+1 entries of the header have been
2518 ** parsed and valid information is in aOffset[] and pC->aType[].
2520 if( pC->nHdrParsed<=p2 ){
2521 /* If there is more header available for parsing in the record, try
2522 ** to extract additional fields up through the p2+1-th field
2524 if( pC->iHdrOffset<aOffset[0] ){
2525 /* Make sure zData points to enough of the record to cover the header. */
2526 if( pC->aRow==0 ){
2527 memset(&sMem, 0, sizeof(sMem));
2528 rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, 0, aOffset[0], &sMem);
2529 if( rc!=SQLITE_OK ) goto abort_due_to_error;
2530 zData = (u8*)sMem.z;
2531 }else{
2532 zData = pC->aRow;
2535 /* Fill in pC->aType[i] and aOffset[i] values through the p2-th field. */
2536 op_column_read_header:
2537 i = pC->nHdrParsed;
2538 offset64 = aOffset[i];
2539 zHdr = zData + pC->iHdrOffset;
2540 zEndHdr = zData + aOffset[0];
2541 testcase( zHdr>=zEndHdr );
2543 if( (t = zHdr[0])<0x80 ){
2544 zHdr++;
2545 offset64 += sqlite3VdbeOneByteSerialTypeLen(t);
2546 }else{
2547 zHdr += sqlite3GetVarint32(zHdr, &t);
2548 offset64 += sqlite3VdbeSerialTypeLen(t);
2550 pC->aType[i++] = t;
2551 aOffset[i] = (u32)(offset64 & 0xffffffff);
2552 }while( i<=p2 && zHdr<zEndHdr );
2554 /* The record is corrupt if any of the following are true:
2555 ** (1) the bytes of the header extend past the declared header size
2556 ** (2) the entire header was used but not all data was used
2557 ** (3) the end of the data extends beyond the end of the record.
2559 if( (zHdr>=zEndHdr && (zHdr>zEndHdr || offset64!=pC->payloadSize))
2560 || (offset64 > pC->payloadSize)
2562 if( aOffset[0]==0 ){
2563 i = 0;
2564 zHdr = zEndHdr;
2565 }else{
2566 if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
2567 goto op_column_corrupt;
2571 pC->nHdrParsed = i;
2572 pC->iHdrOffset = (u32)(zHdr - zData);
2573 if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
2574 }else{
2575 t = 0;
2578 /* If after trying to extract new entries from the header, nHdrParsed is
2579 ** still not up to p2, that means that the record has fewer than p2
2580 ** columns. So the result will be either the default value or a NULL.
2582 if( pC->nHdrParsed<=p2 ){
2583 if( pOp->p4type==P4_MEM ){
2584 sqlite3VdbeMemShallowCopy(pDest, pOp->p4.pMem, MEM_Static);
2585 }else{
2586 sqlite3VdbeMemSetNull(pDest);
2588 goto op_column_out;
2590 }else{
2591 t = pC->aType[p2];
2594 /* Extract the content for the p2+1-th column. Control can only
2595 ** reach this point if aOffset[p2], aOffset[p2+1], and pC->aType[p2] are
2596 ** all valid.
2598 assert( p2<pC->nHdrParsed );
2599 assert( rc==SQLITE_OK );
2600 assert( sqlite3VdbeCheckMemInvariants(pDest) );
2601 if( VdbeMemDynamic(pDest) ){
2602 sqlite3VdbeMemSetNull(pDest);
2604 assert( t==pC->aType[p2] );
2605 if( pC->szRow>=aOffset[p2+1] ){
2606 /* This is the common case where the desired content fits on the original
2607 ** page - where the content is not on an overflow page */
2608 zData = pC->aRow + aOffset[p2];
2609 if( t<12 ){
2610 sqlite3VdbeSerialGet(zData, t, pDest);
2611 }else{
2612 /* If the column value is a string, we need a persistent value, not
2613 ** a MEM_Ephem value. This branch is a fast short-cut that is equivalent
2614 ** to calling sqlite3VdbeSerialGet() and sqlite3VdbeDeephemeralize().
2616 static const u16 aFlag[] = { MEM_Blob, MEM_Str|MEM_Term };
2617 pDest->n = len = (t-12)/2;
2618 pDest->enc = encoding;
2619 if( pDest->szMalloc < len+2 ){
2620 pDest->flags = MEM_Null;
2621 if( sqlite3VdbeMemGrow(pDest, len+2, 0) ) goto no_mem;
2622 }else{
2623 pDest->z = pDest->zMalloc;
2625 memcpy(pDest->z, zData, len);
2626 pDest->z[len] = 0;
2627 pDest->z[len+1] = 0;
2628 pDest->flags = aFlag[t&1];
2630 }else{
2631 pDest->enc = encoding;
2632 /* This branch happens only when content is on overflow pages */
2633 if( ((pOp->p5 & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG))!=0
2634 && ((t>=12 && (t&1)==0) || (pOp->p5 & OPFLAG_TYPEOFARG)!=0))
2635 || (len = sqlite3VdbeSerialTypeLen(t))==0
2637 /* Content is irrelevant for
2638 ** 1. the typeof() function,
2639 ** 2. the length(X) function if X is a blob, and
2640 ** 3. if the content length is zero.
2641 ** So we might as well use bogus content rather than reading
2642 ** content from disk.
2644 ** Although sqlite3VdbeSerialGet() may read at most 8 bytes from the
2645 ** buffer passed to it, debugging function VdbeMemPrettyPrint() may
2646 ** read up to 16. So 16 bytes of bogus content is supplied.
2648 static u8 aZero[16]; /* This is the bogus content */
2649 sqlite3VdbeSerialGet(aZero, t, pDest);
2650 }else{
2651 rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, aOffset[p2], len, pDest);
2652 if( rc!=SQLITE_OK ) goto abort_due_to_error;
2653 sqlite3VdbeSerialGet((const u8*)pDest->z, t, pDest);
2654 pDest->flags &= ~MEM_Ephem;
2658 op_column_out:
2659 UPDATE_MAX_BLOBSIZE(pDest);
2660 REGISTER_TRACE(pOp->p3, pDest);
2661 break;
2663 op_column_corrupt:
2664 if( aOp[0].p3>0 ){
2665 pOp = &aOp[aOp[0].p3-1];
2666 break;
2667 }else{
2668 rc = SQLITE_CORRUPT_BKPT;
2669 goto abort_due_to_error;
2673 /* Opcode: Affinity P1 P2 * P4 *
2674 ** Synopsis: affinity(r[P1@P2])
2676 ** Apply affinities to a range of P2 registers starting with P1.
2678 ** P4 is a string that is P2 characters long. The N-th character of the
2679 ** string indicates the column affinity that should be used for the N-th
2680 ** memory cell in the range.
2682 case OP_Affinity: {
2683 const char *zAffinity; /* The affinity to be applied */
2685 zAffinity = pOp->p4.z;
2686 assert( zAffinity!=0 );
2687 assert( pOp->p2>0 );
2688 assert( zAffinity[pOp->p2]==0 );
2689 pIn1 = &aMem[pOp->p1];
2691 assert( pIn1 <= &p->aMem[(p->nMem+1 - p->nCursor)] );
2692 assert( memIsValid(pIn1) );
2693 applyAffinity(pIn1, *(zAffinity++), encoding);
2694 pIn1++;
2695 }while( zAffinity[0] );
2696 break;
2699 /* Opcode: MakeRecord P1 P2 P3 P4 *
2700 ** Synopsis: r[P3]=mkrec(r[P1@P2])
2702 ** Convert P2 registers beginning with P1 into the [record format]
2703 ** use as a data record in a database table or as a key
2704 ** in an index. The OP_Column opcode can decode the record later.
2706 ** P4 may be a string that is P2 characters long. The N-th character of the
2707 ** string indicates the column affinity that should be used for the N-th
2708 ** field of the index key.
2710 ** The mapping from character to affinity is given by the SQLITE_AFF_
2711 ** macros defined in sqliteInt.h.
2713 ** If P4 is NULL then all index fields have the affinity BLOB.
2715 case OP_MakeRecord: {
2716 u8 *zNewRecord; /* A buffer to hold the data for the new record */
2717 Mem *pRec; /* The new record */
2718 u64 nData; /* Number of bytes of data space */
2719 int nHdr; /* Number of bytes of header space */
2720 i64 nByte; /* Data space required for this record */
2721 i64 nZero; /* Number of zero bytes at the end of the record */
2722 int nVarint; /* Number of bytes in a varint */
2723 u32 serial_type; /* Type field */
2724 Mem *pData0; /* First field to be combined into the record */
2725 Mem *pLast; /* Last field of the record */
2726 int nField; /* Number of fields in the record */
2727 char *zAffinity; /* The affinity string for the record */
2728 int file_format; /* File format to use for encoding */
2729 int i; /* Space used in zNewRecord[] header */
2730 int j; /* Space used in zNewRecord[] content */
2731 u32 len; /* Length of a field */
2733 /* Assuming the record contains N fields, the record format looks
2734 ** like this:
2736 ** ------------------------------------------------------------------------
2737 ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
2738 ** ------------------------------------------------------------------------
2740 ** Data(0) is taken from register P1. Data(1) comes from register P1+1
2741 ** and so forth.
2743 ** Each type field is a varint representing the serial type of the
2744 ** corresponding data element (see sqlite3VdbeSerialType()). The
2745 ** hdr-size field is also a varint which is the offset from the beginning
2746 ** of the record to data0.
2748 nData = 0; /* Number of bytes of data space */
2749 nHdr = 0; /* Number of bytes of header space */
2750 nZero = 0; /* Number of zero bytes at the end of the record */
2751 nField = pOp->p1;
2752 zAffinity = pOp->p4.z;
2753 assert( nField>0 && pOp->p2>0 && pOp->p2+nField<=(p->nMem+1 - p->nCursor)+1 );
2754 pData0 = &aMem[nField];
2755 nField = pOp->p2;
2756 pLast = &pData0[nField-1];
2757 file_format = p->minWriteFileFormat;
2759 /* Identify the output register */
2760 assert( pOp->p3<pOp->p1 || pOp->p3>=pOp->p1+pOp->p2 );
2761 pOut = &aMem[pOp->p3];
2762 memAboutToChange(p, pOut);
2764 /* Apply the requested affinity to all inputs
2766 assert( pData0<=pLast );
2767 if( zAffinity ){
2768 pRec = pData0;
2770 applyAffinity(pRec++, *(zAffinity++), encoding);
2771 assert( zAffinity[0]==0 || pRec<=pLast );
2772 }while( zAffinity[0] );
2775 #ifdef SQLITE_ENABLE_NULL_TRIM
2776 /* NULLs can be safely trimmed from the end of the record, as long as
2777 ** as the schema format is 2 or more and none of the omitted columns
2778 ** have a non-NULL default value. Also, the record must be left with
2779 ** at least one field. If P5>0 then it will be one more than the
2780 ** index of the right-most column with a non-NULL default value */
2781 if( pOp->p5 ){
2782 while( (pLast->flags & MEM_Null)!=0 && nField>pOp->p5 ){
2783 pLast--;
2784 nField--;
2787 #endif
2789 /* Loop through the elements that will make up the record to figure
2790 ** out how much space is required for the new record.
2792 pRec = pLast;
2794 assert( memIsValid(pRec) );
2795 pRec->uTemp = serial_type = sqlite3VdbeSerialType(pRec, file_format, &len);
2796 if( pRec->flags & MEM_Zero ){
2797 if( nData ){
2798 if( sqlite3VdbeMemExpandBlob(pRec) ) goto no_mem;
2799 }else{
2800 nZero += pRec->u.nZero;
2801 len -= pRec->u.nZero;
2804 nData += len;
2805 testcase( serial_type==127 );
2806 testcase( serial_type==128 );
2807 nHdr += serial_type<=127 ? 1 : sqlite3VarintLen(serial_type);
2808 if( pRec==pData0 ) break;
2809 pRec--;
2810 }while(1);
2812 /* EVIDENCE-OF: R-22564-11647 The header begins with a single varint
2813 ** which determines the total number of bytes in the header. The varint
2814 ** value is the size of the header in bytes including the size varint
2815 ** itself. */
2816 testcase( nHdr==126 );
2817 testcase( nHdr==127 );
2818 if( nHdr<=126 ){
2819 /* The common case */
2820 nHdr += 1;
2821 }else{
2822 /* Rare case of a really large header */
2823 nVarint = sqlite3VarintLen(nHdr);
2824 nHdr += nVarint;
2825 if( nVarint<sqlite3VarintLen(nHdr) ) nHdr++;
2827 nByte = nHdr+nData;
2828 if( nByte+nZero>db->aLimit[SQLITE_LIMIT_LENGTH] ){
2829 goto too_big;
2832 /* Make sure the output register has a buffer large enough to store
2833 ** the new record. The output register (pOp->p3) is not allowed to
2834 ** be one of the input registers (because the following call to
2835 ** sqlite3VdbeMemClearAndResize() could clobber the value before it is used).
2837 if( sqlite3VdbeMemClearAndResize(pOut, (int)nByte) ){
2838 goto no_mem;
2840 zNewRecord = (u8 *)pOut->z;
2842 /* Write the record */
2843 i = putVarint32(zNewRecord, nHdr);
2844 j = nHdr;
2845 assert( pData0<=pLast );
2846 pRec = pData0;
2848 serial_type = pRec->uTemp;
2849 /* EVIDENCE-OF: R-06529-47362 Following the size varint are one or more
2850 ** additional varints, one per column. */
2851 i += putVarint32(&zNewRecord[i], serial_type); /* serial type */
2852 /* EVIDENCE-OF: R-64536-51728 The values for each column in the record
2853 ** immediately follow the header. */
2854 j += sqlite3VdbeSerialPut(&zNewRecord[j], pRec, serial_type); /* content */
2855 }while( (++pRec)<=pLast );
2856 assert( i==nHdr );
2857 assert( j==nByte );
2859 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
2860 pOut->n = (int)nByte;
2861 pOut->flags = MEM_Blob;
2862 if( nZero ){
2863 pOut->u.nZero = nZero;
2864 pOut->flags |= MEM_Zero;
2866 REGISTER_TRACE(pOp->p3, pOut);
2867 UPDATE_MAX_BLOBSIZE(pOut);
2868 break;
2871 /* Opcode: Count P1 P2 * * *
2872 ** Synopsis: r[P2]=count()
2874 ** Store the number of entries (an integer value) in the table or index
2875 ** opened by cursor P1 in register P2
2877 #ifndef SQLITE_OMIT_BTREECOUNT
2878 case OP_Count: { /* out2 */
2879 i64 nEntry;
2880 BtCursor *pCrsr;
2882 assert( p->apCsr[pOp->p1]->eCurType==CURTYPE_BTREE );
2883 pCrsr = p->apCsr[pOp->p1]->uc.pCursor;
2884 assert( pCrsr );
2885 nEntry = 0; /* Not needed. Only used to silence a warning. */
2886 rc = sqlite3BtreeCount(pCrsr, &nEntry);
2887 if( rc ) goto abort_due_to_error;
2888 pOut = out2Prerelease(p, pOp);
2889 pOut->u.i = nEntry;
2890 break;
2892 #endif
2894 /* Opcode: Savepoint P1 * * P4 *
2896 ** Open, release or rollback the savepoint named by parameter P4, depending
2897 ** on the value of P1. To open a new savepoint, P1==0. To release (commit) an
2898 ** existing savepoint, P1==1, or to rollback an existing savepoint P1==2.
2900 case OP_Savepoint: {
2901 int p1; /* Value of P1 operand */
2902 char *zName; /* Name of savepoint */
2903 int nName;
2904 Savepoint *pNew;
2905 Savepoint *pSavepoint;
2906 Savepoint *pTmp;
2907 int iSavepoint;
2908 int ii;
2910 p1 = pOp->p1;
2911 zName = pOp->p4.z;
2913 /* Assert that the p1 parameter is valid. Also that if there is no open
2914 ** transaction, then there cannot be any savepoints.
2916 assert( db->pSavepoint==0 || db->autoCommit==0 );
2917 assert( p1==SAVEPOINT_BEGIN||p1==SAVEPOINT_RELEASE||p1==SAVEPOINT_ROLLBACK );
2918 assert( db->pSavepoint || db->isTransactionSavepoint==0 );
2919 assert( checkSavepointCount(db) );
2920 assert( p->bIsReader );
2922 if( p1==SAVEPOINT_BEGIN ){
2923 if( db->nVdbeWrite>0 ){
2924 /* A new savepoint cannot be created if there are active write
2925 ** statements (i.e. open read/write incremental blob handles).
2927 sqlite3VdbeError(p, "cannot open savepoint - SQL statements in progress");
2928 rc = SQLITE_BUSY;
2929 }else{
2930 nName = sqlite3Strlen30(zName);
2932 #ifndef SQLITE_OMIT_VIRTUALTABLE
2933 /* This call is Ok even if this savepoint is actually a transaction
2934 ** savepoint (and therefore should not prompt xSavepoint()) callbacks.
2935 ** If this is a transaction savepoint being opened, it is guaranteed
2936 ** that the db->aVTrans[] array is empty. */
2937 assert( db->autoCommit==0 || db->nVTrans==0 );
2938 rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN,
2939 db->nStatement+db->nSavepoint);
2940 if( rc!=SQLITE_OK ) goto abort_due_to_error;
2941 #endif
2943 /* Create a new savepoint structure. */
2944 pNew = sqlite3DbMallocRawNN(db, sizeof(Savepoint)+nName+1);
2945 if( pNew ){
2946 pNew->zName = (char *)&pNew[1];
2947 memcpy(pNew->zName, zName, nName+1);
2949 /* If there is no open transaction, then mark this as a special
2950 ** "transaction savepoint". */
2951 if( db->autoCommit ){
2952 db->autoCommit = 0;
2953 db->isTransactionSavepoint = 1;
2954 }else{
2955 db->nSavepoint++;
2958 /* Link the new savepoint into the database handle's list. */
2959 pNew->pNext = db->pSavepoint;
2960 db->pSavepoint = pNew;
2961 pNew->nDeferredCons = db->nDeferredCons;
2962 pNew->nDeferredImmCons = db->nDeferredImmCons;
2965 }else{
2966 iSavepoint = 0;
2968 /* Find the named savepoint. If there is no such savepoint, then an
2969 ** an error is returned to the user. */
2970 for(
2971 pSavepoint = db->pSavepoint;
2972 pSavepoint && sqlite3StrICmp(pSavepoint->zName, zName);
2973 pSavepoint = pSavepoint->pNext
2975 iSavepoint++;
2977 if( !pSavepoint ){
2978 sqlite3VdbeError(p, "no such savepoint: %s", zName);
2979 rc = SQLITE_ERROR;
2980 }else if( db->nVdbeWrite>0 && p1==SAVEPOINT_RELEASE ){
2981 /* It is not possible to release (commit) a savepoint if there are
2982 ** active write statements.
2984 sqlite3VdbeError(p, "cannot release savepoint - "
2985 "SQL statements in progress");
2986 rc = SQLITE_BUSY;
2987 }else{
2989 /* Determine whether or not this is a transaction savepoint. If so,
2990 ** and this is a RELEASE command, then the current transaction
2991 ** is committed.
2993 int isTransaction = pSavepoint->pNext==0 && db->isTransactionSavepoint;
2994 if( isTransaction && p1==SAVEPOINT_RELEASE ){
2995 if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
2996 goto vdbe_return;
2998 db->autoCommit = 1;
2999 if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
3000 p->pc = (int)(pOp - aOp);
3001 db->autoCommit = 0;
3002 p->rc = rc = SQLITE_BUSY;
3003 goto vdbe_return;
3005 db->isTransactionSavepoint = 0;
3006 rc = p->rc;
3007 }else{
3008 int isSchemaChange;
3009 iSavepoint = db->nSavepoint - iSavepoint - 1;
3010 if( p1==SAVEPOINT_ROLLBACK ){
3011 isSchemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0;
3012 for(ii=0; ii<db->nDb; ii++){
3013 rc = sqlite3BtreeTripAllCursors(db->aDb[ii].pBt,
3014 SQLITE_ABORT_ROLLBACK,
3015 isSchemaChange==0);
3016 if( rc!=SQLITE_OK ) goto abort_due_to_error;
3018 }else{
3019 isSchemaChange = 0;
3021 for(ii=0; ii<db->nDb; ii++){
3022 rc = sqlite3BtreeSavepoint(db->aDb[ii].pBt, p1, iSavepoint);
3023 if( rc!=SQLITE_OK ){
3024 goto abort_due_to_error;
3027 if( isSchemaChange ){
3028 sqlite3ExpirePreparedStatements(db);
3029 sqlite3ResetAllSchemasOfConnection(db);
3030 db->mDbFlags |= DBFLAG_SchemaChange;
3034 /* Regardless of whether this is a RELEASE or ROLLBACK, destroy all
3035 ** savepoints nested inside of the savepoint being operated on. */
3036 while( db->pSavepoint!=pSavepoint ){
3037 pTmp = db->pSavepoint;
3038 db->pSavepoint = pTmp->pNext;
3039 sqlite3DbFree(db, pTmp);
3040 db->nSavepoint--;
3043 /* If it is a RELEASE, then destroy the savepoint being operated on
3044 ** too. If it is a ROLLBACK TO, then set the number of deferred
3045 ** constraint violations present in the database to the value stored
3046 ** when the savepoint was created. */
3047 if( p1==SAVEPOINT_RELEASE ){
3048 assert( pSavepoint==db->pSavepoint );
3049 db->pSavepoint = pSavepoint->pNext;
3050 sqlite3DbFree(db, pSavepoint);
3051 if( !isTransaction ){
3052 db->nSavepoint--;
3054 }else{
3055 db->nDeferredCons = pSavepoint->nDeferredCons;
3056 db->nDeferredImmCons = pSavepoint->nDeferredImmCons;
3059 if( !isTransaction || p1==SAVEPOINT_ROLLBACK ){
3060 rc = sqlite3VtabSavepoint(db, p1, iSavepoint);
3061 if( rc!=SQLITE_OK ) goto abort_due_to_error;
3065 if( rc ) goto abort_due_to_error;
3067 break;
3070 /* Opcode: AutoCommit P1 P2 * * *
3072 ** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
3073 ** back any currently active btree transactions. If there are any active
3074 ** VMs (apart from this one), then a ROLLBACK fails. A COMMIT fails if
3075 ** there are active writing VMs or active VMs that use shared cache.
3077 ** This instruction causes the VM to halt.
3079 case OP_AutoCommit: {
3080 int desiredAutoCommit;
3081 int iRollback;
3083 desiredAutoCommit = pOp->p1;
3084 iRollback = pOp->p2;
3085 assert( desiredAutoCommit==1 || desiredAutoCommit==0 );
3086 assert( desiredAutoCommit==1 || iRollback==0 );
3087 assert( db->nVdbeActive>0 ); /* At least this one VM is active */
3088 assert( p->bIsReader );
3090 if( desiredAutoCommit!=db->autoCommit ){
3091 if( iRollback ){
3092 assert( desiredAutoCommit==1 );
3093 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
3094 db->autoCommit = 1;
3095 }else if( desiredAutoCommit && db->nVdbeWrite>0 ){
3096 /* If this instruction implements a COMMIT and other VMs are writing
3097 ** return an error indicating that the other VMs must complete first.
3099 sqlite3VdbeError(p, "cannot commit transaction - "
3100 "SQL statements in progress");
3101 rc = SQLITE_BUSY;
3102 goto abort_due_to_error;
3103 }else if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
3104 goto vdbe_return;
3105 }else{
3106 db->autoCommit = (u8)desiredAutoCommit;
3108 if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
3109 p->pc = (int)(pOp - aOp);
3110 db->autoCommit = (u8)(1-desiredAutoCommit);
3111 p->rc = rc = SQLITE_BUSY;
3112 goto vdbe_return;
3114 assert( db->nStatement==0 );
3115 sqlite3CloseSavepoints(db);
3116 if( p->rc==SQLITE_OK ){
3117 rc = SQLITE_DONE;
3118 }else{
3119 rc = SQLITE_ERROR;
3121 goto vdbe_return;
3122 }else{
3123 sqlite3VdbeError(p,
3124 (!desiredAutoCommit)?"cannot start a transaction within a transaction":(
3125 (iRollback)?"cannot rollback - no transaction is active":
3126 "cannot commit - no transaction is active"));
3128 rc = SQLITE_ERROR;
3129 goto abort_due_to_error;
3131 break;
3134 /* Opcode: Transaction P1 P2 P3 P4 P5
3136 ** Begin a transaction on database P1 if a transaction is not already
3137 ** active.
3138 ** If P2 is non-zero, then a write-transaction is started, or if a
3139 ** read-transaction is already active, it is upgraded to a write-transaction.
3140 ** If P2 is zero, then a read-transaction is started.
3142 ** P1 is the index of the database file on which the transaction is
3143 ** started. Index 0 is the main database file and index 1 is the
3144 ** file used for temporary tables. Indices of 2 or more are used for
3145 ** attached databases.
3147 ** If a write-transaction is started and the Vdbe.usesStmtJournal flag is
3148 ** true (this flag is set if the Vdbe may modify more than one row and may
3149 ** throw an ABORT exception), a statement transaction may also be opened.
3150 ** More specifically, a statement transaction is opened iff the database
3151 ** connection is currently not in autocommit mode, or if there are other
3152 ** active statements. A statement transaction allows the changes made by this
3153 ** VDBE to be rolled back after an error without having to roll back the
3154 ** entire transaction. If no error is encountered, the statement transaction
3155 ** will automatically commit when the VDBE halts.
3157 ** If P5!=0 then this opcode also checks the schema cookie against P3
3158 ** and the schema generation counter against P4.
3159 ** The cookie changes its value whenever the database schema changes.
3160 ** This operation is used to detect when that the cookie has changed
3161 ** and that the current process needs to reread the schema. If the schema
3162 ** cookie in P3 differs from the schema cookie in the database header or
3163 ** if the schema generation counter in P4 differs from the current
3164 ** generation counter, then an SQLITE_SCHEMA error is raised and execution
3165 ** halts. The sqlite3_step() wrapper function might then reprepare the
3166 ** statement and rerun it from the beginning.
3168 case OP_Transaction: {
3169 Btree *pBt;
3170 int iMeta;
3171 int iGen;
3173 assert( p->bIsReader );
3174 assert( p->readOnly==0 || pOp->p2==0 );
3175 assert( pOp->p1>=0 && pOp->p1<db->nDb );
3176 assert( DbMaskTest(p->btreeMask, pOp->p1) );
3177 if( pOp->p2 && (db->flags & SQLITE_QueryOnly)!=0 ){
3178 rc = SQLITE_READONLY;
3179 goto abort_due_to_error;
3181 pBt = db->aDb[pOp->p1].pBt;
3183 if( pBt ){
3184 rc = sqlite3BtreeBeginTrans(pBt, pOp->p2);
3185 testcase( rc==SQLITE_BUSY_SNAPSHOT );
3186 testcase( rc==SQLITE_BUSY_RECOVERY );
3187 if( rc!=SQLITE_OK ){
3188 if( (rc&0xff)==SQLITE_BUSY ){
3189 p->pc = (int)(pOp - aOp);
3190 p->rc = rc;
3191 goto vdbe_return;
3193 goto abort_due_to_error;
3196 if( pOp->p2 && p->usesStmtJournal
3197 && (db->autoCommit==0 || db->nVdbeRead>1)
3199 assert( sqlite3BtreeIsInTrans(pBt) );
3200 if( p->iStatement==0 ){
3201 assert( db->nStatement>=0 && db->nSavepoint>=0 );
3202 db->nStatement++;
3203 p->iStatement = db->nSavepoint + db->nStatement;
3206 rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN, p->iStatement-1);
3207 if( rc==SQLITE_OK ){
3208 rc = sqlite3BtreeBeginStmt(pBt, p->iStatement);
3211 /* Store the current value of the database handles deferred constraint
3212 ** counter. If the statement transaction needs to be rolled back,
3213 ** the value of this counter needs to be restored too. */
3214 p->nStmtDefCons = db->nDeferredCons;
3215 p->nStmtDefImmCons = db->nDeferredImmCons;
3218 /* Gather the schema version number for checking:
3219 ** IMPLEMENTATION-OF: R-03189-51135 As each SQL statement runs, the schema
3220 ** version is checked to ensure that the schema has not changed since the
3221 ** SQL statement was prepared.
3223 sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&iMeta);
3224 iGen = db->aDb[pOp->p1].pSchema->iGeneration;
3225 }else{
3226 iGen = iMeta = 0;
3228 assert( pOp->p5==0 || pOp->p4type==P4_INT32 );
3229 if( pOp->p5 && (iMeta!=pOp->p3 || iGen!=pOp->p4.i) ){
3230 sqlite3DbFree(db, p->zErrMsg);
3231 p->zErrMsg = sqlite3DbStrDup(db, "database schema has changed");
3232 /* If the schema-cookie from the database file matches the cookie
3233 ** stored with the in-memory representation of the schema, do
3234 ** not reload the schema from the database file.
3236 ** If virtual-tables are in use, this is not just an optimization.
3237 ** Often, v-tables store their data in other SQLite tables, which
3238 ** are queried from within xNext() and other v-table methods using
3239 ** prepared queries. If such a query is out-of-date, we do not want to
3240 ** discard the database schema, as the user code implementing the
3241 ** v-table would have to be ready for the sqlite3_vtab structure itself
3242 ** to be invalidated whenever sqlite3_step() is called from within
3243 ** a v-table method.
3245 if( db->aDb[pOp->p1].pSchema->schema_cookie!=iMeta ){
3246 sqlite3ResetOneSchema(db, pOp->p1);
3248 p->expired = 1;
3249 rc = SQLITE_SCHEMA;
3251 if( rc ) goto abort_due_to_error;
3252 break;
3255 /* Opcode: ReadCookie P1 P2 P3 * *
3257 ** Read cookie number P3 from database P1 and write it into register P2.
3258 ** P3==1 is the schema version. P3==2 is the database format.
3259 ** P3==3 is the recommended pager cache size, and so forth. P1==0 is
3260 ** the main database file and P1==1 is the database file used to store
3261 ** temporary tables.
3263 ** There must be a read-lock on the database (either a transaction
3264 ** must be started or there must be an open cursor) before
3265 ** executing this instruction.
3267 case OP_ReadCookie: { /* out2 */
3268 int iMeta;
3269 int iDb;
3270 int iCookie;
3272 assert( p->bIsReader );
3273 iDb = pOp->p1;
3274 iCookie = pOp->p3;
3275 assert( pOp->p3<SQLITE_N_BTREE_META );
3276 assert( iDb>=0 && iDb<db->nDb );
3277 assert( db->aDb[iDb].pBt!=0 );
3278 assert( DbMaskTest(p->btreeMask, iDb) );
3280 sqlite3BtreeGetMeta(db->aDb[iDb].pBt, iCookie, (u32 *)&iMeta);
3281 pOut = out2Prerelease(p, pOp);
3282 pOut->u.i = iMeta;
3283 break;
3286 /* Opcode: SetCookie P1 P2 P3 * *
3288 ** Write the integer value P3 into cookie number P2 of database P1.
3289 ** P2==1 is the schema version. P2==2 is the database format.
3290 ** P2==3 is the recommended pager cache
3291 ** size, and so forth. P1==0 is the main database file and P1==1 is the
3292 ** database file used to store temporary tables.
3294 ** A transaction must be started before executing this opcode.
3296 case OP_SetCookie: {
3297 Db *pDb;
3298 assert( pOp->p2<SQLITE_N_BTREE_META );
3299 assert( pOp->p1>=0 && pOp->p1<db->nDb );
3300 assert( DbMaskTest(p->btreeMask, pOp->p1) );
3301 assert( p->readOnly==0 );
3302 pDb = &db->aDb[pOp->p1];
3303 assert( pDb->pBt!=0 );
3304 assert( sqlite3SchemaMutexHeld(db, pOp->p1, 0) );
3305 /* See note about index shifting on OP_ReadCookie */
3306 rc = sqlite3BtreeUpdateMeta(pDb->pBt, pOp->p2, pOp->p3);
3307 if( pOp->p2==BTREE_SCHEMA_VERSION ){
3308 /* When the schema cookie changes, record the new cookie internally */
3309 pDb->pSchema->schema_cookie = pOp->p3;
3310 db->mDbFlags |= DBFLAG_SchemaChange;
3311 }else if( pOp->p2==BTREE_FILE_FORMAT ){
3312 /* Record changes in the file format */
3313 pDb->pSchema->file_format = pOp->p3;
3315 if( pOp->p1==1 ){
3316 /* Invalidate all prepared statements whenever the TEMP database
3317 ** schema is changed. Ticket #1644 */
3318 sqlite3ExpirePreparedStatements(db);
3319 p->expired = 0;
3321 if( rc ) goto abort_due_to_error;
3322 break;
3325 /* Opcode: OpenRead P1 P2 P3 P4 P5
3326 ** Synopsis: root=P2 iDb=P3
3328 ** Open a read-only cursor for the database table whose root page is
3329 ** P2 in a database file. The database file is determined by P3.
3330 ** P3==0 means the main database, P3==1 means the database used for
3331 ** temporary tables, and P3>1 means used the corresponding attached
3332 ** database. Give the new cursor an identifier of P1. The P1
3333 ** values need not be contiguous but all P1 values should be small integers.
3334 ** It is an error for P1 to be negative.
3336 ** If P5!=0 then use the content of register P2 as the root page, not
3337 ** the value of P2 itself.
3339 ** There will be a read lock on the database whenever there is an
3340 ** open cursor. If the database was unlocked prior to this instruction
3341 ** then a read lock is acquired as part of this instruction. A read
3342 ** lock allows other processes to read the database but prohibits
3343 ** any other process from modifying the database. The read lock is
3344 ** released when all cursors are closed. If this instruction attempts
3345 ** to get a read lock but fails, the script terminates with an
3346 ** SQLITE_BUSY error code.
3348 ** The P4 value may be either an integer (P4_INT32) or a pointer to
3349 ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3350 ** structure, then said structure defines the content and collating
3351 ** sequence of the index being opened. Otherwise, if P4 is an integer
3352 ** value, it is set to the number of columns in the table.
3354 ** See also: OpenWrite, ReopenIdx
3356 /* Opcode: ReopenIdx P1 P2 P3 P4 P5
3357 ** Synopsis: root=P2 iDb=P3
3359 ** The ReopenIdx opcode works exactly like ReadOpen except that it first
3360 ** checks to see if the cursor on P1 is already open with a root page
3361 ** number of P2 and if it is this opcode becomes a no-op. In other words,
3362 ** if the cursor is already open, do not reopen it.
3364 ** The ReopenIdx opcode may only be used with P5==0 and with P4 being
3365 ** a P4_KEYINFO object. Furthermore, the P3 value must be the same as
3366 ** every other ReopenIdx or OpenRead for the same cursor number.
3368 ** See the OpenRead opcode documentation for additional information.
3370 /* Opcode: OpenWrite P1 P2 P3 P4 P5
3371 ** Synopsis: root=P2 iDb=P3
3373 ** Open a read/write cursor named P1 on the table or index whose root
3374 ** page is P2. Or if P5!=0 use the content of register P2 to find the
3375 ** root page.
3377 ** The P4 value may be either an integer (P4_INT32) or a pointer to
3378 ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3379 ** structure, then said structure defines the content and collating
3380 ** sequence of the index being opened. Otherwise, if P4 is an integer
3381 ** value, it is set to the number of columns in the table, or to the
3382 ** largest index of any column of the table that is actually used.
3384 ** This instruction works just like OpenRead except that it opens the cursor
3385 ** in read/write mode. For a given table, there can be one or more read-only
3386 ** cursors or a single read/write cursor but not both.
3388 ** See also OpenRead.
3390 case OP_ReopenIdx: {
3391 int nField;
3392 KeyInfo *pKeyInfo;
3393 int p2;
3394 int iDb;
3395 int wrFlag;
3396 Btree *pX;
3397 VdbeCursor *pCur;
3398 Db *pDb;
3400 assert( pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
3401 assert( pOp->p4type==P4_KEYINFO );
3402 pCur = p->apCsr[pOp->p1];
3403 if( pCur && pCur->pgnoRoot==(u32)pOp->p2 ){
3404 assert( pCur->iDb==pOp->p3 ); /* Guaranteed by the code generator */
3405 goto open_cursor_set_hints;
3407 /* If the cursor is not currently open or is open on a different
3408 ** index, then fall through into OP_OpenRead to force a reopen */
3409 case OP_OpenRead:
3410 case OP_OpenWrite:
3412 assert( pOp->opcode==OP_OpenWrite || pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
3413 assert( p->bIsReader );
3414 assert( pOp->opcode==OP_OpenRead || pOp->opcode==OP_ReopenIdx
3415 || p->readOnly==0 );
3417 if( p->expired ){
3418 rc = SQLITE_ABORT_ROLLBACK;
3419 goto abort_due_to_error;
3422 nField = 0;
3423 pKeyInfo = 0;
3424 p2 = pOp->p2;
3425 iDb = pOp->p3;
3426 assert( iDb>=0 && iDb<db->nDb );
3427 assert( DbMaskTest(p->btreeMask, iDb) );
3428 pDb = &db->aDb[iDb];
3429 pX = pDb->pBt;
3430 assert( pX!=0 );
3431 if( pOp->opcode==OP_OpenWrite ){
3432 assert( OPFLAG_FORDELETE==BTREE_FORDELETE );
3433 wrFlag = BTREE_WRCSR | (pOp->p5 & OPFLAG_FORDELETE);
3434 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
3435 if( pDb->pSchema->file_format < p->minWriteFileFormat ){
3436 p->minWriteFileFormat = pDb->pSchema->file_format;
3438 }else{
3439 wrFlag = 0;
3441 if( pOp->p5 & OPFLAG_P2ISREG ){
3442 assert( p2>0 );
3443 assert( p2<=(p->nMem+1 - p->nCursor) );
3444 pIn2 = &aMem[p2];
3445 assert( memIsValid(pIn2) );
3446 assert( (pIn2->flags & MEM_Int)!=0 );
3447 sqlite3VdbeMemIntegerify(pIn2);
3448 p2 = (int)pIn2->u.i;
3449 /* The p2 value always comes from a prior OP_CreateBtree opcode and
3450 ** that opcode will always set the p2 value to 2 or more or else fail.
3451 ** If there were a failure, the prepared statement would have halted
3452 ** before reaching this instruction. */
3453 assert( p2>=2 );
3455 if( pOp->p4type==P4_KEYINFO ){
3456 pKeyInfo = pOp->p4.pKeyInfo;
3457 assert( pKeyInfo->enc==ENC(db) );
3458 assert( pKeyInfo->db==db );
3459 nField = pKeyInfo->nAllField;
3460 }else if( pOp->p4type==P4_INT32 ){
3461 nField = pOp->p4.i;
3463 assert( pOp->p1>=0 );
3464 assert( nField>=0 );
3465 testcase( nField==0 ); /* Table with INTEGER PRIMARY KEY and nothing else */
3466 pCur = allocateCursor(p, pOp->p1, nField, iDb, CURTYPE_BTREE);
3467 if( pCur==0 ) goto no_mem;
3468 pCur->nullRow = 1;
3469 pCur->isOrdered = 1;
3470 pCur->pgnoRoot = p2;
3471 #ifdef SQLITE_DEBUG
3472 pCur->wrFlag = wrFlag;
3473 #endif
3474 rc = sqlite3BtreeCursor(pX, p2, wrFlag, pKeyInfo, pCur->uc.pCursor);
3475 pCur->pKeyInfo = pKeyInfo;
3476 /* Set the VdbeCursor.isTable variable. Previous versions of
3477 ** SQLite used to check if the root-page flags were sane at this point
3478 ** and report database corruption if they were not, but this check has
3479 ** since moved into the btree layer. */
3480 pCur->isTable = pOp->p4type!=P4_KEYINFO;
3482 open_cursor_set_hints:
3483 assert( OPFLAG_BULKCSR==BTREE_BULKLOAD );
3484 assert( OPFLAG_SEEKEQ==BTREE_SEEK_EQ );
3485 testcase( pOp->p5 & OPFLAG_BULKCSR );
3486 #ifdef SQLITE_ENABLE_CURSOR_HINTS
3487 testcase( pOp->p2 & OPFLAG_SEEKEQ );
3488 #endif
3489 sqlite3BtreeCursorHintFlags(pCur->uc.pCursor,
3490 (pOp->p5 & (OPFLAG_BULKCSR|OPFLAG_SEEKEQ)));
3491 if( rc ) goto abort_due_to_error;
3492 break;
3495 /* Opcode: OpenDup P1 P2 * * *
3497 ** Open a new cursor P1 that points to the same ephemeral table as
3498 ** cursor P2. The P2 cursor must have been opened by a prior OP_OpenEphemeral
3499 ** opcode. Only ephemeral cursors may be duplicated.
3501 ** Duplicate ephemeral cursors are used for self-joins of materialized views.
3503 case OP_OpenDup: {
3504 VdbeCursor *pOrig; /* The original cursor to be duplicated */
3505 VdbeCursor *pCx; /* The new cursor */
3507 pOrig = p->apCsr[pOp->p2];
3508 assert( pOrig->pBtx!=0 ); /* Only ephemeral cursors can be duplicated */
3510 pCx = allocateCursor(p, pOp->p1, pOrig->nField, -1, CURTYPE_BTREE);
3511 if( pCx==0 ) goto no_mem;
3512 pCx->nullRow = 1;
3513 pCx->isEphemeral = 1;
3514 pCx->pKeyInfo = pOrig->pKeyInfo;
3515 pCx->isTable = pOrig->isTable;
3516 rc = sqlite3BtreeCursor(pOrig->pBtx, MASTER_ROOT, BTREE_WRCSR,
3517 pCx->pKeyInfo, pCx->uc.pCursor);
3518 /* The sqlite3BtreeCursor() routine can only fail for the first cursor
3519 ** opened for a database. Since there is already an open cursor when this
3520 ** opcode is run, the sqlite3BtreeCursor() cannot fail */
3521 assert( rc==SQLITE_OK );
3522 break;
3526 /* Opcode: OpenEphemeral P1 P2 * P4 P5
3527 ** Synopsis: nColumn=P2
3529 ** Open a new cursor P1 to a transient table.
3530 ** The cursor is always opened read/write even if
3531 ** the main database is read-only. The ephemeral
3532 ** table is deleted automatically when the cursor is closed.
3534 ** P2 is the number of columns in the ephemeral table.
3535 ** The cursor points to a BTree table if P4==0 and to a BTree index
3536 ** if P4 is not 0. If P4 is not NULL, it points to a KeyInfo structure
3537 ** that defines the format of keys in the index.
3539 ** The P5 parameter can be a mask of the BTREE_* flags defined
3540 ** in btree.h. These flags control aspects of the operation of
3541 ** the btree. The BTREE_OMIT_JOURNAL and BTREE_SINGLE flags are
3542 ** added automatically.
3544 /* Opcode: OpenAutoindex P1 P2 * P4 *
3545 ** Synopsis: nColumn=P2
3547 ** This opcode works the same as OP_OpenEphemeral. It has a
3548 ** different name to distinguish its use. Tables created using
3549 ** by this opcode will be used for automatically created transient
3550 ** indices in joins.
3552 case OP_OpenAutoindex:
3553 case OP_OpenEphemeral: {
3554 VdbeCursor *pCx;
3555 KeyInfo *pKeyInfo;
3557 static const int vfsFlags =
3558 SQLITE_OPEN_READWRITE |
3559 SQLITE_OPEN_CREATE |
3560 SQLITE_OPEN_EXCLUSIVE |
3561 SQLITE_OPEN_DELETEONCLOSE |
3562 SQLITE_OPEN_TRANSIENT_DB;
3563 assert( pOp->p1>=0 );
3564 assert( pOp->p2>=0 );
3565 pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_BTREE);
3566 if( pCx==0 ) goto no_mem;
3567 pCx->nullRow = 1;
3568 pCx->isEphemeral = 1;
3569 rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pCx->pBtx,
3570 BTREE_OMIT_JOURNAL | BTREE_SINGLE | pOp->p5, vfsFlags);
3571 if( rc==SQLITE_OK ){
3572 rc = sqlite3BtreeBeginTrans(pCx->pBtx, 1);
3574 if( rc==SQLITE_OK ){
3575 /* If a transient index is required, create it by calling
3576 ** sqlite3BtreeCreateTable() with the BTREE_BLOBKEY flag before
3577 ** opening it. If a transient table is required, just use the
3578 ** automatically created table with root-page 1 (an BLOB_INTKEY table).
3580 if( (pCx->pKeyInfo = pKeyInfo = pOp->p4.pKeyInfo)!=0 ){
3581 int pgno;
3582 assert( pOp->p4type==P4_KEYINFO );
3583 rc = sqlite3BtreeCreateTable(pCx->pBtx, &pgno, BTREE_BLOBKEY | pOp->p5);
3584 if( rc==SQLITE_OK ){
3585 assert( pgno==MASTER_ROOT+1 );
3586 assert( pKeyInfo->db==db );
3587 assert( pKeyInfo->enc==ENC(db) );
3588 rc = sqlite3BtreeCursor(pCx->pBtx, pgno, BTREE_WRCSR,
3589 pKeyInfo, pCx->uc.pCursor);
3591 pCx->isTable = 0;
3592 }else{
3593 rc = sqlite3BtreeCursor(pCx->pBtx, MASTER_ROOT, BTREE_WRCSR,
3594 0, pCx->uc.pCursor);
3595 pCx->isTable = 1;
3598 if( rc ) goto abort_due_to_error;
3599 pCx->isOrdered = (pOp->p5!=BTREE_UNORDERED);
3600 break;
3603 /* Opcode: SorterOpen P1 P2 P3 P4 *
3605 ** This opcode works like OP_OpenEphemeral except that it opens
3606 ** a transient index that is specifically designed to sort large
3607 ** tables using an external merge-sort algorithm.
3609 ** If argument P3 is non-zero, then it indicates that the sorter may
3610 ** assume that a stable sort considering the first P3 fields of each
3611 ** key is sufficient to produce the required results.
3613 case OP_SorterOpen: {
3614 VdbeCursor *pCx;
3616 assert( pOp->p1>=0 );
3617 assert( pOp->p2>=0 );
3618 pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_SORTER);
3619 if( pCx==0 ) goto no_mem;
3620 pCx->pKeyInfo = pOp->p4.pKeyInfo;
3621 assert( pCx->pKeyInfo->db==db );
3622 assert( pCx->pKeyInfo->enc==ENC(db) );
3623 rc = sqlite3VdbeSorterInit(db, pOp->p3, pCx);
3624 if( rc ) goto abort_due_to_error;
3625 break;
3628 /* Opcode: SequenceTest P1 P2 * * *
3629 ** Synopsis: if( cursor[P1].ctr++ ) pc = P2
3631 ** P1 is a sorter cursor. If the sequence counter is currently zero, jump
3632 ** to P2. Regardless of whether or not the jump is taken, increment the
3633 ** the sequence value.
3635 case OP_SequenceTest: {
3636 VdbeCursor *pC;
3637 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3638 pC = p->apCsr[pOp->p1];
3639 assert( isSorter(pC) );
3640 if( (pC->seqCount++)==0 ){
3641 goto jump_to_p2;
3643 break;
3646 /* Opcode: OpenPseudo P1 P2 P3 * *
3647 ** Synopsis: P3 columns in r[P2]
3649 ** Open a new cursor that points to a fake table that contains a single
3650 ** row of data. The content of that one row is the content of memory
3651 ** register P2. In other words, cursor P1 becomes an alias for the
3652 ** MEM_Blob content contained in register P2.
3654 ** A pseudo-table created by this opcode is used to hold a single
3655 ** row output from the sorter so that the row can be decomposed into
3656 ** individual columns using the OP_Column opcode. The OP_Column opcode
3657 ** is the only cursor opcode that works with a pseudo-table.
3659 ** P3 is the number of fields in the records that will be stored by
3660 ** the pseudo-table.
3662 case OP_OpenPseudo: {
3663 VdbeCursor *pCx;
3665 assert( pOp->p1>=0 );
3666 assert( pOp->p3>=0 );
3667 pCx = allocateCursor(p, pOp->p1, pOp->p3, -1, CURTYPE_PSEUDO);
3668 if( pCx==0 ) goto no_mem;
3669 pCx->nullRow = 1;
3670 pCx->seekResult = pOp->p2;
3671 pCx->isTable = 1;
3672 /* Give this pseudo-cursor a fake BtCursor pointer so that pCx
3673 ** can be safely passed to sqlite3VdbeCursorMoveto(). This avoids a test
3674 ** for pCx->eCurType==CURTYPE_BTREE inside of sqlite3VdbeCursorMoveto()
3675 ** which is a performance optimization */
3676 pCx->uc.pCursor = sqlite3BtreeFakeValidCursor();
3677 assert( pOp->p5==0 );
3678 break;
3681 /* Opcode: Close P1 * * * *
3683 ** Close a cursor previously opened as P1. If P1 is not
3684 ** currently open, this instruction is a no-op.
3686 case OP_Close: {
3687 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3688 sqlite3VdbeFreeCursor(p, p->apCsr[pOp->p1]);
3689 p->apCsr[pOp->p1] = 0;
3690 break;
3693 #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
3694 /* Opcode: ColumnsUsed P1 * * P4 *
3696 ** This opcode (which only exists if SQLite was compiled with
3697 ** SQLITE_ENABLE_COLUMN_USED_MASK) identifies which columns of the
3698 ** table or index for cursor P1 are used. P4 is a 64-bit integer
3699 ** (P4_INT64) in which the first 63 bits are one for each of the
3700 ** first 63 columns of the table or index that are actually used
3701 ** by the cursor. The high-order bit is set if any column after
3702 ** the 64th is used.
3704 case OP_ColumnsUsed: {
3705 VdbeCursor *pC;
3706 pC = p->apCsr[pOp->p1];
3707 assert( pC->eCurType==CURTYPE_BTREE );
3708 pC->maskUsed = *(u64*)pOp->p4.pI64;
3709 break;
3711 #endif
3713 /* Opcode: SeekGE P1 P2 P3 P4 *
3714 ** Synopsis: key=r[P3@P4]
3716 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3717 ** use the value in register P3 as the key. If cursor P1 refers
3718 ** to an SQL index, then P3 is the first in an array of P4 registers
3719 ** that are used as an unpacked index key.
3721 ** Reposition cursor P1 so that it points to the smallest entry that
3722 ** is greater than or equal to the key value. If there are no records
3723 ** greater than or equal to the key and P2 is not zero, then jump to P2.
3725 ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3726 ** opcode will always land on a record that equally equals the key, or
3727 ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3728 ** opcode must be followed by an IdxLE opcode with the same arguments.
3729 ** The IdxLE opcode will be skipped if this opcode succeeds, but the
3730 ** IdxLE opcode will be used on subsequent loop iterations.
3732 ** This opcode leaves the cursor configured to move in forward order,
3733 ** from the beginning toward the end. In other words, the cursor is
3734 ** configured to use Next, not Prev.
3736 ** See also: Found, NotFound, SeekLt, SeekGt, SeekLe
3738 /* Opcode: SeekGT P1 P2 P3 P4 *
3739 ** Synopsis: key=r[P3@P4]
3741 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3742 ** use the value in register P3 as a key. If cursor P1 refers
3743 ** to an SQL index, then P3 is the first in an array of P4 registers
3744 ** that are used as an unpacked index key.
3746 ** Reposition cursor P1 so that it points to the smallest entry that
3747 ** is greater than the key value. If there are no records greater than
3748 ** the key and P2 is not zero, then jump to P2.
3750 ** This opcode leaves the cursor configured to move in forward order,
3751 ** from the beginning toward the end. In other words, the cursor is
3752 ** configured to use Next, not Prev.
3754 ** See also: Found, NotFound, SeekLt, SeekGe, SeekLe
3756 /* Opcode: SeekLT P1 P2 P3 P4 *
3757 ** Synopsis: key=r[P3@P4]
3759 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3760 ** use the value in register P3 as a key. If cursor P1 refers
3761 ** to an SQL index, then P3 is the first in an array of P4 registers
3762 ** that are used as an unpacked index key.
3764 ** Reposition cursor P1 so that it points to the largest entry that
3765 ** is less than the key value. If there are no records less than
3766 ** the key and P2 is not zero, then jump to P2.
3768 ** This opcode leaves the cursor configured to move in reverse order,
3769 ** from the end toward the beginning. In other words, the cursor is
3770 ** configured to use Prev, not Next.
3772 ** See also: Found, NotFound, SeekGt, SeekGe, SeekLe
3774 /* Opcode: SeekLE P1 P2 P3 P4 *
3775 ** Synopsis: key=r[P3@P4]
3777 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3778 ** use the value in register P3 as a key. If cursor P1 refers
3779 ** to an SQL index, then P3 is the first in an array of P4 registers
3780 ** that are used as an unpacked index key.
3782 ** Reposition cursor P1 so that it points to the largest entry that
3783 ** is less than or equal to the key value. If there are no records
3784 ** less than or equal to the key and P2 is not zero, then jump to P2.
3786 ** This opcode leaves the cursor configured to move in reverse order,
3787 ** from the end toward the beginning. In other words, the cursor is
3788 ** configured to use Prev, not Next.
3790 ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3791 ** opcode will always land on a record that equally equals the key, or
3792 ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3793 ** opcode must be followed by an IdxGE opcode with the same arguments.
3794 ** The IdxGE opcode will be skipped if this opcode succeeds, but the
3795 ** IdxGE opcode will be used on subsequent loop iterations.
3797 ** See also: Found, NotFound, SeekGt, SeekGe, SeekLt
3799 case OP_SeekLT: /* jump, in3 */
3800 case OP_SeekLE: /* jump, in3 */
3801 case OP_SeekGE: /* jump, in3 */
3802 case OP_SeekGT: { /* jump, in3 */
3803 int res; /* Comparison result */
3804 int oc; /* Opcode */
3805 VdbeCursor *pC; /* The cursor to seek */
3806 UnpackedRecord r; /* The key to seek for */
3807 int nField; /* Number of columns or fields in the key */
3808 i64 iKey; /* The rowid we are to seek to */
3809 int eqOnly; /* Only interested in == results */
3811 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3812 assert( pOp->p2!=0 );
3813 pC = p->apCsr[pOp->p1];
3814 assert( pC!=0 );
3815 assert( pC->eCurType==CURTYPE_BTREE );
3816 assert( OP_SeekLE == OP_SeekLT+1 );
3817 assert( OP_SeekGE == OP_SeekLT+2 );
3818 assert( OP_SeekGT == OP_SeekLT+3 );
3819 assert( pC->isOrdered );
3820 assert( pC->uc.pCursor!=0 );
3821 oc = pOp->opcode;
3822 eqOnly = 0;
3823 pC->nullRow = 0;
3824 #ifdef SQLITE_DEBUG
3825 pC->seekOp = pOp->opcode;
3826 #endif
3828 if( pC->isTable ){
3829 /* The BTREE_SEEK_EQ flag is only set on index cursors */
3830 assert( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ)==0
3831 || CORRUPT_DB );
3833 /* The input value in P3 might be of any type: integer, real, string,
3834 ** blob, or NULL. But it needs to be an integer before we can do
3835 ** the seek, so convert it. */
3836 pIn3 = &aMem[pOp->p3];
3837 if( (pIn3->flags & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
3838 applyNumericAffinity(pIn3, 0);
3840 iKey = sqlite3VdbeIntValue(pIn3);
3842 /* If the P3 value could not be converted into an integer without
3843 ** loss of information, then special processing is required... */
3844 if( (pIn3->flags & MEM_Int)==0 ){
3845 if( (pIn3->flags & MEM_Real)==0 ){
3846 /* If the P3 value cannot be converted into any kind of a number,
3847 ** then the seek is not possible, so jump to P2 */
3848 VdbeBranchTaken(1,2); goto jump_to_p2;
3849 break;
3852 /* If the approximation iKey is larger than the actual real search
3853 ** term, substitute >= for > and < for <=. e.g. if the search term
3854 ** is 4.9 and the integer approximation 5:
3856 ** (x > 4.9) -> (x >= 5)
3857 ** (x <= 4.9) -> (x < 5)
3859 if( pIn3->u.r<(double)iKey ){
3860 assert( OP_SeekGE==(OP_SeekGT-1) );
3861 assert( OP_SeekLT==(OP_SeekLE-1) );
3862 assert( (OP_SeekLE & 0x0001)==(OP_SeekGT & 0x0001) );
3863 if( (oc & 0x0001)==(OP_SeekGT & 0x0001) ) oc--;
3866 /* If the approximation iKey is smaller than the actual real search
3867 ** term, substitute <= for < and > for >=. */
3868 else if( pIn3->u.r>(double)iKey ){
3869 assert( OP_SeekLE==(OP_SeekLT+1) );
3870 assert( OP_SeekGT==(OP_SeekGE+1) );
3871 assert( (OP_SeekLT & 0x0001)==(OP_SeekGE & 0x0001) );
3872 if( (oc & 0x0001)==(OP_SeekLT & 0x0001) ) oc++;
3875 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)iKey, 0, &res);
3876 pC->movetoTarget = iKey; /* Used by OP_Delete */
3877 if( rc!=SQLITE_OK ){
3878 goto abort_due_to_error;
3880 }else{
3881 /* For a cursor with the BTREE_SEEK_EQ hint, only the OP_SeekGE and
3882 ** OP_SeekLE opcodes are allowed, and these must be immediately followed
3883 ** by an OP_IdxGT or OP_IdxLT opcode, respectively, with the same key.
3885 if( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ) ){
3886 eqOnly = 1;
3887 assert( pOp->opcode==OP_SeekGE || pOp->opcode==OP_SeekLE );
3888 assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
3889 assert( pOp[1].p1==pOp[0].p1 );
3890 assert( pOp[1].p2==pOp[0].p2 );
3891 assert( pOp[1].p3==pOp[0].p3 );
3892 assert( pOp[1].p4.i==pOp[0].p4.i );
3895 nField = pOp->p4.i;
3896 assert( pOp->p4type==P4_INT32 );
3897 assert( nField>0 );
3898 r.pKeyInfo = pC->pKeyInfo;
3899 r.nField = (u16)nField;
3901 /* The next line of code computes as follows, only faster:
3902 ** if( oc==OP_SeekGT || oc==OP_SeekLE ){
3903 ** r.default_rc = -1;
3904 ** }else{
3905 ** r.default_rc = +1;
3906 ** }
3908 r.default_rc = ((1 & (oc - OP_SeekLT)) ? -1 : +1);
3909 assert( oc!=OP_SeekGT || r.default_rc==-1 );
3910 assert( oc!=OP_SeekLE || r.default_rc==-1 );
3911 assert( oc!=OP_SeekGE || r.default_rc==+1 );
3912 assert( oc!=OP_SeekLT || r.default_rc==+1 );
3914 r.aMem = &aMem[pOp->p3];
3915 #ifdef SQLITE_DEBUG
3916 { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
3917 #endif
3918 r.eqSeen = 0;
3919 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, &r, 0, 0, &res);
3920 if( rc!=SQLITE_OK ){
3921 goto abort_due_to_error;
3923 if( eqOnly && r.eqSeen==0 ){
3924 assert( res!=0 );
3925 goto seek_not_found;
3928 pC->deferredMoveto = 0;
3929 pC->cacheStatus = CACHE_STALE;
3930 #ifdef SQLITE_TEST
3931 sqlite3_search_count++;
3932 #endif
3933 if( oc>=OP_SeekGE ){ assert( oc==OP_SeekGE || oc==OP_SeekGT );
3934 if( res<0 || (res==0 && oc==OP_SeekGT) ){
3935 res = 0;
3936 rc = sqlite3BtreeNext(pC->uc.pCursor, 0);
3937 if( rc!=SQLITE_OK ){
3938 if( rc==SQLITE_DONE ){
3939 rc = SQLITE_OK;
3940 res = 1;
3941 }else{
3942 goto abort_due_to_error;
3945 }else{
3946 res = 0;
3948 }else{
3949 assert( oc==OP_SeekLT || oc==OP_SeekLE );
3950 if( res>0 || (res==0 && oc==OP_SeekLT) ){
3951 res = 0;
3952 rc = sqlite3BtreePrevious(pC->uc.pCursor, 0);
3953 if( rc!=SQLITE_OK ){
3954 if( rc==SQLITE_DONE ){
3955 rc = SQLITE_OK;
3956 res = 1;
3957 }else{
3958 goto abort_due_to_error;
3961 }else{
3962 /* res might be negative because the table is empty. Check to
3963 ** see if this is the case.
3965 res = sqlite3BtreeEof(pC->uc.pCursor);
3968 seek_not_found:
3969 assert( pOp->p2>0 );
3970 VdbeBranchTaken(res!=0,2);
3971 if( res ){
3972 goto jump_to_p2;
3973 }else if( eqOnly ){
3974 assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
3975 pOp++; /* Skip the OP_IdxLt or OP_IdxGT that follows */
3977 break;
3980 /* Opcode: Found P1 P2 P3 P4 *
3981 ** Synopsis: key=r[P3@P4]
3983 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
3984 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
3985 ** record.
3987 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
3988 ** is a prefix of any entry in P1 then a jump is made to P2 and
3989 ** P1 is left pointing at the matching entry.
3991 ** This operation leaves the cursor in a state where it can be
3992 ** advanced in the forward direction. The Next instruction will work,
3993 ** but not the Prev instruction.
3995 ** See also: NotFound, NoConflict, NotExists. SeekGe
3997 /* Opcode: NotFound P1 P2 P3 P4 *
3998 ** Synopsis: key=r[P3@P4]
4000 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4001 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
4002 ** record.
4004 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
4005 ** is not the prefix of any entry in P1 then a jump is made to P2. If P1
4006 ** does contain an entry whose prefix matches the P3/P4 record then control
4007 ** falls through to the next instruction and P1 is left pointing at the
4008 ** matching entry.
4010 ** This operation leaves the cursor in a state where it cannot be
4011 ** advanced in either direction. In other words, the Next and Prev
4012 ** opcodes do not work after this operation.
4014 ** See also: Found, NotExists, NoConflict
4016 /* Opcode: NoConflict P1 P2 P3 P4 *
4017 ** Synopsis: key=r[P3@P4]
4019 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4020 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
4021 ** record.
4023 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
4024 ** contains any NULL value, jump immediately to P2. If all terms of the
4025 ** record are not-NULL then a check is done to determine if any row in the
4026 ** P1 index btree has a matching key prefix. If there are no matches, jump
4027 ** immediately to P2. If there is a match, fall through and leave the P1
4028 ** cursor pointing to the matching row.
4030 ** This opcode is similar to OP_NotFound with the exceptions that the
4031 ** branch is always taken if any part of the search key input is NULL.
4033 ** This operation leaves the cursor in a state where it cannot be
4034 ** advanced in either direction. In other words, the Next and Prev
4035 ** opcodes do not work after this operation.
4037 ** See also: NotFound, Found, NotExists
4039 case OP_NoConflict: /* jump, in3 */
4040 case OP_NotFound: /* jump, in3 */
4041 case OP_Found: { /* jump, in3 */
4042 int alreadyExists;
4043 int takeJump;
4044 int ii;
4045 VdbeCursor *pC;
4046 int res;
4047 UnpackedRecord *pFree;
4048 UnpackedRecord *pIdxKey;
4049 UnpackedRecord r;
4051 #ifdef SQLITE_TEST
4052 if( pOp->opcode!=OP_NoConflict ) sqlite3_found_count++;
4053 #endif
4055 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4056 assert( pOp->p4type==P4_INT32 );
4057 pC = p->apCsr[pOp->p1];
4058 assert( pC!=0 );
4059 #ifdef SQLITE_DEBUG
4060 pC->seekOp = pOp->opcode;
4061 #endif
4062 pIn3 = &aMem[pOp->p3];
4063 assert( pC->eCurType==CURTYPE_BTREE );
4064 assert( pC->uc.pCursor!=0 );
4065 assert( pC->isTable==0 );
4066 if( pOp->p4.i>0 ){
4067 r.pKeyInfo = pC->pKeyInfo;
4068 r.nField = (u16)pOp->p4.i;
4069 r.aMem = pIn3;
4070 #ifdef SQLITE_DEBUG
4071 for(ii=0; ii<r.nField; ii++){
4072 assert( memIsValid(&r.aMem[ii]) );
4073 assert( (r.aMem[ii].flags & MEM_Zero)==0 || r.aMem[ii].n==0 );
4074 if( ii ) REGISTER_TRACE(pOp->p3+ii, &r.aMem[ii]);
4076 #endif
4077 pIdxKey = &r;
4078 pFree = 0;
4079 }else{
4080 assert( pIn3->flags & MEM_Blob );
4081 rc = ExpandBlob(pIn3);
4082 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
4083 if( rc ) goto no_mem;
4084 pFree = pIdxKey = sqlite3VdbeAllocUnpackedRecord(pC->pKeyInfo);
4085 if( pIdxKey==0 ) goto no_mem;
4086 sqlite3VdbeRecordUnpack(pC->pKeyInfo, pIn3->n, pIn3->z, pIdxKey);
4088 pIdxKey->default_rc = 0;
4089 takeJump = 0;
4090 if( pOp->opcode==OP_NoConflict ){
4091 /* For the OP_NoConflict opcode, take the jump if any of the
4092 ** input fields are NULL, since any key with a NULL will not
4093 ** conflict */
4094 for(ii=0; ii<pIdxKey->nField; ii++){
4095 if( pIdxKey->aMem[ii].flags & MEM_Null ){
4096 takeJump = 1;
4097 break;
4101 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, pIdxKey, 0, 0, &res);
4102 if( pFree ) sqlite3DbFreeNN(db, pFree);
4103 if( rc!=SQLITE_OK ){
4104 goto abort_due_to_error;
4106 pC->seekResult = res;
4107 alreadyExists = (res==0);
4108 pC->nullRow = 1-alreadyExists;
4109 pC->deferredMoveto = 0;
4110 pC->cacheStatus = CACHE_STALE;
4111 if( pOp->opcode==OP_Found ){
4112 VdbeBranchTaken(alreadyExists!=0,2);
4113 if( alreadyExists ) goto jump_to_p2;
4114 }else{
4115 VdbeBranchTaken(takeJump||alreadyExists==0,2);
4116 if( takeJump || !alreadyExists ) goto jump_to_p2;
4118 break;
4121 /* Opcode: SeekRowid P1 P2 P3 * *
4122 ** Synopsis: intkey=r[P3]
4124 ** P1 is the index of a cursor open on an SQL table btree (with integer
4125 ** keys). If register P3 does not contain an integer or if P1 does not
4126 ** contain a record with rowid P3 then jump immediately to P2.
4127 ** Or, if P2 is 0, raise an SQLITE_CORRUPT error. If P1 does contain
4128 ** a record with rowid P3 then
4129 ** leave the cursor pointing at that record and fall through to the next
4130 ** instruction.
4132 ** The OP_NotExists opcode performs the same operation, but with OP_NotExists
4133 ** the P3 register must be guaranteed to contain an integer value. With this
4134 ** opcode, register P3 might not contain an integer.
4136 ** The OP_NotFound opcode performs the same operation on index btrees
4137 ** (with arbitrary multi-value keys).
4139 ** This opcode leaves the cursor in a state where it cannot be advanced
4140 ** in either direction. In other words, the Next and Prev opcodes will
4141 ** not work following this opcode.
4143 ** See also: Found, NotFound, NoConflict, SeekRowid
4145 /* Opcode: NotExists P1 P2 P3 * *
4146 ** Synopsis: intkey=r[P3]
4148 ** P1 is the index of a cursor open on an SQL table btree (with integer
4149 ** keys). P3 is an integer rowid. If P1 does not contain a record with
4150 ** rowid P3 then jump immediately to P2. Or, if P2 is 0, raise an
4151 ** SQLITE_CORRUPT error. If P1 does contain a record with rowid P3 then
4152 ** leave the cursor pointing at that record and fall through to the next
4153 ** instruction.
4155 ** The OP_SeekRowid opcode performs the same operation but also allows the
4156 ** P3 register to contain a non-integer value, in which case the jump is
4157 ** always taken. This opcode requires that P3 always contain an integer.
4159 ** The OP_NotFound opcode performs the same operation on index btrees
4160 ** (with arbitrary multi-value keys).
4162 ** This opcode leaves the cursor in a state where it cannot be advanced
4163 ** in either direction. In other words, the Next and Prev opcodes will
4164 ** not work following this opcode.
4166 ** See also: Found, NotFound, NoConflict, SeekRowid
4168 case OP_SeekRowid: { /* jump, in3 */
4169 VdbeCursor *pC;
4170 BtCursor *pCrsr;
4171 int res;
4172 u64 iKey;
4174 pIn3 = &aMem[pOp->p3];
4175 if( (pIn3->flags & MEM_Int)==0 ){
4176 applyAffinity(pIn3, SQLITE_AFF_NUMERIC, encoding);
4177 if( (pIn3->flags & MEM_Int)==0 ) goto jump_to_p2;
4179 /* Fall through into OP_NotExists */
4180 case OP_NotExists: /* jump, in3 */
4181 pIn3 = &aMem[pOp->p3];
4182 assert( pIn3->flags & MEM_Int );
4183 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4184 pC = p->apCsr[pOp->p1];
4185 assert( pC!=0 );
4186 #ifdef SQLITE_DEBUG
4187 pC->seekOp = 0;
4188 #endif
4189 assert( pC->isTable );
4190 assert( pC->eCurType==CURTYPE_BTREE );
4191 pCrsr = pC->uc.pCursor;
4192 assert( pCrsr!=0 );
4193 res = 0;
4194 iKey = pIn3->u.i;
4195 rc = sqlite3BtreeMovetoUnpacked(pCrsr, 0, iKey, 0, &res);
4196 assert( rc==SQLITE_OK || res==0 );
4197 pC->movetoTarget = iKey; /* Used by OP_Delete */
4198 pC->nullRow = 0;
4199 pC->cacheStatus = CACHE_STALE;
4200 pC->deferredMoveto = 0;
4201 VdbeBranchTaken(res!=0,2);
4202 pC->seekResult = res;
4203 if( res!=0 ){
4204 assert( rc==SQLITE_OK );
4205 if( pOp->p2==0 ){
4206 rc = SQLITE_CORRUPT_BKPT;
4207 }else{
4208 goto jump_to_p2;
4211 if( rc ) goto abort_due_to_error;
4212 break;
4215 /* Opcode: Sequence P1 P2 * * *
4216 ** Synopsis: r[P2]=cursor[P1].ctr++
4218 ** Find the next available sequence number for cursor P1.
4219 ** Write the sequence number into register P2.
4220 ** The sequence number on the cursor is incremented after this
4221 ** instruction.
4223 case OP_Sequence: { /* out2 */
4224 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4225 assert( p->apCsr[pOp->p1]!=0 );
4226 assert( p->apCsr[pOp->p1]->eCurType!=CURTYPE_VTAB );
4227 pOut = out2Prerelease(p, pOp);
4228 pOut->u.i = p->apCsr[pOp->p1]->seqCount++;
4229 break;
4233 /* Opcode: NewRowid P1 P2 P3 * *
4234 ** Synopsis: r[P2]=rowid
4236 ** Get a new integer record number (a.k.a "rowid") used as the key to a table.
4237 ** The record number is not previously used as a key in the database
4238 ** table that cursor P1 points to. The new record number is written
4239 ** written to register P2.
4241 ** If P3>0 then P3 is a register in the root frame of this VDBE that holds
4242 ** the largest previously generated record number. No new record numbers are
4243 ** allowed to be less than this value. When this value reaches its maximum,
4244 ** an SQLITE_FULL error is generated. The P3 register is updated with the '
4245 ** generated record number. This P3 mechanism is used to help implement the
4246 ** AUTOINCREMENT feature.
4248 case OP_NewRowid: { /* out2 */
4249 i64 v; /* The new rowid */
4250 VdbeCursor *pC; /* Cursor of table to get the new rowid */
4251 int res; /* Result of an sqlite3BtreeLast() */
4252 int cnt; /* Counter to limit the number of searches */
4253 Mem *pMem; /* Register holding largest rowid for AUTOINCREMENT */
4254 VdbeFrame *pFrame; /* Root frame of VDBE */
4256 v = 0;
4257 res = 0;
4258 pOut = out2Prerelease(p, pOp);
4259 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4260 pC = p->apCsr[pOp->p1];
4261 assert( pC!=0 );
4262 assert( pC->eCurType==CURTYPE_BTREE );
4263 assert( pC->uc.pCursor!=0 );
4265 /* The next rowid or record number (different terms for the same
4266 ** thing) is obtained in a two-step algorithm.
4268 ** First we attempt to find the largest existing rowid and add one
4269 ** to that. But if the largest existing rowid is already the maximum
4270 ** positive integer, we have to fall through to the second
4271 ** probabilistic algorithm
4273 ** The second algorithm is to select a rowid at random and see if
4274 ** it already exists in the table. If it does not exist, we have
4275 ** succeeded. If the random rowid does exist, we select a new one
4276 ** and try again, up to 100 times.
4278 assert( pC->isTable );
4280 #ifdef SQLITE_32BIT_ROWID
4281 # define MAX_ROWID 0x7fffffff
4282 #else
4283 /* Some compilers complain about constants of the form 0x7fffffffffffffff.
4284 ** Others complain about 0x7ffffffffffffffffLL. The following macro seems
4285 ** to provide the constant while making all compilers happy.
4287 # define MAX_ROWID (i64)( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
4288 #endif
4290 if( !pC->useRandomRowid ){
4291 rc = sqlite3BtreeLast(pC->uc.pCursor, &res);
4292 if( rc!=SQLITE_OK ){
4293 goto abort_due_to_error;
4295 if( res ){
4296 v = 1; /* IMP: R-61914-48074 */
4297 }else{
4298 assert( sqlite3BtreeCursorIsValid(pC->uc.pCursor) );
4299 v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
4300 if( v>=MAX_ROWID ){
4301 pC->useRandomRowid = 1;
4302 }else{
4303 v++; /* IMP: R-29538-34987 */
4308 #ifndef SQLITE_OMIT_AUTOINCREMENT
4309 if( pOp->p3 ){
4310 /* Assert that P3 is a valid memory cell. */
4311 assert( pOp->p3>0 );
4312 if( p->pFrame ){
4313 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
4314 /* Assert that P3 is a valid memory cell. */
4315 assert( pOp->p3<=pFrame->nMem );
4316 pMem = &pFrame->aMem[pOp->p3];
4317 }else{
4318 /* Assert that P3 is a valid memory cell. */
4319 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
4320 pMem = &aMem[pOp->p3];
4321 memAboutToChange(p, pMem);
4323 assert( memIsValid(pMem) );
4325 REGISTER_TRACE(pOp->p3, pMem);
4326 sqlite3VdbeMemIntegerify(pMem);
4327 assert( (pMem->flags & MEM_Int)!=0 ); /* mem(P3) holds an integer */
4328 if( pMem->u.i==MAX_ROWID || pC->useRandomRowid ){
4329 rc = SQLITE_FULL; /* IMP: R-17817-00630 */
4330 goto abort_due_to_error;
4332 if( v<pMem->u.i+1 ){
4333 v = pMem->u.i + 1;
4335 pMem->u.i = v;
4337 #endif
4338 if( pC->useRandomRowid ){
4339 /* IMPLEMENTATION-OF: R-07677-41881 If the largest ROWID is equal to the
4340 ** largest possible integer (9223372036854775807) then the database
4341 ** engine starts picking positive candidate ROWIDs at random until
4342 ** it finds one that is not previously used. */
4343 assert( pOp->p3==0 ); /* We cannot be in random rowid mode if this is
4344 ** an AUTOINCREMENT table. */
4345 cnt = 0;
4347 sqlite3_randomness(sizeof(v), &v);
4348 v &= (MAX_ROWID>>1); v++; /* Ensure that v is greater than zero */
4349 }while( ((rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)v,
4350 0, &res))==SQLITE_OK)
4351 && (res==0)
4352 && (++cnt<100));
4353 if( rc ) goto abort_due_to_error;
4354 if( res==0 ){
4355 rc = SQLITE_FULL; /* IMP: R-38219-53002 */
4356 goto abort_due_to_error;
4358 assert( v>0 ); /* EV: R-40812-03570 */
4360 pC->deferredMoveto = 0;
4361 pC->cacheStatus = CACHE_STALE;
4363 pOut->u.i = v;
4364 break;
4367 /* Opcode: Insert P1 P2 P3 P4 P5
4368 ** Synopsis: intkey=r[P3] data=r[P2]
4370 ** Write an entry into the table of cursor P1. A new entry is
4371 ** created if it doesn't already exist or the data for an existing
4372 ** entry is overwritten. The data is the value MEM_Blob stored in register
4373 ** number P2. The key is stored in register P3. The key must
4374 ** be a MEM_Int.
4376 ** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
4377 ** incremented (otherwise not). If the OPFLAG_LASTROWID flag of P5 is set,
4378 ** then rowid is stored for subsequent return by the
4379 ** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
4381 ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
4382 ** run faster by avoiding an unnecessary seek on cursor P1. However,
4383 ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
4384 ** seeks on the cursor or if the most recent seek used a key equal to P3.
4386 ** If the OPFLAG_ISUPDATE flag is set, then this opcode is part of an
4387 ** UPDATE operation. Otherwise (if the flag is clear) then this opcode
4388 ** is part of an INSERT operation. The difference is only important to
4389 ** the update hook.
4391 ** Parameter P4 may point to a Table structure, or may be NULL. If it is
4392 ** not NULL, then the update-hook (sqlite3.xUpdateCallback) is invoked
4393 ** following a successful insert.
4395 ** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
4396 ** allocated, then ownership of P2 is transferred to the pseudo-cursor
4397 ** and register P2 becomes ephemeral. If the cursor is changed, the
4398 ** value of register P2 will then change. Make sure this does not
4399 ** cause any problems.)
4401 ** This instruction only works on tables. The equivalent instruction
4402 ** for indices is OP_IdxInsert.
4404 /* Opcode: InsertInt P1 P2 P3 P4 P5
4405 ** Synopsis: intkey=P3 data=r[P2]
4407 ** This works exactly like OP_Insert except that the key is the
4408 ** integer value P3, not the value of the integer stored in register P3.
4410 case OP_Insert:
4411 case OP_InsertInt: {
4412 Mem *pData; /* MEM cell holding data for the record to be inserted */
4413 Mem *pKey; /* MEM cell holding key for the record */
4414 VdbeCursor *pC; /* Cursor to table into which insert is written */
4415 int seekResult; /* Result of prior seek or 0 if no USESEEKRESULT flag */
4416 const char *zDb; /* database name - used by the update hook */
4417 Table *pTab; /* Table structure - used by update and pre-update hooks */
4418 int op; /* Opcode for update hook: SQLITE_UPDATE or SQLITE_INSERT */
4419 BtreePayload x; /* Payload to be inserted */
4421 op = 0;
4422 pData = &aMem[pOp->p2];
4423 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4424 assert( memIsValid(pData) );
4425 pC = p->apCsr[pOp->p1];
4426 assert( pC!=0 );
4427 assert( pC->eCurType==CURTYPE_BTREE );
4428 assert( pC->uc.pCursor!=0 );
4429 assert( (pOp->p5 & OPFLAG_ISNOOP) || pC->isTable );
4430 assert( pOp->p4type==P4_TABLE || pOp->p4type>=P4_STATIC );
4431 REGISTER_TRACE(pOp->p2, pData);
4433 if( pOp->opcode==OP_Insert ){
4434 pKey = &aMem[pOp->p3];
4435 assert( pKey->flags & MEM_Int );
4436 assert( memIsValid(pKey) );
4437 REGISTER_TRACE(pOp->p3, pKey);
4438 x.nKey = pKey->u.i;
4439 }else{
4440 assert( pOp->opcode==OP_InsertInt );
4441 x.nKey = pOp->p3;
4444 if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
4445 assert( pC->iDb>=0 );
4446 zDb = db->aDb[pC->iDb].zDbSName;
4447 pTab = pOp->p4.pTab;
4448 assert( (pOp->p5 & OPFLAG_ISNOOP) || HasRowid(pTab) );
4449 op = ((pOp->p5 & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_INSERT);
4450 }else{
4451 pTab = 0; /* Not needed. Silence a compiler warning. */
4452 zDb = 0; /* Not needed. Silence a compiler warning. */
4455 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
4456 /* Invoke the pre-update hook, if any */
4457 if( db->xPreUpdateCallback
4458 && pOp->p4type==P4_TABLE
4459 && !(pOp->p5 & OPFLAG_ISUPDATE)
4461 sqlite3VdbePreUpdateHook(p, pC, SQLITE_INSERT, zDb, pTab, x.nKey, pOp->p2);
4463 if( pOp->p5 & OPFLAG_ISNOOP ) break;
4464 #endif
4466 if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
4467 if( pOp->p5 & OPFLAG_LASTROWID ) db->lastRowid = x.nKey;
4468 assert( pData->flags & (MEM_Blob|MEM_Str) );
4469 x.pData = pData->z;
4470 x.nData = pData->n;
4471 seekResult = ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0);
4472 if( pData->flags & MEM_Zero ){
4473 x.nZero = pData->u.nZero;
4474 }else{
4475 x.nZero = 0;
4477 x.pKey = 0;
4478 rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
4479 (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)), seekResult
4481 pC->deferredMoveto = 0;
4482 pC->cacheStatus = CACHE_STALE;
4484 /* Invoke the update-hook if required. */
4485 if( rc ) goto abort_due_to_error;
4486 if( db->xUpdateCallback && op ){
4487 db->xUpdateCallback(db->pUpdateArg, op, zDb, pTab->zName, x.nKey);
4489 break;
4492 /* Opcode: Delete P1 P2 P3 P4 P5
4494 ** Delete the record at which the P1 cursor is currently pointing.
4496 ** If the OPFLAG_SAVEPOSITION bit of the P5 parameter is set, then
4497 ** the cursor will be left pointing at either the next or the previous
4498 ** record in the table. If it is left pointing at the next record, then
4499 ** the next Next instruction will be a no-op. As a result, in this case
4500 ** it is ok to delete a record from within a Next loop. If
4501 ** OPFLAG_SAVEPOSITION bit of P5 is clear, then the cursor will be
4502 ** left in an undefined state.
4504 ** If the OPFLAG_AUXDELETE bit is set on P5, that indicates that this
4505 ** delete one of several associated with deleting a table row and all its
4506 ** associated index entries. Exactly one of those deletes is the "primary"
4507 ** delete. The others are all on OPFLAG_FORDELETE cursors or else are
4508 ** marked with the AUXDELETE flag.
4510 ** If the OPFLAG_NCHANGE flag of P2 (NB: P2 not P5) is set, then the row
4511 ** change count is incremented (otherwise not).
4513 ** P1 must not be pseudo-table. It has to be a real table with
4514 ** multiple rows.
4516 ** If P4 is not NULL then it points to a Table object. In this case either
4517 ** the update or pre-update hook, or both, may be invoked. The P1 cursor must
4518 ** have been positioned using OP_NotFound prior to invoking this opcode in
4519 ** this case. Specifically, if one is configured, the pre-update hook is
4520 ** invoked if P4 is not NULL. The update-hook is invoked if one is configured,
4521 ** P4 is not NULL, and the OPFLAG_NCHANGE flag is set in P2.
4523 ** If the OPFLAG_ISUPDATE flag is set in P2, then P3 contains the address
4524 ** of the memory cell that contains the value that the rowid of the row will
4525 ** be set to by the update.
4527 case OP_Delete: {
4528 VdbeCursor *pC;
4529 const char *zDb;
4530 Table *pTab;
4531 int opflags;
4533 opflags = pOp->p2;
4534 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4535 pC = p->apCsr[pOp->p1];
4536 assert( pC!=0 );
4537 assert( pC->eCurType==CURTYPE_BTREE );
4538 assert( pC->uc.pCursor!=0 );
4539 assert( pC->deferredMoveto==0 );
4541 #ifdef SQLITE_DEBUG
4542 if( pOp->p4type==P4_TABLE && HasRowid(pOp->p4.pTab) && pOp->p5==0 ){
4543 /* If p5 is zero, the seek operation that positioned the cursor prior to
4544 ** OP_Delete will have also set the pC->movetoTarget field to the rowid of
4545 ** the row that is being deleted */
4546 i64 iKey = sqlite3BtreeIntegerKey(pC->uc.pCursor);
4547 assert( pC->movetoTarget==iKey );
4549 #endif
4551 /* If the update-hook or pre-update-hook will be invoked, set zDb to
4552 ** the name of the db to pass as to it. Also set local pTab to a copy
4553 ** of p4.pTab. Finally, if p5 is true, indicating that this cursor was
4554 ** last moved with OP_Next or OP_Prev, not Seek or NotFound, set
4555 ** VdbeCursor.movetoTarget to the current rowid. */
4556 if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
4557 assert( pC->iDb>=0 );
4558 assert( pOp->p4.pTab!=0 );
4559 zDb = db->aDb[pC->iDb].zDbSName;
4560 pTab = pOp->p4.pTab;
4561 if( (pOp->p5 & OPFLAG_SAVEPOSITION)!=0 && pC->isTable ){
4562 pC->movetoTarget = sqlite3BtreeIntegerKey(pC->uc.pCursor);
4564 }else{
4565 zDb = 0; /* Not needed. Silence a compiler warning. */
4566 pTab = 0; /* Not needed. Silence a compiler warning. */
4569 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
4570 /* Invoke the pre-update-hook if required. */
4571 if( db->xPreUpdateCallback && pOp->p4.pTab ){
4572 assert( !(opflags & OPFLAG_ISUPDATE)
4573 || HasRowid(pTab)==0
4574 || (aMem[pOp->p3].flags & MEM_Int)
4576 sqlite3VdbePreUpdateHook(p, pC,
4577 (opflags & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_DELETE,
4578 zDb, pTab, pC->movetoTarget,
4579 pOp->p3
4582 if( opflags & OPFLAG_ISNOOP ) break;
4583 #endif
4585 /* Only flags that can be set are SAVEPOISTION and AUXDELETE */
4586 assert( (pOp->p5 & ~(OPFLAG_SAVEPOSITION|OPFLAG_AUXDELETE))==0 );
4587 assert( OPFLAG_SAVEPOSITION==BTREE_SAVEPOSITION );
4588 assert( OPFLAG_AUXDELETE==BTREE_AUXDELETE );
4590 #ifdef SQLITE_DEBUG
4591 if( p->pFrame==0 ){
4592 if( pC->isEphemeral==0
4593 && (pOp->p5 & OPFLAG_AUXDELETE)==0
4594 && (pC->wrFlag & OPFLAG_FORDELETE)==0
4596 nExtraDelete++;
4598 if( pOp->p2 & OPFLAG_NCHANGE ){
4599 nExtraDelete--;
4602 #endif
4604 rc = sqlite3BtreeDelete(pC->uc.pCursor, pOp->p5);
4605 pC->cacheStatus = CACHE_STALE;
4606 pC->seekResult = 0;
4607 if( rc ) goto abort_due_to_error;
4609 /* Invoke the update-hook if required. */
4610 if( opflags & OPFLAG_NCHANGE ){
4611 p->nChange++;
4612 if( db->xUpdateCallback && HasRowid(pTab) ){
4613 db->xUpdateCallback(db->pUpdateArg, SQLITE_DELETE, zDb, pTab->zName,
4614 pC->movetoTarget);
4615 assert( pC->iDb>=0 );
4619 break;
4621 /* Opcode: ResetCount * * * * *
4623 ** The value of the change counter is copied to the database handle
4624 ** change counter (returned by subsequent calls to sqlite3_changes()).
4625 ** Then the VMs internal change counter resets to 0.
4626 ** This is used by trigger programs.
4628 case OP_ResetCount: {
4629 sqlite3VdbeSetChanges(db, p->nChange);
4630 p->nChange = 0;
4631 break;
4634 /* Opcode: SorterCompare P1 P2 P3 P4
4635 ** Synopsis: if key(P1)!=trim(r[P3],P4) goto P2
4637 ** P1 is a sorter cursor. This instruction compares a prefix of the
4638 ** record blob in register P3 against a prefix of the entry that
4639 ** the sorter cursor currently points to. Only the first P4 fields
4640 ** of r[P3] and the sorter record are compared.
4642 ** If either P3 or the sorter contains a NULL in one of their significant
4643 ** fields (not counting the P4 fields at the end which are ignored) then
4644 ** the comparison is assumed to be equal.
4646 ** Fall through to next instruction if the two records compare equal to
4647 ** each other. Jump to P2 if they are different.
4649 case OP_SorterCompare: {
4650 VdbeCursor *pC;
4651 int res;
4652 int nKeyCol;
4654 pC = p->apCsr[pOp->p1];
4655 assert( isSorter(pC) );
4656 assert( pOp->p4type==P4_INT32 );
4657 pIn3 = &aMem[pOp->p3];
4658 nKeyCol = pOp->p4.i;
4659 res = 0;
4660 rc = sqlite3VdbeSorterCompare(pC, pIn3, nKeyCol, &res);
4661 VdbeBranchTaken(res!=0,2);
4662 if( rc ) goto abort_due_to_error;
4663 if( res ) goto jump_to_p2;
4664 break;
4667 /* Opcode: SorterData P1 P2 P3 * *
4668 ** Synopsis: r[P2]=data
4670 ** Write into register P2 the current sorter data for sorter cursor P1.
4671 ** Then clear the column header cache on cursor P3.
4673 ** This opcode is normally use to move a record out of the sorter and into
4674 ** a register that is the source for a pseudo-table cursor created using
4675 ** OpenPseudo. That pseudo-table cursor is the one that is identified by
4676 ** parameter P3. Clearing the P3 column cache as part of this opcode saves
4677 ** us from having to issue a separate NullRow instruction to clear that cache.
4679 case OP_SorterData: {
4680 VdbeCursor *pC;
4682 pOut = &aMem[pOp->p2];
4683 pC = p->apCsr[pOp->p1];
4684 assert( isSorter(pC) );
4685 rc = sqlite3VdbeSorterRowkey(pC, pOut);
4686 assert( rc!=SQLITE_OK || (pOut->flags & MEM_Blob) );
4687 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4688 if( rc ) goto abort_due_to_error;
4689 p->apCsr[pOp->p3]->cacheStatus = CACHE_STALE;
4690 break;
4693 /* Opcode: RowData P1 P2 P3 * *
4694 ** Synopsis: r[P2]=data
4696 ** Write into register P2 the complete row content for the row at
4697 ** which cursor P1 is currently pointing.
4698 ** There is no interpretation of the data.
4699 ** It is just copied onto the P2 register exactly as
4700 ** it is found in the database file.
4702 ** If cursor P1 is an index, then the content is the key of the row.
4703 ** If cursor P2 is a table, then the content extracted is the data.
4705 ** If the P1 cursor must be pointing to a valid row (not a NULL row)
4706 ** of a real table, not a pseudo-table.
4708 ** If P3!=0 then this opcode is allowed to make an ephermeral pointer
4709 ** into the database page. That means that the content of the output
4710 ** register will be invalidated as soon as the cursor moves - including
4711 ** moves caused by other cursors that "save" the the current cursors
4712 ** position in order that they can write to the same table. If P3==0
4713 ** then a copy of the data is made into memory. P3!=0 is faster, but
4714 ** P3==0 is safer.
4716 ** If P3!=0 then the content of the P2 register is unsuitable for use
4717 ** in OP_Result and any OP_Result will invalidate the P2 register content.
4718 ** The P2 register content is invalidated by opcodes like OP_Function or
4719 ** by any use of another cursor pointing to the same table.
4721 case OP_RowData: {
4722 VdbeCursor *pC;
4723 BtCursor *pCrsr;
4724 u32 n;
4726 pOut = out2Prerelease(p, pOp);
4728 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4729 pC = p->apCsr[pOp->p1];
4730 assert( pC!=0 );
4731 assert( pC->eCurType==CURTYPE_BTREE );
4732 assert( isSorter(pC)==0 );
4733 assert( pC->nullRow==0 );
4734 assert( pC->uc.pCursor!=0 );
4735 pCrsr = pC->uc.pCursor;
4737 /* The OP_RowData opcodes always follow OP_NotExists or
4738 ** OP_SeekRowid or OP_Rewind/Op_Next with no intervening instructions
4739 ** that might invalidate the cursor.
4740 ** If this where not the case, on of the following assert()s
4741 ** would fail. Should this ever change (because of changes in the code
4742 ** generator) then the fix would be to insert a call to
4743 ** sqlite3VdbeCursorMoveto().
4745 assert( pC->deferredMoveto==0 );
4746 assert( sqlite3BtreeCursorIsValid(pCrsr) );
4747 #if 0 /* Not required due to the previous to assert() statements */
4748 rc = sqlite3VdbeCursorMoveto(pC);
4749 if( rc!=SQLITE_OK ) goto abort_due_to_error;
4750 #endif
4752 n = sqlite3BtreePayloadSize(pCrsr);
4753 if( n>(u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
4754 goto too_big;
4756 testcase( n==0 );
4757 rc = sqlite3VdbeMemFromBtree(pCrsr, 0, n, pOut);
4758 if( rc ) goto abort_due_to_error;
4759 if( !pOp->p3 ) Deephemeralize(pOut);
4760 UPDATE_MAX_BLOBSIZE(pOut);
4761 REGISTER_TRACE(pOp->p2, pOut);
4762 break;
4765 /* Opcode: Rowid P1 P2 * * *
4766 ** Synopsis: r[P2]=rowid
4768 ** Store in register P2 an integer which is the key of the table entry that
4769 ** P1 is currently point to.
4771 ** P1 can be either an ordinary table or a virtual table. There used to
4772 ** be a separate OP_VRowid opcode for use with virtual tables, but this
4773 ** one opcode now works for both table types.
4775 case OP_Rowid: { /* out2 */
4776 VdbeCursor *pC;
4777 i64 v;
4778 sqlite3_vtab *pVtab;
4779 const sqlite3_module *pModule;
4781 pOut = out2Prerelease(p, pOp);
4782 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4783 pC = p->apCsr[pOp->p1];
4784 assert( pC!=0 );
4785 assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
4786 if( pC->nullRow ){
4787 pOut->flags = MEM_Null;
4788 break;
4789 }else if( pC->deferredMoveto ){
4790 v = pC->movetoTarget;
4791 #ifndef SQLITE_OMIT_VIRTUALTABLE
4792 }else if( pC->eCurType==CURTYPE_VTAB ){
4793 assert( pC->uc.pVCur!=0 );
4794 pVtab = pC->uc.pVCur->pVtab;
4795 pModule = pVtab->pModule;
4796 assert( pModule->xRowid );
4797 rc = pModule->xRowid(pC->uc.pVCur, &v);
4798 sqlite3VtabImportErrmsg(p, pVtab);
4799 if( rc ) goto abort_due_to_error;
4800 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4801 }else{
4802 assert( pC->eCurType==CURTYPE_BTREE );
4803 assert( pC->uc.pCursor!=0 );
4804 rc = sqlite3VdbeCursorRestore(pC);
4805 if( rc ) goto abort_due_to_error;
4806 if( pC->nullRow ){
4807 pOut->flags = MEM_Null;
4808 break;
4810 v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
4812 pOut->u.i = v;
4813 break;
4816 /* Opcode: NullRow P1 * * * *
4818 ** Move the cursor P1 to a null row. Any OP_Column operations
4819 ** that occur while the cursor is on the null row will always
4820 ** write a NULL.
4822 case OP_NullRow: {
4823 VdbeCursor *pC;
4825 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4826 pC = p->apCsr[pOp->p1];
4827 assert( pC!=0 );
4828 pC->nullRow = 1;
4829 pC->cacheStatus = CACHE_STALE;
4830 if( pC->eCurType==CURTYPE_BTREE ){
4831 assert( pC->uc.pCursor!=0 );
4832 sqlite3BtreeClearCursor(pC->uc.pCursor);
4834 break;
4837 /* Opcode: SeekEnd P1 * * * *
4839 ** Position cursor P1 at the end of the btree for the purpose of
4840 ** appending a new entry onto the btree.
4842 ** It is assumed that the cursor is used only for appending and so
4843 ** if the cursor is valid, then the cursor must already be pointing
4844 ** at the end of the btree and so no changes are made to
4845 ** the cursor.
4847 /* Opcode: Last P1 P2 * * *
4849 ** The next use of the Rowid or Column or Prev instruction for P1
4850 ** will refer to the last entry in the database table or index.
4851 ** If the table or index is empty and P2>0, then jump immediately to P2.
4852 ** If P2 is 0 or if the table or index is not empty, fall through
4853 ** to the following instruction.
4855 ** This opcode leaves the cursor configured to move in reverse order,
4856 ** from the end toward the beginning. In other words, the cursor is
4857 ** configured to use Prev, not Next.
4859 case OP_SeekEnd:
4860 case OP_Last: { /* jump */
4861 VdbeCursor *pC;
4862 BtCursor *pCrsr;
4863 int res;
4865 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4866 pC = p->apCsr[pOp->p1];
4867 assert( pC!=0 );
4868 assert( pC->eCurType==CURTYPE_BTREE );
4869 pCrsr = pC->uc.pCursor;
4870 res = 0;
4871 assert( pCrsr!=0 );
4872 #ifdef SQLITE_DEBUG
4873 pC->seekOp = pOp->opcode;
4874 #endif
4875 if( pOp->opcode==OP_SeekEnd ){
4876 assert( pOp->p2==0 );
4877 pC->seekResult = -1;
4878 if( sqlite3BtreeCursorIsValidNN(pCrsr) ){
4879 break;
4882 rc = sqlite3BtreeLast(pCrsr, &res);
4883 pC->nullRow = (u8)res;
4884 pC->deferredMoveto = 0;
4885 pC->cacheStatus = CACHE_STALE;
4886 if( rc ) goto abort_due_to_error;
4887 if( pOp->p2>0 ){
4888 VdbeBranchTaken(res!=0,2);
4889 if( res ) goto jump_to_p2;
4891 break;
4894 /* Opcode: IfSmaller P1 P2 P3 * *
4896 ** Estimate the number of rows in the table P1. Jump to P2 if that
4897 ** estimate is less than approximately 2**(0.1*P3).
4899 case OP_IfSmaller: { /* jump */
4900 VdbeCursor *pC;
4901 BtCursor *pCrsr;
4902 int res;
4903 i64 sz;
4905 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4906 pC = p->apCsr[pOp->p1];
4907 assert( pC!=0 );
4908 pCrsr = pC->uc.pCursor;
4909 assert( pCrsr );
4910 rc = sqlite3BtreeFirst(pCrsr, &res);
4911 if( rc ) goto abort_due_to_error;
4912 if( res==0 ){
4913 sz = sqlite3BtreeRowCountEst(pCrsr);
4914 if( ALWAYS(sz>=0) && sqlite3LogEst((u64)sz)<pOp->p3 ) res = 1;
4916 VdbeBranchTaken(res!=0,2);
4917 if( res ) goto jump_to_p2;
4918 break;
4922 /* Opcode: SorterSort P1 P2 * * *
4924 ** After all records have been inserted into the Sorter object
4925 ** identified by P1, invoke this opcode to actually do the sorting.
4926 ** Jump to P2 if there are no records to be sorted.
4928 ** This opcode is an alias for OP_Sort and OP_Rewind that is used
4929 ** for Sorter objects.
4931 /* Opcode: Sort P1 P2 * * *
4933 ** This opcode does exactly the same thing as OP_Rewind except that
4934 ** it increments an undocumented global variable used for testing.
4936 ** Sorting is accomplished by writing records into a sorting index,
4937 ** then rewinding that index and playing it back from beginning to
4938 ** end. We use the OP_Sort opcode instead of OP_Rewind to do the
4939 ** rewinding so that the global variable will be incremented and
4940 ** regression tests can determine whether or not the optimizer is
4941 ** correctly optimizing out sorts.
4943 case OP_SorterSort: /* jump */
4944 case OP_Sort: { /* jump */
4945 #ifdef SQLITE_TEST
4946 sqlite3_sort_count++;
4947 sqlite3_search_count--;
4948 #endif
4949 p->aCounter[SQLITE_STMTSTATUS_SORT]++;
4950 /* Fall through into OP_Rewind */
4952 /* Opcode: Rewind P1 P2 * * *
4954 ** The next use of the Rowid or Column or Next instruction for P1
4955 ** will refer to the first entry in the database table or index.
4956 ** If the table or index is empty, jump immediately to P2.
4957 ** If the table or index is not empty, fall through to the following
4958 ** instruction.
4960 ** This opcode leaves the cursor configured to move in forward order,
4961 ** from the beginning toward the end. In other words, the cursor is
4962 ** configured to use Next, not Prev.
4964 case OP_Rewind: { /* jump */
4965 VdbeCursor *pC;
4966 BtCursor *pCrsr;
4967 int res;
4969 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4970 pC = p->apCsr[pOp->p1];
4971 assert( pC!=0 );
4972 assert( isSorter(pC)==(pOp->opcode==OP_SorterSort) );
4973 res = 1;
4974 #ifdef SQLITE_DEBUG
4975 pC->seekOp = OP_Rewind;
4976 #endif
4977 if( isSorter(pC) ){
4978 rc = sqlite3VdbeSorterRewind(pC, &res);
4979 }else{
4980 assert( pC->eCurType==CURTYPE_BTREE );
4981 pCrsr = pC->uc.pCursor;
4982 assert( pCrsr );
4983 rc = sqlite3BtreeFirst(pCrsr, &res);
4984 pC->deferredMoveto = 0;
4985 pC->cacheStatus = CACHE_STALE;
4987 if( rc ) goto abort_due_to_error;
4988 pC->nullRow = (u8)res;
4989 assert( pOp->p2>0 && pOp->p2<p->nOp );
4990 VdbeBranchTaken(res!=0,2);
4991 if( res ) goto jump_to_p2;
4992 break;
4995 /* Opcode: Next P1 P2 P3 P4 P5
4997 ** Advance cursor P1 so that it points to the next key/data pair in its
4998 ** table or index. If there are no more key/value pairs then fall through
4999 ** to the following instruction. But if the cursor advance was successful,
5000 ** jump immediately to P2.
5002 ** The Next opcode is only valid following an SeekGT, SeekGE, or
5003 ** OP_Rewind opcode used to position the cursor. Next is not allowed
5004 ** to follow SeekLT, SeekLE, or OP_Last.
5006 ** The P1 cursor must be for a real table, not a pseudo-table. P1 must have
5007 ** been opened prior to this opcode or the program will segfault.
5009 ** The P3 value is a hint to the btree implementation. If P3==1, that
5010 ** means P1 is an SQL index and that this instruction could have been
5011 ** omitted if that index had been unique. P3 is usually 0. P3 is
5012 ** always either 0 or 1.
5014 ** P4 is always of type P4_ADVANCE. The function pointer points to
5015 ** sqlite3BtreeNext().
5017 ** If P5 is positive and the jump is taken, then event counter
5018 ** number P5-1 in the prepared statement is incremented.
5020 ** See also: Prev, NextIfOpen
5022 /* Opcode: NextIfOpen P1 P2 P3 P4 P5
5024 ** This opcode works just like Next except that if cursor P1 is not
5025 ** open it behaves a no-op.
5027 /* Opcode: Prev P1 P2 P3 P4 P5
5029 ** Back up cursor P1 so that it points to the previous key/data pair in its
5030 ** table or index. If there is no previous key/value pairs then fall through
5031 ** to the following instruction. But if the cursor backup was successful,
5032 ** jump immediately to P2.
5035 ** The Prev opcode is only valid following an SeekLT, SeekLE, or
5036 ** OP_Last opcode used to position the cursor. Prev is not allowed
5037 ** to follow SeekGT, SeekGE, or OP_Rewind.
5039 ** The P1 cursor must be for a real table, not a pseudo-table. If P1 is
5040 ** not open then the behavior is undefined.
5042 ** The P3 value is a hint to the btree implementation. If P3==1, that
5043 ** means P1 is an SQL index and that this instruction could have been
5044 ** omitted if that index had been unique. P3 is usually 0. P3 is
5045 ** always either 0 or 1.
5047 ** P4 is always of type P4_ADVANCE. The function pointer points to
5048 ** sqlite3BtreePrevious().
5050 ** If P5 is positive and the jump is taken, then event counter
5051 ** number P5-1 in the prepared statement is incremented.
5053 /* Opcode: PrevIfOpen P1 P2 P3 P4 P5
5055 ** This opcode works just like Prev except that if cursor P1 is not
5056 ** open it behaves a no-op.
5058 /* Opcode: SorterNext P1 P2 * * P5
5060 ** This opcode works just like OP_Next except that P1 must be a
5061 ** sorter object for which the OP_SorterSort opcode has been
5062 ** invoked. This opcode advances the cursor to the next sorted
5063 ** record, or jumps to P2 if there are no more sorted records.
5065 case OP_SorterNext: { /* jump */
5066 VdbeCursor *pC;
5068 pC = p->apCsr[pOp->p1];
5069 assert( isSorter(pC) );
5070 rc = sqlite3VdbeSorterNext(db, pC);
5071 goto next_tail;
5072 case OP_PrevIfOpen: /* jump */
5073 case OP_NextIfOpen: /* jump */
5074 if( p->apCsr[pOp->p1]==0 ) break;
5075 /* Fall through */
5076 case OP_Prev: /* jump */
5077 case OP_Next: /* jump */
5078 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5079 assert( pOp->p5<ArraySize(p->aCounter) );
5080 pC = p->apCsr[pOp->p1];
5081 assert( pC!=0 );
5082 assert( pC->deferredMoveto==0 );
5083 assert( pC->eCurType==CURTYPE_BTREE );
5084 assert( pOp->opcode!=OP_Next || pOp->p4.xAdvance==sqlite3BtreeNext );
5085 assert( pOp->opcode!=OP_Prev || pOp->p4.xAdvance==sqlite3BtreePrevious );
5086 assert( pOp->opcode!=OP_NextIfOpen || pOp->p4.xAdvance==sqlite3BtreeNext );
5087 assert( pOp->opcode!=OP_PrevIfOpen || pOp->p4.xAdvance==sqlite3BtreePrevious);
5089 /* The Next opcode is only used after SeekGT, SeekGE, and Rewind.
5090 ** The Prev opcode is only used after SeekLT, SeekLE, and Last. */
5091 assert( pOp->opcode!=OP_Next || pOp->opcode!=OP_NextIfOpen
5092 || pC->seekOp==OP_SeekGT || pC->seekOp==OP_SeekGE
5093 || pC->seekOp==OP_Rewind || pC->seekOp==OP_Found);
5094 assert( pOp->opcode!=OP_Prev || pOp->opcode!=OP_PrevIfOpen
5095 || pC->seekOp==OP_SeekLT || pC->seekOp==OP_SeekLE
5096 || pC->seekOp==OP_Last );
5098 rc = pOp->p4.xAdvance(pC->uc.pCursor, pOp->p3);
5099 next_tail:
5100 pC->cacheStatus = CACHE_STALE;
5101 VdbeBranchTaken(rc==SQLITE_OK,2);
5102 if( rc==SQLITE_OK ){
5103 pC->nullRow = 0;
5104 p->aCounter[pOp->p5]++;
5105 #ifdef SQLITE_TEST
5106 sqlite3_search_count++;
5107 #endif
5108 goto jump_to_p2_and_check_for_interrupt;
5110 if( rc!=SQLITE_DONE ) goto abort_due_to_error;
5111 rc = SQLITE_OK;
5112 pC->nullRow = 1;
5113 goto check_for_interrupt;
5116 /* Opcode: IdxInsert P1 P2 P3 P4 P5
5117 ** Synopsis: key=r[P2]
5119 ** Register P2 holds an SQL index key made using the
5120 ** MakeRecord instructions. This opcode writes that key
5121 ** into the index P1. Data for the entry is nil.
5123 ** If P4 is not zero, then it is the number of values in the unpacked
5124 ** key of reg(P2). In that case, P3 is the index of the first register
5125 ** for the unpacked key. The availability of the unpacked key can sometimes
5126 ** be an optimization.
5128 ** If P5 has the OPFLAG_APPEND bit set, that is a hint to the b-tree layer
5129 ** that this insert is likely to be an append.
5131 ** If P5 has the OPFLAG_NCHANGE bit set, then the change counter is
5132 ** incremented by this instruction. If the OPFLAG_NCHANGE bit is clear,
5133 ** then the change counter is unchanged.
5135 ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
5136 ** run faster by avoiding an unnecessary seek on cursor P1. However,
5137 ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
5138 ** seeks on the cursor or if the most recent seek used a key equivalent
5139 ** to P2.
5141 ** This instruction only works for indices. The equivalent instruction
5142 ** for tables is OP_Insert.
5144 /* Opcode: SorterInsert P1 P2 * * *
5145 ** Synopsis: key=r[P2]
5147 ** Register P2 holds an SQL index key made using the
5148 ** MakeRecord instructions. This opcode writes that key
5149 ** into the sorter P1. Data for the entry is nil.
5151 case OP_SorterInsert: /* in2 */
5152 case OP_IdxInsert: { /* in2 */
5153 VdbeCursor *pC;
5154 BtreePayload x;
5156 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5157 pC = p->apCsr[pOp->p1];
5158 assert( pC!=0 );
5159 assert( isSorter(pC)==(pOp->opcode==OP_SorterInsert) );
5160 pIn2 = &aMem[pOp->p2];
5161 assert( pIn2->flags & MEM_Blob );
5162 if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
5163 assert( pC->eCurType==CURTYPE_BTREE || pOp->opcode==OP_SorterInsert );
5164 assert( pC->isTable==0 );
5165 rc = ExpandBlob(pIn2);
5166 if( rc ) goto abort_due_to_error;
5167 if( pOp->opcode==OP_SorterInsert ){
5168 rc = sqlite3VdbeSorterWrite(pC, pIn2);
5169 }else{
5170 x.nKey = pIn2->n;
5171 x.pKey = pIn2->z;
5172 x.aMem = aMem + pOp->p3;
5173 x.nMem = (u16)pOp->p4.i;
5174 rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
5175 (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)),
5176 ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0)
5178 assert( pC->deferredMoveto==0 );
5179 pC->cacheStatus = CACHE_STALE;
5181 if( rc) goto abort_due_to_error;
5182 break;
5185 /* Opcode: IdxDelete P1 P2 P3 * *
5186 ** Synopsis: key=r[P2@P3]
5188 ** The content of P3 registers starting at register P2 form
5189 ** an unpacked index key. This opcode removes that entry from the
5190 ** index opened by cursor P1.
5192 case OP_IdxDelete: {
5193 VdbeCursor *pC;
5194 BtCursor *pCrsr;
5195 int res;
5196 UnpackedRecord r;
5198 assert( pOp->p3>0 );
5199 assert( pOp->p2>0 && pOp->p2+pOp->p3<=(p->nMem+1 - p->nCursor)+1 );
5200 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5201 pC = p->apCsr[pOp->p1];
5202 assert( pC!=0 );
5203 assert( pC->eCurType==CURTYPE_BTREE );
5204 pCrsr = pC->uc.pCursor;
5205 assert( pCrsr!=0 );
5206 assert( pOp->p5==0 );
5207 r.pKeyInfo = pC->pKeyInfo;
5208 r.nField = (u16)pOp->p3;
5209 r.default_rc = 0;
5210 r.aMem = &aMem[pOp->p2];
5211 rc = sqlite3BtreeMovetoUnpacked(pCrsr, &r, 0, 0, &res);
5212 if( rc ) goto abort_due_to_error;
5213 if( res==0 ){
5214 rc = sqlite3BtreeDelete(pCrsr, BTREE_AUXDELETE);
5215 if( rc ) goto abort_due_to_error;
5217 assert( pC->deferredMoveto==0 );
5218 pC->cacheStatus = CACHE_STALE;
5219 pC->seekResult = 0;
5220 break;
5223 /* Opcode: DeferredSeek P1 * P3 P4 *
5224 ** Synopsis: Move P3 to P1.rowid if needed
5226 ** P1 is an open index cursor and P3 is a cursor on the corresponding
5227 ** table. This opcode does a deferred seek of the P3 table cursor
5228 ** to the row that corresponds to the current row of P1.
5230 ** This is a deferred seek. Nothing actually happens until
5231 ** the cursor is used to read a record. That way, if no reads
5232 ** occur, no unnecessary I/O happens.
5234 ** P4 may be an array of integers (type P4_INTARRAY) containing
5235 ** one entry for each column in the P3 table. If array entry a(i)
5236 ** is non-zero, then reading column a(i)-1 from cursor P3 is
5237 ** equivalent to performing the deferred seek and then reading column i
5238 ** from P1. This information is stored in P3 and used to redirect
5239 ** reads against P3 over to P1, thus possibly avoiding the need to
5240 ** seek and read cursor P3.
5242 /* Opcode: IdxRowid P1 P2 * * *
5243 ** Synopsis: r[P2]=rowid
5245 ** Write into register P2 an integer which is the last entry in the record at
5246 ** the end of the index key pointed to by cursor P1. This integer should be
5247 ** the rowid of the table entry to which this index entry points.
5249 ** See also: Rowid, MakeRecord.
5251 case OP_DeferredSeek:
5252 case OP_IdxRowid: { /* out2 */
5253 VdbeCursor *pC; /* The P1 index cursor */
5254 VdbeCursor *pTabCur; /* The P2 table cursor (OP_DeferredSeek only) */
5255 i64 rowid; /* Rowid that P1 current points to */
5257 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5258 pC = p->apCsr[pOp->p1];
5259 assert( pC!=0 );
5260 assert( pC->eCurType==CURTYPE_BTREE );
5261 assert( pC->uc.pCursor!=0 );
5262 assert( pC->isTable==0 );
5263 assert( pC->deferredMoveto==0 );
5264 assert( !pC->nullRow || pOp->opcode==OP_IdxRowid );
5266 /* The IdxRowid and Seek opcodes are combined because of the commonality
5267 ** of sqlite3VdbeCursorRestore() and sqlite3VdbeIdxRowid(). */
5268 rc = sqlite3VdbeCursorRestore(pC);
5270 /* sqlite3VbeCursorRestore() can only fail if the record has been deleted
5271 ** out from under the cursor. That will never happens for an IdxRowid
5272 ** or Seek opcode */
5273 if( NEVER(rc!=SQLITE_OK) ) goto abort_due_to_error;
5275 if( !pC->nullRow ){
5276 rowid = 0; /* Not needed. Only used to silence a warning. */
5277 rc = sqlite3VdbeIdxRowid(db, pC->uc.pCursor, &rowid);
5278 if( rc!=SQLITE_OK ){
5279 goto abort_due_to_error;
5281 if( pOp->opcode==OP_DeferredSeek ){
5282 assert( pOp->p3>=0 && pOp->p3<p->nCursor );
5283 pTabCur = p->apCsr[pOp->p3];
5284 assert( pTabCur!=0 );
5285 assert( pTabCur->eCurType==CURTYPE_BTREE );
5286 assert( pTabCur->uc.pCursor!=0 );
5287 assert( pTabCur->isTable );
5288 pTabCur->nullRow = 0;
5289 pTabCur->movetoTarget = rowid;
5290 pTabCur->deferredMoveto = 1;
5291 assert( pOp->p4type==P4_INTARRAY || pOp->p4.ai==0 );
5292 pTabCur->aAltMap = pOp->p4.ai;
5293 pTabCur->pAltCursor = pC;
5294 }else{
5295 pOut = out2Prerelease(p, pOp);
5296 pOut->u.i = rowid;
5298 }else{
5299 assert( pOp->opcode==OP_IdxRowid );
5300 sqlite3VdbeMemSetNull(&aMem[pOp->p2]);
5302 break;
5305 /* Opcode: IdxGE P1 P2 P3 P4 P5
5306 ** Synopsis: key=r[P3@P4]
5308 ** The P4 register values beginning with P3 form an unpacked index
5309 ** key that omits the PRIMARY KEY. Compare this key value against the index
5310 ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5311 ** fields at the end.
5313 ** If the P1 index entry is greater than or equal to the key value
5314 ** then jump to P2. Otherwise fall through to the next instruction.
5316 /* Opcode: IdxGT P1 P2 P3 P4 P5
5317 ** Synopsis: key=r[P3@P4]
5319 ** The P4 register values beginning with P3 form an unpacked index
5320 ** key that omits the PRIMARY KEY. Compare this key value against the index
5321 ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5322 ** fields at the end.
5324 ** If the P1 index entry is greater than the key value
5325 ** then jump to P2. Otherwise fall through to the next instruction.
5327 /* Opcode: IdxLT P1 P2 P3 P4 P5
5328 ** Synopsis: key=r[P3@P4]
5330 ** The P4 register values beginning with P3 form an unpacked index
5331 ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5332 ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5333 ** ROWID on the P1 index.
5335 ** If the P1 index entry is less than the key value then jump to P2.
5336 ** Otherwise fall through to the next instruction.
5338 /* Opcode: IdxLE P1 P2 P3 P4 P5
5339 ** Synopsis: key=r[P3@P4]
5341 ** The P4 register values beginning with P3 form an unpacked index
5342 ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5343 ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5344 ** ROWID on the P1 index.
5346 ** If the P1 index entry is less than or equal to the key value then jump
5347 ** to P2. Otherwise fall through to the next instruction.
5349 case OP_IdxLE: /* jump */
5350 case OP_IdxGT: /* jump */
5351 case OP_IdxLT: /* jump */
5352 case OP_IdxGE: { /* jump */
5353 VdbeCursor *pC;
5354 int res;
5355 UnpackedRecord r;
5357 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5358 pC = p->apCsr[pOp->p1];
5359 assert( pC!=0 );
5360 assert( pC->isOrdered );
5361 assert( pC->eCurType==CURTYPE_BTREE );
5362 assert( pC->uc.pCursor!=0);
5363 assert( pC->deferredMoveto==0 );
5364 assert( pOp->p5==0 || pOp->p5==1 );
5365 assert( pOp->p4type==P4_INT32 );
5366 r.pKeyInfo = pC->pKeyInfo;
5367 r.nField = (u16)pOp->p4.i;
5368 if( pOp->opcode<OP_IdxLT ){
5369 assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxGT );
5370 r.default_rc = -1;
5371 }else{
5372 assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxLT );
5373 r.default_rc = 0;
5375 r.aMem = &aMem[pOp->p3];
5376 #ifdef SQLITE_DEBUG
5377 { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
5378 #endif
5379 res = 0; /* Not needed. Only used to silence a warning. */
5380 rc = sqlite3VdbeIdxKeyCompare(db, pC, &r, &res);
5381 assert( (OP_IdxLE&1)==(OP_IdxLT&1) && (OP_IdxGE&1)==(OP_IdxGT&1) );
5382 if( (pOp->opcode&1)==(OP_IdxLT&1) ){
5383 assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxLT );
5384 res = -res;
5385 }else{
5386 assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxGT );
5387 res++;
5389 VdbeBranchTaken(res>0,2);
5390 if( rc ) goto abort_due_to_error;
5391 if( res>0 ) goto jump_to_p2;
5392 break;
5395 /* Opcode: Destroy P1 P2 P3 * *
5397 ** Delete an entire database table or index whose root page in the database
5398 ** file is given by P1.
5400 ** The table being destroyed is in the main database file if P3==0. If
5401 ** P3==1 then the table to be clear is in the auxiliary database file
5402 ** that is used to store tables create using CREATE TEMPORARY TABLE.
5404 ** If AUTOVACUUM is enabled then it is possible that another root page
5405 ** might be moved into the newly deleted root page in order to keep all
5406 ** root pages contiguous at the beginning of the database. The former
5407 ** value of the root page that moved - its value before the move occurred -
5408 ** is stored in register P2. If no page movement was required (because the
5409 ** table being dropped was already the last one in the database) then a
5410 ** zero is stored in register P2. If AUTOVACUUM is disabled then a zero
5411 ** is stored in register P2.
5413 ** This opcode throws an error if there are any active reader VMs when
5414 ** it is invoked. This is done to avoid the difficulty associated with
5415 ** updating existing cursors when a root page is moved in an AUTOVACUUM
5416 ** database. This error is thrown even if the database is not an AUTOVACUUM
5417 ** db in order to avoid introducing an incompatibility between autovacuum
5418 ** and non-autovacuum modes.
5420 ** See also: Clear
5422 case OP_Destroy: { /* out2 */
5423 int iMoved;
5424 int iDb;
5426 assert( p->readOnly==0 );
5427 assert( pOp->p1>1 );
5428 pOut = out2Prerelease(p, pOp);
5429 pOut->flags = MEM_Null;
5430 if( db->nVdbeRead > db->nVDestroy+1 ){
5431 rc = SQLITE_LOCKED;
5432 p->errorAction = OE_Abort;
5433 goto abort_due_to_error;
5434 }else{
5435 iDb = pOp->p3;
5436 assert( DbMaskTest(p->btreeMask, iDb) );
5437 iMoved = 0; /* Not needed. Only to silence a warning. */
5438 rc = sqlite3BtreeDropTable(db->aDb[iDb].pBt, pOp->p1, &iMoved);
5439 pOut->flags = MEM_Int;
5440 pOut->u.i = iMoved;
5441 if( rc ) goto abort_due_to_error;
5442 #ifndef SQLITE_OMIT_AUTOVACUUM
5443 if( iMoved!=0 ){
5444 sqlite3RootPageMoved(db, iDb, iMoved, pOp->p1);
5445 /* All OP_Destroy operations occur on the same btree */
5446 assert( resetSchemaOnFault==0 || resetSchemaOnFault==iDb+1 );
5447 resetSchemaOnFault = iDb+1;
5449 #endif
5451 break;
5454 /* Opcode: Clear P1 P2 P3
5456 ** Delete all contents of the database table or index whose root page
5457 ** in the database file is given by P1. But, unlike Destroy, do not
5458 ** remove the table or index from the database file.
5460 ** The table being clear is in the main database file if P2==0. If
5461 ** P2==1 then the table to be clear is in the auxiliary database file
5462 ** that is used to store tables create using CREATE TEMPORARY TABLE.
5464 ** If the P3 value is non-zero, then the table referred to must be an
5465 ** intkey table (an SQL table, not an index). In this case the row change
5466 ** count is incremented by the number of rows in the table being cleared.
5467 ** If P3 is greater than zero, then the value stored in register P3 is
5468 ** also incremented by the number of rows in the table being cleared.
5470 ** See also: Destroy
5472 case OP_Clear: {
5473 int nChange;
5475 nChange = 0;
5476 assert( p->readOnly==0 );
5477 assert( DbMaskTest(p->btreeMask, pOp->p2) );
5478 rc = sqlite3BtreeClearTable(
5479 db->aDb[pOp->p2].pBt, pOp->p1, (pOp->p3 ? &nChange : 0)
5481 if( pOp->p3 ){
5482 p->nChange += nChange;
5483 if( pOp->p3>0 ){
5484 assert( memIsValid(&aMem[pOp->p3]) );
5485 memAboutToChange(p, &aMem[pOp->p3]);
5486 aMem[pOp->p3].u.i += nChange;
5489 if( rc ) goto abort_due_to_error;
5490 break;
5493 /* Opcode: ResetSorter P1 * * * *
5495 ** Delete all contents from the ephemeral table or sorter
5496 ** that is open on cursor P1.
5498 ** This opcode only works for cursors used for sorting and
5499 ** opened with OP_OpenEphemeral or OP_SorterOpen.
5501 case OP_ResetSorter: {
5502 VdbeCursor *pC;
5504 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5505 pC = p->apCsr[pOp->p1];
5506 assert( pC!=0 );
5507 if( isSorter(pC) ){
5508 sqlite3VdbeSorterReset(db, pC->uc.pSorter);
5509 }else{
5510 assert( pC->eCurType==CURTYPE_BTREE );
5511 assert( pC->isEphemeral );
5512 rc = sqlite3BtreeClearTableOfCursor(pC->uc.pCursor);
5513 if( rc ) goto abort_due_to_error;
5515 break;
5518 /* Opcode: CreateBtree P1 P2 P3 * *
5519 ** Synopsis: r[P2]=root iDb=P1 flags=P3
5521 ** Allocate a new b-tree in the main database file if P1==0 or in the
5522 ** TEMP database file if P1==1 or in an attached database if
5523 ** P1>1. The P3 argument must be 1 (BTREE_INTKEY) for a rowid table
5524 ** it must be 2 (BTREE_BLOBKEY) for a index or WITHOUT ROWID table.
5525 ** The root page number of the new b-tree is stored in register P2.
5527 case OP_CreateBtree: { /* out2 */
5528 int pgno;
5529 Db *pDb;
5531 pOut = out2Prerelease(p, pOp);
5532 pgno = 0;
5533 assert( pOp->p3==BTREE_INTKEY || pOp->p3==BTREE_BLOBKEY );
5534 assert( pOp->p1>=0 && pOp->p1<db->nDb );
5535 assert( DbMaskTest(p->btreeMask, pOp->p1) );
5536 assert( p->readOnly==0 );
5537 pDb = &db->aDb[pOp->p1];
5538 assert( pDb->pBt!=0 );
5539 rc = sqlite3BtreeCreateTable(pDb->pBt, &pgno, pOp->p3);
5540 if( rc ) goto abort_due_to_error;
5541 pOut->u.i = pgno;
5542 break;
5545 /* Opcode: SqlExec * * * P4 *
5547 ** Run the SQL statement or statements specified in the P4 string.
5549 case OP_SqlExec: {
5550 db->nSqlExec++;
5551 rc = sqlite3_exec(db, pOp->p4.z, 0, 0, 0);
5552 db->nSqlExec--;
5553 if( rc ) goto abort_due_to_error;
5554 break;
5557 /* Opcode: ParseSchema P1 * * P4 *
5559 ** Read and parse all entries from the SQLITE_MASTER table of database P1
5560 ** that match the WHERE clause P4.
5562 ** This opcode invokes the parser to create a new virtual machine,
5563 ** then runs the new virtual machine. It is thus a re-entrant opcode.
5565 case OP_ParseSchema: {
5566 int iDb;
5567 const char *zMaster;
5568 char *zSql;
5569 InitData initData;
5571 /* Any prepared statement that invokes this opcode will hold mutexes
5572 ** on every btree. This is a prerequisite for invoking
5573 ** sqlite3InitCallback().
5575 #ifdef SQLITE_DEBUG
5576 for(iDb=0; iDb<db->nDb; iDb++){
5577 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
5579 #endif
5581 iDb = pOp->p1;
5582 assert( iDb>=0 && iDb<db->nDb );
5583 assert( DbHasProperty(db, iDb, DB_SchemaLoaded) );
5584 /* Used to be a conditional */ {
5585 zMaster = MASTER_NAME;
5586 initData.db = db;
5587 initData.iDb = pOp->p1;
5588 initData.pzErrMsg = &p->zErrMsg;
5589 zSql = sqlite3MPrintf(db,
5590 "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s ORDER BY rowid",
5591 db->aDb[iDb].zDbSName, zMaster, pOp->p4.z);
5592 if( zSql==0 ){
5593 rc = SQLITE_NOMEM_BKPT;
5594 }else{
5595 assert( db->init.busy==0 );
5596 db->init.busy = 1;
5597 initData.rc = SQLITE_OK;
5598 assert( !db->mallocFailed );
5599 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
5600 if( rc==SQLITE_OK ) rc = initData.rc;
5601 sqlite3DbFreeNN(db, zSql);
5602 db->init.busy = 0;
5605 if( rc ){
5606 sqlite3ResetAllSchemasOfConnection(db);
5607 if( rc==SQLITE_NOMEM ){
5608 goto no_mem;
5610 goto abort_due_to_error;
5612 break;
5615 #if !defined(SQLITE_OMIT_ANALYZE)
5616 /* Opcode: LoadAnalysis P1 * * * *
5618 ** Read the sqlite_stat1 table for database P1 and load the content
5619 ** of that table into the internal index hash table. This will cause
5620 ** the analysis to be used when preparing all subsequent queries.
5622 case OP_LoadAnalysis: {
5623 assert( pOp->p1>=0 && pOp->p1<db->nDb );
5624 rc = sqlite3AnalysisLoad(db, pOp->p1);
5625 if( rc ) goto abort_due_to_error;
5626 break;
5628 #endif /* !defined(SQLITE_OMIT_ANALYZE) */
5630 /* Opcode: DropTable P1 * * P4 *
5632 ** Remove the internal (in-memory) data structures that describe
5633 ** the table named P4 in database P1. This is called after a table
5634 ** is dropped from disk (using the Destroy opcode) in order to keep
5635 ** the internal representation of the
5636 ** schema consistent with what is on disk.
5638 case OP_DropTable: {
5639 sqlite3UnlinkAndDeleteTable(db, pOp->p1, pOp->p4.z);
5640 break;
5643 /* Opcode: DropIndex P1 * * P4 *
5645 ** Remove the internal (in-memory) data structures that describe
5646 ** the index named P4 in database P1. This is called after an index
5647 ** is dropped from disk (using the Destroy opcode)
5648 ** in order to keep the internal representation of the
5649 ** schema consistent with what is on disk.
5651 case OP_DropIndex: {
5652 sqlite3UnlinkAndDeleteIndex(db, pOp->p1, pOp->p4.z);
5653 break;
5656 /* Opcode: DropTrigger P1 * * P4 *
5658 ** Remove the internal (in-memory) data structures that describe
5659 ** the trigger named P4 in database P1. This is called after a trigger
5660 ** is dropped from disk (using the Destroy opcode) in order to keep
5661 ** the internal representation of the
5662 ** schema consistent with what is on disk.
5664 case OP_DropTrigger: {
5665 sqlite3UnlinkAndDeleteTrigger(db, pOp->p1, pOp->p4.z);
5666 break;
5670 #ifndef SQLITE_OMIT_INTEGRITY_CHECK
5671 /* Opcode: IntegrityCk P1 P2 P3 P4 P5
5673 ** Do an analysis of the currently open database. Store in
5674 ** register P1 the text of an error message describing any problems.
5675 ** If no problems are found, store a NULL in register P1.
5677 ** The register P3 contains one less than the maximum number of allowed errors.
5678 ** At most reg(P3) errors will be reported.
5679 ** In other words, the analysis stops as soon as reg(P1) errors are
5680 ** seen. Reg(P1) is updated with the number of errors remaining.
5682 ** The root page numbers of all tables in the database are integers
5683 ** stored in P4_INTARRAY argument.
5685 ** If P5 is not zero, the check is done on the auxiliary database
5686 ** file, not the main database file.
5688 ** This opcode is used to implement the integrity_check pragma.
5690 case OP_IntegrityCk: {
5691 int nRoot; /* Number of tables to check. (Number of root pages.) */
5692 int *aRoot; /* Array of rootpage numbers for tables to be checked */
5693 int nErr; /* Number of errors reported */
5694 char *z; /* Text of the error report */
5695 Mem *pnErr; /* Register keeping track of errors remaining */
5697 assert( p->bIsReader );
5698 nRoot = pOp->p2;
5699 aRoot = pOp->p4.ai;
5700 assert( nRoot>0 );
5701 assert( aRoot[0]==nRoot );
5702 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
5703 pnErr = &aMem[pOp->p3];
5704 assert( (pnErr->flags & MEM_Int)!=0 );
5705 assert( (pnErr->flags & (MEM_Str|MEM_Blob))==0 );
5706 pIn1 = &aMem[pOp->p1];
5707 assert( pOp->p5<db->nDb );
5708 assert( DbMaskTest(p->btreeMask, pOp->p5) );
5709 z = sqlite3BtreeIntegrityCheck(db->aDb[pOp->p5].pBt, &aRoot[1], nRoot,
5710 (int)pnErr->u.i+1, &nErr);
5711 sqlite3VdbeMemSetNull(pIn1);
5712 if( nErr==0 ){
5713 assert( z==0 );
5714 }else if( z==0 ){
5715 goto no_mem;
5716 }else{
5717 pnErr->u.i -= nErr-1;
5718 sqlite3VdbeMemSetStr(pIn1, z, -1, SQLITE_UTF8, sqlite3_free);
5720 UPDATE_MAX_BLOBSIZE(pIn1);
5721 sqlite3VdbeChangeEncoding(pIn1, encoding);
5722 break;
5724 #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
5726 /* Opcode: RowSetAdd P1 P2 * * *
5727 ** Synopsis: rowset(P1)=r[P2]
5729 ** Insert the integer value held by register P2 into a RowSet object
5730 ** held in register P1.
5732 ** An assertion fails if P2 is not an integer.
5734 case OP_RowSetAdd: { /* in1, in2 */
5735 pIn1 = &aMem[pOp->p1];
5736 pIn2 = &aMem[pOp->p2];
5737 assert( (pIn2->flags & MEM_Int)!=0 );
5738 if( (pIn1->flags & MEM_RowSet)==0 ){
5739 sqlite3VdbeMemSetRowSet(pIn1);
5740 if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
5742 sqlite3RowSetInsert(pIn1->u.pRowSet, pIn2->u.i);
5743 break;
5746 /* Opcode: RowSetRead P1 P2 P3 * *
5747 ** Synopsis: r[P3]=rowset(P1)
5749 ** Extract the smallest value from the RowSet object in P1
5750 ** and put that value into register P3.
5751 ** Or, if RowSet object P1 is initially empty, leave P3
5752 ** unchanged and jump to instruction P2.
5754 case OP_RowSetRead: { /* jump, in1, out3 */
5755 i64 val;
5757 pIn1 = &aMem[pOp->p1];
5758 if( (pIn1->flags & MEM_RowSet)==0
5759 || sqlite3RowSetNext(pIn1->u.pRowSet, &val)==0
5761 /* The boolean index is empty */
5762 sqlite3VdbeMemSetNull(pIn1);
5763 VdbeBranchTaken(1,2);
5764 goto jump_to_p2_and_check_for_interrupt;
5765 }else{
5766 /* A value was pulled from the index */
5767 VdbeBranchTaken(0,2);
5768 sqlite3VdbeMemSetInt64(&aMem[pOp->p3], val);
5770 goto check_for_interrupt;
5773 /* Opcode: RowSetTest P1 P2 P3 P4
5774 ** Synopsis: if r[P3] in rowset(P1) goto P2
5776 ** Register P3 is assumed to hold a 64-bit integer value. If register P1
5777 ** contains a RowSet object and that RowSet object contains
5778 ** the value held in P3, jump to register P2. Otherwise, insert the
5779 ** integer in P3 into the RowSet and continue on to the
5780 ** next opcode.
5782 ** The RowSet object is optimized for the case where sets of integers
5783 ** are inserted in distinct phases, which each set contains no duplicates.
5784 ** Each set is identified by a unique P4 value. The first set
5785 ** must have P4==0, the final set must have P4==-1, and for all other sets
5786 ** must have P4>0.
5788 ** This allows optimizations: (a) when P4==0 there is no need to test
5789 ** the RowSet object for P3, as it is guaranteed not to contain it,
5790 ** (b) when P4==-1 there is no need to insert the value, as it will
5791 ** never be tested for, and (c) when a value that is part of set X is
5792 ** inserted, there is no need to search to see if the same value was
5793 ** previously inserted as part of set X (only if it was previously
5794 ** inserted as part of some other set).
5796 case OP_RowSetTest: { /* jump, in1, in3 */
5797 int iSet;
5798 int exists;
5800 pIn1 = &aMem[pOp->p1];
5801 pIn3 = &aMem[pOp->p3];
5802 iSet = pOp->p4.i;
5803 assert( pIn3->flags&MEM_Int );
5805 /* If there is anything other than a rowset object in memory cell P1,
5806 ** delete it now and initialize P1 with an empty rowset
5808 if( (pIn1->flags & MEM_RowSet)==0 ){
5809 sqlite3VdbeMemSetRowSet(pIn1);
5810 if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
5813 assert( pOp->p4type==P4_INT32 );
5814 assert( iSet==-1 || iSet>=0 );
5815 if( iSet ){
5816 exists = sqlite3RowSetTest(pIn1->u.pRowSet, iSet, pIn3->u.i);
5817 VdbeBranchTaken(exists!=0,2);
5818 if( exists ) goto jump_to_p2;
5820 if( iSet>=0 ){
5821 sqlite3RowSetInsert(pIn1->u.pRowSet, pIn3->u.i);
5823 break;
5827 #ifndef SQLITE_OMIT_TRIGGER
5829 /* Opcode: Program P1 P2 P3 P4 P5
5831 ** Execute the trigger program passed as P4 (type P4_SUBPROGRAM).
5833 ** P1 contains the address of the memory cell that contains the first memory
5834 ** cell in an array of values used as arguments to the sub-program. P2
5835 ** contains the address to jump to if the sub-program throws an IGNORE
5836 ** exception using the RAISE() function. Register P3 contains the address
5837 ** of a memory cell in this (the parent) VM that is used to allocate the
5838 ** memory required by the sub-vdbe at runtime.
5840 ** P4 is a pointer to the VM containing the trigger program.
5842 ** If P5 is non-zero, then recursive program invocation is enabled.
5844 case OP_Program: { /* jump */
5845 int nMem; /* Number of memory registers for sub-program */
5846 int nByte; /* Bytes of runtime space required for sub-program */
5847 Mem *pRt; /* Register to allocate runtime space */
5848 Mem *pMem; /* Used to iterate through memory cells */
5849 Mem *pEnd; /* Last memory cell in new array */
5850 VdbeFrame *pFrame; /* New vdbe frame to execute in */
5851 SubProgram *pProgram; /* Sub-program to execute */
5852 void *t; /* Token identifying trigger */
5854 pProgram = pOp->p4.pProgram;
5855 pRt = &aMem[pOp->p3];
5856 assert( pProgram->nOp>0 );
5858 /* If the p5 flag is clear, then recursive invocation of triggers is
5859 ** disabled for backwards compatibility (p5 is set if this sub-program
5860 ** is really a trigger, not a foreign key action, and the flag set
5861 ** and cleared by the "PRAGMA recursive_triggers" command is clear).
5863 ** It is recursive invocation of triggers, at the SQL level, that is
5864 ** disabled. In some cases a single trigger may generate more than one
5865 ** SubProgram (if the trigger may be executed with more than one different
5866 ** ON CONFLICT algorithm). SubProgram structures associated with a
5867 ** single trigger all have the same value for the SubProgram.token
5868 ** variable. */
5869 if( pOp->p5 ){
5870 t = pProgram->token;
5871 for(pFrame=p->pFrame; pFrame && pFrame->token!=t; pFrame=pFrame->pParent);
5872 if( pFrame ) break;
5875 if( p->nFrame>=db->aLimit[SQLITE_LIMIT_TRIGGER_DEPTH] ){
5876 rc = SQLITE_ERROR;
5877 sqlite3VdbeError(p, "too many levels of trigger recursion");
5878 goto abort_due_to_error;
5881 /* Register pRt is used to store the memory required to save the state
5882 ** of the current program, and the memory required at runtime to execute
5883 ** the trigger program. If this trigger has been fired before, then pRt
5884 ** is already allocated. Otherwise, it must be initialized. */
5885 if( (pRt->flags&MEM_Frame)==0 ){
5886 /* SubProgram.nMem is set to the number of memory cells used by the
5887 ** program stored in SubProgram.aOp. As well as these, one memory
5888 ** cell is required for each cursor used by the program. Set local
5889 ** variable nMem (and later, VdbeFrame.nChildMem) to this value.
5891 nMem = pProgram->nMem + pProgram->nCsr;
5892 assert( nMem>0 );
5893 if( pProgram->nCsr==0 ) nMem++;
5894 nByte = ROUND8(sizeof(VdbeFrame))
5895 + nMem * sizeof(Mem)
5896 + pProgram->nCsr * sizeof(VdbeCursor*)
5897 + (pProgram->nOp + 7)/8;
5898 pFrame = sqlite3DbMallocZero(db, nByte);
5899 if( !pFrame ){
5900 goto no_mem;
5902 sqlite3VdbeMemRelease(pRt);
5903 pRt->flags = MEM_Frame;
5904 pRt->u.pFrame = pFrame;
5906 pFrame->v = p;
5907 pFrame->nChildMem = nMem;
5908 pFrame->nChildCsr = pProgram->nCsr;
5909 pFrame->pc = (int)(pOp - aOp);
5910 pFrame->aMem = p->aMem;
5911 pFrame->nMem = p->nMem;
5912 pFrame->apCsr = p->apCsr;
5913 pFrame->nCursor = p->nCursor;
5914 pFrame->aOp = p->aOp;
5915 pFrame->nOp = p->nOp;
5916 pFrame->token = pProgram->token;
5917 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
5918 pFrame->anExec = p->anExec;
5919 #endif
5921 pEnd = &VdbeFrameMem(pFrame)[pFrame->nChildMem];
5922 for(pMem=VdbeFrameMem(pFrame); pMem!=pEnd; pMem++){
5923 pMem->flags = MEM_Undefined;
5924 pMem->db = db;
5926 }else{
5927 pFrame = pRt->u.pFrame;
5928 assert( pProgram->nMem+pProgram->nCsr==pFrame->nChildMem
5929 || (pProgram->nCsr==0 && pProgram->nMem+1==pFrame->nChildMem) );
5930 assert( pProgram->nCsr==pFrame->nChildCsr );
5931 assert( (int)(pOp - aOp)==pFrame->pc );
5934 p->nFrame++;
5935 pFrame->pParent = p->pFrame;
5936 pFrame->lastRowid = db->lastRowid;
5937 pFrame->nChange = p->nChange;
5938 pFrame->nDbChange = p->db->nChange;
5939 assert( pFrame->pAuxData==0 );
5940 pFrame->pAuxData = p->pAuxData;
5941 p->pAuxData = 0;
5942 p->nChange = 0;
5943 p->pFrame = pFrame;
5944 p->aMem = aMem = VdbeFrameMem(pFrame);
5945 p->nMem = pFrame->nChildMem;
5946 p->nCursor = (u16)pFrame->nChildCsr;
5947 p->apCsr = (VdbeCursor **)&aMem[p->nMem];
5948 pFrame->aOnce = (u8*)&p->apCsr[pProgram->nCsr];
5949 memset(pFrame->aOnce, 0, (pProgram->nOp + 7)/8);
5950 p->aOp = aOp = pProgram->aOp;
5951 p->nOp = pProgram->nOp;
5952 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
5953 p->anExec = 0;
5954 #endif
5955 pOp = &aOp[-1];
5957 break;
5960 /* Opcode: Param P1 P2 * * *
5962 ** This opcode is only ever present in sub-programs called via the
5963 ** OP_Program instruction. Copy a value currently stored in a memory
5964 ** cell of the calling (parent) frame to cell P2 in the current frames
5965 ** address space. This is used by trigger programs to access the new.*
5966 ** and old.* values.
5968 ** The address of the cell in the parent frame is determined by adding
5969 ** the value of the P1 argument to the value of the P1 argument to the
5970 ** calling OP_Program instruction.
5972 case OP_Param: { /* out2 */
5973 VdbeFrame *pFrame;
5974 Mem *pIn;
5975 pOut = out2Prerelease(p, pOp);
5976 pFrame = p->pFrame;
5977 pIn = &pFrame->aMem[pOp->p1 + pFrame->aOp[pFrame->pc].p1];
5978 sqlite3VdbeMemShallowCopy(pOut, pIn, MEM_Ephem);
5979 break;
5982 #endif /* #ifndef SQLITE_OMIT_TRIGGER */
5984 #ifndef SQLITE_OMIT_FOREIGN_KEY
5985 /* Opcode: FkCounter P1 P2 * * *
5986 ** Synopsis: fkctr[P1]+=P2
5988 ** Increment a "constraint counter" by P2 (P2 may be negative or positive).
5989 ** If P1 is non-zero, the database constraint counter is incremented
5990 ** (deferred foreign key constraints). Otherwise, if P1 is zero, the
5991 ** statement counter is incremented (immediate foreign key constraints).
5993 case OP_FkCounter: {
5994 if( db->flags & SQLITE_DeferFKs ){
5995 db->nDeferredImmCons += pOp->p2;
5996 }else if( pOp->p1 ){
5997 db->nDeferredCons += pOp->p2;
5998 }else{
5999 p->nFkConstraint += pOp->p2;
6001 break;
6004 /* Opcode: FkIfZero P1 P2 * * *
6005 ** Synopsis: if fkctr[P1]==0 goto P2
6007 ** This opcode tests if a foreign key constraint-counter is currently zero.
6008 ** If so, jump to instruction P2. Otherwise, fall through to the next
6009 ** instruction.
6011 ** If P1 is non-zero, then the jump is taken if the database constraint-counter
6012 ** is zero (the one that counts deferred constraint violations). If P1 is
6013 ** zero, the jump is taken if the statement constraint-counter is zero
6014 ** (immediate foreign key constraint violations).
6016 case OP_FkIfZero: { /* jump */
6017 if( pOp->p1 ){
6018 VdbeBranchTaken(db->nDeferredCons==0 && db->nDeferredImmCons==0, 2);
6019 if( db->nDeferredCons==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
6020 }else{
6021 VdbeBranchTaken(p->nFkConstraint==0 && db->nDeferredImmCons==0, 2);
6022 if( p->nFkConstraint==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
6024 break;
6026 #endif /* #ifndef SQLITE_OMIT_FOREIGN_KEY */
6028 #ifndef SQLITE_OMIT_AUTOINCREMENT
6029 /* Opcode: MemMax P1 P2 * * *
6030 ** Synopsis: r[P1]=max(r[P1],r[P2])
6032 ** P1 is a register in the root frame of this VM (the root frame is
6033 ** different from the current frame if this instruction is being executed
6034 ** within a sub-program). Set the value of register P1 to the maximum of
6035 ** its current value and the value in register P2.
6037 ** This instruction throws an error if the memory cell is not initially
6038 ** an integer.
6040 case OP_MemMax: { /* in2 */
6041 VdbeFrame *pFrame;
6042 if( p->pFrame ){
6043 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
6044 pIn1 = &pFrame->aMem[pOp->p1];
6045 }else{
6046 pIn1 = &aMem[pOp->p1];
6048 assert( memIsValid(pIn1) );
6049 sqlite3VdbeMemIntegerify(pIn1);
6050 pIn2 = &aMem[pOp->p2];
6051 sqlite3VdbeMemIntegerify(pIn2);
6052 if( pIn1->u.i<pIn2->u.i){
6053 pIn1->u.i = pIn2->u.i;
6055 break;
6057 #endif /* SQLITE_OMIT_AUTOINCREMENT */
6059 /* Opcode: IfPos P1 P2 P3 * *
6060 ** Synopsis: if r[P1]>0 then r[P1]-=P3, goto P2
6062 ** Register P1 must contain an integer.
6063 ** If the value of register P1 is 1 or greater, subtract P3 from the
6064 ** value in P1 and jump to P2.
6066 ** If the initial value of register P1 is less than 1, then the
6067 ** value is unchanged and control passes through to the next instruction.
6069 case OP_IfPos: { /* jump, in1 */
6070 pIn1 = &aMem[pOp->p1];
6071 assert( pIn1->flags&MEM_Int );
6072 VdbeBranchTaken( pIn1->u.i>0, 2);
6073 if( pIn1->u.i>0 ){
6074 pIn1->u.i -= pOp->p3;
6075 goto jump_to_p2;
6077 break;
6080 /* Opcode: OffsetLimit P1 P2 P3 * *
6081 ** Synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)
6083 ** This opcode performs a commonly used computation associated with
6084 ** LIMIT and OFFSET process. r[P1] holds the limit counter. r[P3]
6085 ** holds the offset counter. The opcode computes the combined value
6086 ** of the LIMIT and OFFSET and stores that value in r[P2]. The r[P2]
6087 ** value computed is the total number of rows that will need to be
6088 ** visited in order to complete the query.
6090 ** If r[P3] is zero or negative, that means there is no OFFSET
6091 ** and r[P2] is set to be the value of the LIMIT, r[P1].
6093 ** if r[P1] is zero or negative, that means there is no LIMIT
6094 ** and r[P2] is set to -1.
6096 ** Otherwise, r[P2] is set to the sum of r[P1] and r[P3].
6098 case OP_OffsetLimit: { /* in1, out2, in3 */
6099 i64 x;
6100 pIn1 = &aMem[pOp->p1];
6101 pIn3 = &aMem[pOp->p3];
6102 pOut = out2Prerelease(p, pOp);
6103 assert( pIn1->flags & MEM_Int );
6104 assert( pIn3->flags & MEM_Int );
6105 x = pIn1->u.i;
6106 if( x<=0 || sqlite3AddInt64(&x, pIn3->u.i>0?pIn3->u.i:0) ){
6107 /* If the LIMIT is less than or equal to zero, loop forever. This
6108 ** is documented. But also, if the LIMIT+OFFSET exceeds 2^63 then
6109 ** also loop forever. This is undocumented. In fact, one could argue
6110 ** that the loop should terminate. But assuming 1 billion iterations
6111 ** per second (far exceeding the capabilities of any current hardware)
6112 ** it would take nearly 300 years to actually reach the limit. So
6113 ** looping forever is a reasonable approximation. */
6114 pOut->u.i = -1;
6115 }else{
6116 pOut->u.i = x;
6118 break;
6121 /* Opcode: IfNotZero P1 P2 * * *
6122 ** Synopsis: if r[P1]!=0 then r[P1]--, goto P2
6124 ** Register P1 must contain an integer. If the content of register P1 is
6125 ** initially greater than zero, then decrement the value in register P1.
6126 ** If it is non-zero (negative or positive) and then also jump to P2.
6127 ** If register P1 is initially zero, leave it unchanged and fall through.
6129 case OP_IfNotZero: { /* jump, in1 */
6130 pIn1 = &aMem[pOp->p1];
6131 assert( pIn1->flags&MEM_Int );
6132 VdbeBranchTaken(pIn1->u.i<0, 2);
6133 if( pIn1->u.i ){
6134 if( pIn1->u.i>0 ) pIn1->u.i--;
6135 goto jump_to_p2;
6137 break;
6140 /* Opcode: DecrJumpZero P1 P2 * * *
6141 ** Synopsis: if (--r[P1])==0 goto P2
6143 ** Register P1 must hold an integer. Decrement the value in P1
6144 ** and jump to P2 if the new value is exactly zero.
6146 case OP_DecrJumpZero: { /* jump, in1 */
6147 pIn1 = &aMem[pOp->p1];
6148 assert( pIn1->flags&MEM_Int );
6149 if( pIn1->u.i>SMALLEST_INT64 ) pIn1->u.i--;
6150 VdbeBranchTaken(pIn1->u.i==0, 2);
6151 if( pIn1->u.i==0 ) goto jump_to_p2;
6152 break;
6156 /* Opcode: AggStep0 * P2 P3 P4 P5
6157 ** Synopsis: accum=r[P3] step(r[P2@P5])
6159 ** Execute the step function for an aggregate. The
6160 ** function has P5 arguments. P4 is a pointer to the FuncDef
6161 ** structure that specifies the function. Register P3 is the
6162 ** accumulator.
6164 ** The P5 arguments are taken from register P2 and its
6165 ** successors.
6167 /* Opcode: AggStep * P2 P3 P4 P5
6168 ** Synopsis: accum=r[P3] step(r[P2@P5])
6170 ** Execute the step function for an aggregate. The
6171 ** function has P5 arguments. P4 is a pointer to an sqlite3_context
6172 ** object that is used to run the function. Register P3 is
6173 ** as the accumulator.
6175 ** The P5 arguments are taken from register P2 and its
6176 ** successors.
6178 ** This opcode is initially coded as OP_AggStep0. On first evaluation,
6179 ** the FuncDef stored in P4 is converted into an sqlite3_context and
6180 ** the opcode is changed. In this way, the initialization of the
6181 ** sqlite3_context only happens once, instead of on each call to the
6182 ** step function.
6184 case OP_AggStep0: {
6185 int n;
6186 sqlite3_context *pCtx;
6188 assert( pOp->p4type==P4_FUNCDEF );
6189 n = pOp->p5;
6190 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
6191 assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
6192 assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
6193 pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
6194 if( pCtx==0 ) goto no_mem;
6195 pCtx->pMem = 0;
6196 pCtx->pFunc = pOp->p4.pFunc;
6197 pCtx->iOp = (int)(pOp - aOp);
6198 pCtx->pVdbe = p;
6199 pCtx->argc = n;
6200 pOp->p4type = P4_FUNCCTX;
6201 pOp->p4.pCtx = pCtx;
6202 pOp->opcode = OP_AggStep;
6203 /* Fall through into OP_AggStep */
6205 case OP_AggStep: {
6206 int i;
6207 sqlite3_context *pCtx;
6208 Mem *pMem;
6209 Mem t;
6211 assert( pOp->p4type==P4_FUNCCTX );
6212 pCtx = pOp->p4.pCtx;
6213 pMem = &aMem[pOp->p3];
6215 /* If this function is inside of a trigger, the register array in aMem[]
6216 ** might change from one evaluation to the next. The next block of code
6217 ** checks to see if the register array has changed, and if so it
6218 ** reinitializes the relavant parts of the sqlite3_context object */
6219 if( pCtx->pMem != pMem ){
6220 pCtx->pMem = pMem;
6221 for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
6224 #ifdef SQLITE_DEBUG
6225 for(i=0; i<pCtx->argc; i++){
6226 assert( memIsValid(pCtx->argv[i]) );
6227 REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
6229 #endif
6231 pMem->n++;
6232 sqlite3VdbeMemInit(&t, db, MEM_Null);
6233 pCtx->pOut = &t;
6234 pCtx->fErrorOrAux = 0;
6235 pCtx->skipFlag = 0;
6236 (pCtx->pFunc->xSFunc)(pCtx,pCtx->argc,pCtx->argv); /* IMP: R-24505-23230 */
6237 if( pCtx->fErrorOrAux ){
6238 if( pCtx->isError ){
6239 sqlite3VdbeError(p, "%s", sqlite3_value_text(&t));
6240 rc = pCtx->isError;
6242 sqlite3VdbeMemRelease(&t);
6243 if( rc ) goto abort_due_to_error;
6244 }else{
6245 assert( t.flags==MEM_Null );
6247 if( pCtx->skipFlag ){
6248 assert( pOp[-1].opcode==OP_CollSeq );
6249 i = pOp[-1].p1;
6250 if( i ) sqlite3VdbeMemSetInt64(&aMem[i], 1);
6252 break;
6255 /* Opcode: AggFinal P1 P2 * P4 *
6256 ** Synopsis: accum=r[P1] N=P2
6258 ** Execute the finalizer function for an aggregate. P1 is
6259 ** the memory location that is the accumulator for the aggregate.
6261 ** P2 is the number of arguments that the step function takes and
6262 ** P4 is a pointer to the FuncDef for this function. The P2
6263 ** argument is not used by this opcode. It is only there to disambiguate
6264 ** functions that can take varying numbers of arguments. The
6265 ** P4 argument is only needed for the degenerate case where
6266 ** the step function was not previously called.
6268 case OP_AggFinal: {
6269 Mem *pMem;
6270 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
6271 pMem = &aMem[pOp->p1];
6272 assert( (pMem->flags & ~(MEM_Null|MEM_Agg))==0 );
6273 rc = sqlite3VdbeMemFinalize(pMem, pOp->p4.pFunc);
6274 if( rc ){
6275 sqlite3VdbeError(p, "%s", sqlite3_value_text(pMem));
6276 goto abort_due_to_error;
6278 sqlite3VdbeChangeEncoding(pMem, encoding);
6279 UPDATE_MAX_BLOBSIZE(pMem);
6280 if( sqlite3VdbeMemTooBig(pMem) ){
6281 goto too_big;
6283 break;
6286 #ifndef SQLITE_OMIT_WAL
6287 /* Opcode: Checkpoint P1 P2 P3 * *
6289 ** Checkpoint database P1. This is a no-op if P1 is not currently in
6290 ** WAL mode. Parameter P2 is one of SQLITE_CHECKPOINT_PASSIVE, FULL,
6291 ** RESTART, or TRUNCATE. Write 1 or 0 into mem[P3] if the checkpoint returns
6292 ** SQLITE_BUSY or not, respectively. Write the number of pages in the
6293 ** WAL after the checkpoint into mem[P3+1] and the number of pages
6294 ** in the WAL that have been checkpointed after the checkpoint
6295 ** completes into mem[P3+2]. However on an error, mem[P3+1] and
6296 ** mem[P3+2] are initialized to -1.
6298 case OP_Checkpoint: {
6299 int i; /* Loop counter */
6300 int aRes[3]; /* Results */
6301 Mem *pMem; /* Write results here */
6303 assert( p->readOnly==0 );
6304 aRes[0] = 0;
6305 aRes[1] = aRes[2] = -1;
6306 assert( pOp->p2==SQLITE_CHECKPOINT_PASSIVE
6307 || pOp->p2==SQLITE_CHECKPOINT_FULL
6308 || pOp->p2==SQLITE_CHECKPOINT_RESTART
6309 || pOp->p2==SQLITE_CHECKPOINT_TRUNCATE
6311 rc = sqlite3Checkpoint(db, pOp->p1, pOp->p2, &aRes[1], &aRes[2]);
6312 if( rc ){
6313 if( rc!=SQLITE_BUSY ) goto abort_due_to_error;
6314 rc = SQLITE_OK;
6315 aRes[0] = 1;
6317 for(i=0, pMem = &aMem[pOp->p3]; i<3; i++, pMem++){
6318 sqlite3VdbeMemSetInt64(pMem, (i64)aRes[i]);
6320 break;
6322 #endif
6324 #ifndef SQLITE_OMIT_PRAGMA
6325 /* Opcode: JournalMode P1 P2 P3 * *
6327 ** Change the journal mode of database P1 to P3. P3 must be one of the
6328 ** PAGER_JOURNALMODE_XXX values. If changing between the various rollback
6329 ** modes (delete, truncate, persist, off and memory), this is a simple
6330 ** operation. No IO is required.
6332 ** If changing into or out of WAL mode the procedure is more complicated.
6334 ** Write a string containing the final journal-mode to register P2.
6336 case OP_JournalMode: { /* out2 */
6337 Btree *pBt; /* Btree to change journal mode of */
6338 Pager *pPager; /* Pager associated with pBt */
6339 int eNew; /* New journal mode */
6340 int eOld; /* The old journal mode */
6341 #ifndef SQLITE_OMIT_WAL
6342 const char *zFilename; /* Name of database file for pPager */
6343 #endif
6345 pOut = out2Prerelease(p, pOp);
6346 eNew = pOp->p3;
6347 assert( eNew==PAGER_JOURNALMODE_DELETE
6348 || eNew==PAGER_JOURNALMODE_TRUNCATE
6349 || eNew==PAGER_JOURNALMODE_PERSIST
6350 || eNew==PAGER_JOURNALMODE_OFF
6351 || eNew==PAGER_JOURNALMODE_MEMORY
6352 || eNew==PAGER_JOURNALMODE_WAL
6353 || eNew==PAGER_JOURNALMODE_QUERY
6355 assert( pOp->p1>=0 && pOp->p1<db->nDb );
6356 assert( p->readOnly==0 );
6358 pBt = db->aDb[pOp->p1].pBt;
6359 pPager = sqlite3BtreePager(pBt);
6360 eOld = sqlite3PagerGetJournalMode(pPager);
6361 if( eNew==PAGER_JOURNALMODE_QUERY ) eNew = eOld;
6362 if( !sqlite3PagerOkToChangeJournalMode(pPager) ) eNew = eOld;
6364 #ifndef SQLITE_OMIT_WAL
6365 zFilename = sqlite3PagerFilename(pPager, 1);
6367 /* Do not allow a transition to journal_mode=WAL for a database
6368 ** in temporary storage or if the VFS does not support shared memory
6370 if( eNew==PAGER_JOURNALMODE_WAL
6371 && (sqlite3Strlen30(zFilename)==0 /* Temp file */
6372 || !sqlite3PagerWalSupported(pPager)) /* No shared-memory support */
6374 eNew = eOld;
6377 if( (eNew!=eOld)
6378 && (eOld==PAGER_JOURNALMODE_WAL || eNew==PAGER_JOURNALMODE_WAL)
6380 if( !db->autoCommit || db->nVdbeRead>1 ){
6381 rc = SQLITE_ERROR;
6382 sqlite3VdbeError(p,
6383 "cannot change %s wal mode from within a transaction",
6384 (eNew==PAGER_JOURNALMODE_WAL ? "into" : "out of")
6386 goto abort_due_to_error;
6387 }else{
6389 if( eOld==PAGER_JOURNALMODE_WAL ){
6390 /* If leaving WAL mode, close the log file. If successful, the call
6391 ** to PagerCloseWal() checkpoints and deletes the write-ahead-log
6392 ** file. An EXCLUSIVE lock may still be held on the database file
6393 ** after a successful return.
6395 rc = sqlite3PagerCloseWal(pPager, db);
6396 if( rc==SQLITE_OK ){
6397 sqlite3PagerSetJournalMode(pPager, eNew);
6399 }else if( eOld==PAGER_JOURNALMODE_MEMORY ){
6400 /* Cannot transition directly from MEMORY to WAL. Use mode OFF
6401 ** as an intermediate */
6402 sqlite3PagerSetJournalMode(pPager, PAGER_JOURNALMODE_OFF);
6405 /* Open a transaction on the database file. Regardless of the journal
6406 ** mode, this transaction always uses a rollback journal.
6408 assert( sqlite3BtreeIsInTrans(pBt)==0 );
6409 if( rc==SQLITE_OK ){
6410 rc = sqlite3BtreeSetVersion(pBt, (eNew==PAGER_JOURNALMODE_WAL ? 2 : 1));
6414 #endif /* ifndef SQLITE_OMIT_WAL */
6416 if( rc ) eNew = eOld;
6417 eNew = sqlite3PagerSetJournalMode(pPager, eNew);
6419 pOut->flags = MEM_Str|MEM_Static|MEM_Term;
6420 pOut->z = (char *)sqlite3JournalModename(eNew);
6421 pOut->n = sqlite3Strlen30(pOut->z);
6422 pOut->enc = SQLITE_UTF8;
6423 sqlite3VdbeChangeEncoding(pOut, encoding);
6424 if( rc ) goto abort_due_to_error;
6425 break;
6427 #endif /* SQLITE_OMIT_PRAGMA */
6429 #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
6430 /* Opcode: Vacuum P1 * * * *
6432 ** Vacuum the entire database P1. P1 is 0 for "main", and 2 or more
6433 ** for an attached database. The "temp" database may not be vacuumed.
6435 case OP_Vacuum: {
6436 assert( p->readOnly==0 );
6437 rc = sqlite3RunVacuum(&p->zErrMsg, db, pOp->p1);
6438 if( rc ) goto abort_due_to_error;
6439 break;
6441 #endif
6443 #if !defined(SQLITE_OMIT_AUTOVACUUM)
6444 /* Opcode: IncrVacuum P1 P2 * * *
6446 ** Perform a single step of the incremental vacuum procedure on
6447 ** the P1 database. If the vacuum has finished, jump to instruction
6448 ** P2. Otherwise, fall through to the next instruction.
6450 case OP_IncrVacuum: { /* jump */
6451 Btree *pBt;
6453 assert( pOp->p1>=0 && pOp->p1<db->nDb );
6454 assert( DbMaskTest(p->btreeMask, pOp->p1) );
6455 assert( p->readOnly==0 );
6456 pBt = db->aDb[pOp->p1].pBt;
6457 rc = sqlite3BtreeIncrVacuum(pBt);
6458 VdbeBranchTaken(rc==SQLITE_DONE,2);
6459 if( rc ){
6460 if( rc!=SQLITE_DONE ) goto abort_due_to_error;
6461 rc = SQLITE_OK;
6462 goto jump_to_p2;
6464 break;
6466 #endif
6468 /* Opcode: Expire P1 * * * *
6470 ** Cause precompiled statements to expire. When an expired statement
6471 ** is executed using sqlite3_step() it will either automatically
6472 ** reprepare itself (if it was originally created using sqlite3_prepare_v2())
6473 ** or it will fail with SQLITE_SCHEMA.
6475 ** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
6476 ** then only the currently executing statement is expired.
6478 case OP_Expire: {
6479 if( !pOp->p1 ){
6480 sqlite3ExpirePreparedStatements(db);
6481 }else{
6482 p->expired = 1;
6484 break;
6487 #ifndef SQLITE_OMIT_SHARED_CACHE
6488 /* Opcode: TableLock P1 P2 P3 P4 *
6489 ** Synopsis: iDb=P1 root=P2 write=P3
6491 ** Obtain a lock on a particular table. This instruction is only used when
6492 ** the shared-cache feature is enabled.
6494 ** P1 is the index of the database in sqlite3.aDb[] of the database
6495 ** on which the lock is acquired. A readlock is obtained if P3==0 or
6496 ** a write lock if P3==1.
6498 ** P2 contains the root-page of the table to lock.
6500 ** P4 contains a pointer to the name of the table being locked. This is only
6501 ** used to generate an error message if the lock cannot be obtained.
6503 case OP_TableLock: {
6504 u8 isWriteLock = (u8)pOp->p3;
6505 if( isWriteLock || 0==(db->flags&SQLITE_ReadUncommit) ){
6506 int p1 = pOp->p1;
6507 assert( p1>=0 && p1<db->nDb );
6508 assert( DbMaskTest(p->btreeMask, p1) );
6509 assert( isWriteLock==0 || isWriteLock==1 );
6510 rc = sqlite3BtreeLockTable(db->aDb[p1].pBt, pOp->p2, isWriteLock);
6511 if( rc ){
6512 if( (rc&0xFF)==SQLITE_LOCKED ){
6513 const char *z = pOp->p4.z;
6514 sqlite3VdbeError(p, "database table is locked: %s", z);
6516 goto abort_due_to_error;
6519 break;
6521 #endif /* SQLITE_OMIT_SHARED_CACHE */
6523 #ifndef SQLITE_OMIT_VIRTUALTABLE
6524 /* Opcode: VBegin * * * P4 *
6526 ** P4 may be a pointer to an sqlite3_vtab structure. If so, call the
6527 ** xBegin method for that table.
6529 ** Also, whether or not P4 is set, check that this is not being called from
6530 ** within a callback to a virtual table xSync() method. If it is, the error
6531 ** code will be set to SQLITE_LOCKED.
6533 case OP_VBegin: {
6534 VTable *pVTab;
6535 pVTab = pOp->p4.pVtab;
6536 rc = sqlite3VtabBegin(db, pVTab);
6537 if( pVTab ) sqlite3VtabImportErrmsg(p, pVTab->pVtab);
6538 if( rc ) goto abort_due_to_error;
6539 break;
6541 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6543 #ifndef SQLITE_OMIT_VIRTUALTABLE
6544 /* Opcode: VCreate P1 P2 * * *
6546 ** P2 is a register that holds the name of a virtual table in database
6547 ** P1. Call the xCreate method for that table.
6549 case OP_VCreate: {
6550 Mem sMem; /* For storing the record being decoded */
6551 const char *zTab; /* Name of the virtual table */
6553 memset(&sMem, 0, sizeof(sMem));
6554 sMem.db = db;
6555 /* Because P2 is always a static string, it is impossible for the
6556 ** sqlite3VdbeMemCopy() to fail */
6557 assert( (aMem[pOp->p2].flags & MEM_Str)!=0 );
6558 assert( (aMem[pOp->p2].flags & MEM_Static)!=0 );
6559 rc = sqlite3VdbeMemCopy(&sMem, &aMem[pOp->p2]);
6560 assert( rc==SQLITE_OK );
6561 zTab = (const char*)sqlite3_value_text(&sMem);
6562 assert( zTab || db->mallocFailed );
6563 if( zTab ){
6564 rc = sqlite3VtabCallCreate(db, pOp->p1, zTab, &p->zErrMsg);
6566 sqlite3VdbeMemRelease(&sMem);
6567 if( rc ) goto abort_due_to_error;
6568 break;
6570 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6572 #ifndef SQLITE_OMIT_VIRTUALTABLE
6573 /* Opcode: VDestroy P1 * * P4 *
6575 ** P4 is the name of a virtual table in database P1. Call the xDestroy method
6576 ** of that table.
6578 case OP_VDestroy: {
6579 db->nVDestroy++;
6580 rc = sqlite3VtabCallDestroy(db, pOp->p1, pOp->p4.z);
6581 db->nVDestroy--;
6582 if( rc ) goto abort_due_to_error;
6583 break;
6585 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6587 #ifndef SQLITE_OMIT_VIRTUALTABLE
6588 /* Opcode: VOpen P1 * * P4 *
6590 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6591 ** P1 is a cursor number. This opcode opens a cursor to the virtual
6592 ** table and stores that cursor in P1.
6594 case OP_VOpen: {
6595 VdbeCursor *pCur;
6596 sqlite3_vtab_cursor *pVCur;
6597 sqlite3_vtab *pVtab;
6598 const sqlite3_module *pModule;
6600 assert( p->bIsReader );
6601 pCur = 0;
6602 pVCur = 0;
6603 pVtab = pOp->p4.pVtab->pVtab;
6604 if( pVtab==0 || NEVER(pVtab->pModule==0) ){
6605 rc = SQLITE_LOCKED;
6606 goto abort_due_to_error;
6608 pModule = pVtab->pModule;
6609 rc = pModule->xOpen(pVtab, &pVCur);
6610 sqlite3VtabImportErrmsg(p, pVtab);
6611 if( rc ) goto abort_due_to_error;
6613 /* Initialize sqlite3_vtab_cursor base class */
6614 pVCur->pVtab = pVtab;
6616 /* Initialize vdbe cursor object */
6617 pCur = allocateCursor(p, pOp->p1, 0, -1, CURTYPE_VTAB);
6618 if( pCur ){
6619 pCur->uc.pVCur = pVCur;
6620 pVtab->nRef++;
6621 }else{
6622 assert( db->mallocFailed );
6623 pModule->xClose(pVCur);
6624 goto no_mem;
6626 break;
6628 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6630 #ifndef SQLITE_OMIT_VIRTUALTABLE
6631 /* Opcode: VFilter P1 P2 P3 P4 *
6632 ** Synopsis: iplan=r[P3] zplan='P4'
6634 ** P1 is a cursor opened using VOpen. P2 is an address to jump to if
6635 ** the filtered result set is empty.
6637 ** P4 is either NULL or a string that was generated by the xBestIndex
6638 ** method of the module. The interpretation of the P4 string is left
6639 ** to the module implementation.
6641 ** This opcode invokes the xFilter method on the virtual table specified
6642 ** by P1. The integer query plan parameter to xFilter is stored in register
6643 ** P3. Register P3+1 stores the argc parameter to be passed to the
6644 ** xFilter method. Registers P3+2..P3+1+argc are the argc
6645 ** additional parameters which are passed to
6646 ** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
6648 ** A jump is made to P2 if the result set after filtering would be empty.
6650 case OP_VFilter: { /* jump */
6651 int nArg;
6652 int iQuery;
6653 const sqlite3_module *pModule;
6654 Mem *pQuery;
6655 Mem *pArgc;
6656 sqlite3_vtab_cursor *pVCur;
6657 sqlite3_vtab *pVtab;
6658 VdbeCursor *pCur;
6659 int res;
6660 int i;
6661 Mem **apArg;
6663 pQuery = &aMem[pOp->p3];
6664 pArgc = &pQuery[1];
6665 pCur = p->apCsr[pOp->p1];
6666 assert( memIsValid(pQuery) );
6667 REGISTER_TRACE(pOp->p3, pQuery);
6668 assert( pCur->eCurType==CURTYPE_VTAB );
6669 pVCur = pCur->uc.pVCur;
6670 pVtab = pVCur->pVtab;
6671 pModule = pVtab->pModule;
6673 /* Grab the index number and argc parameters */
6674 assert( (pQuery->flags&MEM_Int)!=0 && pArgc->flags==MEM_Int );
6675 nArg = (int)pArgc->u.i;
6676 iQuery = (int)pQuery->u.i;
6678 /* Invoke the xFilter method */
6679 res = 0;
6680 apArg = p->apArg;
6681 for(i = 0; i<nArg; i++){
6682 apArg[i] = &pArgc[i+1];
6684 rc = pModule->xFilter(pVCur, iQuery, pOp->p4.z, nArg, apArg);
6685 sqlite3VtabImportErrmsg(p, pVtab);
6686 if( rc ) goto abort_due_to_error;
6687 res = pModule->xEof(pVCur);
6688 pCur->nullRow = 0;
6689 VdbeBranchTaken(res!=0,2);
6690 if( res ) goto jump_to_p2;
6691 break;
6693 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6695 #ifndef SQLITE_OMIT_VIRTUALTABLE
6696 /* Opcode: VColumn P1 P2 P3 * *
6697 ** Synopsis: r[P3]=vcolumn(P2)
6699 ** Store the value of the P2-th column of
6700 ** the row of the virtual-table that the
6701 ** P1 cursor is pointing to into register P3.
6703 case OP_VColumn: {
6704 sqlite3_vtab *pVtab;
6705 const sqlite3_module *pModule;
6706 Mem *pDest;
6707 sqlite3_context sContext;
6709 VdbeCursor *pCur = p->apCsr[pOp->p1];
6710 assert( pCur->eCurType==CURTYPE_VTAB );
6711 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
6712 pDest = &aMem[pOp->p3];
6713 memAboutToChange(p, pDest);
6714 if( pCur->nullRow ){
6715 sqlite3VdbeMemSetNull(pDest);
6716 break;
6718 pVtab = pCur->uc.pVCur->pVtab;
6719 pModule = pVtab->pModule;
6720 assert( pModule->xColumn );
6721 memset(&sContext, 0, sizeof(sContext));
6722 sContext.pOut = pDest;
6723 MemSetTypeFlag(pDest, MEM_Null);
6724 rc = pModule->xColumn(pCur->uc.pVCur, &sContext, pOp->p2);
6725 sqlite3VtabImportErrmsg(p, pVtab);
6726 if( sContext.isError ){
6727 rc = sContext.isError;
6729 sqlite3VdbeChangeEncoding(pDest, encoding);
6730 REGISTER_TRACE(pOp->p3, pDest);
6731 UPDATE_MAX_BLOBSIZE(pDest);
6733 if( sqlite3VdbeMemTooBig(pDest) ){
6734 goto too_big;
6736 if( rc ) goto abort_due_to_error;
6737 break;
6739 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6741 #ifndef SQLITE_OMIT_VIRTUALTABLE
6742 /* Opcode: VNext P1 P2 * * *
6744 ** Advance virtual table P1 to the next row in its result set and
6745 ** jump to instruction P2. Or, if the virtual table has reached
6746 ** the end of its result set, then fall through to the next instruction.
6748 case OP_VNext: { /* jump */
6749 sqlite3_vtab *pVtab;
6750 const sqlite3_module *pModule;
6751 int res;
6752 VdbeCursor *pCur;
6754 res = 0;
6755 pCur = p->apCsr[pOp->p1];
6756 assert( pCur->eCurType==CURTYPE_VTAB );
6757 if( pCur->nullRow ){
6758 break;
6760 pVtab = pCur->uc.pVCur->pVtab;
6761 pModule = pVtab->pModule;
6762 assert( pModule->xNext );
6764 /* Invoke the xNext() method of the module. There is no way for the
6765 ** underlying implementation to return an error if one occurs during
6766 ** xNext(). Instead, if an error occurs, true is returned (indicating that
6767 ** data is available) and the error code returned when xColumn or
6768 ** some other method is next invoked on the save virtual table cursor.
6770 rc = pModule->xNext(pCur->uc.pVCur);
6771 sqlite3VtabImportErrmsg(p, pVtab);
6772 if( rc ) goto abort_due_to_error;
6773 res = pModule->xEof(pCur->uc.pVCur);
6774 VdbeBranchTaken(!res,2);
6775 if( !res ){
6776 /* If there is data, jump to P2 */
6777 goto jump_to_p2_and_check_for_interrupt;
6779 goto check_for_interrupt;
6781 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6783 #ifndef SQLITE_OMIT_VIRTUALTABLE
6784 /* Opcode: VRename P1 * * P4 *
6786 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6787 ** This opcode invokes the corresponding xRename method. The value
6788 ** in register P1 is passed as the zName argument to the xRename method.
6790 case OP_VRename: {
6791 sqlite3_vtab *pVtab;
6792 Mem *pName;
6794 pVtab = pOp->p4.pVtab->pVtab;
6795 pName = &aMem[pOp->p1];
6796 assert( pVtab->pModule->xRename );
6797 assert( memIsValid(pName) );
6798 assert( p->readOnly==0 );
6799 REGISTER_TRACE(pOp->p1, pName);
6800 assert( pName->flags & MEM_Str );
6801 testcase( pName->enc==SQLITE_UTF8 );
6802 testcase( pName->enc==SQLITE_UTF16BE );
6803 testcase( pName->enc==SQLITE_UTF16LE );
6804 rc = sqlite3VdbeChangeEncoding(pName, SQLITE_UTF8);
6805 if( rc ) goto abort_due_to_error;
6806 rc = pVtab->pModule->xRename(pVtab, pName->z);
6807 sqlite3VtabImportErrmsg(p, pVtab);
6808 p->expired = 0;
6809 if( rc ) goto abort_due_to_error;
6810 break;
6812 #endif
6814 #ifndef SQLITE_OMIT_VIRTUALTABLE
6815 /* Opcode: VUpdate P1 P2 P3 P4 P5
6816 ** Synopsis: data=r[P3@P2]
6818 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6819 ** This opcode invokes the corresponding xUpdate method. P2 values
6820 ** are contiguous memory cells starting at P3 to pass to the xUpdate
6821 ** invocation. The value in register (P3+P2-1) corresponds to the
6822 ** p2th element of the argv array passed to xUpdate.
6824 ** The xUpdate method will do a DELETE or an INSERT or both.
6825 ** The argv[0] element (which corresponds to memory cell P3)
6826 ** is the rowid of a row to delete. If argv[0] is NULL then no
6827 ** deletion occurs. The argv[1] element is the rowid of the new
6828 ** row. This can be NULL to have the virtual table select the new
6829 ** rowid for itself. The subsequent elements in the array are
6830 ** the values of columns in the new row.
6832 ** If P2==1 then no insert is performed. argv[0] is the rowid of
6833 ** a row to delete.
6835 ** P1 is a boolean flag. If it is set to true and the xUpdate call
6836 ** is successful, then the value returned by sqlite3_last_insert_rowid()
6837 ** is set to the value of the rowid for the row just inserted.
6839 ** P5 is the error actions (OE_Replace, OE_Fail, OE_Ignore, etc) to
6840 ** apply in the case of a constraint failure on an insert or update.
6842 case OP_VUpdate: {
6843 sqlite3_vtab *pVtab;
6844 const sqlite3_module *pModule;
6845 int nArg;
6846 int i;
6847 sqlite_int64 rowid;
6848 Mem **apArg;
6849 Mem *pX;
6851 assert( pOp->p2==1 || pOp->p5==OE_Fail || pOp->p5==OE_Rollback
6852 || pOp->p5==OE_Abort || pOp->p5==OE_Ignore || pOp->p5==OE_Replace
6854 assert( p->readOnly==0 );
6855 pVtab = pOp->p4.pVtab->pVtab;
6856 if( pVtab==0 || NEVER(pVtab->pModule==0) ){
6857 rc = SQLITE_LOCKED;
6858 goto abort_due_to_error;
6860 pModule = pVtab->pModule;
6861 nArg = pOp->p2;
6862 assert( pOp->p4type==P4_VTAB );
6863 if( ALWAYS(pModule->xUpdate) ){
6864 u8 vtabOnConflict = db->vtabOnConflict;
6865 apArg = p->apArg;
6866 pX = &aMem[pOp->p3];
6867 for(i=0; i<nArg; i++){
6868 assert( memIsValid(pX) );
6869 memAboutToChange(p, pX);
6870 apArg[i] = pX;
6871 pX++;
6873 db->vtabOnConflict = pOp->p5;
6874 rc = pModule->xUpdate(pVtab, nArg, apArg, &rowid);
6875 db->vtabOnConflict = vtabOnConflict;
6876 sqlite3VtabImportErrmsg(p, pVtab);
6877 if( rc==SQLITE_OK && pOp->p1 ){
6878 assert( nArg>1 && apArg[0] && (apArg[0]->flags&MEM_Null) );
6879 db->lastRowid = rowid;
6881 if( (rc&0xff)==SQLITE_CONSTRAINT && pOp->p4.pVtab->bConstraint ){
6882 if( pOp->p5==OE_Ignore ){
6883 rc = SQLITE_OK;
6884 }else{
6885 p->errorAction = ((pOp->p5==OE_Replace) ? OE_Abort : pOp->p5);
6887 }else{
6888 p->nChange++;
6890 if( rc ) goto abort_due_to_error;
6892 break;
6894 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6896 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
6897 /* Opcode: Pagecount P1 P2 * * *
6899 ** Write the current number of pages in database P1 to memory cell P2.
6901 case OP_Pagecount: { /* out2 */
6902 pOut = out2Prerelease(p, pOp);
6903 pOut->u.i = sqlite3BtreeLastPage(db->aDb[pOp->p1].pBt);
6904 break;
6906 #endif
6909 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
6910 /* Opcode: MaxPgcnt P1 P2 P3 * *
6912 ** Try to set the maximum page count for database P1 to the value in P3.
6913 ** Do not let the maximum page count fall below the current page count and
6914 ** do not change the maximum page count value if P3==0.
6916 ** Store the maximum page count after the change in register P2.
6918 case OP_MaxPgcnt: { /* out2 */
6919 unsigned int newMax;
6920 Btree *pBt;
6922 pOut = out2Prerelease(p, pOp);
6923 pBt = db->aDb[pOp->p1].pBt;
6924 newMax = 0;
6925 if( pOp->p3 ){
6926 newMax = sqlite3BtreeLastPage(pBt);
6927 if( newMax < (unsigned)pOp->p3 ) newMax = (unsigned)pOp->p3;
6929 pOut->u.i = sqlite3BtreeMaxPageCount(pBt, newMax);
6930 break;
6932 #endif
6934 /* Opcode: Function0 P1 P2 P3 P4 P5
6935 ** Synopsis: r[P3]=func(r[P2@P5])
6937 ** Invoke a user function (P4 is a pointer to a FuncDef object that
6938 ** defines the function) with P5 arguments taken from register P2 and
6939 ** successors. The result of the function is stored in register P3.
6940 ** Register P3 must not be one of the function inputs.
6942 ** P1 is a 32-bit bitmask indicating whether or not each argument to the
6943 ** function was determined to be constant at compile time. If the first
6944 ** argument was constant then bit 0 of P1 is set. This is used to determine
6945 ** whether meta data associated with a user function argument using the
6946 ** sqlite3_set_auxdata() API may be safely retained until the next
6947 ** invocation of this opcode.
6949 ** See also: Function, AggStep, AggFinal
6951 /* Opcode: Function P1 P2 P3 P4 P5
6952 ** Synopsis: r[P3]=func(r[P2@P5])
6954 ** Invoke a user function (P4 is a pointer to an sqlite3_context object that
6955 ** contains a pointer to the function to be run) with P5 arguments taken
6956 ** from register P2 and successors. The result of the function is stored
6957 ** in register P3. Register P3 must not be one of the function inputs.
6959 ** P1 is a 32-bit bitmask indicating whether or not each argument to the
6960 ** function was determined to be constant at compile time. If the first
6961 ** argument was constant then bit 0 of P1 is set. This is used to determine
6962 ** whether meta data associated with a user function argument using the
6963 ** sqlite3_set_auxdata() API may be safely retained until the next
6964 ** invocation of this opcode.
6966 ** SQL functions are initially coded as OP_Function0 with P4 pointing
6967 ** to a FuncDef object. But on first evaluation, the P4 operand is
6968 ** automatically converted into an sqlite3_context object and the operation
6969 ** changed to this OP_Function opcode. In this way, the initialization of
6970 ** the sqlite3_context object occurs only once, rather than once for each
6971 ** evaluation of the function.
6973 ** See also: Function0, AggStep, AggFinal
6975 case OP_PureFunc0:
6976 case OP_Function0: {
6977 int n;
6978 sqlite3_context *pCtx;
6980 assert( pOp->p4type==P4_FUNCDEF );
6981 n = pOp->p5;
6982 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
6983 assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
6984 assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
6985 pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
6986 if( pCtx==0 ) goto no_mem;
6987 pCtx->pOut = 0;
6988 pCtx->pFunc = pOp->p4.pFunc;
6989 pCtx->iOp = (int)(pOp - aOp);
6990 pCtx->pVdbe = p;
6991 pCtx->argc = n;
6992 pOp->p4type = P4_FUNCCTX;
6993 pOp->p4.pCtx = pCtx;
6994 assert( OP_PureFunc == OP_PureFunc0+2 );
6995 assert( OP_Function == OP_Function0+2 );
6996 pOp->opcode += 2;
6997 /* Fall through into OP_Function */
6999 case OP_PureFunc:
7000 case OP_Function: {
7001 int i;
7002 sqlite3_context *pCtx;
7004 assert( pOp->p4type==P4_FUNCCTX );
7005 pCtx = pOp->p4.pCtx;
7007 /* If this function is inside of a trigger, the register array in aMem[]
7008 ** might change from one evaluation to the next. The next block of code
7009 ** checks to see if the register array has changed, and if so it
7010 ** reinitializes the relavant parts of the sqlite3_context object */
7011 pOut = &aMem[pOp->p3];
7012 if( pCtx->pOut != pOut ){
7013 pCtx->pOut = pOut;
7014 for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
7017 memAboutToChange(p, pOut);
7018 #ifdef SQLITE_DEBUG
7019 for(i=0; i<pCtx->argc; i++){
7020 assert( memIsValid(pCtx->argv[i]) );
7021 REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
7023 #endif
7024 MemSetTypeFlag(pOut, MEM_Null);
7025 pCtx->fErrorOrAux = 0;
7026 (*pCtx->pFunc->xSFunc)(pCtx, pCtx->argc, pCtx->argv);/* IMP: R-24505-23230 */
7028 /* If the function returned an error, throw an exception */
7029 if( pCtx->fErrorOrAux ){
7030 if( pCtx->isError ){
7031 sqlite3VdbeError(p, "%s", sqlite3_value_text(pOut));
7032 rc = pCtx->isError;
7034 sqlite3VdbeDeleteAuxData(db, &p->pAuxData, pCtx->iOp, pOp->p1);
7035 if( rc ) goto abort_due_to_error;
7038 /* Copy the result of the function into register P3 */
7039 if( pOut->flags & (MEM_Str|MEM_Blob) ){
7040 sqlite3VdbeChangeEncoding(pOut, encoding);
7041 if( sqlite3VdbeMemTooBig(pOut) ) goto too_big;
7044 REGISTER_TRACE(pOp->p3, pOut);
7045 UPDATE_MAX_BLOBSIZE(pOut);
7046 break;
7049 /* Opcode: Trace P1 P2 * P4 *
7051 ** Write P4 on the statement trace output if statement tracing is
7052 ** enabled.
7054 ** Operand P1 must be 0x7fffffff and P2 must positive.
7056 /* Opcode: Init P1 P2 P3 P4 *
7057 ** Synopsis: Start at P2
7059 ** Programs contain a single instance of this opcode as the very first
7060 ** opcode.
7062 ** If tracing is enabled (by the sqlite3_trace()) interface, then
7063 ** the UTF-8 string contained in P4 is emitted on the trace callback.
7064 ** Or if P4 is blank, use the string returned by sqlite3_sql().
7066 ** If P2 is not zero, jump to instruction P2.
7068 ** Increment the value of P1 so that OP_Once opcodes will jump the
7069 ** first time they are evaluated for this run.
7071 ** If P3 is not zero, then it is an address to jump to if an SQLITE_CORRUPT
7072 ** error is encountered.
7074 case OP_Trace:
7075 case OP_Init: { /* jump */
7076 char *zTrace;
7077 int i;
7079 /* If the P4 argument is not NULL, then it must be an SQL comment string.
7080 ** The "--" string is broken up to prevent false-positives with srcck1.c.
7082 ** This assert() provides evidence for:
7083 ** EVIDENCE-OF: R-50676-09860 The callback can compute the same text that
7084 ** would have been returned by the legacy sqlite3_trace() interface by
7085 ** using the X argument when X begins with "--" and invoking
7086 ** sqlite3_expanded_sql(P) otherwise.
7088 assert( pOp->p4.z==0 || strncmp(pOp->p4.z, "-" "- ", 3)==0 );
7090 /* OP_Init is always instruction 0 */
7091 assert( pOp==p->aOp || pOp->opcode==OP_Trace );
7093 #ifndef SQLITE_OMIT_TRACE
7094 if( (db->mTrace & (SQLITE_TRACE_STMT|SQLITE_TRACE_LEGACY))!=0
7095 && !p->doingRerun
7096 && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
7098 #ifndef SQLITE_OMIT_DEPRECATED
7099 if( db->mTrace & SQLITE_TRACE_LEGACY ){
7100 void (*x)(void*,const char*) = (void(*)(void*,const char*))db->xTrace;
7101 char *z = sqlite3VdbeExpandSql(p, zTrace);
7102 x(db->pTraceArg, z);
7103 sqlite3_free(z);
7104 }else
7105 #endif
7106 if( db->nVdbeExec>1 ){
7107 char *z = sqlite3MPrintf(db, "-- %s", zTrace);
7108 (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, z);
7109 sqlite3DbFree(db, z);
7110 }else{
7111 (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, zTrace);
7114 #ifdef SQLITE_USE_FCNTL_TRACE
7115 zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql);
7116 if( zTrace ){
7117 int j;
7118 for(j=0; j<db->nDb; j++){
7119 if( DbMaskTest(p->btreeMask, j)==0 ) continue;
7120 sqlite3_file_control(db, db->aDb[j].zDbSName, SQLITE_FCNTL_TRACE, zTrace);
7123 #endif /* SQLITE_USE_FCNTL_TRACE */
7124 #ifdef SQLITE_DEBUG
7125 if( (db->flags & SQLITE_SqlTrace)!=0
7126 && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
7128 sqlite3DebugPrintf("SQL-trace: %s\n", zTrace);
7130 #endif /* SQLITE_DEBUG */
7131 #endif /* SQLITE_OMIT_TRACE */
7132 assert( pOp->p2>0 );
7133 if( pOp->p1>=sqlite3GlobalConfig.iOnceResetThreshold ){
7134 if( pOp->opcode==OP_Trace ) break;
7135 for(i=1; i<p->nOp; i++){
7136 if( p->aOp[i].opcode==OP_Once ) p->aOp[i].p1 = 0;
7138 pOp->p1 = 0;
7140 pOp->p1++;
7141 p->aCounter[SQLITE_STMTSTATUS_RUN]++;
7142 goto jump_to_p2;
7145 #ifdef SQLITE_ENABLE_CURSOR_HINTS
7146 /* Opcode: CursorHint P1 * * P4 *
7148 ** Provide a hint to cursor P1 that it only needs to return rows that
7149 ** satisfy the Expr in P4. TK_REGISTER terms in the P4 expression refer
7150 ** to values currently held in registers. TK_COLUMN terms in the P4
7151 ** expression refer to columns in the b-tree to which cursor P1 is pointing.
7153 case OP_CursorHint: {
7154 VdbeCursor *pC;
7156 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
7157 assert( pOp->p4type==P4_EXPR );
7158 pC = p->apCsr[pOp->p1];
7159 if( pC ){
7160 assert( pC->eCurType==CURTYPE_BTREE );
7161 sqlite3BtreeCursorHint(pC->uc.pCursor, BTREE_HINT_RANGE,
7162 pOp->p4.pExpr, aMem);
7164 break;
7166 #endif /* SQLITE_ENABLE_CURSOR_HINTS */
7168 /* Opcode: Noop * * * * *
7170 ** Do nothing. This instruction is often useful as a jump
7171 ** destination.
7174 ** The magic Explain opcode are only inserted when explain==2 (which
7175 ** is to say when the EXPLAIN QUERY PLAN syntax is used.)
7176 ** This opcode records information from the optimizer. It is the
7177 ** the same as a no-op. This opcodesnever appears in a real VM program.
7179 default: { /* This is really OP_Noop and OP_Explain */
7180 assert( pOp->opcode==OP_Noop || pOp->opcode==OP_Explain );
7181 break;
7184 /*****************************************************************************
7185 ** The cases of the switch statement above this line should all be indented
7186 ** by 6 spaces. But the left-most 6 spaces have been removed to improve the
7187 ** readability. From this point on down, the normal indentation rules are
7188 ** restored.
7189 *****************************************************************************/
7192 #ifdef VDBE_PROFILE
7194 u64 endTime = sqlite3Hwtime();
7195 if( endTime>start ) pOrigOp->cycles += endTime - start;
7196 pOrigOp->cnt++;
7198 #endif
7200 /* The following code adds nothing to the actual functionality
7201 ** of the program. It is only here for testing and debugging.
7202 ** On the other hand, it does burn CPU cycles every time through
7203 ** the evaluator loop. So we can leave it out when NDEBUG is defined.
7205 #ifndef NDEBUG
7206 assert( pOp>=&aOp[-1] && pOp<&aOp[p->nOp-1] );
7208 #ifdef SQLITE_DEBUG
7209 if( db->flags & SQLITE_VdbeTrace ){
7210 u8 opProperty = sqlite3OpcodeProperty[pOrigOp->opcode];
7211 if( rc!=0 ) printf("rc=%d\n",rc);
7212 if( opProperty & (OPFLG_OUT2) ){
7213 registerTrace(pOrigOp->p2, &aMem[pOrigOp->p2]);
7215 if( opProperty & OPFLG_OUT3 ){
7216 registerTrace(pOrigOp->p3, &aMem[pOrigOp->p3]);
7219 #endif /* SQLITE_DEBUG */
7220 #endif /* NDEBUG */
7221 } /* The end of the for(;;) loop the loops through opcodes */
7223 /* If we reach this point, it means that execution is finished with
7224 ** an error of some kind.
7226 abort_due_to_error:
7227 if( db->mallocFailed ) rc = SQLITE_NOMEM_BKPT;
7228 assert( rc );
7229 if( p->zErrMsg==0 && rc!=SQLITE_IOERR_NOMEM ){
7230 sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
7232 p->rc = rc;
7233 sqlite3SystemError(db, rc);
7234 testcase( sqlite3GlobalConfig.xLog!=0 );
7235 sqlite3_log(rc, "statement aborts at %d: [%s] %s",
7236 (int)(pOp - aOp), p->zSql, p->zErrMsg);
7237 sqlite3VdbeHalt(p);
7238 if( rc==SQLITE_IOERR_NOMEM ) sqlite3OomFault(db);
7239 rc = SQLITE_ERROR;
7240 if( resetSchemaOnFault>0 ){
7241 sqlite3ResetOneSchema(db, resetSchemaOnFault-1);
7244 /* This is the only way out of this procedure. We have to
7245 ** release the mutexes on btrees that were acquired at the
7246 ** top. */
7247 vdbe_return:
7248 testcase( nVmStep>0 );
7249 p->aCounter[SQLITE_STMTSTATUS_VM_STEP] += (int)nVmStep;
7250 sqlite3VdbeLeave(p);
7251 assert( rc!=SQLITE_OK || nExtraDelete==0
7252 || sqlite3_strlike("DELETE%",p->zSql,0)!=0
7254 return rc;
7256 /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
7257 ** is encountered.
7259 too_big:
7260 sqlite3VdbeError(p, "string or blob too big");
7261 rc = SQLITE_TOOBIG;
7262 goto abort_due_to_error;
7264 /* Jump to here if a malloc() fails.
7266 no_mem:
7267 sqlite3OomFault(db);
7268 sqlite3VdbeError(p, "out of memory");
7269 rc = SQLITE_NOMEM_BKPT;
7270 goto abort_due_to_error;
7272 /* Jump to here if the sqlite3_interrupt() API sets the interrupt
7273 ** flag.
7275 abort_due_to_interrupt:
7276 assert( db->u1.isInterrupted );
7277 rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_INTERRUPT;
7278 p->rc = rc;
7279 sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
7280 goto abort_due_to_error;