blob: 992fa4db9e1ae8fa13784a8568dc50287d3ff475 [file] [log] [blame]
drh9a324642003-09-06 20:12:01 +00001/*
2** 2003 September 6
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains code used for creating, destroying, and populating
drh7abda852014-09-19 16:02:06 +000013** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)
drh9a324642003-09-06 20:12:01 +000014*/
15#include "sqliteInt.h"
drh9a324642003-09-06 20:12:01 +000016#include "vdbeInt.h"
17
drh9a324642003-09-06 20:12:01 +000018/*
19** Create a new virtual database engine.
20*/
drh9ac79622013-12-18 15:11:47 +000021Vdbe *sqlite3VdbeCreate(Parse *pParse){
22 sqlite3 *db = pParse->db;
drh9a324642003-09-06 20:12:01 +000023 Vdbe *p;
drh17435752007-08-16 04:30:38 +000024 p = sqlite3DbMallocZero(db, sizeof(Vdbe) );
drh9a324642003-09-06 20:12:01 +000025 if( p==0 ) return 0;
26 p->db = db;
27 if( db->pVdbe ){
28 db->pVdbe->pPrev = p;
29 }
30 p->pNext = db->pVdbe;
31 p->pPrev = 0;
32 db->pVdbe = p;
33 p->magic = VDBE_MAGIC_INIT;
drh9ac79622013-12-18 15:11:47 +000034 p->pParse = pParse;
drh73d5b8f2013-12-23 19:09:07 +000035 assert( pParse->aLabel==0 );
36 assert( pParse->nLabel==0 );
37 assert( pParse->nOpAlloc==0 );
drhbd573082016-01-01 16:42:09 +000038 assert( pParse->szOpAlloc==0 );
drh9a324642003-09-06 20:12:01 +000039 return p;
40}
41
42/*
drh22c17b82015-05-15 04:13:15 +000043** Change the error string stored in Vdbe.zErrMsg
44*/
45void sqlite3VdbeError(Vdbe *p, const char *zFormat, ...){
46 va_list ap;
47 sqlite3DbFree(p->db, p->zErrMsg);
48 va_start(ap, zFormat);
49 p->zErrMsg = sqlite3VMPrintf(p->db, zFormat, ap);
50 va_end(ap);
51}
52
53/*
drhb900aaf2006-11-09 00:24:53 +000054** Remember the SQL string for a prepared statement.
55*/
danielk19776ab3a2e2009-02-19 14:39:25 +000056void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, int isPrepareV2){
dan1d2ce4f2009-10-19 18:11:09 +000057 assert( isPrepareV2==1 || isPrepareV2==0 );
drhb900aaf2006-11-09 00:24:53 +000058 if( p==0 ) return;
danac455932012-11-26 19:50:41 +000059#if defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_ENABLE_SQLLOG)
danielk19776ab3a2e2009-02-19 14:39:25 +000060 if( !isPrepareV2 ) return;
61#endif
drhb900aaf2006-11-09 00:24:53 +000062 assert( p->zSql==0 );
drh17435752007-08-16 04:30:38 +000063 p->zSql = sqlite3DbStrNDup(p->db, z, n);
shanef639c402009-11-03 19:42:30 +000064 p->isPrepareV2 = (u8)isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000065}
66
67/*
drhc5155252007-01-08 21:07:17 +000068** Swap all content between two VDBE structures.
drhb900aaf2006-11-09 00:24:53 +000069*/
drhc5155252007-01-08 21:07:17 +000070void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
71 Vdbe tmp, *pTmp;
72 char *zTmp;
drh0639c342011-03-18 12:35:36 +000073 assert( pA->db==pB->db );
drhc5155252007-01-08 21:07:17 +000074 tmp = *pA;
75 *pA = *pB;
76 *pB = tmp;
77 pTmp = pA->pNext;
78 pA->pNext = pB->pNext;
79 pB->pNext = pTmp;
80 pTmp = pA->pPrev;
81 pA->pPrev = pB->pPrev;
82 pB->pPrev = pTmp;
83 zTmp = pA->zSql;
84 pA->zSql = pB->zSql;
85 pB->zSql = zTmp;
danielk19776ab3a2e2009-02-19 14:39:25 +000086 pB->isPrepareV2 = pA->isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000087}
88
drh9a324642003-09-06 20:12:01 +000089/*
dan76ccd892014-08-12 13:38:52 +000090** Resize the Vdbe.aOp array so that it is at least nOp elements larger
drh81e069e2014-08-12 14:29:20 +000091** than its current size. nOp is guaranteed to be less than or equal
92** to 1024/sizeof(Op).
danielk1977ace3eb22006-01-26 10:35:04 +000093**
danielk197700e13612008-11-17 19:18:54 +000094** If an out-of-memory error occurs while resizing the array, return
dan76ccd892014-08-12 13:38:52 +000095** SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
danielk197700e13612008-11-17 19:18:54 +000096** unchanged (this is so that any opcodes already allocated can be
97** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +000098*/
dan76ccd892014-08-12 13:38:52 +000099static int growOpArray(Vdbe *v, int nOp){
drha4e5d582007-10-20 15:41:57 +0000100 VdbeOp *pNew;
drh73d5b8f2013-12-23 19:09:07 +0000101 Parse *p = v->pParse;
dan76ccd892014-08-12 13:38:52 +0000102
drh81e069e2014-08-12 14:29:20 +0000103 /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
104 ** more frequent reallocs and hence provide more opportunities for
105 ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
106 ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
107 ** by the minimum* amount required until the size reaches 512. Normal
108 ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
109 ** size of the op array or add 1KB of space, whichever is smaller. */
dan76ccd892014-08-12 13:38:52 +0000110#ifdef SQLITE_TEST_REALLOC_STRESS
111 int nNew = (p->nOpAlloc>=512 ? p->nOpAlloc*2 : p->nOpAlloc+nOp);
112#else
danielk197700e13612008-11-17 19:18:54 +0000113 int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
dan76ccd892014-08-12 13:38:52 +0000114 UNUSED_PARAMETER(nOp);
115#endif
116
drh81e069e2014-08-12 14:29:20 +0000117 assert( nOp<=(1024/sizeof(Op)) );
dan76ccd892014-08-12 13:38:52 +0000118 assert( nNew>=(p->nOpAlloc+nOp) );
drh73d5b8f2013-12-23 19:09:07 +0000119 pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +0000120 if( pNew ){
drhbd573082016-01-01 16:42:09 +0000121 p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
122 p->nOpAlloc = p->szOpAlloc/sizeof(Op);
drh73d5b8f2013-12-23 19:09:07 +0000123 v->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +0000124 }
mistachkinfad30392016-02-13 23:43:46 +0000125 return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
drh76ff3a02004-09-24 22:32:30 +0000126}
127
drh313619f2013-10-31 20:34:06 +0000128#ifdef SQLITE_DEBUG
129/* This routine is just a convenient place to set a breakpoint that will
130** fire after each opcode is inserted and displayed using
131** "PRAGMA vdbe_addoptrace=on".
132*/
133static void test_addop_breakpoint(void){
134 static int n = 0;
135 n++;
136}
137#endif
138
drh76ff3a02004-09-24 22:32:30 +0000139/*
drh9a324642003-09-06 20:12:01 +0000140** Add a new instruction to the list of instructions current in the
141** VDBE. Return the address of the new instruction.
142**
143** Parameters:
144**
145** p Pointer to the VDBE
146**
147** op The opcode for this instruction
148**
drh66a51672008-01-03 00:01:23 +0000149** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000150**
danielk19774adee202004-05-08 08:23:19 +0000151** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000152** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000153** operand.
154*/
drhd7970352015-11-09 12:33:39 +0000155static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
156 assert( p->pParse->nOpAlloc<=p->nOp );
157 if( growOpArray(p, 1) ) return 1;
158 assert( p->pParse->nOpAlloc>p->nOp );
159 return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
160}
drh66a51672008-01-03 00:01:23 +0000161int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000162 int i;
drh701a0ae2004-02-22 20:05:00 +0000163 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000164
165 i = p->nOp;
drh9a324642003-09-06 20:12:01 +0000166 assert( p->magic==VDBE_MAGIC_INIT );
drhed94af52016-02-01 17:20:08 +0000167 assert( op>=0 && op<0xff );
drh73d5b8f2013-12-23 19:09:07 +0000168 if( p->pParse->nOpAlloc<=i ){
drhd7970352015-11-09 12:33:39 +0000169 return growOp3(p, op, p1, p2, p3);
drh9a324642003-09-06 20:12:01 +0000170 }
danielk197701256832007-04-18 14:24:32 +0000171 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000172 pOp = &p->aOp[i];
drh8df32842008-12-09 02:51:23 +0000173 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000174 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000175 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000176 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000177 pOp->p3 = p3;
178 pOp->p4.p = 0;
179 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000180#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000181 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000182#endif
183#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000184 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh9ac79622013-12-18 15:11:47 +0000185 int jj, kk;
186 Parse *pParse = p->pParse;
187 for(jj=kk=0; jj<SQLITE_N_COLCACHE; jj++){
188 struct yColCache *x = pParse->aColCache + jj;
189 if( x->iLevel>pParse->iCacheLevel || x->iReg==0 ) continue;
190 printf(" r[%d]={%d:%d}", x->iReg, x->iTable, x->iColumn);
191 kk++;
192 }
193 if( kk ) printf("\n");
drhe0962052013-01-29 19:14:31 +0000194 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh313619f2013-10-31 20:34:06 +0000195 test_addop_breakpoint();
drhe0962052013-01-29 19:14:31 +0000196 }
drh9a324642003-09-06 20:12:01 +0000197#endif
drh26c9b5e2008-04-11 14:56:53 +0000198#ifdef VDBE_PROFILE
199 pOp->cycles = 0;
200 pOp->cnt = 0;
201#endif
drh688852a2014-02-17 22:40:43 +0000202#ifdef SQLITE_VDBE_COVERAGE
203 pOp->iSrcLine = 0;
204#endif
drh9a324642003-09-06 20:12:01 +0000205 return i;
206}
drh66a51672008-01-03 00:01:23 +0000207int sqlite3VdbeAddOp0(Vdbe *p, int op){
208 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
209}
210int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
211 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
212}
213int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
214 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000215}
216
drh076e85f2015-09-03 13:46:12 +0000217/* Generate code for an unconditional jump to instruction iDest
218*/
219int sqlite3VdbeGoto(Vdbe *p, int iDest){
drh2991ba02015-09-02 18:19:00 +0000220 return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
221}
drh701a0ae2004-02-22 20:05:00 +0000222
drh076e85f2015-09-03 13:46:12 +0000223/* Generate code to cause the string zStr to be loaded into
224** register iDest
225*/
226int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
227 return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
228}
229
230/*
231** Generate code that initializes multiple registers to string or integer
232** constants. The registers begin with iDest and increase consecutively.
233** One register is initialized for each characgter in zTypes[]. For each
234** "s" character in zTypes[], the register is a string if the argument is
235** not NULL, or OP_Null if the value is a null pointer. For each "i" character
236** in zTypes[], the register is initialized to an integer.
237*/
238void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
239 va_list ap;
240 int i;
241 char c;
242 va_start(ap, zTypes);
243 for(i=0; (c = zTypes[i])!=0; i++){
244 if( c=='s' ){
245 const char *z = va_arg(ap, const char*);
drh2ce18652016-01-16 20:50:21 +0000246 sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest++, 0, z, 0);
drh076e85f2015-09-03 13:46:12 +0000247 }else{
248 assert( c=='i' );
249 sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest++);
250 }
251 }
252 va_end(ap);
253}
drh66a51672008-01-03 00:01:23 +0000254
drh701a0ae2004-02-22 20:05:00 +0000255/*
drh66a51672008-01-03 00:01:23 +0000256** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000257*/
drh66a51672008-01-03 00:01:23 +0000258int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000259 Vdbe *p, /* Add the opcode to this VM */
260 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000261 int p1, /* The P1 operand */
262 int p2, /* The P2 operand */
263 int p3, /* The P3 operand */
264 const char *zP4, /* The P4 operand */
265 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000266){
drh66a51672008-01-03 00:01:23 +0000267 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
268 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000269 return addr;
270}
271
272/*
drh7cc023c2015-09-03 04:28:25 +0000273** Add an opcode that includes the p4 value with a P4_INT64 or
274** P4_REAL type.
drh97bae792015-06-05 15:59:57 +0000275*/
276int sqlite3VdbeAddOp4Dup8(
277 Vdbe *p, /* Add the opcode to this VM */
278 int op, /* The new opcode */
279 int p1, /* The P1 operand */
280 int p2, /* The P2 operand */
281 int p3, /* The P3 operand */
282 const u8 *zP4, /* The P4 operand */
283 int p4type /* P4 operand type */
284){
drh575fad62016-02-05 13:38:36 +0000285 char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
drh97bae792015-06-05 15:59:57 +0000286 if( p4copy ) memcpy(p4copy, zP4, 8);
287 return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
288}
289
290/*
drh5d9c9da2011-06-03 20:11:17 +0000291** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000292** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
293** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000294**
295** The zWhere string must have been obtained from sqlite3_malloc().
296** This routine will take ownership of the allocated memory.
297*/
298void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
299 int j;
drh00dceca2016-01-11 22:58:50 +0000300 sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
drh5d9c9da2011-06-03 20:11:17 +0000301 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
302}
303
304/*
drh8cff69d2009-11-12 19:59:44 +0000305** Add an opcode that includes the p4 value as an integer.
306*/
307int sqlite3VdbeAddOp4Int(
308 Vdbe *p, /* Add the opcode to this VM */
309 int op, /* The new opcode */
310 int p1, /* The P1 operand */
311 int p2, /* The P2 operand */
312 int p3, /* The P3 operand */
313 int p4 /* The P4 operand as an integer */
314){
315 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
316 sqlite3VdbeChangeP4(p, addr, SQLITE_INT_TO_PTR(p4), P4_INT32);
317 return addr;
318}
319
drh2fade2f2016-02-09 02:12:20 +0000320/* Insert the end of a co-routine
321*/
322void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
323 sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
324
325 /* Clear the temporary register cache, thereby ensuring that each
326 ** co-routine has its own independent set of registers, because co-routines
327 ** might expect their registers to be preserved across an OP_Yield, and
328 ** that could cause problems if two or more co-routines are using the same
329 ** temporary register.
330 */
331 v->pParse->nTempReg = 0;
332 v->pParse->nRangeReg = 0;
333}
334
drh8cff69d2009-11-12 19:59:44 +0000335/*
drh9a324642003-09-06 20:12:01 +0000336** Create a new symbolic label for an instruction that has yet to be
337** coded. The symbolic label is really just a negative number. The
338** label can be used as the P2 value of an operation. Later, when
339** the label is resolved to a specific address, the VDBE will scan
340** through its operation list and change all values of P2 which match
341** the label into the resolved address.
342**
343** The VDBE knows that a P2 value is a label because labels are
344** always negative and P2 values are suppose to be non-negative.
345** Hence, a negative P2 value is a label that has yet to be resolved.
danielk1977b5548a82004-06-26 13:51:33 +0000346**
347** Zero is returned if a malloc() fails.
drh9a324642003-09-06 20:12:01 +0000348*/
drh73d5b8f2013-12-23 19:09:07 +0000349int sqlite3VdbeMakeLabel(Vdbe *v){
350 Parse *p = v->pParse;
drhc35f3d52012-02-01 19:03:38 +0000351 int i = p->nLabel++;
drh73d5b8f2013-12-23 19:09:07 +0000352 assert( v->magic==VDBE_MAGIC_INIT );
drhc35f3d52012-02-01 19:03:38 +0000353 if( (i & (i-1))==0 ){
354 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
355 (i*2+1)*sizeof(p->aLabel[0]));
drh9a324642003-09-06 20:12:01 +0000356 }
drh76ff3a02004-09-24 22:32:30 +0000357 if( p->aLabel ){
358 p->aLabel[i] = -1;
drh9a324642003-09-06 20:12:01 +0000359 }
drh5ef09bf2015-12-09 17:23:12 +0000360 return ADDR(i);
drh9a324642003-09-06 20:12:01 +0000361}
362
363/*
364** Resolve label "x" to be the address of the next instruction to
365** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000366** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000367*/
drh73d5b8f2013-12-23 19:09:07 +0000368void sqlite3VdbeResolveLabel(Vdbe *v, int x){
369 Parse *p = v->pParse;
drh5ef09bf2015-12-09 17:23:12 +0000370 int j = ADDR(x);
drh73d5b8f2013-12-23 19:09:07 +0000371 assert( v->magic==VDBE_MAGIC_INIT );
drhb2b9d3d2013-08-01 01:14:43 +0000372 assert( j<p->nLabel );
drhef41dfe2015-09-02 17:55:12 +0000373 assert( j>=0 );
374 if( p->aLabel ){
drh73d5b8f2013-12-23 19:09:07 +0000375 p->aLabel[j] = v->nOp;
drh9a324642003-09-06 20:12:01 +0000376 }
drh61019c72014-01-04 16:49:02 +0000377 p->iFixedOp = v->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000378}
379
drh4611d922010-02-25 14:47:01 +0000380/*
381** Mark the VDBE as one that can only be run one time.
382*/
383void sqlite3VdbeRunOnlyOnce(Vdbe *p){
384 p->runOnlyOnce = 1;
385}
386
drhf71a3662016-03-16 20:44:45 +0000387/*
388** Mark the VDBE as one that can only be run multiple times.
389*/
390void sqlite3VdbeReusable(Vdbe *p){
391 p->runOnlyOnce = 0;
392}
393
drhff738bc2009-09-24 00:09:58 +0000394#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000395
396/*
397** The following type and function are used to iterate through all opcodes
398** in a Vdbe main program and each of the sub-programs (triggers) it may
399** invoke directly or indirectly. It should be used as follows:
400**
401** Op *pOp;
402** VdbeOpIter sIter;
403**
404** memset(&sIter, 0, sizeof(sIter));
405** sIter.v = v; // v is of type Vdbe*
406** while( (pOp = opIterNext(&sIter)) ){
407** // Do something with pOp
408** }
409** sqlite3DbFree(v->db, sIter.apSub);
410**
411*/
412typedef struct VdbeOpIter VdbeOpIter;
413struct VdbeOpIter {
414 Vdbe *v; /* Vdbe to iterate through the opcodes of */
415 SubProgram **apSub; /* Array of subprograms */
416 int nSub; /* Number of entries in apSub */
417 int iAddr; /* Address of next instruction to return */
418 int iSub; /* 0 = main program, 1 = first sub-program etc. */
419};
420static Op *opIterNext(VdbeOpIter *p){
421 Vdbe *v = p->v;
422 Op *pRet = 0;
423 Op *aOp;
424 int nOp;
425
426 if( p->iSub<=p->nSub ){
427
428 if( p->iSub==0 ){
429 aOp = v->aOp;
430 nOp = v->nOp;
431 }else{
432 aOp = p->apSub[p->iSub-1]->aOp;
433 nOp = p->apSub[p->iSub-1]->nOp;
434 }
435 assert( p->iAddr<nOp );
436
437 pRet = &aOp[p->iAddr];
438 p->iAddr++;
439 if( p->iAddr==nOp ){
440 p->iSub++;
441 p->iAddr = 0;
442 }
443
444 if( pRet->p4type==P4_SUBPROGRAM ){
445 int nByte = (p->nSub+1)*sizeof(SubProgram*);
446 int j;
447 for(j=0; j<p->nSub; j++){
448 if( p->apSub[j]==pRet->p4.pProgram ) break;
449 }
450 if( j==p->nSub ){
451 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
452 if( !p->apSub ){
453 pRet = 0;
454 }else{
455 p->apSub[p->nSub++] = pRet->p4.pProgram;
456 }
457 }
458 }
459 }
460
461 return pRet;
462}
463
464/*
danf3677212009-09-10 16:14:50 +0000465** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000466** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000467** to be rolled back). This condition is true if the main program or any
468** sub-programs contains any of the following:
469**
470** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
471** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
472** * OP_Destroy
473** * OP_VUpdate
474** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000475** * OP_FkCounter with P2==0 (immediate foreign key constraint)
drh0dd5cda2015-06-16 16:39:01 +0000476** * OP_CreateTable and OP_InitCoroutine (for CREATE TABLE AS SELECT ...)
dan144926d2009-09-09 11:37:20 +0000477**
danf3677212009-09-10 16:14:50 +0000478** Then check that the value of Parse.mayAbort is true if an
479** ABORT may be thrown, or false otherwise. Return true if it does
480** match, or false otherwise. This function is intended to be used as
481** part of an assert statement in the compiler. Similar to:
482**
483** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000484*/
danf3677212009-09-10 16:14:50 +0000485int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
486 int hasAbort = 0;
dan04668832014-12-16 20:13:30 +0000487 int hasFkCounter = 0;
drh0dd5cda2015-06-16 16:39:01 +0000488 int hasCreateTable = 0;
489 int hasInitCoroutine = 0;
dan144926d2009-09-09 11:37:20 +0000490 Op *pOp;
491 VdbeOpIter sIter;
492 memset(&sIter, 0, sizeof(sIter));
493 sIter.v = v;
494
495 while( (pOp = opIterNext(&sIter))!=0 ){
496 int opcode = pOp->opcode;
497 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
498 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drhd91c1a12013-02-09 13:58:25 +0000499 && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000500 ){
danf3677212009-09-10 16:14:50 +0000501 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000502 break;
503 }
drh0dd5cda2015-06-16 16:39:01 +0000504 if( opcode==OP_CreateTable ) hasCreateTable = 1;
505 if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
dan04668832014-12-16 20:13:30 +0000506#ifndef SQLITE_OMIT_FOREIGN_KEY
507 if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
508 hasFkCounter = 1;
509 }
510#endif
dan144926d2009-09-09 11:37:20 +0000511 }
dan144926d2009-09-09 11:37:20 +0000512 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000513
mistachkin48864df2013-03-21 21:20:32 +0000514 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000515 ** If malloc failed, then the while() loop above may not have iterated
516 ** through all opcodes and hasAbort may be set incorrectly. Return
517 ** true for this case to prevent the assert() in the callers frame
518 ** from failing. */
drh0dd5cda2015-06-16 16:39:01 +0000519 return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
520 || (hasCreateTable && hasInitCoroutine) );
dan144926d2009-09-09 11:37:20 +0000521}
drhff738bc2009-09-24 00:09:58 +0000522#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000523
drh9a324642003-09-06 20:12:01 +0000524/*
drhef41dfe2015-09-02 17:55:12 +0000525** This routine is called after all opcodes have been inserted. It loops
526** through all the opcodes and fixes up some details.
drh76ff3a02004-09-24 22:32:30 +0000527**
drhef41dfe2015-09-02 17:55:12 +0000528** (1) For each jump instruction with a negative P2 value (a label)
529** resolve the P2 value to an actual address.
danielk1977634f2982005-03-28 08:44:07 +0000530**
drhef41dfe2015-09-02 17:55:12 +0000531** (2) Compute the maximum number of arguments used by any SQL function
532** and store that value in *pMaxFuncArgs.
drha6c2ed92009-11-14 23:22:23 +0000533**
drhef41dfe2015-09-02 17:55:12 +0000534** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
535** indicate what the prepared statement actually does.
536**
537** (4) Initialize the p4.xAdvance pointer on opcodes that use it.
538**
539** (5) Reclaim the memory allocated for storing labels.
drh7cc84c22016-04-11 13:36:42 +0000540**
541** This routine will only function correctly if the mkopcodeh.tcl generator
542** script numbers the opcodes correctly. Changes to this routine must be
543** coordinated with changes to mkopcodeh.tcl.
drh76ff3a02004-09-24 22:32:30 +0000544*/
drh9cbf3422008-01-17 16:22:13 +0000545static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
dan165921a2009-08-28 18:53:45 +0000546 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000547 Op *pOp;
drh73d5b8f2013-12-23 19:09:07 +0000548 Parse *pParse = p->pParse;
549 int *aLabel = pParse->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000550 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000551 p->bIsReader = 0;
drh7cc84c22016-04-11 13:36:42 +0000552 pOp = &p->aOp[p->nOp-1];
553 while(1){
danielk1977634f2982005-03-28 08:44:07 +0000554
drh7cc84c22016-04-11 13:36:42 +0000555 /* Only JUMP opcodes and the short list of special opcodes in the switch
556 ** below need to be considered. The mkopcodeh.tcl generator script groups
557 ** all these opcodes together near the front of the opcode list. Skip
558 ** any opcode that does not need processing by virtual of the fact that
drhc310db32016-04-11 16:35:05 +0000559 ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
drh7cc84c22016-04-11 13:36:42 +0000560 */
drhc310db32016-04-11 16:35:05 +0000561 if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
drh7cc84c22016-04-11 13:36:42 +0000562 /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
563 ** cases from this switch! */
564 switch( pOp->opcode ){
565 case OP_Transaction: {
566 if( pOp->p2!=0 ) p->readOnly = 0;
567 /* fall thru */
568 }
569 case OP_AutoCommit:
570 case OP_Savepoint: {
571 p->bIsReader = 1;
572 break;
573 }
dand9031542013-07-05 16:54:30 +0000574#ifndef SQLITE_OMIT_WAL
drh7cc84c22016-04-11 13:36:42 +0000575 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000576#endif
drh7cc84c22016-04-11 13:36:42 +0000577 case OP_Vacuum:
578 case OP_JournalMode: {
579 p->readOnly = 0;
580 p->bIsReader = 1;
581 break;
582 }
danielk1977182c4ba2007-06-27 15:53:34 +0000583#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7cc84c22016-04-11 13:36:42 +0000584 case OP_VUpdate: {
585 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
586 break;
587 }
588 case OP_VFilter: {
589 int n;
590 assert( (pOp - p->aOp) >= 3 );
591 assert( pOp[-1].opcode==OP_Integer );
592 n = pOp[-1].p1;
593 if( n>nMaxArgs ) nMaxArgs = n;
594 break;
595 }
danielk1977182c4ba2007-06-27 15:53:34 +0000596#endif
drh7cc84c22016-04-11 13:36:42 +0000597 case OP_Next:
598 case OP_NextIfOpen:
599 case OP_SorterNext: {
600 pOp->p4.xAdvance = sqlite3BtreeNext;
601 pOp->p4type = P4_ADVANCE;
602 break;
603 }
604 case OP_Prev:
605 case OP_PrevIfOpen: {
606 pOp->p4.xAdvance = sqlite3BtreePrevious;
607 pOp->p4type = P4_ADVANCE;
608 break;
609 }
drh8c8a8c42013-08-06 07:45:08 +0000610 }
drh7cc84c22016-04-11 13:36:42 +0000611 if( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 && pOp->p2<0 ){
612 assert( ADDR(pOp->p2)<pParse->nLabel );
613 pOp->p2 = aLabel[ADDR(pOp->p2)];
drh8c8a8c42013-08-06 07:45:08 +0000614 }
danielk1977bc04f852005-03-29 08:26:13 +0000615 }
drh7cc84c22016-04-11 13:36:42 +0000616 if( pOp==p->aOp ) break;
617 pOp--;
drh76ff3a02004-09-24 22:32:30 +0000618 }
drh73d5b8f2013-12-23 19:09:07 +0000619 sqlite3DbFree(p->db, pParse->aLabel);
620 pParse->aLabel = 0;
621 pParse->nLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000622 *pMaxFuncArgs = nMaxArgs;
drha7ab6d82014-07-21 15:44:39 +0000623 assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
drh76ff3a02004-09-24 22:32:30 +0000624}
625
626/*
drh9a324642003-09-06 20:12:01 +0000627** Return the address of the next instruction to be inserted.
628*/
danielk19774adee202004-05-08 08:23:19 +0000629int sqlite3VdbeCurrentAddr(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000630 assert( p->magic==VDBE_MAGIC_INIT );
631 return p->nOp;
632}
633
dan65a7cd12009-09-01 12:16:01 +0000634/*
drh2ce18652016-01-16 20:50:21 +0000635** Verify that at least N opcode slots are available in p without
drhdad300d2016-01-18 00:20:26 +0000636** having to malloc for more space (except when compiled using
637** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
638** to verify that certain calls to sqlite3VdbeAddOpList() can never
639** fail due to a OOM fault and hence that the return value from
640** sqlite3VdbeAddOpList() will always be non-NULL.
drh2ce18652016-01-16 20:50:21 +0000641*/
drhdad300d2016-01-18 00:20:26 +0000642#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
643void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
drh2ce18652016-01-16 20:50:21 +0000644 assert( p->nOp + N <= p->pParse->nOpAlloc );
645}
646#endif
647
648/*
dan65a7cd12009-09-01 12:16:01 +0000649** This function returns a pointer to the array of opcodes associated with
650** the Vdbe passed as the first argument. It is the callers responsibility
651** to arrange for the returned array to be eventually freed using the
652** vdbeFreeOpArray() function.
653**
654** Before returning, *pnOp is set to the number of entries in the returned
655** array. Also, *pnMaxArg is set to the larger of its current value and
656** the number of entries in the Vdbe.apArg[] array required to execute the
657** returned program.
658*/
dan165921a2009-08-28 18:53:45 +0000659VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
660 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +0000661 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +0000662
663 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drha7ab6d82014-07-21 15:44:39 +0000664 assert( DbMaskAllZero(p->btreeMask) );
dan65a7cd12009-09-01 12:16:01 +0000665
dan165921a2009-08-28 18:53:45 +0000666 resolveP2Values(p, pnMaxArg);
667 *pnOp = p->nOp;
668 p->aOp = 0;
669 return aOp;
670}
671
drh9a324642003-09-06 20:12:01 +0000672/*
drh2ce18652016-01-16 20:50:21 +0000673** Add a whole list of operations to the operation stack. Return a
674** pointer to the first operation inserted.
drh1b325542016-02-03 01:55:44 +0000675**
676** Non-zero P2 arguments to jump instructions are automatically adjusted
677** so that the jump target is relative to the first operation inserted.
drh9a324642003-09-06 20:12:01 +0000678*/
drh2ce18652016-01-16 20:50:21 +0000679VdbeOp *sqlite3VdbeAddOpList(
680 Vdbe *p, /* Add opcodes to the prepared statement */
681 int nOp, /* Number of opcodes to add */
682 VdbeOpList const *aOp, /* The opcodes to be added */
683 int iLineno /* Source-file line number of first opcode */
684){
685 int i;
686 VdbeOp *pOut, *pFirst;
drhef41dfe2015-09-02 17:55:12 +0000687 assert( nOp>0 );
drh9a324642003-09-06 20:12:01 +0000688 assert( p->magic==VDBE_MAGIC_INIT );
dan76ccd892014-08-12 13:38:52 +0000689 if( p->nOp + nOp > p->pParse->nOpAlloc && growOpArray(p, nOp) ){
drh76ff3a02004-09-24 22:32:30 +0000690 return 0;
drh9a324642003-09-06 20:12:01 +0000691 }
drh2ce18652016-01-16 20:50:21 +0000692 pFirst = pOut = &p->aOp[p->nOp];
drhef41dfe2015-09-02 17:55:12 +0000693 for(i=0; i<nOp; i++, aOp++, pOut++){
drhef41dfe2015-09-02 17:55:12 +0000694 pOut->opcode = aOp->opcode;
695 pOut->p1 = aOp->p1;
drh5ef09bf2015-12-09 17:23:12 +0000696 pOut->p2 = aOp->p2;
697 assert( aOp->p2>=0 );
drh1b325542016-02-03 01:55:44 +0000698 if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
699 pOut->p2 += p->nOp;
700 }
drhef41dfe2015-09-02 17:55:12 +0000701 pOut->p3 = aOp->p3;
702 pOut->p4type = P4_NOTUSED;
703 pOut->p4.p = 0;
704 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +0000705#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhef41dfe2015-09-02 17:55:12 +0000706 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000707#endif
drh688852a2014-02-17 22:40:43 +0000708#ifdef SQLITE_VDBE_COVERAGE
drhef41dfe2015-09-02 17:55:12 +0000709 pOut->iSrcLine = iLineno+i;
drh688852a2014-02-17 22:40:43 +0000710#else
drhef41dfe2015-09-02 17:55:12 +0000711 (void)iLineno;
drh688852a2014-02-17 22:40:43 +0000712#endif
drhc7379ce2013-10-30 02:28:23 +0000713#ifdef SQLITE_DEBUG
drhef41dfe2015-09-02 17:55:12 +0000714 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh2ce18652016-01-16 20:50:21 +0000715 sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
drh9a324642003-09-06 20:12:01 +0000716 }
drhef41dfe2015-09-02 17:55:12 +0000717#endif
drh9a324642003-09-06 20:12:01 +0000718 }
drhef41dfe2015-09-02 17:55:12 +0000719 p->nOp += nOp;
drh2ce18652016-01-16 20:50:21 +0000720 return pFirst;
drh9a324642003-09-06 20:12:01 +0000721}
722
dan6f9702e2014-11-01 20:38:06 +0000723#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
724/*
725** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
726*/
dan037b5322014-11-03 11:25:32 +0000727void sqlite3VdbeScanStatus(
dan6f9702e2014-11-01 20:38:06 +0000728 Vdbe *p, /* VM to add scanstatus() to */
729 int addrExplain, /* Address of OP_Explain (or 0) */
730 int addrLoop, /* Address of loop counter */
731 int addrVisit, /* Address of rows visited counter */
drh518140e2014-11-06 03:55:10 +0000732 LogEst nEst, /* Estimated number of output rows */
dan6f9702e2014-11-01 20:38:06 +0000733 const char *zName /* Name of table or index being scanned */
734){
dan037b5322014-11-03 11:25:32 +0000735 int nByte = (p->nScan+1) * sizeof(ScanStatus);
736 ScanStatus *aNew;
737 aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
dan6f9702e2014-11-01 20:38:06 +0000738 if( aNew ){
dan037b5322014-11-03 11:25:32 +0000739 ScanStatus *pNew = &aNew[p->nScan++];
dan6f9702e2014-11-01 20:38:06 +0000740 pNew->addrExplain = addrExplain;
741 pNew->addrLoop = addrLoop;
742 pNew->addrVisit = addrVisit;
743 pNew->nEst = nEst;
744 pNew->zName = sqlite3DbStrDup(p->db, zName);
745 p->aScan = aNew;
746 }
747}
748#endif
749
750
drh9a324642003-09-06 20:12:01 +0000751/*
drh0ff287f2015-09-02 18:40:33 +0000752** Change the value of the opcode, or P1, P2, P3, or P5 operands
753** for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000754*/
drh0ff287f2015-09-02 18:40:33 +0000755void sqlite3VdbeChangeOpcode(Vdbe *p, u32 addr, u8 iNewOpcode){
756 sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
757}
drh88caeac2011-08-24 15:12:08 +0000758void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000759 sqlite3VdbeGetOp(p,addr)->p1 = val;
drh9a324642003-09-06 20:12:01 +0000760}
drh88caeac2011-08-24 15:12:08 +0000761void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000762 sqlite3VdbeGetOp(p,addr)->p2 = val;
drh9a324642003-09-06 20:12:01 +0000763}
drh88caeac2011-08-24 15:12:08 +0000764void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000765 sqlite3VdbeGetOp(p,addr)->p3 = val;
danielk1977207872a2008-01-03 07:54:23 +0000766}
drh0ff287f2015-09-02 18:40:33 +0000767void sqlite3VdbeChangeP5(Vdbe *p, u8 p5){
drh9b34abe2016-01-16 15:12:35 +0000768 if( !p->db->mallocFailed ) p->aOp[p->nOp-1].p5 = p5;
danielk19771f4aa332008-01-03 09:51:55 +0000769}
770
771/*
drhf8875402006-03-17 13:56:34 +0000772** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +0000773** the address of the next instruction to be coded.
774*/
775void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drh61019c72014-01-04 16:49:02 +0000776 p->pParse->iFixedOp = p->nOp - 1;
drh0ff287f2015-09-02 18:40:33 +0000777 sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +0000778}
drhb38ad992005-09-16 00:27:01 +0000779
drhb7f6f682006-07-08 17:06:43 +0000780
781/*
782** If the input FuncDef structure is ephemeral, then free it. If
783** the FuncDef is not ephermal, then do nothing.
784*/
drh633e6d52008-07-28 19:34:53 +0000785static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drhf431a872016-05-20 15:53:47 +0000786 if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh633e6d52008-07-28 19:34:53 +0000787 sqlite3DbFree(db, pDef);
drhb7f6f682006-07-08 17:06:43 +0000788 }
789}
790
dand46def72010-07-24 11:28:28 +0000791static void vdbeFreeOpArray(sqlite3 *, Op *, int);
792
drhb38ad992005-09-16 00:27:01 +0000793/*
drh66a51672008-01-03 00:01:23 +0000794** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +0000795*/
drhf431a872016-05-20 15:53:47 +0000796static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
797 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
798 sqlite3DbFree(db, p);
799}
800static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
801 freeEphemeralFunction(db, p->pFunc);
802 sqlite3DbFree(db, p);
803}
drh633e6d52008-07-28 19:34:53 +0000804static void freeP4(sqlite3 *db, int p4type, void *p4){
drhbe5000d2016-04-07 14:05:20 +0000805 assert( db );
806 switch( p4type ){
807 case P4_FUNCCTX: {
drhf431a872016-05-20 15:53:47 +0000808 freeP4FuncCtx(db, (sqlite3_context*)p4);
809 break;
drhbe5000d2016-04-07 14:05:20 +0000810 }
811 case P4_REAL:
812 case P4_INT64:
813 case P4_DYNAMIC:
814 case P4_INTARRAY: {
815 sqlite3DbFree(db, p4);
816 break;
817 }
818 case P4_KEYINFO: {
819 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
820 break;
821 }
drh28935362013-12-07 20:39:19 +0000822#ifdef SQLITE_ENABLE_CURSOR_HINTS
drhbe5000d2016-04-07 14:05:20 +0000823 case P4_EXPR: {
824 sqlite3ExprDelete(db, (Expr*)p4);
825 break;
826 }
drh28935362013-12-07 20:39:19 +0000827#endif
drhbe5000d2016-04-07 14:05:20 +0000828 case P4_MPRINTF: {
829 if( db->pnBytesFreed==0 ) sqlite3_free(p4);
830 break;
831 }
832 case P4_FUNCDEF: {
833 freeEphemeralFunction(db, (FuncDef*)p4);
834 break;
835 }
836 case P4_MEM: {
837 if( db->pnBytesFreed==0 ){
838 sqlite3ValueFree((sqlite3_value*)p4);
839 }else{
drhf431a872016-05-20 15:53:47 +0000840 freeP4Mem(db, (Mem*)p4);
drhb9755982010-07-24 16:34:37 +0000841 }
drhbe5000d2016-04-07 14:05:20 +0000842 break;
843 }
844 case P4_VTAB : {
845 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
846 break;
drhb38ad992005-09-16 00:27:01 +0000847 }
848 }
849}
850
dan65a7cd12009-09-01 12:16:01 +0000851/*
852** Free the space allocated for aOp and any p4 values allocated for the
853** opcodes contained within. If aOp is not NULL it is assumed to contain
854** nOp entries.
855*/
dan165921a2009-08-28 18:53:45 +0000856static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
857 if( aOp ){
858 Op *pOp;
859 for(pOp=aOp; pOp<&aOp[nOp]; pOp++){
drh00dceca2016-01-11 22:58:50 +0000860 if( pOp->p4type ) freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +0000861#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +0000862 sqlite3DbFree(db, pOp->zComment);
863#endif
864 }
865 }
866 sqlite3DbFree(db, aOp);
867}
868
dan65a7cd12009-09-01 12:16:01 +0000869/*
dand19c9332010-07-26 12:05:17 +0000870** Link the SubProgram object passed as the second argument into the linked
871** list at Vdbe.pSubProgram. This list is used to delete all sub-program
872** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +0000873*/
dand19c9332010-07-26 12:05:17 +0000874void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
875 p->pNext = pVdbe->pProgram;
876 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +0000877}
878
drh9a324642003-09-06 20:12:01 +0000879/*
drh48f2d3b2011-09-16 01:34:43 +0000880** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +0000881*/
drh2ce18652016-01-16 20:50:21 +0000882int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
883 VdbeOp *pOp;
884 if( p->db->mallocFailed ) return 0;
885 assert( addr>=0 && addr<p->nOp );
886 pOp = &p->aOp[addr];
887 freeP4(p->db, pOp->p4type, pOp->p4.p);
drh4b31bda2016-01-20 02:01:02 +0000888 pOp->p4type = P4_NOTUSED;
drh939e7782016-01-20 02:36:12 +0000889 pOp->p4.z = 0;
drh2ce18652016-01-16 20:50:21 +0000890 pOp->opcode = OP_Noop;
891 return 1;
drhf8875402006-03-17 13:56:34 +0000892}
893
894/*
drh39c4b822014-09-29 15:42:01 +0000895** If the last opcode is "op" and it is not a jump destination,
896** then remove it. Return true if and only if an opcode was removed.
drh762c1c42014-01-02 19:35:30 +0000897*/
drh61019c72014-01-04 16:49:02 +0000898int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
899 if( (p->nOp-1)>(p->pParse->iFixedOp) && p->aOp[p->nOp-1].opcode==op ){
drh2ce18652016-01-16 20:50:21 +0000900 return sqlite3VdbeChangeToNoop(p, p->nOp-1);
drh61019c72014-01-04 16:49:02 +0000901 }else{
902 return 0;
903 }
drh762c1c42014-01-02 19:35:30 +0000904}
905
906/*
drh66a51672008-01-03 00:01:23 +0000907** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000908** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000909** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000910** few minor changes to the program.
911**
drh66a51672008-01-03 00:01:23 +0000912** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +0000913** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +0000914** A value of n==0 means copy bytes of zP4 up to and including the
915** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +0000916**
drh66a51672008-01-03 00:01:23 +0000917** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +0000918** to a string or structure that is guaranteed to exist for the lifetime of
919** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +0000920**
drh66a51672008-01-03 00:01:23 +0000921** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +0000922*/
drh00dceca2016-01-11 22:58:50 +0000923static void SQLITE_NOINLINE vdbeChangeP4Full(
924 Vdbe *p,
925 Op *pOp,
926 const char *zP4,
927 int n
928){
929 if( pOp->p4type ){
930 freeP4(p->db, pOp->p4type, pOp->p4.p);
931 pOp->p4type = 0;
932 pOp->p4.p = 0;
933 }
934 if( n<0 ){
935 sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
936 }else{
937 if( n==0 ) n = sqlite3Strlen30(zP4);
938 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
939 pOp->p4type = P4_DYNAMIC;
940 }
941}
drh66a51672008-01-03 00:01:23 +0000942void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +0000943 Op *pOp;
drh633e6d52008-07-28 19:34:53 +0000944 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +0000945 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +0000946 db = p->db;
drh91fd4d42008-01-19 20:11:25 +0000947 assert( p->magic==VDBE_MAGIC_INIT );
drh00dceca2016-01-11 22:58:50 +0000948 assert( p->aOp!=0 || db->mallocFailed );
949 if( db->mallocFailed ){
950 if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
danielk1977d5d56522005-03-16 12:15:20 +0000951 return;
952 }
drh7b746032009-06-26 12:15:22 +0000953 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +0000954 assert( addr<p->nOp );
955 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +0000956 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000957 }
958 pOp = &p->aOp[addr];
drh00dceca2016-01-11 22:58:50 +0000959 if( n>=0 || pOp->p4type ){
960 vdbeChangeP4Full(p, pOp, zP4, n);
961 return;
962 }
drh98757152008-01-09 23:04:12 +0000963 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +0000964 /* Note: this cast is safe, because the origin data point was an int
965 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +0000966 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +0000967 pOp->p4type = P4_INT32;
drh00dceca2016-01-11 22:58:50 +0000968 }else if( zP4!=0 ){
969 assert( n<0 );
danielk19772dca4ac2008-01-03 11:50:29 +0000970 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +0000971 pOp->p4type = (signed char)n;
drh00dceca2016-01-11 22:58:50 +0000972 if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
drh9a324642003-09-06 20:12:01 +0000973 }
974}
975
drh2ec2fb22013-11-06 19:59:23 +0000976/*
977** Set the P4 on the most recently added opcode to the KeyInfo for the
978** index given.
979*/
980void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
981 Vdbe *v = pParse->pVdbe;
982 assert( v!=0 );
983 assert( pIdx!=0 );
984 sqlite3VdbeChangeP4(v, -1, (char*)sqlite3KeyInfoOfIndex(pParse, pIdx),
985 P4_KEYINFO);
986}
987
drhc7379ce2013-10-30 02:28:23 +0000988#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +0000989/*
mistachkind5578432012-08-25 10:01:29 +0000990** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +0000991** insert a No-op and add the comment to that new instruction. This
992** makes the code easier to read during debugging. None of this happens
993** in a production build.
drhad6d9462004-09-19 02:15:24 +0000994*/
drhb07028f2011-10-14 21:49:18 +0000995static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +0000996 assert( p->nOp>0 || p->aOp==0 );
drhd4e70eb2008-01-02 00:34:36 +0000997 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
danielk1977dba01372008-01-05 18:44:29 +0000998 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +0000999 assert( p->aOp );
1000 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
1001 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
1002 }
1003}
1004void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
1005 va_list ap;
1006 if( p ){
danielk1977dba01372008-01-05 18:44:29 +00001007 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001008 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +00001009 va_end(ap);
1010 }
drhad6d9462004-09-19 02:15:24 +00001011}
drh16ee60f2008-06-20 18:13:25 +00001012void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
1013 va_list ap;
drhb07028f2011-10-14 21:49:18 +00001014 if( p ){
1015 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +00001016 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001017 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +00001018 va_end(ap);
1019 }
1020}
1021#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +00001022
drh688852a2014-02-17 22:40:43 +00001023#ifdef SQLITE_VDBE_COVERAGE
1024/*
1025** Set the value if the iSrcLine field for the previously coded instruction.
1026*/
1027void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
1028 sqlite3VdbeGetOp(v,-1)->iSrcLine = iLine;
1029}
1030#endif /* SQLITE_VDBE_COVERAGE */
1031
drh9a324642003-09-06 20:12:01 +00001032/*
drh20411ea2009-05-29 19:00:12 +00001033** Return the opcode for a given address. If the address is -1, then
1034** return the most recently inserted opcode.
1035**
1036** If a memory allocation error has occurred prior to the calling of this
1037** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +00001038** is readable but not writable, though it is cast to a writable value.
1039** The return of a dummy opcode allows the call to continue functioning
peter.d.reid60ec9142014-09-06 16:39:46 +00001040** after an OOM fault without having to check to see if the return from
drhf83dc1e2010-06-03 12:09:52 +00001041** this routine is a valid pointer. But because the dummy.opcode is 0,
1042** dummy will never be written to. This is verified by code inspection and
1043** by running with Valgrind.
drh9a324642003-09-06 20:12:01 +00001044*/
danielk19774adee202004-05-08 08:23:19 +00001045VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +00001046 /* C89 specifies that the constant "dummy" will be initialized to all
1047 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +00001048 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh9a324642003-09-06 20:12:01 +00001049 assert( p->magic==VDBE_MAGIC_INIT );
drh37b89a02009-06-19 00:33:31 +00001050 if( addr<0 ){
drh37b89a02009-06-19 00:33:31 +00001051 addr = p->nOp - 1;
1052 }
drh17435752007-08-16 04:30:38 +00001053 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00001054 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +00001055 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +00001056 }else{
1057 return &p->aOp[addr];
1058 }
drh9a324642003-09-06 20:12:01 +00001059}
1060
drhc7379ce2013-10-30 02:28:23 +00001061#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +00001062/*
drhf63552b2013-10-30 00:25:03 +00001063** Return an integer value for one of the parameters to the opcode pOp
1064** determined by character c.
1065*/
1066static int translateP(char c, const Op *pOp){
1067 if( c=='1' ) return pOp->p1;
1068 if( c=='2' ) return pOp->p2;
1069 if( c=='3' ) return pOp->p3;
1070 if( c=='4' ) return pOp->p4.i;
1071 return pOp->p5;
1072}
1073
drh81316f82013-10-29 20:40:47 +00001074/*
drh4eded602013-12-20 15:59:20 +00001075** Compute a string for the "comment" field of a VDBE opcode listing.
1076**
1077** The Synopsis: field in comments in the vdbe.c source file gets converted
1078** to an extra string that is appended to the sqlite3OpcodeName(). In the
1079** absence of other comments, this synopsis becomes the comment on the opcode.
1080** Some translation occurs:
1081**
1082** "PX" -> "r[X]"
1083** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
1084** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
1085** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
drh81316f82013-10-29 20:40:47 +00001086*/
drhf63552b2013-10-30 00:25:03 +00001087static int displayComment(
1088 const Op *pOp, /* The opcode to be commented */
1089 const char *zP4, /* Previously obtained value for P4 */
1090 char *zTemp, /* Write result here */
1091 int nTemp /* Space available in zTemp[] */
1092){
drh81316f82013-10-29 20:40:47 +00001093 const char *zOpName;
1094 const char *zSynopsis;
1095 int nOpName;
1096 int ii, jj;
1097 zOpName = sqlite3OpcodeName(pOp->opcode);
1098 nOpName = sqlite3Strlen30(zOpName);
1099 if( zOpName[nOpName+1] ){
1100 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +00001101 char c;
drh81316f82013-10-29 20:40:47 +00001102 zSynopsis = zOpName += nOpName + 1;
drhf63552b2013-10-30 00:25:03 +00001103 for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
1104 if( c=='P' ){
1105 c = zSynopsis[++ii];
1106 if( c=='4' ){
1107 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
1108 }else if( c=='X' ){
1109 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
1110 seenCom = 1;
drh81316f82013-10-29 20:40:47 +00001111 }else{
drhf63552b2013-10-30 00:25:03 +00001112 int v1 = translateP(c, pOp);
1113 int v2;
1114 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
1115 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
1116 ii += 3;
1117 jj += sqlite3Strlen30(zTemp+jj);
1118 v2 = translateP(zSynopsis[ii], pOp);
drh4eded602013-12-20 15:59:20 +00001119 if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
1120 ii += 2;
1121 v2++;
1122 }
1123 if( v2>1 ){
1124 sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
1125 }
drhf63552b2013-10-30 00:25:03 +00001126 }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
1127 ii += 4;
1128 }
drh81316f82013-10-29 20:40:47 +00001129 }
1130 jj += sqlite3Strlen30(zTemp+jj);
1131 }else{
drhf63552b2013-10-30 00:25:03 +00001132 zTemp[jj++] = c;
drh81316f82013-10-29 20:40:47 +00001133 }
1134 }
1135 if( !seenCom && jj<nTemp-5 && pOp->zComment ){
1136 sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
1137 jj += sqlite3Strlen30(zTemp+jj);
1138 }
1139 if( jj<nTemp ) zTemp[jj] = 0;
1140 }else if( pOp->zComment ){
1141 sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
1142 jj = sqlite3Strlen30(zTemp);
1143 }else{
1144 zTemp[0] = 0;
1145 jj = 0;
1146 }
1147 return jj;
1148}
1149#endif /* SQLITE_DEBUG */
1150
drhf7e36902015-08-13 21:32:41 +00001151#if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
1152/*
1153** Translate the P4.pExpr value for an OP_CursorHint opcode into text
1154** that can be displayed in the P4 column of EXPLAIN output.
1155*/
drh5f4a6862016-01-30 12:50:25 +00001156static void displayP4Expr(StrAccum *p, Expr *pExpr){
drha67a3162015-08-15 00:51:23 +00001157 const char *zOp = 0;
drhf7e36902015-08-13 21:32:41 +00001158 switch( pExpr->op ){
1159 case TK_STRING:
drh5f4a6862016-01-30 12:50:25 +00001160 sqlite3XPrintf(p, "%Q", pExpr->u.zToken);
drhf7e36902015-08-13 21:32:41 +00001161 break;
drhf7e36902015-08-13 21:32:41 +00001162 case TK_INTEGER:
drh5f4a6862016-01-30 12:50:25 +00001163 sqlite3XPrintf(p, "%d", pExpr->u.iValue);
drhf7e36902015-08-13 21:32:41 +00001164 break;
drhf7e36902015-08-13 21:32:41 +00001165 case TK_NULL:
drh5f4a6862016-01-30 12:50:25 +00001166 sqlite3XPrintf(p, "NULL");
drhf7e36902015-08-13 21:32:41 +00001167 break;
drhf7e36902015-08-13 21:32:41 +00001168 case TK_REGISTER: {
drh5f4a6862016-01-30 12:50:25 +00001169 sqlite3XPrintf(p, "r[%d]", pExpr->iTable);
drhf7e36902015-08-13 21:32:41 +00001170 break;
1171 }
drhf7e36902015-08-13 21:32:41 +00001172 case TK_COLUMN: {
drhfe663522015-08-14 01:03:21 +00001173 if( pExpr->iColumn<0 ){
drh5f4a6862016-01-30 12:50:25 +00001174 sqlite3XPrintf(p, "rowid");
drhfe663522015-08-14 01:03:21 +00001175 }else{
drh5f4a6862016-01-30 12:50:25 +00001176 sqlite3XPrintf(p, "c%d", (int)pExpr->iColumn);
drhfe663522015-08-14 01:03:21 +00001177 }
drhf7e36902015-08-13 21:32:41 +00001178 break;
1179 }
drha67a3162015-08-15 00:51:23 +00001180 case TK_LT: zOp = "LT"; break;
1181 case TK_LE: zOp = "LE"; break;
1182 case TK_GT: zOp = "GT"; break;
1183 case TK_GE: zOp = "GE"; break;
1184 case TK_NE: zOp = "NE"; break;
1185 case TK_EQ: zOp = "EQ"; break;
1186 case TK_IS: zOp = "IS"; break;
1187 case TK_ISNOT: zOp = "ISNOT"; break;
1188 case TK_AND: zOp = "AND"; break;
1189 case TK_OR: zOp = "OR"; break;
1190 case TK_PLUS: zOp = "ADD"; break;
1191 case TK_STAR: zOp = "MUL"; break;
1192 case TK_MINUS: zOp = "SUB"; break;
1193 case TK_REM: zOp = "REM"; break;
1194 case TK_BITAND: zOp = "BITAND"; break;
1195 case TK_BITOR: zOp = "BITOR"; break;
1196 case TK_SLASH: zOp = "DIV"; break;
1197 case TK_LSHIFT: zOp = "LSHIFT"; break;
1198 case TK_RSHIFT: zOp = "RSHIFT"; break;
1199 case TK_CONCAT: zOp = "CONCAT"; break;
1200 case TK_UMINUS: zOp = "MINUS"; break;
1201 case TK_UPLUS: zOp = "PLUS"; break;
1202 case TK_BITNOT: zOp = "BITNOT"; break;
1203 case TK_NOT: zOp = "NOT"; break;
1204 case TK_ISNULL: zOp = "ISNULL"; break;
1205 case TK_NOTNULL: zOp = "NOTNULL"; break;
drh81316f82013-10-29 20:40:47 +00001206
drhf7e36902015-08-13 21:32:41 +00001207 default:
drh5f4a6862016-01-30 12:50:25 +00001208 sqlite3XPrintf(p, "%s", "expr");
drhf7e36902015-08-13 21:32:41 +00001209 break;
1210 }
1211
drha67a3162015-08-15 00:51:23 +00001212 if( zOp ){
drh5f4a6862016-01-30 12:50:25 +00001213 sqlite3XPrintf(p, "%s(", zOp);
1214 displayP4Expr(p, pExpr->pLeft);
1215 if( pExpr->pRight ){
1216 sqlite3StrAccumAppend(p, ",", 1);
1217 displayP4Expr(p, pExpr->pRight);
drha67a3162015-08-15 00:51:23 +00001218 }
drh5f4a6862016-01-30 12:50:25 +00001219 sqlite3StrAccumAppend(p, ")", 1);
drhf7e36902015-08-13 21:32:41 +00001220 }
drhf7e36902015-08-13 21:32:41 +00001221}
1222#endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
1223
1224
1225#if VDBE_DISPLAY_P4
drh9a324642003-09-06 20:12:01 +00001226/*
drh66a51672008-01-03 00:01:23 +00001227** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +00001228** Use zTemp for any required temporary buffer space.
1229*/
drh66a51672008-01-03 00:01:23 +00001230static char *displayP4(Op *pOp, char *zTemp, int nTemp){
1231 char *zP4 = zTemp;
drh5f4a6862016-01-30 12:50:25 +00001232 StrAccum x;
drhd3d39e92004-05-20 22:16:29 +00001233 assert( nTemp>=20 );
drh5f4a6862016-01-30 12:50:25 +00001234 sqlite3StrAccumInit(&x, 0, zTemp, nTemp, 0);
drh66a51672008-01-03 00:01:23 +00001235 switch( pOp->p4type ){
1236 case P4_KEYINFO: {
drh5f4a6862016-01-30 12:50:25 +00001237 int j;
danielk19772dca4ac2008-01-03 11:50:29 +00001238 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
drhe1a022e2012-09-17 17:16:53 +00001239 assert( pKeyInfo->aSortOrder!=0 );
drh5f4a6862016-01-30 12:50:25 +00001240 sqlite3XPrintf(&x, "k(%d", pKeyInfo->nField);
drhd3d39e92004-05-20 22:16:29 +00001241 for(j=0; j<pKeyInfo->nField; j++){
1242 CollSeq *pColl = pKeyInfo->aColl[j];
drh5f4a6862016-01-30 12:50:25 +00001243 const char *zColl = pColl ? pColl->zName : "";
1244 if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
1245 sqlite3XPrintf(&x, ",%s%s", pKeyInfo->aSortOrder[j] ? "-" : "", zColl);
drhd3d39e92004-05-20 22:16:29 +00001246 }
drh5f4a6862016-01-30 12:50:25 +00001247 sqlite3StrAccumAppend(&x, ")", 1);
drhd3d39e92004-05-20 22:16:29 +00001248 break;
1249 }
drh28935362013-12-07 20:39:19 +00001250#ifdef SQLITE_ENABLE_CURSOR_HINTS
1251 case P4_EXPR: {
drh5f4a6862016-01-30 12:50:25 +00001252 displayP4Expr(&x, pOp->p4.pExpr);
drh28935362013-12-07 20:39:19 +00001253 break;
1254 }
1255#endif
drh66a51672008-01-03 00:01:23 +00001256 case P4_COLLSEQ: {
danielk19772dca4ac2008-01-03 11:50:29 +00001257 CollSeq *pColl = pOp->p4.pColl;
drh5f4a6862016-01-30 12:50:25 +00001258 sqlite3XPrintf(&x, "(%.20s)", pColl->zName);
drhd3d39e92004-05-20 22:16:29 +00001259 break;
1260 }
drh66a51672008-01-03 00:01:23 +00001261 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +00001262 FuncDef *pDef = pOp->p4.pFunc;
drh5f4a6862016-01-30 12:50:25 +00001263 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +00001264 break;
1265 }
drhe2d9e7c2015-06-26 18:47:53 +00001266#ifdef SQLITE_DEBUG
drh9c7c9132015-06-26 18:16:52 +00001267 case P4_FUNCCTX: {
1268 FuncDef *pDef = pOp->p4.pCtx->pFunc;
drh5f4a6862016-01-30 12:50:25 +00001269 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drh9c7c9132015-06-26 18:16:52 +00001270 break;
1271 }
drhe2d9e7c2015-06-26 18:47:53 +00001272#endif
drh66a51672008-01-03 00:01:23 +00001273 case P4_INT64: {
drh5f4a6862016-01-30 12:50:25 +00001274 sqlite3XPrintf(&x, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +00001275 break;
1276 }
drh66a51672008-01-03 00:01:23 +00001277 case P4_INT32: {
drh5f4a6862016-01-30 12:50:25 +00001278 sqlite3XPrintf(&x, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +00001279 break;
1280 }
drh66a51672008-01-03 00:01:23 +00001281 case P4_REAL: {
drh5f4a6862016-01-30 12:50:25 +00001282 sqlite3XPrintf(&x, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +00001283 break;
1284 }
drh66a51672008-01-03 00:01:23 +00001285 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +00001286 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001287 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001288 zP4 = pMem->z;
drhd4e70eb2008-01-02 00:34:36 +00001289 }else if( pMem->flags & MEM_Int ){
drh5f4a6862016-01-30 12:50:25 +00001290 sqlite3XPrintf(&x, "%lld", pMem->u.i);
drhd4e70eb2008-01-02 00:34:36 +00001291 }else if( pMem->flags & MEM_Real ){
drh5f4a6862016-01-30 12:50:25 +00001292 sqlite3XPrintf(&x, "%.16g", pMem->u.r);
drhb8475df2011-12-09 16:21:19 +00001293 }else if( pMem->flags & MEM_Null ){
drh5f4a6862016-01-30 12:50:25 +00001294 zP4 = "NULL";
drh56016892009-08-25 14:24:04 +00001295 }else{
1296 assert( pMem->flags & MEM_Blob );
1297 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001298 }
drh598f1342007-10-23 15:39:45 +00001299 break;
1300 }
drha967e882006-06-13 01:04:52 +00001301#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001302 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001303 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh5f4a6862016-01-30 12:50:25 +00001304 sqlite3XPrintf(&x, "vtab:%p", pVtab);
drha967e882006-06-13 01:04:52 +00001305 break;
1306 }
1307#endif
drh0acb7e42008-06-25 00:12:41 +00001308 case P4_INTARRAY: {
drh5f4a6862016-01-30 12:50:25 +00001309 int i;
drhb1702022016-01-30 00:45:18 +00001310 int *ai = pOp->p4.ai;
1311 int n = ai[0]; /* The first element of an INTARRAY is always the
1312 ** count of the number of elements to follow */
drh5f4a6862016-01-30 12:50:25 +00001313 for(i=1; i<n; i++){
1314 sqlite3XPrintf(&x, ",%d", ai[i]);
1315 }
drhb1702022016-01-30 00:45:18 +00001316 zTemp[0] = '[';
drh5f4a6862016-01-30 12:50:25 +00001317 sqlite3StrAccumAppend(&x, "]", 1);
drh0acb7e42008-06-25 00:12:41 +00001318 break;
1319 }
dan165921a2009-08-28 18:53:45 +00001320 case P4_SUBPROGRAM: {
drh5f4a6862016-01-30 12:50:25 +00001321 sqlite3XPrintf(&x, "program");
dan165921a2009-08-28 18:53:45 +00001322 break;
1323 }
drh4a6f3aa2011-08-28 00:19:26 +00001324 case P4_ADVANCE: {
1325 zTemp[0] = 0;
1326 break;
1327 }
drh74c33022016-03-30 12:56:55 +00001328 case P4_TABLE: {
1329 sqlite3XPrintf(&x, "%s", pOp->p4.pTab->zName);
1330 break;
1331 }
drhd3d39e92004-05-20 22:16:29 +00001332 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001333 zP4 = pOp->p4.z;
drh949f9cd2008-01-12 21:35:57 +00001334 if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +00001335 zP4 = zTemp;
drhd4e70eb2008-01-02 00:34:36 +00001336 zTemp[0] = 0;
drhd3d39e92004-05-20 22:16:29 +00001337 }
1338 }
1339 }
drh5f4a6862016-01-30 12:50:25 +00001340 sqlite3StrAccumFinish(&x);
drh66a51672008-01-03 00:01:23 +00001341 assert( zP4!=0 );
drh66a51672008-01-03 00:01:23 +00001342 return zP4;
drhd3d39e92004-05-20 22:16:29 +00001343}
drhf7e36902015-08-13 21:32:41 +00001344#endif /* VDBE_DISPLAY_P4 */
drhd3d39e92004-05-20 22:16:29 +00001345
drh900b31e2007-08-28 02:27:51 +00001346/*
drhd0679ed2007-08-28 22:24:34 +00001347** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001348**
drhbdaec522011-04-04 00:14:43 +00001349** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001350** attached databases that will be use. A mask of these databases
1351** is maintained in p->btreeMask. The p->lockMask value is the subset of
1352** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001353*/
drhfb982642007-08-30 01:19:59 +00001354void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001355 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001356 assert( i<(int)sizeof(p->btreeMask)*8 );
drha7ab6d82014-07-21 15:44:39 +00001357 DbMaskSet(p->btreeMask, i);
drhdc5b0472011-04-06 22:05:53 +00001358 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
drha7ab6d82014-07-21 15:44:39 +00001359 DbMaskSet(p->lockMask, i);
drhdc5b0472011-04-06 22:05:53 +00001360 }
drh900b31e2007-08-28 02:27:51 +00001361}
1362
dan20d876f2016-01-07 16:06:22 +00001363#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhbdaec522011-04-04 00:14:43 +00001364/*
1365** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1366** this routine obtains the mutex associated with each BtShared structure
1367** that may be accessed by the VM passed as an argument. In doing so it also
1368** sets the BtShared.db member of each of the BtShared structures, ensuring
1369** that the correct busy-handler callback is invoked if required.
1370**
1371** If SQLite is not threadsafe but does support shared-cache mode, then
1372** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1373** of all of BtShared structures accessible via the database handle
1374** associated with the VM.
1375**
1376** If SQLite is not threadsafe and does not support shared-cache mode, this
1377** function is a no-op.
1378**
1379** The p->btreeMask field is a bitmask of all btrees that the prepared
1380** statement p will ever use. Let N be the number of bits in p->btreeMask
1381** corresponding to btrees that use shared cache. Then the runtime of
1382** this routine is N*N. But as N is rarely more than 1, this should not
1383** be a problem.
1384*/
1385void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001386 int i;
drhdc5b0472011-04-06 22:05:53 +00001387 sqlite3 *db;
1388 Db *aDb;
1389 int nDb;
drha7ab6d82014-07-21 15:44:39 +00001390 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
drhdc5b0472011-04-06 22:05:53 +00001391 db = p->db;
1392 aDb = db->aDb;
1393 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001394 for(i=0; i<nDb; i++){
1395 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001396 sqlite3BtreeEnter(aDb[i].pBt);
1397 }
1398 }
drhbdaec522011-04-04 00:14:43 +00001399}
drhe54e0512011-04-05 17:31:56 +00001400#endif
drhbdaec522011-04-04 00:14:43 +00001401
drhe54e0512011-04-05 17:31:56 +00001402#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001403/*
1404** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1405*/
drhf1aabd62015-06-17 01:31:28 +00001406static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001407 int i;
drhdc5b0472011-04-06 22:05:53 +00001408 sqlite3 *db;
1409 Db *aDb;
1410 int nDb;
drhdc5b0472011-04-06 22:05:53 +00001411 db = p->db;
1412 aDb = db->aDb;
1413 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001414 for(i=0; i<nDb; i++){
1415 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001416 sqlite3BtreeLeave(aDb[i].pBt);
1417 }
1418 }
drhbdaec522011-04-04 00:14:43 +00001419}
drhf1aabd62015-06-17 01:31:28 +00001420void sqlite3VdbeLeave(Vdbe *p){
1421 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
1422 vdbeLeave(p);
1423}
drhbdaec522011-04-04 00:14:43 +00001424#endif
drhd3d39e92004-05-20 22:16:29 +00001425
danielk19778b60e0f2005-01-12 09:10:39 +00001426#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00001427/*
1428** Print a single opcode. This routine is used for debugging only.
1429*/
danielk19774adee202004-05-08 08:23:19 +00001430void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
drh66a51672008-01-03 00:01:23 +00001431 char *zP4;
drhd3d39e92004-05-20 22:16:29 +00001432 char zPtr[50];
drh81316f82013-10-29 20:40:47 +00001433 char zCom[100];
drh26198bb2013-10-31 11:15:09 +00001434 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00001435 if( pOut==0 ) pOut = stdout;
drh66a51672008-01-03 00:01:23 +00001436 zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
drhc7379ce2013-10-30 02:28:23 +00001437#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh81316f82013-10-29 20:40:47 +00001438 displayComment(pOp, zP4, zCom, sizeof(zCom));
1439#else
drh2926f962014-02-17 01:13:28 +00001440 zCom[0] = 0;
drh81316f82013-10-29 20:40:47 +00001441#endif
drh4eded602013-12-20 15:59:20 +00001442 /* NB: The sqlite3OpcodeName() function is implemented by code created
1443 ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
1444 ** information from the vdbe.c source text */
danielk197711641c12008-01-03 08:18:30 +00001445 fprintf(pOut, zFormat1, pc,
drh1db639c2008-01-17 02:36:28 +00001446 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
drh81316f82013-10-29 20:40:47 +00001447 zCom
drh1db639c2008-01-17 02:36:28 +00001448 );
drh9a324642003-09-06 20:12:01 +00001449 fflush(pOut);
1450}
1451#endif
1452
1453/*
drh76ff3a02004-09-24 22:32:30 +00001454** Release an array of N Mem elements
1455*/
drhc890fec2008-08-01 20:10:08 +00001456static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00001457 if( p && N ){
drh069c23c2014-09-19 16:13:12 +00001458 Mem *pEnd = &p[N];
danielk1977a7a8e142008-02-13 18:25:27 +00001459 sqlite3 *db = p->db;
dand46def72010-07-24 11:28:28 +00001460 if( db->pnBytesFreed ){
drh069c23c2014-09-19 16:13:12 +00001461 do{
drh17bcb102014-09-18 21:25:33 +00001462 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh069c23c2014-09-19 16:13:12 +00001463 }while( (++p)<pEnd );
drhc176c272010-07-26 13:57:59 +00001464 return;
1465 }
drh069c23c2014-09-19 16:13:12 +00001466 do{
danielk1977e972e032008-09-19 18:32:26 +00001467 assert( (&p[1])==pEnd || p[0].db==p[1].db );
drh75fd0542014-03-01 16:24:44 +00001468 assert( sqlite3VdbeCheckMemInvariants(p) );
danielk1977e972e032008-09-19 18:32:26 +00001469
1470 /* This block is really an inlined version of sqlite3VdbeMemRelease()
1471 ** that takes advantage of the fact that the memory cell value is
1472 ** being set to NULL after releasing any dynamic resources.
1473 **
1474 ** The justification for duplicating code is that according to
1475 ** callgrind, this causes a certain test case to hit the CPU 4.7
1476 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
1477 ** sqlite3MemRelease() were called from here. With -O2, this jumps
1478 ** to 6.6 percent. The test case is inserting 1000 rows into a table
1479 ** with no indexes using a single prepared INSERT statement, bind()
1480 ** and reset(). Inserts are grouped into a transaction.
1481 */
drhb6e8fd12014-03-06 01:56:33 +00001482 testcase( p->flags & MEM_Agg );
1483 testcase( p->flags & MEM_Dyn );
1484 testcase( p->flags & MEM_Frame );
1485 testcase( p->flags & MEM_RowSet );
dan165921a2009-08-28 18:53:45 +00001486 if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
danielk1977e972e032008-09-19 18:32:26 +00001487 sqlite3VdbeMemRelease(p);
drh17bcb102014-09-18 21:25:33 +00001488 }else if( p->szMalloc ){
danielk1977e972e032008-09-19 18:32:26 +00001489 sqlite3DbFree(db, p->zMalloc);
drh17bcb102014-09-18 21:25:33 +00001490 p->szMalloc = 0;
danielk1977e972e032008-09-19 18:32:26 +00001491 }
1492
drha5750cf2014-02-07 13:20:31 +00001493 p->flags = MEM_Undefined;
drh069c23c2014-09-19 16:13:12 +00001494 }while( (++p)<pEnd );
drh76ff3a02004-09-24 22:32:30 +00001495 }
1496}
1497
dan65a7cd12009-09-01 12:16:01 +00001498/*
1499** Delete a VdbeFrame object and its contents. VdbeFrame objects are
1500** allocated by the OP_Program opcode in sqlite3VdbeExec().
1501*/
dan165921a2009-08-28 18:53:45 +00001502void sqlite3VdbeFrameDelete(VdbeFrame *p){
1503 int i;
1504 Mem *aMem = VdbeFrameMem(p);
1505 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
1506 for(i=0; i<p->nChildCsr; i++){
1507 sqlite3VdbeFreeCursor(p->v, apCsr[i]);
1508 }
1509 releaseMemArray(aMem, p->nChildMem);
drhb9626cf2016-02-22 16:04:31 +00001510 sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
dan165921a2009-08-28 18:53:45 +00001511 sqlite3DbFree(p->v->db, p);
1512}
1513
drhb7f91642004-10-31 02:22:47 +00001514#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00001515/*
drh9a324642003-09-06 20:12:01 +00001516** Give a listing of the program in the virtual machine.
1517**
danielk19774adee202004-05-08 08:23:19 +00001518** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00001519** running the code, it invokes the callback once for each instruction.
1520** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00001521**
1522** When p->explain==1, each instruction is listed. When
1523** p->explain==2, only OP_Explain instructions are listed and these
1524** are shown in a different format. p->explain==2 is used to implement
1525** EXPLAIN QUERY PLAN.
drh5cfa5842009-12-31 20:35:08 +00001526**
1527** When p->explain==1, first the main program is listed, then each of
1528** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00001529*/
danielk19774adee202004-05-08 08:23:19 +00001530int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00001531 Vdbe *p /* The VDBE */
1532){
drh5cfa5842009-12-31 20:35:08 +00001533 int nRow; /* Stop when row count reaches this */
dan165921a2009-08-28 18:53:45 +00001534 int nSub = 0; /* Number of sub-vdbes seen so far */
1535 SubProgram **apSub = 0; /* Array of sub-vdbes */
drh5cfa5842009-12-31 20:35:08 +00001536 Mem *pSub = 0; /* Memory cell hold array of subprogs */
1537 sqlite3 *db = p->db; /* The database connection */
1538 int i; /* Loop counter */
1539 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00001540 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh9a324642003-09-06 20:12:01 +00001541
drh9a324642003-09-06 20:12:01 +00001542 assert( p->explain );
drh5f82e3c2009-07-06 00:44:08 +00001543 assert( p->magic==VDBE_MAGIC_RUN );
danielk19776c359f02008-11-21 16:58:03 +00001544 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00001545
drh9cbf3422008-01-17 16:22:13 +00001546 /* Even though this opcode does not use dynamic strings for
1547 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00001548 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00001549 */
dan165921a2009-08-28 18:53:45 +00001550 releaseMemArray(pMem, 8);
drh9734e6e2011-10-07 18:24:25 +00001551 p->pResultSet = 0;
danielk197718f41892004-05-22 07:27:46 +00001552
mistachkinfad30392016-02-13 23:43:46 +00001553 if( p->rc==SQLITE_NOMEM_BKPT ){
danielk19776c359f02008-11-21 16:58:03 +00001554 /* This happens if a malloc() inside a call to sqlite3_column_text() or
1555 ** sqlite3_column_text16() failed. */
drh4a642b62016-02-05 01:55:27 +00001556 sqlite3OomFault(db);
danielk19776c359f02008-11-21 16:58:03 +00001557 return SQLITE_ERROR;
1558 }
1559
drh5cfa5842009-12-31 20:35:08 +00001560 /* When the number of output rows reaches nRow, that means the
1561 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
1562 ** nRow is the sum of the number of rows in the main program, plus
1563 ** the sum of the number of rows in all trigger subprograms encountered
1564 ** so far. The nRow value will increase as new trigger subprograms are
1565 ** encountered, but p->pc will eventually catch up to nRow.
1566 */
dan165921a2009-08-28 18:53:45 +00001567 nRow = p->nOp;
1568 if( p->explain==1 ){
drh5cfa5842009-12-31 20:35:08 +00001569 /* The first 8 memory cells are used for the result set. So we will
1570 ** commandeer the 9th cell to use as storage for an array of pointers
1571 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
1572 ** cells. */
1573 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00001574 pSub = &p->aMem[9];
1575 if( pSub->flags&MEM_Blob ){
drh5cfa5842009-12-31 20:35:08 +00001576 /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
1577 ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
dan165921a2009-08-28 18:53:45 +00001578 nSub = pSub->n/sizeof(Vdbe*);
1579 apSub = (SubProgram **)pSub->z;
1580 }
1581 for(i=0; i<nSub; i++){
1582 nRow += apSub[i]->nOp;
1583 }
1584 }
1585
drhecc92422005-09-10 16:46:12 +00001586 do{
1587 i = p->pc++;
dan165921a2009-08-28 18:53:45 +00001588 }while( i<nRow && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
1589 if( i>=nRow ){
drh826fb5a2004-02-14 23:59:57 +00001590 p->rc = SQLITE_OK;
1591 rc = SQLITE_DONE;
drh881feaa2006-07-26 01:39:30 +00001592 }else if( db->u1.isInterrupted ){
drhc5cdca62005-01-11 16:54:14 +00001593 p->rc = SQLITE_INTERRUPT;
drh826fb5a2004-02-14 23:59:57 +00001594 rc = SQLITE_ERROR;
drh22c17b82015-05-15 04:13:15 +00001595 sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
drh826fb5a2004-02-14 23:59:57 +00001596 }else{
drh81316f82013-10-29 20:40:47 +00001597 char *zP4;
dan165921a2009-08-28 18:53:45 +00001598 Op *pOp;
1599 if( i<p->nOp ){
drh5cfa5842009-12-31 20:35:08 +00001600 /* The output line number is small enough that we are still in the
1601 ** main program. */
dan165921a2009-08-28 18:53:45 +00001602 pOp = &p->aOp[i];
1603 }else{
drh5cfa5842009-12-31 20:35:08 +00001604 /* We are currently listing subprograms. Figure out which one and
1605 ** pick up the appropriate opcode. */
dan165921a2009-08-28 18:53:45 +00001606 int j;
1607 i -= p->nOp;
1608 for(j=0; i>=apSub[j]->nOp; j++){
1609 i -= apSub[j]->nOp;
1610 }
1611 pOp = &apSub[j]->aOp[i];
1612 }
danielk19770d78bae2008-01-03 07:09:48 +00001613 if( p->explain==1 ){
1614 pMem->flags = MEM_Int;
danielk19770d78bae2008-01-03 07:09:48 +00001615 pMem->u.i = i; /* Program counter */
1616 pMem++;
1617
1618 pMem->flags = MEM_Static|MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001619 pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
danielk19770d78bae2008-01-03 07:09:48 +00001620 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001621 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +00001622 pMem->enc = SQLITE_UTF8;
1623 pMem++;
dan165921a2009-08-28 18:53:45 +00001624
drh5cfa5842009-12-31 20:35:08 +00001625 /* When an OP_Program opcode is encounter (the only opcode that has
1626 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
1627 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
1628 ** has not already been seen.
1629 */
dan165921a2009-08-28 18:53:45 +00001630 if( pOp->p4type==P4_SUBPROGRAM ){
1631 int nByte = (nSub+1)*sizeof(SubProgram*);
1632 int j;
1633 for(j=0; j<nSub; j++){
1634 if( apSub[j]==pOp->p4.pProgram ) break;
1635 }
dan2b9ee772012-03-31 09:59:44 +00001636 if( j==nSub && SQLITE_OK==sqlite3VdbeMemGrow(pSub, nByte, nSub!=0) ){
dan165921a2009-08-28 18:53:45 +00001637 apSub = (SubProgram **)pSub->z;
1638 apSub[nSub++] = pOp->p4.pProgram;
1639 pSub->flags |= MEM_Blob;
1640 pSub->n = nSub*sizeof(SubProgram*);
1641 }
1642 }
danielk19770d78bae2008-01-03 07:09:48 +00001643 }
drheb2e1762004-05-27 01:53:56 +00001644
1645 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001646 pMem->u.i = pOp->p1; /* P1 */
drheb2e1762004-05-27 01:53:56 +00001647 pMem++;
1648
1649 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001650 pMem->u.i = pOp->p2; /* P2 */
drheb2e1762004-05-27 01:53:56 +00001651 pMem++;
1652
dan2ce22452010-11-08 19:01:16 +00001653 pMem->flags = MEM_Int;
1654 pMem->u.i = pOp->p3; /* P3 */
dan2ce22452010-11-08 19:01:16 +00001655 pMem++;
danielk19770d78bae2008-01-03 07:09:48 +00001656
drh2f2b0272015-08-14 18:50:04 +00001657 if( sqlite3VdbeMemClearAndResize(pMem, 100) ){ /* P4 */
danielk1977357864e2009-03-25 15:43:08 +00001658 assert( p->db->mallocFailed );
1659 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001660 }
drhc91b2fd2014-03-01 18:13:23 +00001661 pMem->flags = MEM_Str|MEM_Term;
drh2f2b0272015-08-14 18:50:04 +00001662 zP4 = displayP4(pOp, pMem->z, pMem->szMalloc);
drh81316f82013-10-29 20:40:47 +00001663 if( zP4!=pMem->z ){
1664 sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
danielk1977a7a8e142008-02-13 18:25:27 +00001665 }else{
1666 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001667 pMem->n = sqlite3Strlen30(pMem->z);
danielk1977a7a8e142008-02-13 18:25:27 +00001668 pMem->enc = SQLITE_UTF8;
1669 }
danielk19770d78bae2008-01-03 07:09:48 +00001670 pMem++;
drheb2e1762004-05-27 01:53:56 +00001671
danielk19770d78bae2008-01-03 07:09:48 +00001672 if( p->explain==1 ){
drh322f2852014-09-19 00:43:39 +00001673 if( sqlite3VdbeMemClearAndResize(pMem, 4) ){
danielk1977357864e2009-03-25 15:43:08 +00001674 assert( p->db->mallocFailed );
1675 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001676 }
drhc91b2fd2014-03-01 18:13:23 +00001677 pMem->flags = MEM_Str|MEM_Term;
drh85e5f0d2008-02-19 18:28:13 +00001678 pMem->n = 2;
1679 sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
danielk19770d78bae2008-01-03 07:09:48 +00001680 pMem->enc = SQLITE_UTF8;
1681 pMem++;
1682
drhc7379ce2013-10-30 02:28:23 +00001683#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh322f2852014-09-19 00:43:39 +00001684 if( sqlite3VdbeMemClearAndResize(pMem, 500) ){
drh81316f82013-10-29 20:40:47 +00001685 assert( p->db->mallocFailed );
1686 return SQLITE_ERROR;
drh52391cb2008-02-14 23:44:13 +00001687 }
drhc91b2fd2014-03-01 18:13:23 +00001688 pMem->flags = MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001689 pMem->n = displayComment(pOp, zP4, pMem->z, 500);
drh81316f82013-10-29 20:40:47 +00001690 pMem->enc = SQLITE_UTF8;
1691#else
1692 pMem->flags = MEM_Null; /* Comment */
drh81316f82013-10-29 20:40:47 +00001693#endif
danielk19770d78bae2008-01-03 07:09:48 +00001694 }
1695
dan2ce22452010-11-08 19:01:16 +00001696 p->nResColumn = 8 - 4*(p->explain-1);
drh9734e6e2011-10-07 18:24:25 +00001697 p->pResultSet = &p->aMem[1];
drh826fb5a2004-02-14 23:59:57 +00001698 p->rc = SQLITE_OK;
1699 rc = SQLITE_ROW;
drh9a324642003-09-06 20:12:01 +00001700 }
drh826fb5a2004-02-14 23:59:57 +00001701 return rc;
drh9a324642003-09-06 20:12:01 +00001702}
drhb7f91642004-10-31 02:22:47 +00001703#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00001704
drh7c4ac0c2007-04-05 11:25:58 +00001705#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00001706/*
drh3f7d4e42004-07-24 14:35:58 +00001707** Print the SQL that was used to generate a VDBE program.
1708*/
1709void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00001710 const char *z = 0;
1711 if( p->zSql ){
1712 z = p->zSql;
1713 }else if( p->nOp>=1 ){
1714 const VdbeOp *pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001715 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh84e55a82013-11-13 17:58:23 +00001716 z = pOp->p4.z;
1717 while( sqlite3Isspace(*z) ) z++;
1718 }
drh3f7d4e42004-07-24 14:35:58 +00001719 }
drh84e55a82013-11-13 17:58:23 +00001720 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00001721}
drh7c4ac0c2007-04-05 11:25:58 +00001722#endif
drh3f7d4e42004-07-24 14:35:58 +00001723
drh602c2372007-03-01 00:29:13 +00001724#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
1725/*
1726** Print an IOTRACE message showing SQL content.
1727*/
1728void sqlite3VdbeIOTraceSql(Vdbe *p){
1729 int nOp = p->nOp;
1730 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00001731 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00001732 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00001733 pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001734 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00001735 int i, j;
drh00a18e42007-08-13 11:10:34 +00001736 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00001737 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00001738 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00001739 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00001740 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00001741 if( z[i-1]!=' ' ){
1742 z[j++] = ' ';
1743 }
1744 }else{
1745 z[j++] = z[i];
1746 }
1747 }
1748 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00001749 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00001750 }
1751}
1752#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
1753
drha7dc4a32016-01-25 02:15:02 +00001754/* An instance of this object describes bulk memory available for use
1755** by subcomponents of a prepared statement. Space is allocated out
1756** of a ReusableSpace object by the allocSpace() routine below.
1757*/
1758struct ReusableSpace {
1759 u8 *pSpace; /* Available memory */
1760 int nFree; /* Bytes of available memory */
1761 int nNeeded; /* Total bytes that could not be allocated */
1762};
1763
1764/* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
1765** from the ReusableSpace object. Return a pointer to the allocated
1766** memory on success. If insufficient memory is available in the
1767** ReusableSpace object, increase the ReusableSpace.nNeeded
1768** value by the amount needed and return NULL.
drh4800b2e2009-12-08 15:35:22 +00001769**
drha7dc4a32016-01-25 02:15:02 +00001770** If pBuf is not initially NULL, that means that the memory has already
1771** been allocated by a prior call to this routine, so just return a copy
1772** of pBuf and leave ReusableSpace unchanged.
drhb2771ce2009-02-20 01:28:59 +00001773**
drha7dc4a32016-01-25 02:15:02 +00001774** This allocator is employed to repurpose unused slots at the end of the
1775** opcode array of prepared state for other memory needs of the prepared
1776** statement.
drhb2771ce2009-02-20 01:28:59 +00001777*/
drh4800b2e2009-12-08 15:35:22 +00001778static void *allocSpace(
drha7dc4a32016-01-25 02:15:02 +00001779 struct ReusableSpace *p, /* Bulk memory available for allocation */
1780 void *pBuf, /* Pointer to a prior allocation */
1781 int nByte /* Bytes of memory needed */
drhb2771ce2009-02-20 01:28:59 +00001782){
drha7dc4a32016-01-25 02:15:02 +00001783 assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
drhd797a9b2015-12-07 16:43:44 +00001784 if( pBuf==0 ){
1785 nByte = ROUND8(nByte);
drha7dc4a32016-01-25 02:15:02 +00001786 if( nByte <= p->nFree ){
1787 p->nFree -= nByte;
1788 pBuf = &p->pSpace[p->nFree];
drhd797a9b2015-12-07 16:43:44 +00001789 }else{
drha7dc4a32016-01-25 02:15:02 +00001790 p->nNeeded += nByte;
drhd797a9b2015-12-07 16:43:44 +00001791 }
drhb2771ce2009-02-20 01:28:59 +00001792 }
drhd797a9b2015-12-07 16:43:44 +00001793 assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
drh4800b2e2009-12-08 15:35:22 +00001794 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00001795}
drh602c2372007-03-01 00:29:13 +00001796
drh3f7d4e42004-07-24 14:35:58 +00001797/*
drh124c0b42011-06-01 18:15:55 +00001798** Rewind the VDBE back to the beginning in preparation for
1799** running it.
drh9a324642003-09-06 20:12:01 +00001800*/
drh124c0b42011-06-01 18:15:55 +00001801void sqlite3VdbeRewind(Vdbe *p){
1802#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
1803 int i;
1804#endif
drh9a324642003-09-06 20:12:01 +00001805 assert( p!=0 );
drh9a324642003-09-06 20:12:01 +00001806 assert( p->magic==VDBE_MAGIC_INIT );
1807
drhc16a03b2004-09-15 13:38:10 +00001808 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00001809 */
drhc16a03b2004-09-15 13:38:10 +00001810 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00001811
danielk197700e13612008-11-17 19:18:54 +00001812 /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
danielk1977634f2982005-03-28 08:44:07 +00001813 p->magic = VDBE_MAGIC_RUN;
1814
drh124c0b42011-06-01 18:15:55 +00001815#ifdef SQLITE_DEBUG
drh9f6168b2016-03-19 23:32:58 +00001816 for(i=0; i<p->nMem; i++){
drh124c0b42011-06-01 18:15:55 +00001817 assert( p->aMem[i].db==p->db );
1818 }
1819#endif
1820 p->pc = -1;
1821 p->rc = SQLITE_OK;
1822 p->errorAction = OE_Abort;
drh124c0b42011-06-01 18:15:55 +00001823 p->nChange = 0;
1824 p->cacheCtr = 1;
1825 p->minWriteFileFormat = 255;
1826 p->iStatement = 0;
1827 p->nFkConstraint = 0;
1828#ifdef VDBE_PROFILE
1829 for(i=0; i<p->nOp; i++){
1830 p->aOp[i].cnt = 0;
1831 p->aOp[i].cycles = 0;
1832 }
1833#endif
1834}
1835
1836/*
1837** Prepare a virtual machine for execution for the first time after
1838** creating the virtual machine. This involves things such
drh7abda852014-09-19 16:02:06 +00001839** as allocating registers and initializing the program counter.
drh124c0b42011-06-01 18:15:55 +00001840** After the VDBE has be prepped, it can be executed by one or more
1841** calls to sqlite3VdbeExec().
1842**
peter.d.reid60ec9142014-09-06 16:39:46 +00001843** This function may be called exactly once on each virtual machine.
drh124c0b42011-06-01 18:15:55 +00001844** After this routine is called the VM has been "packaged" and is ready
peter.d.reid60ec9142014-09-06 16:39:46 +00001845** to run. After this routine is called, further calls to
drh124c0b42011-06-01 18:15:55 +00001846** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
1847** the Vdbe from the Parse object that helped generate it so that the
1848** the Vdbe becomes an independent entity and the Parse object can be
1849** destroyed.
1850**
1851** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
1852** to its initial state after it has been run.
1853*/
1854void sqlite3VdbeMakeReady(
1855 Vdbe *p, /* The VDBE */
1856 Parse *pParse /* Parsing context */
1857){
1858 sqlite3 *db; /* The database connection */
1859 int nVar; /* Number of parameters */
1860 int nMem; /* Number of VM memory registers */
1861 int nCursor; /* Number of cursors required */
1862 int nArg; /* Number of arguments in subprograms */
dan1d8cb212011-12-09 13:24:16 +00001863 int nOnce; /* Number of OP_Once instructions */
drh124c0b42011-06-01 18:15:55 +00001864 int n; /* Loop counter */
drha7dc4a32016-01-25 02:15:02 +00001865 struct ReusableSpace x; /* Reusable bulk memory */
drh124c0b42011-06-01 18:15:55 +00001866
1867 assert( p!=0 );
1868 assert( p->nOp>0 );
1869 assert( pParse!=0 );
1870 assert( p->magic==VDBE_MAGIC_INIT );
drh73d5b8f2013-12-23 19:09:07 +00001871 assert( pParse==p->pParse );
drh124c0b42011-06-01 18:15:55 +00001872 db = p->db;
1873 assert( db->mallocFailed==0 );
1874 nVar = pParse->nVar;
1875 nMem = pParse->nMem;
1876 nCursor = pParse->nTab;
1877 nArg = pParse->nMaxArg;
dan1d8cb212011-12-09 13:24:16 +00001878 nOnce = pParse->nOnce;
drh20e226d2012-01-01 13:58:53 +00001879 if( nOnce==0 ) nOnce = 1; /* Ensure at least one byte in p->aOnceFlag[] */
drh124c0b42011-06-01 18:15:55 +00001880
drh3cdce922016-03-21 00:30:40 +00001881 /* Each cursor uses a memory cell. The first cursor (cursor 0) can
1882 ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
1883 ** space at the end of aMem[] for cursors 1 and greater.
danielk1977cd3e8f72008-03-25 09:47:35 +00001884 ** See also: allocateCursor().
1885 */
1886 nMem += nCursor;
drh9f6168b2016-03-19 23:32:58 +00001887 if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
danielk1977cd3e8f72008-03-25 09:47:35 +00001888
drha7dc4a32016-01-25 02:15:02 +00001889 /* Figure out how much reusable memory is available at the end of the
1890 ** opcode array. This extra memory will be reallocated for other elements
1891 ** of the prepared statement.
drh9a324642003-09-06 20:12:01 +00001892 */
drha7dc4a32016-01-25 02:15:02 +00001893 n = ROUND8(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
1894 x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
1895 assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
1896 x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
1897 assert( x.nFree>=0 );
1898 if( x.nFree>0 ){
1899 memset(x.pSpace, 0, x.nFree);
1900 assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
drh08169052016-01-05 03:39:25 +00001901 }
drh19875c82009-12-08 19:58:19 +00001902
drh124c0b42011-06-01 18:15:55 +00001903 resolveP2Values(p, &nArg);
1904 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
1905 if( pParse->explain && nMem<10 ){
1906 nMem = 10;
1907 }
drhaab910c2011-06-27 00:01:22 +00001908 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00001909
drha7dc4a32016-01-25 02:15:02 +00001910 /* Memory for registers, parameters, cursor, etc, is allocated in one or two
1911 ** passes. On the first pass, we try to reuse unused memory at the
drh124c0b42011-06-01 18:15:55 +00001912 ** end of the opcode array. If we are unable to satisfy all memory
1913 ** requirements by reusing the opcode array tail, then the second
drha7dc4a32016-01-25 02:15:02 +00001914 ** pass will fill in the remainder using a fresh memory allocation.
drh124c0b42011-06-01 18:15:55 +00001915 **
1916 ** This two-pass approach that reuses as much memory as possible from
drha7dc4a32016-01-25 02:15:02 +00001917 ** the leftover memory at the end of the opcode array. This can significantly
drh124c0b42011-06-01 18:15:55 +00001918 ** reduce the amount of memory held by a prepared statement.
1919 */
1920 do {
drha7dc4a32016-01-25 02:15:02 +00001921 x.nNeeded = 0;
1922 p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
1923 p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
1924 p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
1925 p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
1926 p->aOnceFlag = allocSpace(&x, p->aOnceFlag, nOnce);
dane2f771b2014-11-03 15:33:17 +00001927#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drha7dc4a32016-01-25 02:15:02 +00001928 p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
dane2f771b2014-11-03 15:33:17 +00001929#endif
drha7dc4a32016-01-25 02:15:02 +00001930 if( x.nNeeded==0 ) break;
1931 x.pSpace = p->pFree = sqlite3DbMallocZero(db, x.nNeeded);
1932 x.nFree = x.nNeeded;
1933 }while( !db->mallocFailed );
drhb2771ce2009-02-20 01:28:59 +00001934
drhd2a56232013-01-28 19:00:20 +00001935 p->nCursor = nCursor;
dan1d8cb212011-12-09 13:24:16 +00001936 p->nOnceFlag = nOnce;
drh124c0b42011-06-01 18:15:55 +00001937 if( p->aVar ){
1938 p->nVar = (ynVar)nVar;
1939 for(n=0; n<nVar; n++){
1940 p->aVar[n].flags = MEM_Null;
1941 p->aVar[n].db = db;
danielk197754db47e2004-05-19 10:36:43 +00001942 }
drh82a48512003-09-06 22:45:20 +00001943 }
drh6d664b42016-01-20 01:48:25 +00001944 p->nzVar = pParse->nzVar;
1945 p->azVar = pParse->azVar;
1946 pParse->nzVar = 0;
1947 pParse->azVar = 0;
drh124c0b42011-06-01 18:15:55 +00001948 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00001949 p->nMem = nMem;
1950 for(n=0; n<nMem; n++){
drha5750cf2014-02-07 13:20:31 +00001951 p->aMem[n].flags = MEM_Undefined;
drh124c0b42011-06-01 18:15:55 +00001952 p->aMem[n].db = db;
drhcf64d8b2003-12-31 17:57:10 +00001953 }
drh9a324642003-09-06 20:12:01 +00001954 }
drh124c0b42011-06-01 18:15:55 +00001955 p->explain = pParse->explain;
1956 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00001957}
1958
drh9a324642003-09-06 20:12:01 +00001959/*
danielk1977cd3e8f72008-03-25 09:47:35 +00001960** Close a VDBE cursor and release all the resources that cursor
1961** happens to hold.
drh9a324642003-09-06 20:12:01 +00001962*/
drhdfe88ec2008-11-03 20:55:06 +00001963void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh4774b132004-06-12 20:12:51 +00001964 if( pCx==0 ){
1965 return;
1966 }
drhc960dcb2015-11-20 19:22:01 +00001967 assert( pCx->pBt==0 || pCx->eCurType==CURTYPE_BTREE );
1968 switch( pCx->eCurType ){
1969 case CURTYPE_SORTER: {
1970 sqlite3VdbeSorterClose(p->db, pCx);
1971 break;
1972 }
1973 case CURTYPE_BTREE: {
1974 if( pCx->pBt ){
1975 sqlite3BtreeClose(pCx->pBt);
1976 /* The pCx->pCursor will be close automatically, if it exists, by
1977 ** the call above. */
1978 }else{
1979 assert( pCx->uc.pCursor!=0 );
1980 sqlite3BtreeCloseCursor(pCx->uc.pCursor);
1981 }
1982 break;
1983 }
drh9eff6162006-06-12 21:59:13 +00001984#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00001985 case CURTYPE_VTAB: {
1986 sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
1987 const sqlite3_module *pModule = pVCur->pVtab->pModule;
1988 assert( pVCur->pVtab->nRef>0 );
1989 pVCur->pVtab->nRef--;
1990 pModule->xClose(pVCur);
1991 break;
1992 }
drh9eff6162006-06-12 21:59:13 +00001993#endif
drhc960dcb2015-11-20 19:22:01 +00001994 }
drh9a324642003-09-06 20:12:01 +00001995}
1996
dan65a7cd12009-09-01 12:16:01 +00001997/*
drhab4e7f32015-04-16 18:11:50 +00001998** Close all cursors in the current frame.
1999*/
2000static void closeCursorsInFrame(Vdbe *p){
2001 if( p->apCsr ){
2002 int i;
2003 for(i=0; i<p->nCursor; i++){
2004 VdbeCursor *pC = p->apCsr[i];
2005 if( pC ){
2006 sqlite3VdbeFreeCursor(p, pC);
2007 p->apCsr[i] = 0;
2008 }
2009 }
2010 }
2011}
2012
2013/*
dan65a7cd12009-09-01 12:16:01 +00002014** Copy the values stored in the VdbeFrame structure to its Vdbe. This
2015** is used, for example, when a trigger sub-program is halted to restore
2016** control to the main program.
2017*/
dan165921a2009-08-28 18:53:45 +00002018int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
2019 Vdbe *v = pFrame->v;
drhab4e7f32015-04-16 18:11:50 +00002020 closeCursorsInFrame(v);
dane2f771b2014-11-03 15:33:17 +00002021#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00002022 v->anExec = pFrame->anExec;
dane2f771b2014-11-03 15:33:17 +00002023#endif
dan1d8cb212011-12-09 13:24:16 +00002024 v->aOnceFlag = pFrame->aOnceFlag;
2025 v->nOnceFlag = pFrame->nOnceFlag;
dan165921a2009-08-28 18:53:45 +00002026 v->aOp = pFrame->aOp;
2027 v->nOp = pFrame->nOp;
2028 v->aMem = pFrame->aMem;
2029 v->nMem = pFrame->nMem;
2030 v->apCsr = pFrame->apCsr;
2031 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00002032 v->db->lastRowid = pFrame->lastRowid;
2033 v->nChange = pFrame->nChange;
danc3da6672014-10-28 18:24:16 +00002034 v->db->nChange = pFrame->nDbChange;
drhb9626cf2016-02-22 16:04:31 +00002035 sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
dan32001322016-02-19 18:54:29 +00002036 v->pAuxData = pFrame->pAuxData;
2037 pFrame->pAuxData = 0;
dan165921a2009-08-28 18:53:45 +00002038 return pFrame->pc;
2039}
2040
drh9a324642003-09-06 20:12:01 +00002041/*
drh5f82e3c2009-07-06 00:44:08 +00002042** Close all cursors.
dan165921a2009-08-28 18:53:45 +00002043**
2044** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
2045** cell array. This is necessary as the memory cell array may contain
2046** pointers to VdbeFrame objects, which may in turn contain pointers to
2047** open cursors.
drh9a324642003-09-06 20:12:01 +00002048*/
drh5f82e3c2009-07-06 00:44:08 +00002049static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00002050 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00002051 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00002052 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
2053 sqlite3VdbeFrameRestore(pFrame);
drhf526dca2014-10-13 17:42:05 +00002054 p->pFrame = 0;
2055 p->nFrame = 0;
dan165921a2009-08-28 18:53:45 +00002056 }
drhf526dca2014-10-13 17:42:05 +00002057 assert( p->nFrame==0 );
drhab4e7f32015-04-16 18:11:50 +00002058 closeCursorsInFrame(p);
dan523a0872009-08-31 05:23:32 +00002059 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00002060 releaseMemArray(p->aMem, p->nMem);
dan523a0872009-08-31 05:23:32 +00002061 }
dan27106572010-12-01 08:04:47 +00002062 while( p->pDelFrame ){
2063 VdbeFrame *pDel = p->pDelFrame;
2064 p->pDelFrame = pDel->pParent;
2065 sqlite3VdbeFrameDelete(pDel);
2066 }
dan0c547792013-07-18 17:12:08 +00002067
2068 /* Delete any auxdata allocations made by the VM */
drhb9626cf2016-02-22 16:04:31 +00002069 if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
dan0c547792013-07-18 17:12:08 +00002070 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00002071}
2072
2073/*
drh7abda852014-09-19 16:02:06 +00002074** Clean up the VM after a single run.
drh9a324642003-09-06 20:12:01 +00002075*/
drhc890fec2008-08-01 20:10:08 +00002076static void Cleanup(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002077 sqlite3 *db = p->db;
dan165921a2009-08-28 18:53:45 +00002078
2079#ifdef SQLITE_DEBUG
2080 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
2081 ** Vdbe.aMem[] arrays have already been cleaned up. */
2082 int i;
drhb8475df2011-12-09 16:21:19 +00002083 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
2084 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00002085 for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
drhb8475df2011-12-09 16:21:19 +00002086 }
dan165921a2009-08-28 18:53:45 +00002087#endif
2088
drh633e6d52008-07-28 19:34:53 +00002089 sqlite3DbFree(db, p->zErrMsg);
drh9a324642003-09-06 20:12:01 +00002090 p->zErrMsg = 0;
drhd4e70eb2008-01-02 00:34:36 +00002091 p->pResultSet = 0;
drh9a324642003-09-06 20:12:01 +00002092}
2093
2094/*
danielk197722322fd2004-05-25 23:35:17 +00002095** Set the number of result columns that will be returned by this SQL
2096** statement. This is now set at compile time, rather than during
2097** execution of the vdbe program so that sqlite3_column_count() can
2098** be called on an SQL statement before sqlite3_step().
2099*/
2100void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00002101 Mem *pColName;
2102 int n;
drh633e6d52008-07-28 19:34:53 +00002103 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002104
drhc890fec2008-08-01 20:10:08 +00002105 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00002106 sqlite3DbFree(db, p->aColName);
danielk1977955de522006-02-10 02:27:42 +00002107 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00002108 p->nResColumn = (u16)nResColumn;
drh633e6d52008-07-28 19:34:53 +00002109 p->aColName = pColName = (Mem*)sqlite3DbMallocZero(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00002110 if( p->aColName==0 ) return;
2111 while( n-- > 0 ){
drh4a50aac2007-08-23 02:47:53 +00002112 pColName->flags = MEM_Null;
drh153c62c2007-08-24 03:51:33 +00002113 pColName->db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002114 pColName++;
drh76ff3a02004-09-24 22:32:30 +00002115 }
danielk197722322fd2004-05-25 23:35:17 +00002116}
2117
2118/*
danielk19773cf86062004-05-26 10:11:05 +00002119** Set the name of the idx'th column to be returned by the SQL statement.
2120** zName must be a pointer to a nul terminated string.
2121**
2122** This call must be made after a call to sqlite3VdbeSetNumCols().
2123**
danielk197710fb7492008-10-31 10:53:22 +00002124** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
2125** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
2126** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00002127*/
danielk197710fb7492008-10-31 10:53:22 +00002128int sqlite3VdbeSetColName(
2129 Vdbe *p, /* Vdbe being configured */
2130 int idx, /* Index of column zName applies to */
2131 int var, /* One of the COLNAME_* constants */
2132 const char *zName, /* Pointer to buffer containing name */
2133 void (*xDel)(void*) /* Memory management strategy for zName */
2134){
danielk19773cf86062004-05-26 10:11:05 +00002135 int rc;
2136 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00002137 assert( idx<p->nResColumn );
2138 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00002139 if( p->db->mallocFailed ){
2140 assert( !zName || xDel!=SQLITE_DYNAMIC );
mistachkinfad30392016-02-13 23:43:46 +00002141 return SQLITE_NOMEM_BKPT;
danielk197710fb7492008-10-31 10:53:22 +00002142 }
drh76ff3a02004-09-24 22:32:30 +00002143 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00002144 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00002145 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00002146 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00002147 return rc;
2148}
2149
danielk197713adf8a2004-06-03 16:08:41 +00002150/*
2151** A read or write transaction may or may not be active on database handle
2152** db. If a transaction is active, commit it. If there is a
2153** write-transaction spanning more than one database file, this routine
2154** takes care of the master journal trickery.
2155*/
danielk19773e3a84d2008-08-01 17:37:40 +00002156static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00002157 int i;
drh8e6cf0a2016-02-22 14:57:38 +00002158 int nTrans = 0; /* Number of databases with an active write-transaction
2159 ** that are candidates for a two-phase commit using a
2160 ** master-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002161 int rc = SQLITE_OK;
2162 int needXcommit = 0;
2163
shane36840fd2009-06-26 16:32:13 +00002164#ifdef SQLITE_OMIT_VIRTUALTABLE
2165 /* With this option, sqlite3VtabSync() is defined to be simply
2166 ** SQLITE_OK so p is not used.
2167 */
2168 UNUSED_PARAMETER(p);
2169#endif
2170
danielk19775bd270b2006-07-25 15:14:52 +00002171 /* Before doing anything else, call the xSync() callback for any
2172 ** virtual module tables written in this transaction. This has to
2173 ** be done before determining whether a master journal file is
2174 ** required, as an xSync() callback may add an attached database
2175 ** to the transaction.
2176 */
dan016f7812013-08-21 17:35:48 +00002177 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00002178
2179 /* This loop determines (a) if the commit hook should be invoked and
2180 ** (b) how many database files have open write transactions, not
2181 ** including the temp database. (b) is important because if more than
2182 ** one database file has an open write transaction, a master journal
2183 ** file is required for an atomic commit.
2184 */
drhabfb62f2010-07-30 11:20:35 +00002185 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002186 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002187 if( sqlite3BtreeIsInTrans(pBt) ){
drh8e6cf0a2016-02-22 14:57:38 +00002188 /* Whether or not a database might need a master journal depends upon
2189 ** its journal mode (among other things). This matrix determines which
2190 ** journal modes use a master journal and which do not */
2191 static const u8 aMJNeeded[] = {
2192 /* DELETE */ 1,
2193 /* PERSIST */ 1,
2194 /* OFF */ 0,
2195 /* TRUNCATE */ 1,
2196 /* MEMORY */ 0,
2197 /* WAL */ 0
2198 };
2199 Pager *pPager; /* Pager associated with pBt */
danielk197713adf8a2004-06-03 16:08:41 +00002200 needXcommit = 1;
dan6b9bb592012-10-05 19:43:02 +00002201 sqlite3BtreeEnter(pBt);
drh8e6cf0a2016-02-22 14:57:38 +00002202 pPager = sqlite3BtreePager(pBt);
2203 if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
2204 && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
2205 ){
2206 assert( i!=1 );
2207 nTrans++;
2208 }
2209 rc = sqlite3PagerExclusiveLock(pPager);
dan6b9bb592012-10-05 19:43:02 +00002210 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00002211 }
2212 }
drhabfb62f2010-07-30 11:20:35 +00002213 if( rc!=SQLITE_OK ){
2214 return rc;
2215 }
danielk197713adf8a2004-06-03 16:08:41 +00002216
2217 /* If there are any write-transactions at all, invoke the commit hook */
2218 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00002219 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00002220 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002221 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00002222 }
2223 }
2224
danielk197740b38dc2004-06-26 08:38:24 +00002225 /* The simple case - no more than one database file (not counting the
2226 ** TEMP database) has a transaction active. There is no need for the
drh2ac3ee92004-06-07 16:27:46 +00002227 ** master-journal.
drhc9e06862004-06-09 20:03:08 +00002228 **
danielk197740b38dc2004-06-26 08:38:24 +00002229 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00002230 ** string, it means the main database is :memory: or a temp file. In
2231 ** that case we do not support atomic multi-file commits, so use the
2232 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00002233 */
drhea678832008-12-10 19:26:22 +00002234 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
2235 || nTrans<=1
2236 ){
danielk197704103022009-02-03 16:51:24 +00002237 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002238 Btree *pBt = db->aDb[i].pBt;
2239 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002240 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00002241 }
2242 }
2243
drh80e35f42007-03-30 14:06:34 +00002244 /* Do the commit only if all databases successfully complete phase 1.
2245 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
2246 ** IO error while deleting or truncating a journal file. It is unlikely,
2247 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00002248 */
2249 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
2250 Btree *pBt = db->aDb[i].pBt;
2251 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002252 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00002253 }
danielk1977979f38e2007-03-27 16:19:51 +00002254 }
2255 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00002256 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002257 }
2258 }
2259
2260 /* The complex case - There is a multi-file write-transaction active.
2261 ** This requires a master journal file to ensure the transaction is
peter.d.reid60ec9142014-09-06 16:39:46 +00002262 ** committed atomically.
danielk197713adf8a2004-06-03 16:08:41 +00002263 */
danielk197744ee5bf2005-05-27 09:41:12 +00002264#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00002265 else{
danielk1977b4b47412007-08-17 15:53:36 +00002266 sqlite3_vfs *pVfs = db->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00002267 char *zMaster = 0; /* File-name for the master journal */
2268 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
danielk1977b4b47412007-08-17 15:53:36 +00002269 sqlite3_file *pMaster = 0;
danielk197762079062007-08-15 17:08:46 +00002270 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00002271 int res;
drhf5808602011-12-16 00:33:04 +00002272 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00002273 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00002274
2275 /* Select a master journal file name */
drh5c531a42011-12-16 01:21:31 +00002276 nMainFile = sqlite3Strlen30(zMainFile);
drh52bcde02012-01-03 14:50:45 +00002277 zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
mistachkinfad30392016-02-13 23:43:46 +00002278 if( zMaster==0 ) return SQLITE_NOMEM_BKPT;
danielk197713adf8a2004-06-03 16:08:41 +00002279 do {
drhdc5ea5c2008-12-10 17:19:59 +00002280 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00002281 if( retryCount ){
2282 if( retryCount>100 ){
2283 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
2284 sqlite3OsDelete(pVfs, zMaster, 0);
2285 break;
2286 }else if( retryCount==1 ){
2287 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
2288 }
danielk197713adf8a2004-06-03 16:08:41 +00002289 }
drh84968c02011-12-16 15:11:39 +00002290 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00002291 sqlite3_randomness(sizeof(iRandom), &iRandom);
drh5c531a42011-12-16 01:21:31 +00002292 sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00002293 (iRandom>>8)&0xffffff, iRandom&0xff);
drhf5808602011-12-16 00:33:04 +00002294 /* The antipenultimate character of the master journal name must
2295 ** be "9" to avoid name collisions when using 8+3 filenames. */
drh5c531a42011-12-16 01:21:31 +00002296 assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
drh81cc5162011-05-17 20:36:21 +00002297 sqlite3FileSuffix3(zMainFile, zMaster);
danielk1977861f7452008-06-05 11:39:11 +00002298 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
2299 }while( rc==SQLITE_OK && res );
2300 if( rc==SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00002301 /* Open the master journal. */
2302 rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
2303 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
2304 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
2305 );
2306 }
danielk197713adf8a2004-06-03 16:08:41 +00002307 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002308 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002309 return rc;
2310 }
2311
2312 /* Write the name of each database file in the transaction into the new
2313 ** master journal file. If an error occurs at this point close
2314 ** and delete the master journal file. All the individual journal files
2315 ** still have 'null' as the master journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00002316 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00002317 */
danielk19771e536952007-08-16 10:09:01 +00002318 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002319 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002320 if( sqlite3BtreeIsInTrans(pBt) ){
danielk19775865e3d2004-06-14 06:03:57 +00002321 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00002322 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00002323 continue; /* Ignore TEMP and :memory: databases */
2324 }
drh8c96a6e2010-08-31 01:09:15 +00002325 assert( zFile[0]!=0 );
drhea678832008-12-10 19:26:22 +00002326 rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
2327 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00002328 if( rc!=SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00002329 sqlite3OsCloseFree(pMaster);
2330 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002331 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002332 return rc;
2333 }
2334 }
2335 }
2336
danielk19779663b8f2007-08-24 11:52:28 +00002337 /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
2338 ** flag is set this is not required.
2339 */
drhb0529582016-02-22 23:44:42 +00002340 if( 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
danielk1977bea2a942009-01-20 17:06:27 +00002341 && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
2342 ){
danielk1977fee2d252007-08-18 10:59:19 +00002343 sqlite3OsCloseFree(pMaster);
2344 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002345 sqlite3DbFree(db, zMaster);
danielk19775865e3d2004-06-14 06:03:57 +00002346 return rc;
2347 }
drhc9e06862004-06-09 20:03:08 +00002348
danielk197713adf8a2004-06-03 16:08:41 +00002349 /* Sync all the db files involved in the transaction. The same call
2350 ** sets the master journal pointer in each individual journal. If
2351 ** an error occurs here, do not delete the master journal file.
2352 **
drh80e35f42007-03-30 14:06:34 +00002353 ** If the error occurs during the first call to
2354 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
2355 ** master journal file will be orphaned. But we cannot delete it,
2356 ** in case the master journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00002357 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00002358 */
danielk19775bd270b2006-07-25 15:14:52 +00002359 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002360 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002361 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002362 rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002363 }
2364 }
danielk1977fee2d252007-08-18 10:59:19 +00002365 sqlite3OsCloseFree(pMaster);
drhabfb62f2010-07-30 11:20:35 +00002366 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00002367 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002368 sqlite3DbFree(db, zMaster);
danielk19775bd270b2006-07-25 15:14:52 +00002369 return rc;
2370 }
danielk197713adf8a2004-06-03 16:08:41 +00002371
danielk1977962398d2004-06-14 09:35:16 +00002372 /* Delete the master journal file. This commits the transaction. After
2373 ** doing this the directory is synced again before any individual
2374 ** transaction files are deleted.
2375 */
drhb0529582016-02-22 23:44:42 +00002376 rc = sqlite3OsDelete(pVfs, zMaster, 1);
drh633e6d52008-07-28 19:34:53 +00002377 sqlite3DbFree(db, zMaster);
drhc416ba92007-03-30 18:42:55 +00002378 zMaster = 0;
drh29a01382006-08-13 19:04:18 +00002379 if( rc ){
2380 return rc;
2381 }
danielk197713adf8a2004-06-03 16:08:41 +00002382
2383 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00002384 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
2385 ** deleting or truncating journals. If something goes wrong while
2386 ** this is happening we don't really care. The integrity of the
2387 ** transaction is already guaranteed, but some stray 'cold' journals
2388 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00002389 */
danielk1977979f38e2007-03-27 16:19:51 +00002390 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002391 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00002392 for(i=0; i<db->nDb; i++){
2393 Btree *pBt = db->aDb[i].pBt;
2394 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002395 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00002396 }
2397 }
danielk19772d1d86f2008-06-20 14:59:51 +00002398 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00002399 enable_simulated_io_errors();
2400
danielk1977f9e7dda2006-06-16 16:08:53 +00002401 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002402 }
danielk197744ee5bf2005-05-27 09:41:12 +00002403#endif
danielk1977026d2702004-06-14 13:14:59 +00002404
drh2ac3ee92004-06-07 16:27:46 +00002405 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002406}
2407
danielk19771d850a72004-05-31 08:26:49 +00002408/*
drh4f7d3a52013-06-27 23:54:02 +00002409** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00002410** matches the number of vdbe's in the list sqlite3.pVdbe that are
2411** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00002412** This is an internal self-check only - it is not an essential processing
2413** step.
danielk19771d850a72004-05-31 08:26:49 +00002414**
2415** This is a no-op if NDEBUG is defined.
2416*/
2417#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00002418static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00002419 Vdbe *p;
2420 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00002421 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00002422 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00002423 p = db->pVdbe;
2424 while( p ){
dan857745c2014-07-19 17:57:10 +00002425 if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
danielk19771d850a72004-05-31 08:26:49 +00002426 cnt++;
drhad4a4b82008-11-05 16:37:34 +00002427 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00002428 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00002429 }
2430 p = p->pNext;
2431 }
drh4f7d3a52013-06-27 23:54:02 +00002432 assert( cnt==db->nVdbeActive );
2433 assert( nWrite==db->nVdbeWrite );
2434 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00002435}
2436#else
2437#define checkActiveVdbeCnt(x)
2438#endif
2439
danielk19773cf86062004-05-26 10:11:05 +00002440/*
danielk1977bd434552009-03-18 10:33:00 +00002441** If the Vdbe passed as the first argument opened a statement-transaction,
2442** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
2443** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
2444** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00002445** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00002446**
2447** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
2448** Otherwise SQLITE_OK.
2449*/
2450int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00002451 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00002452 int rc = SQLITE_OK;
danielk1977ecaecf92009-07-08 08:05:35 +00002453
danielk1977e4948172009-07-17 17:25:43 +00002454 /* If p->iStatement is greater than zero, then this Vdbe opened a
2455 ** statement transaction that should be closed here. The only exception
mistachkin48864df2013-03-21 21:20:32 +00002456 ** is that an IO error may have occurred, causing an emergency rollback.
danielk1977e4948172009-07-17 17:25:43 +00002457 ** In this case (db->nStatement==0), and there is nothing to do.
2458 */
2459 if( db->nStatement && p->iStatement ){
danielk1977bd434552009-03-18 10:33:00 +00002460 int i;
2461 const int iSavepoint = p->iStatement-1;
danielk1977bd434552009-03-18 10:33:00 +00002462
2463 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
2464 assert( db->nStatement>0 );
2465 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
2466
2467 for(i=0; i<db->nDb; i++){
2468 int rc2 = SQLITE_OK;
2469 Btree *pBt = db->aDb[i].pBt;
2470 if( pBt ){
2471 if( eOp==SAVEPOINT_ROLLBACK ){
2472 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
2473 }
2474 if( rc2==SQLITE_OK ){
2475 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
2476 }
2477 if( rc==SQLITE_OK ){
2478 rc = rc2;
2479 }
2480 }
2481 }
2482 db->nStatement--;
2483 p->iStatement = 0;
dan1da40a32009-09-19 17:00:31 +00002484
dana311b802011-04-26 19:21:34 +00002485 if( rc==SQLITE_OK ){
2486 if( eOp==SAVEPOINT_ROLLBACK ){
2487 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
2488 }
2489 if( rc==SQLITE_OK ){
2490 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
2491 }
2492 }
2493
dan1da40a32009-09-19 17:00:31 +00002494 /* If the statement transaction is being rolled back, also restore the
2495 ** database handles deferred constraint counter to the value it had when
2496 ** the statement transaction was opened. */
2497 if( eOp==SAVEPOINT_ROLLBACK ){
2498 db->nDeferredCons = p->nStmtDefCons;
dancb3e4b72013-07-03 19:53:05 +00002499 db->nDeferredImmCons = p->nStmtDefImmCons;
dan1da40a32009-09-19 17:00:31 +00002500 }
danielk1977bd434552009-03-18 10:33:00 +00002501 }
2502 return rc;
2503}
2504
2505/*
dan1da40a32009-09-19 17:00:31 +00002506** This function is called when a transaction opened by the database
2507** handle associated with the VM passed as an argument is about to be
2508** committed. If there are outstanding deferred foreign key constraint
2509** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
2510**
2511** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00002512** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
2513** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00002514*/
2515#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00002516int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00002517 sqlite3 *db = p->db;
dancb3e4b72013-07-03 19:53:05 +00002518 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
2519 || (!deferred && p->nFkConstraint>0)
2520 ){
drhd91c1a12013-02-09 13:58:25 +00002521 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00002522 p->errorAction = OE_Abort;
drh22c17b82015-05-15 04:13:15 +00002523 sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
dan1da40a32009-09-19 17:00:31 +00002524 return SQLITE_ERROR;
2525 }
2526 return SQLITE_OK;
2527}
2528#endif
2529
2530/*
drh92f02c32004-09-02 14:57:08 +00002531** This routine is called the when a VDBE tries to halt. If the VDBE
2532** has made changes and is in autocommit mode, then commit those
2533** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00002534**
drh92f02c32004-09-02 14:57:08 +00002535** This routine is the only way to move the state of a VM from
drhff0587c2007-08-29 17:43:19 +00002536** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
2537** call this on a VM that is in the SQLITE_MAGIC_HALT state.
drh92f02c32004-09-02 14:57:08 +00002538**
2539** Return an error code. If the commit could not complete because of
2540** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
2541** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00002542*/
drhff0587c2007-08-29 17:43:19 +00002543int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00002544 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00002545 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00002546
2547 /* This function contains the logic that determines if a statement or
2548 ** transaction will be committed or rolled back as a result of the
2549 ** execution of this virtual machine.
2550 **
drh71b890a2007-10-03 15:30:52 +00002551 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00002552 **
drh71b890a2007-10-03 15:30:52 +00002553 ** SQLITE_NOMEM
2554 ** SQLITE_IOERR
2555 ** SQLITE_FULL
2556 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00002557 **
drh71b890a2007-10-03 15:30:52 +00002558 ** Then the internal cache might have been left in an inconsistent
2559 ** state. We need to rollback the statement transaction, if there is
2560 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00002561 */
drh9a324642003-09-06 20:12:01 +00002562
drhb84e5742016-02-05 02:42:54 +00002563 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002564 p->rc = SQLITE_NOMEM_BKPT;
danielk1977261919c2005-12-06 12:52:59 +00002565 }
drh6e856bc2011-12-09 18:06:44 +00002566 if( p->aOnceFlag ) memset(p->aOnceFlag, 0, p->nOnceFlag);
drh5f82e3c2009-07-06 00:44:08 +00002567 closeAllCursors(p);
drh92f02c32004-09-02 14:57:08 +00002568 if( p->magic!=VDBE_MAGIC_RUN ){
drh92f02c32004-09-02 14:57:08 +00002569 return SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00002570 }
danielk19771d850a72004-05-31 08:26:49 +00002571 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00002572
danc0537fe2013-06-28 19:41:43 +00002573 /* No commit or rollback needed if the program never started or if the
2574 ** SQL statement does not read or write a database file. */
2575 if( p->pc>=0 && p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00002576 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00002577 int eStatementOp = 0;
2578 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00002579
2580 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00002581 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00002582
drh71b890a2007-10-03 15:30:52 +00002583 /* Check for one of the special errors */
drhaac2f552006-09-23 21:44:23 +00002584 mrc = p->rc & 0xff;
drh71b890a2007-10-03 15:30:52 +00002585 isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
drh77658e22007-12-04 16:54:52 +00002586 || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
danielk197707cb5602006-01-20 10:55:05 +00002587 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00002588 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
2589 ** no rollback is necessary. Otherwise, at least a savepoint
2590 ** transaction must be rolled back to restore the database to a
2591 ** consistent state.
2592 **
2593 ** Even if the statement is read-only, it is important to perform
2594 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00002595 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00002596 ** file as part of an effort to free up cache space (see function
2597 ** pagerStress() in pager.c), the rollback is required to restore
2598 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00002599 */
drhad4a4b82008-11-05 16:37:34 +00002600 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00002601 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00002602 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002603 }else{
2604 /* We are forced to roll back the active transaction. Before doing
2605 ** so, abort any other statements this handle currently has active.
2606 */
drh21021a52012-02-13 17:01:51 +00002607 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002608 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002609 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002610 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002611 }
danielk1977261919c2005-12-06 12:52:59 +00002612 }
2613 }
dan32b09f22009-09-23 17:29:59 +00002614
2615 /* Check for immediate foreign key violations. */
2616 if( p->rc==SQLITE_OK ){
2617 sqlite3VdbeCheckFk(p, 0);
2618 }
danielk197707cb5602006-01-20 10:55:05 +00002619
danielk1977bd434552009-03-18 10:33:00 +00002620 /* If the auto-commit flag is set and this is the only active writer
2621 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00002622 **
2623 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00002624 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00002625 */
danielk1977093e0f62008-11-13 18:00:14 +00002626 if( !sqlite3VtabInSync(db)
2627 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00002628 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00002629 ){
danielk197707cb5602006-01-20 10:55:05 +00002630 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00002631 rc = sqlite3VdbeCheckFk(p, 1);
2632 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00002633 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00002634 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00002635 return SQLITE_ERROR;
2636 }
drhd91c1a12013-02-09 13:58:25 +00002637 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan19611b12011-01-24 16:00:58 +00002638 }else{
2639 /* The auto-commit flag is true, the vdbe program was successful
2640 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
2641 ** key constraints to hold up the transaction. This means a commit
2642 ** is required. */
2643 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00002644 }
dan19611b12011-01-24 16:00:58 +00002645 if( rc==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00002646 sqlite3VdbeLeave(p);
danielk197707cb5602006-01-20 10:55:05 +00002647 return SQLITE_BUSY;
2648 }else if( rc!=SQLITE_OK ){
2649 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00002650 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002651 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002652 }else{
dan1da40a32009-09-19 17:00:31 +00002653 db->nDeferredCons = 0;
dancb3e4b72013-07-03 19:53:05 +00002654 db->nDeferredImmCons = 0;
drh963c74d2013-07-11 12:19:12 +00002655 db->flags &= ~SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00002656 sqlite3CommitInternalChanges(db);
2657 }
2658 }else{
drh0f198a72012-02-13 16:43:16 +00002659 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002660 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002661 }
danielk1977bd434552009-03-18 10:33:00 +00002662 db->nStatement = 0;
2663 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00002664 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00002665 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00002666 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00002667 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002668 }else{
drh21021a52012-02-13 17:01:51 +00002669 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002670 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002671 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002672 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002673 }
danielk19771d850a72004-05-31 08:26:49 +00002674 }
danielk197707cb5602006-01-20 10:55:05 +00002675
danielk1977bd434552009-03-18 10:33:00 +00002676 /* If eStatementOp is non-zero, then a statement transaction needs to
2677 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
2678 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00002679 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
2680 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00002681 */
danielk1977bd434552009-03-18 10:33:00 +00002682 if( eStatementOp ){
2683 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00002684 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002685 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00002686 p->rc = rc;
2687 sqlite3DbFree(db, p->zErrMsg);
2688 p->zErrMsg = 0;
2689 }
drh21021a52012-02-13 17:01:51 +00002690 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00002691 sqlite3CloseSavepoints(db);
2692 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002693 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002694 }
danielk197777d83ba2004-05-31 10:08:14 +00002695 }
danielk197707cb5602006-01-20 10:55:05 +00002696
danielk1977bd434552009-03-18 10:33:00 +00002697 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
2698 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00002699 */
drh6be240e2009-07-14 02:33:02 +00002700 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00002701 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00002702 sqlite3VdbeSetChanges(db, p->nChange);
2703 }else{
2704 sqlite3VdbeSetChanges(db, 0);
2705 }
2706 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00002707 }
drhff0587c2007-08-29 17:43:19 +00002708
2709 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00002710 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00002711 }
danielk19771d850a72004-05-31 08:26:49 +00002712
danielk197765fd59f2006-06-24 11:51:33 +00002713 /* We have successfully halted and closed the VM. Record this fact. */
2714 if( p->pc>=0 ){
drh4f7d3a52013-06-27 23:54:02 +00002715 db->nVdbeActive--;
2716 if( !p->readOnly ) db->nVdbeWrite--;
drh1713afb2013-06-28 01:24:57 +00002717 if( p->bIsReader ) db->nVdbeRead--;
drh4f7d3a52013-06-27 23:54:02 +00002718 assert( db->nVdbeActive>=db->nVdbeRead );
2719 assert( db->nVdbeRead>=db->nVdbeWrite );
2720 assert( db->nVdbeWrite>=0 );
drh9a324642003-09-06 20:12:01 +00002721 }
drh92f02c32004-09-02 14:57:08 +00002722 p->magic = VDBE_MAGIC_HALT;
2723 checkActiveVdbeCnt(db);
drhb84e5742016-02-05 02:42:54 +00002724 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002725 p->rc = SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00002726 }
danielk19771d850a72004-05-31 08:26:49 +00002727
danielk1977404ca072009-03-16 13:19:36 +00002728 /* If the auto-commit flag is set to true, then any locks that were held
2729 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
2730 ** to invoke any required unlock-notify callbacks.
2731 */
2732 if( db->autoCommit ){
2733 sqlite3ConnectionUnlocked(db);
2734 }
2735
drh4f7d3a52013-06-27 23:54:02 +00002736 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
dan19611b12011-01-24 16:00:58 +00002737 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00002738}
drh4cf7c7f2007-08-28 23:28:07 +00002739
drh92f02c32004-09-02 14:57:08 +00002740
2741/*
drh3c23a882007-01-09 14:01:13 +00002742** Each VDBE holds the result of the most recent sqlite3_step() call
2743** in p->rc. This routine sets that result back to SQLITE_OK.
2744*/
2745void sqlite3VdbeResetStepResult(Vdbe *p){
2746 p->rc = SQLITE_OK;
2747}
2748
2749/*
dan029ead62011-10-27 15:19:58 +00002750** Copy the error code and error message belonging to the VDBE passed
2751** as the first argument to its database handle (so that they will be
2752** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
2753**
2754** This function does not clear the VDBE error code or message, just
2755** copies them to the database handle.
2756*/
2757int sqlite3VdbeTransferError(Vdbe *p){
2758 sqlite3 *db = p->db;
2759 int rc = p->rc;
2760 if( p->zErrMsg ){
drh4a642b62016-02-05 01:55:27 +00002761 db->bBenignMalloc++;
dan029ead62011-10-27 15:19:58 +00002762 sqlite3BeginBenignMalloc();
drha3cc0072013-12-13 16:23:55 +00002763 if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
dan029ead62011-10-27 15:19:58 +00002764 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
2765 sqlite3EndBenignMalloc();
drh4a642b62016-02-05 01:55:27 +00002766 db->bBenignMalloc--;
dan029ead62011-10-27 15:19:58 +00002767 db->errCode = rc;
2768 }else{
drh13f40da2014-08-22 18:00:11 +00002769 sqlite3Error(db, rc);
dan029ead62011-10-27 15:19:58 +00002770 }
2771 return rc;
2772}
2773
danac455932012-11-26 19:50:41 +00002774#ifdef SQLITE_ENABLE_SQLLOG
2775/*
2776** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
2777** invoke it.
2778*/
2779static void vdbeInvokeSqllog(Vdbe *v){
2780 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
2781 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
2782 assert( v->db->init.busy==0 );
2783 if( zExpanded ){
2784 sqlite3GlobalConfig.xSqllog(
2785 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
2786 );
2787 sqlite3DbFree(v->db, zExpanded);
2788 }
2789 }
2790}
2791#else
2792# define vdbeInvokeSqllog(x)
2793#endif
2794
dan029ead62011-10-27 15:19:58 +00002795/*
drh92f02c32004-09-02 14:57:08 +00002796** Clean up a VDBE after execution but do not delete the VDBE just yet.
2797** Write any error messages into *pzErrMsg. Return the result code.
2798**
2799** After this routine is run, the VDBE should be ready to be executed
2800** again.
2801**
2802** To look at it another way, this routine resets the state of the
2803** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
2804** VDBE_MAGIC_INIT.
2805*/
drhc890fec2008-08-01 20:10:08 +00002806int sqlite3VdbeReset(Vdbe *p){
drh4ac285a2006-09-15 07:28:50 +00002807 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00002808 db = p->db;
drh92f02c32004-09-02 14:57:08 +00002809
2810 /* If the VM did not run to completion or if it encountered an
2811 ** error, then it might not have been halted properly. So halt
2812 ** it now.
2813 */
2814 sqlite3VdbeHalt(p);
2815
drhfb7e7652005-01-24 00:28:42 +00002816 /* If the VDBE has be run even partially, then transfer the error code
2817 ** and error message from the VDBE into the main database structure. But
2818 ** if the VDBE has just been set to run but has not actually executed any
2819 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00002820 */
drhfb7e7652005-01-24 00:28:42 +00002821 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00002822 vdbeInvokeSqllog(p);
dan029ead62011-10-27 15:19:58 +00002823 sqlite3VdbeTransferError(p);
2824 sqlite3DbFree(db, p->zErrMsg);
2825 p->zErrMsg = 0;
drh4611d922010-02-25 14:47:01 +00002826 if( p->runOnlyOnce ) p->expired = 1;
danielk1977a21c6b62005-01-24 10:25:59 +00002827 }else if( p->rc && p->expired ){
2828 /* The expired flag was set on the VDBE before the first call
2829 ** to sqlite3_step(). For consistency (since sqlite3_step() was
2830 ** called), set the database error in this case as well.
2831 */
drh13f40da2014-08-22 18:00:11 +00002832 sqlite3ErrorWithMsg(db, p->rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002833 sqlite3DbFree(db, p->zErrMsg);
danielk19778e556522007-11-13 10:30:24 +00002834 p->zErrMsg = 0;
drh92f02c32004-09-02 14:57:08 +00002835 }
2836
2837 /* Reclaim all memory used by the VDBE
2838 */
drhc890fec2008-08-01 20:10:08 +00002839 Cleanup(p);
drh92f02c32004-09-02 14:57:08 +00002840
2841 /* Save profiling information from this VDBE run.
2842 */
drh9a324642003-09-06 20:12:01 +00002843#ifdef VDBE_PROFILE
2844 {
2845 FILE *out = fopen("vdbe_profile.out", "a");
2846 if( out ){
2847 int i;
2848 fprintf(out, "---- ");
2849 for(i=0; i<p->nOp; i++){
2850 fprintf(out, "%02x", p->aOp[i].opcode);
2851 }
2852 fprintf(out, "\n");
drh2926f962014-02-17 01:13:28 +00002853 if( p->zSql ){
2854 char c, pc = 0;
2855 fprintf(out, "-- ");
2856 for(i=0; (c = p->zSql[i])!=0; i++){
2857 if( pc=='\n' ) fprintf(out, "-- ");
2858 putc(c, out);
2859 pc = c;
2860 }
2861 if( pc!='\n' ) fprintf(out, "\n");
2862 }
drh9a324642003-09-06 20:12:01 +00002863 for(i=0; i<p->nOp; i++){
drh15ab9412014-02-24 14:24:01 +00002864 char zHdr[100];
2865 sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
drh9a324642003-09-06 20:12:01 +00002866 p->aOp[i].cnt,
2867 p->aOp[i].cycles,
2868 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
2869 );
drh15ab9412014-02-24 14:24:01 +00002870 fprintf(out, "%s", zHdr);
danielk19774adee202004-05-08 08:23:19 +00002871 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00002872 }
2873 fclose(out);
2874 }
2875 }
2876#endif
drh7fa20922013-09-17 23:36:33 +00002877 p->iCurrentTime = 0;
drh9a324642003-09-06 20:12:01 +00002878 p->magic = VDBE_MAGIC_INIT;
drh4ac285a2006-09-15 07:28:50 +00002879 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00002880}
drh92f02c32004-09-02 14:57:08 +00002881
drh9a324642003-09-06 20:12:01 +00002882/*
2883** Clean up and delete a VDBE after execution. Return an integer which is
2884** the result code. Write any error message text into *pzErrMsg.
2885*/
danielk19779e6db7d2004-06-21 08:18:51 +00002886int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00002887 int rc = SQLITE_OK;
danielk1977b5548a82004-06-26 13:51:33 +00002888 if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
drhc890fec2008-08-01 20:10:08 +00002889 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00002890 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00002891 }
danielk19774adee202004-05-08 08:23:19 +00002892 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00002893 return rc;
2894}
2895
2896/*
dan0c547792013-07-18 17:12:08 +00002897** If parameter iOp is less than zero, then invoke the destructor for
2898** all auxiliary data pointers currently cached by the VM passed as
2899** the first argument.
2900**
2901** Or, if iOp is greater than or equal to zero, then the destructor is
2902** only invoked for those auxiliary data pointers created by the user
2903** function invoked by the OP_Function opcode at instruction iOp of
2904** VM pVdbe, and only then if:
2905**
2906** * the associated function parameter is the 32nd or later (counting
2907** from left to right), or
2908**
2909** * the corresponding bit in argument mask is clear (where the first
peter.d.reid60ec9142014-09-06 16:39:46 +00002910** function parameter corresponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00002911*/
drhb9626cf2016-02-22 16:04:31 +00002912void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
dan0c547792013-07-18 17:12:08 +00002913 while( *pp ){
2914 AuxData *pAux = *pp;
2915 if( (iOp<0)
drh693e6712014-01-24 22:58:00 +00002916 || (pAux->iOp==iOp && (pAux->iArg>31 || !(mask & MASKBIT32(pAux->iArg))))
dan0c547792013-07-18 17:12:08 +00002917 ){
drh693e6712014-01-24 22:58:00 +00002918 testcase( pAux->iArg==31 );
drhf92c7ff2004-06-19 15:40:23 +00002919 if( pAux->xDelete ){
2920 pAux->xDelete(pAux->pAux);
2921 }
dan0c547792013-07-18 17:12:08 +00002922 *pp = pAux->pNext;
drhb9626cf2016-02-22 16:04:31 +00002923 sqlite3DbFree(db, pAux);
dan0c547792013-07-18 17:12:08 +00002924 }else{
2925 pp= &pAux->pNext;
drhf92c7ff2004-06-19 15:40:23 +00002926 }
2927 }
2928}
2929
2930/*
drhcb103b92012-10-26 00:11:23 +00002931** Free all memory associated with the Vdbe passed as the second argument,
2932** except for object itself, which is preserved.
2933**
dand46def72010-07-24 11:28:28 +00002934** The difference between this function and sqlite3VdbeDelete() is that
2935** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00002936** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00002937*/
drhcb103b92012-10-26 00:11:23 +00002938void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00002939 SubProgram *pSub, *pNext;
drh124c0b42011-06-01 18:15:55 +00002940 int i;
dand46def72010-07-24 11:28:28 +00002941 assert( p->db==0 || p->db==db );
2942 releaseMemArray(p->aVar, p->nVar);
2943 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
dand19c9332010-07-26 12:05:17 +00002944 for(pSub=p->pProgram; pSub; pSub=pNext){
2945 pNext = pSub->pNext;
2946 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
2947 sqlite3DbFree(db, pSub);
2948 }
drh124c0b42011-06-01 18:15:55 +00002949 for(i=p->nzVar-1; i>=0; i--) sqlite3DbFree(db, p->azVar[i]);
drh6d664b42016-01-20 01:48:25 +00002950 sqlite3DbFree(db, p->azVar);
dand46def72010-07-24 11:28:28 +00002951 vdbeFreeOpArray(db, p->aOp, p->nOp);
dand46def72010-07-24 11:28:28 +00002952 sqlite3DbFree(db, p->aColName);
2953 sqlite3DbFree(db, p->zSql);
2954 sqlite3DbFree(db, p->pFree);
dan6f9702e2014-11-01 20:38:06 +00002955#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan6f9702e2014-11-01 20:38:06 +00002956 for(i=0; i<p->nScan; i++){
2957 sqlite3DbFree(db, p->aScan[i].zName);
2958 }
2959 sqlite3DbFree(db, p->aScan);
2960#endif
dand46def72010-07-24 11:28:28 +00002961}
2962
2963/*
drh9a324642003-09-06 20:12:01 +00002964** Delete an entire VDBE.
2965*/
danielk19774adee202004-05-08 08:23:19 +00002966void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002967 sqlite3 *db;
2968
drhfa3be902009-07-07 02:44:07 +00002969 if( NEVER(p==0) ) return;
drh633e6d52008-07-28 19:34:53 +00002970 db = p->db;
drh4245c402012-06-02 14:32:21 +00002971 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00002972 sqlite3VdbeClearObject(db, p);
drh9a324642003-09-06 20:12:01 +00002973 if( p->pPrev ){
2974 p->pPrev->pNext = p->pNext;
2975 }else{
drh633e6d52008-07-28 19:34:53 +00002976 assert( db->pVdbe==p );
2977 db->pVdbe = p->pNext;
drh9a324642003-09-06 20:12:01 +00002978 }
2979 if( p->pNext ){
2980 p->pNext->pPrev = p->pPrev;
2981 }
drh9a324642003-09-06 20:12:01 +00002982 p->magic = VDBE_MAGIC_DEAD;
drh87f5c5f2010-01-20 01:20:56 +00002983 p->db = 0;
drhcb103b92012-10-26 00:11:23 +00002984 sqlite3DbFree(db, p);
drh9a324642003-09-06 20:12:01 +00002985}
drha11846b2004-01-07 18:52:56 +00002986
2987/*
drh6848dad2014-08-22 23:33:03 +00002988** The cursor "p" has a pending seek operation that has not yet been
2989** carried out. Seek the cursor now. If an error occurs, return
2990** the appropriate error code.
2991*/
2992static int SQLITE_NOINLINE handleDeferredMoveto(VdbeCursor *p){
2993 int res, rc;
2994#ifdef SQLITE_TEST
2995 extern int sqlite3_search_count;
2996#endif
2997 assert( p->deferredMoveto );
2998 assert( p->isTable );
drhc960dcb2015-11-20 19:22:01 +00002999 assert( p->eCurType==CURTYPE_BTREE );
3000 rc = sqlite3BtreeMovetoUnpacked(p->uc.pCursor, 0, p->movetoTarget, 0, &res);
drh6848dad2014-08-22 23:33:03 +00003001 if( rc ) return rc;
drh6848dad2014-08-22 23:33:03 +00003002 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
drh6848dad2014-08-22 23:33:03 +00003003#ifdef SQLITE_TEST
3004 sqlite3_search_count++;
3005#endif
3006 p->deferredMoveto = 0;
3007 p->cacheStatus = CACHE_STALE;
3008 return SQLITE_OK;
3009}
3010
3011/*
3012** Something has moved cursor "p" out of place. Maybe the row it was
3013** pointed to was deleted out from under it. Or maybe the btree was
3014** rebalanced. Whatever the cause, try to restore "p" to the place it
peter.d.reid60ec9142014-09-06 16:39:46 +00003015** is supposed to be pointing. If the row was deleted out from under the
drh6848dad2014-08-22 23:33:03 +00003016** cursor, set the cursor to point to a NULL row.
3017*/
3018static int SQLITE_NOINLINE handleMovedCursor(VdbeCursor *p){
3019 int isDifferentRow, rc;
drhc960dcb2015-11-20 19:22:01 +00003020 assert( p->eCurType==CURTYPE_BTREE );
3021 assert( p->uc.pCursor!=0 );
3022 assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
3023 rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
drh6848dad2014-08-22 23:33:03 +00003024 p->cacheStatus = CACHE_STALE;
3025 if( isDifferentRow ) p->nullRow = 1;
3026 return rc;
3027}
3028
3029/*
drhc22284f2014-10-13 16:02:20 +00003030** Check to ensure that the cursor is valid. Restore the cursor
3031** if need be. Return any I/O error from the restore operation.
3032*/
3033int sqlite3VdbeCursorRestore(VdbeCursor *p){
drhc960dcb2015-11-20 19:22:01 +00003034 assert( p->eCurType==CURTYPE_BTREE );
3035 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
drhc22284f2014-10-13 16:02:20 +00003036 return handleMovedCursor(p);
3037 }
3038 return SQLITE_OK;
3039}
3040
3041/*
drh9a65f2c2009-06-22 19:05:40 +00003042** Make sure the cursor p is ready to read or write the row to which it
3043** was last positioned. Return an error code if an OOM fault or I/O error
3044** prevents us from positioning the cursor to its correct position.
3045**
drha11846b2004-01-07 18:52:56 +00003046** If a MoveTo operation is pending on the given cursor, then do that
drh9a65f2c2009-06-22 19:05:40 +00003047** MoveTo now. If no move is pending, check to see if the row has been
3048** deleted out from under the cursor and if it has, mark the row as
3049** a NULL row.
3050**
3051** If the cursor is already pointing to the correct row and that row has
3052** not been deleted out from under the cursor, then this routine is a no-op.
drha11846b2004-01-07 18:52:56 +00003053*/
dande892d92016-01-29 19:29:45 +00003054int sqlite3VdbeCursorMoveto(VdbeCursor **pp, int *piCol){
3055 VdbeCursor *p = *pp;
drhc960dcb2015-11-20 19:22:01 +00003056 if( p->eCurType==CURTYPE_BTREE ){
3057 if( p->deferredMoveto ){
drhb1702022016-01-30 00:45:18 +00003058 int iMap;
3059 if( p->aAltMap && (iMap = p->aAltMap[1+*piCol])>0 ){
dande892d92016-01-29 19:29:45 +00003060 *pp = p->pAltCursor;
drhb1702022016-01-30 00:45:18 +00003061 *piCol = iMap - 1;
dande892d92016-01-29 19:29:45 +00003062 return SQLITE_OK;
3063 }
drhc960dcb2015-11-20 19:22:01 +00003064 return handleDeferredMoveto(p);
3065 }
3066 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
3067 return handleMovedCursor(p);
3068 }
drha11846b2004-01-07 18:52:56 +00003069 }
3070 return SQLITE_OK;
3071}
danielk19774adee202004-05-08 08:23:19 +00003072
drhab9f7f12004-05-08 10:56:11 +00003073/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003074** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00003075**
danielk1977cfcdaef2004-05-12 07:33:33 +00003076** sqlite3VdbeSerialType()
3077** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00003078** sqlite3VdbeSerialLen()
shane92003092008-07-31 01:43:13 +00003079** sqlite3VdbeSerialPut()
3080** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00003081**
3082** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00003083** data and index records. Each serialized value consists of a
3084** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
3085** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00003086**
danielk1977cfcdaef2004-05-12 07:33:33 +00003087** In an SQLite index record, the serial type is stored directly before
3088** the blob of data that it corresponds to. In a table record, all serial
3089** types are stored at the start of the record, and the blobs of data at
3090** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00003091** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00003092**
3093** The following table describes the various storage classes for data:
3094**
3095** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00003096** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00003097** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00003098** 1 1 signed integer
3099** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00003100** 3 3 signed integer
3101** 4 4 signed integer
3102** 5 6 signed integer
3103** 6 8 signed integer
3104** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00003105** 8 0 Integer constant 0
3106** 9 0 Integer constant 1
3107** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00003108** N>=12 and even (N-12)/2 BLOB
3109** N>=13 and odd (N-13)/2 text
3110**
drh35a59652006-01-02 18:24:40 +00003111** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
3112** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00003113*/
3114
3115/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003116** Return the serial-type for the value stored in pMem.
danielk1977192ac1d2004-05-10 07:17:30 +00003117*/
drhbe37c122015-10-16 14:54:17 +00003118u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
danielk1977cfcdaef2004-05-12 07:33:33 +00003119 int flags = pMem->flags;
drheac5bd72014-07-25 21:35:39 +00003120 u32 n;
danielk1977cfcdaef2004-05-12 07:33:33 +00003121
drhbe37c122015-10-16 14:54:17 +00003122 assert( pLen!=0 );
danielk1977cfcdaef2004-05-12 07:33:33 +00003123 if( flags&MEM_Null ){
drhbe37c122015-10-16 14:54:17 +00003124 *pLen = 0;
drha19b7752004-05-30 21:14:58 +00003125 return 0;
danielk197790e4d952004-05-10 10:05:53 +00003126 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003127 if( flags&MEM_Int ){
drhfe2093d2005-01-20 22:48:47 +00003128 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00003129# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00003130 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00003131 u64 u;
drhcfd654b2011-03-05 13:54:15 +00003132 if( i<0 ){
drh1b40e632014-11-20 02:58:10 +00003133 u = ~i;
drhcfd654b2011-03-05 13:54:15 +00003134 }else{
3135 u = i;
3136 }
drh56690b32012-09-17 15:36:31 +00003137 if( u<=127 ){
drhbe37c122015-10-16 14:54:17 +00003138 if( (i&1)==i && file_format>=4 ){
3139 *pLen = 0;
3140 return 8+(u32)u;
3141 }else{
3142 *pLen = 1;
3143 return 1;
3144 }
drh56690b32012-09-17 15:36:31 +00003145 }
drhbe37c122015-10-16 14:54:17 +00003146 if( u<=32767 ){ *pLen = 2; return 2; }
3147 if( u<=8388607 ){ *pLen = 3; return 3; }
3148 if( u<=2147483647 ){ *pLen = 4; return 4; }
3149 if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
3150 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003151 return 6;
danielk197790e4d952004-05-10 10:05:53 +00003152 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003153 if( flags&MEM_Real ){
drhbe37c122015-10-16 14:54:17 +00003154 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003155 return 7;
danielk197790e4d952004-05-10 10:05:53 +00003156 }
danielk1977e4359752008-11-03 09:39:45 +00003157 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drheac5bd72014-07-25 21:35:39 +00003158 assert( pMem->n>=0 );
3159 n = (u32)pMem->n;
drhfdf972a2007-05-02 13:30:27 +00003160 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00003161 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00003162 }
drhbe37c122015-10-16 14:54:17 +00003163 *pLen = n;
drhfdf972a2007-05-02 13:30:27 +00003164 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00003165}
3166
3167/*
drhfaf37272015-10-16 14:23:42 +00003168** The sizes for serial types less than 128
drhc5ef7152015-06-28 02:58:51 +00003169*/
3170static const u8 sqlite3SmallTypeSizes[] = {
drhfaf37272015-10-16 14:23:42 +00003171 /* 0 1 2 3 4 5 6 7 8 9 */
3172/* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
3173/* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
3174/* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
3175/* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
3176/* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
3177/* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
3178/* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
3179/* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
3180/* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
3181/* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
3182/* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
3183/* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
3184/* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
drhc5ef7152015-06-28 02:58:51 +00003185};
3186
3187/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003188** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00003189*/
drh35cd6432009-06-05 14:17:21 +00003190u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drhfaf37272015-10-16 14:23:42 +00003191 if( serial_type>=128 ){
drh51846b52004-05-28 16:00:21 +00003192 return (serial_type-12)/2;
3193 }else{
drhfaf37272015-10-16 14:23:42 +00003194 assert( serial_type<12
3195 || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
drhc5ef7152015-06-28 02:58:51 +00003196 return sqlite3SmallTypeSizes[serial_type];
drh51846b52004-05-28 16:00:21 +00003197 }
danielk1977192ac1d2004-05-10 07:17:30 +00003198}
drhfaf37272015-10-16 14:23:42 +00003199u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
3200 assert( serial_type<128 );
3201 return sqlite3SmallTypeSizes[serial_type];
3202}
danielk1977192ac1d2004-05-10 07:17:30 +00003203
3204/*
drh110daac2007-05-04 11:59:31 +00003205** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00003206** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00003207** upper 4 bytes. Return the result.
3208**
drh7a4f5022007-05-23 07:20:08 +00003209** For most architectures, this is a no-op.
3210**
3211** (later): It is reported to me that the mixed-endian problem
3212** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
3213** that early versions of GCC stored the two words of a 64-bit
3214** float in the wrong order. And that error has been propagated
3215** ever since. The blame is not necessarily with GCC, though.
3216** GCC might have just copying the problem from a prior compiler.
3217** I am also told that newer versions of GCC that follow a different
3218** ABI get the byte order right.
3219**
3220** Developers using SQLite on an ARM7 should compile and run their
3221** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
3222** enabled, some asserts below will ensure that the byte order of
3223** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00003224**
3225** (2007-08-30) Frank van Vugt has studied this problem closely
3226** and has send his findings to the SQLite developers. Frank
3227** writes that some Linux kernels offer floating point hardware
3228** emulation that uses only 32-bit mantissas instead of a full
3229** 48-bits as required by the IEEE standard. (This is the
3230** CONFIG_FPE_FASTFPE option.) On such systems, floating point
3231** byte swapping becomes very complicated. To avoid problems,
3232** the necessary byte swapping is carried out using a 64-bit integer
3233** rather than a 64-bit float. Frank assures us that the code here
3234** works for him. We, the developers, have no way to independently
3235** verify this, but Frank seems to know what he is talking about
3236** so we trust him.
drh110daac2007-05-04 11:59:31 +00003237*/
3238#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh60d09a72007-08-30 15:05:08 +00003239static u64 floatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00003240 union {
drh60d09a72007-08-30 15:05:08 +00003241 u64 r;
drh110daac2007-05-04 11:59:31 +00003242 u32 i[2];
3243 } u;
3244 u32 t;
3245
3246 u.r = in;
3247 t = u.i[0];
3248 u.i[0] = u.i[1];
3249 u.i[1] = t;
3250 return u.r;
3251}
3252# define swapMixedEndianFloat(X) X = floatSwap(X)
3253#else
3254# define swapMixedEndianFloat(X)
3255#endif
3256
3257/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003258** Write the serialized data blob for the value stored in pMem into
3259** buf. It is assumed that the caller has allocated sufficient space.
3260** Return the number of bytes written.
drhfdf972a2007-05-02 13:30:27 +00003261**
drh038b7bc2013-12-09 23:17:22 +00003262** nBuf is the amount of space left in buf[]. The caller is responsible
3263** for allocating enough space to buf[] to hold the entire field, exclusive
3264** of the pMem->u.nZero bytes for a MEM_Zero value.
drhfdf972a2007-05-02 13:30:27 +00003265**
3266** Return the number of bytes actually written into buf[]. The number
3267** of bytes in the zero-filled tail is included in the return value only
3268** if those bytes were zeroed in buf[].
danielk1977cfcdaef2004-05-12 07:33:33 +00003269*/
drha9ab4812013-12-11 11:00:44 +00003270u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
drh35cd6432009-06-05 14:17:21 +00003271 u32 len;
danielk1977183f9f72004-05-13 05:20:26 +00003272
drh1483e142004-05-21 21:12:42 +00003273 /* Integer and Real */
drhd946db02005-12-29 19:23:06 +00003274 if( serial_type<=7 && serial_type>0 ){
drh1483e142004-05-21 21:12:42 +00003275 u64 v;
drh35cd6432009-06-05 14:17:21 +00003276 u32 i;
drha19b7752004-05-30 21:14:58 +00003277 if( serial_type==7 ){
drh74eaba42014-09-18 17:52:15 +00003278 assert( sizeof(v)==sizeof(pMem->u.r) );
3279 memcpy(&v, &pMem->u.r, sizeof(v));
drh60d09a72007-08-30 15:05:08 +00003280 swapMixedEndianFloat(v);
drh1483e142004-05-21 21:12:42 +00003281 }else{
drh3c024d62007-03-30 11:23:45 +00003282 v = pMem->u.i;
danielk1977cfcdaef2004-05-12 07:33:33 +00003283 }
drhc5ef7152015-06-28 02:58:51 +00003284 len = i = sqlite3SmallTypeSizes[serial_type];
drh3f5b1992014-08-22 13:22:32 +00003285 assert( i>0 );
3286 do{
3287 buf[--i] = (u8)(v&0xFF);
drh1483e142004-05-21 21:12:42 +00003288 v >>= 8;
drh3f5b1992014-08-22 13:22:32 +00003289 }while( i );
drh1483e142004-05-21 21:12:42 +00003290 return len;
danielk1977cfcdaef2004-05-12 07:33:33 +00003291 }
drhd946db02005-12-29 19:23:06 +00003292
danielk1977cfcdaef2004-05-12 07:33:33 +00003293 /* String or blob */
drhd946db02005-12-29 19:23:06 +00003294 if( serial_type>=12 ){
drh8df32842008-12-09 02:51:23 +00003295 assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
shane75ac1de2009-06-09 18:58:52 +00003296 == (int)sqlite3VdbeSerialTypeLen(serial_type) );
drhfdf972a2007-05-02 13:30:27 +00003297 len = pMem->n;
drh72ea29d2015-12-08 16:58:45 +00003298 if( len>0 ) memcpy(buf, pMem->z, len);
drhd946db02005-12-29 19:23:06 +00003299 return len;
3300 }
3301
3302 /* NULL or constants 0 or 1 */
3303 return 0;
danielk1977cfcdaef2004-05-12 07:33:33 +00003304}
3305
drhf926d1e2014-03-04 04:04:33 +00003306/* Input "x" is a sequence of unsigned characters that represent a
3307** big-endian integer. Return the equivalent native integer
3308*/
3309#define ONE_BYTE_INT(x) ((i8)(x)[0])
3310#define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
3311#define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
3312#define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drh8932bec2014-08-22 14:56:13 +00003313#define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drhf926d1e2014-03-04 04:04:33 +00003314
danielk1977cfcdaef2004-05-12 07:33:33 +00003315/*
3316** Deserialize the data blob pointed to by buf as serial type serial_type
3317** and store the result in pMem. Return the number of bytes read.
drh14a924a2014-08-22 14:34:05 +00003318**
3319** This function is implemented as two separate routines for performance.
3320** The few cases that require local variables are broken out into a separate
3321** routine so that in most cases the overhead of moving the stack pointer
3322** is avoided.
danielk1977cfcdaef2004-05-12 07:33:33 +00003323*/
drh14a924a2014-08-22 14:34:05 +00003324static u32 SQLITE_NOINLINE serialGet(
danielk197793d46752004-05-23 13:30:58 +00003325 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00003326 u32 serial_type, /* Serial type to deserialize */
3327 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00003328){
drh8932bec2014-08-22 14:56:13 +00003329 u64 x = FOUR_BYTE_UINT(buf);
3330 u32 y = FOUR_BYTE_UINT(buf+4);
3331 x = (x<<32) + y;
drh14a924a2014-08-22 14:34:05 +00003332 if( serial_type==6 ){
drh654858d2014-11-20 02:18:14 +00003333 /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
3334 ** twos-complement integer. */
drh14a924a2014-08-22 14:34:05 +00003335 pMem->u.i = *(i64*)&x;
3336 pMem->flags = MEM_Int;
3337 testcase( pMem->u.i<0 );
3338 }else{
drh654858d2014-11-20 02:18:14 +00003339 /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
3340 ** floating point number. */
drh14a924a2014-08-22 14:34:05 +00003341#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
3342 /* Verify that integers and floating point values use the same
3343 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
3344 ** defined that 64-bit floating point values really are mixed
3345 ** endian.
3346 */
3347 static const u64 t1 = ((u64)0x3ff00000)<<32;
3348 static const double r1 = 1.0;
3349 u64 t2 = t1;
3350 swapMixedEndianFloat(t2);
3351 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
3352#endif
drh74eaba42014-09-18 17:52:15 +00003353 assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
drh14a924a2014-08-22 14:34:05 +00003354 swapMixedEndianFloat(x);
drh74eaba42014-09-18 17:52:15 +00003355 memcpy(&pMem->u.r, &x, sizeof(x));
3356 pMem->flags = sqlite3IsNaN(pMem->u.r) ? MEM_Null : MEM_Real;
drh14a924a2014-08-22 14:34:05 +00003357 }
3358 return 8;
3359}
danielk1977b1bc9532004-05-22 03:05:33 +00003360u32 sqlite3VdbeSerialGet(
3361 const unsigned char *buf, /* Buffer to deserialize from */
3362 u32 serial_type, /* Serial type to deserialize */
3363 Mem *pMem /* Memory cell to write value into */
3364){
drh3c685822005-05-21 18:32:18 +00003365 switch( serial_type ){
drh3c685822005-05-21 18:32:18 +00003366 case 10: /* Reserved for future use */
3367 case 11: /* Reserved for future use */
drh654858d2014-11-20 02:18:14 +00003368 case 0: { /* Null */
3369 /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
drh3c685822005-05-21 18:32:18 +00003370 pMem->flags = MEM_Null;
3371 break;
3372 }
drh654858d2014-11-20 02:18:14 +00003373 case 1: {
3374 /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
3375 ** integer. */
drhf926d1e2014-03-04 04:04:33 +00003376 pMem->u.i = ONE_BYTE_INT(buf);
drh1483e142004-05-21 21:12:42 +00003377 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003378 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003379 return 1;
drh1483e142004-05-21 21:12:42 +00003380 }
drh3c685822005-05-21 18:32:18 +00003381 case 2: { /* 2-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003382 /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
3383 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003384 pMem->u.i = TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003385 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003386 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003387 return 2;
3388 }
3389 case 3: { /* 3-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003390 /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
3391 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003392 pMem->u.i = THREE_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003393 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003394 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003395 return 3;
3396 }
3397 case 4: { /* 4-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003398 /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
3399 ** twos-complement integer. */
drh8932bec2014-08-22 14:56:13 +00003400 pMem->u.i = FOUR_BYTE_INT(buf);
drhc8bb4302015-11-06 17:28:00 +00003401#ifdef __HP_cc
3402 /* Work around a sign-extension bug in the HP compiler for HP/UX */
3403 if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
3404#endif
drh3c685822005-05-21 18:32:18 +00003405 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003406 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003407 return 4;
3408 }
3409 case 5: { /* 6-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003410 /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
3411 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003412 pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003413 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003414 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003415 return 6;
3416 }
drh91124b32005-08-18 18:15:05 +00003417 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00003418 case 7: { /* IEEE floating point */
drh8932bec2014-08-22 14:56:13 +00003419 /* These use local variables, so do them in a separate routine
3420 ** to avoid having to move the frame pointer in the common case */
drh14a924a2014-08-22 14:34:05 +00003421 return serialGet(buf,serial_type,pMem);
drh3c685822005-05-21 18:32:18 +00003422 }
drhd946db02005-12-29 19:23:06 +00003423 case 8: /* Integer 0 */
3424 case 9: { /* Integer 1 */
drh654858d2014-11-20 02:18:14 +00003425 /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
3426 /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
drh3c024d62007-03-30 11:23:45 +00003427 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00003428 pMem->flags = MEM_Int;
3429 return 0;
3430 }
drh3c685822005-05-21 18:32:18 +00003431 default: {
drh654858d2014-11-20 02:18:14 +00003432 /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
3433 ** length.
3434 ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
3435 ** (N-13)/2 bytes in length. */
drhc138daf2013-11-19 13:55:34 +00003436 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh3c685822005-05-21 18:32:18 +00003437 pMem->z = (char *)buf;
drh14a924a2014-08-22 14:34:05 +00003438 pMem->n = (serial_type-12)/2;
drhc138daf2013-11-19 13:55:34 +00003439 pMem->flags = aFlag[serial_type&1];
drh14a924a2014-08-22 14:34:05 +00003440 return pMem->n;
drh696b32f2004-05-30 01:51:52 +00003441 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003442 }
drh3c685822005-05-21 18:32:18 +00003443 return 0;
danielk1977192ac1d2004-05-10 07:17:30 +00003444}
drh1e968a02008-03-25 00:22:21 +00003445/*
dan03e9cfc2011-09-05 14:20:27 +00003446** This routine is used to allocate sufficient space for an UnpackedRecord
3447** structure large enough to be used with sqlite3VdbeRecordUnpack() if
3448** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00003449**
dan03e9cfc2011-09-05 14:20:27 +00003450** The space is either allocated using sqlite3DbMallocRaw() or from within
3451** the unaligned buffer passed via the second and third arguments (presumably
3452** stack space). If the former, then *ppFree is set to a pointer that should
3453** be eventually freed by the caller using sqlite3DbFree(). Or, if the
3454** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
3455** before returning.
drh1e968a02008-03-25 00:22:21 +00003456**
dan03e9cfc2011-09-05 14:20:27 +00003457** If an OOM error occurs, NULL is returned.
3458*/
3459UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
3460 KeyInfo *pKeyInfo, /* Description of the record */
3461 char *pSpace, /* Unaligned space available */
3462 int szSpace, /* Size of pSpace[] in bytes */
3463 char **ppFree /* OUT: Caller should free this pointer */
drh1e968a02008-03-25 00:22:21 +00003464){
dan03e9cfc2011-09-05 14:20:27 +00003465 UnpackedRecord *p; /* Unpacked record to return */
3466 int nOff; /* Increment pSpace by nOff to align it */
3467 int nByte; /* Number of bytes required for *p */
3468
3469 /* We want to shift the pointer pSpace up such that it is 8-byte aligned.
shane80167bf2009-04-10 15:42:36 +00003470 ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
3471 ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
3472 */
3473 nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
drh8c5d1522009-04-10 00:56:28 +00003474 nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
dan42acb3e2011-09-05 20:16:38 +00003475 if( nByte>szSpace+nOff ){
dan03e9cfc2011-09-05 14:20:27 +00003476 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
3477 *ppFree = (char *)p;
dan42acb3e2011-09-05 20:16:38 +00003478 if( !p ) return 0;
drh1e968a02008-03-25 00:22:21 +00003479 }else{
dan42acb3e2011-09-05 20:16:38 +00003480 p = (UnpackedRecord*)&pSpace[nOff];
dan03e9cfc2011-09-05 14:20:27 +00003481 *ppFree = 0;
drh1e968a02008-03-25 00:22:21 +00003482 }
dan42acb3e2011-09-05 20:16:38 +00003483
3484 p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
drhe1a022e2012-09-17 17:16:53 +00003485 assert( pKeyInfo->aSortOrder!=0 );
drh1e968a02008-03-25 00:22:21 +00003486 p->pKeyInfo = pKeyInfo;
3487 p->nField = pKeyInfo->nField + 1;
dan03e9cfc2011-09-05 14:20:27 +00003488 return p;
3489}
3490
3491/*
3492** Given the nKey-byte encoding of a record in pKey[], populate the
3493** UnpackedRecord structure indicated by the fourth argument with the
3494** contents of the decoded record.
3495*/
3496void sqlite3VdbeRecordUnpack(
3497 KeyInfo *pKeyInfo, /* Information about the record format */
3498 int nKey, /* Size of the binary record */
3499 const void *pKey, /* The binary record */
3500 UnpackedRecord *p /* Populate this structure before returning. */
3501){
3502 const unsigned char *aKey = (const unsigned char *)pKey;
3503 int d;
3504 u32 idx; /* Offset in aKey[] to read from */
3505 u16 u; /* Unsigned loop counter */
3506 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00003507 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00003508
dan1fed5da2014-02-25 21:01:25 +00003509 p->default_rc = 0;
drh8c5d1522009-04-10 00:56:28 +00003510 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00003511 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00003512 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00003513 u = 0;
drh7f4b19f2014-09-16 13:30:05 +00003514 while( idx<szHdr && d<=nKey ){
drh1e968a02008-03-25 00:22:21 +00003515 u32 serial_type;
3516
danielk197700e13612008-11-17 19:18:54 +00003517 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00003518 pMem->enc = pKeyInfo->enc;
3519 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00003520 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
drh17bcb102014-09-18 21:25:33 +00003521 pMem->szMalloc = 0;
drh304637c2011-03-18 16:47:27 +00003522 pMem->z = 0;
drh1e968a02008-03-25 00:22:21 +00003523 d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
drhe14006d2008-03-25 17:23:32 +00003524 pMem++;
drh7f4b19f2014-09-16 13:30:05 +00003525 if( (++u)>=p->nField ) break;
drh1e968a02008-03-25 00:22:21 +00003526 }
drh7d10d5a2008-08-20 16:35:10 +00003527 assert( u<=pKeyInfo->nField + 1 );
shane0b8d2762008-07-22 05:18:00 +00003528 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00003529}
3530
dan3833e932014-03-01 19:44:56 +00003531#if SQLITE_DEBUG
drh1e968a02008-03-25 00:22:21 +00003532/*
dan3833e932014-03-01 19:44:56 +00003533** This function compares two index or table record keys in the same way
3534** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
3535** this function deserializes and compares values using the
3536** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
3537** in assert() statements to ensure that the optimized code in
3538** sqlite3VdbeRecordCompare() returns results with these two primitives.
drh79211e12014-05-02 17:33:16 +00003539**
3540** Return true if the result of comparison is equivalent to desiredResult.
3541** Return false if there is a disagreement.
drh1e968a02008-03-25 00:22:21 +00003542*/
dan3833e932014-03-01 19:44:56 +00003543static int vdbeRecordCompareDebug(
drhec1fc802008-08-13 14:07:40 +00003544 int nKey1, const void *pKey1, /* Left key */
drh79211e12014-05-02 17:33:16 +00003545 const UnpackedRecord *pPKey2, /* Right key */
3546 int desiredResult /* Correct answer */
drh1e968a02008-03-25 00:22:21 +00003547){
drhdf003d62013-08-01 19:17:39 +00003548 u32 d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00003549 u32 idx1; /* Offset into aKey[] of next header element */
3550 u32 szHdr1; /* Number of bytes in header */
3551 int i = 0;
drh1e968a02008-03-25 00:22:21 +00003552 int rc = 0;
3553 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3554 KeyInfo *pKeyInfo;
3555 Mem mem1;
3556
3557 pKeyInfo = pPKey2->pKeyInfo;
drh84de6902014-05-02 18:46:52 +00003558 if( pKeyInfo->db==0 ) return 1;
drh1e968a02008-03-25 00:22:21 +00003559 mem1.enc = pKeyInfo->enc;
drh37272632009-11-16 21:28:45 +00003560 mem1.db = pKeyInfo->db;
drhd93a8b22009-11-16 03:13:40 +00003561 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
drh17bcb102014-09-18 21:25:33 +00003562 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drh8b249a82009-11-16 02:14:00 +00003563
3564 /* Compilers may complain that mem1.u.i is potentially uninitialized.
3565 ** We could initialize it, as shown here, to silence those complaints.
drh5275d2e2011-04-27 01:00:17 +00003566 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
drh8b249a82009-11-16 02:14:00 +00003567 ** the unnecessary initialization has a measurable negative performance
3568 ** impact, since this routine is a very high runner. And so, we choose
3569 ** to ignore the compiler warnings and leave this variable uninitialized.
3570 */
3571 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
drh1e968a02008-03-25 00:22:21 +00003572
shane3f8d5cf2008-04-24 19:15:09 +00003573 idx1 = getVarint32(aKey1, szHdr1);
drh46981362015-07-08 12:25:38 +00003574 if( szHdr1>98307 ) return SQLITE_CORRUPT;
drh1e968a02008-03-25 00:22:21 +00003575 d1 = szHdr1;
drhb2023662013-11-29 15:39:36 +00003576 assert( pKeyInfo->nField+pKeyInfo->nXField>=pPKey2->nField || CORRUPT_DB );
drhe1a022e2012-09-17 17:16:53 +00003577 assert( pKeyInfo->aSortOrder!=0 );
dan89bc0212013-12-03 09:49:52 +00003578 assert( pKeyInfo->nField>0 );
3579 assert( idx1<=szHdr1 || CORRUPT_DB );
drh0b9dada2013-11-25 22:24:36 +00003580 do{
drh1e968a02008-03-25 00:22:21 +00003581 u32 serial_type1;
3582
3583 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00003584 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drhaf5b2af2013-08-05 15:32:09 +00003585
3586 /* Verify that there is enough key space remaining to avoid
3587 ** a buffer overread. The "d1+serial_type1+2" subexpression will
3588 ** always be greater than or equal to the amount of required key space.
3589 ** Use that approximation to avoid the more expensive call to
3590 ** sqlite3VdbeSerialTypeLen() in the common case.
3591 */
3592 if( d1+serial_type1+2>(u32)nKey1
3593 && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
3594 ){
3595 break;
3596 }
drh1e968a02008-03-25 00:22:21 +00003597
3598 /* Extract the values to be compared.
3599 */
3600 d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
3601
3602 /* Do the comparison
3603 */
drh323df792013-08-05 19:11:29 +00003604 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
drh1e968a02008-03-25 00:22:21 +00003605 if( rc!=0 ){
drh17bcb102014-09-18 21:25:33 +00003606 assert( mem1.szMalloc==0 ); /* See comment below */
drh323df792013-08-05 19:11:29 +00003607 if( pKeyInfo->aSortOrder[i] ){
drh6f225d02013-10-26 13:36:51 +00003608 rc = -rc; /* Invert the result for DESC sort order. */
drh8b249a82009-11-16 02:14:00 +00003609 }
drh79211e12014-05-02 17:33:16 +00003610 goto debugCompareEnd;
drh1e968a02008-03-25 00:22:21 +00003611 }
3612 i++;
drh0b9dada2013-11-25 22:24:36 +00003613 }while( idx1<szHdr1 && i<pPKey2->nField );
drh407414c2009-07-14 14:15:27 +00003614
drh8b249a82009-11-16 02:14:00 +00003615 /* No memory allocation is ever used on mem1. Prove this using
3616 ** the following assert(). If the assert() fails, it indicates a
3617 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
danielk1977de630352009-05-04 11:42:29 +00003618 */
drh17bcb102014-09-18 21:25:33 +00003619 assert( mem1.szMalloc==0 );
danielk1977de630352009-05-04 11:42:29 +00003620
drh8b249a82009-11-16 02:14:00 +00003621 /* rc==0 here means that one of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00003622 ** all the fields up to that point were equal. Return the default_rc
dan3b9330f2014-02-27 20:44:18 +00003623 ** value. */
drh79211e12014-05-02 17:33:16 +00003624 rc = pPKey2->default_rc;
3625
3626debugCompareEnd:
3627 if( desiredResult==0 && rc==0 ) return 1;
3628 if( desiredResult<0 && rc<0 ) return 1;
3629 if( desiredResult>0 && rc>0 ) return 1;
3630 if( CORRUPT_DB ) return 1;
3631 if( pKeyInfo->db->mallocFailed ) return 1;
3632 return 0;
dan1fed5da2014-02-25 21:01:25 +00003633}
dan3833e932014-03-01 19:44:56 +00003634#endif
dan1fed5da2014-02-25 21:01:25 +00003635
drhe1bb8022015-01-19 19:48:52 +00003636#if SQLITE_DEBUG
3637/*
3638** Count the number of fields (a.k.a. columns) in the record given by
3639** pKey,nKey. The verify that this count is less than or equal to the
3640** limit given by pKeyInfo->nField + pKeyInfo->nXField.
3641**
3642** If this constraint is not satisfied, it means that the high-speed
3643** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
3644** not work correctly. If this assert() ever fires, it probably means
3645** that the KeyInfo.nField or KeyInfo.nXField values were computed
3646** incorrectly.
3647*/
3648static void vdbeAssertFieldCountWithinLimits(
3649 int nKey, const void *pKey, /* The record to verify */
3650 const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
3651){
3652 int nField = 0;
3653 u32 szHdr;
3654 u32 idx;
3655 u32 notUsed;
3656 const unsigned char *aKey = (const unsigned char*)pKey;
3657
3658 if( CORRUPT_DB ) return;
3659 idx = getVarint32(aKey, szHdr);
mistachkin1b3ee492015-01-21 00:51:08 +00003660 assert( nKey>=0 );
3661 assert( szHdr<=(u32)nKey );
drhe1bb8022015-01-19 19:48:52 +00003662 while( idx<szHdr ){
3663 idx += getVarint32(aKey+idx, notUsed);
3664 nField++;
3665 }
3666 assert( nField <= pKeyInfo->nField+pKeyInfo->nXField );
3667}
drh1af3c642015-01-19 20:57:19 +00003668#else
3669# define vdbeAssertFieldCountWithinLimits(A,B,C)
drhe1bb8022015-01-19 19:48:52 +00003670#endif
3671
dan3833e932014-03-01 19:44:56 +00003672/*
3673** Both *pMem1 and *pMem2 contain string values. Compare the two values
3674** using the collation sequence pColl. As usual, return a negative , zero
3675** or positive value if *pMem1 is less than, equal to or greater than
3676** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
3677*/
dan1fed5da2014-02-25 21:01:25 +00003678static int vdbeCompareMemString(
dan3833e932014-03-01 19:44:56 +00003679 const Mem *pMem1,
3680 const Mem *pMem2,
dan38fdead2014-04-01 10:19:02 +00003681 const CollSeq *pColl,
3682 u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
dan1fed5da2014-02-25 21:01:25 +00003683){
3684 if( pMem1->enc==pColl->enc ){
3685 /* The strings are already in the correct encoding. Call the
3686 ** comparison function directly */
3687 return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
3688 }else{
3689 int rc;
3690 const void *v1, *v2;
3691 int n1, n2;
3692 Mem c1;
3693 Mem c2;
drh17bcb102014-09-18 21:25:33 +00003694 sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
3695 sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
dan1fed5da2014-02-25 21:01:25 +00003696 sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
3697 sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
3698 v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
3699 n1 = v1==0 ? 0 : c1.n;
3700 v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
3701 n2 = v2==0 ? 0 : c2.n;
3702 rc = pColl->xCmp(pColl->pUser, n1, v1, n2, v2);
mistachkinfad30392016-02-13 23:43:46 +00003703 if( (v1==0 || v2==0) && prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
dan1fed5da2014-02-25 21:01:25 +00003704 sqlite3VdbeMemRelease(&c1);
3705 sqlite3VdbeMemRelease(&c2);
3706 return rc;
3707 }
3708}
3709
3710/*
drh982ff722014-09-16 03:24:43 +00003711** Compare two blobs. Return negative, zero, or positive if the first
3712** is less than, equal to, or greater than the second, respectively.
3713** If one blob is a prefix of the other, then the shorter is the lessor.
3714*/
3715static SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
3716 int c = memcmp(pB1->z, pB2->z, pB1->n>pB2->n ? pB2->n : pB1->n);
3717 if( c ) return c;
3718 return pB1->n - pB2->n;
3719}
3720
drh2ab410a2015-11-06 14:59:07 +00003721/*
3722** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
3723** number. Return negative, zero, or positive if the first (i64) is less than,
3724** equal to, or greater than the second (double).
3725*/
3726static int sqlite3IntFloatCompare(i64 i, double r){
3727 if( sizeof(LONGDOUBLE_TYPE)>8 ){
3728 LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
3729 if( x<r ) return -1;
3730 if( x>r ) return +1;
3731 return 0;
3732 }else{
3733 i64 y;
3734 double s;
3735 if( r<-9223372036854775808.0 ) return +1;
3736 if( r>9223372036854775807.0 ) return -1;
3737 y = (i64)r;
3738 if( i<y ) return -1;
3739 if( i>y ){
3740 if( y==SMALLEST_INT64 && r>0.0 ) return -1;
3741 return +1;
3742 }
3743 s = (double)i;
3744 if( s<r ) return -1;
3745 if( s>r ) return +1;
3746 return 0;
3747 }
3748}
drh982ff722014-09-16 03:24:43 +00003749
3750/*
dan1fed5da2014-02-25 21:01:25 +00003751** Compare the values contained by the two memory cells, returning
3752** negative, zero or positive if pMem1 is less than, equal to, or greater
3753** than pMem2. Sorting order is NULL's first, followed by numbers (integers
3754** and reals) sorted numerically, followed by text ordered by the collating
3755** sequence pColl and finally blob's ordered by memcmp().
3756**
3757** Two NULL values are considered equal by this function.
3758*/
3759int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
dan1fed5da2014-02-25 21:01:25 +00003760 int f1, f2;
3761 int combined_flags;
3762
3763 f1 = pMem1->flags;
3764 f2 = pMem2->flags;
3765 combined_flags = f1|f2;
3766 assert( (combined_flags & MEM_RowSet)==0 );
3767
3768 /* If one value is NULL, it is less than the other. If both values
3769 ** are NULL, return 0.
drh8b249a82009-11-16 02:14:00 +00003770 */
dan1fed5da2014-02-25 21:01:25 +00003771 if( combined_flags&MEM_Null ){
3772 return (f2&MEM_Null) - (f1&MEM_Null);
3773 }
3774
drh2ab410a2015-11-06 14:59:07 +00003775 /* At least one of the two values is a number
dan1fed5da2014-02-25 21:01:25 +00003776 */
3777 if( combined_flags&(MEM_Int|MEM_Real) ){
dan1fed5da2014-02-25 21:01:25 +00003778 if( (f1 & f2 & MEM_Int)!=0 ){
3779 if( pMem1->u.i < pMem2->u.i ) return -1;
drh2ab410a2015-11-06 14:59:07 +00003780 if( pMem1->u.i > pMem2->u.i ) return +1;
dan1fed5da2014-02-25 21:01:25 +00003781 return 0;
3782 }
drh2ab410a2015-11-06 14:59:07 +00003783 if( (f1 & f2 & MEM_Real)!=0 ){
3784 if( pMem1->u.r < pMem2->u.r ) return -1;
3785 if( pMem1->u.r > pMem2->u.r ) return +1;
3786 return 0;
3787 }
3788 if( (f1&MEM_Int)!=0 ){
3789 if( (f2&MEM_Real)!=0 ){
3790 return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
3791 }else{
3792 return -1;
3793 }
3794 }
dan1fed5da2014-02-25 21:01:25 +00003795 if( (f1&MEM_Real)!=0 ){
drh2ab410a2015-11-06 14:59:07 +00003796 if( (f2&MEM_Int)!=0 ){
3797 return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
3798 }else{
3799 return -1;
3800 }
dan1fed5da2014-02-25 21:01:25 +00003801 }
drh2ab410a2015-11-06 14:59:07 +00003802 return +1;
dan1fed5da2014-02-25 21:01:25 +00003803 }
3804
3805 /* If one value is a string and the other is a blob, the string is less.
3806 ** If both are strings, compare using the collating functions.
3807 */
3808 if( combined_flags&MEM_Str ){
3809 if( (f1 & MEM_Str)==0 ){
3810 return 1;
3811 }
3812 if( (f2 & MEM_Str)==0 ){
3813 return -1;
3814 }
3815
drhe5520e22015-12-31 04:34:26 +00003816 assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
dan1fed5da2014-02-25 21:01:25 +00003817 assert( pMem1->enc==SQLITE_UTF8 ||
3818 pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
3819
3820 /* The collation sequence must be defined at this point, even if
3821 ** the user deletes the collation sequence after the vdbe program is
3822 ** compiled (this was not always the case).
3823 */
3824 assert( !pColl || pColl->xCmp );
3825
3826 if( pColl ){
dan38fdead2014-04-01 10:19:02 +00003827 return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
dan1fed5da2014-02-25 21:01:25 +00003828 }
3829 /* If a NULL pointer was passed as the collate function, fall through
3830 ** to the blob case and use memcmp(). */
3831 }
3832
3833 /* Both values must be blobs. Compare using memcmp(). */
drh982ff722014-09-16 03:24:43 +00003834 return sqlite3BlobCompare(pMem1, pMem2);
drh1e968a02008-03-25 00:22:21 +00003835}
dan1fed5da2014-02-25 21:01:25 +00003836
3837
dan3833e932014-03-01 19:44:56 +00003838/*
3839** The first argument passed to this function is a serial-type that
3840** corresponds to an integer - all values between 1 and 9 inclusive
3841** except 7. The second points to a buffer containing an integer value
3842** serialized according to serial_type. This function deserializes
3843** and returns the value.
3844*/
dan3b9330f2014-02-27 20:44:18 +00003845static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
drhf926d1e2014-03-04 04:04:33 +00003846 u32 y;
dan3833e932014-03-01 19:44:56 +00003847 assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
dan3b9330f2014-02-27 20:44:18 +00003848 switch( serial_type ){
dan3833e932014-03-01 19:44:56 +00003849 case 0:
dan3b9330f2014-02-27 20:44:18 +00003850 case 1:
drhb6e8fd12014-03-06 01:56:33 +00003851 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003852 return ONE_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003853 case 2:
drhb6e8fd12014-03-06 01:56:33 +00003854 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003855 return TWO_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003856 case 3:
drhb6e8fd12014-03-06 01:56:33 +00003857 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003858 return THREE_BYTE_INT(aKey);
3859 case 4: {
drhb6e8fd12014-03-06 01:56:33 +00003860 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003861 y = FOUR_BYTE_UINT(aKey);
3862 return (i64)*(int*)&y;
3863 }
dan3b9330f2014-02-27 20:44:18 +00003864 case 5: {
drhb6e8fd12014-03-06 01:56:33 +00003865 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003866 return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
danielk1977a7a8e142008-02-13 18:25:27 +00003867 }
dan3b9330f2014-02-27 20:44:18 +00003868 case 6: {
drhf926d1e2014-03-04 04:04:33 +00003869 u64 x = FOUR_BYTE_UINT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00003870 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003871 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
3872 return (i64)*(i64*)&x;
danielk19779a96b662007-11-29 17:05:18 +00003873 }
dan3b9330f2014-02-27 20:44:18 +00003874 }
danielk19779a96b662007-11-29 17:05:18 +00003875
dan3b9330f2014-02-27 20:44:18 +00003876 return (serial_type - 8);
danielk1977eb015e02004-05-18 01:31:14 +00003877}
danielk1977eb015e02004-05-18 01:31:14 +00003878
dan3833e932014-03-01 19:44:56 +00003879/*
3880** This function compares the two table rows or index records
3881** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
3882** or positive integer if key1 is less than, equal to or
3883** greater than key2. The {nKey1, pKey1} key must be a blob
peter.d.reid60ec9142014-09-06 16:39:46 +00003884** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
dan3833e932014-03-01 19:44:56 +00003885** key must be a parsed key such as obtained from
3886** sqlite3VdbeParseRecord.
3887**
3888** If argument bSkip is non-zero, it is assumed that the caller has already
3889** determined that the first fields of the keys are equal.
3890**
3891** Key1 and Key2 do not have to contain the same number of fields. If all
3892** fields that appear in both keys are equal, then pPKey2->default_rc is
3893** returned.
drha1f7c0a2014-03-28 03:12:48 +00003894**
dan38fdead2014-04-01 10:19:02 +00003895** If database corruption is discovered, set pPKey2->errCode to
3896** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
3897** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
3898** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
dan3833e932014-03-01 19:44:56 +00003899*/
dan7004f3f2015-03-30 12:06:26 +00003900int sqlite3VdbeRecordCompareWithSkip(
dan3833e932014-03-01 19:44:56 +00003901 int nKey1, const void *pKey1, /* Left key */
drha1f7c0a2014-03-28 03:12:48 +00003902 UnpackedRecord *pPKey2, /* Right key */
dan3833e932014-03-01 19:44:56 +00003903 int bSkip /* If true, skip the first field */
dan1fed5da2014-02-25 21:01:25 +00003904){
dan3833e932014-03-01 19:44:56 +00003905 u32 d1; /* Offset into aKey[] of next data element */
3906 int i; /* Index of next field to compare */
mistachkinffe6bc22014-03-04 11:16:20 +00003907 u32 szHdr1; /* Size of record header in bytes */
dan3833e932014-03-01 19:44:56 +00003908 u32 idx1; /* Offset of first type in header */
3909 int rc = 0; /* Return value */
3910 Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
dan1fed5da2014-02-25 21:01:25 +00003911 KeyInfo *pKeyInfo = pPKey2->pKeyInfo;
3912 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3913 Mem mem1;
3914
dan3833e932014-03-01 19:44:56 +00003915 /* If bSkip is true, then the caller has already determined that the first
3916 ** two elements in the keys are equal. Fix the various stack variables so
dan3b9330f2014-02-27 20:44:18 +00003917 ** that this routine begins comparing at the second field. */
dan3833e932014-03-01 19:44:56 +00003918 if( bSkip ){
dan3b9330f2014-02-27 20:44:18 +00003919 u32 s1;
dan3b9330f2014-02-27 20:44:18 +00003920 idx1 = 1 + getVarint32(&aKey1[1], s1);
dan3833e932014-03-01 19:44:56 +00003921 szHdr1 = aKey1[0];
3922 d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
dan3b9330f2014-02-27 20:44:18 +00003923 i = 1;
3924 pRhs++;
dan3833e932014-03-01 19:44:56 +00003925 }else{
3926 idx1 = getVarint32(aKey1, szHdr1);
3927 d1 = szHdr1;
drha1f7c0a2014-03-28 03:12:48 +00003928 if( d1>(unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00003929 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00003930 return 0; /* Corruption */
3931 }
dan3833e932014-03-01 19:44:56 +00003932 i = 0;
dan3b9330f2014-02-27 20:44:18 +00003933 }
3934
drh17bcb102014-09-18 21:25:33 +00003935 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
dan1fed5da2014-02-25 21:01:25 +00003936 assert( pPKey2->pKeyInfo->nField+pPKey2->pKeyInfo->nXField>=pPKey2->nField
3937 || CORRUPT_DB );
3938 assert( pPKey2->pKeyInfo->aSortOrder!=0 );
3939 assert( pPKey2->pKeyInfo->nField>0 );
3940 assert( idx1<=szHdr1 || CORRUPT_DB );
3941 do{
dan1fed5da2014-02-25 21:01:25 +00003942 u32 serial_type;
3943
3944 /* RHS is an integer */
3945 if( pRhs->flags & MEM_Int ){
3946 serial_type = aKey1[idx1];
drhb6e8fd12014-03-06 01:56:33 +00003947 testcase( serial_type==12 );
danb95e1192015-05-26 20:31:20 +00003948 if( serial_type>=10 ){
dan1fed5da2014-02-25 21:01:25 +00003949 rc = +1;
3950 }else if( serial_type==0 ){
3951 rc = -1;
dan3b9330f2014-02-27 20:44:18 +00003952 }else if( serial_type==7 ){
dan1fed5da2014-02-25 21:01:25 +00003953 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
drh2ab410a2015-11-06 14:59:07 +00003954 rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
dan3b9330f2014-02-27 20:44:18 +00003955 }else{
3956 i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
3957 i64 rhs = pRhs->u.i;
3958 if( lhs<rhs ){
3959 rc = -1;
3960 }else if( lhs>rhs ){
3961 rc = +1;
dan1fed5da2014-02-25 21:01:25 +00003962 }
3963 }
3964 }
3965
3966 /* RHS is real */
3967 else if( pRhs->flags & MEM_Real ){
3968 serial_type = aKey1[idx1];
dancc7aa1f2015-05-26 20:07:32 +00003969 if( serial_type>=10 ){
3970 /* Serial types 12 or greater are strings and blobs (greater than
3971 ** numbers). Types 10 and 11 are currently "reserved for future
3972 ** use", so it doesn't really matter what the results of comparing
3973 ** them to numberic values are. */
dan1fed5da2014-02-25 21:01:25 +00003974 rc = +1;
3975 }else if( serial_type==0 ){
3976 rc = -1;
3977 }else{
dan1fed5da2014-02-25 21:01:25 +00003978 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
3979 if( serial_type==7 ){
drh2ab410a2015-11-06 14:59:07 +00003980 if( mem1.u.r<pRhs->u.r ){
3981 rc = -1;
3982 }else if( mem1.u.r>pRhs->u.r ){
3983 rc = +1;
3984 }
dan1fed5da2014-02-25 21:01:25 +00003985 }else{
drh2ab410a2015-11-06 14:59:07 +00003986 rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
dan1fed5da2014-02-25 21:01:25 +00003987 }
3988 }
3989 }
3990
3991 /* RHS is a string */
3992 else if( pRhs->flags & MEM_Str ){
3993 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00003994 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00003995 if( serial_type<12 ){
3996 rc = -1;
3997 }else if( !(serial_type & 0x01) ){
3998 rc = +1;
3999 }else{
4000 mem1.n = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004001 testcase( (d1+mem1.n)==(unsigned)nKey1 );
4002 testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004003 if( (d1+mem1.n) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004004 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004005 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00004006 }else if( pKeyInfo->aColl[i] ){
4007 mem1.enc = pKeyInfo->enc;
4008 mem1.db = pKeyInfo->db;
4009 mem1.flags = MEM_Str;
drhfcb44a82014-03-03 15:13:27 +00004010 mem1.z = (char*)&aKey1[d1];
dan38fdead2014-04-01 10:19:02 +00004011 rc = vdbeCompareMemString(
4012 &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
4013 );
dan1fed5da2014-02-25 21:01:25 +00004014 }else{
4015 int nCmp = MIN(mem1.n, pRhs->n);
4016 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4017 if( rc==0 ) rc = mem1.n - pRhs->n;
4018 }
4019 }
4020 }
4021
4022 /* RHS is a blob */
4023 else if( pRhs->flags & MEM_Blob ){
4024 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004025 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004026 if( serial_type<12 || (serial_type & 0x01) ){
4027 rc = -1;
4028 }else{
4029 int nStr = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004030 testcase( (d1+nStr)==(unsigned)nKey1 );
4031 testcase( (d1+nStr+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004032 if( (d1+nStr) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004033 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004034 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00004035 }else{
4036 int nCmp = MIN(nStr, pRhs->n);
4037 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4038 if( rc==0 ) rc = nStr - pRhs->n;
4039 }
4040 }
4041 }
4042
4043 /* RHS is null */
4044 else{
4045 serial_type = aKey1[idx1];
4046 rc = (serial_type!=0);
4047 }
4048
4049 if( rc!=0 ){
dan1fed5da2014-02-25 21:01:25 +00004050 if( pKeyInfo->aSortOrder[i] ){
4051 rc = -rc;
dan1fed5da2014-02-25 21:01:25 +00004052 }
drh79211e12014-05-02 17:33:16 +00004053 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
drh17bcb102014-09-18 21:25:33 +00004054 assert( mem1.szMalloc==0 ); /* See comment below */
dan1fed5da2014-02-25 21:01:25 +00004055 return rc;
4056 }
4057
4058 i++;
dan3b9330f2014-02-27 20:44:18 +00004059 pRhs++;
dan1fed5da2014-02-25 21:01:25 +00004060 d1 += sqlite3VdbeSerialTypeLen(serial_type);
4061 idx1 += sqlite3VarintLen(serial_type);
drh295aedf2014-03-03 18:25:24 +00004062 }while( idx1<(unsigned)szHdr1 && i<pPKey2->nField && d1<=(unsigned)nKey1 );
dan1fed5da2014-02-25 21:01:25 +00004063
4064 /* No memory allocation is ever used on mem1. Prove this using
4065 ** the following assert(). If the assert() fails, it indicates a
dan3833e932014-03-01 19:44:56 +00004066 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
drh17bcb102014-09-18 21:25:33 +00004067 assert( mem1.szMalloc==0 );
dan1fed5da2014-02-25 21:01:25 +00004068
4069 /* rc==0 here means that one or both of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004070 ** all the fields up to that point were equal. Return the default_rc
dan1fed5da2014-02-25 21:01:25 +00004071 ** value. */
dan3833e932014-03-01 19:44:56 +00004072 assert( CORRUPT_DB
drh66141812014-06-30 20:25:03 +00004073 || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
dan6696ba32014-06-28 19:06:49 +00004074 || pKeyInfo->db->mallocFailed
dan3833e932014-03-01 19:44:56 +00004075 );
drh70528d72015-11-05 20:25:09 +00004076 pPKey2->eqSeen = 1;
dan1fed5da2014-02-25 21:01:25 +00004077 return pPKey2->default_rc;
4078}
drh75179de2014-09-16 14:37:35 +00004079int sqlite3VdbeRecordCompare(
4080 int nKey1, const void *pKey1, /* Left key */
4081 UnpackedRecord *pPKey2 /* Right key */
4082){
dan7004f3f2015-03-30 12:06:26 +00004083 return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
drh75179de2014-09-16 14:37:35 +00004084}
4085
dan1fed5da2014-02-25 21:01:25 +00004086
dan3833e932014-03-01 19:44:56 +00004087/*
4088** This function is an optimized version of sqlite3VdbeRecordCompare()
4089** that (a) the first field of pPKey2 is an integer, and (b) the
4090** size-of-header varint at the start of (pKey1/nKey1) fits in a single
4091** byte (i.e. is less than 128).
drhe2ac5062014-03-26 12:02:38 +00004092**
4093** To avoid concerns about buffer overreads, this routine is only used
4094** on schemas where the maximum valid header size is 63 bytes or less.
dan3833e932014-03-01 19:44:56 +00004095*/
dan3b9330f2014-02-27 20:44:18 +00004096static int vdbeRecordCompareInt(
4097 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004098 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004099){
dan9b8afef2014-03-03 20:48:50 +00004100 const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
dan3b9330f2014-02-27 20:44:18 +00004101 int serial_type = ((const u8*)pKey1)[1];
4102 int res;
drhf926d1e2014-03-04 04:04:33 +00004103 u32 y;
4104 u64 x;
dan3b9330f2014-02-27 20:44:18 +00004105 i64 v = pPKey2->aMem[0].u.i;
4106 i64 lhs;
4107
drhe1bb8022015-01-19 19:48:52 +00004108 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drhe2ac5062014-03-26 12:02:38 +00004109 assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
dan3833e932014-03-01 19:44:56 +00004110 switch( serial_type ){
drhf926d1e2014-03-04 04:04:33 +00004111 case 1: { /* 1-byte signed integer */
4112 lhs = ONE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004113 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004114 break;
4115 }
drhf926d1e2014-03-04 04:04:33 +00004116 case 2: { /* 2-byte signed integer */
4117 lhs = TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004118 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004119 break;
4120 }
4121 case 3: { /* 3-byte signed integer */
4122 lhs = THREE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004123 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004124 break;
4125 }
4126 case 4: { /* 4-byte signed integer */
4127 y = FOUR_BYTE_UINT(aKey);
4128 lhs = (i64)*(int*)&y;
drhb6e8fd12014-03-06 01:56:33 +00004129 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004130 break;
4131 }
4132 case 5: { /* 6-byte signed integer */
4133 lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004134 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004135 break;
4136 }
4137 case 6: { /* 8-byte signed integer */
4138 x = FOUR_BYTE_UINT(aKey);
4139 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4140 lhs = *(i64*)&x;
drhb6e8fd12014-03-06 01:56:33 +00004141 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004142 break;
4143 }
dan3b9330f2014-02-27 20:44:18 +00004144 case 8:
4145 lhs = 0;
4146 break;
dan3b9330f2014-02-27 20:44:18 +00004147 case 9:
4148 lhs = 1;
4149 break;
4150
dan063d4a02014-02-28 09:48:30 +00004151 /* This case could be removed without changing the results of running
4152 ** this code. Including it causes gcc to generate a faster switch
4153 ** statement (since the range of switch targets now starts at zero and
dan597515d2014-02-28 18:39:51 +00004154 ** is contiguous) but does not cause any duplicate code to be generated
dan063d4a02014-02-28 09:48:30 +00004155 ** (as gcc is clever enough to combine the two like cases). Other
4156 ** compilers might be similar. */
4157 case 0: case 7:
drh75179de2014-09-16 14:37:35 +00004158 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan063d4a02014-02-28 09:48:30 +00004159
dan3b9330f2014-02-27 20:44:18 +00004160 default:
drh75179de2014-09-16 14:37:35 +00004161 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan3b9330f2014-02-27 20:44:18 +00004162 }
4163
4164 if( v>lhs ){
4165 res = pPKey2->r1;
4166 }else if( v<lhs ){
4167 res = pPKey2->r2;
4168 }else if( pPKey2->nField>1 ){
dan063d4a02014-02-28 09:48:30 +00004169 /* The first fields of the two keys are equal. Compare the trailing
4170 ** fields. */
dan7004f3f2015-03-30 12:06:26 +00004171 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004172 }else{
dan063d4a02014-02-28 09:48:30 +00004173 /* The first fields of the two keys are equal and there are no trailing
4174 ** fields. Return pPKey2->default_rc in this case. */
dan3b9330f2014-02-27 20:44:18 +00004175 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004176 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004177 }
4178
drh79211e12014-05-02 17:33:16 +00004179 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
dan3b9330f2014-02-27 20:44:18 +00004180 return res;
4181}
4182
dan3833e932014-03-01 19:44:56 +00004183/*
4184** This function is an optimized version of sqlite3VdbeRecordCompare()
4185** that (a) the first field of pPKey2 is a string, that (b) the first field
4186** uses the collation sequence BINARY and (c) that the size-of-header varint
4187** at the start of (pKey1/nKey1) fits in a single byte.
4188*/
dan3b9330f2014-02-27 20:44:18 +00004189static int vdbeRecordCompareString(
4190 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004191 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004192){
4193 const u8 *aKey1 = (const u8*)pKey1;
4194 int serial_type;
4195 int res;
4196
drh2ab410a2015-11-06 14:59:07 +00004197 assert( pPKey2->aMem[0].flags & MEM_Str );
drhe1bb8022015-01-19 19:48:52 +00004198 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
dan3b9330f2014-02-27 20:44:18 +00004199 getVarint32(&aKey1[1], serial_type);
dan3b9330f2014-02-27 20:44:18 +00004200 if( serial_type<12 ){
4201 res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
4202 }else if( !(serial_type & 0x01) ){
4203 res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
4204 }else{
4205 int nCmp;
4206 int nStr;
dan3833e932014-03-01 19:44:56 +00004207 int szHdr = aKey1[0];
dan3b9330f2014-02-27 20:44:18 +00004208
4209 nStr = (serial_type-12) / 2;
drha1f7c0a2014-03-28 03:12:48 +00004210 if( (szHdr + nStr) > nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004211 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004212 return 0; /* Corruption */
4213 }
dan3b9330f2014-02-27 20:44:18 +00004214 nCmp = MIN( pPKey2->aMem[0].n, nStr );
dan3833e932014-03-01 19:44:56 +00004215 res = memcmp(&aKey1[szHdr], pPKey2->aMem[0].z, nCmp);
dan3b9330f2014-02-27 20:44:18 +00004216
4217 if( res==0 ){
4218 res = nStr - pPKey2->aMem[0].n;
4219 if( res==0 ){
4220 if( pPKey2->nField>1 ){
dan7004f3f2015-03-30 12:06:26 +00004221 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004222 }else{
4223 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004224 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004225 }
4226 }else if( res>0 ){
4227 res = pPKey2->r2;
4228 }else{
4229 res = pPKey2->r1;
4230 }
4231 }else if( res>0 ){
4232 res = pPKey2->r2;
4233 }else{
4234 res = pPKey2->r1;
4235 }
4236 }
4237
drh66141812014-06-30 20:25:03 +00004238 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
dan3b9330f2014-02-27 20:44:18 +00004239 || CORRUPT_DB
dan6696ba32014-06-28 19:06:49 +00004240 || pPKey2->pKeyInfo->db->mallocFailed
dan3b9330f2014-02-27 20:44:18 +00004241 );
4242 return res;
4243}
4244
dan3833e932014-03-01 19:44:56 +00004245/*
4246** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
4247** suitable for comparing serialized records to the unpacked record passed
4248** as the only argument.
4249*/
dan1fed5da2014-02-25 21:01:25 +00004250RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
dan9b8afef2014-03-03 20:48:50 +00004251 /* varintRecordCompareInt() and varintRecordCompareString() both assume
4252 ** that the size-of-header varint that occurs at the start of each record
4253 ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
4254 ** also assumes that it is safe to overread a buffer by at least the
4255 ** maximum possible legal header size plus 8 bytes. Because there is
4256 ** guaranteed to be at least 74 (but not 136) bytes of padding following each
4257 ** buffer passed to varintRecordCompareInt() this makes it convenient to
4258 ** limit the size of the header to 64 bytes in cases where the first field
4259 ** is an integer.
4260 **
4261 ** The easiest way to enforce this limit is to consider only records with
4262 ** 13 fields or less. If the first field is an integer, the maximum legal
4263 ** header size is (12*5 + 1 + 1) bytes. */
4264 if( (p->pKeyInfo->nField + p->pKeyInfo->nXField)<=13 ){
dan1fed5da2014-02-25 21:01:25 +00004265 int flags = p->aMem[0].flags;
dan3b9330f2014-02-27 20:44:18 +00004266 if( p->pKeyInfo->aSortOrder[0] ){
4267 p->r1 = 1;
4268 p->r2 = -1;
4269 }else{
4270 p->r1 = -1;
4271 p->r2 = 1;
4272 }
dan1fed5da2014-02-25 21:01:25 +00004273 if( (flags & MEM_Int) ){
4274 return vdbeRecordCompareInt;
dan3b9330f2014-02-27 20:44:18 +00004275 }
drhb6e8fd12014-03-06 01:56:33 +00004276 testcase( flags & MEM_Real );
4277 testcase( flags & MEM_Null );
4278 testcase( flags & MEM_Blob );
4279 if( (flags & (MEM_Real|MEM_Null|MEM_Blob))==0 && p->pKeyInfo->aColl[0]==0 ){
4280 assert( flags & MEM_Str );
dan1fed5da2014-02-25 21:01:25 +00004281 return vdbeRecordCompareString;
4282 }
4283 }
dan3b9330f2014-02-27 20:44:18 +00004284
dan3833e932014-03-01 19:44:56 +00004285 return sqlite3VdbeRecordCompare;
dan3b9330f2014-02-27 20:44:18 +00004286}
danielk1977eb015e02004-05-18 01:31:14 +00004287
4288/*
drh7a224de2004-06-02 01:22:02 +00004289** pCur points at an index entry created using the OP_MakeRecord opcode.
4290** Read the rowid (the last field in the record) and store it in *rowid.
4291** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00004292**
4293** pCur might be pointing to text obtained from a corrupt database file.
4294** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00004295*/
drh35f6b932009-06-23 14:15:04 +00004296int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00004297 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004298 int rc;
drhd5788202004-05-28 08:21:05 +00004299 u32 szHdr; /* Size of the header */
4300 u32 typeRowid; /* Serial type of the rowid */
4301 u32 lenRowid; /* Size of the rowid */
4302 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00004303
drh88a003e2008-12-11 16:17:03 +00004304 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00004305 ** than 2GiB are support - anything large must be database corruption.
4306 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00004307 ** this code can safely assume that nCellKey is 32-bits
4308 */
drhea8ffdf2009-07-22 00:35:23 +00004309 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00004310 nCellKey = sqlite3BtreePayloadSize(pCur);
drh7b746032009-06-26 12:15:22 +00004311 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00004312
4313 /* Read in the complete content of the index entry */
drhd3b74202014-09-17 16:41:15 +00004314 sqlite3VdbeMemInit(&m, db, 0);
drh501932c2013-11-21 21:59:53 +00004315 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhd5788202004-05-28 08:21:05 +00004316 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00004317 return rc;
4318 }
drh88a003e2008-12-11 16:17:03 +00004319
4320 /* The index entry must begin with a header size */
shane3f8d5cf2008-04-24 19:15:09 +00004321 (void)getVarint32((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00004322 testcase( szHdr==3 );
drh88a003e2008-12-11 16:17:03 +00004323 testcase( szHdr==m.n );
drh7b746032009-06-26 12:15:22 +00004324 if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
drh88a003e2008-12-11 16:17:03 +00004325 goto idx_rowid_corruption;
4326 }
4327
4328 /* The last field of the index should be an integer - the ROWID.
4329 ** Verify that the last entry really is an integer. */
shane3f8d5cf2008-04-24 19:15:09 +00004330 (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00004331 testcase( typeRowid==1 );
4332 testcase( typeRowid==2 );
4333 testcase( typeRowid==3 );
4334 testcase( typeRowid==4 );
4335 testcase( typeRowid==5 );
4336 testcase( typeRowid==6 );
4337 testcase( typeRowid==8 );
4338 testcase( typeRowid==9 );
4339 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
4340 goto idx_rowid_corruption;
4341 }
drhc5ef7152015-06-28 02:58:51 +00004342 lenRowid = sqlite3SmallTypeSizes[typeRowid];
drheeb844a2009-08-08 18:01:07 +00004343 testcase( (u32)m.n==szHdr+lenRowid );
4344 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00004345 goto idx_rowid_corruption;
4346 }
4347
4348 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00004349 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00004350 *rowid = v.u.i;
danielk1977d8123362004-06-12 09:25:12 +00004351 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004352 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00004353
4354 /* Jump here if database corruption is detected after m has been
4355 ** allocated. Free the m object and return SQLITE_CORRUPT. */
4356idx_rowid_corruption:
drh17bcb102014-09-18 21:25:33 +00004357 testcase( m.szMalloc!=0 );
drh88a003e2008-12-11 16:17:03 +00004358 sqlite3VdbeMemRelease(&m);
4359 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004360}
4361
drh7cf6e4d2004-05-19 14:56:55 +00004362/*
drh5f82e3c2009-07-06 00:44:08 +00004363** Compare the key of the index entry that cursor pC is pointing to against
4364** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00004365** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00004366** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00004367**
drh5f82e3c2009-07-06 00:44:08 +00004368** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00004369** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00004370** is ignored as well. Hence, this routine only compares the prefixes
4371** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00004372*/
danielk1977183f9f72004-05-13 05:20:26 +00004373int sqlite3VdbeIdxKeyCompare(
drhd3b74202014-09-17 16:41:15 +00004374 sqlite3 *db, /* Database connection */
drh295aedf2014-03-03 18:25:24 +00004375 VdbeCursor *pC, /* The cursor to compare against */
drha1f7c0a2014-03-28 03:12:48 +00004376 UnpackedRecord *pUnpacked, /* Unpacked version of key */
drh295aedf2014-03-03 18:25:24 +00004377 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00004378){
drh61fc5952007-04-01 23:49:51 +00004379 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004380 int rc;
drhc960dcb2015-11-20 19:22:01 +00004381 BtCursor *pCur;
drhd5788202004-05-28 08:21:05 +00004382 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00004383
drhc960dcb2015-11-20 19:22:01 +00004384 assert( pC->eCurType==CURTYPE_BTREE );
4385 pCur = pC->uc.pCursor;
drhea8ffdf2009-07-22 00:35:23 +00004386 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00004387 nCellKey = sqlite3BtreePayloadSize(pCur);
drh56689692014-03-03 19:29:28 +00004388 /* nCellKey will always be between 0 and 0xffffffff because of the way
drh407414c2009-07-14 14:15:27 +00004389 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00004390 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00004391 *res = 0;
drh9978c972010-02-23 17:36:32 +00004392 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004393 }
drhd3b74202014-09-17 16:41:15 +00004394 sqlite3VdbeMemInit(&m, db, 0);
drhc960dcb2015-11-20 19:22:01 +00004395 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhec1fc802008-08-13 14:07:40 +00004396 if( rc ){
drhd5788202004-05-28 08:21:05 +00004397 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00004398 }
drh75179de2014-09-16 14:37:35 +00004399 *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
danielk1977d8123362004-06-12 09:25:12 +00004400 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004401 return SQLITE_OK;
4402}
danielk1977b28af712004-06-21 06:50:26 +00004403
4404/*
4405** This routine sets the value to be returned by subsequent calls to
4406** sqlite3_changes() on the database handle 'db'.
4407*/
4408void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
drhb21c8cd2007-08-21 19:33:56 +00004409 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00004410 db->nChange = nChange;
4411 db->nTotalChange += nChange;
4412}
4413
4414/*
4415** Set a flag in the vdbe to update the change counter when it is finalised
4416** or reset.
4417*/
drh4794f732004-11-05 17:17:50 +00004418void sqlite3VdbeCountChanges(Vdbe *v){
4419 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00004420}
drhd89bd002005-01-22 03:03:54 +00004421
4422/*
4423** Mark every prepared statement associated with a database connection
4424** as expired.
4425**
4426** An expired statement means that recompilation of the statement is
4427** recommend. Statements expire when things happen that make their
4428** programs obsolete. Removing user-defined functions or collating
4429** sequences, or changing an authorization function are the types of
4430** things that make prepared statements obsolete.
4431*/
4432void sqlite3ExpirePreparedStatements(sqlite3 *db){
4433 Vdbe *p;
4434 for(p = db->pVdbe; p; p=p->pNext){
4435 p->expired = 1;
4436 }
4437}
danielk1977aee18ef2005-03-09 12:26:50 +00004438
4439/*
4440** Return the database associated with the Vdbe.
4441*/
4442sqlite3 *sqlite3VdbeDb(Vdbe *v){
4443 return v->db;
4444}
dan937d0de2009-10-15 18:35:38 +00004445
4446/*
4447** Return a pointer to an sqlite3_value structure containing the value bound
4448** parameter iVar of VM v. Except, if the value is an SQL NULL, return
4449** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
4450** constants) to the value before returning it.
4451**
4452** The returned value must be freed by the caller using sqlite3ValueFree().
4453*/
drhcf0fd4a2013-08-01 12:21:58 +00004454sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00004455 assert( iVar>0 );
4456 if( v ){
4457 Mem *pMem = &v->aVar[iVar-1];
4458 if( 0==(pMem->flags & MEM_Null) ){
4459 sqlite3_value *pRet = sqlite3ValueNew(v->db);
4460 if( pRet ){
4461 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
4462 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
dan937d0de2009-10-15 18:35:38 +00004463 }
4464 return pRet;
4465 }
4466 }
4467 return 0;
4468}
4469
4470/*
4471** Configure SQL variable iVar so that binding a new value to it signals
4472** to sqlite3_reoptimize() that re-preparing the statement may result
4473** in a better query plan.
4474*/
dan1d2ce4f2009-10-19 18:11:09 +00004475void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00004476 assert( iVar>0 );
4477 if( iVar>32 ){
dan1d2ce4f2009-10-19 18:11:09 +00004478 v->expmask = 0xffffffff;
dan937d0de2009-10-15 18:35:38 +00004479 }else{
dan1d2ce4f2009-10-19 18:11:09 +00004480 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00004481 }
4482}
dan46c47d42011-03-01 18:42:07 +00004483
dan016f7812013-08-21 17:35:48 +00004484#ifndef SQLITE_OMIT_VIRTUALTABLE
4485/*
4486** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
4487** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
4488** in memory obtained from sqlite3DbMalloc).
4489*/
4490void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
dan5c3aa052016-01-20 08:47:55 +00004491 if( pVtab->zErrMsg ){
4492 sqlite3 *db = p->db;
4493 sqlite3DbFree(db, p->zErrMsg);
4494 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
4495 sqlite3_free(pVtab->zErrMsg);
4496 pVtab->zErrMsg = 0;
4497 }
dan016f7812013-08-21 17:35:48 +00004498}
4499#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh32683532013-08-22 15:07:08 +00004500
drh9b1c62d2011-03-30 21:04:43 +00004501#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan93bca692011-09-14 19:41:44 +00004502
4503/*
4504** If the second argument is not NULL, release any allocations associated
4505** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
4506** structure itself, using sqlite3DbFree().
4507**
4508** This function is used to free UnpackedRecord structures allocated by
4509** the vdbeUnpackRecord() function found in vdbeapi.c.
4510*/
4511static void vdbeFreeUnpacked(sqlite3 *db, UnpackedRecord *p){
4512 if( p ){
4513 int i;
4514 for(i=0; i<p->nField; i++){
4515 Mem *pMem = &p->aMem[i];
4516 if( pMem->zMalloc ) sqlite3VdbeMemRelease(pMem);
4517 }
4518 sqlite3DbFree(db, p);
4519 }
4520}
drh74c33022016-03-30 12:56:55 +00004521#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan93bca692011-09-14 19:41:44 +00004522
drh74c33022016-03-30 12:56:55 +00004523#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00004524/*
4525** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
4526** then cursor passed as the second argument should point to the row about
4527** to be update or deleted. If the application calls sqlite3_preupdate_old(),
4528** the required value will be read from the row the cursor points to.
4529*/
4530void sqlite3VdbePreUpdateHook(
4531 Vdbe *v, /* Vdbe pre-update hook is invoked by */
4532 VdbeCursor *pCsr, /* Cursor to grab old.* values from */
4533 int op, /* SQLITE_INSERT, UPDATE or DELETE */
4534 const char *zDb, /* Database name */
dan319eeb72011-03-19 08:38:50 +00004535 Table *pTab, /* Modified table */
dan46c47d42011-03-01 18:42:07 +00004536 i64 iKey1, /* Initial key value */
dan37db03b2011-03-16 19:59:18 +00004537 int iReg /* Register for new.* record */
dan46c47d42011-03-01 18:42:07 +00004538){
4539 sqlite3 *db = v->db;
dan37db03b2011-03-16 19:59:18 +00004540 i64 iKey2;
dan46c47d42011-03-01 18:42:07 +00004541 PreUpdate preupdate;
dan319eeb72011-03-19 08:38:50 +00004542 const char *zTbl = pTab->zName;
drhc4645da2012-09-28 13:05:48 +00004543 static const u8 fakeSortOrder = 0;
dan46c47d42011-03-01 18:42:07 +00004544
drh304637c2011-03-18 16:47:27 +00004545 assert( db->pPreUpdate==0 );
4546 memset(&preupdate, 0, sizeof(PreUpdate));
dan37db03b2011-03-16 19:59:18 +00004547 if( op==SQLITE_UPDATE ){
4548 iKey2 = v->aMem[iReg].u.i;
4549 }else{
4550 iKey2 = iKey1;
4551 }
4552
dane437ca52011-07-11 19:45:38 +00004553 assert( pCsr->nField==pTab->nCol
4554 || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
4555 );
4556
dan37db03b2011-03-16 19:59:18 +00004557 preupdate.v = v;
dan46c47d42011-03-01 18:42:07 +00004558 preupdate.pCsr = pCsr;
4559 preupdate.op = op;
dan37db03b2011-03-16 19:59:18 +00004560 preupdate.iNewReg = iReg;
dan4fccf432011-03-08 19:22:50 +00004561 preupdate.keyinfo.db = db;
4562 preupdate.keyinfo.enc = ENC(db);
dane437ca52011-07-11 19:45:38 +00004563 preupdate.keyinfo.nField = pTab->nCol;
drh498dcae2013-03-13 11:42:00 +00004564 preupdate.keyinfo.aSortOrder = (u8*)&fakeSortOrder;
dan319eeb72011-03-19 08:38:50 +00004565 preupdate.iKey1 = iKey1;
4566 preupdate.iKey2 = iKey2;
4567 preupdate.iPKey = pTab->iPKey;
4568
dan46c47d42011-03-01 18:42:07 +00004569 db->pPreUpdate = &preupdate;
4570 db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
4571 db->pPreUpdate = 0;
4572 sqlite3DbFree(db, preupdate.aRecord);
dan93bca692011-09-14 19:41:44 +00004573 vdbeFreeUnpacked(db, preupdate.pUnpacked);
4574 vdbeFreeUnpacked(db, preupdate.pNewUnpacked);
dan37db03b2011-03-16 19:59:18 +00004575 if( preupdate.aNew ){
4576 int i;
4577 for(i=0; i<pCsr->nField; i++){
4578 sqlite3VdbeMemRelease(&preupdate.aNew[i]);
4579 }
drhea022cf2011-03-18 15:13:31 +00004580 sqlite3DbFree(db, preupdate.aNew);
dan37db03b2011-03-16 19:59:18 +00004581 }
dan46c47d42011-03-01 18:42:07 +00004582}
drh9b1c62d2011-03-30 21:04:43 +00004583#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */