blob: 8eb3141dafcfda00c3bd1a46e6842fa9f8c63039 [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;
drhc5155252007-01-08 21:07:17 +000081 tmp = *pA;
82 *pA = *pB;
83 *pB = tmp;
84 pTmp = pA->pNext;
85 pA->pNext = pB->pNext;
86 pB->pNext = pTmp;
87 pTmp = pA->pPrev;
88 pA->pPrev = pB->pPrev;
89 pB->pPrev = pTmp;
90 zTmp = pA->zSql;
91 pA->zSql = pB->zSql;
92 pB->zSql = zTmp;
danielk19776ab3a2e2009-02-19 14:39:25 +000093 pB->isPrepareV2 = pA->isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000094}
95
drh9a324642003-09-06 20:12:01 +000096/*
dan76ccd892014-08-12 13:38:52 +000097** Resize the Vdbe.aOp array so that it is at least nOp elements larger
drh81e069e2014-08-12 14:29:20 +000098** than its current size. nOp is guaranteed to be less than or equal
99** to 1024/sizeof(Op).
danielk1977ace3eb22006-01-26 10:35:04 +0000100**
danielk197700e13612008-11-17 19:18:54 +0000101** If an out-of-memory error occurs while resizing the array, return
dan76ccd892014-08-12 13:38:52 +0000102** SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
danielk197700e13612008-11-17 19:18:54 +0000103** unchanged (this is so that any opcodes already allocated can be
104** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +0000105*/
dan76ccd892014-08-12 13:38:52 +0000106static int growOpArray(Vdbe *v, int nOp){
drha4e5d582007-10-20 15:41:57 +0000107 VdbeOp *pNew;
drh73d5b8f2013-12-23 19:09:07 +0000108 Parse *p = v->pParse;
dan76ccd892014-08-12 13:38:52 +0000109
drh81e069e2014-08-12 14:29:20 +0000110 /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
111 ** more frequent reallocs and hence provide more opportunities for
112 ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
113 ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
114 ** by the minimum* amount required until the size reaches 512. Normal
115 ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
116 ** size of the op array or add 1KB of space, whichever is smaller. */
dan76ccd892014-08-12 13:38:52 +0000117#ifdef SQLITE_TEST_REALLOC_STRESS
118 int nNew = (p->nOpAlloc>=512 ? p->nOpAlloc*2 : p->nOpAlloc+nOp);
119#else
danielk197700e13612008-11-17 19:18:54 +0000120 int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
dan76ccd892014-08-12 13:38:52 +0000121 UNUSED_PARAMETER(nOp);
122#endif
123
drh81e069e2014-08-12 14:29:20 +0000124 assert( nOp<=(1024/sizeof(Op)) );
dan76ccd892014-08-12 13:38:52 +0000125 assert( nNew>=(p->nOpAlloc+nOp) );
drh73d5b8f2013-12-23 19:09:07 +0000126 pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +0000127 if( pNew ){
drhbd573082016-01-01 16:42:09 +0000128 p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
129 p->nOpAlloc = p->szOpAlloc/sizeof(Op);
drh73d5b8f2013-12-23 19:09:07 +0000130 v->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +0000131 }
danielk197700e13612008-11-17 19:18:54 +0000132 return (pNew ? SQLITE_OK : SQLITE_NOMEM);
drh76ff3a02004-09-24 22:32:30 +0000133}
134
drh313619f2013-10-31 20:34:06 +0000135#ifdef SQLITE_DEBUG
136/* This routine is just a convenient place to set a breakpoint that will
137** fire after each opcode is inserted and displayed using
138** "PRAGMA vdbe_addoptrace=on".
139*/
140static void test_addop_breakpoint(void){
141 static int n = 0;
142 n++;
143}
144#endif
145
drh76ff3a02004-09-24 22:32:30 +0000146/*
drh9a324642003-09-06 20:12:01 +0000147** Add a new instruction to the list of instructions current in the
148** VDBE. Return the address of the new instruction.
149**
150** Parameters:
151**
152** p Pointer to the VDBE
153**
154** op The opcode for this instruction
155**
drh66a51672008-01-03 00:01:23 +0000156** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000157**
danielk19774adee202004-05-08 08:23:19 +0000158** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000159** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000160** operand.
161*/
drhd7970352015-11-09 12:33:39 +0000162static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
163 assert( p->pParse->nOpAlloc<=p->nOp );
164 if( growOpArray(p, 1) ) return 1;
165 assert( p->pParse->nOpAlloc>p->nOp );
166 return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
167}
drh66a51672008-01-03 00:01:23 +0000168int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000169 int i;
drh701a0ae2004-02-22 20:05:00 +0000170 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000171
172 i = p->nOp;
drh9a324642003-09-06 20:12:01 +0000173 assert( p->magic==VDBE_MAGIC_INIT );
drhed94af52016-02-01 17:20:08 +0000174 assert( op>=0 && op<0xff );
drh73d5b8f2013-12-23 19:09:07 +0000175 if( p->pParse->nOpAlloc<=i ){
drhd7970352015-11-09 12:33:39 +0000176 return growOp3(p, op, p1, p2, p3);
drh9a324642003-09-06 20:12:01 +0000177 }
danielk197701256832007-04-18 14:24:32 +0000178 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000179 pOp = &p->aOp[i];
drh8df32842008-12-09 02:51:23 +0000180 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000181 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000182 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000183 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000184 pOp->p3 = p3;
185 pOp->p4.p = 0;
186 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000187#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000188 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000189#endif
190#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000191 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh9ac79622013-12-18 15:11:47 +0000192 int jj, kk;
193 Parse *pParse = p->pParse;
194 for(jj=kk=0; jj<SQLITE_N_COLCACHE; jj++){
195 struct yColCache *x = pParse->aColCache + jj;
196 if( x->iLevel>pParse->iCacheLevel || x->iReg==0 ) continue;
197 printf(" r[%d]={%d:%d}", x->iReg, x->iTable, x->iColumn);
198 kk++;
199 }
200 if( kk ) printf("\n");
drhe0962052013-01-29 19:14:31 +0000201 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh313619f2013-10-31 20:34:06 +0000202 test_addop_breakpoint();
drhe0962052013-01-29 19:14:31 +0000203 }
drh9a324642003-09-06 20:12:01 +0000204#endif
drh26c9b5e2008-04-11 14:56:53 +0000205#ifdef VDBE_PROFILE
206 pOp->cycles = 0;
207 pOp->cnt = 0;
208#endif
drh688852a2014-02-17 22:40:43 +0000209#ifdef SQLITE_VDBE_COVERAGE
210 pOp->iSrcLine = 0;
211#endif
drh9a324642003-09-06 20:12:01 +0000212 return i;
213}
drh66a51672008-01-03 00:01:23 +0000214int sqlite3VdbeAddOp0(Vdbe *p, int op){
215 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
216}
217int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
218 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
219}
220int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
221 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000222}
223
drh076e85f2015-09-03 13:46:12 +0000224/* Generate code for an unconditional jump to instruction iDest
225*/
226int sqlite3VdbeGoto(Vdbe *p, int iDest){
drh2991ba02015-09-02 18:19:00 +0000227 return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
228}
drh701a0ae2004-02-22 20:05:00 +0000229
drh076e85f2015-09-03 13:46:12 +0000230/* Generate code to cause the string zStr to be loaded into
231** register iDest
232*/
233int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
234 return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
235}
236
237/*
238** Generate code that initializes multiple registers to string or integer
239** constants. The registers begin with iDest and increase consecutively.
240** One register is initialized for each characgter in zTypes[]. For each
241** "s" character in zTypes[], the register is a string if the argument is
242** not NULL, or OP_Null if the value is a null pointer. For each "i" character
243** in zTypes[], the register is initialized to an integer.
244*/
245void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
246 va_list ap;
247 int i;
248 char c;
249 va_start(ap, zTypes);
250 for(i=0; (c = zTypes[i])!=0; i++){
251 if( c=='s' ){
252 const char *z = va_arg(ap, const char*);
drh2ce18652016-01-16 20:50:21 +0000253 sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest++, 0, z, 0);
drh076e85f2015-09-03 13:46:12 +0000254 }else{
255 assert( c=='i' );
256 sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest++);
257 }
258 }
259 va_end(ap);
260}
drh66a51672008-01-03 00:01:23 +0000261
drh701a0ae2004-02-22 20:05:00 +0000262/*
drh66a51672008-01-03 00:01:23 +0000263** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000264*/
drh66a51672008-01-03 00:01:23 +0000265int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000266 Vdbe *p, /* Add the opcode to this VM */
267 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000268 int p1, /* The P1 operand */
269 int p2, /* The P2 operand */
270 int p3, /* The P3 operand */
271 const char *zP4, /* The P4 operand */
272 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000273){
drh66a51672008-01-03 00:01:23 +0000274 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
275 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000276 return addr;
277}
278
279/*
drh7cc023c2015-09-03 04:28:25 +0000280** Add an opcode that includes the p4 value with a P4_INT64 or
281** P4_REAL type.
drh97bae792015-06-05 15:59:57 +0000282*/
283int sqlite3VdbeAddOp4Dup8(
284 Vdbe *p, /* Add the opcode to this VM */
285 int op, /* The new opcode */
286 int p1, /* The P1 operand */
287 int p2, /* The P2 operand */
288 int p3, /* The P3 operand */
289 const u8 *zP4, /* The P4 operand */
290 int p4type /* P4 operand type */
291){
drh575fad62016-02-05 13:38:36 +0000292 char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
drh97bae792015-06-05 15:59:57 +0000293 if( p4copy ) memcpy(p4copy, zP4, 8);
294 return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
295}
296
297/*
drh5d9c9da2011-06-03 20:11:17 +0000298** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000299** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
300** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000301**
302** The zWhere string must have been obtained from sqlite3_malloc().
303** This routine will take ownership of the allocated memory.
304*/
305void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
306 int j;
drh00dceca2016-01-11 22:58:50 +0000307 sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
drh5d9c9da2011-06-03 20:11:17 +0000308 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
309}
310
311/*
drh8cff69d2009-11-12 19:59:44 +0000312** Add an opcode that includes the p4 value as an integer.
313*/
314int sqlite3VdbeAddOp4Int(
315 Vdbe *p, /* Add the opcode to this VM */
316 int op, /* The new opcode */
317 int p1, /* The P1 operand */
318 int p2, /* The P2 operand */
319 int p3, /* The P3 operand */
320 int p4 /* The P4 operand as an integer */
321){
322 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
323 sqlite3VdbeChangeP4(p, addr, SQLITE_INT_TO_PTR(p4), P4_INT32);
324 return addr;
325}
326
327/*
drh9a324642003-09-06 20:12:01 +0000328** Create a new symbolic label for an instruction that has yet to be
329** coded. The symbolic label is really just a negative number. The
330** label can be used as the P2 value of an operation. Later, when
331** the label is resolved to a specific address, the VDBE will scan
332** through its operation list and change all values of P2 which match
333** the label into the resolved address.
334**
335** The VDBE knows that a P2 value is a label because labels are
336** always negative and P2 values are suppose to be non-negative.
337** Hence, a negative P2 value is a label that has yet to be resolved.
danielk1977b5548a82004-06-26 13:51:33 +0000338**
339** Zero is returned if a malloc() fails.
drh9a324642003-09-06 20:12:01 +0000340*/
drh73d5b8f2013-12-23 19:09:07 +0000341int sqlite3VdbeMakeLabel(Vdbe *v){
342 Parse *p = v->pParse;
drhc35f3d52012-02-01 19:03:38 +0000343 int i = p->nLabel++;
drh73d5b8f2013-12-23 19:09:07 +0000344 assert( v->magic==VDBE_MAGIC_INIT );
drhc35f3d52012-02-01 19:03:38 +0000345 if( (i & (i-1))==0 ){
346 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
347 (i*2+1)*sizeof(p->aLabel[0]));
drh9a324642003-09-06 20:12:01 +0000348 }
drh76ff3a02004-09-24 22:32:30 +0000349 if( p->aLabel ){
350 p->aLabel[i] = -1;
drh9a324642003-09-06 20:12:01 +0000351 }
drh5ef09bf2015-12-09 17:23:12 +0000352 return ADDR(i);
drh9a324642003-09-06 20:12:01 +0000353}
354
355/*
356** Resolve label "x" to be the address of the next instruction to
357** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000358** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000359*/
drh73d5b8f2013-12-23 19:09:07 +0000360void sqlite3VdbeResolveLabel(Vdbe *v, int x){
361 Parse *p = v->pParse;
drh5ef09bf2015-12-09 17:23:12 +0000362 int j = ADDR(x);
drh73d5b8f2013-12-23 19:09:07 +0000363 assert( v->magic==VDBE_MAGIC_INIT );
drhb2b9d3d2013-08-01 01:14:43 +0000364 assert( j<p->nLabel );
drhef41dfe2015-09-02 17:55:12 +0000365 assert( j>=0 );
366 if( p->aLabel ){
drh73d5b8f2013-12-23 19:09:07 +0000367 p->aLabel[j] = v->nOp;
drh9a324642003-09-06 20:12:01 +0000368 }
drh61019c72014-01-04 16:49:02 +0000369 p->iFixedOp = v->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000370}
371
drh4611d922010-02-25 14:47:01 +0000372/*
373** Mark the VDBE as one that can only be run one time.
374*/
375void sqlite3VdbeRunOnlyOnce(Vdbe *p){
376 p->runOnlyOnce = 1;
377}
378
drhff738bc2009-09-24 00:09:58 +0000379#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000380
381/*
382** The following type and function are used to iterate through all opcodes
383** in a Vdbe main program and each of the sub-programs (triggers) it may
384** invoke directly or indirectly. It should be used as follows:
385**
386** Op *pOp;
387** VdbeOpIter sIter;
388**
389** memset(&sIter, 0, sizeof(sIter));
390** sIter.v = v; // v is of type Vdbe*
391** while( (pOp = opIterNext(&sIter)) ){
392** // Do something with pOp
393** }
394** sqlite3DbFree(v->db, sIter.apSub);
395**
396*/
397typedef struct VdbeOpIter VdbeOpIter;
398struct VdbeOpIter {
399 Vdbe *v; /* Vdbe to iterate through the opcodes of */
400 SubProgram **apSub; /* Array of subprograms */
401 int nSub; /* Number of entries in apSub */
402 int iAddr; /* Address of next instruction to return */
403 int iSub; /* 0 = main program, 1 = first sub-program etc. */
404};
405static Op *opIterNext(VdbeOpIter *p){
406 Vdbe *v = p->v;
407 Op *pRet = 0;
408 Op *aOp;
409 int nOp;
410
411 if( p->iSub<=p->nSub ){
412
413 if( p->iSub==0 ){
414 aOp = v->aOp;
415 nOp = v->nOp;
416 }else{
417 aOp = p->apSub[p->iSub-1]->aOp;
418 nOp = p->apSub[p->iSub-1]->nOp;
419 }
420 assert( p->iAddr<nOp );
421
422 pRet = &aOp[p->iAddr];
423 p->iAddr++;
424 if( p->iAddr==nOp ){
425 p->iSub++;
426 p->iAddr = 0;
427 }
428
429 if( pRet->p4type==P4_SUBPROGRAM ){
430 int nByte = (p->nSub+1)*sizeof(SubProgram*);
431 int j;
432 for(j=0; j<p->nSub; j++){
433 if( p->apSub[j]==pRet->p4.pProgram ) break;
434 }
435 if( j==p->nSub ){
436 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
437 if( !p->apSub ){
438 pRet = 0;
439 }else{
440 p->apSub[p->nSub++] = pRet->p4.pProgram;
441 }
442 }
443 }
444 }
445
446 return pRet;
447}
448
449/*
danf3677212009-09-10 16:14:50 +0000450** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000451** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000452** to be rolled back). This condition is true if the main program or any
453** sub-programs contains any of the following:
454**
455** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
456** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
457** * OP_Destroy
458** * OP_VUpdate
459** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000460** * OP_FkCounter with P2==0 (immediate foreign key constraint)
drh0dd5cda2015-06-16 16:39:01 +0000461** * OP_CreateTable and OP_InitCoroutine (for CREATE TABLE AS SELECT ...)
dan144926d2009-09-09 11:37:20 +0000462**
danf3677212009-09-10 16:14:50 +0000463** Then check that the value of Parse.mayAbort is true if an
464** ABORT may be thrown, or false otherwise. Return true if it does
465** match, or false otherwise. This function is intended to be used as
466** part of an assert statement in the compiler. Similar to:
467**
468** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000469*/
danf3677212009-09-10 16:14:50 +0000470int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
471 int hasAbort = 0;
dan04668832014-12-16 20:13:30 +0000472 int hasFkCounter = 0;
drh0dd5cda2015-06-16 16:39:01 +0000473 int hasCreateTable = 0;
474 int hasInitCoroutine = 0;
dan144926d2009-09-09 11:37:20 +0000475 Op *pOp;
476 VdbeOpIter sIter;
477 memset(&sIter, 0, sizeof(sIter));
478 sIter.v = v;
479
480 while( (pOp = opIterNext(&sIter))!=0 ){
481 int opcode = pOp->opcode;
482 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
483 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drhd91c1a12013-02-09 13:58:25 +0000484 && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000485 ){
danf3677212009-09-10 16:14:50 +0000486 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000487 break;
488 }
drh0dd5cda2015-06-16 16:39:01 +0000489 if( opcode==OP_CreateTable ) hasCreateTable = 1;
490 if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
dan04668832014-12-16 20:13:30 +0000491#ifndef SQLITE_OMIT_FOREIGN_KEY
492 if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
493 hasFkCounter = 1;
494 }
495#endif
dan144926d2009-09-09 11:37:20 +0000496 }
dan144926d2009-09-09 11:37:20 +0000497 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000498
mistachkin48864df2013-03-21 21:20:32 +0000499 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000500 ** If malloc failed, then the while() loop above may not have iterated
501 ** through all opcodes and hasAbort may be set incorrectly. Return
502 ** true for this case to prevent the assert() in the callers frame
503 ** from failing. */
drh0dd5cda2015-06-16 16:39:01 +0000504 return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
505 || (hasCreateTable && hasInitCoroutine) );
dan144926d2009-09-09 11:37:20 +0000506}
drhff738bc2009-09-24 00:09:58 +0000507#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000508
drh9a324642003-09-06 20:12:01 +0000509/*
drhef41dfe2015-09-02 17:55:12 +0000510** This routine is called after all opcodes have been inserted. It loops
511** through all the opcodes and fixes up some details.
drh76ff3a02004-09-24 22:32:30 +0000512**
drhef41dfe2015-09-02 17:55:12 +0000513** (1) For each jump instruction with a negative P2 value (a label)
514** resolve the P2 value to an actual address.
danielk1977634f2982005-03-28 08:44:07 +0000515**
drhef41dfe2015-09-02 17:55:12 +0000516** (2) Compute the maximum number of arguments used by any SQL function
517** and store that value in *pMaxFuncArgs.
drha6c2ed92009-11-14 23:22:23 +0000518**
drhef41dfe2015-09-02 17:55:12 +0000519** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
520** indicate what the prepared statement actually does.
521**
522** (4) Initialize the p4.xAdvance pointer on opcodes that use it.
523**
524** (5) Reclaim the memory allocated for storing labels.
drh76ff3a02004-09-24 22:32:30 +0000525*/
drh9cbf3422008-01-17 16:22:13 +0000526static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
drh76ff3a02004-09-24 22:32:30 +0000527 int i;
dan165921a2009-08-28 18:53:45 +0000528 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000529 Op *pOp;
drh73d5b8f2013-12-23 19:09:07 +0000530 Parse *pParse = p->pParse;
531 int *aLabel = pParse->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000532 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000533 p->bIsReader = 0;
drh76ff3a02004-09-24 22:32:30 +0000534 for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
danielk1977634f2982005-03-28 08:44:07 +0000535 u8 opcode = pOp->opcode;
536
drhb0c88652016-02-01 13:21:13 +0000537 /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
drh8c8a8c42013-08-06 07:45:08 +0000538 ** cases from this switch! */
539 switch( opcode ){
drh8c8a8c42013-08-06 07:45:08 +0000540 case OP_Transaction: {
541 if( pOp->p2!=0 ) p->readOnly = 0;
542 /* fall thru */
543 }
544 case OP_AutoCommit:
545 case OP_Savepoint: {
546 p->bIsReader = 1;
547 break;
548 }
dand9031542013-07-05 16:54:30 +0000549#ifndef SQLITE_OMIT_WAL
drh8c8a8c42013-08-06 07:45:08 +0000550 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000551#endif
drh8c8a8c42013-08-06 07:45:08 +0000552 case OP_Vacuum:
553 case OP_JournalMode: {
554 p->readOnly = 0;
555 p->bIsReader = 1;
556 break;
557 }
danielk1977182c4ba2007-06-27 15:53:34 +0000558#ifndef SQLITE_OMIT_VIRTUALTABLE
drh8c8a8c42013-08-06 07:45:08 +0000559 case OP_VUpdate: {
560 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
561 break;
562 }
563 case OP_VFilter: {
564 int n;
565 assert( p->nOp - i >= 3 );
566 assert( pOp[-1].opcode==OP_Integer );
567 n = pOp[-1].p1;
568 if( n>nMaxArgs ) nMaxArgs = n;
569 break;
570 }
danielk1977182c4ba2007-06-27 15:53:34 +0000571#endif
drh8c8a8c42013-08-06 07:45:08 +0000572 case OP_Next:
drhf93cd942013-11-21 03:12:25 +0000573 case OP_NextIfOpen:
drh8c8a8c42013-08-06 07:45:08 +0000574 case OP_SorterNext: {
575 pOp->p4.xAdvance = sqlite3BtreeNext;
576 pOp->p4type = P4_ADVANCE;
577 break;
578 }
drhf93cd942013-11-21 03:12:25 +0000579 case OP_Prev:
580 case OP_PrevIfOpen: {
drh8c8a8c42013-08-06 07:45:08 +0000581 pOp->p4.xAdvance = sqlite3BtreePrevious;
582 pOp->p4type = P4_ADVANCE;
583 break;
584 }
danielk1977bc04f852005-03-29 08:26:13 +0000585 }
danielk1977634f2982005-03-28 08:44:07 +0000586
drh8c8a8c42013-08-06 07:45:08 +0000587 pOp->opflags = sqlite3OpcodeProperty[opcode];
drha6c2ed92009-11-14 23:22:23 +0000588 if( (pOp->opflags & OPFLG_JUMP)!=0 && pOp->p2<0 ){
drh5ef09bf2015-12-09 17:23:12 +0000589 assert( ADDR(pOp->p2)<pParse->nLabel );
590 pOp->p2 = aLabel[ADDR(pOp->p2)];
drhd2981512008-01-04 19:33:49 +0000591 }
drh76ff3a02004-09-24 22:32:30 +0000592 }
drh73d5b8f2013-12-23 19:09:07 +0000593 sqlite3DbFree(p->db, pParse->aLabel);
594 pParse->aLabel = 0;
595 pParse->nLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000596 *pMaxFuncArgs = nMaxArgs;
drha7ab6d82014-07-21 15:44:39 +0000597 assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
drh76ff3a02004-09-24 22:32:30 +0000598}
599
600/*
drh9a324642003-09-06 20:12:01 +0000601** Return the address of the next instruction to be inserted.
602*/
danielk19774adee202004-05-08 08:23:19 +0000603int sqlite3VdbeCurrentAddr(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000604 assert( p->magic==VDBE_MAGIC_INIT );
605 return p->nOp;
606}
607
dan65a7cd12009-09-01 12:16:01 +0000608/*
drh2ce18652016-01-16 20:50:21 +0000609** Verify that at least N opcode slots are available in p without
drhdad300d2016-01-18 00:20:26 +0000610** having to malloc for more space (except when compiled using
611** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
612** to verify that certain calls to sqlite3VdbeAddOpList() can never
613** fail due to a OOM fault and hence that the return value from
614** sqlite3VdbeAddOpList() will always be non-NULL.
drh2ce18652016-01-16 20:50:21 +0000615*/
drhdad300d2016-01-18 00:20:26 +0000616#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
617void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
drh2ce18652016-01-16 20:50:21 +0000618 assert( p->nOp + N <= p->pParse->nOpAlloc );
619}
620#endif
621
622/*
dan65a7cd12009-09-01 12:16:01 +0000623** This function returns a pointer to the array of opcodes associated with
624** the Vdbe passed as the first argument. It is the callers responsibility
625** to arrange for the returned array to be eventually freed using the
626** vdbeFreeOpArray() function.
627**
628** Before returning, *pnOp is set to the number of entries in the returned
629** array. Also, *pnMaxArg is set to the larger of its current value and
630** the number of entries in the Vdbe.apArg[] array required to execute the
631** returned program.
632*/
dan165921a2009-08-28 18:53:45 +0000633VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
634 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +0000635 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +0000636
637 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drha7ab6d82014-07-21 15:44:39 +0000638 assert( DbMaskAllZero(p->btreeMask) );
dan65a7cd12009-09-01 12:16:01 +0000639
dan165921a2009-08-28 18:53:45 +0000640 resolveP2Values(p, pnMaxArg);
641 *pnOp = p->nOp;
642 p->aOp = 0;
643 return aOp;
644}
645
drh9a324642003-09-06 20:12:01 +0000646/*
drh2ce18652016-01-16 20:50:21 +0000647** Add a whole list of operations to the operation stack. Return a
648** pointer to the first operation inserted.
drh1b325542016-02-03 01:55:44 +0000649**
650** Non-zero P2 arguments to jump instructions are automatically adjusted
651** so that the jump target is relative to the first operation inserted.
drh9a324642003-09-06 20:12:01 +0000652*/
drh2ce18652016-01-16 20:50:21 +0000653VdbeOp *sqlite3VdbeAddOpList(
654 Vdbe *p, /* Add opcodes to the prepared statement */
655 int nOp, /* Number of opcodes to add */
656 VdbeOpList const *aOp, /* The opcodes to be added */
657 int iLineno /* Source-file line number of first opcode */
658){
659 int i;
660 VdbeOp *pOut, *pFirst;
drhef41dfe2015-09-02 17:55:12 +0000661 assert( nOp>0 );
drh9a324642003-09-06 20:12:01 +0000662 assert( p->magic==VDBE_MAGIC_INIT );
dan76ccd892014-08-12 13:38:52 +0000663 if( p->nOp + nOp > p->pParse->nOpAlloc && growOpArray(p, nOp) ){
drh76ff3a02004-09-24 22:32:30 +0000664 return 0;
drh9a324642003-09-06 20:12:01 +0000665 }
drh2ce18652016-01-16 20:50:21 +0000666 pFirst = pOut = &p->aOp[p->nOp];
drhef41dfe2015-09-02 17:55:12 +0000667 for(i=0; i<nOp; i++, aOp++, pOut++){
drhef41dfe2015-09-02 17:55:12 +0000668 pOut->opcode = aOp->opcode;
669 pOut->p1 = aOp->p1;
drh5ef09bf2015-12-09 17:23:12 +0000670 pOut->p2 = aOp->p2;
671 assert( aOp->p2>=0 );
drh1b325542016-02-03 01:55:44 +0000672 if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
673 pOut->p2 += p->nOp;
674 }
drhef41dfe2015-09-02 17:55:12 +0000675 pOut->p3 = aOp->p3;
676 pOut->p4type = P4_NOTUSED;
677 pOut->p4.p = 0;
678 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +0000679#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhef41dfe2015-09-02 17:55:12 +0000680 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000681#endif
drh688852a2014-02-17 22:40:43 +0000682#ifdef SQLITE_VDBE_COVERAGE
drhef41dfe2015-09-02 17:55:12 +0000683 pOut->iSrcLine = iLineno+i;
drh688852a2014-02-17 22:40:43 +0000684#else
drhef41dfe2015-09-02 17:55:12 +0000685 (void)iLineno;
drh688852a2014-02-17 22:40:43 +0000686#endif
drhc7379ce2013-10-30 02:28:23 +0000687#ifdef SQLITE_DEBUG
drhef41dfe2015-09-02 17:55:12 +0000688 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh2ce18652016-01-16 20:50:21 +0000689 sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
drh9a324642003-09-06 20:12:01 +0000690 }
drhef41dfe2015-09-02 17:55:12 +0000691#endif
drh9a324642003-09-06 20:12:01 +0000692 }
drhef41dfe2015-09-02 17:55:12 +0000693 p->nOp += nOp;
drh2ce18652016-01-16 20:50:21 +0000694 return pFirst;
drh9a324642003-09-06 20:12:01 +0000695}
696
dan6f9702e2014-11-01 20:38:06 +0000697#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
698/*
699** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
700*/
dan037b5322014-11-03 11:25:32 +0000701void sqlite3VdbeScanStatus(
dan6f9702e2014-11-01 20:38:06 +0000702 Vdbe *p, /* VM to add scanstatus() to */
703 int addrExplain, /* Address of OP_Explain (or 0) */
704 int addrLoop, /* Address of loop counter */
705 int addrVisit, /* Address of rows visited counter */
drh518140e2014-11-06 03:55:10 +0000706 LogEst nEst, /* Estimated number of output rows */
dan6f9702e2014-11-01 20:38:06 +0000707 const char *zName /* Name of table or index being scanned */
708){
dan037b5322014-11-03 11:25:32 +0000709 int nByte = (p->nScan+1) * sizeof(ScanStatus);
710 ScanStatus *aNew;
711 aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
dan6f9702e2014-11-01 20:38:06 +0000712 if( aNew ){
dan037b5322014-11-03 11:25:32 +0000713 ScanStatus *pNew = &aNew[p->nScan++];
dan6f9702e2014-11-01 20:38:06 +0000714 pNew->addrExplain = addrExplain;
715 pNew->addrLoop = addrLoop;
716 pNew->addrVisit = addrVisit;
717 pNew->nEst = nEst;
718 pNew->zName = sqlite3DbStrDup(p->db, zName);
719 p->aScan = aNew;
720 }
721}
722#endif
723
724
drh9a324642003-09-06 20:12:01 +0000725/*
drh0ff287f2015-09-02 18:40:33 +0000726** Change the value of the opcode, or P1, P2, P3, or P5 operands
727** for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000728*/
drh0ff287f2015-09-02 18:40:33 +0000729void sqlite3VdbeChangeOpcode(Vdbe *p, u32 addr, u8 iNewOpcode){
730 sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
731}
drh88caeac2011-08-24 15:12:08 +0000732void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000733 sqlite3VdbeGetOp(p,addr)->p1 = val;
drh9a324642003-09-06 20:12:01 +0000734}
drh88caeac2011-08-24 15:12:08 +0000735void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000736 sqlite3VdbeGetOp(p,addr)->p2 = val;
drh9a324642003-09-06 20:12:01 +0000737}
drh88caeac2011-08-24 15:12:08 +0000738void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
drh0ff287f2015-09-02 18:40:33 +0000739 sqlite3VdbeGetOp(p,addr)->p3 = val;
danielk1977207872a2008-01-03 07:54:23 +0000740}
drh0ff287f2015-09-02 18:40:33 +0000741void sqlite3VdbeChangeP5(Vdbe *p, u8 p5){
drh9b34abe2016-01-16 15:12:35 +0000742 if( !p->db->mallocFailed ) p->aOp[p->nOp-1].p5 = p5;
danielk19771f4aa332008-01-03 09:51:55 +0000743}
744
745/*
drhf8875402006-03-17 13:56:34 +0000746** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +0000747** the address of the next instruction to be coded.
748*/
749void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drh61019c72014-01-04 16:49:02 +0000750 p->pParse->iFixedOp = p->nOp - 1;
drh0ff287f2015-09-02 18:40:33 +0000751 sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +0000752}
drhb38ad992005-09-16 00:27:01 +0000753
drhb7f6f682006-07-08 17:06:43 +0000754
755/*
756** If the input FuncDef structure is ephemeral, then free it. If
757** the FuncDef is not ephermal, then do nothing.
758*/
drh633e6d52008-07-28 19:34:53 +0000759static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drhd36e1042013-09-06 13:10:12 +0000760 if( ALWAYS(pDef) && (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh633e6d52008-07-28 19:34:53 +0000761 sqlite3DbFree(db, pDef);
drhb7f6f682006-07-08 17:06:43 +0000762 }
763}
764
dand46def72010-07-24 11:28:28 +0000765static void vdbeFreeOpArray(sqlite3 *, Op *, int);
766
drhb38ad992005-09-16 00:27:01 +0000767/*
drh66a51672008-01-03 00:01:23 +0000768** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +0000769*/
drh633e6d52008-07-28 19:34:53 +0000770static void freeP4(sqlite3 *db, int p4type, void *p4){
drh0acb7e42008-06-25 00:12:41 +0000771 if( p4 ){
dand46def72010-07-24 11:28:28 +0000772 assert( db );
drh66a51672008-01-03 00:01:23 +0000773 switch( p4type ){
drh9c7c9132015-06-26 18:16:52 +0000774 case P4_FUNCCTX: {
775 freeEphemeralFunction(db, ((sqlite3_context*)p4)->pFunc);
776 /* Fall through into the next case */
777 }
drh66a51672008-01-03 00:01:23 +0000778 case P4_REAL:
779 case P4_INT64:
drh66a51672008-01-03 00:01:23 +0000780 case P4_DYNAMIC:
drh2ec2fb22013-11-06 19:59:23 +0000781 case P4_INTARRAY: {
drh633e6d52008-07-28 19:34:53 +0000782 sqlite3DbFree(db, p4);
drhac1733d2005-09-17 17:58:22 +0000783 break;
784 }
drh2ec2fb22013-11-06 19:59:23 +0000785 case P4_KEYINFO: {
786 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
787 break;
788 }
drh28935362013-12-07 20:39:19 +0000789#ifdef SQLITE_ENABLE_CURSOR_HINTS
790 case P4_EXPR: {
791 sqlite3ExprDelete(db, (Expr*)p4);
792 break;
793 }
794#endif
drhb9755982010-07-24 16:34:37 +0000795 case P4_MPRINTF: {
drh7043db92010-07-26 12:38:12 +0000796 if( db->pnBytesFreed==0 ) sqlite3_free(p4);
drhb9755982010-07-24 16:34:37 +0000797 break;
798 }
drh66a51672008-01-03 00:01:23 +0000799 case P4_FUNCDEF: {
drh633e6d52008-07-28 19:34:53 +0000800 freeEphemeralFunction(db, (FuncDef*)p4);
drhb7f6f682006-07-08 17:06:43 +0000801 break;
802 }
drh66a51672008-01-03 00:01:23 +0000803 case P4_MEM: {
drhc176c272010-07-26 13:57:59 +0000804 if( db->pnBytesFreed==0 ){
805 sqlite3ValueFree((sqlite3_value*)p4);
806 }else{
drhf37c68e2010-07-26 14:20:06 +0000807 Mem *p = (Mem*)p4;
drh17bcb102014-09-18 21:25:33 +0000808 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drhf37c68e2010-07-26 14:20:06 +0000809 sqlite3DbFree(db, p);
drhc176c272010-07-26 13:57:59 +0000810 }
drhac1733d2005-09-17 17:58:22 +0000811 break;
812 }
danielk1977595a5232009-07-24 17:58:53 +0000813 case P4_VTAB : {
dand46def72010-07-24 11:28:28 +0000814 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
danielk1977595a5232009-07-24 17:58:53 +0000815 break;
816 }
drhb38ad992005-09-16 00:27:01 +0000817 }
818 }
819}
820
dan65a7cd12009-09-01 12:16:01 +0000821/*
822** Free the space allocated for aOp and any p4 values allocated for the
823** opcodes contained within. If aOp is not NULL it is assumed to contain
824** nOp entries.
825*/
dan165921a2009-08-28 18:53:45 +0000826static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
827 if( aOp ){
828 Op *pOp;
829 for(pOp=aOp; pOp<&aOp[nOp]; pOp++){
drh00dceca2016-01-11 22:58:50 +0000830 if( pOp->p4type ) freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +0000831#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +0000832 sqlite3DbFree(db, pOp->zComment);
833#endif
834 }
835 }
836 sqlite3DbFree(db, aOp);
837}
838
dan65a7cd12009-09-01 12:16:01 +0000839/*
dand19c9332010-07-26 12:05:17 +0000840** Link the SubProgram object passed as the second argument into the linked
841** list at Vdbe.pSubProgram. This list is used to delete all sub-program
842** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +0000843*/
dand19c9332010-07-26 12:05:17 +0000844void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
845 p->pNext = pVdbe->pProgram;
846 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +0000847}
848
drh9a324642003-09-06 20:12:01 +0000849/*
drh48f2d3b2011-09-16 01:34:43 +0000850** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +0000851*/
drh2ce18652016-01-16 20:50:21 +0000852int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
853 VdbeOp *pOp;
854 if( p->db->mallocFailed ) return 0;
855 assert( addr>=0 && addr<p->nOp );
856 pOp = &p->aOp[addr];
857 freeP4(p->db, pOp->p4type, pOp->p4.p);
drh4b31bda2016-01-20 02:01:02 +0000858 pOp->p4type = P4_NOTUSED;
drh939e7782016-01-20 02:36:12 +0000859 pOp->p4.z = 0;
drh2ce18652016-01-16 20:50:21 +0000860 pOp->opcode = OP_Noop;
861 return 1;
drhf8875402006-03-17 13:56:34 +0000862}
863
864/*
drh39c4b822014-09-29 15:42:01 +0000865** If the last opcode is "op" and it is not a jump destination,
866** then remove it. Return true if and only if an opcode was removed.
drh762c1c42014-01-02 19:35:30 +0000867*/
drh61019c72014-01-04 16:49:02 +0000868int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
869 if( (p->nOp-1)>(p->pParse->iFixedOp) && p->aOp[p->nOp-1].opcode==op ){
drh2ce18652016-01-16 20:50:21 +0000870 return sqlite3VdbeChangeToNoop(p, p->nOp-1);
drh61019c72014-01-04 16:49:02 +0000871 }else{
872 return 0;
873 }
drh762c1c42014-01-02 19:35:30 +0000874}
875
876/*
drh66a51672008-01-03 00:01:23 +0000877** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000878** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000879** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000880** few minor changes to the program.
881**
drh66a51672008-01-03 00:01:23 +0000882** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +0000883** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +0000884** A value of n==0 means copy bytes of zP4 up to and including the
885** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +0000886**
drh66a51672008-01-03 00:01:23 +0000887** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +0000888** to a string or structure that is guaranteed to exist for the lifetime of
889** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +0000890**
drh66a51672008-01-03 00:01:23 +0000891** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +0000892*/
drh00dceca2016-01-11 22:58:50 +0000893static void SQLITE_NOINLINE vdbeChangeP4Full(
894 Vdbe *p,
895 Op *pOp,
896 const char *zP4,
897 int n
898){
899 if( pOp->p4type ){
900 freeP4(p->db, pOp->p4type, pOp->p4.p);
901 pOp->p4type = 0;
902 pOp->p4.p = 0;
903 }
904 if( n<0 ){
905 sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
906 }else{
907 if( n==0 ) n = sqlite3Strlen30(zP4);
908 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
909 pOp->p4type = P4_DYNAMIC;
910 }
911}
drh66a51672008-01-03 00:01:23 +0000912void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +0000913 Op *pOp;
drh633e6d52008-07-28 19:34:53 +0000914 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +0000915 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +0000916 db = p->db;
drh91fd4d42008-01-19 20:11:25 +0000917 assert( p->magic==VDBE_MAGIC_INIT );
drh00dceca2016-01-11 22:58:50 +0000918 assert( p->aOp!=0 || db->mallocFailed );
919 if( db->mallocFailed ){
920 if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
danielk1977d5d56522005-03-16 12:15:20 +0000921 return;
922 }
drh7b746032009-06-26 12:15:22 +0000923 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +0000924 assert( addr<p->nOp );
925 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +0000926 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000927 }
928 pOp = &p->aOp[addr];
drh00dceca2016-01-11 22:58:50 +0000929 if( n>=0 || pOp->p4type ){
930 vdbeChangeP4Full(p, pOp, zP4, n);
931 return;
932 }
drh98757152008-01-09 23:04:12 +0000933 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +0000934 /* Note: this cast is safe, because the origin data point was an int
935 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +0000936 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +0000937 pOp->p4type = P4_INT32;
drh00dceca2016-01-11 22:58:50 +0000938 }else if( zP4!=0 ){
939 assert( n<0 );
danielk19772dca4ac2008-01-03 11:50:29 +0000940 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +0000941 pOp->p4type = (signed char)n;
drh00dceca2016-01-11 22:58:50 +0000942 if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
drh9a324642003-09-06 20:12:01 +0000943 }
944}
945
drh2ec2fb22013-11-06 19:59:23 +0000946/*
947** Set the P4 on the most recently added opcode to the KeyInfo for the
948** index given.
949*/
950void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
951 Vdbe *v = pParse->pVdbe;
952 assert( v!=0 );
953 assert( pIdx!=0 );
954 sqlite3VdbeChangeP4(v, -1, (char*)sqlite3KeyInfoOfIndex(pParse, pIdx),
955 P4_KEYINFO);
956}
957
drhc7379ce2013-10-30 02:28:23 +0000958#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +0000959/*
mistachkind5578432012-08-25 10:01:29 +0000960** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +0000961** insert a No-op and add the comment to that new instruction. This
962** makes the code easier to read during debugging. None of this happens
963** in a production build.
drhad6d9462004-09-19 02:15:24 +0000964*/
drhb07028f2011-10-14 21:49:18 +0000965static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +0000966 assert( p->nOp>0 || p->aOp==0 );
drhd4e70eb2008-01-02 00:34:36 +0000967 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
danielk1977dba01372008-01-05 18:44:29 +0000968 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +0000969 assert( p->aOp );
970 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
971 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
972 }
973}
974void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
975 va_list ap;
976 if( p ){
danielk1977dba01372008-01-05 18:44:29 +0000977 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +0000978 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +0000979 va_end(ap);
980 }
drhad6d9462004-09-19 02:15:24 +0000981}
drh16ee60f2008-06-20 18:13:25 +0000982void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
983 va_list ap;
drhb07028f2011-10-14 21:49:18 +0000984 if( p ){
985 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +0000986 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +0000987 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +0000988 va_end(ap);
989 }
990}
991#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +0000992
drh688852a2014-02-17 22:40:43 +0000993#ifdef SQLITE_VDBE_COVERAGE
994/*
995** Set the value if the iSrcLine field for the previously coded instruction.
996*/
997void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
998 sqlite3VdbeGetOp(v,-1)->iSrcLine = iLine;
999}
1000#endif /* SQLITE_VDBE_COVERAGE */
1001
drh9a324642003-09-06 20:12:01 +00001002/*
drh20411ea2009-05-29 19:00:12 +00001003** Return the opcode for a given address. If the address is -1, then
1004** return the most recently inserted opcode.
1005**
1006** If a memory allocation error has occurred prior to the calling of this
1007** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +00001008** is readable but not writable, though it is cast to a writable value.
1009** The return of a dummy opcode allows the call to continue functioning
peter.d.reid60ec9142014-09-06 16:39:46 +00001010** after an OOM fault without having to check to see if the return from
drhf83dc1e2010-06-03 12:09:52 +00001011** this routine is a valid pointer. But because the dummy.opcode is 0,
1012** dummy will never be written to. This is verified by code inspection and
1013** by running with Valgrind.
drh9a324642003-09-06 20:12:01 +00001014*/
danielk19774adee202004-05-08 08:23:19 +00001015VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +00001016 /* C89 specifies that the constant "dummy" will be initialized to all
1017 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +00001018 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh9a324642003-09-06 20:12:01 +00001019 assert( p->magic==VDBE_MAGIC_INIT );
drh37b89a02009-06-19 00:33:31 +00001020 if( addr<0 ){
drh37b89a02009-06-19 00:33:31 +00001021 addr = p->nOp - 1;
1022 }
drh17435752007-08-16 04:30:38 +00001023 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00001024 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +00001025 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +00001026 }else{
1027 return &p->aOp[addr];
1028 }
drh9a324642003-09-06 20:12:01 +00001029}
1030
drhc7379ce2013-10-30 02:28:23 +00001031#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +00001032/*
drhf63552b2013-10-30 00:25:03 +00001033** Return an integer value for one of the parameters to the opcode pOp
1034** determined by character c.
1035*/
1036static int translateP(char c, const Op *pOp){
1037 if( c=='1' ) return pOp->p1;
1038 if( c=='2' ) return pOp->p2;
1039 if( c=='3' ) return pOp->p3;
1040 if( c=='4' ) return pOp->p4.i;
1041 return pOp->p5;
1042}
1043
drh81316f82013-10-29 20:40:47 +00001044/*
drh4eded602013-12-20 15:59:20 +00001045** Compute a string for the "comment" field of a VDBE opcode listing.
1046**
1047** The Synopsis: field in comments in the vdbe.c source file gets converted
1048** to an extra string that is appended to the sqlite3OpcodeName(). In the
1049** absence of other comments, this synopsis becomes the comment on the opcode.
1050** Some translation occurs:
1051**
1052** "PX" -> "r[X]"
1053** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
1054** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
1055** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
drh81316f82013-10-29 20:40:47 +00001056*/
drhf63552b2013-10-30 00:25:03 +00001057static int displayComment(
1058 const Op *pOp, /* The opcode to be commented */
1059 const char *zP4, /* Previously obtained value for P4 */
1060 char *zTemp, /* Write result here */
1061 int nTemp /* Space available in zTemp[] */
1062){
drh81316f82013-10-29 20:40:47 +00001063 const char *zOpName;
1064 const char *zSynopsis;
1065 int nOpName;
1066 int ii, jj;
1067 zOpName = sqlite3OpcodeName(pOp->opcode);
1068 nOpName = sqlite3Strlen30(zOpName);
1069 if( zOpName[nOpName+1] ){
1070 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +00001071 char c;
drh81316f82013-10-29 20:40:47 +00001072 zSynopsis = zOpName += nOpName + 1;
drhf63552b2013-10-30 00:25:03 +00001073 for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
1074 if( c=='P' ){
1075 c = zSynopsis[++ii];
1076 if( c=='4' ){
1077 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
1078 }else if( c=='X' ){
1079 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
1080 seenCom = 1;
drh81316f82013-10-29 20:40:47 +00001081 }else{
drhf63552b2013-10-30 00:25:03 +00001082 int v1 = translateP(c, pOp);
1083 int v2;
1084 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
1085 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
1086 ii += 3;
1087 jj += sqlite3Strlen30(zTemp+jj);
1088 v2 = translateP(zSynopsis[ii], pOp);
drh4eded602013-12-20 15:59:20 +00001089 if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
1090 ii += 2;
1091 v2++;
1092 }
1093 if( v2>1 ){
1094 sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
1095 }
drhf63552b2013-10-30 00:25:03 +00001096 }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
1097 ii += 4;
1098 }
drh81316f82013-10-29 20:40:47 +00001099 }
1100 jj += sqlite3Strlen30(zTemp+jj);
1101 }else{
drhf63552b2013-10-30 00:25:03 +00001102 zTemp[jj++] = c;
drh81316f82013-10-29 20:40:47 +00001103 }
1104 }
1105 if( !seenCom && jj<nTemp-5 && pOp->zComment ){
1106 sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
1107 jj += sqlite3Strlen30(zTemp+jj);
1108 }
1109 if( jj<nTemp ) zTemp[jj] = 0;
1110 }else if( pOp->zComment ){
1111 sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
1112 jj = sqlite3Strlen30(zTemp);
1113 }else{
1114 zTemp[0] = 0;
1115 jj = 0;
1116 }
1117 return jj;
1118}
1119#endif /* SQLITE_DEBUG */
1120
drhf7e36902015-08-13 21:32:41 +00001121#if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
1122/*
1123** Translate the P4.pExpr value for an OP_CursorHint opcode into text
1124** that can be displayed in the P4 column of EXPLAIN output.
1125*/
drh5f4a6862016-01-30 12:50:25 +00001126static void displayP4Expr(StrAccum *p, Expr *pExpr){
drha67a3162015-08-15 00:51:23 +00001127 const char *zOp = 0;
drhf7e36902015-08-13 21:32:41 +00001128 switch( pExpr->op ){
1129 case TK_STRING:
drh5f4a6862016-01-30 12:50:25 +00001130 sqlite3XPrintf(p, "%Q", pExpr->u.zToken);
drhf7e36902015-08-13 21:32:41 +00001131 break;
drhf7e36902015-08-13 21:32:41 +00001132 case TK_INTEGER:
drh5f4a6862016-01-30 12:50:25 +00001133 sqlite3XPrintf(p, "%d", pExpr->u.iValue);
drhf7e36902015-08-13 21:32:41 +00001134 break;
drhf7e36902015-08-13 21:32:41 +00001135 case TK_NULL:
drh5f4a6862016-01-30 12:50:25 +00001136 sqlite3XPrintf(p, "NULL");
drhf7e36902015-08-13 21:32:41 +00001137 break;
drhf7e36902015-08-13 21:32:41 +00001138 case TK_REGISTER: {
drh5f4a6862016-01-30 12:50:25 +00001139 sqlite3XPrintf(p, "r[%d]", pExpr->iTable);
drhf7e36902015-08-13 21:32:41 +00001140 break;
1141 }
drhf7e36902015-08-13 21:32:41 +00001142 case TK_COLUMN: {
drhfe663522015-08-14 01:03:21 +00001143 if( pExpr->iColumn<0 ){
drh5f4a6862016-01-30 12:50:25 +00001144 sqlite3XPrintf(p, "rowid");
drhfe663522015-08-14 01:03:21 +00001145 }else{
drh5f4a6862016-01-30 12:50:25 +00001146 sqlite3XPrintf(p, "c%d", (int)pExpr->iColumn);
drhfe663522015-08-14 01:03:21 +00001147 }
drhf7e36902015-08-13 21:32:41 +00001148 break;
1149 }
drha67a3162015-08-15 00:51:23 +00001150 case TK_LT: zOp = "LT"; break;
1151 case TK_LE: zOp = "LE"; break;
1152 case TK_GT: zOp = "GT"; break;
1153 case TK_GE: zOp = "GE"; break;
1154 case TK_NE: zOp = "NE"; break;
1155 case TK_EQ: zOp = "EQ"; break;
1156 case TK_IS: zOp = "IS"; break;
1157 case TK_ISNOT: zOp = "ISNOT"; break;
1158 case TK_AND: zOp = "AND"; break;
1159 case TK_OR: zOp = "OR"; break;
1160 case TK_PLUS: zOp = "ADD"; break;
1161 case TK_STAR: zOp = "MUL"; break;
1162 case TK_MINUS: zOp = "SUB"; break;
1163 case TK_REM: zOp = "REM"; break;
1164 case TK_BITAND: zOp = "BITAND"; break;
1165 case TK_BITOR: zOp = "BITOR"; break;
1166 case TK_SLASH: zOp = "DIV"; break;
1167 case TK_LSHIFT: zOp = "LSHIFT"; break;
1168 case TK_RSHIFT: zOp = "RSHIFT"; break;
1169 case TK_CONCAT: zOp = "CONCAT"; break;
1170 case TK_UMINUS: zOp = "MINUS"; break;
1171 case TK_UPLUS: zOp = "PLUS"; break;
1172 case TK_BITNOT: zOp = "BITNOT"; break;
1173 case TK_NOT: zOp = "NOT"; break;
1174 case TK_ISNULL: zOp = "ISNULL"; break;
1175 case TK_NOTNULL: zOp = "NOTNULL"; break;
drhf7e36902015-08-13 21:32:41 +00001176
1177 default:
drh5f4a6862016-01-30 12:50:25 +00001178 sqlite3XPrintf(p, "%s", "expr");
drhf7e36902015-08-13 21:32:41 +00001179 break;
1180 }
1181
drha67a3162015-08-15 00:51:23 +00001182 if( zOp ){
drh5f4a6862016-01-30 12:50:25 +00001183 sqlite3XPrintf(p, "%s(", zOp);
1184 displayP4Expr(p, pExpr->pLeft);
1185 if( pExpr->pRight ){
1186 sqlite3StrAccumAppend(p, ",", 1);
1187 displayP4Expr(p, pExpr->pRight);
drha67a3162015-08-15 00:51:23 +00001188 }
drh5f4a6862016-01-30 12:50:25 +00001189 sqlite3StrAccumAppend(p, ")", 1);
drhf7e36902015-08-13 21:32:41 +00001190 }
drhf7e36902015-08-13 21:32:41 +00001191}
1192#endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
1193
1194
1195#if VDBE_DISPLAY_P4
drh9a324642003-09-06 20:12:01 +00001196/*
drh66a51672008-01-03 00:01:23 +00001197** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +00001198** Use zTemp for any required temporary buffer space.
1199*/
drh66a51672008-01-03 00:01:23 +00001200static char *displayP4(Op *pOp, char *zTemp, int nTemp){
1201 char *zP4 = zTemp;
drh5f4a6862016-01-30 12:50:25 +00001202 StrAccum x;
drhd3d39e92004-05-20 22:16:29 +00001203 assert( nTemp>=20 );
drh5f4a6862016-01-30 12:50:25 +00001204 sqlite3StrAccumInit(&x, 0, zTemp, nTemp, 0);
drh66a51672008-01-03 00:01:23 +00001205 switch( pOp->p4type ){
1206 case P4_KEYINFO: {
drh5f4a6862016-01-30 12:50:25 +00001207 int j;
danielk19772dca4ac2008-01-03 11:50:29 +00001208 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
drhe1a022e2012-09-17 17:16:53 +00001209 assert( pKeyInfo->aSortOrder!=0 );
drh5f4a6862016-01-30 12:50:25 +00001210 sqlite3XPrintf(&x, "k(%d", pKeyInfo->nField);
drhd3d39e92004-05-20 22:16:29 +00001211 for(j=0; j<pKeyInfo->nField; j++){
1212 CollSeq *pColl = pKeyInfo->aColl[j];
drh5f4a6862016-01-30 12:50:25 +00001213 const char *zColl = pColl ? pColl->zName : "";
1214 if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
1215 sqlite3XPrintf(&x, ",%s%s", pKeyInfo->aSortOrder[j] ? "-" : "", zColl);
drhd3d39e92004-05-20 22:16:29 +00001216 }
drh5f4a6862016-01-30 12:50:25 +00001217 sqlite3StrAccumAppend(&x, ")", 1);
drhd3d39e92004-05-20 22:16:29 +00001218 break;
1219 }
drh28935362013-12-07 20:39:19 +00001220#ifdef SQLITE_ENABLE_CURSOR_HINTS
1221 case P4_EXPR: {
drh5f4a6862016-01-30 12:50:25 +00001222 displayP4Expr(&x, pOp->p4.pExpr);
drh28935362013-12-07 20:39:19 +00001223 break;
1224 }
1225#endif
drh66a51672008-01-03 00:01:23 +00001226 case P4_COLLSEQ: {
danielk19772dca4ac2008-01-03 11:50:29 +00001227 CollSeq *pColl = pOp->p4.pColl;
drh5f4a6862016-01-30 12:50:25 +00001228 sqlite3XPrintf(&x, "(%.20s)", pColl->zName);
drhd3d39e92004-05-20 22:16:29 +00001229 break;
1230 }
drh66a51672008-01-03 00:01:23 +00001231 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +00001232 FuncDef *pDef = pOp->p4.pFunc;
drh5f4a6862016-01-30 12:50:25 +00001233 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +00001234 break;
1235 }
drhe2d9e7c2015-06-26 18:47:53 +00001236#ifdef SQLITE_DEBUG
drh9c7c9132015-06-26 18:16:52 +00001237 case P4_FUNCCTX: {
1238 FuncDef *pDef = pOp->p4.pCtx->pFunc;
drh5f4a6862016-01-30 12:50:25 +00001239 sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drh9c7c9132015-06-26 18:16:52 +00001240 break;
1241 }
drhe2d9e7c2015-06-26 18:47:53 +00001242#endif
drh66a51672008-01-03 00:01:23 +00001243 case P4_INT64: {
drh5f4a6862016-01-30 12:50:25 +00001244 sqlite3XPrintf(&x, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +00001245 break;
1246 }
drh66a51672008-01-03 00:01:23 +00001247 case P4_INT32: {
drh5f4a6862016-01-30 12:50:25 +00001248 sqlite3XPrintf(&x, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +00001249 break;
1250 }
drh66a51672008-01-03 00:01:23 +00001251 case P4_REAL: {
drh5f4a6862016-01-30 12:50:25 +00001252 sqlite3XPrintf(&x, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +00001253 break;
1254 }
drh66a51672008-01-03 00:01:23 +00001255 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +00001256 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001257 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001258 zP4 = pMem->z;
drhd4e70eb2008-01-02 00:34:36 +00001259 }else if( pMem->flags & MEM_Int ){
drh5f4a6862016-01-30 12:50:25 +00001260 sqlite3XPrintf(&x, "%lld", pMem->u.i);
drhd4e70eb2008-01-02 00:34:36 +00001261 }else if( pMem->flags & MEM_Real ){
drh5f4a6862016-01-30 12:50:25 +00001262 sqlite3XPrintf(&x, "%.16g", pMem->u.r);
drhb8475df2011-12-09 16:21:19 +00001263 }else if( pMem->flags & MEM_Null ){
drh5f4a6862016-01-30 12:50:25 +00001264 zP4 = "NULL";
drh56016892009-08-25 14:24:04 +00001265 }else{
1266 assert( pMem->flags & MEM_Blob );
1267 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001268 }
drh598f1342007-10-23 15:39:45 +00001269 break;
1270 }
drha967e882006-06-13 01:04:52 +00001271#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001272 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001273 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh5f4a6862016-01-30 12:50:25 +00001274 sqlite3XPrintf(&x, "vtab:%p", pVtab);
drha967e882006-06-13 01:04:52 +00001275 break;
1276 }
1277#endif
drh0acb7e42008-06-25 00:12:41 +00001278 case P4_INTARRAY: {
drh5f4a6862016-01-30 12:50:25 +00001279 int i;
drhb1702022016-01-30 00:45:18 +00001280 int *ai = pOp->p4.ai;
1281 int n = ai[0]; /* The first element of an INTARRAY is always the
1282 ** count of the number of elements to follow */
drh5f4a6862016-01-30 12:50:25 +00001283 for(i=1; i<n; i++){
1284 sqlite3XPrintf(&x, ",%d", ai[i]);
1285 }
drhb1702022016-01-30 00:45:18 +00001286 zTemp[0] = '[';
drh5f4a6862016-01-30 12:50:25 +00001287 sqlite3StrAccumAppend(&x, "]", 1);
drh0acb7e42008-06-25 00:12:41 +00001288 break;
1289 }
dan165921a2009-08-28 18:53:45 +00001290 case P4_SUBPROGRAM: {
drh5f4a6862016-01-30 12:50:25 +00001291 sqlite3XPrintf(&x, "program");
dan165921a2009-08-28 18:53:45 +00001292 break;
1293 }
drh4a6f3aa2011-08-28 00:19:26 +00001294 case P4_ADVANCE: {
1295 zTemp[0] = 0;
1296 break;
1297 }
drhd3d39e92004-05-20 22:16:29 +00001298 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001299 zP4 = pOp->p4.z;
drh949f9cd2008-01-12 21:35:57 +00001300 if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +00001301 zP4 = zTemp;
drhd4e70eb2008-01-02 00:34:36 +00001302 zTemp[0] = 0;
drhd3d39e92004-05-20 22:16:29 +00001303 }
1304 }
1305 }
drh5f4a6862016-01-30 12:50:25 +00001306 sqlite3StrAccumFinish(&x);
drh66a51672008-01-03 00:01:23 +00001307 assert( zP4!=0 );
drh66a51672008-01-03 00:01:23 +00001308 return zP4;
drhd3d39e92004-05-20 22:16:29 +00001309}
drhf7e36902015-08-13 21:32:41 +00001310#endif /* VDBE_DISPLAY_P4 */
drhd3d39e92004-05-20 22:16:29 +00001311
drh900b31e2007-08-28 02:27:51 +00001312/*
drhd0679ed2007-08-28 22:24:34 +00001313** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001314**
drhbdaec522011-04-04 00:14:43 +00001315** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001316** attached databases that will be use. A mask of these databases
1317** is maintained in p->btreeMask. The p->lockMask value is the subset of
1318** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001319*/
drhfb982642007-08-30 01:19:59 +00001320void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001321 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001322 assert( i<(int)sizeof(p->btreeMask)*8 );
drha7ab6d82014-07-21 15:44:39 +00001323 DbMaskSet(p->btreeMask, i);
drhdc5b0472011-04-06 22:05:53 +00001324 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
drha7ab6d82014-07-21 15:44:39 +00001325 DbMaskSet(p->lockMask, i);
drhdc5b0472011-04-06 22:05:53 +00001326 }
drh900b31e2007-08-28 02:27:51 +00001327}
1328
dan20d876f2016-01-07 16:06:22 +00001329#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhbdaec522011-04-04 00:14:43 +00001330/*
1331** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1332** this routine obtains the mutex associated with each BtShared structure
1333** that may be accessed by the VM passed as an argument. In doing so it also
1334** sets the BtShared.db member of each of the BtShared structures, ensuring
1335** that the correct busy-handler callback is invoked if required.
1336**
1337** If SQLite is not threadsafe but does support shared-cache mode, then
1338** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1339** of all of BtShared structures accessible via the database handle
1340** associated with the VM.
1341**
1342** If SQLite is not threadsafe and does not support shared-cache mode, this
1343** function is a no-op.
1344**
1345** The p->btreeMask field is a bitmask of all btrees that the prepared
1346** statement p will ever use. Let N be the number of bits in p->btreeMask
1347** corresponding to btrees that use shared cache. Then the runtime of
1348** this routine is N*N. But as N is rarely more than 1, this should not
1349** be a problem.
1350*/
1351void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001352 int i;
drhdc5b0472011-04-06 22:05:53 +00001353 sqlite3 *db;
1354 Db *aDb;
1355 int nDb;
drha7ab6d82014-07-21 15:44:39 +00001356 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
drhdc5b0472011-04-06 22:05:53 +00001357 db = p->db;
1358 aDb = db->aDb;
1359 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001360 for(i=0; i<nDb; i++){
1361 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001362 sqlite3BtreeEnter(aDb[i].pBt);
1363 }
1364 }
drhbdaec522011-04-04 00:14:43 +00001365}
drhe54e0512011-04-05 17:31:56 +00001366#endif
drhbdaec522011-04-04 00:14:43 +00001367
drhe54e0512011-04-05 17:31:56 +00001368#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001369/*
1370** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1371*/
drhf1aabd62015-06-17 01:31:28 +00001372static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001373 int i;
drhdc5b0472011-04-06 22:05:53 +00001374 sqlite3 *db;
1375 Db *aDb;
1376 int nDb;
drhdc5b0472011-04-06 22:05:53 +00001377 db = p->db;
1378 aDb = db->aDb;
1379 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001380 for(i=0; i<nDb; i++){
1381 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001382 sqlite3BtreeLeave(aDb[i].pBt);
1383 }
1384 }
drhbdaec522011-04-04 00:14:43 +00001385}
drhf1aabd62015-06-17 01:31:28 +00001386void sqlite3VdbeLeave(Vdbe *p){
1387 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
1388 vdbeLeave(p);
1389}
drhbdaec522011-04-04 00:14:43 +00001390#endif
drhd3d39e92004-05-20 22:16:29 +00001391
danielk19778b60e0f2005-01-12 09:10:39 +00001392#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00001393/*
1394** Print a single opcode. This routine is used for debugging only.
1395*/
danielk19774adee202004-05-08 08:23:19 +00001396void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
drh66a51672008-01-03 00:01:23 +00001397 char *zP4;
drhd3d39e92004-05-20 22:16:29 +00001398 char zPtr[50];
drh81316f82013-10-29 20:40:47 +00001399 char zCom[100];
drh26198bb2013-10-31 11:15:09 +00001400 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00001401 if( pOut==0 ) pOut = stdout;
drh66a51672008-01-03 00:01:23 +00001402 zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
drhc7379ce2013-10-30 02:28:23 +00001403#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh81316f82013-10-29 20:40:47 +00001404 displayComment(pOp, zP4, zCom, sizeof(zCom));
1405#else
drh2926f962014-02-17 01:13:28 +00001406 zCom[0] = 0;
drh81316f82013-10-29 20:40:47 +00001407#endif
drh4eded602013-12-20 15:59:20 +00001408 /* NB: The sqlite3OpcodeName() function is implemented by code created
1409 ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
1410 ** information from the vdbe.c source text */
danielk197711641c12008-01-03 08:18:30 +00001411 fprintf(pOut, zFormat1, pc,
drh1db639c2008-01-17 02:36:28 +00001412 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
drh81316f82013-10-29 20:40:47 +00001413 zCom
drh1db639c2008-01-17 02:36:28 +00001414 );
drh9a324642003-09-06 20:12:01 +00001415 fflush(pOut);
1416}
1417#endif
1418
1419/*
drh76ff3a02004-09-24 22:32:30 +00001420** Release an array of N Mem elements
1421*/
drhc890fec2008-08-01 20:10:08 +00001422static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00001423 if( p && N ){
drh069c23c2014-09-19 16:13:12 +00001424 Mem *pEnd = &p[N];
danielk1977a7a8e142008-02-13 18:25:27 +00001425 sqlite3 *db = p->db;
dand46def72010-07-24 11:28:28 +00001426 if( db->pnBytesFreed ){
drh069c23c2014-09-19 16:13:12 +00001427 do{
drh17bcb102014-09-18 21:25:33 +00001428 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh069c23c2014-09-19 16:13:12 +00001429 }while( (++p)<pEnd );
drhc176c272010-07-26 13:57:59 +00001430 return;
1431 }
drh069c23c2014-09-19 16:13:12 +00001432 do{
danielk1977e972e032008-09-19 18:32:26 +00001433 assert( (&p[1])==pEnd || p[0].db==p[1].db );
drh75fd0542014-03-01 16:24:44 +00001434 assert( sqlite3VdbeCheckMemInvariants(p) );
danielk1977e972e032008-09-19 18:32:26 +00001435
1436 /* This block is really an inlined version of sqlite3VdbeMemRelease()
1437 ** that takes advantage of the fact that the memory cell value is
1438 ** being set to NULL after releasing any dynamic resources.
1439 **
1440 ** The justification for duplicating code is that according to
1441 ** callgrind, this causes a certain test case to hit the CPU 4.7
1442 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
1443 ** sqlite3MemRelease() were called from here. With -O2, this jumps
1444 ** to 6.6 percent. The test case is inserting 1000 rows into a table
1445 ** with no indexes using a single prepared INSERT statement, bind()
1446 ** and reset(). Inserts are grouped into a transaction.
1447 */
drhb6e8fd12014-03-06 01:56:33 +00001448 testcase( p->flags & MEM_Agg );
1449 testcase( p->flags & MEM_Dyn );
1450 testcase( p->flags & MEM_Frame );
1451 testcase( p->flags & MEM_RowSet );
dan165921a2009-08-28 18:53:45 +00001452 if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
danielk1977e972e032008-09-19 18:32:26 +00001453 sqlite3VdbeMemRelease(p);
drh17bcb102014-09-18 21:25:33 +00001454 }else if( p->szMalloc ){
danielk1977e972e032008-09-19 18:32:26 +00001455 sqlite3DbFree(db, p->zMalloc);
drh17bcb102014-09-18 21:25:33 +00001456 p->szMalloc = 0;
danielk1977e972e032008-09-19 18:32:26 +00001457 }
1458
drha5750cf2014-02-07 13:20:31 +00001459 p->flags = MEM_Undefined;
drh069c23c2014-09-19 16:13:12 +00001460 }while( (++p)<pEnd );
drh76ff3a02004-09-24 22:32:30 +00001461 }
1462}
1463
dan65a7cd12009-09-01 12:16:01 +00001464/*
1465** Delete a VdbeFrame object and its contents. VdbeFrame objects are
1466** allocated by the OP_Program opcode in sqlite3VdbeExec().
1467*/
dan165921a2009-08-28 18:53:45 +00001468void sqlite3VdbeFrameDelete(VdbeFrame *p){
1469 int i;
1470 Mem *aMem = VdbeFrameMem(p);
1471 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
1472 for(i=0; i<p->nChildCsr; i++){
1473 sqlite3VdbeFreeCursor(p->v, apCsr[i]);
1474 }
1475 releaseMemArray(aMem, p->nChildMem);
1476 sqlite3DbFree(p->v->db, p);
1477}
1478
drhb7f91642004-10-31 02:22:47 +00001479#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00001480/*
drh9a324642003-09-06 20:12:01 +00001481** Give a listing of the program in the virtual machine.
1482**
danielk19774adee202004-05-08 08:23:19 +00001483** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00001484** running the code, it invokes the callback once for each instruction.
1485** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00001486**
1487** When p->explain==1, each instruction is listed. When
1488** p->explain==2, only OP_Explain instructions are listed and these
1489** are shown in a different format. p->explain==2 is used to implement
1490** EXPLAIN QUERY PLAN.
drh5cfa5842009-12-31 20:35:08 +00001491**
1492** When p->explain==1, first the main program is listed, then each of
1493** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00001494*/
danielk19774adee202004-05-08 08:23:19 +00001495int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00001496 Vdbe *p /* The VDBE */
1497){
drh5cfa5842009-12-31 20:35:08 +00001498 int nRow; /* Stop when row count reaches this */
dan165921a2009-08-28 18:53:45 +00001499 int nSub = 0; /* Number of sub-vdbes seen so far */
1500 SubProgram **apSub = 0; /* Array of sub-vdbes */
drh5cfa5842009-12-31 20:35:08 +00001501 Mem *pSub = 0; /* Memory cell hold array of subprogs */
1502 sqlite3 *db = p->db; /* The database connection */
1503 int i; /* Loop counter */
1504 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00001505 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh9a324642003-09-06 20:12:01 +00001506
drh9a324642003-09-06 20:12:01 +00001507 assert( p->explain );
drh5f82e3c2009-07-06 00:44:08 +00001508 assert( p->magic==VDBE_MAGIC_RUN );
danielk19776c359f02008-11-21 16:58:03 +00001509 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00001510
drh9cbf3422008-01-17 16:22:13 +00001511 /* Even though this opcode does not use dynamic strings for
1512 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00001513 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00001514 */
dan165921a2009-08-28 18:53:45 +00001515 releaseMemArray(pMem, 8);
drh9734e6e2011-10-07 18:24:25 +00001516 p->pResultSet = 0;
danielk197718f41892004-05-22 07:27:46 +00001517
danielk19776c359f02008-11-21 16:58:03 +00001518 if( p->rc==SQLITE_NOMEM ){
1519 /* This happens if a malloc() inside a call to sqlite3_column_text() or
1520 ** sqlite3_column_text16() failed. */
drh4a642b62016-02-05 01:55:27 +00001521 sqlite3OomFault(db);
danielk19776c359f02008-11-21 16:58:03 +00001522 return SQLITE_ERROR;
1523 }
1524
drh5cfa5842009-12-31 20:35:08 +00001525 /* When the number of output rows reaches nRow, that means the
1526 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
1527 ** nRow is the sum of the number of rows in the main program, plus
1528 ** the sum of the number of rows in all trigger subprograms encountered
1529 ** so far. The nRow value will increase as new trigger subprograms are
1530 ** encountered, but p->pc will eventually catch up to nRow.
1531 */
dan165921a2009-08-28 18:53:45 +00001532 nRow = p->nOp;
1533 if( p->explain==1 ){
drh5cfa5842009-12-31 20:35:08 +00001534 /* The first 8 memory cells are used for the result set. So we will
1535 ** commandeer the 9th cell to use as storage for an array of pointers
1536 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
1537 ** cells. */
1538 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00001539 pSub = &p->aMem[9];
1540 if( pSub->flags&MEM_Blob ){
drh5cfa5842009-12-31 20:35:08 +00001541 /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
1542 ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
dan165921a2009-08-28 18:53:45 +00001543 nSub = pSub->n/sizeof(Vdbe*);
1544 apSub = (SubProgram **)pSub->z;
1545 }
1546 for(i=0; i<nSub; i++){
1547 nRow += apSub[i]->nOp;
1548 }
1549 }
1550
drhecc92422005-09-10 16:46:12 +00001551 do{
1552 i = p->pc++;
dan165921a2009-08-28 18:53:45 +00001553 }while( i<nRow && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
1554 if( i>=nRow ){
drh826fb5a2004-02-14 23:59:57 +00001555 p->rc = SQLITE_OK;
1556 rc = SQLITE_DONE;
drh881feaa2006-07-26 01:39:30 +00001557 }else if( db->u1.isInterrupted ){
drhc5cdca62005-01-11 16:54:14 +00001558 p->rc = SQLITE_INTERRUPT;
drh826fb5a2004-02-14 23:59:57 +00001559 rc = SQLITE_ERROR;
drh22c17b82015-05-15 04:13:15 +00001560 sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
drh826fb5a2004-02-14 23:59:57 +00001561 }else{
drh81316f82013-10-29 20:40:47 +00001562 char *zP4;
dan165921a2009-08-28 18:53:45 +00001563 Op *pOp;
1564 if( i<p->nOp ){
drh5cfa5842009-12-31 20:35:08 +00001565 /* The output line number is small enough that we are still in the
1566 ** main program. */
dan165921a2009-08-28 18:53:45 +00001567 pOp = &p->aOp[i];
1568 }else{
drh5cfa5842009-12-31 20:35:08 +00001569 /* We are currently listing subprograms. Figure out which one and
1570 ** pick up the appropriate opcode. */
dan165921a2009-08-28 18:53:45 +00001571 int j;
1572 i -= p->nOp;
1573 for(j=0; i>=apSub[j]->nOp; j++){
1574 i -= apSub[j]->nOp;
1575 }
1576 pOp = &apSub[j]->aOp[i];
1577 }
danielk19770d78bae2008-01-03 07:09:48 +00001578 if( p->explain==1 ){
1579 pMem->flags = MEM_Int;
danielk19770d78bae2008-01-03 07:09:48 +00001580 pMem->u.i = i; /* Program counter */
1581 pMem++;
1582
1583 pMem->flags = MEM_Static|MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001584 pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
danielk19770d78bae2008-01-03 07:09:48 +00001585 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001586 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +00001587 pMem->enc = SQLITE_UTF8;
1588 pMem++;
dan165921a2009-08-28 18:53:45 +00001589
drh5cfa5842009-12-31 20:35:08 +00001590 /* When an OP_Program opcode is encounter (the only opcode that has
1591 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
1592 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
1593 ** has not already been seen.
1594 */
dan165921a2009-08-28 18:53:45 +00001595 if( pOp->p4type==P4_SUBPROGRAM ){
1596 int nByte = (nSub+1)*sizeof(SubProgram*);
1597 int j;
1598 for(j=0; j<nSub; j++){
1599 if( apSub[j]==pOp->p4.pProgram ) break;
1600 }
dan2b9ee772012-03-31 09:59:44 +00001601 if( j==nSub && SQLITE_OK==sqlite3VdbeMemGrow(pSub, nByte, nSub!=0) ){
dan165921a2009-08-28 18:53:45 +00001602 apSub = (SubProgram **)pSub->z;
1603 apSub[nSub++] = pOp->p4.pProgram;
1604 pSub->flags |= MEM_Blob;
1605 pSub->n = nSub*sizeof(SubProgram*);
1606 }
1607 }
danielk19770d78bae2008-01-03 07:09:48 +00001608 }
drheb2e1762004-05-27 01:53:56 +00001609
1610 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001611 pMem->u.i = pOp->p1; /* P1 */
drheb2e1762004-05-27 01:53:56 +00001612 pMem++;
1613
1614 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001615 pMem->u.i = pOp->p2; /* P2 */
drheb2e1762004-05-27 01:53:56 +00001616 pMem++;
1617
dan2ce22452010-11-08 19:01:16 +00001618 pMem->flags = MEM_Int;
1619 pMem->u.i = pOp->p3; /* P3 */
dan2ce22452010-11-08 19:01:16 +00001620 pMem++;
danielk19770d78bae2008-01-03 07:09:48 +00001621
drh2f2b0272015-08-14 18:50:04 +00001622 if( sqlite3VdbeMemClearAndResize(pMem, 100) ){ /* P4 */
danielk1977357864e2009-03-25 15:43:08 +00001623 assert( p->db->mallocFailed );
1624 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001625 }
drhc91b2fd2014-03-01 18:13:23 +00001626 pMem->flags = MEM_Str|MEM_Term;
drh2f2b0272015-08-14 18:50:04 +00001627 zP4 = displayP4(pOp, pMem->z, pMem->szMalloc);
drh81316f82013-10-29 20:40:47 +00001628 if( zP4!=pMem->z ){
1629 sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
danielk1977a7a8e142008-02-13 18:25:27 +00001630 }else{
1631 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001632 pMem->n = sqlite3Strlen30(pMem->z);
danielk1977a7a8e142008-02-13 18:25:27 +00001633 pMem->enc = SQLITE_UTF8;
1634 }
danielk19770d78bae2008-01-03 07:09:48 +00001635 pMem++;
drheb2e1762004-05-27 01:53:56 +00001636
danielk19770d78bae2008-01-03 07:09:48 +00001637 if( p->explain==1 ){
drh322f2852014-09-19 00:43:39 +00001638 if( sqlite3VdbeMemClearAndResize(pMem, 4) ){
danielk1977357864e2009-03-25 15:43:08 +00001639 assert( p->db->mallocFailed );
1640 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001641 }
drhc91b2fd2014-03-01 18:13:23 +00001642 pMem->flags = MEM_Str|MEM_Term;
drh85e5f0d2008-02-19 18:28:13 +00001643 pMem->n = 2;
1644 sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
danielk19770d78bae2008-01-03 07:09:48 +00001645 pMem->enc = SQLITE_UTF8;
1646 pMem++;
1647
drhc7379ce2013-10-30 02:28:23 +00001648#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh322f2852014-09-19 00:43:39 +00001649 if( sqlite3VdbeMemClearAndResize(pMem, 500) ){
drh81316f82013-10-29 20:40:47 +00001650 assert( p->db->mallocFailed );
1651 return SQLITE_ERROR;
drh52391cb2008-02-14 23:44:13 +00001652 }
drhc91b2fd2014-03-01 18:13:23 +00001653 pMem->flags = MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001654 pMem->n = displayComment(pOp, zP4, pMem->z, 500);
drh81316f82013-10-29 20:40:47 +00001655 pMem->enc = SQLITE_UTF8;
1656#else
1657 pMem->flags = MEM_Null; /* Comment */
drh81316f82013-10-29 20:40:47 +00001658#endif
danielk19770d78bae2008-01-03 07:09:48 +00001659 }
1660
dan2ce22452010-11-08 19:01:16 +00001661 p->nResColumn = 8 - 4*(p->explain-1);
drh9734e6e2011-10-07 18:24:25 +00001662 p->pResultSet = &p->aMem[1];
drh826fb5a2004-02-14 23:59:57 +00001663 p->rc = SQLITE_OK;
1664 rc = SQLITE_ROW;
drh9a324642003-09-06 20:12:01 +00001665 }
drh826fb5a2004-02-14 23:59:57 +00001666 return rc;
drh9a324642003-09-06 20:12:01 +00001667}
drhb7f91642004-10-31 02:22:47 +00001668#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00001669
drh7c4ac0c2007-04-05 11:25:58 +00001670#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00001671/*
drh3f7d4e42004-07-24 14:35:58 +00001672** Print the SQL that was used to generate a VDBE program.
1673*/
1674void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00001675 const char *z = 0;
1676 if( p->zSql ){
1677 z = p->zSql;
1678 }else if( p->nOp>=1 ){
1679 const VdbeOp *pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001680 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh84e55a82013-11-13 17:58:23 +00001681 z = pOp->p4.z;
1682 while( sqlite3Isspace(*z) ) z++;
1683 }
drh3f7d4e42004-07-24 14:35:58 +00001684 }
drh84e55a82013-11-13 17:58:23 +00001685 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00001686}
drh7c4ac0c2007-04-05 11:25:58 +00001687#endif
drh3f7d4e42004-07-24 14:35:58 +00001688
drh602c2372007-03-01 00:29:13 +00001689#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
1690/*
1691** Print an IOTRACE message showing SQL content.
1692*/
1693void sqlite3VdbeIOTraceSql(Vdbe *p){
1694 int nOp = p->nOp;
1695 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00001696 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00001697 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00001698 pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00001699 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00001700 int i, j;
drh00a18e42007-08-13 11:10:34 +00001701 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00001702 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00001703 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00001704 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00001705 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00001706 if( z[i-1]!=' ' ){
1707 z[j++] = ' ';
1708 }
1709 }else{
1710 z[j++] = z[i];
1711 }
1712 }
1713 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00001714 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00001715 }
1716}
1717#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
1718
drha7dc4a32016-01-25 02:15:02 +00001719/* An instance of this object describes bulk memory available for use
1720** by subcomponents of a prepared statement. Space is allocated out
1721** of a ReusableSpace object by the allocSpace() routine below.
1722*/
1723struct ReusableSpace {
1724 u8 *pSpace; /* Available memory */
1725 int nFree; /* Bytes of available memory */
1726 int nNeeded; /* Total bytes that could not be allocated */
1727};
1728
1729/* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
1730** from the ReusableSpace object. Return a pointer to the allocated
1731** memory on success. If insufficient memory is available in the
1732** ReusableSpace object, increase the ReusableSpace.nNeeded
1733** value by the amount needed and return NULL.
drh4800b2e2009-12-08 15:35:22 +00001734**
drha7dc4a32016-01-25 02:15:02 +00001735** If pBuf is not initially NULL, that means that the memory has already
1736** been allocated by a prior call to this routine, so just return a copy
1737** of pBuf and leave ReusableSpace unchanged.
drhb2771ce2009-02-20 01:28:59 +00001738**
drha7dc4a32016-01-25 02:15:02 +00001739** This allocator is employed to repurpose unused slots at the end of the
1740** opcode array of prepared state for other memory needs of the prepared
1741** statement.
drhb2771ce2009-02-20 01:28:59 +00001742*/
drh4800b2e2009-12-08 15:35:22 +00001743static void *allocSpace(
drha7dc4a32016-01-25 02:15:02 +00001744 struct ReusableSpace *p, /* Bulk memory available for allocation */
1745 void *pBuf, /* Pointer to a prior allocation */
1746 int nByte /* Bytes of memory needed */
drhb2771ce2009-02-20 01:28:59 +00001747){
drha7dc4a32016-01-25 02:15:02 +00001748 assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
drhd797a9b2015-12-07 16:43:44 +00001749 if( pBuf==0 ){
1750 nByte = ROUND8(nByte);
drha7dc4a32016-01-25 02:15:02 +00001751 if( nByte <= p->nFree ){
1752 p->nFree -= nByte;
1753 pBuf = &p->pSpace[p->nFree];
drhd797a9b2015-12-07 16:43:44 +00001754 }else{
drha7dc4a32016-01-25 02:15:02 +00001755 p->nNeeded += nByte;
drhd797a9b2015-12-07 16:43:44 +00001756 }
drhb2771ce2009-02-20 01:28:59 +00001757 }
drhd797a9b2015-12-07 16:43:44 +00001758 assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
drh4800b2e2009-12-08 15:35:22 +00001759 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00001760}
drh602c2372007-03-01 00:29:13 +00001761
drh3f7d4e42004-07-24 14:35:58 +00001762/*
drh124c0b42011-06-01 18:15:55 +00001763** Rewind the VDBE back to the beginning in preparation for
1764** running it.
drh9a324642003-09-06 20:12:01 +00001765*/
drh124c0b42011-06-01 18:15:55 +00001766void sqlite3VdbeRewind(Vdbe *p){
1767#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
1768 int i;
1769#endif
drh9a324642003-09-06 20:12:01 +00001770 assert( p!=0 );
drh9a324642003-09-06 20:12:01 +00001771 assert( p->magic==VDBE_MAGIC_INIT );
1772
drhc16a03b2004-09-15 13:38:10 +00001773 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00001774 */
drhc16a03b2004-09-15 13:38:10 +00001775 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00001776
danielk197700e13612008-11-17 19:18:54 +00001777 /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
danielk1977634f2982005-03-28 08:44:07 +00001778 p->magic = VDBE_MAGIC_RUN;
1779
drh124c0b42011-06-01 18:15:55 +00001780#ifdef SQLITE_DEBUG
1781 for(i=1; i<p->nMem; i++){
1782 assert( p->aMem[i].db==p->db );
1783 }
1784#endif
1785 p->pc = -1;
1786 p->rc = SQLITE_OK;
1787 p->errorAction = OE_Abort;
drh124c0b42011-06-01 18:15:55 +00001788 p->nChange = 0;
1789 p->cacheCtr = 1;
1790 p->minWriteFileFormat = 255;
1791 p->iStatement = 0;
1792 p->nFkConstraint = 0;
1793#ifdef VDBE_PROFILE
1794 for(i=0; i<p->nOp; i++){
1795 p->aOp[i].cnt = 0;
1796 p->aOp[i].cycles = 0;
1797 }
1798#endif
1799}
1800
1801/*
1802** Prepare a virtual machine for execution for the first time after
1803** creating the virtual machine. This involves things such
drh7abda852014-09-19 16:02:06 +00001804** as allocating registers and initializing the program counter.
drh124c0b42011-06-01 18:15:55 +00001805** After the VDBE has be prepped, it can be executed by one or more
1806** calls to sqlite3VdbeExec().
1807**
peter.d.reid60ec9142014-09-06 16:39:46 +00001808** This function may be called exactly once on each virtual machine.
drh124c0b42011-06-01 18:15:55 +00001809** After this routine is called the VM has been "packaged" and is ready
peter.d.reid60ec9142014-09-06 16:39:46 +00001810** to run. After this routine is called, further calls to
drh124c0b42011-06-01 18:15:55 +00001811** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
1812** the Vdbe from the Parse object that helped generate it so that the
1813** the Vdbe becomes an independent entity and the Parse object can be
1814** destroyed.
1815**
1816** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
1817** to its initial state after it has been run.
1818*/
1819void sqlite3VdbeMakeReady(
1820 Vdbe *p, /* The VDBE */
1821 Parse *pParse /* Parsing context */
1822){
1823 sqlite3 *db; /* The database connection */
1824 int nVar; /* Number of parameters */
1825 int nMem; /* Number of VM memory registers */
1826 int nCursor; /* Number of cursors required */
1827 int nArg; /* Number of arguments in subprograms */
dan1d8cb212011-12-09 13:24:16 +00001828 int nOnce; /* Number of OP_Once instructions */
drh124c0b42011-06-01 18:15:55 +00001829 int n; /* Loop counter */
drha7dc4a32016-01-25 02:15:02 +00001830 struct ReusableSpace x; /* Reusable bulk memory */
drh124c0b42011-06-01 18:15:55 +00001831
1832 assert( p!=0 );
1833 assert( p->nOp>0 );
1834 assert( pParse!=0 );
1835 assert( p->magic==VDBE_MAGIC_INIT );
drh73d5b8f2013-12-23 19:09:07 +00001836 assert( pParse==p->pParse );
drh124c0b42011-06-01 18:15:55 +00001837 db = p->db;
1838 assert( db->mallocFailed==0 );
1839 nVar = pParse->nVar;
1840 nMem = pParse->nMem;
1841 nCursor = pParse->nTab;
1842 nArg = pParse->nMaxArg;
dan1d8cb212011-12-09 13:24:16 +00001843 nOnce = pParse->nOnce;
drh20e226d2012-01-01 13:58:53 +00001844 if( nOnce==0 ) nOnce = 1; /* Ensure at least one byte in p->aOnceFlag[] */
drh124c0b42011-06-01 18:15:55 +00001845
danielk1977cd3e8f72008-03-25 09:47:35 +00001846 /* For each cursor required, also allocate a memory cell. Memory
1847 ** cells (nMem+1-nCursor)..nMem, inclusive, will never be used by
drha7dc4a32016-01-25 02:15:02 +00001848 ** the vdbe program. Instead they are used to allocate memory for
drhdfe88ec2008-11-03 20:55:06 +00001849 ** VdbeCursor/BtCursor structures. The blob of memory associated with
danielk1977cd3e8f72008-03-25 09:47:35 +00001850 ** cursor 0 is stored in memory cell nMem. Memory cell (nMem-1)
1851 ** stores the blob of memory associated with cursor 1, etc.
1852 **
1853 ** See also: allocateCursor().
1854 */
1855 nMem += nCursor;
1856
drha7dc4a32016-01-25 02:15:02 +00001857 /* Figure out how much reusable memory is available at the end of the
1858 ** opcode array. This extra memory will be reallocated for other elements
1859 ** of the prepared statement.
drh9a324642003-09-06 20:12:01 +00001860 */
drha7dc4a32016-01-25 02:15:02 +00001861 n = ROUND8(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
1862 x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
1863 assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
1864 x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
1865 assert( x.nFree>=0 );
1866 if( x.nFree>0 ){
1867 memset(x.pSpace, 0, x.nFree);
1868 assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
drh08169052016-01-05 03:39:25 +00001869 }
drh19875c82009-12-08 19:58:19 +00001870
drh124c0b42011-06-01 18:15:55 +00001871 resolveP2Values(p, &nArg);
1872 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
1873 if( pParse->explain && nMem<10 ){
1874 nMem = 10;
1875 }
drhaab910c2011-06-27 00:01:22 +00001876 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00001877
drha7dc4a32016-01-25 02:15:02 +00001878 /* Memory for registers, parameters, cursor, etc, is allocated in one or two
1879 ** passes. On the first pass, we try to reuse unused memory at the
drh124c0b42011-06-01 18:15:55 +00001880 ** end of the opcode array. If we are unable to satisfy all memory
1881 ** requirements by reusing the opcode array tail, then the second
drha7dc4a32016-01-25 02:15:02 +00001882 ** pass will fill in the remainder using a fresh memory allocation.
drh124c0b42011-06-01 18:15:55 +00001883 **
1884 ** This two-pass approach that reuses as much memory as possible from
drha7dc4a32016-01-25 02:15:02 +00001885 ** the leftover memory at the end of the opcode array. This can significantly
drh124c0b42011-06-01 18:15:55 +00001886 ** reduce the amount of memory held by a prepared statement.
1887 */
1888 do {
drha7dc4a32016-01-25 02:15:02 +00001889 x.nNeeded = 0;
1890 p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
1891 p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
1892 p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
1893 p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
1894 p->aOnceFlag = allocSpace(&x, p->aOnceFlag, nOnce);
dane2f771b2014-11-03 15:33:17 +00001895#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drha7dc4a32016-01-25 02:15:02 +00001896 p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
dane2f771b2014-11-03 15:33:17 +00001897#endif
drha7dc4a32016-01-25 02:15:02 +00001898 if( x.nNeeded==0 ) break;
1899 x.pSpace = p->pFree = sqlite3DbMallocZero(db, x.nNeeded);
1900 x.nFree = x.nNeeded;
1901 }while( !db->mallocFailed );
drhb2771ce2009-02-20 01:28:59 +00001902
drhd2a56232013-01-28 19:00:20 +00001903 p->nCursor = nCursor;
dan1d8cb212011-12-09 13:24:16 +00001904 p->nOnceFlag = nOnce;
drh124c0b42011-06-01 18:15:55 +00001905 if( p->aVar ){
1906 p->nVar = (ynVar)nVar;
1907 for(n=0; n<nVar; n++){
1908 p->aVar[n].flags = MEM_Null;
1909 p->aVar[n].db = db;
danielk197754db47e2004-05-19 10:36:43 +00001910 }
drh82a48512003-09-06 22:45:20 +00001911 }
drh6d664b42016-01-20 01:48:25 +00001912 p->nzVar = pParse->nzVar;
1913 p->azVar = pParse->azVar;
1914 pParse->nzVar = 0;
1915 pParse->azVar = 0;
drh124c0b42011-06-01 18:15:55 +00001916 if( p->aMem ){
1917 p->aMem--; /* aMem[] goes from 1..nMem */
1918 p->nMem = nMem; /* not from 0..nMem-1 */
1919 for(n=1; n<=nMem; n++){
drha5750cf2014-02-07 13:20:31 +00001920 p->aMem[n].flags = MEM_Undefined;
drh124c0b42011-06-01 18:15:55 +00001921 p->aMem[n].db = db;
drhcf64d8b2003-12-31 17:57:10 +00001922 }
drh9a324642003-09-06 20:12:01 +00001923 }
drh124c0b42011-06-01 18:15:55 +00001924 p->explain = pParse->explain;
1925 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00001926}
1927
drh9a324642003-09-06 20:12:01 +00001928/*
danielk1977cd3e8f72008-03-25 09:47:35 +00001929** Close a VDBE cursor and release all the resources that cursor
1930** happens to hold.
drh9a324642003-09-06 20:12:01 +00001931*/
drhdfe88ec2008-11-03 20:55:06 +00001932void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh4774b132004-06-12 20:12:51 +00001933 if( pCx==0 ){
1934 return;
1935 }
drhc960dcb2015-11-20 19:22:01 +00001936 assert( pCx->pBt==0 || pCx->eCurType==CURTYPE_BTREE );
1937 switch( pCx->eCurType ){
1938 case CURTYPE_SORTER: {
1939 sqlite3VdbeSorterClose(p->db, pCx);
1940 break;
1941 }
1942 case CURTYPE_BTREE: {
1943 if( pCx->pBt ){
1944 sqlite3BtreeClose(pCx->pBt);
1945 /* The pCx->pCursor will be close automatically, if it exists, by
1946 ** the call above. */
1947 }else{
1948 assert( pCx->uc.pCursor!=0 );
1949 sqlite3BtreeCloseCursor(pCx->uc.pCursor);
1950 }
1951 break;
1952 }
drh9eff6162006-06-12 21:59:13 +00001953#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00001954 case CURTYPE_VTAB: {
1955 sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
1956 const sqlite3_module *pModule = pVCur->pVtab->pModule;
1957 assert( pVCur->pVtab->nRef>0 );
1958 pVCur->pVtab->nRef--;
1959 pModule->xClose(pVCur);
1960 break;
1961 }
drh9eff6162006-06-12 21:59:13 +00001962#endif
drhc960dcb2015-11-20 19:22:01 +00001963 }
drh9a324642003-09-06 20:12:01 +00001964}
1965
dan65a7cd12009-09-01 12:16:01 +00001966/*
drhab4e7f32015-04-16 18:11:50 +00001967** Close all cursors in the current frame.
1968*/
1969static void closeCursorsInFrame(Vdbe *p){
1970 if( p->apCsr ){
1971 int i;
1972 for(i=0; i<p->nCursor; i++){
1973 VdbeCursor *pC = p->apCsr[i];
1974 if( pC ){
1975 sqlite3VdbeFreeCursor(p, pC);
1976 p->apCsr[i] = 0;
1977 }
1978 }
1979 }
1980}
1981
1982/*
dan65a7cd12009-09-01 12:16:01 +00001983** Copy the values stored in the VdbeFrame structure to its Vdbe. This
1984** is used, for example, when a trigger sub-program is halted to restore
1985** control to the main program.
1986*/
dan165921a2009-08-28 18:53:45 +00001987int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
1988 Vdbe *v = pFrame->v;
drhab4e7f32015-04-16 18:11:50 +00001989 closeCursorsInFrame(v);
dane2f771b2014-11-03 15:33:17 +00001990#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00001991 v->anExec = pFrame->anExec;
dane2f771b2014-11-03 15:33:17 +00001992#endif
dan1d8cb212011-12-09 13:24:16 +00001993 v->aOnceFlag = pFrame->aOnceFlag;
1994 v->nOnceFlag = pFrame->nOnceFlag;
dan165921a2009-08-28 18:53:45 +00001995 v->aOp = pFrame->aOp;
1996 v->nOp = pFrame->nOp;
1997 v->aMem = pFrame->aMem;
1998 v->nMem = pFrame->nMem;
1999 v->apCsr = pFrame->apCsr;
2000 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00002001 v->db->lastRowid = pFrame->lastRowid;
2002 v->nChange = pFrame->nChange;
danc3da6672014-10-28 18:24:16 +00002003 v->db->nChange = pFrame->nDbChange;
dan165921a2009-08-28 18:53:45 +00002004 return pFrame->pc;
2005}
2006
drh9a324642003-09-06 20:12:01 +00002007/*
drh5f82e3c2009-07-06 00:44:08 +00002008** Close all cursors.
dan165921a2009-08-28 18:53:45 +00002009**
2010** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
2011** cell array. This is necessary as the memory cell array may contain
2012** pointers to VdbeFrame objects, which may in turn contain pointers to
2013** open cursors.
drh9a324642003-09-06 20:12:01 +00002014*/
drh5f82e3c2009-07-06 00:44:08 +00002015static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00002016 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00002017 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00002018 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
2019 sqlite3VdbeFrameRestore(pFrame);
drhf526dca2014-10-13 17:42:05 +00002020 p->pFrame = 0;
2021 p->nFrame = 0;
dan165921a2009-08-28 18:53:45 +00002022 }
drhf526dca2014-10-13 17:42:05 +00002023 assert( p->nFrame==0 );
drhab4e7f32015-04-16 18:11:50 +00002024 closeCursorsInFrame(p);
dan523a0872009-08-31 05:23:32 +00002025 if( p->aMem ){
2026 releaseMemArray(&p->aMem[1], p->nMem);
2027 }
dan27106572010-12-01 08:04:47 +00002028 while( p->pDelFrame ){
2029 VdbeFrame *pDel = p->pDelFrame;
2030 p->pDelFrame = pDel->pParent;
2031 sqlite3VdbeFrameDelete(pDel);
2032 }
dan0c547792013-07-18 17:12:08 +00002033
2034 /* Delete any auxdata allocations made by the VM */
drhf526dca2014-10-13 17:42:05 +00002035 if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p, -1, 0);
dan0c547792013-07-18 17:12:08 +00002036 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00002037}
2038
2039/*
drh7abda852014-09-19 16:02:06 +00002040** Clean up the VM after a single run.
drh9a324642003-09-06 20:12:01 +00002041*/
drhc890fec2008-08-01 20:10:08 +00002042static void Cleanup(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002043 sqlite3 *db = p->db;
dan165921a2009-08-28 18:53:45 +00002044
2045#ifdef SQLITE_DEBUG
2046 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
2047 ** Vdbe.aMem[] arrays have already been cleaned up. */
2048 int i;
drhb8475df2011-12-09 16:21:19 +00002049 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
2050 if( p->aMem ){
drha5750cf2014-02-07 13:20:31 +00002051 for(i=1; i<=p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
drhb8475df2011-12-09 16:21:19 +00002052 }
dan165921a2009-08-28 18:53:45 +00002053#endif
2054
drh633e6d52008-07-28 19:34:53 +00002055 sqlite3DbFree(db, p->zErrMsg);
drh9a324642003-09-06 20:12:01 +00002056 p->zErrMsg = 0;
drhd4e70eb2008-01-02 00:34:36 +00002057 p->pResultSet = 0;
drh9a324642003-09-06 20:12:01 +00002058}
2059
2060/*
danielk197722322fd2004-05-25 23:35:17 +00002061** Set the number of result columns that will be returned by this SQL
2062** statement. This is now set at compile time, rather than during
2063** execution of the vdbe program so that sqlite3_column_count() can
2064** be called on an SQL statement before sqlite3_step().
2065*/
2066void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00002067 Mem *pColName;
2068 int n;
drh633e6d52008-07-28 19:34:53 +00002069 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002070
drhc890fec2008-08-01 20:10:08 +00002071 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00002072 sqlite3DbFree(db, p->aColName);
danielk1977955de522006-02-10 02:27:42 +00002073 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00002074 p->nResColumn = (u16)nResColumn;
drh633e6d52008-07-28 19:34:53 +00002075 p->aColName = pColName = (Mem*)sqlite3DbMallocZero(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00002076 if( p->aColName==0 ) return;
2077 while( n-- > 0 ){
drh4a50aac2007-08-23 02:47:53 +00002078 pColName->flags = MEM_Null;
drh153c62c2007-08-24 03:51:33 +00002079 pColName->db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002080 pColName++;
drh76ff3a02004-09-24 22:32:30 +00002081 }
danielk197722322fd2004-05-25 23:35:17 +00002082}
2083
2084/*
danielk19773cf86062004-05-26 10:11:05 +00002085** Set the name of the idx'th column to be returned by the SQL statement.
2086** zName must be a pointer to a nul terminated string.
2087**
2088** This call must be made after a call to sqlite3VdbeSetNumCols().
2089**
danielk197710fb7492008-10-31 10:53:22 +00002090** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
2091** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
2092** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00002093*/
danielk197710fb7492008-10-31 10:53:22 +00002094int sqlite3VdbeSetColName(
2095 Vdbe *p, /* Vdbe being configured */
2096 int idx, /* Index of column zName applies to */
2097 int var, /* One of the COLNAME_* constants */
2098 const char *zName, /* Pointer to buffer containing name */
2099 void (*xDel)(void*) /* Memory management strategy for zName */
2100){
danielk19773cf86062004-05-26 10:11:05 +00002101 int rc;
2102 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00002103 assert( idx<p->nResColumn );
2104 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00002105 if( p->db->mallocFailed ){
2106 assert( !zName || xDel!=SQLITE_DYNAMIC );
2107 return SQLITE_NOMEM;
2108 }
drh76ff3a02004-09-24 22:32:30 +00002109 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00002110 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00002111 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00002112 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00002113 return rc;
2114}
2115
danielk197713adf8a2004-06-03 16:08:41 +00002116/*
2117** A read or write transaction may or may not be active on database handle
2118** db. If a transaction is active, commit it. If there is a
2119** write-transaction spanning more than one database file, this routine
2120** takes care of the master journal trickery.
2121*/
danielk19773e3a84d2008-08-01 17:37:40 +00002122static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00002123 int i;
2124 int nTrans = 0; /* Number of databases with an active write-transaction */
2125 int rc = SQLITE_OK;
2126 int needXcommit = 0;
2127
shane36840fd2009-06-26 16:32:13 +00002128#ifdef SQLITE_OMIT_VIRTUALTABLE
2129 /* With this option, sqlite3VtabSync() is defined to be simply
2130 ** SQLITE_OK so p is not used.
2131 */
2132 UNUSED_PARAMETER(p);
2133#endif
2134
danielk19775bd270b2006-07-25 15:14:52 +00002135 /* Before doing anything else, call the xSync() callback for any
2136 ** virtual module tables written in this transaction. This has to
2137 ** be done before determining whether a master journal file is
2138 ** required, as an xSync() callback may add an attached database
2139 ** to the transaction.
2140 */
dan016f7812013-08-21 17:35:48 +00002141 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00002142
2143 /* This loop determines (a) if the commit hook should be invoked and
2144 ** (b) how many database files have open write transactions, not
2145 ** including the temp database. (b) is important because if more than
2146 ** one database file has an open write transaction, a master journal
2147 ** file is required for an atomic commit.
2148 */
drhabfb62f2010-07-30 11:20:35 +00002149 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002150 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002151 if( sqlite3BtreeIsInTrans(pBt) ){
danielk197713adf8a2004-06-03 16:08:41 +00002152 needXcommit = 1;
2153 if( i!=1 ) nTrans++;
dan6b9bb592012-10-05 19:43:02 +00002154 sqlite3BtreeEnter(pBt);
drhabfb62f2010-07-30 11:20:35 +00002155 rc = sqlite3PagerExclusiveLock(sqlite3BtreePager(pBt));
dan6b9bb592012-10-05 19:43:02 +00002156 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00002157 }
2158 }
drhabfb62f2010-07-30 11:20:35 +00002159 if( rc!=SQLITE_OK ){
2160 return rc;
2161 }
danielk197713adf8a2004-06-03 16:08:41 +00002162
2163 /* If there are any write-transactions at all, invoke the commit hook */
2164 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00002165 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00002166 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002167 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00002168 }
2169 }
2170
danielk197740b38dc2004-06-26 08:38:24 +00002171 /* The simple case - no more than one database file (not counting the
2172 ** TEMP database) has a transaction active. There is no need for the
drh2ac3ee92004-06-07 16:27:46 +00002173 ** master-journal.
drhc9e06862004-06-09 20:03:08 +00002174 **
danielk197740b38dc2004-06-26 08:38:24 +00002175 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00002176 ** string, it means the main database is :memory: or a temp file. In
2177 ** that case we do not support atomic multi-file commits, so use the
2178 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00002179 */
drhea678832008-12-10 19:26:22 +00002180 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
2181 || nTrans<=1
2182 ){
danielk197704103022009-02-03 16:51:24 +00002183 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002184 Btree *pBt = db->aDb[i].pBt;
2185 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002186 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00002187 }
2188 }
2189
drh80e35f42007-03-30 14:06:34 +00002190 /* Do the commit only if all databases successfully complete phase 1.
2191 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
2192 ** IO error while deleting or truncating a journal file. It is unlikely,
2193 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00002194 */
2195 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
2196 Btree *pBt = db->aDb[i].pBt;
2197 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002198 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00002199 }
danielk1977979f38e2007-03-27 16:19:51 +00002200 }
2201 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00002202 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002203 }
2204 }
2205
2206 /* The complex case - There is a multi-file write-transaction active.
2207 ** This requires a master journal file to ensure the transaction is
peter.d.reid60ec9142014-09-06 16:39:46 +00002208 ** committed atomically.
danielk197713adf8a2004-06-03 16:08:41 +00002209 */
danielk197744ee5bf2005-05-27 09:41:12 +00002210#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00002211 else{
danielk1977b4b47412007-08-17 15:53:36 +00002212 sqlite3_vfs *pVfs = db->pVfs;
drh2c8997b2005-08-27 16:36:48 +00002213 int needSync = 0;
danielk197713adf8a2004-06-03 16:08:41 +00002214 char *zMaster = 0; /* File-name for the master journal */
2215 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
danielk1977b4b47412007-08-17 15:53:36 +00002216 sqlite3_file *pMaster = 0;
danielk197762079062007-08-15 17:08:46 +00002217 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00002218 int res;
drhf5808602011-12-16 00:33:04 +00002219 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00002220 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00002221
2222 /* Select a master journal file name */
drh5c531a42011-12-16 01:21:31 +00002223 nMainFile = sqlite3Strlen30(zMainFile);
drh52bcde02012-01-03 14:50:45 +00002224 zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
drh5c531a42011-12-16 01:21:31 +00002225 if( zMaster==0 ) return SQLITE_NOMEM;
danielk197713adf8a2004-06-03 16:08:41 +00002226 do {
drhdc5ea5c2008-12-10 17:19:59 +00002227 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00002228 if( retryCount ){
2229 if( retryCount>100 ){
2230 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
2231 sqlite3OsDelete(pVfs, zMaster, 0);
2232 break;
2233 }else if( retryCount==1 ){
2234 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
2235 }
danielk197713adf8a2004-06-03 16:08:41 +00002236 }
drh84968c02011-12-16 15:11:39 +00002237 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00002238 sqlite3_randomness(sizeof(iRandom), &iRandom);
drh5c531a42011-12-16 01:21:31 +00002239 sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00002240 (iRandom>>8)&0xffffff, iRandom&0xff);
drhf5808602011-12-16 00:33:04 +00002241 /* The antipenultimate character of the master journal name must
2242 ** be "9" to avoid name collisions when using 8+3 filenames. */
drh5c531a42011-12-16 01:21:31 +00002243 assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
drh81cc5162011-05-17 20:36:21 +00002244 sqlite3FileSuffix3(zMainFile, zMaster);
danielk1977861f7452008-06-05 11:39:11 +00002245 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
2246 }while( rc==SQLITE_OK && res );
2247 if( rc==SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00002248 /* Open the master journal. */
2249 rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
2250 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
2251 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
2252 );
2253 }
danielk197713adf8a2004-06-03 16:08:41 +00002254 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002255 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002256 return rc;
2257 }
2258
2259 /* Write the name of each database file in the transaction into the new
2260 ** master journal file. If an error occurs at this point close
2261 ** and delete the master journal file. All the individual journal files
2262 ** still have 'null' as the master journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00002263 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00002264 */
danielk19771e536952007-08-16 10:09:01 +00002265 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002266 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002267 if( sqlite3BtreeIsInTrans(pBt) ){
danielk19775865e3d2004-06-14 06:03:57 +00002268 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00002269 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00002270 continue; /* Ignore TEMP and :memory: databases */
2271 }
drh8c96a6e2010-08-31 01:09:15 +00002272 assert( zFile[0]!=0 );
drh2c8997b2005-08-27 16:36:48 +00002273 if( !needSync && !sqlite3BtreeSyncDisabled(pBt) ){
2274 needSync = 1;
2275 }
drhea678832008-12-10 19:26:22 +00002276 rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
2277 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00002278 if( rc!=SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00002279 sqlite3OsCloseFree(pMaster);
2280 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002281 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002282 return rc;
2283 }
2284 }
2285 }
2286
danielk19779663b8f2007-08-24 11:52:28 +00002287 /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
2288 ** flag is set this is not required.
2289 */
danielk1977bea2a942009-01-20 17:06:27 +00002290 if( needSync
2291 && 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
2292 && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
2293 ){
danielk1977fee2d252007-08-18 10:59:19 +00002294 sqlite3OsCloseFree(pMaster);
2295 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002296 sqlite3DbFree(db, zMaster);
danielk19775865e3d2004-06-14 06:03:57 +00002297 return rc;
2298 }
drhc9e06862004-06-09 20:03:08 +00002299
danielk197713adf8a2004-06-03 16:08:41 +00002300 /* Sync all the db files involved in the transaction. The same call
2301 ** sets the master journal pointer in each individual journal. If
2302 ** an error occurs here, do not delete the master journal file.
2303 **
drh80e35f42007-03-30 14:06:34 +00002304 ** If the error occurs during the first call to
2305 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
2306 ** master journal file will be orphaned. But we cannot delete it,
2307 ** in case the master journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00002308 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00002309 */
danielk19775bd270b2006-07-25 15:14:52 +00002310 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002311 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002312 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002313 rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002314 }
2315 }
danielk1977fee2d252007-08-18 10:59:19 +00002316 sqlite3OsCloseFree(pMaster);
drhabfb62f2010-07-30 11:20:35 +00002317 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00002318 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002319 sqlite3DbFree(db, zMaster);
danielk19775bd270b2006-07-25 15:14:52 +00002320 return rc;
2321 }
danielk197713adf8a2004-06-03 16:08:41 +00002322
danielk1977962398d2004-06-14 09:35:16 +00002323 /* Delete the master journal file. This commits the transaction. After
2324 ** doing this the directory is synced again before any individual
2325 ** transaction files are deleted.
2326 */
drh75a4d7c2015-03-16 16:44:55 +00002327 rc = sqlite3OsDelete(pVfs, zMaster, needSync);
drh633e6d52008-07-28 19:34:53 +00002328 sqlite3DbFree(db, zMaster);
drhc416ba92007-03-30 18:42:55 +00002329 zMaster = 0;
drh29a01382006-08-13 19:04:18 +00002330 if( rc ){
2331 return rc;
2332 }
danielk197713adf8a2004-06-03 16:08:41 +00002333
2334 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00002335 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
2336 ** deleting or truncating journals. If something goes wrong while
2337 ** this is happening we don't really care. The integrity of the
2338 ** transaction is already guaranteed, but some stray 'cold' journals
2339 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00002340 */
danielk1977979f38e2007-03-27 16:19:51 +00002341 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002342 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00002343 for(i=0; i<db->nDb; i++){
2344 Btree *pBt = db->aDb[i].pBt;
2345 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002346 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00002347 }
2348 }
danielk19772d1d86f2008-06-20 14:59:51 +00002349 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00002350 enable_simulated_io_errors();
2351
danielk1977f9e7dda2006-06-16 16:08:53 +00002352 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002353 }
danielk197744ee5bf2005-05-27 09:41:12 +00002354#endif
danielk1977026d2702004-06-14 13:14:59 +00002355
drh2ac3ee92004-06-07 16:27:46 +00002356 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002357}
2358
danielk19771d850a72004-05-31 08:26:49 +00002359/*
drh4f7d3a52013-06-27 23:54:02 +00002360** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00002361** matches the number of vdbe's in the list sqlite3.pVdbe that are
2362** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00002363** This is an internal self-check only - it is not an essential processing
2364** step.
danielk19771d850a72004-05-31 08:26:49 +00002365**
2366** This is a no-op if NDEBUG is defined.
2367*/
2368#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00002369static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00002370 Vdbe *p;
2371 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00002372 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00002373 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00002374 p = db->pVdbe;
2375 while( p ){
dan857745c2014-07-19 17:57:10 +00002376 if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
danielk19771d850a72004-05-31 08:26:49 +00002377 cnt++;
drhad4a4b82008-11-05 16:37:34 +00002378 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00002379 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00002380 }
2381 p = p->pNext;
2382 }
drh4f7d3a52013-06-27 23:54:02 +00002383 assert( cnt==db->nVdbeActive );
2384 assert( nWrite==db->nVdbeWrite );
2385 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00002386}
2387#else
2388#define checkActiveVdbeCnt(x)
2389#endif
2390
danielk19773cf86062004-05-26 10:11:05 +00002391/*
danielk1977bd434552009-03-18 10:33:00 +00002392** If the Vdbe passed as the first argument opened a statement-transaction,
2393** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
2394** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
2395** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00002396** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00002397**
2398** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
2399** Otherwise SQLITE_OK.
2400*/
2401int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00002402 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00002403 int rc = SQLITE_OK;
danielk1977ecaecf92009-07-08 08:05:35 +00002404
danielk1977e4948172009-07-17 17:25:43 +00002405 /* If p->iStatement is greater than zero, then this Vdbe opened a
2406 ** statement transaction that should be closed here. The only exception
mistachkin48864df2013-03-21 21:20:32 +00002407 ** is that an IO error may have occurred, causing an emergency rollback.
danielk1977e4948172009-07-17 17:25:43 +00002408 ** In this case (db->nStatement==0), and there is nothing to do.
2409 */
2410 if( db->nStatement && p->iStatement ){
danielk1977bd434552009-03-18 10:33:00 +00002411 int i;
2412 const int iSavepoint = p->iStatement-1;
danielk1977bd434552009-03-18 10:33:00 +00002413
2414 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
2415 assert( db->nStatement>0 );
2416 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
2417
2418 for(i=0; i<db->nDb; i++){
2419 int rc2 = SQLITE_OK;
2420 Btree *pBt = db->aDb[i].pBt;
2421 if( pBt ){
2422 if( eOp==SAVEPOINT_ROLLBACK ){
2423 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
2424 }
2425 if( rc2==SQLITE_OK ){
2426 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
2427 }
2428 if( rc==SQLITE_OK ){
2429 rc = rc2;
2430 }
2431 }
2432 }
2433 db->nStatement--;
2434 p->iStatement = 0;
dan1da40a32009-09-19 17:00:31 +00002435
dana311b802011-04-26 19:21:34 +00002436 if( rc==SQLITE_OK ){
2437 if( eOp==SAVEPOINT_ROLLBACK ){
2438 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
2439 }
2440 if( rc==SQLITE_OK ){
2441 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
2442 }
2443 }
2444
dan1da40a32009-09-19 17:00:31 +00002445 /* If the statement transaction is being rolled back, also restore the
2446 ** database handles deferred constraint counter to the value it had when
2447 ** the statement transaction was opened. */
2448 if( eOp==SAVEPOINT_ROLLBACK ){
2449 db->nDeferredCons = p->nStmtDefCons;
drh648e2642013-07-11 15:03:32 +00002450 db->nDeferredImmCons = p->nStmtDefImmCons;
dan1da40a32009-09-19 17:00:31 +00002451 }
danielk1977bd434552009-03-18 10:33:00 +00002452 }
2453 return rc;
2454}
2455
2456/*
dan1da40a32009-09-19 17:00:31 +00002457** This function is called when a transaction opened by the database
2458** handle associated with the VM passed as an argument is about to be
2459** committed. If there are outstanding deferred foreign key constraint
2460** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
2461**
2462** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00002463** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
2464** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00002465*/
2466#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00002467int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00002468 sqlite3 *db = p->db;
drh648e2642013-07-11 15:03:32 +00002469 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
2470 || (!deferred && p->nFkConstraint>0)
2471 ){
drhd91c1a12013-02-09 13:58:25 +00002472 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00002473 p->errorAction = OE_Abort;
drh22c17b82015-05-15 04:13:15 +00002474 sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
dan1da40a32009-09-19 17:00:31 +00002475 return SQLITE_ERROR;
2476 }
2477 return SQLITE_OK;
2478}
2479#endif
2480
2481/*
drh92f02c32004-09-02 14:57:08 +00002482** This routine is called the when a VDBE tries to halt. If the VDBE
2483** has made changes and is in autocommit mode, then commit those
2484** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00002485**
drh92f02c32004-09-02 14:57:08 +00002486** This routine is the only way to move the state of a VM from
drhff0587c2007-08-29 17:43:19 +00002487** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
2488** call this on a VM that is in the SQLITE_MAGIC_HALT state.
drh92f02c32004-09-02 14:57:08 +00002489**
2490** Return an error code. If the commit could not complete because of
2491** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
2492** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00002493*/
drhff0587c2007-08-29 17:43:19 +00002494int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00002495 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00002496 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00002497
2498 /* This function contains the logic that determines if a statement or
2499 ** transaction will be committed or rolled back as a result of the
2500 ** execution of this virtual machine.
2501 **
drh71b890a2007-10-03 15:30:52 +00002502 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00002503 **
drh71b890a2007-10-03 15:30:52 +00002504 ** SQLITE_NOMEM
2505 ** SQLITE_IOERR
2506 ** SQLITE_FULL
2507 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00002508 **
drh71b890a2007-10-03 15:30:52 +00002509 ** Then the internal cache might have been left in an inconsistent
2510 ** state. We need to rollback the statement transaction, if there is
2511 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00002512 */
drh9a324642003-09-06 20:12:01 +00002513
drhb84e5742016-02-05 02:42:54 +00002514 if( db->mallocFailed ){
danielk1977261919c2005-12-06 12:52:59 +00002515 p->rc = SQLITE_NOMEM;
2516 }
drh6e856bc2011-12-09 18:06:44 +00002517 if( p->aOnceFlag ) memset(p->aOnceFlag, 0, p->nOnceFlag);
drh5f82e3c2009-07-06 00:44:08 +00002518 closeAllCursors(p);
drh92f02c32004-09-02 14:57:08 +00002519 if( p->magic!=VDBE_MAGIC_RUN ){
drh92f02c32004-09-02 14:57:08 +00002520 return SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00002521 }
danielk19771d850a72004-05-31 08:26:49 +00002522 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00002523
danc0537fe2013-06-28 19:41:43 +00002524 /* No commit or rollback needed if the program never started or if the
2525 ** SQL statement does not read or write a database file. */
2526 if( p->pc>=0 && p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00002527 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00002528 int eStatementOp = 0;
2529 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00002530
2531 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00002532 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00002533
drh71b890a2007-10-03 15:30:52 +00002534 /* Check for one of the special errors */
drhaac2f552006-09-23 21:44:23 +00002535 mrc = p->rc & 0xff;
drh71b890a2007-10-03 15:30:52 +00002536 isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
drh77658e22007-12-04 16:54:52 +00002537 || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
danielk197707cb5602006-01-20 10:55:05 +00002538 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00002539 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
2540 ** no rollback is necessary. Otherwise, at least a savepoint
2541 ** transaction must be rolled back to restore the database to a
2542 ** consistent state.
2543 **
2544 ** Even if the statement is read-only, it is important to perform
2545 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00002546 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00002547 ** file as part of an effort to free up cache space (see function
2548 ** pagerStress() in pager.c), the rollback is required to restore
2549 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00002550 */
drhad4a4b82008-11-05 16:37:34 +00002551 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00002552 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00002553 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002554 }else{
2555 /* We are forced to roll back the active transaction. Before doing
2556 ** so, abort any other statements this handle currently has active.
2557 */
drh21021a52012-02-13 17:01:51 +00002558 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002559 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002560 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002561 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002562 }
danielk1977261919c2005-12-06 12:52:59 +00002563 }
2564 }
dan32b09f22009-09-23 17:29:59 +00002565
2566 /* Check for immediate foreign key violations. */
2567 if( p->rc==SQLITE_OK ){
2568 sqlite3VdbeCheckFk(p, 0);
2569 }
danielk197707cb5602006-01-20 10:55:05 +00002570
danielk1977bd434552009-03-18 10:33:00 +00002571 /* If the auto-commit flag is set and this is the only active writer
2572 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00002573 **
2574 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00002575 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00002576 */
danielk1977093e0f62008-11-13 18:00:14 +00002577 if( !sqlite3VtabInSync(db)
2578 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00002579 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00002580 ){
danielk197707cb5602006-01-20 10:55:05 +00002581 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00002582 rc = sqlite3VdbeCheckFk(p, 1);
2583 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00002584 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00002585 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00002586 return SQLITE_ERROR;
2587 }
drhd91c1a12013-02-09 13:58:25 +00002588 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan19611b12011-01-24 16:00:58 +00002589 }else{
2590 /* The auto-commit flag is true, the vdbe program was successful
2591 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
2592 ** key constraints to hold up the transaction. This means a commit
2593 ** is required. */
2594 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00002595 }
dan19611b12011-01-24 16:00:58 +00002596 if( rc==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00002597 sqlite3VdbeLeave(p);
danielk197707cb5602006-01-20 10:55:05 +00002598 return SQLITE_BUSY;
2599 }else if( rc!=SQLITE_OK ){
2600 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00002601 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002602 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002603 }else{
dan1da40a32009-09-19 17:00:31 +00002604 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00002605 db->nDeferredImmCons = 0;
2606 db->flags &= ~SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00002607 sqlite3CommitInternalChanges(db);
2608 }
2609 }else{
drh0f198a72012-02-13 16:43:16 +00002610 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00002611 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002612 }
danielk1977bd434552009-03-18 10:33:00 +00002613 db->nStatement = 0;
2614 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00002615 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00002616 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00002617 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00002618 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002619 }else{
drh21021a52012-02-13 17:01:51 +00002620 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002621 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002622 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002623 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002624 }
danielk19771d850a72004-05-31 08:26:49 +00002625 }
danielk197707cb5602006-01-20 10:55:05 +00002626
danielk1977bd434552009-03-18 10:33:00 +00002627 /* If eStatementOp is non-zero, then a statement transaction needs to
2628 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
2629 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00002630 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
2631 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00002632 */
danielk1977bd434552009-03-18 10:33:00 +00002633 if( eStatementOp ){
2634 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00002635 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002636 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00002637 p->rc = rc;
2638 sqlite3DbFree(db, p->zErrMsg);
2639 p->zErrMsg = 0;
2640 }
drh21021a52012-02-13 17:01:51 +00002641 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00002642 sqlite3CloseSavepoints(db);
2643 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00002644 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00002645 }
danielk197777d83ba2004-05-31 10:08:14 +00002646 }
danielk197707cb5602006-01-20 10:55:05 +00002647
danielk1977bd434552009-03-18 10:33:00 +00002648 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
2649 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00002650 */
drh6be240e2009-07-14 02:33:02 +00002651 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00002652 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00002653 sqlite3VdbeSetChanges(db, p->nChange);
2654 }else{
2655 sqlite3VdbeSetChanges(db, 0);
2656 }
2657 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00002658 }
drhff0587c2007-08-29 17:43:19 +00002659
2660 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00002661 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00002662 }
danielk19771d850a72004-05-31 08:26:49 +00002663
danielk197765fd59f2006-06-24 11:51:33 +00002664 /* We have successfully halted and closed the VM. Record this fact. */
2665 if( p->pc>=0 ){
drh4f7d3a52013-06-27 23:54:02 +00002666 db->nVdbeActive--;
2667 if( !p->readOnly ) db->nVdbeWrite--;
drh1713afb2013-06-28 01:24:57 +00002668 if( p->bIsReader ) db->nVdbeRead--;
drh4f7d3a52013-06-27 23:54:02 +00002669 assert( db->nVdbeActive>=db->nVdbeRead );
2670 assert( db->nVdbeRead>=db->nVdbeWrite );
2671 assert( db->nVdbeWrite>=0 );
drh9a324642003-09-06 20:12:01 +00002672 }
drh92f02c32004-09-02 14:57:08 +00002673 p->magic = VDBE_MAGIC_HALT;
2674 checkActiveVdbeCnt(db);
drhb84e5742016-02-05 02:42:54 +00002675 if( db->mallocFailed ){
drhff0587c2007-08-29 17:43:19 +00002676 p->rc = SQLITE_NOMEM;
2677 }
danielk19771d850a72004-05-31 08:26:49 +00002678
danielk1977404ca072009-03-16 13:19:36 +00002679 /* If the auto-commit flag is set to true, then any locks that were held
2680 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
2681 ** to invoke any required unlock-notify callbacks.
2682 */
2683 if( db->autoCommit ){
2684 sqlite3ConnectionUnlocked(db);
2685 }
2686
drh4f7d3a52013-06-27 23:54:02 +00002687 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
dan19611b12011-01-24 16:00:58 +00002688 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00002689}
drh4cf7c7f2007-08-28 23:28:07 +00002690
drh92f02c32004-09-02 14:57:08 +00002691
2692/*
drh3c23a882007-01-09 14:01:13 +00002693** Each VDBE holds the result of the most recent sqlite3_step() call
2694** in p->rc. This routine sets that result back to SQLITE_OK.
2695*/
2696void sqlite3VdbeResetStepResult(Vdbe *p){
2697 p->rc = SQLITE_OK;
2698}
2699
2700/*
dan029ead62011-10-27 15:19:58 +00002701** Copy the error code and error message belonging to the VDBE passed
2702** as the first argument to its database handle (so that they will be
2703** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
2704**
2705** This function does not clear the VDBE error code or message, just
2706** copies them to the database handle.
2707*/
2708int sqlite3VdbeTransferError(Vdbe *p){
2709 sqlite3 *db = p->db;
2710 int rc = p->rc;
2711 if( p->zErrMsg ){
drh4a642b62016-02-05 01:55:27 +00002712 db->bBenignMalloc++;
dan029ead62011-10-27 15:19:58 +00002713 sqlite3BeginBenignMalloc();
drha3cc0072013-12-13 16:23:55 +00002714 if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
dan029ead62011-10-27 15:19:58 +00002715 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
2716 sqlite3EndBenignMalloc();
drh4a642b62016-02-05 01:55:27 +00002717 db->bBenignMalloc--;
dan029ead62011-10-27 15:19:58 +00002718 db->errCode = rc;
2719 }else{
drh13f40da2014-08-22 18:00:11 +00002720 sqlite3Error(db, rc);
dan029ead62011-10-27 15:19:58 +00002721 }
2722 return rc;
2723}
2724
danac455932012-11-26 19:50:41 +00002725#ifdef SQLITE_ENABLE_SQLLOG
2726/*
2727** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
2728** invoke it.
2729*/
2730static void vdbeInvokeSqllog(Vdbe *v){
2731 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
2732 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
2733 assert( v->db->init.busy==0 );
2734 if( zExpanded ){
2735 sqlite3GlobalConfig.xSqllog(
2736 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
2737 );
2738 sqlite3DbFree(v->db, zExpanded);
2739 }
2740 }
2741}
2742#else
2743# define vdbeInvokeSqllog(x)
2744#endif
2745
dan029ead62011-10-27 15:19:58 +00002746/*
drh92f02c32004-09-02 14:57:08 +00002747** Clean up a VDBE after execution but do not delete the VDBE just yet.
2748** Write any error messages into *pzErrMsg. Return the result code.
2749**
2750** After this routine is run, the VDBE should be ready to be executed
2751** again.
2752**
2753** To look at it another way, this routine resets the state of the
2754** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
2755** VDBE_MAGIC_INIT.
2756*/
drhc890fec2008-08-01 20:10:08 +00002757int sqlite3VdbeReset(Vdbe *p){
drh4ac285a2006-09-15 07:28:50 +00002758 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00002759 db = p->db;
drh92f02c32004-09-02 14:57:08 +00002760
2761 /* If the VM did not run to completion or if it encountered an
2762 ** error, then it might not have been halted properly. So halt
2763 ** it now.
2764 */
2765 sqlite3VdbeHalt(p);
2766
drhfb7e7652005-01-24 00:28:42 +00002767 /* If the VDBE has be run even partially, then transfer the error code
2768 ** and error message from the VDBE into the main database structure. But
2769 ** if the VDBE has just been set to run but has not actually executed any
2770 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00002771 */
drhfb7e7652005-01-24 00:28:42 +00002772 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00002773 vdbeInvokeSqllog(p);
dan029ead62011-10-27 15:19:58 +00002774 sqlite3VdbeTransferError(p);
2775 sqlite3DbFree(db, p->zErrMsg);
2776 p->zErrMsg = 0;
drh4611d922010-02-25 14:47:01 +00002777 if( p->runOnlyOnce ) p->expired = 1;
danielk1977a21c6b62005-01-24 10:25:59 +00002778 }else if( p->rc && p->expired ){
2779 /* The expired flag was set on the VDBE before the first call
2780 ** to sqlite3_step(). For consistency (since sqlite3_step() was
2781 ** called), set the database error in this case as well.
2782 */
drh13f40da2014-08-22 18:00:11 +00002783 sqlite3ErrorWithMsg(db, p->rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
drh633e6d52008-07-28 19:34:53 +00002784 sqlite3DbFree(db, p->zErrMsg);
danielk19778e556522007-11-13 10:30:24 +00002785 p->zErrMsg = 0;
drh92f02c32004-09-02 14:57:08 +00002786 }
2787
2788 /* Reclaim all memory used by the VDBE
2789 */
drhc890fec2008-08-01 20:10:08 +00002790 Cleanup(p);
drh92f02c32004-09-02 14:57:08 +00002791
2792 /* Save profiling information from this VDBE run.
2793 */
drh9a324642003-09-06 20:12:01 +00002794#ifdef VDBE_PROFILE
2795 {
2796 FILE *out = fopen("vdbe_profile.out", "a");
2797 if( out ){
2798 int i;
2799 fprintf(out, "---- ");
2800 for(i=0; i<p->nOp; i++){
2801 fprintf(out, "%02x", p->aOp[i].opcode);
2802 }
2803 fprintf(out, "\n");
drh2926f962014-02-17 01:13:28 +00002804 if( p->zSql ){
2805 char c, pc = 0;
2806 fprintf(out, "-- ");
2807 for(i=0; (c = p->zSql[i])!=0; i++){
2808 if( pc=='\n' ) fprintf(out, "-- ");
2809 putc(c, out);
2810 pc = c;
2811 }
2812 if( pc!='\n' ) fprintf(out, "\n");
2813 }
drh9a324642003-09-06 20:12:01 +00002814 for(i=0; i<p->nOp; i++){
drh15ab9412014-02-24 14:24:01 +00002815 char zHdr[100];
2816 sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
drh9a324642003-09-06 20:12:01 +00002817 p->aOp[i].cnt,
2818 p->aOp[i].cycles,
2819 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
2820 );
drh15ab9412014-02-24 14:24:01 +00002821 fprintf(out, "%s", zHdr);
danielk19774adee202004-05-08 08:23:19 +00002822 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00002823 }
2824 fclose(out);
2825 }
2826 }
2827#endif
drh7fa20922013-09-17 23:36:33 +00002828 p->iCurrentTime = 0;
drh9a324642003-09-06 20:12:01 +00002829 p->magic = VDBE_MAGIC_INIT;
drh4ac285a2006-09-15 07:28:50 +00002830 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00002831}
drh92f02c32004-09-02 14:57:08 +00002832
drh9a324642003-09-06 20:12:01 +00002833/*
2834** Clean up and delete a VDBE after execution. Return an integer which is
2835** the result code. Write any error message text into *pzErrMsg.
2836*/
danielk19779e6db7d2004-06-21 08:18:51 +00002837int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00002838 int rc = SQLITE_OK;
danielk1977b5548a82004-06-26 13:51:33 +00002839 if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
drhc890fec2008-08-01 20:10:08 +00002840 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00002841 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00002842 }
danielk19774adee202004-05-08 08:23:19 +00002843 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00002844 return rc;
2845}
2846
2847/*
dan0c547792013-07-18 17:12:08 +00002848** If parameter iOp is less than zero, then invoke the destructor for
2849** all auxiliary data pointers currently cached by the VM passed as
2850** the first argument.
2851**
2852** Or, if iOp is greater than or equal to zero, then the destructor is
2853** only invoked for those auxiliary data pointers created by the user
2854** function invoked by the OP_Function opcode at instruction iOp of
2855** VM pVdbe, and only then if:
2856**
2857** * the associated function parameter is the 32nd or later (counting
2858** from left to right), or
2859**
2860** * the corresponding bit in argument mask is clear (where the first
peter.d.reid60ec9142014-09-06 16:39:46 +00002861** function parameter corresponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00002862*/
dan0c547792013-07-18 17:12:08 +00002863void sqlite3VdbeDeleteAuxData(Vdbe *pVdbe, int iOp, int mask){
2864 AuxData **pp = &pVdbe->pAuxData;
2865 while( *pp ){
2866 AuxData *pAux = *pp;
2867 if( (iOp<0)
drh693e6712014-01-24 22:58:00 +00002868 || (pAux->iOp==iOp && (pAux->iArg>31 || !(mask & MASKBIT32(pAux->iArg))))
dan0c547792013-07-18 17:12:08 +00002869 ){
drh693e6712014-01-24 22:58:00 +00002870 testcase( pAux->iArg==31 );
drhf92c7ff2004-06-19 15:40:23 +00002871 if( pAux->xDelete ){
2872 pAux->xDelete(pAux->pAux);
2873 }
dan0c547792013-07-18 17:12:08 +00002874 *pp = pAux->pNext;
2875 sqlite3DbFree(pVdbe->db, pAux);
2876 }else{
2877 pp= &pAux->pNext;
drhf92c7ff2004-06-19 15:40:23 +00002878 }
2879 }
2880}
2881
2882/*
drhcb103b92012-10-26 00:11:23 +00002883** Free all memory associated with the Vdbe passed as the second argument,
2884** except for object itself, which is preserved.
2885**
dand46def72010-07-24 11:28:28 +00002886** The difference between this function and sqlite3VdbeDelete() is that
2887** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00002888** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00002889*/
drhcb103b92012-10-26 00:11:23 +00002890void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00002891 SubProgram *pSub, *pNext;
drh124c0b42011-06-01 18:15:55 +00002892 int i;
dand46def72010-07-24 11:28:28 +00002893 assert( p->db==0 || p->db==db );
2894 releaseMemArray(p->aVar, p->nVar);
2895 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
dand19c9332010-07-26 12:05:17 +00002896 for(pSub=p->pProgram; pSub; pSub=pNext){
2897 pNext = pSub->pNext;
2898 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
2899 sqlite3DbFree(db, pSub);
2900 }
drh124c0b42011-06-01 18:15:55 +00002901 for(i=p->nzVar-1; i>=0; i--) sqlite3DbFree(db, p->azVar[i]);
drh6d664b42016-01-20 01:48:25 +00002902 sqlite3DbFree(db, p->azVar);
dand46def72010-07-24 11:28:28 +00002903 vdbeFreeOpArray(db, p->aOp, p->nOp);
dand46def72010-07-24 11:28:28 +00002904 sqlite3DbFree(db, p->aColName);
2905 sqlite3DbFree(db, p->zSql);
2906 sqlite3DbFree(db, p->pFree);
dan6f9702e2014-11-01 20:38:06 +00002907#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan6f9702e2014-11-01 20:38:06 +00002908 for(i=0; i<p->nScan; i++){
2909 sqlite3DbFree(db, p->aScan[i].zName);
2910 }
2911 sqlite3DbFree(db, p->aScan);
drh7e02e5e2011-12-06 19:44:51 +00002912#endif
dand46def72010-07-24 11:28:28 +00002913}
2914
2915/*
drh9a324642003-09-06 20:12:01 +00002916** Delete an entire VDBE.
2917*/
danielk19774adee202004-05-08 08:23:19 +00002918void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002919 sqlite3 *db;
2920
drhfa3be902009-07-07 02:44:07 +00002921 if( NEVER(p==0) ) return;
drh633e6d52008-07-28 19:34:53 +00002922 db = p->db;
drh4245c402012-06-02 14:32:21 +00002923 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00002924 sqlite3VdbeClearObject(db, p);
drh9a324642003-09-06 20:12:01 +00002925 if( p->pPrev ){
2926 p->pPrev->pNext = p->pNext;
2927 }else{
drh633e6d52008-07-28 19:34:53 +00002928 assert( db->pVdbe==p );
2929 db->pVdbe = p->pNext;
drh9a324642003-09-06 20:12:01 +00002930 }
2931 if( p->pNext ){
2932 p->pNext->pPrev = p->pPrev;
2933 }
drh9a324642003-09-06 20:12:01 +00002934 p->magic = VDBE_MAGIC_DEAD;
drh87f5c5f2010-01-20 01:20:56 +00002935 p->db = 0;
drhcb103b92012-10-26 00:11:23 +00002936 sqlite3DbFree(db, p);
drh9a324642003-09-06 20:12:01 +00002937}
drha11846b2004-01-07 18:52:56 +00002938
2939/*
drh6848dad2014-08-22 23:33:03 +00002940** The cursor "p" has a pending seek operation that has not yet been
2941** carried out. Seek the cursor now. If an error occurs, return
2942** the appropriate error code.
2943*/
2944static int SQLITE_NOINLINE handleDeferredMoveto(VdbeCursor *p){
2945 int res, rc;
2946#ifdef SQLITE_TEST
2947 extern int sqlite3_search_count;
2948#endif
2949 assert( p->deferredMoveto );
2950 assert( p->isTable );
drhc960dcb2015-11-20 19:22:01 +00002951 assert( p->eCurType==CURTYPE_BTREE );
2952 rc = sqlite3BtreeMovetoUnpacked(p->uc.pCursor, 0, p->movetoTarget, 0, &res);
drh6848dad2014-08-22 23:33:03 +00002953 if( rc ) return rc;
drh6848dad2014-08-22 23:33:03 +00002954 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
drh6848dad2014-08-22 23:33:03 +00002955#ifdef SQLITE_TEST
2956 sqlite3_search_count++;
2957#endif
2958 p->deferredMoveto = 0;
2959 p->cacheStatus = CACHE_STALE;
2960 return SQLITE_OK;
2961}
2962
2963/*
2964** Something has moved cursor "p" out of place. Maybe the row it was
2965** pointed to was deleted out from under it. Or maybe the btree was
2966** rebalanced. Whatever the cause, try to restore "p" to the place it
peter.d.reid60ec9142014-09-06 16:39:46 +00002967** is supposed to be pointing. If the row was deleted out from under the
drh6848dad2014-08-22 23:33:03 +00002968** cursor, set the cursor to point to a NULL row.
2969*/
2970static int SQLITE_NOINLINE handleMovedCursor(VdbeCursor *p){
2971 int isDifferentRow, rc;
drhc960dcb2015-11-20 19:22:01 +00002972 assert( p->eCurType==CURTYPE_BTREE );
2973 assert( p->uc.pCursor!=0 );
2974 assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
2975 rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
drh6848dad2014-08-22 23:33:03 +00002976 p->cacheStatus = CACHE_STALE;
2977 if( isDifferentRow ) p->nullRow = 1;
2978 return rc;
2979}
2980
2981/*
drhc22284f2014-10-13 16:02:20 +00002982** Check to ensure that the cursor is valid. Restore the cursor
2983** if need be. Return any I/O error from the restore operation.
2984*/
2985int sqlite3VdbeCursorRestore(VdbeCursor *p){
drhc960dcb2015-11-20 19:22:01 +00002986 assert( p->eCurType==CURTYPE_BTREE );
2987 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
drhc22284f2014-10-13 16:02:20 +00002988 return handleMovedCursor(p);
2989 }
2990 return SQLITE_OK;
2991}
2992
2993/*
drh9a65f2c2009-06-22 19:05:40 +00002994** Make sure the cursor p is ready to read or write the row to which it
2995** was last positioned. Return an error code if an OOM fault or I/O error
2996** prevents us from positioning the cursor to its correct position.
2997**
drha11846b2004-01-07 18:52:56 +00002998** If a MoveTo operation is pending on the given cursor, then do that
drh9a65f2c2009-06-22 19:05:40 +00002999** MoveTo now. If no move is pending, check to see if the row has been
3000** deleted out from under the cursor and if it has, mark the row as
3001** a NULL row.
3002**
3003** If the cursor is already pointing to the correct row and that row has
3004** not been deleted out from under the cursor, then this routine is a no-op.
drha11846b2004-01-07 18:52:56 +00003005*/
dande892d92016-01-29 19:29:45 +00003006int sqlite3VdbeCursorMoveto(VdbeCursor **pp, int *piCol){
3007 VdbeCursor *p = *pp;
drhc960dcb2015-11-20 19:22:01 +00003008 if( p->eCurType==CURTYPE_BTREE ){
3009 if( p->deferredMoveto ){
drhb1702022016-01-30 00:45:18 +00003010 int iMap;
3011 if( p->aAltMap && (iMap = p->aAltMap[1+*piCol])>0 ){
dande892d92016-01-29 19:29:45 +00003012 *pp = p->pAltCursor;
drhb1702022016-01-30 00:45:18 +00003013 *piCol = iMap - 1;
dande892d92016-01-29 19:29:45 +00003014 return SQLITE_OK;
3015 }
drhc960dcb2015-11-20 19:22:01 +00003016 return handleDeferredMoveto(p);
3017 }
3018 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
3019 return handleMovedCursor(p);
3020 }
drha11846b2004-01-07 18:52:56 +00003021 }
3022 return SQLITE_OK;
3023}
danielk19774adee202004-05-08 08:23:19 +00003024
drhab9f7f12004-05-08 10:56:11 +00003025/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003026** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00003027**
danielk1977cfcdaef2004-05-12 07:33:33 +00003028** sqlite3VdbeSerialType()
3029** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00003030** sqlite3VdbeSerialLen()
shane92003092008-07-31 01:43:13 +00003031** sqlite3VdbeSerialPut()
3032** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00003033**
3034** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00003035** data and index records. Each serialized value consists of a
3036** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
3037** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00003038**
danielk1977cfcdaef2004-05-12 07:33:33 +00003039** In an SQLite index record, the serial type is stored directly before
3040** the blob of data that it corresponds to. In a table record, all serial
3041** types are stored at the start of the record, and the blobs of data at
3042** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00003043** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00003044**
3045** The following table describes the various storage classes for data:
3046**
3047** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00003048** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00003049** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00003050** 1 1 signed integer
3051** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00003052** 3 3 signed integer
3053** 4 4 signed integer
3054** 5 6 signed integer
3055** 6 8 signed integer
3056** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00003057** 8 0 Integer constant 0
3058** 9 0 Integer constant 1
3059** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00003060** N>=12 and even (N-12)/2 BLOB
3061** N>=13 and odd (N-13)/2 text
3062**
drh35a59652006-01-02 18:24:40 +00003063** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
3064** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00003065*/
3066
3067/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003068** Return the serial-type for the value stored in pMem.
danielk1977192ac1d2004-05-10 07:17:30 +00003069*/
drhbe37c122015-10-16 14:54:17 +00003070u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
danielk1977cfcdaef2004-05-12 07:33:33 +00003071 int flags = pMem->flags;
drheac5bd72014-07-25 21:35:39 +00003072 u32 n;
danielk1977cfcdaef2004-05-12 07:33:33 +00003073
drhbe37c122015-10-16 14:54:17 +00003074 assert( pLen!=0 );
danielk1977cfcdaef2004-05-12 07:33:33 +00003075 if( flags&MEM_Null ){
drhbe37c122015-10-16 14:54:17 +00003076 *pLen = 0;
drha19b7752004-05-30 21:14:58 +00003077 return 0;
danielk197790e4d952004-05-10 10:05:53 +00003078 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003079 if( flags&MEM_Int ){
drhfe2093d2005-01-20 22:48:47 +00003080 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00003081# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00003082 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00003083 u64 u;
drhcfd654b2011-03-05 13:54:15 +00003084 if( i<0 ){
drh1b40e632014-11-20 02:58:10 +00003085 u = ~i;
drhcfd654b2011-03-05 13:54:15 +00003086 }else{
3087 u = i;
3088 }
drh56690b32012-09-17 15:36:31 +00003089 if( u<=127 ){
drhbe37c122015-10-16 14:54:17 +00003090 if( (i&1)==i && file_format>=4 ){
3091 *pLen = 0;
3092 return 8+(u32)u;
3093 }else{
3094 *pLen = 1;
3095 return 1;
3096 }
drh56690b32012-09-17 15:36:31 +00003097 }
drhbe37c122015-10-16 14:54:17 +00003098 if( u<=32767 ){ *pLen = 2; return 2; }
3099 if( u<=8388607 ){ *pLen = 3; return 3; }
3100 if( u<=2147483647 ){ *pLen = 4; return 4; }
3101 if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
3102 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003103 return 6;
danielk197790e4d952004-05-10 10:05:53 +00003104 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003105 if( flags&MEM_Real ){
drhbe37c122015-10-16 14:54:17 +00003106 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003107 return 7;
danielk197790e4d952004-05-10 10:05:53 +00003108 }
danielk1977e4359752008-11-03 09:39:45 +00003109 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drheac5bd72014-07-25 21:35:39 +00003110 assert( pMem->n>=0 );
3111 n = (u32)pMem->n;
drhfdf972a2007-05-02 13:30:27 +00003112 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00003113 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00003114 }
drhbe37c122015-10-16 14:54:17 +00003115 *pLen = n;
drhfdf972a2007-05-02 13:30:27 +00003116 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00003117}
3118
3119/*
drhfaf37272015-10-16 14:23:42 +00003120** The sizes for serial types less than 128
drhc5ef7152015-06-28 02:58:51 +00003121*/
3122static const u8 sqlite3SmallTypeSizes[] = {
drhfaf37272015-10-16 14:23:42 +00003123 /* 0 1 2 3 4 5 6 7 8 9 */
3124/* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
3125/* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
3126/* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
3127/* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
3128/* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
3129/* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
3130/* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
3131/* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
3132/* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
3133/* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
3134/* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
3135/* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
3136/* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
drhc5ef7152015-06-28 02:58:51 +00003137};
3138
3139/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003140** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00003141*/
drh35cd6432009-06-05 14:17:21 +00003142u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drhfaf37272015-10-16 14:23:42 +00003143 if( serial_type>=128 ){
drh51846b52004-05-28 16:00:21 +00003144 return (serial_type-12)/2;
3145 }else{
drhfaf37272015-10-16 14:23:42 +00003146 assert( serial_type<12
3147 || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
drhc5ef7152015-06-28 02:58:51 +00003148 return sqlite3SmallTypeSizes[serial_type];
drh51846b52004-05-28 16:00:21 +00003149 }
danielk1977192ac1d2004-05-10 07:17:30 +00003150}
drhfaf37272015-10-16 14:23:42 +00003151u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
3152 assert( serial_type<128 );
3153 return sqlite3SmallTypeSizes[serial_type];
3154}
danielk1977192ac1d2004-05-10 07:17:30 +00003155
3156/*
drh110daac2007-05-04 11:59:31 +00003157** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00003158** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00003159** upper 4 bytes. Return the result.
3160**
drh7a4f5022007-05-23 07:20:08 +00003161** For most architectures, this is a no-op.
3162**
3163** (later): It is reported to me that the mixed-endian problem
3164** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
3165** that early versions of GCC stored the two words of a 64-bit
3166** float in the wrong order. And that error has been propagated
3167** ever since. The blame is not necessarily with GCC, though.
3168** GCC might have just copying the problem from a prior compiler.
3169** I am also told that newer versions of GCC that follow a different
3170** ABI get the byte order right.
3171**
3172** Developers using SQLite on an ARM7 should compile and run their
3173** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
3174** enabled, some asserts below will ensure that the byte order of
3175** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00003176**
3177** (2007-08-30) Frank van Vugt has studied this problem closely
3178** and has send his findings to the SQLite developers. Frank
3179** writes that some Linux kernels offer floating point hardware
3180** emulation that uses only 32-bit mantissas instead of a full
3181** 48-bits as required by the IEEE standard. (This is the
3182** CONFIG_FPE_FASTFPE option.) On such systems, floating point
3183** byte swapping becomes very complicated. To avoid problems,
3184** the necessary byte swapping is carried out using a 64-bit integer
3185** rather than a 64-bit float. Frank assures us that the code here
3186** works for him. We, the developers, have no way to independently
3187** verify this, but Frank seems to know what he is talking about
3188** so we trust him.
drh110daac2007-05-04 11:59:31 +00003189*/
3190#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh60d09a72007-08-30 15:05:08 +00003191static u64 floatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00003192 union {
drh60d09a72007-08-30 15:05:08 +00003193 u64 r;
drh110daac2007-05-04 11:59:31 +00003194 u32 i[2];
3195 } u;
3196 u32 t;
3197
3198 u.r = in;
3199 t = u.i[0];
3200 u.i[0] = u.i[1];
3201 u.i[1] = t;
3202 return u.r;
3203}
3204# define swapMixedEndianFloat(X) X = floatSwap(X)
3205#else
3206# define swapMixedEndianFloat(X)
3207#endif
3208
3209/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003210** Write the serialized data blob for the value stored in pMem into
3211** buf. It is assumed that the caller has allocated sufficient space.
3212** Return the number of bytes written.
drhfdf972a2007-05-02 13:30:27 +00003213**
drh038b7bc2013-12-09 23:17:22 +00003214** nBuf is the amount of space left in buf[]. The caller is responsible
3215** for allocating enough space to buf[] to hold the entire field, exclusive
3216** of the pMem->u.nZero bytes for a MEM_Zero value.
drhfdf972a2007-05-02 13:30:27 +00003217**
3218** Return the number of bytes actually written into buf[]. The number
3219** of bytes in the zero-filled tail is included in the return value only
3220** if those bytes were zeroed in buf[].
danielk1977cfcdaef2004-05-12 07:33:33 +00003221*/
drha9ab4812013-12-11 11:00:44 +00003222u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
drh35cd6432009-06-05 14:17:21 +00003223 u32 len;
danielk1977183f9f72004-05-13 05:20:26 +00003224
drh1483e142004-05-21 21:12:42 +00003225 /* Integer and Real */
drhd946db02005-12-29 19:23:06 +00003226 if( serial_type<=7 && serial_type>0 ){
drh1483e142004-05-21 21:12:42 +00003227 u64 v;
drh35cd6432009-06-05 14:17:21 +00003228 u32 i;
drha19b7752004-05-30 21:14:58 +00003229 if( serial_type==7 ){
drh74eaba42014-09-18 17:52:15 +00003230 assert( sizeof(v)==sizeof(pMem->u.r) );
3231 memcpy(&v, &pMem->u.r, sizeof(v));
drh60d09a72007-08-30 15:05:08 +00003232 swapMixedEndianFloat(v);
drh1483e142004-05-21 21:12:42 +00003233 }else{
drh3c024d62007-03-30 11:23:45 +00003234 v = pMem->u.i;
danielk1977cfcdaef2004-05-12 07:33:33 +00003235 }
drhc5ef7152015-06-28 02:58:51 +00003236 len = i = sqlite3SmallTypeSizes[serial_type];
drh3f5b1992014-08-22 13:22:32 +00003237 assert( i>0 );
3238 do{
3239 buf[--i] = (u8)(v&0xFF);
drh1483e142004-05-21 21:12:42 +00003240 v >>= 8;
drh3f5b1992014-08-22 13:22:32 +00003241 }while( i );
drh1483e142004-05-21 21:12:42 +00003242 return len;
danielk1977cfcdaef2004-05-12 07:33:33 +00003243 }
drhd946db02005-12-29 19:23:06 +00003244
danielk1977cfcdaef2004-05-12 07:33:33 +00003245 /* String or blob */
drhd946db02005-12-29 19:23:06 +00003246 if( serial_type>=12 ){
drh8df32842008-12-09 02:51:23 +00003247 assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
shane75ac1de2009-06-09 18:58:52 +00003248 == (int)sqlite3VdbeSerialTypeLen(serial_type) );
drhfdf972a2007-05-02 13:30:27 +00003249 len = pMem->n;
drh72ea29d2015-12-08 16:58:45 +00003250 if( len>0 ) memcpy(buf, pMem->z, len);
drhd946db02005-12-29 19:23:06 +00003251 return len;
3252 }
3253
3254 /* NULL or constants 0 or 1 */
3255 return 0;
danielk1977cfcdaef2004-05-12 07:33:33 +00003256}
3257
drhf926d1e2014-03-04 04:04:33 +00003258/* Input "x" is a sequence of unsigned characters that represent a
3259** big-endian integer. Return the equivalent native integer
3260*/
3261#define ONE_BYTE_INT(x) ((i8)(x)[0])
3262#define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
3263#define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
3264#define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drh8932bec2014-08-22 14:56:13 +00003265#define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drhf926d1e2014-03-04 04:04:33 +00003266
danielk1977cfcdaef2004-05-12 07:33:33 +00003267/*
3268** Deserialize the data blob pointed to by buf as serial type serial_type
3269** and store the result in pMem. Return the number of bytes read.
drh14a924a2014-08-22 14:34:05 +00003270**
3271** This function is implemented as two separate routines for performance.
3272** The few cases that require local variables are broken out into a separate
3273** routine so that in most cases the overhead of moving the stack pointer
3274** is avoided.
danielk1977cfcdaef2004-05-12 07:33:33 +00003275*/
drh14a924a2014-08-22 14:34:05 +00003276static u32 SQLITE_NOINLINE serialGet(
danielk197793d46752004-05-23 13:30:58 +00003277 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00003278 u32 serial_type, /* Serial type to deserialize */
3279 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00003280){
drh8932bec2014-08-22 14:56:13 +00003281 u64 x = FOUR_BYTE_UINT(buf);
3282 u32 y = FOUR_BYTE_UINT(buf+4);
3283 x = (x<<32) + y;
drh14a924a2014-08-22 14:34:05 +00003284 if( serial_type==6 ){
drh654858d2014-11-20 02:18:14 +00003285 /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
3286 ** twos-complement integer. */
drh14a924a2014-08-22 14:34:05 +00003287 pMem->u.i = *(i64*)&x;
3288 pMem->flags = MEM_Int;
3289 testcase( pMem->u.i<0 );
3290 }else{
drh654858d2014-11-20 02:18:14 +00003291 /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
3292 ** floating point number. */
drh14a924a2014-08-22 14:34:05 +00003293#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
3294 /* Verify that integers and floating point values use the same
3295 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
3296 ** defined that 64-bit floating point values really are mixed
3297 ** endian.
3298 */
3299 static const u64 t1 = ((u64)0x3ff00000)<<32;
3300 static const double r1 = 1.0;
3301 u64 t2 = t1;
3302 swapMixedEndianFloat(t2);
3303 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
3304#endif
drh74eaba42014-09-18 17:52:15 +00003305 assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
drh14a924a2014-08-22 14:34:05 +00003306 swapMixedEndianFloat(x);
drh74eaba42014-09-18 17:52:15 +00003307 memcpy(&pMem->u.r, &x, sizeof(x));
3308 pMem->flags = sqlite3IsNaN(pMem->u.r) ? MEM_Null : MEM_Real;
drh14a924a2014-08-22 14:34:05 +00003309 }
3310 return 8;
3311}
danielk1977b1bc9532004-05-22 03:05:33 +00003312u32 sqlite3VdbeSerialGet(
3313 const unsigned char *buf, /* Buffer to deserialize from */
3314 u32 serial_type, /* Serial type to deserialize */
3315 Mem *pMem /* Memory cell to write value into */
3316){
drh3c685822005-05-21 18:32:18 +00003317 switch( serial_type ){
drh3c685822005-05-21 18:32:18 +00003318 case 10: /* Reserved for future use */
3319 case 11: /* Reserved for future use */
drh654858d2014-11-20 02:18:14 +00003320 case 0: { /* Null */
3321 /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
drh3c685822005-05-21 18:32:18 +00003322 pMem->flags = MEM_Null;
3323 break;
3324 }
drh654858d2014-11-20 02:18:14 +00003325 case 1: {
3326 /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
3327 ** integer. */
drhf926d1e2014-03-04 04:04:33 +00003328 pMem->u.i = ONE_BYTE_INT(buf);
drh1483e142004-05-21 21:12:42 +00003329 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003330 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003331 return 1;
drh1483e142004-05-21 21:12:42 +00003332 }
drh3c685822005-05-21 18:32:18 +00003333 case 2: { /* 2-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003334 /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
3335 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003336 pMem->u.i = TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003337 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003338 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003339 return 2;
3340 }
3341 case 3: { /* 3-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003342 /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
3343 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003344 pMem->u.i = THREE_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003345 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003346 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003347 return 3;
3348 }
3349 case 4: { /* 4-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003350 /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
3351 ** twos-complement integer. */
drh8932bec2014-08-22 14:56:13 +00003352 pMem->u.i = FOUR_BYTE_INT(buf);
drhc8bb4302015-11-06 17:28:00 +00003353#ifdef __HP_cc
3354 /* Work around a sign-extension bug in the HP compiler for HP/UX */
3355 if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
3356#endif
drh3c685822005-05-21 18:32:18 +00003357 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003358 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003359 return 4;
3360 }
3361 case 5: { /* 6-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003362 /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
3363 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003364 pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003365 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003366 testcase( pMem->u.i<0 );
drh3c685822005-05-21 18:32:18 +00003367 return 6;
3368 }
drh91124b32005-08-18 18:15:05 +00003369 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00003370 case 7: { /* IEEE floating point */
drh8932bec2014-08-22 14:56:13 +00003371 /* These use local variables, so do them in a separate routine
3372 ** to avoid having to move the frame pointer in the common case */
drh14a924a2014-08-22 14:34:05 +00003373 return serialGet(buf,serial_type,pMem);
drh3c685822005-05-21 18:32:18 +00003374 }
drhd946db02005-12-29 19:23:06 +00003375 case 8: /* Integer 0 */
3376 case 9: { /* Integer 1 */
drh654858d2014-11-20 02:18:14 +00003377 /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
3378 /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
drh3c024d62007-03-30 11:23:45 +00003379 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00003380 pMem->flags = MEM_Int;
3381 return 0;
3382 }
drh3c685822005-05-21 18:32:18 +00003383 default: {
drh654858d2014-11-20 02:18:14 +00003384 /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
3385 ** length.
3386 ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
3387 ** (N-13)/2 bytes in length. */
drhc138daf2013-11-19 13:55:34 +00003388 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh3c685822005-05-21 18:32:18 +00003389 pMem->z = (char *)buf;
drh14a924a2014-08-22 14:34:05 +00003390 pMem->n = (serial_type-12)/2;
drhc138daf2013-11-19 13:55:34 +00003391 pMem->flags = aFlag[serial_type&1];
drh14a924a2014-08-22 14:34:05 +00003392 return pMem->n;
drh696b32f2004-05-30 01:51:52 +00003393 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003394 }
drh3c685822005-05-21 18:32:18 +00003395 return 0;
danielk1977192ac1d2004-05-10 07:17:30 +00003396}
drh1e968a02008-03-25 00:22:21 +00003397/*
dan03e9cfc2011-09-05 14:20:27 +00003398** This routine is used to allocate sufficient space for an UnpackedRecord
3399** structure large enough to be used with sqlite3VdbeRecordUnpack() if
3400** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00003401**
dan03e9cfc2011-09-05 14:20:27 +00003402** The space is either allocated using sqlite3DbMallocRaw() or from within
3403** the unaligned buffer passed via the second and third arguments (presumably
3404** stack space). If the former, then *ppFree is set to a pointer that should
3405** be eventually freed by the caller using sqlite3DbFree(). Or, if the
3406** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
3407** before returning.
drh1e968a02008-03-25 00:22:21 +00003408**
dan03e9cfc2011-09-05 14:20:27 +00003409** If an OOM error occurs, NULL is returned.
3410*/
3411UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
3412 KeyInfo *pKeyInfo, /* Description of the record */
3413 char *pSpace, /* Unaligned space available */
3414 int szSpace, /* Size of pSpace[] in bytes */
3415 char **ppFree /* OUT: Caller should free this pointer */
drh1e968a02008-03-25 00:22:21 +00003416){
dan03e9cfc2011-09-05 14:20:27 +00003417 UnpackedRecord *p; /* Unpacked record to return */
3418 int nOff; /* Increment pSpace by nOff to align it */
3419 int nByte; /* Number of bytes required for *p */
3420
3421 /* We want to shift the pointer pSpace up such that it is 8-byte aligned.
shane80167bf2009-04-10 15:42:36 +00003422 ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
3423 ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
3424 */
3425 nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
drh8c5d1522009-04-10 00:56:28 +00003426 nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
dan42acb3e2011-09-05 20:16:38 +00003427 if( nByte>szSpace+nOff ){
dan03e9cfc2011-09-05 14:20:27 +00003428 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
3429 *ppFree = (char *)p;
dan42acb3e2011-09-05 20:16:38 +00003430 if( !p ) return 0;
drh1e968a02008-03-25 00:22:21 +00003431 }else{
dan42acb3e2011-09-05 20:16:38 +00003432 p = (UnpackedRecord*)&pSpace[nOff];
dan03e9cfc2011-09-05 14:20:27 +00003433 *ppFree = 0;
drh1e968a02008-03-25 00:22:21 +00003434 }
dan42acb3e2011-09-05 20:16:38 +00003435
3436 p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
drhe1a022e2012-09-17 17:16:53 +00003437 assert( pKeyInfo->aSortOrder!=0 );
drh1e968a02008-03-25 00:22:21 +00003438 p->pKeyInfo = pKeyInfo;
3439 p->nField = pKeyInfo->nField + 1;
dan03e9cfc2011-09-05 14:20:27 +00003440 return p;
3441}
3442
3443/*
3444** Given the nKey-byte encoding of a record in pKey[], populate the
3445** UnpackedRecord structure indicated by the fourth argument with the
3446** contents of the decoded record.
3447*/
3448void sqlite3VdbeRecordUnpack(
3449 KeyInfo *pKeyInfo, /* Information about the record format */
3450 int nKey, /* Size of the binary record */
3451 const void *pKey, /* The binary record */
3452 UnpackedRecord *p /* Populate this structure before returning. */
3453){
3454 const unsigned char *aKey = (const unsigned char *)pKey;
3455 int d;
3456 u32 idx; /* Offset in aKey[] to read from */
3457 u16 u; /* Unsigned loop counter */
3458 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00003459 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00003460
dan1fed5da2014-02-25 21:01:25 +00003461 p->default_rc = 0;
drh8c5d1522009-04-10 00:56:28 +00003462 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00003463 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00003464 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00003465 u = 0;
drh7f4b19f2014-09-16 13:30:05 +00003466 while( idx<szHdr && d<=nKey ){
drh1e968a02008-03-25 00:22:21 +00003467 u32 serial_type;
3468
danielk197700e13612008-11-17 19:18:54 +00003469 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00003470 pMem->enc = pKeyInfo->enc;
3471 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00003472 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
drh17bcb102014-09-18 21:25:33 +00003473 pMem->szMalloc = 0;
drh1e968a02008-03-25 00:22:21 +00003474 d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
drhe14006d2008-03-25 17:23:32 +00003475 pMem++;
drh7f4b19f2014-09-16 13:30:05 +00003476 if( (++u)>=p->nField ) break;
drh1e968a02008-03-25 00:22:21 +00003477 }
drh7d10d5a2008-08-20 16:35:10 +00003478 assert( u<=pKeyInfo->nField + 1 );
shane0b8d2762008-07-22 05:18:00 +00003479 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00003480}
3481
dan3833e932014-03-01 19:44:56 +00003482#if SQLITE_DEBUG
drh1e968a02008-03-25 00:22:21 +00003483/*
dan3833e932014-03-01 19:44:56 +00003484** This function compares two index or table record keys in the same way
3485** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
3486** this function deserializes and compares values using the
3487** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
3488** in assert() statements to ensure that the optimized code in
3489** sqlite3VdbeRecordCompare() returns results with these two primitives.
drh1e968a02008-03-25 00:22:21 +00003490**
drh79211e12014-05-02 17:33:16 +00003491** Return true if the result of comparison is equivalent to desiredResult.
3492** Return false if there is a disagreement.
drh1e968a02008-03-25 00:22:21 +00003493*/
dan3833e932014-03-01 19:44:56 +00003494static int vdbeRecordCompareDebug(
drhec1fc802008-08-13 14:07:40 +00003495 int nKey1, const void *pKey1, /* Left key */
drh79211e12014-05-02 17:33:16 +00003496 const UnpackedRecord *pPKey2, /* Right key */
3497 int desiredResult /* Correct answer */
drh1e968a02008-03-25 00:22:21 +00003498){
drhdf003d62013-08-01 19:17:39 +00003499 u32 d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00003500 u32 idx1; /* Offset into aKey[] of next header element */
3501 u32 szHdr1; /* Number of bytes in header */
3502 int i = 0;
drh1e968a02008-03-25 00:22:21 +00003503 int rc = 0;
3504 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3505 KeyInfo *pKeyInfo;
3506 Mem mem1;
3507
3508 pKeyInfo = pPKey2->pKeyInfo;
drh84de6902014-05-02 18:46:52 +00003509 if( pKeyInfo->db==0 ) return 1;
drh1e968a02008-03-25 00:22:21 +00003510 mem1.enc = pKeyInfo->enc;
drh37272632009-11-16 21:28:45 +00003511 mem1.db = pKeyInfo->db;
drhd93a8b22009-11-16 03:13:40 +00003512 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
drh17bcb102014-09-18 21:25:33 +00003513 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drh8b249a82009-11-16 02:14:00 +00003514
3515 /* Compilers may complain that mem1.u.i is potentially uninitialized.
3516 ** We could initialize it, as shown here, to silence those complaints.
drh5275d2e2011-04-27 01:00:17 +00003517 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
drh8b249a82009-11-16 02:14:00 +00003518 ** the unnecessary initialization has a measurable negative performance
3519 ** impact, since this routine is a very high runner. And so, we choose
3520 ** to ignore the compiler warnings and leave this variable uninitialized.
3521 */
3522 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
drh1e968a02008-03-25 00:22:21 +00003523
shane3f8d5cf2008-04-24 19:15:09 +00003524 idx1 = getVarint32(aKey1, szHdr1);
drh46981362015-07-08 12:25:38 +00003525 if( szHdr1>98307 ) return SQLITE_CORRUPT;
drh1e968a02008-03-25 00:22:21 +00003526 d1 = szHdr1;
drhb2023662013-11-29 15:39:36 +00003527 assert( pKeyInfo->nField+pKeyInfo->nXField>=pPKey2->nField || CORRUPT_DB );
drhe1a022e2012-09-17 17:16:53 +00003528 assert( pKeyInfo->aSortOrder!=0 );
dan89bc0212013-12-03 09:49:52 +00003529 assert( pKeyInfo->nField>0 );
3530 assert( idx1<=szHdr1 || CORRUPT_DB );
drh0b9dada2013-11-25 22:24:36 +00003531 do{
drh1e968a02008-03-25 00:22:21 +00003532 u32 serial_type1;
3533
3534 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00003535 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drhaf5b2af2013-08-05 15:32:09 +00003536
3537 /* Verify that there is enough key space remaining to avoid
3538 ** a buffer overread. The "d1+serial_type1+2" subexpression will
3539 ** always be greater than or equal to the amount of required key space.
3540 ** Use that approximation to avoid the more expensive call to
3541 ** sqlite3VdbeSerialTypeLen() in the common case.
3542 */
3543 if( d1+serial_type1+2>(u32)nKey1
3544 && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
3545 ){
3546 break;
3547 }
drh1e968a02008-03-25 00:22:21 +00003548
3549 /* Extract the values to be compared.
3550 */
3551 d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
3552
3553 /* Do the comparison
3554 */
drh323df792013-08-05 19:11:29 +00003555 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
drh1e968a02008-03-25 00:22:21 +00003556 if( rc!=0 ){
drh17bcb102014-09-18 21:25:33 +00003557 assert( mem1.szMalloc==0 ); /* See comment below */
drh323df792013-08-05 19:11:29 +00003558 if( pKeyInfo->aSortOrder[i] ){
drh6f225d02013-10-26 13:36:51 +00003559 rc = -rc; /* Invert the result for DESC sort order. */
drh8b249a82009-11-16 02:14:00 +00003560 }
drh79211e12014-05-02 17:33:16 +00003561 goto debugCompareEnd;
drh1e968a02008-03-25 00:22:21 +00003562 }
3563 i++;
drh0b9dada2013-11-25 22:24:36 +00003564 }while( idx1<szHdr1 && i<pPKey2->nField );
drh407414c2009-07-14 14:15:27 +00003565
drh8b249a82009-11-16 02:14:00 +00003566 /* No memory allocation is ever used on mem1. Prove this using
3567 ** the following assert(). If the assert() fails, it indicates a
3568 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
danielk1977de630352009-05-04 11:42:29 +00003569 */
drh17bcb102014-09-18 21:25:33 +00003570 assert( mem1.szMalloc==0 );
danielk1977de630352009-05-04 11:42:29 +00003571
drh8b249a82009-11-16 02:14:00 +00003572 /* rc==0 here means that one of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00003573 ** all the fields up to that point were equal. Return the default_rc
dan3b9330f2014-02-27 20:44:18 +00003574 ** value. */
drh79211e12014-05-02 17:33:16 +00003575 rc = pPKey2->default_rc;
3576
3577debugCompareEnd:
3578 if( desiredResult==0 && rc==0 ) return 1;
3579 if( desiredResult<0 && rc<0 ) return 1;
3580 if( desiredResult>0 && rc>0 ) return 1;
3581 if( CORRUPT_DB ) return 1;
3582 if( pKeyInfo->db->mallocFailed ) return 1;
3583 return 0;
drh1e968a02008-03-25 00:22:21 +00003584}
dan3833e932014-03-01 19:44:56 +00003585#endif
dan1fed5da2014-02-25 21:01:25 +00003586
drhe1bb8022015-01-19 19:48:52 +00003587#if SQLITE_DEBUG
3588/*
3589** Count the number of fields (a.k.a. columns) in the record given by
3590** pKey,nKey. The verify that this count is less than or equal to the
3591** limit given by pKeyInfo->nField + pKeyInfo->nXField.
3592**
3593** If this constraint is not satisfied, it means that the high-speed
3594** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
3595** not work correctly. If this assert() ever fires, it probably means
3596** that the KeyInfo.nField or KeyInfo.nXField values were computed
3597** incorrectly.
3598*/
3599static void vdbeAssertFieldCountWithinLimits(
3600 int nKey, const void *pKey, /* The record to verify */
3601 const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
3602){
3603 int nField = 0;
3604 u32 szHdr;
3605 u32 idx;
3606 u32 notUsed;
3607 const unsigned char *aKey = (const unsigned char*)pKey;
3608
3609 if( CORRUPT_DB ) return;
3610 idx = getVarint32(aKey, szHdr);
mistachkin1b3ee492015-01-21 00:51:08 +00003611 assert( nKey>=0 );
3612 assert( szHdr<=(u32)nKey );
drhe1bb8022015-01-19 19:48:52 +00003613 while( idx<szHdr ){
3614 idx += getVarint32(aKey+idx, notUsed);
3615 nField++;
3616 }
3617 assert( nField <= pKeyInfo->nField+pKeyInfo->nXField );
3618}
drh1af3c642015-01-19 20:57:19 +00003619#else
3620# define vdbeAssertFieldCountWithinLimits(A,B,C)
drhe1bb8022015-01-19 19:48:52 +00003621#endif
3622
dan3833e932014-03-01 19:44:56 +00003623/*
3624** Both *pMem1 and *pMem2 contain string values. Compare the two values
3625** using the collation sequence pColl. As usual, return a negative , zero
3626** or positive value if *pMem1 is less than, equal to or greater than
3627** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
3628*/
dan1fed5da2014-02-25 21:01:25 +00003629static int vdbeCompareMemString(
dan3833e932014-03-01 19:44:56 +00003630 const Mem *pMem1,
3631 const Mem *pMem2,
dan38fdead2014-04-01 10:19:02 +00003632 const CollSeq *pColl,
3633 u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
dan1fed5da2014-02-25 21:01:25 +00003634){
3635 if( pMem1->enc==pColl->enc ){
3636 /* The strings are already in the correct encoding. Call the
3637 ** comparison function directly */
3638 return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
3639 }else{
3640 int rc;
3641 const void *v1, *v2;
3642 int n1, n2;
3643 Mem c1;
3644 Mem c2;
drh17bcb102014-09-18 21:25:33 +00003645 sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
3646 sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
dan1fed5da2014-02-25 21:01:25 +00003647 sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
3648 sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
3649 v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
3650 n1 = v1==0 ? 0 : c1.n;
3651 v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
3652 n2 = v2==0 ? 0 : c2.n;
3653 rc = pColl->xCmp(pColl->pUser, n1, v1, n2, v2);
drhb8763632016-01-19 17:54:21 +00003654 if( (v1==0 || v2==0) && prcErr ) *prcErr = SQLITE_NOMEM;
dan1fed5da2014-02-25 21:01:25 +00003655 sqlite3VdbeMemRelease(&c1);
3656 sqlite3VdbeMemRelease(&c2);
3657 return rc;
3658 }
3659}
3660
3661/*
drh982ff722014-09-16 03:24:43 +00003662** Compare two blobs. Return negative, zero, or positive if the first
3663** is less than, equal to, or greater than the second, respectively.
3664** If one blob is a prefix of the other, then the shorter is the lessor.
3665*/
3666static SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
3667 int c = memcmp(pB1->z, pB2->z, pB1->n>pB2->n ? pB2->n : pB1->n);
3668 if( c ) return c;
3669 return pB1->n - pB2->n;
3670}
3671
drh2ab410a2015-11-06 14:59:07 +00003672/*
3673** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
3674** number. Return negative, zero, or positive if the first (i64) is less than,
3675** equal to, or greater than the second (double).
3676*/
3677static int sqlite3IntFloatCompare(i64 i, double r){
3678 if( sizeof(LONGDOUBLE_TYPE)>8 ){
3679 LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
3680 if( x<r ) return -1;
3681 if( x>r ) return +1;
3682 return 0;
3683 }else{
3684 i64 y;
3685 double s;
3686 if( r<-9223372036854775808.0 ) return +1;
3687 if( r>9223372036854775807.0 ) return -1;
3688 y = (i64)r;
3689 if( i<y ) return -1;
3690 if( i>y ){
3691 if( y==SMALLEST_INT64 && r>0.0 ) return -1;
3692 return +1;
3693 }
3694 s = (double)i;
3695 if( s<r ) return -1;
3696 if( s>r ) return +1;
3697 return 0;
3698 }
3699}
drh982ff722014-09-16 03:24:43 +00003700
3701/*
dan1fed5da2014-02-25 21:01:25 +00003702** Compare the values contained by the two memory cells, returning
3703** negative, zero or positive if pMem1 is less than, equal to, or greater
3704** than pMem2. Sorting order is NULL's first, followed by numbers (integers
3705** and reals) sorted numerically, followed by text ordered by the collating
3706** sequence pColl and finally blob's ordered by memcmp().
3707**
3708** Two NULL values are considered equal by this function.
3709*/
3710int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
dan1fed5da2014-02-25 21:01:25 +00003711 int f1, f2;
3712 int combined_flags;
3713
3714 f1 = pMem1->flags;
3715 f2 = pMem2->flags;
3716 combined_flags = f1|f2;
3717 assert( (combined_flags & MEM_RowSet)==0 );
drhec1fc802008-08-13 14:07:40 +00003718
dan1fed5da2014-02-25 21:01:25 +00003719 /* If one value is NULL, it is less than the other. If both values
3720 ** are NULL, return 0.
3721 */
3722 if( combined_flags&MEM_Null ){
3723 return (f2&MEM_Null) - (f1&MEM_Null);
3724 }
3725
drh2ab410a2015-11-06 14:59:07 +00003726 /* At least one of the two values is a number
dan1fed5da2014-02-25 21:01:25 +00003727 */
3728 if( combined_flags&(MEM_Int|MEM_Real) ){
dan1fed5da2014-02-25 21:01:25 +00003729 if( (f1 & f2 & MEM_Int)!=0 ){
3730 if( pMem1->u.i < pMem2->u.i ) return -1;
drh2ab410a2015-11-06 14:59:07 +00003731 if( pMem1->u.i > pMem2->u.i ) return +1;
dan1fed5da2014-02-25 21:01:25 +00003732 return 0;
3733 }
drh2ab410a2015-11-06 14:59:07 +00003734 if( (f1 & f2 & MEM_Real)!=0 ){
3735 if( pMem1->u.r < pMem2->u.r ) return -1;
3736 if( pMem1->u.r > pMem2->u.r ) return +1;
3737 return 0;
3738 }
3739 if( (f1&MEM_Int)!=0 ){
3740 if( (f2&MEM_Real)!=0 ){
3741 return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
3742 }else{
3743 return -1;
3744 }
3745 }
dan1fed5da2014-02-25 21:01:25 +00003746 if( (f1&MEM_Real)!=0 ){
drh2ab410a2015-11-06 14:59:07 +00003747 if( (f2&MEM_Int)!=0 ){
3748 return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
3749 }else{
3750 return -1;
3751 }
dan1fed5da2014-02-25 21:01:25 +00003752 }
drh2ab410a2015-11-06 14:59:07 +00003753 return +1;
dan1fed5da2014-02-25 21:01:25 +00003754 }
3755
3756 /* If one value is a string and the other is a blob, the string is less.
3757 ** If both are strings, compare using the collating functions.
3758 */
3759 if( combined_flags&MEM_Str ){
3760 if( (f1 & MEM_Str)==0 ){
3761 return 1;
3762 }
3763 if( (f2 & MEM_Str)==0 ){
3764 return -1;
3765 }
3766
drhe5520e22015-12-31 04:34:26 +00003767 assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
dan1fed5da2014-02-25 21:01:25 +00003768 assert( pMem1->enc==SQLITE_UTF8 ||
3769 pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
3770
3771 /* The collation sequence must be defined at this point, even if
3772 ** the user deletes the collation sequence after the vdbe program is
3773 ** compiled (this was not always the case).
3774 */
3775 assert( !pColl || pColl->xCmp );
3776
3777 if( pColl ){
dan38fdead2014-04-01 10:19:02 +00003778 return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
dan1fed5da2014-02-25 21:01:25 +00003779 }
3780 /* If a NULL pointer was passed as the collate function, fall through
3781 ** to the blob case and use memcmp(). */
3782 }
3783
3784 /* Both values must be blobs. Compare using memcmp(). */
drh982ff722014-09-16 03:24:43 +00003785 return sqlite3BlobCompare(pMem1, pMem2);
dan1fed5da2014-02-25 21:01:25 +00003786}
3787
3788
dan3833e932014-03-01 19:44:56 +00003789/*
3790** The first argument passed to this function is a serial-type that
3791** corresponds to an integer - all values between 1 and 9 inclusive
3792** except 7. The second points to a buffer containing an integer value
3793** serialized according to serial_type. This function deserializes
3794** and returns the value.
3795*/
dan3b9330f2014-02-27 20:44:18 +00003796static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
drhf926d1e2014-03-04 04:04:33 +00003797 u32 y;
dan3833e932014-03-01 19:44:56 +00003798 assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
dan3b9330f2014-02-27 20:44:18 +00003799 switch( serial_type ){
dan3833e932014-03-01 19:44:56 +00003800 case 0:
dan3b9330f2014-02-27 20:44:18 +00003801 case 1:
drhb6e8fd12014-03-06 01:56:33 +00003802 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003803 return ONE_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003804 case 2:
drhb6e8fd12014-03-06 01:56:33 +00003805 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003806 return TWO_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00003807 case 3:
drhb6e8fd12014-03-06 01:56:33 +00003808 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003809 return THREE_BYTE_INT(aKey);
3810 case 4: {
drhb6e8fd12014-03-06 01:56:33 +00003811 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003812 y = FOUR_BYTE_UINT(aKey);
3813 return (i64)*(int*)&y;
3814 }
dan3b9330f2014-02-27 20:44:18 +00003815 case 5: {
drhb6e8fd12014-03-06 01:56:33 +00003816 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003817 return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
danielk19779a96b662007-11-29 17:05:18 +00003818 }
dan3b9330f2014-02-27 20:44:18 +00003819 case 6: {
drhf926d1e2014-03-04 04:04:33 +00003820 u64 x = FOUR_BYTE_UINT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00003821 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00003822 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
3823 return (i64)*(i64*)&x;
drh7a224de2004-06-02 01:22:02 +00003824 }
dan3b9330f2014-02-27 20:44:18 +00003825 }
danielk1977161546c2008-07-26 18:26:10 +00003826
dan3b9330f2014-02-27 20:44:18 +00003827 return (serial_type - 8);
drhd5788202004-05-28 08:21:05 +00003828}
danielk1977eb015e02004-05-18 01:31:14 +00003829
dan3833e932014-03-01 19:44:56 +00003830/*
3831** This function compares the two table rows or index records
3832** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
3833** or positive integer if key1 is less than, equal to or
3834** greater than key2. The {nKey1, pKey1} key must be a blob
peter.d.reid60ec9142014-09-06 16:39:46 +00003835** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
dan3833e932014-03-01 19:44:56 +00003836** key must be a parsed key such as obtained from
3837** sqlite3VdbeParseRecord.
3838**
3839** If argument bSkip is non-zero, it is assumed that the caller has already
3840** determined that the first fields of the keys are equal.
3841**
3842** Key1 and Key2 do not have to contain the same number of fields. If all
3843** fields that appear in both keys are equal, then pPKey2->default_rc is
3844** returned.
drha1f7c0a2014-03-28 03:12:48 +00003845**
dan38fdead2014-04-01 10:19:02 +00003846** If database corruption is discovered, set pPKey2->errCode to
3847** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
3848** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
3849** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
dan3833e932014-03-01 19:44:56 +00003850*/
dan7004f3f2015-03-30 12:06:26 +00003851int sqlite3VdbeRecordCompareWithSkip(
dan3833e932014-03-01 19:44:56 +00003852 int nKey1, const void *pKey1, /* Left key */
drha1f7c0a2014-03-28 03:12:48 +00003853 UnpackedRecord *pPKey2, /* Right key */
dan3833e932014-03-01 19:44:56 +00003854 int bSkip /* If true, skip the first field */
dan1fed5da2014-02-25 21:01:25 +00003855){
dan3833e932014-03-01 19:44:56 +00003856 u32 d1; /* Offset into aKey[] of next data element */
3857 int i; /* Index of next field to compare */
mistachkinffe6bc22014-03-04 11:16:20 +00003858 u32 szHdr1; /* Size of record header in bytes */
dan3833e932014-03-01 19:44:56 +00003859 u32 idx1; /* Offset of first type in header */
3860 int rc = 0; /* Return value */
3861 Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
dan1fed5da2014-02-25 21:01:25 +00003862 KeyInfo *pKeyInfo = pPKey2->pKeyInfo;
3863 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3864 Mem mem1;
3865
dan3833e932014-03-01 19:44:56 +00003866 /* If bSkip is true, then the caller has already determined that the first
3867 ** two elements in the keys are equal. Fix the various stack variables so
dan3b9330f2014-02-27 20:44:18 +00003868 ** that this routine begins comparing at the second field. */
dan3833e932014-03-01 19:44:56 +00003869 if( bSkip ){
dan3b9330f2014-02-27 20:44:18 +00003870 u32 s1;
dan3b9330f2014-02-27 20:44:18 +00003871 idx1 = 1 + getVarint32(&aKey1[1], s1);
dan3833e932014-03-01 19:44:56 +00003872 szHdr1 = aKey1[0];
3873 d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
dan3b9330f2014-02-27 20:44:18 +00003874 i = 1;
3875 pRhs++;
dan3833e932014-03-01 19:44:56 +00003876 }else{
3877 idx1 = getVarint32(aKey1, szHdr1);
3878 d1 = szHdr1;
drha1f7c0a2014-03-28 03:12:48 +00003879 if( d1>(unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00003880 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00003881 return 0; /* Corruption */
3882 }
dan3833e932014-03-01 19:44:56 +00003883 i = 0;
dan3b9330f2014-02-27 20:44:18 +00003884 }
3885
drh17bcb102014-09-18 21:25:33 +00003886 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
dan1fed5da2014-02-25 21:01:25 +00003887 assert( pPKey2->pKeyInfo->nField+pPKey2->pKeyInfo->nXField>=pPKey2->nField
3888 || CORRUPT_DB );
3889 assert( pPKey2->pKeyInfo->aSortOrder!=0 );
3890 assert( pPKey2->pKeyInfo->nField>0 );
3891 assert( idx1<=szHdr1 || CORRUPT_DB );
3892 do{
dan1fed5da2014-02-25 21:01:25 +00003893 u32 serial_type;
3894
3895 /* RHS is an integer */
3896 if( pRhs->flags & MEM_Int ){
3897 serial_type = aKey1[idx1];
drhb6e8fd12014-03-06 01:56:33 +00003898 testcase( serial_type==12 );
danb95e1192015-05-26 20:31:20 +00003899 if( serial_type>=10 ){
dan1fed5da2014-02-25 21:01:25 +00003900 rc = +1;
3901 }else if( serial_type==0 ){
3902 rc = -1;
dan3b9330f2014-02-27 20:44:18 +00003903 }else if( serial_type==7 ){
dan1fed5da2014-02-25 21:01:25 +00003904 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
drh2ab410a2015-11-06 14:59:07 +00003905 rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
dan3b9330f2014-02-27 20:44:18 +00003906 }else{
3907 i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
3908 i64 rhs = pRhs->u.i;
3909 if( lhs<rhs ){
3910 rc = -1;
3911 }else if( lhs>rhs ){
3912 rc = +1;
dan1fed5da2014-02-25 21:01:25 +00003913 }
3914 }
3915 }
3916
3917 /* RHS is real */
3918 else if( pRhs->flags & MEM_Real ){
3919 serial_type = aKey1[idx1];
dancc7aa1f2015-05-26 20:07:32 +00003920 if( serial_type>=10 ){
3921 /* Serial types 12 or greater are strings and blobs (greater than
3922 ** numbers). Types 10 and 11 are currently "reserved for future
3923 ** use", so it doesn't really matter what the results of comparing
3924 ** them to numberic values are. */
dan1fed5da2014-02-25 21:01:25 +00003925 rc = +1;
3926 }else if( serial_type==0 ){
3927 rc = -1;
3928 }else{
dan1fed5da2014-02-25 21:01:25 +00003929 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
3930 if( serial_type==7 ){
drh2ab410a2015-11-06 14:59:07 +00003931 if( mem1.u.r<pRhs->u.r ){
3932 rc = -1;
3933 }else if( mem1.u.r>pRhs->u.r ){
3934 rc = +1;
3935 }
dan1fed5da2014-02-25 21:01:25 +00003936 }else{
drh2ab410a2015-11-06 14:59:07 +00003937 rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
dan1fed5da2014-02-25 21:01:25 +00003938 }
3939 }
3940 }
3941
3942 /* RHS is a string */
3943 else if( pRhs->flags & MEM_Str ){
3944 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00003945 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00003946 if( serial_type<12 ){
3947 rc = -1;
3948 }else if( !(serial_type & 0x01) ){
3949 rc = +1;
3950 }else{
3951 mem1.n = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00003952 testcase( (d1+mem1.n)==(unsigned)nKey1 );
3953 testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00003954 if( (d1+mem1.n) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00003955 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00003956 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00003957 }else if( pKeyInfo->aColl[i] ){
3958 mem1.enc = pKeyInfo->enc;
3959 mem1.db = pKeyInfo->db;
3960 mem1.flags = MEM_Str;
drhfcb44a82014-03-03 15:13:27 +00003961 mem1.z = (char*)&aKey1[d1];
dan38fdead2014-04-01 10:19:02 +00003962 rc = vdbeCompareMemString(
3963 &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
3964 );
dan1fed5da2014-02-25 21:01:25 +00003965 }else{
3966 int nCmp = MIN(mem1.n, pRhs->n);
3967 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
3968 if( rc==0 ) rc = mem1.n - pRhs->n;
3969 }
3970 }
3971 }
3972
3973 /* RHS is a blob */
3974 else if( pRhs->flags & MEM_Blob ){
3975 getVarint32(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00003976 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00003977 if( serial_type<12 || (serial_type & 0x01) ){
3978 rc = -1;
3979 }else{
3980 int nStr = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00003981 testcase( (d1+nStr)==(unsigned)nKey1 );
3982 testcase( (d1+nStr+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00003983 if( (d1+nStr) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00003984 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00003985 return 0; /* Corruption */
dan1fed5da2014-02-25 21:01:25 +00003986 }else{
3987 int nCmp = MIN(nStr, pRhs->n);
3988 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
3989 if( rc==0 ) rc = nStr - pRhs->n;
3990 }
3991 }
3992 }
3993
3994 /* RHS is null */
3995 else{
3996 serial_type = aKey1[idx1];
3997 rc = (serial_type!=0);
3998 }
3999
4000 if( rc!=0 ){
dan1fed5da2014-02-25 21:01:25 +00004001 if( pKeyInfo->aSortOrder[i] ){
4002 rc = -rc;
dan1fed5da2014-02-25 21:01:25 +00004003 }
drh79211e12014-05-02 17:33:16 +00004004 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
drh17bcb102014-09-18 21:25:33 +00004005 assert( mem1.szMalloc==0 ); /* See comment below */
dan1fed5da2014-02-25 21:01:25 +00004006 return rc;
4007 }
4008
4009 i++;
dan3b9330f2014-02-27 20:44:18 +00004010 pRhs++;
dan1fed5da2014-02-25 21:01:25 +00004011 d1 += sqlite3VdbeSerialTypeLen(serial_type);
4012 idx1 += sqlite3VarintLen(serial_type);
drh295aedf2014-03-03 18:25:24 +00004013 }while( idx1<(unsigned)szHdr1 && i<pPKey2->nField && d1<=(unsigned)nKey1 );
dan1fed5da2014-02-25 21:01:25 +00004014
4015 /* No memory allocation is ever used on mem1. Prove this using
4016 ** the following assert(). If the assert() fails, it indicates a
dan3833e932014-03-01 19:44:56 +00004017 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
drh17bcb102014-09-18 21:25:33 +00004018 assert( mem1.szMalloc==0 );
dan1fed5da2014-02-25 21:01:25 +00004019
4020 /* rc==0 here means that one or both of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004021 ** all the fields up to that point were equal. Return the default_rc
dan1fed5da2014-02-25 21:01:25 +00004022 ** value. */
dan3833e932014-03-01 19:44:56 +00004023 assert( CORRUPT_DB
drh66141812014-06-30 20:25:03 +00004024 || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
dan6696ba32014-06-28 19:06:49 +00004025 || pKeyInfo->db->mallocFailed
dan3833e932014-03-01 19:44:56 +00004026 );
drh70528d72015-11-05 20:25:09 +00004027 pPKey2->eqSeen = 1;
dan1fed5da2014-02-25 21:01:25 +00004028 return pPKey2->default_rc;
4029}
drh75179de2014-09-16 14:37:35 +00004030int sqlite3VdbeRecordCompare(
4031 int nKey1, const void *pKey1, /* Left key */
4032 UnpackedRecord *pPKey2 /* Right key */
4033){
dan7004f3f2015-03-30 12:06:26 +00004034 return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
drh75179de2014-09-16 14:37:35 +00004035}
4036
dan1fed5da2014-02-25 21:01:25 +00004037
dan3833e932014-03-01 19:44:56 +00004038/*
4039** This function is an optimized version of sqlite3VdbeRecordCompare()
4040** that (a) the first field of pPKey2 is an integer, and (b) the
4041** size-of-header varint at the start of (pKey1/nKey1) fits in a single
4042** byte (i.e. is less than 128).
drhe2ac5062014-03-26 12:02:38 +00004043**
4044** To avoid concerns about buffer overreads, this routine is only used
4045** on schemas where the maximum valid header size is 63 bytes or less.
dan3833e932014-03-01 19:44:56 +00004046*/
dan3b9330f2014-02-27 20:44:18 +00004047static int vdbeRecordCompareInt(
4048 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004049 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004050){
dan9b8afef2014-03-03 20:48:50 +00004051 const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
dan3b9330f2014-02-27 20:44:18 +00004052 int serial_type = ((const u8*)pKey1)[1];
4053 int res;
drhf926d1e2014-03-04 04:04:33 +00004054 u32 y;
4055 u64 x;
dan3b9330f2014-02-27 20:44:18 +00004056 i64 v = pPKey2->aMem[0].u.i;
4057 i64 lhs;
4058
drhe1bb8022015-01-19 19:48:52 +00004059 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drhe2ac5062014-03-26 12:02:38 +00004060 assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
dan3833e932014-03-01 19:44:56 +00004061 switch( serial_type ){
drhf926d1e2014-03-04 04:04:33 +00004062 case 1: { /* 1-byte signed integer */
4063 lhs = ONE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004064 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004065 break;
4066 }
drhf926d1e2014-03-04 04:04:33 +00004067 case 2: { /* 2-byte signed integer */
4068 lhs = TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004069 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004070 break;
4071 }
4072 case 3: { /* 3-byte signed integer */
4073 lhs = THREE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004074 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004075 break;
4076 }
4077 case 4: { /* 4-byte signed integer */
4078 y = FOUR_BYTE_UINT(aKey);
4079 lhs = (i64)*(int*)&y;
drhb6e8fd12014-03-06 01:56:33 +00004080 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004081 break;
4082 }
4083 case 5: { /* 6-byte signed integer */
4084 lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004085 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004086 break;
4087 }
4088 case 6: { /* 8-byte signed integer */
4089 x = FOUR_BYTE_UINT(aKey);
4090 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4091 lhs = *(i64*)&x;
drhb6e8fd12014-03-06 01:56:33 +00004092 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004093 break;
4094 }
dan3b9330f2014-02-27 20:44:18 +00004095 case 8:
4096 lhs = 0;
4097 break;
dan3b9330f2014-02-27 20:44:18 +00004098 case 9:
4099 lhs = 1;
4100 break;
4101
dan063d4a02014-02-28 09:48:30 +00004102 /* This case could be removed without changing the results of running
4103 ** this code. Including it causes gcc to generate a faster switch
4104 ** statement (since the range of switch targets now starts at zero and
dan597515d2014-02-28 18:39:51 +00004105 ** is contiguous) but does not cause any duplicate code to be generated
dan063d4a02014-02-28 09:48:30 +00004106 ** (as gcc is clever enough to combine the two like cases). Other
4107 ** compilers might be similar. */
4108 case 0: case 7:
drh75179de2014-09-16 14:37:35 +00004109 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan063d4a02014-02-28 09:48:30 +00004110
dan3b9330f2014-02-27 20:44:18 +00004111 default:
drh75179de2014-09-16 14:37:35 +00004112 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan3b9330f2014-02-27 20:44:18 +00004113 }
4114
4115 if( v>lhs ){
4116 res = pPKey2->r1;
4117 }else if( v<lhs ){
4118 res = pPKey2->r2;
4119 }else if( pPKey2->nField>1 ){
dan063d4a02014-02-28 09:48:30 +00004120 /* The first fields of the two keys are equal. Compare the trailing
4121 ** fields. */
dan7004f3f2015-03-30 12:06:26 +00004122 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004123 }else{
dan063d4a02014-02-28 09:48:30 +00004124 /* The first fields of the two keys are equal and there are no trailing
4125 ** fields. Return pPKey2->default_rc in this case. */
dan3b9330f2014-02-27 20:44:18 +00004126 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004127 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004128 }
4129
drh79211e12014-05-02 17:33:16 +00004130 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
dan3b9330f2014-02-27 20:44:18 +00004131 return res;
4132}
4133
dan3833e932014-03-01 19:44:56 +00004134/*
4135** This function is an optimized version of sqlite3VdbeRecordCompare()
4136** that (a) the first field of pPKey2 is a string, that (b) the first field
4137** uses the collation sequence BINARY and (c) that the size-of-header varint
4138** at the start of (pKey1/nKey1) fits in a single byte.
4139*/
dan3b9330f2014-02-27 20:44:18 +00004140static int vdbeRecordCompareString(
4141 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004142 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004143){
4144 const u8 *aKey1 = (const u8*)pKey1;
4145 int serial_type;
4146 int res;
4147
drh2ab410a2015-11-06 14:59:07 +00004148 assert( pPKey2->aMem[0].flags & MEM_Str );
drhe1bb8022015-01-19 19:48:52 +00004149 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
dan3b9330f2014-02-27 20:44:18 +00004150 getVarint32(&aKey1[1], serial_type);
dan3b9330f2014-02-27 20:44:18 +00004151 if( serial_type<12 ){
4152 res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
4153 }else if( !(serial_type & 0x01) ){
4154 res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
4155 }else{
4156 int nCmp;
4157 int nStr;
dan3833e932014-03-01 19:44:56 +00004158 int szHdr = aKey1[0];
dan3b9330f2014-02-27 20:44:18 +00004159
4160 nStr = (serial_type-12) / 2;
drha1f7c0a2014-03-28 03:12:48 +00004161 if( (szHdr + nStr) > nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004162 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004163 return 0; /* Corruption */
4164 }
dan3b9330f2014-02-27 20:44:18 +00004165 nCmp = MIN( pPKey2->aMem[0].n, nStr );
dan3833e932014-03-01 19:44:56 +00004166 res = memcmp(&aKey1[szHdr], pPKey2->aMem[0].z, nCmp);
dan3b9330f2014-02-27 20:44:18 +00004167
4168 if( res==0 ){
4169 res = nStr - pPKey2->aMem[0].n;
4170 if( res==0 ){
4171 if( pPKey2->nField>1 ){
dan7004f3f2015-03-30 12:06:26 +00004172 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004173 }else{
4174 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004175 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004176 }
4177 }else if( res>0 ){
4178 res = pPKey2->r2;
4179 }else{
4180 res = pPKey2->r1;
4181 }
4182 }else if( res>0 ){
4183 res = pPKey2->r2;
4184 }else{
4185 res = pPKey2->r1;
4186 }
4187 }
4188
drh66141812014-06-30 20:25:03 +00004189 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
dan3b9330f2014-02-27 20:44:18 +00004190 || CORRUPT_DB
dan6696ba32014-06-28 19:06:49 +00004191 || pPKey2->pKeyInfo->db->mallocFailed
dan3b9330f2014-02-27 20:44:18 +00004192 );
4193 return res;
4194}
4195
dan3833e932014-03-01 19:44:56 +00004196/*
4197** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
4198** suitable for comparing serialized records to the unpacked record passed
4199** as the only argument.
4200*/
dan1fed5da2014-02-25 21:01:25 +00004201RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
dan9b8afef2014-03-03 20:48:50 +00004202 /* varintRecordCompareInt() and varintRecordCompareString() both assume
4203 ** that the size-of-header varint that occurs at the start of each record
4204 ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
4205 ** also assumes that it is safe to overread a buffer by at least the
4206 ** maximum possible legal header size plus 8 bytes. Because there is
4207 ** guaranteed to be at least 74 (but not 136) bytes of padding following each
4208 ** buffer passed to varintRecordCompareInt() this makes it convenient to
4209 ** limit the size of the header to 64 bytes in cases where the first field
4210 ** is an integer.
4211 **
4212 ** The easiest way to enforce this limit is to consider only records with
4213 ** 13 fields or less. If the first field is an integer, the maximum legal
4214 ** header size is (12*5 + 1 + 1) bytes. */
4215 if( (p->pKeyInfo->nField + p->pKeyInfo->nXField)<=13 ){
dan1fed5da2014-02-25 21:01:25 +00004216 int flags = p->aMem[0].flags;
dan3b9330f2014-02-27 20:44:18 +00004217 if( p->pKeyInfo->aSortOrder[0] ){
4218 p->r1 = 1;
4219 p->r2 = -1;
4220 }else{
4221 p->r1 = -1;
4222 p->r2 = 1;
4223 }
dan1fed5da2014-02-25 21:01:25 +00004224 if( (flags & MEM_Int) ){
4225 return vdbeRecordCompareInt;
dan3b9330f2014-02-27 20:44:18 +00004226 }
drhb6e8fd12014-03-06 01:56:33 +00004227 testcase( flags & MEM_Real );
4228 testcase( flags & MEM_Null );
4229 testcase( flags & MEM_Blob );
4230 if( (flags & (MEM_Real|MEM_Null|MEM_Blob))==0 && p->pKeyInfo->aColl[0]==0 ){
4231 assert( flags & MEM_Str );
dan1fed5da2014-02-25 21:01:25 +00004232 return vdbeRecordCompareString;
4233 }
4234 }
dan3b9330f2014-02-27 20:44:18 +00004235
dan3833e932014-03-01 19:44:56 +00004236 return sqlite3VdbeRecordCompare;
dan3b9330f2014-02-27 20:44:18 +00004237}
danielk1977eb015e02004-05-18 01:31:14 +00004238
4239/*
drh7a224de2004-06-02 01:22:02 +00004240** pCur points at an index entry created using the OP_MakeRecord opcode.
4241** Read the rowid (the last field in the record) and store it in *rowid.
4242** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00004243**
4244** pCur might be pointing to text obtained from a corrupt database file.
4245** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00004246*/
drh35f6b932009-06-23 14:15:04 +00004247int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00004248 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004249 int rc;
drhd5788202004-05-28 08:21:05 +00004250 u32 szHdr; /* Size of the header */
4251 u32 typeRowid; /* Serial type of the rowid */
4252 u32 lenRowid; /* Size of the rowid */
4253 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00004254
drh88a003e2008-12-11 16:17:03 +00004255 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00004256 ** than 2GiB are support - anything large must be database corruption.
4257 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00004258 ** this code can safely assume that nCellKey is 32-bits
4259 */
drhea8ffdf2009-07-22 00:35:23 +00004260 assert( sqlite3BtreeCursorIsValid(pCur) );
drhb07028f2011-10-14 21:49:18 +00004261 VVA_ONLY(rc =) sqlite3BtreeKeySize(pCur, &nCellKey);
drhc27ae612009-07-14 18:35:44 +00004262 assert( rc==SQLITE_OK ); /* pCur is always valid so KeySize cannot fail */
drh7b746032009-06-26 12:15:22 +00004263 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00004264
4265 /* Read in the complete content of the index entry */
drhd3b74202014-09-17 16:41:15 +00004266 sqlite3VdbeMemInit(&m, db, 0);
drh501932c2013-11-21 21:59:53 +00004267 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhd5788202004-05-28 08:21:05 +00004268 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00004269 return rc;
4270 }
drh88a003e2008-12-11 16:17:03 +00004271
4272 /* The index entry must begin with a header size */
shane3f8d5cf2008-04-24 19:15:09 +00004273 (void)getVarint32((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00004274 testcase( szHdr==3 );
drh88a003e2008-12-11 16:17:03 +00004275 testcase( szHdr==m.n );
drh7b746032009-06-26 12:15:22 +00004276 if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
drh88a003e2008-12-11 16:17:03 +00004277 goto idx_rowid_corruption;
4278 }
4279
4280 /* The last field of the index should be an integer - the ROWID.
4281 ** Verify that the last entry really is an integer. */
shane3f8d5cf2008-04-24 19:15:09 +00004282 (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00004283 testcase( typeRowid==1 );
4284 testcase( typeRowid==2 );
4285 testcase( typeRowid==3 );
4286 testcase( typeRowid==4 );
4287 testcase( typeRowid==5 );
4288 testcase( typeRowid==6 );
4289 testcase( typeRowid==8 );
4290 testcase( typeRowid==9 );
4291 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
4292 goto idx_rowid_corruption;
4293 }
drhc5ef7152015-06-28 02:58:51 +00004294 lenRowid = sqlite3SmallTypeSizes[typeRowid];
drheeb844a2009-08-08 18:01:07 +00004295 testcase( (u32)m.n==szHdr+lenRowid );
4296 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00004297 goto idx_rowid_corruption;
4298 }
4299
4300 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00004301 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00004302 *rowid = v.u.i;
danielk1977d8123362004-06-12 09:25:12 +00004303 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004304 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00004305
4306 /* Jump here if database corruption is detected after m has been
4307 ** allocated. Free the m object and return SQLITE_CORRUPT. */
4308idx_rowid_corruption:
drh17bcb102014-09-18 21:25:33 +00004309 testcase( m.szMalloc!=0 );
drh88a003e2008-12-11 16:17:03 +00004310 sqlite3VdbeMemRelease(&m);
4311 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004312}
4313
drh7cf6e4d2004-05-19 14:56:55 +00004314/*
drh5f82e3c2009-07-06 00:44:08 +00004315** Compare the key of the index entry that cursor pC is pointing to against
4316** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00004317** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00004318** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00004319**
drh5f82e3c2009-07-06 00:44:08 +00004320** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00004321** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00004322** is ignored as well. Hence, this routine only compares the prefixes
4323** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00004324*/
danielk1977183f9f72004-05-13 05:20:26 +00004325int sqlite3VdbeIdxKeyCompare(
drhd3b74202014-09-17 16:41:15 +00004326 sqlite3 *db, /* Database connection */
drh295aedf2014-03-03 18:25:24 +00004327 VdbeCursor *pC, /* The cursor to compare against */
drha1f7c0a2014-03-28 03:12:48 +00004328 UnpackedRecord *pUnpacked, /* Unpacked version of key */
drh295aedf2014-03-03 18:25:24 +00004329 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00004330){
drh61fc5952007-04-01 23:49:51 +00004331 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004332 int rc;
drhc960dcb2015-11-20 19:22:01 +00004333 BtCursor *pCur;
drhd5788202004-05-28 08:21:05 +00004334 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00004335
drhc960dcb2015-11-20 19:22:01 +00004336 assert( pC->eCurType==CURTYPE_BTREE );
4337 pCur = pC->uc.pCursor;
drhea8ffdf2009-07-22 00:35:23 +00004338 assert( sqlite3BtreeCursorIsValid(pCur) );
drhb07028f2011-10-14 21:49:18 +00004339 VVA_ONLY(rc =) sqlite3BtreeKeySize(pCur, &nCellKey);
drhc27ae612009-07-14 18:35:44 +00004340 assert( rc==SQLITE_OK ); /* pCur is always valid so KeySize cannot fail */
drh56689692014-03-03 19:29:28 +00004341 /* nCellKey will always be between 0 and 0xffffffff because of the way
drh407414c2009-07-14 14:15:27 +00004342 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00004343 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00004344 *res = 0;
drh9978c972010-02-23 17:36:32 +00004345 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00004346 }
drhd3b74202014-09-17 16:41:15 +00004347 sqlite3VdbeMemInit(&m, db, 0);
drhc960dcb2015-11-20 19:22:01 +00004348 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhec1fc802008-08-13 14:07:40 +00004349 if( rc ){
drhd5788202004-05-28 08:21:05 +00004350 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00004351 }
drhe63d9992008-08-13 19:11:48 +00004352 *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
danielk1977d8123362004-06-12 09:25:12 +00004353 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00004354 return SQLITE_OK;
4355}
danielk1977b28af712004-06-21 06:50:26 +00004356
4357/*
4358** This routine sets the value to be returned by subsequent calls to
4359** sqlite3_changes() on the database handle 'db'.
4360*/
4361void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
drhb21c8cd2007-08-21 19:33:56 +00004362 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00004363 db->nChange = nChange;
4364 db->nTotalChange += nChange;
4365}
4366
4367/*
4368** Set a flag in the vdbe to update the change counter when it is finalised
4369** or reset.
4370*/
drh4794f732004-11-05 17:17:50 +00004371void sqlite3VdbeCountChanges(Vdbe *v){
4372 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00004373}
drhd89bd002005-01-22 03:03:54 +00004374
4375/*
4376** Mark every prepared statement associated with a database connection
4377** as expired.
4378**
4379** An expired statement means that recompilation of the statement is
4380** recommend. Statements expire when things happen that make their
4381** programs obsolete. Removing user-defined functions or collating
4382** sequences, or changing an authorization function are the types of
4383** things that make prepared statements obsolete.
4384*/
4385void sqlite3ExpirePreparedStatements(sqlite3 *db){
4386 Vdbe *p;
4387 for(p = db->pVdbe; p; p=p->pNext){
4388 p->expired = 1;
4389 }
4390}
danielk1977aee18ef2005-03-09 12:26:50 +00004391
4392/*
4393** Return the database associated with the Vdbe.
4394*/
4395sqlite3 *sqlite3VdbeDb(Vdbe *v){
4396 return v->db;
4397}
dan937d0de2009-10-15 18:35:38 +00004398
4399/*
4400** Return a pointer to an sqlite3_value structure containing the value bound
4401** parameter iVar of VM v. Except, if the value is an SQL NULL, return
4402** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
4403** constants) to the value before returning it.
4404**
4405** The returned value must be freed by the caller using sqlite3ValueFree().
4406*/
drhcf0fd4a2013-08-01 12:21:58 +00004407sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00004408 assert( iVar>0 );
4409 if( v ){
4410 Mem *pMem = &v->aVar[iVar-1];
4411 if( 0==(pMem->flags & MEM_Null) ){
4412 sqlite3_value *pRet = sqlite3ValueNew(v->db);
4413 if( pRet ){
4414 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
4415 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
dan937d0de2009-10-15 18:35:38 +00004416 }
4417 return pRet;
4418 }
4419 }
4420 return 0;
4421}
4422
4423/*
4424** Configure SQL variable iVar so that binding a new value to it signals
4425** to sqlite3_reoptimize() that re-preparing the statement may result
4426** in a better query plan.
4427*/
dan1d2ce4f2009-10-19 18:11:09 +00004428void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00004429 assert( iVar>0 );
4430 if( iVar>32 ){
dan1d2ce4f2009-10-19 18:11:09 +00004431 v->expmask = 0xffffffff;
dan937d0de2009-10-15 18:35:38 +00004432 }else{
dan1d2ce4f2009-10-19 18:11:09 +00004433 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00004434 }
4435}
dan016f7812013-08-21 17:35:48 +00004436
4437#ifndef SQLITE_OMIT_VIRTUALTABLE
4438/*
4439** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
4440** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
4441** in memory obtained from sqlite3DbMalloc).
4442*/
4443void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
dan5c3aa052016-01-20 08:47:55 +00004444 if( pVtab->zErrMsg ){
4445 sqlite3 *db = p->db;
4446 sqlite3DbFree(db, p->zErrMsg);
4447 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
4448 sqlite3_free(pVtab->zErrMsg);
4449 pVtab->zErrMsg = 0;
4450 }
dan016f7812013-08-21 17:35:48 +00004451}
4452#endif /* SQLITE_OMIT_VIRTUALTABLE */