blob: 9e1eb581f04bc9c746d299f6748d36d8c86fc1d2 [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
danielk1977fc57d7b2004-05-26 02:04:57 +000013** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.) Prior
drh9a324642003-09-06 20:12:01 +000014** to version 2.8.7, all this code was combined into the vdbe.c source file.
15** But that file was getting too big so this subroutines were split out.
16*/
17#include "sqliteInt.h"
drh9a324642003-09-06 20:12:01 +000018#include "vdbeInt.h"
19
drh9a324642003-09-06 20:12:01 +000020/*
21** Create a new virtual database engine.
22*/
drh9bb575f2004-09-06 17:24:11 +000023Vdbe *sqlite3VdbeCreate(sqlite3 *db){
drh9a324642003-09-06 20:12:01 +000024 Vdbe *p;
drh17435752007-08-16 04:30:38 +000025 p = sqlite3DbMallocZero(db, sizeof(Vdbe) );
drh9a324642003-09-06 20:12:01 +000026 if( p==0 ) return 0;
27 p->db = db;
28 if( db->pVdbe ){
29 db->pVdbe->pPrev = p;
30 }
31 p->pNext = db->pVdbe;
32 p->pPrev = 0;
33 db->pVdbe = p;
34 p->magic = VDBE_MAGIC_INIT;
35 return p;
36}
37
38/*
drhb900aaf2006-11-09 00:24:53 +000039** Remember the SQL string for a prepared statement.
40*/
danielk19776ab3a2e2009-02-19 14:39:25 +000041void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, int isPrepareV2){
dan1d2ce4f2009-10-19 18:11:09 +000042 assert( isPrepareV2==1 || isPrepareV2==0 );
drhb900aaf2006-11-09 00:24:53 +000043 if( p==0 ) return;
danac455932012-11-26 19:50:41 +000044#if defined(SQLITE_OMIT_TRACE) && !defined(SQLITE_ENABLE_SQLLOG)
danielk19776ab3a2e2009-02-19 14:39:25 +000045 if( !isPrepareV2 ) return;
46#endif
drhb900aaf2006-11-09 00:24:53 +000047 assert( p->zSql==0 );
drh17435752007-08-16 04:30:38 +000048 p->zSql = sqlite3DbStrNDup(p->db, z, n);
shanef639c402009-11-03 19:42:30 +000049 p->isPrepareV2 = (u8)isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000050}
51
52/*
53** Return the SQL associated with a prepared statement
54*/
danielk1977d0e2a852007-11-14 06:48:48 +000055const char *sqlite3_sql(sqlite3_stmt *pStmt){
danielk19776ab3a2e2009-02-19 14:39:25 +000056 Vdbe *p = (Vdbe *)pStmt;
drh87f5c5f2010-01-20 01:20:56 +000057 return (p && p->isPrepareV2) ? p->zSql : 0;
drhb900aaf2006-11-09 00:24:53 +000058}
59
60/*
drhc5155252007-01-08 21:07:17 +000061** Swap all content between two VDBE structures.
drhb900aaf2006-11-09 00:24:53 +000062*/
drhc5155252007-01-08 21:07:17 +000063void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
64 Vdbe tmp, *pTmp;
65 char *zTmp;
drhc5155252007-01-08 21:07:17 +000066 tmp = *pA;
67 *pA = *pB;
68 *pB = tmp;
69 pTmp = pA->pNext;
70 pA->pNext = pB->pNext;
71 pB->pNext = pTmp;
72 pTmp = pA->pPrev;
73 pA->pPrev = pB->pPrev;
74 pB->pPrev = pTmp;
75 zTmp = pA->zSql;
76 pA->zSql = pB->zSql;
77 pB->zSql = zTmp;
danielk19776ab3a2e2009-02-19 14:39:25 +000078 pB->isPrepareV2 = pA->isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000079}
80
drh9a324642003-09-06 20:12:01 +000081/*
danielk197700e13612008-11-17 19:18:54 +000082** Resize the Vdbe.aOp array so that it is at least one op larger than
83** it was.
danielk1977ace3eb22006-01-26 10:35:04 +000084**
danielk197700e13612008-11-17 19:18:54 +000085** If an out-of-memory error occurs while resizing the array, return
86** SQLITE_NOMEM. In this case Vdbe.aOp and Vdbe.nOpAlloc remain
87** unchanged (this is so that any opcodes already allocated can be
88** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +000089*/
danielk197700e13612008-11-17 19:18:54 +000090static int growOpArray(Vdbe *p){
drha4e5d582007-10-20 15:41:57 +000091 VdbeOp *pNew;
danielk197700e13612008-11-17 19:18:54 +000092 int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
93 pNew = sqlite3DbRealloc(p->db, p->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +000094 if( pNew ){
drhb45f65d2009-03-01 19:42:11 +000095 p->nOpAlloc = sqlite3DbMallocSize(p->db, pNew)/sizeof(Op);
drha4e5d582007-10-20 15:41:57 +000096 p->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +000097 }
danielk197700e13612008-11-17 19:18:54 +000098 return (pNew ? SQLITE_OK : SQLITE_NOMEM);
drh76ff3a02004-09-24 22:32:30 +000099}
100
drh313619f2013-10-31 20:34:06 +0000101#ifdef SQLITE_DEBUG
102/* This routine is just a convenient place to set a breakpoint that will
103** fire after each opcode is inserted and displayed using
104** "PRAGMA vdbe_addoptrace=on".
105*/
106static void test_addop_breakpoint(void){
107 static int n = 0;
108 n++;
109}
110#endif
111
drh76ff3a02004-09-24 22:32:30 +0000112/*
drh9a324642003-09-06 20:12:01 +0000113** Add a new instruction to the list of instructions current in the
114** VDBE. Return the address of the new instruction.
115**
116** Parameters:
117**
118** p Pointer to the VDBE
119**
120** op The opcode for this instruction
121**
drh66a51672008-01-03 00:01:23 +0000122** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000123**
danielk19774adee202004-05-08 08:23:19 +0000124** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000125** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000126** operand.
127*/
drh66a51672008-01-03 00:01:23 +0000128int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000129 int i;
drh701a0ae2004-02-22 20:05:00 +0000130 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000131
132 i = p->nOp;
drh9a324642003-09-06 20:12:01 +0000133 assert( p->magic==VDBE_MAGIC_INIT );
drh8df32842008-12-09 02:51:23 +0000134 assert( op>0 && op<0xff );
drhfd2d26b2006-03-15 22:44:36 +0000135 if( p->nOpAlloc<=i ){
danielk197700e13612008-11-17 19:18:54 +0000136 if( growOpArray(p) ){
drhc42ed162009-06-26 14:04:51 +0000137 return 1;
drhfd2d26b2006-03-15 22:44:36 +0000138 }
drh9a324642003-09-06 20:12:01 +0000139 }
danielk197701256832007-04-18 14:24:32 +0000140 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000141 pOp = &p->aOp[i];
drh8df32842008-12-09 02:51:23 +0000142 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000143 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000144 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000145 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000146 pOp->p3 = p3;
147 pOp->p4.p = 0;
148 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000149#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000150 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000151#endif
152#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000153 if( p->db->flags & SQLITE_VdbeAddopTrace ){
154 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh313619f2013-10-31 20:34:06 +0000155 test_addop_breakpoint();
drhe0962052013-01-29 19:14:31 +0000156 }
drh9a324642003-09-06 20:12:01 +0000157#endif
drh26c9b5e2008-04-11 14:56:53 +0000158#ifdef VDBE_PROFILE
159 pOp->cycles = 0;
160 pOp->cnt = 0;
161#endif
drh9a324642003-09-06 20:12:01 +0000162 return i;
163}
drh66a51672008-01-03 00:01:23 +0000164int sqlite3VdbeAddOp0(Vdbe *p, int op){
165 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
166}
167int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
168 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
169}
170int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
171 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000172}
173
drh66a51672008-01-03 00:01:23 +0000174
drh701a0ae2004-02-22 20:05:00 +0000175/*
drh66a51672008-01-03 00:01:23 +0000176** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000177*/
drh66a51672008-01-03 00:01:23 +0000178int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000179 Vdbe *p, /* Add the opcode to this VM */
180 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000181 int p1, /* The P1 operand */
182 int p2, /* The P2 operand */
183 int p3, /* The P3 operand */
184 const char *zP4, /* The P4 operand */
185 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000186){
drh66a51672008-01-03 00:01:23 +0000187 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
188 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000189 return addr;
190}
191
192/*
drh5d9c9da2011-06-03 20:11:17 +0000193** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000194** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
195** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000196**
197** The zWhere string must have been obtained from sqlite3_malloc().
198** This routine will take ownership of the allocated memory.
199*/
200void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
201 int j;
202 int addr = sqlite3VdbeAddOp3(p, OP_ParseSchema, iDb, 0, 0);
203 sqlite3VdbeChangeP4(p, addr, zWhere, P4_DYNAMIC);
204 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
205}
206
207/*
drh8cff69d2009-11-12 19:59:44 +0000208** Add an opcode that includes the p4 value as an integer.
209*/
210int sqlite3VdbeAddOp4Int(
211 Vdbe *p, /* Add the opcode to this VM */
212 int op, /* The new opcode */
213 int p1, /* The P1 operand */
214 int p2, /* The P2 operand */
215 int p3, /* The P3 operand */
216 int p4 /* The P4 operand as an integer */
217){
218 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
219 sqlite3VdbeChangeP4(p, addr, SQLITE_INT_TO_PTR(p4), P4_INT32);
220 return addr;
221}
222
223/*
drh9a324642003-09-06 20:12:01 +0000224** Create a new symbolic label for an instruction that has yet to be
225** coded. The symbolic label is really just a negative number. The
226** label can be used as the P2 value of an operation. Later, when
227** the label is resolved to a specific address, the VDBE will scan
228** through its operation list and change all values of P2 which match
229** the label into the resolved address.
230**
231** The VDBE knows that a P2 value is a label because labels are
232** always negative and P2 values are suppose to be non-negative.
233** Hence, a negative P2 value is a label that has yet to be resolved.
danielk1977b5548a82004-06-26 13:51:33 +0000234**
235** Zero is returned if a malloc() fails.
drh9a324642003-09-06 20:12:01 +0000236*/
danielk19774adee202004-05-08 08:23:19 +0000237int sqlite3VdbeMakeLabel(Vdbe *p){
drhc35f3d52012-02-01 19:03:38 +0000238 int i = p->nLabel++;
drh9a324642003-09-06 20:12:01 +0000239 assert( p->magic==VDBE_MAGIC_INIT );
drhc35f3d52012-02-01 19:03:38 +0000240 if( (i & (i-1))==0 ){
241 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
242 (i*2+1)*sizeof(p->aLabel[0]));
drh9a324642003-09-06 20:12:01 +0000243 }
drh76ff3a02004-09-24 22:32:30 +0000244 if( p->aLabel ){
245 p->aLabel[i] = -1;
drh9a324642003-09-06 20:12:01 +0000246 }
drh9a324642003-09-06 20:12:01 +0000247 return -1-i;
248}
249
250/*
251** Resolve label "x" to be the address of the next instruction to
252** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000253** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000254*/
danielk19774adee202004-05-08 08:23:19 +0000255void sqlite3VdbeResolveLabel(Vdbe *p, int x){
drh76ff3a02004-09-24 22:32:30 +0000256 int j = -1-x;
drh9a324642003-09-06 20:12:01 +0000257 assert( p->magic==VDBE_MAGIC_INIT );
drhb2b9d3d2013-08-01 01:14:43 +0000258 assert( j<p->nLabel );
259 if( j>=0 && p->aLabel ){
drh76ff3a02004-09-24 22:32:30 +0000260 p->aLabel[j] = p->nOp;
drh9a324642003-09-06 20:12:01 +0000261 }
262}
263
drh4611d922010-02-25 14:47:01 +0000264/*
265** Mark the VDBE as one that can only be run one time.
266*/
267void sqlite3VdbeRunOnlyOnce(Vdbe *p){
268 p->runOnlyOnce = 1;
269}
270
drhff738bc2009-09-24 00:09:58 +0000271#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000272
273/*
274** The following type and function are used to iterate through all opcodes
275** in a Vdbe main program and each of the sub-programs (triggers) it may
276** invoke directly or indirectly. It should be used as follows:
277**
278** Op *pOp;
279** VdbeOpIter sIter;
280**
281** memset(&sIter, 0, sizeof(sIter));
282** sIter.v = v; // v is of type Vdbe*
283** while( (pOp = opIterNext(&sIter)) ){
284** // Do something with pOp
285** }
286** sqlite3DbFree(v->db, sIter.apSub);
287**
288*/
289typedef struct VdbeOpIter VdbeOpIter;
290struct VdbeOpIter {
291 Vdbe *v; /* Vdbe to iterate through the opcodes of */
292 SubProgram **apSub; /* Array of subprograms */
293 int nSub; /* Number of entries in apSub */
294 int iAddr; /* Address of next instruction to return */
295 int iSub; /* 0 = main program, 1 = first sub-program etc. */
296};
297static Op *opIterNext(VdbeOpIter *p){
298 Vdbe *v = p->v;
299 Op *pRet = 0;
300 Op *aOp;
301 int nOp;
302
303 if( p->iSub<=p->nSub ){
304
305 if( p->iSub==0 ){
306 aOp = v->aOp;
307 nOp = v->nOp;
308 }else{
309 aOp = p->apSub[p->iSub-1]->aOp;
310 nOp = p->apSub[p->iSub-1]->nOp;
311 }
312 assert( p->iAddr<nOp );
313
314 pRet = &aOp[p->iAddr];
315 p->iAddr++;
316 if( p->iAddr==nOp ){
317 p->iSub++;
318 p->iAddr = 0;
319 }
320
321 if( pRet->p4type==P4_SUBPROGRAM ){
322 int nByte = (p->nSub+1)*sizeof(SubProgram*);
323 int j;
324 for(j=0; j<p->nSub; j++){
325 if( p->apSub[j]==pRet->p4.pProgram ) break;
326 }
327 if( j==p->nSub ){
328 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
329 if( !p->apSub ){
330 pRet = 0;
331 }else{
332 p->apSub[p->nSub++] = pRet->p4.pProgram;
333 }
334 }
335 }
336 }
337
338 return pRet;
339}
340
341/*
danf3677212009-09-10 16:14:50 +0000342** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000343** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000344** to be rolled back). This condition is true if the main program or any
345** sub-programs contains any of the following:
346**
347** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
348** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
349** * OP_Destroy
350** * OP_VUpdate
351** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000352** * OP_FkCounter with P2==0 (immediate foreign key constraint)
dan144926d2009-09-09 11:37:20 +0000353**
danf3677212009-09-10 16:14:50 +0000354** Then check that the value of Parse.mayAbort is true if an
355** ABORT may be thrown, or false otherwise. Return true if it does
356** match, or false otherwise. This function is intended to be used as
357** part of an assert statement in the compiler. Similar to:
358**
359** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000360*/
danf3677212009-09-10 16:14:50 +0000361int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
362 int hasAbort = 0;
dan144926d2009-09-09 11:37:20 +0000363 Op *pOp;
364 VdbeOpIter sIter;
365 memset(&sIter, 0, sizeof(sIter));
366 sIter.v = v;
367
368 while( (pOp = opIterNext(&sIter))!=0 ){
369 int opcode = pOp->opcode;
370 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
dan32b09f22009-09-23 17:29:59 +0000371#ifndef SQLITE_OMIT_FOREIGN_KEY
dan0ff297e2009-09-25 17:03:14 +0000372 || (opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1)
dan32b09f22009-09-23 17:29:59 +0000373#endif
dan144926d2009-09-09 11:37:20 +0000374 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drhd91c1a12013-02-09 13:58:25 +0000375 && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000376 ){
danf3677212009-09-10 16:14:50 +0000377 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000378 break;
379 }
380 }
dan144926d2009-09-09 11:37:20 +0000381 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000382
mistachkin48864df2013-03-21 21:20:32 +0000383 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000384 ** If malloc failed, then the while() loop above may not have iterated
385 ** through all opcodes and hasAbort may be set incorrectly. Return
386 ** true for this case to prevent the assert() in the callers frame
387 ** from failing. */
388 return ( v->db->mallocFailed || hasAbort==mayAbort );
dan144926d2009-09-09 11:37:20 +0000389}
drhff738bc2009-09-24 00:09:58 +0000390#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000391
drh9a324642003-09-06 20:12:01 +0000392/*
drh9cbf3422008-01-17 16:22:13 +0000393** Loop through the program looking for P2 values that are negative
394** on jump instructions. Each such value is a label. Resolve the
395** label by setting the P2 value to its correct non-zero value.
drh76ff3a02004-09-24 22:32:30 +0000396**
397** This routine is called once after all opcodes have been inserted.
danielk1977634f2982005-03-28 08:44:07 +0000398**
drh13449892005-09-07 21:22:45 +0000399** Variable *pMaxFuncArgs is set to the maximum value of any P2 argument
danielk1977399918f2006-06-14 13:03:23 +0000400** to an OP_Function, OP_AggStep or OP_VFilter opcode. This is used by
danielk1977634f2982005-03-28 08:44:07 +0000401** sqlite3VdbeMakeReady() to size the Vdbe.apArg[] array.
drha6c2ed92009-11-14 23:22:23 +0000402**
403** The Op.opflags field is set on all opcodes.
drh76ff3a02004-09-24 22:32:30 +0000404*/
drh9cbf3422008-01-17 16:22:13 +0000405static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
drh76ff3a02004-09-24 22:32:30 +0000406 int i;
dan165921a2009-08-28 18:53:45 +0000407 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000408 Op *pOp;
409 int *aLabel = p->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000410 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000411 p->bIsReader = 0;
drh76ff3a02004-09-24 22:32:30 +0000412 for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
danielk1977634f2982005-03-28 08:44:07 +0000413 u8 opcode = pOp->opcode;
414
drh8c8a8c42013-08-06 07:45:08 +0000415 /* NOTE: Be sure to update mkopcodeh.awk when adding or removing
416 ** cases from this switch! */
417 switch( opcode ){
418 case OP_Function:
419 case OP_AggStep: {
420 if( pOp->p5>nMaxArgs ) nMaxArgs = pOp->p5;
421 break;
422 }
423 case OP_Transaction: {
424 if( pOp->p2!=0 ) p->readOnly = 0;
425 /* fall thru */
426 }
427 case OP_AutoCommit:
428 case OP_Savepoint: {
429 p->bIsReader = 1;
430 break;
431 }
dand9031542013-07-05 16:54:30 +0000432#ifndef SQLITE_OMIT_WAL
drh8c8a8c42013-08-06 07:45:08 +0000433 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000434#endif
drh8c8a8c42013-08-06 07:45:08 +0000435 case OP_Vacuum:
436 case OP_JournalMode: {
437 p->readOnly = 0;
438 p->bIsReader = 1;
439 break;
440 }
danielk1977182c4ba2007-06-27 15:53:34 +0000441#ifndef SQLITE_OMIT_VIRTUALTABLE
drh8c8a8c42013-08-06 07:45:08 +0000442 case OP_VUpdate: {
443 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
444 break;
445 }
446 case OP_VFilter: {
447 int n;
448 assert( p->nOp - i >= 3 );
449 assert( pOp[-1].opcode==OP_Integer );
450 n = pOp[-1].p1;
451 if( n>nMaxArgs ) nMaxArgs = n;
452 break;
453 }
danielk1977182c4ba2007-06-27 15:53:34 +0000454#endif
drh8c8a8c42013-08-06 07:45:08 +0000455 case OP_Next:
drhf93cd942013-11-21 03:12:25 +0000456 case OP_NextIfOpen:
drh8c8a8c42013-08-06 07:45:08 +0000457 case OP_SorterNext: {
458 pOp->p4.xAdvance = sqlite3BtreeNext;
459 pOp->p4type = P4_ADVANCE;
460 break;
461 }
drhf93cd942013-11-21 03:12:25 +0000462 case OP_Prev:
463 case OP_PrevIfOpen: {
drh8c8a8c42013-08-06 07:45:08 +0000464 pOp->p4.xAdvance = sqlite3BtreePrevious;
465 pOp->p4type = P4_ADVANCE;
466 break;
467 }
danielk1977bc04f852005-03-29 08:26:13 +0000468 }
danielk1977634f2982005-03-28 08:44:07 +0000469
drh8c8a8c42013-08-06 07:45:08 +0000470 pOp->opflags = sqlite3OpcodeProperty[opcode];
drha6c2ed92009-11-14 23:22:23 +0000471 if( (pOp->opflags & OPFLG_JUMP)!=0 && pOp->p2<0 ){
drhd2981512008-01-04 19:33:49 +0000472 assert( -1-pOp->p2<p->nLabel );
473 pOp->p2 = aLabel[-1-pOp->p2];
474 }
drh76ff3a02004-09-24 22:32:30 +0000475 }
drh633e6d52008-07-28 19:34:53 +0000476 sqlite3DbFree(p->db, p->aLabel);
drh76ff3a02004-09-24 22:32:30 +0000477 p->aLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000478 *pMaxFuncArgs = nMaxArgs;
danc0537fe2013-06-28 19:41:43 +0000479 assert( p->bIsReader!=0 || p->btreeMask==0 );
drh76ff3a02004-09-24 22:32:30 +0000480}
481
482/*
drh9a324642003-09-06 20:12:01 +0000483** Return the address of the next instruction to be inserted.
484*/
danielk19774adee202004-05-08 08:23:19 +0000485int sqlite3VdbeCurrentAddr(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000486 assert( p->magic==VDBE_MAGIC_INIT );
487 return p->nOp;
488}
489
dan65a7cd12009-09-01 12:16:01 +0000490/*
491** This function returns a pointer to the array of opcodes associated with
492** the Vdbe passed as the first argument. It is the callers responsibility
493** to arrange for the returned array to be eventually freed using the
494** vdbeFreeOpArray() function.
495**
496** Before returning, *pnOp is set to the number of entries in the returned
497** array. Also, *pnMaxArg is set to the larger of its current value and
498** the number of entries in the Vdbe.apArg[] array required to execute the
499** returned program.
500*/
dan165921a2009-08-28 18:53:45 +0000501VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
502 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +0000503 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +0000504
505 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drhbdaec522011-04-04 00:14:43 +0000506 assert( p->btreeMask==0 );
dan65a7cd12009-09-01 12:16:01 +0000507
dan165921a2009-08-28 18:53:45 +0000508 resolveP2Values(p, pnMaxArg);
509 *pnOp = p->nOp;
510 p->aOp = 0;
511 return aOp;
512}
513
drh9a324642003-09-06 20:12:01 +0000514/*
515** Add a whole list of operations to the operation stack. Return the
516** address of the first operation added.
517*/
danielk19774adee202004-05-08 08:23:19 +0000518int sqlite3VdbeAddOpList(Vdbe *p, int nOp, VdbeOpList const *aOp){
drh9a324642003-09-06 20:12:01 +0000519 int addr;
520 assert( p->magic==VDBE_MAGIC_INIT );
danielk197700e13612008-11-17 19:18:54 +0000521 if( p->nOp + nOp > p->nOpAlloc && growOpArray(p) ){
drh76ff3a02004-09-24 22:32:30 +0000522 return 0;
drh9a324642003-09-06 20:12:01 +0000523 }
524 addr = p->nOp;
drh7b746032009-06-26 12:15:22 +0000525 if( ALWAYS(nOp>0) ){
drh9a324642003-09-06 20:12:01 +0000526 int i;
drh905793e2004-02-21 13:31:09 +0000527 VdbeOpList const *pIn = aOp;
528 for(i=0; i<nOp; i++, pIn++){
529 int p2 = pIn->p2;
530 VdbeOp *pOut = &p->aOp[i+addr];
531 pOut->opcode = pIn->opcode;
532 pOut->p1 = pIn->p1;
drh4308e342013-11-11 16:55:52 +0000533 if( p2<0 ){
534 assert( sqlite3OpcodeProperty[pOut->opcode] & OPFLG_JUMP );
drh8558cde2008-01-05 05:20:10 +0000535 pOut->p2 = addr + ADDR(p2);
536 }else{
537 pOut->p2 = p2;
538 }
drh24003452008-01-03 01:28:59 +0000539 pOut->p3 = pIn->p3;
540 pOut->p4type = P4_NOTUSED;
541 pOut->p4.p = 0;
542 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +0000543#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000544 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000545#endif
546#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000547 if( p->db->flags & SQLITE_VdbeAddopTrace ){
danielk19774adee202004-05-08 08:23:19 +0000548 sqlite3VdbePrintOp(0, i+addr, &p->aOp[i+addr]);
drh9a324642003-09-06 20:12:01 +0000549 }
550#endif
551 }
552 p->nOp += nOp;
553 }
554 return addr;
555}
556
557/*
558** Change the value of the P1 operand for a specific instruction.
559** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000560** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000561** few minor changes to the program.
562*/
drh88caeac2011-08-24 15:12:08 +0000563void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
drh7b746032009-06-26 12:15:22 +0000564 assert( p!=0 );
drh88caeac2011-08-24 15:12:08 +0000565 if( ((u32)p->nOp)>addr ){
drh9a324642003-09-06 20:12:01 +0000566 p->aOp[addr].p1 = val;
567 }
568}
569
570/*
571** Change the value of the P2 operand for a specific instruction.
572** This routine is useful for setting a jump destination.
573*/
drh88caeac2011-08-24 15:12:08 +0000574void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
drh7b746032009-06-26 12:15:22 +0000575 assert( p!=0 );
drh88caeac2011-08-24 15:12:08 +0000576 if( ((u32)p->nOp)>addr ){
drh9a324642003-09-06 20:12:01 +0000577 p->aOp[addr].p2 = val;
578 }
579}
580
drhd654be82005-09-20 17:42:23 +0000581/*
danielk19771f4aa332008-01-03 09:51:55 +0000582** Change the value of the P3 operand for a specific instruction.
danielk1977207872a2008-01-03 07:54:23 +0000583*/
drh88caeac2011-08-24 15:12:08 +0000584void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
drh7b746032009-06-26 12:15:22 +0000585 assert( p!=0 );
drh88caeac2011-08-24 15:12:08 +0000586 if( ((u32)p->nOp)>addr ){
danielk1977207872a2008-01-03 07:54:23 +0000587 p->aOp[addr].p3 = val;
588 }
589}
590
591/*
drh35573352008-01-08 23:54:25 +0000592** Change the value of the P5 operand for the most recently
593** added operation.
danielk19771f4aa332008-01-03 09:51:55 +0000594*/
drh35573352008-01-08 23:54:25 +0000595void sqlite3VdbeChangeP5(Vdbe *p, u8 val){
drh7b746032009-06-26 12:15:22 +0000596 assert( p!=0 );
597 if( p->aOp ){
drh35573352008-01-08 23:54:25 +0000598 assert( p->nOp>0 );
599 p->aOp[p->nOp-1].p5 = val;
danielk19771f4aa332008-01-03 09:51:55 +0000600 }
601}
602
603/*
drhf8875402006-03-17 13:56:34 +0000604** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +0000605** the address of the next instruction to be coded.
606*/
607void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drhe0c7efd2013-08-02 20:11:19 +0000608 if( ALWAYS(addr>=0) ) sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +0000609}
drhb38ad992005-09-16 00:27:01 +0000610
drhb7f6f682006-07-08 17:06:43 +0000611
612/*
613** If the input FuncDef structure is ephemeral, then free it. If
614** the FuncDef is not ephermal, then do nothing.
615*/
drh633e6d52008-07-28 19:34:53 +0000616static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drhd36e1042013-09-06 13:10:12 +0000617 if( ALWAYS(pDef) && (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh633e6d52008-07-28 19:34:53 +0000618 sqlite3DbFree(db, pDef);
drhb7f6f682006-07-08 17:06:43 +0000619 }
620}
621
dand46def72010-07-24 11:28:28 +0000622static void vdbeFreeOpArray(sqlite3 *, Op *, int);
623
drhb38ad992005-09-16 00:27:01 +0000624/*
drh66a51672008-01-03 00:01:23 +0000625** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +0000626*/
drh633e6d52008-07-28 19:34:53 +0000627static void freeP4(sqlite3 *db, int p4type, void *p4){
drh0acb7e42008-06-25 00:12:41 +0000628 if( p4 ){
dand46def72010-07-24 11:28:28 +0000629 assert( db );
drh66a51672008-01-03 00:01:23 +0000630 switch( p4type ){
631 case P4_REAL:
632 case P4_INT64:
drh66a51672008-01-03 00:01:23 +0000633 case P4_DYNAMIC:
drh2ec2fb22013-11-06 19:59:23 +0000634 case P4_INTARRAY: {
drh633e6d52008-07-28 19:34:53 +0000635 sqlite3DbFree(db, p4);
drhac1733d2005-09-17 17:58:22 +0000636 break;
637 }
drh2ec2fb22013-11-06 19:59:23 +0000638 case P4_KEYINFO: {
639 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
640 break;
641 }
drhb9755982010-07-24 16:34:37 +0000642 case P4_MPRINTF: {
drh7043db92010-07-26 12:38:12 +0000643 if( db->pnBytesFreed==0 ) sqlite3_free(p4);
drhb9755982010-07-24 16:34:37 +0000644 break;
645 }
drh66a51672008-01-03 00:01:23 +0000646 case P4_FUNCDEF: {
drh633e6d52008-07-28 19:34:53 +0000647 freeEphemeralFunction(db, (FuncDef*)p4);
drhb7f6f682006-07-08 17:06:43 +0000648 break;
649 }
drh66a51672008-01-03 00:01:23 +0000650 case P4_MEM: {
drhc176c272010-07-26 13:57:59 +0000651 if( db->pnBytesFreed==0 ){
652 sqlite3ValueFree((sqlite3_value*)p4);
653 }else{
drhf37c68e2010-07-26 14:20:06 +0000654 Mem *p = (Mem*)p4;
655 sqlite3DbFree(db, p->zMalloc);
656 sqlite3DbFree(db, p);
drhc176c272010-07-26 13:57:59 +0000657 }
drhac1733d2005-09-17 17:58:22 +0000658 break;
659 }
danielk1977595a5232009-07-24 17:58:53 +0000660 case P4_VTAB : {
dand46def72010-07-24 11:28:28 +0000661 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
danielk1977595a5232009-07-24 17:58:53 +0000662 break;
663 }
drhb38ad992005-09-16 00:27:01 +0000664 }
665 }
666}
667
dan65a7cd12009-09-01 12:16:01 +0000668/*
669** Free the space allocated for aOp and any p4 values allocated for the
670** opcodes contained within. If aOp is not NULL it is assumed to contain
671** nOp entries.
672*/
dan165921a2009-08-28 18:53:45 +0000673static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
674 if( aOp ){
675 Op *pOp;
676 for(pOp=aOp; pOp<&aOp[nOp]; pOp++){
677 freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +0000678#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +0000679 sqlite3DbFree(db, pOp->zComment);
680#endif
681 }
682 }
683 sqlite3DbFree(db, aOp);
684}
685
dan65a7cd12009-09-01 12:16:01 +0000686/*
dand19c9332010-07-26 12:05:17 +0000687** Link the SubProgram object passed as the second argument into the linked
688** list at Vdbe.pSubProgram. This list is used to delete all sub-program
689** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +0000690*/
dand19c9332010-07-26 12:05:17 +0000691void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
692 p->pNext = pVdbe->pProgram;
693 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +0000694}
695
drh9a324642003-09-06 20:12:01 +0000696/*
drh48f2d3b2011-09-16 01:34:43 +0000697** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +0000698*/
drh48f2d3b2011-09-16 01:34:43 +0000699void sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
drh7b746032009-06-26 12:15:22 +0000700 if( p->aOp ){
danielk197792d4d7a2007-05-04 12:05:56 +0000701 VdbeOp *pOp = &p->aOp[addr];
drh633e6d52008-07-28 19:34:53 +0000702 sqlite3 *db = p->db;
drh48f2d3b2011-09-16 01:34:43 +0000703 freeP4(db, pOp->p4type, pOp->p4.p);
704 memset(pOp, 0, sizeof(pOp[0]));
705 pOp->opcode = OP_Noop;
drh313619f2013-10-31 20:34:06 +0000706 if( addr==p->nOp-1 ) p->nOp--;
drhf8875402006-03-17 13:56:34 +0000707 }
708}
709
710/*
drh66a51672008-01-03 00:01:23 +0000711** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000712** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000713** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000714** few minor changes to the program.
715**
drh66a51672008-01-03 00:01:23 +0000716** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +0000717** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +0000718** A value of n==0 means copy bytes of zP4 up to and including the
719** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +0000720**
drh66a51672008-01-03 00:01:23 +0000721** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +0000722** to a string or structure that is guaranteed to exist for the lifetime of
723** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +0000724**
drh66a51672008-01-03 00:01:23 +0000725** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +0000726*/
drh66a51672008-01-03 00:01:23 +0000727void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +0000728 Op *pOp;
drh633e6d52008-07-28 19:34:53 +0000729 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +0000730 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +0000731 db = p->db;
drh91fd4d42008-01-19 20:11:25 +0000732 assert( p->magic==VDBE_MAGIC_INIT );
drh633e6d52008-07-28 19:34:53 +0000733 if( p->aOp==0 || db->mallocFailed ){
drh2ec2fb22013-11-06 19:59:23 +0000734 if( n!=P4_VTAB ){
drh633e6d52008-07-28 19:34:53 +0000735 freeP4(db, n, (void*)*(char**)&zP4);
danielk1977261919c2005-12-06 12:52:59 +0000736 }
danielk1977d5d56522005-03-16 12:15:20 +0000737 return;
738 }
drh7b746032009-06-26 12:15:22 +0000739 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +0000740 assert( addr<p->nOp );
741 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +0000742 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000743 }
744 pOp = &p->aOp[addr];
drhfc5e5462012-12-03 17:04:40 +0000745 assert( pOp->p4type==P4_NOTUSED || pOp->p4type==P4_INT32 );
drh633e6d52008-07-28 19:34:53 +0000746 freeP4(db, pOp->p4type, pOp->p4.p);
drh66a51672008-01-03 00:01:23 +0000747 pOp->p4.p = 0;
drh98757152008-01-09 23:04:12 +0000748 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +0000749 /* Note: this cast is safe, because the origin data point was an int
750 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +0000751 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +0000752 pOp->p4type = P4_INT32;
drh98757152008-01-09 23:04:12 +0000753 }else if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +0000754 pOp->p4.p = 0;
755 pOp->p4type = P4_NOTUSED;
756 }else if( n==P4_KEYINFO ){
danielk19772dca4ac2008-01-03 11:50:29 +0000757 pOp->p4.p = (void*)zP4;
drh66a51672008-01-03 00:01:23 +0000758 pOp->p4type = P4_KEYINFO;
danielk1977595a5232009-07-24 17:58:53 +0000759 }else if( n==P4_VTAB ){
760 pOp->p4.p = (void*)zP4;
761 pOp->p4type = P4_VTAB;
762 sqlite3VtabLock((VTable *)zP4);
763 assert( ((VTable *)zP4)->db==p->db );
drh9a324642003-09-06 20:12:01 +0000764 }else if( n<0 ){
danielk19772dca4ac2008-01-03 11:50:29 +0000765 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +0000766 pOp->p4type = (signed char)n;
drh9a324642003-09-06 20:12:01 +0000767 }else{
drhea678832008-12-10 19:26:22 +0000768 if( n==0 ) n = sqlite3Strlen30(zP4);
danielk19772dca4ac2008-01-03 11:50:29 +0000769 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
drh66a51672008-01-03 00:01:23 +0000770 pOp->p4type = P4_DYNAMIC;
drh9a324642003-09-06 20:12:01 +0000771 }
772}
773
drh2ec2fb22013-11-06 19:59:23 +0000774/*
775** Set the P4 on the most recently added opcode to the KeyInfo for the
776** index given.
777*/
778void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
779 Vdbe *v = pParse->pVdbe;
780 assert( v!=0 );
781 assert( pIdx!=0 );
782 sqlite3VdbeChangeP4(v, -1, (char*)sqlite3KeyInfoOfIndex(pParse, pIdx),
783 P4_KEYINFO);
784}
785
drhc7379ce2013-10-30 02:28:23 +0000786#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +0000787/*
mistachkind5578432012-08-25 10:01:29 +0000788** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +0000789** insert a No-op and add the comment to that new instruction. This
790** makes the code easier to read during debugging. None of this happens
791** in a production build.
drhad6d9462004-09-19 02:15:24 +0000792*/
drhb07028f2011-10-14 21:49:18 +0000793static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +0000794 assert( p->nOp>0 || p->aOp==0 );
drhd4e70eb2008-01-02 00:34:36 +0000795 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
danielk1977dba01372008-01-05 18:44:29 +0000796 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +0000797 assert( p->aOp );
798 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
799 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
800 }
801}
802void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
803 va_list ap;
804 if( p ){
danielk1977dba01372008-01-05 18:44:29 +0000805 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +0000806 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +0000807 va_end(ap);
808 }
drhad6d9462004-09-19 02:15:24 +0000809}
drh16ee60f2008-06-20 18:13:25 +0000810void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
811 va_list ap;
drhb07028f2011-10-14 21:49:18 +0000812 if( p ){
813 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +0000814 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +0000815 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +0000816 va_end(ap);
817 }
818}
819#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +0000820
drh9a324642003-09-06 20:12:01 +0000821/*
drh20411ea2009-05-29 19:00:12 +0000822** Return the opcode for a given address. If the address is -1, then
823** return the most recently inserted opcode.
824**
825** If a memory allocation error has occurred prior to the calling of this
826** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +0000827** is readable but not writable, though it is cast to a writable value.
828** The return of a dummy opcode allows the call to continue functioning
829** after a OOM fault without having to check to see if the return from
830** this routine is a valid pointer. But because the dummy.opcode is 0,
831** dummy will never be written to. This is verified by code inspection and
832** by running with Valgrind.
drh37b89a02009-06-19 00:33:31 +0000833**
834** About the #ifdef SQLITE_OMIT_TRACE: Normally, this routine is never called
835** unless p->nOp>0. This is because in the absense of SQLITE_OMIT_TRACE,
836** an OP_Trace instruction is always inserted by sqlite3VdbeGet() as soon as
837** a new VDBE is created. So we are free to set addr to p->nOp-1 without
838** having to double-check to make sure that the result is non-negative. But
839** if SQLITE_OMIT_TRACE is defined, the OP_Trace is omitted and we do need to
840** check the value of p->nOp-1 before continuing.
drh9a324642003-09-06 20:12:01 +0000841*/
danielk19774adee202004-05-08 08:23:19 +0000842VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +0000843 /* C89 specifies that the constant "dummy" will be initialized to all
844 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +0000845 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh9a324642003-09-06 20:12:01 +0000846 assert( p->magic==VDBE_MAGIC_INIT );
drh37b89a02009-06-19 00:33:31 +0000847 if( addr<0 ){
848#ifdef SQLITE_OMIT_TRACE
drhf83dc1e2010-06-03 12:09:52 +0000849 if( p->nOp==0 ) return (VdbeOp*)&dummy;
drh37b89a02009-06-19 00:33:31 +0000850#endif
851 addr = p->nOp - 1;
852 }
drh17435752007-08-16 04:30:38 +0000853 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +0000854 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +0000855 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +0000856 }else{
857 return &p->aOp[addr];
858 }
drh9a324642003-09-06 20:12:01 +0000859}
860
drhc7379ce2013-10-30 02:28:23 +0000861#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +0000862/*
drhf63552b2013-10-30 00:25:03 +0000863** Return an integer value for one of the parameters to the opcode pOp
864** determined by character c.
865*/
866static int translateP(char c, const Op *pOp){
867 if( c=='1' ) return pOp->p1;
868 if( c=='2' ) return pOp->p2;
869 if( c=='3' ) return pOp->p3;
870 if( c=='4' ) return pOp->p4.i;
871 return pOp->p5;
872}
873
drh81316f82013-10-29 20:40:47 +0000874/*
875** Compute a string for the "comment" field of a VDBE opcode listing
876*/
drhf63552b2013-10-30 00:25:03 +0000877static int displayComment(
878 const Op *pOp, /* The opcode to be commented */
879 const char *zP4, /* Previously obtained value for P4 */
880 char *zTemp, /* Write result here */
881 int nTemp /* Space available in zTemp[] */
882){
drh81316f82013-10-29 20:40:47 +0000883 const char *zOpName;
884 const char *zSynopsis;
885 int nOpName;
886 int ii, jj;
887 zOpName = sqlite3OpcodeName(pOp->opcode);
888 nOpName = sqlite3Strlen30(zOpName);
889 if( zOpName[nOpName+1] ){
890 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +0000891 char c;
drh81316f82013-10-29 20:40:47 +0000892 zSynopsis = zOpName += nOpName + 1;
drhf63552b2013-10-30 00:25:03 +0000893 for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
894 if( c=='P' ){
895 c = zSynopsis[++ii];
896 if( c=='4' ){
897 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
898 }else if( c=='X' ){
899 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
900 seenCom = 1;
drh81316f82013-10-29 20:40:47 +0000901 }else{
drhf63552b2013-10-30 00:25:03 +0000902 int v1 = translateP(c, pOp);
903 int v2;
904 sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
905 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
906 ii += 3;
907 jj += sqlite3Strlen30(zTemp+jj);
908 v2 = translateP(zSynopsis[ii], pOp);
909 if( v2>1 ) sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
910 }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
911 ii += 4;
912 }
drh81316f82013-10-29 20:40:47 +0000913 }
914 jj += sqlite3Strlen30(zTemp+jj);
915 }else{
drhf63552b2013-10-30 00:25:03 +0000916 zTemp[jj++] = c;
drh81316f82013-10-29 20:40:47 +0000917 }
918 }
919 if( !seenCom && jj<nTemp-5 && pOp->zComment ){
920 sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
921 jj += sqlite3Strlen30(zTemp+jj);
922 }
923 if( jj<nTemp ) zTemp[jj] = 0;
924 }else if( pOp->zComment ){
925 sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
926 jj = sqlite3Strlen30(zTemp);
927 }else{
928 zTemp[0] = 0;
929 jj = 0;
930 }
931 return jj;
932}
933#endif /* SQLITE_DEBUG */
934
935
drhb7f91642004-10-31 02:22:47 +0000936#if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) \
937 || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +0000938/*
drh66a51672008-01-03 00:01:23 +0000939** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +0000940** Use zTemp for any required temporary buffer space.
941*/
drh66a51672008-01-03 00:01:23 +0000942static char *displayP4(Op *pOp, char *zTemp, int nTemp){
943 char *zP4 = zTemp;
drhd3d39e92004-05-20 22:16:29 +0000944 assert( nTemp>=20 );
drh66a51672008-01-03 00:01:23 +0000945 switch( pOp->p4type ){
946 case P4_KEYINFO: {
drhd3d39e92004-05-20 22:16:29 +0000947 int i, j;
danielk19772dca4ac2008-01-03 11:50:29 +0000948 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
drhe1a022e2012-09-17 17:16:53 +0000949 assert( pKeyInfo->aSortOrder!=0 );
drh5b843aa2013-10-30 13:46:01 +0000950 sqlite3_snprintf(nTemp, zTemp, "k(%d", pKeyInfo->nField);
drhea678832008-12-10 19:26:22 +0000951 i = sqlite3Strlen30(zTemp);
drhd3d39e92004-05-20 22:16:29 +0000952 for(j=0; j<pKeyInfo->nField; j++){
953 CollSeq *pColl = pKeyInfo->aColl[j];
drh261d8a52012-12-08 21:36:26 +0000954 const char *zColl = pColl ? pColl->zName : "nil";
955 int n = sqlite3Strlen30(zColl);
drh5b843aa2013-10-30 13:46:01 +0000956 if( n==6 && memcmp(zColl,"BINARY",6)==0 ){
957 zColl = "B";
958 n = 1;
959 }
drh261d8a52012-12-08 21:36:26 +0000960 if( i+n>nTemp-6 ){
961 memcpy(&zTemp[i],",...",4);
962 break;
drhd3d39e92004-05-20 22:16:29 +0000963 }
drh261d8a52012-12-08 21:36:26 +0000964 zTemp[i++] = ',';
965 if( pKeyInfo->aSortOrder[j] ){
966 zTemp[i++] = '-';
967 }
968 memcpy(&zTemp[i], zColl, n+1);
969 i += n;
drhd3d39e92004-05-20 22:16:29 +0000970 }
971 zTemp[i++] = ')';
972 zTemp[i] = 0;
973 assert( i<nTemp );
drhd3d39e92004-05-20 22:16:29 +0000974 break;
975 }
drh66a51672008-01-03 00:01:23 +0000976 case P4_COLLSEQ: {
danielk19772dca4ac2008-01-03 11:50:29 +0000977 CollSeq *pColl = pOp->p4.pColl;
drh5e6790c2013-11-12 20:18:14 +0000978 sqlite3_snprintf(nTemp, zTemp, "(%.20s)", pColl->zName);
drhd3d39e92004-05-20 22:16:29 +0000979 break;
980 }
drh66a51672008-01-03 00:01:23 +0000981 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +0000982 FuncDef *pDef = pOp->p4.pFunc;
drha967e882006-06-13 01:04:52 +0000983 sqlite3_snprintf(nTemp, zTemp, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +0000984 break;
985 }
drh66a51672008-01-03 00:01:23 +0000986 case P4_INT64: {
danielk19772dca4ac2008-01-03 11:50:29 +0000987 sqlite3_snprintf(nTemp, zTemp, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +0000988 break;
989 }
drh66a51672008-01-03 00:01:23 +0000990 case P4_INT32: {
991 sqlite3_snprintf(nTemp, zTemp, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +0000992 break;
993 }
drh66a51672008-01-03 00:01:23 +0000994 case P4_REAL: {
danielk19772dca4ac2008-01-03 11:50:29 +0000995 sqlite3_snprintf(nTemp, zTemp, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +0000996 break;
997 }
drh66a51672008-01-03 00:01:23 +0000998 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +0000999 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001000 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001001 zP4 = pMem->z;
drhd4e70eb2008-01-02 00:34:36 +00001002 }else if( pMem->flags & MEM_Int ){
1003 sqlite3_snprintf(nTemp, zTemp, "%lld", pMem->u.i);
1004 }else if( pMem->flags & MEM_Real ){
1005 sqlite3_snprintf(nTemp, zTemp, "%.16g", pMem->r);
drhb8475df2011-12-09 16:21:19 +00001006 }else if( pMem->flags & MEM_Null ){
1007 sqlite3_snprintf(nTemp, zTemp, "NULL");
drh56016892009-08-25 14:24:04 +00001008 }else{
1009 assert( pMem->flags & MEM_Blob );
1010 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001011 }
drh598f1342007-10-23 15:39:45 +00001012 break;
1013 }
drha967e882006-06-13 01:04:52 +00001014#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001015 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001016 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh19146192006-06-26 19:10:32 +00001017 sqlite3_snprintf(nTemp, zTemp, "vtab:%p:%p", pVtab, pVtab->pModule);
drha967e882006-06-13 01:04:52 +00001018 break;
1019 }
1020#endif
drh0acb7e42008-06-25 00:12:41 +00001021 case P4_INTARRAY: {
1022 sqlite3_snprintf(nTemp, zTemp, "intarray");
1023 break;
1024 }
dan165921a2009-08-28 18:53:45 +00001025 case P4_SUBPROGRAM: {
1026 sqlite3_snprintf(nTemp, zTemp, "program");
1027 break;
1028 }
drh4a6f3aa2011-08-28 00:19:26 +00001029 case P4_ADVANCE: {
1030 zTemp[0] = 0;
1031 break;
1032 }
drhd3d39e92004-05-20 22:16:29 +00001033 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001034 zP4 = pOp->p4.z;
drh949f9cd2008-01-12 21:35:57 +00001035 if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +00001036 zP4 = zTemp;
drhd4e70eb2008-01-02 00:34:36 +00001037 zTemp[0] = 0;
drhd3d39e92004-05-20 22:16:29 +00001038 }
1039 }
1040 }
drh66a51672008-01-03 00:01:23 +00001041 assert( zP4!=0 );
drh66a51672008-01-03 00:01:23 +00001042 return zP4;
drhd3d39e92004-05-20 22:16:29 +00001043}
drhb7f91642004-10-31 02:22:47 +00001044#endif
drhd3d39e92004-05-20 22:16:29 +00001045
drh900b31e2007-08-28 02:27:51 +00001046/*
drhd0679ed2007-08-28 22:24:34 +00001047** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001048**
drhbdaec522011-04-04 00:14:43 +00001049** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001050** attached databases that will be use. A mask of these databases
1051** is maintained in p->btreeMask. The p->lockMask value is the subset of
1052** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001053*/
drhfb982642007-08-30 01:19:59 +00001054void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001055 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001056 assert( i<(int)sizeof(p->btreeMask)*8 );
drhbdaec522011-04-04 00:14:43 +00001057 p->btreeMask |= ((yDbMask)1)<<i;
drhdc5b0472011-04-06 22:05:53 +00001058 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
1059 p->lockMask |= ((yDbMask)1)<<i;
1060 }
drh900b31e2007-08-28 02:27:51 +00001061}
1062
drhe54e0512011-04-05 17:31:56 +00001063#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001064/*
1065** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1066** this routine obtains the mutex associated with each BtShared structure
1067** that may be accessed by the VM passed as an argument. In doing so it also
1068** sets the BtShared.db member of each of the BtShared structures, ensuring
1069** that the correct busy-handler callback is invoked if required.
1070**
1071** If SQLite is not threadsafe but does support shared-cache mode, then
1072** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1073** of all of BtShared structures accessible via the database handle
1074** associated with the VM.
1075**
1076** If SQLite is not threadsafe and does not support shared-cache mode, this
1077** function is a no-op.
1078**
1079** The p->btreeMask field is a bitmask of all btrees that the prepared
1080** statement p will ever use. Let N be the number of bits in p->btreeMask
1081** corresponding to btrees that use shared cache. Then the runtime of
1082** this routine is N*N. But as N is rarely more than 1, this should not
1083** be a problem.
1084*/
1085void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001086 int i;
1087 yDbMask mask;
drhdc5b0472011-04-06 22:05:53 +00001088 sqlite3 *db;
1089 Db *aDb;
1090 int nDb;
1091 if( p->lockMask==0 ) return; /* The common case */
1092 db = p->db;
1093 aDb = db->aDb;
1094 nDb = db->nDb;
drhbdaec522011-04-04 00:14:43 +00001095 for(i=0, mask=1; i<nDb; i++, mask += mask){
drhdc5b0472011-04-06 22:05:53 +00001096 if( i!=1 && (mask & p->lockMask)!=0 && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001097 sqlite3BtreeEnter(aDb[i].pBt);
1098 }
1099 }
drhbdaec522011-04-04 00:14:43 +00001100}
drhe54e0512011-04-05 17:31:56 +00001101#endif
drhbdaec522011-04-04 00:14:43 +00001102
drhe54e0512011-04-05 17:31:56 +00001103#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001104/*
1105** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1106*/
1107void sqlite3VdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001108 int i;
1109 yDbMask mask;
drhdc5b0472011-04-06 22:05:53 +00001110 sqlite3 *db;
1111 Db *aDb;
1112 int nDb;
1113 if( p->lockMask==0 ) return; /* The common case */
1114 db = p->db;
1115 aDb = db->aDb;
1116 nDb = db->nDb;
drhbdaec522011-04-04 00:14:43 +00001117 for(i=0, mask=1; i<nDb; i++, mask += mask){
drhdc5b0472011-04-06 22:05:53 +00001118 if( i!=1 && (mask & p->lockMask)!=0 && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001119 sqlite3BtreeLeave(aDb[i].pBt);
1120 }
1121 }
drhbdaec522011-04-04 00:14:43 +00001122}
drhbdaec522011-04-04 00:14:43 +00001123#endif
drhd3d39e92004-05-20 22:16:29 +00001124
danielk19778b60e0f2005-01-12 09:10:39 +00001125#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00001126/*
1127** Print a single opcode. This routine is used for debugging only.
1128*/
danielk19774adee202004-05-08 08:23:19 +00001129void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
drh66a51672008-01-03 00:01:23 +00001130 char *zP4;
drhd3d39e92004-05-20 22:16:29 +00001131 char zPtr[50];
drh81316f82013-10-29 20:40:47 +00001132 char zCom[100];
drh26198bb2013-10-31 11:15:09 +00001133 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00001134 if( pOut==0 ) pOut = stdout;
drh66a51672008-01-03 00:01:23 +00001135 zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
drhc7379ce2013-10-30 02:28:23 +00001136#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh81316f82013-10-29 20:40:47 +00001137 displayComment(pOp, zP4, zCom, sizeof(zCom));
1138#else
1139 zCom[0] = 0
1140#endif
danielk197711641c12008-01-03 08:18:30 +00001141 fprintf(pOut, zFormat1, pc,
drh1db639c2008-01-17 02:36:28 +00001142 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
drh81316f82013-10-29 20:40:47 +00001143 zCom
drh1db639c2008-01-17 02:36:28 +00001144 );
drh9a324642003-09-06 20:12:01 +00001145 fflush(pOut);
1146}
1147#endif
1148
1149/*
drh76ff3a02004-09-24 22:32:30 +00001150** Release an array of N Mem elements
1151*/
drhc890fec2008-08-01 20:10:08 +00001152static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00001153 if( p && N ){
danielk1977e972e032008-09-19 18:32:26 +00001154 Mem *pEnd;
danielk1977a7a8e142008-02-13 18:25:27 +00001155 sqlite3 *db = p->db;
drh8df32842008-12-09 02:51:23 +00001156 u8 malloc_failed = db->mallocFailed;
dand46def72010-07-24 11:28:28 +00001157 if( db->pnBytesFreed ){
1158 for(pEnd=&p[N]; p<pEnd; p++){
1159 sqlite3DbFree(db, p->zMalloc);
1160 }
drhc176c272010-07-26 13:57:59 +00001161 return;
1162 }
danielk1977e972e032008-09-19 18:32:26 +00001163 for(pEnd=&p[N]; p<pEnd; p++){
1164 assert( (&p[1])==pEnd || p[0].db==p[1].db );
1165
1166 /* This block is really an inlined version of sqlite3VdbeMemRelease()
1167 ** that takes advantage of the fact that the memory cell value is
1168 ** being set to NULL after releasing any dynamic resources.
1169 **
1170 ** The justification for duplicating code is that according to
1171 ** callgrind, this causes a certain test case to hit the CPU 4.7
1172 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
1173 ** sqlite3MemRelease() were called from here. With -O2, this jumps
1174 ** to 6.6 percent. The test case is inserting 1000 rows into a table
1175 ** with no indexes using a single prepared INSERT statement, bind()
1176 ** and reset(). Inserts are grouped into a transaction.
1177 */
dan165921a2009-08-28 18:53:45 +00001178 if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
danielk1977e972e032008-09-19 18:32:26 +00001179 sqlite3VdbeMemRelease(p);
1180 }else if( p->zMalloc ){
1181 sqlite3DbFree(db, p->zMalloc);
1182 p->zMalloc = 0;
1183 }
1184
drhb8475df2011-12-09 16:21:19 +00001185 p->flags = MEM_Invalid;
drh76ff3a02004-09-24 22:32:30 +00001186 }
danielk1977a7a8e142008-02-13 18:25:27 +00001187 db->mallocFailed = malloc_failed;
drh76ff3a02004-09-24 22:32:30 +00001188 }
1189}
1190
dan65a7cd12009-09-01 12:16:01 +00001191/*
1192** Delete a VdbeFrame object and its contents. VdbeFrame objects are
1193** allocated by the OP_Program opcode in sqlite3VdbeExec().
1194*/
dan165921a2009-08-28 18:53:45 +00001195void sqlite3VdbeFrameDelete(VdbeFrame *p){
1196 int i;
1197 Mem *aMem = VdbeFrameMem(p);
1198 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
1199 for(i=0; i<p->nChildCsr; i++){
1200 sqlite3VdbeFreeCursor(p->v, apCsr[i]);
1201 }
1202 releaseMemArray(aMem, p->nChildMem);
1203 sqlite3DbFree(p->v->db, p);
1204}
1205
drhb7f91642004-10-31 02:22:47 +00001206#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00001207/*
drh9a324642003-09-06 20:12:01 +00001208** Give a listing of the program in the virtual machine.
1209**
danielk19774adee202004-05-08 08:23:19 +00001210** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00001211** running the code, it invokes the callback once for each instruction.
1212** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00001213**
1214** When p->explain==1, each instruction is listed. When
1215** p->explain==2, only OP_Explain instructions are listed and these
1216** are shown in a different format. p->explain==2 is used to implement
1217** EXPLAIN QUERY PLAN.
drh5cfa5842009-12-31 20:35:08 +00001218**
1219** When p->explain==1, first the main program is listed, then each of
1220** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00001221*/
danielk19774adee202004-05-08 08:23:19 +00001222int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00001223 Vdbe *p /* The VDBE */
1224){
drh5cfa5842009-12-31 20:35:08 +00001225 int nRow; /* Stop when row count reaches this */
dan165921a2009-08-28 18:53:45 +00001226 int nSub = 0; /* Number of sub-vdbes seen so far */
1227 SubProgram **apSub = 0; /* Array of sub-vdbes */
drh5cfa5842009-12-31 20:35:08 +00001228 Mem *pSub = 0; /* Memory cell hold array of subprogs */
1229 sqlite3 *db = p->db; /* The database connection */
1230 int i; /* Loop counter */
1231 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00001232 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh9a324642003-09-06 20:12:01 +00001233
drh9a324642003-09-06 20:12:01 +00001234 assert( p->explain );
drh5f82e3c2009-07-06 00:44:08 +00001235 assert( p->magic==VDBE_MAGIC_RUN );
danielk19776c359f02008-11-21 16:58:03 +00001236 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00001237
drh9cbf3422008-01-17 16:22:13 +00001238 /* Even though this opcode does not use dynamic strings for
1239 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00001240 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00001241 */
dan165921a2009-08-28 18:53:45 +00001242 releaseMemArray(pMem, 8);
drh9734e6e2011-10-07 18:24:25 +00001243 p->pResultSet = 0;
danielk197718f41892004-05-22 07:27:46 +00001244
danielk19776c359f02008-11-21 16:58:03 +00001245 if( p->rc==SQLITE_NOMEM ){
1246 /* This happens if a malloc() inside a call to sqlite3_column_text() or
1247 ** sqlite3_column_text16() failed. */
1248 db->mallocFailed = 1;
1249 return SQLITE_ERROR;
1250 }
1251
drh5cfa5842009-12-31 20:35:08 +00001252 /* When the number of output rows reaches nRow, that means the
1253 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
1254 ** nRow is the sum of the number of rows in the main program, plus
1255 ** the sum of the number of rows in all trigger subprograms encountered
1256 ** so far. The nRow value will increase as new trigger subprograms are
1257 ** encountered, but p->pc will eventually catch up to nRow.
1258 */
dan165921a2009-08-28 18:53:45 +00001259 nRow = p->nOp;
1260 if( p->explain==1 ){
drh5cfa5842009-12-31 20:35:08 +00001261 /* The first 8 memory cells are used for the result set. So we will
1262 ** commandeer the 9th cell to use as storage for an array of pointers
1263 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
1264 ** cells. */
1265 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00001266 pSub = &p->aMem[9];
1267 if( pSub->flags&MEM_Blob ){
drh5cfa5842009-12-31 20:35:08 +00001268 /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
1269 ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
dan165921a2009-08-28 18:53:45 +00001270 nSub = pSub->n/sizeof(Vdbe*);
1271 apSub = (SubProgram **)pSub->z;
1272 }
1273 for(i=0; i<nSub; i++){
1274 nRow += apSub[i]->nOp;
1275 }
1276 }
1277
drhecc92422005-09-10 16:46:12 +00001278 do{
1279 i = p->pc++;
dan165921a2009-08-28 18:53:45 +00001280 }while( i<nRow && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
1281 if( i>=nRow ){
drh826fb5a2004-02-14 23:59:57 +00001282 p->rc = SQLITE_OK;
1283 rc = SQLITE_DONE;
drh881feaa2006-07-26 01:39:30 +00001284 }else if( db->u1.isInterrupted ){
drhc5cdca62005-01-11 16:54:14 +00001285 p->rc = SQLITE_INTERRUPT;
drh826fb5a2004-02-14 23:59:57 +00001286 rc = SQLITE_ERROR;
drhf089aa42008-07-08 19:34:06 +00001287 sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3ErrStr(p->rc));
drh826fb5a2004-02-14 23:59:57 +00001288 }else{
drh81316f82013-10-29 20:40:47 +00001289 char *zP4;
dan165921a2009-08-28 18:53:45 +00001290 Op *pOp;
1291 if( i<p->nOp ){
drh5cfa5842009-12-31 20:35:08 +00001292 /* The output line number is small enough that we are still in the
1293 ** main program. */
dan165921a2009-08-28 18:53:45 +00001294 pOp = &p->aOp[i];
1295 }else{
drh5cfa5842009-12-31 20:35:08 +00001296 /* We are currently listing subprograms. Figure out which one and
1297 ** pick up the appropriate opcode. */
dan165921a2009-08-28 18:53:45 +00001298 int j;
1299 i -= p->nOp;
1300 for(j=0; i>=apSub[j]->nOp; j++){
1301 i -= apSub[j]->nOp;
1302 }
1303 pOp = &apSub[j]->aOp[i];
1304 }
danielk19770d78bae2008-01-03 07:09:48 +00001305 if( p->explain==1 ){
1306 pMem->flags = MEM_Int;
1307 pMem->type = SQLITE_INTEGER;
1308 pMem->u.i = i; /* Program counter */
1309 pMem++;
1310
1311 pMem->flags = MEM_Static|MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001312 pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
danielk19770d78bae2008-01-03 07:09:48 +00001313 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001314 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +00001315 pMem->type = SQLITE_TEXT;
1316 pMem->enc = SQLITE_UTF8;
1317 pMem++;
dan165921a2009-08-28 18:53:45 +00001318
drh5cfa5842009-12-31 20:35:08 +00001319 /* When an OP_Program opcode is encounter (the only opcode that has
1320 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
1321 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
1322 ** has not already been seen.
1323 */
dan165921a2009-08-28 18:53:45 +00001324 if( pOp->p4type==P4_SUBPROGRAM ){
1325 int nByte = (nSub+1)*sizeof(SubProgram*);
1326 int j;
1327 for(j=0; j<nSub; j++){
1328 if( apSub[j]==pOp->p4.pProgram ) break;
1329 }
dan2b9ee772012-03-31 09:59:44 +00001330 if( j==nSub && SQLITE_OK==sqlite3VdbeMemGrow(pSub, nByte, nSub!=0) ){
dan165921a2009-08-28 18:53:45 +00001331 apSub = (SubProgram **)pSub->z;
1332 apSub[nSub++] = pOp->p4.pProgram;
1333 pSub->flags |= MEM_Blob;
1334 pSub->n = nSub*sizeof(SubProgram*);
1335 }
1336 }
danielk19770d78bae2008-01-03 07:09:48 +00001337 }
drheb2e1762004-05-27 01:53:56 +00001338
1339 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001340 pMem->u.i = pOp->p1; /* P1 */
drh9c054832004-05-31 18:51:57 +00001341 pMem->type = SQLITE_INTEGER;
drheb2e1762004-05-27 01:53:56 +00001342 pMem++;
1343
1344 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +00001345 pMem->u.i = pOp->p2; /* P2 */
drh9c054832004-05-31 18:51:57 +00001346 pMem->type = SQLITE_INTEGER;
drheb2e1762004-05-27 01:53:56 +00001347 pMem++;
1348
dan2ce22452010-11-08 19:01:16 +00001349 pMem->flags = MEM_Int;
1350 pMem->u.i = pOp->p3; /* P3 */
1351 pMem->type = SQLITE_INTEGER;
1352 pMem++;
danielk19770d78bae2008-01-03 07:09:48 +00001353
danielk1977a7a8e142008-02-13 18:25:27 +00001354 if( sqlite3VdbeMemGrow(pMem, 32, 0) ){ /* P4 */
danielk1977357864e2009-03-25 15:43:08 +00001355 assert( p->db->mallocFailed );
1356 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001357 }
1358 pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
drh81316f82013-10-29 20:40:47 +00001359 zP4 = displayP4(pOp, pMem->z, 32);
1360 if( zP4!=pMem->z ){
1361 sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
danielk1977a7a8e142008-02-13 18:25:27 +00001362 }else{
1363 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +00001364 pMem->n = sqlite3Strlen30(pMem->z);
danielk1977a7a8e142008-02-13 18:25:27 +00001365 pMem->enc = SQLITE_UTF8;
1366 }
drh9c054832004-05-31 18:51:57 +00001367 pMem->type = SQLITE_TEXT;
danielk19770d78bae2008-01-03 07:09:48 +00001368 pMem++;
drheb2e1762004-05-27 01:53:56 +00001369
danielk19770d78bae2008-01-03 07:09:48 +00001370 if( p->explain==1 ){
drh85e5f0d2008-02-19 18:28:13 +00001371 if( sqlite3VdbeMemGrow(pMem, 4, 0) ){
danielk1977357864e2009-03-25 15:43:08 +00001372 assert( p->db->mallocFailed );
1373 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +00001374 }
1375 pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
drh85e5f0d2008-02-19 18:28:13 +00001376 pMem->n = 2;
1377 sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
danielk19770d78bae2008-01-03 07:09:48 +00001378 pMem->type = SQLITE_TEXT;
1379 pMem->enc = SQLITE_UTF8;
1380 pMem++;
1381
drhc7379ce2013-10-30 02:28:23 +00001382#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh81316f82013-10-29 20:40:47 +00001383 if( sqlite3VdbeMemGrow(pMem, 500, 0) ){
1384 assert( p->db->mallocFailed );
1385 return SQLITE_ERROR;
drh52391cb2008-02-14 23:44:13 +00001386 }
drh81316f82013-10-29 20:40:47 +00001387 pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
1388 pMem->n = displayComment(pOp, zP4, pMem->z, 500);
1389 pMem->type = SQLITE_TEXT;
1390 pMem->enc = SQLITE_UTF8;
1391#else
1392 pMem->flags = MEM_Null; /* Comment */
1393 pMem->type = SQLITE_NULL;
1394#endif
danielk19770d78bae2008-01-03 07:09:48 +00001395 }
1396
dan2ce22452010-11-08 19:01:16 +00001397 p->nResColumn = 8 - 4*(p->explain-1);
drh9734e6e2011-10-07 18:24:25 +00001398 p->pResultSet = &p->aMem[1];
drh826fb5a2004-02-14 23:59:57 +00001399 p->rc = SQLITE_OK;
1400 rc = SQLITE_ROW;
drh9a324642003-09-06 20:12:01 +00001401 }
drh826fb5a2004-02-14 23:59:57 +00001402 return rc;
drh9a324642003-09-06 20:12:01 +00001403}
drhb7f91642004-10-31 02:22:47 +00001404#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00001405
drh7c4ac0c2007-04-05 11:25:58 +00001406#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00001407/*
drh3f7d4e42004-07-24 14:35:58 +00001408** Print the SQL that was used to generate a VDBE program.
1409*/
1410void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00001411 const char *z = 0;
1412 if( p->zSql ){
1413 z = p->zSql;
1414 }else if( p->nOp>=1 ){
1415 const VdbeOp *pOp = &p->aOp[0];
1416 if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
1417 z = pOp->p4.z;
1418 while( sqlite3Isspace(*z) ) z++;
1419 }
drh3f7d4e42004-07-24 14:35:58 +00001420 }
drh84e55a82013-11-13 17:58:23 +00001421 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00001422}
drh7c4ac0c2007-04-05 11:25:58 +00001423#endif
drh3f7d4e42004-07-24 14:35:58 +00001424
drh602c2372007-03-01 00:29:13 +00001425#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
1426/*
1427** Print an IOTRACE message showing SQL content.
1428*/
1429void sqlite3VdbeIOTraceSql(Vdbe *p){
1430 int nOp = p->nOp;
1431 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00001432 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00001433 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00001434 pOp = &p->aOp[0];
1435 if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00001436 int i, j;
drh00a18e42007-08-13 11:10:34 +00001437 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00001438 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00001439 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00001440 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00001441 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00001442 if( z[i-1]!=' ' ){
1443 z[j++] = ' ';
1444 }
1445 }else{
1446 z[j++] = z[i];
1447 }
1448 }
1449 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00001450 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00001451 }
1452}
1453#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
1454
drhb2771ce2009-02-20 01:28:59 +00001455/*
drh4800b2e2009-12-08 15:35:22 +00001456** Allocate space from a fixed size buffer and return a pointer to
1457** that space. If insufficient space is available, return NULL.
1458**
1459** The pBuf parameter is the initial value of a pointer which will
1460** receive the new memory. pBuf is normally NULL. If pBuf is not
1461** NULL, it means that memory space has already been allocated and that
1462** this routine should not allocate any new memory. When pBuf is not
1463** NULL simply return pBuf. Only allocate new memory space when pBuf
1464** is NULL.
drhb2771ce2009-02-20 01:28:59 +00001465**
1466** nByte is the number of bytes of space needed.
1467**
drh19875c82009-12-08 19:58:19 +00001468** *ppFrom points to available space and pEnd points to the end of the
1469** available space. When space is allocated, *ppFrom is advanced past
1470** the end of the allocated space.
drhb2771ce2009-02-20 01:28:59 +00001471**
1472** *pnByte is a counter of the number of bytes of space that have failed
1473** to allocate. If there is insufficient space in *ppFrom to satisfy the
danielk1977d336e222009-02-20 10:58:41 +00001474** request, then increment *pnByte by the amount of the request.
drhb2771ce2009-02-20 01:28:59 +00001475*/
drh4800b2e2009-12-08 15:35:22 +00001476static void *allocSpace(
1477 void *pBuf, /* Where return pointer will be stored */
drhb2771ce2009-02-20 01:28:59 +00001478 int nByte, /* Number of bytes to allocate */
1479 u8 **ppFrom, /* IN/OUT: Allocate from *ppFrom */
danielk1977d336e222009-02-20 10:58:41 +00001480 u8 *pEnd, /* Pointer to 1 byte past the end of *ppFrom buffer */
drhb2771ce2009-02-20 01:28:59 +00001481 int *pnByte /* If allocation cannot be made, increment *pnByte */
1482){
drhea598cb2009-04-05 12:22:08 +00001483 assert( EIGHT_BYTE_ALIGNMENT(*ppFrom) );
drh4800b2e2009-12-08 15:35:22 +00001484 if( pBuf ) return pBuf;
1485 nByte = ROUND8(nByte);
1486 if( &(*ppFrom)[nByte] <= pEnd ){
1487 pBuf = (void*)*ppFrom;
1488 *ppFrom += nByte;
1489 }else{
1490 *pnByte += nByte;
drhb2771ce2009-02-20 01:28:59 +00001491 }
drh4800b2e2009-12-08 15:35:22 +00001492 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00001493}
drh602c2372007-03-01 00:29:13 +00001494
drh3f7d4e42004-07-24 14:35:58 +00001495/*
drh124c0b42011-06-01 18:15:55 +00001496** Rewind the VDBE back to the beginning in preparation for
1497** running it.
drh9a324642003-09-06 20:12:01 +00001498*/
drh124c0b42011-06-01 18:15:55 +00001499void sqlite3VdbeRewind(Vdbe *p){
1500#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
1501 int i;
1502#endif
drh9a324642003-09-06 20:12:01 +00001503 assert( p!=0 );
drh9a324642003-09-06 20:12:01 +00001504 assert( p->magic==VDBE_MAGIC_INIT );
1505
drhc16a03b2004-09-15 13:38:10 +00001506 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00001507 */
drhc16a03b2004-09-15 13:38:10 +00001508 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00001509
danielk197700e13612008-11-17 19:18:54 +00001510 /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
danielk1977634f2982005-03-28 08:44:07 +00001511 p->magic = VDBE_MAGIC_RUN;
1512
drh124c0b42011-06-01 18:15:55 +00001513#ifdef SQLITE_DEBUG
1514 for(i=1; i<p->nMem; i++){
1515 assert( p->aMem[i].db==p->db );
1516 }
1517#endif
1518 p->pc = -1;
1519 p->rc = SQLITE_OK;
1520 p->errorAction = OE_Abort;
1521 p->magic = VDBE_MAGIC_RUN;
1522 p->nChange = 0;
1523 p->cacheCtr = 1;
1524 p->minWriteFileFormat = 255;
1525 p->iStatement = 0;
1526 p->nFkConstraint = 0;
1527#ifdef VDBE_PROFILE
1528 for(i=0; i<p->nOp; i++){
1529 p->aOp[i].cnt = 0;
1530 p->aOp[i].cycles = 0;
1531 }
1532#endif
1533}
1534
1535/*
1536** Prepare a virtual machine for execution for the first time after
1537** creating the virtual machine. This involves things such
1538** as allocating stack space and initializing the program counter.
1539** After the VDBE has be prepped, it can be executed by one or more
1540** calls to sqlite3VdbeExec().
1541**
1542** This function may be called exact once on a each virtual machine.
1543** After this routine is called the VM has been "packaged" and is ready
1544** to run. After this routine is called, futher calls to
1545** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
1546** the Vdbe from the Parse object that helped generate it so that the
1547** the Vdbe becomes an independent entity and the Parse object can be
1548** destroyed.
1549**
1550** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
1551** to its initial state after it has been run.
1552*/
1553void sqlite3VdbeMakeReady(
1554 Vdbe *p, /* The VDBE */
1555 Parse *pParse /* Parsing context */
1556){
1557 sqlite3 *db; /* The database connection */
1558 int nVar; /* Number of parameters */
1559 int nMem; /* Number of VM memory registers */
1560 int nCursor; /* Number of cursors required */
1561 int nArg; /* Number of arguments in subprograms */
dan1d8cb212011-12-09 13:24:16 +00001562 int nOnce; /* Number of OP_Once instructions */
drh124c0b42011-06-01 18:15:55 +00001563 int n; /* Loop counter */
1564 u8 *zCsr; /* Memory available for allocation */
1565 u8 *zEnd; /* First byte past allocated memory */
1566 int nByte; /* How much extra memory is needed */
1567
1568 assert( p!=0 );
1569 assert( p->nOp>0 );
1570 assert( pParse!=0 );
1571 assert( p->magic==VDBE_MAGIC_INIT );
1572 db = p->db;
1573 assert( db->mallocFailed==0 );
1574 nVar = pParse->nVar;
1575 nMem = pParse->nMem;
1576 nCursor = pParse->nTab;
1577 nArg = pParse->nMaxArg;
dan1d8cb212011-12-09 13:24:16 +00001578 nOnce = pParse->nOnce;
drh20e226d2012-01-01 13:58:53 +00001579 if( nOnce==0 ) nOnce = 1; /* Ensure at least one byte in p->aOnceFlag[] */
drh124c0b42011-06-01 18:15:55 +00001580
danielk1977cd3e8f72008-03-25 09:47:35 +00001581 /* For each cursor required, also allocate a memory cell. Memory
1582 ** cells (nMem+1-nCursor)..nMem, inclusive, will never be used by
1583 ** the vdbe program. Instead they are used to allocate space for
drhdfe88ec2008-11-03 20:55:06 +00001584 ** VdbeCursor/BtCursor structures. The blob of memory associated with
danielk1977cd3e8f72008-03-25 09:47:35 +00001585 ** cursor 0 is stored in memory cell nMem. Memory cell (nMem-1)
1586 ** stores the blob of memory associated with cursor 1, etc.
1587 **
1588 ** See also: allocateCursor().
1589 */
1590 nMem += nCursor;
1591
danielk19776ab3a2e2009-02-19 14:39:25 +00001592 /* Allocate space for memory registers, SQL variables, VDBE cursors and
drh124c0b42011-06-01 18:15:55 +00001593 ** an array to marshal SQL function arguments in.
drh9a324642003-09-06 20:12:01 +00001594 */
drh124c0b42011-06-01 18:15:55 +00001595 zCsr = (u8*)&p->aOp[p->nOp]; /* Memory avaliable for allocation */
1596 zEnd = (u8*)&p->aOp[p->nOpAlloc]; /* First byte past end of zCsr[] */
drh19875c82009-12-08 19:58:19 +00001597
drh124c0b42011-06-01 18:15:55 +00001598 resolveP2Values(p, &nArg);
1599 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
1600 if( pParse->explain && nMem<10 ){
1601 nMem = 10;
1602 }
1603 memset(zCsr, 0, zEnd-zCsr);
1604 zCsr += (zCsr - (u8*)0)&7;
1605 assert( EIGHT_BYTE_ALIGNMENT(zCsr) );
drhaab910c2011-06-27 00:01:22 +00001606 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00001607
1608 /* Memory for registers, parameters, cursor, etc, is allocated in two
1609 ** passes. On the first pass, we try to reuse unused space at the
1610 ** end of the opcode array. If we are unable to satisfy all memory
1611 ** requirements by reusing the opcode array tail, then the second
1612 ** pass will fill in the rest using a fresh allocation.
1613 **
1614 ** This two-pass approach that reuses as much memory as possible from
1615 ** the leftover space at the end of the opcode array can significantly
1616 ** reduce the amount of memory held by a prepared statement.
1617 */
1618 do {
1619 nByte = 0;
1620 p->aMem = allocSpace(p->aMem, nMem*sizeof(Mem), &zCsr, zEnd, &nByte);
1621 p->aVar = allocSpace(p->aVar, nVar*sizeof(Mem), &zCsr, zEnd, &nByte);
1622 p->apArg = allocSpace(p->apArg, nArg*sizeof(Mem*), &zCsr, zEnd, &nByte);
1623 p->azVar = allocSpace(p->azVar, nVar*sizeof(char*), &zCsr, zEnd, &nByte);
1624 p->apCsr = allocSpace(p->apCsr, nCursor*sizeof(VdbeCursor*),
1625 &zCsr, zEnd, &nByte);
drhb8475df2011-12-09 16:21:19 +00001626 p->aOnceFlag = allocSpace(p->aOnceFlag, nOnce, &zCsr, zEnd, &nByte);
drh124c0b42011-06-01 18:15:55 +00001627 if( nByte ){
1628 p->pFree = sqlite3DbMallocZero(db, nByte);
drh0f7eb612006-08-08 13:51:43 +00001629 }
drh124c0b42011-06-01 18:15:55 +00001630 zCsr = p->pFree;
1631 zEnd = &zCsr[nByte];
1632 }while( nByte && !db->mallocFailed );
drhb2771ce2009-02-20 01:28:59 +00001633
drhd2a56232013-01-28 19:00:20 +00001634 p->nCursor = nCursor;
dan1d8cb212011-12-09 13:24:16 +00001635 p->nOnceFlag = nOnce;
drh124c0b42011-06-01 18:15:55 +00001636 if( p->aVar ){
1637 p->nVar = (ynVar)nVar;
1638 for(n=0; n<nVar; n++){
1639 p->aVar[n].flags = MEM_Null;
1640 p->aVar[n].db = db;
danielk197754db47e2004-05-19 10:36:43 +00001641 }
drh82a48512003-09-06 22:45:20 +00001642 }
drh124c0b42011-06-01 18:15:55 +00001643 if( p->azVar ){
1644 p->nzVar = pParse->nzVar;
1645 memcpy(p->azVar, pParse->azVar, p->nzVar*sizeof(p->azVar[0]));
1646 memset(pParse->azVar, 0, pParse->nzVar*sizeof(pParse->azVar[0]));
danielk1977b3bce662005-01-29 08:32:43 +00001647 }
drh124c0b42011-06-01 18:15:55 +00001648 if( p->aMem ){
1649 p->aMem--; /* aMem[] goes from 1..nMem */
1650 p->nMem = nMem; /* not from 0..nMem-1 */
1651 for(n=1; n<=nMem; n++){
drhb8475df2011-12-09 16:21:19 +00001652 p->aMem[n].flags = MEM_Invalid;
drh124c0b42011-06-01 18:15:55 +00001653 p->aMem[n].db = db;
drhcf64d8b2003-12-31 17:57:10 +00001654 }
drh9a324642003-09-06 20:12:01 +00001655 }
drh124c0b42011-06-01 18:15:55 +00001656 p->explain = pParse->explain;
1657 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00001658}
1659
drh9a324642003-09-06 20:12:01 +00001660/*
danielk1977cd3e8f72008-03-25 09:47:35 +00001661** Close a VDBE cursor and release all the resources that cursor
1662** happens to hold.
drh9a324642003-09-06 20:12:01 +00001663*/
drhdfe88ec2008-11-03 20:55:06 +00001664void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh4774b132004-06-12 20:12:51 +00001665 if( pCx==0 ){
1666 return;
1667 }
dana20fde62011-07-12 14:28:05 +00001668 sqlite3VdbeSorterClose(p->db, pCx);
drh9a324642003-09-06 20:12:01 +00001669 if( pCx->pBt ){
danielk19774adee202004-05-08 08:23:19 +00001670 sqlite3BtreeClose(pCx->pBt);
drh34004ce2008-07-11 16:15:17 +00001671 /* The pCx->pCursor will be close automatically, if it exists, by
1672 ** the call above. */
1673 }else if( pCx->pCursor ){
1674 sqlite3BtreeCloseCursor(pCx->pCursor);
drh9a324642003-09-06 20:12:01 +00001675 }
drh9eff6162006-06-12 21:59:13 +00001676#ifndef SQLITE_OMIT_VIRTUALTABLE
1677 if( pCx->pVtabCursor ){
1678 sqlite3_vtab_cursor *pVtabCursor = pCx->pVtabCursor;
drh5cc10232013-11-21 01:04:02 +00001679 const sqlite3_module *pModule = pVtabCursor->pVtab->pModule;
danielk1977be718892006-06-23 08:05:19 +00001680 p->inVtabMethod = 1;
drh9eff6162006-06-12 21:59:13 +00001681 pModule->xClose(pVtabCursor);
danielk1977be718892006-06-23 08:05:19 +00001682 p->inVtabMethod = 0;
drh9eff6162006-06-12 21:59:13 +00001683 }
1684#endif
drh9a324642003-09-06 20:12:01 +00001685}
1686
dan65a7cd12009-09-01 12:16:01 +00001687/*
1688** Copy the values stored in the VdbeFrame structure to its Vdbe. This
1689** is used, for example, when a trigger sub-program is halted to restore
1690** control to the main program.
1691*/
dan165921a2009-08-28 18:53:45 +00001692int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
1693 Vdbe *v = pFrame->v;
dan1d8cb212011-12-09 13:24:16 +00001694 v->aOnceFlag = pFrame->aOnceFlag;
1695 v->nOnceFlag = pFrame->nOnceFlag;
dan165921a2009-08-28 18:53:45 +00001696 v->aOp = pFrame->aOp;
1697 v->nOp = pFrame->nOp;
1698 v->aMem = pFrame->aMem;
1699 v->nMem = pFrame->nMem;
1700 v->apCsr = pFrame->apCsr;
1701 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00001702 v->db->lastRowid = pFrame->lastRowid;
1703 v->nChange = pFrame->nChange;
dan165921a2009-08-28 18:53:45 +00001704 return pFrame->pc;
1705}
1706
drh9a324642003-09-06 20:12:01 +00001707/*
drh5f82e3c2009-07-06 00:44:08 +00001708** Close all cursors.
dan165921a2009-08-28 18:53:45 +00001709**
1710** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
1711** cell array. This is necessary as the memory cell array may contain
1712** pointers to VdbeFrame objects, which may in turn contain pointers to
1713** open cursors.
drh9a324642003-09-06 20:12:01 +00001714*/
drh5f82e3c2009-07-06 00:44:08 +00001715static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00001716 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00001717 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00001718 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
1719 sqlite3VdbeFrameRestore(pFrame);
1720 }
1721 p->pFrame = 0;
1722 p->nFrame = 0;
1723
dan523a0872009-08-31 05:23:32 +00001724 if( p->apCsr ){
1725 int i;
1726 for(i=0; i<p->nCursor; i++){
1727 VdbeCursor *pC = p->apCsr[i];
1728 if( pC ){
1729 sqlite3VdbeFreeCursor(p, pC);
1730 p->apCsr[i] = 0;
1731 }
danielk1977be718892006-06-23 08:05:19 +00001732 }
drh9a324642003-09-06 20:12:01 +00001733 }
dan523a0872009-08-31 05:23:32 +00001734 if( p->aMem ){
1735 releaseMemArray(&p->aMem[1], p->nMem);
1736 }
dan27106572010-12-01 08:04:47 +00001737 while( p->pDelFrame ){
1738 VdbeFrame *pDel = p->pDelFrame;
1739 p->pDelFrame = pDel->pParent;
1740 sqlite3VdbeFrameDelete(pDel);
1741 }
dan0c547792013-07-18 17:12:08 +00001742
1743 /* Delete any auxdata allocations made by the VM */
1744 sqlite3VdbeDeleteAuxData(p, -1, 0);
1745 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00001746}
1747
1748/*
drh9a324642003-09-06 20:12:01 +00001749** Clean up the VM after execution.
1750**
1751** This routine will automatically close any cursors, lists, and/or
1752** sorters that were left open. It also deletes the values of
drh5a12e682004-05-19 11:24:25 +00001753** variables in the aVar[] array.
drh9a324642003-09-06 20:12:01 +00001754*/
drhc890fec2008-08-01 20:10:08 +00001755static void Cleanup(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00001756 sqlite3 *db = p->db;
dan165921a2009-08-28 18:53:45 +00001757
1758#ifdef SQLITE_DEBUG
1759 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
1760 ** Vdbe.aMem[] arrays have already been cleaned up. */
1761 int i;
drhb8475df2011-12-09 16:21:19 +00001762 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
1763 if( p->aMem ){
1764 for(i=1; i<=p->nMem; i++) assert( p->aMem[i].flags==MEM_Invalid );
1765 }
dan165921a2009-08-28 18:53:45 +00001766#endif
1767
drh633e6d52008-07-28 19:34:53 +00001768 sqlite3DbFree(db, p->zErrMsg);
drh9a324642003-09-06 20:12:01 +00001769 p->zErrMsg = 0;
drhd4e70eb2008-01-02 00:34:36 +00001770 p->pResultSet = 0;
drh9a324642003-09-06 20:12:01 +00001771}
1772
1773/*
danielk197722322fd2004-05-25 23:35:17 +00001774** Set the number of result columns that will be returned by this SQL
1775** statement. This is now set at compile time, rather than during
1776** execution of the vdbe program so that sqlite3_column_count() can
1777** be called on an SQL statement before sqlite3_step().
1778*/
1779void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00001780 Mem *pColName;
1781 int n;
drh633e6d52008-07-28 19:34:53 +00001782 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00001783
drhc890fec2008-08-01 20:10:08 +00001784 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00001785 sqlite3DbFree(db, p->aColName);
danielk1977955de522006-02-10 02:27:42 +00001786 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00001787 p->nResColumn = (u16)nResColumn;
drh633e6d52008-07-28 19:34:53 +00001788 p->aColName = pColName = (Mem*)sqlite3DbMallocZero(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00001789 if( p->aColName==0 ) return;
1790 while( n-- > 0 ){
drh4a50aac2007-08-23 02:47:53 +00001791 pColName->flags = MEM_Null;
drh153c62c2007-08-24 03:51:33 +00001792 pColName->db = p->db;
drh4a50aac2007-08-23 02:47:53 +00001793 pColName++;
drh76ff3a02004-09-24 22:32:30 +00001794 }
danielk197722322fd2004-05-25 23:35:17 +00001795}
1796
1797/*
danielk19773cf86062004-05-26 10:11:05 +00001798** Set the name of the idx'th column to be returned by the SQL statement.
1799** zName must be a pointer to a nul terminated string.
1800**
1801** This call must be made after a call to sqlite3VdbeSetNumCols().
1802**
danielk197710fb7492008-10-31 10:53:22 +00001803** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
1804** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
1805** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00001806*/
danielk197710fb7492008-10-31 10:53:22 +00001807int sqlite3VdbeSetColName(
1808 Vdbe *p, /* Vdbe being configured */
1809 int idx, /* Index of column zName applies to */
1810 int var, /* One of the COLNAME_* constants */
1811 const char *zName, /* Pointer to buffer containing name */
1812 void (*xDel)(void*) /* Memory management strategy for zName */
1813){
danielk19773cf86062004-05-26 10:11:05 +00001814 int rc;
1815 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00001816 assert( idx<p->nResColumn );
1817 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00001818 if( p->db->mallocFailed ){
1819 assert( !zName || xDel!=SQLITE_DYNAMIC );
1820 return SQLITE_NOMEM;
1821 }
drh76ff3a02004-09-24 22:32:30 +00001822 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00001823 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00001824 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00001825 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00001826 return rc;
1827}
1828
danielk197713adf8a2004-06-03 16:08:41 +00001829/*
1830** A read or write transaction may or may not be active on database handle
1831** db. If a transaction is active, commit it. If there is a
1832** write-transaction spanning more than one database file, this routine
1833** takes care of the master journal trickery.
1834*/
danielk19773e3a84d2008-08-01 17:37:40 +00001835static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00001836 int i;
1837 int nTrans = 0; /* Number of databases with an active write-transaction */
1838 int rc = SQLITE_OK;
1839 int needXcommit = 0;
1840
shane36840fd2009-06-26 16:32:13 +00001841#ifdef SQLITE_OMIT_VIRTUALTABLE
1842 /* With this option, sqlite3VtabSync() is defined to be simply
1843 ** SQLITE_OK so p is not used.
1844 */
1845 UNUSED_PARAMETER(p);
1846#endif
1847
danielk19775bd270b2006-07-25 15:14:52 +00001848 /* Before doing anything else, call the xSync() callback for any
1849 ** virtual module tables written in this transaction. This has to
1850 ** be done before determining whether a master journal file is
1851 ** required, as an xSync() callback may add an attached database
1852 ** to the transaction.
1853 */
dan016f7812013-08-21 17:35:48 +00001854 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00001855
1856 /* This loop determines (a) if the commit hook should be invoked and
1857 ** (b) how many database files have open write transactions, not
1858 ** including the temp database. (b) is important because if more than
1859 ** one database file has an open write transaction, a master journal
1860 ** file is required for an atomic commit.
1861 */
drhabfb62f2010-07-30 11:20:35 +00001862 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001863 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00001864 if( sqlite3BtreeIsInTrans(pBt) ){
danielk197713adf8a2004-06-03 16:08:41 +00001865 needXcommit = 1;
1866 if( i!=1 ) nTrans++;
dan6b9bb592012-10-05 19:43:02 +00001867 sqlite3BtreeEnter(pBt);
drhabfb62f2010-07-30 11:20:35 +00001868 rc = sqlite3PagerExclusiveLock(sqlite3BtreePager(pBt));
dan6b9bb592012-10-05 19:43:02 +00001869 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00001870 }
1871 }
drhabfb62f2010-07-30 11:20:35 +00001872 if( rc!=SQLITE_OK ){
1873 return rc;
1874 }
danielk197713adf8a2004-06-03 16:08:41 +00001875
1876 /* If there are any write-transactions at all, invoke the commit hook */
1877 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00001878 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00001879 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00001880 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00001881 }
1882 }
1883
danielk197740b38dc2004-06-26 08:38:24 +00001884 /* The simple case - no more than one database file (not counting the
1885 ** TEMP database) has a transaction active. There is no need for the
drh2ac3ee92004-06-07 16:27:46 +00001886 ** master-journal.
drhc9e06862004-06-09 20:03:08 +00001887 **
danielk197740b38dc2004-06-26 08:38:24 +00001888 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00001889 ** string, it means the main database is :memory: or a temp file. In
1890 ** that case we do not support atomic multi-file commits, so use the
1891 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00001892 */
drhea678832008-12-10 19:26:22 +00001893 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
1894 || nTrans<=1
1895 ){
danielk197704103022009-02-03 16:51:24 +00001896 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001897 Btree *pBt = db->aDb[i].pBt;
1898 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00001899 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00001900 }
1901 }
1902
drh80e35f42007-03-30 14:06:34 +00001903 /* Do the commit only if all databases successfully complete phase 1.
1904 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
1905 ** IO error while deleting or truncating a journal file. It is unlikely,
1906 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00001907 */
1908 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
1909 Btree *pBt = db->aDb[i].pBt;
1910 if( pBt ){
dan60939d02011-03-29 15:40:55 +00001911 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001912 }
danielk1977979f38e2007-03-27 16:19:51 +00001913 }
1914 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00001915 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00001916 }
1917 }
1918
1919 /* The complex case - There is a multi-file write-transaction active.
1920 ** This requires a master journal file to ensure the transaction is
1921 ** committed atomicly.
1922 */
danielk197744ee5bf2005-05-27 09:41:12 +00001923#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00001924 else{
danielk1977b4b47412007-08-17 15:53:36 +00001925 sqlite3_vfs *pVfs = db->pVfs;
drh2c8997b2005-08-27 16:36:48 +00001926 int needSync = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001927 char *zMaster = 0; /* File-name for the master journal */
1928 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
danielk1977b4b47412007-08-17 15:53:36 +00001929 sqlite3_file *pMaster = 0;
danielk197762079062007-08-15 17:08:46 +00001930 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00001931 int res;
drhf5808602011-12-16 00:33:04 +00001932 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00001933 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00001934
1935 /* Select a master journal file name */
drh5c531a42011-12-16 01:21:31 +00001936 nMainFile = sqlite3Strlen30(zMainFile);
drh52bcde02012-01-03 14:50:45 +00001937 zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
drh5c531a42011-12-16 01:21:31 +00001938 if( zMaster==0 ) return SQLITE_NOMEM;
danielk197713adf8a2004-06-03 16:08:41 +00001939 do {
drhdc5ea5c2008-12-10 17:19:59 +00001940 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00001941 if( retryCount ){
1942 if( retryCount>100 ){
1943 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
1944 sqlite3OsDelete(pVfs, zMaster, 0);
1945 break;
1946 }else if( retryCount==1 ){
1947 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
1948 }
danielk197713adf8a2004-06-03 16:08:41 +00001949 }
drh84968c02011-12-16 15:11:39 +00001950 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00001951 sqlite3_randomness(sizeof(iRandom), &iRandom);
drh5c531a42011-12-16 01:21:31 +00001952 sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00001953 (iRandom>>8)&0xffffff, iRandom&0xff);
drhf5808602011-12-16 00:33:04 +00001954 /* The antipenultimate character of the master journal name must
1955 ** be "9" to avoid name collisions when using 8+3 filenames. */
drh5c531a42011-12-16 01:21:31 +00001956 assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
drh81cc5162011-05-17 20:36:21 +00001957 sqlite3FileSuffix3(zMainFile, zMaster);
danielk1977861f7452008-06-05 11:39:11 +00001958 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
1959 }while( rc==SQLITE_OK && res );
1960 if( rc==SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001961 /* Open the master journal. */
1962 rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
1963 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
1964 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
1965 );
1966 }
danielk197713adf8a2004-06-03 16:08:41 +00001967 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00001968 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001969 return rc;
1970 }
1971
1972 /* Write the name of each database file in the transaction into the new
1973 ** master journal file. If an error occurs at this point close
1974 ** and delete the master journal file. All the individual journal files
1975 ** still have 'null' as the master journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00001976 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00001977 */
danielk19771e536952007-08-16 10:09:01 +00001978 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001979 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00001980 if( sqlite3BtreeIsInTrans(pBt) ){
danielk19775865e3d2004-06-14 06:03:57 +00001981 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00001982 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00001983 continue; /* Ignore TEMP and :memory: databases */
1984 }
drh8c96a6e2010-08-31 01:09:15 +00001985 assert( zFile[0]!=0 );
drh2c8997b2005-08-27 16:36:48 +00001986 if( !needSync && !sqlite3BtreeSyncDisabled(pBt) ){
1987 needSync = 1;
1988 }
drhea678832008-12-10 19:26:22 +00001989 rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
1990 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00001991 if( rc!=SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001992 sqlite3OsCloseFree(pMaster);
1993 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00001994 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001995 return rc;
1996 }
1997 }
1998 }
1999
danielk19779663b8f2007-08-24 11:52:28 +00002000 /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
2001 ** flag is set this is not required.
2002 */
danielk1977bea2a942009-01-20 17:06:27 +00002003 if( needSync
2004 && 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
2005 && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
2006 ){
danielk1977fee2d252007-08-18 10:59:19 +00002007 sqlite3OsCloseFree(pMaster);
2008 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00002009 sqlite3DbFree(db, zMaster);
danielk19775865e3d2004-06-14 06:03:57 +00002010 return rc;
2011 }
drhc9e06862004-06-09 20:03:08 +00002012
danielk197713adf8a2004-06-03 16:08:41 +00002013 /* Sync all the db files involved in the transaction. The same call
2014 ** sets the master journal pointer in each individual journal. If
2015 ** an error occurs here, do not delete the master journal file.
2016 **
drh80e35f42007-03-30 14:06:34 +00002017 ** If the error occurs during the first call to
2018 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
2019 ** master journal file will be orphaned. But we cannot delete it,
2020 ** in case the master journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00002021 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00002022 */
danielk19775bd270b2006-07-25 15:14:52 +00002023 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002024 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002025 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002026 rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00002027 }
2028 }
danielk1977fee2d252007-08-18 10:59:19 +00002029 sqlite3OsCloseFree(pMaster);
drhabfb62f2010-07-30 11:20:35 +00002030 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00002031 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00002032 sqlite3DbFree(db, zMaster);
danielk19775bd270b2006-07-25 15:14:52 +00002033 return rc;
2034 }
danielk197713adf8a2004-06-03 16:08:41 +00002035
danielk1977962398d2004-06-14 09:35:16 +00002036 /* Delete the master journal file. This commits the transaction. After
2037 ** doing this the directory is synced again before any individual
2038 ** transaction files are deleted.
2039 */
danielk1977fee2d252007-08-18 10:59:19 +00002040 rc = sqlite3OsDelete(pVfs, zMaster, 1);
drh633e6d52008-07-28 19:34:53 +00002041 sqlite3DbFree(db, zMaster);
drhc416ba92007-03-30 18:42:55 +00002042 zMaster = 0;
drh29a01382006-08-13 19:04:18 +00002043 if( rc ){
2044 return rc;
2045 }
danielk197713adf8a2004-06-03 16:08:41 +00002046
2047 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00002048 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
2049 ** deleting or truncating journals. If something goes wrong while
2050 ** this is happening we don't really care. The integrity of the
2051 ** transaction is already guaranteed, but some stray 'cold' journals
2052 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00002053 */
danielk1977979f38e2007-03-27 16:19:51 +00002054 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002055 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00002056 for(i=0; i<db->nDb; i++){
2057 Btree *pBt = db->aDb[i].pBt;
2058 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002059 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00002060 }
2061 }
danielk19772d1d86f2008-06-20 14:59:51 +00002062 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00002063 enable_simulated_io_errors();
2064
danielk1977f9e7dda2006-06-16 16:08:53 +00002065 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002066 }
danielk197744ee5bf2005-05-27 09:41:12 +00002067#endif
danielk1977026d2702004-06-14 13:14:59 +00002068
drh2ac3ee92004-06-07 16:27:46 +00002069 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002070}
2071
danielk19771d850a72004-05-31 08:26:49 +00002072/*
drh4f7d3a52013-06-27 23:54:02 +00002073** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00002074** matches the number of vdbe's in the list sqlite3.pVdbe that are
2075** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00002076** This is an internal self-check only - it is not an essential processing
2077** step.
danielk19771d850a72004-05-31 08:26:49 +00002078**
2079** This is a no-op if NDEBUG is defined.
2080*/
2081#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00002082static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00002083 Vdbe *p;
2084 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00002085 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00002086 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00002087 p = db->pVdbe;
2088 while( p ){
drh92f02c32004-09-02 14:57:08 +00002089 if( p->magic==VDBE_MAGIC_RUN && p->pc>=0 ){
danielk19771d850a72004-05-31 08:26:49 +00002090 cnt++;
drhad4a4b82008-11-05 16:37:34 +00002091 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00002092 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00002093 }
2094 p = p->pNext;
2095 }
drh4f7d3a52013-06-27 23:54:02 +00002096 assert( cnt==db->nVdbeActive );
2097 assert( nWrite==db->nVdbeWrite );
2098 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00002099}
2100#else
2101#define checkActiveVdbeCnt(x)
2102#endif
2103
danielk19773cf86062004-05-26 10:11:05 +00002104/*
danielk1977bd434552009-03-18 10:33:00 +00002105** If the Vdbe passed as the first argument opened a statement-transaction,
2106** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
2107** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
2108** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00002109** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00002110**
2111** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
2112** Otherwise SQLITE_OK.
2113*/
2114int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00002115 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00002116 int rc = SQLITE_OK;
danielk1977ecaecf92009-07-08 08:05:35 +00002117
danielk1977e4948172009-07-17 17:25:43 +00002118 /* If p->iStatement is greater than zero, then this Vdbe opened a
2119 ** statement transaction that should be closed here. The only exception
mistachkin48864df2013-03-21 21:20:32 +00002120 ** is that an IO error may have occurred, causing an emergency rollback.
danielk1977e4948172009-07-17 17:25:43 +00002121 ** In this case (db->nStatement==0), and there is nothing to do.
2122 */
2123 if( db->nStatement && p->iStatement ){
danielk1977bd434552009-03-18 10:33:00 +00002124 int i;
2125 const int iSavepoint = p->iStatement-1;
danielk1977bd434552009-03-18 10:33:00 +00002126
2127 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
2128 assert( db->nStatement>0 );
2129 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
2130
2131 for(i=0; i<db->nDb; i++){
2132 int rc2 = SQLITE_OK;
2133 Btree *pBt = db->aDb[i].pBt;
2134 if( pBt ){
2135 if( eOp==SAVEPOINT_ROLLBACK ){
2136 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
2137 }
2138 if( rc2==SQLITE_OK ){
2139 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
2140 }
2141 if( rc==SQLITE_OK ){
2142 rc = rc2;
2143 }
2144 }
2145 }
2146 db->nStatement--;
2147 p->iStatement = 0;
dan1da40a32009-09-19 17:00:31 +00002148
dana311b802011-04-26 19:21:34 +00002149 if( rc==SQLITE_OK ){
2150 if( eOp==SAVEPOINT_ROLLBACK ){
2151 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
2152 }
2153 if( rc==SQLITE_OK ){
2154 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
2155 }
2156 }
2157
dan1da40a32009-09-19 17:00:31 +00002158 /* If the statement transaction is being rolled back, also restore the
2159 ** database handles deferred constraint counter to the value it had when
2160 ** the statement transaction was opened. */
2161 if( eOp==SAVEPOINT_ROLLBACK ){
2162 db->nDeferredCons = p->nStmtDefCons;
drh648e2642013-07-11 15:03:32 +00002163 db->nDeferredImmCons = p->nStmtDefImmCons;
dan1da40a32009-09-19 17:00:31 +00002164 }
danielk1977bd434552009-03-18 10:33:00 +00002165 }
2166 return rc;
2167}
2168
2169/*
dan1da40a32009-09-19 17:00:31 +00002170** This function is called when a transaction opened by the database
2171** handle associated with the VM passed as an argument is about to be
2172** committed. If there are outstanding deferred foreign key constraint
2173** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
2174**
2175** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00002176** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
2177** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00002178*/
2179#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00002180int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00002181 sqlite3 *db = p->db;
drh648e2642013-07-11 15:03:32 +00002182 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
2183 || (!deferred && p->nFkConstraint>0)
2184 ){
drhd91c1a12013-02-09 13:58:25 +00002185 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00002186 p->errorAction = OE_Abort;
drhf9c8ce32013-11-05 13:33:55 +00002187 sqlite3SetString(&p->zErrMsg, db, "FOREIGN KEY constraint failed");
dan1da40a32009-09-19 17:00:31 +00002188 return SQLITE_ERROR;
2189 }
2190 return SQLITE_OK;
2191}
2192#endif
2193
2194/*
drh92f02c32004-09-02 14:57:08 +00002195** This routine is called the when a VDBE tries to halt. If the VDBE
2196** has made changes and is in autocommit mode, then commit those
2197** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00002198**
drh92f02c32004-09-02 14:57:08 +00002199** This routine is the only way to move the state of a VM from
drhff0587c2007-08-29 17:43:19 +00002200** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
2201** call this on a VM that is in the SQLITE_MAGIC_HALT state.
drh92f02c32004-09-02 14:57:08 +00002202**
2203** Return an error code. If the commit could not complete because of
2204** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
2205** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00002206*/
drhff0587c2007-08-29 17:43:19 +00002207int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00002208 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00002209 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00002210
2211 /* This function contains the logic that determines if a statement or
2212 ** transaction will be committed or rolled back as a result of the
2213 ** execution of this virtual machine.
2214 **
drh71b890a2007-10-03 15:30:52 +00002215 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00002216 **
drh71b890a2007-10-03 15:30:52 +00002217 ** SQLITE_NOMEM
2218 ** SQLITE_IOERR
2219 ** SQLITE_FULL
2220 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00002221 **
drh71b890a2007-10-03 15:30:52 +00002222 ** Then the internal cache might have been left in an inconsistent
2223 ** state. We need to rollback the statement transaction, if there is
2224 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00002225 */
drh9a324642003-09-06 20:12:01 +00002226
drh17435752007-08-16 04:30:38 +00002227 if( p->db->mallocFailed ){
danielk1977261919c2005-12-06 12:52:59 +00002228 p->rc = SQLITE_NOMEM;
2229 }
drh6e856bc2011-12-09 18:06:44 +00002230 if( p->aOnceFlag ) memset(p->aOnceFlag, 0, p->nOnceFlag);
drh5f82e3c2009-07-06 00:44:08 +00002231 closeAllCursors(p);
drh92f02c32004-09-02 14:57:08 +00002232 if( p->magic!=VDBE_MAGIC_RUN ){
drh92f02c32004-09-02 14:57:08 +00002233 return SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00002234 }
danielk19771d850a72004-05-31 08:26:49 +00002235 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00002236
danc0537fe2013-06-28 19:41:43 +00002237 /* No commit or rollback needed if the program never started or if the
2238 ** SQL statement does not read or write a database file. */
2239 if( p->pc>=0 && p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00002240 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00002241 int eStatementOp = 0;
2242 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00002243
2244 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00002245 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00002246
drh71b890a2007-10-03 15:30:52 +00002247 /* Check for one of the special errors */
drhaac2f552006-09-23 21:44:23 +00002248 mrc = p->rc & 0xff;
drhfa3be902009-07-07 02:44:07 +00002249 assert( p->rc!=SQLITE_IOERR_BLOCKED ); /* This error no longer exists */
drh71b890a2007-10-03 15:30:52 +00002250 isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
drh77658e22007-12-04 16:54:52 +00002251 || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
danielk197707cb5602006-01-20 10:55:05 +00002252 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00002253 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
2254 ** no rollback is necessary. Otherwise, at least a savepoint
2255 ** transaction must be rolled back to restore the database to a
2256 ** consistent state.
2257 **
2258 ** Even if the statement is read-only, it is important to perform
2259 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00002260 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00002261 ** file as part of an effort to free up cache space (see function
2262 ** pagerStress() in pager.c), the rollback is required to restore
2263 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00002264 */
drhad4a4b82008-11-05 16:37:34 +00002265 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00002266 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00002267 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002268 }else{
2269 /* We are forced to roll back the active transaction. Before doing
2270 ** so, abort any other statements this handle currently has active.
2271 */
drh21021a52012-02-13 17:01:51 +00002272 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002273 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002274 db->autoCommit = 1;
2275 }
danielk1977261919c2005-12-06 12:52:59 +00002276 }
2277 }
dan32b09f22009-09-23 17:29:59 +00002278
2279 /* Check for immediate foreign key violations. */
2280 if( p->rc==SQLITE_OK ){
2281 sqlite3VdbeCheckFk(p, 0);
2282 }
danielk197707cb5602006-01-20 10:55:05 +00002283
danielk1977bd434552009-03-18 10:33:00 +00002284 /* If the auto-commit flag is set and this is the only active writer
2285 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00002286 **
2287 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00002288 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00002289 */
danielk1977093e0f62008-11-13 18:00:14 +00002290 if( !sqlite3VtabInSync(db)
2291 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00002292 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00002293 ){
danielk197707cb5602006-01-20 10:55:05 +00002294 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00002295 rc = sqlite3VdbeCheckFk(p, 1);
2296 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00002297 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00002298 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00002299 return SQLITE_ERROR;
2300 }
drhd91c1a12013-02-09 13:58:25 +00002301 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan19611b12011-01-24 16:00:58 +00002302 }else{
2303 /* The auto-commit flag is true, the vdbe program was successful
2304 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
2305 ** key constraints to hold up the transaction. This means a commit
2306 ** is required. */
2307 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00002308 }
dan19611b12011-01-24 16:00:58 +00002309 if( rc==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00002310 sqlite3VdbeLeave(p);
danielk197707cb5602006-01-20 10:55:05 +00002311 return SQLITE_BUSY;
2312 }else if( rc!=SQLITE_OK ){
2313 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00002314 sqlite3RollbackAll(db, SQLITE_OK);
danielk197707cb5602006-01-20 10:55:05 +00002315 }else{
dan1da40a32009-09-19 17:00:31 +00002316 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00002317 db->nDeferredImmCons = 0;
2318 db->flags &= ~SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00002319 sqlite3CommitInternalChanges(db);
2320 }
2321 }else{
drh0f198a72012-02-13 16:43:16 +00002322 sqlite3RollbackAll(db, SQLITE_OK);
danielk197707cb5602006-01-20 10:55:05 +00002323 }
danielk1977bd434552009-03-18 10:33:00 +00002324 db->nStatement = 0;
2325 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00002326 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00002327 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00002328 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00002329 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00002330 }else{
drh21021a52012-02-13 17:01:51 +00002331 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00002332 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00002333 db->autoCommit = 1;
2334 }
danielk19771d850a72004-05-31 08:26:49 +00002335 }
danielk197707cb5602006-01-20 10:55:05 +00002336
danielk1977bd434552009-03-18 10:33:00 +00002337 /* If eStatementOp is non-zero, then a statement transaction needs to
2338 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
2339 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00002340 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
2341 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00002342 */
danielk1977bd434552009-03-18 10:33:00 +00002343 if( eStatementOp ){
2344 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00002345 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002346 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00002347 p->rc = rc;
2348 sqlite3DbFree(db, p->zErrMsg);
2349 p->zErrMsg = 0;
2350 }
drh21021a52012-02-13 17:01:51 +00002351 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00002352 sqlite3CloseSavepoints(db);
2353 db->autoCommit = 1;
danielk197707cb5602006-01-20 10:55:05 +00002354 }
danielk197777d83ba2004-05-31 10:08:14 +00002355 }
danielk197707cb5602006-01-20 10:55:05 +00002356
danielk1977bd434552009-03-18 10:33:00 +00002357 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
2358 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00002359 */
drh6be240e2009-07-14 02:33:02 +00002360 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00002361 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00002362 sqlite3VdbeSetChanges(db, p->nChange);
2363 }else{
2364 sqlite3VdbeSetChanges(db, 0);
2365 }
2366 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00002367 }
drhff0587c2007-08-29 17:43:19 +00002368
2369 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00002370 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00002371 }
danielk19771d850a72004-05-31 08:26:49 +00002372
danielk197765fd59f2006-06-24 11:51:33 +00002373 /* We have successfully halted and closed the VM. Record this fact. */
2374 if( p->pc>=0 ){
drh4f7d3a52013-06-27 23:54:02 +00002375 db->nVdbeActive--;
2376 if( !p->readOnly ) db->nVdbeWrite--;
drh1713afb2013-06-28 01:24:57 +00002377 if( p->bIsReader ) db->nVdbeRead--;
drh4f7d3a52013-06-27 23:54:02 +00002378 assert( db->nVdbeActive>=db->nVdbeRead );
2379 assert( db->nVdbeRead>=db->nVdbeWrite );
2380 assert( db->nVdbeWrite>=0 );
drh9a324642003-09-06 20:12:01 +00002381 }
drh92f02c32004-09-02 14:57:08 +00002382 p->magic = VDBE_MAGIC_HALT;
2383 checkActiveVdbeCnt(db);
drhff0587c2007-08-29 17:43:19 +00002384 if( p->db->mallocFailed ){
2385 p->rc = SQLITE_NOMEM;
2386 }
danielk19771d850a72004-05-31 08:26:49 +00002387
danielk1977404ca072009-03-16 13:19:36 +00002388 /* If the auto-commit flag is set to true, then any locks that were held
2389 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
2390 ** to invoke any required unlock-notify callbacks.
2391 */
2392 if( db->autoCommit ){
2393 sqlite3ConnectionUnlocked(db);
2394 }
2395
drh4f7d3a52013-06-27 23:54:02 +00002396 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
dan19611b12011-01-24 16:00:58 +00002397 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00002398}
drh4cf7c7f2007-08-28 23:28:07 +00002399
drh92f02c32004-09-02 14:57:08 +00002400
2401/*
drh3c23a882007-01-09 14:01:13 +00002402** Each VDBE holds the result of the most recent sqlite3_step() call
2403** in p->rc. This routine sets that result back to SQLITE_OK.
2404*/
2405void sqlite3VdbeResetStepResult(Vdbe *p){
2406 p->rc = SQLITE_OK;
2407}
2408
2409/*
dan029ead62011-10-27 15:19:58 +00002410** Copy the error code and error message belonging to the VDBE passed
2411** as the first argument to its database handle (so that they will be
2412** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
2413**
2414** This function does not clear the VDBE error code or message, just
2415** copies them to the database handle.
2416*/
2417int sqlite3VdbeTransferError(Vdbe *p){
2418 sqlite3 *db = p->db;
2419 int rc = p->rc;
2420 if( p->zErrMsg ){
drh81bdd6d2011-10-29 01:33:24 +00002421 u8 mallocFailed = db->mallocFailed;
dan029ead62011-10-27 15:19:58 +00002422 sqlite3BeginBenignMalloc();
2423 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
2424 sqlite3EndBenignMalloc();
drh81bdd6d2011-10-29 01:33:24 +00002425 db->mallocFailed = mallocFailed;
dan029ead62011-10-27 15:19:58 +00002426 db->errCode = rc;
2427 }else{
2428 sqlite3Error(db, rc, 0);
2429 }
2430 return rc;
2431}
2432
danac455932012-11-26 19:50:41 +00002433#ifdef SQLITE_ENABLE_SQLLOG
2434/*
2435** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
2436** invoke it.
2437*/
2438static void vdbeInvokeSqllog(Vdbe *v){
2439 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
2440 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
2441 assert( v->db->init.busy==0 );
2442 if( zExpanded ){
2443 sqlite3GlobalConfig.xSqllog(
2444 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
2445 );
2446 sqlite3DbFree(v->db, zExpanded);
2447 }
2448 }
2449}
2450#else
2451# define vdbeInvokeSqllog(x)
2452#endif
2453
dan029ead62011-10-27 15:19:58 +00002454/*
drh92f02c32004-09-02 14:57:08 +00002455** Clean up a VDBE after execution but do not delete the VDBE just yet.
2456** Write any error messages into *pzErrMsg. Return the result code.
2457**
2458** After this routine is run, the VDBE should be ready to be executed
2459** again.
2460**
2461** To look at it another way, this routine resets the state of the
2462** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
2463** VDBE_MAGIC_INIT.
2464*/
drhc890fec2008-08-01 20:10:08 +00002465int sqlite3VdbeReset(Vdbe *p){
drh4ac285a2006-09-15 07:28:50 +00002466 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00002467 db = p->db;
drh92f02c32004-09-02 14:57:08 +00002468
2469 /* If the VM did not run to completion or if it encountered an
2470 ** error, then it might not have been halted properly. So halt
2471 ** it now.
2472 */
2473 sqlite3VdbeHalt(p);
2474
drhfb7e7652005-01-24 00:28:42 +00002475 /* If the VDBE has be run even partially, then transfer the error code
2476 ** and error message from the VDBE into the main database structure. But
2477 ** if the VDBE has just been set to run but has not actually executed any
2478 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00002479 */
drhfb7e7652005-01-24 00:28:42 +00002480 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00002481 vdbeInvokeSqllog(p);
dan029ead62011-10-27 15:19:58 +00002482 sqlite3VdbeTransferError(p);
2483 sqlite3DbFree(db, p->zErrMsg);
2484 p->zErrMsg = 0;
drh4611d922010-02-25 14:47:01 +00002485 if( p->runOnlyOnce ) p->expired = 1;
danielk1977a21c6b62005-01-24 10:25:59 +00002486 }else if( p->rc && p->expired ){
2487 /* The expired flag was set on the VDBE before the first call
2488 ** to sqlite3_step(). For consistency (since sqlite3_step() was
2489 ** called), set the database error in this case as well.
2490 */
drh4ac285a2006-09-15 07:28:50 +00002491 sqlite3Error(db, p->rc, 0);
drh633e6d52008-07-28 19:34:53 +00002492 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
2493 sqlite3DbFree(db, p->zErrMsg);
danielk19778e556522007-11-13 10:30:24 +00002494 p->zErrMsg = 0;
drh92f02c32004-09-02 14:57:08 +00002495 }
2496
2497 /* Reclaim all memory used by the VDBE
2498 */
drhc890fec2008-08-01 20:10:08 +00002499 Cleanup(p);
drh92f02c32004-09-02 14:57:08 +00002500
2501 /* Save profiling information from this VDBE run.
2502 */
drh9a324642003-09-06 20:12:01 +00002503#ifdef VDBE_PROFILE
2504 {
2505 FILE *out = fopen("vdbe_profile.out", "a");
2506 if( out ){
2507 int i;
2508 fprintf(out, "---- ");
2509 for(i=0; i<p->nOp; i++){
2510 fprintf(out, "%02x", p->aOp[i].opcode);
2511 }
2512 fprintf(out, "\n");
2513 for(i=0; i<p->nOp; i++){
2514 fprintf(out, "%6d %10lld %8lld ",
2515 p->aOp[i].cnt,
2516 p->aOp[i].cycles,
2517 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
2518 );
danielk19774adee202004-05-08 08:23:19 +00002519 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00002520 }
2521 fclose(out);
2522 }
2523 }
2524#endif
drh7fa20922013-09-17 23:36:33 +00002525 p->iCurrentTime = 0;
drh9a324642003-09-06 20:12:01 +00002526 p->magic = VDBE_MAGIC_INIT;
drh4ac285a2006-09-15 07:28:50 +00002527 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00002528}
drh92f02c32004-09-02 14:57:08 +00002529
drh9a324642003-09-06 20:12:01 +00002530/*
2531** Clean up and delete a VDBE after execution. Return an integer which is
2532** the result code. Write any error message text into *pzErrMsg.
2533*/
danielk19779e6db7d2004-06-21 08:18:51 +00002534int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00002535 int rc = SQLITE_OK;
danielk1977b5548a82004-06-26 13:51:33 +00002536 if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
drhc890fec2008-08-01 20:10:08 +00002537 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00002538 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00002539 }
danielk19774adee202004-05-08 08:23:19 +00002540 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00002541 return rc;
2542}
2543
2544/*
dan0c547792013-07-18 17:12:08 +00002545** If parameter iOp is less than zero, then invoke the destructor for
2546** all auxiliary data pointers currently cached by the VM passed as
2547** the first argument.
2548**
2549** Or, if iOp is greater than or equal to zero, then the destructor is
2550** only invoked for those auxiliary data pointers created by the user
2551** function invoked by the OP_Function opcode at instruction iOp of
2552** VM pVdbe, and only then if:
2553**
2554** * the associated function parameter is the 32nd or later (counting
2555** from left to right), or
2556**
2557** * the corresponding bit in argument mask is clear (where the first
2558** function parameter corrsponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00002559*/
dan0c547792013-07-18 17:12:08 +00002560void sqlite3VdbeDeleteAuxData(Vdbe *pVdbe, int iOp, int mask){
2561 AuxData **pp = &pVdbe->pAuxData;
2562 while( *pp ){
2563 AuxData *pAux = *pp;
2564 if( (iOp<0)
2565 || (pAux->iOp==iOp && (pAux->iArg>31 || !(mask & ((u32)1<<pAux->iArg))))
2566 ){
drhf92c7ff2004-06-19 15:40:23 +00002567 if( pAux->xDelete ){
2568 pAux->xDelete(pAux->pAux);
2569 }
dan0c547792013-07-18 17:12:08 +00002570 *pp = pAux->pNext;
2571 sqlite3DbFree(pVdbe->db, pAux);
2572 }else{
2573 pp= &pAux->pNext;
drhf92c7ff2004-06-19 15:40:23 +00002574 }
2575 }
2576}
2577
2578/*
drhcb103b92012-10-26 00:11:23 +00002579** Free all memory associated with the Vdbe passed as the second argument,
2580** except for object itself, which is preserved.
2581**
dand46def72010-07-24 11:28:28 +00002582** The difference between this function and sqlite3VdbeDelete() is that
2583** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00002584** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00002585*/
drhcb103b92012-10-26 00:11:23 +00002586void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00002587 SubProgram *pSub, *pNext;
drh124c0b42011-06-01 18:15:55 +00002588 int i;
dand46def72010-07-24 11:28:28 +00002589 assert( p->db==0 || p->db==db );
2590 releaseMemArray(p->aVar, p->nVar);
2591 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
dand19c9332010-07-26 12:05:17 +00002592 for(pSub=p->pProgram; pSub; pSub=pNext){
2593 pNext = pSub->pNext;
2594 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
2595 sqlite3DbFree(db, pSub);
2596 }
drh124c0b42011-06-01 18:15:55 +00002597 for(i=p->nzVar-1; i>=0; i--) sqlite3DbFree(db, p->azVar[i]);
dand46def72010-07-24 11:28:28 +00002598 vdbeFreeOpArray(db, p->aOp, p->nOp);
2599 sqlite3DbFree(db, p->aLabel);
2600 sqlite3DbFree(db, p->aColName);
2601 sqlite3DbFree(db, p->zSql);
2602 sqlite3DbFree(db, p->pFree);
drh678a9aa2011-12-10 15:55:01 +00002603#if defined(SQLITE_ENABLE_TREE_EXPLAIN)
drh25fe97a2013-01-23 18:44:22 +00002604 sqlite3DbFree(db, p->zExplain);
drh678a9aa2011-12-10 15:55:01 +00002605 sqlite3DbFree(db, p->pExplain);
drh7e02e5e2011-12-06 19:44:51 +00002606#endif
dand46def72010-07-24 11:28:28 +00002607}
2608
2609/*
drh9a324642003-09-06 20:12:01 +00002610** Delete an entire VDBE.
2611*/
danielk19774adee202004-05-08 08:23:19 +00002612void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00002613 sqlite3 *db;
2614
drhfa3be902009-07-07 02:44:07 +00002615 if( NEVER(p==0) ) return;
drh633e6d52008-07-28 19:34:53 +00002616 db = p->db;
drh4245c402012-06-02 14:32:21 +00002617 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00002618 sqlite3VdbeClearObject(db, p);
drh9a324642003-09-06 20:12:01 +00002619 if( p->pPrev ){
2620 p->pPrev->pNext = p->pNext;
2621 }else{
drh633e6d52008-07-28 19:34:53 +00002622 assert( db->pVdbe==p );
2623 db->pVdbe = p->pNext;
drh9a324642003-09-06 20:12:01 +00002624 }
2625 if( p->pNext ){
2626 p->pNext->pPrev = p->pPrev;
2627 }
drh9a324642003-09-06 20:12:01 +00002628 p->magic = VDBE_MAGIC_DEAD;
drh87f5c5f2010-01-20 01:20:56 +00002629 p->db = 0;
drhcb103b92012-10-26 00:11:23 +00002630 sqlite3DbFree(db, p);
drh9a324642003-09-06 20:12:01 +00002631}
drha11846b2004-01-07 18:52:56 +00002632
2633/*
drh9a65f2c2009-06-22 19:05:40 +00002634** Make sure the cursor p is ready to read or write the row to which it
2635** was last positioned. Return an error code if an OOM fault or I/O error
2636** prevents us from positioning the cursor to its correct position.
2637**
drha11846b2004-01-07 18:52:56 +00002638** If a MoveTo operation is pending on the given cursor, then do that
drh9a65f2c2009-06-22 19:05:40 +00002639** MoveTo now. If no move is pending, check to see if the row has been
2640** deleted out from under the cursor and if it has, mark the row as
2641** a NULL row.
2642**
2643** If the cursor is already pointing to the correct row and that row has
2644** not been deleted out from under the cursor, then this routine is a no-op.
drha11846b2004-01-07 18:52:56 +00002645*/
drhdfe88ec2008-11-03 20:55:06 +00002646int sqlite3VdbeCursorMoveto(VdbeCursor *p){
drha11846b2004-01-07 18:52:56 +00002647 if( p->deferredMoveto ){
drh536065a2005-01-26 21:55:31 +00002648 int res, rc;
adamd4fc93082006-09-14 16:57:19 +00002649#ifdef SQLITE_TEST
danielk1977132872b2004-05-10 10:37:18 +00002650 extern int sqlite3_search_count;
adamd4fc93082006-09-14 16:57:19 +00002651#endif
drhf0863fe2005-06-12 21:35:51 +00002652 assert( p->isTable );
drhe63d9992008-08-13 19:11:48 +00002653 rc = sqlite3BtreeMovetoUnpacked(p->pCursor, 0, p->movetoTarget, 0, &res);
drh536065a2005-01-26 21:55:31 +00002654 if( rc ) return rc;
drhaa736092009-06-22 00:55:30 +00002655 p->lastRowid = p->movetoTarget;
drhbe0b2372010-07-30 18:40:55 +00002656 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
2657 p->rowidIsValid = 1;
drh10cfdd52006-08-08 15:42:59 +00002658#ifdef SQLITE_TEST
danielk1977132872b2004-05-10 10:37:18 +00002659 sqlite3_search_count++;
drh10cfdd52006-08-08 15:42:59 +00002660#endif
drha11846b2004-01-07 18:52:56 +00002661 p->deferredMoveto = 0;
drh76873ab2006-01-07 18:48:26 +00002662 p->cacheStatus = CACHE_STALE;
drh399af1d2013-11-20 17:25:55 +00002663 }else if( p->pCursor ){
drha3460582008-07-11 21:02:53 +00002664 int hasMoved;
2665 int rc = sqlite3BtreeCursorHasMoved(p->pCursor, &hasMoved);
2666 if( rc ) return rc;
2667 if( hasMoved ){
2668 p->cacheStatus = CACHE_STALE;
2669 p->nullRow = 1;
2670 }
drha11846b2004-01-07 18:52:56 +00002671 }
2672 return SQLITE_OK;
2673}
danielk19774adee202004-05-08 08:23:19 +00002674
drhab9f7f12004-05-08 10:56:11 +00002675/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002676** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00002677**
danielk1977cfcdaef2004-05-12 07:33:33 +00002678** sqlite3VdbeSerialType()
2679** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00002680** sqlite3VdbeSerialLen()
shane92003092008-07-31 01:43:13 +00002681** sqlite3VdbeSerialPut()
2682** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00002683**
2684** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00002685** data and index records. Each serialized value consists of a
2686** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
2687** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00002688**
danielk1977cfcdaef2004-05-12 07:33:33 +00002689** In an SQLite index record, the serial type is stored directly before
2690** the blob of data that it corresponds to. In a table record, all serial
2691** types are stored at the start of the record, and the blobs of data at
2692** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00002693** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00002694**
2695** The following table describes the various storage classes for data:
2696**
2697** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00002698** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00002699** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00002700** 1 1 signed integer
2701** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00002702** 3 3 signed integer
2703** 4 4 signed integer
2704** 5 6 signed integer
2705** 6 8 signed integer
2706** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00002707** 8 0 Integer constant 0
2708** 9 0 Integer constant 1
2709** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00002710** N>=12 and even (N-12)/2 BLOB
2711** N>=13 and odd (N-13)/2 text
2712**
drh35a59652006-01-02 18:24:40 +00002713** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
2714** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00002715*/
2716
2717/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002718** Return the serial-type for the value stored in pMem.
danielk1977192ac1d2004-05-10 07:17:30 +00002719*/
drhd946db02005-12-29 19:23:06 +00002720u32 sqlite3VdbeSerialType(Mem *pMem, int file_format){
danielk1977cfcdaef2004-05-12 07:33:33 +00002721 int flags = pMem->flags;
drhfdf972a2007-05-02 13:30:27 +00002722 int n;
danielk1977cfcdaef2004-05-12 07:33:33 +00002723
2724 if( flags&MEM_Null ){
drha19b7752004-05-30 21:14:58 +00002725 return 0;
danielk197790e4d952004-05-10 10:05:53 +00002726 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002727 if( flags&MEM_Int ){
drhfe2093d2005-01-20 22:48:47 +00002728 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00002729# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00002730 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00002731 u64 u;
drhcfd654b2011-03-05 13:54:15 +00002732 if( i<0 ){
2733 if( i<(-MAX_6BYTE) ) return 6;
2734 /* Previous test prevents: u = -(-9223372036854775808) */
2735 u = -i;
2736 }else{
2737 u = i;
2738 }
drh56690b32012-09-17 15:36:31 +00002739 if( u<=127 ){
2740 return ((i&1)==i && file_format>=4) ? 8+(u32)u : 1;
2741 }
drh5742b632005-01-26 17:47:02 +00002742 if( u<=32767 ) return 2;
2743 if( u<=8388607 ) return 3;
2744 if( u<=2147483647 ) return 4;
2745 if( u<=MAX_6BYTE ) return 5;
drha19b7752004-05-30 21:14:58 +00002746 return 6;
danielk197790e4d952004-05-10 10:05:53 +00002747 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002748 if( flags&MEM_Real ){
drha19b7752004-05-30 21:14:58 +00002749 return 7;
danielk197790e4d952004-05-10 10:05:53 +00002750 }
danielk1977e4359752008-11-03 09:39:45 +00002751 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drhfdf972a2007-05-02 13:30:27 +00002752 n = pMem->n;
2753 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00002754 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00002755 }
drhfdf972a2007-05-02 13:30:27 +00002756 assert( n>=0 );
2757 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00002758}
2759
2760/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002761** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00002762*/
drh35cd6432009-06-05 14:17:21 +00002763u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drha19b7752004-05-30 21:14:58 +00002764 if( serial_type>=12 ){
drh51846b52004-05-28 16:00:21 +00002765 return (serial_type-12)/2;
2766 }else{
drh57196282004-10-06 15:41:16 +00002767 static const u8 aSize[] = { 0, 1, 2, 3, 4, 6, 8, 8, 0, 0, 0, 0 };
drh51846b52004-05-28 16:00:21 +00002768 return aSize[serial_type];
2769 }
danielk1977192ac1d2004-05-10 07:17:30 +00002770}
2771
2772/*
drh110daac2007-05-04 11:59:31 +00002773** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00002774** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00002775** upper 4 bytes. Return the result.
2776**
drh7a4f5022007-05-23 07:20:08 +00002777** For most architectures, this is a no-op.
2778**
2779** (later): It is reported to me that the mixed-endian problem
2780** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
2781** that early versions of GCC stored the two words of a 64-bit
2782** float in the wrong order. And that error has been propagated
2783** ever since. The blame is not necessarily with GCC, though.
2784** GCC might have just copying the problem from a prior compiler.
2785** I am also told that newer versions of GCC that follow a different
2786** ABI get the byte order right.
2787**
2788** Developers using SQLite on an ARM7 should compile and run their
2789** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
2790** enabled, some asserts below will ensure that the byte order of
2791** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00002792**
2793** (2007-08-30) Frank van Vugt has studied this problem closely
2794** and has send his findings to the SQLite developers. Frank
2795** writes that some Linux kernels offer floating point hardware
2796** emulation that uses only 32-bit mantissas instead of a full
2797** 48-bits as required by the IEEE standard. (This is the
2798** CONFIG_FPE_FASTFPE option.) On such systems, floating point
2799** byte swapping becomes very complicated. To avoid problems,
2800** the necessary byte swapping is carried out using a 64-bit integer
2801** rather than a 64-bit float. Frank assures us that the code here
2802** works for him. We, the developers, have no way to independently
2803** verify this, but Frank seems to know what he is talking about
2804** so we trust him.
drh110daac2007-05-04 11:59:31 +00002805*/
2806#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh60d09a72007-08-30 15:05:08 +00002807static u64 floatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00002808 union {
drh60d09a72007-08-30 15:05:08 +00002809 u64 r;
drh110daac2007-05-04 11:59:31 +00002810 u32 i[2];
2811 } u;
2812 u32 t;
2813
2814 u.r = in;
2815 t = u.i[0];
2816 u.i[0] = u.i[1];
2817 u.i[1] = t;
2818 return u.r;
2819}
2820# define swapMixedEndianFloat(X) X = floatSwap(X)
2821#else
2822# define swapMixedEndianFloat(X)
2823#endif
2824
2825/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002826** Write the serialized data blob for the value stored in pMem into
2827** buf. It is assumed that the caller has allocated sufficient space.
2828** Return the number of bytes written.
drhfdf972a2007-05-02 13:30:27 +00002829**
drh038b7bc2013-12-09 23:17:22 +00002830** nBuf is the amount of space left in buf[]. The caller is responsible
2831** for allocating enough space to buf[] to hold the entire field, exclusive
2832** of the pMem->u.nZero bytes for a MEM_Zero value.
drhfdf972a2007-05-02 13:30:27 +00002833**
2834** Return the number of bytes actually written into buf[]. The number
2835** of bytes in the zero-filled tail is included in the return value only
2836** if those bytes were zeroed in buf[].
danielk1977cfcdaef2004-05-12 07:33:33 +00002837*/
drha9ab4812013-12-11 11:00:44 +00002838u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
drh35cd6432009-06-05 14:17:21 +00002839 u32 len;
danielk1977183f9f72004-05-13 05:20:26 +00002840
drh1483e142004-05-21 21:12:42 +00002841 /* Integer and Real */
drhd946db02005-12-29 19:23:06 +00002842 if( serial_type<=7 && serial_type>0 ){
drh1483e142004-05-21 21:12:42 +00002843 u64 v;
drh35cd6432009-06-05 14:17:21 +00002844 u32 i;
drha19b7752004-05-30 21:14:58 +00002845 if( serial_type==7 ){
drh4f0c5872007-03-26 22:05:01 +00002846 assert( sizeof(v)==sizeof(pMem->r) );
2847 memcpy(&v, &pMem->r, sizeof(v));
drh60d09a72007-08-30 15:05:08 +00002848 swapMixedEndianFloat(v);
drh1483e142004-05-21 21:12:42 +00002849 }else{
drh3c024d62007-03-30 11:23:45 +00002850 v = pMem->u.i;
danielk1977cfcdaef2004-05-12 07:33:33 +00002851 }
drh1483e142004-05-21 21:12:42 +00002852 len = i = sqlite3VdbeSerialTypeLen(serial_type);
2853 while( i-- ){
drh8df32842008-12-09 02:51:23 +00002854 buf[i] = (u8)(v&0xFF);
drh1483e142004-05-21 21:12:42 +00002855 v >>= 8;
2856 }
2857 return len;
danielk1977cfcdaef2004-05-12 07:33:33 +00002858 }
drhd946db02005-12-29 19:23:06 +00002859
danielk1977cfcdaef2004-05-12 07:33:33 +00002860 /* String or blob */
drhd946db02005-12-29 19:23:06 +00002861 if( serial_type>=12 ){
drh8df32842008-12-09 02:51:23 +00002862 assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
shane75ac1de2009-06-09 18:58:52 +00002863 == (int)sqlite3VdbeSerialTypeLen(serial_type) );
drhfdf972a2007-05-02 13:30:27 +00002864 len = pMem->n;
drhd946db02005-12-29 19:23:06 +00002865 memcpy(buf, pMem->z, len);
2866 return len;
2867 }
2868
2869 /* NULL or constants 0 or 1 */
2870 return 0;
danielk1977cfcdaef2004-05-12 07:33:33 +00002871}
2872
2873/*
2874** Deserialize the data blob pointed to by buf as serial type serial_type
2875** and store the result in pMem. Return the number of bytes read.
2876*/
drh35cd6432009-06-05 14:17:21 +00002877u32 sqlite3VdbeSerialGet(
danielk197793d46752004-05-23 13:30:58 +00002878 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00002879 u32 serial_type, /* Serial type to deserialize */
2880 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00002881){
drh3c685822005-05-21 18:32:18 +00002882 switch( serial_type ){
drh3c685822005-05-21 18:32:18 +00002883 case 10: /* Reserved for future use */
2884 case 11: /* Reserved for future use */
2885 case 0: { /* NULL */
2886 pMem->flags = MEM_Null;
2887 break;
2888 }
2889 case 1: { /* 1-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002890 pMem->u.i = (signed char)buf[0];
drh1483e142004-05-21 21:12:42 +00002891 pMem->flags = MEM_Int;
drh3c685822005-05-21 18:32:18 +00002892 return 1;
drh1483e142004-05-21 21:12:42 +00002893 }
drh3c685822005-05-21 18:32:18 +00002894 case 2: { /* 2-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002895 pMem->u.i = (((signed char)buf[0])<<8) | buf[1];
drh3c685822005-05-21 18:32:18 +00002896 pMem->flags = MEM_Int;
2897 return 2;
2898 }
2899 case 3: { /* 3-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002900 pMem->u.i = (((signed char)buf[0])<<16) | (buf[1]<<8) | buf[2];
drh3c685822005-05-21 18:32:18 +00002901 pMem->flags = MEM_Int;
2902 return 3;
2903 }
2904 case 4: { /* 4-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002905 pMem->u.i = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
drh3c685822005-05-21 18:32:18 +00002906 pMem->flags = MEM_Int;
2907 return 4;
2908 }
2909 case 5: { /* 6-byte signed integer */
2910 u64 x = (((signed char)buf[0])<<8) | buf[1];
2911 u32 y = (buf[2]<<24) | (buf[3]<<16) | (buf[4]<<8) | buf[5];
2912 x = (x<<32) | y;
drh3c024d62007-03-30 11:23:45 +00002913 pMem->u.i = *(i64*)&x;
drh3c685822005-05-21 18:32:18 +00002914 pMem->flags = MEM_Int;
2915 return 6;
2916 }
drh91124b32005-08-18 18:15:05 +00002917 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00002918 case 7: { /* IEEE floating point */
drhd81bd4e2005-09-05 20:06:49 +00002919 u64 x;
2920 u32 y;
drh2a3e4a72006-01-23 21:44:53 +00002921#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
drhde941c62005-08-28 01:34:21 +00002922 /* Verify that integers and floating point values use the same
drh110daac2007-05-04 11:59:31 +00002923 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
2924 ** defined that 64-bit floating point values really are mixed
2925 ** endian.
drhbfd6b032005-08-28 01:38:44 +00002926 */
drhde941c62005-08-28 01:34:21 +00002927 static const u64 t1 = ((u64)0x3ff00000)<<32;
drh4f0c5872007-03-26 22:05:01 +00002928 static const double r1 = 1.0;
drh60d09a72007-08-30 15:05:08 +00002929 u64 t2 = t1;
2930 swapMixedEndianFloat(t2);
2931 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
drhde941c62005-08-28 01:34:21 +00002932#endif
drhbfd6b032005-08-28 01:38:44 +00002933
drhd81bd4e2005-09-05 20:06:49 +00002934 x = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
2935 y = (buf[4]<<24) | (buf[5]<<16) | (buf[6]<<8) | buf[7];
drh3c685822005-05-21 18:32:18 +00002936 x = (x<<32) | y;
2937 if( serial_type==6 ){
drh3c024d62007-03-30 11:23:45 +00002938 pMem->u.i = *(i64*)&x;
drh3c685822005-05-21 18:32:18 +00002939 pMem->flags = MEM_Int;
2940 }else{
drh4f0c5872007-03-26 22:05:01 +00002941 assert( sizeof(x)==8 && sizeof(pMem->r)==8 );
drh60d09a72007-08-30 15:05:08 +00002942 swapMixedEndianFloat(x);
drh4f0c5872007-03-26 22:05:01 +00002943 memcpy(&pMem->r, &x, sizeof(x));
drh2eaf93d2008-04-29 00:15:20 +00002944 pMem->flags = sqlite3IsNaN(pMem->r) ? MEM_Null : MEM_Real;
drh3c685822005-05-21 18:32:18 +00002945 }
2946 return 8;
2947 }
drhd946db02005-12-29 19:23:06 +00002948 case 8: /* Integer 0 */
2949 case 9: { /* Integer 1 */
drh3c024d62007-03-30 11:23:45 +00002950 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00002951 pMem->flags = MEM_Int;
2952 return 0;
2953 }
drh3c685822005-05-21 18:32:18 +00002954 default: {
drhc138daf2013-11-19 13:55:34 +00002955 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh35cd6432009-06-05 14:17:21 +00002956 u32 len = (serial_type-12)/2;
drh3c685822005-05-21 18:32:18 +00002957 pMem->z = (char *)buf;
2958 pMem->n = len;
2959 pMem->xDel = 0;
drhc138daf2013-11-19 13:55:34 +00002960 pMem->flags = aFlag[serial_type&1];
drh3c685822005-05-21 18:32:18 +00002961 return len;
drh696b32f2004-05-30 01:51:52 +00002962 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002963 }
drh3c685822005-05-21 18:32:18 +00002964 return 0;
danielk1977192ac1d2004-05-10 07:17:30 +00002965}
2966
drh1e968a02008-03-25 00:22:21 +00002967/*
dan03e9cfc2011-09-05 14:20:27 +00002968** This routine is used to allocate sufficient space for an UnpackedRecord
2969** structure large enough to be used with sqlite3VdbeRecordUnpack() if
2970** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00002971**
dan03e9cfc2011-09-05 14:20:27 +00002972** The space is either allocated using sqlite3DbMallocRaw() or from within
2973** the unaligned buffer passed via the second and third arguments (presumably
2974** stack space). If the former, then *ppFree is set to a pointer that should
2975** be eventually freed by the caller using sqlite3DbFree(). Or, if the
2976** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
2977** before returning.
drh1e968a02008-03-25 00:22:21 +00002978**
dan03e9cfc2011-09-05 14:20:27 +00002979** If an OOM error occurs, NULL is returned.
2980*/
2981UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
2982 KeyInfo *pKeyInfo, /* Description of the record */
2983 char *pSpace, /* Unaligned space available */
2984 int szSpace, /* Size of pSpace[] in bytes */
2985 char **ppFree /* OUT: Caller should free this pointer */
drh1e968a02008-03-25 00:22:21 +00002986){
dan03e9cfc2011-09-05 14:20:27 +00002987 UnpackedRecord *p; /* Unpacked record to return */
2988 int nOff; /* Increment pSpace by nOff to align it */
2989 int nByte; /* Number of bytes required for *p */
2990
2991 /* We want to shift the pointer pSpace up such that it is 8-byte aligned.
shane80167bf2009-04-10 15:42:36 +00002992 ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
2993 ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
2994 */
2995 nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
drh8c5d1522009-04-10 00:56:28 +00002996 nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
dan42acb3e2011-09-05 20:16:38 +00002997 if( nByte>szSpace+nOff ){
dan03e9cfc2011-09-05 14:20:27 +00002998 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
2999 *ppFree = (char *)p;
dan42acb3e2011-09-05 20:16:38 +00003000 if( !p ) return 0;
drh1e968a02008-03-25 00:22:21 +00003001 }else{
dan42acb3e2011-09-05 20:16:38 +00003002 p = (UnpackedRecord*)&pSpace[nOff];
dan03e9cfc2011-09-05 14:20:27 +00003003 *ppFree = 0;
drh1e968a02008-03-25 00:22:21 +00003004 }
dan42acb3e2011-09-05 20:16:38 +00003005
3006 p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
drhe1a022e2012-09-17 17:16:53 +00003007 assert( pKeyInfo->aSortOrder!=0 );
drh1e968a02008-03-25 00:22:21 +00003008 p->pKeyInfo = pKeyInfo;
3009 p->nField = pKeyInfo->nField + 1;
dan03e9cfc2011-09-05 14:20:27 +00003010 return p;
3011}
3012
3013/*
3014** Given the nKey-byte encoding of a record in pKey[], populate the
3015** UnpackedRecord structure indicated by the fourth argument with the
3016** contents of the decoded record.
3017*/
3018void sqlite3VdbeRecordUnpack(
3019 KeyInfo *pKeyInfo, /* Information about the record format */
3020 int nKey, /* Size of the binary record */
3021 const void *pKey, /* The binary record */
3022 UnpackedRecord *p /* Populate this structure before returning. */
3023){
3024 const unsigned char *aKey = (const unsigned char *)pKey;
3025 int d;
3026 u32 idx; /* Offset in aKey[] to read from */
3027 u16 u; /* Unsigned loop counter */
3028 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00003029 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00003030
3031 p->flags = 0;
drh8c5d1522009-04-10 00:56:28 +00003032 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00003033 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00003034 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00003035 u = 0;
drh2fa34d32009-07-15 16:30:50 +00003036 while( idx<szHdr && u<p->nField && d<=nKey ){
drh1e968a02008-03-25 00:22:21 +00003037 u32 serial_type;
3038
danielk197700e13612008-11-17 19:18:54 +00003039 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00003040 pMem->enc = pKeyInfo->enc;
3041 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00003042 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
danielk19775f096132008-03-28 15:44:09 +00003043 pMem->zMalloc = 0;
drh1e968a02008-03-25 00:22:21 +00003044 d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
drhe14006d2008-03-25 17:23:32 +00003045 pMem++;
shane0b8d2762008-07-22 05:18:00 +00003046 u++;
drh1e968a02008-03-25 00:22:21 +00003047 }
drh7d10d5a2008-08-20 16:35:10 +00003048 assert( u<=pKeyInfo->nField + 1 );
shane0b8d2762008-07-22 05:18:00 +00003049 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00003050}
3051
3052/*
3053** This function compares the two table rows or index records
3054** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
drhe63d9992008-08-13 19:11:48 +00003055** or positive integer if key1 is less than, equal to or
3056** greater than key2. The {nKey1, pKey1} key must be a blob
drh1e968a02008-03-25 00:22:21 +00003057** created by th OP_MakeRecord opcode of the VDBE. The pPKey2
3058** key must be a parsed key such as obtained from
3059** sqlite3VdbeParseRecord.
3060**
3061** Key1 and Key2 do not have to contain the same number of fields.
drhe63d9992008-08-13 19:11:48 +00003062** The key with fewer fields is usually compares less than the
3063** longer key. However if the UNPACKED_INCRKEY flags in pPKey2 is set
3064** and the common prefixes are equal, then key1 is less than key2.
3065** Or if the UNPACKED_MATCH_PREFIX flag is set and the prefixes are
3066** equal, then the keys are considered to be equal and
drhec1fc802008-08-13 14:07:40 +00003067** the parts beyond the common prefix are ignored.
drh1e968a02008-03-25 00:22:21 +00003068*/
drhe14006d2008-03-25 17:23:32 +00003069int sqlite3VdbeRecordCompare(
drhec1fc802008-08-13 14:07:40 +00003070 int nKey1, const void *pKey1, /* Left key */
drhec1fc802008-08-13 14:07:40 +00003071 UnpackedRecord *pPKey2 /* Right key */
drh1e968a02008-03-25 00:22:21 +00003072){
drhdf003d62013-08-01 19:17:39 +00003073 u32 d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00003074 u32 idx1; /* Offset into aKey[] of next header element */
3075 u32 szHdr1; /* Number of bytes in header */
3076 int i = 0;
drh1e968a02008-03-25 00:22:21 +00003077 int rc = 0;
3078 const unsigned char *aKey1 = (const unsigned char *)pKey1;
3079 KeyInfo *pKeyInfo;
3080 Mem mem1;
3081
3082 pKeyInfo = pPKey2->pKeyInfo;
3083 mem1.enc = pKeyInfo->enc;
drh37272632009-11-16 21:28:45 +00003084 mem1.db = pKeyInfo->db;
drhd93a8b22009-11-16 03:13:40 +00003085 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
3086 VVA_ONLY( mem1.zMalloc = 0; ) /* Only needed by assert() statements */
drh8b249a82009-11-16 02:14:00 +00003087
3088 /* Compilers may complain that mem1.u.i is potentially uninitialized.
3089 ** We could initialize it, as shown here, to silence those complaints.
drh5275d2e2011-04-27 01:00:17 +00003090 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
drh8b249a82009-11-16 02:14:00 +00003091 ** the unnecessary initialization has a measurable negative performance
3092 ** impact, since this routine is a very high runner. And so, we choose
3093 ** to ignore the compiler warnings and leave this variable uninitialized.
3094 */
3095 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
drh1e968a02008-03-25 00:22:21 +00003096
shane3f8d5cf2008-04-24 19:15:09 +00003097 idx1 = getVarint32(aKey1, szHdr1);
drh1e968a02008-03-25 00:22:21 +00003098 d1 = szHdr1;
drhb2023662013-11-29 15:39:36 +00003099 assert( pKeyInfo->nField+pKeyInfo->nXField>=pPKey2->nField || CORRUPT_DB );
drhe1a022e2012-09-17 17:16:53 +00003100 assert( pKeyInfo->aSortOrder!=0 );
dan89bc0212013-12-03 09:49:52 +00003101 assert( pKeyInfo->nField>0 );
3102 assert( idx1<=szHdr1 || CORRUPT_DB );
drh0b9dada2013-11-25 22:24:36 +00003103 do{
drh1e968a02008-03-25 00:22:21 +00003104 u32 serial_type1;
3105
3106 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00003107 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drhaf5b2af2013-08-05 15:32:09 +00003108
3109 /* Verify that there is enough key space remaining to avoid
3110 ** a buffer overread. The "d1+serial_type1+2" subexpression will
3111 ** always be greater than or equal to the amount of required key space.
3112 ** Use that approximation to avoid the more expensive call to
3113 ** sqlite3VdbeSerialTypeLen() in the common case.
3114 */
3115 if( d1+serial_type1+2>(u32)nKey1
3116 && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
3117 ){
3118 break;
3119 }
drh1e968a02008-03-25 00:22:21 +00003120
3121 /* Extract the values to be compared.
3122 */
3123 d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
3124
3125 /* Do the comparison
3126 */
drh323df792013-08-05 19:11:29 +00003127 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
drh1e968a02008-03-25 00:22:21 +00003128 if( rc!=0 ){
drh8b249a82009-11-16 02:14:00 +00003129 assert( mem1.zMalloc==0 ); /* See comment below */
drh323df792013-08-05 19:11:29 +00003130 if( pKeyInfo->aSortOrder[i] ){
drh6f225d02013-10-26 13:36:51 +00003131 rc = -rc; /* Invert the result for DESC sort order. */
drh8b249a82009-11-16 02:14:00 +00003132 }
drh8b249a82009-11-16 02:14:00 +00003133 return rc;
drh1e968a02008-03-25 00:22:21 +00003134 }
3135 i++;
drh0b9dada2013-11-25 22:24:36 +00003136 }while( idx1<szHdr1 && i<pPKey2->nField );
drh407414c2009-07-14 14:15:27 +00003137
drh8b249a82009-11-16 02:14:00 +00003138 /* No memory allocation is ever used on mem1. Prove this using
3139 ** the following assert(). If the assert() fails, it indicates a
3140 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
danielk1977de630352009-05-04 11:42:29 +00003141 */
drh8b249a82009-11-16 02:14:00 +00003142 assert( mem1.zMalloc==0 );
danielk1977de630352009-05-04 11:42:29 +00003143
drh8b249a82009-11-16 02:14:00 +00003144 /* rc==0 here means that one of the keys ran out of fields and
3145 ** all the fields up to that point were equal. If the UNPACKED_INCRKEY
3146 ** flag is set, then break the tie by treating key2 as larger.
3147 ** If the UPACKED_PREFIX_MATCH flag is set, then keys with common prefixes
3148 ** are considered to be equal. Otherwise, the longer key is the
3149 ** larger. As it happens, the pPKey2 will always be the longer
3150 ** if there is a difference.
3151 */
3152 assert( rc==0 );
3153 if( pPKey2->flags & UNPACKED_INCRKEY ){
3154 rc = -1;
3155 }else if( pPKey2->flags & UNPACKED_PREFIX_MATCH ){
3156 /* Leave rc==0 */
3157 }else if( idx1<szHdr1 ){
3158 rc = 1;
drh1e968a02008-03-25 00:22:21 +00003159 }
drh1e968a02008-03-25 00:22:21 +00003160 return rc;
3161}
drhec1fc802008-08-13 14:07:40 +00003162
danielk1977eb015e02004-05-18 01:31:14 +00003163
3164/*
drh7a224de2004-06-02 01:22:02 +00003165** pCur points at an index entry created using the OP_MakeRecord opcode.
3166** Read the rowid (the last field in the record) and store it in *rowid.
3167** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00003168**
3169** pCur might be pointing to text obtained from a corrupt database file.
3170** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00003171*/
drh35f6b932009-06-23 14:15:04 +00003172int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00003173 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00003174 int rc;
drhd5788202004-05-28 08:21:05 +00003175 u32 szHdr; /* Size of the header */
3176 u32 typeRowid; /* Serial type of the rowid */
3177 u32 lenRowid; /* Size of the rowid */
3178 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00003179
shanecea72b22009-09-07 04:38:36 +00003180 UNUSED_PARAMETER(db);
3181
drh88a003e2008-12-11 16:17:03 +00003182 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00003183 ** than 2GiB are support - anything large must be database corruption.
3184 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00003185 ** this code can safely assume that nCellKey is 32-bits
3186 */
drhea8ffdf2009-07-22 00:35:23 +00003187 assert( sqlite3BtreeCursorIsValid(pCur) );
drhb07028f2011-10-14 21:49:18 +00003188 VVA_ONLY(rc =) sqlite3BtreeKeySize(pCur, &nCellKey);
drhc27ae612009-07-14 18:35:44 +00003189 assert( rc==SQLITE_OK ); /* pCur is always valid so KeySize cannot fail */
drh7b746032009-06-26 12:15:22 +00003190 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00003191
3192 /* Read in the complete content of the index entry */
drhff104c12009-08-25 13:10:27 +00003193 memset(&m, 0, sizeof(m));
drh501932c2013-11-21 21:59:53 +00003194 rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, 1, &m);
drhd5788202004-05-28 08:21:05 +00003195 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00003196 return rc;
3197 }
drh88a003e2008-12-11 16:17:03 +00003198
3199 /* The index entry must begin with a header size */
shane3f8d5cf2008-04-24 19:15:09 +00003200 (void)getVarint32((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00003201 testcase( szHdr==3 );
drh88a003e2008-12-11 16:17:03 +00003202 testcase( szHdr==m.n );
drh7b746032009-06-26 12:15:22 +00003203 if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
drh88a003e2008-12-11 16:17:03 +00003204 goto idx_rowid_corruption;
3205 }
3206
3207 /* The last field of the index should be an integer - the ROWID.
3208 ** Verify that the last entry really is an integer. */
shane3f8d5cf2008-04-24 19:15:09 +00003209 (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00003210 testcase( typeRowid==1 );
3211 testcase( typeRowid==2 );
3212 testcase( typeRowid==3 );
3213 testcase( typeRowid==4 );
3214 testcase( typeRowid==5 );
3215 testcase( typeRowid==6 );
3216 testcase( typeRowid==8 );
3217 testcase( typeRowid==9 );
3218 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
3219 goto idx_rowid_corruption;
3220 }
drhd5788202004-05-28 08:21:05 +00003221 lenRowid = sqlite3VdbeSerialTypeLen(typeRowid);
drheeb844a2009-08-08 18:01:07 +00003222 testcase( (u32)m.n==szHdr+lenRowid );
3223 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00003224 goto idx_rowid_corruption;
3225 }
3226
3227 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00003228 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00003229 *rowid = v.u.i;
danielk1977d8123362004-06-12 09:25:12 +00003230 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00003231 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00003232
3233 /* Jump here if database corruption is detected after m has been
3234 ** allocated. Free the m object and return SQLITE_CORRUPT. */
3235idx_rowid_corruption:
3236 testcase( m.zMalloc!=0 );
3237 sqlite3VdbeMemRelease(&m);
3238 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00003239}
3240
drh7cf6e4d2004-05-19 14:56:55 +00003241/*
drh5f82e3c2009-07-06 00:44:08 +00003242** Compare the key of the index entry that cursor pC is pointing to against
3243** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00003244** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00003245** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00003246**
drh5f82e3c2009-07-06 00:44:08 +00003247** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00003248** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00003249** is ignored as well. Hence, this routine only compares the prefixes
3250** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00003251*/
danielk1977183f9f72004-05-13 05:20:26 +00003252int sqlite3VdbeIdxKeyCompare(
drhdfe88ec2008-11-03 20:55:06 +00003253 VdbeCursor *pC, /* The cursor to compare against */
drh5f82e3c2009-07-06 00:44:08 +00003254 UnpackedRecord *pUnpacked, /* Unpacked version of key to compare against */
drh7cf6e4d2004-05-19 14:56:55 +00003255 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00003256){
drh61fc5952007-04-01 23:49:51 +00003257 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00003258 int rc;
danielk19773d1bfea2004-05-14 11:00:53 +00003259 BtCursor *pCur = pC->pCursor;
drhd5788202004-05-28 08:21:05 +00003260 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00003261
drhea8ffdf2009-07-22 00:35:23 +00003262 assert( sqlite3BtreeCursorIsValid(pCur) );
drhb07028f2011-10-14 21:49:18 +00003263 VVA_ONLY(rc =) sqlite3BtreeKeySize(pCur, &nCellKey);
drhc27ae612009-07-14 18:35:44 +00003264 assert( rc==SQLITE_OK ); /* pCur is always valid so KeySize cannot fail */
drh407414c2009-07-14 14:15:27 +00003265 /* nCellKey will always be between 0 and 0xffffffff because of the say
3266 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00003267 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00003268 *res = 0;
drh9978c972010-02-23 17:36:32 +00003269 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00003270 }
drhfd3ca1c2009-08-25 12:11:00 +00003271 memset(&m, 0, sizeof(m));
drh501932c2013-11-21 21:59:53 +00003272 rc = sqlite3VdbeMemFromBtree(pC->pCursor, 0, (u32)nCellKey, 1, &m);
drhec1fc802008-08-13 14:07:40 +00003273 if( rc ){
drhd5788202004-05-28 08:21:05 +00003274 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00003275 }
dan6f133232011-11-16 15:41:29 +00003276 assert( pUnpacked->flags & UNPACKED_PREFIX_MATCH );
drhe63d9992008-08-13 19:11:48 +00003277 *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
danielk1977d8123362004-06-12 09:25:12 +00003278 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00003279 return SQLITE_OK;
3280}
danielk1977b28af712004-06-21 06:50:26 +00003281
3282/*
3283** This routine sets the value to be returned by subsequent calls to
3284** sqlite3_changes() on the database handle 'db'.
3285*/
3286void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
drhb21c8cd2007-08-21 19:33:56 +00003287 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00003288 db->nChange = nChange;
3289 db->nTotalChange += nChange;
3290}
3291
3292/*
3293** Set a flag in the vdbe to update the change counter when it is finalised
3294** or reset.
3295*/
drh4794f732004-11-05 17:17:50 +00003296void sqlite3VdbeCountChanges(Vdbe *v){
3297 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00003298}
drhd89bd002005-01-22 03:03:54 +00003299
3300/*
3301** Mark every prepared statement associated with a database connection
3302** as expired.
3303**
3304** An expired statement means that recompilation of the statement is
3305** recommend. Statements expire when things happen that make their
3306** programs obsolete. Removing user-defined functions or collating
3307** sequences, or changing an authorization function are the types of
3308** things that make prepared statements obsolete.
3309*/
3310void sqlite3ExpirePreparedStatements(sqlite3 *db){
3311 Vdbe *p;
3312 for(p = db->pVdbe; p; p=p->pNext){
3313 p->expired = 1;
3314 }
3315}
danielk1977aee18ef2005-03-09 12:26:50 +00003316
3317/*
3318** Return the database associated with the Vdbe.
3319*/
3320sqlite3 *sqlite3VdbeDb(Vdbe *v){
3321 return v->db;
3322}
dan937d0de2009-10-15 18:35:38 +00003323
3324/*
3325** Return a pointer to an sqlite3_value structure containing the value bound
3326** parameter iVar of VM v. Except, if the value is an SQL NULL, return
3327** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
3328** constants) to the value before returning it.
3329**
3330** The returned value must be freed by the caller using sqlite3ValueFree().
3331*/
drhcf0fd4a2013-08-01 12:21:58 +00003332sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00003333 assert( iVar>0 );
3334 if( v ){
3335 Mem *pMem = &v->aVar[iVar-1];
3336 if( 0==(pMem->flags & MEM_Null) ){
3337 sqlite3_value *pRet = sqlite3ValueNew(v->db);
3338 if( pRet ){
3339 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
3340 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
3341 sqlite3VdbeMemStoreType((Mem *)pRet);
3342 }
3343 return pRet;
3344 }
3345 }
3346 return 0;
3347}
3348
3349/*
3350** Configure SQL variable iVar so that binding a new value to it signals
3351** to sqlite3_reoptimize() that re-preparing the statement may result
3352** in a better query plan.
3353*/
dan1d2ce4f2009-10-19 18:11:09 +00003354void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00003355 assert( iVar>0 );
3356 if( iVar>32 ){
dan1d2ce4f2009-10-19 18:11:09 +00003357 v->expmask = 0xffffffff;
dan937d0de2009-10-15 18:35:38 +00003358 }else{
dan1d2ce4f2009-10-19 18:11:09 +00003359 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00003360 }
3361}
dan016f7812013-08-21 17:35:48 +00003362
3363#ifndef SQLITE_OMIT_VIRTUALTABLE
3364/*
3365** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
3366** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
3367** in memory obtained from sqlite3DbMalloc).
3368*/
3369void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
3370 sqlite3 *db = p->db;
3371 sqlite3DbFree(db, p->zErrMsg);
3372 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
3373 sqlite3_free(pVtab->zErrMsg);
3374 pVtab->zErrMsg = 0;
3375}
3376#endif /* SQLITE_OMIT_VIRTUALTABLE */