blob: 7d712ad674778d6dbe471f8cd92df58fb1e35106 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
48 assert( pExpr->op==TK_COLLATE );
49 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
drhdb36e252019-10-22 19:51:29 +000073 if( op==TK_VECTOR ){
74 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75 }
drh11949042019-08-05 18:01:42 +000076 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000077}
78
drh53db1452004-05-20 13:54:53 +000079/*
drh8b4c40d2007-02-01 23:02:45 +000080** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000081** sequence named by pToken. Return a pointer to a new Expr node that
82** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000083**
84** If a memory allocation error occurs, that fact is recorded in pParse->db
85** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000086*/
drh4ef7efa2014-03-20 15:14:08 +000087Expr *sqlite3ExprAddCollateToken(
88 Parse *pParse, /* Parsing context */
89 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000090 const Token *pCollName, /* Name of collating sequence */
91 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000092){
drh0a8a4062012-12-07 18:38:16 +000093 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000094 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000095 if( pNew ){
96 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000097 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000098 pExpr = pNew;
99 }
drhae80dde2012-12-06 21:16:43 +0000100 }
drh0a8a4062012-12-07 18:38:16 +0000101 return pExpr;
102}
103Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000104 Token s;
105 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000106 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000107 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000108}
109
110/*
drh0d950af2019-08-22 16:38:42 +0000111** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000112*/
113Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000114 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
115 assert( pExpr->op==TK_COLLATE );
116 pExpr = pExpr->pLeft;
117 }
118 return pExpr;
119}
120
121/*
122** Skip over any TK_COLLATE operators and/or any unlikely()
123** or likelihood() or likely() functions at the root of an
124** expression.
125*/
126Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000127 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000128 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000129 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000131 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000132 pExpr = pExpr->x.pList->a[0].pExpr;
133 }else{
drh0b8d2552015-09-05 22:36:07 +0000134 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000135 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000136 }
drha4c3c872013-09-12 17:29:25 +0000137 }
drh0a8a4062012-12-07 18:38:16 +0000138 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000139}
140
141/*
drhae80dde2012-12-06 21:16:43 +0000142** Return the collation sequence for the expression pExpr. If
143** there is no defined collating sequence, return NULL.
144**
drh70efa842017-09-28 01:58:23 +0000145** See also: sqlite3ExprNNCollSeq()
146**
147** The sqlite3ExprNNCollSeq() works the same exact that it returns the
148** default collation if pExpr has no defined collation.
149**
drhae80dde2012-12-06 21:16:43 +0000150** The collating sequence might be determined by a COLLATE operator
151** or by the presence of a column with a defined collating sequence.
152** COLLATE operators take first precedence. Left operands take
153** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000154*/
danielk19777cedc8d2004-06-10 10:50:08 +0000155CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000156 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000157 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000158 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000159 while( p ){
drhae80dde2012-12-06 21:16:43 +0000160 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000161 if( op==TK_REGISTER ) op = p->op2;
162 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000163 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000164 ){
drheda079c2018-09-20 19:02:15 +0000165 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000166 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000167 int j = p->iColumn;
168 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000169 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000170 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000171 }
172 break;
danielk19770202b292004-06-09 09:55:16 +0000173 }
drhe081d732018-07-27 18:19:12 +0000174 if( op==TK_CAST || op==TK_UPLUS ){
175 p = p->pLeft;
176 continue;
177 }
drh269d3222019-10-23 18:09:39 +0000178 if( op==TK_VECTOR ){
179 p = p->x.pList->a[0].pExpr;
180 continue;
181 }
drhcb0e04f2018-12-12 21:34:17 +0000182 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000183 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
184 break;
185 }
drhae80dde2012-12-06 21:16:43 +0000186 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000187 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000188 p = p->pLeft;
189 }else{
drh2308ed32015-02-09 16:09:34 +0000190 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000191 /* The Expr.x union is never used at the same time as Expr.pRight */
192 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000193 if( p->x.pList!=0
194 && !db->mallocFailed
195 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
196 ){
drh2308ed32015-02-09 16:09:34 +0000197 int i;
drh95768022019-11-10 10:08:03 +0000198 for(i=0; i<p->x.pList->nExpr; i++){
drh2308ed32015-02-09 16:09:34 +0000199 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
200 pNext = p->x.pList->a[i].pExpr;
201 break;
202 }
203 }
204 }
205 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000206 }
207 }else{
drh7d10d5a2008-08-20 16:35:10 +0000208 break;
209 }
danielk19770202b292004-06-09 09:55:16 +0000210 }
danielk19777cedc8d2004-06-10 10:50:08 +0000211 if( sqlite3CheckCollSeq(pParse, pColl) ){
212 pColl = 0;
213 }
214 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000215}
216
217/*
drh70efa842017-09-28 01:58:23 +0000218** Return the collation sequence for the expression pExpr. If
219** there is no defined collating sequence, return a pointer to the
220** defautl collation sequence.
221**
222** See also: sqlite3ExprCollSeq()
223**
224** The sqlite3ExprCollSeq() routine works the same except that it
225** returns NULL if there is no defined collation.
226*/
227CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
228 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
229 if( p==0 ) p = pParse->db->pDfltColl;
230 assert( p!=0 );
231 return p;
232}
233
234/*
235** Return TRUE if the two expressions have equivalent collating sequences.
236*/
237int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
238 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
239 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
240 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
241}
242
243/*
drh626a8792005-01-17 22:08:19 +0000244** pExpr is an operand of a comparison operator. aff2 is the
245** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000246** type affinity that should be used for the comparison operator.
247*/
danielk1977e014a832004-05-17 10:48:57 +0000248char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000249 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000250 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000251 /* Both sides of the comparison are columns. If one has numeric
252 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000253 */
drh8a512562005-11-14 22:29:05 +0000254 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000255 return SQLITE_AFF_NUMERIC;
256 }else{
drh05883a32015-06-02 15:32:08 +0000257 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000258 }
danielk1977e014a832004-05-17 10:48:57 +0000259 }else{
260 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000261 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
262 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
264}
265
drh53db1452004-05-20 13:54:53 +0000266/*
267** pExpr is a comparison operator. Return the type affinity that should
268** be applied to both operands prior to doing the comparison.
269*/
danielk1977e014a832004-05-17 10:48:57 +0000270static char comparisonAffinity(Expr *pExpr){
271 char aff;
272 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000274 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000275 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000276 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000277 if( pExpr->pRight ){
278 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000279 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
280 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000281 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000282 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000283 }
284 return aff;
285}
286
287/*
288** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289** idx_affinity is the affinity of an indexed column. Return true
290** if the index with affinity idx_affinity may be used to implement
291** the comparison in pExpr.
292*/
293int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
294 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000295 if( aff<SQLITE_AFF_TEXT ){
296 return 1;
drh8a512562005-11-14 22:29:05 +0000297 }
drh915e4342019-08-06 15:18:15 +0000298 if( aff==SQLITE_AFF_TEXT ){
299 return idx_affinity==SQLITE_AFF_TEXT;
300 }
301 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000302}
303
danielk1977a37cdde2004-05-16 11:15:36 +0000304/*
drh35573352008-01-08 23:54:25 +0000305** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000306** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000307*/
drh35573352008-01-08 23:54:25 +0000308static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
309 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000310 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000311 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000312}
313
drha2e00042002-01-22 03:13:42 +0000314/*
danielk19770202b292004-06-09 09:55:16 +0000315** Return a pointer to the collation sequence that should be used by
316** a binary comparison operator comparing pLeft and pRight.
317**
318** If the left hand expression has a collating sequence type, then it is
319** used. Otherwise the collation sequence for the right hand expression
320** is used, or the default (BINARY) if neither expression has a collating
321** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000322**
323** Argument pRight (but not pLeft) may be a null pointer. In this case,
324** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000325*/
drh0a0e1312007-08-07 17:04:59 +0000326CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000327 Parse *pParse,
328 Expr *pLeft,
329 Expr *pRight
330){
drhec41dda2007-02-07 13:09:45 +0000331 CollSeq *pColl;
332 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000333 if( pLeft->flags & EP_Collate ){
334 pColl = sqlite3ExprCollSeq(pParse, pLeft);
335 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
336 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000337 }else{
338 pColl = sqlite3ExprCollSeq(pParse, pLeft);
339 if( !pColl ){
340 pColl = sqlite3ExprCollSeq(pParse, pRight);
341 }
danielk19770202b292004-06-09 09:55:16 +0000342 }
343 return pColl;
344}
345
drh898c5272019-10-22 00:03:41 +0000346/* Expresssion p is a comparison operator. Return a collation sequence
347** appropriate for the comparison operator.
348**
349** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
350** However, if the OP_Commuted flag is set, then the order of the operands
351** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
352** correct collating sequence is found.
353*/
354CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
355 if( ExprHasProperty(p, EP_Commuted) ){
356 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
357 }else{
358 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
359 }
360}
361
danielk19770202b292004-06-09 09:55:16 +0000362/*
drhbe5c89a2004-07-26 00:31:09 +0000363** Generate code for a comparison operator.
364*/
365static int codeCompare(
366 Parse *pParse, /* The parsing (and code generating) context */
367 Expr *pLeft, /* The left operand */
368 Expr *pRight, /* The right operand */
369 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000370 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000371 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000372 int jumpIfNull, /* If true, jump if either operand is NULL */
373 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000374){
drh35573352008-01-08 23:54:25 +0000375 int p5;
376 int addr;
377 CollSeq *p4;
378
drh86541862019-12-19 20:37:32 +0000379 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000380 if( isCommuted ){
381 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
382 }else{
383 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
384 }
drh35573352008-01-08 23:54:25 +0000385 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
386 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
387 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000388 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000389 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000390}
391
dancfbb5e82016-07-13 19:48:13 +0000392/*
dan870a0702016-08-01 16:37:43 +0000393** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000394**
395** A vector is defined as any expression that results in two or more
396** columns of result. Every TK_VECTOR node is an vector because the
397** parser will not generate a TK_VECTOR with fewer than two entries.
398** But a TK_SELECT might be either a vector or a scalar. It is only
399** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000400*/
401int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000402 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000403}
404
405/*
dancfbb5e82016-07-13 19:48:13 +0000406** If the expression passed as the only argument is of type TK_VECTOR
407** return the number of expressions in the vector. Or, if the expression
408** is a sub-select, return the number of columns in the sub-select. For
409** any other type of expression, return 1.
410*/
dan71c57db2016-07-09 20:23:55 +0000411int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000412 u8 op = pExpr->op;
413 if( op==TK_REGISTER ) op = pExpr->op2;
414 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000415 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000416 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000417 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000418 }else{
419 return 1;
dan71c57db2016-07-09 20:23:55 +0000420 }
dan71c57db2016-07-09 20:23:55 +0000421}
422
danba00e302016-07-23 20:24:06 +0000423/*
drhfc7f27b2016-08-20 00:07:01 +0000424** Return a pointer to a subexpression of pVector that is the i-th
425** column of the vector (numbered starting with 0). The caller must
426** ensure that i is within range.
427**
drh76dbe7a2016-08-20 21:02:38 +0000428** If pVector is really a scalar (and "scalar" here includes subqueries
429** that return a single column!) then return pVector unmodified.
430**
drhfc7f27b2016-08-20 00:07:01 +0000431** pVector retains ownership of the returned subexpression.
432**
433** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000434** just the expression for the i-th term of the result set, and may
435** not be ready for evaluation because the table cursor has not yet
436** been positioned.
danba00e302016-07-23 20:24:06 +0000437*/
drhfc7f27b2016-08-20 00:07:01 +0000438Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000439 assert( i<sqlite3ExprVectorSize(pVector) );
440 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000441 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
442 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000443 return pVector->x.pSelect->pEList->a[i].pExpr;
444 }else{
445 return pVector->x.pList->a[i].pExpr;
446 }
dan71c57db2016-07-09 20:23:55 +0000447 }
dan870a0702016-08-01 16:37:43 +0000448 return pVector;
dan71c57db2016-07-09 20:23:55 +0000449}
drhfc7f27b2016-08-20 00:07:01 +0000450
drhfc7f27b2016-08-20 00:07:01 +0000451/*
452** Compute and return a new Expr object which when passed to
453** sqlite3ExprCode() will generate all necessary code to compute
454** the iField-th column of the vector expression pVector.
455**
drh8762ec12016-08-20 01:06:22 +0000456** It is ok for pVector to be a scalar (as long as iField==0).
457** In that case, this routine works like sqlite3ExprDup().
458**
drhfc7f27b2016-08-20 00:07:01 +0000459** The caller owns the returned Expr object and is responsible for
460** ensuring that the returned value eventually gets freed.
461**
drh8762ec12016-08-20 01:06:22 +0000462** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000463** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000464** valid for the life of the returned object. If pVector is a TK_VECTOR
465** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000466** returns.
drh8762ec12016-08-20 01:06:22 +0000467**
468** A trick to cause a TK_SELECT pVector to be deleted together with
469** the returned Expr object is to attach the pVector to the pRight field
470** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000471*/
472Expr *sqlite3ExprForVectorField(
473 Parse *pParse, /* Parsing context */
474 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000475 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000476){
477 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000478 if( pVector->op==TK_SELECT ){
479 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000480 /* The TK_SELECT_COLUMN Expr node:
481 **
drh966e2912017-01-03 02:58:01 +0000482 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000483 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000484 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000485 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000486 ** pLeft->iTable: First in an array of register holding result, or 0
487 ** if the result is not yet computed.
488 **
489 ** sqlite3ExprDelete() specifically skips the recursive delete of
490 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000491 ** can be attached to pRight to cause this node to take ownership of
492 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
493 ** with the same pLeft pointer to the pVector, but only one of them
494 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000495 */
drhabfd35e2016-12-06 22:47:23 +0000496 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000497 if( pRet ){
498 pRet->iColumn = iField;
499 pRet->pLeft = pVector;
500 }
drhfc7f27b2016-08-20 00:07:01 +0000501 assert( pRet==0 || pRet->iTable==0 );
502 }else{
drha1251bc2016-08-20 00:51:37 +0000503 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
504 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000505 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000506 }
507 return pRet;
508}
dan71c57db2016-07-09 20:23:55 +0000509
dan5c288b92016-07-30 21:02:33 +0000510/*
511** If expression pExpr is of type TK_SELECT, generate code to evaluate
512** it. Return the register in which the result is stored (or, if the
513** sub-select returns more than one column, the first in an array
514** of registers in which the result is stored).
515**
516** If pExpr is not a TK_SELECT expression, return 0.
517*/
518static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000519 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000520#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000521 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000522 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000523 }
danf9b2e052016-08-02 17:45:00 +0000524#endif
dan8da209b2016-07-26 18:06:08 +0000525 return reg;
526}
527
dan5c288b92016-07-30 21:02:33 +0000528/*
529** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000530** or TK_SELECT that returns more than one column. This function returns
531** the register number of a register that contains the value of
532** element iField of the vector.
533**
534** If pVector is a TK_SELECT expression, then code for it must have
535** already been generated using the exprCodeSubselect() routine. In this
536** case parameter regSelect should be the first in an array of registers
537** containing the results of the sub-select.
538**
539** If pVector is of type TK_VECTOR, then code for the requested field
540** is generated. In this case (*pRegFree) may be set to the number of
541** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000542**
543** Before returning, output parameter (*ppExpr) is set to point to the
544** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000545*/
546static int exprVectorRegister(
547 Parse *pParse, /* Parse context */
548 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000549 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000550 int regSelect, /* First in array of registers */
551 Expr **ppExpr, /* OUT: Expression element */
552 int *pRegFree /* OUT: Temp register to free */
553){
drh12abf402016-08-22 14:30:05 +0000554 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000555 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000556 if( op==TK_REGISTER ){
557 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
558 return pVector->iTable+iField;
559 }
560 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000561 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
562 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000563 }
dan870a0702016-08-01 16:37:43 +0000564 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000565 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
566}
567
568/*
569** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000570** the result of the comparison (1, 0, or NULL) and write that
571** result into register dest.
572**
573** The caller must satisfy the following preconditions:
574**
575** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
576** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
577** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000578*/
drh79752b62016-08-13 10:02:17 +0000579static void codeVectorCompare(
580 Parse *pParse, /* Code generator context */
581 Expr *pExpr, /* The comparison operation */
582 int dest, /* Write results into this register */
583 u8 op, /* Comparison operator */
584 u8 p5 /* SQLITE_NULLEQ or zero */
585){
dan71c57db2016-07-09 20:23:55 +0000586 Vdbe *v = pParse->pVdbe;
587 Expr *pLeft = pExpr->pLeft;
588 Expr *pRight = pExpr->pRight;
589 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000590 int i;
591 int regLeft = 0;
592 int regRight = 0;
593 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000594 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000595 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000596
drh70d6b832019-12-30 23:50:19 +0000597 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000598 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
599 sqlite3ErrorMsg(pParse, "row value misused");
600 return;
601 }
drhb29e60c2016-09-05 12:02:34 +0000602 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
603 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
604 || pExpr->op==TK_LT || pExpr->op==TK_GT
605 || pExpr->op==TK_LE || pExpr->op==TK_GE
606 );
607 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
608 || (pExpr->op==TK_ISNOT && op==TK_NE) );
609 assert( p5==0 || pExpr->op!=op );
610 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000611
drhb29e60c2016-09-05 12:02:34 +0000612 p5 |= SQLITE_STOREP2;
613 if( opx==TK_LE ) opx = TK_LT;
614 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000615
drhb29e60c2016-09-05 12:02:34 +0000616 regLeft = exprCodeSubselect(pParse, pLeft);
617 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000618
drhb29e60c2016-09-05 12:02:34 +0000619 for(i=0; 1 /*Loop exits by "break"*/; i++){
620 int regFree1 = 0, regFree2 = 0;
621 Expr *pL, *pR;
622 int r1, r2;
623 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000624 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
625 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000626 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000627 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
628 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
629 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
630 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
631 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
632 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
633 sqlite3ReleaseTempReg(pParse, regFree1);
634 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000635 if( i==nLeft-1 ){
636 break;
dan71c57db2016-07-09 20:23:55 +0000637 }
drhb29e60c2016-09-05 12:02:34 +0000638 if( opx==TK_EQ ){
639 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
640 p5 |= SQLITE_KEEPNULL;
641 }else if( opx==TK_NE ){
642 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
643 p5 |= SQLITE_KEEPNULL;
644 }else{
645 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
646 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
647 VdbeCoverageIf(v, op==TK_LT);
648 VdbeCoverageIf(v, op==TK_GT);
649 VdbeCoverageIf(v, op==TK_LE);
650 VdbeCoverageIf(v, op==TK_GE);
651 if( i==nLeft-2 ) opx = op;
652 }
dan71c57db2016-07-09 20:23:55 +0000653 }
drhb29e60c2016-09-05 12:02:34 +0000654 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000655}
656
danielk19774b5255a2008-06-05 16:47:39 +0000657#if SQLITE_MAX_EXPR_DEPTH>0
658/*
659** Check that argument nHeight is less than or equal to the maximum
660** expression depth allowed. If it is not, leave an error message in
661** pParse.
662*/
drh7d10d5a2008-08-20 16:35:10 +0000663int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000664 int rc = SQLITE_OK;
665 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
666 if( nHeight>mxHeight ){
667 sqlite3ErrorMsg(pParse,
668 "Expression tree is too large (maximum depth %d)", mxHeight
669 );
670 rc = SQLITE_ERROR;
671 }
672 return rc;
673}
674
675/* The following three functions, heightOfExpr(), heightOfExprList()
676** and heightOfSelect(), are used to determine the maximum height
677** of any expression tree referenced by the structure passed as the
678** first argument.
679**
680** If this maximum height is greater than the current value pointed
681** to by pnHeight, the second parameter, then set *pnHeight to that
682** value.
683*/
684static void heightOfExpr(Expr *p, int *pnHeight){
685 if( p ){
686 if( p->nHeight>*pnHeight ){
687 *pnHeight = p->nHeight;
688 }
689 }
690}
691static void heightOfExprList(ExprList *p, int *pnHeight){
692 if( p ){
693 int i;
694 for(i=0; i<p->nExpr; i++){
695 heightOfExpr(p->a[i].pExpr, pnHeight);
696 }
697 }
698}
dan1a3a3082018-01-18 19:00:54 +0000699static void heightOfSelect(Select *pSelect, int *pnHeight){
700 Select *p;
701 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000702 heightOfExpr(p->pWhere, pnHeight);
703 heightOfExpr(p->pHaving, pnHeight);
704 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000705 heightOfExprList(p->pEList, pnHeight);
706 heightOfExprList(p->pGroupBy, pnHeight);
707 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000708 }
709}
710
711/*
712** Set the Expr.nHeight variable in the structure passed as an
713** argument. An expression with no children, Expr.pList or
714** Expr.pSelect member has a height of 1. Any other expression
715** has a height equal to the maximum height of any other
716** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000717**
718** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
719** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000720*/
721static void exprSetHeight(Expr *p){
722 int nHeight = 0;
723 heightOfExpr(p->pLeft, &nHeight);
724 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000725 if( ExprHasProperty(p, EP_xIsSelect) ){
726 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000727 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000728 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000729 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000730 }
danielk19774b5255a2008-06-05 16:47:39 +0000731 p->nHeight = nHeight + 1;
732}
733
734/*
735** Set the Expr.nHeight variable using the exprSetHeight() function. If
736** the height is greater than the maximum allowed expression depth,
737** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000738**
739** Also propagate all EP_Propagate flags from the Expr.x.pList into
740** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000741*/
drh2308ed32015-02-09 16:09:34 +0000742void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000743 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000744 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000745 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000746}
747
748/*
749** Return the maximum height of any expression tree referenced
750** by the select statement passed as an argument.
751*/
752int sqlite3SelectExprHeight(Select *p){
753 int nHeight = 0;
754 heightOfSelect(p, &nHeight);
755 return nHeight;
756}
drh2308ed32015-02-09 16:09:34 +0000757#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
758/*
759** Propagate all EP_Propagate flags from the Expr.x.pList into
760** Expr.flags.
761*/
762void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
763 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
764 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
765 }
766}
767#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000768#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
769
drhbe5c89a2004-07-26 00:31:09 +0000770/*
drhb7916a72009-05-27 10:31:29 +0000771** This routine is the core allocator for Expr nodes.
772**
drha76b5df2002-02-23 02:32:10 +0000773** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000774** for this node and for the pToken argument is a single allocation
775** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000776** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000777**
778** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000779** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000780** parameter is ignored if pToken is NULL or if the token does not
781** appear to be quoted. If the quotes were of the form "..." (double-quotes)
782** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000783**
784** Special case: If op==TK_INTEGER and pToken points to a string that
785** can be translated into a 32-bit integer, then the token is not
786** stored in u.zToken. Instead, the integer values is written
787** into u.iValue and the EP_IntValue flag is set. No extra storage
788** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000789*/
drhb7916a72009-05-27 10:31:29 +0000790Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000791 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000792 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000793 const Token *pToken, /* Token argument. Might be NULL */
794 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000795){
drha76b5df2002-02-23 02:32:10 +0000796 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000797 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000798 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000799
drh575fad62016-02-05 13:38:36 +0000800 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000801 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000802 if( op!=TK_INTEGER || pToken->z==0
803 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
804 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000805 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000806 }
drhb7916a72009-05-27 10:31:29 +0000807 }
drh575fad62016-02-05 13:38:36 +0000808 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000809 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000810 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000811 pNew->op = (u8)op;
812 pNew->iAgg = -1;
813 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000814 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000815 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000816 pNew->u.iValue = iValue;
817 }else{
drh33e619f2009-05-28 01:00:55 +0000818 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000819 assert( pToken->z!=0 || pToken->n==0 );
820 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000821 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000822 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000823 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000824 }
drhb7916a72009-05-27 10:31:29 +0000825 }
826 }
827#if SQLITE_MAX_EXPR_DEPTH>0
828 pNew->nHeight = 1;
829#endif
830 }
drha76b5df2002-02-23 02:32:10 +0000831 return pNew;
832}
833
834/*
drhb7916a72009-05-27 10:31:29 +0000835** Allocate a new expression node from a zero-terminated token that has
836** already been dequoted.
837*/
838Expr *sqlite3Expr(
839 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
840 int op, /* Expression opcode */
841 const char *zToken /* Token argument. Might be NULL */
842){
843 Token x;
844 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000845 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000846 return sqlite3ExprAlloc(db, op, &x, 0);
847}
848
849/*
850** Attach subtrees pLeft and pRight to the Expr node pRoot.
851**
852** If pRoot==NULL that means that a memory allocation error has occurred.
853** In that case, delete the subtrees pLeft and pRight.
854*/
855void sqlite3ExprAttachSubtrees(
856 sqlite3 *db,
857 Expr *pRoot,
858 Expr *pLeft,
859 Expr *pRight
860){
861 if( pRoot==0 ){
862 assert( db->mallocFailed );
863 sqlite3ExprDelete(db, pLeft);
864 sqlite3ExprDelete(db, pRight);
865 }else{
866 if( pRight ){
867 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000868 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000869 }
870 if( pLeft ){
871 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000872 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000873 }
874 exprSetHeight(pRoot);
875 }
876}
877
878/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000879** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000880**
drhbf664462009-06-19 18:32:54 +0000881** One or both of the subtrees can be NULL. Return a pointer to the new
882** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
883** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000884*/
drh17435752007-08-16 04:30:38 +0000885Expr *sqlite3PExpr(
886 Parse *pParse, /* Parsing context */
887 int op, /* Expression opcode */
888 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000889 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000890){
drh5fb52ca2012-03-31 02:34:35 +0000891 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000892 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
893 if( p ){
894 memset(p, 0, sizeof(Expr));
895 p->op = op & 0xff;
896 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000897 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000898 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000899 }else{
900 sqlite3ExprDelete(pParse->db, pLeft);
901 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000902 }
drh4e0cff62004-11-05 05:10:28 +0000903 return p;
904}
905
906/*
drh08de4f72016-04-11 01:06:47 +0000907** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
908** do a memory allocation failure) then delete the pSelect object.
909*/
910void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
911 if( pExpr ){
912 pExpr->x.pSelect = pSelect;
913 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
914 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
915 }else{
916 assert( pParse->db->mallocFailed );
917 sqlite3SelectDelete(pParse->db, pSelect);
918 }
919}
920
921
922/*
drh91bb0ee2004-09-01 03:06:34 +0000923** Join two expressions using an AND operator. If either expression is
924** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000925**
926** If one side or the other of the AND is known to be false, then instead
927** of returning an AND expression, just return a constant expression with
928** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000929*/
drhd5c851c2019-04-19 13:38:34 +0000930Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
931 sqlite3 *db = pParse->db;
932 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000933 return pRight;
934 }else if( pRight==0 ){
935 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000936 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
937 && !IN_RENAME_OBJECT
938 ){
939 sqlite3ExprDelete(db, pLeft);
940 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000941 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000942 }else{
drhd5c851c2019-04-19 13:38:34 +0000943 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000944 }
945}
946
947/*
948** Construct a new expression node for a function with multiple
949** arguments.
950*/
drh954733b2018-07-27 23:33:16 +0000951Expr *sqlite3ExprFunction(
952 Parse *pParse, /* Parsing context */
953 ExprList *pList, /* Argument list */
954 Token *pToken, /* Name of the function */
955 int eDistinct /* SF_Distinct or SF_ALL or 0 */
956){
drha76b5df2002-02-23 02:32:10 +0000957 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000958 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000959 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000960 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000961 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000962 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000963 return 0;
964 }
drh954733b2018-07-27 23:33:16 +0000965 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
966 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
967 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000968 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000969 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000970 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000971 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000972 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000973 return pNew;
974}
975
976/*
drh0dfa5252020-01-08 17:28:19 +0000977** Check to see if a function is usable according to current access
978** rules:
979**
980** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
981**
982** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
983** top-level SQL
984**
985** If the function is not usable, create an error.
986*/
987void sqlite3ExprFunctionUsable(
988 Parse *pParse, /* Parsing and code generating context */
989 Expr *pExpr, /* The function invocation */
990 FuncDef *pDef /* The function being invoked */
991){
992 assert( !IN_RENAME_OBJECT );
993 if( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0
994 && ExprHasProperty(pExpr, EP_FromDDL)
995 ){
996 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
997 || (pParse->db->flags & SQLITE_TrustedSchema)==0
998 ){
999 /* Functions prohibited in triggers and views if:
1000 ** (1) tagged with SQLITE_DIRECTONLY
1001 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1002 ** is tagged with SQLITE_FUNC_UNSAFE) and
1003 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1004 ** that the schema is possibly tainted).
1005 */
1006 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1007 }
1008 }
1009}
1010
1011/*
drhfa6bc002004-09-07 16:19:52 +00001012** Assign a variable number to an expression that encodes a wildcard
1013** in the original SQL statement.
1014**
1015** Wildcards consisting of a single "?" are assigned the next sequential
1016** variable number.
1017**
1018** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001019** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001020** the SQL statement comes from an external source.
1021**
drh51f49f12009-05-21 20:41:32 +00001022** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001023** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001024** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001025** assigned.
1026*/
drhde25a882016-10-03 15:28:24 +00001027void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001028 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001029 const char *z;
drhf326d662016-12-23 13:30:53 +00001030 ynVar x;
drh17435752007-08-16 04:30:38 +00001031
drhfa6bc002004-09-07 16:19:52 +00001032 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001033 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001034 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001035 assert( z!=0 );
1036 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001037 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001038 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001039 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001040 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001041 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001042 }else{
drhf326d662016-12-23 13:30:53 +00001043 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001044 if( z[0]=='?' ){
1045 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1046 ** use it as the variable number */
1047 i64 i;
drh18814df2017-01-31 03:52:34 +00001048 int bOk;
1049 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1050 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1051 bOk = 1;
1052 }else{
1053 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1054 }
drh124c0b42011-06-01 18:15:55 +00001055 testcase( i==0 );
1056 testcase( i==1 );
1057 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1058 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1059 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1060 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1061 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001062 return;
drhfa6bc002004-09-07 16:19:52 +00001063 }
drh8e74e7b2017-01-31 12:41:48 +00001064 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001065 if( x>pParse->nVar ){
1066 pParse->nVar = (int)x;
1067 doAdd = 1;
1068 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1069 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001070 }
1071 }else{
1072 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1073 ** number as the prior appearance of the same name, or if the name
1074 ** has never appeared before, reuse the same variable number
1075 */
drh9bf755c2016-12-23 03:59:31 +00001076 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1077 if( x==0 ){
1078 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001079 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001080 }
drhfa6bc002004-09-07 16:19:52 +00001081 }
drhf326d662016-12-23 13:30:53 +00001082 if( doAdd ){
1083 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1084 }
1085 }
1086 pExpr->iColumn = x;
1087 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001088 sqlite3ErrorMsg(pParse, "too many SQL variables");
1089 }
drhfa6bc002004-09-07 16:19:52 +00001090}
1091
1092/*
danf6963f92009-11-23 14:39:14 +00001093** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001094*/
drh4f0010b2016-04-11 14:49:39 +00001095static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1096 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001097 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1098 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001099
1100 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1101 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001102 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001103#ifdef SQLITE_DEBUG
1104 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1105 assert( p->pLeft==0 );
1106 assert( p->pRight==0 );
1107 assert( p->x.pSelect==0 );
1108 }
1109#endif
1110 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001111 /* The Expr.x union is never used at the same time as Expr.pRight */
1112 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001113 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001114 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001115 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001116 sqlite3ExprDeleteNN(db, p->pRight);
1117 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001118 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001119 sqlite3SelectDelete(db, p->x.pSelect);
1120 }else{
1121 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001122#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001123 if( ExprHasProperty(p, EP_WinFunc) ){
1124 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001125 }
dan6ba7ab02019-07-02 11:56:47 +00001126#endif
dan8117f112019-07-10 20:16:53 +00001127 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 }
drh209bc522016-09-23 21:36:24 +00001129 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001130 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001131 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001132 }
drha2e00042002-01-22 03:13:42 +00001133}
drh4f0010b2016-04-11 14:49:39 +00001134void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1135 if( p ) sqlite3ExprDeleteNN(db, p);
1136}
drha2e00042002-01-22 03:13:42 +00001137
drh8e34e402019-06-11 10:43:56 +00001138/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1139** expression.
1140*/
1141void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1142 if( p ){
1143 if( IN_RENAME_OBJECT ){
1144 sqlite3RenameExprUnmap(pParse, p);
1145 }
1146 sqlite3ExprDeleteNN(pParse->db, p);
1147 }
1148}
1149
drhd2687b72005-08-12 22:56:09 +00001150/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001151** Return the number of bytes allocated for the expression structure
1152** passed as the first argument. This is always one of EXPR_FULLSIZE,
1153** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1154*/
1155static int exprStructSize(Expr *p){
1156 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001157 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1158 return EXPR_FULLSIZE;
1159}
1160
1161/*
drh33e619f2009-05-28 01:00:55 +00001162** The dupedExpr*Size() routines each return the number of bytes required
1163** to store a copy of an expression or expression tree. They differ in
1164** how much of the tree is measured.
1165**
1166** dupedExprStructSize() Size of only the Expr structure
1167** dupedExprNodeSize() Size of Expr + space for token
1168** dupedExprSize() Expr + token + subtree components
1169**
1170***************************************************************************
1171**
1172** The dupedExprStructSize() function returns two values OR-ed together:
1173** (1) the space required for a copy of the Expr structure only and
1174** (2) the EP_xxx flags that indicate what the structure size should be.
1175** The return values is always one of:
1176**
1177** EXPR_FULLSIZE
1178** EXPR_REDUCEDSIZE | EP_Reduced
1179** EXPR_TOKENONLYSIZE | EP_TokenOnly
1180**
1181** The size of the structure can be found by masking the return value
1182** of this routine with 0xfff. The flags can be found by masking the
1183** return value with EP_Reduced|EP_TokenOnly.
1184**
1185** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1186** (unreduced) Expr objects as they or originally constructed by the parser.
1187** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001188** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001189** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001190** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001191** to reduce a pristine expression tree from the parser. The implementation
1192** of dupedExprStructSize() contain multiple assert() statements that attempt
1193** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001194*/
1195static int dupedExprStructSize(Expr *p, int flags){
1196 int nSize;
drh33e619f2009-05-28 01:00:55 +00001197 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001198 assert( EXPR_FULLSIZE<=0xfff );
1199 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001200 if( 0==flags || p->op==TK_SELECT_COLUMN
1201#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001202 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001203#endif
1204 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001205 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001206 }else{
drhc5cd1242013-09-12 16:50:49 +00001207 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001208 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001209 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001210 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001211 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001212 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1213 }else{
drhaecd8022013-09-13 18:15:15 +00001214 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001215 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1216 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001217 }
1218 return nSize;
1219}
1220
1221/*
drh33e619f2009-05-28 01:00:55 +00001222** This function returns the space in bytes required to store the copy
1223** of the Expr structure and a copy of the Expr.u.zToken string (if that
1224** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001225*/
1226static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001227 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1228 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001229 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001230 }
danielk1977bc739712009-03-23 04:33:32 +00001231 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001232}
1233
1234/*
1235** Return the number of bytes required to create a duplicate of the
1236** expression passed as the first argument. The second argument is a
1237** mask containing EXPRDUP_XXX flags.
1238**
1239** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001240** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001241**
1242** If the EXPRDUP_REDUCE flag is set, then the return value includes
1243** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1244** and Expr.pRight variables (but not for any structures pointed to or
1245** descended from the Expr.x.pList or Expr.x.pSelect variables).
1246*/
1247static int dupedExprSize(Expr *p, int flags){
1248 int nByte = 0;
1249 if( p ){
1250 nByte = dupedExprNodeSize(p, flags);
1251 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001252 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001253 }
1254 }
1255 return nByte;
1256}
1257
1258/*
1259** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1260** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001261** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001262** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001263** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001264** portion of the buffer copied into by this function.
1265*/
drh3c194692016-04-11 16:43:43 +00001266static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1267 Expr *pNew; /* Value to return */
1268 u8 *zAlloc; /* Memory space from which to build Expr object */
1269 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1270
drh575fad62016-02-05 13:38:36 +00001271 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001272 assert( p );
1273 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1274 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001275
drh3c194692016-04-11 16:43:43 +00001276 /* Figure out where to write the new Expr structure. */
1277 if( pzBuffer ){
1278 zAlloc = *pzBuffer;
1279 staticFlag = EP_Static;
1280 }else{
1281 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1282 staticFlag = 0;
1283 }
1284 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001285
drh3c194692016-04-11 16:43:43 +00001286 if( pNew ){
1287 /* Set nNewSize to the size allocated for the structure pointed to
1288 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1289 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1290 ** by the copy of the p->u.zToken string (if any).
1291 */
1292 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1293 const int nNewSize = nStructSize & 0xfff;
1294 int nToken;
1295 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1296 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001297 }else{
drh3c194692016-04-11 16:43:43 +00001298 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001299 }
drh3c194692016-04-11 16:43:43 +00001300 if( dupFlags ){
1301 assert( ExprHasProperty(p, EP_Reduced)==0 );
1302 memcpy(zAlloc, p, nNewSize);
1303 }else{
1304 u32 nSize = (u32)exprStructSize(p);
1305 memcpy(zAlloc, p, nSize);
1306 if( nSize<EXPR_FULLSIZE ){
1307 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1308 }
1309 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001310
drh3c194692016-04-11 16:43:43 +00001311 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1312 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1313 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1314 pNew->flags |= staticFlag;
1315
1316 /* Copy the p->u.zToken string, if any. */
1317 if( nToken ){
1318 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1319 memcpy(zToken, p->u.zToken, nToken);
1320 }
1321
drh209bc522016-09-23 21:36:24 +00001322 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001323 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1324 if( ExprHasProperty(p, EP_xIsSelect) ){
1325 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001326 }else{
drh3c194692016-04-11 16:43:43 +00001327 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001328 }
drh3c194692016-04-11 16:43:43 +00001329 }
1330
1331 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001332 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001333 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001334 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001335 pNew->pLeft = p->pLeft ?
1336 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1337 pNew->pRight = p->pRight ?
1338 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001339 }
dan67a9b8e2018-06-22 20:51:35 +00001340#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001341 if( ExprHasProperty(p, EP_WinFunc) ){
1342 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1343 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001344 }
dan67a9b8e2018-06-22 20:51:35 +00001345#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001346 if( pzBuffer ){
1347 *pzBuffer = zAlloc;
1348 }
1349 }else{
drh209bc522016-09-23 21:36:24 +00001350 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001351 if( pNew->op==TK_SELECT_COLUMN ){
1352 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001353 assert( p->iColumn==0 || p->pRight==0 );
1354 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001355 }else{
1356 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1357 }
drh3c194692016-04-11 16:43:43 +00001358 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001359 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001360 }
1361 }
1362 return pNew;
1363}
1364
1365/*
danbfe31e72014-01-15 14:17:31 +00001366** Create and return a deep copy of the object passed as the second
1367** argument. If an OOM condition is encountered, NULL is returned
1368** and the db->mallocFailed flag set.
1369*/
daneede6a52014-01-15 19:42:23 +00001370#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001371static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001372 With *pRet = 0;
1373 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001374 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001375 pRet = sqlite3DbMallocZero(db, nByte);
1376 if( pRet ){
1377 int i;
1378 pRet->nCte = p->nCte;
1379 for(i=0; i<p->nCte; i++){
1380 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1381 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1382 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1383 }
1384 }
1385 }
1386 return pRet;
1387}
daneede6a52014-01-15 19:42:23 +00001388#else
1389# define withDup(x,y) 0
1390#endif
dan4e9119d2014-01-13 15:12:23 +00001391
drha8389972018-12-06 22:04:19 +00001392#ifndef SQLITE_OMIT_WINDOWFUNC
1393/*
1394** The gatherSelectWindows() procedure and its helper routine
1395** gatherSelectWindowsCallback() are used to scan all the expressions
1396** an a newly duplicated SELECT statement and gather all of the Window
1397** objects found there, assembling them onto the linked list at Select->pWin.
1398*/
1399static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001400 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001401 Select *pSelect = pWalker->u.pSelect;
1402 Window *pWin = pExpr->y.pWin;
1403 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001404 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001405 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001406 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001407 }
1408 return WRC_Continue;
1409}
drha37b6a52018-12-06 22:12:18 +00001410static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1411 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1412}
drha8389972018-12-06 22:04:19 +00001413static void gatherSelectWindows(Select *p){
1414 Walker w;
1415 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001416 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1417 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001418 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001419 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001420 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001421}
1422#endif
1423
1424
drha76b5df2002-02-23 02:32:10 +00001425/*
drhff78bd22002-02-27 01:47:11 +00001426** The following group of routines make deep copies of expressions,
1427** expression lists, ID lists, and select statements. The copies can
1428** be deleted (by being passed to their respective ...Delete() routines)
1429** without effecting the originals.
1430**
danielk19774adee202004-05-08 08:23:19 +00001431** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1432** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001433** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001434**
drhad3cab52002-05-24 02:04:32 +00001435** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001436**
drhb7916a72009-05-27 10:31:29 +00001437** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001438** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1439** truncated version of the usual Expr structure that will be stored as
1440** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001441*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001442Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001443 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001444 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001445}
danielk19776ab3a2e2009-02-19 14:39:25 +00001446ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001447 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001448 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001449 int i;
drhb1637482017-01-03 00:27:16 +00001450 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001451 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001452 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001453 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001454 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001455 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001456 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001457 pOldItem = p->a;
1458 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001459 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001460 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001461 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001462 if( pOldExpr
1463 && pOldExpr->op==TK_SELECT_COLUMN
1464 && (pNewExpr = pItem->pExpr)!=0
1465 ){
1466 assert( pNewExpr->iColumn==0 || i>0 );
1467 if( pNewExpr->iColumn==0 ){
1468 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001469 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1470 }else{
1471 assert( i>0 );
1472 assert( pItem[-1].pExpr!=0 );
1473 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1474 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1475 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001476 }
1477 }
drh41cee662019-12-12 20:22:34 +00001478 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001479 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001480 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001481 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001482 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001483 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001484 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001485 }
1486 return pNew;
1487}
danielk197793758c82005-01-21 08:13:14 +00001488
1489/*
1490** If cursors, triggers, views and subqueries are all omitted from
1491** the build, then none of the following routines, except for
1492** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1493** called with a NULL argument.
1494*/
danielk19776a67fe82005-02-04 04:07:16 +00001495#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1496 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001497SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001498 SrcList *pNew;
1499 int i;
drh113088e2003-03-20 01:16:58 +00001500 int nByte;
drh575fad62016-02-05 13:38:36 +00001501 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001502 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001503 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001504 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001505 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001506 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001507 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001508 struct SrcList_item *pNewItem = &pNew->a[i];
1509 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001510 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001511 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001512 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1513 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1514 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001515 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001516 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001517 pNewItem->addrFillSub = pOldItem->addrFillSub;
1518 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001519 if( pNewItem->fg.isIndexedBy ){
1520 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1521 }
1522 pNewItem->pIBIndex = pOldItem->pIBIndex;
1523 if( pNewItem->fg.isTabFunc ){
1524 pNewItem->u1.pFuncArg =
1525 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1526 }
drhed8a3bb2005-06-06 21:19:56 +00001527 pTab = pNewItem->pTab = pOldItem->pTab;
1528 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001529 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001530 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001531 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1532 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001533 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001534 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001535 }
1536 return pNew;
1537}
drh17435752007-08-16 04:30:38 +00001538IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001539 IdList *pNew;
1540 int i;
drh575fad62016-02-05 13:38:36 +00001541 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001542 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001543 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001544 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001545 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001546 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001547 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001548 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001549 return 0;
1550 }
drh6c535152012-02-02 03:38:30 +00001551 /* Note that because the size of the allocation for p->a[] is not
1552 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1553 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001554 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001555 struct IdList_item *pNewItem = &pNew->a[i];
1556 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001557 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001558 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001559 }
1560 return pNew;
1561}
dana7466202017-02-03 14:44:52 +00001562Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1563 Select *pRet = 0;
1564 Select *pNext = 0;
1565 Select **pp = &pRet;
1566 Select *p;
1567
drh575fad62016-02-05 13:38:36 +00001568 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001569 for(p=pDup; p; p=p->pPrior){
1570 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1571 if( pNew==0 ) break;
1572 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1573 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1574 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1575 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1576 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1577 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1578 pNew->op = p->op;
1579 pNew->pNext = pNext;
1580 pNew->pPrior = 0;
1581 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001582 pNew->iLimit = 0;
1583 pNew->iOffset = 0;
1584 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1585 pNew->addrOpenEphm[0] = -1;
1586 pNew->addrOpenEphm[1] = -1;
1587 pNew->nSelectRow = p->nSelectRow;
1588 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001589#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001590 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001591 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001592 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001593#endif
drhfef37762018-07-10 19:48:35 +00001594 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001595 *pp = pNew;
1596 pp = &pNew->pPrior;
1597 pNext = pNew;
1598 }
1599
1600 return pRet;
drhff78bd22002-02-27 01:47:11 +00001601}
danielk197793758c82005-01-21 08:13:14 +00001602#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001603Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001604 assert( p==0 );
1605 return 0;
1606}
1607#endif
drhff78bd22002-02-27 01:47:11 +00001608
1609
1610/*
drha76b5df2002-02-23 02:32:10 +00001611** Add a new element to the end of an expression list. If pList is
1612** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001613**
drha19543f2017-09-15 15:17:48 +00001614** The pList argument must be either NULL or a pointer to an ExprList
1615** obtained from a prior call to sqlite3ExprListAppend(). This routine
1616** may not be used with an ExprList obtained from sqlite3ExprListDup().
1617** Reason: This routine assumes that the number of slots in pList->a[]
1618** is a power of two. That is true for sqlite3ExprListAppend() returns
1619** but is not necessarily true from the return value of sqlite3ExprListDup().
1620**
drhb7916a72009-05-27 10:31:29 +00001621** If a memory allocation error occurs, the entire list is freed and
1622** NULL is returned. If non-NULL is returned, then it is guaranteed
1623** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001624*/
drh17435752007-08-16 04:30:38 +00001625ExprList *sqlite3ExprListAppend(
1626 Parse *pParse, /* Parsing context */
1627 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001628 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001629){
drh43606172017-04-05 11:32:13 +00001630 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001631 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001632 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001633 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001634 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001635 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001636 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001637 }
drhc263f7c2016-01-18 13:18:54 +00001638 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001639 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001640 ExprList *pNew;
1641 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001642 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001643 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001644 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001645 }
drh43606172017-04-05 11:32:13 +00001646 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001647 }
drh43606172017-04-05 11:32:13 +00001648 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001649 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001650 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001651 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001652 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001653 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001654
1655no_mem:
1656 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001657 sqlite3ExprDelete(db, pExpr);
1658 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001659 return 0;
drha76b5df2002-02-23 02:32:10 +00001660}
1661
1662/*
drh8762ec12016-08-20 01:06:22 +00001663** pColumns and pExpr form a vector assignment which is part of the SET
1664** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001665**
1666** (a,b,c) = (expr1,expr2,expr3)
1667** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1668**
1669** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001670** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001671** TK_SELECT_COLUMN expressions.
1672*/
1673ExprList *sqlite3ExprListAppendVector(
1674 Parse *pParse, /* Parsing context */
1675 ExprList *pList, /* List to which to append. Might be NULL */
1676 IdList *pColumns, /* List of names of LHS of the assignment */
1677 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1678){
1679 sqlite3 *db = pParse->db;
1680 int n;
1681 int i;
drh66860af2016-08-23 18:30:10 +00001682 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001683 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1684 ** exit prior to this routine being invoked */
1685 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001686 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001687
1688 /* If the RHS is a vector, then we can immediately check to see that
1689 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1690 ** wildcards ("*") in the result set of the SELECT must be expanded before
1691 ** we can do the size check, so defer the size check until code generation.
1692 */
1693 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001694 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1695 pColumns->nId, n);
1696 goto vector_append_error;
1697 }
drh966e2912017-01-03 02:58:01 +00001698
1699 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001700 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001701 assert( pSubExpr!=0 || db->mallocFailed );
1702 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1703 if( pSubExpr==0 ) continue;
1704 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001705 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1706 if( pList ){
drh66860af2016-08-23 18:30:10 +00001707 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001708 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001709 pColumns->a[i].zName = 0;
1710 }
1711 }
drh966e2912017-01-03 02:58:01 +00001712
drhffe28052017-05-06 18:09:36 +00001713 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001714 Expr *pFirst = pList->a[iFirst].pExpr;
1715 assert( pFirst!=0 );
1716 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001717
drhf4dd26c2017-04-05 11:49:06 +00001718 /* Store the SELECT statement in pRight so it will be deleted when
1719 ** sqlite3ExprListDelete() is called */
1720 pFirst->pRight = pExpr;
1721 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001722
drhf4dd26c2017-04-05 11:49:06 +00001723 /* Remember the size of the LHS in iTable so that we can check that
1724 ** the RHS and LHS sizes match during code generation. */
1725 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001726 }
1727
1728vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001729 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001730 sqlite3IdListDelete(db, pColumns);
1731 return pList;
1732}
1733
1734/*
drhbc622bc2015-08-24 15:39:42 +00001735** Set the sort order for the last element on the given ExprList.
1736*/
dan6e118922019-08-12 16:36:38 +00001737void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001738 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001739 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001740 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001741
1742 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1743 assert( iSortOrder==SQLITE_SO_UNDEFINED
1744 || iSortOrder==SQLITE_SO_ASC
1745 || iSortOrder==SQLITE_SO_DESC
1746 );
1747 assert( eNulls==SQLITE_SO_UNDEFINED
1748 || eNulls==SQLITE_SO_ASC
1749 || eNulls==SQLITE_SO_DESC
1750 );
1751
dan9105fd52019-08-19 17:26:32 +00001752 pItem = &p->a[p->nExpr-1];
1753 assert( pItem->bNulls==0 );
1754 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1755 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001756 }
dan9105fd52019-08-19 17:26:32 +00001757 pItem->sortFlags = (u8)iSortOrder;
1758
1759 if( eNulls!=SQLITE_SO_UNDEFINED ){
1760 pItem->bNulls = 1;
1761 if( iSortOrder!=eNulls ){
1762 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1763 }
drhbc622bc2015-08-24 15:39:42 +00001764 }
drhbc622bc2015-08-24 15:39:42 +00001765}
1766
1767/*
drh41cee662019-12-12 20:22:34 +00001768** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001769** on the expression list.
1770**
1771** pList might be NULL following an OOM error. But pName should never be
1772** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1773** is set.
1774*/
1775void sqlite3ExprListSetName(
1776 Parse *pParse, /* Parsing context */
1777 ExprList *pList, /* List to which to add the span. */
1778 Token *pName, /* Name to be added */
1779 int dequote /* True to cause the name to be dequoted */
1780){
1781 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1782 if( pList ){
1783 struct ExprList_item *pItem;
1784 assert( pList->nExpr>0 );
1785 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001786 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001787 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001788 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1789 if( dequote ) sqlite3Dequote(pItem->zEName);
danc9461ec2018-08-29 21:00:16 +00001790 if( IN_RENAME_OBJECT ){
drh41cee662019-12-12 20:22:34 +00001791 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
dan5be60c52018-08-15 20:28:39 +00001792 }
drhb7916a72009-05-27 10:31:29 +00001793 }
1794}
1795
1796/*
1797** Set the ExprList.a[].zSpan element of the most recently added item
1798** on the expression list.
1799**
1800** pList might be NULL following an OOM error. But pSpan should never be
1801** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1802** is set.
1803*/
1804void sqlite3ExprListSetSpan(
1805 Parse *pParse, /* Parsing context */
1806 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001807 const char *zStart, /* Start of the span */
1808 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001809){
1810 sqlite3 *db = pParse->db;
1811 assert( pList!=0 || db->mallocFailed!=0 );
1812 if( pList ){
1813 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1814 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001815 if( pItem->zEName==0 ){
1816 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1817 pItem->eEName = ENAME_SPAN;
1818 }
drhb7916a72009-05-27 10:31:29 +00001819 }
1820}
1821
1822/*
danielk19777a15a4b2007-05-08 17:54:43 +00001823** If the expression list pEList contains more than iLimit elements,
1824** leave an error message in pParse.
1825*/
1826void sqlite3ExprListCheckLength(
1827 Parse *pParse,
1828 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001829 const char *zObject
1830){
drhb1a6c3c2008-03-20 16:30:17 +00001831 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001832 testcase( pEList && pEList->nExpr==mx );
1833 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001834 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001835 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1836 }
1837}
1838
1839/*
drha76b5df2002-02-23 02:32:10 +00001840** Delete an entire expression list.
1841*/
drhaffa8552016-04-11 18:25:05 +00001842static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001843 int i = pList->nExpr;
1844 struct ExprList_item *pItem = pList->a;
1845 assert( pList->nExpr>0 );
1846 do{
drh633e6d52008-07-28 19:34:53 +00001847 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001848 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001849 pItem++;
1850 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001851 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001852}
drhaffa8552016-04-11 18:25:05 +00001853void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1854 if( pList ) exprListDeleteNN(db, pList);
1855}
drha76b5df2002-02-23 02:32:10 +00001856
1857/*
drh2308ed32015-02-09 16:09:34 +00001858** Return the bitwise-OR of all Expr.flags fields in the given
1859** ExprList.
drh885a5b02015-02-09 15:21:36 +00001860*/
drh2308ed32015-02-09 16:09:34 +00001861u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001862 int i;
drh2308ed32015-02-09 16:09:34 +00001863 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001864 assert( pList!=0 );
1865 for(i=0; i<pList->nExpr; i++){
1866 Expr *pExpr = pList->a[i].pExpr;
1867 assert( pExpr!=0 );
1868 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001869 }
drh2308ed32015-02-09 16:09:34 +00001870 return m;
drh885a5b02015-02-09 15:21:36 +00001871}
1872
1873/*
drh7e6f9802017-09-04 00:33:04 +00001874** This is a SELECT-node callback for the expression walker that
1875** always "fails". By "fail" in this case, we mean set
1876** pWalker->eCode to zero and abort.
1877**
1878** This callback is used by multiple expression walkers.
1879*/
1880int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1881 UNUSED_PARAMETER(NotUsed);
1882 pWalker->eCode = 0;
1883 return WRC_Abort;
1884}
1885
1886/*
drh0cbec592020-01-03 02:20:37 +00001887** Check the input string to see if it is "true" or "false" (in any case).
1888**
1889** If the string is.... Return
1890** "true" EP_IsTrue
1891** "false" EP_IsFalse
1892** anything else 0
1893*/
1894u32 sqlite3IsTrueOrFalse(const char *zIn){
1895 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1896 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1897 return 0;
1898}
1899
1900
1901/*
drh171d16b2018-02-26 20:15:54 +00001902** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001903** then convert it into an TK_TRUEFALSE term. Return non-zero if
1904** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001905*/
1906int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001907 u32 v;
drh171d16b2018-02-26 20:15:54 +00001908 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001909 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001910 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001911 ){
1912 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001913 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001914 return 1;
1915 }
1916 return 0;
1917}
1918
drh43c4ac82018-02-26 21:26:27 +00001919/*
drh96acafb2018-02-27 14:49:25 +00001920** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001921** and 0 if it is FALSE.
1922*/
drh96acafb2018-02-27 14:49:25 +00001923int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001924 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001925 assert( pExpr->op==TK_TRUEFALSE );
1926 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1927 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1928 return pExpr->u.zToken[4]==0;
1929}
1930
drh17180fc2019-04-19 17:26:19 +00001931/*
1932** If pExpr is an AND or OR expression, try to simplify it by eliminating
1933** terms that are always true or false. Return the simplified expression.
1934** Or return the original expression if no simplification is possible.
1935**
1936** Examples:
1937**
1938** (x<10) AND true => (x<10)
1939** (x<10) AND false => false
1940** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1941** (x<10) AND (y=22 OR true) => (x<10)
1942** (y=22) OR true => true
1943*/
1944Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1945 assert( pExpr!=0 );
1946 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1947 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1948 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1949 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1950 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1951 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1952 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1953 }
1954 }
1955 return pExpr;
1956}
1957
drh171d16b2018-02-26 20:15:54 +00001958
1959/*
drh059b2d52014-10-24 19:28:09 +00001960** These routines are Walker callbacks used to check expressions to
1961** see if they are "constant" for some definition of constant. The
1962** Walker.eCode value determines the type of "constant" we are looking
1963** for.
drh73b211a2005-01-18 04:00:42 +00001964**
drh7d10d5a2008-08-20 16:35:10 +00001965** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001966**
drh059b2d52014-10-24 19:28:09 +00001967** sqlite3ExprIsConstant() pWalker->eCode==1
1968** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001969** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001970** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001971**
drh059b2d52014-10-24 19:28:09 +00001972** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1973** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001974**
drhfeada2d2014-09-24 13:20:22 +00001975** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001976** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1977** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001978** parameter raises an error for new statements, but is silently converted
1979** to NULL for existing schemas. This allows sqlite_master tables that
1980** contain a bound parameter because they were generated by older versions
1981** of SQLite to be parsed by newer versions of SQLite without raising a
1982** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001983*/
drh7d10d5a2008-08-20 16:35:10 +00001984static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001985
drh059b2d52014-10-24 19:28:09 +00001986 /* If pWalker->eCode is 2 then any term of the expression that comes from
1987 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001988 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001989 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1990 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001991 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001992 }
1993
drh626a8792005-01-17 22:08:19 +00001994 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001995 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001996 ** and either pWalker->eCode==4 or 5 or the function has the
1997 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001998 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00001999 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2000 && !ExprHasProperty(pExpr, EP_WinFunc)
2001 ){
drhb1fba282013-11-21 14:33:48 +00002002 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002003 }else{
2004 pWalker->eCode = 0;
2005 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002006 }
drh626a8792005-01-17 22:08:19 +00002007 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002008 /* Convert "true" or "false" in a DEFAULT clause into the
2009 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002010 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002011 return WRC_Prune;
2012 }
2013 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00002014 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002015 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002016 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002017 testcase( pExpr->op==TK_ID );
2018 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002019 testcase( pExpr->op==TK_AGG_FUNCTION );
2020 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002021 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002022 return WRC_Continue;
2023 }
drh059b2d52014-10-24 19:28:09 +00002024 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2025 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002026 }
drhf43ce0b2017-05-25 00:08:48 +00002027 /* Fall through */
2028 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002029 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00002030 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002031 testcase( pExpr->op==TK_IF_NULL_ROW );
2032 pWalker->eCode = 0;
2033 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002034 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002035 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002036 /* Silently convert bound parameters that appear inside of CREATE
2037 ** statements into a NULL when parsing the CREATE statement text out
2038 ** of the sqlite_master table */
2039 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002040 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002041 /* A bound parameter in a CREATE statement that originates from
2042 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002043 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002044 return WRC_Abort;
2045 }
2046 /* Fall through */
drh626a8792005-01-17 22:08:19 +00002047 default:
drh6e341b92018-04-17 18:50:40 +00002048 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2049 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002050 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002051 }
2052}
drh059b2d52014-10-24 19:28:09 +00002053static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002054 Walker w;
drh059b2d52014-10-24 19:28:09 +00002055 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002056 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002057 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002058#ifdef SQLITE_DEBUG
2059 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2060#endif
drh059b2d52014-10-24 19:28:09 +00002061 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002062 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002063 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002064}
drh626a8792005-01-17 22:08:19 +00002065
2066/*
drh059b2d52014-10-24 19:28:09 +00002067** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002068** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002069**
2070** For the purposes of this function, a double-quoted string (ex: "abc")
2071** is considered a variable but a single-quoted string (ex: 'abc') is
2072** a constant.
drhfef52082000-06-06 01:50:43 +00002073*/
danielk19774adee202004-05-08 08:23:19 +00002074int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002075 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002076}
2077
2078/*
drh07aded62018-07-28 16:24:08 +00002079** Walk an expression tree. Return non-zero if
2080**
2081** (1) the expression is constant, and
2082** (2) the expression does originate in the ON or USING clause
2083** of a LEFT JOIN, and
2084** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2085** operands created by the constant propagation optimization.
2086**
2087** When this routine returns true, it indicates that the expression
2088** can be added to the pParse->pConstExpr list and evaluated once when
2089** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002090*/
2091int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002092 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002093}
2094
2095/*
drhfcb9f4f2015-06-01 18:13:16 +00002096** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002097** for any single row of the table with cursor iCur. In other words, the
2098** expression must not refer to any non-deterministic function nor any
2099** table other than iCur.
2100*/
2101int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2102 return exprIsConst(p, 3, iCur);
2103}
2104
danab31a842017-04-29 20:53:09 +00002105
2106/*
2107** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2108*/
2109static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2110 ExprList *pGroupBy = pWalker->u.pGroupBy;
2111 int i;
2112
2113 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2114 ** it constant. */
2115 for(i=0; i<pGroupBy->nExpr; i++){
2116 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002117 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002118 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002119 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002120 return WRC_Prune;
2121 }
2122 }
2123 }
2124
2125 /* Check if pExpr is a sub-select. If so, consider it variable. */
2126 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2127 pWalker->eCode = 0;
2128 return WRC_Abort;
2129 }
2130
2131 return exprNodeIsConstant(pWalker, pExpr);
2132}
2133
2134/*
2135** Walk the expression tree passed as the first argument. Return non-zero
2136** if the expression consists entirely of constants or copies of terms
2137** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002138**
2139** This routine is used to determine if a term of the HAVING clause can
2140** be promoted into the WHERE clause. In order for such a promotion to work,
2141** the value of the HAVING clause term must be the same for all members of
2142** a "group". The requirement that the GROUP BY term must be BINARY
2143** assumes that no other collating sequence will have a finer-grained
2144** grouping than binary. In other words (A=B COLLATE binary) implies
2145** A=B in every other collating sequence. The requirement that the
2146** GROUP BY be BINARY is stricter than necessary. It would also work
2147** to promote HAVING clauses that use the same alternative collating
2148** sequence as the GROUP BY term, but that is much harder to check,
2149** alternative collating sequences are uncommon, and this is only an
2150** optimization, so we take the easy way out and simply require the
2151** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002152*/
2153int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2154 Walker w;
danab31a842017-04-29 20:53:09 +00002155 w.eCode = 1;
2156 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002157 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002158 w.u.pGroupBy = pGroupBy;
2159 w.pParse = pParse;
2160 sqlite3WalkExpr(&w, p);
2161 return w.eCode;
2162}
2163
drh059b2d52014-10-24 19:28:09 +00002164/*
2165** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002166** or a function call with constant arguments. Return and 0 if there
2167** are any variables.
2168**
2169** For the purposes of this function, a double-quoted string (ex: "abc")
2170** is considered a variable but a single-quoted string (ex: 'abc') is
2171** a constant.
2172*/
drhfeada2d2014-09-24 13:20:22 +00002173int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2174 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002175 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002176}
2177
drh5b88bc42013-12-07 23:35:21 +00002178#ifdef SQLITE_ENABLE_CURSOR_HINTS
2179/*
2180** Walk an expression tree. Return 1 if the expression contains a
2181** subquery of some kind. Return 0 if there are no subqueries.
2182*/
2183int sqlite3ExprContainsSubquery(Expr *p){
2184 Walker w;
drhbec24762015-08-13 20:07:13 +00002185 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002186 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002187 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002188#ifdef SQLITE_DEBUG
2189 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2190#endif
drh5b88bc42013-12-07 23:35:21 +00002191 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002192 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002193}
2194#endif
2195
drheb55bd22005-06-30 17:04:21 +00002196/*
drh73b211a2005-01-18 04:00:42 +00002197** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002198** to fit in a 32-bit integer, return 1 and put the value of the integer
2199** in *pValue. If the expression is not an integer or if it is too big
2200** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002201*/
danielk19774adee202004-05-08 08:23:19 +00002202int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002203 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002204 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002205
2206 /* If an expression is an integer literal that fits in a signed 32-bit
2207 ** integer, then the EP_IntValue flag will have already been set */
2208 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2209 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2210
drh92b01d52008-06-24 00:32:35 +00002211 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002212 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002213 return 1;
2214 }
drhe4de1fe2002-06-02 16:09:01 +00002215 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002216 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002217 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002218 break;
drh4b59ab52002-08-24 18:24:51 +00002219 }
drhe4de1fe2002-06-02 16:09:01 +00002220 case TK_UMINUS: {
2221 int v;
danielk19774adee202004-05-08 08:23:19 +00002222 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002223 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002224 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002225 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002226 }
2227 break;
2228 }
2229 default: break;
2230 }
drh92b01d52008-06-24 00:32:35 +00002231 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002232}
2233
2234/*
drh039fc322009-11-17 18:31:47 +00002235** Return FALSE if there is no chance that the expression can be NULL.
2236**
2237** If the expression might be NULL or if the expression is too complex
2238** to tell return TRUE.
2239**
2240** This routine is used as an optimization, to skip OP_IsNull opcodes
2241** when we know that a value cannot be NULL. Hence, a false positive
2242** (returning TRUE when in fact the expression can never be NULL) might
2243** be a small performance hit but is otherwise harmless. On the other
2244** hand, a false negative (returning FALSE when the result could be NULL)
2245** will likely result in an incorrect answer. So when in doubt, return
2246** TRUE.
2247*/
2248int sqlite3ExprCanBeNull(const Expr *p){
2249 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002250 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2251 p = p->pLeft;
2252 }
drh039fc322009-11-17 18:31:47 +00002253 op = p->op;
2254 if( op==TK_REGISTER ) op = p->op2;
2255 switch( op ){
2256 case TK_INTEGER:
2257 case TK_STRING:
2258 case TK_FLOAT:
2259 case TK_BLOB:
2260 return 0;
drh7248a8b2014-08-04 18:50:54 +00002261 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002262 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002263 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002264 (p->iColumn>=0
2265 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2266 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002267 default:
2268 return 1;
2269 }
2270}
2271
2272/*
2273** Return TRUE if the given expression is a constant which would be
2274** unchanged by OP_Affinity with the affinity given in the second
2275** argument.
2276**
2277** This routine is used to determine if the OP_Affinity operation
2278** can be omitted. When in doubt return FALSE. A false negative
2279** is harmless. A false positive, however, can result in the wrong
2280** answer.
2281*/
2282int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2283 u8 op;
drhaf866402019-08-22 11:11:28 +00002284 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002285 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002286 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2287 if( p->op==TK_UMINUS ) unaryMinus = 1;
2288 p = p->pLeft;
2289 }
drh039fc322009-11-17 18:31:47 +00002290 op = p->op;
2291 if( op==TK_REGISTER ) op = p->op2;
2292 switch( op ){
2293 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002294 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002295 }
2296 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002297 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002298 }
2299 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002300 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002301 }
2302 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002303 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002304 }
drh2f2855b2009-11-18 01:25:26 +00002305 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002306 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002307 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002308 }
drh039fc322009-11-17 18:31:47 +00002309 default: {
2310 return 0;
2311 }
2312 }
2313}
2314
2315/*
drhc4a3c772001-04-04 11:48:57 +00002316** Return TRUE if the given string is a row-id column name.
2317*/
danielk19774adee202004-05-08 08:23:19 +00002318int sqlite3IsRowid(const char *z){
2319 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2320 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2321 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002322 return 0;
2323}
2324
danielk19779a96b662007-11-29 17:05:18 +00002325/*
drh69c355b2016-03-09 15:34:51 +00002326** pX is the RHS of an IN operator. If pX is a SELECT statement
2327** that can be simplified to a direct table access, then return
2328** a pointer to the SELECT statement. If pX is not a SELECT statement,
2329** or if the SELECT statement needs to be manifested into a transient
2330** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002331*/
2332#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002333static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002334 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002335 SrcList *pSrc;
2336 ExprList *pEList;
2337 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002338 int i;
drh69c355b2016-03-09 15:34:51 +00002339 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2340 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2341 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002342 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002343 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002344 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2345 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2346 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002347 }
drh2e26a602020-01-06 18:59:46 +00002348 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002349 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002350 if( p->pWhere ) return 0; /* Has no WHERE clause */
2351 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002352 assert( pSrc!=0 );
2353 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002354 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002355 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002356 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002357 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002358 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2359 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002360 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002361 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002362 for(i=0; i<pEList->nExpr; i++){
2363 Expr *pRes = pEList->a[i].pExpr;
2364 if( pRes->op!=TK_COLUMN ) return 0;
2365 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002366 }
drh69c355b2016-03-09 15:34:51 +00002367 return p;
drhb287f4b2008-04-25 00:08:38 +00002368}
2369#endif /* SQLITE_OMIT_SUBQUERY */
2370
danf9b2e052016-08-02 17:45:00 +00002371#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002372/*
drh4c259e92014-08-01 21:12:35 +00002373** Generate code that checks the left-most column of index table iCur to see if
2374** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002375** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2376** to be set to NULL if iCur contains one or more NULL values.
2377*/
2378static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002379 int addr1;
drh6be515e2014-08-01 21:00:53 +00002380 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002381 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002382 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2383 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002384 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002385 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002386}
danf9b2e052016-08-02 17:45:00 +00002387#endif
drh6be515e2014-08-01 21:00:53 +00002388
drhbb53ecb2014-08-02 21:03:33 +00002389
2390#ifndef SQLITE_OMIT_SUBQUERY
2391/*
2392** The argument is an IN operator with a list (not a subquery) on the
2393** right-hand side. Return TRUE if that list is constant.
2394*/
2395static int sqlite3InRhsIsConstant(Expr *pIn){
2396 Expr *pLHS;
2397 int res;
2398 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2399 pLHS = pIn->pLeft;
2400 pIn->pLeft = 0;
2401 res = sqlite3ExprIsConstant(pIn);
2402 pIn->pLeft = pLHS;
2403 return res;
2404}
2405#endif
2406
drh6be515e2014-08-01 21:00:53 +00002407/*
danielk19779a96b662007-11-29 17:05:18 +00002408** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002409** The pX parameter is the expression on the RHS of the IN operator, which
2410** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002411**
drhd4305ca2012-09-18 17:08:33 +00002412** The job of this routine is to find or create a b-tree object that can
2413** be used either to test for membership in the RHS set or to iterate through
2414** all members of the RHS set, skipping duplicates.
2415**
drh3a856252014-08-01 14:46:57 +00002416** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002417** and pX->iTable is set to the index of that cursor.
2418**
drhb74b1012009-05-28 21:04:37 +00002419** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002420**
drh1ccce442013-03-12 20:38:51 +00002421** IN_INDEX_ROWID - The cursor was opened on a database table.
2422** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2423** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2424** IN_INDEX_EPH - The cursor was opened on a specially created and
2425** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002426** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2427** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002428**
drhd4305ca2012-09-18 17:08:33 +00002429** An existing b-tree might be used if the RHS expression pX is a simple
2430** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002431**
dan553168c2016-08-01 20:14:31 +00002432** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002433**
drhd4305ca2012-09-18 17:08:33 +00002434** If the RHS of the IN operator is a list or a more complex subquery, then
2435** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002436** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002437** existing table.
drhd4305ca2012-09-18 17:08:33 +00002438**
drh7fc0ba02017-11-17 15:02:00 +00002439** The inFlags parameter must contain, at a minimum, one of the bits
2440** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2441** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2442** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2443** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002444**
2445** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2446** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002447** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002448** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2449** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002450**
drh3a856252014-08-01 14:46:57 +00002451** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2452** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002453** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2454** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002455**
drhbb53ecb2014-08-02 21:03:33 +00002456** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2457** if the RHS of the IN operator is a list (not a subquery) then this
2458** routine might decide that creating an ephemeral b-tree for membership
2459** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2460** calling routine should implement the IN operator using a sequence
2461** of Eq or Ne comparison operations.
2462**
drhb74b1012009-05-28 21:04:37 +00002463** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002464** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002465** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002466** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002467** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002468** to *prRhsHasNull. If there is no chance that the (...) contains a
2469** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002470**
drhe21a6e12014-08-01 18:00:24 +00002471** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002472** the value in that register will be NULL if the b-tree contains one or more
2473** NULL values, and it will be some non-NULL value if the b-tree contains no
2474** NULL values.
dan553168c2016-08-01 20:14:31 +00002475**
2476** If the aiMap parameter is not NULL, it must point to an array containing
2477** one element for each column returned by the SELECT statement on the RHS
2478** of the IN(...) operator. The i'th entry of the array is populated with the
2479** offset of the index column that matches the i'th column returned by the
2480** SELECT. For example, if the expression and selected index are:
2481**
2482** (?,?,?) IN (SELECT a, b, c FROM t1)
2483** CREATE INDEX i1 ON t1(b, c, a);
2484**
2485** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002486*/
danielk1977284f4ac2007-12-10 05:03:46 +00002487#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002488int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002489 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002490 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002491 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2492 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002493 int *aiMap, /* Mapping from Index fields to RHS fields */
2494 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002495){
drhb74b1012009-05-28 21:04:37 +00002496 Select *p; /* SELECT to the right of IN operator */
2497 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2498 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002499 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002500 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002501
drh1450bc62009-10-30 13:25:56 +00002502 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002503 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002504
dan7b35a772016-07-28 19:47:15 +00002505 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2506 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002507 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002508 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002509 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002510 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2511 int i;
2512 ExprList *pEList = pX->x.pSelect->pEList;
2513 for(i=0; i<pEList->nExpr; i++){
2514 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2515 }
2516 if( i==pEList->nExpr ){
2517 prRhsHasNull = 0;
2518 }
2519 }
2520
drhb74b1012009-05-28 21:04:37 +00002521 /* Check to see if an existing table or index can be used to
2522 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002523 ** ephemeral table. */
2524 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002525 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002526 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002527 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002528 ExprList *pEList = p->pEList;
2529 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002530
drhb07028f2011-10-14 21:49:18 +00002531 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2532 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2533 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2534 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002535
drhb22f7c82014-02-06 23:56:27 +00002536 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002537 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2538 sqlite3CodeVerifySchema(pParse, iDb);
2539 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002540
drha84a2832016-08-26 21:15:35 +00002541 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002542 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002543 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002544 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002545 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002546
2547 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2548 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002549 ExplainQueryPlan((pParse, 0,
2550 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002551 sqlite3VdbeJumpHere(v, iAddr);
2552 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002553 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002554 int affinity_ok = 1;
2555 int i;
2556
2557 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002558 ** comparison is the same as the affinity of each column in table
2559 ** on the RHS of the IN operator. If it not, it is not possible to
2560 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002561 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002562 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002563 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002564 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002565 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002566 testcase( cmpaff==SQLITE_AFF_BLOB );
2567 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002568 switch( cmpaff ){
2569 case SQLITE_AFF_BLOB:
2570 break;
2571 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002572 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2573 ** other has no affinity and the other side is TEXT. Hence,
2574 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2575 ** and for the term on the LHS of the IN to have no affinity. */
2576 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002577 break;
2578 default:
2579 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2580 }
2581 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002582
drha84a2832016-08-26 21:15:35 +00002583 if( affinity_ok ){
2584 /* Search for an existing index that will work for this IN operator */
2585 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2586 Bitmask colUsed; /* Columns of the index used */
2587 Bitmask mCol; /* Mask for the current column */
2588 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002589 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002590 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2591 ** BITMASK(nExpr) without overflowing */
2592 testcase( pIdx->nColumn==BMS-2 );
2593 testcase( pIdx->nColumn==BMS-1 );
2594 if( pIdx->nColumn>=BMS-1 ) continue;
2595 if( mustBeUnique ){
2596 if( pIdx->nKeyCol>nExpr
2597 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2598 ){
2599 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002600 }
danielk19770cdc0222008-06-26 18:04:03 +00002601 }
drha84a2832016-08-26 21:15:35 +00002602
2603 colUsed = 0; /* Columns of index used so far */
2604 for(i=0; i<nExpr; i++){
2605 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2606 Expr *pRhs = pEList->a[i].pExpr;
2607 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2608 int j;
2609
2610 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2611 for(j=0; j<nExpr; j++){
2612 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2613 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002614 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2615 continue;
2616 }
drha84a2832016-08-26 21:15:35 +00002617 break;
2618 }
2619 if( j==nExpr ) break;
2620 mCol = MASKBIT(j);
2621 if( mCol & colUsed ) break; /* Each column used only once */
2622 colUsed |= mCol;
2623 if( aiMap ) aiMap[i] = j;
2624 }
2625
2626 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2627 if( colUsed==(MASKBIT(nExpr)-1) ){
2628 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002629 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002630 ExplainQueryPlan((pParse, 0,
2631 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002632 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2633 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2634 VdbeComment((v, "%s", pIdx->zName));
2635 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2636 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2637
2638 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002639#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002640 i64 mask = (1<<nExpr)-1;
2641 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2642 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002643#endif
2644 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002645 if( nExpr==1 ){
2646 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2647 }
2648 }
2649 sqlite3VdbeJumpHere(v, iAddr);
2650 }
2651 } /* End loop over indexes */
2652 } /* End if( affinity_ok ) */
2653 } /* End if not an rowid index */
2654 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002655
drhbb53ecb2014-08-02 21:03:33 +00002656 /* If no preexisting index is available for the IN clause
2657 ** and IN_INDEX_NOOP is an allowed reply
2658 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002659 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002660 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002661 ** the IN operator so return IN_INDEX_NOOP.
2662 */
2663 if( eType==0
2664 && (inFlags & IN_INDEX_NOOP_OK)
2665 && !ExprHasProperty(pX, EP_xIsSelect)
2666 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2667 ){
2668 eType = IN_INDEX_NOOP;
2669 }
drhbb53ecb2014-08-02 21:03:33 +00002670
danielk19779a96b662007-11-29 17:05:18 +00002671 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002672 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002673 ** We will have to generate an ephemeral table to do the job.
2674 */
drh8e23daf2013-06-11 13:30:04 +00002675 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002676 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002677 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002678 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002679 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002680 }else if( prRhsHasNull ){
2681 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002682 }
drh85bcdce2018-12-23 21:27:29 +00002683 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002684 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002685 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002686 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002687 }
drhcf4d38a2010-07-28 02:53:36 +00002688 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002689 }
danba00e302016-07-23 20:24:06 +00002690
2691 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2692 int i, n;
2693 n = sqlite3ExprVectorSize(pX->pLeft);
2694 for(i=0; i<n; i++) aiMap[i] = i;
2695 }
drh2c041312018-12-24 02:34:49 +00002696 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002697 return eType;
2698}
danielk1977284f4ac2007-12-10 05:03:46 +00002699#endif
drh626a8792005-01-17 22:08:19 +00002700
danf9b2e052016-08-02 17:45:00 +00002701#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002702/*
2703** Argument pExpr is an (?, ?...) IN(...) expression. This
2704** function allocates and returns a nul-terminated string containing
2705** the affinities to be used for each column of the comparison.
2706**
2707** It is the responsibility of the caller to ensure that the returned
2708** string is eventually freed using sqlite3DbFree().
2709*/
dan71c57db2016-07-09 20:23:55 +00002710static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2711 Expr *pLeft = pExpr->pLeft;
2712 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002713 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002714 char *zRet;
2715
dan553168c2016-08-01 20:14:31 +00002716 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002717 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002718 if( zRet ){
2719 int i;
2720 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002721 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002722 char a = sqlite3ExprAffinity(pA);
2723 if( pSelect ){
2724 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2725 }else{
2726 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002727 }
dan71c57db2016-07-09 20:23:55 +00002728 }
2729 zRet[nVal] = '\0';
2730 }
2731 return zRet;
2732}
danf9b2e052016-08-02 17:45:00 +00002733#endif
dan71c57db2016-07-09 20:23:55 +00002734
dan8da209b2016-07-26 18:06:08 +00002735#ifndef SQLITE_OMIT_SUBQUERY
2736/*
2737** Load the Parse object passed as the first argument with an error
2738** message of the form:
2739**
2740** "sub-select returns N columns - expected M"
2741*/
2742void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002743 if( pParse->nErr==0 ){
2744 const char *zFmt = "sub-select returns %d columns - expected %d";
2745 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2746 }
dan8da209b2016-07-26 18:06:08 +00002747}
2748#endif
2749
drh626a8792005-01-17 22:08:19 +00002750/*
dan44c56042016-12-07 15:38:37 +00002751** Expression pExpr is a vector that has been used in a context where
2752** it is not permitted. If pExpr is a sub-select vector, this routine
2753** loads the Parse object with a message of the form:
2754**
2755** "sub-select returns N columns - expected 1"
2756**
2757** Or, if it is a regular scalar vector:
2758**
2759** "row value misused"
2760*/
2761void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2762#ifndef SQLITE_OMIT_SUBQUERY
2763 if( pExpr->flags & EP_xIsSelect ){
2764 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2765 }else
2766#endif
2767 {
2768 sqlite3ErrorMsg(pParse, "row value misused");
2769 }
2770}
2771
drh85bcdce2018-12-23 21:27:29 +00002772#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002773/*
drh85bcdce2018-12-23 21:27:29 +00002774** Generate code that will construct an ephemeral table containing all terms
2775** in the RHS of an IN operator. The IN operator can be in either of two
2776** forms:
drh626a8792005-01-17 22:08:19 +00002777**
drh9cbe6352005-11-29 03:13:21 +00002778** x IN (4,5,11) -- IN operator with list on right-hand side
2779** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002780**
drh2c041312018-12-24 02:34:49 +00002781** The pExpr parameter is the IN operator. The cursor number for the
2782** constructed ephermeral table is returned. The first time the ephemeral
2783** table is computed, the cursor number is also stored in pExpr->iTable,
2784** however the cursor number returned might not be the same, as it might
2785** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002786**
drh85bcdce2018-12-23 21:27:29 +00002787** If the LHS expression ("x" in the examples) is a column value, or
2788** the SELECT statement returns a column value, then the affinity of that
2789** column is used to build the index keys. If both 'x' and the
2790** SELECT... statement are columns, then numeric affinity is used
2791** if either column has NUMERIC or INTEGER affinity. If neither
2792** 'x' nor the SELECT... statement are columns, then numeric affinity
2793** is used.
drhcce7d172000-05-31 15:34:51 +00002794*/
drh85bcdce2018-12-23 21:27:29 +00002795void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002796 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002797 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002798 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002799){
drh2c041312018-12-24 02:34:49 +00002800 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002801 int addr; /* Address of OP_OpenEphemeral instruction */
2802 Expr *pLeft; /* the LHS of the IN operator */
2803 KeyInfo *pKeyInfo = 0; /* Key information */
2804 int nVal; /* Size of vector pLeft */
2805 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002806
drh2c041312018-12-24 02:34:49 +00002807 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002808 assert( v!=0 );
2809
drh2c041312018-12-24 02:34:49 +00002810 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002811 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002812 **
2813 ** * The right-hand side is a correlated subquery
2814 ** * The right-hand side is an expression list containing variables
2815 ** * We are inside a trigger
2816 **
drh2c041312018-12-24 02:34:49 +00002817 ** If all of the above are false, then we can compute the RHS just once
2818 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002819 */
drhefb699f2018-12-24 11:55:44 +00002820 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002821 /* Reuse of the RHS is allowed */
2822 /* If this routine has already been coded, but the previous code
2823 ** might not have been invoked yet, so invoke it now as a subroutine.
2824 */
2825 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002826 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002827 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2828 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2829 pExpr->x.pSelect->selId));
2830 }
drh2c041312018-12-24 02:34:49 +00002831 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2832 pExpr->y.sub.iAddr);
2833 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002834 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002835 return;
2836 }
2837
2838 /* Begin coding the subroutine */
2839 ExprSetProperty(pExpr, EP_Subrtn);
2840 pExpr->y.sub.regReturn = ++pParse->nMem;
2841 pExpr->y.sub.iAddr =
2842 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2843 VdbeComment((v, "return address"));
2844
2845 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002846 }
2847
drh85bcdce2018-12-23 21:27:29 +00002848 /* Check to see if this is a vector IN operator */
2849 pLeft = pExpr->pLeft;
2850 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002851
drh85bcdce2018-12-23 21:27:29 +00002852 /* Construct the ephemeral table that will contain the content of
2853 ** RHS of the IN operator.
2854 */
drh2c041312018-12-24 02:34:49 +00002855 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002856 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002857#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2858 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2859 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2860 }else{
2861 VdbeComment((v, "RHS of IN operator"));
2862 }
2863#endif
drh50ef6712019-02-22 23:29:56 +00002864 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002865
drh85bcdce2018-12-23 21:27:29 +00002866 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2867 /* Case 1: expr IN (SELECT ...)
2868 **
2869 ** Generate code to write the results of the select into the temporary
2870 ** table allocated and opened above.
2871 */
2872 Select *pSelect = pExpr->x.pSelect;
2873 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002874
drh2c041312018-12-24 02:34:49 +00002875 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2876 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002877 ));
drh85bcdce2018-12-23 21:27:29 +00002878 /* If the LHS and RHS of the IN operator do not match, that
2879 ** error will have been caught long before we reach this point. */
2880 if( ALWAYS(pEList->nExpr==nVal) ){
2881 SelectDest dest;
2882 int i;
drhbd462bc2018-12-24 20:21:06 +00002883 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002884 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2885 pSelect->iLimit = 0;
2886 testcase( pSelect->selFlags & SF_Distinct );
2887 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2888 if( sqlite3Select(pParse, pSelect, &dest) ){
2889 sqlite3DbFree(pParse->db, dest.zAffSdst);
2890 sqlite3KeyInfoUnref(pKeyInfo);
2891 return;
drhfef52082000-06-06 01:50:43 +00002892 }
drh85bcdce2018-12-23 21:27:29 +00002893 sqlite3DbFree(pParse->db, dest.zAffSdst);
2894 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2895 assert( pEList!=0 );
2896 assert( pEList->nExpr>0 );
2897 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2898 for(i=0; i<nVal; i++){
2899 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2900 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2901 pParse, p, pEList->a[i].pExpr
2902 );
danielk197741a05b72008-10-02 13:50:55 +00002903 }
drh85bcdce2018-12-23 21:27:29 +00002904 }
2905 }else if( ALWAYS(pExpr->x.pList!=0) ){
2906 /* Case 2: expr IN (exprlist)
2907 **
2908 ** For each expression, build an index key from the evaluation and
2909 ** store it in the temporary table. If <expr> is a column, then use
2910 ** that columns affinity when building index keys. If <expr> is not
2911 ** a column, use numeric affinity.
2912 */
2913 char affinity; /* Affinity of the LHS of the IN */
2914 int i;
2915 ExprList *pList = pExpr->x.pList;
2916 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002917 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002918 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002919 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002920 affinity = SQLITE_AFF_BLOB;
2921 }
2922 if( pKeyInfo ){
2923 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2924 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002925 }
2926
drh85bcdce2018-12-23 21:27:29 +00002927 /* Loop through each expression in <exprlist>. */
2928 r1 = sqlite3GetTempReg(pParse);
2929 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002930 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2931 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002932
2933 /* If the expression is not constant then we will need to
2934 ** disable the test that was generated above that makes sure
2935 ** this code only executes once. Because for a non-constant
2936 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002937 */
drh2c041312018-12-24 02:34:49 +00002938 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2939 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002940 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002941 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002942 }
drh1398ad32005-01-19 23:24:50 +00002943
drh85bcdce2018-12-23 21:27:29 +00002944 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002945 sqlite3ExprCode(pParse, pE2, r1);
2946 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2947 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002948 }
drh85bcdce2018-12-23 21:27:29 +00002949 sqlite3ReleaseTempReg(pParse, r1);
2950 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002951 }
drh85bcdce2018-12-23 21:27:29 +00002952 if( pKeyInfo ){
2953 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2954 }
drh2c041312018-12-24 02:34:49 +00002955 if( addrOnce ){
2956 sqlite3VdbeJumpHere(v, addrOnce);
2957 /* Subroutine return */
2958 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2959 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002960 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002961 }
2962}
2963#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002964
drh85bcdce2018-12-23 21:27:29 +00002965/*
2966** Generate code for scalar subqueries used as a subquery expression
2967** or EXISTS operator:
2968**
2969** (SELECT a FROM b) -- subquery
2970** EXISTS (SELECT a FROM b) -- EXISTS subquery
2971**
2972** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2973**
drhd86fe442019-08-26 13:45:49 +00002974** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002975** the result is stored in a contiguous array of registers and the
2976** return value is the register of the left-most result column.
2977** Return 0 if an error occurs.
2978*/
2979#ifndef SQLITE_OMIT_SUBQUERY
2980int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002981 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002982 int rReg = 0; /* Register storing resulting */
2983 Select *pSel; /* SELECT statement to encode */
2984 SelectDest dest; /* How to deal with SELECT result */
2985 int nReg; /* Registers to allocate */
2986 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002987
2988 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002989 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002990 testcase( pExpr->op==TK_EXISTS );
2991 testcase( pExpr->op==TK_SELECT );
2992 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2993 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2994 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002995
drh5198ff52018-12-24 12:09:47 +00002996 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002997 ** is encountered if any of the following is true:
2998 **
2999 ** * The right-hand side is a correlated subquery
3000 ** * The right-hand side is an expression list containing variables
3001 ** * We are inside a trigger
3002 **
3003 ** If all of the above are false, then we can run this code just once
3004 ** save the results, and reuse the same result on subsequent invocations.
3005 */
3006 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003007 /* If this routine has already been coded, then invoke it as a
3008 ** subroutine. */
3009 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003010 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003011 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3012 pExpr->y.sub.iAddr);
3013 return pExpr->iTable;
3014 }
3015
3016 /* Begin coding the subroutine */
3017 ExprSetProperty(pExpr, EP_Subrtn);
3018 pExpr->y.sub.regReturn = ++pParse->nMem;
3019 pExpr->y.sub.iAddr =
3020 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3021 VdbeComment((v, "return address"));
3022
drh2c041312018-12-24 02:34:49 +00003023 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003024 }
drh85bcdce2018-12-23 21:27:29 +00003025
3026 /* For a SELECT, generate code to put the values for all columns of
3027 ** the first row into an array of registers and return the index of
3028 ** the first register.
3029 **
3030 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3031 ** into a register and return that register number.
3032 **
3033 ** In both cases, the query is augmented with "LIMIT 1". Any
3034 ** preexisting limit is discarded in place of the new LIMIT 1.
3035 */
drhbd462bc2018-12-24 20:21:06 +00003036 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3037 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003038 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3039 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3040 pParse->nMem += nReg;
3041 if( pExpr->op==TK_SELECT ){
3042 dest.eDest = SRT_Mem;
3043 dest.iSdst = dest.iSDParm;
3044 dest.nSdst = nReg;
3045 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3046 VdbeComment((v, "Init subquery result"));
3047 }else{
3048 dest.eDest = SRT_Exists;
3049 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3050 VdbeComment((v, "Init EXISTS result"));
3051 }
drh85bcdce2018-12-23 21:27:29 +00003052 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003053 /* The subquery already has a limit. If the pre-existing limit is X
3054 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3055 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003056 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003057 if( pLimit ){
3058 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3059 pLimit = sqlite3PExpr(pParse, TK_NE,
3060 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3061 }
3062 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003063 pSel->pLimit->pLeft = pLimit;
3064 }else{
drh7ca13472019-09-23 11:55:22 +00003065 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003066 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003067 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3068 }
3069 pSel->iLimit = 0;
3070 if( sqlite3Select(pParse, pSel, &dest) ){
3071 return 0;
3072 }
drh2c041312018-12-24 02:34:49 +00003073 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003074 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003075 if( addrOnce ){
3076 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003077
drh5198ff52018-12-24 12:09:47 +00003078 /* Subroutine return */
3079 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3080 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003081 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003082 }
drh2c041312018-12-24 02:34:49 +00003083
drh1450bc62009-10-30 13:25:56 +00003084 return rReg;
drhcce7d172000-05-31 15:34:51 +00003085}
drh51522cd2005-01-20 13:36:19 +00003086#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003087
drhe3365e62009-11-12 17:52:24 +00003088#ifndef SQLITE_OMIT_SUBQUERY
3089/*
dan7b35a772016-07-28 19:47:15 +00003090** Expr pIn is an IN(...) expression. This function checks that the
3091** sub-select on the RHS of the IN() operator has the same number of
3092** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3093** a sub-query, that the LHS is a vector of size 1.
3094*/
3095int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3096 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3097 if( (pIn->flags & EP_xIsSelect) ){
3098 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3099 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3100 return 1;
3101 }
3102 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003103 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003104 return 1;
3105 }
3106 return 0;
3107}
3108#endif
3109
3110#ifndef SQLITE_OMIT_SUBQUERY
3111/*
drhe3365e62009-11-12 17:52:24 +00003112** Generate code for an IN expression.
3113**
3114** x IN (SELECT ...)
3115** x IN (value, value, ...)
3116**
drhecb87ac2016-08-25 15:46:25 +00003117** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003118** right-hand side (RHS) is an array of zero or more scalar values, or a
3119** subquery. If the RHS is a subquery, the number of result columns must
3120** match the number of columns in the vector on the LHS. If the RHS is
3121** a list of values, the LHS must be a scalar.
3122**
3123** The IN operator is true if the LHS value is contained within the RHS.
3124** The result is false if the LHS is definitely not in the RHS. The
3125** result is NULL if the presence of the LHS in the RHS cannot be
3126** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003127**
drh6be515e2014-08-01 21:00:53 +00003128** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003129** contained within the RHS. If due to NULLs we cannot determine if the LHS
3130** is contained in the RHS then jump to destIfNull. If the LHS is contained
3131** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003132**
3133** See the separate in-operator.md documentation file in the canonical
3134** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003135*/
3136static void sqlite3ExprCodeIN(
3137 Parse *pParse, /* Parsing and code generating context */
3138 Expr *pExpr, /* The IN expression */
3139 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3140 int destIfNull /* Jump here if the results are unknown due to NULLs */
3141){
3142 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003143 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003144 int rLhs; /* Register(s) holding the LHS values */
3145 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003146 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003147 int *aiMap = 0; /* Map from vector field to index column */
3148 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003149 int nVector; /* Size of vectors for this IN operator */
3150 int iDummy; /* Dummy parameter to exprCodeVector() */
3151 Expr *pLeft; /* The LHS of the IN operator */
3152 int i; /* loop counter */
3153 int destStep2; /* Where to jump when NULLs seen in step 2 */
3154 int destStep6 = 0; /* Start of code for Step 6 */
3155 int addrTruthOp; /* Address of opcode that determines the IN is true */
3156 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3157 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003158 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003159
drhe347d3e2016-08-25 21:14:34 +00003160 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003161 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003162 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003163 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3164 aiMap = (int*)sqlite3DbMallocZero(
3165 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3166 );
drhe347d3e2016-08-25 21:14:34 +00003167 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003168
danba00e302016-07-23 20:24:06 +00003169 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003170 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003171 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3172 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003173 v = pParse->pVdbe;
3174 assert( v!=0 ); /* OOM detected prior to this routine */
3175 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003176 eType = sqlite3FindInIndex(pParse, pExpr,
3177 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003178 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3179 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003180
danba00e302016-07-23 20:24:06 +00003181 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3182 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3183 );
drhecb87ac2016-08-25 15:46:25 +00003184#ifdef SQLITE_DEBUG
3185 /* Confirm that aiMap[] contains nVector integer values between 0 and
3186 ** nVector-1. */
3187 for(i=0; i<nVector; i++){
3188 int j, cnt;
3189 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3190 assert( cnt==1 );
3191 }
3192#endif
drhe3365e62009-11-12 17:52:24 +00003193
danba00e302016-07-23 20:24:06 +00003194 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3195 ** vector, then it is stored in an array of nVector registers starting
3196 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003197 **
3198 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3199 ** so that the fields are in the same order as an existing index. The
3200 ** aiMap[] array contains a mapping from the original LHS field order to
3201 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003202 */
drhe347d3e2016-08-25 21:14:34 +00003203 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3204 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003205 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003206 /* LHS fields are not reordered */
3207 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003208 }else{
3209 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003210 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003211 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003212 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003213 }
danba00e302016-07-23 20:24:06 +00003214 }
drhe3365e62009-11-12 17:52:24 +00003215
drhbb53ecb2014-08-02 21:03:33 +00003216 /* If sqlite3FindInIndex() did not find or create an index that is
3217 ** suitable for evaluating the IN operator, then evaluate using a
3218 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003219 **
3220 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003221 */
drhbb53ecb2014-08-02 21:03:33 +00003222 if( eType==IN_INDEX_NOOP ){
3223 ExprList *pList = pExpr->x.pList;
3224 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003225 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003226 int r2, regToFree;
3227 int regCkNull = 0;
3228 int ii;
drhdd668c22019-09-02 02:21:58 +00003229 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003230 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003231 if( destIfNull!=destIfFalse ){
3232 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003233 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003234 }
drhdd668c22019-09-02 02:21:58 +00003235 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003236 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003237 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003238 r2 = regToFree = sqlite3GetTempReg(pParse);
3239 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003240 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003241 }else{
3242 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003243 }
drha9769792014-08-04 16:39:39 +00003244 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003245 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3246 }
drhf6ea97e2020-01-04 15:21:47 +00003247 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003248 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003249 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3250 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003251 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003252 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3253 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3254 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3255 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003256 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003257 }else{
drh47994882019-12-22 23:48:36 +00003258 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003259 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003260 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3261 (void*)pColl, P4_COLLSEQ);
3262 VdbeCoverageIf(v, op==OP_Ne);
3263 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003264 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003265 }
drhbb53ecb2014-08-02 21:03:33 +00003266 }
3267 if( regCkNull ){
3268 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003269 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003270 }
3271 sqlite3VdbeResolveLabel(v, labelOk);
3272 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003273 goto sqlite3ExprCodeIN_finished;
3274 }
3275
3276 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3277 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3278 ** We will then skip the binary search of the RHS.
3279 */
3280 if( destIfNull==destIfFalse ){
3281 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003282 }else{
drhec4ccdb2018-12-29 02:26:59 +00003283 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003284 }
drh4eac5f02019-12-24 15:01:17 +00003285 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003286 for(i=0; i<nVector; i++){
3287 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3288 if( sqlite3ExprCanBeNull(p) ){
3289 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003290 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003291 }
drhe3365e62009-11-12 17:52:24 +00003292 }
drhe347d3e2016-08-25 21:14:34 +00003293
3294 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3295 ** of the RHS using the LHS as a probe. If found, the result is
3296 ** true.
3297 */
3298 if( eType==IN_INDEX_ROWID ){
3299 /* In this case, the RHS is the ROWID of table b-tree and so we also
3300 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3301 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003302 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003303 VdbeCoverage(v);
3304 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3305 }else{
3306 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3307 if( destIfFalse==destIfNull ){
3308 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003309 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003310 rLhs, nVector); VdbeCoverage(v);
3311 goto sqlite3ExprCodeIN_finished;
3312 }
3313 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003314 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003315 rLhs, nVector); VdbeCoverage(v);
3316 }
3317
3318 /* Step 4. If the RHS is known to be non-NULL and we did not find
3319 ** an match on the search above, then the result must be FALSE.
3320 */
3321 if( rRhsHasNull && nVector==1 ){
3322 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3323 VdbeCoverage(v);
3324 }
3325
3326 /* Step 5. If we do not care about the difference between NULL and
3327 ** FALSE, then just return false.
3328 */
3329 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3330
3331 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3332 ** If any comparison is NULL, then the result is NULL. If all
3333 ** comparisons are FALSE then the final result is FALSE.
3334 **
3335 ** For a scalar LHS, it is sufficient to check just the first row
3336 ** of the RHS.
3337 */
3338 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003339 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003340 VdbeCoverage(v);
3341 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003342 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003343 }else{
3344 /* For nVector==1, combine steps 6 and 7 by immediately returning
3345 ** FALSE if the first comparison is not NULL */
3346 destNotNull = destIfFalse;
3347 }
3348 for(i=0; i<nVector; i++){
3349 Expr *p;
3350 CollSeq *pColl;
3351 int r3 = sqlite3GetTempReg(pParse);
3352 p = sqlite3VectorFieldSubexpr(pLeft, i);
3353 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003354 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003355 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3356 (void*)pColl, P4_COLLSEQ);
3357 VdbeCoverage(v);
3358 sqlite3ReleaseTempReg(pParse, r3);
3359 }
3360 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3361 if( nVector>1 ){
3362 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003363 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003364 VdbeCoverage(v);
3365
3366 /* Step 7: If we reach this point, we know that the result must
3367 ** be false. */
3368 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3369 }
3370
3371 /* Jumps here in order to return true. */
3372 sqlite3VdbeJumpHere(v, addrTruthOp);
3373
3374sqlite3ExprCodeIN_finished:
3375 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003376 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003377sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003378 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003379 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003380}
3381#endif /* SQLITE_OMIT_SUBQUERY */
3382
drh13573c72010-01-12 17:04:07 +00003383#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003384/*
3385** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003386** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003387**
3388** The z[] string will probably not be zero-terminated. But the
3389** z[n] character is guaranteed to be something that does not look
3390** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003391*/
drhb7916a72009-05-27 10:31:29 +00003392static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003393 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003394 double value;
drh9339da12010-09-30 00:50:49 +00003395 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003396 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3397 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003398 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003399 }
3400}
drh13573c72010-01-12 17:04:07 +00003401#endif
drh598f1342007-10-23 15:39:45 +00003402
3403
3404/*
drhfec19aa2004-05-19 20:41:03 +00003405** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003406** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003407**
shaneh5f1d6b62010-09-30 16:51:25 +00003408** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003409*/
drh13573c72010-01-12 17:04:07 +00003410static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3411 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003412 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003413 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003414 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003415 if( negFlag ) i = -i;
3416 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003417 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003418 int c;
3419 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003420 const char *z = pExpr->u.zToken;
3421 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003422 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003423 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003424#ifdef SQLITE_OMIT_FLOATING_POINT
3425 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3426#else
drh1b7ddc52014-07-23 14:52:05 +00003427#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003428 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003429 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003430 }else
3431#endif
3432 {
drh9296c182014-07-23 13:40:49 +00003433 codeReal(v, z, negFlag, iMem);
3434 }
drh13573c72010-01-12 17:04:07 +00003435#endif
drh77320ea2016-11-30 14:47:37 +00003436 }else{
drh84d4f1a2017-09-20 10:47:10 +00003437 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003438 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003439 }
drhfec19aa2004-05-19 20:41:03 +00003440 }
3441}
3442
drh5cd79232009-05-25 11:46:29 +00003443
drh1f9ca2c2015-08-25 16:57:52 +00003444/* Generate code that will load into register regOut a value that is
3445** appropriate for the iIdxCol-th column of index pIdx.
3446*/
3447void sqlite3ExprCodeLoadIndexColumn(
3448 Parse *pParse, /* The parsing context */
3449 Index *pIdx, /* The index whose column is to be loaded */
3450 int iTabCur, /* Cursor pointing to a table row */
3451 int iIdxCol, /* The column of the index to be loaded */
3452 int regOut /* Store the index column value in this register */
3453){
3454 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003455 if( iTabCol==XN_EXPR ){
3456 assert( pIdx->aColExpr );
3457 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003458 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003459 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003460 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003461 }else{
drh6df9c4b2019-10-18 12:52:08 +00003462 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003463 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003464 }
drh1f9ca2c2015-08-25 16:57:52 +00003465}
3466
drhe70fa7f2019-10-22 21:01:34 +00003467#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3468/*
3469** Generate code that will compute the value of generated column pCol
3470** and store the result in register regOut
3471*/
3472void sqlite3ExprCodeGeneratedColumn(
3473 Parse *pParse,
3474 Column *pCol,
3475 int regOut
3476){
drh4dad7ed2019-12-16 16:52:22 +00003477 int iAddr;
3478 Vdbe *v = pParse->pVdbe;
3479 assert( v!=0 );
3480 assert( pParse->iSelfTab!=0 );
3481 if( pParse->iSelfTab>0 ){
3482 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3483 }else{
3484 iAddr = 0;
3485 }
drhe70fa7f2019-10-22 21:01:34 +00003486 sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3487 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003488 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003489 }
drh4dad7ed2019-12-16 16:52:22 +00003490 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003491}
3492#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3493
drh5cd79232009-05-25 11:46:29 +00003494/*
drh5c092e82010-05-14 19:24:02 +00003495** Generate code to extract the value of the iCol-th column of a table.
3496*/
3497void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003498 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003499 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003500 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003501 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003502 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003503){
drhab45fc02019-10-16 22:01:56 +00003504 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003505 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003506 if( pTab==0 ){
3507 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3508 return;
3509 }
drh5c092e82010-05-14 19:24:02 +00003510 if( iCol<0 || iCol==pTab->iPKey ){
3511 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3512 }else{
drh81f7b372019-10-16 12:18:59 +00003513 int op;
3514 int x;
3515 if( IsVirtual(pTab) ){
3516 op = OP_VColumn;
3517 x = iCol;
3518#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003519 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003520 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003521 if( pCol->colFlags & COLFLAG_BUSY ){
3522 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3523 }else{
3524 int savedSelfTab = pParse->iSelfTab;
3525 pCol->colFlags |= COLFLAG_BUSY;
3526 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003527 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003528 pParse->iSelfTab = savedSelfTab;
3529 pCol->colFlags &= ~COLFLAG_BUSY;
3530 }
drh81f7b372019-10-16 12:18:59 +00003531 return;
3532#endif
3533 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003534 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003535 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003536 op = OP_Column;
3537 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003538 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003539 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003540 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003541 }
3542 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003543 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3544 }
3545}
3546
3547/*
drh945498f2007-02-24 11:52:52 +00003548** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003549** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003550**
3551** There must be an open cursor to pTab in iTable when this routine
3552** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003553*/
drhe55cbd72008-03-31 23:48:03 +00003554int sqlite3ExprCodeGetColumn(
3555 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003556 Table *pTab, /* Description of the table we are reading from */
3557 int iColumn, /* Index of the table column */
3558 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003559 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003560 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003561){
drh81f7b372019-10-16 12:18:59 +00003562 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003563 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003564 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003565 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3566 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003567 }
drhe55cbd72008-03-31 23:48:03 +00003568 return iReg;
3569}
drhe55cbd72008-03-31 23:48:03 +00003570
3571/*
drhb21e7c72008-06-22 12:37:57 +00003572** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003573** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003574*/
drhb21e7c72008-06-22 12:37:57 +00003575void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003576 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003577}
3578
drh652fbf52008-04-01 01:42:41 +00003579/*
drh12abf402016-08-22 14:30:05 +00003580** Convert a scalar expression node to a TK_REGISTER referencing
3581** register iReg. The caller must ensure that iReg already contains
3582** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003583*/
dan069d1b12019-06-16 08:58:14 +00003584static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003585 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003586 p->op2 = p->op;
3587 p->op = TK_REGISTER;
3588 p->iTable = iReg;
3589 ExprClearProperty(p, EP_Skip);
3590}
3591
drh12abf402016-08-22 14:30:05 +00003592/*
3593** Evaluate an expression (either a vector or a scalar expression) and store
3594** the result in continguous temporary registers. Return the index of
3595** the first register used to store the result.
3596**
3597** If the returned result register is a temporary scalar, then also write
3598** that register number into *piFreeable. If the returned result register
3599** is not a temporary or if the expression is a vector set *piFreeable
3600** to 0.
3601*/
3602static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3603 int iResult;
3604 int nResult = sqlite3ExprVectorSize(p);
3605 if( nResult==1 ){
3606 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3607 }else{
3608 *piFreeable = 0;
3609 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003610#if SQLITE_OMIT_SUBQUERY
3611 iResult = 0;
3612#else
drh85bcdce2018-12-23 21:27:29 +00003613 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003614#endif
drh12abf402016-08-22 14:30:05 +00003615 }else{
3616 int i;
3617 iResult = pParse->nMem+1;
3618 pParse->nMem += nResult;
3619 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003620 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003621 }
3622 }
3623 }
3624 return iResult;
3625}
3626
drh25c42962020-01-01 13:55:08 +00003627/*
3628** Generate code to implement special SQL functions that are implemented
3629** in-line rather than by using the usual callbacks.
3630*/
3631static int exprCodeInlineFunction(
3632 Parse *pParse, /* Parsing context */
3633 ExprList *pFarg, /* List of function arguments */
3634 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3635 int target /* Store function result in this register */
3636){
3637 int nFarg;
3638 Vdbe *v = pParse->pVdbe;
3639 assert( v!=0 );
3640 assert( pFarg!=0 );
3641 nFarg = pFarg->nExpr;
3642 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3643 switch( iFuncId ){
3644 case INLINEFUNC_coalesce: {
3645 /* Attempt a direct implementation of the built-in COALESCE() and
3646 ** IFNULL() functions. This avoids unnecessary evaluation of
3647 ** arguments past the first non-NULL argument.
3648 */
3649 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3650 int i;
3651 assert( nFarg>=2 );
3652 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3653 for(i=1; i<nFarg; i++){
3654 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3655 VdbeCoverage(v);
3656 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3657 }
drh90996882020-01-03 14:16:43 +00003658 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3659 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3660 }
drh25c42962020-01-01 13:55:08 +00003661 sqlite3VdbeResolveLabel(v, endCoalesce);
3662 break;
3663 }
3664
drh171c50e2020-01-01 15:43:30 +00003665 default: {
drh25c42962020-01-01 13:55:08 +00003666 /* The UNLIKELY() function is a no-op. The result is the value
3667 ** of the first argument.
3668 */
drh171c50e2020-01-01 15:43:30 +00003669 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003670 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3671 break;
3672 }
3673
drh171c50e2020-01-01 15:43:30 +00003674 /***********************************************************************
3675 ** Test-only SQL functions that are only usable if enabled
3676 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3677 */
3678 case INLINEFUNC_expr_compare: {
3679 /* Compare two expressions using sqlite3ExprCompare() */
3680 assert( nFarg==2 );
3681 sqlite3VdbeAddOp2(v, OP_Integer,
3682 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3683 target);
3684 break;
3685 }
3686
3687 case INLINEFUNC_expr_implies_expr: {
3688 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3689 assert( nFarg==2 );
3690 sqlite3VdbeAddOp2(v, OP_Integer,
3691 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3692 target);
3693 break;
3694 }
3695
3696 case INLINEFUNC_implies_nonnull_row: {
3697 /* REsult of sqlite3ExprImpliesNonNullRow() */
3698 Expr *pA1;
3699 assert( nFarg==2 );
3700 pA1 = pFarg->a[1].pExpr;
3701 if( pA1->op==TK_COLUMN ){
3702 sqlite3VdbeAddOp2(v, OP_Integer,
3703 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3704 target);
3705 }else{
3706 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3707 }
3708 break;
3709 }
3710
drh25c42962020-01-01 13:55:08 +00003711#ifdef SQLITE_DEBUG
3712 case INLINEFUNC_affinity: {
3713 /* The AFFINITY() function evaluates to a string that describes
3714 ** the type affinity of the argument. This is used for testing of
3715 ** the SQLite type logic.
3716 */
3717 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3718 char aff;
3719 assert( nFarg==1 );
3720 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3721 sqlite3VdbeLoadString(v, target,
3722 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3723 break;
3724 }
3725#endif
3726 }
3727 return target;
3728}
3729
dan71c57db2016-07-09 20:23:55 +00003730
drha4c3c872013-09-12 17:29:25 +00003731/*
drhcce7d172000-05-31 15:34:51 +00003732** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003733** expression. Attempt to store the results in register "target".
3734** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003735**
drh8b213892008-08-29 02:14:02 +00003736** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003737** be stored in target. The result might be stored in some other
3738** register if it is convenient to do so. The calling function
3739** must check the return code and move the results to the desired
3740** register.
drhcce7d172000-05-31 15:34:51 +00003741*/
drh678ccce2008-03-31 18:19:54 +00003742int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003743 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3744 int op; /* The opcode being coded */
3745 int inReg = target; /* Results stored in register inReg */
3746 int regFree1 = 0; /* If non-zero free this temporary register */
3747 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003748 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003749 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003750 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003751
drh9cbf3422008-01-17 16:22:13 +00003752 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003753 if( v==0 ){
3754 assert( pParse->db->mallocFailed );
3755 return 0;
3756 }
drh389a1ad2008-01-03 23:44:53 +00003757
drh1efa8022018-04-28 04:16:43 +00003758expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003759 if( pExpr==0 ){
3760 op = TK_NULL;
3761 }else{
3762 op = pExpr->op;
3763 }
drhf2bc0132004-10-04 13:19:23 +00003764 switch( op ){
drh13449892005-09-07 21:22:45 +00003765 case TK_AGG_COLUMN: {
3766 AggInfo *pAggInfo = pExpr->pAggInfo;
3767 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3768 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003769 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003770 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003771 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003772 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003773 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003774 return target;
drh13449892005-09-07 21:22:45 +00003775 }
3776 /* Otherwise, fall thru into the TK_COLUMN case */
3777 }
drh967e8b72000-06-21 13:59:10 +00003778 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003779 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003780 int iReg;
drhefad2e22018-07-27 16:57:11 +00003781 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003782 /* This COLUMN expression is really a constant due to WHERE clause
3783 ** constraints, and that constant is coded by the pExpr->pLeft
3784 ** expresssion. However, make sure the constant has the correct
3785 ** datatype by applying the Affinity of the table column to the
3786 ** constant.
3787 */
drh57f7ece2019-11-21 18:28:44 +00003788 int aff;
drh67b9ba12019-12-20 20:45:02 +00003789 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003790 if( pExpr->y.pTab ){
3791 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3792 }else{
3793 aff = pExpr->affExpr;
3794 }
drh96fb16e2019-08-06 14:37:24 +00003795 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003796 static const char zAff[] = "B\000C\000D\000E";
3797 assert( SQLITE_AFF_BLOB=='A' );
3798 assert( SQLITE_AFF_TEXT=='B' );
3799 if( iReg!=target ){
3800 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3801 iReg = target;
3802 }
3803 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3804 &zAff[(aff-'B')*2], P4_STATIC);
3805 }
3806 return iReg;
drhefad2e22018-07-27 16:57:11 +00003807 }
drhb2b9d3d2013-08-01 01:14:43 +00003808 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003809 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003810 /* Other columns in the same row for CHECK constraints or
3811 ** generated columns or for inserting into partial index.
3812 ** The row is unpacked into registers beginning at
3813 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3814 ** immediately prior to the first column.
3815 */
3816 Column *pCol;
3817 Table *pTab = pExpr->y.pTab;
3818 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003819 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003820 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003821 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003822 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003823 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003824 return -1-pParse->iSelfTab;
3825 }
drhc5f808d2019-10-19 15:01:52 +00003826 pCol = pTab->aCol + iCol;
3827 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3828 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003829#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3830 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003831 if( pCol->colFlags & COLFLAG_BUSY ){
3832 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3833 pCol->zName);
3834 return 0;
3835 }
3836 pCol->colFlags |= COLFLAG_BUSY;
3837 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3838 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3839 }
3840 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003841 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003842 }else
3843#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3844 if( pCol->affinity==SQLITE_AFF_REAL ){
3845 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003846 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3847 return target;
3848 }else{
drh9942ef02019-10-18 02:19:18 +00003849 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003850 }
drhb2b9d3d2013-08-01 01:14:43 +00003851 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003852 /* Coding an expression that is part of an index where column names
3853 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003854 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003855 }
drh22827922000-06-06 17:27:05 +00003856 }
drh67b9ba12019-12-20 20:45:02 +00003857 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003858 pExpr->iColumn, iTab, target,
3859 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003860 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3861 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3862 }
3863 return iReg;
drhcce7d172000-05-31 15:34:51 +00003864 }
3865 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003866 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003867 return target;
drhfec19aa2004-05-19 20:41:03 +00003868 }
drh8abed7b2018-02-26 18:49:05 +00003869 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003870 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003871 return target;
3872 }
drh13573c72010-01-12 17:04:07 +00003873#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003874 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003875 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3876 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003877 return target;
drh598f1342007-10-23 15:39:45 +00003878 }
drh13573c72010-01-12 17:04:07 +00003879#endif
drhfec19aa2004-05-19 20:41:03 +00003880 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003881 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003882 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003883 return target;
drhcce7d172000-05-31 15:34:51 +00003884 }
drhaac30f92019-12-14 15:01:55 +00003885 default: {
drhc29af652019-12-18 21:22:40 +00003886 /* Make NULL the default case so that if a bug causes an illegal
3887 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003888 ** sanely and not crash. But keep the assert() to bring the problem
3889 ** to the attention of the developers. */
3890 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003891 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003892 return target;
drhf0863fe2005-06-12 21:35:51 +00003893 }
danielk19775338a5f2005-01-20 13:03:10 +00003894#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003895 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003896 int n;
3897 const char *z;
drhca48c902008-01-18 14:08:24 +00003898 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003899 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3900 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3901 assert( pExpr->u.zToken[1]=='\'' );
3902 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003903 n = sqlite3Strlen30(z) - 1;
3904 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003905 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3906 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003907 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003908 }
danielk19775338a5f2005-01-20 13:03:10 +00003909#endif
drh50457892003-09-06 01:10:47 +00003910 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003911 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3912 assert( pExpr->u.zToken!=0 );
3913 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003914 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3915 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003916 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003917 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003918 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003919 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003920 }
drhc332cc32016-09-19 10:24:19 +00003921 return target;
drh50457892003-09-06 01:10:47 +00003922 }
drh4e0cff62004-11-05 05:10:28 +00003923 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003924 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003925 }
drh487e2622005-06-25 18:42:14 +00003926#ifndef SQLITE_OMIT_CAST
3927 case TK_CAST: {
3928 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003929 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003930 if( inReg!=target ){
3931 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3932 inReg = target;
3933 }
drh4169e432014-08-25 20:11:52 +00003934 sqlite3VdbeAddOp2(v, OP_Cast, target,
3935 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003936 return inReg;
drh487e2622005-06-25 18:42:14 +00003937 }
3938#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003939 case TK_IS:
3940 case TK_ISNOT:
3941 op = (op==TK_IS) ? TK_EQ : TK_NE;
3942 p5 = SQLITE_NULLEQ;
3943 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003944 case TK_LT:
3945 case TK_LE:
3946 case TK_GT:
3947 case TK_GE:
3948 case TK_NE:
3949 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003950 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003951 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003952 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003953 }else{
3954 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3955 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3956 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00003957 r1, r2, inReg, SQLITE_STOREP2 | p5,
3958 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00003959 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3960 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3961 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3962 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3963 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3964 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3965 testcase( regFree1==0 );
3966 testcase( regFree2==0 );
3967 }
drh6a2fe092009-09-23 02:29:36 +00003968 break;
3969 }
drhcce7d172000-05-31 15:34:51 +00003970 case TK_AND:
3971 case TK_OR:
3972 case TK_PLUS:
3973 case TK_STAR:
3974 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003975 case TK_REM:
3976 case TK_BITAND:
3977 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003978 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003979 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003980 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003981 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003982 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3983 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3984 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3985 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3986 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3987 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3988 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3989 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3990 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3991 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3992 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003993 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3994 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003995 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003996 testcase( regFree1==0 );
3997 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003998 break;
3999 }
drhcce7d172000-05-31 15:34:51 +00004000 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004001 Expr *pLeft = pExpr->pLeft;
4002 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004003 if( pLeft->op==TK_INTEGER ){
4004 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004005 return target;
drh13573c72010-01-12 17:04:07 +00004006#ifndef SQLITE_OMIT_FLOATING_POINT
4007 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004008 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4009 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004010 return target;
drh13573c72010-01-12 17:04:07 +00004011#endif
drh3c84ddf2008-01-09 02:15:38 +00004012 }else{
drh10d1edf2013-11-15 15:52:39 +00004013 tempX.op = TK_INTEGER;
4014 tempX.flags = EP_IntValue|EP_TokenOnly;
4015 tempX.u.iValue = 0;
4016 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004017 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004018 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004019 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004020 }
drh3c84ddf2008-01-09 02:15:38 +00004021 break;
drh6e142f52000-06-08 13:36:40 +00004022 }
drhbf4133c2001-10-13 02:59:08 +00004023 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004024 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004025 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4026 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004027 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4028 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004029 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004030 break;
4031 }
drh8abed7b2018-02-26 18:49:05 +00004032 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004033 int isTrue; /* IS TRUE or IS NOT TRUE */
4034 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004035 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4036 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004037 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4038 bNormal = pExpr->op2==TK_IS;
4039 testcase( isTrue && bNormal);
4040 testcase( !isTrue && bNormal);
4041 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004042 break;
4043 }
drhcce7d172000-05-31 15:34:51 +00004044 case TK_ISNULL:
4045 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004046 int addr;
drh7d176102014-02-18 03:07:12 +00004047 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4048 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004049 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004050 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004051 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004052 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004053 VdbeCoverageIf(v, op==TK_ISNULL);
4054 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004055 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004056 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004057 break;
drhcce7d172000-05-31 15:34:51 +00004058 }
drh22827922000-06-06 17:27:05 +00004059 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004060 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00004061 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00004062 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4063 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004064 }else{
drhc332cc32016-09-19 10:24:19 +00004065 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004066 }
drh22827922000-06-06 17:27:05 +00004067 break;
4068 }
drhcce7d172000-05-31 15:34:51 +00004069 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004070 ExprList *pFarg; /* List of function arguments */
4071 int nFarg; /* Number of function arguments */
4072 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004073 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004074 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004075 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004076 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004077 u8 enc = ENC(db); /* The text encoding used by this database */
4078 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004079
dan67a9b8e2018-06-22 20:51:35 +00004080#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004081 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4082 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004083 }
dan67a9b8e2018-06-22 20:51:35 +00004084#endif
dan86fb6e12018-05-16 20:58:07 +00004085
drh1e9b53f2017-01-04 01:07:24 +00004086 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00004087 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00004088 ** out of the inner loop, even if that means an extra OP_Copy. */
4089 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004090 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004091 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00004092 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00004093 pFarg = 0;
4094 }else{
4095 pFarg = pExpr->x.pList;
4096 }
4097 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004098 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4099 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004100 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004101#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4102 if( pDef==0 && pParse->explain ){
4103 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4104 }
4105#endif
danb6e9f7a2018-05-19 14:15:29 +00004106 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004107 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004108 break;
4109 }
drh25c42962020-01-01 13:55:08 +00004110 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004111 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4112 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004113 return exprCodeInlineFunction(pParse, pFarg,
4114 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drhae6bb952009-11-11 00:24:31 +00004115 }
drh0dfa5252020-01-08 17:28:19 +00004116 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004117
drhd1a01ed2013-11-21 16:08:52 +00004118 for(i=0; i<nFarg; i++){
4119 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004120 testcase( i==31 );
4121 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004122 }
4123 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4124 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4125 }
4126 }
drh12ffee82009-04-08 13:51:51 +00004127 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004128 if( constMask ){
4129 r1 = pParse->nMem+1;
4130 pParse->nMem += nFarg;
4131 }else{
4132 r1 = sqlite3GetTempRange(pParse, nFarg);
4133 }
drha748fdc2012-03-28 01:34:47 +00004134
4135 /* For length() and typeof() functions with a column argument,
4136 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4137 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4138 ** loading.
4139 */
drhd36e1042013-09-06 13:10:12 +00004140 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004141 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004142 assert( nFarg==1 );
4143 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004144 exprOp = pFarg->a[0].pExpr->op;
4145 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004146 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4147 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004148 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4149 pFarg->a[0].pExpr->op2 =
4150 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004151 }
4152 }
4153
drh5579d592015-08-26 14:01:41 +00004154 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004155 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004156 }else{
drh12ffee82009-04-08 13:51:51 +00004157 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004158 }
drhb7f6f682006-07-08 17:06:43 +00004159#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004160 /* Possibly overload the function if the first argument is
4161 ** a virtual table column.
4162 **
4163 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4164 ** second argument, not the first, as the argument to test to
4165 ** see if it is a column in a virtual table. This is done because
4166 ** the left operand of infix functions (the operand we want to
4167 ** control overloading) ends up as the second argument to the
4168 ** function. The expression "A glob B" is equivalent to
4169 ** "glob(B,A). We want to use the A in "A glob B" to test
4170 ** for function overloading. But we use the B term in "glob(B,A)".
4171 */
drh59155062018-05-26 18:03:48 +00004172 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004173 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4174 }else if( nFarg>0 ){
4175 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004176 }
4177#endif
drhd36e1042013-09-06 13:10:12 +00004178 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004179 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004180 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004181 }
drh092457b2017-12-29 15:04:49 +00004182#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4183 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004184 Expr *pArg = pFarg->a[0].pExpr;
4185 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004186 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004187 }else{
4188 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4189 }
drh092457b2017-12-29 15:04:49 +00004190 }else
4191#endif
4192 {
drh920cf592019-10-30 16:29:02 +00004193 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004194 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004195 }
drh13d79502019-12-23 02:18:49 +00004196 if( nFarg ){
4197 if( constMask==0 ){
4198 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4199 }else{
drh3aef2fb2020-01-02 17:46:02 +00004200 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004201 }
drh2dcef112008-01-12 19:03:48 +00004202 }
drhc332cc32016-09-19 10:24:19 +00004203 return target;
drhcce7d172000-05-31 15:34:51 +00004204 }
drhfe2093d2005-01-20 22:48:47 +00004205#ifndef SQLITE_OMIT_SUBQUERY
4206 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004207 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004208 int nCol;
drhc5499be2008-04-01 15:06:33 +00004209 testcase( op==TK_EXISTS );
4210 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004211 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4212 sqlite3SubselectError(pParse, nCol, 1);
4213 }else{
drh85bcdce2018-12-23 21:27:29 +00004214 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004215 }
drh19a775c2000-06-05 18:54:46 +00004216 break;
4217 }
drhfc7f27b2016-08-20 00:07:01 +00004218 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004219 int n;
drhfc7f27b2016-08-20 00:07:01 +00004220 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004221 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004222 }
drh966e2912017-01-03 02:58:01 +00004223 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004224 if( pExpr->iTable!=0
4225 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004226 ){
4227 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4228 pExpr->iTable, n);
4229 }
drhc332cc32016-09-19 10:24:19 +00004230 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004231 }
drhfef52082000-06-06 01:50:43 +00004232 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004233 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4234 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004235 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4236 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4237 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4238 sqlite3VdbeResolveLabel(v, destIfFalse);
4239 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4240 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004241 return target;
drhfef52082000-06-06 01:50:43 +00004242 }
drhe3365e62009-11-12 17:52:24 +00004243#endif /* SQLITE_OMIT_SUBQUERY */
4244
4245
drh2dcef112008-01-12 19:03:48 +00004246 /*
4247 ** x BETWEEN y AND z
4248 **
4249 ** This is equivalent to
4250 **
4251 ** x>=y AND x<=z
4252 **
4253 ** X is stored in pExpr->pLeft.
4254 ** Y is stored in pExpr->pList->a[0].pExpr.
4255 ** Z is stored in pExpr->pList->a[1].pExpr.
4256 */
drhfef52082000-06-06 01:50:43 +00004257 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004258 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004259 return target;
drhfef52082000-06-06 01:50:43 +00004260 }
drh94fa9c42016-02-27 21:16:04 +00004261 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004262 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004263 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004264 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004265 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004266 }
drh2dcef112008-01-12 19:03:48 +00004267
dan165921a2009-08-28 18:53:45 +00004268 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004269 /* If the opcode is TK_TRIGGER, then the expression is a reference
4270 ** to a column in the new.* or old.* pseudo-tables available to
4271 ** trigger programs. In this case Expr.iTable is set to 1 for the
4272 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4273 ** is set to the column of the pseudo-table to read, or to -1 to
4274 ** read the rowid field.
4275 **
4276 ** The expression is implemented using an OP_Param opcode. The p1
4277 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4278 ** to reference another column of the old.* pseudo-table, where
4279 ** i is the index of the column. For a new.rowid reference, p1 is
4280 ** set to (n+1), where n is the number of columns in each pseudo-table.
4281 ** For a reference to any other column in the new.* pseudo-table, p1
4282 ** is set to (n+2+i), where n and i are as defined previously. For
4283 ** example, if the table on which triggers are being fired is
4284 ** declared as:
4285 **
4286 ** CREATE TABLE t1(a, b);
4287 **
4288 ** Then p1 is interpreted as follows:
4289 **
4290 ** p1==0 -> old.rowid p1==3 -> new.rowid
4291 ** p1==1 -> old.a p1==4 -> new.a
4292 ** p1==2 -> old.b p1==5 -> new.b
4293 */
drheda079c2018-09-20 19:02:15 +00004294 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004295 int iCol = pExpr->iColumn;
4296 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004297 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004298
4299 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004300 assert( iCol>=-1 && iCol<pTab->nCol );
4301 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004302 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4303
4304 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004305 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004306 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004307 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004308 ));
dan65a7cd12009-09-01 12:16:01 +00004309
drh44dbca82010-01-13 04:22:20 +00004310#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004311 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004312 ** integer. Use OP_RealAffinity to make sure it is really real.
4313 **
4314 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4315 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004316 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004317 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4318 }
drh44dbca82010-01-13 04:22:20 +00004319#endif
dan165921a2009-08-28 18:53:45 +00004320 break;
4321 }
4322
dan71c57db2016-07-09 20:23:55 +00004323 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004324 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004325 break;
4326 }
4327
drh9e9a67a2019-08-17 17:07:15 +00004328 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4329 ** that derive from the right-hand table of a LEFT JOIN. The
4330 ** Expr.iTable value is the table number for the right-hand table.
4331 ** The expression is only evaluated if that table is not currently
4332 ** on a LEFT JOIN NULL row.
4333 */
drh31d6fd52017-04-14 19:03:10 +00004334 case TK_IF_NULL_ROW: {
4335 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004336 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004337 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004338 /* Temporarily disable factoring of constant expressions, since
4339 ** even though expressions may appear to be constant, they are not
4340 ** really constant because they originate from the right-hand side
4341 ** of a LEFT JOIN. */
4342 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004343 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004344 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004345 sqlite3VdbeJumpHere(v, addrINR);
4346 sqlite3VdbeChangeP3(v, addrINR, inReg);
4347 break;
4348 }
4349
drh2dcef112008-01-12 19:03:48 +00004350 /*
4351 ** Form A:
4352 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4353 **
4354 ** Form B:
4355 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4356 **
4357 ** Form A is can be transformed into the equivalent form B as follows:
4358 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4359 ** WHEN x=eN THEN rN ELSE y END
4360 **
4361 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004362 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4363 ** odd. The Y is also optional. If the number of elements in x.pList
4364 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004365 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4366 **
4367 ** The result of the expression is the Ri for the first matching Ei,
4368 ** or if there is no matching Ei, the ELSE term Y, or if there is
4369 ** no ELSE term, NULL.
4370 */
drhaac30f92019-12-14 15:01:55 +00004371 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004372 int endLabel; /* GOTO label for end of CASE stmt */
4373 int nextCase; /* GOTO label for next WHEN clause */
4374 int nExpr; /* 2x number of WHEN terms */
4375 int i; /* Loop counter */
4376 ExprList *pEList; /* List of WHEN terms */
4377 struct ExprList_item *aListelem; /* Array of WHEN terms */
4378 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004379 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004380 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004381 Expr *pDel = 0;
4382 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004383
danielk19776ab3a2e2009-02-19 14:39:25 +00004384 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004385 assert(pExpr->x.pList->nExpr > 0);
4386 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004387 aListelem = pEList->a;
4388 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004389 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004390 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004391 pDel = sqlite3ExprDup(db, pX, 0);
4392 if( db->mallocFailed ){
4393 sqlite3ExprDelete(db, pDel);
4394 break;
4395 }
drh33cd4902009-05-30 20:49:20 +00004396 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004397 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004398 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004399 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004400 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004401 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004402 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004403 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4404 ** The value in regFree1 might get SCopy-ed into the file result.
4405 ** So make sure that the regFree1 register is not reused for other
4406 ** purposes and possibly overwritten. */
4407 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004408 }
drhc5cd1242013-09-12 16:50:49 +00004409 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004410 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004411 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004412 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004413 }else{
drh2dcef112008-01-12 19:03:48 +00004414 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004415 }
drhec4ccdb2018-12-29 02:26:59 +00004416 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004417 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004418 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004419 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004420 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004421 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004422 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004423 }
drhc5cd1242013-09-12 16:50:49 +00004424 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004425 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004426 }else{
drh9de221d2008-01-05 06:51:30 +00004427 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004428 }
dan8b65e592019-07-17 14:34:17 +00004429 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004430 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004431 break;
4432 }
danielk19775338a5f2005-01-20 13:03:10 +00004433#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004434 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004435 assert( pExpr->affExpr==OE_Rollback
4436 || pExpr->affExpr==OE_Abort
4437 || pExpr->affExpr==OE_Fail
4438 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004439 );
dane0af83a2009-09-08 19:15:01 +00004440 if( !pParse->pTriggerTab ){
4441 sqlite3ErrorMsg(pParse,
4442 "RAISE() may only be used within a trigger-program");
4443 return 0;
4444 }
drh11949042019-08-05 18:01:42 +00004445 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004446 sqlite3MayAbort(pParse);
4447 }
dan165921a2009-08-28 18:53:45 +00004448 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004449 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004450 sqlite3VdbeAddOp4(
4451 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004452 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004453 }else{
drh433dccf2013-02-09 15:37:11 +00004454 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004455 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004456 }
4457
drhffe07b22005-11-03 00:41:17 +00004458 break;
drh17a7f8d2002-03-24 13:13:27 +00004459 }
danielk19775338a5f2005-01-20 13:03:10 +00004460#endif
drhffe07b22005-11-03 00:41:17 +00004461 }
drh2dcef112008-01-12 19:03:48 +00004462 sqlite3ReleaseTempReg(pParse, regFree1);
4463 sqlite3ReleaseTempReg(pParse, regFree2);
4464 return inReg;
4465}
4466
4467/*
drhd1a01ed2013-11-21 16:08:52 +00004468** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004469**
drhad879ff2017-01-04 04:10:02 +00004470** If regDest>=0 then the result is always stored in that register and the
4471** result is not reusable. If regDest<0 then this routine is free to
4472** store the value whereever it wants. The register where the expression
4473** is stored is returned. When regDest<0, two identical expressions will
4474** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004475*/
drh1e9b53f2017-01-04 01:07:24 +00004476int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004477 Parse *pParse, /* Parsing context */
4478 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004479 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004480){
drhd1a01ed2013-11-21 16:08:52 +00004481 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004482 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004483 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004484 if( regDest<0 && p ){
4485 struct ExprList_item *pItem;
4486 int i;
4487 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004488 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004489 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004490 }
4491 }
drh1e9b53f2017-01-04 01:07:24 +00004492 }
drhd1a01ed2013-11-21 16:08:52 +00004493 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4494 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004495 if( p ){
4496 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004497 pItem->reusable = regDest<0;
4498 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004499 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004500 }
drhd1a01ed2013-11-21 16:08:52 +00004501 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004502 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004503}
4504
4505/*
drh2dcef112008-01-12 19:03:48 +00004506** Generate code to evaluate an expression and store the results
4507** into a register. Return the register number where the results
4508** are stored.
4509**
4510** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004511** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004512** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004513**
4514** If pExpr is a constant, then this routine might generate this
4515** code to fill the register in the initialization section of the
4516** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004517*/
4518int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004519 int r2;
drh0d950af2019-08-22 16:38:42 +00004520 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004521 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004522 && pExpr->op!=TK_REGISTER
4523 && sqlite3ExprIsConstantNotJoin(pExpr)
4524 ){
drhf30a9692013-11-15 01:10:18 +00004525 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004526 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004527 }else{
drhf30a9692013-11-15 01:10:18 +00004528 int r1 = sqlite3GetTempReg(pParse);
4529 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4530 if( r2==r1 ){
4531 *pReg = r1;
4532 }else{
4533 sqlite3ReleaseTempReg(pParse, r1);
4534 *pReg = 0;
4535 }
drh2dcef112008-01-12 19:03:48 +00004536 }
4537 return r2;
4538}
4539
4540/*
4541** Generate code that will evaluate expression pExpr and store the
4542** results in register target. The results are guaranteed to appear
4543** in register target.
4544*/
drh05a86c52014-02-16 01:55:49 +00004545void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004546 int inReg;
4547
4548 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004549 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4550 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4551 if( inReg!=target && pParse->pVdbe ){
drh629b88c2020-01-02 02:50:45 +00004552 u8 op;
4553 if( ExprHasProperty(pExpr,EP_Subquery) ){
4554 op = OP_Copy;
4555 }else{
4556 op = OP_SCopy;
4557 }
4558 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004559 }
drhcce7d172000-05-31 15:34:51 +00004560}
4561
4562/*
drh1c75c9d2015-12-21 15:22:13 +00004563** Make a transient copy of expression pExpr and then code it using
4564** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4565** except that the input expression is guaranteed to be unchanged.
4566*/
4567void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4568 sqlite3 *db = pParse->db;
4569 pExpr = sqlite3ExprDup(db, pExpr, 0);
4570 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4571 sqlite3ExprDelete(db, pExpr);
4572}
4573
4574/*
drh05a86c52014-02-16 01:55:49 +00004575** Generate code that will evaluate expression pExpr and store the
4576** results in register target. The results are guaranteed to appear
4577** in register target. If the expression is constant, then this routine
4578** might choose to code the expression at initialization time.
4579*/
4580void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004581 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004582 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004583 }else{
4584 sqlite3ExprCode(pParse, pExpr, target);
4585 }
drhcce7d172000-05-31 15:34:51 +00004586}
4587
4588/*
drh268380c2004-02-25 13:47:31 +00004589** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004590** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004591**
drh3df6c3b2017-09-15 15:38:01 +00004592** Return the number of elements evaluated. The number returned will
4593** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4594** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004595**
4596** The SQLITE_ECEL_DUP flag prevents the arguments from being
4597** filled using OP_SCopy. OP_Copy must be used instead.
4598**
4599** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4600** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004601**
4602** The SQLITE_ECEL_REF flag means that expressions in the list with
4603** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4604** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004605** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4606** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004607*/
danielk19774adee202004-05-08 08:23:19 +00004608int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004609 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004610 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004611 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004612 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004613 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004614){
4615 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004616 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004617 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004618 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004619 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004620 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004621 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004622 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004623 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004624 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004625 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004626#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4627 if( pItem->bSorterRef ){
4628 i--;
4629 n--;
4630 }else
4631#endif
dan257c13f2016-11-10 20:14:06 +00004632 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4633 if( flags & SQLITE_ECEL_OMITREF ){
4634 i--;
4635 n--;
4636 }else{
4637 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4638 }
drhb8b06692018-08-04 15:16:20 +00004639 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4640 && sqlite3ExprIsConstantNotJoin(pExpr)
4641 ){
drhad879ff2017-01-04 04:10:02 +00004642 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004643 }else{
4644 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4645 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004646 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004647 if( copyOp==OP_Copy
4648 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4649 && pOp->p1+pOp->p3+1==inReg
4650 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004651 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004652 ){
4653 pOp->p3++;
4654 }else{
4655 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4656 }
drhd1a01ed2013-11-21 16:08:52 +00004657 }
drhd1766112008-09-17 00:13:12 +00004658 }
drh268380c2004-02-25 13:47:31 +00004659 }
drhf9b596e2004-05-26 16:54:42 +00004660 return n;
drh268380c2004-02-25 13:47:31 +00004661}
4662
4663/*
drh36c563a2009-11-12 13:32:22 +00004664** Generate code for a BETWEEN operator.
4665**
4666** x BETWEEN y AND z
4667**
4668** The above is equivalent to
4669**
4670** x>=y AND x<=z
4671**
4672** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004673** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004674**
4675** The xJumpIf parameter determines details:
4676**
4677** NULL: Store the boolean result in reg[dest]
4678** sqlite3ExprIfTrue: Jump to dest if true
4679** sqlite3ExprIfFalse: Jump to dest if false
4680**
4681** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004682*/
4683static void exprCodeBetween(
4684 Parse *pParse, /* Parsing and code generating context */
4685 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004686 int dest, /* Jump destination or storage location */
4687 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004688 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4689){
dan8b65e592019-07-17 14:34:17 +00004690 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004691 Expr compLeft; /* The x>=y term */
4692 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004693 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004694 Expr *pDel = 0;
4695 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004696
dan71c57db2016-07-09 20:23:55 +00004697 memset(&compLeft, 0, sizeof(Expr));
4698 memset(&compRight, 0, sizeof(Expr));
4699 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004700
4701 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004702 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4703 if( db->mallocFailed==0 ){
4704 exprAnd.op = TK_AND;
4705 exprAnd.pLeft = &compLeft;
4706 exprAnd.pRight = &compRight;
4707 compLeft.op = TK_GE;
4708 compLeft.pLeft = pDel;
4709 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4710 compRight.op = TK_LE;
4711 compRight.pLeft = pDel;
4712 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4713 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4714 if( xJump ){
4715 xJump(pParse, &exprAnd, dest, jumpIfNull);
4716 }else{
4717 /* Mark the expression is being from the ON or USING clause of a join
4718 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4719 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4720 ** for clarity, but we are out of bits in the Expr.flags field so we
4721 ** have to reuse the EP_FromJoin bit. Bummer. */
4722 pDel->flags |= EP_FromJoin;
4723 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4724 }
4725 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004726 }
dan8b65e592019-07-17 14:34:17 +00004727 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004728
4729 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004730 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4731 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4732 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4733 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4734 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4735 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4736 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4737 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004738 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004739}
4740
4741/*
drhcce7d172000-05-31 15:34:51 +00004742** Generate code for a boolean expression such that a jump is made
4743** to the label "dest" if the expression is true but execution
4744** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004745**
4746** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004747** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004748**
4749** This code depends on the fact that certain token values (ex: TK_EQ)
4750** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4751** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4752** the make process cause these values to align. Assert()s in the code
4753** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004754*/
danielk19774adee202004-05-08 08:23:19 +00004755void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004756 Vdbe *v = pParse->pVdbe;
4757 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004758 int regFree1 = 0;
4759 int regFree2 = 0;
4760 int r1, r2;
4761
drh35573352008-01-08 23:54:25 +00004762 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004763 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004764 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004765 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004766 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004767 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004768 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004769 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4770 if( pAlt!=pExpr ){
4771 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4772 }else if( op==TK_AND ){
4773 int d2 = sqlite3VdbeMakeLabel(pParse);
4774 testcase( jumpIfNull==0 );
4775 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4776 jumpIfNull^SQLITE_JUMPIFNULL);
4777 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4778 sqlite3VdbeResolveLabel(v, d2);
4779 }else{
4780 testcase( jumpIfNull==0 );
4781 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4782 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4783 }
drhcce7d172000-05-31 15:34:51 +00004784 break;
4785 }
4786 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004787 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004788 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004789 break;
4790 }
drh8abed7b2018-02-26 18:49:05 +00004791 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004792 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4793 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004794 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004795 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004796 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004797 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004798 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004799 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004800 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4801 isNot ? SQLITE_JUMPIFNULL : 0);
4802 }else{
4803 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4804 isNot ? SQLITE_JUMPIFNULL : 0);
4805 }
drh007c8432018-02-26 03:20:18 +00004806 break;
4807 }
drhde845c22016-03-17 19:07:52 +00004808 case TK_IS:
4809 case TK_ISNOT:
4810 testcase( op==TK_IS );
4811 testcase( op==TK_ISNOT );
4812 op = (op==TK_IS) ? TK_EQ : TK_NE;
4813 jumpIfNull = SQLITE_NULLEQ;
4814 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004815 case TK_LT:
4816 case TK_LE:
4817 case TK_GT:
4818 case TK_GE:
4819 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004820 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004821 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004822 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004823 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4824 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004825 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004826 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004827 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4828 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4829 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4830 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004831 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4832 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4833 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4834 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4835 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4836 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004837 testcase( regFree1==0 );
4838 testcase( regFree2==0 );
4839 break;
4840 }
drhcce7d172000-05-31 15:34:51 +00004841 case TK_ISNULL:
4842 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004843 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4844 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004845 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4846 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004847 VdbeCoverageIf(v, op==TK_ISNULL);
4848 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004849 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004850 break;
4851 }
drhfef52082000-06-06 01:50:43 +00004852 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004853 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004854 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004855 break;
4856 }
drh84e30ca2011-02-10 17:46:14 +00004857#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004858 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004859 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004860 int destIfNull = jumpIfNull ? dest : destIfFalse;
4861 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004862 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004863 sqlite3VdbeResolveLabel(v, destIfFalse);
4864 break;
4865 }
shanehbb201342011-02-09 19:55:20 +00004866#endif
drhcce7d172000-05-31 15:34:51 +00004867 default: {
dan7b35a772016-07-28 19:47:15 +00004868 default_expr:
drhad317272019-04-19 16:21:51 +00004869 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004870 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004871 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004872 /* No-op */
4873 }else{
4874 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4875 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004876 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004877 testcase( regFree1==0 );
4878 testcase( jumpIfNull==0 );
4879 }
drhcce7d172000-05-31 15:34:51 +00004880 break;
4881 }
4882 }
drh2dcef112008-01-12 19:03:48 +00004883 sqlite3ReleaseTempReg(pParse, regFree1);
4884 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004885}
4886
4887/*
drh66b89c82000-11-28 20:47:17 +00004888** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004889** to the label "dest" if the expression is false but execution
4890** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004891**
4892** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004893** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4894** is 0.
drhcce7d172000-05-31 15:34:51 +00004895*/
danielk19774adee202004-05-08 08:23:19 +00004896void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004897 Vdbe *v = pParse->pVdbe;
4898 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004899 int regFree1 = 0;
4900 int regFree2 = 0;
4901 int r1, r2;
4902
drh35573352008-01-08 23:54:25 +00004903 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004904 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004905 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004906
4907 /* The value of pExpr->op and op are related as follows:
4908 **
4909 ** pExpr->op op
4910 ** --------- ----------
4911 ** TK_ISNULL OP_NotNull
4912 ** TK_NOTNULL OP_IsNull
4913 ** TK_NE OP_Eq
4914 ** TK_EQ OP_Ne
4915 ** TK_GT OP_Le
4916 ** TK_LE OP_Gt
4917 ** TK_GE OP_Lt
4918 ** TK_LT OP_Ge
4919 **
4920 ** For other values of pExpr->op, op is undefined and unused.
4921 ** The value of TK_ and OP_ constants are arranged such that we
4922 ** can compute the mapping above using the following expression.
4923 ** Assert()s verify that the computation is correct.
4924 */
4925 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4926
4927 /* Verify correct alignment of TK_ and OP_ constants
4928 */
4929 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4930 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4931 assert( pExpr->op!=TK_NE || op==OP_Eq );
4932 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4933 assert( pExpr->op!=TK_LT || op==OP_Ge );
4934 assert( pExpr->op!=TK_LE || op==OP_Gt );
4935 assert( pExpr->op!=TK_GT || op==OP_Le );
4936 assert( pExpr->op!=TK_GE || op==OP_Lt );
4937
danba00e302016-07-23 20:24:06 +00004938 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004939 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004940 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004941 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4942 if( pAlt!=pExpr ){
4943 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4944 }else if( pExpr->op==TK_AND ){
4945 testcase( jumpIfNull==0 );
4946 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4947 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4948 }else{
4949 int d2 = sqlite3VdbeMakeLabel(pParse);
4950 testcase( jumpIfNull==0 );
4951 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4952 jumpIfNull^SQLITE_JUMPIFNULL);
4953 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4954 sqlite3VdbeResolveLabel(v, d2);
4955 }
drhcce7d172000-05-31 15:34:51 +00004956 break;
4957 }
4958 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004959 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004960 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004961 break;
4962 }
drh8abed7b2018-02-26 18:49:05 +00004963 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004964 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4965 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004966 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004967 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004968 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004969 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004970 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004971 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004972 /* IS TRUE and IS NOT FALSE */
4973 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4974 isNot ? 0 : SQLITE_JUMPIFNULL);
4975
4976 }else{
4977 /* IS FALSE and IS NOT TRUE */
4978 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004979 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004980 }
drh007c8432018-02-26 03:20:18 +00004981 break;
4982 }
drhde845c22016-03-17 19:07:52 +00004983 case TK_IS:
4984 case TK_ISNOT:
4985 testcase( pExpr->op==TK_IS );
4986 testcase( pExpr->op==TK_ISNOT );
4987 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4988 jumpIfNull = SQLITE_NULLEQ;
4989 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004990 case TK_LT:
4991 case TK_LE:
4992 case TK_GT:
4993 case TK_GE:
4994 case TK_NE:
4995 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004996 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004997 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004998 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4999 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005000 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005001 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005002 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5003 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5004 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5005 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005006 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5007 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5008 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5009 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5010 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5011 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005012 testcase( regFree1==0 );
5013 testcase( regFree2==0 );
5014 break;
5015 }
drhcce7d172000-05-31 15:34:51 +00005016 case TK_ISNULL:
5017 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005018 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5019 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005020 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5021 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005022 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005023 break;
5024 }
drhfef52082000-06-06 01:50:43 +00005025 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005026 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005027 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005028 break;
5029 }
drh84e30ca2011-02-10 17:46:14 +00005030#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005031 case TK_IN: {
5032 if( jumpIfNull ){
5033 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5034 }else{
drhec4ccdb2018-12-29 02:26:59 +00005035 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005036 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5037 sqlite3VdbeResolveLabel(v, destIfNull);
5038 }
5039 break;
5040 }
shanehbb201342011-02-09 19:55:20 +00005041#endif
drhcce7d172000-05-31 15:34:51 +00005042 default: {
danba00e302016-07-23 20:24:06 +00005043 default_expr:
drhad317272019-04-19 16:21:51 +00005044 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005045 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005046 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005047 /* no-op */
5048 }else{
5049 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5050 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005051 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005052 testcase( regFree1==0 );
5053 testcase( jumpIfNull==0 );
5054 }
drhcce7d172000-05-31 15:34:51 +00005055 break;
5056 }
5057 }
drh2dcef112008-01-12 19:03:48 +00005058 sqlite3ReleaseTempReg(pParse, regFree1);
5059 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005060}
drh22827922000-06-06 17:27:05 +00005061
5062/*
drh72bc8202015-06-11 13:58:35 +00005063** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5064** code generation, and that copy is deleted after code generation. This
5065** ensures that the original pExpr is unchanged.
5066*/
5067void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5068 sqlite3 *db = pParse->db;
5069 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5070 if( db->mallocFailed==0 ){
5071 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5072 }
5073 sqlite3ExprDelete(db, pCopy);
5074}
5075
dan5aa550c2017-06-24 18:10:29 +00005076/*
5077** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5078** type of expression.
5079**
5080** If pExpr is a simple SQL value - an integer, real, string, blob
5081** or NULL value - then the VDBE currently being prepared is configured
5082** to re-prepare each time a new value is bound to variable pVar.
5083**
5084** Additionally, if pExpr is a simple SQL value and the value is the
5085** same as that currently bound to variable pVar, non-zero is returned.
5086** Otherwise, if the values are not the same or if pExpr is not a simple
5087** SQL value, zero is returned.
5088*/
5089static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5090 int res = 0;
drhc0804222017-06-28 21:47:16 +00005091 int iVar;
5092 sqlite3_value *pL, *pR = 0;
5093
5094 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5095 if( pR ){
5096 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005097 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005098 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005099 if( pL ){
5100 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5101 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5102 }
5103 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005104 }
drhc0804222017-06-28 21:47:16 +00005105 sqlite3ValueFree(pR);
5106 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005107 }
5108
5109 return res;
5110}
drh72bc8202015-06-11 13:58:35 +00005111
5112/*
drh1d9da702010-01-07 15:17:02 +00005113** Do a deep comparison of two expression trees. Return 0 if the two
5114** expressions are completely identical. Return 1 if they differ only
5115** by a COLLATE operator at the top level. Return 2 if there are differences
5116** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005117**
drh619a1302013-08-01 13:04:46 +00005118** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5119** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5120**
drh66518ca2013-08-01 15:09:57 +00005121** The pA side might be using TK_REGISTER. If that is the case and pB is
5122** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5123**
drh1d9da702010-01-07 15:17:02 +00005124** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005125** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005126** identical, we return 2 just to be safe. So if this routine
5127** returns 2, then you do not really know for certain if the two
5128** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005129** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005130** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005131** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005132** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005133**
drhc0804222017-06-28 21:47:16 +00005134** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5135** pParse->pReprepare can be matched against literals in pB. The
5136** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5137** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5138** Argument pParse should normally be NULL. If it is not NULL and pA or
5139** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005140*/
dan5aa550c2017-06-24 18:10:29 +00005141int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005142 u32 combinedFlags;
5143 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005144 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005145 }
dan5aa550c2017-06-24 18:10:29 +00005146 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5147 return 0;
5148 }
drh10d1edf2013-11-15 15:52:39 +00005149 combinedFlags = pA->flags | pB->flags;
5150 if( combinedFlags & EP_IntValue ){
5151 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5152 return 0;
5153 }
drh1d9da702010-01-07 15:17:02 +00005154 return 2;
drh22827922000-06-06 17:27:05 +00005155 }
dan16dd3982018-12-20 15:04:38 +00005156 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005157 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005158 return 1;
5159 }
dan5aa550c2017-06-24 18:10:29 +00005160 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005161 return 1;
5162 }
5163 return 2;
5164 }
drh2edc5fd2015-11-24 02:10:52 +00005165 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005166 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005167 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005168#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005169 assert( pA->op==pB->op );
5170 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5171 return 2;
5172 }
drheda079c2018-09-20 19:02:15 +00005173 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005174 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5175 return 2;
5176 }
drheda079c2018-09-20 19:02:15 +00005177 }
5178#endif
drhf20bbc52019-01-17 01:06:00 +00005179 }else if( pA->op==TK_NULL ){
5180 return 0;
drhd5af5422018-04-13 14:27:01 +00005181 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005182 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005183 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005184 return 2;
drh2646da72005-12-09 20:02:05 +00005185 }
drh22827922000-06-06 17:27:05 +00005186 }
drh898c5272019-10-22 00:03:41 +00005187 if( (pA->flags & (EP_Distinct|EP_Commuted))
5188 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drh89b6de02018-12-12 20:11:23 +00005189 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00005190 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005191 if( (combinedFlags & EP_FixedCol)==0
5192 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005193 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005194 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005195 if( pA->op!=TK_STRING
5196 && pA->op!=TK_TRUEFALSE
5197 && (combinedFlags & EP_Reduced)==0
5198 ){
drh10d1edf2013-11-15 15:52:39 +00005199 if( pA->iColumn!=pB->iColumn ) return 2;
drh04307c82019-10-31 13:16:26 +00005200 if( pA->op2!=pB->op2 ){
5201 if( pA->op==TK_TRUTH ) return 2;
5202 if( pA->op==TK_FUNCTION && iTab<0 ){
5203 /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
5204 ** INSERT INTO t1(a) VALUES(julianday('now')+10);
5205 ** Without this test, sqlite3ExprCodeAtInit() will run on the
5206 ** the julianday() of INSERT first, and remember that expression.
5207 ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
5208 ** constraint as redundant, reusing the one from the INSERT, even
5209 ** though the julianday() in INSERT lacks the critical NC_IsCheck
5210 ** flag. See ticket [830277d9db6c3ba1] (2019-10-30)
5211 */
5212 return 2;
5213 }
5214 }
drh0f28e1b2019-10-28 13:07:01 +00005215 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5216 return 2;
5217 }
drh10d1edf2013-11-15 15:52:39 +00005218 }
5219 }
drh1d9da702010-01-07 15:17:02 +00005220 return 0;
drh22827922000-06-06 17:27:05 +00005221}
5222
drh8c6f6662010-04-26 19:17:26 +00005223/*
5224** Compare two ExprList objects. Return 0 if they are identical and
5225** non-zero if they differ in any way.
5226**
drh619a1302013-08-01 13:04:46 +00005227** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5228** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5229**
drh8c6f6662010-04-26 19:17:26 +00005230** This routine might return non-zero for equivalent ExprLists. The
5231** only consequence will be disabled optimizations. But this routine
5232** must never return 0 if the two ExprList objects are different, or
5233** a malfunction will result.
5234**
5235** Two NULL pointers are considered to be the same. But a NULL pointer
5236** always differs from a non-NULL pointer.
5237*/
drh619a1302013-08-01 13:04:46 +00005238int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005239 int i;
5240 if( pA==0 && pB==0 ) return 0;
5241 if( pA==0 || pB==0 ) return 1;
5242 if( pA->nExpr!=pB->nExpr ) return 1;
5243 for(i=0; i<pA->nExpr; i++){
5244 Expr *pExprA = pA->a[i].pExpr;
5245 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005246 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00005247 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00005248 }
5249 return 0;
5250}
drh13449892005-09-07 21:22:45 +00005251
drh22827922000-06-06 17:27:05 +00005252/*
drhf9463df2017-02-11 14:59:58 +00005253** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5254** are ignored.
5255*/
5256int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005257 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005258 sqlite3ExprSkipCollateAndLikely(pA),
5259 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005260 iTab);
5261}
5262
5263/*
drhc51cf862019-05-11 19:36:03 +00005264** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005265**
5266** Or if seenNot is true, return non-zero if Expr p can only be
5267** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005268*/
5269static int exprImpliesNotNull(
5270 Parse *pParse, /* Parsing context */
5271 Expr *p, /* The expression to be checked */
5272 Expr *pNN, /* The expression that is NOT NULL */
5273 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005274 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005275){
5276 assert( p );
5277 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005278 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5279 return pNN->op!=TK_NULL;
5280 }
drhc51cf862019-05-11 19:36:03 +00005281 switch( p->op ){
5282 case TK_IN: {
5283 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5284 assert( ExprHasProperty(p,EP_xIsSelect)
5285 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005286 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005287 }
5288 case TK_BETWEEN: {
5289 ExprList *pList = p->x.pList;
5290 assert( pList!=0 );
5291 assert( pList->nExpr==2 );
5292 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005293 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5294 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005295 ){
5296 return 1;
5297 }
drh7a231b42019-08-30 15:11:08 +00005298 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005299 }
5300 case TK_EQ:
5301 case TK_NE:
5302 case TK_LT:
5303 case TK_LE:
5304 case TK_GT:
5305 case TK_GE:
5306 case TK_PLUS:
5307 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005308 case TK_BITOR:
5309 case TK_LSHIFT:
5310 case TK_RSHIFT:
5311 case TK_CONCAT:
5312 seenNot = 1;
5313 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005314 case TK_STAR:
5315 case TK_REM:
5316 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005317 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005318 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5319 /* Fall thru into the next case */
5320 }
5321 case TK_SPAN:
5322 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005323 case TK_UPLUS:
5324 case TK_UMINUS: {
5325 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5326 }
5327 case TK_TRUTH: {
5328 if( seenNot ) return 0;
5329 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005330 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005331 }
dan1cd382e2019-08-29 15:06:35 +00005332 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005333 case TK_NOT: {
5334 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5335 }
5336 }
5337 return 0;
5338}
5339
5340/*
drh4bd5f732013-07-31 23:22:39 +00005341** Return true if we can prove the pE2 will always be true if pE1 is
5342** true. Return false if we cannot complete the proof or if pE2 might
5343** be false. Examples:
5344**
drh619a1302013-08-01 13:04:46 +00005345** pE1: x==5 pE2: x==5 Result: true
5346** pE1: x>0 pE2: x==5 Result: false
5347** pE1: x=21 pE2: x=21 OR y=43 Result: true
5348** pE1: x!=123 pE2: x IS NOT NULL Result: true
5349** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5350** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5351** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005352**
5353** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5354** Expr.iTable<0 then assume a table number given by iTab.
5355**
drhc0804222017-06-28 21:47:16 +00005356** If pParse is not NULL, then the values of bound variables in pE1 are
5357** compared against literal values in pE2 and pParse->pVdbe->expmask is
5358** modified to record which bound variables are referenced. If pParse
5359** is NULL, then false will be returned if pE1 contains any bound variables.
5360**
drh4bd5f732013-07-31 23:22:39 +00005361** When in doubt, return false. Returning true might give a performance
5362** improvement. Returning false might cause a performance reduction, but
5363** it will always give the correct answer and is hence always safe.
5364*/
dan5aa550c2017-06-24 18:10:29 +00005365int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5366 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005367 return 1;
5368 }
5369 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005370 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5371 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005372 ){
5373 return 1;
5374 }
drh664d6d12019-05-04 17:32:07 +00005375 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005376 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005377 ){
drhc51cf862019-05-11 19:36:03 +00005378 return 1;
drh619a1302013-08-01 13:04:46 +00005379 }
5380 return 0;
drh4bd5f732013-07-31 23:22:39 +00005381}
5382
5383/*
drh6c68d752019-11-04 02:05:52 +00005384** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005385** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005386** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5387**
5388** This routine controls an optimization. False positives (setting
5389** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5390** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005391*/
5392static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005393 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005394 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005395 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5396 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005397 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005398 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005399 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005400 case TK_IS:
5401 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005402 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005403 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005404 case TK_IN:
drh25897872018-03-20 21:16:15 +00005405 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005406 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005407 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005408 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005409 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005410 testcase( pExpr->op==TK_IS );
5411 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005412 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005413 testcase( pExpr->op==TK_CASE );
5414 testcase( pExpr->op==TK_IN );
5415 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005416 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005417 return WRC_Prune;
5418 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005419 if( pWalker->u.iCur==pExpr->iTable ){
5420 pWalker->eCode = 1;
5421 return WRC_Abort;
5422 }
5423 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005424
dan9d23ea72019-08-29 19:34:29 +00005425 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005426 if( pWalker->eCode==0 ){
5427 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5428 if( pWalker->eCode ){
5429 pWalker->eCode = 0;
5430 sqlite3WalkExpr(pWalker, pExpr->pRight);
5431 }
dan9d23ea72019-08-29 19:34:29 +00005432 }
5433 return WRC_Prune;
5434
5435 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005436 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5437 assert( pWalker->eCode );
5438 return WRC_Abort;
5439 }
dan9d23ea72019-08-29 19:34:29 +00005440 return WRC_Prune;
5441
drh98811552018-04-03 14:04:48 +00005442 /* Virtual tables are allowed to use constraints like x=NULL. So
5443 ** a term of the form x=y does not prove that y is not null if x
5444 ** is the column of a virtual table */
5445 case TK_EQ:
5446 case TK_NE:
5447 case TK_LT:
5448 case TK_LE:
5449 case TK_GT:
5450 case TK_GE:
5451 testcase( pExpr->op==TK_EQ );
5452 testcase( pExpr->op==TK_NE );
5453 testcase( pExpr->op==TK_LT );
5454 testcase( pExpr->op==TK_LE );
5455 testcase( pExpr->op==TK_GT );
5456 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005457 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5458 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005459 ){
5460 return WRC_Prune;
5461 }
dan9d23ea72019-08-29 19:34:29 +00005462
drh25897872018-03-20 21:16:15 +00005463 default:
5464 return WRC_Continue;
5465 }
5466}
5467
5468/*
5469** Return true (non-zero) if expression p can only be true if at least
5470** one column of table iTab is non-null. In other words, return true
5471** if expression p will always be NULL or false if every column of iTab
5472** is NULL.
5473**
drh821b6102018-03-24 18:01:51 +00005474** False negatives are acceptable. In other words, it is ok to return
5475** zero even if expression p will never be true of every column of iTab
5476** is NULL. A false negative is merely a missed optimization opportunity.
5477**
5478** False positives are not allowed, however. A false positive may result
5479** in an incorrect answer.
5480**
drh25897872018-03-20 21:16:15 +00005481** Terms of p that are marked with EP_FromJoin (and hence that come from
5482** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5483**
5484** This routine is used to check if a LEFT JOIN can be converted into
5485** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5486** clause requires that some column of the right table of the LEFT JOIN
5487** be non-NULL, then the LEFT JOIN can be safely converted into an
5488** ordinary join.
5489*/
5490int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5491 Walker w;
drh0d950af2019-08-22 16:38:42 +00005492 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005493 if( p==0 ) return 0;
5494 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005495 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005496 }else{
5497 while( p->op==TK_AND ){
5498 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5499 p = p->pRight;
5500 }
drhd6db6592019-04-01 19:42:42 +00005501 }
drh25897872018-03-20 21:16:15 +00005502 w.xExprCallback = impliesNotNullRow;
5503 w.xSelectCallback = 0;
5504 w.xSelectCallback2 = 0;
5505 w.eCode = 0;
5506 w.u.iCur = iTab;
5507 sqlite3WalkExpr(&w, p);
5508 return w.eCode;
5509}
5510
5511/*
drh030796d2012-08-23 16:18:10 +00005512** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005513** to determine if an expression can be evaluated by reference to the
5514** index only, without having to do a search for the corresponding
5515** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5516** is the cursor for the table.
5517*/
5518struct IdxCover {
5519 Index *pIdx; /* The index to be tested for coverage */
5520 int iCur; /* Cursor number for the table corresponding to the index */
5521};
5522
5523/*
5524** Check to see if there are references to columns in table
5525** pWalker->u.pIdxCover->iCur can be satisfied using the index
5526** pWalker->u.pIdxCover->pIdx.
5527*/
5528static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5529 if( pExpr->op==TK_COLUMN
5530 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005531 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005532 ){
5533 pWalker->eCode = 1;
5534 return WRC_Abort;
5535 }
5536 return WRC_Continue;
5537}
5538
5539/*
drhe604ec02016-07-27 19:20:58 +00005540** Determine if an index pIdx on table with cursor iCur contains will
5541** the expression pExpr. Return true if the index does cover the
5542** expression and false if the pExpr expression references table columns
5543** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005544**
5545** An index covering an expression means that the expression can be
5546** evaluated using only the index and without having to lookup the
5547** corresponding table entry.
5548*/
5549int sqlite3ExprCoveredByIndex(
5550 Expr *pExpr, /* The index to be tested */
5551 int iCur, /* The cursor number for the corresponding table */
5552 Index *pIdx /* The index that might be used for coverage */
5553){
5554 Walker w;
5555 struct IdxCover xcov;
5556 memset(&w, 0, sizeof(w));
5557 xcov.iCur = iCur;
5558 xcov.pIdx = pIdx;
5559 w.xExprCallback = exprIdxCover;
5560 w.u.pIdxCover = &xcov;
5561 sqlite3WalkExpr(&w, pExpr);
5562 return !w.eCode;
5563}
5564
5565
5566/*
5567** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005568** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005569** aggregate function, in order to implement the
5570** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005571*/
drh030796d2012-08-23 16:18:10 +00005572struct SrcCount {
5573 SrcList *pSrc; /* One particular FROM clause in a nested query */
5574 int nThis; /* Number of references to columns in pSrcList */
5575 int nOther; /* Number of references to columns in other FROM clauses */
5576};
5577
5578/*
5579** Count the number of references to columns.
5580*/
5581static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005582 /* There was once a NEVER() on the second term on the grounds that
5583 ** sqlite3FunctionUsesThisSrc() was always called before
5584 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5585 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5586 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5587 ** FunctionUsesThisSrc() when creating a new sub-select. */
5588 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005589 int i;
drh030796d2012-08-23 16:18:10 +00005590 struct SrcCount *p = pWalker->u.pSrcCount;
5591 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005592 int nSrc = pSrc ? pSrc->nSrc : 0;
5593 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005594 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005595 }
drh655814d2015-01-09 01:27:29 +00005596 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005597 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005598 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5599 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005600 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005601 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005602 p->nOther++;
5603 }
drh374fdce2012-04-17 16:38:53 +00005604 }
drh030796d2012-08-23 16:18:10 +00005605 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005606}
5607
5608/*
drh030796d2012-08-23 16:18:10 +00005609** Determine if any of the arguments to the pExpr Function reference
5610** pSrcList. Return true if they do. Also return true if the function
5611** has no arguments or has only constant arguments. Return false if pExpr
5612** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005613*/
drh030796d2012-08-23 16:18:10 +00005614int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005615 Walker w;
drh030796d2012-08-23 16:18:10 +00005616 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005617 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005618 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005619 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005620 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005621 w.u.pSrcCount = &cnt;
5622 cnt.pSrc = pSrcList;
5623 cnt.nThis = 0;
5624 cnt.nOther = 0;
5625 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005626#ifndef SQLITE_OMIT_WINDOWFUNC
5627 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5628 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5629 }
5630#endif
drh030796d2012-08-23 16:18:10 +00005631 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005632}
5633
5634/*
drh13449892005-09-07 21:22:45 +00005635** Add a new element to the pAggInfo->aCol[] array. Return the index of
5636** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005637*/
drh17435752007-08-16 04:30:38 +00005638static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005639 int i;
drhcf643722007-03-27 13:36:37 +00005640 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005641 db,
drhcf643722007-03-27 13:36:37 +00005642 pInfo->aCol,
5643 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005644 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005645 &i
5646 );
drh13449892005-09-07 21:22:45 +00005647 return i;
5648}
5649
5650/*
5651** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5652** the new element. Return a negative number if malloc fails.
5653*/
drh17435752007-08-16 04:30:38 +00005654static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005655 int i;
drhcf643722007-03-27 13:36:37 +00005656 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005657 db,
drhcf643722007-03-27 13:36:37 +00005658 pInfo->aFunc,
5659 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005660 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005661 &i
5662 );
drh13449892005-09-07 21:22:45 +00005663 return i;
5664}
drh22827922000-06-06 17:27:05 +00005665
5666/*
drh7d10d5a2008-08-20 16:35:10 +00005667** This is the xExprCallback for a tree walker. It is used to
5668** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005669** for additional information.
drh22827922000-06-06 17:27:05 +00005670*/
drh7d10d5a2008-08-20 16:35:10 +00005671static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005672 int i;
drh7d10d5a2008-08-20 16:35:10 +00005673 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005674 Parse *pParse = pNC->pParse;
5675 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005676 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005677
drh25c3b8c2018-04-16 10:34:13 +00005678 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005679 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005680 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005681 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005682 testcase( pExpr->op==TK_AGG_COLUMN );
5683 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005684 /* Check to see if the column is in one of the tables in the FROM
5685 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005686 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005687 struct SrcList_item *pItem = pSrcList->a;
5688 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5689 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005690 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005691 if( pExpr->iTable==pItem->iCursor ){
5692 /* If we reach this point, it means that pExpr refers to a table
5693 ** that is in the FROM clause of the aggregate query.
5694 **
5695 ** Make an entry for the column in pAggInfo->aCol[] if there
5696 ** is not an entry there already.
5697 */
drh7f906d62007-03-12 23:48:52 +00005698 int k;
drh13449892005-09-07 21:22:45 +00005699 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005700 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005701 if( pCol->iTable==pExpr->iTable &&
5702 pCol->iColumn==pExpr->iColumn ){
5703 break;
5704 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005705 }
danielk19771e536952007-08-16 10:09:01 +00005706 if( (k>=pAggInfo->nColumn)
5707 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5708 ){
drh7f906d62007-03-12 23:48:52 +00005709 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005710 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005711 pCol->iTable = pExpr->iTable;
5712 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005713 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005714 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005715 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005716 if( pAggInfo->pGroupBy ){
5717 int j, n;
5718 ExprList *pGB = pAggInfo->pGroupBy;
5719 struct ExprList_item *pTerm = pGB->a;
5720 n = pGB->nExpr;
5721 for(j=0; j<n; j++, pTerm++){
5722 Expr *pE = pTerm->pExpr;
5723 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5724 pE->iColumn==pExpr->iColumn ){
5725 pCol->iSorterColumn = j;
5726 break;
5727 }
5728 }
5729 }
5730 if( pCol->iSorterColumn<0 ){
5731 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5732 }
5733 }
5734 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5735 ** because it was there before or because we just created it).
5736 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5737 ** pAggInfo->aCol[] entry.
5738 */
drhebb6a652013-09-12 23:42:22 +00005739 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005740 pExpr->pAggInfo = pAggInfo;
5741 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005742 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005743 break;
5744 } /* endif pExpr->iTable==pItem->iCursor */
5745 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005746 }
drh7d10d5a2008-08-20 16:35:10 +00005747 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005748 }
5749 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005750 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005751 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005752 ){
drh13449892005-09-07 21:22:45 +00005753 /* Check to see if pExpr is a duplicate of another aggregate
5754 ** function that is already in the pAggInfo structure
5755 */
5756 struct AggInfo_func *pItem = pAggInfo->aFunc;
5757 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005758 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005759 break;
5760 }
drh22827922000-06-06 17:27:05 +00005761 }
drh13449892005-09-07 21:22:45 +00005762 if( i>=pAggInfo->nFunc ){
5763 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5764 */
danielk197714db2662006-01-09 16:12:04 +00005765 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005766 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005767 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005768 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005769 pItem = &pAggInfo->aFunc[i];
5770 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005771 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005772 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005773 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005774 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005775 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005776 if( pExpr->flags & EP_Distinct ){
5777 pItem->iDistinct = pParse->nTab++;
5778 }else{
5779 pItem->iDistinct = -1;
5780 }
drh0dfa5252020-01-08 17:28:19 +00005781 sqlite3ExprFunctionUsable(pParse, pExpr, pItem->pFunc);
drh13449892005-09-07 21:22:45 +00005782 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005783 }
drh13449892005-09-07 21:22:45 +00005784 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5785 */
drhc5cd1242013-09-12 16:50:49 +00005786 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005787 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005788 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005789 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005790 return WRC_Prune;
5791 }else{
5792 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005793 }
drh22827922000-06-06 17:27:05 +00005794 }
5795 }
drh7d10d5a2008-08-20 16:35:10 +00005796 return WRC_Continue;
5797}
5798static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005799 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005800 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005801 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005802}
drh979dd1b2017-05-29 14:26:07 +00005803static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5804 UNUSED_PARAMETER(pSelect);
5805 pWalker->walkerDepth--;
5806}
drh626a8792005-01-17 22:08:19 +00005807
5808/*
drhe8abb4c2012-11-02 18:24:57 +00005809** Analyze the pExpr expression looking for aggregate functions and
5810** for variables that need to be added to AggInfo object that pNC->pAggInfo
5811** points to. Additional entries are made on the AggInfo object as
5812** necessary.
drh626a8792005-01-17 22:08:19 +00005813**
5814** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005815** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005816*/
drhd2b3e232008-01-23 14:51:49 +00005817void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005818 Walker w;
5819 w.xExprCallback = analyzeAggregate;
5820 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005821 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5822 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005823 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005824 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005825 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005826 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005827}
drh5d9a4af2005-08-30 00:54:01 +00005828
5829/*
5830** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5831** expression list. Return the number of errors.
5832**
5833** If an error is found, the analysis is cut short.
5834*/
drhd2b3e232008-01-23 14:51:49 +00005835void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005836 struct ExprList_item *pItem;
5837 int i;
drh5d9a4af2005-08-30 00:54:01 +00005838 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005839 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5840 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005841 }
5842 }
drh5d9a4af2005-08-30 00:54:01 +00005843}
drh892d3172008-01-10 03:46:36 +00005844
5845/*
drhceea3322009-04-23 13:22:42 +00005846** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005847*/
5848int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005849 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005850 return ++pParse->nMem;
5851 }
danielk19772f425f62008-07-04 09:41:39 +00005852 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005853}
drhceea3322009-04-23 13:22:42 +00005854
5855/*
5856** Deallocate a register, making available for reuse for some other
5857** purpose.
drhceea3322009-04-23 13:22:42 +00005858*/
drh892d3172008-01-10 03:46:36 +00005859void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00005860 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00005861 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00005862 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5863 pParse->aTempReg[pParse->nTempReg++] = iReg;
5864 }
drh892d3172008-01-10 03:46:36 +00005865 }
5866}
5867
5868/*
drhed24da42016-09-06 14:37:05 +00005869** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005870*/
5871int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005872 int i, n;
drhed24da42016-09-06 14:37:05 +00005873 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005874 i = pParse->iRangeReg;
5875 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005876 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005877 pParse->iRangeReg += nReg;
5878 pParse->nRangeReg -= nReg;
5879 }else{
5880 i = pParse->nMem+1;
5881 pParse->nMem += nReg;
5882 }
5883 return i;
5884}
5885void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005886 if( nReg==1 ){
5887 sqlite3ReleaseTempReg(pParse, iReg);
5888 return;
5889 }
drh3aef2fb2020-01-02 17:46:02 +00005890 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00005891 if( nReg>pParse->nRangeReg ){
5892 pParse->nRangeReg = nReg;
5893 pParse->iRangeReg = iReg;
5894 }
5895}
drhcdc69552011-12-06 13:24:59 +00005896
5897/*
5898** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005899**
5900** Always invoke this procedure after coding a subroutine or co-routine
5901** that might be invoked from other parts of the code, to ensure that
5902** the sub/co-routine does not use registers in common with the code that
5903** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005904*/
5905void sqlite3ClearTempRegCache(Parse *pParse){
5906 pParse->nTempReg = 0;
5907 pParse->nRangeReg = 0;
5908}
drhbb9b5f22016-03-19 00:35:02 +00005909
5910/*
5911** Validate that no temporary register falls within the range of
5912** iFirst..iLast, inclusive. This routine is only call from within assert()
5913** statements.
5914*/
5915#ifdef SQLITE_DEBUG
5916int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5917 int i;
5918 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005919 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5920 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005921 ){
5922 return 0;
5923 }
5924 for(i=0; i<pParse->nTempReg; i++){
5925 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5926 return 0;
5927 }
5928 }
5929 return 1;
5930}
5931#endif /* SQLITE_DEBUG */