blob: 63609d72dd9e5bfff087c61814eb34bb9b67719e [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/*
68** Return the SQL associated with a prepared statement
69*/
danielk1977d0e2a852007-11-14 06:48:48 +000070const char *sqlite3_sql(sqlite3_stmt *pStmt){
danielk19776ab3a2e2009-02-19 14:39:25 +000071 Vdbe *p = (Vdbe *)pStmt;
drhef41dfe2015-09-02 17:55:12 +000072 return p ? p->zSql : 0;
drhb900aaf2006-11-09 00:24:53 +000073}
74
75/*
drhc5155252007-01-08 21:07:17 +000076** Swap all content between two VDBE structures.
drhb900aaf2006-11-09 00:24:53 +000077*/
drhc5155252007-01-08 21:07:17 +000078void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
79 Vdbe tmp, *pTmp;
80 char *zTmp;
drh0639c342011-03-18 12:35:36 +000081 assert( pA->db==pB->db );
drhc5155252007-01-08 21:07:17 +000082 tmp = *pA;
83 *pA = *pB;
84 *pB = tmp;
85 pTmp = pA->pNext;
86 pA->pNext = pB->pNext;
87 pB->pNext = pTmp;
88 pTmp = pA->pPrev;
89 pA->pPrev = pB->pPrev;
90 pB->pPrev = pTmp;
91 zTmp = pA->zSql;
92 pA->zSql = pB->zSql;
93 pB->zSql = zTmp;
danielk19776ab3a2e2009-02-19 14:39:25 +000094 pB->isPrepareV2 = pA->isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000095}
96
drh9a324642003-09-06 20:12:01 +000097/*
dan76ccd892014-08-12 13:38:52 +000098** Resize the Vdbe.aOp array so that it is at least nOp elements larger
drh81e069e2014-08-12 14:29:20 +000099** than its current size. nOp is guaranteed to be less than or equal
100** to 1024/sizeof(Op).
danielk1977ace3eb22006-01-26 10:35:04 +0000101**
danielk197700e13612008-11-17 19:18:54 +0000102** If an out-of-memory error occurs while resizing the array, return
dan76ccd892014-08-12 13:38:52 +0000103** SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
danielk197700e13612008-11-17 19:18:54 +0000104** unchanged (this is so that any opcodes already allocated can be
105** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +0000106*/
dan76ccd892014-08-12 13:38:52 +0000107static int growOpArray(Vdbe *v, int nOp){
drha4e5d582007-10-20 15:41:57 +0000108 VdbeOp *pNew;
drh73d5b8f2013-12-23 19:09:07 +0000109 Parse *p = v->pParse;
dan76ccd892014-08-12 13:38:52 +0000110
drh81e069e2014-08-12 14:29:20 +0000111 /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
112 ** more frequent reallocs and hence provide more opportunities for
113 ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
114 ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
115 ** by the minimum* amount required until the size reaches 512. Normal
116 ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
117 ** size of the op array or add 1KB of space, whichever is smaller. */
dan76ccd892014-08-12 13:38:52 +0000118#ifdef SQLITE_TEST_REALLOC_STRESS
119 int nNew = (p->nOpAlloc>=512 ? p->nOpAlloc*2 : p->nOpAlloc+nOp);
120#else
danielk197700e13612008-11-17 19:18:54 +0000121 int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
dan76ccd892014-08-12 13:38:52 +0000122 UNUSED_PARAMETER(nOp);
123#endif
124
drh81e069e2014-08-12 14:29:20 +0000125 assert( nOp<=(1024/sizeof(Op)) );
dan76ccd892014-08-12 13:38:52 +0000126 assert( nNew>=(p->nOpAlloc+nOp) );
drh73d5b8f2013-12-23 19:09:07 +0000127 pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +0000128 if( pNew ){
drhbd573082016-01-01 16:42:09 +0000129 p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
130 p->nOpAlloc = p->szOpAlloc/sizeof(Op);
drh73d5b8f2013-12-23 19:09:07 +0000131 v->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +0000132 }
mistachkinfad30392016-02-13 23:43:46 +0000133 return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
drh76ff3a02004-09-24 22:32:30 +0000134}
135
drh313619f2013-10-31 20:34:06 +0000136#ifdef SQLITE_DEBUG
137/* This routine is just a convenient place to set a breakpoint that will
138** fire after each opcode is inserted and displayed using
139** "PRAGMA vdbe_addoptrace=on".
140*/
141static void test_addop_breakpoint(void){
142 static int n = 0;
143 n++;
144}
145#endif
146
drh76ff3a02004-09-24 22:32:30 +0000147/*
drh9a324642003-09-06 20:12:01 +0000148** Add a new instruction to the list of instructions current in the
149** VDBE. Return the address of the new instruction.
150**
151** Parameters:
152**
153** p Pointer to the VDBE
154**
155** op The opcode for this instruction
156**
drh66a51672008-01-03 00:01:23 +0000157** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000158**
danielk19774adee202004-05-08 08:23:19 +0000159** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000160** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000161** operand.
162*/
drhd7970352015-11-09 12:33:39 +0000163static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
164 assert( p->pParse->nOpAlloc<=p->nOp );
165 if( growOpArray(p, 1) ) return 1;
166 assert( p->pParse->nOpAlloc>p->nOp );
167 return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
168}
drh66a51672008-01-03 00:01:23 +0000169int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000170 int i;
drh701a0ae2004-02-22 20:05:00 +0000171 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000172
173 i = p->nOp;
drh9a324642003-09-06 20:12:01 +0000174 assert( p->magic==VDBE_MAGIC_INIT );
drhed94af52016-02-01 17:20:08 +0000175 assert( op>=0 && op<0xff );
drh73d5b8f2013-12-23 19:09:07 +0000176 if( p->pParse->nOpAlloc<=i ){
drhd7970352015-11-09 12:33:39 +0000177 return growOp3(p, op, p1, p2, p3);
drh9a324642003-09-06 20:12:01 +0000178 }
danielk197701256832007-04-18 14:24:32 +0000179 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000180 pOp = &p->aOp[i];
drh8df32842008-12-09 02:51:23 +0000181 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000182 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000183 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000184 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000185 pOp->p3 = p3;
186 pOp->p4.p = 0;
187 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000188#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000189 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000190#endif
191#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000192 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh9ac79622013-12-18 15:11:47 +0000193 int jj, kk;
194 Parse *pParse = p->pParse;
195 for(jj=kk=0; jj<SQLITE_N_COLCACHE; jj++){
196 struct yColCache *x = pParse->aColCache + jj;
197 if( x->iLevel>pParse->iCacheLevel || x->iReg==0 ) continue;
198 printf(" r[%d]={%d:%d}", x->iReg, x->iTable, x->iColumn);
199 kk++;
200 }
201 if( kk ) printf("\n");
drhe0962052013-01-29 19:14:31 +0000202 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh313619f2013-10-31 20:34:06 +0000203 test_addop_breakpoint();
drhe0962052013-01-29 19:14:31 +0000204 }
drh9a324642003-09-06 20:12:01 +0000205#endif
drh26c9b5e2008-04-11 14:56:53 +0000206#ifdef VDBE_PROFILE
207 pOp->cycles = 0;
208 pOp->cnt = 0;
209#endif
drh688852a2014-02-17 22:40:43 +0000210#ifdef SQLITE_VDBE_COVERAGE
211 pOp->iSrcLine = 0;
212#endif
drh9a324642003-09-06 20:12:01 +0000213 return i;
214}
drh66a51672008-01-03 00:01:23 +0000215int sqlite3VdbeAddOp0(Vdbe *p, int op){
216 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
217}
218int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
219 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
220}
221int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
222 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000223}
224
drh076e85f2015-09-03 13:46:12 +0000225/* Generate code for an unconditional jump to instruction iDest
226*/
227int sqlite3VdbeGoto(Vdbe *p, int iDest){
drh2991ba02015-09-02 18:19:00 +0000228 return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
229}
drh701a0ae2004-02-22 20:05:00 +0000230
drh076e85f2015-09-03 13:46:12 +0000231/* Generate code to cause the string zStr to be loaded into
232** register iDest
233*/
234int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
235 return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
236}
237
238/*
239** Generate code that initializes multiple registers to string or integer
240** constants. The registers begin with iDest and increase consecutively.
241** One register is initialized for each characgter in zTypes[]. For each
242** "s" character in zTypes[], the register is a string if the argument is
243** not NULL, or OP_Null if the value is a null pointer. For each "i" character
244** in zTypes[], the register is initialized to an integer.
245*/
246void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
247 va_list ap;
248 int i;
249 char c;
250 va_start(ap, zTypes);
251 for(i=0; (c = zTypes[i])!=0; i++){
252 if( c=='s' ){
253 const char *z = va_arg(ap, const char*);
drh2ce18652016-01-16 20:50:21 +0000254 sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest++, 0, z, 0);
drh076e85f2015-09-03 13:46:12 +0000255 }else{
256 assert( c=='i' );
257 sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest++);
258 }
259 }
260 va_end(ap);
261}
drh66a51672008-01-03 00:01:23 +0000262
drh701a0ae2004-02-22 20:05:00 +0000263/*
drh66a51672008-01-03 00:01:23 +0000264** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000265*/
drh66a51672008-01-03 00:01:23 +0000266int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000267 Vdbe *p, /* Add the opcode to this VM */
268 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000269 int p1, /* The P1 operand */
270 int p2, /* The P2 operand */
271 int p3, /* The P3 operand */
272 const char *zP4, /* The P4 operand */
273 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000274){
drh66a51672008-01-03 00:01:23 +0000275 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
276 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000277 return addr;
278}
279
280/*
drh7cc023c2015-09-03 04:28:25 +0000281** Add an opcode that includes the p4 value with a P4_INT64 or
282** P4_REAL type.
drh97bae792015-06-05 15:59:57 +0000283*/
284int sqlite3VdbeAddOp4Dup8(
285 Vdbe *p, /* Add the opcode to this VM */
286 int op, /* The new opcode */
287 int p1, /* The P1 operand */
288 int p2, /* The P2 operand */
289 int p3, /* The P3 operand */
290 const u8 *zP4, /* The P4 operand */
291 int p4type /* P4 operand type */
292){
drh575fad62016-02-05 13:38:36 +0000293 char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
drh97bae792015-06-05 15:59:57 +0000294 if( p4copy ) memcpy(p4copy, zP4, 8);
295 return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
296}
297
298/*
drh5d9c9da2011-06-03 20:11:17 +0000299** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000300** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
301** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000302**
303** The zWhere string must have been obtained from sqlite3_malloc().
304** This routine will take ownership of the allocated memory.
305*/
306void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
307 int j;
drh00dceca2016-01-11 22:58:50 +0000308 sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
drh5d9c9da2011-06-03 20:11:17 +0000309 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
310}
311
312/*
drh8cff69d2009-11-12 19:59:44 +0000313** Add an opcode that includes the p4 value as an integer.
314*/
315int sqlite3VdbeAddOp4Int(
316 Vdbe *p, /* Add the opcode to this VM */
317 int op, /* The new opcode */
318 int p1, /* The P1 operand */
319 int p2, /* The P2 operand */
320 int p3, /* The P3 operand */
321 int p4 /* The P4 operand as an integer */
322){
323 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
324 sqlite3VdbeChangeP4(p, addr, SQLITE_INT_TO_PTR(p4), P4_INT32);
325 return addr;
326}
327
drh2fade2f2016-02-09 02:12:20 +0000328/* Insert the end of a co-routine
329*/
330void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
331 sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
332
333 /* Clear the temporary register cache, thereby ensuring that each
334 ** co-routine has its own independent set of registers, because co-routines
335 ** might expect their registers to be preserved across an OP_Yield, and
336 ** that could cause problems if two or more co-routines are using the same
337 ** temporary register.
338 */
339 v->pParse->nTempReg = 0;
340 v->pParse->nRangeReg = 0;
341}
342
drh8cff69d2009-11-12 19:59:44 +0000343/*
drh9a324642003-09-06 20:12:01 +0000344** Create a new symbolic label for an instruction that has yet to be
345** coded. The symbolic label is really just a negative number. The
346** label can be used as the P2 value of an operation. Later, when
347** the label is resolved to a specific address, the VDBE will scan
348** through its operation list and change all values of P2 which match
349** the label into the resolved address.
350**
351** The VDBE knows that a P2 value is a label because labels are
352** always negative and P2 values are suppose to be non-negative.
353** Hence, a negative P2 value is a label that has yet to be resolved.
danielk1977b5548a82004-06-26 13:51:33 +0000354**
355** Zero is returned if a malloc() fails.
drh9a324642003-09-06 20:12:01 +0000356*/
drh73d5b8f2013-12-23 19:09:07 +0000357int sqlite3VdbeMakeLabel(Vdbe *v){
358 Parse *p = v->pParse;
drhc35f3d52012-02-01 19:03:38 +0000359 int i = p->nLabel++;
drh73d5b8f2013-12-23 19:09:07 +0000360 assert( v->magic==VDBE_MAGIC_INIT );
drhc35f3d52012-02-01 19:03:38 +0000361 if( (i & (i-1))==0 ){
362 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
363 (i*2+1)*sizeof(p->aLabel[0]));
drh9a324642003-09-06 20:12:01 +0000364 }
drh76ff3a02004-09-24 22:32:30 +0000365 if( p->aLabel ){
366 p->aLabel[i] = -1;
drh9a324642003-09-06 20:12:01 +0000367 }
drh5ef09bf2015-12-09 17:23:12 +0000368 return ADDR(i);
drh9a324642003-09-06 20:12:01 +0000369}
370
371/*
372** Resolve label "x" to be the address of the next instruction to
373** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000374** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000375*/
drh73d5b8f2013-12-23 19:09:07 +0000376void sqlite3VdbeResolveLabel(Vdbe *v, int x){
377 Parse *p = v->pParse;
drh5ef09bf2015-12-09 17:23:12 +0000378 int j = ADDR(x);
drh73d5b8f2013-12-23 19:09:07 +0000379 assert( v->magic==VDBE_MAGIC_INIT );
drhb2b9d3d2013-08-01 01:14:43 +0000380 assert( j<p->nLabel );
drhef41dfe2015-09-02 17:55:12 +0000381 assert( j>=0 );
382 if( p->aLabel ){
drh73d5b8f2013-12-23 19:09:07 +0000383 p->aLabel[j] = v->nOp;
drh9a324642003-09-06 20:12:01 +0000384 }
drh61019c72014-01-04 16:49:02 +0000385 p->iFixedOp = v->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000386}
387
drh4611d922010-02-25 14:47:01 +0000388/*
389** Mark the VDBE as one that can only be run one time.
390*/
391void sqlite3VdbeRunOnlyOnce(Vdbe *p){
392 p->runOnlyOnce = 1;
393}
394
drhf71a3662016-03-16 20:44:45 +0000395/*
396** Mark the VDBE as one that can only be run multiple times.
397*/
398void sqlite3VdbeReusable(Vdbe *p){
399 p->runOnlyOnce = 0;
400}
401
drhff738bc2009-09-24 00:09:58 +0000402#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000403
404/*
405** The following type and function are used to iterate through all opcodes
406** in a Vdbe main program and each of the sub-programs (triggers) it may
407** invoke directly or indirectly. It should be used as follows:
408**
409** Op *pOp;
410** VdbeOpIter sIter;
411**
412** memset(&sIter, 0, sizeof(sIter));
413** sIter.v = v; // v is of type Vdbe*
414** while( (pOp = opIterNext(&sIter)) ){
415** // Do something with pOp
416** }
417** sqlite3DbFree(v->db, sIter.apSub);
418**
419*/
420typedef struct VdbeOpIter VdbeOpIter;
421struct VdbeOpIter {
422 Vdbe *v; /* Vdbe to iterate through the opcodes of */
423 SubProgram **apSub; /* Array of subprograms */
424 int nSub; /* Number of entries in apSub */
425 int iAddr; /* Address of next instruction to return */
426 int iSub; /* 0 = main program, 1 = first sub-program etc. */
427};
428static Op *opIterNext(VdbeOpIter *p){
429 Vdbe *v = p->v;
430 Op *pRet = 0;
431 Op *aOp;
432 int nOp;
433
434 if( p->iSub<=p->nSub ){
435
436 if( p->iSub==0 ){
437 aOp = v->aOp;
438 nOp = v->nOp;
439 }else{
440 aOp = p->apSub[p->iSub-1]->aOp;
441 nOp = p->apSub[p->iSub-1]->nOp;
442 }
443 assert( p->iAddr<nOp );
444
445 pRet = &aOp[p->iAddr];
446 p->iAddr++;
447 if( p->iAddr==nOp ){
448 p->iSub++;
449 p->iAddr = 0;
450 }
451
452 if( pRet->p4type==P4_SUBPROGRAM ){
453 int nByte = (p->nSub+1)*sizeof(SubProgram*);
454 int j;
455 for(j=0; j<p->nSub; j++){
456 if( p->apSub[j]==pRet->p4.pProgram ) break;
457 }
458 if( j==p->nSub ){
459 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
460 if( !p->apSub ){
461 pRet = 0;
462 }else{
463 p->apSub[p->nSub++] = pRet->p4.pProgram;
464 }
465 }
466 }
467 }
468
469 return pRet;
470}
471
472/*
danf3677212009-09-10 16:14:50 +0000473** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000474** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000475** to be rolled back). This condition is true if the main program or any
476** sub-programs contains any of the following:
477**
478** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
479** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
480** * OP_Destroy
481** * OP_VUpdate
482** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000483** * OP_FkCounter with P2==0 (immediate foreign key constraint)
drh0dd5cda2015-06-16 16:39:01 +0000484** * OP_CreateTable and OP_InitCoroutine (for CREATE TABLE AS SELECT ...)
dan144926d2009-09-09 11:37:20 +0000485**
danf3677212009-09-10 16:14:50 +0000486** Then check that the value of Parse.mayAbort is true if an
487** ABORT may be thrown, or false otherwise. Return true if it does
488** match, or false otherwise. This function is intended to be used as
489** part of an assert statement in the compiler. Similar to:
490**
491** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000492*/
danf3677212009-09-10 16:14:50 +0000493int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
494 int hasAbort = 0;
dan04668832014-12-16 20:13:30 +0000495 int hasFkCounter = 0;
drh0dd5cda2015-06-16 16:39:01 +0000496 int hasCreateTable = 0;
497 int hasInitCoroutine = 0;
dan144926d2009-09-09 11:37:20 +0000498 Op *pOp;
499 VdbeOpIter sIter;
500 memset(&sIter, 0, sizeof(sIter));
501 sIter.v = v;
502
503 while( (pOp = opIterNext(&sIter))!=0 ){
504 int opcode = pOp->opcode;
505 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
506 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drhd91c1a12013-02-09 13:58:25 +0000507 && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000508 ){
danf3677212009-09-10 16:14:50 +0000509 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000510 break;
511 }
drh0dd5cda2015-06-16 16:39:01 +0000512 if( opcode==OP_CreateTable ) hasCreateTable = 1;
513 if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
dan04668832014-12-16 20:13:30 +0000514#ifndef SQLITE_OMIT_FOREIGN_KEY
515 if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
516 hasFkCounter = 1;
517 }
518#endif
dan144926d2009-09-09 11:37:20 +0000519 }
dan144926d2009-09-09 11:37:20 +0000520 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000521
mistachkin48864df2013-03-21 21:20:32 +0000522 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000523 ** If malloc failed, then the while() loop above may not have iterated
524 ** through all opcodes and hasAbort may be set incorrectly. Return
525 ** true for this case to prevent the assert() in the callers frame
526 ** from failing. */
drh0dd5cda2015-06-16 16:39:01 +0000527 return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
528 || (hasCreateTable && hasInitCoroutine) );
dan144926d2009-09-09 11:37:20 +0000529}
drhff738bc2009-09-24 00:09:58 +0000530#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000531
drh9a324642003-09-06 20:12:01 +0000532/*
drhef41dfe2015-09-02 17:55:12 +0000533** This routine is called after all opcodes have been inserted. It loops
534** through all the opcodes and fixes up some details.
drh76ff3a02004-09-24 22:32:30 +0000535**
drhef41dfe2015-09-02 17:55:12 +0000536** (1) For each jump instruction with a negative P2 value (a label)
537** resolve the P2 value to an actual address.
danielk1977634f2982005-03-28 08:44:07 +0000538**
drhef41dfe2015-09-02 17:55:12 +0000539** (2) Compute the maximum number of arguments used by any SQL function
540** and store that value in *pMaxFuncArgs.
drha6c2ed92009-11-14 23:22:23 +0000541**
drhef41dfe2015-09-02 17:55:12 +0000542** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
543** indicate what the prepared statement actually does.
544**
545** (4) Initialize the p4.xAdvance pointer on opcodes that use it.
546**
547** (5) Reclaim the memory allocated for storing labels.
drh7cc84c22016-04-11 13:36:42 +0000548**
549** This routine will only function correctly if the mkopcodeh.tcl generator
550** script numbers the opcodes correctly. Changes to this routine must be
551** coordinated with changes to mkopcodeh.tcl.
drh76ff3a02004-09-24 22:32:30 +0000552*/
drh9cbf3422008-01-17 16:22:13 +0000553static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
dan165921a2009-08-28 18:53:45 +0000554 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000555 Op *pOp;
drh73d5b8f2013-12-23 19:09:07 +0000556 Parse *pParse = p->pParse;
557 int *aLabel = pParse->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000558 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000559 p->bIsReader = 0;
drh7cc84c22016-04-11 13:36:42 +0000560 pOp = &p->aOp[p->nOp-1];
561 while(1){
danielk1977634f2982005-03-28 08:44:07 +0000562
drh7cc84c22016-04-11 13:36:42 +0000563 /* Only JUMP opcodes and the short list of special opcodes in the switch
564 ** below need to be considered. The mkopcodeh.tcl generator script groups
565 ** all these opcodes together near the front of the opcode list. Skip
566 ** any opcode that does not need processing by virtual of the fact that
drhc310db32016-04-11 16:35:05 +0000567 ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
drh7cc84c22016-04-11 13:36:42 +0000568 */
drhc310db32016-04-11 16:35:05 +0000569 if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
drh7cc84c22016-04-11 13:36:42 +0000570 /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
571 ** cases from this switch! */
572 switch( pOp->opcode ){
573 case OP_Transaction: {
574 if( pOp->p2!=0 ) p->readOnly = 0;
575 /* fall thru */
576 }
577 case OP_AutoCommit:
578 case OP_Savepoint: {
579 p->bIsReader = 1;
580 break;
581 }
dand9031542013-07-05 16:54:30 +0000582#ifndef SQLITE_OMIT_WAL
drh7cc84c22016-04-11 13:36:42 +0000583 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000584#endif
drh7cc84c22016-04-11 13:36:42 +0000585 case OP_Vacuum:
586 case OP_JournalMode: {
587 p->readOnly = 0;
588 p->bIsReader = 1;
589 break;
590 }
danielk1977182c4ba2007-06-27 15:53:34 +0000591#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7cc84c22016-04-11 13:36:42 +0000592 case OP_VUpdate: {
593 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
594 break;
595 }
596 case OP_VFilter: {
597 int n;
598 assert( (pOp - p->aOp) >= 3 );
599 assert( pOp[-1].opcode==OP_Integer );
600 n = pOp[-1].p1;
601 if( n>nMaxArgs ) nMaxArgs = n;
602 break;
603 }
danielk1977182c4ba2007-06-27 15:53:34 +0000604#endif
drh7cc84c22016-04-11 13:36:42 +0000605 case OP_Next:
606 case OP_NextIfOpen:
607 case OP_SorterNext: {
608 pOp->p4.xAdvance = sqlite3BtreeNext;
609 pOp->p4type = P4_ADVANCE;
610 break;
611 }
612 case OP_Prev:
613 case OP_PrevIfOpen: {
614 pOp->p4.xAdvance = sqlite3BtreePrevious;
615 pOp->p4type = P4_ADVANCE;
616 break;
617 }
drh8c8a8c42013-08-06 07:45:08 +0000618 }
drh7cc84c22016-04-11 13:36:42 +0000619 if( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 && pOp->p2<0 ){
620 assert( ADDR(pOp->p2)<pParse->nLabel );
621 pOp->p2 = aLabel[ADDR(pOp->p2)];
drh8c8a8c42013-08-06 07:45:08 +0000622 }
danielk1977bc04f852005-03-29 08:26:13 +0000623 }
drh7cc84c22016-04-11 13:36:42 +0000624 if( pOp==p->aOp ) break;
625 pOp--;
drh76ff3a02004-09-24 22:32:30 +0000626 }
drh73d5b8f2013-12-23 19:09:07 +0000627 sqlite3DbFree(p->db, pParse->aLabel);
628 pParse->aLabel = 0;
629 pParse->nLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000630 *pMaxFuncArgs = nMaxArgs;
drha7ab6d82014-07-21 15:44:39 +0000631 assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
drh76ff3a02004-09-24 22:32:30 +0000632}
633
634/*
drh9a324642003-09-06 20:12:01 +0000635** Return the address of the next instruction to be inserted.
636*/
danielk19774adee202004-05-08 08:23:19 +0000637int sqlite3VdbeCurrentAddr(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000638 assert( p->magic==VDBE_MAGIC_INIT );
639 return p->nOp;
640}
641
dan65a7cd12009-09-01 12:16:01 +0000642/*
drh2ce18652016-01-16 20:50:21 +0000643** Verify that at least N opcode slots are available in p without
drhdad300d2016-01-18 00:20:26 +0000644** having to malloc for more space (except when compiled using
645** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
646** to verify that certain calls to sqlite3VdbeAddOpList() can never
647** fail due to a OOM fault and hence that the return value from
648** sqlite3VdbeAddOpList() will always be non-NULL.
drh2ce18652016-01-16 20:50:21 +0000649*/
drhdad300d2016-01-18 00:20:26 +0000650#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
651void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
drh2ce18652016-01-16 20:50:21 +0000652 assert( p->nOp + N <= p->pParse->nOpAlloc );
653}
654#endif
655
656/*
dan65a7cd12009-09-01 12:16:01 +0000657** This function returns a pointer to the array of opcodes associated with
658** the Vdbe passed as the first argument. It is the callers responsibility
659** to arrange for the returned array to be eventually freed using the
660** vdbeFreeOpArray() function.
661**
662** Before returning, *pnOp is set to the number of entries in the returned
663** array. Also, *pnMaxArg is set to the larger of its current value and
664** the number of entries in the Vdbe.apArg[] array required to execute the
665** returned program.
666*/
dan165921a2009-08-28 18:53:45 +0000667VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
668 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +0000669 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +0000670
671 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drha7ab6d82014-07-21 15:44:39 +0000672 assert( DbMaskAllZero(p->btreeMask) );
dan65a7cd12009-09-01 12:16:01 +0000673
dan165921a2009-08-28 18:53:45 +0000674 resolveP2Values(p, pnMaxArg);
675 *pnOp = p->nOp;
676 p->aOp = 0;
677 return aOp;
678}
679
drh9a324642003-09-06 20:12:01 +0000680/*
drh2ce18652016-01-16 20:50:21 +0000681** Add a whole list of operations to the operation stack. Return a
682** pointer to the first operation inserted.
drh1b325542016-02-03 01:55:44 +0000683**
684** Non-zero P2 arguments to jump instructions are automatically adjusted
685** so that the jump target is relative to the first operation inserted.
drh9a324642003-09-06 20:12:01 +0000686*/
drh2ce18652016-01-16 20:50:21 +0000687VdbeOp *sqlite3VdbeAddOpList(
688 Vdbe *p, /* Add opcodes to the prepared statement */
689 int nOp, /* Number of opcodes to add */
690 VdbeOpList const *aOp, /* The opcodes to be added */
691 int iLineno /* Source-file line number of first opcode */
692){
693 int i;
694 VdbeOp *pOut, *pFirst;
drhef41dfe2015-09-02 17:55:12 +0000695 assert( nOp>0 );
drh9a324642003-09-06 20:12:01 +0000696 assert( p->magic==VDBE_MAGIC_INIT );
dan76ccd892014-08-12 13:38:52 +0000697 if( p->nOp + nOp > p->pParse->nOpAlloc && growOpArray(p, nOp) ){
drh76ff3a02004-09-24 22:32:30 +0000698 return 0;
drh9a324642003-09-06 20:12:01 +0000699 }
drh2ce18652016-01-16 20:50:21 +0000700 pFirst = pOut = &p->aOp[p->nOp];
drhef41dfe2015-09-02 17:55:12 +0000701 for(i=0; i<nOp; i++, aOp++, pOut++){
drhef41dfe2015-09-02 17:55:12 +0000702 pOut->opcode = aOp->opcode;
703 pOut->p1 = aOp->p1;
drh5ef09bf2015-12-09 17:23:12 +0000704 pOut->p2 = aOp->p2;
705 assert( aOp->p2>=0 );
drh1b325542016-02-03 01:55:44 +0000706 if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
707 pOut->p2 += p->nOp;
708 }
drhef41dfe2015-09-02 17:55:12 +0000709 pOut->p3 = aOp->p3;
710 pOut->p4type = P4_NOTUSED;
711 pOut->p4.p = 0;
712 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +0000713#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhef41dfe2015-09-02 17:55:12 +0000714 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000715#endif
drh688852a2014-02-17 22:40:43 +0000716#ifdef SQLITE_VDBE_COVERAGE
drhef41dfe2015-09-02 17:55:12 +0000717 pOut->iSrcLine = iLineno+i;
drh688852a2014-02-17 22:40:43 +0000718#else
drhef41dfe2015-09-02 17:55:12 +0000719 (void)iLineno;
drh688852a2014-02-17 22:40:43 +0000720#endif
drhc7379ce2013-10-30 02:28:23 +0000721#ifdef SQLITE_DEBUG
drhef41dfe2015-09-02 17:55:12 +0000722 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh2ce18652016-01-16 20:50:21 +0000723 sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
drh9a324642003-09-06 20:12:01 +0000724 }
drhef41dfe2015-09-02 17:55:12 +0000725#endif
drh9a324642003-09-06 20:12:01 +0000726 }
drhef41dfe2015-09-02 17:55:12 +0000727 p->nOp += nOp;
drh2ce18652016-01-16 20:50:21 +0000728 return pFirst;
drh9a324642003-09-06 20:12:01 +0000729}
730
dan6f9702e2014-11-01 20:38:06 +0000731#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
732/*
733** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
734*/
dan037b5322014-11-03 11:25:32 +0000735void sqlite3VdbeScanStatus(
dan6f9702e2014-11-01 20:38:06 +0000736 Vdbe *p, /* VM to add scanstatus() to */
737 int addrExplain, /* Address of OP_Explain (or 0) */
738 int addrLoop, /* Address of loop counter */
739 int addrVisit, /* Address of rows visited counter */
drh518140e2014-11-06 03:55:10 +0000740 LogEst nEst, /* Estimated number of output rows */
dan6f9702e2014-11-01 20:38:06 +0000741 const char *zName /* Name of table or index being scanned */
742){
dan037b5322014-11-03 11:25:32 +0000743 int nByte = (p->nScan+1) * sizeof(ScanStatus);
744 ScanStatus *aNew;
745 aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
dan6f9702e2014-11-01 20:38:06 +0000746 if( aNew ){
dan037b5322014-11-03 11:25:32 +0000747 ScanStatus *pNew = &aNew[p->nScan++];
dan6f9702e2014-11-01 20:38:06 +0000748 pNew->addrExplain = addrExplain;
749 pNew->addrLoop = addrLoop;
750 pNew->addrVisit = addrVisit;
751 pNew->nEst = nEst;
752 pNew->zName = sqlite3DbStrDup(p->db, zName);
753 p->aScan = aNew;
754 }
755}
756#endif
757
758
drh9a324642003-09-06 20:12:01 +0000759/*
drh0ff287f2015-09-02 18:40:33 +0000760** Change the value of the opcode, or P1, P2, P3, or P5 operands
761** for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000762*/
drh0ff287f2015-09-02 18:40:33 +0000763void sqlite3VdbeChangeOpcode(Vdbe *p, u32 addr, u8 iNewOpcode){
764 sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
765}
drh88caeac2011-08-24 15:12:08 +0000766void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000767 sqlite3VdbeGetOp(p,addr)->p1 = val;
drh9a324642003-09-06 20:12:01 +0000768}
drh88caeac2011-08-24 15:12:08 +0000769void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000770 sqlite3VdbeGetOp(p,addr)->p2 = val;
drh9a324642003-09-06 20:12:01 +0000771}
drh88caeac2011-08-24 15:12:08 +0000772void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000773 sqlite3VdbeGetOp(p,addr)->p3 = val;
danielk1977207872a2008-01-03 07:54:23 +0000774}
drh0ff287f2015-09-02 18:40:33 +0000775void sqlite3VdbeChangeP5(Vdbe *p, u8 p5){
drh9b34abe2016-01-16 15:12:35 +0000776 if( !p->db->mallocFailed ) p->aOp[p->nOp-1].p5 = p5;
danielk19771f4aa332008-01-03 09:51:55 +0000777}
778
779/*
drhf8875402006-03-17 13:56:34 +0000780** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +0000781** the address of the next instruction to be coded.
782*/
783void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drh61019c72014-01-04 16:49:02 +0000784 p->pParse->iFixedOp = p->nOp - 1;
drh0ff287f2015-09-02 18:40:33 +0000785 sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +0000786}
drhb38ad992005-09-16 00:27:01 +0000787
drhb7f6f682006-07-08 17:06:43 +0000788
789/*
790** If the input FuncDef structure is ephemeral, then free it. If
791** the FuncDef is not ephermal, then do nothing.
792*/
drh633e6d52008-07-28 19:34:53 +0000793static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drhf431a872016-05-20 15:53:47 +0000794 if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh633e6d52008-07-28 19:34:53 +0000795 sqlite3DbFree(db, pDef);
drhb7f6f682006-07-08 17:06:43 +0000796 }
797}
798
dand46def72010-07-24 11:28:28 +0000799static void vdbeFreeOpArray(sqlite3 *, Op *, int);
800
drhb38ad992005-09-16 00:27:01 +0000801/*
drh66a51672008-01-03 00:01:23 +0000802** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +0000803*/
drhf431a872016-05-20 15:53:47 +0000804static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
805 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
806 sqlite3DbFree(db, p);
807}
808static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
809 freeEphemeralFunction(db, p->pFunc);
810 sqlite3DbFree(db, p);
811}
drh633e6d52008-07-28 19:34:53 +0000812static void freeP4(sqlite3 *db, int p4type, void *p4){
drhbe5000d2016-04-07 14:05:20 +0000813 assert( db );
814 switch( p4type ){
815 case P4_FUNCCTX: {
drhf431a872016-05-20 15:53:47 +0000816 freeP4FuncCtx(db, (sqlite3_context*)p4);
817 break;
drhbe5000d2016-04-07 14:05:20 +0000818 }
819 case P4_REAL:
820 case P4_INT64:
821 case P4_DYNAMIC:
822 case P4_INTARRAY: {
823 sqlite3DbFree(db, p4);
824 break;
825 }
826 case P4_KEYINFO: {
827 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
828 break;
829 }
drh28935362013-12-07 20:39:19 +0000830#ifdef SQLITE_ENABLE_CURSOR_HINTS
drhbe5000d2016-04-07 14:05:20 +0000831 case P4_EXPR: {
832 sqlite3ExprDelete(db, (Expr*)p4);
833 break;
834 }
drh28935362013-12-07 20:39:19 +0000835#endif
drhbe5000d2016-04-07 14:05:20 +0000836 case P4_MPRINTF: {
837 if( db->pnBytesFreed==0 ) sqlite3_free(p4);
838 break;
839 }
840 case P4_FUNCDEF: {
841 freeEphemeralFunction(db, (FuncDef*)p4);
842 break;
843 }
844 case P4_MEM: {
845 if( db->pnBytesFreed==0 ){
846 sqlite3ValueFree((sqlite3_value*)p4);
847 }else{
drhf431a872016-05-20 15:53:47 +0000848 freeP4Mem(db, (Mem*)p4);
drhb9755982010-07-24 16:34:37 +0000849 }
drhbe5000d2016-04-07 14:05:20 +0000850 break;
851 }
852 case P4_VTAB : {
853 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
854 break;
drhb38ad992005-09-16 00:27:01 +0000855 }
856 }
857}
858
dan65a7cd12009-09-01 12:16:01 +0000859/*
860** Free the space allocated for aOp and any p4 values allocated for the
861** opcodes contained within. If aOp is not NULL it is assumed to contain
862** nOp entries.
863*/
dan165921a2009-08-28 18:53:45 +0000864static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
865 if( aOp ){
866 Op *pOp;
867 for(pOp=aOp; pOp<&aOp[nOp]; pOp++){
drh00dceca2016-01-11 22:58:50 +0000868 if( pOp->p4type ) freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +0000869#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +0000870 sqlite3DbFree(db, pOp->zComment);
871#endif
872 }
873 }
874 sqlite3DbFree(db, aOp);
875}
876
dan65a7cd12009-09-01 12:16:01 +0000877/*
dand19c9332010-07-26 12:05:17 +0000878** Link the SubProgram object passed as the second argument into the linked
879** list at Vdbe.pSubProgram. This list is used to delete all sub-program
880** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +0000881*/
dand19c9332010-07-26 12:05:17 +0000882void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
883 p->pNext = pVdbe->pProgram;
884 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +0000885}
886
drh9a324642003-09-06 20:12:01 +0000887/*
drh48f2d3b2011-09-16 01:34:43 +0000888** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +0000889*/
drh2ce18652016-01-16 20:50:21 +0000890int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
891 VdbeOp *pOp;
892 if( p->db->mallocFailed ) return 0;
893 assert( addr>=0 && addr<p->nOp );
894 pOp = &p->aOp[addr];
895 freeP4(p->db, pOp->p4type, pOp->p4.p);
drh4b31bda2016-01-20 02:01:02 +0000896 pOp->p4type = P4_NOTUSED;
drh939e7782016-01-20 02:36:12 +0000897 pOp->p4.z = 0;
drh2ce18652016-01-16 20:50:21 +0000898 pOp->opcode = OP_Noop;
899 return 1;
drhf8875402006-03-17 13:56:34 +0000900}
901
902/*
drh39c4b822014-09-29 15:42:01 +0000903** If the last opcode is "op" and it is not a jump destination,
904** then remove it. Return true if and only if an opcode was removed.
drh762c1c42014-01-02 19:35:30 +0000905*/
drh61019c72014-01-04 16:49:02 +0000906int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
907 if( (p->nOp-1)>(p->pParse->iFixedOp) && p->aOp[p->nOp-1].opcode==op ){
drh2ce18652016-01-16 20:50:21 +0000908 return sqlite3VdbeChangeToNoop(p, p->nOp-1);
drh61019c72014-01-04 16:49:02 +0000909 }else{
910 return 0;
911 }
drh762c1c42014-01-02 19:35:30 +0000912}
913
914/*
drh66a51672008-01-03 00:01:23 +0000915** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000916** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000917** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000918** few minor changes to the program.
919**
drh66a51672008-01-03 00:01:23 +0000920** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +0000921** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +0000922** A value of n==0 means copy bytes of zP4 up to and including the
923** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +0000924**
drh66a51672008-01-03 00:01:23 +0000925** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +0000926** to a string or structure that is guaranteed to exist for the lifetime of
927** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +0000928**
drh66a51672008-01-03 00:01:23 +0000929** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +0000930*/
drh00dceca2016-01-11 22:58:50 +0000931static void SQLITE_NOINLINE vdbeChangeP4Full(
932 Vdbe *p,
933 Op *pOp,
934 const char *zP4,
935 int n
936){
937 if( pOp->p4type ){
938 freeP4(p->db, pOp->p4type, pOp->p4.p);
939 pOp->p4type = 0;
940 pOp->p4.p = 0;
941 }
942 if( n<0 ){
943 sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
944 }else{
945 if( n==0 ) n = sqlite3Strlen30(zP4);
946 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
947 pOp->p4type = P4_DYNAMIC;
948 }
949}
drh66a51672008-01-03 00:01:23 +0000950void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +0000951 Op *pOp;
drh633e6d52008-07-28 19:34:53 +0000952 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +0000953 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +0000954 db = p->db;
drh91fd4d42008-01-19 20:11:25 +0000955 assert( p->magic==VDBE_MAGIC_INIT );
drh00dceca2016-01-11 22:58:50 +0000956 assert( p->aOp!=0 || db->mallocFailed );
957 if( db->mallocFailed ){
958 if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
danielk1977d5d56522005-03-16 12:15:20 +0000959 return;
960 }
drh7b746032009-06-26 12:15:22 +0000961 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +0000962 assert( addr<p->nOp );
963 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +0000964 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000965 }
966 pOp = &p->aOp[addr];
drh00dceca2016-01-11 22:58:50 +0000967 if( n>=0 || pOp->p4type ){
968 vdbeChangeP4Full(p, pOp, zP4, n);
969 return;
970 }
drh98757152008-01-09 23:04:12 +0000971 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +0000972 /* Note: this cast is safe, because the origin data point was an int
973 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +0000974 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +0000975 pOp->p4type = P4_INT32;
drh00dceca2016-01-11 22:58:50 +0000976 }else if( zP4!=0 ){
977 assert( n<0 );
danielk19772dca4ac2008-01-03 11:50:29 +0000978 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +0000979 pOp->p4type = (signed char)n;
drh00dceca2016-01-11 22:58:50 +0000980 if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
drh9a324642003-09-06 20:12:01 +0000981 }
982}
983
drh2ec2fb22013-11-06 19:59:23 +0000984/*
985** Set the P4 on the most recently added opcode to the KeyInfo for the
986** index given.
987*/
988void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
989 Vdbe *v = pParse->pVdbe;
990 assert( v!=0 );
991 assert( pIdx!=0 );
992 sqlite3VdbeChangeP4(v, -1, (char*)sqlite3KeyInfoOfIndex(pParse, pIdx),
993 P4_KEYINFO);
994}
995
drhc7379ce2013-10-30 02:28:23 +0000996#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +0000997/*
mistachkind5578432012-08-25 10:01:29 +0000998** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +0000999** insert a No-op and add the comment to that new instruction. This
1000** makes the code easier to read during debugging. None of this happens
1001** in a production build.
drhad6d9462004-09-19 02:15:24 +00001002*/
drhb07028f2011-10-14 21:49:18 +00001003static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +00001004 assert( p->nOp>0 || p->aOp==0 );
drhd4e70eb2008-01-02 00:34:36 +00001005 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
danielk1977dba01372008-01-05 18:44:29 +00001006 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +00001007 assert( p->aOp );
1008 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
1009 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
1010 }
1011}
1012void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
1013 va_list ap;
1014 if( p ){
danielk1977dba01372008-01-05 18:44:29 +00001015 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001016 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +00001017 va_end(ap);
1018 }
drhad6d9462004-09-19 02:15:24 +00001019}
drh16ee60f2008-06-20 18:13:25 +00001020void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
1021 va_list ap;
drhb07028f2011-10-14 21:49:18 +00001022 if( p ){
1023 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +00001024 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001025 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +00001026 va_end(ap);
1027 }
1028}
1029#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +00001030
drh688852a2014-02-17 22:40:43 +00001031#ifdef SQLITE_VDBE_COVERAGE
1032/*
1033** Set the value if the iSrcLine field for the previously coded instruction.
1034*/
1035void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
1036 sqlite3VdbeGetOp(v,-1)->iSrcLine = iLine;
1037}
1038#endif /* SQLITE_VDBE_COVERAGE */
1039
drh9a324642003-09-06 20:12:01 +00001040/*
drh20411ea2009-05-29 19:00:12 +00001041** Return the opcode for a given address. If the address is -1, then
1042** return the most recently inserted opcode.
1043**
1044** If a memory allocation error has occurred prior to the calling of this
1045** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +00001046** is readable but not writable, though it is cast to a writable value.
1047** The return of a dummy opcode allows the call to continue functioning
peter.d.reid60ec9142014-09-06 16:39:46 +00001048** after an OOM fault without having to check to see if the return from
drhf83dc1e2010-06-03 12:09:52 +00001049** this routine is a valid pointer. But because the dummy.opcode is 0,
1050** dummy will never be written to. This is verified by code inspection and
1051** by running with Valgrind.
drh9a324642003-09-06 20:12:01 +00001052*/
danielk19774adee202004-05-08 08:23:19 +00001053VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +00001054 /* C89 specifies that the constant "dummy" will be initialized to all
1055 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +00001056 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh9a324642003-09-06 20:12:01 +00001057 assert( p->magic==VDBE_MAGIC_INIT );
drh37b89a02009-06-19 00:33:31 +00001058 if( addr<0 ){
drh37b89a02009-06-19 00:33:31 +00001059 addr = p->nOp - 1;
1060 }
drh17435752007-08-16 04:30:38 +00001061 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00001062 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +00001063 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +00001064 }else{
1065 return &p->aOp[addr];
1066 }
drh9a324642003-09-06 20:12:01 +00001067}
1068
drhc7379ce2013-10-30 02:28:23 +00001069#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +00001070/*
drhf63552b2013-10-30 00:25:03 +00001071** Return an integer value for one of the parameters to the opcode pOp
1072** determined by character c.
1073*/
1074static int translateP(char c, const Op *pOp){
1075 if( c=='1' ) return pOp->p1;
1076 if( c=='2' ) return pOp->p2;
1077 if( c=='3' ) return pOp->p3;
1078 if( c=='4' ) return pOp->p4.i;
1079 return pOp->p5;
1080}
1081
drh81316f82013-10-29 20:40:47 +00001082/*
drh4eded602013-12-20 15:59:20 +00001083** Compute a string for the "comment" field of a VDBE opcode listing.
1084**
1085** The Synopsis: field in comments in the vdbe.c source file gets converted
1086** to an extra string that is appended to the sqlite3OpcodeName(). In the
1087** absence of other comments, this synopsis becomes the comment on the opcode.
1088** Some translation occurs:
1089**
1090** "PX" -> "r[X]"
1091** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
1092** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
1093** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
drh81316f82013-10-29 20:40:47 +00001094*/
drhf63552b2013-10-30 00:25:03 +00001095static int displayComment(
1096 const Op *pOp, /* The opcode to be commented */
1097 const char *zP4, /* Previously obtained value for P4 */
1098 char *zTemp, /* Write result here */
1099 int nTemp /* Space available in zTemp[] */
1100){
drh81316f82013-10-29 20:40:47 +00001101 const char *zOpName;
1102 const char *zSynopsis;
1103 int nOpName;
1104 int ii, jj;
1105 zOpName = sqlite3OpcodeName(pOp->opcode);
1106 nOpName = sqlite3Strlen30(zOpName);
1107 if( zOpName[nOpName+1] ){
1108 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +00001109 char c;
drh81316f82013-10-29 20:40:47 +00001110 zSynopsis = zOpName += nOpName + 1;
drhf63552b2013-10-30 00:25:03 +00001111 for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
1112 if( c=='P' ){
1113 c = zSynopsis[++ii];
1114 if( c=='4' ){
1115 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
1116 }else if( c=='X' ){
1117 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
1118 seenCom = 1;
drh81316f82013-10-29 20:40:47 +00001119 }else{
drhf63552b2013-10-30 00:25:03 +00001120 int v1 = translateP(c, pOp);
1121 int v2;
1122 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
1123 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
1124 ii += 3;
1125 jj += sqlite3Strlen30(zTemp+jj);
1126 v2 = translateP(zSynopsis[ii], pOp);
drh4eded602013-12-20 15:59:20 +00001127 if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
1128 ii += 2;
1129 v2++;
1130 }
1131 if( v2>1 ){
1132 sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
1133 }
drhf63552b2013-10-30 00:25:03 +00001134 }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
1135 ii += 4;
1136 }
drh81316f82013-10-29 20:40:47 +00001137 }
1138 jj += sqlite3Strlen30(zTemp+jj);
1139 }else{
drhf63552b2013-10-30 00:25:03 +00001140 zTemp[jj++] = c;
drh81316f82013-10-29 20:40:47 +00001141 }
1142 }
1143 if( !seenCom && jj<nTemp-5 && pOp->zComment ){
1144 sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
1145 jj += sqlite3Strlen30(zTemp+jj);
1146 }
1147 if( jj<nTemp ) zTemp[jj] = 0;
1148 }else if( pOp->zComment ){
1149 sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
1150 jj = sqlite3Strlen30(zTemp);
1151 }else{
1152 zTemp[0] = 0;
1153 jj = 0;
1154 }
1155 return jj;
1156}
1157#endif /* SQLITE_DEBUG */
1158
drhf7e36902015-08-13 21:32:41 +00001159#if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
1160/*
1161** Translate the P4.pExpr value for an OP_CursorHint opcode into text
1162** that can be displayed in the P4 column of EXPLAIN output.
1163*/
drh5f4a6862016-01-30 12:50:25 +00001164static void displayP4Expr(StrAccum *p, Expr *pExpr){
drha67a3162015-08-15 00:51:23 +00001165 const char *zOp = 0;
drhf7e36902015-08-13 21:32:41 +00001166 switch( pExpr->op ){
1167 case TK_STRING:
drh5f4a6862016-01-30 12:50:25 +00001168 sqlite3XPrintf(p, "%Q", pExpr->u.zToken);
drhf7e36902015-08-13 21:32:41 +00001169 break;
drhf7e36902015-08-13 21:32:41 +00001170 case TK_INTEGER:
drh5f4a6862016-01-30 12:50:25 +00001171 sqlite3XPrintf(p, "%d", pExpr->u.iValue);
drhf7e36902015-08-13 21:32:41 +00001172 break;
drhf7e36902015-08-13 21:32:41 +00001173 case TK_NULL:
drh5f4a6862016-01-30 12:50:25 +00001174 sqlite3XPrintf(p, "NULL");
drhf7e36902015-08-13 21:32:41 +00001175 break;
drhf7e36902015-08-13 21:32:41 +00001176 case TK_REGISTER: {
drh5f4a6862016-01-30 12:50:25 +00001177 sqlite3XPrintf(p, "r[%d]", pExpr->iTable);
drhf7e36902015-08-13 21:32:41 +00001178 break;
1179 }
drhf7e36902015-08-13 21:32:41 +00001180 case TK_COLUMN: {
drhfe663522015-08-14 01:03:21 +00001181 if( pExpr->iColumn<0 ){
drh5f4a6862016-01-30 12:50:25 +00001182 sqlite3XPrintf(p, "rowid");
drhfe663522015-08-14 01:03:21 +00001183 }else{
drh5f4a6862016-01-30 12:50:25 +00001184 sqlite3XPrintf(p, "c%d", (int)pExpr->iColumn);
drhfe663522015-08-14 01:03:21 +00001185 }
drhf7e36902015-08-13 21:32:41 +00001186 break;
1187 }
drha67a3162015-08-15 00:51:23 +00001188 case TK_LT: zOp = "LT"; break;
1189 case TK_LE: zOp = "LE"; break;
1190 case TK_GT: zOp = "GT"; break;
1191 case TK_GE: zOp = "GE"; break;
1192 case TK_NE: zOp = "NE"; break;
1193 case TK_EQ: zOp = "EQ"; break;
1194 case TK_IS: zOp = "IS"; break;
1195 case TK_ISNOT: zOp = "ISNOT"; break;
1196 case TK_AND: zOp = "AND"; break;
1197 case TK_OR: zOp = "OR"; break;
1198 case TK_PLUS: zOp = "ADD"; break;
1199 case TK_STAR: zOp = "MUL"; break;
1200 case TK_MINUS: zOp = "SUB"; break;
1201 case TK_REM: zOp = "REM"; break;
1202 case TK_BITAND: zOp = "BITAND"; break;
1203 case TK_BITOR: zOp = "BITOR"; break;
1204 case TK_SLASH: zOp = "DIV"; break;
1205 case TK_LSHIFT: zOp = "LSHIFT"; break;
1206 case TK_RSHIFT: zOp = "RSHIFT"; break;
1207 case TK_CONCAT: zOp = "CONCAT"; break;
1208 case TK_UMINUS: zOp = "MINUS"; break;
1209 case TK_UPLUS: zOp = "PLUS"; break;
1210 case TK_BITNOT: zOp = "BITNOT"; break;
1211 case TK_NOT: zOp = "NOT"; break;
1212 case TK_ISNULL: zOp = "ISNULL"; break;
1213 case TK_NOTNULL: zOp = "NOTNULL"; break;
drh81316f82013-10-29 20:40:47 +00001214
drhf7e36902015-08-13 21:32:41 +00001215 default:
drh5f4a6862016-01-30 12:50:25 +00001216 sqlite3XPrintf(p, "%s", "expr");
drhf7e36902015-08-13 21:32:41 +00001217 break;
1218 }
1219
drha67a3162015-08-15 00:51:23 +00001220 if( zOp ){
drh5f4a6862016-01-30 12:50:25 +00001221 sqlite3XPrintf(p, "%s(", zOp);
1222 displayP4Expr(p, pExpr->pLeft);
1223 if( pExpr->pRight ){
1224 sqlite3StrAccumAppend(p, ",", 1);
1225 displayP4Expr(p, pExpr->pRight);
drha67a3162015-08-15 00:51:23 +00001226 }
drh5f4a6862016-01-30 12:50:25 +00001227 sqlite3StrAccumAppend(p, ")", 1);
drhf7e36902015-08-13 21:32:41 +00001228 }
drhf7e36902015-08-13 21:32:41 +00001229}
1230#endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
1231
1232
1233#if VDBE_DISPLAY_P4
drh9a324642003-09-06 20:12:01 +00001234/*
drh66a51672008-01-03 00:01:23 +00001235** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +00001236** Use zTemp for any required temporary buffer space.
1237*/
drh66a51672008-01-03 00:01:23 +00001238static char *displayP4(Op *pOp, char *zTemp, int nTemp){
1239 char *zP4 = zTemp;
drh5f4a6862016-01-30 12:50:25 +00001240 StrAccum x;
drhd3d39e92004-05-20 22:16:29 +00001241 assert( nTemp>=20 );
drh5f4a6862016-01-30 12:50:25 +00001242 sqlite3StrAccumInit(&x, 0, zTemp, nTemp, 0);
drh66a51672008-01-03 00:01:23 +00001243 switch( pOp->p4type ){
1244 case P4_KEYINFO: {
drh5f4a6862016-01-30 12:50:25 +00001245 int j;
danielk19772dca4ac2008-01-03 11:50:29 +00001246 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
drhe1a022e2012-09-17 17:16:53 +00001247 assert( pKeyInfo->aSortOrder!=0 );
drh5f4a6862016-01-30 12:50:25 +00001248 sqlite3XPrintf(&x, "k(%d", pKeyInfo->nField);
drhd3d39e92004-05-20 22:16:29 +00001249 for(j=0; j<pKeyInfo->nField; j++){
1250 CollSeq *pColl = pKeyInfo->aColl[j];
drh5f4a6862016-01-30 12:50:25 +00001251 const char *zColl = pColl ? pColl->zName : "";
1252 if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
1253 sqlite3XPrintf(&x, ",%s%s", pKeyInfo->aSortOrder[j] ? "-" : "", zColl);
drhd3d39e92004-05-20 22:16:29 +00001254 }
drh5f4a6862016-01-30 12:50:25 +00001255 sqlite3StrAccumAppend(&x, ")", 1);
drhd3d39e92004-05-20 22:16:29 +00001256 break;
1257 }
drh28935362013-12-07 20:39:19 +00001258#ifdef SQLITE_ENABLE_CURSOR_HINTS
1259 case P4_EXPR: {
drh5f4a6862016-01-30 12:50:25 +00001260 displayP4Expr(&x, pOp->p4.pExpr);
drh28935362013-12-07 20:39:19 +00001261 break;
1262 }
1263#endif
drh66a51672008-01-03 00:01:23 +00001264 case P4_COLLSEQ: {
danielk19772dca4ac2008-01-03 11:50:29 +00001265 CollSeq *pColl = pOp->p4.pColl;
drh5f4a6862016-01-30 12:50:25 +00001266 sqlite3XPrintf(&x, "(%.20s)", pColl->zName);
drhd3d39e92004-05-20 22:16:29 +00001267 break;
1268 }
drh66a51672008-01-03 00:01:23 +00001269 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +00001270 FuncDef *pDef = pOp->p4.pFunc;
drh5f4a6862016-01-30 12:50:25 +00001271 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +00001272 break;
1273 }
drhe2d9e7c2015-06-26 18:47:53 +00001274#ifdef SQLITE_DEBUG
drh9c7c9132015-06-26 18:16:52 +00001275 case P4_FUNCCTX: {
1276 FuncDef *pDef = pOp->p4.pCtx->pFunc;
drh5f4a6862016-01-30 12:50:25 +00001277 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drh9c7c9132015-06-26 18:16:52 +00001278 break;
1279 }
drhe2d9e7c2015-06-26 18:47:53 +00001280#endif
drh66a51672008-01-03 00:01:23 +00001281 case P4_INT64: {
drh5f4a6862016-01-30 12:50:25 +00001282 sqlite3XPrintf(&x, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +00001283 break;
1284 }
drh66a51672008-01-03 00:01:23 +00001285 case P4_INT32: {
drh5f4a6862016-01-30 12:50:25 +00001286 sqlite3XPrintf(&x, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +00001287 break;
1288 }
drh66a51672008-01-03 00:01:23 +00001289 case P4_REAL: {
drh5f4a6862016-01-30 12:50:25 +00001290 sqlite3XPrintf(&x, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +00001291 break;
1292 }
drh66a51672008-01-03 00:01:23 +00001293 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +00001294 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001295 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001296 zP4 = pMem->z;
drhd4e70eb2008-01-02 00:34:36 +00001297 }else if( pMem->flags & MEM_Int ){
drh5f4a6862016-01-30 12:50:25 +00001298 sqlite3XPrintf(&x, "%lld", pMem->u.i);
drhd4e70eb2008-01-02 00:34:36 +00001299 }else if( pMem->flags & MEM_Real ){
drh5f4a6862016-01-30 12:50:25 +00001300 sqlite3XPrintf(&x, "%.16g", pMem->u.r);
drhb8475df2011-12-09 16:21:19 +00001301 }else if( pMem->flags & MEM_Null ){
drh5f4a6862016-01-30 12:50:25 +00001302 zP4 = "NULL";
drh56016892009-08-25 14:24:04 +00001303 }else{
1304 assert( pMem->flags & MEM_Blob );
1305 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001306 }
drh598f1342007-10-23 15:39:45 +00001307 break;
1308 }
drha967e882006-06-13 01:04:52 +00001309#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001310 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001311 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh5f4a6862016-01-30 12:50:25 +00001312 sqlite3XPrintf(&x, "vtab:%p", pVtab);
drha967e882006-06-13 01:04:52 +00001313 break;
1314 }
1315#endif
drh0acb7e42008-06-25 00:12:41 +00001316 case P4_INTARRAY: {
drh5f4a6862016-01-30 12:50:25 +00001317 int i;
drhb1702022016-01-30 00:45:18 +00001318 int *ai = pOp->p4.ai;
1319 int n = ai[0]; /* The first element of an INTARRAY is always the
1320 ** count of the number of elements to follow */
drh5f4a6862016-01-30 12:50:25 +00001321 for(i=1; i<n; i++){
1322 sqlite3XPrintf(&x, ",%d", ai[i]);
1323 }
drhb1702022016-01-30 00:45:18 +00001324 zTemp[0] = '[';
drh5f4a6862016-01-30 12:50:25 +00001325 sqlite3StrAccumAppend(&x, "]", 1);
drh0acb7e42008-06-25 00:12:41 +00001326 break;
1327 }
dan165921a2009-08-28 18:53:45 +00001328 case P4_SUBPROGRAM: {
drh5f4a6862016-01-30 12:50:25 +00001329 sqlite3XPrintf(&x, "program");
dan165921a2009-08-28 18:53:45 +00001330 break;
1331 }
drh4a6f3aa2011-08-28 00:19:26 +00001332 case P4_ADVANCE: {
1333 zTemp[0] = 0;
1334 break;
1335 }
drh74c33022016-03-30 12:56:55 +00001336 case P4_TABLE: {
1337 sqlite3XPrintf(&x, "%s", pOp->p4.pTab->zName);
1338 break;
1339 }
drhd3d39e92004-05-20 22:16:29 +00001340 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001341 zP4 = pOp->p4.z;
drh949f9cd2008-01-12 21:35:57 +00001342 if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +00001343 zP4 = zTemp;
drhd4e70eb2008-01-02 00:34:36 +00001344 zTemp[0] = 0;
drhd3d39e92004-05-20 22:16:29 +00001345 }
1346 }
1347 }
drh5f4a6862016-01-30 12:50:25 +00001348 sqlite3StrAccumFinish(&x);
drh66a51672008-01-03 00:01:23 +00001349 assert( zP4!=0 );
drh66a51672008-01-03 00:01:23 +00001350 return zP4;
drhd3d39e92004-05-20 22:16:29 +00001351}
drhf7e36902015-08-13 21:32:41 +00001352#endif /* VDBE_DISPLAY_P4 */
drhd3d39e92004-05-20 22:16:29 +00001353
drh900b31e2007-08-28 02:27:51 +00001354/*
drhd0679ed2007-08-28 22:24:34 +00001355** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001356**
drhbdaec522011-04-04 00:14:43 +00001357** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001358** attached databases that will be use. A mask of these databases
1359** is maintained in p->btreeMask. The p->lockMask value is the subset of
1360** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001361*/
drhfb982642007-08-30 01:19:59 +00001362void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001363 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001364 assert( i<(int)sizeof(p->btreeMask)*8 );
drha7ab6d82014-07-21 15:44:39 +00001365 DbMaskSet(p->btreeMask, i);
drhdc5b0472011-04-06 22:05:53 +00001366 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
drha7ab6d82014-07-21 15:44:39 +00001367 DbMaskSet(p->lockMask, i);
drhdc5b0472011-04-06 22:05:53 +00001368 }
drh900b31e2007-08-28 02:27:51 +00001369}
1370
dan20d876f2016-01-07 16:06:22 +00001371#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhbdaec522011-04-04 00:14:43 +00001372/*
1373** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1374** this routine obtains the mutex associated with each BtShared structure
1375** that may be accessed by the VM passed as an argument. In doing so it also
1376** sets the BtShared.db member of each of the BtShared structures, ensuring
1377** that the correct busy-handler callback is invoked if required.
1378**
1379** If SQLite is not threadsafe but does support shared-cache mode, then
1380** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1381** of all of BtShared structures accessible via the database handle
1382** associated with the VM.
1383**
1384** If SQLite is not threadsafe and does not support shared-cache mode, this
1385** function is a no-op.
1386**
1387** The p->btreeMask field is a bitmask of all btrees that the prepared
1388** statement p will ever use. Let N be the number of bits in p->btreeMask
1389** corresponding to btrees that use shared cache. Then the runtime of
1390** this routine is N*N. But as N is rarely more than 1, this should not
1391** be a problem.
1392*/
1393void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001394 int i;
drhdc5b0472011-04-06 22:05:53 +00001395 sqlite3 *db;
1396 Db *aDb;
1397 int nDb;
drha7ab6d82014-07-21 15:44:39 +00001398 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
drhdc5b0472011-04-06 22:05:53 +00001399 db = p->db;
1400 aDb = db->aDb;
1401 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001402 for(i=0; i<nDb; i++){
1403 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001404 sqlite3BtreeEnter(aDb[i].pBt);
1405 }
1406 }
drhbdaec522011-04-04 00:14:43 +00001407}
drhe54e0512011-04-05 17:31:56 +00001408#endif
drhbdaec522011-04-04 00:14:43 +00001409
drhe54e0512011-04-05 17:31:56 +00001410#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001411/*
1412** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1413*/
drhf1aabd62015-06-17 01:31:28 +00001414static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001415 int i;
drhdc5b0472011-04-06 22:05:53 +00001416 sqlite3 *db;
1417 Db *aDb;
1418 int nDb;
drhdc5b0472011-04-06 22:05:53 +00001419 db = p->db;
1420 aDb = db->aDb;
1421 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001422 for(i=0; i<nDb; i++){
1423 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001424 sqlite3BtreeLeave(aDb[i].pBt);
1425 }
1426 }
drhbdaec522011-04-04 00:14:43 +00001427}
drhf1aabd62015-06-17 01:31:28 +00001428void sqlite3VdbeLeave(Vdbe *p){
1429 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
1430 vdbeLeave(p);
1431}
drhbdaec522011-04-04 00:14:43 +00001432#endif
drhd3d39e92004-05-20 22:16:29 +00001433
danielk19778b60e0f2005-01-12 09:10:39 +00001434#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00001435/*
1436** Print a single opcode. This routine is used for debugging only.
1437*/
danielk19774adee202004-05-08 08:23:19 +00001438void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
drh66a51672008-01-03 00:01:23 +00001439 char *zP4;
drhd3d39e92004-05-20 22:16:29 +00001440 char zPtr[50];
drh81316f82013-10-29 20:40:47 +00001441 char zCom[100];
drh26198bb2013-10-31 11:15:09 +00001442 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00001443 if( pOut==0 ) pOut = stdout;
drh66a51672008-01-03 00:01:23 +00001444 zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
drhc7379ce2013-10-30 02:28:23 +00001445#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh81316f82013-10-29 20:40:47 +00001446 displayComment(pOp, zP4, zCom, sizeof(zCom));
1447#else
drh2926f962014-02-17 01:13:28 +00001448 zCom[0] = 0;
drh81316f82013-10-29 20:40:47 +00001449#endif
drh4eded602013-12-20 15:59:20 +00001450 /* NB: The sqlite3OpcodeName() function is implemented by code created
1451 ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
1452 ** information from the vdbe.c source text */
danielk197711641c12008-01-03 08:18:30 +00001453 fprintf(pOut, zFormat1, pc,
drh1db639c2008-01-17 02:36:28 +00001454 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
drh81316f82013-10-29 20:40:47 +00001455 zCom
drh1db639c2008-01-17 02:36:28 +00001456 );
drh9a324642003-09-06 20:12:01 +00001457 fflush(pOut);
1458}
1459#endif
1460
1461/*
drh76ff3a02004-09-24 22:32:30 +00001462** Release an array of N Mem elements
1463*/
drhc890fec2008-08-01 20:10:08 +00001464static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00001465 if( p && N ){
drh069c23c2014-09-19 16:13:12 +00001466 Mem *pEnd = &p[N];
danielk1977a7a8e142008-02-13 18:25:27 +00001467 sqlite3 *db = p->db;
dand46def72010-07-24 11:28:28 +00001468 if( db->pnBytesFreed ){
drh069c23c2014-09-19 16:13:12 +00001469 do{
drh17bcb102014-09-18 21:25:33 +00001470 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh069c23c2014-09-19 16:13:12 +00001471 }while( (++p)<pEnd );
drhc176c272010-07-26 13:57:59 +00001472 return;
1473 }
drh069c23c2014-09-19 16:13:12 +00001474 do{
danielk1977e972e032008-09-19 18:32:26 +00001475 assert( (&p[1])==pEnd || p[0].db==p[1].db );
drh75fd0542014-03-01 16:24:44 +00001476 assert( sqlite3VdbeCheckMemInvariants(p) );
danielk1977e972e032008-09-19 18:32:26 +00001477
1478 /* This block is really an inlined version of sqlite3VdbeMemRelease()
1479 ** that takes advantage of the fact that the memory cell value is
1480 ** being set to NULL after releasing any dynamic resources.
1481 **
1482 ** The justification for duplicating code is that according to
1483 ** callgrind, this causes a certain test case to hit the CPU 4.7
1484 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
1485 ** sqlite3MemRelease() were called from here. With -O2, this jumps
1486 ** to 6.6 percent. The test case is inserting 1000 rows into a table
1487 ** with no indexes using a single prepared INSERT statement, bind()
1488 ** and reset(). Inserts are grouped into a transaction.
1489 */
drhb6e8fd12014-03-06 01:56:33 +00001490 testcase( p->flags & MEM_Agg );
1491 testcase( p->flags & MEM_Dyn );
1492 testcase( p->flags & MEM_Frame );
1493 testcase( p->flags & MEM_RowSet );
dan165921a2009-08-28 18:53:45 +00001494 if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
danielk1977e972e032008-09-19 18:32:26 +00001495 sqlite3VdbeMemRelease(p);
drh17bcb102014-09-18 21:25:33 +00001496 }else if( p->szMalloc ){
danielk1977e972e032008-09-19 18:32:26 +00001497 sqlite3DbFree(db, p->zMalloc);
drh17bcb102014-09-18 21:25:33 +00001498 p->szMalloc = 0;
danielk1977e972e032008-09-19 18:32:26 +00001499 }
1500
drha5750cf2014-02-07 13:20:31 +00001501 p->flags = MEM_Undefined;
drh069c23c2014-09-19 16:13:12 +00001502 }while( (++p)<pEnd );
drh76ff3a02004-09-24 22:32:30 +00001503 }
1504}
1505
dan65a7cd12009-09-01 12:16:01 +00001506/*
1507** Delete a VdbeFrame object and its contents. VdbeFrame objects are
1508** allocated by the OP_Program opcode in sqlite3VdbeExec().
1509*/
dan165921a2009-08-28 18:53:45 +00001510void sqlite3VdbeFrameDelete(VdbeFrame *p){
1511 int i;
1512 Mem *aMem = VdbeFrameMem(p);
1513 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
1514 for(i=0; i<p->nChildCsr; i++){
1515 sqlite3VdbeFreeCursor(p->v, apCsr[i]);
1516 }
1517 releaseMemArray(aMem, p->nChildMem);
drhb9626cf2016-02-22 16:04:31 +00001518 sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
dan165921a2009-08-28 18:53:45 +00001519 sqlite3DbFree(p->v->db, p);
1520}
1521
drhb7f91642004-10-31 02:22:47 +00001522#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00001523/*
drh9a324642003-09-06 20:12:01 +00001524** Give a listing of the program in the virtual machine.
1525**
danielk19774adee202004-05-08 08:23:19 +00001526** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00001527** running the code, it invokes the callback once for each instruction.
1528** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00001529**
1530** When p->explain==1, each instruction is listed. When
1531** p->explain==2, only OP_Explain instructions are listed and these
1532** are shown in a different format. p->explain==2 is used to implement
1533** EXPLAIN QUERY PLAN.
drh5cfa5842009-12-31 20:35:08 +00001534**
1535** When p->explain==1, first the main program is listed, then each of
1536** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00001537*/
danielk19774adee202004-05-08 08:23:19 +00001538int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00001539 Vdbe *p /* The VDBE */
1540){
drh5cfa5842009-12-31 20:35:08 +00001541 int nRow; /* Stop when row count reaches this */
dan165921a2009-08-28 18:53:45 +00001542 int nSub = 0; /* Number of sub-vdbes seen so far */
1543 SubProgram **apSub = 0; /* Array of sub-vdbes */
drh5cfa5842009-12-31 20:35:08 +00001544 Mem *pSub = 0; /* Memory cell hold array of subprogs */
1545 sqlite3 *db = p->db; /* The database connection */
1546 int i; /* Loop counter */
1547 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00001548 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh9a324642003-09-06 20:12:01 +00001549
drh9a324642003-09-06 20:12:01 +00001550 assert( p->explain );
drh5f82e3c2009-07-06 00:44:08 +00001551 assert( p->magic==VDBE_MAGIC_RUN );
danielk19776c359f02008-11-21 16:58:03 +00001552 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00001553
drh9cbf3422008-01-17 16:22:13 +00001554 /* Even though this opcode does not use dynamic strings for
1555 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00001556 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00001557 */
dan165921a2009-08-28 18:53:45 +00001558 releaseMemArray(pMem, 8);
drh9734e6e2011-10-07 18:24:25 +00001559 p->pResultSet = 0;
danielk197718f41892004-05-22 07:27:46 +00001560
mistachkinfad30392016-02-13 23:43:46 +00001561 if( p->rc==SQLITE_NOMEM_BKPT ){
danielk19776c359f02008-11-21 16:58:03 +00001562 /* This happens if a malloc() inside a call to sqlite3_column_text() or
1563 ** sqlite3_column_text16() failed. */
drh4a642b62016-02-05 01:55:27 +00001564 sqlite3OomFault(db);
danielk19776c359f02008-11-21 16:58:03 +00001565 return SQLITE_ERROR;
1566 }
1567
drh5cfa5842009-12-31 20:35:08 +00001568 /* When the number of output rows reaches nRow, that means the
1569 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
1570 ** nRow is the sum of the number of rows in the main program, plus
1571 ** the sum of the number of rows in all trigger subprograms encountered
1572 ** so far. The nRow value will increase as new trigger subprograms are
1573 ** encountered, but p->pc will eventually catch up to nRow.
1574 */
dan165921a2009-08-28 18:53:45 +00001575 nRow = p->nOp;
1576 if( p->explain==1 ){
drh5cfa5842009-12-31 20:35:08 +00001577 /* The first 8 memory cells are used for the result set. So we will
1578 ** commandeer the 9th cell to use as storage for an array of pointers
1579 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
1580 ** cells. */
1581 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00001582 pSub = &p->aMem[9];
1583 if( pSub->flags&MEM_Blob ){
drh5cfa5842009-12-31 20:35:08 +00001584 /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
1585 ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
dan165921a2009-08-28 18:53:45 +00001586 nSub = pSub->n/sizeof(Vdbe*);
1587 apSub = (SubProgram **)pSub->z;
1588 }
1589 for(i=0; i<nSub; i++){
1590 nRow += apSub[i]->nOp;
1591 }
1592 }
1593
drhecc92422005-09-10 16:46:12 +00001594 do{
1595 i = p->pc++;
dan165921a2009-08-28 18:53:45 +00001596 }while( i<nRow && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
1597 if( i>=nRow ){
drh826fb5a2004-02-14 23:59:57 +00001598 p->rc = SQLITE_OK;
1599 rc = SQLITE_DONE;
drh881feaa2006-07-26 01:39:30 +00001600 }else if( db->u1.isInterrupted ){
drhc5cdca62005-01-11 16:54:14 +00001601 p->rc = SQLITE_INTERRUPT;
drh826fb5a2004-02-14 23:59:57 +00001602 rc = SQLITE_ERROR;
drh22c17b82015-05-15 04:13:15 +00001603 sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
drh826fb5a2004-02-14 23:59:57 +00001604 }else{
drh81316f82013-10-29 20:40:47 +00001605 char *zP4;
dan165921a2009-08-28 18:53:45 +00001606 Op *pOp;
1607 if( i<p->nOp ){
drh5cfa5842009-12-31 20:35:08 +00001608 /* The output line number is small enough that we are still in the
1609 ** main program. */
dan165921a2009-08-28 18:53:45 +00001610 pOp = &p->aOp[i];
1611 }else{
drh5cfa5842009-12-31 20:35:08 +00001612 /* We are currently listing subprograms. Figure out which one and
1613 ** pick up the appropriate opcode. */
dan165921a2009-08-28 18:53:45 +00001614 int j;
1615 i -= p->nOp;
1616 for(j=0; i>=apSub[j]->nOp; j++){
1617 i -= apSub[j]->nOp;
1618 }
1619 pOp = &apSub[j]->aOp[i];
1620 }
danielk19770d78bae2008-01-03 07:09:48 +00001621 if( p->explain==1 ){
1622 pMem->flags = MEM_Int;
danielk19770d78bae2008-01-03 07:09:48 +00001623 pMem->u.i = i; /* Program counter */
1624 pMem++;
1625
1626 pMem->flags = MEM_Static|MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001627 pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
danielk19770d78bae2008-01-03 07:09:48 +00001628 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001629 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +00001630 pMem->enc = SQLITE_UTF8;
1631 pMem++;
dan165921a2009-08-28 18:53:45 +00001632
drh5cfa5842009-12-31 20:35:08 +00001633 /* When an OP_Program opcode is encounter (the only opcode that has
1634 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
1635 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
1636 ** has not already been seen.
1637 */
dan165921a2009-08-28 18:53:45 +00001638 if( pOp->p4type==P4_SUBPROGRAM ){
1639 int nByte = (nSub+1)*sizeof(SubProgram*);
1640 int j;
1641 for(j=0; j<nSub; j++){
1642 if( apSub[j]==pOp->p4.pProgram ) break;
1643 }
dan2b9ee772012-03-31 09:59:44 +00001644 if( j==nSub && SQLITE_OK==sqlite3VdbeMemGrow(pSub, nByte, nSub!=0) ){
dan165921a2009-08-28 18:53:45 +00001645 apSub = (SubProgram **)pSub->z;
1646 apSub[nSub++] = pOp->p4.pProgram;
1647 pSub->flags |= MEM_Blob;
1648 pSub->n = nSub*sizeof(SubProgram*);
1649 }
1650 }
danielk19770d78bae2008-01-03 07:09:48 +00001651 }
drheb2e1762004-05-27 01:53:56 +00001652
1653 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001654 pMem->u.i = pOp->p1; /* P1 */
drheb2e1762004-05-27 01:53:56 +00001655 pMem++;
1656
1657 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001658 pMem->u.i = pOp->p2; /* P2 */
drheb2e1762004-05-27 01:53:56 +00001659 pMem++;
1660
dan2ce22452010-11-08 19:01:16 +00001661 pMem->flags = MEM_Int;
1662 pMem->u.i = pOp->p3; /* P3 */
dan2ce22452010-11-08 19:01:16 +00001663 pMem++;
danielk19770d78bae2008-01-03 07:09:48 +00001664
drh2f2b0272015-08-14 18:50:04 +00001665 if( sqlite3VdbeMemClearAndResize(pMem, 100) ){ /* P4 */
danielk1977357864e2009-03-25 15:43:08 +00001666 assert( p->db->mallocFailed );
1667 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001668 }
drhc91b2fd2014-03-01 18:13:23 +00001669 pMem->flags = MEM_Str|MEM_Term;
drh2f2b0272015-08-14 18:50:04 +00001670 zP4 = displayP4(pOp, pMem->z, pMem->szMalloc);
drh81316f82013-10-29 20:40:47 +00001671 if( zP4!=pMem->z ){
1672 sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
danielk1977a7a8e142008-02-13 18:25:27 +00001673 }else{
1674 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001675 pMem->n = sqlite3Strlen30(pMem->z);
danielk1977a7a8e142008-02-13 18:25:27 +00001676 pMem->enc = SQLITE_UTF8;
1677 }
danielk19770d78bae2008-01-03 07:09:48 +00001678 pMem++;
drheb2e1762004-05-27 01:53:56 +00001679
danielk19770d78bae2008-01-03 07:09:48 +00001680 if( p->explain==1 ){
drh322f2852014-09-19 00:43:39 +00001681 if( sqlite3VdbeMemClearAndResize(pMem, 4) ){
danielk1977357864e2009-03-25 15:43:08 +00001682 assert( p->db->mallocFailed );
1683 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001684 }
drhc91b2fd2014-03-01 18:13:23 +00001685 pMem->flags = MEM_Str|MEM_Term;
drh85e5f0d2008-02-19 18:28:13 +00001686 pMem->n = 2;
1687 sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
danielk19770d78bae2008-01-03 07:09:48 +00001688 pMem->enc = SQLITE_UTF8;
1689 pMem++;
1690
drhc7379ce2013-10-30 02:28:23 +00001691#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh322f2852014-09-19 00:43:39 +00001692 if( sqlite3VdbeMemClearAndResize(pMem, 500) ){
drh81316f82013-10-29 20:40:47 +00001693 assert( p->db->mallocFailed );
1694 return SQLITE_ERROR;
drh52391cb2008-02-14 23:44:13 +00001695 }
drhc91b2fd2014-03-01 18:13:23 +00001696 pMem->flags = MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001697 pMem->n = displayComment(pOp, zP4, pMem->z, 500);
drh81316f82013-10-29 20:40:47 +00001698 pMem->enc = SQLITE_UTF8;
1699#else
1700 pMem->flags = MEM_Null; /* Comment */
drh81316f82013-10-29 20:40:47 +00001701#endif
danielk19770d78bae2008-01-03 07:09:48 +00001702 }
1703
dan2ce22452010-11-08 19:01:16 +00001704 p->nResColumn = 8 - 4*(p->explain-1);
drh9734e6e2011-10-07 18:24:25 +00001705 p->pResultSet = &p->aMem[1];
drh826fb5a2004-02-14 23:59:57 +00001706 p->rc = SQLITE_OK;
1707 rc = SQLITE_ROW;
drh9a324642003-09-06 20:12:01 +00001708 }
drh826fb5a2004-02-14 23:59:57 +00001709 return rc;
drh9a324642003-09-06 20:12:01 +00001710}
drhb7f91642004-10-31 02:22:47 +00001711#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00001712
drh7c4ac0c2007-04-05 11:25:58 +00001713#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00001714/*
drh3f7d4e42004-07-24 14:35:58 +00001715** Print the SQL that was used to generate a VDBE program.
1716*/
1717void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00001718 const char *z = 0;
1719 if( p->zSql ){
1720 z = p->zSql;
1721 }else if( p->nOp>=1 ){
1722 const VdbeOp *pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001723 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh84e55a82013-11-13 17:58:23 +00001724 z = pOp->p4.z;
1725 while( sqlite3Isspace(*z) ) z++;
1726 }
drh3f7d4e42004-07-24 14:35:58 +00001727 }
drh84e55a82013-11-13 17:58:23 +00001728 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00001729}
drh7c4ac0c2007-04-05 11:25:58 +00001730#endif
drh3f7d4e42004-07-24 14:35:58 +00001731
drh602c2372007-03-01 00:29:13 +00001732#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
1733/*
1734** Print an IOTRACE message showing SQL content.
1735*/
1736void sqlite3VdbeIOTraceSql(Vdbe *p){
1737 int nOp = p->nOp;
1738 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00001739 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00001740 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00001741 pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001742 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00001743 int i, j;
drh00a18e42007-08-13 11:10:34 +00001744 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00001745 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00001746 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00001747 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00001748 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00001749 if( z[i-1]!=' ' ){
1750 z[j++] = ' ';
1751 }
1752 }else{
1753 z[j++] = z[i];
1754 }
1755 }
1756 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00001757 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00001758 }
1759}
1760#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
1761
drha7dc4a32016-01-25 02:15:02 +00001762/* An instance of this object describes bulk memory available for use
1763** by subcomponents of a prepared statement. Space is allocated out
1764** of a ReusableSpace object by the allocSpace() routine below.
1765*/
1766struct ReusableSpace {
1767 u8 *pSpace; /* Available memory */
1768 int nFree; /* Bytes of available memory */
1769 int nNeeded; /* Total bytes that could not be allocated */
1770};
1771
1772/* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
1773** from the ReusableSpace object. Return a pointer to the allocated
1774** memory on success. If insufficient memory is available in the
1775** ReusableSpace object, increase the ReusableSpace.nNeeded
1776** value by the amount needed and return NULL.
drh4800b2e2009-12-08 15:35:22 +00001777**
drha7dc4a32016-01-25 02:15:02 +00001778** If pBuf is not initially NULL, that means that the memory has already
1779** been allocated by a prior call to this routine, so just return a copy
1780** of pBuf and leave ReusableSpace unchanged.
drhb2771ce2009-02-20 01:28:59 +00001781**
drha7dc4a32016-01-25 02:15:02 +00001782** This allocator is employed to repurpose unused slots at the end of the
1783** opcode array of prepared state for other memory needs of the prepared
1784** statement.
drhb2771ce2009-02-20 01:28:59 +00001785*/
drh4800b2e2009-12-08 15:35:22 +00001786static void *allocSpace(
drha7dc4a32016-01-25 02:15:02 +00001787 struct ReusableSpace *p, /* Bulk memory available for allocation */
1788 void *pBuf, /* Pointer to a prior allocation */
1789 int nByte /* Bytes of memory needed */
drhb2771ce2009-02-20 01:28:59 +00001790){
drha7dc4a32016-01-25 02:15:02 +00001791 assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
drhd797a9b2015-12-07 16:43:44 +00001792 if( pBuf==0 ){
1793 nByte = ROUND8(nByte);
drha7dc4a32016-01-25 02:15:02 +00001794 if( nByte <= p->nFree ){
1795 p->nFree -= nByte;
1796 pBuf = &p->pSpace[p->nFree];
drhd797a9b2015-12-07 16:43:44 +00001797 }else{
drha7dc4a32016-01-25 02:15:02 +00001798 p->nNeeded += nByte;
drhd797a9b2015-12-07 16:43:44 +00001799 }
drhb2771ce2009-02-20 01:28:59 +00001800 }
drhd797a9b2015-12-07 16:43:44 +00001801 assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
drh4800b2e2009-12-08 15:35:22 +00001802 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00001803}
drh602c2372007-03-01 00:29:13 +00001804
drh3f7d4e42004-07-24 14:35:58 +00001805/*
drh124c0b42011-06-01 18:15:55 +00001806** Rewind the VDBE back to the beginning in preparation for
1807** running it.
drh9a324642003-09-06 20:12:01 +00001808*/
drh124c0b42011-06-01 18:15:55 +00001809void sqlite3VdbeRewind(Vdbe *p){
1810#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
1811 int i;
1812#endif
drh9a324642003-09-06 20:12:01 +00001813 assert( p!=0 );
drh9a324642003-09-06 20:12:01 +00001814 assert( p->magic==VDBE_MAGIC_INIT );
1815
drhc16a03b2004-09-15 13:38:10 +00001816 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00001817 */
drhc16a03b2004-09-15 13:38:10 +00001818 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00001819
danielk197700e13612008-11-17 19:18:54 +00001820 /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
danielk1977634f2982005-03-28 08:44:07 +00001821 p->magic = VDBE_MAGIC_RUN;
1822
drh124c0b42011-06-01 18:15:55 +00001823#ifdef SQLITE_DEBUG
drh9f6168b2016-03-19 23:32:58 +00001824 for(i=0; i<p->nMem; i++){
drh124c0b42011-06-01 18:15:55 +00001825 assert( p->aMem[i].db==p->db );
1826 }
1827#endif
1828 p->pc = -1;
1829 p->rc = SQLITE_OK;
1830 p->errorAction = OE_Abort;
drh124c0b42011-06-01 18:15:55 +00001831 p->nChange = 0;
1832 p->cacheCtr = 1;
1833 p->minWriteFileFormat = 255;
1834 p->iStatement = 0;
1835 p->nFkConstraint = 0;
1836#ifdef VDBE_PROFILE
1837 for(i=0; i<p->nOp; i++){
1838 p->aOp[i].cnt = 0;
1839 p->aOp[i].cycles = 0;
1840 }
1841#endif
1842}
1843
1844/*
1845** Prepare a virtual machine for execution for the first time after
1846** creating the virtual machine. This involves things such
drh7abda852014-09-19 16:02:06 +00001847** as allocating registers and initializing the program counter.
drh124c0b42011-06-01 18:15:55 +00001848** After the VDBE has be prepped, it can be executed by one or more
1849** calls to sqlite3VdbeExec().
1850**
peter.d.reid60ec9142014-09-06 16:39:46 +00001851** This function may be called exactly once on each virtual machine.
drh124c0b42011-06-01 18:15:55 +00001852** After this routine is called the VM has been "packaged" and is ready
peter.d.reid60ec9142014-09-06 16:39:46 +00001853** to run. After this routine is called, further calls to
drh124c0b42011-06-01 18:15:55 +00001854** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
1855** the Vdbe from the Parse object that helped generate it so that the
1856** the Vdbe becomes an independent entity and the Parse object can be
1857** destroyed.
1858**
1859** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
1860** to its initial state after it has been run.
1861*/
1862void sqlite3VdbeMakeReady(
1863 Vdbe *p, /* The VDBE */
1864 Parse *pParse /* Parsing context */
1865){
1866 sqlite3 *db; /* The database connection */
1867 int nVar; /* Number of parameters */
1868 int nMem; /* Number of VM memory registers */
1869 int nCursor; /* Number of cursors required */
1870 int nArg; /* Number of arguments in subprograms */
dan1d8cb212011-12-09 13:24:16 +00001871 int nOnce; /* Number of OP_Once instructions */
drh124c0b42011-06-01 18:15:55 +00001872 int n; /* Loop counter */
drha7dc4a32016-01-25 02:15:02 +00001873 struct ReusableSpace x; /* Reusable bulk memory */
drh124c0b42011-06-01 18:15:55 +00001874
1875 assert( p!=0 );
1876 assert( p->nOp>0 );
1877 assert( pParse!=0 );
1878 assert( p->magic==VDBE_MAGIC_INIT );
drh73d5b8f2013-12-23 19:09:07 +00001879 assert( pParse==p->pParse );
drh124c0b42011-06-01 18:15:55 +00001880 db = p->db;
1881 assert( db->mallocFailed==0 );
1882 nVar = pParse->nVar;
1883 nMem = pParse->nMem;
1884 nCursor = pParse->nTab;
1885 nArg = pParse->nMaxArg;
dan1d8cb212011-12-09 13:24:16 +00001886 nOnce = pParse->nOnce;
drh20e226d2012-01-01 13:58:53 +00001887 if( nOnce==0 ) nOnce = 1; /* Ensure at least one byte in p->aOnceFlag[] */
drh124c0b42011-06-01 18:15:55 +00001888
drh3cdce922016-03-21 00:30:40 +00001889 /* Each cursor uses a memory cell. The first cursor (cursor 0) can
1890 ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
1891 ** space at the end of aMem[] for cursors 1 and greater.
danielk1977cd3e8f72008-03-25 09:47:35 +00001892 ** See also: allocateCursor().
1893 */
1894 nMem += nCursor;
drh9f6168b2016-03-19 23:32:58 +00001895 if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
danielk1977cd3e8f72008-03-25 09:47:35 +00001896
drha7dc4a32016-01-25 02:15:02 +00001897 /* Figure out how much reusable memory is available at the end of the
1898 ** opcode array. This extra memory will be reallocated for other elements
1899 ** of the prepared statement.
drh9a324642003-09-06 20:12:01 +00001900 */
drha7dc4a32016-01-25 02:15:02 +00001901 n = ROUND8(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
1902 x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
1903 assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
1904 x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
1905 assert( x.nFree>=0 );
1906 if( x.nFree>0 ){
1907 memset(x.pSpace, 0, x.nFree);
1908 assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
drh08169052016-01-05 03:39:25 +00001909 }
drh19875c82009-12-08 19:58:19 +00001910
drh124c0b42011-06-01 18:15:55 +00001911 resolveP2Values(p, &nArg);
1912 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
1913 if( pParse->explain && nMem<10 ){
1914 nMem = 10;
1915 }
drhaab910c2011-06-27 00:01:22 +00001916 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00001917
drha7dc4a32016-01-25 02:15:02 +00001918 /* Memory for registers, parameters, cursor, etc, is allocated in one or two
1919 ** passes. On the first pass, we try to reuse unused memory at the
drh124c0b42011-06-01 18:15:55 +00001920 ** end of the opcode array. If we are unable to satisfy all memory
1921 ** requirements by reusing the opcode array tail, then the second
drha7dc4a32016-01-25 02:15:02 +00001922 ** pass will fill in the remainder using a fresh memory allocation.
drh124c0b42011-06-01 18:15:55 +00001923 **
1924 ** This two-pass approach that reuses as much memory as possible from
drha7dc4a32016-01-25 02:15:02 +00001925 ** the leftover memory at the end of the opcode array. This can significantly
drh124c0b42011-06-01 18:15:55 +00001926 ** reduce the amount of memory held by a prepared statement.
1927 */
1928 do {
drha7dc4a32016-01-25 02:15:02 +00001929 x.nNeeded = 0;
1930 p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
1931 p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
1932 p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
1933 p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
1934 p->aOnceFlag = allocSpace(&x, p->aOnceFlag, nOnce);
dane2f771b2014-11-03 15:33:17 +00001935#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drha7dc4a32016-01-25 02:15:02 +00001936 p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
dane2f771b2014-11-03 15:33:17 +00001937#endif
drha7dc4a32016-01-25 02:15:02 +00001938 if( x.nNeeded==0 ) break;
1939 x.pSpace = p->pFree = sqlite3DbMallocZero(db, x.nNeeded);
1940 x.nFree = x.nNeeded;
1941 }while( !db->mallocFailed );
drhb2771ce2009-02-20 01:28:59 +00001942
drhd2a56232013-01-28 19:00:20 +00001943 p->nCursor = nCursor;
dan1d8cb212011-12-09 13:24:16 +00001944 p->nOnceFlag = nOnce;
drh124c0b42011-06-01 18:15:55 +00001945 if( p->aVar ){
1946 p->nVar = (ynVar)nVar;
1947 for(n=0; n<nVar; n++){
1948 p->aVar[n].flags = MEM_Null;
1949 p->aVar[n].db = db;
danielk197754db47e2004-05-19 10:36:43 +00001950 }
drh82a48512003-09-06 22:45:20 +00001951 }
drh6d664b42016-01-20 01:48:25 +00001952 p->nzVar = pParse->nzVar;
1953 p->azVar = pParse->azVar;
1954 pParse->nzVar = 0;
1955 pParse->azVar = 0;
drh124c0b42011-06-01 18:15:55 +00001956 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00001957 p->nMem = nMem;
1958 for(n=0; n<nMem; n++){
drha5750cf2014-02-07 13:20:31 +00001959 p->aMem[n].flags = MEM_Undefined;
drh124c0b42011-06-01 18:15:55 +00001960 p->aMem[n].db = db;
drhcf64d8b2003-12-31 17:57:10 +00001961 }
drh9a324642003-09-06 20:12:01 +00001962 }
drh124c0b42011-06-01 18:15:55 +00001963 p->explain = pParse->explain;
1964 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00001965}
1966
drh9a324642003-09-06 20:12:01 +00001967/*
danielk1977cd3e8f72008-03-25 09:47:35 +00001968** Close a VDBE cursor and release all the resources that cursor
1969** happens to hold.
drh9a324642003-09-06 20:12:01 +00001970*/
drhdfe88ec2008-11-03 20:55:06 +00001971void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh4774b132004-06-12 20:12:51 +00001972 if( pCx==0 ){
1973 return;
1974 }
drhc960dcb2015-11-20 19:22:01 +00001975 assert( pCx->pBt==0 || pCx->eCurType==CURTYPE_BTREE );
1976 switch( pCx->eCurType ){
1977 case CURTYPE_SORTER: {
1978 sqlite3VdbeSorterClose(p->db, pCx);
1979 break;
1980 }
1981 case CURTYPE_BTREE: {
1982 if( pCx->pBt ){
1983 sqlite3BtreeClose(pCx->pBt);
1984 /* The pCx->pCursor will be close automatically, if it exists, by
1985 ** the call above. */
1986 }else{
1987 assert( pCx->uc.pCursor!=0 );
1988 sqlite3BtreeCloseCursor(pCx->uc.pCursor);
1989 }
1990 break;
1991 }
drh9eff6162006-06-12 21:59:13 +00001992#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00001993 case CURTYPE_VTAB: {
1994 sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
1995 const sqlite3_module *pModule = pVCur->pVtab->pModule;
1996 assert( pVCur->pVtab->nRef>0 );
1997 pVCur->pVtab->nRef--;
1998 pModule->xClose(pVCur);
1999 break;
2000 }
drh9eff6162006-06-12 21:59:13 +00002001#endif
drhc960dcb2015-11-20 19:22:01 +00002002 }
drh9a324642003-09-06 20:12:01 +00002003}
2004
dan65a7cd12009-09-01 12:16:01 +00002005/*
drhab4e7f32015-04-16 18:11:50 +00002006** Close all cursors in the current frame.
2007*/
2008static void closeCursorsInFrame(Vdbe *p){
2009 if( p->apCsr ){
2010 int i;
2011 for(i=0; i<p->nCursor; i++){
2012 VdbeCursor *pC = p->apCsr[i];
2013 if( pC ){
2014 sqlite3VdbeFreeCursor(p, pC);
2015 p->apCsr[i] = 0;
2016 }
2017 }
2018 }
2019}
2020
2021/*
dan65a7cd12009-09-01 12:16:01 +00002022** Copy the values stored in the VdbeFrame structure to its Vdbe. This
2023** is used, for example, when a trigger sub-program is halted to restore
2024** control to the main program.
2025*/
dan165921a2009-08-28 18:53:45 +00002026int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
2027 Vdbe *v = pFrame->v;
drhab4e7f32015-04-16 18:11:50 +00002028 closeCursorsInFrame(v);
dane2f771b2014-11-03 15:33:17 +00002029#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00002030 v->anExec = pFrame->anExec;
dane2f771b2014-11-03 15:33:17 +00002031#endif
dan1d8cb212011-12-09 13:24:16 +00002032 v->aOnceFlag = pFrame->aOnceFlag;
2033 v->nOnceFlag = pFrame->nOnceFlag;
dan165921a2009-08-28 18:53:45 +00002034 v->aOp = pFrame->aOp;
2035 v->nOp = pFrame->nOp;
2036 v->aMem = pFrame->aMem;
2037 v->nMem = pFrame->nMem;
2038 v->apCsr = pFrame->apCsr;
2039 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00002040 v->db->lastRowid = pFrame->lastRowid;
2041 v->nChange = pFrame->nChange;
danc3da6672014-10-28 18:24:16 +00002042 v->db->nChange = pFrame->nDbChange;
drhb9626cf2016-02-22 16:04:31 +00002043 sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
dan32001322016-02-19 18:54:29 +00002044 v->pAuxData = pFrame->pAuxData;
2045 pFrame->pAuxData = 0;
dan165921a2009-08-28 18:53:45 +00002046 return pFrame->pc;
2047}
2048
drh9a324642003-09-06 20:12:01 +00002049/*
drh5f82e3c2009-07-06 00:44:08 +00002050** Close all cursors.
dan165921a2009-08-28 18:53:45 +00002051**
2052** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
2053** cell array. This is necessary as the memory cell array may contain
2054** pointers to VdbeFrame objects, which may in turn contain pointers to
2055** open cursors.
drh9a324642003-09-06 20:12:01 +00002056*/
drh5f82e3c2009-07-06 00:44:08 +00002057static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00002058 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00002059 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00002060 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
2061 sqlite3VdbeFrameRestore(pFrame);
drhf526dca2014-10-13 17:42:05 +00002062 p->pFrame = 0;
2063 p->nFrame = 0;
dan165921a2009-08-28 18:53:45 +00002064 }
drhf526dca2014-10-13 17:42:05 +00002065 assert( p->nFrame==0 );
drhab4e7f32015-04-16 18:11:50 +00002066 closeCursorsInFrame(p);
dan523a0872009-08-31 05:23:32 +00002067 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00002068 releaseMemArray(p->aMem, p->nMem);
dan523a0872009-08-31 05:23:32 +00002069 }
dan27106572010-12-01 08:04:47 +00002070 while( p->pDelFrame ){
2071 VdbeFrame *pDel = p->pDelFrame;
2072 p->pDelFrame = pDel->pParent;
2073 sqlite3VdbeFrameDelete(pDel);
2074 }
dan0c547792013-07-18 17:12:08 +00002075
2076 /* Delete any auxdata allocations made by the VM */
drhb9626cf2016-02-22 16:04:31 +00002077 if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
dan0c547792013-07-18 17:12:08 +00002078 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00002079}
2080
2081/*
drh7abda852014-09-19 16:02:06 +00002082** Clean up the VM after a single run.
drh9a324642003-09-06 20:12:01 +00002083*/
drhc890fec2008-08-01 20:10:08 +00002084static void Cleanup(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002085 sqlite3 *db = p->db;
dan165921a2009-08-28 18:53:45 +00002086
2087#ifdef SQLITE_DEBUG
2088 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
2089 ** Vdbe.aMem[] arrays have already been cleaned up. */
2090 int i;
drhb8475df2011-12-09 16:21:19 +00002091 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
2092 if( p->aMem ){
drh9f6168b2016-03-19 23:32:58 +00002093 for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
drhb8475df2011-12-09 16:21:19 +00002094 }
dan165921a2009-08-28 18:53:45 +00002095#endif
2096
drh633e6d52008-07-28 19:34:53 +00002097 sqlite3DbFree(db, p->zErrMsg);
drh9a324642003-09-06 20:12:01 +00002098 p->zErrMsg = 0;
drhd4e70eb2008-01-02 00:34:36 +00002099 p->pResultSet = 0;
drh9a324642003-09-06 20:12:01 +00002100}
2101
2102/*
danielk197722322fd2004-05-25 23:35:17 +00002103** Set the number of result columns that will be returned by this SQL
2104** statement. This is now set at compile time, rather than during
2105** execution of the vdbe program so that sqlite3_column_count() can
2106** be called on an SQL statement before sqlite3_step().
2107*/
2108void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00002109 Mem *pColName;
2110 int n;
drh633e6d52008-07-28 19:34:53 +00002111 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002112
drhc890fec2008-08-01 20:10:08 +00002113 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00002114 sqlite3DbFree(db, p->aColName);
danielk1977955de522006-02-10 02:27:42 +00002115 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00002116 p->nResColumn = (u16)nResColumn;
drh633e6d52008-07-28 19:34:53 +00002117 p->aColName = pColName = (Mem*)sqlite3DbMallocZero(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00002118 if( p->aColName==0 ) return;
2119 while( n-- > 0 ){
drh4a50aac2007-08-23 02:47:53 +00002120 pColName->flags = MEM_Null;
drh153c62c2007-08-24 03:51:33 +00002121 pColName->db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002122 pColName++;
drh76ff3a02004-09-24 22:32:30 +00002123 }
danielk197722322fd2004-05-25 23:35:17 +00002124}
2125
2126/*
danielk19773cf86062004-05-26 10:11:05 +00002127** Set the name of the idx'th column to be returned by the SQL statement.
2128** zName must be a pointer to a nul terminated string.
2129**
2130** This call must be made after a call to sqlite3VdbeSetNumCols().
2131**
danielk197710fb7492008-10-31 10:53:22 +00002132** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
2133** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
2134** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00002135*/
danielk197710fb7492008-10-31 10:53:22 +00002136int sqlite3VdbeSetColName(
2137 Vdbe *p, /* Vdbe being configured */
2138 int idx, /* Index of column zName applies to */
2139 int var, /* One of the COLNAME_* constants */
2140 const char *zName, /* Pointer to buffer containing name */
2141 void (*xDel)(void*) /* Memory management strategy for zName */
2142){
danielk19773cf86062004-05-26 10:11:05 +00002143 int rc;
2144 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00002145 assert( idx<p->nResColumn );
2146 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00002147 if( p->db->mallocFailed ){
2148 assert( !zName || xDel!=SQLITE_DYNAMIC );
mistachkinfad30392016-02-13 23:43:46 +00002149 return SQLITE_NOMEM_BKPT;
danielk197710fb7492008-10-31 10:53:22 +00002150 }
drh76ff3a02004-09-24 22:32:30 +00002151 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00002152 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00002153 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00002154 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00002155 return rc;
2156}
2157
danielk197713adf8a2004-06-03 16:08:41 +00002158/*
2159** A read or write transaction may or may not be active on database handle
2160** db. If a transaction is active, commit it. If there is a
2161** write-transaction spanning more than one database file, this routine
2162** takes care of the master journal trickery.
2163*/
danielk19773e3a84d2008-08-01 17:37:40 +00002164static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00002165 int i;
drh8e6cf0a2016-02-22 14:57:38 +00002166 int nTrans = 0; /* Number of databases with an active write-transaction
2167 ** that are candidates for a two-phase commit using a
2168 ** master-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002169 int rc = SQLITE_OK;
2170 int needXcommit = 0;
2171
shane36840fd2009-06-26 16:32:13 +00002172#ifdef SQLITE_OMIT_VIRTUALTABLE
2173 /* With this option, sqlite3VtabSync() is defined to be simply
2174 ** SQLITE_OK so p is not used.
2175 */
2176 UNUSED_PARAMETER(p);
2177#endif
2178
danielk19775bd270b2006-07-25 15:14:52 +00002179 /* Before doing anything else, call the xSync() callback for any
2180 ** virtual module tables written in this transaction. This has to
2181 ** be done before determining whether a master journal file is
2182 ** required, as an xSync() callback may add an attached database
2183 ** to the transaction.
2184 */
dan016f7812013-08-21 17:35:48 +00002185 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00002186
2187 /* This loop determines (a) if the commit hook should be invoked and
2188 ** (b) how many database files have open write transactions, not
2189 ** including the temp database. (b) is important because if more than
2190 ** one database file has an open write transaction, a master journal
2191 ** file is required for an atomic commit.
2192 */
drhabfb62f2010-07-30 11:20:35 +00002193 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002194 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002195 if( sqlite3BtreeIsInTrans(pBt) ){
drh8e6cf0a2016-02-22 14:57:38 +00002196 /* Whether or not a database might need a master journal depends upon
2197 ** its journal mode (among other things). This matrix determines which
2198 ** journal modes use a master journal and which do not */
2199 static const u8 aMJNeeded[] = {
2200 /* DELETE */ 1,
2201 /* PERSIST */ 1,
2202 /* OFF */ 0,
2203 /* TRUNCATE */ 1,
2204 /* MEMORY */ 0,
2205 /* WAL */ 0
2206 };
2207 Pager *pPager; /* Pager associated with pBt */
danielk197713adf8a2004-06-03 16:08:41 +00002208 needXcommit = 1;
dan6b9bb592012-10-05 19:43:02 +00002209 sqlite3BtreeEnter(pBt);
drh8e6cf0a2016-02-22 14:57:38 +00002210 pPager = sqlite3BtreePager(pBt);
2211 if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
2212 && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
2213 ){
2214 assert( i!=1 );
2215 nTrans++;
2216 }
2217 rc = sqlite3PagerExclusiveLock(pPager);
dan6b9bb592012-10-05 19:43:02 +00002218 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00002219 }
2220 }
drhabfb62f2010-07-30 11:20:35 +00002221 if( rc!=SQLITE_OK ){
2222 return rc;
2223 }
danielk197713adf8a2004-06-03 16:08:41 +00002224
2225 /* If there are any write-transactions at all, invoke the commit hook */
2226 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00002227 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00002228 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002229 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00002230 }
2231 }
2232
danielk197740b38dc2004-06-26 08:38:24 +00002233 /* The simple case - no more than one database file (not counting the
2234 ** TEMP database) has a transaction active. There is no need for the
drh2ac3ee92004-06-07 16:27:46 +00002235 ** master-journal.
drhc9e06862004-06-09 20:03:08 +00002236 **
danielk197740b38dc2004-06-26 08:38:24 +00002237 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00002238 ** string, it means the main database is :memory: or a temp file. In
2239 ** that case we do not support atomic multi-file commits, so use the
2240 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00002241 */
drhea678832008-12-10 19:26:22 +00002242 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
2243 || nTrans<=1
2244 ){
danielk197704103022009-02-03 16:51:24 +00002245 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002246 Btree *pBt = db->aDb[i].pBt;
2247 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002248 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00002249 }
2250 }
2251
drh80e35f42007-03-30 14:06:34 +00002252 /* Do the commit only if all databases successfully complete phase 1.
2253 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
2254 ** IO error while deleting or truncating a journal file. It is unlikely,
2255 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00002256 */
2257 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
2258 Btree *pBt = db->aDb[i].pBt;
2259 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002260 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00002261 }
danielk1977979f38e2007-03-27 16:19:51 +00002262 }
2263 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00002264 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002265 }
2266 }
2267
2268 /* The complex case - There is a multi-file write-transaction active.
2269 ** This requires a master journal file to ensure the transaction is
peter.d.reid60ec9142014-09-06 16:39:46 +00002270 ** committed atomically.
danielk197713adf8a2004-06-03 16:08:41 +00002271 */
danielk197744ee5bf2005-05-27 09:41:12 +00002272#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00002273 else{
danielk1977b4b47412007-08-17 15:53:36 +00002274 sqlite3_vfs *pVfs = db->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00002275 char *zMaster = 0; /* File-name for the master journal */
2276 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
danielk1977b4b47412007-08-17 15:53:36 +00002277 sqlite3_file *pMaster = 0;
danielk197762079062007-08-15 17:08:46 +00002278 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00002279 int res;
drhf5808602011-12-16 00:33:04 +00002280 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00002281 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00002282
2283 /* Select a master journal file name */
drh5c531a42011-12-16 01:21:31 +00002284 nMainFile = sqlite3Strlen30(zMainFile);
drh52bcde02012-01-03 14:50:45 +00002285 zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
mistachkinfad30392016-02-13 23:43:46 +00002286 if( zMaster==0 ) return SQLITE_NOMEM_BKPT;
danielk197713adf8a2004-06-03 16:08:41 +00002287 do {
drhdc5ea5c2008-12-10 17:19:59 +00002288 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00002289 if( retryCount ){
2290 if( retryCount>100 ){
2291 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
2292 sqlite3OsDelete(pVfs, zMaster, 0);
2293 break;
2294 }else if( retryCount==1 ){
2295 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
2296 }
danielk197713adf8a2004-06-03 16:08:41 +00002297 }
drh84968c02011-12-16 15:11:39 +00002298 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00002299 sqlite3_randomness(sizeof(iRandom), &iRandom);
drh5c531a42011-12-16 01:21:31 +00002300 sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00002301 (iRandom>>8)&0xffffff, iRandom&0xff);
drhf5808602011-12-16 00:33:04 +00002302 /* The antipenultimate character of the master journal name must
2303 ** be "9" to avoid name collisions when using 8+3 filenames. */
drh5c531a42011-12-16 01:21:31 +00002304 assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
drh81cc5162011-05-17 20:36:21 +00002305 sqlite3FileSuffix3(zMainFile, zMaster);
danielk1977861f7452008-06-05 11:39:11 +00002306 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
2307 }while( rc==SQLITE_OK && res );
2308 if( rc==SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00002309 /* Open the master journal. */
2310 rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
2311 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
2312 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
2313 );
2314 }
danielk197713adf8a2004-06-03 16:08:41 +00002315 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002316 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002317 return rc;
2318 }
2319
2320 /* Write the name of each database file in the transaction into the new
2321 ** master journal file. If an error occurs at this point close
2322 ** and delete the master journal file. All the individual journal files
2323 ** still have 'null' as the master journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00002324 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00002325 */
danielk19771e536952007-08-16 10:09:01 +00002326 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002327 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002328 if( sqlite3BtreeIsInTrans(pBt) ){
danielk19775865e3d2004-06-14 06:03:57 +00002329 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00002330 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00002331 continue; /* Ignore TEMP and :memory: databases */
2332 }
drh8c96a6e2010-08-31 01:09:15 +00002333 assert( zFile[0]!=0 );
drhea678832008-12-10 19:26:22 +00002334 rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
2335 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00002336 if( rc!=SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00002337 sqlite3OsCloseFree(pMaster);
2338 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002339 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002340 return rc;
2341 }
2342 }
2343 }
2344
danielk19779663b8f2007-08-24 11:52:28 +00002345 /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
2346 ** flag is set this is not required.
2347 */
drhb0529582016-02-22 23:44:42 +00002348 if( 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
danielk1977bea2a942009-01-20 17:06:27 +00002349 && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
2350 ){
danielk1977fee2d252007-08-18 10:59:19 +00002351 sqlite3OsCloseFree(pMaster);
2352 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002353 sqlite3DbFree(db, zMaster);
danielk19775865e3d2004-06-14 06:03:57 +00002354 return rc;
2355 }
drhc9e06862004-06-09 20:03:08 +00002356
danielk197713adf8a2004-06-03 16:08:41 +00002357 /* Sync all the db files involved in the transaction. The same call
2358 ** sets the master journal pointer in each individual journal. If
2359 ** an error occurs here, do not delete the master journal file.
2360 **
drh80e35f42007-03-30 14:06:34 +00002361 ** If the error occurs during the first call to
2362 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
2363 ** master journal file will be orphaned. But we cannot delete it,
2364 ** in case the master journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00002365 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00002366 */
danielk19775bd270b2006-07-25 15:14:52 +00002367 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002368 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002369 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002370 rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002371 }
2372 }
danielk1977fee2d252007-08-18 10:59:19 +00002373 sqlite3OsCloseFree(pMaster);
drhabfb62f2010-07-30 11:20:35 +00002374 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00002375 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002376 sqlite3DbFree(db, zMaster);
danielk19775bd270b2006-07-25 15:14:52 +00002377 return rc;
2378 }
danielk197713adf8a2004-06-03 16:08:41 +00002379
danielk1977962398d2004-06-14 09:35:16 +00002380 /* Delete the master journal file. This commits the transaction. After
2381 ** doing this the directory is synced again before any individual
2382 ** transaction files are deleted.
2383 */
drhb0529582016-02-22 23:44:42 +00002384 rc = sqlite3OsDelete(pVfs, zMaster, 1);
drh633e6d52008-07-28 19:34:53 +00002385 sqlite3DbFree(db, zMaster);
drhc416ba92007-03-30 18:42:55 +00002386 zMaster = 0;
drh29a01382006-08-13 19:04:18 +00002387 if( rc ){
2388 return rc;
2389 }
danielk197713adf8a2004-06-03 16:08:41 +00002390
2391 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00002392 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
2393 ** deleting or truncating journals. If something goes wrong while
2394 ** this is happening we don't really care. The integrity of the
2395 ** transaction is already guaranteed, but some stray 'cold' journals
2396 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00002397 */
danielk1977979f38e2007-03-27 16:19:51 +00002398 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002399 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00002400 for(i=0; i<db->nDb; i++){
2401 Btree *pBt = db->aDb[i].pBt;
2402 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002403 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00002404 }
2405 }
danielk19772d1d86f2008-06-20 14:59:51 +00002406 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00002407 enable_simulated_io_errors();
2408
danielk1977f9e7dda2006-06-16 16:08:53 +00002409 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002410 }
danielk197744ee5bf2005-05-27 09:41:12 +00002411#endif
danielk1977026d2702004-06-14 13:14:59 +00002412
drh2ac3ee92004-06-07 16:27:46 +00002413 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002414}
2415
danielk19771d850a72004-05-31 08:26:49 +00002416/*
drh4f7d3a52013-06-27 23:54:02 +00002417** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00002418** matches the number of vdbe's in the list sqlite3.pVdbe that are
2419** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00002420** This is an internal self-check only - it is not an essential processing
2421** step.
danielk19771d850a72004-05-31 08:26:49 +00002422**
2423** This is a no-op if NDEBUG is defined.
2424*/
2425#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00002426static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00002427 Vdbe *p;
2428 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00002429 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00002430 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00002431 p = db->pVdbe;
2432 while( p ){
dan857745c2014-07-19 17:57:10 +00002433 if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
danielk19771d850a72004-05-31 08:26:49 +00002434 cnt++;
drhad4a4b82008-11-05 16:37:34 +00002435 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00002436 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00002437 }
2438 p = p->pNext;
2439 }
drh4f7d3a52013-06-27 23:54:02 +00002440 assert( cnt==db->nVdbeActive );
2441 assert( nWrite==db->nVdbeWrite );
2442 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00002443}
2444#else
2445#define checkActiveVdbeCnt(x)
2446#endif
2447
danielk19773cf86062004-05-26 10:11:05 +00002448/*
danielk1977bd434552009-03-18 10:33:00 +00002449** If the Vdbe passed as the first argument opened a statement-transaction,
2450** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
2451** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
2452** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00002453** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00002454**
2455** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
2456** Otherwise SQLITE_OK.
2457*/
2458int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00002459 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00002460 int rc = SQLITE_OK;
danielk1977ecaecf92009-07-08 08:05:35 +00002461
danielk1977e4948172009-07-17 17:25:43 +00002462 /* If p->iStatement is greater than zero, then this Vdbe opened a
2463 ** statement transaction that should be closed here. The only exception
mistachkin48864df2013-03-21 21:20:32 +00002464 ** is that an IO error may have occurred, causing an emergency rollback.
danielk1977e4948172009-07-17 17:25:43 +00002465 ** In this case (db->nStatement==0), and there is nothing to do.
2466 */
2467 if( db->nStatement && p->iStatement ){
danielk1977bd434552009-03-18 10:33:00 +00002468 int i;
2469 const int iSavepoint = p->iStatement-1;
danielk1977bd434552009-03-18 10:33:00 +00002470
2471 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
2472 assert( db->nStatement>0 );
2473 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
2474
2475 for(i=0; i<db->nDb; i++){
2476 int rc2 = SQLITE_OK;
2477 Btree *pBt = db->aDb[i].pBt;
2478 if( pBt ){
2479 if( eOp==SAVEPOINT_ROLLBACK ){
2480 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
2481 }
2482 if( rc2==SQLITE_OK ){
2483 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
2484 }
2485 if( rc==SQLITE_OK ){
2486 rc = rc2;
2487 }
2488 }
2489 }
2490 db->nStatement--;
2491 p->iStatement = 0;
dan1da40a32009-09-19 17:00:31 +00002492
dana311b802011-04-26 19:21:34 +00002493 if( rc==SQLITE_OK ){
2494 if( eOp==SAVEPOINT_ROLLBACK ){
2495 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
2496 }
2497 if( rc==SQLITE_OK ){
2498 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
2499 }
2500 }
2501
dan1da40a32009-09-19 17:00:31 +00002502 /* If the statement transaction is being rolled back, also restore the
2503 ** database handles deferred constraint counter to the value it had when
2504 ** the statement transaction was opened. */
2505 if( eOp==SAVEPOINT_ROLLBACK ){
2506 db->nDeferredCons = p->nStmtDefCons;
dancb3e4b72013-07-03 19:53:05 +00002507 db->nDeferredImmCons = p->nStmtDefImmCons;
dan1da40a32009-09-19 17:00:31 +00002508 }
danielk1977bd434552009-03-18 10:33:00 +00002509 }
2510 return rc;
2511}
2512
2513/*
dan1da40a32009-09-19 17:00:31 +00002514** This function is called when a transaction opened by the database
2515** handle associated with the VM passed as an argument is about to be
2516** committed. If there are outstanding deferred foreign key constraint
2517** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
2518**
2519** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00002520** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
2521** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00002522*/
2523#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00002524int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00002525 sqlite3 *db = p->db;
dancb3e4b72013-07-03 19:53:05 +00002526 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
2527 || (!deferred && p->nFkConstraint>0)
2528 ){
drhd91c1a12013-02-09 13:58:25 +00002529 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00002530 p->errorAction = OE_Abort;
drh22c17b82015-05-15 04:13:15 +00002531 sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
dan1da40a32009-09-19 17:00:31 +00002532 return SQLITE_ERROR;
2533 }
2534 return SQLITE_OK;
2535}
2536#endif
2537
2538/*
drh92f02c32004-09-02 14:57:08 +00002539** This routine is called the when a VDBE tries to halt. If the VDBE
2540** has made changes and is in autocommit mode, then commit those
2541** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00002542**
drh92f02c32004-09-02 14:57:08 +00002543** This routine is the only way to move the state of a VM from
drhff0587c2007-08-29 17:43:19 +00002544** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
2545** call this on a VM that is in the SQLITE_MAGIC_HALT state.
drh92f02c32004-09-02 14:57:08 +00002546**
2547** Return an error code. If the commit could not complete because of
2548** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
2549** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00002550*/
drhff0587c2007-08-29 17:43:19 +00002551int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00002552 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00002553 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00002554
2555 /* This function contains the logic that determines if a statement or
2556 ** transaction will be committed or rolled back as a result of the
2557 ** execution of this virtual machine.
2558 **
drh71b890a2007-10-03 15:30:52 +00002559 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00002560 **
drh71b890a2007-10-03 15:30:52 +00002561 ** SQLITE_NOMEM
2562 ** SQLITE_IOERR
2563 ** SQLITE_FULL
2564 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00002565 **
drh71b890a2007-10-03 15:30:52 +00002566 ** Then the internal cache might have been left in an inconsistent
2567 ** state. We need to rollback the statement transaction, if there is
2568 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00002569 */
drh9a324642003-09-06 20:12:01 +00002570
drhb84e5742016-02-05 02:42:54 +00002571 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002572 p->rc = SQLITE_NOMEM_BKPT;
danielk1977261919c2005-12-06 12:52:59 +00002573 }
drh6e856bc2011-12-09 18:06:44 +00002574 if( p->aOnceFlag ) memset(p->aOnceFlag, 0, p->nOnceFlag);
drh5f82e3c2009-07-06 00:44:08 +00002575 closeAllCursors(p);
drh92f02c32004-09-02 14:57:08 +00002576 if( p->magic!=VDBE_MAGIC_RUN ){
drh92f02c32004-09-02 14:57:08 +00002577 return SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00002578 }
danielk19771d850a72004-05-31 08:26:49 +00002579 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00002580
danc0537fe2013-06-28 19:41:43 +00002581 /* No commit or rollback needed if the program never started or if the
2582 ** SQL statement does not read or write a database file. */
2583 if( p->pc>=0 && p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00002584 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00002585 int eStatementOp = 0;
2586 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00002587
2588 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00002589 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00002590
drh71b890a2007-10-03 15:30:52 +00002591 /* Check for one of the special errors */
drhaac2f552006-09-23 21:44:23 +00002592 mrc = p->rc & 0xff;
drh71b890a2007-10-03 15:30:52 +00002593 isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
drh77658e22007-12-04 16:54:52 +00002594 || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
danielk197707cb5602006-01-20 10:55:05 +00002595 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00002596 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
2597 ** no rollback is necessary. Otherwise, at least a savepoint
2598 ** transaction must be rolled back to restore the database to a
2599 ** consistent state.
2600 **
2601 ** Even if the statement is read-only, it is important to perform
2602 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00002603 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00002604 ** file as part of an effort to free up cache space (see function
2605 ** pagerStress() in pager.c), the rollback is required to restore
2606 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00002607 */
drhad4a4b82008-11-05 16:37:34 +00002608 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00002609 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00002610 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002611 }else{
2612 /* We are forced to roll back the active transaction. Before doing
2613 ** so, abort any other statements this handle currently has active.
2614 */
drh21021a52012-02-13 17:01:51 +00002615 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002616 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002617 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002618 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002619 }
danielk1977261919c2005-12-06 12:52:59 +00002620 }
2621 }
dan32b09f22009-09-23 17:29:59 +00002622
2623 /* Check for immediate foreign key violations. */
2624 if( p->rc==SQLITE_OK ){
2625 sqlite3VdbeCheckFk(p, 0);
2626 }
danielk197707cb5602006-01-20 10:55:05 +00002627
danielk1977bd434552009-03-18 10:33:00 +00002628 /* If the auto-commit flag is set and this is the only active writer
2629 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00002630 **
2631 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00002632 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00002633 */
danielk1977093e0f62008-11-13 18:00:14 +00002634 if( !sqlite3VtabInSync(db)
2635 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00002636 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00002637 ){
danielk197707cb5602006-01-20 10:55:05 +00002638 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00002639 rc = sqlite3VdbeCheckFk(p, 1);
2640 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00002641 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00002642 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00002643 return SQLITE_ERROR;
2644 }
drhd91c1a12013-02-09 13:58:25 +00002645 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan19611b12011-01-24 16:00:58 +00002646 }else{
2647 /* The auto-commit flag is true, the vdbe program was successful
2648 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
2649 ** key constraints to hold up the transaction. This means a commit
2650 ** is required. */
2651 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00002652 }
dan19611b12011-01-24 16:00:58 +00002653 if( rc==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00002654 sqlite3VdbeLeave(p);
danielk197707cb5602006-01-20 10:55:05 +00002655 return SQLITE_BUSY;
2656 }else if( rc!=SQLITE_OK ){
2657 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00002658 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002659 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002660 }else{
dan1da40a32009-09-19 17:00:31 +00002661 db->nDeferredCons = 0;
dancb3e4b72013-07-03 19:53:05 +00002662 db->nDeferredImmCons = 0;
drh963c74d2013-07-11 12:19:12 +00002663 db->flags &= ~SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00002664 sqlite3CommitInternalChanges(db);
2665 }
2666 }else{
drh0f198a72012-02-13 16:43:16 +00002667 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002668 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002669 }
danielk1977bd434552009-03-18 10:33:00 +00002670 db->nStatement = 0;
2671 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00002672 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00002673 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00002674 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00002675 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002676 }else{
drh21021a52012-02-13 17:01:51 +00002677 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002678 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002679 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002680 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002681 }
danielk19771d850a72004-05-31 08:26:49 +00002682 }
danielk197707cb5602006-01-20 10:55:05 +00002683
danielk1977bd434552009-03-18 10:33:00 +00002684 /* If eStatementOp is non-zero, then a statement transaction needs to
2685 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
2686 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00002687 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
2688 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00002689 */
danielk1977bd434552009-03-18 10:33:00 +00002690 if( eStatementOp ){
2691 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00002692 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002693 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00002694 p->rc = rc;
2695 sqlite3DbFree(db, p->zErrMsg);
2696 p->zErrMsg = 0;
2697 }
drh21021a52012-02-13 17:01:51 +00002698 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00002699 sqlite3CloseSavepoints(db);
2700 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002701 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002702 }
danielk197777d83ba2004-05-31 10:08:14 +00002703 }
danielk197707cb5602006-01-20 10:55:05 +00002704
danielk1977bd434552009-03-18 10:33:00 +00002705 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
2706 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00002707 */
drh6be240e2009-07-14 02:33:02 +00002708 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00002709 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00002710 sqlite3VdbeSetChanges(db, p->nChange);
2711 }else{
2712 sqlite3VdbeSetChanges(db, 0);
2713 }
2714 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00002715 }
drhff0587c2007-08-29 17:43:19 +00002716
2717 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00002718 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00002719 }
danielk19771d850a72004-05-31 08:26:49 +00002720
danielk197765fd59f2006-06-24 11:51:33 +00002721 /* We have successfully halted and closed the VM. Record this fact. */
2722 if( p->pc>=0 ){
drh4f7d3a52013-06-27 23:54:02 +00002723 db->nVdbeActive--;
2724 if( !p->readOnly ) db->nVdbeWrite--;
drh1713afb2013-06-28 01:24:57 +00002725 if( p->bIsReader ) db->nVdbeRead--;
drh4f7d3a52013-06-27 23:54:02 +00002726 assert( db->nVdbeActive>=db->nVdbeRead );
2727 assert( db->nVdbeRead>=db->nVdbeWrite );
2728 assert( db->nVdbeWrite>=0 );
drh9a324642003-09-06 20:12:01 +00002729 }
drh92f02c32004-09-02 14:57:08 +00002730 p->magic = VDBE_MAGIC_HALT;
2731 checkActiveVdbeCnt(db);
drhb84e5742016-02-05 02:42:54 +00002732 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00002733 p->rc = SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00002734 }
danielk19771d850a72004-05-31 08:26:49 +00002735
danielk1977404ca072009-03-16 13:19:36 +00002736 /* If the auto-commit flag is set to true, then any locks that were held
2737 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
2738 ** to invoke any required unlock-notify callbacks.
2739 */
2740 if( db->autoCommit ){
2741 sqlite3ConnectionUnlocked(db);
2742 }
2743
drh4f7d3a52013-06-27 23:54:02 +00002744 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
dan19611b12011-01-24 16:00:58 +00002745 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00002746}
drh4cf7c7f2007-08-28 23:28:07 +00002747
drh92f02c32004-09-02 14:57:08 +00002748
2749/*
drh3c23a882007-01-09 14:01:13 +00002750** Each VDBE holds the result of the most recent sqlite3_step() call
2751** in p->rc. This routine sets that result back to SQLITE_OK.
2752*/
2753void sqlite3VdbeResetStepResult(Vdbe *p){
2754 p->rc = SQLITE_OK;
2755}
2756
2757/*
dan029ead62011-10-27 15:19:58 +00002758** Copy the error code and error message belonging to the VDBE passed
2759** as the first argument to its database handle (so that they will be
2760** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
2761**
2762** This function does not clear the VDBE error code or message, just
2763** copies them to the database handle.
2764*/
2765int sqlite3VdbeTransferError(Vdbe *p){
2766 sqlite3 *db = p->db;
2767 int rc = p->rc;
2768 if( p->zErrMsg ){
drh4a642b62016-02-05 01:55:27 +00002769 db->bBenignMalloc++;
dan029ead62011-10-27 15:19:58 +00002770 sqlite3BeginBenignMalloc();
drha3cc0072013-12-13 16:23:55 +00002771 if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
dan029ead62011-10-27 15:19:58 +00002772 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
2773 sqlite3EndBenignMalloc();
drh4a642b62016-02-05 01:55:27 +00002774 db->bBenignMalloc--;
dan029ead62011-10-27 15:19:58 +00002775 db->errCode = rc;
2776 }else{
drh13f40da2014-08-22 18:00:11 +00002777 sqlite3Error(db, rc);
dan029ead62011-10-27 15:19:58 +00002778 }
2779 return rc;
2780}
2781
danac455932012-11-26 19:50:41 +00002782#ifdef SQLITE_ENABLE_SQLLOG
2783/*
2784** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
2785** invoke it.
2786*/
2787static void vdbeInvokeSqllog(Vdbe *v){
2788 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
2789 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
2790 assert( v->db->init.busy==0 );
2791 if( zExpanded ){
2792 sqlite3GlobalConfig.xSqllog(
2793 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
2794 );
2795 sqlite3DbFree(v->db, zExpanded);
2796 }
2797 }
2798}
2799#else
2800# define vdbeInvokeSqllog(x)
2801#endif
2802
dan029ead62011-10-27 15:19:58 +00002803/*
drh92f02c32004-09-02 14:57:08 +00002804** Clean up a VDBE after execution but do not delete the VDBE just yet.
2805** Write any error messages into *pzErrMsg. Return the result code.
2806**
2807** After this routine is run, the VDBE should be ready to be executed
2808** again.
2809**
2810** To look at it another way, this routine resets the state of the
2811** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
2812** VDBE_MAGIC_INIT.
2813*/
drhc890fec2008-08-01 20:10:08 +00002814int sqlite3VdbeReset(Vdbe *p){
drh4ac285a2006-09-15 07:28:50 +00002815 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00002816 db = p->db;
drh92f02c32004-09-02 14:57:08 +00002817
2818 /* If the VM did not run to completion or if it encountered an
2819 ** error, then it might not have been halted properly. So halt
2820 ** it now.
2821 */
2822 sqlite3VdbeHalt(p);
2823
drhfb7e7652005-01-24 00:28:42 +00002824 /* If the VDBE has be run even partially, then transfer the error code
2825 ** and error message from the VDBE into the main database structure. But
2826 ** if the VDBE has just been set to run but has not actually executed any
2827 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00002828 */
drhfb7e7652005-01-24 00:28:42 +00002829 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00002830 vdbeInvokeSqllog(p);
dan029ead62011-10-27 15:19:58 +00002831 sqlite3VdbeTransferError(p);
2832 sqlite3DbFree(db, p->zErrMsg);
2833 p->zErrMsg = 0;
drh4611d922010-02-25 14:47:01 +00002834 if( p->runOnlyOnce ) p->expired = 1;
danielk1977a21c6b62005-01-24 10:25:59 +00002835 }else if( p->rc && p->expired ){
2836 /* The expired flag was set on the VDBE before the first call
2837 ** to sqlite3_step(). For consistency (since sqlite3_step() was
2838 ** called), set the database error in this case as well.
2839 */
drh13f40da2014-08-22 18:00:11 +00002840 sqlite3ErrorWithMsg(db, p->rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002841 sqlite3DbFree(db, p->zErrMsg);
danielk19778e556522007-11-13 10:30:24 +00002842 p->zErrMsg = 0;
drh92f02c32004-09-02 14:57:08 +00002843 }
2844
2845 /* Reclaim all memory used by the VDBE
2846 */
drhc890fec2008-08-01 20:10:08 +00002847 Cleanup(p);
drh92f02c32004-09-02 14:57:08 +00002848
2849 /* Save profiling information from this VDBE run.
2850 */
drh9a324642003-09-06 20:12:01 +00002851#ifdef VDBE_PROFILE
2852 {
2853 FILE *out = fopen("vdbe_profile.out", "a");
2854 if( out ){
2855 int i;
2856 fprintf(out, "---- ");
2857 for(i=0; i<p->nOp; i++){
2858 fprintf(out, "%02x", p->aOp[i].opcode);
2859 }
2860 fprintf(out, "\n");
drh2926f962014-02-17 01:13:28 +00002861 if( p->zSql ){
2862 char c, pc = 0;
2863 fprintf(out, "-- ");
2864 for(i=0; (c = p->zSql[i])!=0; i++){
2865 if( pc=='\n' ) fprintf(out, "-- ");
2866 putc(c, out);
2867 pc = c;
2868 }
2869 if( pc!='\n' ) fprintf(out, "\n");
2870 }
drh9a324642003-09-06 20:12:01 +00002871 for(i=0; i<p->nOp; i++){
drh15ab9412014-02-24 14:24:01 +00002872 char zHdr[100];
2873 sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
drh9a324642003-09-06 20:12:01 +00002874 p->aOp[i].cnt,
2875 p->aOp[i].cycles,
2876 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
2877 );
drh15ab9412014-02-24 14:24:01 +00002878 fprintf(out, "%s", zHdr);
danielk19774adee202004-05-08 08:23:19 +00002879 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00002880 }
2881 fclose(out);
2882 }
2883 }
2884#endif
drh7fa20922013-09-17 23:36:33 +00002885 p->iCurrentTime = 0;
drh9a324642003-09-06 20:12:01 +00002886 p->magic = VDBE_MAGIC_INIT;
drh4ac285a2006-09-15 07:28:50 +00002887 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00002888}
drh92f02c32004-09-02 14:57:08 +00002889
drh9a324642003-09-06 20:12:01 +00002890/*
2891** Clean up and delete a VDBE after execution. Return an integer which is
2892** the result code. Write any error message text into *pzErrMsg.
2893*/
danielk19779e6db7d2004-06-21 08:18:51 +00002894int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00002895 int rc = SQLITE_OK;
danielk1977b5548a82004-06-26 13:51:33 +00002896 if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
drhc890fec2008-08-01 20:10:08 +00002897 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00002898 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00002899 }
danielk19774adee202004-05-08 08:23:19 +00002900 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00002901 return rc;
2902}
2903
2904/*
dan0c547792013-07-18 17:12:08 +00002905** If parameter iOp is less than zero, then invoke the destructor for
2906** all auxiliary data pointers currently cached by the VM passed as
2907** the first argument.
2908**
2909** Or, if iOp is greater than or equal to zero, then the destructor is
2910** only invoked for those auxiliary data pointers created by the user
2911** function invoked by the OP_Function opcode at instruction iOp of
2912** VM pVdbe, and only then if:
2913**
2914** * the associated function parameter is the 32nd or later (counting
2915** from left to right), or
2916**
2917** * the corresponding bit in argument mask is clear (where the first
peter.d.reid60ec9142014-09-06 16:39:46 +00002918** function parameter corresponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00002919*/
drhb9626cf2016-02-22 16:04:31 +00002920void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
dan0c547792013-07-18 17:12:08 +00002921 while( *pp ){
2922 AuxData *pAux = *pp;
2923 if( (iOp<0)
drh693e6712014-01-24 22:58:00 +00002924 || (pAux->iOp==iOp && (pAux->iArg>31 || !(mask & MASKBIT32(pAux->iArg))))
dan0c547792013-07-18 17:12:08 +00002925 ){
drh693e6712014-01-24 22:58:00 +00002926 testcase( pAux->iArg==31 );
drhf92c7ff2004-06-19 15:40:23 +00002927 if( pAux->xDelete ){
2928 pAux->xDelete(pAux->pAux);
2929 }
dan0c547792013-07-18 17:12:08 +00002930 *pp = pAux->pNext;
drhb9626cf2016-02-22 16:04:31 +00002931 sqlite3DbFree(db, pAux);
dan0c547792013-07-18 17:12:08 +00002932 }else{
2933 pp= &pAux->pNext;
drhf92c7ff2004-06-19 15:40:23 +00002934 }
2935 }
2936}
2937
2938/*
drhcb103b92012-10-26 00:11:23 +00002939** Free all memory associated with the Vdbe passed as the second argument,
2940** except for object itself, which is preserved.
2941**
dand46def72010-07-24 11:28:28 +00002942** The difference between this function and sqlite3VdbeDelete() is that
2943** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00002944** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00002945*/
drhcb103b92012-10-26 00:11:23 +00002946void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00002947 SubProgram *pSub, *pNext;
drh124c0b42011-06-01 18:15:55 +00002948 int i;
dand46def72010-07-24 11:28:28 +00002949 assert( p->db==0 || p->db==db );
2950 releaseMemArray(p->aVar, p->nVar);
2951 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
dand19c9332010-07-26 12:05:17 +00002952 for(pSub=p->pProgram; pSub; pSub=pNext){
2953 pNext = pSub->pNext;
2954 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
2955 sqlite3DbFree(db, pSub);
2956 }
drh124c0b42011-06-01 18:15:55 +00002957 for(i=p->nzVar-1; i>=0; i--) sqlite3DbFree(db, p->azVar[i]);
drh6d664b42016-01-20 01:48:25 +00002958 sqlite3DbFree(db, p->azVar);
dand46def72010-07-24 11:28:28 +00002959 vdbeFreeOpArray(db, p->aOp, p->nOp);
dand46def72010-07-24 11:28:28 +00002960 sqlite3DbFree(db, p->aColName);
2961 sqlite3DbFree(db, p->zSql);
2962 sqlite3DbFree(db, p->pFree);
dan6f9702e2014-11-01 20:38:06 +00002963#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan6f9702e2014-11-01 20:38:06 +00002964 for(i=0; i<p->nScan; i++){
2965 sqlite3DbFree(db, p->aScan[i].zName);
2966 }
2967 sqlite3DbFree(db, p->aScan);
2968#endif
dand46def72010-07-24 11:28:28 +00002969}
2970
2971/*
drh9a324642003-09-06 20:12:01 +00002972** Delete an entire VDBE.
2973*/
danielk19774adee202004-05-08 08:23:19 +00002974void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002975 sqlite3 *db;
2976
drhfa3be902009-07-07 02:44:07 +00002977 if( NEVER(p==0) ) return;
drh633e6d52008-07-28 19:34:53 +00002978 db = p->db;
drh4245c402012-06-02 14:32:21 +00002979 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00002980 sqlite3VdbeClearObject(db, p);
drh9a324642003-09-06 20:12:01 +00002981 if( p->pPrev ){
2982 p->pPrev->pNext = p->pNext;
2983 }else{
drh633e6d52008-07-28 19:34:53 +00002984 assert( db->pVdbe==p );
2985 db->pVdbe = p->pNext;
drh9a324642003-09-06 20:12:01 +00002986 }
2987 if( p->pNext ){
2988 p->pNext->pPrev = p->pPrev;
2989 }
drh9a324642003-09-06 20:12:01 +00002990 p->magic = VDBE_MAGIC_DEAD;
drh87f5c5f2010-01-20 01:20:56 +00002991 p->db = 0;
drhcb103b92012-10-26 00:11:23 +00002992 sqlite3DbFree(db, p);
drh9a324642003-09-06 20:12:01 +00002993}
drha11846b2004-01-07 18:52:56 +00002994
2995/*
drh6848dad2014-08-22 23:33:03 +00002996** The cursor "p" has a pending seek operation that has not yet been
2997** carried out. Seek the cursor now. If an error occurs, return
2998** the appropriate error code.
2999*/
3000static int SQLITE_NOINLINE handleDeferredMoveto(VdbeCursor *p){
3001 int res, rc;
3002#ifdef SQLITE_TEST
3003 extern int sqlite3_search_count;
3004#endif
3005 assert( p->deferredMoveto );
3006 assert( p->isTable );
drhc960dcb2015-11-20 19:22:01 +00003007 assert( p->eCurType==CURTYPE_BTREE );
3008 rc = sqlite3BtreeMovetoUnpacked(p->uc.pCursor, 0, p->movetoTarget, 0, &res);
drh6848dad2014-08-22 23:33:03 +00003009 if( rc ) return rc;
drh6848dad2014-08-22 23:33:03 +00003010 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
drh6848dad2014-08-22 23:33:03 +00003011#ifdef SQLITE_TEST
3012 sqlite3_search_count++;
3013#endif
3014 p->deferredMoveto = 0;
3015 p->cacheStatus = CACHE_STALE;
3016 return SQLITE_OK;
3017}
3018
3019/*
3020** Something has moved cursor "p" out of place. Maybe the row it was
3021** pointed to was deleted out from under it. Or maybe the btree was
3022** rebalanced. Whatever the cause, try to restore "p" to the place it
peter.d.reid60ec9142014-09-06 16:39:46 +00003023** is supposed to be pointing. If the row was deleted out from under the
drh6848dad2014-08-22 23:33:03 +00003024** cursor, set the cursor to point to a NULL row.
3025*/
3026static int SQLITE_NOINLINE handleMovedCursor(VdbeCursor *p){
3027 int isDifferentRow, rc;
drhc960dcb2015-11-20 19:22:01 +00003028 assert( p->eCurType==CURTYPE_BTREE );
3029 assert( p->uc.pCursor!=0 );
3030 assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
3031 rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
drh6848dad2014-08-22 23:33:03 +00003032 p->cacheStatus = CACHE_STALE;
3033 if( isDifferentRow ) p->nullRow = 1;
3034 return rc;
3035}
3036
3037/*
drhc22284f2014-10-13 16:02:20 +00003038** Check to ensure that the cursor is valid. Restore the cursor
3039** if need be. Return any I/O error from the restore operation.
3040*/
3041int sqlite3VdbeCursorRestore(VdbeCursor *p){
drhc960dcb2015-11-20 19:22:01 +00003042 assert( p->eCurType==CURTYPE_BTREE );
3043 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
drhc22284f2014-10-13 16:02:20 +00003044 return handleMovedCursor(p);
3045 }
3046 return SQLITE_OK;
3047}
3048
3049/*
drh9a65f2c2009-06-22 19:05:40 +00003050** Make sure the cursor p is ready to read or write the row to which it
3051** was last positioned. Return an error code if an OOM fault or I/O error
3052** prevents us from positioning the cursor to its correct position.
3053**
drha11846b2004-01-07 18:52:56 +00003054** If a MoveTo operation is pending on the given cursor, then do that
drh9a65f2c2009-06-22 19:05:40 +00003055** MoveTo now. If no move is pending, check to see if the row has been
3056** deleted out from under the cursor and if it has, mark the row as
3057** a NULL row.
3058**
3059** If the cursor is already pointing to the correct row and that row has
3060** not been deleted out from under the cursor, then this routine is a no-op.
drha11846b2004-01-07 18:52:56 +00003061*/
dande892d92016-01-29 19:29:45 +00003062int sqlite3VdbeCursorMoveto(VdbeCursor **pp, int *piCol){
3063 VdbeCursor *p = *pp;
drhc960dcb2015-11-20 19:22:01 +00003064 if( p->eCurType==CURTYPE_BTREE ){
3065 if( p->deferredMoveto ){
drhb1702022016-01-30 00:45:18 +00003066 int iMap;
3067 if( p->aAltMap && (iMap = p->aAltMap[1+*piCol])>0 ){
dande892d92016-01-29 19:29:45 +00003068 *pp = p->pAltCursor;
drhb1702022016-01-30 00:45:18 +00003069 *piCol = iMap - 1;
dande892d92016-01-29 19:29:45 +00003070 return SQLITE_OK;
3071 }
drhc960dcb2015-11-20 19:22:01 +00003072 return handleDeferredMoveto(p);
3073 }
3074 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
3075 return handleMovedCursor(p);
3076 }
drha11846b2004-01-07 18:52:56 +00003077 }
3078 return SQLITE_OK;
3079}
danielk19774adee202004-05-08 08:23:19 +00003080
drhab9f7f12004-05-08 10:56:11 +00003081/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003082** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00003083**
danielk1977cfcdaef2004-05-12 07:33:33 +00003084** sqlite3VdbeSerialType()
3085** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00003086** sqlite3VdbeSerialLen()
shane92003092008-07-31 01:43:13 +00003087** sqlite3VdbeSerialPut()
3088** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00003089**
3090** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00003091** data and index records. Each serialized value consists of a
3092** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
3093** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00003094**
danielk1977cfcdaef2004-05-12 07:33:33 +00003095** In an SQLite index record, the serial type is stored directly before
3096** the blob of data that it corresponds to. In a table record, all serial
3097** types are stored at the start of the record, and the blobs of data at
3098** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00003099** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00003100**
3101** The following table describes the various storage classes for data:
3102**
3103** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00003104** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00003105** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00003106** 1 1 signed integer
3107** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00003108** 3 3 signed integer
3109** 4 4 signed integer
3110** 5 6 signed integer
3111** 6 8 signed integer
3112** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00003113** 8 0 Integer constant 0
3114** 9 0 Integer constant 1
3115** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00003116** N>=12 and even (N-12)/2 BLOB
3117** N>=13 and odd (N-13)/2 text
3118**
drh35a59652006-01-02 18:24:40 +00003119** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
3120** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00003121*/
3122
3123/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003124** Return the serial-type for the value stored in pMem.
danielk1977192ac1d2004-05-10 07:17:30 +00003125*/
drhbe37c122015-10-16 14:54:17 +00003126u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
danielk1977cfcdaef2004-05-12 07:33:33 +00003127 int flags = pMem->flags;
drheac5bd72014-07-25 21:35:39 +00003128 u32 n;
danielk1977cfcdaef2004-05-12 07:33:33 +00003129
drhbe37c122015-10-16 14:54:17 +00003130 assert( pLen!=0 );
danielk1977cfcdaef2004-05-12 07:33:33 +00003131 if( flags&MEM_Null ){
drhbe37c122015-10-16 14:54:17 +00003132 *pLen = 0;
drha19b7752004-05-30 21:14:58 +00003133 return 0;
danielk197790e4d952004-05-10 10:05:53 +00003134 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003135 if( flags&MEM_Int ){
drhfe2093d2005-01-20 22:48:47 +00003136 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00003137# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00003138 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00003139 u64 u;
drhcfd654b2011-03-05 13:54:15 +00003140 if( i<0 ){
drh1b40e632014-11-20 02:58:10 +00003141 u = ~i;
drhcfd654b2011-03-05 13:54:15 +00003142 }else{
3143 u = i;
3144 }
drh56690b32012-09-17 15:36:31 +00003145 if( u<=127 ){
drhbe37c122015-10-16 14:54:17 +00003146 if( (i&1)==i && file_format>=4 ){
3147 *pLen = 0;
3148 return 8+(u32)u;
3149 }else{
3150 *pLen = 1;
3151 return 1;
3152 }
drh56690b32012-09-17 15:36:31 +00003153 }
drhbe37c122015-10-16 14:54:17 +00003154 if( u<=32767 ){ *pLen = 2; return 2; }
3155 if( u<=8388607 ){ *pLen = 3; return 3; }
3156 if( u<=2147483647 ){ *pLen = 4; return 4; }
3157 if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
3158 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003159 return 6;
danielk197790e4d952004-05-10 10:05:53 +00003160 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003161 if( flags&MEM_Real ){
drhbe37c122015-10-16 14:54:17 +00003162 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003163 return 7;
danielk197790e4d952004-05-10 10:05:53 +00003164 }
danielk1977e4359752008-11-03 09:39:45 +00003165 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drheac5bd72014-07-25 21:35:39 +00003166 assert( pMem->n>=0 );
3167 n = (u32)pMem->n;
drhfdf972a2007-05-02 13:30:27 +00003168 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00003169 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00003170 }
drhbe37c122015-10-16 14:54:17 +00003171 *pLen = n;
drhfdf972a2007-05-02 13:30:27 +00003172 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00003173}
3174
3175/*
drhfaf37272015-10-16 14:23:42 +00003176** The sizes for serial types less than 128
drhc5ef7152015-06-28 02:58:51 +00003177*/
3178static const u8 sqlite3SmallTypeSizes[] = {
drhfaf37272015-10-16 14:23:42 +00003179 /* 0 1 2 3 4 5 6 7 8 9 */
3180/* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
3181/* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
3182/* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
3183/* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
3184/* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
3185/* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
3186/* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
3187/* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
3188/* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
3189/* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
3190/* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
3191/* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
3192/* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
drhc5ef7152015-06-28 02:58:51 +00003193};
3194
3195/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003196** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00003197*/
drh35cd6432009-06-05 14:17:21 +00003198u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drhfaf37272015-10-16 14:23:42 +00003199 if( serial_type>=128 ){
drh51846b52004-05-28 16:00:21 +00003200 return (serial_type-12)/2;
3201 }else{
drhfaf37272015-10-16 14:23:42 +00003202 assert( serial_type<12
3203 || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
drhc5ef7152015-06-28 02:58:51 +00003204 return sqlite3SmallTypeSizes[serial_type];
drh51846b52004-05-28 16:00:21 +00003205 }
danielk1977192ac1d2004-05-10 07:17:30 +00003206}
drhfaf37272015-10-16 14:23:42 +00003207u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
3208 assert( serial_type<128 );
3209 return sqlite3SmallTypeSizes[serial_type];
3210}
danielk1977192ac1d2004-05-10 07:17:30 +00003211
3212/*
drh110daac2007-05-04 11:59:31 +00003213** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00003214** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00003215** upper 4 bytes. Return the result.
3216**
drh7a4f5022007-05-23 07:20:08 +00003217** For most architectures, this is a no-op.
3218**
3219** (later): It is reported to me that the mixed-endian problem
3220** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
3221** that early versions of GCC stored the two words of a 64-bit
3222** float in the wrong order. And that error has been propagated
3223** ever since. The blame is not necessarily with GCC, though.
3224** GCC might have just copying the problem from a prior compiler.
3225** I am also told that newer versions of GCC that follow a different
3226** ABI get the byte order right.
3227**
3228** Developers using SQLite on an ARM7 should compile and run their
3229** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
3230** enabled, some asserts below will ensure that the byte order of
3231** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00003232**
3233** (2007-08-30) Frank van Vugt has studied this problem closely
3234** and has send his findings to the SQLite developers. Frank
3235** writes that some Linux kernels offer floating point hardware
3236** emulation that uses only 32-bit mantissas instead of a full
3237** 48-bits as required by the IEEE standard. (This is the
3238** CONFIG_FPE_FASTFPE option.) On such systems, floating point
3239** byte swapping becomes very complicated. To avoid problems,
3240** the necessary byte swapping is carried out using a 64-bit integer
3241** rather than a 64-bit float. Frank assures us that the code here
3242** works for him. We, the developers, have no way to independently
3243** verify this, but Frank seems to know what he is talking about
3244** so we trust him.
drh110daac2007-05-04 11:59:31 +00003245*/
3246#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh60d09a72007-08-30 15:05:08 +00003247static u64 floatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00003248 union {
drh60d09a72007-08-30 15:05:08 +00003249 u64 r;
drh110daac2007-05-04 11:59:31 +00003250 u32 i[2];
3251 } u;
3252 u32 t;
3253
3254 u.r = in;
3255 t = u.i[0];
3256 u.i[0] = u.i[1];
3257 u.i[1] = t;
3258 return u.r;
3259}
3260# define swapMixedEndianFloat(X) X = floatSwap(X)
3261#else
3262# define swapMixedEndianFloat(X)
3263#endif
3264
3265/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003266** Write the serialized data blob for the value stored in pMem into
3267** buf. It is assumed that the caller has allocated sufficient space.
3268** Return the number of bytes written.
drhfdf972a2007-05-02 13:30:27 +00003269**
drh038b7bc2013-12-09 23:17:22 +00003270** nBuf is the amount of space left in buf[]. The caller is responsible
3271** for allocating enough space to buf[] to hold the entire field, exclusive
3272** of the pMem->u.nZero bytes for a MEM_Zero value.
drhfdf972a2007-05-02 13:30:27 +00003273**
3274** Return the number of bytes actually written into buf[]. The number
3275** of bytes in the zero-filled tail is included in the return value only
3276** if those bytes were zeroed in buf[].
danielk1977cfcdaef2004-05-12 07:33:33 +00003277*/
drha9ab4812013-12-11 11:00:44 +00003278u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
drh35cd6432009-06-05 14:17:21 +00003279 u32 len;
danielk1977183f9f72004-05-13 05:20:26 +00003280
drh1483e142004-05-21 21:12:42 +00003281 /* Integer and Real */
drhd946db02005-12-29 19:23:06 +00003282 if( serial_type<=7 && serial_type>0 ){
drh1483e142004-05-21 21:12:42 +00003283 u64 v;
drh35cd6432009-06-05 14:17:21 +00003284 u32 i;
drha19b7752004-05-30 21:14:58 +00003285 if( serial_type==7 ){
drh74eaba42014-09-18 17:52:15 +00003286 assert( sizeof(v)==sizeof(pMem->u.r) );
3287 memcpy(&v, &pMem->u.r, sizeof(v));
drh60d09a72007-08-30 15:05:08 +00003288 swapMixedEndianFloat(v);
drh1483e142004-05-21 21:12:42 +00003289 }else{
drh3c024d62007-03-30 11:23:45 +00003290 v = pMem->u.i;
danielk1977cfcdaef2004-05-12 07:33:33 +00003291 }
drhc5ef7152015-06-28 02:58:51 +00003292 len = i = sqlite3SmallTypeSizes[serial_type];
drh3f5b1992014-08-22 13:22:32 +00003293 assert( i>0 );
3294 do{
3295 buf[--i] = (u8)(v&0xFF);
drh1483e142004-05-21 21:12:42 +00003296 v >>= 8;
drh3f5b1992014-08-22 13:22:32 +00003297 }while( i );
drh1483e142004-05-21 21:12:42 +00003298 return len;
danielk1977cfcdaef2004-05-12 07:33:33 +00003299 }
drhd946db02005-12-29 19:23:06 +00003300
danielk1977cfcdaef2004-05-12 07:33:33 +00003301 /* String or blob */
drhd946db02005-12-29 19:23:06 +00003302 if( serial_type>=12 ){
drh8df32842008-12-09 02:51:23 +00003303 assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
shane75ac1de2009-06-09 18:58:52 +00003304 == (int)sqlite3VdbeSerialTypeLen(serial_type) );
drhfdf972a2007-05-02 13:30:27 +00003305 len = pMem->n;
drh72ea29d2015-12-08 16:58:45 +00003306 if( len>0 ) memcpy(buf, pMem->z, len);
drhd946db02005-12-29 19:23:06 +00003307 return len;
3308 }
3309
3310 /* NULL or constants 0 or 1 */
3311 return 0;
danielk1977cfcdaef2004-05-12 07:33:33 +00003312}
3313
drhf926d1e2014-03-04 04:04:33 +00003314/* Input "x" is a sequence of unsigned characters that represent a
3315** big-endian integer. Return the equivalent native integer
3316*/
3317#define ONE_BYTE_INT(x) ((i8)(x)[0])
3318#define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
3319#define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
3320#define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drh8932bec2014-08-22 14:56:13 +00003321#define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drhf926d1e2014-03-04 04:04:33 +00003322
danielk1977cfcdaef2004-05-12 07:33:33 +00003323/*
3324** Deserialize the data blob pointed to by buf as serial type serial_type
3325** and store the result in pMem. Return the number of bytes read.
drh14a924a2014-08-22 14:34:05 +00003326**
3327** This function is implemented as two separate routines for performance.
3328** The few cases that require local variables are broken out into a separate
3329** routine so that in most cases the overhead of moving the stack pointer
3330** is avoided.
danielk1977cfcdaef2004-05-12 07:33:33 +00003331*/
drh14a924a2014-08-22 14:34:05 +00003332static u32 SQLITE_NOINLINE serialGet(
danielk197793d46752004-05-23 13:30:58 +00003333 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00003334 u32 serial_type, /* Serial type to deserialize */
3335 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00003336){
drh8932bec2014-08-22 14:56:13 +00003337 u64 x = FOUR_BYTE_UINT(buf);
3338 u32 y = FOUR_BYTE_UINT(buf+4);
3339 x = (x<<32) + y;
drh14a924a2014-08-22 14:34:05 +00003340 if( serial_type==6 ){
drh654858d2014-11-20 02:18:14 +00003341 /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
3342 ** twos-complement integer. */
drh14a924a2014-08-22 14:34:05 +00003343 pMem->u.i = *(i64*)&x;
3344 pMem->flags = MEM_Int;
3345 testcase( pMem->u.i<0 );
3346 }else{
drh654858d2014-11-20 02:18:14 +00003347 /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
3348 ** floating point number. */
drh14a924a2014-08-22 14:34:05 +00003349#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
3350 /* Verify that integers and floating point values use the same
3351 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
3352 ** defined that 64-bit floating point values really are mixed
3353 ** endian.
3354 */
3355 static const u64 t1 = ((u64)0x3ff00000)<<32;
3356 static const double r1 = 1.0;
3357 u64 t2 = t1;
3358 swapMixedEndianFloat(t2);
3359 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
3360#endif
drh74eaba42014-09-18 17:52:15 +00003361 assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
drh14a924a2014-08-22 14:34:05 +00003362 swapMixedEndianFloat(x);
drh74eaba42014-09-18 17:52:15 +00003363 memcpy(&pMem->u.r, &x, sizeof(x));
3364 pMem->flags = sqlite3IsNaN(pMem->u.r) ? MEM_Null : MEM_Real;
drh14a924a2014-08-22 14:34:05 +00003365 }
3366 return 8;
3367}
danielk1977b1bc9532004-05-22 03:05:33 +00003368u32 sqlite3VdbeSerialGet(
3369 const unsigned char *buf, /* Buffer to deserialize from */
3370 u32 serial_type, /* Serial type to deserialize */
3371 Mem *pMem /* Memory cell to write value into */
3372){
drh3c685822005-05-21 18:32:18 +00003373 switch( serial_type ){
drh3c685822005-05-21 18:32:18 +00003374 case 10: /* Reserved for future use */
3375 case 11: /* Reserved for future use */
drh654858d2014-11-20 02:18:14 +00003376 case 0: { /* Null */
3377 /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
drh3c685822005-05-21 18:32:18 +00003378 pMem->flags = MEM_Null;
3379 break;
3380 }
drh654858d2014-11-20 02:18:14 +00003381 case 1: {
3382 /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
3383 ** integer. */
drhf926d1e2014-03-04 04:04:33 +00003384 pMem->u.i = ONE_BYTE_INT(buf);
drh1483e142004-05-21 21:12:42 +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 1;
drh1483e142004-05-21 21:12:42 +00003388 }
drh3c685822005-05-21 18:32:18 +00003389 case 2: { /* 2-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003390 /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
3391 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003392 pMem->u.i = TWO_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 2;
3396 }
3397 case 3: { /* 3-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003398 /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
3399 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003400 pMem->u.i = THREE_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003401 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003402 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003403 return 3;
3404 }
3405 case 4: { /* 4-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003406 /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
3407 ** twos-complement integer. */
drh8932bec2014-08-22 14:56:13 +00003408 pMem->u.i = FOUR_BYTE_INT(buf);
drhc8bb4302015-11-06 17:28:00 +00003409#ifdef __HP_cc
3410 /* Work around a sign-extension bug in the HP compiler for HP/UX */
3411 if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
3412#endif
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 4;
3416 }
3417 case 5: { /* 6-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003418 /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
3419 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003420 pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003421 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003422 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003423 return 6;
3424 }
drh91124b32005-08-18 18:15:05 +00003425 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00003426 case 7: { /* IEEE floating point */
drh8932bec2014-08-22 14:56:13 +00003427 /* These use local variables, so do them in a separate routine
3428 ** to avoid having to move the frame pointer in the common case */
drh14a924a2014-08-22 14:34:05 +00003429 return serialGet(buf,serial_type,pMem);
drh3c685822005-05-21 18:32:18 +00003430 }
drhd946db02005-12-29 19:23:06 +00003431 case 8: /* Integer 0 */
3432 case 9: { /* Integer 1 */
drh654858d2014-11-20 02:18:14 +00003433 /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
3434 /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
drh3c024d62007-03-30 11:23:45 +00003435 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00003436 pMem->flags = MEM_Int;
3437 return 0;
3438 }
drh3c685822005-05-21 18:32:18 +00003439 default: {
drh654858d2014-11-20 02:18:14 +00003440 /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
3441 ** length.
3442 ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
3443 ** (N-13)/2 bytes in length. */
drhc138daf2013-11-19 13:55:34 +00003444 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh3c685822005-05-21 18:32:18 +00003445 pMem->z = (char *)buf;
drh14a924a2014-08-22 14:34:05 +00003446 pMem->n = (serial_type-12)/2;
drhc138daf2013-11-19 13:55:34 +00003447 pMem->flags = aFlag[serial_type&1];
drh14a924a2014-08-22 14:34:05 +00003448 return pMem->n;
drh696b32f2004-05-30 01:51:52 +00003449 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003450 }
drh3c685822005-05-21 18:32:18 +00003451 return 0;
danielk1977192ac1d2004-05-10 07:17:30 +00003452}
drh1e968a02008-03-25 00:22:21 +00003453/*
dan03e9cfc2011-09-05 14:20:27 +00003454** This routine is used to allocate sufficient space for an UnpackedRecord
3455** structure large enough to be used with sqlite3VdbeRecordUnpack() if
3456** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00003457**
dan03e9cfc2011-09-05 14:20:27 +00003458** The space is either allocated using sqlite3DbMallocRaw() or from within
3459** the unaligned buffer passed via the second and third arguments (presumably
3460** stack space). If the former, then *ppFree is set to a pointer that should
3461** be eventually freed by the caller using sqlite3DbFree(). Or, if the
3462** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
3463** before returning.
drh1e968a02008-03-25 00:22:21 +00003464**
dan03e9cfc2011-09-05 14:20:27 +00003465** If an OOM error occurs, NULL is returned.
3466*/
3467UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
3468 KeyInfo *pKeyInfo, /* Description of the record */
3469 char *pSpace, /* Unaligned space available */
3470 int szSpace, /* Size of pSpace[] in bytes */
3471 char **ppFree /* OUT: Caller should free this pointer */
drh1e968a02008-03-25 00:22:21 +00003472){
dan03e9cfc2011-09-05 14:20:27 +00003473 UnpackedRecord *p; /* Unpacked record to return */
3474 int nOff; /* Increment pSpace by nOff to align it */
3475 int nByte; /* Number of bytes required for *p */
3476
3477 /* We want to shift the pointer pSpace up such that it is 8-byte aligned.
shane80167bf2009-04-10 15:42:36 +00003478 ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
3479 ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
3480 */
3481 nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
drh8c5d1522009-04-10 00:56:28 +00003482 nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
dan42acb3e2011-09-05 20:16:38 +00003483 if( nByte>szSpace+nOff ){
dan03e9cfc2011-09-05 14:20:27 +00003484 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
3485 *ppFree = (char *)p;
dan42acb3e2011-09-05 20:16:38 +00003486 if( !p ) return 0;
drh1e968a02008-03-25 00:22:21 +00003487 }else{
dan42acb3e2011-09-05 20:16:38 +00003488 p = (UnpackedRecord*)&pSpace[nOff];
dan03e9cfc2011-09-05 14:20:27 +00003489 *ppFree = 0;
drh1e968a02008-03-25 00:22:21 +00003490 }
dan42acb3e2011-09-05 20:16:38 +00003491
3492 p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
drhe1a022e2012-09-17 17:16:53 +00003493 assert( pKeyInfo->aSortOrder!=0 );
drh1e968a02008-03-25 00:22:21 +00003494 p->pKeyInfo = pKeyInfo;
3495 p->nField = pKeyInfo->nField + 1;
dan03e9cfc2011-09-05 14:20:27 +00003496 return p;
3497}
3498
3499/*
3500** Given the nKey-byte encoding of a record in pKey[], populate the
3501** UnpackedRecord structure indicated by the fourth argument with the
3502** contents of the decoded record.
3503*/
3504void sqlite3VdbeRecordUnpack(
3505 KeyInfo *pKeyInfo, /* Information about the record format */
3506 int nKey, /* Size of the binary record */
3507 const void *pKey, /* The binary record */
3508 UnpackedRecord *p /* Populate this structure before returning. */
3509){
3510 const unsigned char *aKey = (const unsigned char *)pKey;
3511 int d;
3512 u32 idx; /* Offset in aKey[] to read from */
3513 u16 u; /* Unsigned loop counter */
3514 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00003515 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00003516
dan1fed5da2014-02-25 21:01:25 +00003517 p->default_rc = 0;
drh8c5d1522009-04-10 00:56:28 +00003518 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00003519 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00003520 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00003521 u = 0;
drh7f4b19f2014-09-16 13:30:05 +00003522 while( idx<szHdr && d<=nKey ){
drh1e968a02008-03-25 00:22:21 +00003523 u32 serial_type;
3524
danielk197700e13612008-11-17 19:18:54 +00003525 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00003526 pMem->enc = pKeyInfo->enc;
3527 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00003528 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
drh17bcb102014-09-18 21:25:33 +00003529 pMem->szMalloc = 0;
drh304637c2011-03-18 16:47:27 +00003530 pMem->z = 0;
drh1e968a02008-03-25 00:22:21 +00003531 d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
drhe14006d2008-03-25 17:23:32 +00003532 pMem++;
drh7f4b19f2014-09-16 13:30:05 +00003533 if( (++u)>=p->nField ) break;
drh1e968a02008-03-25 00:22:21 +00003534 }
drh7d10d5a2008-08-20 16:35:10 +00003535 assert( u<=pKeyInfo->nField + 1 );
shane0b8d2762008-07-22 05:18:00 +00003536 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00003537}
3538
dan3833e932014-03-01 19:44:56 +00003539#if SQLITE_DEBUG
drh1e968a02008-03-25 00:22:21 +00003540/*
dan3833e932014-03-01 19:44:56 +00003541** This function compares two index or table record keys in the same way
3542** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
3543** this function deserializes and compares values using the
3544** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
3545** in assert() statements to ensure that the optimized code in
3546** sqlite3VdbeRecordCompare() returns results with these two primitives.
drh79211e12014-05-02 17:33:16 +00003547**
3548** Return true if the result of comparison is equivalent to desiredResult.
3549** Return false if there is a disagreement.
drh1e968a02008-03-25 00:22:21 +00003550*/
dan3833e932014-03-01 19:44:56 +00003551static int vdbeRecordCompareDebug(
drhec1fc802008-08-13 14:07:40 +00003552 int nKey1, const void *pKey1, /* Left key */
drh79211e12014-05-02 17:33:16 +00003553 const UnpackedRecord *pPKey2, /* Right key */
3554 int desiredResult /* Correct answer */
drh1e968a02008-03-25 00:22:21 +00003555){
drhdf003d62013-08-01 19:17:39 +00003556 u32 d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00003557 u32 idx1; /* Offset into aKey[] of next header element */
3558 u32 szHdr1; /* Number of bytes in header */
3559 int i = 0;
drh1e968a02008-03-25 00:22:21 +00003560 int rc = 0;
3561 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3562 KeyInfo *pKeyInfo;
3563 Mem mem1;
3564
3565 pKeyInfo = pPKey2->pKeyInfo;
drh84de6902014-05-02 18:46:52 +00003566 if( pKeyInfo->db==0 ) return 1;
drh1e968a02008-03-25 00:22:21 +00003567 mem1.enc = pKeyInfo->enc;
drh37272632009-11-16 21:28:45 +00003568 mem1.db = pKeyInfo->db;
drhd93a8b22009-11-16 03:13:40 +00003569 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
drh17bcb102014-09-18 21:25:33 +00003570 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drh8b249a82009-11-16 02:14:00 +00003571
3572 /* Compilers may complain that mem1.u.i is potentially uninitialized.
3573 ** We could initialize it, as shown here, to silence those complaints.
drh5275d2e2011-04-27 01:00:17 +00003574 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
drh8b249a82009-11-16 02:14:00 +00003575 ** the unnecessary initialization has a measurable negative performance
3576 ** impact, since this routine is a very high runner. And so, we choose
3577 ** to ignore the compiler warnings and leave this variable uninitialized.
3578 */
3579 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
drh1e968a02008-03-25 00:22:21 +00003580
shane3f8d5cf2008-04-24 19:15:09 +00003581 idx1 = getVarint32(aKey1, szHdr1);
drh46981362015-07-08 12:25:38 +00003582 if( szHdr1>98307 ) return SQLITE_CORRUPT;
drh1e968a02008-03-25 00:22:21 +00003583 d1 = szHdr1;
drhb2023662013-11-29 15:39:36 +00003584 assert( pKeyInfo->nField+pKeyInfo->nXField>=pPKey2->nField || CORRUPT_DB );
drhe1a022e2012-09-17 17:16:53 +00003585 assert( pKeyInfo->aSortOrder!=0 );
dan89bc0212013-12-03 09:49:52 +00003586 assert( pKeyInfo->nField>0 );
3587 assert( idx1<=szHdr1 || CORRUPT_DB );
drh0b9dada2013-11-25 22:24:36 +00003588 do{
drh1e968a02008-03-25 00:22:21 +00003589 u32 serial_type1;
3590
3591 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00003592 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drhaf5b2af2013-08-05 15:32:09 +00003593
3594 /* Verify that there is enough key space remaining to avoid
3595 ** a buffer overread. The "d1+serial_type1+2" subexpression will
3596 ** always be greater than or equal to the amount of required key space.
3597 ** Use that approximation to avoid the more expensive call to
3598 ** sqlite3VdbeSerialTypeLen() in the common case.
3599 */
3600 if( d1+serial_type1+2>(u32)nKey1
3601 && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
3602 ){
3603 break;
3604 }
drh1e968a02008-03-25 00:22:21 +00003605
3606 /* Extract the values to be compared.
3607 */
3608 d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
3609
3610 /* Do the comparison
3611 */
drh323df792013-08-05 19:11:29 +00003612 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
drh1e968a02008-03-25 00:22:21 +00003613 if( rc!=0 ){
drh17bcb102014-09-18 21:25:33 +00003614 assert( mem1.szMalloc==0 ); /* See comment below */
drh323df792013-08-05 19:11:29 +00003615 if( pKeyInfo->aSortOrder[i] ){
drh6f225d02013-10-26 13:36:51 +00003616 rc = -rc; /* Invert the result for DESC sort order. */
drh8b249a82009-11-16 02:14:00 +00003617 }
drh79211e12014-05-02 17:33:16 +00003618 goto debugCompareEnd;
drh1e968a02008-03-25 00:22:21 +00003619 }
3620 i++;
drh0b9dada2013-11-25 22:24:36 +00003621 }while( idx1<szHdr1 && i<pPKey2->nField );
drh407414c2009-07-14 14:15:27 +00003622
drh8b249a82009-11-16 02:14:00 +00003623 /* No memory allocation is ever used on mem1. Prove this using
3624 ** the following assert(). If the assert() fails, it indicates a
3625 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
danielk1977de630352009-05-04 11:42:29 +00003626 */
drh17bcb102014-09-18 21:25:33 +00003627 assert( mem1.szMalloc==0 );
danielk1977de630352009-05-04 11:42:29 +00003628
drh8b249a82009-11-16 02:14:00 +00003629 /* rc==0 here means that one of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00003630 ** all the fields up to that point were equal. Return the default_rc
dan3b9330f2014-02-27 20:44:18 +00003631 ** value. */
drh79211e12014-05-02 17:33:16 +00003632 rc = pPKey2->default_rc;
3633
3634debugCompareEnd:
3635 if( desiredResult==0 && rc==0 ) return 1;
3636 if( desiredResult<0 && rc<0 ) return 1;
3637 if( desiredResult>0 && rc>0 ) return 1;
3638 if( CORRUPT_DB ) return 1;
3639 if( pKeyInfo->db->mallocFailed ) return 1;
3640 return 0;
dan1fed5da2014-02-25 21:01:25 +00003641}
dan3833e932014-03-01 19:44:56 +00003642#endif
dan1fed5da2014-02-25 21:01:25 +00003643
drhe1bb8022015-01-19 19:48:52 +00003644#if SQLITE_DEBUG
3645/*
3646** Count the number of fields (a.k.a. columns) in the record given by
3647** pKey,nKey. The verify that this count is less than or equal to the
3648** limit given by pKeyInfo->nField + pKeyInfo->nXField.
3649**
3650** If this constraint is not satisfied, it means that the high-speed
3651** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
3652** not work correctly. If this assert() ever fires, it probably means
3653** that the KeyInfo.nField or KeyInfo.nXField values were computed
3654** incorrectly.
3655*/
3656static void vdbeAssertFieldCountWithinLimits(
3657 int nKey, const void *pKey, /* The record to verify */
3658 const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
3659){
3660 int nField = 0;
3661 u32 szHdr;
3662 u32 idx;
3663 u32 notUsed;
3664 const unsigned char *aKey = (const unsigned char*)pKey;
3665
3666 if( CORRUPT_DB ) return;
3667 idx = getVarint32(aKey, szHdr);
mistachkin1b3ee492015-01-21 00:51:08 +00003668 assert( nKey>=0 );
3669 assert( szHdr<=(u32)nKey );
drhe1bb8022015-01-19 19:48:52 +00003670 while( idx<szHdr ){
3671 idx += getVarint32(aKey+idx, notUsed);
3672 nField++;
3673 }
3674 assert( nField <= pKeyInfo->nField+pKeyInfo->nXField );
3675}
drh1af3c642015-01-19 20:57:19 +00003676#else
3677# define vdbeAssertFieldCountWithinLimits(A,B,C)
drhe1bb8022015-01-19 19:48:52 +00003678#endif
3679
dan3833e932014-03-01 19:44:56 +00003680/*
3681** Both *pMem1 and *pMem2 contain string values. Compare the two values
3682** using the collation sequence pColl. As usual, return a negative , zero
3683** or positive value if *pMem1 is less than, equal to or greater than
3684** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
3685*/
dan1fed5da2014-02-25 21:01:25 +00003686static int vdbeCompareMemString(
dan3833e932014-03-01 19:44:56 +00003687 const Mem *pMem1,
3688 const Mem *pMem2,
dan38fdead2014-04-01 10:19:02 +00003689 const CollSeq *pColl,
3690 u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
dan1fed5da2014-02-25 21:01:25 +00003691){
3692 if( pMem1->enc==pColl->enc ){
3693 /* The strings are already in the correct encoding. Call the
3694 ** comparison function directly */
3695 return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
3696 }else{
3697 int rc;
3698 const void *v1, *v2;
3699 int n1, n2;
3700 Mem c1;
3701 Mem c2;
drh17bcb102014-09-18 21:25:33 +00003702 sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
3703 sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
dan1fed5da2014-02-25 21:01:25 +00003704 sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
3705 sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
3706 v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
3707 n1 = v1==0 ? 0 : c1.n;
3708 v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
3709 n2 = v2==0 ? 0 : c2.n;
3710 rc = pColl->xCmp(pColl->pUser, n1, v1, n2, v2);
mistachkinfad30392016-02-13 23:43:46 +00003711 if( (v1==0 || v2==0) && prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
dan1fed5da2014-02-25 21:01:25 +00003712 sqlite3VdbeMemRelease(&c1);
3713 sqlite3VdbeMemRelease(&c2);
3714 return rc;
3715 }
3716}
3717
3718/*
drh982ff722014-09-16 03:24:43 +00003719** Compare two blobs. Return negative, zero, or positive if the first
3720** is less than, equal to, or greater than the second, respectively.
3721** If one blob is a prefix of the other, then the shorter is the lessor.
3722*/
3723static SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
3724 int c = memcmp(pB1->z, pB2->z, pB1->n>pB2->n ? pB2->n : pB1->n);
3725 if( c ) return c;
3726 return pB1->n - pB2->n;
3727}
3728
drh2ab410a2015-11-06 14:59:07 +00003729/*
3730** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
3731** number. Return negative, zero, or positive if the first (i64) is less than,
3732** equal to, or greater than the second (double).
3733*/
3734static int sqlite3IntFloatCompare(i64 i, double r){
3735 if( sizeof(LONGDOUBLE_TYPE)>8 ){
3736 LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
3737 if( x<r ) return -1;
3738 if( x>r ) return +1;
3739 return 0;
3740 }else{
3741 i64 y;
3742 double s;
3743 if( r<-9223372036854775808.0 ) return +1;
3744 if( r>9223372036854775807.0 ) return -1;
3745 y = (i64)r;
3746 if( i<y ) return -1;
3747 if( i>y ){
3748 if( y==SMALLEST_INT64 && r>0.0 ) return -1;
3749 return +1;
3750 }
3751 s = (double)i;
3752 if( s<r ) return -1;
3753 if( s>r ) return +1;
3754 return 0;
3755 }
3756}
drh982ff722014-09-16 03:24:43 +00003757
3758/*
dan1fed5da2014-02-25 21:01:25 +00003759** Compare the values contained by the two memory cells, returning
3760** negative, zero or positive if pMem1 is less than, equal to, or greater
3761** than pMem2. Sorting order is NULL's first, followed by numbers (integers
3762** and reals) sorted numerically, followed by text ordered by the collating
3763** sequence pColl and finally blob's ordered by memcmp().
3764**
3765** Two NULL values are considered equal by this function.
3766*/
3767int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
dan1fed5da2014-02-25 21:01:25 +00003768 int f1, f2;
3769 int combined_flags;
3770
3771 f1 = pMem1->flags;
3772 f2 = pMem2->flags;
3773 combined_flags = f1|f2;
3774 assert( (combined_flags & MEM_RowSet)==0 );
3775
3776 /* If one value is NULL, it is less than the other. If both values
3777 ** are NULL, return 0.
drh8b249a82009-11-16 02:14:00 +00003778 */
dan1fed5da2014-02-25 21:01:25 +00003779 if( combined_flags&MEM_Null ){
3780 return (f2&MEM_Null) - (f1&MEM_Null);
3781 }
3782
drh2ab410a2015-11-06 14:59:07 +00003783 /* At least one of the two values is a number
dan1fed5da2014-02-25 21:01:25 +00003784 */
3785 if( combined_flags&(MEM_Int|MEM_Real) ){
dan1fed5da2014-02-25 21:01:25 +00003786 if( (f1 & f2 & MEM_Int)!=0 ){
3787 if( pMem1->u.i < pMem2->u.i ) return -1;
drh2ab410a2015-11-06 14:59:07 +00003788 if( pMem1->u.i > pMem2->u.i ) return +1;
dan1fed5da2014-02-25 21:01:25 +00003789 return 0;
3790 }
drh2ab410a2015-11-06 14:59:07 +00003791 if( (f1 & f2 & MEM_Real)!=0 ){
3792 if( pMem1->u.r < pMem2->u.r ) return -1;
3793 if( pMem1->u.r > pMem2->u.r ) return +1;
3794 return 0;
3795 }
3796 if( (f1&MEM_Int)!=0 ){
3797 if( (f2&MEM_Real)!=0 ){
3798 return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
3799 }else{
3800 return -1;
3801 }
3802 }
dan1fed5da2014-02-25 21:01:25 +00003803 if( (f1&MEM_Real)!=0 ){
drh2ab410a2015-11-06 14:59:07 +00003804 if( (f2&MEM_Int)!=0 ){
3805 return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
3806 }else{
3807 return -1;
3808 }
dan1fed5da2014-02-25 21:01:25 +00003809 }
drh2ab410a2015-11-06 14:59:07 +00003810 return +1;
dan1fed5da2014-02-25 21:01:25 +00003811 }
3812
3813 /* If one value is a string and the other is a blob, the string is less.
3814 ** If both are strings, compare using the collating functions.
3815 */
3816 if( combined_flags&MEM_Str ){
3817 if( (f1 & MEM_Str)==0 ){
3818 return 1;
3819 }
3820 if( (f2 & MEM_Str)==0 ){
3821 return -1;
3822 }
3823
drhe5520e22015-12-31 04:34:26 +00003824 assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
dan1fed5da2014-02-25 21:01:25 +00003825 assert( pMem1->enc==SQLITE_UTF8 ||
3826 pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
3827
3828 /* The collation sequence must be defined at this point, even if
3829 ** the user deletes the collation sequence after the vdbe program is
3830 ** compiled (this was not always the case).
3831 */
3832 assert( !pColl || pColl->xCmp );
3833
3834 if( pColl ){
dan38fdead2014-04-01 10:19:02 +00003835 return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
dan1fed5da2014-02-25 21:01:25 +00003836 }
3837 /* If a NULL pointer was passed as the collate function, fall through
3838 ** to the blob case and use memcmp(). */
3839 }
3840
3841 /* Both values must be blobs. Compare using memcmp(). */
drh982ff722014-09-16 03:24:43 +00003842 return sqlite3BlobCompare(pMem1, pMem2);
drh1e968a02008-03-25 00:22:21 +00003843}
dan1fed5da2014-02-25 21:01:25 +00003844
3845
dan3833e932014-03-01 19:44:56 +00003846/*
3847** The first argument passed to this function is a serial-type that
3848** corresponds to an integer - all values between 1 and 9 inclusive
3849** except 7. The second points to a buffer containing an integer value
3850** serialized according to serial_type. This function deserializes
3851** and returns the value.
3852*/
dan3b9330f2014-02-27 20:44:18 +00003853static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
drhf926d1e2014-03-04 04:04:33 +00003854 u32 y;
dan3833e932014-03-01 19:44:56 +00003855 assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
dan3b9330f2014-02-27 20:44:18 +00003856 switch( serial_type ){
dan3833e932014-03-01 19:44:56 +00003857 case 0:
dan3b9330f2014-02-27 20:44:18 +00003858 case 1:
drhb6e8fd12014-03-06 01:56:33 +00003859 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003860 return ONE_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003861 case 2:
drhb6e8fd12014-03-06 01:56:33 +00003862 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003863 return TWO_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003864 case 3:
drhb6e8fd12014-03-06 01:56:33 +00003865 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003866 return THREE_BYTE_INT(aKey);
3867 case 4: {
drhb6e8fd12014-03-06 01:56:33 +00003868 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003869 y = FOUR_BYTE_UINT(aKey);
3870 return (i64)*(int*)&y;
3871 }
dan3b9330f2014-02-27 20:44:18 +00003872 case 5: {
drhb6e8fd12014-03-06 01:56:33 +00003873 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003874 return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
danielk1977a7a8e142008-02-13 18:25:27 +00003875 }
dan3b9330f2014-02-27 20:44:18 +00003876 case 6: {
drhf926d1e2014-03-04 04:04:33 +00003877 u64 x = FOUR_BYTE_UINT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00003878 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003879 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
3880 return (i64)*(i64*)&x;
danielk19779a96b662007-11-29 17:05:18 +00003881 }
dan3b9330f2014-02-27 20:44:18 +00003882 }
danielk19779a96b662007-11-29 17:05:18 +00003883
dan3b9330f2014-02-27 20:44:18 +00003884 return (serial_type - 8);
danielk1977eb015e02004-05-18 01:31:14 +00003885}
danielk1977eb015e02004-05-18 01:31:14 +00003886
dan3833e932014-03-01 19:44:56 +00003887/*
3888** This function compares the two table rows or index records
3889** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
3890** or positive integer if key1 is less than, equal to or
3891** greater than key2. The {nKey1, pKey1} key must be a blob
peter.d.reid60ec9142014-09-06 16:39:46 +00003892** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
dan3833e932014-03-01 19:44:56 +00003893** key must be a parsed key such as obtained from
3894** sqlite3VdbeParseRecord.
3895**
3896** If argument bSkip is non-zero, it is assumed that the caller has already
3897** determined that the first fields of the keys are equal.
3898**
3899** Key1 and Key2 do not have to contain the same number of fields. If all
3900** fields that appear in both keys are equal, then pPKey2->default_rc is
3901** returned.
drha1f7c0a2014-03-28 03:12:48 +00003902**
dan38fdead2014-04-01 10:19:02 +00003903** If database corruption is discovered, set pPKey2->errCode to
3904** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
3905** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
3906** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
dan3833e932014-03-01 19:44:56 +00003907*/
dan7004f3f2015-03-30 12:06:26 +00003908int sqlite3VdbeRecordCompareWithSkip(
dan3833e932014-03-01 19:44:56 +00003909 int nKey1, const void *pKey1, /* Left key */
drha1f7c0a2014-03-28 03:12:48 +00003910 UnpackedRecord *pPKey2, /* Right key */
dan3833e932014-03-01 19:44:56 +00003911 int bSkip /* If true, skip the first field */
dan1fed5da2014-02-25 21:01:25 +00003912){
dan3833e932014-03-01 19:44:56 +00003913 u32 d1; /* Offset into aKey[] of next data element */
3914 int i; /* Index of next field to compare */
mistachkinffe6bc22014-03-04 11:16:20 +00003915 u32 szHdr1; /* Size of record header in bytes */
dan3833e932014-03-01 19:44:56 +00003916 u32 idx1; /* Offset of first type in header */
3917 int rc = 0; /* Return value */
3918 Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
dan1fed5da2014-02-25 21:01:25 +00003919 KeyInfo *pKeyInfo = pPKey2->pKeyInfo;
3920 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3921 Mem mem1;
3922
dan3833e932014-03-01 19:44:56 +00003923 /* If bSkip is true, then the caller has already determined that the first
3924 ** two elements in the keys are equal. Fix the various stack variables so
dan3b9330f2014-02-27 20:44:18 +00003925 ** that this routine begins comparing at the second field. */
dan3833e932014-03-01 19:44:56 +00003926 if( bSkip ){
dan3b9330f2014-02-27 20:44:18 +00003927 u32 s1;
dan3b9330f2014-02-27 20:44:18 +00003928 idx1 = 1 + getVarint32(&aKey1[1], s1);
dan3833e932014-03-01 19:44:56 +00003929 szHdr1 = aKey1[0];
3930 d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
dan3b9330f2014-02-27 20:44:18 +00003931 i = 1;
3932 pRhs++;
dan3833e932014-03-01 19:44:56 +00003933 }else{
3934 idx1 = getVarint32(aKey1, szHdr1);
3935 d1 = szHdr1;
drha1f7c0a2014-03-28 03:12:48 +00003936 if( d1>(unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00003937 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00003938 return 0; /* Corruption */
3939 }
dan3833e932014-03-01 19:44:56 +00003940 i = 0;
dan3b9330f2014-02-27 20:44:18 +00003941 }
3942
drh17bcb102014-09-18 21:25:33 +00003943 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
dan1fed5da2014-02-25 21:01:25 +00003944 assert( pPKey2->pKeyInfo->nField+pPKey2->pKeyInfo->nXField>=pPKey2->nField
3945 || CORRUPT_DB );
3946 assert( pPKey2->pKeyInfo->aSortOrder!=0 );
3947 assert( pPKey2->pKeyInfo->nField>0 );
3948 assert( idx1<=szHdr1 || CORRUPT_DB );
3949 do{
dan1fed5da2014-02-25 21:01:25 +00003950 u32 serial_type;
3951
3952 /* RHS is an integer */
3953 if( pRhs->flags & MEM_Int ){
3954 serial_type = aKey1[idx1];
drhb6e8fd12014-03-06 01:56:33 +00003955 testcase( serial_type==12 );
danb95e1192015-05-26 20:31:20 +00003956 if( serial_type>=10 ){
dan1fed5da2014-02-25 21:01:25 +00003957 rc = +1;
3958 }else if( serial_type==0 ){
3959 rc = -1;
dan3b9330f2014-02-27 20:44:18 +00003960 }else if( serial_type==7 ){
dan1fed5da2014-02-25 21:01:25 +00003961 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
drh2ab410a2015-11-06 14:59:07 +00003962 rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
dan3b9330f2014-02-27 20:44:18 +00003963 }else{
3964 i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
3965 i64 rhs = pRhs->u.i;
3966 if( lhs<rhs ){
3967 rc = -1;
3968 }else if( lhs>rhs ){
3969 rc = +1;
dan1fed5da2014-02-25 21:01:25 +00003970 }
3971 }
3972 }
3973
3974 /* RHS is real */
3975 else if( pRhs->flags & MEM_Real ){
3976 serial_type = aKey1[idx1];
dancc7aa1f2015-05-26 20:07:32 +00003977 if( serial_type>=10 ){
3978 /* Serial types 12 or greater are strings and blobs (greater than
3979 ** numbers). Types 10 and 11 are currently "reserved for future
3980 ** use", so it doesn't really matter what the results of comparing
3981 ** them to numberic values are. */
dan1fed5da2014-02-25 21:01:25 +00003982 rc = +1;
3983 }else if( serial_type==0 ){
3984 rc = -1;
3985 }else{
dan1fed5da2014-02-25 21:01:25 +00003986 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
3987 if( serial_type==7 ){
drh2ab410a2015-11-06 14:59:07 +00003988 if( mem1.u.r<pRhs->u.r ){
3989 rc = -1;
3990 }else if( mem1.u.r>pRhs->u.r ){
3991 rc = +1;
3992 }
dan1fed5da2014-02-25 21:01:25 +00003993 }else{
drh2ab410a2015-11-06 14:59:07 +00003994 rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
dan1fed5da2014-02-25 21:01:25 +00003995 }
3996 }
3997 }
3998
3999 /* RHS is a string */
4000 else if( pRhs->flags & MEM_Str ){
4001 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004002 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004003 if( serial_type<12 ){
4004 rc = -1;
4005 }else if( !(serial_type & 0x01) ){
4006 rc = +1;
4007 }else{
4008 mem1.n = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004009 testcase( (d1+mem1.n)==(unsigned)nKey1 );
4010 testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004011 if( (d1+mem1.n) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004012 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004013 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00004014 }else if( pKeyInfo->aColl[i] ){
4015 mem1.enc = pKeyInfo->enc;
4016 mem1.db = pKeyInfo->db;
4017 mem1.flags = MEM_Str;
drhfcb44a82014-03-03 15:13:27 +00004018 mem1.z = (char*)&aKey1[d1];
dan38fdead2014-04-01 10:19:02 +00004019 rc = vdbeCompareMemString(
4020 &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
4021 );
dan1fed5da2014-02-25 21:01:25 +00004022 }else{
4023 int nCmp = MIN(mem1.n, pRhs->n);
4024 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4025 if( rc==0 ) rc = mem1.n - pRhs->n;
4026 }
4027 }
4028 }
4029
4030 /* RHS is a blob */
4031 else if( pRhs->flags & MEM_Blob ){
4032 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004033 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004034 if( serial_type<12 || (serial_type & 0x01) ){
4035 rc = -1;
4036 }else{
4037 int nStr = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004038 testcase( (d1+nStr)==(unsigned)nKey1 );
4039 testcase( (d1+nStr+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004040 if( (d1+nStr) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004041 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004042 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00004043 }else{
4044 int nCmp = MIN(nStr, pRhs->n);
4045 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4046 if( rc==0 ) rc = nStr - pRhs->n;
4047 }
4048 }
4049 }
4050
4051 /* RHS is null */
4052 else{
4053 serial_type = aKey1[idx1];
4054 rc = (serial_type!=0);
4055 }
4056
4057 if( rc!=0 ){
dan1fed5da2014-02-25 21:01:25 +00004058 if( pKeyInfo->aSortOrder[i] ){
4059 rc = -rc;
dan1fed5da2014-02-25 21:01:25 +00004060 }
drh79211e12014-05-02 17:33:16 +00004061 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
drh17bcb102014-09-18 21:25:33 +00004062 assert( mem1.szMalloc==0 ); /* See comment below */
dan1fed5da2014-02-25 21:01:25 +00004063 return rc;
4064 }
4065
4066 i++;
dan3b9330f2014-02-27 20:44:18 +00004067 pRhs++;
dan1fed5da2014-02-25 21:01:25 +00004068 d1 += sqlite3VdbeSerialTypeLen(serial_type);
4069 idx1 += sqlite3VarintLen(serial_type);
drh295aedf2014-03-03 18:25:24 +00004070 }while( idx1<(unsigned)szHdr1 && i<pPKey2->nField && d1<=(unsigned)nKey1 );
dan1fed5da2014-02-25 21:01:25 +00004071
4072 /* No memory allocation is ever used on mem1. Prove this using
4073 ** the following assert(). If the assert() fails, it indicates a
dan3833e932014-03-01 19:44:56 +00004074 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
drh17bcb102014-09-18 21:25:33 +00004075 assert( mem1.szMalloc==0 );
dan1fed5da2014-02-25 21:01:25 +00004076
4077 /* rc==0 here means that one or both of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004078 ** all the fields up to that point were equal. Return the default_rc
dan1fed5da2014-02-25 21:01:25 +00004079 ** value. */
dan3833e932014-03-01 19:44:56 +00004080 assert( CORRUPT_DB
drh66141812014-06-30 20:25:03 +00004081 || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
dan6696ba32014-06-28 19:06:49 +00004082 || pKeyInfo->db->mallocFailed
dan3833e932014-03-01 19:44:56 +00004083 );
drh70528d72015-11-05 20:25:09 +00004084 pPKey2->eqSeen = 1;
dan1fed5da2014-02-25 21:01:25 +00004085 return pPKey2->default_rc;
4086}
drh75179de2014-09-16 14:37:35 +00004087int sqlite3VdbeRecordCompare(
4088 int nKey1, const void *pKey1, /* Left key */
4089 UnpackedRecord *pPKey2 /* Right key */
4090){
dan7004f3f2015-03-30 12:06:26 +00004091 return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
drh75179de2014-09-16 14:37:35 +00004092}
4093
dan1fed5da2014-02-25 21:01:25 +00004094
dan3833e932014-03-01 19:44:56 +00004095/*
4096** This function is an optimized version of sqlite3VdbeRecordCompare()
4097** that (a) the first field of pPKey2 is an integer, and (b) the
4098** size-of-header varint at the start of (pKey1/nKey1) fits in a single
4099** byte (i.e. is less than 128).
drhe2ac5062014-03-26 12:02:38 +00004100**
4101** To avoid concerns about buffer overreads, this routine is only used
4102** on schemas where the maximum valid header size is 63 bytes or less.
dan3833e932014-03-01 19:44:56 +00004103*/
dan3b9330f2014-02-27 20:44:18 +00004104static int vdbeRecordCompareInt(
4105 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004106 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004107){
dan9b8afef2014-03-03 20:48:50 +00004108 const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
dan3b9330f2014-02-27 20:44:18 +00004109 int serial_type = ((const u8*)pKey1)[1];
4110 int res;
drhf926d1e2014-03-04 04:04:33 +00004111 u32 y;
4112 u64 x;
dan3b9330f2014-02-27 20:44:18 +00004113 i64 v = pPKey2->aMem[0].u.i;
4114 i64 lhs;
4115
drhe1bb8022015-01-19 19:48:52 +00004116 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drhe2ac5062014-03-26 12:02:38 +00004117 assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
dan3833e932014-03-01 19:44:56 +00004118 switch( serial_type ){
drhf926d1e2014-03-04 04:04:33 +00004119 case 1: { /* 1-byte signed integer */
4120 lhs = ONE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004121 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004122 break;
4123 }
drhf926d1e2014-03-04 04:04:33 +00004124 case 2: { /* 2-byte signed integer */
4125 lhs = TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004126 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004127 break;
4128 }
4129 case 3: { /* 3-byte signed integer */
4130 lhs = THREE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004131 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004132 break;
4133 }
4134 case 4: { /* 4-byte signed integer */
4135 y = FOUR_BYTE_UINT(aKey);
4136 lhs = (i64)*(int*)&y;
drhb6e8fd12014-03-06 01:56:33 +00004137 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004138 break;
4139 }
4140 case 5: { /* 6-byte signed integer */
4141 lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004142 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004143 break;
4144 }
4145 case 6: { /* 8-byte signed integer */
4146 x = FOUR_BYTE_UINT(aKey);
4147 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4148 lhs = *(i64*)&x;
drhb6e8fd12014-03-06 01:56:33 +00004149 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004150 break;
4151 }
dan3b9330f2014-02-27 20:44:18 +00004152 case 8:
4153 lhs = 0;
4154 break;
dan3b9330f2014-02-27 20:44:18 +00004155 case 9:
4156 lhs = 1;
4157 break;
4158
dan063d4a02014-02-28 09:48:30 +00004159 /* This case could be removed without changing the results of running
4160 ** this code. Including it causes gcc to generate a faster switch
4161 ** statement (since the range of switch targets now starts at zero and
dan597515d2014-02-28 18:39:51 +00004162 ** is contiguous) but does not cause any duplicate code to be generated
dan063d4a02014-02-28 09:48:30 +00004163 ** (as gcc is clever enough to combine the two like cases). Other
4164 ** compilers might be similar. */
4165 case 0: case 7:
drh75179de2014-09-16 14:37:35 +00004166 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan063d4a02014-02-28 09:48:30 +00004167
dan3b9330f2014-02-27 20:44:18 +00004168 default:
drh75179de2014-09-16 14:37:35 +00004169 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan3b9330f2014-02-27 20:44:18 +00004170 }
4171
4172 if( v>lhs ){
4173 res = pPKey2->r1;
4174 }else if( v<lhs ){
4175 res = pPKey2->r2;
4176 }else if( pPKey2->nField>1 ){
dan063d4a02014-02-28 09:48:30 +00004177 /* The first fields of the two keys are equal. Compare the trailing
4178 ** fields. */
dan7004f3f2015-03-30 12:06:26 +00004179 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004180 }else{
dan063d4a02014-02-28 09:48:30 +00004181 /* The first fields of the two keys are equal and there are no trailing
4182 ** fields. Return pPKey2->default_rc in this case. */
dan3b9330f2014-02-27 20:44:18 +00004183 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004184 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004185 }
4186
drh79211e12014-05-02 17:33:16 +00004187 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
dan3b9330f2014-02-27 20:44:18 +00004188 return res;
4189}
4190
dan3833e932014-03-01 19:44:56 +00004191/*
4192** This function is an optimized version of sqlite3VdbeRecordCompare()
4193** that (a) the first field of pPKey2 is a string, that (b) the first field
4194** uses the collation sequence BINARY and (c) that the size-of-header varint
4195** at the start of (pKey1/nKey1) fits in a single byte.
4196*/
dan3b9330f2014-02-27 20:44:18 +00004197static int vdbeRecordCompareString(
4198 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004199 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004200){
4201 const u8 *aKey1 = (const u8*)pKey1;
4202 int serial_type;
4203 int res;
4204
drh2ab410a2015-11-06 14:59:07 +00004205 assert( pPKey2->aMem[0].flags & MEM_Str );
drhe1bb8022015-01-19 19:48:52 +00004206 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
dan3b9330f2014-02-27 20:44:18 +00004207 getVarint32(&aKey1[1], serial_type);
dan3b9330f2014-02-27 20:44:18 +00004208 if( serial_type<12 ){
4209 res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
4210 }else if( !(serial_type & 0x01) ){
4211 res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
4212 }else{
4213 int nCmp;
4214 int nStr;
dan3833e932014-03-01 19:44:56 +00004215 int szHdr = aKey1[0];
dan3b9330f2014-02-27 20:44:18 +00004216
4217 nStr = (serial_type-12) / 2;
drha1f7c0a2014-03-28 03:12:48 +00004218 if( (szHdr + nStr) > nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004219 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004220 return 0; /* Corruption */
4221 }
dan3b9330f2014-02-27 20:44:18 +00004222 nCmp = MIN( pPKey2->aMem[0].n, nStr );
dan3833e932014-03-01 19:44:56 +00004223 res = memcmp(&aKey1[szHdr], pPKey2->aMem[0].z, nCmp);
dan3b9330f2014-02-27 20:44:18 +00004224
4225 if( res==0 ){
4226 res = nStr - pPKey2->aMem[0].n;
4227 if( res==0 ){
4228 if( pPKey2->nField>1 ){
dan7004f3f2015-03-30 12:06:26 +00004229 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004230 }else{
4231 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004232 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004233 }
4234 }else if( res>0 ){
4235 res = pPKey2->r2;
4236 }else{
4237 res = pPKey2->r1;
4238 }
4239 }else if( res>0 ){
4240 res = pPKey2->r2;
4241 }else{
4242 res = pPKey2->r1;
4243 }
4244 }
4245
drh66141812014-06-30 20:25:03 +00004246 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
dan3b9330f2014-02-27 20:44:18 +00004247 || CORRUPT_DB
dan6696ba32014-06-28 19:06:49 +00004248 || pPKey2->pKeyInfo->db->mallocFailed
dan3b9330f2014-02-27 20:44:18 +00004249 );
4250 return res;
4251}
4252
dan3833e932014-03-01 19:44:56 +00004253/*
4254** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
4255** suitable for comparing serialized records to the unpacked record passed
4256** as the only argument.
4257*/
dan1fed5da2014-02-25 21:01:25 +00004258RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
dan9b8afef2014-03-03 20:48:50 +00004259 /* varintRecordCompareInt() and varintRecordCompareString() both assume
4260 ** that the size-of-header varint that occurs at the start of each record
4261 ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
4262 ** also assumes that it is safe to overread a buffer by at least the
4263 ** maximum possible legal header size plus 8 bytes. Because there is
4264 ** guaranteed to be at least 74 (but not 136) bytes of padding following each
4265 ** buffer passed to varintRecordCompareInt() this makes it convenient to
4266 ** limit the size of the header to 64 bytes in cases where the first field
4267 ** is an integer.
4268 **
4269 ** The easiest way to enforce this limit is to consider only records with
4270 ** 13 fields or less. If the first field is an integer, the maximum legal
4271 ** header size is (12*5 + 1 + 1) bytes. */
4272 if( (p->pKeyInfo->nField + p->pKeyInfo->nXField)<=13 ){
dan1fed5da2014-02-25 21:01:25 +00004273 int flags = p->aMem[0].flags;
dan3b9330f2014-02-27 20:44:18 +00004274 if( p->pKeyInfo->aSortOrder[0] ){
4275 p->r1 = 1;
4276 p->r2 = -1;
4277 }else{
4278 p->r1 = -1;
4279 p->r2 = 1;
4280 }
dan1fed5da2014-02-25 21:01:25 +00004281 if( (flags & MEM_Int) ){
4282 return vdbeRecordCompareInt;
dan3b9330f2014-02-27 20:44:18 +00004283 }
drhb6e8fd12014-03-06 01:56:33 +00004284 testcase( flags & MEM_Real );
4285 testcase( flags & MEM_Null );
4286 testcase( flags & MEM_Blob );
4287 if( (flags & (MEM_Real|MEM_Null|MEM_Blob))==0 && p->pKeyInfo->aColl[0]==0 ){
4288 assert( flags & MEM_Str );
dan1fed5da2014-02-25 21:01:25 +00004289 return vdbeRecordCompareString;
4290 }
4291 }
dan3b9330f2014-02-27 20:44:18 +00004292
dan3833e932014-03-01 19:44:56 +00004293 return sqlite3VdbeRecordCompare;
dan3b9330f2014-02-27 20:44:18 +00004294}
danielk1977eb015e02004-05-18 01:31:14 +00004295
4296/*
drh7a224de2004-06-02 01:22:02 +00004297** pCur points at an index entry created using the OP_MakeRecord opcode.
4298** Read the rowid (the last field in the record) and store it in *rowid.
4299** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00004300**
4301** pCur might be pointing to text obtained from a corrupt database file.
4302** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00004303*/
drh35f6b932009-06-23 14:15:04 +00004304int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00004305 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004306 int rc;
drhd5788202004-05-28 08:21:05 +00004307 u32 szHdr; /* Size of the header */
4308 u32 typeRowid; /* Serial type of the rowid */
4309 u32 lenRowid; /* Size of the rowid */
4310 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00004311
drh88a003e2008-12-11 16:17:03 +00004312 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00004313 ** than 2GiB are support - anything large must be database corruption.
4314 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00004315 ** this code can safely assume that nCellKey is 32-bits
4316 */
drhea8ffdf2009-07-22 00:35:23 +00004317 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00004318 nCellKey = sqlite3BtreePayloadSize(pCur);
drh7b746032009-06-26 12:15:22 +00004319 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00004320
4321 /* Read in the complete content of the index entry */
drhd3b74202014-09-17 16:41:15 +00004322 sqlite3VdbeMemInit(&m, db, 0);
drh501932c2013-11-21 21:59:53 +00004323 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhd5788202004-05-28 08:21:05 +00004324 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00004325 return rc;
4326 }
drh88a003e2008-12-11 16:17:03 +00004327
4328 /* The index entry must begin with a header size */
shane3f8d5cf2008-04-24 19:15:09 +00004329 (void)getVarint32((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00004330 testcase( szHdr==3 );
drh88a003e2008-12-11 16:17:03 +00004331 testcase( szHdr==m.n );
drh7b746032009-06-26 12:15:22 +00004332 if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
drh88a003e2008-12-11 16:17:03 +00004333 goto idx_rowid_corruption;
4334 }
4335
4336 /* The last field of the index should be an integer - the ROWID.
4337 ** Verify that the last entry really is an integer. */
shane3f8d5cf2008-04-24 19:15:09 +00004338 (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00004339 testcase( typeRowid==1 );
4340 testcase( typeRowid==2 );
4341 testcase( typeRowid==3 );
4342 testcase( typeRowid==4 );
4343 testcase( typeRowid==5 );
4344 testcase( typeRowid==6 );
4345 testcase( typeRowid==8 );
4346 testcase( typeRowid==9 );
4347 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
4348 goto idx_rowid_corruption;
4349 }
drhc5ef7152015-06-28 02:58:51 +00004350 lenRowid = sqlite3SmallTypeSizes[typeRowid];
drheeb844a2009-08-08 18:01:07 +00004351 testcase( (u32)m.n==szHdr+lenRowid );
4352 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00004353 goto idx_rowid_corruption;
4354 }
4355
4356 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00004357 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00004358 *rowid = v.u.i;
danielk1977d8123362004-06-12 09:25:12 +00004359 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004360 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00004361
4362 /* Jump here if database corruption is detected after m has been
4363 ** allocated. Free the m object and return SQLITE_CORRUPT. */
4364idx_rowid_corruption:
drh17bcb102014-09-18 21:25:33 +00004365 testcase( m.szMalloc!=0 );
drh88a003e2008-12-11 16:17:03 +00004366 sqlite3VdbeMemRelease(&m);
4367 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004368}
4369
drh7cf6e4d2004-05-19 14:56:55 +00004370/*
drh5f82e3c2009-07-06 00:44:08 +00004371** Compare the key of the index entry that cursor pC is pointing to against
4372** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00004373** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00004374** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00004375**
drh5f82e3c2009-07-06 00:44:08 +00004376** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00004377** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00004378** is ignored as well. Hence, this routine only compares the prefixes
4379** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00004380*/
danielk1977183f9f72004-05-13 05:20:26 +00004381int sqlite3VdbeIdxKeyCompare(
drhd3b74202014-09-17 16:41:15 +00004382 sqlite3 *db, /* Database connection */
drh295aedf2014-03-03 18:25:24 +00004383 VdbeCursor *pC, /* The cursor to compare against */
drha1f7c0a2014-03-28 03:12:48 +00004384 UnpackedRecord *pUnpacked, /* Unpacked version of key */
drh295aedf2014-03-03 18:25:24 +00004385 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00004386){
drh61fc5952007-04-01 23:49:51 +00004387 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004388 int rc;
drhc960dcb2015-11-20 19:22:01 +00004389 BtCursor *pCur;
drhd5788202004-05-28 08:21:05 +00004390 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00004391
drhc960dcb2015-11-20 19:22:01 +00004392 assert( pC->eCurType==CURTYPE_BTREE );
4393 pCur = pC->uc.pCursor;
drhea8ffdf2009-07-22 00:35:23 +00004394 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00004395 nCellKey = sqlite3BtreePayloadSize(pCur);
drh56689692014-03-03 19:29:28 +00004396 /* nCellKey will always be between 0 and 0xffffffff because of the way
drh407414c2009-07-14 14:15:27 +00004397 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00004398 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00004399 *res = 0;
drh9978c972010-02-23 17:36:32 +00004400 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004401 }
drhd3b74202014-09-17 16:41:15 +00004402 sqlite3VdbeMemInit(&m, db, 0);
drhc960dcb2015-11-20 19:22:01 +00004403 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhec1fc802008-08-13 14:07:40 +00004404 if( rc ){
drhd5788202004-05-28 08:21:05 +00004405 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00004406 }
drh75179de2014-09-16 14:37:35 +00004407 *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
danielk1977d8123362004-06-12 09:25:12 +00004408 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004409 return SQLITE_OK;
4410}
danielk1977b28af712004-06-21 06:50:26 +00004411
4412/*
4413** This routine sets the value to be returned by subsequent calls to
4414** sqlite3_changes() on the database handle 'db'.
4415*/
4416void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
drhb21c8cd2007-08-21 19:33:56 +00004417 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00004418 db->nChange = nChange;
4419 db->nTotalChange += nChange;
4420}
4421
4422/*
4423** Set a flag in the vdbe to update the change counter when it is finalised
4424** or reset.
4425*/
drh4794f732004-11-05 17:17:50 +00004426void sqlite3VdbeCountChanges(Vdbe *v){
4427 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00004428}
drhd89bd002005-01-22 03:03:54 +00004429
4430/*
4431** Mark every prepared statement associated with a database connection
4432** as expired.
4433**
4434** An expired statement means that recompilation of the statement is
4435** recommend. Statements expire when things happen that make their
4436** programs obsolete. Removing user-defined functions or collating
4437** sequences, or changing an authorization function are the types of
4438** things that make prepared statements obsolete.
4439*/
4440void sqlite3ExpirePreparedStatements(sqlite3 *db){
4441 Vdbe *p;
4442 for(p = db->pVdbe; p; p=p->pNext){
4443 p->expired = 1;
4444 }
4445}
danielk1977aee18ef2005-03-09 12:26:50 +00004446
4447/*
4448** Return the database associated with the Vdbe.
4449*/
4450sqlite3 *sqlite3VdbeDb(Vdbe *v){
4451 return v->db;
4452}
dan937d0de2009-10-15 18:35:38 +00004453
4454/*
4455** Return a pointer to an sqlite3_value structure containing the value bound
4456** parameter iVar of VM v. Except, if the value is an SQL NULL, return
4457** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
4458** constants) to the value before returning it.
4459**
4460** The returned value must be freed by the caller using sqlite3ValueFree().
4461*/
drhcf0fd4a2013-08-01 12:21:58 +00004462sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00004463 assert( iVar>0 );
4464 if( v ){
4465 Mem *pMem = &v->aVar[iVar-1];
4466 if( 0==(pMem->flags & MEM_Null) ){
4467 sqlite3_value *pRet = sqlite3ValueNew(v->db);
4468 if( pRet ){
4469 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
4470 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
dan937d0de2009-10-15 18:35:38 +00004471 }
4472 return pRet;
4473 }
4474 }
4475 return 0;
4476}
4477
4478/*
4479** Configure SQL variable iVar so that binding a new value to it signals
4480** to sqlite3_reoptimize() that re-preparing the statement may result
4481** in a better query plan.
4482*/
dan1d2ce4f2009-10-19 18:11:09 +00004483void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00004484 assert( iVar>0 );
4485 if( iVar>32 ){
dan1d2ce4f2009-10-19 18:11:09 +00004486 v->expmask = 0xffffffff;
dan937d0de2009-10-15 18:35:38 +00004487 }else{
dan1d2ce4f2009-10-19 18:11:09 +00004488 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00004489 }
4490}
dan46c47d42011-03-01 18:42:07 +00004491
dan016f7812013-08-21 17:35:48 +00004492#ifndef SQLITE_OMIT_VIRTUALTABLE
4493/*
4494** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
4495** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
4496** in memory obtained from sqlite3DbMalloc).
4497*/
4498void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
dan5c3aa052016-01-20 08:47:55 +00004499 if( pVtab->zErrMsg ){
4500 sqlite3 *db = p->db;
4501 sqlite3DbFree(db, p->zErrMsg);
4502 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
4503 sqlite3_free(pVtab->zErrMsg);
4504 pVtab->zErrMsg = 0;
4505 }
dan016f7812013-08-21 17:35:48 +00004506}
4507#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh32683532013-08-22 15:07:08 +00004508
drh9b1c62d2011-03-30 21:04:43 +00004509#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan93bca692011-09-14 19:41:44 +00004510
4511/*
4512** If the second argument is not NULL, release any allocations associated
4513** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
4514** structure itself, using sqlite3DbFree().
4515**
4516** This function is used to free UnpackedRecord structures allocated by
4517** the vdbeUnpackRecord() function found in vdbeapi.c.
4518*/
4519static void vdbeFreeUnpacked(sqlite3 *db, UnpackedRecord *p){
4520 if( p ){
4521 int i;
4522 for(i=0; i<p->nField; i++){
4523 Mem *pMem = &p->aMem[i];
4524 if( pMem->zMalloc ) sqlite3VdbeMemRelease(pMem);
4525 }
4526 sqlite3DbFree(db, p);
4527 }
4528}
drh74c33022016-03-30 12:56:55 +00004529#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan93bca692011-09-14 19:41:44 +00004530
drh74c33022016-03-30 12:56:55 +00004531#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00004532/*
4533** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
4534** then cursor passed as the second argument should point to the row about
4535** to be update or deleted. If the application calls sqlite3_preupdate_old(),
4536** the required value will be read from the row the cursor points to.
4537*/
4538void sqlite3VdbePreUpdateHook(
4539 Vdbe *v, /* Vdbe pre-update hook is invoked by */
4540 VdbeCursor *pCsr, /* Cursor to grab old.* values from */
4541 int op, /* SQLITE_INSERT, UPDATE or DELETE */
4542 const char *zDb, /* Database name */
dan319eeb72011-03-19 08:38:50 +00004543 Table *pTab, /* Modified table */
dan46c47d42011-03-01 18:42:07 +00004544 i64 iKey1, /* Initial key value */
dan37db03b2011-03-16 19:59:18 +00004545 int iReg /* Register for new.* record */
dan46c47d42011-03-01 18:42:07 +00004546){
4547 sqlite3 *db = v->db;
dan37db03b2011-03-16 19:59:18 +00004548 i64 iKey2;
dan46c47d42011-03-01 18:42:07 +00004549 PreUpdate preupdate;
dan319eeb72011-03-19 08:38:50 +00004550 const char *zTbl = pTab->zName;
drhc4645da2012-09-28 13:05:48 +00004551 static const u8 fakeSortOrder = 0;
dan46c47d42011-03-01 18:42:07 +00004552
drh304637c2011-03-18 16:47:27 +00004553 assert( db->pPreUpdate==0 );
4554 memset(&preupdate, 0, sizeof(PreUpdate));
dan37db03b2011-03-16 19:59:18 +00004555 if( op==SQLITE_UPDATE ){
4556 iKey2 = v->aMem[iReg].u.i;
4557 }else{
4558 iKey2 = iKey1;
4559 }
4560
dane437ca52011-07-11 19:45:38 +00004561 assert( pCsr->nField==pTab->nCol
4562 || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
4563 );
4564
dan37db03b2011-03-16 19:59:18 +00004565 preupdate.v = v;
dan46c47d42011-03-01 18:42:07 +00004566 preupdate.pCsr = pCsr;
4567 preupdate.op = op;
dan37db03b2011-03-16 19:59:18 +00004568 preupdate.iNewReg = iReg;
dan4fccf432011-03-08 19:22:50 +00004569 preupdate.keyinfo.db = db;
4570 preupdate.keyinfo.enc = ENC(db);
dane437ca52011-07-11 19:45:38 +00004571 preupdate.keyinfo.nField = pTab->nCol;
drh498dcae2013-03-13 11:42:00 +00004572 preupdate.keyinfo.aSortOrder = (u8*)&fakeSortOrder;
dan319eeb72011-03-19 08:38:50 +00004573 preupdate.iKey1 = iKey1;
4574 preupdate.iKey2 = iKey2;
4575 preupdate.iPKey = pTab->iPKey;
4576
dan46c47d42011-03-01 18:42:07 +00004577 db->pPreUpdate = &preupdate;
4578 db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
4579 db->pPreUpdate = 0;
4580 sqlite3DbFree(db, preupdate.aRecord);
dan93bca692011-09-14 19:41:44 +00004581 vdbeFreeUnpacked(db, preupdate.pUnpacked);
4582 vdbeFreeUnpacked(db, preupdate.pNewUnpacked);
dan37db03b2011-03-16 19:59:18 +00004583 if( preupdate.aNew ){
4584 int i;
4585 for(i=0; i<pCsr->nField; i++){
4586 sqlite3VdbeMemRelease(&preupdate.aNew[i]);
4587 }
drhea022cf2011-03-18 15:13:31 +00004588 sqlite3DbFree(db, preupdate.aNew);
dan37db03b2011-03-16 19:59:18 +00004589 }
dan46c47d42011-03-01 18:42:07 +00004590}
drh9b1c62d2011-03-30 21:04:43 +00004591#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */