blob: ecdd92be9cf9186ad58b44a719810aa95dc12bb4 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
drh0fd61352014-02-07 02:29:45 +000012** The code in this file implements the function that runs the
13** bytecode of a prepared statement.
drh75897232000-05-29 14:26:00 +000014**
drhac82fcf2002-09-08 17:23:41 +000015** 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.
drh75897232000-05-29 14:26:00 +000020*/
21#include "sqliteInt.h"
drh9a324642003-09-06 20:12:01 +000022#include "vdbeInt.h"
drh8f619cc2002-09-08 00:04:50 +000023
24/*
drh2b4ded92010-09-27 21:09:31 +000025** Invoke this macro on memory cells just prior to changing the
26** value of the cell. This macro verifies that shallow copies are
drh0fd61352014-02-07 02:29:45 +000027** 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
drhb6e8fd12014-03-06 01:56:33 +000031** like that ever happens.
drh2b4ded92010-09-27 21:09:31 +000032*/
33#ifdef SQLITE_DEBUG
drhe4c88c02012-01-04 12:57:45 +000034# define memAboutToChange(P,M) sqlite3VdbeMemAboutToChange(P,M)
drh2b4ded92010-09-27 21:09:31 +000035#else
36# define memAboutToChange(P,M)
37#endif
38
39/*
drh487ab3c2001-11-08 00:45:21 +000040** The following global variable is incremented every time a cursor
drh959403f2008-12-12 17:56:16 +000041** moves, either by the OP_SeekXX, OP_Next, or OP_Prev opcodes. The test
drh487ab3c2001-11-08 00:45:21 +000042** procedures use this information to make sure that indices are
drhac82fcf2002-09-08 17:23:41 +000043** working correctly. This variable has no function other than to
44** help verify the correct operation of the library.
drh487ab3c2001-11-08 00:45:21 +000045*/
drh0f7eb612006-08-08 13:51:43 +000046#ifdef SQLITE_TEST
danielk19776f8a5032004-05-10 10:34:51 +000047int sqlite3_search_count = 0;
drh0f7eb612006-08-08 13:51:43 +000048#endif
drh487ab3c2001-11-08 00:45:21 +000049
drhf6038712004-02-08 18:07:34 +000050/*
51** When this global variable is positive, it gets decremented once before
drhe4c88c02012-01-04 12:57:45 +000052** 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.
drhf6038712004-02-08 18:07:34 +000054**
55** This facility is used for testing purposes only. It does not function
56** in an ordinary build.
57*/
drh0f7eb612006-08-08 13:51:43 +000058#ifdef SQLITE_TEST
danielk19776f8a5032004-05-10 10:34:51 +000059int sqlite3_interrupt_count = 0;
drh0f7eb612006-08-08 13:51:43 +000060#endif
drh1350b032002-02-27 19:00:20 +000061
danielk19777e18c252004-05-25 11:47:24 +000062/*
drh6bf89572004-11-03 16:27:01 +000063** 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
shane21e7feb2008-05-30 15:59:49 +000065** sorting is occurring or not occurring at appropriate times. This variable
drh6bf89572004-11-03 16:27:01 +000066** has no function other than to help verify the correct operation of the
67** library.
68*/
drh0f7eb612006-08-08 13:51:43 +000069#ifdef SQLITE_TEST
drh6bf89572004-11-03 16:27:01 +000070int sqlite3_sort_count = 0;
drh0f7eb612006-08-08 13:51:43 +000071#endif
drh6bf89572004-11-03 16:27:01 +000072
73/*
drhae7e1512007-05-02 16:51:59 +000074** The next global variable records the size of the largest MEM_Blob
drh9cbf3422008-01-17 16:22:13 +000075** or MEM_Str that has been used by a VDBE opcode. The test procedures
drhae7e1512007-05-02 16:51:59 +000076** 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.
79*/
80#ifdef SQLITE_TEST
81int sqlite3_max_blobsize = 0;
drhca48c902008-01-18 14:08:24 +000082static void updateMaxBlobsize(Mem *p){
83 if( (p->flags & (MEM_Str|MEM_Blob))!=0 && p->n>sqlite3_max_blobsize ){
84 sqlite3_max_blobsize = p->n;
85 }
86}
drhae7e1512007-05-02 16:51:59 +000087#endif
88
89/*
drh9b1c62d2011-03-30 21:04:43 +000090** This macro evaluates to true if either the update hook or the preupdate
91** hook are enabled for database connect DB.
92*/
93#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
drh74c33022016-03-30 12:56:55 +000094# define HAS_UPDATE_HOOK(DB) ((DB)->xPreUpdateCallback||(DB)->xUpdateCallback)
drh9b1c62d2011-03-30 21:04:43 +000095#else
drh74c33022016-03-30 12:56:55 +000096# define HAS_UPDATE_HOOK(DB) ((DB)->xUpdateCallback)
drh9b1c62d2011-03-30 21:04:43 +000097#endif
98
99/*
drh0fd61352014-02-07 02:29:45 +0000100** The next global variable is incremented each time the OP_Found opcode
dan0ff297e2009-09-25 17:03:14 +0000101** is executed. This is used to test whether or not the foreign key
102** operation implemented using OP_FkIsZero is working. This variable
103** has no function other than to help verify the correct operation of the
104** library.
105*/
106#ifdef SQLITE_TEST
107int sqlite3_found_count = 0;
108#endif
109
110/*
drhb7654112008-01-12 12:48:07 +0000111** Test a register to see if it exceeds the current maximum blob size.
112** If it does, record the new maximum blob size.
113*/
drhd12602a2016-12-07 15:49:02 +0000114#if defined(SQLITE_TEST) && !defined(SQLITE_UNTESTABLE)
drhca48c902008-01-18 14:08:24 +0000115# define UPDATE_MAX_BLOBSIZE(P) updateMaxBlobsize(P)
drhb7654112008-01-12 12:48:07 +0000116#else
117# define UPDATE_MAX_BLOBSIZE(P)
118#endif
119
120/*
drh5655c542014-02-19 19:14:34 +0000121** 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.
124**
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.
drh4336b0e2014-08-05 00:53:51 +0000129**
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.
drh688852a2014-02-17 22:40:43 +0000135*/
136#if !defined(SQLITE_VDBE_COVERAGE)
137# define VdbeBranchTaken(I,M)
138#else
drh5655c542014-02-19 19:14:34 +0000139# define VdbeBranchTaken(I,M) vdbeTakeBranch(pOp->iSrcLine,I,M)
140 static void vdbeTakeBranch(int iSrcLine, u8 I, u8 M){
141 if( iSrcLine<=2 && ALWAYS(iSrcLine>0) ){
142 M = iSrcLine;
143 /* Assert the truth of VdbeCoverageAlwaysTaken() and
144 ** VdbeCoverageNeverTaken() */
145 assert( (M & I)==I );
146 }else{
147 if( sqlite3GlobalConfig.xVdbeBranch==0 ) return; /*NO_TEST*/
148 sqlite3GlobalConfig.xVdbeBranch(sqlite3GlobalConfig.pVdbeBranchArg,
149 iSrcLine,I,M);
150 }
151 }
drh688852a2014-02-17 22:40:43 +0000152#endif
153
154/*
drh9cbf3422008-01-17 16:22:13 +0000155** Convert the given register into a string if it isn't one
danielk1977bd7e4602004-05-24 07:34:48 +0000156** already. Return non-zero if a malloc() fails.
157*/
drhb21c8cd2007-08-21 19:33:56 +0000158#define Stringify(P, enc) \
drhbd9507c2014-08-23 17:21:37 +0000159 if(((P)->flags&(MEM_Str|MEM_Blob))==0 && sqlite3VdbeMemStringify(P,enc,0)) \
drhf4479502004-05-27 03:12:53 +0000160 { goto no_mem; }
danielk1977bd7e4602004-05-24 07:34:48 +0000161
162/*
danielk1977bd7e4602004-05-24 07:34:48 +0000163** An ephemeral string value (signified by the MEM_Ephem flag) contains
164** a pointer to a dynamically allocated string where some other entity
drh9cbf3422008-01-17 16:22:13 +0000165** is responsible for deallocating that string. Because the register
166** does not control the string, it might be deleted without the register
167** knowing it.
danielk1977bd7e4602004-05-24 07:34:48 +0000168**
169** This routine converts an ephemeral string into a dynamically allocated
drh9cbf3422008-01-17 16:22:13 +0000170** string that the register itself controls. In other words, it
drhc91b2fd2014-03-01 18:13:23 +0000171** converts an MEM_Ephem string into a string with P.z==P.zMalloc.
danielk1977bd7e4602004-05-24 07:34:48 +0000172*/
drhb21c8cd2007-08-21 19:33:56 +0000173#define Deephemeralize(P) \
drheb2e1762004-05-27 01:53:56 +0000174 if( ((P)->flags&MEM_Ephem)!=0 \
drhb21c8cd2007-08-21 19:33:56 +0000175 && sqlite3VdbeMemMakeWriteable(P) ){ goto no_mem;}
danielk197793d46752004-05-23 13:30:58 +0000176
dan689ab892011-08-12 15:02:00 +0000177/* Return true if the cursor was opened using the OP_OpenSorter opcode. */
drhc960dcb2015-11-20 19:22:01 +0000178#define isSorter(x) ((x)->eCurType==CURTYPE_SORTER)
danielk19778a6b5412004-05-24 07:04:25 +0000179
180/*
drhdfe88ec2008-11-03 20:55:06 +0000181** Allocate VdbeCursor number iCur. Return a pointer to it. Return NULL
drh4774b132004-06-12 20:12:51 +0000182** if we run out of memory.
drh8c74a8c2002-08-25 19:20:40 +0000183*/
drhdfe88ec2008-11-03 20:55:06 +0000184static VdbeCursor *allocateCursor(
185 Vdbe *p, /* The virtual machine */
186 int iCur, /* Index of the new VdbeCursor */
danielk1977d336e222009-02-20 10:58:41 +0000187 int nField, /* Number of fields in the table or index */
drhe4c88c02012-01-04 12:57:45 +0000188 int iDb, /* Database the cursor belongs to, or -1 */
drhc960dcb2015-11-20 19:22:01 +0000189 u8 eCurType /* Type of the new cursor */
danielk1977cd3e8f72008-03-25 09:47:35 +0000190){
191 /* Find the memory cell that will be used to store the blob of memory
drhdfe88ec2008-11-03 20:55:06 +0000192 ** required for this VdbeCursor structure. It is convenient to use a
danielk1977cd3e8f72008-03-25 09:47:35 +0000193 ** vdbe memory cell to manage the memory allocation required for a
drhdfe88ec2008-11-03 20:55:06 +0000194 ** VdbeCursor structure for the following reasons:
danielk1977cd3e8f72008-03-25 09:47:35 +0000195 **
196 ** * Sometimes cursor numbers are used for a couple of different
197 ** purposes in a vdbe program. The different uses might require
198 ** different sized allocations. Memory cells provide growable
199 ** allocations.
200 **
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.
204 **
drh3cdce922016-03-21 00:30:40 +0000205 ** The memory cell for cursor 0 is aMem[0]. The rest are allocated from
drh9f6168b2016-03-19 23:32:58 +0000206 ** 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.
danielk1977cd3e8f72008-03-25 09:47:35 +0000208 */
drh9f6168b2016-03-19 23:32:58 +0000209 Mem *pMem = iCur>0 ? &p->aMem[p->nMem-iCur] : p->aMem;
danielk1977cd3e8f72008-03-25 09:47:35 +0000210
danielk19775f096132008-03-28 15:44:09 +0000211 int nByte;
drhdfe88ec2008-11-03 20:55:06 +0000212 VdbeCursor *pCx = 0;
danielk19775f096132008-03-28 15:44:09 +0000213 nByte =
drh5cc10232013-11-21 01:04:02 +0000214 ROUND8(sizeof(VdbeCursor)) + 2*sizeof(u32)*nField +
drhc960dcb2015-11-20 19:22:01 +0000215 (eCurType==CURTYPE_BTREE?sqlite3BtreeCursorSize():0);
danielk1977cd3e8f72008-03-25 09:47:35 +0000216
drh9f6168b2016-03-19 23:32:58 +0000217 assert( iCur>=0 && iCur<p->nCursor );
drha3fa1402016-04-29 02:55:05 +0000218 if( p->apCsr[iCur] ){ /*OPTIMIZATION-IF-FALSE*/
danielk1977be718892006-06-23 08:05:19 +0000219 sqlite3VdbeFreeCursor(p, p->apCsr[iCur]);
danielk1977cd3e8f72008-03-25 09:47:35 +0000220 p->apCsr[iCur] = 0;
drh8c74a8c2002-08-25 19:20:40 +0000221 }
drh322f2852014-09-19 00:43:39 +0000222 if( SQLITE_OK==sqlite3VdbeMemClearAndResize(pMem, nByte) ){
drhdfe88ec2008-11-03 20:55:06 +0000223 p->apCsr[iCur] = pCx = (VdbeCursor*)pMem->z;
drhfbd8cbd2016-12-10 12:58:15 +0000224 memset(pCx, 0, offsetof(VdbeCursor,pAltCursor));
drhc960dcb2015-11-20 19:22:01 +0000225 pCx->eCurType = eCurType;
danielk197794eb6a12005-12-15 15:22:08 +0000226 pCx->iDb = iDb;
danielk1977cd3e8f72008-03-25 09:47:35 +0000227 pCx->nField = nField;
drhb53a5a92014-10-12 22:37:22 +0000228 pCx->aOffset = &pCx->aType[nField];
drhc960dcb2015-11-20 19:22:01 +0000229 if( eCurType==CURTYPE_BTREE ){
230 pCx->uc.pCursor = (BtCursor*)
drh5cc10232013-11-21 01:04:02 +0000231 &pMem->z[ROUND8(sizeof(VdbeCursor))+2*sizeof(u32)*nField];
drhc960dcb2015-11-20 19:22:01 +0000232 sqlite3BtreeCursorZero(pCx->uc.pCursor);
danielk1977cd3e8f72008-03-25 09:47:35 +0000233 }
danielk197794eb6a12005-12-15 15:22:08 +0000234 }
drh4774b132004-06-12 20:12:51 +0000235 return pCx;
drh8c74a8c2002-08-25 19:20:40 +0000236}
237
danielk19773d1bfea2004-05-14 11:00:53 +0000238/*
drh29d72102006-02-09 22:13:41 +0000239** 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.
drhbd9507c2014-08-23 17:21:37 +0000243**
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.
248**
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.
drh29d72102006-02-09 22:13:41 +0000252*/
drhbd9507c2014-08-23 17:21:37 +0000253static void applyNumericAffinity(Mem *pRec, int bTryForInt){
drh975b4c62014-07-26 16:47:23 +0000254 double rValue;
255 i64 iValue;
256 u8 enc = pRec->enc;
drh11a6eee2014-09-19 22:01:54 +0000257 assert( (pRec->flags & (MEM_Str|MEM_Int|MEM_Real))==MEM_Str );
drh975b4c62014-07-26 16:47:23 +0000258 if( sqlite3AtoF(pRec->z, &rValue, pRec->n, enc)==0 ) return;
259 if( 0==sqlite3Atoi64(pRec->z, &iValue, pRec->n, enc) ){
260 pRec->u.i = iValue;
261 pRec->flags |= MEM_Int;
262 }else{
drh74eaba42014-09-18 17:52:15 +0000263 pRec->u.r = rValue;
drh975b4c62014-07-26 16:47:23 +0000264 pRec->flags |= MEM_Real;
drhbd9507c2014-08-23 17:21:37 +0000265 if( bTryForInt ) sqlite3VdbeIntegerAffinity(pRec);
drh29d72102006-02-09 22:13:41 +0000266 }
267}
268
269/*
drh8a512562005-11-14 22:29:05 +0000270** Processing is determine by the affinity parameter:
danielk19773d1bfea2004-05-14 11:00:53 +0000271**
drh8a512562005-11-14 22:29:05 +0000272** SQLITE_AFF_INTEGER:
273** SQLITE_AFF_REAL:
274** SQLITE_AFF_NUMERIC:
275** Try to convert pRec to an integer representation or a
276** floating-point representation if an integer representation
277** is not possible. Note that the integer representation is
278** always preferred, even if the affinity is REAL, because
279** an integer representation is more space efficient on disk.
280**
281** SQLITE_AFF_TEXT:
282** Convert pRec to a text representation.
283**
drh05883a32015-06-02 15:32:08 +0000284** SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000285** No-op. pRec is unchanged.
danielk19773d1bfea2004-05-14 11:00:53 +0000286*/
drh17435752007-08-16 04:30:38 +0000287static void applyAffinity(
drh17435752007-08-16 04:30:38 +0000288 Mem *pRec, /* The value to apply affinity to */
289 char affinity, /* The affinity to be applied */
290 u8 enc /* Use this text encoding */
291){
drh7ea31cc2014-09-18 14:36:00 +0000292 if( affinity>=SQLITE_AFF_NUMERIC ){
drh8a512562005-11-14 22:29:05 +0000293 assert( affinity==SQLITE_AFF_INTEGER || affinity==SQLITE_AFF_REAL
294 || affinity==SQLITE_AFF_NUMERIC );
drha3fa1402016-04-29 02:55:05 +0000295 if( (pRec->flags & MEM_Int)==0 ){ /*OPTIMIZATION-IF-FALSE*/
drhbd9507c2014-08-23 17:21:37 +0000296 if( (pRec->flags & MEM_Real)==0 ){
drh11a6eee2014-09-19 22:01:54 +0000297 if( pRec->flags & MEM_Str ) applyNumericAffinity(pRec,1);
drhbd9507c2014-08-23 17:21:37 +0000298 }else{
299 sqlite3VdbeIntegerAffinity(pRec);
300 }
drh17c40292004-07-21 02:53:29 +0000301 }
drh7ea31cc2014-09-18 14:36:00 +0000302 }else if( affinity==SQLITE_AFF_TEXT ){
danielk19773d1bfea2004-05-14 11:00:53 +0000303 /* Only attempt the conversion to TEXT if there is an integer or real
drhf4479502004-05-27 03:12:53 +0000304 ** representation (blob and NULL do not get converted) but no string
drha3fa1402016-04-29 02:55:05 +0000305 ** representation. It would be harmless to repeat the conversion if
306 ** there is already a string rep, but it is pointless to waste those
307 ** CPU cycles. */
308 if( 0==(pRec->flags&MEM_Str) ){ /*OPTIMIZATION-IF-FALSE*/
309 if( (pRec->flags&(MEM_Real|MEM_Int)) ){
310 sqlite3VdbeMemStringify(pRec, enc, 1);
311 }
danielk19773d1bfea2004-05-14 11:00:53 +0000312 }
dandde548c2015-05-19 19:44:25 +0000313 pRec->flags &= ~(MEM_Real|MEM_Int);
danielk19773d1bfea2004-05-14 11:00:53 +0000314 }
315}
316
danielk1977aee18ef2005-03-09 12:26:50 +0000317/*
drh29d72102006-02-09 22:13:41 +0000318** 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.
drh29d72102006-02-09 22:13:41 +0000322*/
323int sqlite3_value_numeric_type(sqlite3_value *pVal){
drh1b27b8c2014-02-10 03:21:57 +0000324 int eType = sqlite3_value_type(pVal);
325 if( eType==SQLITE_TEXT ){
326 Mem *pMem = (Mem*)pVal;
drhbd9507c2014-08-23 17:21:37 +0000327 applyNumericAffinity(pMem, 0);
drh1b27b8c2014-02-10 03:21:57 +0000328 eType = sqlite3_value_type(pVal);
drhe5a8a1d2010-11-18 12:31:24 +0000329 }
drh1b27b8c2014-02-10 03:21:57 +0000330 return eType;
drh29d72102006-02-09 22:13:41 +0000331}
332
333/*
danielk1977aee18ef2005-03-09 12:26:50 +0000334** Exported version of applyAffinity(). This one works on sqlite3_value*,
335** not the internal Mem* type.
336*/
danielk19771e536952007-08-16 10:09:01 +0000337void sqlite3ValueApplyAffinity(
danielk19771e536952007-08-16 10:09:01 +0000338 sqlite3_value *pVal,
339 u8 affinity,
340 u8 enc
341){
drhb21c8cd2007-08-21 19:33:56 +0000342 applyAffinity((Mem *)pVal, affinity, enc);
danielk1977aee18ef2005-03-09 12:26:50 +0000343}
344
drh3d1d90a2014-03-24 15:00:15 +0000345/*
drhf1a89ed2014-08-23 17:41:15 +0000346** 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
drh74eaba42014-09-18 17:52:15 +0000348** numeric type, if has one. Set the pMem->u.r and pMem->u.i fields
drhf1a89ed2014-08-23 17:41:15 +0000349** accordingly.
350*/
351static u16 SQLITE_NOINLINE computeNumericType(Mem *pMem){
352 assert( (pMem->flags & (MEM_Int|MEM_Real))==0 );
353 assert( (pMem->flags & (MEM_Str|MEM_Blob))!=0 );
drh74eaba42014-09-18 17:52:15 +0000354 if( sqlite3AtoF(pMem->z, &pMem->u.r, pMem->n, pMem->enc)==0 ){
drhf1a89ed2014-08-23 17:41:15 +0000355 return 0;
356 }
357 if( sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc)==SQLITE_OK ){
358 return MEM_Int;
359 }
360 return MEM_Real;
361}
362
363/*
drh3d1d90a2014-03-24 15:00:15 +0000364** Return the numeric type for pMem, either MEM_Int or MEM_Real or both or
365** none.
366**
367** Unlike applyNumericAffinity(), this routine does not modify pMem->flags.
drh74eaba42014-09-18 17:52:15 +0000368** But it does set pMem->u.r and pMem->u.i appropriately.
drh3d1d90a2014-03-24 15:00:15 +0000369*/
370static u16 numericType(Mem *pMem){
371 if( pMem->flags & (MEM_Int|MEM_Real) ){
372 return pMem->flags & (MEM_Int|MEM_Real);
373 }
374 if( pMem->flags & (MEM_Str|MEM_Blob) ){
drhf1a89ed2014-08-23 17:41:15 +0000375 return computeNumericType(pMem);
drh3d1d90a2014-03-24 15:00:15 +0000376 }
377 return 0;
378}
379
danielk1977b5402fb2005-01-12 07:15:04 +0000380#ifdef SQLITE_DEBUG
drhb6f54522004-05-20 02:42:16 +0000381/*
danielk1977ca6b2912004-05-21 10:49:47 +0000382** Write a nice string representation of the contents of cell pMem
383** into buffer zBuf, length nBuf.
384*/
drh74161702006-02-24 02:53:49 +0000385void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf){
danielk1977ca6b2912004-05-21 10:49:47 +0000386 char *zCsr = zBuf;
387 int f = pMem->flags;
388
drh57196282004-10-06 15:41:16 +0000389 static const char *const encnames[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
danielk1977bfd6cce2004-06-18 04:24:54 +0000390
danielk1977ca6b2912004-05-21 10:49:47 +0000391 if( f&MEM_Blob ){
392 int i;
393 char c;
394 if( f & MEM_Dyn ){
395 c = 'z';
396 assert( (f & (MEM_Static|MEM_Ephem))==0 );
397 }else if( f & MEM_Static ){
398 c = 't';
399 assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
400 }else if( f & MEM_Ephem ){
401 c = 'e';
402 assert( (f & (MEM_Static|MEM_Dyn))==0 );
403 }else{
404 c = 's';
405 }
drh85c2dc02017-03-16 13:30:58 +0000406 *(zCsr++) = c;
drh5bb3eb92007-05-04 13:15:55 +0000407 sqlite3_snprintf(100, zCsr, "%d[", pMem->n);
drhea678832008-12-10 19:26:22 +0000408 zCsr += sqlite3Strlen30(zCsr);
danielk1977ca6b2912004-05-21 10:49:47 +0000409 for(i=0; i<16 && i<pMem->n; i++){
drh5bb3eb92007-05-04 13:15:55 +0000410 sqlite3_snprintf(100, zCsr, "%02X", ((int)pMem->z[i] & 0xFF));
drhea678832008-12-10 19:26:22 +0000411 zCsr += sqlite3Strlen30(zCsr);
danielk1977ca6b2912004-05-21 10:49:47 +0000412 }
413 for(i=0; i<16 && i<pMem->n; i++){
414 char z = pMem->z[i];
415 if( z<32 || z>126 ) *zCsr++ = '.';
416 else *zCsr++ = z;
417 }
drh85c2dc02017-03-16 13:30:58 +0000418 *(zCsr++) = ']';
drhfdf972a2007-05-02 13:30:27 +0000419 if( f & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +0000420 sqlite3_snprintf(100, zCsr,"+%dz",pMem->u.nZero);
drhea678832008-12-10 19:26:22 +0000421 zCsr += sqlite3Strlen30(zCsr);
drhfdf972a2007-05-02 13:30:27 +0000422 }
danielk1977b1bc9532004-05-22 03:05:33 +0000423 *zCsr = '\0';
424 }else if( f & MEM_Str ){
425 int j, k;
426 zBuf[0] = ' ';
427 if( f & MEM_Dyn ){
428 zBuf[1] = 'z';
429 assert( (f & (MEM_Static|MEM_Ephem))==0 );
430 }else if( f & MEM_Static ){
431 zBuf[1] = 't';
432 assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
433 }else if( f & MEM_Ephem ){
434 zBuf[1] = 'e';
435 assert( (f & (MEM_Static|MEM_Dyn))==0 );
436 }else{
437 zBuf[1] = 's';
438 }
439 k = 2;
drh5bb3eb92007-05-04 13:15:55 +0000440 sqlite3_snprintf(100, &zBuf[k], "%d", pMem->n);
drhea678832008-12-10 19:26:22 +0000441 k += sqlite3Strlen30(&zBuf[k]);
danielk1977b1bc9532004-05-22 03:05:33 +0000442 zBuf[k++] = '[';
443 for(j=0; j<15 && j<pMem->n; j++){
444 u8 c = pMem->z[j];
danielk1977b1bc9532004-05-22 03:05:33 +0000445 if( c>=0x20 && c<0x7f ){
446 zBuf[k++] = c;
447 }else{
448 zBuf[k++] = '.';
449 }
450 }
451 zBuf[k++] = ']';
drh5bb3eb92007-05-04 13:15:55 +0000452 sqlite3_snprintf(100,&zBuf[k], encnames[pMem->enc]);
drhea678832008-12-10 19:26:22 +0000453 k += sqlite3Strlen30(&zBuf[k]);
danielk1977b1bc9532004-05-22 03:05:33 +0000454 zBuf[k++] = 0;
danielk1977ca6b2912004-05-21 10:49:47 +0000455 }
danielk1977ca6b2912004-05-21 10:49:47 +0000456}
457#endif
458
drh5b6afba2008-01-05 16:29:28 +0000459#ifdef SQLITE_DEBUG
460/*
461** Print the value of a register for tracing purposes:
462*/
drh84e55a82013-11-13 17:58:23 +0000463static void memTracePrint(Mem *p){
drha5750cf2014-02-07 13:20:31 +0000464 if( p->flags & MEM_Undefined ){
drh84e55a82013-11-13 17:58:23 +0000465 printf(" undefined");
drh953f7612012-12-07 22:18:54 +0000466 }else if( p->flags & MEM_Null ){
drh84e55a82013-11-13 17:58:23 +0000467 printf(" NULL");
drh5b6afba2008-01-05 16:29:28 +0000468 }else if( (p->flags & (MEM_Int|MEM_Str))==(MEM_Int|MEM_Str) ){
drh84e55a82013-11-13 17:58:23 +0000469 printf(" si:%lld", p->u.i);
drh5b6afba2008-01-05 16:29:28 +0000470 }else if( p->flags & MEM_Int ){
drh84e55a82013-11-13 17:58:23 +0000471 printf(" i:%lld", p->u.i);
drh0b3bf922009-06-15 20:45:34 +0000472#ifndef SQLITE_OMIT_FLOATING_POINT
drh5b6afba2008-01-05 16:29:28 +0000473 }else if( p->flags & MEM_Real ){
drh74eaba42014-09-18 17:52:15 +0000474 printf(" r:%g", p->u.r);
drh0b3bf922009-06-15 20:45:34 +0000475#endif
drh733bf1b2009-04-22 00:47:00 +0000476 }else if( p->flags & MEM_RowSet ){
drh84e55a82013-11-13 17:58:23 +0000477 printf(" (rowset)");
drh5b6afba2008-01-05 16:29:28 +0000478 }else{
479 char zBuf[200];
480 sqlite3VdbeMemPrettyPrint(p, zBuf);
drh84e55a82013-11-13 17:58:23 +0000481 printf(" %s", zBuf);
drh5b6afba2008-01-05 16:29:28 +0000482 }
dan5b6c8e42016-01-30 15:46:03 +0000483 if( p->flags & MEM_Subtype ) printf(" subtype=0x%02x", p->eSubtype);
drh5b6afba2008-01-05 16:29:28 +0000484}
drh84e55a82013-11-13 17:58:23 +0000485static void registerTrace(int iReg, Mem *p){
486 printf("REG[%d] = ", iReg);
487 memTracePrint(p);
488 printf("\n");
drhe2bc6552017-04-17 20:50:34 +0000489 sqlite3VdbeCheckMemInvariants(p);
drh5b6afba2008-01-05 16:29:28 +0000490}
491#endif
492
493#ifdef SQLITE_DEBUG
drh84e55a82013-11-13 17:58:23 +0000494# define REGISTER_TRACE(R,M) if(db->flags&SQLITE_VdbeTrace)registerTrace(R,M)
drh5b6afba2008-01-05 16:29:28 +0000495#else
496# define REGISTER_TRACE(R,M)
497#endif
498
danielk197784ac9d02004-05-18 09:58:06 +0000499
drh7b396862003-01-01 23:06:20 +0000500#ifdef VDBE_PROFILE
shane9bcbdad2008-05-29 20:22:37 +0000501
502/*
503** hwtime.h contains inline assembler code for implementing
504** high-performance timing routines.
drh7b396862003-01-01 23:06:20 +0000505*/
shane9bcbdad2008-05-29 20:22:37 +0000506#include "hwtime.h"
507
drh7b396862003-01-01 23:06:20 +0000508#endif
509
danielk1977fd7f0452008-12-17 17:30:26 +0000510#ifndef NDEBUG
511/*
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.
516**
517** Usage:
518**
519** assert( checkSavepointCount(db) );
520*/
521static int checkSavepointCount(sqlite3 *db){
522 int n = 0;
523 Savepoint *p;
524 for(p=db->pSavepoint; p; p=p->pNext) n++;
525 assert( n==(db->nSavepoint + db->isTransactionSavepoint) );
526 return 1;
527}
528#endif
529
drh27a348c2015-04-13 19:14:06 +0000530/*
531** Return the register of pOp->p2 after first preparing it to be
532** overwritten with an integer value.
drh9eef8c62015-10-15 17:31:41 +0000533*/
534static SQLITE_NOINLINE Mem *out2PrereleaseWithClear(Mem *pOut){
535 sqlite3VdbeMemSetNull(pOut);
536 pOut->flags = MEM_Int;
537 return pOut;
538}
drh27a348c2015-04-13 19:14:06 +0000539static Mem *out2Prerelease(Vdbe *p, VdbeOp *pOp){
540 Mem *pOut;
541 assert( pOp->p2>0 );
drh9f6168b2016-03-19 23:32:58 +0000542 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
drh27a348c2015-04-13 19:14:06 +0000543 pOut = &p->aMem[pOp->p2];
544 memAboutToChange(p, pOut);
drha3fa1402016-04-29 02:55:05 +0000545 if( VdbeMemDynamic(pOut) ){ /*OPTIMIZATION-IF-FALSE*/
drh9eef8c62015-10-15 17:31:41 +0000546 return out2PrereleaseWithClear(pOut);
547 }else{
548 pOut->flags = MEM_Int;
549 return pOut;
550 }
drh27a348c2015-04-13 19:14:06 +0000551}
552
drhb9755982010-07-24 16:34:37 +0000553
554/*
drh0fd61352014-02-07 02:29:45 +0000555** Execute as much of a VDBE program as we can.
556** This is the core of sqlite3_step().
drhb86ccfb2003-01-28 23:13:10 +0000557*/
danielk19774adee202004-05-08 08:23:19 +0000558int sqlite3VdbeExec(
drhb86ccfb2003-01-28 23:13:10 +0000559 Vdbe *p /* The VDBE */
560){
drhbbe879d2009-11-14 18:04:35 +0000561 Op *aOp = p->aOp; /* Copy of p->aOp */
mistachkin5f7b95f2017-02-01 23:03:54 +0000562 Op *pOp = aOp; /* Current operation */
drh6dc41482015-04-16 17:31:02 +0000563#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
564 Op *pOrigOp; /* Value of pOp at the top of the loop */
565#endif
drhb89aeb62016-01-27 15:49:32 +0000566#ifdef SQLITE_DEBUG
drhdef19e32016-01-27 16:26:25 +0000567 int nExtraDelete = 0; /* Verifies FORDELETE and AUXDELETE flags */
drhb89aeb62016-01-27 15:49:32 +0000568#endif
drhb86ccfb2003-01-28 23:13:10 +0000569 int rc = SQLITE_OK; /* Value to return */
drh9bb575f2004-09-06 17:24:11 +0000570 sqlite3 *db = p->db; /* The database */
drhcdf011d2011-04-04 21:25:28 +0000571 u8 resetSchemaOnFault = 0; /* Reset schema after an error if positive */
drh8079a0d2006-01-12 17:20:50 +0000572 u8 encoding = ENC(db); /* The database encoding */
drh0f825a72016-08-13 14:17:02 +0000573 int iCompare = 0; /* Result of last comparison */
drhbf159fa2013-06-25 22:01:22 +0000574 unsigned nVmStep = 0; /* Number of virtual machine steps */
drh49afe3a2013-07-10 03:05:14 +0000575#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
drh2ab792e2017-05-30 18:34:07 +0000576 unsigned nProgressLimit; /* Invoke xProgress() when nVmStep reaches this */
drh49afe3a2013-07-10 03:05:14 +0000577#endif
drha6c2ed92009-11-14 23:22:23 +0000578 Mem *aMem = p->aMem; /* Copy of p->aMem */
drhb27b7f52008-12-10 18:03:45 +0000579 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 */
drhb86ccfb2003-01-28 23:13:10 +0000583#ifdef VDBE_PROFILE
shane9bcbdad2008-05-29 20:22:37 +0000584 u64 start; /* CPU clock count at start of opcode */
drhb86ccfb2003-01-28 23:13:10 +0000585#endif
drh856c1032009-06-02 15:21:42 +0000586 /*** INSERT STACK UNION HERE ***/
drhe63d9992008-08-13 19:11:48 +0000587
drhca48c902008-01-18 14:08:24 +0000588 assert( p->magic==VDBE_MAGIC_RUN ); /* sqlite3_step() verifies this */
drhbdaec522011-04-04 00:14:43 +0000589 sqlite3VdbeEnter(p);
danielk19772e588c72005-12-09 14:25:08 +0000590 if( p->rc==SQLITE_NOMEM ){
591 /* This happens if a malloc() inside a call to sqlite3_column_text() or
592 ** sqlite3_column_text16() failed. */
593 goto no_mem;
594 }
drhcbd8db32015-08-20 17:18:32 +0000595 assert( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_BUSY );
drh1713afb2013-06-28 01:24:57 +0000596 assert( p->bIsReader || p->readOnly!=0 );
drh95a7b3e2013-09-16 12:57:19 +0000597 p->iCurrentTime = 0;
drhb86ccfb2003-01-28 23:13:10 +0000598 assert( p->explain==0 );
drhd4e70eb2008-01-02 00:34:36 +0000599 p->pResultSet = 0;
drha4afb652005-07-09 02:16:02 +0000600 db->busyHandler.nBusy = 0;
drh0fd61352014-02-07 02:29:45 +0000601 if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
drh602c2372007-03-01 00:29:13 +0000602 sqlite3VdbeIOTraceSql(p);
drh0d1961e2013-07-25 16:27:51 +0000603#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
604 if( db->xProgress ){
drh6cbbdb02015-06-24 14:36:27 +0000605 u32 iPrior = p->aCounter[SQLITE_STMTSTATUS_VM_STEP];
drh0d1961e2013-07-25 16:27:51 +0000606 assert( 0 < db->nProgressOps );
drh6cbbdb02015-06-24 14:36:27 +0000607 nProgressLimit = db->nProgressOps - (iPrior % db->nProgressOps);
drh2ab792e2017-05-30 18:34:07 +0000608 }else{
609 nProgressLimit = 0xffffffff;
drh0d1961e2013-07-25 16:27:51 +0000610 }
611#endif
drh3c23a882007-01-09 14:01:13 +0000612#ifdef SQLITE_DEBUG
danielk19772d1d86f2008-06-20 14:59:51 +0000613 sqlite3BeginBenignMalloc();
drh84e55a82013-11-13 17:58:23 +0000614 if( p->pc==0
615 && (p->db->flags & (SQLITE_VdbeListing|SQLITE_VdbeEQP|SQLITE_VdbeTrace))!=0
616 ){
drh3c23a882007-01-09 14:01:13 +0000617 int i;
drh84e55a82013-11-13 17:58:23 +0000618 int once = 1;
drh3c23a882007-01-09 14:01:13 +0000619 sqlite3VdbePrintSql(p);
drh84e55a82013-11-13 17:58:23 +0000620 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]);
624 }
drh3c23a882007-01-09 14:01:13 +0000625 }
drh84e55a82013-11-13 17:58:23 +0000626 if( p->db->flags & SQLITE_VdbeEQP ){
627 for(i=0; i<p->nOp; i++){
628 if( aOp[i].opcode==OP_Explain ){
629 if( once ) printf("VDBE Query Plan:\n");
630 printf("%s\n", aOp[i].p4.z);
631 once = 0;
632 }
633 }
634 }
635 if( p->db->flags & SQLITE_VdbeTrace ) printf("VDBE Trace:\n");
drh3c23a882007-01-09 14:01:13 +0000636 }
danielk19772d1d86f2008-06-20 14:59:51 +0000637 sqlite3EndBenignMalloc();
drh3c23a882007-01-09 14:01:13 +0000638#endif
drh9467abf2016-02-17 18:44:11 +0000639 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 );
643
drhf56fa462015-04-13 21:39:54 +0000644 assert( pOp>=aOp && pOp<&aOp[p->nOp]);
drh7b396862003-01-01 23:06:20 +0000645#ifdef VDBE_PROFILE
shane9bcbdad2008-05-29 20:22:37 +0000646 start = sqlite3Hwtime();
drh7b396862003-01-01 23:06:20 +0000647#endif
drhbf159fa2013-06-25 22:01:22 +0000648 nVmStep++;
dan6f9702e2014-11-01 20:38:06 +0000649#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drhf56fa462015-04-13 21:39:54 +0000650 if( p->anExec ) p->anExec[(int)(pOp-aOp)]++;
dan6f9702e2014-11-01 20:38:06 +0000651#endif
drh6e142f52000-06-08 13:36:40 +0000652
danielk19778b60e0f2005-01-12 09:10:39 +0000653 /* Only allow tracing if SQLITE_DEBUG is defined.
drh6e142f52000-06-08 13:36:40 +0000654 */
danielk19778b60e0f2005-01-12 09:10:39 +0000655#ifdef SQLITE_DEBUG
drh84e55a82013-11-13 17:58:23 +0000656 if( db->flags & SQLITE_VdbeTrace ){
drhf56fa462015-04-13 21:39:54 +0000657 sqlite3VdbePrintOp(stdout, (int)(pOp - aOp), pOp);
drh75897232000-05-29 14:26:00 +0000658 }
drh3f7d4e42004-07-24 14:35:58 +0000659#endif
660
drh6e142f52000-06-08 13:36:40 +0000661
drhf6038712004-02-08 18:07:34 +0000662 /* Check to see if we need to simulate an interrupt. This only happens
663 ** if we have a special test build.
664 */
665#ifdef SQLITE_TEST
danielk19776f8a5032004-05-10 10:34:51 +0000666 if( sqlite3_interrupt_count>0 ){
667 sqlite3_interrupt_count--;
668 if( sqlite3_interrupt_count==0 ){
669 sqlite3_interrupt(db);
drhf6038712004-02-08 18:07:34 +0000670 }
671 }
672#endif
673
drh3c657212009-11-17 23:59:58 +0000674 /* Sanity checking on other operands */
675#ifdef SQLITE_DEBUG
drh7cc84c22016-04-11 13:36:42 +0000676 {
677 u8 opProperty = sqlite3OpcodeProperty[pOp->opcode];
678 if( (opProperty & OPFLG_IN1)!=0 ){
679 assert( pOp->p1>0 );
680 assert( pOp->p1<=(p->nMem+1 - p->nCursor) );
681 assert( memIsValid(&aMem[pOp->p1]) );
682 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p1]) );
683 REGISTER_TRACE(pOp->p1, &aMem[pOp->p1]);
684 }
685 if( (opProperty & OPFLG_IN2)!=0 ){
686 assert( pOp->p2>0 );
687 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
688 assert( memIsValid(&aMem[pOp->p2]) );
689 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p2]) );
690 REGISTER_TRACE(pOp->p2, &aMem[pOp->p2]);
691 }
692 if( (opProperty & OPFLG_IN3)!=0 ){
693 assert( pOp->p3>0 );
694 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
695 assert( memIsValid(&aMem[pOp->p3]) );
696 assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p3]) );
697 REGISTER_TRACE(pOp->p3, &aMem[pOp->p3]);
698 }
699 if( (opProperty & OPFLG_OUT2)!=0 ){
700 assert( pOp->p2>0 );
701 assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
702 memAboutToChange(p, &aMem[pOp->p2]);
703 }
704 if( (opProperty & OPFLG_OUT3)!=0 ){
705 assert( pOp->p3>0 );
706 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
707 memAboutToChange(p, &aMem[pOp->p3]);
708 }
drh3c657212009-11-17 23:59:58 +0000709 }
710#endif
drh6dc41482015-04-16 17:31:02 +0000711#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
712 pOrigOp = pOp;
713#endif
drh93952eb2009-11-13 19:43:43 +0000714
drh75897232000-05-29 14:26:00 +0000715 switch( pOp->opcode ){
drh75897232000-05-29 14:26:00 +0000716
drh5e00f6c2001-09-13 13:46:56 +0000717/*****************************************************************************
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.
drhac82fcf2002-09-08 17:23:41 +0000725**
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
drhf2bc0132004-10-04 13:19:23 +0000731** 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.
drhac82fcf2002-09-08 17:23:41 +0000734**
drh9cbf3422008-01-17 16:22:13 +0000735** Other keywords in the comment that follows each case are used to
736** construct the OPFLG_INITIALIZER value that initializes opcodeProperty[].
drh27a348c2015-04-13 19:14:06 +0000737** Keywords include: in1, in2, in3, out2, out3. See
drh9cbf3422008-01-17 16:22:13 +0000738** the mkopcodeh.awk script for additional information.
danielk1977bc04f852005-03-29 08:26:13 +0000739**
drhac82fcf2002-09-08 17:23:41 +0000740** Documentation about VDBE opcodes is generated by scanning this file
741** for lines of that contain "Opcode:". That line and all subsequent
742** comment lines are used in the generation of the opcode.html documentation
743** file.
744**
745** SUMMARY:
746**
747** Formatting is important to scripts that scan this file.
748** Do not deviate from the formatting style currently in use.
749**
drh5e00f6c2001-09-13 13:46:56 +0000750*****************************************************************************/
drh75897232000-05-29 14:26:00 +0000751
drh9cbf3422008-01-17 16:22:13 +0000752/* Opcode: Goto * P2 * * *
drh5e00f6c2001-09-13 13:46:56 +0000753**
754** An unconditional jump to address P2.
755** The next instruction executed will be
756** the one at index P2 from the beginning of
757** the program.
drhfe705102014-03-06 13:38:37 +0000758**
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.
drh5e00f6c2001-09-13 13:46:56 +0000763*/
drh9cbf3422008-01-17 16:22:13 +0000764case OP_Goto: { /* jump */
drhf56fa462015-04-13 21:39:54 +0000765jump_to_p2_and_check_for_interrupt:
766 pOp = &aOp[pOp->p2 - 1];
drh49afe3a2013-07-10 03:05:14 +0000767
768 /* Opcodes that are used as the bottom of a loop (OP_Next, OP_Prev,
drhbb6783b2017-04-29 18:02:49 +0000769 ** OP_VNext, or OP_SorterNext) all jump here upon
drh49afe3a2013-07-10 03:05:14 +0000770 ** completion. Check to see if sqlite3_interrupt() has been called
771 ** or if the progress callback needs to be invoked.
772 **
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" */
778check_for_interrupt:
drh0fd61352014-02-07 02:29:45 +0000779 if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
drh49afe3a2013-07-10 03:05:14 +0000780#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.
786 */
drh2ab792e2017-05-30 18:34:07 +0000787 if( nVmStep>=nProgressLimit && db->xProgress!=0 ){
drh400fcba2013-11-14 00:09:48 +0000788 assert( db->nProgressOps!=0 );
789 nProgressLimit = nVmStep + db->nProgressOps - (nVmStep%db->nProgressOps);
790 if( db->xProgress(db->pProgressArg) ){
drh49afe3a2013-07-10 03:05:14 +0000791 rc = SQLITE_INTERRUPT;
drh9467abf2016-02-17 18:44:11 +0000792 goto abort_due_to_error;
drh49afe3a2013-07-10 03:05:14 +0000793 }
drh49afe3a2013-07-10 03:05:14 +0000794 }
795#endif
796
drh5e00f6c2001-09-13 13:46:56 +0000797 break;
798}
drh75897232000-05-29 14:26:00 +0000799
drh2eb95372008-06-06 15:04:36 +0000800/* Opcode: Gosub P1 P2 * * *
drh8c74a8c2002-08-25 19:20:40 +0000801**
drh2eb95372008-06-06 15:04:36 +0000802** Write the current address onto register P1
drh8c74a8c2002-08-25 19:20:40 +0000803** and then jump to address P2.
drh8c74a8c2002-08-25 19:20:40 +0000804*/
drhb8475df2011-12-09 16:21:19 +0000805case OP_Gosub: { /* jump */
drh9f6168b2016-03-19 23:32:58 +0000806 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
drh3c657212009-11-17 23:59:58 +0000807 pIn1 = &aMem[pOp->p1];
drhc91b2fd2014-03-01 18:13:23 +0000808 assert( VdbeMemDynamic(pIn1)==0 );
drh2b4ded92010-09-27 21:09:31 +0000809 memAboutToChange(p, pIn1);
drh2eb95372008-06-06 15:04:36 +0000810 pIn1->flags = MEM_Int;
drhf56fa462015-04-13 21:39:54 +0000811 pIn1->u.i = (int)(pOp-aOp);
drh2eb95372008-06-06 15:04:36 +0000812 REGISTER_TRACE(pOp->p1, pIn1);
drhf56fa462015-04-13 21:39:54 +0000813
814 /* Most jump operations do a goto to this spot in order to update
815 ** the pOp pointer. */
816jump_to_p2:
817 pOp = &aOp[pOp->p2 - 1];
drh8c74a8c2002-08-25 19:20:40 +0000818 break;
819}
820
drh2eb95372008-06-06 15:04:36 +0000821/* Opcode: Return P1 * * * *
drh8c74a8c2002-08-25 19:20:40 +0000822**
drh81cf13e2014-02-07 18:27:53 +0000823** Jump to the next instruction after the address in register P1. After
824** the jump, register P1 becomes undefined.
drh8c74a8c2002-08-25 19:20:40 +0000825*/
drh2eb95372008-06-06 15:04:36 +0000826case OP_Return: { /* in1 */
drh3c657212009-11-17 23:59:58 +0000827 pIn1 = &aMem[pOp->p1];
drh81cf13e2014-02-07 18:27:53 +0000828 assert( pIn1->flags==MEM_Int );
drhf56fa462015-04-13 21:39:54 +0000829 pOp = &aOp[pIn1->u.i];
drh81cf13e2014-02-07 18:27:53 +0000830 pIn1->flags = MEM_Undefined;
drh8c74a8c2002-08-25 19:20:40 +0000831 break;
832}
833
drhed71a832014-02-07 19:18:10 +0000834/* Opcode: InitCoroutine P1 P2 P3 * *
drh81cf13e2014-02-07 18:27:53 +0000835**
drh5dad9a32014-07-25 18:37:42 +0000836** Set up register P1 so that it will Yield to the coroutine
drhed71a832014-02-07 19:18:10 +0000837** located at address P3.
838**
drh5dad9a32014-07-25 18:37:42 +0000839** If P2!=0 then the coroutine implementation immediately follows
840** this opcode. So jump over the coroutine implementation to
drhed71a832014-02-07 19:18:10 +0000841** address P2.
drh5dad9a32014-07-25 18:37:42 +0000842**
843** See also: EndCoroutine
drh81cf13e2014-02-07 18:27:53 +0000844*/
845case OP_InitCoroutine: { /* jump */
drh9f6168b2016-03-19 23:32:58 +0000846 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
drhed71a832014-02-07 19:18:10 +0000847 assert( pOp->p2>=0 && pOp->p2<p->nOp );
848 assert( pOp->p3>=0 && pOp->p3<p->nOp );
drh81cf13e2014-02-07 18:27:53 +0000849 pOut = &aMem[pOp->p1];
drhed71a832014-02-07 19:18:10 +0000850 assert( !VdbeMemDynamic(pOut) );
851 pOut->u.i = pOp->p3 - 1;
drh81cf13e2014-02-07 18:27:53 +0000852 pOut->flags = MEM_Int;
drhf56fa462015-04-13 21:39:54 +0000853 if( pOp->p2 ) goto jump_to_p2;
drh81cf13e2014-02-07 18:27:53 +0000854 break;
855}
856
857/* Opcode: EndCoroutine P1 * * * *
858**
drhbc5cf382014-08-06 01:08:07 +0000859** The instruction at the address in register P1 is a Yield.
drh5dad9a32014-07-25 18:37:42 +0000860** Jump to the P2 parameter of that Yield.
drh81cf13e2014-02-07 18:27:53 +0000861** After the jump, register P1 becomes undefined.
drh5dad9a32014-07-25 18:37:42 +0000862**
863** See also: InitCoroutine
drh81cf13e2014-02-07 18:27:53 +0000864*/
865case OP_EndCoroutine: { /* in1 */
866 VdbeOp *pCaller;
867 pIn1 = &aMem[pOp->p1];
868 assert( pIn1->flags==MEM_Int );
869 assert( pIn1->u.i>=0 && pIn1->u.i<p->nOp );
870 pCaller = &aOp[pIn1->u.i];
871 assert( pCaller->opcode==OP_Yield );
872 assert( pCaller->p2>=0 && pCaller->p2<p->nOp );
drhf56fa462015-04-13 21:39:54 +0000873 pOp = &aOp[pCaller->p2 - 1];
drh81cf13e2014-02-07 18:27:53 +0000874 pIn1->flags = MEM_Undefined;
875 break;
876}
877
878/* Opcode: Yield P1 P2 * * *
drhe00ee6e2008-06-20 15:24:01 +0000879**
drh5dad9a32014-07-25 18:37:42 +0000880** Swap the program counter with the value in register P1. This
881** has the effect of yielding to a coroutine.
drh81cf13e2014-02-07 18:27:53 +0000882**
drh5dad9a32014-07-25 18:37:42 +0000883** If the coroutine that is launched by this instruction ends with
884** Yield or Return then continue to the next instruction. But if
885** the coroutine launched by this instruction ends with
886** EndCoroutine, then jump to P2 rather than continuing with the
887** next instruction.
888**
889** See also: InitCoroutine
drhe00ee6e2008-06-20 15:24:01 +0000890*/
drh81cf13e2014-02-07 18:27:53 +0000891case OP_Yield: { /* in1, jump */
drhe00ee6e2008-06-20 15:24:01 +0000892 int pcDest;
drh3c657212009-11-17 23:59:58 +0000893 pIn1 = &aMem[pOp->p1];
drhc91b2fd2014-03-01 18:13:23 +0000894 assert( VdbeMemDynamic(pIn1)==0 );
drhe00ee6e2008-06-20 15:24:01 +0000895 pIn1->flags = MEM_Int;
drh9c1905f2008-12-10 22:32:56 +0000896 pcDest = (int)pIn1->u.i;
drhf56fa462015-04-13 21:39:54 +0000897 pIn1->u.i = (int)(pOp - aOp);
drhe00ee6e2008-06-20 15:24:01 +0000898 REGISTER_TRACE(pOp->p1, pIn1);
drhf56fa462015-04-13 21:39:54 +0000899 pOp = &aOp[pcDest];
drhe00ee6e2008-06-20 15:24:01 +0000900 break;
901}
902
drhf9c8ce32013-11-05 13:33:55 +0000903/* Opcode: HaltIfNull P1 P2 P3 P4 P5
drh72e26de2016-08-24 21:24:04 +0000904** Synopsis: if r[P3]=null halt
drh5053a792009-02-20 03:02:23 +0000905**
drhef8662b2011-06-20 21:47:58 +0000906** Check the value in register P3. If it is NULL then Halt using
drh5053a792009-02-20 03:02:23 +0000907** 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.
drhf9c8ce32013-11-05 13:33:55 +0000909** The P5 parameter should be 1.
drh5053a792009-02-20 03:02:23 +0000910*/
911case OP_HaltIfNull: { /* in3 */
drh3c657212009-11-17 23:59:58 +0000912 pIn3 = &aMem[pOp->p3];
drh5053a792009-02-20 03:02:23 +0000913 if( (pIn3->flags & MEM_Null)==0 ) break;
914 /* Fall through into OP_Halt */
915}
drhe00ee6e2008-06-20 15:24:01 +0000916
drhf9c8ce32013-11-05 13:33:55 +0000917/* Opcode: Halt P1 P2 * P4 P5
drh5e00f6c2001-09-13 13:46:56 +0000918**
drh3d4501e2008-12-04 20:40:10 +0000919** Exit immediately. All open cursors, etc are closed
drh5e00f6c2001-09-13 13:46:56 +0000920** automatically.
drhb19a2bc2001-09-16 00:13:26 +0000921**
drh92f02c32004-09-02 14:57:08 +0000922** 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
drhb798fa62002-09-03 19:43:23 +0000928** VDBE, but do not rollback the transaction.
drh9cfcf5d2002-01-29 18:41:24 +0000929**
drh66a51672008-01-03 00:01:23 +0000930** If P4 is not null then it is an error message string.
drh7f057c92005-06-24 03:53:06 +0000931**
drhf9c8ce32013-11-05 13:33:55 +0000932** P5 is a value between 0 and 4, inclusive, that modifies the P4 string.
933**
934** 0: (no change)
935** 1: NOT NULL contraint failed: P4
936** 2: UNIQUE constraint failed: P4
937** 3: CHECK constraint failed: P4
938** 4: FOREIGN KEY constraint failed: P4
939**
940** If P5 is not zero and P4 is NULL, then everything after the ":" is
941** omitted.
942**
drh9cfcf5d2002-01-29 18:41:24 +0000943** There is an implied "Halt 0 0 0" instruction inserted at the very end of
drhb19a2bc2001-09-16 00:13:26 +0000944** every program. So a jump past the last instruction of the program
945** is the same as executing Halt.
drh5e00f6c2001-09-13 13:46:56 +0000946*/
drh9cbf3422008-01-17 16:22:13 +0000947case OP_Halt: {
drhf56fa462015-04-13 21:39:54 +0000948 VdbeFrame *pFrame;
949 int pcx;
drhf9c8ce32013-11-05 13:33:55 +0000950
drhf56fa462015-04-13 21:39:54 +0000951 pcx = (int)(pOp - aOp);
dan165921a2009-08-28 18:53:45 +0000952 if( pOp->p1==SQLITE_OK && p->pFrame ){
dan2832ad42009-08-31 15:27:27 +0000953 /* Halt the sub-program. Return control to the parent frame. */
drhf56fa462015-04-13 21:39:54 +0000954 pFrame = p->pFrame;
dan165921a2009-08-28 18:53:45 +0000955 p->pFrame = pFrame->pParent;
956 p->nFrame--;
dan2832ad42009-08-31 15:27:27 +0000957 sqlite3VdbeSetChanges(db, p->nChange);
drhf56fa462015-04-13 21:39:54 +0000958 pcx = sqlite3VdbeFrameRestore(pFrame);
dan165921a2009-08-28 18:53:45 +0000959 if( pOp->p2==OE_Ignore ){
drhf56fa462015-04-13 21:39:54 +0000960 /* Instruction pcx is the OP_Program that invoked the sub-program
dan2832ad42009-08-31 15:27:27 +0000961 ** 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. */
drhf56fa462015-04-13 21:39:54 +0000965 pcx = p->aOp[pcx].p2-1;
dan165921a2009-08-28 18:53:45 +0000966 }
drhbbe879d2009-11-14 18:04:35 +0000967 aOp = p->aOp;
drha6c2ed92009-11-14 23:22:23 +0000968 aMem = p->aMem;
drhf56fa462015-04-13 21:39:54 +0000969 pOp = &aOp[pcx];
dan165921a2009-08-28 18:53:45 +0000970 break;
971 }
drh92f02c32004-09-02 14:57:08 +0000972 p->rc = pOp->p1;
shane36840fd2009-06-26 16:32:13 +0000973 p->errorAction = (u8)pOp->p2;
drhf56fa462015-04-13 21:39:54 +0000974 p->pc = pcx;
drhfb4e3a32016-12-30 00:09:14 +0000975 assert( pOp->p5<=4 );
drhf9c8ce32013-11-05 13:33:55 +0000976 if( p->rc ){
drhd9b7ec92013-11-06 14:05:21 +0000977 if( pOp->p5 ){
978 static const char * const azType[] = { "NOT NULL", "UNIQUE", "CHECK",
979 "FOREIGN KEY" };
drhd9b7ec92013-11-06 14:05:21 +0000980 testcase( pOp->p5==1 );
981 testcase( pOp->p5==2 );
982 testcase( pOp->p5==3 );
983 testcase( pOp->p5==4 );
drh99f5de72016-04-30 02:59:15 +0000984 sqlite3VdbeError(p, "%s constraint failed", azType[pOp->p5-1]);
985 if( pOp->p4.z ){
986 p->zErrMsg = sqlite3MPrintf(db, "%z: %s", p->zErrMsg, pOp->p4.z);
987 }
drhd9b7ec92013-11-06 14:05:21 +0000988 }else{
drh22c17b82015-05-15 04:13:15 +0000989 sqlite3VdbeError(p, "%s", pOp->p4.z);
drhf9c8ce32013-11-05 13:33:55 +0000990 }
drh99f5de72016-04-30 02:59:15 +0000991 sqlite3_log(pOp->p1, "abort at %d in [%s]: %s", pcx, p->zSql, p->zErrMsg);
drh9cfcf5d2002-01-29 18:41:24 +0000992 }
drh92f02c32004-09-02 14:57:08 +0000993 rc = sqlite3VdbeHalt(p);
dan1da40a32009-09-19 17:00:31 +0000994 assert( rc==SQLITE_BUSY || rc==SQLITE_OK || rc==SQLITE_ERROR );
drh92f02c32004-09-02 14:57:08 +0000995 if( rc==SQLITE_BUSY ){
drh99f5de72016-04-30 02:59:15 +0000996 p->rc = SQLITE_BUSY;
drh900b31e2007-08-28 02:27:51 +0000997 }else{
drhd91c1a12013-02-09 13:58:25 +0000998 assert( rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT );
dancb3e4b72013-07-03 19:53:05 +0000999 assert( rc==SQLITE_OK || db->nDeferredCons>0 || db->nDeferredImmCons>0 );
drh900b31e2007-08-28 02:27:51 +00001000 rc = p->rc ? SQLITE_ERROR : SQLITE_DONE;
drh92f02c32004-09-02 14:57:08 +00001001 }
drh900b31e2007-08-28 02:27:51 +00001002 goto vdbe_return;
drh5e00f6c2001-09-13 13:46:56 +00001003}
drhc61053b2000-06-04 12:58:36 +00001004
drh4c583122008-01-04 22:01:03 +00001005/* Opcode: Integer P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00001006** Synopsis: r[P2]=P1
drh5e00f6c2001-09-13 13:46:56 +00001007**
drh9cbf3422008-01-17 16:22:13 +00001008** The 32-bit integer value P1 is written into register P2.
drh5e00f6c2001-09-13 13:46:56 +00001009*/
drh27a348c2015-04-13 19:14:06 +00001010case OP_Integer: { /* out2 */
1011 pOut = out2Prerelease(p, pOp);
drh4c583122008-01-04 22:01:03 +00001012 pOut->u.i = pOp->p1;
drh29dda4a2005-07-21 18:23:20 +00001013 break;
1014}
1015
drh4c583122008-01-04 22:01:03 +00001016/* Opcode: Int64 * P2 * P4 *
drh81316f82013-10-29 20:40:47 +00001017** Synopsis: r[P2]=P4
drh29dda4a2005-07-21 18:23:20 +00001018**
drh66a51672008-01-03 00:01:23 +00001019** P4 is a pointer to a 64-bit integer value.
drh9cbf3422008-01-17 16:22:13 +00001020** Write that value into register P2.
drh29dda4a2005-07-21 18:23:20 +00001021*/
drh27a348c2015-04-13 19:14:06 +00001022case OP_Int64: { /* out2 */
1023 pOut = out2Prerelease(p, pOp);
danielk19772dca4ac2008-01-03 11:50:29 +00001024 assert( pOp->p4.pI64!=0 );
drh4c583122008-01-04 22:01:03 +00001025 pOut->u.i = *pOp->p4.pI64;
drhf4479502004-05-27 03:12:53 +00001026 break;
1027}
drh4f26d6c2004-05-26 23:25:30 +00001028
drh13573c72010-01-12 17:04:07 +00001029#ifndef SQLITE_OMIT_FLOATING_POINT
drh4c583122008-01-04 22:01:03 +00001030/* Opcode: Real * P2 * P4 *
drh81316f82013-10-29 20:40:47 +00001031** Synopsis: r[P2]=P4
drhf4479502004-05-27 03:12:53 +00001032**
drh4c583122008-01-04 22:01:03 +00001033** P4 is a pointer to a 64-bit floating point value.
drh9cbf3422008-01-17 16:22:13 +00001034** Write that value into register P2.
drhf4479502004-05-27 03:12:53 +00001035*/
drh27a348c2015-04-13 19:14:06 +00001036case OP_Real: { /* same as TK_FLOAT, out2 */
1037 pOut = out2Prerelease(p, pOp);
drh4c583122008-01-04 22:01:03 +00001038 pOut->flags = MEM_Real;
drh2eaf93d2008-04-29 00:15:20 +00001039 assert( !sqlite3IsNaN(*pOp->p4.pReal) );
drh74eaba42014-09-18 17:52:15 +00001040 pOut->u.r = *pOp->p4.pReal;
drhf4479502004-05-27 03:12:53 +00001041 break;
1042}
drh13573c72010-01-12 17:04:07 +00001043#endif
danielk1977cbb18d22004-05-28 11:37:27 +00001044
drh3c84ddf2008-01-09 02:15:38 +00001045/* Opcode: String8 * P2 * P4 *
drh81316f82013-10-29 20:40:47 +00001046** Synopsis: r[P2]='P4'
danielk1977cbb18d22004-05-28 11:37:27 +00001047**
drh66a51672008-01-03 00:01:23 +00001048** P4 points to a nul terminated UTF-8 string. This opcode is transformed
drhf07cf6e2015-03-06 16:45:16 +00001049** into a String opcode before it is executed for the first time. During
drh0fd61352014-02-07 02:29:45 +00001050** this transformation, the length of string P4 is computed and stored
1051** as the P1 parameter.
danielk1977cbb18d22004-05-28 11:37:27 +00001052*/
drh27a348c2015-04-13 19:14:06 +00001053case OP_String8: { /* same as TK_STRING, out2 */
danielk19772dca4ac2008-01-03 11:50:29 +00001054 assert( pOp->p4.z!=0 );
drh27a348c2015-04-13 19:14:06 +00001055 pOut = out2Prerelease(p, pOp);
drhed2df7f2005-11-16 04:34:32 +00001056 pOp->opcode = OP_String;
drhea678832008-12-10 19:26:22 +00001057 pOp->p1 = sqlite3Strlen30(pOp->p4.z);
drhed2df7f2005-11-16 04:34:32 +00001058
1059#ifndef SQLITE_OMIT_UTF16
drh8079a0d2006-01-12 17:20:50 +00001060 if( encoding!=SQLITE_UTF8 ){
drh3a9cf172009-06-17 21:42:33 +00001061 rc = sqlite3VdbeMemSetStr(pOut, pOp->p4.z, -1, SQLITE_UTF8, SQLITE_STATIC);
drh2f555112016-04-30 18:10:34 +00001062 assert( rc==SQLITE_OK || rc==SQLITE_TOOBIG );
drh4c583122008-01-04 22:01:03 +00001063 if( SQLITE_OK!=sqlite3VdbeChangeEncoding(pOut, encoding) ) goto no_mem;
drh17bcb102014-09-18 21:25:33 +00001064 assert( pOut->szMalloc>0 && pOut->zMalloc==pOut->z );
drhc91b2fd2014-03-01 18:13:23 +00001065 assert( VdbeMemDynamic(pOut)==0 );
drh17bcb102014-09-18 21:25:33 +00001066 pOut->szMalloc = 0;
drh4c583122008-01-04 22:01:03 +00001067 pOut->flags |= MEM_Static;
drh66a51672008-01-03 00:01:23 +00001068 if( pOp->p4type==P4_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +00001069 sqlite3DbFree(db, pOp->p4.z);
danielk1977e0048402004-06-15 16:51:01 +00001070 }
drh66a51672008-01-03 00:01:23 +00001071 pOp->p4type = P4_DYNAMIC;
drh4c583122008-01-04 22:01:03 +00001072 pOp->p4.z = pOut->z;
1073 pOp->p1 = pOut->n;
danielk19770f69c1e2004-05-29 11:24:50 +00001074 }
drh2f555112016-04-30 18:10:34 +00001075 testcase( rc==SQLITE_TOOBIG );
danielk197793758c82005-01-21 08:13:14 +00001076#endif
drhbb4957f2008-03-20 14:03:29 +00001077 if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
drhcbd2da92007-12-17 16:20:06 +00001078 goto too_big;
1079 }
drh2f555112016-04-30 18:10:34 +00001080 assert( rc==SQLITE_OK );
drhcbd2da92007-12-17 16:20:06 +00001081 /* Fall through to the next case, OP_String */
danielk1977cbb18d22004-05-28 11:37:27 +00001082}
drhf4479502004-05-27 03:12:53 +00001083
drhf07cf6e2015-03-06 16:45:16 +00001084/* Opcode: String P1 P2 P3 P4 P5
drh81316f82013-10-29 20:40:47 +00001085** Synopsis: r[P2]='P4' (len=P1)
drhf4479502004-05-27 03:12:53 +00001086**
drh9cbf3422008-01-17 16:22:13 +00001087** The string value P4 of length P1 (bytes) is stored in register P2.
drhf07cf6e2015-03-06 16:45:16 +00001088**
drh44aebff2016-05-02 10:25:42 +00001089** If P3 is not zero and the content of register P3 is equal to P5, then
drha9c18a92015-03-06 20:49:52 +00001090** 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
drh44aebff2016-05-02 10:25:42 +00001092** of a string, as if it had been CAST. In other words:
1093**
1094** if( P3!=0 and reg[P3]==P5 ) reg[P2] := CAST(reg[P2] as BLOB)
drhf4479502004-05-27 03:12:53 +00001095*/
drh27a348c2015-04-13 19:14:06 +00001096case OP_String: { /* out2 */
danielk19772dca4ac2008-01-03 11:50:29 +00001097 assert( pOp->p4.z!=0 );
drh27a348c2015-04-13 19:14:06 +00001098 pOut = out2Prerelease(p, pOp);
drh4c583122008-01-04 22:01:03 +00001099 pOut->flags = MEM_Str|MEM_Static|MEM_Term;
1100 pOut->z = pOp->p4.z;
1101 pOut->n = pOp->p1;
1102 pOut->enc = encoding;
drhb7654112008-01-12 12:48:07 +00001103 UPDATE_MAX_BLOBSIZE(pOut);
drh41d2e662015-12-01 21:23:07 +00001104#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh44aebff2016-05-02 10:25:42 +00001105 if( pOp->p3>0 ){
drh9f6168b2016-03-19 23:32:58 +00001106 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
drhf07cf6e2015-03-06 16:45:16 +00001107 pIn3 = &aMem[pOp->p3];
1108 assert( pIn3->flags & MEM_Int );
drh44aebff2016-05-02 10:25:42 +00001109 if( pIn3->u.i==pOp->p5 ) pOut->flags = MEM_Blob|MEM_Static|MEM_Term;
drhf07cf6e2015-03-06 16:45:16 +00001110 }
drh41d2e662015-12-01 21:23:07 +00001111#endif
danielk1977c572ef72004-05-27 09:28:41 +00001112 break;
1113}
1114
drh053a1282012-09-19 21:15:46 +00001115/* Opcode: Null P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001116** Synopsis: r[P2..P3]=NULL
drhf0863fe2005-06-12 21:35:51 +00001117**
drhb8475df2011-12-09 16:21:19 +00001118** Write a NULL into registers P2. If P3 greater than P2, then also write
drh053a1282012-09-19 21:15:46 +00001119** NULL into register P3 and every register in between P2 and P3. If P3
drhb8475df2011-12-09 16:21:19 +00001120** is less than P2 (typically P3 is zero) then only register P2 is
drh053a1282012-09-19 21:15:46 +00001121** set to NULL.
1122**
1123** If the P1 value is non-zero, then also set the MEM_Cleared flag so that
1124** NULL values will not compare equal even if SQLITE_NULLEQ is set on
1125** OP_Ne or OP_Eq.
drhf0863fe2005-06-12 21:35:51 +00001126*/
drh27a348c2015-04-13 19:14:06 +00001127case OP_Null: { /* out2 */
drhb8475df2011-12-09 16:21:19 +00001128 int cnt;
drh053a1282012-09-19 21:15:46 +00001129 u16 nullFlag;
drh27a348c2015-04-13 19:14:06 +00001130 pOut = out2Prerelease(p, pOp);
drhb8475df2011-12-09 16:21:19 +00001131 cnt = pOp->p3-pOp->p2;
drh9f6168b2016-03-19 23:32:58 +00001132 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
drh053a1282012-09-19 21:15:46 +00001133 pOut->flags = nullFlag = pOp->p1 ? (MEM_Null|MEM_Cleared) : MEM_Null;
drh2a1df932016-09-30 17:46:44 +00001134 pOut->n = 0;
drhb8475df2011-12-09 16:21:19 +00001135 while( cnt>0 ){
1136 pOut++;
1137 memAboutToChange(p, pOut);
drh0725cab2014-09-17 14:52:46 +00001138 sqlite3VdbeMemSetNull(pOut);
drh053a1282012-09-19 21:15:46 +00001139 pOut->flags = nullFlag;
drh2a1df932016-09-30 17:46:44 +00001140 pOut->n = 0;
drhb8475df2011-12-09 16:21:19 +00001141 cnt--;
1142 }
drhf0863fe2005-06-12 21:35:51 +00001143 break;
1144}
1145
drh05a86c52014-02-16 01:55:49 +00001146/* Opcode: SoftNull P1 * * * *
drh72e26de2016-08-24 21:24:04 +00001147** Synopsis: r[P1]=NULL
drh05a86c52014-02-16 01:55:49 +00001148**
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.
1153*/
1154case OP_SoftNull: {
drh9f6168b2016-03-19 23:32:58 +00001155 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
drh05a86c52014-02-16 01:55:49 +00001156 pOut = &aMem[pOp->p1];
drhe2bc6552017-04-17 20:50:34 +00001157 pOut->flags = (pOut->flags&~(MEM_Undefined|MEM_AffMask))|MEM_Null;
drh05a86c52014-02-16 01:55:49 +00001158 break;
1159}
drhf0863fe2005-06-12 21:35:51 +00001160
drha5750cf2014-02-07 13:20:31 +00001161/* Opcode: Blob P1 P2 * P4 *
drh81316f82013-10-29 20:40:47 +00001162** Synopsis: r[P2]=P4 (len=P1)
danielk1977c572ef72004-05-27 09:28:41 +00001163**
drh9de221d2008-01-05 06:51:30 +00001164** P4 points to a blob of data P1 bytes long. Store this
drh710c4842010-08-30 01:17:20 +00001165** blob in register P2.
danielk1977c572ef72004-05-27 09:28:41 +00001166*/
drh27a348c2015-04-13 19:14:06 +00001167case OP_Blob: { /* out2 */
drhcbd2da92007-12-17 16:20:06 +00001168 assert( pOp->p1 <= SQLITE_MAX_LENGTH );
drh27a348c2015-04-13 19:14:06 +00001169 pOut = out2Prerelease(p, pOp);
drh4c583122008-01-04 22:01:03 +00001170 sqlite3VdbeMemSetStr(pOut, pOp->p4.z, pOp->p1, 0, 0);
drh9de221d2008-01-05 06:51:30 +00001171 pOut->enc = encoding;
drhb7654112008-01-12 12:48:07 +00001172 UPDATE_MAX_BLOBSIZE(pOut);
danielk1977a37cdde2004-05-16 11:15:36 +00001173 break;
1174}
1175
drheaf52d82010-05-12 13:50:23 +00001176/* Opcode: Variable P1 P2 * P4 *
drh81316f82013-10-29 20:40:47 +00001177** Synopsis: r[P2]=parameter(P1,P4)
drh50457892003-09-06 01:10:47 +00001178**
drheaf52d82010-05-12 13:50:23 +00001179** Transfer the values of bound parameter P1 into register P2
drh08de1492009-02-20 03:55:05 +00001180**
drh0fd61352014-02-07 02:29:45 +00001181** If the parameter is named, then its name appears in P4.
drh08de1492009-02-20 03:55:05 +00001182** The P4 value is used by sqlite3_bind_parameter_name().
drh50457892003-09-06 01:10:47 +00001183*/
drh27a348c2015-04-13 19:14:06 +00001184case OP_Variable: { /* out2 */
drh856c1032009-06-02 15:21:42 +00001185 Mem *pVar; /* Value being transferred */
1186
drheaf52d82010-05-12 13:50:23 +00001187 assert( pOp->p1>0 && pOp->p1<=p->nVar );
drh9bf755c2016-12-23 03:59:31 +00001188 assert( pOp->p4.z==0 || pOp->p4.z==sqlite3VListNumToName(p->pVList,pOp->p1) );
drheaf52d82010-05-12 13:50:23 +00001189 pVar = &p->aVar[pOp->p1 - 1];
1190 if( sqlite3VdbeMemTooBig(pVar) ){
1191 goto too_big;
drh023ae032007-05-08 12:12:16 +00001192 }
drh7441df72017-01-09 19:27:04 +00001193 pOut = &aMem[pOp->p2];
drheaf52d82010-05-12 13:50:23 +00001194 sqlite3VdbeMemShallowCopy(pOut, pVar, MEM_Static);
1195 UPDATE_MAX_BLOBSIZE(pOut);
danielk197793d46752004-05-23 13:30:58 +00001196 break;
1197}
danielk1977295ba552004-05-19 10:34:51 +00001198
drhb21e7c72008-06-22 12:37:57 +00001199/* Opcode: Move P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001200** Synopsis: r[P2@P3]=r[P1@P3]
drh5e00f6c2001-09-13 13:46:56 +00001201**
drh079a3072014-03-19 14:10:55 +00001202** Move the P3 values in register P1..P1+P3-1 over into
1203** registers P2..P2+P3-1. Registers P1..P1+P3-1 are
drhb21e7c72008-06-22 12:37:57 +00001204** left holding a NULL. It is an error for register ranges
drh079a3072014-03-19 14:10:55 +00001205** P1..P1+P3-1 and P2..P2+P3-1 to overlap. It is an error
1206** for P3 to be less than 1.
drh5e00f6c2001-09-13 13:46:56 +00001207*/
drhe1349cb2008-04-01 00:36:10 +00001208case OP_Move: {
drh856c1032009-06-02 15:21:42 +00001209 int n; /* Number of registers left to copy */
1210 int p1; /* Register to copy from */
1211 int p2; /* Register to copy to */
1212
drhe09f43f2013-11-21 04:18:31 +00001213 n = pOp->p3;
drh856c1032009-06-02 15:21:42 +00001214 p1 = pOp->p1;
1215 p2 = pOp->p2;
drh079a3072014-03-19 14:10:55 +00001216 assert( n>0 && p1>0 && p2>0 );
drhb21e7c72008-06-22 12:37:57 +00001217 assert( p1+n<=p2 || p2+n<=p1 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001218
drha6c2ed92009-11-14 23:22:23 +00001219 pIn1 = &aMem[p1];
1220 pOut = &aMem[p2];
drhe09f43f2013-11-21 04:18:31 +00001221 do{
drh9f6168b2016-03-19 23:32:58 +00001222 assert( pOut<=&aMem[(p->nMem+1 - p->nCursor)] );
1223 assert( pIn1<=&aMem[(p->nMem+1 - p->nCursor)] );
drh2b4ded92010-09-27 21:09:31 +00001224 assert( memIsValid(pIn1) );
1225 memAboutToChange(p, pOut);
drh17bcb102014-09-18 21:25:33 +00001226 sqlite3VdbeMemMove(pOut, pIn1);
drh52043d72011-08-03 16:40:15 +00001227#ifdef SQLITE_DEBUG
drhbd6789e2015-04-28 14:00:02 +00001228 if( pOut->pScopyFrom>=&aMem[p1] && pOut->pScopyFrom<pOut ){
drh5fb71252015-04-28 12:44:55 +00001229 pOut->pScopyFrom += pOp->p2 - p1;
drh52043d72011-08-03 16:40:15 +00001230 }
1231#endif
drhbd6789e2015-04-28 14:00:02 +00001232 Deephemeralize(pOut);
drhb21e7c72008-06-22 12:37:57 +00001233 REGISTER_TRACE(p2++, pOut);
1234 pIn1++;
1235 pOut++;
drh079a3072014-03-19 14:10:55 +00001236 }while( --n );
drhe1349cb2008-04-01 00:36:10 +00001237 break;
1238}
1239
drhe8e4af72012-09-21 00:04:28 +00001240/* Opcode: Copy P1 P2 P3 * *
drh4eded602013-12-20 15:59:20 +00001241** Synopsis: r[P2@P3+1]=r[P1@P3+1]
drhb1fdb2a2008-01-05 04:06:03 +00001242**
drhe8e4af72012-09-21 00:04:28 +00001243** Make a copy of registers P1..P1+P3 into registers P2..P2+P3.
drhb1fdb2a2008-01-05 04:06:03 +00001244**
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.
1247*/
drhe8e4af72012-09-21 00:04:28 +00001248case OP_Copy: {
1249 int n;
1250
1251 n = pOp->p3;
drh3c657212009-11-17 23:59:58 +00001252 pIn1 = &aMem[pOp->p1];
1253 pOut = &aMem[pOp->p2];
drhe1349cb2008-04-01 00:36:10 +00001254 assert( pOut!=pIn1 );
drhe8e4af72012-09-21 00:04:28 +00001255 while( 1 ){
1256 sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
1257 Deephemeralize(pOut);
drh953f7612012-12-07 22:18:54 +00001258#ifdef SQLITE_DEBUG
1259 pOut->pScopyFrom = 0;
1260#endif
drhe8e4af72012-09-21 00:04:28 +00001261 REGISTER_TRACE(pOp->p2+pOp->p3-n, pOut);
1262 if( (n--)==0 ) break;
1263 pOut++;
1264 pIn1++;
1265 }
drhe1349cb2008-04-01 00:36:10 +00001266 break;
1267}
1268
drhb1fdb2a2008-01-05 04:06:03 +00001269/* Opcode: SCopy P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00001270** Synopsis: r[P2]=r[P1]
drhb1fdb2a2008-01-05 04:06:03 +00001271**
drh9cbf3422008-01-17 16:22:13 +00001272** Make a shallow copy of register P1 into register P2.
drhb1fdb2a2008-01-05 04:06:03 +00001273**
1274** This instruction makes a shallow copy of the value. If the value
1275** is a string or blob, then the copy is only a pointer to the
1276** original and hence if the original changes so will the copy.
1277** Worse, if the original is deallocated, the copy becomes invalid.
1278** Thus the program must guarantee that the original will not change
1279** during the lifetime of the copy. Use OP_Copy to make a complete
1280** copy.
1281*/
drh26198bb2013-10-31 11:15:09 +00001282case OP_SCopy: { /* out2 */
drh3c657212009-11-17 23:59:58 +00001283 pIn1 = &aMem[pOp->p1];
1284 pOut = &aMem[pOp->p2];
drh2d401ab2008-01-10 23:50:11 +00001285 assert( pOut!=pIn1 );
drhe1349cb2008-04-01 00:36:10 +00001286 sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
drh2b4ded92010-09-27 21:09:31 +00001287#ifdef SQLITE_DEBUG
1288 if( pOut->pScopyFrom==0 ) pOut->pScopyFrom = pIn1;
1289#endif
drh5e00f6c2001-09-13 13:46:56 +00001290 break;
1291}
drh75897232000-05-29 14:26:00 +00001292
drhfed7ac62015-10-15 18:04:59 +00001293/* Opcode: IntCopy P1 P2 * * *
1294** Synopsis: r[P2]=r[P1]
1295**
1296** Transfer the integer value held in register P1 into register P2.
1297**
1298** This is an optimized version of SCopy that works only for integer
1299** values.
1300*/
1301case OP_IntCopy: { /* out2 */
1302 pIn1 = &aMem[pOp->p1];
1303 assert( (pIn1->flags & MEM_Int)!=0 );
1304 pOut = &aMem[pOp->p2];
1305 sqlite3VdbeMemSetInt64(pOut, pIn1->u.i);
1306 break;
1307}
1308
drh9cbf3422008-01-17 16:22:13 +00001309/* Opcode: ResultRow P1 P2 * * *
drh72e26de2016-08-24 21:24:04 +00001310** Synopsis: output=r[P1@P2]
drhd4e70eb2008-01-02 00:34:36 +00001311**
shane21e7feb2008-05-30 15:59:49 +00001312** The registers P1 through P1+P2-1 contain a single row of
drhd4e70eb2008-01-02 00:34:36 +00001313** results. This opcode causes the sqlite3_step() call to terminate
1314** with an SQLITE_ROW return code and it sets up the sqlite3_stmt
drh4d87aae2014-02-20 19:42:00 +00001315** structure to provide access to the r(P1)..r(P1+P2-1) values as
drh0fd61352014-02-07 02:29:45 +00001316** the result row.
drhd4e70eb2008-01-02 00:34:36 +00001317*/
drh9cbf3422008-01-17 16:22:13 +00001318case OP_ResultRow: {
drhd4e70eb2008-01-02 00:34:36 +00001319 Mem *pMem;
1320 int i;
1321 assert( p->nResColumn==pOp->p2 );
drh0a07c102008-01-03 18:03:08 +00001322 assert( pOp->p1>0 );
drh9f6168b2016-03-19 23:32:58 +00001323 assert( pOp->p1+pOp->p2<=(p->nMem+1 - p->nCursor)+1 );
drhd4e70eb2008-01-02 00:34:36 +00001324
drhe6400b92013-11-13 23:48:46 +00001325#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
1326 /* Run the progress counter just before returning.
1327 */
1328 if( db->xProgress!=0
drh2ab792e2017-05-30 18:34:07 +00001329 && nVmStep>=nProgressLimit
drhe6400b92013-11-13 23:48:46 +00001330 && db->xProgress(db->pProgressArg)!=0
1331 ){
1332 rc = SQLITE_INTERRUPT;
drh9467abf2016-02-17 18:44:11 +00001333 goto abort_due_to_error;
drhe6400b92013-11-13 23:48:46 +00001334 }
1335#endif
1336
dan32b09f22009-09-23 17:29:59 +00001337 /* 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 );
drh9467abf2016-02-17 18:44:11 +00001343 goto abort_due_to_error;
dan32b09f22009-09-23 17:29:59 +00001344 }
1345
danielk1977bd434552009-03-18 10:33:00 +00001346 /* 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.
1350 **
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.
drhaa736092009-06-22 00:55:30 +00001357 **
1358 ** The statement transaction is never a top-level transaction. Hence
1359 ** the RELEASE call below can never fail.
danielk1977bd434552009-03-18 10:33:00 +00001360 */
1361 assert( p->iStatement==0 || db->flags&SQLITE_CountRows );
drhaa736092009-06-22 00:55:30 +00001362 rc = sqlite3VdbeCloseStatement(p, SAVEPOINT_RELEASE);
drh9467abf2016-02-17 18:44:11 +00001363 assert( rc==SQLITE_OK );
danielk1977bd434552009-03-18 10:33:00 +00001364
drhd4e70eb2008-01-02 00:34:36 +00001365 /* Invalidate all ephemeral cursor row caches */
1366 p->cacheCtr = (p->cacheCtr + 2)|1;
1367
1368 /* Make sure the results of the current row are \000 terminated
shane21e7feb2008-05-30 15:59:49 +00001369 ** and have an assigned type. The results are de-ephemeralized as
drhb8a45bb2011-12-31 21:51:55 +00001370 ** a side effect.
drhd4e70eb2008-01-02 00:34:36 +00001371 */
drha6c2ed92009-11-14 23:22:23 +00001372 pMem = p->pResultSet = &aMem[pOp->p1];
drhd4e70eb2008-01-02 00:34:36 +00001373 for(i=0; i<pOp->p2; i++){
drh2b4ded92010-09-27 21:09:31 +00001374 assert( memIsValid(&pMem[i]) );
drhebc16712010-09-28 00:25:58 +00001375 Deephemeralize(&pMem[i]);
drh746fd9c2010-09-28 06:00:47 +00001376 assert( (pMem[i].flags & MEM_Ephem)==0
1377 || (pMem[i].flags & (MEM_Str|MEM_Blob))==0 );
drhd4e70eb2008-01-02 00:34:36 +00001378 sqlite3VdbeMemNulTerminate(&pMem[i]);
drh0acb7e42008-06-25 00:12:41 +00001379 REGISTER_TRACE(pOp->p1+i, &pMem[i]);
drhd4e70eb2008-01-02 00:34:36 +00001380 }
drh28039692008-03-17 16:54:01 +00001381 if( db->mallocFailed ) goto no_mem;
drhd4e70eb2008-01-02 00:34:36 +00001382
drh3d2a5292016-07-13 22:55:01 +00001383 if( db->mTrace & SQLITE_TRACE_ROW ){
1384 db->xTrace(SQLITE_TRACE_ROW, db->pTraceArg, p, 0);
1385 }
1386
drhd4e70eb2008-01-02 00:34:36 +00001387 /* Return SQLITE_ROW
1388 */
drhf56fa462015-04-13 21:39:54 +00001389 p->pc = (int)(pOp - aOp) + 1;
drhd4e70eb2008-01-02 00:34:36 +00001390 rc = SQLITE_ROW;
1391 goto vdbe_return;
1392}
1393
drh5b6afba2008-01-05 16:29:28 +00001394/* Opcode: Concat P1 P2 P3 * *
drh313619f2013-10-31 20:34:06 +00001395** Synopsis: r[P3]=r[P2]+r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001396**
drh5b6afba2008-01-05 16:29:28 +00001397** 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.
danielk1977a7a8e142008-02-13 18:25:27 +00001400**
1401** P3 = P2 || P1
1402**
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().
drh5e00f6c2001-09-13 13:46:56 +00001406*/
drh5b6afba2008-01-05 16:29:28 +00001407case OP_Concat: { /* same as TK_CONCAT, in1, in2, out3 */
drh023ae032007-05-08 12:12:16 +00001408 i64 nByte;
danielk19778a6b5412004-05-24 07:04:25 +00001409
drh3c657212009-11-17 23:59:58 +00001410 pIn1 = &aMem[pOp->p1];
1411 pIn2 = &aMem[pOp->p2];
1412 pOut = &aMem[pOp->p3];
danielk1977a7a8e142008-02-13 18:25:27 +00001413 assert( pIn1!=pOut );
drh5b6afba2008-01-05 16:29:28 +00001414 if( (pIn1->flags | pIn2->flags) & MEM_Null ){
danielk1977a7a8e142008-02-13 18:25:27 +00001415 sqlite3VdbeMemSetNull(pOut);
drh5b6afba2008-01-05 16:29:28 +00001416 break;
drh5e00f6c2001-09-13 13:46:56 +00001417 }
drha0c06522009-06-17 22:50:41 +00001418 if( ExpandBlob(pIn1) || ExpandBlob(pIn2) ) goto no_mem;
drh5b6afba2008-01-05 16:29:28 +00001419 Stringify(pIn1, encoding);
drh5b6afba2008-01-05 16:29:28 +00001420 Stringify(pIn2, encoding);
1421 nByte = pIn1->n + pIn2->n;
drhbb4957f2008-03-20 14:03:29 +00001422 if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
drh5b6afba2008-01-05 16:29:28 +00001423 goto too_big;
drh5e00f6c2001-09-13 13:46:56 +00001424 }
drh9c1905f2008-12-10 22:32:56 +00001425 if( sqlite3VdbeMemGrow(pOut, (int)nByte+2, pOut==pIn2) ){
drh5b6afba2008-01-05 16:29:28 +00001426 goto no_mem;
1427 }
drhc91b2fd2014-03-01 18:13:23 +00001428 MemSetTypeFlag(pOut, MEM_Str);
danielk1977a7a8e142008-02-13 18:25:27 +00001429 if( pOut!=pIn2 ){
1430 memcpy(pOut->z, pIn2->z, pIn2->n);
1431 }
1432 memcpy(&pOut->z[pIn2->n], pIn1->z, pIn1->n);
drh81316f82013-10-29 20:40:47 +00001433 pOut->z[nByte]=0;
danielk1977a7a8e142008-02-13 18:25:27 +00001434 pOut->z[nByte+1] = 0;
1435 pOut->flags |= MEM_Term;
drh9c1905f2008-12-10 22:32:56 +00001436 pOut->n = (int)nByte;
drh5b6afba2008-01-05 16:29:28 +00001437 pOut->enc = encoding;
drhb7654112008-01-12 12:48:07 +00001438 UPDATE_MAX_BLOBSIZE(pOut);
drh5e00f6c2001-09-13 13:46:56 +00001439 break;
1440}
drh75897232000-05-29 14:26:00 +00001441
drh3c84ddf2008-01-09 02:15:38 +00001442/* Opcode: Add P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001443** Synopsis: r[P3]=r[P1]+r[P2]
drh5e00f6c2001-09-13 13:46:56 +00001444**
drh60a713c2008-01-21 16:22:45 +00001445** Add the value in register P1 to the value in register P2
shane21e7feb2008-05-30 15:59:49 +00001446** and store the result in register P3.
drh60a713c2008-01-21 16:22:45 +00001447** If either input is NULL, the result is NULL.
drh5e00f6c2001-09-13 13:46:56 +00001448*/
drh3c84ddf2008-01-09 02:15:38 +00001449/* Opcode: Multiply P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001450** Synopsis: r[P3]=r[P1]*r[P2]
drh5e00f6c2001-09-13 13:46:56 +00001451**
drh3c84ddf2008-01-09 02:15:38 +00001452**
shane21e7feb2008-05-30 15:59:49 +00001453** Multiply the value in register P1 by the value in register P2
drh60a713c2008-01-21 16:22:45 +00001454** and store the result in register P3.
1455** If either input is NULL, the result is NULL.
drh5e00f6c2001-09-13 13:46:56 +00001456*/
drh3c84ddf2008-01-09 02:15:38 +00001457/* Opcode: Subtract P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001458** Synopsis: r[P3]=r[P2]-r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001459**
drh60a713c2008-01-21 16:22:45 +00001460** 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.
drh5e00f6c2001-09-13 13:46:56 +00001463*/
drh9cbf3422008-01-17 16:22:13 +00001464/* Opcode: Divide P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001465** Synopsis: r[P3]=r[P2]/r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001466**
drh60a713c2008-01-21 16:22:45 +00001467** Divide the value in register P1 by the value in register P2
dane275dc32009-08-18 16:24:58 +00001468** 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.
drh5e00f6c2001-09-13 13:46:56 +00001471*/
drh9cbf3422008-01-17 16:22:13 +00001472/* Opcode: Remainder P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001473** Synopsis: r[P3]=r[P2]%r[P1]
drhbf4133c2001-10-13 02:59:08 +00001474**
drh40864a12013-11-15 18:58:37 +00001475** 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.
drhf5905aa2002-05-26 20:54:33 +00001478** If either operand is NULL, the result is NULL.
drhbf4133c2001-10-13 02:59:08 +00001479*/
drh5b6afba2008-01-05 16:29:28 +00001480case OP_Add: /* same as TK_PLUS, in1, in2, out3 */
1481case OP_Subtract: /* same as TK_MINUS, in1, in2, out3 */
1482case OP_Multiply: /* same as TK_STAR, in1, in2, out3 */
1483case OP_Divide: /* same as TK_SLASH, in1, in2, out3 */
1484case OP_Remainder: { /* same as TK_REM, in1, in2, out3 */
drhbe707b32012-12-10 22:19:14 +00001485 char bIntint; /* Started out as two integer operands */
drh3d1d90a2014-03-24 15:00:15 +00001486 u16 flags; /* Combined MEM_* flags from both inputs */
1487 u16 type1; /* Numeric type of left operand */
1488 u16 type2; /* Numeric type of right operand */
drh856c1032009-06-02 15:21:42 +00001489 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 */
1493
drh3c657212009-11-17 23:59:58 +00001494 pIn1 = &aMem[pOp->p1];
drh3d1d90a2014-03-24 15:00:15 +00001495 type1 = numericType(pIn1);
drh3c657212009-11-17 23:59:58 +00001496 pIn2 = &aMem[pOp->p2];
drh3d1d90a2014-03-24 15:00:15 +00001497 type2 = numericType(pIn2);
drh3c657212009-11-17 23:59:58 +00001498 pOut = &aMem[pOp->p3];
drh5b6afba2008-01-05 16:29:28 +00001499 flags = pIn1->flags | pIn2->flags;
drh3d1d90a2014-03-24 15:00:15 +00001500 if( (type1 & type2 & MEM_Int)!=0 ){
drh856c1032009-06-02 15:21:42 +00001501 iA = pIn1->u.i;
1502 iB = pIn2->u.i;
drhbe707b32012-12-10 22:19:14 +00001503 bIntint = 1;
drh5e00f6c2001-09-13 13:46:56 +00001504 switch( pOp->opcode ){
drh158b9cb2011-03-05 20:59:46 +00001505 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;
drhbf4133c2001-10-13 02:59:08 +00001508 case OP_Divide: {
drh856c1032009-06-02 15:21:42 +00001509 if( iA==0 ) goto arithmetic_result_is_null;
drh158b9cb2011-03-05 20:59:46 +00001510 if( iA==-1 && iB==SMALLEST_INT64 ) goto fp_math;
drh856c1032009-06-02 15:21:42 +00001511 iB /= iA;
drh75897232000-05-29 14:26:00 +00001512 break;
1513 }
drhbf4133c2001-10-13 02:59:08 +00001514 default: {
drh856c1032009-06-02 15:21:42 +00001515 if( iA==0 ) goto arithmetic_result_is_null;
1516 if( iA==-1 ) iA = 1;
1517 iB %= iA;
drhbf4133c2001-10-13 02:59:08 +00001518 break;
1519 }
drh75897232000-05-29 14:26:00 +00001520 }
drh856c1032009-06-02 15:21:42 +00001521 pOut->u.i = iB;
danielk1977a7a8e142008-02-13 18:25:27 +00001522 MemSetTypeFlag(pOut, MEM_Int);
drhcfcca022017-04-17 23:23:17 +00001523 }else if( (flags & MEM_Null)!=0 ){
1524 goto arithmetic_result_is_null;
drh5e00f6c2001-09-13 13:46:56 +00001525 }else{
drhbe707b32012-12-10 22:19:14 +00001526 bIntint = 0;
drh158b9cb2011-03-05 20:59:46 +00001527fp_math:
drh856c1032009-06-02 15:21:42 +00001528 rA = sqlite3VdbeRealValue(pIn1);
1529 rB = sqlite3VdbeRealValue(pIn2);
drh5e00f6c2001-09-13 13:46:56 +00001530 switch( pOp->opcode ){
drh856c1032009-06-02 15:21:42 +00001531 case OP_Add: rB += rA; break;
1532 case OP_Subtract: rB -= rA; break;
1533 case OP_Multiply: rB *= rA; break;
drhbf4133c2001-10-13 02:59:08 +00001534 case OP_Divide: {
shanefbd60f82009-02-04 03:59:25 +00001535 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
drh856c1032009-06-02 15:21:42 +00001536 if( rA==(double)0 ) goto arithmetic_result_is_null;
1537 rB /= rA;
drh5e00f6c2001-09-13 13:46:56 +00001538 break;
1539 }
drhbf4133c2001-10-13 02:59:08 +00001540 default: {
shane75ac1de2009-06-09 18:58:52 +00001541 iA = (i64)rA;
1542 iB = (i64)rB;
drh856c1032009-06-02 15:21:42 +00001543 if( iA==0 ) goto arithmetic_result_is_null;
1544 if( iA==-1 ) iA = 1;
1545 rB = (double)(iB % iA);
drhbf4133c2001-10-13 02:59:08 +00001546 break;
1547 }
drh5e00f6c2001-09-13 13:46:56 +00001548 }
drhc5a7b512010-01-13 16:25:42 +00001549#ifdef SQLITE_OMIT_FLOATING_POINT
1550 pOut->u.i = rB;
1551 MemSetTypeFlag(pOut, MEM_Int);
1552#else
drh856c1032009-06-02 15:21:42 +00001553 if( sqlite3IsNaN(rB) ){
drha05a7222008-01-19 03:35:58 +00001554 goto arithmetic_result_is_null;
drh53c14022007-05-10 17:23:11 +00001555 }
drh74eaba42014-09-18 17:52:15 +00001556 pOut->u.r = rB;
danielk1977a7a8e142008-02-13 18:25:27 +00001557 MemSetTypeFlag(pOut, MEM_Real);
drh3d1d90a2014-03-24 15:00:15 +00001558 if( ((type1|type2)&MEM_Real)==0 && !bIntint ){
drh5b6afba2008-01-05 16:29:28 +00001559 sqlite3VdbeIntegerAffinity(pOut);
drh8a512562005-11-14 22:29:05 +00001560 }
drhc5a7b512010-01-13 16:25:42 +00001561#endif
drh5e00f6c2001-09-13 13:46:56 +00001562 }
1563 break;
1564
drha05a7222008-01-19 03:35:58 +00001565arithmetic_result_is_null:
1566 sqlite3VdbeMemSetNull(pOut);
drh5e00f6c2001-09-13 13:46:56 +00001567 break;
1568}
1569
drh7a957892012-02-02 17:35:43 +00001570/* Opcode: CollSeq P1 * * P4
danielk1977dc1bdc42004-06-11 10:51:27 +00001571**
drhbb6783b2017-04-29 18:02:49 +00001572** P4 is a pointer to a CollSeq object. If the next call to a user function
danielk1977dc1bdc42004-06-11 10:51:27 +00001573** or aggregate calls sqlite3GetFuncCollSeq(), this collation sequence will
1574** be returned. This is used by the built-in min(), max() and nullif()
drhe6f85e72004-12-25 01:03:13 +00001575** functions.
danielk1977dc1bdc42004-06-11 10:51:27 +00001576**
drh7a957892012-02-02 17:35:43 +00001577** 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.
1580**
danielk1977dc1bdc42004-06-11 10:51:27 +00001581** The interface used by the implementation of the aforementioned functions
1582** to retrieve the collation sequence set by this opcode is not available
drh0a0d0562015-03-12 05:08:34 +00001583** publicly. Only built-in functions have access to this feature.
danielk1977dc1bdc42004-06-11 10:51:27 +00001584*/
drh9cbf3422008-01-17 16:22:13 +00001585case OP_CollSeq: {
drh66a51672008-01-03 00:01:23 +00001586 assert( pOp->p4type==P4_COLLSEQ );
drh7a957892012-02-02 17:35:43 +00001587 if( pOp->p1 ){
1588 sqlite3VdbeMemSetInt64(&aMem[pOp->p1], 0);
1589 }
danielk1977dc1bdc42004-06-11 10:51:27 +00001590 break;
1591}
1592
drh9c7c9132015-06-26 18:16:52 +00001593/* Opcode: Function0 P1 P2 P3 P4 P5
drhf63552b2013-10-30 00:25:03 +00001594** Synopsis: r[P3]=func(r[P2@P5])
drh8e0a2f92002-02-23 23:45:45 +00001595**
drhe2d9e7c2015-06-26 18:47:53 +00001596** Invoke a user function (P4 is a pointer to a FuncDef object that
drh98757152008-01-09 23:04:12 +00001597** defines the function) with P5 arguments taken from register P2 and
drh9cbf3422008-01-17 16:22:13 +00001598** successors. The result of the function is stored in register P3.
danielk1977a7a8e142008-02-13 18:25:27 +00001599** Register P3 must not be one of the function inputs.
danielk1977682f68b2004-06-05 10:22:17 +00001600**
drh13449892005-09-07 21:22:45 +00001601** P1 is a 32-bit bitmask indicating whether or not each argument to the
danielk1977682f68b2004-06-05 10:22:17 +00001602** function was determined to be constant at compile time. If the first
drh13449892005-09-07 21:22:45 +00001603** argument was constant then bit 0 of P1 is set. This is used to determine
danielk1977682f68b2004-06-05 10:22:17 +00001604** whether meta data associated with a user function argument using the
1605** sqlite3_set_auxdata() API may be safely retained until the next
1606** invocation of this opcode.
drh1350b032002-02-27 19:00:20 +00001607**
drh9c7c9132015-06-26 18:16:52 +00001608** See also: Function, AggStep, AggFinal
drh8e0a2f92002-02-23 23:45:45 +00001609*/
drh9c7c9132015-06-26 18:16:52 +00001610/* Opcode: Function P1 P2 P3 P4 P5
1611** Synopsis: r[P3]=func(r[P2@P5])
1612**
1613** Invoke a user function (P4 is a pointer to an sqlite3_context object that
1614** contains a pointer to the function to be run) with P5 arguments taken
1615** from register P2 and successors. The result of the function is stored
1616** in register P3. Register P3 must not be one of the function inputs.
1617**
1618** P1 is a 32-bit bitmask indicating whether or not each argument to the
1619** function was determined to be constant at compile time. If the first
1620** argument was constant then bit 0 of P1 is set. This is used to determine
1621** whether meta data associated with a user function argument using the
1622** sqlite3_set_auxdata() API may be safely retained until the next
1623** invocation of this opcode.
1624**
1625** SQL functions are initially coded as OP_Function0 with P4 pointing
drhe2d9e7c2015-06-26 18:47:53 +00001626** to a FuncDef object. But on first evaluation, the P4 operand is
drh9c7c9132015-06-26 18:16:52 +00001627** automatically converted into an sqlite3_context object and the operation
1628** changed to this OP_Function opcode. In this way, the initialization of
1629** the sqlite3_context object occurs only once, rather than once for each
1630** evaluation of the function.
1631**
1632** See also: Function0, AggStep, AggFinal
1633*/
1634case OP_Function0: {
drh856c1032009-06-02 15:21:42 +00001635 int n;
drh9c7c9132015-06-26 18:16:52 +00001636 sqlite3_context *pCtx;
danielk197751ad0ec2004-05-24 12:39:02 +00001637
dan0c547792013-07-18 17:12:08 +00001638 assert( pOp->p4type==P4_FUNCDEF );
drh9c7c9132015-06-26 18:16:52 +00001639 n = pOp->p5;
drh9f6168b2016-03-19 23:32:58 +00001640 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
1641 assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
drh9c7c9132015-06-26 18:16:52 +00001642 assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
drh575fad62016-02-05 13:38:36 +00001643 pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
drh9c7c9132015-06-26 18:16:52 +00001644 if( pCtx==0 ) goto no_mem;
1645 pCtx->pOut = 0;
1646 pCtx->pFunc = pOp->p4.pFunc;
1647 pCtx->iOp = (int)(pOp - aOp);
1648 pCtx->pVdbe = p;
1649 pCtx->argc = n;
1650 pOp->p4type = P4_FUNCCTX;
1651 pOp->p4.pCtx = pCtx;
1652 pOp->opcode = OP_Function;
1653 /* Fall through into OP_Function */
1654}
1655case OP_Function: {
1656 int i;
1657 sqlite3_context *pCtx;
1658
1659 assert( pOp->p4type==P4_FUNCCTX );
1660 pCtx = pOp->p4.pCtx;
1661
1662 /* If this function is inside of a trigger, the register array in aMem[]
1663 ** might change from one evaluation to the next. The next block of code
1664 ** checks to see if the register array has changed, and if so it
1665 ** reinitializes the relavant parts of the sqlite3_context object */
drhe2d9e7c2015-06-26 18:47:53 +00001666 pOut = &aMem[pOp->p3];
1667 if( pCtx->pOut != pOut ){
1668 pCtx->pOut = pOut;
drh9c7c9132015-06-26 18:16:52 +00001669 for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
1670 }
1671
drhe3247822017-02-21 15:27:22 +00001672 memAboutToChange(p, pOut);
drh9c7c9132015-06-26 18:16:52 +00001673#ifdef SQLITE_DEBUG
1674 for(i=0; i<pCtx->argc; i++){
1675 assert( memIsValid(pCtx->argv[i]) );
1676 REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
1677 }
1678#endif
drhe3247822017-02-21 15:27:22 +00001679 MemSetTypeFlag(pOut, MEM_Null);
drh9c7c9132015-06-26 18:16:52 +00001680 pCtx->fErrorOrAux = 0;
drh2d801512016-01-14 22:19:58 +00001681 (*pCtx->pFunc->xSFunc)(pCtx, pCtx->argc, pCtx->argv);/* IMP: R-24505-23230 */
danielk19777e18c252004-05-25 11:47:24 +00001682
drh90669c12006-01-20 15:45:36 +00001683 /* If the function returned an error, throw an exception */
drh9c7c9132015-06-26 18:16:52 +00001684 if( pCtx->fErrorOrAux ){
1685 if( pCtx->isError ){
drhe3247822017-02-21 15:27:22 +00001686 sqlite3VdbeError(p, "%s", sqlite3_value_text(pOut));
drh9c7c9132015-06-26 18:16:52 +00001687 rc = pCtx->isError;
drh9b47ee32013-08-20 03:13:51 +00001688 }
drhb9626cf2016-02-22 16:04:31 +00001689 sqlite3VdbeDeleteAuxData(db, &p->pAuxData, pCtx->iOp, pOp->p1);
drh9467abf2016-02-17 18:44:11 +00001690 if( rc ) goto abort_due_to_error;
drh90669c12006-01-20 15:45:36 +00001691 }
1692
drh9cbf3422008-01-17 16:22:13 +00001693 /* Copy the result of the function into register P3 */
drhe2d9e7c2015-06-26 18:47:53 +00001694 if( pOut->flags & (MEM_Str|MEM_Blob) ){
drhe3247822017-02-21 15:27:22 +00001695 sqlite3VdbeChangeEncoding(pOut, encoding);
1696 if( sqlite3VdbeMemTooBig(pOut) ) goto too_big;
drh023ae032007-05-08 12:12:16 +00001697 }
drh7b94e7f2011-04-04 12:29:20 +00001698
drhe3247822017-02-21 15:27:22 +00001699 REGISTER_TRACE(pOp->p3, pOut);
1700 UPDATE_MAX_BLOBSIZE(pOut);
drh8e0a2f92002-02-23 23:45:45 +00001701 break;
1702}
1703
drh98757152008-01-09 23:04:12 +00001704/* Opcode: BitAnd P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001705** Synopsis: r[P3]=r[P1]&r[P2]
drhbf4133c2001-10-13 02:59:08 +00001706**
drh98757152008-01-09 23:04:12 +00001707** Take the bit-wise AND of the values in register P1 and P2 and
1708** store the result in register P3.
drh60a713c2008-01-21 16:22:45 +00001709** If either input is NULL, the result is NULL.
drhbf4133c2001-10-13 02:59:08 +00001710*/
drh98757152008-01-09 23:04:12 +00001711/* Opcode: BitOr P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001712** Synopsis: r[P3]=r[P1]|r[P2]
drhbf4133c2001-10-13 02:59:08 +00001713**
drh98757152008-01-09 23:04:12 +00001714** Take the bit-wise OR of the values in register P1 and P2 and
1715** store the result in register P3.
drh60a713c2008-01-21 16:22:45 +00001716** If either input is NULL, the result is NULL.
drhbf4133c2001-10-13 02:59:08 +00001717*/
drh98757152008-01-09 23:04:12 +00001718/* Opcode: ShiftLeft P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001719** Synopsis: r[P3]=r[P2]<<r[P1]
drhbf4133c2001-10-13 02:59:08 +00001720**
drh98757152008-01-09 23:04:12 +00001721** Shift the integer value in register P2 to the left by the
drh710c4842010-08-30 01:17:20 +00001722** number of bits specified by the integer in register P1.
drh98757152008-01-09 23:04:12 +00001723** Store the result in register P3.
drh60a713c2008-01-21 16:22:45 +00001724** If either input is NULL, the result is NULL.
drhbf4133c2001-10-13 02:59:08 +00001725*/
drh98757152008-01-09 23:04:12 +00001726/* Opcode: ShiftRight P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00001727** Synopsis: r[P3]=r[P2]>>r[P1]
drhbf4133c2001-10-13 02:59:08 +00001728**
drh98757152008-01-09 23:04:12 +00001729** Shift the integer value in register P2 to the right by the
drh60a713c2008-01-21 16:22:45 +00001730** number of bits specified by the integer in register P1.
drh98757152008-01-09 23:04:12 +00001731** Store the result in register P3.
drh60a713c2008-01-21 16:22:45 +00001732** If either input is NULL, the result is NULL.
drhbf4133c2001-10-13 02:59:08 +00001733*/
drh5b6afba2008-01-05 16:29:28 +00001734case OP_BitAnd: /* same as TK_BITAND, in1, in2, out3 */
1735case OP_BitOr: /* same as TK_BITOR, in1, in2, out3 */
1736case OP_ShiftLeft: /* same as TK_LSHIFT, in1, in2, out3 */
1737case OP_ShiftRight: { /* same as TK_RSHIFT, in1, in2, out3 */
drh158b9cb2011-03-05 20:59:46 +00001738 i64 iA;
1739 u64 uA;
1740 i64 iB;
1741 u8 op;
drh6810ce62004-01-31 19:22:56 +00001742
drh3c657212009-11-17 23:59:58 +00001743 pIn1 = &aMem[pOp->p1];
1744 pIn2 = &aMem[pOp->p2];
1745 pOut = &aMem[pOp->p3];
drh5b6afba2008-01-05 16:29:28 +00001746 if( (pIn1->flags | pIn2->flags) & MEM_Null ){
drha05a7222008-01-19 03:35:58 +00001747 sqlite3VdbeMemSetNull(pOut);
drhf5905aa2002-05-26 20:54:33 +00001748 break;
1749 }
drh158b9cb2011-03-05 20:59:46 +00001750 iA = sqlite3VdbeIntValue(pIn2);
1751 iB = sqlite3VdbeIntValue(pIn1);
1752 op = pOp->opcode;
1753 if( op==OP_BitAnd ){
1754 iA &= iB;
1755 }else if( op==OP_BitOr ){
1756 iA |= iB;
1757 }else if( iB!=0 ){
1758 assert( op==OP_ShiftRight || op==OP_ShiftLeft );
1759
1760 /* If shifting by a negative amount, shift in the other direction */
1761 if( iB<0 ){
1762 assert( OP_ShiftRight==OP_ShiftLeft+1 );
1763 op = 2*OP_ShiftLeft + 1 - op;
1764 iB = iB>(-64) ? -iB : 64;
1765 }
1766
1767 if( iB>=64 ){
1768 iA = (iA>=0 || op==OP_ShiftLeft) ? 0 : -1;
1769 }else{
1770 memcpy(&uA, &iA, sizeof(uA));
1771 if( op==OP_ShiftLeft ){
1772 uA <<= iB;
1773 }else{
1774 uA >>= iB;
1775 /* Sign-extend on a right shift of a negative number */
1776 if( iA<0 ) uA |= ((((u64)0xffffffff)<<32)|0xffffffff) << (64-iB);
1777 }
1778 memcpy(&iA, &uA, sizeof(iA));
1779 }
drhbf4133c2001-10-13 02:59:08 +00001780 }
drh158b9cb2011-03-05 20:59:46 +00001781 pOut->u.i = iA;
danielk1977a7a8e142008-02-13 18:25:27 +00001782 MemSetTypeFlag(pOut, MEM_Int);
drhbf4133c2001-10-13 02:59:08 +00001783 break;
1784}
1785
drh8558cde2008-01-05 05:20:10 +00001786/* Opcode: AddImm P1 P2 * * *
drh72e26de2016-08-24 21:24:04 +00001787** Synopsis: r[P1]=r[P1]+P2
drh5e00f6c2001-09-13 13:46:56 +00001788**
danielk19770cdc0222008-06-26 18:04:03 +00001789** Add the constant P2 to the value in register P1.
drh8558cde2008-01-05 05:20:10 +00001790** The result is always an integer.
drh4a324312001-12-21 14:30:42 +00001791**
drh8558cde2008-01-05 05:20:10 +00001792** To force any register to be an integer, just add 0.
drh5e00f6c2001-09-13 13:46:56 +00001793*/
drh9cbf3422008-01-17 16:22:13 +00001794case OP_AddImm: { /* in1 */
drh3c657212009-11-17 23:59:58 +00001795 pIn1 = &aMem[pOp->p1];
drh2b4ded92010-09-27 21:09:31 +00001796 memAboutToChange(p, pIn1);
drh8558cde2008-01-05 05:20:10 +00001797 sqlite3VdbeMemIntegerify(pIn1);
1798 pIn1->u.i += pOp->p2;
drh5e00f6c2001-09-13 13:46:56 +00001799 break;
1800}
1801
drh9cbf3422008-01-17 16:22:13 +00001802/* Opcode: MustBeInt P1 P2 * * *
drh8aff1012001-12-22 14:49:24 +00001803**
drh9cbf3422008-01-17 16:22:13 +00001804** Force the value in register P1 to be an integer. If the value
1805** in P1 is not an integer and cannot be converted into an integer
danielk19779a96b662007-11-29 17:05:18 +00001806** without data loss, then jump immediately to P2, or if P2==0
drh8aff1012001-12-22 14:49:24 +00001807** raise an SQLITE_MISMATCH exception.
1808*/
drh9cbf3422008-01-17 16:22:13 +00001809case OP_MustBeInt: { /* jump, in1 */
drh3c657212009-11-17 23:59:58 +00001810 pIn1 = &aMem[pOp->p1];
drh3c84ddf2008-01-09 02:15:38 +00001811 if( (pIn1->flags & MEM_Int)==0 ){
drh83b301b2013-11-20 00:59:02 +00001812 applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
drh688852a2014-02-17 22:40:43 +00001813 VdbeBranchTaken((pIn1->flags&MEM_Int)==0, 2);
drh83b301b2013-11-20 00:59:02 +00001814 if( (pIn1->flags & MEM_Int)==0 ){
1815 if( pOp->p2==0 ){
1816 rc = SQLITE_MISMATCH;
1817 goto abort_due_to_error;
1818 }else{
drhf56fa462015-04-13 21:39:54 +00001819 goto jump_to_p2;
drh83b301b2013-11-20 00:59:02 +00001820 }
drh8aff1012001-12-22 14:49:24 +00001821 }
drh8aff1012001-12-22 14:49:24 +00001822 }
drh83b301b2013-11-20 00:59:02 +00001823 MemSetTypeFlag(pIn1, MEM_Int);
drh8aff1012001-12-22 14:49:24 +00001824 break;
1825}
1826
drh13573c72010-01-12 17:04:07 +00001827#ifndef SQLITE_OMIT_FLOATING_POINT
drh8558cde2008-01-05 05:20:10 +00001828/* Opcode: RealAffinity P1 * * * *
drh487e2622005-06-25 18:42:14 +00001829**
drh2133d822008-01-03 18:44:59 +00001830** If register P1 holds an integer convert it to a real value.
drh487e2622005-06-25 18:42:14 +00001831**
drh8a512562005-11-14 22:29:05 +00001832** This opcode is used when extracting information from a column that
1833** has REAL affinity. Such column values may still be stored as
1834** integers, for space efficiency, but after extraction we want them
1835** to have only a real value.
drh487e2622005-06-25 18:42:14 +00001836*/
drh9cbf3422008-01-17 16:22:13 +00001837case OP_RealAffinity: { /* in1 */
drh3c657212009-11-17 23:59:58 +00001838 pIn1 = &aMem[pOp->p1];
drh8558cde2008-01-05 05:20:10 +00001839 if( pIn1->flags & MEM_Int ){
1840 sqlite3VdbeMemRealify(pIn1);
drh8a512562005-11-14 22:29:05 +00001841 }
drh487e2622005-06-25 18:42:14 +00001842 break;
1843}
drh13573c72010-01-12 17:04:07 +00001844#endif
drh487e2622005-06-25 18:42:14 +00001845
drh8df447f2005-11-01 15:48:24 +00001846#ifndef SQLITE_OMIT_CAST
drh4169e432014-08-25 20:11:52 +00001847/* Opcode: Cast P1 P2 * * *
mistachkina1dc42a2014-08-27 17:53:40 +00001848** Synopsis: affinity(r[P1])
drh487e2622005-06-25 18:42:14 +00001849**
drh4169e432014-08-25 20:11:52 +00001850** Force the value in register P1 to be the type defined by P2.
1851**
1852** <ul>
drhbb6783b2017-04-29 18:02:49 +00001853** <li> P2=='A' &rarr; BLOB
1854** <li> P2=='B' &rarr; TEXT
1855** <li> P2=='C' &rarr; NUMERIC
1856** <li> P2=='D' &rarr; INTEGER
1857** <li> P2=='E' &rarr; REAL
drh4169e432014-08-25 20:11:52 +00001858** </ul>
drh487e2622005-06-25 18:42:14 +00001859**
1860** A NULL value is not changed by this routine. It remains NULL.
1861*/
drh4169e432014-08-25 20:11:52 +00001862case OP_Cast: { /* in1 */
drh05883a32015-06-02 15:32:08 +00001863 assert( pOp->p2>=SQLITE_AFF_BLOB && pOp->p2<=SQLITE_AFF_REAL );
drh05bbb2e2014-08-25 22:37:19 +00001864 testcase( pOp->p2==SQLITE_AFF_TEXT );
drh05883a32015-06-02 15:32:08 +00001865 testcase( pOp->p2==SQLITE_AFF_BLOB );
drh05bbb2e2014-08-25 22:37:19 +00001866 testcase( pOp->p2==SQLITE_AFF_NUMERIC );
1867 testcase( pOp->p2==SQLITE_AFF_INTEGER );
1868 testcase( pOp->p2==SQLITE_AFF_REAL );
drh3c657212009-11-17 23:59:58 +00001869 pIn1 = &aMem[pOp->p1];
drh2b4ded92010-09-27 21:09:31 +00001870 memAboutToChange(p, pIn1);
drh8558cde2008-01-05 05:20:10 +00001871 rc = ExpandBlob(pIn1);
drh4169e432014-08-25 20:11:52 +00001872 sqlite3VdbeMemCast(pIn1, pOp->p2, encoding);
drhb7654112008-01-12 12:48:07 +00001873 UPDATE_MAX_BLOBSIZE(pIn1);
drh9467abf2016-02-17 18:44:11 +00001874 if( rc ) goto abort_due_to_error;
drh487e2622005-06-25 18:42:14 +00001875 break;
1876}
drh8a512562005-11-14 22:29:05 +00001877#endif /* SQLITE_OMIT_CAST */
1878
drh79752b62016-08-13 10:02:17 +00001879/* Opcode: Eq P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001880** Synopsis: IF r[P3]==r[P1]
drh79752b62016-08-13 10:02:17 +00001881**
1882** Compare the values in register P1 and P3. If reg(P3)==reg(P1) then
1883** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5, then
1884** store the result of comparison in register P2.
1885**
1886** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
1887** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
1888** to coerce both inputs according to this affinity before the
1889** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
1890** affinity is used. Note that the affinity conversions are stored
1891** back into the input registers P1 and P3. So this opcode can cause
1892** persistent changes to registers P1 and P3.
1893**
1894** Once any conversions have taken place, and neither value is NULL,
1895** the values are compared. If both values are blobs then memcmp() is
1896** used to determine the results of the comparison. If both values
1897** are text, then the appropriate collating function specified in
1898** P4 is used to do the comparison. If P4 is not specified then
1899** memcmp() is used to compare text string. If both values are
1900** numeric, then a numeric comparison is used. If the two values
1901** are of different types, then numbers are considered less than
1902** strings and strings are considered less than blobs.
1903**
1904** If SQLITE_NULLEQ is set in P5 then the result of comparison is always either
1905** true or false and is never NULL. If both operands are NULL then the result
1906** of comparison is true. If either operand is NULL then the result is false.
1907** If neither operand is NULL the result is the same as it would be if
1908** the SQLITE_NULLEQ flag were omitted from P5.
1909**
1910** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
drh3fffbf92016-09-05 15:02:41 +00001911** content of r[P2] is only changed if the new value is NULL or 0 (false).
1912** In other words, a prior r[P2] value will not be overwritten by 1 (true).
drh79752b62016-08-13 10:02:17 +00001913*/
1914/* Opcode: Ne P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001915** Synopsis: IF r[P3]!=r[P1]
drh79752b62016-08-13 10:02:17 +00001916**
1917** This works just like the Eq opcode except that the jump is taken if
1918** the operands in registers P1 and P3 are not equal. See the Eq opcode for
1919** additional information.
1920**
1921** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
drh3fffbf92016-09-05 15:02:41 +00001922** content of r[P2] is only changed if the new value is NULL or 1 (true).
1923** In other words, a prior r[P2] value will not be overwritten by 0 (false).
drh79752b62016-08-13 10:02:17 +00001924*/
drh35573352008-01-08 23:54:25 +00001925/* Opcode: Lt P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001926** Synopsis: IF r[P3]<r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001927**
drh35573352008-01-08 23:54:25 +00001928** Compare the values in register P1 and P3. If reg(P3)<reg(P1) then
drh79752b62016-08-13 10:02:17 +00001929** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5 store
1930** the result of comparison (0 or 1 or NULL) into register P2.
drhf5905aa2002-05-26 20:54:33 +00001931**
drh35573352008-01-08 23:54:25 +00001932** If the SQLITE_JUMPIFNULL bit of P5 is set and either reg(P1) or
drh79752b62016-08-13 10:02:17 +00001933** reg(P3) is NULL then the take the jump. If the SQLITE_JUMPIFNULL
drh710c4842010-08-30 01:17:20 +00001934** bit is clear then fall through if either operand is NULL.
drh4f686232005-09-20 13:55:18 +00001935**
drh35573352008-01-08 23:54:25 +00001936** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
drh8a512562005-11-14 22:29:05 +00001937** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
drh60a713c2008-01-21 16:22:45 +00001938** to coerce both inputs according to this affinity before the
drh35573352008-01-08 23:54:25 +00001939** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
drh60a713c2008-01-21 16:22:45 +00001940** affinity is used. Note that the affinity conversions are stored
1941** back into the input registers P1 and P3. So this opcode can cause
1942** persistent changes to registers P1 and P3.
danielk1977a37cdde2004-05-16 11:15:36 +00001943**
1944** Once any conversions have taken place, and neither value is NULL,
drh35573352008-01-08 23:54:25 +00001945** the values are compared. If both values are blobs then memcmp() is
1946** used to determine the results of the comparison. If both values
1947** are text, then the appropriate collating function specified in
1948** P4 is used to do the comparison. If P4 is not specified then
1949** memcmp() is used to compare text string. If both values are
1950** numeric, then a numeric comparison is used. If the two values
1951** are of different types, then numbers are considered less than
1952** strings and strings are considered less than blobs.
drh5e00f6c2001-09-13 13:46:56 +00001953*/
drh9cbf3422008-01-17 16:22:13 +00001954/* Opcode: Le P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001955** Synopsis: IF r[P3]<=r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001956**
drh35573352008-01-08 23:54:25 +00001957** This works just like the Lt opcode except that the jump is taken if
1958** the content of register P3 is less than or equal to the content of
1959** register P1. See the Lt opcode for additional information.
drh5e00f6c2001-09-13 13:46:56 +00001960*/
drh9cbf3422008-01-17 16:22:13 +00001961/* Opcode: Gt P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001962** Synopsis: IF r[P3]>r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001963**
drh35573352008-01-08 23:54:25 +00001964** This works just like the Lt opcode except that the jump is taken if
1965** the content of register P3 is greater than the content of
1966** register P1. See the Lt opcode for additional information.
drh5e00f6c2001-09-13 13:46:56 +00001967*/
drh9cbf3422008-01-17 16:22:13 +00001968/* Opcode: Ge P1 P2 P3 P4 P5
drh88e665f2016-08-27 01:41:53 +00001969** Synopsis: IF r[P3]>=r[P1]
drh5e00f6c2001-09-13 13:46:56 +00001970**
drh35573352008-01-08 23:54:25 +00001971** This works just like the Lt opcode except that the jump is taken if
1972** the content of register P3 is greater than or equal to the content of
1973** register P1. See the Lt opcode for additional information.
drh5e00f6c2001-09-13 13:46:56 +00001974*/
drh9cbf3422008-01-17 16:22:13 +00001975case OP_Eq: /* same as TK_EQ, jump, in1, in3 */
1976case OP_Ne: /* same as TK_NE, jump, in1, in3 */
1977case OP_Lt: /* same as TK_LT, jump, in1, in3 */
1978case OP_Le: /* same as TK_LE, jump, in1, in3 */
1979case OP_Gt: /* same as TK_GT, jump, in1, in3 */
1980case OP_Ge: { /* same as TK_GE, jump, in1, in3 */
drh4910a762016-09-03 01:46:15 +00001981 int res, res2; /* Result of the comparison of pIn1 against pIn3 */
drh6a2fe092009-09-23 02:29:36 +00001982 char affinity; /* Affinity to use for comparison */
danb7dca7d2010-03-05 16:32:12 +00001983 u16 flags1; /* Copy of initial value of pIn1->flags */
1984 u16 flags3; /* Copy of initial value of pIn3->flags */
danielk1977a37cdde2004-05-16 11:15:36 +00001985
drh3c657212009-11-17 23:59:58 +00001986 pIn1 = &aMem[pOp->p1];
1987 pIn3 = &aMem[pOp->p3];
danb7dca7d2010-03-05 16:32:12 +00001988 flags1 = pIn1->flags;
1989 flags3 = pIn3->flags;
drhc3f1d5f2011-05-30 23:42:16 +00001990 if( (flags1 | flags3)&MEM_Null ){
drh6a2fe092009-09-23 02:29:36 +00001991 /* One or both operands are NULL */
1992 if( pOp->p5 & SQLITE_NULLEQ ){
1993 /* If SQLITE_NULLEQ is set (which will only happen if the operator is
1994 ** OP_Eq or OP_Ne) then take the jump or not depending on whether
1995 ** or not both operands are null.
1996 */
1997 assert( pOp->opcode==OP_Eq || pOp->opcode==OP_Ne );
drh053a1282012-09-19 21:15:46 +00001998 assert( (flags1 & MEM_Cleared)==0 );
drh3d77dee2014-02-19 14:20:49 +00001999 assert( (pOp->p5 & SQLITE_JUMPIFNULL)==0 );
drhc3191d22016-10-18 16:36:15 +00002000 if( (flags1&flags3&MEM_Null)!=0
drh053a1282012-09-19 21:15:46 +00002001 && (flags3&MEM_Cleared)==0
2002 ){
drh4910a762016-09-03 01:46:15 +00002003 res = 0; /* Operands are equal */
drh053a1282012-09-19 21:15:46 +00002004 }else{
drh4910a762016-09-03 01:46:15 +00002005 res = 1; /* Operands are not equal */
drh053a1282012-09-19 21:15:46 +00002006 }
drh6a2fe092009-09-23 02:29:36 +00002007 }else{
2008 /* SQLITE_NULLEQ is clear and at least one operand is NULL,
2009 ** then the result is always NULL.
2010 ** The jump is taken if the SQLITE_JUMPIFNULL bit is set.
2011 */
drh688852a2014-02-17 22:40:43 +00002012 if( pOp->p5 & SQLITE_STOREP2 ){
drha6c2ed92009-11-14 23:22:23 +00002013 pOut = &aMem[pOp->p2];
drh4910a762016-09-03 01:46:15 +00002014 iCompare = 1; /* Operands are not equal */
danb1d6b532015-12-14 19:42:19 +00002015 memAboutToChange(p, pOut);
drh6a2fe092009-09-23 02:29:36 +00002016 MemSetTypeFlag(pOut, MEM_Null);
2017 REGISTER_TRACE(pOp->p2, pOut);
drh688852a2014-02-17 22:40:43 +00002018 }else{
drhf4345e42014-02-18 11:31:59 +00002019 VdbeBranchTaken(2,3);
drh688852a2014-02-17 22:40:43 +00002020 if( pOp->p5 & SQLITE_JUMPIFNULL ){
drhf56fa462015-04-13 21:39:54 +00002021 goto jump_to_p2;
drh688852a2014-02-17 22:40:43 +00002022 }
drh6a2fe092009-09-23 02:29:36 +00002023 }
2024 break;
danielk1977a37cdde2004-05-16 11:15:36 +00002025 }
drh6a2fe092009-09-23 02:29:36 +00002026 }else{
2027 /* Neither operand is NULL. Do a comparison. */
2028 affinity = pOp->p5 & SQLITE_AFF_MASK;
drh24a09622014-09-18 16:28:59 +00002029 if( affinity>=SQLITE_AFF_NUMERIC ){
drh5fd0c122016-04-04 13:46:24 +00002030 if( (flags1 | flags3)&MEM_Str ){
2031 if( (flags1 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
2032 applyNumericAffinity(pIn1,0);
drh64caee42016-09-09 19:33:00 +00002033 testcase( flags3!=pIn3->flags ); /* Possible if pIn1==pIn3 */
drh4b37cd42016-06-25 11:43:47 +00002034 flags3 = pIn3->flags;
drh5fd0c122016-04-04 13:46:24 +00002035 }
2036 if( (flags3 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
2037 applyNumericAffinity(pIn3,0);
2038 }
drh24a09622014-09-18 16:28:59 +00002039 }
drh64caee42016-09-09 19:33:00 +00002040 /* Handle the common case of integer comparison here, as an
2041 ** optimization, to avoid a call to sqlite3MemCompare() */
2042 if( (pIn1->flags & pIn3->flags & MEM_Int)!=0 ){
2043 if( pIn3->u.i > pIn1->u.i ){ res = +1; goto compare_op; }
2044 if( pIn3->u.i < pIn1->u.i ){ res = -1; goto compare_op; }
2045 res = 0;
2046 goto compare_op;
2047 }
drh24a09622014-09-18 16:28:59 +00002048 }else if( affinity==SQLITE_AFF_TEXT ){
drhe5520e22015-12-31 04:34:26 +00002049 if( (flags1 & MEM_Str)==0 && (flags1 & (MEM_Int|MEM_Real))!=0 ){
drhe7a34662014-09-19 22:44:20 +00002050 testcase( pIn1->flags & MEM_Int );
2051 testcase( pIn1->flags & MEM_Real );
drh24a09622014-09-18 16:28:59 +00002052 sqlite3VdbeMemStringify(pIn1, encoding, 1);
drhbc8a6b32015-03-31 11:42:23 +00002053 testcase( (flags1&MEM_Dyn) != (pIn1->flags&MEM_Dyn) );
2054 flags1 = (pIn1->flags & ~MEM_TypeMask) | (flags1 & MEM_TypeMask);
drh21e19b42016-09-15 14:54:51 +00002055 assert( pIn1!=pIn3 );
drh24a09622014-09-18 16:28:59 +00002056 }
drhe5520e22015-12-31 04:34:26 +00002057 if( (flags3 & MEM_Str)==0 && (flags3 & (MEM_Int|MEM_Real))!=0 ){
drhe7a34662014-09-19 22:44:20 +00002058 testcase( pIn3->flags & MEM_Int );
2059 testcase( pIn3->flags & MEM_Real );
drh24a09622014-09-18 16:28:59 +00002060 sqlite3VdbeMemStringify(pIn3, encoding, 1);
drhbc8a6b32015-03-31 11:42:23 +00002061 testcase( (flags3&MEM_Dyn) != (pIn3->flags&MEM_Dyn) );
2062 flags3 = (pIn3->flags & ~MEM_TypeMask) | (flags3 & MEM_TypeMask);
drh24a09622014-09-18 16:28:59 +00002063 }
drh6a2fe092009-09-23 02:29:36 +00002064 }
drh6a2fe092009-09-23 02:29:36 +00002065 assert( pOp->p4type==P4_COLLSEQ || pOp->p4.pColl==0 );
drh4910a762016-09-03 01:46:15 +00002066 res = sqlite3MemCompare(pIn3, pIn1, pOp->p4.pColl);
drhe51c44f2004-05-30 20:46:09 +00002067 }
drh64caee42016-09-09 19:33:00 +00002068compare_op:
danielk1977a37cdde2004-05-16 11:15:36 +00002069 switch( pOp->opcode ){
drh4910a762016-09-03 01:46:15 +00002070 case OP_Eq: res2 = res==0; break;
2071 case OP_Ne: res2 = res; break;
2072 case OP_Lt: res2 = res<0; break;
2073 case OP_Le: res2 = res<=0; break;
2074 case OP_Gt: res2 = res>0; break;
2075 default: res2 = res>=0; break;
danielk1977a37cdde2004-05-16 11:15:36 +00002076 }
2077
drhf56fa462015-04-13 21:39:54 +00002078 /* Undo any changes made by applyAffinity() to the input registers. */
2079 assert( (pIn1->flags & MEM_Dyn) == (flags1 & MEM_Dyn) );
2080 pIn1->flags = flags1;
2081 assert( (pIn3->flags & MEM_Dyn) == (flags3 & MEM_Dyn) );
2082 pIn3->flags = flags3;
2083
drh35573352008-01-08 23:54:25 +00002084 if( pOp->p5 & SQLITE_STOREP2 ){
drha6c2ed92009-11-14 23:22:23 +00002085 pOut = &aMem[pOp->p2];
drh4910a762016-09-03 01:46:15 +00002086 iCompare = res;
2087 res2 = res2!=0; /* For this path res2 must be exactly 0 or 1 */
drh3fffbf92016-09-05 15:02:41 +00002088 if( (pOp->p5 & SQLITE_KEEPNULL)!=0 ){
drh79752b62016-08-13 10:02:17 +00002089 /* The KEEPNULL flag prevents OP_Eq from overwriting a NULL with 1
drh3fffbf92016-09-05 15:02:41 +00002090 ** and prevents OP_Ne from overwriting NULL with 0. This flag
2091 ** is only used in contexts where either:
2092 ** (1) op==OP_Eq && (r[P2]==NULL || r[P2]==0)
2093 ** (2) op==OP_Ne && (r[P2]==NULL || r[P2]==1)
2094 ** Therefore it is not necessary to check the content of r[P2] for
2095 ** NULL. */
drh79752b62016-08-13 10:02:17 +00002096 assert( pOp->opcode==OP_Ne || pOp->opcode==OP_Eq );
drh4910a762016-09-03 01:46:15 +00002097 assert( res2==0 || res2==1 );
drh3fffbf92016-09-05 15:02:41 +00002098 testcase( res2==0 && pOp->opcode==OP_Eq );
2099 testcase( res2==1 && pOp->opcode==OP_Eq );
2100 testcase( res2==0 && pOp->opcode==OP_Ne );
2101 testcase( res2==1 && pOp->opcode==OP_Ne );
drh4910a762016-09-03 01:46:15 +00002102 if( (pOp->opcode==OP_Eq)==res2 ) break;
drh79752b62016-08-13 10:02:17 +00002103 }
drh2b4ded92010-09-27 21:09:31 +00002104 memAboutToChange(p, pOut);
danielk1977a7a8e142008-02-13 18:25:27 +00002105 MemSetTypeFlag(pOut, MEM_Int);
drh4910a762016-09-03 01:46:15 +00002106 pOut->u.i = res2;
drh35573352008-01-08 23:54:25 +00002107 REGISTER_TRACE(pOp->p2, pOut);
drh688852a2014-02-17 22:40:43 +00002108 }else{
drhf4345e42014-02-18 11:31:59 +00002109 VdbeBranchTaken(res!=0, (pOp->p5 & SQLITE_NULLEQ)?2:3);
drh4910a762016-09-03 01:46:15 +00002110 if( res2 ){
drhf56fa462015-04-13 21:39:54 +00002111 goto jump_to_p2;
drh688852a2014-02-17 22:40:43 +00002112 }
danielk1977a37cdde2004-05-16 11:15:36 +00002113 }
2114 break;
2115}
drhc9b84a12002-06-20 11:36:48 +00002116
drh79752b62016-08-13 10:02:17 +00002117/* Opcode: ElseNotEq * P2 * * *
2118**
drhfd7459e2016-09-17 17:39:01 +00002119** This opcode must immediately follow an OP_Lt or OP_Gt comparison operator.
2120** If result of an OP_Eq comparison on the same two operands
2121** would have be NULL or false (0), then then jump to P2.
2122** If the result of an OP_Eq comparison on the two previous operands
2123** would have been true (1), then fall through.
drh79752b62016-08-13 10:02:17 +00002124*/
2125case OP_ElseNotEq: { /* same as TK_ESCAPE, jump */
2126 assert( pOp>aOp );
2127 assert( pOp[-1].opcode==OP_Lt || pOp[-1].opcode==OP_Gt );
drh4910a762016-09-03 01:46:15 +00002128 assert( pOp[-1].p5 & SQLITE_STOREP2 );
drh0f825a72016-08-13 14:17:02 +00002129 VdbeBranchTaken(iCompare!=0, 2);
2130 if( iCompare!=0 ) goto jump_to_p2;
drh79752b62016-08-13 10:02:17 +00002131 break;
2132}
2133
2134
drh0acb7e42008-06-25 00:12:41 +00002135/* Opcode: Permutation * * * P4 *
2136**
drhb7dab702017-01-26 18:00:00 +00002137** Set the permutation used by the OP_Compare operator in the next
2138** instruction. The permutation is stored in the P4 operand.
drh0acb7e42008-06-25 00:12:41 +00002139**
drh953f7612012-12-07 22:18:54 +00002140** The permutation is only valid until the next OP_Compare that has
2141** the OPFLAG_PERMUTE bit set in P5. Typically the OP_Permutation should
2142** occur immediately prior to the OP_Compare.
drhb1702022016-01-30 00:45:18 +00002143**
2144** The first integer in the P4 integer array is the length of the array
2145** and does not become part of the permutation.
drh0acb7e42008-06-25 00:12:41 +00002146*/
2147case OP_Permutation: {
2148 assert( pOp->p4type==P4_INTARRAY );
2149 assert( pOp->p4.ai );
drhb7dab702017-01-26 18:00:00 +00002150 assert( pOp[1].opcode==OP_Compare );
2151 assert( pOp[1].p5 & OPFLAG_PERMUTE );
drh0acb7e42008-06-25 00:12:41 +00002152 break;
2153}
2154
drh953f7612012-12-07 22:18:54 +00002155/* Opcode: Compare P1 P2 P3 P4 P5
drh079a3072014-03-19 14:10:55 +00002156** Synopsis: r[P1@P3] <-> r[P2@P3]
drh16ee60f2008-06-20 18:13:25 +00002157**
drh710c4842010-08-30 01:17:20 +00002158** Compare two vectors of registers in reg(P1)..reg(P1+P3-1) (call this
2159** vector "A") and in reg(P2)..reg(P2+P3-1) ("B"). Save the result of
drh16ee60f2008-06-20 18:13:25 +00002160** the comparison for use by the next OP_Jump instruct.
2161**
drh0ca10df2012-12-08 13:26:23 +00002162** If P5 has the OPFLAG_PERMUTE bit set, then the order of comparison is
2163** determined by the most recent OP_Permutation operator. If the
2164** OPFLAG_PERMUTE bit is clear, then register are compared in sequential
2165** order.
2166**
drh0acb7e42008-06-25 00:12:41 +00002167** P4 is a KeyInfo structure that defines collating sequences and sort
2168** orders for the comparison. The permutation applies to registers
2169** only. The KeyInfo elements are used sequentially.
2170**
2171** The comparison is a sort comparison, so NULLs compare equal,
2172** NULLs are less than numbers, numbers are less than strings,
drh16ee60f2008-06-20 18:13:25 +00002173** and strings are less than blobs.
2174*/
2175case OP_Compare: {
drh856c1032009-06-02 15:21:42 +00002176 int n;
2177 int i;
2178 int p1;
2179 int p2;
2180 const KeyInfo *pKeyInfo;
2181 int idx;
2182 CollSeq *pColl; /* Collating sequence to use on this term */
2183 int bRev; /* True for DESCENDING sort order */
drhb7dab702017-01-26 18:00:00 +00002184 int *aPermute; /* The permutation */
drh856c1032009-06-02 15:21:42 +00002185
drhb7dab702017-01-26 18:00:00 +00002186 if( (pOp->p5 & OPFLAG_PERMUTE)==0 ){
2187 aPermute = 0;
2188 }else{
2189 assert( pOp>aOp );
2190 assert( pOp[-1].opcode==OP_Permutation );
2191 assert( pOp[-1].p4type==P4_INTARRAY );
2192 aPermute = pOp[-1].p4.ai + 1;
2193 assert( aPermute!=0 );
2194 }
drh856c1032009-06-02 15:21:42 +00002195 n = pOp->p3;
2196 pKeyInfo = pOp->p4.pKeyInfo;
drh16ee60f2008-06-20 18:13:25 +00002197 assert( n>0 );
drh93a960a2008-07-10 00:32:42 +00002198 assert( pKeyInfo!=0 );
drh16ee60f2008-06-20 18:13:25 +00002199 p1 = pOp->p1;
drh16ee60f2008-06-20 18:13:25 +00002200 p2 = pOp->p2;
drhd879e3e2017-02-13 13:35:55 +00002201#ifdef SQLITE_DEBUG
drh6a2fe092009-09-23 02:29:36 +00002202 if( aPermute ){
2203 int k, mx = 0;
2204 for(k=0; k<n; k++) if( aPermute[k]>mx ) mx = aPermute[k];
drh9f6168b2016-03-19 23:32:58 +00002205 assert( p1>0 && p1+mx<=(p->nMem+1 - p->nCursor)+1 );
2206 assert( p2>0 && p2+mx<=(p->nMem+1 - p->nCursor)+1 );
drh6a2fe092009-09-23 02:29:36 +00002207 }else{
drh9f6168b2016-03-19 23:32:58 +00002208 assert( p1>0 && p1+n<=(p->nMem+1 - p->nCursor)+1 );
2209 assert( p2>0 && p2+n<=(p->nMem+1 - p->nCursor)+1 );
drh6a2fe092009-09-23 02:29:36 +00002210 }
2211#endif /* SQLITE_DEBUG */
drh0acb7e42008-06-25 00:12:41 +00002212 for(i=0; i<n; i++){
drh856c1032009-06-02 15:21:42 +00002213 idx = aPermute ? aPermute[i] : i;
drh2b4ded92010-09-27 21:09:31 +00002214 assert( memIsValid(&aMem[p1+idx]) );
2215 assert( memIsValid(&aMem[p2+idx]) );
drha6c2ed92009-11-14 23:22:23 +00002216 REGISTER_TRACE(p1+idx, &aMem[p1+idx]);
2217 REGISTER_TRACE(p2+idx, &aMem[p2+idx]);
drh93a960a2008-07-10 00:32:42 +00002218 assert( i<pKeyInfo->nField );
2219 pColl = pKeyInfo->aColl[i];
2220 bRev = pKeyInfo->aSortOrder[i];
drha6c2ed92009-11-14 23:22:23 +00002221 iCompare = sqlite3MemCompare(&aMem[p1+idx], &aMem[p2+idx], pColl);
drh0acb7e42008-06-25 00:12:41 +00002222 if( iCompare ){
2223 if( bRev ) iCompare = -iCompare;
2224 break;
2225 }
drh16ee60f2008-06-20 18:13:25 +00002226 }
2227 break;
2228}
2229
2230/* Opcode: Jump P1 P2 P3 * *
2231**
2232** Jump to the instruction at address P1, P2, or P3 depending on whether
2233** in the most recent OP_Compare instruction the P1 vector was less than
2234** equal to, or greater than the P2 vector, respectively.
2235*/
drh0acb7e42008-06-25 00:12:41 +00002236case OP_Jump: { /* jump */
2237 if( iCompare<0 ){
drhf56fa462015-04-13 21:39:54 +00002238 VdbeBranchTaken(0,3); pOp = &aOp[pOp->p1 - 1];
drh0acb7e42008-06-25 00:12:41 +00002239 }else if( iCompare==0 ){
drhf56fa462015-04-13 21:39:54 +00002240 VdbeBranchTaken(1,3); pOp = &aOp[pOp->p2 - 1];
drh16ee60f2008-06-20 18:13:25 +00002241 }else{
drhf56fa462015-04-13 21:39:54 +00002242 VdbeBranchTaken(2,3); pOp = &aOp[pOp->p3 - 1];
drh16ee60f2008-06-20 18:13:25 +00002243 }
2244 break;
2245}
2246
drh5b6afba2008-01-05 16:29:28 +00002247/* Opcode: And P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00002248** Synopsis: r[P3]=(r[P1] && r[P2])
drh5e00f6c2001-09-13 13:46:56 +00002249**
drh5b6afba2008-01-05 16:29:28 +00002250** Take the logical AND of the values in registers P1 and P2 and
2251** write the result into register P3.
drh5e00f6c2001-09-13 13:46:56 +00002252**
drh5b6afba2008-01-05 16:29:28 +00002253** If either P1 or P2 is 0 (false) then the result is 0 even if
2254** the other input is NULL. A NULL and true or two NULLs give
2255** a NULL output.
drh5e00f6c2001-09-13 13:46:56 +00002256*/
drh5b6afba2008-01-05 16:29:28 +00002257/* Opcode: Or P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00002258** Synopsis: r[P3]=(r[P1] || r[P2])
drh5b6afba2008-01-05 16:29:28 +00002259**
2260** Take the logical OR of the values in register P1 and P2 and
2261** store the answer in register P3.
2262**
2263** If either P1 or P2 is nonzero (true) then the result is 1 (true)
2264** even if the other input is NULL. A NULL and false or two NULLs
2265** give a NULL output.
2266*/
2267case OP_And: /* same as TK_AND, in1, in2, out3 */
2268case OP_Or: { /* same as TK_OR, in1, in2, out3 */
drh856c1032009-06-02 15:21:42 +00002269 int v1; /* Left operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
2270 int v2; /* Right operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
drhbb113512002-05-27 01:04:51 +00002271
drh3c657212009-11-17 23:59:58 +00002272 pIn1 = &aMem[pOp->p1];
drh5b6afba2008-01-05 16:29:28 +00002273 if( pIn1->flags & MEM_Null ){
drhbb113512002-05-27 01:04:51 +00002274 v1 = 2;
drh5e00f6c2001-09-13 13:46:56 +00002275 }else{
drh5b6afba2008-01-05 16:29:28 +00002276 v1 = sqlite3VdbeIntValue(pIn1)!=0;
drhbb113512002-05-27 01:04:51 +00002277 }
drh3c657212009-11-17 23:59:58 +00002278 pIn2 = &aMem[pOp->p2];
drh5b6afba2008-01-05 16:29:28 +00002279 if( pIn2->flags & MEM_Null ){
drhbb113512002-05-27 01:04:51 +00002280 v2 = 2;
2281 }else{
drh5b6afba2008-01-05 16:29:28 +00002282 v2 = sqlite3VdbeIntValue(pIn2)!=0;
drhbb113512002-05-27 01:04:51 +00002283 }
2284 if( pOp->opcode==OP_And ){
drh5b6afba2008-01-05 16:29:28 +00002285 static const unsigned char and_logic[] = { 0, 0, 0, 0, 1, 2, 0, 2, 2 };
drhbb113512002-05-27 01:04:51 +00002286 v1 = and_logic[v1*3+v2];
2287 }else{
drh5b6afba2008-01-05 16:29:28 +00002288 static const unsigned char or_logic[] = { 0, 1, 2, 1, 1, 1, 2, 1, 2 };
drhbb113512002-05-27 01:04:51 +00002289 v1 = or_logic[v1*3+v2];
drh5e00f6c2001-09-13 13:46:56 +00002290 }
drh3c657212009-11-17 23:59:58 +00002291 pOut = &aMem[pOp->p3];
drhbb113512002-05-27 01:04:51 +00002292 if( v1==2 ){
danielk1977a7a8e142008-02-13 18:25:27 +00002293 MemSetTypeFlag(pOut, MEM_Null);
drhbb113512002-05-27 01:04:51 +00002294 }else{
drh5b6afba2008-01-05 16:29:28 +00002295 pOut->u.i = v1;
danielk1977a7a8e142008-02-13 18:25:27 +00002296 MemSetTypeFlag(pOut, MEM_Int);
drhbb113512002-05-27 01:04:51 +00002297 }
drh5e00f6c2001-09-13 13:46:56 +00002298 break;
2299}
2300
drhe99fa2a2008-12-15 15:27:51 +00002301/* Opcode: Not P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00002302** Synopsis: r[P2]= !r[P1]
drh5e00f6c2001-09-13 13:46:56 +00002303**
drhe99fa2a2008-12-15 15:27:51 +00002304** Interpret the value in register P1 as a boolean value. Store the
2305** boolean complement in register P2. If the value in register P1 is
2306** NULL, then a NULL is stored in P2.
drh5e00f6c2001-09-13 13:46:56 +00002307*/
drh93952eb2009-11-13 19:43:43 +00002308case OP_Not: { /* same as TK_NOT, in1, out2 */
drh3c657212009-11-17 23:59:58 +00002309 pIn1 = &aMem[pOp->p1];
2310 pOut = &aMem[pOp->p2];
drh0725cab2014-09-17 14:52:46 +00002311 sqlite3VdbeMemSetNull(pOut);
2312 if( (pIn1->flags & MEM_Null)==0 ){
2313 pOut->flags = MEM_Int;
2314 pOut->u.i = !sqlite3VdbeIntValue(pIn1);
drhe99fa2a2008-12-15 15:27:51 +00002315 }
drh5e00f6c2001-09-13 13:46:56 +00002316 break;
2317}
2318
drhe99fa2a2008-12-15 15:27:51 +00002319/* Opcode: BitNot P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00002320** Synopsis: r[P1]= ~r[P1]
drhbf4133c2001-10-13 02:59:08 +00002321**
drhe99fa2a2008-12-15 15:27:51 +00002322** Interpret the content of register P1 as an integer. Store the
2323** ones-complement of the P1 value into register P2. If P1 holds
2324** a NULL then store a NULL in P2.
drhbf4133c2001-10-13 02:59:08 +00002325*/
drh93952eb2009-11-13 19:43:43 +00002326case OP_BitNot: { /* same as TK_BITNOT, in1, out2 */
drh3c657212009-11-17 23:59:58 +00002327 pIn1 = &aMem[pOp->p1];
2328 pOut = &aMem[pOp->p2];
drh0725cab2014-09-17 14:52:46 +00002329 sqlite3VdbeMemSetNull(pOut);
2330 if( (pIn1->flags & MEM_Null)==0 ){
2331 pOut->flags = MEM_Int;
2332 pOut->u.i = ~sqlite3VdbeIntValue(pIn1);
drhe99fa2a2008-12-15 15:27:51 +00002333 }
drhbf4133c2001-10-13 02:59:08 +00002334 break;
2335}
2336
drh48f2d3b2011-09-16 01:34:43 +00002337/* Opcode: Once P1 P2 * * *
2338**
drhab087d42017-03-24 17:59:56 +00002339** Fall through to the next instruction the first time this opcode is
2340** encountered on each invocation of the byte-code program. Jump to P2
2341** on the second and all subsequent encounters during the same invocation.
2342**
2343** Top-level programs determine first invocation by comparing the P1
2344** operand against the P1 operand on the OP_Init opcode at the beginning
2345** of the program. If the P1 values differ, then fall through and make
2346** the P1 of this opcode equal to the P1 of OP_Init. If P1 values are
2347** the same then take the jump.
2348**
2349** For subprograms, there is a bitmask in the VdbeFrame that determines
2350** whether or not the jump should be taken. The bitmask is necessary
2351** because the self-altering code trick does not work for recursive
2352** triggers.
drh48f2d3b2011-09-16 01:34:43 +00002353*/
dan1d8cb212011-12-09 13:24:16 +00002354case OP_Once: { /* jump */
drhab087d42017-03-24 17:59:56 +00002355 u32 iAddr; /* Address of this instruction */
drh9e5eb9c2016-09-18 16:08:10 +00002356 assert( p->aOp[0].opcode==OP_Init );
drhab087d42017-03-24 17:59:56 +00002357 if( p->pFrame ){
2358 iAddr = (int)(pOp - p->aOp);
2359 if( (p->pFrame->aOnce[iAddr/8] & (1<<(iAddr & 7)))!=0 ){
2360 VdbeBranchTaken(1, 2);
drhab087d42017-03-24 17:59:56 +00002361 goto jump_to_p2;
2362 }
drh18333ef2017-03-24 18:38:41 +00002363 p->pFrame->aOnce[iAddr/8] |= 1<<(iAddr & 7);
dan1d8cb212011-12-09 13:24:16 +00002364 }else{
drhab087d42017-03-24 17:59:56 +00002365 if( p->aOp[0].p1==pOp->p1 ){
2366 VdbeBranchTaken(1, 2);
2367 goto jump_to_p2;
2368 }
dan1d8cb212011-12-09 13:24:16 +00002369 }
drhab087d42017-03-24 17:59:56 +00002370 VdbeBranchTaken(0, 2);
2371 pOp->p1 = p->aOp[0].p1;
dan1d8cb212011-12-09 13:24:16 +00002372 break;
2373}
2374
drh3c84ddf2008-01-09 02:15:38 +00002375/* Opcode: If P1 P2 P3 * *
drh5e00f6c2001-09-13 13:46:56 +00002376**
drhef8662b2011-06-20 21:47:58 +00002377** Jump to P2 if the value in register P1 is true. The value
drh3c84ddf2008-01-09 02:15:38 +00002378** is considered true if it is numeric and non-zero. If the value
drhe21a6e12014-08-01 18:00:24 +00002379** in P1 is NULL then take the jump if and only if P3 is non-zero.
drh5e00f6c2001-09-13 13:46:56 +00002380*/
drh3c84ddf2008-01-09 02:15:38 +00002381/* Opcode: IfNot P1 P2 P3 * *
drhf5905aa2002-05-26 20:54:33 +00002382**
drhef8662b2011-06-20 21:47:58 +00002383** Jump to P2 if the value in register P1 is False. The value
drhb8475df2011-12-09 16:21:19 +00002384** is considered false if it has a numeric value of zero. If the value
drhe21a6e12014-08-01 18:00:24 +00002385** in P1 is NULL then take the jump if and only if P3 is non-zero.
drhf5905aa2002-05-26 20:54:33 +00002386*/
drh9cbf3422008-01-17 16:22:13 +00002387case OP_If: /* jump, in1 */
2388case OP_IfNot: { /* jump, in1 */
drh5e00f6c2001-09-13 13:46:56 +00002389 int c;
drh3c657212009-11-17 23:59:58 +00002390 pIn1 = &aMem[pOp->p1];
drh3c84ddf2008-01-09 02:15:38 +00002391 if( pIn1->flags & MEM_Null ){
2392 c = pOp->p3;
drhf5905aa2002-05-26 20:54:33 +00002393 }else{
drhba0232a2005-06-06 17:27:19 +00002394#ifdef SQLITE_OMIT_FLOATING_POINT
shanefbd60f82009-02-04 03:59:25 +00002395 c = sqlite3VdbeIntValue(pIn1)!=0;
drhba0232a2005-06-06 17:27:19 +00002396#else
drh3c84ddf2008-01-09 02:15:38 +00002397 c = sqlite3VdbeRealValue(pIn1)!=0.0;
drhba0232a2005-06-06 17:27:19 +00002398#endif
drhf5905aa2002-05-26 20:54:33 +00002399 if( pOp->opcode==OP_IfNot ) c = !c;
2400 }
drh688852a2014-02-17 22:40:43 +00002401 VdbeBranchTaken(c!=0, 2);
drh3c84ddf2008-01-09 02:15:38 +00002402 if( c ){
drhf56fa462015-04-13 21:39:54 +00002403 goto jump_to_p2;
drh3c84ddf2008-01-09 02:15:38 +00002404 }
drh5e00f6c2001-09-13 13:46:56 +00002405 break;
2406}
2407
drh830ecf92009-06-18 00:41:55 +00002408/* Opcode: IsNull P1 P2 * * *
drh72e26de2016-08-24 21:24:04 +00002409** Synopsis: if r[P1]==NULL goto P2
drh477df4b2008-01-05 18:48:24 +00002410**
drh830ecf92009-06-18 00:41:55 +00002411** Jump to P2 if the value in register P1 is NULL.
drh477df4b2008-01-05 18:48:24 +00002412*/
drh9cbf3422008-01-17 16:22:13 +00002413case OP_IsNull: { /* same as TK_ISNULL, jump, in1 */
drh3c657212009-11-17 23:59:58 +00002414 pIn1 = &aMem[pOp->p1];
drh688852a2014-02-17 22:40:43 +00002415 VdbeBranchTaken( (pIn1->flags & MEM_Null)!=0, 2);
drh830ecf92009-06-18 00:41:55 +00002416 if( (pIn1->flags & MEM_Null)!=0 ){
drhf56fa462015-04-13 21:39:54 +00002417 goto jump_to_p2;
drh830ecf92009-06-18 00:41:55 +00002418 }
drh477df4b2008-01-05 18:48:24 +00002419 break;
2420}
2421
drh98757152008-01-09 23:04:12 +00002422/* Opcode: NotNull P1 P2 * * *
drhfc8d4f92013-11-08 15:19:46 +00002423** Synopsis: if r[P1]!=NULL goto P2
drh5e00f6c2001-09-13 13:46:56 +00002424**
drh6a288a32008-01-07 19:20:24 +00002425** Jump to P2 if the value in register P1 is not NULL.
drh5e00f6c2001-09-13 13:46:56 +00002426*/
drh9cbf3422008-01-17 16:22:13 +00002427case OP_NotNull: { /* same as TK_NOTNULL, jump, in1 */
drh3c657212009-11-17 23:59:58 +00002428 pIn1 = &aMem[pOp->p1];
drh688852a2014-02-17 22:40:43 +00002429 VdbeBranchTaken( (pIn1->flags & MEM_Null)==0, 2);
drh6a288a32008-01-07 19:20:24 +00002430 if( (pIn1->flags & MEM_Null)==0 ){
drhf56fa462015-04-13 21:39:54 +00002431 goto jump_to_p2;
drh6a288a32008-01-07 19:20:24 +00002432 }
drh5e00f6c2001-09-13 13:46:56 +00002433 break;
2434}
2435
drh31d6fd52017-04-14 19:03:10 +00002436/* Opcode: IfNullRow P1 P2 P3 * *
2437** Synopsis: if P1.nullRow then r[P3]=NULL, goto P2
2438**
2439** Check the cursor P1 to see if it is currently pointing at a NULL row.
2440** If it is, then set register P3 to NULL and jump immediately to P2.
2441** If P1 is not on a NULL row, then fall through without making any
2442** changes.
2443*/
2444case OP_IfNullRow: { /* jump */
2445 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh3f1e9e02017-05-23 01:21:07 +00002446 assert( p->apCsr[pOp->p1]!=0 );
drh31d6fd52017-04-14 19:03:10 +00002447 if( p->apCsr[pOp->p1]->nullRow ){
2448 sqlite3VdbeMemSetNull(aMem + pOp->p3);
2449 goto jump_to_p2;
2450 }
2451 break;
2452}
2453
drh3e9ca092009-09-08 01:14:48 +00002454/* Opcode: Column P1 P2 P3 P4 P5
drh72e26de2016-08-24 21:24:04 +00002455** Synopsis: r[P3]=PX
danielk1977192ac1d2004-05-10 07:17:30 +00002456**
danielk1977cfcdaef2004-05-12 07:33:33 +00002457** Interpret the data that cursor P1 points to as a structure built using
2458** the MakeRecord instruction. (See the MakeRecord opcode for additional
drhd4e70eb2008-01-02 00:34:36 +00002459** information about the format of the data.) Extract the P2-th column
2460** from this record. If there are less that (P2+1)
2461** values in the record, extract a NULL.
2462**
drh9cbf3422008-01-17 16:22:13 +00002463** The value extracted is stored in register P3.
danielk1977192ac1d2004-05-10 07:17:30 +00002464**
drh1cc3a362017-04-03 13:17:31 +00002465** If the record contains fewer than P2 fields, then extract a NULL. Or,
danielk19771f4aa332008-01-03 09:51:55 +00002466** if the P4 argument is a P4_MEM use the value of the P4 argument as
2467** the result.
drh3e9ca092009-09-08 01:14:48 +00002468**
2469** If the OPFLAG_CLEARCACHE bit is set on P5 and P1 is a pseudo-table cursor,
2470** then the cache of the cursor is reset prior to extracting the column.
2471** The first OP_Column against a pseudo-table after the value of the content
2472** register has changed should have this bit set.
drha748fdc2012-03-28 01:34:47 +00002473**
drh1cc3a362017-04-03 13:17:31 +00002474** If the OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG bits are set on P5 then
drhdda5c082012-03-28 13:41:10 +00002475** the result is guaranteed to only be used as the argument of a length()
2476** or typeof() function, respectively. The loading of large blobs can be
2477** skipped for length() and all content loading can be skipped for typeof().
danielk1977192ac1d2004-05-10 07:17:30 +00002478*/
danielk1977cfcdaef2004-05-12 07:33:33 +00002479case OP_Column: {
drh856c1032009-06-02 15:21:42 +00002480 int p2; /* column number to retrieve */
2481 VdbeCursor *pC; /* The VDBE cursor */
drhd3194f52004-05-27 19:59:32 +00002482 BtCursor *pCrsr; /* The BTree cursor */
drhd3194f52004-05-27 19:59:32 +00002483 u32 *aOffset; /* aOffset[i] is offset to start of data for i-th column */
danielk1977cfcdaef2004-05-12 07:33:33 +00002484 int len; /* The length of the serialized data for the column */
drhd3194f52004-05-27 19:59:32 +00002485 int i; /* Loop counter */
drhd4e70eb2008-01-02 00:34:36 +00002486 Mem *pDest; /* Where to write the extracted value */
drhd3194f52004-05-27 19:59:32 +00002487 Mem sMem; /* For storing the record being decoded */
drh399af1d2013-11-20 17:25:55 +00002488 const u8 *zData; /* Part of the record being decoded */
2489 const u8 *zHdr; /* Next unparsed byte of the header */
2490 const u8 *zEndHdr; /* Pointer to first byte after the header */
drh35cd6432009-06-05 14:17:21 +00002491 u32 offset; /* Offset into the data */
drhc6ce38832015-10-15 21:30:24 +00002492 u64 offset64; /* 64-bit offset */
drh501932c2013-11-21 21:59:53 +00002493 u32 avail; /* Number of bytes of available data */
drh5a077b72011-08-29 02:16:18 +00002494 u32 t; /* A type code from the record header */
drh3e9ca092009-09-08 01:14:48 +00002495 Mem *pReg; /* PseudoTable input register */
danielk1977192ac1d2004-05-10 07:17:30 +00002496
dande892d92016-01-29 19:29:45 +00002497 pC = p->apCsr[pOp->p1];
drh856c1032009-06-02 15:21:42 +00002498 p2 = pOp->p2;
dande892d92016-01-29 19:29:45 +00002499
drh170ad682017-06-02 15:44:22 +00002500 /* If the cursor cache is stale (meaning it is not currently point at
2501 ** the correct row) then bring it up-to-date by doing the necessary
2502 ** B-Tree seek. */
dande892d92016-01-29 19:29:45 +00002503 rc = sqlite3VdbeCursorMoveto(&pC, &p2);
drh4ca239f2016-05-19 11:12:43 +00002504 if( rc ) goto abort_due_to_error;
dande892d92016-01-29 19:29:45 +00002505
drh9f6168b2016-03-19 23:32:58 +00002506 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
drha6c2ed92009-11-14 23:22:23 +00002507 pDest = &aMem[pOp->p3];
drh2b4ded92010-09-27 21:09:31 +00002508 memAboutToChange(p, pDest);
drhc8606e42013-11-20 19:28:03 +00002509 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
danielk19776c924092007-11-12 08:09:34 +00002510 assert( pC!=0 );
drhc8606e42013-11-20 19:28:03 +00002511 assert( p2<pC->nField );
drhb53a5a92014-10-12 22:37:22 +00002512 aOffset = pC->aOffset;
drh62aaa6c2015-11-21 17:27:42 +00002513 assert( pC->eCurType!=CURTYPE_VTAB );
drhc960dcb2015-11-20 19:22:01 +00002514 assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
2515 assert( pC->eCurType!=CURTYPE_SORTER );
drh399af1d2013-11-20 17:25:55 +00002516
drha43a02e2016-05-19 17:51:19 +00002517 if( pC->cacheStatus!=p->cacheCtr ){ /*OPTIMIZATION-IF-FALSE*/
danielk1977192ac1d2004-05-10 07:17:30 +00002518 if( pC->nullRow ){
drhc960dcb2015-11-20 19:22:01 +00002519 if( pC->eCurType==CURTYPE_PSEUDO ){
2520 assert( pC->uc.pseudoTableReg>0 );
2521 pReg = &aMem[pC->uc.pseudoTableReg];
drhc8606e42013-11-20 19:28:03 +00002522 assert( pReg->flags & MEM_Blob );
2523 assert( memIsValid(pReg) );
2524 pC->payloadSize = pC->szRow = avail = pReg->n;
2525 pC->aRow = (u8*)pReg->z;
2526 }else{
drh6b5631e2014-11-05 15:57:39 +00002527 sqlite3VdbeMemSetNull(pDest);
drh399af1d2013-11-20 17:25:55 +00002528 goto op_column_out;
2529 }
danielk1977192ac1d2004-05-10 07:17:30 +00002530 }else{
drh06a09a82016-11-25 17:03:03 +00002531 pCrsr = pC->uc.pCursor;
drhc960dcb2015-11-20 19:22:01 +00002532 assert( pC->eCurType==CURTYPE_BTREE );
drhc8606e42013-11-20 19:28:03 +00002533 assert( pCrsr );
drha7c90c42016-06-04 20:37:10 +00002534 assert( sqlite3BtreeCursorIsValid(pCrsr) );
2535 pC->payloadSize = sqlite3BtreePayloadSize(pCrsr);
2536 pC->aRow = sqlite3BtreePayloadFetch(pCrsr, &avail);
drh399af1d2013-11-20 17:25:55 +00002537 assert( avail<=65536 ); /* Maximum page size is 64KiB */
2538 if( pC->payloadSize <= (u32)avail ){
2539 pC->szRow = pC->payloadSize;
drh5f7dacb2015-11-20 13:33:56 +00002540 }else if( pC->payloadSize > (u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
2541 goto too_big;
drhe61cffc2004-06-12 18:12:15 +00002542 }else{
drh399af1d2013-11-20 17:25:55 +00002543 pC->szRow = avail;
2544 }
danielk1977192ac1d2004-05-10 07:17:30 +00002545 }
drhd3194f52004-05-27 19:59:32 +00002546 pC->cacheStatus = p->cacheCtr;
drh399af1d2013-11-20 17:25:55 +00002547 pC->iHdrOffset = getVarint32(pC->aRow, offset);
2548 pC->nHdrParsed = 0;
2549 aOffset[0] = offset;
drh35cd6432009-06-05 14:17:21 +00002550
drhc81aa2e2014-10-11 23:31:52 +00002551
drha43a02e2016-05-19 17:51:19 +00002552 if( avail<offset ){ /*OPTIMIZATION-IF-FALSE*/
drhc81aa2e2014-10-11 23:31:52 +00002553 /* pC->aRow does not have to hold the entire row, but it does at least
2554 ** need to cover the header of the record. If pC->aRow does not contain
2555 ** the complete header, then set it to zero, forcing the header to be
2556 ** dynamically allocated. */
2557 pC->aRow = 0;
2558 pC->szRow = 0;
drh848a3322015-10-16 12:53:47 +00002559
2560 /* Make sure a corrupt database has not given us an oversize header.
2561 ** Do this now to avoid an oversize memory allocation.
2562 **
2563 ** Type entries can be between 1 and 5 bytes each. But 4 and 5 byte
2564 ** types use so much data space that there can only be 4096 and 32 of
2565 ** them, respectively. So the maximum header length results from a
2566 ** 3-byte type for each of the maximum of 32768 columns plus three
2567 ** extra bytes for the header length itself. 32768*3 + 3 = 98307.
2568 */
2569 if( offset > 98307 || offset > pC->payloadSize ){
2570 rc = SQLITE_CORRUPT_BKPT;
drh9467abf2016-02-17 18:44:11 +00002571 goto abort_due_to_error;
drh848a3322015-10-16 12:53:47 +00002572 }
drh0eda6cd2016-05-19 16:58:42 +00002573 }else if( offset>0 ){ /*OPTIMIZATION-IF-TRUE*/
2574 /* The following goto is an optimization. It can be omitted and
2575 ** everything will still work. But OP_Column is measurably faster
2576 ** by skipping the subsequent conditional, which is always true.
2577 */
2578 zData = pC->aRow;
2579 assert( pC->nHdrParsed<=p2 ); /* Conditional skipped */
2580 goto op_column_read_header;
drhc81aa2e2014-10-11 23:31:52 +00002581 }
drh399af1d2013-11-20 17:25:55 +00002582 }
drh35cd6432009-06-05 14:17:21 +00002583
drh399af1d2013-11-20 17:25:55 +00002584 /* Make sure at least the first p2+1 entries of the header have been
drh0c8f7602014-09-19 16:56:45 +00002585 ** parsed and valid information is in aOffset[] and pC->aType[].
drh399af1d2013-11-20 17:25:55 +00002586 */
drhc8606e42013-11-20 19:28:03 +00002587 if( pC->nHdrParsed<=p2 ){
drh380d6852013-11-20 20:58:00 +00002588 /* If there is more header available for parsing in the record, try
2589 ** to extract additional fields up through the p2+1-th field
drh35cd6432009-06-05 14:17:21 +00002590 */
drhc8606e42013-11-20 19:28:03 +00002591 if( pC->iHdrOffset<aOffset[0] ){
2592 /* Make sure zData points to enough of the record to cover the header. */
2593 if( pC->aRow==0 ){
2594 memset(&sMem, 0, sizeof(sMem));
drhcb3cabd2016-11-25 19:18:28 +00002595 rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, 0, aOffset[0], &sMem);
drh9467abf2016-02-17 18:44:11 +00002596 if( rc!=SQLITE_OK ) goto abort_due_to_error;
drhc8606e42013-11-20 19:28:03 +00002597 zData = (u8*)sMem.z;
2598 }else{
2599 zData = pC->aRow;
drh9188b382004-05-14 21:12:22 +00002600 }
drhc8606e42013-11-20 19:28:03 +00002601
drh0c8f7602014-09-19 16:56:45 +00002602 /* Fill in pC->aType[i] and aOffset[i] values through the p2-th field. */
drh0eda6cd2016-05-19 16:58:42 +00002603 op_column_read_header:
drhc8606e42013-11-20 19:28:03 +00002604 i = pC->nHdrParsed;
drhc6ce38832015-10-15 21:30:24 +00002605 offset64 = aOffset[i];
drhc8606e42013-11-20 19:28:03 +00002606 zHdr = zData + pC->iHdrOffset;
2607 zEndHdr = zData + aOffset[0];
drhc8606e42013-11-20 19:28:03 +00002608 do{
drh95fa6062015-10-16 13:50:08 +00002609 if( (t = zHdr[0])<0x80 ){
drhc8606e42013-11-20 19:28:03 +00002610 zHdr++;
drhfaf37272015-10-16 14:23:42 +00002611 offset64 += sqlite3VdbeOneByteSerialTypeLen(t);
drh5a077b72011-08-29 02:16:18 +00002612 }else{
drhc8606e42013-11-20 19:28:03 +00002613 zHdr += sqlite3GetVarint32(zHdr, &t);
drhfaf37272015-10-16 14:23:42 +00002614 offset64 += sqlite3VdbeSerialTypeLen(t);
drh5a077b72011-08-29 02:16:18 +00002615 }
drhfaf37272015-10-16 14:23:42 +00002616 pC->aType[i++] = t;
drhc6ce38832015-10-15 21:30:24 +00002617 aOffset[i] = (u32)(offset64 & 0xffffffff);
drhc8606e42013-11-20 19:28:03 +00002618 }while( i<=p2 && zHdr<zEndHdr );
drh170c2762016-05-20 21:40:11 +00002619
drh8dd83622014-10-13 23:39:02 +00002620 /* The record is corrupt if any of the following are true:
2621 ** (1) the bytes of the header extend past the declared header size
drh8dd83622014-10-13 23:39:02 +00002622 ** (2) the entire header was used but not all data was used
drh8dd83622014-10-13 23:39:02 +00002623 ** (3) the end of the data extends beyond the end of the record.
drhc8606e42013-11-20 19:28:03 +00002624 */
drhc6ce38832015-10-15 21:30:24 +00002625 if( (zHdr>=zEndHdr && (zHdr>zEndHdr || offset64!=pC->payloadSize))
2626 || (offset64 > pC->payloadSize)
drhc8606e42013-11-20 19:28:03 +00002627 ){
drhddb2b4a2016-03-25 12:10:32 +00002628 if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
drhc8606e42013-11-20 19:28:03 +00002629 rc = SQLITE_CORRUPT_BKPT;
drh9467abf2016-02-17 18:44:11 +00002630 goto abort_due_to_error;
danielk1977dedf45b2006-01-13 17:12:01 +00002631 }
drhddb2b4a2016-03-25 12:10:32 +00002632
drh170c2762016-05-20 21:40:11 +00002633 pC->nHdrParsed = i;
2634 pC->iHdrOffset = (u32)(zHdr - zData);
2635 if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
mistachkin8c7cd6a2015-12-16 21:09:53 +00002636 }else{
drh9fbc8852016-01-04 03:48:46 +00002637 t = 0;
drh9188b382004-05-14 21:12:22 +00002638 }
drhd3194f52004-05-27 19:59:32 +00002639
drhf2db3382015-04-30 20:33:25 +00002640 /* If after trying to extract new entries from the header, nHdrParsed is
drh380d6852013-11-20 20:58:00 +00002641 ** still not up to p2, that means that the record has fewer than p2
2642 ** columns. So the result will be either the default value or a NULL.
drhd3194f52004-05-27 19:59:32 +00002643 */
drhc8606e42013-11-20 19:28:03 +00002644 if( pC->nHdrParsed<=p2 ){
2645 if( pOp->p4type==P4_MEM ){
2646 sqlite3VdbeMemShallowCopy(pDest, pOp->p4.pMem, MEM_Static);
2647 }else{
drh22e8d832014-10-29 00:58:38 +00002648 sqlite3VdbeMemSetNull(pDest);
drhc8606e42013-11-20 19:28:03 +00002649 }
danielk19773c9cc8d2005-01-17 03:40:08 +00002650 goto op_column_out;
drhd3194f52004-05-27 19:59:32 +00002651 }
drh95fa6062015-10-16 13:50:08 +00002652 }else{
2653 t = pC->aType[p2];
danielk1977cfcdaef2004-05-12 07:33:33 +00002654 }
danielk1977192ac1d2004-05-10 07:17:30 +00002655
drh380d6852013-11-20 20:58:00 +00002656 /* Extract the content for the p2+1-th column. Control can only
drh0c8f7602014-09-19 16:56:45 +00002657 ** reach this point if aOffset[p2], aOffset[p2+1], and pC->aType[p2] are
drh380d6852013-11-20 20:58:00 +00002658 ** all valid.
drh9188b382004-05-14 21:12:22 +00002659 */
drhc8606e42013-11-20 19:28:03 +00002660 assert( p2<pC->nHdrParsed );
2661 assert( rc==SQLITE_OK );
drh75fd0542014-03-01 16:24:44 +00002662 assert( sqlite3VdbeCheckMemInvariants(pDest) );
drha1851ef2016-05-20 19:51:28 +00002663 if( VdbeMemDynamic(pDest) ){
2664 sqlite3VdbeMemSetNull(pDest);
2665 }
drh95fa6062015-10-16 13:50:08 +00002666 assert( t==pC->aType[p2] );
drhc8606e42013-11-20 19:28:03 +00002667 if( pC->szRow>=aOffset[p2+1] ){
drh380d6852013-11-20 20:58:00 +00002668 /* This is the common case where the desired content fits on the original
2669 ** page - where the content is not on an overflow page */
drh69f6e252016-01-11 18:05:00 +00002670 zData = pC->aRow + aOffset[p2];
2671 if( t<12 ){
2672 sqlite3VdbeSerialGet(zData, t, pDest);
2673 }else{
2674 /* If the column value is a string, we need a persistent value, not
2675 ** a MEM_Ephem value. This branch is a fast short-cut that is equivalent
2676 ** to calling sqlite3VdbeSerialGet() and sqlite3VdbeDeephemeralize().
2677 */
2678 static const u16 aFlag[] = { MEM_Blob, MEM_Str|MEM_Term };
2679 pDest->n = len = (t-12)/2;
drha1851ef2016-05-20 19:51:28 +00002680 pDest->enc = encoding;
drh69f6e252016-01-11 18:05:00 +00002681 if( pDest->szMalloc < len+2 ){
2682 pDest->flags = MEM_Null;
2683 if( sqlite3VdbeMemGrow(pDest, len+2, 0) ) goto no_mem;
2684 }else{
2685 pDest->z = pDest->zMalloc;
2686 }
2687 memcpy(pDest->z, zData, len);
2688 pDest->z[len] = 0;
2689 pDest->z[len+1] = 0;
2690 pDest->flags = aFlag[t&1];
2691 }
danielk197736963fd2005-02-19 08:18:05 +00002692 }else{
drha1851ef2016-05-20 19:51:28 +00002693 pDest->enc = encoding;
drh58c96082013-12-23 11:33:32 +00002694 /* This branch happens only when content is on overflow pages */
drh380d6852013-11-20 20:58:00 +00002695 if( ((pOp->p5 & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG))!=0
2696 && ((t>=12 && (t&1)==0) || (pOp->p5 & OPFLAG_TYPEOFARG)!=0))
2697 || (len = sqlite3VdbeSerialTypeLen(t))==0
drhc8606e42013-11-20 19:28:03 +00002698 ){
drh2a2a6962014-09-16 18:22:44 +00002699 /* Content is irrelevant for
2700 ** 1. the typeof() function,
2701 ** 2. the length(X) function if X is a blob, and
2702 ** 3. if the content length is zero.
2703 ** So we might as well use bogus content rather than reading
dan1f9144e2017-03-17 13:59:06 +00002704 ** content from disk.
2705 **
2706 ** Although sqlite3VdbeSerialGet() may read at most 8 bytes from the
2707 ** buffer passed to it, debugging function VdbeMemPrettyPrint() may
2708 ** read up to 16. So 16 bytes of bogus content is supplied.
2709 */
2710 static u8 aZero[16]; /* This is the bogus content */
drh69f6e252016-01-11 18:05:00 +00002711 sqlite3VdbeSerialGet(aZero, t, pDest);
danielk1977aee18ef2005-03-09 12:26:50 +00002712 }else{
drhcb3cabd2016-11-25 19:18:28 +00002713 rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, aOffset[p2], len, pDest);
drh9467abf2016-02-17 18:44:11 +00002714 if( rc!=SQLITE_OK ) goto abort_due_to_error;
2715 sqlite3VdbeSerialGet((const u8*)pDest->z, t, pDest);
2716 pDest->flags &= ~MEM_Ephem;
danielk1977aee18ef2005-03-09 12:26:50 +00002717 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002718 }
drhd3194f52004-05-27 19:59:32 +00002719
danielk19773c9cc8d2005-01-17 03:40:08 +00002720op_column_out:
drhb7654112008-01-12 12:48:07 +00002721 UPDATE_MAX_BLOBSIZE(pDest);
drh5b6afba2008-01-05 16:29:28 +00002722 REGISTER_TRACE(pOp->p3, pDest);
danielk1977192ac1d2004-05-10 07:17:30 +00002723 break;
2724}
2725
danielk1977751de562008-04-18 09:01:15 +00002726/* Opcode: Affinity P1 P2 * P4 *
drhf63552b2013-10-30 00:25:03 +00002727** Synopsis: affinity(r[P1@P2])
danielk1977751de562008-04-18 09:01:15 +00002728**
2729** Apply affinities to a range of P2 registers starting with P1.
2730**
drhbb6783b2017-04-29 18:02:49 +00002731** P4 is a string that is P2 characters long. The N-th character of the
2732** string indicates the column affinity that should be used for the N-th
danielk1977751de562008-04-18 09:01:15 +00002733** memory cell in the range.
2734*/
2735case OP_Affinity: {
drh039fc322009-11-17 18:31:47 +00002736 const char *zAffinity; /* The affinity to be applied */
danielk1977751de562008-04-18 09:01:15 +00002737
drh856c1032009-06-02 15:21:42 +00002738 zAffinity = pOp->p4.z;
drh039fc322009-11-17 18:31:47 +00002739 assert( zAffinity!=0 );
drh662c50e2017-04-01 20:14:01 +00002740 assert( pOp->p2>0 );
drh039fc322009-11-17 18:31:47 +00002741 assert( zAffinity[pOp->p2]==0 );
2742 pIn1 = &aMem[pOp->p1];
drh662c50e2017-04-01 20:14:01 +00002743 do{
drh9f6168b2016-03-19 23:32:58 +00002744 assert( pIn1 <= &p->aMem[(p->nMem+1 - p->nCursor)] );
drh2b4ded92010-09-27 21:09:31 +00002745 assert( memIsValid(pIn1) );
drh662c50e2017-04-01 20:14:01 +00002746 applyAffinity(pIn1, *(zAffinity++), encoding);
drh039fc322009-11-17 18:31:47 +00002747 pIn1++;
drh662c50e2017-04-01 20:14:01 +00002748 }while( zAffinity[0] );
danielk1977751de562008-04-18 09:01:15 +00002749 break;
2750}
2751
drh1db639c2008-01-17 02:36:28 +00002752/* Opcode: MakeRecord P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00002753** Synopsis: r[P3]=mkrec(r[P1@P2])
drh7a224de2004-06-02 01:22:02 +00002754**
drh710c4842010-08-30 01:17:20 +00002755** Convert P2 registers beginning with P1 into the [record format]
2756** use as a data record in a database table or as a key
2757** in an index. The OP_Column opcode can decode the record later.
drh7a224de2004-06-02 01:22:02 +00002758**
drhbb6783b2017-04-29 18:02:49 +00002759** P4 may be a string that is P2 characters long. The N-th character of the
2760** string indicates the column affinity that should be used for the N-th
drh9cbf3422008-01-17 16:22:13 +00002761** field of the index key.
drh7a224de2004-06-02 01:22:02 +00002762**
drh8a512562005-11-14 22:29:05 +00002763** The mapping from character to affinity is given by the SQLITE_AFF_
2764** macros defined in sqliteInt.h.
drh7a224de2004-06-02 01:22:02 +00002765**
drh05883a32015-06-02 15:32:08 +00002766** If P4 is NULL then all index fields have the affinity BLOB.
drh7f057c92005-06-24 03:53:06 +00002767*/
drh1db639c2008-01-17 02:36:28 +00002768case OP_MakeRecord: {
drh856c1032009-06-02 15:21:42 +00002769 u8 *zNewRecord; /* A buffer to hold the data for the new record */
2770 Mem *pRec; /* The new record */
2771 u64 nData; /* Number of bytes of data space */
2772 int nHdr; /* Number of bytes of header space */
2773 i64 nByte; /* Data space required for this record */
drh4a335072015-04-11 02:08:48 +00002774 i64 nZero; /* Number of zero bytes at the end of the record */
drh856c1032009-06-02 15:21:42 +00002775 int nVarint; /* Number of bytes in a varint */
2776 u32 serial_type; /* Type field */
2777 Mem *pData0; /* First field to be combined into the record */
2778 Mem *pLast; /* Last field of the record */
2779 int nField; /* Number of fields in the record */
2780 char *zAffinity; /* The affinity string for the record */
2781 int file_format; /* File format to use for encoding */
drh59bf00c2013-12-08 23:33:28 +00002782 int i; /* Space used in zNewRecord[] header */
2783 int j; /* Space used in zNewRecord[] content */
drhbe37c122015-10-16 14:54:17 +00002784 u32 len; /* Length of a field */
drh856c1032009-06-02 15:21:42 +00002785
drhf3218fe2004-05-28 08:21:02 +00002786 /* Assuming the record contains N fields, the record format looks
2787 ** like this:
2788 **
drh7a224de2004-06-02 01:22:02 +00002789 ** ------------------------------------------------------------------------
2790 ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
2791 ** ------------------------------------------------------------------------
drhf3218fe2004-05-28 08:21:02 +00002792 **
drh9cbf3422008-01-17 16:22:13 +00002793 ** Data(0) is taken from register P1. Data(1) comes from register P1+1
peter.d.reid60ec9142014-09-06 16:39:46 +00002794 ** and so forth.
drhf3218fe2004-05-28 08:21:02 +00002795 **
2796 ** Each type field is a varint representing the serial type of the
2797 ** corresponding data element (see sqlite3VdbeSerialType()). The
drh7a224de2004-06-02 01:22:02 +00002798 ** hdr-size field is also a varint which is the offset from the beginning
2799 ** of the record to data0.
drhf3218fe2004-05-28 08:21:02 +00002800 */
drh856c1032009-06-02 15:21:42 +00002801 nData = 0; /* Number of bytes of data space */
2802 nHdr = 0; /* Number of bytes of header space */
drh856c1032009-06-02 15:21:42 +00002803 nZero = 0; /* Number of zero bytes at the end of the record */
drh1db639c2008-01-17 02:36:28 +00002804 nField = pOp->p1;
danielk19772dca4ac2008-01-03 11:50:29 +00002805 zAffinity = pOp->p4.z;
drh9f6168b2016-03-19 23:32:58 +00002806 assert( nField>0 && pOp->p2>0 && pOp->p2+nField<=(p->nMem+1 - p->nCursor)+1 );
drha6c2ed92009-11-14 23:22:23 +00002807 pData0 = &aMem[nField];
drh1db639c2008-01-17 02:36:28 +00002808 nField = pOp->p2;
2809 pLast = &pData0[nField-1];
drhd946db02005-12-29 19:23:06 +00002810 file_format = p->minWriteFileFormat;
danielk19778d059842004-05-12 11:24:02 +00002811
drh2b4ded92010-09-27 21:09:31 +00002812 /* Identify the output register */
2813 assert( pOp->p3<pOp->p1 || pOp->p3>=pOp->p1+pOp->p2 );
2814 pOut = &aMem[pOp->p3];
2815 memAboutToChange(p, pOut);
2816
drh3e6c0602013-12-10 20:53:01 +00002817 /* Apply the requested affinity to all inputs
2818 */
2819 assert( pData0<=pLast );
2820 if( zAffinity ){
2821 pRec = pData0;
2822 do{
drh57bf4a82014-02-17 14:59:22 +00002823 applyAffinity(pRec++, *(zAffinity++), encoding);
2824 assert( zAffinity[0]==0 || pRec<=pLast );
2825 }while( zAffinity[0] );
drh3e6c0602013-12-10 20:53:01 +00002826 }
2827
drhd447dce2017-01-25 20:55:11 +00002828#ifdef SQLITE_ENABLE_NULL_TRIM
drh585ce192017-01-25 14:58:27 +00002829 /* NULLs can be safely trimmed from the end of the record, as long as
2830 ** as the schema format is 2 or more and none of the omitted columns
2831 ** have a non-NULL default value. Also, the record must be left with
2832 ** at least one field. If P5>0 then it will be one more than the
2833 ** index of the right-most column with a non-NULL default value */
2834 if( pOp->p5 ){
2835 while( (pLast->flags & MEM_Null)!=0 && nField>pOp->p5 ){
2836 pLast--;
2837 nField--;
2838 }
2839 }
drhd447dce2017-01-25 20:55:11 +00002840#endif
drh585ce192017-01-25 14:58:27 +00002841
drhf3218fe2004-05-28 08:21:02 +00002842 /* Loop through the elements that will make up the record to figure
2843 ** out how much space is required for the new record.
danielk19778d059842004-05-12 11:24:02 +00002844 */
drh038b7bc2013-12-09 23:17:22 +00002845 pRec = pLast;
drh59bf00c2013-12-08 23:33:28 +00002846 do{
drh2b4ded92010-09-27 21:09:31 +00002847 assert( memIsValid(pRec) );
drhbe37c122015-10-16 14:54:17 +00002848 pRec->uTemp = serial_type = sqlite3VdbeSerialType(pRec, file_format, &len);
drhfdf972a2007-05-02 13:30:27 +00002849 if( pRec->flags & MEM_Zero ){
drh038b7bc2013-12-09 23:17:22 +00002850 if( nData ){
drh53e66c32015-07-24 15:49:23 +00002851 if( sqlite3VdbeMemExpandBlob(pRec) ) goto no_mem;
drh038b7bc2013-12-09 23:17:22 +00002852 }else{
2853 nZero += pRec->u.nZero;
2854 len -= pRec->u.nZero;
2855 }
drhfdf972a2007-05-02 13:30:27 +00002856 }
drh8079a0d2006-01-12 17:20:50 +00002857 nData += len;
drh59bf00c2013-12-08 23:33:28 +00002858 testcase( serial_type==127 );
2859 testcase( serial_type==128 );
drh2a242872013-12-08 22:59:29 +00002860 nHdr += serial_type<=127 ? 1 : sqlite3VarintLen(serial_type);
drh45c3c662016-04-07 14:16:16 +00002861 if( pRec==pData0 ) break;
2862 pRec--;
2863 }while(1);
danielk19773d1bfea2004-05-14 11:00:53 +00002864
drh654858d2014-11-20 02:18:14 +00002865 /* EVIDENCE-OF: R-22564-11647 The header begins with a single varint
2866 ** which determines the total number of bytes in the header. The varint
2867 ** value is the size of the header in bytes including the size varint
2868 ** itself. */
drh59bf00c2013-12-08 23:33:28 +00002869 testcase( nHdr==126 );
2870 testcase( nHdr==127 );
drh2a242872013-12-08 22:59:29 +00002871 if( nHdr<=126 ){
2872 /* The common case */
2873 nHdr += 1;
2874 }else{
2875 /* Rare case of a really large header */
2876 nVarint = sqlite3VarintLen(nHdr);
2877 nHdr += nVarint;
2878 if( nVarint<sqlite3VarintLen(nHdr) ) nHdr++;
drhcb9882a2005-03-17 03:15:40 +00002879 }
drh038b7bc2013-12-09 23:17:22 +00002880 nByte = nHdr+nData;
drh4a335072015-04-11 02:08:48 +00002881 if( nByte+nZero>db->aLimit[SQLITE_LIMIT_LENGTH] ){
drh023ae032007-05-08 12:12:16 +00002882 goto too_big;
2883 }
drhf3218fe2004-05-28 08:21:02 +00002884
danielk1977a7a8e142008-02-13 18:25:27 +00002885 /* Make sure the output register has a buffer large enough to store
2886 ** the new record. The output register (pOp->p3) is not allowed to
2887 ** be one of the input registers (because the following call to
drh322f2852014-09-19 00:43:39 +00002888 ** sqlite3VdbeMemClearAndResize() could clobber the value before it is used).
danielk1977a7a8e142008-02-13 18:25:27 +00002889 */
drh322f2852014-09-19 00:43:39 +00002890 if( sqlite3VdbeMemClearAndResize(pOut, (int)nByte) ){
danielk1977a7a8e142008-02-13 18:25:27 +00002891 goto no_mem;
danielk19778d059842004-05-12 11:24:02 +00002892 }
danielk1977a7a8e142008-02-13 18:25:27 +00002893 zNewRecord = (u8 *)pOut->z;
drhf3218fe2004-05-28 08:21:02 +00002894
2895 /* Write the record */
shane3f8d5cf2008-04-24 19:15:09 +00002896 i = putVarint32(zNewRecord, nHdr);
drh59bf00c2013-12-08 23:33:28 +00002897 j = nHdr;
2898 assert( pData0<=pLast );
2899 pRec = pData0;
2900 do{
drhfacf47a2014-10-13 20:12:47 +00002901 serial_type = pRec->uTemp;
drh654858d2014-11-20 02:18:14 +00002902 /* EVIDENCE-OF: R-06529-47362 Following the size varint are one or more
2903 ** additional varints, one per column. */
drh038b7bc2013-12-09 23:17:22 +00002904 i += putVarint32(&zNewRecord[i], serial_type); /* serial type */
drh654858d2014-11-20 02:18:14 +00002905 /* EVIDENCE-OF: R-64536-51728 The values for each column in the record
2906 ** immediately follow the header. */
drha9ab4812013-12-11 11:00:44 +00002907 j += sqlite3VdbeSerialPut(&zNewRecord[j], pRec, serial_type); /* content */
drh59bf00c2013-12-08 23:33:28 +00002908 }while( (++pRec)<=pLast );
2909 assert( i==nHdr );
2910 assert( j==nByte );
drhf3218fe2004-05-28 08:21:02 +00002911
drh9f6168b2016-03-19 23:32:58 +00002912 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
drh9c1905f2008-12-10 22:32:56 +00002913 pOut->n = (int)nByte;
drhc91b2fd2014-03-01 18:13:23 +00002914 pOut->flags = MEM_Blob;
drhfdf972a2007-05-02 13:30:27 +00002915 if( nZero ){
drh8df32842008-12-09 02:51:23 +00002916 pOut->u.nZero = nZero;
drh477df4b2008-01-05 18:48:24 +00002917 pOut->flags |= MEM_Zero;
drhfdf972a2007-05-02 13:30:27 +00002918 }
drh1013c932008-01-06 00:25:21 +00002919 REGISTER_TRACE(pOp->p3, pOut);
drhb7654112008-01-12 12:48:07 +00002920 UPDATE_MAX_BLOBSIZE(pOut);
danielk19778d059842004-05-12 11:24:02 +00002921 break;
2922}
2923
danielk1977a5533162009-02-24 10:01:51 +00002924/* Opcode: Count P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00002925** Synopsis: r[P2]=count()
danielk1977a5533162009-02-24 10:01:51 +00002926**
2927** Store the number of entries (an integer value) in the table or index
2928** opened by cursor P1 in register P2
2929*/
2930#ifndef SQLITE_OMIT_BTREECOUNT
drh27a348c2015-04-13 19:14:06 +00002931case OP_Count: { /* out2 */
danielk1977a5533162009-02-24 10:01:51 +00002932 i64 nEntry;
drhc54a6172009-06-02 16:06:03 +00002933 BtCursor *pCrsr;
2934
drhc960dcb2015-11-20 19:22:01 +00002935 assert( p->apCsr[pOp->p1]->eCurType==CURTYPE_BTREE );
2936 pCrsr = p->apCsr[pOp->p1]->uc.pCursor;
drh3da046d2013-11-11 03:24:11 +00002937 assert( pCrsr );
drh2dc06482013-12-11 00:59:10 +00002938 nEntry = 0; /* Not needed. Only used to silence a warning. */
drh3da046d2013-11-11 03:24:11 +00002939 rc = sqlite3BtreeCount(pCrsr, &nEntry);
drh9467abf2016-02-17 18:44:11 +00002940 if( rc ) goto abort_due_to_error;
drh27a348c2015-04-13 19:14:06 +00002941 pOut = out2Prerelease(p, pOp);
danielk1977a5533162009-02-24 10:01:51 +00002942 pOut->u.i = nEntry;
2943 break;
2944}
2945#endif
2946
danielk1977fd7f0452008-12-17 17:30:26 +00002947/* Opcode: Savepoint P1 * * P4 *
2948**
2949** Open, release or rollback the savepoint named by parameter P4, depending
2950** on the value of P1. To open a new savepoint, P1==0. To release (commit) an
2951** existing savepoint, P1==1, or to rollback an existing savepoint P1==2.
2952*/
2953case OP_Savepoint: {
drh856c1032009-06-02 15:21:42 +00002954 int p1; /* Value of P1 operand */
2955 char *zName; /* Name of savepoint */
2956 int nName;
2957 Savepoint *pNew;
2958 Savepoint *pSavepoint;
2959 Savepoint *pTmp;
2960 int iSavepoint;
2961 int ii;
2962
2963 p1 = pOp->p1;
2964 zName = pOp->p4.z;
danielk1977fd7f0452008-12-17 17:30:26 +00002965
2966 /* Assert that the p1 parameter is valid. Also that if there is no open
2967 ** transaction, then there cannot be any savepoints.
2968 */
2969 assert( db->pSavepoint==0 || db->autoCommit==0 );
2970 assert( p1==SAVEPOINT_BEGIN||p1==SAVEPOINT_RELEASE||p1==SAVEPOINT_ROLLBACK );
2971 assert( db->pSavepoint || db->isTransactionSavepoint==0 );
2972 assert( checkSavepointCount(db) );
danc0537fe2013-06-28 19:41:43 +00002973 assert( p->bIsReader );
danielk1977fd7f0452008-12-17 17:30:26 +00002974
2975 if( p1==SAVEPOINT_BEGIN ){
drh4f7d3a52013-06-27 23:54:02 +00002976 if( db->nVdbeWrite>0 ){
danielk1977fd7f0452008-12-17 17:30:26 +00002977 /* A new savepoint cannot be created if there are active write
2978 ** statements (i.e. open read/write incremental blob handles).
2979 */
drh22c17b82015-05-15 04:13:15 +00002980 sqlite3VdbeError(p, "cannot open savepoint - SQL statements in progress");
danielk1977fd7f0452008-12-17 17:30:26 +00002981 rc = SQLITE_BUSY;
2982 }else{
drh856c1032009-06-02 15:21:42 +00002983 nName = sqlite3Strlen30(zName);
danielk1977fd7f0452008-12-17 17:30:26 +00002984
drhbe07ec52011-06-03 12:15:26 +00002985#ifndef SQLITE_OMIT_VIRTUALTABLE
dand9495cd2011-04-27 12:08:04 +00002986 /* This call is Ok even if this savepoint is actually a transaction
2987 ** savepoint (and therefore should not prompt xSavepoint()) callbacks.
2988 ** If this is a transaction savepoint being opened, it is guaranteed
2989 ** that the db->aVTrans[] array is empty. */
2990 assert( db->autoCommit==0 || db->nVTrans==0 );
drha24bc9c2011-05-24 00:35:56 +00002991 rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN,
2992 db->nStatement+db->nSavepoint);
dand9495cd2011-04-27 12:08:04 +00002993 if( rc!=SQLITE_OK ) goto abort_due_to_error;
drh305ebab2011-05-26 14:19:14 +00002994#endif
dand9495cd2011-04-27 12:08:04 +00002995
danielk1977fd7f0452008-12-17 17:30:26 +00002996 /* Create a new savepoint structure. */
drh575fad62016-02-05 13:38:36 +00002997 pNew = sqlite3DbMallocRawNN(db, sizeof(Savepoint)+nName+1);
danielk1977fd7f0452008-12-17 17:30:26 +00002998 if( pNew ){
2999 pNew->zName = (char *)&pNew[1];
3000 memcpy(pNew->zName, zName, nName+1);
3001
3002 /* If there is no open transaction, then mark this as a special
3003 ** "transaction savepoint". */
3004 if( db->autoCommit ){
3005 db->autoCommit = 0;
3006 db->isTransactionSavepoint = 1;
3007 }else{
3008 db->nSavepoint++;
danielk1977d8293352009-04-30 09:10:37 +00003009 }
dan21e8d012011-03-03 20:05:59 +00003010
danielk1977fd7f0452008-12-17 17:30:26 +00003011 /* Link the new savepoint into the database handle's list. */
3012 pNew->pNext = db->pSavepoint;
3013 db->pSavepoint = pNew;
danba9108b2009-09-22 07:13:42 +00003014 pNew->nDeferredCons = db->nDeferredCons;
dancb3e4b72013-07-03 19:53:05 +00003015 pNew->nDeferredImmCons = db->nDeferredImmCons;
danielk1977fd7f0452008-12-17 17:30:26 +00003016 }
3017 }
3018 }else{
drh856c1032009-06-02 15:21:42 +00003019 iSavepoint = 0;
danielk1977fd7f0452008-12-17 17:30:26 +00003020
3021 /* Find the named savepoint. If there is no such savepoint, then an
3022 ** an error is returned to the user. */
3023 for(
drh856c1032009-06-02 15:21:42 +00003024 pSavepoint = db->pSavepoint;
danielk1977fd7f0452008-12-17 17:30:26 +00003025 pSavepoint && sqlite3StrICmp(pSavepoint->zName, zName);
drh856c1032009-06-02 15:21:42 +00003026 pSavepoint = pSavepoint->pNext
danielk1977fd7f0452008-12-17 17:30:26 +00003027 ){
3028 iSavepoint++;
3029 }
3030 if( !pSavepoint ){
drh22c17b82015-05-15 04:13:15 +00003031 sqlite3VdbeError(p, "no such savepoint: %s", zName);
danielk1977fd7f0452008-12-17 17:30:26 +00003032 rc = SQLITE_ERROR;
drh4f7d3a52013-06-27 23:54:02 +00003033 }else if( db->nVdbeWrite>0 && p1==SAVEPOINT_RELEASE ){
danielk1977fd7f0452008-12-17 17:30:26 +00003034 /* It is not possible to release (commit) a savepoint if there are
drh0f198a72012-02-13 16:43:16 +00003035 ** active write statements.
danielk1977fd7f0452008-12-17 17:30:26 +00003036 */
drh22c17b82015-05-15 04:13:15 +00003037 sqlite3VdbeError(p, "cannot release savepoint - "
3038 "SQL statements in progress");
danielk1977fd7f0452008-12-17 17:30:26 +00003039 rc = SQLITE_BUSY;
3040 }else{
3041
3042 /* Determine whether or not this is a transaction savepoint. If so,
danielk197734cf35d2008-12-18 18:31:38 +00003043 ** and this is a RELEASE command, then the current transaction
3044 ** is committed.
danielk1977fd7f0452008-12-17 17:30:26 +00003045 */
3046 int isTransaction = pSavepoint->pNext==0 && db->isTransactionSavepoint;
3047 if( isTransaction && p1==SAVEPOINT_RELEASE ){
dan32b09f22009-09-23 17:29:59 +00003048 if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
dan1da40a32009-09-19 17:00:31 +00003049 goto vdbe_return;
3050 }
danielk1977fd7f0452008-12-17 17:30:26 +00003051 db->autoCommit = 1;
3052 if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
drhf56fa462015-04-13 21:39:54 +00003053 p->pc = (int)(pOp - aOp);
danielk1977fd7f0452008-12-17 17:30:26 +00003054 db->autoCommit = 0;
3055 p->rc = rc = SQLITE_BUSY;
3056 goto vdbe_return;
3057 }
danielk197734cf35d2008-12-18 18:31:38 +00003058 db->isTransactionSavepoint = 0;
3059 rc = p->rc;
danielk1977fd7f0452008-12-17 17:30:26 +00003060 }else{
drh47b7fc72014-11-11 01:33:57 +00003061 int isSchemaChange;
danielk1977fd7f0452008-12-17 17:30:26 +00003062 iSavepoint = db->nSavepoint - iSavepoint - 1;
drh31f10052012-03-31 17:17:26 +00003063 if( p1==SAVEPOINT_ROLLBACK ){
drh47b7fc72014-11-11 01:33:57 +00003064 isSchemaChange = (db->flags & SQLITE_InternChanges)!=0;
drh31f10052012-03-31 17:17:26 +00003065 for(ii=0; ii<db->nDb; ii++){
drh77b1dee2014-11-17 17:13:06 +00003066 rc = sqlite3BtreeTripAllCursors(db->aDb[ii].pBt,
3067 SQLITE_ABORT_ROLLBACK,
drh47b7fc72014-11-11 01:33:57 +00003068 isSchemaChange==0);
dan80231042014-11-12 14:56:02 +00003069 if( rc!=SQLITE_OK ) goto abort_due_to_error;
drh31f10052012-03-31 17:17:26 +00003070 }
drh47b7fc72014-11-11 01:33:57 +00003071 }else{
3072 isSchemaChange = 0;
drh0f198a72012-02-13 16:43:16 +00003073 }
3074 for(ii=0; ii<db->nDb; ii++){
danielk1977fd7f0452008-12-17 17:30:26 +00003075 rc = sqlite3BtreeSavepoint(db->aDb[ii].pBt, p1, iSavepoint);
3076 if( rc!=SQLITE_OK ){
3077 goto abort_due_to_error;
danielk1977bd434552009-03-18 10:33:00 +00003078 }
danielk1977fd7f0452008-12-17 17:30:26 +00003079 }
drh47b7fc72014-11-11 01:33:57 +00003080 if( isSchemaChange ){
danielk1977fd7f0452008-12-17 17:30:26 +00003081 sqlite3ExpirePreparedStatements(db);
drh81028a42012-05-15 18:28:27 +00003082 sqlite3ResetAllSchemasOfConnection(db);
danc311fee2010-08-31 16:25:19 +00003083 db->flags = (db->flags | SQLITE_InternChanges);
danielk1977fd7f0452008-12-17 17:30:26 +00003084 }
3085 }
3086
3087 /* Regardless of whether this is a RELEASE or ROLLBACK, destroy all
3088 ** savepoints nested inside of the savepoint being operated on. */
3089 while( db->pSavepoint!=pSavepoint ){
drh856c1032009-06-02 15:21:42 +00003090 pTmp = db->pSavepoint;
danielk1977fd7f0452008-12-17 17:30:26 +00003091 db->pSavepoint = pTmp->pNext;
3092 sqlite3DbFree(db, pTmp);
3093 db->nSavepoint--;
3094 }
3095
dan1da40a32009-09-19 17:00:31 +00003096 /* If it is a RELEASE, then destroy the savepoint being operated on
3097 ** too. If it is a ROLLBACK TO, then set the number of deferred
3098 ** constraint violations present in the database to the value stored
3099 ** when the savepoint was created. */
danielk1977fd7f0452008-12-17 17:30:26 +00003100 if( p1==SAVEPOINT_RELEASE ){
3101 assert( pSavepoint==db->pSavepoint );
3102 db->pSavepoint = pSavepoint->pNext;
3103 sqlite3DbFree(db, pSavepoint);
3104 if( !isTransaction ){
3105 db->nSavepoint--;
3106 }
dan1da40a32009-09-19 17:00:31 +00003107 }else{
3108 db->nDeferredCons = pSavepoint->nDeferredCons;
dancb3e4b72013-07-03 19:53:05 +00003109 db->nDeferredImmCons = pSavepoint->nDeferredImmCons;
danielk1977fd7f0452008-12-17 17:30:26 +00003110 }
dand9495cd2011-04-27 12:08:04 +00003111
danea8562e2015-04-18 16:25:54 +00003112 if( !isTransaction || p1==SAVEPOINT_ROLLBACK ){
dand9495cd2011-04-27 12:08:04 +00003113 rc = sqlite3VtabSavepoint(db, p1, iSavepoint);
3114 if( rc!=SQLITE_OK ) goto abort_due_to_error;
3115 }
danielk1977fd7f0452008-12-17 17:30:26 +00003116 }
3117 }
drh9467abf2016-02-17 18:44:11 +00003118 if( rc ) goto abort_due_to_error;
danielk1977fd7f0452008-12-17 17:30:26 +00003119
3120 break;
3121}
3122
drh98757152008-01-09 23:04:12 +00003123/* Opcode: AutoCommit P1 P2 * * *
danielk19771d850a72004-05-31 08:26:49 +00003124**
3125** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
danielk197746c43ed2004-06-30 06:30:25 +00003126** back any currently active btree transactions. If there are any active
drhc25eabe2009-02-24 18:57:31 +00003127** VMs (apart from this one), then a ROLLBACK fails. A COMMIT fails if
3128** there are active writing VMs or active VMs that use shared cache.
drh92f02c32004-09-02 14:57:08 +00003129**
3130** This instruction causes the VM to halt.
danielk19771d850a72004-05-31 08:26:49 +00003131*/
drh9cbf3422008-01-17 16:22:13 +00003132case OP_AutoCommit: {
drh856c1032009-06-02 15:21:42 +00003133 int desiredAutoCommit;
shane68c02732009-06-09 18:14:18 +00003134 int iRollback;
danielk19771d850a72004-05-31 08:26:49 +00003135
drh856c1032009-06-02 15:21:42 +00003136 desiredAutoCommit = pOp->p1;
shane68c02732009-06-09 18:14:18 +00003137 iRollback = pOp->p2;
drhad4a4b82008-11-05 16:37:34 +00003138 assert( desiredAutoCommit==1 || desiredAutoCommit==0 );
shane68c02732009-06-09 18:14:18 +00003139 assert( desiredAutoCommit==1 || iRollback==0 );
drh4f7d3a52013-06-27 23:54:02 +00003140 assert( db->nVdbeActive>0 ); /* At least this one VM is active */
danc0537fe2013-06-28 19:41:43 +00003141 assert( p->bIsReader );
danielk197746c43ed2004-06-30 06:30:25 +00003142
drhb0c88652016-02-01 13:21:13 +00003143 if( desiredAutoCommit!=db->autoCommit ){
shane68c02732009-06-09 18:14:18 +00003144 if( iRollback ){
drhad4a4b82008-11-05 16:37:34 +00003145 assert( desiredAutoCommit==1 );
drh21021a52012-02-13 17:01:51 +00003146 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977f3f06bb2005-12-16 15:24:28 +00003147 db->autoCommit = 1;
drhb0c88652016-02-01 13:21:13 +00003148 }else if( desiredAutoCommit && db->nVdbeWrite>0 ){
3149 /* If this instruction implements a COMMIT and other VMs are writing
3150 ** return an error indicating that the other VMs must complete first.
3151 */
3152 sqlite3VdbeError(p, "cannot commit transaction - "
3153 "SQL statements in progress");
3154 rc = SQLITE_BUSY;
drh9467abf2016-02-17 18:44:11 +00003155 goto abort_due_to_error;
dan32b09f22009-09-23 17:29:59 +00003156 }else if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
dan1da40a32009-09-19 17:00:31 +00003157 goto vdbe_return;
danielk1977f3f06bb2005-12-16 15:24:28 +00003158 }else{
shane7d3846a2008-12-11 02:58:26 +00003159 db->autoCommit = (u8)desiredAutoCommit;
drh8ff25872015-07-31 18:59:56 +00003160 }
3161 if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
3162 p->pc = (int)(pOp - aOp);
3163 db->autoCommit = (u8)(1-desiredAutoCommit);
3164 p->rc = rc = SQLITE_BUSY;
3165 goto vdbe_return;
danielk19771d850a72004-05-31 08:26:49 +00003166 }
danielk1977bd434552009-03-18 10:33:00 +00003167 assert( db->nStatement==0 );
danielk1977fd7f0452008-12-17 17:30:26 +00003168 sqlite3CloseSavepoints(db);
drh83968c42007-04-18 16:45:24 +00003169 if( p->rc==SQLITE_OK ){
drh900b31e2007-08-28 02:27:51 +00003170 rc = SQLITE_DONE;
drh83968c42007-04-18 16:45:24 +00003171 }else{
drh900b31e2007-08-28 02:27:51 +00003172 rc = SQLITE_ERROR;
drh83968c42007-04-18 16:45:24 +00003173 }
drh900b31e2007-08-28 02:27:51 +00003174 goto vdbe_return;
danielk19771d850a72004-05-31 08:26:49 +00003175 }else{
drh22c17b82015-05-15 04:13:15 +00003176 sqlite3VdbeError(p,
drhad4a4b82008-11-05 16:37:34 +00003177 (!desiredAutoCommit)?"cannot start a transaction within a transaction":(
shane68c02732009-06-09 18:14:18 +00003178 (iRollback)?"cannot rollback - no transaction is active":
drhf089aa42008-07-08 19:34:06 +00003179 "cannot commit - no transaction is active"));
danielk19771d850a72004-05-31 08:26:49 +00003180
3181 rc = SQLITE_ERROR;
drh9467abf2016-02-17 18:44:11 +00003182 goto abort_due_to_error;
drh663fc632002-02-02 18:49:19 +00003183 }
3184 break;
3185}
3186
drhb22f7c82014-02-06 23:56:27 +00003187/* Opcode: Transaction P1 P2 P3 P4 P5
drh5e00f6c2001-09-13 13:46:56 +00003188**
drh05a86c52014-02-16 01:55:49 +00003189** Begin a transaction on database P1 if a transaction is not already
3190** active.
3191** If P2 is non-zero, then a write-transaction is started, or if a
3192** read-transaction is already active, it is upgraded to a write-transaction.
3193** If P2 is zero, then a read-transaction is started.
drh5e00f6c2001-09-13 13:46:56 +00003194**
drh001bbcb2003-03-19 03:14:00 +00003195** P1 is the index of the database file on which the transaction is
3196** started. Index 0 is the main database file and index 1 is the
drh60a713c2008-01-21 16:22:45 +00003197** file used for temporary tables. Indices of 2 or more are used for
3198** attached databases.
drhcabb0812002-09-14 13:47:32 +00003199**
dane0af83a2009-09-08 19:15:01 +00003200** If a write-transaction is started and the Vdbe.usesStmtJournal flag is
3201** true (this flag is set if the Vdbe may modify more than one row and may
3202** throw an ABORT exception), a statement transaction may also be opened.
3203** More specifically, a statement transaction is opened iff the database
3204** connection is currently not in autocommit mode, or if there are other
drha4510172012-02-02 15:50:17 +00003205** active statements. A statement transaction allows the changes made by this
dane0af83a2009-09-08 19:15:01 +00003206** VDBE to be rolled back after an error without having to roll back the
3207** entire transaction. If no error is encountered, the statement transaction
3208** will automatically commit when the VDBE halts.
3209**
drhb22f7c82014-02-06 23:56:27 +00003210** If P5!=0 then this opcode also checks the schema cookie against P3
3211** and the schema generation counter against P4.
3212** The cookie changes its value whenever the database schema changes.
3213** This operation is used to detect when that the cookie has changed
drh05a86c52014-02-16 01:55:49 +00003214** and that the current process needs to reread the schema. If the schema
3215** cookie in P3 differs from the schema cookie in the database header or
3216** if the schema generation counter in P4 differs from the current
3217** generation counter, then an SQLITE_SCHEMA error is raised and execution
3218** halts. The sqlite3_step() wrapper function might then reprepare the
3219** statement and rerun it from the beginning.
drh5e00f6c2001-09-13 13:46:56 +00003220*/
drh9cbf3422008-01-17 16:22:13 +00003221case OP_Transaction: {
danielk19771d850a72004-05-31 08:26:49 +00003222 Btree *pBt;
drhb22f7c82014-02-06 23:56:27 +00003223 int iMeta;
3224 int iGen;
danielk19771d850a72004-05-31 08:26:49 +00003225
drh1713afb2013-06-28 01:24:57 +00003226 assert( p->bIsReader );
drh9e92a472013-06-27 17:40:30 +00003227 assert( p->readOnly==0 || pOp->p2==0 );
drh653b82a2009-06-22 11:10:47 +00003228 assert( pOp->p1>=0 && pOp->p1<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00003229 assert( DbMaskTest(p->btreeMask, pOp->p1) );
drh13447bf2013-07-10 13:33:49 +00003230 if( pOp->p2 && (db->flags & SQLITE_QueryOnly)!=0 ){
3231 rc = SQLITE_READONLY;
3232 goto abort_due_to_error;
3233 }
drh653b82a2009-06-22 11:10:47 +00003234 pBt = db->aDb[pOp->p1].pBt;
danielk19771d850a72004-05-31 08:26:49 +00003235
danielk197724162fe2004-06-04 06:22:00 +00003236 if( pBt ){
danielk197740b38dc2004-06-26 08:38:24 +00003237 rc = sqlite3BtreeBeginTrans(pBt, pOp->p2);
drhcbd8db32015-08-20 17:18:32 +00003238 testcase( rc==SQLITE_BUSY_SNAPSHOT );
3239 testcase( rc==SQLITE_BUSY_RECOVERY );
drh9e9f1bd2009-10-13 15:36:51 +00003240 if( rc!=SQLITE_OK ){
drhfadd2b12016-09-19 23:39:34 +00003241 if( (rc&0xff)==SQLITE_BUSY ){
3242 p->pc = (int)(pOp - aOp);
3243 p->rc = rc;
3244 goto vdbe_return;
3245 }
danielk197724162fe2004-06-04 06:22:00 +00003246 goto abort_due_to_error;
drh90bfcda2001-09-23 19:46:51 +00003247 }
dane0af83a2009-09-08 19:15:01 +00003248
3249 if( pOp->p2 && p->usesStmtJournal
danc0537fe2013-06-28 19:41:43 +00003250 && (db->autoCommit==0 || db->nVdbeRead>1)
dane0af83a2009-09-08 19:15:01 +00003251 ){
3252 assert( sqlite3BtreeIsInTrans(pBt) );
3253 if( p->iStatement==0 ){
3254 assert( db->nStatement>=0 && db->nSavepoint>=0 );
3255 db->nStatement++;
3256 p->iStatement = db->nSavepoint + db->nStatement;
3257 }
dana311b802011-04-26 19:21:34 +00003258
drh346506f2011-05-25 01:16:42 +00003259 rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN, p->iStatement-1);
dana311b802011-04-26 19:21:34 +00003260 if( rc==SQLITE_OK ){
3261 rc = sqlite3BtreeBeginStmt(pBt, p->iStatement);
3262 }
dan1da40a32009-09-19 17:00:31 +00003263
3264 /* Store the current value of the database handles deferred constraint
3265 ** counter. If the statement transaction needs to be rolled back,
3266 ** the value of this counter needs to be restored too. */
3267 p->nStmtDefCons = db->nDeferredCons;
dancb3e4b72013-07-03 19:53:05 +00003268 p->nStmtDefImmCons = db->nDeferredImmCons;
dane0af83a2009-09-08 19:15:01 +00003269 }
drhb22f7c82014-02-06 23:56:27 +00003270
drh51a74d42015-02-28 01:04:27 +00003271 /* Gather the schema version number for checking:
drh96fdcb42016-09-27 00:09:33 +00003272 ** IMPLEMENTATION-OF: R-03189-51135 As each SQL statement runs, the schema
3273 ** version is checked to ensure that the schema has not changed since the
3274 ** SQL statement was prepared.
drh51a74d42015-02-28 01:04:27 +00003275 */
drhb22f7c82014-02-06 23:56:27 +00003276 sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&iMeta);
3277 iGen = db->aDb[pOp->p1].pSchema->iGeneration;
3278 }else{
3279 iGen = iMeta = 0;
3280 }
3281 assert( pOp->p5==0 || pOp->p4type==P4_INT32 );
3282 if( pOp->p5 && (iMeta!=pOp->p3 || iGen!=pOp->p4.i) ){
3283 sqlite3DbFree(db, p->zErrMsg);
3284 p->zErrMsg = sqlite3DbStrDup(db, "database schema has changed");
3285 /* If the schema-cookie from the database file matches the cookie
3286 ** stored with the in-memory representation of the schema, do
3287 ** not reload the schema from the database file.
3288 **
3289 ** If virtual-tables are in use, this is not just an optimization.
3290 ** Often, v-tables store their data in other SQLite tables, which
3291 ** are queried from within xNext() and other v-table methods using
3292 ** prepared queries. If such a query is out-of-date, we do not want to
3293 ** discard the database schema, as the user code implementing the
3294 ** v-table would have to be ready for the sqlite3_vtab structure itself
3295 ** to be invalidated whenever sqlite3_step() is called from within
3296 ** a v-table method.
3297 */
3298 if( db->aDb[pOp->p1].pSchema->schema_cookie!=iMeta ){
3299 sqlite3ResetOneSchema(db, pOp->p1);
3300 }
3301 p->expired = 1;
3302 rc = SQLITE_SCHEMA;
drhb86ccfb2003-01-28 23:13:10 +00003303 }
drh9467abf2016-02-17 18:44:11 +00003304 if( rc ) goto abort_due_to_error;
drh5e00f6c2001-09-13 13:46:56 +00003305 break;
3306}
3307
drhb1fdb2a2008-01-05 04:06:03 +00003308/* Opcode: ReadCookie P1 P2 P3 * *
drh50e5dad2001-09-15 00:57:28 +00003309**
drh9cbf3422008-01-17 16:22:13 +00003310** Read cookie number P3 from database P1 and write it into register P2.
danielk19770d19f7a2009-06-03 11:25:07 +00003311** P3==1 is the schema version. P3==2 is the database format.
3312** P3==3 is the recommended pager cache size, and so forth. P1==0 is
drh001bbcb2003-03-19 03:14:00 +00003313** the main database file and P1==1 is the database file used to store
3314** temporary tables.
drh4a324312001-12-21 14:30:42 +00003315**
drh50e5dad2001-09-15 00:57:28 +00003316** There must be a read-lock on the database (either a transaction
drhb19a2bc2001-09-16 00:13:26 +00003317** must be started or there must be an open cursor) before
drh50e5dad2001-09-15 00:57:28 +00003318** executing this instruction.
3319*/
drh27a348c2015-04-13 19:14:06 +00003320case OP_ReadCookie: { /* out2 */
drhf328bc82004-05-10 23:29:49 +00003321 int iMeta;
drh856c1032009-06-02 15:21:42 +00003322 int iDb;
3323 int iCookie;
danielk1977180b56a2007-06-24 08:00:42 +00003324
drh1713afb2013-06-28 01:24:57 +00003325 assert( p->bIsReader );
drh856c1032009-06-02 15:21:42 +00003326 iDb = pOp->p1;
3327 iCookie = pOp->p3;
drhb7654112008-01-12 12:48:07 +00003328 assert( pOp->p3<SQLITE_N_BTREE_META );
danielk1977180b56a2007-06-24 08:00:42 +00003329 assert( iDb>=0 && iDb<db->nDb );
3330 assert( db->aDb[iDb].pBt!=0 );
drha7ab6d82014-07-21 15:44:39 +00003331 assert( DbMaskTest(p->btreeMask, iDb) );
danielk19770d19f7a2009-06-03 11:25:07 +00003332
danielk1977602b4662009-07-02 07:47:33 +00003333 sqlite3BtreeGetMeta(db->aDb[iDb].pBt, iCookie, (u32 *)&iMeta);
drh27a348c2015-04-13 19:14:06 +00003334 pOut = out2Prerelease(p, pOp);
drh4c583122008-01-04 22:01:03 +00003335 pOut->u.i = iMeta;
drh50e5dad2001-09-15 00:57:28 +00003336 break;
3337}
3338
drh98757152008-01-09 23:04:12 +00003339/* Opcode: SetCookie P1 P2 P3 * *
drh50e5dad2001-09-15 00:57:28 +00003340**
drh1861afc2016-02-01 21:48:34 +00003341** Write the integer value P3 into cookie number P2 of database P1.
3342** P2==1 is the schema version. P2==2 is the database format.
3343** P2==3 is the recommended pager cache
danielk19770d19f7a2009-06-03 11:25:07 +00003344** size, and so forth. P1==0 is the main database file and P1==1 is the
3345** database file used to store temporary tables.
drh50e5dad2001-09-15 00:57:28 +00003346**
3347** A transaction must be started before executing this opcode.
3348*/
drh1861afc2016-02-01 21:48:34 +00003349case OP_SetCookie: {
drh3f7d4e42004-07-24 14:35:58 +00003350 Db *pDb;
drh4a324312001-12-21 14:30:42 +00003351 assert( pOp->p2<SQLITE_N_BTREE_META );
drh001bbcb2003-03-19 03:14:00 +00003352 assert( pOp->p1>=0 && pOp->p1<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00003353 assert( DbMaskTest(p->btreeMask, pOp->p1) );
drh9e92a472013-06-27 17:40:30 +00003354 assert( p->readOnly==0 );
drh3f7d4e42004-07-24 14:35:58 +00003355 pDb = &db->aDb[pOp->p1];
3356 assert( pDb->pBt!=0 );
drh21206082011-04-04 18:22:02 +00003357 assert( sqlite3SchemaMutexHeld(db, pOp->p1, 0) );
drha3b321d2004-05-11 09:31:31 +00003358 /* See note about index shifting on OP_ReadCookie */
drh1861afc2016-02-01 21:48:34 +00003359 rc = sqlite3BtreeUpdateMeta(pDb->pBt, pOp->p2, pOp->p3);
danielk19770d19f7a2009-06-03 11:25:07 +00003360 if( pOp->p2==BTREE_SCHEMA_VERSION ){
drh3f7d4e42004-07-24 14:35:58 +00003361 /* When the schema cookie changes, record the new cookie internally */
drh1861afc2016-02-01 21:48:34 +00003362 pDb->pSchema->schema_cookie = pOp->p3;
drh3f7d4e42004-07-24 14:35:58 +00003363 db->flags |= SQLITE_InternChanges;
danielk19770d19f7a2009-06-03 11:25:07 +00003364 }else if( pOp->p2==BTREE_FILE_FORMAT ){
drhd28bcb32005-12-21 14:43:11 +00003365 /* Record changes in the file format */
drh1861afc2016-02-01 21:48:34 +00003366 pDb->pSchema->file_format = pOp->p3;
drh3f7d4e42004-07-24 14:35:58 +00003367 }
drhfd426c62006-01-30 15:34:22 +00003368 if( pOp->p1==1 ){
3369 /* Invalidate all prepared statements whenever the TEMP database
3370 ** schema is changed. Ticket #1644 */
3371 sqlite3ExpirePreparedStatements(db);
danfa401de2009-10-16 14:55:03 +00003372 p->expired = 0;
drhfd426c62006-01-30 15:34:22 +00003373 }
drh9467abf2016-02-17 18:44:11 +00003374 if( rc ) goto abort_due_to_error;
drh50e5dad2001-09-15 00:57:28 +00003375 break;
3376}
3377
drh98757152008-01-09 23:04:12 +00003378/* Opcode: OpenRead P1 P2 P3 P4 P5
drh81316f82013-10-29 20:40:47 +00003379** Synopsis: root=P2 iDb=P3
drh5e00f6c2001-09-13 13:46:56 +00003380**
drhecdc7532001-09-23 02:35:53 +00003381** Open a read-only cursor for the database table whose root page is
danielk1977207872a2008-01-03 07:54:23 +00003382** P2 in a database file. The database file is determined by P3.
drh60a713c2008-01-21 16:22:45 +00003383** P3==0 means the main database, P3==1 means the database used for
3384** temporary tables, and P3>1 means used the corresponding attached
3385** database. Give the new cursor an identifier of P1. The P1
danielk1977207872a2008-01-03 07:54:23 +00003386** values need not be contiguous but all P1 values should be small integers.
3387** It is an error for P1 to be negative.
drh5e00f6c2001-09-13 13:46:56 +00003388**
drh98757152008-01-09 23:04:12 +00003389** If P5!=0 then use the content of register P2 as the root page, not
3390** the value of P2 itself.
drh5edc3122001-09-13 21:53:09 +00003391**
drhb19a2bc2001-09-16 00:13:26 +00003392** There will be a read lock on the database whenever there is an
3393** open cursor. If the database was unlocked prior to this instruction
3394** then a read lock is acquired as part of this instruction. A read
3395** lock allows other processes to read the database but prohibits
3396** any other process from modifying the database. The read lock is
3397** released when all cursors are closed. If this instruction attempts
3398** to get a read lock but fails, the script terminates with an
3399** SQLITE_BUSY error code.
3400**
danielk1977d336e222009-02-20 10:58:41 +00003401** The P4 value may be either an integer (P4_INT32) or a pointer to
3402** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3403** structure, then said structure defines the content and collating
3404** sequence of the index being opened. Otherwise, if P4 is an integer
3405** value, it is set to the number of columns in the table.
drhf57b3392001-10-08 13:22:32 +00003406**
drh35263192014-07-22 20:02:19 +00003407** See also: OpenWrite, ReopenIdx
3408*/
3409/* Opcode: ReopenIdx P1 P2 P3 P4 P5
3410** Synopsis: root=P2 iDb=P3
3411**
3412** The ReopenIdx opcode works exactly like ReadOpen except that it first
3413** checks to see if the cursor on P1 is already open with a root page
3414** number of P2 and if it is this opcode becomes a no-op. In other words,
3415** if the cursor is already open, do not reopen it.
3416**
3417** The ReopenIdx opcode may only be used with P5==0 and with P4 being
3418** a P4_KEYINFO object. Furthermore, the P3 value must be the same as
3419** every other ReopenIdx or OpenRead for the same cursor number.
3420**
3421** See the OpenRead opcode documentation for additional information.
drh5e00f6c2001-09-13 13:46:56 +00003422*/
drh98757152008-01-09 23:04:12 +00003423/* Opcode: OpenWrite P1 P2 P3 P4 P5
drh81316f82013-10-29 20:40:47 +00003424** Synopsis: root=P2 iDb=P3
drhecdc7532001-09-23 02:35:53 +00003425**
3426** Open a read/write cursor named P1 on the table or index whose root
drh98757152008-01-09 23:04:12 +00003427** page is P2. Or if P5!=0 use the content of register P2 to find the
3428** root page.
drhecdc7532001-09-23 02:35:53 +00003429**
danielk1977d336e222009-02-20 10:58:41 +00003430** The P4 value may be either an integer (P4_INT32) or a pointer to
3431** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
3432** structure, then said structure defines the content and collating
3433** sequence of the index being opened. Otherwise, if P4 is an integer
drh35cd6432009-06-05 14:17:21 +00003434** value, it is set to the number of columns in the table, or to the
3435** largest index of any column of the table that is actually used.
jplyon5a564222003-06-02 06:15:58 +00003436**
drh001bbcb2003-03-19 03:14:00 +00003437** This instruction works just like OpenRead except that it opens the cursor
drhecdc7532001-09-23 02:35:53 +00003438** in read/write mode. For a given table, there can be one or more read-only
3439** cursors or a single read/write cursor but not both.
drhf57b3392001-10-08 13:22:32 +00003440**
drh001bbcb2003-03-19 03:14:00 +00003441** See also OpenRead.
drhecdc7532001-09-23 02:35:53 +00003442*/
drh35263192014-07-22 20:02:19 +00003443case OP_ReopenIdx: {
drh856c1032009-06-02 15:21:42 +00003444 int nField;
3445 KeyInfo *pKeyInfo;
drh856c1032009-06-02 15:21:42 +00003446 int p2;
3447 int iDb;
drhf57b3392001-10-08 13:22:32 +00003448 int wrFlag;
3449 Btree *pX;
drhdfe88ec2008-11-03 20:55:06 +00003450 VdbeCursor *pCur;
drhd946db02005-12-29 19:23:06 +00003451 Db *pDb;
drh856c1032009-06-02 15:21:42 +00003452
drhe0997b32015-03-20 14:57:50 +00003453 assert( pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
drh35263192014-07-22 20:02:19 +00003454 assert( pOp->p4type==P4_KEYINFO );
3455 pCur = p->apCsr[pOp->p1];
drhe8f2c9d2014-08-06 17:49:13 +00003456 if( pCur && pCur->pgnoRoot==(u32)pOp->p2 ){
drh35263192014-07-22 20:02:19 +00003457 assert( pCur->iDb==pOp->p3 ); /* Guaranteed by the code generator */
drhe0997b32015-03-20 14:57:50 +00003458 goto open_cursor_set_hints;
drh35263192014-07-22 20:02:19 +00003459 }
3460 /* If the cursor is not currently open or is open on a different
3461 ** index, then fall through into OP_OpenRead to force a reopen */
drh5e00f6c2001-09-13 13:46:56 +00003462case OP_OpenRead:
drh1fa509a2015-03-20 16:34:49 +00003463case OP_OpenWrite:
drh856c1032009-06-02 15:21:42 +00003464
drhe0997b32015-03-20 14:57:50 +00003465 assert( pOp->opcode==OP_OpenWrite || pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
drh1713afb2013-06-28 01:24:57 +00003466 assert( p->bIsReader );
drh35263192014-07-22 20:02:19 +00003467 assert( pOp->opcode==OP_OpenRead || pOp->opcode==OP_ReopenIdx
3468 || p->readOnly==0 );
dan428c2182012-08-06 18:50:11 +00003469
danfa401de2009-10-16 14:55:03 +00003470 if( p->expired ){
drh47b7fc72014-11-11 01:33:57 +00003471 rc = SQLITE_ABORT_ROLLBACK;
drh9467abf2016-02-17 18:44:11 +00003472 goto abort_due_to_error;
danfa401de2009-10-16 14:55:03 +00003473 }
3474
drh856c1032009-06-02 15:21:42 +00003475 nField = 0;
3476 pKeyInfo = 0;
drh856c1032009-06-02 15:21:42 +00003477 p2 = pOp->p2;
3478 iDb = pOp->p3;
drh6810ce62004-01-31 19:22:56 +00003479 assert( iDb>=0 && iDb<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00003480 assert( DbMaskTest(p->btreeMask, iDb) );
drhd946db02005-12-29 19:23:06 +00003481 pDb = &db->aDb[iDb];
3482 pX = pDb->pBt;
drh6810ce62004-01-31 19:22:56 +00003483 assert( pX!=0 );
drhd946db02005-12-29 19:23:06 +00003484 if( pOp->opcode==OP_OpenWrite ){
danfd261ec2015-10-22 20:54:33 +00003485 assert( OPFLAG_FORDELETE==BTREE_FORDELETE );
3486 wrFlag = BTREE_WRCSR | (pOp->p5 & OPFLAG_FORDELETE);
drh21206082011-04-04 18:22:02 +00003487 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk1977da184232006-01-05 11:34:32 +00003488 if( pDb->pSchema->file_format < p->minWriteFileFormat ){
3489 p->minWriteFileFormat = pDb->pSchema->file_format;
drhd946db02005-12-29 19:23:06 +00003490 }
3491 }else{
3492 wrFlag = 0;
3493 }
dan428c2182012-08-06 18:50:11 +00003494 if( pOp->p5 & OPFLAG_P2ISREG ){
drh9cbf3422008-01-17 16:22:13 +00003495 assert( p2>0 );
drh9f6168b2016-03-19 23:32:58 +00003496 assert( p2<=(p->nMem+1 - p->nCursor) );
drha6c2ed92009-11-14 23:22:23 +00003497 pIn2 = &aMem[p2];
drh2b4ded92010-09-27 21:09:31 +00003498 assert( memIsValid(pIn2) );
3499 assert( (pIn2->flags & MEM_Int)!=0 );
drh9cbf3422008-01-17 16:22:13 +00003500 sqlite3VdbeMemIntegerify(pIn2);
drh9c1905f2008-12-10 22:32:56 +00003501 p2 = (int)pIn2->u.i;
drh9a65f2c2009-06-22 19:05:40 +00003502 /* The p2 value always comes from a prior OP_CreateTable opcode and
3503 ** that opcode will always set the p2 value to 2 or more or else fail.
3504 ** If there were a failure, the prepared statement would have halted
3505 ** before reaching this instruction. */
drh9467abf2016-02-17 18:44:11 +00003506 assert( p2>=2 );
drh5edc3122001-09-13 21:53:09 +00003507 }
danielk1977d336e222009-02-20 10:58:41 +00003508 if( pOp->p4type==P4_KEYINFO ){
3509 pKeyInfo = pOp->p4.pKeyInfo;
drh41e13e12013-11-07 14:09:39 +00003510 assert( pKeyInfo->enc==ENC(db) );
3511 assert( pKeyInfo->db==db );
drhad124322013-10-23 13:30:58 +00003512 nField = pKeyInfo->nField+pKeyInfo->nXField;
danielk1977d336e222009-02-20 10:58:41 +00003513 }else if( pOp->p4type==P4_INT32 ){
3514 nField = pOp->p4.i;
3515 }
drh653b82a2009-06-22 11:10:47 +00003516 assert( pOp->p1>=0 );
drh399af1d2013-11-20 17:25:55 +00003517 assert( nField>=0 );
3518 testcase( nField==0 ); /* Table with INTEGER PRIMARY KEY and nothing else */
drhc960dcb2015-11-20 19:22:01 +00003519 pCur = allocateCursor(p, pOp->p1, nField, iDb, CURTYPE_BTREE);
drh4774b132004-06-12 20:12:51 +00003520 if( pCur==0 ) goto no_mem;
drhf328bc82004-05-10 23:29:49 +00003521 pCur->nullRow = 1;
drhd4187c72010-08-30 22:15:45 +00003522 pCur->isOrdered = 1;
drh35263192014-07-22 20:02:19 +00003523 pCur->pgnoRoot = p2;
drhb89aeb62016-01-27 15:49:32 +00003524#ifdef SQLITE_DEBUG
3525 pCur->wrFlag = wrFlag;
3526#endif
drhc960dcb2015-11-20 19:22:01 +00003527 rc = sqlite3BtreeCursor(pX, p2, wrFlag, pKeyInfo, pCur->uc.pCursor);
danielk1977d336e222009-02-20 10:58:41 +00003528 pCur->pKeyInfo = pKeyInfo;
drh14da87f2013-11-20 21:51:33 +00003529 /* Set the VdbeCursor.isTable variable. Previous versions of
danielk1977172114a2009-07-07 15:47:12 +00003530 ** SQLite used to check if the root-page flags were sane at this point
3531 ** and report database corruption if they were not, but this check has
3532 ** since moved into the btree layer. */
3533 pCur->isTable = pOp->p4type!=P4_KEYINFO;
drhe0997b32015-03-20 14:57:50 +00003534
3535open_cursor_set_hints:
3536 assert( OPFLAG_BULKCSR==BTREE_BULKLOAD );
3537 assert( OPFLAG_SEEKEQ==BTREE_SEEK_EQ );
drh0403cb32015-08-14 23:57:04 +00003538 testcase( pOp->p5 & OPFLAG_BULKCSR );
drh9abe8412016-01-02 05:00:31 +00003539#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh0403cb32015-08-14 23:57:04 +00003540 testcase( pOp->p2 & OPFLAG_SEEKEQ );
3541#endif
drhc960dcb2015-11-20 19:22:01 +00003542 sqlite3BtreeCursorHintFlags(pCur->uc.pCursor,
drhf7854c72015-10-27 13:24:37 +00003543 (pOp->p5 & (OPFLAG_BULKCSR|OPFLAG_SEEKEQ)));
drh9467abf2016-02-17 18:44:11 +00003544 if( rc ) goto abort_due_to_error;
drh5e00f6c2001-09-13 13:46:56 +00003545 break;
3546}
3547
drhe08e8d62017-05-01 15:15:41 +00003548/* Opcode: OpenDup P1 P2 * * *
3549**
3550** Open a new cursor P1 that points to the same ephemeral table as
3551** cursor P2. The P2 cursor must have been opened by a prior OP_OpenEphemeral
3552** opcode. Only ephemeral cursors may be duplicated.
3553**
3554** Duplicate ephemeral cursors are used for self-joins of materialized views.
3555*/
3556case OP_OpenDup: {
3557 VdbeCursor *pOrig; /* The original cursor to be duplicated */
3558 VdbeCursor *pCx; /* The new cursor */
3559
3560 pOrig = p->apCsr[pOp->p2];
3561 assert( pOrig->pBtx!=0 ); /* Only ephemeral cursors can be duplicated */
3562
3563 pCx = allocateCursor(p, pOp->p1, pOrig->nField, -1, CURTYPE_BTREE);
3564 if( pCx==0 ) goto no_mem;
3565 pCx->nullRow = 1;
3566 pCx->isEphemeral = 1;
3567 pCx->pKeyInfo = pOrig->pKeyInfo;
3568 pCx->isTable = pOrig->isTable;
3569 rc = sqlite3BtreeCursor(pOrig->pBtx, MASTER_ROOT, BTREE_WRCSR,
3570 pCx->pKeyInfo, pCx->uc.pCursor);
drh3f4df4c2017-05-02 17:54:19 +00003571 /* The sqlite3BtreeCursor() routine can only fail for the first cursor
3572 ** opened for a database. Since there is already an open cursor when this
3573 ** opcode is run, the sqlite3BtreeCursor() cannot fail */
3574 assert( rc==SQLITE_OK );
drhe08e8d62017-05-01 15:15:41 +00003575 break;
3576}
3577
3578
drh2a5d9902011-08-26 00:34:45 +00003579/* Opcode: OpenEphemeral P1 P2 * P4 P5
drh81316f82013-10-29 20:40:47 +00003580** Synopsis: nColumn=P2
drh5e00f6c2001-09-13 13:46:56 +00003581**
drhb9bb7c12006-06-11 23:41:55 +00003582** Open a new cursor P1 to a transient table.
drh9170dd72005-07-08 17:13:46 +00003583** The cursor is always opened read/write even if
drh25d3adb2010-04-05 15:11:08 +00003584** the main database is read-only. The ephemeral
drh9170dd72005-07-08 17:13:46 +00003585** table is deleted automatically when the cursor is closed.
drhc6b52df2002-01-04 03:09:29 +00003586**
drh25d3adb2010-04-05 15:11:08 +00003587** P2 is the number of columns in the ephemeral table.
drh66a51672008-01-03 00:01:23 +00003588** The cursor points to a BTree table if P4==0 and to a BTree index
3589** if P4 is not 0. If P4 is not NULL, it points to a KeyInfo structure
drhd3d39e92004-05-20 22:16:29 +00003590** that defines the format of keys in the index.
drhb9bb7c12006-06-11 23:41:55 +00003591**
drh2a5d9902011-08-26 00:34:45 +00003592** The P5 parameter can be a mask of the BTREE_* flags defined
3593** in btree.h. These flags control aspects of the operation of
3594** the btree. The BTREE_OMIT_JOURNAL and BTREE_SINGLE flags are
3595** added automatically.
drh5e00f6c2001-09-13 13:46:56 +00003596*/
drha21a64d2010-04-06 22:33:55 +00003597/* Opcode: OpenAutoindex P1 P2 * P4 *
drh81316f82013-10-29 20:40:47 +00003598** Synopsis: nColumn=P2
drha21a64d2010-04-06 22:33:55 +00003599**
3600** This opcode works the same as OP_OpenEphemeral. It has a
3601** different name to distinguish its use. Tables created using
3602** by this opcode will be used for automatically created transient
3603** indices in joins.
3604*/
3605case OP_OpenAutoindex:
drh9cbf3422008-01-17 16:22:13 +00003606case OP_OpenEphemeral: {
drhdfe88ec2008-11-03 20:55:06 +00003607 VdbeCursor *pCx;
drh41e13e12013-11-07 14:09:39 +00003608 KeyInfo *pKeyInfo;
3609
drhd4187c72010-08-30 22:15:45 +00003610 static const int vfsFlags =
drh33f4e022007-09-03 15:19:34 +00003611 SQLITE_OPEN_READWRITE |
3612 SQLITE_OPEN_CREATE |
3613 SQLITE_OPEN_EXCLUSIVE |
3614 SQLITE_OPEN_DELETEONCLOSE |
3615 SQLITE_OPEN_TRANSIENT_DB;
drh653b82a2009-06-22 11:10:47 +00003616 assert( pOp->p1>=0 );
drh399af1d2013-11-20 17:25:55 +00003617 assert( pOp->p2>=0 );
drhc960dcb2015-11-20 19:22:01 +00003618 pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_BTREE);
drh4774b132004-06-12 20:12:51 +00003619 if( pCx==0 ) goto no_mem;
drh17f71932002-02-21 12:01:27 +00003620 pCx->nullRow = 1;
drh079a3072014-03-19 14:10:55 +00003621 pCx->isEphemeral = 1;
drhfbd8cbd2016-12-10 12:58:15 +00003622 rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pCx->pBtx,
drhd4187c72010-08-30 22:15:45 +00003623 BTREE_OMIT_JOURNAL | BTREE_SINGLE | pOp->p5, vfsFlags);
drh5e00f6c2001-09-13 13:46:56 +00003624 if( rc==SQLITE_OK ){
drhfbd8cbd2016-12-10 12:58:15 +00003625 rc = sqlite3BtreeBeginTrans(pCx->pBtx, 1);
drh5e00f6c2001-09-13 13:46:56 +00003626 }
3627 if( rc==SQLITE_OK ){
danielk19774adee202004-05-08 08:23:19 +00003628 /* If a transient index is required, create it by calling
drhd4187c72010-08-30 22:15:45 +00003629 ** sqlite3BtreeCreateTable() with the BTREE_BLOBKEY flag before
danielk19774adee202004-05-08 08:23:19 +00003630 ** opening it. If a transient table is required, just use the
drhd4187c72010-08-30 22:15:45 +00003631 ** automatically created table with root-page 1 (an BLOB_INTKEY table).
danielk19774adee202004-05-08 08:23:19 +00003632 */
drhfbd8cbd2016-12-10 12:58:15 +00003633 if( (pCx->pKeyInfo = pKeyInfo = pOp->p4.pKeyInfo)!=0 ){
drhc6b52df2002-01-04 03:09:29 +00003634 int pgno;
drh66a51672008-01-03 00:01:23 +00003635 assert( pOp->p4type==P4_KEYINFO );
drhfbd8cbd2016-12-10 12:58:15 +00003636 rc = sqlite3BtreeCreateTable(pCx->pBtx, &pgno, BTREE_BLOBKEY | pOp->p5);
drhc6b52df2002-01-04 03:09:29 +00003637 if( rc==SQLITE_OK ){
drhf328bc82004-05-10 23:29:49 +00003638 assert( pgno==MASTER_ROOT+1 );
drh41e13e12013-11-07 14:09:39 +00003639 assert( pKeyInfo->db==db );
3640 assert( pKeyInfo->enc==ENC(db) );
drhfbd8cbd2016-12-10 12:58:15 +00003641 rc = sqlite3BtreeCursor(pCx->pBtx, pgno, BTREE_WRCSR,
drh62aaa6c2015-11-21 17:27:42 +00003642 pKeyInfo, pCx->uc.pCursor);
drhc6b52df2002-01-04 03:09:29 +00003643 }
drhf0863fe2005-06-12 21:35:51 +00003644 pCx->isTable = 0;
drhc6b52df2002-01-04 03:09:29 +00003645 }else{
drhfbd8cbd2016-12-10 12:58:15 +00003646 rc = sqlite3BtreeCursor(pCx->pBtx, MASTER_ROOT, BTREE_WRCSR,
drh62aaa6c2015-11-21 17:27:42 +00003647 0, pCx->uc.pCursor);
drhf0863fe2005-06-12 21:35:51 +00003648 pCx->isTable = 1;
drhc6b52df2002-01-04 03:09:29 +00003649 }
drh5e00f6c2001-09-13 13:46:56 +00003650 }
drh9467abf2016-02-17 18:44:11 +00003651 if( rc ) goto abort_due_to_error;
drhd4187c72010-08-30 22:15:45 +00003652 pCx->isOrdered = (pOp->p5!=BTREE_UNORDERED);
dan5134d132011-09-02 10:31:11 +00003653 break;
3654}
3655
danfad9f9a2014-04-01 18:41:51 +00003656/* Opcode: SorterOpen P1 P2 P3 P4 *
dan5134d132011-09-02 10:31:11 +00003657**
3658** This opcode works like OP_OpenEphemeral except that it opens
3659** a transient index that is specifically designed to sort large
3660** tables using an external merge-sort algorithm.
danfad9f9a2014-04-01 18:41:51 +00003661**
3662** If argument P3 is non-zero, then it indicates that the sorter may
3663** assume that a stable sort considering the first P3 fields of each
3664** key is sufficient to produce the required results.
dan5134d132011-09-02 10:31:11 +00003665*/
drhca892a72011-09-03 00:17:51 +00003666case OP_SorterOpen: {
dan5134d132011-09-02 10:31:11 +00003667 VdbeCursor *pCx;
drh3a949872012-09-18 13:20:13 +00003668
drh399af1d2013-11-20 17:25:55 +00003669 assert( pOp->p1>=0 );
3670 assert( pOp->p2>=0 );
drhc960dcb2015-11-20 19:22:01 +00003671 pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_SORTER);
dan5134d132011-09-02 10:31:11 +00003672 if( pCx==0 ) goto no_mem;
3673 pCx->pKeyInfo = pOp->p4.pKeyInfo;
drh41e13e12013-11-07 14:09:39 +00003674 assert( pCx->pKeyInfo->db==db );
3675 assert( pCx->pKeyInfo->enc==ENC(db) );
danfad9f9a2014-04-01 18:41:51 +00003676 rc = sqlite3VdbeSorterInit(db, pOp->p3, pCx);
drh9467abf2016-02-17 18:44:11 +00003677 if( rc ) goto abort_due_to_error;
drh5e00f6c2001-09-13 13:46:56 +00003678 break;
3679}
3680
dan78d58432014-03-25 15:04:07 +00003681/* Opcode: SequenceTest P1 P2 * * *
3682** Synopsis: if( cursor[P1].ctr++ ) pc = P2
3683**
3684** P1 is a sorter cursor. If the sequence counter is currently zero, jump
3685** to P2. Regardless of whether or not the jump is taken, increment the
3686** the sequence value.
3687*/
3688case OP_SequenceTest: {
3689 VdbeCursor *pC;
3690 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3691 pC = p->apCsr[pOp->p1];
drhc960dcb2015-11-20 19:22:01 +00003692 assert( isSorter(pC) );
dan78d58432014-03-25 15:04:07 +00003693 if( (pC->seqCount++)==0 ){
drhf56fa462015-04-13 21:39:54 +00003694 goto jump_to_p2;
dan78d58432014-03-25 15:04:07 +00003695 }
drh5e00f6c2001-09-13 13:46:56 +00003696 break;
3697}
3698
drh5f612292014-02-08 23:20:32 +00003699/* Opcode: OpenPseudo P1 P2 P3 * *
drh60830e32014-02-10 15:56:34 +00003700** Synopsis: P3 columns in r[P2]
drh70ce3f02003-04-15 19:22:22 +00003701**
3702** Open a new cursor that points to a fake table that contains a single
drh5f612292014-02-08 23:20:32 +00003703** row of data. The content of that one row is the content of memory
3704** register P2. In other words, cursor P1 becomes an alias for the
3705** MEM_Blob content contained in register P2.
drh70ce3f02003-04-15 19:22:22 +00003706**
drh2d8d7ce2010-02-15 15:17:05 +00003707** A pseudo-table created by this opcode is used to hold a single
drhcdd536f2006-03-17 00:04:03 +00003708** row output from the sorter so that the row can be decomposed into
drh3e9ca092009-09-08 01:14:48 +00003709** individual columns using the OP_Column opcode. The OP_Column opcode
3710** is the only cursor opcode that works with a pseudo-table.
danielk1977d336e222009-02-20 10:58:41 +00003711**
3712** P3 is the number of fields in the records that will be stored by
3713** the pseudo-table.
drh70ce3f02003-04-15 19:22:22 +00003714*/
drh9cbf3422008-01-17 16:22:13 +00003715case OP_OpenPseudo: {
drhdfe88ec2008-11-03 20:55:06 +00003716 VdbeCursor *pCx;
drh856c1032009-06-02 15:21:42 +00003717
drh653b82a2009-06-22 11:10:47 +00003718 assert( pOp->p1>=0 );
drh399af1d2013-11-20 17:25:55 +00003719 assert( pOp->p3>=0 );
drhc960dcb2015-11-20 19:22:01 +00003720 pCx = allocateCursor(p, pOp->p1, pOp->p3, -1, CURTYPE_PSEUDO);
drh4774b132004-06-12 20:12:51 +00003721 if( pCx==0 ) goto no_mem;
drh70ce3f02003-04-15 19:22:22 +00003722 pCx->nullRow = 1;
drhc960dcb2015-11-20 19:22:01 +00003723 pCx->uc.pseudoTableReg = pOp->p2;
drhf0863fe2005-06-12 21:35:51 +00003724 pCx->isTable = 1;
drh5f612292014-02-08 23:20:32 +00003725 assert( pOp->p5==0 );
drh70ce3f02003-04-15 19:22:22 +00003726 break;
3727}
3728
drh98757152008-01-09 23:04:12 +00003729/* Opcode: Close P1 * * * *
drh5e00f6c2001-09-13 13:46:56 +00003730**
3731** Close a cursor previously opened as P1. If P1 is not
3732** currently open, this instruction is a no-op.
3733*/
drh9cbf3422008-01-17 16:22:13 +00003734case OP_Close: {
drh653b82a2009-06-22 11:10:47 +00003735 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
3736 sqlite3VdbeFreeCursor(p, p->apCsr[pOp->p1]);
3737 p->apCsr[pOp->p1] = 0;
drh5e00f6c2001-09-13 13:46:56 +00003738 break;
3739}
3740
drh97bae792015-06-05 15:59:57 +00003741#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
3742/* Opcode: ColumnsUsed P1 * * P4 *
3743**
3744** This opcode (which only exists if SQLite was compiled with
3745** SQLITE_ENABLE_COLUMN_USED_MASK) identifies which columns of the
3746** table or index for cursor P1 are used. P4 is a 64-bit integer
3747** (P4_INT64) in which the first 63 bits are one for each of the
3748** first 63 columns of the table or index that are actually used
3749** by the cursor. The high-order bit is set if any column after
3750** the 64th is used.
3751*/
3752case OP_ColumnsUsed: {
3753 VdbeCursor *pC;
3754 pC = p->apCsr[pOp->p1];
drhc960dcb2015-11-20 19:22:01 +00003755 assert( pC->eCurType==CURTYPE_BTREE );
drh97bae792015-06-05 15:59:57 +00003756 pC->maskUsed = *(u64*)pOp->p4.pI64;
3757 break;
3758}
3759#endif
3760
drh8af3f772014-07-25 18:01:06 +00003761/* Opcode: SeekGE P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00003762** Synopsis: key=r[P3@P4]
drh5e00f6c2001-09-13 13:46:56 +00003763**
danielk1977b790c6c2008-04-18 10:25:24 +00003764** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
drh959403f2008-12-12 17:56:16 +00003765** use the value in register P3 as the key. If cursor P1 refers
danielk1977b790c6c2008-04-18 10:25:24 +00003766** to an SQL index, then P3 is the first in an array of P4 registers
3767** that are used as an unpacked index key.
3768**
3769** Reposition cursor P1 so that it points to the smallest entry that
3770** is greater than or equal to the key value. If there are no records
3771** greater than or equal to the key and P2 is not zero, then jump to P2.
drh7cf6e4d2004-05-19 14:56:55 +00003772**
drhb1d607d2015-11-05 22:30:54 +00003773** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3774** opcode will always land on a record that equally equals the key, or
3775** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3776** opcode must be followed by an IdxLE opcode with the same arguments.
3777** The IdxLE opcode will be skipped if this opcode succeeds, but the
3778** IdxLE opcode will be used on subsequent loop iterations.
3779**
drh8af3f772014-07-25 18:01:06 +00003780** This opcode leaves the cursor configured to move in forward order,
drhbc5cf382014-08-06 01:08:07 +00003781** from the beginning toward the end. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00003782** configured to use Next, not Prev.
drh8af3f772014-07-25 18:01:06 +00003783**
drh935850e2014-05-24 17:15:15 +00003784** See also: Found, NotFound, SeekLt, SeekGt, SeekLe
drh7cf6e4d2004-05-19 14:56:55 +00003785*/
drh8af3f772014-07-25 18:01:06 +00003786/* Opcode: SeekGT P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00003787** Synopsis: key=r[P3@P4]
drh7cf6e4d2004-05-19 14:56:55 +00003788**
danielk1977b790c6c2008-04-18 10:25:24 +00003789** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
drh959403f2008-12-12 17:56:16 +00003790** use the value in register P3 as a key. If cursor P1 refers
danielk1977b790c6c2008-04-18 10:25:24 +00003791** to an SQL index, then P3 is the first in an array of P4 registers
3792** that are used as an unpacked index key.
3793**
3794** Reposition cursor P1 so that it points to the smallest entry that
3795** is greater than the key value. If there are no records greater than
3796** the key and P2 is not zero, then jump to P2.
drhb19a2bc2001-09-16 00:13:26 +00003797**
drh8af3f772014-07-25 18:01:06 +00003798** This opcode leaves the cursor configured to move in forward order,
drh4ed2fb92014-08-14 13:06:25 +00003799** from the beginning toward the end. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00003800** configured to use Next, not Prev.
drh8af3f772014-07-25 18:01:06 +00003801**
drh935850e2014-05-24 17:15:15 +00003802** See also: Found, NotFound, SeekLt, SeekGe, SeekLe
drh5e00f6c2001-09-13 13:46:56 +00003803*/
drh8af3f772014-07-25 18:01:06 +00003804/* Opcode: SeekLT P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00003805** Synopsis: key=r[P3@P4]
drhc045ec52002-12-04 20:01:06 +00003806**
danielk1977b790c6c2008-04-18 10:25:24 +00003807** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
drh959403f2008-12-12 17:56:16 +00003808** use the value in register P3 as a key. If cursor P1 refers
danielk1977b790c6c2008-04-18 10:25:24 +00003809** to an SQL index, then P3 is the first in an array of P4 registers
3810** that are used as an unpacked index key.
3811**
3812** Reposition cursor P1 so that it points to the largest entry that
3813** is less than the key value. If there are no records less than
3814** the key and P2 is not zero, then jump to P2.
drhc045ec52002-12-04 20:01:06 +00003815**
drh8af3f772014-07-25 18:01:06 +00003816** This opcode leaves the cursor configured to move in reverse order,
3817** from the end toward the beginning. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00003818** configured to use Prev, not Next.
drh8af3f772014-07-25 18:01:06 +00003819**
drh935850e2014-05-24 17:15:15 +00003820** See also: Found, NotFound, SeekGt, SeekGe, SeekLe
drh7cf6e4d2004-05-19 14:56:55 +00003821*/
drh8af3f772014-07-25 18:01:06 +00003822/* Opcode: SeekLE P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00003823** Synopsis: key=r[P3@P4]
danielk19773d1bfea2004-05-14 11:00:53 +00003824**
danielk1977b790c6c2008-04-18 10:25:24 +00003825** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
drh959403f2008-12-12 17:56:16 +00003826** use the value in register P3 as a key. If cursor P1 refers
danielk1977b790c6c2008-04-18 10:25:24 +00003827** to an SQL index, then P3 is the first in an array of P4 registers
3828** that are used as an unpacked index key.
danielk1977751de562008-04-18 09:01:15 +00003829**
danielk1977b790c6c2008-04-18 10:25:24 +00003830** Reposition cursor P1 so that it points to the largest entry that
3831** is less than or equal to the key value. If there are no records
3832** less than or equal to the key and P2 is not zero, then jump to P2.
drh7cf6e4d2004-05-19 14:56:55 +00003833**
drh8af3f772014-07-25 18:01:06 +00003834** This opcode leaves the cursor configured to move in reverse order,
3835** from the end toward the beginning. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00003836** configured to use Prev, not Next.
drh8af3f772014-07-25 18:01:06 +00003837**
drhb1d607d2015-11-05 22:30:54 +00003838** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
3839** opcode will always land on a record that equally equals the key, or
3840** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
3841** opcode must be followed by an IdxGE opcode with the same arguments.
3842** The IdxGE opcode will be skipped if this opcode succeeds, but the
3843** IdxGE opcode will be used on subsequent loop iterations.
3844**
drh935850e2014-05-24 17:15:15 +00003845** See also: Found, NotFound, SeekGt, SeekGe, SeekLt
drhc045ec52002-12-04 20:01:06 +00003846*/
drh4a1d3652014-02-14 15:13:36 +00003847case OP_SeekLT: /* jump, in3 */
3848case OP_SeekLE: /* jump, in3 */
3849case OP_SeekGE: /* jump, in3 */
3850case OP_SeekGT: { /* jump, in3 */
drhb1d607d2015-11-05 22:30:54 +00003851 int res; /* Comparison result */
3852 int oc; /* Opcode */
3853 VdbeCursor *pC; /* The cursor to seek */
3854 UnpackedRecord r; /* The key to seek for */
3855 int nField; /* Number of columns or fields in the key */
3856 i64 iKey; /* The rowid we are to seek to */
drhd6b79462015-11-07 01:19:00 +00003857 int eqOnly; /* Only interested in == results */
drh80ff32f2001-11-04 18:32:46 +00003858
drh653b82a2009-06-22 11:10:47 +00003859 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh959403f2008-12-12 17:56:16 +00003860 assert( pOp->p2!=0 );
drh653b82a2009-06-22 11:10:47 +00003861 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00003862 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00003863 assert( pC->eCurType==CURTYPE_BTREE );
drh4a1d3652014-02-14 15:13:36 +00003864 assert( OP_SeekLE == OP_SeekLT+1 );
3865 assert( OP_SeekGE == OP_SeekLT+2 );
3866 assert( OP_SeekGT == OP_SeekLT+3 );
drhd4187c72010-08-30 22:15:45 +00003867 assert( pC->isOrdered );
drhc960dcb2015-11-20 19:22:01 +00003868 assert( pC->uc.pCursor!=0 );
drh3da046d2013-11-11 03:24:11 +00003869 oc = pOp->opcode;
drhd6b79462015-11-07 01:19:00 +00003870 eqOnly = 0;
drh3da046d2013-11-11 03:24:11 +00003871 pC->nullRow = 0;
drh8af3f772014-07-25 18:01:06 +00003872#ifdef SQLITE_DEBUG
3873 pC->seekOp = pOp->opcode;
3874#endif
drhe0997b32015-03-20 14:57:50 +00003875
drh3da046d2013-11-11 03:24:11 +00003876 if( pC->isTable ){
drhd6b79462015-11-07 01:19:00 +00003877 /* The BTREE_SEEK_EQ flag is only set on index cursors */
drh218c66e2016-12-27 12:35:36 +00003878 assert( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ)==0
3879 || CORRUPT_DB );
drhd6b79462015-11-07 01:19:00 +00003880
drh3da046d2013-11-11 03:24:11 +00003881 /* The input value in P3 might be of any type: integer, real, string,
3882 ** blob, or NULL. But it needs to be an integer before we can do
peter.d.reid60ec9142014-09-06 16:39:46 +00003883 ** the seek, so convert it. */
drh3da046d2013-11-11 03:24:11 +00003884 pIn3 = &aMem[pOp->p3];
drh11a6eee2014-09-19 22:01:54 +00003885 if( (pIn3->flags & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
drhbd9507c2014-08-23 17:21:37 +00003886 applyNumericAffinity(pIn3, 0);
3887 }
drh3da046d2013-11-11 03:24:11 +00003888 iKey = sqlite3VdbeIntValue(pIn3);
drh959403f2008-12-12 17:56:16 +00003889
drh3da046d2013-11-11 03:24:11 +00003890 /* If the P3 value could not be converted into an integer without
3891 ** loss of information, then special processing is required... */
3892 if( (pIn3->flags & MEM_Int)==0 ){
3893 if( (pIn3->flags & MEM_Real)==0 ){
3894 /* If the P3 value cannot be converted into any kind of a number,
3895 ** then the seek is not possible, so jump to P2 */
drhf56fa462015-04-13 21:39:54 +00003896 VdbeBranchTaken(1,2); goto jump_to_p2;
drh3da046d2013-11-11 03:24:11 +00003897 break;
3898 }
drh959403f2008-12-12 17:56:16 +00003899
danaa1776f2013-11-26 18:22:59 +00003900 /* If the approximation iKey is larger than the actual real search
3901 ** term, substitute >= for > and < for <=. e.g. if the search term
3902 ** is 4.9 and the integer approximation 5:
3903 **
3904 ** (x > 4.9) -> (x >= 5)
3905 ** (x <= 4.9) -> (x < 5)
3906 */
drh74eaba42014-09-18 17:52:15 +00003907 if( pIn3->u.r<(double)iKey ){
drh4a1d3652014-02-14 15:13:36 +00003908 assert( OP_SeekGE==(OP_SeekGT-1) );
3909 assert( OP_SeekLT==(OP_SeekLE-1) );
3910 assert( (OP_SeekLE & 0x0001)==(OP_SeekGT & 0x0001) );
3911 if( (oc & 0x0001)==(OP_SeekGT & 0x0001) ) oc--;
danaa1776f2013-11-26 18:22:59 +00003912 }
3913
3914 /* If the approximation iKey is smaller than the actual real search
3915 ** term, substitute <= for < and > for >=. */
drh74eaba42014-09-18 17:52:15 +00003916 else if( pIn3->u.r>(double)iKey ){
drh4a1d3652014-02-14 15:13:36 +00003917 assert( OP_SeekLE==(OP_SeekLT+1) );
3918 assert( OP_SeekGT==(OP_SeekGE+1) );
3919 assert( (OP_SeekLT & 0x0001)==(OP_SeekGE & 0x0001) );
3920 if( (oc & 0x0001)==(OP_SeekLT & 0x0001) ) oc++;
drh8721ce42001-11-07 14:22:00 +00003921 }
drh3da046d2013-11-11 03:24:11 +00003922 }
drhc960dcb2015-11-20 19:22:01 +00003923 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)iKey, 0, &res);
drhb53a5a92014-10-12 22:37:22 +00003924 pC->movetoTarget = iKey; /* Used by OP_Delete */
drh3da046d2013-11-11 03:24:11 +00003925 if( rc!=SQLITE_OK ){
3926 goto abort_due_to_error;
drh1af3fdb2004-07-18 21:33:01 +00003927 }
drhaa736092009-06-22 00:55:30 +00003928 }else{
drhd6b79462015-11-07 01:19:00 +00003929 /* For a cursor with the BTREE_SEEK_EQ hint, only the OP_SeekGE and
3930 ** OP_SeekLE opcodes are allowed, and these must be immediately followed
3931 ** by an OP_IdxGT or OP_IdxLT opcode, respectively, with the same key.
3932 */
drhc960dcb2015-11-20 19:22:01 +00003933 if( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ) ){
drhd6b79462015-11-07 01:19:00 +00003934 eqOnly = 1;
3935 assert( pOp->opcode==OP_SeekGE || pOp->opcode==OP_SeekLE );
3936 assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
3937 assert( pOp[1].p1==pOp[0].p1 );
3938 assert( pOp[1].p2==pOp[0].p2 );
3939 assert( pOp[1].p3==pOp[0].p3 );
3940 assert( pOp[1].p4.i==pOp[0].p4.i );
3941 }
3942
drh3da046d2013-11-11 03:24:11 +00003943 nField = pOp->p4.i;
3944 assert( pOp->p4type==P4_INT32 );
3945 assert( nField>0 );
3946 r.pKeyInfo = pC->pKeyInfo;
3947 r.nField = (u16)nField;
3948
3949 /* The next line of code computes as follows, only faster:
drh4a1d3652014-02-14 15:13:36 +00003950 ** if( oc==OP_SeekGT || oc==OP_SeekLE ){
dan1fed5da2014-02-25 21:01:25 +00003951 ** r.default_rc = -1;
drh3da046d2013-11-11 03:24:11 +00003952 ** }else{
dan1fed5da2014-02-25 21:01:25 +00003953 ** r.default_rc = +1;
drh3da046d2013-11-11 03:24:11 +00003954 ** }
danielk1977f7b9d662008-06-23 18:49:43 +00003955 */
dan1fed5da2014-02-25 21:01:25 +00003956 r.default_rc = ((1 & (oc - OP_SeekLT)) ? -1 : +1);
3957 assert( oc!=OP_SeekGT || r.default_rc==-1 );
3958 assert( oc!=OP_SeekLE || r.default_rc==-1 );
3959 assert( oc!=OP_SeekGE || r.default_rc==+1 );
3960 assert( oc!=OP_SeekLT || r.default_rc==+1 );
drh3da046d2013-11-11 03:24:11 +00003961
3962 r.aMem = &aMem[pOp->p3];
3963#ifdef SQLITE_DEBUG
3964 { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
3965#endif
drh70528d72015-11-05 20:25:09 +00003966 r.eqSeen = 0;
drhc960dcb2015-11-20 19:22:01 +00003967 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, &r, 0, 0, &res);
drh3da046d2013-11-11 03:24:11 +00003968 if( rc!=SQLITE_OK ){
3969 goto abort_due_to_error;
3970 }
drhb1d607d2015-11-05 22:30:54 +00003971 if( eqOnly && r.eqSeen==0 ){
3972 assert( res!=0 );
3973 goto seek_not_found;
drh70528d72015-11-05 20:25:09 +00003974 }
drh3da046d2013-11-11 03:24:11 +00003975 }
3976 pC->deferredMoveto = 0;
3977 pC->cacheStatus = CACHE_STALE;
3978#ifdef SQLITE_TEST
3979 sqlite3_search_count++;
3980#endif
drh4a1d3652014-02-14 15:13:36 +00003981 if( oc>=OP_SeekGE ){ assert( oc==OP_SeekGE || oc==OP_SeekGT );
3982 if( res<0 || (res==0 && oc==OP_SeekGT) ){
drhe39a7322014-02-03 14:04:11 +00003983 res = 0;
drh2ab792e2017-05-30 18:34:07 +00003984 rc = sqlite3BtreeNext(pC->uc.pCursor, 0);
3985 if( rc!=SQLITE_OK ){
3986 if( rc==SQLITE_DONE ){
3987 rc = SQLITE_OK;
3988 res = 1;
3989 }else{
3990 goto abort_due_to_error;
3991 }
3992 }
drh3da046d2013-11-11 03:24:11 +00003993 }else{
3994 res = 0;
3995 }
3996 }else{
drh4a1d3652014-02-14 15:13:36 +00003997 assert( oc==OP_SeekLT || oc==OP_SeekLE );
3998 if( res>0 || (res==0 && oc==OP_SeekLT) ){
drhe39a7322014-02-03 14:04:11 +00003999 res = 0;
drh2ab792e2017-05-30 18:34:07 +00004000 rc = sqlite3BtreePrevious(pC->uc.pCursor, 0);
4001 if( rc!=SQLITE_OK ){
4002 if( rc==SQLITE_DONE ){
4003 rc = SQLITE_OK;
4004 res = 1;
4005 }else{
4006 goto abort_due_to_error;
4007 }
4008 }
drh3da046d2013-11-11 03:24:11 +00004009 }else{
4010 /* res might be negative because the table is empty. Check to
4011 ** see if this is the case.
4012 */
drhc960dcb2015-11-20 19:22:01 +00004013 res = sqlite3BtreeEof(pC->uc.pCursor);
drh3da046d2013-11-11 03:24:11 +00004014 }
4015 }
drhb1d607d2015-11-05 22:30:54 +00004016seek_not_found:
drh3da046d2013-11-11 03:24:11 +00004017 assert( pOp->p2>0 );
drh688852a2014-02-17 22:40:43 +00004018 VdbeBranchTaken(res!=0,2);
drh3da046d2013-11-11 03:24:11 +00004019 if( res ){
drhf56fa462015-04-13 21:39:54 +00004020 goto jump_to_p2;
drhb1d607d2015-11-05 22:30:54 +00004021 }else if( eqOnly ){
4022 assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
4023 pOp++; /* Skip the OP_IdxLt or OP_IdxGT that follows */
drh5e00f6c2001-09-13 13:46:56 +00004024 }
drh5e00f6c2001-09-13 13:46:56 +00004025 break;
4026}
dan71c57db2016-07-09 20:23:55 +00004027
drh8cff69d2009-11-12 19:59:44 +00004028/* Opcode: Found P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00004029** Synopsis: key=r[P3@P4]
drh5e00f6c2001-09-13 13:46:56 +00004030**
drh8cff69d2009-11-12 19:59:44 +00004031** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4032** P4>0 then register P3 is the first of P4 registers that form an unpacked
4033** record.
4034**
4035** Cursor P1 is on an index btree. If the record identified by P3 and P4
4036** is a prefix of any entry in P1 then a jump is made to P2 and
drhe3365e62009-11-12 17:52:24 +00004037** P1 is left pointing at the matching entry.
drh6f225d02013-10-26 13:36:51 +00004038**
drhcefc87f2014-08-01 01:40:33 +00004039** This operation leaves the cursor in a state where it can be
4040** advanced in the forward direction. The Next instruction will work,
4041** but not the Prev instruction.
drh8af3f772014-07-25 18:01:06 +00004042**
drh6f225d02013-10-26 13:36:51 +00004043** See also: NotFound, NoConflict, NotExists. SeekGe
drh5e00f6c2001-09-13 13:46:56 +00004044*/
drh8cff69d2009-11-12 19:59:44 +00004045/* Opcode: NotFound P1 P2 P3 P4 *
drhf63552b2013-10-30 00:25:03 +00004046** Synopsis: key=r[P3@P4]
drh5e00f6c2001-09-13 13:46:56 +00004047**
drh8cff69d2009-11-12 19:59:44 +00004048** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4049** P4>0 then register P3 is the first of P4 registers that form an unpacked
4050** record.
4051**
4052** Cursor P1 is on an index btree. If the record identified by P3 and P4
4053** is not the prefix of any entry in P1 then a jump is made to P2. If P1
4054** does contain an entry whose prefix matches the P3/P4 record then control
4055** falls through to the next instruction and P1 is left pointing at the
4056** matching entry.
drh5e00f6c2001-09-13 13:46:56 +00004057**
drh8af3f772014-07-25 18:01:06 +00004058** This operation leaves the cursor in a state where it cannot be
4059** advanced in either direction. In other words, the Next and Prev
4060** opcodes do not work after this operation.
4061**
drh6f225d02013-10-26 13:36:51 +00004062** See also: Found, NotExists, NoConflict
drh5e00f6c2001-09-13 13:46:56 +00004063*/
drh6f225d02013-10-26 13:36:51 +00004064/* Opcode: NoConflict P1 P2 P3 P4 *
drh4af5bee2013-10-30 02:37:50 +00004065** Synopsis: key=r[P3@P4]
drh6f225d02013-10-26 13:36:51 +00004066**
4067** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
4068** P4>0 then register P3 is the first of P4 registers that form an unpacked
4069** record.
4070**
4071** Cursor P1 is on an index btree. If the record identified by P3 and P4
4072** contains any NULL value, jump immediately to P2. If all terms of the
4073** record are not-NULL then a check is done to determine if any row in the
4074** P1 index btree has a matching key prefix. If there are no matches, jump
4075** immediately to P2. If there is a match, fall through and leave the P1
4076** cursor pointing to the matching row.
4077**
4078** This opcode is similar to OP_NotFound with the exceptions that the
4079** branch is always taken if any part of the search key input is NULL.
4080**
drh8af3f772014-07-25 18:01:06 +00004081** This operation leaves the cursor in a state where it cannot be
4082** advanced in either direction. In other words, the Next and Prev
4083** opcodes do not work after this operation.
4084**
drh6f225d02013-10-26 13:36:51 +00004085** See also: NotFound, Found, NotExists
4086*/
4087case OP_NoConflict: /* jump, in3 */
drh9cbf3422008-01-17 16:22:13 +00004088case OP_NotFound: /* jump, in3 */
4089case OP_Found: { /* jump, in3 */
drh856c1032009-06-02 15:21:42 +00004090 int alreadyExists;
drhf56fa462015-04-13 21:39:54 +00004091 int takeJump;
drh6f225d02013-10-26 13:36:51 +00004092 int ii;
drhdfe88ec2008-11-03 20:55:06 +00004093 VdbeCursor *pC;
drh856c1032009-06-02 15:21:42 +00004094 int res;
drha582b012016-12-21 19:45:54 +00004095 UnpackedRecord *pFree;
drh856c1032009-06-02 15:21:42 +00004096 UnpackedRecord *pIdxKey;
drh8cff69d2009-11-12 19:59:44 +00004097 UnpackedRecord r;
drh856c1032009-06-02 15:21:42 +00004098
dan0ff297e2009-09-25 17:03:14 +00004099#ifdef SQLITE_TEST
drh6f225d02013-10-26 13:36:51 +00004100 if( pOp->opcode!=OP_NoConflict ) sqlite3_found_count++;
dan0ff297e2009-09-25 17:03:14 +00004101#endif
4102
drhaa736092009-06-22 00:55:30 +00004103 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh8cff69d2009-11-12 19:59:44 +00004104 assert( pOp->p4type==P4_INT32 );
drhaa736092009-06-22 00:55:30 +00004105 pC = p->apCsr[pOp->p1];
4106 assert( pC!=0 );
drh8af3f772014-07-25 18:01:06 +00004107#ifdef SQLITE_DEBUG
drhcefc87f2014-08-01 01:40:33 +00004108 pC->seekOp = pOp->opcode;
drh8af3f772014-07-25 18:01:06 +00004109#endif
drh3c657212009-11-17 23:59:58 +00004110 pIn3 = &aMem[pOp->p3];
drhc960dcb2015-11-20 19:22:01 +00004111 assert( pC->eCurType==CURTYPE_BTREE );
4112 assert( pC->uc.pCursor!=0 );
drh3da046d2013-11-11 03:24:11 +00004113 assert( pC->isTable==0 );
4114 if( pOp->p4.i>0 ){
4115 r.pKeyInfo = pC->pKeyInfo;
4116 r.nField = (u16)pOp->p4.i;
4117 r.aMem = pIn3;
drh8aaf7bc2016-09-20 01:19:18 +00004118#ifdef SQLITE_DEBUG
drh826af372014-02-08 19:12:21 +00004119 for(ii=0; ii<r.nField; ii++){
4120 assert( memIsValid(&r.aMem[ii]) );
drh8aaf7bc2016-09-20 01:19:18 +00004121 assert( (r.aMem[ii].flags & MEM_Zero)==0 || r.aMem[ii].n==0 );
drh826af372014-02-08 19:12:21 +00004122 if( ii ) REGISTER_TRACE(pOp->p3+ii, &r.aMem[ii]);
drh826af372014-02-08 19:12:21 +00004123 }
drh8aaf7bc2016-09-20 01:19:18 +00004124#endif
drh3da046d2013-11-11 03:24:11 +00004125 pIdxKey = &r;
drha582b012016-12-21 19:45:54 +00004126 pFree = 0;
drh3da046d2013-11-11 03:24:11 +00004127 }else{
drhe46515b2017-05-19 22:51:00 +00004128 assert( pIn3->flags & MEM_Blob );
4129 rc = ExpandBlob(pIn3);
4130 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
4131 if( rc ) goto no_mem;
drha582b012016-12-21 19:45:54 +00004132 pFree = pIdxKey = sqlite3VdbeAllocUnpackedRecord(pC->pKeyInfo);
drh3da046d2013-11-11 03:24:11 +00004133 if( pIdxKey==0 ) goto no_mem;
drh3da046d2013-11-11 03:24:11 +00004134 sqlite3VdbeRecordUnpack(pC->pKeyInfo, pIn3->n, pIn3->z, pIdxKey);
drh5e00f6c2001-09-13 13:46:56 +00004135 }
dan1fed5da2014-02-25 21:01:25 +00004136 pIdxKey->default_rc = 0;
drhf56fa462015-04-13 21:39:54 +00004137 takeJump = 0;
drh3da046d2013-11-11 03:24:11 +00004138 if( pOp->opcode==OP_NoConflict ){
4139 /* For the OP_NoConflict opcode, take the jump if any of the
4140 ** input fields are NULL, since any key with a NULL will not
4141 ** conflict */
mistachkin7bb6e8e2015-01-12 18:52:41 +00004142 for(ii=0; ii<pIdxKey->nField; ii++){
4143 if( pIdxKey->aMem[ii].flags & MEM_Null ){
drhf56fa462015-04-13 21:39:54 +00004144 takeJump = 1;
drh3da046d2013-11-11 03:24:11 +00004145 break;
drh6f225d02013-10-26 13:36:51 +00004146 }
4147 }
drh5e00f6c2001-09-13 13:46:56 +00004148 }
drhc960dcb2015-11-20 19:22:01 +00004149 rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, pIdxKey, 0, 0, &res);
drhdbd6a7d2017-04-05 12:39:49 +00004150 if( pFree ) sqlite3DbFreeNN(db, pFree);
drh3da046d2013-11-11 03:24:11 +00004151 if( rc!=SQLITE_OK ){
drh9467abf2016-02-17 18:44:11 +00004152 goto abort_due_to_error;
drh3da046d2013-11-11 03:24:11 +00004153 }
4154 pC->seekResult = res;
4155 alreadyExists = (res==0);
4156 pC->nullRow = 1-alreadyExists;
4157 pC->deferredMoveto = 0;
4158 pC->cacheStatus = CACHE_STALE;
drh5e00f6c2001-09-13 13:46:56 +00004159 if( pOp->opcode==OP_Found ){
drh688852a2014-02-17 22:40:43 +00004160 VdbeBranchTaken(alreadyExists!=0,2);
drhf56fa462015-04-13 21:39:54 +00004161 if( alreadyExists ) goto jump_to_p2;
drh5e00f6c2001-09-13 13:46:56 +00004162 }else{
drhf56fa462015-04-13 21:39:54 +00004163 VdbeBranchTaken(takeJump||alreadyExists==0,2);
4164 if( takeJump || !alreadyExists ) goto jump_to_p2;
drh5e00f6c2001-09-13 13:46:56 +00004165 }
drh5e00f6c2001-09-13 13:46:56 +00004166 break;
4167}
4168
drheeb95652016-05-26 20:56:38 +00004169/* Opcode: SeekRowid P1 P2 P3 * *
4170** Synopsis: intkey=r[P3]
4171**
4172** P1 is the index of a cursor open on an SQL table btree (with integer
4173** keys). If register P3 does not contain an integer or if P1 does not
4174** contain a record with rowid P3 then jump immediately to P2.
4175** Or, if P2 is 0, raise an SQLITE_CORRUPT error. If P1 does contain
4176** a record with rowid P3 then
4177** leave the cursor pointing at that record and fall through to the next
4178** instruction.
4179**
4180** The OP_NotExists opcode performs the same operation, but with OP_NotExists
4181** the P3 register must be guaranteed to contain an integer value. With this
4182** opcode, register P3 might not contain an integer.
4183**
4184** The OP_NotFound opcode performs the same operation on index btrees
4185** (with arbitrary multi-value keys).
4186**
4187** This opcode leaves the cursor in a state where it cannot be advanced
4188** in either direction. In other words, the Next and Prev opcodes will
4189** not work following this opcode.
4190**
4191** See also: Found, NotFound, NoConflict, SeekRowid
4192*/
drh9cbf3422008-01-17 16:22:13 +00004193/* Opcode: NotExists P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00004194** Synopsis: intkey=r[P3]
drh6b125452002-01-28 15:53:03 +00004195**
drh261c02d2013-10-25 14:46:15 +00004196** P1 is the index of a cursor open on an SQL table btree (with integer
4197** keys). P3 is an integer rowid. If P1 does not contain a record with
danc6157e12015-09-14 09:23:47 +00004198** rowid P3 then jump immediately to P2. Or, if P2 is 0, raise an
4199** SQLITE_CORRUPT error. If P1 does contain a record with rowid P3 then
4200** leave the cursor pointing at that record and fall through to the next
4201** instruction.
drh6b125452002-01-28 15:53:03 +00004202**
drheeb95652016-05-26 20:56:38 +00004203** The OP_SeekRowid opcode performs the same operation but also allows the
4204** P3 register to contain a non-integer value, in which case the jump is
4205** always taken. This opcode requires that P3 always contain an integer.
4206**
drh261c02d2013-10-25 14:46:15 +00004207** The OP_NotFound opcode performs the same operation on index btrees
4208** (with arbitrary multi-value keys).
drh6b125452002-01-28 15:53:03 +00004209**
drh8af3f772014-07-25 18:01:06 +00004210** This opcode leaves the cursor in a state where it cannot be advanced
4211** in either direction. In other words, the Next and Prev opcodes will
4212** not work following this opcode.
4213**
drheeb95652016-05-26 20:56:38 +00004214** See also: Found, NotFound, NoConflict, SeekRowid
drh6b125452002-01-28 15:53:03 +00004215*/
drheeb95652016-05-26 20:56:38 +00004216case OP_SeekRowid: { /* jump, in3 */
drhdfe88ec2008-11-03 20:55:06 +00004217 VdbeCursor *pC;
drh0ca3e242002-01-29 23:07:02 +00004218 BtCursor *pCrsr;
drh856c1032009-06-02 15:21:42 +00004219 int res;
4220 u64 iKey;
4221
drh3c657212009-11-17 23:59:58 +00004222 pIn3 = &aMem[pOp->p3];
drheeb95652016-05-26 20:56:38 +00004223 if( (pIn3->flags & MEM_Int)==0 ){
4224 applyAffinity(pIn3, SQLITE_AFF_NUMERIC, encoding);
4225 if( (pIn3->flags & MEM_Int)==0 ) goto jump_to_p2;
4226 }
4227 /* Fall through into OP_NotExists */
4228case OP_NotExists: /* jump, in3 */
4229 pIn3 = &aMem[pOp->p3];
drhaa736092009-06-22 00:55:30 +00004230 assert( pIn3->flags & MEM_Int );
4231 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4232 pC = p->apCsr[pOp->p1];
4233 assert( pC!=0 );
drh8af3f772014-07-25 18:01:06 +00004234#ifdef SQLITE_DEBUG
4235 pC->seekOp = 0;
4236#endif
drhaa736092009-06-22 00:55:30 +00004237 assert( pC->isTable );
drhc960dcb2015-11-20 19:22:01 +00004238 assert( pC->eCurType==CURTYPE_BTREE );
4239 pCrsr = pC->uc.pCursor;
drh3da046d2013-11-11 03:24:11 +00004240 assert( pCrsr!=0 );
4241 res = 0;
4242 iKey = pIn3->u.i;
4243 rc = sqlite3BtreeMovetoUnpacked(pCrsr, 0, iKey, 0, &res);
drhb79d5522015-09-14 19:26:37 +00004244 assert( rc==SQLITE_OK || res==0 );
drhb53a5a92014-10-12 22:37:22 +00004245 pC->movetoTarget = iKey; /* Used by OP_Delete */
drh3da046d2013-11-11 03:24:11 +00004246 pC->nullRow = 0;
4247 pC->cacheStatus = CACHE_STALE;
4248 pC->deferredMoveto = 0;
drh688852a2014-02-17 22:40:43 +00004249 VdbeBranchTaken(res!=0,2);
drh3da046d2013-11-11 03:24:11 +00004250 pC->seekResult = res;
danc6157e12015-09-14 09:23:47 +00004251 if( res!=0 ){
drhb79d5522015-09-14 19:26:37 +00004252 assert( rc==SQLITE_OK );
4253 if( pOp->p2==0 ){
4254 rc = SQLITE_CORRUPT_BKPT;
4255 }else{
4256 goto jump_to_p2;
4257 }
danc6157e12015-09-14 09:23:47 +00004258 }
drh9467abf2016-02-17 18:44:11 +00004259 if( rc ) goto abort_due_to_error;
drh6b125452002-01-28 15:53:03 +00004260 break;
4261}
4262
drh4c583122008-01-04 22:01:03 +00004263/* Opcode: Sequence P1 P2 * * *
drh079a3072014-03-19 14:10:55 +00004264** Synopsis: r[P2]=cursor[P1].ctr++
drh4db38a72005-09-01 12:16:28 +00004265**
drh4c583122008-01-04 22:01:03 +00004266** Find the next available sequence number for cursor P1.
drh9cbf3422008-01-17 16:22:13 +00004267** Write the sequence number into register P2.
drh4c583122008-01-04 22:01:03 +00004268** The sequence number on the cursor is incremented after this
4269** instruction.
drh4db38a72005-09-01 12:16:28 +00004270*/
drh27a348c2015-04-13 19:14:06 +00004271case OP_Sequence: { /* out2 */
drh653b82a2009-06-22 11:10:47 +00004272 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4273 assert( p->apCsr[pOp->p1]!=0 );
drhc960dcb2015-11-20 19:22:01 +00004274 assert( p->apCsr[pOp->p1]->eCurType!=CURTYPE_VTAB );
drh27a348c2015-04-13 19:14:06 +00004275 pOut = out2Prerelease(p, pOp);
drh653b82a2009-06-22 11:10:47 +00004276 pOut->u.i = p->apCsr[pOp->p1]->seqCount++;
drh4db38a72005-09-01 12:16:28 +00004277 break;
4278}
4279
4280
drh98757152008-01-09 23:04:12 +00004281/* Opcode: NewRowid P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00004282** Synopsis: r[P2]=rowid
drh5e00f6c2001-09-13 13:46:56 +00004283**
drhf0863fe2005-06-12 21:35:51 +00004284** Get a new integer record number (a.k.a "rowid") used as the key to a table.
drhb19a2bc2001-09-16 00:13:26 +00004285** The record number is not previously used as a key in the database
drh9cbf3422008-01-17 16:22:13 +00004286** table that cursor P1 points to. The new record number is written
4287** written to register P2.
drh205f48e2004-11-05 00:43:11 +00004288**
dan76d462e2009-08-30 11:42:51 +00004289** If P3>0 then P3 is a register in the root frame of this VDBE that holds
4290** the largest previously generated record number. No new record numbers are
4291** allowed to be less than this value. When this value reaches its maximum,
drhef8662b2011-06-20 21:47:58 +00004292** an SQLITE_FULL error is generated. The P3 register is updated with the '
dan76d462e2009-08-30 11:42:51 +00004293** generated record number. This P3 mechanism is used to help implement the
drh205f48e2004-11-05 00:43:11 +00004294** AUTOINCREMENT feature.
drh5e00f6c2001-09-13 13:46:56 +00004295*/
drh27a348c2015-04-13 19:14:06 +00004296case OP_NewRowid: { /* out2 */
drhaa736092009-06-22 00:55:30 +00004297 i64 v; /* The new rowid */
4298 VdbeCursor *pC; /* Cursor of table to get the new rowid */
4299 int res; /* Result of an sqlite3BtreeLast() */
4300 int cnt; /* Counter to limit the number of searches */
4301 Mem *pMem; /* Register holding largest rowid for AUTOINCREMENT */
dan76d462e2009-08-30 11:42:51 +00004302 VdbeFrame *pFrame; /* Root frame of VDBE */
drh856c1032009-06-02 15:21:42 +00004303
drh856c1032009-06-02 15:21:42 +00004304 v = 0;
4305 res = 0;
drh27a348c2015-04-13 19:14:06 +00004306 pOut = out2Prerelease(p, pOp);
drhaa736092009-06-22 00:55:30 +00004307 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4308 pC = p->apCsr[pOp->p1];
4309 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00004310 assert( pC->eCurType==CURTYPE_BTREE );
4311 assert( pC->uc.pCursor!=0 );
drh98ef0f62015-06-30 01:25:52 +00004312 {
drh5cf8e8c2002-02-19 22:42:05 +00004313 /* The next rowid or record number (different terms for the same
4314 ** thing) is obtained in a two-step algorithm.
4315 **
4316 ** First we attempt to find the largest existing rowid and add one
4317 ** to that. But if the largest existing rowid is already the maximum
4318 ** positive integer, we have to fall through to the second
4319 ** probabilistic algorithm
4320 **
4321 ** The second algorithm is to select a rowid at random and see if
4322 ** it already exists in the table. If it does not exist, we have
4323 ** succeeded. If the random rowid does exist, we select a new one
drhaa736092009-06-22 00:55:30 +00004324 ** and try again, up to 100 times.
drhdb5ed6d2001-09-18 22:17:44 +00004325 */
drhaa736092009-06-22 00:55:30 +00004326 assert( pC->isTable );
drhfe2093d2005-01-20 22:48:47 +00004327
drh75f86a42005-02-17 00:03:06 +00004328#ifdef SQLITE_32BIT_ROWID
4329# define MAX_ROWID 0x7fffffff
4330#else
drhfe2093d2005-01-20 22:48:47 +00004331 /* Some compilers complain about constants of the form 0x7fffffffffffffff.
4332 ** Others complain about 0x7ffffffffffffffffLL. The following macro seems
4333 ** to provide the constant while making all compilers happy.
4334 */
danielk197764202cf2008-11-17 15:31:47 +00004335# define MAX_ROWID (i64)( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
drh75f86a42005-02-17 00:03:06 +00004336#endif
drhfe2093d2005-01-20 22:48:47 +00004337
drh5cf8e8c2002-02-19 22:42:05 +00004338 if( !pC->useRandomRowid ){
drhc960dcb2015-11-20 19:22:01 +00004339 rc = sqlite3BtreeLast(pC->uc.pCursor, &res);
drhe0670b62014-02-12 21:31:12 +00004340 if( rc!=SQLITE_OK ){
4341 goto abort_due_to_error;
4342 }
4343 if( res ){
4344 v = 1; /* IMP: R-61914-48074 */
4345 }else{
drhc960dcb2015-11-20 19:22:01 +00004346 assert( sqlite3BtreeCursorIsValid(pC->uc.pCursor) );
drha7c90c42016-06-04 20:37:10 +00004347 v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
drhe0670b62014-02-12 21:31:12 +00004348 if( v>=MAX_ROWID ){
4349 pC->useRandomRowid = 1;
drh5cf8e8c2002-02-19 22:42:05 +00004350 }else{
drhe0670b62014-02-12 21:31:12 +00004351 v++; /* IMP: R-29538-34987 */
drh5cf8e8c2002-02-19 22:42:05 +00004352 }
drh3fc190c2001-09-14 03:24:23 +00004353 }
drhe0670b62014-02-12 21:31:12 +00004354 }
drh205f48e2004-11-05 00:43:11 +00004355
4356#ifndef SQLITE_OMIT_AUTOINCREMENT
drhe0670b62014-02-12 21:31:12 +00004357 if( pOp->p3 ){
4358 /* Assert that P3 is a valid memory cell. */
4359 assert( pOp->p3>0 );
4360 if( p->pFrame ){
4361 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
shaneabc6b892009-09-10 19:09:03 +00004362 /* Assert that P3 is a valid memory cell. */
drhe0670b62014-02-12 21:31:12 +00004363 assert( pOp->p3<=pFrame->nMem );
4364 pMem = &pFrame->aMem[pOp->p3];
4365 }else{
4366 /* Assert that P3 is a valid memory cell. */
drh9f6168b2016-03-19 23:32:58 +00004367 assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
drhe0670b62014-02-12 21:31:12 +00004368 pMem = &aMem[pOp->p3];
4369 memAboutToChange(p, pMem);
drh205f48e2004-11-05 00:43:11 +00004370 }
drhe0670b62014-02-12 21:31:12 +00004371 assert( memIsValid(pMem) );
drh205f48e2004-11-05 00:43:11 +00004372
drhe0670b62014-02-12 21:31:12 +00004373 REGISTER_TRACE(pOp->p3, pMem);
4374 sqlite3VdbeMemIntegerify(pMem);
4375 assert( (pMem->flags & MEM_Int)!=0 ); /* mem(P3) holds an integer */
4376 if( pMem->u.i==MAX_ROWID || pC->useRandomRowid ){
drhe77caa12016-11-02 13:18:46 +00004377 rc = SQLITE_FULL; /* IMP: R-17817-00630 */
drhe0670b62014-02-12 21:31:12 +00004378 goto abort_due_to_error;
4379 }
4380 if( v<pMem->u.i+1 ){
4381 v = pMem->u.i + 1;
4382 }
4383 pMem->u.i = v;
drh5cf8e8c2002-02-19 22:42:05 +00004384 }
drhe0670b62014-02-12 21:31:12 +00004385#endif
drh5cf8e8c2002-02-19 22:42:05 +00004386 if( pC->useRandomRowid ){
drh748a52c2010-09-01 11:50:08 +00004387 /* IMPLEMENTATION-OF: R-07677-41881 If the largest ROWID is equal to the
drhc79c7612010-01-01 18:57:48 +00004388 ** largest possible integer (9223372036854775807) then the database
drh748a52c2010-09-01 11:50:08 +00004389 ** engine starts picking positive candidate ROWIDs at random until
4390 ** it finds one that is not previously used. */
drhaa736092009-06-22 00:55:30 +00004391 assert( pOp->p3==0 ); /* We cannot be in random rowid mode if this is
4392 ** an AUTOINCREMENT table. */
drh5cf8e8c2002-02-19 22:42:05 +00004393 cnt = 0;
drh2c4dc632014-09-25 12:31:28 +00004394 do{
4395 sqlite3_randomness(sizeof(v), &v);
drhd8633462014-09-25 17:42:41 +00004396 v &= (MAX_ROWID>>1); v++; /* Ensure that v is greater than zero */
drhc960dcb2015-11-20 19:22:01 +00004397 }while( ((rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)v,
drh748a52c2010-09-01 11:50:08 +00004398 0, &res))==SQLITE_OK)
shanehc4d340a2010-09-01 02:37:56 +00004399 && (res==0)
drh2c4dc632014-09-25 12:31:28 +00004400 && (++cnt<100));
drh9467abf2016-02-17 18:44:11 +00004401 if( rc ) goto abort_due_to_error;
4402 if( res==0 ){
drhc79c7612010-01-01 18:57:48 +00004403 rc = SQLITE_FULL; /* IMP: R-38219-53002 */
drh5cf8e8c2002-02-19 22:42:05 +00004404 goto abort_due_to_error;
4405 }
drh748a52c2010-09-01 11:50:08 +00004406 assert( v>0 ); /* EV: R-40812-03570 */
drh1eaa2692001-09-18 02:02:23 +00004407 }
drha11846b2004-01-07 18:52:56 +00004408 pC->deferredMoveto = 0;
drh76873ab2006-01-07 18:48:26 +00004409 pC->cacheStatus = CACHE_STALE;
drh5e00f6c2001-09-13 13:46:56 +00004410 }
drh4c583122008-01-04 22:01:03 +00004411 pOut->u.i = v;
drh5e00f6c2001-09-13 13:46:56 +00004412 break;
4413}
4414
danielk19771f4aa332008-01-03 09:51:55 +00004415/* Opcode: Insert P1 P2 P3 P4 P5
drh81316f82013-10-29 20:40:47 +00004416** Synopsis: intkey=r[P3] data=r[P2]
drh5e00f6c2001-09-13 13:46:56 +00004417**
jplyon5a564222003-06-02 06:15:58 +00004418** Write an entry into the table of cursor P1. A new entry is
drhb19a2bc2001-09-16 00:13:26 +00004419** created if it doesn't already exist or the data for an existing
drh3e9ca092009-09-08 01:14:48 +00004420** entry is overwritten. The data is the value MEM_Blob stored in register
danielk19771f4aa332008-01-03 09:51:55 +00004421** number P2. The key is stored in register P3. The key must
drh3e9ca092009-09-08 01:14:48 +00004422** be a MEM_Int.
drh4a324312001-12-21 14:30:42 +00004423**
danielk19771f4aa332008-01-03 09:51:55 +00004424** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
4425** incremented (otherwise not). If the OPFLAG_LASTROWID flag of P5 is set,
danielk1977b28af712004-06-21 06:50:26 +00004426** then rowid is stored for subsequent return by the
drh85b623f2007-12-13 21:54:09 +00004427** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
drh6b125452002-01-28 15:53:03 +00004428**
drheaf6ae22016-11-09 20:14:34 +00004429** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
4430** run faster by avoiding an unnecessary seek on cursor P1. However,
4431** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
4432** seeks on the cursor or if the most recent seek used a key equal to P3.
drh3e9ca092009-09-08 01:14:48 +00004433**
4434** If the OPFLAG_ISUPDATE flag is set, then this opcode is part of an
4435** UPDATE operation. Otherwise (if the flag is clear) then this opcode
4436** is part of an INSERT operation. The difference is only important to
4437** the update hook.
4438**
dan319eeb72011-03-19 08:38:50 +00004439** Parameter P4 may point to a Table structure, or may be NULL. If it is
4440** not NULL, then the update-hook (sqlite3.xUpdateCallback) is invoked
4441** following a successful insert.
danielk19771f6eec52006-06-16 06:17:47 +00004442**
drh93aed5a2008-01-16 17:46:38 +00004443** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
4444** allocated, then ownership of P2 is transferred to the pseudo-cursor
4445** and register P2 becomes ephemeral. If the cursor is changed, the
4446** value of register P2 will then change. Make sure this does not
4447** cause any problems.)
4448**
drhf0863fe2005-06-12 21:35:51 +00004449** This instruction only works on tables. The equivalent instruction
4450** for indices is OP_IdxInsert.
drh6b125452002-01-28 15:53:03 +00004451*/
drhe05c9292009-10-29 13:48:10 +00004452/* Opcode: InsertInt P1 P2 P3 P4 P5
drh72e26de2016-08-24 21:24:04 +00004453** Synopsis: intkey=P3 data=r[P2]
drhe05c9292009-10-29 13:48:10 +00004454**
4455** This works exactly like OP_Insert except that the key is the
4456** integer value P3, not the value of the integer stored in register P3.
4457*/
4458case OP_Insert:
4459case OP_InsertInt: {
drh3e9ca092009-09-08 01:14:48 +00004460 Mem *pData; /* MEM cell holding data for the record to be inserted */
4461 Mem *pKey; /* MEM cell holding key for the record */
drh3e9ca092009-09-08 01:14:48 +00004462 VdbeCursor *pC; /* Cursor to table into which insert is written */
drh3e9ca092009-09-08 01:14:48 +00004463 int seekResult; /* Result of prior seek or 0 if no USESEEKRESULT flag */
4464 const char *zDb; /* database name - used by the update hook */
dan319eeb72011-03-19 08:38:50 +00004465 Table *pTab; /* Table structure - used by update and pre-update hooks */
drh74c33022016-03-30 12:56:55 +00004466 int op; /* Opcode for update hook: SQLITE_UPDATE or SQLITE_INSERT */
drh8eeb4462016-05-21 20:03:42 +00004467 BtreePayload x; /* Payload to be inserted */
drh856c1032009-06-02 15:21:42 +00004468
drh74c33022016-03-30 12:56:55 +00004469 op = 0;
drha6c2ed92009-11-14 23:22:23 +00004470 pData = &aMem[pOp->p2];
drh653b82a2009-06-22 11:10:47 +00004471 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh2b4ded92010-09-27 21:09:31 +00004472 assert( memIsValid(pData) );
drh653b82a2009-06-22 11:10:47 +00004473 pC = p->apCsr[pOp->p1];
drha05a7222008-01-19 03:35:58 +00004474 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00004475 assert( pC->eCurType==CURTYPE_BTREE );
4476 assert( pC->uc.pCursor!=0 );
dancb9a3642017-01-30 19:44:53 +00004477 assert( (pOp->p5 & OPFLAG_ISNOOP) || pC->isTable );
drhcbf1b8e2013-11-11 22:55:26 +00004478 assert( pOp->p4type==P4_TABLE || pOp->p4type>=P4_STATIC );
drh5b6afba2008-01-05 16:29:28 +00004479 REGISTER_TRACE(pOp->p2, pData);
danielk19775f8d8a82004-05-11 00:28:42 +00004480
drhe05c9292009-10-29 13:48:10 +00004481 if( pOp->opcode==OP_Insert ){
drha6c2ed92009-11-14 23:22:23 +00004482 pKey = &aMem[pOp->p3];
drhe05c9292009-10-29 13:48:10 +00004483 assert( pKey->flags & MEM_Int );
drh2b4ded92010-09-27 21:09:31 +00004484 assert( memIsValid(pKey) );
drhe05c9292009-10-29 13:48:10 +00004485 REGISTER_TRACE(pOp->p3, pKey);
drh8eeb4462016-05-21 20:03:42 +00004486 x.nKey = pKey->u.i;
drhe05c9292009-10-29 13:48:10 +00004487 }else{
4488 assert( pOp->opcode==OP_InsertInt );
drh8eeb4462016-05-21 20:03:42 +00004489 x.nKey = pOp->p3;
drhe05c9292009-10-29 13:48:10 +00004490 }
4491
drh9b1c62d2011-03-30 21:04:43 +00004492 if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
dan46c47d42011-03-01 18:42:07 +00004493 assert( pC->iDb>=0 );
drh69c33822016-08-18 14:33:11 +00004494 zDb = db->aDb[pC->iDb].zDbSName;
dan319eeb72011-03-19 08:38:50 +00004495 pTab = pOp->p4.pTab;
dancb9a3642017-01-30 19:44:53 +00004496 assert( (pOp->p5 & OPFLAG_ISNOOP) || HasRowid(pTab) );
dan46c47d42011-03-01 18:42:07 +00004497 op = ((pOp->p5 & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_INSERT);
drh74c33022016-03-30 12:56:55 +00004498 }else{
drh13795212017-01-31 15:27:04 +00004499 pTab = 0; /* Not needed. Silence a compiler warning. */
drh74c33022016-03-30 12:56:55 +00004500 zDb = 0; /* Not needed. Silence a compiler warning. */
dan46c47d42011-03-01 18:42:07 +00004501 }
4502
drh9b1c62d2011-03-30 21:04:43 +00004503#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00004504 /* Invoke the pre-update hook, if any */
4505 if( db->xPreUpdateCallback
dan319eeb72011-03-19 08:38:50 +00004506 && pOp->p4type==P4_TABLE
drh92fe38e2014-10-14 13:41:32 +00004507 && !(pOp->p5 & OPFLAG_ISUPDATE)
dan46c47d42011-03-01 18:42:07 +00004508 ){
drh8eeb4462016-05-21 20:03:42 +00004509 sqlite3VdbePreUpdateHook(p, pC, SQLITE_INSERT, zDb, pTab, x.nKey, pOp->p2);
dan46c47d42011-03-01 18:42:07 +00004510 }
dancb9a3642017-01-30 19:44:53 +00004511 if( pOp->p5 & OPFLAG_ISNOOP ) break;
drh9b1c62d2011-03-30 21:04:43 +00004512#endif
dan46c47d42011-03-01 18:42:07 +00004513
drha05a7222008-01-19 03:35:58 +00004514 if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
drhfae58d52017-01-26 17:26:44 +00004515 if( pOp->p5 & OPFLAG_LASTROWID ) db->lastRowid = x.nKey;
drha05a7222008-01-19 03:35:58 +00004516 if( pData->flags & MEM_Null ){
drh8eeb4462016-05-21 20:03:42 +00004517 x.pData = 0;
4518 x.nData = 0;
drha05a7222008-01-19 03:35:58 +00004519 }else{
4520 assert( pData->flags & (MEM_Blob|MEM_Str) );
drh8eeb4462016-05-21 20:03:42 +00004521 x.pData = pData->z;
4522 x.nData = pData->n;
drha05a7222008-01-19 03:35:58 +00004523 }
drh3e9ca092009-09-08 01:14:48 +00004524 seekResult = ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0);
4525 if( pData->flags & MEM_Zero ){
drh8eeb4462016-05-21 20:03:42 +00004526 x.nZero = pData->u.nZero;
drha05a7222008-01-19 03:35:58 +00004527 }else{
drh8eeb4462016-05-21 20:03:42 +00004528 x.nZero = 0;
drha05a7222008-01-19 03:35:58 +00004529 }
drh8eeb4462016-05-21 20:03:42 +00004530 x.pKey = 0;
4531 rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
danf91c1312017-01-10 20:04:38 +00004532 (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)), seekResult
drh3e9ca092009-09-08 01:14:48 +00004533 );
drha05a7222008-01-19 03:35:58 +00004534 pC->deferredMoveto = 0;
4535 pC->cacheStatus = CACHE_STALE;
danielk197794eb6a12005-12-15 15:22:08 +00004536
drha05a7222008-01-19 03:35:58 +00004537 /* Invoke the update-hook if required. */
drh9467abf2016-02-17 18:44:11 +00004538 if( rc ) goto abort_due_to_error;
drhc556f3c2016-03-30 15:30:07 +00004539 if( db->xUpdateCallback && op ){
drh8eeb4462016-05-21 20:03:42 +00004540 db->xUpdateCallback(db->pUpdateArg, op, zDb, pTab->zName, x.nKey);
drha05a7222008-01-19 03:35:58 +00004541 }
drh5e00f6c2001-09-13 13:46:56 +00004542 break;
4543}
4544
dan438b8812015-09-15 15:55:15 +00004545/* Opcode: Delete P1 P2 P3 P4 P5
drh5e00f6c2001-09-13 13:46:56 +00004546**
drh5edc3122001-09-13 21:53:09 +00004547** Delete the record at which the P1 cursor is currently pointing.
4548**
drhe807bdb2016-01-21 17:06:33 +00004549** If the OPFLAG_SAVEPOSITION bit of the P5 parameter is set, then
4550** the cursor will be left pointing at either the next or the previous
4551** record in the table. If it is left pointing at the next record, then
4552** the next Next instruction will be a no-op. As a result, in this case
4553** it is ok to delete a record from within a Next loop. If
4554** OPFLAG_SAVEPOSITION bit of P5 is clear, then the cursor will be
4555** left in an undefined state.
drhc8d30ac2002-04-12 10:08:59 +00004556**
drhdef19e32016-01-27 16:26:25 +00004557** If the OPFLAG_AUXDELETE bit is set on P5, that indicates that this
4558** delete one of several associated with deleting a table row and all its
4559** associated index entries. Exactly one of those deletes is the "primary"
4560** delete. The others are all on OPFLAG_FORDELETE cursors or else are
4561** marked with the AUXDELETE flag.
drhe807bdb2016-01-21 17:06:33 +00004562**
4563** If the OPFLAG_NCHANGE flag of P2 (NB: P2 not P5) is set, then the row
4564** change count is incremented (otherwise not).
drh70ce3f02003-04-15 19:22:22 +00004565**
drh91fd4d42008-01-19 20:11:25 +00004566** P1 must not be pseudo-table. It has to be a real table with
4567** multiple rows.
4568**
drh5e769a52016-09-28 16:05:53 +00004569** If P4 is not NULL then it points to a Table object. In this case either
dan319eeb72011-03-19 08:38:50 +00004570** the update or pre-update hook, or both, may be invoked. The P1 cursor must
4571** have been positioned using OP_NotFound prior to invoking this opcode in
4572** this case. Specifically, if one is configured, the pre-update hook is
4573** invoked if P4 is not NULL. The update-hook is invoked if one is configured,
4574** P4 is not NULL, and the OPFLAG_NCHANGE flag is set in P2.
dan46c47d42011-03-01 18:42:07 +00004575**
4576** If the OPFLAG_ISUPDATE flag is set in P2, then P3 contains the address
4577** of the memory cell that contains the value that the rowid of the row will
4578** be set to by the update.
drh5e00f6c2001-09-13 13:46:56 +00004579*/
drh9cbf3422008-01-17 16:22:13 +00004580case OP_Delete: {
drhdfe88ec2008-11-03 20:55:06 +00004581 VdbeCursor *pC;
dan46c47d42011-03-01 18:42:07 +00004582 const char *zDb;
dan319eeb72011-03-19 08:38:50 +00004583 Table *pTab;
dan46c47d42011-03-01 18:42:07 +00004584 int opflags;
drh91fd4d42008-01-19 20:11:25 +00004585
dan46c47d42011-03-01 18:42:07 +00004586 opflags = pOp->p2;
drh653b82a2009-06-22 11:10:47 +00004587 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4588 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00004589 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00004590 assert( pC->eCurType==CURTYPE_BTREE );
4591 assert( pC->uc.pCursor!=0 );
drh9a65f2c2009-06-22 19:05:40 +00004592 assert( pC->deferredMoveto==0 );
drh9a65f2c2009-06-22 19:05:40 +00004593
drhb53a5a92014-10-12 22:37:22 +00004594#ifdef SQLITE_DEBUG
dan438b8812015-09-15 15:55:15 +00004595 if( pOp->p4type==P4_TABLE && HasRowid(pOp->p4.pTab) && pOp->p5==0 ){
4596 /* If p5 is zero, the seek operation that positioned the cursor prior to
4597 ** OP_Delete will have also set the pC->movetoTarget field to the rowid of
4598 ** the row that is being deleted */
drha7c90c42016-06-04 20:37:10 +00004599 i64 iKey = sqlite3BtreeIntegerKey(pC->uc.pCursor);
drh92fe38e2014-10-14 13:41:32 +00004600 assert( pC->movetoTarget==iKey );
drhb53a5a92014-10-12 22:37:22 +00004601 }
4602#endif
drh91fd4d42008-01-19 20:11:25 +00004603
dan438b8812015-09-15 15:55:15 +00004604 /* If the update-hook or pre-update-hook will be invoked, set zDb to
4605 ** the name of the db to pass as to it. Also set local pTab to a copy
4606 ** of p4.pTab. Finally, if p5 is true, indicating that this cursor was
4607 ** last moved with OP_Next or OP_Prev, not Seek or NotFound, set
4608 ** VdbeCursor.movetoTarget to the current rowid. */
drhc556f3c2016-03-30 15:30:07 +00004609 if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
dan46c47d42011-03-01 18:42:07 +00004610 assert( pC->iDb>=0 );
drhc556f3c2016-03-30 15:30:07 +00004611 assert( pOp->p4.pTab!=0 );
drh69c33822016-08-18 14:33:11 +00004612 zDb = db->aDb[pC->iDb].zDbSName;
dan319eeb72011-03-19 08:38:50 +00004613 pTab = pOp->p4.pTab;
drhc556f3c2016-03-30 15:30:07 +00004614 if( (pOp->p5 & OPFLAG_SAVEPOSITION)!=0 && pC->isTable ){
drha7c90c42016-06-04 20:37:10 +00004615 pC->movetoTarget = sqlite3BtreeIntegerKey(pC->uc.pCursor);
dan438b8812015-09-15 15:55:15 +00004616 }
drh74c33022016-03-30 12:56:55 +00004617 }else{
4618 zDb = 0; /* Not needed. Silence a compiler warning. */
4619 pTab = 0; /* Not needed. Silence a compiler warning. */
drh92fe38e2014-10-14 13:41:32 +00004620 }
dan46c47d42011-03-01 18:42:07 +00004621
drh9b1c62d2011-03-30 21:04:43 +00004622#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00004623 /* Invoke the pre-update-hook if required. */
dancb9a3642017-01-30 19:44:53 +00004624 if( db->xPreUpdateCallback && pOp->p4.pTab ){
4625 assert( !(opflags & OPFLAG_ISUPDATE)
4626 || HasRowid(pTab)==0
4627 || (aMem[pOp->p3].flags & MEM_Int)
4628 );
dan46c47d42011-03-01 18:42:07 +00004629 sqlite3VdbePreUpdateHook(p, pC,
4630 (opflags & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_DELETE,
drh92fe38e2014-10-14 13:41:32 +00004631 zDb, pTab, pC->movetoTarget,
dan37db03b2011-03-16 19:59:18 +00004632 pOp->p3
dan46c47d42011-03-01 18:42:07 +00004633 );
4634 }
dan46c47d42011-03-01 18:42:07 +00004635 if( opflags & OPFLAG_ISNOOP ) break;
drhc556f3c2016-03-30 15:30:07 +00004636#endif
drhb53a5a92014-10-12 22:37:22 +00004637
drhdef19e32016-01-27 16:26:25 +00004638 /* Only flags that can be set are SAVEPOISTION and AUXDELETE */
4639 assert( (pOp->p5 & ~(OPFLAG_SAVEPOSITION|OPFLAG_AUXDELETE))==0 );
drhe807bdb2016-01-21 17:06:33 +00004640 assert( OPFLAG_SAVEPOSITION==BTREE_SAVEPOSITION );
drhdef19e32016-01-27 16:26:25 +00004641 assert( OPFLAG_AUXDELETE==BTREE_AUXDELETE );
drhb89aeb62016-01-27 15:49:32 +00004642
4643#ifdef SQLITE_DEBUG
dane61bbf42016-01-28 17:06:17 +00004644 if( p->pFrame==0 ){
4645 if( pC->isEphemeral==0
4646 && (pOp->p5 & OPFLAG_AUXDELETE)==0
4647 && (pC->wrFlag & OPFLAG_FORDELETE)==0
4648 ){
4649 nExtraDelete++;
4650 }
4651 if( pOp->p2 & OPFLAG_NCHANGE ){
4652 nExtraDelete--;
4653 }
drhb89aeb62016-01-27 15:49:32 +00004654 }
4655#endif
4656
drhc960dcb2015-11-20 19:22:01 +00004657 rc = sqlite3BtreeDelete(pC->uc.pCursor, pOp->p5);
drh91fd4d42008-01-19 20:11:25 +00004658 pC->cacheStatus = CACHE_STALE;
dan3b908d42016-11-08 19:22:32 +00004659 pC->seekResult = 0;
drhd3e1af42016-02-25 18:54:30 +00004660 if( rc ) goto abort_due_to_error;
danielk197794eb6a12005-12-15 15:22:08 +00004661
drh91fd4d42008-01-19 20:11:25 +00004662 /* Invoke the update-hook if required. */
dan46c47d42011-03-01 18:42:07 +00004663 if( opflags & OPFLAG_NCHANGE ){
4664 p->nChange++;
drhc556f3c2016-03-30 15:30:07 +00004665 if( db->xUpdateCallback && HasRowid(pTab) ){
drh92fe38e2014-10-14 13:41:32 +00004666 db->xUpdateCallback(db->pUpdateArg, SQLITE_DELETE, zDb, pTab->zName,
dan438b8812015-09-15 15:55:15 +00004667 pC->movetoTarget);
4668 assert( pC->iDb>=0 );
dan46c47d42011-03-01 18:42:07 +00004669 }
drh5e00f6c2001-09-13 13:46:56 +00004670 }
dan438b8812015-09-15 15:55:15 +00004671
rdcb0c374f2004-02-20 22:53:38 +00004672 break;
4673}
drhb7f1d9a2009-09-08 02:27:58 +00004674/* Opcode: ResetCount * * * * *
rdcb0c374f2004-02-20 22:53:38 +00004675**
drhb7f1d9a2009-09-08 02:27:58 +00004676** The value of the change counter is copied to the database handle
4677** change counter (returned by subsequent calls to sqlite3_changes()).
4678** Then the VMs internal change counter resets to 0.
4679** This is used by trigger programs.
rdcb0c374f2004-02-20 22:53:38 +00004680*/
drh9cbf3422008-01-17 16:22:13 +00004681case OP_ResetCount: {
drhb7f1d9a2009-09-08 02:27:58 +00004682 sqlite3VdbeSetChanges(db, p->nChange);
danielk1977b28af712004-06-21 06:50:26 +00004683 p->nChange = 0;
drh5e00f6c2001-09-13 13:46:56 +00004684 break;
4685}
4686
drh1153c7b2013-11-01 22:02:56 +00004687/* Opcode: SorterCompare P1 P2 P3 P4
drh72e26de2016-08-24 21:24:04 +00004688** Synopsis: if key(P1)!=trim(r[P3],P4) goto P2
dan5134d132011-09-02 10:31:11 +00004689**
drh1153c7b2013-11-01 22:02:56 +00004690** P1 is a sorter cursor. This instruction compares a prefix of the
drhbc5cf382014-08-06 01:08:07 +00004691** record blob in register P3 against a prefix of the entry that
drhac502322014-07-30 13:56:48 +00004692** the sorter cursor currently points to. Only the first P4 fields
4693** of r[P3] and the sorter record are compared.
drh1153c7b2013-11-01 22:02:56 +00004694**
4695** If either P3 or the sorter contains a NULL in one of their significant
4696** fields (not counting the P4 fields at the end which are ignored) then
4697** the comparison is assumed to be equal.
4698**
4699** Fall through to next instruction if the two records compare equal to
4700** each other. Jump to P2 if they are different.
dan5134d132011-09-02 10:31:11 +00004701*/
4702case OP_SorterCompare: {
4703 VdbeCursor *pC;
4704 int res;
drhac502322014-07-30 13:56:48 +00004705 int nKeyCol;
dan5134d132011-09-02 10:31:11 +00004706
4707 pC = p->apCsr[pOp->p1];
4708 assert( isSorter(pC) );
drh1153c7b2013-11-01 22:02:56 +00004709 assert( pOp->p4type==P4_INT32 );
dan5134d132011-09-02 10:31:11 +00004710 pIn3 = &aMem[pOp->p3];
drhac502322014-07-30 13:56:48 +00004711 nKeyCol = pOp->p4.i;
drh958d2612014-04-18 13:40:07 +00004712 res = 0;
drhac502322014-07-30 13:56:48 +00004713 rc = sqlite3VdbeSorterCompare(pC, pIn3, nKeyCol, &res);
drh688852a2014-02-17 22:40:43 +00004714 VdbeBranchTaken(res!=0,2);
drh9467abf2016-02-17 18:44:11 +00004715 if( rc ) goto abort_due_to_error;
drhf56fa462015-04-13 21:39:54 +00004716 if( res ) goto jump_to_p2;
dan5134d132011-09-02 10:31:11 +00004717 break;
4718};
4719
drh6cf4a7d2014-10-13 13:00:58 +00004720/* Opcode: SorterData P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00004721** Synopsis: r[P2]=data
dan5134d132011-09-02 10:31:11 +00004722**
4723** Write into register P2 the current sorter data for sorter cursor P1.
drh6cf4a7d2014-10-13 13:00:58 +00004724** Then clear the column header cache on cursor P3.
4725**
4726** This opcode is normally use to move a record out of the sorter and into
4727** a register that is the source for a pseudo-table cursor created using
4728** OpenPseudo. That pseudo-table cursor is the one that is identified by
4729** parameter P3. Clearing the P3 column cache as part of this opcode saves
4730** us from having to issue a separate NullRow instruction to clear that cache.
dan5134d132011-09-02 10:31:11 +00004731*/
4732case OP_SorterData: {
4733 VdbeCursor *pC;
drh3a949872012-09-18 13:20:13 +00004734
dan5134d132011-09-02 10:31:11 +00004735 pOut = &aMem[pOp->p2];
4736 pC = p->apCsr[pOp->p1];
drh14da87f2013-11-20 21:51:33 +00004737 assert( isSorter(pC) );
dan5134d132011-09-02 10:31:11 +00004738 rc = sqlite3VdbeSorterRowkey(pC, pOut);
dan38524132014-05-01 20:26:48 +00004739 assert( rc!=SQLITE_OK || (pOut->flags & MEM_Blob) );
drh6cf4a7d2014-10-13 13:00:58 +00004740 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh9467abf2016-02-17 18:44:11 +00004741 if( rc ) goto abort_due_to_error;
drh6cf4a7d2014-10-13 13:00:58 +00004742 p->apCsr[pOp->p3]->cacheStatus = CACHE_STALE;
dan5134d132011-09-02 10:31:11 +00004743 break;
4744}
4745
drhe7b554d2017-01-09 15:44:25 +00004746/* Opcode: RowData P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00004747** Synopsis: r[P2]=data
drh70ce3f02003-04-15 19:22:22 +00004748**
drh9057fc72016-11-25 19:32:32 +00004749** Write into register P2 the complete row content for the row at
4750** which cursor P1 is currently pointing.
drh98757152008-01-09 23:04:12 +00004751** There is no interpretation of the data.
4752** It is just copied onto the P2 register exactly as
danielk197796cb76f2008-01-04 13:24:28 +00004753** it is found in the database file.
drh70ce3f02003-04-15 19:22:22 +00004754**
drh9057fc72016-11-25 19:32:32 +00004755** If cursor P1 is an index, then the content is the key of the row.
4756** If cursor P2 is a table, then the content extracted is the data.
drh143f3c42004-01-07 20:37:52 +00004757**
drhde4fcfd2008-01-19 23:50:26 +00004758** If the P1 cursor must be pointing to a valid row (not a NULL row)
4759** of a real table, not a pseudo-table.
drhe7b554d2017-01-09 15:44:25 +00004760**
4761** If P3!=0 then this opcode is allowed to make an ephermeral pointer
4762** into the database page. That means that the content of the output
4763** register will be invalidated as soon as the cursor moves - including
4764** moves caused by other cursors that "save" the the current cursors
4765** position in order that they can write to the same table. If P3==0
4766** then a copy of the data is made into memory. P3!=0 is faster, but
4767** P3==0 is safer.
4768**
4769** If P3!=0 then the content of the P2 register is unsuitable for use
4770** in OP_Result and any OP_Result will invalidate the P2 register content.
mistachkinab61cf72017-01-09 18:22:54 +00004771** The P2 register content is invalidated by opcodes like OP_Function or
drhe7b554d2017-01-09 15:44:25 +00004772** by any use of another cursor pointing to the same table.
drh143f3c42004-01-07 20:37:52 +00004773*/
danielk1977a7a8e142008-02-13 18:25:27 +00004774case OP_RowData: {
drhdfe88ec2008-11-03 20:55:06 +00004775 VdbeCursor *pC;
drhde4fcfd2008-01-19 23:50:26 +00004776 BtCursor *pCrsr;
danielk1977e0d4b062004-06-28 01:11:46 +00004777 u32 n;
drh70ce3f02003-04-15 19:22:22 +00004778
drhe7b554d2017-01-09 15:44:25 +00004779 pOut = out2Prerelease(p, pOp);
danielk1977a7a8e142008-02-13 18:25:27 +00004780
drh653b82a2009-06-22 11:10:47 +00004781 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4782 pC = p->apCsr[pOp->p1];
drhc960dcb2015-11-20 19:22:01 +00004783 assert( pC!=0 );
4784 assert( pC->eCurType==CURTYPE_BTREE );
drh14da87f2013-11-20 21:51:33 +00004785 assert( isSorter(pC)==0 );
drhde4fcfd2008-01-19 23:50:26 +00004786 assert( pC->nullRow==0 );
drhc960dcb2015-11-20 19:22:01 +00004787 assert( pC->uc.pCursor!=0 );
4788 pCrsr = pC->uc.pCursor;
drh9a65f2c2009-06-22 19:05:40 +00004789
drh9057fc72016-11-25 19:32:32 +00004790 /* The OP_RowData opcodes always follow OP_NotExists or
drheeb95652016-05-26 20:56:38 +00004791 ** OP_SeekRowid or OP_Rewind/Op_Next with no intervening instructions
4792 ** that might invalidate the cursor.
4793 ** If this where not the case, on of the following assert()s
drhc22284f2014-10-13 16:02:20 +00004794 ** would fail. Should this ever change (because of changes in the code
4795 ** generator) then the fix would be to insert a call to
4796 ** sqlite3VdbeCursorMoveto().
drh9a65f2c2009-06-22 19:05:40 +00004797 */
4798 assert( pC->deferredMoveto==0 );
drhc22284f2014-10-13 16:02:20 +00004799 assert( sqlite3BtreeCursorIsValid(pCrsr) );
4800#if 0 /* Not required due to the previous to assert() statements */
drhde4fcfd2008-01-19 23:50:26 +00004801 rc = sqlite3VdbeCursorMoveto(pC);
drhc22284f2014-10-13 16:02:20 +00004802 if( rc!=SQLITE_OK ) goto abort_due_to_error;
4803#endif
drh9a65f2c2009-06-22 19:05:40 +00004804
drha7c90c42016-06-04 20:37:10 +00004805 n = sqlite3BtreePayloadSize(pCrsr);
drhd66c4f82016-06-04 20:58:35 +00004806 if( n>(u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
drha7c90c42016-06-04 20:37:10 +00004807 goto too_big;
drhde4fcfd2008-01-19 23:50:26 +00004808 }
drh722246e2014-10-07 23:02:24 +00004809 testcase( n==0 );
drhe7b554d2017-01-09 15:44:25 +00004810 rc = sqlite3VdbeMemFromBtree(pCrsr, 0, n, pOut);
drh9467abf2016-02-17 18:44:11 +00004811 if( rc ) goto abort_due_to_error;
drhe7b554d2017-01-09 15:44:25 +00004812 if( !pOp->p3 ) Deephemeralize(pOut);
drhb7654112008-01-12 12:48:07 +00004813 UPDATE_MAX_BLOBSIZE(pOut);
drhee0ec8e2013-10-31 17:38:01 +00004814 REGISTER_TRACE(pOp->p2, pOut);
drh5e00f6c2001-09-13 13:46:56 +00004815 break;
4816}
4817
drh2133d822008-01-03 18:44:59 +00004818/* Opcode: Rowid P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00004819** Synopsis: r[P2]=rowid
drh5e00f6c2001-09-13 13:46:56 +00004820**
drh2133d822008-01-03 18:44:59 +00004821** Store in register P2 an integer which is the key of the table entry that
drhbfdc7542008-05-29 03:12:54 +00004822** P1 is currently point to.
drh044925b2009-04-22 17:15:02 +00004823**
4824** P1 can be either an ordinary table or a virtual table. There used to
4825** be a separate OP_VRowid opcode for use with virtual tables, but this
4826** one opcode now works for both table types.
drh5e00f6c2001-09-13 13:46:56 +00004827*/
drh27a348c2015-04-13 19:14:06 +00004828case OP_Rowid: { /* out2 */
drhdfe88ec2008-11-03 20:55:06 +00004829 VdbeCursor *pC;
drhf328bc82004-05-10 23:29:49 +00004830 i64 v;
drh856c1032009-06-02 15:21:42 +00004831 sqlite3_vtab *pVtab;
4832 const sqlite3_module *pModule;
drh5e00f6c2001-09-13 13:46:56 +00004833
drh27a348c2015-04-13 19:14:06 +00004834 pOut = out2Prerelease(p, pOp);
drh653b82a2009-06-22 11:10:47 +00004835 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4836 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00004837 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00004838 assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
drh044925b2009-04-22 17:15:02 +00004839 if( pC->nullRow ){
drh3c657212009-11-17 23:59:58 +00004840 pOut->flags = MEM_Null;
drh044925b2009-04-22 17:15:02 +00004841 break;
4842 }else if( pC->deferredMoveto ){
drh61495262009-04-22 15:32:59 +00004843 v = pC->movetoTarget;
drh044925b2009-04-22 17:15:02 +00004844#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00004845 }else if( pC->eCurType==CURTYPE_VTAB ){
4846 assert( pC->uc.pVCur!=0 );
4847 pVtab = pC->uc.pVCur->pVtab;
drh044925b2009-04-22 17:15:02 +00004848 pModule = pVtab->pModule;
4849 assert( pModule->xRowid );
drhc960dcb2015-11-20 19:22:01 +00004850 rc = pModule->xRowid(pC->uc.pVCur, &v);
dan016f7812013-08-21 17:35:48 +00004851 sqlite3VtabImportErrmsg(p, pVtab);
drh9467abf2016-02-17 18:44:11 +00004852 if( rc ) goto abort_due_to_error;
drh044925b2009-04-22 17:15:02 +00004853#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh70ce3f02003-04-15 19:22:22 +00004854 }else{
drhc960dcb2015-11-20 19:22:01 +00004855 assert( pC->eCurType==CURTYPE_BTREE );
4856 assert( pC->uc.pCursor!=0 );
drhc22284f2014-10-13 16:02:20 +00004857 rc = sqlite3VdbeCursorRestore(pC);
drh61495262009-04-22 15:32:59 +00004858 if( rc ) goto abort_due_to_error;
dan2b8669a2014-11-17 19:42:48 +00004859 if( pC->nullRow ){
4860 pOut->flags = MEM_Null;
4861 break;
4862 }
drha7c90c42016-06-04 20:37:10 +00004863 v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
drh5e00f6c2001-09-13 13:46:56 +00004864 }
drh4c583122008-01-04 22:01:03 +00004865 pOut->u.i = v;
drh5e00f6c2001-09-13 13:46:56 +00004866 break;
4867}
4868
drh9cbf3422008-01-17 16:22:13 +00004869/* Opcode: NullRow P1 * * * *
drh17f71932002-02-21 12:01:27 +00004870**
4871** Move the cursor P1 to a null row. Any OP_Column operations
drh9cbf3422008-01-17 16:22:13 +00004872** that occur while the cursor is on the null row will always
4873** write a NULL.
drh17f71932002-02-21 12:01:27 +00004874*/
drh9cbf3422008-01-17 16:22:13 +00004875case OP_NullRow: {
drhdfe88ec2008-11-03 20:55:06 +00004876 VdbeCursor *pC;
drh17f71932002-02-21 12:01:27 +00004877
drh653b82a2009-06-22 11:10:47 +00004878 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4879 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00004880 assert( pC!=0 );
drhd7556d22004-05-14 21:59:40 +00004881 pC->nullRow = 1;
drh399af1d2013-11-20 17:25:55 +00004882 pC->cacheStatus = CACHE_STALE;
drhc960dcb2015-11-20 19:22:01 +00004883 if( pC->eCurType==CURTYPE_BTREE ){
4884 assert( pC->uc.pCursor!=0 );
4885 sqlite3BtreeClearCursor(pC->uc.pCursor);
danielk1977be51a652008-10-08 17:58:48 +00004886 }
drh17f71932002-02-21 12:01:27 +00004887 break;
4888}
4889
danb18e60b2015-04-01 16:18:00 +00004890/* Opcode: Last P1 P2 P3 * *
drh9562b552002-02-19 15:00:07 +00004891**
drh8af3f772014-07-25 18:01:06 +00004892** The next use of the Rowid or Column or Prev instruction for P1
drh9562b552002-02-19 15:00:07 +00004893** will refer to the last entry in the database table or index.
4894** If the table or index is empty and P2>0, then jump immediately to P2.
4895** If P2 is 0 or if the table or index is not empty, fall through
4896** to the following instruction.
drh8af3f772014-07-25 18:01:06 +00004897**
4898** This opcode leaves the cursor configured to move in reverse order,
4899** from the end toward the beginning. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00004900** configured to use Prev, not Next.
drhd6ef5af2016-11-15 04:00:24 +00004901**
4902** If P3 is -1, then the cursor is positioned at the end of the btree
4903** for the purpose of appending a new entry onto the btree. In that
4904** case P2 must be 0. It is assumed that the cursor is used only for
4905** appending and so if the cursor is valid, then the cursor must already
4906** be pointing at the end of the btree and so no changes are made to
4907** the cursor.
drh9562b552002-02-19 15:00:07 +00004908*/
drh9cbf3422008-01-17 16:22:13 +00004909case OP_Last: { /* jump */
drhdfe88ec2008-11-03 20:55:06 +00004910 VdbeCursor *pC;
drh9562b552002-02-19 15:00:07 +00004911 BtCursor *pCrsr;
drha05a7222008-01-19 03:35:58 +00004912 int res;
drh9562b552002-02-19 15:00:07 +00004913
drh653b82a2009-06-22 11:10:47 +00004914 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4915 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00004916 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00004917 assert( pC->eCurType==CURTYPE_BTREE );
4918 pCrsr = pC->uc.pCursor;
drh7abc5402011-10-22 21:00:46 +00004919 res = 0;
drh3da046d2013-11-11 03:24:11 +00004920 assert( pCrsr!=0 );
danb18e60b2015-04-01 16:18:00 +00004921 pC->seekResult = pOp->p3;
drh8af3f772014-07-25 18:01:06 +00004922#ifdef SQLITE_DEBUG
4923 pC->seekOp = OP_Last;
4924#endif
drhd6ef5af2016-11-15 04:00:24 +00004925 if( pOp->p3==0 || !sqlite3BtreeCursorIsValidNN(pCrsr) ){
4926 rc = sqlite3BtreeLast(pCrsr, &res);
4927 pC->nullRow = (u8)res;
4928 pC->deferredMoveto = 0;
4929 pC->cacheStatus = CACHE_STALE;
4930 if( rc ) goto abort_due_to_error;
4931 if( pOp->p2>0 ){
4932 VdbeBranchTaken(res!=0,2);
4933 if( res ) goto jump_to_p2;
4934 }
4935 }else{
4936 assert( pOp->p2==0 );
drh9562b552002-02-19 15:00:07 +00004937 }
4938 break;
4939}
4940
drh5e98e832017-02-17 19:24:06 +00004941/* Opcode: IfSmaller P1 P2 P3 * *
4942**
4943** Estimate the number of rows in the table P1. Jump to P2 if that
4944** estimate is less than approximately 2**(0.1*P3).
4945*/
4946case OP_IfSmaller: { /* jump */
4947 VdbeCursor *pC;
4948 BtCursor *pCrsr;
4949 int res;
4950 i64 sz;
4951
4952 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
4953 pC = p->apCsr[pOp->p1];
4954 assert( pC!=0 );
4955 pCrsr = pC->uc.pCursor;
4956 assert( pCrsr );
4957 rc = sqlite3BtreeFirst(pCrsr, &res);
4958 if( rc ) goto abort_due_to_error;
4959 if( res==0 ){
4960 sz = sqlite3BtreeRowCountEst(pCrsr);
4961 if( ALWAYS(sz>=0) && sqlite3LogEst((u64)sz)<pOp->p3 ) res = 1;
4962 }
4963 VdbeBranchTaken(res!=0,2);
4964 if( res ) goto jump_to_p2;
4965 break;
4966}
4967
drh0342b1f2005-09-01 03:07:44 +00004968
drh6bd4dc62016-12-23 16:05:22 +00004969/* Opcode: SorterSort P1 P2 * * *
4970**
4971** After all records have been inserted into the Sorter object
4972** identified by P1, invoke this opcode to actually do the sorting.
4973** Jump to P2 if there are no records to be sorted.
4974**
4975** This opcode is an alias for OP_Sort and OP_Rewind that is used
4976** for Sorter objects.
4977*/
drh9cbf3422008-01-17 16:22:13 +00004978/* Opcode: Sort P1 P2 * * *
drh0342b1f2005-09-01 03:07:44 +00004979**
4980** This opcode does exactly the same thing as OP_Rewind except that
4981** it increments an undocumented global variable used for testing.
4982**
4983** Sorting is accomplished by writing records into a sorting index,
4984** then rewinding that index and playing it back from beginning to
4985** end. We use the OP_Sort opcode instead of OP_Rewind to do the
4986** rewinding so that the global variable will be incremented and
4987** regression tests can determine whether or not the optimizer is
4988** correctly optimizing out sorts.
4989*/
drhc6aff302011-09-01 15:32:47 +00004990case OP_SorterSort: /* jump */
drh9cbf3422008-01-17 16:22:13 +00004991case OP_Sort: { /* jump */
drh0f7eb612006-08-08 13:51:43 +00004992#ifdef SQLITE_TEST
drh0342b1f2005-09-01 03:07:44 +00004993 sqlite3_sort_count++;
drh4db38a72005-09-01 12:16:28 +00004994 sqlite3_search_count--;
drh0f7eb612006-08-08 13:51:43 +00004995#endif
drh9b47ee32013-08-20 03:13:51 +00004996 p->aCounter[SQLITE_STMTSTATUS_SORT]++;
drh0342b1f2005-09-01 03:07:44 +00004997 /* Fall through into OP_Rewind */
4998}
drh9cbf3422008-01-17 16:22:13 +00004999/* Opcode: Rewind P1 P2 * * *
drh5e00f6c2001-09-13 13:46:56 +00005000**
drhf0863fe2005-06-12 21:35:51 +00005001** The next use of the Rowid or Column or Next instruction for P1
drh8721ce42001-11-07 14:22:00 +00005002** will refer to the first entry in the database table or index.
dan04489b62014-10-31 20:11:32 +00005003** If the table or index is empty, jump immediately to P2.
5004** If the table or index is not empty, fall through to the following
5005** instruction.
drh8af3f772014-07-25 18:01:06 +00005006**
5007** This opcode leaves the cursor configured to move in forward order,
drh4ed2fb92014-08-14 13:06:25 +00005008** from the beginning toward the end. In other words, the cursor is
drh5dad9a32014-07-25 18:37:42 +00005009** configured to use Next, not Prev.
drh5e00f6c2001-09-13 13:46:56 +00005010*/
drh9cbf3422008-01-17 16:22:13 +00005011case OP_Rewind: { /* jump */
drhdfe88ec2008-11-03 20:55:06 +00005012 VdbeCursor *pC;
drh5e00f6c2001-09-13 13:46:56 +00005013 BtCursor *pCrsr;
drhf4dada72004-05-11 09:57:35 +00005014 int res;
drh5e00f6c2001-09-13 13:46:56 +00005015
drh653b82a2009-06-22 11:10:47 +00005016 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5017 pC = p->apCsr[pOp->p1];
drh4774b132004-06-12 20:12:51 +00005018 assert( pC!=0 );
drh14da87f2013-11-20 21:51:33 +00005019 assert( isSorter(pC)==(pOp->opcode==OP_SorterSort) );
dan2411dea2010-07-03 05:56:09 +00005020 res = 1;
drh8af3f772014-07-25 18:01:06 +00005021#ifdef SQLITE_DEBUG
5022 pC->seekOp = OP_Rewind;
5023#endif
dan689ab892011-08-12 15:02:00 +00005024 if( isSorter(pC) ){
drh958d2612014-04-18 13:40:07 +00005025 rc = sqlite3VdbeSorterRewind(pC, &res);
dana205a482011-08-27 18:48:57 +00005026 }else{
drhc960dcb2015-11-20 19:22:01 +00005027 assert( pC->eCurType==CURTYPE_BTREE );
5028 pCrsr = pC->uc.pCursor;
dana205a482011-08-27 18:48:57 +00005029 assert( pCrsr );
danielk19774adee202004-05-08 08:23:19 +00005030 rc = sqlite3BtreeFirst(pCrsr, &res);
drha11846b2004-01-07 18:52:56 +00005031 pC->deferredMoveto = 0;
drh76873ab2006-01-07 18:48:26 +00005032 pC->cacheStatus = CACHE_STALE;
drhf4dada72004-05-11 09:57:35 +00005033 }
drh9467abf2016-02-17 18:44:11 +00005034 if( rc ) goto abort_due_to_error;
drh9c1905f2008-12-10 22:32:56 +00005035 pC->nullRow = (u8)res;
drha05a7222008-01-19 03:35:58 +00005036 assert( pOp->p2>0 && pOp->p2<p->nOp );
drh688852a2014-02-17 22:40:43 +00005037 VdbeBranchTaken(res!=0,2);
drhf56fa462015-04-13 21:39:54 +00005038 if( res ) goto jump_to_p2;
drh5e00f6c2001-09-13 13:46:56 +00005039 break;
5040}
5041
drh0fd61352014-02-07 02:29:45 +00005042/* Opcode: Next P1 P2 P3 P4 P5
drh5e00f6c2001-09-13 13:46:56 +00005043**
5044** Advance cursor P1 so that it points to the next key/data pair in its
drh8721ce42001-11-07 14:22:00 +00005045** table or index. If there are no more key/value pairs then fall through
5046** to the following instruction. But if the cursor advance was successful,
5047** jump immediately to P2.
drhc045ec52002-12-04 20:01:06 +00005048**
drh5dad9a32014-07-25 18:37:42 +00005049** The Next opcode is only valid following an SeekGT, SeekGE, or
5050** OP_Rewind opcode used to position the cursor. Next is not allowed
5051** to follow SeekLT, SeekLE, or OP_Last.
drh8af3f772014-07-25 18:01:06 +00005052**
drhf93cd942013-11-21 03:12:25 +00005053** The P1 cursor must be for a real table, not a pseudo-table. P1 must have
5054** been opened prior to this opcode or the program will segfault.
drh60a713c2008-01-21 16:22:45 +00005055**
drhe39a7322014-02-03 14:04:11 +00005056** The P3 value is a hint to the btree implementation. If P3==1, that
5057** means P1 is an SQL index and that this instruction could have been
5058** omitted if that index had been unique. P3 is usually 0. P3 is
5059** always either 0 or 1.
5060**
dana205a482011-08-27 18:48:57 +00005061** P4 is always of type P4_ADVANCE. The function pointer points to
5062** sqlite3BtreeNext().
5063**
drhafc266a2010-03-31 17:47:44 +00005064** If P5 is positive and the jump is taken, then event counter
5065** number P5-1 in the prepared statement is incremented.
5066**
drhf93cd942013-11-21 03:12:25 +00005067** See also: Prev, NextIfOpen
5068*/
drh0fd61352014-02-07 02:29:45 +00005069/* Opcode: NextIfOpen P1 P2 P3 P4 P5
drhf93cd942013-11-21 03:12:25 +00005070**
drh5dad9a32014-07-25 18:37:42 +00005071** This opcode works just like Next except that if cursor P1 is not
drhf93cd942013-11-21 03:12:25 +00005072** open it behaves a no-op.
drh8721ce42001-11-07 14:22:00 +00005073*/
drh0fd61352014-02-07 02:29:45 +00005074/* Opcode: Prev P1 P2 P3 P4 P5
drhc045ec52002-12-04 20:01:06 +00005075**
5076** Back up cursor P1 so that it points to the previous key/data pair in its
5077** table or index. If there is no previous key/value pairs then fall through
5078** to the following instruction. But if the cursor backup was successful,
5079** jump immediately to P2.
drh60a713c2008-01-21 16:22:45 +00005080**
drh8af3f772014-07-25 18:01:06 +00005081**
drh5dad9a32014-07-25 18:37:42 +00005082** The Prev opcode is only valid following an SeekLT, SeekLE, or
5083** OP_Last opcode used to position the cursor. Prev is not allowed
5084** to follow SeekGT, SeekGE, or OP_Rewind.
drh8af3f772014-07-25 18:01:06 +00005085**
drhf93cd942013-11-21 03:12:25 +00005086** The P1 cursor must be for a real table, not a pseudo-table. If P1 is
5087** not open then the behavior is undefined.
drhafc266a2010-03-31 17:47:44 +00005088**
drhe39a7322014-02-03 14:04:11 +00005089** The P3 value is a hint to the btree implementation. If P3==1, that
5090** means P1 is an SQL index and that this instruction could have been
5091** omitted if that index had been unique. P3 is usually 0. P3 is
5092** always either 0 or 1.
5093**
dana205a482011-08-27 18:48:57 +00005094** P4 is always of type P4_ADVANCE. The function pointer points to
5095** sqlite3BtreePrevious().
5096**
drhafc266a2010-03-31 17:47:44 +00005097** If P5 is positive and the jump is taken, then event counter
5098** number P5-1 in the prepared statement is incremented.
drhc045ec52002-12-04 20:01:06 +00005099*/
drh0fd61352014-02-07 02:29:45 +00005100/* Opcode: PrevIfOpen P1 P2 P3 P4 P5
drhf93cd942013-11-21 03:12:25 +00005101**
drh5dad9a32014-07-25 18:37:42 +00005102** This opcode works just like Prev except that if cursor P1 is not
drhf93cd942013-11-21 03:12:25 +00005103** open it behaves a no-op.
5104*/
drh6bd4dc62016-12-23 16:05:22 +00005105/* Opcode: SorterNext P1 P2 * * P5
5106**
5107** This opcode works just like OP_Next except that P1 must be a
5108** sorter object for which the OP_SorterSort opcode has been
5109** invoked. This opcode advances the cursor to the next sorted
5110** record, or jumps to P2 if there are no more sorted records.
5111*/
drhf93cd942013-11-21 03:12:25 +00005112case OP_SorterNext: { /* jump */
drhdfe88ec2008-11-03 20:55:06 +00005113 VdbeCursor *pC;
drh8721ce42001-11-07 14:22:00 +00005114
drhf93cd942013-11-21 03:12:25 +00005115 pC = p->apCsr[pOp->p1];
5116 assert( isSorter(pC) );
drh2ab792e2017-05-30 18:34:07 +00005117 rc = sqlite3VdbeSorterNext(db, pC);
drhf93cd942013-11-21 03:12:25 +00005118 goto next_tail;
5119case OP_PrevIfOpen: /* jump */
5120case OP_NextIfOpen: /* jump */
5121 if( p->apCsr[pOp->p1]==0 ) break;
5122 /* Fall through */
5123case OP_Prev: /* jump */
5124case OP_Next: /* jump */
drh70ce3f02003-04-15 19:22:22 +00005125 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
drh9b47ee32013-08-20 03:13:51 +00005126 assert( pOp->p5<ArraySize(p->aCounter) );
drhd7556d22004-05-14 21:59:40 +00005127 pC = p->apCsr[pOp->p1];
drhf93cd942013-11-21 03:12:25 +00005128 assert( pC!=0 );
5129 assert( pC->deferredMoveto==0 );
drhc960dcb2015-11-20 19:22:01 +00005130 assert( pC->eCurType==CURTYPE_BTREE );
drhf93cd942013-11-21 03:12:25 +00005131 assert( pOp->opcode!=OP_Next || pOp->p4.xAdvance==sqlite3BtreeNext );
5132 assert( pOp->opcode!=OP_Prev || pOp->p4.xAdvance==sqlite3BtreePrevious );
5133 assert( pOp->opcode!=OP_NextIfOpen || pOp->p4.xAdvance==sqlite3BtreeNext );
5134 assert( pOp->opcode!=OP_PrevIfOpen || pOp->p4.xAdvance==sqlite3BtreePrevious);
drh8af3f772014-07-25 18:01:06 +00005135
5136 /* The Next opcode is only used after SeekGT, SeekGE, and Rewind.
5137 ** The Prev opcode is only used after SeekLT, SeekLE, and Last. */
5138 assert( pOp->opcode!=OP_Next || pOp->opcode!=OP_NextIfOpen
5139 || pC->seekOp==OP_SeekGT || pC->seekOp==OP_SeekGE
drhcefc87f2014-08-01 01:40:33 +00005140 || pC->seekOp==OP_Rewind || pC->seekOp==OP_Found);
drh8af3f772014-07-25 18:01:06 +00005141 assert( pOp->opcode!=OP_Prev || pOp->opcode!=OP_PrevIfOpen
5142 || pC->seekOp==OP_SeekLT || pC->seekOp==OP_SeekLE
5143 || pC->seekOp==OP_Last );
5144
drh2ab792e2017-05-30 18:34:07 +00005145 rc = pOp->p4.xAdvance(pC->uc.pCursor, pOp->p3);
drhf93cd942013-11-21 03:12:25 +00005146next_tail:
drha3460582008-07-11 21:02:53 +00005147 pC->cacheStatus = CACHE_STALE;
drh2ab792e2017-05-30 18:34:07 +00005148 VdbeBranchTaken(rc==SQLITE_OK,2);
5149 if( rc==SQLITE_OK ){
drhf93cd942013-11-21 03:12:25 +00005150 pC->nullRow = 0;
drh9b47ee32013-08-20 03:13:51 +00005151 p->aCounter[pOp->p5]++;
drh0f7eb612006-08-08 13:51:43 +00005152#ifdef SQLITE_TEST
drha3460582008-07-11 21:02:53 +00005153 sqlite3_search_count++;
drh0f7eb612006-08-08 13:51:43 +00005154#endif
drhf56fa462015-04-13 21:39:54 +00005155 goto jump_to_p2_and_check_for_interrupt;
drh8721ce42001-11-07 14:22:00 +00005156 }
drh2ab792e2017-05-30 18:34:07 +00005157 if( rc!=SQLITE_DONE ) goto abort_due_to_error;
5158 rc = SQLITE_OK;
5159 pC->nullRow = 1;
drh49afe3a2013-07-10 03:05:14 +00005160 goto check_for_interrupt;
drh8721ce42001-11-07 14:22:00 +00005161}
5162
drh9b4eaeb2016-11-09 00:10:33 +00005163/* Opcode: IdxInsert P1 P2 P3 P4 P5
drh81316f82013-10-29 20:40:47 +00005164** Synopsis: key=r[P2]
drh5e00f6c2001-09-13 13:46:56 +00005165**
drhef8662b2011-06-20 21:47:58 +00005166** Register P2 holds an SQL index key made using the
drh9437bd22009-02-01 00:29:56 +00005167** MakeRecord instructions. This opcode writes that key
drhee32e0a2006-01-10 19:45:49 +00005168** into the index P1. Data for the entry is nil.
drh717e6402001-09-27 03:22:32 +00005169**
drhfb8c56f2016-11-09 01:19:25 +00005170** If P4 is not zero, then it is the number of values in the unpacked
drh9b4eaeb2016-11-09 00:10:33 +00005171** key of reg(P2). In that case, P3 is the index of the first register
5172** for the unpacked key. The availability of the unpacked key can sometimes
5173** be an optimization.
5174**
5175** If P5 has the OPFLAG_APPEND bit set, that is a hint to the b-tree layer
5176** that this insert is likely to be an append.
drhe4d90812007-03-29 05:51:49 +00005177**
mistachkin21a919f2014-02-07 03:28:02 +00005178** If P5 has the OPFLAG_NCHANGE bit set, then the change counter is
5179** incremented by this instruction. If the OPFLAG_NCHANGE bit is clear,
5180** then the change counter is unchanged.
drh0fd61352014-02-07 02:29:45 +00005181**
drheaf6ae22016-11-09 20:14:34 +00005182** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
5183** run faster by avoiding an unnecessary seek on cursor P1. However,
5184** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
5185** seeks on the cursor or if the most recent seek used a key equivalent
5186** to P2.
drh0fd61352014-02-07 02:29:45 +00005187**
drhf0863fe2005-06-12 21:35:51 +00005188** This instruction only works for indices. The equivalent instruction
5189** for tables is OP_Insert.
drh5e00f6c2001-09-13 13:46:56 +00005190*/
drhf013e202016-10-15 18:37:05 +00005191/* Opcode: SorterInsert P1 P2 * * *
5192** Synopsis: key=r[P2]
5193**
5194** Register P2 holds an SQL index key made using the
5195** MakeRecord instructions. This opcode writes that key
5196** into the sorter P1. Data for the entry is nil.
5197*/
drhca892a72011-09-03 00:17:51 +00005198case OP_SorterInsert: /* in2 */
drh9cbf3422008-01-17 16:22:13 +00005199case OP_IdxInsert: { /* in2 */
drhdfe88ec2008-11-03 20:55:06 +00005200 VdbeCursor *pC;
drh8eeb4462016-05-21 20:03:42 +00005201 BtreePayload x;
drh856c1032009-06-02 15:21:42 +00005202
drh653b82a2009-06-22 11:10:47 +00005203 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5204 pC = p->apCsr[pOp->p1];
5205 assert( pC!=0 );
drh14da87f2013-11-20 21:51:33 +00005206 assert( isSorter(pC)==(pOp->opcode==OP_SorterInsert) );
drh3c657212009-11-17 23:59:58 +00005207 pIn2 = &aMem[pOp->p2];
drhaa9b8962008-01-08 02:57:55 +00005208 assert( pIn2->flags & MEM_Blob );
drh6546af12013-11-04 15:23:25 +00005209 if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
drhc960dcb2015-11-20 19:22:01 +00005210 assert( pC->eCurType==CURTYPE_BTREE || pOp->opcode==OP_SorterInsert );
drh3da046d2013-11-11 03:24:11 +00005211 assert( pC->isTable==0 );
5212 rc = ExpandBlob(pIn2);
drh9467abf2016-02-17 18:44:11 +00005213 if( rc ) goto abort_due_to_error;
5214 if( pOp->opcode==OP_SorterInsert ){
5215 rc = sqlite3VdbeSorterWrite(pC, pIn2);
5216 }else{
drh8eeb4462016-05-21 20:03:42 +00005217 x.nKey = pIn2->n;
5218 x.pKey = pIn2->z;
drh9b4eaeb2016-11-09 00:10:33 +00005219 x.aMem = aMem + pOp->p3;
5220 x.nMem = (u16)pOp->p4.i;
5221 rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
danf91c1312017-01-10 20:04:38 +00005222 (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)),
drh9467abf2016-02-17 18:44:11 +00005223 ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0)
5224 );
5225 assert( pC->deferredMoveto==0 );
5226 pC->cacheStatus = CACHE_STALE;
drh5e00f6c2001-09-13 13:46:56 +00005227 }
drh9467abf2016-02-17 18:44:11 +00005228 if( rc) goto abort_due_to_error;
drh5e00f6c2001-09-13 13:46:56 +00005229 break;
5230}
5231
drhd1d38482008-10-07 23:46:38 +00005232/* Opcode: IdxDelete P1 P2 P3 * *
drhf63552b2013-10-30 00:25:03 +00005233** Synopsis: key=r[P2@P3]
drh5e00f6c2001-09-13 13:46:56 +00005234**
drhe14006d2008-03-25 17:23:32 +00005235** The content of P3 registers starting at register P2 form
5236** an unpacked index key. This opcode removes that entry from the
danielk1977a7a8e142008-02-13 18:25:27 +00005237** index opened by cursor P1.
drh5e00f6c2001-09-13 13:46:56 +00005238*/
drhe14006d2008-03-25 17:23:32 +00005239case OP_IdxDelete: {
drhdfe88ec2008-11-03 20:55:06 +00005240 VdbeCursor *pC;
drh5e00f6c2001-09-13 13:46:56 +00005241 BtCursor *pCrsr;
drh9a65f2c2009-06-22 19:05:40 +00005242 int res;
5243 UnpackedRecord r;
drh856c1032009-06-02 15:21:42 +00005244
drhe14006d2008-03-25 17:23:32 +00005245 assert( pOp->p3>0 );
drh9f6168b2016-03-19 23:32:58 +00005246 assert( pOp->p2>0 && pOp->p2+pOp->p3<=(p->nMem+1 - p->nCursor)+1 );
drh653b82a2009-06-22 11:10:47 +00005247 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5248 pC = p->apCsr[pOp->p1];
5249 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00005250 assert( pC->eCurType==CURTYPE_BTREE );
5251 pCrsr = pC->uc.pCursor;
drh3da046d2013-11-11 03:24:11 +00005252 assert( pCrsr!=0 );
drh4308e342013-11-11 16:55:52 +00005253 assert( pOp->p5==0 );
drh3da046d2013-11-11 03:24:11 +00005254 r.pKeyInfo = pC->pKeyInfo;
5255 r.nField = (u16)pOp->p3;
dan1fed5da2014-02-25 21:01:25 +00005256 r.default_rc = 0;
drh3da046d2013-11-11 03:24:11 +00005257 r.aMem = &aMem[pOp->p2];
drh3da046d2013-11-11 03:24:11 +00005258 rc = sqlite3BtreeMovetoUnpacked(pCrsr, &r, 0, 0, &res);
drh9467abf2016-02-17 18:44:11 +00005259 if( rc ) goto abort_due_to_error;
5260 if( res==0 ){
dane61bbf42016-01-28 17:06:17 +00005261 rc = sqlite3BtreeDelete(pCrsr, BTREE_AUXDELETE);
drh9467abf2016-02-17 18:44:11 +00005262 if( rc ) goto abort_due_to_error;
drh5e00f6c2001-09-13 13:46:56 +00005263 }
drh3da046d2013-11-11 03:24:11 +00005264 assert( pC->deferredMoveto==0 );
5265 pC->cacheStatus = CACHE_STALE;
dan3b908d42016-11-08 19:22:32 +00005266 pC->seekResult = 0;
drh5e00f6c2001-09-13 13:46:56 +00005267 break;
5268}
5269
drh170ad682017-06-02 15:44:22 +00005270/* Opcode: DeferredSeek P1 * P3 P4 *
5271** Synopsis: Move P3 to P1.rowid if needed
drh784c1b92016-01-30 16:59:56 +00005272**
5273** P1 is an open index cursor and P3 is a cursor on the corresponding
5274** table. This opcode does a deferred seek of the P3 table cursor
5275** to the row that corresponds to the current row of P1.
5276**
5277** This is a deferred seek. Nothing actually happens until
5278** the cursor is used to read a record. That way, if no reads
5279** occur, no unnecessary I/O happens.
5280**
5281** P4 may be an array of integers (type P4_INTARRAY) containing
drh19d720d2016-02-03 19:52:06 +00005282** one entry for each column in the P3 table. If array entry a(i)
5283** is non-zero, then reading column a(i)-1 from cursor P3 is
drh784c1b92016-01-30 16:59:56 +00005284** equivalent to performing the deferred seek and then reading column i
5285** from P1. This information is stored in P3 and used to redirect
5286** reads against P3 over to P1, thus possibly avoiding the need to
5287** seek and read cursor P3.
5288*/
drh2133d822008-01-03 18:44:59 +00005289/* Opcode: IdxRowid P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00005290** Synopsis: r[P2]=rowid
drh8721ce42001-11-07 14:22:00 +00005291**
drh2133d822008-01-03 18:44:59 +00005292** Write into register P2 an integer which is the last entry in the record at
drhf0863fe2005-06-12 21:35:51 +00005293** the end of the index key pointed to by cursor P1. This integer should be
5294** the rowid of the table entry to which this index entry points.
drh8721ce42001-11-07 14:22:00 +00005295**
drh9437bd22009-02-01 00:29:56 +00005296** See also: Rowid, MakeRecord.
drh8721ce42001-11-07 14:22:00 +00005297*/
drh170ad682017-06-02 15:44:22 +00005298case OP_DeferredSeek:
5299case OP_IdxRowid: { /* out2 */
5300 VdbeCursor *pC; /* The P1 index cursor */
5301 VdbeCursor *pTabCur; /* The P2 table cursor (OP_DeferredSeek only) */
5302 i64 rowid; /* Rowid that P1 current points to */
drh8721ce42001-11-07 14:22:00 +00005303
drh653b82a2009-06-22 11:10:47 +00005304 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5305 pC = p->apCsr[pOp->p1];
5306 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00005307 assert( pC->eCurType==CURTYPE_BTREE );
drh784c1b92016-01-30 16:59:56 +00005308 assert( pC->uc.pCursor!=0 );
drh3da046d2013-11-11 03:24:11 +00005309 assert( pC->isTable==0 );
drhc22284f2014-10-13 16:02:20 +00005310 assert( pC->deferredMoveto==0 );
drh784c1b92016-01-30 16:59:56 +00005311 assert( !pC->nullRow || pOp->opcode==OP_IdxRowid );
5312
5313 /* The IdxRowid and Seek opcodes are combined because of the commonality
5314 ** of sqlite3VdbeCursorRestore() and sqlite3VdbeIdxRowid(). */
5315 rc = sqlite3VdbeCursorRestore(pC);
drhc22284f2014-10-13 16:02:20 +00005316
5317 /* sqlite3VbeCursorRestore() can only fail if the record has been deleted
drh784c1b92016-01-30 16:59:56 +00005318 ** out from under the cursor. That will never happens for an IdxRowid
5319 ** or Seek opcode */
drhc22284f2014-10-13 16:02:20 +00005320 if( NEVER(rc!=SQLITE_OK) ) goto abort_due_to_error;
5321
drh3da046d2013-11-11 03:24:11 +00005322 if( !pC->nullRow ){
drh2dc06482013-12-11 00:59:10 +00005323 rowid = 0; /* Not needed. Only used to silence a warning. */
drh784c1b92016-01-30 16:59:56 +00005324 rc = sqlite3VdbeIdxRowid(db, pC->uc.pCursor, &rowid);
drh3da046d2013-11-11 03:24:11 +00005325 if( rc!=SQLITE_OK ){
5326 goto abort_due_to_error;
danielk19773d1bfea2004-05-14 11:00:53 +00005327 }
drh170ad682017-06-02 15:44:22 +00005328 if( pOp->opcode==OP_DeferredSeek ){
drh784c1b92016-01-30 16:59:56 +00005329 assert( pOp->p3>=0 && pOp->p3<p->nCursor );
5330 pTabCur = p->apCsr[pOp->p3];
5331 assert( pTabCur!=0 );
5332 assert( pTabCur->eCurType==CURTYPE_BTREE );
5333 assert( pTabCur->uc.pCursor!=0 );
5334 assert( pTabCur->isTable );
5335 pTabCur->nullRow = 0;
5336 pTabCur->movetoTarget = rowid;
5337 pTabCur->deferredMoveto = 1;
5338 assert( pOp->p4type==P4_INTARRAY || pOp->p4.ai==0 );
5339 pTabCur->aAltMap = pOp->p4.ai;
5340 pTabCur->pAltCursor = pC;
5341 }else{
5342 pOut = out2Prerelease(p, pOp);
5343 pOut->u.i = rowid;
drh784c1b92016-01-30 16:59:56 +00005344 }
5345 }else{
5346 assert( pOp->opcode==OP_IdxRowid );
5347 sqlite3VdbeMemSetNull(&aMem[pOp->p2]);
drh8721ce42001-11-07 14:22:00 +00005348 }
5349 break;
5350}
5351
danielk197761dd5832008-04-18 11:31:12 +00005352/* Opcode: IdxGE P1 P2 P3 P4 P5
drhf63552b2013-10-30 00:25:03 +00005353** Synopsis: key=r[P3@P4]
drh8721ce42001-11-07 14:22:00 +00005354**
danielk197761dd5832008-04-18 11:31:12 +00005355** The P4 register values beginning with P3 form an unpacked index
drh4a1d3652014-02-14 15:13:36 +00005356** key that omits the PRIMARY KEY. Compare this key value against the index
5357** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5358** fields at the end.
drhf3218fe2004-05-28 08:21:02 +00005359**
danielk197761dd5832008-04-18 11:31:12 +00005360** If the P1 index entry is greater than or equal to the key value
5361** then jump to P2. Otherwise fall through to the next instruction.
drh4a1d3652014-02-14 15:13:36 +00005362*/
5363/* Opcode: IdxGT P1 P2 P3 P4 P5
5364** Synopsis: key=r[P3@P4]
drh772ae622004-05-19 13:13:08 +00005365**
drh4a1d3652014-02-14 15:13:36 +00005366** The P4 register values beginning with P3 form an unpacked index
5367** key that omits the PRIMARY KEY. Compare this key value against the index
5368** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
5369** fields at the end.
5370**
5371** If the P1 index entry is greater than the key value
5372** then jump to P2. Otherwise fall through to the next instruction.
drh8721ce42001-11-07 14:22:00 +00005373*/
drh3bb9b932010-08-06 02:10:00 +00005374/* Opcode: IdxLT P1 P2 P3 P4 P5
drhf63552b2013-10-30 00:25:03 +00005375** Synopsis: key=r[P3@P4]
drhc045ec52002-12-04 20:01:06 +00005376**
danielk197761dd5832008-04-18 11:31:12 +00005377** The P4 register values beginning with P3 form an unpacked index
drh4a1d3652014-02-14 15:13:36 +00005378** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5379** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5380** ROWID on the P1 index.
drhf3218fe2004-05-28 08:21:02 +00005381**
danielk197761dd5832008-04-18 11:31:12 +00005382** If the P1 index entry is less than the key value then jump to P2.
5383** Otherwise fall through to the next instruction.
drhc045ec52002-12-04 20:01:06 +00005384*/
drh4a1d3652014-02-14 15:13:36 +00005385/* Opcode: IdxLE P1 P2 P3 P4 P5
5386** Synopsis: key=r[P3@P4]
5387**
5388** The P4 register values beginning with P3 form an unpacked index
5389** key that omits the PRIMARY KEY or ROWID. Compare this key value against
5390** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
5391** ROWID on the P1 index.
5392**
5393** If the P1 index entry is less than or equal to the key value then jump
5394** to P2. Otherwise fall through to the next instruction.
5395*/
5396case OP_IdxLE: /* jump */
5397case OP_IdxGT: /* jump */
drh93952eb2009-11-13 19:43:43 +00005398case OP_IdxLT: /* jump */
drh4a1d3652014-02-14 15:13:36 +00005399case OP_IdxGE: { /* jump */
drhdfe88ec2008-11-03 20:55:06 +00005400 VdbeCursor *pC;
drh856c1032009-06-02 15:21:42 +00005401 int res;
5402 UnpackedRecord r;
drh8721ce42001-11-07 14:22:00 +00005403
drh653b82a2009-06-22 11:10:47 +00005404 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5405 pC = p->apCsr[pOp->p1];
5406 assert( pC!=0 );
drhd4187c72010-08-30 22:15:45 +00005407 assert( pC->isOrdered );
drhc960dcb2015-11-20 19:22:01 +00005408 assert( pC->eCurType==CURTYPE_BTREE );
5409 assert( pC->uc.pCursor!=0);
drh3da046d2013-11-11 03:24:11 +00005410 assert( pC->deferredMoveto==0 );
5411 assert( pOp->p5==0 || pOp->p5==1 );
5412 assert( pOp->p4type==P4_INT32 );
5413 r.pKeyInfo = pC->pKeyInfo;
5414 r.nField = (u16)pOp->p4.i;
drh4a1d3652014-02-14 15:13:36 +00005415 if( pOp->opcode<OP_IdxLT ){
5416 assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxGT );
dan1fed5da2014-02-25 21:01:25 +00005417 r.default_rc = -1;
drh3da046d2013-11-11 03:24:11 +00005418 }else{
drh4a1d3652014-02-14 15:13:36 +00005419 assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxLT );
dan1fed5da2014-02-25 21:01:25 +00005420 r.default_rc = 0;
drh3da046d2013-11-11 03:24:11 +00005421 }
5422 r.aMem = &aMem[pOp->p3];
drh2b4ded92010-09-27 21:09:31 +00005423#ifdef SQLITE_DEBUG
drh3da046d2013-11-11 03:24:11 +00005424 { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
drh2b4ded92010-09-27 21:09:31 +00005425#endif
drh2dc06482013-12-11 00:59:10 +00005426 res = 0; /* Not needed. Only used to silence a warning. */
drhd3b74202014-09-17 16:41:15 +00005427 rc = sqlite3VdbeIdxKeyCompare(db, pC, &r, &res);
drh4a1d3652014-02-14 15:13:36 +00005428 assert( (OP_IdxLE&1)==(OP_IdxLT&1) && (OP_IdxGE&1)==(OP_IdxGT&1) );
5429 if( (pOp->opcode&1)==(OP_IdxLT&1) ){
5430 assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxLT );
drh3da046d2013-11-11 03:24:11 +00005431 res = -res;
5432 }else{
drh4a1d3652014-02-14 15:13:36 +00005433 assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxGT );
drh3da046d2013-11-11 03:24:11 +00005434 res++;
5435 }
drh688852a2014-02-17 22:40:43 +00005436 VdbeBranchTaken(res>0,2);
drh9467abf2016-02-17 18:44:11 +00005437 if( rc ) goto abort_due_to_error;
drhf56fa462015-04-13 21:39:54 +00005438 if( res>0 ) goto jump_to_p2;
drh8721ce42001-11-07 14:22:00 +00005439 break;
5440}
5441
drh98757152008-01-09 23:04:12 +00005442/* Opcode: Destroy P1 P2 P3 * *
drh5e00f6c2001-09-13 13:46:56 +00005443**
5444** Delete an entire database table or index whose root page in the database
5445** file is given by P1.
drhb19a2bc2001-09-16 00:13:26 +00005446**
drh98757152008-01-09 23:04:12 +00005447** The table being destroyed is in the main database file if P3==0. If
5448** P3==1 then the table to be clear is in the auxiliary database file
drhf57b3392001-10-08 13:22:32 +00005449** that is used to store tables create using CREATE TEMPORARY TABLE.
5450**
drh205f48e2004-11-05 00:43:11 +00005451** If AUTOVACUUM is enabled then it is possible that another root page
5452** might be moved into the newly deleted root page in order to keep all
5453** root pages contiguous at the beginning of the database. The former
5454** value of the root page that moved - its value before the move occurred -
dana34adaf2017-04-08 14:11:47 +00005455** is stored in register P2. If no page movement was required (because the
5456** table being dropped was already the last one in the database) then a
5457** zero is stored in register P2. If AUTOVACUUM is disabled then a zero
5458** is stored in register P2.
5459**
5460** This opcode throws an error if there are any active reader VMs when
5461** it is invoked. This is done to avoid the difficulty associated with
5462** updating existing cursors when a root page is moved in an AUTOVACUUM
5463** database. This error is thrown even if the database is not an AUTOVACUUM
5464** db in order to avoid introducing an incompatibility between autovacuum
5465** and non-autovacuum modes.
drh205f48e2004-11-05 00:43:11 +00005466**
drhb19a2bc2001-09-16 00:13:26 +00005467** See also: Clear
drh5e00f6c2001-09-13 13:46:56 +00005468*/
drh27a348c2015-04-13 19:14:06 +00005469case OP_Destroy: { /* out2 */
danielk1977a0bf2652004-11-04 14:30:04 +00005470 int iMoved;
drh856c1032009-06-02 15:21:42 +00005471 int iDb;
drh3a949872012-09-18 13:20:13 +00005472
drh9e92a472013-06-27 17:40:30 +00005473 assert( p->readOnly==0 );
drh055f2982016-01-15 15:06:41 +00005474 assert( pOp->p1>1 );
drh27a348c2015-04-13 19:14:06 +00005475 pOut = out2Prerelease(p, pOp);
drh3c657212009-11-17 23:59:58 +00005476 pOut->flags = MEM_Null;
drh086723a2015-03-24 12:51:52 +00005477 if( db->nVdbeRead > db->nVDestroy+1 ){
danielk1977e6efa742004-11-10 11:55:10 +00005478 rc = SQLITE_LOCKED;
drh77658e22007-12-04 16:54:52 +00005479 p->errorAction = OE_Abort;
drh9467abf2016-02-17 18:44:11 +00005480 goto abort_due_to_error;
danielk1977e6efa742004-11-10 11:55:10 +00005481 }else{
drh856c1032009-06-02 15:21:42 +00005482 iDb = pOp->p3;
drha7ab6d82014-07-21 15:44:39 +00005483 assert( DbMaskTest(p->btreeMask, iDb) );
drh2dc06482013-12-11 00:59:10 +00005484 iMoved = 0; /* Not needed. Only to silence a warning. */
drh98757152008-01-09 23:04:12 +00005485 rc = sqlite3BtreeDropTable(db->aDb[iDb].pBt, pOp->p1, &iMoved);
drh3c657212009-11-17 23:59:58 +00005486 pOut->flags = MEM_Int;
drh98757152008-01-09 23:04:12 +00005487 pOut->u.i = iMoved;
drh9467abf2016-02-17 18:44:11 +00005488 if( rc ) goto abort_due_to_error;
drh3765df42006-06-28 18:18:09 +00005489#ifndef SQLITE_OMIT_AUTOVACUUM
drh9467abf2016-02-17 18:44:11 +00005490 if( iMoved!=0 ){
drhcdf011d2011-04-04 21:25:28 +00005491 sqlite3RootPageMoved(db, iDb, iMoved, pOp->p1);
5492 /* All OP_Destroy operations occur on the same btree */
5493 assert( resetSchemaOnFault==0 || resetSchemaOnFault==iDb+1 );
5494 resetSchemaOnFault = iDb+1;
danielk1977e6efa742004-11-10 11:55:10 +00005495 }
drh3765df42006-06-28 18:18:09 +00005496#endif
danielk1977a0bf2652004-11-04 14:30:04 +00005497 }
drh5e00f6c2001-09-13 13:46:56 +00005498 break;
5499}
5500
danielk1977c7af4842008-10-27 13:59:33 +00005501/* Opcode: Clear P1 P2 P3
drh5edc3122001-09-13 21:53:09 +00005502**
5503** Delete all contents of the database table or index whose root page
drhb19a2bc2001-09-16 00:13:26 +00005504** in the database file is given by P1. But, unlike Destroy, do not
drh5edc3122001-09-13 21:53:09 +00005505** remove the table or index from the database file.
drhb19a2bc2001-09-16 00:13:26 +00005506**
drhf57b3392001-10-08 13:22:32 +00005507** The table being clear is in the main database file if P2==0. If
5508** P2==1 then the table to be clear is in the auxiliary database file
5509** that is used to store tables create using CREATE TEMPORARY TABLE.
5510**
shanebe217792009-03-05 04:20:31 +00005511** If the P3 value is non-zero, then the table referred to must be an
danielk1977c7af4842008-10-27 13:59:33 +00005512** intkey table (an SQL table, not an index). In this case the row change
5513** count is incremented by the number of rows in the table being cleared.
5514** If P3 is greater than zero, then the value stored in register P3 is
5515** also incremented by the number of rows in the table being cleared.
5516**
drhb19a2bc2001-09-16 00:13:26 +00005517** See also: Destroy
drh5edc3122001-09-13 21:53:09 +00005518*/
drh9cbf3422008-01-17 16:22:13 +00005519case OP_Clear: {
drh856c1032009-06-02 15:21:42 +00005520 int nChange;
5521
5522 nChange = 0;
drh9e92a472013-06-27 17:40:30 +00005523 assert( p->readOnly==0 );
drha7ab6d82014-07-21 15:44:39 +00005524 assert( DbMaskTest(p->btreeMask, pOp->p2) );
danielk1977c7af4842008-10-27 13:59:33 +00005525 rc = sqlite3BtreeClearTable(
5526 db->aDb[pOp->p2].pBt, pOp->p1, (pOp->p3 ? &nChange : 0)
5527 );
5528 if( pOp->p3 ){
5529 p->nChange += nChange;
5530 if( pOp->p3>0 ){
drh2b4ded92010-09-27 21:09:31 +00005531 assert( memIsValid(&aMem[pOp->p3]) );
5532 memAboutToChange(p, &aMem[pOp->p3]);
drha6c2ed92009-11-14 23:22:23 +00005533 aMem[pOp->p3].u.i += nChange;
danielk1977c7af4842008-10-27 13:59:33 +00005534 }
5535 }
drh9467abf2016-02-17 18:44:11 +00005536 if( rc ) goto abort_due_to_error;
drh5edc3122001-09-13 21:53:09 +00005537 break;
5538}
5539
drh65ea12c2014-03-19 17:41:36 +00005540/* Opcode: ResetSorter P1 * * * *
drh079a3072014-03-19 14:10:55 +00005541**
drh65ea12c2014-03-19 17:41:36 +00005542** Delete all contents from the ephemeral table or sorter
5543** that is open on cursor P1.
drh079a3072014-03-19 14:10:55 +00005544**
drh65ea12c2014-03-19 17:41:36 +00005545** This opcode only works for cursors used for sorting and
5546** opened with OP_OpenEphemeral or OP_SorterOpen.
drh079a3072014-03-19 14:10:55 +00005547*/
drh65ea12c2014-03-19 17:41:36 +00005548case OP_ResetSorter: {
drh079a3072014-03-19 14:10:55 +00005549 VdbeCursor *pC;
5550
5551 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
5552 pC = p->apCsr[pOp->p1];
5553 assert( pC!=0 );
drhc960dcb2015-11-20 19:22:01 +00005554 if( isSorter(pC) ){
5555 sqlite3VdbeSorterReset(db, pC->uc.pSorter);
drh65ea12c2014-03-19 17:41:36 +00005556 }else{
drhc960dcb2015-11-20 19:22:01 +00005557 assert( pC->eCurType==CURTYPE_BTREE );
drh65ea12c2014-03-19 17:41:36 +00005558 assert( pC->isEphemeral );
drhc960dcb2015-11-20 19:22:01 +00005559 rc = sqlite3BtreeClearTableOfCursor(pC->uc.pCursor);
drh9467abf2016-02-17 18:44:11 +00005560 if( rc ) goto abort_due_to_error;
drh65ea12c2014-03-19 17:41:36 +00005561 }
drh079a3072014-03-19 14:10:55 +00005562 break;
5563}
5564
drh4c583122008-01-04 22:01:03 +00005565/* Opcode: CreateTable P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00005566** Synopsis: r[P2]=root iDb=P1
drh5b2fd562001-09-13 15:21:31 +00005567**
drh4c583122008-01-04 22:01:03 +00005568** Allocate a new table in the main database file if P1==0 or in the
5569** auxiliary database file if P1==1 or in an attached database if
5570** P1>1. Write the root page number of the new table into
drh9cbf3422008-01-17 16:22:13 +00005571** register P2
drh5b2fd562001-09-13 15:21:31 +00005572**
drhc6b52df2002-01-04 03:09:29 +00005573** The difference between a table and an index is this: A table must
5574** have a 4-byte integer key and can have arbitrary data. An index
5575** has an arbitrary key but no data.
5576**
drhb19a2bc2001-09-16 00:13:26 +00005577** See also: CreateIndex
drh5b2fd562001-09-13 15:21:31 +00005578*/
drh4c583122008-01-04 22:01:03 +00005579/* Opcode: CreateIndex P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00005580** Synopsis: r[P2]=root iDb=P1
drhf57b3392001-10-08 13:22:32 +00005581**
drh4c583122008-01-04 22:01:03 +00005582** Allocate a new index in the main database file if P1==0 or in the
5583** auxiliary database file if P1==1 or in an attached database if
5584** P1>1. Write the root page number of the new table into
drh9cbf3422008-01-17 16:22:13 +00005585** register P2.
drhf57b3392001-10-08 13:22:32 +00005586**
drhc6b52df2002-01-04 03:09:29 +00005587** See documentation on OP_CreateTable for additional information.
drhf57b3392001-10-08 13:22:32 +00005588*/
drh27a348c2015-04-13 19:14:06 +00005589case OP_CreateIndex: /* out2 */
5590case OP_CreateTable: { /* out2 */
drh856c1032009-06-02 15:21:42 +00005591 int pgno;
drhf328bc82004-05-10 23:29:49 +00005592 int flags;
drh234c39d2004-07-24 03:30:47 +00005593 Db *pDb;
drh856c1032009-06-02 15:21:42 +00005594
drh27a348c2015-04-13 19:14:06 +00005595 pOut = out2Prerelease(p, pOp);
drh856c1032009-06-02 15:21:42 +00005596 pgno = 0;
drh234c39d2004-07-24 03:30:47 +00005597 assert( pOp->p1>=0 && pOp->p1<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00005598 assert( DbMaskTest(p->btreeMask, pOp->p1) );
drh9e92a472013-06-27 17:40:30 +00005599 assert( p->readOnly==0 );
drh234c39d2004-07-24 03:30:47 +00005600 pDb = &db->aDb[pOp->p1];
5601 assert( pDb->pBt!=0 );
drhc6b52df2002-01-04 03:09:29 +00005602 if( pOp->opcode==OP_CreateTable ){
danielk197794076252004-05-14 12:16:11 +00005603 /* flags = BTREE_INTKEY; */
drhd4187c72010-08-30 22:15:45 +00005604 flags = BTREE_INTKEY;
drhc6b52df2002-01-04 03:09:29 +00005605 }else{
drhd4187c72010-08-30 22:15:45 +00005606 flags = BTREE_BLOBKEY;
drhc6b52df2002-01-04 03:09:29 +00005607 }
drh234c39d2004-07-24 03:30:47 +00005608 rc = sqlite3BtreeCreateTable(pDb->pBt, &pgno, flags);
drh9467abf2016-02-17 18:44:11 +00005609 if( rc ) goto abort_due_to_error;
drh88a003e2008-12-11 16:17:03 +00005610 pOut->u.i = pgno;
drh5b2fd562001-09-13 15:21:31 +00005611 break;
5612}
5613
drh4a54bb52017-02-18 15:58:52 +00005614/* Opcode: SqlExec * * * P4 *
5615**
5616** Run the SQL statement or statements specified in the P4 string.
5617*/
5618case OP_SqlExec: {
drhbce04142017-02-23 00:58:36 +00005619 db->nSqlExec++;
drh4a54bb52017-02-18 15:58:52 +00005620 rc = sqlite3_exec(db, pOp->p4.z, 0, 0, 0);
drhbce04142017-02-23 00:58:36 +00005621 db->nSqlExec--;
drh4a54bb52017-02-18 15:58:52 +00005622 if( rc ) goto abort_due_to_error;
5623 break;
5624}
5625
drh22645842011-03-24 01:34:03 +00005626/* Opcode: ParseSchema P1 * * P4 *
drh234c39d2004-07-24 03:30:47 +00005627**
5628** Read and parse all entries from the SQLITE_MASTER table of database P1
drh22645842011-03-24 01:34:03 +00005629** that match the WHERE clause P4.
drh234c39d2004-07-24 03:30:47 +00005630**
5631** This opcode invokes the parser to create a new virtual machine,
shane21e7feb2008-05-30 15:59:49 +00005632** then runs the new virtual machine. It is thus a re-entrant opcode.
drh234c39d2004-07-24 03:30:47 +00005633*/
drh9cbf3422008-01-17 16:22:13 +00005634case OP_ParseSchema: {
drh856c1032009-06-02 15:21:42 +00005635 int iDb;
5636 const char *zMaster;
5637 char *zSql;
5638 InitData initData;
5639
drhbdaec522011-04-04 00:14:43 +00005640 /* Any prepared statement that invokes this opcode will hold mutexes
5641 ** on every btree. This is a prerequisite for invoking
5642 ** sqlite3InitCallback().
5643 */
5644#ifdef SQLITE_DEBUG
5645 for(iDb=0; iDb<db->nDb; iDb++){
5646 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
5647 }
5648#endif
drhbdaec522011-04-04 00:14:43 +00005649
drh856c1032009-06-02 15:21:42 +00005650 iDb = pOp->p1;
drh234c39d2004-07-24 03:30:47 +00005651 assert( iDb>=0 && iDb<db->nDb );
dan6c154872011-04-02 09:44:43 +00005652 assert( DbHasProperty(db, iDb, DB_SchemaLoaded) );
drhbdaec522011-04-04 00:14:43 +00005653 /* Used to be a conditional */ {
drhe0a04a32016-12-16 01:00:21 +00005654 zMaster = MASTER_NAME;
danielk1977a8bbef82009-03-23 17:11:26 +00005655 initData.db = db;
5656 initData.iDb = pOp->p1;
5657 initData.pzErrMsg = &p->zErrMsg;
5658 zSql = sqlite3MPrintf(db,
drh6a9c64b2010-01-12 23:54:14 +00005659 "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s ORDER BY rowid",
drh69c33822016-08-18 14:33:11 +00005660 db->aDb[iDb].zDbSName, zMaster, pOp->p4.z);
danielk1977a8bbef82009-03-23 17:11:26 +00005661 if( zSql==0 ){
mistachkinfad30392016-02-13 23:43:46 +00005662 rc = SQLITE_NOMEM_BKPT;
danielk1977a8bbef82009-03-23 17:11:26 +00005663 }else{
danielk1977a8bbef82009-03-23 17:11:26 +00005664 assert( db->init.busy==0 );
5665 db->init.busy = 1;
5666 initData.rc = SQLITE_OK;
5667 assert( !db->mallocFailed );
5668 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
5669 if( rc==SQLITE_OK ) rc = initData.rc;
drhdbd6a7d2017-04-05 12:39:49 +00005670 sqlite3DbFreeNN(db, zSql);
danielk1977a8bbef82009-03-23 17:11:26 +00005671 db->init.busy = 0;
danielk1977a8bbef82009-03-23 17:11:26 +00005672 }
drh3c23a882007-01-09 14:01:13 +00005673 }
drh9467abf2016-02-17 18:44:11 +00005674 if( rc ){
5675 sqlite3ResetAllSchemasOfConnection(db);
5676 if( rc==SQLITE_NOMEM ){
5677 goto no_mem;
5678 }
5679 goto abort_due_to_error;
danielk1977261919c2005-12-06 12:52:59 +00005680 }
drh234c39d2004-07-24 03:30:47 +00005681 break;
5682}
5683
drh8bfdf722009-06-19 14:06:03 +00005684#if !defined(SQLITE_OMIT_ANALYZE)
drh98757152008-01-09 23:04:12 +00005685/* Opcode: LoadAnalysis P1 * * * *
drh497e4462005-07-23 03:18:40 +00005686**
5687** Read the sqlite_stat1 table for database P1 and load the content
5688** of that table into the internal index hash table. This will cause
5689** the analysis to be used when preparing all subsequent queries.
5690*/
drh9cbf3422008-01-17 16:22:13 +00005691case OP_LoadAnalysis: {
drh856c1032009-06-02 15:21:42 +00005692 assert( pOp->p1>=0 && pOp->p1<db->nDb );
5693 rc = sqlite3AnalysisLoad(db, pOp->p1);
drh9467abf2016-02-17 18:44:11 +00005694 if( rc ) goto abort_due_to_error;
drh497e4462005-07-23 03:18:40 +00005695 break;
5696}
drh8bfdf722009-06-19 14:06:03 +00005697#endif /* !defined(SQLITE_OMIT_ANALYZE) */
drh497e4462005-07-23 03:18:40 +00005698
drh98757152008-01-09 23:04:12 +00005699/* Opcode: DropTable P1 * * P4 *
drh956bc922004-07-24 17:38:29 +00005700**
5701** Remove the internal (in-memory) data structures that describe
drh66a51672008-01-03 00:01:23 +00005702** the table named P4 in database P1. This is called after a table
drh5dad9a32014-07-25 18:37:42 +00005703** is dropped from disk (using the Destroy opcode) in order to keep
5704** the internal representation of the
drh956bc922004-07-24 17:38:29 +00005705** schema consistent with what is on disk.
5706*/
drh9cbf3422008-01-17 16:22:13 +00005707case OP_DropTable: {
danielk19772dca4ac2008-01-03 11:50:29 +00005708 sqlite3UnlinkAndDeleteTable(db, pOp->p1, pOp->p4.z);
drh956bc922004-07-24 17:38:29 +00005709 break;
5710}
5711
drh98757152008-01-09 23:04:12 +00005712/* Opcode: DropIndex P1 * * P4 *
drh956bc922004-07-24 17:38:29 +00005713**
5714** Remove the internal (in-memory) data structures that describe
drh66a51672008-01-03 00:01:23 +00005715** the index named P4 in database P1. This is called after an index
drh5dad9a32014-07-25 18:37:42 +00005716** is dropped from disk (using the Destroy opcode)
5717** in order to keep the internal representation of the
drh956bc922004-07-24 17:38:29 +00005718** schema consistent with what is on disk.
5719*/
drh9cbf3422008-01-17 16:22:13 +00005720case OP_DropIndex: {
danielk19772dca4ac2008-01-03 11:50:29 +00005721 sqlite3UnlinkAndDeleteIndex(db, pOp->p1, pOp->p4.z);
drh956bc922004-07-24 17:38:29 +00005722 break;
5723}
5724
drh98757152008-01-09 23:04:12 +00005725/* Opcode: DropTrigger P1 * * P4 *
drh956bc922004-07-24 17:38:29 +00005726**
5727** Remove the internal (in-memory) data structures that describe
drh66a51672008-01-03 00:01:23 +00005728** the trigger named P4 in database P1. This is called after a trigger
drh5dad9a32014-07-25 18:37:42 +00005729** is dropped from disk (using the Destroy opcode) in order to keep
5730** the internal representation of the
drh956bc922004-07-24 17:38:29 +00005731** schema consistent with what is on disk.
5732*/
drh9cbf3422008-01-17 16:22:13 +00005733case OP_DropTrigger: {
danielk19772dca4ac2008-01-03 11:50:29 +00005734 sqlite3UnlinkAndDeleteTrigger(db, pOp->p1, pOp->p4.z);
drh956bc922004-07-24 17:38:29 +00005735 break;
5736}
5737
drh234c39d2004-07-24 03:30:47 +00005738
drhb7f91642004-10-31 02:22:47 +00005739#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh98968b22016-03-15 22:00:39 +00005740/* Opcode: IntegrityCk P1 P2 P3 P4 P5
drh5e00f6c2001-09-13 13:46:56 +00005741**
drh98757152008-01-09 23:04:12 +00005742** Do an analysis of the currently open database. Store in
5743** register P1 the text of an error message describing any problems.
5744** If no problems are found, store a NULL in register P1.
drh1dcdbc02007-01-27 02:24:54 +00005745**
drh66accfc2017-02-22 18:04:42 +00005746** The register P3 contains one less than the maximum number of allowed errors.
drh60a713c2008-01-21 16:22:45 +00005747** At most reg(P3) errors will be reported.
5748** In other words, the analysis stops as soon as reg(P1) errors are
5749** seen. Reg(P1) is updated with the number of errors remaining.
drhb19a2bc2001-09-16 00:13:26 +00005750**
drh98968b22016-03-15 22:00:39 +00005751** The root page numbers of all tables in the database are integers
5752** stored in P4_INTARRAY argument.
drh21504322002-06-25 13:16:02 +00005753**
drh98757152008-01-09 23:04:12 +00005754** If P5 is not zero, the check is done on the auxiliary database
drh21504322002-06-25 13:16:02 +00005755** file, not the main database file.
drh1dd397f2002-02-03 03:34:07 +00005756**
drh1dcdbc02007-01-27 02:24:54 +00005757** This opcode is used to implement the integrity_check pragma.
drh5e00f6c2001-09-13 13:46:56 +00005758*/
drhaaab5722002-02-19 13:39:21 +00005759case OP_IntegrityCk: {
drh98757152008-01-09 23:04:12 +00005760 int nRoot; /* Number of tables to check. (Number of root pages.) */
5761 int *aRoot; /* Array of rootpage numbers for tables to be checked */
drh98757152008-01-09 23:04:12 +00005762 int nErr; /* Number of errors reported */
5763 char *z; /* Text of the error report */
5764 Mem *pnErr; /* Register keeping track of errors remaining */
drh9e92a472013-06-27 17:40:30 +00005765
drh1713afb2013-06-28 01:24:57 +00005766 assert( p->bIsReader );
drh98757152008-01-09 23:04:12 +00005767 nRoot = pOp->p2;
drh98968b22016-03-15 22:00:39 +00005768 aRoot = pOp->p4.ai;
drh79069752004-05-22 21:30:40 +00005769 assert( nRoot>0 );
drh98968b22016-03-15 22:00:39 +00005770 assert( aRoot[nRoot]==0 );
drh9f6168b2016-03-19 23:32:58 +00005771 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
drha6c2ed92009-11-14 23:22:23 +00005772 pnErr = &aMem[pOp->p3];
drh1dcdbc02007-01-27 02:24:54 +00005773 assert( (pnErr->flags & MEM_Int)!=0 );
drh98757152008-01-09 23:04:12 +00005774 assert( (pnErr->flags & (MEM_Str|MEM_Blob))==0 );
drha6c2ed92009-11-14 23:22:23 +00005775 pIn1 = &aMem[pOp->p1];
drh98757152008-01-09 23:04:12 +00005776 assert( pOp->p5<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00005777 assert( DbMaskTest(p->btreeMask, pOp->p5) );
drh98757152008-01-09 23:04:12 +00005778 z = sqlite3BtreeIntegrityCheck(db->aDb[pOp->p5].pBt, aRoot, nRoot,
drh66accfc2017-02-22 18:04:42 +00005779 (int)pnErr->u.i+1, &nErr);
drha05a7222008-01-19 03:35:58 +00005780 sqlite3VdbeMemSetNull(pIn1);
drh1dcdbc02007-01-27 02:24:54 +00005781 if( nErr==0 ){
5782 assert( z==0 );
drhc890fec2008-08-01 20:10:08 +00005783 }else if( z==0 ){
5784 goto no_mem;
drh1dd397f2002-02-03 03:34:07 +00005785 }else{
drh66accfc2017-02-22 18:04:42 +00005786 pnErr->u.i -= nErr-1;
danielk1977a7a8e142008-02-13 18:25:27 +00005787 sqlite3VdbeMemSetStr(pIn1, z, -1, SQLITE_UTF8, sqlite3_free);
danielk19778a6b5412004-05-24 07:04:25 +00005788 }
drhb7654112008-01-12 12:48:07 +00005789 UPDATE_MAX_BLOBSIZE(pIn1);
drh98757152008-01-09 23:04:12 +00005790 sqlite3VdbeChangeEncoding(pIn1, encoding);
drh5e00f6c2001-09-13 13:46:56 +00005791 break;
5792}
drhb7f91642004-10-31 02:22:47 +00005793#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5e00f6c2001-09-13 13:46:56 +00005794
drh3d4501e2008-12-04 20:40:10 +00005795/* Opcode: RowSetAdd P1 P2 * * *
drh72e26de2016-08-24 21:24:04 +00005796** Synopsis: rowset(P1)=r[P2]
drh5e00f6c2001-09-13 13:46:56 +00005797**
drhbb6783b2017-04-29 18:02:49 +00005798** Insert the integer value held by register P2 into a RowSet object
drh3d4501e2008-12-04 20:40:10 +00005799** held in register P1.
5800**
5801** An assertion fails if P2 is not an integer.
drh5e00f6c2001-09-13 13:46:56 +00005802*/
drh93952eb2009-11-13 19:43:43 +00005803case OP_RowSetAdd: { /* in1, in2 */
drh3c657212009-11-17 23:59:58 +00005804 pIn1 = &aMem[pOp->p1];
5805 pIn2 = &aMem[pOp->p2];
drh93952eb2009-11-13 19:43:43 +00005806 assert( (pIn2->flags & MEM_Int)!=0 );
5807 if( (pIn1->flags & MEM_RowSet)==0 ){
5808 sqlite3VdbeMemSetRowSet(pIn1);
5809 if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
drh3d4501e2008-12-04 20:40:10 +00005810 }
drh93952eb2009-11-13 19:43:43 +00005811 sqlite3RowSetInsert(pIn1->u.pRowSet, pIn2->u.i);
drh3d4501e2008-12-04 20:40:10 +00005812 break;
5813}
5814
5815/* Opcode: RowSetRead P1 P2 P3 * *
drh72e26de2016-08-24 21:24:04 +00005816** Synopsis: r[P3]=rowset(P1)
drh3d4501e2008-12-04 20:40:10 +00005817**
drhbb6783b2017-04-29 18:02:49 +00005818** Extract the smallest value from the RowSet object in P1
5819** and put that value into register P3.
5820** Or, if RowSet object P1 is initially empty, leave P3
drh3d4501e2008-12-04 20:40:10 +00005821** unchanged and jump to instruction P2.
5822*/
drh93952eb2009-11-13 19:43:43 +00005823case OP_RowSetRead: { /* jump, in1, out3 */
drh3d4501e2008-12-04 20:40:10 +00005824 i64 val;
drh49afe3a2013-07-10 03:05:14 +00005825
drh3c657212009-11-17 23:59:58 +00005826 pIn1 = &aMem[pOp->p1];
drh93952eb2009-11-13 19:43:43 +00005827 if( (pIn1->flags & MEM_RowSet)==0
5828 || sqlite3RowSetNext(pIn1->u.pRowSet, &val)==0
drh3d4501e2008-12-04 20:40:10 +00005829 ){
5830 /* The boolean index is empty */
drh93952eb2009-11-13 19:43:43 +00005831 sqlite3VdbeMemSetNull(pIn1);
drh688852a2014-02-17 22:40:43 +00005832 VdbeBranchTaken(1,2);
drhf56fa462015-04-13 21:39:54 +00005833 goto jump_to_p2_and_check_for_interrupt;
drh3d4501e2008-12-04 20:40:10 +00005834 }else{
5835 /* A value was pulled from the index */
drh688852a2014-02-17 22:40:43 +00005836 VdbeBranchTaken(0,2);
drhf56fa462015-04-13 21:39:54 +00005837 sqlite3VdbeMemSetInt64(&aMem[pOp->p3], val);
drh17435752007-08-16 04:30:38 +00005838 }
drh49afe3a2013-07-10 03:05:14 +00005839 goto check_for_interrupt;
drh5e00f6c2001-09-13 13:46:56 +00005840}
5841
drh1b26c7c2009-04-22 02:15:47 +00005842/* Opcode: RowSetTest P1 P2 P3 P4
drh81316f82013-10-29 20:40:47 +00005843** Synopsis: if r[P3] in rowset(P1) goto P2
danielk19771d461462009-04-21 09:02:45 +00005844**
drhade97602009-04-21 15:05:18 +00005845** Register P3 is assumed to hold a 64-bit integer value. If register P1
drh1b26c7c2009-04-22 02:15:47 +00005846** contains a RowSet object and that RowSet object contains
danielk19771d461462009-04-21 09:02:45 +00005847** the value held in P3, jump to register P2. Otherwise, insert the
drh1b26c7c2009-04-22 02:15:47 +00005848** integer in P3 into the RowSet and continue on to the
drhade97602009-04-21 15:05:18 +00005849** next opcode.
danielk19771d461462009-04-21 09:02:45 +00005850**
drhbb6783b2017-04-29 18:02:49 +00005851** The RowSet object is optimized for the case where sets of integers
5852** are inserted in distinct phases, which each set contains no duplicates.
5853** Each set is identified by a unique P4 value. The first set
5854** must have P4==0, the final set must have P4==-1, and for all other sets
5855** must have P4>0.
danielk19771d461462009-04-21 09:02:45 +00005856**
5857** This allows optimizations: (a) when P4==0 there is no need to test
drhbb6783b2017-04-29 18:02:49 +00005858** the RowSet object for P3, as it is guaranteed not to contain it,
danielk19771d461462009-04-21 09:02:45 +00005859** (b) when P4==-1 there is no need to insert the value, as it will
5860** never be tested for, and (c) when a value that is part of set X is
5861** inserted, there is no need to search to see if the same value was
5862** previously inserted as part of set X (only if it was previously
5863** inserted as part of some other set).
5864*/
drh1b26c7c2009-04-22 02:15:47 +00005865case OP_RowSetTest: { /* jump, in1, in3 */
drh856c1032009-06-02 15:21:42 +00005866 int iSet;
5867 int exists;
5868
drh3c657212009-11-17 23:59:58 +00005869 pIn1 = &aMem[pOp->p1];
5870 pIn3 = &aMem[pOp->p3];
drh856c1032009-06-02 15:21:42 +00005871 iSet = pOp->p4.i;
danielk19771d461462009-04-21 09:02:45 +00005872 assert( pIn3->flags&MEM_Int );
5873
drh1b26c7c2009-04-22 02:15:47 +00005874 /* If there is anything other than a rowset object in memory cell P1,
5875 ** delete it now and initialize P1 with an empty rowset
danielk19771d461462009-04-21 09:02:45 +00005876 */
drh733bf1b2009-04-22 00:47:00 +00005877 if( (pIn1->flags & MEM_RowSet)==0 ){
5878 sqlite3VdbeMemSetRowSet(pIn1);
5879 if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
danielk19771d461462009-04-21 09:02:45 +00005880 }
5881
5882 assert( pOp->p4type==P4_INT32 );
drh1b26c7c2009-04-22 02:15:47 +00005883 assert( iSet==-1 || iSet>=0 );
danielk19771d461462009-04-21 09:02:45 +00005884 if( iSet ){
drhd83cad22014-04-10 02:24:48 +00005885 exists = sqlite3RowSetTest(pIn1->u.pRowSet, iSet, pIn3->u.i);
drh688852a2014-02-17 22:40:43 +00005886 VdbeBranchTaken(exists!=0,2);
drhf56fa462015-04-13 21:39:54 +00005887 if( exists ) goto jump_to_p2;
danielk19771d461462009-04-21 09:02:45 +00005888 }
5889 if( iSet>=0 ){
drh733bf1b2009-04-22 00:47:00 +00005890 sqlite3RowSetInsert(pIn1->u.pRowSet, pIn3->u.i);
danielk19771d461462009-04-21 09:02:45 +00005891 }
5892 break;
5893}
5894
drh5e00f6c2001-09-13 13:46:56 +00005895
danielk197793758c82005-01-21 08:13:14 +00005896#ifndef SQLITE_OMIT_TRIGGER
dan165921a2009-08-28 18:53:45 +00005897
drh0fd61352014-02-07 02:29:45 +00005898/* Opcode: Program P1 P2 P3 P4 P5
dan165921a2009-08-28 18:53:45 +00005899**
dan76d462e2009-08-30 11:42:51 +00005900** Execute the trigger program passed as P4 (type P4_SUBPROGRAM).
dan165921a2009-08-28 18:53:45 +00005901**
dan76d462e2009-08-30 11:42:51 +00005902** P1 contains the address of the memory cell that contains the first memory
5903** cell in an array of values used as arguments to the sub-program. P2
5904** contains the address to jump to if the sub-program throws an IGNORE
5905** exception using the RAISE() function. Register P3 contains the address
5906** of a memory cell in this (the parent) VM that is used to allocate the
5907** memory required by the sub-vdbe at runtime.
dan165921a2009-08-28 18:53:45 +00005908**
5909** P4 is a pointer to the VM containing the trigger program.
drh0fd61352014-02-07 02:29:45 +00005910**
5911** If P5 is non-zero, then recursive program invocation is enabled.
dan165921a2009-08-28 18:53:45 +00005912*/
dan76d462e2009-08-30 11:42:51 +00005913case OP_Program: { /* jump */
dan65a7cd12009-09-01 12:16:01 +00005914 int nMem; /* Number of memory registers for sub-program */
5915 int nByte; /* Bytes of runtime space required for sub-program */
5916 Mem *pRt; /* Register to allocate runtime space */
5917 Mem *pMem; /* Used to iterate through memory cells */
5918 Mem *pEnd; /* Last memory cell in new array */
5919 VdbeFrame *pFrame; /* New vdbe frame to execute in */
5920 SubProgram *pProgram; /* Sub-program to execute */
5921 void *t; /* Token identifying trigger */
5922
5923 pProgram = pOp->p4.pProgram;
drha6c2ed92009-11-14 23:22:23 +00005924 pRt = &aMem[pOp->p3];
dan165921a2009-08-28 18:53:45 +00005925 assert( pProgram->nOp>0 );
5926
dan1da40a32009-09-19 17:00:31 +00005927 /* If the p5 flag is clear, then recursive invocation of triggers is
5928 ** disabled for backwards compatibility (p5 is set if this sub-program
5929 ** is really a trigger, not a foreign key action, and the flag set
5930 ** and cleared by the "PRAGMA recursive_triggers" command is clear).
dan165921a2009-08-28 18:53:45 +00005931 **
5932 ** It is recursive invocation of triggers, at the SQL level, that is
5933 ** disabled. In some cases a single trigger may generate more than one
5934 ** SubProgram (if the trigger may be executed with more than one different
5935 ** ON CONFLICT algorithm). SubProgram structures associated with a
5936 ** single trigger all have the same value for the SubProgram.token
dan1da40a32009-09-19 17:00:31 +00005937 ** variable. */
5938 if( pOp->p5 ){
dan65a7cd12009-09-01 12:16:01 +00005939 t = pProgram->token;
dan165921a2009-08-28 18:53:45 +00005940 for(pFrame=p->pFrame; pFrame && pFrame->token!=t; pFrame=pFrame->pParent);
5941 if( pFrame ) break;
5942 }
5943
danf5894502009-10-07 18:41:19 +00005944 if( p->nFrame>=db->aLimit[SQLITE_LIMIT_TRIGGER_DEPTH] ){
dan165921a2009-08-28 18:53:45 +00005945 rc = SQLITE_ERROR;
drh22c17b82015-05-15 04:13:15 +00005946 sqlite3VdbeError(p, "too many levels of trigger recursion");
drh9467abf2016-02-17 18:44:11 +00005947 goto abort_due_to_error;
dan165921a2009-08-28 18:53:45 +00005948 }
5949
5950 /* Register pRt is used to store the memory required to save the state
5951 ** of the current program, and the memory required at runtime to execute
5952 ** the trigger program. If this trigger has been fired before, then pRt
5953 ** is already allocated. Otherwise, it must be initialized. */
5954 if( (pRt->flags&MEM_Frame)==0 ){
dan165921a2009-08-28 18:53:45 +00005955 /* SubProgram.nMem is set to the number of memory cells used by the
5956 ** program stored in SubProgram.aOp. As well as these, one memory
5957 ** cell is required for each cursor used by the program. Set local
5958 ** variable nMem (and later, VdbeFrame.nChildMem) to this value.
5959 */
dan65a7cd12009-09-01 12:16:01 +00005960 nMem = pProgram->nMem + pProgram->nCsr;
drh3cdce922016-03-21 00:30:40 +00005961 assert( nMem>0 );
5962 if( pProgram->nCsr==0 ) nMem++;
dan65a7cd12009-09-01 12:16:01 +00005963 nByte = ROUND8(sizeof(VdbeFrame))
dan165921a2009-08-28 18:53:45 +00005964 + nMem * sizeof(Mem)
drhab087d42017-03-24 17:59:56 +00005965 + pProgram->nCsr * sizeof(VdbeCursor*)
5966 + (pProgram->nOp + 7)/8;
dan165921a2009-08-28 18:53:45 +00005967 pFrame = sqlite3DbMallocZero(db, nByte);
5968 if( !pFrame ){
5969 goto no_mem;
5970 }
5971 sqlite3VdbeMemRelease(pRt);
5972 pRt->flags = MEM_Frame;
5973 pRt->u.pFrame = pFrame;
5974
5975 pFrame->v = p;
5976 pFrame->nChildMem = nMem;
5977 pFrame->nChildCsr = pProgram->nCsr;
drhf56fa462015-04-13 21:39:54 +00005978 pFrame->pc = (int)(pOp - aOp);
dan165921a2009-08-28 18:53:45 +00005979 pFrame->aMem = p->aMem;
5980 pFrame->nMem = p->nMem;
5981 pFrame->apCsr = p->apCsr;
5982 pFrame->nCursor = p->nCursor;
5983 pFrame->aOp = p->aOp;
5984 pFrame->nOp = p->nOp;
5985 pFrame->token = pProgram->token;
dane2f771b2014-11-03 15:33:17 +00005986#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00005987 pFrame->anExec = p->anExec;
dane2f771b2014-11-03 15:33:17 +00005988#endif
dan165921a2009-08-28 18:53:45 +00005989
5990 pEnd = &VdbeFrameMem(pFrame)[pFrame->nChildMem];
5991 for(pMem=VdbeFrameMem(pFrame); pMem!=pEnd; pMem++){
drha5750cf2014-02-07 13:20:31 +00005992 pMem->flags = MEM_Undefined;
dan165921a2009-08-28 18:53:45 +00005993 pMem->db = db;
5994 }
5995 }else{
5996 pFrame = pRt->u.pFrame;
drh9f6168b2016-03-19 23:32:58 +00005997 assert( pProgram->nMem+pProgram->nCsr==pFrame->nChildMem
5998 || (pProgram->nCsr==0 && pProgram->nMem+1==pFrame->nChildMem) );
dan165921a2009-08-28 18:53:45 +00005999 assert( pProgram->nCsr==pFrame->nChildCsr );
drhf56fa462015-04-13 21:39:54 +00006000 assert( (int)(pOp - aOp)==pFrame->pc );
dan165921a2009-08-28 18:53:45 +00006001 }
6002
6003 p->nFrame++;
6004 pFrame->pParent = p->pFrame;
drhfae58d52017-01-26 17:26:44 +00006005 pFrame->lastRowid = db->lastRowid;
dan76d462e2009-08-30 11:42:51 +00006006 pFrame->nChange = p->nChange;
danc3da6672014-10-28 18:24:16 +00006007 pFrame->nDbChange = p->db->nChange;
dan32001322016-02-19 18:54:29 +00006008 assert( pFrame->pAuxData==0 );
6009 pFrame->pAuxData = p->pAuxData;
6010 p->pAuxData = 0;
dan2832ad42009-08-31 15:27:27 +00006011 p->nChange = 0;
dan165921a2009-08-28 18:53:45 +00006012 p->pFrame = pFrame;
drh9f6168b2016-03-19 23:32:58 +00006013 p->aMem = aMem = VdbeFrameMem(pFrame);
dan165921a2009-08-28 18:53:45 +00006014 p->nMem = pFrame->nChildMem;
shanecea72b22009-09-07 04:38:36 +00006015 p->nCursor = (u16)pFrame->nChildCsr;
drh9f6168b2016-03-19 23:32:58 +00006016 p->apCsr = (VdbeCursor **)&aMem[p->nMem];
drhab087d42017-03-24 17:59:56 +00006017 pFrame->aOnce = (u8*)&p->apCsr[pProgram->nCsr];
drh18333ef2017-03-24 18:38:41 +00006018 memset(pFrame->aOnce, 0, (pProgram->nOp + 7)/8);
drhbbe879d2009-11-14 18:04:35 +00006019 p->aOp = aOp = pProgram->aOp;
dan165921a2009-08-28 18:53:45 +00006020 p->nOp = pProgram->nOp;
dane2f771b2014-11-03 15:33:17 +00006021#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00006022 p->anExec = 0;
dane2f771b2014-11-03 15:33:17 +00006023#endif
drhf56fa462015-04-13 21:39:54 +00006024 pOp = &aOp[-1];
dan165921a2009-08-28 18:53:45 +00006025
6026 break;
6027}
6028
dan76d462e2009-08-30 11:42:51 +00006029/* Opcode: Param P1 P2 * * *
dan165921a2009-08-28 18:53:45 +00006030**
dan76d462e2009-08-30 11:42:51 +00006031** This opcode is only ever present in sub-programs called via the
6032** OP_Program instruction. Copy a value currently stored in a memory
6033** cell of the calling (parent) frame to cell P2 in the current frames
6034** address space. This is used by trigger programs to access the new.*
6035** and old.* values.
dan165921a2009-08-28 18:53:45 +00006036**
dan76d462e2009-08-30 11:42:51 +00006037** The address of the cell in the parent frame is determined by adding
6038** the value of the P1 argument to the value of the P1 argument to the
6039** calling OP_Program instruction.
dan165921a2009-08-28 18:53:45 +00006040*/
drh27a348c2015-04-13 19:14:06 +00006041case OP_Param: { /* out2 */
dan65a7cd12009-09-01 12:16:01 +00006042 VdbeFrame *pFrame;
6043 Mem *pIn;
drh27a348c2015-04-13 19:14:06 +00006044 pOut = out2Prerelease(p, pOp);
dan65a7cd12009-09-01 12:16:01 +00006045 pFrame = p->pFrame;
6046 pIn = &pFrame->aMem[pOp->p1 + pFrame->aOp[pFrame->pc].p1];
dan165921a2009-08-28 18:53:45 +00006047 sqlite3VdbeMemShallowCopy(pOut, pIn, MEM_Ephem);
6048 break;
6049}
6050
danielk197793758c82005-01-21 08:13:14 +00006051#endif /* #ifndef SQLITE_OMIT_TRIGGER */
rdcb0c374f2004-02-20 22:53:38 +00006052
dan1da40a32009-09-19 17:00:31 +00006053#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00006054/* Opcode: FkCounter P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00006055** Synopsis: fkctr[P1]+=P2
dan1da40a32009-09-19 17:00:31 +00006056**
dan0ff297e2009-09-25 17:03:14 +00006057** Increment a "constraint counter" by P2 (P2 may be negative or positive).
6058** If P1 is non-zero, the database constraint counter is incremented
6059** (deferred foreign key constraints). Otherwise, if P1 is zero, the
dan32b09f22009-09-23 17:29:59 +00006060** statement counter is incremented (immediate foreign key constraints).
dan1da40a32009-09-19 17:00:31 +00006061*/
dan32b09f22009-09-23 17:29:59 +00006062case OP_FkCounter: {
drh963c74d2013-07-11 12:19:12 +00006063 if( db->flags & SQLITE_DeferFKs ){
dancb3e4b72013-07-03 19:53:05 +00006064 db->nDeferredImmCons += pOp->p2;
6065 }else if( pOp->p1 ){
dan0ff297e2009-09-25 17:03:14 +00006066 db->nDeferredCons += pOp->p2;
dan32b09f22009-09-23 17:29:59 +00006067 }else{
dan0ff297e2009-09-25 17:03:14 +00006068 p->nFkConstraint += pOp->p2;
6069 }
6070 break;
6071}
6072
6073/* Opcode: FkIfZero P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00006074** Synopsis: if fkctr[P1]==0 goto P2
dan0ff297e2009-09-25 17:03:14 +00006075**
6076** This opcode tests if a foreign key constraint-counter is currently zero.
6077** If so, jump to instruction P2. Otherwise, fall through to the next
6078** instruction.
6079**
6080** If P1 is non-zero, then the jump is taken if the database constraint-counter
6081** is zero (the one that counts deferred constraint violations). If P1 is
6082** zero, the jump is taken if the statement constraint-counter is zero
6083** (immediate foreign key constraint violations).
6084*/
6085case OP_FkIfZero: { /* jump */
6086 if( pOp->p1 ){
drh688852a2014-02-17 22:40:43 +00006087 VdbeBranchTaken(db->nDeferredCons==0 && db->nDeferredImmCons==0, 2);
drhf56fa462015-04-13 21:39:54 +00006088 if( db->nDeferredCons==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
dan0ff297e2009-09-25 17:03:14 +00006089 }else{
drh688852a2014-02-17 22:40:43 +00006090 VdbeBranchTaken(p->nFkConstraint==0 && db->nDeferredImmCons==0, 2);
drhf56fa462015-04-13 21:39:54 +00006091 if( p->nFkConstraint==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
dan32b09f22009-09-23 17:29:59 +00006092 }
dan1da40a32009-09-19 17:00:31 +00006093 break;
6094}
6095#endif /* #ifndef SQLITE_OMIT_FOREIGN_KEY */
6096
drh205f48e2004-11-05 00:43:11 +00006097#ifndef SQLITE_OMIT_AUTOINCREMENT
drh98757152008-01-09 23:04:12 +00006098/* Opcode: MemMax P1 P2 * * *
drh81316f82013-10-29 20:40:47 +00006099** Synopsis: r[P1]=max(r[P1],r[P2])
drh205f48e2004-11-05 00:43:11 +00006100**
dan76d462e2009-08-30 11:42:51 +00006101** P1 is a register in the root frame of this VM (the root frame is
6102** different from the current frame if this instruction is being executed
6103** within a sub-program). Set the value of register P1 to the maximum of
6104** its current value and the value in register P2.
drh205f48e2004-11-05 00:43:11 +00006105**
6106** This instruction throws an error if the memory cell is not initially
6107** an integer.
6108*/
dan76d462e2009-08-30 11:42:51 +00006109case OP_MemMax: { /* in2 */
dan76d462e2009-08-30 11:42:51 +00006110 VdbeFrame *pFrame;
6111 if( p->pFrame ){
6112 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
6113 pIn1 = &pFrame->aMem[pOp->p1];
6114 }else{
drha6c2ed92009-11-14 23:22:23 +00006115 pIn1 = &aMem[pOp->p1];
dan76d462e2009-08-30 11:42:51 +00006116 }
drh2b4ded92010-09-27 21:09:31 +00006117 assert( memIsValid(pIn1) );
drh98757152008-01-09 23:04:12 +00006118 sqlite3VdbeMemIntegerify(pIn1);
drh3c657212009-11-17 23:59:58 +00006119 pIn2 = &aMem[pOp->p2];
drh98757152008-01-09 23:04:12 +00006120 sqlite3VdbeMemIntegerify(pIn2);
6121 if( pIn1->u.i<pIn2->u.i){
6122 pIn1->u.i = pIn2->u.i;
drh205f48e2004-11-05 00:43:11 +00006123 }
6124 break;
6125}
6126#endif /* SQLITE_OMIT_AUTOINCREMENT */
6127
drh8b0cf382015-10-06 21:07:06 +00006128/* Opcode: IfPos P1 P2 P3 * *
6129** Synopsis: if r[P1]>0 then r[P1]-=P3, goto P2
danielk1977a2dc3b12005-02-05 12:48:48 +00006130**
drh16897072015-03-07 00:57:37 +00006131** Register P1 must contain an integer.
mistachkin91a3ecb2015-10-06 21:49:55 +00006132** If the value of register P1 is 1 or greater, subtract P3 from the
drh8b0cf382015-10-06 21:07:06 +00006133** value in P1 and jump to P2.
drh6f58f702006-01-08 05:26:41 +00006134**
drh16897072015-03-07 00:57:37 +00006135** If the initial value of register P1 is less than 1, then the
6136** value is unchanged and control passes through to the next instruction.
danielk1977a2dc3b12005-02-05 12:48:48 +00006137*/
drh9cbf3422008-01-17 16:22:13 +00006138case OP_IfPos: { /* jump, in1 */
drh3c657212009-11-17 23:59:58 +00006139 pIn1 = &aMem[pOp->p1];
danielk1977a7a8e142008-02-13 18:25:27 +00006140 assert( pIn1->flags&MEM_Int );
drh688852a2014-02-17 22:40:43 +00006141 VdbeBranchTaken( pIn1->u.i>0, 2);
drh8b0cf382015-10-06 21:07:06 +00006142 if( pIn1->u.i>0 ){
6143 pIn1->u.i -= pOp->p3;
6144 goto jump_to_p2;
6145 }
drhec7429a2005-10-06 16:53:14 +00006146 break;
6147}
6148
drhcc2fa4c2016-01-25 15:57:29 +00006149/* Opcode: OffsetLimit P1 P2 P3 * *
6150** Synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)
drh15007a92006-01-08 18:10:17 +00006151**
drhcc2fa4c2016-01-25 15:57:29 +00006152** This opcode performs a commonly used computation associated with
6153** LIMIT and OFFSET process. r[P1] holds the limit counter. r[P3]
6154** holds the offset counter. The opcode computes the combined value
6155** of the LIMIT and OFFSET and stores that value in r[P2]. The r[P2]
6156** value computed is the total number of rows that will need to be
6157** visited in order to complete the query.
6158**
6159** If r[P3] is zero or negative, that means there is no OFFSET
6160** and r[P2] is set to be the value of the LIMIT, r[P1].
6161**
6162** if r[P1] is zero or negative, that means there is no LIMIT
6163** and r[P2] is set to -1.
6164**
6165** Otherwise, r[P2] is set to the sum of r[P1] and r[P3].
drh15007a92006-01-08 18:10:17 +00006166*/
drhcc2fa4c2016-01-25 15:57:29 +00006167case OP_OffsetLimit: { /* in1, out2, in3 */
drh719da302016-12-10 04:06:49 +00006168 i64 x;
drh3c657212009-11-17 23:59:58 +00006169 pIn1 = &aMem[pOp->p1];
drhcc2fa4c2016-01-25 15:57:29 +00006170 pIn3 = &aMem[pOp->p3];
6171 pOut = out2Prerelease(p, pOp);
6172 assert( pIn1->flags & MEM_Int );
6173 assert( pIn3->flags & MEM_Int );
drh719da302016-12-10 04:06:49 +00006174 x = pIn1->u.i;
6175 if( x<=0 || sqlite3AddInt64(&x, pIn3->u.i>0?pIn3->u.i:0) ){
6176 /* If the LIMIT is less than or equal to zero, loop forever. This
6177 ** is documented. But also, if the LIMIT+OFFSET exceeds 2^63 then
6178 ** also loop forever. This is undocumented. In fact, one could argue
6179 ** that the loop should terminate. But assuming 1 billion iterations
6180 ** per second (far exceeding the capabilities of any current hardware)
6181 ** it would take nearly 300 years to actually reach the limit. So
6182 ** looping forever is a reasonable approximation. */
6183 pOut->u.i = -1;
6184 }else{
6185 pOut->u.i = x;
6186 }
drh15007a92006-01-08 18:10:17 +00006187 break;
6188}
6189
drhf99dd352016-12-18 17:42:00 +00006190/* Opcode: IfNotZero P1 P2 * * *
6191** Synopsis: if r[P1]!=0 then r[P1]--, goto P2
drhec7429a2005-10-06 16:53:14 +00006192**
drh16897072015-03-07 00:57:37 +00006193** Register P1 must contain an integer. If the content of register P1 is
drhf99dd352016-12-18 17:42:00 +00006194** initially greater than zero, then decrement the value in register P1.
6195** If it is non-zero (negative or positive) and then also jump to P2.
6196** If register P1 is initially zero, leave it unchanged and fall through.
drhec7429a2005-10-06 16:53:14 +00006197*/
drh16897072015-03-07 00:57:37 +00006198case OP_IfNotZero: { /* jump, in1 */
drh3c657212009-11-17 23:59:58 +00006199 pIn1 = &aMem[pOp->p1];
danielk1977a7a8e142008-02-13 18:25:27 +00006200 assert( pIn1->flags&MEM_Int );
drh16897072015-03-07 00:57:37 +00006201 VdbeBranchTaken(pIn1->u.i<0, 2);
6202 if( pIn1->u.i ){
drhf99dd352016-12-18 17:42:00 +00006203 if( pIn1->u.i>0 ) pIn1->u.i--;
drhf56fa462015-04-13 21:39:54 +00006204 goto jump_to_p2;
drh16897072015-03-07 00:57:37 +00006205 }
6206 break;
6207}
6208
6209/* Opcode: DecrJumpZero P1 P2 * * *
6210** Synopsis: if (--r[P1])==0 goto P2
6211**
drhab5be2e2016-11-30 05:08:59 +00006212** Register P1 must hold an integer. Decrement the value in P1
6213** and jump to P2 if the new value is exactly zero.
drh16897072015-03-07 00:57:37 +00006214*/
6215case OP_DecrJumpZero: { /* jump, in1 */
6216 pIn1 = &aMem[pOp->p1];
6217 assert( pIn1->flags&MEM_Int );
drhab5be2e2016-11-30 05:08:59 +00006218 if( pIn1->u.i>SMALLEST_INT64 ) pIn1->u.i--;
6219 VdbeBranchTaken(pIn1->u.i==0, 2);
6220 if( pIn1->u.i==0 ) goto jump_to_p2;
drha2a49dc2008-01-02 14:28:13 +00006221 break;
6222}
6223
drh16897072015-03-07 00:57:37 +00006224
drhe2d9e7c2015-06-26 18:47:53 +00006225/* Opcode: AggStep0 * P2 P3 P4 P5
drhf63552b2013-10-30 00:25:03 +00006226** Synopsis: accum=r[P3] step(r[P2@P5])
drhe5095352002-02-24 03:25:14 +00006227**
drh0bce8352002-02-28 00:41:10 +00006228** Execute the step function for an aggregate. The
drh98757152008-01-09 23:04:12 +00006229** function has P5 arguments. P4 is a pointer to the FuncDef
drhe2d9e7c2015-06-26 18:47:53 +00006230** structure that specifies the function. Register P3 is the
6231** accumulator.
drhe5095352002-02-24 03:25:14 +00006232**
drh98757152008-01-09 23:04:12 +00006233** The P5 arguments are taken from register P2 and its
6234** successors.
drhe5095352002-02-24 03:25:14 +00006235*/
drhe2d9e7c2015-06-26 18:47:53 +00006236/* Opcode: AggStep * P2 P3 P4 P5
6237** Synopsis: accum=r[P3] step(r[P2@P5])
6238**
6239** Execute the step function for an aggregate. The
6240** function has P5 arguments. P4 is a pointer to an sqlite3_context
6241** object that is used to run the function. Register P3 is
6242** as the accumulator.
6243**
6244** The P5 arguments are taken from register P2 and its
6245** successors.
6246**
6247** This opcode is initially coded as OP_AggStep0. On first evaluation,
6248** the FuncDef stored in P4 is converted into an sqlite3_context and
6249** the opcode is changed. In this way, the initialization of the
6250** sqlite3_context only happens once, instead of on each call to the
6251** step function.
6252*/
drh9c7c9132015-06-26 18:16:52 +00006253case OP_AggStep0: {
drh856c1032009-06-02 15:21:42 +00006254 int n;
drh9c7c9132015-06-26 18:16:52 +00006255 sqlite3_context *pCtx;
drhe5095352002-02-24 03:25:14 +00006256
drh9c7c9132015-06-26 18:16:52 +00006257 assert( pOp->p4type==P4_FUNCDEF );
drh856c1032009-06-02 15:21:42 +00006258 n = pOp->p5;
drh9f6168b2016-03-19 23:32:58 +00006259 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
6260 assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
drh9c7c9132015-06-26 18:16:52 +00006261 assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
drh575fad62016-02-05 13:38:36 +00006262 pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
drh9c7c9132015-06-26 18:16:52 +00006263 if( pCtx==0 ) goto no_mem;
6264 pCtx->pMem = 0;
6265 pCtx->pFunc = pOp->p4.pFunc;
6266 pCtx->iOp = (int)(pOp - aOp);
6267 pCtx->pVdbe = p;
6268 pCtx->argc = n;
6269 pOp->p4type = P4_FUNCCTX;
6270 pOp->p4.pCtx = pCtx;
6271 pOp->opcode = OP_AggStep;
6272 /* Fall through into OP_AggStep */
6273}
6274case OP_AggStep: {
6275 int i;
6276 sqlite3_context *pCtx;
6277 Mem *pMem;
6278 Mem t;
6279
6280 assert( pOp->p4type==P4_FUNCCTX );
6281 pCtx = pOp->p4.pCtx;
6282 pMem = &aMem[pOp->p3];
6283
6284 /* If this function is inside of a trigger, the register array in aMem[]
6285 ** might change from one evaluation to the next. The next block of code
6286 ** checks to see if the register array has changed, and if so it
6287 ** reinitializes the relavant parts of the sqlite3_context object */
6288 if( pCtx->pMem != pMem ){
6289 pCtx->pMem = pMem;
6290 for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
6291 }
6292
6293#ifdef SQLITE_DEBUG
6294 for(i=0; i<pCtx->argc; i++){
6295 assert( memIsValid(pCtx->argv[i]) );
6296 REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
6297 }
6298#endif
6299
drhabfcea22005-09-06 20:36:48 +00006300 pMem->n++;
drhd3b74202014-09-17 16:41:15 +00006301 sqlite3VdbeMemInit(&t, db, MEM_Null);
drh9c7c9132015-06-26 18:16:52 +00006302 pCtx->pOut = &t;
6303 pCtx->fErrorOrAux = 0;
6304 pCtx->skipFlag = 0;
drh2d801512016-01-14 22:19:58 +00006305 (pCtx->pFunc->xSFunc)(pCtx,pCtx->argc,pCtx->argv); /* IMP: R-24505-23230 */
drh9c7c9132015-06-26 18:16:52 +00006306 if( pCtx->fErrorOrAux ){
6307 if( pCtx->isError ){
6308 sqlite3VdbeError(p, "%s", sqlite3_value_text(&t));
6309 rc = pCtx->isError;
6310 }
6311 sqlite3VdbeMemRelease(&t);
drh9467abf2016-02-17 18:44:11 +00006312 if( rc ) goto abort_due_to_error;
drh9c7c9132015-06-26 18:16:52 +00006313 }else{
6314 assert( t.flags==MEM_Null );
drh1350b032002-02-27 19:00:20 +00006315 }
drh9c7c9132015-06-26 18:16:52 +00006316 if( pCtx->skipFlag ){
drh7a957892012-02-02 17:35:43 +00006317 assert( pOp[-1].opcode==OP_CollSeq );
6318 i = pOp[-1].p1;
6319 if( i ) sqlite3VdbeMemSetInt64(&aMem[i], 1);
6320 }
drh5e00f6c2001-09-13 13:46:56 +00006321 break;
6322}
6323
drh98757152008-01-09 23:04:12 +00006324/* Opcode: AggFinal P1 P2 * P4 *
drh81316f82013-10-29 20:40:47 +00006325** Synopsis: accum=r[P1] N=P2
drh5e00f6c2001-09-13 13:46:56 +00006326**
drh13449892005-09-07 21:22:45 +00006327** Execute the finalizer function for an aggregate. P1 is
6328** the memory location that is the accumulator for the aggregate.
drha10a34b2005-09-07 22:09:48 +00006329**
6330** P2 is the number of arguments that the step function takes and
drh66a51672008-01-03 00:01:23 +00006331** P4 is a pointer to the FuncDef for this function. The P2
drha10a34b2005-09-07 22:09:48 +00006332** argument is not used by this opcode. It is only there to disambiguate
6333** functions that can take varying numbers of arguments. The
drh66a51672008-01-03 00:01:23 +00006334** P4 argument is only needed for the degenerate case where
drha10a34b2005-09-07 22:09:48 +00006335** the step function was not previously called.
drh5e00f6c2001-09-13 13:46:56 +00006336*/
drh9cbf3422008-01-17 16:22:13 +00006337case OP_AggFinal: {
drh13449892005-09-07 21:22:45 +00006338 Mem *pMem;
drh9f6168b2016-03-19 23:32:58 +00006339 assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
drha6c2ed92009-11-14 23:22:23 +00006340 pMem = &aMem[pOp->p1];
drha10a34b2005-09-07 22:09:48 +00006341 assert( (pMem->flags & ~(MEM_Null|MEM_Agg))==0 );
danielk19772dca4ac2008-01-03 11:50:29 +00006342 rc = sqlite3VdbeMemFinalize(pMem, pOp->p4.pFunc);
drh4c8555f2009-06-25 01:47:11 +00006343 if( rc ){
drh22c17b82015-05-15 04:13:15 +00006344 sqlite3VdbeError(p, "%s", sqlite3_value_text(pMem));
drh9467abf2016-02-17 18:44:11 +00006345 goto abort_due_to_error;
drh90669c12006-01-20 15:45:36 +00006346 }
drh2dca8682008-03-21 17:13:13 +00006347 sqlite3VdbeChangeEncoding(pMem, encoding);
drhb7654112008-01-12 12:48:07 +00006348 UPDATE_MAX_BLOBSIZE(pMem);
drh023ae032007-05-08 12:12:16 +00006349 if( sqlite3VdbeMemTooBig(pMem) ){
6350 goto too_big;
6351 }
drh5e00f6c2001-09-13 13:46:56 +00006352 break;
6353}
6354
dan5cf53532010-05-01 16:40:20 +00006355#ifndef SQLITE_OMIT_WAL
dancdc1f042010-11-18 12:11:05 +00006356/* Opcode: Checkpoint P1 P2 P3 * *
dane04dc882010-04-20 18:53:15 +00006357**
6358** Checkpoint database P1. This is a no-op if P1 is not currently in
drha25165f2014-12-04 04:50:59 +00006359** WAL mode. Parameter P2 is one of SQLITE_CHECKPOINT_PASSIVE, FULL,
6360** RESTART, or TRUNCATE. Write 1 or 0 into mem[P3] if the checkpoint returns
drh30aa3b92011-02-07 23:56:01 +00006361** SQLITE_BUSY or not, respectively. Write the number of pages in the
6362** WAL after the checkpoint into mem[P3+1] and the number of pages
6363** in the WAL that have been checkpointed after the checkpoint
6364** completes into mem[P3+2]. However on an error, mem[P3+1] and
6365** mem[P3+2] are initialized to -1.
dan7c246102010-04-12 19:00:29 +00006366*/
6367case OP_Checkpoint: {
drh30aa3b92011-02-07 23:56:01 +00006368 int i; /* Loop counter */
6369 int aRes[3]; /* Results */
6370 Mem *pMem; /* Write results here */
6371
drh9e92a472013-06-27 17:40:30 +00006372 assert( p->readOnly==0 );
drh30aa3b92011-02-07 23:56:01 +00006373 aRes[0] = 0;
6374 aRes[1] = aRes[2] = -1;
dancdc1f042010-11-18 12:11:05 +00006375 assert( pOp->p2==SQLITE_CHECKPOINT_PASSIVE
6376 || pOp->p2==SQLITE_CHECKPOINT_FULL
6377 || pOp->p2==SQLITE_CHECKPOINT_RESTART
danf26a1542014-12-02 19:04:54 +00006378 || pOp->p2==SQLITE_CHECKPOINT_TRUNCATE
dancdc1f042010-11-18 12:11:05 +00006379 );
drh30aa3b92011-02-07 23:56:01 +00006380 rc = sqlite3Checkpoint(db, pOp->p1, pOp->p2, &aRes[1], &aRes[2]);
drh9467abf2016-02-17 18:44:11 +00006381 if( rc ){
6382 if( rc!=SQLITE_BUSY ) goto abort_due_to_error;
dancdc1f042010-11-18 12:11:05 +00006383 rc = SQLITE_OK;
drh30aa3b92011-02-07 23:56:01 +00006384 aRes[0] = 1;
dancdc1f042010-11-18 12:11:05 +00006385 }
drh30aa3b92011-02-07 23:56:01 +00006386 for(i=0, pMem = &aMem[pOp->p3]; i<3; i++, pMem++){
6387 sqlite3VdbeMemSetInt64(pMem, (i64)aRes[i]);
6388 }
dan7c246102010-04-12 19:00:29 +00006389 break;
6390};
dan5cf53532010-05-01 16:40:20 +00006391#endif
drh5e00f6c2001-09-13 13:46:56 +00006392
drhcac29a62010-07-02 19:36:52 +00006393#ifndef SQLITE_OMIT_PRAGMA
drh0fd61352014-02-07 02:29:45 +00006394/* Opcode: JournalMode P1 P2 P3 * *
dane04dc882010-04-20 18:53:15 +00006395**
6396** Change the journal mode of database P1 to P3. P3 must be one of the
6397** PAGER_JOURNALMODE_XXX values. If changing between the various rollback
6398** modes (delete, truncate, persist, off and memory), this is a simple
6399** operation. No IO is required.
6400**
6401** If changing into or out of WAL mode the procedure is more complicated.
6402**
6403** Write a string containing the final journal-mode to register P2.
6404*/
drh27a348c2015-04-13 19:14:06 +00006405case OP_JournalMode: { /* out2 */
dane04dc882010-04-20 18:53:15 +00006406 Btree *pBt; /* Btree to change journal mode of */
6407 Pager *pPager; /* Pager associated with pBt */
drhd80b2332010-05-01 00:59:37 +00006408 int eNew; /* New journal mode */
6409 int eOld; /* The old journal mode */
mistachkin59ee77c2012-09-13 15:26:44 +00006410#ifndef SQLITE_OMIT_WAL
drhd80b2332010-05-01 00:59:37 +00006411 const char *zFilename; /* Name of database file for pPager */
mistachkin59ee77c2012-09-13 15:26:44 +00006412#endif
dane04dc882010-04-20 18:53:15 +00006413
drh27a348c2015-04-13 19:14:06 +00006414 pOut = out2Prerelease(p, pOp);
drhd80b2332010-05-01 00:59:37 +00006415 eNew = pOp->p3;
dane04dc882010-04-20 18:53:15 +00006416 assert( eNew==PAGER_JOURNALMODE_DELETE
6417 || eNew==PAGER_JOURNALMODE_TRUNCATE
6418 || eNew==PAGER_JOURNALMODE_PERSIST
6419 || eNew==PAGER_JOURNALMODE_OFF
6420 || eNew==PAGER_JOURNALMODE_MEMORY
6421 || eNew==PAGER_JOURNALMODE_WAL
6422 || eNew==PAGER_JOURNALMODE_QUERY
6423 );
6424 assert( pOp->p1>=0 && pOp->p1<db->nDb );
drh9e92a472013-06-27 17:40:30 +00006425 assert( p->readOnly==0 );
drh3ebaee92010-05-06 21:37:22 +00006426
dane04dc882010-04-20 18:53:15 +00006427 pBt = db->aDb[pOp->p1].pBt;
6428 pPager = sqlite3BtreePager(pBt);
drh0b9b4302010-06-11 17:01:24 +00006429 eOld = sqlite3PagerGetJournalMode(pPager);
6430 if( eNew==PAGER_JOURNALMODE_QUERY ) eNew = eOld;
6431 if( !sqlite3PagerOkToChangeJournalMode(pPager) ) eNew = eOld;
dan5cf53532010-05-01 16:40:20 +00006432
6433#ifndef SQLITE_OMIT_WAL
drhd4e0bb02012-05-27 01:19:04 +00006434 zFilename = sqlite3PagerFilename(pPager, 1);
dane04dc882010-04-20 18:53:15 +00006435
drhd80b2332010-05-01 00:59:37 +00006436 /* Do not allow a transition to journal_mode=WAL for a database
drh6e1f4822010-07-13 23:41:40 +00006437 ** in temporary storage or if the VFS does not support shared memory
drhd80b2332010-05-01 00:59:37 +00006438 */
6439 if( eNew==PAGER_JOURNALMODE_WAL
drh057fc812011-10-17 23:15:31 +00006440 && (sqlite3Strlen30(zFilename)==0 /* Temp file */
drh6e1f4822010-07-13 23:41:40 +00006441 || !sqlite3PagerWalSupported(pPager)) /* No shared-memory support */
dane180c292010-04-26 17:42:56 +00006442 ){
drh0b9b4302010-06-11 17:01:24 +00006443 eNew = eOld;
dane180c292010-04-26 17:42:56 +00006444 }
6445
drh0b9b4302010-06-11 17:01:24 +00006446 if( (eNew!=eOld)
6447 && (eOld==PAGER_JOURNALMODE_WAL || eNew==PAGER_JOURNALMODE_WAL)
6448 ){
danc0537fe2013-06-28 19:41:43 +00006449 if( !db->autoCommit || db->nVdbeRead>1 ){
drh0b9b4302010-06-11 17:01:24 +00006450 rc = SQLITE_ERROR;
drh22c17b82015-05-15 04:13:15 +00006451 sqlite3VdbeError(p,
drh0b9b4302010-06-11 17:01:24 +00006452 "cannot change %s wal mode from within a transaction",
6453 (eNew==PAGER_JOURNALMODE_WAL ? "into" : "out of")
6454 );
drh9467abf2016-02-17 18:44:11 +00006455 goto abort_due_to_error;
drh0b9b4302010-06-11 17:01:24 +00006456 }else{
6457
6458 if( eOld==PAGER_JOURNALMODE_WAL ){
6459 /* If leaving WAL mode, close the log file. If successful, the call
6460 ** to PagerCloseWal() checkpoints and deletes the write-ahead-log
6461 ** file. An EXCLUSIVE lock may still be held on the database file
6462 ** after a successful return.
dane04dc882010-04-20 18:53:15 +00006463 */
dan7fb89902016-08-12 16:21:15 +00006464 rc = sqlite3PagerCloseWal(pPager, db);
drhab9b7442010-05-10 11:20:05 +00006465 if( rc==SQLITE_OK ){
drh0b9b4302010-06-11 17:01:24 +00006466 sqlite3PagerSetJournalMode(pPager, eNew);
drh89c3f2f2010-05-15 01:09:38 +00006467 }
drh242c4f72010-06-22 14:49:39 +00006468 }else if( eOld==PAGER_JOURNALMODE_MEMORY ){
6469 /* Cannot transition directly from MEMORY to WAL. Use mode OFF
6470 ** as an intermediate */
6471 sqlite3PagerSetJournalMode(pPager, PAGER_JOURNALMODE_OFF);
drh0b9b4302010-06-11 17:01:24 +00006472 }
6473
6474 /* Open a transaction on the database file. Regardless of the journal
6475 ** mode, this transaction always uses a rollback journal.
6476 */
6477 assert( sqlite3BtreeIsInTrans(pBt)==0 );
6478 if( rc==SQLITE_OK ){
dan731bf5b2010-06-17 16:44:21 +00006479 rc = sqlite3BtreeSetVersion(pBt, (eNew==PAGER_JOURNALMODE_WAL ? 2 : 1));
dane04dc882010-04-20 18:53:15 +00006480 }
6481 }
6482 }
dan5cf53532010-05-01 16:40:20 +00006483#endif /* ifndef SQLITE_OMIT_WAL */
dane04dc882010-04-20 18:53:15 +00006484
drh9467abf2016-02-17 18:44:11 +00006485 if( rc ) eNew = eOld;
drh0b9b4302010-06-11 17:01:24 +00006486 eNew = sqlite3PagerSetJournalMode(pPager, eNew);
dan731bf5b2010-06-17 16:44:21 +00006487
dane04dc882010-04-20 18:53:15 +00006488 pOut->flags = MEM_Str|MEM_Static|MEM_Term;
danb9780022010-04-21 18:37:57 +00006489 pOut->z = (char *)sqlite3JournalModename(eNew);
dane04dc882010-04-20 18:53:15 +00006490 pOut->n = sqlite3Strlen30(pOut->z);
6491 pOut->enc = SQLITE_UTF8;
6492 sqlite3VdbeChangeEncoding(pOut, encoding);
drh9467abf2016-02-17 18:44:11 +00006493 if( rc ) goto abort_due_to_error;
dane04dc882010-04-20 18:53:15 +00006494 break;
drhcac29a62010-07-02 19:36:52 +00006495};
6496#endif /* SQLITE_OMIT_PRAGMA */
dane04dc882010-04-20 18:53:15 +00006497
drhfdbcdee2007-03-27 14:44:50 +00006498#if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
drh9ef5e772016-08-19 14:20:56 +00006499/* Opcode: Vacuum P1 * * * *
drh6f8c91c2003-12-07 00:24:35 +00006500**
drh9ef5e772016-08-19 14:20:56 +00006501** Vacuum the entire database P1. P1 is 0 for "main", and 2 or more
6502** for an attached database. The "temp" database may not be vacuumed.
drh6f8c91c2003-12-07 00:24:35 +00006503*/
drh9cbf3422008-01-17 16:22:13 +00006504case OP_Vacuum: {
drh9e92a472013-06-27 17:40:30 +00006505 assert( p->readOnly==0 );
drh9ef5e772016-08-19 14:20:56 +00006506 rc = sqlite3RunVacuum(&p->zErrMsg, db, pOp->p1);
drh9467abf2016-02-17 18:44:11 +00006507 if( rc ) goto abort_due_to_error;
drh6f8c91c2003-12-07 00:24:35 +00006508 break;
6509}
drh154d4b22006-09-21 11:02:16 +00006510#endif
drh6f8c91c2003-12-07 00:24:35 +00006511
danielk1977dddbcdc2007-04-26 14:42:34 +00006512#if !defined(SQLITE_OMIT_AUTOVACUUM)
drh98757152008-01-09 23:04:12 +00006513/* Opcode: IncrVacuum P1 P2 * * *
danielk1977dddbcdc2007-04-26 14:42:34 +00006514**
6515** Perform a single step of the incremental vacuum procedure on
drhca5557f2007-05-04 18:30:40 +00006516** the P1 database. If the vacuum has finished, jump to instruction
danielk1977dddbcdc2007-04-26 14:42:34 +00006517** P2. Otherwise, fall through to the next instruction.
6518*/
drh9cbf3422008-01-17 16:22:13 +00006519case OP_IncrVacuum: { /* jump */
drhca5557f2007-05-04 18:30:40 +00006520 Btree *pBt;
6521
6522 assert( pOp->p1>=0 && pOp->p1<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00006523 assert( DbMaskTest(p->btreeMask, pOp->p1) );
drh9e92a472013-06-27 17:40:30 +00006524 assert( p->readOnly==0 );
drhca5557f2007-05-04 18:30:40 +00006525 pBt = db->aDb[pOp->p1].pBt;
danielk1977dddbcdc2007-04-26 14:42:34 +00006526 rc = sqlite3BtreeIncrVacuum(pBt);
drh688852a2014-02-17 22:40:43 +00006527 VdbeBranchTaken(rc==SQLITE_DONE,2);
drh9467abf2016-02-17 18:44:11 +00006528 if( rc ){
6529 if( rc!=SQLITE_DONE ) goto abort_due_to_error;
danielk1977dddbcdc2007-04-26 14:42:34 +00006530 rc = SQLITE_OK;
drhf56fa462015-04-13 21:39:54 +00006531 goto jump_to_p2;
danielk1977dddbcdc2007-04-26 14:42:34 +00006532 }
6533 break;
6534}
6535#endif
6536
drh98757152008-01-09 23:04:12 +00006537/* Opcode: Expire P1 * * * *
danielk1977a21c6b62005-01-24 10:25:59 +00006538**
drh25df48d2014-07-22 14:58:12 +00006539** Cause precompiled statements to expire. When an expired statement
6540** is executed using sqlite3_step() it will either automatically
6541** reprepare itself (if it was originally created using sqlite3_prepare_v2())
6542** or it will fail with SQLITE_SCHEMA.
danielk1977a21c6b62005-01-24 10:25:59 +00006543**
6544** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
drh25df48d2014-07-22 14:58:12 +00006545** then only the currently executing statement is expired.
danielk1977a21c6b62005-01-24 10:25:59 +00006546*/
drh9cbf3422008-01-17 16:22:13 +00006547case OP_Expire: {
danielk1977a21c6b62005-01-24 10:25:59 +00006548 if( !pOp->p1 ){
6549 sqlite3ExpirePreparedStatements(db);
6550 }else{
6551 p->expired = 1;
6552 }
6553 break;
6554}
6555
danielk1977c00da102006-01-07 13:21:04 +00006556#ifndef SQLITE_OMIT_SHARED_CACHE
drh6a9ad3d2008-04-02 16:29:30 +00006557/* Opcode: TableLock P1 P2 P3 P4 *
drh81316f82013-10-29 20:40:47 +00006558** Synopsis: iDb=P1 root=P2 write=P3
danielk1977c00da102006-01-07 13:21:04 +00006559**
6560** Obtain a lock on a particular table. This instruction is only used when
6561** the shared-cache feature is enabled.
6562**
danielk197796d48e92009-06-29 06:00:37 +00006563** P1 is the index of the database in sqlite3.aDb[] of the database
drh6a9ad3d2008-04-02 16:29:30 +00006564** on which the lock is acquired. A readlock is obtained if P3==0 or
6565** a write lock if P3==1.
danielk1977c00da102006-01-07 13:21:04 +00006566**
6567** P2 contains the root-page of the table to lock.
6568**
drh66a51672008-01-03 00:01:23 +00006569** P4 contains a pointer to the name of the table being locked. This is only
danielk1977c00da102006-01-07 13:21:04 +00006570** used to generate an error message if the lock cannot be obtained.
6571*/
drh9cbf3422008-01-17 16:22:13 +00006572case OP_TableLock: {
danielk1977e0d9e6f2009-07-03 16:25:06 +00006573 u8 isWriteLock = (u8)pOp->p3;
drh169dd922017-06-26 13:57:49 +00006574 if( isWriteLock || 0==(db->flags&SQLITE_ReadUncommit) ){
danielk1977e0d9e6f2009-07-03 16:25:06 +00006575 int p1 = pOp->p1;
6576 assert( p1>=0 && p1<db->nDb );
drha7ab6d82014-07-21 15:44:39 +00006577 assert( DbMaskTest(p->btreeMask, p1) );
danielk1977e0d9e6f2009-07-03 16:25:06 +00006578 assert( isWriteLock==0 || isWriteLock==1 );
6579 rc = sqlite3BtreeLockTable(db->aDb[p1].pBt, pOp->p2, isWriteLock);
drh9467abf2016-02-17 18:44:11 +00006580 if( rc ){
6581 if( (rc&0xFF)==SQLITE_LOCKED ){
6582 const char *z = pOp->p4.z;
6583 sqlite3VdbeError(p, "database table is locked: %s", z);
6584 }
6585 goto abort_due_to_error;
danielk1977e0d9e6f2009-07-03 16:25:06 +00006586 }
danielk1977c00da102006-01-07 13:21:04 +00006587 }
6588 break;
6589}
drhb9bb7c12006-06-11 23:41:55 +00006590#endif /* SQLITE_OMIT_SHARED_CACHE */
6591
6592#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006593/* Opcode: VBegin * * * P4 *
drhb9bb7c12006-06-11 23:41:55 +00006594**
danielk19773e3a84d2008-08-01 17:37:40 +00006595** P4 may be a pointer to an sqlite3_vtab structure. If so, call the
6596** xBegin method for that table.
6597**
6598** Also, whether or not P4 is set, check that this is not being called from
danielk1977404ca072009-03-16 13:19:36 +00006599** within a callback to a virtual table xSync() method. If it is, the error
6600** code will be set to SQLITE_LOCKED.
drhb9bb7c12006-06-11 23:41:55 +00006601*/
drh9cbf3422008-01-17 16:22:13 +00006602case OP_VBegin: {
danielk1977595a5232009-07-24 17:58:53 +00006603 VTable *pVTab;
6604 pVTab = pOp->p4.pVtab;
6605 rc = sqlite3VtabBegin(db, pVTab);
dan016f7812013-08-21 17:35:48 +00006606 if( pVTab ) sqlite3VtabImportErrmsg(p, pVTab->pVtab);
drh9467abf2016-02-17 18:44:11 +00006607 if( rc ) goto abort_due_to_error;
danielk1977f9e7dda2006-06-16 16:08:53 +00006608 break;
6609}
6610#endif /* SQLITE_OMIT_VIRTUALTABLE */
6611
6612#ifndef SQLITE_OMIT_VIRTUALTABLE
dan73779452015-03-19 18:56:17 +00006613/* Opcode: VCreate P1 P2 * * *
danielk1977f9e7dda2006-06-16 16:08:53 +00006614**
dan73779452015-03-19 18:56:17 +00006615** P2 is a register that holds the name of a virtual table in database
6616** P1. Call the xCreate method for that table.
danielk1977f9e7dda2006-06-16 16:08:53 +00006617*/
drh9cbf3422008-01-17 16:22:13 +00006618case OP_VCreate: {
dan73779452015-03-19 18:56:17 +00006619 Mem sMem; /* For storing the record being decoded */
drh47464062015-03-21 12:22:16 +00006620 const char *zTab; /* Name of the virtual table */
6621
dan73779452015-03-19 18:56:17 +00006622 memset(&sMem, 0, sizeof(sMem));
6623 sMem.db = db;
drh47464062015-03-21 12:22:16 +00006624 /* Because P2 is always a static string, it is impossible for the
6625 ** sqlite3VdbeMemCopy() to fail */
6626 assert( (aMem[pOp->p2].flags & MEM_Str)!=0 );
6627 assert( (aMem[pOp->p2].flags & MEM_Static)!=0 );
dan73779452015-03-19 18:56:17 +00006628 rc = sqlite3VdbeMemCopy(&sMem, &aMem[pOp->p2]);
drh47464062015-03-21 12:22:16 +00006629 assert( rc==SQLITE_OK );
6630 zTab = (const char*)sqlite3_value_text(&sMem);
6631 assert( zTab || db->mallocFailed );
6632 if( zTab ){
6633 rc = sqlite3VtabCallCreate(db, pOp->p1, zTab, &p->zErrMsg);
dan73779452015-03-19 18:56:17 +00006634 }
6635 sqlite3VdbeMemRelease(&sMem);
drh9467abf2016-02-17 18:44:11 +00006636 if( rc ) goto abort_due_to_error;
drhb9bb7c12006-06-11 23:41:55 +00006637 break;
6638}
6639#endif /* SQLITE_OMIT_VIRTUALTABLE */
6640
6641#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006642/* Opcode: VDestroy P1 * * P4 *
drhb9bb7c12006-06-11 23:41:55 +00006643**
drh66a51672008-01-03 00:01:23 +00006644** P4 is the name of a virtual table in database P1. Call the xDestroy method
danielk19779e39ce82006-06-12 16:01:21 +00006645** of that table.
drhb9bb7c12006-06-11 23:41:55 +00006646*/
drh9cbf3422008-01-17 16:22:13 +00006647case OP_VDestroy: {
drh086723a2015-03-24 12:51:52 +00006648 db->nVDestroy++;
danielk19772dca4ac2008-01-03 11:50:29 +00006649 rc = sqlite3VtabCallDestroy(db, pOp->p1, pOp->p4.z);
drh086723a2015-03-24 12:51:52 +00006650 db->nVDestroy--;
drh9467abf2016-02-17 18:44:11 +00006651 if( rc ) goto abort_due_to_error;
drhb9bb7c12006-06-11 23:41:55 +00006652 break;
6653}
6654#endif /* SQLITE_OMIT_VIRTUALTABLE */
danielk1977c00da102006-01-07 13:21:04 +00006655
drh9eff6162006-06-12 21:59:13 +00006656#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006657/* Opcode: VOpen P1 * * P4 *
drh9eff6162006-06-12 21:59:13 +00006658**
drh66a51672008-01-03 00:01:23 +00006659** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
drh9eff6162006-06-12 21:59:13 +00006660** P1 is a cursor number. This opcode opens a cursor to the virtual
6661** table and stores that cursor in P1.
6662*/
drh9cbf3422008-01-17 16:22:13 +00006663case OP_VOpen: {
drh856c1032009-06-02 15:21:42 +00006664 VdbeCursor *pCur;
drhc960dcb2015-11-20 19:22:01 +00006665 sqlite3_vtab_cursor *pVCur;
drh856c1032009-06-02 15:21:42 +00006666 sqlite3_vtab *pVtab;
drhf496a7d2015-03-24 14:05:50 +00006667 const sqlite3_module *pModule;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006668
drh1713afb2013-06-28 01:24:57 +00006669 assert( p->bIsReader );
drh856c1032009-06-02 15:21:42 +00006670 pCur = 0;
drhc960dcb2015-11-20 19:22:01 +00006671 pVCur = 0;
danielk1977595a5232009-07-24 17:58:53 +00006672 pVtab = pOp->p4.pVtab->pVtab;
drhf496a7d2015-03-24 14:05:50 +00006673 if( pVtab==0 || NEVER(pVtab->pModule==0) ){
6674 rc = SQLITE_LOCKED;
drh9467abf2016-02-17 18:44:11 +00006675 goto abort_due_to_error;
drhf496a7d2015-03-24 14:05:50 +00006676 }
6677 pModule = pVtab->pModule;
drhc960dcb2015-11-20 19:22:01 +00006678 rc = pModule->xOpen(pVtab, &pVCur);
dan016f7812013-08-21 17:35:48 +00006679 sqlite3VtabImportErrmsg(p, pVtab);
drh9467abf2016-02-17 18:44:11 +00006680 if( rc ) goto abort_due_to_error;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006681
drh9467abf2016-02-17 18:44:11 +00006682 /* Initialize sqlite3_vtab_cursor base class */
6683 pVCur->pVtab = pVtab;
6684
6685 /* Initialize vdbe cursor object */
6686 pCur = allocateCursor(p, pOp->p1, 0, -1, CURTYPE_VTAB);
6687 if( pCur ){
6688 pCur->uc.pVCur = pVCur;
6689 pVtab->nRef++;
6690 }else{
6691 assert( db->mallocFailed );
6692 pModule->xClose(pVCur);
6693 goto no_mem;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006694 }
drh9eff6162006-06-12 21:59:13 +00006695 break;
6696}
6697#endif /* SQLITE_OMIT_VIRTUALTABLE */
6698
6699#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk19776dbee812008-01-03 18:39:41 +00006700/* Opcode: VFilter P1 P2 P3 P4 *
drh831116d2014-04-03 14:31:00 +00006701** Synopsis: iplan=r[P3] zplan='P4'
drh9eff6162006-06-12 21:59:13 +00006702**
6703** P1 is a cursor opened using VOpen. P2 is an address to jump to if
6704** the filtered result set is empty.
6705**
drh66a51672008-01-03 00:01:23 +00006706** P4 is either NULL or a string that was generated by the xBestIndex
6707** method of the module. The interpretation of the P4 string is left
drh4be8b512006-06-13 23:51:34 +00006708** to the module implementation.
danielk19775fac9f82006-06-13 14:16:58 +00006709**
drh9eff6162006-06-12 21:59:13 +00006710** This opcode invokes the xFilter method on the virtual table specified
danielk19776dbee812008-01-03 18:39:41 +00006711** by P1. The integer query plan parameter to xFilter is stored in register
6712** P3. Register P3+1 stores the argc parameter to be passed to the
drh174edc62008-05-29 05:23:41 +00006713** xFilter method. Registers P3+2..P3+1+argc are the argc
6714** additional parameters which are passed to
danielk19776dbee812008-01-03 18:39:41 +00006715** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
danielk1977b7a7b9a2006-06-13 10:24:42 +00006716**
danielk19776dbee812008-01-03 18:39:41 +00006717** A jump is made to P2 if the result set after filtering would be empty.
drh9eff6162006-06-12 21:59:13 +00006718*/
drh9cbf3422008-01-17 16:22:13 +00006719case OP_VFilter: { /* jump */
danielk1977b7a7b9a2006-06-13 10:24:42 +00006720 int nArg;
danielk19776dbee812008-01-03 18:39:41 +00006721 int iQuery;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006722 const sqlite3_module *pModule;
drh856c1032009-06-02 15:21:42 +00006723 Mem *pQuery;
6724 Mem *pArgc;
drhc960dcb2015-11-20 19:22:01 +00006725 sqlite3_vtab_cursor *pVCur;
drh4dc754d2008-07-23 18:17:32 +00006726 sqlite3_vtab *pVtab;
drh856c1032009-06-02 15:21:42 +00006727 VdbeCursor *pCur;
6728 int res;
6729 int i;
6730 Mem **apArg;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006731
drha6c2ed92009-11-14 23:22:23 +00006732 pQuery = &aMem[pOp->p3];
drh856c1032009-06-02 15:21:42 +00006733 pArgc = &pQuery[1];
6734 pCur = p->apCsr[pOp->p1];
drh2b4ded92010-09-27 21:09:31 +00006735 assert( memIsValid(pQuery) );
drh5b6afba2008-01-05 16:29:28 +00006736 REGISTER_TRACE(pOp->p3, pQuery);
drhc960dcb2015-11-20 19:22:01 +00006737 assert( pCur->eCurType==CURTYPE_VTAB );
6738 pVCur = pCur->uc.pVCur;
6739 pVtab = pVCur->pVtab;
drh4dc754d2008-07-23 18:17:32 +00006740 pModule = pVtab->pModule;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006741
drh9cbf3422008-01-17 16:22:13 +00006742 /* Grab the index number and argc parameters */
danielk19776dbee812008-01-03 18:39:41 +00006743 assert( (pQuery->flags&MEM_Int)!=0 && pArgc->flags==MEM_Int );
drh9c1905f2008-12-10 22:32:56 +00006744 nArg = (int)pArgc->u.i;
6745 iQuery = (int)pQuery->u.i;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006746
drh644a5292006-12-20 14:53:38 +00006747 /* Invoke the xFilter method */
drhf56fa462015-04-13 21:39:54 +00006748 res = 0;
6749 apArg = p->apArg;
6750 for(i = 0; i<nArg; i++){
6751 apArg[i] = &pArgc[i+1];
6752 }
drhc960dcb2015-11-20 19:22:01 +00006753 rc = pModule->xFilter(pVCur, iQuery, pOp->p4.z, nArg, apArg);
drhf56fa462015-04-13 21:39:54 +00006754 sqlite3VtabImportErrmsg(p, pVtab);
drh9467abf2016-02-17 18:44:11 +00006755 if( rc ) goto abort_due_to_error;
6756 res = pModule->xEof(pVCur);
drh1d454a32008-01-31 19:34:51 +00006757 pCur->nullRow = 0;
drhf56fa462015-04-13 21:39:54 +00006758 VdbeBranchTaken(res!=0,2);
6759 if( res ) goto jump_to_p2;
drh9eff6162006-06-12 21:59:13 +00006760 break;
6761}
6762#endif /* SQLITE_OMIT_VIRTUALTABLE */
6763
6764#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006765/* Opcode: VColumn P1 P2 P3 * *
drh81316f82013-10-29 20:40:47 +00006766** Synopsis: r[P3]=vcolumn(P2)
drh9eff6162006-06-12 21:59:13 +00006767**
drh2133d822008-01-03 18:44:59 +00006768** Store the value of the P2-th column of
6769** the row of the virtual-table that the
6770** P1 cursor is pointing to into register P3.
drh9eff6162006-06-12 21:59:13 +00006771*/
6772case OP_VColumn: {
danielk19773e3a84d2008-08-01 17:37:40 +00006773 sqlite3_vtab *pVtab;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006774 const sqlite3_module *pModule;
drhde4fcfd2008-01-19 23:50:26 +00006775 Mem *pDest;
6776 sqlite3_context sContext;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006777
drhdfe88ec2008-11-03 20:55:06 +00006778 VdbeCursor *pCur = p->apCsr[pOp->p1];
drhc960dcb2015-11-20 19:22:01 +00006779 assert( pCur->eCurType==CURTYPE_VTAB );
drh9f6168b2016-03-19 23:32:58 +00006780 assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
drha6c2ed92009-11-14 23:22:23 +00006781 pDest = &aMem[pOp->p3];
drh2b4ded92010-09-27 21:09:31 +00006782 memAboutToChange(p, pDest);
drh2945b4a2008-01-31 15:53:45 +00006783 if( pCur->nullRow ){
6784 sqlite3VdbeMemSetNull(pDest);
6785 break;
6786 }
drhc960dcb2015-11-20 19:22:01 +00006787 pVtab = pCur->uc.pVCur->pVtab;
danielk19773e3a84d2008-08-01 17:37:40 +00006788 pModule = pVtab->pModule;
drhde4fcfd2008-01-19 23:50:26 +00006789 assert( pModule->xColumn );
6790 memset(&sContext, 0, sizeof(sContext));
drh9bd038f2014-08-27 14:14:06 +00006791 sContext.pOut = pDest;
6792 MemSetTypeFlag(pDest, MEM_Null);
drhc960dcb2015-11-20 19:22:01 +00006793 rc = pModule->xColumn(pCur->uc.pVCur, &sContext, pOp->p2);
dan016f7812013-08-21 17:35:48 +00006794 sqlite3VtabImportErrmsg(p, pVtab);
drh4c8555f2009-06-25 01:47:11 +00006795 if( sContext.isError ){
6796 rc = sContext.isError;
6797 }
drh9bd038f2014-08-27 14:14:06 +00006798 sqlite3VdbeChangeEncoding(pDest, encoding);
drh5ff44372009-11-24 16:26:17 +00006799 REGISTER_TRACE(pOp->p3, pDest);
drhde4fcfd2008-01-19 23:50:26 +00006800 UPDATE_MAX_BLOBSIZE(pDest);
danielk1977b7a7b9a2006-06-13 10:24:42 +00006801
drhde4fcfd2008-01-19 23:50:26 +00006802 if( sqlite3VdbeMemTooBig(pDest) ){
6803 goto too_big;
6804 }
drh9467abf2016-02-17 18:44:11 +00006805 if( rc ) goto abort_due_to_error;
drh9eff6162006-06-12 21:59:13 +00006806 break;
6807}
6808#endif /* SQLITE_OMIT_VIRTUALTABLE */
6809
6810#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006811/* Opcode: VNext P1 P2 * * *
drh9eff6162006-06-12 21:59:13 +00006812**
6813** Advance virtual table P1 to the next row in its result set and
6814** jump to instruction P2. Or, if the virtual table has reached
6815** the end of its result set, then fall through to the next instruction.
6816*/
drh9cbf3422008-01-17 16:22:13 +00006817case OP_VNext: { /* jump */
danielk19773e3a84d2008-08-01 17:37:40 +00006818 sqlite3_vtab *pVtab;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006819 const sqlite3_module *pModule;
drhc54a6172009-06-02 16:06:03 +00006820 int res;
drh856c1032009-06-02 15:21:42 +00006821 VdbeCursor *pCur;
danielk1977b7a7b9a2006-06-13 10:24:42 +00006822
drhc54a6172009-06-02 16:06:03 +00006823 res = 0;
drh856c1032009-06-02 15:21:42 +00006824 pCur = p->apCsr[pOp->p1];
drhc960dcb2015-11-20 19:22:01 +00006825 assert( pCur->eCurType==CURTYPE_VTAB );
drh2945b4a2008-01-31 15:53:45 +00006826 if( pCur->nullRow ){
6827 break;
6828 }
drhc960dcb2015-11-20 19:22:01 +00006829 pVtab = pCur->uc.pVCur->pVtab;
danielk19773e3a84d2008-08-01 17:37:40 +00006830 pModule = pVtab->pModule;
drhde4fcfd2008-01-19 23:50:26 +00006831 assert( pModule->xNext );
danielk1977b7a7b9a2006-06-13 10:24:42 +00006832
drhde4fcfd2008-01-19 23:50:26 +00006833 /* Invoke the xNext() method of the module. There is no way for the
6834 ** underlying implementation to return an error if one occurs during
6835 ** xNext(). Instead, if an error occurs, true is returned (indicating that
6836 ** data is available) and the error code returned when xColumn or
6837 ** some other method is next invoked on the save virtual table cursor.
6838 */
drhc960dcb2015-11-20 19:22:01 +00006839 rc = pModule->xNext(pCur->uc.pVCur);
dan016f7812013-08-21 17:35:48 +00006840 sqlite3VtabImportErrmsg(p, pVtab);
drh9467abf2016-02-17 18:44:11 +00006841 if( rc ) goto abort_due_to_error;
6842 res = pModule->xEof(pCur->uc.pVCur);
drh688852a2014-02-17 22:40:43 +00006843 VdbeBranchTaken(!res,2);
drhde4fcfd2008-01-19 23:50:26 +00006844 if( !res ){
6845 /* If there is data, jump to P2 */
drhf56fa462015-04-13 21:39:54 +00006846 goto jump_to_p2_and_check_for_interrupt;
drhde4fcfd2008-01-19 23:50:26 +00006847 }
drh49afe3a2013-07-10 03:05:14 +00006848 goto check_for_interrupt;
drh9eff6162006-06-12 21:59:13 +00006849}
6850#endif /* SQLITE_OMIT_VIRTUALTABLE */
6851
danielk1977182c4ba2007-06-27 15:53:34 +00006852#ifndef SQLITE_OMIT_VIRTUALTABLE
drh98757152008-01-09 23:04:12 +00006853/* Opcode: VRename P1 * * P4 *
danielk1977182c4ba2007-06-27 15:53:34 +00006854**
drh66a51672008-01-03 00:01:23 +00006855** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
danielk1977182c4ba2007-06-27 15:53:34 +00006856** This opcode invokes the corresponding xRename method. The value
danielk19776dbee812008-01-03 18:39:41 +00006857** in register P1 is passed as the zName argument to the xRename method.
danielk1977182c4ba2007-06-27 15:53:34 +00006858*/
drh9cbf3422008-01-17 16:22:13 +00006859case OP_VRename: {
drh856c1032009-06-02 15:21:42 +00006860 sqlite3_vtab *pVtab;
6861 Mem *pName;
6862
danielk1977595a5232009-07-24 17:58:53 +00006863 pVtab = pOp->p4.pVtab->pVtab;
drha6c2ed92009-11-14 23:22:23 +00006864 pName = &aMem[pOp->p1];
danielk1977182c4ba2007-06-27 15:53:34 +00006865 assert( pVtab->pModule->xRename );
drh2b4ded92010-09-27 21:09:31 +00006866 assert( memIsValid(pName) );
drh9e92a472013-06-27 17:40:30 +00006867 assert( p->readOnly==0 );
drh5b6afba2008-01-05 16:29:28 +00006868 REGISTER_TRACE(pOp->p1, pName);
drh35f6b932009-06-23 14:15:04 +00006869 assert( pName->flags & MEM_Str );
drh98655a62011-10-18 22:07:47 +00006870 testcase( pName->enc==SQLITE_UTF8 );
6871 testcase( pName->enc==SQLITE_UTF16BE );
6872 testcase( pName->enc==SQLITE_UTF16LE );
6873 rc = sqlite3VdbeChangeEncoding(pName, SQLITE_UTF8);
drh9467abf2016-02-17 18:44:11 +00006874 if( rc ) goto abort_due_to_error;
6875 rc = pVtab->pModule->xRename(pVtab, pName->z);
6876 sqlite3VtabImportErrmsg(p, pVtab);
6877 p->expired = 0;
6878 if( rc ) goto abort_due_to_error;
danielk1977182c4ba2007-06-27 15:53:34 +00006879 break;
6880}
6881#endif
drh4cbdda92006-06-14 19:00:20 +00006882
6883#ifndef SQLITE_OMIT_VIRTUALTABLE
drh0fd61352014-02-07 02:29:45 +00006884/* Opcode: VUpdate P1 P2 P3 P4 P5
drhf63552b2013-10-30 00:25:03 +00006885** Synopsis: data=r[P3@P2]
danielk1977399918f2006-06-14 13:03:23 +00006886**
drh66a51672008-01-03 00:01:23 +00006887** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
danielk1977399918f2006-06-14 13:03:23 +00006888** This opcode invokes the corresponding xUpdate method. P2 values
danielk19772a339ff2008-01-03 17:31:44 +00006889** are contiguous memory cells starting at P3 to pass to the xUpdate
6890** invocation. The value in register (P3+P2-1) corresponds to the
6891** p2th element of the argv array passed to xUpdate.
drh4cbdda92006-06-14 19:00:20 +00006892**
6893** The xUpdate method will do a DELETE or an INSERT or both.
danielk19772a339ff2008-01-03 17:31:44 +00006894** The argv[0] element (which corresponds to memory cell P3)
6895** is the rowid of a row to delete. If argv[0] is NULL then no
6896** deletion occurs. The argv[1] element is the rowid of the new
6897** row. This can be NULL to have the virtual table select the new
6898** rowid for itself. The subsequent elements in the array are
6899** the values of columns in the new row.
drh4cbdda92006-06-14 19:00:20 +00006900**
6901** If P2==1 then no insert is performed. argv[0] is the rowid of
6902** a row to delete.
danielk19771f6eec52006-06-16 06:17:47 +00006903**
6904** P1 is a boolean flag. If it is set to true and the xUpdate call
6905** is successful, then the value returned by sqlite3_last_insert_rowid()
6906** is set to the value of the rowid for the row just inserted.
drh0fd61352014-02-07 02:29:45 +00006907**
6908** P5 is the error actions (OE_Replace, OE_Fail, OE_Ignore, etc) to
6909** apply in the case of a constraint failure on an insert or update.
danielk1977399918f2006-06-14 13:03:23 +00006910*/
drh9cbf3422008-01-17 16:22:13 +00006911case OP_VUpdate: {
drh856c1032009-06-02 15:21:42 +00006912 sqlite3_vtab *pVtab;
drhf496a7d2015-03-24 14:05:50 +00006913 const sqlite3_module *pModule;
drh856c1032009-06-02 15:21:42 +00006914 int nArg;
6915 int i;
6916 sqlite_int64 rowid;
6917 Mem **apArg;
6918 Mem *pX;
6919
danb061d052011-04-25 18:49:57 +00006920 assert( pOp->p2==1 || pOp->p5==OE_Fail || pOp->p5==OE_Rollback
6921 || pOp->p5==OE_Abort || pOp->p5==OE_Ignore || pOp->p5==OE_Replace
6922 );
drh9e92a472013-06-27 17:40:30 +00006923 assert( p->readOnly==0 );
danielk1977595a5232009-07-24 17:58:53 +00006924 pVtab = pOp->p4.pVtab->pVtab;
drhf496a7d2015-03-24 14:05:50 +00006925 if( pVtab==0 || NEVER(pVtab->pModule==0) ){
6926 rc = SQLITE_LOCKED;
drh9467abf2016-02-17 18:44:11 +00006927 goto abort_due_to_error;
drhf496a7d2015-03-24 14:05:50 +00006928 }
6929 pModule = pVtab->pModule;
drh856c1032009-06-02 15:21:42 +00006930 nArg = pOp->p2;
drh66a51672008-01-03 00:01:23 +00006931 assert( pOp->p4type==P4_VTAB );
drh35f6b932009-06-23 14:15:04 +00006932 if( ALWAYS(pModule->xUpdate) ){
danb061d052011-04-25 18:49:57 +00006933 u8 vtabOnConflict = db->vtabOnConflict;
drh856c1032009-06-02 15:21:42 +00006934 apArg = p->apArg;
drha6c2ed92009-11-14 23:22:23 +00006935 pX = &aMem[pOp->p3];
danielk19772a339ff2008-01-03 17:31:44 +00006936 for(i=0; i<nArg; i++){
drh2b4ded92010-09-27 21:09:31 +00006937 assert( memIsValid(pX) );
6938 memAboutToChange(p, pX);
drh9c419382006-06-16 21:13:21 +00006939 apArg[i] = pX;
danielk19772a339ff2008-01-03 17:31:44 +00006940 pX++;
danielk1977399918f2006-06-14 13:03:23 +00006941 }
danb061d052011-04-25 18:49:57 +00006942 db->vtabOnConflict = pOp->p5;
danielk19771f6eec52006-06-16 06:17:47 +00006943 rc = pModule->xUpdate(pVtab, nArg, apArg, &rowid);
danb061d052011-04-25 18:49:57 +00006944 db->vtabOnConflict = vtabOnConflict;
dan016f7812013-08-21 17:35:48 +00006945 sqlite3VtabImportErrmsg(p, pVtab);
drh35f6b932009-06-23 14:15:04 +00006946 if( rc==SQLITE_OK && pOp->p1 ){
danielk19771f6eec52006-06-16 06:17:47 +00006947 assert( nArg>1 && apArg[0] && (apArg[0]->flags&MEM_Null) );
drhfae58d52017-01-26 17:26:44 +00006948 db->lastRowid = rowid;
danielk19771f6eec52006-06-16 06:17:47 +00006949 }
drhd91c1a12013-02-09 13:58:25 +00006950 if( (rc&0xff)==SQLITE_CONSTRAINT && pOp->p4.pVtab->bConstraint ){
danb061d052011-04-25 18:49:57 +00006951 if( pOp->p5==OE_Ignore ){
6952 rc = SQLITE_OK;
6953 }else{
6954 p->errorAction = ((pOp->p5==OE_Replace) ? OE_Abort : pOp->p5);
6955 }
6956 }else{
6957 p->nChange++;
6958 }
drh9467abf2016-02-17 18:44:11 +00006959 if( rc ) goto abort_due_to_error;
danielk1977399918f2006-06-14 13:03:23 +00006960 }
drh4cbdda92006-06-14 19:00:20 +00006961 break;
danielk1977399918f2006-06-14 13:03:23 +00006962}
6963#endif /* SQLITE_OMIT_VIRTUALTABLE */
6964
danielk197759a93792008-05-15 17:48:20 +00006965#ifndef SQLITE_OMIT_PAGER_PRAGMAS
6966/* Opcode: Pagecount P1 P2 * * *
6967**
6968** Write the current number of pages in database P1 to memory cell P2.
6969*/
drh27a348c2015-04-13 19:14:06 +00006970case OP_Pagecount: { /* out2 */
6971 pOut = out2Prerelease(p, pOp);
drhb1299152010-03-30 22:58:33 +00006972 pOut->u.i = sqlite3BtreeLastPage(db->aDb[pOp->p1].pBt);
danielk197759a93792008-05-15 17:48:20 +00006973 break;
6974}
6975#endif
6976
drh60ac3f42010-11-23 18:59:27 +00006977
6978#ifndef SQLITE_OMIT_PAGER_PRAGMAS
6979/* Opcode: MaxPgcnt P1 P2 P3 * *
6980**
6981** Try to set the maximum page count for database P1 to the value in P3.
drhc84e0332010-11-23 20:25:08 +00006982** Do not let the maximum page count fall below the current page count and
6983** do not change the maximum page count value if P3==0.
6984**
drh60ac3f42010-11-23 18:59:27 +00006985** Store the maximum page count after the change in register P2.
6986*/
drh27a348c2015-04-13 19:14:06 +00006987case OP_MaxPgcnt: { /* out2 */
drhc84e0332010-11-23 20:25:08 +00006988 unsigned int newMax;
drh60ac3f42010-11-23 18:59:27 +00006989 Btree *pBt;
6990
drh27a348c2015-04-13 19:14:06 +00006991 pOut = out2Prerelease(p, pOp);
drh60ac3f42010-11-23 18:59:27 +00006992 pBt = db->aDb[pOp->p1].pBt;
drhc84e0332010-11-23 20:25:08 +00006993 newMax = 0;
6994 if( pOp->p3 ){
6995 newMax = sqlite3BtreeLastPage(pBt);
drh6ea28d62010-11-26 16:49:59 +00006996 if( newMax < (unsigned)pOp->p3 ) newMax = (unsigned)pOp->p3;
drhc84e0332010-11-23 20:25:08 +00006997 }
6998 pOut->u.i = sqlite3BtreeMaxPageCount(pBt, newMax);
drh60ac3f42010-11-23 18:59:27 +00006999 break;
7000}
7001#endif
7002
7003
drh9e5eb9c2016-09-18 16:08:10 +00007004/* Opcode: Init P1 P2 * P4 *
drh72e26de2016-08-24 21:24:04 +00007005** Synopsis: Start at P2
drhaceb31b2014-02-08 01:40:27 +00007006**
7007** Programs contain a single instance of this opcode as the very first
7008** opcode.
drh949f9cd2008-01-12 21:35:57 +00007009**
7010** If tracing is enabled (by the sqlite3_trace()) interface, then
7011** the UTF-8 string contained in P4 is emitted on the trace callback.
drhaceb31b2014-02-08 01:40:27 +00007012** Or if P4 is blank, use the string returned by sqlite3_sql().
7013**
7014** If P2 is not zero, jump to instruction P2.
drh9e5eb9c2016-09-18 16:08:10 +00007015**
7016** Increment the value of P1 so that OP_Once opcodes will jump the
7017** first time they are evaluated for this run.
drh949f9cd2008-01-12 21:35:57 +00007018*/
drhaceb31b2014-02-08 01:40:27 +00007019case OP_Init: { /* jump */
drh856c1032009-06-02 15:21:42 +00007020 char *zTrace;
drh9e5eb9c2016-09-18 16:08:10 +00007021 int i;
drh5fe63bf2016-07-25 02:42:22 +00007022
7023 /* If the P4 argument is not NULL, then it must be an SQL comment string.
7024 ** The "--" string is broken up to prevent false-positives with srcck1.c.
7025 **
7026 ** This assert() provides evidence for:
7027 ** EVIDENCE-OF: R-50676-09860 The callback can compute the same text that
7028 ** would have been returned by the legacy sqlite3_trace() interface by
7029 ** using the X argument when X begins with "--" and invoking
7030 ** sqlite3_expanded_sql(P) otherwise.
7031 */
7032 assert( pOp->p4.z==0 || strncmp(pOp->p4.z, "-" "- ", 3)==0 );
drh9e5eb9c2016-09-18 16:08:10 +00007033 assert( pOp==p->aOp ); /* Always instruction 0 */
drh856c1032009-06-02 15:21:42 +00007034
drhaceb31b2014-02-08 01:40:27 +00007035#ifndef SQLITE_OMIT_TRACE
drhfca760c2016-07-14 01:09:08 +00007036 if( (db->mTrace & (SQLITE_TRACE_STMT|SQLITE_TRACE_LEGACY))!=0
drh37f58e92012-09-04 21:34:26 +00007037 && !p->doingRerun
7038 && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
7039 ){
drh3d2a5292016-07-13 22:55:01 +00007040#ifndef SQLITE_OMIT_DEPRECATED
drhfca760c2016-07-14 01:09:08 +00007041 if( db->mTrace & SQLITE_TRACE_LEGACY ){
7042 void (*x)(void*,const char*) = (void(*)(void*,const char*))db->xTrace;
drh5fe63bf2016-07-25 02:42:22 +00007043 char *z = sqlite3VdbeExpandSql(p, zTrace);
drhfca760c2016-07-14 01:09:08 +00007044 x(db->pTraceArg, z);
drhbd441f72016-07-25 02:31:48 +00007045 sqlite3_free(z);
drhfca760c2016-07-14 01:09:08 +00007046 }else
drh3d2a5292016-07-13 22:55:01 +00007047#endif
drh7adbcff2017-03-20 15:29:28 +00007048 if( db->nVdbeExec>1 ){
7049 char *z = sqlite3MPrintf(db, "-- %s", zTrace);
7050 (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, z);
7051 sqlite3DbFree(db, z);
7052 }else{
drhbd441f72016-07-25 02:31:48 +00007053 (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, zTrace);
drh3d2a5292016-07-13 22:55:01 +00007054 }
drh949f9cd2008-01-12 21:35:57 +00007055 }
drh8f8b2312013-10-18 20:03:43 +00007056#ifdef SQLITE_USE_FCNTL_TRACE
7057 zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql);
7058 if( zTrace ){
mistachkind8992ce2016-09-20 17:49:01 +00007059 int j;
7060 for(j=0; j<db->nDb; j++){
7061 if( DbMaskTest(p->btreeMask, j)==0 ) continue;
7062 sqlite3_file_control(db, db->aDb[j].zDbSName, SQLITE_FCNTL_TRACE, zTrace);
drh8f8b2312013-10-18 20:03:43 +00007063 }
7064 }
7065#endif /* SQLITE_USE_FCNTL_TRACE */
drhc3f1d5f2011-05-30 23:42:16 +00007066#ifdef SQLITE_DEBUG
7067 if( (db->flags & SQLITE_SqlTrace)!=0
7068 && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
7069 ){
7070 sqlite3DebugPrintf("SQL-trace: %s\n", zTrace);
7071 }
7072#endif /* SQLITE_DEBUG */
drhaceb31b2014-02-08 01:40:27 +00007073#endif /* SQLITE_OMIT_TRACE */
drh4910a762016-09-03 01:46:15 +00007074 assert( pOp->p2>0 );
drh9e5eb9c2016-09-18 16:08:10 +00007075 if( pOp->p1>=sqlite3GlobalConfig.iOnceResetThreshold ){
7076 for(i=1; i<p->nOp; i++){
7077 if( p->aOp[i].opcode==OP_Once ) p->aOp[i].p1 = 0;
7078 }
7079 pOp->p1 = 0;
7080 }
7081 pOp->p1++;
drh4910a762016-09-03 01:46:15 +00007082 goto jump_to_p2;
drh949f9cd2008-01-12 21:35:57 +00007083}
drh949f9cd2008-01-12 21:35:57 +00007084
drh28935362013-12-07 20:39:19 +00007085#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh0df57012015-08-14 15:05:55 +00007086/* Opcode: CursorHint P1 * * P4 *
drh28935362013-12-07 20:39:19 +00007087**
7088** Provide a hint to cursor P1 that it only needs to return rows that
drh0df57012015-08-14 15:05:55 +00007089** satisfy the Expr in P4. TK_REGISTER terms in the P4 expression refer
7090** to values currently held in registers. TK_COLUMN terms in the P4
7091** expression refer to columns in the b-tree to which cursor P1 is pointing.
drh28935362013-12-07 20:39:19 +00007092*/
7093case OP_CursorHint: {
7094 VdbeCursor *pC;
7095
7096 assert( pOp->p1>=0 && pOp->p1<p->nCursor );
7097 assert( pOp->p4type==P4_EXPR );
7098 pC = p->apCsr[pOp->p1];
dan91d3a612014-07-15 11:59:44 +00007099 if( pC ){
drhc960dcb2015-11-20 19:22:01 +00007100 assert( pC->eCurType==CURTYPE_BTREE );
drh62aaa6c2015-11-21 17:27:42 +00007101 sqlite3BtreeCursorHint(pC->uc.pCursor, BTREE_HINT_RANGE,
7102 pOp->p4.pExpr, aMem);
dan91d3a612014-07-15 11:59:44 +00007103 }
drh28935362013-12-07 20:39:19 +00007104 break;
7105}
7106#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh91fd4d42008-01-19 20:11:25 +00007107
7108/* Opcode: Noop * * * * *
7109**
7110** Do nothing. This instruction is often useful as a jump
7111** destination.
drh5e00f6c2001-09-13 13:46:56 +00007112*/
drh91fd4d42008-01-19 20:11:25 +00007113/*
7114** The magic Explain opcode are only inserted when explain==2 (which
7115** is to say when the EXPLAIN QUERY PLAN syntax is used.)
7116** This opcode records information from the optimizer. It is the
7117** the same as a no-op. This opcodesnever appears in a real VM program.
7118*/
7119default: { /* This is really OP_Noop and OP_Explain */
drh13573c72010-01-12 17:04:07 +00007120 assert( pOp->opcode==OP_Noop || pOp->opcode==OP_Explain );
drh5e00f6c2001-09-13 13:46:56 +00007121 break;
7122}
7123
7124/*****************************************************************************
7125** The cases of the switch statement above this line should all be indented
7126** by 6 spaces. But the left-most 6 spaces have been removed to improve the
7127** readability. From this point on down, the normal indentation rules are
7128** restored.
7129*****************************************************************************/
7130 }
drh6e142f52000-06-08 13:36:40 +00007131
drh7b396862003-01-01 23:06:20 +00007132#ifdef VDBE_PROFILE
drh8178a752003-01-05 21:41:40 +00007133 {
drha01c7c72014-04-25 12:35:31 +00007134 u64 endTime = sqlite3Hwtime();
drh6dc41482015-04-16 17:31:02 +00007135 if( endTime>start ) pOrigOp->cycles += endTime - start;
7136 pOrigOp->cnt++;
drh8178a752003-01-05 21:41:40 +00007137 }
drh7b396862003-01-01 23:06:20 +00007138#endif
7139
drh6e142f52000-06-08 13:36:40 +00007140 /* The following code adds nothing to the actual functionality
7141 ** of the program. It is only here for testing and debugging.
7142 ** On the other hand, it does burn CPU cycles every time through
7143 ** the evaluator loop. So we can leave it out when NDEBUG is defined.
7144 */
7145#ifndef NDEBUG
drh6dc41482015-04-16 17:31:02 +00007146 assert( pOp>=&aOp[-1] && pOp<&aOp[p->nOp-1] );
drhae7e1512007-05-02 16:51:59 +00007147
drhcf1023c2007-05-08 20:59:49 +00007148#ifdef SQLITE_DEBUG
drh84e55a82013-11-13 17:58:23 +00007149 if( db->flags & SQLITE_VdbeTrace ){
drh7cc84c22016-04-11 13:36:42 +00007150 u8 opProperty = sqlite3OpcodeProperty[pOrigOp->opcode];
drh84e55a82013-11-13 17:58:23 +00007151 if( rc!=0 ) printf("rc=%d\n",rc);
drh7cc84c22016-04-11 13:36:42 +00007152 if( opProperty & (OPFLG_OUT2) ){
drh6dc41482015-04-16 17:31:02 +00007153 registerTrace(pOrigOp->p2, &aMem[pOrigOp->p2]);
drh75897232000-05-29 14:26:00 +00007154 }
drh7cc84c22016-04-11 13:36:42 +00007155 if( opProperty & OPFLG_OUT3 ){
drh6dc41482015-04-16 17:31:02 +00007156 registerTrace(pOrigOp->p3, &aMem[pOrigOp->p3]);
drh5b6afba2008-01-05 16:29:28 +00007157 }
drh75897232000-05-29 14:26:00 +00007158 }
danielk1977b5402fb2005-01-12 07:15:04 +00007159#endif /* SQLITE_DEBUG */
7160#endif /* NDEBUG */
drhb86ccfb2003-01-28 23:13:10 +00007161 } /* The end of the for(;;) loop the loops through opcodes */
drh75897232000-05-29 14:26:00 +00007162
drha05a7222008-01-19 03:35:58 +00007163 /* If we reach this point, it means that execution is finished with
7164 ** an error of some kind.
drhb86ccfb2003-01-28 23:13:10 +00007165 */
drh9467abf2016-02-17 18:44:11 +00007166abort_due_to_error:
7167 if( db->mallocFailed ) rc = SQLITE_NOMEM_BKPT;
drha05a7222008-01-19 03:35:58 +00007168 assert( rc );
drh9467abf2016-02-17 18:44:11 +00007169 if( p->zErrMsg==0 && rc!=SQLITE_IOERR_NOMEM ){
7170 sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
7171 }
drha05a7222008-01-19 03:35:58 +00007172 p->rc = rc;
drhf68521c2016-03-21 12:28:02 +00007173 sqlite3SystemError(db, rc);
drha64fa912010-03-04 00:53:32 +00007174 testcase( sqlite3GlobalConfig.xLog!=0 );
7175 sqlite3_log(rc, "statement aborts at %d: [%s] %s",
drhf56fa462015-04-13 21:39:54 +00007176 (int)(pOp - aOp), p->zSql, p->zErrMsg);
drh92f02c32004-09-02 14:57:08 +00007177 sqlite3VdbeHalt(p);
drh4a642b62016-02-05 01:55:27 +00007178 if( rc==SQLITE_IOERR_NOMEM ) sqlite3OomFault(db);
danielk19777eaabcd2008-07-07 14:56:56 +00007179 rc = SQLITE_ERROR;
drhcdf011d2011-04-04 21:25:28 +00007180 if( resetSchemaOnFault>0 ){
drh81028a42012-05-15 18:28:27 +00007181 sqlite3ResetOneSchema(db, resetSchemaOnFault-1);
drhbdaec522011-04-04 00:14:43 +00007182 }
drh900b31e2007-08-28 02:27:51 +00007183
7184 /* This is the only way out of this procedure. We have to
7185 ** release the mutexes on btrees that were acquired at the
7186 ** top. */
7187vdbe_return:
drh77dfd5b2013-08-19 11:15:48 +00007188 testcase( nVmStep>0 );
drh9b47ee32013-08-20 03:13:51 +00007189 p->aCounter[SQLITE_STMTSTATUS_VM_STEP] += (int)nVmStep;
drhbdaec522011-04-04 00:14:43 +00007190 sqlite3VdbeLeave(p);
dan83f0ab82016-01-29 18:04:31 +00007191 assert( rc!=SQLITE_OK || nExtraDelete==0
7192 || sqlite3_strlike("DELETE%",p->zSql,0)!=0
7193 );
drhb86ccfb2003-01-28 23:13:10 +00007194 return rc;
7195
drh023ae032007-05-08 12:12:16 +00007196 /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
7197 ** is encountered.
7198 */
7199too_big:
drh22c17b82015-05-15 04:13:15 +00007200 sqlite3VdbeError(p, "string or blob too big");
drh023ae032007-05-08 12:12:16 +00007201 rc = SQLITE_TOOBIG;
drh9467abf2016-02-17 18:44:11 +00007202 goto abort_due_to_error;
drh023ae032007-05-08 12:12:16 +00007203
drh98640a32007-06-07 19:08:32 +00007204 /* Jump to here if a malloc() fails.
drhb86ccfb2003-01-28 23:13:10 +00007205 */
7206no_mem:
drh4a642b62016-02-05 01:55:27 +00007207 sqlite3OomFault(db);
drh22c17b82015-05-15 04:13:15 +00007208 sqlite3VdbeError(p, "out of memory");
mistachkinfad30392016-02-13 23:43:46 +00007209 rc = SQLITE_NOMEM_BKPT;
drh9467abf2016-02-17 18:44:11 +00007210 goto abort_due_to_error;
drhb86ccfb2003-01-28 23:13:10 +00007211
danielk19776f8a5032004-05-10 10:34:51 +00007212 /* Jump to here if the sqlite3_interrupt() API sets the interrupt
drhb86ccfb2003-01-28 23:13:10 +00007213 ** flag.
7214 */
7215abort_due_to_interrupt:
drh881feaa2006-07-26 01:39:30 +00007216 assert( db->u1.isInterrupted );
mistachkinfad30392016-02-13 23:43:46 +00007217 rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_INTERRUPT;
danielk1977026d2702004-06-14 13:14:59 +00007218 p->rc = rc;
drh22c17b82015-05-15 04:13:15 +00007219 sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
drh9467abf2016-02-17 18:44:11 +00007220 goto abort_due_to_error;
drhb86ccfb2003-01-28 23:13:10 +00007221}