4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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"
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.
34 # define memAboutToChange(P,M) sqlite3VdbeMemAboutToChange(P,M)
36 # define memAboutToChange(P,M)
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.
47 int sqlite3_search_count
= 0;
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.
59 int sqlite3_interrupt_count
= 0;
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
70 int sqlite3_sort_count
= 0;
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.
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
;
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)
96 # define HAS_UPDATE_HOOK(DB) ((DB)->xUpdateCallback)
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
107 int sqlite3_found_count
= 0;
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)
117 # define UPDATE_MAX_BLOBSIZE(P)
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)
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) ){
143 /* Assert the truth of VdbeCoverageAlwaysTaken() and
144 ** VdbeCoverageNeverTaken() */
145 assert( (M
& I
)==I
);
147 if( sqlite3GlobalConfig
.xVdbeBranch
==0 ) return; /*NO_TEST*/
148 sqlite3GlobalConfig
.xVdbeBranch(sqlite3GlobalConfig
.pVdbeBranchArg
,
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)) \
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
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
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
;
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
]);
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
;
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
);
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
){
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
) ){
261 pRec
->flags
|= MEM_Int
;
264 pRec
->flags
|= MEM_Real
;
265 if( bTryForInt
) sqlite3VdbeIntegerAffinity(pRec
);
270 ** Processing is determine by the affinity parameter:
272 ** SQLITE_AFF_INTEGER:
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.
282 ** Convert pRec to a text representation.
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);
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
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
);
334 ** Exported version of applyAffinity(). This one works on sqlite3_value*,
335 ** not the internal Mem* type.
337 void sqlite3ValueApplyAffinity(
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
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 ){
357 if( sqlite3Atoi64(pMem
->z
, &pMem
->u
.i
, pMem
->n
, pMem
->enc
)==0 ){
364 ** Return the numeric type for pMem, either MEM_Int or MEM_Real or both or
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
);
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
){
389 static const char *const encnames
[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
396 assert( (f
& (MEM_Static
|MEM_Ephem
))==0 );
397 }else if( f
& MEM_Static
){
399 assert( (f
& (MEM_Dyn
|MEM_Ephem
))==0 );
400 }else if( f
& MEM_Ephem
){
402 assert( (f
& (MEM_Static
|MEM_Dyn
))==0 );
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
++){
415 if( z
<32 || z
>126 ) *zCsr
++ = '.';
420 sqlite3_snprintf(100, zCsr
,"+%dz",pMem
->u
.nZero
);
421 zCsr
+= sqlite3Strlen30(zCsr
);
424 }else if( f
& MEM_Str
){
429 assert( (f
& (MEM_Static
|MEM_Ephem
))==0 );
430 }else if( f
& MEM_Static
){
432 assert( (f
& (MEM_Dyn
|MEM_Ephem
))==0 );
433 }else if( f
& MEM_Ephem
){
435 assert( (f
& (MEM_Static
|MEM_Dyn
))==0 );
440 sqlite3_snprintf(100, &zBuf
[k
], "%d", pMem
->n
);
441 k
+= sqlite3Strlen30(&zBuf
[k
]);
443 for(j
=0; j
<15 && j
<pMem
->n
; j
++){
445 if( c
>=0x20 && c
<0x7f ){
452 sqlite3_snprintf(100,&zBuf
[k
], encnames
[pMem
->enc
]);
453 k
+= sqlite3Strlen30(&zBuf
[k
]);
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
){
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
);
476 }else if( p
->flags
& MEM_RowSet
){
480 sqlite3VdbeMemPrettyPrint(p
, 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
);
489 sqlite3VdbeCheckMemInvariants(p
);
494 # define REGISTER_TRACE(R,M) if(db->flags&SQLITE_VdbeTrace)registerTrace(R,M)
496 # define REGISTER_TRACE(R,M)
503 ** hwtime.h contains inline assembler code for implementing
504 ** high-performance timing routines.
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.
519 ** assert( checkSavepointCount(db) );
521 static int checkSavepointCount(sqlite3
*db
){
524 for(p
=db
->pSavepoint
; p
; p
=p
->pNext
) n
++;
525 assert( n
==(db
->nSavepoint
+ db
->isTransactionSavepoint
) );
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
;
539 static Mem
*out2Prerelease(Vdbe
*p
, VdbeOp
*pOp
){
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
);
548 pOut
->flags
= MEM_Int
;
555 ** Execute as much of a VDBE program as we can.
556 ** This is the core of sqlite3_step().
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 */
567 int nExtraDelete
= 0; /* Verifies FORDELETE and AUXDELETE flags */
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 */
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 */
584 u64 start
; /* CPU clock count at start of opcode */
586 /*** INSERT STACK UNION HERE ***/
588 assert( p
->magic
==VDBE_MAGIC_RUN
); /* sqlite3_step() verifies this */
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. */
595 assert( p
->rc
==SQLITE_OK
|| (p
->rc
&0xff)==SQLITE_BUSY
);
596 assert( p
->bIsReader
|| p
->readOnly
!=0 );
598 assert( p
->explain
==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
605 u32 iPrior
= p
->aCounter
[SQLITE_STMTSTATUS_VM_STEP
];
606 assert( 0 < db
->nProgressOps
);
607 nProgressLimit
= db
->nProgressOps
- (iPrior
% db
->nProgressOps
);
609 nProgressLimit
= 0xffffffff;
613 sqlite3BeginBenignMalloc();
615 && (p
->db
->flags
& (SQLITE_VdbeListing
|SQLITE_VdbeEQP
|SQLITE_VdbeTrace
))!=0
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
);
635 if( p
->db
->flags
& SQLITE_VdbeTrace
) printf("VDBE Trace:\n");
637 sqlite3EndBenignMalloc();
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
]);
646 start
= sqlite3Hwtime();
649 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
650 if( p
->anExec
) p
->anExec
[(int)(pOp
-aOp
)]++;
653 /* Only allow tracing if SQLITE_DEBUG is defined.
656 if( db
->flags
& SQLITE_VdbeTrace
){
657 sqlite3VdbePrintOp(stdout
, (int)(pOp
- aOp
), pOp
);
662 /* Check to see if we need to simulate an interrupt. This only happens
663 ** if we have a special test build.
666 if( sqlite3_interrupt_count
>0 ){
667 sqlite3_interrupt_count
--;
668 if( sqlite3_interrupt_count
==0 ){
669 sqlite3_interrupt(db
);
674 /* Sanity checking on other operands */
677 u8 opProperty
= sqlite3OpcodeProperty
[pOp
->opcode
];
678 if( (opProperty
& OPFLG_IN1
)!=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 ){
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 ){
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 ){
701 assert( pOp
->p2
<=(p
->nMem
+1 - p
->nCursor
) );
702 memAboutToChange(p
, &aMem
[pOp
->p2
]);
704 if( (opProperty
& OPFLG_OUT3
)!=0 ){
706 assert( pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
707 memAboutToChange(p
, &aMem
[pOp
->p3
]);
711 #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
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
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
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" */
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
;
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. */
817 pOp
= &aOp
[pOp
->p2
- 1];
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
;
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
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
;
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 */
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
;
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
889 ** See also: InitCoroutine
891 case OP_Yield
: { /* in1, jump */
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
);
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
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.
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
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.
951 pcx
= (int)(pOp
- aOp
);
952 if( pOp
->p1
==SQLITE_OK
&& p
->pFrame
){
953 /* Halt the sub-program. Return control to the parent frame. */
955 p
->pFrame
= pFrame
->pParent
;
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;
973 p
->errorAction
= (u8
)pOp
->p2
;
975 assert( pOp
->p5
<=4 );
978 static const char * const azType
[] = { "NOT NULL", "UNIQUE", "CHECK",
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]);
986 p
->zErrMsg
= sqlite3MPrintf(db
, "%z: %s", p
->zErrMsg
, pOp
->p4
.z
);
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
){
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
;
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
;
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
;
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
;
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 );
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
;
1075 testcase( rc
==SQLITE_TOOBIG
);
1077 if( pOp
->p1
>db
->aLimit
[SQLITE_LIMIT_LENGTH
] ){
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
;
1102 pOut
->enc
= encoding
;
1103 UPDATE_MAX_BLOBSIZE(pOut
);
1104 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
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
;
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
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
1127 case OP_Null
: { /* out2 */
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
;
1137 memAboutToChange(p
, pOut
);
1138 sqlite3VdbeMemSetNull(pOut
);
1139 pOut
->flags
= nullFlag
;
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.
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
;
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
);
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
) ){
1193 pOut
= &aMem
[pOp
->p2
];
1194 sqlite3VdbeMemShallowCopy(pOut
, pVar
, MEM_Static
);
1195 UPDATE_MAX_BLOBSIZE(pOut
);
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.
1209 int n
; /* Number of registers left to copy */
1210 int p1
; /* Register to copy from */
1211 int p2
; /* Register to copy to */
1216 assert( n
>0 && p1
>0 && p2
>0 );
1217 assert( p1
+n
<=p2
|| p2
+n
<=p1
);
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
);
1228 if( pOut
->pScopyFrom
>=&aMem
[p1
] && pOut
->pScopyFrom
<pOut
){
1229 pOut
->pScopyFrom
+= pOp
->p2
- p1
;
1232 Deephemeralize(pOut
);
1233 REGISTER_TRACE(p2
++, pOut
);
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.
1252 pIn1
= &aMem
[pOp
->p1
];
1253 pOut
= &aMem
[pOp
->p2
];
1254 assert( pOut
!=pIn1
);
1256 sqlite3VdbeMemShallowCopy(pOut
, pIn1
, MEM_Ephem
);
1257 Deephemeralize(pOut
);
1259 pOut
->pScopyFrom
= 0;
1261 REGISTER_TRACE(pOp
->p2
+pOp
->p3
-n
, pOut
);
1262 if( (n
--)==0 ) 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
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
);
1288 if( pOut
->pScopyFrom
==0 ) pOut
->pScopyFrom
= pIn1
;
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
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
);
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
1318 case OP_ResultRow
: {
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
;
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
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;
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.
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 */
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
);
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
] ){
1425 if( sqlite3VdbeMemGrow(pOut
, (int)nByte
+2, pOut
==pIn2
) ){
1428 MemSetTypeFlag(pOut
, MEM_Str
);
1430 memcpy(pOut
->z
, pIn2
->z
, pIn2
->n
);
1432 memcpy(&pOut
->z
[pIn2
->n
], pIn1
->z
, pIn1
->n
);
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
);
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 ){
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;
1509 if( iA
==0 ) goto arithmetic_result_is_null
;
1510 if( iA
==-1 && iB
==SMALLEST_INT64
) goto fp_math
;
1515 if( iA
==0 ) goto arithmetic_result_is_null
;
1516 if( iA
==-1 ) iA
= 1;
1522 MemSetTypeFlag(pOut
, MEM_Int
);
1523 }else if( (flags
& MEM_Null
)!=0 ){
1524 goto arithmetic_result_is_null
;
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;
1535 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
1536 if( rA
==(double)0 ) goto arithmetic_result_is_null
;
1543 if( iA
==0 ) goto arithmetic_result_is_null
;
1544 if( iA
==-1 ) iA
= 1;
1545 rB
= (double)(iB
% iA
);
1549 #ifdef SQLITE_OMIT_FLOATING_POINT
1551 MemSetTypeFlag(pOut
, MEM_Int
);
1553 if( sqlite3IsNaN(rB
) ){
1554 goto arithmetic_result_is_null
;
1557 MemSetTypeFlag(pOut
, MEM_Real
);
1558 if( ((type1
|type2
)&MEM_Real
)==0 && !bIntint
){
1559 sqlite3VdbeIntegerAffinity(pOut
);
1565 arithmetic_result_is_null
:
1566 sqlite3VdbeMemSetNull(pOut
);
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()
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.
1586 assert( pOp
->p4type
==P4_COLLSEQ
);
1588 sqlite3VdbeMemSetInt64(&aMem
[pOp
->p1
], 0);
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 */
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
);
1639 iA
= sqlite3VdbeIntValue(pIn2
);
1640 iB
= sqlite3VdbeIntValue(pIn1
);
1642 if( op
==OP_BitAnd
){
1644 }else if( op
==OP_BitOr
){
1647 assert( op
==OP_ShiftRight
|| op
==OP_ShiftLeft
);
1649 /* If shifting by a negative amount, shift in the other direction */
1651 assert( OP_ShiftRight
==OP_ShiftLeft
+1 );
1652 op
= 2*OP_ShiftLeft
+ 1 - op
;
1653 iB
= iB
>(-64) ? -iB
: 64;
1657 iA
= (iA
>=0 || op
==OP_ShiftLeft
) ? 0 : -1;
1659 memcpy(&uA
, &iA
, sizeof(uA
));
1660 if( op
==OP_ShiftLeft
){
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
));
1671 MemSetTypeFlag(pOut
, MEM_Int
);
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
;
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 ){
1705 rc
= SQLITE_MISMATCH
;
1706 goto abort_due_to_error
;
1712 MemSetTypeFlag(pIn1
, MEM_Int
);
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
);
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.
1742 ** <li> P2=='A' → BLOB
1743 ** <li> P2=='B' → TEXT
1744 ** <li> P2=='C' → NUMERIC
1745 ** <li> P2=='D' → INTEGER
1746 ** <li> P2=='E' → REAL
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
;
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 */
1894 res
= 1; /* Operands are not equal */
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
);
1908 VdbeBranchTaken(2,3);
1909 if( pOp
->p5
& SQLITE_JUMPIFNULL
){
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
; }
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
);
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
];
1970 static const unsigned char aEQb
[] = { 0, 1, 0, 1, 0, 1 };
1971 res2
= aEQb
[pOp
->opcode
- OP_Ne
];
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
];
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
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
);
2005 REGISTER_TRACE(pOp
->p2
, pOut
);
2007 VdbeBranchTaken(res
!=0, (pOp
->p5
& SQLITE_NULLEQ
)?2:3);
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 */
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
;
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
);
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
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.
2078 const KeyInfo
*pKeyInfo
;
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 ){
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 );
2094 pKeyInfo
= pOp
->p4
.pKeyInfo
;
2096 assert( pKeyInfo
!=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 );
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 */
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
);
2121 if( bRev
) iCompare
= -iCompare
;
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 */
2136 VdbeBranchTaken(0,3); pOp
= &aOp
[pOp
->p1
- 1];
2137 }else if( iCompare
==0 ){
2138 VdbeBranchTaken(1,3); pOp
= &aOp
[pOp
->p2
- 1];
2140 VdbeBranchTaken(2,3); pOp
= &aOp
[pOp
->p3
- 1];
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
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
){
2174 v1
= sqlite3VdbeIntValue(pIn1
)!=0;
2176 pIn2
= &aMem
[pOp
->p2
];
2177 if( pIn2
->flags
& MEM_Null
){
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
];
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
];
2191 MemSetTypeFlag(pOut
, MEM_Null
);
2194 MemSetTypeFlag(pOut
, MEM_Int
);
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
);
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
);
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
2252 case OP_Once
: { /* jump */
2253 u32 iAddr
; /* Address of this instruction */
2254 assert( p
->aOp
[0].opcode
==OP_Init
);
2256 iAddr
= (int)(pOp
- p
->aOp
);
2257 if( (p
->pFrame
->aOnce
[iAddr
/8] & (1<<(iAddr
& 7)))!=0 ){
2258 VdbeBranchTaken(1, 2);
2261 p
->pFrame
->aOnce
[iAddr
/8] |= 1<<(iAddr
& 7);
2263 if( p
->aOp
[0].p1
==pOp
->p1
){
2264 VdbeBranchTaken(1, 2);
2268 VdbeBranchTaken(0, 2);
2269 pOp
->p1
= p
->aOp
[0].p1
;
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 */
2288 pIn1
= &aMem
[pOp
->p1
];
2289 if( pIn1
->flags
& MEM_Null
){
2292 #ifdef SQLITE_OMIT_FLOATING_POINT
2293 c
= sqlite3VdbeIntValue(pIn1
)!=0;
2295 c
= sqlite3VdbeRealValue(pIn1
)!=0.0;
2297 if( pOp
->opcode
==OP_IfNot
) c
= !c
;
2299 VdbeBranchTaken(c
!=0, 2);
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 ){
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 ){
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
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
);
2352 /* Opcode: Location P1 P2 * * *
2353 ** Synopsis: r[P2] = location(P1)
2355 ** Store in register r[P2] the location in the database file that is the
2356 ** start of the payload for the record at which that cursor P1 is currently
2359 case OP_Location
: { /* out2 */
2360 VdbeCursor
*pC
; /* The VDBE cursor */
2361 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
2362 pC
= p
->apCsr
[pOp
->p1
];
2363 pOut
= out2Prerelease(p
, pOp
);
2364 if( pC
==0 || pC
->eCurType
!=CURTYPE_BTREE
){
2365 pOut
->flags
= MEM_Null
;
2367 pOut
->u
.i
= sqlite3BtreeLocation(pC
->uc
.pCursor
);
2372 /* Opcode: Column P1 P2 P3 P4 P5
2373 ** Synopsis: r[P3]=PX
2375 ** Interpret the data that cursor P1 points to as a structure built using
2376 ** the MakeRecord instruction. (See the MakeRecord opcode for additional
2377 ** information about the format of the data.) Extract the P2-th column
2378 ** from this record. If there are less that (P2+1)
2379 ** values in the record, extract a NULL.
2381 ** The value extracted is stored in register P3.
2383 ** If the record contains fewer than P2 fields, then extract a NULL. Or,
2384 ** if the P4 argument is a P4_MEM use the value of the P4 argument as
2387 ** If the OPFLAG_CLEARCACHE bit is set on P5 and P1 is a pseudo-table cursor,
2388 ** then the cache of the cursor is reset prior to extracting the column.
2389 ** The first OP_Column against a pseudo-table after the value of the content
2390 ** register has changed should have this bit set.
2392 ** If the OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG bits are set on P5 then
2393 ** the result is guaranteed to only be used as the argument of a length()
2394 ** or typeof() function, respectively. The loading of large blobs can be
2395 ** skipped for length() and all content loading can be skipped for typeof().
2398 int p2
; /* column number to retrieve */
2399 VdbeCursor
*pC
; /* The VDBE cursor */
2400 BtCursor
*pCrsr
; /* The BTree cursor */
2401 u32
*aOffset
; /* aOffset[i] is offset to start of data for i-th column */
2402 int len
; /* The length of the serialized data for the column */
2403 int i
; /* Loop counter */
2404 Mem
*pDest
; /* Where to write the extracted value */
2405 Mem sMem
; /* For storing the record being decoded */
2406 const u8
*zData
; /* Part of the record being decoded */
2407 const u8
*zHdr
; /* Next unparsed byte of the header */
2408 const u8
*zEndHdr
; /* Pointer to first byte after the header */
2409 u64 offset64
; /* 64-bit offset */
2410 u32 t
; /* A type code from the record header */
2411 Mem
*pReg
; /* PseudoTable input register */
2413 pC
= p
->apCsr
[pOp
->p1
];
2416 /* If the cursor cache is stale (meaning it is not currently point at
2417 ** the correct row) then bring it up-to-date by doing the necessary
2419 rc
= sqlite3VdbeCursorMoveto(&pC
, &p2
);
2420 if( rc
) goto abort_due_to_error
;
2422 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
2423 pDest
= &aMem
[pOp
->p3
];
2424 memAboutToChange(p
, pDest
);
2425 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
2427 assert( p2
<pC
->nField
);
2428 aOffset
= pC
->aOffset
;
2429 assert( pC
->eCurType
!=CURTYPE_VTAB
);
2430 assert( pC
->eCurType
!=CURTYPE_PSEUDO
|| pC
->nullRow
);
2431 assert( pC
->eCurType
!=CURTYPE_SORTER
);
2433 if( pC
->cacheStatus
!=p
->cacheCtr
){ /*OPTIMIZATION-IF-FALSE*/
2435 if( pC
->eCurType
==CURTYPE_PSEUDO
){
2436 /* For the special case of as pseudo-cursor, the seekResult field
2437 ** identifies the register that holds the record */
2438 assert( pC
->seekResult
>0 );
2439 pReg
= &aMem
[pC
->seekResult
];
2440 assert( pReg
->flags
& MEM_Blob
);
2441 assert( memIsValid(pReg
) );
2442 pC
->payloadSize
= pC
->szRow
= pReg
->n
;
2443 pC
->aRow
= (u8
*)pReg
->z
;
2445 sqlite3VdbeMemSetNull(pDest
);
2449 pCrsr
= pC
->uc
.pCursor
;
2450 assert( pC
->eCurType
==CURTYPE_BTREE
);
2452 assert( sqlite3BtreeCursorIsValid(pCrsr
) );
2453 pC
->payloadSize
= sqlite3BtreePayloadSize(pCrsr
);
2454 pC
->aRow
= sqlite3BtreePayloadFetch(pCrsr
, &pC
->szRow
);
2455 assert( pC
->szRow
<=pC
->payloadSize
);
2456 assert( pC
->szRow
<=65536 ); /* Maximum page size is 64KiB */
2457 if( pC
->payloadSize
> (u32
)db
->aLimit
[SQLITE_LIMIT_LENGTH
] ){
2461 pC
->cacheStatus
= p
->cacheCtr
;
2462 pC
->iHdrOffset
= getVarint32(pC
->aRow
, aOffset
[0]);
2466 if( pC
->szRow
<aOffset
[0] ){ /*OPTIMIZATION-IF-FALSE*/
2467 /* pC->aRow does not have to hold the entire row, but it does at least
2468 ** need to cover the header of the record. If pC->aRow does not contain
2469 ** the complete header, then set it to zero, forcing the header to be
2470 ** dynamically allocated. */
2474 /* Make sure a corrupt database has not given us an oversize header.
2475 ** Do this now to avoid an oversize memory allocation.
2477 ** Type entries can be between 1 and 5 bytes each. But 4 and 5 byte
2478 ** types use so much data space that there can only be 4096 and 32 of
2479 ** them, respectively. So the maximum header length results from a
2480 ** 3-byte type for each of the maximum of 32768 columns plus three
2481 ** extra bytes for the header length itself. 32768*3 + 3 = 98307.
2483 if( aOffset
[0] > 98307 || aOffset
[0] > pC
->payloadSize
){
2484 goto op_column_corrupt
;
2487 /* This is an optimization. By skipping over the first few tests
2488 ** (ex: pC->nHdrParsed<=p2) in the next section, we achieve a
2489 ** measurable performance gain.
2491 ** This branch is taken even if aOffset[0]==0. Such a record is never
2492 ** generated by SQLite, and could be considered corruption, but we
2493 ** accept it for historical reasons. When aOffset[0]==0, the code this
2494 ** branch jumps to reads past the end of the record, but never more
2495 ** than a few bytes. Even if the record occurs at the end of the page
2496 ** content area, the "page header" comes after the page content and so
2497 ** this overread is harmless. Similar overreads can occur for a corrupt
2501 assert( pC
->nHdrParsed
<=p2
); /* Conditional skipped */
2502 testcase( aOffset
[0]==0 );
2503 goto op_column_read_header
;
2507 /* Make sure at least the first p2+1 entries of the header have been
2508 ** parsed and valid information is in aOffset[] and pC->aType[].
2510 if( pC
->nHdrParsed
<=p2
){
2511 /* If there is more header available for parsing in the record, try
2512 ** to extract additional fields up through the p2+1-th field
2514 if( pC
->iHdrOffset
<aOffset
[0] ){
2515 /* Make sure zData points to enough of the record to cover the header. */
2517 memset(&sMem
, 0, sizeof(sMem
));
2518 rc
= sqlite3VdbeMemFromBtree(pC
->uc
.pCursor
, 0, aOffset
[0], &sMem
);
2519 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
2520 zData
= (u8
*)sMem
.z
;
2525 /* Fill in pC->aType[i] and aOffset[i] values through the p2-th field. */
2526 op_column_read_header
:
2528 offset64
= aOffset
[i
];
2529 zHdr
= zData
+ pC
->iHdrOffset
;
2530 zEndHdr
= zData
+ aOffset
[0];
2531 testcase( zHdr
>=zEndHdr
);
2533 if( (t
= zHdr
[0])<0x80 ){
2535 offset64
+= sqlite3VdbeOneByteSerialTypeLen(t
);
2537 zHdr
+= sqlite3GetVarint32(zHdr
, &t
);
2538 offset64
+= sqlite3VdbeSerialTypeLen(t
);
2541 aOffset
[i
] = (u32
)(offset64
& 0xffffffff);
2542 }while( i
<=p2
&& zHdr
<zEndHdr
);
2544 /* The record is corrupt if any of the following are true:
2545 ** (1) the bytes of the header extend past the declared header size
2546 ** (2) the entire header was used but not all data was used
2547 ** (3) the end of the data extends beyond the end of the record.
2549 if( (zHdr
>=zEndHdr
&& (zHdr
>zEndHdr
|| offset64
!=pC
->payloadSize
))
2550 || (offset64
> pC
->payloadSize
)
2552 if( aOffset
[0]==0 ){
2556 if( pC
->aRow
==0 ) sqlite3VdbeMemRelease(&sMem
);
2557 goto op_column_corrupt
;
2562 pC
->iHdrOffset
= (u32
)(zHdr
- zData
);
2563 if( pC
->aRow
==0 ) sqlite3VdbeMemRelease(&sMem
);
2568 /* If after trying to extract new entries from the header, nHdrParsed is
2569 ** still not up to p2, that means that the record has fewer than p2
2570 ** columns. So the result will be either the default value or a NULL.
2572 if( pC
->nHdrParsed
<=p2
){
2573 if( pOp
->p4type
==P4_MEM
){
2574 sqlite3VdbeMemShallowCopy(pDest
, pOp
->p4
.pMem
, MEM_Static
);
2576 sqlite3VdbeMemSetNull(pDest
);
2584 /* Extract the content for the p2+1-th column. Control can only
2585 ** reach this point if aOffset[p2], aOffset[p2+1], and pC->aType[p2] are
2588 assert( p2
<pC
->nHdrParsed
);
2589 assert( rc
==SQLITE_OK
);
2590 assert( sqlite3VdbeCheckMemInvariants(pDest
) );
2591 if( VdbeMemDynamic(pDest
) ){
2592 sqlite3VdbeMemSetNull(pDest
);
2594 assert( t
==pC
->aType
[p2
] );
2595 if( pC
->szRow
>=aOffset
[p2
+1] ){
2596 /* This is the common case where the desired content fits on the original
2597 ** page - where the content is not on an overflow page */
2598 zData
= pC
->aRow
+ aOffset
[p2
];
2600 sqlite3VdbeSerialGet(zData
, t
, pDest
);
2602 /* If the column value is a string, we need a persistent value, not
2603 ** a MEM_Ephem value. This branch is a fast short-cut that is equivalent
2604 ** to calling sqlite3VdbeSerialGet() and sqlite3VdbeDeephemeralize().
2606 static const u16 aFlag
[] = { MEM_Blob
, MEM_Str
|MEM_Term
};
2607 pDest
->n
= len
= (t
-12)/2;
2608 pDest
->enc
= encoding
;
2609 if( pDest
->szMalloc
< len
+2 ){
2610 pDest
->flags
= MEM_Null
;
2611 if( sqlite3VdbeMemGrow(pDest
, len
+2, 0) ) goto no_mem
;
2613 pDest
->z
= pDest
->zMalloc
;
2615 memcpy(pDest
->z
, zData
, len
);
2617 pDest
->z
[len
+1] = 0;
2618 pDest
->flags
= aFlag
[t
&1];
2621 pDest
->enc
= encoding
;
2622 /* This branch happens only when content is on overflow pages */
2623 if( ((pOp
->p5
& (OPFLAG_LENGTHARG
|OPFLAG_TYPEOFARG
))!=0
2624 && ((t
>=12 && (t
&1)==0) || (pOp
->p5
& OPFLAG_TYPEOFARG
)!=0))
2625 || (len
= sqlite3VdbeSerialTypeLen(t
))==0
2627 /* Content is irrelevant for
2628 ** 1. the typeof() function,
2629 ** 2. the length(X) function if X is a blob, and
2630 ** 3. if the content length is zero.
2631 ** So we might as well use bogus content rather than reading
2632 ** content from disk.
2634 ** Although sqlite3VdbeSerialGet() may read at most 8 bytes from the
2635 ** buffer passed to it, debugging function VdbeMemPrettyPrint() may
2636 ** read up to 16. So 16 bytes of bogus content is supplied.
2638 static u8 aZero
[16]; /* This is the bogus content */
2639 sqlite3VdbeSerialGet(aZero
, t
, pDest
);
2641 rc
= sqlite3VdbeMemFromBtree(pC
->uc
.pCursor
, aOffset
[p2
], len
, pDest
);
2642 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
2643 sqlite3VdbeSerialGet((const u8
*)pDest
->z
, t
, pDest
);
2644 pDest
->flags
&= ~MEM_Ephem
;
2649 UPDATE_MAX_BLOBSIZE(pDest
);
2650 REGISTER_TRACE(pOp
->p3
, pDest
);
2655 pOp
= &aOp
[aOp
[0].p3
-1];
2658 rc
= SQLITE_CORRUPT_BKPT
;
2659 goto abort_due_to_error
;
2663 /* Opcode: Affinity P1 P2 * P4 *
2664 ** Synopsis: affinity(r[P1@P2])
2666 ** Apply affinities to a range of P2 registers starting with P1.
2668 ** P4 is a string that is P2 characters long. The N-th character of the
2669 ** string indicates the column affinity that should be used for the N-th
2670 ** memory cell in the range.
2673 const char *zAffinity
; /* The affinity to be applied */
2675 zAffinity
= pOp
->p4
.z
;
2676 assert( zAffinity
!=0 );
2677 assert( pOp
->p2
>0 );
2678 assert( zAffinity
[pOp
->p2
]==0 );
2679 pIn1
= &aMem
[pOp
->p1
];
2681 assert( pIn1
<= &p
->aMem
[(p
->nMem
+1 - p
->nCursor
)] );
2682 assert( memIsValid(pIn1
) );
2683 applyAffinity(pIn1
, *(zAffinity
++), encoding
);
2685 }while( zAffinity
[0] );
2689 /* Opcode: MakeRecord P1 P2 P3 P4 *
2690 ** Synopsis: r[P3]=mkrec(r[P1@P2])
2692 ** Convert P2 registers beginning with P1 into the [record format]
2693 ** use as a data record in a database table or as a key
2694 ** in an index. The OP_Column opcode can decode the record later.
2696 ** P4 may be a string that is P2 characters long. The N-th character of the
2697 ** string indicates the column affinity that should be used for the N-th
2698 ** field of the index key.
2700 ** The mapping from character to affinity is given by the SQLITE_AFF_
2701 ** macros defined in sqliteInt.h.
2703 ** If P4 is NULL then all index fields have the affinity BLOB.
2705 case OP_MakeRecord
: {
2706 u8
*zNewRecord
; /* A buffer to hold the data for the new record */
2707 Mem
*pRec
; /* The new record */
2708 u64 nData
; /* Number of bytes of data space */
2709 int nHdr
; /* Number of bytes of header space */
2710 i64 nByte
; /* Data space required for this record */
2711 i64 nZero
; /* Number of zero bytes at the end of the record */
2712 int nVarint
; /* Number of bytes in a varint */
2713 u32 serial_type
; /* Type field */
2714 Mem
*pData0
; /* First field to be combined into the record */
2715 Mem
*pLast
; /* Last field of the record */
2716 int nField
; /* Number of fields in the record */
2717 char *zAffinity
; /* The affinity string for the record */
2718 int file_format
; /* File format to use for encoding */
2719 int i
; /* Space used in zNewRecord[] header */
2720 int j
; /* Space used in zNewRecord[] content */
2721 u32 len
; /* Length of a field */
2723 /* Assuming the record contains N fields, the record format looks
2726 ** ------------------------------------------------------------------------
2727 ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
2728 ** ------------------------------------------------------------------------
2730 ** Data(0) is taken from register P1. Data(1) comes from register P1+1
2733 ** Each type field is a varint representing the serial type of the
2734 ** corresponding data element (see sqlite3VdbeSerialType()). The
2735 ** hdr-size field is also a varint which is the offset from the beginning
2736 ** of the record to data0.
2738 nData
= 0; /* Number of bytes of data space */
2739 nHdr
= 0; /* Number of bytes of header space */
2740 nZero
= 0; /* Number of zero bytes at the end of the record */
2742 zAffinity
= pOp
->p4
.z
;
2743 assert( nField
>0 && pOp
->p2
>0 && pOp
->p2
+nField
<=(p
->nMem
+1 - p
->nCursor
)+1 );
2744 pData0
= &aMem
[nField
];
2746 pLast
= &pData0
[nField
-1];
2747 file_format
= p
->minWriteFileFormat
;
2749 /* Identify the output register */
2750 assert( pOp
->p3
<pOp
->p1
|| pOp
->p3
>=pOp
->p1
+pOp
->p2
);
2751 pOut
= &aMem
[pOp
->p3
];
2752 memAboutToChange(p
, pOut
);
2754 /* Apply the requested affinity to all inputs
2756 assert( pData0
<=pLast
);
2760 applyAffinity(pRec
++, *(zAffinity
++), encoding
);
2761 assert( zAffinity
[0]==0 || pRec
<=pLast
);
2762 }while( zAffinity
[0] );
2765 #ifdef SQLITE_ENABLE_NULL_TRIM
2766 /* NULLs can be safely trimmed from the end of the record, as long as
2767 ** as the schema format is 2 or more and none of the omitted columns
2768 ** have a non-NULL default value. Also, the record must be left with
2769 ** at least one field. If P5>0 then it will be one more than the
2770 ** index of the right-most column with a non-NULL default value */
2772 while( (pLast
->flags
& MEM_Null
)!=0 && nField
>pOp
->p5
){
2779 /* Loop through the elements that will make up the record to figure
2780 ** out how much space is required for the new record.
2784 assert( memIsValid(pRec
) );
2785 pRec
->uTemp
= serial_type
= sqlite3VdbeSerialType(pRec
, file_format
, &len
);
2786 if( pRec
->flags
& MEM_Zero
){
2788 if( sqlite3VdbeMemExpandBlob(pRec
) ) goto no_mem
;
2790 nZero
+= pRec
->u
.nZero
;
2791 len
-= pRec
->u
.nZero
;
2795 testcase( serial_type
==127 );
2796 testcase( serial_type
==128 );
2797 nHdr
+= serial_type
<=127 ? 1 : sqlite3VarintLen(serial_type
);
2798 if( pRec
==pData0
) break;
2802 /* EVIDENCE-OF: R-22564-11647 The header begins with a single varint
2803 ** which determines the total number of bytes in the header. The varint
2804 ** value is the size of the header in bytes including the size varint
2806 testcase( nHdr
==126 );
2807 testcase( nHdr
==127 );
2809 /* The common case */
2812 /* Rare case of a really large header */
2813 nVarint
= sqlite3VarintLen(nHdr
);
2815 if( nVarint
<sqlite3VarintLen(nHdr
) ) nHdr
++;
2818 if( nByte
+nZero
>db
->aLimit
[SQLITE_LIMIT_LENGTH
] ){
2822 /* Make sure the output register has a buffer large enough to store
2823 ** the new record. The output register (pOp->p3) is not allowed to
2824 ** be one of the input registers (because the following call to
2825 ** sqlite3VdbeMemClearAndResize() could clobber the value before it is used).
2827 if( sqlite3VdbeMemClearAndResize(pOut
, (int)nByte
) ){
2830 zNewRecord
= (u8
*)pOut
->z
;
2832 /* Write the record */
2833 i
= putVarint32(zNewRecord
, nHdr
);
2835 assert( pData0
<=pLast
);
2838 serial_type
= pRec
->uTemp
;
2839 /* EVIDENCE-OF: R-06529-47362 Following the size varint are one or more
2840 ** additional varints, one per column. */
2841 i
+= putVarint32(&zNewRecord
[i
], serial_type
); /* serial type */
2842 /* EVIDENCE-OF: R-64536-51728 The values for each column in the record
2843 ** immediately follow the header. */
2844 j
+= sqlite3VdbeSerialPut(&zNewRecord
[j
], pRec
, serial_type
); /* content */
2845 }while( (++pRec
)<=pLast
);
2849 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
2850 pOut
->n
= (int)nByte
;
2851 pOut
->flags
= MEM_Blob
;
2853 pOut
->u
.nZero
= nZero
;
2854 pOut
->flags
|= MEM_Zero
;
2856 REGISTER_TRACE(pOp
->p3
, pOut
);
2857 UPDATE_MAX_BLOBSIZE(pOut
);
2861 /* Opcode: Count P1 P2 * * *
2862 ** Synopsis: r[P2]=count()
2864 ** Store the number of entries (an integer value) in the table or index
2865 ** opened by cursor P1 in register P2
2867 #ifndef SQLITE_OMIT_BTREECOUNT
2868 case OP_Count
: { /* out2 */
2872 assert( p
->apCsr
[pOp
->p1
]->eCurType
==CURTYPE_BTREE
);
2873 pCrsr
= p
->apCsr
[pOp
->p1
]->uc
.pCursor
;
2875 nEntry
= 0; /* Not needed. Only used to silence a warning. */
2876 rc
= sqlite3BtreeCount(pCrsr
, &nEntry
);
2877 if( rc
) goto abort_due_to_error
;
2878 pOut
= out2Prerelease(p
, pOp
);
2884 /* Opcode: Savepoint P1 * * P4 *
2886 ** Open, release or rollback the savepoint named by parameter P4, depending
2887 ** on the value of P1. To open a new savepoint, P1==0. To release (commit) an
2888 ** existing savepoint, P1==1, or to rollback an existing savepoint P1==2.
2890 case OP_Savepoint
: {
2891 int p1
; /* Value of P1 operand */
2892 char *zName
; /* Name of savepoint */
2895 Savepoint
*pSavepoint
;
2903 /* Assert that the p1 parameter is valid. Also that if there is no open
2904 ** transaction, then there cannot be any savepoints.
2906 assert( db
->pSavepoint
==0 || db
->autoCommit
==0 );
2907 assert( p1
==SAVEPOINT_BEGIN
||p1
==SAVEPOINT_RELEASE
||p1
==SAVEPOINT_ROLLBACK
);
2908 assert( db
->pSavepoint
|| db
->isTransactionSavepoint
==0 );
2909 assert( checkSavepointCount(db
) );
2910 assert( p
->bIsReader
);
2912 if( p1
==SAVEPOINT_BEGIN
){
2913 if( db
->nVdbeWrite
>0 ){
2914 /* A new savepoint cannot be created if there are active write
2915 ** statements (i.e. open read/write incremental blob handles).
2917 sqlite3VdbeError(p
, "cannot open savepoint - SQL statements in progress");
2920 nName
= sqlite3Strlen30(zName
);
2922 #ifndef SQLITE_OMIT_VIRTUALTABLE
2923 /* This call is Ok even if this savepoint is actually a transaction
2924 ** savepoint (and therefore should not prompt xSavepoint()) callbacks.
2925 ** If this is a transaction savepoint being opened, it is guaranteed
2926 ** that the db->aVTrans[] array is empty. */
2927 assert( db
->autoCommit
==0 || db
->nVTrans
==0 );
2928 rc
= sqlite3VtabSavepoint(db
, SAVEPOINT_BEGIN
,
2929 db
->nStatement
+db
->nSavepoint
);
2930 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
2933 /* Create a new savepoint structure. */
2934 pNew
= sqlite3DbMallocRawNN(db
, sizeof(Savepoint
)+nName
+1);
2936 pNew
->zName
= (char *)&pNew
[1];
2937 memcpy(pNew
->zName
, zName
, nName
+1);
2939 /* If there is no open transaction, then mark this as a special
2940 ** "transaction savepoint". */
2941 if( db
->autoCommit
){
2943 db
->isTransactionSavepoint
= 1;
2948 /* Link the new savepoint into the database handle's list. */
2949 pNew
->pNext
= db
->pSavepoint
;
2950 db
->pSavepoint
= pNew
;
2951 pNew
->nDeferredCons
= db
->nDeferredCons
;
2952 pNew
->nDeferredImmCons
= db
->nDeferredImmCons
;
2958 /* Find the named savepoint. If there is no such savepoint, then an
2959 ** an error is returned to the user. */
2961 pSavepoint
= db
->pSavepoint
;
2962 pSavepoint
&& sqlite3StrICmp(pSavepoint
->zName
, zName
);
2963 pSavepoint
= pSavepoint
->pNext
2968 sqlite3VdbeError(p
, "no such savepoint: %s", zName
);
2970 }else if( db
->nVdbeWrite
>0 && p1
==SAVEPOINT_RELEASE
){
2971 /* It is not possible to release (commit) a savepoint if there are
2972 ** active write statements.
2974 sqlite3VdbeError(p
, "cannot release savepoint - "
2975 "SQL statements in progress");
2979 /* Determine whether or not this is a transaction savepoint. If so,
2980 ** and this is a RELEASE command, then the current transaction
2983 int isTransaction
= pSavepoint
->pNext
==0 && db
->isTransactionSavepoint
;
2984 if( isTransaction
&& p1
==SAVEPOINT_RELEASE
){
2985 if( (rc
= sqlite3VdbeCheckFk(p
, 1))!=SQLITE_OK
){
2989 if( sqlite3VdbeHalt(p
)==SQLITE_BUSY
){
2990 p
->pc
= (int)(pOp
- aOp
);
2992 p
->rc
= rc
= SQLITE_BUSY
;
2995 db
->isTransactionSavepoint
= 0;
2999 iSavepoint
= db
->nSavepoint
- iSavepoint
- 1;
3000 if( p1
==SAVEPOINT_ROLLBACK
){
3001 isSchemaChange
= (db
->mDbFlags
& DBFLAG_SchemaChange
)!=0;
3002 for(ii
=0; ii
<db
->nDb
; ii
++){
3003 rc
= sqlite3BtreeTripAllCursors(db
->aDb
[ii
].pBt
,
3004 SQLITE_ABORT_ROLLBACK
,
3006 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
3011 for(ii
=0; ii
<db
->nDb
; ii
++){
3012 rc
= sqlite3BtreeSavepoint(db
->aDb
[ii
].pBt
, p1
, iSavepoint
);
3013 if( rc
!=SQLITE_OK
){
3014 goto abort_due_to_error
;
3017 if( isSchemaChange
){
3018 sqlite3ExpirePreparedStatements(db
);
3019 sqlite3ResetAllSchemasOfConnection(db
);
3020 db
->mDbFlags
|= DBFLAG_SchemaChange
;
3024 /* Regardless of whether this is a RELEASE or ROLLBACK, destroy all
3025 ** savepoints nested inside of the savepoint being operated on. */
3026 while( db
->pSavepoint
!=pSavepoint
){
3027 pTmp
= db
->pSavepoint
;
3028 db
->pSavepoint
= pTmp
->pNext
;
3029 sqlite3DbFree(db
, pTmp
);
3033 /* If it is a RELEASE, then destroy the savepoint being operated on
3034 ** too. If it is a ROLLBACK TO, then set the number of deferred
3035 ** constraint violations present in the database to the value stored
3036 ** when the savepoint was created. */
3037 if( p1
==SAVEPOINT_RELEASE
){
3038 assert( pSavepoint
==db
->pSavepoint
);
3039 db
->pSavepoint
= pSavepoint
->pNext
;
3040 sqlite3DbFree(db
, pSavepoint
);
3041 if( !isTransaction
){
3045 db
->nDeferredCons
= pSavepoint
->nDeferredCons
;
3046 db
->nDeferredImmCons
= pSavepoint
->nDeferredImmCons
;
3049 if( !isTransaction
|| p1
==SAVEPOINT_ROLLBACK
){
3050 rc
= sqlite3VtabSavepoint(db
, p1
, iSavepoint
);
3051 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
3055 if( rc
) goto abort_due_to_error
;
3060 /* Opcode: AutoCommit P1 P2 * * *
3062 ** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
3063 ** back any currently active btree transactions. If there are any active
3064 ** VMs (apart from this one), then a ROLLBACK fails. A COMMIT fails if
3065 ** there are active writing VMs or active VMs that use shared cache.
3067 ** This instruction causes the VM to halt.
3069 case OP_AutoCommit
: {
3070 int desiredAutoCommit
;
3073 desiredAutoCommit
= pOp
->p1
;
3074 iRollback
= pOp
->p2
;
3075 assert( desiredAutoCommit
==1 || desiredAutoCommit
==0 );
3076 assert( desiredAutoCommit
==1 || iRollback
==0 );
3077 assert( db
->nVdbeActive
>0 ); /* At least this one VM is active */
3078 assert( p
->bIsReader
);
3080 if( desiredAutoCommit
!=db
->autoCommit
){
3082 assert( desiredAutoCommit
==1 );
3083 sqlite3RollbackAll(db
, SQLITE_ABORT_ROLLBACK
);
3085 }else if( desiredAutoCommit
&& db
->nVdbeWrite
>0 ){
3086 /* If this instruction implements a COMMIT and other VMs are writing
3087 ** return an error indicating that the other VMs must complete first.
3089 sqlite3VdbeError(p
, "cannot commit transaction - "
3090 "SQL statements in progress");
3092 goto abort_due_to_error
;
3093 }else if( (rc
= sqlite3VdbeCheckFk(p
, 1))!=SQLITE_OK
){
3096 db
->autoCommit
= (u8
)desiredAutoCommit
;
3098 if( sqlite3VdbeHalt(p
)==SQLITE_BUSY
){
3099 p
->pc
= (int)(pOp
- aOp
);
3100 db
->autoCommit
= (u8
)(1-desiredAutoCommit
);
3101 p
->rc
= rc
= SQLITE_BUSY
;
3104 assert( db
->nStatement
==0 );
3105 sqlite3CloseSavepoints(db
);
3106 if( p
->rc
==SQLITE_OK
){
3114 (!desiredAutoCommit
)?"cannot start a transaction within a transaction":(
3115 (iRollback
)?"cannot rollback - no transaction is active":
3116 "cannot commit - no transaction is active"));
3119 goto abort_due_to_error
;
3124 /* Opcode: Transaction P1 P2 P3 P4 P5
3126 ** Begin a transaction on database P1 if a transaction is not already
3128 ** If P2 is non-zero, then a write-transaction is started, or if a
3129 ** read-transaction is already active, it is upgraded to a write-transaction.
3130 ** If P2 is zero, then a read-transaction is started.
3132 ** P1 is the index of the database file on which the transaction is
3133 ** started. Index 0 is the main database file and index 1 is the
3134 ** file used for temporary tables. Indices of 2 or more are used for
3135 ** attached databases.
3137 ** If a write-transaction is started and the Vdbe.usesStmtJournal flag is
3138 ** true (this flag is set if the Vdbe may modify more than one row and may
3139 ** throw an ABORT exception), a statement transaction may also be opened.
3140 ** More specifically, a statement transaction is opened iff the database
3141 ** connection is currently not in autocommit mode, or if there are other
3142 ** active statements. A statement transaction allows the changes made by this
3143 ** VDBE to be rolled back after an error without having to roll back the
3144 ** entire transaction. If no error is encountered, the statement transaction
3145 ** will automatically commit when the VDBE halts.
3147 ** If P5!=0 then this opcode also checks the schema cookie against P3
3148 ** and the schema generation counter against P4.
3149 ** The cookie changes its value whenever the database schema changes.
3150 ** This operation is used to detect when that the cookie has changed
3151 ** and that the current process needs to reread the schema. If the schema
3152 ** cookie in P3 differs from the schema cookie in the database header or
3153 ** if the schema generation counter in P4 differs from the current
3154 ** generation counter, then an SQLITE_SCHEMA error is raised and execution
3155 ** halts. The sqlite3_step() wrapper function might then reprepare the
3156 ** statement and rerun it from the beginning.
3158 case OP_Transaction
: {
3163 assert( p
->bIsReader
);
3164 assert( p
->readOnly
==0 || pOp
->p2
==0 );
3165 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
3166 assert( DbMaskTest(p
->btreeMask
, pOp
->p1
) );
3167 if( pOp
->p2
&& (db
->flags
& SQLITE_QueryOnly
)!=0 ){
3168 rc
= SQLITE_READONLY
;
3169 goto abort_due_to_error
;
3171 pBt
= db
->aDb
[pOp
->p1
].pBt
;
3174 rc
= sqlite3BtreeBeginTrans(pBt
, pOp
->p2
);
3175 testcase( rc
==SQLITE_BUSY_SNAPSHOT
);
3176 testcase( rc
==SQLITE_BUSY_RECOVERY
);
3177 if( rc
!=SQLITE_OK
){
3178 if( (rc
&0xff)==SQLITE_BUSY
){
3179 p
->pc
= (int)(pOp
- aOp
);
3183 goto abort_due_to_error
;
3186 if( pOp
->p2
&& p
->usesStmtJournal
3187 && (db
->autoCommit
==0 || db
->nVdbeRead
>1)
3189 assert( sqlite3BtreeIsInTrans(pBt
) );
3190 if( p
->iStatement
==0 ){
3191 assert( db
->nStatement
>=0 && db
->nSavepoint
>=0 );
3193 p
->iStatement
= db
->nSavepoint
+ db
->nStatement
;
3196 rc
= sqlite3VtabSavepoint(db
, SAVEPOINT_BEGIN
, p
->iStatement
-1);
3197 if( rc
==SQLITE_OK
){
3198 rc
= sqlite3BtreeBeginStmt(pBt
, p
->iStatement
);
3201 /* Store the current value of the database handles deferred constraint
3202 ** counter. If the statement transaction needs to be rolled back,
3203 ** the value of this counter needs to be restored too. */
3204 p
->nStmtDefCons
= db
->nDeferredCons
;
3205 p
->nStmtDefImmCons
= db
->nDeferredImmCons
;
3208 /* Gather the schema version number for checking:
3209 ** IMPLEMENTATION-OF: R-03189-51135 As each SQL statement runs, the schema
3210 ** version is checked to ensure that the schema has not changed since the
3211 ** SQL statement was prepared.
3213 sqlite3BtreeGetMeta(pBt
, BTREE_SCHEMA_VERSION
, (u32
*)&iMeta
);
3214 iGen
= db
->aDb
[pOp
->p1
].pSchema
->iGeneration
;
3218 assert( pOp
->p5
==0 || pOp
->p4type
==P4_INT32
);
3219 if( pOp
->p5
&& (iMeta
!=pOp
->p3
|| iGen
!=pOp
->p4
.i
) ){
3220 sqlite3DbFree(db
, p
->zErrMsg
);
3221 p
->zErrMsg
= sqlite3DbStrDup(db
, "database schema has changed");
3222 /* If the schema-cookie from the database file matches the cookie
3223 ** stored with the in-memory representation of the schema, do
3224 ** not reload the schema from the database file.
3226 ** If virtual-tables are in use, this is not just an optimization.
3227 ** Often, v-tables store their data in other SQLite tables, which
3228 ** are queried from within xNext() and other v-table methods using
3229 ** prepared queries. If such a query is out-of-date, we do not want to
3230 ** discard the database schema, as the user code implementing the
3231 ** v-table would have to be ready for the sqlite3_vtab structure itself
3232 ** to be invalidated whenever sqlite3_step() is called from within
3233 ** a v-table method.
3235 if( db
->aDb
[pOp
->p1
].pSchema
->schema_cookie
!=iMeta
){
3236 sqlite3ResetOneSchema(db
, pOp
->p1
);
3241 if( rc
) goto abort_due_to_error
;
3245 /* Opcode: ReadCookie P1 P2 P3 * *
3247 ** Read cookie number P3 from database P1 and write it into register P2.
3248 ** P3==1 is the schema version. P3==2 is the database format.
3249 ** P3==3 is the recommended pager cache size, and so forth. P1==0 is
3250 ** the main database file and P1==1 is the database file used to store
3251 ** temporary tables.
3253 ** There must be a read-lock on the database (either a transaction
3254 ** must be started or there must be an open cursor) before
3255 ** executing this instruction.
3257 case OP_ReadCookie
: { /* out2 */
3262 assert( p
->bIsReader
);
3265 assert( pOp
->p3
<SQLITE_N_BTREE_META
);
3266 assert( iDb
>=0 && iDb
<db
->nDb
);
3267 assert( db
->aDb
[iDb
].pBt
!=0 );
3268 assert( DbMaskTest(p
->btreeMask
, iDb
) );
3270 sqlite3BtreeGetMeta(db
->aDb
[iDb
].pBt
, iCookie
, (u32
*)&iMeta
);
3271 pOut
= out2Prerelease(p
, pOp
);
3276 /* Opcode: SetCookie P1 P2 P3 * *
3278 ** Write the integer value P3 into cookie number P2 of database P1.
3279 ** P2==1 is the schema version. P2==2 is the database format.
3280 ** P2==3 is the recommended pager cache
3281 ** size, and so forth. P1==0 is the main database file and P1==1 is the
3282 ** database file used to store temporary tables.
3284 ** A transaction must be started before executing this opcode.
3286 case OP_SetCookie
: {
3288 assert( pOp
->p2
<SQLITE_N_BTREE_META
);
3289 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
3290 assert( DbMaskTest(p
->btreeMask
, pOp
->p1
) );
3291 assert( p
->readOnly
==0 );
3292 pDb
= &db
->aDb
[pOp
->p1
];
3293 assert( pDb
->pBt
!=0 );
3294 assert( sqlite3SchemaMutexHeld(db
, pOp
->p1
, 0) );
3295 /* See note about index shifting on OP_ReadCookie */
3296 rc
= sqlite3BtreeUpdateMeta(pDb
->pBt
, pOp
->p2
, pOp
->p3
);
3297 if( pOp
->p2
==BTREE_SCHEMA_VERSION
){
3298 /* When the schema cookie changes, record the new cookie internally */
3299 pDb
->pSchema
->schema_cookie
= pOp
->p3
;
3300 db
->mDbFlags
|= DBFLAG_SchemaChange
;
3301 }else if( pOp
->p2
==BTREE_FILE_FORMAT
){
3302 /* Record changes in the file format */
3303 pDb
->pSchema
->file_format
= pOp
->p3
;
3306 /* Invalidate all prepared statements whenever the TEMP database
3307 ** schema is changed. Ticket #1644 */
3308 sqlite3ExpirePreparedStatements(db
);
3311 if( rc
) goto abort_due_to_error
;
3315 /* Opcode: OpenRead P1 P2 P3 P4 P5
3316 ** Synopsis: root=P2 iDb=P3
3318 ** Open a read-only cursor for the database table whose root page is
3319 ** P2 in a database file. The database file is determined by P3.
3320 ** P3==0 means the main database, P3==1 means the database used for
3321 ** temporary tables, and P3>1 means used the corresponding attached
3322 ** database. Give the new cursor an identifier of P1. The P1
3323 ** values need not be contiguous but all P1 values should be small integers.
3324 ** It is an error for P1 to be negative.
3326 ** If P5!=0 then use the content of register P2 as the root page, not
3327 ** the value of P2 itself.
3329 ** There will be a read lock on the database whenever there is an
3330 ** open cursor. If the database was unlocked prior to this instruction
3331 ** then a read lock is acquired as part of this instruction. A read
3332 ** lock allows other processes to read the database but prohibits
3333 ** any other process from modifying the database. The read lock is
3334 ** released when all cursors are closed. If this instruction attempts
3335 ** to get a read lock but fails, the script terminates with an
3336 ** SQLITE_BUSY error code.
3338 ** The P4 value may be either an integer (P4_INT32) or a pointer to
3339 ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3340 ** structure, then said structure defines the content and collating
3341 ** sequence of the index being opened. Otherwise, if P4 is an integer
3342 ** value, it is set to the number of columns in the table.
3344 ** See also: OpenWrite, ReopenIdx
3346 /* Opcode: ReopenIdx P1 P2 P3 P4 P5
3347 ** Synopsis: root=P2 iDb=P3
3349 ** The ReopenIdx opcode works exactly like ReadOpen except that it first
3350 ** checks to see if the cursor on P1 is already open with a root page
3351 ** number of P2 and if it is this opcode becomes a no-op. In other words,
3352 ** if the cursor is already open, do not reopen it.
3354 ** The ReopenIdx opcode may only be used with P5==0 and with P4 being
3355 ** a P4_KEYINFO object. Furthermore, the P3 value must be the same as
3356 ** every other ReopenIdx or OpenRead for the same cursor number.
3358 ** See the OpenRead opcode documentation for additional information.
3360 /* Opcode: OpenWrite P1 P2 P3 P4 P5
3361 ** Synopsis: root=P2 iDb=P3
3363 ** Open a read/write cursor named P1 on the table or index whose root
3364 ** page is P2. Or if P5!=0 use the content of register P2 to find the
3367 ** The P4 value may be either an integer (P4_INT32) or a pointer to
3368 ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3369 ** structure, then said structure defines the content and collating
3370 ** sequence of the index being opened. Otherwise, if P4 is an integer
3371 ** value, it is set to the number of columns in the table, or to the
3372 ** largest index of any column of the table that is actually used.
3374 ** This instruction works just like OpenRead except that it opens the cursor
3375 ** in read/write mode. For a given table, there can be one or more read-only
3376 ** cursors or a single read/write cursor but not both.
3378 ** See also OpenRead.
3380 case OP_ReopenIdx
: {
3390 assert( pOp
->p5
==0 || pOp
->p5
==OPFLAG_SEEKEQ
);
3391 assert( pOp
->p4type
==P4_KEYINFO
);
3392 pCur
= p
->apCsr
[pOp
->p1
];
3393 if( pCur
&& pCur
->pgnoRoot
==(u32
)pOp
->p2
){
3394 assert( pCur
->iDb
==pOp
->p3
); /* Guaranteed by the code generator */
3395 goto open_cursor_set_hints
;
3397 /* If the cursor is not currently open or is open on a different
3398 ** index, then fall through into OP_OpenRead to force a reopen */
3402 assert( pOp
->opcode
==OP_OpenWrite
|| pOp
->p5
==0 || pOp
->p5
==OPFLAG_SEEKEQ
);
3403 assert( p
->bIsReader
);
3404 assert( pOp
->opcode
==OP_OpenRead
|| pOp
->opcode
==OP_ReopenIdx
3405 || p
->readOnly
==0 );
3408 rc
= SQLITE_ABORT_ROLLBACK
;
3409 goto abort_due_to_error
;
3416 assert( iDb
>=0 && iDb
<db
->nDb
);
3417 assert( DbMaskTest(p
->btreeMask
, iDb
) );
3418 pDb
= &db
->aDb
[iDb
];
3421 if( pOp
->opcode
==OP_OpenWrite
){
3422 assert( OPFLAG_FORDELETE
==BTREE_FORDELETE
);
3423 wrFlag
= BTREE_WRCSR
| (pOp
->p5
& OPFLAG_FORDELETE
);
3424 assert( sqlite3SchemaMutexHeld(db
, iDb
, 0) );
3425 if( pDb
->pSchema
->file_format
< p
->minWriteFileFormat
){
3426 p
->minWriteFileFormat
= pDb
->pSchema
->file_format
;
3431 if( pOp
->p5
& OPFLAG_P2ISREG
){
3433 assert( p2
<=(p
->nMem
+1 - p
->nCursor
) );
3435 assert( memIsValid(pIn2
) );
3436 assert( (pIn2
->flags
& MEM_Int
)!=0 );
3437 sqlite3VdbeMemIntegerify(pIn2
);
3438 p2
= (int)pIn2
->u
.i
;
3439 /* The p2 value always comes from a prior OP_CreateBtree opcode and
3440 ** that opcode will always set the p2 value to 2 or more or else fail.
3441 ** If there were a failure, the prepared statement would have halted
3442 ** before reaching this instruction. */
3445 if( pOp
->p4type
==P4_KEYINFO
){
3446 pKeyInfo
= pOp
->p4
.pKeyInfo
;
3447 assert( pKeyInfo
->enc
==ENC(db
) );
3448 assert( pKeyInfo
->db
==db
);
3449 nField
= pKeyInfo
->nAllField
;
3450 }else if( pOp
->p4type
==P4_INT32
){
3453 assert( pOp
->p1
>=0 );
3454 assert( nField
>=0 );
3455 testcase( nField
==0 ); /* Table with INTEGER PRIMARY KEY and nothing else */
3456 pCur
= allocateCursor(p
, pOp
->p1
, nField
, iDb
, CURTYPE_BTREE
);
3457 if( pCur
==0 ) goto no_mem
;
3459 pCur
->isOrdered
= 1;
3460 pCur
->pgnoRoot
= p2
;
3462 pCur
->wrFlag
= wrFlag
;
3464 rc
= sqlite3BtreeCursor(pX
, p2
, wrFlag
, pKeyInfo
, pCur
->uc
.pCursor
);
3465 pCur
->pKeyInfo
= pKeyInfo
;
3466 /* Set the VdbeCursor.isTable variable. Previous versions of
3467 ** SQLite used to check if the root-page flags were sane at this point
3468 ** and report database corruption if they were not, but this check has
3469 ** since moved into the btree layer. */
3470 pCur
->isTable
= pOp
->p4type
!=P4_KEYINFO
;
3472 open_cursor_set_hints
:
3473 assert( OPFLAG_BULKCSR
==BTREE_BULKLOAD
);
3474 assert( OPFLAG_SEEKEQ
==BTREE_SEEK_EQ
);
3475 testcase( pOp
->p5
& OPFLAG_BULKCSR
);
3476 #ifdef SQLITE_ENABLE_CURSOR_HINTS
3477 testcase( pOp
->p2
& OPFLAG_SEEKEQ
);
3479 sqlite3BtreeCursorHintFlags(pCur
->uc
.pCursor
,
3480 (pOp
->p5
& (OPFLAG_BULKCSR
|OPFLAG_SEEKEQ
)));
3481 if( rc
) goto abort_due_to_error
;
3485 /* Opcode: OpenDup P1 P2 * * *
3487 ** Open a new cursor P1 that points to the same ephemeral table as
3488 ** cursor P2. The P2 cursor must have been opened by a prior OP_OpenEphemeral
3489 ** opcode. Only ephemeral cursors may be duplicated.
3491 ** Duplicate ephemeral cursors are used for self-joins of materialized views.
3494 VdbeCursor
*pOrig
; /* The original cursor to be duplicated */
3495 VdbeCursor
*pCx
; /* The new cursor */
3497 pOrig
= p
->apCsr
[pOp
->p2
];
3498 assert( pOrig
->pBtx
!=0 ); /* Only ephemeral cursors can be duplicated */
3500 pCx
= allocateCursor(p
, pOp
->p1
, pOrig
->nField
, -1, CURTYPE_BTREE
);
3501 if( pCx
==0 ) goto no_mem
;
3503 pCx
->isEphemeral
= 1;
3504 pCx
->pKeyInfo
= pOrig
->pKeyInfo
;
3505 pCx
->isTable
= pOrig
->isTable
;
3506 rc
= sqlite3BtreeCursor(pOrig
->pBtx
, MASTER_ROOT
, BTREE_WRCSR
,
3507 pCx
->pKeyInfo
, pCx
->uc
.pCursor
);
3508 /* The sqlite3BtreeCursor() routine can only fail for the first cursor
3509 ** opened for a database. Since there is already an open cursor when this
3510 ** opcode is run, the sqlite3BtreeCursor() cannot fail */
3511 assert( rc
==SQLITE_OK
);
3516 /* Opcode: OpenEphemeral P1 P2 * P4 P5
3517 ** Synopsis: nColumn=P2
3519 ** Open a new cursor P1 to a transient table.
3520 ** The cursor is always opened read/write even if
3521 ** the main database is read-only. The ephemeral
3522 ** table is deleted automatically when the cursor is closed.
3524 ** P2 is the number of columns in the ephemeral table.
3525 ** The cursor points to a BTree table if P4==0 and to a BTree index
3526 ** if P4 is not 0. If P4 is not NULL, it points to a KeyInfo structure
3527 ** that defines the format of keys in the index.
3529 ** The P5 parameter can be a mask of the BTREE_* flags defined
3530 ** in btree.h. These flags control aspects of the operation of
3531 ** the btree. The BTREE_OMIT_JOURNAL and BTREE_SINGLE flags are
3532 ** added automatically.
3534 /* Opcode: OpenAutoindex P1 P2 * P4 *
3535 ** Synopsis: nColumn=P2
3537 ** This opcode works the same as OP_OpenEphemeral. It has a
3538 ** different name to distinguish its use. Tables created using
3539 ** by this opcode will be used for automatically created transient
3540 ** indices in joins.
3542 case OP_OpenAutoindex
:
3543 case OP_OpenEphemeral
: {
3547 static const int vfsFlags
=
3548 SQLITE_OPEN_READWRITE
|
3549 SQLITE_OPEN_CREATE
|
3550 SQLITE_OPEN_EXCLUSIVE
|
3551 SQLITE_OPEN_DELETEONCLOSE
|
3552 SQLITE_OPEN_TRANSIENT_DB
;
3553 assert( pOp
->p1
>=0 );
3554 assert( pOp
->p2
>=0 );
3555 pCx
= allocateCursor(p
, pOp
->p1
, pOp
->p2
, -1, CURTYPE_BTREE
);
3556 if( pCx
==0 ) goto no_mem
;
3558 pCx
->isEphemeral
= 1;
3559 rc
= sqlite3BtreeOpen(db
->pVfs
, 0, db
, &pCx
->pBtx
,
3560 BTREE_OMIT_JOURNAL
| BTREE_SINGLE
| pOp
->p5
, vfsFlags
);
3561 if( rc
==SQLITE_OK
){
3562 rc
= sqlite3BtreeBeginTrans(pCx
->pBtx
, 1);
3564 if( rc
==SQLITE_OK
){
3565 /* If a transient index is required, create it by calling
3566 ** sqlite3BtreeCreateTable() with the BTREE_BLOBKEY flag before
3567 ** opening it. If a transient table is required, just use the
3568 ** automatically created table with root-page 1 (an BLOB_INTKEY table).
3570 if( (pCx
->pKeyInfo
= pKeyInfo
= pOp
->p4
.pKeyInfo
)!=0 ){
3572 assert( pOp
->p4type
==P4_KEYINFO
);
3573 rc
= sqlite3BtreeCreateTable(pCx
->pBtx
, &pgno
, BTREE_BLOBKEY
| pOp
->p5
);
3574 if( rc
==SQLITE_OK
){
3575 assert( pgno
==MASTER_ROOT
+1 );
3576 assert( pKeyInfo
->db
==db
);
3577 assert( pKeyInfo
->enc
==ENC(db
) );
3578 rc
= sqlite3BtreeCursor(pCx
->pBtx
, pgno
, BTREE_WRCSR
,
3579 pKeyInfo
, pCx
->uc
.pCursor
);
3583 rc
= sqlite3BtreeCursor(pCx
->pBtx
, MASTER_ROOT
, BTREE_WRCSR
,
3584 0, pCx
->uc
.pCursor
);
3588 if( rc
) goto abort_due_to_error
;
3589 pCx
->isOrdered
= (pOp
->p5
!=BTREE_UNORDERED
);
3593 /* Opcode: SorterOpen P1 P2 P3 P4 *
3595 ** This opcode works like OP_OpenEphemeral except that it opens
3596 ** a transient index that is specifically designed to sort large
3597 ** tables using an external merge-sort algorithm.
3599 ** If argument P3 is non-zero, then it indicates that the sorter may
3600 ** assume that a stable sort considering the first P3 fields of each
3601 ** key is sufficient to produce the required results.
3603 case OP_SorterOpen
: {
3606 assert( pOp
->p1
>=0 );
3607 assert( pOp
->p2
>=0 );
3608 pCx
= allocateCursor(p
, pOp
->p1
, pOp
->p2
, -1, CURTYPE_SORTER
);
3609 if( pCx
==0 ) goto no_mem
;
3610 pCx
->pKeyInfo
= pOp
->p4
.pKeyInfo
;
3611 assert( pCx
->pKeyInfo
->db
==db
);
3612 assert( pCx
->pKeyInfo
->enc
==ENC(db
) );
3613 rc
= sqlite3VdbeSorterInit(db
, pOp
->p3
, pCx
);
3614 if( rc
) goto abort_due_to_error
;
3618 /* Opcode: SequenceTest P1 P2 * * *
3619 ** Synopsis: if( cursor[P1].ctr++ ) pc = P2
3621 ** P1 is a sorter cursor. If the sequence counter is currently zero, jump
3622 ** to P2. Regardless of whether or not the jump is taken, increment the
3623 ** the sequence value.
3625 case OP_SequenceTest
: {
3627 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
3628 pC
= p
->apCsr
[pOp
->p1
];
3629 assert( isSorter(pC
) );
3630 if( (pC
->seqCount
++)==0 ){
3636 /* Opcode: OpenPseudo P1 P2 P3 * *
3637 ** Synopsis: P3 columns in r[P2]
3639 ** Open a new cursor that points to a fake table that contains a single
3640 ** row of data. The content of that one row is the content of memory
3641 ** register P2. In other words, cursor P1 becomes an alias for the
3642 ** MEM_Blob content contained in register P2.
3644 ** A pseudo-table created by this opcode is used to hold a single
3645 ** row output from the sorter so that the row can be decomposed into
3646 ** individual columns using the OP_Column opcode. The OP_Column opcode
3647 ** is the only cursor opcode that works with a pseudo-table.
3649 ** P3 is the number of fields in the records that will be stored by
3650 ** the pseudo-table.
3652 case OP_OpenPseudo
: {
3655 assert( pOp
->p1
>=0 );
3656 assert( pOp
->p3
>=0 );
3657 pCx
= allocateCursor(p
, pOp
->p1
, pOp
->p3
, -1, CURTYPE_PSEUDO
);
3658 if( pCx
==0 ) goto no_mem
;
3660 pCx
->seekResult
= pOp
->p2
;
3662 /* Give this pseudo-cursor a fake BtCursor pointer so that pCx
3663 ** can be safely passed to sqlite3VdbeCursorMoveto(). This avoids a test
3664 ** for pCx->eCurType==CURTYPE_BTREE inside of sqlite3VdbeCursorMoveto()
3665 ** which is a performance optimization */
3666 pCx
->uc
.pCursor
= sqlite3BtreeFakeValidCursor();
3667 assert( pOp
->p5
==0 );
3671 /* Opcode: Close P1 * * * *
3673 ** Close a cursor previously opened as P1. If P1 is not
3674 ** currently open, this instruction is a no-op.
3677 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
3678 sqlite3VdbeFreeCursor(p
, p
->apCsr
[pOp
->p1
]);
3679 p
->apCsr
[pOp
->p1
] = 0;
3683 #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
3684 /* Opcode: ColumnsUsed P1 * * P4 *
3686 ** This opcode (which only exists if SQLite was compiled with
3687 ** SQLITE_ENABLE_COLUMN_USED_MASK) identifies which columns of the
3688 ** table or index for cursor P1 are used. P4 is a 64-bit integer
3689 ** (P4_INT64) in which the first 63 bits are one for each of the
3690 ** first 63 columns of the table or index that are actually used
3691 ** by the cursor. The high-order bit is set if any column after
3692 ** the 64th is used.
3694 case OP_ColumnsUsed
: {
3696 pC
= p
->apCsr
[pOp
->p1
];
3697 assert( pC
->eCurType
==CURTYPE_BTREE
);
3698 pC
->maskUsed
= *(u64
*)pOp
->p4
.pI64
;
3703 /* Opcode: SeekGE P1 P2 P3 P4 *
3704 ** Synopsis: key=r[P3@P4]
3706 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3707 ** use the value in register P3 as the key. If cursor P1 refers
3708 ** to an SQL index, then P3 is the first in an array of P4 registers
3709 ** that are used as an unpacked index key.
3711 ** Reposition cursor P1 so that it points to the smallest entry that
3712 ** is greater than or equal to the key value. If there are no records
3713 ** greater than or equal to the key and P2 is not zero, then jump to P2.
3715 ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3716 ** opcode will always land on a record that equally equals the key, or
3717 ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3718 ** opcode must be followed by an IdxLE opcode with the same arguments.
3719 ** The IdxLE opcode will be skipped if this opcode succeeds, but the
3720 ** IdxLE opcode will be used on subsequent loop iterations.
3722 ** This opcode leaves the cursor configured to move in forward order,
3723 ** from the beginning toward the end. In other words, the cursor is
3724 ** configured to use Next, not Prev.
3726 ** See also: Found, NotFound, SeekLt, SeekGt, SeekLe
3728 /* Opcode: SeekGT P1 P2 P3 P4 *
3729 ** Synopsis: key=r[P3@P4]
3731 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3732 ** use the value in register P3 as a key. If cursor P1 refers
3733 ** to an SQL index, then P3 is the first in an array of P4 registers
3734 ** that are used as an unpacked index key.
3736 ** Reposition cursor P1 so that it points to the smallest entry that
3737 ** is greater than the key value. If there are no records greater than
3738 ** the key and P2 is not zero, then jump to P2.
3740 ** This opcode leaves the cursor configured to move in forward order,
3741 ** from the beginning toward the end. In other words, the cursor is
3742 ** configured to use Next, not Prev.
3744 ** See also: Found, NotFound, SeekLt, SeekGe, SeekLe
3746 /* Opcode: SeekLT P1 P2 P3 P4 *
3747 ** Synopsis: key=r[P3@P4]
3749 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3750 ** use the value in register P3 as a key. If cursor P1 refers
3751 ** to an SQL index, then P3 is the first in an array of P4 registers
3752 ** that are used as an unpacked index key.
3754 ** Reposition cursor P1 so that it points to the largest entry that
3755 ** is less than the key value. If there are no records less than
3756 ** the key and P2 is not zero, then jump to P2.
3758 ** This opcode leaves the cursor configured to move in reverse order,
3759 ** from the end toward the beginning. In other words, the cursor is
3760 ** configured to use Prev, not Next.
3762 ** See also: Found, NotFound, SeekGt, SeekGe, SeekLe
3764 /* Opcode: SeekLE P1 P2 P3 P4 *
3765 ** Synopsis: key=r[P3@P4]
3767 ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
3768 ** use the value in register P3 as a key. If cursor P1 refers
3769 ** to an SQL index, then P3 is the first in an array of P4 registers
3770 ** that are used as an unpacked index key.
3772 ** Reposition cursor P1 so that it points to the largest entry that
3773 ** is less than or equal to the key value. If there are no records
3774 ** less than or equal to the key and P2 is not zero, then jump to P2.
3776 ** This opcode leaves the cursor configured to move in reverse order,
3777 ** from the end toward the beginning. In other words, the cursor is
3778 ** configured to use Prev, not Next.
3780 ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3781 ** opcode will always land on a record that equally equals the key, or
3782 ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3783 ** opcode must be followed by an IdxGE opcode with the same arguments.
3784 ** The IdxGE opcode will be skipped if this opcode succeeds, but the
3785 ** IdxGE opcode will be used on subsequent loop iterations.
3787 ** See also: Found, NotFound, SeekGt, SeekGe, SeekLt
3789 case OP_SeekLT
: /* jump, in3 */
3790 case OP_SeekLE
: /* jump, in3 */
3791 case OP_SeekGE
: /* jump, in3 */
3792 case OP_SeekGT
: { /* jump, in3 */
3793 int res
; /* Comparison result */
3794 int oc
; /* Opcode */
3795 VdbeCursor
*pC
; /* The cursor to seek */
3796 UnpackedRecord r
; /* The key to seek for */
3797 int nField
; /* Number of columns or fields in the key */
3798 i64 iKey
; /* The rowid we are to seek to */
3799 int eqOnly
; /* Only interested in == results */
3801 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
3802 assert( pOp
->p2
!=0 );
3803 pC
= p
->apCsr
[pOp
->p1
];
3805 assert( pC
->eCurType
==CURTYPE_BTREE
);
3806 assert( OP_SeekLE
== OP_SeekLT
+1 );
3807 assert( OP_SeekGE
== OP_SeekLT
+2 );
3808 assert( OP_SeekGT
== OP_SeekLT
+3 );
3809 assert( pC
->isOrdered
);
3810 assert( pC
->uc
.pCursor
!=0 );
3815 pC
->seekOp
= pOp
->opcode
;
3819 /* The BTREE_SEEK_EQ flag is only set on index cursors */
3820 assert( sqlite3BtreeCursorHasHint(pC
->uc
.pCursor
, BTREE_SEEK_EQ
)==0
3823 /* The input value in P3 might be of any type: integer, real, string,
3824 ** blob, or NULL. But it needs to be an integer before we can do
3825 ** the seek, so convert it. */
3826 pIn3
= &aMem
[pOp
->p3
];
3827 if( (pIn3
->flags
& (MEM_Int
|MEM_Real
|MEM_Str
))==MEM_Str
){
3828 applyNumericAffinity(pIn3
, 0);
3830 iKey
= sqlite3VdbeIntValue(pIn3
);
3832 /* If the P3 value could not be converted into an integer without
3833 ** loss of information, then special processing is required... */
3834 if( (pIn3
->flags
& MEM_Int
)==0 ){
3835 if( (pIn3
->flags
& MEM_Real
)==0 ){
3836 /* If the P3 value cannot be converted into any kind of a number,
3837 ** then the seek is not possible, so jump to P2 */
3838 VdbeBranchTaken(1,2); goto jump_to_p2
;
3842 /* If the approximation iKey is larger than the actual real search
3843 ** term, substitute >= for > and < for <=. e.g. if the search term
3844 ** is 4.9 and the integer approximation 5:
3846 ** (x > 4.9) -> (x >= 5)
3847 ** (x <= 4.9) -> (x < 5)
3849 if( pIn3
->u
.r
<(double)iKey
){
3850 assert( OP_SeekGE
==(OP_SeekGT
-1) );
3851 assert( OP_SeekLT
==(OP_SeekLE
-1) );
3852 assert( (OP_SeekLE
& 0x0001)==(OP_SeekGT
& 0x0001) );
3853 if( (oc
& 0x0001)==(OP_SeekGT
& 0x0001) ) oc
--;
3856 /* If the approximation iKey is smaller than the actual real search
3857 ** term, substitute <= for < and > for >=. */
3858 else if( pIn3
->u
.r
>(double)iKey
){
3859 assert( OP_SeekLE
==(OP_SeekLT
+1) );
3860 assert( OP_SeekGT
==(OP_SeekGE
+1) );
3861 assert( (OP_SeekLT
& 0x0001)==(OP_SeekGE
& 0x0001) );
3862 if( (oc
& 0x0001)==(OP_SeekLT
& 0x0001) ) oc
++;
3865 rc
= sqlite3BtreeMovetoUnpacked(pC
->uc
.pCursor
, 0, (u64
)iKey
, 0, &res
);
3866 pC
->movetoTarget
= iKey
; /* Used by OP_Delete */
3867 if( rc
!=SQLITE_OK
){
3868 goto abort_due_to_error
;
3871 /* For a cursor with the BTREE_SEEK_EQ hint, only the OP_SeekGE and
3872 ** OP_SeekLE opcodes are allowed, and these must be immediately followed
3873 ** by an OP_IdxGT or OP_IdxLT opcode, respectively, with the same key.
3875 if( sqlite3BtreeCursorHasHint(pC
->uc
.pCursor
, BTREE_SEEK_EQ
) ){
3877 assert( pOp
->opcode
==OP_SeekGE
|| pOp
->opcode
==OP_SeekLE
);
3878 assert( pOp
[1].opcode
==OP_IdxLT
|| pOp
[1].opcode
==OP_IdxGT
);
3879 assert( pOp
[1].p1
==pOp
[0].p1
);
3880 assert( pOp
[1].p2
==pOp
[0].p2
);
3881 assert( pOp
[1].p3
==pOp
[0].p3
);
3882 assert( pOp
[1].p4
.i
==pOp
[0].p4
.i
);
3886 assert( pOp
->p4type
==P4_INT32
);
3888 r
.pKeyInfo
= pC
->pKeyInfo
;
3889 r
.nField
= (u16
)nField
;
3891 /* The next line of code computes as follows, only faster:
3892 ** if( oc==OP_SeekGT || oc==OP_SeekLE ){
3893 ** r.default_rc = -1;
3895 ** r.default_rc = +1;
3898 r
.default_rc
= ((1 & (oc
- OP_SeekLT
)) ? -1 : +1);
3899 assert( oc
!=OP_SeekGT
|| r
.default_rc
==-1 );
3900 assert( oc
!=OP_SeekLE
|| r
.default_rc
==-1 );
3901 assert( oc
!=OP_SeekGE
|| r
.default_rc
==+1 );
3902 assert( oc
!=OP_SeekLT
|| r
.default_rc
==+1 );
3904 r
.aMem
= &aMem
[pOp
->p3
];
3906 { int i
; for(i
=0; i
<r
.nField
; i
++) assert( memIsValid(&r
.aMem
[i
]) ); }
3909 rc
= sqlite3BtreeMovetoUnpacked(pC
->uc
.pCursor
, &r
, 0, 0, &res
);
3910 if( rc
!=SQLITE_OK
){
3911 goto abort_due_to_error
;
3913 if( eqOnly
&& r
.eqSeen
==0 ){
3915 goto seek_not_found
;
3918 pC
->deferredMoveto
= 0;
3919 pC
->cacheStatus
= CACHE_STALE
;
3921 sqlite3_search_count
++;
3923 if( oc
>=OP_SeekGE
){ assert( oc
==OP_SeekGE
|| oc
==OP_SeekGT
);
3924 if( res
<0 || (res
==0 && oc
==OP_SeekGT
) ){
3926 rc
= sqlite3BtreeNext(pC
->uc
.pCursor
, 0);
3927 if( rc
!=SQLITE_OK
){
3928 if( rc
==SQLITE_DONE
){
3932 goto abort_due_to_error
;
3939 assert( oc
==OP_SeekLT
|| oc
==OP_SeekLE
);
3940 if( res
>0 || (res
==0 && oc
==OP_SeekLT
) ){
3942 rc
= sqlite3BtreePrevious(pC
->uc
.pCursor
, 0);
3943 if( rc
!=SQLITE_OK
){
3944 if( rc
==SQLITE_DONE
){
3948 goto abort_due_to_error
;
3952 /* res might be negative because the table is empty. Check to
3953 ** see if this is the case.
3955 res
= sqlite3BtreeEof(pC
->uc
.pCursor
);
3959 assert( pOp
->p2
>0 );
3960 VdbeBranchTaken(res
!=0,2);
3964 assert( pOp
[1].opcode
==OP_IdxLT
|| pOp
[1].opcode
==OP_IdxGT
);
3965 pOp
++; /* Skip the OP_IdxLt or OP_IdxGT that follows */
3970 /* Opcode: Found P1 P2 P3 P4 *
3971 ** Synopsis: key=r[P3@P4]
3973 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
3974 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
3977 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
3978 ** is a prefix of any entry in P1 then a jump is made to P2 and
3979 ** P1 is left pointing at the matching entry.
3981 ** This operation leaves the cursor in a state where it can be
3982 ** advanced in the forward direction. The Next instruction will work,
3983 ** but not the Prev instruction.
3985 ** See also: NotFound, NoConflict, NotExists. SeekGe
3987 /* Opcode: NotFound P1 P2 P3 P4 *
3988 ** Synopsis: key=r[P3@P4]
3990 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
3991 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
3994 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
3995 ** is not the prefix of any entry in P1 then a jump is made to P2. If P1
3996 ** does contain an entry whose prefix matches the P3/P4 record then control
3997 ** falls through to the next instruction and P1 is left pointing at the
4000 ** This operation leaves the cursor in a state where it cannot be
4001 ** advanced in either direction. In other words, the Next and Prev
4002 ** opcodes do not work after this operation.
4004 ** See also: Found, NotExists, NoConflict
4006 /* Opcode: NoConflict P1 P2 P3 P4 *
4007 ** Synopsis: key=r[P3@P4]
4009 ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4010 ** P4>0 then register P3 is the first of P4 registers that form an unpacked
4013 ** Cursor P1 is on an index btree. If the record identified by P3 and P4
4014 ** contains any NULL value, jump immediately to P2. If all terms of the
4015 ** record are not-NULL then a check is done to determine if any row in the
4016 ** P1 index btree has a matching key prefix. If there are no matches, jump
4017 ** immediately to P2. If there is a match, fall through and leave the P1
4018 ** cursor pointing to the matching row.
4020 ** This opcode is similar to OP_NotFound with the exceptions that the
4021 ** branch is always taken if any part of the search key input is NULL.
4023 ** This operation leaves the cursor in a state where it cannot be
4024 ** advanced in either direction. In other words, the Next and Prev
4025 ** opcodes do not work after this operation.
4027 ** See also: NotFound, Found, NotExists
4029 case OP_NoConflict
: /* jump, in3 */
4030 case OP_NotFound
: /* jump, in3 */
4031 case OP_Found
: { /* jump, in3 */
4037 UnpackedRecord
*pFree
;
4038 UnpackedRecord
*pIdxKey
;
4042 if( pOp
->opcode
!=OP_NoConflict
) sqlite3_found_count
++;
4045 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4046 assert( pOp
->p4type
==P4_INT32
);
4047 pC
= p
->apCsr
[pOp
->p1
];
4050 pC
->seekOp
= pOp
->opcode
;
4052 pIn3
= &aMem
[pOp
->p3
];
4053 assert( pC
->eCurType
==CURTYPE_BTREE
);
4054 assert( pC
->uc
.pCursor
!=0 );
4055 assert( pC
->isTable
==0 );
4057 r
.pKeyInfo
= pC
->pKeyInfo
;
4058 r
.nField
= (u16
)pOp
->p4
.i
;
4061 for(ii
=0; ii
<r
.nField
; ii
++){
4062 assert( memIsValid(&r
.aMem
[ii
]) );
4063 assert( (r
.aMem
[ii
].flags
& MEM_Zero
)==0 || r
.aMem
[ii
].n
==0 );
4064 if( ii
) REGISTER_TRACE(pOp
->p3
+ii
, &r
.aMem
[ii
]);
4070 assert( pIn3
->flags
& MEM_Blob
);
4071 rc
= ExpandBlob(pIn3
);
4072 assert( rc
==SQLITE_OK
|| rc
==SQLITE_NOMEM
);
4073 if( rc
) goto no_mem
;
4074 pFree
= pIdxKey
= sqlite3VdbeAllocUnpackedRecord(pC
->pKeyInfo
);
4075 if( pIdxKey
==0 ) goto no_mem
;
4076 sqlite3VdbeRecordUnpack(pC
->pKeyInfo
, pIn3
->n
, pIn3
->z
, pIdxKey
);
4078 pIdxKey
->default_rc
= 0;
4080 if( pOp
->opcode
==OP_NoConflict
){
4081 /* For the OP_NoConflict opcode, take the jump if any of the
4082 ** input fields are NULL, since any key with a NULL will not
4084 for(ii
=0; ii
<pIdxKey
->nField
; ii
++){
4085 if( pIdxKey
->aMem
[ii
].flags
& MEM_Null
){
4091 rc
= sqlite3BtreeMovetoUnpacked(pC
->uc
.pCursor
, pIdxKey
, 0, 0, &res
);
4092 if( pFree
) sqlite3DbFreeNN(db
, pFree
);
4093 if( rc
!=SQLITE_OK
){
4094 goto abort_due_to_error
;
4096 pC
->seekResult
= res
;
4097 alreadyExists
= (res
==0);
4098 pC
->nullRow
= 1-alreadyExists
;
4099 pC
->deferredMoveto
= 0;
4100 pC
->cacheStatus
= CACHE_STALE
;
4101 if( pOp
->opcode
==OP_Found
){
4102 VdbeBranchTaken(alreadyExists
!=0,2);
4103 if( alreadyExists
) goto jump_to_p2
;
4105 VdbeBranchTaken(takeJump
||alreadyExists
==0,2);
4106 if( takeJump
|| !alreadyExists
) goto jump_to_p2
;
4111 /* Opcode: SeekRowid P1 P2 P3 * *
4112 ** Synopsis: intkey=r[P3]
4114 ** P1 is the index of a cursor open on an SQL table btree (with integer
4115 ** keys). If register P3 does not contain an integer or if P1 does not
4116 ** contain a record with rowid P3 then jump immediately to P2.
4117 ** Or, if P2 is 0, raise an SQLITE_CORRUPT error. If P1 does contain
4118 ** a record with rowid P3 then
4119 ** leave the cursor pointing at that record and fall through to the next
4122 ** The OP_NotExists opcode performs the same operation, but with OP_NotExists
4123 ** the P3 register must be guaranteed to contain an integer value. With this
4124 ** opcode, register P3 might not contain an integer.
4126 ** The OP_NotFound opcode performs the same operation on index btrees
4127 ** (with arbitrary multi-value keys).
4129 ** This opcode leaves the cursor in a state where it cannot be advanced
4130 ** in either direction. In other words, the Next and Prev opcodes will
4131 ** not work following this opcode.
4133 ** See also: Found, NotFound, NoConflict, SeekRowid
4135 /* Opcode: NotExists P1 P2 P3 * *
4136 ** Synopsis: intkey=r[P3]
4138 ** P1 is the index of a cursor open on an SQL table btree (with integer
4139 ** keys). P3 is an integer rowid. If P1 does not contain a record with
4140 ** rowid P3 then jump immediately to P2. Or, if P2 is 0, raise an
4141 ** SQLITE_CORRUPT error. If P1 does contain a record with rowid P3 then
4142 ** leave the cursor pointing at that record and fall through to the next
4145 ** The OP_SeekRowid opcode performs the same operation but also allows the
4146 ** P3 register to contain a non-integer value, in which case the jump is
4147 ** always taken. This opcode requires that P3 always contain an integer.
4149 ** The OP_NotFound opcode performs the same operation on index btrees
4150 ** (with arbitrary multi-value keys).
4152 ** This opcode leaves the cursor in a state where it cannot be advanced
4153 ** in either direction. In other words, the Next and Prev opcodes will
4154 ** not work following this opcode.
4156 ** See also: Found, NotFound, NoConflict, SeekRowid
4158 case OP_SeekRowid
: { /* jump, in3 */
4164 pIn3
= &aMem
[pOp
->p3
];
4165 if( (pIn3
->flags
& MEM_Int
)==0 ){
4166 applyAffinity(pIn3
, SQLITE_AFF_NUMERIC
, encoding
);
4167 if( (pIn3
->flags
& MEM_Int
)==0 ) goto jump_to_p2
;
4169 /* Fall through into OP_NotExists */
4170 case OP_NotExists
: /* jump, in3 */
4171 pIn3
= &aMem
[pOp
->p3
];
4172 assert( pIn3
->flags
& MEM_Int
);
4173 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4174 pC
= p
->apCsr
[pOp
->p1
];
4179 assert( pC
->isTable
);
4180 assert( pC
->eCurType
==CURTYPE_BTREE
);
4181 pCrsr
= pC
->uc
.pCursor
;
4185 rc
= sqlite3BtreeMovetoUnpacked(pCrsr
, 0, iKey
, 0, &res
);
4186 assert( rc
==SQLITE_OK
|| res
==0 );
4187 pC
->movetoTarget
= iKey
; /* Used by OP_Delete */
4189 pC
->cacheStatus
= CACHE_STALE
;
4190 pC
->deferredMoveto
= 0;
4191 VdbeBranchTaken(res
!=0,2);
4192 pC
->seekResult
= res
;
4194 assert( rc
==SQLITE_OK
);
4196 rc
= SQLITE_CORRUPT_BKPT
;
4201 if( rc
) goto abort_due_to_error
;
4205 /* Opcode: Sequence P1 P2 * * *
4206 ** Synopsis: r[P2]=cursor[P1].ctr++
4208 ** Find the next available sequence number for cursor P1.
4209 ** Write the sequence number into register P2.
4210 ** The sequence number on the cursor is incremented after this
4213 case OP_Sequence
: { /* out2 */
4214 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4215 assert( p
->apCsr
[pOp
->p1
]!=0 );
4216 assert( p
->apCsr
[pOp
->p1
]->eCurType
!=CURTYPE_VTAB
);
4217 pOut
= out2Prerelease(p
, pOp
);
4218 pOut
->u
.i
= p
->apCsr
[pOp
->p1
]->seqCount
++;
4223 /* Opcode: NewRowid P1 P2 P3 * *
4224 ** Synopsis: r[P2]=rowid
4226 ** Get a new integer record number (a.k.a "rowid") used as the key to a table.
4227 ** The record number is not previously used as a key in the database
4228 ** table that cursor P1 points to. The new record number is written
4229 ** written to register P2.
4231 ** If P3>0 then P3 is a register in the root frame of this VDBE that holds
4232 ** the largest previously generated record number. No new record numbers are
4233 ** allowed to be less than this value. When this value reaches its maximum,
4234 ** an SQLITE_FULL error is generated. The P3 register is updated with the '
4235 ** generated record number. This P3 mechanism is used to help implement the
4236 ** AUTOINCREMENT feature.
4238 case OP_NewRowid
: { /* out2 */
4239 i64 v
; /* The new rowid */
4240 VdbeCursor
*pC
; /* Cursor of table to get the new rowid */
4241 int res
; /* Result of an sqlite3BtreeLast() */
4242 int cnt
; /* Counter to limit the number of searches */
4243 Mem
*pMem
; /* Register holding largest rowid for AUTOINCREMENT */
4244 VdbeFrame
*pFrame
; /* Root frame of VDBE */
4248 pOut
= out2Prerelease(p
, pOp
);
4249 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4250 pC
= p
->apCsr
[pOp
->p1
];
4252 assert( pC
->eCurType
==CURTYPE_BTREE
);
4253 assert( pC
->uc
.pCursor
!=0 );
4255 /* The next rowid or record number (different terms for the same
4256 ** thing) is obtained in a two-step algorithm.
4258 ** First we attempt to find the largest existing rowid and add one
4259 ** to that. But if the largest existing rowid is already the maximum
4260 ** positive integer, we have to fall through to the second
4261 ** probabilistic algorithm
4263 ** The second algorithm is to select a rowid at random and see if
4264 ** it already exists in the table. If it does not exist, we have
4265 ** succeeded. If the random rowid does exist, we select a new one
4266 ** and try again, up to 100 times.
4268 assert( pC
->isTable
);
4270 #ifdef SQLITE_32BIT_ROWID
4271 # define MAX_ROWID 0x7fffffff
4273 /* Some compilers complain about constants of the form 0x7fffffffffffffff.
4274 ** Others complain about 0x7ffffffffffffffffLL. The following macro seems
4275 ** to provide the constant while making all compilers happy.
4277 # define MAX_ROWID (i64)( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
4280 if( !pC
->useRandomRowid
){
4281 rc
= sqlite3BtreeLast(pC
->uc
.pCursor
, &res
);
4282 if( rc
!=SQLITE_OK
){
4283 goto abort_due_to_error
;
4286 v
= 1; /* IMP: R-61914-48074 */
4288 assert( sqlite3BtreeCursorIsValid(pC
->uc
.pCursor
) );
4289 v
= sqlite3BtreeIntegerKey(pC
->uc
.pCursor
);
4291 pC
->useRandomRowid
= 1;
4293 v
++; /* IMP: R-29538-34987 */
4298 #ifndef SQLITE_OMIT_AUTOINCREMENT
4300 /* Assert that P3 is a valid memory cell. */
4301 assert( pOp
->p3
>0 );
4303 for(pFrame
=p
->pFrame
; pFrame
->pParent
; pFrame
=pFrame
->pParent
);
4304 /* Assert that P3 is a valid memory cell. */
4305 assert( pOp
->p3
<=pFrame
->nMem
);
4306 pMem
= &pFrame
->aMem
[pOp
->p3
];
4308 /* Assert that P3 is a valid memory cell. */
4309 assert( pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
4310 pMem
= &aMem
[pOp
->p3
];
4311 memAboutToChange(p
, pMem
);
4313 assert( memIsValid(pMem
) );
4315 REGISTER_TRACE(pOp
->p3
, pMem
);
4316 sqlite3VdbeMemIntegerify(pMem
);
4317 assert( (pMem
->flags
& MEM_Int
)!=0 ); /* mem(P3) holds an integer */
4318 if( pMem
->u
.i
==MAX_ROWID
|| pC
->useRandomRowid
){
4319 rc
= SQLITE_FULL
; /* IMP: R-17817-00630 */
4320 goto abort_due_to_error
;
4322 if( v
<pMem
->u
.i
+1 ){
4328 if( pC
->useRandomRowid
){
4329 /* IMPLEMENTATION-OF: R-07677-41881 If the largest ROWID is equal to the
4330 ** largest possible integer (9223372036854775807) then the database
4331 ** engine starts picking positive candidate ROWIDs at random until
4332 ** it finds one that is not previously used. */
4333 assert( pOp
->p3
==0 ); /* We cannot be in random rowid mode if this is
4334 ** an AUTOINCREMENT table. */
4337 sqlite3_randomness(sizeof(v
), &v
);
4338 v
&= (MAX_ROWID
>>1); v
++; /* Ensure that v is greater than zero */
4339 }while( ((rc
= sqlite3BtreeMovetoUnpacked(pC
->uc
.pCursor
, 0, (u64
)v
,
4340 0, &res
))==SQLITE_OK
)
4343 if( rc
) goto abort_due_to_error
;
4345 rc
= SQLITE_FULL
; /* IMP: R-38219-53002 */
4346 goto abort_due_to_error
;
4348 assert( v
>0 ); /* EV: R-40812-03570 */
4350 pC
->deferredMoveto
= 0;
4351 pC
->cacheStatus
= CACHE_STALE
;
4357 /* Opcode: Insert P1 P2 P3 P4 P5
4358 ** Synopsis: intkey=r[P3] data=r[P2]
4360 ** Write an entry into the table of cursor P1. A new entry is
4361 ** created if it doesn't already exist or the data for an existing
4362 ** entry is overwritten. The data is the value MEM_Blob stored in register
4363 ** number P2. The key is stored in register P3. The key must
4366 ** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
4367 ** incremented (otherwise not). If the OPFLAG_LASTROWID flag of P5 is set,
4368 ** then rowid is stored for subsequent return by the
4369 ** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
4371 ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
4372 ** run faster by avoiding an unnecessary seek on cursor P1. However,
4373 ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
4374 ** seeks on the cursor or if the most recent seek used a key equal to P3.
4376 ** If the OPFLAG_ISUPDATE flag is set, then this opcode is part of an
4377 ** UPDATE operation. Otherwise (if the flag is clear) then this opcode
4378 ** is part of an INSERT operation. The difference is only important to
4381 ** Parameter P4 may point to a Table structure, or may be NULL. If it is
4382 ** not NULL, then the update-hook (sqlite3.xUpdateCallback) is invoked
4383 ** following a successful insert.
4385 ** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
4386 ** allocated, then ownership of P2 is transferred to the pseudo-cursor
4387 ** and register P2 becomes ephemeral. If the cursor is changed, the
4388 ** value of register P2 will then change. Make sure this does not
4389 ** cause any problems.)
4391 ** This instruction only works on tables. The equivalent instruction
4392 ** for indices is OP_IdxInsert.
4394 /* Opcode: InsertInt P1 P2 P3 P4 P5
4395 ** Synopsis: intkey=P3 data=r[P2]
4397 ** This works exactly like OP_Insert except that the key is the
4398 ** integer value P3, not the value of the integer stored in register P3.
4401 case OP_InsertInt
: {
4402 Mem
*pData
; /* MEM cell holding data for the record to be inserted */
4403 Mem
*pKey
; /* MEM cell holding key for the record */
4404 VdbeCursor
*pC
; /* Cursor to table into which insert is written */
4405 int seekResult
; /* Result of prior seek or 0 if no USESEEKRESULT flag */
4406 const char *zDb
; /* database name - used by the update hook */
4407 Table
*pTab
; /* Table structure - used by update and pre-update hooks */
4408 int op
; /* Opcode for update hook: SQLITE_UPDATE or SQLITE_INSERT */
4409 BtreePayload x
; /* Payload to be inserted */
4412 pData
= &aMem
[pOp
->p2
];
4413 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4414 assert( memIsValid(pData
) );
4415 pC
= p
->apCsr
[pOp
->p1
];
4417 assert( pC
->eCurType
==CURTYPE_BTREE
);
4418 assert( pC
->uc
.pCursor
!=0 );
4419 assert( (pOp
->p5
& OPFLAG_ISNOOP
) || pC
->isTable
);
4420 assert( pOp
->p4type
==P4_TABLE
|| pOp
->p4type
>=P4_STATIC
);
4421 REGISTER_TRACE(pOp
->p2
, pData
);
4423 if( pOp
->opcode
==OP_Insert
){
4424 pKey
= &aMem
[pOp
->p3
];
4425 assert( pKey
->flags
& MEM_Int
);
4426 assert( memIsValid(pKey
) );
4427 REGISTER_TRACE(pOp
->p3
, pKey
);
4430 assert( pOp
->opcode
==OP_InsertInt
);
4434 if( pOp
->p4type
==P4_TABLE
&& HAS_UPDATE_HOOK(db
) ){
4435 assert( pC
->iDb
>=0 );
4436 zDb
= db
->aDb
[pC
->iDb
].zDbSName
;
4437 pTab
= pOp
->p4
.pTab
;
4438 assert( (pOp
->p5
& OPFLAG_ISNOOP
) || HasRowid(pTab
) );
4439 op
= ((pOp
->p5
& OPFLAG_ISUPDATE
) ? SQLITE_UPDATE
: SQLITE_INSERT
);
4441 pTab
= 0; /* Not needed. Silence a compiler warning. */
4442 zDb
= 0; /* Not needed. Silence a compiler warning. */
4445 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
4446 /* Invoke the pre-update hook, if any */
4447 if( db
->xPreUpdateCallback
4448 && pOp
->p4type
==P4_TABLE
4449 && !(pOp
->p5
& OPFLAG_ISUPDATE
)
4451 sqlite3VdbePreUpdateHook(p
, pC
, SQLITE_INSERT
, zDb
, pTab
, x
.nKey
, pOp
->p2
);
4453 if( pOp
->p5
& OPFLAG_ISNOOP
) break;
4456 if( pOp
->p5
& OPFLAG_NCHANGE
) p
->nChange
++;
4457 if( pOp
->p5
& OPFLAG_LASTROWID
) db
->lastRowid
= x
.nKey
;
4458 assert( pData
->flags
& (MEM_Blob
|MEM_Str
) );
4461 seekResult
= ((pOp
->p5
& OPFLAG_USESEEKRESULT
) ? pC
->seekResult
: 0);
4462 if( pData
->flags
& MEM_Zero
){
4463 x
.nZero
= pData
->u
.nZero
;
4468 rc
= sqlite3BtreeInsert(pC
->uc
.pCursor
, &x
,
4469 (pOp
->p5
& (OPFLAG_APPEND
|OPFLAG_SAVEPOSITION
)), seekResult
4471 pC
->deferredMoveto
= 0;
4472 pC
->cacheStatus
= CACHE_STALE
;
4474 /* Invoke the update-hook if required. */
4475 if( rc
) goto abort_due_to_error
;
4476 if( db
->xUpdateCallback
&& op
){
4477 db
->xUpdateCallback(db
->pUpdateArg
, op
, zDb
, pTab
->zName
, x
.nKey
);
4482 /* Opcode: Delete P1 P2 P3 P4 P5
4484 ** Delete the record at which the P1 cursor is currently pointing.
4486 ** If the OPFLAG_SAVEPOSITION bit of the P5 parameter is set, then
4487 ** the cursor will be left pointing at either the next or the previous
4488 ** record in the table. If it is left pointing at the next record, then
4489 ** the next Next instruction will be a no-op. As a result, in this case
4490 ** it is ok to delete a record from within a Next loop. If
4491 ** OPFLAG_SAVEPOSITION bit of P5 is clear, then the cursor will be
4492 ** left in an undefined state.
4494 ** If the OPFLAG_AUXDELETE bit is set on P5, that indicates that this
4495 ** delete one of several associated with deleting a table row and all its
4496 ** associated index entries. Exactly one of those deletes is the "primary"
4497 ** delete. The others are all on OPFLAG_FORDELETE cursors or else are
4498 ** marked with the AUXDELETE flag.
4500 ** If the OPFLAG_NCHANGE flag of P2 (NB: P2 not P5) is set, then the row
4501 ** change count is incremented (otherwise not).
4503 ** P1 must not be pseudo-table. It has to be a real table with
4506 ** If P4 is not NULL then it points to a Table object. In this case either
4507 ** the update or pre-update hook, or both, may be invoked. The P1 cursor must
4508 ** have been positioned using OP_NotFound prior to invoking this opcode in
4509 ** this case. Specifically, if one is configured, the pre-update hook is
4510 ** invoked if P4 is not NULL. The update-hook is invoked if one is configured,
4511 ** P4 is not NULL, and the OPFLAG_NCHANGE flag is set in P2.
4513 ** If the OPFLAG_ISUPDATE flag is set in P2, then P3 contains the address
4514 ** of the memory cell that contains the value that the rowid of the row will
4515 ** be set to by the update.
4524 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4525 pC
= p
->apCsr
[pOp
->p1
];
4527 assert( pC
->eCurType
==CURTYPE_BTREE
);
4528 assert( pC
->uc
.pCursor
!=0 );
4529 assert( pC
->deferredMoveto
==0 );
4532 if( pOp
->p4type
==P4_TABLE
&& HasRowid(pOp
->p4
.pTab
) && pOp
->p5
==0 ){
4533 /* If p5 is zero, the seek operation that positioned the cursor prior to
4534 ** OP_Delete will have also set the pC->movetoTarget field to the rowid of
4535 ** the row that is being deleted */
4536 i64 iKey
= sqlite3BtreeIntegerKey(pC
->uc
.pCursor
);
4537 assert( pC
->movetoTarget
==iKey
);
4541 /* If the update-hook or pre-update-hook will be invoked, set zDb to
4542 ** the name of the db to pass as to it. Also set local pTab to a copy
4543 ** of p4.pTab. Finally, if p5 is true, indicating that this cursor was
4544 ** last moved with OP_Next or OP_Prev, not Seek or NotFound, set
4545 ** VdbeCursor.movetoTarget to the current rowid. */
4546 if( pOp
->p4type
==P4_TABLE
&& HAS_UPDATE_HOOK(db
) ){
4547 assert( pC
->iDb
>=0 );
4548 assert( pOp
->p4
.pTab
!=0 );
4549 zDb
= db
->aDb
[pC
->iDb
].zDbSName
;
4550 pTab
= pOp
->p4
.pTab
;
4551 if( (pOp
->p5
& OPFLAG_SAVEPOSITION
)!=0 && pC
->isTable
){
4552 pC
->movetoTarget
= sqlite3BtreeIntegerKey(pC
->uc
.pCursor
);
4555 zDb
= 0; /* Not needed. Silence a compiler warning. */
4556 pTab
= 0; /* Not needed. Silence a compiler warning. */
4559 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
4560 /* Invoke the pre-update-hook if required. */
4561 if( db
->xPreUpdateCallback
&& pOp
->p4
.pTab
){
4562 assert( !(opflags
& OPFLAG_ISUPDATE
)
4563 || HasRowid(pTab
)==0
4564 || (aMem
[pOp
->p3
].flags
& MEM_Int
)
4566 sqlite3VdbePreUpdateHook(p
, pC
,
4567 (opflags
& OPFLAG_ISUPDATE
) ? SQLITE_UPDATE
: SQLITE_DELETE
,
4568 zDb
, pTab
, pC
->movetoTarget
,
4572 if( opflags
& OPFLAG_ISNOOP
) break;
4575 /* Only flags that can be set are SAVEPOISTION and AUXDELETE */
4576 assert( (pOp
->p5
& ~(OPFLAG_SAVEPOSITION
|OPFLAG_AUXDELETE
))==0 );
4577 assert( OPFLAG_SAVEPOSITION
==BTREE_SAVEPOSITION
);
4578 assert( OPFLAG_AUXDELETE
==BTREE_AUXDELETE
);
4582 if( pC
->isEphemeral
==0
4583 && (pOp
->p5
& OPFLAG_AUXDELETE
)==0
4584 && (pC
->wrFlag
& OPFLAG_FORDELETE
)==0
4588 if( pOp
->p2
& OPFLAG_NCHANGE
){
4594 rc
= sqlite3BtreeDelete(pC
->uc
.pCursor
, pOp
->p5
);
4595 pC
->cacheStatus
= CACHE_STALE
;
4597 if( rc
) goto abort_due_to_error
;
4599 /* Invoke the update-hook if required. */
4600 if( opflags
& OPFLAG_NCHANGE
){
4602 if( db
->xUpdateCallback
&& HasRowid(pTab
) ){
4603 db
->xUpdateCallback(db
->pUpdateArg
, SQLITE_DELETE
, zDb
, pTab
->zName
,
4605 assert( pC
->iDb
>=0 );
4611 /* Opcode: ResetCount * * * * *
4613 ** The value of the change counter is copied to the database handle
4614 ** change counter (returned by subsequent calls to sqlite3_changes()).
4615 ** Then the VMs internal change counter resets to 0.
4616 ** This is used by trigger programs.
4618 case OP_ResetCount
: {
4619 sqlite3VdbeSetChanges(db
, p
->nChange
);
4624 /* Opcode: SorterCompare P1 P2 P3 P4
4625 ** Synopsis: if key(P1)!=trim(r[P3],P4) goto P2
4627 ** P1 is a sorter cursor. This instruction compares a prefix of the
4628 ** record blob in register P3 against a prefix of the entry that
4629 ** the sorter cursor currently points to. Only the first P4 fields
4630 ** of r[P3] and the sorter record are compared.
4632 ** If either P3 or the sorter contains a NULL in one of their significant
4633 ** fields (not counting the P4 fields at the end which are ignored) then
4634 ** the comparison is assumed to be equal.
4636 ** Fall through to next instruction if the two records compare equal to
4637 ** each other. Jump to P2 if they are different.
4639 case OP_SorterCompare
: {
4644 pC
= p
->apCsr
[pOp
->p1
];
4645 assert( isSorter(pC
) );
4646 assert( pOp
->p4type
==P4_INT32
);
4647 pIn3
= &aMem
[pOp
->p3
];
4648 nKeyCol
= pOp
->p4
.i
;
4650 rc
= sqlite3VdbeSorterCompare(pC
, pIn3
, nKeyCol
, &res
);
4651 VdbeBranchTaken(res
!=0,2);
4652 if( rc
) goto abort_due_to_error
;
4653 if( res
) goto jump_to_p2
;
4657 /* Opcode: SorterData P1 P2 P3 * *
4658 ** Synopsis: r[P2]=data
4660 ** Write into register P2 the current sorter data for sorter cursor P1.
4661 ** Then clear the column header cache on cursor P3.
4663 ** This opcode is normally use to move a record out of the sorter and into
4664 ** a register that is the source for a pseudo-table cursor created using
4665 ** OpenPseudo. That pseudo-table cursor is the one that is identified by
4666 ** parameter P3. Clearing the P3 column cache as part of this opcode saves
4667 ** us from having to issue a separate NullRow instruction to clear that cache.
4669 case OP_SorterData
: {
4672 pOut
= &aMem
[pOp
->p2
];
4673 pC
= p
->apCsr
[pOp
->p1
];
4674 assert( isSorter(pC
) );
4675 rc
= sqlite3VdbeSorterRowkey(pC
, pOut
);
4676 assert( rc
!=SQLITE_OK
|| (pOut
->flags
& MEM_Blob
) );
4677 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4678 if( rc
) goto abort_due_to_error
;
4679 p
->apCsr
[pOp
->p3
]->cacheStatus
= CACHE_STALE
;
4683 /* Opcode: RowData P1 P2 P3 * *
4684 ** Synopsis: r[P2]=data
4686 ** Write into register P2 the complete row content for the row at
4687 ** which cursor P1 is currently pointing.
4688 ** There is no interpretation of the data.
4689 ** It is just copied onto the P2 register exactly as
4690 ** it is found in the database file.
4692 ** If cursor P1 is an index, then the content is the key of the row.
4693 ** If cursor P2 is a table, then the content extracted is the data.
4695 ** If the P1 cursor must be pointing to a valid row (not a NULL row)
4696 ** of a real table, not a pseudo-table.
4698 ** If P3!=0 then this opcode is allowed to make an ephermeral pointer
4699 ** into the database page. That means that the content of the output
4700 ** register will be invalidated as soon as the cursor moves - including
4701 ** moves caused by other cursors that "save" the the current cursors
4702 ** position in order that they can write to the same table. If P3==0
4703 ** then a copy of the data is made into memory. P3!=0 is faster, but
4706 ** If P3!=0 then the content of the P2 register is unsuitable for use
4707 ** in OP_Result and any OP_Result will invalidate the P2 register content.
4708 ** The P2 register content is invalidated by opcodes like OP_Function or
4709 ** by any use of another cursor pointing to the same table.
4716 pOut
= out2Prerelease(p
, pOp
);
4718 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4719 pC
= p
->apCsr
[pOp
->p1
];
4721 assert( pC
->eCurType
==CURTYPE_BTREE
);
4722 assert( isSorter(pC
)==0 );
4723 assert( pC
->nullRow
==0 );
4724 assert( pC
->uc
.pCursor
!=0 );
4725 pCrsr
= pC
->uc
.pCursor
;
4727 /* The OP_RowData opcodes always follow OP_NotExists or
4728 ** OP_SeekRowid or OP_Rewind/Op_Next with no intervening instructions
4729 ** that might invalidate the cursor.
4730 ** If this where not the case, on of the following assert()s
4731 ** would fail. Should this ever change (because of changes in the code
4732 ** generator) then the fix would be to insert a call to
4733 ** sqlite3VdbeCursorMoveto().
4735 assert( pC
->deferredMoveto
==0 );
4736 assert( sqlite3BtreeCursorIsValid(pCrsr
) );
4737 #if 0 /* Not required due to the previous to assert() statements */
4738 rc
= sqlite3VdbeCursorMoveto(pC
);
4739 if( rc
!=SQLITE_OK
) goto abort_due_to_error
;
4742 n
= sqlite3BtreePayloadSize(pCrsr
);
4743 if( n
>(u32
)db
->aLimit
[SQLITE_LIMIT_LENGTH
] ){
4747 rc
= sqlite3VdbeMemFromBtree(pCrsr
, 0, n
, pOut
);
4748 if( rc
) goto abort_due_to_error
;
4749 if( !pOp
->p3
) Deephemeralize(pOut
);
4750 UPDATE_MAX_BLOBSIZE(pOut
);
4751 REGISTER_TRACE(pOp
->p2
, pOut
);
4755 /* Opcode: Rowid P1 P2 * * *
4756 ** Synopsis: r[P2]=rowid
4758 ** Store in register P2 an integer which is the key of the table entry that
4759 ** P1 is currently point to.
4761 ** P1 can be either an ordinary table or a virtual table. There used to
4762 ** be a separate OP_VRowid opcode for use with virtual tables, but this
4763 ** one opcode now works for both table types.
4765 case OP_Rowid
: { /* out2 */
4768 sqlite3_vtab
*pVtab
;
4769 const sqlite3_module
*pModule
;
4771 pOut
= out2Prerelease(p
, pOp
);
4772 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4773 pC
= p
->apCsr
[pOp
->p1
];
4775 assert( pC
->eCurType
!=CURTYPE_PSEUDO
|| pC
->nullRow
);
4777 pOut
->flags
= MEM_Null
;
4779 }else if( pC
->deferredMoveto
){
4780 v
= pC
->movetoTarget
;
4781 #ifndef SQLITE_OMIT_VIRTUALTABLE
4782 }else if( pC
->eCurType
==CURTYPE_VTAB
){
4783 assert( pC
->uc
.pVCur
!=0 );
4784 pVtab
= pC
->uc
.pVCur
->pVtab
;
4785 pModule
= pVtab
->pModule
;
4786 assert( pModule
->xRowid
);
4787 rc
= pModule
->xRowid(pC
->uc
.pVCur
, &v
);
4788 sqlite3VtabImportErrmsg(p
, pVtab
);
4789 if( rc
) goto abort_due_to_error
;
4790 #endif /* SQLITE_OMIT_VIRTUALTABLE */
4792 assert( pC
->eCurType
==CURTYPE_BTREE
);
4793 assert( pC
->uc
.pCursor
!=0 );
4794 rc
= sqlite3VdbeCursorRestore(pC
);
4795 if( rc
) goto abort_due_to_error
;
4797 pOut
->flags
= MEM_Null
;
4800 v
= sqlite3BtreeIntegerKey(pC
->uc
.pCursor
);
4806 /* Opcode: NullRow P1 * * * *
4808 ** Move the cursor P1 to a null row. Any OP_Column operations
4809 ** that occur while the cursor is on the null row will always
4815 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4816 pC
= p
->apCsr
[pOp
->p1
];
4819 pC
->cacheStatus
= CACHE_STALE
;
4820 if( pC
->eCurType
==CURTYPE_BTREE
){
4821 assert( pC
->uc
.pCursor
!=0 );
4822 sqlite3BtreeClearCursor(pC
->uc
.pCursor
);
4827 /* Opcode: SeekEnd P1 * * * *
4829 ** Position cursor P1 at the end of the btree for the purpose of
4830 ** appending a new entry onto the btree.
4832 ** It is assumed that the cursor is used only for appending and so
4833 ** if the cursor is valid, then the cursor must already be pointing
4834 ** at the end of the btree and so no changes are made to
4837 /* Opcode: Last P1 P2 * * *
4839 ** The next use of the Rowid or Column or Prev instruction for P1
4840 ** will refer to the last entry in the database table or index.
4841 ** If the table or index is empty and P2>0, then jump immediately to P2.
4842 ** If P2 is 0 or if the table or index is not empty, fall through
4843 ** to the following instruction.
4845 ** This opcode leaves the cursor configured to move in reverse order,
4846 ** from the end toward the beginning. In other words, the cursor is
4847 ** configured to use Prev, not Next.
4850 case OP_Last
: { /* jump */
4855 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4856 pC
= p
->apCsr
[pOp
->p1
];
4858 assert( pC
->eCurType
==CURTYPE_BTREE
);
4859 pCrsr
= pC
->uc
.pCursor
;
4863 pC
->seekOp
= pOp
->opcode
;
4865 if( pOp
->opcode
==OP_SeekEnd
){
4866 assert( pOp
->p2
==0 );
4867 pC
->seekResult
= -1;
4868 if( sqlite3BtreeCursorIsValidNN(pCrsr
) ){
4872 rc
= sqlite3BtreeLast(pCrsr
, &res
);
4873 pC
->nullRow
= (u8
)res
;
4874 pC
->deferredMoveto
= 0;
4875 pC
->cacheStatus
= CACHE_STALE
;
4876 if( rc
) goto abort_due_to_error
;
4878 VdbeBranchTaken(res
!=0,2);
4879 if( res
) goto jump_to_p2
;
4884 /* Opcode: IfSmaller P1 P2 P3 * *
4886 ** Estimate the number of rows in the table P1. Jump to P2 if that
4887 ** estimate is less than approximately 2**(0.1*P3).
4889 case OP_IfSmaller
: { /* jump */
4895 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4896 pC
= p
->apCsr
[pOp
->p1
];
4898 pCrsr
= pC
->uc
.pCursor
;
4900 rc
= sqlite3BtreeFirst(pCrsr
, &res
);
4901 if( rc
) goto abort_due_to_error
;
4903 sz
= sqlite3BtreeRowCountEst(pCrsr
);
4904 if( ALWAYS(sz
>=0) && sqlite3LogEst((u64
)sz
)<pOp
->p3
) res
= 1;
4906 VdbeBranchTaken(res
!=0,2);
4907 if( res
) goto jump_to_p2
;
4912 /* Opcode: SorterSort P1 P2 * * *
4914 ** After all records have been inserted into the Sorter object
4915 ** identified by P1, invoke this opcode to actually do the sorting.
4916 ** Jump to P2 if there are no records to be sorted.
4918 ** This opcode is an alias for OP_Sort and OP_Rewind that is used
4919 ** for Sorter objects.
4921 /* Opcode: Sort P1 P2 * * *
4923 ** This opcode does exactly the same thing as OP_Rewind except that
4924 ** it increments an undocumented global variable used for testing.
4926 ** Sorting is accomplished by writing records into a sorting index,
4927 ** then rewinding that index and playing it back from beginning to
4928 ** end. We use the OP_Sort opcode instead of OP_Rewind to do the
4929 ** rewinding so that the global variable will be incremented and
4930 ** regression tests can determine whether or not the optimizer is
4931 ** correctly optimizing out sorts.
4933 case OP_SorterSort
: /* jump */
4934 case OP_Sort
: { /* jump */
4936 sqlite3_sort_count
++;
4937 sqlite3_search_count
--;
4939 p
->aCounter
[SQLITE_STMTSTATUS_SORT
]++;
4940 /* Fall through into OP_Rewind */
4942 /* Opcode: Rewind P1 P2 * * *
4944 ** The next use of the Rowid or Column or Next instruction for P1
4945 ** will refer to the first entry in the database table or index.
4946 ** If the table or index is empty, jump immediately to P2.
4947 ** If the table or index is not empty, fall through to the following
4950 ** This opcode leaves the cursor configured to move in forward order,
4951 ** from the beginning toward the end. In other words, the cursor is
4952 ** configured to use Next, not Prev.
4954 case OP_Rewind
: { /* jump */
4959 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
4960 pC
= p
->apCsr
[pOp
->p1
];
4962 assert( isSorter(pC
)==(pOp
->opcode
==OP_SorterSort
) );
4965 pC
->seekOp
= OP_Rewind
;
4968 rc
= sqlite3VdbeSorterRewind(pC
, &res
);
4970 assert( pC
->eCurType
==CURTYPE_BTREE
);
4971 pCrsr
= pC
->uc
.pCursor
;
4973 rc
= sqlite3BtreeFirst(pCrsr
, &res
);
4974 pC
->deferredMoveto
= 0;
4975 pC
->cacheStatus
= CACHE_STALE
;
4977 if( rc
) goto abort_due_to_error
;
4978 pC
->nullRow
= (u8
)res
;
4979 assert( pOp
->p2
>0 && pOp
->p2
<p
->nOp
);
4980 VdbeBranchTaken(res
!=0,2);
4981 if( res
) goto jump_to_p2
;
4985 /* Opcode: Next P1 P2 P3 P4 P5
4987 ** Advance cursor P1 so that it points to the next key/data pair in its
4988 ** table or index. If there are no more key/value pairs then fall through
4989 ** to the following instruction. But if the cursor advance was successful,
4990 ** jump immediately to P2.
4992 ** The Next opcode is only valid following an SeekGT, SeekGE, or
4993 ** OP_Rewind opcode used to position the cursor. Next is not allowed
4994 ** to follow SeekLT, SeekLE, or OP_Last.
4996 ** The P1 cursor must be for a real table, not a pseudo-table. P1 must have
4997 ** been opened prior to this opcode or the program will segfault.
4999 ** The P3 value is a hint to the btree implementation. If P3==1, that
5000 ** means P1 is an SQL index and that this instruction could have been
5001 ** omitted if that index had been unique. P3 is usually 0. P3 is
5002 ** always either 0 or 1.
5004 ** P4 is always of type P4_ADVANCE. The function pointer points to
5005 ** sqlite3BtreeNext().
5007 ** If P5 is positive and the jump is taken, then event counter
5008 ** number P5-1 in the prepared statement is incremented.
5010 ** See also: Prev, NextIfOpen
5012 /* Opcode: NextIfOpen P1 P2 P3 P4 P5
5014 ** This opcode works just like Next except that if cursor P1 is not
5015 ** open it behaves a no-op.
5017 /* Opcode: Prev P1 P2 P3 P4 P5
5019 ** Back up cursor P1 so that it points to the previous key/data pair in its
5020 ** table or index. If there is no previous key/value pairs then fall through
5021 ** to the following instruction. But if the cursor backup was successful,
5022 ** jump immediately to P2.
5025 ** The Prev opcode is only valid following an SeekLT, SeekLE, or
5026 ** OP_Last opcode used to position the cursor. Prev is not allowed
5027 ** to follow SeekGT, SeekGE, or OP_Rewind.
5029 ** The P1 cursor must be for a real table, not a pseudo-table. If P1 is
5030 ** not open then the behavior is undefined.
5032 ** The P3 value is a hint to the btree implementation. If P3==1, that
5033 ** means P1 is an SQL index and that this instruction could have been
5034 ** omitted if that index had been unique. P3 is usually 0. P3 is
5035 ** always either 0 or 1.
5037 ** P4 is always of type P4_ADVANCE. The function pointer points to
5038 ** sqlite3BtreePrevious().
5040 ** If P5 is positive and the jump is taken, then event counter
5041 ** number P5-1 in the prepared statement is incremented.
5043 /* Opcode: PrevIfOpen P1 P2 P3 P4 P5
5045 ** This opcode works just like Prev except that if cursor P1 is not
5046 ** open it behaves a no-op.
5048 /* Opcode: SorterNext P1 P2 * * P5
5050 ** This opcode works just like OP_Next except that P1 must be a
5051 ** sorter object for which the OP_SorterSort opcode has been
5052 ** invoked. This opcode advances the cursor to the next sorted
5053 ** record, or jumps to P2 if there are no more sorted records.
5055 case OP_SorterNext
: { /* jump */
5058 pC
= p
->apCsr
[pOp
->p1
];
5059 assert( isSorter(pC
) );
5060 rc
= sqlite3VdbeSorterNext(db
, pC
);
5062 case OP_PrevIfOpen
: /* jump */
5063 case OP_NextIfOpen
: /* jump */
5064 if( p
->apCsr
[pOp
->p1
]==0 ) break;
5066 case OP_Prev
: /* jump */
5067 case OP_Next
: /* jump */
5068 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5069 assert( pOp
->p5
<ArraySize(p
->aCounter
) );
5070 pC
= p
->apCsr
[pOp
->p1
];
5072 assert( pC
->deferredMoveto
==0 );
5073 assert( pC
->eCurType
==CURTYPE_BTREE
);
5074 assert( pOp
->opcode
!=OP_Next
|| pOp
->p4
.xAdvance
==sqlite3BtreeNext
);
5075 assert( pOp
->opcode
!=OP_Prev
|| pOp
->p4
.xAdvance
==sqlite3BtreePrevious
);
5076 assert( pOp
->opcode
!=OP_NextIfOpen
|| pOp
->p4
.xAdvance
==sqlite3BtreeNext
);
5077 assert( pOp
->opcode
!=OP_PrevIfOpen
|| pOp
->p4
.xAdvance
==sqlite3BtreePrevious
);
5079 /* The Next opcode is only used after SeekGT, SeekGE, and Rewind.
5080 ** The Prev opcode is only used after SeekLT, SeekLE, and Last. */
5081 assert( pOp
->opcode
!=OP_Next
|| pOp
->opcode
!=OP_NextIfOpen
5082 || pC
->seekOp
==OP_SeekGT
|| pC
->seekOp
==OP_SeekGE
5083 || pC
->seekOp
==OP_Rewind
|| pC
->seekOp
==OP_Found
);
5084 assert( pOp
->opcode
!=OP_Prev
|| pOp
->opcode
!=OP_PrevIfOpen
5085 || pC
->seekOp
==OP_SeekLT
|| pC
->seekOp
==OP_SeekLE
5086 || pC
->seekOp
==OP_Last
);
5088 rc
= pOp
->p4
.xAdvance(pC
->uc
.pCursor
, pOp
->p3
);
5090 pC
->cacheStatus
= CACHE_STALE
;
5091 VdbeBranchTaken(rc
==SQLITE_OK
,2);
5092 if( rc
==SQLITE_OK
){
5094 p
->aCounter
[pOp
->p5
]++;
5096 sqlite3_search_count
++;
5098 goto jump_to_p2_and_check_for_interrupt
;
5100 if( rc
!=SQLITE_DONE
) goto abort_due_to_error
;
5103 goto check_for_interrupt
;
5106 /* Opcode: IdxInsert P1 P2 P3 P4 P5
5107 ** Synopsis: key=r[P2]
5109 ** Register P2 holds an SQL index key made using the
5110 ** MakeRecord instructions. This opcode writes that key
5111 ** into the index P1. Data for the entry is nil.
5113 ** If P4 is not zero, then it is the number of values in the unpacked
5114 ** key of reg(P2). In that case, P3 is the index of the first register
5115 ** for the unpacked key. The availability of the unpacked key can sometimes
5116 ** be an optimization.
5118 ** If P5 has the OPFLAG_APPEND bit set, that is a hint to the b-tree layer
5119 ** that this insert is likely to be an append.
5121 ** If P5 has the OPFLAG_NCHANGE bit set, then the change counter is
5122 ** incremented by this instruction. If the OPFLAG_NCHANGE bit is clear,
5123 ** then the change counter is unchanged.
5125 ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
5126 ** run faster by avoiding an unnecessary seek on cursor P1. However,
5127 ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
5128 ** seeks on the cursor or if the most recent seek used a key equivalent
5131 ** This instruction only works for indices. The equivalent instruction
5132 ** for tables is OP_Insert.
5134 /* Opcode: SorterInsert P1 P2 * * *
5135 ** Synopsis: key=r[P2]
5137 ** Register P2 holds an SQL index key made using the
5138 ** MakeRecord instructions. This opcode writes that key
5139 ** into the sorter P1. Data for the entry is nil.
5141 case OP_SorterInsert
: /* in2 */
5142 case OP_IdxInsert
: { /* in2 */
5146 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5147 pC
= p
->apCsr
[pOp
->p1
];
5149 assert( isSorter(pC
)==(pOp
->opcode
==OP_SorterInsert
) );
5150 pIn2
= &aMem
[pOp
->p2
];
5151 assert( pIn2
->flags
& MEM_Blob
);
5152 if( pOp
->p5
& OPFLAG_NCHANGE
) p
->nChange
++;
5153 assert( pC
->eCurType
==CURTYPE_BTREE
|| pOp
->opcode
==OP_SorterInsert
);
5154 assert( pC
->isTable
==0 );
5155 rc
= ExpandBlob(pIn2
);
5156 if( rc
) goto abort_due_to_error
;
5157 if( pOp
->opcode
==OP_SorterInsert
){
5158 rc
= sqlite3VdbeSorterWrite(pC
, pIn2
);
5162 x
.aMem
= aMem
+ pOp
->p3
;
5163 x
.nMem
= (u16
)pOp
->p4
.i
;
5164 rc
= sqlite3BtreeInsert(pC
->uc
.pCursor
, &x
,
5165 (pOp
->p5
& (OPFLAG_APPEND
|OPFLAG_SAVEPOSITION
)),
5166 ((pOp
->p5
& OPFLAG_USESEEKRESULT
) ? pC
->seekResult
: 0)
5168 assert( pC
->deferredMoveto
==0 );
5169 pC
->cacheStatus
= CACHE_STALE
;
5171 if( rc
) goto abort_due_to_error
;
5175 /* Opcode: IdxDelete P1 P2 P3 * *
5176 ** Synopsis: key=r[P2@P3]
5178 ** The content of P3 registers starting at register P2 form
5179 ** an unpacked index key. This opcode removes that entry from the
5180 ** index opened by cursor P1.
5182 case OP_IdxDelete
: {
5188 assert( pOp
->p3
>0 );
5189 assert( pOp
->p2
>0 && pOp
->p2
+pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
)+1 );
5190 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5191 pC
= p
->apCsr
[pOp
->p1
];
5193 assert( pC
->eCurType
==CURTYPE_BTREE
);
5194 pCrsr
= pC
->uc
.pCursor
;
5196 assert( pOp
->p5
==0 );
5197 r
.pKeyInfo
= pC
->pKeyInfo
;
5198 r
.nField
= (u16
)pOp
->p3
;
5200 r
.aMem
= &aMem
[pOp
->p2
];
5201 rc
= sqlite3BtreeMovetoUnpacked(pCrsr
, &r
, 0, 0, &res
);
5202 if( rc
) goto abort_due_to_error
;
5204 rc
= sqlite3BtreeDelete(pCrsr
, BTREE_AUXDELETE
);
5205 if( rc
) goto abort_due_to_error
;
5207 assert( pC
->deferredMoveto
==0 );
5208 pC
->cacheStatus
= CACHE_STALE
;
5213 /* Opcode: DeferredSeek P1 * P3 P4 *
5214 ** Synopsis: Move P3 to P1.rowid if needed
5216 ** P1 is an open index cursor and P3 is a cursor on the corresponding
5217 ** table. This opcode does a deferred seek of the P3 table cursor
5218 ** to the row that corresponds to the current row of P1.
5220 ** This is a deferred seek. Nothing actually happens until
5221 ** the cursor is used to read a record. That way, if no reads
5222 ** occur, no unnecessary I/O happens.
5224 ** P4 may be an array of integers (type P4_INTARRAY) containing
5225 ** one entry for each column in the P3 table. If array entry a(i)
5226 ** is non-zero, then reading column a(i)-1 from cursor P3 is
5227 ** equivalent to performing the deferred seek and then reading column i
5228 ** from P1. This information is stored in P3 and used to redirect
5229 ** reads against P3 over to P1, thus possibly avoiding the need to
5230 ** seek and read cursor P3.
5232 /* Opcode: IdxRowid P1 P2 * * *
5233 ** Synopsis: r[P2]=rowid
5235 ** Write into register P2 an integer which is the last entry in the record at
5236 ** the end of the index key pointed to by cursor P1. This integer should be
5237 ** the rowid of the table entry to which this index entry points.
5239 ** See also: Rowid, MakeRecord.
5241 case OP_DeferredSeek
:
5242 case OP_IdxRowid
: { /* out2 */
5243 VdbeCursor
*pC
; /* The P1 index cursor */
5244 VdbeCursor
*pTabCur
; /* The P2 table cursor (OP_DeferredSeek only) */
5245 i64 rowid
; /* Rowid that P1 current points to */
5247 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5248 pC
= p
->apCsr
[pOp
->p1
];
5250 assert( pC
->eCurType
==CURTYPE_BTREE
);
5251 assert( pC
->uc
.pCursor
!=0 );
5252 assert( pC
->isTable
==0 );
5253 assert( pC
->deferredMoveto
==0 );
5254 assert( !pC
->nullRow
|| pOp
->opcode
==OP_IdxRowid
);
5256 /* The IdxRowid and Seek opcodes are combined because of the commonality
5257 ** of sqlite3VdbeCursorRestore() and sqlite3VdbeIdxRowid(). */
5258 rc
= sqlite3VdbeCursorRestore(pC
);
5260 /* sqlite3VbeCursorRestore() can only fail if the record has been deleted
5261 ** out from under the cursor. That will never happens for an IdxRowid
5262 ** or Seek opcode */
5263 if( NEVER(rc
!=SQLITE_OK
) ) goto abort_due_to_error
;
5266 rowid
= 0; /* Not needed. Only used to silence a warning. */
5267 rc
= sqlite3VdbeIdxRowid(db
, pC
->uc
.pCursor
, &rowid
);
5268 if( rc
!=SQLITE_OK
){
5269 goto abort_due_to_error
;
5271 if( pOp
->opcode
==OP_DeferredSeek
){
5272 assert( pOp
->p3
>=0 && pOp
->p3
<p
->nCursor
);
5273 pTabCur
= p
->apCsr
[pOp
->p3
];
5274 assert( pTabCur
!=0 );
5275 assert( pTabCur
->eCurType
==CURTYPE_BTREE
);
5276 assert( pTabCur
->uc
.pCursor
!=0 );
5277 assert( pTabCur
->isTable
);
5278 pTabCur
->nullRow
= 0;
5279 pTabCur
->movetoTarget
= rowid
;
5280 pTabCur
->deferredMoveto
= 1;
5281 assert( pOp
->p4type
==P4_INTARRAY
|| pOp
->p4
.ai
==0 );
5282 pTabCur
->aAltMap
= pOp
->p4
.ai
;
5283 pTabCur
->pAltCursor
= pC
;
5285 pOut
= out2Prerelease(p
, pOp
);
5289 assert( pOp
->opcode
==OP_IdxRowid
);
5290 sqlite3VdbeMemSetNull(&aMem
[pOp
->p2
]);
5295 /* Opcode: IdxGE P1 P2 P3 P4 P5
5296 ** Synopsis: key=r[P3@P4]
5298 ** The P4 register values beginning with P3 form an unpacked index
5299 ** key that omits the PRIMARY KEY. Compare this key value against the index
5300 ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5301 ** fields at the end.
5303 ** If the P1 index entry is greater than or equal to the key value
5304 ** then jump to P2. Otherwise fall through to the next instruction.
5306 /* Opcode: IdxGT P1 P2 P3 P4 P5
5307 ** Synopsis: key=r[P3@P4]
5309 ** The P4 register values beginning with P3 form an unpacked index
5310 ** key that omits the PRIMARY KEY. Compare this key value against the index
5311 ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5312 ** fields at the end.
5314 ** If the P1 index entry is greater than the key value
5315 ** then jump to P2. Otherwise fall through to the next instruction.
5317 /* Opcode: IdxLT P1 P2 P3 P4 P5
5318 ** Synopsis: key=r[P3@P4]
5320 ** The P4 register values beginning with P3 form an unpacked index
5321 ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5322 ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5323 ** ROWID on the P1 index.
5325 ** If the P1 index entry is less than the key value then jump to P2.
5326 ** Otherwise fall through to the next instruction.
5328 /* Opcode: IdxLE P1 P2 P3 P4 P5
5329 ** Synopsis: key=r[P3@P4]
5331 ** The P4 register values beginning with P3 form an unpacked index
5332 ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5333 ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5334 ** ROWID on the P1 index.
5336 ** If the P1 index entry is less than or equal to the key value then jump
5337 ** to P2. Otherwise fall through to the next instruction.
5339 case OP_IdxLE
: /* jump */
5340 case OP_IdxGT
: /* jump */
5341 case OP_IdxLT
: /* jump */
5342 case OP_IdxGE
: { /* jump */
5347 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5348 pC
= p
->apCsr
[pOp
->p1
];
5350 assert( pC
->isOrdered
);
5351 assert( pC
->eCurType
==CURTYPE_BTREE
);
5352 assert( pC
->uc
.pCursor
!=0);
5353 assert( pC
->deferredMoveto
==0 );
5354 assert( pOp
->p5
==0 || pOp
->p5
==1 );
5355 assert( pOp
->p4type
==P4_INT32
);
5356 r
.pKeyInfo
= pC
->pKeyInfo
;
5357 r
.nField
= (u16
)pOp
->p4
.i
;
5358 if( pOp
->opcode
<OP_IdxLT
){
5359 assert( pOp
->opcode
==OP_IdxLE
|| pOp
->opcode
==OP_IdxGT
);
5362 assert( pOp
->opcode
==OP_IdxGE
|| pOp
->opcode
==OP_IdxLT
);
5365 r
.aMem
= &aMem
[pOp
->p3
];
5367 { int i
; for(i
=0; i
<r
.nField
; i
++) assert( memIsValid(&r
.aMem
[i
]) ); }
5369 res
= 0; /* Not needed. Only used to silence a warning. */
5370 rc
= sqlite3VdbeIdxKeyCompare(db
, pC
, &r
, &res
);
5371 assert( (OP_IdxLE
&1)==(OP_IdxLT
&1) && (OP_IdxGE
&1)==(OP_IdxGT
&1) );
5372 if( (pOp
->opcode
&1)==(OP_IdxLT
&1) ){
5373 assert( pOp
->opcode
==OP_IdxLE
|| pOp
->opcode
==OP_IdxLT
);
5376 assert( pOp
->opcode
==OP_IdxGE
|| pOp
->opcode
==OP_IdxGT
);
5379 VdbeBranchTaken(res
>0,2);
5380 if( rc
) goto abort_due_to_error
;
5381 if( res
>0 ) goto jump_to_p2
;
5385 /* Opcode: Destroy P1 P2 P3 * *
5387 ** Delete an entire database table or index whose root page in the database
5388 ** file is given by P1.
5390 ** The table being destroyed is in the main database file if P3==0. If
5391 ** P3==1 then the table to be clear is in the auxiliary database file
5392 ** that is used to store tables create using CREATE TEMPORARY TABLE.
5394 ** If AUTOVACUUM is enabled then it is possible that another root page
5395 ** might be moved into the newly deleted root page in order to keep all
5396 ** root pages contiguous at the beginning of the database. The former
5397 ** value of the root page that moved - its value before the move occurred -
5398 ** is stored in register P2. If no page movement was required (because the
5399 ** table being dropped was already the last one in the database) then a
5400 ** zero is stored in register P2. If AUTOVACUUM is disabled then a zero
5401 ** is stored in register P2.
5403 ** This opcode throws an error if there are any active reader VMs when
5404 ** it is invoked. This is done to avoid the difficulty associated with
5405 ** updating existing cursors when a root page is moved in an AUTOVACUUM
5406 ** database. This error is thrown even if the database is not an AUTOVACUUM
5407 ** db in order to avoid introducing an incompatibility between autovacuum
5408 ** and non-autovacuum modes.
5412 case OP_Destroy
: { /* out2 */
5416 assert( p
->readOnly
==0 );
5417 assert( pOp
->p1
>1 );
5418 pOut
= out2Prerelease(p
, pOp
);
5419 pOut
->flags
= MEM_Null
;
5420 if( db
->nVdbeRead
> db
->nVDestroy
+1 ){
5422 p
->errorAction
= OE_Abort
;
5423 goto abort_due_to_error
;
5426 assert( DbMaskTest(p
->btreeMask
, iDb
) );
5427 iMoved
= 0; /* Not needed. Only to silence a warning. */
5428 rc
= sqlite3BtreeDropTable(db
->aDb
[iDb
].pBt
, pOp
->p1
, &iMoved
);
5429 pOut
->flags
= MEM_Int
;
5431 if( rc
) goto abort_due_to_error
;
5432 #ifndef SQLITE_OMIT_AUTOVACUUM
5434 sqlite3RootPageMoved(db
, iDb
, iMoved
, pOp
->p1
);
5435 /* All OP_Destroy operations occur on the same btree */
5436 assert( resetSchemaOnFault
==0 || resetSchemaOnFault
==iDb
+1 );
5437 resetSchemaOnFault
= iDb
+1;
5444 /* Opcode: Clear P1 P2 P3
5446 ** Delete all contents of the database table or index whose root page
5447 ** in the database file is given by P1. But, unlike Destroy, do not
5448 ** remove the table or index from the database file.
5450 ** The table being clear is in the main database file if P2==0. If
5451 ** P2==1 then the table to be clear is in the auxiliary database file
5452 ** that is used to store tables create using CREATE TEMPORARY TABLE.
5454 ** If the P3 value is non-zero, then the table referred to must be an
5455 ** intkey table (an SQL table, not an index). In this case the row change
5456 ** count is incremented by the number of rows in the table being cleared.
5457 ** If P3 is greater than zero, then the value stored in register P3 is
5458 ** also incremented by the number of rows in the table being cleared.
5460 ** See also: Destroy
5466 assert( p
->readOnly
==0 );
5467 assert( DbMaskTest(p
->btreeMask
, pOp
->p2
) );
5468 rc
= sqlite3BtreeClearTable(
5469 db
->aDb
[pOp
->p2
].pBt
, pOp
->p1
, (pOp
->p3
? &nChange
: 0)
5472 p
->nChange
+= nChange
;
5474 assert( memIsValid(&aMem
[pOp
->p3
]) );
5475 memAboutToChange(p
, &aMem
[pOp
->p3
]);
5476 aMem
[pOp
->p3
].u
.i
+= nChange
;
5479 if( rc
) goto abort_due_to_error
;
5483 /* Opcode: ResetSorter P1 * * * *
5485 ** Delete all contents from the ephemeral table or sorter
5486 ** that is open on cursor P1.
5488 ** This opcode only works for cursors used for sorting and
5489 ** opened with OP_OpenEphemeral or OP_SorterOpen.
5491 case OP_ResetSorter
: {
5494 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
5495 pC
= p
->apCsr
[pOp
->p1
];
5498 sqlite3VdbeSorterReset(db
, pC
->uc
.pSorter
);
5500 assert( pC
->eCurType
==CURTYPE_BTREE
);
5501 assert( pC
->isEphemeral
);
5502 rc
= sqlite3BtreeClearTableOfCursor(pC
->uc
.pCursor
);
5503 if( rc
) goto abort_due_to_error
;
5508 /* Opcode: CreateBtree P1 P2 P3 * *
5509 ** Synopsis: r[P2]=root iDb=P1 flags=P3
5511 ** Allocate a new b-tree in the main database file if P1==0 or in the
5512 ** TEMP database file if P1==1 or in an attached database if
5513 ** P1>1. The P3 argument must be 1 (BTREE_INTKEY) for a rowid table
5514 ** it must be 2 (BTREE_BLOBKEY) for a index or WITHOUT ROWID table.
5515 ** The root page number of the new b-tree is stored in register P2.
5517 case OP_CreateBtree
: { /* out2 */
5521 pOut
= out2Prerelease(p
, pOp
);
5523 assert( pOp
->p3
==BTREE_INTKEY
|| pOp
->p3
==BTREE_BLOBKEY
);
5524 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
5525 assert( DbMaskTest(p
->btreeMask
, pOp
->p1
) );
5526 assert( p
->readOnly
==0 );
5527 pDb
= &db
->aDb
[pOp
->p1
];
5528 assert( pDb
->pBt
!=0 );
5529 rc
= sqlite3BtreeCreateTable(pDb
->pBt
, &pgno
, pOp
->p3
);
5530 if( rc
) goto abort_due_to_error
;
5535 /* Opcode: SqlExec * * * P4 *
5537 ** Run the SQL statement or statements specified in the P4 string.
5541 rc
= sqlite3_exec(db
, pOp
->p4
.z
, 0, 0, 0);
5543 if( rc
) goto abort_due_to_error
;
5547 /* Opcode: ParseSchema P1 * * P4 *
5549 ** Read and parse all entries from the SQLITE_MASTER table of database P1
5550 ** that match the WHERE clause P4.
5552 ** This opcode invokes the parser to create a new virtual machine,
5553 ** then runs the new virtual machine. It is thus a re-entrant opcode.
5555 case OP_ParseSchema
: {
5557 const char *zMaster
;
5561 /* Any prepared statement that invokes this opcode will hold mutexes
5562 ** on every btree. This is a prerequisite for invoking
5563 ** sqlite3InitCallback().
5566 for(iDb
=0; iDb
<db
->nDb
; iDb
++){
5567 assert( iDb
==1 || sqlite3BtreeHoldsMutex(db
->aDb
[iDb
].pBt
) );
5572 assert( iDb
>=0 && iDb
<db
->nDb
);
5573 assert( DbHasProperty(db
, iDb
, DB_SchemaLoaded
) );
5574 /* Used to be a conditional */ {
5575 zMaster
= MASTER_NAME
;
5577 initData
.iDb
= pOp
->p1
;
5578 initData
.pzErrMsg
= &p
->zErrMsg
;
5579 zSql
= sqlite3MPrintf(db
,
5580 "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s ORDER BY rowid",
5581 db
->aDb
[iDb
].zDbSName
, zMaster
, pOp
->p4
.z
);
5583 rc
= SQLITE_NOMEM_BKPT
;
5585 assert( db
->init
.busy
==0 );
5587 initData
.rc
= SQLITE_OK
;
5588 assert( !db
->mallocFailed
);
5589 rc
= sqlite3_exec(db
, zSql
, sqlite3InitCallback
, &initData
, 0);
5590 if( rc
==SQLITE_OK
) rc
= initData
.rc
;
5591 sqlite3DbFreeNN(db
, zSql
);
5596 sqlite3ResetAllSchemasOfConnection(db
);
5597 if( rc
==SQLITE_NOMEM
){
5600 goto abort_due_to_error
;
5605 #if !defined(SQLITE_OMIT_ANALYZE)
5606 /* Opcode: LoadAnalysis P1 * * * *
5608 ** Read the sqlite_stat1 table for database P1 and load the content
5609 ** of that table into the internal index hash table. This will cause
5610 ** the analysis to be used when preparing all subsequent queries.
5612 case OP_LoadAnalysis
: {
5613 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
5614 rc
= sqlite3AnalysisLoad(db
, pOp
->p1
);
5615 if( rc
) goto abort_due_to_error
;
5618 #endif /* !defined(SQLITE_OMIT_ANALYZE) */
5620 /* Opcode: DropTable P1 * * P4 *
5622 ** Remove the internal (in-memory) data structures that describe
5623 ** the table named P4 in database P1. This is called after a table
5624 ** is dropped from disk (using the Destroy opcode) in order to keep
5625 ** the internal representation of the
5626 ** schema consistent with what is on disk.
5628 case OP_DropTable
: {
5629 sqlite3UnlinkAndDeleteTable(db
, pOp
->p1
, pOp
->p4
.z
);
5633 /* Opcode: DropIndex P1 * * P4 *
5635 ** Remove the internal (in-memory) data structures that describe
5636 ** the index named P4 in database P1. This is called after an index
5637 ** is dropped from disk (using the Destroy opcode)
5638 ** in order to keep the internal representation of the
5639 ** schema consistent with what is on disk.
5641 case OP_DropIndex
: {
5642 sqlite3UnlinkAndDeleteIndex(db
, pOp
->p1
, pOp
->p4
.z
);
5646 /* Opcode: DropTrigger P1 * * P4 *
5648 ** Remove the internal (in-memory) data structures that describe
5649 ** the trigger named P4 in database P1. This is called after a trigger
5650 ** is dropped from disk (using the Destroy opcode) in order to keep
5651 ** the internal representation of the
5652 ** schema consistent with what is on disk.
5654 case OP_DropTrigger
: {
5655 sqlite3UnlinkAndDeleteTrigger(db
, pOp
->p1
, pOp
->p4
.z
);
5660 #ifndef SQLITE_OMIT_INTEGRITY_CHECK
5661 /* Opcode: IntegrityCk P1 P2 P3 P4 P5
5663 ** Do an analysis of the currently open database. Store in
5664 ** register P1 the text of an error message describing any problems.
5665 ** If no problems are found, store a NULL in register P1.
5667 ** The register P3 contains one less than the maximum number of allowed errors.
5668 ** At most reg(P3) errors will be reported.
5669 ** In other words, the analysis stops as soon as reg(P1) errors are
5670 ** seen. Reg(P1) is updated with the number of errors remaining.
5672 ** The root page numbers of all tables in the database are integers
5673 ** stored in P4_INTARRAY argument.
5675 ** If P5 is not zero, the check is done on the auxiliary database
5676 ** file, not the main database file.
5678 ** This opcode is used to implement the integrity_check pragma.
5680 case OP_IntegrityCk
: {
5681 int nRoot
; /* Number of tables to check. (Number of root pages.) */
5682 int *aRoot
; /* Array of rootpage numbers for tables to be checked */
5683 int nErr
; /* Number of errors reported */
5684 char *z
; /* Text of the error report */
5685 Mem
*pnErr
; /* Register keeping track of errors remaining */
5687 assert( p
->bIsReader
);
5691 assert( aRoot
[0]==nRoot
);
5692 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
5693 pnErr
= &aMem
[pOp
->p3
];
5694 assert( (pnErr
->flags
& MEM_Int
)!=0 );
5695 assert( (pnErr
->flags
& (MEM_Str
|MEM_Blob
))==0 );
5696 pIn1
= &aMem
[pOp
->p1
];
5697 assert( pOp
->p5
<db
->nDb
);
5698 assert( DbMaskTest(p
->btreeMask
, pOp
->p5
) );
5699 z
= sqlite3BtreeIntegrityCheck(db
->aDb
[pOp
->p5
].pBt
, &aRoot
[1], nRoot
,
5700 (int)pnErr
->u
.i
+1, &nErr
);
5701 sqlite3VdbeMemSetNull(pIn1
);
5707 pnErr
->u
.i
-= nErr
-1;
5708 sqlite3VdbeMemSetStr(pIn1
, z
, -1, SQLITE_UTF8
, sqlite3_free
);
5710 UPDATE_MAX_BLOBSIZE(pIn1
);
5711 sqlite3VdbeChangeEncoding(pIn1
, encoding
);
5714 #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
5716 /* Opcode: RowSetAdd P1 P2 * * *
5717 ** Synopsis: rowset(P1)=r[P2]
5719 ** Insert the integer value held by register P2 into a RowSet object
5720 ** held in register P1.
5722 ** An assertion fails if P2 is not an integer.
5724 case OP_RowSetAdd
: { /* in1, in2 */
5725 pIn1
= &aMem
[pOp
->p1
];
5726 pIn2
= &aMem
[pOp
->p2
];
5727 assert( (pIn2
->flags
& MEM_Int
)!=0 );
5728 if( (pIn1
->flags
& MEM_RowSet
)==0 ){
5729 sqlite3VdbeMemSetRowSet(pIn1
);
5730 if( (pIn1
->flags
& MEM_RowSet
)==0 ) goto no_mem
;
5732 sqlite3RowSetInsert(pIn1
->u
.pRowSet
, pIn2
->u
.i
);
5736 /* Opcode: RowSetRead P1 P2 P3 * *
5737 ** Synopsis: r[P3]=rowset(P1)
5739 ** Extract the smallest value from the RowSet object in P1
5740 ** and put that value into register P3.
5741 ** Or, if RowSet object P1 is initially empty, leave P3
5742 ** unchanged and jump to instruction P2.
5744 case OP_RowSetRead
: { /* jump, in1, out3 */
5747 pIn1
= &aMem
[pOp
->p1
];
5748 if( (pIn1
->flags
& MEM_RowSet
)==0
5749 || sqlite3RowSetNext(pIn1
->u
.pRowSet
, &val
)==0
5751 /* The boolean index is empty */
5752 sqlite3VdbeMemSetNull(pIn1
);
5753 VdbeBranchTaken(1,2);
5754 goto jump_to_p2_and_check_for_interrupt
;
5756 /* A value was pulled from the index */
5757 VdbeBranchTaken(0,2);
5758 sqlite3VdbeMemSetInt64(&aMem
[pOp
->p3
], val
);
5760 goto check_for_interrupt
;
5763 /* Opcode: RowSetTest P1 P2 P3 P4
5764 ** Synopsis: if r[P3] in rowset(P1) goto P2
5766 ** Register P3 is assumed to hold a 64-bit integer value. If register P1
5767 ** contains a RowSet object and that RowSet object contains
5768 ** the value held in P3, jump to register P2. Otherwise, insert the
5769 ** integer in P3 into the RowSet and continue on to the
5772 ** The RowSet object is optimized for the case where sets of integers
5773 ** are inserted in distinct phases, which each set contains no duplicates.
5774 ** Each set is identified by a unique P4 value. The first set
5775 ** must have P4==0, the final set must have P4==-1, and for all other sets
5778 ** This allows optimizations: (a) when P4==0 there is no need to test
5779 ** the RowSet object for P3, as it is guaranteed not to contain it,
5780 ** (b) when P4==-1 there is no need to insert the value, as it will
5781 ** never be tested for, and (c) when a value that is part of set X is
5782 ** inserted, there is no need to search to see if the same value was
5783 ** previously inserted as part of set X (only if it was previously
5784 ** inserted as part of some other set).
5786 case OP_RowSetTest
: { /* jump, in1, in3 */
5790 pIn1
= &aMem
[pOp
->p1
];
5791 pIn3
= &aMem
[pOp
->p3
];
5793 assert( pIn3
->flags
&MEM_Int
);
5795 /* If there is anything other than a rowset object in memory cell P1,
5796 ** delete it now and initialize P1 with an empty rowset
5798 if( (pIn1
->flags
& MEM_RowSet
)==0 ){
5799 sqlite3VdbeMemSetRowSet(pIn1
);
5800 if( (pIn1
->flags
& MEM_RowSet
)==0 ) goto no_mem
;
5803 assert( pOp
->p4type
==P4_INT32
);
5804 assert( iSet
==-1 || iSet
>=0 );
5806 exists
= sqlite3RowSetTest(pIn1
->u
.pRowSet
, iSet
, pIn3
->u
.i
);
5807 VdbeBranchTaken(exists
!=0,2);
5808 if( exists
) goto jump_to_p2
;
5811 sqlite3RowSetInsert(pIn1
->u
.pRowSet
, pIn3
->u
.i
);
5817 #ifndef SQLITE_OMIT_TRIGGER
5819 /* Opcode: Program P1 P2 P3 P4 P5
5821 ** Execute the trigger program passed as P4 (type P4_SUBPROGRAM).
5823 ** P1 contains the address of the memory cell that contains the first memory
5824 ** cell in an array of values used as arguments to the sub-program. P2
5825 ** contains the address to jump to if the sub-program throws an IGNORE
5826 ** exception using the RAISE() function. Register P3 contains the address
5827 ** of a memory cell in this (the parent) VM that is used to allocate the
5828 ** memory required by the sub-vdbe at runtime.
5830 ** P4 is a pointer to the VM containing the trigger program.
5832 ** If P5 is non-zero, then recursive program invocation is enabled.
5834 case OP_Program
: { /* jump */
5835 int nMem
; /* Number of memory registers for sub-program */
5836 int nByte
; /* Bytes of runtime space required for sub-program */
5837 Mem
*pRt
; /* Register to allocate runtime space */
5838 Mem
*pMem
; /* Used to iterate through memory cells */
5839 Mem
*pEnd
; /* Last memory cell in new array */
5840 VdbeFrame
*pFrame
; /* New vdbe frame to execute in */
5841 SubProgram
*pProgram
; /* Sub-program to execute */
5842 void *t
; /* Token identifying trigger */
5844 pProgram
= pOp
->p4
.pProgram
;
5845 pRt
= &aMem
[pOp
->p3
];
5846 assert( pProgram
->nOp
>0 );
5848 /* If the p5 flag is clear, then recursive invocation of triggers is
5849 ** disabled for backwards compatibility (p5 is set if this sub-program
5850 ** is really a trigger, not a foreign key action, and the flag set
5851 ** and cleared by the "PRAGMA recursive_triggers" command is clear).
5853 ** It is recursive invocation of triggers, at the SQL level, that is
5854 ** disabled. In some cases a single trigger may generate more than one
5855 ** SubProgram (if the trigger may be executed with more than one different
5856 ** ON CONFLICT algorithm). SubProgram structures associated with a
5857 ** single trigger all have the same value for the SubProgram.token
5860 t
= pProgram
->token
;
5861 for(pFrame
=p
->pFrame
; pFrame
&& pFrame
->token
!=t
; pFrame
=pFrame
->pParent
);
5865 if( p
->nFrame
>=db
->aLimit
[SQLITE_LIMIT_TRIGGER_DEPTH
] ){
5867 sqlite3VdbeError(p
, "too many levels of trigger recursion");
5868 goto abort_due_to_error
;
5871 /* Register pRt is used to store the memory required to save the state
5872 ** of the current program, and the memory required at runtime to execute
5873 ** the trigger program. If this trigger has been fired before, then pRt
5874 ** is already allocated. Otherwise, it must be initialized. */
5875 if( (pRt
->flags
&MEM_Frame
)==0 ){
5876 /* SubProgram.nMem is set to the number of memory cells used by the
5877 ** program stored in SubProgram.aOp. As well as these, one memory
5878 ** cell is required for each cursor used by the program. Set local
5879 ** variable nMem (and later, VdbeFrame.nChildMem) to this value.
5881 nMem
= pProgram
->nMem
+ pProgram
->nCsr
;
5883 if( pProgram
->nCsr
==0 ) nMem
++;
5884 nByte
= ROUND8(sizeof(VdbeFrame
))
5885 + nMem
* sizeof(Mem
)
5886 + pProgram
->nCsr
* sizeof(VdbeCursor
*)
5887 + (pProgram
->nOp
+ 7)/8;
5888 pFrame
= sqlite3DbMallocZero(db
, nByte
);
5892 sqlite3VdbeMemRelease(pRt
);
5893 pRt
->flags
= MEM_Frame
;
5894 pRt
->u
.pFrame
= pFrame
;
5897 pFrame
->nChildMem
= nMem
;
5898 pFrame
->nChildCsr
= pProgram
->nCsr
;
5899 pFrame
->pc
= (int)(pOp
- aOp
);
5900 pFrame
->aMem
= p
->aMem
;
5901 pFrame
->nMem
= p
->nMem
;
5902 pFrame
->apCsr
= p
->apCsr
;
5903 pFrame
->nCursor
= p
->nCursor
;
5904 pFrame
->aOp
= p
->aOp
;
5905 pFrame
->nOp
= p
->nOp
;
5906 pFrame
->token
= pProgram
->token
;
5907 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
5908 pFrame
->anExec
= p
->anExec
;
5911 pEnd
= &VdbeFrameMem(pFrame
)[pFrame
->nChildMem
];
5912 for(pMem
=VdbeFrameMem(pFrame
); pMem
!=pEnd
; pMem
++){
5913 pMem
->flags
= MEM_Undefined
;
5917 pFrame
= pRt
->u
.pFrame
;
5918 assert( pProgram
->nMem
+pProgram
->nCsr
==pFrame
->nChildMem
5919 || (pProgram
->nCsr
==0 && pProgram
->nMem
+1==pFrame
->nChildMem
) );
5920 assert( pProgram
->nCsr
==pFrame
->nChildCsr
);
5921 assert( (int)(pOp
- aOp
)==pFrame
->pc
);
5925 pFrame
->pParent
= p
->pFrame
;
5926 pFrame
->lastRowid
= db
->lastRowid
;
5927 pFrame
->nChange
= p
->nChange
;
5928 pFrame
->nDbChange
= p
->db
->nChange
;
5929 assert( pFrame
->pAuxData
==0 );
5930 pFrame
->pAuxData
= p
->pAuxData
;
5934 p
->aMem
= aMem
= VdbeFrameMem(pFrame
);
5935 p
->nMem
= pFrame
->nChildMem
;
5936 p
->nCursor
= (u16
)pFrame
->nChildCsr
;
5937 p
->apCsr
= (VdbeCursor
**)&aMem
[p
->nMem
];
5938 pFrame
->aOnce
= (u8
*)&p
->apCsr
[pProgram
->nCsr
];
5939 memset(pFrame
->aOnce
, 0, (pProgram
->nOp
+ 7)/8);
5940 p
->aOp
= aOp
= pProgram
->aOp
;
5941 p
->nOp
= pProgram
->nOp
;
5942 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
5950 /* Opcode: Param P1 P2 * * *
5952 ** This opcode is only ever present in sub-programs called via the
5953 ** OP_Program instruction. Copy a value currently stored in a memory
5954 ** cell of the calling (parent) frame to cell P2 in the current frames
5955 ** address space. This is used by trigger programs to access the new.*
5956 ** and old.* values.
5958 ** The address of the cell in the parent frame is determined by adding
5959 ** the value of the P1 argument to the value of the P1 argument to the
5960 ** calling OP_Program instruction.
5962 case OP_Param
: { /* out2 */
5965 pOut
= out2Prerelease(p
, pOp
);
5967 pIn
= &pFrame
->aMem
[pOp
->p1
+ pFrame
->aOp
[pFrame
->pc
].p1
];
5968 sqlite3VdbeMemShallowCopy(pOut
, pIn
, MEM_Ephem
);
5972 #endif /* #ifndef SQLITE_OMIT_TRIGGER */
5974 #ifndef SQLITE_OMIT_FOREIGN_KEY
5975 /* Opcode: FkCounter P1 P2 * * *
5976 ** Synopsis: fkctr[P1]+=P2
5978 ** Increment a "constraint counter" by P2 (P2 may be negative or positive).
5979 ** If P1 is non-zero, the database constraint counter is incremented
5980 ** (deferred foreign key constraints). Otherwise, if P1 is zero, the
5981 ** statement counter is incremented (immediate foreign key constraints).
5983 case OP_FkCounter
: {
5984 if( db
->flags
& SQLITE_DeferFKs
){
5985 db
->nDeferredImmCons
+= pOp
->p2
;
5986 }else if( pOp
->p1
){
5987 db
->nDeferredCons
+= pOp
->p2
;
5989 p
->nFkConstraint
+= pOp
->p2
;
5994 /* Opcode: FkIfZero P1 P2 * * *
5995 ** Synopsis: if fkctr[P1]==0 goto P2
5997 ** This opcode tests if a foreign key constraint-counter is currently zero.
5998 ** If so, jump to instruction P2. Otherwise, fall through to the next
6001 ** If P1 is non-zero, then the jump is taken if the database constraint-counter
6002 ** is zero (the one that counts deferred constraint violations). If P1 is
6003 ** zero, the jump is taken if the statement constraint-counter is zero
6004 ** (immediate foreign key constraint violations).
6006 case OP_FkIfZero
: { /* jump */
6008 VdbeBranchTaken(db
->nDeferredCons
==0 && db
->nDeferredImmCons
==0, 2);
6009 if( db
->nDeferredCons
==0 && db
->nDeferredImmCons
==0 ) goto jump_to_p2
;
6011 VdbeBranchTaken(p
->nFkConstraint
==0 && db
->nDeferredImmCons
==0, 2);
6012 if( p
->nFkConstraint
==0 && db
->nDeferredImmCons
==0 ) goto jump_to_p2
;
6016 #endif /* #ifndef SQLITE_OMIT_FOREIGN_KEY */
6018 #ifndef SQLITE_OMIT_AUTOINCREMENT
6019 /* Opcode: MemMax P1 P2 * * *
6020 ** Synopsis: r[P1]=max(r[P1],r[P2])
6022 ** P1 is a register in the root frame of this VM (the root frame is
6023 ** different from the current frame if this instruction is being executed
6024 ** within a sub-program). Set the value of register P1 to the maximum of
6025 ** its current value and the value in register P2.
6027 ** This instruction throws an error if the memory cell is not initially
6030 case OP_MemMax
: { /* in2 */
6033 for(pFrame
=p
->pFrame
; pFrame
->pParent
; pFrame
=pFrame
->pParent
);
6034 pIn1
= &pFrame
->aMem
[pOp
->p1
];
6036 pIn1
= &aMem
[pOp
->p1
];
6038 assert( memIsValid(pIn1
) );
6039 sqlite3VdbeMemIntegerify(pIn1
);
6040 pIn2
= &aMem
[pOp
->p2
];
6041 sqlite3VdbeMemIntegerify(pIn2
);
6042 if( pIn1
->u
.i
<pIn2
->u
.i
){
6043 pIn1
->u
.i
= pIn2
->u
.i
;
6047 #endif /* SQLITE_OMIT_AUTOINCREMENT */
6049 /* Opcode: IfPos P1 P2 P3 * *
6050 ** Synopsis: if r[P1]>0 then r[P1]-=P3, goto P2
6052 ** Register P1 must contain an integer.
6053 ** If the value of register P1 is 1 or greater, subtract P3 from the
6054 ** value in P1 and jump to P2.
6056 ** If the initial value of register P1 is less than 1, then the
6057 ** value is unchanged and control passes through to the next instruction.
6059 case OP_IfPos
: { /* jump, in1 */
6060 pIn1
= &aMem
[pOp
->p1
];
6061 assert( pIn1
->flags
&MEM_Int
);
6062 VdbeBranchTaken( pIn1
->u
.i
>0, 2);
6064 pIn1
->u
.i
-= pOp
->p3
;
6070 /* Opcode: OffsetLimit P1 P2 P3 * *
6071 ** Synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)
6073 ** This opcode performs a commonly used computation associated with
6074 ** LIMIT and OFFSET process. r[P1] holds the limit counter. r[P3]
6075 ** holds the offset counter. The opcode computes the combined value
6076 ** of the LIMIT and OFFSET and stores that value in r[P2]. The r[P2]
6077 ** value computed is the total number of rows that will need to be
6078 ** visited in order to complete the query.
6080 ** If r[P3] is zero or negative, that means there is no OFFSET
6081 ** and r[P2] is set to be the value of the LIMIT, r[P1].
6083 ** if r[P1] is zero or negative, that means there is no LIMIT
6084 ** and r[P2] is set to -1.
6086 ** Otherwise, r[P2] is set to the sum of r[P1] and r[P3].
6088 case OP_OffsetLimit
: { /* in1, out2, in3 */
6090 pIn1
= &aMem
[pOp
->p1
];
6091 pIn3
= &aMem
[pOp
->p3
];
6092 pOut
= out2Prerelease(p
, pOp
);
6093 assert( pIn1
->flags
& MEM_Int
);
6094 assert( pIn3
->flags
& MEM_Int
);
6096 if( x
<=0 || sqlite3AddInt64(&x
, pIn3
->u
.i
>0?pIn3
->u
.i
:0) ){
6097 /* If the LIMIT is less than or equal to zero, loop forever. This
6098 ** is documented. But also, if the LIMIT+OFFSET exceeds 2^63 then
6099 ** also loop forever. This is undocumented. In fact, one could argue
6100 ** that the loop should terminate. But assuming 1 billion iterations
6101 ** per second (far exceeding the capabilities of any current hardware)
6102 ** it would take nearly 300 years to actually reach the limit. So
6103 ** looping forever is a reasonable approximation. */
6111 /* Opcode: IfNotZero P1 P2 * * *
6112 ** Synopsis: if r[P1]!=0 then r[P1]--, goto P2
6114 ** Register P1 must contain an integer. If the content of register P1 is
6115 ** initially greater than zero, then decrement the value in register P1.
6116 ** If it is non-zero (negative or positive) and then also jump to P2.
6117 ** If register P1 is initially zero, leave it unchanged and fall through.
6119 case OP_IfNotZero
: { /* jump, in1 */
6120 pIn1
= &aMem
[pOp
->p1
];
6121 assert( pIn1
->flags
&MEM_Int
);
6122 VdbeBranchTaken(pIn1
->u
.i
<0, 2);
6124 if( pIn1
->u
.i
>0 ) pIn1
->u
.i
--;
6130 /* Opcode: DecrJumpZero P1 P2 * * *
6131 ** Synopsis: if (--r[P1])==0 goto P2
6133 ** Register P1 must hold an integer. Decrement the value in P1
6134 ** and jump to P2 if the new value is exactly zero.
6136 case OP_DecrJumpZero
: { /* jump, in1 */
6137 pIn1
= &aMem
[pOp
->p1
];
6138 assert( pIn1
->flags
&MEM_Int
);
6139 if( pIn1
->u
.i
>SMALLEST_INT64
) pIn1
->u
.i
--;
6140 VdbeBranchTaken(pIn1
->u
.i
==0, 2);
6141 if( pIn1
->u
.i
==0 ) goto jump_to_p2
;
6146 /* Opcode: AggStep0 * P2 P3 P4 P5
6147 ** Synopsis: accum=r[P3] step(r[P2@P5])
6149 ** Execute the step function for an aggregate. The
6150 ** function has P5 arguments. P4 is a pointer to the FuncDef
6151 ** structure that specifies the function. Register P3 is the
6154 ** The P5 arguments are taken from register P2 and its
6157 /* Opcode: AggStep * P2 P3 P4 P5
6158 ** Synopsis: accum=r[P3] step(r[P2@P5])
6160 ** Execute the step function for an aggregate. The
6161 ** function has P5 arguments. P4 is a pointer to an sqlite3_context
6162 ** object that is used to run the function. Register P3 is
6163 ** as the accumulator.
6165 ** The P5 arguments are taken from register P2 and its
6168 ** This opcode is initially coded as OP_AggStep0. On first evaluation,
6169 ** the FuncDef stored in P4 is converted into an sqlite3_context and
6170 ** the opcode is changed. In this way, the initialization of the
6171 ** sqlite3_context only happens once, instead of on each call to the
6176 sqlite3_context
*pCtx
;
6178 assert( pOp
->p4type
==P4_FUNCDEF
);
6180 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
6181 assert( n
==0 || (pOp
->p2
>0 && pOp
->p2
+n
<=(p
->nMem
+1 - p
->nCursor
)+1) );
6182 assert( pOp
->p3
<pOp
->p2
|| pOp
->p3
>=pOp
->p2
+n
);
6183 pCtx
= sqlite3DbMallocRawNN(db
, sizeof(*pCtx
) + (n
-1)*sizeof(sqlite3_value
*));
6184 if( pCtx
==0 ) goto no_mem
;
6186 pCtx
->pFunc
= pOp
->p4
.pFunc
;
6187 pCtx
->iOp
= (int)(pOp
- aOp
);
6190 pOp
->p4type
= P4_FUNCCTX
;
6191 pOp
->p4
.pCtx
= pCtx
;
6192 pOp
->opcode
= OP_AggStep
;
6193 /* Fall through into OP_AggStep */
6197 sqlite3_context
*pCtx
;
6201 assert( pOp
->p4type
==P4_FUNCCTX
);
6202 pCtx
= pOp
->p4
.pCtx
;
6203 pMem
= &aMem
[pOp
->p3
];
6205 /* If this function is inside of a trigger, the register array in aMem[]
6206 ** might change from one evaluation to the next. The next block of code
6207 ** checks to see if the register array has changed, and if so it
6208 ** reinitializes the relavant parts of the sqlite3_context object */
6209 if( pCtx
->pMem
!= pMem
){
6211 for(i
=pCtx
->argc
-1; i
>=0; i
--) pCtx
->argv
[i
] = &aMem
[pOp
->p2
+i
];
6215 for(i
=0; i
<pCtx
->argc
; i
++){
6216 assert( memIsValid(pCtx
->argv
[i
]) );
6217 REGISTER_TRACE(pOp
->p2
+i
, pCtx
->argv
[i
]);
6222 sqlite3VdbeMemInit(&t
, db
, MEM_Null
);
6224 pCtx
->fErrorOrAux
= 0;
6226 (pCtx
->pFunc
->xSFunc
)(pCtx
,pCtx
->argc
,pCtx
->argv
); /* IMP: R-24505-23230 */
6227 if( pCtx
->fErrorOrAux
){
6228 if( pCtx
->isError
){
6229 sqlite3VdbeError(p
, "%s", sqlite3_value_text(&t
));
6232 sqlite3VdbeMemRelease(&t
);
6233 if( rc
) goto abort_due_to_error
;
6235 assert( t
.flags
==MEM_Null
);
6237 if( pCtx
->skipFlag
){
6238 assert( pOp
[-1].opcode
==OP_CollSeq
);
6240 if( i
) sqlite3VdbeMemSetInt64(&aMem
[i
], 1);
6245 /* Opcode: AggFinal P1 P2 * P4 *
6246 ** Synopsis: accum=r[P1] N=P2
6248 ** Execute the finalizer function for an aggregate. P1 is
6249 ** the memory location that is the accumulator for the aggregate.
6251 ** P2 is the number of arguments that the step function takes and
6252 ** P4 is a pointer to the FuncDef for this function. The P2
6253 ** argument is not used by this opcode. It is only there to disambiguate
6254 ** functions that can take varying numbers of arguments. The
6255 ** P4 argument is only needed for the degenerate case where
6256 ** the step function was not previously called.
6260 assert( pOp
->p1
>0 && pOp
->p1
<=(p
->nMem
+1 - p
->nCursor
) );
6261 pMem
= &aMem
[pOp
->p1
];
6262 assert( (pMem
->flags
& ~(MEM_Null
|MEM_Agg
))==0 );
6263 rc
= sqlite3VdbeMemFinalize(pMem
, pOp
->p4
.pFunc
);
6265 sqlite3VdbeError(p
, "%s", sqlite3_value_text(pMem
));
6266 goto abort_due_to_error
;
6268 sqlite3VdbeChangeEncoding(pMem
, encoding
);
6269 UPDATE_MAX_BLOBSIZE(pMem
);
6270 if( sqlite3VdbeMemTooBig(pMem
) ){
6276 #ifndef SQLITE_OMIT_WAL
6277 /* Opcode: Checkpoint P1 P2 P3 * *
6279 ** Checkpoint database P1. This is a no-op if P1 is not currently in
6280 ** WAL mode. Parameter P2 is one of SQLITE_CHECKPOINT_PASSIVE, FULL,
6281 ** RESTART, or TRUNCATE. Write 1 or 0 into mem[P3] if the checkpoint returns
6282 ** SQLITE_BUSY or not, respectively. Write the number of pages in the
6283 ** WAL after the checkpoint into mem[P3+1] and the number of pages
6284 ** in the WAL that have been checkpointed after the checkpoint
6285 ** completes into mem[P3+2]. However on an error, mem[P3+1] and
6286 ** mem[P3+2] are initialized to -1.
6288 case OP_Checkpoint
: {
6289 int i
; /* Loop counter */
6290 int aRes
[3]; /* Results */
6291 Mem
*pMem
; /* Write results here */
6293 assert( p
->readOnly
==0 );
6295 aRes
[1] = aRes
[2] = -1;
6296 assert( pOp
->p2
==SQLITE_CHECKPOINT_PASSIVE
6297 || pOp
->p2
==SQLITE_CHECKPOINT_FULL
6298 || pOp
->p2
==SQLITE_CHECKPOINT_RESTART
6299 || pOp
->p2
==SQLITE_CHECKPOINT_TRUNCATE
6301 rc
= sqlite3Checkpoint(db
, pOp
->p1
, pOp
->p2
, &aRes
[1], &aRes
[2]);
6303 if( rc
!=SQLITE_BUSY
) goto abort_due_to_error
;
6307 for(i
=0, pMem
= &aMem
[pOp
->p3
]; i
<3; i
++, pMem
++){
6308 sqlite3VdbeMemSetInt64(pMem
, (i64
)aRes
[i
]);
6314 #ifndef SQLITE_OMIT_PRAGMA
6315 /* Opcode: JournalMode P1 P2 P3 * *
6317 ** Change the journal mode of database P1 to P3. P3 must be one of the
6318 ** PAGER_JOURNALMODE_XXX values. If changing between the various rollback
6319 ** modes (delete, truncate, persist, off and memory), this is a simple
6320 ** operation. No IO is required.
6322 ** If changing into or out of WAL mode the procedure is more complicated.
6324 ** Write a string containing the final journal-mode to register P2.
6326 case OP_JournalMode
: { /* out2 */
6327 Btree
*pBt
; /* Btree to change journal mode of */
6328 Pager
*pPager
; /* Pager associated with pBt */
6329 int eNew
; /* New journal mode */
6330 int eOld
; /* The old journal mode */
6331 #ifndef SQLITE_OMIT_WAL
6332 const char *zFilename
; /* Name of database file for pPager */
6335 pOut
= out2Prerelease(p
, pOp
);
6337 assert( eNew
==PAGER_JOURNALMODE_DELETE
6338 || eNew
==PAGER_JOURNALMODE_TRUNCATE
6339 || eNew
==PAGER_JOURNALMODE_PERSIST
6340 || eNew
==PAGER_JOURNALMODE_OFF
6341 || eNew
==PAGER_JOURNALMODE_MEMORY
6342 || eNew
==PAGER_JOURNALMODE_WAL
6343 || eNew
==PAGER_JOURNALMODE_QUERY
6345 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
6346 assert( p
->readOnly
==0 );
6348 pBt
= db
->aDb
[pOp
->p1
].pBt
;
6349 pPager
= sqlite3BtreePager(pBt
);
6350 eOld
= sqlite3PagerGetJournalMode(pPager
);
6351 if( eNew
==PAGER_JOURNALMODE_QUERY
) eNew
= eOld
;
6352 if( !sqlite3PagerOkToChangeJournalMode(pPager
) ) eNew
= eOld
;
6354 #ifndef SQLITE_OMIT_WAL
6355 zFilename
= sqlite3PagerFilename(pPager
, 1);
6357 /* Do not allow a transition to journal_mode=WAL for a database
6358 ** in temporary storage or if the VFS does not support shared memory
6360 if( eNew
==PAGER_JOURNALMODE_WAL
6361 && (sqlite3Strlen30(zFilename
)==0 /* Temp file */
6362 || !sqlite3PagerWalSupported(pPager
)) /* No shared-memory support */
6368 && (eOld
==PAGER_JOURNALMODE_WAL
|| eNew
==PAGER_JOURNALMODE_WAL
)
6370 if( !db
->autoCommit
|| db
->nVdbeRead
>1 ){
6373 "cannot change %s wal mode from within a transaction",
6374 (eNew
==PAGER_JOURNALMODE_WAL
? "into" : "out of")
6376 goto abort_due_to_error
;
6379 if( eOld
==PAGER_JOURNALMODE_WAL
){
6380 /* If leaving WAL mode, close the log file. If successful, the call
6381 ** to PagerCloseWal() checkpoints and deletes the write-ahead-log
6382 ** file. An EXCLUSIVE lock may still be held on the database file
6383 ** after a successful return.
6385 rc
= sqlite3PagerCloseWal(pPager
, db
);
6386 if( rc
==SQLITE_OK
){
6387 sqlite3PagerSetJournalMode(pPager
, eNew
);
6389 }else if( eOld
==PAGER_JOURNALMODE_MEMORY
){
6390 /* Cannot transition directly from MEMORY to WAL. Use mode OFF
6391 ** as an intermediate */
6392 sqlite3PagerSetJournalMode(pPager
, PAGER_JOURNALMODE_OFF
);
6395 /* Open a transaction on the database file. Regardless of the journal
6396 ** mode, this transaction always uses a rollback journal.
6398 assert( sqlite3BtreeIsInTrans(pBt
)==0 );
6399 if( rc
==SQLITE_OK
){
6400 rc
= sqlite3BtreeSetVersion(pBt
, (eNew
==PAGER_JOURNALMODE_WAL
? 2 : 1));
6404 #endif /* ifndef SQLITE_OMIT_WAL */
6406 if( rc
) eNew
= eOld
;
6407 eNew
= sqlite3PagerSetJournalMode(pPager
, eNew
);
6409 pOut
->flags
= MEM_Str
|MEM_Static
|MEM_Term
;
6410 pOut
->z
= (char *)sqlite3JournalModename(eNew
);
6411 pOut
->n
= sqlite3Strlen30(pOut
->z
);
6412 pOut
->enc
= SQLITE_UTF8
;
6413 sqlite3VdbeChangeEncoding(pOut
, encoding
);
6414 if( rc
) goto abort_due_to_error
;
6417 #endif /* SQLITE_OMIT_PRAGMA */
6419 #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
6420 /* Opcode: Vacuum P1 * * * *
6422 ** Vacuum the entire database P1. P1 is 0 for "main", and 2 or more
6423 ** for an attached database. The "temp" database may not be vacuumed.
6426 assert( p
->readOnly
==0 );
6427 rc
= sqlite3RunVacuum(&p
->zErrMsg
, db
, pOp
->p1
);
6428 if( rc
) goto abort_due_to_error
;
6433 #if !defined(SQLITE_OMIT_AUTOVACUUM)
6434 /* Opcode: IncrVacuum P1 P2 * * *
6436 ** Perform a single step of the incremental vacuum procedure on
6437 ** the P1 database. If the vacuum has finished, jump to instruction
6438 ** P2. Otherwise, fall through to the next instruction.
6440 case OP_IncrVacuum
: { /* jump */
6443 assert( pOp
->p1
>=0 && pOp
->p1
<db
->nDb
);
6444 assert( DbMaskTest(p
->btreeMask
, pOp
->p1
) );
6445 assert( p
->readOnly
==0 );
6446 pBt
= db
->aDb
[pOp
->p1
].pBt
;
6447 rc
= sqlite3BtreeIncrVacuum(pBt
);
6448 VdbeBranchTaken(rc
==SQLITE_DONE
,2);
6450 if( rc
!=SQLITE_DONE
) goto abort_due_to_error
;
6458 /* Opcode: Expire P1 * * * *
6460 ** Cause precompiled statements to expire. When an expired statement
6461 ** is executed using sqlite3_step() it will either automatically
6462 ** reprepare itself (if it was originally created using sqlite3_prepare_v2())
6463 ** or it will fail with SQLITE_SCHEMA.
6465 ** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
6466 ** then only the currently executing statement is expired.
6470 sqlite3ExpirePreparedStatements(db
);
6477 #ifndef SQLITE_OMIT_SHARED_CACHE
6478 /* Opcode: TableLock P1 P2 P3 P4 *
6479 ** Synopsis: iDb=P1 root=P2 write=P3
6481 ** Obtain a lock on a particular table. This instruction is only used when
6482 ** the shared-cache feature is enabled.
6484 ** P1 is the index of the database in sqlite3.aDb[] of the database
6485 ** on which the lock is acquired. A readlock is obtained if P3==0 or
6486 ** a write lock if P3==1.
6488 ** P2 contains the root-page of the table to lock.
6490 ** P4 contains a pointer to the name of the table being locked. This is only
6491 ** used to generate an error message if the lock cannot be obtained.
6493 case OP_TableLock
: {
6494 u8 isWriteLock
= (u8
)pOp
->p3
;
6495 if( isWriteLock
|| 0==(db
->flags
&SQLITE_ReadUncommit
) ){
6497 assert( p1
>=0 && p1
<db
->nDb
);
6498 assert( DbMaskTest(p
->btreeMask
, p1
) );
6499 assert( isWriteLock
==0 || isWriteLock
==1 );
6500 rc
= sqlite3BtreeLockTable(db
->aDb
[p1
].pBt
, pOp
->p2
, isWriteLock
);
6502 if( (rc
&0xFF)==SQLITE_LOCKED
){
6503 const char *z
= pOp
->p4
.z
;
6504 sqlite3VdbeError(p
, "database table is locked: %s", z
);
6506 goto abort_due_to_error
;
6511 #endif /* SQLITE_OMIT_SHARED_CACHE */
6513 #ifndef SQLITE_OMIT_VIRTUALTABLE
6514 /* Opcode: VBegin * * * P4 *
6516 ** P4 may be a pointer to an sqlite3_vtab structure. If so, call the
6517 ** xBegin method for that table.
6519 ** Also, whether or not P4 is set, check that this is not being called from
6520 ** within a callback to a virtual table xSync() method. If it is, the error
6521 ** code will be set to SQLITE_LOCKED.
6525 pVTab
= pOp
->p4
.pVtab
;
6526 rc
= sqlite3VtabBegin(db
, pVTab
);
6527 if( pVTab
) sqlite3VtabImportErrmsg(p
, pVTab
->pVtab
);
6528 if( rc
) goto abort_due_to_error
;
6531 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6533 #ifndef SQLITE_OMIT_VIRTUALTABLE
6534 /* Opcode: VCreate P1 P2 * * *
6536 ** P2 is a register that holds the name of a virtual table in database
6537 ** P1. Call the xCreate method for that table.
6540 Mem sMem
; /* For storing the record being decoded */
6541 const char *zTab
; /* Name of the virtual table */
6543 memset(&sMem
, 0, sizeof(sMem
));
6545 /* Because P2 is always a static string, it is impossible for the
6546 ** sqlite3VdbeMemCopy() to fail */
6547 assert( (aMem
[pOp
->p2
].flags
& MEM_Str
)!=0 );
6548 assert( (aMem
[pOp
->p2
].flags
& MEM_Static
)!=0 );
6549 rc
= sqlite3VdbeMemCopy(&sMem
, &aMem
[pOp
->p2
]);
6550 assert( rc
==SQLITE_OK
);
6551 zTab
= (const char*)sqlite3_value_text(&sMem
);
6552 assert( zTab
|| db
->mallocFailed
);
6554 rc
= sqlite3VtabCallCreate(db
, pOp
->p1
, zTab
, &p
->zErrMsg
);
6556 sqlite3VdbeMemRelease(&sMem
);
6557 if( rc
) goto abort_due_to_error
;
6560 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6562 #ifndef SQLITE_OMIT_VIRTUALTABLE
6563 /* Opcode: VDestroy P1 * * P4 *
6565 ** P4 is the name of a virtual table in database P1. Call the xDestroy method
6570 rc
= sqlite3VtabCallDestroy(db
, pOp
->p1
, pOp
->p4
.z
);
6572 if( rc
) goto abort_due_to_error
;
6575 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6577 #ifndef SQLITE_OMIT_VIRTUALTABLE
6578 /* Opcode: VOpen P1 * * P4 *
6580 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6581 ** P1 is a cursor number. This opcode opens a cursor to the virtual
6582 ** table and stores that cursor in P1.
6586 sqlite3_vtab_cursor
*pVCur
;
6587 sqlite3_vtab
*pVtab
;
6588 const sqlite3_module
*pModule
;
6590 assert( p
->bIsReader
);
6593 pVtab
= pOp
->p4
.pVtab
->pVtab
;
6594 if( pVtab
==0 || NEVER(pVtab
->pModule
==0) ){
6596 goto abort_due_to_error
;
6598 pModule
= pVtab
->pModule
;
6599 rc
= pModule
->xOpen(pVtab
, &pVCur
);
6600 sqlite3VtabImportErrmsg(p
, pVtab
);
6601 if( rc
) goto abort_due_to_error
;
6603 /* Initialize sqlite3_vtab_cursor base class */
6604 pVCur
->pVtab
= pVtab
;
6606 /* Initialize vdbe cursor object */
6607 pCur
= allocateCursor(p
, pOp
->p1
, 0, -1, CURTYPE_VTAB
);
6609 pCur
->uc
.pVCur
= pVCur
;
6612 assert( db
->mallocFailed
);
6613 pModule
->xClose(pVCur
);
6618 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6620 #ifndef SQLITE_OMIT_VIRTUALTABLE
6621 /* Opcode: VFilter P1 P2 P3 P4 *
6622 ** Synopsis: iplan=r[P3] zplan='P4'
6624 ** P1 is a cursor opened using VOpen. P2 is an address to jump to if
6625 ** the filtered result set is empty.
6627 ** P4 is either NULL or a string that was generated by the xBestIndex
6628 ** method of the module. The interpretation of the P4 string is left
6629 ** to the module implementation.
6631 ** This opcode invokes the xFilter method on the virtual table specified
6632 ** by P1. The integer query plan parameter to xFilter is stored in register
6633 ** P3. Register P3+1 stores the argc parameter to be passed to the
6634 ** xFilter method. Registers P3+2..P3+1+argc are the argc
6635 ** additional parameters which are passed to
6636 ** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
6638 ** A jump is made to P2 if the result set after filtering would be empty.
6640 case OP_VFilter
: { /* jump */
6643 const sqlite3_module
*pModule
;
6646 sqlite3_vtab_cursor
*pVCur
;
6647 sqlite3_vtab
*pVtab
;
6653 pQuery
= &aMem
[pOp
->p3
];
6655 pCur
= p
->apCsr
[pOp
->p1
];
6656 assert( memIsValid(pQuery
) );
6657 REGISTER_TRACE(pOp
->p3
, pQuery
);
6658 assert( pCur
->eCurType
==CURTYPE_VTAB
);
6659 pVCur
= pCur
->uc
.pVCur
;
6660 pVtab
= pVCur
->pVtab
;
6661 pModule
= pVtab
->pModule
;
6663 /* Grab the index number and argc parameters */
6664 assert( (pQuery
->flags
&MEM_Int
)!=0 && pArgc
->flags
==MEM_Int
);
6665 nArg
= (int)pArgc
->u
.i
;
6666 iQuery
= (int)pQuery
->u
.i
;
6668 /* Invoke the xFilter method */
6671 for(i
= 0; i
<nArg
; i
++){
6672 apArg
[i
] = &pArgc
[i
+1];
6674 rc
= pModule
->xFilter(pVCur
, iQuery
, pOp
->p4
.z
, nArg
, apArg
);
6675 sqlite3VtabImportErrmsg(p
, pVtab
);
6676 if( rc
) goto abort_due_to_error
;
6677 res
= pModule
->xEof(pVCur
);
6679 VdbeBranchTaken(res
!=0,2);
6680 if( res
) goto jump_to_p2
;
6683 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6685 #ifndef SQLITE_OMIT_VIRTUALTABLE
6686 /* Opcode: VColumn P1 P2 P3 * *
6687 ** Synopsis: r[P3]=vcolumn(P2)
6689 ** Store the value of the P2-th column of
6690 ** the row of the virtual-table that the
6691 ** P1 cursor is pointing to into register P3.
6694 sqlite3_vtab
*pVtab
;
6695 const sqlite3_module
*pModule
;
6697 sqlite3_context sContext
;
6699 VdbeCursor
*pCur
= p
->apCsr
[pOp
->p1
];
6700 assert( pCur
->eCurType
==CURTYPE_VTAB
);
6701 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
6702 pDest
= &aMem
[pOp
->p3
];
6703 memAboutToChange(p
, pDest
);
6704 if( pCur
->nullRow
){
6705 sqlite3VdbeMemSetNull(pDest
);
6708 pVtab
= pCur
->uc
.pVCur
->pVtab
;
6709 pModule
= pVtab
->pModule
;
6710 assert( pModule
->xColumn
);
6711 memset(&sContext
, 0, sizeof(sContext
));
6712 sContext
.pOut
= pDest
;
6713 MemSetTypeFlag(pDest
, MEM_Null
);
6714 rc
= pModule
->xColumn(pCur
->uc
.pVCur
, &sContext
, pOp
->p2
);
6715 sqlite3VtabImportErrmsg(p
, pVtab
);
6716 if( sContext
.isError
){
6717 rc
= sContext
.isError
;
6719 sqlite3VdbeChangeEncoding(pDest
, encoding
);
6720 REGISTER_TRACE(pOp
->p3
, pDest
);
6721 UPDATE_MAX_BLOBSIZE(pDest
);
6723 if( sqlite3VdbeMemTooBig(pDest
) ){
6726 if( rc
) goto abort_due_to_error
;
6729 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6731 #ifndef SQLITE_OMIT_VIRTUALTABLE
6732 /* Opcode: VNext P1 P2 * * *
6734 ** Advance virtual table P1 to the next row in its result set and
6735 ** jump to instruction P2. Or, if the virtual table has reached
6736 ** the end of its result set, then fall through to the next instruction.
6738 case OP_VNext
: { /* jump */
6739 sqlite3_vtab
*pVtab
;
6740 const sqlite3_module
*pModule
;
6745 pCur
= p
->apCsr
[pOp
->p1
];
6746 assert( pCur
->eCurType
==CURTYPE_VTAB
);
6747 if( pCur
->nullRow
){
6750 pVtab
= pCur
->uc
.pVCur
->pVtab
;
6751 pModule
= pVtab
->pModule
;
6752 assert( pModule
->xNext
);
6754 /* Invoke the xNext() method of the module. There is no way for the
6755 ** underlying implementation to return an error if one occurs during
6756 ** xNext(). Instead, if an error occurs, true is returned (indicating that
6757 ** data is available) and the error code returned when xColumn or
6758 ** some other method is next invoked on the save virtual table cursor.
6760 rc
= pModule
->xNext(pCur
->uc
.pVCur
);
6761 sqlite3VtabImportErrmsg(p
, pVtab
);
6762 if( rc
) goto abort_due_to_error
;
6763 res
= pModule
->xEof(pCur
->uc
.pVCur
);
6764 VdbeBranchTaken(!res
,2);
6766 /* If there is data, jump to P2 */
6767 goto jump_to_p2_and_check_for_interrupt
;
6769 goto check_for_interrupt
;
6771 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6773 #ifndef SQLITE_OMIT_VIRTUALTABLE
6774 /* Opcode: VRename P1 * * P4 *
6776 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6777 ** This opcode invokes the corresponding xRename method. The value
6778 ** in register P1 is passed as the zName argument to the xRename method.
6781 sqlite3_vtab
*pVtab
;
6784 pVtab
= pOp
->p4
.pVtab
->pVtab
;
6785 pName
= &aMem
[pOp
->p1
];
6786 assert( pVtab
->pModule
->xRename
);
6787 assert( memIsValid(pName
) );
6788 assert( p
->readOnly
==0 );
6789 REGISTER_TRACE(pOp
->p1
, pName
);
6790 assert( pName
->flags
& MEM_Str
);
6791 testcase( pName
->enc
==SQLITE_UTF8
);
6792 testcase( pName
->enc
==SQLITE_UTF16BE
);
6793 testcase( pName
->enc
==SQLITE_UTF16LE
);
6794 rc
= sqlite3VdbeChangeEncoding(pName
, SQLITE_UTF8
);
6795 if( rc
) goto abort_due_to_error
;
6796 rc
= pVtab
->pModule
->xRename(pVtab
, pName
->z
);
6797 sqlite3VtabImportErrmsg(p
, pVtab
);
6799 if( rc
) goto abort_due_to_error
;
6804 #ifndef SQLITE_OMIT_VIRTUALTABLE
6805 /* Opcode: VUpdate P1 P2 P3 P4 P5
6806 ** Synopsis: data=r[P3@P2]
6808 ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
6809 ** This opcode invokes the corresponding xUpdate method. P2 values
6810 ** are contiguous memory cells starting at P3 to pass to the xUpdate
6811 ** invocation. The value in register (P3+P2-1) corresponds to the
6812 ** p2th element of the argv array passed to xUpdate.
6814 ** The xUpdate method will do a DELETE or an INSERT or both.
6815 ** The argv[0] element (which corresponds to memory cell P3)
6816 ** is the rowid of a row to delete. If argv[0] is NULL then no
6817 ** deletion occurs. The argv[1] element is the rowid of the new
6818 ** row. This can be NULL to have the virtual table select the new
6819 ** rowid for itself. The subsequent elements in the array are
6820 ** the values of columns in the new row.
6822 ** If P2==1 then no insert is performed. argv[0] is the rowid of
6825 ** P1 is a boolean flag. If it is set to true and the xUpdate call
6826 ** is successful, then the value returned by sqlite3_last_insert_rowid()
6827 ** is set to the value of the rowid for the row just inserted.
6829 ** P5 is the error actions (OE_Replace, OE_Fail, OE_Ignore, etc) to
6830 ** apply in the case of a constraint failure on an insert or update.
6833 sqlite3_vtab
*pVtab
;
6834 const sqlite3_module
*pModule
;
6841 assert( pOp
->p2
==1 || pOp
->p5
==OE_Fail
|| pOp
->p5
==OE_Rollback
6842 || pOp
->p5
==OE_Abort
|| pOp
->p5
==OE_Ignore
|| pOp
->p5
==OE_Replace
6844 assert( p
->readOnly
==0 );
6845 pVtab
= pOp
->p4
.pVtab
->pVtab
;
6846 if( pVtab
==0 || NEVER(pVtab
->pModule
==0) ){
6848 goto abort_due_to_error
;
6850 pModule
= pVtab
->pModule
;
6852 assert( pOp
->p4type
==P4_VTAB
);
6853 if( ALWAYS(pModule
->xUpdate
) ){
6854 u8 vtabOnConflict
= db
->vtabOnConflict
;
6856 pX
= &aMem
[pOp
->p3
];
6857 for(i
=0; i
<nArg
; i
++){
6858 assert( memIsValid(pX
) );
6859 memAboutToChange(p
, pX
);
6863 db
->vtabOnConflict
= pOp
->p5
;
6864 rc
= pModule
->xUpdate(pVtab
, nArg
, apArg
, &rowid
);
6865 db
->vtabOnConflict
= vtabOnConflict
;
6866 sqlite3VtabImportErrmsg(p
, pVtab
);
6867 if( rc
==SQLITE_OK
&& pOp
->p1
){
6868 assert( nArg
>1 && apArg
[0] && (apArg
[0]->flags
&MEM_Null
) );
6869 db
->lastRowid
= rowid
;
6871 if( (rc
&0xff)==SQLITE_CONSTRAINT
&& pOp
->p4
.pVtab
->bConstraint
){
6872 if( pOp
->p5
==OE_Ignore
){
6875 p
->errorAction
= ((pOp
->p5
==OE_Replace
) ? OE_Abort
: pOp
->p5
);
6880 if( rc
) goto abort_due_to_error
;
6884 #endif /* SQLITE_OMIT_VIRTUALTABLE */
6886 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
6887 /* Opcode: Pagecount P1 P2 * * *
6889 ** Write the current number of pages in database P1 to memory cell P2.
6891 case OP_Pagecount
: { /* out2 */
6892 pOut
= out2Prerelease(p
, pOp
);
6893 pOut
->u
.i
= sqlite3BtreeLastPage(db
->aDb
[pOp
->p1
].pBt
);
6899 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
6900 /* Opcode: MaxPgcnt P1 P2 P3 * *
6902 ** Try to set the maximum page count for database P1 to the value in P3.
6903 ** Do not let the maximum page count fall below the current page count and
6904 ** do not change the maximum page count value if P3==0.
6906 ** Store the maximum page count after the change in register P2.
6908 case OP_MaxPgcnt
: { /* out2 */
6909 unsigned int newMax
;
6912 pOut
= out2Prerelease(p
, pOp
);
6913 pBt
= db
->aDb
[pOp
->p1
].pBt
;
6916 newMax
= sqlite3BtreeLastPage(pBt
);
6917 if( newMax
< (unsigned)pOp
->p3
) newMax
= (unsigned)pOp
->p3
;
6919 pOut
->u
.i
= sqlite3BtreeMaxPageCount(pBt
, newMax
);
6924 /* Opcode: Function0 P1 P2 P3 P4 P5
6925 ** Synopsis: r[P3]=func(r[P2@P5])
6927 ** Invoke a user function (P4 is a pointer to a FuncDef object that
6928 ** defines the function) with P5 arguments taken from register P2 and
6929 ** successors. The result of the function is stored in register P3.
6930 ** Register P3 must not be one of the function inputs.
6932 ** P1 is a 32-bit bitmask indicating whether or not each argument to the
6933 ** function was determined to be constant at compile time. If the first
6934 ** argument was constant then bit 0 of P1 is set. This is used to determine
6935 ** whether meta data associated with a user function argument using the
6936 ** sqlite3_set_auxdata() API may be safely retained until the next
6937 ** invocation of this opcode.
6939 ** See also: Function, AggStep, AggFinal
6941 /* Opcode: Function P1 P2 P3 P4 P5
6942 ** Synopsis: r[P3]=func(r[P2@P5])
6944 ** Invoke a user function (P4 is a pointer to an sqlite3_context object that
6945 ** contains a pointer to the function to be run) with P5 arguments taken
6946 ** from register P2 and successors. The result of the function is stored
6947 ** in register P3. Register P3 must not be one of the function inputs.
6949 ** P1 is a 32-bit bitmask indicating whether or not each argument to the
6950 ** function was determined to be constant at compile time. If the first
6951 ** argument was constant then bit 0 of P1 is set. This is used to determine
6952 ** whether meta data associated with a user function argument using the
6953 ** sqlite3_set_auxdata() API may be safely retained until the next
6954 ** invocation of this opcode.
6956 ** SQL functions are initially coded as OP_Function0 with P4 pointing
6957 ** to a FuncDef object. But on first evaluation, the P4 operand is
6958 ** automatically converted into an sqlite3_context object and the operation
6959 ** changed to this OP_Function opcode. In this way, the initialization of
6960 ** the sqlite3_context object occurs only once, rather than once for each
6961 ** evaluation of the function.
6963 ** See also: Function0, AggStep, AggFinal
6966 case OP_Function0
: {
6968 sqlite3_context
*pCtx
;
6970 assert( pOp
->p4type
==P4_FUNCDEF
);
6972 assert( pOp
->p3
>0 && pOp
->p3
<=(p
->nMem
+1 - p
->nCursor
) );
6973 assert( n
==0 || (pOp
->p2
>0 && pOp
->p2
+n
<=(p
->nMem
+1 - p
->nCursor
)+1) );
6974 assert( pOp
->p3
<pOp
->p2
|| pOp
->p3
>=pOp
->p2
+n
);
6975 pCtx
= sqlite3DbMallocRawNN(db
, sizeof(*pCtx
) + (n
-1)*sizeof(sqlite3_value
*));
6976 if( pCtx
==0 ) goto no_mem
;
6978 pCtx
->pFunc
= pOp
->p4
.pFunc
;
6979 pCtx
->iOp
= (int)(pOp
- aOp
);
6982 pOp
->p4type
= P4_FUNCCTX
;
6983 pOp
->p4
.pCtx
= pCtx
;
6984 assert( OP_PureFunc
== OP_PureFunc0
+2 );
6985 assert( OP_Function
== OP_Function0
+2 );
6987 /* Fall through into OP_Function */
6992 sqlite3_context
*pCtx
;
6994 assert( pOp
->p4type
==P4_FUNCCTX
);
6995 pCtx
= pOp
->p4
.pCtx
;
6997 /* If this function is inside of a trigger, the register array in aMem[]
6998 ** might change from one evaluation to the next. The next block of code
6999 ** checks to see if the register array has changed, and if so it
7000 ** reinitializes the relavant parts of the sqlite3_context object */
7001 pOut
= &aMem
[pOp
->p3
];
7002 if( pCtx
->pOut
!= pOut
){
7004 for(i
=pCtx
->argc
-1; i
>=0; i
--) pCtx
->argv
[i
] = &aMem
[pOp
->p2
+i
];
7007 memAboutToChange(p
, pOut
);
7009 for(i
=0; i
<pCtx
->argc
; i
++){
7010 assert( memIsValid(pCtx
->argv
[i
]) );
7011 REGISTER_TRACE(pOp
->p2
+i
, pCtx
->argv
[i
]);
7014 MemSetTypeFlag(pOut
, MEM_Null
);
7015 pCtx
->fErrorOrAux
= 0;
7016 (*pCtx
->pFunc
->xSFunc
)(pCtx
, pCtx
->argc
, pCtx
->argv
);/* IMP: R-24505-23230 */
7018 /* If the function returned an error, throw an exception */
7019 if( pCtx
->fErrorOrAux
){
7020 if( pCtx
->isError
){
7021 sqlite3VdbeError(p
, "%s", sqlite3_value_text(pOut
));
7024 sqlite3VdbeDeleteAuxData(db
, &p
->pAuxData
, pCtx
->iOp
, pOp
->p1
);
7025 if( rc
) goto abort_due_to_error
;
7028 /* Copy the result of the function into register P3 */
7029 if( pOut
->flags
& (MEM_Str
|MEM_Blob
) ){
7030 sqlite3VdbeChangeEncoding(pOut
, encoding
);
7031 if( sqlite3VdbeMemTooBig(pOut
) ) goto too_big
;
7034 REGISTER_TRACE(pOp
->p3
, pOut
);
7035 UPDATE_MAX_BLOBSIZE(pOut
);
7040 /* Opcode: Init P1 P2 P3 P4 *
7041 ** Synopsis: Start at P2
7043 ** Programs contain a single instance of this opcode as the very first
7046 ** If tracing is enabled (by the sqlite3_trace()) interface, then
7047 ** the UTF-8 string contained in P4 is emitted on the trace callback.
7048 ** Or if P4 is blank, use the string returned by sqlite3_sql().
7050 ** If P2 is not zero, jump to instruction P2.
7052 ** Increment the value of P1 so that OP_Once opcodes will jump the
7053 ** first time they are evaluated for this run.
7055 ** If P3 is not zero, then it is an address to jump to if an SQLITE_CORRUPT
7056 ** error is encountered.
7058 case OP_Init
: { /* jump */
7062 /* If the P4 argument is not NULL, then it must be an SQL comment string.
7063 ** The "--" string is broken up to prevent false-positives with srcck1.c.
7065 ** This assert() provides evidence for:
7066 ** EVIDENCE-OF: R-50676-09860 The callback can compute the same text that
7067 ** would have been returned by the legacy sqlite3_trace() interface by
7068 ** using the X argument when X begins with "--" and invoking
7069 ** sqlite3_expanded_sql(P) otherwise.
7071 assert( pOp
->p4
.z
==0 || strncmp(pOp
->p4
.z
, "-" "- ", 3)==0 );
7072 assert( pOp
==p
->aOp
); /* Always instruction 0 */
7074 #ifndef SQLITE_OMIT_TRACE
7075 if( (db
->mTrace
& (SQLITE_TRACE_STMT
|SQLITE_TRACE_LEGACY
))!=0
7077 && (zTrace
= (pOp
->p4
.z
? pOp
->p4
.z
: p
->zSql
))!=0
7079 #ifndef SQLITE_OMIT_DEPRECATED
7080 if( db
->mTrace
& SQLITE_TRACE_LEGACY
){
7081 void (*x
)(void*,const char*) = (void(*)(void*,const char*))db
->xTrace
;
7082 char *z
= sqlite3VdbeExpandSql(p
, zTrace
);
7083 x(db
->pTraceArg
, z
);
7087 if( db
->nVdbeExec
>1 ){
7088 char *z
= sqlite3MPrintf(db
, "-- %s", zTrace
);
7089 (void)db
->xTrace(SQLITE_TRACE_STMT
, db
->pTraceArg
, p
, z
);
7090 sqlite3DbFree(db
, z
);
7092 (void)db
->xTrace(SQLITE_TRACE_STMT
, db
->pTraceArg
, p
, zTrace
);
7095 #ifdef SQLITE_USE_FCNTL_TRACE
7096 zTrace
= (pOp
->p4
.z
? pOp
->p4
.z
: p
->zSql
);
7099 for(j
=0; j
<db
->nDb
; j
++){
7100 if( DbMaskTest(p
->btreeMask
, j
)==0 ) continue;
7101 sqlite3_file_control(db
, db
->aDb
[j
].zDbSName
, SQLITE_FCNTL_TRACE
, zTrace
);
7104 #endif /* SQLITE_USE_FCNTL_TRACE */
7106 if( (db
->flags
& SQLITE_SqlTrace
)!=0
7107 && (zTrace
= (pOp
->p4
.z
? pOp
->p4
.z
: p
->zSql
))!=0
7109 sqlite3DebugPrintf("SQL-trace: %s\n", zTrace
);
7111 #endif /* SQLITE_DEBUG */
7112 #endif /* SQLITE_OMIT_TRACE */
7113 assert( pOp
->p2
>0 );
7114 if( pOp
->p1
>=sqlite3GlobalConfig
.iOnceResetThreshold
){
7115 for(i
=1; i
<p
->nOp
; i
++){
7116 if( p
->aOp
[i
].opcode
==OP_Once
) p
->aOp
[i
].p1
= 0;
7121 p
->aCounter
[SQLITE_STMTSTATUS_RUN
]++;
7125 #ifdef SQLITE_ENABLE_CURSOR_HINTS
7126 /* Opcode: CursorHint P1 * * P4 *
7128 ** Provide a hint to cursor P1 that it only needs to return rows that
7129 ** satisfy the Expr in P4. TK_REGISTER terms in the P4 expression refer
7130 ** to values currently held in registers. TK_COLUMN terms in the P4
7131 ** expression refer to columns in the b-tree to which cursor P1 is pointing.
7133 case OP_CursorHint
: {
7136 assert( pOp
->p1
>=0 && pOp
->p1
<p
->nCursor
);
7137 assert( pOp
->p4type
==P4_EXPR
);
7138 pC
= p
->apCsr
[pOp
->p1
];
7140 assert( pC
->eCurType
==CURTYPE_BTREE
);
7141 sqlite3BtreeCursorHint(pC
->uc
.pCursor
, BTREE_HINT_RANGE
,
7142 pOp
->p4
.pExpr
, aMem
);
7146 #endif /* SQLITE_ENABLE_CURSOR_HINTS */
7148 /* Opcode: Noop * * * * *
7150 ** Do nothing. This instruction is often useful as a jump
7154 ** The magic Explain opcode are only inserted when explain==2 (which
7155 ** is to say when the EXPLAIN QUERY PLAN syntax is used.)
7156 ** This opcode records information from the optimizer. It is the
7157 ** the same as a no-op. This opcodesnever appears in a real VM program.
7159 default: { /* This is really OP_Noop and OP_Explain */
7160 assert( pOp
->opcode
==OP_Noop
|| pOp
->opcode
==OP_Explain
);
7164 /*****************************************************************************
7165 ** The cases of the switch statement above this line should all be indented
7166 ** by 6 spaces. But the left-most 6 spaces have been removed to improve the
7167 ** readability. From this point on down, the normal indentation rules are
7169 *****************************************************************************/
7174 u64 endTime
= sqlite3Hwtime();
7175 if( endTime
>start
) pOrigOp
->cycles
+= endTime
- start
;
7180 /* The following code adds nothing to the actual functionality
7181 ** of the program. It is only here for testing and debugging.
7182 ** On the other hand, it does burn CPU cycles every time through
7183 ** the evaluator loop. So we can leave it out when NDEBUG is defined.
7186 assert( pOp
>=&aOp
[-1] && pOp
<&aOp
[p
->nOp
-1] );
7189 if( db
->flags
& SQLITE_VdbeTrace
){
7190 u8 opProperty
= sqlite3OpcodeProperty
[pOrigOp
->opcode
];
7191 if( rc
!=0 ) printf("rc=%d\n",rc
);
7192 if( opProperty
& (OPFLG_OUT2
) ){
7193 registerTrace(pOrigOp
->p2
, &aMem
[pOrigOp
->p2
]);
7195 if( opProperty
& OPFLG_OUT3
){
7196 registerTrace(pOrigOp
->p3
, &aMem
[pOrigOp
->p3
]);
7199 #endif /* SQLITE_DEBUG */
7201 } /* The end of the for(;;) loop the loops through opcodes */
7203 /* If we reach this point, it means that execution is finished with
7204 ** an error of some kind.
7207 if( db
->mallocFailed
) rc
= SQLITE_NOMEM_BKPT
;
7209 if( p
->zErrMsg
==0 && rc
!=SQLITE_IOERR_NOMEM
){
7210 sqlite3VdbeError(p
, "%s", sqlite3ErrStr(rc
));
7213 sqlite3SystemError(db
, rc
);
7214 testcase( sqlite3GlobalConfig
.xLog
!=0 );
7215 sqlite3_log(rc
, "statement aborts at %d: [%s] %s",
7216 (int)(pOp
- aOp
), p
->zSql
, p
->zErrMsg
);
7218 if( rc
==SQLITE_IOERR_NOMEM
) sqlite3OomFault(db
);
7220 if( resetSchemaOnFault
>0 ){
7221 sqlite3ResetOneSchema(db
, resetSchemaOnFault
-1);
7224 /* This is the only way out of this procedure. We have to
7225 ** release the mutexes on btrees that were acquired at the
7228 testcase( nVmStep
>0 );
7229 p
->aCounter
[SQLITE_STMTSTATUS_VM_STEP
] += (int)nVmStep
;
7230 sqlite3VdbeLeave(p
);
7231 assert( rc
!=SQLITE_OK
|| nExtraDelete
==0
7232 || sqlite3_strlike("DELETE%",p
->zSql
,0)!=0
7236 /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
7240 sqlite3VdbeError(p
, "string or blob too big");
7242 goto abort_due_to_error
;
7244 /* Jump to here if a malloc() fails.
7247 sqlite3OomFault(db
);
7248 sqlite3VdbeError(p
, "out of memory");
7249 rc
= SQLITE_NOMEM_BKPT
;
7250 goto abort_due_to_error
;
7252 /* Jump to here if the sqlite3_interrupt() API sets the interrupt
7255 abort_due_to_interrupt
:
7256 assert( db
->u1
.isInterrupted
);
7257 rc
= db
->mallocFailed
? SQLITE_NOMEM_BKPT
: SQLITE_INTERRUPT
;
7259 sqlite3VdbeError(p
, "%s", sqlite3ErrStr(rc
));
7260 goto abort_due_to_error
;