blob: 93332a3738f7d47960d32cd13f36dcc23d81ec49 [file] [log] [blame]
drh9a324642003-09-06 20:12:01 +00001/*
2** 2003 September 6
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains code used for creating, destroying, and populating
drh7abda852014-09-19 16:02:06 +000013** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)
drh9a324642003-09-06 20:12:01 +000014*/
15#include "sqliteInt.h"
drh9a324642003-09-06 20:12:01 +000016#include "vdbeInt.h"
17
drh920cf592019-10-30 16:29:02 +000018/* Forward references */
19static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef);
20static void vdbeFreeOpArray(sqlite3 *, Op *, int);
21
drh9a324642003-09-06 20:12:01 +000022/*
23** Create a new virtual database engine.
24*/
drh9ac79622013-12-18 15:11:47 +000025Vdbe *sqlite3VdbeCreate(Parse *pParse){
26 sqlite3 *db = pParse->db;
drh9a324642003-09-06 20:12:01 +000027 Vdbe *p;
drhd8e4b132016-10-01 19:21:56 +000028 p = sqlite3DbMallocRawNN(db, sizeof(Vdbe) );
drh9a324642003-09-06 20:12:01 +000029 if( p==0 ) return 0;
drhab3182f2016-10-01 00:37:50 +000030 memset(&p->aOp, 0, sizeof(Vdbe)-offsetof(Vdbe,aOp));
drh9a324642003-09-06 20:12:01 +000031 p->db = db;
32 if( db->pVdbe ){
drhe5928b12022-08-23 20:11:01 +000033 db->pVdbe->ppVPrev = &p->pVNext;
drh9a324642003-09-06 20:12:01 +000034 }
drhe5928b12022-08-23 20:11:01 +000035 p->pVNext = db->pVdbe;
36 p->ppVPrev = &db->pVdbe;
drh9a324642003-09-06 20:12:01 +000037 db->pVdbe = p;
drh66181ce2022-03-31 20:04:49 +000038 assert( p->eVdbeState==VDBE_INIT_STATE );
drh9ac79622013-12-18 15:11:47 +000039 p->pParse = pParse;
drh55965612017-09-16 20:58:41 +000040 pParse->pVdbe = p;
drh73d5b8f2013-12-23 19:09:07 +000041 assert( pParse->aLabel==0 );
42 assert( pParse->nLabel==0 );
drhb6991792018-12-28 20:14:03 +000043 assert( p->nOpAlloc==0 );
drhbd573082016-01-01 16:42:09 +000044 assert( pParse->szOpAlloc==0 );
drh55965612017-09-16 20:58:41 +000045 sqlite3VdbeAddOp2(p, OP_Init, 0, 1);
drh9a324642003-09-06 20:12:01 +000046 return p;
47}
48
49/*
drh6df9c4b2019-10-18 12:52:08 +000050** Return the Parse object that owns a Vdbe object.
51*/
52Parse *sqlite3VdbeParser(Vdbe *p){
53 return p->pParse;
54}
55
56/*
drh22c17b82015-05-15 04:13:15 +000057** Change the error string stored in Vdbe.zErrMsg
58*/
59void sqlite3VdbeError(Vdbe *p, const char *zFormat, ...){
60 va_list ap;
61 sqlite3DbFree(p->db, p->zErrMsg);
62 va_start(ap, zFormat);
63 p->zErrMsg = sqlite3VMPrintf(p->db, zFormat, ap);
64 va_end(ap);
65}
66
67/*
drhb900aaf2006-11-09 00:24:53 +000068** Remember the SQL string for a prepared statement.
69*/
drh2c2f3922017-06-01 00:54:35 +000070void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, u8 prepFlags){
drhb900aaf2006-11-09 00:24:53 +000071 if( p==0 ) return;
drh2c2f3922017-06-01 00:54:35 +000072 p->prepFlags = prepFlags;
73 if( (prepFlags & SQLITE_PREPARE_SAVESQL)==0 ){
74 p->expmask = 0;
75 }
drhb900aaf2006-11-09 00:24:53 +000076 assert( p->zSql==0 );
drh17435752007-08-16 04:30:38 +000077 p->zSql = sqlite3DbStrNDup(p->db, z, n);
drhb900aaf2006-11-09 00:24:53 +000078}
79
drh893bd372018-12-07 16:32:11 +000080#ifdef SQLITE_ENABLE_NORMALIZE
81/*
82** Add a new element to the Vdbe->pDblStr list.
83*/
84void sqlite3VdbeAddDblquoteStr(sqlite3 *db, Vdbe *p, const char *z){
85 if( p ){
86 int n = sqlite3Strlen30(z);
87 DblquoteStr *pStr = sqlite3DbMallocRawNN(db,
88 sizeof(*pStr)+n+1-sizeof(pStr->z));
89 if( pStr ){
90 pStr->pNextStr = p->pDblStr;
91 p->pDblStr = pStr;
92 memcpy(pStr->z, z, n+1);
93 }
94 }
95}
96#endif
97
98#ifdef SQLITE_ENABLE_NORMALIZE
99/*
100** zId of length nId is a double-quoted identifier. Check to see if
101** that identifier is really used as a string literal.
102*/
103int sqlite3VdbeUsesDoubleQuotedString(
drh893bd372018-12-07 16:32:11 +0000104 Vdbe *pVdbe, /* The prepared statement */
drh643d8552018-12-10 16:00:57 +0000105 const char *zId /* The double-quoted identifier, already dequoted */
drh893bd372018-12-07 16:32:11 +0000106){
drh893bd372018-12-07 16:32:11 +0000107 DblquoteStr *pStr;
108 assert( zId!=0 );
drh893bd372018-12-07 16:32:11 +0000109 if( pVdbe->pDblStr==0 ) return 0;
drh893bd372018-12-07 16:32:11 +0000110 for(pStr=pVdbe->pDblStr; pStr; pStr=pStr->pNextStr){
drh643d8552018-12-10 16:00:57 +0000111 if( strcmp(zId, pStr->z)==0 ) return 1;
drh893bd372018-12-07 16:32:11 +0000112 }
drh643d8552018-12-10 16:00:57 +0000113 return 0;
drh893bd372018-12-07 16:32:11 +0000114}
115#endif
116
drhb900aaf2006-11-09 00:24:53 +0000117/*
drha57ac0a2022-07-03 11:16:03 +0000118** Swap byte-code between two VDBE structures.
119**
120** This happens after pB was previously run and returned
121** SQLITE_SCHEMA. The statement was then reprepared in pA.
122** This routine transfers the new bytecode in pA over to pB
123** so that pB can be run again. The old pB byte code is
124** moved back to pA so that it will be cleaned up when pA is
125** finalized.
drhb900aaf2006-11-09 00:24:53 +0000126*/
drhc5155252007-01-08 21:07:17 +0000127void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
drhe5928b12022-08-23 20:11:01 +0000128 Vdbe tmp, *pTmp, **ppTmp;
drhc5155252007-01-08 21:07:17 +0000129 char *zTmp;
drh0639c342011-03-18 12:35:36 +0000130 assert( pA->db==pB->db );
drhc5155252007-01-08 21:07:17 +0000131 tmp = *pA;
132 *pA = *pB;
133 *pB = tmp;
drhe5928b12022-08-23 20:11:01 +0000134 pTmp = pA->pVNext;
135 pA->pVNext = pB->pVNext;
136 pB->pVNext = pTmp;
137 ppTmp = pA->ppVPrev;
138 pA->ppVPrev = pB->ppVPrev;
139 pB->ppVPrev = ppTmp;
drhc5155252007-01-08 21:07:17 +0000140 zTmp = pA->zSql;
141 pA->zSql = pB->zSql;
142 pB->zSql = zTmp;
mistachkin4a4c1bf2019-11-19 00:13:42 +0000143#ifdef SQLITE_ENABLE_NORMALIZE
mistachkin8bee11a2018-10-29 17:53:23 +0000144 zTmp = pA->zNormSql;
145 pA->zNormSql = pB->zNormSql;
146 pB->zNormSql = zTmp;
147#endif
drh76adb232017-03-02 13:13:30 +0000148 pB->expmask = pA->expmask;
drh2c2f3922017-06-01 00:54:35 +0000149 pB->prepFlags = pA->prepFlags;
drh00d11d42017-06-29 12:49:18 +0000150 memcpy(pB->aCounter, pA->aCounter, sizeof(pB->aCounter));
151 pB->aCounter[SQLITE_STMTSTATUS_REPREPARE]++;
drhb900aaf2006-11-09 00:24:53 +0000152}
153
drh9a324642003-09-06 20:12:01 +0000154/*
dan76ccd892014-08-12 13:38:52 +0000155** Resize the Vdbe.aOp array so that it is at least nOp elements larger
drh81e069e2014-08-12 14:29:20 +0000156** than its current size. nOp is guaranteed to be less than or equal
157** to 1024/sizeof(Op).
danielk1977ace3eb22006-01-26 10:35:04 +0000158**
danielk197700e13612008-11-17 19:18:54 +0000159** If an out-of-memory error occurs while resizing the array, return
drhb6991792018-12-28 20:14:03 +0000160** SQLITE_NOMEM. In this case Vdbe.aOp and Vdbe.nOpAlloc remain
danielk197700e13612008-11-17 19:18:54 +0000161** unchanged (this is so that any opcodes already allocated can be
162** correctly deallocated along with the rest of the Vdbe).
drh76ff3a02004-09-24 22:32:30 +0000163*/
dan76ccd892014-08-12 13:38:52 +0000164static int growOpArray(Vdbe *v, int nOp){
drha4e5d582007-10-20 15:41:57 +0000165 VdbeOp *pNew;
drh73d5b8f2013-12-23 19:09:07 +0000166 Parse *p = v->pParse;
dan76ccd892014-08-12 13:38:52 +0000167
drh81e069e2014-08-12 14:29:20 +0000168 /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
169 ** more frequent reallocs and hence provide more opportunities for
170 ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
171 ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
172 ** by the minimum* amount required until the size reaches 512. Normal
173 ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
174 ** size of the op array or add 1KB of space, whichever is smaller. */
dan76ccd892014-08-12 13:38:52 +0000175#ifdef SQLITE_TEST_REALLOC_STRESS
drh0aa32312019-04-13 04:01:12 +0000176 sqlite3_int64 nNew = (v->nOpAlloc>=512 ? 2*(sqlite3_int64)v->nOpAlloc
177 : (sqlite3_int64)v->nOpAlloc+nOp);
dan76ccd892014-08-12 13:38:52 +0000178#else
drh0aa32312019-04-13 04:01:12 +0000179 sqlite3_int64 nNew = (v->nOpAlloc ? 2*(sqlite3_int64)v->nOpAlloc
drhf6ad2012019-04-13 14:07:57 +0000180 : (sqlite3_int64)(1024/sizeof(Op)));
dan76ccd892014-08-12 13:38:52 +0000181 UNUSED_PARAMETER(nOp);
182#endif
183
drh1cb02662017-03-17 22:50:16 +0000184 /* Ensure that the size of a VDBE does not grow too large */
185 if( nNew > p->db->aLimit[SQLITE_LIMIT_VDBE_OP] ){
186 sqlite3OomFault(p->db);
187 return SQLITE_NOMEM;
188 }
189
drhe684ac62022-03-08 13:59:46 +0000190 assert( nOp<=(int)(1024/sizeof(Op)) );
drhb6991792018-12-28 20:14:03 +0000191 assert( nNew>=(v->nOpAlloc+nOp) );
drh73d5b8f2013-12-23 19:09:07 +0000192 pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
drha4e5d582007-10-20 15:41:57 +0000193 if( pNew ){
drhbd573082016-01-01 16:42:09 +0000194 p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
drhb6991792018-12-28 20:14:03 +0000195 v->nOpAlloc = p->szOpAlloc/sizeof(Op);
drh73d5b8f2013-12-23 19:09:07 +0000196 v->aOp = pNew;
drh76ff3a02004-09-24 22:32:30 +0000197 }
mistachkinfad30392016-02-13 23:43:46 +0000198 return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
drh76ff3a02004-09-24 22:32:30 +0000199}
200
drh313619f2013-10-31 20:34:06 +0000201#ifdef SQLITE_DEBUG
202/* This routine is just a convenient place to set a breakpoint that will
203** fire after each opcode is inserted and displayed using
drh52f11b82020-01-02 13:26:49 +0000204** "PRAGMA vdbe_addoptrace=on". Parameters "pc" (program counter) and
205** pOp are available to make the breakpoint conditional.
206**
207** Other useful labels for breakpoints include:
208** test_trace_breakpoint(pc,pOp)
209** sqlite3CorruptError(lineno)
210** sqlite3MisuseError(lineno)
211** sqlite3CantopenError(lineno)
drh313619f2013-10-31 20:34:06 +0000212*/
drh52f11b82020-01-02 13:26:49 +0000213static void test_addop_breakpoint(int pc, Op *pOp){
drh313619f2013-10-31 20:34:06 +0000214 static int n = 0;
215 n++;
216}
217#endif
218
drh76ff3a02004-09-24 22:32:30 +0000219/*
drh9a324642003-09-06 20:12:01 +0000220** Add a new instruction to the list of instructions current in the
221** VDBE. Return the address of the new instruction.
222**
223** Parameters:
224**
225** p Pointer to the VDBE
226**
227** op The opcode for this instruction
228**
drh66a51672008-01-03 00:01:23 +0000229** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000230**
danielk19774adee202004-05-08 08:23:19 +0000231** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000232** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000233** operand.
234*/
drhd7970352015-11-09 12:33:39 +0000235static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
drhb6991792018-12-28 20:14:03 +0000236 assert( p->nOpAlloc<=p->nOp );
drhd7970352015-11-09 12:33:39 +0000237 if( growOpArray(p, 1) ) return 1;
drhb6991792018-12-28 20:14:03 +0000238 assert( p->nOpAlloc>p->nOp );
drhd7970352015-11-09 12:33:39 +0000239 return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
240}
drh66a51672008-01-03 00:01:23 +0000241int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000242 int i;
drh701a0ae2004-02-22 20:05:00 +0000243 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000244
245 i = p->nOp;
drh66181ce2022-03-31 20:04:49 +0000246 assert( p->eVdbeState==VDBE_INIT_STATE );
drhed94af52016-02-01 17:20:08 +0000247 assert( op>=0 && op<0xff );
drhb6991792018-12-28 20:14:03 +0000248 if( p->nOpAlloc<=i ){
drhd7970352015-11-09 12:33:39 +0000249 return growOp3(p, op, p1, p2, p3);
drh9a324642003-09-06 20:12:01 +0000250 }
drhc59ffa82021-10-04 15:08:49 +0000251 assert( p->aOp!=0 );
danielk197701256832007-04-18 14:24:32 +0000252 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000253 pOp = &p->aOp[i];
drhc59ffa82021-10-04 15:08:49 +0000254 assert( pOp!=0 );
drh8df32842008-12-09 02:51:23 +0000255 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000256 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000257 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000258 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000259 pOp->p3 = p3;
260 pOp->p4.p = 0;
261 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000262#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000263 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000264#endif
265#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000266 if( p->db->flags & SQLITE_VdbeAddopTrace ){
267 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh52f11b82020-01-02 13:26:49 +0000268 test_addop_breakpoint(i, &p->aOp[i]);
drhe0962052013-01-29 19:14:31 +0000269 }
drh9a324642003-09-06 20:12:01 +0000270#endif
drh26c9b5e2008-04-11 14:56:53 +0000271#ifdef VDBE_PROFILE
272 pOp->cycles = 0;
273 pOp->cnt = 0;
274#endif
drh688852a2014-02-17 22:40:43 +0000275#ifdef SQLITE_VDBE_COVERAGE
276 pOp->iSrcLine = 0;
277#endif
drh9a324642003-09-06 20:12:01 +0000278 return i;
279}
drh66a51672008-01-03 00:01:23 +0000280int sqlite3VdbeAddOp0(Vdbe *p, int op){
281 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
282}
283int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
284 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
285}
286int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
287 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000288}
289
drh076e85f2015-09-03 13:46:12 +0000290/* Generate code for an unconditional jump to instruction iDest
291*/
292int sqlite3VdbeGoto(Vdbe *p, int iDest){
drh2991ba02015-09-02 18:19:00 +0000293 return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
294}
drh701a0ae2004-02-22 20:05:00 +0000295
drh076e85f2015-09-03 13:46:12 +0000296/* Generate code to cause the string zStr to be loaded into
297** register iDest
298*/
299int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
300 return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
301}
302
303/*
304** Generate code that initializes multiple registers to string or integer
305** constants. The registers begin with iDest and increase consecutively.
306** One register is initialized for each characgter in zTypes[]. For each
307** "s" character in zTypes[], the register is a string if the argument is
308** not NULL, or OP_Null if the value is a null pointer. For each "i" character
309** in zTypes[], the register is initialized to an integer.
drh40cf27c2017-07-07 16:00:53 +0000310**
311** If the input string does not end with "X" then an OP_ResultRow instruction
312** is generated for the values inserted.
drh076e85f2015-09-03 13:46:12 +0000313*/
314void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
315 va_list ap;
316 int i;
317 char c;
318 va_start(ap, zTypes);
319 for(i=0; (c = zTypes[i])!=0; i++){
320 if( c=='s' ){
321 const char *z = va_arg(ap, const char*);
drh40cf27c2017-07-07 16:00:53 +0000322 sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest+i, 0, z, 0);
323 }else if( c=='i' ){
324 sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest+i);
drh076e85f2015-09-03 13:46:12 +0000325 }else{
drh40cf27c2017-07-07 16:00:53 +0000326 goto skip_op_resultrow;
drh076e85f2015-09-03 13:46:12 +0000327 }
328 }
drh40cf27c2017-07-07 16:00:53 +0000329 sqlite3VdbeAddOp2(p, OP_ResultRow, iDest, i);
330skip_op_resultrow:
drh076e85f2015-09-03 13:46:12 +0000331 va_end(ap);
332}
drh66a51672008-01-03 00:01:23 +0000333
drh701a0ae2004-02-22 20:05:00 +0000334/*
drh66a51672008-01-03 00:01:23 +0000335** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000336*/
drh66a51672008-01-03 00:01:23 +0000337int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000338 Vdbe *p, /* Add the opcode to this VM */
339 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000340 int p1, /* The P1 operand */
341 int p2, /* The P2 operand */
342 int p3, /* The P3 operand */
343 const char *zP4, /* The P4 operand */
344 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000345){
drh66a51672008-01-03 00:01:23 +0000346 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
347 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000348 return addr;
349}
350
351/*
drh920cf592019-10-30 16:29:02 +0000352** Add an OP_Function or OP_PureFunc opcode.
353**
354** The eCallCtx argument is information (typically taken from Expr.op2)
355** that describes the calling context of the function. 0 means a general
356** function call. NC_IsCheck means called by a check constraint,
357** NC_IdxExpr means called as part of an index expression. NC_PartIdx
358** means in the WHERE clause of a partial index. NC_GenCol means called
359** while computing a generated column value. 0 is the usual case.
360*/
361int sqlite3VdbeAddFunctionCall(
362 Parse *pParse, /* Parsing context */
363 int p1, /* Constant argument mask */
364 int p2, /* First argument register */
365 int p3, /* Register into which results are written */
366 int nArg, /* Number of argument */
367 const FuncDef *pFunc, /* The function to be invoked */
368 int eCallCtx /* Calling context */
369){
370 Vdbe *v = pParse->pVdbe;
371 int nByte;
372 int addr;
373 sqlite3_context *pCtx;
374 assert( v );
375 nByte = sizeof(*pCtx) + (nArg-1)*sizeof(sqlite3_value*);
376 pCtx = sqlite3DbMallocRawNN(pParse->db, nByte);
377 if( pCtx==0 ){
378 assert( pParse->db->mallocFailed );
379 freeEphemeralFunction(pParse->db, (FuncDef*)pFunc);
380 return 0;
381 }
382 pCtx->pOut = 0;
383 pCtx->pFunc = (FuncDef*)pFunc;
drh20cee7d2019-10-30 18:50:08 +0000384 pCtx->pVdbe = 0;
drh920cf592019-10-30 16:29:02 +0000385 pCtx->isError = 0;
386 pCtx->argc = nArg;
drhf2b9d7c2019-11-01 16:37:53 +0000387 pCtx->iOp = sqlite3VdbeCurrentAddr(v);
drh920cf592019-10-30 16:29:02 +0000388 addr = sqlite3VdbeAddOp4(v, eCallCtx ? OP_PureFunc : OP_Function,
389 p1, p2, p3, (char*)pCtx, P4_FUNCCTX);
drh20cee7d2019-10-30 18:50:08 +0000390 sqlite3VdbeChangeP5(v, eCallCtx & NC_SelfRef);
drh4d288302022-08-30 00:11:51 +0000391 sqlite3MayAbort(pParse);
drh920cf592019-10-30 16:29:02 +0000392 return addr;
393}
394
395/*
drh7cc023c2015-09-03 04:28:25 +0000396** Add an opcode that includes the p4 value with a P4_INT64 or
397** P4_REAL type.
drh97bae792015-06-05 15:59:57 +0000398*/
399int sqlite3VdbeAddOp4Dup8(
400 Vdbe *p, /* Add the opcode to this VM */
401 int op, /* The new opcode */
402 int p1, /* The P1 operand */
403 int p2, /* The P2 operand */
404 int p3, /* The P3 operand */
405 const u8 *zP4, /* The P4 operand */
406 int p4type /* P4 operand type */
407){
drh575fad62016-02-05 13:38:36 +0000408 char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
drh97bae792015-06-05 15:59:57 +0000409 if( p4copy ) memcpy(p4copy, zP4, 8);
410 return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
411}
412
drhe2ca99c2018-05-02 00:33:43 +0000413#ifndef SQLITE_OMIT_EXPLAIN
414/*
415** Return the address of the current EXPLAIN QUERY PLAN baseline.
416** 0 means "none".
417*/
418int sqlite3VdbeExplainParent(Parse *pParse){
419 VdbeOp *pOp;
420 if( pParse->addrExplain==0 ) return 0;
421 pOp = sqlite3VdbeGetOp(pParse->pVdbe, pParse->addrExplain);
422 return pOp->p2;
423}
424
425/*
drhbd462bc2018-12-24 20:21:06 +0000426** Set a debugger breakpoint on the following routine in order to
427** monitor the EXPLAIN QUERY PLAN code generation.
428*/
429#if defined(SQLITE_DEBUG)
430void sqlite3ExplainBreakpoint(const char *z1, const char *z2){
431 (void)z1;
432 (void)z2;
433}
434#endif
435
436/*
drh91a23dc2020-03-19 15:57:03 +0000437** Add a new OP_Explain opcode.
drhe2ca99c2018-05-02 00:33:43 +0000438**
439** If the bPush flag is true, then make this opcode the parent for
440** subsequent Explains until sqlite3VdbeExplainPop() is called.
441*/
442void sqlite3VdbeExplain(Parse *pParse, u8 bPush, const char *zFmt, ...){
drhc310c532018-12-24 18:10:39 +0000443#ifndef SQLITE_DEBUG
444 /* Always include the OP_Explain opcodes if SQLITE_DEBUG is defined.
445 ** But omit them (for performance) during production builds */
446 if( pParse->explain==2 )
447#endif
448 {
drhe2ca99c2018-05-02 00:33:43 +0000449 char *zMsg;
drhc4ceea72018-08-21 12:16:33 +0000450 Vdbe *v;
drhe2ca99c2018-05-02 00:33:43 +0000451 va_list ap;
452 int iThis;
453 va_start(ap, zFmt);
454 zMsg = sqlite3VMPrintf(pParse->db, zFmt, ap);
455 va_end(ap);
456 v = pParse->pVdbe;
457 iThis = v->nOp;
458 sqlite3VdbeAddOp4(v, OP_Explain, iThis, pParse->addrExplain, 0,
459 zMsg, P4_DYNAMIC);
drh058e9952022-07-25 19:05:24 +0000460 sqlite3ExplainBreakpoint(bPush?"PUSH":"", sqlite3VdbeGetLastOp(v)->p4.z);
drhbd462bc2018-12-24 20:21:06 +0000461 if( bPush){
462 pParse->addrExplain = iThis;
463 }
drhe2ca99c2018-05-02 00:33:43 +0000464 }
465}
466
467/*
468** Pop the EXPLAIN QUERY PLAN stack one level.
469*/
470void sqlite3VdbeExplainPop(Parse *pParse){
drhbd462bc2018-12-24 20:21:06 +0000471 sqlite3ExplainBreakpoint("POP", 0);
drhe2ca99c2018-05-02 00:33:43 +0000472 pParse->addrExplain = sqlite3VdbeExplainParent(pParse);
473}
474#endif /* SQLITE_OMIT_EXPLAIN */
475
drh97bae792015-06-05 15:59:57 +0000476/*
drh5d9c9da2011-06-03 20:11:17 +0000477** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000478** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
479** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000480**
481** The zWhere string must have been obtained from sqlite3_malloc().
482** This routine will take ownership of the allocated memory.
483*/
dan6a5a13d2021-02-17 20:08:22 +0000484void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere, u16 p5){
drh5d9c9da2011-06-03 20:11:17 +0000485 int j;
drh00dceca2016-01-11 22:58:50 +0000486 sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
dan6a5a13d2021-02-17 20:08:22 +0000487 sqlite3VdbeChangeP5(p, p5);
drh5d9c9da2011-06-03 20:11:17 +0000488 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
drhed7974d2020-10-26 18:14:12 +0000489 sqlite3MayAbort(p->pParse);
drh5d9c9da2011-06-03 20:11:17 +0000490}
491
492/*
drh8cff69d2009-11-12 19:59:44 +0000493** Add an opcode that includes the p4 value as an integer.
494*/
495int sqlite3VdbeAddOp4Int(
496 Vdbe *p, /* Add the opcode to this VM */
497 int op, /* The new opcode */
498 int p1, /* The P1 operand */
499 int p2, /* The P2 operand */
500 int p3, /* The P3 operand */
501 int p4 /* The P4 operand as an integer */
502){
503 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
drhbdaa1ee2016-12-07 20:09:51 +0000504 if( p->db->mallocFailed==0 ){
505 VdbeOp *pOp = &p->aOp[addr];
506 pOp->p4type = P4_INT32;
507 pOp->p4.i = p4;
508 }
drh8cff69d2009-11-12 19:59:44 +0000509 return addr;
510}
511
drh2fade2f2016-02-09 02:12:20 +0000512/* Insert the end of a co-routine
513*/
514void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
515 sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
516
517 /* Clear the temporary register cache, thereby ensuring that each
518 ** co-routine has its own independent set of registers, because co-routines
519 ** might expect their registers to be preserved across an OP_Yield, and
520 ** that could cause problems if two or more co-routines are using the same
521 ** temporary register.
522 */
523 v->pParse->nTempReg = 0;
524 v->pParse->nRangeReg = 0;
525}
526
drh8cff69d2009-11-12 19:59:44 +0000527/*
drh9a324642003-09-06 20:12:01 +0000528** Create a new symbolic label for an instruction that has yet to be
529** coded. The symbolic label is really just a negative number. The
530** label can be used as the P2 value of an operation. Later, when
531** the label is resolved to a specific address, the VDBE will scan
532** through its operation list and change all values of P2 which match
533** the label into the resolved address.
534**
535** The VDBE knows that a P2 value is a label because labels are
536** always negative and P2 values are suppose to be non-negative.
537** Hence, a negative P2 value is a label that has yet to be resolved.
drhd1d158b2018-12-29 14:23:22 +0000538** (Later:) This is only true for opcodes that have the OPFLG_JUMP
539** property.
danielk1977b5548a82004-06-26 13:51:33 +0000540**
drhd1d158b2018-12-29 14:23:22 +0000541** Variable usage notes:
542**
543** Parse.aLabel[x] Stores the address that the x-th label resolves
544** into. For testing (SQLITE_DEBUG), unresolved
545** labels stores -1, but that is not required.
546** Parse.nLabelAlloc Number of slots allocated to Parse.aLabel[]
547** Parse.nLabel The *negative* of the number of labels that have
548** been issued. The negative is stored because
549** that gives a performance improvement over storing
550** the equivalent positive value.
drh9a324642003-09-06 20:12:01 +0000551*/
drhec4ccdb2018-12-29 02:26:59 +0000552int sqlite3VdbeMakeLabel(Parse *pParse){
drhd1d158b2018-12-29 14:23:22 +0000553 return --pParse->nLabel;
drh9a324642003-09-06 20:12:01 +0000554}
555
556/*
557** Resolve label "x" to be the address of the next instruction to
558** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000559** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000560*/
drhec4ccdb2018-12-29 02:26:59 +0000561static SQLITE_NOINLINE void resizeResolveLabel(Parse *p, Vdbe *v, int j){
drhd1d158b2018-12-29 14:23:22 +0000562 int nNewSize = 10 - p->nLabel;
drhec4ccdb2018-12-29 02:26:59 +0000563 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
564 nNewSize*sizeof(p->aLabel[0]));
565 if( p->aLabel==0 ){
566 p->nLabelAlloc = 0;
567 }else{
568#ifdef SQLITE_DEBUG
569 int i;
570 for(i=p->nLabelAlloc; i<nNewSize; i++) p->aLabel[i] = -1;
571#endif
572 p->nLabelAlloc = nNewSize;
573 p->aLabel[j] = v->nOp;
574 }
575}
drh73d5b8f2013-12-23 19:09:07 +0000576void sqlite3VdbeResolveLabel(Vdbe *v, int x){
577 Parse *p = v->pParse;
drh5ef09bf2015-12-09 17:23:12 +0000578 int j = ADDR(x);
drh66181ce2022-03-31 20:04:49 +0000579 assert( v->eVdbeState==VDBE_INIT_STATE );
drhd1d158b2018-12-29 14:23:22 +0000580 assert( j<-p->nLabel );
drhef41dfe2015-09-02 17:55:12 +0000581 assert( j>=0 );
drh29285462018-04-17 19:29:58 +0000582#ifdef SQLITE_DEBUG
drhec4ccdb2018-12-29 02:26:59 +0000583 if( p->db->flags & SQLITE_VdbeAddopTrace ){
584 printf("RESOLVE LABEL %d to %d\n", x, v->nOp);
585 }
drh29285462018-04-17 19:29:58 +0000586#endif
drhd1d158b2018-12-29 14:23:22 +0000587 if( p->nLabelAlloc + p->nLabel < 0 ){
drhec4ccdb2018-12-29 02:26:59 +0000588 resizeResolveLabel(p,v,j);
589 }else{
drh7ef8a3e2018-04-17 20:09:27 +0000590 assert( p->aLabel[j]==(-1) ); /* Labels may only be resolved once */
drh73d5b8f2013-12-23 19:09:07 +0000591 p->aLabel[j] = v->nOp;
drh9a324642003-09-06 20:12:01 +0000592 }
593}
594
drh4611d922010-02-25 14:47:01 +0000595/*
596** Mark the VDBE as one that can only be run one time.
597*/
598void sqlite3VdbeRunOnlyOnce(Vdbe *p){
drh18bcfb92022-04-03 19:13:40 +0000599 sqlite3VdbeAddOp2(p, OP_Expire, 1, 1);
drh4611d922010-02-25 14:47:01 +0000600}
601
drhf71a3662016-03-16 20:44:45 +0000602/*
drh861ac672022-06-22 12:54:25 +0000603** Mark the VDBE as one that can be run multiple times.
drhf71a3662016-03-16 20:44:45 +0000604*/
605void sqlite3VdbeReusable(Vdbe *p){
drh18bcfb92022-04-03 19:13:40 +0000606 int i;
607 for(i=1; ALWAYS(i<p->nOp); i++){
drh50f22d12022-04-04 19:58:55 +0000608 if( ALWAYS(p->aOp[i].opcode==OP_Expire) ){
drh18bcfb92022-04-03 19:13:40 +0000609 p->aOp[1].opcode = OP_Noop;
610 break;
611 }
612 }
drhf71a3662016-03-16 20:44:45 +0000613}
614
drhff738bc2009-09-24 00:09:58 +0000615#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000616
617/*
618** The following type and function are used to iterate through all opcodes
619** in a Vdbe main program and each of the sub-programs (triggers) it may
620** invoke directly or indirectly. It should be used as follows:
621**
622** Op *pOp;
623** VdbeOpIter sIter;
624**
625** memset(&sIter, 0, sizeof(sIter));
626** sIter.v = v; // v is of type Vdbe*
627** while( (pOp = opIterNext(&sIter)) ){
628** // Do something with pOp
629** }
630** sqlite3DbFree(v->db, sIter.apSub);
631**
632*/
633typedef struct VdbeOpIter VdbeOpIter;
634struct VdbeOpIter {
635 Vdbe *v; /* Vdbe to iterate through the opcodes of */
636 SubProgram **apSub; /* Array of subprograms */
637 int nSub; /* Number of entries in apSub */
638 int iAddr; /* Address of next instruction to return */
639 int iSub; /* 0 = main program, 1 = first sub-program etc. */
640};
641static Op *opIterNext(VdbeOpIter *p){
642 Vdbe *v = p->v;
643 Op *pRet = 0;
644 Op *aOp;
645 int nOp;
646
647 if( p->iSub<=p->nSub ){
648
649 if( p->iSub==0 ){
650 aOp = v->aOp;
651 nOp = v->nOp;
652 }else{
653 aOp = p->apSub[p->iSub-1]->aOp;
654 nOp = p->apSub[p->iSub-1]->nOp;
655 }
656 assert( p->iAddr<nOp );
657
658 pRet = &aOp[p->iAddr];
659 p->iAddr++;
660 if( p->iAddr==nOp ){
661 p->iSub++;
662 p->iAddr = 0;
663 }
664
665 if( pRet->p4type==P4_SUBPROGRAM ){
666 int nByte = (p->nSub+1)*sizeof(SubProgram*);
667 int j;
668 for(j=0; j<p->nSub; j++){
669 if( p->apSub[j]==pRet->p4.pProgram ) break;
670 }
671 if( j==p->nSub ){
672 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
673 if( !p->apSub ){
674 pRet = 0;
675 }else{
676 p->apSub[p->nSub++] = pRet->p4.pProgram;
677 }
678 }
679 }
680 }
681
682 return pRet;
683}
684
685/*
danf3677212009-09-10 16:14:50 +0000686** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000687** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000688** to be rolled back). This condition is true if the main program or any
689** sub-programs contains any of the following:
690**
691** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
692** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
693** * OP_Destroy
694** * OP_VUpdate
drh8e8c8892019-12-10 18:10:12 +0000695** * OP_VCreate
dan144926d2009-09-09 11:37:20 +0000696** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000697** * OP_FkCounter with P2==0 (immediate foreign key constraint)
drh0f3f7662017-08-18 14:34:28 +0000698** * OP_CreateBtree/BTREE_INTKEY and OP_InitCoroutine
699** (for CREATE TABLE AS SELECT ...)
dan144926d2009-09-09 11:37:20 +0000700**
danf3677212009-09-10 16:14:50 +0000701** Then check that the value of Parse.mayAbort is true if an
702** ABORT may be thrown, or false otherwise. Return true if it does
703** match, or false otherwise. This function is intended to be used as
704** part of an assert statement in the compiler. Similar to:
705**
706** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000707*/
danf3677212009-09-10 16:14:50 +0000708int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
709 int hasAbort = 0;
dan04668832014-12-16 20:13:30 +0000710 int hasFkCounter = 0;
drh0dd5cda2015-06-16 16:39:01 +0000711 int hasCreateTable = 0;
danef14abb2019-05-21 14:42:24 +0000712 int hasCreateIndex = 0;
drh0dd5cda2015-06-16 16:39:01 +0000713 int hasInitCoroutine = 0;
dan144926d2009-09-09 11:37:20 +0000714 Op *pOp;
715 VdbeOpIter sIter;
drhc4c0ff82022-03-31 16:09:13 +0000716
717 if( v==0 ) return 0;
dan144926d2009-09-09 11:37:20 +0000718 memset(&sIter, 0, sizeof(sIter));
719 sIter.v = v;
720
721 while( (pOp = opIterNext(&sIter))!=0 ){
722 int opcode = pOp->opcode;
723 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
dan1d4b1642018-12-28 17:45:08 +0000724 || opcode==OP_VDestroy
drh8e8c8892019-12-10 18:10:12 +0000725 || opcode==OP_VCreate
drhed7974d2020-10-26 18:14:12 +0000726 || opcode==OP_ParseSchema
drh4d288302022-08-30 00:11:51 +0000727 || opcode==OP_Function || opcode==OP_PureFunc
dan144926d2009-09-09 11:37:20 +0000728 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drh211a0852019-01-27 02:41:34 +0000729 && ((pOp->p1)!=SQLITE_OK && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000730 ){
danf3677212009-09-10 16:14:50 +0000731 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000732 break;
733 }
drh0f3f7662017-08-18 14:34:28 +0000734 if( opcode==OP_CreateBtree && pOp->p3==BTREE_INTKEY ) hasCreateTable = 1;
dan7ed6c062019-05-21 16:32:41 +0000735 if( mayAbort ){
736 /* hasCreateIndex may also be set for some DELETE statements that use
737 ** OP_Clear. So this routine may end up returning true in the case
738 ** where a "DELETE FROM tbl" has a statement-journal but does not
739 ** require one. This is not so bad - it is an inefficiency, not a bug. */
740 if( opcode==OP_CreateBtree && pOp->p3==BTREE_BLOBKEY ) hasCreateIndex = 1;
741 if( opcode==OP_Clear ) hasCreateIndex = 1;
742 }
drh0dd5cda2015-06-16 16:39:01 +0000743 if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
dan04668832014-12-16 20:13:30 +0000744#ifndef SQLITE_OMIT_FOREIGN_KEY
745 if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
746 hasFkCounter = 1;
747 }
748#endif
dan144926d2009-09-09 11:37:20 +0000749 }
dan144926d2009-09-09 11:37:20 +0000750 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000751
mistachkin48864df2013-03-21 21:20:32 +0000752 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000753 ** If malloc failed, then the while() loop above may not have iterated
754 ** through all opcodes and hasAbort may be set incorrectly. Return
755 ** true for this case to prevent the assert() in the callers frame
756 ** from failing. */
drh0dd5cda2015-06-16 16:39:01 +0000757 return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
danef14abb2019-05-21 14:42:24 +0000758 || (hasCreateTable && hasInitCoroutine) || hasCreateIndex
759 );
dan144926d2009-09-09 11:37:20 +0000760}
drhff738bc2009-09-24 00:09:58 +0000761#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000762
drh4031baf2018-05-28 17:31:20 +0000763#ifdef SQLITE_DEBUG
764/*
765** Increment the nWrite counter in the VDBE if the cursor is not an
766** ephemeral cursor, or if the cursor argument is NULL.
767*/
768void sqlite3VdbeIncrWriteCounter(Vdbe *p, VdbeCursor *pC){
769 if( pC==0
770 || (pC->eCurType!=CURTYPE_SORTER
771 && pC->eCurType!=CURTYPE_PSEUDO
772 && !pC->isEphemeral)
773 ){
774 p->nWrite++;
775 }
776}
777#endif
778
779#ifdef SQLITE_DEBUG
780/*
781** Assert if an Abort at this point in time might result in a corrupt
782** database.
783*/
784void sqlite3VdbeAssertAbortable(Vdbe *p){
785 assert( p->nWrite==0 || p->usesStmtJournal );
786}
787#endif
788
drh9a324642003-09-06 20:12:01 +0000789/*
drhef41dfe2015-09-02 17:55:12 +0000790** This routine is called after all opcodes have been inserted. It loops
791** through all the opcodes and fixes up some details.
drh76ff3a02004-09-24 22:32:30 +0000792**
drhef41dfe2015-09-02 17:55:12 +0000793** (1) For each jump instruction with a negative P2 value (a label)
794** resolve the P2 value to an actual address.
danielk1977634f2982005-03-28 08:44:07 +0000795**
drhef41dfe2015-09-02 17:55:12 +0000796** (2) Compute the maximum number of arguments used by any SQL function
797** and store that value in *pMaxFuncArgs.
drha6c2ed92009-11-14 23:22:23 +0000798**
drhef41dfe2015-09-02 17:55:12 +0000799** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
800** indicate what the prepared statement actually does.
801**
drha7c9dd52022-02-24 14:44:23 +0000802** (4) (discontinued)
drhef41dfe2015-09-02 17:55:12 +0000803**
804** (5) Reclaim the memory allocated for storing labels.
drh7cc84c22016-04-11 13:36:42 +0000805**
806** This routine will only function correctly if the mkopcodeh.tcl generator
807** script numbers the opcodes correctly. Changes to this routine must be
808** coordinated with changes to mkopcodeh.tcl.
drh76ff3a02004-09-24 22:32:30 +0000809*/
drh9cbf3422008-01-17 16:22:13 +0000810static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
dan165921a2009-08-28 18:53:45 +0000811 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000812 Op *pOp;
drh73d5b8f2013-12-23 19:09:07 +0000813 Parse *pParse = p->pParse;
814 int *aLabel = pParse->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000815 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000816 p->bIsReader = 0;
drh7cc84c22016-04-11 13:36:42 +0000817 pOp = &p->aOp[p->nOp-1];
drh064390b2022-07-01 19:42:12 +0000818 assert( p->aOp[0].opcode==OP_Init );
819 while( 1 /* Loop termates when it reaches the OP_Init opcode */ ){
drh7cc84c22016-04-11 13:36:42 +0000820 /* Only JUMP opcodes and the short list of special opcodes in the switch
821 ** below need to be considered. The mkopcodeh.tcl generator script groups
822 ** all these opcodes together near the front of the opcode list. Skip
823 ** any opcode that does not need processing by virtual of the fact that
drhc310db32016-04-11 16:35:05 +0000824 ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
drh7cc84c22016-04-11 13:36:42 +0000825 */
drhc310db32016-04-11 16:35:05 +0000826 if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
drh7cc84c22016-04-11 13:36:42 +0000827 /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
828 ** cases from this switch! */
829 switch( pOp->opcode ){
830 case OP_Transaction: {
831 if( pOp->p2!=0 ) p->readOnly = 0;
drh08b92082020-08-10 14:18:00 +0000832 /* no break */ deliberate_fall_through
drh7cc84c22016-04-11 13:36:42 +0000833 }
834 case OP_AutoCommit:
835 case OP_Savepoint: {
836 p->bIsReader = 1;
837 break;
838 }
dand9031542013-07-05 16:54:30 +0000839#ifndef SQLITE_OMIT_WAL
drh7cc84c22016-04-11 13:36:42 +0000840 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000841#endif
drh7cc84c22016-04-11 13:36:42 +0000842 case OP_Vacuum:
843 case OP_JournalMode: {
844 p->readOnly = 0;
845 p->bIsReader = 1;
846 break;
847 }
drh064390b2022-07-01 19:42:12 +0000848 case OP_Init: {
849 assert( pOp->p2>=0 );
850 goto resolve_p2_values_loop_exit;
851 }
danielk1977182c4ba2007-06-27 15:53:34 +0000852#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7cc84c22016-04-11 13:36:42 +0000853 case OP_VUpdate: {
854 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
855 break;
856 }
857 case OP_VFilter: {
858 int n;
859 assert( (pOp - p->aOp) >= 3 );
860 assert( pOp[-1].opcode==OP_Integer );
861 n = pOp[-1].p1;
862 if( n>nMaxArgs ) nMaxArgs = n;
drh6a8700b2017-08-02 11:04:00 +0000863 /* Fall through into the default case */
drh08b92082020-08-10 14:18:00 +0000864 /* no break */ deliberate_fall_through
drh7cc84c22016-04-11 13:36:42 +0000865 }
danielk1977182c4ba2007-06-27 15:53:34 +0000866#endif
drh6a8700b2017-08-02 11:04:00 +0000867 default: {
868 if( pOp->p2<0 ){
869 /* The mkopcodeh.tcl script has so arranged things that the only
870 ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
871 ** have non-negative values for P2. */
872 assert( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 );
drhd1d158b2018-12-29 14:23:22 +0000873 assert( ADDR(pOp->p2)<-pParse->nLabel );
drh6a8700b2017-08-02 11:04:00 +0000874 pOp->p2 = aLabel[ADDR(pOp->p2)];
875 }
drh7cc84c22016-04-11 13:36:42 +0000876 break;
877 }
drh8c8a8c42013-08-06 07:45:08 +0000878 }
drh6a8700b2017-08-02 11:04:00 +0000879 /* The mkopcodeh.tcl script has so arranged things that the only
880 ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
881 ** have non-negative values for P2. */
882 assert( (sqlite3OpcodeProperty[pOp->opcode]&OPFLG_JUMP)==0 || pOp->p2>=0);
danielk1977bc04f852005-03-29 08:26:13 +0000883 }
drh064390b2022-07-01 19:42:12 +0000884 assert( pOp>p->aOp );
drh7cc84c22016-04-11 13:36:42 +0000885 pOp--;
drh76ff3a02004-09-24 22:32:30 +0000886 }
drh064390b2022-07-01 19:42:12 +0000887resolve_p2_values_loop_exit:
drhcea170e2022-03-28 14:56:47 +0000888 if( aLabel ){
drh41ce47c2022-08-22 02:00:26 +0000889 sqlite3DbNNFreeNN(p->db, pParse->aLabel);
drhcea170e2022-03-28 14:56:47 +0000890 pParse->aLabel = 0;
891 }
drh73d5b8f2013-12-23 19:09:07 +0000892 pParse->nLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000893 *pMaxFuncArgs = nMaxArgs;
drha7ab6d82014-07-21 15:44:39 +0000894 assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
drh76ff3a02004-09-24 22:32:30 +0000895}
896
drhb77c3122022-04-23 18:04:31 +0000897#ifdef SQLITE_DEBUG
898/*
899** Check to see if a subroutine contains a jump to a location outside of
900** the subroutine. If a jump outside the subroutine is detected, add code
901** that will cause the program to halt with an error message.
902**
903** The subroutine consists of opcodes between iFirst and iLast. Jumps to
904** locations within the subroutine are acceptable. iRetReg is a register
905** that contains the return address. Jumps to outside the range of iFirst
906** through iLast are also acceptable as long as the jump destination is
907** an OP_Return to iReturnAddr.
908**
drh6c7e89b2022-04-23 18:34:55 +0000909** A jump to an unresolved label means that the jump destination will be
910** beyond the current address. That is normally a jump to an early
911** termination and is consider acceptable.
drhb77c3122022-04-23 18:04:31 +0000912**
913** This routine only runs during debug builds. The purpose is (of course)
914** to detect invalid escapes out of a subroutine. The OP_Halt opcode
915** is generated rather than an assert() or other error, so that ".eqp full"
916** will still work to show the original bytecode, to aid in debugging.
917*/
918void sqlite3VdbeNoJumpsOutsideSubrtn(
919 Vdbe *v, /* The byte-code program under construction */
920 int iFirst, /* First opcode of the subroutine */
921 int iLast, /* Last opcode of the subroutine */
922 int iRetReg /* Subroutine return address register */
923){
924 VdbeOp *pOp;
925 Parse *pParse;
926 int i;
927 sqlite3_str *pErr = 0;
928 assert( v!=0 );
929 pParse = v->pParse;
930 assert( pParse!=0 );
931 if( pParse->nErr ) return;
932 assert( iLast>=iFirst );
933 assert( iLast<v->nOp );
934 pOp = &v->aOp[iFirst];
935 for(i=iFirst; i<=iLast; i++, pOp++){
936 if( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 ){
937 int iDest = pOp->p2; /* Jump destination */
938 if( iDest==0 ) continue;
drh6c7e89b2022-04-23 18:34:55 +0000939 if( pOp->opcode==OP_Gosub ) continue;
drhb77c3122022-04-23 18:04:31 +0000940 if( iDest<0 ){
941 int j = ADDR(iDest);
942 assert( j>=0 );
943 if( j>=-pParse->nLabel || pParse->aLabel[j]<0 ){
drhb77c3122022-04-23 18:04:31 +0000944 continue;
945 }
946 iDest = pParse->aLabel[j];
947 }
948 if( iDest<iFirst || iDest>iLast ){
949 int j = iDest;
950 for(; j<v->nOp; j++){
951 VdbeOp *pX = &v->aOp[j];
952 if( pX->opcode==OP_Return ){
953 if( pX->p1==iRetReg ) break;
954 continue;
955 }
956 if( pX->opcode==OP_Noop ) continue;
957 if( pX->opcode==OP_Explain ) continue;
958 if( pErr==0 ){
959 pErr = sqlite3_str_new(0);
960 }else{
961 sqlite3_str_appendchar(pErr, 1, '\n');
962 }
963 sqlite3_str_appendf(pErr,
964 "Opcode at %d jumps to %d which is outside the "
965 "subroutine at %d..%d",
966 i, iDest, iFirst, iLast);
967 break;
968 }
969 }
970 }
971 }
972 if( pErr ){
973 char *zErr = sqlite3_str_finish(pErr);
974 sqlite3VdbeAddOp4(v, OP_Halt, SQLITE_INTERNAL, OE_Abort, 0, zErr, 0);
975 sqlite3_free(zErr);
976 sqlite3MayAbort(pParse);
977 }
978}
979#endif /* SQLITE_DEBUG */
980
drh76ff3a02004-09-24 22:32:30 +0000981/*
drh9a324642003-09-06 20:12:01 +0000982** Return the address of the next instruction to be inserted.
983*/
danielk19774adee202004-05-08 08:23:19 +0000984int sqlite3VdbeCurrentAddr(Vdbe *p){
drh66181ce2022-03-31 20:04:49 +0000985 assert( p->eVdbeState==VDBE_INIT_STATE );
drh9a324642003-09-06 20:12:01 +0000986 return p->nOp;
987}
988
dan65a7cd12009-09-01 12:16:01 +0000989/*
drh2ce18652016-01-16 20:50:21 +0000990** Verify that at least N opcode slots are available in p without
drhdad300d2016-01-18 00:20:26 +0000991** having to malloc for more space (except when compiled using
992** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
993** to verify that certain calls to sqlite3VdbeAddOpList() can never
994** fail due to a OOM fault and hence that the return value from
995** sqlite3VdbeAddOpList() will always be non-NULL.
drh2ce18652016-01-16 20:50:21 +0000996*/
drhdad300d2016-01-18 00:20:26 +0000997#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
998void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
drhb6991792018-12-28 20:14:03 +0000999 assert( p->nOp + N <= p->nOpAlloc );
drh2ce18652016-01-16 20:50:21 +00001000}
1001#endif
1002
1003/*
dan9e1ab1a2017-01-05 19:32:48 +00001004** Verify that the VM passed as the only argument does not contain
1005** an OP_ResultRow opcode. Fail an assert() if it does. This is used
1006** by code in pragma.c to ensure that the implementation of certain
1007** pragmas comports with the flags specified in the mkpragmatab.tcl
1008** script.
1009*/
1010#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
1011void sqlite3VdbeVerifyNoResultRow(Vdbe *p){
1012 int i;
1013 for(i=0; i<p->nOp; i++){
1014 assert( p->aOp[i].opcode!=OP_ResultRow );
1015 }
1016}
1017#endif
1018
1019/*
drh4031baf2018-05-28 17:31:20 +00001020** Generate code (a single OP_Abortable opcode) that will
1021** verify that the VDBE program can safely call Abort in the current
1022** context.
1023*/
1024#if defined(SQLITE_DEBUG)
1025void sqlite3VdbeVerifyAbortable(Vdbe *p, int onError){
1026 if( onError==OE_Abort ) sqlite3VdbeAddOp0(p, OP_Abortable);
1027}
1028#endif
1029
1030/*
dan65a7cd12009-09-01 12:16:01 +00001031** This function returns a pointer to the array of opcodes associated with
1032** the Vdbe passed as the first argument. It is the callers responsibility
1033** to arrange for the returned array to be eventually freed using the
1034** vdbeFreeOpArray() function.
1035**
1036** Before returning, *pnOp is set to the number of entries in the returned
1037** array. Also, *pnMaxArg is set to the larger of its current value and
1038** the number of entries in the Vdbe.apArg[] array required to execute the
1039** returned program.
1040*/
dan165921a2009-08-28 18:53:45 +00001041VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
1042 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +00001043 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +00001044
1045 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drha7ab6d82014-07-21 15:44:39 +00001046 assert( DbMaskAllZero(p->btreeMask) );
dan65a7cd12009-09-01 12:16:01 +00001047
dan165921a2009-08-28 18:53:45 +00001048 resolveP2Values(p, pnMaxArg);
1049 *pnOp = p->nOp;
1050 p->aOp = 0;
1051 return aOp;
1052}
1053
drh9a324642003-09-06 20:12:01 +00001054/*
drh2ce18652016-01-16 20:50:21 +00001055** Add a whole list of operations to the operation stack. Return a
1056** pointer to the first operation inserted.
drh1b325542016-02-03 01:55:44 +00001057**
1058** Non-zero P2 arguments to jump instructions are automatically adjusted
1059** so that the jump target is relative to the first operation inserted.
drh9a324642003-09-06 20:12:01 +00001060*/
drh2ce18652016-01-16 20:50:21 +00001061VdbeOp *sqlite3VdbeAddOpList(
1062 Vdbe *p, /* Add opcodes to the prepared statement */
1063 int nOp, /* Number of opcodes to add */
1064 VdbeOpList const *aOp, /* The opcodes to be added */
1065 int iLineno /* Source-file line number of first opcode */
1066){
1067 int i;
1068 VdbeOp *pOut, *pFirst;
drhef41dfe2015-09-02 17:55:12 +00001069 assert( nOp>0 );
drh66181ce2022-03-31 20:04:49 +00001070 assert( p->eVdbeState==VDBE_INIT_STATE );
drhb6991792018-12-28 20:14:03 +00001071 if( p->nOp + nOp > p->nOpAlloc && growOpArray(p, nOp) ){
drh76ff3a02004-09-24 22:32:30 +00001072 return 0;
drh9a324642003-09-06 20:12:01 +00001073 }
drh2ce18652016-01-16 20:50:21 +00001074 pFirst = pOut = &p->aOp[p->nOp];
drhef41dfe2015-09-02 17:55:12 +00001075 for(i=0; i<nOp; i++, aOp++, pOut++){
drhef41dfe2015-09-02 17:55:12 +00001076 pOut->opcode = aOp->opcode;
1077 pOut->p1 = aOp->p1;
drh5ef09bf2015-12-09 17:23:12 +00001078 pOut->p2 = aOp->p2;
1079 assert( aOp->p2>=0 );
drh1b325542016-02-03 01:55:44 +00001080 if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
1081 pOut->p2 += p->nOp;
1082 }
drhef41dfe2015-09-02 17:55:12 +00001083 pOut->p3 = aOp->p3;
1084 pOut->p4type = P4_NOTUSED;
1085 pOut->p4.p = 0;
1086 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +00001087#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhef41dfe2015-09-02 17:55:12 +00001088 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +00001089#endif
drh688852a2014-02-17 22:40:43 +00001090#ifdef SQLITE_VDBE_COVERAGE
drhef41dfe2015-09-02 17:55:12 +00001091 pOut->iSrcLine = iLineno+i;
drh688852a2014-02-17 22:40:43 +00001092#else
drhef41dfe2015-09-02 17:55:12 +00001093 (void)iLineno;
drh688852a2014-02-17 22:40:43 +00001094#endif
drhc7379ce2013-10-30 02:28:23 +00001095#ifdef SQLITE_DEBUG
drhef41dfe2015-09-02 17:55:12 +00001096 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh2ce18652016-01-16 20:50:21 +00001097 sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
drh9a324642003-09-06 20:12:01 +00001098 }
drhef41dfe2015-09-02 17:55:12 +00001099#endif
drh9a324642003-09-06 20:12:01 +00001100 }
drhef41dfe2015-09-02 17:55:12 +00001101 p->nOp += nOp;
drh2ce18652016-01-16 20:50:21 +00001102 return pFirst;
drh9a324642003-09-06 20:12:01 +00001103}
1104
dan6f9702e2014-11-01 20:38:06 +00001105#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
1106/*
1107** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
1108*/
dan037b5322014-11-03 11:25:32 +00001109void sqlite3VdbeScanStatus(
dan6f9702e2014-11-01 20:38:06 +00001110 Vdbe *p, /* VM to add scanstatus() to */
1111 int addrExplain, /* Address of OP_Explain (or 0) */
1112 int addrLoop, /* Address of loop counter */
1113 int addrVisit, /* Address of rows visited counter */
drh518140e2014-11-06 03:55:10 +00001114 LogEst nEst, /* Estimated number of output rows */
dan6f9702e2014-11-01 20:38:06 +00001115 const char *zName /* Name of table or index being scanned */
1116){
drh0aa32312019-04-13 04:01:12 +00001117 sqlite3_int64 nByte = (p->nScan+1) * sizeof(ScanStatus);
dan037b5322014-11-03 11:25:32 +00001118 ScanStatus *aNew;
1119 aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
dan6f9702e2014-11-01 20:38:06 +00001120 if( aNew ){
dan037b5322014-11-03 11:25:32 +00001121 ScanStatus *pNew = &aNew[p->nScan++];
dan6f9702e2014-11-01 20:38:06 +00001122 pNew->addrExplain = addrExplain;
1123 pNew->addrLoop = addrLoop;
1124 pNew->addrVisit = addrVisit;
1125 pNew->nEst = nEst;
1126 pNew->zName = sqlite3DbStrDup(p->db, zName);
1127 p->aScan = aNew;
1128 }
1129}
1130#endif
1131
1132
drh9a324642003-09-06 20:12:01 +00001133/*
drh0ff287f2015-09-02 18:40:33 +00001134** Change the value of the opcode, or P1, P2, P3, or P5 operands
1135** for a specific instruction.
drh9a324642003-09-06 20:12:01 +00001136*/
mistachkin044388c2019-08-09 01:59:14 +00001137void sqlite3VdbeChangeOpcode(Vdbe *p, int addr, u8 iNewOpcode){
drh058e9952022-07-25 19:05:24 +00001138 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001139 sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
1140}
drh3728b842019-08-09 01:11:32 +00001141void sqlite3VdbeChangeP1(Vdbe *p, int addr, int val){
drh058e9952022-07-25 19:05:24 +00001142 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001143 sqlite3VdbeGetOp(p,addr)->p1 = val;
drh9a324642003-09-06 20:12:01 +00001144}
drh3728b842019-08-09 01:11:32 +00001145void sqlite3VdbeChangeP2(Vdbe *p, int addr, int val){
drhe6710e82022-07-26 10:16:25 +00001146 assert( addr>=0 || p->db->mallocFailed );
drh0ff287f2015-09-02 18:40:33 +00001147 sqlite3VdbeGetOp(p,addr)->p2 = val;
drh9a324642003-09-06 20:12:01 +00001148}
drh3728b842019-08-09 01:11:32 +00001149void sqlite3VdbeChangeP3(Vdbe *p, int addr, int val){
drh058e9952022-07-25 19:05:24 +00001150 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001151 sqlite3VdbeGetOp(p,addr)->p3 = val;
danielk1977207872a2008-01-03 07:54:23 +00001152}
drh585ce192017-01-25 14:58:27 +00001153void sqlite3VdbeChangeP5(Vdbe *p, u16 p5){
drhdd3bfe82016-09-29 20:28:34 +00001154 assert( p->nOp>0 || p->db->mallocFailed );
1155 if( p->nOp>0 ) p->aOp[p->nOp-1].p5 = p5;
danielk19771f4aa332008-01-03 09:51:55 +00001156}
1157
1158/*
drhf8875402006-03-17 13:56:34 +00001159** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +00001160** the address of the next instruction to be coded.
1161*/
1162void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drh0ff287f2015-09-02 18:40:33 +00001163 sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +00001164}
drhb38ad992005-09-16 00:27:01 +00001165
drhdc4f6fc2020-02-07 19:44:13 +00001166/*
1167** Change the P2 operand of the jump instruction at addr so that
1168** the jump lands on the next opcode. Or if the jump instruction was
1169** the previous opcode (and is thus a no-op) then simply back up
1170** the next instruction counter by one slot so that the jump is
1171** overwritten by the next inserted opcode.
1172**
1173** This routine is an optimization of sqlite3VdbeJumpHere() that
1174** strives to omit useless byte-code like this:
1175**
1176** 7 Once 0 8 0
1177** 8 ...
1178*/
1179void sqlite3VdbeJumpHereOrPopInst(Vdbe *p, int addr){
1180 if( addr==p->nOp-1 ){
1181 assert( p->aOp[addr].opcode==OP_Once
1182 || p->aOp[addr].opcode==OP_If
1183 || p->aOp[addr].opcode==OP_FkIfZero );
1184 assert( p->aOp[addr].p4type==0 );
1185#ifdef SQLITE_VDBE_COVERAGE
drh058e9952022-07-25 19:05:24 +00001186 sqlite3VdbeGetLastOp(p)->iSrcLine = 0; /* Erase VdbeCoverage() macros */
drhdc4f6fc2020-02-07 19:44:13 +00001187#endif
1188 p->nOp--;
1189 }else{
1190 sqlite3VdbeChangeP2(p, addr, p->nOp);
1191 }
1192}
1193
drhb7f6f682006-07-08 17:06:43 +00001194
1195/*
1196** If the input FuncDef structure is ephemeral, then free it. If
1197** the FuncDef is not ephermal, then do nothing.
1198*/
drh633e6d52008-07-28 19:34:53 +00001199static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drh41ce47c2022-08-22 02:00:26 +00001200 assert( db!=0 );
drhf431a872016-05-20 15:53:47 +00001201 if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh41ce47c2022-08-22 02:00:26 +00001202 sqlite3DbNNFreeNN(db, pDef);
drhb7f6f682006-07-08 17:06:43 +00001203 }
1204}
1205
drhb38ad992005-09-16 00:27:01 +00001206/*
drh66a51672008-01-03 00:01:23 +00001207** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +00001208*/
drhf431a872016-05-20 15:53:47 +00001209static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
1210 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh41ce47c2022-08-22 02:00:26 +00001211 sqlite3DbNNFreeNN(db, p);
drhf431a872016-05-20 15:53:47 +00001212}
1213static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
drh41ce47c2022-08-22 02:00:26 +00001214 assert( db!=0 );
drhf431a872016-05-20 15:53:47 +00001215 freeEphemeralFunction(db, p->pFunc);
drh41ce47c2022-08-22 02:00:26 +00001216 sqlite3DbNNFreeNN(db, p);
drhf431a872016-05-20 15:53:47 +00001217}
drh633e6d52008-07-28 19:34:53 +00001218static void freeP4(sqlite3 *db, int p4type, void *p4){
drhbe5000d2016-04-07 14:05:20 +00001219 assert( db );
1220 switch( p4type ){
1221 case P4_FUNCCTX: {
drhf431a872016-05-20 15:53:47 +00001222 freeP4FuncCtx(db, (sqlite3_context*)p4);
1223 break;
drhbe5000d2016-04-07 14:05:20 +00001224 }
1225 case P4_REAL:
1226 case P4_INT64:
1227 case P4_DYNAMIC:
1228 case P4_INTARRAY: {
drh41ce47c2022-08-22 02:00:26 +00001229 if( p4 ) sqlite3DbNNFreeNN(db, p4);
drhbe5000d2016-04-07 14:05:20 +00001230 break;
1231 }
1232 case P4_KEYINFO: {
1233 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
1234 break;
1235 }
drh28935362013-12-07 20:39:19 +00001236#ifdef SQLITE_ENABLE_CURSOR_HINTS
drhbe5000d2016-04-07 14:05:20 +00001237 case P4_EXPR: {
1238 sqlite3ExprDelete(db, (Expr*)p4);
1239 break;
1240 }
drh28935362013-12-07 20:39:19 +00001241#endif
drhbe5000d2016-04-07 14:05:20 +00001242 case P4_FUNCDEF: {
1243 freeEphemeralFunction(db, (FuncDef*)p4);
1244 break;
1245 }
1246 case P4_MEM: {
1247 if( db->pnBytesFreed==0 ){
1248 sqlite3ValueFree((sqlite3_value*)p4);
1249 }else{
drhf431a872016-05-20 15:53:47 +00001250 freeP4Mem(db, (Mem*)p4);
drhb9755982010-07-24 16:34:37 +00001251 }
drhbe5000d2016-04-07 14:05:20 +00001252 break;
1253 }
1254 case P4_VTAB : {
1255 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
1256 break;
drhb38ad992005-09-16 00:27:01 +00001257 }
1258 }
1259}
1260
dan65a7cd12009-09-01 12:16:01 +00001261/*
1262** Free the space allocated for aOp and any p4 values allocated for the
1263** opcodes contained within. If aOp is not NULL it is assumed to contain
1264** nOp entries.
1265*/
dan165921a2009-08-28 18:53:45 +00001266static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
drh60a512d2022-03-28 15:06:36 +00001267 assert( nOp>=0 );
drh41ce47c2022-08-22 02:00:26 +00001268 assert( db!=0 );
dan165921a2009-08-28 18:53:45 +00001269 if( aOp ){
drh60a512d2022-03-28 15:06:36 +00001270 Op *pOp = &aOp[nOp-1];
1271 while(1){ /* Exit via break */
drh0c243302017-07-12 20:43:23 +00001272 if( pOp->p4type <= P4_FREE_IF_LE ) freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +00001273#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +00001274 sqlite3DbFree(db, pOp->zComment);
1275#endif
drh60a512d2022-03-28 15:06:36 +00001276 if( pOp==aOp ) break;
1277 pOp--;
dan165921a2009-08-28 18:53:45 +00001278 }
drh41ce47c2022-08-22 02:00:26 +00001279 sqlite3DbNNFreeNN(db, aOp);
dan165921a2009-08-28 18:53:45 +00001280 }
dan165921a2009-08-28 18:53:45 +00001281}
1282
dan65a7cd12009-09-01 12:16:01 +00001283/*
dand19c9332010-07-26 12:05:17 +00001284** Link the SubProgram object passed as the second argument into the linked
1285** list at Vdbe.pSubProgram. This list is used to delete all sub-program
1286** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +00001287*/
dand19c9332010-07-26 12:05:17 +00001288void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
1289 p->pNext = pVdbe->pProgram;
1290 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +00001291}
1292
drh9a324642003-09-06 20:12:01 +00001293/*
drh06baba52019-10-24 19:35:26 +00001294** Return true if the given Vdbe has any SubPrograms.
1295*/
1296int sqlite3VdbeHasSubProgram(Vdbe *pVdbe){
1297 return pVdbe->pProgram!=0;
1298}
1299
1300/*
drh48f2d3b2011-09-16 01:34:43 +00001301** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +00001302*/
drh2ce18652016-01-16 20:50:21 +00001303int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
1304 VdbeOp *pOp;
1305 if( p->db->mallocFailed ) return 0;
1306 assert( addr>=0 && addr<p->nOp );
1307 pOp = &p->aOp[addr];
1308 freeP4(p->db, pOp->p4type, pOp->p4.p);
drh4b31bda2016-01-20 02:01:02 +00001309 pOp->p4type = P4_NOTUSED;
drh939e7782016-01-20 02:36:12 +00001310 pOp->p4.z = 0;
drh2ce18652016-01-16 20:50:21 +00001311 pOp->opcode = OP_Noop;
1312 return 1;
drhf8875402006-03-17 13:56:34 +00001313}
1314
1315/*
drh39c4b822014-09-29 15:42:01 +00001316** If the last opcode is "op" and it is not a jump destination,
1317** then remove it. Return true if and only if an opcode was removed.
drh762c1c42014-01-02 19:35:30 +00001318*/
drh61019c72014-01-04 16:49:02 +00001319int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
drh2831c4d2016-09-29 19:50:02 +00001320 if( p->nOp>0 && p->aOp[p->nOp-1].opcode==op ){
drh2ce18652016-01-16 20:50:21 +00001321 return sqlite3VdbeChangeToNoop(p, p->nOp-1);
drh61019c72014-01-04 16:49:02 +00001322 }else{
1323 return 0;
1324 }
drh762c1c42014-01-02 19:35:30 +00001325}
1326
drh13d79502019-12-23 02:18:49 +00001327#ifdef SQLITE_DEBUG
1328/*
1329** Generate an OP_ReleaseReg opcode to indicate that a range of
1330** registers, except any identified by mask, are no longer in use.
1331*/
drh3aef2fb2020-01-02 17:46:02 +00001332void sqlite3VdbeReleaseRegisters(
1333 Parse *pParse, /* Parsing context */
1334 int iFirst, /* Index of first register to be released */
1335 int N, /* Number of registers to release */
1336 u32 mask, /* Mask of registers to NOT release */
1337 int bUndefine /* If true, mark registers as undefined */
1338){
drhda4c7cc2022-04-07 18:17:56 +00001339 if( N==0 || OptimizationDisabled(pParse->db, SQLITE_ReleaseReg) ) return;
drh13d79502019-12-23 02:18:49 +00001340 assert( pParse->pVdbe );
drh3aef2fb2020-01-02 17:46:02 +00001341 assert( iFirst>=1 );
1342 assert( iFirst+N-1<=pParse->nMem );
drhb2fe5a72020-01-10 01:05:49 +00001343 if( N<=31 && mask!=0 ){
1344 while( N>0 && (mask&1)!=0 ){
1345 mask >>= 1;
1346 iFirst++;
1347 N--;
1348 }
1349 while( N>0 && N<=32 && (mask & MASKBIT32(N-1))!=0 ){
1350 mask &= ~MASKBIT32(N-1);
1351 N--;
1352 }
drh13d79502019-12-23 02:18:49 +00001353 }
1354 if( N>0 ){
1355 sqlite3VdbeAddOp3(pParse->pVdbe, OP_ReleaseReg, iFirst, N, *(int*)&mask);
drh3aef2fb2020-01-02 17:46:02 +00001356 if( bUndefine ) sqlite3VdbeChangeP5(pParse->pVdbe, 1);
drh13d79502019-12-23 02:18:49 +00001357 }
1358}
1359#endif /* SQLITE_DEBUG */
1360
1361
drh762c1c42014-01-02 19:35:30 +00001362/*
drh66a51672008-01-03 00:01:23 +00001363** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +00001364** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +00001365** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +00001366** few minor changes to the program.
1367**
drh66a51672008-01-03 00:01:23 +00001368** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +00001369** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +00001370** A value of n==0 means copy bytes of zP4 up to and including the
1371** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +00001372**
drh66a51672008-01-03 00:01:23 +00001373** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +00001374** to a string or structure that is guaranteed to exist for the lifetime of
1375** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +00001376**
drh66a51672008-01-03 00:01:23 +00001377** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +00001378*/
drh00dceca2016-01-11 22:58:50 +00001379static void SQLITE_NOINLINE vdbeChangeP4Full(
1380 Vdbe *p,
1381 Op *pOp,
1382 const char *zP4,
1383 int n
1384){
1385 if( pOp->p4type ){
1386 freeP4(p->db, pOp->p4type, pOp->p4.p);
1387 pOp->p4type = 0;
1388 pOp->p4.p = 0;
1389 }
1390 if( n<0 ){
1391 sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
1392 }else{
1393 if( n==0 ) n = sqlite3Strlen30(zP4);
1394 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
1395 pOp->p4type = P4_DYNAMIC;
1396 }
1397}
drh66a51672008-01-03 00:01:23 +00001398void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +00001399 Op *pOp;
drh633e6d52008-07-28 19:34:53 +00001400 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +00001401 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +00001402 db = p->db;
drh66181ce2022-03-31 20:04:49 +00001403 assert( p->eVdbeState==VDBE_INIT_STATE );
drh00dceca2016-01-11 22:58:50 +00001404 assert( p->aOp!=0 || db->mallocFailed );
1405 if( db->mallocFailed ){
1406 if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
danielk1977d5d56522005-03-16 12:15:20 +00001407 return;
1408 }
drh7b746032009-06-26 12:15:22 +00001409 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +00001410 assert( addr<p->nOp );
1411 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +00001412 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +00001413 }
1414 pOp = &p->aOp[addr];
drh00dceca2016-01-11 22:58:50 +00001415 if( n>=0 || pOp->p4type ){
1416 vdbeChangeP4Full(p, pOp, zP4, n);
1417 return;
1418 }
drh98757152008-01-09 23:04:12 +00001419 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +00001420 /* Note: this cast is safe, because the origin data point was an int
1421 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +00001422 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +00001423 pOp->p4type = P4_INT32;
drh00dceca2016-01-11 22:58:50 +00001424 }else if( zP4!=0 ){
1425 assert( n<0 );
danielk19772dca4ac2008-01-03 11:50:29 +00001426 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +00001427 pOp->p4type = (signed char)n;
drh00dceca2016-01-11 22:58:50 +00001428 if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
drh9a324642003-09-06 20:12:01 +00001429 }
1430}
1431
drh2ec2fb22013-11-06 19:59:23 +00001432/*
drhf14b7fb2016-12-07 21:35:55 +00001433** Change the P4 operand of the most recently coded instruction
1434** to the value defined by the arguments. This is a high-speed
1435** version of sqlite3VdbeChangeP4().
1436**
1437** The P4 operand must not have been previously defined. And the new
1438** P4 must not be P4_INT32. Use sqlite3VdbeChangeP4() in either of
1439** those cases.
1440*/
1441void sqlite3VdbeAppendP4(Vdbe *p, void *pP4, int n){
1442 VdbeOp *pOp;
1443 assert( n!=P4_INT32 && n!=P4_VTAB );
1444 assert( n<=0 );
1445 if( p->db->mallocFailed ){
1446 freeP4(p->db, n, pP4);
1447 }else{
1448 assert( pP4!=0 );
1449 assert( p->nOp>0 );
1450 pOp = &p->aOp[p->nOp-1];
1451 assert( pOp->p4type==P4_NOTUSED );
1452 pOp->p4type = n;
1453 pOp->p4.p = pP4;
1454 }
1455}
1456
1457/*
drh2ec2fb22013-11-06 19:59:23 +00001458** Set the P4 on the most recently added opcode to the KeyInfo for the
1459** index given.
1460*/
1461void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
1462 Vdbe *v = pParse->pVdbe;
drhf14b7fb2016-12-07 21:35:55 +00001463 KeyInfo *pKeyInfo;
drh2ec2fb22013-11-06 19:59:23 +00001464 assert( v!=0 );
1465 assert( pIdx!=0 );
drhf14b7fb2016-12-07 21:35:55 +00001466 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pIdx);
1467 if( pKeyInfo ) sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
drh2ec2fb22013-11-06 19:59:23 +00001468}
1469
drhc7379ce2013-10-30 02:28:23 +00001470#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +00001471/*
mistachkind5578432012-08-25 10:01:29 +00001472** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +00001473** insert a No-op and add the comment to that new instruction. This
1474** makes the code easier to read during debugging. None of this happens
1475** in a production build.
drhad6d9462004-09-19 02:15:24 +00001476*/
drhb07028f2011-10-14 21:49:18 +00001477static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +00001478 assert( p->nOp>0 || p->aOp==0 );
drh0c7d3d32022-01-24 16:47:12 +00001479 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->pParse->nErr>0 );
danielk1977dba01372008-01-05 18:44:29 +00001480 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +00001481 assert( p->aOp );
1482 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
1483 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
1484 }
1485}
1486void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
1487 va_list ap;
1488 if( p ){
danielk1977dba01372008-01-05 18:44:29 +00001489 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001490 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +00001491 va_end(ap);
1492 }
drhad6d9462004-09-19 02:15:24 +00001493}
drh16ee60f2008-06-20 18:13:25 +00001494void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
1495 va_list ap;
drhb07028f2011-10-14 21:49:18 +00001496 if( p ){
1497 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +00001498 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001499 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +00001500 va_end(ap);
1501 }
1502}
1503#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +00001504
drh688852a2014-02-17 22:40:43 +00001505#ifdef SQLITE_VDBE_COVERAGE
1506/*
1507** Set the value if the iSrcLine field for the previously coded instruction.
1508*/
1509void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
drh058e9952022-07-25 19:05:24 +00001510 sqlite3VdbeGetLastOp(v)->iSrcLine = iLine;
drh688852a2014-02-17 22:40:43 +00001511}
1512#endif /* SQLITE_VDBE_COVERAGE */
1513
drh9a324642003-09-06 20:12:01 +00001514/*
drh058e9952022-07-25 19:05:24 +00001515** Return the opcode for a given address. The address must be non-negative.
1516** See sqlite3VdbeGetLastOp() to get the most recently added opcode.
drh20411ea2009-05-29 19:00:12 +00001517**
1518** If a memory allocation error has occurred prior to the calling of this
1519** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +00001520** is readable but not writable, though it is cast to a writable value.
1521** The return of a dummy opcode allows the call to continue functioning
peter.d.reid60ec9142014-09-06 16:39:46 +00001522** after an OOM fault without having to check to see if the return from
drhf83dc1e2010-06-03 12:09:52 +00001523** this routine is a valid pointer. But because the dummy.opcode is 0,
1524** dummy will never be written to. This is verified by code inspection and
1525** by running with Valgrind.
drh9a324642003-09-06 20:12:01 +00001526*/
danielk19774adee202004-05-08 08:23:19 +00001527VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +00001528 /* C89 specifies that the constant "dummy" will be initialized to all
1529 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +00001530 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh66181ce2022-03-31 20:04:49 +00001531 assert( p->eVdbeState==VDBE_INIT_STATE );
drh17435752007-08-16 04:30:38 +00001532 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00001533 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +00001534 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +00001535 }else{
1536 return &p->aOp[addr];
1537 }
drh9a324642003-09-06 20:12:01 +00001538}
1539
drh058e9952022-07-25 19:05:24 +00001540/* Return the most recently added opcode
1541*/
1542VdbeOp * sqlite3VdbeGetLastOp(Vdbe *p){
1543 return sqlite3VdbeGetOp(p, p->nOp - 1);
1544}
1545
drhc7379ce2013-10-30 02:28:23 +00001546#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +00001547/*
drhf63552b2013-10-30 00:25:03 +00001548** Return an integer value for one of the parameters to the opcode pOp
1549** determined by character c.
1550*/
1551static int translateP(char c, const Op *pOp){
1552 if( c=='1' ) return pOp->p1;
1553 if( c=='2' ) return pOp->p2;
1554 if( c=='3' ) return pOp->p3;
1555 if( c=='4' ) return pOp->p4.i;
1556 return pOp->p5;
1557}
1558
drh81316f82013-10-29 20:40:47 +00001559/*
drh4eded602013-12-20 15:59:20 +00001560** Compute a string for the "comment" field of a VDBE opcode listing.
1561**
1562** The Synopsis: field in comments in the vdbe.c source file gets converted
1563** to an extra string that is appended to the sqlite3OpcodeName(). In the
1564** absence of other comments, this synopsis becomes the comment on the opcode.
1565** Some translation occurs:
1566**
1567** "PX" -> "r[X]"
1568** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
1569** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
1570** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
drh81316f82013-10-29 20:40:47 +00001571*/
drh8c5163a2020-03-23 20:58:55 +00001572char *sqlite3VdbeDisplayComment(
drhcb49f542020-03-23 19:14:11 +00001573 sqlite3 *db, /* Optional - Oom error reporting only */
drhf63552b2013-10-30 00:25:03 +00001574 const Op *pOp, /* The opcode to be commented */
drhcb49f542020-03-23 19:14:11 +00001575 const char *zP4 /* Previously obtained value for P4 */
drhf63552b2013-10-30 00:25:03 +00001576){
drh81316f82013-10-29 20:40:47 +00001577 const char *zOpName;
1578 const char *zSynopsis;
1579 int nOpName;
drhd7b10d72020-02-01 17:38:24 +00001580 int ii;
drh1ad78c52016-08-27 14:05:12 +00001581 char zAlt[50];
drhd7b10d72020-02-01 17:38:24 +00001582 StrAccum x;
drhd7b10d72020-02-01 17:38:24 +00001583
drhcb49f542020-03-23 19:14:11 +00001584 sqlite3StrAccumInit(&x, 0, 0, 0, SQLITE_MAX_LENGTH);
drh81316f82013-10-29 20:40:47 +00001585 zOpName = sqlite3OpcodeName(pOp->opcode);
1586 nOpName = sqlite3Strlen30(zOpName);
1587 if( zOpName[nOpName+1] ){
1588 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +00001589 char c;
drh7d4c94b2021-10-04 22:34:38 +00001590 zSynopsis = zOpName + nOpName + 1;
drh1ad78c52016-08-27 14:05:12 +00001591 if( strncmp(zSynopsis,"IF ",3)==0 ){
drh4bc20452021-03-29 18:53:47 +00001592 sqlite3_snprintf(sizeof(zAlt), zAlt, "if %s goto P2", zSynopsis+3);
drh1ad78c52016-08-27 14:05:12 +00001593 zSynopsis = zAlt;
1594 }
drhd7b10d72020-02-01 17:38:24 +00001595 for(ii=0; (c = zSynopsis[ii])!=0; ii++){
drhf63552b2013-10-30 00:25:03 +00001596 if( c=='P' ){
1597 c = zSynopsis[++ii];
1598 if( c=='4' ){
drhd7b10d72020-02-01 17:38:24 +00001599 sqlite3_str_appendall(&x, zP4);
drhf63552b2013-10-30 00:25:03 +00001600 }else if( c=='X' ){
drh088b6152022-04-18 13:57:57 +00001601 if( pOp->zComment && pOp->zComment[0] ){
1602 sqlite3_str_appendall(&x, pOp->zComment);
drhd83997b2022-05-14 17:40:47 +00001603 seenCom = 1;
1604 break;
drh088b6152022-04-18 13:57:57 +00001605 }
drh81316f82013-10-29 20:40:47 +00001606 }else{
drhf63552b2013-10-30 00:25:03 +00001607 int v1 = translateP(c, pOp);
1608 int v2;
drhf63552b2013-10-30 00:25:03 +00001609 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
1610 ii += 3;
drhf63552b2013-10-30 00:25:03 +00001611 v2 = translateP(zSynopsis[ii], pOp);
drh4eded602013-12-20 15:59:20 +00001612 if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
1613 ii += 2;
1614 v2++;
1615 }
drhd7b10d72020-02-01 17:38:24 +00001616 if( v2<2 ){
1617 sqlite3_str_appendf(&x, "%d", v1);
1618 }else{
1619 sqlite3_str_appendf(&x, "%d..%d", v1, v1+v2-1);
drh4eded602013-12-20 15:59:20 +00001620 }
drhd7b10d72020-02-01 17:38:24 +00001621 }else if( strncmp(zSynopsis+ii+1, "@NP", 3)==0 ){
1622 sqlite3_context *pCtx = pOp->p4.pCtx;
drh40d1db82020-02-04 00:55:27 +00001623 if( pOp->p4type!=P4_FUNCCTX || pCtx->argc==1 ){
drhd7b10d72020-02-01 17:38:24 +00001624 sqlite3_str_appendf(&x, "%d", v1);
1625 }else if( pCtx->argc>1 ){
1626 sqlite3_str_appendf(&x, "%d..%d", v1, v1+pCtx->argc-1);
drh1a56fce2020-10-20 12:37:51 +00001627 }else if( x.accError==0 ){
drhd7b10d72020-02-01 17:38:24 +00001628 assert( x.nChar>2 );
1629 x.nChar -= 2;
1630 ii++;
1631 }
1632 ii += 3;
1633 }else{
1634 sqlite3_str_appendf(&x, "%d", v1);
1635 if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
1636 ii += 4;
1637 }
drhf63552b2013-10-30 00:25:03 +00001638 }
drh81316f82013-10-29 20:40:47 +00001639 }
drh81316f82013-10-29 20:40:47 +00001640 }else{
drhd7b10d72020-02-01 17:38:24 +00001641 sqlite3_str_appendchar(&x, 1, c);
drh81316f82013-10-29 20:40:47 +00001642 }
1643 }
drhd7b10d72020-02-01 17:38:24 +00001644 if( !seenCom && pOp->zComment ){
1645 sqlite3_str_appendf(&x, "; %s", pOp->zComment);
drh81316f82013-10-29 20:40:47 +00001646 }
drh81316f82013-10-29 20:40:47 +00001647 }else if( pOp->zComment ){
drhd7b10d72020-02-01 17:38:24 +00001648 sqlite3_str_appendall(&x, pOp->zComment);
drh81316f82013-10-29 20:40:47 +00001649 }
drhcb49f542020-03-23 19:14:11 +00001650 if( (x.accError & SQLITE_NOMEM)!=0 && db!=0 ){
1651 sqlite3OomFault(db);
1652 }
1653 return sqlite3StrAccumFinish(&x);
drh81316f82013-10-29 20:40:47 +00001654}
drhe0ef4e22020-04-02 12:53:17 +00001655#endif /* SQLITE_ENABLE_EXPLAIN_COMMENTS */
drh81316f82013-10-29 20:40:47 +00001656
drhf7e36902015-08-13 21:32:41 +00001657#if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
1658/*
1659** Translate the P4.pExpr value for an OP_CursorHint opcode into text
1660** that can be displayed in the P4 column of EXPLAIN output.
1661*/
drh5f4a6862016-01-30 12:50:25 +00001662static void displayP4Expr(StrAccum *p, Expr *pExpr){
drha67a3162015-08-15 00:51:23 +00001663 const char *zOp = 0;
drhf7e36902015-08-13 21:32:41 +00001664 switch( pExpr->op ){
1665 case TK_STRING:
drhf9751072021-10-07 13:40:29 +00001666 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh0cdbe1a2018-05-09 13:46:26 +00001667 sqlite3_str_appendf(p, "%Q", pExpr->u.zToken);
drhf7e36902015-08-13 21:32:41 +00001668 break;
drhf7e36902015-08-13 21:32:41 +00001669 case TK_INTEGER:
drh0cdbe1a2018-05-09 13:46:26 +00001670 sqlite3_str_appendf(p, "%d", pExpr->u.iValue);
drhf7e36902015-08-13 21:32:41 +00001671 break;
drhf7e36902015-08-13 21:32:41 +00001672 case TK_NULL:
drh0cdbe1a2018-05-09 13:46:26 +00001673 sqlite3_str_appendf(p, "NULL");
drhf7e36902015-08-13 21:32:41 +00001674 break;
drhf7e36902015-08-13 21:32:41 +00001675 case TK_REGISTER: {
drh0cdbe1a2018-05-09 13:46:26 +00001676 sqlite3_str_appendf(p, "r[%d]", pExpr->iTable);
drhf7e36902015-08-13 21:32:41 +00001677 break;
1678 }
drhf7e36902015-08-13 21:32:41 +00001679 case TK_COLUMN: {
drhfe663522015-08-14 01:03:21 +00001680 if( pExpr->iColumn<0 ){
drh0cdbe1a2018-05-09 13:46:26 +00001681 sqlite3_str_appendf(p, "rowid");
drhfe663522015-08-14 01:03:21 +00001682 }else{
drh0cdbe1a2018-05-09 13:46:26 +00001683 sqlite3_str_appendf(p, "c%d", (int)pExpr->iColumn);
drhfe663522015-08-14 01:03:21 +00001684 }
drhf7e36902015-08-13 21:32:41 +00001685 break;
1686 }
drha67a3162015-08-15 00:51:23 +00001687 case TK_LT: zOp = "LT"; break;
1688 case TK_LE: zOp = "LE"; break;
1689 case TK_GT: zOp = "GT"; break;
1690 case TK_GE: zOp = "GE"; break;
1691 case TK_NE: zOp = "NE"; break;
1692 case TK_EQ: zOp = "EQ"; break;
1693 case TK_IS: zOp = "IS"; break;
1694 case TK_ISNOT: zOp = "ISNOT"; break;
1695 case TK_AND: zOp = "AND"; break;
1696 case TK_OR: zOp = "OR"; break;
1697 case TK_PLUS: zOp = "ADD"; break;
1698 case TK_STAR: zOp = "MUL"; break;
1699 case TK_MINUS: zOp = "SUB"; break;
1700 case TK_REM: zOp = "REM"; break;
1701 case TK_BITAND: zOp = "BITAND"; break;
1702 case TK_BITOR: zOp = "BITOR"; break;
1703 case TK_SLASH: zOp = "DIV"; break;
1704 case TK_LSHIFT: zOp = "LSHIFT"; break;
1705 case TK_RSHIFT: zOp = "RSHIFT"; break;
1706 case TK_CONCAT: zOp = "CONCAT"; break;
1707 case TK_UMINUS: zOp = "MINUS"; break;
1708 case TK_UPLUS: zOp = "PLUS"; break;
1709 case TK_BITNOT: zOp = "BITNOT"; break;
1710 case TK_NOT: zOp = "NOT"; break;
1711 case TK_ISNULL: zOp = "ISNULL"; break;
1712 case TK_NOTNULL: zOp = "NOTNULL"; break;
drh81316f82013-10-29 20:40:47 +00001713
drhf7e36902015-08-13 21:32:41 +00001714 default:
drh0cdbe1a2018-05-09 13:46:26 +00001715 sqlite3_str_appendf(p, "%s", "expr");
drhf7e36902015-08-13 21:32:41 +00001716 break;
1717 }
1718
drha67a3162015-08-15 00:51:23 +00001719 if( zOp ){
drh0cdbe1a2018-05-09 13:46:26 +00001720 sqlite3_str_appendf(p, "%s(", zOp);
drh5f4a6862016-01-30 12:50:25 +00001721 displayP4Expr(p, pExpr->pLeft);
1722 if( pExpr->pRight ){
drh0cdbe1a2018-05-09 13:46:26 +00001723 sqlite3_str_append(p, ",", 1);
drh5f4a6862016-01-30 12:50:25 +00001724 displayP4Expr(p, pExpr->pRight);
drha67a3162015-08-15 00:51:23 +00001725 }
drh0cdbe1a2018-05-09 13:46:26 +00001726 sqlite3_str_append(p, ")", 1);
drhf7e36902015-08-13 21:32:41 +00001727 }
drhf7e36902015-08-13 21:32:41 +00001728}
1729#endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
1730
1731
1732#if VDBE_DISPLAY_P4
drh9a324642003-09-06 20:12:01 +00001733/*
drh66a51672008-01-03 00:01:23 +00001734** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +00001735** Use zTemp for any required temporary buffer space.
1736*/
drh8c5163a2020-03-23 20:58:55 +00001737char *sqlite3VdbeDisplayP4(sqlite3 *db, Op *pOp){
drhcb49f542020-03-23 19:14:11 +00001738 char *zP4 = 0;
drh5f4a6862016-01-30 12:50:25 +00001739 StrAccum x;
drhcb49f542020-03-23 19:14:11 +00001740
1741 sqlite3StrAccumInit(&x, 0, 0, 0, SQLITE_MAX_LENGTH);
drh66a51672008-01-03 00:01:23 +00001742 switch( pOp->p4type ){
1743 case P4_KEYINFO: {
drh5f4a6862016-01-30 12:50:25 +00001744 int j;
danielk19772dca4ac2008-01-03 11:50:29 +00001745 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +00001746 assert( pKeyInfo->aSortFlags!=0 );
drh0cdbe1a2018-05-09 13:46:26 +00001747 sqlite3_str_appendf(&x, "k(%d", pKeyInfo->nKeyField);
drha485ad12017-08-02 22:43:14 +00001748 for(j=0; j<pKeyInfo->nKeyField; j++){
drhd3d39e92004-05-20 22:16:29 +00001749 CollSeq *pColl = pKeyInfo->aColl[j];
drh5f4a6862016-01-30 12:50:25 +00001750 const char *zColl = pColl ? pColl->zName : "";
1751 if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
dan6e118922019-08-12 16:36:38 +00001752 sqlite3_str_appendf(&x, ",%s%s%s",
1753 (pKeyInfo->aSortFlags[j] & KEYINFO_ORDER_DESC) ? "-" : "",
1754 (pKeyInfo->aSortFlags[j] & KEYINFO_ORDER_BIGNULL)? "N." : "",
1755 zColl);
drhd3d39e92004-05-20 22:16:29 +00001756 }
drh0cdbe1a2018-05-09 13:46:26 +00001757 sqlite3_str_append(&x, ")", 1);
drhd3d39e92004-05-20 22:16:29 +00001758 break;
1759 }
drh28935362013-12-07 20:39:19 +00001760#ifdef SQLITE_ENABLE_CURSOR_HINTS
1761 case P4_EXPR: {
drh5f4a6862016-01-30 12:50:25 +00001762 displayP4Expr(&x, pOp->p4.pExpr);
drh28935362013-12-07 20:39:19 +00001763 break;
1764 }
1765#endif
drh66a51672008-01-03 00:01:23 +00001766 case P4_COLLSEQ: {
drh4cf21212020-03-05 14:19:49 +00001767 static const char *const encnames[] = {"?", "8", "16LE", "16BE"};
danielk19772dca4ac2008-01-03 11:50:29 +00001768 CollSeq *pColl = pOp->p4.pColl;
drh5025cb52021-07-29 17:23:23 +00001769 assert( pColl->enc<4 );
drh4cf21212020-03-05 14:19:49 +00001770 sqlite3_str_appendf(&x, "%.18s-%s", pColl->zName,
1771 encnames[pColl->enc]);
drhd3d39e92004-05-20 22:16:29 +00001772 break;
1773 }
drh66a51672008-01-03 00:01:23 +00001774 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +00001775 FuncDef *pDef = pOp->p4.pFunc;
drh0cdbe1a2018-05-09 13:46:26 +00001776 sqlite3_str_appendf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +00001777 break;
1778 }
drh9c7c9132015-06-26 18:16:52 +00001779 case P4_FUNCCTX: {
1780 FuncDef *pDef = pOp->p4.pCtx->pFunc;
drh0cdbe1a2018-05-09 13:46:26 +00001781 sqlite3_str_appendf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drh9c7c9132015-06-26 18:16:52 +00001782 break;
1783 }
drh66a51672008-01-03 00:01:23 +00001784 case P4_INT64: {
drh0cdbe1a2018-05-09 13:46:26 +00001785 sqlite3_str_appendf(&x, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +00001786 break;
1787 }
drh66a51672008-01-03 00:01:23 +00001788 case P4_INT32: {
drh0cdbe1a2018-05-09 13:46:26 +00001789 sqlite3_str_appendf(&x, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +00001790 break;
1791 }
drh66a51672008-01-03 00:01:23 +00001792 case P4_REAL: {
drh0cdbe1a2018-05-09 13:46:26 +00001793 sqlite3_str_appendf(&x, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +00001794 break;
1795 }
drh66a51672008-01-03 00:01:23 +00001796 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +00001797 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001798 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001799 zP4 = pMem->z;
drh169f0772019-05-02 21:36:26 +00001800 }else if( pMem->flags & (MEM_Int|MEM_IntReal) ){
drh0cdbe1a2018-05-09 13:46:26 +00001801 sqlite3_str_appendf(&x, "%lld", pMem->u.i);
drhd4e70eb2008-01-02 00:34:36 +00001802 }else if( pMem->flags & MEM_Real ){
drh0cdbe1a2018-05-09 13:46:26 +00001803 sqlite3_str_appendf(&x, "%.16g", pMem->u.r);
drhb8475df2011-12-09 16:21:19 +00001804 }else if( pMem->flags & MEM_Null ){
drh5f4a6862016-01-30 12:50:25 +00001805 zP4 = "NULL";
drh56016892009-08-25 14:24:04 +00001806 }else{
1807 assert( pMem->flags & MEM_Blob );
1808 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001809 }
drh598f1342007-10-23 15:39:45 +00001810 break;
1811 }
drha967e882006-06-13 01:04:52 +00001812#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001813 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001814 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh0cdbe1a2018-05-09 13:46:26 +00001815 sqlite3_str_appendf(&x, "vtab:%p", pVtab);
drha967e882006-06-13 01:04:52 +00001816 break;
1817 }
1818#endif
drh0acb7e42008-06-25 00:12:41 +00001819 case P4_INTARRAY: {
drhabc38152020-07-22 13:38:04 +00001820 u32 i;
1821 u32 *ai = pOp->p4.ai;
1822 u32 n = ai[0]; /* The first element of an INTARRAY is always the
drhb1702022016-01-30 00:45:18 +00001823 ** count of the number of elements to follow */
drhb5c10632017-09-21 00:49:15 +00001824 for(i=1; i<=n; i++){
drhabc38152020-07-22 13:38:04 +00001825 sqlite3_str_appendf(&x, "%c%u", (i==1 ? '[' : ','), ai[i]);
drh5f4a6862016-01-30 12:50:25 +00001826 }
drh0cdbe1a2018-05-09 13:46:26 +00001827 sqlite3_str_append(&x, "]", 1);
drh0acb7e42008-06-25 00:12:41 +00001828 break;
1829 }
dan165921a2009-08-28 18:53:45 +00001830 case P4_SUBPROGRAM: {
drhcb49f542020-03-23 19:14:11 +00001831 zP4 = "program";
dan165921a2009-08-28 18:53:45 +00001832 break;
1833 }
drh74c33022016-03-30 12:56:55 +00001834 case P4_TABLE: {
drhcb49f542020-03-23 19:14:11 +00001835 zP4 = pOp->p4.pTab->zName;
drh74c33022016-03-30 12:56:55 +00001836 break;
1837 }
drhd3d39e92004-05-20 22:16:29 +00001838 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001839 zP4 = pOp->p4.z;
drhd3d39e92004-05-20 22:16:29 +00001840 }
1841 }
drhcb49f542020-03-23 19:14:11 +00001842 if( zP4 ) sqlite3_str_appendall(&x, zP4);
drhe1cd73f2020-04-02 17:21:51 +00001843 if( (x.accError & SQLITE_NOMEM)!=0 ){
drhcb49f542020-03-23 19:14:11 +00001844 sqlite3OomFault(db);
1845 }
1846 return sqlite3StrAccumFinish(&x);
drhd3d39e92004-05-20 22:16:29 +00001847}
drhf7e36902015-08-13 21:32:41 +00001848#endif /* VDBE_DISPLAY_P4 */
drhd3d39e92004-05-20 22:16:29 +00001849
drh900b31e2007-08-28 02:27:51 +00001850/*
drhd0679ed2007-08-28 22:24:34 +00001851** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001852**
drhbdaec522011-04-04 00:14:43 +00001853** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001854** attached databases that will be use. A mask of these databases
1855** is maintained in p->btreeMask. The p->lockMask value is the subset of
1856** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001857*/
drhfb982642007-08-30 01:19:59 +00001858void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001859 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001860 assert( i<(int)sizeof(p->btreeMask)*8 );
drha7ab6d82014-07-21 15:44:39 +00001861 DbMaskSet(p->btreeMask, i);
drhdc5b0472011-04-06 22:05:53 +00001862 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
drha7ab6d82014-07-21 15:44:39 +00001863 DbMaskSet(p->lockMask, i);
drhdc5b0472011-04-06 22:05:53 +00001864 }
drh900b31e2007-08-28 02:27:51 +00001865}
1866
dan20d876f2016-01-07 16:06:22 +00001867#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhbdaec522011-04-04 00:14:43 +00001868/*
1869** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1870** this routine obtains the mutex associated with each BtShared structure
1871** that may be accessed by the VM passed as an argument. In doing so it also
1872** sets the BtShared.db member of each of the BtShared structures, ensuring
1873** that the correct busy-handler callback is invoked if required.
1874**
1875** If SQLite is not threadsafe but does support shared-cache mode, then
1876** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1877** of all of BtShared structures accessible via the database handle
1878** associated with the VM.
1879**
1880** If SQLite is not threadsafe and does not support shared-cache mode, this
1881** function is a no-op.
1882**
1883** The p->btreeMask field is a bitmask of all btrees that the prepared
1884** statement p will ever use. Let N be the number of bits in p->btreeMask
1885** corresponding to btrees that use shared cache. Then the runtime of
1886** this routine is N*N. But as N is rarely more than 1, this should not
1887** be a problem.
1888*/
1889void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001890 int i;
drhdc5b0472011-04-06 22:05:53 +00001891 sqlite3 *db;
1892 Db *aDb;
1893 int nDb;
drha7ab6d82014-07-21 15:44:39 +00001894 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
drhdc5b0472011-04-06 22:05:53 +00001895 db = p->db;
1896 aDb = db->aDb;
1897 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001898 for(i=0; i<nDb; i++){
1899 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001900 sqlite3BtreeEnter(aDb[i].pBt);
1901 }
1902 }
drhbdaec522011-04-04 00:14:43 +00001903}
drhe54e0512011-04-05 17:31:56 +00001904#endif
drhbdaec522011-04-04 00:14:43 +00001905
drhe54e0512011-04-05 17:31:56 +00001906#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001907/*
1908** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1909*/
drhf1aabd62015-06-17 01:31:28 +00001910static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001911 int i;
drhdc5b0472011-04-06 22:05:53 +00001912 sqlite3 *db;
1913 Db *aDb;
1914 int nDb;
drhdc5b0472011-04-06 22:05:53 +00001915 db = p->db;
1916 aDb = db->aDb;
1917 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001918 for(i=0; i<nDb; i++){
1919 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001920 sqlite3BtreeLeave(aDb[i].pBt);
1921 }
1922 }
drhbdaec522011-04-04 00:14:43 +00001923}
drhf1aabd62015-06-17 01:31:28 +00001924void sqlite3VdbeLeave(Vdbe *p){
1925 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
1926 vdbeLeave(p);
1927}
drhbdaec522011-04-04 00:14:43 +00001928#endif
drhd3d39e92004-05-20 22:16:29 +00001929
danielk19778b60e0f2005-01-12 09:10:39 +00001930#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00001931/*
1932** Print a single opcode. This routine is used for debugging only.
1933*/
drh299bf7c2018-06-11 17:35:02 +00001934void sqlite3VdbePrintOp(FILE *pOut, int pc, VdbeOp *pOp){
drh66a51672008-01-03 00:01:23 +00001935 char *zP4;
drhcb49f542020-03-23 19:14:11 +00001936 char *zCom;
drhe1cd73f2020-04-02 17:21:51 +00001937 sqlite3 dummyDb;
drh26198bb2013-10-31 11:15:09 +00001938 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00001939 if( pOut==0 ) pOut = stdout;
dan62c94d02020-05-16 15:18:27 +00001940 sqlite3BeginBenignMalloc();
drhe1cd73f2020-04-02 17:21:51 +00001941 dummyDb.mallocFailed = 1;
1942 zP4 = sqlite3VdbeDisplayP4(&dummyDb, pOp);
drhc7379ce2013-10-30 02:28:23 +00001943#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh8c5163a2020-03-23 20:58:55 +00001944 zCom = sqlite3VdbeDisplayComment(0, pOp, zP4);
drh81316f82013-10-29 20:40:47 +00001945#else
drhcb49f542020-03-23 19:14:11 +00001946 zCom = 0;
drh81316f82013-10-29 20:40:47 +00001947#endif
drh4eded602013-12-20 15:59:20 +00001948 /* NB: The sqlite3OpcodeName() function is implemented by code created
1949 ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
1950 ** information from the vdbe.c source text */
danielk197711641c12008-01-03 08:18:30 +00001951 fprintf(pOut, zFormat1, pc,
drh7e088a62020-05-02 00:01:39 +00001952 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3,
1953 zP4 ? zP4 : "", pOp->p5,
drhcb49f542020-03-23 19:14:11 +00001954 zCom ? zCom : ""
drh1db639c2008-01-17 02:36:28 +00001955 );
drh9a324642003-09-06 20:12:01 +00001956 fflush(pOut);
drhcb49f542020-03-23 19:14:11 +00001957 sqlite3_free(zP4);
1958 sqlite3_free(zCom);
dan62c94d02020-05-16 15:18:27 +00001959 sqlite3EndBenignMalloc();
drh9a324642003-09-06 20:12:01 +00001960}
1961#endif
1962
1963/*
drh2a1df932016-09-30 17:46:44 +00001964** Initialize an array of N Mem element.
drhc9373e82022-02-28 03:25:13 +00001965**
drh42963572022-02-28 12:08:09 +00001966** This is a high-runner, so only those fields that really do need to
1967** be initialized are set. The Mem structure is organized so that
1968** the fields that get initialized are nearby and hopefully on the same
1969** cache line.
drhc9373e82022-02-28 03:25:13 +00001970**
1971** Mem.flags = flags
1972** Mem.db = db
1973** Mem.szMalloc = 0
1974**
1975** All other fields of Mem can safely remain uninitialized for now. They
drh42963572022-02-28 12:08:09 +00001976** will be initialized before use.
drh2a1df932016-09-30 17:46:44 +00001977*/
1978static void initMemArray(Mem *p, int N, sqlite3 *db, u16 flags){
drhc9373e82022-02-28 03:25:13 +00001979 if( N>0 ){
drhc9373e82022-02-28 03:25:13 +00001980 do{
drh42963572022-02-28 12:08:09 +00001981 p->flags = flags;
1982 p->db = db;
1983 p->szMalloc = 0;
drh2a1df932016-09-30 17:46:44 +00001984#ifdef SQLITE_DEBUG
drhc9373e82022-02-28 03:25:13 +00001985 p->pScopyFrom = 0;
drh2a1df932016-09-30 17:46:44 +00001986#endif
drhc9373e82022-02-28 03:25:13 +00001987 p++;
1988 }while( (--N)>0 );
drh2a1df932016-09-30 17:46:44 +00001989 }
1990}
1991
1992/*
drh5308d392022-03-02 13:45:22 +00001993** Release auxiliary memory held in an array of N Mem elements.
1994**
1995** After this routine returns, all Mem elements in the array will still
1996** be valid. Those Mem elements that were not holding auxiliary resources
1997** will be unchanged. Mem elements which had something freed will be
1998** set to MEM_Undefined.
drh76ff3a02004-09-24 22:32:30 +00001999*/
drhc890fec2008-08-01 20:10:08 +00002000static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00002001 if( p && N ){
drh069c23c2014-09-19 16:13:12 +00002002 Mem *pEnd = &p[N];
danielk1977a7a8e142008-02-13 18:25:27 +00002003 sqlite3 *db = p->db;
dand46def72010-07-24 11:28:28 +00002004 if( db->pnBytesFreed ){
drh069c23c2014-09-19 16:13:12 +00002005 do{
drh17bcb102014-09-18 21:25:33 +00002006 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh069c23c2014-09-19 16:13:12 +00002007 }while( (++p)<pEnd );
drhc176c272010-07-26 13:57:59 +00002008 return;
2009 }
drh069c23c2014-09-19 16:13:12 +00002010 do{
danielk1977e972e032008-09-19 18:32:26 +00002011 assert( (&p[1])==pEnd || p[0].db==p[1].db );
drh75fd0542014-03-01 16:24:44 +00002012 assert( sqlite3VdbeCheckMemInvariants(p) );
danielk1977e972e032008-09-19 18:32:26 +00002013
2014 /* This block is really an inlined version of sqlite3VdbeMemRelease()
2015 ** that takes advantage of the fact that the memory cell value is
2016 ** being set to NULL after releasing any dynamic resources.
2017 **
2018 ** The justification for duplicating code is that according to
2019 ** callgrind, this causes a certain test case to hit the CPU 4.7
2020 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
2021 ** sqlite3MemRelease() were called from here. With -O2, this jumps
2022 ** to 6.6 percent. The test case is inserting 1000 rows into a table
2023 ** with no indexes using a single prepared INSERT statement, bind()
2024 ** and reset(). Inserts are grouped into a transaction.
2025 */
drhb6e8fd12014-03-06 01:56:33 +00002026 testcase( p->flags & MEM_Agg );
2027 testcase( p->flags & MEM_Dyn );
drh9d67afc2018-08-29 20:24:03 +00002028 if( p->flags&(MEM_Agg|MEM_Dyn) ){
drh9fdd66e2021-10-20 17:58:33 +00002029 testcase( (p->flags & MEM_Dyn)!=0 && p->xDel==sqlite3VdbeFrameMemDel );
danielk1977e972e032008-09-19 18:32:26 +00002030 sqlite3VdbeMemRelease(p);
drh5308d392022-03-02 13:45:22 +00002031 p->flags = MEM_Undefined;
drh17bcb102014-09-18 21:25:33 +00002032 }else if( p->szMalloc ){
drh41ce47c2022-08-22 02:00:26 +00002033 sqlite3DbNNFreeNN(db, p->zMalloc);
drh17bcb102014-09-18 21:25:33 +00002034 p->szMalloc = 0;
drh5308d392022-03-02 13:45:22 +00002035 p->flags = MEM_Undefined;
danielk1977e972e032008-09-19 18:32:26 +00002036 }
drh5308d392022-03-02 13:45:22 +00002037#ifdef SQLITE_DEBUG
2038 else{
2039 p->flags = MEM_Undefined;
2040 }
2041#endif
drh069c23c2014-09-19 16:13:12 +00002042 }while( (++p)<pEnd );
drh76ff3a02004-09-24 22:32:30 +00002043 }
2044}
2045
drh72f56ef2018-08-29 18:47:22 +00002046#ifdef SQLITE_DEBUG
2047/*
2048** Verify that pFrame is a valid VdbeFrame pointer. Return true if it is
2049** and false if something is wrong.
2050**
2051** This routine is intended for use inside of assert() statements only.
2052*/
2053int sqlite3VdbeFrameIsValid(VdbeFrame *pFrame){
2054 if( pFrame->iFrameMagic!=SQLITE_FRAME_MAGIC ) return 0;
2055 return 1;
2056}
2057#endif
2058
2059
2060/*
2061** This is a destructor on a Mem object (which is really an sqlite3_value)
2062** that deletes the Frame object that is attached to it as a blob.
2063**
2064** This routine does not delete the Frame right away. It merely adds the
2065** frame to a list of frames to be deleted when the Vdbe halts.
2066*/
2067void sqlite3VdbeFrameMemDel(void *pArg){
2068 VdbeFrame *pFrame = (VdbeFrame*)pArg;
2069 assert( sqlite3VdbeFrameIsValid(pFrame) );
2070 pFrame->pParent = pFrame->v->pDelFrame;
2071 pFrame->v->pDelFrame = pFrame;
2072}
2073
drh8c5163a2020-03-23 20:58:55 +00002074#if defined(SQLITE_ENABLE_BYTECODE_VTAB) || !defined(SQLITE_OMIT_EXPLAIN)
drh356cd762020-03-23 17:24:46 +00002075/*
2076** Locate the next opcode to be displayed in EXPLAIN or EXPLAIN
2077** QUERY PLAN output.
2078**
2079** Return SQLITE_ROW on success. Return SQLITE_DONE if there are no
2080** more opcodes to be displayed.
2081*/
2082int sqlite3VdbeNextOpcode(
2083 Vdbe *p, /* The statement being explained */
2084 Mem *pSub, /* Storage for keeping track of subprogram nesting */
drh8f78a522020-03-26 16:48:18 +00002085 int eMode, /* 0: normal. 1: EQP. 2: TablesUsed */
drh356cd762020-03-23 17:24:46 +00002086 int *piPc, /* IN/OUT: Current rowid. Overwritten with next rowid */
2087 int *piAddr, /* OUT: Write index into (*paOp)[] here */
2088 Op **paOp /* OUT: Write the opcode array here */
2089){
2090 int nRow; /* Stop when row count reaches this */
2091 int nSub = 0; /* Number of sub-vdbes seen so far */
2092 SubProgram **apSub = 0; /* Array of sub-vdbes */
2093 int i; /* Next instruction address */
2094 int rc = SQLITE_OK; /* Result code */
drhc004bd52020-04-02 13:08:54 +00002095 Op *aOp = 0; /* Opcode array */
drh356cd762020-03-23 17:24:46 +00002096 int iPc; /* Rowid. Copy of value in *piPc */
2097
2098 /* When the number of output rows reaches nRow, that means the
2099 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
2100 ** nRow is the sum of the number of rows in the main program, plus
2101 ** the sum of the number of rows in all trigger subprograms encountered
2102 ** so far. The nRow value will increase as new trigger subprograms are
2103 ** encountered, but p->pc will eventually catch up to nRow.
2104 */
2105 nRow = p->nOp;
2106 if( pSub!=0 ){
2107 if( pSub->flags&MEM_Blob ){
2108 /* pSub is initiallly NULL. It is initialized to a BLOB by
2109 ** the P4_SUBPROGRAM processing logic below */
2110 nSub = pSub->n/sizeof(Vdbe*);
2111 apSub = (SubProgram **)pSub->z;
2112 }
2113 for(i=0; i<nSub; i++){
2114 nRow += apSub[i]->nOp;
2115 }
2116 }
2117 iPc = *piPc;
2118 while(1){ /* Loop exits via break */
2119 i = iPc++;
2120 if( i>=nRow ){
2121 p->rc = SQLITE_OK;
2122 rc = SQLITE_DONE;
2123 break;
2124 }
2125 if( i<p->nOp ){
2126 /* The rowid is small enough that we are still in the
2127 ** main program. */
2128 aOp = p->aOp;
2129 }else{
2130 /* We are currently listing subprograms. Figure out which one and
2131 ** pick up the appropriate opcode. */
2132 int j;
2133 i -= p->nOp;
2134 assert( apSub!=0 );
2135 assert( nSub>0 );
2136 for(j=0; i>=apSub[j]->nOp; j++){
2137 i -= apSub[j]->nOp;
2138 assert( i<apSub[j]->nOp || j+1<nSub );
2139 }
2140 aOp = apSub[j]->aOp;
2141 }
2142
2143 /* When an OP_Program opcode is encounter (the only opcode that has
2144 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
2145 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
2146 ** has not already been seen.
2147 */
2148 if( pSub!=0 && aOp[i].p4type==P4_SUBPROGRAM ){
2149 int nByte = (nSub+1)*sizeof(SubProgram*);
2150 int j;
2151 for(j=0; j<nSub; j++){
2152 if( apSub[j]==aOp[i].p4.pProgram ) break;
2153 }
2154 if( j==nSub ){
2155 p->rc = sqlite3VdbeMemGrow(pSub, nByte, nSub!=0);
2156 if( p->rc!=SQLITE_OK ){
2157 rc = SQLITE_ERROR;
2158 break;
2159 }
2160 apSub = (SubProgram **)pSub->z;
2161 apSub[nSub++] = aOp[i].p4.pProgram;
drh0518d062020-03-24 13:27:53 +00002162 MemSetTypeFlag(pSub, MEM_Blob);
drh356cd762020-03-23 17:24:46 +00002163 pSub->n = nSub*sizeof(SubProgram*);
2164 nRow += aOp[i].p4.pProgram->nOp;
2165 }
2166 }
drh8f78a522020-03-26 16:48:18 +00002167 if( eMode==0 ) break;
2168#ifdef SQLITE_ENABLE_BYTECODE_VTAB
2169 if( eMode==2 ){
2170 Op *pOp = aOp + i;
2171 if( pOp->opcode==OP_OpenRead ) break;
2172 if( pOp->opcode==OP_OpenWrite && (pOp->p5 & OPFLAG_P2ISREG)==0 ) break;
2173 if( pOp->opcode==OP_ReopenIdx ) break;
2174 }else
2175#endif
2176 {
2177 assert( eMode==1 );
2178 if( aOp[i].opcode==OP_Explain ) break;
drh49d01ab2020-04-02 19:58:31 +00002179 if( aOp[i].opcode==OP_Init && iPc>1 ) break;
drh8f78a522020-03-26 16:48:18 +00002180 }
drh356cd762020-03-23 17:24:46 +00002181 }
2182 *piPc = iPc;
2183 *piAddr = i;
2184 *paOp = aOp;
2185 return rc;
2186}
drh8c5163a2020-03-23 20:58:55 +00002187#endif /* SQLITE_ENABLE_BYTECODE_VTAB || !SQLITE_OMIT_EXPLAIN */
drh356cd762020-03-23 17:24:46 +00002188
drh72f56ef2018-08-29 18:47:22 +00002189
dan65a7cd12009-09-01 12:16:01 +00002190/*
2191** Delete a VdbeFrame object and its contents. VdbeFrame objects are
2192** allocated by the OP_Program opcode in sqlite3VdbeExec().
2193*/
dan165921a2009-08-28 18:53:45 +00002194void sqlite3VdbeFrameDelete(VdbeFrame *p){
2195 int i;
2196 Mem *aMem = VdbeFrameMem(p);
2197 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
drh72f56ef2018-08-29 18:47:22 +00002198 assert( sqlite3VdbeFrameIsValid(p) );
dan165921a2009-08-28 18:53:45 +00002199 for(i=0; i<p->nChildCsr; i++){
drh473571b2022-04-01 18:19:04 +00002200 if( apCsr[i] ) sqlite3VdbeFreeCursorNN(p->v, apCsr[i]);
dan165921a2009-08-28 18:53:45 +00002201 }
2202 releaseMemArray(aMem, p->nChildMem);
drhb9626cf2016-02-22 16:04:31 +00002203 sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
dan165921a2009-08-28 18:53:45 +00002204 sqlite3DbFree(p->v->db, p);
2205}
2206
drhb7f91642004-10-31 02:22:47 +00002207#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00002208/*
drh9a324642003-09-06 20:12:01 +00002209** Give a listing of the program in the virtual machine.
2210**
danielk19774adee202004-05-08 08:23:19 +00002211** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00002212** running the code, it invokes the callback once for each instruction.
2213** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00002214**
2215** When p->explain==1, each instruction is listed. When
2216** p->explain==2, only OP_Explain instructions are listed and these
2217** are shown in a different format. p->explain==2 is used to implement
2218** EXPLAIN QUERY PLAN.
drh4b5345c2018-04-24 13:07:40 +00002219** 2018-04-24: In p->explain==2 mode, the OP_Init opcodes of triggers
2220** are also shown, so that the boundaries between the main program and
2221** each trigger are clear.
drh5cfa5842009-12-31 20:35:08 +00002222**
2223** When p->explain==1, first the main program is listed, then each of
2224** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00002225*/
danielk19774adee202004-05-08 08:23:19 +00002226int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00002227 Vdbe *p /* The VDBE */
2228){
drh5cfa5842009-12-31 20:35:08 +00002229 Mem *pSub = 0; /* Memory cell hold array of subprogs */
2230 sqlite3 *db = p->db; /* The database connection */
2231 int i; /* Loop counter */
2232 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00002233 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh36e31c62017-12-21 18:23:26 +00002234 int bListSubprogs = (p->explain==1 || (db->flags & SQLITE_TriggerEQP)!=0);
drh356cd762020-03-23 17:24:46 +00002235 Op *aOp; /* Array of opcodes */
2236 Op *pOp; /* Current opcode */
drh9a324642003-09-06 20:12:01 +00002237
drh9a324642003-09-06 20:12:01 +00002238 assert( p->explain );
drh66181ce2022-03-31 20:04:49 +00002239 assert( p->eVdbeState==VDBE_RUN_STATE );
danielk19776c359f02008-11-21 16:58:03 +00002240 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00002241
drh9cbf3422008-01-17 16:22:13 +00002242 /* Even though this opcode does not use dynamic strings for
2243 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00002244 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00002245 */
dan165921a2009-08-28 18:53:45 +00002246 releaseMemArray(pMem, 8);
drh9734e6e2011-10-07 18:24:25 +00002247 p->pResultSet = 0;
danielk197718f41892004-05-22 07:27:46 +00002248
drh85b76a22017-10-12 20:24:09 +00002249 if( p->rc==SQLITE_NOMEM ){
danielk19776c359f02008-11-21 16:58:03 +00002250 /* This happens if a malloc() inside a call to sqlite3_column_text() or
2251 ** sqlite3_column_text16() failed. */
drh4a642b62016-02-05 01:55:27 +00002252 sqlite3OomFault(db);
danielk19776c359f02008-11-21 16:58:03 +00002253 return SQLITE_ERROR;
2254 }
2255
drh36e31c62017-12-21 18:23:26 +00002256 if( bListSubprogs ){
drh5cfa5842009-12-31 20:35:08 +00002257 /* The first 8 memory cells are used for the result set. So we will
2258 ** commandeer the 9th cell to use as storage for an array of pointers
2259 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
2260 ** cells. */
2261 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00002262 pSub = &p->aMem[9];
drh356cd762020-03-23 17:24:46 +00002263 }else{
2264 pSub = 0;
dan165921a2009-08-28 18:53:45 +00002265 }
2266
drh356cd762020-03-23 17:24:46 +00002267 /* Figure out which opcode is next to display */
2268 rc = sqlite3VdbeNextOpcode(p, pSub, p->explain==2, &p->pc, &i, &aOp);
drheb2e1762004-05-27 01:53:56 +00002269
dan280db652017-04-17 17:03:08 +00002270 if( rc==SQLITE_OK ){
drh356cd762020-03-23 17:24:46 +00002271 pOp = aOp + i;
dan892edb62020-03-30 13:35:05 +00002272 if( AtomicLoad(&db->u1.isInterrupted) ){
dan280db652017-04-17 17:03:08 +00002273 p->rc = SQLITE_INTERRUPT;
2274 rc = SQLITE_ERROR;
2275 sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
danielk1977a7a8e142008-02-13 18:25:27 +00002276 }else{
drh8c5163a2020-03-23 20:58:55 +00002277 char *zP4 = sqlite3VdbeDisplayP4(db, pOp);
drhcb49f542020-03-23 19:14:11 +00002278 if( p->explain==2 ){
2279 sqlite3VdbeMemSetInt64(pMem, pOp->p1);
2280 sqlite3VdbeMemSetInt64(pMem+1, pOp->p2);
2281 sqlite3VdbeMemSetInt64(pMem+2, pOp->p3);
2282 sqlite3VdbeMemSetStr(pMem+3, zP4, -1, SQLITE_UTF8, sqlite3_free);
2283 p->nResColumn = 4;
dan280db652017-04-17 17:03:08 +00002284 }else{
drhcb49f542020-03-23 19:14:11 +00002285 sqlite3VdbeMemSetInt64(pMem+0, i);
2286 sqlite3VdbeMemSetStr(pMem+1, (char*)sqlite3OpcodeName(pOp->opcode),
2287 -1, SQLITE_UTF8, SQLITE_STATIC);
2288 sqlite3VdbeMemSetInt64(pMem+2, pOp->p1);
2289 sqlite3VdbeMemSetInt64(pMem+3, pOp->p2);
2290 sqlite3VdbeMemSetInt64(pMem+4, pOp->p3);
2291 /* pMem+5 for p4 is done last */
2292 sqlite3VdbeMemSetInt64(pMem+6, pOp->p5);
dan280db652017-04-17 17:03:08 +00002293#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhcb49f542020-03-23 19:14:11 +00002294 {
drh8c5163a2020-03-23 20:58:55 +00002295 char *zCom = sqlite3VdbeDisplayComment(db, pOp, zP4);
drhcb49f542020-03-23 19:14:11 +00002296 sqlite3VdbeMemSetStr(pMem+7, zCom, -1, SQLITE_UTF8, sqlite3_free);
dan280db652017-04-17 17:03:08 +00002297 }
dan280db652017-04-17 17:03:08 +00002298#else
drhcb49f542020-03-23 19:14:11 +00002299 sqlite3VdbeMemSetNull(pMem+7);
dan280db652017-04-17 17:03:08 +00002300#endif
drhcb49f542020-03-23 19:14:11 +00002301 sqlite3VdbeMemSetStr(pMem+5, zP4, -1, SQLITE_UTF8, sqlite3_free);
2302 p->nResColumn = 8;
dan280db652017-04-17 17:03:08 +00002303 }
drhcb49f542020-03-23 19:14:11 +00002304 p->pResultSet = pMem;
2305 if( db->mallocFailed ){
2306 p->rc = SQLITE_NOMEM;
2307 rc = SQLITE_ERROR;
2308 }else{
2309 p->rc = SQLITE_OK;
2310 rc = SQLITE_ROW;
2311 }
dan280db652017-04-17 17:03:08 +00002312 }
drh9a324642003-09-06 20:12:01 +00002313 }
drh826fb5a2004-02-14 23:59:57 +00002314 return rc;
drh9a324642003-09-06 20:12:01 +00002315}
drhb7f91642004-10-31 02:22:47 +00002316#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00002317
drh7c4ac0c2007-04-05 11:25:58 +00002318#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00002319/*
drh3f7d4e42004-07-24 14:35:58 +00002320** Print the SQL that was used to generate a VDBE program.
2321*/
2322void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00002323 const char *z = 0;
2324 if( p->zSql ){
2325 z = p->zSql;
2326 }else if( p->nOp>=1 ){
2327 const VdbeOp *pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00002328 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh84e55a82013-11-13 17:58:23 +00002329 z = pOp->p4.z;
2330 while( sqlite3Isspace(*z) ) z++;
2331 }
drh3f7d4e42004-07-24 14:35:58 +00002332 }
drh84e55a82013-11-13 17:58:23 +00002333 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00002334}
drh7c4ac0c2007-04-05 11:25:58 +00002335#endif
drh3f7d4e42004-07-24 14:35:58 +00002336
drh602c2372007-03-01 00:29:13 +00002337#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
2338/*
2339** Print an IOTRACE message showing SQL content.
2340*/
2341void sqlite3VdbeIOTraceSql(Vdbe *p){
2342 int nOp = p->nOp;
2343 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00002344 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00002345 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00002346 pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00002347 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00002348 int i, j;
drh00a18e42007-08-13 11:10:34 +00002349 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00002350 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00002351 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00002352 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00002353 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00002354 if( z[i-1]!=' ' ){
2355 z[j++] = ' ';
2356 }
2357 }else{
2358 z[j++] = z[i];
2359 }
2360 }
2361 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00002362 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00002363 }
2364}
2365#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
2366
drha7dc4a32016-01-25 02:15:02 +00002367/* An instance of this object describes bulk memory available for use
2368** by subcomponents of a prepared statement. Space is allocated out
2369** of a ReusableSpace object by the allocSpace() routine below.
2370*/
2371struct ReusableSpace {
drhf6ad2012019-04-13 14:07:57 +00002372 u8 *pSpace; /* Available memory */
2373 sqlite3_int64 nFree; /* Bytes of available memory */
2374 sqlite3_int64 nNeeded; /* Total bytes that could not be allocated */
drha7dc4a32016-01-25 02:15:02 +00002375};
2376
2377/* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
2378** from the ReusableSpace object. Return a pointer to the allocated
2379** memory on success. If insufficient memory is available in the
2380** ReusableSpace object, increase the ReusableSpace.nNeeded
2381** value by the amount needed and return NULL.
drh4800b2e2009-12-08 15:35:22 +00002382**
drha7dc4a32016-01-25 02:15:02 +00002383** If pBuf is not initially NULL, that means that the memory has already
2384** been allocated by a prior call to this routine, so just return a copy
2385** of pBuf and leave ReusableSpace unchanged.
drhb2771ce2009-02-20 01:28:59 +00002386**
drha7dc4a32016-01-25 02:15:02 +00002387** This allocator is employed to repurpose unused slots at the end of the
2388** opcode array of prepared state for other memory needs of the prepared
2389** statement.
drhb2771ce2009-02-20 01:28:59 +00002390*/
drh4800b2e2009-12-08 15:35:22 +00002391static void *allocSpace(
drha7dc4a32016-01-25 02:15:02 +00002392 struct ReusableSpace *p, /* Bulk memory available for allocation */
2393 void *pBuf, /* Pointer to a prior allocation */
drhcf6e3fd2022-04-01 18:45:11 +00002394 sqlite3_int64 nByte /* Bytes of memory needed. */
drhb2771ce2009-02-20 01:28:59 +00002395){
drha7dc4a32016-01-25 02:15:02 +00002396 assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
drhd797a9b2015-12-07 16:43:44 +00002397 if( pBuf==0 ){
drhcf6e3fd2022-04-01 18:45:11 +00002398 nByte = ROUND8P(nByte);
drha7dc4a32016-01-25 02:15:02 +00002399 if( nByte <= p->nFree ){
2400 p->nFree -= nByte;
2401 pBuf = &p->pSpace[p->nFree];
drhd797a9b2015-12-07 16:43:44 +00002402 }else{
drha7dc4a32016-01-25 02:15:02 +00002403 p->nNeeded += nByte;
drhd797a9b2015-12-07 16:43:44 +00002404 }
drhb2771ce2009-02-20 01:28:59 +00002405 }
drhd797a9b2015-12-07 16:43:44 +00002406 assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
drh4800b2e2009-12-08 15:35:22 +00002407 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00002408}
drh602c2372007-03-01 00:29:13 +00002409
drh3f7d4e42004-07-24 14:35:58 +00002410/*
drh124c0b42011-06-01 18:15:55 +00002411** Rewind the VDBE back to the beginning in preparation for
2412** running it.
drh9a324642003-09-06 20:12:01 +00002413*/
drh124c0b42011-06-01 18:15:55 +00002414void sqlite3VdbeRewind(Vdbe *p){
2415#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
2416 int i;
2417#endif
drh9a324642003-09-06 20:12:01 +00002418 assert( p!=0 );
drh99a21822022-03-31 21:15:09 +00002419 assert( p->eVdbeState==VDBE_INIT_STATE
2420 || p->eVdbeState==VDBE_READY_STATE
2421 || p->eVdbeState==VDBE_HALT_STATE );
drh9a324642003-09-06 20:12:01 +00002422
drhc16a03b2004-09-15 13:38:10 +00002423 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00002424 */
drhc16a03b2004-09-15 13:38:10 +00002425 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00002426
drh99a21822022-03-31 21:15:09 +00002427 p->eVdbeState = VDBE_READY_STATE;
danielk1977634f2982005-03-28 08:44:07 +00002428
drh124c0b42011-06-01 18:15:55 +00002429#ifdef SQLITE_DEBUG
drh9f6168b2016-03-19 23:32:58 +00002430 for(i=0; i<p->nMem; i++){
drh124c0b42011-06-01 18:15:55 +00002431 assert( p->aMem[i].db==p->db );
2432 }
2433#endif
2434 p->pc = -1;
2435 p->rc = SQLITE_OK;
2436 p->errorAction = OE_Abort;
drh124c0b42011-06-01 18:15:55 +00002437 p->nChange = 0;
2438 p->cacheCtr = 1;
2439 p->minWriteFileFormat = 255;
2440 p->iStatement = 0;
2441 p->nFkConstraint = 0;
2442#ifdef VDBE_PROFILE
2443 for(i=0; i<p->nOp; i++){
2444 p->aOp[i].cnt = 0;
2445 p->aOp[i].cycles = 0;
2446 }
2447#endif
2448}
2449
2450/*
2451** Prepare a virtual machine for execution for the first time after
2452** creating the virtual machine. This involves things such
drh7abda852014-09-19 16:02:06 +00002453** as allocating registers and initializing the program counter.
drh124c0b42011-06-01 18:15:55 +00002454** After the VDBE has be prepped, it can be executed by one or more
2455** calls to sqlite3VdbeExec().
2456**
peter.d.reid60ec9142014-09-06 16:39:46 +00002457** This function may be called exactly once on each virtual machine.
drh124c0b42011-06-01 18:15:55 +00002458** After this routine is called the VM has been "packaged" and is ready
peter.d.reid60ec9142014-09-06 16:39:46 +00002459** to run. After this routine is called, further calls to
drh124c0b42011-06-01 18:15:55 +00002460** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
2461** the Vdbe from the Parse object that helped generate it so that the
2462** the Vdbe becomes an independent entity and the Parse object can be
2463** destroyed.
2464**
2465** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
2466** to its initial state after it has been run.
2467*/
2468void sqlite3VdbeMakeReady(
2469 Vdbe *p, /* The VDBE */
2470 Parse *pParse /* Parsing context */
2471){
2472 sqlite3 *db; /* The database connection */
2473 int nVar; /* Number of parameters */
2474 int nMem; /* Number of VM memory registers */
2475 int nCursor; /* Number of cursors required */
2476 int nArg; /* Number of arguments in subprograms */
2477 int n; /* Loop counter */
drha7dc4a32016-01-25 02:15:02 +00002478 struct ReusableSpace x; /* Reusable bulk memory */
drh124c0b42011-06-01 18:15:55 +00002479
2480 assert( p!=0 );
2481 assert( p->nOp>0 );
2482 assert( pParse!=0 );
drh66181ce2022-03-31 20:04:49 +00002483 assert( p->eVdbeState==VDBE_INIT_STATE );
drh73d5b8f2013-12-23 19:09:07 +00002484 assert( pParse==p->pParse );
drhe2b0a122021-01-01 17:01:33 +00002485 p->pVList = pParse->pVList;
2486 pParse->pVList = 0;
drh124c0b42011-06-01 18:15:55 +00002487 db = p->db;
2488 assert( db->mallocFailed==0 );
2489 nVar = pParse->nVar;
2490 nMem = pParse->nMem;
2491 nCursor = pParse->nTab;
2492 nArg = pParse->nMaxArg;
2493
drh3cdce922016-03-21 00:30:40 +00002494 /* Each cursor uses a memory cell. The first cursor (cursor 0) can
2495 ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
2496 ** space at the end of aMem[] for cursors 1 and greater.
danielk1977cd3e8f72008-03-25 09:47:35 +00002497 ** See also: allocateCursor().
2498 */
2499 nMem += nCursor;
drh9f6168b2016-03-19 23:32:58 +00002500 if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
danielk1977cd3e8f72008-03-25 09:47:35 +00002501
drha7dc4a32016-01-25 02:15:02 +00002502 /* Figure out how much reusable memory is available at the end of the
2503 ** opcode array. This extra memory will be reallocated for other elements
2504 ** of the prepared statement.
drh9a324642003-09-06 20:12:01 +00002505 */
drhcf6e3fd2022-04-01 18:45:11 +00002506 n = ROUND8P(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
drha7dc4a32016-01-25 02:15:02 +00002507 x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
2508 assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
2509 x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
2510 assert( x.nFree>=0 );
drh2a1df932016-09-30 17:46:44 +00002511 assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
drh19875c82009-12-08 19:58:19 +00002512
drh124c0b42011-06-01 18:15:55 +00002513 resolveP2Values(p, &nArg);
2514 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
drhf3ce2482019-10-09 01:19:07 +00002515 if( pParse->explain ){
2516 static const char * const azColName[] = {
2517 "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
2518 "id", "parent", "notused", "detail"
2519 };
2520 int iFirst, mx, i;
2521 if( nMem<10 ) nMem = 10;
drh62b6e1d2020-03-21 14:22:27 +00002522 p->explain = pParse->explain;
drhf3ce2482019-10-09 01:19:07 +00002523 if( pParse->explain==2 ){
2524 sqlite3VdbeSetNumCols(p, 4);
2525 iFirst = 8;
2526 mx = 12;
2527 }else{
2528 sqlite3VdbeSetNumCols(p, 8);
2529 iFirst = 0;
2530 mx = 8;
2531 }
2532 for(i=iFirst; i<mx; i++){
2533 sqlite3VdbeSetColName(p, i-iFirst, COLNAME_NAME,
2534 azColName[i], SQLITE_STATIC);
2535 }
drh124c0b42011-06-01 18:15:55 +00002536 }
drhaab910c2011-06-27 00:01:22 +00002537 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00002538
drha7dc4a32016-01-25 02:15:02 +00002539 /* Memory for registers, parameters, cursor, etc, is allocated in one or two
2540 ** passes. On the first pass, we try to reuse unused memory at the
drh124c0b42011-06-01 18:15:55 +00002541 ** end of the opcode array. If we are unable to satisfy all memory
2542 ** requirements by reusing the opcode array tail, then the second
drha7dc4a32016-01-25 02:15:02 +00002543 ** pass will fill in the remainder using a fresh memory allocation.
drh124c0b42011-06-01 18:15:55 +00002544 **
2545 ** This two-pass approach that reuses as much memory as possible from
drha7dc4a32016-01-25 02:15:02 +00002546 ** the leftover memory at the end of the opcode array. This can significantly
drh124c0b42011-06-01 18:15:55 +00002547 ** reduce the amount of memory held by a prepared statement.
2548 */
drh81f91592018-12-28 20:48:07 +00002549 x.nNeeded = 0;
2550 p->aMem = allocSpace(&x, 0, nMem*sizeof(Mem));
2551 p->aVar = allocSpace(&x, 0, nVar*sizeof(Mem));
2552 p->apArg = allocSpace(&x, 0, nArg*sizeof(Mem*));
2553 p->apCsr = allocSpace(&x, 0, nCursor*sizeof(VdbeCursor*));
dane2f771b2014-11-03 15:33:17 +00002554#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drh81f91592018-12-28 20:48:07 +00002555 p->anExec = allocSpace(&x, 0, p->nOp*sizeof(i64));
dane2f771b2014-11-03 15:33:17 +00002556#endif
drh81f91592018-12-28 20:48:07 +00002557 if( x.nNeeded ){
drh2a1df932016-09-30 17:46:44 +00002558 x.pSpace = p->pFree = sqlite3DbMallocRawNN(db, x.nNeeded);
drha7dc4a32016-01-25 02:15:02 +00002559 x.nFree = x.nNeeded;
drh81f91592018-12-28 20:48:07 +00002560 if( !db->mallocFailed ){
2561 p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
2562 p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
2563 p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
2564 p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
2565#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2566 p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
2567#endif
2568 }
2569 }
drhb2771ce2009-02-20 01:28:59 +00002570
drhab3182f2016-10-01 00:37:50 +00002571 if( db->mallocFailed ){
2572 p->nVar = 0;
2573 p->nCursor = 0;
2574 p->nMem = 0;
2575 }else{
drh2a1df932016-09-30 17:46:44 +00002576 p->nCursor = nCursor;
2577 p->nVar = (ynVar)nVar;
2578 initMemArray(p->aVar, nVar, db, MEM_Null);
2579 p->nMem = nMem;
2580 initMemArray(p->aMem, nMem, db, MEM_Undefined);
drh2a1df932016-09-30 17:46:44 +00002581 memset(p->apCsr, 0, nCursor*sizeof(VdbeCursor*));
2582#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2583 memset(p->anExec, 0, p->nOp*sizeof(i64));
2584#endif
2585 }
drh124c0b42011-06-01 18:15:55 +00002586 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00002587}
2588
drh9a324642003-09-06 20:12:01 +00002589/*
danielk1977cd3e8f72008-03-25 09:47:35 +00002590** Close a VDBE cursor and release all the resources that cursor
2591** happens to hold.
drh9a324642003-09-06 20:12:01 +00002592*/
drhdfe88ec2008-11-03 20:55:06 +00002593void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh473571b2022-04-01 18:19:04 +00002594 if( pCx ) sqlite3VdbeFreeCursorNN(p,pCx);
2595}
2596void sqlite3VdbeFreeCursorNN(Vdbe *p, VdbeCursor *pCx){
drhc960dcb2015-11-20 19:22:01 +00002597 switch( pCx->eCurType ){
2598 case CURTYPE_SORTER: {
2599 sqlite3VdbeSorterClose(p->db, pCx);
2600 break;
2601 }
2602 case CURTYPE_BTREE: {
daneeee8a52021-03-18 14:31:37 +00002603 assert( pCx->uc.pCursor!=0 );
2604 sqlite3BtreeCloseCursor(pCx->uc.pCursor);
drhc960dcb2015-11-20 19:22:01 +00002605 break;
2606 }
drh9eff6162006-06-12 21:59:13 +00002607#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00002608 case CURTYPE_VTAB: {
2609 sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
2610 const sqlite3_module *pModule = pVCur->pVtab->pModule;
2611 assert( pVCur->pVtab->nRef>0 );
2612 pVCur->pVtab->nRef--;
2613 pModule->xClose(pVCur);
2614 break;
2615 }
drh9eff6162006-06-12 21:59:13 +00002616#endif
drhc960dcb2015-11-20 19:22:01 +00002617 }
drh9a324642003-09-06 20:12:01 +00002618}
2619
dan65a7cd12009-09-01 12:16:01 +00002620/*
drhab4e7f32015-04-16 18:11:50 +00002621** Close all cursors in the current frame.
2622*/
2623static void closeCursorsInFrame(Vdbe *p){
drh17c48652022-04-01 17:01:57 +00002624 int i;
2625 for(i=0; i<p->nCursor; i++){
2626 VdbeCursor *pC = p->apCsr[i];
2627 if( pC ){
drh473571b2022-04-01 18:19:04 +00002628 sqlite3VdbeFreeCursorNN(p, pC);
drh17c48652022-04-01 17:01:57 +00002629 p->apCsr[i] = 0;
drhab4e7f32015-04-16 18:11:50 +00002630 }
2631 }
2632}
2633
2634/*
dan65a7cd12009-09-01 12:16:01 +00002635** Copy the values stored in the VdbeFrame structure to its Vdbe. This
2636** is used, for example, when a trigger sub-program is halted to restore
2637** control to the main program.
2638*/
dan165921a2009-08-28 18:53:45 +00002639int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
2640 Vdbe *v = pFrame->v;
drhab4e7f32015-04-16 18:11:50 +00002641 closeCursorsInFrame(v);
dane2f771b2014-11-03 15:33:17 +00002642#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan43764a82014-11-01 21:00:04 +00002643 v->anExec = pFrame->anExec;
dane2f771b2014-11-03 15:33:17 +00002644#endif
dan165921a2009-08-28 18:53:45 +00002645 v->aOp = pFrame->aOp;
2646 v->nOp = pFrame->nOp;
2647 v->aMem = pFrame->aMem;
2648 v->nMem = pFrame->nMem;
2649 v->apCsr = pFrame->apCsr;
2650 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00002651 v->db->lastRowid = pFrame->lastRowid;
2652 v->nChange = pFrame->nChange;
danc3da6672014-10-28 18:24:16 +00002653 v->db->nChange = pFrame->nDbChange;
drhb9626cf2016-02-22 16:04:31 +00002654 sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
dan32001322016-02-19 18:54:29 +00002655 v->pAuxData = pFrame->pAuxData;
2656 pFrame->pAuxData = 0;
dan165921a2009-08-28 18:53:45 +00002657 return pFrame->pc;
2658}
2659
drh9a324642003-09-06 20:12:01 +00002660/*
drh5f82e3c2009-07-06 00:44:08 +00002661** Close all cursors.
dan165921a2009-08-28 18:53:45 +00002662**
2663** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
2664** cell array. This is necessary as the memory cell array may contain
2665** pointers to VdbeFrame objects, which may in turn contain pointers to
2666** open cursors.
drh9a324642003-09-06 20:12:01 +00002667*/
drh5f82e3c2009-07-06 00:44:08 +00002668static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00002669 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00002670 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00002671 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
2672 sqlite3VdbeFrameRestore(pFrame);
drhf526dca2014-10-13 17:42:05 +00002673 p->pFrame = 0;
2674 p->nFrame = 0;
dan165921a2009-08-28 18:53:45 +00002675 }
drhf526dca2014-10-13 17:42:05 +00002676 assert( p->nFrame==0 );
drhab4e7f32015-04-16 18:11:50 +00002677 closeCursorsInFrame(p);
drh99a21822022-03-31 21:15:09 +00002678 releaseMemArray(p->aMem, p->nMem);
dan27106572010-12-01 08:04:47 +00002679 while( p->pDelFrame ){
2680 VdbeFrame *pDel = p->pDelFrame;
2681 p->pDelFrame = pDel->pParent;
2682 sqlite3VdbeFrameDelete(pDel);
2683 }
dan0c547792013-07-18 17:12:08 +00002684
2685 /* Delete any auxdata allocations made by the VM */
drhb9626cf2016-02-22 16:04:31 +00002686 if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
dan0c547792013-07-18 17:12:08 +00002687 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00002688}
2689
2690/*
danielk197722322fd2004-05-25 23:35:17 +00002691** Set the number of result columns that will be returned by this SQL
2692** statement. This is now set at compile time, rather than during
2693** execution of the vdbe program so that sqlite3_column_count() can
2694** be called on an SQL statement before sqlite3_step().
2695*/
2696void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00002697 int n;
drh633e6d52008-07-28 19:34:53 +00002698 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002699
drhb8a12902017-05-31 11:24:13 +00002700 if( p->nResColumn ){
2701 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
2702 sqlite3DbFree(db, p->aColName);
2703 }
danielk1977955de522006-02-10 02:27:42 +00002704 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00002705 p->nResColumn = (u16)nResColumn;
drhb8a12902017-05-31 11:24:13 +00002706 p->aColName = (Mem*)sqlite3DbMallocRawNN(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00002707 if( p->aColName==0 ) return;
drhb8a12902017-05-31 11:24:13 +00002708 initMemArray(p->aColName, n, db, MEM_Null);
danielk197722322fd2004-05-25 23:35:17 +00002709}
2710
2711/*
danielk19773cf86062004-05-26 10:11:05 +00002712** Set the name of the idx'th column to be returned by the SQL statement.
2713** zName must be a pointer to a nul terminated string.
2714**
2715** This call must be made after a call to sqlite3VdbeSetNumCols().
2716**
danielk197710fb7492008-10-31 10:53:22 +00002717** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
2718** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
2719** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00002720*/
danielk197710fb7492008-10-31 10:53:22 +00002721int sqlite3VdbeSetColName(
2722 Vdbe *p, /* Vdbe being configured */
2723 int idx, /* Index of column zName applies to */
2724 int var, /* One of the COLNAME_* constants */
2725 const char *zName, /* Pointer to buffer containing name */
2726 void (*xDel)(void*) /* Memory management strategy for zName */
2727){
danielk19773cf86062004-05-26 10:11:05 +00002728 int rc;
2729 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00002730 assert( idx<p->nResColumn );
2731 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00002732 if( p->db->mallocFailed ){
2733 assert( !zName || xDel!=SQLITE_DYNAMIC );
mistachkinfad30392016-02-13 23:43:46 +00002734 return SQLITE_NOMEM_BKPT;
danielk197710fb7492008-10-31 10:53:22 +00002735 }
drh76ff3a02004-09-24 22:32:30 +00002736 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00002737 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00002738 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00002739 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00002740 return rc;
2741}
2742
danielk197713adf8a2004-06-03 16:08:41 +00002743/*
2744** A read or write transaction may or may not be active on database handle
2745** db. If a transaction is active, commit it. If there is a
2746** write-transaction spanning more than one database file, this routine
drhccb21132020-06-19 11:34:57 +00002747** takes care of the super-journal trickery.
danielk197713adf8a2004-06-03 16:08:41 +00002748*/
danielk19773e3a84d2008-08-01 17:37:40 +00002749static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00002750 int i;
drh8e6cf0a2016-02-22 14:57:38 +00002751 int nTrans = 0; /* Number of databases with an active write-transaction
2752 ** that are candidates for a two-phase commit using a
drhccb21132020-06-19 11:34:57 +00002753 ** super-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002754 int rc = SQLITE_OK;
2755 int needXcommit = 0;
2756
shane36840fd2009-06-26 16:32:13 +00002757#ifdef SQLITE_OMIT_VIRTUALTABLE
2758 /* With this option, sqlite3VtabSync() is defined to be simply
2759 ** SQLITE_OK so p is not used.
2760 */
2761 UNUSED_PARAMETER(p);
2762#endif
2763
danielk19775bd270b2006-07-25 15:14:52 +00002764 /* Before doing anything else, call the xSync() callback for any
2765 ** virtual module tables written in this transaction. This has to
drhccb21132020-06-19 11:34:57 +00002766 ** be done before determining whether a super-journal file is
danielk19775bd270b2006-07-25 15:14:52 +00002767 ** required, as an xSync() callback may add an attached database
2768 ** to the transaction.
2769 */
dan016f7812013-08-21 17:35:48 +00002770 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00002771
2772 /* This loop determines (a) if the commit hook should be invoked and
2773 ** (b) how many database files have open write transactions, not
2774 ** including the temp database. (b) is important because if more than
drhccb21132020-06-19 11:34:57 +00002775 ** one database file has an open write transaction, a super-journal
danielk19775bd270b2006-07-25 15:14:52 +00002776 ** file is required for an atomic commit.
2777 */
drhabfb62f2010-07-30 11:20:35 +00002778 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002779 Btree *pBt = db->aDb[i].pBt;
drh99744fa2020-08-25 19:09:07 +00002780 if( sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
drhccb21132020-06-19 11:34:57 +00002781 /* Whether or not a database might need a super-journal depends upon
drh8e6cf0a2016-02-22 14:57:38 +00002782 ** its journal mode (among other things). This matrix determines which
drhccb21132020-06-19 11:34:57 +00002783 ** journal modes use a super-journal and which do not */
drh8e6cf0a2016-02-22 14:57:38 +00002784 static const u8 aMJNeeded[] = {
2785 /* DELETE */ 1,
2786 /* PERSIST */ 1,
2787 /* OFF */ 0,
2788 /* TRUNCATE */ 1,
2789 /* MEMORY */ 0,
2790 /* WAL */ 0
2791 };
2792 Pager *pPager; /* Pager associated with pBt */
danielk197713adf8a2004-06-03 16:08:41 +00002793 needXcommit = 1;
dan6b9bb592012-10-05 19:43:02 +00002794 sqlite3BtreeEnter(pBt);
drh8e6cf0a2016-02-22 14:57:38 +00002795 pPager = sqlite3BtreePager(pBt);
2796 if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
2797 && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
dan6cbc5072017-11-17 08:20:10 +00002798 && sqlite3PagerIsMemdb(pPager)==0
drh8e6cf0a2016-02-22 14:57:38 +00002799 ){
2800 assert( i!=1 );
2801 nTrans++;
2802 }
dan7b3d71e2015-08-19 20:27:05 +00002803 rc = sqlite3BtreeExclusiveLock(pBt);
dan6b9bb592012-10-05 19:43:02 +00002804 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00002805 }
2806 }
dan3d394342015-07-27 19:31:45 +00002807
drh01be4632015-09-03 15:17:12 +00002808#ifndef SQLITE_OMIT_CONCURRENT
dand05cc8f2020-07-16 20:57:35 +00002809 if( db->eConcurrent && (rc & 0xFF)==SQLITE_BUSY ){
dan3d394342015-07-27 19:31:45 +00002810 /* An SQLITE_BUSY or SQLITE_BUSY_SNAPSHOT was encountered while
2811 ** attempting to take the WRITER lock on a wal file. Release the
2812 ** WRITER locks on all wal files and return early. */
2813 for(i=0; i<db->nDb; i++){
2814 Btree *pBt = db->aDb[i].pBt;
dan74154a72020-11-26 18:41:08 +00002815 if( sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
dan3d394342015-07-27 19:31:45 +00002816 sqlite3BtreeEnter(pBt);
2817 sqlite3PagerDropExclusiveLock(sqlite3BtreePager(pBt));
2818 sqlite3BtreeLeave(pBt);
2819 }
2820 }
2821 }
dan04085292015-08-24 16:00:08 +00002822#endif
dan3d394342015-07-27 19:31:45 +00002823
drhabfb62f2010-07-30 11:20:35 +00002824 if( rc!=SQLITE_OK ){
2825 return rc;
2826 }
danielk197713adf8a2004-06-03 16:08:41 +00002827
2828 /* If there are any write-transactions at all, invoke the commit hook */
2829 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00002830 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00002831 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002832 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00002833 }
2834 }
2835
danielk197740b38dc2004-06-26 08:38:24 +00002836 /* The simple case - no more than one database file (not counting the
2837 ** TEMP database) has a transaction active. There is no need for the
drhccb21132020-06-19 11:34:57 +00002838 ** super-journal.
drhc9e06862004-06-09 20:03:08 +00002839 **
danielk197740b38dc2004-06-26 08:38:24 +00002840 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00002841 ** string, it means the main database is :memory: or a temp file. In
2842 ** that case we do not support atomic multi-file commits, so use the
2843 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00002844 */
drhea678832008-12-10 19:26:22 +00002845 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
2846 || nTrans<=1
2847 ){
danielk197704103022009-02-03 16:51:24 +00002848 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002849 Btree *pBt = db->aDb[i].pBt;
2850 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002851 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00002852 }
2853 }
2854
drh80e35f42007-03-30 14:06:34 +00002855 /* Do the commit only if all databases successfully complete phase 1.
2856 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
2857 ** IO error while deleting or truncating a journal file. It is unlikely,
2858 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00002859 */
2860 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
2861 Btree *pBt = db->aDb[i].pBt;
2862 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002863 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00002864 }
danielk1977979f38e2007-03-27 16:19:51 +00002865 }
2866 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00002867 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002868 }
2869 }
2870
2871 /* The complex case - There is a multi-file write-transaction active.
drhccb21132020-06-19 11:34:57 +00002872 ** This requires a super-journal file to ensure the transaction is
peter.d.reid60ec9142014-09-06 16:39:46 +00002873 ** committed atomically.
danielk197713adf8a2004-06-03 16:08:41 +00002874 */
danielk197744ee5bf2005-05-27 09:41:12 +00002875#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00002876 else{
danielk1977b4b47412007-08-17 15:53:36 +00002877 sqlite3_vfs *pVfs = db->pVfs;
drhccb21132020-06-19 11:34:57 +00002878 char *zSuper = 0; /* File-name for the super-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002879 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
drh067b92b2020-06-19 15:24:12 +00002880 sqlite3_file *pSuperJrnl = 0;
danielk197762079062007-08-15 17:08:46 +00002881 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00002882 int res;
drhf5808602011-12-16 00:33:04 +00002883 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00002884 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00002885
drhccb21132020-06-19 11:34:57 +00002886 /* Select a super-journal file name */
drh5c531a42011-12-16 01:21:31 +00002887 nMainFile = sqlite3Strlen30(zMainFile);
drhccb21132020-06-19 11:34:57 +00002888 zSuper = sqlite3MPrintf(db, "%.4c%s%.16c", 0,zMainFile,0);
2889 if( zSuper==0 ) return SQLITE_NOMEM_BKPT;
2890 zSuper += 4;
danielk197713adf8a2004-06-03 16:08:41 +00002891 do {
drhdc5ea5c2008-12-10 17:19:59 +00002892 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00002893 if( retryCount ){
2894 if( retryCount>100 ){
drhccb21132020-06-19 11:34:57 +00002895 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zSuper);
2896 sqlite3OsDelete(pVfs, zSuper, 0);
drh84968c02011-12-16 15:11:39 +00002897 break;
2898 }else if( retryCount==1 ){
drhccb21132020-06-19 11:34:57 +00002899 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zSuper);
drh84968c02011-12-16 15:11:39 +00002900 }
danielk197713adf8a2004-06-03 16:08:41 +00002901 }
drh84968c02011-12-16 15:11:39 +00002902 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00002903 sqlite3_randomness(sizeof(iRandom), &iRandom);
drhccb21132020-06-19 11:34:57 +00002904 sqlite3_snprintf(13, &zSuper[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00002905 (iRandom>>8)&0xffffff, iRandom&0xff);
drhccb21132020-06-19 11:34:57 +00002906 /* The antipenultimate character of the super-journal name must
drhf5808602011-12-16 00:33:04 +00002907 ** be "9" to avoid name collisions when using 8+3 filenames. */
drhccb21132020-06-19 11:34:57 +00002908 assert( zSuper[sqlite3Strlen30(zSuper)-3]=='9' );
2909 sqlite3FileSuffix3(zMainFile, zSuper);
2910 rc = sqlite3OsAccess(pVfs, zSuper, SQLITE_ACCESS_EXISTS, &res);
danielk1977861f7452008-06-05 11:39:11 +00002911 }while( rc==SQLITE_OK && res );
2912 if( rc==SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00002913 /* Open the super-journal. */
drh067b92b2020-06-19 15:24:12 +00002914 rc = sqlite3OsOpenMalloc(pVfs, zSuper, &pSuperJrnl,
drh19db9352008-03-27 22:42:51 +00002915 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
drh067b92b2020-06-19 15:24:12 +00002916 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_SUPER_JOURNAL, 0
drh19db9352008-03-27 22:42:51 +00002917 );
2918 }
danielk197713adf8a2004-06-03 16:08:41 +00002919 if( rc!=SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00002920 sqlite3DbFree(db, zSuper-4);
danielk197713adf8a2004-06-03 16:08:41 +00002921 return rc;
2922 }
2923
2924 /* Write the name of each database file in the transaction into the new
drhccb21132020-06-19 11:34:57 +00002925 ** super-journal file. If an error occurs at this point close
2926 ** and delete the super-journal file. All the individual journal files
2927 ** still have 'null' as the super-journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00002928 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00002929 */
danielk19771e536952007-08-16 10:09:01 +00002930 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002931 Btree *pBt = db->aDb[i].pBt;
drh99744fa2020-08-25 19:09:07 +00002932 if( sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
danielk19775865e3d2004-06-14 06:03:57 +00002933 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00002934 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00002935 continue; /* Ignore TEMP and :memory: databases */
2936 }
drh8c96a6e2010-08-31 01:09:15 +00002937 assert( zFile[0]!=0 );
drh067b92b2020-06-19 15:24:12 +00002938 rc = sqlite3OsWrite(pSuperJrnl, zFile, sqlite3Strlen30(zFile)+1,offset);
drhea678832008-12-10 19:26:22 +00002939 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00002940 if( rc!=SQLITE_OK ){
drh067b92b2020-06-19 15:24:12 +00002941 sqlite3OsCloseFree(pSuperJrnl);
drhccb21132020-06-19 11:34:57 +00002942 sqlite3OsDelete(pVfs, zSuper, 0);
2943 sqlite3DbFree(db, zSuper-4);
danielk197713adf8a2004-06-03 16:08:41 +00002944 return rc;
2945 }
2946 }
2947 }
2948
drhccb21132020-06-19 11:34:57 +00002949 /* Sync the super-journal file. If the IOCAP_SEQUENTIAL device
danielk19779663b8f2007-08-24 11:52:28 +00002950 ** flag is set this is not required.
2951 */
drh067b92b2020-06-19 15:24:12 +00002952 if( 0==(sqlite3OsDeviceCharacteristics(pSuperJrnl)&SQLITE_IOCAP_SEQUENTIAL)
2953 && SQLITE_OK!=(rc = sqlite3OsSync(pSuperJrnl, SQLITE_SYNC_NORMAL))
danielk1977bea2a942009-01-20 17:06:27 +00002954 ){
drh067b92b2020-06-19 15:24:12 +00002955 sqlite3OsCloseFree(pSuperJrnl);
drhccb21132020-06-19 11:34:57 +00002956 sqlite3OsDelete(pVfs, zSuper, 0);
2957 sqlite3DbFree(db, zSuper-4);
danielk19775865e3d2004-06-14 06:03:57 +00002958 return rc;
2959 }
drhc9e06862004-06-09 20:03:08 +00002960
danielk197713adf8a2004-06-03 16:08:41 +00002961 /* Sync all the db files involved in the transaction. The same call
drhccb21132020-06-19 11:34:57 +00002962 ** sets the super-journal pointer in each individual journal. If
2963 ** an error occurs here, do not delete the super-journal file.
danielk197713adf8a2004-06-03 16:08:41 +00002964 **
drh80e35f42007-03-30 14:06:34 +00002965 ** If the error occurs during the first call to
2966 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
drhccb21132020-06-19 11:34:57 +00002967 ** super-journal file will be orphaned. But we cannot delete it,
2968 ** in case the super-journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00002969 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00002970 */
danielk19775bd270b2006-07-25 15:14:52 +00002971 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002972 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00002973 if( pBt ){
drhccb21132020-06-19 11:34:57 +00002974 rc = sqlite3BtreeCommitPhaseOne(pBt, zSuper);
danielk197713adf8a2004-06-03 16:08:41 +00002975 }
2976 }
drh067b92b2020-06-19 15:24:12 +00002977 sqlite3OsCloseFree(pSuperJrnl);
drhabfb62f2010-07-30 11:20:35 +00002978 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00002979 if( rc!=SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00002980 sqlite3DbFree(db, zSuper-4);
danielk19775bd270b2006-07-25 15:14:52 +00002981 return rc;
2982 }
danielk197713adf8a2004-06-03 16:08:41 +00002983
drhccb21132020-06-19 11:34:57 +00002984 /* Delete the super-journal file. This commits the transaction. After
danielk1977962398d2004-06-14 09:35:16 +00002985 ** doing this the directory is synced again before any individual
2986 ** transaction files are deleted.
2987 */
drhccb21132020-06-19 11:34:57 +00002988 rc = sqlite3OsDelete(pVfs, zSuper, 1);
2989 sqlite3DbFree(db, zSuper-4);
2990 zSuper = 0;
drh29a01382006-08-13 19:04:18 +00002991 if( rc ){
2992 return rc;
2993 }
danielk197713adf8a2004-06-03 16:08:41 +00002994
2995 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00002996 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
2997 ** deleting or truncating journals. If something goes wrong while
2998 ** this is happening we don't really care. The integrity of the
2999 ** transaction is already guaranteed, but some stray 'cold' journals
3000 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00003001 */
danielk1977979f38e2007-03-27 16:19:51 +00003002 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00003003 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00003004 for(i=0; i<db->nDb; i++){
3005 Btree *pBt = db->aDb[i].pBt;
3006 if( pBt ){
dan60939d02011-03-29 15:40:55 +00003007 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00003008 }
3009 }
danielk19772d1d86f2008-06-20 14:59:51 +00003010 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00003011 enable_simulated_io_errors();
3012
danielk1977f9e7dda2006-06-16 16:08:53 +00003013 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00003014 }
danielk197744ee5bf2005-05-27 09:41:12 +00003015#endif
danielk1977026d2702004-06-14 13:14:59 +00003016
drh2ac3ee92004-06-07 16:27:46 +00003017 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00003018}
3019
danielk19771d850a72004-05-31 08:26:49 +00003020/*
drh4f7d3a52013-06-27 23:54:02 +00003021** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00003022** matches the number of vdbe's in the list sqlite3.pVdbe that are
3023** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00003024** This is an internal self-check only - it is not an essential processing
3025** step.
danielk19771d850a72004-05-31 08:26:49 +00003026**
3027** This is a no-op if NDEBUG is defined.
3028*/
3029#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00003030static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00003031 Vdbe *p;
3032 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00003033 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00003034 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00003035 p = db->pVdbe;
3036 while( p ){
dan857745c2014-07-19 17:57:10 +00003037 if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
danielk19771d850a72004-05-31 08:26:49 +00003038 cnt++;
drhad4a4b82008-11-05 16:37:34 +00003039 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00003040 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00003041 }
drhe5928b12022-08-23 20:11:01 +00003042 p = p->pVNext;
danielk19771d850a72004-05-31 08:26:49 +00003043 }
drh4f7d3a52013-06-27 23:54:02 +00003044 assert( cnt==db->nVdbeActive );
3045 assert( nWrite==db->nVdbeWrite );
3046 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00003047}
3048#else
3049#define checkActiveVdbeCnt(x)
3050#endif
3051
danielk19773cf86062004-05-26 10:11:05 +00003052/*
danielk1977bd434552009-03-18 10:33:00 +00003053** If the Vdbe passed as the first argument opened a statement-transaction,
3054** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
3055** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
3056** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00003057** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00003058**
3059** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
3060** Otherwise SQLITE_OK.
3061*/
drhd0840642017-01-26 17:11:18 +00003062static SQLITE_NOINLINE int vdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00003063 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00003064 int rc = SQLITE_OK;
drhd0840642017-01-26 17:11:18 +00003065 int i;
3066 const int iSavepoint = p->iStatement-1;
danielk1977ecaecf92009-07-08 08:05:35 +00003067
drhd0840642017-01-26 17:11:18 +00003068 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
3069 assert( db->nStatement>0 );
3070 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
danielk1977bd434552009-03-18 10:33:00 +00003071
drhd0840642017-01-26 17:11:18 +00003072 for(i=0; i<db->nDb; i++){
3073 int rc2 = SQLITE_OK;
3074 Btree *pBt = db->aDb[i].pBt;
3075 if( pBt ){
dana311b802011-04-26 19:21:34 +00003076 if( eOp==SAVEPOINT_ROLLBACK ){
drhd0840642017-01-26 17:11:18 +00003077 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
3078 }
3079 if( rc2==SQLITE_OK ){
3080 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
dana311b802011-04-26 19:21:34 +00003081 }
3082 if( rc==SQLITE_OK ){
drhd0840642017-01-26 17:11:18 +00003083 rc = rc2;
dana311b802011-04-26 19:21:34 +00003084 }
3085 }
drhd0840642017-01-26 17:11:18 +00003086 }
3087 db->nStatement--;
3088 p->iStatement = 0;
dana311b802011-04-26 19:21:34 +00003089
drhd0840642017-01-26 17:11:18 +00003090 if( rc==SQLITE_OK ){
dan1da40a32009-09-19 17:00:31 +00003091 if( eOp==SAVEPOINT_ROLLBACK ){
drhd0840642017-01-26 17:11:18 +00003092 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
dan1da40a32009-09-19 17:00:31 +00003093 }
drhd0840642017-01-26 17:11:18 +00003094 if( rc==SQLITE_OK ){
3095 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
3096 }
3097 }
3098
3099 /* If the statement transaction is being rolled back, also restore the
3100 ** database handles deferred constraint counter to the value it had when
3101 ** the statement transaction was opened. */
3102 if( eOp==SAVEPOINT_ROLLBACK ){
3103 db->nDeferredCons = p->nStmtDefCons;
3104 db->nDeferredImmCons = p->nStmtDefImmCons;
danielk1977bd434552009-03-18 10:33:00 +00003105 }
3106 return rc;
3107}
drhd0840642017-01-26 17:11:18 +00003108int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
3109 if( p->db->nStatement && p->iStatement ){
3110 return vdbeCloseStatement(p, eOp);
3111 }
3112 return SQLITE_OK;
3113}
3114
danielk1977bd434552009-03-18 10:33:00 +00003115
3116/*
dan1da40a32009-09-19 17:00:31 +00003117** This function is called when a transaction opened by the database
3118** handle associated with the VM passed as an argument is about to be
3119** committed. If there are outstanding deferred foreign key constraint
3120** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
3121**
3122** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00003123** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
3124** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00003125*/
3126#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00003127int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00003128 sqlite3 *db = p->db;
drh648e2642013-07-11 15:03:32 +00003129 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
3130 || (!deferred && p->nFkConstraint>0)
3131 ){
drhd91c1a12013-02-09 13:58:25 +00003132 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00003133 p->errorAction = OE_Abort;
drh22c17b82015-05-15 04:13:15 +00003134 sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
drh89cf9582022-03-31 11:12:56 +00003135 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)==0 ) return SQLITE_ERROR;
drh90402d42022-03-14 16:54:05 +00003136 return SQLITE_CONSTRAINT_FOREIGNKEY;
dan1da40a32009-09-19 17:00:31 +00003137 }
3138 return SQLITE_OK;
3139}
3140#endif
3141
3142/*
drh92f02c32004-09-02 14:57:08 +00003143** This routine is called the when a VDBE tries to halt. If the VDBE
3144** has made changes and is in autocommit mode, then commit those
3145** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00003146**
drh687d74d2021-08-09 13:06:59 +00003147** This routine is the only way to move the sqlite3eOpenState of a VM from
3148** SQLITE_STATE_RUN to SQLITE_STATE_HALT. It is harmless to
3149** call this on a VM that is in the SQLITE_STATE_HALT state.
drh92f02c32004-09-02 14:57:08 +00003150**
3151** Return an error code. If the commit could not complete because of
3152** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
3153** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00003154*/
drhff0587c2007-08-29 17:43:19 +00003155int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00003156 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00003157 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00003158
3159 /* This function contains the logic that determines if a statement or
3160 ** transaction will be committed or rolled back as a result of the
3161 ** execution of this virtual machine.
3162 **
drh71b890a2007-10-03 15:30:52 +00003163 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00003164 **
drh71b890a2007-10-03 15:30:52 +00003165 ** SQLITE_NOMEM
3166 ** SQLITE_IOERR
3167 ** SQLITE_FULL
3168 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00003169 **
drh71b890a2007-10-03 15:30:52 +00003170 ** Then the internal cache might have been left in an inconsistent
3171 ** state. We need to rollback the statement transaction, if there is
3172 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00003173 */
drh9a324642003-09-06 20:12:01 +00003174
drh8703edd2022-04-03 22:35:13 +00003175 assert( p->eVdbeState==VDBE_RUN_STATE );
drhb84e5742016-02-05 02:42:54 +00003176 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00003177 p->rc = SQLITE_NOMEM_BKPT;
danielk1977261919c2005-12-06 12:52:59 +00003178 }
drh5f82e3c2009-07-06 00:44:08 +00003179 closeAllCursors(p);
danielk19771d850a72004-05-31 08:26:49 +00003180 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00003181
danc0537fe2013-06-28 19:41:43 +00003182 /* No commit or rollback needed if the program never started or if the
3183 ** SQL statement does not read or write a database file. */
drh99a21822022-03-31 21:15:09 +00003184 if( p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00003185 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00003186 int eStatementOp = 0;
3187 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00003188
3189 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00003190 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00003191
drh71b890a2007-10-03 15:30:52 +00003192 /* Check for one of the special errors */
drh3ce76a02021-11-15 18:50:02 +00003193 if( p->rc ){
3194 mrc = p->rc & 0xff;
3195 isSpecialError = mrc==SQLITE_NOMEM
3196 || mrc==SQLITE_IOERR
3197 || mrc==SQLITE_INTERRUPT
3198 || mrc==SQLITE_FULL;
3199 }else{
3200 mrc = isSpecialError = 0;
3201 }
danielk197707cb5602006-01-20 10:55:05 +00003202 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00003203 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
3204 ** no rollback is necessary. Otherwise, at least a savepoint
3205 ** transaction must be rolled back to restore the database to a
3206 ** consistent state.
3207 **
3208 ** Even if the statement is read-only, it is important to perform
3209 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00003210 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00003211 ** file as part of an effort to free up cache space (see function
3212 ** pagerStress() in pager.c), the rollback is required to restore
3213 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00003214 */
drhad4a4b82008-11-05 16:37:34 +00003215 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00003216 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00003217 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00003218 }else{
3219 /* We are forced to roll back the active transaction. Before doing
3220 ** so, abort any other statements this handle currently has active.
3221 */
drh21021a52012-02-13 17:01:51 +00003222 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00003223 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00003224 db->autoCommit = 1;
dand05cc8f2020-07-16 20:57:35 +00003225 db->eConcurrent = CONCURRENT_NONE;
danc3da6672014-10-28 18:24:16 +00003226 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003227 }
danielk1977261919c2005-12-06 12:52:59 +00003228 }
3229 }
dan32b09f22009-09-23 17:29:59 +00003230
3231 /* Check for immediate foreign key violations. */
danf116ad82019-05-07 19:44:11 +00003232 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan32b09f22009-09-23 17:29:59 +00003233 sqlite3VdbeCheckFk(p, 0);
3234 }
danielk197707cb5602006-01-20 10:55:05 +00003235
danielk1977bd434552009-03-18 10:33:00 +00003236 /* If the auto-commit flag is set and this is the only active writer
3237 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00003238 **
3239 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00003240 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00003241 */
danielk1977093e0f62008-11-13 18:00:14 +00003242 if( !sqlite3VtabInSync(db)
3243 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00003244 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00003245 ){
danielk197707cb5602006-01-20 10:55:05 +00003246 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00003247 rc = sqlite3VdbeCheckFk(p, 1);
3248 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00003249 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00003250 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00003251 return SQLITE_ERROR;
3252 }
drhd91c1a12013-02-09 13:58:25 +00003253 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
drh9dc71882021-11-15 19:10:13 +00003254 }else if( db->flags & SQLITE_CorruptRdOnly ){
3255 rc = SQLITE_CORRUPT;
3256 db->flags &= ~SQLITE_CorruptRdOnly;
dan19611b12011-01-24 16:00:58 +00003257 }else{
3258 /* The auto-commit flag is true, the vdbe program was successful
3259 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
3260 ** key constraints to hold up the transaction. This means a commit
3261 ** is required. */
3262 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00003263 }
dan3d394342015-07-27 19:31:45 +00003264 if( (rc & 0xFF)==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00003265 sqlite3VdbeLeave(p);
dan3d394342015-07-27 19:31:45 +00003266 return rc;
danielk197707cb5602006-01-20 10:55:05 +00003267 }else if( rc!=SQLITE_OK ){
3268 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00003269 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00003270 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003271 }else{
dan1da40a32009-09-19 17:00:31 +00003272 db->nDeferredCons = 0;
drh648e2642013-07-11 15:03:32 +00003273 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00003274 db->flags &= ~(u64)SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00003275 sqlite3CommitInternalChanges(db);
3276 }
3277 }else{
drh0f198a72012-02-13 16:43:16 +00003278 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00003279 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003280 }
danielk1977bd434552009-03-18 10:33:00 +00003281 db->nStatement = 0;
3282 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00003283 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00003284 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00003285 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00003286 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00003287 }else{
drh21021a52012-02-13 17:01:51 +00003288 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00003289 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00003290 db->autoCommit = 1;
dand05cc8f2020-07-16 20:57:35 +00003291 db->eConcurrent = CONCURRENT_NONE;
danc3da6672014-10-28 18:24:16 +00003292 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003293 }
danielk19771d850a72004-05-31 08:26:49 +00003294 }
danielk197707cb5602006-01-20 10:55:05 +00003295
danielk1977bd434552009-03-18 10:33:00 +00003296 /* If eStatementOp is non-zero, then a statement transaction needs to
3297 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
3298 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00003299 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
3300 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00003301 */
danielk1977bd434552009-03-18 10:33:00 +00003302 if( eStatementOp ){
3303 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00003304 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00003305 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00003306 p->rc = rc;
3307 sqlite3DbFree(db, p->zErrMsg);
3308 p->zErrMsg = 0;
3309 }
drh21021a52012-02-13 17:01:51 +00003310 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00003311 sqlite3CloseSavepoints(db);
3312 db->autoCommit = 1;
dand05cc8f2020-07-16 20:57:35 +00003313 db->eConcurrent = CONCURRENT_NONE;
danc3da6672014-10-28 18:24:16 +00003314 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003315 }
danielk197777d83ba2004-05-31 10:08:14 +00003316 }
danielk197707cb5602006-01-20 10:55:05 +00003317
danielk1977bd434552009-03-18 10:33:00 +00003318 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
3319 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00003320 */
drh6be240e2009-07-14 02:33:02 +00003321 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00003322 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00003323 sqlite3VdbeSetChanges(db, p->nChange);
3324 }else{
3325 sqlite3VdbeSetChanges(db, 0);
3326 }
3327 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00003328 }
drhff0587c2007-08-29 17:43:19 +00003329
3330 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00003331 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00003332 }
danielk19771d850a72004-05-31 08:26:49 +00003333
danielk197765fd59f2006-06-24 11:51:33 +00003334 /* We have successfully halted and closed the VM. Record this fact. */
drh99a21822022-03-31 21:15:09 +00003335 db->nVdbeActive--;
3336 if( !p->readOnly ) db->nVdbeWrite--;
3337 if( p->bIsReader ) db->nVdbeRead--;
3338 assert( db->nVdbeActive>=db->nVdbeRead );
3339 assert( db->nVdbeRead>=db->nVdbeWrite );
3340 assert( db->nVdbeWrite>=0 );
drh66181ce2022-03-31 20:04:49 +00003341 p->eVdbeState = VDBE_HALT_STATE;
drh92f02c32004-09-02 14:57:08 +00003342 checkActiveVdbeCnt(db);
drhb84e5742016-02-05 02:42:54 +00003343 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00003344 p->rc = SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00003345 }
danielk19771d850a72004-05-31 08:26:49 +00003346
danielk1977404ca072009-03-16 13:19:36 +00003347 /* If the auto-commit flag is set to true, then any locks that were held
3348 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
3349 ** to invoke any required unlock-notify callbacks.
3350 */
3351 if( db->autoCommit ){
3352 sqlite3ConnectionUnlocked(db);
3353 }
3354
drh4f7d3a52013-06-27 23:54:02 +00003355 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
danb87b25f2015-08-21 20:11:23 +00003356 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00003357}
drh4cf7c7f2007-08-28 23:28:07 +00003358
drh92f02c32004-09-02 14:57:08 +00003359
3360/*
drh3c23a882007-01-09 14:01:13 +00003361** Each VDBE holds the result of the most recent sqlite3_step() call
3362** in p->rc. This routine sets that result back to SQLITE_OK.
3363*/
3364void sqlite3VdbeResetStepResult(Vdbe *p){
3365 p->rc = SQLITE_OK;
3366}
3367
3368/*
dan029ead62011-10-27 15:19:58 +00003369** Copy the error code and error message belonging to the VDBE passed
3370** as the first argument to its database handle (so that they will be
3371** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
3372**
3373** This function does not clear the VDBE error code or message, just
3374** copies them to the database handle.
3375*/
3376int sqlite3VdbeTransferError(Vdbe *p){
3377 sqlite3 *db = p->db;
3378 int rc = p->rc;
3379 if( p->zErrMsg ){
drh4a642b62016-02-05 01:55:27 +00003380 db->bBenignMalloc++;
dan029ead62011-10-27 15:19:58 +00003381 sqlite3BeginBenignMalloc();
drha3cc0072013-12-13 16:23:55 +00003382 if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
dan029ead62011-10-27 15:19:58 +00003383 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
3384 sqlite3EndBenignMalloc();
drh4a642b62016-02-05 01:55:27 +00003385 db->bBenignMalloc--;
drhe70d01f2017-05-29 22:44:18 +00003386 }else if( db->pErr ){
3387 sqlite3ValueSetNull(db->pErr);
dan029ead62011-10-27 15:19:58 +00003388 }
drhe70d01f2017-05-29 22:44:18 +00003389 db->errCode = rc;
drhe1c47432022-02-07 18:52:56 +00003390 db->errByteOffset = -1;
dan029ead62011-10-27 15:19:58 +00003391 return rc;
3392}
3393
danac455932012-11-26 19:50:41 +00003394#ifdef SQLITE_ENABLE_SQLLOG
3395/*
3396** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
3397** invoke it.
3398*/
3399static void vdbeInvokeSqllog(Vdbe *v){
3400 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
3401 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
3402 assert( v->db->init.busy==0 );
3403 if( zExpanded ){
3404 sqlite3GlobalConfig.xSqllog(
3405 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
3406 );
3407 sqlite3DbFree(v->db, zExpanded);
3408 }
3409 }
3410}
3411#else
3412# define vdbeInvokeSqllog(x)
3413#endif
3414
dan029ead62011-10-27 15:19:58 +00003415/*
drh92f02c32004-09-02 14:57:08 +00003416** Clean up a VDBE after execution but do not delete the VDBE just yet.
3417** Write any error messages into *pzErrMsg. Return the result code.
3418**
3419** After this routine is run, the VDBE should be ready to be executed
3420** again.
3421**
3422** To look at it another way, this routine resets the state of the
drh66181ce2022-03-31 20:04:49 +00003423** virtual machine from VDBE_RUN_STATE or VDBE_HALT_STATE back to
3424** VDBE_READY_STATE.
drh92f02c32004-09-02 14:57:08 +00003425*/
drhc890fec2008-08-01 20:10:08 +00003426int sqlite3VdbeReset(Vdbe *p){
mistachkin4537f772017-10-07 23:35:40 +00003427#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
mistachkinb60424e2017-10-07 23:31:33 +00003428 int i;
3429#endif
3430
drh4ac285a2006-09-15 07:28:50 +00003431 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00003432 db = p->db;
drh92f02c32004-09-02 14:57:08 +00003433
3434 /* If the VM did not run to completion or if it encountered an
3435 ** error, then it might not have been halted properly. So halt
3436 ** it now.
3437 */
drh8703edd2022-04-03 22:35:13 +00003438 if( p->eVdbeState==VDBE_RUN_STATE ) sqlite3VdbeHalt(p);
drh92f02c32004-09-02 14:57:08 +00003439
drh8741d0d2018-09-12 00:21:11 +00003440 /* If the VDBE has been run even partially, then transfer the error code
drhfb7e7652005-01-24 00:28:42 +00003441 ** and error message from the VDBE into the main database structure. But
3442 ** if the VDBE has just been set to run but has not actually executed any
3443 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00003444 */
drhfb7e7652005-01-24 00:28:42 +00003445 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00003446 vdbeInvokeSqllog(p);
drhed505ce2020-05-26 20:31:17 +00003447 if( db->pErr || p->zErrMsg ){
3448 sqlite3VdbeTransferError(p);
3449 }else{
3450 db->errCode = p->rc;
3451 }
drh92f02c32004-09-02 14:57:08 +00003452 }
3453
drhc2c6fd12017-09-09 22:46:56 +00003454 /* Reset register contents and reclaim error message memory.
drh92f02c32004-09-02 14:57:08 +00003455 */
drhc2c6fd12017-09-09 22:46:56 +00003456#ifdef SQLITE_DEBUG
3457 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
3458 ** Vdbe.aMem[] arrays have already been cleaned up. */
drhc2c6fd12017-09-09 22:46:56 +00003459 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
3460 if( p->aMem ){
3461 for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
3462 }
3463#endif
drhed505ce2020-05-26 20:31:17 +00003464 if( p->zErrMsg ){
3465 sqlite3DbFree(db, p->zErrMsg);
3466 p->zErrMsg = 0;
3467 }
drhc2c6fd12017-09-09 22:46:56 +00003468 p->pResultSet = 0;
drh4031baf2018-05-28 17:31:20 +00003469#ifdef SQLITE_DEBUG
3470 p->nWrite = 0;
3471#endif
drh92f02c32004-09-02 14:57:08 +00003472
3473 /* Save profiling information from this VDBE run.
3474 */
drh9a324642003-09-06 20:12:01 +00003475#ifdef VDBE_PROFILE
3476 {
3477 FILE *out = fopen("vdbe_profile.out", "a");
3478 if( out ){
drh9a324642003-09-06 20:12:01 +00003479 fprintf(out, "---- ");
3480 for(i=0; i<p->nOp; i++){
3481 fprintf(out, "%02x", p->aOp[i].opcode);
3482 }
3483 fprintf(out, "\n");
drh2926f962014-02-17 01:13:28 +00003484 if( p->zSql ){
3485 char c, pc = 0;
3486 fprintf(out, "-- ");
3487 for(i=0; (c = p->zSql[i])!=0; i++){
3488 if( pc=='\n' ) fprintf(out, "-- ");
3489 putc(c, out);
3490 pc = c;
3491 }
3492 if( pc!='\n' ) fprintf(out, "\n");
3493 }
drh9a324642003-09-06 20:12:01 +00003494 for(i=0; i<p->nOp; i++){
drh15ab9412014-02-24 14:24:01 +00003495 char zHdr[100];
3496 sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
drh9a324642003-09-06 20:12:01 +00003497 p->aOp[i].cnt,
3498 p->aOp[i].cycles,
3499 p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
3500 );
drh15ab9412014-02-24 14:24:01 +00003501 fprintf(out, "%s", zHdr);
danielk19774adee202004-05-08 08:23:19 +00003502 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00003503 }
3504 fclose(out);
3505 }
3506 }
3507#endif
drh4ac285a2006-09-15 07:28:50 +00003508 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00003509}
drh92f02c32004-09-02 14:57:08 +00003510
drh9a324642003-09-06 20:12:01 +00003511/*
3512** Clean up and delete a VDBE after execution. Return an integer which is
3513** the result code. Write any error message text into *pzErrMsg.
3514*/
danielk19779e6db7d2004-06-21 08:18:51 +00003515int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00003516 int rc = SQLITE_OK;
drh99a21822022-03-31 21:15:09 +00003517 assert( VDBE_RUN_STATE>VDBE_READY_STATE );
3518 assert( VDBE_HALT_STATE>VDBE_READY_STATE );
3519 assert( VDBE_INIT_STATE<VDBE_READY_STATE );
3520 if( p->eVdbeState>=VDBE_READY_STATE ){
drhc890fec2008-08-01 20:10:08 +00003521 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00003522 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00003523 }
danielk19774adee202004-05-08 08:23:19 +00003524 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00003525 return rc;
3526}
3527
3528/*
dan0c547792013-07-18 17:12:08 +00003529** If parameter iOp is less than zero, then invoke the destructor for
3530** all auxiliary data pointers currently cached by the VM passed as
3531** the first argument.
3532**
3533** Or, if iOp is greater than or equal to zero, then the destructor is
3534** only invoked for those auxiliary data pointers created by the user
3535** function invoked by the OP_Function opcode at instruction iOp of
3536** VM pVdbe, and only then if:
3537**
3538** * the associated function parameter is the 32nd or later (counting
3539** from left to right), or
3540**
3541** * the corresponding bit in argument mask is clear (where the first
peter.d.reid60ec9142014-09-06 16:39:46 +00003542** function parameter corresponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00003543*/
drhb9626cf2016-02-22 16:04:31 +00003544void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
dan0c547792013-07-18 17:12:08 +00003545 while( *pp ){
3546 AuxData *pAux = *pp;
3547 if( (iOp<0)
drhf7fa4e72017-05-11 15:20:18 +00003548 || (pAux->iAuxOp==iOp
3549 && pAux->iAuxArg>=0
drhe6941392017-05-10 19:42:52 +00003550 && (pAux->iAuxArg>31 || !(mask & MASKBIT32(pAux->iAuxArg))))
dan0c547792013-07-18 17:12:08 +00003551 ){
drhe6941392017-05-10 19:42:52 +00003552 testcase( pAux->iAuxArg==31 );
3553 if( pAux->xDeleteAux ){
3554 pAux->xDeleteAux(pAux->pAux);
drhf92c7ff2004-06-19 15:40:23 +00003555 }
drhe6941392017-05-10 19:42:52 +00003556 *pp = pAux->pNextAux;
drhb9626cf2016-02-22 16:04:31 +00003557 sqlite3DbFree(db, pAux);
dan0c547792013-07-18 17:12:08 +00003558 }else{
drhe6941392017-05-10 19:42:52 +00003559 pp= &pAux->pNextAux;
drhf92c7ff2004-06-19 15:40:23 +00003560 }
3561 }
3562}
3563
3564/*
drhcb103b92012-10-26 00:11:23 +00003565** Free all memory associated with the Vdbe passed as the second argument,
3566** except for object itself, which is preserved.
3567**
dand46def72010-07-24 11:28:28 +00003568** The difference between this function and sqlite3VdbeDelete() is that
3569** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00003570** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00003571*/
drh1c848632022-04-04 01:12:11 +00003572static void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00003573 SubProgram *pSub, *pNext;
drh41ce47c2022-08-22 02:00:26 +00003574 assert( db!=0 );
dand46def72010-07-24 11:28:28 +00003575 assert( p->db==0 || p->db==db );
drhda3ec152022-03-28 14:18:03 +00003576 if( p->aColName ){
3577 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh41ce47c2022-08-22 02:00:26 +00003578 sqlite3DbNNFreeNN(db, p->aColName);
drhda3ec152022-03-28 14:18:03 +00003579 }
dand19c9332010-07-26 12:05:17 +00003580 for(pSub=p->pProgram; pSub; pSub=pNext){
3581 pNext = pSub->pNext;
3582 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
3583 sqlite3DbFree(db, pSub);
3584 }
drh66181ce2022-03-31 20:04:49 +00003585 if( p->eVdbeState!=VDBE_INIT_STATE ){
drh8dfef112016-10-01 16:53:45 +00003586 releaseMemArray(p->aVar, p->nVar);
drh41ce47c2022-08-22 02:00:26 +00003587 if( p->pVList ) sqlite3DbNNFreeNN(db, p->pVList);
3588 if( p->pFree ) sqlite3DbNNFreeNN(db, p->pFree);
drhab3182f2016-10-01 00:37:50 +00003589 }
dand46def72010-07-24 11:28:28 +00003590 vdbeFreeOpArray(db, p->aOp, p->nOp);
drh41ce47c2022-08-22 02:00:26 +00003591 if( p->zSql ) sqlite3DbNNFreeNN(db, p->zSql);
mistachkin8bee11a2018-10-29 17:53:23 +00003592#ifdef SQLITE_ENABLE_NORMALIZE
3593 sqlite3DbFree(db, p->zNormSql);
drh893bd372018-12-07 16:32:11 +00003594 {
3595 DblquoteStr *pThis, *pNext;
3596 for(pThis=p->pDblStr; pThis; pThis=pNext){
3597 pNext = pThis->pNextStr;
3598 sqlite3DbFree(db, pThis);
3599 }
3600 }
mistachkin8bee11a2018-10-29 17:53:23 +00003601#endif
dan6f9702e2014-11-01 20:38:06 +00003602#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drhf326d662016-12-23 13:30:53 +00003603 {
3604 int i;
3605 for(i=0; i<p->nScan; i++){
3606 sqlite3DbFree(db, p->aScan[i].zName);
3607 }
3608 sqlite3DbFree(db, p->aScan);
dan6f9702e2014-11-01 20:38:06 +00003609 }
dan6f9702e2014-11-01 20:38:06 +00003610#endif
dand46def72010-07-24 11:28:28 +00003611}
3612
3613/*
drh9a324642003-09-06 20:12:01 +00003614** Delete an entire VDBE.
3615*/
danielk19774adee202004-05-08 08:23:19 +00003616void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00003617 sqlite3 *db;
3618
drh9d9c41e2017-10-31 03:40:15 +00003619 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +00003620 db = p->db;
drh41ce47c2022-08-22 02:00:26 +00003621 assert( db!=0 );
drh4245c402012-06-02 14:32:21 +00003622 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00003623 sqlite3VdbeClearObject(db, p);
drh1c848632022-04-04 01:12:11 +00003624 if( db->pnBytesFreed==0 ){
drhe5928b12022-08-23 20:11:01 +00003625 assert( p->ppVPrev!=0 );
3626 *p->ppVPrev = p->pVNext;
3627 if( p->pVNext ){
3628 p->pVNext->ppVPrev = p->ppVPrev;
drh1c848632022-04-04 01:12:11 +00003629 }
drh9a324642003-09-06 20:12:01 +00003630 }
drh41ce47c2022-08-22 02:00:26 +00003631 sqlite3DbNNFreeNN(db, p);
drh9a324642003-09-06 20:12:01 +00003632}
drha11846b2004-01-07 18:52:56 +00003633
3634/*
drh6848dad2014-08-22 23:33:03 +00003635** The cursor "p" has a pending seek operation that has not yet been
3636** carried out. Seek the cursor now. If an error occurs, return
3637** the appropriate error code.
3638*/
drhbe3da242019-12-29 00:52:41 +00003639int SQLITE_NOINLINE sqlite3VdbeFinishMoveto(VdbeCursor *p){
drh6848dad2014-08-22 23:33:03 +00003640 int res, rc;
3641#ifdef SQLITE_TEST
3642 extern int sqlite3_search_count;
3643#endif
3644 assert( p->deferredMoveto );
3645 assert( p->isTable );
drhc960dcb2015-11-20 19:22:01 +00003646 assert( p->eCurType==CURTYPE_BTREE );
drh42a410d2021-06-19 18:32:20 +00003647 rc = sqlite3BtreeTableMoveto(p->uc.pCursor, p->movetoTarget, 0, &res);
drh6848dad2014-08-22 23:33:03 +00003648 if( rc ) return rc;
drh6848dad2014-08-22 23:33:03 +00003649 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
drh6848dad2014-08-22 23:33:03 +00003650#ifdef SQLITE_TEST
3651 sqlite3_search_count++;
3652#endif
3653 p->deferredMoveto = 0;
3654 p->cacheStatus = CACHE_STALE;
3655 return SQLITE_OK;
3656}
3657
3658/*
3659** Something has moved cursor "p" out of place. Maybe the row it was
3660** pointed to was deleted out from under it. Or maybe the btree was
3661** rebalanced. Whatever the cause, try to restore "p" to the place it
peter.d.reid60ec9142014-09-06 16:39:46 +00003662** is supposed to be pointing. If the row was deleted out from under the
drh6848dad2014-08-22 23:33:03 +00003663** cursor, set the cursor to point to a NULL row.
3664*/
drhfc569502022-02-25 20:11:59 +00003665int SQLITE_NOINLINE sqlite3VdbeHandleMovedCursor(VdbeCursor *p){
drh6848dad2014-08-22 23:33:03 +00003666 int isDifferentRow, rc;
drhc960dcb2015-11-20 19:22:01 +00003667 assert( p->eCurType==CURTYPE_BTREE );
3668 assert( p->uc.pCursor!=0 );
3669 assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
3670 rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
drh6848dad2014-08-22 23:33:03 +00003671 p->cacheStatus = CACHE_STALE;
3672 if( isDifferentRow ) p->nullRow = 1;
3673 return rc;
3674}
3675
3676/*
drhc22284f2014-10-13 16:02:20 +00003677** Check to ensure that the cursor is valid. Restore the cursor
3678** if need be. Return any I/O error from the restore operation.
3679*/
3680int sqlite3VdbeCursorRestore(VdbeCursor *p){
drheab6c122022-04-14 12:59:25 +00003681 assert( p->eCurType==CURTYPE_BTREE || IsNullCursor(p) );
drhc960dcb2015-11-20 19:22:01 +00003682 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
drhfc569502022-02-25 20:11:59 +00003683 return sqlite3VdbeHandleMovedCursor(p);
drha11846b2004-01-07 18:52:56 +00003684 }
3685 return SQLITE_OK;
3686}
danielk19774adee202004-05-08 08:23:19 +00003687
drhab9f7f12004-05-08 10:56:11 +00003688/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003689** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00003690**
danielk1977cfcdaef2004-05-12 07:33:33 +00003691** sqlite3VdbeSerialType()
3692** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00003693** sqlite3VdbeSerialLen()
drhd859dc22022-04-02 14:30:58 +00003694** sqlite3VdbeSerialPut() <--- in-lined into OP_MakeRecord as of 2022-04-02
shane92003092008-07-31 01:43:13 +00003695** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00003696**
3697** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00003698** data and index records. Each serialized value consists of a
3699** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
3700** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00003701**
danielk1977cfcdaef2004-05-12 07:33:33 +00003702** In an SQLite index record, the serial type is stored directly before
3703** the blob of data that it corresponds to. In a table record, all serial
3704** types are stored at the start of the record, and the blobs of data at
3705** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00003706** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00003707**
3708** The following table describes the various storage classes for data:
3709**
3710** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00003711** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00003712** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00003713** 1 1 signed integer
3714** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00003715** 3 3 signed integer
3716** 4 4 signed integer
3717** 5 6 signed integer
3718** 6 8 signed integer
3719** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00003720** 8 0 Integer constant 0
3721** 9 0 Integer constant 1
3722** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00003723** N>=12 and even (N-12)/2 BLOB
3724** N>=13 and odd (N-13)/2 text
3725**
drh35a59652006-01-02 18:24:40 +00003726** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
3727** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00003728*/
3729
drh175b8f02019-08-08 15:24:17 +00003730#if 0 /* Inlined into the OP_MakeRecord opcode */
danielk197790e4d952004-05-10 10:05:53 +00003731/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003732** Return the serial-type for the value stored in pMem.
drh6bab6f22019-05-09 17:10:30 +00003733**
3734** This routine might convert a large MEM_IntReal value into MEM_Real.
drhc1da4392019-07-11 19:22:36 +00003735**
3736** 2019-07-11: The primary user of this subroutine was the OP_MakeRecord
3737** opcode in the byte-code engine. But by moving this routine in-line, we
3738** can omit some redundant tests and make that opcode a lot faster. So
drh175b8f02019-08-08 15:24:17 +00003739** this routine is now only used by the STAT3 logic and STAT3 support has
3740** ended. The code is kept here for historical reference only.
danielk1977192ac1d2004-05-10 07:17:30 +00003741*/
drhbe37c122015-10-16 14:54:17 +00003742u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
danielk1977cfcdaef2004-05-12 07:33:33 +00003743 int flags = pMem->flags;
drheac5bd72014-07-25 21:35:39 +00003744 u32 n;
danielk1977cfcdaef2004-05-12 07:33:33 +00003745
drhbe37c122015-10-16 14:54:17 +00003746 assert( pLen!=0 );
danielk1977cfcdaef2004-05-12 07:33:33 +00003747 if( flags&MEM_Null ){
drhbe37c122015-10-16 14:54:17 +00003748 *pLen = 0;
drha19b7752004-05-30 21:14:58 +00003749 return 0;
danielk197790e4d952004-05-10 10:05:53 +00003750 }
drh169f0772019-05-02 21:36:26 +00003751 if( flags&(MEM_Int|MEM_IntReal) ){
drhfe2093d2005-01-20 22:48:47 +00003752 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00003753# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00003754 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00003755 u64 u;
drh3242c692019-05-04 01:29:13 +00003756 testcase( flags & MEM_Int );
3757 testcase( flags & MEM_IntReal );
drhcfd654b2011-03-05 13:54:15 +00003758 if( i<0 ){
drh1b40e632014-11-20 02:58:10 +00003759 u = ~i;
drhcfd654b2011-03-05 13:54:15 +00003760 }else{
3761 u = i;
3762 }
drh56690b32012-09-17 15:36:31 +00003763 if( u<=127 ){
drhbe37c122015-10-16 14:54:17 +00003764 if( (i&1)==i && file_format>=4 ){
3765 *pLen = 0;
3766 return 8+(u32)u;
3767 }else{
3768 *pLen = 1;
3769 return 1;
3770 }
drh56690b32012-09-17 15:36:31 +00003771 }
drhbe37c122015-10-16 14:54:17 +00003772 if( u<=32767 ){ *pLen = 2; return 2; }
3773 if( u<=8388607 ){ *pLen = 3; return 3; }
3774 if( u<=2147483647 ){ *pLen = 4; return 4; }
3775 if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
3776 *pLen = 8;
drh6bab6f22019-05-09 17:10:30 +00003777 if( flags&MEM_IntReal ){
3778 /* If the value is IntReal and is going to take up 8 bytes to store
3779 ** as an integer, then we might as well make it an 8-byte floating
3780 ** point value */
3781 pMem->u.r = (double)pMem->u.i;
3782 pMem->flags &= ~MEM_IntReal;
3783 pMem->flags |= MEM_Real;
3784 return 7;
3785 }
drha19b7752004-05-30 21:14:58 +00003786 return 6;
danielk197790e4d952004-05-10 10:05:53 +00003787 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003788 if( flags&MEM_Real ){
drhbe37c122015-10-16 14:54:17 +00003789 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003790 return 7;
danielk197790e4d952004-05-10 10:05:53 +00003791 }
danielk1977e4359752008-11-03 09:39:45 +00003792 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drheac5bd72014-07-25 21:35:39 +00003793 assert( pMem->n>=0 );
3794 n = (u32)pMem->n;
drhfdf972a2007-05-02 13:30:27 +00003795 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00003796 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00003797 }
drhbe37c122015-10-16 14:54:17 +00003798 *pLen = n;
drhfdf972a2007-05-02 13:30:27 +00003799 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00003800}
drh175b8f02019-08-08 15:24:17 +00003801#endif /* inlined into OP_MakeRecord */
danielk1977192ac1d2004-05-10 07:17:30 +00003802
3803/*
drhfaf37272015-10-16 14:23:42 +00003804** The sizes for serial types less than 128
drhc5ef7152015-06-28 02:58:51 +00003805*/
drhd859dc22022-04-02 14:30:58 +00003806const u8 sqlite3SmallTypeSizes[128] = {
drhfaf37272015-10-16 14:23:42 +00003807 /* 0 1 2 3 4 5 6 7 8 9 */
3808/* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
3809/* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
3810/* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
3811/* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
3812/* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
3813/* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
3814/* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
3815/* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
3816/* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
3817/* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
3818/* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
3819/* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
3820/* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
drhc5ef7152015-06-28 02:58:51 +00003821};
3822
3823/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003824** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00003825*/
drh35cd6432009-06-05 14:17:21 +00003826u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drhfaf37272015-10-16 14:23:42 +00003827 if( serial_type>=128 ){
drh51846b52004-05-28 16:00:21 +00003828 return (serial_type-12)/2;
3829 }else{
drhfaf37272015-10-16 14:23:42 +00003830 assert( serial_type<12
3831 || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
drhc5ef7152015-06-28 02:58:51 +00003832 return sqlite3SmallTypeSizes[serial_type];
drh51846b52004-05-28 16:00:21 +00003833 }
danielk1977192ac1d2004-05-10 07:17:30 +00003834}
drhfaf37272015-10-16 14:23:42 +00003835u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
3836 assert( serial_type<128 );
3837 return sqlite3SmallTypeSizes[serial_type];
3838}
danielk1977192ac1d2004-05-10 07:17:30 +00003839
3840/*
drh110daac2007-05-04 11:59:31 +00003841** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00003842** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00003843** upper 4 bytes. Return the result.
3844**
drh7a4f5022007-05-23 07:20:08 +00003845** For most architectures, this is a no-op.
3846**
3847** (later): It is reported to me that the mixed-endian problem
3848** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
3849** that early versions of GCC stored the two words of a 64-bit
3850** float in the wrong order. And that error has been propagated
3851** ever since. The blame is not necessarily with GCC, though.
3852** GCC might have just copying the problem from a prior compiler.
3853** I am also told that newer versions of GCC that follow a different
3854** ABI get the byte order right.
3855**
3856** Developers using SQLite on an ARM7 should compile and run their
3857** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
3858** enabled, some asserts below will ensure that the byte order of
3859** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00003860**
3861** (2007-08-30) Frank van Vugt has studied this problem closely
3862** and has send his findings to the SQLite developers. Frank
3863** writes that some Linux kernels offer floating point hardware
3864** emulation that uses only 32-bit mantissas instead of a full
3865** 48-bits as required by the IEEE standard. (This is the
3866** CONFIG_FPE_FASTFPE option.) On such systems, floating point
3867** byte swapping becomes very complicated. To avoid problems,
3868** the necessary byte swapping is carried out using a 64-bit integer
3869** rather than a 64-bit float. Frank assures us that the code here
3870** works for him. We, the developers, have no way to independently
3871** verify this, but Frank seems to know what he is talking about
3872** so we trust him.
drh110daac2007-05-04 11:59:31 +00003873*/
3874#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhd859dc22022-04-02 14:30:58 +00003875u64 sqlite3FloatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00003876 union {
drh60d09a72007-08-30 15:05:08 +00003877 u64 r;
drh110daac2007-05-04 11:59:31 +00003878 u32 i[2];
3879 } u;
3880 u32 t;
3881
3882 u.r = in;
3883 t = u.i[0];
3884 u.i[0] = u.i[1];
3885 u.i[1] = t;
3886 return u.r;
3887}
drhd859dc22022-04-02 14:30:58 +00003888#endif /* SQLITE_MIXED_ENDIAN_64BIT_FLOAT */
drh110daac2007-05-04 11:59:31 +00003889
danielk1977cfcdaef2004-05-12 07:33:33 +00003890
drhf926d1e2014-03-04 04:04:33 +00003891/* Input "x" is a sequence of unsigned characters that represent a
3892** big-endian integer. Return the equivalent native integer
3893*/
3894#define ONE_BYTE_INT(x) ((i8)(x)[0])
3895#define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
3896#define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
3897#define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drh8932bec2014-08-22 14:56:13 +00003898#define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drhf926d1e2014-03-04 04:04:33 +00003899
danielk1977cfcdaef2004-05-12 07:33:33 +00003900/*
3901** Deserialize the data blob pointed to by buf as serial type serial_type
drh06164b22021-12-14 00:36:09 +00003902** and store the result in pMem.
drh14a924a2014-08-22 14:34:05 +00003903**
3904** This function is implemented as two separate routines for performance.
3905** The few cases that require local variables are broken out into a separate
3906** routine so that in most cases the overhead of moving the stack pointer
3907** is avoided.
danielk1977cfcdaef2004-05-12 07:33:33 +00003908*/
drh06164b22021-12-14 00:36:09 +00003909static void serialGet(
danielk197793d46752004-05-23 13:30:58 +00003910 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00003911 u32 serial_type, /* Serial type to deserialize */
3912 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00003913){
drh8932bec2014-08-22 14:56:13 +00003914 u64 x = FOUR_BYTE_UINT(buf);
3915 u32 y = FOUR_BYTE_UINT(buf+4);
3916 x = (x<<32) + y;
drh14a924a2014-08-22 14:34:05 +00003917 if( serial_type==6 ){
drh654858d2014-11-20 02:18:14 +00003918 /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
3919 ** twos-complement integer. */
drh14a924a2014-08-22 14:34:05 +00003920 pMem->u.i = *(i64*)&x;
3921 pMem->flags = MEM_Int;
3922 testcase( pMem->u.i<0 );
3923 }else{
drh654858d2014-11-20 02:18:14 +00003924 /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
3925 ** floating point number. */
drh14a924a2014-08-22 14:34:05 +00003926#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
3927 /* Verify that integers and floating point values use the same
3928 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
3929 ** defined that 64-bit floating point values really are mixed
3930 ** endian.
3931 */
3932 static const u64 t1 = ((u64)0x3ff00000)<<32;
3933 static const double r1 = 1.0;
3934 u64 t2 = t1;
3935 swapMixedEndianFloat(t2);
3936 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
3937#endif
drh74eaba42014-09-18 17:52:15 +00003938 assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
drh14a924a2014-08-22 14:34:05 +00003939 swapMixedEndianFloat(x);
drh74eaba42014-09-18 17:52:15 +00003940 memcpy(&pMem->u.r, &x, sizeof(x));
drh05921222019-05-30 00:46:37 +00003941 pMem->flags = IsNaN(x) ? MEM_Null : MEM_Real;
drh14a924a2014-08-22 14:34:05 +00003942 }
drh14a924a2014-08-22 14:34:05 +00003943}
drh06164b22021-12-14 00:36:09 +00003944void sqlite3VdbeSerialGet(
danielk1977b1bc9532004-05-22 03:05:33 +00003945 const unsigned char *buf, /* Buffer to deserialize from */
3946 u32 serial_type, /* Serial type to deserialize */
3947 Mem *pMem /* Memory cell to write value into */
3948){
drh3c685822005-05-21 18:32:18 +00003949 switch( serial_type ){
drhce2fbd12018-01-12 21:00:14 +00003950 case 10: { /* Internal use only: NULL with virtual table
3951 ** UPDATE no-change flag set */
3952 pMem->flags = MEM_Null|MEM_Zero;
drhcdb60972018-01-13 14:28:00 +00003953 pMem->n = 0;
3954 pMem->u.nZero = 0;
drh06164b22021-12-14 00:36:09 +00003955 return;
drhce2fbd12018-01-12 21:00:14 +00003956 }
drh3c685822005-05-21 18:32:18 +00003957 case 11: /* Reserved for future use */
drh654858d2014-11-20 02:18:14 +00003958 case 0: { /* Null */
3959 /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
drh3c685822005-05-21 18:32:18 +00003960 pMem->flags = MEM_Null;
drh06164b22021-12-14 00:36:09 +00003961 return;
drh3c685822005-05-21 18:32:18 +00003962 }
drh654858d2014-11-20 02:18:14 +00003963 case 1: {
3964 /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
3965 ** integer. */
drhf926d1e2014-03-04 04:04:33 +00003966 pMem->u.i = ONE_BYTE_INT(buf);
drh1483e142004-05-21 21:12:42 +00003967 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003968 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00003969 return;
drh1483e142004-05-21 21:12:42 +00003970 }
drh3c685822005-05-21 18:32:18 +00003971 case 2: { /* 2-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003972 /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
3973 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003974 pMem->u.i = TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003975 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003976 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00003977 return;
drh3c685822005-05-21 18:32:18 +00003978 }
3979 case 3: { /* 3-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003980 /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
3981 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00003982 pMem->u.i = THREE_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00003983 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003984 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00003985 return;
drh3c685822005-05-21 18:32:18 +00003986 }
3987 case 4: { /* 4-byte signed integer */
drh654858d2014-11-20 02:18:14 +00003988 /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
3989 ** twos-complement integer. */
drh8932bec2014-08-22 14:56:13 +00003990 pMem->u.i = FOUR_BYTE_INT(buf);
drhc8bb4302015-11-06 17:28:00 +00003991#ifdef __HP_cc
3992 /* Work around a sign-extension bug in the HP compiler for HP/UX */
3993 if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
3994#endif
drh3c685822005-05-21 18:32:18 +00003995 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00003996 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00003997 return;
drh3c685822005-05-21 18:32:18 +00003998 }
3999 case 5: { /* 6-byte signed integer */
drh654858d2014-11-20 02:18:14 +00004000 /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
4001 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00004002 pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00004003 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004004 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004005 return;
drh3c685822005-05-21 18:32:18 +00004006 }
drh91124b32005-08-18 18:15:05 +00004007 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00004008 case 7: { /* IEEE floating point */
drh8932bec2014-08-22 14:56:13 +00004009 /* These use local variables, so do them in a separate routine
4010 ** to avoid having to move the frame pointer in the common case */
drh06164b22021-12-14 00:36:09 +00004011 serialGet(buf,serial_type,pMem);
4012 return;
drh3c685822005-05-21 18:32:18 +00004013 }
drhd946db02005-12-29 19:23:06 +00004014 case 8: /* Integer 0 */
4015 case 9: { /* Integer 1 */
drh654858d2014-11-20 02:18:14 +00004016 /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
4017 /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
drh3c024d62007-03-30 11:23:45 +00004018 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00004019 pMem->flags = MEM_Int;
drh06164b22021-12-14 00:36:09 +00004020 return;
drhd946db02005-12-29 19:23:06 +00004021 }
drh3c685822005-05-21 18:32:18 +00004022 default: {
drh654858d2014-11-20 02:18:14 +00004023 /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
4024 ** length.
4025 ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
4026 ** (N-13)/2 bytes in length. */
drhc138daf2013-11-19 13:55:34 +00004027 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh3c685822005-05-21 18:32:18 +00004028 pMem->z = (char *)buf;
drh14a924a2014-08-22 14:34:05 +00004029 pMem->n = (serial_type-12)/2;
drhc138daf2013-11-19 13:55:34 +00004030 pMem->flags = aFlag[serial_type&1];
drh06164b22021-12-14 00:36:09 +00004031 return;
drh696b32f2004-05-30 01:51:52 +00004032 }
danielk1977cfcdaef2004-05-12 07:33:33 +00004033 }
drh06164b22021-12-14 00:36:09 +00004034 return;
danielk1977192ac1d2004-05-10 07:17:30 +00004035}
drh1e968a02008-03-25 00:22:21 +00004036/*
dan03e9cfc2011-09-05 14:20:27 +00004037** This routine is used to allocate sufficient space for an UnpackedRecord
4038** structure large enough to be used with sqlite3VdbeRecordUnpack() if
4039** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00004040**
dan03e9cfc2011-09-05 14:20:27 +00004041** The space is either allocated using sqlite3DbMallocRaw() or from within
4042** the unaligned buffer passed via the second and third arguments (presumably
4043** stack space). If the former, then *ppFree is set to a pointer that should
4044** be eventually freed by the caller using sqlite3DbFree(). Or, if the
4045** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
4046** before returning.
drh1e968a02008-03-25 00:22:21 +00004047**
dan03e9cfc2011-09-05 14:20:27 +00004048** If an OOM error occurs, NULL is returned.
4049*/
4050UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
drha582b012016-12-21 19:45:54 +00004051 KeyInfo *pKeyInfo /* Description of the record */
drh1e968a02008-03-25 00:22:21 +00004052){
dan03e9cfc2011-09-05 14:20:27 +00004053 UnpackedRecord *p; /* Unpacked record to return */
dan03e9cfc2011-09-05 14:20:27 +00004054 int nByte; /* Number of bytes required for *p */
drhcf6e3fd2022-04-01 18:45:11 +00004055 nByte = ROUND8P(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nKeyField+1);
drha582b012016-12-21 19:45:54 +00004056 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
4057 if( !p ) return 0;
drhcf6e3fd2022-04-01 18:45:11 +00004058 p->aMem = (Mem*)&((char*)p)[ROUND8P(sizeof(UnpackedRecord))];
dan6e118922019-08-12 16:36:38 +00004059 assert( pKeyInfo->aSortFlags!=0 );
drh1e968a02008-03-25 00:22:21 +00004060 p->pKeyInfo = pKeyInfo;
drha485ad12017-08-02 22:43:14 +00004061 p->nField = pKeyInfo->nKeyField + 1;
dan03e9cfc2011-09-05 14:20:27 +00004062 return p;
4063}
4064
4065/*
4066** Given the nKey-byte encoding of a record in pKey[], populate the
4067** UnpackedRecord structure indicated by the fourth argument with the
4068** contents of the decoded record.
4069*/
4070void sqlite3VdbeRecordUnpack(
4071 KeyInfo *pKeyInfo, /* Information about the record format */
4072 int nKey, /* Size of the binary record */
4073 const void *pKey, /* The binary record */
4074 UnpackedRecord *p /* Populate this structure before returning. */
4075){
4076 const unsigned char *aKey = (const unsigned char *)pKey;
drh936ade42019-01-24 14:16:20 +00004077 u32 d;
dan03e9cfc2011-09-05 14:20:27 +00004078 u32 idx; /* Offset in aKey[] to read from */
4079 u16 u; /* Unsigned loop counter */
4080 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00004081 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00004082
dan1fed5da2014-02-25 21:01:25 +00004083 p->default_rc = 0;
drh8c5d1522009-04-10 00:56:28 +00004084 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00004085 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00004086 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00004087 u = 0;
drhf69af052019-01-25 18:17:37 +00004088 while( idx<szHdr && d<=(u32)nKey ){
drh1e968a02008-03-25 00:22:21 +00004089 u32 serial_type;
4090
danielk197700e13612008-11-17 19:18:54 +00004091 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00004092 pMem->enc = pKeyInfo->enc;
4093 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00004094 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
drh17bcb102014-09-18 21:25:33 +00004095 pMem->szMalloc = 0;
drh304637c2011-03-18 16:47:27 +00004096 pMem->z = 0;
drh06164b22021-12-14 00:36:09 +00004097 sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
4098 d += sqlite3VdbeSerialTypeLen(serial_type);
drhe14006d2008-03-25 17:23:32 +00004099 pMem++;
drh7f4b19f2014-09-16 13:30:05 +00004100 if( (++u)>=p->nField ) break;
drh1e968a02008-03-25 00:22:21 +00004101 }
drhf69af052019-01-25 18:17:37 +00004102 if( d>(u32)nKey && u ){
drh4067ce72019-01-14 13:32:15 +00004103 assert( CORRUPT_DB );
4104 /* In a corrupt record entry, the last pMem might have been set up using
4105 ** uninitialized memory. Overwrite its value with NULL, to prevent
4106 ** warnings from MSAN. */
4107 sqlite3VdbeMemSetNull(pMem-1);
4108 }
drha485ad12017-08-02 22:43:14 +00004109 assert( u<=pKeyInfo->nKeyField + 1 );
shane0b8d2762008-07-22 05:18:00 +00004110 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00004111}
4112
drhd879e3e2017-02-13 13:35:55 +00004113#ifdef SQLITE_DEBUG
dan3b9330f2014-02-27 20:44:18 +00004114/*
dan3833e932014-03-01 19:44:56 +00004115** This function compares two index or table record keys in the same way
4116** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
4117** this function deserializes and compares values using the
4118** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
4119** in assert() statements to ensure that the optimized code in
4120** sqlite3VdbeRecordCompare() returns results with these two primitives.
drh79211e12014-05-02 17:33:16 +00004121**
4122** Return true if the result of comparison is equivalent to desiredResult.
4123** Return false if there is a disagreement.
dan3b9330f2014-02-27 20:44:18 +00004124*/
dan3833e932014-03-01 19:44:56 +00004125static int vdbeRecordCompareDebug(
dan1fed5da2014-02-25 21:01:25 +00004126 int nKey1, const void *pKey1, /* Left key */
drh79211e12014-05-02 17:33:16 +00004127 const UnpackedRecord *pPKey2, /* Right key */
4128 int desiredResult /* Correct answer */
dan1fed5da2014-02-25 21:01:25 +00004129){
dan3b9330f2014-02-27 20:44:18 +00004130 u32 d1; /* Offset into aKey[] of next data element */
4131 u32 idx1; /* Offset into aKey[] of next header element */
4132 u32 szHdr1; /* Number of bytes in header */
4133 int i = 0;
4134 int rc = 0;
4135 const unsigned char *aKey1 = (const unsigned char *)pKey1;
4136 KeyInfo *pKeyInfo;
4137 Mem mem1;
dan1fed5da2014-02-25 21:01:25 +00004138
dan3b9330f2014-02-27 20:44:18 +00004139 pKeyInfo = pPKey2->pKeyInfo;
drh84de6902014-05-02 18:46:52 +00004140 if( pKeyInfo->db==0 ) return 1;
dan3b9330f2014-02-27 20:44:18 +00004141 mem1.enc = pKeyInfo->enc;
4142 mem1.db = pKeyInfo->db;
4143 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
drh17bcb102014-09-18 21:25:33 +00004144 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
dan1fed5da2014-02-25 21:01:25 +00004145
dan3b9330f2014-02-27 20:44:18 +00004146 /* Compilers may complain that mem1.u.i is potentially uninitialized.
4147 ** We could initialize it, as shown here, to silence those complaints.
4148 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
4149 ** the unnecessary initialization has a measurable negative performance
4150 ** impact, since this routine is a very high runner. And so, we choose
4151 ** to ignore the compiler warnings and leave this variable uninitialized.
4152 */
4153 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
4154
4155 idx1 = getVarint32(aKey1, szHdr1);
drh46981362015-07-08 12:25:38 +00004156 if( szHdr1>98307 ) return SQLITE_CORRUPT;
dan3b9330f2014-02-27 20:44:18 +00004157 d1 = szHdr1;
drha485ad12017-08-02 22:43:14 +00004158 assert( pKeyInfo->nAllField>=pPKey2->nField || CORRUPT_DB );
dan6e118922019-08-12 16:36:38 +00004159 assert( pKeyInfo->aSortFlags!=0 );
drha485ad12017-08-02 22:43:14 +00004160 assert( pKeyInfo->nKeyField>0 );
dan3b9330f2014-02-27 20:44:18 +00004161 assert( idx1<=szHdr1 || CORRUPT_DB );
4162 do{
4163 u32 serial_type1;
dan1fed5da2014-02-25 21:01:25 +00004164
dan3b9330f2014-02-27 20:44:18 +00004165 /* Read the serial types for the next element in each key. */
4166 idx1 += getVarint32( aKey1+idx1, serial_type1 );
dan1fed5da2014-02-25 21:01:25 +00004167
dan3b9330f2014-02-27 20:44:18 +00004168 /* Verify that there is enough key space remaining to avoid
4169 ** a buffer overread. The "d1+serial_type1+2" subexpression will
4170 ** always be greater than or equal to the amount of required key space.
4171 ** Use that approximation to avoid the more expensive call to
4172 ** sqlite3VdbeSerialTypeLen() in the common case.
4173 */
drha79bcf32019-01-12 21:30:26 +00004174 if( d1+(u64)serial_type1+2>(u64)nKey1
4175 && d1+(u64)sqlite3VdbeSerialTypeLen(serial_type1)>(u64)nKey1
dan3b9330f2014-02-27 20:44:18 +00004176 ){
4177 break;
dan1fed5da2014-02-25 21:01:25 +00004178 }
dan1fed5da2014-02-25 21:01:25 +00004179
dan3b9330f2014-02-27 20:44:18 +00004180 /* Extract the values to be compared.
4181 */
drh06164b22021-12-14 00:36:09 +00004182 sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
4183 d1 += sqlite3VdbeSerialTypeLen(serial_type1);
dan1fed5da2014-02-25 21:01:25 +00004184
dan3b9330f2014-02-27 20:44:18 +00004185 /* Do the comparison
4186 */
drh9b133652019-01-22 02:34:35 +00004187 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i],
4188 pKeyInfo->nAllField>i ? pKeyInfo->aColl[i] : 0);
dan3b9330f2014-02-27 20:44:18 +00004189 if( rc!=0 ){
drh17bcb102014-09-18 21:25:33 +00004190 assert( mem1.szMalloc==0 ); /* See comment below */
dan6e118922019-08-12 16:36:38 +00004191 if( (pKeyInfo->aSortFlags[i] & KEYINFO_ORDER_BIGNULL)
4192 && ((mem1.flags & MEM_Null) || (pPKey2->aMem[i].flags & MEM_Null))
4193 ){
4194 rc = -rc;
4195 }
4196 if( pKeyInfo->aSortFlags[i] & KEYINFO_ORDER_DESC ){
dan3b9330f2014-02-27 20:44:18 +00004197 rc = -rc; /* Invert the result for DESC sort order. */
dan1fed5da2014-02-25 21:01:25 +00004198 }
drh79211e12014-05-02 17:33:16 +00004199 goto debugCompareEnd;
dan1fed5da2014-02-25 21:01:25 +00004200 }
dan3b9330f2014-02-27 20:44:18 +00004201 i++;
4202 }while( idx1<szHdr1 && i<pPKey2->nField );
dan1fed5da2014-02-25 21:01:25 +00004203
dan3b9330f2014-02-27 20:44:18 +00004204 /* No memory allocation is ever used on mem1. Prove this using
4205 ** the following assert(). If the assert() fails, it indicates a
4206 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
4207 */
drh17bcb102014-09-18 21:25:33 +00004208 assert( mem1.szMalloc==0 );
dan3b9330f2014-02-27 20:44:18 +00004209
4210 /* rc==0 here means that one of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004211 ** all the fields up to that point were equal. Return the default_rc
dan3b9330f2014-02-27 20:44:18 +00004212 ** value. */
drh79211e12014-05-02 17:33:16 +00004213 rc = pPKey2->default_rc;
4214
4215debugCompareEnd:
4216 if( desiredResult==0 && rc==0 ) return 1;
4217 if( desiredResult<0 && rc<0 ) return 1;
4218 if( desiredResult>0 && rc>0 ) return 1;
4219 if( CORRUPT_DB ) return 1;
4220 if( pKeyInfo->db->mallocFailed ) return 1;
4221 return 0;
dan1fed5da2014-02-25 21:01:25 +00004222}
dan3833e932014-03-01 19:44:56 +00004223#endif
dan1fed5da2014-02-25 21:01:25 +00004224
drhd879e3e2017-02-13 13:35:55 +00004225#ifdef SQLITE_DEBUG
drhe1bb8022015-01-19 19:48:52 +00004226/*
4227** Count the number of fields (a.k.a. columns) in the record given by
4228** pKey,nKey. The verify that this count is less than or equal to the
drha485ad12017-08-02 22:43:14 +00004229** limit given by pKeyInfo->nAllField.
drhe1bb8022015-01-19 19:48:52 +00004230**
4231** If this constraint is not satisfied, it means that the high-speed
4232** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
4233** not work correctly. If this assert() ever fires, it probably means
drha485ad12017-08-02 22:43:14 +00004234** that the KeyInfo.nKeyField or KeyInfo.nAllField values were computed
drhe1bb8022015-01-19 19:48:52 +00004235** incorrectly.
4236*/
4237static void vdbeAssertFieldCountWithinLimits(
4238 int nKey, const void *pKey, /* The record to verify */
4239 const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
4240){
4241 int nField = 0;
4242 u32 szHdr;
4243 u32 idx;
4244 u32 notUsed;
4245 const unsigned char *aKey = (const unsigned char*)pKey;
4246
4247 if( CORRUPT_DB ) return;
4248 idx = getVarint32(aKey, szHdr);
mistachkin1b3ee492015-01-21 00:51:08 +00004249 assert( nKey>=0 );
4250 assert( szHdr<=(u32)nKey );
drhe1bb8022015-01-19 19:48:52 +00004251 while( idx<szHdr ){
4252 idx += getVarint32(aKey+idx, notUsed);
4253 nField++;
4254 }
drha485ad12017-08-02 22:43:14 +00004255 assert( nField <= pKeyInfo->nAllField );
drhe1bb8022015-01-19 19:48:52 +00004256}
drh1af3c642015-01-19 20:57:19 +00004257#else
4258# define vdbeAssertFieldCountWithinLimits(A,B,C)
drhe1bb8022015-01-19 19:48:52 +00004259#endif
4260
dan3833e932014-03-01 19:44:56 +00004261/*
4262** Both *pMem1 and *pMem2 contain string values. Compare the two values
4263** using the collation sequence pColl. As usual, return a negative , zero
4264** or positive value if *pMem1 is less than, equal to or greater than
4265** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
4266*/
dan1fed5da2014-02-25 21:01:25 +00004267static int vdbeCompareMemString(
dan3833e932014-03-01 19:44:56 +00004268 const Mem *pMem1,
4269 const Mem *pMem2,
dan38fdead2014-04-01 10:19:02 +00004270 const CollSeq *pColl,
4271 u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
dan1fed5da2014-02-25 21:01:25 +00004272){
4273 if( pMem1->enc==pColl->enc ){
4274 /* The strings are already in the correct encoding. Call the
4275 ** comparison function directly */
4276 return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
4277 }else{
4278 int rc;
4279 const void *v1, *v2;
dan1fed5da2014-02-25 21:01:25 +00004280 Mem c1;
4281 Mem c2;
drh17bcb102014-09-18 21:25:33 +00004282 sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
4283 sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
dan1fed5da2014-02-25 21:01:25 +00004284 sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
4285 sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
4286 v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
dan1fed5da2014-02-25 21:01:25 +00004287 v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
dan21766c02017-05-22 08:04:09 +00004288 if( (v1==0 || v2==0) ){
4289 if( prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
4290 rc = 0;
4291 }else{
4292 rc = pColl->xCmp(pColl->pUser, c1.n, v1, c2.n, v2);
4293 }
drhfc854502022-03-02 17:50:59 +00004294 sqlite3VdbeMemReleaseMalloc(&c1);
4295 sqlite3VdbeMemReleaseMalloc(&c2);
dan1fed5da2014-02-25 21:01:25 +00004296 return rc;
4297 }
4298}
4299
4300/*
drh64caee42016-09-09 19:33:00 +00004301** The input pBlob is guaranteed to be a Blob that is not marked
4302** with MEM_Zero. Return true if it could be a zero-blob.
4303*/
drh8aaf7bc2016-09-20 01:19:18 +00004304static int isAllZero(const char *z, int n){
drh64caee42016-09-09 19:33:00 +00004305 int i;
drh8aaf7bc2016-09-20 01:19:18 +00004306 for(i=0; i<n; i++){
4307 if( z[i] ) return 0;
4308 }
4309 return 1;
drh64caee42016-09-09 19:33:00 +00004310}
4311
4312/*
drh982ff722014-09-16 03:24:43 +00004313** Compare two blobs. Return negative, zero, or positive if the first
4314** is less than, equal to, or greater than the second, respectively.
4315** If one blob is a prefix of the other, then the shorter is the lessor.
4316*/
drh8d7b2122018-06-11 13:10:45 +00004317SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
drh64caee42016-09-09 19:33:00 +00004318 int c;
4319 int n1 = pB1->n;
4320 int n2 = pB2->n;
4321
4322 /* It is possible to have a Blob value that has some non-zero content
4323 ** followed by zero content. But that only comes up for Blobs formed
4324 ** by the OP_MakeRecord opcode, and such Blobs never get passed into
4325 ** sqlite3MemCompare(). */
4326 assert( (pB1->flags & MEM_Zero)==0 || n1==0 );
4327 assert( (pB2->flags & MEM_Zero)==0 || n2==0 );
4328
4329 if( (pB1->flags|pB2->flags) & MEM_Zero ){
4330 if( pB1->flags & pB2->flags & MEM_Zero ){
4331 return pB1->u.nZero - pB2->u.nZero;
4332 }else if( pB1->flags & MEM_Zero ){
drh8aaf7bc2016-09-20 01:19:18 +00004333 if( !isAllZero(pB2->z, pB2->n) ) return -1;
drh64caee42016-09-09 19:33:00 +00004334 return pB1->u.nZero - n2;
4335 }else{
drh8aaf7bc2016-09-20 01:19:18 +00004336 if( !isAllZero(pB1->z, pB1->n) ) return +1;
drh64caee42016-09-09 19:33:00 +00004337 return n1 - pB2->u.nZero;
4338 }
4339 }
4340 c = memcmp(pB1->z, pB2->z, n1>n2 ? n2 : n1);
drh982ff722014-09-16 03:24:43 +00004341 if( c ) return c;
drh64caee42016-09-09 19:33:00 +00004342 return n1 - n2;
drh982ff722014-09-16 03:24:43 +00004343}
4344
drh2ab410a2015-11-06 14:59:07 +00004345/*
4346** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
4347** number. Return negative, zero, or positive if the first (i64) is less than,
4348** equal to, or greater than the second (double).
4349*/
drhde324612021-07-19 20:52:31 +00004350int sqlite3IntFloatCompare(i64 i, double r){
drh2ab410a2015-11-06 14:59:07 +00004351 if( sizeof(LONGDOUBLE_TYPE)>8 ){
4352 LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
drhde9873b2020-11-23 21:05:29 +00004353 testcase( x<r );
4354 testcase( x>r );
4355 testcase( x==r );
drh2ab410a2015-11-06 14:59:07 +00004356 if( x<r ) return -1;
drhde9873b2020-11-23 21:05:29 +00004357 if( x>r ) return +1; /*NO_TEST*/ /* work around bugs in gcov */
4358 return 0; /*NO_TEST*/ /* work around bugs in gcov */
drh2ab410a2015-11-06 14:59:07 +00004359 }else{
4360 i64 y;
4361 double s;
4362 if( r<-9223372036854775808.0 ) return +1;
drh6c319e12018-05-18 13:39:00 +00004363 if( r>=9223372036854775808.0 ) return -1;
drh2ab410a2015-11-06 14:59:07 +00004364 y = (i64)r;
4365 if( i<y ) return -1;
drh6c319e12018-05-18 13:39:00 +00004366 if( i>y ) return +1;
drh2ab410a2015-11-06 14:59:07 +00004367 s = (double)i;
4368 if( s<r ) return -1;
4369 if( s>r ) return +1;
4370 return 0;
4371 }
4372}
drh982ff722014-09-16 03:24:43 +00004373
4374/*
dan1fed5da2014-02-25 21:01:25 +00004375** Compare the values contained by the two memory cells, returning
4376** negative, zero or positive if pMem1 is less than, equal to, or greater
4377** than pMem2. Sorting order is NULL's first, followed by numbers (integers
4378** and reals) sorted numerically, followed by text ordered by the collating
4379** sequence pColl and finally blob's ordered by memcmp().
4380**
4381** Two NULL values are considered equal by this function.
4382*/
4383int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
dan1fed5da2014-02-25 21:01:25 +00004384 int f1, f2;
4385 int combined_flags;
4386
4387 f1 = pMem1->flags;
4388 f2 = pMem2->flags;
4389 combined_flags = f1|f2;
drh9d67afc2018-08-29 20:24:03 +00004390 assert( !sqlite3VdbeMemIsRowSet(pMem1) && !sqlite3VdbeMemIsRowSet(pMem2) );
dan1fed5da2014-02-25 21:01:25 +00004391
4392 /* If one value is NULL, it is less than the other. If both values
4393 ** are NULL, return 0.
4394 */
4395 if( combined_flags&MEM_Null ){
4396 return (f2&MEM_Null) - (f1&MEM_Null);
4397 }
4398
drh2ab410a2015-11-06 14:59:07 +00004399 /* At least one of the two values is a number
dan1fed5da2014-02-25 21:01:25 +00004400 */
drh169f0772019-05-02 21:36:26 +00004401 if( combined_flags&(MEM_Int|MEM_Real|MEM_IntReal) ){
drh3242c692019-05-04 01:29:13 +00004402 testcase( combined_flags & MEM_Int );
4403 testcase( combined_flags & MEM_Real );
4404 testcase( combined_flags & MEM_IntReal );
drh169f0772019-05-02 21:36:26 +00004405 if( (f1 & f2 & (MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004406 testcase( f1 & f2 & MEM_Int );
4407 testcase( f1 & f2 & MEM_IntReal );
dan1fed5da2014-02-25 21:01:25 +00004408 if( pMem1->u.i < pMem2->u.i ) return -1;
drh2ab410a2015-11-06 14:59:07 +00004409 if( pMem1->u.i > pMem2->u.i ) return +1;
dan1fed5da2014-02-25 21:01:25 +00004410 return 0;
4411 }
drh2ab410a2015-11-06 14:59:07 +00004412 if( (f1 & f2 & MEM_Real)!=0 ){
4413 if( pMem1->u.r < pMem2->u.r ) return -1;
4414 if( pMem1->u.r > pMem2->u.r ) return +1;
4415 return 0;
4416 }
drh169f0772019-05-02 21:36:26 +00004417 if( (f1&(MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004418 testcase( f1 & MEM_Int );
4419 testcase( f1 & MEM_IntReal );
drh2ab410a2015-11-06 14:59:07 +00004420 if( (f2&MEM_Real)!=0 ){
4421 return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
drh169f0772019-05-02 21:36:26 +00004422 }else if( (f2&(MEM_Int|MEM_IntReal))!=0 ){
4423 if( pMem1->u.i < pMem2->u.i ) return -1;
4424 if( pMem1->u.i > pMem2->u.i ) return +1;
4425 return 0;
drh2ab410a2015-11-06 14:59:07 +00004426 }else{
4427 return -1;
4428 }
4429 }
dan1fed5da2014-02-25 21:01:25 +00004430 if( (f1&MEM_Real)!=0 ){
drh169f0772019-05-02 21:36:26 +00004431 if( (f2&(MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004432 testcase( f2 & MEM_Int );
4433 testcase( f2 & MEM_IntReal );
drh2ab410a2015-11-06 14:59:07 +00004434 return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
4435 }else{
4436 return -1;
4437 }
dan1fed5da2014-02-25 21:01:25 +00004438 }
drh2ab410a2015-11-06 14:59:07 +00004439 return +1;
dan1fed5da2014-02-25 21:01:25 +00004440 }
4441
4442 /* If one value is a string and the other is a blob, the string is less.
4443 ** If both are strings, compare using the collating functions.
4444 */
4445 if( combined_flags&MEM_Str ){
4446 if( (f1 & MEM_Str)==0 ){
4447 return 1;
4448 }
4449 if( (f2 & MEM_Str)==0 ){
4450 return -1;
4451 }
4452
drhe5520e22015-12-31 04:34:26 +00004453 assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
dan1fed5da2014-02-25 21:01:25 +00004454 assert( pMem1->enc==SQLITE_UTF8 ||
4455 pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
4456
4457 /* The collation sequence must be defined at this point, even if
4458 ** the user deletes the collation sequence after the vdbe program is
4459 ** compiled (this was not always the case).
4460 */
4461 assert( !pColl || pColl->xCmp );
4462
4463 if( pColl ){
dan38fdead2014-04-01 10:19:02 +00004464 return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
dan1fed5da2014-02-25 21:01:25 +00004465 }
4466 /* If a NULL pointer was passed as the collate function, fall through
4467 ** to the blob case and use memcmp(). */
4468 }
4469
4470 /* Both values must be blobs. Compare using memcmp(). */
drh982ff722014-09-16 03:24:43 +00004471 return sqlite3BlobCompare(pMem1, pMem2);
dan1fed5da2014-02-25 21:01:25 +00004472}
4473
4474
dan3833e932014-03-01 19:44:56 +00004475/*
4476** The first argument passed to this function is a serial-type that
4477** corresponds to an integer - all values between 1 and 9 inclusive
4478** except 7. The second points to a buffer containing an integer value
4479** serialized according to serial_type. This function deserializes
4480** and returns the value.
4481*/
dan3b9330f2014-02-27 20:44:18 +00004482static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
drhf926d1e2014-03-04 04:04:33 +00004483 u32 y;
dan3833e932014-03-01 19:44:56 +00004484 assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
dan3b9330f2014-02-27 20:44:18 +00004485 switch( serial_type ){
dan3833e932014-03-01 19:44:56 +00004486 case 0:
dan3b9330f2014-02-27 20:44:18 +00004487 case 1:
drhb6e8fd12014-03-06 01:56:33 +00004488 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004489 return ONE_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00004490 case 2:
drhb6e8fd12014-03-06 01:56:33 +00004491 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004492 return TWO_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00004493 case 3:
drhb6e8fd12014-03-06 01:56:33 +00004494 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004495 return THREE_BYTE_INT(aKey);
4496 case 4: {
drhb6e8fd12014-03-06 01:56:33 +00004497 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004498 y = FOUR_BYTE_UINT(aKey);
4499 return (i64)*(int*)&y;
4500 }
dan3b9330f2014-02-27 20:44:18 +00004501 case 5: {
drhb6e8fd12014-03-06 01:56:33 +00004502 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004503 return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhaf5b2af2013-08-05 15:32:09 +00004504 }
dan3b9330f2014-02-27 20:44:18 +00004505 case 6: {
drhf926d1e2014-03-04 04:04:33 +00004506 u64 x = FOUR_BYTE_UINT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004507 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004508 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4509 return (i64)*(i64*)&x;
drh1e968a02008-03-25 00:22:21 +00004510 }
dan3b9330f2014-02-27 20:44:18 +00004511 }
drh407414c2009-07-14 14:15:27 +00004512
dan3b9330f2014-02-27 20:44:18 +00004513 return (serial_type - 8);
drh1e968a02008-03-25 00:22:21 +00004514}
danielk1977eb015e02004-05-18 01:31:14 +00004515
dan3833e932014-03-01 19:44:56 +00004516/*
4517** This function compares the two table rows or index records
4518** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
4519** or positive integer if key1 is less than, equal to or
4520** greater than key2. The {nKey1, pKey1} key must be a blob
peter.d.reid60ec9142014-09-06 16:39:46 +00004521** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
dan3833e932014-03-01 19:44:56 +00004522** key must be a parsed key such as obtained from
4523** sqlite3VdbeParseRecord.
4524**
4525** If argument bSkip is non-zero, it is assumed that the caller has already
4526** determined that the first fields of the keys are equal.
4527**
4528** Key1 and Key2 do not have to contain the same number of fields. If all
4529** fields that appear in both keys are equal, then pPKey2->default_rc is
4530** returned.
drha1f7c0a2014-03-28 03:12:48 +00004531**
dan38fdead2014-04-01 10:19:02 +00004532** If database corruption is discovered, set pPKey2->errCode to
4533** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
4534** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
4535** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
dan3833e932014-03-01 19:44:56 +00004536*/
dan7004f3f2015-03-30 12:06:26 +00004537int sqlite3VdbeRecordCompareWithSkip(
dan3833e932014-03-01 19:44:56 +00004538 int nKey1, const void *pKey1, /* Left key */
drha1f7c0a2014-03-28 03:12:48 +00004539 UnpackedRecord *pPKey2, /* Right key */
dan3833e932014-03-01 19:44:56 +00004540 int bSkip /* If true, skip the first field */
dan1fed5da2014-02-25 21:01:25 +00004541){
dan3833e932014-03-01 19:44:56 +00004542 u32 d1; /* Offset into aKey[] of next data element */
4543 int i; /* Index of next field to compare */
mistachkinffe6bc22014-03-04 11:16:20 +00004544 u32 szHdr1; /* Size of record header in bytes */
dan3833e932014-03-01 19:44:56 +00004545 u32 idx1; /* Offset of first type in header */
4546 int rc = 0; /* Return value */
4547 Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
drh6eb34802018-06-06 20:55:10 +00004548 KeyInfo *pKeyInfo;
dan1fed5da2014-02-25 21:01:25 +00004549 const unsigned char *aKey1 = (const unsigned char *)pKey1;
4550 Mem mem1;
4551
dan3833e932014-03-01 19:44:56 +00004552 /* If bSkip is true, then the caller has already determined that the first
4553 ** two elements in the keys are equal. Fix the various stack variables so
dan3b9330f2014-02-27 20:44:18 +00004554 ** that this routine begins comparing at the second field. */
dan3833e932014-03-01 19:44:56 +00004555 if( bSkip ){
drhc2808f32022-04-02 22:47:47 +00004556 u32 s1 = aKey1[1];
4557 if( s1<0x80 ){
4558 idx1 = 2;
4559 }else{
4560 idx1 = 1 + sqlite3GetVarint32(&aKey1[1], &s1);
4561 }
dan3833e932014-03-01 19:44:56 +00004562 szHdr1 = aKey1[0];
4563 d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
dan3b9330f2014-02-27 20:44:18 +00004564 i = 1;
4565 pRhs++;
dan3833e932014-03-01 19:44:56 +00004566 }else{
drhc2808f32022-04-02 22:47:47 +00004567 if( (szHdr1 = aKey1[0])<0x80 ){
4568 idx1 = 1;
4569 }else{
4570 idx1 = sqlite3GetVarint32(aKey1, &szHdr1);
4571 }
dan3833e932014-03-01 19:44:56 +00004572 d1 = szHdr1;
4573 i = 0;
dan3b9330f2014-02-27 20:44:18 +00004574 }
drh2a58dbd2019-01-11 16:44:16 +00004575 if( d1>(unsigned)nKey1 ){
4576 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
4577 return 0; /* Corruption */
4578 }
dan3b9330f2014-02-27 20:44:18 +00004579
drh17bcb102014-09-18 21:25:33 +00004580 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drha485ad12017-08-02 22:43:14 +00004581 assert( pPKey2->pKeyInfo->nAllField>=pPKey2->nField
dan1fed5da2014-02-25 21:01:25 +00004582 || CORRUPT_DB );
dan6e118922019-08-12 16:36:38 +00004583 assert( pPKey2->pKeyInfo->aSortFlags!=0 );
drha485ad12017-08-02 22:43:14 +00004584 assert( pPKey2->pKeyInfo->nKeyField>0 );
dan1fed5da2014-02-25 21:01:25 +00004585 assert( idx1<=szHdr1 || CORRUPT_DB );
4586 do{
dan1fed5da2014-02-25 21:01:25 +00004587 u32 serial_type;
4588
4589 /* RHS is an integer */
drh169f0772019-05-02 21:36:26 +00004590 if( pRhs->flags & (MEM_Int|MEM_IntReal) ){
drh3242c692019-05-04 01:29:13 +00004591 testcase( pRhs->flags & MEM_Int );
4592 testcase( pRhs->flags & MEM_IntReal );
dan1fed5da2014-02-25 21:01:25 +00004593 serial_type = aKey1[idx1];
drhb6e8fd12014-03-06 01:56:33 +00004594 testcase( serial_type==12 );
danb95e1192015-05-26 20:31:20 +00004595 if( serial_type>=10 ){
dan1fed5da2014-02-25 21:01:25 +00004596 rc = +1;
4597 }else if( serial_type==0 ){
4598 rc = -1;
dan3b9330f2014-02-27 20:44:18 +00004599 }else if( serial_type==7 ){
dan1fed5da2014-02-25 21:01:25 +00004600 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
drh2ab410a2015-11-06 14:59:07 +00004601 rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
dan3b9330f2014-02-27 20:44:18 +00004602 }else{
4603 i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
4604 i64 rhs = pRhs->u.i;
4605 if( lhs<rhs ){
4606 rc = -1;
4607 }else if( lhs>rhs ){
4608 rc = +1;
dan1fed5da2014-02-25 21:01:25 +00004609 }
4610 }
4611 }
4612
4613 /* RHS is real */
4614 else if( pRhs->flags & MEM_Real ){
4615 serial_type = aKey1[idx1];
dancc7aa1f2015-05-26 20:07:32 +00004616 if( serial_type>=10 ){
4617 /* Serial types 12 or greater are strings and blobs (greater than
4618 ** numbers). Types 10 and 11 are currently "reserved for future
4619 ** use", so it doesn't really matter what the results of comparing
4620 ** them to numberic values are. */
dan1fed5da2014-02-25 21:01:25 +00004621 rc = +1;
4622 }else if( serial_type==0 ){
4623 rc = -1;
4624 }else{
dan1fed5da2014-02-25 21:01:25 +00004625 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
4626 if( serial_type==7 ){
drh2ab410a2015-11-06 14:59:07 +00004627 if( mem1.u.r<pRhs->u.r ){
4628 rc = -1;
4629 }else if( mem1.u.r>pRhs->u.r ){
4630 rc = +1;
4631 }
dan1fed5da2014-02-25 21:01:25 +00004632 }else{
drh2ab410a2015-11-06 14:59:07 +00004633 rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
dan1fed5da2014-02-25 21:01:25 +00004634 }
4635 }
4636 }
4637
4638 /* RHS is a string */
4639 else if( pRhs->flags & MEM_Str ){
drh02a95eb2020-01-28 20:27:42 +00004640 getVarint32NR(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004641 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004642 if( serial_type<12 ){
4643 rc = -1;
4644 }else if( !(serial_type & 0x01) ){
4645 rc = +1;
4646 }else{
4647 mem1.n = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004648 testcase( (d1+mem1.n)==(unsigned)nKey1 );
4649 testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
drh9b133652019-01-22 02:34:35 +00004650 if( (d1+mem1.n) > (unsigned)nKey1
4651 || (pKeyInfo = pPKey2->pKeyInfo)->nAllField<=i
4652 ){
dan38fdead2014-04-01 10:19:02 +00004653 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004654 return 0; /* Corruption */
drh9b133652019-01-22 02:34:35 +00004655 }else if( pKeyInfo->aColl[i] ){
dan1fed5da2014-02-25 21:01:25 +00004656 mem1.enc = pKeyInfo->enc;
4657 mem1.db = pKeyInfo->db;
4658 mem1.flags = MEM_Str;
drhfcb44a82014-03-03 15:13:27 +00004659 mem1.z = (char*)&aKey1[d1];
dan38fdead2014-04-01 10:19:02 +00004660 rc = vdbeCompareMemString(
4661 &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
4662 );
dan1fed5da2014-02-25 21:01:25 +00004663 }else{
4664 int nCmp = MIN(mem1.n, pRhs->n);
4665 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4666 if( rc==0 ) rc = mem1.n - pRhs->n;
4667 }
4668 }
4669 }
4670
4671 /* RHS is a blob */
4672 else if( pRhs->flags & MEM_Blob ){
drh8aaf7bc2016-09-20 01:19:18 +00004673 assert( (pRhs->flags & MEM_Zero)==0 || pRhs->n==0 );
drh02a95eb2020-01-28 20:27:42 +00004674 getVarint32NR(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004675 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004676 if( serial_type<12 || (serial_type & 0x01) ){
4677 rc = -1;
4678 }else{
4679 int nStr = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004680 testcase( (d1+nStr)==(unsigned)nKey1 );
4681 testcase( (d1+nStr+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004682 if( (d1+nStr) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004683 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004684 return 0; /* Corruption */
drh8aaf7bc2016-09-20 01:19:18 +00004685 }else if( pRhs->flags & MEM_Zero ){
4686 if( !isAllZero((const char*)&aKey1[d1],nStr) ){
4687 rc = 1;
4688 }else{
4689 rc = nStr - pRhs->u.nZero;
4690 }
dan1fed5da2014-02-25 21:01:25 +00004691 }else{
4692 int nCmp = MIN(nStr, pRhs->n);
4693 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4694 if( rc==0 ) rc = nStr - pRhs->n;
4695 }
4696 }
4697 }
4698
4699 /* RHS is null */
4700 else{
4701 serial_type = aKey1[idx1];
4702 rc = (serial_type!=0);
4703 }
4704
4705 if( rc!=0 ){
dan6e118922019-08-12 16:36:38 +00004706 int sortFlags = pPKey2->pKeyInfo->aSortFlags[i];
4707 if( sortFlags ){
4708 if( (sortFlags & KEYINFO_ORDER_BIGNULL)==0
4709 || ((sortFlags & KEYINFO_ORDER_DESC)
4710 !=(serial_type==0 || (pRhs->flags&MEM_Null)))
4711 ){
4712 rc = -rc;
4713 }
dan1fed5da2014-02-25 21:01:25 +00004714 }
drh79211e12014-05-02 17:33:16 +00004715 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
drh17bcb102014-09-18 21:25:33 +00004716 assert( mem1.szMalloc==0 ); /* See comment below */
dan1fed5da2014-02-25 21:01:25 +00004717 return rc;
4718 }
4719
4720 i++;
drhd8821082018-06-06 20:29:19 +00004721 if( i==pPKey2->nField ) break;
dan3b9330f2014-02-27 20:44:18 +00004722 pRhs++;
dan1fed5da2014-02-25 21:01:25 +00004723 d1 += sqlite3VdbeSerialTypeLen(serial_type);
4724 idx1 += sqlite3VarintLen(serial_type);
drhd8821082018-06-06 20:29:19 +00004725 }while( idx1<(unsigned)szHdr1 && d1<=(unsigned)nKey1 );
dan1fed5da2014-02-25 21:01:25 +00004726
4727 /* No memory allocation is ever used on mem1. Prove this using
4728 ** the following assert(). If the assert() fails, it indicates a
dan3833e932014-03-01 19:44:56 +00004729 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
drh17bcb102014-09-18 21:25:33 +00004730 assert( mem1.szMalloc==0 );
dan1fed5da2014-02-25 21:01:25 +00004731
4732 /* rc==0 here means that one or both of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004733 ** all the fields up to that point were equal. Return the default_rc
dan1fed5da2014-02-25 21:01:25 +00004734 ** value. */
dan3833e932014-03-01 19:44:56 +00004735 assert( CORRUPT_DB
drh66141812014-06-30 20:25:03 +00004736 || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
drh6eb34802018-06-06 20:55:10 +00004737 || pPKey2->pKeyInfo->db->mallocFailed
dan3833e932014-03-01 19:44:56 +00004738 );
drh70528d72015-11-05 20:25:09 +00004739 pPKey2->eqSeen = 1;
dan1fed5da2014-02-25 21:01:25 +00004740 return pPKey2->default_rc;
4741}
drh75179de2014-09-16 14:37:35 +00004742int sqlite3VdbeRecordCompare(
4743 int nKey1, const void *pKey1, /* Left key */
4744 UnpackedRecord *pPKey2 /* Right key */
4745){
dan7004f3f2015-03-30 12:06:26 +00004746 return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
drh75179de2014-09-16 14:37:35 +00004747}
4748
dan1fed5da2014-02-25 21:01:25 +00004749
dan3833e932014-03-01 19:44:56 +00004750/*
4751** This function is an optimized version of sqlite3VdbeRecordCompare()
4752** that (a) the first field of pPKey2 is an integer, and (b) the
4753** size-of-header varint at the start of (pKey1/nKey1) fits in a single
4754** byte (i.e. is less than 128).
drhe2ac5062014-03-26 12:02:38 +00004755**
4756** To avoid concerns about buffer overreads, this routine is only used
4757** on schemas where the maximum valid header size is 63 bytes or less.
dan3833e932014-03-01 19:44:56 +00004758*/
dan3b9330f2014-02-27 20:44:18 +00004759static int vdbeRecordCompareInt(
4760 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004761 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004762){
dan9b8afef2014-03-03 20:48:50 +00004763 const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
dan3b9330f2014-02-27 20:44:18 +00004764 int serial_type = ((const u8*)pKey1)[1];
4765 int res;
drhf926d1e2014-03-04 04:04:33 +00004766 u32 y;
4767 u64 x;
drh5f6eb1a2016-09-15 00:04:46 +00004768 i64 v;
dan3b9330f2014-02-27 20:44:18 +00004769 i64 lhs;
4770
drhe1bb8022015-01-19 19:48:52 +00004771 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drhe2ac5062014-03-26 12:02:38 +00004772 assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
dan3833e932014-03-01 19:44:56 +00004773 switch( serial_type ){
drhf926d1e2014-03-04 04:04:33 +00004774 case 1: { /* 1-byte signed integer */
4775 lhs = ONE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004776 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004777 break;
4778 }
drhf926d1e2014-03-04 04:04:33 +00004779 case 2: { /* 2-byte signed integer */
4780 lhs = TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004781 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004782 break;
4783 }
4784 case 3: { /* 3-byte signed integer */
4785 lhs = THREE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004786 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004787 break;
4788 }
4789 case 4: { /* 4-byte signed integer */
4790 y = FOUR_BYTE_UINT(aKey);
4791 lhs = (i64)*(int*)&y;
drhb6e8fd12014-03-06 01:56:33 +00004792 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004793 break;
4794 }
4795 case 5: { /* 6-byte signed integer */
4796 lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004797 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004798 break;
4799 }
4800 case 6: { /* 8-byte signed integer */
4801 x = FOUR_BYTE_UINT(aKey);
4802 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4803 lhs = *(i64*)&x;
drhb6e8fd12014-03-06 01:56:33 +00004804 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004805 break;
4806 }
dan3b9330f2014-02-27 20:44:18 +00004807 case 8:
4808 lhs = 0;
4809 break;
dan3b9330f2014-02-27 20:44:18 +00004810 case 9:
4811 lhs = 1;
4812 break;
4813
dan063d4a02014-02-28 09:48:30 +00004814 /* This case could be removed without changing the results of running
4815 ** this code. Including it causes gcc to generate a faster switch
4816 ** statement (since the range of switch targets now starts at zero and
dan597515d2014-02-28 18:39:51 +00004817 ** is contiguous) but does not cause any duplicate code to be generated
dan063d4a02014-02-28 09:48:30 +00004818 ** (as gcc is clever enough to combine the two like cases). Other
4819 ** compilers might be similar. */
4820 case 0: case 7:
drh75179de2014-09-16 14:37:35 +00004821 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan063d4a02014-02-28 09:48:30 +00004822
dan3b9330f2014-02-27 20:44:18 +00004823 default:
drh75179de2014-09-16 14:37:35 +00004824 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan3b9330f2014-02-27 20:44:18 +00004825 }
4826
drhf357caf2022-02-27 21:10:49 +00004827 assert( pPKey2->u.i == pPKey2->aMem[0].u.i );
4828 v = pPKey2->u.i;
dan3b9330f2014-02-27 20:44:18 +00004829 if( v>lhs ){
4830 res = pPKey2->r1;
4831 }else if( v<lhs ){
4832 res = pPKey2->r2;
4833 }else if( pPKey2->nField>1 ){
dan063d4a02014-02-28 09:48:30 +00004834 /* The first fields of the two keys are equal. Compare the trailing
4835 ** fields. */
dan7004f3f2015-03-30 12:06:26 +00004836 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004837 }else{
dan063d4a02014-02-28 09:48:30 +00004838 /* The first fields of the two keys are equal and there are no trailing
4839 ** fields. Return pPKey2->default_rc in this case. */
dan3b9330f2014-02-27 20:44:18 +00004840 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004841 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004842 }
4843
drh79211e12014-05-02 17:33:16 +00004844 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
dan3b9330f2014-02-27 20:44:18 +00004845 return res;
4846}
4847
dan3833e932014-03-01 19:44:56 +00004848/*
4849** This function is an optimized version of sqlite3VdbeRecordCompare()
4850** that (a) the first field of pPKey2 is a string, that (b) the first field
4851** uses the collation sequence BINARY and (c) that the size-of-header varint
4852** at the start of (pKey1/nKey1) fits in a single byte.
4853*/
dan3b9330f2014-02-27 20:44:18 +00004854static int vdbeRecordCompareString(
4855 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004856 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004857){
4858 const u8 *aKey1 = (const u8*)pKey1;
4859 int serial_type;
4860 int res;
4861
drh2ab410a2015-11-06 14:59:07 +00004862 assert( pPKey2->aMem[0].flags & MEM_Str );
drhf357caf2022-02-27 21:10:49 +00004863 assert( pPKey2->aMem[0].n == pPKey2->n );
4864 assert( pPKey2->aMem[0].z == pPKey2->u.z );
drhe1bb8022015-01-19 19:48:52 +00004865 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drha1e951f2022-02-27 18:54:33 +00004866 serial_type = (signed char)(aKey1[1]);
4867
4868vrcs_restart:
dan3b9330f2014-02-27 20:44:18 +00004869 if( serial_type<12 ){
drha1e951f2022-02-27 18:54:33 +00004870 if( serial_type<0 ){
4871 sqlite3GetVarint32(&aKey1[1], (u32*)&serial_type);
4872 if( serial_type>=12 ) goto vrcs_restart;
4873 assert( CORRUPT_DB );
4874 }
dan3b9330f2014-02-27 20:44:18 +00004875 res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
4876 }else if( !(serial_type & 0x01) ){
4877 res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
4878 }else{
4879 int nCmp;
4880 int nStr;
dan3833e932014-03-01 19:44:56 +00004881 int szHdr = aKey1[0];
dan3b9330f2014-02-27 20:44:18 +00004882
4883 nStr = (serial_type-12) / 2;
drha1f7c0a2014-03-28 03:12:48 +00004884 if( (szHdr + nStr) > nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004885 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004886 return 0; /* Corruption */
4887 }
drhf357caf2022-02-27 21:10:49 +00004888 nCmp = MIN( pPKey2->n, nStr );
4889 res = memcmp(&aKey1[szHdr], pPKey2->u.z, nCmp);
dan3b9330f2014-02-27 20:44:18 +00004890
dan52d9a3c2019-07-12 15:15:43 +00004891 if( res>0 ){
4892 res = pPKey2->r2;
4893 }else if( res<0 ){
4894 res = pPKey2->r1;
4895 }else{
drhf357caf2022-02-27 21:10:49 +00004896 res = nStr - pPKey2->n;
dan3b9330f2014-02-27 20:44:18 +00004897 if( res==0 ){
4898 if( pPKey2->nField>1 ){
dan7004f3f2015-03-30 12:06:26 +00004899 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004900 }else{
4901 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004902 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004903 }
4904 }else if( res>0 ){
4905 res = pPKey2->r2;
4906 }else{
4907 res = pPKey2->r1;
4908 }
dan3b9330f2014-02-27 20:44:18 +00004909 }
4910 }
4911
drh66141812014-06-30 20:25:03 +00004912 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
dan3b9330f2014-02-27 20:44:18 +00004913 || CORRUPT_DB
dan6696ba32014-06-28 19:06:49 +00004914 || pPKey2->pKeyInfo->db->mallocFailed
dan3b9330f2014-02-27 20:44:18 +00004915 );
4916 return res;
4917}
4918
dan3833e932014-03-01 19:44:56 +00004919/*
4920** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
4921** suitable for comparing serialized records to the unpacked record passed
4922** as the only argument.
4923*/
dan1fed5da2014-02-25 21:01:25 +00004924RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
dan9b8afef2014-03-03 20:48:50 +00004925 /* varintRecordCompareInt() and varintRecordCompareString() both assume
4926 ** that the size-of-header varint that occurs at the start of each record
4927 ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
4928 ** also assumes that it is safe to overread a buffer by at least the
4929 ** maximum possible legal header size plus 8 bytes. Because there is
4930 ** guaranteed to be at least 74 (but not 136) bytes of padding following each
4931 ** buffer passed to varintRecordCompareInt() this makes it convenient to
4932 ** limit the size of the header to 64 bytes in cases where the first field
4933 ** is an integer.
4934 **
4935 ** The easiest way to enforce this limit is to consider only records with
4936 ** 13 fields or less. If the first field is an integer, the maximum legal
4937 ** header size is (12*5 + 1 + 1) bytes. */
drha485ad12017-08-02 22:43:14 +00004938 if( p->pKeyInfo->nAllField<=13 ){
dan1fed5da2014-02-25 21:01:25 +00004939 int flags = p->aMem[0].flags;
dan6e118922019-08-12 16:36:38 +00004940 if( p->pKeyInfo->aSortFlags[0] ){
4941 if( p->pKeyInfo->aSortFlags[0] & KEYINFO_ORDER_BIGNULL ){
4942 return sqlite3VdbeRecordCompare;
4943 }
dan3b9330f2014-02-27 20:44:18 +00004944 p->r1 = 1;
4945 p->r2 = -1;
4946 }else{
4947 p->r1 = -1;
4948 p->r2 = 1;
4949 }
dan1fed5da2014-02-25 21:01:25 +00004950 if( (flags & MEM_Int) ){
drhf357caf2022-02-27 21:10:49 +00004951 p->u.i = p->aMem[0].u.i;
dan1fed5da2014-02-25 21:01:25 +00004952 return vdbeRecordCompareInt;
dan3b9330f2014-02-27 20:44:18 +00004953 }
drhb6e8fd12014-03-06 01:56:33 +00004954 testcase( flags & MEM_Real );
4955 testcase( flags & MEM_Null );
4956 testcase( flags & MEM_Blob );
drh169f0772019-05-02 21:36:26 +00004957 if( (flags & (MEM_Real|MEM_IntReal|MEM_Null|MEM_Blob))==0
4958 && p->pKeyInfo->aColl[0]==0
4959 ){
drhb6e8fd12014-03-06 01:56:33 +00004960 assert( flags & MEM_Str );
drhf357caf2022-02-27 21:10:49 +00004961 p->u.z = p->aMem[0].z;
4962 p->n = p->aMem[0].n;
dan1fed5da2014-02-25 21:01:25 +00004963 return vdbeRecordCompareString;
4964 }
4965 }
dan3b9330f2014-02-27 20:44:18 +00004966
dan3833e932014-03-01 19:44:56 +00004967 return sqlite3VdbeRecordCompare;
dan3b9330f2014-02-27 20:44:18 +00004968}
dan1fed5da2014-02-25 21:01:25 +00004969
danielk1977eb015e02004-05-18 01:31:14 +00004970/*
drh7a224de2004-06-02 01:22:02 +00004971** pCur points at an index entry created using the OP_MakeRecord opcode.
4972** Read the rowid (the last field in the record) and store it in *rowid.
4973** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00004974**
4975** pCur might be pointing to text obtained from a corrupt database file.
4976** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00004977*/
drhd3b74202014-09-17 16:41:15 +00004978int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00004979 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00004980 int rc;
drhd5788202004-05-28 08:21:05 +00004981 u32 szHdr; /* Size of the header */
4982 u32 typeRowid; /* Serial type of the rowid */
4983 u32 lenRowid; /* Size of the rowid */
4984 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00004985
drh88a003e2008-12-11 16:17:03 +00004986 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00004987 ** than 2GiB are support - anything large must be database corruption.
4988 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00004989 ** this code can safely assume that nCellKey is 32-bits
4990 */
drhea8ffdf2009-07-22 00:35:23 +00004991 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00004992 nCellKey = sqlite3BtreePayloadSize(pCur);
drh7b746032009-06-26 12:15:22 +00004993 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00004994
4995 /* Read in the complete content of the index entry */
drhd3b74202014-09-17 16:41:15 +00004996 sqlite3VdbeMemInit(&m, db, 0);
drh2a740062020-02-05 18:28:17 +00004997 rc = sqlite3VdbeMemFromBtreeZeroOffset(pCur, (u32)nCellKey, &m);
drhd5788202004-05-28 08:21:05 +00004998 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00004999 return rc;
5000 }
drh88a003e2008-12-11 16:17:03 +00005001
5002 /* The index entry must begin with a header size */
drh02a95eb2020-01-28 20:27:42 +00005003 getVarint32NR((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00005004 testcase( szHdr==3 );
mistachkin2b5fbb22021-12-31 18:26:50 +00005005 testcase( szHdr==(u32)m.n );
drh44d06852018-10-01 13:54:30 +00005006 testcase( szHdr>0x7fffffff );
5007 assert( m.n>=0 );
5008 if( unlikely(szHdr<3 || szHdr>(unsigned)m.n) ){
drh88a003e2008-12-11 16:17:03 +00005009 goto idx_rowid_corruption;
5010 }
5011
5012 /* The last field of the index should be an integer - the ROWID.
5013 ** Verify that the last entry really is an integer. */
drh02a95eb2020-01-28 20:27:42 +00005014 getVarint32NR((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00005015 testcase( typeRowid==1 );
5016 testcase( typeRowid==2 );
5017 testcase( typeRowid==3 );
5018 testcase( typeRowid==4 );
5019 testcase( typeRowid==5 );
5020 testcase( typeRowid==6 );
5021 testcase( typeRowid==8 );
5022 testcase( typeRowid==9 );
5023 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
5024 goto idx_rowid_corruption;
5025 }
drhc5ef7152015-06-28 02:58:51 +00005026 lenRowid = sqlite3SmallTypeSizes[typeRowid];
drheeb844a2009-08-08 18:01:07 +00005027 testcase( (u32)m.n==szHdr+lenRowid );
5028 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00005029 goto idx_rowid_corruption;
5030 }
5031
5032 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00005033 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00005034 *rowid = v.u.i;
drhfc854502022-03-02 17:50:59 +00005035 sqlite3VdbeMemReleaseMalloc(&m);
danielk1977183f9f72004-05-13 05:20:26 +00005036 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00005037
5038 /* Jump here if database corruption is detected after m has been
5039 ** allocated. Free the m object and return SQLITE_CORRUPT. */
5040idx_rowid_corruption:
drh17bcb102014-09-18 21:25:33 +00005041 testcase( m.szMalloc!=0 );
drhfc854502022-03-02 17:50:59 +00005042 sqlite3VdbeMemReleaseMalloc(&m);
drh88a003e2008-12-11 16:17:03 +00005043 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00005044}
5045
drh7cf6e4d2004-05-19 14:56:55 +00005046/*
drh5f82e3c2009-07-06 00:44:08 +00005047** Compare the key of the index entry that cursor pC is pointing to against
5048** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00005049** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00005050** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00005051**
drh5f82e3c2009-07-06 00:44:08 +00005052** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00005053** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00005054** is ignored as well. Hence, this routine only compares the prefixes
5055** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00005056*/
danielk1977183f9f72004-05-13 05:20:26 +00005057int sqlite3VdbeIdxKeyCompare(
drhd3b74202014-09-17 16:41:15 +00005058 sqlite3 *db, /* Database connection */
drh295aedf2014-03-03 18:25:24 +00005059 VdbeCursor *pC, /* The cursor to compare against */
drha1f7c0a2014-03-28 03:12:48 +00005060 UnpackedRecord *pUnpacked, /* Unpacked version of key */
drh295aedf2014-03-03 18:25:24 +00005061 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00005062){
drh61fc5952007-04-01 23:49:51 +00005063 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00005064 int rc;
drhc960dcb2015-11-20 19:22:01 +00005065 BtCursor *pCur;
drhd5788202004-05-28 08:21:05 +00005066 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00005067
drhc960dcb2015-11-20 19:22:01 +00005068 assert( pC->eCurType==CURTYPE_BTREE );
5069 pCur = pC->uc.pCursor;
drhea8ffdf2009-07-22 00:35:23 +00005070 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00005071 nCellKey = sqlite3BtreePayloadSize(pCur);
drh56689692014-03-03 19:29:28 +00005072 /* nCellKey will always be between 0 and 0xffffffff because of the way
drh407414c2009-07-14 14:15:27 +00005073 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00005074 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00005075 *res = 0;
drh9978c972010-02-23 17:36:32 +00005076 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00005077 }
drhd3b74202014-09-17 16:41:15 +00005078 sqlite3VdbeMemInit(&m, db, 0);
drh2a740062020-02-05 18:28:17 +00005079 rc = sqlite3VdbeMemFromBtreeZeroOffset(pCur, (u32)nCellKey, &m);
drhec1fc802008-08-13 14:07:40 +00005080 if( rc ){
drhd5788202004-05-28 08:21:05 +00005081 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00005082 }
drh6eb34802018-06-06 20:55:10 +00005083 *res = sqlite3VdbeRecordCompareWithSkip(m.n, m.z, pUnpacked, 0);
drhfc854502022-03-02 17:50:59 +00005084 sqlite3VdbeMemReleaseMalloc(&m);
danielk1977183f9f72004-05-13 05:20:26 +00005085 return SQLITE_OK;
5086}
danielk1977b28af712004-06-21 06:50:26 +00005087
5088/*
5089** This routine sets the value to be returned by subsequent calls to
5090** sqlite3_changes() on the database handle 'db'.
5091*/
dan2c718872021-06-22 18:32:05 +00005092void sqlite3VdbeSetChanges(sqlite3 *db, i64 nChange){
drhb21c8cd2007-08-21 19:33:56 +00005093 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00005094 db->nChange = nChange;
5095 db->nTotalChange += nChange;
5096}
5097
5098/*
5099** Set a flag in the vdbe to update the change counter when it is finalised
5100** or reset.
5101*/
drh4794f732004-11-05 17:17:50 +00005102void sqlite3VdbeCountChanges(Vdbe *v){
5103 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00005104}
drhd89bd002005-01-22 03:03:54 +00005105
5106/*
5107** Mark every prepared statement associated with a database connection
5108** as expired.
5109**
5110** An expired statement means that recompilation of the statement is
5111** recommend. Statements expire when things happen that make their
5112** programs obsolete. Removing user-defined functions or collating
5113** sequences, or changing an authorization function are the types of
5114** things that make prepared statements obsolete.
drhba968db2018-07-24 22:02:12 +00005115**
5116** If iCode is 1, then expiration is advisory. The statement should
5117** be reprepared before being restarted, but if it is already running
5118** it is allowed to run to completion.
5119**
5120** Internally, this function just sets the Vdbe.expired flag on all
5121** prepared statements. The flag is set to 1 for an immediate expiration
5122** and set to 2 for an advisory expiration.
drhd89bd002005-01-22 03:03:54 +00005123*/
drhba968db2018-07-24 22:02:12 +00005124void sqlite3ExpirePreparedStatements(sqlite3 *db, int iCode){
drhd89bd002005-01-22 03:03:54 +00005125 Vdbe *p;
drhe5928b12022-08-23 20:11:01 +00005126 for(p = db->pVdbe; p; p=p->pVNext){
drhba968db2018-07-24 22:02:12 +00005127 p->expired = iCode+1;
drhd89bd002005-01-22 03:03:54 +00005128 }
5129}
danielk1977aee18ef2005-03-09 12:26:50 +00005130
5131/*
5132** Return the database associated with the Vdbe.
5133*/
5134sqlite3 *sqlite3VdbeDb(Vdbe *v){
5135 return v->db;
5136}
dan937d0de2009-10-15 18:35:38 +00005137
5138/*
drh2c2f3922017-06-01 00:54:35 +00005139** Return the SQLITE_PREPARE flags for a Vdbe.
5140*/
5141u8 sqlite3VdbePrepareFlags(Vdbe *v){
5142 return v->prepFlags;
5143}
5144
5145/*
dan937d0de2009-10-15 18:35:38 +00005146** Return a pointer to an sqlite3_value structure containing the value bound
5147** parameter iVar of VM v. Except, if the value is an SQL NULL, return
5148** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
5149** constants) to the value before returning it.
5150**
5151** The returned value must be freed by the caller using sqlite3ValueFree().
5152*/
drhcf0fd4a2013-08-01 12:21:58 +00005153sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00005154 assert( iVar>0 );
5155 if( v ){
5156 Mem *pMem = &v->aVar[iVar-1];
drh7df74752017-06-26 14:46:05 +00005157 assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
dan937d0de2009-10-15 18:35:38 +00005158 if( 0==(pMem->flags & MEM_Null) ){
5159 sqlite3_value *pRet = sqlite3ValueNew(v->db);
5160 if( pRet ){
5161 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
5162 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
dan937d0de2009-10-15 18:35:38 +00005163 }
5164 return pRet;
5165 }
5166 }
5167 return 0;
5168}
5169
5170/*
5171** Configure SQL variable iVar so that binding a new value to it signals
5172** to sqlite3_reoptimize() that re-preparing the statement may result
5173** in a better query plan.
5174*/
dan1d2ce4f2009-10-19 18:11:09 +00005175void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00005176 assert( iVar>0 );
drh7df74752017-06-26 14:46:05 +00005177 assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
drh29967962017-03-03 21:51:40 +00005178 if( iVar>=32 ){
5179 v->expmask |= 0x80000000;
dan937d0de2009-10-15 18:35:38 +00005180 }else{
dan1d2ce4f2009-10-19 18:11:09 +00005181 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00005182 }
5183}
dan016f7812013-08-21 17:35:48 +00005184
drh3e34eab2017-07-19 19:48:40 +00005185/*
5186** Cause a function to throw an error if it was call from OP_PureFunc
5187** rather than OP_Function.
5188**
5189** OP_PureFunc means that the function must be deterministic, and should
5190** throw an error if it is given inputs that would make it non-deterministic.
5191** This routine is invoked by date/time functions that use non-deterministic
5192** features such as 'now'.
5193*/
drh6e97f8e2017-07-20 13:17:08 +00005194int sqlite3NotPureFunc(sqlite3_context *pCtx){
drh20cee7d2019-10-30 18:50:08 +00005195 const VdbeOp *pOp;
drh175b8f02019-08-08 15:24:17 +00005196#ifdef SQLITE_ENABLE_STAT4
drhe8cf1ab2017-07-25 01:34:05 +00005197 if( pCtx->pVdbe==0 ) return 1;
5198#endif
drh20cee7d2019-10-30 18:50:08 +00005199 pOp = pCtx->pVdbe->aOp + pCtx->iOp;
5200 if( pOp->opcode==OP_PureFunc ){
5201 const char *zContext;
5202 char *zMsg;
5203 if( pOp->p5 & NC_IsCheck ){
5204 zContext = "a CHECK constraint";
5205 }else if( pOp->p5 & NC_GenCol ){
5206 zContext = "a generated column";
5207 }else{
5208 zContext = "an index";
5209 }
5210 zMsg = sqlite3_mprintf("non-deterministic use of %s() in %s",
5211 pCtx->pFunc->zName, zContext);
drh920cf592019-10-30 16:29:02 +00005212 sqlite3_result_error(pCtx, zMsg, -1);
5213 sqlite3_free(zMsg);
drh6e97f8e2017-07-20 13:17:08 +00005214 return 0;
drh3e34eab2017-07-19 19:48:40 +00005215 }
drh6e97f8e2017-07-20 13:17:08 +00005216 return 1;
drh3e34eab2017-07-19 19:48:40 +00005217}
5218
dan24249b32022-12-19 18:42:55 +00005219#include <sys/time.h>
dancb393f72023-01-16 20:33:43 +00005220void sqlite3OpenTransLog(u64 *aOpenTransTm){
5221 u64 i1 = aOpenTransTm[OPEN_TRANS_START];
5222 if( aOpenTransTm[OPEN_TRANS_DONE]>(i1+OPEN_TRANS_TIMEOUT) ){
dan24249b32022-12-19 18:42:55 +00005223 sqlite3_log(SQLITE_WARNING,
dand6285d32023-01-25 17:24:34 +00005224 "slow open transaction (v=7): (%d, %d, %d, %d)",
dancb393f72023-01-16 20:33:43 +00005225 (aOpenTransTm[OPEN_TRANS_BEFORERESET]==0) ? 0 :
5226 (int)(aOpenTransTm[OPEN_TRANS_BEFORERESET] - i1),
dan707300e2022-12-22 14:29:55 +00005227
dancb393f72023-01-16 20:33:43 +00005228 (aOpenTransTm[OPEN_TRANS_AFTERRESET]==0) ? 0 :
5229 (int)(aOpenTransTm[OPEN_TRANS_AFTERRESET] - i1),
dan707300e2022-12-22 14:29:55 +00005230
dancb393f72023-01-16 20:33:43 +00005231 (aOpenTransTm[OPEN_TRANS_AFTERUNFETCH]==0) ? 0 :
5232 (int)(aOpenTransTm[OPEN_TRANS_AFTERUNFETCH] - i1),
dan707300e2022-12-22 14:29:55 +00005233
dancb393f72023-01-16 20:33:43 +00005234 (int)(aOpenTransTm[OPEN_TRANS_DONE] - i1)
dan24249b32022-12-19 18:42:55 +00005235 );
5236 }
5237}
5238u64 sqlite3STimeNow(){
5239 struct timeval time;
5240 gettimeofday(&time, 0);
5241 return ((u64)time.tv_sec * 1000000 + (u64)time.tv_usec);
5242}
5243
dan016f7812013-08-21 17:35:48 +00005244#ifndef SQLITE_OMIT_VIRTUALTABLE
5245/*
5246** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
5247** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
5248** in memory obtained from sqlite3DbMalloc).
5249*/
5250void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
dan5c3aa052016-01-20 08:47:55 +00005251 if( pVtab->zErrMsg ){
5252 sqlite3 *db = p->db;
5253 sqlite3DbFree(db, p->zErrMsg);
5254 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
5255 sqlite3_free(pVtab->zErrMsg);
5256 pVtab->zErrMsg = 0;
5257 }
dan016f7812013-08-21 17:35:48 +00005258}
5259#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh32683532013-08-22 15:07:08 +00005260
drh9b1c62d2011-03-30 21:04:43 +00005261#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan93bca692011-09-14 19:41:44 +00005262
5263/*
5264** If the second argument is not NULL, release any allocations associated
5265** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
5266** structure itself, using sqlite3DbFree().
5267**
5268** This function is used to free UnpackedRecord structures allocated by
5269** the vdbeUnpackRecord() function found in vdbeapi.c.
5270*/
dan2a86c192017-01-25 17:44:13 +00005271static void vdbeFreeUnpacked(sqlite3 *db, int nField, UnpackedRecord *p){
drh41ce47c2022-08-22 02:00:26 +00005272 assert( db!=0 );
dan93bca692011-09-14 19:41:44 +00005273 if( p ){
5274 int i;
dan2a86c192017-01-25 17:44:13 +00005275 for(i=0; i<nField; i++){
dan93bca692011-09-14 19:41:44 +00005276 Mem *pMem = &p->aMem[i];
drhfc854502022-03-02 17:50:59 +00005277 if( pMem->zMalloc ) sqlite3VdbeMemReleaseMalloc(pMem);
dan93bca692011-09-14 19:41:44 +00005278 }
drh41ce47c2022-08-22 02:00:26 +00005279 sqlite3DbNNFreeNN(db, p);
dan93bca692011-09-14 19:41:44 +00005280 }
5281}
drh74c33022016-03-30 12:56:55 +00005282#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan93bca692011-09-14 19:41:44 +00005283
drh74c33022016-03-30 12:56:55 +00005284#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00005285/*
5286** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
5287** then cursor passed as the second argument should point to the row about
5288** to be update or deleted. If the application calls sqlite3_preupdate_old(),
5289** the required value will be read from the row the cursor points to.
5290*/
5291void sqlite3VdbePreUpdateHook(
5292 Vdbe *v, /* Vdbe pre-update hook is invoked by */
5293 VdbeCursor *pCsr, /* Cursor to grab old.* values from */
5294 int op, /* SQLITE_INSERT, UPDATE or DELETE */
5295 const char *zDb, /* Database name */
dan319eeb72011-03-19 08:38:50 +00005296 Table *pTab, /* Modified table */
dan46c47d42011-03-01 18:42:07 +00005297 i64 iKey1, /* Initial key value */
dana23a8732021-04-21 20:52:17 +00005298 int iReg, /* Register for new.* record */
5299 int iBlobWrite
dan46c47d42011-03-01 18:42:07 +00005300){
5301 sqlite3 *db = v->db;
dan37db03b2011-03-16 19:59:18 +00005302 i64 iKey2;
dan46c47d42011-03-01 18:42:07 +00005303 PreUpdate preupdate;
dan319eeb72011-03-19 08:38:50 +00005304 const char *zTbl = pTab->zName;
drhc4645da2012-09-28 13:05:48 +00005305 static const u8 fakeSortOrder = 0;
dan46c47d42011-03-01 18:42:07 +00005306
drh304637c2011-03-18 16:47:27 +00005307 assert( db->pPreUpdate==0 );
5308 memset(&preupdate, 0, sizeof(PreUpdate));
dancb9a3642017-01-30 19:44:53 +00005309 if( HasRowid(pTab)==0 ){
5310 iKey1 = iKey2 = 0;
5311 preupdate.pPk = sqlite3PrimaryKeyIndex(pTab);
dan37db03b2011-03-16 19:59:18 +00005312 }else{
dancb9a3642017-01-30 19:44:53 +00005313 if( op==SQLITE_UPDATE ){
5314 iKey2 = v->aMem[iReg].u.i;
5315 }else{
5316 iKey2 = iKey1;
5317 }
dan37db03b2011-03-16 19:59:18 +00005318 }
5319
drh3ab4ffc2021-11-11 11:23:08 +00005320 assert( pCsr!=0 );
5321 assert( pCsr->eCurType==CURTYPE_BTREE );
dane437ca52011-07-11 19:45:38 +00005322 assert( pCsr->nField==pTab->nCol
5323 || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
5324 );
5325
dan37db03b2011-03-16 19:59:18 +00005326 preupdate.v = v;
dan46c47d42011-03-01 18:42:07 +00005327 preupdate.pCsr = pCsr;
5328 preupdate.op = op;
dan37db03b2011-03-16 19:59:18 +00005329 preupdate.iNewReg = iReg;
dan4fccf432011-03-08 19:22:50 +00005330 preupdate.keyinfo.db = db;
5331 preupdate.keyinfo.enc = ENC(db);
drha485ad12017-08-02 22:43:14 +00005332 preupdate.keyinfo.nKeyField = pTab->nCol;
drha677eec2019-08-22 19:35:24 +00005333 preupdate.keyinfo.aSortFlags = (u8*)&fakeSortOrder;
dan319eeb72011-03-19 08:38:50 +00005334 preupdate.iKey1 = iKey1;
5335 preupdate.iKey2 = iKey2;
dane43635a2016-10-21 21:21:45 +00005336 preupdate.pTab = pTab;
dana23a8732021-04-21 20:52:17 +00005337 preupdate.iBlobWrite = iBlobWrite;
dan319eeb72011-03-19 08:38:50 +00005338
dan46c47d42011-03-01 18:42:07 +00005339 db->pPreUpdate = &preupdate;
5340 db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
5341 db->pPreUpdate = 0;
5342 sqlite3DbFree(db, preupdate.aRecord);
drha485ad12017-08-02 22:43:14 +00005343 vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pUnpacked);
5344 vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pNewUnpacked);
dan37db03b2011-03-16 19:59:18 +00005345 if( preupdate.aNew ){
5346 int i;
5347 for(i=0; i<pCsr->nField; i++){
5348 sqlite3VdbeMemRelease(&preupdate.aNew[i]);
5349 }
drh41ce47c2022-08-22 02:00:26 +00005350 sqlite3DbNNFreeNN(db, preupdate.aNew);
dan37db03b2011-03-16 19:59:18 +00005351 }
dan46c47d42011-03-01 18:42:07 +00005352}
drh9b1c62d2011-03-30 21:04:43 +00005353#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */