blob: 6fbeb827fbe750d523caf7691701b1d28fac1588 [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;
mistachkin9bec6fb2014-06-26 21:28:21 +000047 if( pExpr->flags & EP_Generic ) return 0;
drha7d6db62019-06-11 21:02:15 +000048 while( ExprHasProperty(pExpr, EP_Skip) ){
49 assert( pExpr->op==TK_COLLATE );
50 pExpr = pExpr->pLeft;
51 assert( pExpr!=0 );
52 }
drh580c8c12012-12-08 03:34:04 +000053 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000054 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000055 assert( pExpr->flags&EP_xIsSelect );
56 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000057 }
drhdb45bd52016-08-22 00:48:58 +000058 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000059#ifndef SQLITE_OMIT_CAST
60 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000061 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000062 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000063 }
64#endif
drheda079c2018-09-20 19:02:15 +000065 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
66 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000067 }
dan80aa5452016-09-03 19:52:12 +000068 if( op==TK_SELECT_COLUMN ){
69 assert( pExpr->pLeft->flags&EP_xIsSelect );
70 return sqlite3ExprAffinity(
71 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
72 );
73 }
danielk1977a37cdde2004-05-16 11:15:36 +000074 return pExpr->affinity;
75}
76
drh53db1452004-05-20 13:54:53 +000077/*
drh8b4c40d2007-02-01 23:02:45 +000078** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000079** sequence named by pToken. Return a pointer to a new Expr node that
80** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000081**
82** If a memory allocation error occurs, that fact is recorded in pParse->db
83** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000084*/
drh4ef7efa2014-03-20 15:14:08 +000085Expr *sqlite3ExprAddCollateToken(
86 Parse *pParse, /* Parsing context */
87 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000088 const Token *pCollName, /* Name of collating sequence */
89 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000090){
drh0a8a4062012-12-07 18:38:16 +000091 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000092 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000093 if( pNew ){
94 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000095 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000096 pExpr = pNew;
97 }
drhae80dde2012-12-06 21:16:43 +000098 }
drh0a8a4062012-12-07 18:38:16 +000099 return pExpr;
100}
101Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000102 Token s;
103 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000104 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000105 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000106}
107
108/*
drh0b8d2552015-09-05 22:36:07 +0000109** Skip over any TK_COLLATE operators and any unlikely()
drha4c3c872013-09-12 17:29:25 +0000110** or likelihood() function at the root of an expression.
drh0a8a4062012-12-07 18:38:16 +0000111*/
112Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000113 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000114 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000115 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
116 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000117 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000118 pExpr = pExpr->x.pList->a[0].pExpr;
119 }else{
drh0b8d2552015-09-05 22:36:07 +0000120 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000121 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000122 }
drha4c3c872013-09-12 17:29:25 +0000123 }
drh0a8a4062012-12-07 18:38:16 +0000124 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000125}
126
127/*
drhae80dde2012-12-06 21:16:43 +0000128** Return the collation sequence for the expression pExpr. If
129** there is no defined collating sequence, return NULL.
130**
drh70efa842017-09-28 01:58:23 +0000131** See also: sqlite3ExprNNCollSeq()
132**
133** The sqlite3ExprNNCollSeq() works the same exact that it returns the
134** default collation if pExpr has no defined collation.
135**
drhae80dde2012-12-06 21:16:43 +0000136** The collating sequence might be determined by a COLLATE operator
137** or by the presence of a column with a defined collating sequence.
138** COLLATE operators take first precedence. Left operands take
139** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000140*/
danielk19777cedc8d2004-06-10 10:50:08 +0000141CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000142 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000143 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000144 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000145 while( p ){
drhae80dde2012-12-06 21:16:43 +0000146 int op = p->op;
drhfbb24d12014-03-20 17:03:30 +0000147 if( p->flags & EP_Generic ) break;
drhcb0e04f2018-12-12 21:34:17 +0000148 if( op==TK_REGISTER ) op = p->op2;
149 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000150 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000151 ){
drheda079c2018-09-20 19:02:15 +0000152 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000153 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000154 int j = p->iColumn;
155 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000156 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000157 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000158 }
159 break;
danielk19770202b292004-06-09 09:55:16 +0000160 }
drhe081d732018-07-27 18:19:12 +0000161 if( op==TK_CAST || op==TK_UPLUS ){
162 p = p->pLeft;
163 continue;
164 }
drhcb0e04f2018-12-12 21:34:17 +0000165 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000166 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
167 break;
168 }
drhae80dde2012-12-06 21:16:43 +0000169 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000170 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000171 p = p->pLeft;
172 }else{
drh2308ed32015-02-09 16:09:34 +0000173 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000174 /* The Expr.x union is never used at the same time as Expr.pRight */
175 assert( p->x.pList==0 || p->pRight==0 );
176 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
177 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
178 ** least one EP_Collate. Thus the following two ALWAYS. */
179 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000180 int i;
drh6728cd92015-02-09 18:28:03 +0000181 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000182 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
183 pNext = p->x.pList->a[i].pExpr;
184 break;
185 }
186 }
187 }
188 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000189 }
190 }else{
drh7d10d5a2008-08-20 16:35:10 +0000191 break;
192 }
danielk19770202b292004-06-09 09:55:16 +0000193 }
danielk19777cedc8d2004-06-10 10:50:08 +0000194 if( sqlite3CheckCollSeq(pParse, pColl) ){
195 pColl = 0;
196 }
197 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000198}
199
200/*
drh70efa842017-09-28 01:58:23 +0000201** Return the collation sequence for the expression pExpr. If
202** there is no defined collating sequence, return a pointer to the
203** defautl collation sequence.
204**
205** See also: sqlite3ExprCollSeq()
206**
207** The sqlite3ExprCollSeq() routine works the same except that it
208** returns NULL if there is no defined collation.
209*/
210CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
211 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
212 if( p==0 ) p = pParse->db->pDfltColl;
213 assert( p!=0 );
214 return p;
215}
216
217/*
218** Return TRUE if the two expressions have equivalent collating sequences.
219*/
220int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
221 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
222 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
223 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
224}
225
226/*
drh626a8792005-01-17 22:08:19 +0000227** pExpr is an operand of a comparison operator. aff2 is the
228** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000229** type affinity that should be used for the comparison operator.
230*/
danielk1977e014a832004-05-17 10:48:57 +0000231char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000232 char aff1 = sqlite3ExprAffinity(pExpr);
danielk1977e014a832004-05-17 10:48:57 +0000233 if( aff1 && aff2 ){
drh8df447f2005-11-01 15:48:24 +0000234 /* Both sides of the comparison are columns. If one has numeric
235 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000236 */
drh8a512562005-11-14 22:29:05 +0000237 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000238 return SQLITE_AFF_NUMERIC;
239 }else{
drh05883a32015-06-02 15:32:08 +0000240 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000241 }
242 }else if( !aff1 && !aff2 ){
drh5f6a87b2004-07-19 00:39:45 +0000243 /* Neither side of the comparison is a column. Compare the
244 ** results directly.
danielk1977e014a832004-05-17 10:48:57 +0000245 */
drh05883a32015-06-02 15:32:08 +0000246 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000247 }else{
248 /* One side is a column, the other is not. Use the columns affinity. */
drhfe05af82005-07-21 03:14:59 +0000249 assert( aff1==0 || aff2==0 );
danielk1977e014a832004-05-17 10:48:57 +0000250 return (aff1 + aff2);
251 }
252}
253
drh53db1452004-05-20 13:54:53 +0000254/*
255** pExpr is a comparison operator. Return the type affinity that should
256** be applied to both operands prior to doing the comparison.
257*/
danielk1977e014a832004-05-17 10:48:57 +0000258static char comparisonAffinity(Expr *pExpr){
259 char aff;
260 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
261 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000262 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000263 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000264 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000265 if( pExpr->pRight ){
266 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000267 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
268 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000269 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000270 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000271 }
272 return aff;
273}
274
275/*
276** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
277** idx_affinity is the affinity of an indexed column. Return true
278** if the index with affinity idx_affinity may be used to implement
279** the comparison in pExpr.
280*/
281int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
282 char aff = comparisonAffinity(pExpr);
drh8a512562005-11-14 22:29:05 +0000283 switch( aff ){
drh05883a32015-06-02 15:32:08 +0000284 case SQLITE_AFF_BLOB:
drh8a512562005-11-14 22:29:05 +0000285 return 1;
286 case SQLITE_AFF_TEXT:
287 return idx_affinity==SQLITE_AFF_TEXT;
288 default:
289 return sqlite3IsNumericAffinity(idx_affinity);
290 }
danielk1977e014a832004-05-17 10:48:57 +0000291}
292
danielk1977a37cdde2004-05-16 11:15:36 +0000293/*
drh35573352008-01-08 23:54:25 +0000294** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000295** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000296*/
drh35573352008-01-08 23:54:25 +0000297static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
298 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000299 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000300 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000301}
302
drha2e00042002-01-22 03:13:42 +0000303/*
danielk19770202b292004-06-09 09:55:16 +0000304** Return a pointer to the collation sequence that should be used by
305** a binary comparison operator comparing pLeft and pRight.
306**
307** If the left hand expression has a collating sequence type, then it is
308** used. Otherwise the collation sequence for the right hand expression
309** is used, or the default (BINARY) if neither expression has a collating
310** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000311**
312** Argument pRight (but not pLeft) may be a null pointer. In this case,
313** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000314*/
drh0a0e1312007-08-07 17:04:59 +0000315CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000316 Parse *pParse,
317 Expr *pLeft,
318 Expr *pRight
319){
drhec41dda2007-02-07 13:09:45 +0000320 CollSeq *pColl;
321 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000322 if( pLeft->flags & EP_Collate ){
323 pColl = sqlite3ExprCollSeq(pParse, pLeft);
324 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
325 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000326 }else{
327 pColl = sqlite3ExprCollSeq(pParse, pLeft);
328 if( !pColl ){
329 pColl = sqlite3ExprCollSeq(pParse, pRight);
330 }
danielk19770202b292004-06-09 09:55:16 +0000331 }
332 return pColl;
333}
334
335/*
drhbe5c89a2004-07-26 00:31:09 +0000336** Generate code for a comparison operator.
337*/
338static int codeCompare(
339 Parse *pParse, /* The parsing (and code generating) context */
340 Expr *pLeft, /* The left operand */
341 Expr *pRight, /* The right operand */
342 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000343 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000344 int dest, /* Jump here if true. */
345 int jumpIfNull /* If true, jump if either operand is NULL */
346){
drh35573352008-01-08 23:54:25 +0000347 int p5;
348 int addr;
349 CollSeq *p4;
350
351 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
352 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
353 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
354 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000355 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000356 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000357}
358
dancfbb5e82016-07-13 19:48:13 +0000359/*
dan870a0702016-08-01 16:37:43 +0000360** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000361**
362** A vector is defined as any expression that results in two or more
363** columns of result. Every TK_VECTOR node is an vector because the
364** parser will not generate a TK_VECTOR with fewer than two entries.
365** But a TK_SELECT might be either a vector or a scalar. It is only
366** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000367*/
368int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000369 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000370}
371
372/*
dancfbb5e82016-07-13 19:48:13 +0000373** If the expression passed as the only argument is of type TK_VECTOR
374** return the number of expressions in the vector. Or, if the expression
375** is a sub-select, return the number of columns in the sub-select. For
376** any other type of expression, return 1.
377*/
dan71c57db2016-07-09 20:23:55 +0000378int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000379 u8 op = pExpr->op;
380 if( op==TK_REGISTER ) op = pExpr->op2;
381 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000382 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000383 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000384 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000385 }else{
386 return 1;
dan71c57db2016-07-09 20:23:55 +0000387 }
dan71c57db2016-07-09 20:23:55 +0000388}
389
danba00e302016-07-23 20:24:06 +0000390/*
drhfc7f27b2016-08-20 00:07:01 +0000391** Return a pointer to a subexpression of pVector that is the i-th
392** column of the vector (numbered starting with 0). The caller must
393** ensure that i is within range.
394**
drh76dbe7a2016-08-20 21:02:38 +0000395** If pVector is really a scalar (and "scalar" here includes subqueries
396** that return a single column!) then return pVector unmodified.
397**
drhfc7f27b2016-08-20 00:07:01 +0000398** pVector retains ownership of the returned subexpression.
399**
400** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000401** just the expression for the i-th term of the result set, and may
402** not be ready for evaluation because the table cursor has not yet
403** been positioned.
danba00e302016-07-23 20:24:06 +0000404*/
drhfc7f27b2016-08-20 00:07:01 +0000405Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000406 assert( i<sqlite3ExprVectorSize(pVector) );
407 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000408 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
409 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000410 return pVector->x.pSelect->pEList->a[i].pExpr;
411 }else{
412 return pVector->x.pList->a[i].pExpr;
413 }
dan71c57db2016-07-09 20:23:55 +0000414 }
dan870a0702016-08-01 16:37:43 +0000415 return pVector;
dan71c57db2016-07-09 20:23:55 +0000416}
drhfc7f27b2016-08-20 00:07:01 +0000417
drhfc7f27b2016-08-20 00:07:01 +0000418/*
419** Compute and return a new Expr object which when passed to
420** sqlite3ExprCode() will generate all necessary code to compute
421** the iField-th column of the vector expression pVector.
422**
drh8762ec12016-08-20 01:06:22 +0000423** It is ok for pVector to be a scalar (as long as iField==0).
424** In that case, this routine works like sqlite3ExprDup().
425**
drhfc7f27b2016-08-20 00:07:01 +0000426** The caller owns the returned Expr object and is responsible for
427** ensuring that the returned value eventually gets freed.
428**
drh8762ec12016-08-20 01:06:22 +0000429** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000430** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000431** valid for the life of the returned object. If pVector is a TK_VECTOR
432** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000433** returns.
drh8762ec12016-08-20 01:06:22 +0000434**
435** A trick to cause a TK_SELECT pVector to be deleted together with
436** the returned Expr object is to attach the pVector to the pRight field
437** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000438*/
439Expr *sqlite3ExprForVectorField(
440 Parse *pParse, /* Parsing context */
441 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000442 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000443){
444 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000445 if( pVector->op==TK_SELECT ){
446 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000447 /* The TK_SELECT_COLUMN Expr node:
448 **
drh966e2912017-01-03 02:58:01 +0000449 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000450 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000451 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000452 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000453 ** pLeft->iTable: First in an array of register holding result, or 0
454 ** if the result is not yet computed.
455 **
456 ** sqlite3ExprDelete() specifically skips the recursive delete of
457 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000458 ** can be attached to pRight to cause this node to take ownership of
459 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
460 ** with the same pLeft pointer to the pVector, but only one of them
461 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000462 */
drhabfd35e2016-12-06 22:47:23 +0000463 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000464 if( pRet ){
465 pRet->iColumn = iField;
466 pRet->pLeft = pVector;
467 }
drhfc7f27b2016-08-20 00:07:01 +0000468 assert( pRet==0 || pRet->iTable==0 );
469 }else{
drha1251bc2016-08-20 00:51:37 +0000470 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
471 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000472 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000473 }
474 return pRet;
475}
dan71c57db2016-07-09 20:23:55 +0000476
dan5c288b92016-07-30 21:02:33 +0000477/*
478** If expression pExpr is of type TK_SELECT, generate code to evaluate
479** it. Return the register in which the result is stored (or, if the
480** sub-select returns more than one column, the first in an array
481** of registers in which the result is stored).
482**
483** If pExpr is not a TK_SELECT expression, return 0.
484*/
485static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000486 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000487#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000488 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000489 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000490 }
danf9b2e052016-08-02 17:45:00 +0000491#endif
dan8da209b2016-07-26 18:06:08 +0000492 return reg;
493}
494
dan5c288b92016-07-30 21:02:33 +0000495/*
496** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000497** or TK_SELECT that returns more than one column. This function returns
498** the register number of a register that contains the value of
499** element iField of the vector.
500**
501** If pVector is a TK_SELECT expression, then code for it must have
502** already been generated using the exprCodeSubselect() routine. In this
503** case parameter regSelect should be the first in an array of registers
504** containing the results of the sub-select.
505**
506** If pVector is of type TK_VECTOR, then code for the requested field
507** is generated. In this case (*pRegFree) may be set to the number of
508** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000509**
510** Before returning, output parameter (*ppExpr) is set to point to the
511** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000512*/
513static int exprVectorRegister(
514 Parse *pParse, /* Parse context */
515 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000516 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000517 int regSelect, /* First in array of registers */
518 Expr **ppExpr, /* OUT: Expression element */
519 int *pRegFree /* OUT: Temp register to free */
520){
drh12abf402016-08-22 14:30:05 +0000521 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000522 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000523 if( op==TK_REGISTER ){
524 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
525 return pVector->iTable+iField;
526 }
527 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000528 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
529 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000530 }
dan870a0702016-08-01 16:37:43 +0000531 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000532 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
533}
534
535/*
536** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000537** the result of the comparison (1, 0, or NULL) and write that
538** result into register dest.
539**
540** The caller must satisfy the following preconditions:
541**
542** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
543** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
544** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000545*/
drh79752b62016-08-13 10:02:17 +0000546static void codeVectorCompare(
547 Parse *pParse, /* Code generator context */
548 Expr *pExpr, /* The comparison operation */
549 int dest, /* Write results into this register */
550 u8 op, /* Comparison operator */
551 u8 p5 /* SQLITE_NULLEQ or zero */
552){
dan71c57db2016-07-09 20:23:55 +0000553 Vdbe *v = pParse->pVdbe;
554 Expr *pLeft = pExpr->pLeft;
555 Expr *pRight = pExpr->pRight;
556 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000557 int i;
558 int regLeft = 0;
559 int regRight = 0;
560 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000561 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000562
drh245ce622017-01-01 12:44:07 +0000563 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
564 sqlite3ErrorMsg(pParse, "row value misused");
565 return;
566 }
drhb29e60c2016-09-05 12:02:34 +0000567 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
568 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
569 || pExpr->op==TK_LT || pExpr->op==TK_GT
570 || pExpr->op==TK_LE || pExpr->op==TK_GE
571 );
572 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
573 || (pExpr->op==TK_ISNOT && op==TK_NE) );
574 assert( p5==0 || pExpr->op!=op );
575 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000576
drhb29e60c2016-09-05 12:02:34 +0000577 p5 |= SQLITE_STOREP2;
578 if( opx==TK_LE ) opx = TK_LT;
579 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000580
drhb29e60c2016-09-05 12:02:34 +0000581 regLeft = exprCodeSubselect(pParse, pLeft);
582 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000583
drhb29e60c2016-09-05 12:02:34 +0000584 for(i=0; 1 /*Loop exits by "break"*/; i++){
585 int regFree1 = 0, regFree2 = 0;
586 Expr *pL, *pR;
587 int r1, r2;
588 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000589 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
590 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
591 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
592 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
593 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
594 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
595 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
596 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
597 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
598 sqlite3ReleaseTempReg(pParse, regFree1);
599 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000600 if( i==nLeft-1 ){
601 break;
dan71c57db2016-07-09 20:23:55 +0000602 }
drhb29e60c2016-09-05 12:02:34 +0000603 if( opx==TK_EQ ){
604 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
605 p5 |= SQLITE_KEEPNULL;
606 }else if( opx==TK_NE ){
607 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
608 p5 |= SQLITE_KEEPNULL;
609 }else{
610 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
611 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
612 VdbeCoverageIf(v, op==TK_LT);
613 VdbeCoverageIf(v, op==TK_GT);
614 VdbeCoverageIf(v, op==TK_LE);
615 VdbeCoverageIf(v, op==TK_GE);
616 if( i==nLeft-2 ) opx = op;
617 }
dan71c57db2016-07-09 20:23:55 +0000618 }
drhb29e60c2016-09-05 12:02:34 +0000619 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000620}
621
danielk19774b5255a2008-06-05 16:47:39 +0000622#if SQLITE_MAX_EXPR_DEPTH>0
623/*
624** Check that argument nHeight is less than or equal to the maximum
625** expression depth allowed. If it is not, leave an error message in
626** pParse.
627*/
drh7d10d5a2008-08-20 16:35:10 +0000628int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000629 int rc = SQLITE_OK;
630 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
631 if( nHeight>mxHeight ){
632 sqlite3ErrorMsg(pParse,
633 "Expression tree is too large (maximum depth %d)", mxHeight
634 );
635 rc = SQLITE_ERROR;
636 }
637 return rc;
638}
639
640/* The following three functions, heightOfExpr(), heightOfExprList()
641** and heightOfSelect(), are used to determine the maximum height
642** of any expression tree referenced by the structure passed as the
643** first argument.
644**
645** If this maximum height is greater than the current value pointed
646** to by pnHeight, the second parameter, then set *pnHeight to that
647** value.
648*/
649static void heightOfExpr(Expr *p, int *pnHeight){
650 if( p ){
651 if( p->nHeight>*pnHeight ){
652 *pnHeight = p->nHeight;
653 }
654 }
655}
656static void heightOfExprList(ExprList *p, int *pnHeight){
657 if( p ){
658 int i;
659 for(i=0; i<p->nExpr; i++){
660 heightOfExpr(p->a[i].pExpr, pnHeight);
661 }
662 }
663}
dan1a3a3082018-01-18 19:00:54 +0000664static void heightOfSelect(Select *pSelect, int *pnHeight){
665 Select *p;
666 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000667 heightOfExpr(p->pWhere, pnHeight);
668 heightOfExpr(p->pHaving, pnHeight);
669 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000670 heightOfExprList(p->pEList, pnHeight);
671 heightOfExprList(p->pGroupBy, pnHeight);
672 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000673 }
674}
675
676/*
677** Set the Expr.nHeight variable in the structure passed as an
678** argument. An expression with no children, Expr.pList or
679** Expr.pSelect member has a height of 1. Any other expression
680** has a height equal to the maximum height of any other
681** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000682**
683** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
684** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000685*/
686static void exprSetHeight(Expr *p){
687 int nHeight = 0;
688 heightOfExpr(p->pLeft, &nHeight);
689 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000690 if( ExprHasProperty(p, EP_xIsSelect) ){
691 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000692 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000693 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000694 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000695 }
danielk19774b5255a2008-06-05 16:47:39 +0000696 p->nHeight = nHeight + 1;
697}
698
699/*
700** Set the Expr.nHeight variable using the exprSetHeight() function. If
701** the height is greater than the maximum allowed expression depth,
702** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000703**
704** Also propagate all EP_Propagate flags from the Expr.x.pList into
705** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000706*/
drh2308ed32015-02-09 16:09:34 +0000707void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000708 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000709 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000710 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000711}
712
713/*
714** Return the maximum height of any expression tree referenced
715** by the select statement passed as an argument.
716*/
717int sqlite3SelectExprHeight(Select *p){
718 int nHeight = 0;
719 heightOfSelect(p, &nHeight);
720 return nHeight;
721}
drh2308ed32015-02-09 16:09:34 +0000722#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
723/*
724** Propagate all EP_Propagate flags from the Expr.x.pList into
725** Expr.flags.
726*/
727void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
728 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
729 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
730 }
731}
732#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000733#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
734
drhbe5c89a2004-07-26 00:31:09 +0000735/*
drhb7916a72009-05-27 10:31:29 +0000736** This routine is the core allocator for Expr nodes.
737**
drha76b5df2002-02-23 02:32:10 +0000738** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000739** for this node and for the pToken argument is a single allocation
740** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000741** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000742**
743** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000744** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000745** parameter is ignored if pToken is NULL or if the token does not
746** appear to be quoted. If the quotes were of the form "..." (double-quotes)
747** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000748**
749** Special case: If op==TK_INTEGER and pToken points to a string that
750** can be translated into a 32-bit integer, then the token is not
751** stored in u.zToken. Instead, the integer values is written
752** into u.iValue and the EP_IntValue flag is set. No extra storage
753** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000754*/
drhb7916a72009-05-27 10:31:29 +0000755Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000756 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000757 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000758 const Token *pToken, /* Token argument. Might be NULL */
759 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000760){
drha76b5df2002-02-23 02:32:10 +0000761 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000762 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000763 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000764
drh575fad62016-02-05 13:38:36 +0000765 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000766 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000767 if( op!=TK_INTEGER || pToken->z==0
768 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
769 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000770 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000771 }
drhb7916a72009-05-27 10:31:29 +0000772 }
drh575fad62016-02-05 13:38:36 +0000773 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000774 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000775 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000776 pNew->op = (u8)op;
777 pNew->iAgg = -1;
778 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000779 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000780 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000781 pNew->u.iValue = iValue;
782 }else{
drh33e619f2009-05-28 01:00:55 +0000783 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000784 assert( pToken->z!=0 || pToken->n==0 );
785 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000786 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000787 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000788 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000789 }
drhb7916a72009-05-27 10:31:29 +0000790 }
791 }
792#if SQLITE_MAX_EXPR_DEPTH>0
793 pNew->nHeight = 1;
794#endif
795 }
drha76b5df2002-02-23 02:32:10 +0000796 return pNew;
797}
798
799/*
drhb7916a72009-05-27 10:31:29 +0000800** Allocate a new expression node from a zero-terminated token that has
801** already been dequoted.
802*/
803Expr *sqlite3Expr(
804 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
805 int op, /* Expression opcode */
806 const char *zToken /* Token argument. Might be NULL */
807){
808 Token x;
809 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000810 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000811 return sqlite3ExprAlloc(db, op, &x, 0);
812}
813
814/*
815** Attach subtrees pLeft and pRight to the Expr node pRoot.
816**
817** If pRoot==NULL that means that a memory allocation error has occurred.
818** In that case, delete the subtrees pLeft and pRight.
819*/
820void sqlite3ExprAttachSubtrees(
821 sqlite3 *db,
822 Expr *pRoot,
823 Expr *pLeft,
824 Expr *pRight
825){
826 if( pRoot==0 ){
827 assert( db->mallocFailed );
828 sqlite3ExprDelete(db, pLeft);
829 sqlite3ExprDelete(db, pRight);
830 }else{
831 if( pRight ){
832 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000833 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000834 }
835 if( pLeft ){
836 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000837 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000838 }
839 exprSetHeight(pRoot);
840 }
841}
842
843/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000844** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000845**
drhbf664462009-06-19 18:32:54 +0000846** One or both of the subtrees can be NULL. Return a pointer to the new
847** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
848** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000849*/
drh17435752007-08-16 04:30:38 +0000850Expr *sqlite3PExpr(
851 Parse *pParse, /* Parsing context */
852 int op, /* Expression opcode */
853 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000854 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000855){
drh5fb52ca2012-03-31 02:34:35 +0000856 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000857 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858 if( p ){
859 memset(p, 0, sizeof(Expr));
860 p->op = op & 0xff;
861 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000862 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000863 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000864 }else{
865 sqlite3ExprDelete(pParse->db, pLeft);
866 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000867 }
drh4e0cff62004-11-05 05:10:28 +0000868 return p;
869}
870
871/*
drh08de4f72016-04-11 01:06:47 +0000872** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
873** do a memory allocation failure) then delete the pSelect object.
874*/
875void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
876 if( pExpr ){
877 pExpr->x.pSelect = pSelect;
878 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
879 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
880 }else{
881 assert( pParse->db->mallocFailed );
882 sqlite3SelectDelete(pParse->db, pSelect);
883 }
884}
885
886
887/*
drh91bb0ee2004-09-01 03:06:34 +0000888** Join two expressions using an AND operator. If either expression is
889** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000890**
891** If one side or the other of the AND is known to be false, then instead
892** of returning an AND expression, just return a constant expression with
893** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000894*/
drhd5c851c2019-04-19 13:38:34 +0000895Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
896 sqlite3 *db = pParse->db;
897 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000898 return pRight;
899 }else if( pRight==0 ){
900 return pLeft;
drhad317272019-04-19 16:21:51 +0000901 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000902 sqlite3ExprUnmapAndDelete(pParse, pLeft);
903 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5fb52ca2012-03-31 02:34:35 +0000904 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000905 }else{
drhd5c851c2019-04-19 13:38:34 +0000906 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000907 }
908}
909
910/*
911** Construct a new expression node for a function with multiple
912** arguments.
913*/
drh954733b2018-07-27 23:33:16 +0000914Expr *sqlite3ExprFunction(
915 Parse *pParse, /* Parsing context */
916 ExprList *pList, /* Argument list */
917 Token *pToken, /* Name of the function */
918 int eDistinct /* SF_Distinct or SF_ALL or 0 */
919){
drha76b5df2002-02-23 02:32:10 +0000920 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000921 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000922 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000923 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000924 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000925 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000926 return 0;
927 }
drh954733b2018-07-27 23:33:16 +0000928 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
929 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
930 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000931 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000932 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000933 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000934 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000935 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000936 return pNew;
937}
938
939/*
drhfa6bc002004-09-07 16:19:52 +0000940** Assign a variable number to an expression that encodes a wildcard
941** in the original SQL statement.
942**
943** Wildcards consisting of a single "?" are assigned the next sequential
944** variable number.
945**
946** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000947** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000948** the SQL statement comes from an external source.
949**
drh51f49f12009-05-21 20:41:32 +0000950** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000951** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000952** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000953** assigned.
954*/
drhde25a882016-10-03 15:28:24 +0000955void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000956 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000957 const char *z;
drhf326d662016-12-23 13:30:53 +0000958 ynVar x;
drh17435752007-08-16 04:30:38 +0000959
drhfa6bc002004-09-07 16:19:52 +0000960 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000961 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000962 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000963 assert( z!=0 );
964 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000965 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000966 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000967 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000968 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000969 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000970 }else{
drhf326d662016-12-23 13:30:53 +0000971 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000972 if( z[0]=='?' ){
973 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
974 ** use it as the variable number */
975 i64 i;
drh18814df2017-01-31 03:52:34 +0000976 int bOk;
977 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
978 i = z[1]-'0'; /* The common case of ?N for a single digit N */
979 bOk = 1;
980 }else{
981 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
982 }
drh124c0b42011-06-01 18:15:55 +0000983 testcase( i==0 );
984 testcase( i==1 );
985 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
986 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
987 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
988 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
989 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000990 return;
drhfa6bc002004-09-07 16:19:52 +0000991 }
drh8e74e7b2017-01-31 12:41:48 +0000992 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +0000993 if( x>pParse->nVar ){
994 pParse->nVar = (int)x;
995 doAdd = 1;
996 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
997 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +0000998 }
999 }else{
1000 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1001 ** number as the prior appearance of the same name, or if the name
1002 ** has never appeared before, reuse the same variable number
1003 */
drh9bf755c2016-12-23 03:59:31 +00001004 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1005 if( x==0 ){
1006 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001007 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001008 }
drhfa6bc002004-09-07 16:19:52 +00001009 }
drhf326d662016-12-23 13:30:53 +00001010 if( doAdd ){
1011 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1012 }
1013 }
1014 pExpr->iColumn = x;
1015 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001016 sqlite3ErrorMsg(pParse, "too many SQL variables");
1017 }
drhfa6bc002004-09-07 16:19:52 +00001018}
1019
1020/*
danf6963f92009-11-23 14:39:14 +00001021** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001022*/
drh4f0010b2016-04-11 14:49:39 +00001023static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1024 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001025 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1026 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001027
1028 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1029 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan6ba7ab02019-07-02 11:56:47 +00001030 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc|EP_Filter) );
drh209bc522016-09-23 21:36:24 +00001031#ifdef SQLITE_DEBUG
1032 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1033 assert( p->pLeft==0 );
1034 assert( p->pRight==0 );
1035 assert( p->x.pSelect==0 );
1036 }
1037#endif
1038 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001039 /* The Expr.x union is never used at the same time as Expr.pRight */
1040 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001041 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001042 if( p->pRight ){
dan8117f112019-07-10 20:16:53 +00001043 assert( !ExprHasProperty(p, (EP_WinFunc|EP_Filter)) );
drhd1086672017-07-07 13:59:34 +00001044 sqlite3ExprDeleteNN(db, p->pRight);
1045 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan8117f112019-07-10 20:16:53 +00001046 assert( !ExprHasProperty(p, (EP_WinFunc|EP_Filter)) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001047 sqlite3SelectDelete(db, p->x.pSelect);
1048 }else{
1049 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001050#ifndef SQLITE_OMIT_WINDOWFUNC
dan8117f112019-07-10 20:16:53 +00001051 if( ExprHasProperty(p, (EP_WinFunc|EP_Filter)) ){
1052 if( ExprHasProperty(p, EP_WinFunc) ){
1053 assert( p->op==TK_FUNCTION && !ExprHasProperty(p, EP_Filter) );
1054 sqlite3WindowDelete(db, p->y.pWin);
1055 }else{
1056 assert( p->op==TK_FUNCTION || p->op==TK_AGG_FUNCTION );
1057 sqlite3ExprDeleteNN(db, p->y.pFilter);
1058 }
1059 }
dan6ba7ab02019-07-02 11:56:47 +00001060#endif
dan8117f112019-07-10 20:16:53 +00001061 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001062 }
drh209bc522016-09-23 21:36:24 +00001063 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001064 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001065 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001066 }
drha2e00042002-01-22 03:13:42 +00001067}
drh4f0010b2016-04-11 14:49:39 +00001068void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1069 if( p ) sqlite3ExprDeleteNN(db, p);
1070}
drha2e00042002-01-22 03:13:42 +00001071
drh8e34e402019-06-11 10:43:56 +00001072/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1073** expression.
1074*/
1075void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1076 if( p ){
1077 if( IN_RENAME_OBJECT ){
1078 sqlite3RenameExprUnmap(pParse, p);
1079 }
1080 sqlite3ExprDeleteNN(pParse->db, p);
1081 }
1082}
1083
drhd2687b72005-08-12 22:56:09 +00001084/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001085** Return the number of bytes allocated for the expression structure
1086** passed as the first argument. This is always one of EXPR_FULLSIZE,
1087** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1088*/
1089static int exprStructSize(Expr *p){
1090 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001091 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1092 return EXPR_FULLSIZE;
1093}
1094
1095/*
drha8e05762019-01-05 21:56:12 +00001096** Copy the complete content of an Expr node, taking care not to read
1097** past the end of the structure for a reduced-size version of the source
1098** Expr.
1099*/
1100static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1101 memset(pDest, 0, sizeof(Expr));
1102 memcpy(pDest, pSrc, exprStructSize(pSrc));
1103}
1104
1105/*
drh33e619f2009-05-28 01:00:55 +00001106** The dupedExpr*Size() routines each return the number of bytes required
1107** to store a copy of an expression or expression tree. They differ in
1108** how much of the tree is measured.
1109**
1110** dupedExprStructSize() Size of only the Expr structure
1111** dupedExprNodeSize() Size of Expr + space for token
1112** dupedExprSize() Expr + token + subtree components
1113**
1114***************************************************************************
1115**
1116** The dupedExprStructSize() function returns two values OR-ed together:
1117** (1) the space required for a copy of the Expr structure only and
1118** (2) the EP_xxx flags that indicate what the structure size should be.
1119** The return values is always one of:
1120**
1121** EXPR_FULLSIZE
1122** EXPR_REDUCEDSIZE | EP_Reduced
1123** EXPR_TOKENONLYSIZE | EP_TokenOnly
1124**
1125** The size of the structure can be found by masking the return value
1126** of this routine with 0xfff. The flags can be found by masking the
1127** return value with EP_Reduced|EP_TokenOnly.
1128**
1129** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1130** (unreduced) Expr objects as they or originally constructed by the parser.
1131** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001132** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001133** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001134** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001135** to reduce a pristine expression tree from the parser. The implementation
1136** of dupedExprStructSize() contain multiple assert() statements that attempt
1137** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001138*/
1139static int dupedExprStructSize(Expr *p, int flags){
1140 int nSize;
drh33e619f2009-05-28 01:00:55 +00001141 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001142 assert( EXPR_FULLSIZE<=0xfff );
1143 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001144 if( 0==flags || p->op==TK_SELECT_COLUMN
1145#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001146 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001147#endif
1148 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001149 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001150 }else{
drhc5cd1242013-09-12 16:50:49 +00001151 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001152 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001153 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001154 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001155 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001156 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1157 }else{
drhaecd8022013-09-13 18:15:15 +00001158 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001159 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1160 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001161 }
1162 return nSize;
1163}
1164
1165/*
drh33e619f2009-05-28 01:00:55 +00001166** This function returns the space in bytes required to store the copy
1167** of the Expr structure and a copy of the Expr.u.zToken string (if that
1168** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001169*/
1170static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001171 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1172 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001173 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001174 }
danielk1977bc739712009-03-23 04:33:32 +00001175 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001176}
1177
1178/*
1179** Return the number of bytes required to create a duplicate of the
1180** expression passed as the first argument. The second argument is a
1181** mask containing EXPRDUP_XXX flags.
1182**
1183** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001184** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001185**
1186** If the EXPRDUP_REDUCE flag is set, then the return value includes
1187** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1188** and Expr.pRight variables (but not for any structures pointed to or
1189** descended from the Expr.x.pList or Expr.x.pSelect variables).
1190*/
1191static int dupedExprSize(Expr *p, int flags){
1192 int nByte = 0;
1193 if( p ){
1194 nByte = dupedExprNodeSize(p, flags);
1195 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001196 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001197 }
1198 }
1199 return nByte;
1200}
1201
1202/*
1203** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1204** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001205** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001206** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001207** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001208** portion of the buffer copied into by this function.
1209*/
drh3c194692016-04-11 16:43:43 +00001210static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1211 Expr *pNew; /* Value to return */
1212 u8 *zAlloc; /* Memory space from which to build Expr object */
1213 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1214
drh575fad62016-02-05 13:38:36 +00001215 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001216 assert( p );
1217 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1218 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001219
drh3c194692016-04-11 16:43:43 +00001220 /* Figure out where to write the new Expr structure. */
1221 if( pzBuffer ){
1222 zAlloc = *pzBuffer;
1223 staticFlag = EP_Static;
1224 }else{
1225 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1226 staticFlag = 0;
1227 }
1228 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001229
drh3c194692016-04-11 16:43:43 +00001230 if( pNew ){
1231 /* Set nNewSize to the size allocated for the structure pointed to
1232 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1233 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1234 ** by the copy of the p->u.zToken string (if any).
1235 */
1236 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1237 const int nNewSize = nStructSize & 0xfff;
1238 int nToken;
1239 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1240 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001241 }else{
drh3c194692016-04-11 16:43:43 +00001242 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001243 }
drh3c194692016-04-11 16:43:43 +00001244 if( dupFlags ){
1245 assert( ExprHasProperty(p, EP_Reduced)==0 );
1246 memcpy(zAlloc, p, nNewSize);
1247 }else{
1248 u32 nSize = (u32)exprStructSize(p);
1249 memcpy(zAlloc, p, nSize);
1250 if( nSize<EXPR_FULLSIZE ){
1251 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1252 }
1253 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001254
drh3c194692016-04-11 16:43:43 +00001255 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1256 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1257 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1258 pNew->flags |= staticFlag;
1259
1260 /* Copy the p->u.zToken string, if any. */
1261 if( nToken ){
1262 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1263 memcpy(zToken, p->u.zToken, nToken);
1264 }
1265
drh209bc522016-09-23 21:36:24 +00001266 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001267 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1268 if( ExprHasProperty(p, EP_xIsSelect) ){
1269 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001270 }else{
drh3c194692016-04-11 16:43:43 +00001271 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001272 }
drh3c194692016-04-11 16:43:43 +00001273 }
1274
1275 /* Fill in pNew->pLeft and pNew->pRight. */
dan6ba7ab02019-07-02 11:56:47 +00001276 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc|EP_Filter) ){
drh53988062018-09-24 15:39:30 +00001277 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001278 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001279 pNew->pLeft = p->pLeft ?
1280 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1281 pNew->pRight = p->pRight ?
1282 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001283 }
dan67a9b8e2018-06-22 20:51:35 +00001284#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001285 if( ExprHasProperty(p, EP_WinFunc) ){
1286 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1287 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001288 }
dan6ba7ab02019-07-02 11:56:47 +00001289 if( ExprHasProperty(p, EP_Filter) ){
1290 pNew->y.pFilter = sqlite3ExprDup(db, p->y.pFilter, 0);
1291 assert( ExprHasProperty(pNew, EP_Filter) );
1292 }
dan67a9b8e2018-06-22 20:51:35 +00001293#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001294 if( pzBuffer ){
1295 *pzBuffer = zAlloc;
1296 }
1297 }else{
drh209bc522016-09-23 21:36:24 +00001298 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001299 if( pNew->op==TK_SELECT_COLUMN ){
1300 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001301 assert( p->iColumn==0 || p->pRight==0 );
1302 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001303 }else{
1304 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1305 }
drh3c194692016-04-11 16:43:43 +00001306 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001307 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001308 }
1309 }
1310 return pNew;
1311}
1312
1313/*
danbfe31e72014-01-15 14:17:31 +00001314** Create and return a deep copy of the object passed as the second
1315** argument. If an OOM condition is encountered, NULL is returned
1316** and the db->mallocFailed flag set.
1317*/
daneede6a52014-01-15 19:42:23 +00001318#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001319static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001320 With *pRet = 0;
1321 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001322 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001323 pRet = sqlite3DbMallocZero(db, nByte);
1324 if( pRet ){
1325 int i;
1326 pRet->nCte = p->nCte;
1327 for(i=0; i<p->nCte; i++){
1328 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1329 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1330 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1331 }
1332 }
1333 }
1334 return pRet;
1335}
daneede6a52014-01-15 19:42:23 +00001336#else
1337# define withDup(x,y) 0
1338#endif
dan4e9119d2014-01-13 15:12:23 +00001339
drha8389972018-12-06 22:04:19 +00001340#ifndef SQLITE_OMIT_WINDOWFUNC
1341/*
1342** The gatherSelectWindows() procedure and its helper routine
1343** gatherSelectWindowsCallback() are used to scan all the expressions
1344** an a newly duplicated SELECT statement and gather all of the Window
1345** objects found there, assembling them onto the linked list at Select->pWin.
1346*/
1347static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001348 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
1349 assert( pExpr->y.pWin );
drha8389972018-12-06 22:04:19 +00001350 pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1351 pWalker->u.pSelect->pWin = pExpr->y.pWin;
1352 }
1353 return WRC_Continue;
1354}
drha37b6a52018-12-06 22:12:18 +00001355static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1356 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1357}
drha8389972018-12-06 22:04:19 +00001358static void gatherSelectWindows(Select *p){
1359 Walker w;
1360 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001361 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1362 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001363 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001364 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001365 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001366}
1367#endif
1368
1369
drha76b5df2002-02-23 02:32:10 +00001370/*
drhff78bd22002-02-27 01:47:11 +00001371** The following group of routines make deep copies of expressions,
1372** expression lists, ID lists, and select statements. The copies can
1373** be deleted (by being passed to their respective ...Delete() routines)
1374** without effecting the originals.
1375**
danielk19774adee202004-05-08 08:23:19 +00001376** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1377** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001378** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001379**
drhad3cab52002-05-24 02:04:32 +00001380** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001381**
drhb7916a72009-05-27 10:31:29 +00001382** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001383** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1384** truncated version of the usual Expr structure that will be stored as
1385** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001386*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001387Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001388 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001389 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001390}
danielk19776ab3a2e2009-02-19 14:39:25 +00001391ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001392 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001393 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001394 int i;
drhb1637482017-01-03 00:27:16 +00001395 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001396 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001397 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001398 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001399 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001400 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001401 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001402 pOldItem = p->a;
1403 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001404 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001405 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001406 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001407 if( pOldExpr
1408 && pOldExpr->op==TK_SELECT_COLUMN
1409 && (pNewExpr = pItem->pExpr)!=0
1410 ){
1411 assert( pNewExpr->iColumn==0 || i>0 );
1412 if( pNewExpr->iColumn==0 ){
1413 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001414 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1415 }else{
1416 assert( i>0 );
1417 assert( pItem[-1].pExpr!=0 );
1418 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1419 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1420 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001421 }
1422 }
drh17435752007-08-16 04:30:38 +00001423 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001424 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001425 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001426 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001427 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001428 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001429 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001430 }
1431 return pNew;
1432}
danielk197793758c82005-01-21 08:13:14 +00001433
1434/*
1435** If cursors, triggers, views and subqueries are all omitted from
1436** the build, then none of the following routines, except for
1437** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1438** called with a NULL argument.
1439*/
danielk19776a67fe82005-02-04 04:07:16 +00001440#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1441 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001442SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001443 SrcList *pNew;
1444 int i;
drh113088e2003-03-20 01:16:58 +00001445 int nByte;
drh575fad62016-02-05 13:38:36 +00001446 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001447 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001448 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001449 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001450 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001451 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001452 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001453 struct SrcList_item *pNewItem = &pNew->a[i];
1454 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001455 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001456 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001457 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1458 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1459 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001460 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001461 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001462 pNewItem->addrFillSub = pOldItem->addrFillSub;
1463 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001464 if( pNewItem->fg.isIndexedBy ){
1465 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1466 }
1467 pNewItem->pIBIndex = pOldItem->pIBIndex;
1468 if( pNewItem->fg.isTabFunc ){
1469 pNewItem->u1.pFuncArg =
1470 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1471 }
drhed8a3bb2005-06-06 21:19:56 +00001472 pTab = pNewItem->pTab = pOldItem->pTab;
1473 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001474 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001475 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001476 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1477 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001478 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001479 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001480 }
1481 return pNew;
1482}
drh17435752007-08-16 04:30:38 +00001483IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001484 IdList *pNew;
1485 int i;
drh575fad62016-02-05 13:38:36 +00001486 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001487 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001488 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001489 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001490 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001491 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001492 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001493 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001494 return 0;
1495 }
drh6c535152012-02-02 03:38:30 +00001496 /* Note that because the size of the allocation for p->a[] is not
1497 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1498 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001499 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001500 struct IdList_item *pNewItem = &pNew->a[i];
1501 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001502 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001503 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001504 }
1505 return pNew;
1506}
dana7466202017-02-03 14:44:52 +00001507Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1508 Select *pRet = 0;
1509 Select *pNext = 0;
1510 Select **pp = &pRet;
1511 Select *p;
1512
drh575fad62016-02-05 13:38:36 +00001513 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001514 for(p=pDup; p; p=p->pPrior){
1515 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1516 if( pNew==0 ) break;
1517 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1518 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1519 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1520 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1521 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1522 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1523 pNew->op = p->op;
1524 pNew->pNext = pNext;
1525 pNew->pPrior = 0;
1526 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001527 pNew->iLimit = 0;
1528 pNew->iOffset = 0;
1529 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1530 pNew->addrOpenEphm[0] = -1;
1531 pNew->addrOpenEphm[1] = -1;
1532 pNew->nSelectRow = p->nSelectRow;
1533 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001534#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001535 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001536 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001537 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001538#endif
drhfef37762018-07-10 19:48:35 +00001539 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001540 *pp = pNew;
1541 pp = &pNew->pPrior;
1542 pNext = pNew;
1543 }
1544
1545 return pRet;
drhff78bd22002-02-27 01:47:11 +00001546}
danielk197793758c82005-01-21 08:13:14 +00001547#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001548Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001549 assert( p==0 );
1550 return 0;
1551}
1552#endif
drhff78bd22002-02-27 01:47:11 +00001553
1554
1555/*
drha76b5df2002-02-23 02:32:10 +00001556** Add a new element to the end of an expression list. If pList is
1557** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001558**
drha19543f2017-09-15 15:17:48 +00001559** The pList argument must be either NULL or a pointer to an ExprList
1560** obtained from a prior call to sqlite3ExprListAppend(). This routine
1561** may not be used with an ExprList obtained from sqlite3ExprListDup().
1562** Reason: This routine assumes that the number of slots in pList->a[]
1563** is a power of two. That is true for sqlite3ExprListAppend() returns
1564** but is not necessarily true from the return value of sqlite3ExprListDup().
1565**
drhb7916a72009-05-27 10:31:29 +00001566** If a memory allocation error occurs, the entire list is freed and
1567** NULL is returned. If non-NULL is returned, then it is guaranteed
1568** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001569*/
drh17435752007-08-16 04:30:38 +00001570ExprList *sqlite3ExprListAppend(
1571 Parse *pParse, /* Parsing context */
1572 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001573 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001574){
drh43606172017-04-05 11:32:13 +00001575 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001576 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001577 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001578 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001579 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001580 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001581 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001582 }
drhc263f7c2016-01-18 13:18:54 +00001583 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001584 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001585 ExprList *pNew;
1586 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001587 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001588 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001589 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001590 }
drh43606172017-04-05 11:32:13 +00001591 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001592 }
drh43606172017-04-05 11:32:13 +00001593 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001594 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1595 assert( offsetof(struct ExprList_item,pExpr)==0 );
1596 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001597 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001598 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001599
1600no_mem:
1601 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001602 sqlite3ExprDelete(db, pExpr);
1603 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001604 return 0;
drha76b5df2002-02-23 02:32:10 +00001605}
1606
1607/*
drh8762ec12016-08-20 01:06:22 +00001608** pColumns and pExpr form a vector assignment which is part of the SET
1609** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001610**
1611** (a,b,c) = (expr1,expr2,expr3)
1612** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1613**
1614** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001615** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001616** TK_SELECT_COLUMN expressions.
1617*/
1618ExprList *sqlite3ExprListAppendVector(
1619 Parse *pParse, /* Parsing context */
1620 ExprList *pList, /* List to which to append. Might be NULL */
1621 IdList *pColumns, /* List of names of LHS of the assignment */
1622 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1623){
1624 sqlite3 *db = pParse->db;
1625 int n;
1626 int i;
drh66860af2016-08-23 18:30:10 +00001627 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001628 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1629 ** exit prior to this routine being invoked */
1630 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001631 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001632
1633 /* If the RHS is a vector, then we can immediately check to see that
1634 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1635 ** wildcards ("*") in the result set of the SELECT must be expanded before
1636 ** we can do the size check, so defer the size check until code generation.
1637 */
1638 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001639 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1640 pColumns->nId, n);
1641 goto vector_append_error;
1642 }
drh966e2912017-01-03 02:58:01 +00001643
1644 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001645 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1646 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1647 if( pList ){
drh66860af2016-08-23 18:30:10 +00001648 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001649 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1650 pColumns->a[i].zName = 0;
1651 }
1652 }
drh966e2912017-01-03 02:58:01 +00001653
drhffe28052017-05-06 18:09:36 +00001654 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001655 Expr *pFirst = pList->a[iFirst].pExpr;
1656 assert( pFirst!=0 );
1657 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001658
drhf4dd26c2017-04-05 11:49:06 +00001659 /* Store the SELECT statement in pRight so it will be deleted when
1660 ** sqlite3ExprListDelete() is called */
1661 pFirst->pRight = pExpr;
1662 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001663
drhf4dd26c2017-04-05 11:49:06 +00001664 /* Remember the size of the LHS in iTable so that we can check that
1665 ** the RHS and LHS sizes match during code generation. */
1666 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001667 }
1668
1669vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001670 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001671 sqlite3IdListDelete(db, pColumns);
1672 return pList;
1673}
1674
1675/*
drhbc622bc2015-08-24 15:39:42 +00001676** Set the sort order for the last element on the given ExprList.
1677*/
1678void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1679 if( p==0 ) return;
1680 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1681 assert( p->nExpr>0 );
1682 if( iSortOrder<0 ){
1683 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1684 return;
1685 }
1686 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001687}
1688
1689/*
drhb7916a72009-05-27 10:31:29 +00001690** Set the ExprList.a[].zName element of the most recently added item
1691** on the expression list.
1692**
1693** pList might be NULL following an OOM error. But pName should never be
1694** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1695** is set.
1696*/
1697void sqlite3ExprListSetName(
1698 Parse *pParse, /* Parsing context */
1699 ExprList *pList, /* List to which to add the span. */
1700 Token *pName, /* Name to be added */
1701 int dequote /* True to cause the name to be dequoted */
1702){
1703 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1704 if( pList ){
1705 struct ExprList_item *pItem;
1706 assert( pList->nExpr>0 );
1707 pItem = &pList->a[pList->nExpr-1];
1708 assert( pItem->zName==0 );
1709 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001710 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001711 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001712 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001713 }
drhb7916a72009-05-27 10:31:29 +00001714 }
1715}
1716
1717/*
1718** Set the ExprList.a[].zSpan element of the most recently added item
1719** on the expression list.
1720**
1721** pList might be NULL following an OOM error. But pSpan should never be
1722** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1723** is set.
1724*/
1725void sqlite3ExprListSetSpan(
1726 Parse *pParse, /* Parsing context */
1727 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001728 const char *zStart, /* Start of the span */
1729 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001730){
1731 sqlite3 *db = pParse->db;
1732 assert( pList!=0 || db->mallocFailed!=0 );
1733 if( pList ){
1734 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1735 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001736 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001737 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001738 }
1739}
1740
1741/*
danielk19777a15a4b2007-05-08 17:54:43 +00001742** If the expression list pEList contains more than iLimit elements,
1743** leave an error message in pParse.
1744*/
1745void sqlite3ExprListCheckLength(
1746 Parse *pParse,
1747 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001748 const char *zObject
1749){
drhb1a6c3c2008-03-20 16:30:17 +00001750 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001751 testcase( pEList && pEList->nExpr==mx );
1752 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001753 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001754 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1755 }
1756}
1757
1758/*
drha76b5df2002-02-23 02:32:10 +00001759** Delete an entire expression list.
1760*/
drhaffa8552016-04-11 18:25:05 +00001761static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001762 int i = pList->nExpr;
1763 struct ExprList_item *pItem = pList->a;
1764 assert( pList->nExpr>0 );
1765 do{
drh633e6d52008-07-28 19:34:53 +00001766 sqlite3ExprDelete(db, pItem->pExpr);
1767 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001768 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001769 pItem++;
1770 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001771 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001772}
drhaffa8552016-04-11 18:25:05 +00001773void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1774 if( pList ) exprListDeleteNN(db, pList);
1775}
drha76b5df2002-02-23 02:32:10 +00001776
1777/*
drh2308ed32015-02-09 16:09:34 +00001778** Return the bitwise-OR of all Expr.flags fields in the given
1779** ExprList.
drh885a5b02015-02-09 15:21:36 +00001780*/
drh2308ed32015-02-09 16:09:34 +00001781u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001782 int i;
drh2308ed32015-02-09 16:09:34 +00001783 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001784 assert( pList!=0 );
1785 for(i=0; i<pList->nExpr; i++){
1786 Expr *pExpr = pList->a[i].pExpr;
1787 assert( pExpr!=0 );
1788 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001789 }
drh2308ed32015-02-09 16:09:34 +00001790 return m;
drh885a5b02015-02-09 15:21:36 +00001791}
1792
1793/*
drh7e6f9802017-09-04 00:33:04 +00001794** This is a SELECT-node callback for the expression walker that
1795** always "fails". By "fail" in this case, we mean set
1796** pWalker->eCode to zero and abort.
1797**
1798** This callback is used by multiple expression walkers.
1799*/
1800int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1801 UNUSED_PARAMETER(NotUsed);
1802 pWalker->eCode = 0;
1803 return WRC_Abort;
1804}
1805
1806/*
drh171d16b2018-02-26 20:15:54 +00001807** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001808** then convert it into an TK_TRUEFALSE term. Return non-zero if
1809** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001810*/
1811int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1812 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001813 if( !ExprHasProperty(pExpr, EP_Quoted)
1814 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1815 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001816 ){
1817 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001818 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001819 return 1;
1820 }
1821 return 0;
1822}
1823
drh43c4ac82018-02-26 21:26:27 +00001824/*
drh96acafb2018-02-27 14:49:25 +00001825** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001826** and 0 if it is FALSE.
1827*/
drh96acafb2018-02-27 14:49:25 +00001828int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001829 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001830 assert( pExpr->op==TK_TRUEFALSE );
1831 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1832 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1833 return pExpr->u.zToken[4]==0;
1834}
1835
drh17180fc2019-04-19 17:26:19 +00001836/*
1837** If pExpr is an AND or OR expression, try to simplify it by eliminating
1838** terms that are always true or false. Return the simplified expression.
1839** Or return the original expression if no simplification is possible.
1840**
1841** Examples:
1842**
1843** (x<10) AND true => (x<10)
1844** (x<10) AND false => false
1845** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1846** (x<10) AND (y=22 OR true) => (x<10)
1847** (y=22) OR true => true
1848*/
1849Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1850 assert( pExpr!=0 );
1851 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1852 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1853 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1854 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1855 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1856 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1857 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1858 }
1859 }
1860 return pExpr;
1861}
1862
drh171d16b2018-02-26 20:15:54 +00001863
1864/*
drh059b2d52014-10-24 19:28:09 +00001865** These routines are Walker callbacks used to check expressions to
1866** see if they are "constant" for some definition of constant. The
1867** Walker.eCode value determines the type of "constant" we are looking
1868** for.
drh73b211a2005-01-18 04:00:42 +00001869**
drh7d10d5a2008-08-20 16:35:10 +00001870** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001871**
drh059b2d52014-10-24 19:28:09 +00001872** sqlite3ExprIsConstant() pWalker->eCode==1
1873** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001874** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001875** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001876**
drh059b2d52014-10-24 19:28:09 +00001877** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1878** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001879**
drhfeada2d2014-09-24 13:20:22 +00001880** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001881** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1882** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001883** parameter raises an error for new statements, but is silently converted
1884** to NULL for existing schemas. This allows sqlite_master tables that
1885** contain a bound parameter because they were generated by older versions
1886** of SQLite to be parsed by newer versions of SQLite without raising a
1887** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001888*/
drh7d10d5a2008-08-20 16:35:10 +00001889static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001890
drh059b2d52014-10-24 19:28:09 +00001891 /* If pWalker->eCode is 2 then any term of the expression that comes from
1892 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001893 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001894 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1895 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001896 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001897 }
1898
drh626a8792005-01-17 22:08:19 +00001899 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001900 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001901 ** and either pWalker->eCode==4 or 5 or the function has the
1902 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001903 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001904 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001905 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001906 }else{
1907 pWalker->eCode = 0;
1908 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001909 }
drh626a8792005-01-17 22:08:19 +00001910 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001911 /* Convert "true" or "false" in a DEFAULT clause into the
1912 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001913 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001914 return WRC_Prune;
1915 }
1916 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001917 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001918 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001919 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001920 testcase( pExpr->op==TK_ID );
1921 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001922 testcase( pExpr->op==TK_AGG_FUNCTION );
1923 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001924 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001925 return WRC_Continue;
1926 }
drh059b2d52014-10-24 19:28:09 +00001927 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1928 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001929 }
drhf43ce0b2017-05-25 00:08:48 +00001930 /* Fall through */
1931 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001932 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001933 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001934 testcase( pExpr->op==TK_IF_NULL_ROW );
1935 pWalker->eCode = 0;
1936 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001937 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001938 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001939 /* Silently convert bound parameters that appear inside of CREATE
1940 ** statements into a NULL when parsing the CREATE statement text out
1941 ** of the sqlite_master table */
1942 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001943 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001944 /* A bound parameter in a CREATE statement that originates from
1945 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001946 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001947 return WRC_Abort;
1948 }
1949 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001950 default:
drh6e341b92018-04-17 18:50:40 +00001951 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1952 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001953 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001954 }
1955}
drh059b2d52014-10-24 19:28:09 +00001956static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001957 Walker w;
drh059b2d52014-10-24 19:28:09 +00001958 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001959 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001960 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001961#ifdef SQLITE_DEBUG
1962 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1963#endif
drh059b2d52014-10-24 19:28:09 +00001964 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001965 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001966 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001967}
drh626a8792005-01-17 22:08:19 +00001968
1969/*
drh059b2d52014-10-24 19:28:09 +00001970** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001971** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001972**
1973** For the purposes of this function, a double-quoted string (ex: "abc")
1974** is considered a variable but a single-quoted string (ex: 'abc') is
1975** a constant.
drhfef52082000-06-06 01:50:43 +00001976*/
danielk19774adee202004-05-08 08:23:19 +00001977int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001978 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001979}
1980
1981/*
drh07aded62018-07-28 16:24:08 +00001982** Walk an expression tree. Return non-zero if
1983**
1984** (1) the expression is constant, and
1985** (2) the expression does originate in the ON or USING clause
1986** of a LEFT JOIN, and
1987** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1988** operands created by the constant propagation optimization.
1989**
1990** When this routine returns true, it indicates that the expression
1991** can be added to the pParse->pConstExpr list and evaluated once when
1992** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001993*/
1994int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001995 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001996}
1997
1998/*
drhfcb9f4f2015-06-01 18:13:16 +00001999** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002000** for any single row of the table with cursor iCur. In other words, the
2001** expression must not refer to any non-deterministic function nor any
2002** table other than iCur.
2003*/
2004int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2005 return exprIsConst(p, 3, iCur);
2006}
2007
danab31a842017-04-29 20:53:09 +00002008
2009/*
2010** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2011*/
2012static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2013 ExprList *pGroupBy = pWalker->u.pGroupBy;
2014 int i;
2015
2016 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2017 ** it constant. */
2018 for(i=0; i<pGroupBy->nExpr; i++){
2019 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002020 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002021 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002022 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002023 return WRC_Prune;
2024 }
2025 }
2026 }
2027
2028 /* Check if pExpr is a sub-select. If so, consider it variable. */
2029 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2030 pWalker->eCode = 0;
2031 return WRC_Abort;
2032 }
2033
2034 return exprNodeIsConstant(pWalker, pExpr);
2035}
2036
2037/*
2038** Walk the expression tree passed as the first argument. Return non-zero
2039** if the expression consists entirely of constants or copies of terms
2040** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002041**
2042** This routine is used to determine if a term of the HAVING clause can
2043** be promoted into the WHERE clause. In order for such a promotion to work,
2044** the value of the HAVING clause term must be the same for all members of
2045** a "group". The requirement that the GROUP BY term must be BINARY
2046** assumes that no other collating sequence will have a finer-grained
2047** grouping than binary. In other words (A=B COLLATE binary) implies
2048** A=B in every other collating sequence. The requirement that the
2049** GROUP BY be BINARY is stricter than necessary. It would also work
2050** to promote HAVING clauses that use the same alternative collating
2051** sequence as the GROUP BY term, but that is much harder to check,
2052** alternative collating sequences are uncommon, and this is only an
2053** optimization, so we take the easy way out and simply require the
2054** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002055*/
2056int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2057 Walker w;
danab31a842017-04-29 20:53:09 +00002058 w.eCode = 1;
2059 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002060 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002061 w.u.pGroupBy = pGroupBy;
2062 w.pParse = pParse;
2063 sqlite3WalkExpr(&w, p);
2064 return w.eCode;
2065}
2066
drh059b2d52014-10-24 19:28:09 +00002067/*
2068** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002069** or a function call with constant arguments. Return and 0 if there
2070** are any variables.
2071**
2072** For the purposes of this function, a double-quoted string (ex: "abc")
2073** is considered a variable but a single-quoted string (ex: 'abc') is
2074** a constant.
2075*/
drhfeada2d2014-09-24 13:20:22 +00002076int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2077 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002078 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002079}
2080
drh5b88bc42013-12-07 23:35:21 +00002081#ifdef SQLITE_ENABLE_CURSOR_HINTS
2082/*
2083** Walk an expression tree. Return 1 if the expression contains a
2084** subquery of some kind. Return 0 if there are no subqueries.
2085*/
2086int sqlite3ExprContainsSubquery(Expr *p){
2087 Walker w;
drhbec24762015-08-13 20:07:13 +00002088 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002089 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002090 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002091#ifdef SQLITE_DEBUG
2092 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2093#endif
drh5b88bc42013-12-07 23:35:21 +00002094 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002095 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002096}
2097#endif
2098
drheb55bd22005-06-30 17:04:21 +00002099/*
drh73b211a2005-01-18 04:00:42 +00002100** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002101** to fit in a 32-bit integer, return 1 and put the value of the integer
2102** in *pValue. If the expression is not an integer or if it is too big
2103** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002104*/
danielk19774adee202004-05-08 08:23:19 +00002105int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002106 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002107 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002108
2109 /* If an expression is an integer literal that fits in a signed 32-bit
2110 ** integer, then the EP_IntValue flag will have already been set */
2111 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2112 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2113
drh92b01d52008-06-24 00:32:35 +00002114 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002115 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002116 return 1;
2117 }
drhe4de1fe2002-06-02 16:09:01 +00002118 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002119 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002120 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002121 break;
drh4b59ab52002-08-24 18:24:51 +00002122 }
drhe4de1fe2002-06-02 16:09:01 +00002123 case TK_UMINUS: {
2124 int v;
danielk19774adee202004-05-08 08:23:19 +00002125 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002126 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002127 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002128 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002129 }
2130 break;
2131 }
2132 default: break;
2133 }
drh92b01d52008-06-24 00:32:35 +00002134 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002135}
2136
2137/*
drh039fc322009-11-17 18:31:47 +00002138** Return FALSE if there is no chance that the expression can be NULL.
2139**
2140** If the expression might be NULL or if the expression is too complex
2141** to tell return TRUE.
2142**
2143** This routine is used as an optimization, to skip OP_IsNull opcodes
2144** when we know that a value cannot be NULL. Hence, a false positive
2145** (returning TRUE when in fact the expression can never be NULL) might
2146** be a small performance hit but is otherwise harmless. On the other
2147** hand, a false negative (returning FALSE when the result could be NULL)
2148** will likely result in an incorrect answer. So when in doubt, return
2149** TRUE.
2150*/
2151int sqlite3ExprCanBeNull(const Expr *p){
2152 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002153 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2154 p = p->pLeft;
2155 }
drh039fc322009-11-17 18:31:47 +00002156 op = p->op;
2157 if( op==TK_REGISTER ) op = p->op2;
2158 switch( op ){
2159 case TK_INTEGER:
2160 case TK_STRING:
2161 case TK_FLOAT:
2162 case TK_BLOB:
2163 return 0;
drh7248a8b2014-08-04 18:50:54 +00002164 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002165 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002166 p->y.pTab==0 || /* Reference to column of index on expression */
2167 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002168 default:
2169 return 1;
2170 }
2171}
2172
2173/*
2174** Return TRUE if the given expression is a constant which would be
2175** unchanged by OP_Affinity with the affinity given in the second
2176** argument.
2177**
2178** This routine is used to determine if the OP_Affinity operation
2179** can be omitted. When in doubt return FALSE. A false negative
2180** is harmless. A false positive, however, can result in the wrong
2181** answer.
2182*/
2183int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2184 u8 op;
drh05883a32015-06-02 15:32:08 +00002185 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002186 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002187 op = p->op;
2188 if( op==TK_REGISTER ) op = p->op2;
2189 switch( op ){
2190 case TK_INTEGER: {
2191 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2192 }
2193 case TK_FLOAT: {
2194 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2195 }
2196 case TK_STRING: {
2197 return aff==SQLITE_AFF_TEXT;
2198 }
2199 case TK_BLOB: {
2200 return 1;
2201 }
drh2f2855b2009-11-18 01:25:26 +00002202 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002203 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2204 return p->iColumn<0
2205 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002206 }
drh039fc322009-11-17 18:31:47 +00002207 default: {
2208 return 0;
2209 }
2210 }
2211}
2212
2213/*
drhc4a3c772001-04-04 11:48:57 +00002214** Return TRUE if the given string is a row-id column name.
2215*/
danielk19774adee202004-05-08 08:23:19 +00002216int sqlite3IsRowid(const char *z){
2217 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2218 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2219 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002220 return 0;
2221}
2222
danielk19779a96b662007-11-29 17:05:18 +00002223/*
drh69c355b2016-03-09 15:34:51 +00002224** pX is the RHS of an IN operator. If pX is a SELECT statement
2225** that can be simplified to a direct table access, then return
2226** a pointer to the SELECT statement. If pX is not a SELECT statement,
2227** or if the SELECT statement needs to be manifested into a transient
2228** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002229*/
2230#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002231static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002232 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002233 SrcList *pSrc;
2234 ExprList *pEList;
2235 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002236 int i;
drh69c355b2016-03-09 15:34:51 +00002237 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2238 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2239 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002240 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002241 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002242 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2243 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2244 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002245 }
drhb74b1012009-05-28 21:04:37 +00002246 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002247 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002248 if( p->pWhere ) return 0; /* Has no WHERE clause */
2249 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002250 assert( pSrc!=0 );
2251 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002252 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002253 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002254 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002255 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002256 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2257 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002258 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002259 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002260 for(i=0; i<pEList->nExpr; i++){
2261 Expr *pRes = pEList->a[i].pExpr;
2262 if( pRes->op!=TK_COLUMN ) return 0;
2263 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002264 }
drh69c355b2016-03-09 15:34:51 +00002265 return p;
drhb287f4b2008-04-25 00:08:38 +00002266}
2267#endif /* SQLITE_OMIT_SUBQUERY */
2268
danf9b2e052016-08-02 17:45:00 +00002269#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002270/*
drh4c259e92014-08-01 21:12:35 +00002271** Generate code that checks the left-most column of index table iCur to see if
2272** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002273** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2274** to be set to NULL if iCur contains one or more NULL values.
2275*/
2276static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002277 int addr1;
drh6be515e2014-08-01 21:00:53 +00002278 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002279 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002280 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2281 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002282 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002283 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002284}
danf9b2e052016-08-02 17:45:00 +00002285#endif
drh6be515e2014-08-01 21:00:53 +00002286
drhbb53ecb2014-08-02 21:03:33 +00002287
2288#ifndef SQLITE_OMIT_SUBQUERY
2289/*
2290** The argument is an IN operator with a list (not a subquery) on the
2291** right-hand side. Return TRUE if that list is constant.
2292*/
2293static int sqlite3InRhsIsConstant(Expr *pIn){
2294 Expr *pLHS;
2295 int res;
2296 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2297 pLHS = pIn->pLeft;
2298 pIn->pLeft = 0;
2299 res = sqlite3ExprIsConstant(pIn);
2300 pIn->pLeft = pLHS;
2301 return res;
2302}
2303#endif
2304
drh6be515e2014-08-01 21:00:53 +00002305/*
danielk19779a96b662007-11-29 17:05:18 +00002306** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002307** The pX parameter is the expression on the RHS of the IN operator, which
2308** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002309**
drhd4305ca2012-09-18 17:08:33 +00002310** The job of this routine is to find or create a b-tree object that can
2311** be used either to test for membership in the RHS set or to iterate through
2312** all members of the RHS set, skipping duplicates.
2313**
drh3a856252014-08-01 14:46:57 +00002314** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002315** and pX->iTable is set to the index of that cursor.
2316**
drhb74b1012009-05-28 21:04:37 +00002317** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002318**
drh1ccce442013-03-12 20:38:51 +00002319** IN_INDEX_ROWID - The cursor was opened on a database table.
2320** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2321** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2322** IN_INDEX_EPH - The cursor was opened on a specially created and
2323** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002324** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2325** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002326**
drhd4305ca2012-09-18 17:08:33 +00002327** An existing b-tree might be used if the RHS expression pX is a simple
2328** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002329**
dan553168c2016-08-01 20:14:31 +00002330** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002331**
drhd4305ca2012-09-18 17:08:33 +00002332** If the RHS of the IN operator is a list or a more complex subquery, then
2333** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002334** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002335** existing table.
drhd4305ca2012-09-18 17:08:33 +00002336**
drh7fc0ba02017-11-17 15:02:00 +00002337** The inFlags parameter must contain, at a minimum, one of the bits
2338** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2339** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2340** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2341** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002342**
2343** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2344** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002345** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002346** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2347** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002348**
drh3a856252014-08-01 14:46:57 +00002349** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2350** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002351** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2352** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002353**
drhbb53ecb2014-08-02 21:03:33 +00002354** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2355** if the RHS of the IN operator is a list (not a subquery) then this
2356** routine might decide that creating an ephemeral b-tree for membership
2357** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2358** calling routine should implement the IN operator using a sequence
2359** of Eq or Ne comparison operations.
2360**
drhb74b1012009-05-28 21:04:37 +00002361** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002362** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002363** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002364** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002365** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002366** to *prRhsHasNull. If there is no chance that the (...) contains a
2367** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002368**
drhe21a6e12014-08-01 18:00:24 +00002369** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002370** the value in that register will be NULL if the b-tree contains one or more
2371** NULL values, and it will be some non-NULL value if the b-tree contains no
2372** NULL values.
dan553168c2016-08-01 20:14:31 +00002373**
2374** If the aiMap parameter is not NULL, it must point to an array containing
2375** one element for each column returned by the SELECT statement on the RHS
2376** of the IN(...) operator. The i'th entry of the array is populated with the
2377** offset of the index column that matches the i'th column returned by the
2378** SELECT. For example, if the expression and selected index are:
2379**
2380** (?,?,?) IN (SELECT a, b, c FROM t1)
2381** CREATE INDEX i1 ON t1(b, c, a);
2382**
2383** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002384*/
danielk1977284f4ac2007-12-10 05:03:46 +00002385#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002386int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002387 Parse *pParse, /* Parsing context */
2388 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2389 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2390 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002391 int *aiMap, /* Mapping from Index fields to RHS fields */
2392 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002393){
drhb74b1012009-05-28 21:04:37 +00002394 Select *p; /* SELECT to the right of IN operator */
2395 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2396 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002397 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002398 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002399
drh1450bc62009-10-30 13:25:56 +00002400 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002401 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002402
dan7b35a772016-07-28 19:47:15 +00002403 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2404 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002405 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002406 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002407 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002408 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2409 int i;
2410 ExprList *pEList = pX->x.pSelect->pEList;
2411 for(i=0; i<pEList->nExpr; i++){
2412 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2413 }
2414 if( i==pEList->nExpr ){
2415 prRhsHasNull = 0;
2416 }
2417 }
2418
drhb74b1012009-05-28 21:04:37 +00002419 /* Check to see if an existing table or index can be used to
2420 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002421 ** ephemeral table. */
2422 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002423 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002424 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002425 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002426 ExprList *pEList = p->pEList;
2427 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002428
drhb07028f2011-10-14 21:49:18 +00002429 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2430 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2431 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2432 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002433
drhb22f7c82014-02-06 23:56:27 +00002434 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002435 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2436 sqlite3CodeVerifySchema(pParse, iDb);
2437 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002438
drha84a2832016-08-26 21:15:35 +00002439 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002440 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002441 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002442 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002443 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002444
2445 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2446 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002447 ExplainQueryPlan((pParse, 0,
2448 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002449 sqlite3VdbeJumpHere(v, iAddr);
2450 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002451 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002452 int affinity_ok = 1;
2453 int i;
2454
2455 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002456 ** comparison is the same as the affinity of each column in table
2457 ** on the RHS of the IN operator. If it not, it is not possible to
2458 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002459 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002460 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002461 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002462 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002463 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002464 testcase( cmpaff==SQLITE_AFF_BLOB );
2465 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002466 switch( cmpaff ){
2467 case SQLITE_AFF_BLOB:
2468 break;
2469 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002470 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2471 ** other has no affinity and the other side is TEXT. Hence,
2472 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2473 ** and for the term on the LHS of the IN to have no affinity. */
2474 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002475 break;
2476 default:
2477 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2478 }
2479 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002480
drha84a2832016-08-26 21:15:35 +00002481 if( affinity_ok ){
2482 /* Search for an existing index that will work for this IN operator */
2483 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2484 Bitmask colUsed; /* Columns of the index used */
2485 Bitmask mCol; /* Mask for the current column */
2486 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002487 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002488 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2489 ** BITMASK(nExpr) without overflowing */
2490 testcase( pIdx->nColumn==BMS-2 );
2491 testcase( pIdx->nColumn==BMS-1 );
2492 if( pIdx->nColumn>=BMS-1 ) continue;
2493 if( mustBeUnique ){
2494 if( pIdx->nKeyCol>nExpr
2495 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2496 ){
2497 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002498 }
danielk19770cdc0222008-06-26 18:04:03 +00002499 }
drha84a2832016-08-26 21:15:35 +00002500
2501 colUsed = 0; /* Columns of index used so far */
2502 for(i=0; i<nExpr; i++){
2503 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2504 Expr *pRhs = pEList->a[i].pExpr;
2505 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2506 int j;
2507
2508 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2509 for(j=0; j<nExpr; j++){
2510 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2511 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002512 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2513 continue;
2514 }
drha84a2832016-08-26 21:15:35 +00002515 break;
2516 }
2517 if( j==nExpr ) break;
2518 mCol = MASKBIT(j);
2519 if( mCol & colUsed ) break; /* Each column used only once */
2520 colUsed |= mCol;
2521 if( aiMap ) aiMap[i] = j;
2522 }
2523
2524 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2525 if( colUsed==(MASKBIT(nExpr)-1) ){
2526 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002527 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002528 ExplainQueryPlan((pParse, 0,
2529 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002530 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2531 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2532 VdbeComment((v, "%s", pIdx->zName));
2533 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2534 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2535
2536 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002537#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002538 i64 mask = (1<<nExpr)-1;
2539 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2540 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002541#endif
2542 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002543 if( nExpr==1 ){
2544 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2545 }
2546 }
2547 sqlite3VdbeJumpHere(v, iAddr);
2548 }
2549 } /* End loop over indexes */
2550 } /* End if( affinity_ok ) */
2551 } /* End if not an rowid index */
2552 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002553
drhbb53ecb2014-08-02 21:03:33 +00002554 /* If no preexisting index is available for the IN clause
2555 ** and IN_INDEX_NOOP is an allowed reply
2556 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002557 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002558 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002559 ** the IN operator so return IN_INDEX_NOOP.
2560 */
2561 if( eType==0
2562 && (inFlags & IN_INDEX_NOOP_OK)
2563 && !ExprHasProperty(pX, EP_xIsSelect)
2564 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2565 ){
2566 eType = IN_INDEX_NOOP;
2567 }
drhbb53ecb2014-08-02 21:03:33 +00002568
danielk19779a96b662007-11-29 17:05:18 +00002569 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002570 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002571 ** We will have to generate an ephemeral table to do the job.
2572 */
drh8e23daf2013-06-11 13:30:04 +00002573 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002574 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002575 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002576 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002577 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002578 }else if( prRhsHasNull ){
2579 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002580 }
drh85bcdce2018-12-23 21:27:29 +00002581 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002582 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002583 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002584 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002585 }
drhcf4d38a2010-07-28 02:53:36 +00002586 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002587 }
danba00e302016-07-23 20:24:06 +00002588
2589 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2590 int i, n;
2591 n = sqlite3ExprVectorSize(pX->pLeft);
2592 for(i=0; i<n; i++) aiMap[i] = i;
2593 }
drh2c041312018-12-24 02:34:49 +00002594 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002595 return eType;
2596}
danielk1977284f4ac2007-12-10 05:03:46 +00002597#endif
drh626a8792005-01-17 22:08:19 +00002598
danf9b2e052016-08-02 17:45:00 +00002599#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002600/*
2601** Argument pExpr is an (?, ?...) IN(...) expression. This
2602** function allocates and returns a nul-terminated string containing
2603** the affinities to be used for each column of the comparison.
2604**
2605** It is the responsibility of the caller to ensure that the returned
2606** string is eventually freed using sqlite3DbFree().
2607*/
dan71c57db2016-07-09 20:23:55 +00002608static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2609 Expr *pLeft = pExpr->pLeft;
2610 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002611 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002612 char *zRet;
2613
dan553168c2016-08-01 20:14:31 +00002614 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002615 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002616 if( zRet ){
2617 int i;
2618 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002619 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002620 char a = sqlite3ExprAffinity(pA);
2621 if( pSelect ){
2622 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2623 }else{
2624 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002625 }
dan71c57db2016-07-09 20:23:55 +00002626 }
2627 zRet[nVal] = '\0';
2628 }
2629 return zRet;
2630}
danf9b2e052016-08-02 17:45:00 +00002631#endif
dan71c57db2016-07-09 20:23:55 +00002632
dan8da209b2016-07-26 18:06:08 +00002633#ifndef SQLITE_OMIT_SUBQUERY
2634/*
2635** Load the Parse object passed as the first argument with an error
2636** message of the form:
2637**
2638** "sub-select returns N columns - expected M"
2639*/
2640void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2641 const char *zFmt = "sub-select returns %d columns - expected %d";
2642 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2643}
2644#endif
2645
drh626a8792005-01-17 22:08:19 +00002646/*
dan44c56042016-12-07 15:38:37 +00002647** Expression pExpr is a vector that has been used in a context where
2648** it is not permitted. If pExpr is a sub-select vector, this routine
2649** loads the Parse object with a message of the form:
2650**
2651** "sub-select returns N columns - expected 1"
2652**
2653** Or, if it is a regular scalar vector:
2654**
2655** "row value misused"
2656*/
2657void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2658#ifndef SQLITE_OMIT_SUBQUERY
2659 if( pExpr->flags & EP_xIsSelect ){
2660 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2661 }else
2662#endif
2663 {
2664 sqlite3ErrorMsg(pParse, "row value misused");
2665 }
2666}
2667
drh85bcdce2018-12-23 21:27:29 +00002668#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002669/*
drh85bcdce2018-12-23 21:27:29 +00002670** Generate code that will construct an ephemeral table containing all terms
2671** in the RHS of an IN operator. The IN operator can be in either of two
2672** forms:
drh626a8792005-01-17 22:08:19 +00002673**
drh9cbe6352005-11-29 03:13:21 +00002674** x IN (4,5,11) -- IN operator with list on right-hand side
2675** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002676**
drh2c041312018-12-24 02:34:49 +00002677** The pExpr parameter is the IN operator. The cursor number for the
2678** constructed ephermeral table is returned. The first time the ephemeral
2679** table is computed, the cursor number is also stored in pExpr->iTable,
2680** however the cursor number returned might not be the same, as it might
2681** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002682**
drh85bcdce2018-12-23 21:27:29 +00002683** If the LHS expression ("x" in the examples) is a column value, or
2684** the SELECT statement returns a column value, then the affinity of that
2685** column is used to build the index keys. If both 'x' and the
2686** SELECT... statement are columns, then numeric affinity is used
2687** if either column has NUMERIC or INTEGER affinity. If neither
2688** 'x' nor the SELECT... statement are columns, then numeric affinity
2689** is used.
drhcce7d172000-05-31 15:34:51 +00002690*/
drh85bcdce2018-12-23 21:27:29 +00002691void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002692 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002693 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002694 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002695){
drh2c041312018-12-24 02:34:49 +00002696 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002697 int addr; /* Address of OP_OpenEphemeral instruction */
2698 Expr *pLeft; /* the LHS of the IN operator */
2699 KeyInfo *pKeyInfo = 0; /* Key information */
2700 int nVal; /* Size of vector pLeft */
2701 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002702
drh2c041312018-12-24 02:34:49 +00002703 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002704 assert( v!=0 );
2705
drh2c041312018-12-24 02:34:49 +00002706 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002707 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002708 **
2709 ** * The right-hand side is a correlated subquery
2710 ** * The right-hand side is an expression list containing variables
2711 ** * We are inside a trigger
2712 **
drh2c041312018-12-24 02:34:49 +00002713 ** If all of the above are false, then we can compute the RHS just once
2714 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002715 */
drhefb699f2018-12-24 11:55:44 +00002716 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002717 /* Reuse of the RHS is allowed */
2718 /* If this routine has already been coded, but the previous code
2719 ** might not have been invoked yet, so invoke it now as a subroutine.
2720 */
2721 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002722 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002723 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2724 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2725 pExpr->x.pSelect->selId));
2726 }
drh2c041312018-12-24 02:34:49 +00002727 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2728 pExpr->y.sub.iAddr);
2729 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002730 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002731 return;
2732 }
2733
2734 /* Begin coding the subroutine */
2735 ExprSetProperty(pExpr, EP_Subrtn);
2736 pExpr->y.sub.regReturn = ++pParse->nMem;
2737 pExpr->y.sub.iAddr =
2738 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2739 VdbeComment((v, "return address"));
2740
2741 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002742 }
2743
drh85bcdce2018-12-23 21:27:29 +00002744 /* Check to see if this is a vector IN operator */
2745 pLeft = pExpr->pLeft;
2746 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002747
drh85bcdce2018-12-23 21:27:29 +00002748 /* Construct the ephemeral table that will contain the content of
2749 ** RHS of the IN operator.
2750 */
drh2c041312018-12-24 02:34:49 +00002751 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002752 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002753#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2754 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2755 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2756 }else{
2757 VdbeComment((v, "RHS of IN operator"));
2758 }
2759#endif
drh50ef6712019-02-22 23:29:56 +00002760 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002761
drh85bcdce2018-12-23 21:27:29 +00002762 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2763 /* Case 1: expr IN (SELECT ...)
2764 **
2765 ** Generate code to write the results of the select into the temporary
2766 ** table allocated and opened above.
2767 */
2768 Select *pSelect = pExpr->x.pSelect;
2769 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002770
drh2c041312018-12-24 02:34:49 +00002771 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2772 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002773 ));
drh85bcdce2018-12-23 21:27:29 +00002774 /* If the LHS and RHS of the IN operator do not match, that
2775 ** error will have been caught long before we reach this point. */
2776 if( ALWAYS(pEList->nExpr==nVal) ){
2777 SelectDest dest;
2778 int i;
drhbd462bc2018-12-24 20:21:06 +00002779 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002780 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2781 pSelect->iLimit = 0;
2782 testcase( pSelect->selFlags & SF_Distinct );
2783 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2784 if( sqlite3Select(pParse, pSelect, &dest) ){
2785 sqlite3DbFree(pParse->db, dest.zAffSdst);
2786 sqlite3KeyInfoUnref(pKeyInfo);
2787 return;
drhfef52082000-06-06 01:50:43 +00002788 }
drh85bcdce2018-12-23 21:27:29 +00002789 sqlite3DbFree(pParse->db, dest.zAffSdst);
2790 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2791 assert( pEList!=0 );
2792 assert( pEList->nExpr>0 );
2793 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2794 for(i=0; i<nVal; i++){
2795 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2796 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2797 pParse, p, pEList->a[i].pExpr
2798 );
danielk197741a05b72008-10-02 13:50:55 +00002799 }
drh85bcdce2018-12-23 21:27:29 +00002800 }
2801 }else if( ALWAYS(pExpr->x.pList!=0) ){
2802 /* Case 2: expr IN (exprlist)
2803 **
2804 ** For each expression, build an index key from the evaluation and
2805 ** store it in the temporary table. If <expr> is a column, then use
2806 ** that columns affinity when building index keys. If <expr> is not
2807 ** a column, use numeric affinity.
2808 */
2809 char affinity; /* Affinity of the LHS of the IN */
2810 int i;
2811 ExprList *pList = pExpr->x.pList;
2812 struct ExprList_item *pItem;
2813 int r1, r2, r3;
2814 affinity = sqlite3ExprAffinity(pLeft);
2815 if( !affinity ){
2816 affinity = SQLITE_AFF_BLOB;
2817 }
2818 if( pKeyInfo ){
2819 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2820 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002821 }
2822
drh85bcdce2018-12-23 21:27:29 +00002823 /* Loop through each expression in <exprlist>. */
2824 r1 = sqlite3GetTempReg(pParse);
2825 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002826 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2827 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002828
2829 /* If the expression is not constant then we will need to
2830 ** disable the test that was generated above that makes sure
2831 ** this code only executes once. Because for a non-constant
2832 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002833 */
drh2c041312018-12-24 02:34:49 +00002834 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2835 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002836 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002837 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002838 }
drh1398ad32005-01-19 23:24:50 +00002839
drh85bcdce2018-12-23 21:27:29 +00002840 /* Evaluate the expression and insert it into the temp table */
drh50ef6712019-02-22 23:29:56 +00002841 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2842 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2843 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drhcce7d172000-05-31 15:34:51 +00002844 }
drh85bcdce2018-12-23 21:27:29 +00002845 sqlite3ReleaseTempReg(pParse, r1);
2846 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002847 }
drh85bcdce2018-12-23 21:27:29 +00002848 if( pKeyInfo ){
2849 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2850 }
drh2c041312018-12-24 02:34:49 +00002851 if( addrOnce ){
2852 sqlite3VdbeJumpHere(v, addrOnce);
2853 /* Subroutine return */
2854 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2855 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002856 }
2857}
2858#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002859
drh85bcdce2018-12-23 21:27:29 +00002860/*
2861** Generate code for scalar subqueries used as a subquery expression
2862** or EXISTS operator:
2863**
2864** (SELECT a FROM b) -- subquery
2865** EXISTS (SELECT a FROM b) -- EXISTS subquery
2866**
2867** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2868**
2869** The register that holds the result. For a multi-column SELECT,
2870** the result is stored in a contiguous array of registers and the
2871** return value is the register of the left-most result column.
2872** Return 0 if an error occurs.
2873*/
2874#ifndef SQLITE_OMIT_SUBQUERY
2875int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002876 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002877 int rReg = 0; /* Register storing resulting */
2878 Select *pSel; /* SELECT statement to encode */
2879 SelectDest dest; /* How to deal with SELECT result */
2880 int nReg; /* Registers to allocate */
2881 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002882
2883 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002884 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002885 testcase( pExpr->op==TK_EXISTS );
2886 testcase( pExpr->op==TK_SELECT );
2887 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2888 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2889 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002890
drh5198ff52018-12-24 12:09:47 +00002891 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002892 ** is encountered if any of the following is true:
2893 **
2894 ** * The right-hand side is a correlated subquery
2895 ** * The right-hand side is an expression list containing variables
2896 ** * We are inside a trigger
2897 **
2898 ** If all of the above are false, then we can run this code just once
2899 ** save the results, and reuse the same result on subsequent invocations.
2900 */
2901 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002902 /* If this routine has already been coded, then invoke it as a
2903 ** subroutine. */
2904 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002905 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002906 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2907 pExpr->y.sub.iAddr);
2908 return pExpr->iTable;
2909 }
2910
2911 /* Begin coding the subroutine */
2912 ExprSetProperty(pExpr, EP_Subrtn);
2913 pExpr->y.sub.regReturn = ++pParse->nMem;
2914 pExpr->y.sub.iAddr =
2915 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2916 VdbeComment((v, "return address"));
2917
drh2c041312018-12-24 02:34:49 +00002918 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002919 }
drh85bcdce2018-12-23 21:27:29 +00002920
2921 /* For a SELECT, generate code to put the values for all columns of
2922 ** the first row into an array of registers and return the index of
2923 ** the first register.
2924 **
2925 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2926 ** into a register and return that register number.
2927 **
2928 ** In both cases, the query is augmented with "LIMIT 1". Any
2929 ** preexisting limit is discarded in place of the new LIMIT 1.
2930 */
drhbd462bc2018-12-24 20:21:06 +00002931 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2932 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002933 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2934 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2935 pParse->nMem += nReg;
2936 if( pExpr->op==TK_SELECT ){
2937 dest.eDest = SRT_Mem;
2938 dest.iSdst = dest.iSDParm;
2939 dest.nSdst = nReg;
2940 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2941 VdbeComment((v, "Init subquery result"));
2942 }else{
2943 dest.eDest = SRT_Exists;
2944 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2945 VdbeComment((v, "Init EXISTS result"));
2946 }
2947 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2948 if( pSel->pLimit ){
2949 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2950 pSel->pLimit->pLeft = pLimit;
2951 }else{
2952 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2953 }
2954 pSel->iLimit = 0;
2955 if( sqlite3Select(pParse, pSel, &dest) ){
2956 return 0;
2957 }
drh2c041312018-12-24 02:34:49 +00002958 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002959 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002960 if( addrOnce ){
2961 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002962
drh5198ff52018-12-24 12:09:47 +00002963 /* Subroutine return */
2964 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2965 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2966 }
drh2c041312018-12-24 02:34:49 +00002967
drh1450bc62009-10-30 13:25:56 +00002968 return rReg;
drhcce7d172000-05-31 15:34:51 +00002969}
drh51522cd2005-01-20 13:36:19 +00002970#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002971
drhe3365e62009-11-12 17:52:24 +00002972#ifndef SQLITE_OMIT_SUBQUERY
2973/*
dan7b35a772016-07-28 19:47:15 +00002974** Expr pIn is an IN(...) expression. This function checks that the
2975** sub-select on the RHS of the IN() operator has the same number of
2976** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2977** a sub-query, that the LHS is a vector of size 1.
2978*/
2979int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2980 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2981 if( (pIn->flags & EP_xIsSelect) ){
2982 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2983 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2984 return 1;
2985 }
2986 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002987 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002988 return 1;
2989 }
2990 return 0;
2991}
2992#endif
2993
2994#ifndef SQLITE_OMIT_SUBQUERY
2995/*
drhe3365e62009-11-12 17:52:24 +00002996** Generate code for an IN expression.
2997**
2998** x IN (SELECT ...)
2999** x IN (value, value, ...)
3000**
drhecb87ac2016-08-25 15:46:25 +00003001** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003002** right-hand side (RHS) is an array of zero or more scalar values, or a
3003** subquery. If the RHS is a subquery, the number of result columns must
3004** match the number of columns in the vector on the LHS. If the RHS is
3005** a list of values, the LHS must be a scalar.
3006**
3007** The IN operator is true if the LHS value is contained within the RHS.
3008** The result is false if the LHS is definitely not in the RHS. The
3009** result is NULL if the presence of the LHS in the RHS cannot be
3010** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003011**
drh6be515e2014-08-01 21:00:53 +00003012** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003013** contained within the RHS. If due to NULLs we cannot determine if the LHS
3014** is contained in the RHS then jump to destIfNull. If the LHS is contained
3015** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003016**
3017** See the separate in-operator.md documentation file in the canonical
3018** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003019*/
3020static void sqlite3ExprCodeIN(
3021 Parse *pParse, /* Parsing and code generating context */
3022 Expr *pExpr, /* The IN expression */
3023 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3024 int destIfNull /* Jump here if the results are unknown due to NULLs */
3025){
3026 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003027 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003028 int rLhs; /* Register(s) holding the LHS values */
3029 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003030 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003031 int *aiMap = 0; /* Map from vector field to index column */
3032 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003033 int nVector; /* Size of vectors for this IN operator */
3034 int iDummy; /* Dummy parameter to exprCodeVector() */
3035 Expr *pLeft; /* The LHS of the IN operator */
3036 int i; /* loop counter */
3037 int destStep2; /* Where to jump when NULLs seen in step 2 */
3038 int destStep6 = 0; /* Start of code for Step 6 */
3039 int addrTruthOp; /* Address of opcode that determines the IN is true */
3040 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3041 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003042 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003043
drhe347d3e2016-08-25 21:14:34 +00003044 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003045 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003046 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003047 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3048 aiMap = (int*)sqlite3DbMallocZero(
3049 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3050 );
drhe347d3e2016-08-25 21:14:34 +00003051 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003052
danba00e302016-07-23 20:24:06 +00003053 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003054 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003055 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3056 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003057 v = pParse->pVdbe;
3058 assert( v!=0 ); /* OOM detected prior to this routine */
3059 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003060 eType = sqlite3FindInIndex(pParse, pExpr,
3061 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003062 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3063 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003064
danba00e302016-07-23 20:24:06 +00003065 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3066 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3067 );
drhecb87ac2016-08-25 15:46:25 +00003068#ifdef SQLITE_DEBUG
3069 /* Confirm that aiMap[] contains nVector integer values between 0 and
3070 ** nVector-1. */
3071 for(i=0; i<nVector; i++){
3072 int j, cnt;
3073 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3074 assert( cnt==1 );
3075 }
3076#endif
drhe3365e62009-11-12 17:52:24 +00003077
danba00e302016-07-23 20:24:06 +00003078 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3079 ** vector, then it is stored in an array of nVector registers starting
3080 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003081 **
3082 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3083 ** so that the fields are in the same order as an existing index. The
3084 ** aiMap[] array contains a mapping from the original LHS field order to
3085 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003086 */
drhe347d3e2016-08-25 21:14:34 +00003087 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3088 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003089 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003090 /* LHS fields are not reordered */
3091 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003092 }else{
3093 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003094 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003095 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003096 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003097 }
danba00e302016-07-23 20:24:06 +00003098 }
drhe3365e62009-11-12 17:52:24 +00003099
drhbb53ecb2014-08-02 21:03:33 +00003100 /* If sqlite3FindInIndex() did not find or create an index that is
3101 ** suitable for evaluating the IN operator, then evaluate using a
3102 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003103 **
3104 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003105 */
drhbb53ecb2014-08-02 21:03:33 +00003106 if( eType==IN_INDEX_NOOP ){
3107 ExprList *pList = pExpr->x.pList;
3108 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003109 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003110 int r2, regToFree;
3111 int regCkNull = 0;
3112 int ii;
3113 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003114 if( destIfNull!=destIfFalse ){
3115 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003116 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003117 }
3118 for(ii=0; ii<pList->nExpr; ii++){
3119 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003120 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003121 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3122 }
3123 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003124 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003125 (void*)pColl, P4_COLLSEQ);
3126 VdbeCoverageIf(v, ii<pList->nExpr-1);
3127 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003128 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003129 }else{
3130 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003131 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003132 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003133 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003134 }
3135 sqlite3ReleaseTempReg(pParse, regToFree);
3136 }
3137 if( regCkNull ){
3138 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003139 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003140 }
3141 sqlite3VdbeResolveLabel(v, labelOk);
3142 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003143 goto sqlite3ExprCodeIN_finished;
3144 }
3145
3146 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3147 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3148 ** We will then skip the binary search of the RHS.
3149 */
3150 if( destIfNull==destIfFalse ){
3151 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003152 }else{
drhec4ccdb2018-12-29 02:26:59 +00003153 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003154 }
3155 for(i=0; i<nVector; i++){
3156 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3157 if( sqlite3ExprCanBeNull(p) ){
3158 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003159 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003160 }
drhe3365e62009-11-12 17:52:24 +00003161 }
drhe347d3e2016-08-25 21:14:34 +00003162
3163 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3164 ** of the RHS using the LHS as a probe. If found, the result is
3165 ** true.
3166 */
3167 if( eType==IN_INDEX_ROWID ){
3168 /* In this case, the RHS is the ROWID of table b-tree and so we also
3169 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3170 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003171 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003172 VdbeCoverage(v);
3173 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3174 }else{
3175 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3176 if( destIfFalse==destIfNull ){
3177 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003178 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003179 rLhs, nVector); VdbeCoverage(v);
3180 goto sqlite3ExprCodeIN_finished;
3181 }
3182 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003183 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003184 rLhs, nVector); VdbeCoverage(v);
3185 }
3186
3187 /* Step 4. If the RHS is known to be non-NULL and we did not find
3188 ** an match on the search above, then the result must be FALSE.
3189 */
3190 if( rRhsHasNull && nVector==1 ){
3191 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3192 VdbeCoverage(v);
3193 }
3194
3195 /* Step 5. If we do not care about the difference between NULL and
3196 ** FALSE, then just return false.
3197 */
3198 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3199
3200 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3201 ** If any comparison is NULL, then the result is NULL. If all
3202 ** comparisons are FALSE then the final result is FALSE.
3203 **
3204 ** For a scalar LHS, it is sufficient to check just the first row
3205 ** of the RHS.
3206 */
3207 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003208 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003209 VdbeCoverage(v);
3210 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003211 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003212 }else{
3213 /* For nVector==1, combine steps 6 and 7 by immediately returning
3214 ** FALSE if the first comparison is not NULL */
3215 destNotNull = destIfFalse;
3216 }
3217 for(i=0; i<nVector; i++){
3218 Expr *p;
3219 CollSeq *pColl;
3220 int r3 = sqlite3GetTempReg(pParse);
3221 p = sqlite3VectorFieldSubexpr(pLeft, i);
3222 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003223 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003224 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3225 (void*)pColl, P4_COLLSEQ);
3226 VdbeCoverage(v);
3227 sqlite3ReleaseTempReg(pParse, r3);
3228 }
3229 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3230 if( nVector>1 ){
3231 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003232 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003233 VdbeCoverage(v);
3234
3235 /* Step 7: If we reach this point, we know that the result must
3236 ** be false. */
3237 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3238 }
3239
3240 /* Jumps here in order to return true. */
3241 sqlite3VdbeJumpHere(v, addrTruthOp);
3242
3243sqlite3ExprCodeIN_finished:
3244 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003245 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003246sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003247 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003248 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003249}
3250#endif /* SQLITE_OMIT_SUBQUERY */
3251
drh13573c72010-01-12 17:04:07 +00003252#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003253/*
3254** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003255** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003256**
3257** The z[] string will probably not be zero-terminated. But the
3258** z[n] character is guaranteed to be something that does not look
3259** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003260*/
drhb7916a72009-05-27 10:31:29 +00003261static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003262 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003263 double value;
drh9339da12010-09-30 00:50:49 +00003264 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003265 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3266 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003267 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003268 }
3269}
drh13573c72010-01-12 17:04:07 +00003270#endif
drh598f1342007-10-23 15:39:45 +00003271
3272
3273/*
drhfec19aa2004-05-19 20:41:03 +00003274** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003275** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003276**
shaneh5f1d6b62010-09-30 16:51:25 +00003277** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003278*/
drh13573c72010-01-12 17:04:07 +00003279static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3280 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003281 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003282 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003283 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003284 if( negFlag ) i = -i;
3285 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003286 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003287 int c;
3288 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003289 const char *z = pExpr->u.zToken;
3290 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003291 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003292 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003293#ifdef SQLITE_OMIT_FLOATING_POINT
3294 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3295#else
drh1b7ddc52014-07-23 14:52:05 +00003296#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003297 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003298 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003299 }else
3300#endif
3301 {
drh9296c182014-07-23 13:40:49 +00003302 codeReal(v, z, negFlag, iMem);
3303 }
drh13573c72010-01-12 17:04:07 +00003304#endif
drh77320ea2016-11-30 14:47:37 +00003305 }else{
drh84d4f1a2017-09-20 10:47:10 +00003306 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003307 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003308 }
drhfec19aa2004-05-19 20:41:03 +00003309 }
3310}
3311
drh5cd79232009-05-25 11:46:29 +00003312
drh1f9ca2c2015-08-25 16:57:52 +00003313/* Generate code that will load into register regOut a value that is
3314** appropriate for the iIdxCol-th column of index pIdx.
3315*/
3316void sqlite3ExprCodeLoadIndexColumn(
3317 Parse *pParse, /* The parsing context */
3318 Index *pIdx, /* The index whose column is to be loaded */
3319 int iTabCur, /* Cursor pointing to a table row */
3320 int iIdxCol, /* The column of the index to be loaded */
3321 int regOut /* Store the index column value in this register */
3322){
3323 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003324 if( iTabCol==XN_EXPR ){
3325 assert( pIdx->aColExpr );
3326 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003327 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003328 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003329 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003330 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003331 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3332 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003333 }
drh1f9ca2c2015-08-25 16:57:52 +00003334}
3335
drh5cd79232009-05-25 11:46:29 +00003336/*
drh5c092e82010-05-14 19:24:02 +00003337** Generate code to extract the value of the iCol-th column of a table.
3338*/
3339void sqlite3ExprCodeGetColumnOfTable(
3340 Vdbe *v, /* The VDBE under construction */
3341 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003342 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003343 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003344 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003345){
drhaca19e12017-04-07 19:41:31 +00003346 if( pTab==0 ){
3347 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3348 return;
3349 }
drh5c092e82010-05-14 19:24:02 +00003350 if( iCol<0 || iCol==pTab->iPKey ){
3351 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3352 }else{
3353 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003354 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003355 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003356 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3357 }
3358 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003359 }
3360 if( iCol>=0 ){
3361 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3362 }
3363}
3364
3365/*
drh945498f2007-02-24 11:52:52 +00003366** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003367** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003368**
3369** There must be an open cursor to pTab in iTable when this routine
3370** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003371*/
drhe55cbd72008-03-31 23:48:03 +00003372int sqlite3ExprCodeGetColumn(
3373 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003374 Table *pTab, /* Description of the table we are reading from */
3375 int iColumn, /* Index of the table column */
3376 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003377 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003378 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003379){
drhe55cbd72008-03-31 23:48:03 +00003380 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003381 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003382 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003383 if( p5 ){
3384 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003385 }
drhe55cbd72008-03-31 23:48:03 +00003386 return iReg;
3387}
drhe55cbd72008-03-31 23:48:03 +00003388
3389/*
drhb21e7c72008-06-22 12:37:57 +00003390** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003391** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003392*/
drhb21e7c72008-06-22 12:37:57 +00003393void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003394 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003395 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003396}
3397
drh652fbf52008-04-01 01:42:41 +00003398/*
drh12abf402016-08-22 14:30:05 +00003399** Convert a scalar expression node to a TK_REGISTER referencing
3400** register iReg. The caller must ensure that iReg already contains
3401** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003402*/
dan069d1b12019-06-16 08:58:14 +00003403static void exprToRegister(Expr *pExpr, int iReg){
3404 Expr *p = sqlite3ExprSkipCollate(pExpr);
drha4c3c872013-09-12 17:29:25 +00003405 p->op2 = p->op;
3406 p->op = TK_REGISTER;
3407 p->iTable = iReg;
3408 ExprClearProperty(p, EP_Skip);
3409}
3410
drh12abf402016-08-22 14:30:05 +00003411/*
3412** Evaluate an expression (either a vector or a scalar expression) and store
3413** the result in continguous temporary registers. Return the index of
3414** the first register used to store the result.
3415**
3416** If the returned result register is a temporary scalar, then also write
3417** that register number into *piFreeable. If the returned result register
3418** is not a temporary or if the expression is a vector set *piFreeable
3419** to 0.
3420*/
3421static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3422 int iResult;
3423 int nResult = sqlite3ExprVectorSize(p);
3424 if( nResult==1 ){
3425 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3426 }else{
3427 *piFreeable = 0;
3428 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003429#if SQLITE_OMIT_SUBQUERY
3430 iResult = 0;
3431#else
drh85bcdce2018-12-23 21:27:29 +00003432 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003433#endif
drh12abf402016-08-22 14:30:05 +00003434 }else{
3435 int i;
3436 iResult = pParse->nMem+1;
3437 pParse->nMem += nResult;
3438 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003439 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003440 }
3441 }
3442 }
3443 return iResult;
3444}
3445
dan71c57db2016-07-09 20:23:55 +00003446
drha4c3c872013-09-12 17:29:25 +00003447/*
drhcce7d172000-05-31 15:34:51 +00003448** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003449** expression. Attempt to store the results in register "target".
3450** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003451**
drh8b213892008-08-29 02:14:02 +00003452** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003453** be stored in target. The result might be stored in some other
3454** register if it is convenient to do so. The calling function
3455** must check the return code and move the results to the desired
3456** register.
drhcce7d172000-05-31 15:34:51 +00003457*/
drh678ccce2008-03-31 18:19:54 +00003458int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003459 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3460 int op; /* The opcode being coded */
3461 int inReg = target; /* Results stored in register inReg */
3462 int regFree1 = 0; /* If non-zero free this temporary register */
3463 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003464 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003465 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003466 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003467
drh9cbf3422008-01-17 16:22:13 +00003468 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003469 if( v==0 ){
3470 assert( pParse->db->mallocFailed );
3471 return 0;
3472 }
drh389a1ad2008-01-03 23:44:53 +00003473
drh1efa8022018-04-28 04:16:43 +00003474expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003475 if( pExpr==0 ){
3476 op = TK_NULL;
3477 }else{
3478 op = pExpr->op;
3479 }
drhf2bc0132004-10-04 13:19:23 +00003480 switch( op ){
drh13449892005-09-07 21:22:45 +00003481 case TK_AGG_COLUMN: {
3482 AggInfo *pAggInfo = pExpr->pAggInfo;
3483 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3484 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003485 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003486 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003487 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003488 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003489 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003490 return target;
drh13449892005-09-07 21:22:45 +00003491 }
3492 /* Otherwise, fall thru into the TK_COLUMN case */
3493 }
drh967e8b72000-06-21 13:59:10 +00003494 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003495 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003496 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003497 /* This COLUMN expression is really a constant due to WHERE clause
3498 ** constraints, and that constant is coded by the pExpr->pLeft
3499 ** expresssion. However, make sure the constant has the correct
3500 ** datatype by applying the Affinity of the table column to the
3501 ** constant.
3502 */
3503 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003504 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drhd98f5322018-08-09 18:36:54 +00003505 if( aff!=SQLITE_AFF_BLOB ){
3506 static const char zAff[] = "B\000C\000D\000E";
3507 assert( SQLITE_AFF_BLOB=='A' );
3508 assert( SQLITE_AFF_TEXT=='B' );
3509 if( iReg!=target ){
3510 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3511 iReg = target;
3512 }
3513 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3514 &zAff[(aff-'B')*2], P4_STATIC);
3515 }
3516 return iReg;
drhefad2e22018-07-27 16:57:11 +00003517 }
drhb2b9d3d2013-08-01 01:14:43 +00003518 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003519 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003520 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003521 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003522 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003523 /* Coding an expression that is part of an index where column names
3524 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003525 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003526 }
drh22827922000-06-06 17:27:05 +00003527 }
drheda079c2018-09-20 19:02:15 +00003528 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003529 pExpr->iColumn, iTab, target,
3530 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003531 }
3532 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003533 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003534 return target;
drhfec19aa2004-05-19 20:41:03 +00003535 }
drh8abed7b2018-02-26 18:49:05 +00003536 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003537 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003538 return target;
3539 }
drh13573c72010-01-12 17:04:07 +00003540#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003541 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003542 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3543 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003544 return target;
drh598f1342007-10-23 15:39:45 +00003545 }
drh13573c72010-01-12 17:04:07 +00003546#endif
drhfec19aa2004-05-19 20:41:03 +00003547 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003548 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003549 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003550 return target;
drhcce7d172000-05-31 15:34:51 +00003551 }
drhf0863fe2005-06-12 21:35:51 +00003552 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003553 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003554 return target;
drhf0863fe2005-06-12 21:35:51 +00003555 }
danielk19775338a5f2005-01-20 13:03:10 +00003556#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003557 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003558 int n;
3559 const char *z;
drhca48c902008-01-18 14:08:24 +00003560 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003561 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3562 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3563 assert( pExpr->u.zToken[1]=='\'' );
3564 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003565 n = sqlite3Strlen30(z) - 1;
3566 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003567 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3568 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003569 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003570 }
danielk19775338a5f2005-01-20 13:03:10 +00003571#endif
drh50457892003-09-06 01:10:47 +00003572 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003573 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3574 assert( pExpr->u.zToken!=0 );
3575 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003576 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3577 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003578 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003579 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003580 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003581 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003582 }
drhc332cc32016-09-19 10:24:19 +00003583 return target;
drh50457892003-09-06 01:10:47 +00003584 }
drh4e0cff62004-11-05 05:10:28 +00003585 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003586 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003587 }
drh487e2622005-06-25 18:42:14 +00003588#ifndef SQLITE_OMIT_CAST
3589 case TK_CAST: {
3590 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003591 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003592 if( inReg!=target ){
3593 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3594 inReg = target;
3595 }
drh4169e432014-08-25 20:11:52 +00003596 sqlite3VdbeAddOp2(v, OP_Cast, target,
3597 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003598 return inReg;
drh487e2622005-06-25 18:42:14 +00003599 }
3600#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003601 case TK_IS:
3602 case TK_ISNOT:
3603 op = (op==TK_IS) ? TK_EQ : TK_NE;
3604 p5 = SQLITE_NULLEQ;
3605 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003606 case TK_LT:
3607 case TK_LE:
3608 case TK_GT:
3609 case TK_GE:
3610 case TK_NE:
3611 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003612 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003613 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003614 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003615 }else{
3616 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3617 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3618 codeCompare(pParse, pLeft, pExpr->pRight, op,
3619 r1, r2, inReg, SQLITE_STOREP2 | p5);
3620 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3621 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3622 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3623 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3624 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3625 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3626 testcase( regFree1==0 );
3627 testcase( regFree2==0 );
3628 }
drh6a2fe092009-09-23 02:29:36 +00003629 break;
3630 }
drhcce7d172000-05-31 15:34:51 +00003631 case TK_AND:
3632 case TK_OR:
3633 case TK_PLUS:
3634 case TK_STAR:
3635 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003636 case TK_REM:
3637 case TK_BITAND:
3638 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003639 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003640 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003641 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003642 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003643 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3644 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3645 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3646 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3647 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3648 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3649 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3650 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3651 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3652 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3653 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003654 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3655 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003656 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003657 testcase( regFree1==0 );
3658 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003659 break;
3660 }
drhcce7d172000-05-31 15:34:51 +00003661 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003662 Expr *pLeft = pExpr->pLeft;
3663 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003664 if( pLeft->op==TK_INTEGER ){
3665 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003666 return target;
drh13573c72010-01-12 17:04:07 +00003667#ifndef SQLITE_OMIT_FLOATING_POINT
3668 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003669 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3670 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003671 return target;
drh13573c72010-01-12 17:04:07 +00003672#endif
drh3c84ddf2008-01-09 02:15:38 +00003673 }else{
drh10d1edf2013-11-15 15:52:39 +00003674 tempX.op = TK_INTEGER;
3675 tempX.flags = EP_IntValue|EP_TokenOnly;
3676 tempX.u.iValue = 0;
3677 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003678 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003679 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003680 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003681 }
drh3c84ddf2008-01-09 02:15:38 +00003682 break;
drh6e142f52000-06-08 13:36:40 +00003683 }
drhbf4133c2001-10-13 02:59:08 +00003684 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003685 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003686 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3687 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003688 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3689 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003690 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003691 break;
3692 }
drh8abed7b2018-02-26 18:49:05 +00003693 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003694 int isTrue; /* IS TRUE or IS NOT TRUE */
3695 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003696 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3697 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003698 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3699 bNormal = pExpr->op2==TK_IS;
3700 testcase( isTrue && bNormal);
3701 testcase( !isTrue && bNormal);
3702 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003703 break;
3704 }
drhcce7d172000-05-31 15:34:51 +00003705 case TK_ISNULL:
3706 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003707 int addr;
drh7d176102014-02-18 03:07:12 +00003708 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3709 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003710 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003711 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003712 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003713 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003714 VdbeCoverageIf(v, op==TK_ISNULL);
3715 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003716 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003717 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003718 break;
drhcce7d172000-05-31 15:34:51 +00003719 }
drh22827922000-06-06 17:27:05 +00003720 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003721 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003722 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003723 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3724 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003725 }else{
drhc332cc32016-09-19 10:24:19 +00003726 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003727 }
drh22827922000-06-06 17:27:05 +00003728 break;
3729 }
drhcce7d172000-05-31 15:34:51 +00003730 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003731 ExprList *pFarg; /* List of function arguments */
3732 int nFarg; /* Number of function arguments */
3733 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003734 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003735 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003736 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003737 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003738 u8 enc = ENC(db); /* The text encoding used by this database */
3739 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003740
dan67a9b8e2018-06-22 20:51:35 +00003741#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003742 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3743 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003744 }
dan67a9b8e2018-06-22 20:51:35 +00003745#endif
dan86fb6e12018-05-16 20:58:07 +00003746
drh1e9b53f2017-01-04 01:07:24 +00003747 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003748 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003749 ** out of the inner loop, even if that means an extra OP_Copy. */
3750 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003751 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003752 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003753 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003754 pFarg = 0;
3755 }else{
3756 pFarg = pExpr->x.pList;
3757 }
3758 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003759 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3760 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003761 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003762#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3763 if( pDef==0 && pParse->explain ){
3764 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3765 }
3766#endif
danb6e9f7a2018-05-19 14:15:29 +00003767 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003768 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003769 break;
3770 }
drhae6bb952009-11-11 00:24:31 +00003771
3772 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003773 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003774 ** arguments past the first non-NULL argument.
3775 */
drhd36e1042013-09-06 13:10:12 +00003776 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003777 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003778 assert( nFarg>=2 );
3779 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3780 for(i=1; i<nFarg; i++){
3781 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003782 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003783 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003784 }
3785 sqlite3VdbeResolveLabel(v, endCoalesce);
3786 break;
3787 }
3788
drhcca9f3d2013-09-06 15:23:29 +00003789 /* The UNLIKELY() function is a no-op. The result is the value
3790 ** of the first argument.
3791 */
3792 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3793 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003794 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003795 }
drhae6bb952009-11-11 00:24:31 +00003796
drh54240752017-01-03 14:39:30 +00003797#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003798 /* The AFFINITY() function evaluates to a string that describes
3799 ** the type affinity of the argument. This is used for testing of
3800 ** the SQLite type logic.
3801 */
3802 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3803 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3804 char aff;
3805 assert( nFarg==1 );
3806 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3807 sqlite3VdbeLoadString(v, target,
3808 aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3809 return target;
3810 }
drh54240752017-01-03 14:39:30 +00003811#endif
drha1a523a2016-12-26 00:18:36 +00003812
drhd1a01ed2013-11-21 16:08:52 +00003813 for(i=0; i<nFarg; i++){
3814 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003815 testcase( i==31 );
3816 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003817 }
3818 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3819 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3820 }
3821 }
drh12ffee82009-04-08 13:51:51 +00003822 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003823 if( constMask ){
3824 r1 = pParse->nMem+1;
3825 pParse->nMem += nFarg;
3826 }else{
3827 r1 = sqlite3GetTempRange(pParse, nFarg);
3828 }
drha748fdc2012-03-28 01:34:47 +00003829
3830 /* For length() and typeof() functions with a column argument,
3831 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3832 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3833 ** loading.
3834 */
drhd36e1042013-09-06 13:10:12 +00003835 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003836 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003837 assert( nFarg==1 );
3838 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003839 exprOp = pFarg->a[0].pExpr->op;
3840 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003841 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3842 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003843 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3844 pFarg->a[0].pExpr->op2 =
3845 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003846 }
3847 }
3848
drh5579d592015-08-26 14:01:41 +00003849 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003850 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003851 }else{
drh12ffee82009-04-08 13:51:51 +00003852 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003853 }
drhb7f6f682006-07-08 17:06:43 +00003854#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003855 /* Possibly overload the function if the first argument is
3856 ** a virtual table column.
3857 **
3858 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3859 ** second argument, not the first, as the argument to test to
3860 ** see if it is a column in a virtual table. This is done because
3861 ** the left operand of infix functions (the operand we want to
3862 ** control overloading) ends up as the second argument to the
3863 ** function. The expression "A glob B" is equivalent to
3864 ** "glob(B,A). We want to use the A in "A glob B" to test
3865 ** for function overloading. But we use the B term in "glob(B,A)".
3866 */
drh59155062018-05-26 18:03:48 +00003867 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003868 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3869 }else if( nFarg>0 ){
3870 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003871 }
3872#endif
drhd36e1042013-09-06 13:10:12 +00003873 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003874 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003875 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003876 }
drh092457b2017-12-29 15:04:49 +00003877#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3878 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003879 Expr *pArg = pFarg->a[0].pExpr;
3880 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003881 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003882 }else{
3883 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3884 }
drh092457b2017-12-29 15:04:49 +00003885 }else
3886#endif
3887 {
drh2fc865c2017-12-16 20:20:37 +00003888 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3889 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3890 sqlite3VdbeChangeP5(v, (u8)nFarg);
3891 }
drhd1a01ed2013-11-21 16:08:52 +00003892 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003893 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003894 }
drhc332cc32016-09-19 10:24:19 +00003895 return target;
drhcce7d172000-05-31 15:34:51 +00003896 }
drhfe2093d2005-01-20 22:48:47 +00003897#ifndef SQLITE_OMIT_SUBQUERY
3898 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003899 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003900 int nCol;
drhc5499be2008-04-01 15:06:33 +00003901 testcase( op==TK_EXISTS );
3902 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003903 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3904 sqlite3SubselectError(pParse, nCol, 1);
3905 }else{
drh85bcdce2018-12-23 21:27:29 +00003906 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003907 }
drh19a775c2000-06-05 18:54:46 +00003908 break;
3909 }
drhfc7f27b2016-08-20 00:07:01 +00003910 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003911 int n;
drhfc7f27b2016-08-20 00:07:01 +00003912 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003913 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003914 }
drh966e2912017-01-03 02:58:01 +00003915 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3916 if( pExpr->iTable
3917 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3918 ){
3919 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3920 pExpr->iTable, n);
3921 }
drhc332cc32016-09-19 10:24:19 +00003922 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003923 }
drhfef52082000-06-06 01:50:43 +00003924 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003925 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3926 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003927 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3928 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3929 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3930 sqlite3VdbeResolveLabel(v, destIfFalse);
3931 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3932 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003933 return target;
drhfef52082000-06-06 01:50:43 +00003934 }
drhe3365e62009-11-12 17:52:24 +00003935#endif /* SQLITE_OMIT_SUBQUERY */
3936
3937
drh2dcef112008-01-12 19:03:48 +00003938 /*
3939 ** x BETWEEN y AND z
3940 **
3941 ** This is equivalent to
3942 **
3943 ** x>=y AND x<=z
3944 **
3945 ** X is stored in pExpr->pLeft.
3946 ** Y is stored in pExpr->pList->a[0].pExpr.
3947 ** Z is stored in pExpr->pList->a[1].pExpr.
3948 */
drhfef52082000-06-06 01:50:43 +00003949 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003950 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003951 return target;
drhfef52082000-06-06 01:50:43 +00003952 }
drh94fa9c42016-02-27 21:16:04 +00003953 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003954 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003955 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003956 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003957 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003958 }
drh2dcef112008-01-12 19:03:48 +00003959
dan165921a2009-08-28 18:53:45 +00003960 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003961 /* If the opcode is TK_TRIGGER, then the expression is a reference
3962 ** to a column in the new.* or old.* pseudo-tables available to
3963 ** trigger programs. In this case Expr.iTable is set to 1 for the
3964 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3965 ** is set to the column of the pseudo-table to read, or to -1 to
3966 ** read the rowid field.
3967 **
3968 ** The expression is implemented using an OP_Param opcode. The p1
3969 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3970 ** to reference another column of the old.* pseudo-table, where
3971 ** i is the index of the column. For a new.rowid reference, p1 is
3972 ** set to (n+1), where n is the number of columns in each pseudo-table.
3973 ** For a reference to any other column in the new.* pseudo-table, p1
3974 ** is set to (n+2+i), where n and i are as defined previously. For
3975 ** example, if the table on which triggers are being fired is
3976 ** declared as:
3977 **
3978 ** CREATE TABLE t1(a, b);
3979 **
3980 ** Then p1 is interpreted as follows:
3981 **
3982 ** p1==0 -> old.rowid p1==3 -> new.rowid
3983 ** p1==1 -> old.a p1==4 -> new.a
3984 ** p1==2 -> old.b p1==5 -> new.b
3985 */
drheda079c2018-09-20 19:02:15 +00003986 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003987 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3988
3989 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3990 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3991 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3992 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3993
3994 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003995 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003996 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003997 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003998 ));
dan65a7cd12009-09-01 12:16:01 +00003999
drh44dbca82010-01-13 04:22:20 +00004000#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004001 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004002 ** integer. Use OP_RealAffinity to make sure it is really real.
4003 **
4004 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4005 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004006 if( pExpr->iColumn>=0
4007 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4008 ){
4009 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4010 }
drh44dbca82010-01-13 04:22:20 +00004011#endif
dan165921a2009-08-28 18:53:45 +00004012 break;
4013 }
4014
dan71c57db2016-07-09 20:23:55 +00004015 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004016 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004017 break;
4018 }
4019
drh31d6fd52017-04-14 19:03:10 +00004020 case TK_IF_NULL_ROW: {
4021 int addrINR;
4022 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh31d6fd52017-04-14 19:03:10 +00004023 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh31d6fd52017-04-14 19:03:10 +00004024 sqlite3VdbeJumpHere(v, addrINR);
4025 sqlite3VdbeChangeP3(v, addrINR, inReg);
4026 break;
4027 }
4028
drh2dcef112008-01-12 19:03:48 +00004029 /*
4030 ** Form A:
4031 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4032 **
4033 ** Form B:
4034 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4035 **
4036 ** Form A is can be transformed into the equivalent form B as follows:
4037 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4038 ** WHEN x=eN THEN rN ELSE y END
4039 **
4040 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004041 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4042 ** odd. The Y is also optional. If the number of elements in x.pList
4043 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004044 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4045 **
4046 ** The result of the expression is the Ri for the first matching Ei,
4047 ** or if there is no matching Ei, the ELSE term Y, or if there is
4048 ** no ELSE term, NULL.
4049 */
drh33cd4902009-05-30 20:49:20 +00004050 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004051 int endLabel; /* GOTO label for end of CASE stmt */
4052 int nextCase; /* GOTO label for next WHEN clause */
4053 int nExpr; /* 2x number of WHEN terms */
4054 int i; /* Loop counter */
4055 ExprList *pEList; /* List of WHEN terms */
4056 struct ExprList_item *aListelem; /* Array of WHEN terms */
4057 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004058 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004059 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
drh17a7f8d2002-03-24 13:13:27 +00004060
danielk19776ab3a2e2009-02-19 14:39:25 +00004061 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004062 assert(pExpr->x.pList->nExpr > 0);
4063 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004064 aListelem = pEList->a;
4065 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004066 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004067 if( (pX = pExpr->pLeft)!=0 ){
drha8e05762019-01-05 21:56:12 +00004068 exprNodeCopy(&tempX, pX);
drh33cd4902009-05-30 20:49:20 +00004069 testcase( pX->op==TK_COLUMN );
drh12abf402016-08-22 14:30:05 +00004070 exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004071 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004072 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004073 opCompare.op = TK_EQ;
drh10d1edf2013-11-15 15:52:39 +00004074 opCompare.pLeft = &tempX;
drh2dcef112008-01-12 19:03:48 +00004075 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004076 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4077 ** The value in regFree1 might get SCopy-ed into the file result.
4078 ** So make sure that the regFree1 register is not reused for other
4079 ** purposes and possibly overwritten. */
4080 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004081 }
drhc5cd1242013-09-12 16:50:49 +00004082 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004083 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004084 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004085 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004086 }else{
drh2dcef112008-01-12 19:03:48 +00004087 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004088 }
drhec4ccdb2018-12-29 02:26:59 +00004089 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004090 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004091 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004092 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004093 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004094 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004095 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004096 }
drhc5cd1242013-09-12 16:50:49 +00004097 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004098 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004099 }else{
drh9de221d2008-01-05 06:51:30 +00004100 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004101 }
drh2dcef112008-01-12 19:03:48 +00004102 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004103 break;
4104 }
danielk19775338a5f2005-01-20 13:03:10 +00004105#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004106 case TK_RAISE: {
dan165921a2009-08-28 18:53:45 +00004107 assert( pExpr->affinity==OE_Rollback
4108 || pExpr->affinity==OE_Abort
4109 || pExpr->affinity==OE_Fail
4110 || pExpr->affinity==OE_Ignore
4111 );
dane0af83a2009-09-08 19:15:01 +00004112 if( !pParse->pTriggerTab ){
4113 sqlite3ErrorMsg(pParse,
4114 "RAISE() may only be used within a trigger-program");
4115 return 0;
4116 }
4117 if( pExpr->affinity==OE_Abort ){
4118 sqlite3MayAbort(pParse);
4119 }
dan165921a2009-08-28 18:53:45 +00004120 assert( !ExprHasProperty(pExpr, EP_IntValue) );
dane0af83a2009-09-08 19:15:01 +00004121 if( pExpr->affinity==OE_Ignore ){
4122 sqlite3VdbeAddOp4(
4123 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004124 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004125 }else{
drh433dccf2013-02-09 15:37:11 +00004126 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drhf9c8ce32013-11-05 13:33:55 +00004127 pExpr->affinity, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004128 }
4129
drhffe07b22005-11-03 00:41:17 +00004130 break;
drh17a7f8d2002-03-24 13:13:27 +00004131 }
danielk19775338a5f2005-01-20 13:03:10 +00004132#endif
drhffe07b22005-11-03 00:41:17 +00004133 }
drh2dcef112008-01-12 19:03:48 +00004134 sqlite3ReleaseTempReg(pParse, regFree1);
4135 sqlite3ReleaseTempReg(pParse, regFree2);
4136 return inReg;
4137}
4138
4139/*
drhd1a01ed2013-11-21 16:08:52 +00004140** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004141**
drhad879ff2017-01-04 04:10:02 +00004142** If regDest>=0 then the result is always stored in that register and the
4143** result is not reusable. If regDest<0 then this routine is free to
4144** store the value whereever it wants. The register where the expression
4145** is stored is returned. When regDest<0, two identical expressions will
4146** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004147*/
drh1e9b53f2017-01-04 01:07:24 +00004148int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004149 Parse *pParse, /* Parsing context */
4150 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004151 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004152){
drhd1a01ed2013-11-21 16:08:52 +00004153 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004154 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004155 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004156 if( regDest<0 && p ){
4157 struct ExprList_item *pItem;
4158 int i;
4159 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004160 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004161 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004162 }
4163 }
drh1e9b53f2017-01-04 01:07:24 +00004164 }
drhd1a01ed2013-11-21 16:08:52 +00004165 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4166 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004167 if( p ){
4168 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004169 pItem->reusable = regDest<0;
4170 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004171 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004172 }
drhd1a01ed2013-11-21 16:08:52 +00004173 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004174 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004175}
4176
4177/*
drh2dcef112008-01-12 19:03:48 +00004178** Generate code to evaluate an expression and store the results
4179** into a register. Return the register number where the results
4180** are stored.
4181**
4182** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004183** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004184** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004185**
4186** If pExpr is a constant, then this routine might generate this
4187** code to fill the register in the initialization section of the
4188** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004189*/
4190int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004191 int r2;
4192 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004193 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004194 && pExpr->op!=TK_REGISTER
4195 && sqlite3ExprIsConstantNotJoin(pExpr)
4196 ){
drhf30a9692013-11-15 01:10:18 +00004197 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004198 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004199 }else{
drhf30a9692013-11-15 01:10:18 +00004200 int r1 = sqlite3GetTempReg(pParse);
4201 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4202 if( r2==r1 ){
4203 *pReg = r1;
4204 }else{
4205 sqlite3ReleaseTempReg(pParse, r1);
4206 *pReg = 0;
4207 }
drh2dcef112008-01-12 19:03:48 +00004208 }
4209 return r2;
4210}
4211
4212/*
4213** Generate code that will evaluate expression pExpr and store the
4214** results in register target. The results are guaranteed to appear
4215** in register target.
4216*/
drh05a86c52014-02-16 01:55:49 +00004217void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004218 int inReg;
4219
4220 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004221 if( pExpr && pExpr->op==TK_REGISTER ){
4222 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4223 }else{
4224 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004225 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004226 if( inReg!=target && pParse->pVdbe ){
4227 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4228 }
drhcce7d172000-05-31 15:34:51 +00004229 }
drhcce7d172000-05-31 15:34:51 +00004230}
4231
4232/*
drh1c75c9d2015-12-21 15:22:13 +00004233** Make a transient copy of expression pExpr and then code it using
4234** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4235** except that the input expression is guaranteed to be unchanged.
4236*/
4237void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4238 sqlite3 *db = pParse->db;
4239 pExpr = sqlite3ExprDup(db, pExpr, 0);
4240 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4241 sqlite3ExprDelete(db, pExpr);
4242}
4243
4244/*
drh05a86c52014-02-16 01:55:49 +00004245** Generate code that will evaluate expression pExpr and store the
4246** results in register target. The results are guaranteed to appear
4247** in register target. If the expression is constant, then this routine
4248** might choose to code the expression at initialization time.
4249*/
4250void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004251 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004252 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004253 }else{
4254 sqlite3ExprCode(pParse, pExpr, target);
4255 }
drhcce7d172000-05-31 15:34:51 +00004256}
4257
4258/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004259** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004260** in register target.
drh25303782004-12-07 15:41:48 +00004261**
drh2dcef112008-01-12 19:03:48 +00004262** Also make a copy of the expression results into another "cache" register
4263** and modify the expression so that the next time it is evaluated,
4264** the result is a copy of the cache register.
4265**
4266** This routine is used for expressions that are used multiple
4267** times. They are evaluated once and the results of the expression
4268** are reused.
drh25303782004-12-07 15:41:48 +00004269*/
drh05a86c52014-02-16 01:55:49 +00004270void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004271 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004272 int iMem;
4273
drhde4fcfd2008-01-19 23:50:26 +00004274 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004275 assert( pExpr->op!=TK_REGISTER );
4276 sqlite3ExprCode(pParse, pExpr, target);
4277 iMem = ++pParse->nMem;
4278 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4279 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004280}
drh2dcef112008-01-12 19:03:48 +00004281
drh678ccce2008-03-31 18:19:54 +00004282/*
drh268380c2004-02-25 13:47:31 +00004283** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004284** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004285**
drh3df6c3b2017-09-15 15:38:01 +00004286** Return the number of elements evaluated. The number returned will
4287** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4288** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004289**
4290** The SQLITE_ECEL_DUP flag prevents the arguments from being
4291** filled using OP_SCopy. OP_Copy must be used instead.
4292**
4293** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4294** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004295**
4296** The SQLITE_ECEL_REF flag means that expressions in the list with
4297** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4298** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004299** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4300** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004301*/
danielk19774adee202004-05-08 08:23:19 +00004302int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004303 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004304 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004305 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004306 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004307 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004308){
4309 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004310 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004311 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004312 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004313 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004314 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004315 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004316 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004317 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004318 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004319 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004320#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4321 if( pItem->bSorterRef ){
4322 i--;
4323 n--;
4324 }else
4325#endif
dan257c13f2016-11-10 20:14:06 +00004326 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4327 if( flags & SQLITE_ECEL_OMITREF ){
4328 i--;
4329 n--;
4330 }else{
4331 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4332 }
drhb8b06692018-08-04 15:16:20 +00004333 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4334 && sqlite3ExprIsConstantNotJoin(pExpr)
4335 ){
drhad879ff2017-01-04 04:10:02 +00004336 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004337 }else{
4338 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4339 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004340 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004341 if( copyOp==OP_Copy
4342 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4343 && pOp->p1+pOp->p3+1==inReg
4344 && pOp->p2+pOp->p3+1==target+i
4345 ){
4346 pOp->p3++;
4347 }else{
4348 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4349 }
drhd1a01ed2013-11-21 16:08:52 +00004350 }
drhd1766112008-09-17 00:13:12 +00004351 }
drh268380c2004-02-25 13:47:31 +00004352 }
drhf9b596e2004-05-26 16:54:42 +00004353 return n;
drh268380c2004-02-25 13:47:31 +00004354}
4355
4356/*
drh36c563a2009-11-12 13:32:22 +00004357** Generate code for a BETWEEN operator.
4358**
4359** x BETWEEN y AND z
4360**
4361** The above is equivalent to
4362**
4363** x>=y AND x<=z
4364**
4365** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004366** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004367**
4368** The xJumpIf parameter determines details:
4369**
4370** NULL: Store the boolean result in reg[dest]
4371** sqlite3ExprIfTrue: Jump to dest if true
4372** sqlite3ExprIfFalse: Jump to dest if false
4373**
4374** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004375*/
4376static void exprCodeBetween(
4377 Parse *pParse, /* Parsing and code generating context */
4378 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004379 int dest, /* Jump destination or storage location */
4380 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004381 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4382){
drhdb45bd52016-08-22 00:48:58 +00004383 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004384 Expr compLeft; /* The x>=y term */
4385 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004386 Expr exprX; /* The x subexpression */
4387 int regFree1 = 0; /* Temporary use register */
drh84b19a32016-08-20 22:49:28 +00004388
dan71c57db2016-07-09 20:23:55 +00004389 memset(&compLeft, 0, sizeof(Expr));
4390 memset(&compRight, 0, sizeof(Expr));
4391 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004392
4393 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drha8e05762019-01-05 21:56:12 +00004394 exprNodeCopy(&exprX, pExpr->pLeft);
drh36c563a2009-11-12 13:32:22 +00004395 exprAnd.op = TK_AND;
4396 exprAnd.pLeft = &compLeft;
4397 exprAnd.pRight = &compRight;
4398 compLeft.op = TK_GE;
drhdb45bd52016-08-22 00:48:58 +00004399 compLeft.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004400 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4401 compRight.op = TK_LE;
drhdb45bd52016-08-22 00:48:58 +00004402 compRight.pLeft = &exprX;
drh36c563a2009-11-12 13:32:22 +00004403 compRight.pRight = pExpr->x.pList->a[1].pExpr;
drh12abf402016-08-22 14:30:05 +00004404 exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
drh84b19a32016-08-20 22:49:28 +00004405 if( xJump ){
4406 xJump(pParse, &exprAnd, dest, jumpIfNull);
drh36c563a2009-11-12 13:32:22 +00004407 }else{
drh36fd41e2016-11-25 14:30:42 +00004408 /* Mark the expression is being from the ON or USING clause of a join
4409 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4410 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4411 ** for clarity, but we are out of bits in the Expr.flags field so we
4412 ** have to reuse the EP_FromJoin bit. Bummer. */
drhdb45bd52016-08-22 00:48:58 +00004413 exprX.flags |= EP_FromJoin;
dan71c57db2016-07-09 20:23:55 +00004414 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
drh36c563a2009-11-12 13:32:22 +00004415 }
drhdb45bd52016-08-22 00:48:58 +00004416 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004417
4418 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004419 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4420 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4421 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4422 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4423 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4424 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4425 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4426 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004427 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004428}
4429
4430/*
drhcce7d172000-05-31 15:34:51 +00004431** Generate code for a boolean expression such that a jump is made
4432** to the label "dest" if the expression is true but execution
4433** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004434**
4435** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004436** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004437**
4438** This code depends on the fact that certain token values (ex: TK_EQ)
4439** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4440** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4441** the make process cause these values to align. Assert()s in the code
4442** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004443*/
danielk19774adee202004-05-08 08:23:19 +00004444void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004445 Vdbe *v = pParse->pVdbe;
4446 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004447 int regFree1 = 0;
4448 int regFree2 = 0;
4449 int r1, r2;
4450
drh35573352008-01-08 23:54:25 +00004451 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004452 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004453 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004454 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004455 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004456 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004457 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004458 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4459 if( pAlt!=pExpr ){
4460 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4461 }else if( op==TK_AND ){
4462 int d2 = sqlite3VdbeMakeLabel(pParse);
4463 testcase( jumpIfNull==0 );
4464 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4465 jumpIfNull^SQLITE_JUMPIFNULL);
4466 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4467 sqlite3VdbeResolveLabel(v, d2);
4468 }else{
4469 testcase( jumpIfNull==0 );
4470 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4471 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4472 }
drhcce7d172000-05-31 15:34:51 +00004473 break;
4474 }
4475 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004476 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004477 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004478 break;
4479 }
drh8abed7b2018-02-26 18:49:05 +00004480 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004481 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4482 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004483 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004484 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004485 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004486 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004487 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004488 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004489 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4490 isNot ? SQLITE_JUMPIFNULL : 0);
4491 }else{
4492 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4493 isNot ? SQLITE_JUMPIFNULL : 0);
4494 }
drh007c8432018-02-26 03:20:18 +00004495 break;
4496 }
drhde845c22016-03-17 19:07:52 +00004497 case TK_IS:
4498 case TK_ISNOT:
4499 testcase( op==TK_IS );
4500 testcase( op==TK_ISNOT );
4501 op = (op==TK_IS) ? TK_EQ : TK_NE;
4502 jumpIfNull = SQLITE_NULLEQ;
4503 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004504 case TK_LT:
4505 case TK_LE:
4506 case TK_GT:
4507 case TK_GE:
4508 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004509 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004510 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004511 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004512 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4513 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004514 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004515 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004516 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4517 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4518 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4519 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004520 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4521 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4522 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4523 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4524 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4525 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004526 testcase( regFree1==0 );
4527 testcase( regFree2==0 );
4528 break;
4529 }
drhcce7d172000-05-31 15:34:51 +00004530 case TK_ISNULL:
4531 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004532 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4533 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004534 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4535 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004536 VdbeCoverageIf(v, op==TK_ISNULL);
4537 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004538 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004539 break;
4540 }
drhfef52082000-06-06 01:50:43 +00004541 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004542 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004543 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004544 break;
4545 }
drh84e30ca2011-02-10 17:46:14 +00004546#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004547 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004548 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004549 int destIfNull = jumpIfNull ? dest : destIfFalse;
4550 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004551 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004552 sqlite3VdbeResolveLabel(v, destIfFalse);
4553 break;
4554 }
shanehbb201342011-02-09 19:55:20 +00004555#endif
drhcce7d172000-05-31 15:34:51 +00004556 default: {
dan7b35a772016-07-28 19:47:15 +00004557 default_expr:
drhad317272019-04-19 16:21:51 +00004558 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004559 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004560 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004561 /* No-op */
4562 }else{
4563 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4564 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004565 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004566 testcase( regFree1==0 );
4567 testcase( jumpIfNull==0 );
4568 }
drhcce7d172000-05-31 15:34:51 +00004569 break;
4570 }
4571 }
drh2dcef112008-01-12 19:03:48 +00004572 sqlite3ReleaseTempReg(pParse, regFree1);
4573 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004574}
4575
4576/*
drh66b89c82000-11-28 20:47:17 +00004577** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004578** to the label "dest" if the expression is false but execution
4579** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004580**
4581** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004582** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4583** is 0.
drhcce7d172000-05-31 15:34:51 +00004584*/
danielk19774adee202004-05-08 08:23:19 +00004585void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004586 Vdbe *v = pParse->pVdbe;
4587 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004588 int regFree1 = 0;
4589 int regFree2 = 0;
4590 int r1, r2;
4591
drh35573352008-01-08 23:54:25 +00004592 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004593 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004594 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004595
4596 /* The value of pExpr->op and op are related as follows:
4597 **
4598 ** pExpr->op op
4599 ** --------- ----------
4600 ** TK_ISNULL OP_NotNull
4601 ** TK_NOTNULL OP_IsNull
4602 ** TK_NE OP_Eq
4603 ** TK_EQ OP_Ne
4604 ** TK_GT OP_Le
4605 ** TK_LE OP_Gt
4606 ** TK_GE OP_Lt
4607 ** TK_LT OP_Ge
4608 **
4609 ** For other values of pExpr->op, op is undefined and unused.
4610 ** The value of TK_ and OP_ constants are arranged such that we
4611 ** can compute the mapping above using the following expression.
4612 ** Assert()s verify that the computation is correct.
4613 */
4614 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4615
4616 /* Verify correct alignment of TK_ and OP_ constants
4617 */
4618 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4619 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4620 assert( pExpr->op!=TK_NE || op==OP_Eq );
4621 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4622 assert( pExpr->op!=TK_LT || op==OP_Ge );
4623 assert( pExpr->op!=TK_LE || op==OP_Gt );
4624 assert( pExpr->op!=TK_GT || op==OP_Le );
4625 assert( pExpr->op!=TK_GE || op==OP_Lt );
4626
danba00e302016-07-23 20:24:06 +00004627 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004628 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004629 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004630 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4631 if( pAlt!=pExpr ){
4632 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4633 }else if( pExpr->op==TK_AND ){
4634 testcase( jumpIfNull==0 );
4635 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4636 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4637 }else{
4638 int d2 = sqlite3VdbeMakeLabel(pParse);
4639 testcase( jumpIfNull==0 );
4640 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4641 jumpIfNull^SQLITE_JUMPIFNULL);
4642 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4643 sqlite3VdbeResolveLabel(v, d2);
4644 }
drhcce7d172000-05-31 15:34:51 +00004645 break;
4646 }
4647 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004648 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004649 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004650 break;
4651 }
drh8abed7b2018-02-26 18:49:05 +00004652 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004653 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4654 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004655 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004656 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004657 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004658 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004659 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004660 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004661 /* IS TRUE and IS NOT FALSE */
4662 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4663 isNot ? 0 : SQLITE_JUMPIFNULL);
4664
4665 }else{
4666 /* IS FALSE and IS NOT TRUE */
4667 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004668 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004669 }
drh007c8432018-02-26 03:20:18 +00004670 break;
4671 }
drhde845c22016-03-17 19:07:52 +00004672 case TK_IS:
4673 case TK_ISNOT:
4674 testcase( pExpr->op==TK_IS );
4675 testcase( pExpr->op==TK_ISNOT );
4676 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4677 jumpIfNull = SQLITE_NULLEQ;
4678 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004679 case TK_LT:
4680 case TK_LE:
4681 case TK_GT:
4682 case TK_GE:
4683 case TK_NE:
4684 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004685 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004686 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004687 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4688 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004689 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004690 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004691 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4692 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4693 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4694 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004695 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4696 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4697 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4698 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4699 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4700 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004701 testcase( regFree1==0 );
4702 testcase( regFree2==0 );
4703 break;
4704 }
drhcce7d172000-05-31 15:34:51 +00004705 case TK_ISNULL:
4706 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004707 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4708 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004709 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4710 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004711 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004712 break;
4713 }
drhfef52082000-06-06 01:50:43 +00004714 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004715 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004716 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004717 break;
4718 }
drh84e30ca2011-02-10 17:46:14 +00004719#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004720 case TK_IN: {
4721 if( jumpIfNull ){
4722 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4723 }else{
drhec4ccdb2018-12-29 02:26:59 +00004724 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004725 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4726 sqlite3VdbeResolveLabel(v, destIfNull);
4727 }
4728 break;
4729 }
shanehbb201342011-02-09 19:55:20 +00004730#endif
drhcce7d172000-05-31 15:34:51 +00004731 default: {
danba00e302016-07-23 20:24:06 +00004732 default_expr:
drhad317272019-04-19 16:21:51 +00004733 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004734 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004735 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004736 /* no-op */
4737 }else{
4738 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4739 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004740 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004741 testcase( regFree1==0 );
4742 testcase( jumpIfNull==0 );
4743 }
drhcce7d172000-05-31 15:34:51 +00004744 break;
4745 }
4746 }
drh2dcef112008-01-12 19:03:48 +00004747 sqlite3ReleaseTempReg(pParse, regFree1);
4748 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004749}
drh22827922000-06-06 17:27:05 +00004750
4751/*
drh72bc8202015-06-11 13:58:35 +00004752** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4753** code generation, and that copy is deleted after code generation. This
4754** ensures that the original pExpr is unchanged.
4755*/
4756void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4757 sqlite3 *db = pParse->db;
4758 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4759 if( db->mallocFailed==0 ){
4760 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4761 }
4762 sqlite3ExprDelete(db, pCopy);
4763}
4764
dan5aa550c2017-06-24 18:10:29 +00004765/*
4766** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4767** type of expression.
4768**
4769** If pExpr is a simple SQL value - an integer, real, string, blob
4770** or NULL value - then the VDBE currently being prepared is configured
4771** to re-prepare each time a new value is bound to variable pVar.
4772**
4773** Additionally, if pExpr is a simple SQL value and the value is the
4774** same as that currently bound to variable pVar, non-zero is returned.
4775** Otherwise, if the values are not the same or if pExpr is not a simple
4776** SQL value, zero is returned.
4777*/
4778static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4779 int res = 0;
drhc0804222017-06-28 21:47:16 +00004780 int iVar;
4781 sqlite3_value *pL, *pR = 0;
4782
4783 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4784 if( pR ){
4785 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004786 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004787 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004788 if( pL ){
4789 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4790 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4791 }
4792 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004793 }
drhc0804222017-06-28 21:47:16 +00004794 sqlite3ValueFree(pR);
4795 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004796 }
4797
4798 return res;
4799}
drh72bc8202015-06-11 13:58:35 +00004800
4801/*
drh1d9da702010-01-07 15:17:02 +00004802** Do a deep comparison of two expression trees. Return 0 if the two
4803** expressions are completely identical. Return 1 if they differ only
4804** by a COLLATE operator at the top level. Return 2 if there are differences
4805** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004806**
drh619a1302013-08-01 13:04:46 +00004807** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4808** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4809**
drh66518ca2013-08-01 15:09:57 +00004810** The pA side might be using TK_REGISTER. If that is the case and pB is
4811** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4812**
drh1d9da702010-01-07 15:17:02 +00004813** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004814** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004815** identical, we return 2 just to be safe. So if this routine
4816** returns 2, then you do not really know for certain if the two
4817** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004818** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004819** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004820** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004821** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004822**
drhc0804222017-06-28 21:47:16 +00004823** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4824** pParse->pReprepare can be matched against literals in pB. The
4825** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4826** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4827** Argument pParse should normally be NULL. If it is not NULL and pA or
4828** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004829*/
dan5aa550c2017-06-24 18:10:29 +00004830int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004831 u32 combinedFlags;
4832 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004833 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004834 }
dan5aa550c2017-06-24 18:10:29 +00004835 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4836 return 0;
4837 }
drh10d1edf2013-11-15 15:52:39 +00004838 combinedFlags = pA->flags | pB->flags;
4839 if( combinedFlags & EP_IntValue ){
4840 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4841 return 0;
4842 }
drh1d9da702010-01-07 15:17:02 +00004843 return 2;
drh22827922000-06-06 17:27:05 +00004844 }
dan16dd3982018-12-20 15:04:38 +00004845 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004846 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004847 return 1;
4848 }
dan5aa550c2017-06-24 18:10:29 +00004849 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004850 return 1;
4851 }
4852 return 2;
4853 }
drh2edc5fd2015-11-24 02:10:52 +00004854 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
drh390b88a2015-08-31 18:13:01 +00004855 if( pA->op==TK_FUNCTION ){
4856 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004857#ifndef SQLITE_OMIT_WINDOWFUNC
4858 /* Justification for the assert():
4859 ** window functions have p->op==TK_FUNCTION but aggregate functions
4860 ** have p->op==TK_AGG_FUNCTION. So any comparison between an aggregate
4861 ** function and a window function should have failed before reaching
4862 ** this point. And, it is not possible to have a window function and
4863 ** a scalar function with the same name and number of arguments. So
4864 ** if we reach this point, either A and B both window functions or
4865 ** neither are a window functions. */
4866 assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4867 if( ExprHasProperty(pA,EP_WinFunc) ){
4868 if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4869 }
4870#endif
drhf20bbc52019-01-17 01:06:00 +00004871 }else if( pA->op==TK_NULL ){
4872 return 0;
drhd5af5422018-04-13 14:27:01 +00004873 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004874 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004875 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004876 return 2;
drh2646da72005-12-09 20:02:05 +00004877 }
dan6ba7ab02019-07-02 11:56:47 +00004878#ifndef SQLITE_OMIT_WINDOWFUNC
4879 else if( pA->op==TK_AGG_FUNCTION ){
4880 assert( ExprHasProperty(pA, EP_WinFunc)==0 );
4881 if( sqlite3ExprCompare(pParse, pA->y.pFilter, pB->y.pFilter, iTab) ){
4882 return 2;
4883 }
4884 }
4885#endif
drh22827922000-06-06 17:27:05 +00004886 }
drh10d1edf2013-11-15 15:52:39 +00004887 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004888 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004889 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004890 if( (combinedFlags & EP_FixedCol)==0
4891 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004892 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004893 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004894 if( pA->op!=TK_STRING
4895 && pA->op!=TK_TRUEFALSE
4896 && (combinedFlags & EP_Reduced)==0
4897 ){
drh10d1edf2013-11-15 15:52:39 +00004898 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00004899 if( pA->op2!=pB->op2 ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004900 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004901 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004902 }
4903 }
drh1d9da702010-01-07 15:17:02 +00004904 return 0;
drh22827922000-06-06 17:27:05 +00004905}
4906
drh8c6f6662010-04-26 19:17:26 +00004907/*
4908** Compare two ExprList objects. Return 0 if they are identical and
4909** non-zero if they differ in any way.
4910**
drh619a1302013-08-01 13:04:46 +00004911** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4912** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4913**
drh8c6f6662010-04-26 19:17:26 +00004914** This routine might return non-zero for equivalent ExprLists. The
4915** only consequence will be disabled optimizations. But this routine
4916** must never return 0 if the two ExprList objects are different, or
4917** a malfunction will result.
4918**
4919** Two NULL pointers are considered to be the same. But a NULL pointer
4920** always differs from a non-NULL pointer.
4921*/
drh619a1302013-08-01 13:04:46 +00004922int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004923 int i;
4924 if( pA==0 && pB==0 ) return 0;
4925 if( pA==0 || pB==0 ) return 1;
4926 if( pA->nExpr!=pB->nExpr ) return 1;
4927 for(i=0; i<pA->nExpr; i++){
4928 Expr *pExprA = pA->a[i].pExpr;
4929 Expr *pExprB = pB->a[i].pExpr;
4930 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004931 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004932 }
4933 return 0;
4934}
drh13449892005-09-07 21:22:45 +00004935
drh22827922000-06-06 17:27:05 +00004936/*
drhf9463df2017-02-11 14:59:58 +00004937** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4938** are ignored.
4939*/
4940int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004941 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004942 sqlite3ExprSkipCollate(pA),
4943 sqlite3ExprSkipCollate(pB),
4944 iTab);
4945}
4946
4947/*
drhc51cf862019-05-11 19:36:03 +00004948** Return non-zero if Expr p can only be true if pNN is not NULL.
4949*/
4950static int exprImpliesNotNull(
4951 Parse *pParse, /* Parsing context */
4952 Expr *p, /* The expression to be checked */
4953 Expr *pNN, /* The expression that is NOT NULL */
4954 int iTab, /* Table being evaluated */
4955 int seenNot /* True if p is an operand of NOT */
4956){
4957 assert( p );
4958 assert( pNN );
4959 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ) return 1;
4960 switch( p->op ){
4961 case TK_IN: {
4962 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4963 assert( ExprHasProperty(p,EP_xIsSelect)
4964 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4965 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4966 }
4967 case TK_BETWEEN: {
4968 ExprList *pList = p->x.pList;
4969 assert( pList!=0 );
4970 assert( pList->nExpr==2 );
4971 if( seenNot ) return 0;
4972 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4973 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4974 ){
4975 return 1;
4976 }
4977 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4978 }
4979 case TK_EQ:
4980 case TK_NE:
4981 case TK_LT:
4982 case TK_LE:
4983 case TK_GT:
4984 case TK_GE:
4985 case TK_PLUS:
4986 case TK_MINUS:
4987 case TK_STAR:
4988 case TK_REM:
4989 case TK_BITAND:
4990 case TK_BITOR:
4991 case TK_SLASH:
4992 case TK_LSHIFT:
4993 case TK_RSHIFT:
4994 case TK_CONCAT: {
4995 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
4996 /* Fall thru into the next case */
4997 }
4998 case TK_SPAN:
4999 case TK_COLLATE:
5000 case TK_BITNOT:
5001 case TK_UPLUS:
5002 case TK_UMINUS: {
5003 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5004 }
5005 case TK_TRUTH: {
5006 if( seenNot ) return 0;
5007 if( p->op2!=TK_IS ) return 0;
5008 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5009 }
5010 case TK_NOT: {
5011 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5012 }
5013 }
5014 return 0;
5015}
5016
5017/*
drh4bd5f732013-07-31 23:22:39 +00005018** Return true if we can prove the pE2 will always be true if pE1 is
5019** true. Return false if we cannot complete the proof or if pE2 might
5020** be false. Examples:
5021**
drh619a1302013-08-01 13:04:46 +00005022** pE1: x==5 pE2: x==5 Result: true
5023** pE1: x>0 pE2: x==5 Result: false
5024** pE1: x=21 pE2: x=21 OR y=43 Result: true
5025** pE1: x!=123 pE2: x IS NOT NULL Result: true
5026** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5027** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5028** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005029**
5030** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5031** Expr.iTable<0 then assume a table number given by iTab.
5032**
drhc0804222017-06-28 21:47:16 +00005033** If pParse is not NULL, then the values of bound variables in pE1 are
5034** compared against literal values in pE2 and pParse->pVdbe->expmask is
5035** modified to record which bound variables are referenced. If pParse
5036** is NULL, then false will be returned if pE1 contains any bound variables.
5037**
drh4bd5f732013-07-31 23:22:39 +00005038** When in doubt, return false. Returning true might give a performance
5039** improvement. Returning false might cause a performance reduction, but
5040** it will always give the correct answer and is hence always safe.
5041*/
dan5aa550c2017-06-24 18:10:29 +00005042int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5043 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005044 return 1;
5045 }
5046 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005047 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5048 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005049 ){
5050 return 1;
5051 }
drh664d6d12019-05-04 17:32:07 +00005052 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005053 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005054 ){
drhc51cf862019-05-11 19:36:03 +00005055 return 1;
drh619a1302013-08-01 13:04:46 +00005056 }
5057 return 0;
drh4bd5f732013-07-31 23:22:39 +00005058}
5059
5060/*
drh25897872018-03-20 21:16:15 +00005061** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5062** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005063** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5064**
5065** This routine controls an optimization. False positives (setting
5066** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5067** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005068*/
5069static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005070 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005071 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005072 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5073 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005074 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00005075 case TK_NOT:
drh25897872018-03-20 21:16:15 +00005076 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005077 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005078 case TK_IS:
5079 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005080 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005081 case TK_IN:
drh25897872018-03-20 21:16:15 +00005082 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00005083 testcase( pExpr->op==TK_ISNOT );
5084 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00005085 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005086 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005087 testcase( pExpr->op==TK_IS );
5088 testcase( pExpr->op==TK_OR );
5089 testcase( pExpr->op==TK_CASE );
5090 testcase( pExpr->op==TK_IN );
5091 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005092 return WRC_Prune;
5093 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005094 if( pWalker->u.iCur==pExpr->iTable ){
5095 pWalker->eCode = 1;
5096 return WRC_Abort;
5097 }
5098 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005099
5100 /* Virtual tables are allowed to use constraints like x=NULL. So
5101 ** a term of the form x=y does not prove that y is not null if x
5102 ** is the column of a virtual table */
5103 case TK_EQ:
5104 case TK_NE:
5105 case TK_LT:
5106 case TK_LE:
5107 case TK_GT:
5108 case TK_GE:
5109 testcase( pExpr->op==TK_EQ );
5110 testcase( pExpr->op==TK_NE );
5111 testcase( pExpr->op==TK_LT );
5112 testcase( pExpr->op==TK_LE );
5113 testcase( pExpr->op==TK_GT );
5114 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005115 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5116 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005117 ){
5118 return WRC_Prune;
5119 }
drh25897872018-03-20 21:16:15 +00005120 default:
5121 return WRC_Continue;
5122 }
5123}
5124
5125/*
5126** Return true (non-zero) if expression p can only be true if at least
5127** one column of table iTab is non-null. In other words, return true
5128** if expression p will always be NULL or false if every column of iTab
5129** is NULL.
5130**
drh821b6102018-03-24 18:01:51 +00005131** False negatives are acceptable. In other words, it is ok to return
5132** zero even if expression p will never be true of every column of iTab
5133** is NULL. A false negative is merely a missed optimization opportunity.
5134**
5135** False positives are not allowed, however. A false positive may result
5136** in an incorrect answer.
5137**
drh25897872018-03-20 21:16:15 +00005138** Terms of p that are marked with EP_FromJoin (and hence that come from
5139** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5140**
5141** This routine is used to check if a LEFT JOIN can be converted into
5142** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5143** clause requires that some column of the right table of the LEFT JOIN
5144** be non-NULL, then the LEFT JOIN can be safely converted into an
5145** ordinary join.
5146*/
5147int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5148 Walker w;
drhd6db6592019-04-01 19:42:42 +00005149 p = sqlite3ExprSkipCollate(p);
5150 while( p ){
5151 if( p->op==TK_NOTNULL ){
5152 p = p->pLeft;
5153 }else if( p->op==TK_AND ){
5154 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5155 p = p->pRight;
5156 }else{
5157 break;
5158 }
5159 }
drh25897872018-03-20 21:16:15 +00005160 w.xExprCallback = impliesNotNullRow;
5161 w.xSelectCallback = 0;
5162 w.xSelectCallback2 = 0;
5163 w.eCode = 0;
5164 w.u.iCur = iTab;
5165 sqlite3WalkExpr(&w, p);
5166 return w.eCode;
5167}
5168
5169/*
drh030796d2012-08-23 16:18:10 +00005170** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005171** to determine if an expression can be evaluated by reference to the
5172** index only, without having to do a search for the corresponding
5173** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5174** is the cursor for the table.
5175*/
5176struct IdxCover {
5177 Index *pIdx; /* The index to be tested for coverage */
5178 int iCur; /* Cursor number for the table corresponding to the index */
5179};
5180
5181/*
5182** Check to see if there are references to columns in table
5183** pWalker->u.pIdxCover->iCur can be satisfied using the index
5184** pWalker->u.pIdxCover->pIdx.
5185*/
5186static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5187 if( pExpr->op==TK_COLUMN
5188 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5189 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5190 ){
5191 pWalker->eCode = 1;
5192 return WRC_Abort;
5193 }
5194 return WRC_Continue;
5195}
5196
5197/*
drhe604ec02016-07-27 19:20:58 +00005198** Determine if an index pIdx on table with cursor iCur contains will
5199** the expression pExpr. Return true if the index does cover the
5200** expression and false if the pExpr expression references table columns
5201** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005202**
5203** An index covering an expression means that the expression can be
5204** evaluated using only the index and without having to lookup the
5205** corresponding table entry.
5206*/
5207int sqlite3ExprCoveredByIndex(
5208 Expr *pExpr, /* The index to be tested */
5209 int iCur, /* The cursor number for the corresponding table */
5210 Index *pIdx /* The index that might be used for coverage */
5211){
5212 Walker w;
5213 struct IdxCover xcov;
5214 memset(&w, 0, sizeof(w));
5215 xcov.iCur = iCur;
5216 xcov.pIdx = pIdx;
5217 w.xExprCallback = exprIdxCover;
5218 w.u.pIdxCover = &xcov;
5219 sqlite3WalkExpr(&w, pExpr);
5220 return !w.eCode;
5221}
5222
5223
5224/*
5225** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005226** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005227** aggregate function, in order to implement the
5228** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005229*/
drh030796d2012-08-23 16:18:10 +00005230struct SrcCount {
5231 SrcList *pSrc; /* One particular FROM clause in a nested query */
5232 int nThis; /* Number of references to columns in pSrcList */
5233 int nOther; /* Number of references to columns in other FROM clauses */
5234};
5235
5236/*
5237** Count the number of references to columns.
5238*/
5239static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005240 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5241 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5242 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5243 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5244 ** NEVER() will need to be removed. */
5245 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005246 int i;
drh030796d2012-08-23 16:18:10 +00005247 struct SrcCount *p = pWalker->u.pSrcCount;
5248 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005249 int nSrc = pSrc ? pSrc->nSrc : 0;
5250 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005251 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005252 }
drh655814d2015-01-09 01:27:29 +00005253 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005254 p->nThis++;
5255 }else{
5256 p->nOther++;
5257 }
drh374fdce2012-04-17 16:38:53 +00005258 }
drh030796d2012-08-23 16:18:10 +00005259 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005260}
5261
5262/*
drh030796d2012-08-23 16:18:10 +00005263** Determine if any of the arguments to the pExpr Function reference
5264** pSrcList. Return true if they do. Also return true if the function
5265** has no arguments or has only constant arguments. Return false if pExpr
5266** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005267*/
drh030796d2012-08-23 16:18:10 +00005268int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005269 Walker w;
drh030796d2012-08-23 16:18:10 +00005270 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005271 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005272 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005273 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005274 w.u.pSrcCount = &cnt;
5275 cnt.pSrc = pSrcList;
5276 cnt.nThis = 0;
5277 cnt.nOther = 0;
5278 sqlite3WalkExprList(&w, pExpr->x.pList);
5279 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005280}
5281
5282/*
drh13449892005-09-07 21:22:45 +00005283** Add a new element to the pAggInfo->aCol[] array. Return the index of
5284** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005285*/
drh17435752007-08-16 04:30:38 +00005286static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005287 int i;
drhcf643722007-03-27 13:36:37 +00005288 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005289 db,
drhcf643722007-03-27 13:36:37 +00005290 pInfo->aCol,
5291 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005292 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005293 &i
5294 );
drh13449892005-09-07 21:22:45 +00005295 return i;
5296}
5297
5298/*
5299** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5300** the new element. Return a negative number if malloc fails.
5301*/
drh17435752007-08-16 04:30:38 +00005302static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005303 int i;
drhcf643722007-03-27 13:36:37 +00005304 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005305 db,
drhcf643722007-03-27 13:36:37 +00005306 pInfo->aFunc,
5307 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005308 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005309 &i
5310 );
drh13449892005-09-07 21:22:45 +00005311 return i;
5312}
drh22827922000-06-06 17:27:05 +00005313
5314/*
drh7d10d5a2008-08-20 16:35:10 +00005315** This is the xExprCallback for a tree walker. It is used to
5316** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005317** for additional information.
drh22827922000-06-06 17:27:05 +00005318*/
drh7d10d5a2008-08-20 16:35:10 +00005319static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005320 int i;
drh7d10d5a2008-08-20 16:35:10 +00005321 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005322 Parse *pParse = pNC->pParse;
5323 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005324 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005325
drh25c3b8c2018-04-16 10:34:13 +00005326 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005327 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005328 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005329 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005330 testcase( pExpr->op==TK_AGG_COLUMN );
5331 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005332 /* Check to see if the column is in one of the tables in the FROM
5333 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005334 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005335 struct SrcList_item *pItem = pSrcList->a;
5336 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5337 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005338 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005339 if( pExpr->iTable==pItem->iCursor ){
5340 /* If we reach this point, it means that pExpr refers to a table
5341 ** that is in the FROM clause of the aggregate query.
5342 **
5343 ** Make an entry for the column in pAggInfo->aCol[] if there
5344 ** is not an entry there already.
5345 */
drh7f906d62007-03-12 23:48:52 +00005346 int k;
drh13449892005-09-07 21:22:45 +00005347 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005348 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005349 if( pCol->iTable==pExpr->iTable &&
5350 pCol->iColumn==pExpr->iColumn ){
5351 break;
5352 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005353 }
danielk19771e536952007-08-16 10:09:01 +00005354 if( (k>=pAggInfo->nColumn)
5355 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5356 ){
drh7f906d62007-03-12 23:48:52 +00005357 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005358 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005359 pCol->iTable = pExpr->iTable;
5360 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005361 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005362 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005363 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005364 if( pAggInfo->pGroupBy ){
5365 int j, n;
5366 ExprList *pGB = pAggInfo->pGroupBy;
5367 struct ExprList_item *pTerm = pGB->a;
5368 n = pGB->nExpr;
5369 for(j=0; j<n; j++, pTerm++){
5370 Expr *pE = pTerm->pExpr;
5371 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5372 pE->iColumn==pExpr->iColumn ){
5373 pCol->iSorterColumn = j;
5374 break;
5375 }
5376 }
5377 }
5378 if( pCol->iSorterColumn<0 ){
5379 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5380 }
5381 }
5382 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5383 ** because it was there before or because we just created it).
5384 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5385 ** pAggInfo->aCol[] entry.
5386 */
drhebb6a652013-09-12 23:42:22 +00005387 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005388 pExpr->pAggInfo = pAggInfo;
5389 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005390 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005391 break;
5392 } /* endif pExpr->iTable==pItem->iCursor */
5393 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005394 }
drh7d10d5a2008-08-20 16:35:10 +00005395 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005396 }
5397 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005398 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005399 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005400 ){
drh13449892005-09-07 21:22:45 +00005401 /* Check to see if pExpr is a duplicate of another aggregate
5402 ** function that is already in the pAggInfo structure
5403 */
5404 struct AggInfo_func *pItem = pAggInfo->aFunc;
5405 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005406 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005407 break;
5408 }
drh22827922000-06-06 17:27:05 +00005409 }
drh13449892005-09-07 21:22:45 +00005410 if( i>=pAggInfo->nFunc ){
5411 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5412 */
danielk197714db2662006-01-09 16:12:04 +00005413 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005414 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005415 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005416 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005417 pItem = &pAggInfo->aFunc[i];
5418 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005419 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005420 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005421 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005422 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005423 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005424 if( pExpr->flags & EP_Distinct ){
5425 pItem->iDistinct = pParse->nTab++;
5426 }else{
5427 pItem->iDistinct = -1;
5428 }
drh13449892005-09-07 21:22:45 +00005429 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005430 }
drh13449892005-09-07 21:22:45 +00005431 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5432 */
drhc5cd1242013-09-12 16:50:49 +00005433 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005434 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005435 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005436 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005437 return WRC_Prune;
5438 }else{
5439 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005440 }
drh22827922000-06-06 17:27:05 +00005441 }
5442 }
drh7d10d5a2008-08-20 16:35:10 +00005443 return WRC_Continue;
5444}
5445static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005446 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005447 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005448 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005449}
drh979dd1b2017-05-29 14:26:07 +00005450static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5451 UNUSED_PARAMETER(pSelect);
5452 pWalker->walkerDepth--;
5453}
drh626a8792005-01-17 22:08:19 +00005454
5455/*
drhe8abb4c2012-11-02 18:24:57 +00005456** Analyze the pExpr expression looking for aggregate functions and
5457** for variables that need to be added to AggInfo object that pNC->pAggInfo
5458** points to. Additional entries are made on the AggInfo object as
5459** necessary.
drh626a8792005-01-17 22:08:19 +00005460**
5461** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005462** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005463*/
drhd2b3e232008-01-23 14:51:49 +00005464void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005465 Walker w;
5466 w.xExprCallback = analyzeAggregate;
5467 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005468 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5469 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005470 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005471 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005472 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005473 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005474}
drh5d9a4af2005-08-30 00:54:01 +00005475
5476/*
5477** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5478** expression list. Return the number of errors.
5479**
5480** If an error is found, the analysis is cut short.
5481*/
drhd2b3e232008-01-23 14:51:49 +00005482void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005483 struct ExprList_item *pItem;
5484 int i;
drh5d9a4af2005-08-30 00:54:01 +00005485 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005486 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5487 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005488 }
5489 }
drh5d9a4af2005-08-30 00:54:01 +00005490}
drh892d3172008-01-10 03:46:36 +00005491
5492/*
drhceea3322009-04-23 13:22:42 +00005493** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005494*/
5495int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005496 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005497 return ++pParse->nMem;
5498 }
danielk19772f425f62008-07-04 09:41:39 +00005499 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005500}
drhceea3322009-04-23 13:22:42 +00005501
5502/*
5503** Deallocate a register, making available for reuse for some other
5504** purpose.
drhceea3322009-04-23 13:22:42 +00005505*/
drh892d3172008-01-10 03:46:36 +00005506void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005507 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005508 pParse->aTempReg[pParse->nTempReg++] = iReg;
5509 }
5510}
5511
5512/*
drhed24da42016-09-06 14:37:05 +00005513** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005514*/
5515int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005516 int i, n;
drhed24da42016-09-06 14:37:05 +00005517 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005518 i = pParse->iRangeReg;
5519 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005520 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005521 pParse->iRangeReg += nReg;
5522 pParse->nRangeReg -= nReg;
5523 }else{
5524 i = pParse->nMem+1;
5525 pParse->nMem += nReg;
5526 }
5527 return i;
5528}
5529void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005530 if( nReg==1 ){
5531 sqlite3ReleaseTempReg(pParse, iReg);
5532 return;
5533 }
drh892d3172008-01-10 03:46:36 +00005534 if( nReg>pParse->nRangeReg ){
5535 pParse->nRangeReg = nReg;
5536 pParse->iRangeReg = iReg;
5537 }
5538}
drhcdc69552011-12-06 13:24:59 +00005539
5540/*
5541** Mark all temporary registers as being unavailable for reuse.
5542*/
5543void sqlite3ClearTempRegCache(Parse *pParse){
5544 pParse->nTempReg = 0;
5545 pParse->nRangeReg = 0;
5546}
drhbb9b5f22016-03-19 00:35:02 +00005547
5548/*
5549** Validate that no temporary register falls within the range of
5550** iFirst..iLast, inclusive. This routine is only call from within assert()
5551** statements.
5552*/
5553#ifdef SQLITE_DEBUG
5554int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5555 int i;
5556 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005557 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5558 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005559 ){
5560 return 0;
5561 }
5562 for(i=0; i<pParse->nTempReg; i++){
5563 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5564 return 0;
5565 }
5566 }
5567 return 1;
5568}
5569#endif /* SQLITE_DEBUG */