blob: ca9e5112a416022f6960bf212a24eccbe5df2ed2 [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;
drh3547e492022-12-23 14:49:24 +0000215 (void)pc;
216 (void)pOp;
drh313619f2013-10-31 20:34:06 +0000217 n++;
218}
219#endif
220
drh76ff3a02004-09-24 22:32:30 +0000221/*
drh9a324642003-09-06 20:12:01 +0000222** Add a new instruction to the list of instructions current in the
223** VDBE. Return the address of the new instruction.
224**
225** Parameters:
226**
227** p Pointer to the VDBE
228**
229** op The opcode for this instruction
230**
drh66a51672008-01-03 00:01:23 +0000231** p1, p2, p3 Operands
drh9a324642003-09-06 20:12:01 +0000232**
danielk19774adee202004-05-08 08:23:19 +0000233** Use the sqlite3VdbeResolveLabel() function to fix an address and
drh66a51672008-01-03 00:01:23 +0000234** the sqlite3VdbeChangeP4() function to change the value of the P4
drh9a324642003-09-06 20:12:01 +0000235** operand.
236*/
drhd7970352015-11-09 12:33:39 +0000237static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
drhb6991792018-12-28 20:14:03 +0000238 assert( p->nOpAlloc<=p->nOp );
drhd7970352015-11-09 12:33:39 +0000239 if( growOpArray(p, 1) ) return 1;
drhb6991792018-12-28 20:14:03 +0000240 assert( p->nOpAlloc>p->nOp );
drhd7970352015-11-09 12:33:39 +0000241 return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
242}
drh66a51672008-01-03 00:01:23 +0000243int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
drh9a324642003-09-06 20:12:01 +0000244 int i;
drh701a0ae2004-02-22 20:05:00 +0000245 VdbeOp *pOp;
drh9a324642003-09-06 20:12:01 +0000246
247 i = p->nOp;
drh66181ce2022-03-31 20:04:49 +0000248 assert( p->eVdbeState==VDBE_INIT_STATE );
drhed94af52016-02-01 17:20:08 +0000249 assert( op>=0 && op<0xff );
drhb6991792018-12-28 20:14:03 +0000250 if( p->nOpAlloc<=i ){
drhd7970352015-11-09 12:33:39 +0000251 return growOp3(p, op, p1, p2, p3);
drh9a324642003-09-06 20:12:01 +0000252 }
drhc59ffa82021-10-04 15:08:49 +0000253 assert( p->aOp!=0 );
danielk197701256832007-04-18 14:24:32 +0000254 p->nOp++;
drh701a0ae2004-02-22 20:05:00 +0000255 pOp = &p->aOp[i];
drhc59ffa82021-10-04 15:08:49 +0000256 assert( pOp!=0 );
drh8df32842008-12-09 02:51:23 +0000257 pOp->opcode = (u8)op;
drh26c9b5e2008-04-11 14:56:53 +0000258 pOp->p5 = 0;
drh701a0ae2004-02-22 20:05:00 +0000259 pOp->p1 = p1;
drh701a0ae2004-02-22 20:05:00 +0000260 pOp->p2 = p2;
drh66a51672008-01-03 00:01:23 +0000261 pOp->p3 = p3;
262 pOp->p4.p = 0;
263 pOp->p4type = P4_NOTUSED;
drhc7379ce2013-10-30 02:28:23 +0000264#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh26c9b5e2008-04-11 14:56:53 +0000265 pOp->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +0000266#endif
dan7f4b0662022-12-07 20:09:54 +0000267#if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || defined(VDBE_PROFILE)
268 pOp->nExec = 0;
269 pOp->nCycle = 0;
270#endif
drhc7379ce2013-10-30 02:28:23 +0000271#ifdef SQLITE_DEBUG
drhe0962052013-01-29 19:14:31 +0000272 if( p->db->flags & SQLITE_VdbeAddopTrace ){
273 sqlite3VdbePrintOp(0, i, &p->aOp[i]);
drh52f11b82020-01-02 13:26:49 +0000274 test_addop_breakpoint(i, &p->aOp[i]);
drhe0962052013-01-29 19:14:31 +0000275 }
drh9a324642003-09-06 20:12:01 +0000276#endif
drh688852a2014-02-17 22:40:43 +0000277#ifdef SQLITE_VDBE_COVERAGE
278 pOp->iSrcLine = 0;
279#endif
drh9a324642003-09-06 20:12:01 +0000280 return i;
281}
drh66a51672008-01-03 00:01:23 +0000282int sqlite3VdbeAddOp0(Vdbe *p, int op){
283 return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
284}
285int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
286 return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
287}
288int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
289 return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
drh701a0ae2004-02-22 20:05:00 +0000290}
291
drh076e85f2015-09-03 13:46:12 +0000292/* Generate code for an unconditional jump to instruction iDest
293*/
294int sqlite3VdbeGoto(Vdbe *p, int iDest){
drh2991ba02015-09-02 18:19:00 +0000295 return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
296}
drh701a0ae2004-02-22 20:05:00 +0000297
drh076e85f2015-09-03 13:46:12 +0000298/* Generate code to cause the string zStr to be loaded into
299** register iDest
300*/
301int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
302 return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
303}
304
305/*
306** Generate code that initializes multiple registers to string or integer
307** constants. The registers begin with iDest and increase consecutively.
308** One register is initialized for each characgter in zTypes[]. For each
309** "s" character in zTypes[], the register is a string if the argument is
310** not NULL, or OP_Null if the value is a null pointer. For each "i" character
311** in zTypes[], the register is initialized to an integer.
drh40cf27c2017-07-07 16:00:53 +0000312**
313** If the input string does not end with "X" then an OP_ResultRow instruction
314** is generated for the values inserted.
drh076e85f2015-09-03 13:46:12 +0000315*/
316void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
317 va_list ap;
318 int i;
319 char c;
320 va_start(ap, zTypes);
321 for(i=0; (c = zTypes[i])!=0; i++){
322 if( c=='s' ){
323 const char *z = va_arg(ap, const char*);
drh40cf27c2017-07-07 16:00:53 +0000324 sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest+i, 0, z, 0);
325 }else if( c=='i' ){
326 sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest+i);
drh076e85f2015-09-03 13:46:12 +0000327 }else{
drh40cf27c2017-07-07 16:00:53 +0000328 goto skip_op_resultrow;
drh076e85f2015-09-03 13:46:12 +0000329 }
330 }
drh40cf27c2017-07-07 16:00:53 +0000331 sqlite3VdbeAddOp2(p, OP_ResultRow, iDest, i);
332skip_op_resultrow:
drh076e85f2015-09-03 13:46:12 +0000333 va_end(ap);
334}
drh66a51672008-01-03 00:01:23 +0000335
drh701a0ae2004-02-22 20:05:00 +0000336/*
drh66a51672008-01-03 00:01:23 +0000337** Add an opcode that includes the p4 value as a pointer.
drhd4e70eb2008-01-02 00:34:36 +0000338*/
drh66a51672008-01-03 00:01:23 +0000339int sqlite3VdbeAddOp4(
drhd4e70eb2008-01-02 00:34:36 +0000340 Vdbe *p, /* Add the opcode to this VM */
341 int op, /* The new opcode */
drh66a51672008-01-03 00:01:23 +0000342 int p1, /* The P1 operand */
343 int p2, /* The P2 operand */
344 int p3, /* The P3 operand */
345 const char *zP4, /* The P4 operand */
346 int p4type /* P4 operand type */
drhd4e70eb2008-01-02 00:34:36 +0000347){
drh66a51672008-01-03 00:01:23 +0000348 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
349 sqlite3VdbeChangeP4(p, addr, zP4, p4type);
drhd4e70eb2008-01-02 00:34:36 +0000350 return addr;
351}
352
353/*
drh920cf592019-10-30 16:29:02 +0000354** Add an OP_Function or OP_PureFunc opcode.
355**
356** The eCallCtx argument is information (typically taken from Expr.op2)
357** that describes the calling context of the function. 0 means a general
358** function call. NC_IsCheck means called by a check constraint,
359** NC_IdxExpr means called as part of an index expression. NC_PartIdx
360** means in the WHERE clause of a partial index. NC_GenCol means called
361** while computing a generated column value. 0 is the usual case.
362*/
363int sqlite3VdbeAddFunctionCall(
364 Parse *pParse, /* Parsing context */
365 int p1, /* Constant argument mask */
366 int p2, /* First argument register */
367 int p3, /* Register into which results are written */
368 int nArg, /* Number of argument */
369 const FuncDef *pFunc, /* The function to be invoked */
370 int eCallCtx /* Calling context */
371){
372 Vdbe *v = pParse->pVdbe;
373 int nByte;
374 int addr;
375 sqlite3_context *pCtx;
376 assert( v );
377 nByte = sizeof(*pCtx) + (nArg-1)*sizeof(sqlite3_value*);
378 pCtx = sqlite3DbMallocRawNN(pParse->db, nByte);
379 if( pCtx==0 ){
380 assert( pParse->db->mallocFailed );
381 freeEphemeralFunction(pParse->db, (FuncDef*)pFunc);
382 return 0;
383 }
384 pCtx->pOut = 0;
385 pCtx->pFunc = (FuncDef*)pFunc;
drh20cee7d2019-10-30 18:50:08 +0000386 pCtx->pVdbe = 0;
drh920cf592019-10-30 16:29:02 +0000387 pCtx->isError = 0;
388 pCtx->argc = nArg;
drhf2b9d7c2019-11-01 16:37:53 +0000389 pCtx->iOp = sqlite3VdbeCurrentAddr(v);
drh920cf592019-10-30 16:29:02 +0000390 addr = sqlite3VdbeAddOp4(v, eCallCtx ? OP_PureFunc : OP_Function,
391 p1, p2, p3, (char*)pCtx, P4_FUNCCTX);
drh20cee7d2019-10-30 18:50:08 +0000392 sqlite3VdbeChangeP5(v, eCallCtx & NC_SelfRef);
drh4d288302022-08-30 00:11:51 +0000393 sqlite3MayAbort(pParse);
drh920cf592019-10-30 16:29:02 +0000394 return addr;
395}
396
397/*
drh7cc023c2015-09-03 04:28:25 +0000398** Add an opcode that includes the p4 value with a P4_INT64 or
399** P4_REAL type.
drh97bae792015-06-05 15:59:57 +0000400*/
401int sqlite3VdbeAddOp4Dup8(
402 Vdbe *p, /* Add the opcode to this VM */
403 int op, /* The new opcode */
404 int p1, /* The P1 operand */
405 int p2, /* The P2 operand */
406 int p3, /* The P3 operand */
407 const u8 *zP4, /* The P4 operand */
408 int p4type /* P4 operand type */
409){
drh575fad62016-02-05 13:38:36 +0000410 char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
drh97bae792015-06-05 15:59:57 +0000411 if( p4copy ) memcpy(p4copy, zP4, 8);
412 return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
413}
414
drhe2ca99c2018-05-02 00:33:43 +0000415#ifndef SQLITE_OMIT_EXPLAIN
416/*
417** Return the address of the current EXPLAIN QUERY PLAN baseline.
418** 0 means "none".
419*/
420int sqlite3VdbeExplainParent(Parse *pParse){
421 VdbeOp *pOp;
422 if( pParse->addrExplain==0 ) return 0;
423 pOp = sqlite3VdbeGetOp(pParse->pVdbe, pParse->addrExplain);
424 return pOp->p2;
425}
426
427/*
drhbd462bc2018-12-24 20:21:06 +0000428** Set a debugger breakpoint on the following routine in order to
429** monitor the EXPLAIN QUERY PLAN code generation.
430*/
431#if defined(SQLITE_DEBUG)
432void sqlite3ExplainBreakpoint(const char *z1, const char *z2){
433 (void)z1;
434 (void)z2;
435}
436#endif
437
438/*
drh91a23dc2020-03-19 15:57:03 +0000439** Add a new OP_Explain opcode.
drhe2ca99c2018-05-02 00:33:43 +0000440**
441** If the bPush flag is true, then make this opcode the parent for
442** subsequent Explains until sqlite3VdbeExplainPop() is called.
443*/
dan231ff4b2022-12-02 20:32:22 +0000444int sqlite3VdbeExplain(Parse *pParse, u8 bPush, const char *zFmt, ...){
445 int addr = 0;
446#if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
drhc310c532018-12-24 18:10:39 +0000447 /* Always include the OP_Explain opcodes if SQLITE_DEBUG is defined.
448 ** But omit them (for performance) during production builds */
drhbd462bc2018-12-24 20:21:06 +0000449 if( pParse->explain==2 )
450#endif
451 {
drhe2ca99c2018-05-02 00:33:43 +0000452 char *zMsg;
drhc4ceea72018-08-21 12:16:33 +0000453 Vdbe *v;
drhe2ca99c2018-05-02 00:33:43 +0000454 va_list ap;
455 int iThis;
456 va_start(ap, zFmt);
457 zMsg = sqlite3VMPrintf(pParse->db, zFmt, ap);
458 va_end(ap);
459 v = pParse->pVdbe;
460 iThis = v->nOp;
dan231ff4b2022-12-02 20:32:22 +0000461 addr = sqlite3VdbeAddOp4(v, OP_Explain, iThis, pParse->addrExplain, 0,
drhe2ca99c2018-05-02 00:33:43 +0000462 zMsg, P4_DYNAMIC);
drh058e9952022-07-25 19:05:24 +0000463 sqlite3ExplainBreakpoint(bPush?"PUSH":"", sqlite3VdbeGetLastOp(v)->p4.z);
drhbd462bc2018-12-24 20:21:06 +0000464 if( bPush){
465 pParse->addrExplain = iThis;
466 }
dan231ff4b2022-12-02 20:32:22 +0000467 sqlite3VdbeScanStatus(v, iThis, 0, 0, 0, 0);
drhe2ca99c2018-05-02 00:33:43 +0000468 }
dan231ff4b2022-12-02 20:32:22 +0000469 return addr;
drhe2ca99c2018-05-02 00:33:43 +0000470}
471
472/*
473** Pop the EXPLAIN QUERY PLAN stack one level.
474*/
475void sqlite3VdbeExplainPop(Parse *pParse){
drhbd462bc2018-12-24 20:21:06 +0000476 sqlite3ExplainBreakpoint("POP", 0);
drhe2ca99c2018-05-02 00:33:43 +0000477 pParse->addrExplain = sqlite3VdbeExplainParent(pParse);
478}
479#endif /* SQLITE_OMIT_EXPLAIN */
480
drh97bae792015-06-05 15:59:57 +0000481/*
drh5d9c9da2011-06-03 20:11:17 +0000482** Add an OP_ParseSchema opcode. This routine is broken out from
drhe4c88c02012-01-04 12:57:45 +0000483** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
484** as having been used.
drh5d9c9da2011-06-03 20:11:17 +0000485**
486** The zWhere string must have been obtained from sqlite3_malloc().
487** This routine will take ownership of the allocated memory.
488*/
dan6a5a13d2021-02-17 20:08:22 +0000489void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere, u16 p5){
drh5d9c9da2011-06-03 20:11:17 +0000490 int j;
drh00dceca2016-01-11 22:58:50 +0000491 sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
dan6a5a13d2021-02-17 20:08:22 +0000492 sqlite3VdbeChangeP5(p, p5);
drh5d9c9da2011-06-03 20:11:17 +0000493 for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
drhed7974d2020-10-26 18:14:12 +0000494 sqlite3MayAbort(p->pParse);
drh5d9c9da2011-06-03 20:11:17 +0000495}
496
497/*
drh8cff69d2009-11-12 19:59:44 +0000498** Add an opcode that includes the p4 value as an integer.
499*/
500int sqlite3VdbeAddOp4Int(
501 Vdbe *p, /* Add the opcode to this VM */
502 int op, /* The new opcode */
503 int p1, /* The P1 operand */
504 int p2, /* The P2 operand */
505 int p3, /* The P3 operand */
506 int p4 /* The P4 operand as an integer */
507){
508 int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
drhbdaa1ee2016-12-07 20:09:51 +0000509 if( p->db->mallocFailed==0 ){
510 VdbeOp *pOp = &p->aOp[addr];
511 pOp->p4type = P4_INT32;
512 pOp->p4.i = p4;
513 }
drh8cff69d2009-11-12 19:59:44 +0000514 return addr;
515}
516
drh2fade2f2016-02-09 02:12:20 +0000517/* Insert the end of a co-routine
518*/
519void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
520 sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
521
522 /* Clear the temporary register cache, thereby ensuring that each
523 ** co-routine has its own independent set of registers, because co-routines
524 ** might expect their registers to be preserved across an OP_Yield, and
525 ** that could cause problems if two or more co-routines are using the same
526 ** temporary register.
527 */
528 v->pParse->nTempReg = 0;
529 v->pParse->nRangeReg = 0;
530}
531
drh8cff69d2009-11-12 19:59:44 +0000532/*
drh9a324642003-09-06 20:12:01 +0000533** Create a new symbolic label for an instruction that has yet to be
534** coded. The symbolic label is really just a negative number. The
535** label can be used as the P2 value of an operation. Later, when
536** the label is resolved to a specific address, the VDBE will scan
537** through its operation list and change all values of P2 which match
538** the label into the resolved address.
539**
540** The VDBE knows that a P2 value is a label because labels are
541** always negative and P2 values are suppose to be non-negative.
542** Hence, a negative P2 value is a label that has yet to be resolved.
drhd1d158b2018-12-29 14:23:22 +0000543** (Later:) This is only true for opcodes that have the OPFLG_JUMP
544** property.
danielk1977b5548a82004-06-26 13:51:33 +0000545**
drhd1d158b2018-12-29 14:23:22 +0000546** Variable usage notes:
547**
548** Parse.aLabel[x] Stores the address that the x-th label resolves
549** into. For testing (SQLITE_DEBUG), unresolved
550** labels stores -1, but that is not required.
551** Parse.nLabelAlloc Number of slots allocated to Parse.aLabel[]
552** Parse.nLabel The *negative* of the number of labels that have
553** been issued. The negative is stored because
554** that gives a performance improvement over storing
555** the equivalent positive value.
drh9a324642003-09-06 20:12:01 +0000556*/
drhec4ccdb2018-12-29 02:26:59 +0000557int sqlite3VdbeMakeLabel(Parse *pParse){
drhd1d158b2018-12-29 14:23:22 +0000558 return --pParse->nLabel;
drh9a324642003-09-06 20:12:01 +0000559}
560
561/*
562** Resolve label "x" to be the address of the next instruction to
563** be inserted. The parameter "x" must have been obtained from
danielk19774adee202004-05-08 08:23:19 +0000564** a prior call to sqlite3VdbeMakeLabel().
drh9a324642003-09-06 20:12:01 +0000565*/
drhec4ccdb2018-12-29 02:26:59 +0000566static SQLITE_NOINLINE void resizeResolveLabel(Parse *p, Vdbe *v, int j){
drhd1d158b2018-12-29 14:23:22 +0000567 int nNewSize = 10 - p->nLabel;
drhec4ccdb2018-12-29 02:26:59 +0000568 p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
569 nNewSize*sizeof(p->aLabel[0]));
570 if( p->aLabel==0 ){
571 p->nLabelAlloc = 0;
572 }else{
573#ifdef SQLITE_DEBUG
574 int i;
575 for(i=p->nLabelAlloc; i<nNewSize; i++) p->aLabel[i] = -1;
576#endif
577 p->nLabelAlloc = nNewSize;
578 p->aLabel[j] = v->nOp;
579 }
580}
drh73d5b8f2013-12-23 19:09:07 +0000581void sqlite3VdbeResolveLabel(Vdbe *v, int x){
582 Parse *p = v->pParse;
drh5ef09bf2015-12-09 17:23:12 +0000583 int j = ADDR(x);
drh66181ce2022-03-31 20:04:49 +0000584 assert( v->eVdbeState==VDBE_INIT_STATE );
drhd1d158b2018-12-29 14:23:22 +0000585 assert( j<-p->nLabel );
drhef41dfe2015-09-02 17:55:12 +0000586 assert( j>=0 );
drh29285462018-04-17 19:29:58 +0000587#ifdef SQLITE_DEBUG
drhec4ccdb2018-12-29 02:26:59 +0000588 if( p->db->flags & SQLITE_VdbeAddopTrace ){
589 printf("RESOLVE LABEL %d to %d\n", x, v->nOp);
590 }
drh29285462018-04-17 19:29:58 +0000591#endif
drhd1d158b2018-12-29 14:23:22 +0000592 if( p->nLabelAlloc + p->nLabel < 0 ){
drhec4ccdb2018-12-29 02:26:59 +0000593 resizeResolveLabel(p,v,j);
594 }else{
drh7ef8a3e2018-04-17 20:09:27 +0000595 assert( p->aLabel[j]==(-1) ); /* Labels may only be resolved once */
drh73d5b8f2013-12-23 19:09:07 +0000596 p->aLabel[j] = v->nOp;
drh9a324642003-09-06 20:12:01 +0000597 }
598}
599
drh4611d922010-02-25 14:47:01 +0000600/*
601** Mark the VDBE as one that can only be run one time.
602*/
603void sqlite3VdbeRunOnlyOnce(Vdbe *p){
drh18bcfb92022-04-03 19:13:40 +0000604 sqlite3VdbeAddOp2(p, OP_Expire, 1, 1);
drh4611d922010-02-25 14:47:01 +0000605}
606
drhf71a3662016-03-16 20:44:45 +0000607/*
drh861ac672022-06-22 12:54:25 +0000608** Mark the VDBE as one that can be run multiple times.
drhf71a3662016-03-16 20:44:45 +0000609*/
610void sqlite3VdbeReusable(Vdbe *p){
drh18bcfb92022-04-03 19:13:40 +0000611 int i;
612 for(i=1; ALWAYS(i<p->nOp); i++){
drh50f22d12022-04-04 19:58:55 +0000613 if( ALWAYS(p->aOp[i].opcode==OP_Expire) ){
drh18bcfb92022-04-03 19:13:40 +0000614 p->aOp[1].opcode = OP_Noop;
615 break;
616 }
617 }
drhf71a3662016-03-16 20:44:45 +0000618}
619
drhff738bc2009-09-24 00:09:58 +0000620#ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
dan144926d2009-09-09 11:37:20 +0000621
622/*
623** The following type and function are used to iterate through all opcodes
624** in a Vdbe main program and each of the sub-programs (triggers) it may
625** invoke directly or indirectly. It should be used as follows:
626**
627** Op *pOp;
628** VdbeOpIter sIter;
629**
630** memset(&sIter, 0, sizeof(sIter));
631** sIter.v = v; // v is of type Vdbe*
632** while( (pOp = opIterNext(&sIter)) ){
633** // Do something with pOp
634** }
635** sqlite3DbFree(v->db, sIter.apSub);
636**
637*/
638typedef struct VdbeOpIter VdbeOpIter;
639struct VdbeOpIter {
640 Vdbe *v; /* Vdbe to iterate through the opcodes of */
641 SubProgram **apSub; /* Array of subprograms */
642 int nSub; /* Number of entries in apSub */
643 int iAddr; /* Address of next instruction to return */
644 int iSub; /* 0 = main program, 1 = first sub-program etc. */
645};
646static Op *opIterNext(VdbeOpIter *p){
647 Vdbe *v = p->v;
648 Op *pRet = 0;
649 Op *aOp;
650 int nOp;
651
652 if( p->iSub<=p->nSub ){
653
654 if( p->iSub==0 ){
655 aOp = v->aOp;
656 nOp = v->nOp;
657 }else{
658 aOp = p->apSub[p->iSub-1]->aOp;
659 nOp = p->apSub[p->iSub-1]->nOp;
660 }
661 assert( p->iAddr<nOp );
662
663 pRet = &aOp[p->iAddr];
664 p->iAddr++;
665 if( p->iAddr==nOp ){
666 p->iSub++;
667 p->iAddr = 0;
668 }
669
670 if( pRet->p4type==P4_SUBPROGRAM ){
671 int nByte = (p->nSub+1)*sizeof(SubProgram*);
672 int j;
673 for(j=0; j<p->nSub; j++){
674 if( p->apSub[j]==pRet->p4.pProgram ) break;
675 }
676 if( j==p->nSub ){
677 p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
678 if( !p->apSub ){
679 pRet = 0;
680 }else{
681 p->apSub[p->nSub++] = pRet->p4.pProgram;
682 }
683 }
684 }
685 }
686
687 return pRet;
688}
689
690/*
danf3677212009-09-10 16:14:50 +0000691** Check if the program stored in the VM associated with pParse may
drhff738bc2009-09-24 00:09:58 +0000692** throw an ABORT exception (causing the statement, but not entire transaction
dan144926d2009-09-09 11:37:20 +0000693** to be rolled back). This condition is true if the main program or any
694** sub-programs contains any of the following:
695**
696** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
697** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
698** * OP_Destroy
699** * OP_VUpdate
drh8e8c8892019-12-10 18:10:12 +0000700** * OP_VCreate
dan144926d2009-09-09 11:37:20 +0000701** * OP_VRename
dan32b09f22009-09-23 17:29:59 +0000702** * OP_FkCounter with P2==0 (immediate foreign key constraint)
drh0f3f7662017-08-18 14:34:28 +0000703** * OP_CreateBtree/BTREE_INTKEY and OP_InitCoroutine
704** (for CREATE TABLE AS SELECT ...)
dan144926d2009-09-09 11:37:20 +0000705**
danf3677212009-09-10 16:14:50 +0000706** Then check that the value of Parse.mayAbort is true if an
707** ABORT may be thrown, or false otherwise. Return true if it does
708** match, or false otherwise. This function is intended to be used as
709** part of an assert statement in the compiler. Similar to:
710**
711** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
dan144926d2009-09-09 11:37:20 +0000712*/
danf3677212009-09-10 16:14:50 +0000713int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
714 int hasAbort = 0;
dan04668832014-12-16 20:13:30 +0000715 int hasFkCounter = 0;
drh0dd5cda2015-06-16 16:39:01 +0000716 int hasCreateTable = 0;
danef14abb2019-05-21 14:42:24 +0000717 int hasCreateIndex = 0;
drh0dd5cda2015-06-16 16:39:01 +0000718 int hasInitCoroutine = 0;
dan144926d2009-09-09 11:37:20 +0000719 Op *pOp;
720 VdbeOpIter sIter;
drhc4c0ff82022-03-31 16:09:13 +0000721
722 if( v==0 ) return 0;
dan144926d2009-09-09 11:37:20 +0000723 memset(&sIter, 0, sizeof(sIter));
724 sIter.v = v;
725
726 while( (pOp = opIterNext(&sIter))!=0 ){
727 int opcode = pOp->opcode;
728 if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
dan1d4b1642018-12-28 17:45:08 +0000729 || opcode==OP_VDestroy
drh8e8c8892019-12-10 18:10:12 +0000730 || opcode==OP_VCreate
drhed7974d2020-10-26 18:14:12 +0000731 || opcode==OP_ParseSchema
drh4d288302022-08-30 00:11:51 +0000732 || opcode==OP_Function || opcode==OP_PureFunc
dan144926d2009-09-09 11:37:20 +0000733 || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
drh211a0852019-01-27 02:41:34 +0000734 && ((pOp->p1)!=SQLITE_OK && pOp->p2==OE_Abort))
dan144926d2009-09-09 11:37:20 +0000735 ){
danf3677212009-09-10 16:14:50 +0000736 hasAbort = 1;
dan144926d2009-09-09 11:37:20 +0000737 break;
738 }
drh0f3f7662017-08-18 14:34:28 +0000739 if( opcode==OP_CreateBtree && pOp->p3==BTREE_INTKEY ) hasCreateTable = 1;
dan7ed6c062019-05-21 16:32:41 +0000740 if( mayAbort ){
741 /* hasCreateIndex may also be set for some DELETE statements that use
742 ** OP_Clear. So this routine may end up returning true in the case
743 ** where a "DELETE FROM tbl" has a statement-journal but does not
744 ** require one. This is not so bad - it is an inefficiency, not a bug. */
745 if( opcode==OP_CreateBtree && pOp->p3==BTREE_BLOBKEY ) hasCreateIndex = 1;
746 if( opcode==OP_Clear ) hasCreateIndex = 1;
747 }
drh0dd5cda2015-06-16 16:39:01 +0000748 if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
dan04668832014-12-16 20:13:30 +0000749#ifndef SQLITE_OMIT_FOREIGN_KEY
750 if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
751 hasFkCounter = 1;
752 }
753#endif
dan144926d2009-09-09 11:37:20 +0000754 }
dan144926d2009-09-09 11:37:20 +0000755 sqlite3DbFree(v->db, sIter.apSub);
danf3677212009-09-10 16:14:50 +0000756
mistachkin48864df2013-03-21 21:20:32 +0000757 /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
danf3677212009-09-10 16:14:50 +0000758 ** If malloc failed, then the while() loop above may not have iterated
759 ** through all opcodes and hasAbort may be set incorrectly. Return
760 ** true for this case to prevent the assert() in the callers frame
761 ** from failing. */
drh0dd5cda2015-06-16 16:39:01 +0000762 return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
danef14abb2019-05-21 14:42:24 +0000763 || (hasCreateTable && hasInitCoroutine) || hasCreateIndex
764 );
dan144926d2009-09-09 11:37:20 +0000765}
drhff738bc2009-09-24 00:09:58 +0000766#endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
dan144926d2009-09-09 11:37:20 +0000767
drh4031baf2018-05-28 17:31:20 +0000768#ifdef SQLITE_DEBUG
769/*
770** Increment the nWrite counter in the VDBE if the cursor is not an
771** ephemeral cursor, or if the cursor argument is NULL.
772*/
773void sqlite3VdbeIncrWriteCounter(Vdbe *p, VdbeCursor *pC){
774 if( pC==0
775 || (pC->eCurType!=CURTYPE_SORTER
776 && pC->eCurType!=CURTYPE_PSEUDO
777 && !pC->isEphemeral)
778 ){
779 p->nWrite++;
780 }
781}
782#endif
783
784#ifdef SQLITE_DEBUG
785/*
786** Assert if an Abort at this point in time might result in a corrupt
787** database.
788*/
789void sqlite3VdbeAssertAbortable(Vdbe *p){
790 assert( p->nWrite==0 || p->usesStmtJournal );
791}
792#endif
793
drh9a324642003-09-06 20:12:01 +0000794/*
drhef41dfe2015-09-02 17:55:12 +0000795** This routine is called after all opcodes have been inserted. It loops
796** through all the opcodes and fixes up some details.
drh76ff3a02004-09-24 22:32:30 +0000797**
drhef41dfe2015-09-02 17:55:12 +0000798** (1) For each jump instruction with a negative P2 value (a label)
799** resolve the P2 value to an actual address.
danielk1977634f2982005-03-28 08:44:07 +0000800**
drhef41dfe2015-09-02 17:55:12 +0000801** (2) Compute the maximum number of arguments used by any SQL function
802** and store that value in *pMaxFuncArgs.
drha6c2ed92009-11-14 23:22:23 +0000803**
drhef41dfe2015-09-02 17:55:12 +0000804** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
805** indicate what the prepared statement actually does.
806**
drha7c9dd52022-02-24 14:44:23 +0000807** (4) (discontinued)
drhef41dfe2015-09-02 17:55:12 +0000808**
809** (5) Reclaim the memory allocated for storing labels.
drh7cc84c22016-04-11 13:36:42 +0000810**
811** This routine will only function correctly if the mkopcodeh.tcl generator
812** script numbers the opcodes correctly. Changes to this routine must be
813** coordinated with changes to mkopcodeh.tcl.
drh76ff3a02004-09-24 22:32:30 +0000814*/
drh9cbf3422008-01-17 16:22:13 +0000815static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
dan165921a2009-08-28 18:53:45 +0000816 int nMaxArgs = *pMaxFuncArgs;
drh76ff3a02004-09-24 22:32:30 +0000817 Op *pOp;
drh73d5b8f2013-12-23 19:09:07 +0000818 Parse *pParse = p->pParse;
819 int *aLabel = pParse->aLabel;
drhad4a4b82008-11-05 16:37:34 +0000820 p->readOnly = 1;
drh1713afb2013-06-28 01:24:57 +0000821 p->bIsReader = 0;
drh7cc84c22016-04-11 13:36:42 +0000822 pOp = &p->aOp[p->nOp-1];
drh064390b2022-07-01 19:42:12 +0000823 assert( p->aOp[0].opcode==OP_Init );
824 while( 1 /* Loop termates when it reaches the OP_Init opcode */ ){
drh7cc84c22016-04-11 13:36:42 +0000825 /* Only JUMP opcodes and the short list of special opcodes in the switch
826 ** below need to be considered. The mkopcodeh.tcl generator script groups
827 ** all these opcodes together near the front of the opcode list. Skip
828 ** any opcode that does not need processing by virtual of the fact that
drhc310db32016-04-11 16:35:05 +0000829 ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
drh7cc84c22016-04-11 13:36:42 +0000830 */
drhc310db32016-04-11 16:35:05 +0000831 if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
drh7cc84c22016-04-11 13:36:42 +0000832 /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
833 ** cases from this switch! */
834 switch( pOp->opcode ){
835 case OP_Transaction: {
836 if( pOp->p2!=0 ) p->readOnly = 0;
drh08b92082020-08-10 14:18:00 +0000837 /* no break */ deliberate_fall_through
drh7cc84c22016-04-11 13:36:42 +0000838 }
839 case OP_AutoCommit:
840 case OP_Savepoint: {
841 p->bIsReader = 1;
842 break;
843 }
dand9031542013-07-05 16:54:30 +0000844#ifndef SQLITE_OMIT_WAL
drh7cc84c22016-04-11 13:36:42 +0000845 case OP_Checkpoint:
drh9e92a472013-06-27 17:40:30 +0000846#endif
drh7cc84c22016-04-11 13:36:42 +0000847 case OP_Vacuum:
848 case OP_JournalMode: {
849 p->readOnly = 0;
850 p->bIsReader = 1;
851 break;
852 }
drh064390b2022-07-01 19:42:12 +0000853 case OP_Init: {
854 assert( pOp->p2>=0 );
855 goto resolve_p2_values_loop_exit;
856 }
danielk1977182c4ba2007-06-27 15:53:34 +0000857#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7cc84c22016-04-11 13:36:42 +0000858 case OP_VUpdate: {
859 if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
860 break;
861 }
862 case OP_VFilter: {
863 int n;
864 assert( (pOp - p->aOp) >= 3 );
865 assert( pOp[-1].opcode==OP_Integer );
866 n = pOp[-1].p1;
867 if( n>nMaxArgs ) nMaxArgs = n;
drh6a8700b2017-08-02 11:04:00 +0000868 /* Fall through into the default case */
drh08b92082020-08-10 14:18:00 +0000869 /* no break */ deliberate_fall_through
drh7cc84c22016-04-11 13:36:42 +0000870 }
danielk1977182c4ba2007-06-27 15:53:34 +0000871#endif
drh6a8700b2017-08-02 11:04:00 +0000872 default: {
873 if( pOp->p2<0 ){
874 /* The mkopcodeh.tcl script has so arranged things that the only
875 ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
876 ** have non-negative values for P2. */
877 assert( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 );
drhd1d158b2018-12-29 14:23:22 +0000878 assert( ADDR(pOp->p2)<-pParse->nLabel );
drh6a8700b2017-08-02 11:04:00 +0000879 pOp->p2 = aLabel[ADDR(pOp->p2)];
880 }
drh7cc84c22016-04-11 13:36:42 +0000881 break;
882 }
drh8c8a8c42013-08-06 07:45:08 +0000883 }
drh6a8700b2017-08-02 11:04:00 +0000884 /* The mkopcodeh.tcl script has so arranged things that the only
885 ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
886 ** have non-negative values for P2. */
887 assert( (sqlite3OpcodeProperty[pOp->opcode]&OPFLG_JUMP)==0 || pOp->p2>=0);
danielk1977bc04f852005-03-29 08:26:13 +0000888 }
drh064390b2022-07-01 19:42:12 +0000889 assert( pOp>p->aOp );
drh7cc84c22016-04-11 13:36:42 +0000890 pOp--;
drh76ff3a02004-09-24 22:32:30 +0000891 }
drh064390b2022-07-01 19:42:12 +0000892resolve_p2_values_loop_exit:
drhcea170e2022-03-28 14:56:47 +0000893 if( aLabel ){
drh41ce47c2022-08-22 02:00:26 +0000894 sqlite3DbNNFreeNN(p->db, pParse->aLabel);
drhcea170e2022-03-28 14:56:47 +0000895 pParse->aLabel = 0;
896 }
drh73d5b8f2013-12-23 19:09:07 +0000897 pParse->nLabel = 0;
danielk1977bc04f852005-03-29 08:26:13 +0000898 *pMaxFuncArgs = nMaxArgs;
drha7ab6d82014-07-21 15:44:39 +0000899 assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
drh76ff3a02004-09-24 22:32:30 +0000900}
901
drhb77c3122022-04-23 18:04:31 +0000902#ifdef SQLITE_DEBUG
903/*
904** Check to see if a subroutine contains a jump to a location outside of
905** the subroutine. If a jump outside the subroutine is detected, add code
906** that will cause the program to halt with an error message.
907**
908** The subroutine consists of opcodes between iFirst and iLast. Jumps to
909** locations within the subroutine are acceptable. iRetReg is a register
910** that contains the return address. Jumps to outside the range of iFirst
911** through iLast are also acceptable as long as the jump destination is
912** an OP_Return to iReturnAddr.
913**
drh6c7e89b2022-04-23 18:34:55 +0000914** A jump to an unresolved label means that the jump destination will be
915** beyond the current address. That is normally a jump to an early
916** termination and is consider acceptable.
drhb77c3122022-04-23 18:04:31 +0000917**
918** This routine only runs during debug builds. The purpose is (of course)
919** to detect invalid escapes out of a subroutine. The OP_Halt opcode
920** is generated rather than an assert() or other error, so that ".eqp full"
921** will still work to show the original bytecode, to aid in debugging.
922*/
923void sqlite3VdbeNoJumpsOutsideSubrtn(
924 Vdbe *v, /* The byte-code program under construction */
925 int iFirst, /* First opcode of the subroutine */
926 int iLast, /* Last opcode of the subroutine */
927 int iRetReg /* Subroutine return address register */
928){
929 VdbeOp *pOp;
930 Parse *pParse;
931 int i;
932 sqlite3_str *pErr = 0;
933 assert( v!=0 );
934 pParse = v->pParse;
935 assert( pParse!=0 );
936 if( pParse->nErr ) return;
937 assert( iLast>=iFirst );
938 assert( iLast<v->nOp );
939 pOp = &v->aOp[iFirst];
940 for(i=iFirst; i<=iLast; i++, pOp++){
941 if( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 ){
942 int iDest = pOp->p2; /* Jump destination */
943 if( iDest==0 ) continue;
drh6c7e89b2022-04-23 18:34:55 +0000944 if( pOp->opcode==OP_Gosub ) continue;
drhb77c3122022-04-23 18:04:31 +0000945 if( iDest<0 ){
946 int j = ADDR(iDest);
947 assert( j>=0 );
948 if( j>=-pParse->nLabel || pParse->aLabel[j]<0 ){
drhb77c3122022-04-23 18:04:31 +0000949 continue;
950 }
951 iDest = pParse->aLabel[j];
952 }
953 if( iDest<iFirst || iDest>iLast ){
954 int j = iDest;
955 for(; j<v->nOp; j++){
956 VdbeOp *pX = &v->aOp[j];
957 if( pX->opcode==OP_Return ){
958 if( pX->p1==iRetReg ) break;
959 continue;
960 }
961 if( pX->opcode==OP_Noop ) continue;
962 if( pX->opcode==OP_Explain ) continue;
963 if( pErr==0 ){
964 pErr = sqlite3_str_new(0);
965 }else{
966 sqlite3_str_appendchar(pErr, 1, '\n');
967 }
968 sqlite3_str_appendf(pErr,
969 "Opcode at %d jumps to %d which is outside the "
970 "subroutine at %d..%d",
971 i, iDest, iFirst, iLast);
972 break;
973 }
974 }
975 }
976 }
977 if( pErr ){
978 char *zErr = sqlite3_str_finish(pErr);
979 sqlite3VdbeAddOp4(v, OP_Halt, SQLITE_INTERNAL, OE_Abort, 0, zErr, 0);
980 sqlite3_free(zErr);
981 sqlite3MayAbort(pParse);
982 }
983}
984#endif /* SQLITE_DEBUG */
985
drh76ff3a02004-09-24 22:32:30 +0000986/*
drh9a324642003-09-06 20:12:01 +0000987** Return the address of the next instruction to be inserted.
988*/
danielk19774adee202004-05-08 08:23:19 +0000989int sqlite3VdbeCurrentAddr(Vdbe *p){
drh66181ce2022-03-31 20:04:49 +0000990 assert( p->eVdbeState==VDBE_INIT_STATE );
drh9a324642003-09-06 20:12:01 +0000991 return p->nOp;
992}
993
dan65a7cd12009-09-01 12:16:01 +0000994/*
drh2ce18652016-01-16 20:50:21 +0000995** Verify that at least N opcode slots are available in p without
drhdad300d2016-01-18 00:20:26 +0000996** having to malloc for more space (except when compiled using
997** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
998** to verify that certain calls to sqlite3VdbeAddOpList() can never
999** fail due to a OOM fault and hence that the return value from
1000** sqlite3VdbeAddOpList() will always be non-NULL.
drh2ce18652016-01-16 20:50:21 +00001001*/
drhdad300d2016-01-18 00:20:26 +00001002#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
1003void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
drhb6991792018-12-28 20:14:03 +00001004 assert( p->nOp + N <= p->nOpAlloc );
drh2ce18652016-01-16 20:50:21 +00001005}
1006#endif
1007
1008/*
dan9e1ab1a2017-01-05 19:32:48 +00001009** Verify that the VM passed as the only argument does not contain
1010** an OP_ResultRow opcode. Fail an assert() if it does. This is used
1011** by code in pragma.c to ensure that the implementation of certain
1012** pragmas comports with the flags specified in the mkpragmatab.tcl
1013** script.
1014*/
1015#if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
1016void sqlite3VdbeVerifyNoResultRow(Vdbe *p){
1017 int i;
1018 for(i=0; i<p->nOp; i++){
1019 assert( p->aOp[i].opcode!=OP_ResultRow );
1020 }
1021}
1022#endif
1023
1024/*
drh4031baf2018-05-28 17:31:20 +00001025** Generate code (a single OP_Abortable opcode) that will
1026** verify that the VDBE program can safely call Abort in the current
1027** context.
1028*/
1029#if defined(SQLITE_DEBUG)
1030void sqlite3VdbeVerifyAbortable(Vdbe *p, int onError){
1031 if( onError==OE_Abort ) sqlite3VdbeAddOp0(p, OP_Abortable);
1032}
1033#endif
1034
1035/*
dan65a7cd12009-09-01 12:16:01 +00001036** This function returns a pointer to the array of opcodes associated with
1037** the Vdbe passed as the first argument. It is the callers responsibility
1038** to arrange for the returned array to be eventually freed using the
1039** vdbeFreeOpArray() function.
1040**
1041** Before returning, *pnOp is set to the number of entries in the returned
1042** array. Also, *pnMaxArg is set to the larger of its current value and
1043** the number of entries in the Vdbe.apArg[] array required to execute the
1044** returned program.
1045*/
dan165921a2009-08-28 18:53:45 +00001046VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
1047 VdbeOp *aOp = p->aOp;
dan523a0872009-08-31 05:23:32 +00001048 assert( aOp && !p->db->mallocFailed );
dan65a7cd12009-09-01 12:16:01 +00001049
1050 /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
drha7ab6d82014-07-21 15:44:39 +00001051 assert( DbMaskAllZero(p->btreeMask) );
dan65a7cd12009-09-01 12:16:01 +00001052
dan165921a2009-08-28 18:53:45 +00001053 resolveP2Values(p, pnMaxArg);
1054 *pnOp = p->nOp;
1055 p->aOp = 0;
1056 return aOp;
1057}
1058
drh9a324642003-09-06 20:12:01 +00001059/*
drh2ce18652016-01-16 20:50:21 +00001060** Add a whole list of operations to the operation stack. Return a
1061** pointer to the first operation inserted.
drh1b325542016-02-03 01:55:44 +00001062**
1063** Non-zero P2 arguments to jump instructions are automatically adjusted
1064** so that the jump target is relative to the first operation inserted.
drh9a324642003-09-06 20:12:01 +00001065*/
drh2ce18652016-01-16 20:50:21 +00001066VdbeOp *sqlite3VdbeAddOpList(
1067 Vdbe *p, /* Add opcodes to the prepared statement */
1068 int nOp, /* Number of opcodes to add */
1069 VdbeOpList const *aOp, /* The opcodes to be added */
1070 int iLineno /* Source-file line number of first opcode */
1071){
1072 int i;
1073 VdbeOp *pOut, *pFirst;
drhef41dfe2015-09-02 17:55:12 +00001074 assert( nOp>0 );
drh66181ce2022-03-31 20:04:49 +00001075 assert( p->eVdbeState==VDBE_INIT_STATE );
drhb6991792018-12-28 20:14:03 +00001076 if( p->nOp + nOp > p->nOpAlloc && growOpArray(p, nOp) ){
drh76ff3a02004-09-24 22:32:30 +00001077 return 0;
drh9a324642003-09-06 20:12:01 +00001078 }
drh2ce18652016-01-16 20:50:21 +00001079 pFirst = pOut = &p->aOp[p->nOp];
drhef41dfe2015-09-02 17:55:12 +00001080 for(i=0; i<nOp; i++, aOp++, pOut++){
drhef41dfe2015-09-02 17:55:12 +00001081 pOut->opcode = aOp->opcode;
1082 pOut->p1 = aOp->p1;
drh5ef09bf2015-12-09 17:23:12 +00001083 pOut->p2 = aOp->p2;
1084 assert( aOp->p2>=0 );
drh1b325542016-02-03 01:55:44 +00001085 if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
1086 pOut->p2 += p->nOp;
1087 }
drhef41dfe2015-09-02 17:55:12 +00001088 pOut->p3 = aOp->p3;
1089 pOut->p4type = P4_NOTUSED;
1090 pOut->p4.p = 0;
1091 pOut->p5 = 0;
drhc7379ce2013-10-30 02:28:23 +00001092#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhef41dfe2015-09-02 17:55:12 +00001093 pOut->zComment = 0;
drhc7379ce2013-10-30 02:28:23 +00001094#endif
drh688852a2014-02-17 22:40:43 +00001095#ifdef SQLITE_VDBE_COVERAGE
drhef41dfe2015-09-02 17:55:12 +00001096 pOut->iSrcLine = iLineno+i;
drh688852a2014-02-17 22:40:43 +00001097#else
drhef41dfe2015-09-02 17:55:12 +00001098 (void)iLineno;
drh688852a2014-02-17 22:40:43 +00001099#endif
drhc7379ce2013-10-30 02:28:23 +00001100#ifdef SQLITE_DEBUG
drhef41dfe2015-09-02 17:55:12 +00001101 if( p->db->flags & SQLITE_VdbeAddopTrace ){
drh2ce18652016-01-16 20:50:21 +00001102 sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
drh9a324642003-09-06 20:12:01 +00001103 }
drhef41dfe2015-09-02 17:55:12 +00001104#endif
drh9a324642003-09-06 20:12:01 +00001105 }
drhef41dfe2015-09-02 17:55:12 +00001106 p->nOp += nOp;
drh2ce18652016-01-16 20:50:21 +00001107 return pFirst;
drh9a324642003-09-06 20:12:01 +00001108}
1109
dan6f9702e2014-11-01 20:38:06 +00001110#if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
1111/*
1112** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
1113*/
dan037b5322014-11-03 11:25:32 +00001114void sqlite3VdbeScanStatus(
dan6f9702e2014-11-01 20:38:06 +00001115 Vdbe *p, /* VM to add scanstatus() to */
1116 int addrExplain, /* Address of OP_Explain (or 0) */
1117 int addrLoop, /* Address of loop counter */
1118 int addrVisit, /* Address of rows visited counter */
drh518140e2014-11-06 03:55:10 +00001119 LogEst nEst, /* Estimated number of output rows */
dan6f9702e2014-11-01 20:38:06 +00001120 const char *zName /* Name of table or index being scanned */
1121){
drh0aa32312019-04-13 04:01:12 +00001122 sqlite3_int64 nByte = (p->nScan+1) * sizeof(ScanStatus);
dan037b5322014-11-03 11:25:32 +00001123 ScanStatus *aNew;
1124 aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
dan6f9702e2014-11-01 20:38:06 +00001125 if( aNew ){
dan037b5322014-11-03 11:25:32 +00001126 ScanStatus *pNew = &aNew[p->nScan++];
dan231ff4b2022-12-02 20:32:22 +00001127 memset(pNew, 0, sizeof(ScanStatus));
dan6f9702e2014-11-01 20:38:06 +00001128 pNew->addrExplain = addrExplain;
1129 pNew->addrLoop = addrLoop;
1130 pNew->addrVisit = addrVisit;
1131 pNew->nEst = nEst;
1132 pNew->zName = sqlite3DbStrDup(p->db, zName);
1133 p->aScan = aNew;
1134 }
1135}
dan231ff4b2022-12-02 20:32:22 +00001136
dan07c8e082022-12-05 18:52:12 +00001137/*
1138** Add the range of instructions from addrStart to addrEnd (inclusive) to
1139** the set of those corresponding to the sqlite3_stmt_scanstatus() counters
1140** associated with the OP_Explain instruction at addrExplain. The
1141** sum of the sqlite3Hwtime() values for each of these instructions
1142** will be returned for SQLITE_SCANSTAT_NCYCLE requests.
1143*/
danf6f01f12022-12-03 18:16:25 +00001144void sqlite3VdbeScanStatusRange(
1145 Vdbe *p,
1146 int addrExplain,
1147 int addrStart,
1148 int addrEnd
1149){
dan231ff4b2022-12-02 20:32:22 +00001150 ScanStatus *pScan = 0;
1151 int ii;
1152 for(ii=p->nScan-1; ii>=0; ii--){
1153 pScan = &p->aScan[ii];
1154 if( pScan->addrExplain==addrExplain ) break;
1155 pScan = 0;
1156 }
1157 if( pScan ){
danf6f01f12022-12-03 18:16:25 +00001158 if( addrEnd<0 ) addrEnd = sqlite3VdbeCurrentAddr(p)-1;
1159 for(ii=0; ii<ArraySize(pScan->aAddrRange); ii+=2){
1160 if( pScan->aAddrRange[ii]==0 ){
1161 pScan->aAddrRange[ii] = addrStart;
1162 pScan->aAddrRange[ii+1] = addrEnd;
1163 break;
1164 }
1165 }
dan231ff4b2022-12-02 20:32:22 +00001166 }
1167}
dana3d0c152022-12-05 18:19:56 +00001168
dan07c8e082022-12-05 18:52:12 +00001169/*
1170** Set the addresses for the SQLITE_SCANSTAT_NLOOP and SQLITE_SCANSTAT_NROW
1171** counters for the query element associated with the OP_Explain at
1172** addrExplain.
1173*/
dana3d0c152022-12-05 18:19:56 +00001174void sqlite3VdbeScanStatusCounters(
1175 Vdbe *p,
1176 int addrExplain,
1177 int addrLoop,
1178 int addrVisit
1179){
1180 ScanStatus *pScan = 0;
1181 int ii;
1182 for(ii=p->nScan-1; ii>=0; ii--){
1183 pScan = &p->aScan[ii];
1184 if( pScan->addrExplain==addrExplain ) break;
1185 pScan = 0;
1186 }
1187 if( pScan ){
1188 pScan->addrLoop = addrLoop;
1189 pScan->addrVisit = addrVisit;
1190 }
1191}
dan6f9702e2014-11-01 20:38:06 +00001192#endif
1193
1194
drh9a324642003-09-06 20:12:01 +00001195/*
drh0ff287f2015-09-02 18:40:33 +00001196** Change the value of the opcode, or P1, P2, P3, or P5 operands
1197** for a specific instruction.
drh9a324642003-09-06 20:12:01 +00001198*/
mistachkin044388c2019-08-09 01:59:14 +00001199void sqlite3VdbeChangeOpcode(Vdbe *p, int addr, u8 iNewOpcode){
drh058e9952022-07-25 19:05:24 +00001200 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001201 sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
1202}
drh3728b842019-08-09 01:11:32 +00001203void sqlite3VdbeChangeP1(Vdbe *p, int addr, int val){
drh058e9952022-07-25 19:05:24 +00001204 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001205 sqlite3VdbeGetOp(p,addr)->p1 = val;
drh9a324642003-09-06 20:12:01 +00001206}
drh3728b842019-08-09 01:11:32 +00001207void sqlite3VdbeChangeP2(Vdbe *p, int addr, int val){
drhe6710e82022-07-26 10:16:25 +00001208 assert( addr>=0 || p->db->mallocFailed );
drh0ff287f2015-09-02 18:40:33 +00001209 sqlite3VdbeGetOp(p,addr)->p2 = val;
drh9a324642003-09-06 20:12:01 +00001210}
drh3728b842019-08-09 01:11:32 +00001211void sqlite3VdbeChangeP3(Vdbe *p, int addr, int val){
drh058e9952022-07-25 19:05:24 +00001212 assert( addr>=0 );
drh0ff287f2015-09-02 18:40:33 +00001213 sqlite3VdbeGetOp(p,addr)->p3 = val;
danielk1977207872a2008-01-03 07:54:23 +00001214}
drh585ce192017-01-25 14:58:27 +00001215void sqlite3VdbeChangeP5(Vdbe *p, u16 p5){
drhdd3bfe82016-09-29 20:28:34 +00001216 assert( p->nOp>0 || p->db->mallocFailed );
1217 if( p->nOp>0 ) p->aOp[p->nOp-1].p5 = p5;
danielk19771f4aa332008-01-03 09:51:55 +00001218}
1219
1220/*
drhe995d2c2022-10-13 12:47:33 +00001221** If the previous opcode is an OP_Column that delivers results
drh921acff2022-10-13 15:09:44 +00001222** into register iDest, then add the OPFLAG_TYPEOFARG flag to that
drhe995d2c2022-10-13 12:47:33 +00001223** opcode.
1224*/
1225void sqlite3VdbeTypeofColumn(Vdbe *p, int iDest){
drhbd1c6342022-10-13 14:35:20 +00001226 VdbeOp *pOp = sqlite3VdbeGetLastOp(p);
1227 if( pOp->p3==iDest && pOp->opcode==OP_Column ){
1228 pOp->p5 |= OPFLAG_TYPEOFARG;
drhe995d2c2022-10-13 12:47:33 +00001229 }
1230}
1231
1232/*
drhf8875402006-03-17 13:56:34 +00001233** Change the P2 operand of instruction addr so that it points to
drhd654be82005-09-20 17:42:23 +00001234** the address of the next instruction to be coded.
1235*/
1236void sqlite3VdbeJumpHere(Vdbe *p, int addr){
drh0ff287f2015-09-02 18:40:33 +00001237 sqlite3VdbeChangeP2(p, addr, p->nOp);
drhd654be82005-09-20 17:42:23 +00001238}
drhb38ad992005-09-16 00:27:01 +00001239
drhdc4f6fc2020-02-07 19:44:13 +00001240/*
1241** Change the P2 operand of the jump instruction at addr so that
1242** the jump lands on the next opcode. Or if the jump instruction was
1243** the previous opcode (and is thus a no-op) then simply back up
1244** the next instruction counter by one slot so that the jump is
1245** overwritten by the next inserted opcode.
1246**
1247** This routine is an optimization of sqlite3VdbeJumpHere() that
1248** strives to omit useless byte-code like this:
1249**
1250** 7 Once 0 8 0
1251** 8 ...
1252*/
1253void sqlite3VdbeJumpHereOrPopInst(Vdbe *p, int addr){
1254 if( addr==p->nOp-1 ){
1255 assert( p->aOp[addr].opcode==OP_Once
1256 || p->aOp[addr].opcode==OP_If
1257 || p->aOp[addr].opcode==OP_FkIfZero );
1258 assert( p->aOp[addr].p4type==0 );
1259#ifdef SQLITE_VDBE_COVERAGE
drh058e9952022-07-25 19:05:24 +00001260 sqlite3VdbeGetLastOp(p)->iSrcLine = 0; /* Erase VdbeCoverage() macros */
drhdc4f6fc2020-02-07 19:44:13 +00001261#endif
1262 p->nOp--;
1263 }else{
1264 sqlite3VdbeChangeP2(p, addr, p->nOp);
1265 }
1266}
1267
drhb7f6f682006-07-08 17:06:43 +00001268
1269/*
1270** If the input FuncDef structure is ephemeral, then free it. If
1271** the FuncDef is not ephermal, then do nothing.
1272*/
drh633e6d52008-07-28 19:34:53 +00001273static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
drh41ce47c2022-08-22 02:00:26 +00001274 assert( db!=0 );
drhf431a872016-05-20 15:53:47 +00001275 if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
drh41ce47c2022-08-22 02:00:26 +00001276 sqlite3DbNNFreeNN(db, pDef);
drhb7f6f682006-07-08 17:06:43 +00001277 }
1278}
1279
drhb38ad992005-09-16 00:27:01 +00001280/*
drh66a51672008-01-03 00:01:23 +00001281** Delete a P4 value if necessary.
drhb38ad992005-09-16 00:27:01 +00001282*/
drhf431a872016-05-20 15:53:47 +00001283static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
1284 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh41ce47c2022-08-22 02:00:26 +00001285 sqlite3DbNNFreeNN(db, p);
drhf431a872016-05-20 15:53:47 +00001286}
1287static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
drh41ce47c2022-08-22 02:00:26 +00001288 assert( db!=0 );
drhf431a872016-05-20 15:53:47 +00001289 freeEphemeralFunction(db, p->pFunc);
drh41ce47c2022-08-22 02:00:26 +00001290 sqlite3DbNNFreeNN(db, p);
drhf431a872016-05-20 15:53:47 +00001291}
drh633e6d52008-07-28 19:34:53 +00001292static void freeP4(sqlite3 *db, int p4type, void *p4){
drhbe5000d2016-04-07 14:05:20 +00001293 assert( db );
1294 switch( p4type ){
1295 case P4_FUNCCTX: {
drhf431a872016-05-20 15:53:47 +00001296 freeP4FuncCtx(db, (sqlite3_context*)p4);
1297 break;
drhbe5000d2016-04-07 14:05:20 +00001298 }
1299 case P4_REAL:
1300 case P4_INT64:
1301 case P4_DYNAMIC:
1302 case P4_INTARRAY: {
drh41ce47c2022-08-22 02:00:26 +00001303 if( p4 ) sqlite3DbNNFreeNN(db, p4);
drhbe5000d2016-04-07 14:05:20 +00001304 break;
1305 }
1306 case P4_KEYINFO: {
1307 if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
1308 break;
1309 }
drh28935362013-12-07 20:39:19 +00001310#ifdef SQLITE_ENABLE_CURSOR_HINTS
drhbe5000d2016-04-07 14:05:20 +00001311 case P4_EXPR: {
1312 sqlite3ExprDelete(db, (Expr*)p4);
1313 break;
1314 }
drh28935362013-12-07 20:39:19 +00001315#endif
drhbe5000d2016-04-07 14:05:20 +00001316 case P4_FUNCDEF: {
1317 freeEphemeralFunction(db, (FuncDef*)p4);
1318 break;
1319 }
1320 case P4_MEM: {
1321 if( db->pnBytesFreed==0 ){
1322 sqlite3ValueFree((sqlite3_value*)p4);
1323 }else{
drhf431a872016-05-20 15:53:47 +00001324 freeP4Mem(db, (Mem*)p4);
drhb9755982010-07-24 16:34:37 +00001325 }
drhbe5000d2016-04-07 14:05:20 +00001326 break;
1327 }
1328 case P4_VTAB : {
1329 if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
1330 break;
drhb38ad992005-09-16 00:27:01 +00001331 }
1332 }
1333}
1334
dan65a7cd12009-09-01 12:16:01 +00001335/*
1336** Free the space allocated for aOp and any p4 values allocated for the
1337** opcodes contained within. If aOp is not NULL it is assumed to contain
1338** nOp entries.
1339*/
dan165921a2009-08-28 18:53:45 +00001340static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
drh60a512d2022-03-28 15:06:36 +00001341 assert( nOp>=0 );
drh41ce47c2022-08-22 02:00:26 +00001342 assert( db!=0 );
dan165921a2009-08-28 18:53:45 +00001343 if( aOp ){
drh60a512d2022-03-28 15:06:36 +00001344 Op *pOp = &aOp[nOp-1];
1345 while(1){ /* Exit via break */
drh0c243302017-07-12 20:43:23 +00001346 if( pOp->p4type <= P4_FREE_IF_LE ) freeP4(db, pOp->p4type, pOp->p4.p);
drhc7379ce2013-10-30 02:28:23 +00001347#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
dan165921a2009-08-28 18:53:45 +00001348 sqlite3DbFree(db, pOp->zComment);
1349#endif
drh60a512d2022-03-28 15:06:36 +00001350 if( pOp==aOp ) break;
1351 pOp--;
dan165921a2009-08-28 18:53:45 +00001352 }
drh41ce47c2022-08-22 02:00:26 +00001353 sqlite3DbNNFreeNN(db, aOp);
dan165921a2009-08-28 18:53:45 +00001354 }
dan165921a2009-08-28 18:53:45 +00001355}
1356
dan65a7cd12009-09-01 12:16:01 +00001357/*
dand19c9332010-07-26 12:05:17 +00001358** Link the SubProgram object passed as the second argument into the linked
1359** list at Vdbe.pSubProgram. This list is used to delete all sub-program
1360** objects when the VM is no longer required.
dan65a7cd12009-09-01 12:16:01 +00001361*/
dand19c9332010-07-26 12:05:17 +00001362void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
1363 p->pNext = pVdbe->pProgram;
1364 pVdbe->pProgram = p;
dan165921a2009-08-28 18:53:45 +00001365}
1366
drh9a324642003-09-06 20:12:01 +00001367/*
drh06baba52019-10-24 19:35:26 +00001368** Return true if the given Vdbe has any SubPrograms.
1369*/
1370int sqlite3VdbeHasSubProgram(Vdbe *pVdbe){
1371 return pVdbe->pProgram!=0;
1372}
1373
1374/*
drh48f2d3b2011-09-16 01:34:43 +00001375** Change the opcode at addr into OP_Noop
drhf8875402006-03-17 13:56:34 +00001376*/
drh2ce18652016-01-16 20:50:21 +00001377int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
1378 VdbeOp *pOp;
1379 if( p->db->mallocFailed ) return 0;
1380 assert( addr>=0 && addr<p->nOp );
1381 pOp = &p->aOp[addr];
1382 freeP4(p->db, pOp->p4type, pOp->p4.p);
drh4b31bda2016-01-20 02:01:02 +00001383 pOp->p4type = P4_NOTUSED;
drh939e7782016-01-20 02:36:12 +00001384 pOp->p4.z = 0;
drh2ce18652016-01-16 20:50:21 +00001385 pOp->opcode = OP_Noop;
1386 return 1;
drhf8875402006-03-17 13:56:34 +00001387}
1388
1389/*
drh39c4b822014-09-29 15:42:01 +00001390** If the last opcode is "op" and it is not a jump destination,
1391** then remove it. Return true if and only if an opcode was removed.
drh762c1c42014-01-02 19:35:30 +00001392*/
drh61019c72014-01-04 16:49:02 +00001393int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
drh2831c4d2016-09-29 19:50:02 +00001394 if( p->nOp>0 && p->aOp[p->nOp-1].opcode==op ){
drh2ce18652016-01-16 20:50:21 +00001395 return sqlite3VdbeChangeToNoop(p, p->nOp-1);
drh61019c72014-01-04 16:49:02 +00001396 }else{
1397 return 0;
1398 }
drh762c1c42014-01-02 19:35:30 +00001399}
1400
drh13d79502019-12-23 02:18:49 +00001401#ifdef SQLITE_DEBUG
1402/*
1403** Generate an OP_ReleaseReg opcode to indicate that a range of
1404** registers, except any identified by mask, are no longer in use.
1405*/
drh3aef2fb2020-01-02 17:46:02 +00001406void sqlite3VdbeReleaseRegisters(
1407 Parse *pParse, /* Parsing context */
1408 int iFirst, /* Index of first register to be released */
1409 int N, /* Number of registers to release */
1410 u32 mask, /* Mask of registers to NOT release */
1411 int bUndefine /* If true, mark registers as undefined */
1412){
drhda4c7cc2022-04-07 18:17:56 +00001413 if( N==0 || OptimizationDisabled(pParse->db, SQLITE_ReleaseReg) ) return;
drh13d79502019-12-23 02:18:49 +00001414 assert( pParse->pVdbe );
drh3aef2fb2020-01-02 17:46:02 +00001415 assert( iFirst>=1 );
1416 assert( iFirst+N-1<=pParse->nMem );
drhb2fe5a72020-01-10 01:05:49 +00001417 if( N<=31 && mask!=0 ){
1418 while( N>0 && (mask&1)!=0 ){
1419 mask >>= 1;
1420 iFirst++;
1421 N--;
1422 }
1423 while( N>0 && N<=32 && (mask & MASKBIT32(N-1))!=0 ){
1424 mask &= ~MASKBIT32(N-1);
1425 N--;
1426 }
drh13d79502019-12-23 02:18:49 +00001427 }
1428 if( N>0 ){
1429 sqlite3VdbeAddOp3(pParse->pVdbe, OP_ReleaseReg, iFirst, N, *(int*)&mask);
drh3aef2fb2020-01-02 17:46:02 +00001430 if( bUndefine ) sqlite3VdbeChangeP5(pParse->pVdbe, 1);
drh13d79502019-12-23 02:18:49 +00001431 }
1432}
1433#endif /* SQLITE_DEBUG */
1434
1435
drh762c1c42014-01-02 19:35:30 +00001436/*
drh66a51672008-01-03 00:01:23 +00001437** Change the value of the P4 operand for a specific instruction.
drh9a324642003-09-06 20:12:01 +00001438** This routine is useful when a large program is loaded from a
danielk19774adee202004-05-08 08:23:19 +00001439** static array using sqlite3VdbeAddOpList but we want to make a
drh9a324642003-09-06 20:12:01 +00001440** few minor changes to the program.
1441**
drh66a51672008-01-03 00:01:23 +00001442** If n>=0 then the P4 operand is dynamic, meaning that a copy of
drh17435752007-08-16 04:30:38 +00001443** the string is made into memory obtained from sqlite3_malloc().
drh66a51672008-01-03 00:01:23 +00001444** A value of n==0 means copy bytes of zP4 up to and including the
1445** first null byte. If n>0 then copy n+1 bytes of zP4.
danielk19771f55c052005-05-19 08:42:59 +00001446**
drh66a51672008-01-03 00:01:23 +00001447** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
danielk19771f55c052005-05-19 08:42:59 +00001448** to a string or structure that is guaranteed to exist for the lifetime of
1449** the Vdbe. In these cases we can just copy the pointer.
drh9a324642003-09-06 20:12:01 +00001450**
drh66a51672008-01-03 00:01:23 +00001451** If addr<0 then change P4 on the most recently inserted instruction.
drh9a324642003-09-06 20:12:01 +00001452*/
drh00dceca2016-01-11 22:58:50 +00001453static void SQLITE_NOINLINE vdbeChangeP4Full(
1454 Vdbe *p,
1455 Op *pOp,
1456 const char *zP4,
1457 int n
1458){
1459 if( pOp->p4type ){
1460 freeP4(p->db, pOp->p4type, pOp->p4.p);
1461 pOp->p4type = 0;
1462 pOp->p4.p = 0;
1463 }
1464 if( n<0 ){
1465 sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
1466 }else{
1467 if( n==0 ) n = sqlite3Strlen30(zP4);
1468 pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
1469 pOp->p4type = P4_DYNAMIC;
1470 }
1471}
drh66a51672008-01-03 00:01:23 +00001472void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
drh9a324642003-09-06 20:12:01 +00001473 Op *pOp;
drh633e6d52008-07-28 19:34:53 +00001474 sqlite3 *db;
drh91fd4d42008-01-19 20:11:25 +00001475 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +00001476 db = p->db;
drh66181ce2022-03-31 20:04:49 +00001477 assert( p->eVdbeState==VDBE_INIT_STATE );
drh00dceca2016-01-11 22:58:50 +00001478 assert( p->aOp!=0 || db->mallocFailed );
1479 if( db->mallocFailed ){
1480 if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
danielk1977d5d56522005-03-16 12:15:20 +00001481 return;
1482 }
drh7b746032009-06-26 12:15:22 +00001483 assert( p->nOp>0 );
drh91fd4d42008-01-19 20:11:25 +00001484 assert( addr<p->nOp );
1485 if( addr<0 ){
drh9a324642003-09-06 20:12:01 +00001486 addr = p->nOp - 1;
drh9a324642003-09-06 20:12:01 +00001487 }
1488 pOp = &p->aOp[addr];
drh00dceca2016-01-11 22:58:50 +00001489 if( n>=0 || pOp->p4type ){
1490 vdbeChangeP4Full(p, pOp, zP4, n);
1491 return;
1492 }
drh98757152008-01-09 23:04:12 +00001493 if( n==P4_INT32 ){
mlcreech12d40822008-03-06 07:35:21 +00001494 /* Note: this cast is safe, because the origin data point was an int
1495 ** that was cast to a (const char *). */
shane1fc41292008-07-08 22:28:48 +00001496 pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
drh8df32842008-12-09 02:51:23 +00001497 pOp->p4type = P4_INT32;
drh00dceca2016-01-11 22:58:50 +00001498 }else if( zP4!=0 ){
1499 assert( n<0 );
danielk19772dca4ac2008-01-03 11:50:29 +00001500 pOp->p4.p = (void*)zP4;
drh8df32842008-12-09 02:51:23 +00001501 pOp->p4type = (signed char)n;
drh00dceca2016-01-11 22:58:50 +00001502 if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
drh9a324642003-09-06 20:12:01 +00001503 }
1504}
1505
drh2ec2fb22013-11-06 19:59:23 +00001506/*
drhf14b7fb2016-12-07 21:35:55 +00001507** Change the P4 operand of the most recently coded instruction
1508** to the value defined by the arguments. This is a high-speed
1509** version of sqlite3VdbeChangeP4().
1510**
1511** The P4 operand must not have been previously defined. And the new
1512** P4 must not be P4_INT32. Use sqlite3VdbeChangeP4() in either of
1513** those cases.
1514*/
1515void sqlite3VdbeAppendP4(Vdbe *p, void *pP4, int n){
1516 VdbeOp *pOp;
1517 assert( n!=P4_INT32 && n!=P4_VTAB );
1518 assert( n<=0 );
1519 if( p->db->mallocFailed ){
1520 freeP4(p->db, n, pP4);
1521 }else{
drh75fba2f2022-11-30 20:22:31 +00001522 assert( pP4!=0 || n==P4_DYNAMIC );
drhf14b7fb2016-12-07 21:35:55 +00001523 assert( p->nOp>0 );
1524 pOp = &p->aOp[p->nOp-1];
1525 assert( pOp->p4type==P4_NOTUSED );
1526 pOp->p4type = n;
1527 pOp->p4.p = pP4;
1528 }
1529}
1530
1531/*
drh2ec2fb22013-11-06 19:59:23 +00001532** Set the P4 on the most recently added opcode to the KeyInfo for the
1533** index given.
1534*/
1535void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
1536 Vdbe *v = pParse->pVdbe;
drhf14b7fb2016-12-07 21:35:55 +00001537 KeyInfo *pKeyInfo;
drh2ec2fb22013-11-06 19:59:23 +00001538 assert( v!=0 );
1539 assert( pIdx!=0 );
drhf14b7fb2016-12-07 21:35:55 +00001540 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pIdx);
1541 if( pKeyInfo ) sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
drh2ec2fb22013-11-06 19:59:23 +00001542}
1543
drhc7379ce2013-10-30 02:28:23 +00001544#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhad6d9462004-09-19 02:15:24 +00001545/*
mistachkind5578432012-08-25 10:01:29 +00001546** Change the comment on the most recently coded instruction. Or
drh16ee60f2008-06-20 18:13:25 +00001547** insert a No-op and add the comment to that new instruction. This
1548** makes the code easier to read during debugging. None of this happens
1549** in a production build.
drhad6d9462004-09-19 02:15:24 +00001550*/
drhb07028f2011-10-14 21:49:18 +00001551static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
danielk197701256832007-04-18 14:24:32 +00001552 assert( p->nOp>0 || p->aOp==0 );
drh0c7d3d32022-01-24 16:47:12 +00001553 assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->pParse->nErr>0 );
danielk1977dba01372008-01-05 18:44:29 +00001554 if( p->nOp ){
drhb07028f2011-10-14 21:49:18 +00001555 assert( p->aOp );
1556 sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
1557 p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
1558 }
1559}
1560void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
1561 va_list ap;
1562 if( p ){
danielk1977dba01372008-01-05 18:44:29 +00001563 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001564 vdbeVComment(p, zFormat, ap);
danielk1977dba01372008-01-05 18:44:29 +00001565 va_end(ap);
1566 }
drhad6d9462004-09-19 02:15:24 +00001567}
drh16ee60f2008-06-20 18:13:25 +00001568void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
1569 va_list ap;
drhb07028f2011-10-14 21:49:18 +00001570 if( p ){
1571 sqlite3VdbeAddOp0(p, OP_Noop);
drh16ee60f2008-06-20 18:13:25 +00001572 va_start(ap, zFormat);
drhb07028f2011-10-14 21:49:18 +00001573 vdbeVComment(p, zFormat, ap);
drh16ee60f2008-06-20 18:13:25 +00001574 va_end(ap);
1575 }
1576}
1577#endif /* NDEBUG */
drhad6d9462004-09-19 02:15:24 +00001578
drh688852a2014-02-17 22:40:43 +00001579#ifdef SQLITE_VDBE_COVERAGE
1580/*
1581** Set the value if the iSrcLine field for the previously coded instruction.
1582*/
1583void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
drh058e9952022-07-25 19:05:24 +00001584 sqlite3VdbeGetLastOp(v)->iSrcLine = iLine;
drh688852a2014-02-17 22:40:43 +00001585}
1586#endif /* SQLITE_VDBE_COVERAGE */
1587
drh9a324642003-09-06 20:12:01 +00001588/*
drh058e9952022-07-25 19:05:24 +00001589** Return the opcode for a given address. The address must be non-negative.
1590** See sqlite3VdbeGetLastOp() to get the most recently added opcode.
drh20411ea2009-05-29 19:00:12 +00001591**
1592** If a memory allocation error has occurred prior to the calling of this
1593** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
drhf83dc1e2010-06-03 12:09:52 +00001594** is readable but not writable, though it is cast to a writable value.
1595** The return of a dummy opcode allows the call to continue functioning
peter.d.reid60ec9142014-09-06 16:39:46 +00001596** after an OOM fault without having to check to see if the return from
drhf83dc1e2010-06-03 12:09:52 +00001597** this routine is a valid pointer. But because the dummy.opcode is 0,
1598** dummy will never be written to. This is verified by code inspection and
1599** by running with Valgrind.
drh9a324642003-09-06 20:12:01 +00001600*/
danielk19774adee202004-05-08 08:23:19 +00001601VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
drha0b75da2010-07-02 18:44:37 +00001602 /* C89 specifies that the constant "dummy" will be initialized to all
1603 ** zeros, which is correct. MSVC generates a warning, nevertheless. */
mistachkin0fe5f952011-09-14 18:19:08 +00001604 static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
drh66181ce2022-03-31 20:04:49 +00001605 assert( p->eVdbeState==VDBE_INIT_STATE );
drh17435752007-08-16 04:30:38 +00001606 assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
drh20411ea2009-05-29 19:00:12 +00001607 if( p->db->mallocFailed ){
drhf83dc1e2010-06-03 12:09:52 +00001608 return (VdbeOp*)&dummy;
drh20411ea2009-05-29 19:00:12 +00001609 }else{
1610 return &p->aOp[addr];
1611 }
drh9a324642003-09-06 20:12:01 +00001612}
1613
drh058e9952022-07-25 19:05:24 +00001614/* Return the most recently added opcode
1615*/
1616VdbeOp * sqlite3VdbeGetLastOp(Vdbe *p){
1617 return sqlite3VdbeGetOp(p, p->nOp - 1);
1618}
1619
drhc7379ce2013-10-30 02:28:23 +00001620#if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
drh81316f82013-10-29 20:40:47 +00001621/*
drhf63552b2013-10-30 00:25:03 +00001622** Return an integer value for one of the parameters to the opcode pOp
1623** determined by character c.
1624*/
1625static int translateP(char c, const Op *pOp){
1626 if( c=='1' ) return pOp->p1;
1627 if( c=='2' ) return pOp->p2;
1628 if( c=='3' ) return pOp->p3;
1629 if( c=='4' ) return pOp->p4.i;
1630 return pOp->p5;
1631}
1632
drh81316f82013-10-29 20:40:47 +00001633/*
drh4eded602013-12-20 15:59:20 +00001634** Compute a string for the "comment" field of a VDBE opcode listing.
1635**
1636** The Synopsis: field in comments in the vdbe.c source file gets converted
1637** to an extra string that is appended to the sqlite3OpcodeName(). In the
1638** absence of other comments, this synopsis becomes the comment on the opcode.
1639** Some translation occurs:
1640**
1641** "PX" -> "r[X]"
1642** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
1643** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
1644** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
drh81316f82013-10-29 20:40:47 +00001645*/
drh8c5163a2020-03-23 20:58:55 +00001646char *sqlite3VdbeDisplayComment(
drhcb49f542020-03-23 19:14:11 +00001647 sqlite3 *db, /* Optional - Oom error reporting only */
drhf63552b2013-10-30 00:25:03 +00001648 const Op *pOp, /* The opcode to be commented */
drhcb49f542020-03-23 19:14:11 +00001649 const char *zP4 /* Previously obtained value for P4 */
drhf63552b2013-10-30 00:25:03 +00001650){
drh81316f82013-10-29 20:40:47 +00001651 const char *zOpName;
1652 const char *zSynopsis;
1653 int nOpName;
drhd7b10d72020-02-01 17:38:24 +00001654 int ii;
drh1ad78c52016-08-27 14:05:12 +00001655 char zAlt[50];
drhd7b10d72020-02-01 17:38:24 +00001656 StrAccum x;
drhd7b10d72020-02-01 17:38:24 +00001657
drhcb49f542020-03-23 19:14:11 +00001658 sqlite3StrAccumInit(&x, 0, 0, 0, SQLITE_MAX_LENGTH);
drh81316f82013-10-29 20:40:47 +00001659 zOpName = sqlite3OpcodeName(pOp->opcode);
1660 nOpName = sqlite3Strlen30(zOpName);
1661 if( zOpName[nOpName+1] ){
1662 int seenCom = 0;
drhf63552b2013-10-30 00:25:03 +00001663 char c;
drh7d4c94b2021-10-04 22:34:38 +00001664 zSynopsis = zOpName + nOpName + 1;
drh1ad78c52016-08-27 14:05:12 +00001665 if( strncmp(zSynopsis,"IF ",3)==0 ){
drh4bc20452021-03-29 18:53:47 +00001666 sqlite3_snprintf(sizeof(zAlt), zAlt, "if %s goto P2", zSynopsis+3);
drh1ad78c52016-08-27 14:05:12 +00001667 zSynopsis = zAlt;
1668 }
drhd7b10d72020-02-01 17:38:24 +00001669 for(ii=0; (c = zSynopsis[ii])!=0; ii++){
drhf63552b2013-10-30 00:25:03 +00001670 if( c=='P' ){
1671 c = zSynopsis[++ii];
1672 if( c=='4' ){
drhd7b10d72020-02-01 17:38:24 +00001673 sqlite3_str_appendall(&x, zP4);
drhf63552b2013-10-30 00:25:03 +00001674 }else if( c=='X' ){
drh088b6152022-04-18 13:57:57 +00001675 if( pOp->zComment && pOp->zComment[0] ){
1676 sqlite3_str_appendall(&x, pOp->zComment);
drhd83997b2022-05-14 17:40:47 +00001677 seenCom = 1;
1678 break;
drh088b6152022-04-18 13:57:57 +00001679 }
drh81316f82013-10-29 20:40:47 +00001680 }else{
drhf63552b2013-10-30 00:25:03 +00001681 int v1 = translateP(c, pOp);
1682 int v2;
drhf63552b2013-10-30 00:25:03 +00001683 if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
1684 ii += 3;
drhf63552b2013-10-30 00:25:03 +00001685 v2 = translateP(zSynopsis[ii], pOp);
drh4eded602013-12-20 15:59:20 +00001686 if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
1687 ii += 2;
1688 v2++;
1689 }
drhd7b10d72020-02-01 17:38:24 +00001690 if( v2<2 ){
1691 sqlite3_str_appendf(&x, "%d", v1);
1692 }else{
1693 sqlite3_str_appendf(&x, "%d..%d", v1, v1+v2-1);
drh4eded602013-12-20 15:59:20 +00001694 }
drhd7b10d72020-02-01 17:38:24 +00001695 }else if( strncmp(zSynopsis+ii+1, "@NP", 3)==0 ){
1696 sqlite3_context *pCtx = pOp->p4.pCtx;
drh40d1db82020-02-04 00:55:27 +00001697 if( pOp->p4type!=P4_FUNCCTX || pCtx->argc==1 ){
drhd7b10d72020-02-01 17:38:24 +00001698 sqlite3_str_appendf(&x, "%d", v1);
1699 }else if( pCtx->argc>1 ){
1700 sqlite3_str_appendf(&x, "%d..%d", v1, v1+pCtx->argc-1);
drh1a56fce2020-10-20 12:37:51 +00001701 }else if( x.accError==0 ){
drhd7b10d72020-02-01 17:38:24 +00001702 assert( x.nChar>2 );
1703 x.nChar -= 2;
1704 ii++;
1705 }
1706 ii += 3;
1707 }else{
1708 sqlite3_str_appendf(&x, "%d", v1);
1709 if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
1710 ii += 4;
1711 }
drhf63552b2013-10-30 00:25:03 +00001712 }
drh81316f82013-10-29 20:40:47 +00001713 }
drh81316f82013-10-29 20:40:47 +00001714 }else{
drhd7b10d72020-02-01 17:38:24 +00001715 sqlite3_str_appendchar(&x, 1, c);
drh81316f82013-10-29 20:40:47 +00001716 }
1717 }
drhd7b10d72020-02-01 17:38:24 +00001718 if( !seenCom && pOp->zComment ){
1719 sqlite3_str_appendf(&x, "; %s", pOp->zComment);
drh81316f82013-10-29 20:40:47 +00001720 }
drh81316f82013-10-29 20:40:47 +00001721 }else if( pOp->zComment ){
drhd7b10d72020-02-01 17:38:24 +00001722 sqlite3_str_appendall(&x, pOp->zComment);
drh81316f82013-10-29 20:40:47 +00001723 }
drhcb49f542020-03-23 19:14:11 +00001724 if( (x.accError & SQLITE_NOMEM)!=0 && db!=0 ){
1725 sqlite3OomFault(db);
1726 }
1727 return sqlite3StrAccumFinish(&x);
drh81316f82013-10-29 20:40:47 +00001728}
drhe0ef4e22020-04-02 12:53:17 +00001729#endif /* SQLITE_ENABLE_EXPLAIN_COMMENTS */
drh81316f82013-10-29 20:40:47 +00001730
drhf7e36902015-08-13 21:32:41 +00001731#if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
1732/*
1733** Translate the P4.pExpr value for an OP_CursorHint opcode into text
1734** that can be displayed in the P4 column of EXPLAIN output.
1735*/
drh5f4a6862016-01-30 12:50:25 +00001736static void displayP4Expr(StrAccum *p, Expr *pExpr){
drha67a3162015-08-15 00:51:23 +00001737 const char *zOp = 0;
drhf7e36902015-08-13 21:32:41 +00001738 switch( pExpr->op ){
1739 case TK_STRING:
drhf9751072021-10-07 13:40:29 +00001740 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh0cdbe1a2018-05-09 13:46:26 +00001741 sqlite3_str_appendf(p, "%Q", pExpr->u.zToken);
drhf7e36902015-08-13 21:32:41 +00001742 break;
drhf7e36902015-08-13 21:32:41 +00001743 case TK_INTEGER:
drh0cdbe1a2018-05-09 13:46:26 +00001744 sqlite3_str_appendf(p, "%d", pExpr->u.iValue);
drhf7e36902015-08-13 21:32:41 +00001745 break;
drhf7e36902015-08-13 21:32:41 +00001746 case TK_NULL:
drh0cdbe1a2018-05-09 13:46:26 +00001747 sqlite3_str_appendf(p, "NULL");
drhf7e36902015-08-13 21:32:41 +00001748 break;
drhf7e36902015-08-13 21:32:41 +00001749 case TK_REGISTER: {
drh0cdbe1a2018-05-09 13:46:26 +00001750 sqlite3_str_appendf(p, "r[%d]", pExpr->iTable);
drhf7e36902015-08-13 21:32:41 +00001751 break;
1752 }
drhf7e36902015-08-13 21:32:41 +00001753 case TK_COLUMN: {
drhfe663522015-08-14 01:03:21 +00001754 if( pExpr->iColumn<0 ){
drh0cdbe1a2018-05-09 13:46:26 +00001755 sqlite3_str_appendf(p, "rowid");
drhfe663522015-08-14 01:03:21 +00001756 }else{
drh0cdbe1a2018-05-09 13:46:26 +00001757 sqlite3_str_appendf(p, "c%d", (int)pExpr->iColumn);
drhfe663522015-08-14 01:03:21 +00001758 }
drhf7e36902015-08-13 21:32:41 +00001759 break;
1760 }
drha67a3162015-08-15 00:51:23 +00001761 case TK_LT: zOp = "LT"; break;
1762 case TK_LE: zOp = "LE"; break;
1763 case TK_GT: zOp = "GT"; break;
1764 case TK_GE: zOp = "GE"; break;
1765 case TK_NE: zOp = "NE"; break;
1766 case TK_EQ: zOp = "EQ"; break;
1767 case TK_IS: zOp = "IS"; break;
1768 case TK_ISNOT: zOp = "ISNOT"; break;
1769 case TK_AND: zOp = "AND"; break;
1770 case TK_OR: zOp = "OR"; break;
1771 case TK_PLUS: zOp = "ADD"; break;
1772 case TK_STAR: zOp = "MUL"; break;
1773 case TK_MINUS: zOp = "SUB"; break;
1774 case TK_REM: zOp = "REM"; break;
1775 case TK_BITAND: zOp = "BITAND"; break;
1776 case TK_BITOR: zOp = "BITOR"; break;
1777 case TK_SLASH: zOp = "DIV"; break;
1778 case TK_LSHIFT: zOp = "LSHIFT"; break;
1779 case TK_RSHIFT: zOp = "RSHIFT"; break;
1780 case TK_CONCAT: zOp = "CONCAT"; break;
1781 case TK_UMINUS: zOp = "MINUS"; break;
1782 case TK_UPLUS: zOp = "PLUS"; break;
1783 case TK_BITNOT: zOp = "BITNOT"; break;
1784 case TK_NOT: zOp = "NOT"; break;
1785 case TK_ISNULL: zOp = "ISNULL"; break;
1786 case TK_NOTNULL: zOp = "NOTNULL"; break;
drh81316f82013-10-29 20:40:47 +00001787
drhf7e36902015-08-13 21:32:41 +00001788 default:
drh0cdbe1a2018-05-09 13:46:26 +00001789 sqlite3_str_appendf(p, "%s", "expr");
drhf7e36902015-08-13 21:32:41 +00001790 break;
1791 }
1792
drha67a3162015-08-15 00:51:23 +00001793 if( zOp ){
drh0cdbe1a2018-05-09 13:46:26 +00001794 sqlite3_str_appendf(p, "%s(", zOp);
drh5f4a6862016-01-30 12:50:25 +00001795 displayP4Expr(p, pExpr->pLeft);
1796 if( pExpr->pRight ){
drh0cdbe1a2018-05-09 13:46:26 +00001797 sqlite3_str_append(p, ",", 1);
drh5f4a6862016-01-30 12:50:25 +00001798 displayP4Expr(p, pExpr->pRight);
drha67a3162015-08-15 00:51:23 +00001799 }
drh0cdbe1a2018-05-09 13:46:26 +00001800 sqlite3_str_append(p, ")", 1);
drhf7e36902015-08-13 21:32:41 +00001801 }
drhf7e36902015-08-13 21:32:41 +00001802}
1803#endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
1804
1805
1806#if VDBE_DISPLAY_P4
drh9a324642003-09-06 20:12:01 +00001807/*
drh66a51672008-01-03 00:01:23 +00001808** Compute a string that describes the P4 parameter for an opcode.
drhd3d39e92004-05-20 22:16:29 +00001809** Use zTemp for any required temporary buffer space.
1810*/
drh8c5163a2020-03-23 20:58:55 +00001811char *sqlite3VdbeDisplayP4(sqlite3 *db, Op *pOp){
drhcb49f542020-03-23 19:14:11 +00001812 char *zP4 = 0;
drh5f4a6862016-01-30 12:50:25 +00001813 StrAccum x;
drhcb49f542020-03-23 19:14:11 +00001814
1815 sqlite3StrAccumInit(&x, 0, 0, 0, SQLITE_MAX_LENGTH);
drh66a51672008-01-03 00:01:23 +00001816 switch( pOp->p4type ){
1817 case P4_KEYINFO: {
drh5f4a6862016-01-30 12:50:25 +00001818 int j;
danielk19772dca4ac2008-01-03 11:50:29 +00001819 KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +00001820 assert( pKeyInfo->aSortFlags!=0 );
drh0cdbe1a2018-05-09 13:46:26 +00001821 sqlite3_str_appendf(&x, "k(%d", pKeyInfo->nKeyField);
drha485ad12017-08-02 22:43:14 +00001822 for(j=0; j<pKeyInfo->nKeyField; j++){
drhd3d39e92004-05-20 22:16:29 +00001823 CollSeq *pColl = pKeyInfo->aColl[j];
drh5f4a6862016-01-30 12:50:25 +00001824 const char *zColl = pColl ? pColl->zName : "";
1825 if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
dan6e118922019-08-12 16:36:38 +00001826 sqlite3_str_appendf(&x, ",%s%s%s",
1827 (pKeyInfo->aSortFlags[j] & KEYINFO_ORDER_DESC) ? "-" : "",
1828 (pKeyInfo->aSortFlags[j] & KEYINFO_ORDER_BIGNULL)? "N." : "",
1829 zColl);
drhd3d39e92004-05-20 22:16:29 +00001830 }
drh0cdbe1a2018-05-09 13:46:26 +00001831 sqlite3_str_append(&x, ")", 1);
drhd3d39e92004-05-20 22:16:29 +00001832 break;
1833 }
drh28935362013-12-07 20:39:19 +00001834#ifdef SQLITE_ENABLE_CURSOR_HINTS
1835 case P4_EXPR: {
drh5f4a6862016-01-30 12:50:25 +00001836 displayP4Expr(&x, pOp->p4.pExpr);
drh28935362013-12-07 20:39:19 +00001837 break;
1838 }
1839#endif
drh66a51672008-01-03 00:01:23 +00001840 case P4_COLLSEQ: {
drh4cf21212020-03-05 14:19:49 +00001841 static const char *const encnames[] = {"?", "8", "16LE", "16BE"};
danielk19772dca4ac2008-01-03 11:50:29 +00001842 CollSeq *pColl = pOp->p4.pColl;
drh5025cb52021-07-29 17:23:23 +00001843 assert( pColl->enc<4 );
drh4cf21212020-03-05 14:19:49 +00001844 sqlite3_str_appendf(&x, "%.18s-%s", pColl->zName,
1845 encnames[pColl->enc]);
drhd3d39e92004-05-20 22:16:29 +00001846 break;
1847 }
drh66a51672008-01-03 00:01:23 +00001848 case P4_FUNCDEF: {
danielk19772dca4ac2008-01-03 11:50:29 +00001849 FuncDef *pDef = pOp->p4.pFunc;
drh0cdbe1a2018-05-09 13:46:26 +00001850 sqlite3_str_appendf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drhf9b596e2004-05-26 16:54:42 +00001851 break;
1852 }
drh9c7c9132015-06-26 18:16:52 +00001853 case P4_FUNCCTX: {
1854 FuncDef *pDef = pOp->p4.pCtx->pFunc;
drh0cdbe1a2018-05-09 13:46:26 +00001855 sqlite3_str_appendf(&x, "%s(%d)", pDef->zName, pDef->nArg);
drh9c7c9132015-06-26 18:16:52 +00001856 break;
1857 }
drh66a51672008-01-03 00:01:23 +00001858 case P4_INT64: {
drh0cdbe1a2018-05-09 13:46:26 +00001859 sqlite3_str_appendf(&x, "%lld", *pOp->p4.pI64);
drhd4e70eb2008-01-02 00:34:36 +00001860 break;
1861 }
drh66a51672008-01-03 00:01:23 +00001862 case P4_INT32: {
drh0cdbe1a2018-05-09 13:46:26 +00001863 sqlite3_str_appendf(&x, "%d", pOp->p4.i);
drh598f1342007-10-23 15:39:45 +00001864 break;
1865 }
drh66a51672008-01-03 00:01:23 +00001866 case P4_REAL: {
drh0cdbe1a2018-05-09 13:46:26 +00001867 sqlite3_str_appendf(&x, "%.16g", *pOp->p4.pReal);
drhd4e70eb2008-01-02 00:34:36 +00001868 break;
1869 }
drh66a51672008-01-03 00:01:23 +00001870 case P4_MEM: {
danielk19772dca4ac2008-01-03 11:50:29 +00001871 Mem *pMem = pOp->p4.pMem;
drhd4e70eb2008-01-02 00:34:36 +00001872 if( pMem->flags & MEM_Str ){
drh66a51672008-01-03 00:01:23 +00001873 zP4 = pMem->z;
drh169f0772019-05-02 21:36:26 +00001874 }else if( pMem->flags & (MEM_Int|MEM_IntReal) ){
drh0cdbe1a2018-05-09 13:46:26 +00001875 sqlite3_str_appendf(&x, "%lld", pMem->u.i);
drhd4e70eb2008-01-02 00:34:36 +00001876 }else if( pMem->flags & MEM_Real ){
drh0cdbe1a2018-05-09 13:46:26 +00001877 sqlite3_str_appendf(&x, "%.16g", pMem->u.r);
drhb8475df2011-12-09 16:21:19 +00001878 }else if( pMem->flags & MEM_Null ){
drh5f4a6862016-01-30 12:50:25 +00001879 zP4 = "NULL";
drh56016892009-08-25 14:24:04 +00001880 }else{
1881 assert( pMem->flags & MEM_Blob );
1882 zP4 = "(blob)";
drhd4e70eb2008-01-02 00:34:36 +00001883 }
drh598f1342007-10-23 15:39:45 +00001884 break;
1885 }
drha967e882006-06-13 01:04:52 +00001886#ifndef SQLITE_OMIT_VIRTUALTABLE
drh66a51672008-01-03 00:01:23 +00001887 case P4_VTAB: {
danielk1977595a5232009-07-24 17:58:53 +00001888 sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
drh0cdbe1a2018-05-09 13:46:26 +00001889 sqlite3_str_appendf(&x, "vtab:%p", pVtab);
drha967e882006-06-13 01:04:52 +00001890 break;
1891 }
1892#endif
drh0acb7e42008-06-25 00:12:41 +00001893 case P4_INTARRAY: {
drhabc38152020-07-22 13:38:04 +00001894 u32 i;
1895 u32 *ai = pOp->p4.ai;
1896 u32 n = ai[0]; /* The first element of an INTARRAY is always the
drhb1702022016-01-30 00:45:18 +00001897 ** count of the number of elements to follow */
drhb5c10632017-09-21 00:49:15 +00001898 for(i=1; i<=n; i++){
drhabc38152020-07-22 13:38:04 +00001899 sqlite3_str_appendf(&x, "%c%u", (i==1 ? '[' : ','), ai[i]);
drh5f4a6862016-01-30 12:50:25 +00001900 }
drh0cdbe1a2018-05-09 13:46:26 +00001901 sqlite3_str_append(&x, "]", 1);
drh0acb7e42008-06-25 00:12:41 +00001902 break;
1903 }
dan165921a2009-08-28 18:53:45 +00001904 case P4_SUBPROGRAM: {
drhcb49f542020-03-23 19:14:11 +00001905 zP4 = "program";
dan165921a2009-08-28 18:53:45 +00001906 break;
1907 }
drh74c33022016-03-30 12:56:55 +00001908 case P4_TABLE: {
drhcb49f542020-03-23 19:14:11 +00001909 zP4 = pOp->p4.pTab->zName;
drh74c33022016-03-30 12:56:55 +00001910 break;
1911 }
drhd3d39e92004-05-20 22:16:29 +00001912 default: {
danielk19772dca4ac2008-01-03 11:50:29 +00001913 zP4 = pOp->p4.z;
drhd3d39e92004-05-20 22:16:29 +00001914 }
1915 }
drhcb49f542020-03-23 19:14:11 +00001916 if( zP4 ) sqlite3_str_appendall(&x, zP4);
drhe1cd73f2020-04-02 17:21:51 +00001917 if( (x.accError & SQLITE_NOMEM)!=0 ){
drhcb49f542020-03-23 19:14:11 +00001918 sqlite3OomFault(db);
1919 }
1920 return sqlite3StrAccumFinish(&x);
drhd3d39e92004-05-20 22:16:29 +00001921}
drhf7e36902015-08-13 21:32:41 +00001922#endif /* VDBE_DISPLAY_P4 */
drhd3d39e92004-05-20 22:16:29 +00001923
drh900b31e2007-08-28 02:27:51 +00001924/*
drhd0679ed2007-08-28 22:24:34 +00001925** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
drh3ebaee92010-05-06 21:37:22 +00001926**
drhbdaec522011-04-04 00:14:43 +00001927** The prepared statements need to know in advance the complete set of
drhe4c88c02012-01-04 12:57:45 +00001928** attached databases that will be use. A mask of these databases
1929** is maintained in p->btreeMask. The p->lockMask value is the subset of
1930** p->btreeMask of databases that will require a lock.
drh900b31e2007-08-28 02:27:51 +00001931*/
drhfb982642007-08-30 01:19:59 +00001932void sqlite3VdbeUsesBtree(Vdbe *p, int i){
drhfcd71b62011-04-05 22:08:24 +00001933 assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
danielk197700e13612008-11-17 19:18:54 +00001934 assert( i<(int)sizeof(p->btreeMask)*8 );
drha7ab6d82014-07-21 15:44:39 +00001935 DbMaskSet(p->btreeMask, i);
drhdc5b0472011-04-06 22:05:53 +00001936 if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
drha7ab6d82014-07-21 15:44:39 +00001937 DbMaskSet(p->lockMask, i);
drhdc5b0472011-04-06 22:05:53 +00001938 }
drh900b31e2007-08-28 02:27:51 +00001939}
1940
dan20d876f2016-01-07 16:06:22 +00001941#if !defined(SQLITE_OMIT_SHARED_CACHE)
drhbdaec522011-04-04 00:14:43 +00001942/*
1943** If SQLite is compiled to support shared-cache mode and to be threadsafe,
1944** this routine obtains the mutex associated with each BtShared structure
1945** that may be accessed by the VM passed as an argument. In doing so it also
1946** sets the BtShared.db member of each of the BtShared structures, ensuring
1947** that the correct busy-handler callback is invoked if required.
1948**
1949** If SQLite is not threadsafe but does support shared-cache mode, then
1950** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
1951** of all of BtShared structures accessible via the database handle
1952** associated with the VM.
1953**
1954** If SQLite is not threadsafe and does not support shared-cache mode, this
1955** function is a no-op.
1956**
1957** The p->btreeMask field is a bitmask of all btrees that the prepared
1958** statement p will ever use. Let N be the number of bits in p->btreeMask
1959** corresponding to btrees that use shared cache. Then the runtime of
1960** this routine is N*N. But as N is rarely more than 1, this should not
1961** be a problem.
1962*/
1963void sqlite3VdbeEnter(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001964 int i;
drhdc5b0472011-04-06 22:05:53 +00001965 sqlite3 *db;
1966 Db *aDb;
1967 int nDb;
drha7ab6d82014-07-21 15:44:39 +00001968 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
drhdc5b0472011-04-06 22:05:53 +00001969 db = p->db;
1970 aDb = db->aDb;
1971 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001972 for(i=0; i<nDb; i++){
1973 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001974 sqlite3BtreeEnter(aDb[i].pBt);
1975 }
1976 }
drhbdaec522011-04-04 00:14:43 +00001977}
drhe54e0512011-04-05 17:31:56 +00001978#endif
drhbdaec522011-04-04 00:14:43 +00001979
drhe54e0512011-04-05 17:31:56 +00001980#if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
drhbdaec522011-04-04 00:14:43 +00001981/*
1982** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
1983*/
drhf1aabd62015-06-17 01:31:28 +00001984static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
drhbdaec522011-04-04 00:14:43 +00001985 int i;
drhdc5b0472011-04-06 22:05:53 +00001986 sqlite3 *db;
1987 Db *aDb;
1988 int nDb;
drhdc5b0472011-04-06 22:05:53 +00001989 db = p->db;
1990 aDb = db->aDb;
1991 nDb = db->nDb;
drha7ab6d82014-07-21 15:44:39 +00001992 for(i=0; i<nDb; i++){
1993 if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
drhbdaec522011-04-04 00:14:43 +00001994 sqlite3BtreeLeave(aDb[i].pBt);
1995 }
1996 }
drhbdaec522011-04-04 00:14:43 +00001997}
drhf1aabd62015-06-17 01:31:28 +00001998void sqlite3VdbeLeave(Vdbe *p){
1999 if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
2000 vdbeLeave(p);
2001}
drhbdaec522011-04-04 00:14:43 +00002002#endif
drhd3d39e92004-05-20 22:16:29 +00002003
danielk19778b60e0f2005-01-12 09:10:39 +00002004#if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
drh9a324642003-09-06 20:12:01 +00002005/*
2006** Print a single opcode. This routine is used for debugging only.
2007*/
drh299bf7c2018-06-11 17:35:02 +00002008void sqlite3VdbePrintOp(FILE *pOut, int pc, VdbeOp *pOp){
drh66a51672008-01-03 00:01:23 +00002009 char *zP4;
drhcb49f542020-03-23 19:14:11 +00002010 char *zCom;
drhe1cd73f2020-04-02 17:21:51 +00002011 sqlite3 dummyDb;
drh26198bb2013-10-31 11:15:09 +00002012 static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
drh9a324642003-09-06 20:12:01 +00002013 if( pOut==0 ) pOut = stdout;
dan62c94d02020-05-16 15:18:27 +00002014 sqlite3BeginBenignMalloc();
drhe1cd73f2020-04-02 17:21:51 +00002015 dummyDb.mallocFailed = 1;
2016 zP4 = sqlite3VdbeDisplayP4(&dummyDb, pOp);
drhc7379ce2013-10-30 02:28:23 +00002017#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drh8c5163a2020-03-23 20:58:55 +00002018 zCom = sqlite3VdbeDisplayComment(0, pOp, zP4);
drh81316f82013-10-29 20:40:47 +00002019#else
drhcb49f542020-03-23 19:14:11 +00002020 zCom = 0;
drh81316f82013-10-29 20:40:47 +00002021#endif
drh4eded602013-12-20 15:59:20 +00002022 /* NB: The sqlite3OpcodeName() function is implemented by code created
2023 ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
2024 ** information from the vdbe.c source text */
danielk197711641c12008-01-03 08:18:30 +00002025 fprintf(pOut, zFormat1, pc,
drh7e088a62020-05-02 00:01:39 +00002026 sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3,
2027 zP4 ? zP4 : "", pOp->p5,
drhcb49f542020-03-23 19:14:11 +00002028 zCom ? zCom : ""
drh1db639c2008-01-17 02:36:28 +00002029 );
drh9a324642003-09-06 20:12:01 +00002030 fflush(pOut);
drhcb49f542020-03-23 19:14:11 +00002031 sqlite3_free(zP4);
2032 sqlite3_free(zCom);
dan62c94d02020-05-16 15:18:27 +00002033 sqlite3EndBenignMalloc();
drh9a324642003-09-06 20:12:01 +00002034}
2035#endif
2036
2037/*
drh2a1df932016-09-30 17:46:44 +00002038** Initialize an array of N Mem element.
drhc9373e82022-02-28 03:25:13 +00002039**
drh42963572022-02-28 12:08:09 +00002040** This is a high-runner, so only those fields that really do need to
2041** be initialized are set. The Mem structure is organized so that
2042** the fields that get initialized are nearby and hopefully on the same
2043** cache line.
drhc9373e82022-02-28 03:25:13 +00002044**
2045** Mem.flags = flags
2046** Mem.db = db
2047** Mem.szMalloc = 0
2048**
2049** All other fields of Mem can safely remain uninitialized for now. They
drh42963572022-02-28 12:08:09 +00002050** will be initialized before use.
drh2a1df932016-09-30 17:46:44 +00002051*/
2052static void initMemArray(Mem *p, int N, sqlite3 *db, u16 flags){
drhc9373e82022-02-28 03:25:13 +00002053 if( N>0 ){
drhc9373e82022-02-28 03:25:13 +00002054 do{
drh42963572022-02-28 12:08:09 +00002055 p->flags = flags;
2056 p->db = db;
2057 p->szMalloc = 0;
drh2a1df932016-09-30 17:46:44 +00002058#ifdef SQLITE_DEBUG
drhc9373e82022-02-28 03:25:13 +00002059 p->pScopyFrom = 0;
drh2a1df932016-09-30 17:46:44 +00002060#endif
drhc9373e82022-02-28 03:25:13 +00002061 p++;
2062 }while( (--N)>0 );
drh2a1df932016-09-30 17:46:44 +00002063 }
2064}
2065
2066/*
drh5308d392022-03-02 13:45:22 +00002067** Release auxiliary memory held in an array of N Mem elements.
2068**
2069** After this routine returns, all Mem elements in the array will still
2070** be valid. Those Mem elements that were not holding auxiliary resources
2071** will be unchanged. Mem elements which had something freed will be
2072** set to MEM_Undefined.
drh76ff3a02004-09-24 22:32:30 +00002073*/
drhc890fec2008-08-01 20:10:08 +00002074static void releaseMemArray(Mem *p, int N){
danielk1977a7a8e142008-02-13 18:25:27 +00002075 if( p && N ){
drh069c23c2014-09-19 16:13:12 +00002076 Mem *pEnd = &p[N];
danielk1977a7a8e142008-02-13 18:25:27 +00002077 sqlite3 *db = p->db;
dand46def72010-07-24 11:28:28 +00002078 if( db->pnBytesFreed ){
drh069c23c2014-09-19 16:13:12 +00002079 do{
drh17bcb102014-09-18 21:25:33 +00002080 if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
drh069c23c2014-09-19 16:13:12 +00002081 }while( (++p)<pEnd );
drhc176c272010-07-26 13:57:59 +00002082 return;
2083 }
drh069c23c2014-09-19 16:13:12 +00002084 do{
danielk1977e972e032008-09-19 18:32:26 +00002085 assert( (&p[1])==pEnd || p[0].db==p[1].db );
drh75fd0542014-03-01 16:24:44 +00002086 assert( sqlite3VdbeCheckMemInvariants(p) );
danielk1977e972e032008-09-19 18:32:26 +00002087
2088 /* This block is really an inlined version of sqlite3VdbeMemRelease()
2089 ** that takes advantage of the fact that the memory cell value is
2090 ** being set to NULL after releasing any dynamic resources.
2091 **
2092 ** The justification for duplicating code is that according to
2093 ** callgrind, this causes a certain test case to hit the CPU 4.7
2094 ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
2095 ** sqlite3MemRelease() were called from here. With -O2, this jumps
2096 ** to 6.6 percent. The test case is inserting 1000 rows into a table
2097 ** with no indexes using a single prepared INSERT statement, bind()
2098 ** and reset(). Inserts are grouped into a transaction.
2099 */
drhb6e8fd12014-03-06 01:56:33 +00002100 testcase( p->flags & MEM_Agg );
2101 testcase( p->flags & MEM_Dyn );
drh9d67afc2018-08-29 20:24:03 +00002102 if( p->flags&(MEM_Agg|MEM_Dyn) ){
drh9fdd66e2021-10-20 17:58:33 +00002103 testcase( (p->flags & MEM_Dyn)!=0 && p->xDel==sqlite3VdbeFrameMemDel );
danielk1977e972e032008-09-19 18:32:26 +00002104 sqlite3VdbeMemRelease(p);
drh5308d392022-03-02 13:45:22 +00002105 p->flags = MEM_Undefined;
drh17bcb102014-09-18 21:25:33 +00002106 }else if( p->szMalloc ){
drh41ce47c2022-08-22 02:00:26 +00002107 sqlite3DbNNFreeNN(db, p->zMalloc);
drh17bcb102014-09-18 21:25:33 +00002108 p->szMalloc = 0;
drh5308d392022-03-02 13:45:22 +00002109 p->flags = MEM_Undefined;
danielk1977e972e032008-09-19 18:32:26 +00002110 }
drh5308d392022-03-02 13:45:22 +00002111#ifdef SQLITE_DEBUG
2112 else{
2113 p->flags = MEM_Undefined;
2114 }
2115#endif
drh069c23c2014-09-19 16:13:12 +00002116 }while( (++p)<pEnd );
drh76ff3a02004-09-24 22:32:30 +00002117 }
2118}
2119
drh72f56ef2018-08-29 18:47:22 +00002120#ifdef SQLITE_DEBUG
2121/*
2122** Verify that pFrame is a valid VdbeFrame pointer. Return true if it is
2123** and false if something is wrong.
2124**
2125** This routine is intended for use inside of assert() statements only.
2126*/
2127int sqlite3VdbeFrameIsValid(VdbeFrame *pFrame){
2128 if( pFrame->iFrameMagic!=SQLITE_FRAME_MAGIC ) return 0;
2129 return 1;
2130}
2131#endif
2132
2133
2134/*
2135** This is a destructor on a Mem object (which is really an sqlite3_value)
2136** that deletes the Frame object that is attached to it as a blob.
2137**
2138** This routine does not delete the Frame right away. It merely adds the
2139** frame to a list of frames to be deleted when the Vdbe halts.
2140*/
2141void sqlite3VdbeFrameMemDel(void *pArg){
2142 VdbeFrame *pFrame = (VdbeFrame*)pArg;
2143 assert( sqlite3VdbeFrameIsValid(pFrame) );
2144 pFrame->pParent = pFrame->v->pDelFrame;
2145 pFrame->v->pDelFrame = pFrame;
2146}
2147
drh8c5163a2020-03-23 20:58:55 +00002148#if defined(SQLITE_ENABLE_BYTECODE_VTAB) || !defined(SQLITE_OMIT_EXPLAIN)
drh356cd762020-03-23 17:24:46 +00002149/*
2150** Locate the next opcode to be displayed in EXPLAIN or EXPLAIN
2151** QUERY PLAN output.
2152**
2153** Return SQLITE_ROW on success. Return SQLITE_DONE if there are no
2154** more opcodes to be displayed.
2155*/
2156int sqlite3VdbeNextOpcode(
2157 Vdbe *p, /* The statement being explained */
2158 Mem *pSub, /* Storage for keeping track of subprogram nesting */
drh8f78a522020-03-26 16:48:18 +00002159 int eMode, /* 0: normal. 1: EQP. 2: TablesUsed */
drh356cd762020-03-23 17:24:46 +00002160 int *piPc, /* IN/OUT: Current rowid. Overwritten with next rowid */
2161 int *piAddr, /* OUT: Write index into (*paOp)[] here */
2162 Op **paOp /* OUT: Write the opcode array here */
2163){
2164 int nRow; /* Stop when row count reaches this */
2165 int nSub = 0; /* Number of sub-vdbes seen so far */
2166 SubProgram **apSub = 0; /* Array of sub-vdbes */
2167 int i; /* Next instruction address */
2168 int rc = SQLITE_OK; /* Result code */
drhc004bd52020-04-02 13:08:54 +00002169 Op *aOp = 0; /* Opcode array */
drh356cd762020-03-23 17:24:46 +00002170 int iPc; /* Rowid. Copy of value in *piPc */
2171
2172 /* When the number of output rows reaches nRow, that means the
2173 ** listing has finished and sqlite3_step() should return SQLITE_DONE.
2174 ** nRow is the sum of the number of rows in the main program, plus
2175 ** the sum of the number of rows in all trigger subprograms encountered
2176 ** so far. The nRow value will increase as new trigger subprograms are
2177 ** encountered, but p->pc will eventually catch up to nRow.
2178 */
2179 nRow = p->nOp;
2180 if( pSub!=0 ){
2181 if( pSub->flags&MEM_Blob ){
2182 /* pSub is initiallly NULL. It is initialized to a BLOB by
2183 ** the P4_SUBPROGRAM processing logic below */
2184 nSub = pSub->n/sizeof(Vdbe*);
2185 apSub = (SubProgram **)pSub->z;
2186 }
2187 for(i=0; i<nSub; i++){
2188 nRow += apSub[i]->nOp;
2189 }
2190 }
2191 iPc = *piPc;
2192 while(1){ /* Loop exits via break */
2193 i = iPc++;
2194 if( i>=nRow ){
2195 p->rc = SQLITE_OK;
2196 rc = SQLITE_DONE;
2197 break;
2198 }
2199 if( i<p->nOp ){
2200 /* The rowid is small enough that we are still in the
2201 ** main program. */
2202 aOp = p->aOp;
2203 }else{
2204 /* We are currently listing subprograms. Figure out which one and
2205 ** pick up the appropriate opcode. */
2206 int j;
2207 i -= p->nOp;
2208 assert( apSub!=0 );
2209 assert( nSub>0 );
2210 for(j=0; i>=apSub[j]->nOp; j++){
2211 i -= apSub[j]->nOp;
2212 assert( i<apSub[j]->nOp || j+1<nSub );
2213 }
2214 aOp = apSub[j]->aOp;
2215 }
2216
2217 /* When an OP_Program opcode is encounter (the only opcode that has
2218 ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
2219 ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
2220 ** has not already been seen.
2221 */
2222 if( pSub!=0 && aOp[i].p4type==P4_SUBPROGRAM ){
2223 int nByte = (nSub+1)*sizeof(SubProgram*);
2224 int j;
2225 for(j=0; j<nSub; j++){
2226 if( apSub[j]==aOp[i].p4.pProgram ) break;
2227 }
2228 if( j==nSub ){
2229 p->rc = sqlite3VdbeMemGrow(pSub, nByte, nSub!=0);
2230 if( p->rc!=SQLITE_OK ){
2231 rc = SQLITE_ERROR;
2232 break;
2233 }
2234 apSub = (SubProgram **)pSub->z;
2235 apSub[nSub++] = aOp[i].p4.pProgram;
drh0518d062020-03-24 13:27:53 +00002236 MemSetTypeFlag(pSub, MEM_Blob);
drh356cd762020-03-23 17:24:46 +00002237 pSub->n = nSub*sizeof(SubProgram*);
2238 nRow += aOp[i].p4.pProgram->nOp;
2239 }
2240 }
drh8f78a522020-03-26 16:48:18 +00002241 if( eMode==0 ) break;
2242#ifdef SQLITE_ENABLE_BYTECODE_VTAB
2243 if( eMode==2 ){
2244 Op *pOp = aOp + i;
2245 if( pOp->opcode==OP_OpenRead ) break;
2246 if( pOp->opcode==OP_OpenWrite && (pOp->p5 & OPFLAG_P2ISREG)==0 ) break;
2247 if( pOp->opcode==OP_ReopenIdx ) break;
2248 }else
2249#endif
2250 {
2251 assert( eMode==1 );
2252 if( aOp[i].opcode==OP_Explain ) break;
drh49d01ab2020-04-02 19:58:31 +00002253 if( aOp[i].opcode==OP_Init && iPc>1 ) break;
drh8f78a522020-03-26 16:48:18 +00002254 }
drh356cd762020-03-23 17:24:46 +00002255 }
2256 *piPc = iPc;
2257 *piAddr = i;
2258 *paOp = aOp;
2259 return rc;
2260}
drh8c5163a2020-03-23 20:58:55 +00002261#endif /* SQLITE_ENABLE_BYTECODE_VTAB || !SQLITE_OMIT_EXPLAIN */
drh356cd762020-03-23 17:24:46 +00002262
drh72f56ef2018-08-29 18:47:22 +00002263
dan65a7cd12009-09-01 12:16:01 +00002264/*
2265** Delete a VdbeFrame object and its contents. VdbeFrame objects are
2266** allocated by the OP_Program opcode in sqlite3VdbeExec().
2267*/
dan165921a2009-08-28 18:53:45 +00002268void sqlite3VdbeFrameDelete(VdbeFrame *p){
2269 int i;
2270 Mem *aMem = VdbeFrameMem(p);
2271 VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
drh72f56ef2018-08-29 18:47:22 +00002272 assert( sqlite3VdbeFrameIsValid(p) );
dan165921a2009-08-28 18:53:45 +00002273 for(i=0; i<p->nChildCsr; i++){
drh473571b2022-04-01 18:19:04 +00002274 if( apCsr[i] ) sqlite3VdbeFreeCursorNN(p->v, apCsr[i]);
dan165921a2009-08-28 18:53:45 +00002275 }
2276 releaseMemArray(aMem, p->nChildMem);
drhb9626cf2016-02-22 16:04:31 +00002277 sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
dan165921a2009-08-28 18:53:45 +00002278 sqlite3DbFree(p->v->db, p);
2279}
2280
drhb7f91642004-10-31 02:22:47 +00002281#ifndef SQLITE_OMIT_EXPLAIN
drh76ff3a02004-09-24 22:32:30 +00002282/*
drh9a324642003-09-06 20:12:01 +00002283** Give a listing of the program in the virtual machine.
2284**
danielk19774adee202004-05-08 08:23:19 +00002285** The interface is the same as sqlite3VdbeExec(). But instead of
drh9a324642003-09-06 20:12:01 +00002286** running the code, it invokes the callback once for each instruction.
2287** This feature is used to implement "EXPLAIN".
drh9cbf3422008-01-17 16:22:13 +00002288**
2289** When p->explain==1, each instruction is listed. When
2290** p->explain==2, only OP_Explain instructions are listed and these
2291** are shown in a different format. p->explain==2 is used to implement
2292** EXPLAIN QUERY PLAN.
drh4b5345c2018-04-24 13:07:40 +00002293** 2018-04-24: In p->explain==2 mode, the OP_Init opcodes of triggers
2294** are also shown, so that the boundaries between the main program and
2295** each trigger are clear.
drh5cfa5842009-12-31 20:35:08 +00002296**
2297** When p->explain==1, first the main program is listed, then each of
2298** the trigger subprograms are listed one by one.
drh9a324642003-09-06 20:12:01 +00002299*/
danielk19774adee202004-05-08 08:23:19 +00002300int sqlite3VdbeList(
drh9a324642003-09-06 20:12:01 +00002301 Vdbe *p /* The VDBE */
2302){
drh5cfa5842009-12-31 20:35:08 +00002303 Mem *pSub = 0; /* Memory cell hold array of subprogs */
2304 sqlite3 *db = p->db; /* The database connection */
2305 int i; /* Loop counter */
2306 int rc = SQLITE_OK; /* Return code */
drh9734e6e2011-10-07 18:24:25 +00002307 Mem *pMem = &p->aMem[1]; /* First Mem of result set */
drh36e31c62017-12-21 18:23:26 +00002308 int bListSubprogs = (p->explain==1 || (db->flags & SQLITE_TriggerEQP)!=0);
drh356cd762020-03-23 17:24:46 +00002309 Op *aOp; /* Array of opcodes */
2310 Op *pOp; /* Current opcode */
drh9a324642003-09-06 20:12:01 +00002311
drh9a324642003-09-06 20:12:01 +00002312 assert( p->explain );
drh66181ce2022-03-31 20:04:49 +00002313 assert( p->eVdbeState==VDBE_RUN_STATE );
danielk19776c359f02008-11-21 16:58:03 +00002314 assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
danielk197718f41892004-05-22 07:27:46 +00002315
drh9cbf3422008-01-17 16:22:13 +00002316 /* Even though this opcode does not use dynamic strings for
2317 ** the result, result columns may become dynamic if the user calls
drh4f26d6c2004-05-26 23:25:30 +00002318 ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
danielk197718f41892004-05-22 07:27:46 +00002319 */
dan165921a2009-08-28 18:53:45 +00002320 releaseMemArray(pMem, 8);
danielk197718f41892004-05-22 07:27:46 +00002321
drh85b76a22017-10-12 20:24:09 +00002322 if( p->rc==SQLITE_NOMEM ){
danielk19776c359f02008-11-21 16:58:03 +00002323 /* This happens if a malloc() inside a call to sqlite3_column_text() or
2324 ** sqlite3_column_text16() failed. */
drh4a642b62016-02-05 01:55:27 +00002325 sqlite3OomFault(db);
danielk19776c359f02008-11-21 16:58:03 +00002326 return SQLITE_ERROR;
2327 }
2328
drh36e31c62017-12-21 18:23:26 +00002329 if( bListSubprogs ){
drh5cfa5842009-12-31 20:35:08 +00002330 /* The first 8 memory cells are used for the result set. So we will
2331 ** commandeer the 9th cell to use as storage for an array of pointers
2332 ** to trigger subprograms. The VDBE is guaranteed to have at least 9
2333 ** cells. */
2334 assert( p->nMem>9 );
dan165921a2009-08-28 18:53:45 +00002335 pSub = &p->aMem[9];
drh356cd762020-03-23 17:24:46 +00002336 }else{
2337 pSub = 0;
dan165921a2009-08-28 18:53:45 +00002338 }
2339
drh356cd762020-03-23 17:24:46 +00002340 /* Figure out which opcode is next to display */
2341 rc = sqlite3VdbeNextOpcode(p, pSub, p->explain==2, &p->pc, &i, &aOp);
drheb2e1762004-05-27 01:53:56 +00002342
dan280db652017-04-17 17:03:08 +00002343 if( rc==SQLITE_OK ){
drh356cd762020-03-23 17:24:46 +00002344 pOp = aOp + i;
dan892edb62020-03-30 13:35:05 +00002345 if( AtomicLoad(&db->u1.isInterrupted) ){
dan280db652017-04-17 17:03:08 +00002346 p->rc = SQLITE_INTERRUPT;
2347 rc = SQLITE_ERROR;
2348 sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
danielk1977a7a8e142008-02-13 18:25:27 +00002349 }else{
drh8c5163a2020-03-23 20:58:55 +00002350 char *zP4 = sqlite3VdbeDisplayP4(db, pOp);
drhcb49f542020-03-23 19:14:11 +00002351 if( p->explain==2 ){
2352 sqlite3VdbeMemSetInt64(pMem, pOp->p1);
2353 sqlite3VdbeMemSetInt64(pMem+1, pOp->p2);
2354 sqlite3VdbeMemSetInt64(pMem+2, pOp->p3);
2355 sqlite3VdbeMemSetStr(pMem+3, zP4, -1, SQLITE_UTF8, sqlite3_free);
2356 p->nResColumn = 4;
dan280db652017-04-17 17:03:08 +00002357 }else{
drhcb49f542020-03-23 19:14:11 +00002358 sqlite3VdbeMemSetInt64(pMem+0, i);
2359 sqlite3VdbeMemSetStr(pMem+1, (char*)sqlite3OpcodeName(pOp->opcode),
2360 -1, SQLITE_UTF8, SQLITE_STATIC);
2361 sqlite3VdbeMemSetInt64(pMem+2, pOp->p1);
2362 sqlite3VdbeMemSetInt64(pMem+3, pOp->p2);
2363 sqlite3VdbeMemSetInt64(pMem+4, pOp->p3);
2364 /* pMem+5 for p4 is done last */
2365 sqlite3VdbeMemSetInt64(pMem+6, pOp->p5);
dan280db652017-04-17 17:03:08 +00002366#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
drhcb49f542020-03-23 19:14:11 +00002367 {
drh8c5163a2020-03-23 20:58:55 +00002368 char *zCom = sqlite3VdbeDisplayComment(db, pOp, zP4);
drhcb49f542020-03-23 19:14:11 +00002369 sqlite3VdbeMemSetStr(pMem+7, zCom, -1, SQLITE_UTF8, sqlite3_free);
dan280db652017-04-17 17:03:08 +00002370 }
dan280db652017-04-17 17:03:08 +00002371#else
drhcb49f542020-03-23 19:14:11 +00002372 sqlite3VdbeMemSetNull(pMem+7);
dan280db652017-04-17 17:03:08 +00002373#endif
drhcb49f542020-03-23 19:14:11 +00002374 sqlite3VdbeMemSetStr(pMem+5, zP4, -1, SQLITE_UTF8, sqlite3_free);
2375 p->nResColumn = 8;
dan280db652017-04-17 17:03:08 +00002376 }
drhedc27132022-12-22 18:44:39 +00002377 p->pResultRow = pMem;
drhcb49f542020-03-23 19:14:11 +00002378 if( db->mallocFailed ){
2379 p->rc = SQLITE_NOMEM;
2380 rc = SQLITE_ERROR;
2381 }else{
2382 p->rc = SQLITE_OK;
2383 rc = SQLITE_ROW;
2384 }
dan280db652017-04-17 17:03:08 +00002385 }
drh9a324642003-09-06 20:12:01 +00002386 }
drh826fb5a2004-02-14 23:59:57 +00002387 return rc;
drh9a324642003-09-06 20:12:01 +00002388}
drhb7f91642004-10-31 02:22:47 +00002389#endif /* SQLITE_OMIT_EXPLAIN */
drh9a324642003-09-06 20:12:01 +00002390
drh7c4ac0c2007-04-05 11:25:58 +00002391#ifdef SQLITE_DEBUG
drh9a324642003-09-06 20:12:01 +00002392/*
drh3f7d4e42004-07-24 14:35:58 +00002393** Print the SQL that was used to generate a VDBE program.
2394*/
2395void sqlite3VdbePrintSql(Vdbe *p){
drh84e55a82013-11-13 17:58:23 +00002396 const char *z = 0;
2397 if( p->zSql ){
2398 z = p->zSql;
2399 }else if( p->nOp>=1 ){
2400 const VdbeOp *pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00002401 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh84e55a82013-11-13 17:58:23 +00002402 z = pOp->p4.z;
2403 while( sqlite3Isspace(*z) ) z++;
2404 }
drh3f7d4e42004-07-24 14:35:58 +00002405 }
drh84e55a82013-11-13 17:58:23 +00002406 if( z ) printf("SQL: [%s]\n", z);
drh3f7d4e42004-07-24 14:35:58 +00002407}
drh7c4ac0c2007-04-05 11:25:58 +00002408#endif
drh3f7d4e42004-07-24 14:35:58 +00002409
drh602c2372007-03-01 00:29:13 +00002410#if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
2411/*
2412** Print an IOTRACE message showing SQL content.
2413*/
2414void sqlite3VdbeIOTraceSql(Vdbe *p){
2415 int nOp = p->nOp;
2416 VdbeOp *pOp;
mlcreech3a00f902008-03-04 17:45:01 +00002417 if( sqlite3IoTrace==0 ) return;
drh602c2372007-03-01 00:29:13 +00002418 if( nOp<1 ) return;
drh949f9cd2008-01-12 21:35:57 +00002419 pOp = &p->aOp[0];
drhaceb31b2014-02-08 01:40:27 +00002420 if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
drh602c2372007-03-01 00:29:13 +00002421 int i, j;
drh00a18e42007-08-13 11:10:34 +00002422 char z[1000];
drh949f9cd2008-01-12 21:35:57 +00002423 sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
danielk197778ca0e72009-01-20 16:53:39 +00002424 for(i=0; sqlite3Isspace(z[i]); i++){}
drh602c2372007-03-01 00:29:13 +00002425 for(j=0; z[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +00002426 if( sqlite3Isspace(z[i]) ){
drh602c2372007-03-01 00:29:13 +00002427 if( z[i-1]!=' ' ){
2428 z[j++] = ' ';
2429 }
2430 }else{
2431 z[j++] = z[i];
2432 }
2433 }
2434 z[j] = 0;
mlcreech3a00f902008-03-04 17:45:01 +00002435 sqlite3IoTrace("SQL %s\n", z);
drh602c2372007-03-01 00:29:13 +00002436 }
2437}
2438#endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
2439
drha7dc4a32016-01-25 02:15:02 +00002440/* An instance of this object describes bulk memory available for use
2441** by subcomponents of a prepared statement. Space is allocated out
2442** of a ReusableSpace object by the allocSpace() routine below.
2443*/
2444struct ReusableSpace {
drhf6ad2012019-04-13 14:07:57 +00002445 u8 *pSpace; /* Available memory */
2446 sqlite3_int64 nFree; /* Bytes of available memory */
2447 sqlite3_int64 nNeeded; /* Total bytes that could not be allocated */
drha7dc4a32016-01-25 02:15:02 +00002448};
2449
2450/* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
2451** from the ReusableSpace object. Return a pointer to the allocated
2452** memory on success. If insufficient memory is available in the
2453** ReusableSpace object, increase the ReusableSpace.nNeeded
2454** value by the amount needed and return NULL.
drh4800b2e2009-12-08 15:35:22 +00002455**
drha7dc4a32016-01-25 02:15:02 +00002456** If pBuf is not initially NULL, that means that the memory has already
2457** been allocated by a prior call to this routine, so just return a copy
2458** of pBuf and leave ReusableSpace unchanged.
drhb2771ce2009-02-20 01:28:59 +00002459**
drha7dc4a32016-01-25 02:15:02 +00002460** This allocator is employed to repurpose unused slots at the end of the
2461** opcode array of prepared state for other memory needs of the prepared
2462** statement.
drhb2771ce2009-02-20 01:28:59 +00002463*/
drh4800b2e2009-12-08 15:35:22 +00002464static void *allocSpace(
drha7dc4a32016-01-25 02:15:02 +00002465 struct ReusableSpace *p, /* Bulk memory available for allocation */
2466 void *pBuf, /* Pointer to a prior allocation */
drhcf6e3fd2022-04-01 18:45:11 +00002467 sqlite3_int64 nByte /* Bytes of memory needed. */
drhb2771ce2009-02-20 01:28:59 +00002468){
drha7dc4a32016-01-25 02:15:02 +00002469 assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
drhd797a9b2015-12-07 16:43:44 +00002470 if( pBuf==0 ){
drhcf6e3fd2022-04-01 18:45:11 +00002471 nByte = ROUND8P(nByte);
drha7dc4a32016-01-25 02:15:02 +00002472 if( nByte <= p->nFree ){
2473 p->nFree -= nByte;
2474 pBuf = &p->pSpace[p->nFree];
drhd797a9b2015-12-07 16:43:44 +00002475 }else{
drha7dc4a32016-01-25 02:15:02 +00002476 p->nNeeded += nByte;
drhd797a9b2015-12-07 16:43:44 +00002477 }
drhb2771ce2009-02-20 01:28:59 +00002478 }
drhd797a9b2015-12-07 16:43:44 +00002479 assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
drh4800b2e2009-12-08 15:35:22 +00002480 return pBuf;
drhb2771ce2009-02-20 01:28:59 +00002481}
drh602c2372007-03-01 00:29:13 +00002482
drh3f7d4e42004-07-24 14:35:58 +00002483/*
drh124c0b42011-06-01 18:15:55 +00002484** Rewind the VDBE back to the beginning in preparation for
2485** running it.
drh9a324642003-09-06 20:12:01 +00002486*/
drh124c0b42011-06-01 18:15:55 +00002487void sqlite3VdbeRewind(Vdbe *p){
dan231ff4b2022-12-02 20:32:22 +00002488#if defined(SQLITE_DEBUG)
drh124c0b42011-06-01 18:15:55 +00002489 int i;
2490#endif
drh9a324642003-09-06 20:12:01 +00002491 assert( p!=0 );
drh99a21822022-03-31 21:15:09 +00002492 assert( p->eVdbeState==VDBE_INIT_STATE
2493 || p->eVdbeState==VDBE_READY_STATE
2494 || p->eVdbeState==VDBE_HALT_STATE );
drh9a324642003-09-06 20:12:01 +00002495
drhc16a03b2004-09-15 13:38:10 +00002496 /* There should be at least one opcode.
drh9a324642003-09-06 20:12:01 +00002497 */
drhc16a03b2004-09-15 13:38:10 +00002498 assert( p->nOp>0 );
drh9a324642003-09-06 20:12:01 +00002499
drh99a21822022-03-31 21:15:09 +00002500 p->eVdbeState = VDBE_READY_STATE;
danielk1977634f2982005-03-28 08:44:07 +00002501
drh124c0b42011-06-01 18:15:55 +00002502#ifdef SQLITE_DEBUG
drh9f6168b2016-03-19 23:32:58 +00002503 for(i=0; i<p->nMem; i++){
drh124c0b42011-06-01 18:15:55 +00002504 assert( p->aMem[i].db==p->db );
2505 }
2506#endif
2507 p->pc = -1;
2508 p->rc = SQLITE_OK;
2509 p->errorAction = OE_Abort;
drh124c0b42011-06-01 18:15:55 +00002510 p->nChange = 0;
2511 p->cacheCtr = 1;
2512 p->minWriteFileFormat = 255;
2513 p->iStatement = 0;
2514 p->nFkConstraint = 0;
2515#ifdef VDBE_PROFILE
dan7f4b0662022-12-07 20:09:54 +00002516 for(i=0; i<p->nOp; i++){
2517 p->aOp[i].nExec = 0;
2518 p->aOp[i].nCycle = 0;
2519 }
drh124c0b42011-06-01 18:15:55 +00002520#endif
2521}
2522
2523/*
2524** Prepare a virtual machine for execution for the first time after
2525** creating the virtual machine. This involves things such
drh7abda852014-09-19 16:02:06 +00002526** as allocating registers and initializing the program counter.
drh124c0b42011-06-01 18:15:55 +00002527** After the VDBE has be prepped, it can be executed by one or more
2528** calls to sqlite3VdbeExec().
2529**
peter.d.reid60ec9142014-09-06 16:39:46 +00002530** This function may be called exactly once on each virtual machine.
drh124c0b42011-06-01 18:15:55 +00002531** After this routine is called the VM has been "packaged" and is ready
peter.d.reid60ec9142014-09-06 16:39:46 +00002532** to run. After this routine is called, further calls to
drh124c0b42011-06-01 18:15:55 +00002533** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
2534** the Vdbe from the Parse object that helped generate it so that the
2535** the Vdbe becomes an independent entity and the Parse object can be
2536** destroyed.
2537**
2538** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
2539** to its initial state after it has been run.
2540*/
2541void sqlite3VdbeMakeReady(
2542 Vdbe *p, /* The VDBE */
2543 Parse *pParse /* Parsing context */
2544){
2545 sqlite3 *db; /* The database connection */
2546 int nVar; /* Number of parameters */
2547 int nMem; /* Number of VM memory registers */
2548 int nCursor; /* Number of cursors required */
2549 int nArg; /* Number of arguments in subprograms */
2550 int n; /* Loop counter */
drha7dc4a32016-01-25 02:15:02 +00002551 struct ReusableSpace x; /* Reusable bulk memory */
drh124c0b42011-06-01 18:15:55 +00002552
2553 assert( p!=0 );
2554 assert( p->nOp>0 );
2555 assert( pParse!=0 );
drh66181ce2022-03-31 20:04:49 +00002556 assert( p->eVdbeState==VDBE_INIT_STATE );
drh73d5b8f2013-12-23 19:09:07 +00002557 assert( pParse==p->pParse );
drhe2b0a122021-01-01 17:01:33 +00002558 p->pVList = pParse->pVList;
2559 pParse->pVList = 0;
drh124c0b42011-06-01 18:15:55 +00002560 db = p->db;
2561 assert( db->mallocFailed==0 );
2562 nVar = pParse->nVar;
2563 nMem = pParse->nMem;
2564 nCursor = pParse->nTab;
2565 nArg = pParse->nMaxArg;
2566
drh3cdce922016-03-21 00:30:40 +00002567 /* Each cursor uses a memory cell. The first cursor (cursor 0) can
2568 ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
2569 ** space at the end of aMem[] for cursors 1 and greater.
danielk1977cd3e8f72008-03-25 09:47:35 +00002570 ** See also: allocateCursor().
2571 */
2572 nMem += nCursor;
drh9f6168b2016-03-19 23:32:58 +00002573 if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
danielk1977cd3e8f72008-03-25 09:47:35 +00002574
drha7dc4a32016-01-25 02:15:02 +00002575 /* Figure out how much reusable memory is available at the end of the
2576 ** opcode array. This extra memory will be reallocated for other elements
2577 ** of the prepared statement.
drh9a324642003-09-06 20:12:01 +00002578 */
drhcf6e3fd2022-04-01 18:45:11 +00002579 n = ROUND8P(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
drha7dc4a32016-01-25 02:15:02 +00002580 x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
2581 assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
2582 x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
2583 assert( x.nFree>=0 );
drh2a1df932016-09-30 17:46:44 +00002584 assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
drh19875c82009-12-08 19:58:19 +00002585
drh124c0b42011-06-01 18:15:55 +00002586 resolveP2Values(p, &nArg);
2587 p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
drhf3ce2482019-10-09 01:19:07 +00002588 if( pParse->explain ){
2589 static const char * const azColName[] = {
2590 "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
2591 "id", "parent", "notused", "detail"
2592 };
2593 int iFirst, mx, i;
2594 if( nMem<10 ) nMem = 10;
drh62b6e1d2020-03-21 14:22:27 +00002595 p->explain = pParse->explain;
drhf3ce2482019-10-09 01:19:07 +00002596 if( pParse->explain==2 ){
2597 sqlite3VdbeSetNumCols(p, 4);
2598 iFirst = 8;
2599 mx = 12;
2600 }else{
2601 sqlite3VdbeSetNumCols(p, 8);
2602 iFirst = 0;
2603 mx = 8;
2604 }
2605 for(i=iFirst; i<mx; i++){
2606 sqlite3VdbeSetColName(p, i-iFirst, COLNAME_NAME,
2607 azColName[i], SQLITE_STATIC);
2608 }
drh124c0b42011-06-01 18:15:55 +00002609 }
drhaab910c2011-06-27 00:01:22 +00002610 p->expired = 0;
drh124c0b42011-06-01 18:15:55 +00002611
drha7dc4a32016-01-25 02:15:02 +00002612 /* Memory for registers, parameters, cursor, etc, is allocated in one or two
2613 ** passes. On the first pass, we try to reuse unused memory at the
drh124c0b42011-06-01 18:15:55 +00002614 ** end of the opcode array. If we are unable to satisfy all memory
2615 ** requirements by reusing the opcode array tail, then the second
drha7dc4a32016-01-25 02:15:02 +00002616 ** pass will fill in the remainder using a fresh memory allocation.
drh124c0b42011-06-01 18:15:55 +00002617 **
2618 ** This two-pass approach that reuses as much memory as possible from
drha7dc4a32016-01-25 02:15:02 +00002619 ** the leftover memory at the end of the opcode array. This can significantly
drh124c0b42011-06-01 18:15:55 +00002620 ** reduce the amount of memory held by a prepared statement.
2621 */
drh81f91592018-12-28 20:48:07 +00002622 x.nNeeded = 0;
2623 p->aMem = allocSpace(&x, 0, nMem*sizeof(Mem));
2624 p->aVar = allocSpace(&x, 0, nVar*sizeof(Mem));
2625 p->apArg = allocSpace(&x, 0, nArg*sizeof(Mem*));
2626 p->apCsr = allocSpace(&x, 0, nCursor*sizeof(VdbeCursor*));
drh81f91592018-12-28 20:48:07 +00002627 if( x.nNeeded ){
drh2a1df932016-09-30 17:46:44 +00002628 x.pSpace = p->pFree = sqlite3DbMallocRawNN(db, x.nNeeded);
drha7dc4a32016-01-25 02:15:02 +00002629 x.nFree = x.nNeeded;
drh81f91592018-12-28 20:48:07 +00002630 if( !db->mallocFailed ){
2631 p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
2632 p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
2633 p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
2634 p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
drh81f91592018-12-28 20:48:07 +00002635 }
2636 }
drhb2771ce2009-02-20 01:28:59 +00002637
drhab3182f2016-10-01 00:37:50 +00002638 if( db->mallocFailed ){
2639 p->nVar = 0;
2640 p->nCursor = 0;
2641 p->nMem = 0;
2642 }else{
drh2a1df932016-09-30 17:46:44 +00002643 p->nCursor = nCursor;
2644 p->nVar = (ynVar)nVar;
2645 initMemArray(p->aVar, nVar, db, MEM_Null);
2646 p->nMem = nMem;
2647 initMemArray(p->aMem, nMem, db, MEM_Undefined);
drh2a1df932016-09-30 17:46:44 +00002648 memset(p->apCsr, 0, nCursor*sizeof(VdbeCursor*));
drh2a1df932016-09-30 17:46:44 +00002649 }
drh124c0b42011-06-01 18:15:55 +00002650 sqlite3VdbeRewind(p);
drh9a324642003-09-06 20:12:01 +00002651}
2652
drh9a324642003-09-06 20:12:01 +00002653/*
danielk1977cd3e8f72008-03-25 09:47:35 +00002654** Close a VDBE cursor and release all the resources that cursor
2655** happens to hold.
drh9a324642003-09-06 20:12:01 +00002656*/
drhdfe88ec2008-11-03 20:55:06 +00002657void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
drh473571b2022-04-01 18:19:04 +00002658 if( pCx ) sqlite3VdbeFreeCursorNN(p,pCx);
2659}
2660void sqlite3VdbeFreeCursorNN(Vdbe *p, VdbeCursor *pCx){
drhc960dcb2015-11-20 19:22:01 +00002661 switch( pCx->eCurType ){
2662 case CURTYPE_SORTER: {
2663 sqlite3VdbeSorterClose(p->db, pCx);
2664 break;
2665 }
2666 case CURTYPE_BTREE: {
daneeee8a52021-03-18 14:31:37 +00002667 assert( pCx->uc.pCursor!=0 );
2668 sqlite3BtreeCloseCursor(pCx->uc.pCursor);
drhc960dcb2015-11-20 19:22:01 +00002669 break;
2670 }
drh9eff6162006-06-12 21:59:13 +00002671#ifndef SQLITE_OMIT_VIRTUALTABLE
drhc960dcb2015-11-20 19:22:01 +00002672 case CURTYPE_VTAB: {
2673 sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
2674 const sqlite3_module *pModule = pVCur->pVtab->pModule;
2675 assert( pVCur->pVtab->nRef>0 );
2676 pVCur->pVtab->nRef--;
2677 pModule->xClose(pVCur);
2678 break;
2679 }
drh9eff6162006-06-12 21:59:13 +00002680#endif
drhc960dcb2015-11-20 19:22:01 +00002681 }
drh9a324642003-09-06 20:12:01 +00002682}
2683
dan65a7cd12009-09-01 12:16:01 +00002684/*
drhab4e7f32015-04-16 18:11:50 +00002685** Close all cursors in the current frame.
2686*/
2687static void closeCursorsInFrame(Vdbe *p){
drh17c48652022-04-01 17:01:57 +00002688 int i;
2689 for(i=0; i<p->nCursor; i++){
2690 VdbeCursor *pC = p->apCsr[i];
2691 if( pC ){
drh473571b2022-04-01 18:19:04 +00002692 sqlite3VdbeFreeCursorNN(p, pC);
drh17c48652022-04-01 17:01:57 +00002693 p->apCsr[i] = 0;
drhab4e7f32015-04-16 18:11:50 +00002694 }
2695 }
2696}
2697
2698/*
dan65a7cd12009-09-01 12:16:01 +00002699** Copy the values stored in the VdbeFrame structure to its Vdbe. This
2700** is used, for example, when a trigger sub-program is halted to restore
2701** control to the main program.
2702*/
dan165921a2009-08-28 18:53:45 +00002703int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
2704 Vdbe *v = pFrame->v;
drhab4e7f32015-04-16 18:11:50 +00002705 closeCursorsInFrame(v);
dan165921a2009-08-28 18:53:45 +00002706 v->aOp = pFrame->aOp;
2707 v->nOp = pFrame->nOp;
2708 v->aMem = pFrame->aMem;
2709 v->nMem = pFrame->nMem;
2710 v->apCsr = pFrame->apCsr;
2711 v->nCursor = pFrame->nCursor;
dan76d462e2009-08-30 11:42:51 +00002712 v->db->lastRowid = pFrame->lastRowid;
2713 v->nChange = pFrame->nChange;
danc3da6672014-10-28 18:24:16 +00002714 v->db->nChange = pFrame->nDbChange;
drhb9626cf2016-02-22 16:04:31 +00002715 sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
dan32001322016-02-19 18:54:29 +00002716 v->pAuxData = pFrame->pAuxData;
2717 pFrame->pAuxData = 0;
dan165921a2009-08-28 18:53:45 +00002718 return pFrame->pc;
2719}
2720
drh9a324642003-09-06 20:12:01 +00002721/*
drh5f82e3c2009-07-06 00:44:08 +00002722** Close all cursors.
dan165921a2009-08-28 18:53:45 +00002723**
2724** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
2725** cell array. This is necessary as the memory cell array may contain
2726** pointers to VdbeFrame objects, which may in turn contain pointers to
2727** open cursors.
drh9a324642003-09-06 20:12:01 +00002728*/
drh5f82e3c2009-07-06 00:44:08 +00002729static void closeAllCursors(Vdbe *p){
dan165921a2009-08-28 18:53:45 +00002730 if( p->pFrame ){
drh23272752011-03-06 21:54:33 +00002731 VdbeFrame *pFrame;
dan165921a2009-08-28 18:53:45 +00002732 for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
2733 sqlite3VdbeFrameRestore(pFrame);
drhf526dca2014-10-13 17:42:05 +00002734 p->pFrame = 0;
2735 p->nFrame = 0;
dan165921a2009-08-28 18:53:45 +00002736 }
drhf526dca2014-10-13 17:42:05 +00002737 assert( p->nFrame==0 );
drhab4e7f32015-04-16 18:11:50 +00002738 closeCursorsInFrame(p);
drh99a21822022-03-31 21:15:09 +00002739 releaseMemArray(p->aMem, p->nMem);
dan27106572010-12-01 08:04:47 +00002740 while( p->pDelFrame ){
2741 VdbeFrame *pDel = p->pDelFrame;
2742 p->pDelFrame = pDel->pParent;
2743 sqlite3VdbeFrameDelete(pDel);
2744 }
dan0c547792013-07-18 17:12:08 +00002745
2746 /* Delete any auxdata allocations made by the VM */
drhb9626cf2016-02-22 16:04:31 +00002747 if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
dan0c547792013-07-18 17:12:08 +00002748 assert( p->pAuxData==0 );
drh9a324642003-09-06 20:12:01 +00002749}
2750
2751/*
danielk197722322fd2004-05-25 23:35:17 +00002752** Set the number of result columns that will be returned by this SQL
2753** statement. This is now set at compile time, rather than during
2754** execution of the vdbe program so that sqlite3_column_count() can
2755** be called on an SQL statement before sqlite3_step().
2756*/
2757void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
drh76ff3a02004-09-24 22:32:30 +00002758 int n;
drh633e6d52008-07-28 19:34:53 +00002759 sqlite3 *db = p->db;
drh4a50aac2007-08-23 02:47:53 +00002760
drhb8a12902017-05-31 11:24:13 +00002761 if( p->nResColumn ){
2762 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
2763 sqlite3DbFree(db, p->aColName);
2764 }
danielk1977955de522006-02-10 02:27:42 +00002765 n = nResColumn*COLNAME_N;
shane36840fd2009-06-26 16:32:13 +00002766 p->nResColumn = (u16)nResColumn;
drhb8a12902017-05-31 11:24:13 +00002767 p->aColName = (Mem*)sqlite3DbMallocRawNN(db, sizeof(Mem)*n );
drh76ff3a02004-09-24 22:32:30 +00002768 if( p->aColName==0 ) return;
drhb8a12902017-05-31 11:24:13 +00002769 initMemArray(p->aColName, n, db, MEM_Null);
danielk197722322fd2004-05-25 23:35:17 +00002770}
2771
2772/*
danielk19773cf86062004-05-26 10:11:05 +00002773** Set the name of the idx'th column to be returned by the SQL statement.
2774** zName must be a pointer to a nul terminated string.
2775**
2776** This call must be made after a call to sqlite3VdbeSetNumCols().
2777**
danielk197710fb7492008-10-31 10:53:22 +00002778** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
2779** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
2780** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
danielk19773cf86062004-05-26 10:11:05 +00002781*/
danielk197710fb7492008-10-31 10:53:22 +00002782int sqlite3VdbeSetColName(
2783 Vdbe *p, /* Vdbe being configured */
2784 int idx, /* Index of column zName applies to */
2785 int var, /* One of the COLNAME_* constants */
2786 const char *zName, /* Pointer to buffer containing name */
2787 void (*xDel)(void*) /* Memory management strategy for zName */
2788){
danielk19773cf86062004-05-26 10:11:05 +00002789 int rc;
2790 Mem *pColName;
danielk1977955de522006-02-10 02:27:42 +00002791 assert( idx<p->nResColumn );
2792 assert( var<COLNAME_N );
danielk197710fb7492008-10-31 10:53:22 +00002793 if( p->db->mallocFailed ){
2794 assert( !zName || xDel!=SQLITE_DYNAMIC );
mistachkinfad30392016-02-13 23:43:46 +00002795 return SQLITE_NOMEM_BKPT;
danielk197710fb7492008-10-31 10:53:22 +00002796 }
drh76ff3a02004-09-24 22:32:30 +00002797 assert( p->aColName!=0 );
danielk1977955de522006-02-10 02:27:42 +00002798 pColName = &(p->aColName[idx+var*p->nResColumn]);
danielk197710fb7492008-10-31 10:53:22 +00002799 rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
drh0793f1b2008-11-05 17:41:19 +00002800 assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
danielk19773cf86062004-05-26 10:11:05 +00002801 return rc;
2802}
2803
danielk197713adf8a2004-06-03 16:08:41 +00002804/*
2805** A read or write transaction may or may not be active on database handle
2806** db. If a transaction is active, commit it. If there is a
2807** write-transaction spanning more than one database file, this routine
drhccb21132020-06-19 11:34:57 +00002808** takes care of the super-journal trickery.
danielk197713adf8a2004-06-03 16:08:41 +00002809*/
danielk19773e3a84d2008-08-01 17:37:40 +00002810static int vdbeCommit(sqlite3 *db, Vdbe *p){
danielk197713adf8a2004-06-03 16:08:41 +00002811 int i;
drh8e6cf0a2016-02-22 14:57:38 +00002812 int nTrans = 0; /* Number of databases with an active write-transaction
2813 ** that are candidates for a two-phase commit using a
drhccb21132020-06-19 11:34:57 +00002814 ** super-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002815 int rc = SQLITE_OK;
2816 int needXcommit = 0;
2817
shane36840fd2009-06-26 16:32:13 +00002818#ifdef SQLITE_OMIT_VIRTUALTABLE
2819 /* With this option, sqlite3VtabSync() is defined to be simply
2820 ** SQLITE_OK so p is not used.
2821 */
2822 UNUSED_PARAMETER(p);
2823#endif
2824
danielk19775bd270b2006-07-25 15:14:52 +00002825 /* Before doing anything else, call the xSync() callback for any
2826 ** virtual module tables written in this transaction. This has to
drhccb21132020-06-19 11:34:57 +00002827 ** be done before determining whether a super-journal file is
danielk19775bd270b2006-07-25 15:14:52 +00002828 ** required, as an xSync() callback may add an attached database
2829 ** to the transaction.
2830 */
dan016f7812013-08-21 17:35:48 +00002831 rc = sqlite3VtabSync(db, p);
danielk19775bd270b2006-07-25 15:14:52 +00002832
2833 /* This loop determines (a) if the commit hook should be invoked and
2834 ** (b) how many database files have open write transactions, not
2835 ** including the temp database. (b) is important because if more than
drhccb21132020-06-19 11:34:57 +00002836 ** one database file has an open write transaction, a super-journal
danielk19775bd270b2006-07-25 15:14:52 +00002837 ** file is required for an atomic commit.
2838 */
drhabfb62f2010-07-30 11:20:35 +00002839 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002840 Btree *pBt = db->aDb[i].pBt;
drh99744fa2020-08-25 19:09:07 +00002841 if( sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
drhccb21132020-06-19 11:34:57 +00002842 /* Whether or not a database might need a super-journal depends upon
drh8e6cf0a2016-02-22 14:57:38 +00002843 ** its journal mode (among other things). This matrix determines which
drhccb21132020-06-19 11:34:57 +00002844 ** journal modes use a super-journal and which do not */
drh8e6cf0a2016-02-22 14:57:38 +00002845 static const u8 aMJNeeded[] = {
2846 /* DELETE */ 1,
2847 /* PERSIST */ 1,
2848 /* OFF */ 0,
2849 /* TRUNCATE */ 1,
2850 /* MEMORY */ 0,
2851 /* WAL */ 0
2852 };
2853 Pager *pPager; /* Pager associated with pBt */
danielk197713adf8a2004-06-03 16:08:41 +00002854 needXcommit = 1;
dan6b9bb592012-10-05 19:43:02 +00002855 sqlite3BtreeEnter(pBt);
drh8e6cf0a2016-02-22 14:57:38 +00002856 pPager = sqlite3BtreePager(pBt);
2857 if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
2858 && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
dan6cbc5072017-11-17 08:20:10 +00002859 && sqlite3PagerIsMemdb(pPager)==0
drh8e6cf0a2016-02-22 14:57:38 +00002860 ){
2861 assert( i!=1 );
2862 nTrans++;
2863 }
2864 rc = sqlite3PagerExclusiveLock(pPager);
dan6b9bb592012-10-05 19:43:02 +00002865 sqlite3BtreeLeave(pBt);
danielk197713adf8a2004-06-03 16:08:41 +00002866 }
2867 }
drhabfb62f2010-07-30 11:20:35 +00002868 if( rc!=SQLITE_OK ){
2869 return rc;
2870 }
danielk197713adf8a2004-06-03 16:08:41 +00002871
2872 /* If there are any write-transactions at all, invoke the commit hook */
2873 if( needXcommit && db->xCommitCallback ){
drh92f02c32004-09-02 14:57:08 +00002874 rc = db->xCommitCallback(db->pCommitArg);
drh92f02c32004-09-02 14:57:08 +00002875 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00002876 return SQLITE_CONSTRAINT_COMMITHOOK;
danielk197713adf8a2004-06-03 16:08:41 +00002877 }
2878 }
2879
danielk197740b38dc2004-06-26 08:38:24 +00002880 /* The simple case - no more than one database file (not counting the
2881 ** TEMP database) has a transaction active. There is no need for the
drhccb21132020-06-19 11:34:57 +00002882 ** super-journal.
drhc9e06862004-06-09 20:03:08 +00002883 **
danielk197740b38dc2004-06-26 08:38:24 +00002884 ** If the return value of sqlite3BtreeGetFilename() is a zero length
danielk197717b90b52008-06-06 11:11:25 +00002885 ** string, it means the main database is :memory: or a temp file. In
2886 ** that case we do not support atomic multi-file commits, so use the
2887 ** simple case then too.
danielk197713adf8a2004-06-03 16:08:41 +00002888 */
drhea678832008-12-10 19:26:22 +00002889 if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
2890 || nTrans<=1
2891 ){
danielk197704103022009-02-03 16:51:24 +00002892 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002893 Btree *pBt = db->aDb[i].pBt;
2894 if( pBt ){
drh80e35f42007-03-30 14:06:34 +00002895 rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
drh2ac3ee92004-06-07 16:27:46 +00002896 }
2897 }
2898
drh80e35f42007-03-30 14:06:34 +00002899 /* Do the commit only if all databases successfully complete phase 1.
2900 ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
2901 ** IO error while deleting or truncating a journal file. It is unlikely,
2902 ** but could happen. In this case abandon processing and return the error.
danielk1977979f38e2007-03-27 16:19:51 +00002903 */
2904 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
2905 Btree *pBt = db->aDb[i].pBt;
2906 if( pBt ){
dan60939d02011-03-29 15:40:55 +00002907 rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
danielk197713adf8a2004-06-03 16:08:41 +00002908 }
danielk1977979f38e2007-03-27 16:19:51 +00002909 }
2910 if( rc==SQLITE_OK ){
danielk1977f9e7dda2006-06-16 16:08:53 +00002911 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00002912 }
2913 }
2914
2915 /* The complex case - There is a multi-file write-transaction active.
drhccb21132020-06-19 11:34:57 +00002916 ** This requires a super-journal file to ensure the transaction is
peter.d.reid60ec9142014-09-06 16:39:46 +00002917 ** committed atomically.
danielk197713adf8a2004-06-03 16:08:41 +00002918 */
danielk197744ee5bf2005-05-27 09:41:12 +00002919#ifndef SQLITE_OMIT_DISKIO
danielk197713adf8a2004-06-03 16:08:41 +00002920 else{
danielk1977b4b47412007-08-17 15:53:36 +00002921 sqlite3_vfs *pVfs = db->pVfs;
drhccb21132020-06-19 11:34:57 +00002922 char *zSuper = 0; /* File-name for the super-journal */
danielk197713adf8a2004-06-03 16:08:41 +00002923 char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
drh067b92b2020-06-19 15:24:12 +00002924 sqlite3_file *pSuperJrnl = 0;
danielk197762079062007-08-15 17:08:46 +00002925 i64 offset = 0;
danielk1977861f7452008-06-05 11:39:11 +00002926 int res;
drhf5808602011-12-16 00:33:04 +00002927 int retryCount = 0;
drh5c531a42011-12-16 01:21:31 +00002928 int nMainFile;
danielk197713adf8a2004-06-03 16:08:41 +00002929
drhccb21132020-06-19 11:34:57 +00002930 /* Select a super-journal file name */
drh5c531a42011-12-16 01:21:31 +00002931 nMainFile = sqlite3Strlen30(zMainFile);
drhccb21132020-06-19 11:34:57 +00002932 zSuper = sqlite3MPrintf(db, "%.4c%s%.16c", 0,zMainFile,0);
2933 if( zSuper==0 ) return SQLITE_NOMEM_BKPT;
2934 zSuper += 4;
danielk197713adf8a2004-06-03 16:08:41 +00002935 do {
drhdc5ea5c2008-12-10 17:19:59 +00002936 u32 iRandom;
drh84968c02011-12-16 15:11:39 +00002937 if( retryCount ){
2938 if( retryCount>100 ){
drhccb21132020-06-19 11:34:57 +00002939 sqlite3_log(SQLITE_FULL, "MJ delete: %s", zSuper);
2940 sqlite3OsDelete(pVfs, zSuper, 0);
drh84968c02011-12-16 15:11:39 +00002941 break;
2942 }else if( retryCount==1 ){
drhccb21132020-06-19 11:34:57 +00002943 sqlite3_log(SQLITE_FULL, "MJ collide: %s", zSuper);
drh84968c02011-12-16 15:11:39 +00002944 }
danielk197713adf8a2004-06-03 16:08:41 +00002945 }
drh84968c02011-12-16 15:11:39 +00002946 retryCount++;
danielk197713adf8a2004-06-03 16:08:41 +00002947 sqlite3_randomness(sizeof(iRandom), &iRandom);
drhccb21132020-06-19 11:34:57 +00002948 sqlite3_snprintf(13, &zSuper[nMainFile], "-mj%06X9%02X",
drhf5808602011-12-16 00:33:04 +00002949 (iRandom>>8)&0xffffff, iRandom&0xff);
drhccb21132020-06-19 11:34:57 +00002950 /* The antipenultimate character of the super-journal name must
drhf5808602011-12-16 00:33:04 +00002951 ** be "9" to avoid name collisions when using 8+3 filenames. */
drhccb21132020-06-19 11:34:57 +00002952 assert( zSuper[sqlite3Strlen30(zSuper)-3]=='9' );
2953 sqlite3FileSuffix3(zMainFile, zSuper);
2954 rc = sqlite3OsAccess(pVfs, zSuper, SQLITE_ACCESS_EXISTS, &res);
danielk1977861f7452008-06-05 11:39:11 +00002955 }while( rc==SQLITE_OK && res );
2956 if( rc==SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00002957 /* Open the super-journal. */
drh067b92b2020-06-19 15:24:12 +00002958 rc = sqlite3OsOpenMalloc(pVfs, zSuper, &pSuperJrnl,
drh19db9352008-03-27 22:42:51 +00002959 SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
drh067b92b2020-06-19 15:24:12 +00002960 SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_SUPER_JOURNAL, 0
drh19db9352008-03-27 22:42:51 +00002961 );
2962 }
danielk197713adf8a2004-06-03 16:08:41 +00002963 if( rc!=SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00002964 sqlite3DbFree(db, zSuper-4);
danielk197713adf8a2004-06-03 16:08:41 +00002965 return rc;
2966 }
2967
2968 /* Write the name of each database file in the transaction into the new
drhccb21132020-06-19 11:34:57 +00002969 ** super-journal file. If an error occurs at this point close
2970 ** and delete the super-journal file. All the individual journal files
2971 ** still have 'null' as the super-journal pointer, so they will roll
danielk1977aca790a2005-01-13 11:07:52 +00002972 ** back independently if a failure occurs.
danielk197713adf8a2004-06-03 16:08:41 +00002973 */
danielk19771e536952007-08-16 10:09:01 +00002974 for(i=0; i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00002975 Btree *pBt = db->aDb[i].pBt;
drh99744fa2020-08-25 19:09:07 +00002976 if( sqlite3BtreeTxnState(pBt)==SQLITE_TXN_WRITE ){
danielk19775865e3d2004-06-14 06:03:57 +00002977 char const *zFile = sqlite3BtreeGetJournalname(pBt);
drh8c96a6e2010-08-31 01:09:15 +00002978 if( zFile==0 ){
drhb290e1c2009-12-08 13:36:55 +00002979 continue; /* Ignore TEMP and :memory: databases */
2980 }
drh8c96a6e2010-08-31 01:09:15 +00002981 assert( zFile[0]!=0 );
drh067b92b2020-06-19 15:24:12 +00002982 rc = sqlite3OsWrite(pSuperJrnl, zFile, sqlite3Strlen30(zFile)+1,offset);
drhea678832008-12-10 19:26:22 +00002983 offset += sqlite3Strlen30(zFile)+1;
danielk197713adf8a2004-06-03 16:08:41 +00002984 if( rc!=SQLITE_OK ){
drh067b92b2020-06-19 15:24:12 +00002985 sqlite3OsCloseFree(pSuperJrnl);
drhccb21132020-06-19 11:34:57 +00002986 sqlite3OsDelete(pVfs, zSuper, 0);
2987 sqlite3DbFree(db, zSuper-4);
danielk197713adf8a2004-06-03 16:08:41 +00002988 return rc;
2989 }
2990 }
2991 }
2992
drhccb21132020-06-19 11:34:57 +00002993 /* Sync the super-journal file. If the IOCAP_SEQUENTIAL device
danielk19779663b8f2007-08-24 11:52:28 +00002994 ** flag is set this is not required.
2995 */
drh067b92b2020-06-19 15:24:12 +00002996 if( 0==(sqlite3OsDeviceCharacteristics(pSuperJrnl)&SQLITE_IOCAP_SEQUENTIAL)
2997 && SQLITE_OK!=(rc = sqlite3OsSync(pSuperJrnl, SQLITE_SYNC_NORMAL))
danielk1977bea2a942009-01-20 17:06:27 +00002998 ){
drh067b92b2020-06-19 15:24:12 +00002999 sqlite3OsCloseFree(pSuperJrnl);
drhccb21132020-06-19 11:34:57 +00003000 sqlite3OsDelete(pVfs, zSuper, 0);
3001 sqlite3DbFree(db, zSuper-4);
danielk19775865e3d2004-06-14 06:03:57 +00003002 return rc;
3003 }
drhc9e06862004-06-09 20:03:08 +00003004
danielk197713adf8a2004-06-03 16:08:41 +00003005 /* Sync all the db files involved in the transaction. The same call
drhccb21132020-06-19 11:34:57 +00003006 ** sets the super-journal pointer in each individual journal. If
3007 ** an error occurs here, do not delete the super-journal file.
danielk197713adf8a2004-06-03 16:08:41 +00003008 **
drh80e35f42007-03-30 14:06:34 +00003009 ** If the error occurs during the first call to
3010 ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
drhccb21132020-06-19 11:34:57 +00003011 ** super-journal file will be orphaned. But we cannot delete it,
3012 ** in case the super-journal file name was written into the journal
shanebe217792009-03-05 04:20:31 +00003013 ** file before the failure occurred.
danielk197713adf8a2004-06-03 16:08:41 +00003014 */
danielk19775bd270b2006-07-25 15:14:52 +00003015 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
danielk197713adf8a2004-06-03 16:08:41 +00003016 Btree *pBt = db->aDb[i].pBt;
drhd0679ed2007-08-28 22:24:34 +00003017 if( pBt ){
drhccb21132020-06-19 11:34:57 +00003018 rc = sqlite3BtreeCommitPhaseOne(pBt, zSuper);
danielk197713adf8a2004-06-03 16:08:41 +00003019 }
3020 }
drh067b92b2020-06-19 15:24:12 +00003021 sqlite3OsCloseFree(pSuperJrnl);
drhabfb62f2010-07-30 11:20:35 +00003022 assert( rc!=SQLITE_BUSY );
danielk19775bd270b2006-07-25 15:14:52 +00003023 if( rc!=SQLITE_OK ){
drhccb21132020-06-19 11:34:57 +00003024 sqlite3DbFree(db, zSuper-4);
danielk19775bd270b2006-07-25 15:14:52 +00003025 return rc;
3026 }
danielk197713adf8a2004-06-03 16:08:41 +00003027
drhccb21132020-06-19 11:34:57 +00003028 /* Delete the super-journal file. This commits the transaction. After
danielk1977962398d2004-06-14 09:35:16 +00003029 ** doing this the directory is synced again before any individual
3030 ** transaction files are deleted.
3031 */
drhccb21132020-06-19 11:34:57 +00003032 rc = sqlite3OsDelete(pVfs, zSuper, 1);
3033 sqlite3DbFree(db, zSuper-4);
3034 zSuper = 0;
drh29a01382006-08-13 19:04:18 +00003035 if( rc ){
3036 return rc;
3037 }
danielk197713adf8a2004-06-03 16:08:41 +00003038
3039 /* All files and directories have already been synced, so the following
drh80e35f42007-03-30 14:06:34 +00003040 ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
3041 ** deleting or truncating journals. If something goes wrong while
3042 ** this is happening we don't really care. The integrity of the
3043 ** transaction is already guaranteed, but some stray 'cold' journals
3044 ** may be lying around. Returning an error code won't help matters.
danielk197713adf8a2004-06-03 16:08:41 +00003045 */
danielk1977979f38e2007-03-27 16:19:51 +00003046 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00003047 sqlite3BeginBenignMalloc();
danielk197713adf8a2004-06-03 16:08:41 +00003048 for(i=0; i<db->nDb; i++){
3049 Btree *pBt = db->aDb[i].pBt;
3050 if( pBt ){
dan60939d02011-03-29 15:40:55 +00003051 sqlite3BtreeCommitPhaseTwo(pBt, 1);
danielk197713adf8a2004-06-03 16:08:41 +00003052 }
3053 }
danielk19772d1d86f2008-06-20 14:59:51 +00003054 sqlite3EndBenignMalloc();
danielk1977979f38e2007-03-27 16:19:51 +00003055 enable_simulated_io_errors();
3056
danielk1977f9e7dda2006-06-16 16:08:53 +00003057 sqlite3VtabCommit(db);
danielk197713adf8a2004-06-03 16:08:41 +00003058 }
danielk197744ee5bf2005-05-27 09:41:12 +00003059#endif
danielk1977026d2702004-06-14 13:14:59 +00003060
drh2ac3ee92004-06-07 16:27:46 +00003061 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00003062}
3063
danielk19771d850a72004-05-31 08:26:49 +00003064/*
drh4f7d3a52013-06-27 23:54:02 +00003065** This routine checks that the sqlite3.nVdbeActive count variable
danielk19771d850a72004-05-31 08:26:49 +00003066** matches the number of vdbe's in the list sqlite3.pVdbe that are
3067** currently active. An assertion fails if the two counts do not match.
drh92f02c32004-09-02 14:57:08 +00003068** This is an internal self-check only - it is not an essential processing
3069** step.
danielk19771d850a72004-05-31 08:26:49 +00003070**
3071** This is a no-op if NDEBUG is defined.
3072*/
3073#ifndef NDEBUG
drh9bb575f2004-09-06 17:24:11 +00003074static void checkActiveVdbeCnt(sqlite3 *db){
danielk19771d850a72004-05-31 08:26:49 +00003075 Vdbe *p;
3076 int cnt = 0;
drhad4a4b82008-11-05 16:37:34 +00003077 int nWrite = 0;
drh4f7d3a52013-06-27 23:54:02 +00003078 int nRead = 0;
danielk19771d850a72004-05-31 08:26:49 +00003079 p = db->pVdbe;
3080 while( p ){
dan857745c2014-07-19 17:57:10 +00003081 if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
danielk19771d850a72004-05-31 08:26:49 +00003082 cnt++;
drhad4a4b82008-11-05 16:37:34 +00003083 if( p->readOnly==0 ) nWrite++;
drh1713afb2013-06-28 01:24:57 +00003084 if( p->bIsReader ) nRead++;
danielk19771d850a72004-05-31 08:26:49 +00003085 }
drhe5928b12022-08-23 20:11:01 +00003086 p = p->pVNext;
danielk19771d850a72004-05-31 08:26:49 +00003087 }
drh4f7d3a52013-06-27 23:54:02 +00003088 assert( cnt==db->nVdbeActive );
3089 assert( nWrite==db->nVdbeWrite );
3090 assert( nRead==db->nVdbeRead );
danielk19771d850a72004-05-31 08:26:49 +00003091}
3092#else
3093#define checkActiveVdbeCnt(x)
3094#endif
3095
danielk19773cf86062004-05-26 10:11:05 +00003096/*
danielk1977bd434552009-03-18 10:33:00 +00003097** If the Vdbe passed as the first argument opened a statement-transaction,
3098** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
3099** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
3100** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
drhf7b54962013-05-28 12:11:54 +00003101** statement transaction is committed.
danielk1977bd434552009-03-18 10:33:00 +00003102**
3103** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
3104** Otherwise SQLITE_OK.
3105*/
drhd0840642017-01-26 17:11:18 +00003106static SQLITE_NOINLINE int vdbeCloseStatement(Vdbe *p, int eOp){
danielk1977c926b6a2009-03-20 14:42:11 +00003107 sqlite3 *const db = p->db;
danielk1977bd434552009-03-18 10:33:00 +00003108 int rc = SQLITE_OK;
drhd0840642017-01-26 17:11:18 +00003109 int i;
3110 const int iSavepoint = p->iStatement-1;
danielk1977ecaecf92009-07-08 08:05:35 +00003111
drhd0840642017-01-26 17:11:18 +00003112 assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
3113 assert( db->nStatement>0 );
3114 assert( p->iStatement==(db->nStatement+db->nSavepoint) );
danielk1977bd434552009-03-18 10:33:00 +00003115
drhd0840642017-01-26 17:11:18 +00003116 for(i=0; i<db->nDb; i++){
3117 int rc2 = SQLITE_OK;
3118 Btree *pBt = db->aDb[i].pBt;
3119 if( pBt ){
dana311b802011-04-26 19:21:34 +00003120 if( eOp==SAVEPOINT_ROLLBACK ){
drhd0840642017-01-26 17:11:18 +00003121 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
3122 }
3123 if( rc2==SQLITE_OK ){
3124 rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
dana311b802011-04-26 19:21:34 +00003125 }
3126 if( rc==SQLITE_OK ){
drhd0840642017-01-26 17:11:18 +00003127 rc = rc2;
dana311b802011-04-26 19:21:34 +00003128 }
3129 }
drhd0840642017-01-26 17:11:18 +00003130 }
3131 db->nStatement--;
3132 p->iStatement = 0;
dana311b802011-04-26 19:21:34 +00003133
drhd0840642017-01-26 17:11:18 +00003134 if( rc==SQLITE_OK ){
dan1da40a32009-09-19 17:00:31 +00003135 if( eOp==SAVEPOINT_ROLLBACK ){
drhd0840642017-01-26 17:11:18 +00003136 rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
dan1da40a32009-09-19 17:00:31 +00003137 }
drhd0840642017-01-26 17:11:18 +00003138 if( rc==SQLITE_OK ){
3139 rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
3140 }
3141 }
3142
3143 /* If the statement transaction is being rolled back, also restore the
3144 ** database handles deferred constraint counter to the value it had when
3145 ** the statement transaction was opened. */
3146 if( eOp==SAVEPOINT_ROLLBACK ){
3147 db->nDeferredCons = p->nStmtDefCons;
3148 db->nDeferredImmCons = p->nStmtDefImmCons;
danielk1977bd434552009-03-18 10:33:00 +00003149 }
3150 return rc;
3151}
drhd0840642017-01-26 17:11:18 +00003152int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
3153 if( p->db->nStatement && p->iStatement ){
3154 return vdbeCloseStatement(p, eOp);
3155 }
3156 return SQLITE_OK;
3157}
3158
danielk1977bd434552009-03-18 10:33:00 +00003159
3160/*
dan1da40a32009-09-19 17:00:31 +00003161** This function is called when a transaction opened by the database
3162** handle associated with the VM passed as an argument is about to be
3163** committed. If there are outstanding deferred foreign key constraint
3164** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
3165**
3166** If there are outstanding FK violations and this function returns
drhd91c1a12013-02-09 13:58:25 +00003167** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
3168** and write an error message to it. Then return SQLITE_ERROR.
dan1da40a32009-09-19 17:00:31 +00003169*/
3170#ifndef SQLITE_OMIT_FOREIGN_KEY
dan32b09f22009-09-23 17:29:59 +00003171int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
dan1da40a32009-09-19 17:00:31 +00003172 sqlite3 *db = p->db;
dancb3e4b72013-07-03 19:53:05 +00003173 if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
3174 || (!deferred && p->nFkConstraint>0)
3175 ){
drhd91c1a12013-02-09 13:58:25 +00003176 p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
dan32b09f22009-09-23 17:29:59 +00003177 p->errorAction = OE_Abort;
drh22c17b82015-05-15 04:13:15 +00003178 sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
drh89cf9582022-03-31 11:12:56 +00003179 if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)==0 ) return SQLITE_ERROR;
drh90402d42022-03-14 16:54:05 +00003180 return SQLITE_CONSTRAINT_FOREIGNKEY;
dan1da40a32009-09-19 17:00:31 +00003181 }
3182 return SQLITE_OK;
3183}
3184#endif
3185
3186/*
drh92f02c32004-09-02 14:57:08 +00003187** This routine is called the when a VDBE tries to halt. If the VDBE
3188** has made changes and is in autocommit mode, then commit those
3189** changes. If a rollback is needed, then do the rollback.
drh9a324642003-09-06 20:12:01 +00003190**
drh687d74d2021-08-09 13:06:59 +00003191** This routine is the only way to move the sqlite3eOpenState of a VM from
3192** SQLITE_STATE_RUN to SQLITE_STATE_HALT. It is harmless to
3193** call this on a VM that is in the SQLITE_STATE_HALT state.
drh92f02c32004-09-02 14:57:08 +00003194**
3195** Return an error code. If the commit could not complete because of
3196** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
3197** means the close did not happen and needs to be repeated.
drh9a324642003-09-06 20:12:01 +00003198*/
drhff0587c2007-08-29 17:43:19 +00003199int sqlite3VdbeHalt(Vdbe *p){
danielk1977bd434552009-03-18 10:33:00 +00003200 int rc; /* Used to store transient return codes */
drh9bb575f2004-09-06 17:24:11 +00003201 sqlite3 *db = p->db;
danielk197707cb5602006-01-20 10:55:05 +00003202
3203 /* This function contains the logic that determines if a statement or
3204 ** transaction will be committed or rolled back as a result of the
3205 ** execution of this virtual machine.
3206 **
drh71b890a2007-10-03 15:30:52 +00003207 ** If any of the following errors occur:
danielk197707cb5602006-01-20 10:55:05 +00003208 **
drh71b890a2007-10-03 15:30:52 +00003209 ** SQLITE_NOMEM
3210 ** SQLITE_IOERR
3211 ** SQLITE_FULL
3212 ** SQLITE_INTERRUPT
danielk197707cb5602006-01-20 10:55:05 +00003213 **
drh71b890a2007-10-03 15:30:52 +00003214 ** Then the internal cache might have been left in an inconsistent
3215 ** state. We need to rollback the statement transaction, if there is
3216 ** one, or the complete transaction if there is no statement transaction.
danielk197707cb5602006-01-20 10:55:05 +00003217 */
drh9a324642003-09-06 20:12:01 +00003218
drh8703edd2022-04-03 22:35:13 +00003219 assert( p->eVdbeState==VDBE_RUN_STATE );
drhb84e5742016-02-05 02:42:54 +00003220 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00003221 p->rc = SQLITE_NOMEM_BKPT;
danielk1977261919c2005-12-06 12:52:59 +00003222 }
drh5f82e3c2009-07-06 00:44:08 +00003223 closeAllCursors(p);
danielk19771d850a72004-05-31 08:26:49 +00003224 checkActiveVdbeCnt(db);
danielk1977261919c2005-12-06 12:52:59 +00003225
danc0537fe2013-06-28 19:41:43 +00003226 /* No commit or rollback needed if the program never started or if the
3227 ** SQL statement does not read or write a database file. */
drh99a21822022-03-31 21:15:09 +00003228 if( p->bIsReader ){
drhaac2f552006-09-23 21:44:23 +00003229 int mrc; /* Primary error code from p->rc */
danielk1977bd434552009-03-18 10:33:00 +00003230 int eStatementOp = 0;
3231 int isSpecialError; /* Set to true if a 'special' error */
drhff0587c2007-08-29 17:43:19 +00003232
3233 /* Lock all btrees used by the statement */
drhbdaec522011-04-04 00:14:43 +00003234 sqlite3VdbeEnter(p);
drhff0587c2007-08-29 17:43:19 +00003235
drh71b890a2007-10-03 15:30:52 +00003236 /* Check for one of the special errors */
drh3ce76a02021-11-15 18:50:02 +00003237 if( p->rc ){
3238 mrc = p->rc & 0xff;
3239 isSpecialError = mrc==SQLITE_NOMEM
3240 || mrc==SQLITE_IOERR
3241 || mrc==SQLITE_INTERRUPT
3242 || mrc==SQLITE_FULL;
3243 }else{
3244 mrc = isSpecialError = 0;
3245 }
danielk197707cb5602006-01-20 10:55:05 +00003246 if( isSpecialError ){
dan5653e4d2010-08-12 11:25:47 +00003247 /* If the query was read-only and the error code is SQLITE_INTERRUPT,
3248 ** no rollback is necessary. Otherwise, at least a savepoint
3249 ** transaction must be rolled back to restore the database to a
3250 ** consistent state.
3251 **
3252 ** Even if the statement is read-only, it is important to perform
3253 ** a statement or transaction rollback operation. If the error
mistachkin48864df2013-03-21 21:20:32 +00003254 ** occurred while writing to the journal, sub-journal or database
dan5653e4d2010-08-12 11:25:47 +00003255 ** file as part of an effort to free up cache space (see function
3256 ** pagerStress() in pager.c), the rollback is required to restore
3257 ** the pager to a consistent state.
danielk197707cb5602006-01-20 10:55:05 +00003258 */
drhad4a4b82008-11-05 16:37:34 +00003259 if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
drhfa3be902009-07-07 02:44:07 +00003260 if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
danielk1977bd434552009-03-18 10:33:00 +00003261 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00003262 }else{
3263 /* We are forced to roll back the active transaction. Before doing
3264 ** so, abort any other statements this handle currently has active.
3265 */
drh21021a52012-02-13 17:01:51 +00003266 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00003267 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00003268 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00003269 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003270 }
danielk1977261919c2005-12-06 12:52:59 +00003271 }
3272 }
dan32b09f22009-09-23 17:29:59 +00003273
3274 /* Check for immediate foreign key violations. */
danf116ad82019-05-07 19:44:11 +00003275 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan32b09f22009-09-23 17:29:59 +00003276 sqlite3VdbeCheckFk(p, 0);
3277 }
danielk197707cb5602006-01-20 10:55:05 +00003278
danielk1977bd434552009-03-18 10:33:00 +00003279 /* If the auto-commit flag is set and this is the only active writer
3280 ** VM, then we do either a commit or rollback of the current transaction.
danielk197707cb5602006-01-20 10:55:05 +00003281 **
3282 ** Note: This block also runs if one of the special errors handled
drhad4a4b82008-11-05 16:37:34 +00003283 ** above has occurred.
danielk197707cb5602006-01-20 10:55:05 +00003284 */
danielk1977093e0f62008-11-13 18:00:14 +00003285 if( !sqlite3VtabInSync(db)
3286 && db->autoCommit
drh4f7d3a52013-06-27 23:54:02 +00003287 && db->nVdbeWrite==(p->readOnly==0)
danielk1977093e0f62008-11-13 18:00:14 +00003288 ){
danielk197707cb5602006-01-20 10:55:05 +00003289 if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
dan19611b12011-01-24 16:00:58 +00003290 rc = sqlite3VdbeCheckFk(p, 1);
3291 if( rc!=SQLITE_OK ){
drhe9ce5852011-02-11 22:54:28 +00003292 if( NEVER(p->readOnly) ){
drhbdaec522011-04-04 00:14:43 +00003293 sqlite3VdbeLeave(p);
dan19611b12011-01-24 16:00:58 +00003294 return SQLITE_ERROR;
3295 }
drhd91c1a12013-02-09 13:58:25 +00003296 rc = SQLITE_CONSTRAINT_FOREIGNKEY;
drh9dc71882021-11-15 19:10:13 +00003297 }else if( db->flags & SQLITE_CorruptRdOnly ){
3298 rc = SQLITE_CORRUPT;
3299 db->flags &= ~SQLITE_CorruptRdOnly;
dan19611b12011-01-24 16:00:58 +00003300 }else{
3301 /* The auto-commit flag is true, the vdbe program was successful
3302 ** or hit an 'OR FAIL' constraint and there are no deferred foreign
3303 ** key constraints to hold up the transaction. This means a commit
3304 ** is required. */
3305 rc = vdbeCommit(db, p);
dan1da40a32009-09-19 17:00:31 +00003306 }
dan19611b12011-01-24 16:00:58 +00003307 if( rc==SQLITE_BUSY && p->readOnly ){
drhbdaec522011-04-04 00:14:43 +00003308 sqlite3VdbeLeave(p);
danielk197707cb5602006-01-20 10:55:05 +00003309 return SQLITE_BUSY;
3310 }else if( rc!=SQLITE_OK ){
3311 p->rc = rc;
drh0f198a72012-02-13 16:43:16 +00003312 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00003313 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003314 }else{
dan1da40a32009-09-19 17:00:31 +00003315 db->nDeferredCons = 0;
dancb3e4b72013-07-03 19:53:05 +00003316 db->nDeferredImmCons = 0;
drhd5b44d62018-12-06 17:06:02 +00003317 db->flags &= ~(u64)SQLITE_DeferFKs;
danielk197707cb5602006-01-20 10:55:05 +00003318 sqlite3CommitInternalChanges(db);
3319 }
3320 }else{
drh0f198a72012-02-13 16:43:16 +00003321 sqlite3RollbackAll(db, SQLITE_OK);
danc3da6672014-10-28 18:24:16 +00003322 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003323 }
danielk1977bd434552009-03-18 10:33:00 +00003324 db->nStatement = 0;
3325 }else if( eStatementOp==0 ){
danielk197707cb5602006-01-20 10:55:05 +00003326 if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
danielk1977bd434552009-03-18 10:33:00 +00003327 eStatementOp = SAVEPOINT_RELEASE;
danielk197707cb5602006-01-20 10:55:05 +00003328 }else if( p->errorAction==OE_Abort ){
danielk1977bd434552009-03-18 10:33:00 +00003329 eStatementOp = SAVEPOINT_ROLLBACK;
danielk197707cb5602006-01-20 10:55:05 +00003330 }else{
drh21021a52012-02-13 17:01:51 +00003331 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
danielk1977fc158bf2009-01-07 08:12:16 +00003332 sqlite3CloseSavepoints(db);
danielk197707cb5602006-01-20 10:55:05 +00003333 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00003334 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003335 }
danielk19771d850a72004-05-31 08:26:49 +00003336 }
danielk197707cb5602006-01-20 10:55:05 +00003337
danielk1977bd434552009-03-18 10:33:00 +00003338 /* If eStatementOp is non-zero, then a statement transaction needs to
3339 ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
3340 ** do so. If this operation returns an error, and the current statement
drh35173242010-03-08 21:40:13 +00003341 ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
3342 ** current statement error code.
danielk197707cb5602006-01-20 10:55:05 +00003343 */
danielk1977bd434552009-03-18 10:33:00 +00003344 if( eStatementOp ){
3345 rc = sqlite3VdbeCloseStatement(p, eStatementOp);
dan40ad9d22010-06-03 09:17:38 +00003346 if( rc ){
drhd91c1a12013-02-09 13:58:25 +00003347 if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
dan40ad9d22010-06-03 09:17:38 +00003348 p->rc = rc;
3349 sqlite3DbFree(db, p->zErrMsg);
3350 p->zErrMsg = 0;
3351 }
drh21021a52012-02-13 17:01:51 +00003352 sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
dan40ad9d22010-06-03 09:17:38 +00003353 sqlite3CloseSavepoints(db);
3354 db->autoCommit = 1;
danc3da6672014-10-28 18:24:16 +00003355 p->nChange = 0;
danielk197707cb5602006-01-20 10:55:05 +00003356 }
danielk197777d83ba2004-05-31 10:08:14 +00003357 }
danielk197707cb5602006-01-20 10:55:05 +00003358
danielk1977bd434552009-03-18 10:33:00 +00003359 /* If this was an INSERT, UPDATE or DELETE and no statement transaction
3360 ** has been rolled back, update the database connection change-counter.
danielk197707cb5602006-01-20 10:55:05 +00003361 */
drh6be240e2009-07-14 02:33:02 +00003362 if( p->changeCntOn ){
danielk1977bd434552009-03-18 10:33:00 +00003363 if( eStatementOp!=SAVEPOINT_ROLLBACK ){
danielk197707cb5602006-01-20 10:55:05 +00003364 sqlite3VdbeSetChanges(db, p->nChange);
3365 }else{
3366 sqlite3VdbeSetChanges(db, 0);
3367 }
3368 p->nChange = 0;
danielk1977b28af712004-06-21 06:50:26 +00003369 }
drhff0587c2007-08-29 17:43:19 +00003370
3371 /* Release the locks */
drhbdaec522011-04-04 00:14:43 +00003372 sqlite3VdbeLeave(p);
drh9a324642003-09-06 20:12:01 +00003373 }
danielk19771d850a72004-05-31 08:26:49 +00003374
danielk197765fd59f2006-06-24 11:51:33 +00003375 /* We have successfully halted and closed the VM. Record this fact. */
drh99a21822022-03-31 21:15:09 +00003376 db->nVdbeActive--;
3377 if( !p->readOnly ) db->nVdbeWrite--;
3378 if( p->bIsReader ) db->nVdbeRead--;
3379 assert( db->nVdbeActive>=db->nVdbeRead );
3380 assert( db->nVdbeRead>=db->nVdbeWrite );
3381 assert( db->nVdbeWrite>=0 );
drh66181ce2022-03-31 20:04:49 +00003382 p->eVdbeState = VDBE_HALT_STATE;
drh92f02c32004-09-02 14:57:08 +00003383 checkActiveVdbeCnt(db);
drhb84e5742016-02-05 02:42:54 +00003384 if( db->mallocFailed ){
mistachkinfad30392016-02-13 23:43:46 +00003385 p->rc = SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00003386 }
danielk19771d850a72004-05-31 08:26:49 +00003387
danielk1977404ca072009-03-16 13:19:36 +00003388 /* If the auto-commit flag is set to true, then any locks that were held
3389 ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
3390 ** to invoke any required unlock-notify callbacks.
3391 */
3392 if( db->autoCommit ){
3393 sqlite3ConnectionUnlocked(db);
3394 }
3395
drh4f7d3a52013-06-27 23:54:02 +00003396 assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
dan19611b12011-01-24 16:00:58 +00003397 return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
drh92f02c32004-09-02 14:57:08 +00003398}
drh4cf7c7f2007-08-28 23:28:07 +00003399
drh92f02c32004-09-02 14:57:08 +00003400
3401/*
drh3c23a882007-01-09 14:01:13 +00003402** Each VDBE holds the result of the most recent sqlite3_step() call
3403** in p->rc. This routine sets that result back to SQLITE_OK.
3404*/
3405void sqlite3VdbeResetStepResult(Vdbe *p){
3406 p->rc = SQLITE_OK;
3407}
3408
3409/*
dan029ead62011-10-27 15:19:58 +00003410** Copy the error code and error message belonging to the VDBE passed
3411** as the first argument to its database handle (so that they will be
3412** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
3413**
3414** This function does not clear the VDBE error code or message, just
3415** copies them to the database handle.
3416*/
3417int sqlite3VdbeTransferError(Vdbe *p){
3418 sqlite3 *db = p->db;
3419 int rc = p->rc;
3420 if( p->zErrMsg ){
drh4a642b62016-02-05 01:55:27 +00003421 db->bBenignMalloc++;
dan029ead62011-10-27 15:19:58 +00003422 sqlite3BeginBenignMalloc();
drha3cc0072013-12-13 16:23:55 +00003423 if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
dan029ead62011-10-27 15:19:58 +00003424 sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
3425 sqlite3EndBenignMalloc();
drh4a642b62016-02-05 01:55:27 +00003426 db->bBenignMalloc--;
drhe70d01f2017-05-29 22:44:18 +00003427 }else if( db->pErr ){
3428 sqlite3ValueSetNull(db->pErr);
dan029ead62011-10-27 15:19:58 +00003429 }
drhe70d01f2017-05-29 22:44:18 +00003430 db->errCode = rc;
drhe1c47432022-02-07 18:52:56 +00003431 db->errByteOffset = -1;
dan029ead62011-10-27 15:19:58 +00003432 return rc;
3433}
3434
danac455932012-11-26 19:50:41 +00003435#ifdef SQLITE_ENABLE_SQLLOG
3436/*
3437** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
3438** invoke it.
3439*/
3440static void vdbeInvokeSqllog(Vdbe *v){
3441 if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
3442 char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
3443 assert( v->db->init.busy==0 );
3444 if( zExpanded ){
3445 sqlite3GlobalConfig.xSqllog(
3446 sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
3447 );
3448 sqlite3DbFree(v->db, zExpanded);
3449 }
3450 }
3451}
3452#else
3453# define vdbeInvokeSqllog(x)
3454#endif
3455
dan029ead62011-10-27 15:19:58 +00003456/*
drh92f02c32004-09-02 14:57:08 +00003457** Clean up a VDBE after execution but do not delete the VDBE just yet.
3458** Write any error messages into *pzErrMsg. Return the result code.
3459**
3460** After this routine is run, the VDBE should be ready to be executed
3461** again.
3462**
3463** To look at it another way, this routine resets the state of the
drh66181ce2022-03-31 20:04:49 +00003464** virtual machine from VDBE_RUN_STATE or VDBE_HALT_STATE back to
3465** VDBE_READY_STATE.
drh92f02c32004-09-02 14:57:08 +00003466*/
drhc890fec2008-08-01 20:10:08 +00003467int sqlite3VdbeReset(Vdbe *p){
mistachkin4537f772017-10-07 23:35:40 +00003468#if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
mistachkinb60424e2017-10-07 23:31:33 +00003469 int i;
3470#endif
3471
drh4ac285a2006-09-15 07:28:50 +00003472 sqlite3 *db;
drh4ac285a2006-09-15 07:28:50 +00003473 db = p->db;
drh92f02c32004-09-02 14:57:08 +00003474
3475 /* If the VM did not run to completion or if it encountered an
3476 ** error, then it might not have been halted properly. So halt
3477 ** it now.
3478 */
drh8703edd2022-04-03 22:35:13 +00003479 if( p->eVdbeState==VDBE_RUN_STATE ) sqlite3VdbeHalt(p);
drh92f02c32004-09-02 14:57:08 +00003480
drh8741d0d2018-09-12 00:21:11 +00003481 /* If the VDBE has been run even partially, then transfer the error code
drhfb7e7652005-01-24 00:28:42 +00003482 ** and error message from the VDBE into the main database structure. But
3483 ** if the VDBE has just been set to run but has not actually executed any
3484 ** instructions yet, leave the main database error information unchanged.
drh92f02c32004-09-02 14:57:08 +00003485 */
drhfb7e7652005-01-24 00:28:42 +00003486 if( p->pc>=0 ){
danac455932012-11-26 19:50:41 +00003487 vdbeInvokeSqllog(p);
drhed505ce2020-05-26 20:31:17 +00003488 if( db->pErr || p->zErrMsg ){
3489 sqlite3VdbeTransferError(p);
3490 }else{
3491 db->errCode = p->rc;
3492 }
drh92f02c32004-09-02 14:57:08 +00003493 }
3494
drhc2c6fd12017-09-09 22:46:56 +00003495 /* Reset register contents and reclaim error message memory.
drh92f02c32004-09-02 14:57:08 +00003496 */
drhc2c6fd12017-09-09 22:46:56 +00003497#ifdef SQLITE_DEBUG
3498 /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
3499 ** Vdbe.aMem[] arrays have already been cleaned up. */
drhc2c6fd12017-09-09 22:46:56 +00003500 if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
3501 if( p->aMem ){
3502 for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
3503 }
3504#endif
drhed505ce2020-05-26 20:31:17 +00003505 if( p->zErrMsg ){
3506 sqlite3DbFree(db, p->zErrMsg);
3507 p->zErrMsg = 0;
3508 }
drhedc27132022-12-22 18:44:39 +00003509 p->pResultRow = 0;
drh4031baf2018-05-28 17:31:20 +00003510#ifdef SQLITE_DEBUG
3511 p->nWrite = 0;
3512#endif
drh92f02c32004-09-02 14:57:08 +00003513
3514 /* Save profiling information from this VDBE run.
3515 */
drh9a324642003-09-06 20:12:01 +00003516#ifdef VDBE_PROFILE
3517 {
3518 FILE *out = fopen("vdbe_profile.out", "a");
3519 if( out ){
drh9a324642003-09-06 20:12:01 +00003520 fprintf(out, "---- ");
3521 for(i=0; i<p->nOp; i++){
3522 fprintf(out, "%02x", p->aOp[i].opcode);
3523 }
3524 fprintf(out, "\n");
drh2926f962014-02-17 01:13:28 +00003525 if( p->zSql ){
3526 char c, pc = 0;
3527 fprintf(out, "-- ");
3528 for(i=0; (c = p->zSql[i])!=0; i++){
3529 if( pc=='\n' ) fprintf(out, "-- ");
3530 putc(c, out);
3531 pc = c;
3532 }
3533 if( pc!='\n' ) fprintf(out, "\n");
3534 }
drh9a324642003-09-06 20:12:01 +00003535 for(i=0; i<p->nOp; i++){
drh15ab9412014-02-24 14:24:01 +00003536 char zHdr[100];
dan7f4b0662022-12-07 20:09:54 +00003537 i64 cnt = p->aOp[i].nExec;
3538 i64 cycles = p->aOp[i].nCycle;
drh15ab9412014-02-24 14:24:01 +00003539 sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
dan231ff4b2022-12-02 20:32:22 +00003540 cnt,
3541 cycles,
3542 cnt>0 ? cycles/cnt : 0
drh9a324642003-09-06 20:12:01 +00003543 );
drh15ab9412014-02-24 14:24:01 +00003544 fprintf(out, "%s", zHdr);
danielk19774adee202004-05-08 08:23:19 +00003545 sqlite3VdbePrintOp(out, i, &p->aOp[i]);
drh9a324642003-09-06 20:12:01 +00003546 }
3547 fclose(out);
3548 }
3549 }
3550#endif
drh4ac285a2006-09-15 07:28:50 +00003551 return p->rc & db->errMask;
drh9a324642003-09-06 20:12:01 +00003552}
drh92f02c32004-09-02 14:57:08 +00003553
drh9a324642003-09-06 20:12:01 +00003554/*
3555** Clean up and delete a VDBE after execution. Return an integer which is
3556** the result code. Write any error message text into *pzErrMsg.
3557*/
danielk19779e6db7d2004-06-21 08:18:51 +00003558int sqlite3VdbeFinalize(Vdbe *p){
danielk1977b5548a82004-06-26 13:51:33 +00003559 int rc = SQLITE_OK;
drh99a21822022-03-31 21:15:09 +00003560 assert( VDBE_RUN_STATE>VDBE_READY_STATE );
3561 assert( VDBE_HALT_STATE>VDBE_READY_STATE );
3562 assert( VDBE_INIT_STATE<VDBE_READY_STATE );
3563 if( p->eVdbeState>=VDBE_READY_STATE ){
drhc890fec2008-08-01 20:10:08 +00003564 rc = sqlite3VdbeReset(p);
drh4ac285a2006-09-15 07:28:50 +00003565 assert( (rc & p->db->errMask)==rc );
drh9a324642003-09-06 20:12:01 +00003566 }
danielk19774adee202004-05-08 08:23:19 +00003567 sqlite3VdbeDelete(p);
drh9a324642003-09-06 20:12:01 +00003568 return rc;
3569}
3570
3571/*
dan0c547792013-07-18 17:12:08 +00003572** If parameter iOp is less than zero, then invoke the destructor for
3573** all auxiliary data pointers currently cached by the VM passed as
3574** the first argument.
3575**
3576** Or, if iOp is greater than or equal to zero, then the destructor is
3577** only invoked for those auxiliary data pointers created by the user
3578** function invoked by the OP_Function opcode at instruction iOp of
3579** VM pVdbe, and only then if:
3580**
3581** * the associated function parameter is the 32nd or later (counting
3582** from left to right), or
3583**
3584** * the corresponding bit in argument mask is clear (where the first
peter.d.reid60ec9142014-09-06 16:39:46 +00003585** function parameter corresponds to bit 0 etc.).
drhf92c7ff2004-06-19 15:40:23 +00003586*/
drhb9626cf2016-02-22 16:04:31 +00003587void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
dan0c547792013-07-18 17:12:08 +00003588 while( *pp ){
3589 AuxData *pAux = *pp;
3590 if( (iOp<0)
drhf7fa4e72017-05-11 15:20:18 +00003591 || (pAux->iAuxOp==iOp
3592 && pAux->iAuxArg>=0
drhe6941392017-05-10 19:42:52 +00003593 && (pAux->iAuxArg>31 || !(mask & MASKBIT32(pAux->iAuxArg))))
dan0c547792013-07-18 17:12:08 +00003594 ){
drhe6941392017-05-10 19:42:52 +00003595 testcase( pAux->iAuxArg==31 );
3596 if( pAux->xDeleteAux ){
3597 pAux->xDeleteAux(pAux->pAux);
drhf92c7ff2004-06-19 15:40:23 +00003598 }
drhe6941392017-05-10 19:42:52 +00003599 *pp = pAux->pNextAux;
drhb9626cf2016-02-22 16:04:31 +00003600 sqlite3DbFree(db, pAux);
dan0c547792013-07-18 17:12:08 +00003601 }else{
drhe6941392017-05-10 19:42:52 +00003602 pp= &pAux->pNextAux;
drhf92c7ff2004-06-19 15:40:23 +00003603 }
3604 }
3605}
3606
3607/*
drhcb103b92012-10-26 00:11:23 +00003608** Free all memory associated with the Vdbe passed as the second argument,
3609** except for object itself, which is preserved.
3610**
dand46def72010-07-24 11:28:28 +00003611** The difference between this function and sqlite3VdbeDelete() is that
3612** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
drhcb103b92012-10-26 00:11:23 +00003613** the database connection and frees the object itself.
dand46def72010-07-24 11:28:28 +00003614*/
drh1c848632022-04-04 01:12:11 +00003615static void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
dand19c9332010-07-26 12:05:17 +00003616 SubProgram *pSub, *pNext;
drh41ce47c2022-08-22 02:00:26 +00003617 assert( db!=0 );
dand46def72010-07-24 11:28:28 +00003618 assert( p->db==0 || p->db==db );
drhda3ec152022-03-28 14:18:03 +00003619 if( p->aColName ){
3620 releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
drh41ce47c2022-08-22 02:00:26 +00003621 sqlite3DbNNFreeNN(db, p->aColName);
drhda3ec152022-03-28 14:18:03 +00003622 }
dand19c9332010-07-26 12:05:17 +00003623 for(pSub=p->pProgram; pSub; pSub=pNext){
3624 pNext = pSub->pNext;
3625 vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
3626 sqlite3DbFree(db, pSub);
3627 }
drh66181ce2022-03-31 20:04:49 +00003628 if( p->eVdbeState!=VDBE_INIT_STATE ){
drh8dfef112016-10-01 16:53:45 +00003629 releaseMemArray(p->aVar, p->nVar);
drh41ce47c2022-08-22 02:00:26 +00003630 if( p->pVList ) sqlite3DbNNFreeNN(db, p->pVList);
3631 if( p->pFree ) sqlite3DbNNFreeNN(db, p->pFree);
drhab3182f2016-10-01 00:37:50 +00003632 }
dand46def72010-07-24 11:28:28 +00003633 vdbeFreeOpArray(db, p->aOp, p->nOp);
drh41ce47c2022-08-22 02:00:26 +00003634 if( p->zSql ) sqlite3DbNNFreeNN(db, p->zSql);
mistachkin8bee11a2018-10-29 17:53:23 +00003635#ifdef SQLITE_ENABLE_NORMALIZE
3636 sqlite3DbFree(db, p->zNormSql);
drh893bd372018-12-07 16:32:11 +00003637 {
3638 DblquoteStr *pThis, *pNext;
3639 for(pThis=p->pDblStr; pThis; pThis=pNext){
3640 pNext = pThis->pNextStr;
3641 sqlite3DbFree(db, pThis);
3642 }
3643 }
mistachkin8bee11a2018-10-29 17:53:23 +00003644#endif
dan6f9702e2014-11-01 20:38:06 +00003645#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
drhf326d662016-12-23 13:30:53 +00003646 {
3647 int i;
3648 for(i=0; i<p->nScan; i++){
3649 sqlite3DbFree(db, p->aScan[i].zName);
3650 }
3651 sqlite3DbFree(db, p->aScan);
dan6f9702e2014-11-01 20:38:06 +00003652 }
dan6f9702e2014-11-01 20:38:06 +00003653#endif
dand46def72010-07-24 11:28:28 +00003654}
3655
3656/*
drh9a324642003-09-06 20:12:01 +00003657** Delete an entire VDBE.
3658*/
danielk19774adee202004-05-08 08:23:19 +00003659void sqlite3VdbeDelete(Vdbe *p){
drh633e6d52008-07-28 19:34:53 +00003660 sqlite3 *db;
3661
drh9d9c41e2017-10-31 03:40:15 +00003662 assert( p!=0 );
drh633e6d52008-07-28 19:34:53 +00003663 db = p->db;
drh41ce47c2022-08-22 02:00:26 +00003664 assert( db!=0 );
drh4245c402012-06-02 14:32:21 +00003665 assert( sqlite3_mutex_held(db->mutex) );
drhcb103b92012-10-26 00:11:23 +00003666 sqlite3VdbeClearObject(db, p);
drh1c848632022-04-04 01:12:11 +00003667 if( db->pnBytesFreed==0 ){
drhe5928b12022-08-23 20:11:01 +00003668 assert( p->ppVPrev!=0 );
3669 *p->ppVPrev = p->pVNext;
3670 if( p->pVNext ){
3671 p->pVNext->ppVPrev = p->ppVPrev;
drh1c848632022-04-04 01:12:11 +00003672 }
drh9a324642003-09-06 20:12:01 +00003673 }
drh41ce47c2022-08-22 02:00:26 +00003674 sqlite3DbNNFreeNN(db, p);
drh9a324642003-09-06 20:12:01 +00003675}
drha11846b2004-01-07 18:52:56 +00003676
3677/*
drh6848dad2014-08-22 23:33:03 +00003678** The cursor "p" has a pending seek operation that has not yet been
3679** carried out. Seek the cursor now. If an error occurs, return
3680** the appropriate error code.
3681*/
drhbe3da242019-12-29 00:52:41 +00003682int SQLITE_NOINLINE sqlite3VdbeFinishMoveto(VdbeCursor *p){
drh6848dad2014-08-22 23:33:03 +00003683 int res, rc;
3684#ifdef SQLITE_TEST
3685 extern int sqlite3_search_count;
3686#endif
3687 assert( p->deferredMoveto );
3688 assert( p->isTable );
drhc960dcb2015-11-20 19:22:01 +00003689 assert( p->eCurType==CURTYPE_BTREE );
drh42a410d2021-06-19 18:32:20 +00003690 rc = sqlite3BtreeTableMoveto(p->uc.pCursor, p->movetoTarget, 0, &res);
drh6848dad2014-08-22 23:33:03 +00003691 if( rc ) return rc;
drh6848dad2014-08-22 23:33:03 +00003692 if( res!=0 ) return SQLITE_CORRUPT_BKPT;
drh6848dad2014-08-22 23:33:03 +00003693#ifdef SQLITE_TEST
3694 sqlite3_search_count++;
3695#endif
3696 p->deferredMoveto = 0;
3697 p->cacheStatus = CACHE_STALE;
3698 return SQLITE_OK;
3699}
3700
3701/*
3702** Something has moved cursor "p" out of place. Maybe the row it was
3703** pointed to was deleted out from under it. Or maybe the btree was
3704** rebalanced. Whatever the cause, try to restore "p" to the place it
peter.d.reid60ec9142014-09-06 16:39:46 +00003705** is supposed to be pointing. If the row was deleted out from under the
drh6848dad2014-08-22 23:33:03 +00003706** cursor, set the cursor to point to a NULL row.
3707*/
drhfc569502022-02-25 20:11:59 +00003708int SQLITE_NOINLINE sqlite3VdbeHandleMovedCursor(VdbeCursor *p){
drh6848dad2014-08-22 23:33:03 +00003709 int isDifferentRow, rc;
drhc960dcb2015-11-20 19:22:01 +00003710 assert( p->eCurType==CURTYPE_BTREE );
3711 assert( p->uc.pCursor!=0 );
3712 assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
3713 rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
drh6848dad2014-08-22 23:33:03 +00003714 p->cacheStatus = CACHE_STALE;
3715 if( isDifferentRow ) p->nullRow = 1;
3716 return rc;
3717}
3718
3719/*
drhc22284f2014-10-13 16:02:20 +00003720** Check to ensure that the cursor is valid. Restore the cursor
3721** if need be. Return any I/O error from the restore operation.
3722*/
3723int sqlite3VdbeCursorRestore(VdbeCursor *p){
drheab6c122022-04-14 12:59:25 +00003724 assert( p->eCurType==CURTYPE_BTREE || IsNullCursor(p) );
drhc960dcb2015-11-20 19:22:01 +00003725 if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
drhfc569502022-02-25 20:11:59 +00003726 return sqlite3VdbeHandleMovedCursor(p);
drha11846b2004-01-07 18:52:56 +00003727 }
3728 return SQLITE_OK;
3729}
danielk19774adee202004-05-08 08:23:19 +00003730
drhab9f7f12004-05-08 10:56:11 +00003731/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003732** The following functions:
danielk197790e4d952004-05-10 10:05:53 +00003733**
danielk1977cfcdaef2004-05-12 07:33:33 +00003734** sqlite3VdbeSerialType()
3735** sqlite3VdbeSerialTypeLen()
danielk197790e4d952004-05-10 10:05:53 +00003736** sqlite3VdbeSerialLen()
drhd859dc22022-04-02 14:30:58 +00003737** sqlite3VdbeSerialPut() <--- in-lined into OP_MakeRecord as of 2022-04-02
shane92003092008-07-31 01:43:13 +00003738** sqlite3VdbeSerialGet()
danielk197790e4d952004-05-10 10:05:53 +00003739**
3740** encapsulate the code that serializes values for storage in SQLite
danielk1977cfcdaef2004-05-12 07:33:33 +00003741** data and index records. Each serialized value consists of a
3742** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
3743** integer, stored as a varint.
danielk197790e4d952004-05-10 10:05:53 +00003744**
danielk1977cfcdaef2004-05-12 07:33:33 +00003745** In an SQLite index record, the serial type is stored directly before
3746** the blob of data that it corresponds to. In a table record, all serial
3747** types are stored at the start of the record, and the blobs of data at
3748** the end. Hence these functions allow the caller to handle the
mistachkin48864df2013-03-21 21:20:32 +00003749** serial-type and data blob separately.
danielk1977cfcdaef2004-05-12 07:33:33 +00003750**
3751** The following table describes the various storage classes for data:
3752**
3753** serial type bytes of data type
danielk197790e4d952004-05-10 10:05:53 +00003754** -------------- --------------- ---------------
drha19b7752004-05-30 21:14:58 +00003755** 0 0 NULL
danielk197790e4d952004-05-10 10:05:53 +00003756** 1 1 signed integer
3757** 2 2 signed integer
drha19b7752004-05-30 21:14:58 +00003758** 3 3 signed integer
3759** 4 4 signed integer
3760** 5 6 signed integer
3761** 6 8 signed integer
3762** 7 8 IEEE float
drhd946db02005-12-29 19:23:06 +00003763** 8 0 Integer constant 0
3764** 9 0 Integer constant 1
3765** 10,11 reserved for expansion
danielk197790e4d952004-05-10 10:05:53 +00003766** N>=12 and even (N-12)/2 BLOB
3767** N>=13 and odd (N-13)/2 text
3768**
drh35a59652006-01-02 18:24:40 +00003769** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
3770** of SQLite will not understand those serial types.
danielk197790e4d952004-05-10 10:05:53 +00003771*/
3772
drh175b8f02019-08-08 15:24:17 +00003773#if 0 /* Inlined into the OP_MakeRecord opcode */
danielk197790e4d952004-05-10 10:05:53 +00003774/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003775** Return the serial-type for the value stored in pMem.
drh6bab6f22019-05-09 17:10:30 +00003776**
3777** This routine might convert a large MEM_IntReal value into MEM_Real.
drhc1da4392019-07-11 19:22:36 +00003778**
3779** 2019-07-11: The primary user of this subroutine was the OP_MakeRecord
3780** opcode in the byte-code engine. But by moving this routine in-line, we
3781** can omit some redundant tests and make that opcode a lot faster. So
drh175b8f02019-08-08 15:24:17 +00003782** this routine is now only used by the STAT3 logic and STAT3 support has
3783** ended. The code is kept here for historical reference only.
danielk1977192ac1d2004-05-10 07:17:30 +00003784*/
drhbe37c122015-10-16 14:54:17 +00003785u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
danielk1977cfcdaef2004-05-12 07:33:33 +00003786 int flags = pMem->flags;
drheac5bd72014-07-25 21:35:39 +00003787 u32 n;
danielk1977cfcdaef2004-05-12 07:33:33 +00003788
drhbe37c122015-10-16 14:54:17 +00003789 assert( pLen!=0 );
danielk1977cfcdaef2004-05-12 07:33:33 +00003790 if( flags&MEM_Null ){
drhbe37c122015-10-16 14:54:17 +00003791 *pLen = 0;
drha19b7752004-05-30 21:14:58 +00003792 return 0;
danielk197790e4d952004-05-10 10:05:53 +00003793 }
drh169f0772019-05-02 21:36:26 +00003794 if( flags&(MEM_Int|MEM_IntReal) ){
drhfe2093d2005-01-20 22:48:47 +00003795 /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
drh5284a052008-05-08 15:18:10 +00003796# define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
drh3c024d62007-03-30 11:23:45 +00003797 i64 i = pMem->u.i;
drhd946db02005-12-29 19:23:06 +00003798 u64 u;
drh3242c692019-05-04 01:29:13 +00003799 testcase( flags & MEM_Int );
3800 testcase( flags & MEM_IntReal );
drhcfd654b2011-03-05 13:54:15 +00003801 if( i<0 ){
drh1b40e632014-11-20 02:58:10 +00003802 u = ~i;
drhcfd654b2011-03-05 13:54:15 +00003803 }else{
3804 u = i;
3805 }
drh56690b32012-09-17 15:36:31 +00003806 if( u<=127 ){
drhbe37c122015-10-16 14:54:17 +00003807 if( (i&1)==i && file_format>=4 ){
3808 *pLen = 0;
3809 return 8+(u32)u;
3810 }else{
3811 *pLen = 1;
3812 return 1;
3813 }
drh56690b32012-09-17 15:36:31 +00003814 }
drhbe37c122015-10-16 14:54:17 +00003815 if( u<=32767 ){ *pLen = 2; return 2; }
3816 if( u<=8388607 ){ *pLen = 3; return 3; }
3817 if( u<=2147483647 ){ *pLen = 4; return 4; }
3818 if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
3819 *pLen = 8;
drh6bab6f22019-05-09 17:10:30 +00003820 if( flags&MEM_IntReal ){
3821 /* If the value is IntReal and is going to take up 8 bytes to store
3822 ** as an integer, then we might as well make it an 8-byte floating
3823 ** point value */
3824 pMem->u.r = (double)pMem->u.i;
3825 pMem->flags &= ~MEM_IntReal;
3826 pMem->flags |= MEM_Real;
3827 return 7;
3828 }
drha19b7752004-05-30 21:14:58 +00003829 return 6;
danielk197790e4d952004-05-10 10:05:53 +00003830 }
danielk1977cfcdaef2004-05-12 07:33:33 +00003831 if( flags&MEM_Real ){
drhbe37c122015-10-16 14:54:17 +00003832 *pLen = 8;
drha19b7752004-05-30 21:14:58 +00003833 return 7;
danielk197790e4d952004-05-10 10:05:53 +00003834 }
danielk1977e4359752008-11-03 09:39:45 +00003835 assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
drheac5bd72014-07-25 21:35:39 +00003836 assert( pMem->n>=0 );
3837 n = (u32)pMem->n;
drhfdf972a2007-05-02 13:30:27 +00003838 if( flags & MEM_Zero ){
drh8df32842008-12-09 02:51:23 +00003839 n += pMem->u.nZero;
danielk197790e4d952004-05-10 10:05:53 +00003840 }
drhbe37c122015-10-16 14:54:17 +00003841 *pLen = n;
drhfdf972a2007-05-02 13:30:27 +00003842 return ((n*2) + 12 + ((flags&MEM_Str)!=0));
danielk1977192ac1d2004-05-10 07:17:30 +00003843}
drh175b8f02019-08-08 15:24:17 +00003844#endif /* inlined into OP_MakeRecord */
danielk1977192ac1d2004-05-10 07:17:30 +00003845
3846/*
drhfaf37272015-10-16 14:23:42 +00003847** The sizes for serial types less than 128
drhc5ef7152015-06-28 02:58:51 +00003848*/
drhd859dc22022-04-02 14:30:58 +00003849const u8 sqlite3SmallTypeSizes[128] = {
drhfaf37272015-10-16 14:23:42 +00003850 /* 0 1 2 3 4 5 6 7 8 9 */
3851/* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
3852/* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
3853/* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
3854/* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
3855/* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
3856/* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
3857/* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
3858/* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
3859/* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
3860/* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
3861/* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
3862/* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
3863/* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
drhc5ef7152015-06-28 02:58:51 +00003864};
3865
3866/*
danielk1977cfcdaef2004-05-12 07:33:33 +00003867** Return the length of the data corresponding to the supplied serial-type.
danielk1977192ac1d2004-05-10 07:17:30 +00003868*/
drh35cd6432009-06-05 14:17:21 +00003869u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
drhfaf37272015-10-16 14:23:42 +00003870 if( serial_type>=128 ){
drh51846b52004-05-28 16:00:21 +00003871 return (serial_type-12)/2;
3872 }else{
drhfaf37272015-10-16 14:23:42 +00003873 assert( serial_type<12
3874 || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
drhc5ef7152015-06-28 02:58:51 +00003875 return sqlite3SmallTypeSizes[serial_type];
drh51846b52004-05-28 16:00:21 +00003876 }
danielk1977192ac1d2004-05-10 07:17:30 +00003877}
drhfaf37272015-10-16 14:23:42 +00003878u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
3879 assert( serial_type<128 );
3880 return sqlite3SmallTypeSizes[serial_type];
3881}
danielk1977192ac1d2004-05-10 07:17:30 +00003882
3883/*
drh110daac2007-05-04 11:59:31 +00003884** If we are on an architecture with mixed-endian floating
drh7a4f5022007-05-23 07:20:08 +00003885** points (ex: ARM7) then swap the lower 4 bytes with the
drh110daac2007-05-04 11:59:31 +00003886** upper 4 bytes. Return the result.
3887**
drh7a4f5022007-05-23 07:20:08 +00003888** For most architectures, this is a no-op.
3889**
3890** (later): It is reported to me that the mixed-endian problem
3891** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
3892** that early versions of GCC stored the two words of a 64-bit
3893** float in the wrong order. And that error has been propagated
3894** ever since. The blame is not necessarily with GCC, though.
3895** GCC might have just copying the problem from a prior compiler.
3896** I am also told that newer versions of GCC that follow a different
3897** ABI get the byte order right.
3898**
3899** Developers using SQLite on an ARM7 should compile and run their
3900** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
3901** enabled, some asserts below will ensure that the byte order of
3902** floating point values is correct.
drh60d09a72007-08-30 15:05:08 +00003903**
3904** (2007-08-30) Frank van Vugt has studied this problem closely
3905** and has send his findings to the SQLite developers. Frank
3906** writes that some Linux kernels offer floating point hardware
3907** emulation that uses only 32-bit mantissas instead of a full
3908** 48-bits as required by the IEEE standard. (This is the
3909** CONFIG_FPE_FASTFPE option.) On such systems, floating point
3910** byte swapping becomes very complicated. To avoid problems,
3911** the necessary byte swapping is carried out using a 64-bit integer
3912** rather than a 64-bit float. Frank assures us that the code here
3913** works for him. We, the developers, have no way to independently
3914** verify this, but Frank seems to know what he is talking about
3915** so we trust him.
drh110daac2007-05-04 11:59:31 +00003916*/
3917#ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
drhd859dc22022-04-02 14:30:58 +00003918u64 sqlite3FloatSwap(u64 in){
drh110daac2007-05-04 11:59:31 +00003919 union {
drh60d09a72007-08-30 15:05:08 +00003920 u64 r;
drh110daac2007-05-04 11:59:31 +00003921 u32 i[2];
3922 } u;
3923 u32 t;
3924
3925 u.r = in;
3926 t = u.i[0];
3927 u.i[0] = u.i[1];
3928 u.i[1] = t;
3929 return u.r;
3930}
drhd859dc22022-04-02 14:30:58 +00003931#endif /* SQLITE_MIXED_ENDIAN_64BIT_FLOAT */
drh110daac2007-05-04 11:59:31 +00003932
danielk1977cfcdaef2004-05-12 07:33:33 +00003933
drhf926d1e2014-03-04 04:04:33 +00003934/* Input "x" is a sequence of unsigned characters that represent a
3935** big-endian integer. Return the equivalent native integer
3936*/
3937#define ONE_BYTE_INT(x) ((i8)(x)[0])
3938#define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
3939#define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
3940#define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drh8932bec2014-08-22 14:56:13 +00003941#define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
drhf926d1e2014-03-04 04:04:33 +00003942
danielk1977cfcdaef2004-05-12 07:33:33 +00003943/*
3944** Deserialize the data blob pointed to by buf as serial type serial_type
drh06164b22021-12-14 00:36:09 +00003945** and store the result in pMem.
drh14a924a2014-08-22 14:34:05 +00003946**
3947** This function is implemented as two separate routines for performance.
3948** The few cases that require local variables are broken out into a separate
3949** routine so that in most cases the overhead of moving the stack pointer
3950** is avoided.
danielk1977cfcdaef2004-05-12 07:33:33 +00003951*/
drh06164b22021-12-14 00:36:09 +00003952static void serialGet(
danielk197793d46752004-05-23 13:30:58 +00003953 const unsigned char *buf, /* Buffer to deserialize from */
drh25aa1b42004-05-28 01:39:01 +00003954 u32 serial_type, /* Serial type to deserialize */
3955 Mem *pMem /* Memory cell to write value into */
danielk1977b1bc9532004-05-22 03:05:33 +00003956){
drh8932bec2014-08-22 14:56:13 +00003957 u64 x = FOUR_BYTE_UINT(buf);
3958 u32 y = FOUR_BYTE_UINT(buf+4);
3959 x = (x<<32) + y;
drh14a924a2014-08-22 14:34:05 +00003960 if( serial_type==6 ){
drh654858d2014-11-20 02:18:14 +00003961 /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
3962 ** twos-complement integer. */
drh14a924a2014-08-22 14:34:05 +00003963 pMem->u.i = *(i64*)&x;
3964 pMem->flags = MEM_Int;
3965 testcase( pMem->u.i<0 );
3966 }else{
drh654858d2014-11-20 02:18:14 +00003967 /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
3968 ** floating point number. */
drh14a924a2014-08-22 14:34:05 +00003969#if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
3970 /* Verify that integers and floating point values use the same
3971 ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
3972 ** defined that 64-bit floating point values really are mixed
3973 ** endian.
3974 */
3975 static const u64 t1 = ((u64)0x3ff00000)<<32;
3976 static const double r1 = 1.0;
3977 u64 t2 = t1;
3978 swapMixedEndianFloat(t2);
3979 assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
3980#endif
drh74eaba42014-09-18 17:52:15 +00003981 assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
drh14a924a2014-08-22 14:34:05 +00003982 swapMixedEndianFloat(x);
drh74eaba42014-09-18 17:52:15 +00003983 memcpy(&pMem->u.r, &x, sizeof(x));
drh05921222019-05-30 00:46:37 +00003984 pMem->flags = IsNaN(x) ? MEM_Null : MEM_Real;
drh14a924a2014-08-22 14:34:05 +00003985 }
drh14a924a2014-08-22 14:34:05 +00003986}
drh06164b22021-12-14 00:36:09 +00003987void sqlite3VdbeSerialGet(
danielk1977b1bc9532004-05-22 03:05:33 +00003988 const unsigned char *buf, /* Buffer to deserialize from */
3989 u32 serial_type, /* Serial type to deserialize */
3990 Mem *pMem /* Memory cell to write value into */
3991){
drh3c685822005-05-21 18:32:18 +00003992 switch( serial_type ){
drhce2fbd12018-01-12 21:00:14 +00003993 case 10: { /* Internal use only: NULL with virtual table
3994 ** UPDATE no-change flag set */
3995 pMem->flags = MEM_Null|MEM_Zero;
drhcdb60972018-01-13 14:28:00 +00003996 pMem->n = 0;
3997 pMem->u.nZero = 0;
drh06164b22021-12-14 00:36:09 +00003998 return;
drhce2fbd12018-01-12 21:00:14 +00003999 }
drh3c685822005-05-21 18:32:18 +00004000 case 11: /* Reserved for future use */
drh654858d2014-11-20 02:18:14 +00004001 case 0: { /* Null */
4002 /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
drh3c685822005-05-21 18:32:18 +00004003 pMem->flags = MEM_Null;
drh06164b22021-12-14 00:36:09 +00004004 return;
drh3c685822005-05-21 18:32:18 +00004005 }
drh654858d2014-11-20 02:18:14 +00004006 case 1: {
4007 /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
4008 ** integer. */
drhf926d1e2014-03-04 04:04:33 +00004009 pMem->u.i = ONE_BYTE_INT(buf);
drh1483e142004-05-21 21:12:42 +00004010 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004011 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004012 return;
drh1483e142004-05-21 21:12:42 +00004013 }
drh3c685822005-05-21 18:32:18 +00004014 case 2: { /* 2-byte signed integer */
drh654858d2014-11-20 02:18:14 +00004015 /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
4016 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00004017 pMem->u.i = TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00004018 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004019 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004020 return;
drh3c685822005-05-21 18:32:18 +00004021 }
4022 case 3: { /* 3-byte signed integer */
drh654858d2014-11-20 02:18:14 +00004023 /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
4024 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00004025 pMem->u.i = THREE_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00004026 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004027 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004028 return;
drh3c685822005-05-21 18:32:18 +00004029 }
4030 case 4: { /* 4-byte signed integer */
drh654858d2014-11-20 02:18:14 +00004031 /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
4032 ** twos-complement integer. */
drh8932bec2014-08-22 14:56:13 +00004033 pMem->u.i = FOUR_BYTE_INT(buf);
drhc8bb4302015-11-06 17:28:00 +00004034#ifdef __HP_cc
4035 /* Work around a sign-extension bug in the HP compiler for HP/UX */
4036 if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
4037#endif
drh3c685822005-05-21 18:32:18 +00004038 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004039 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004040 return;
drh3c685822005-05-21 18:32:18 +00004041 }
4042 case 5: { /* 6-byte signed integer */
drh654858d2014-11-20 02:18:14 +00004043 /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
4044 ** twos-complement integer. */
drhf926d1e2014-03-04 04:04:33 +00004045 pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
drh3c685822005-05-21 18:32:18 +00004046 pMem->flags = MEM_Int;
drhb6e8fd12014-03-06 01:56:33 +00004047 testcase( pMem->u.i<0 );
drh06164b22021-12-14 00:36:09 +00004048 return;
drh3c685822005-05-21 18:32:18 +00004049 }
drh91124b32005-08-18 18:15:05 +00004050 case 6: /* 8-byte signed integer */
drh3c685822005-05-21 18:32:18 +00004051 case 7: { /* IEEE floating point */
drh8932bec2014-08-22 14:56:13 +00004052 /* These use local variables, so do them in a separate routine
4053 ** to avoid having to move the frame pointer in the common case */
drh06164b22021-12-14 00:36:09 +00004054 serialGet(buf,serial_type,pMem);
4055 return;
drh3c685822005-05-21 18:32:18 +00004056 }
drhd946db02005-12-29 19:23:06 +00004057 case 8: /* Integer 0 */
4058 case 9: { /* Integer 1 */
drh654858d2014-11-20 02:18:14 +00004059 /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
4060 /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
drh3c024d62007-03-30 11:23:45 +00004061 pMem->u.i = serial_type-8;
drhd946db02005-12-29 19:23:06 +00004062 pMem->flags = MEM_Int;
drh06164b22021-12-14 00:36:09 +00004063 return;
drhd946db02005-12-29 19:23:06 +00004064 }
drh3c685822005-05-21 18:32:18 +00004065 default: {
drh654858d2014-11-20 02:18:14 +00004066 /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
4067 ** length.
4068 ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
4069 ** (N-13)/2 bytes in length. */
drhc138daf2013-11-19 13:55:34 +00004070 static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
drh3c685822005-05-21 18:32:18 +00004071 pMem->z = (char *)buf;
drh14a924a2014-08-22 14:34:05 +00004072 pMem->n = (serial_type-12)/2;
drhc138daf2013-11-19 13:55:34 +00004073 pMem->flags = aFlag[serial_type&1];
drh06164b22021-12-14 00:36:09 +00004074 return;
drh696b32f2004-05-30 01:51:52 +00004075 }
danielk1977cfcdaef2004-05-12 07:33:33 +00004076 }
drh06164b22021-12-14 00:36:09 +00004077 return;
danielk1977192ac1d2004-05-10 07:17:30 +00004078}
drh1e968a02008-03-25 00:22:21 +00004079/*
dan03e9cfc2011-09-05 14:20:27 +00004080** This routine is used to allocate sufficient space for an UnpackedRecord
4081** structure large enough to be used with sqlite3VdbeRecordUnpack() if
4082** the first argument is a pointer to KeyInfo structure pKeyInfo.
drh1e968a02008-03-25 00:22:21 +00004083**
dan03e9cfc2011-09-05 14:20:27 +00004084** The space is either allocated using sqlite3DbMallocRaw() or from within
4085** the unaligned buffer passed via the second and third arguments (presumably
4086** stack space). If the former, then *ppFree is set to a pointer that should
4087** be eventually freed by the caller using sqlite3DbFree(). Or, if the
4088** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
4089** before returning.
drh1e968a02008-03-25 00:22:21 +00004090**
dan03e9cfc2011-09-05 14:20:27 +00004091** If an OOM error occurs, NULL is returned.
4092*/
4093UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
drha582b012016-12-21 19:45:54 +00004094 KeyInfo *pKeyInfo /* Description of the record */
drh1e968a02008-03-25 00:22:21 +00004095){
dan03e9cfc2011-09-05 14:20:27 +00004096 UnpackedRecord *p; /* Unpacked record to return */
dan03e9cfc2011-09-05 14:20:27 +00004097 int nByte; /* Number of bytes required for *p */
drhcf6e3fd2022-04-01 18:45:11 +00004098 nByte = ROUND8P(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nKeyField+1);
drha582b012016-12-21 19:45:54 +00004099 p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
4100 if( !p ) return 0;
drhcf6e3fd2022-04-01 18:45:11 +00004101 p->aMem = (Mem*)&((char*)p)[ROUND8P(sizeof(UnpackedRecord))];
dan6e118922019-08-12 16:36:38 +00004102 assert( pKeyInfo->aSortFlags!=0 );
drh1e968a02008-03-25 00:22:21 +00004103 p->pKeyInfo = pKeyInfo;
drha485ad12017-08-02 22:43:14 +00004104 p->nField = pKeyInfo->nKeyField + 1;
dan03e9cfc2011-09-05 14:20:27 +00004105 return p;
4106}
4107
4108/*
4109** Given the nKey-byte encoding of a record in pKey[], populate the
4110** UnpackedRecord structure indicated by the fourth argument with the
4111** contents of the decoded record.
4112*/
4113void sqlite3VdbeRecordUnpack(
4114 KeyInfo *pKeyInfo, /* Information about the record format */
4115 int nKey, /* Size of the binary record */
4116 const void *pKey, /* The binary record */
4117 UnpackedRecord *p /* Populate this structure before returning. */
4118){
4119 const unsigned char *aKey = (const unsigned char *)pKey;
drh936ade42019-01-24 14:16:20 +00004120 u32 d;
dan03e9cfc2011-09-05 14:20:27 +00004121 u32 idx; /* Offset in aKey[] to read from */
4122 u16 u; /* Unsigned loop counter */
4123 u32 szHdr;
dan42acb3e2011-09-05 20:16:38 +00004124 Mem *pMem = p->aMem;
dan03e9cfc2011-09-05 14:20:27 +00004125
dan1fed5da2014-02-25 21:01:25 +00004126 p->default_rc = 0;
drh8c5d1522009-04-10 00:56:28 +00004127 assert( EIGHT_BYTE_ALIGNMENT(pMem) );
shane3f8d5cf2008-04-24 19:15:09 +00004128 idx = getVarint32(aKey, szHdr);
drh1e968a02008-03-25 00:22:21 +00004129 d = szHdr;
shane0b8d2762008-07-22 05:18:00 +00004130 u = 0;
drhf69af052019-01-25 18:17:37 +00004131 while( idx<szHdr && d<=(u32)nKey ){
drh1e968a02008-03-25 00:22:21 +00004132 u32 serial_type;
4133
danielk197700e13612008-11-17 19:18:54 +00004134 idx += getVarint32(&aKey[idx], serial_type);
drh1e968a02008-03-25 00:22:21 +00004135 pMem->enc = pKeyInfo->enc;
4136 pMem->db = pKeyInfo->db;
drhc3f1d5f2011-05-30 23:42:16 +00004137 /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
drh17bcb102014-09-18 21:25:33 +00004138 pMem->szMalloc = 0;
drh304637c2011-03-18 16:47:27 +00004139 pMem->z = 0;
drh06164b22021-12-14 00:36:09 +00004140 sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
4141 d += sqlite3VdbeSerialTypeLen(serial_type);
drhe14006d2008-03-25 17:23:32 +00004142 pMem++;
drh7f4b19f2014-09-16 13:30:05 +00004143 if( (++u)>=p->nField ) break;
drh1e968a02008-03-25 00:22:21 +00004144 }
drhf69af052019-01-25 18:17:37 +00004145 if( d>(u32)nKey && u ){
drh4067ce72019-01-14 13:32:15 +00004146 assert( CORRUPT_DB );
4147 /* In a corrupt record entry, the last pMem might have been set up using
4148 ** uninitialized memory. Overwrite its value with NULL, to prevent
4149 ** warnings from MSAN. */
4150 sqlite3VdbeMemSetNull(pMem-1);
4151 }
drha485ad12017-08-02 22:43:14 +00004152 assert( u<=pKeyInfo->nKeyField + 1 );
shane0b8d2762008-07-22 05:18:00 +00004153 p->nField = u;
drh1e968a02008-03-25 00:22:21 +00004154}
4155
drhd879e3e2017-02-13 13:35:55 +00004156#ifdef SQLITE_DEBUG
drh1e968a02008-03-25 00:22:21 +00004157/*
dan3833e932014-03-01 19:44:56 +00004158** This function compares two index or table record keys in the same way
4159** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
4160** this function deserializes and compares values using the
4161** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
4162** in assert() statements to ensure that the optimized code in
4163** sqlite3VdbeRecordCompare() returns results with these two primitives.
drh79211e12014-05-02 17:33:16 +00004164**
4165** Return true if the result of comparison is equivalent to desiredResult.
4166** Return false if there is a disagreement.
drh1e968a02008-03-25 00:22:21 +00004167*/
dan3833e932014-03-01 19:44:56 +00004168static int vdbeRecordCompareDebug(
drhec1fc802008-08-13 14:07:40 +00004169 int nKey1, const void *pKey1, /* Left key */
drh79211e12014-05-02 17:33:16 +00004170 const UnpackedRecord *pPKey2, /* Right key */
4171 int desiredResult /* Correct answer */
drh1e968a02008-03-25 00:22:21 +00004172){
drhdf003d62013-08-01 19:17:39 +00004173 u32 d1; /* Offset into aKey[] of next data element */
drh1e968a02008-03-25 00:22:21 +00004174 u32 idx1; /* Offset into aKey[] of next header element */
4175 u32 szHdr1; /* Number of bytes in header */
4176 int i = 0;
drh1e968a02008-03-25 00:22:21 +00004177 int rc = 0;
4178 const unsigned char *aKey1 = (const unsigned char *)pKey1;
4179 KeyInfo *pKeyInfo;
4180 Mem mem1;
4181
4182 pKeyInfo = pPKey2->pKeyInfo;
drh84de6902014-05-02 18:46:52 +00004183 if( pKeyInfo->db==0 ) return 1;
drh1e968a02008-03-25 00:22:21 +00004184 mem1.enc = pKeyInfo->enc;
drh37272632009-11-16 21:28:45 +00004185 mem1.db = pKeyInfo->db;
drhd93a8b22009-11-16 03:13:40 +00004186 /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
drh17bcb102014-09-18 21:25:33 +00004187 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drh8b249a82009-11-16 02:14:00 +00004188
4189 /* Compilers may complain that mem1.u.i is potentially uninitialized.
4190 ** We could initialize it, as shown here, to silence those complaints.
drh5275d2e2011-04-27 01:00:17 +00004191 ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
drh8b249a82009-11-16 02:14:00 +00004192 ** the unnecessary initialization has a measurable negative performance
4193 ** impact, since this routine is a very high runner. And so, we choose
4194 ** to ignore the compiler warnings and leave this variable uninitialized.
4195 */
4196 /* mem1.u.i = 0; // not needed, here to silence compiler warning */
drh1e968a02008-03-25 00:22:21 +00004197
shane3f8d5cf2008-04-24 19:15:09 +00004198 idx1 = getVarint32(aKey1, szHdr1);
drh46981362015-07-08 12:25:38 +00004199 if( szHdr1>98307 ) return SQLITE_CORRUPT;
drh1e968a02008-03-25 00:22:21 +00004200 d1 = szHdr1;
drha485ad12017-08-02 22:43:14 +00004201 assert( pKeyInfo->nAllField>=pPKey2->nField || CORRUPT_DB );
dan6e118922019-08-12 16:36:38 +00004202 assert( pKeyInfo->aSortFlags!=0 );
drha485ad12017-08-02 22:43:14 +00004203 assert( pKeyInfo->nKeyField>0 );
dan89bc0212013-12-03 09:49:52 +00004204 assert( idx1<=szHdr1 || CORRUPT_DB );
drh0b9dada2013-11-25 22:24:36 +00004205 do{
drh1e968a02008-03-25 00:22:21 +00004206 u32 serial_type1;
4207
4208 /* Read the serial types for the next element in each key. */
shane3f8d5cf2008-04-24 19:15:09 +00004209 idx1 += getVarint32( aKey1+idx1, serial_type1 );
drhaf5b2af2013-08-05 15:32:09 +00004210
4211 /* Verify that there is enough key space remaining to avoid
4212 ** a buffer overread. The "d1+serial_type1+2" subexpression will
4213 ** always be greater than or equal to the amount of required key space.
4214 ** Use that approximation to avoid the more expensive call to
4215 ** sqlite3VdbeSerialTypeLen() in the common case.
4216 */
drha79bcf32019-01-12 21:30:26 +00004217 if( d1+(u64)serial_type1+2>(u64)nKey1
4218 && d1+(u64)sqlite3VdbeSerialTypeLen(serial_type1)>(u64)nKey1
drhaf5b2af2013-08-05 15:32:09 +00004219 ){
4220 break;
4221 }
drh1e968a02008-03-25 00:22:21 +00004222
4223 /* Extract the values to be compared.
4224 */
drh06164b22021-12-14 00:36:09 +00004225 sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
4226 d1 += sqlite3VdbeSerialTypeLen(serial_type1);
drh1e968a02008-03-25 00:22:21 +00004227
4228 /* Do the comparison
4229 */
drh9b133652019-01-22 02:34:35 +00004230 rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i],
4231 pKeyInfo->nAllField>i ? pKeyInfo->aColl[i] : 0);
drh1e968a02008-03-25 00:22:21 +00004232 if( rc!=0 ){
drh17bcb102014-09-18 21:25:33 +00004233 assert( mem1.szMalloc==0 ); /* See comment below */
dan6e118922019-08-12 16:36:38 +00004234 if( (pKeyInfo->aSortFlags[i] & KEYINFO_ORDER_BIGNULL)
4235 && ((mem1.flags & MEM_Null) || (pPKey2->aMem[i].flags & MEM_Null))
4236 ){
4237 rc = -rc;
4238 }
4239 if( pKeyInfo->aSortFlags[i] & KEYINFO_ORDER_DESC ){
drh6f225d02013-10-26 13:36:51 +00004240 rc = -rc; /* Invert the result for DESC sort order. */
drh8b249a82009-11-16 02:14:00 +00004241 }
drh79211e12014-05-02 17:33:16 +00004242 goto debugCompareEnd;
drh1e968a02008-03-25 00:22:21 +00004243 }
4244 i++;
drh0b9dada2013-11-25 22:24:36 +00004245 }while( idx1<szHdr1 && i<pPKey2->nField );
drh407414c2009-07-14 14:15:27 +00004246
drh8b249a82009-11-16 02:14:00 +00004247 /* No memory allocation is ever used on mem1. Prove this using
4248 ** the following assert(). If the assert() fails, it indicates a
4249 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
danielk1977de630352009-05-04 11:42:29 +00004250 */
drh17bcb102014-09-18 21:25:33 +00004251 assert( mem1.szMalloc==0 );
danielk1977de630352009-05-04 11:42:29 +00004252
drh8b249a82009-11-16 02:14:00 +00004253 /* rc==0 here means that one of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004254 ** all the fields up to that point were equal. Return the default_rc
dan3b9330f2014-02-27 20:44:18 +00004255 ** value. */
drh79211e12014-05-02 17:33:16 +00004256 rc = pPKey2->default_rc;
4257
4258debugCompareEnd:
4259 if( desiredResult==0 && rc==0 ) return 1;
4260 if( desiredResult<0 && rc<0 ) return 1;
4261 if( desiredResult>0 && rc>0 ) return 1;
4262 if( CORRUPT_DB ) return 1;
4263 if( pKeyInfo->db->mallocFailed ) return 1;
4264 return 0;
dan1fed5da2014-02-25 21:01:25 +00004265}
dan3833e932014-03-01 19:44:56 +00004266#endif
dan1fed5da2014-02-25 21:01:25 +00004267
drhd879e3e2017-02-13 13:35:55 +00004268#ifdef SQLITE_DEBUG
drhe1bb8022015-01-19 19:48:52 +00004269/*
4270** Count the number of fields (a.k.a. columns) in the record given by
4271** pKey,nKey. The verify that this count is less than or equal to the
drha485ad12017-08-02 22:43:14 +00004272** limit given by pKeyInfo->nAllField.
drhe1bb8022015-01-19 19:48:52 +00004273**
4274** If this constraint is not satisfied, it means that the high-speed
4275** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
4276** not work correctly. If this assert() ever fires, it probably means
drha485ad12017-08-02 22:43:14 +00004277** that the KeyInfo.nKeyField or KeyInfo.nAllField values were computed
drhe1bb8022015-01-19 19:48:52 +00004278** incorrectly.
4279*/
4280static void vdbeAssertFieldCountWithinLimits(
4281 int nKey, const void *pKey, /* The record to verify */
4282 const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
4283){
4284 int nField = 0;
4285 u32 szHdr;
4286 u32 idx;
4287 u32 notUsed;
4288 const unsigned char *aKey = (const unsigned char*)pKey;
4289
4290 if( CORRUPT_DB ) return;
4291 idx = getVarint32(aKey, szHdr);
mistachkin1b3ee492015-01-21 00:51:08 +00004292 assert( nKey>=0 );
4293 assert( szHdr<=(u32)nKey );
drhe1bb8022015-01-19 19:48:52 +00004294 while( idx<szHdr ){
4295 idx += getVarint32(aKey+idx, notUsed);
4296 nField++;
4297 }
drha485ad12017-08-02 22:43:14 +00004298 assert( nField <= pKeyInfo->nAllField );
drhe1bb8022015-01-19 19:48:52 +00004299}
drh1af3c642015-01-19 20:57:19 +00004300#else
4301# define vdbeAssertFieldCountWithinLimits(A,B,C)
drhe1bb8022015-01-19 19:48:52 +00004302#endif
4303
dan3833e932014-03-01 19:44:56 +00004304/*
4305** Both *pMem1 and *pMem2 contain string values. Compare the two values
4306** using the collation sequence pColl. As usual, return a negative , zero
4307** or positive value if *pMem1 is less than, equal to or greater than
4308** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
4309*/
dan1fed5da2014-02-25 21:01:25 +00004310static int vdbeCompareMemString(
dan3833e932014-03-01 19:44:56 +00004311 const Mem *pMem1,
4312 const Mem *pMem2,
dan38fdead2014-04-01 10:19:02 +00004313 const CollSeq *pColl,
4314 u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
dan1fed5da2014-02-25 21:01:25 +00004315){
4316 if( pMem1->enc==pColl->enc ){
4317 /* The strings are already in the correct encoding. Call the
4318 ** comparison function directly */
4319 return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
4320 }else{
4321 int rc;
4322 const void *v1, *v2;
dan1fed5da2014-02-25 21:01:25 +00004323 Mem c1;
4324 Mem c2;
drh17bcb102014-09-18 21:25:33 +00004325 sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
4326 sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
dan1fed5da2014-02-25 21:01:25 +00004327 sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
4328 sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
4329 v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
dan1fed5da2014-02-25 21:01:25 +00004330 v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
dan21766c02017-05-22 08:04:09 +00004331 if( (v1==0 || v2==0) ){
4332 if( prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
4333 rc = 0;
4334 }else{
4335 rc = pColl->xCmp(pColl->pUser, c1.n, v1, c2.n, v2);
4336 }
drhfc854502022-03-02 17:50:59 +00004337 sqlite3VdbeMemReleaseMalloc(&c1);
4338 sqlite3VdbeMemReleaseMalloc(&c2);
dan1fed5da2014-02-25 21:01:25 +00004339 return rc;
4340 }
4341}
4342
4343/*
drh64caee42016-09-09 19:33:00 +00004344** The input pBlob is guaranteed to be a Blob that is not marked
4345** with MEM_Zero. Return true if it could be a zero-blob.
4346*/
drh8aaf7bc2016-09-20 01:19:18 +00004347static int isAllZero(const char *z, int n){
drh64caee42016-09-09 19:33:00 +00004348 int i;
drh8aaf7bc2016-09-20 01:19:18 +00004349 for(i=0; i<n; i++){
4350 if( z[i] ) return 0;
4351 }
4352 return 1;
drh64caee42016-09-09 19:33:00 +00004353}
4354
4355/*
drh982ff722014-09-16 03:24:43 +00004356** Compare two blobs. Return negative, zero, or positive if the first
4357** is less than, equal to, or greater than the second, respectively.
4358** If one blob is a prefix of the other, then the shorter is the lessor.
4359*/
drh8d7b2122018-06-11 13:10:45 +00004360SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
drh64caee42016-09-09 19:33:00 +00004361 int c;
4362 int n1 = pB1->n;
4363 int n2 = pB2->n;
4364
4365 /* It is possible to have a Blob value that has some non-zero content
4366 ** followed by zero content. But that only comes up for Blobs formed
4367 ** by the OP_MakeRecord opcode, and such Blobs never get passed into
4368 ** sqlite3MemCompare(). */
4369 assert( (pB1->flags & MEM_Zero)==0 || n1==0 );
4370 assert( (pB2->flags & MEM_Zero)==0 || n2==0 );
4371
4372 if( (pB1->flags|pB2->flags) & MEM_Zero ){
4373 if( pB1->flags & pB2->flags & MEM_Zero ){
4374 return pB1->u.nZero - pB2->u.nZero;
4375 }else if( pB1->flags & MEM_Zero ){
drh8aaf7bc2016-09-20 01:19:18 +00004376 if( !isAllZero(pB2->z, pB2->n) ) return -1;
drh64caee42016-09-09 19:33:00 +00004377 return pB1->u.nZero - n2;
4378 }else{
drh8aaf7bc2016-09-20 01:19:18 +00004379 if( !isAllZero(pB1->z, pB1->n) ) return +1;
drh64caee42016-09-09 19:33:00 +00004380 return n1 - pB2->u.nZero;
4381 }
4382 }
4383 c = memcmp(pB1->z, pB2->z, n1>n2 ? n2 : n1);
drh982ff722014-09-16 03:24:43 +00004384 if( c ) return c;
drh64caee42016-09-09 19:33:00 +00004385 return n1 - n2;
drh982ff722014-09-16 03:24:43 +00004386}
4387
drh2ab410a2015-11-06 14:59:07 +00004388/*
4389** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
4390** number. Return negative, zero, or positive if the first (i64) is less than,
4391** equal to, or greater than the second (double).
4392*/
drhde324612021-07-19 20:52:31 +00004393int sqlite3IntFloatCompare(i64 i, double r){
drh2ab410a2015-11-06 14:59:07 +00004394 if( sizeof(LONGDOUBLE_TYPE)>8 ){
4395 LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
drhde9873b2020-11-23 21:05:29 +00004396 testcase( x<r );
4397 testcase( x>r );
4398 testcase( x==r );
drh2ab410a2015-11-06 14:59:07 +00004399 if( x<r ) return -1;
drhde9873b2020-11-23 21:05:29 +00004400 if( x>r ) return +1; /*NO_TEST*/ /* work around bugs in gcov */
4401 return 0; /*NO_TEST*/ /* work around bugs in gcov */
drh2ab410a2015-11-06 14:59:07 +00004402 }else{
4403 i64 y;
4404 double s;
4405 if( r<-9223372036854775808.0 ) return +1;
drh6c319e12018-05-18 13:39:00 +00004406 if( r>=9223372036854775808.0 ) return -1;
drh2ab410a2015-11-06 14:59:07 +00004407 y = (i64)r;
4408 if( i<y ) return -1;
drh6c319e12018-05-18 13:39:00 +00004409 if( i>y ) return +1;
drh2ab410a2015-11-06 14:59:07 +00004410 s = (double)i;
4411 if( s<r ) return -1;
drh8d1751b2018-05-18 14:19:35 +00004412 if( s>r ) return +1;
drh2ab410a2015-11-06 14:59:07 +00004413 return 0;
4414 }
4415}
drh982ff722014-09-16 03:24:43 +00004416
4417/*
dan1fed5da2014-02-25 21:01:25 +00004418** Compare the values contained by the two memory cells, returning
4419** negative, zero or positive if pMem1 is less than, equal to, or greater
4420** than pMem2. Sorting order is NULL's first, followed by numbers (integers
4421** and reals) sorted numerically, followed by text ordered by the collating
4422** sequence pColl and finally blob's ordered by memcmp().
4423**
4424** Two NULL values are considered equal by this function.
4425*/
4426int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
dan1fed5da2014-02-25 21:01:25 +00004427 int f1, f2;
4428 int combined_flags;
4429
4430 f1 = pMem1->flags;
4431 f2 = pMem2->flags;
4432 combined_flags = f1|f2;
drh9d67afc2018-08-29 20:24:03 +00004433 assert( !sqlite3VdbeMemIsRowSet(pMem1) && !sqlite3VdbeMemIsRowSet(pMem2) );
dan1fed5da2014-02-25 21:01:25 +00004434
4435 /* If one value is NULL, it is less than the other. If both values
4436 ** are NULL, return 0.
drh8b249a82009-11-16 02:14:00 +00004437 */
dan1fed5da2014-02-25 21:01:25 +00004438 if( combined_flags&MEM_Null ){
4439 return (f2&MEM_Null) - (f1&MEM_Null);
4440 }
4441
drh2ab410a2015-11-06 14:59:07 +00004442 /* At least one of the two values is a number
dan1fed5da2014-02-25 21:01:25 +00004443 */
drh169f0772019-05-02 21:36:26 +00004444 if( combined_flags&(MEM_Int|MEM_Real|MEM_IntReal) ){
drh3242c692019-05-04 01:29:13 +00004445 testcase( combined_flags & MEM_Int );
4446 testcase( combined_flags & MEM_Real );
4447 testcase( combined_flags & MEM_IntReal );
drh169f0772019-05-02 21:36:26 +00004448 if( (f1 & f2 & (MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004449 testcase( f1 & f2 & MEM_Int );
4450 testcase( f1 & f2 & MEM_IntReal );
dan1fed5da2014-02-25 21:01:25 +00004451 if( pMem1->u.i < pMem2->u.i ) return -1;
drh2ab410a2015-11-06 14:59:07 +00004452 if( pMem1->u.i > pMem2->u.i ) return +1;
dan1fed5da2014-02-25 21:01:25 +00004453 return 0;
4454 }
drh2ab410a2015-11-06 14:59:07 +00004455 if( (f1 & f2 & MEM_Real)!=0 ){
4456 if( pMem1->u.r < pMem2->u.r ) return -1;
4457 if( pMem1->u.r > pMem2->u.r ) return +1;
4458 return 0;
4459 }
drh169f0772019-05-02 21:36:26 +00004460 if( (f1&(MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004461 testcase( f1 & MEM_Int );
4462 testcase( f1 & MEM_IntReal );
drh2ab410a2015-11-06 14:59:07 +00004463 if( (f2&MEM_Real)!=0 ){
4464 return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
drh169f0772019-05-02 21:36:26 +00004465 }else if( (f2&(MEM_Int|MEM_IntReal))!=0 ){
4466 if( pMem1->u.i < pMem2->u.i ) return -1;
4467 if( pMem1->u.i > pMem2->u.i ) return +1;
4468 return 0;
drh2ab410a2015-11-06 14:59:07 +00004469 }else{
4470 return -1;
4471 }
4472 }
dan1fed5da2014-02-25 21:01:25 +00004473 if( (f1&MEM_Real)!=0 ){
drh169f0772019-05-02 21:36:26 +00004474 if( (f2&(MEM_Int|MEM_IntReal))!=0 ){
drh3242c692019-05-04 01:29:13 +00004475 testcase( f2 & MEM_Int );
4476 testcase( f2 & MEM_IntReal );
drh2ab410a2015-11-06 14:59:07 +00004477 return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
4478 }else{
4479 return -1;
4480 }
dan1fed5da2014-02-25 21:01:25 +00004481 }
drh2ab410a2015-11-06 14:59:07 +00004482 return +1;
dan1fed5da2014-02-25 21:01:25 +00004483 }
4484
4485 /* If one value is a string and the other is a blob, the string is less.
4486 ** If both are strings, compare using the collating functions.
4487 */
4488 if( combined_flags&MEM_Str ){
4489 if( (f1 & MEM_Str)==0 ){
4490 return 1;
4491 }
4492 if( (f2 & MEM_Str)==0 ){
4493 return -1;
4494 }
4495
drhe5520e22015-12-31 04:34:26 +00004496 assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
dan1fed5da2014-02-25 21:01:25 +00004497 assert( pMem1->enc==SQLITE_UTF8 ||
4498 pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
4499
4500 /* The collation sequence must be defined at this point, even if
4501 ** the user deletes the collation sequence after the vdbe program is
4502 ** compiled (this was not always the case).
4503 */
4504 assert( !pColl || pColl->xCmp );
4505
4506 if( pColl ){
dan38fdead2014-04-01 10:19:02 +00004507 return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
dan1fed5da2014-02-25 21:01:25 +00004508 }
4509 /* If a NULL pointer was passed as the collate function, fall through
4510 ** to the blob case and use memcmp(). */
4511 }
4512
4513 /* Both values must be blobs. Compare using memcmp(). */
drh982ff722014-09-16 03:24:43 +00004514 return sqlite3BlobCompare(pMem1, pMem2);
drh1e968a02008-03-25 00:22:21 +00004515}
dan1fed5da2014-02-25 21:01:25 +00004516
4517
dan3833e932014-03-01 19:44:56 +00004518/*
4519** The first argument passed to this function is a serial-type that
4520** corresponds to an integer - all values between 1 and 9 inclusive
4521** except 7. The second points to a buffer containing an integer value
4522** serialized according to serial_type. This function deserializes
4523** and returns the value.
4524*/
dan3b9330f2014-02-27 20:44:18 +00004525static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
drhf926d1e2014-03-04 04:04:33 +00004526 u32 y;
dan3833e932014-03-01 19:44:56 +00004527 assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
dan3b9330f2014-02-27 20:44:18 +00004528 switch( serial_type ){
dan3833e932014-03-01 19:44:56 +00004529 case 0:
dan3b9330f2014-02-27 20:44:18 +00004530 case 1:
drhb6e8fd12014-03-06 01:56:33 +00004531 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004532 return ONE_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00004533 case 2:
drhb6e8fd12014-03-06 01:56:33 +00004534 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004535 return TWO_BYTE_INT(aKey);
dan3b9330f2014-02-27 20:44:18 +00004536 case 3:
drhb6e8fd12014-03-06 01:56:33 +00004537 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004538 return THREE_BYTE_INT(aKey);
4539 case 4: {
drhb6e8fd12014-03-06 01:56:33 +00004540 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004541 y = FOUR_BYTE_UINT(aKey);
4542 return (i64)*(int*)&y;
4543 }
dan3b9330f2014-02-27 20:44:18 +00004544 case 5: {
drhb6e8fd12014-03-06 01:56:33 +00004545 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004546 return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drh0660e262006-10-27 14:06:57 +00004547 }
dan3b9330f2014-02-27 20:44:18 +00004548 case 6: {
drhf926d1e2014-03-04 04:04:33 +00004549 u64 x = FOUR_BYTE_UINT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004550 testcase( aKey[0]&0x80 );
drhf926d1e2014-03-04 04:04:33 +00004551 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4552 return (i64)*(i64*)&x;
danielk19779a96b662007-11-29 17:05:18 +00004553 }
dan3b9330f2014-02-27 20:44:18 +00004554 }
danielk19779a96b662007-11-29 17:05:18 +00004555
dan3b9330f2014-02-27 20:44:18 +00004556 return (serial_type - 8);
danielk1977eb015e02004-05-18 01:31:14 +00004557}
danielk1977eb015e02004-05-18 01:31:14 +00004558
dan3833e932014-03-01 19:44:56 +00004559/*
4560** This function compares the two table rows or index records
4561** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
4562** or positive integer if key1 is less than, equal to or
4563** greater than key2. The {nKey1, pKey1} key must be a blob
peter.d.reid60ec9142014-09-06 16:39:46 +00004564** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
dan3833e932014-03-01 19:44:56 +00004565** key must be a parsed key such as obtained from
4566** sqlite3VdbeParseRecord.
4567**
4568** If argument bSkip is non-zero, it is assumed that the caller has already
4569** determined that the first fields of the keys are equal.
4570**
4571** Key1 and Key2 do not have to contain the same number of fields. If all
4572** fields that appear in both keys are equal, then pPKey2->default_rc is
4573** returned.
drha1f7c0a2014-03-28 03:12:48 +00004574**
dan38fdead2014-04-01 10:19:02 +00004575** If database corruption is discovered, set pPKey2->errCode to
4576** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
4577** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
4578** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
dan3833e932014-03-01 19:44:56 +00004579*/
dan7004f3f2015-03-30 12:06:26 +00004580int sqlite3VdbeRecordCompareWithSkip(
dan3833e932014-03-01 19:44:56 +00004581 int nKey1, const void *pKey1, /* Left key */
drha1f7c0a2014-03-28 03:12:48 +00004582 UnpackedRecord *pPKey2, /* Right key */
dan3833e932014-03-01 19:44:56 +00004583 int bSkip /* If true, skip the first field */
dan1fed5da2014-02-25 21:01:25 +00004584){
dan3833e932014-03-01 19:44:56 +00004585 u32 d1; /* Offset into aKey[] of next data element */
4586 int i; /* Index of next field to compare */
mistachkinffe6bc22014-03-04 11:16:20 +00004587 u32 szHdr1; /* Size of record header in bytes */
dan3833e932014-03-01 19:44:56 +00004588 u32 idx1; /* Offset of first type in header */
4589 int rc = 0; /* Return value */
4590 Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
drh6eb34802018-06-06 20:55:10 +00004591 KeyInfo *pKeyInfo;
dan1fed5da2014-02-25 21:01:25 +00004592 const unsigned char *aKey1 = (const unsigned char *)pKey1;
4593 Mem mem1;
4594
dan3833e932014-03-01 19:44:56 +00004595 /* If bSkip is true, then the caller has already determined that the first
4596 ** two elements in the keys are equal. Fix the various stack variables so
dan3b9330f2014-02-27 20:44:18 +00004597 ** that this routine begins comparing at the second field. */
dan3833e932014-03-01 19:44:56 +00004598 if( bSkip ){
drhc2808f32022-04-02 22:47:47 +00004599 u32 s1 = aKey1[1];
4600 if( s1<0x80 ){
4601 idx1 = 2;
4602 }else{
4603 idx1 = 1 + sqlite3GetVarint32(&aKey1[1], &s1);
4604 }
dan3833e932014-03-01 19:44:56 +00004605 szHdr1 = aKey1[0];
4606 d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
dan3b9330f2014-02-27 20:44:18 +00004607 i = 1;
4608 pRhs++;
dan3833e932014-03-01 19:44:56 +00004609 }else{
drhc2808f32022-04-02 22:47:47 +00004610 if( (szHdr1 = aKey1[0])<0x80 ){
4611 idx1 = 1;
4612 }else{
4613 idx1 = sqlite3GetVarint32(aKey1, &szHdr1);
4614 }
dan3833e932014-03-01 19:44:56 +00004615 d1 = szHdr1;
4616 i = 0;
dan3b9330f2014-02-27 20:44:18 +00004617 }
drh2a58dbd2019-01-11 16:44:16 +00004618 if( d1>(unsigned)nKey1 ){
4619 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
4620 return 0; /* Corruption */
4621 }
dan3b9330f2014-02-27 20:44:18 +00004622
drh17bcb102014-09-18 21:25:33 +00004623 VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
drha485ad12017-08-02 22:43:14 +00004624 assert( pPKey2->pKeyInfo->nAllField>=pPKey2->nField
dan1fed5da2014-02-25 21:01:25 +00004625 || CORRUPT_DB );
dan6e118922019-08-12 16:36:38 +00004626 assert( pPKey2->pKeyInfo->aSortFlags!=0 );
drha485ad12017-08-02 22:43:14 +00004627 assert( pPKey2->pKeyInfo->nKeyField>0 );
dan1fed5da2014-02-25 21:01:25 +00004628 assert( idx1<=szHdr1 || CORRUPT_DB );
drh093677a2022-11-04 11:54:42 +00004629 while( 1 /*exit-by-break*/ ){
dan1fed5da2014-02-25 21:01:25 +00004630 u32 serial_type;
4631
4632 /* RHS is an integer */
drh169f0772019-05-02 21:36:26 +00004633 if( pRhs->flags & (MEM_Int|MEM_IntReal) ){
drh3242c692019-05-04 01:29:13 +00004634 testcase( pRhs->flags & MEM_Int );
4635 testcase( pRhs->flags & MEM_IntReal );
dan1fed5da2014-02-25 21:01:25 +00004636 serial_type = aKey1[idx1];
drhb6e8fd12014-03-06 01:56:33 +00004637 testcase( serial_type==12 );
danb95e1192015-05-26 20:31:20 +00004638 if( serial_type>=10 ){
drh0e522c02022-10-18 13:27:31 +00004639 rc = serial_type==10 ? -1 : +1;
dan1fed5da2014-02-25 21:01:25 +00004640 }else if( serial_type==0 ){
4641 rc = -1;
dan3b9330f2014-02-27 20:44:18 +00004642 }else if( serial_type==7 ){
dan1fed5da2014-02-25 21:01:25 +00004643 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
drh2ab410a2015-11-06 14:59:07 +00004644 rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
dan3b9330f2014-02-27 20:44:18 +00004645 }else{
4646 i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
4647 i64 rhs = pRhs->u.i;
4648 if( lhs<rhs ){
4649 rc = -1;
4650 }else if( lhs>rhs ){
4651 rc = +1;
dan1fed5da2014-02-25 21:01:25 +00004652 }
4653 }
4654 }
4655
4656 /* RHS is real */
4657 else if( pRhs->flags & MEM_Real ){
4658 serial_type = aKey1[idx1];
dancc7aa1f2015-05-26 20:07:32 +00004659 if( serial_type>=10 ){
4660 /* Serial types 12 or greater are strings and blobs (greater than
4661 ** numbers). Types 10 and 11 are currently "reserved for future
4662 ** use", so it doesn't really matter what the results of comparing
4663 ** them to numberic values are. */
drh0e522c02022-10-18 13:27:31 +00004664 rc = serial_type==10 ? -1 : +1;
dan1fed5da2014-02-25 21:01:25 +00004665 }else if( serial_type==0 ){
4666 rc = -1;
4667 }else{
dan1fed5da2014-02-25 21:01:25 +00004668 sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
4669 if( serial_type==7 ){
drh2ab410a2015-11-06 14:59:07 +00004670 if( mem1.u.r<pRhs->u.r ){
4671 rc = -1;
4672 }else if( mem1.u.r>pRhs->u.r ){
4673 rc = +1;
4674 }
dan1fed5da2014-02-25 21:01:25 +00004675 }else{
drh2ab410a2015-11-06 14:59:07 +00004676 rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
dan1fed5da2014-02-25 21:01:25 +00004677 }
4678 }
4679 }
4680
4681 /* RHS is a string */
4682 else if( pRhs->flags & MEM_Str ){
drh02a95eb2020-01-28 20:27:42 +00004683 getVarint32NR(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004684 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004685 if( serial_type<12 ){
4686 rc = -1;
4687 }else if( !(serial_type & 0x01) ){
4688 rc = +1;
4689 }else{
4690 mem1.n = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004691 testcase( (d1+mem1.n)==(unsigned)nKey1 );
4692 testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
drh9b133652019-01-22 02:34:35 +00004693 if( (d1+mem1.n) > (unsigned)nKey1
4694 || (pKeyInfo = pPKey2->pKeyInfo)->nAllField<=i
4695 ){
dan38fdead2014-04-01 10:19:02 +00004696 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004697 return 0; /* Corruption */
drh9b133652019-01-22 02:34:35 +00004698 }else if( pKeyInfo->aColl[i] ){
dan1fed5da2014-02-25 21:01:25 +00004699 mem1.enc = pKeyInfo->enc;
4700 mem1.db = pKeyInfo->db;
4701 mem1.flags = MEM_Str;
drhfcb44a82014-03-03 15:13:27 +00004702 mem1.z = (char*)&aKey1[d1];
dan38fdead2014-04-01 10:19:02 +00004703 rc = vdbeCompareMemString(
4704 &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
4705 );
dan1fed5da2014-02-25 21:01:25 +00004706 }else{
4707 int nCmp = MIN(mem1.n, pRhs->n);
4708 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4709 if( rc==0 ) rc = mem1.n - pRhs->n;
4710 }
4711 }
4712 }
4713
4714 /* RHS is a blob */
4715 else if( pRhs->flags & MEM_Blob ){
drh8aaf7bc2016-09-20 01:19:18 +00004716 assert( (pRhs->flags & MEM_Zero)==0 || pRhs->n==0 );
drh02a95eb2020-01-28 20:27:42 +00004717 getVarint32NR(&aKey1[idx1], serial_type);
drhb6e8fd12014-03-06 01:56:33 +00004718 testcase( serial_type==12 );
dan1fed5da2014-02-25 21:01:25 +00004719 if( serial_type<12 || (serial_type & 0x01) ){
4720 rc = -1;
4721 }else{
4722 int nStr = (serial_type - 12) / 2;
drhb6e8fd12014-03-06 01:56:33 +00004723 testcase( (d1+nStr)==(unsigned)nKey1 );
4724 testcase( (d1+nStr+1)==(unsigned)nKey1 );
drh295aedf2014-03-03 18:25:24 +00004725 if( (d1+nStr) > (unsigned)nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004726 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004727 return 0; /* Corruption */
drh8aaf7bc2016-09-20 01:19:18 +00004728 }else if( pRhs->flags & MEM_Zero ){
4729 if( !isAllZero((const char*)&aKey1[d1],nStr) ){
4730 rc = 1;
4731 }else{
4732 rc = nStr - pRhs->u.nZero;
4733 }
dan1fed5da2014-02-25 21:01:25 +00004734 }else{
4735 int nCmp = MIN(nStr, pRhs->n);
4736 rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
4737 if( rc==0 ) rc = nStr - pRhs->n;
4738 }
4739 }
4740 }
4741
4742 /* RHS is null */
4743 else{
4744 serial_type = aKey1[idx1];
drh43fce6b2022-10-18 10:27:06 +00004745 rc = (serial_type!=0 && serial_type!=10);
dan1fed5da2014-02-25 21:01:25 +00004746 }
4747
4748 if( rc!=0 ){
dan6e118922019-08-12 16:36:38 +00004749 int sortFlags = pPKey2->pKeyInfo->aSortFlags[i];
4750 if( sortFlags ){
4751 if( (sortFlags & KEYINFO_ORDER_BIGNULL)==0
4752 || ((sortFlags & KEYINFO_ORDER_DESC)
4753 !=(serial_type==0 || (pRhs->flags&MEM_Null)))
4754 ){
4755 rc = -rc;
4756 }
dan1fed5da2014-02-25 21:01:25 +00004757 }
drh79211e12014-05-02 17:33:16 +00004758 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
drh17bcb102014-09-18 21:25:33 +00004759 assert( mem1.szMalloc==0 ); /* See comment below */
dan1fed5da2014-02-25 21:01:25 +00004760 return rc;
4761 }
4762
4763 i++;
drhd8821082018-06-06 20:29:19 +00004764 if( i==pPKey2->nField ) break;
dan3b9330f2014-02-27 20:44:18 +00004765 pRhs++;
dan1fed5da2014-02-25 21:01:25 +00004766 d1 += sqlite3VdbeSerialTypeLen(serial_type);
drh093677a2022-11-04 11:54:42 +00004767 if( d1>(unsigned)nKey1 ) break;
dan1fed5da2014-02-25 21:01:25 +00004768 idx1 += sqlite3VarintLen(serial_type);
drh093677a2022-11-04 11:54:42 +00004769 if( idx1>=(unsigned)szHdr1 ){
4770 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
4771 return 0; /* Corrupt index */
4772 }
4773 }
dan1fed5da2014-02-25 21:01:25 +00004774
4775 /* No memory allocation is ever used on mem1. Prove this using
4776 ** the following assert(). If the assert() fails, it indicates a
dan3833e932014-03-01 19:44:56 +00004777 ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
drh17bcb102014-09-18 21:25:33 +00004778 assert( mem1.szMalloc==0 );
dan1fed5da2014-02-25 21:01:25 +00004779
4780 /* rc==0 here means that one or both of the keys ran out of fields and
peter.d.reid60ec9142014-09-06 16:39:46 +00004781 ** all the fields up to that point were equal. Return the default_rc
dan1fed5da2014-02-25 21:01:25 +00004782 ** value. */
dan3833e932014-03-01 19:44:56 +00004783 assert( CORRUPT_DB
drh66141812014-06-30 20:25:03 +00004784 || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
drh6eb34802018-06-06 20:55:10 +00004785 || pPKey2->pKeyInfo->db->mallocFailed
dan3833e932014-03-01 19:44:56 +00004786 );
drh70528d72015-11-05 20:25:09 +00004787 pPKey2->eqSeen = 1;
dan1fed5da2014-02-25 21:01:25 +00004788 return pPKey2->default_rc;
4789}
drh75179de2014-09-16 14:37:35 +00004790int sqlite3VdbeRecordCompare(
4791 int nKey1, const void *pKey1, /* Left key */
4792 UnpackedRecord *pPKey2 /* Right key */
4793){
dan7004f3f2015-03-30 12:06:26 +00004794 return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
drh75179de2014-09-16 14:37:35 +00004795}
4796
dan1fed5da2014-02-25 21:01:25 +00004797
dan3833e932014-03-01 19:44:56 +00004798/*
4799** This function is an optimized version of sqlite3VdbeRecordCompare()
4800** that (a) the first field of pPKey2 is an integer, and (b) the
4801** size-of-header varint at the start of (pKey1/nKey1) fits in a single
4802** byte (i.e. is less than 128).
drhe2ac5062014-03-26 12:02:38 +00004803**
4804** To avoid concerns about buffer overreads, this routine is only used
4805** on schemas where the maximum valid header size is 63 bytes or less.
dan3833e932014-03-01 19:44:56 +00004806*/
dan3b9330f2014-02-27 20:44:18 +00004807static int vdbeRecordCompareInt(
4808 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004809 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004810){
dan9b8afef2014-03-03 20:48:50 +00004811 const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
dan3b9330f2014-02-27 20:44:18 +00004812 int serial_type = ((const u8*)pKey1)[1];
4813 int res;
drhf926d1e2014-03-04 04:04:33 +00004814 u32 y;
4815 u64 x;
drh5f6eb1a2016-09-15 00:04:46 +00004816 i64 v;
dan3b9330f2014-02-27 20:44:18 +00004817 i64 lhs;
4818
drhe1bb8022015-01-19 19:48:52 +00004819 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drhe2ac5062014-03-26 12:02:38 +00004820 assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
dan3833e932014-03-01 19:44:56 +00004821 switch( serial_type ){
drhf926d1e2014-03-04 04:04:33 +00004822 case 1: { /* 1-byte signed integer */
4823 lhs = ONE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004824 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004825 break;
4826 }
drhf926d1e2014-03-04 04:04:33 +00004827 case 2: { /* 2-byte signed integer */
4828 lhs = TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004829 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004830 break;
4831 }
4832 case 3: { /* 3-byte signed integer */
4833 lhs = THREE_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004834 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004835 break;
4836 }
4837 case 4: { /* 4-byte signed integer */
4838 y = FOUR_BYTE_UINT(aKey);
4839 lhs = (i64)*(int*)&y;
drhb6e8fd12014-03-06 01:56:33 +00004840 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004841 break;
4842 }
4843 case 5: { /* 6-byte signed integer */
4844 lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
drhb6e8fd12014-03-06 01:56:33 +00004845 testcase( lhs<0 );
drhf926d1e2014-03-04 04:04:33 +00004846 break;
4847 }
4848 case 6: { /* 8-byte signed integer */
4849 x = FOUR_BYTE_UINT(aKey);
4850 x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
4851 lhs = *(i64*)&x;
drhb6e8fd12014-03-06 01:56:33 +00004852 testcase( lhs<0 );
dan3b9330f2014-02-27 20:44:18 +00004853 break;
4854 }
dan3b9330f2014-02-27 20:44:18 +00004855 case 8:
4856 lhs = 0;
4857 break;
dan3b9330f2014-02-27 20:44:18 +00004858 case 9:
4859 lhs = 1;
4860 break;
4861
dan063d4a02014-02-28 09:48:30 +00004862 /* This case could be removed without changing the results of running
4863 ** this code. Including it causes gcc to generate a faster switch
4864 ** statement (since the range of switch targets now starts at zero and
dan597515d2014-02-28 18:39:51 +00004865 ** is contiguous) but does not cause any duplicate code to be generated
dan063d4a02014-02-28 09:48:30 +00004866 ** (as gcc is clever enough to combine the two like cases). Other
4867 ** compilers might be similar. */
4868 case 0: case 7:
drh75179de2014-09-16 14:37:35 +00004869 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan063d4a02014-02-28 09:48:30 +00004870
dan3b9330f2014-02-27 20:44:18 +00004871 default:
drh75179de2014-09-16 14:37:35 +00004872 return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
dan3b9330f2014-02-27 20:44:18 +00004873 }
4874
drhf357caf2022-02-27 21:10:49 +00004875 assert( pPKey2->u.i == pPKey2->aMem[0].u.i );
4876 v = pPKey2->u.i;
dan3b9330f2014-02-27 20:44:18 +00004877 if( v>lhs ){
4878 res = pPKey2->r1;
4879 }else if( v<lhs ){
4880 res = pPKey2->r2;
4881 }else if( pPKey2->nField>1 ){
dan063d4a02014-02-28 09:48:30 +00004882 /* The first fields of the two keys are equal. Compare the trailing
4883 ** fields. */
dan7004f3f2015-03-30 12:06:26 +00004884 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004885 }else{
dan063d4a02014-02-28 09:48:30 +00004886 /* The first fields of the two keys are equal and there are no trailing
4887 ** fields. Return pPKey2->default_rc in this case. */
dan3b9330f2014-02-27 20:44:18 +00004888 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004889 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004890 }
4891
drh79211e12014-05-02 17:33:16 +00004892 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
dan3b9330f2014-02-27 20:44:18 +00004893 return res;
4894}
4895
dan3833e932014-03-01 19:44:56 +00004896/*
4897** This function is an optimized version of sqlite3VdbeRecordCompare()
4898** that (a) the first field of pPKey2 is a string, that (b) the first field
4899** uses the collation sequence BINARY and (c) that the size-of-header varint
4900** at the start of (pKey1/nKey1) fits in a single byte.
4901*/
dan3b9330f2014-02-27 20:44:18 +00004902static int vdbeRecordCompareString(
4903 int nKey1, const void *pKey1, /* Left key */
drh75179de2014-09-16 14:37:35 +00004904 UnpackedRecord *pPKey2 /* Right key */
dan3b9330f2014-02-27 20:44:18 +00004905){
4906 const u8 *aKey1 = (const u8*)pKey1;
4907 int serial_type;
4908 int res;
4909
drh2ab410a2015-11-06 14:59:07 +00004910 assert( pPKey2->aMem[0].flags & MEM_Str );
drhf357caf2022-02-27 21:10:49 +00004911 assert( pPKey2->aMem[0].n == pPKey2->n );
4912 assert( pPKey2->aMem[0].z == pPKey2->u.z );
drhe1bb8022015-01-19 19:48:52 +00004913 vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
drha1e951f2022-02-27 18:54:33 +00004914 serial_type = (signed char)(aKey1[1]);
4915
4916vrcs_restart:
dan3b9330f2014-02-27 20:44:18 +00004917 if( serial_type<12 ){
drha1e951f2022-02-27 18:54:33 +00004918 if( serial_type<0 ){
4919 sqlite3GetVarint32(&aKey1[1], (u32*)&serial_type);
4920 if( serial_type>=12 ) goto vrcs_restart;
4921 assert( CORRUPT_DB );
4922 }
dan3b9330f2014-02-27 20:44:18 +00004923 res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
4924 }else if( !(serial_type & 0x01) ){
4925 res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
4926 }else{
4927 int nCmp;
4928 int nStr;
dan3833e932014-03-01 19:44:56 +00004929 int szHdr = aKey1[0];
dan3b9330f2014-02-27 20:44:18 +00004930
4931 nStr = (serial_type-12) / 2;
drha1f7c0a2014-03-28 03:12:48 +00004932 if( (szHdr + nStr) > nKey1 ){
dan38fdead2014-04-01 10:19:02 +00004933 pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
drha1f7c0a2014-03-28 03:12:48 +00004934 return 0; /* Corruption */
4935 }
drhf357caf2022-02-27 21:10:49 +00004936 nCmp = MIN( pPKey2->n, nStr );
4937 res = memcmp(&aKey1[szHdr], pPKey2->u.z, nCmp);
dan3b9330f2014-02-27 20:44:18 +00004938
dan52d9a3c2019-07-12 15:15:43 +00004939 if( res>0 ){
4940 res = pPKey2->r2;
4941 }else if( res<0 ){
4942 res = pPKey2->r1;
4943 }else{
drhf357caf2022-02-27 21:10:49 +00004944 res = nStr - pPKey2->n;
dan3b9330f2014-02-27 20:44:18 +00004945 if( res==0 ){
4946 if( pPKey2->nField>1 ){
dan7004f3f2015-03-30 12:06:26 +00004947 res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
dan3b9330f2014-02-27 20:44:18 +00004948 }else{
4949 res = pPKey2->default_rc;
drh70528d72015-11-05 20:25:09 +00004950 pPKey2->eqSeen = 1;
dan3b9330f2014-02-27 20:44:18 +00004951 }
4952 }else if( res>0 ){
4953 res = pPKey2->r2;
4954 }else{
4955 res = pPKey2->r1;
4956 }
dan3b9330f2014-02-27 20:44:18 +00004957 }
4958 }
4959
drh66141812014-06-30 20:25:03 +00004960 assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
dan3b9330f2014-02-27 20:44:18 +00004961 || CORRUPT_DB
dan6696ba32014-06-28 19:06:49 +00004962 || pPKey2->pKeyInfo->db->mallocFailed
dan3b9330f2014-02-27 20:44:18 +00004963 );
4964 return res;
4965}
4966
dan3833e932014-03-01 19:44:56 +00004967/*
4968** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
4969** suitable for comparing serialized records to the unpacked record passed
4970** as the only argument.
4971*/
dan1fed5da2014-02-25 21:01:25 +00004972RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
dan9b8afef2014-03-03 20:48:50 +00004973 /* varintRecordCompareInt() and varintRecordCompareString() both assume
4974 ** that the size-of-header varint that occurs at the start of each record
4975 ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
4976 ** also assumes that it is safe to overread a buffer by at least the
4977 ** maximum possible legal header size plus 8 bytes. Because there is
4978 ** guaranteed to be at least 74 (but not 136) bytes of padding following each
4979 ** buffer passed to varintRecordCompareInt() this makes it convenient to
4980 ** limit the size of the header to 64 bytes in cases where the first field
4981 ** is an integer.
4982 **
4983 ** The easiest way to enforce this limit is to consider only records with
4984 ** 13 fields or less. If the first field is an integer, the maximum legal
4985 ** header size is (12*5 + 1 + 1) bytes. */
drha485ad12017-08-02 22:43:14 +00004986 if( p->pKeyInfo->nAllField<=13 ){
dan1fed5da2014-02-25 21:01:25 +00004987 int flags = p->aMem[0].flags;
dan6e118922019-08-12 16:36:38 +00004988 if( p->pKeyInfo->aSortFlags[0] ){
4989 if( p->pKeyInfo->aSortFlags[0] & KEYINFO_ORDER_BIGNULL ){
4990 return sqlite3VdbeRecordCompare;
4991 }
dan3b9330f2014-02-27 20:44:18 +00004992 p->r1 = 1;
4993 p->r2 = -1;
4994 }else{
4995 p->r1 = -1;
4996 p->r2 = 1;
4997 }
dan1fed5da2014-02-25 21:01:25 +00004998 if( (flags & MEM_Int) ){
drhf357caf2022-02-27 21:10:49 +00004999 p->u.i = p->aMem[0].u.i;
dan1fed5da2014-02-25 21:01:25 +00005000 return vdbeRecordCompareInt;
dan3b9330f2014-02-27 20:44:18 +00005001 }
drhb6e8fd12014-03-06 01:56:33 +00005002 testcase( flags & MEM_Real );
5003 testcase( flags & MEM_Null );
5004 testcase( flags & MEM_Blob );
drh169f0772019-05-02 21:36:26 +00005005 if( (flags & (MEM_Real|MEM_IntReal|MEM_Null|MEM_Blob))==0
5006 && p->pKeyInfo->aColl[0]==0
5007 ){
drhb6e8fd12014-03-06 01:56:33 +00005008 assert( flags & MEM_Str );
drhf357caf2022-02-27 21:10:49 +00005009 p->u.z = p->aMem[0].z;
5010 p->n = p->aMem[0].n;
dan1fed5da2014-02-25 21:01:25 +00005011 return vdbeRecordCompareString;
5012 }
5013 }
dan3b9330f2014-02-27 20:44:18 +00005014
dan3833e932014-03-01 19:44:56 +00005015 return sqlite3VdbeRecordCompare;
dan3b9330f2014-02-27 20:44:18 +00005016}
danielk1977eb015e02004-05-18 01:31:14 +00005017
5018/*
drh7a224de2004-06-02 01:22:02 +00005019** pCur points at an index entry created using the OP_MakeRecord opcode.
5020** Read the rowid (the last field in the record) and store it in *rowid.
5021** Return SQLITE_OK if everything works, or an error code otherwise.
drh88a003e2008-12-11 16:17:03 +00005022**
5023** pCur might be pointing to text obtained from a corrupt database file.
5024** So the content cannot be trusted. Do appropriate checks on the content.
danielk1977183f9f72004-05-13 05:20:26 +00005025*/
drh35f6b932009-06-23 14:15:04 +00005026int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
drh61fc5952007-04-01 23:49:51 +00005027 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00005028 int rc;
drhd5788202004-05-28 08:21:05 +00005029 u32 szHdr; /* Size of the header */
5030 u32 typeRowid; /* Serial type of the rowid */
5031 u32 lenRowid; /* Size of the rowid */
5032 Mem m, v;
danielk1977183f9f72004-05-13 05:20:26 +00005033
drh88a003e2008-12-11 16:17:03 +00005034 /* Get the size of the index entry. Only indices entries of less
drh7b746032009-06-26 12:15:22 +00005035 ** than 2GiB are support - anything large must be database corruption.
5036 ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
drhc27ae612009-07-14 18:35:44 +00005037 ** this code can safely assume that nCellKey is 32-bits
5038 */
drhea8ffdf2009-07-22 00:35:23 +00005039 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00005040 nCellKey = sqlite3BtreePayloadSize(pCur);
drh7b746032009-06-26 12:15:22 +00005041 assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
drh88a003e2008-12-11 16:17:03 +00005042
5043 /* Read in the complete content of the index entry */
drhd3b74202014-09-17 16:41:15 +00005044 sqlite3VdbeMemInit(&m, db, 0);
drh2a740062020-02-05 18:28:17 +00005045 rc = sqlite3VdbeMemFromBtreeZeroOffset(pCur, (u32)nCellKey, &m);
drhd5788202004-05-28 08:21:05 +00005046 if( rc ){
danielk1977183f9f72004-05-13 05:20:26 +00005047 return rc;
5048 }
drh88a003e2008-12-11 16:17:03 +00005049
5050 /* The index entry must begin with a header size */
drh02a95eb2020-01-28 20:27:42 +00005051 getVarint32NR((u8*)m.z, szHdr);
drh7b746032009-06-26 12:15:22 +00005052 testcase( szHdr==3 );
mistachkin2b5fbb22021-12-31 18:26:50 +00005053 testcase( szHdr==(u32)m.n );
drh44d06852018-10-01 13:54:30 +00005054 testcase( szHdr>0x7fffffff );
5055 assert( m.n>=0 );
5056 if( unlikely(szHdr<3 || szHdr>(unsigned)m.n) ){
drh88a003e2008-12-11 16:17:03 +00005057 goto idx_rowid_corruption;
5058 }
5059
5060 /* The last field of the index should be an integer - the ROWID.
5061 ** Verify that the last entry really is an integer. */
drh02a95eb2020-01-28 20:27:42 +00005062 getVarint32NR((u8*)&m.z[szHdr-1], typeRowid);
drh88a003e2008-12-11 16:17:03 +00005063 testcase( typeRowid==1 );
5064 testcase( typeRowid==2 );
5065 testcase( typeRowid==3 );
5066 testcase( typeRowid==4 );
5067 testcase( typeRowid==5 );
5068 testcase( typeRowid==6 );
5069 testcase( typeRowid==8 );
5070 testcase( typeRowid==9 );
5071 if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
5072 goto idx_rowid_corruption;
5073 }
drhc5ef7152015-06-28 02:58:51 +00005074 lenRowid = sqlite3SmallTypeSizes[typeRowid];
drheeb844a2009-08-08 18:01:07 +00005075 testcase( (u32)m.n==szHdr+lenRowid );
5076 if( unlikely((u32)m.n<szHdr+lenRowid) ){
drh88a003e2008-12-11 16:17:03 +00005077 goto idx_rowid_corruption;
5078 }
5079
5080 /* Fetch the integer off the end of the index record */
drh2646da72005-12-09 20:02:05 +00005081 sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
drh3c024d62007-03-30 11:23:45 +00005082 *rowid = v.u.i;
drhfc854502022-03-02 17:50:59 +00005083 sqlite3VdbeMemReleaseMalloc(&m);
danielk1977183f9f72004-05-13 05:20:26 +00005084 return SQLITE_OK;
drh88a003e2008-12-11 16:17:03 +00005085
5086 /* Jump here if database corruption is detected after m has been
5087 ** allocated. Free the m object and return SQLITE_CORRUPT. */
5088idx_rowid_corruption:
drh17bcb102014-09-18 21:25:33 +00005089 testcase( m.szMalloc!=0 );
drhfc854502022-03-02 17:50:59 +00005090 sqlite3VdbeMemReleaseMalloc(&m);
drh88a003e2008-12-11 16:17:03 +00005091 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00005092}
5093
drh7cf6e4d2004-05-19 14:56:55 +00005094/*
drh5f82e3c2009-07-06 00:44:08 +00005095** Compare the key of the index entry that cursor pC is pointing to against
5096** the key string in pUnpacked. Write into *pRes a number
drh7cf6e4d2004-05-19 14:56:55 +00005097** that is negative, zero, or positive if pC is less than, equal to,
drh5f82e3c2009-07-06 00:44:08 +00005098** or greater than pUnpacked. Return SQLITE_OK on success.
drhd3d39e92004-05-20 22:16:29 +00005099**
drh5f82e3c2009-07-06 00:44:08 +00005100** pUnpacked is either created without a rowid or is truncated so that it
drhd5788202004-05-28 08:21:05 +00005101** omits the rowid at the end. The rowid at the end of the index entry
drhec1fc802008-08-13 14:07:40 +00005102** is ignored as well. Hence, this routine only compares the prefixes
5103** of the keys prior to the final rowid, not the entire key.
drh7cf6e4d2004-05-19 14:56:55 +00005104*/
danielk1977183f9f72004-05-13 05:20:26 +00005105int sqlite3VdbeIdxKeyCompare(
drhd3b74202014-09-17 16:41:15 +00005106 sqlite3 *db, /* Database connection */
drh295aedf2014-03-03 18:25:24 +00005107 VdbeCursor *pC, /* The cursor to compare against */
drha1f7c0a2014-03-28 03:12:48 +00005108 UnpackedRecord *pUnpacked, /* Unpacked version of key */
drh295aedf2014-03-03 18:25:24 +00005109 int *res /* Write the comparison result here */
danielk1977183f9f72004-05-13 05:20:26 +00005110){
drh61fc5952007-04-01 23:49:51 +00005111 i64 nCellKey = 0;
danielk1977183f9f72004-05-13 05:20:26 +00005112 int rc;
drhc960dcb2015-11-20 19:22:01 +00005113 BtCursor *pCur;
drhd5788202004-05-28 08:21:05 +00005114 Mem m;
danielk1977183f9f72004-05-13 05:20:26 +00005115
drhc960dcb2015-11-20 19:22:01 +00005116 assert( pC->eCurType==CURTYPE_BTREE );
5117 pCur = pC->uc.pCursor;
drhea8ffdf2009-07-22 00:35:23 +00005118 assert( sqlite3BtreeCursorIsValid(pCur) );
drha7c90c42016-06-04 20:37:10 +00005119 nCellKey = sqlite3BtreePayloadSize(pCur);
drh56689692014-03-03 19:29:28 +00005120 /* nCellKey will always be between 0 and 0xffffffff because of the way
drh407414c2009-07-14 14:15:27 +00005121 ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
drhc27ae612009-07-14 18:35:44 +00005122 if( nCellKey<=0 || nCellKey>0x7fffffff ){
danielk1977183f9f72004-05-13 05:20:26 +00005123 *res = 0;
drh9978c972010-02-23 17:36:32 +00005124 return SQLITE_CORRUPT_BKPT;
danielk1977183f9f72004-05-13 05:20:26 +00005125 }
drhd3b74202014-09-17 16:41:15 +00005126 sqlite3VdbeMemInit(&m, db, 0);
drh2a740062020-02-05 18:28:17 +00005127 rc = sqlite3VdbeMemFromBtreeZeroOffset(pCur, (u32)nCellKey, &m);
drhec1fc802008-08-13 14:07:40 +00005128 if( rc ){
drhd5788202004-05-28 08:21:05 +00005129 return rc;
danielk1977183f9f72004-05-13 05:20:26 +00005130 }
drh6eb34802018-06-06 20:55:10 +00005131 *res = sqlite3VdbeRecordCompareWithSkip(m.n, m.z, pUnpacked, 0);
drhfc854502022-03-02 17:50:59 +00005132 sqlite3VdbeMemReleaseMalloc(&m);
danielk1977183f9f72004-05-13 05:20:26 +00005133 return SQLITE_OK;
5134}
danielk1977b28af712004-06-21 06:50:26 +00005135
5136/*
5137** This routine sets the value to be returned by subsequent calls to
5138** sqlite3_changes() on the database handle 'db'.
5139*/
dan2c718872021-06-22 18:32:05 +00005140void sqlite3VdbeSetChanges(sqlite3 *db, i64 nChange){
drhb21c8cd2007-08-21 19:33:56 +00005141 assert( sqlite3_mutex_held(db->mutex) );
danielk1977b28af712004-06-21 06:50:26 +00005142 db->nChange = nChange;
5143 db->nTotalChange += nChange;
5144}
5145
5146/*
5147** Set a flag in the vdbe to update the change counter when it is finalised
5148** or reset.
5149*/
drh4794f732004-11-05 17:17:50 +00005150void sqlite3VdbeCountChanges(Vdbe *v){
5151 v->changeCntOn = 1;
danielk1977b28af712004-06-21 06:50:26 +00005152}
drhd89bd002005-01-22 03:03:54 +00005153
5154/*
5155** Mark every prepared statement associated with a database connection
5156** as expired.
5157**
5158** An expired statement means that recompilation of the statement is
5159** recommend. Statements expire when things happen that make their
5160** programs obsolete. Removing user-defined functions or collating
5161** sequences, or changing an authorization function are the types of
5162** things that make prepared statements obsolete.
drhba968db2018-07-24 22:02:12 +00005163**
5164** If iCode is 1, then expiration is advisory. The statement should
5165** be reprepared before being restarted, but if it is already running
5166** it is allowed to run to completion.
5167**
5168** Internally, this function just sets the Vdbe.expired flag on all
5169** prepared statements. The flag is set to 1 for an immediate expiration
5170** and set to 2 for an advisory expiration.
drhd89bd002005-01-22 03:03:54 +00005171*/
drhba968db2018-07-24 22:02:12 +00005172void sqlite3ExpirePreparedStatements(sqlite3 *db, int iCode){
drhd89bd002005-01-22 03:03:54 +00005173 Vdbe *p;
drhe5928b12022-08-23 20:11:01 +00005174 for(p = db->pVdbe; p; p=p->pVNext){
drhba968db2018-07-24 22:02:12 +00005175 p->expired = iCode+1;
drhd89bd002005-01-22 03:03:54 +00005176 }
5177}
danielk1977aee18ef2005-03-09 12:26:50 +00005178
5179/*
5180** Return the database associated with the Vdbe.
5181*/
5182sqlite3 *sqlite3VdbeDb(Vdbe *v){
5183 return v->db;
5184}
dan937d0de2009-10-15 18:35:38 +00005185
5186/*
drh2c2f3922017-06-01 00:54:35 +00005187** Return the SQLITE_PREPARE flags for a Vdbe.
5188*/
5189u8 sqlite3VdbePrepareFlags(Vdbe *v){
5190 return v->prepFlags;
5191}
5192
5193/*
dan937d0de2009-10-15 18:35:38 +00005194** Return a pointer to an sqlite3_value structure containing the value bound
5195** parameter iVar of VM v. Except, if the value is an SQL NULL, return
5196** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
5197** constants) to the value before returning it.
5198**
5199** The returned value must be freed by the caller using sqlite3ValueFree().
5200*/
drhcf0fd4a2013-08-01 12:21:58 +00005201sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
dan937d0de2009-10-15 18:35:38 +00005202 assert( iVar>0 );
5203 if( v ){
5204 Mem *pMem = &v->aVar[iVar-1];
drh7df74752017-06-26 14:46:05 +00005205 assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
dan937d0de2009-10-15 18:35:38 +00005206 if( 0==(pMem->flags & MEM_Null) ){
5207 sqlite3_value *pRet = sqlite3ValueNew(v->db);
5208 if( pRet ){
5209 sqlite3VdbeMemCopy((Mem *)pRet, pMem);
5210 sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
dan937d0de2009-10-15 18:35:38 +00005211 }
5212 return pRet;
5213 }
5214 }
5215 return 0;
5216}
5217
5218/*
5219** Configure SQL variable iVar so that binding a new value to it signals
5220** to sqlite3_reoptimize() that re-preparing the statement may result
5221** in a better query plan.
5222*/
dan1d2ce4f2009-10-19 18:11:09 +00005223void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
dan937d0de2009-10-15 18:35:38 +00005224 assert( iVar>0 );
drh7df74752017-06-26 14:46:05 +00005225 assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
drh29967962017-03-03 21:51:40 +00005226 if( iVar>=32 ){
5227 v->expmask |= 0x80000000;
dan937d0de2009-10-15 18:35:38 +00005228 }else{
dan1d2ce4f2009-10-19 18:11:09 +00005229 v->expmask |= ((u32)1 << (iVar-1));
dan937d0de2009-10-15 18:35:38 +00005230 }
5231}
dan46c47d42011-03-01 18:42:07 +00005232
drh3e34eab2017-07-19 19:48:40 +00005233/*
5234** Cause a function to throw an error if it was call from OP_PureFunc
5235** rather than OP_Function.
5236**
5237** OP_PureFunc means that the function must be deterministic, and should
5238** throw an error if it is given inputs that would make it non-deterministic.
5239** This routine is invoked by date/time functions that use non-deterministic
5240** features such as 'now'.
5241*/
drh6e97f8e2017-07-20 13:17:08 +00005242int sqlite3NotPureFunc(sqlite3_context *pCtx){
drh20cee7d2019-10-30 18:50:08 +00005243 const VdbeOp *pOp;
drh175b8f02019-08-08 15:24:17 +00005244#ifdef SQLITE_ENABLE_STAT4
drhe8cf1ab2017-07-25 01:34:05 +00005245 if( pCtx->pVdbe==0 ) return 1;
5246#endif
drh20cee7d2019-10-30 18:50:08 +00005247 pOp = pCtx->pVdbe->aOp + pCtx->iOp;
5248 if( pOp->opcode==OP_PureFunc ){
5249 const char *zContext;
5250 char *zMsg;
5251 if( pOp->p5 & NC_IsCheck ){
5252 zContext = "a CHECK constraint";
5253 }else if( pOp->p5 & NC_GenCol ){
5254 zContext = "a generated column";
5255 }else{
5256 zContext = "an index";
5257 }
5258 zMsg = sqlite3_mprintf("non-deterministic use of %s() in %s",
5259 pCtx->pFunc->zName, zContext);
drh920cf592019-10-30 16:29:02 +00005260 sqlite3_result_error(pCtx, zMsg, -1);
5261 sqlite3_free(zMsg);
drh6e97f8e2017-07-20 13:17:08 +00005262 return 0;
drh3e34eab2017-07-19 19:48:40 +00005263 }
drh6e97f8e2017-07-20 13:17:08 +00005264 return 1;
drh3e34eab2017-07-19 19:48:40 +00005265}
5266
dan016f7812013-08-21 17:35:48 +00005267#ifndef SQLITE_OMIT_VIRTUALTABLE
5268/*
5269** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
5270** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
5271** in memory obtained from sqlite3DbMalloc).
5272*/
5273void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
dan5c3aa052016-01-20 08:47:55 +00005274 if( pVtab->zErrMsg ){
5275 sqlite3 *db = p->db;
5276 sqlite3DbFree(db, p->zErrMsg);
5277 p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
5278 sqlite3_free(pVtab->zErrMsg);
5279 pVtab->zErrMsg = 0;
5280 }
dan016f7812013-08-21 17:35:48 +00005281}
5282#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh32683532013-08-22 15:07:08 +00005283
drh9b1c62d2011-03-30 21:04:43 +00005284#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan93bca692011-09-14 19:41:44 +00005285
5286/*
5287** If the second argument is not NULL, release any allocations associated
5288** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
5289** structure itself, using sqlite3DbFree().
5290**
5291** This function is used to free UnpackedRecord structures allocated by
5292** the vdbeUnpackRecord() function found in vdbeapi.c.
5293*/
dan2a86c192017-01-25 17:44:13 +00005294static void vdbeFreeUnpacked(sqlite3 *db, int nField, UnpackedRecord *p){
drh41ce47c2022-08-22 02:00:26 +00005295 assert( db!=0 );
dan93bca692011-09-14 19:41:44 +00005296 if( p ){
5297 int i;
dan2a86c192017-01-25 17:44:13 +00005298 for(i=0; i<nField; i++){
dan93bca692011-09-14 19:41:44 +00005299 Mem *pMem = &p->aMem[i];
drhfc854502022-03-02 17:50:59 +00005300 if( pMem->zMalloc ) sqlite3VdbeMemReleaseMalloc(pMem);
dan93bca692011-09-14 19:41:44 +00005301 }
drh41ce47c2022-08-22 02:00:26 +00005302 sqlite3DbNNFreeNN(db, p);
dan93bca692011-09-14 19:41:44 +00005303 }
5304}
drh74c33022016-03-30 12:56:55 +00005305#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
dan93bca692011-09-14 19:41:44 +00005306
drh74c33022016-03-30 12:56:55 +00005307#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
dan46c47d42011-03-01 18:42:07 +00005308/*
5309** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
5310** then cursor passed as the second argument should point to the row about
5311** to be update or deleted. If the application calls sqlite3_preupdate_old(),
5312** the required value will be read from the row the cursor points to.
5313*/
5314void sqlite3VdbePreUpdateHook(
5315 Vdbe *v, /* Vdbe pre-update hook is invoked by */
5316 VdbeCursor *pCsr, /* Cursor to grab old.* values from */
5317 int op, /* SQLITE_INSERT, UPDATE or DELETE */
5318 const char *zDb, /* Database name */
dan319eeb72011-03-19 08:38:50 +00005319 Table *pTab, /* Modified table */
dan46c47d42011-03-01 18:42:07 +00005320 i64 iKey1, /* Initial key value */
dana23a8732021-04-21 20:52:17 +00005321 int iReg, /* Register for new.* record */
5322 int iBlobWrite
dan46c47d42011-03-01 18:42:07 +00005323){
5324 sqlite3 *db = v->db;
dan37db03b2011-03-16 19:59:18 +00005325 i64 iKey2;
dan46c47d42011-03-01 18:42:07 +00005326 PreUpdate preupdate;
dan319eeb72011-03-19 08:38:50 +00005327 const char *zTbl = pTab->zName;
drhc4645da2012-09-28 13:05:48 +00005328 static const u8 fakeSortOrder = 0;
dan46c47d42011-03-01 18:42:07 +00005329
drh304637c2011-03-18 16:47:27 +00005330 assert( db->pPreUpdate==0 );
5331 memset(&preupdate, 0, sizeof(PreUpdate));
dancb9a3642017-01-30 19:44:53 +00005332 if( HasRowid(pTab)==0 ){
5333 iKey1 = iKey2 = 0;
5334 preupdate.pPk = sqlite3PrimaryKeyIndex(pTab);
dan37db03b2011-03-16 19:59:18 +00005335 }else{
dancb9a3642017-01-30 19:44:53 +00005336 if( op==SQLITE_UPDATE ){
5337 iKey2 = v->aMem[iReg].u.i;
5338 }else{
5339 iKey2 = iKey1;
5340 }
dan37db03b2011-03-16 19:59:18 +00005341 }
5342
drh3ab4ffc2021-11-11 11:23:08 +00005343 assert( pCsr!=0 );
5344 assert( pCsr->eCurType==CURTYPE_BTREE );
dane437ca52011-07-11 19:45:38 +00005345 assert( pCsr->nField==pTab->nCol
5346 || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
5347 );
5348
dan37db03b2011-03-16 19:59:18 +00005349 preupdate.v = v;
dan46c47d42011-03-01 18:42:07 +00005350 preupdate.pCsr = pCsr;
5351 preupdate.op = op;
dan37db03b2011-03-16 19:59:18 +00005352 preupdate.iNewReg = iReg;
dan4fccf432011-03-08 19:22:50 +00005353 preupdate.keyinfo.db = db;
5354 preupdate.keyinfo.enc = ENC(db);
drha485ad12017-08-02 22:43:14 +00005355 preupdate.keyinfo.nKeyField = pTab->nCol;
drha677eec2019-08-22 19:35:24 +00005356 preupdate.keyinfo.aSortFlags = (u8*)&fakeSortOrder;
dan319eeb72011-03-19 08:38:50 +00005357 preupdate.iKey1 = iKey1;
5358 preupdate.iKey2 = iKey2;
dane43635a2016-10-21 21:21:45 +00005359 preupdate.pTab = pTab;
dana23a8732021-04-21 20:52:17 +00005360 preupdate.iBlobWrite = iBlobWrite;
dan319eeb72011-03-19 08:38:50 +00005361
dan46c47d42011-03-01 18:42:07 +00005362 db->pPreUpdate = &preupdate;
5363 db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
5364 db->pPreUpdate = 0;
5365 sqlite3DbFree(db, preupdate.aRecord);
drha485ad12017-08-02 22:43:14 +00005366 vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pUnpacked);
5367 vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pNewUnpacked);
dan37db03b2011-03-16 19:59:18 +00005368 if( preupdate.aNew ){
5369 int i;
5370 for(i=0; i<pCsr->nField; i++){
5371 sqlite3VdbeMemRelease(&preupdate.aNew[i]);
5372 }
drh41ce47c2022-08-22 02:00:26 +00005373 sqlite3DbNNFreeNN(db, preupdate.aNew);
dan37db03b2011-03-16 19:59:18 +00005374 }
dan46c47d42011-03-01 18:42:07 +00005375}
drh9b1c62d2011-03-30 21:04:43 +00005376#endif /* SQLITE_ENABLE_PREUPDATE_HOOK */