blob: d31fb3e552c56b19f168c5b98b66f82a198ead30 [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.
danielk19779a9b1562008-04-24 08:31:51 +000016**
drh6be240e2009-07-14 02:33:02 +000017** $Id: vdbeaux.c,v 1.472 2009/07/14 02:33:02 drh Exp $
drh9a324642003-09-06 20:12:01 +000018*/
19#include "sqliteInt.h"
drh9a324642003-09-06 20:12:01 +000020#include "vdbeInt.h"
21
22
drh46c99e02007-08-27 23:26:59 +000023
drh9a324642003-09-06 20:12:01 +000024/*
25** When debugging the code generator in a symbolic debugger, one can
mlcreech3a00f902008-03-04 17:45:01 +000026** set the sqlite3VdbeAddopTrace to 1 and all opcodes will be printed
drh9a324642003-09-06 20:12:01 +000027** as they are added to the instruction stream.
28*/
drh8d904f02005-06-14 17:47:58 +000029#ifdef SQLITE_DEBUG
mlcreech3a00f902008-03-04 17:45:01 +000030int sqlite3VdbeAddopTrace = 0;
drh9a324642003-09-06 20:12:01 +000031#endif
32
33
34/*
35** Create a new virtual database engine.
36*/
drh9bb575f2004-09-06 17:24:11 +000037Vdbe *sqlite3VdbeCreate(sqlite3 *db){
drh9a324642003-09-06 20:12:01 +000038 Vdbe *p;
drh17435752007-08-16 04:30:38 +000039 p = sqlite3DbMallocZero(db, sizeof(Vdbe) );
drh9a324642003-09-06 20:12:01 +000040 if( p==0 ) return 0;
41 p->db = db;
42 if( db->pVdbe ){
43 db->pVdbe->pPrev = p;
44 }
45 p->pNext = db->pVdbe;
46 p->pPrev = 0;
47 db->pVdbe = p;
48 p->magic = VDBE_MAGIC_INIT;
49 return p;
50}
51
52/*
drhb900aaf2006-11-09 00:24:53 +000053** Remember the SQL string for a prepared statement.
54*/
danielk19776ab3a2e2009-02-19 14:39:25 +000055void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, int isPrepareV2){
drhb900aaf2006-11-09 00:24:53 +000056 if( p==0 ) return;
danielk19776ab3a2e2009-02-19 14:39:25 +000057#ifdef SQLITE_OMIT_TRACE
58 if( !isPrepareV2 ) return;
59#endif
drhb900aaf2006-11-09 00:24:53 +000060 assert( p->zSql==0 );
drh17435752007-08-16 04:30:38 +000061 p->zSql = sqlite3DbStrNDup(p->db, z, n);
shanec0688ea2009-03-05 03:48:06 +000062 p->isPrepareV2 = isPrepareV2 ? 1 : 0;
drhb900aaf2006-11-09 00:24:53 +000063}
64
65/*
66** Return the SQL associated with a prepared statement
67*/
danielk1977d0e2a852007-11-14 06:48:48 +000068const char *sqlite3_sql(sqlite3_stmt *pStmt){
danielk19776ab3a2e2009-02-19 14:39:25 +000069 Vdbe *p = (Vdbe *)pStmt;
70 return (p->isPrepareV2 ? p->zSql : 0);
drhb900aaf2006-11-09 00:24:53 +000071}
72
73/*
drhc5155252007-01-08 21:07:17 +000074** Swap all content between two VDBE structures.
drhb900aaf2006-11-09 00:24:53 +000075*/
drhc5155252007-01-08 21:07:17 +000076void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
77 Vdbe tmp, *pTmp;
78 char *zTmp;
drhc5155252007-01-08 21:07:17 +000079 tmp = *pA;
80 *pA = *pB;
81 *pB = tmp;
82 pTmp = pA->pNext;
83 pA->pNext = pB->pNext;
84 pB->pNext = pTmp;
85 pTmp = pA->pPrev;
86 pA->pPrev = pB->pPrev;
87 pB->pPrev = pTmp;
88 zTmp = pA->zSql;
89 pA->zSql = pB->zSql;
90 pB->zSql = zTmp;
danielk19776ab3a2e2009-02-19 14:39:25 +000091 pB->isPrepareV2 = pA->isPrepareV2;
drhb900aaf2006-11-09 00:24:53 +000092}
93
drhcf1023c2007-05-08 20:59:49 +000094#ifdef SQLITE_DEBUG
drhb900aaf2006-11-09 00:24:53 +000095/*
drh9a324642003-09-06 20:12:01 +000096** Turn tracing on or off
97*/
danielk19774adee202004-05-08 08:23:19 +000098void sqlite3VdbeTrace(Vdbe *p, FILE *trace){
drh9a324642003-09-06 20:12:01 +000099 p->trace = trace;
100}
drhcf1023c2007-05-08 20:59:49 +0000101#endif
drh9a324642003-09-06 20:12:01 +0000102
103/*
danielk197700e13612008-11-17 19:18:54 +0000104** Resize the Vdbe.aOp array so that it is at least one op larger than
105** it was.
danielk1977ace3eb22006-01-26 10:35:04 +0000106**
danielk197700e13612008-11-17 19:18:54 +0000107** If an out-of-memory error occurs while resizing the array, return
108** SQLITE_NOMEM. In this case Vdbe.aOp and Vdbe.nOpAlloc remain
109** unchanged (this is so that any opcodes already allocated can be
110** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +0000111*/
danielk197700e13612008-11-17 19:18:54 +0000112static int growOpArray(Vdbe *p){
drha4e5d582007-10-20 15:41:57 +0000113 VdbeOp *pNew;
danielk197700e13612008-11-17 19:18:54 +0000114 int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
115 pNew = sqlite3DbRealloc(p->db, p->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +0000116 if( pNew ){
drhb45f65d2009-03-01 19:42:11 +0000117 p->nOpAlloc = sqlite3DbMallocSize(p->db, pNew)/sizeof(Op);
drha4e5d582007-10-20 15:41:57 +0000118 p->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +0000119 }
danielk197700e13612008-11-17 19:18:54 +0000120 return (pNew ? SQLITE_OK : SQLITE_NOMEM);
drh76ff3a02004-09-24 22:32:30 +0000121}
122
123/*
drh9a324642003-09-06 20:12:01 +0000124** Add a new instruction to the list of instructions current in the
125** VDBE. Return the address of the new instruction.
126**
127** Parameters:
128**
129** p Pointer to the VDBE
130**
131** op The opcode for this instruction
132**
drh66a51672008-01-03 00:01:23 +0000133** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000134**
danielk19774adee202004-05-08 08:23:19 +0000135** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000136** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000137** operand.
138*/
drh66a51672008-01-03 00:01:23 +0000139int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000140 int i;
drh701a0ae2004-02-22 20:05:00 +0000141 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000142
143 i = p->nOp;
drh9a324642003-09-06 20:12:01 +0000144 assert( p->magic==VDBE_MAGIC_INIT );
drh8df32842008-12-09 02:51:23 +0000145 assert( op>0 && op<0xff );
drhfd2d26b2006-03-15 22:44:36 +0000146 if( p->nOpAlloc<=i ){
danielk197700e13612008-11-17 19:18:54 +0000147 if( growOpArray(p) ){
drhc42ed162009-06-26 14:04:51 +0000148 return 1;
drhfd2d26b2006-03-15 22:44:36 +0000149 }
drh9a324642003-09-06 20:12:01 +0000150 }
danielk197701256832007-04-18 14:24:32 +0000151 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000152 pOp = &p->aOp[i];
drh8df32842008-12-09 02:51:23 +0000153 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000154 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000155 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000156 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000157 pOp->p3 = p3;
158 pOp->p4.p = 0;
159 pOp->p4type = P4_NOTUSED;
drh55ef4d92005-08-14 01:20:37 +0000160 p->expired = 0;
danielk19778b60e0f2005-01-12 09:10:39 +0000161#ifdef SQLITE_DEBUG
drh26c9b5e2008-04-11 14:56:53 +0000162 pOp->zComment = 0;
mlcreech3a00f902008-03-04 17:45:01 +0000163 if( sqlite3VdbeAddopTrace ) sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +0000164#endif
drh26c9b5e2008-04-11 14:56:53 +0000165#ifdef VDBE_PROFILE
166 pOp->cycles = 0;
167 pOp->cnt = 0;
168#endif
drh9a324642003-09-06 20:12:01 +0000169 return i;
170}
drh66a51672008-01-03 00:01:23 +0000171int sqlite3VdbeAddOp0(Vdbe *p, int op){
172 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
173}
174int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
175 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
176}
177int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
178 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000179}
180
drh66a51672008-01-03 00:01:23 +0000181
drh701a0ae2004-02-22 20:05:00 +0000182/*
drh66a51672008-01-03 00:01:23 +0000183** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000184*/
drh66a51672008-01-03 00:01:23 +0000185int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000186 Vdbe *p, /* Add the opcode to this VM */
187 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000188 int p1, /* The P1 operand */
189 int p2, /* The P2 operand */
190 int p3, /* The P3 operand */
191 const char *zP4, /* The P4 operand */
192 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000193){
drh66a51672008-01-03 00:01:23 +0000194 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
195 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000196 return addr;
197}
198
199/*
drh9a324642003-09-06 20:12:01 +0000200** Create a new symbolic label for an instruction that has yet to be
201** coded. The symbolic label is really just a negative number. The
202** label can be used as the P2 value of an operation. Later, when
203** the label is resolved to a specific address, the VDBE will scan
204** through its operation list and change all values of P2 which match
205** the label into the resolved address.
206**
207** The VDBE knows that a P2 value is a label because labels are
208** always negative and P2 values are suppose to be non-negative.
209** Hence, a negative P2 value is a label that has yet to be resolved.
danielk1977b5548a82004-06-26 13:51:33 +0000210**
211** Zero is returned if a malloc() fails.
drh9a324642003-09-06 20:12:01 +0000212*/
danielk19774adee202004-05-08 08:23:19 +0000213int sqlite3VdbeMakeLabel(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000214 int i;
215 i = p->nLabel++;
216 assert( p->magic==VDBE_MAGIC_INIT );
217 if( i>=p->nLabelAlloc ){
drh6a1e0712008-12-05 15:24:15 +0000218 int n = p->nLabelAlloc*2 + 5;
danielk19771e536952007-08-16 10:09:01 +0000219 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
drh6a1e0712008-12-05 15:24:15 +0000220 n*sizeof(p->aLabel[0]));
221 p->nLabelAlloc = sqlite3DbMallocSize(p->db, p->aLabel)/sizeof(p->aLabel[0]);
drh9a324642003-09-06 20:12:01 +0000222 }
drh76ff3a02004-09-24 22:32:30 +0000223 if( p->aLabel ){
224 p->aLabel[i] = -1;
drh9a324642003-09-06 20:12:01 +0000225 }
drh9a324642003-09-06 20:12:01 +0000226 return -1-i;
227}
228
229/*
230** Resolve label "x" to be the address of the next instruction to
231** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000232** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000233*/
danielk19774adee202004-05-08 08:23:19 +0000234void sqlite3VdbeResolveLabel(Vdbe *p, int x){
drh76ff3a02004-09-24 22:32:30 +0000235 int j = -1-x;
drh9a324642003-09-06 20:12:01 +0000236 assert( p->magic==VDBE_MAGIC_INIT );
drh76ff3a02004-09-24 22:32:30 +0000237 assert( j>=0 && j<p->nLabel );
238 if( p->aLabel ){
239 p->aLabel[j] = p->nOp;
drh9a324642003-09-06 20:12:01 +0000240 }
241}
242
243/*
drh9cbf3422008-01-17 16:22:13 +0000244** Loop through the program looking for P2 values that are negative
245** on jump instructions. Each such value is a label. Resolve the
246** label by setting the P2 value to its correct non-zero value.
drh76ff3a02004-09-24 22:32:30 +0000247**
248** This routine is called once after all opcodes have been inserted.
danielk1977634f2982005-03-28 08:44:07 +0000249**
drh13449892005-09-07 21:22:45 +0000250** Variable *pMaxFuncArgs is set to the maximum value of any P2 argument
danielk1977399918f2006-06-14 13:03:23 +0000251** to an OP_Function, OP_AggStep or OP_VFilter opcode. This is used by
danielk1977634f2982005-03-28 08:44:07 +0000252** sqlite3VdbeMakeReady() to size the Vdbe.apArg[] array.
danielk1977bc04f852005-03-29 08:26:13 +0000253**
drh38449902005-06-07 01:43:41 +0000254** This routine also does the following optimization: It scans for
drh77658e22007-12-04 16:54:52 +0000255** instructions that might cause a statement rollback. Such instructions
256** are:
257**
258** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
259** * OP_Destroy
260** * OP_VUpdate
261** * OP_VRename
262**
263** If no such instruction is found, then every Statement instruction
264** is changed to a Noop. In this way, we avoid creating the statement
265** journal file unnecessarily.
drh76ff3a02004-09-24 22:32:30 +0000266*/
drh9cbf3422008-01-17 16:22:13 +0000267static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
drh76ff3a02004-09-24 22:32:30 +0000268 int i;
danielk1977bc04f852005-03-29 08:26:13 +0000269 int nMaxArgs = 0;
drh76ff3a02004-09-24 22:32:30 +0000270 Op *pOp;
271 int *aLabel = p->aLabel;
drh38449902005-06-07 01:43:41 +0000272 int doesStatementRollback = 0;
273 int hasStatementBegin = 0;
drhad4a4b82008-11-05 16:37:34 +0000274 p->readOnly = 1;
275 p->usesStmtJournal = 0;
drh76ff3a02004-09-24 22:32:30 +0000276 for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
danielk1977634f2982005-03-28 08:44:07 +0000277 u8 opcode = pOp->opcode;
278
drha2baf3a2008-06-18 15:34:09 +0000279 if( opcode==OP_Function || opcode==OP_AggStep ){
drh98757152008-01-09 23:04:12 +0000280 if( pOp->p5>nMaxArgs ) nMaxArgs = pOp->p5;
danielk1977399918f2006-06-14 13:03:23 +0000281#ifndef SQLITE_OMIT_VIRTUALTABLE
drha2baf3a2008-06-18 15:34:09 +0000282 }else if( opcode==OP_VUpdate ){
danielk1977bc04f852005-03-29 08:26:13 +0000283 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
drha2baf3a2008-06-18 15:34:09 +0000284#endif
danielk19775dfecba2008-06-23 13:57:21 +0000285 }
danielk1977182c4ba2007-06-27 15:53:34 +0000286 if( opcode==OP_Halt ){
drh38449902005-06-07 01:43:41 +0000287 if( pOp->p1==SQLITE_CONSTRAINT && pOp->p2==OE_Abort ){
288 doesStatementRollback = 1;
289 }
drh38449902005-06-07 01:43:41 +0000290 }else if( opcode==OP_Statement ){
291 hasStatementBegin = 1;
drhad4a4b82008-11-05 16:37:34 +0000292 p->usesStmtJournal = 1;
drh77658e22007-12-04 16:54:52 +0000293 }else if( opcode==OP_Destroy ){
294 doesStatementRollback = 1;
drhad4a4b82008-11-05 16:37:34 +0000295 }else if( opcode==OP_Transaction && pOp->p2!=0 ){
296 p->readOnly = 0;
danielk1977182c4ba2007-06-27 15:53:34 +0000297#ifndef SQLITE_OMIT_VIRTUALTABLE
298 }else if( opcode==OP_VUpdate || opcode==OP_VRename ){
299 doesStatementRollback = 1;
drh4be8b512006-06-13 23:51:34 +0000300 }else if( opcode==OP_VFilter ){
301 int n;
302 assert( p->nOp - i >= 3 );
drh4c583122008-01-04 22:01:03 +0000303 assert( pOp[-1].opcode==OP_Integer );
danielk19776dbee812008-01-03 18:39:41 +0000304 n = pOp[-1].p1;
drh4be8b512006-06-13 23:51:34 +0000305 if( n>nMaxArgs ) nMaxArgs = n;
danielk1977182c4ba2007-06-27 15:53:34 +0000306#endif
danielk1977bc04f852005-03-29 08:26:13 +0000307 }
danielk1977634f2982005-03-28 08:44:07 +0000308
drhd2981512008-01-04 19:33:49 +0000309 if( sqlite3VdbeOpcodeHasProperty(opcode, OPFLG_JUMP) && pOp->p2<0 ){
310 assert( -1-pOp->p2<p->nLabel );
311 pOp->p2 = aLabel[-1-pOp->p2];
312 }
drh76ff3a02004-09-24 22:32:30 +0000313 }
drh633e6d52008-07-28 19:34:53 +0000314 sqlite3DbFree(p->db, p->aLabel);
drh76ff3a02004-09-24 22:32:30 +0000315 p->aLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000316
317 *pMaxFuncArgs = nMaxArgs;
drh38449902005-06-07 01:43:41 +0000318
319 /* If we never rollback a statement transaction, then statement
320 ** transactions are not needed. So change every OP_Statement
drh66560ad2006-01-06 14:32:19 +0000321 ** opcode into an OP_Noop. This avoid a call to sqlite3OsOpenExclusive()
drh38449902005-06-07 01:43:41 +0000322 ** which can be expensive on some platforms.
323 */
324 if( hasStatementBegin && !doesStatementRollback ){
drhad4a4b82008-11-05 16:37:34 +0000325 p->usesStmtJournal = 0;
drh38449902005-06-07 01:43:41 +0000326 for(pOp=p->aOp, i=p->nOp-1; i>=0; i--, pOp++){
327 if( pOp->opcode==OP_Statement ){
328 pOp->opcode = OP_Noop;
329 }
330 }
331 }
drh76ff3a02004-09-24 22:32:30 +0000332}
333
334/*
drh9a324642003-09-06 20:12:01 +0000335** Return the address of the next instruction to be inserted.
336*/
danielk19774adee202004-05-08 08:23:19 +0000337int sqlite3VdbeCurrentAddr(Vdbe *p){
drh9a324642003-09-06 20:12:01 +0000338 assert( p->magic==VDBE_MAGIC_INIT );
339 return p->nOp;
340}
341
342/*
343** Add a whole list of operations to the operation stack. Return the
344** address of the first operation added.
345*/
danielk19774adee202004-05-08 08:23:19 +0000346int sqlite3VdbeAddOpList(Vdbe *p, int nOp, VdbeOpList const *aOp){
drh9a324642003-09-06 20:12:01 +0000347 int addr;
348 assert( p->magic==VDBE_MAGIC_INIT );
danielk197700e13612008-11-17 19:18:54 +0000349 if( p->nOp + nOp > p->nOpAlloc && growOpArray(p) ){
drh76ff3a02004-09-24 22:32:30 +0000350 return 0;
drh9a324642003-09-06 20:12:01 +0000351 }
352 addr = p->nOp;
drh7b746032009-06-26 12:15:22 +0000353 if( ALWAYS(nOp>0) ){
drh9a324642003-09-06 20:12:01 +0000354 int i;
drh905793e2004-02-21 13:31:09 +0000355 VdbeOpList const *pIn = aOp;
356 for(i=0; i<nOp; i++, pIn++){
357 int p2 = pIn->p2;
358 VdbeOp *pOut = &p->aOp[i+addr];
359 pOut->opcode = pIn->opcode;
360 pOut->p1 = pIn->p1;
drh8558cde2008-01-05 05:20:10 +0000361 if( p2<0 && sqlite3VdbeOpcodeHasProperty(pOut->opcode, OPFLG_JUMP) ){
362 pOut->p2 = addr + ADDR(p2);
363 }else{
364 pOut->p2 = p2;
365 }
drh24003452008-01-03 01:28:59 +0000366 pOut->p3 = pIn->p3;
367 pOut->p4type = P4_NOTUSED;
368 pOut->p4.p = 0;
369 pOut->p5 = 0;
danielk19778b60e0f2005-01-12 09:10:39 +0000370#ifdef SQLITE_DEBUG
drh26c9b5e2008-04-11 14:56:53 +0000371 pOut->zComment = 0;
mlcreech3a00f902008-03-04 17:45:01 +0000372 if( sqlite3VdbeAddopTrace ){
danielk19774adee202004-05-08 08:23:19 +0000373 sqlite3VdbePrintOp(0, i+addr, &p->aOp[i+addr]);
drh9a324642003-09-06 20:12:01 +0000374 }
375#endif
376 }
377 p->nOp += nOp;
378 }
379 return addr;
380}
381
382/*
383** Change the value of the P1 operand for a specific instruction.
384** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000385** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000386** few minor changes to the program.
387*/
danielk19774adee202004-05-08 08:23:19 +0000388void sqlite3VdbeChangeP1(Vdbe *p, int addr, int val){
drh7b746032009-06-26 12:15:22 +0000389 assert( p!=0 );
390 assert( addr>=0 );
391 if( p->nOp>addr ){
drh9a324642003-09-06 20:12:01 +0000392 p->aOp[addr].p1 = val;
393 }
394}
395
396/*
397** Change the value of the P2 operand for a specific instruction.
398** This routine is useful for setting a jump destination.
399*/
danielk19774adee202004-05-08 08:23:19 +0000400void sqlite3VdbeChangeP2(Vdbe *p, int addr, int val){
drh7b746032009-06-26 12:15:22 +0000401 assert( p!=0 );
402 assert( addr>=0 );
403 if( p->nOp>addr ){
drh9a324642003-09-06 20:12:01 +0000404 p->aOp[addr].p2 = val;
405 }
406}
407
drhd654be82005-09-20 17:42:23 +0000408/*
danielk19771f4aa332008-01-03 09:51:55 +0000409** Change the value of the P3 operand for a specific instruction.
danielk1977207872a2008-01-03 07:54:23 +0000410*/
411void sqlite3VdbeChangeP3(Vdbe *p, int addr, int val){
drh7b746032009-06-26 12:15:22 +0000412 assert( p!=0 );
413 assert( addr>=0 );
414 if( p->nOp>addr ){
danielk1977207872a2008-01-03 07:54:23 +0000415 p->aOp[addr].p3 = val;
416 }
417}
418
419/*
drh35573352008-01-08 23:54:25 +0000420** Change the value of the P5 operand for the most recently
421** added operation.
danielk19771f4aa332008-01-03 09:51:55 +0000422*/
drh35573352008-01-08 23:54:25 +0000423void sqlite3VdbeChangeP5(Vdbe *p, u8 val){
drh7b746032009-06-26 12:15:22 +0000424 assert( p!=0 );
425 if( p->aOp ){
drh35573352008-01-08 23:54:25 +0000426 assert( p->nOp>0 );
427 p->aOp[p->nOp-1].p5 = val;
danielk19771f4aa332008-01-03 09:51:55 +0000428 }
429}
430
431/*
drhf8875402006-03-17 13:56:34 +0000432** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +0000433** the address of the next instruction to be coded.
434*/
435void sqlite3VdbeJumpHere(Vdbe *p, int addr){
436 sqlite3VdbeChangeP2(p, addr, p->nOp);
437}
drhb38ad992005-09-16 00:27:01 +0000438
drhb7f6f682006-07-08 17:06:43 +0000439
440/*
441** If the input FuncDef structure is ephemeral, then free it. If
442** the FuncDef is not ephermal, then do nothing.
443*/
drh633e6d52008-07-28 19:34:53 +0000444static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drh7b746032009-06-26 12:15:22 +0000445 if( ALWAYS(pDef) && (pDef->flags & SQLITE_FUNC_EPHEM)!=0 ){
drh633e6d52008-07-28 19:34:53 +0000446 sqlite3DbFree(db, pDef);
drhb7f6f682006-07-08 17:06:43 +0000447 }
448}
449
drhb38ad992005-09-16 00:27:01 +0000450/*
drh66a51672008-01-03 00:01:23 +0000451** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +0000452*/
drh633e6d52008-07-28 19:34:53 +0000453static void freeP4(sqlite3 *db, int p4type, void *p4){
drh0acb7e42008-06-25 00:12:41 +0000454 if( p4 ){
drh66a51672008-01-03 00:01:23 +0000455 switch( p4type ){
456 case P4_REAL:
457 case P4_INT64:
458 case P4_MPRINTF:
459 case P4_DYNAMIC:
460 case P4_KEYINFO:
drh0acb7e42008-06-25 00:12:41 +0000461 case P4_INTARRAY:
drh66a51672008-01-03 00:01:23 +0000462 case P4_KEYINFO_HANDOFF: {
drh633e6d52008-07-28 19:34:53 +0000463 sqlite3DbFree(db, p4);
drhac1733d2005-09-17 17:58:22 +0000464 break;
465 }
drh66a51672008-01-03 00:01:23 +0000466 case P4_VDBEFUNC: {
drh0acb7e42008-06-25 00:12:41 +0000467 VdbeFunc *pVdbeFunc = (VdbeFunc *)p4;
drh633e6d52008-07-28 19:34:53 +0000468 freeEphemeralFunction(db, pVdbeFunc->pFunc);
drhac1733d2005-09-17 17:58:22 +0000469 sqlite3VdbeDeleteAuxData(pVdbeFunc, 0);
drh633e6d52008-07-28 19:34:53 +0000470 sqlite3DbFree(db, pVdbeFunc);
drhac1733d2005-09-17 17:58:22 +0000471 break;
472 }
drh66a51672008-01-03 00:01:23 +0000473 case P4_FUNCDEF: {
drh633e6d52008-07-28 19:34:53 +0000474 freeEphemeralFunction(db, (FuncDef*)p4);
drhb7f6f682006-07-08 17:06:43 +0000475 break;
476 }
drh66a51672008-01-03 00:01:23 +0000477 case P4_MEM: {
drh0acb7e42008-06-25 00:12:41 +0000478 sqlite3ValueFree((sqlite3_value*)p4);
drhac1733d2005-09-17 17:58:22 +0000479 break;
480 }
drhb38ad992005-09-16 00:27:01 +0000481 }
482 }
483}
484
485
drh9a324642003-09-06 20:12:01 +0000486/*
drhf8875402006-03-17 13:56:34 +0000487** Change N opcodes starting at addr to No-ops.
488*/
489void sqlite3VdbeChangeToNoop(Vdbe *p, int addr, int N){
drh7b746032009-06-26 12:15:22 +0000490 if( p->aOp ){
danielk197792d4d7a2007-05-04 12:05:56 +0000491 VdbeOp *pOp = &p->aOp[addr];
drh633e6d52008-07-28 19:34:53 +0000492 sqlite3 *db = p->db;
danielk197792d4d7a2007-05-04 12:05:56 +0000493 while( N-- ){
drh633e6d52008-07-28 19:34:53 +0000494 freeP4(db, pOp->p4type, pOp->p4.p);
danielk197792d4d7a2007-05-04 12:05:56 +0000495 memset(pOp, 0, sizeof(pOp[0]));
496 pOp->opcode = OP_Noop;
497 pOp++;
498 }
drhf8875402006-03-17 13:56:34 +0000499 }
500}
501
502/*
drh66a51672008-01-03 00:01:23 +0000503** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +0000504** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +0000505** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +0000506** few minor changes to the program.
507**
drh66a51672008-01-03 00:01:23 +0000508** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +0000509** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +0000510** A value of n==0 means copy bytes of zP4 up to and including the
511** first null byte. If n>0 then copy n+1 bytes of zP4.
drh9a324642003-09-06 20:12:01 +0000512**
drh66a51672008-01-03 00:01:23 +0000513** If n==P4_KEYINFO it means that zP4 is a pointer to a KeyInfo structure.
danielk19771f55c052005-05-19 08:42:59 +0000514** A copy is made of the KeyInfo structure into memory obtained from
drh17435752007-08-16 04:30:38 +0000515** sqlite3_malloc, to be freed when the Vdbe is finalized.
drh66a51672008-01-03 00:01:23 +0000516** n==P4_KEYINFO_HANDOFF indicates that zP4 points to a KeyInfo structure
drh17435752007-08-16 04:30:38 +0000517** stored in memory that the caller has obtained from sqlite3_malloc. The
danielk19771f55c052005-05-19 08:42:59 +0000518** caller should not free the allocation, it will be freed when the Vdbe is
519** finalized.
520**
drh66a51672008-01-03 00:01:23 +0000521** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +0000522** to a string or structure that is guaranteed to exist for the lifetime of
523** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +0000524**
drh66a51672008-01-03 00:01:23 +0000525** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +0000526*/
drh66a51672008-01-03 00:01:23 +0000527void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +0000528 Op *pOp;
drh633e6d52008-07-28 19:34:53 +0000529 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +0000530 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +0000531 db = p->db;
drh91fd4d42008-01-19 20:11:25 +0000532 assert( p->magic==VDBE_MAGIC_INIT );
drh633e6d52008-07-28 19:34:53 +0000533 if( p->aOp==0 || db->mallocFailed ){
drh66a51672008-01-03 00:01:23 +0000534 if (n != P4_KEYINFO) {
drh633e6d52008-07-28 19:34:53 +0000535 freeP4(db, n, (void*)*(char**)&zP4);
danielk1977261919c2005-12-06 12:52:59 +0000536 }
danielk1977d5d56522005-03-16 12:15:20 +0000537 return;
538 }
drh7b746032009-06-26 12:15:22 +0000539 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +0000540 assert( addr<p->nOp );
541 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +0000542 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +0000543 }
544 pOp = &p->aOp[addr];
drh633e6d52008-07-28 19:34:53 +0000545 freeP4(db, pOp->p4type, pOp->p4.p);
drh66a51672008-01-03 00:01:23 +0000546 pOp->p4.p = 0;
drh98757152008-01-09 23:04:12 +0000547 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +0000548 /* Note: this cast is safe, because the origin data point was an int
549 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +0000550 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +0000551 pOp->p4type = P4_INT32;
drh98757152008-01-09 23:04:12 +0000552 }else if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +0000553 pOp->p4.p = 0;
554 pOp->p4type = P4_NOTUSED;
555 }else if( n==P4_KEYINFO ){
drhd3d39e92004-05-20 22:16:29 +0000556 KeyInfo *pKeyInfo;
557 int nField, nByte;
drh4db38a72005-09-01 12:16:28 +0000558
drh66a51672008-01-03 00:01:23 +0000559 nField = ((KeyInfo*)zP4)->nField;
drhfdd6e852005-12-16 01:06:16 +0000560 nByte = sizeof(*pKeyInfo) + (nField-1)*sizeof(pKeyInfo->aColl[0]) + nField;
drhe5ae5732008-06-15 02:51:47 +0000561 pKeyInfo = sqlite3Malloc( nByte );
danielk19772dca4ac2008-01-03 11:50:29 +0000562 pOp->p4.pKeyInfo = pKeyInfo;
drhd3d39e92004-05-20 22:16:29 +0000563 if( pKeyInfo ){
drhb21e7c72008-06-22 12:37:57 +0000564 u8 *aSortOrder;
drh66a51672008-01-03 00:01:23 +0000565 memcpy(pKeyInfo, zP4, nByte);
drhfdd6e852005-12-16 01:06:16 +0000566 aSortOrder = pKeyInfo->aSortOrder;
567 if( aSortOrder ){
danielk1977bab45c62006-01-16 15:14:27 +0000568 pKeyInfo->aSortOrder = (unsigned char*)&pKeyInfo->aColl[nField];
drhfdd6e852005-12-16 01:06:16 +0000569 memcpy(pKeyInfo->aSortOrder, aSortOrder, nField);
570 }
drh66a51672008-01-03 00:01:23 +0000571 pOp->p4type = P4_KEYINFO;
drhd3d39e92004-05-20 22:16:29 +0000572 }else{
drh17435752007-08-16 04:30:38 +0000573 p->db->mallocFailed = 1;
drh66a51672008-01-03 00:01:23 +0000574 pOp->p4type = P4_NOTUSED;
drhd3d39e92004-05-20 22:16:29 +0000575 }
drh66a51672008-01-03 00:01:23 +0000576 }else if( n==P4_KEYINFO_HANDOFF ){
danielk19772dca4ac2008-01-03 11:50:29 +0000577 pOp->p4.p = (void*)zP4;
drh66a51672008-01-03 00:01:23 +0000578 pOp->p4type = P4_KEYINFO;
drh9a324642003-09-06 20:12:01 +0000579 }else if( n<0 ){
danielk19772dca4ac2008-01-03 11:50:29 +0000580 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +0000581 pOp->p4type = (signed char)n;
drh9a324642003-09-06 20:12:01 +0000582 }else{
drhea678832008-12-10 19:26:22 +0000583 if( n==0 ) n = sqlite3Strlen30(zP4);
danielk19772dca4ac2008-01-03 11:50:29 +0000584 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
drh66a51672008-01-03 00:01:23 +0000585 pOp->p4type = P4_DYNAMIC;
drh9a324642003-09-06 20:12:01 +0000586 }
587}
588
drhad6d9462004-09-19 02:15:24 +0000589#ifndef NDEBUG
590/*
drh16ee60f2008-06-20 18:13:25 +0000591** Change the comment on the the most recently coded instruction. Or
592** insert a No-op and add the comment to that new instruction. This
593** makes the code easier to read during debugging. None of this happens
594** in a production build.
drhad6d9462004-09-19 02:15:24 +0000595*/
596void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
597 va_list ap;
danielk197701256832007-04-18 14:24:32 +0000598 assert( p->nOp>0 || p->aOp==0 );
drhd4e70eb2008-01-02 00:34:36 +0000599 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
danielk1977dba01372008-01-05 18:44:29 +0000600 if( p->nOp ){
drh8cc74322008-01-15 02:22:24 +0000601 char **pz = &p->aOp[p->nOp-1].zComment;
danielk1977dba01372008-01-05 18:44:29 +0000602 va_start(ap, zFormat);
drh633e6d52008-07-28 19:34:53 +0000603 sqlite3DbFree(p->db, *pz);
drh8cc74322008-01-15 02:22:24 +0000604 *pz = sqlite3VMPrintf(p->db, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +0000605 va_end(ap);
606 }
drhad6d9462004-09-19 02:15:24 +0000607}
drh16ee60f2008-06-20 18:13:25 +0000608void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
609 va_list ap;
610 sqlite3VdbeAddOp0(p, OP_Noop);
611 assert( p->nOp>0 || p->aOp==0 );
612 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
613 if( p->nOp ){
614 char **pz = &p->aOp[p->nOp-1].zComment;
615 va_start(ap, zFormat);
drh633e6d52008-07-28 19:34:53 +0000616 sqlite3DbFree(p->db, *pz);
drh16ee60f2008-06-20 18:13:25 +0000617 *pz = sqlite3VMPrintf(p->db, zFormat, ap);
618 va_end(ap);
619 }
620}
621#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +0000622
drh9a324642003-09-06 20:12:01 +0000623/*
drh20411ea2009-05-29 19:00:12 +0000624** Return the opcode for a given address. If the address is -1, then
625** return the most recently inserted opcode.
626**
627** If a memory allocation error has occurred prior to the calling of this
628** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
629** is readable and writable, but it has no effect. The return of a dummy
630** opcode allows the call to continue functioning after a OOM fault without
631** having to check to see if the return from this routine is a valid pointer.
drh37b89a02009-06-19 00:33:31 +0000632**
633** About the #ifdef SQLITE_OMIT_TRACE: Normally, this routine is never called
634** unless p->nOp>0. This is because in the absense of SQLITE_OMIT_TRACE,
635** an OP_Trace instruction is always inserted by sqlite3VdbeGet() as soon as
636** a new VDBE is created. So we are free to set addr to p->nOp-1 without
637** having to double-check to make sure that the result is non-negative. But
638** if SQLITE_OMIT_TRACE is defined, the OP_Trace is omitted and we do need to
639** check the value of p->nOp-1 before continuing.
drh9a324642003-09-06 20:12:01 +0000640*/
danielk19774adee202004-05-08 08:23:19 +0000641VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drh20411ea2009-05-29 19:00:12 +0000642 static VdbeOp dummy;
drh9a324642003-09-06 20:12:01 +0000643 assert( p->magic==VDBE_MAGIC_INIT );
drh37b89a02009-06-19 00:33:31 +0000644 if( addr<0 ){
645#ifdef SQLITE_OMIT_TRACE
646 if( p->nOp==0 ) return &dummy;
647#endif
648 addr = p->nOp - 1;
649 }
drh17435752007-08-16 04:30:38 +0000650 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +0000651 if( p->db->mallocFailed ){
652 return &dummy;
653 }else{
654 return &p->aOp[addr];
655 }
drh9a324642003-09-06 20:12:01 +0000656}
657
drhb7f91642004-10-31 02:22:47 +0000658#if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) \
659 || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +0000660/*
drh66a51672008-01-03 00:01:23 +0000661** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +0000662** Use zTemp for any required temporary buffer space.
663*/
drh66a51672008-01-03 00:01:23 +0000664static char *displayP4(Op *pOp, char *zTemp, int nTemp){
665 char *zP4 = zTemp;
drhd3d39e92004-05-20 22:16:29 +0000666 assert( nTemp>=20 );
drh66a51672008-01-03 00:01:23 +0000667 switch( pOp->p4type ){
drh16ee60f2008-06-20 18:13:25 +0000668 case P4_KEYINFO_STATIC:
drh66a51672008-01-03 00:01:23 +0000669 case P4_KEYINFO: {
drhd3d39e92004-05-20 22:16:29 +0000670 int i, j;
danielk19772dca4ac2008-01-03 11:50:29 +0000671 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
drh5bb3eb92007-05-04 13:15:55 +0000672 sqlite3_snprintf(nTemp, zTemp, "keyinfo(%d", pKeyInfo->nField);
drhea678832008-12-10 19:26:22 +0000673 i = sqlite3Strlen30(zTemp);
drhd3d39e92004-05-20 22:16:29 +0000674 for(j=0; j<pKeyInfo->nField; j++){
675 CollSeq *pColl = pKeyInfo->aColl[j];
676 if( pColl ){
drhea678832008-12-10 19:26:22 +0000677 int n = sqlite3Strlen30(pColl->zName);
drhd3d39e92004-05-20 22:16:29 +0000678 if( i+n>nTemp-6 ){
drh5bb3eb92007-05-04 13:15:55 +0000679 memcpy(&zTemp[i],",...",4);
drhd3d39e92004-05-20 22:16:29 +0000680 break;
681 }
682 zTemp[i++] = ',';
drhffbc3082004-05-21 01:29:06 +0000683 if( pKeyInfo->aSortOrder && pKeyInfo->aSortOrder[j] ){
drhd3d39e92004-05-20 22:16:29 +0000684 zTemp[i++] = '-';
685 }
drh5bb3eb92007-05-04 13:15:55 +0000686 memcpy(&zTemp[i], pColl->zName,n+1);
drhd3d39e92004-05-20 22:16:29 +0000687 i += n;
688 }else if( i+4<nTemp-6 ){
drh5bb3eb92007-05-04 13:15:55 +0000689 memcpy(&zTemp[i],",nil",4);
drhd3d39e92004-05-20 22:16:29 +0000690 i += 4;
691 }
692 }
693 zTemp[i++] = ')';
694 zTemp[i] = 0;
695 assert( i<nTemp );
drhd3d39e92004-05-20 22:16:29 +0000696 break;
697 }
drh66a51672008-01-03 00:01:23 +0000698 case P4_COLLSEQ: {
danielk19772dca4ac2008-01-03 11:50:29 +0000699 CollSeq *pColl = pOp->p4.pColl;
drh5bb3eb92007-05-04 13:15:55 +0000700 sqlite3_snprintf(nTemp, zTemp, "collseq(%.20s)", pColl->zName);
drhd3d39e92004-05-20 22:16:29 +0000701 break;
702 }
drh66a51672008-01-03 00:01:23 +0000703 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +0000704 FuncDef *pDef = pOp->p4.pFunc;
drha967e882006-06-13 01:04:52 +0000705 sqlite3_snprintf(nTemp, zTemp, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +0000706 break;
707 }
drh66a51672008-01-03 00:01:23 +0000708 case P4_INT64: {
danielk19772dca4ac2008-01-03 11:50:29 +0000709 sqlite3_snprintf(nTemp, zTemp, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +0000710 break;
711 }
drh66a51672008-01-03 00:01:23 +0000712 case P4_INT32: {
713 sqlite3_snprintf(nTemp, zTemp, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +0000714 break;
715 }
drh66a51672008-01-03 00:01:23 +0000716 case P4_REAL: {
danielk19772dca4ac2008-01-03 11:50:29 +0000717 sqlite3_snprintf(nTemp, zTemp, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +0000718 break;
719 }
drh66a51672008-01-03 00:01:23 +0000720 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +0000721 Mem *pMem = pOp->p4.pMem;
drhc4dd3fd2008-01-22 01:48:05 +0000722 assert( (pMem->flags & MEM_Null)==0 );
drhd4e70eb2008-01-02 00:34:36 +0000723 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +0000724 zP4 = pMem->z;
drhd4e70eb2008-01-02 00:34:36 +0000725 }else if( pMem->flags & MEM_Int ){
726 sqlite3_snprintf(nTemp, zTemp, "%lld", pMem->u.i);
727 }else if( pMem->flags & MEM_Real ){
728 sqlite3_snprintf(nTemp, zTemp, "%.16g", pMem->r);
drhd4e70eb2008-01-02 00:34:36 +0000729 }
drh598f1342007-10-23 15:39:45 +0000730 break;
731 }
drha967e882006-06-13 01:04:52 +0000732#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +0000733 case P4_VTAB: {
danielk19772dca4ac2008-01-03 11:50:29 +0000734 sqlite3_vtab *pVtab = pOp->p4.pVtab;
drh19146192006-06-26 19:10:32 +0000735 sqlite3_snprintf(nTemp, zTemp, "vtab:%p:%p", pVtab, pVtab->pModule);
drha967e882006-06-13 01:04:52 +0000736 break;
737 }
738#endif
drh0acb7e42008-06-25 00:12:41 +0000739 case P4_INTARRAY: {
740 sqlite3_snprintf(nTemp, zTemp, "intarray");
741 break;
742 }
drhd3d39e92004-05-20 22:16:29 +0000743 default: {
danielk19772dca4ac2008-01-03 11:50:29 +0000744 zP4 = pOp->p4.z;
drh949f9cd2008-01-12 21:35:57 +0000745 if( zP4==0 ){
drh66a51672008-01-03 00:01:23 +0000746 zP4 = zTemp;
drhd4e70eb2008-01-02 00:34:36 +0000747 zTemp[0] = 0;
drhd3d39e92004-05-20 22:16:29 +0000748 }
749 }
750 }
drh66a51672008-01-03 00:01:23 +0000751 assert( zP4!=0 );
drh66a51672008-01-03 00:01:23 +0000752 return zP4;
drhd3d39e92004-05-20 22:16:29 +0000753}
drhb7f91642004-10-31 02:22:47 +0000754#endif
drhd3d39e92004-05-20 22:16:29 +0000755
drh900b31e2007-08-28 02:27:51 +0000756/*
drhd0679ed2007-08-28 22:24:34 +0000757** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
758**
drh900b31e2007-08-28 02:27:51 +0000759*/
drhfb982642007-08-30 01:19:59 +0000760void sqlite3VdbeUsesBtree(Vdbe *p, int i){
761 int mask;
drh3500ed62009-05-05 15:46:43 +0000762 assert( i>=0 && i<p->db->nDb && i<sizeof(u32)*8 );
danielk197700e13612008-11-17 19:18:54 +0000763 assert( i<(int)sizeof(p->btreeMask)*8 );
drh3500ed62009-05-05 15:46:43 +0000764 mask = ((u32)1)<<i;
drhfb982642007-08-30 01:19:59 +0000765 if( (p->btreeMask & mask)==0 ){
766 p->btreeMask |= mask;
767 sqlite3BtreeMutexArrayInsert(&p->aMutex, p->db->aDb[i].pBt);
768 }
drh900b31e2007-08-28 02:27:51 +0000769}
770
drhd3d39e92004-05-20 22:16:29 +0000771
danielk19778b60e0f2005-01-12 09:10:39 +0000772#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +0000773/*
774** Print a single opcode. This routine is used for debugging only.
775*/
danielk19774adee202004-05-08 08:23:19 +0000776void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
drh66a51672008-01-03 00:01:23 +0000777 char *zP4;
drhd3d39e92004-05-20 22:16:29 +0000778 char zPtr[50];
drh1db639c2008-01-17 02:36:28 +0000779 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-4s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +0000780 if( pOut==0 ) pOut = stdout;
drh66a51672008-01-03 00:01:23 +0000781 zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
danielk197711641c12008-01-03 08:18:30 +0000782 fprintf(pOut, zFormat1, pc,
drh1db639c2008-01-17 02:36:28 +0000783 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
784#ifdef SQLITE_DEBUG
785 pOp->zComment ? pOp->zComment : ""
786#else
787 ""
788#endif
789 );
drh9a324642003-09-06 20:12:01 +0000790 fflush(pOut);
791}
792#endif
793
794/*
drh76ff3a02004-09-24 22:32:30 +0000795** Release an array of N Mem elements
796*/
drhc890fec2008-08-01 20:10:08 +0000797static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +0000798 if( p && N ){
danielk1977e972e032008-09-19 18:32:26 +0000799 Mem *pEnd;
danielk1977a7a8e142008-02-13 18:25:27 +0000800 sqlite3 *db = p->db;
drh8df32842008-12-09 02:51:23 +0000801 u8 malloc_failed = db->mallocFailed;
danielk1977e972e032008-09-19 18:32:26 +0000802 for(pEnd=&p[N]; p<pEnd; p++){
803 assert( (&p[1])==pEnd || p[0].db==p[1].db );
804
805 /* This block is really an inlined version of sqlite3VdbeMemRelease()
806 ** that takes advantage of the fact that the memory cell value is
807 ** being set to NULL after releasing any dynamic resources.
808 **
809 ** The justification for duplicating code is that according to
810 ** callgrind, this causes a certain test case to hit the CPU 4.7
811 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
812 ** sqlite3MemRelease() were called from here. With -O2, this jumps
813 ** to 6.6 percent. The test case is inserting 1000 rows into a table
814 ** with no indexes using a single prepared INSERT statement, bind()
815 ** and reset(). Inserts are grouped into a transaction.
816 */
817 if( p->flags&(MEM_Agg|MEM_Dyn) ){
818 sqlite3VdbeMemRelease(p);
819 }else if( p->zMalloc ){
820 sqlite3DbFree(db, p->zMalloc);
821 p->zMalloc = 0;
822 }
823
danielk19775f096132008-03-28 15:44:09 +0000824 p->flags = MEM_Null;
drh76ff3a02004-09-24 22:32:30 +0000825 }
danielk1977a7a8e142008-02-13 18:25:27 +0000826 db->mallocFailed = malloc_failed;
drh76ff3a02004-09-24 22:32:30 +0000827 }
828}
829
danielk1977dfb316d2008-03-26 18:34:43 +0000830#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
831int sqlite3VdbeReleaseBuffers(Vdbe *p){
832 int ii;
833 int nFree = 0;
834 assert( sqlite3_mutex_held(p->db->mutex) );
835 for(ii=1; ii<=p->nMem; ii++){
836 Mem *pMem = &p->aMem[ii];
drh3d4501e2008-12-04 20:40:10 +0000837 if( pMem->flags & MEM_RowSet ){
838 sqlite3RowSetClear(pMem->u.pRowSet);
839 }
danielk1977dfb316d2008-03-26 18:34:43 +0000840 if( pMem->z && pMem->flags&MEM_Dyn ){
841 assert( !pMem->xDel );
drh633e6d52008-07-28 19:34:53 +0000842 nFree += sqlite3DbMallocSize(pMem->db, pMem->z);
danielk1977dfb316d2008-03-26 18:34:43 +0000843 sqlite3VdbeMemRelease(pMem);
844 }
845 }
846 return nFree;
847}
848#endif
849
drhb7f91642004-10-31 02:22:47 +0000850#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +0000851/*
drh9a324642003-09-06 20:12:01 +0000852** Give a listing of the program in the virtual machine.
853**
danielk19774adee202004-05-08 08:23:19 +0000854** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +0000855** running the code, it invokes the callback once for each instruction.
856** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +0000857**
858** When p->explain==1, each instruction is listed. When
859** p->explain==2, only OP_Explain instructions are listed and these
860** are shown in a different format. p->explain==2 is used to implement
861** EXPLAIN QUERY PLAN.
drh9a324642003-09-06 20:12:01 +0000862*/
danielk19774adee202004-05-08 08:23:19 +0000863int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +0000864 Vdbe *p /* The VDBE */
865){
drh9bb575f2004-09-06 17:24:11 +0000866 sqlite3 *db = p->db;
drh9a324642003-09-06 20:12:01 +0000867 int i;
drh826fb5a2004-02-14 23:59:57 +0000868 int rc = SQLITE_OK;
drh9cbf3422008-01-17 16:22:13 +0000869 Mem *pMem = p->pResultSet = &p->aMem[1];
drh9a324642003-09-06 20:12:01 +0000870
drh9a324642003-09-06 20:12:01 +0000871 assert( p->explain );
drh5f82e3c2009-07-06 00:44:08 +0000872 assert( p->magic==VDBE_MAGIC_RUN );
drhc5cdca62005-01-11 16:54:14 +0000873 assert( db->magic==SQLITE_MAGIC_BUSY );
danielk19776c359f02008-11-21 16:58:03 +0000874 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +0000875
drh9cbf3422008-01-17 16:22:13 +0000876 /* Even though this opcode does not use dynamic strings for
877 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +0000878 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +0000879 */
drhc890fec2008-08-01 20:10:08 +0000880 releaseMemArray(pMem, p->nMem);
danielk197718f41892004-05-22 07:27:46 +0000881
danielk19776c359f02008-11-21 16:58:03 +0000882 if( p->rc==SQLITE_NOMEM ){
883 /* This happens if a malloc() inside a call to sqlite3_column_text() or
884 ** sqlite3_column_text16() failed. */
885 db->mallocFailed = 1;
886 return SQLITE_ERROR;
887 }
888
drhecc92422005-09-10 16:46:12 +0000889 do{
890 i = p->pc++;
891 }while( i<p->nOp && p->explain==2 && p->aOp[i].opcode!=OP_Explain );
drh826fb5a2004-02-14 23:59:57 +0000892 if( i>=p->nOp ){
893 p->rc = SQLITE_OK;
894 rc = SQLITE_DONE;
drh881feaa2006-07-26 01:39:30 +0000895 }else if( db->u1.isInterrupted ){
drhc5cdca62005-01-11 16:54:14 +0000896 p->rc = SQLITE_INTERRUPT;
drh826fb5a2004-02-14 23:59:57 +0000897 rc = SQLITE_ERROR;
drhf089aa42008-07-08 19:34:06 +0000898 sqlite3SetString(&p->zErrMsg, db, "%s", sqlite3ErrStr(p->rc));
drh826fb5a2004-02-14 23:59:57 +0000899 }else{
danielk1977a7a8e142008-02-13 18:25:27 +0000900 char *z;
drhd3d39e92004-05-20 22:16:29 +0000901 Op *pOp = &p->aOp[i];
danielk19770d78bae2008-01-03 07:09:48 +0000902 if( p->explain==1 ){
903 pMem->flags = MEM_Int;
904 pMem->type = SQLITE_INTEGER;
905 pMem->u.i = i; /* Program counter */
906 pMem++;
907
908 pMem->flags = MEM_Static|MEM_Str|MEM_Term;
909 pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
910 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +0000911 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +0000912 pMem->type = SQLITE_TEXT;
913 pMem->enc = SQLITE_UTF8;
914 pMem++;
915 }
drheb2e1762004-05-27 01:53:56 +0000916
917 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +0000918 pMem->u.i = pOp->p1; /* P1 */
drh9c054832004-05-31 18:51:57 +0000919 pMem->type = SQLITE_INTEGER;
drheb2e1762004-05-27 01:53:56 +0000920 pMem++;
921
922 pMem->flags = MEM_Int;
drh3c024d62007-03-30 11:23:45 +0000923 pMem->u.i = pOp->p2; /* P2 */
drh9c054832004-05-31 18:51:57 +0000924 pMem->type = SQLITE_INTEGER;
drheb2e1762004-05-27 01:53:56 +0000925 pMem++;
926
danielk19770d78bae2008-01-03 07:09:48 +0000927 if( p->explain==1 ){
928 pMem->flags = MEM_Int;
929 pMem->u.i = pOp->p3; /* P3 */
930 pMem->type = SQLITE_INTEGER;
931 pMem++;
932 }
933
danielk1977a7a8e142008-02-13 18:25:27 +0000934 if( sqlite3VdbeMemGrow(pMem, 32, 0) ){ /* P4 */
danielk1977357864e2009-03-25 15:43:08 +0000935 assert( p->db->mallocFailed );
936 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +0000937 }
938 pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
939 z = displayP4(pOp, pMem->z, 32);
940 if( z!=pMem->z ){
941 sqlite3VdbeMemSetStr(pMem, z, -1, SQLITE_UTF8, 0);
942 }else{
943 assert( pMem->z!=0 );
drhea678832008-12-10 19:26:22 +0000944 pMem->n = sqlite3Strlen30(pMem->z);
danielk1977a7a8e142008-02-13 18:25:27 +0000945 pMem->enc = SQLITE_UTF8;
946 }
drh9c054832004-05-31 18:51:57 +0000947 pMem->type = SQLITE_TEXT;
danielk19770d78bae2008-01-03 07:09:48 +0000948 pMem++;
drheb2e1762004-05-27 01:53:56 +0000949
danielk19770d78bae2008-01-03 07:09:48 +0000950 if( p->explain==1 ){
drh85e5f0d2008-02-19 18:28:13 +0000951 if( sqlite3VdbeMemGrow(pMem, 4, 0) ){
danielk1977357864e2009-03-25 15:43:08 +0000952 assert( p->db->mallocFailed );
953 return SQLITE_ERROR;
danielk1977a7a8e142008-02-13 18:25:27 +0000954 }
955 pMem->flags = MEM_Dyn|MEM_Str|MEM_Term;
drh85e5f0d2008-02-19 18:28:13 +0000956 pMem->n = 2;
957 sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
danielk19770d78bae2008-01-03 07:09:48 +0000958 pMem->type = SQLITE_TEXT;
959 pMem->enc = SQLITE_UTF8;
960 pMem++;
961
drhaa9b8962008-01-08 02:57:55 +0000962#ifdef SQLITE_DEBUG
danielk19770d78bae2008-01-03 07:09:48 +0000963 if( pOp->zComment ){
964 pMem->flags = MEM_Str|MEM_Term;
965 pMem->z = pOp->zComment;
drhea678832008-12-10 19:26:22 +0000966 pMem->n = sqlite3Strlen30(pMem->z);
danielk19770d78bae2008-01-03 07:09:48 +0000967 pMem->enc = SQLITE_UTF8;
danielk19771e522b42008-09-16 09:09:19 +0000968 pMem->type = SQLITE_TEXT;
drh52391cb2008-02-14 23:44:13 +0000969 }else
drhaa9b8962008-01-08 02:57:55 +0000970#endif
drh52391cb2008-02-14 23:44:13 +0000971 {
972 pMem->flags = MEM_Null; /* Comment */
973 pMem->type = SQLITE_NULL;
974 }
danielk19770d78bae2008-01-03 07:09:48 +0000975 }
976
977 p->nResColumn = 8 - 5*(p->explain-1);
drh826fb5a2004-02-14 23:59:57 +0000978 p->rc = SQLITE_OK;
979 rc = SQLITE_ROW;
drh9a324642003-09-06 20:12:01 +0000980 }
drh826fb5a2004-02-14 23:59:57 +0000981 return rc;
drh9a324642003-09-06 20:12:01 +0000982}
drhb7f91642004-10-31 02:22:47 +0000983#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +0000984
drh7c4ac0c2007-04-05 11:25:58 +0000985#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +0000986/*
drh3f7d4e42004-07-24 14:35:58 +0000987** Print the SQL that was used to generate a VDBE program.
988*/
989void sqlite3VdbePrintSql(Vdbe *p){
drh3f7d4e42004-07-24 14:35:58 +0000990 int nOp = p->nOp;
991 VdbeOp *pOp;
drhc16a03b2004-09-15 13:38:10 +0000992 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +0000993 pOp = &p->aOp[0];
994 if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
danielk19772dca4ac2008-01-03 11:50:29 +0000995 const char *z = pOp->p4.z;
danielk197778ca0e72009-01-20 16:53:39 +0000996 while( sqlite3Isspace(*z) ) z++;
drh3f7d4e42004-07-24 14:35:58 +0000997 printf("SQL: [%s]\n", z);
998 }
drh3f7d4e42004-07-24 14:35:58 +0000999}
drh7c4ac0c2007-04-05 11:25:58 +00001000#endif
drh3f7d4e42004-07-24 14:35:58 +00001001
drh602c2372007-03-01 00:29:13 +00001002#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
1003/*
1004** Print an IOTRACE message showing SQL content.
1005*/
1006void sqlite3VdbeIOTraceSql(Vdbe *p){
1007 int nOp = p->nOp;
1008 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00001009 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00001010 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00001011 pOp = &p->aOp[0];
1012 if( pOp->opcode==OP_Trace && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00001013 int i, j;
drh00a18e42007-08-13 11:10:34 +00001014 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00001015 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00001016 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00001017 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00001018 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00001019 if( z[i-1]!=' ' ){
1020 z[j++] = ' ';
1021 }
1022 }else{
1023 z[j++] = z[i];
1024 }
1025 }
1026 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00001027 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00001028 }
1029}
1030#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
1031
drhb2771ce2009-02-20 01:28:59 +00001032/*
1033** Allocate space from a fixed size buffer. Make *pp point to the
1034** allocated space. (Note: pp is a char* rather than a void** to
1035** work around the pointer aliasing rules of C.) *pp should initially
1036** be zero. If *pp is not zero, that means that the space has already
1037** been allocated and this routine is a noop.
1038**
1039** nByte is the number of bytes of space needed.
1040**
1041** *ppFrom point to available space and pEnd points to the end of the
1042** available space.
1043**
1044** *pnByte is a counter of the number of bytes of space that have failed
1045** to allocate. If there is insufficient space in *ppFrom to satisfy the
danielk1977d336e222009-02-20 10:58:41 +00001046** request, then increment *pnByte by the amount of the request.
drhb2771ce2009-02-20 01:28:59 +00001047*/
1048static void allocSpace(
1049 char *pp, /* IN/OUT: Set *pp to point to allocated buffer */
1050 int nByte, /* Number of bytes to allocate */
1051 u8 **ppFrom, /* IN/OUT: Allocate from *ppFrom */
danielk1977d336e222009-02-20 10:58:41 +00001052 u8 *pEnd, /* Pointer to 1 byte past the end of *ppFrom buffer */
drhb2771ce2009-02-20 01:28:59 +00001053 int *pnByte /* If allocation cannot be made, increment *pnByte */
1054){
drhea598cb2009-04-05 12:22:08 +00001055 assert( EIGHT_BYTE_ALIGNMENT(*ppFrom) );
drhb2771ce2009-02-20 01:28:59 +00001056 if( (*(void**)pp)==0 ){
danielk1977bc739712009-03-23 04:33:32 +00001057 nByte = ROUND8(nByte);
drhb2771ce2009-02-20 01:28:59 +00001058 if( (pEnd - *ppFrom)>=nByte ){
1059 *(void**)pp = (void *)*ppFrom;
1060 *ppFrom += nByte;
1061 }else{
1062 *pnByte += nByte;
1063 }
1064 }
1065}
drh602c2372007-03-01 00:29:13 +00001066
drh3f7d4e42004-07-24 14:35:58 +00001067/*
drh9a324642003-09-06 20:12:01 +00001068** Prepare a virtual machine for execution. This involves things such
1069** as allocating stack space and initializing the program counter.
1070** After the VDBE has be prepped, it can be executed by one or more
danielk19774adee202004-05-08 08:23:19 +00001071** calls to sqlite3VdbeExec().
drh92f02c32004-09-02 14:57:08 +00001072**
1073** This is the only way to move a VDBE from VDBE_MAGIC_INIT to
1074** VDBE_MAGIC_RUN.
danielk19776ab3a2e2009-02-19 14:39:25 +00001075**
1076** This function may be called more than once on a single virtual machine.
1077** The first call is made while compiling the SQL statement. Subsequent
1078** calls are made as part of the process of resetting a statement to be
1079** re-executed (from a call to sqlite3_reset()). The nVar, nMem, nCursor
1080** and isExplain parameters are only passed correct values the first time
1081** the function is called. On subsequent calls, from sqlite3_reset(), nVar
1082** is passed -1 and nMem, nCursor and isExplain are all passed zero.
drh9a324642003-09-06 20:12:01 +00001083*/
danielk19774adee202004-05-08 08:23:19 +00001084void sqlite3VdbeMakeReady(
drh9a324642003-09-06 20:12:01 +00001085 Vdbe *p, /* The VDBE */
drh7c972de2003-09-06 22:18:07 +00001086 int nVar, /* Number of '?' see in the SQL statement */
drh290c1942004-08-21 17:54:45 +00001087 int nMem, /* Number of memory cells to allocate */
1088 int nCursor, /* Number of cursors to allocate */
drh9a324642003-09-06 20:12:01 +00001089 int isExplain /* True if the EXPLAIN keywords is present */
1090){
1091 int n;
danielk19771e536952007-08-16 10:09:01 +00001092 sqlite3 *db = p->db;
drh9a324642003-09-06 20:12:01 +00001093
1094 assert( p!=0 );
drh9a324642003-09-06 20:12:01 +00001095 assert( p->magic==VDBE_MAGIC_INIT );
1096
drhc16a03b2004-09-15 13:38:10 +00001097 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00001098 */
drhc16a03b2004-09-15 13:38:10 +00001099 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00001100
danielk197700e13612008-11-17 19:18:54 +00001101 /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
danielk1977634f2982005-03-28 08:44:07 +00001102 p->magic = VDBE_MAGIC_RUN;
1103
danielk1977cd3e8f72008-03-25 09:47:35 +00001104 /* For each cursor required, also allocate a memory cell. Memory
1105 ** cells (nMem+1-nCursor)..nMem, inclusive, will never be used by
1106 ** the vdbe program. Instead they are used to allocate space for
drhdfe88ec2008-11-03 20:55:06 +00001107 ** VdbeCursor/BtCursor structures. The blob of memory associated with
danielk1977cd3e8f72008-03-25 09:47:35 +00001108 ** cursor 0 is stored in memory cell nMem. Memory cell (nMem-1)
1109 ** stores the blob of memory associated with cursor 1, etc.
1110 **
1111 ** See also: allocateCursor().
1112 */
1113 nMem += nCursor;
1114
danielk19776ab3a2e2009-02-19 14:39:25 +00001115 /* Allocate space for memory registers, SQL variables, VDBE cursors and
1116 ** an array to marshal SQL function arguments in. This is only done the
1117 ** first time this function is called for a given VDBE, not when it is
1118 ** being called from sqlite3_reset() to reset the virtual machine.
drh9a324642003-09-06 20:12:01 +00001119 */
drh5f82e3c2009-07-06 00:44:08 +00001120 if( nVar>=0 && ALWAYS(db->mallocFailed==0) ){
drhb2771ce2009-02-20 01:28:59 +00001121 u8 *zCsr = (u8 *)&p->aOp[p->nOp];
1122 u8 *zEnd = (u8 *)&p->aOp[p->nOpAlloc];
danielk19776ab3a2e2009-02-19 14:39:25 +00001123 int nByte;
danielk1977634f2982005-03-28 08:44:07 +00001124 int nArg; /* Maximum number of args passed to a user function. */
drh9cbf3422008-01-17 16:22:13 +00001125 resolveP2Values(p, &nArg);
drh9cbf3422008-01-17 16:22:13 +00001126 if( isExplain && nMem<10 ){
drhc46f5202008-11-04 14:25:06 +00001127 nMem = 10;
drh0f7eb612006-08-08 13:51:43 +00001128 }
drhea598cb2009-04-05 12:22:08 +00001129 zCsr += (zCsr - (u8*)0)&7;
1130 assert( EIGHT_BYTE_ALIGNMENT(zCsr) );
drh3c6d9a42009-04-06 11:11:42 +00001131 if( zEnd<zCsr ) zEnd = zCsr;
drhb2771ce2009-02-20 01:28:59 +00001132
1133 do {
1134 memset(zCsr, 0, zEnd-zCsr);
1135 nByte = 0;
1136 allocSpace((char*)&p->aMem, nMem*sizeof(Mem), &zCsr, zEnd, &nByte);
1137 allocSpace((char*)&p->aVar, nVar*sizeof(Mem), &zCsr, zEnd, &nByte);
1138 allocSpace((char*)&p->apArg, nArg*sizeof(Mem*), &zCsr, zEnd, &nByte);
1139 allocSpace((char*)&p->azVar, nVar*sizeof(char*), &zCsr, zEnd, &nByte);
1140 allocSpace((char*)&p->apCsr,
1141 nCursor*sizeof(VdbeCursor*), &zCsr, zEnd, &nByte
1142 );
1143 if( nByte ){
1144 p->pFree = sqlite3DbMallocRaw(db, nByte);
1145 }
1146 zCsr = p->pFree;
1147 zEnd = &zCsr[nByte];
1148 }while( nByte && !db->mallocFailed );
1149
shane36840fd2009-06-26 16:32:13 +00001150 p->nCursor = (u16)nCursor;
drhb2771ce2009-02-20 01:28:59 +00001151 if( p->aVar ){
shane36840fd2009-06-26 16:32:13 +00001152 p->nVar = (u16)nVar;
drh290c1942004-08-21 17:54:45 +00001153 for(n=0; n<nVar; n++){
1154 p->aVar[n].flags = MEM_Null;
drhb21c8cd2007-08-21 19:33:56 +00001155 p->aVar[n].db = db;
1156 }
drhb2771ce2009-02-20 01:28:59 +00001157 }
1158 if( p->aMem ){
1159 p->aMem--; /* aMem[] goes from 1..nMem */
1160 p->nMem = nMem; /* not from 0..nMem-1 */
drh9cbf3422008-01-17 16:22:13 +00001161 for(n=1; n<=nMem; n++){
1162 p->aMem[n].flags = MEM_Null;
1163 p->aMem[n].db = db;
drh290c1942004-08-21 17:54:45 +00001164 }
danielk197754db47e2004-05-19 10:36:43 +00001165 }
drh82a48512003-09-06 22:45:20 +00001166 }
drh9cbf3422008-01-17 16:22:13 +00001167#ifdef SQLITE_DEBUG
1168 for(n=1; n<p->nMem; n++){
1169 assert( p->aMem[n].db==db );
danielk1977b3bce662005-01-29 08:32:43 +00001170 }
drh9cbf3422008-01-17 16:22:13 +00001171#endif
drh9a324642003-09-06 20:12:01 +00001172
danielk19771d850a72004-05-31 08:26:49 +00001173 p->pc = -1;
drh9a324642003-09-06 20:12:01 +00001174 p->rc = SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00001175 p->errorAction = OE_Abort;
drh9a324642003-09-06 20:12:01 +00001176 p->explain |= isExplain;
1177 p->magic = VDBE_MAGIC_RUN;
danielk1977b28af712004-06-21 06:50:26 +00001178 p->nChange = 0;
drh76873ab2006-01-07 18:48:26 +00001179 p->cacheCtr = 1;
drhd946db02005-12-29 19:23:06 +00001180 p->minWriteFileFormat = 255;
danielk1977bd434552009-03-18 10:33:00 +00001181 p->iStatement = 0;
drh9a324642003-09-06 20:12:01 +00001182#ifdef VDBE_PROFILE
drhcf64d8b2003-12-31 17:57:10 +00001183 {
1184 int i;
1185 for(i=0; i<p->nOp; i++){
1186 p->aOp[i].cnt = 0;
1187 p->aOp[i].cycles = 0;
1188 }
drh9a324642003-09-06 20:12:01 +00001189 }
1190#endif
1191}
1192
drh9a324642003-09-06 20:12:01 +00001193/*
danielk1977cd3e8f72008-03-25 09:47:35 +00001194** Close a VDBE cursor and release all the resources that cursor
1195** happens to hold.
drh9a324642003-09-06 20:12:01 +00001196*/
drhdfe88ec2008-11-03 20:55:06 +00001197void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh4774b132004-06-12 20:12:51 +00001198 if( pCx==0 ){
1199 return;
1200 }
drh9a324642003-09-06 20:12:01 +00001201 if( pCx->pBt ){
danielk19774adee202004-05-08 08:23:19 +00001202 sqlite3BtreeClose(pCx->pBt);
drh34004ce2008-07-11 16:15:17 +00001203 /* The pCx->pCursor will be close automatically, if it exists, by
1204 ** the call above. */
1205 }else if( pCx->pCursor ){
1206 sqlite3BtreeCloseCursor(pCx->pCursor);
drh9a324642003-09-06 20:12:01 +00001207 }
drh9eff6162006-06-12 21:59:13 +00001208#ifndef SQLITE_OMIT_VIRTUALTABLE
1209 if( pCx->pVtabCursor ){
1210 sqlite3_vtab_cursor *pVtabCursor = pCx->pVtabCursor;
danielk1977be718892006-06-23 08:05:19 +00001211 const sqlite3_module *pModule = pCx->pModule;
1212 p->inVtabMethod = 1;
drh7e8b8482008-01-23 03:03:05 +00001213 (void)sqlite3SafetyOff(p->db);
drh9eff6162006-06-12 21:59:13 +00001214 pModule->xClose(pVtabCursor);
drh7e8b8482008-01-23 03:03:05 +00001215 (void)sqlite3SafetyOn(p->db);
danielk1977be718892006-06-23 08:05:19 +00001216 p->inVtabMethod = 0;
drh9eff6162006-06-12 21:59:13 +00001217 }
1218#endif
danielk19779882d992008-03-27 17:59:01 +00001219 if( !pCx->ephemPseudoTable ){
drh633e6d52008-07-28 19:34:53 +00001220 sqlite3DbFree(p->db, pCx->pData);
danielk19779882d992008-03-27 17:59:01 +00001221 }
drh9a324642003-09-06 20:12:01 +00001222}
1223
1224/*
drh5f82e3c2009-07-06 00:44:08 +00001225** Close all cursors.
drh9a324642003-09-06 20:12:01 +00001226*/
drh5f82e3c2009-07-06 00:44:08 +00001227static void closeAllCursors(Vdbe *p){
drh9a324642003-09-06 20:12:01 +00001228 int i;
drh290c1942004-08-21 17:54:45 +00001229 if( p->apCsr==0 ) return;
drh9a324642003-09-06 20:12:01 +00001230 for(i=0; i<p->nCursor; i++){
drhdfe88ec2008-11-03 20:55:06 +00001231 VdbeCursor *pC = p->apCsr[i];
drh5f82e3c2009-07-06 00:44:08 +00001232 if( pC ){
drhff0587c2007-08-29 17:43:19 +00001233 sqlite3VdbeFreeCursor(p, pC);
danielk1977b7a2f2e2006-06-23 11:34:54 +00001234 p->apCsr[i] = 0;
danielk1977be718892006-06-23 08:05:19 +00001235 }
drh9a324642003-09-06 20:12:01 +00001236 }
drh9a324642003-09-06 20:12:01 +00001237}
1238
1239/*
drh9a324642003-09-06 20:12:01 +00001240** Clean up the VM after execution.
1241**
1242** This routine will automatically close any cursors, lists, and/or
1243** sorters that were left open. It also deletes the values of
drh5a12e682004-05-19 11:24:25 +00001244** variables in the aVar[] array.
drh9a324642003-09-06 20:12:01 +00001245*/
drhc890fec2008-08-01 20:10:08 +00001246static void Cleanup(Vdbe *p){
drh9a324642003-09-06 20:12:01 +00001247 int i;
drh633e6d52008-07-28 19:34:53 +00001248 sqlite3 *db = p->db;
drh3d4501e2008-12-04 20:40:10 +00001249 Mem *pMem;
drh5f82e3c2009-07-06 00:44:08 +00001250 closeAllCursors(p);
drh3d4501e2008-12-04 20:40:10 +00001251 for(pMem=&p->aMem[1], i=1; i<=p->nMem; i++, pMem++){
1252 if( pMem->flags & MEM_RowSet ){
1253 sqlite3RowSetClear(pMem->u.pRowSet);
1254 }
1255 MemSetTypeFlag(pMem, MEM_Null);
danielk1977a7a8e142008-02-13 18:25:27 +00001256 }
drhc890fec2008-08-01 20:10:08 +00001257 releaseMemArray(&p->aMem[1], p->nMem);
drh76ff3a02004-09-24 22:32:30 +00001258 if( p->contextStack ){
drh633e6d52008-07-28 19:34:53 +00001259 sqlite3DbFree(db, p->contextStack);
drh344737f2004-09-19 00:50:20 +00001260 }
drh5f968432004-02-21 19:02:30 +00001261 p->contextStack = 0;
drh344737f2004-09-19 00:50:20 +00001262 p->contextStackDepth = 0;
1263 p->contextStackTop = 0;
drh633e6d52008-07-28 19:34:53 +00001264 sqlite3DbFree(db, p->zErrMsg);
drh9a324642003-09-06 20:12:01 +00001265 p->zErrMsg = 0;
drhd4e70eb2008-01-02 00:34:36 +00001266 p->pResultSet = 0;
drh9a324642003-09-06 20:12:01 +00001267}
1268
1269/*
danielk197722322fd2004-05-25 23:35:17 +00001270** Set the number of result columns that will be returned by this SQL
1271** statement. This is now set at compile time, rather than during
1272** execution of the vdbe program so that sqlite3_column_count() can
1273** be called on an SQL statement before sqlite3_step().
1274*/
1275void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00001276 Mem *pColName;
1277 int n;
drh633e6d52008-07-28 19:34:53 +00001278 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00001279
drhc890fec2008-08-01 20:10:08 +00001280 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00001281 sqlite3DbFree(db, p->aColName);
danielk1977955de522006-02-10 02:27:42 +00001282 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00001283 p->nResColumn = (u16)nResColumn;
drh633e6d52008-07-28 19:34:53 +00001284 p->aColName = pColName = (Mem*)sqlite3DbMallocZero(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00001285 if( p->aColName==0 ) return;
1286 while( n-- > 0 ){
drh4a50aac2007-08-23 02:47:53 +00001287 pColName->flags = MEM_Null;
drh153c62c2007-08-24 03:51:33 +00001288 pColName->db = p->db;
drh4a50aac2007-08-23 02:47:53 +00001289 pColName++;
drh76ff3a02004-09-24 22:32:30 +00001290 }
danielk197722322fd2004-05-25 23:35:17 +00001291}
1292
1293/*
danielk19773cf86062004-05-26 10:11:05 +00001294** Set the name of the idx'th column to be returned by the SQL statement.
1295** zName must be a pointer to a nul terminated string.
1296**
1297** This call must be made after a call to sqlite3VdbeSetNumCols().
1298**
danielk197710fb7492008-10-31 10:53:22 +00001299** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
1300** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
1301** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00001302*/
danielk197710fb7492008-10-31 10:53:22 +00001303int sqlite3VdbeSetColName(
1304 Vdbe *p, /* Vdbe being configured */
1305 int idx, /* Index of column zName applies to */
1306 int var, /* One of the COLNAME_* constants */
1307 const char *zName, /* Pointer to buffer containing name */
1308 void (*xDel)(void*) /* Memory management strategy for zName */
1309){
danielk19773cf86062004-05-26 10:11:05 +00001310 int rc;
1311 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00001312 assert( idx<p->nResColumn );
1313 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00001314 if( p->db->mallocFailed ){
1315 assert( !zName || xDel!=SQLITE_DYNAMIC );
1316 return SQLITE_NOMEM;
1317 }
drh76ff3a02004-09-24 22:32:30 +00001318 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00001319 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00001320 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00001321 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00001322 return rc;
1323}
1324
danielk197713adf8a2004-06-03 16:08:41 +00001325/*
1326** A read or write transaction may or may not be active on database handle
1327** db. If a transaction is active, commit it. If there is a
1328** write-transaction spanning more than one database file, this routine
1329** takes care of the master journal trickery.
1330*/
danielk19773e3a84d2008-08-01 17:37:40 +00001331static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00001332 int i;
1333 int nTrans = 0; /* Number of databases with an active write-transaction */
1334 int rc = SQLITE_OK;
1335 int needXcommit = 0;
1336
shane36840fd2009-06-26 16:32:13 +00001337#ifdef SQLITE_OMIT_VIRTUALTABLE
1338 /* With this option, sqlite3VtabSync() is defined to be simply
1339 ** SQLITE_OK so p is not used.
1340 */
1341 UNUSED_PARAMETER(p);
1342#endif
1343
danielk19775bd270b2006-07-25 15:14:52 +00001344 /* Before doing anything else, call the xSync() callback for any
1345 ** virtual module tables written in this transaction. This has to
1346 ** be done before determining whether a master journal file is
1347 ** required, as an xSync() callback may add an attached database
1348 ** to the transaction.
1349 */
danielk19773e3a84d2008-08-01 17:37:40 +00001350 rc = sqlite3VtabSync(db, &p->zErrMsg);
danielk19775bd270b2006-07-25 15:14:52 +00001351 if( rc!=SQLITE_OK ){
1352 return rc;
1353 }
1354
1355 /* This loop determines (a) if the commit hook should be invoked and
1356 ** (b) how many database files have open write transactions, not
1357 ** including the temp database. (b) is important because if more than
1358 ** one database file has an open write transaction, a master journal
1359 ** file is required for an atomic commit.
1360 */
danielk197713adf8a2004-06-03 16:08:41 +00001361 for(i=0; i<db->nDb; i++){
1362 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00001363 if( sqlite3BtreeIsInTrans(pBt) ){
danielk197713adf8a2004-06-03 16:08:41 +00001364 needXcommit = 1;
1365 if( i!=1 ) nTrans++;
1366 }
1367 }
1368
1369 /* If there are any write-transactions at all, invoke the commit hook */
1370 if( needXcommit && db->xCommitCallback ){
drh7e8b8482008-01-23 03:03:05 +00001371 (void)sqlite3SafetyOff(db);
drh92f02c32004-09-02 14:57:08 +00001372 rc = db->xCommitCallback(db->pCommitArg);
drh7e8b8482008-01-23 03:03:05 +00001373 (void)sqlite3SafetyOn(db);
drh92f02c32004-09-02 14:57:08 +00001374 if( rc ){
danielk197713adf8a2004-06-03 16:08:41 +00001375 return SQLITE_CONSTRAINT;
1376 }
1377 }
1378
danielk197740b38dc2004-06-26 08:38:24 +00001379 /* The simple case - no more than one database file (not counting the
1380 ** TEMP database) has a transaction active. There is no need for the
drh2ac3ee92004-06-07 16:27:46 +00001381 ** master-journal.
drhc9e06862004-06-09 20:03:08 +00001382 **
danielk197740b38dc2004-06-26 08:38:24 +00001383 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00001384 ** string, it means the main database is :memory: or a temp file. In
1385 ** that case we do not support atomic multi-file commits, so use the
1386 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00001387 */
drhea678832008-12-10 19:26:22 +00001388 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
1389 || nTrans<=1
1390 ){
danielk197704103022009-02-03 16:51:24 +00001391 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001392 Btree *pBt = db->aDb[i].pBt;
1393 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00001394 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00001395 }
1396 }
1397
drh80e35f42007-03-30 14:06:34 +00001398 /* Do the commit only if all databases successfully complete phase 1.
1399 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
1400 ** IO error while deleting or truncating a journal file. It is unlikely,
1401 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00001402 */
1403 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
1404 Btree *pBt = db->aDb[i].pBt;
1405 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00001406 rc = sqlite3BtreeCommitPhaseTwo(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00001407 }
danielk1977979f38e2007-03-27 16:19:51 +00001408 }
1409 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00001410 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00001411 }
1412 }
1413
1414 /* The complex case - There is a multi-file write-transaction active.
1415 ** This requires a master journal file to ensure the transaction is
1416 ** committed atomicly.
1417 */
danielk197744ee5bf2005-05-27 09:41:12 +00001418#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00001419 else{
danielk1977b4b47412007-08-17 15:53:36 +00001420 sqlite3_vfs *pVfs = db->pVfs;
drh2c8997b2005-08-27 16:36:48 +00001421 int needSync = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001422 char *zMaster = 0; /* File-name for the master journal */
1423 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
danielk1977b4b47412007-08-17 15:53:36 +00001424 sqlite3_file *pMaster = 0;
danielk197762079062007-08-15 17:08:46 +00001425 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00001426 int res;
danielk197713adf8a2004-06-03 16:08:41 +00001427
1428 /* Select a master journal file name */
1429 do {
drhdc5ea5c2008-12-10 17:19:59 +00001430 u32 iRandom;
drh633e6d52008-07-28 19:34:53 +00001431 sqlite3DbFree(db, zMaster);
drhdc5ea5c2008-12-10 17:19:59 +00001432 sqlite3_randomness(sizeof(iRandom), &iRandom);
1433 zMaster = sqlite3MPrintf(db, "%s-mj%08X", zMainFile, iRandom&0x7fffffff);
danielk197713adf8a2004-06-03 16:08:41 +00001434 if( !zMaster ){
1435 return SQLITE_NOMEM;
1436 }
danielk1977861f7452008-06-05 11:39:11 +00001437 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
1438 }while( rc==SQLITE_OK && res );
1439 if( rc==SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001440 /* Open the master journal. */
1441 rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
1442 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
1443 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
1444 );
1445 }
danielk197713adf8a2004-06-03 16:08:41 +00001446 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00001447 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001448 return rc;
1449 }
1450
1451 /* Write the name of each database file in the transaction into the new
1452 ** master journal file. If an error occurs at this point close
1453 ** and delete the master journal file. All the individual journal files
1454 ** still have 'null' as the master journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00001455 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00001456 */
danielk19771e536952007-08-16 10:09:01 +00001457 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001458 Btree *pBt = db->aDb[i].pBt;
drhc9e06862004-06-09 20:03:08 +00001459 if( i==1 ) continue; /* Ignore the TEMP database */
drhd0679ed2007-08-28 22:24:34 +00001460 if( sqlite3BtreeIsInTrans(pBt) ){
danielk19775865e3d2004-06-14 06:03:57 +00001461 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drhc9e06862004-06-09 20:03:08 +00001462 if( zFile[0]==0 ) continue; /* Ignore :memory: databases */
drh2c8997b2005-08-27 16:36:48 +00001463 if( !needSync && !sqlite3BtreeSyncDisabled(pBt) ){
1464 needSync = 1;
1465 }
drhea678832008-12-10 19:26:22 +00001466 rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
1467 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00001468 if( rc!=SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001469 sqlite3OsCloseFree(pMaster);
1470 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00001471 sqlite3DbFree(db, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001472 return rc;
1473 }
1474 }
1475 }
1476
danielk19779663b8f2007-08-24 11:52:28 +00001477 /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
1478 ** flag is set this is not required.
1479 */
danielk1977bea2a942009-01-20 17:06:27 +00001480 if( needSync
1481 && 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
1482 && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
1483 ){
danielk1977fee2d252007-08-18 10:59:19 +00001484 sqlite3OsCloseFree(pMaster);
1485 sqlite3OsDelete(pVfs, zMaster, 0);
drh633e6d52008-07-28 19:34:53 +00001486 sqlite3DbFree(db, zMaster);
danielk19775865e3d2004-06-14 06:03:57 +00001487 return rc;
1488 }
drhc9e06862004-06-09 20:03:08 +00001489
danielk197713adf8a2004-06-03 16:08:41 +00001490 /* Sync all the db files involved in the transaction. The same call
1491 ** sets the master journal pointer in each individual journal. If
1492 ** an error occurs here, do not delete the master journal file.
1493 **
drh80e35f42007-03-30 14:06:34 +00001494 ** If the error occurs during the first call to
1495 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
1496 ** master journal file will be orphaned. But we cannot delete it,
1497 ** in case the master journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00001498 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00001499 */
danielk19775bd270b2006-07-25 15:14:52 +00001500 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00001501 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00001502 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00001503 rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001504 }
1505 }
danielk1977fee2d252007-08-18 10:59:19 +00001506 sqlite3OsCloseFree(pMaster);
danielk19775bd270b2006-07-25 15:14:52 +00001507 if( rc!=SQLITE_OK ){
drh633e6d52008-07-28 19:34:53 +00001508 sqlite3DbFree(db, zMaster);
danielk19775bd270b2006-07-25 15:14:52 +00001509 return rc;
1510 }
danielk197713adf8a2004-06-03 16:08:41 +00001511
danielk1977962398d2004-06-14 09:35:16 +00001512 /* Delete the master journal file. This commits the transaction. After
1513 ** doing this the directory is synced again before any individual
1514 ** transaction files are deleted.
1515 */
danielk1977fee2d252007-08-18 10:59:19 +00001516 rc = sqlite3OsDelete(pVfs, zMaster, 1);
drh633e6d52008-07-28 19:34:53 +00001517 sqlite3DbFree(db, zMaster);
drhc416ba92007-03-30 18:42:55 +00001518 zMaster = 0;
drh29a01382006-08-13 19:04:18 +00001519 if( rc ){
1520 return rc;
1521 }
danielk197713adf8a2004-06-03 16:08:41 +00001522
1523 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00001524 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
1525 ** deleting or truncating journals. If something goes wrong while
1526 ** this is happening we don't really care. The integrity of the
1527 ** transaction is already guaranteed, but some stray 'cold' journals
1528 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00001529 */
danielk1977979f38e2007-03-27 16:19:51 +00001530 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00001531 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00001532 for(i=0; i<db->nDb; i++){
1533 Btree *pBt = db->aDb[i].pBt;
1534 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00001535 sqlite3BtreeCommitPhaseTwo(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00001536 }
1537 }
danielk19772d1d86f2008-06-20 14:59:51 +00001538 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00001539 enable_simulated_io_errors();
1540
danielk1977f9e7dda2006-06-16 16:08:53 +00001541 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00001542 }
danielk197744ee5bf2005-05-27 09:41:12 +00001543#endif
danielk1977026d2702004-06-14 13:14:59 +00001544
drh2ac3ee92004-06-07 16:27:46 +00001545 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001546}
1547
danielk19771d850a72004-05-31 08:26:49 +00001548/*
1549** This routine checks that the sqlite3.activeVdbeCnt count variable
1550** matches the number of vdbe's in the list sqlite3.pVdbe that are
1551** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00001552** This is an internal self-check only - it is not an essential processing
1553** step.
danielk19771d850a72004-05-31 08:26:49 +00001554**
1555** This is a no-op if NDEBUG is defined.
1556*/
1557#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00001558static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00001559 Vdbe *p;
1560 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00001561 int nWrite = 0;
danielk19771d850a72004-05-31 08:26:49 +00001562 p = db->pVdbe;
1563 while( p ){
drh92f02c32004-09-02 14:57:08 +00001564 if( p->magic==VDBE_MAGIC_RUN && p->pc>=0 ){
danielk19771d850a72004-05-31 08:26:49 +00001565 cnt++;
drhad4a4b82008-11-05 16:37:34 +00001566 if( p->readOnly==0 ) nWrite++;
danielk19771d850a72004-05-31 08:26:49 +00001567 }
1568 p = p->pNext;
1569 }
danielk19771d850a72004-05-31 08:26:49 +00001570 assert( cnt==db->activeVdbeCnt );
drhad4a4b82008-11-05 16:37:34 +00001571 assert( nWrite==db->writeVdbeCnt );
danielk19771d850a72004-05-31 08:26:49 +00001572}
1573#else
1574#define checkActiveVdbeCnt(x)
1575#endif
1576
danielk19773cf86062004-05-26 10:11:05 +00001577/*
drhfb982642007-08-30 01:19:59 +00001578** For every Btree that in database connection db which
1579** has been modified, "trip" or invalidate each cursor in
1580** that Btree might have been modified so that the cursor
1581** can never be used again. This happens when a rollback
1582*** occurs. We have to trip all the other cursors, even
1583** cursor from other VMs in different database connections,
1584** so that none of them try to use the data at which they
1585** were pointing and which now may have been changed due
1586** to the rollback.
1587**
1588** Remember that a rollback can delete tables complete and
1589** reorder rootpages. So it is not sufficient just to save
1590** the state of the cursor. We have to invalidate the cursor
1591** so that it is never used again.
danielk1977be718892006-06-23 08:05:19 +00001592*/
drhade6c9c2007-11-24 10:23:44 +00001593static void invalidateCursorsOnModifiedBtrees(sqlite3 *db){
drhfb982642007-08-30 01:19:59 +00001594 int i;
1595 for(i=0; i<db->nDb; i++){
1596 Btree *p = db->aDb[i].pBt;
1597 if( p && sqlite3BtreeIsInTrans(p) ){
1598 sqlite3BtreeTripAllCursors(p, SQLITE_ABORT);
1599 }
danielk1977be718892006-06-23 08:05:19 +00001600 }
1601}
1602
1603/*
danielk1977bd434552009-03-18 10:33:00 +00001604** If the Vdbe passed as the first argument opened a statement-transaction,
1605** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
1606** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
1607** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
1608** statement transaction is commtted.
1609**
1610** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
1611** Otherwise SQLITE_OK.
1612*/
1613int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00001614 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00001615 int rc = SQLITE_OK;
danielk1977ecaecf92009-07-08 08:05:35 +00001616
drh6be240e2009-07-14 02:33:02 +00001617 if( p->iStatement ){
danielk1977bd434552009-03-18 10:33:00 +00001618 int i;
1619 const int iSavepoint = p->iStatement-1;
danielk1977bd434552009-03-18 10:33:00 +00001620
1621 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
1622 assert( db->nStatement>0 );
1623 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
1624
1625 for(i=0; i<db->nDb; i++){
1626 int rc2 = SQLITE_OK;
1627 Btree *pBt = db->aDb[i].pBt;
1628 if( pBt ){
1629 if( eOp==SAVEPOINT_ROLLBACK ){
1630 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
1631 }
1632 if( rc2==SQLITE_OK ){
1633 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
1634 }
1635 if( rc==SQLITE_OK ){
1636 rc = rc2;
1637 }
1638 }
1639 }
1640 db->nStatement--;
1641 p->iStatement = 0;
1642 }
1643 return rc;
1644}
1645
1646/*
danielk1977f7590db2009-04-10 12:55:16 +00001647** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1648** this routine obtains the mutex associated with each BtShared structure
1649** that may be accessed by the VM passed as an argument. In doing so it
1650** sets the BtShared.db member of each of the BtShared structures, ensuring
1651** that the correct busy-handler callback is invoked if required.
1652**
1653** If SQLite is not threadsafe but does support shared-cache mode, then
1654** sqlite3BtreeEnterAll() is invoked to set the BtShared.db variables
1655** of all of BtShared structures accessible via the database handle
1656** associated with the VM. Of course only a subset of these structures
1657** will be accessed by the VM, and we could use Vdbe.btreeMask to figure
1658** that subset out, but there is no advantage to doing so.
1659**
1660** If SQLite is not threadsafe and does not support shared-cache mode, this
1661** function is a no-op.
1662*/
1663#ifndef SQLITE_OMIT_SHARED_CACHE
1664void sqlite3VdbeMutexArrayEnter(Vdbe *p){
1665#if SQLITE_THREADSAFE
1666 sqlite3BtreeMutexArrayEnter(&p->aMutex);
1667#else
1668 sqlite3BtreeEnterAll(p->db);
1669#endif
1670}
1671#endif
1672
1673/*
drh92f02c32004-09-02 14:57:08 +00001674** This routine is called the when a VDBE tries to halt. If the VDBE
1675** has made changes and is in autocommit mode, then commit those
1676** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00001677**
drh92f02c32004-09-02 14:57:08 +00001678** This routine is the only way to move the state of a VM from
drhff0587c2007-08-29 17:43:19 +00001679** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
1680** call this on a VM that is in the SQLITE_MAGIC_HALT state.
drh92f02c32004-09-02 14:57:08 +00001681**
1682** Return an error code. If the commit could not complete because of
1683** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
1684** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00001685*/
drhff0587c2007-08-29 17:43:19 +00001686int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00001687 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00001688 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00001689
1690 /* This function contains the logic that determines if a statement or
1691 ** transaction will be committed or rolled back as a result of the
1692 ** execution of this virtual machine.
1693 **
drh71b890a2007-10-03 15:30:52 +00001694 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00001695 **
drh71b890a2007-10-03 15:30:52 +00001696 ** SQLITE_NOMEM
1697 ** SQLITE_IOERR
1698 ** SQLITE_FULL
1699 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00001700 **
drh71b890a2007-10-03 15:30:52 +00001701 ** Then the internal cache might have been left in an inconsistent
1702 ** state. We need to rollback the statement transaction, if there is
1703 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00001704 */
drh9a324642003-09-06 20:12:01 +00001705
drh17435752007-08-16 04:30:38 +00001706 if( p->db->mallocFailed ){
danielk1977261919c2005-12-06 12:52:59 +00001707 p->rc = SQLITE_NOMEM;
1708 }
drh5f82e3c2009-07-06 00:44:08 +00001709 closeAllCursors(p);
drh92f02c32004-09-02 14:57:08 +00001710 if( p->magic!=VDBE_MAGIC_RUN ){
drh92f02c32004-09-02 14:57:08 +00001711 return SQLITE_OK;
drh9a324642003-09-06 20:12:01 +00001712 }
danielk19771d850a72004-05-31 08:26:49 +00001713 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00001714
danielk197707cb5602006-01-20 10:55:05 +00001715 /* No commit or rollback needed if the program never started */
1716 if( p->pc>=0 ){
drhaac2f552006-09-23 21:44:23 +00001717 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00001718 int eStatementOp = 0;
1719 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00001720
1721 /* Lock all btrees used by the statement */
danielk1977f7590db2009-04-10 12:55:16 +00001722 sqlite3VdbeMutexArrayEnter(p);
drhff0587c2007-08-29 17:43:19 +00001723
drh71b890a2007-10-03 15:30:52 +00001724 /* Check for one of the special errors */
drhaac2f552006-09-23 21:44:23 +00001725 mrc = p->rc & 0xff;
drhfa3be902009-07-07 02:44:07 +00001726 assert( p->rc!=SQLITE_IOERR_BLOCKED ); /* This error no longer exists */
drh71b890a2007-10-03 15:30:52 +00001727 isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
drh77658e22007-12-04 16:54:52 +00001728 || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
danielk197707cb5602006-01-20 10:55:05 +00001729 if( isSpecialError ){
danielk197707cb5602006-01-20 10:55:05 +00001730 /* If the query was read-only, we need do no rollback at all. Otherwise,
1731 ** proceed with the special handling.
1732 */
drhad4a4b82008-11-05 16:37:34 +00001733 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00001734 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00001735 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00001736 }else{
1737 /* We are forced to roll back the active transaction. Before doing
1738 ** so, abort any other statements this handle currently has active.
1739 */
drhfb982642007-08-30 01:19:59 +00001740 invalidateCursorsOnModifiedBtrees(db);
danielk197797a227c2006-01-20 16:32:04 +00001741 sqlite3RollbackAll(db);
danielk1977fc158bf2009-01-07 08:12:16 +00001742 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00001743 db->autoCommit = 1;
1744 }
danielk1977261919c2005-12-06 12:52:59 +00001745 }
1746 }
danielk197707cb5602006-01-20 10:55:05 +00001747
danielk1977bd434552009-03-18 10:33:00 +00001748 /* If the auto-commit flag is set and this is the only active writer
1749 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00001750 **
1751 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00001752 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00001753 */
danielk1977093e0f62008-11-13 18:00:14 +00001754 if( !sqlite3VtabInSync(db)
1755 && db->autoCommit
1756 && db->writeVdbeCnt==(p->readOnly==0)
1757 ){
danielk197707cb5602006-01-20 10:55:05 +00001758 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
drhfd131da2007-08-07 17:13:03 +00001759 /* The auto-commit flag is true, and the vdbe program was
danielk197707cb5602006-01-20 10:55:05 +00001760 ** successful or hit an 'OR FAIL' constraint. This means a commit
1761 ** is required.
1762 */
danielk1977bd434552009-03-18 10:33:00 +00001763 rc = vdbeCommit(db, p);
danielk197707cb5602006-01-20 10:55:05 +00001764 if( rc==SQLITE_BUSY ){
drhff0587c2007-08-29 17:43:19 +00001765 sqlite3BtreeMutexArrayLeave(&p->aMutex);
danielk197707cb5602006-01-20 10:55:05 +00001766 return SQLITE_BUSY;
1767 }else if( rc!=SQLITE_OK ){
1768 p->rc = rc;
danielk197797a227c2006-01-20 16:32:04 +00001769 sqlite3RollbackAll(db);
danielk197707cb5602006-01-20 10:55:05 +00001770 }else{
1771 sqlite3CommitInternalChanges(db);
1772 }
1773 }else{
danielk197797a227c2006-01-20 16:32:04 +00001774 sqlite3RollbackAll(db);
danielk197707cb5602006-01-20 10:55:05 +00001775 }
danielk1977bd434552009-03-18 10:33:00 +00001776 db->nStatement = 0;
1777 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00001778 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00001779 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00001780 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00001781 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00001782 }else{
drhfb982642007-08-30 01:19:59 +00001783 invalidateCursorsOnModifiedBtrees(db);
danielk197797a227c2006-01-20 16:32:04 +00001784 sqlite3RollbackAll(db);
danielk1977fc158bf2009-01-07 08:12:16 +00001785 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00001786 db->autoCommit = 1;
1787 }
danielk19771d850a72004-05-31 08:26:49 +00001788 }
danielk197707cb5602006-01-20 10:55:05 +00001789
danielk1977bd434552009-03-18 10:33:00 +00001790 /* If eStatementOp is non-zero, then a statement transaction needs to
1791 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
1792 ** do so. If this operation returns an error, and the current statement
1793 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then set the error
1794 ** code to the new value.
danielk197707cb5602006-01-20 10:55:05 +00001795 */
danielk1977bd434552009-03-18 10:33:00 +00001796 if( eStatementOp ){
1797 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
1798 if( rc && (p->rc==SQLITE_OK || p->rc==SQLITE_CONSTRAINT) ){
1799 p->rc = rc;
1800 sqlite3DbFree(db, p->zErrMsg);
1801 p->zErrMsg = 0;
danielk197707cb5602006-01-20 10:55:05 +00001802 }
danielk197777d83ba2004-05-31 10:08:14 +00001803 }
danielk197707cb5602006-01-20 10:55:05 +00001804
danielk1977bd434552009-03-18 10:33:00 +00001805 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
1806 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00001807 */
drh6be240e2009-07-14 02:33:02 +00001808 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00001809 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00001810 sqlite3VdbeSetChanges(db, p->nChange);
1811 }else{
1812 sqlite3VdbeSetChanges(db, 0);
1813 }
1814 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00001815 }
danielk197707cb5602006-01-20 10:55:05 +00001816
1817 /* Rollback or commit any schema changes that occurred. */
1818 if( p->rc!=SQLITE_OK && db->flags&SQLITE_InternChanges ){
1819 sqlite3ResetInternalSchema(db, 0);
1820 db->flags = (db->flags | SQLITE_InternChanges);
1821 }
drhff0587c2007-08-29 17:43:19 +00001822
1823 /* Release the locks */
1824 sqlite3BtreeMutexArrayLeave(&p->aMutex);
drh9a324642003-09-06 20:12:01 +00001825 }
danielk19771d850a72004-05-31 08:26:49 +00001826
danielk197765fd59f2006-06-24 11:51:33 +00001827 /* We have successfully halted and closed the VM. Record this fact. */
1828 if( p->pc>=0 ){
danielk19771d850a72004-05-31 08:26:49 +00001829 db->activeVdbeCnt--;
drhad4a4b82008-11-05 16:37:34 +00001830 if( !p->readOnly ){
1831 db->writeVdbeCnt--;
1832 }
1833 assert( db->activeVdbeCnt>=db->writeVdbeCnt );
drh9a324642003-09-06 20:12:01 +00001834 }
drh92f02c32004-09-02 14:57:08 +00001835 p->magic = VDBE_MAGIC_HALT;
1836 checkActiveVdbeCnt(db);
drhff0587c2007-08-29 17:43:19 +00001837 if( p->db->mallocFailed ){
1838 p->rc = SQLITE_NOMEM;
1839 }
danielk19771d850a72004-05-31 08:26:49 +00001840
danielk1977404ca072009-03-16 13:19:36 +00001841 /* If the auto-commit flag is set to true, then any locks that were held
1842 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
1843 ** to invoke any required unlock-notify callbacks.
1844 */
1845 if( db->autoCommit ){
1846 sqlite3ConnectionUnlocked(db);
1847 }
1848
danielk1977bd434552009-03-18 10:33:00 +00001849 assert( db->activeVdbeCnt>0 || db->autoCommit==0 || db->nStatement==0 );
drh92f02c32004-09-02 14:57:08 +00001850 return SQLITE_OK;
1851}
drh4cf7c7f2007-08-28 23:28:07 +00001852
drh92f02c32004-09-02 14:57:08 +00001853
1854/*
drh3c23a882007-01-09 14:01:13 +00001855** Each VDBE holds the result of the most recent sqlite3_step() call
1856** in p->rc. This routine sets that result back to SQLITE_OK.
1857*/
1858void sqlite3VdbeResetStepResult(Vdbe *p){
1859 p->rc = SQLITE_OK;
1860}
1861
1862/*
drh92f02c32004-09-02 14:57:08 +00001863** Clean up a VDBE after execution but do not delete the VDBE just yet.
1864** Write any error messages into *pzErrMsg. Return the result code.
1865**
1866** After this routine is run, the VDBE should be ready to be executed
1867** again.
1868**
1869** To look at it another way, this routine resets the state of the
1870** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
1871** VDBE_MAGIC_INIT.
1872*/
drhc890fec2008-08-01 20:10:08 +00001873int sqlite3VdbeReset(Vdbe *p){
drh4ac285a2006-09-15 07:28:50 +00001874 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00001875 db = p->db;
drh92f02c32004-09-02 14:57:08 +00001876
1877 /* If the VM did not run to completion or if it encountered an
1878 ** error, then it might not have been halted properly. So halt
1879 ** it now.
1880 */
drh7e8b8482008-01-23 03:03:05 +00001881 (void)sqlite3SafetyOn(db);
drh92f02c32004-09-02 14:57:08 +00001882 sqlite3VdbeHalt(p);
drh7e8b8482008-01-23 03:03:05 +00001883 (void)sqlite3SafetyOff(db);
drh92f02c32004-09-02 14:57:08 +00001884
drhfb7e7652005-01-24 00:28:42 +00001885 /* If the VDBE has be run even partially, then transfer the error code
1886 ** and error message from the VDBE into the main database structure. But
1887 ** if the VDBE has just been set to run but has not actually executed any
1888 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00001889 */
drhfb7e7652005-01-24 00:28:42 +00001890 if( p->pc>=0 ){
1891 if( p->zErrMsg ){
danielk19779ff3f3f2008-10-11 17:51:38 +00001892 sqlite3BeginBenignMalloc();
drh633e6d52008-07-28 19:34:53 +00001893 sqlite3ValueSetStr(db->pErr,-1,p->zErrMsg,SQLITE_UTF8,SQLITE_TRANSIENT);
danielk19779ff3f3f2008-10-11 17:51:38 +00001894 sqlite3EndBenignMalloc();
danielk197797a227c2006-01-20 16:32:04 +00001895 db->errCode = p->rc;
drh633e6d52008-07-28 19:34:53 +00001896 sqlite3DbFree(db, p->zErrMsg);
drhfb7e7652005-01-24 00:28:42 +00001897 p->zErrMsg = 0;
1898 }else if( p->rc ){
drh4ac285a2006-09-15 07:28:50 +00001899 sqlite3Error(db, p->rc, 0);
drhfb7e7652005-01-24 00:28:42 +00001900 }else{
drh4ac285a2006-09-15 07:28:50 +00001901 sqlite3Error(db, SQLITE_OK, 0);
drhfb7e7652005-01-24 00:28:42 +00001902 }
danielk1977a21c6b62005-01-24 10:25:59 +00001903 }else if( p->rc && p->expired ){
1904 /* The expired flag was set on the VDBE before the first call
1905 ** to sqlite3_step(). For consistency (since sqlite3_step() was
1906 ** called), set the database error in this case as well.
1907 */
drh4ac285a2006-09-15 07:28:50 +00001908 sqlite3Error(db, p->rc, 0);
drh633e6d52008-07-28 19:34:53 +00001909 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
1910 sqlite3DbFree(db, p->zErrMsg);
danielk19778e556522007-11-13 10:30:24 +00001911 p->zErrMsg = 0;
drh92f02c32004-09-02 14:57:08 +00001912 }
1913
1914 /* Reclaim all memory used by the VDBE
1915 */
drhc890fec2008-08-01 20:10:08 +00001916 Cleanup(p);
drh92f02c32004-09-02 14:57:08 +00001917
1918 /* Save profiling information from this VDBE run.
1919 */
drh9a324642003-09-06 20:12:01 +00001920#ifdef VDBE_PROFILE
1921 {
1922 FILE *out = fopen("vdbe_profile.out", "a");
1923 if( out ){
1924 int i;
1925 fprintf(out, "---- ");
1926 for(i=0; i<p->nOp; i++){
1927 fprintf(out, "%02x", p->aOp[i].opcode);
1928 }
1929 fprintf(out, "\n");
1930 for(i=0; i<p->nOp; i++){
1931 fprintf(out, "%6d %10lld %8lld ",
1932 p->aOp[i].cnt,
1933 p->aOp[i].cycles,
1934 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
1935 );
danielk19774adee202004-05-08 08:23:19 +00001936 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00001937 }
1938 fclose(out);
1939 }
1940 }
1941#endif
1942 p->magic = VDBE_MAGIC_INIT;
drh4ac285a2006-09-15 07:28:50 +00001943 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00001944}
drh92f02c32004-09-02 14:57:08 +00001945
drh9a324642003-09-06 20:12:01 +00001946/*
1947** Clean up and delete a VDBE after execution. Return an integer which is
1948** the result code. Write any error message text into *pzErrMsg.
1949*/
danielk19779e6db7d2004-06-21 08:18:51 +00001950int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00001951 int rc = SQLITE_OK;
danielk1977b5548a82004-06-26 13:51:33 +00001952 if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
drhc890fec2008-08-01 20:10:08 +00001953 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00001954 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00001955 }
danielk19774adee202004-05-08 08:23:19 +00001956 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00001957 return rc;
1958}
1959
1960/*
drhf92c7ff2004-06-19 15:40:23 +00001961** Call the destructor for each auxdata entry in pVdbeFunc for which
danielk1977e159fdf2004-06-21 10:45:06 +00001962** the corresponding bit in mask is clear. Auxdata entries beyond 31
drhf92c7ff2004-06-19 15:40:23 +00001963** are always destroyed. To destroy all auxdata entries, call this
danielk1977e159fdf2004-06-21 10:45:06 +00001964** routine with mask==0.
drhf92c7ff2004-06-19 15:40:23 +00001965*/
1966void sqlite3VdbeDeleteAuxData(VdbeFunc *pVdbeFunc, int mask){
1967 int i;
1968 for(i=0; i<pVdbeFunc->nAux; i++){
1969 struct AuxData *pAux = &pVdbeFunc->apAux[i];
drh3500ed62009-05-05 15:46:43 +00001970 if( (i>31 || !(mask&(((u32)1)<<i))) && pAux->pAux ){
drhf92c7ff2004-06-19 15:40:23 +00001971 if( pAux->xDelete ){
1972 pAux->xDelete(pAux->pAux);
1973 }
1974 pAux->pAux = 0;
1975 }
1976 }
1977}
1978
1979/*
drh9a324642003-09-06 20:12:01 +00001980** Delete an entire VDBE.
1981*/
danielk19774adee202004-05-08 08:23:19 +00001982void sqlite3VdbeDelete(Vdbe *p){
drh9a324642003-09-06 20:12:01 +00001983 int i;
drh633e6d52008-07-28 19:34:53 +00001984 sqlite3 *db;
1985
drhfa3be902009-07-07 02:44:07 +00001986 if( NEVER(p==0) ) return;
drh633e6d52008-07-28 19:34:53 +00001987 db = p->db;
drh9a324642003-09-06 20:12:01 +00001988 if( p->pPrev ){
1989 p->pPrev->pNext = p->pNext;
1990 }else{
drh633e6d52008-07-28 19:34:53 +00001991 assert( db->pVdbe==p );
1992 db->pVdbe = p->pNext;
drh9a324642003-09-06 20:12:01 +00001993 }
1994 if( p->pNext ){
1995 p->pNext->pPrev = p->pPrev;
1996 }
drh76ff3a02004-09-24 22:32:30 +00001997 if( p->aOp ){
drhd4e70eb2008-01-02 00:34:36 +00001998 Op *pOp = p->aOp;
1999 for(i=0; i<p->nOp; i++, pOp++){
drh633e6d52008-07-28 19:34:53 +00002000 freeP4(db, pOp->p4type, pOp->p4.p);
drhd4e70eb2008-01-02 00:34:36 +00002001#ifdef SQLITE_DEBUG
drh633e6d52008-07-28 19:34:53 +00002002 sqlite3DbFree(db, pOp->zComment);
drhd4e70eb2008-01-02 00:34:36 +00002003#endif
drh9a324642003-09-06 20:12:01 +00002004 }
2005 }
drhc890fec2008-08-01 20:10:08 +00002006 releaseMemArray(p->aVar, p->nVar);
drh633e6d52008-07-28 19:34:53 +00002007 sqlite3DbFree(db, p->aLabel);
drhc890fec2008-08-01 20:10:08 +00002008 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh633e6d52008-07-28 19:34:53 +00002009 sqlite3DbFree(db, p->aColName);
2010 sqlite3DbFree(db, p->zSql);
drh9a324642003-09-06 20:12:01 +00002011 p->magic = VDBE_MAGIC_DEAD;
drhb2771ce2009-02-20 01:28:59 +00002012 sqlite3DbFree(db, p->aOp);
2013 sqlite3DbFree(db, p->pFree);
drh633e6d52008-07-28 19:34:53 +00002014 sqlite3DbFree(db, p);
drh9a324642003-09-06 20:12:01 +00002015}
drha11846b2004-01-07 18:52:56 +00002016
2017/*
drh9a65f2c2009-06-22 19:05:40 +00002018** Make sure the cursor p is ready to read or write the row to which it
2019** was last positioned. Return an error code if an OOM fault or I/O error
2020** prevents us from positioning the cursor to its correct position.
2021**
drha11846b2004-01-07 18:52:56 +00002022** If a MoveTo operation is pending on the given cursor, then do that
drh9a65f2c2009-06-22 19:05:40 +00002023** MoveTo now. If no move is pending, check to see if the row has been
2024** deleted out from under the cursor and if it has, mark the row as
2025** a NULL row.
2026**
2027** If the cursor is already pointing to the correct row and that row has
2028** not been deleted out from under the cursor, then this routine is a no-op.
drha11846b2004-01-07 18:52:56 +00002029*/
drhdfe88ec2008-11-03 20:55:06 +00002030int sqlite3VdbeCursorMoveto(VdbeCursor *p){
drha11846b2004-01-07 18:52:56 +00002031 if( p->deferredMoveto ){
drh536065a2005-01-26 21:55:31 +00002032 int res, rc;
adamd4fc93082006-09-14 16:57:19 +00002033#ifdef SQLITE_TEST
danielk1977132872b2004-05-10 10:37:18 +00002034 extern int sqlite3_search_count;
adamd4fc93082006-09-14 16:57:19 +00002035#endif
drhf0863fe2005-06-12 21:35:51 +00002036 assert( p->isTable );
drhe63d9992008-08-13 19:11:48 +00002037 rc = sqlite3BtreeMovetoUnpacked(p->pCursor, 0, p->movetoTarget, 0, &res);
drh536065a2005-01-26 21:55:31 +00002038 if( rc ) return rc;
drhaa736092009-06-22 00:55:30 +00002039 p->lastRowid = p->movetoTarget;
drh61495262009-04-22 15:32:59 +00002040 p->rowidIsValid = ALWAYS(res==0) ?1:0;
2041 if( NEVER(res<0) ){
drh536065a2005-01-26 21:55:31 +00002042 rc = sqlite3BtreeNext(p->pCursor, &res);
2043 if( rc ) return rc;
drha11846b2004-01-07 18:52:56 +00002044 }
drh10cfdd52006-08-08 15:42:59 +00002045#ifdef SQLITE_TEST
danielk1977132872b2004-05-10 10:37:18 +00002046 sqlite3_search_count++;
drh10cfdd52006-08-08 15:42:59 +00002047#endif
drha11846b2004-01-07 18:52:56 +00002048 p->deferredMoveto = 0;
drh76873ab2006-01-07 18:48:26 +00002049 p->cacheStatus = CACHE_STALE;
drh6be240e2009-07-14 02:33:02 +00002050 }else if( ALWAYS(p->pCursor) ){
drha3460582008-07-11 21:02:53 +00002051 int hasMoved;
2052 int rc = sqlite3BtreeCursorHasMoved(p->pCursor, &hasMoved);
2053 if( rc ) return rc;
2054 if( hasMoved ){
2055 p->cacheStatus = CACHE_STALE;
2056 p->nullRow = 1;
2057 }
drha11846b2004-01-07 18:52:56 +00002058 }
2059 return SQLITE_OK;
2060}
danielk19774adee202004-05-08 08:23:19 +00002061
drhab9f7f12004-05-08 10:56:11 +00002062/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002063** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00002064**
danielk1977cfcdaef2004-05-12 07:33:33 +00002065** sqlite3VdbeSerialType()
2066** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00002067** sqlite3VdbeSerialLen()
shane92003092008-07-31 01:43:13 +00002068** sqlite3VdbeSerialPut()
2069** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00002070**
2071** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00002072** data and index records. Each serialized value consists of a
2073** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
2074** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00002075**
danielk1977cfcdaef2004-05-12 07:33:33 +00002076** In an SQLite index record, the serial type is stored directly before
2077** the blob of data that it corresponds to. In a table record, all serial
2078** types are stored at the start of the record, and the blobs of data at
2079** the end. Hence these functions allow the caller to handle the
2080** serial-type and data blob seperately.
2081**
2082** The following table describes the various storage classes for data:
2083**
2084** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00002085** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00002086** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00002087** 1 1 signed integer
2088** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00002089** 3 3 signed integer
2090** 4 4 signed integer
2091** 5 6 signed integer
2092** 6 8 signed integer
2093** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00002094** 8 0 Integer constant 0
2095** 9 0 Integer constant 1
2096** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00002097** N>=12 and even (N-12)/2 BLOB
2098** N>=13 and odd (N-13)/2 text
2099**
drh35a59652006-01-02 18:24:40 +00002100** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
2101** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00002102*/
2103
2104/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002105** Return the serial-type for the value stored in pMem.
danielk1977192ac1d2004-05-10 07:17:30 +00002106*/
drhd946db02005-12-29 19:23:06 +00002107u32 sqlite3VdbeSerialType(Mem *pMem, int file_format){
danielk1977cfcdaef2004-05-12 07:33:33 +00002108 int flags = pMem->flags;
drhfdf972a2007-05-02 13:30:27 +00002109 int n;
danielk1977cfcdaef2004-05-12 07:33:33 +00002110
2111 if( flags&MEM_Null ){
drha19b7752004-05-30 21:14:58 +00002112 return 0;
danielk197790e4d952004-05-10 10:05:53 +00002113 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002114 if( flags&MEM_Int ){
drhfe2093d2005-01-20 22:48:47 +00002115 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00002116# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00002117 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00002118 u64 u;
2119 if( file_format>=4 && (i&1)==i ){
drh8df32842008-12-09 02:51:23 +00002120 return 8+(u32)i;
drhd946db02005-12-29 19:23:06 +00002121 }
2122 u = i<0 ? -i : i;
drh5742b632005-01-26 17:47:02 +00002123 if( u<=127 ) return 1;
2124 if( u<=32767 ) return 2;
2125 if( u<=8388607 ) return 3;
2126 if( u<=2147483647 ) return 4;
2127 if( u<=MAX_6BYTE ) return 5;
drha19b7752004-05-30 21:14:58 +00002128 return 6;
danielk197790e4d952004-05-10 10:05:53 +00002129 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002130 if( flags&MEM_Real ){
drha19b7752004-05-30 21:14:58 +00002131 return 7;
danielk197790e4d952004-05-10 10:05:53 +00002132 }
danielk1977e4359752008-11-03 09:39:45 +00002133 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drhfdf972a2007-05-02 13:30:27 +00002134 n = pMem->n;
2135 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00002136 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00002137 }
drhfdf972a2007-05-02 13:30:27 +00002138 assert( n>=0 );
2139 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00002140}
2141
2142/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002143** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00002144*/
drh35cd6432009-06-05 14:17:21 +00002145u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drha19b7752004-05-30 21:14:58 +00002146 if( serial_type>=12 ){
drh51846b52004-05-28 16:00:21 +00002147 return (serial_type-12)/2;
2148 }else{
drh57196282004-10-06 15:41:16 +00002149 static const u8 aSize[] = { 0, 1, 2, 3, 4, 6, 8, 8, 0, 0, 0, 0 };
drh51846b52004-05-28 16:00:21 +00002150 return aSize[serial_type];
2151 }
danielk1977192ac1d2004-05-10 07:17:30 +00002152}
2153
2154/*
drh110daac2007-05-04 11:59:31 +00002155** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00002156** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00002157** upper 4 bytes. Return the result.
2158**
drh7a4f5022007-05-23 07:20:08 +00002159** For most architectures, this is a no-op.
2160**
2161** (later): It is reported to me that the mixed-endian problem
2162** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
2163** that early versions of GCC stored the two words of a 64-bit
2164** float in the wrong order. And that error has been propagated
2165** ever since. The blame is not necessarily with GCC, though.
2166** GCC might have just copying the problem from a prior compiler.
2167** I am also told that newer versions of GCC that follow a different
2168** ABI get the byte order right.
2169**
2170** Developers using SQLite on an ARM7 should compile and run their
2171** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
2172** enabled, some asserts below will ensure that the byte order of
2173** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00002174**
2175** (2007-08-30) Frank van Vugt has studied this problem closely
2176** and has send his findings to the SQLite developers. Frank
2177** writes that some Linux kernels offer floating point hardware
2178** emulation that uses only 32-bit mantissas instead of a full
2179** 48-bits as required by the IEEE standard. (This is the
2180** CONFIG_FPE_FASTFPE option.) On such systems, floating point
2181** byte swapping becomes very complicated. To avoid problems,
2182** the necessary byte swapping is carried out using a 64-bit integer
2183** rather than a 64-bit float. Frank assures us that the code here
2184** works for him. We, the developers, have no way to independently
2185** verify this, but Frank seems to know what he is talking about
2186** so we trust him.
drh110daac2007-05-04 11:59:31 +00002187*/
2188#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drh60d09a72007-08-30 15:05:08 +00002189static u64 floatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00002190 union {
drh60d09a72007-08-30 15:05:08 +00002191 u64 r;
drh110daac2007-05-04 11:59:31 +00002192 u32 i[2];
2193 } u;
2194 u32 t;
2195
2196 u.r = in;
2197 t = u.i[0];
2198 u.i[0] = u.i[1];
2199 u.i[1] = t;
2200 return u.r;
2201}
2202# define swapMixedEndianFloat(X) X = floatSwap(X)
2203#else
2204# define swapMixedEndianFloat(X)
2205#endif
2206
2207/*
danielk1977cfcdaef2004-05-12 07:33:33 +00002208** Write the serialized data blob for the value stored in pMem into
2209** buf. It is assumed that the caller has allocated sufficient space.
2210** Return the number of bytes written.
drhfdf972a2007-05-02 13:30:27 +00002211**
2212** nBuf is the amount of space left in buf[]. nBuf must always be
2213** large enough to hold the entire field. Except, if the field is
2214** a blob with a zero-filled tail, then buf[] might be just the right
2215** size to hold everything except for the zero-filled tail. If buf[]
2216** is only big enough to hold the non-zero prefix, then only write that
2217** prefix into buf[]. But if buf[] is large enough to hold both the
2218** prefix and the tail then write the prefix and set the tail to all
2219** zeros.
2220**
2221** Return the number of bytes actually written into buf[]. The number
2222** of bytes in the zero-filled tail is included in the return value only
2223** if those bytes were zeroed in buf[].
danielk1977cfcdaef2004-05-12 07:33:33 +00002224*/
drh35cd6432009-06-05 14:17:21 +00002225u32 sqlite3VdbeSerialPut(u8 *buf, int nBuf, Mem *pMem, int file_format){
drhd946db02005-12-29 19:23:06 +00002226 u32 serial_type = sqlite3VdbeSerialType(pMem, file_format);
drh35cd6432009-06-05 14:17:21 +00002227 u32 len;
danielk1977183f9f72004-05-13 05:20:26 +00002228
drh1483e142004-05-21 21:12:42 +00002229 /* Integer and Real */
drhd946db02005-12-29 19:23:06 +00002230 if( serial_type<=7 && serial_type>0 ){
drh1483e142004-05-21 21:12:42 +00002231 u64 v;
drh35cd6432009-06-05 14:17:21 +00002232 u32 i;
drha19b7752004-05-30 21:14:58 +00002233 if( serial_type==7 ){
drh4f0c5872007-03-26 22:05:01 +00002234 assert( sizeof(v)==sizeof(pMem->r) );
2235 memcpy(&v, &pMem->r, sizeof(v));
drh60d09a72007-08-30 15:05:08 +00002236 swapMixedEndianFloat(v);
drh1483e142004-05-21 21:12:42 +00002237 }else{
drh3c024d62007-03-30 11:23:45 +00002238 v = pMem->u.i;
danielk1977cfcdaef2004-05-12 07:33:33 +00002239 }
drh1483e142004-05-21 21:12:42 +00002240 len = i = sqlite3VdbeSerialTypeLen(serial_type);
shane75ac1de2009-06-09 18:58:52 +00002241 assert( len<=(u32)nBuf );
drh1483e142004-05-21 21:12:42 +00002242 while( i-- ){
drh8df32842008-12-09 02:51:23 +00002243 buf[i] = (u8)(v&0xFF);
drh1483e142004-05-21 21:12:42 +00002244 v >>= 8;
2245 }
2246 return len;
danielk1977cfcdaef2004-05-12 07:33:33 +00002247 }
drhd946db02005-12-29 19:23:06 +00002248
danielk1977cfcdaef2004-05-12 07:33:33 +00002249 /* String or blob */
drhd946db02005-12-29 19:23:06 +00002250 if( serial_type>=12 ){
drh8df32842008-12-09 02:51:23 +00002251 assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
shane75ac1de2009-06-09 18:58:52 +00002252 == (int)sqlite3VdbeSerialTypeLen(serial_type) );
drhfdf972a2007-05-02 13:30:27 +00002253 assert( pMem->n<=nBuf );
2254 len = pMem->n;
drhd946db02005-12-29 19:23:06 +00002255 memcpy(buf, pMem->z, len);
drhfdf972a2007-05-02 13:30:27 +00002256 if( pMem->flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00002257 len += pMem->u.nZero;
drh35cd6432009-06-05 14:17:21 +00002258 assert( nBuf>=0 );
2259 if( len > (u32)nBuf ){
2260 len = (u32)nBuf;
drhfdf972a2007-05-02 13:30:27 +00002261 }
2262 memset(&buf[pMem->n], 0, len-pMem->n);
2263 }
drhd946db02005-12-29 19:23:06 +00002264 return len;
2265 }
2266
2267 /* NULL or constants 0 or 1 */
2268 return 0;
danielk1977cfcdaef2004-05-12 07:33:33 +00002269}
2270
2271/*
2272** Deserialize the data blob pointed to by buf as serial type serial_type
2273** and store the result in pMem. Return the number of bytes read.
2274*/
drh35cd6432009-06-05 14:17:21 +00002275u32 sqlite3VdbeSerialGet(
danielk197793d46752004-05-23 13:30:58 +00002276 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00002277 u32 serial_type, /* Serial type to deserialize */
2278 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00002279){
drh3c685822005-05-21 18:32:18 +00002280 switch( serial_type ){
drh3c685822005-05-21 18:32:18 +00002281 case 10: /* Reserved for future use */
2282 case 11: /* Reserved for future use */
2283 case 0: { /* NULL */
2284 pMem->flags = MEM_Null;
2285 break;
2286 }
2287 case 1: { /* 1-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002288 pMem->u.i = (signed char)buf[0];
drh1483e142004-05-21 21:12:42 +00002289 pMem->flags = MEM_Int;
drh3c685822005-05-21 18:32:18 +00002290 return 1;
drh1483e142004-05-21 21:12:42 +00002291 }
drh3c685822005-05-21 18:32:18 +00002292 case 2: { /* 2-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002293 pMem->u.i = (((signed char)buf[0])<<8) | buf[1];
drh3c685822005-05-21 18:32:18 +00002294 pMem->flags = MEM_Int;
2295 return 2;
2296 }
2297 case 3: { /* 3-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002298 pMem->u.i = (((signed char)buf[0])<<16) | (buf[1]<<8) | buf[2];
drh3c685822005-05-21 18:32:18 +00002299 pMem->flags = MEM_Int;
2300 return 3;
2301 }
2302 case 4: { /* 4-byte signed integer */
drh3c024d62007-03-30 11:23:45 +00002303 pMem->u.i = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
drh3c685822005-05-21 18:32:18 +00002304 pMem->flags = MEM_Int;
2305 return 4;
2306 }
2307 case 5: { /* 6-byte signed integer */
2308 u64 x = (((signed char)buf[0])<<8) | buf[1];
2309 u32 y = (buf[2]<<24) | (buf[3]<<16) | (buf[4]<<8) | buf[5];
2310 x = (x<<32) | y;
drh3c024d62007-03-30 11:23:45 +00002311 pMem->u.i = *(i64*)&x;
drh3c685822005-05-21 18:32:18 +00002312 pMem->flags = MEM_Int;
2313 return 6;
2314 }
drh91124b32005-08-18 18:15:05 +00002315 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00002316 case 7: { /* IEEE floating point */
drhd81bd4e2005-09-05 20:06:49 +00002317 u64 x;
2318 u32 y;
drh2a3e4a72006-01-23 21:44:53 +00002319#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
drhde941c62005-08-28 01:34:21 +00002320 /* Verify that integers and floating point values use the same
drh110daac2007-05-04 11:59:31 +00002321 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
2322 ** defined that 64-bit floating point values really are mixed
2323 ** endian.
drhbfd6b032005-08-28 01:38:44 +00002324 */
drhde941c62005-08-28 01:34:21 +00002325 static const u64 t1 = ((u64)0x3ff00000)<<32;
drh4f0c5872007-03-26 22:05:01 +00002326 static const double r1 = 1.0;
drh60d09a72007-08-30 15:05:08 +00002327 u64 t2 = t1;
2328 swapMixedEndianFloat(t2);
2329 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
drhde941c62005-08-28 01:34:21 +00002330#endif
drhbfd6b032005-08-28 01:38:44 +00002331
drhd81bd4e2005-09-05 20:06:49 +00002332 x = (buf[0]<<24) | (buf[1]<<16) | (buf[2]<<8) | buf[3];
2333 y = (buf[4]<<24) | (buf[5]<<16) | (buf[6]<<8) | buf[7];
drh3c685822005-05-21 18:32:18 +00002334 x = (x<<32) | y;
2335 if( serial_type==6 ){
drh3c024d62007-03-30 11:23:45 +00002336 pMem->u.i = *(i64*)&x;
drh3c685822005-05-21 18:32:18 +00002337 pMem->flags = MEM_Int;
2338 }else{
drh4f0c5872007-03-26 22:05:01 +00002339 assert( sizeof(x)==8 && sizeof(pMem->r)==8 );
drh60d09a72007-08-30 15:05:08 +00002340 swapMixedEndianFloat(x);
drh4f0c5872007-03-26 22:05:01 +00002341 memcpy(&pMem->r, &x, sizeof(x));
drh2eaf93d2008-04-29 00:15:20 +00002342 pMem->flags = sqlite3IsNaN(pMem->r) ? MEM_Null : MEM_Real;
drh3c685822005-05-21 18:32:18 +00002343 }
2344 return 8;
2345 }
drhd946db02005-12-29 19:23:06 +00002346 case 8: /* Integer 0 */
2347 case 9: { /* Integer 1 */
drh3c024d62007-03-30 11:23:45 +00002348 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00002349 pMem->flags = MEM_Int;
2350 return 0;
2351 }
drh3c685822005-05-21 18:32:18 +00002352 default: {
drh35cd6432009-06-05 14:17:21 +00002353 u32 len = (serial_type-12)/2;
drh3c685822005-05-21 18:32:18 +00002354 pMem->z = (char *)buf;
2355 pMem->n = len;
2356 pMem->xDel = 0;
2357 if( serial_type&0x01 ){
2358 pMem->flags = MEM_Str | MEM_Ephem;
2359 }else{
2360 pMem->flags = MEM_Blob | MEM_Ephem;
2361 }
2362 return len;
drh696b32f2004-05-30 01:51:52 +00002363 }
danielk1977cfcdaef2004-05-12 07:33:33 +00002364 }
drh3c685822005-05-21 18:32:18 +00002365 return 0;
danielk1977192ac1d2004-05-10 07:17:30 +00002366}
2367
drh0e6082e2006-01-12 20:28:35 +00002368
drh1e968a02008-03-25 00:22:21 +00002369/*
2370** Given the nKey-byte encoding of a record in pKey[], parse the
drhe14006d2008-03-25 17:23:32 +00002371** record into a UnpackedRecord structure. Return a pointer to
drh1e968a02008-03-25 00:22:21 +00002372** that structure.
2373**
2374** The calling function might provide szSpace bytes of memory
2375** space at pSpace. This space can be used to hold the returned
2376** VDbeParsedRecord structure if it is large enough. If it is
2377** not big enough, space is obtained from sqlite3_malloc().
2378**
2379** The returned structure should be closed by a call to
drhe14006d2008-03-25 17:23:32 +00002380** sqlite3VdbeDeleteUnpackedRecord().
drh1e968a02008-03-25 00:22:21 +00002381*/
drhe14006d2008-03-25 17:23:32 +00002382UnpackedRecord *sqlite3VdbeRecordUnpack(
drh1e968a02008-03-25 00:22:21 +00002383 KeyInfo *pKeyInfo, /* Information about the record format */
2384 int nKey, /* Size of the binary record */
2385 const void *pKey, /* The binary record */
drh8c5d1522009-04-10 00:56:28 +00002386 char *pSpace, /* Unaligned space available to hold the object */
drh1e968a02008-03-25 00:22:21 +00002387 int szSpace /* Size of pSpace[] in bytes */
2388){
2389 const unsigned char *aKey = (const unsigned char *)pKey;
drh8c5d1522009-04-10 00:56:28 +00002390 UnpackedRecord *p; /* The unpacked record that we will return */
2391 int nByte; /* Memory space needed to hold p, in bytes */
2392 int d;
danielk197700e13612008-11-17 19:18:54 +00002393 u32 idx;
drh8c5d1522009-04-10 00:56:28 +00002394 u16 u; /* Unsigned loop counter */
drh1e968a02008-03-25 00:22:21 +00002395 u32 szHdr;
2396 Mem *pMem;
drh8c5d1522009-04-10 00:56:28 +00002397 int nOff; /* Increase pSpace by this much to 8-byte align it */
drh1e968a02008-03-25 00:22:21 +00002398
shane80167bf2009-04-10 15:42:36 +00002399 /*
2400 ** We want to shift the pointer pSpace up such that it is 8-byte aligned.
2401 ** Thus, we need to calculate a value, nOff, between 0 and 7, to shift
2402 ** it by. If pSpace is already 8-byte aligned, nOff should be zero.
2403 */
2404 nOff = (8 - (SQLITE_PTR_TO_INT(pSpace) & 7)) & 7;
drh8c5d1522009-04-10 00:56:28 +00002405 pSpace += nOff;
2406 szSpace -= nOff;
2407 nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nField+1);
drh1e968a02008-03-25 00:22:21 +00002408 if( nByte>szSpace ){
2409 p = sqlite3DbMallocRaw(pKeyInfo->db, nByte);
2410 if( p==0 ) return 0;
drhe63d9992008-08-13 19:11:48 +00002411 p->flags = UNPACKED_NEED_FREE | UNPACKED_NEED_DESTROY;
drh1e968a02008-03-25 00:22:21 +00002412 }else{
drh8c5d1522009-04-10 00:56:28 +00002413 p = (UnpackedRecord*)pSpace;
drhe63d9992008-08-13 19:11:48 +00002414 p->flags = UNPACKED_NEED_DESTROY;
drh1e968a02008-03-25 00:22:21 +00002415 }
2416 p->pKeyInfo = pKeyInfo;
2417 p->nField = pKeyInfo->nField + 1;
drh8c5d1522009-04-10 00:56:28 +00002418 p->aMem = pMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
2419 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00002420 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00002421 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00002422 u = 0;
2423 while( idx<szHdr && u<p->nField ){
drh1e968a02008-03-25 00:22:21 +00002424 u32 serial_type;
2425
danielk197700e13612008-11-17 19:18:54 +00002426 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00002427 if( d>=nKey && sqlite3VdbeSerialTypeLen(serial_type)>0 ) break;
2428 pMem->enc = pKeyInfo->enc;
2429 pMem->db = pKeyInfo->db;
2430 pMem->flags = 0;
danielk19775f096132008-03-28 15:44:09 +00002431 pMem->zMalloc = 0;
drh1e968a02008-03-25 00:22:21 +00002432 d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
drhe14006d2008-03-25 17:23:32 +00002433 pMem++;
shane0b8d2762008-07-22 05:18:00 +00002434 u++;
drh1e968a02008-03-25 00:22:21 +00002435 }
drh7d10d5a2008-08-20 16:35:10 +00002436 assert( u<=pKeyInfo->nField + 1 );
shane0b8d2762008-07-22 05:18:00 +00002437 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00002438 return (void*)p;
2439}
2440
2441/*
drh7b746032009-06-26 12:15:22 +00002442** This routine destroys a UnpackedRecord object.
drh1e968a02008-03-25 00:22:21 +00002443*/
drhe14006d2008-03-25 17:23:32 +00002444void sqlite3VdbeDeleteUnpackedRecord(UnpackedRecord *p){
drh7b746032009-06-26 12:15:22 +00002445 int i;
2446 Mem *pMem;
2447
2448 assert( p!=0 );
2449 assert( p->flags & UNPACKED_NEED_DESTROY );
2450 for(i=0, pMem=p->aMem; i<p->nField; i++, pMem++){
drh6be240e2009-07-14 02:33:02 +00002451 /* The unpacked record is always constructed by the
2452 ** sqlite3VdbeUnpackRecord() function above, which makes all
2453 ** strings and blobs static. And none of the elements are
2454 ** ever transformed, so there is never anything to delete.
2455 */
2456 if( NEVER(pMem->zMalloc) ) sqlite3VdbeMemRelease(pMem);
drh7b746032009-06-26 12:15:22 +00002457 }
2458 if( p->flags & UNPACKED_NEED_FREE ){
2459 sqlite3DbFree(p->pKeyInfo->db, p);
drh1e968a02008-03-25 00:22:21 +00002460 }
2461}
2462
2463/*
2464** This function compares the two table rows or index records
2465** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
drhe63d9992008-08-13 19:11:48 +00002466** or positive integer if key1 is less than, equal to or
2467** greater than key2. The {nKey1, pKey1} key must be a blob
drh1e968a02008-03-25 00:22:21 +00002468** created by th OP_MakeRecord opcode of the VDBE. The pPKey2
2469** key must be a parsed key such as obtained from
2470** sqlite3VdbeParseRecord.
2471**
2472** Key1 and Key2 do not have to contain the same number of fields.
drhe63d9992008-08-13 19:11:48 +00002473** The key with fewer fields is usually compares less than the
2474** longer key. However if the UNPACKED_INCRKEY flags in pPKey2 is set
2475** and the common prefixes are equal, then key1 is less than key2.
2476** Or if the UNPACKED_MATCH_PREFIX flag is set and the prefixes are
2477** equal, then the keys are considered to be equal and
drhec1fc802008-08-13 14:07:40 +00002478** the parts beyond the common prefix are ignored.
2479**
drhe63d9992008-08-13 19:11:48 +00002480** If the UNPACKED_IGNORE_ROWID flag is set, then the last byte of
2481** the header of pKey1 is ignored. It is assumed that pKey1 is
2482** an index key, and thus ends with a rowid value. The last byte
2483** of the header will therefore be the serial type of the rowid:
2484** one of 1, 2, 3, 4, 5, 6, 8, or 9 - the integer serial types.
2485** The serial type of the final rowid will always be a single byte.
2486** By ignoring this last byte of the header, we force the comparison
2487** to ignore the rowid at the end of key1.
drh1e968a02008-03-25 00:22:21 +00002488*/
drhe14006d2008-03-25 17:23:32 +00002489int sqlite3VdbeRecordCompare(
drhec1fc802008-08-13 14:07:40 +00002490 int nKey1, const void *pKey1, /* Left key */
drhec1fc802008-08-13 14:07:40 +00002491 UnpackedRecord *pPKey2 /* Right key */
drh1e968a02008-03-25 00:22:21 +00002492){
danielk197700e13612008-11-17 19:18:54 +00002493 int d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00002494 u32 idx1; /* Offset into aKey[] of next header element */
2495 u32 szHdr1; /* Number of bytes in header */
2496 int i = 0;
2497 int nField;
2498 int rc = 0;
2499 const unsigned char *aKey1 = (const unsigned char *)pKey1;
2500 KeyInfo *pKeyInfo;
2501 Mem mem1;
2502
2503 pKeyInfo = pPKey2->pKeyInfo;
2504 mem1.enc = pKeyInfo->enc;
2505 mem1.db = pKeyInfo->db;
2506 mem1.flags = 0;
shane60a4b532009-05-06 18:57:09 +00002507 mem1.u.i = 0; /* not needed, here to silence compiler warning */
danielk19775f096132008-03-28 15:44:09 +00002508 mem1.zMalloc = 0;
drh1e968a02008-03-25 00:22:21 +00002509
shane3f8d5cf2008-04-24 19:15:09 +00002510 idx1 = getVarint32(aKey1, szHdr1);
drh1e968a02008-03-25 00:22:21 +00002511 d1 = szHdr1;
drhe63d9992008-08-13 19:11:48 +00002512 if( pPKey2->flags & UNPACKED_IGNORE_ROWID ){
2513 szHdr1--;
2514 }
drh1e968a02008-03-25 00:22:21 +00002515 nField = pKeyInfo->nField;
2516 while( idx1<szHdr1 && i<pPKey2->nField ){
2517 u32 serial_type1;
2518
2519 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00002520 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drh1e968a02008-03-25 00:22:21 +00002521 if( d1>=nKey1 && sqlite3VdbeSerialTypeLen(serial_type1)>0 ) break;
2522
2523 /* Extract the values to be compared.
2524 */
2525 d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
2526
2527 /* Do the comparison
2528 */
drhe14006d2008-03-25 17:23:32 +00002529 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i],
drh1e968a02008-03-25 00:22:21 +00002530 i<nField ? pKeyInfo->aColl[i] : 0);
drh1e968a02008-03-25 00:22:21 +00002531 if( rc!=0 ){
2532 break;
2533 }
2534 i++;
2535 }
danielk19775f096132008-03-28 15:44:09 +00002536 if( mem1.zMalloc ) sqlite3VdbeMemRelease(&mem1);
drh1e968a02008-03-25 00:22:21 +00002537
danielk1977de630352009-05-04 11:42:29 +00002538 /* If the PREFIX_SEARCH flag is set and all fields except the final
2539 ** rowid field were equal, then clear the PREFIX_SEARCH flag and set
2540 ** pPKey2->rowid to the value of the rowid field in (pKey1, nKey1).
2541 ** This is used by the OP_IsUnique opcode.
2542 */
2543 if( (pPKey2->flags & UNPACKED_PREFIX_SEARCH) && i==(pPKey2->nField-1) ){
2544 assert( idx1==szHdr1 && rc );
2545 assert( mem1.flags & MEM_Int );
2546 pPKey2->flags &= ~UNPACKED_PREFIX_SEARCH;
2547 pPKey2->rowid = mem1.u.i;
2548 }
2549
drh1e968a02008-03-25 00:22:21 +00002550 if( rc==0 ){
drhec1fc802008-08-13 14:07:40 +00002551 /* rc==0 here means that one of the keys ran out of fields and
drhe63d9992008-08-13 19:11:48 +00002552 ** all the fields up to that point were equal. If the UNPACKED_INCRKEY
2553 ** flag is set, then break the tie by treating key2 as larger.
2554 ** If the UPACKED_PREFIX_MATCH flag is set, then keys with common prefixes
drhec1fc802008-08-13 14:07:40 +00002555 ** are considered to be equal. Otherwise, the longer key is the
2556 ** larger. As it happens, the pPKey2 will always be the longer
2557 ** if there is a difference.
2558 */
drhe63d9992008-08-13 19:11:48 +00002559 if( pPKey2->flags & UNPACKED_INCRKEY ){
drh1e968a02008-03-25 00:22:21 +00002560 rc = -1;
drhe63d9992008-08-13 19:11:48 +00002561 }else if( pPKey2->flags & UNPACKED_PREFIX_MATCH ){
drhec1fc802008-08-13 14:07:40 +00002562 /* Leave rc==0 */
2563 }else if( idx1<szHdr1 ){
2564 rc = 1;
drh1e968a02008-03-25 00:22:21 +00002565 }
2566 }else if( pKeyInfo->aSortOrder && i<pKeyInfo->nField
2567 && pKeyInfo->aSortOrder[i] ){
2568 rc = -rc;
2569 }
2570
2571 return rc;
2572}
drhec1fc802008-08-13 14:07:40 +00002573
danielk1977eb015e02004-05-18 01:31:14 +00002574
2575/*
drh7a224de2004-06-02 01:22:02 +00002576** pCur points at an index entry created using the OP_MakeRecord opcode.
2577** Read the rowid (the last field in the record) and store it in *rowid.
2578** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00002579**
2580** pCur might be pointing to text obtained from a corrupt database file.
2581** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00002582*/
drh35f6b932009-06-23 14:15:04 +00002583int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00002584 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00002585 int rc;
drhd5788202004-05-28 08:21:05 +00002586 u32 szHdr; /* Size of the header */
2587 u32 typeRowid; /* Serial type of the rowid */
2588 u32 lenRowid; /* Size of the rowid */
2589 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00002590
drh88a003e2008-12-11 16:17:03 +00002591 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00002592 ** than 2GiB are support - anything large must be database corruption.
2593 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
2594 ** this code can safely assume that nCellKey is 32-bits */
drhd5788202004-05-28 08:21:05 +00002595 sqlite3BtreeKeySize(pCur, &nCellKey);
drh7b746032009-06-26 12:15:22 +00002596 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00002597
2598 /* Read in the complete content of the index entry */
danielk1977a7a8e142008-02-13 18:25:27 +00002599 m.flags = 0;
drh35f6b932009-06-23 14:15:04 +00002600 m.db = db;
danielk19775f096132008-03-28 15:44:09 +00002601 m.zMalloc = 0;
drh8df32842008-12-09 02:51:23 +00002602 rc = sqlite3VdbeMemFromBtree(pCur, 0, (int)nCellKey, 1, &m);
drhd5788202004-05-28 08:21:05 +00002603 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00002604 return rc;
2605 }
drh88a003e2008-12-11 16:17:03 +00002606
2607 /* The index entry must begin with a header size */
shane3f8d5cf2008-04-24 19:15:09 +00002608 (void)getVarint32((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00002609 testcase( szHdr==3 );
drh88a003e2008-12-11 16:17:03 +00002610 testcase( szHdr==m.n );
drh7b746032009-06-26 12:15:22 +00002611 if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
drh88a003e2008-12-11 16:17:03 +00002612 goto idx_rowid_corruption;
2613 }
2614
2615 /* The last field of the index should be an integer - the ROWID.
2616 ** Verify that the last entry really is an integer. */
shane3f8d5cf2008-04-24 19:15:09 +00002617 (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00002618 testcase( typeRowid==1 );
2619 testcase( typeRowid==2 );
2620 testcase( typeRowid==3 );
2621 testcase( typeRowid==4 );
2622 testcase( typeRowid==5 );
2623 testcase( typeRowid==6 );
2624 testcase( typeRowid==8 );
2625 testcase( typeRowid==9 );
2626 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
2627 goto idx_rowid_corruption;
2628 }
drhd5788202004-05-28 08:21:05 +00002629 lenRowid = sqlite3VdbeSerialTypeLen(typeRowid);
drh5f82e3c2009-07-06 00:44:08 +00002630 testcase( m.n==szHdr+lenRowid );
2631 if( unlikely(m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00002632 goto idx_rowid_corruption;
2633 }
2634
2635 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00002636 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00002637 *rowid = v.u.i;
danielk1977d8123362004-06-12 09:25:12 +00002638 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00002639 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00002640
2641 /* Jump here if database corruption is detected after m has been
2642 ** allocated. Free the m object and return SQLITE_CORRUPT. */
2643idx_rowid_corruption:
2644 testcase( m.zMalloc!=0 );
2645 sqlite3VdbeMemRelease(&m);
2646 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00002647}
2648
drh7cf6e4d2004-05-19 14:56:55 +00002649/*
drh5f82e3c2009-07-06 00:44:08 +00002650** Compare the key of the index entry that cursor pC is pointing to against
2651** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00002652** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00002653** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00002654**
drh5f82e3c2009-07-06 00:44:08 +00002655** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00002656** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00002657** is ignored as well. Hence, this routine only compares the prefixes
2658** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00002659*/
danielk1977183f9f72004-05-13 05:20:26 +00002660int sqlite3VdbeIdxKeyCompare(
drhdfe88ec2008-11-03 20:55:06 +00002661 VdbeCursor *pC, /* The cursor to compare against */
drh5f82e3c2009-07-06 00:44:08 +00002662 UnpackedRecord *pUnpacked, /* Unpacked version of key to compare against */
drh7cf6e4d2004-05-19 14:56:55 +00002663 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00002664){
drh61fc5952007-04-01 23:49:51 +00002665 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00002666 int rc;
danielk19773d1bfea2004-05-14 11:00:53 +00002667 BtCursor *pCur = pC->pCursor;
drhd5788202004-05-28 08:21:05 +00002668 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00002669
2670 sqlite3BtreeKeySize(pCur, &nCellKey);
drh8df32842008-12-09 02:51:23 +00002671 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00002672 *res = 0;
2673 return SQLITE_OK;
2674 }
danielk1977a7a8e142008-02-13 18:25:27 +00002675 m.db = 0;
2676 m.flags = 0;
danielk19775f096132008-03-28 15:44:09 +00002677 m.zMalloc = 0;
drh8df32842008-12-09 02:51:23 +00002678 rc = sqlite3VdbeMemFromBtree(pC->pCursor, 0, (int)nCellKey, 1, &m);
drhec1fc802008-08-13 14:07:40 +00002679 if( rc ){
drhd5788202004-05-28 08:21:05 +00002680 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00002681 }
drhe63d9992008-08-13 19:11:48 +00002682 assert( pUnpacked->flags & UNPACKED_IGNORE_ROWID );
2683 *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
danielk1977d8123362004-06-12 09:25:12 +00002684 sqlite3VdbeMemRelease(&m);
danielk1977183f9f72004-05-13 05:20:26 +00002685 return SQLITE_OK;
2686}
danielk1977b28af712004-06-21 06:50:26 +00002687
2688/*
2689** This routine sets the value to be returned by subsequent calls to
2690** sqlite3_changes() on the database handle 'db'.
2691*/
2692void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
drhb21c8cd2007-08-21 19:33:56 +00002693 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00002694 db->nChange = nChange;
2695 db->nTotalChange += nChange;
2696}
2697
2698/*
2699** Set a flag in the vdbe to update the change counter when it is finalised
2700** or reset.
2701*/
drh4794f732004-11-05 17:17:50 +00002702void sqlite3VdbeCountChanges(Vdbe *v){
2703 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00002704}
drhd89bd002005-01-22 03:03:54 +00002705
2706/*
2707** Mark every prepared statement associated with a database connection
2708** as expired.
2709**
2710** An expired statement means that recompilation of the statement is
2711** recommend. Statements expire when things happen that make their
2712** programs obsolete. Removing user-defined functions or collating
2713** sequences, or changing an authorization function are the types of
2714** things that make prepared statements obsolete.
2715*/
2716void sqlite3ExpirePreparedStatements(sqlite3 *db){
2717 Vdbe *p;
2718 for(p = db->pVdbe; p; p=p->pNext){
2719 p->expired = 1;
2720 }
2721}
danielk1977aee18ef2005-03-09 12:26:50 +00002722
2723/*
2724** Return the database associated with the Vdbe.
2725*/
2726sqlite3 *sqlite3VdbeDb(Vdbe *v){
2727 return v->db;
2728}