blob: ef4221ff8df541a19ccbc1944dfd587acb5c2adf [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 }
drh11949042019-08-05 18:01:42 +000074 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000075}
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);
drh96fb16e2019-08-06 14:37:24 +0000233 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
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 }
danielk1977e014a832004-05-17 10:48:57 +0000242 }else{
243 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000244 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
245 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000246 }
247}
248
drh53db1452004-05-20 13:54:53 +0000249/*
250** pExpr is a comparison operator. Return the type affinity that should
251** be applied to both operands prior to doing the comparison.
252*/
danielk1977e014a832004-05-17 10:48:57 +0000253static char comparisonAffinity(Expr *pExpr){
254 char aff;
255 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
256 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000257 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000258 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000259 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000260 if( pExpr->pRight ){
261 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000262 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
263 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000264 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000265 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000266 }
267 return aff;
268}
269
270/*
271** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
272** idx_affinity is the affinity of an indexed column. Return true
273** if the index with affinity idx_affinity may be used to implement
274** the comparison in pExpr.
275*/
276int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
277 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000278 if( aff<SQLITE_AFF_TEXT ){
279 return 1;
drh8a512562005-11-14 22:29:05 +0000280 }
drh915e4342019-08-06 15:18:15 +0000281 if( aff==SQLITE_AFF_TEXT ){
282 return idx_affinity==SQLITE_AFF_TEXT;
283 }
284 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000285}
286
danielk1977a37cdde2004-05-16 11:15:36 +0000287/*
drh35573352008-01-08 23:54:25 +0000288** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000289** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000290*/
drh35573352008-01-08 23:54:25 +0000291static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
292 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000293 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000294 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000295}
296
drha2e00042002-01-22 03:13:42 +0000297/*
danielk19770202b292004-06-09 09:55:16 +0000298** Return a pointer to the collation sequence that should be used by
299** a binary comparison operator comparing pLeft and pRight.
300**
301** If the left hand expression has a collating sequence type, then it is
302** used. Otherwise the collation sequence for the right hand expression
303** is used, or the default (BINARY) if neither expression has a collating
304** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000305**
306** Argument pRight (but not pLeft) may be a null pointer. In this case,
307** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000308*/
drh0a0e1312007-08-07 17:04:59 +0000309CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000310 Parse *pParse,
311 Expr *pLeft,
312 Expr *pRight
313){
drhec41dda2007-02-07 13:09:45 +0000314 CollSeq *pColl;
315 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000316 if( pLeft->flags & EP_Collate ){
317 pColl = sqlite3ExprCollSeq(pParse, pLeft);
318 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
319 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000320 }else{
321 pColl = sqlite3ExprCollSeq(pParse, pLeft);
322 if( !pColl ){
323 pColl = sqlite3ExprCollSeq(pParse, pRight);
324 }
danielk19770202b292004-06-09 09:55:16 +0000325 }
326 return pColl;
327}
328
329/*
drhbe5c89a2004-07-26 00:31:09 +0000330** Generate code for a comparison operator.
331*/
332static int codeCompare(
333 Parse *pParse, /* The parsing (and code generating) context */
334 Expr *pLeft, /* The left operand */
335 Expr *pRight, /* The right operand */
336 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000337 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000338 int dest, /* Jump here if true. */
339 int jumpIfNull /* If true, jump if either operand is NULL */
340){
drh35573352008-01-08 23:54:25 +0000341 int p5;
342 int addr;
343 CollSeq *p4;
344
345 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
346 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
347 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
348 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000349 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000350 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000351}
352
dancfbb5e82016-07-13 19:48:13 +0000353/*
dan870a0702016-08-01 16:37:43 +0000354** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000355**
356** A vector is defined as any expression that results in two or more
357** columns of result. Every TK_VECTOR node is an vector because the
358** parser will not generate a TK_VECTOR with fewer than two entries.
359** But a TK_SELECT might be either a vector or a scalar. It is only
360** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000361*/
362int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000363 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000364}
365
366/*
dancfbb5e82016-07-13 19:48:13 +0000367** If the expression passed as the only argument is of type TK_VECTOR
368** return the number of expressions in the vector. Or, if the expression
369** is a sub-select, return the number of columns in the sub-select. For
370** any other type of expression, return 1.
371*/
dan71c57db2016-07-09 20:23:55 +0000372int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000373 u8 op = pExpr->op;
374 if( op==TK_REGISTER ) op = pExpr->op2;
375 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000376 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000377 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000378 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000379 }else{
380 return 1;
dan71c57db2016-07-09 20:23:55 +0000381 }
dan71c57db2016-07-09 20:23:55 +0000382}
383
danba00e302016-07-23 20:24:06 +0000384/*
drhfc7f27b2016-08-20 00:07:01 +0000385** Return a pointer to a subexpression of pVector that is the i-th
386** column of the vector (numbered starting with 0). The caller must
387** ensure that i is within range.
388**
drh76dbe7a2016-08-20 21:02:38 +0000389** If pVector is really a scalar (and "scalar" here includes subqueries
390** that return a single column!) then return pVector unmodified.
391**
drhfc7f27b2016-08-20 00:07:01 +0000392** pVector retains ownership of the returned subexpression.
393**
394** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000395** just the expression for the i-th term of the result set, and may
396** not be ready for evaluation because the table cursor has not yet
397** been positioned.
danba00e302016-07-23 20:24:06 +0000398*/
drhfc7f27b2016-08-20 00:07:01 +0000399Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000400 assert( i<sqlite3ExprVectorSize(pVector) );
401 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000402 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
403 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000404 return pVector->x.pSelect->pEList->a[i].pExpr;
405 }else{
406 return pVector->x.pList->a[i].pExpr;
407 }
dan71c57db2016-07-09 20:23:55 +0000408 }
dan870a0702016-08-01 16:37:43 +0000409 return pVector;
dan71c57db2016-07-09 20:23:55 +0000410}
drhfc7f27b2016-08-20 00:07:01 +0000411
drhfc7f27b2016-08-20 00:07:01 +0000412/*
413** Compute and return a new Expr object which when passed to
414** sqlite3ExprCode() will generate all necessary code to compute
415** the iField-th column of the vector expression pVector.
416**
drh8762ec12016-08-20 01:06:22 +0000417** It is ok for pVector to be a scalar (as long as iField==0).
418** In that case, this routine works like sqlite3ExprDup().
419**
drhfc7f27b2016-08-20 00:07:01 +0000420** The caller owns the returned Expr object and is responsible for
421** ensuring that the returned value eventually gets freed.
422**
drh8762ec12016-08-20 01:06:22 +0000423** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000424** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000425** valid for the life of the returned object. If pVector is a TK_VECTOR
426** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000427** returns.
drh8762ec12016-08-20 01:06:22 +0000428**
429** A trick to cause a TK_SELECT pVector to be deleted together with
430** the returned Expr object is to attach the pVector to the pRight field
431** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000432*/
433Expr *sqlite3ExprForVectorField(
434 Parse *pParse, /* Parsing context */
435 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000436 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000437){
438 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000439 if( pVector->op==TK_SELECT ){
440 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000441 /* The TK_SELECT_COLUMN Expr node:
442 **
drh966e2912017-01-03 02:58:01 +0000443 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000444 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000445 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000446 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000447 ** pLeft->iTable: First in an array of register holding result, or 0
448 ** if the result is not yet computed.
449 **
450 ** sqlite3ExprDelete() specifically skips the recursive delete of
451 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000452 ** can be attached to pRight to cause this node to take ownership of
453 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
454 ** with the same pLeft pointer to the pVector, but only one of them
455 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000456 */
drhabfd35e2016-12-06 22:47:23 +0000457 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000458 if( pRet ){
459 pRet->iColumn = iField;
460 pRet->pLeft = pVector;
461 }
drhfc7f27b2016-08-20 00:07:01 +0000462 assert( pRet==0 || pRet->iTable==0 );
463 }else{
drha1251bc2016-08-20 00:51:37 +0000464 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
465 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000466 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000467 }
468 return pRet;
469}
dan71c57db2016-07-09 20:23:55 +0000470
dan5c288b92016-07-30 21:02:33 +0000471/*
472** If expression pExpr is of type TK_SELECT, generate code to evaluate
473** it. Return the register in which the result is stored (or, if the
474** sub-select returns more than one column, the first in an array
475** of registers in which the result is stored).
476**
477** If pExpr is not a TK_SELECT expression, return 0.
478*/
479static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000480 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000481#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000482 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000483 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000484 }
danf9b2e052016-08-02 17:45:00 +0000485#endif
dan8da209b2016-07-26 18:06:08 +0000486 return reg;
487}
488
dan5c288b92016-07-30 21:02:33 +0000489/*
490** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000491** or TK_SELECT that returns more than one column. This function returns
492** the register number of a register that contains the value of
493** element iField of the vector.
494**
495** If pVector is a TK_SELECT expression, then code for it must have
496** already been generated using the exprCodeSubselect() routine. In this
497** case parameter regSelect should be the first in an array of registers
498** containing the results of the sub-select.
499**
500** If pVector is of type TK_VECTOR, then code for the requested field
501** is generated. In this case (*pRegFree) may be set to the number of
502** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000503**
504** Before returning, output parameter (*ppExpr) is set to point to the
505** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000506*/
507static int exprVectorRegister(
508 Parse *pParse, /* Parse context */
509 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000510 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000511 int regSelect, /* First in array of registers */
512 Expr **ppExpr, /* OUT: Expression element */
513 int *pRegFree /* OUT: Temp register to free */
514){
drh12abf402016-08-22 14:30:05 +0000515 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000516 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000517 if( op==TK_REGISTER ){
518 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
519 return pVector->iTable+iField;
520 }
521 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000522 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
523 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000524 }
dan870a0702016-08-01 16:37:43 +0000525 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000526 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
527}
528
529/*
530** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000531** the result of the comparison (1, 0, or NULL) and write that
532** result into register dest.
533**
534** The caller must satisfy the following preconditions:
535**
536** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
537** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
538** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000539*/
drh79752b62016-08-13 10:02:17 +0000540static void codeVectorCompare(
541 Parse *pParse, /* Code generator context */
542 Expr *pExpr, /* The comparison operation */
543 int dest, /* Write results into this register */
544 u8 op, /* Comparison operator */
545 u8 p5 /* SQLITE_NULLEQ or zero */
546){
dan71c57db2016-07-09 20:23:55 +0000547 Vdbe *v = pParse->pVdbe;
548 Expr *pLeft = pExpr->pLeft;
549 Expr *pRight = pExpr->pRight;
550 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000551 int i;
552 int regLeft = 0;
553 int regRight = 0;
554 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000555 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000556
drh245ce622017-01-01 12:44:07 +0000557 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
558 sqlite3ErrorMsg(pParse, "row value misused");
559 return;
560 }
drhb29e60c2016-09-05 12:02:34 +0000561 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
562 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
563 || pExpr->op==TK_LT || pExpr->op==TK_GT
564 || pExpr->op==TK_LE || pExpr->op==TK_GE
565 );
566 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
567 || (pExpr->op==TK_ISNOT && op==TK_NE) );
568 assert( p5==0 || pExpr->op!=op );
569 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000570
drhb29e60c2016-09-05 12:02:34 +0000571 p5 |= SQLITE_STOREP2;
572 if( opx==TK_LE ) opx = TK_LT;
573 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000574
drhb29e60c2016-09-05 12:02:34 +0000575 regLeft = exprCodeSubselect(pParse, pLeft);
576 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000577
drhb29e60c2016-09-05 12:02:34 +0000578 for(i=0; 1 /*Loop exits by "break"*/; i++){
579 int regFree1 = 0, regFree2 = 0;
580 Expr *pL, *pR;
581 int r1, r2;
582 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000583 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
584 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
585 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
586 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
587 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
588 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
589 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
590 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
591 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
592 sqlite3ReleaseTempReg(pParse, regFree1);
593 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000594 if( i==nLeft-1 ){
595 break;
dan71c57db2016-07-09 20:23:55 +0000596 }
drhb29e60c2016-09-05 12:02:34 +0000597 if( opx==TK_EQ ){
598 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
599 p5 |= SQLITE_KEEPNULL;
600 }else if( opx==TK_NE ){
601 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
602 p5 |= SQLITE_KEEPNULL;
603 }else{
604 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
605 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
606 VdbeCoverageIf(v, op==TK_LT);
607 VdbeCoverageIf(v, op==TK_GT);
608 VdbeCoverageIf(v, op==TK_LE);
609 VdbeCoverageIf(v, op==TK_GE);
610 if( i==nLeft-2 ) opx = op;
611 }
dan71c57db2016-07-09 20:23:55 +0000612 }
drhb29e60c2016-09-05 12:02:34 +0000613 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000614}
615
danielk19774b5255a2008-06-05 16:47:39 +0000616#if SQLITE_MAX_EXPR_DEPTH>0
617/*
618** Check that argument nHeight is less than or equal to the maximum
619** expression depth allowed. If it is not, leave an error message in
620** pParse.
621*/
drh7d10d5a2008-08-20 16:35:10 +0000622int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000623 int rc = SQLITE_OK;
624 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
625 if( nHeight>mxHeight ){
626 sqlite3ErrorMsg(pParse,
627 "Expression tree is too large (maximum depth %d)", mxHeight
628 );
629 rc = SQLITE_ERROR;
630 }
631 return rc;
632}
633
634/* The following three functions, heightOfExpr(), heightOfExprList()
635** and heightOfSelect(), are used to determine the maximum height
636** of any expression tree referenced by the structure passed as the
637** first argument.
638**
639** If this maximum height is greater than the current value pointed
640** to by pnHeight, the second parameter, then set *pnHeight to that
641** value.
642*/
643static void heightOfExpr(Expr *p, int *pnHeight){
644 if( p ){
645 if( p->nHeight>*pnHeight ){
646 *pnHeight = p->nHeight;
647 }
648 }
649}
650static void heightOfExprList(ExprList *p, int *pnHeight){
651 if( p ){
652 int i;
653 for(i=0; i<p->nExpr; i++){
654 heightOfExpr(p->a[i].pExpr, pnHeight);
655 }
656 }
657}
dan1a3a3082018-01-18 19:00:54 +0000658static void heightOfSelect(Select *pSelect, int *pnHeight){
659 Select *p;
660 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000661 heightOfExpr(p->pWhere, pnHeight);
662 heightOfExpr(p->pHaving, pnHeight);
663 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000664 heightOfExprList(p->pEList, pnHeight);
665 heightOfExprList(p->pGroupBy, pnHeight);
666 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000667 }
668}
669
670/*
671** Set the Expr.nHeight variable in the structure passed as an
672** argument. An expression with no children, Expr.pList or
673** Expr.pSelect member has a height of 1. Any other expression
674** has a height equal to the maximum height of any other
675** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000676**
677** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
678** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000679*/
680static void exprSetHeight(Expr *p){
681 int nHeight = 0;
682 heightOfExpr(p->pLeft, &nHeight);
683 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000684 if( ExprHasProperty(p, EP_xIsSelect) ){
685 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000686 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000687 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000688 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000689 }
danielk19774b5255a2008-06-05 16:47:39 +0000690 p->nHeight = nHeight + 1;
691}
692
693/*
694** Set the Expr.nHeight variable using the exprSetHeight() function. If
695** the height is greater than the maximum allowed expression depth,
696** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000697**
698** Also propagate all EP_Propagate flags from the Expr.x.pList into
699** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000700*/
drh2308ed32015-02-09 16:09:34 +0000701void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000702 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000703 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000704 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000705}
706
707/*
708** Return the maximum height of any expression tree referenced
709** by the select statement passed as an argument.
710*/
711int sqlite3SelectExprHeight(Select *p){
712 int nHeight = 0;
713 heightOfSelect(p, &nHeight);
714 return nHeight;
715}
drh2308ed32015-02-09 16:09:34 +0000716#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
717/*
718** Propagate all EP_Propagate flags from the Expr.x.pList into
719** Expr.flags.
720*/
721void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
722 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
723 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
724 }
725}
726#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000727#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
728
drhbe5c89a2004-07-26 00:31:09 +0000729/*
drhb7916a72009-05-27 10:31:29 +0000730** This routine is the core allocator for Expr nodes.
731**
drha76b5df2002-02-23 02:32:10 +0000732** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000733** for this node and for the pToken argument is a single allocation
734** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000735** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000736**
737** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000738** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000739** parameter is ignored if pToken is NULL or if the token does not
740** appear to be quoted. If the quotes were of the form "..." (double-quotes)
741** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000742**
743** Special case: If op==TK_INTEGER and pToken points to a string that
744** can be translated into a 32-bit integer, then the token is not
745** stored in u.zToken. Instead, the integer values is written
746** into u.iValue and the EP_IntValue flag is set. No extra storage
747** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000748*/
drhb7916a72009-05-27 10:31:29 +0000749Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000750 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000751 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000752 const Token *pToken, /* Token argument. Might be NULL */
753 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000754){
drha76b5df2002-02-23 02:32:10 +0000755 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000756 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000757 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000758
drh575fad62016-02-05 13:38:36 +0000759 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000760 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000761 if( op!=TK_INTEGER || pToken->z==0
762 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
763 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000764 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000765 }
drhb7916a72009-05-27 10:31:29 +0000766 }
drh575fad62016-02-05 13:38:36 +0000767 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000768 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000769 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000770 pNew->op = (u8)op;
771 pNew->iAgg = -1;
772 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000773 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000774 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000775 pNew->u.iValue = iValue;
776 }else{
drh33e619f2009-05-28 01:00:55 +0000777 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000778 assert( pToken->z!=0 || pToken->n==0 );
779 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000780 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000781 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000782 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000783 }
drhb7916a72009-05-27 10:31:29 +0000784 }
785 }
786#if SQLITE_MAX_EXPR_DEPTH>0
787 pNew->nHeight = 1;
788#endif
789 }
drha76b5df2002-02-23 02:32:10 +0000790 return pNew;
791}
792
793/*
drhb7916a72009-05-27 10:31:29 +0000794** Allocate a new expression node from a zero-terminated token that has
795** already been dequoted.
796*/
797Expr *sqlite3Expr(
798 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
799 int op, /* Expression opcode */
800 const char *zToken /* Token argument. Might be NULL */
801){
802 Token x;
803 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000804 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000805 return sqlite3ExprAlloc(db, op, &x, 0);
806}
807
808/*
809** Attach subtrees pLeft and pRight to the Expr node pRoot.
810**
811** If pRoot==NULL that means that a memory allocation error has occurred.
812** In that case, delete the subtrees pLeft and pRight.
813*/
814void sqlite3ExprAttachSubtrees(
815 sqlite3 *db,
816 Expr *pRoot,
817 Expr *pLeft,
818 Expr *pRight
819){
820 if( pRoot==0 ){
821 assert( db->mallocFailed );
822 sqlite3ExprDelete(db, pLeft);
823 sqlite3ExprDelete(db, pRight);
824 }else{
825 if( pRight ){
826 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000827 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000828 }
829 if( pLeft ){
830 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000831 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000832 }
833 exprSetHeight(pRoot);
834 }
835}
836
837/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000838** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000839**
drhbf664462009-06-19 18:32:54 +0000840** One or both of the subtrees can be NULL. Return a pointer to the new
841** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
842** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000843*/
drh17435752007-08-16 04:30:38 +0000844Expr *sqlite3PExpr(
845 Parse *pParse, /* Parsing context */
846 int op, /* Expression opcode */
847 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000848 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000849){
drh5fb52ca2012-03-31 02:34:35 +0000850 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000851 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
852 if( p ){
853 memset(p, 0, sizeof(Expr));
854 p->op = op & 0xff;
855 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000856 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000857 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000858 }else{
859 sqlite3ExprDelete(pParse->db, pLeft);
860 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000861 }
drh4e0cff62004-11-05 05:10:28 +0000862 return p;
863}
864
865/*
drh08de4f72016-04-11 01:06:47 +0000866** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
867** do a memory allocation failure) then delete the pSelect object.
868*/
869void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
870 if( pExpr ){
871 pExpr->x.pSelect = pSelect;
872 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
873 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
874 }else{
875 assert( pParse->db->mallocFailed );
876 sqlite3SelectDelete(pParse->db, pSelect);
877 }
878}
879
880
881/*
drh91bb0ee2004-09-01 03:06:34 +0000882** Join two expressions using an AND operator. If either expression is
883** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000884**
885** If one side or the other of the AND is known to be false, then instead
886** of returning an AND expression, just return a constant expression with
887** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000888*/
drhd5c851c2019-04-19 13:38:34 +0000889Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
890 sqlite3 *db = pParse->db;
891 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000892 return pRight;
893 }else if( pRight==0 ){
894 return pLeft;
drhad317272019-04-19 16:21:51 +0000895 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000896 sqlite3ExprUnmapAndDelete(pParse, pLeft);
897 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5fb52ca2012-03-31 02:34:35 +0000898 return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
drh91bb0ee2004-09-01 03:06:34 +0000899 }else{
drhd5c851c2019-04-19 13:38:34 +0000900 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000901 }
902}
903
904/*
905** Construct a new expression node for a function with multiple
906** arguments.
907*/
drh954733b2018-07-27 23:33:16 +0000908Expr *sqlite3ExprFunction(
909 Parse *pParse, /* Parsing context */
910 ExprList *pList, /* Argument list */
911 Token *pToken, /* Name of the function */
912 int eDistinct /* SF_Distinct or SF_ALL or 0 */
913){
drha76b5df2002-02-23 02:32:10 +0000914 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000915 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000916 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000917 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000918 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000919 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000920 return 0;
921 }
drh954733b2018-07-27 23:33:16 +0000922 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
923 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
924 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000925 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000926 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000927 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000928 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000929 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000930 return pNew;
931}
932
933/*
drhfa6bc002004-09-07 16:19:52 +0000934** Assign a variable number to an expression that encodes a wildcard
935** in the original SQL statement.
936**
937** Wildcards consisting of a single "?" are assigned the next sequential
938** variable number.
939**
940** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000941** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000942** the SQL statement comes from an external source.
943**
drh51f49f12009-05-21 20:41:32 +0000944** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000945** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000946** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000947** assigned.
948*/
drhde25a882016-10-03 15:28:24 +0000949void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000950 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000951 const char *z;
drhf326d662016-12-23 13:30:53 +0000952 ynVar x;
drh17435752007-08-16 04:30:38 +0000953
drhfa6bc002004-09-07 16:19:52 +0000954 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000955 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000956 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000957 assert( z!=0 );
958 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000959 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000960 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000961 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000962 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000963 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000964 }else{
drhf326d662016-12-23 13:30:53 +0000965 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000966 if( z[0]=='?' ){
967 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
968 ** use it as the variable number */
969 i64 i;
drh18814df2017-01-31 03:52:34 +0000970 int bOk;
971 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
972 i = z[1]-'0'; /* The common case of ?N for a single digit N */
973 bOk = 1;
974 }else{
975 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
976 }
drh124c0b42011-06-01 18:15:55 +0000977 testcase( i==0 );
978 testcase( i==1 );
979 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
980 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
981 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
982 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
983 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000984 return;
drhfa6bc002004-09-07 16:19:52 +0000985 }
drh8e74e7b2017-01-31 12:41:48 +0000986 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +0000987 if( x>pParse->nVar ){
988 pParse->nVar = (int)x;
989 doAdd = 1;
990 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
991 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +0000992 }
993 }else{
994 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
995 ** number as the prior appearance of the same name, or if the name
996 ** has never appeared before, reuse the same variable number
997 */
drh9bf755c2016-12-23 03:59:31 +0000998 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
999 if( x==0 ){
1000 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001001 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001002 }
drhfa6bc002004-09-07 16:19:52 +00001003 }
drhf326d662016-12-23 13:30:53 +00001004 if( doAdd ){
1005 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1006 }
1007 }
1008 pExpr->iColumn = x;
1009 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001010 sqlite3ErrorMsg(pParse, "too many SQL variables");
1011 }
drhfa6bc002004-09-07 16:19:52 +00001012}
1013
1014/*
danf6963f92009-11-23 14:39:14 +00001015** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001016*/
drh4f0010b2016-04-11 14:49:39 +00001017static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1018 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001019 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1020 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001021
1022 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1023 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001024 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001025#ifdef SQLITE_DEBUG
1026 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1027 assert( p->pLeft==0 );
1028 assert( p->pRight==0 );
1029 assert( p->x.pSelect==0 );
1030 }
1031#endif
1032 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001033 /* The Expr.x union is never used at the same time as Expr.pRight */
1034 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001035 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001036 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001037 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001038 sqlite3ExprDeleteNN(db, p->pRight);
1039 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001040 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001041 sqlite3SelectDelete(db, p->x.pSelect);
1042 }else{
1043 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001044#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001045 if( ExprHasProperty(p, EP_WinFunc) ){
1046 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001047 }
dan6ba7ab02019-07-02 11:56:47 +00001048#endif
dan8117f112019-07-10 20:16:53 +00001049 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001050 }
drh209bc522016-09-23 21:36:24 +00001051 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001052 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001053 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001054 }
drha2e00042002-01-22 03:13:42 +00001055}
drh4f0010b2016-04-11 14:49:39 +00001056void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1057 if( p ) sqlite3ExprDeleteNN(db, p);
1058}
drha2e00042002-01-22 03:13:42 +00001059
drh8e34e402019-06-11 10:43:56 +00001060/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1061** expression.
1062*/
1063void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1064 if( p ){
1065 if( IN_RENAME_OBJECT ){
1066 sqlite3RenameExprUnmap(pParse, p);
1067 }
1068 sqlite3ExprDeleteNN(pParse->db, p);
1069 }
1070}
1071
drhd2687b72005-08-12 22:56:09 +00001072/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001073** Return the number of bytes allocated for the expression structure
1074** passed as the first argument. This is always one of EXPR_FULLSIZE,
1075** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1076*/
1077static int exprStructSize(Expr *p){
1078 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001079 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1080 return EXPR_FULLSIZE;
1081}
1082
1083/*
drh33e619f2009-05-28 01:00:55 +00001084** The dupedExpr*Size() routines each return the number of bytes required
1085** to store a copy of an expression or expression tree. They differ in
1086** how much of the tree is measured.
1087**
1088** dupedExprStructSize() Size of only the Expr structure
1089** dupedExprNodeSize() Size of Expr + space for token
1090** dupedExprSize() Expr + token + subtree components
1091**
1092***************************************************************************
1093**
1094** The dupedExprStructSize() function returns two values OR-ed together:
1095** (1) the space required for a copy of the Expr structure only and
1096** (2) the EP_xxx flags that indicate what the structure size should be.
1097** The return values is always one of:
1098**
1099** EXPR_FULLSIZE
1100** EXPR_REDUCEDSIZE | EP_Reduced
1101** EXPR_TOKENONLYSIZE | EP_TokenOnly
1102**
1103** The size of the structure can be found by masking the return value
1104** of this routine with 0xfff. The flags can be found by masking the
1105** return value with EP_Reduced|EP_TokenOnly.
1106**
1107** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1108** (unreduced) Expr objects as they or originally constructed by the parser.
1109** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001110** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001111** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001112** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001113** to reduce a pristine expression tree from the parser. The implementation
1114** of dupedExprStructSize() contain multiple assert() statements that attempt
1115** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001116*/
1117static int dupedExprStructSize(Expr *p, int flags){
1118 int nSize;
drh33e619f2009-05-28 01:00:55 +00001119 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001120 assert( EXPR_FULLSIZE<=0xfff );
1121 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001122 if( 0==flags || p->op==TK_SELECT_COLUMN
1123#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001124 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001125#endif
1126 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 }else{
drhc5cd1242013-09-12 16:50:49 +00001129 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001130 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001131 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001132 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001133 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001134 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1135 }else{
drhaecd8022013-09-13 18:15:15 +00001136 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001137 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1138 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001139 }
1140 return nSize;
1141}
1142
1143/*
drh33e619f2009-05-28 01:00:55 +00001144** This function returns the space in bytes required to store the copy
1145** of the Expr structure and a copy of the Expr.u.zToken string (if that
1146** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001147*/
1148static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001149 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1150 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001151 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001152 }
danielk1977bc739712009-03-23 04:33:32 +00001153 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001154}
1155
1156/*
1157** Return the number of bytes required to create a duplicate of the
1158** expression passed as the first argument. The second argument is a
1159** mask containing EXPRDUP_XXX flags.
1160**
1161** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001162** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001163**
1164** If the EXPRDUP_REDUCE flag is set, then the return value includes
1165** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1166** and Expr.pRight variables (but not for any structures pointed to or
1167** descended from the Expr.x.pList or Expr.x.pSelect variables).
1168*/
1169static int dupedExprSize(Expr *p, int flags){
1170 int nByte = 0;
1171 if( p ){
1172 nByte = dupedExprNodeSize(p, flags);
1173 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001174 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001175 }
1176 }
1177 return nByte;
1178}
1179
1180/*
1181** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1182** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001183** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001184** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001185** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001186** portion of the buffer copied into by this function.
1187*/
drh3c194692016-04-11 16:43:43 +00001188static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1189 Expr *pNew; /* Value to return */
1190 u8 *zAlloc; /* Memory space from which to build Expr object */
1191 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1192
drh575fad62016-02-05 13:38:36 +00001193 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001194 assert( p );
1195 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1196 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001197
drh3c194692016-04-11 16:43:43 +00001198 /* Figure out where to write the new Expr structure. */
1199 if( pzBuffer ){
1200 zAlloc = *pzBuffer;
1201 staticFlag = EP_Static;
1202 }else{
1203 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1204 staticFlag = 0;
1205 }
1206 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001207
drh3c194692016-04-11 16:43:43 +00001208 if( pNew ){
1209 /* Set nNewSize to the size allocated for the structure pointed to
1210 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1211 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1212 ** by the copy of the p->u.zToken string (if any).
1213 */
1214 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1215 const int nNewSize = nStructSize & 0xfff;
1216 int nToken;
1217 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1218 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001219 }else{
drh3c194692016-04-11 16:43:43 +00001220 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001221 }
drh3c194692016-04-11 16:43:43 +00001222 if( dupFlags ){
1223 assert( ExprHasProperty(p, EP_Reduced)==0 );
1224 memcpy(zAlloc, p, nNewSize);
1225 }else{
1226 u32 nSize = (u32)exprStructSize(p);
1227 memcpy(zAlloc, p, nSize);
1228 if( nSize<EXPR_FULLSIZE ){
1229 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1230 }
1231 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001232
drh3c194692016-04-11 16:43:43 +00001233 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1234 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1235 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1236 pNew->flags |= staticFlag;
1237
1238 /* Copy the p->u.zToken string, if any. */
1239 if( nToken ){
1240 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1241 memcpy(zToken, p->u.zToken, nToken);
1242 }
1243
drh209bc522016-09-23 21:36:24 +00001244 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001245 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1246 if( ExprHasProperty(p, EP_xIsSelect) ){
1247 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001248 }else{
drh3c194692016-04-11 16:43:43 +00001249 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001250 }
drh3c194692016-04-11 16:43:43 +00001251 }
1252
1253 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001254 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001255 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001256 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001257 pNew->pLeft = p->pLeft ?
1258 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1259 pNew->pRight = p->pRight ?
1260 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001261 }
dan67a9b8e2018-06-22 20:51:35 +00001262#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001263 if( ExprHasProperty(p, EP_WinFunc) ){
1264 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1265 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001266 }
dan67a9b8e2018-06-22 20:51:35 +00001267#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001268 if( pzBuffer ){
1269 *pzBuffer = zAlloc;
1270 }
1271 }else{
drh209bc522016-09-23 21:36:24 +00001272 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001273 if( pNew->op==TK_SELECT_COLUMN ){
1274 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001275 assert( p->iColumn==0 || p->pRight==0 );
1276 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001277 }else{
1278 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1279 }
drh3c194692016-04-11 16:43:43 +00001280 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001281 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001282 }
1283 }
1284 return pNew;
1285}
1286
1287/*
danbfe31e72014-01-15 14:17:31 +00001288** Create and return a deep copy of the object passed as the second
1289** argument. If an OOM condition is encountered, NULL is returned
1290** and the db->mallocFailed flag set.
1291*/
daneede6a52014-01-15 19:42:23 +00001292#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001293static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001294 With *pRet = 0;
1295 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001296 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001297 pRet = sqlite3DbMallocZero(db, nByte);
1298 if( pRet ){
1299 int i;
1300 pRet->nCte = p->nCte;
1301 for(i=0; i<p->nCte; i++){
1302 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1303 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1304 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1305 }
1306 }
1307 }
1308 return pRet;
1309}
daneede6a52014-01-15 19:42:23 +00001310#else
1311# define withDup(x,y) 0
1312#endif
dan4e9119d2014-01-13 15:12:23 +00001313
drha8389972018-12-06 22:04:19 +00001314#ifndef SQLITE_OMIT_WINDOWFUNC
1315/*
1316** The gatherSelectWindows() procedure and its helper routine
1317** gatherSelectWindowsCallback() are used to scan all the expressions
1318** an a newly duplicated SELECT statement and gather all of the Window
1319** objects found there, assembling them onto the linked list at Select->pWin.
1320*/
1321static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001322 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001323 Select *pSelect = pWalker->u.pSelect;
1324 Window *pWin = pExpr->y.pWin;
1325 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001326 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001327 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001328 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001329 }
1330 return WRC_Continue;
1331}
drha37b6a52018-12-06 22:12:18 +00001332static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1333 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1334}
drha8389972018-12-06 22:04:19 +00001335static void gatherSelectWindows(Select *p){
1336 Walker w;
1337 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001338 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1339 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001340 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001341 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001342 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001343}
1344#endif
1345
1346
drha76b5df2002-02-23 02:32:10 +00001347/*
drhff78bd22002-02-27 01:47:11 +00001348** The following group of routines make deep copies of expressions,
1349** expression lists, ID lists, and select statements. The copies can
1350** be deleted (by being passed to their respective ...Delete() routines)
1351** without effecting the originals.
1352**
danielk19774adee202004-05-08 08:23:19 +00001353** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1354** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001355** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001356**
drhad3cab52002-05-24 02:04:32 +00001357** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001358**
drhb7916a72009-05-27 10:31:29 +00001359** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001360** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1361** truncated version of the usual Expr structure that will be stored as
1362** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001363*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001364Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001365 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001366 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001367}
danielk19776ab3a2e2009-02-19 14:39:25 +00001368ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001369 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001370 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001371 int i;
drhb1637482017-01-03 00:27:16 +00001372 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001373 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001374 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001375 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001376 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001377 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001378 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001379 pOldItem = p->a;
1380 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001381 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001382 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001383 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001384 if( pOldExpr
1385 && pOldExpr->op==TK_SELECT_COLUMN
1386 && (pNewExpr = pItem->pExpr)!=0
1387 ){
1388 assert( pNewExpr->iColumn==0 || i>0 );
1389 if( pNewExpr->iColumn==0 ){
1390 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001391 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1392 }else{
1393 assert( i>0 );
1394 assert( pItem[-1].pExpr!=0 );
1395 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1396 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1397 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001398 }
1399 }
drh17435752007-08-16 04:30:38 +00001400 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001401 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
drh145716b2004-09-24 12:24:06 +00001402 pItem->sortOrder = pOldItem->sortOrder;
drh3e7bc9c2004-02-21 19:17:17 +00001403 pItem->done = 0;
drh2c036cf2013-06-26 00:34:13 +00001404 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001405 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001406 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001407 }
1408 return pNew;
1409}
danielk197793758c82005-01-21 08:13:14 +00001410
1411/*
1412** If cursors, triggers, views and subqueries are all omitted from
1413** the build, then none of the following routines, except for
1414** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1415** called with a NULL argument.
1416*/
danielk19776a67fe82005-02-04 04:07:16 +00001417#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1418 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001419SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001420 SrcList *pNew;
1421 int i;
drh113088e2003-03-20 01:16:58 +00001422 int nByte;
drh575fad62016-02-05 13:38:36 +00001423 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001424 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001425 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001426 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001427 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001428 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001429 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001430 struct SrcList_item *pNewItem = &pNew->a[i];
1431 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001432 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001433 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001434 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1435 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1436 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001437 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001438 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001439 pNewItem->addrFillSub = pOldItem->addrFillSub;
1440 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001441 if( pNewItem->fg.isIndexedBy ){
1442 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1443 }
1444 pNewItem->pIBIndex = pOldItem->pIBIndex;
1445 if( pNewItem->fg.isTabFunc ){
1446 pNewItem->u1.pFuncArg =
1447 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1448 }
drhed8a3bb2005-06-06 21:19:56 +00001449 pTab = pNewItem->pTab = pOldItem->pTab;
1450 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001451 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001452 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001453 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1454 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001455 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001456 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001457 }
1458 return pNew;
1459}
drh17435752007-08-16 04:30:38 +00001460IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001461 IdList *pNew;
1462 int i;
drh575fad62016-02-05 13:38:36 +00001463 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001464 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001465 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001466 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001467 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001468 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001469 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001470 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001471 return 0;
1472 }
drh6c535152012-02-02 03:38:30 +00001473 /* Note that because the size of the allocation for p->a[] is not
1474 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1475 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001476 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001477 struct IdList_item *pNewItem = &pNew->a[i];
1478 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001479 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001480 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001481 }
1482 return pNew;
1483}
dana7466202017-02-03 14:44:52 +00001484Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1485 Select *pRet = 0;
1486 Select *pNext = 0;
1487 Select **pp = &pRet;
1488 Select *p;
1489
drh575fad62016-02-05 13:38:36 +00001490 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001491 for(p=pDup; p; p=p->pPrior){
1492 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1493 if( pNew==0 ) break;
1494 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1495 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1496 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1497 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1498 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1499 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1500 pNew->op = p->op;
1501 pNew->pNext = pNext;
1502 pNew->pPrior = 0;
1503 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001504 pNew->iLimit = 0;
1505 pNew->iOffset = 0;
1506 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1507 pNew->addrOpenEphm[0] = -1;
1508 pNew->addrOpenEphm[1] = -1;
1509 pNew->nSelectRow = p->nSelectRow;
1510 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001511#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001512 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001513 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
drha8389972018-12-06 22:04:19 +00001514 if( p->pWin ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001515#endif
drhfef37762018-07-10 19:48:35 +00001516 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001517 *pp = pNew;
1518 pp = &pNew->pPrior;
1519 pNext = pNew;
1520 }
1521
1522 return pRet;
drhff78bd22002-02-27 01:47:11 +00001523}
danielk197793758c82005-01-21 08:13:14 +00001524#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001525Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001526 assert( p==0 );
1527 return 0;
1528}
1529#endif
drhff78bd22002-02-27 01:47:11 +00001530
1531
1532/*
drha76b5df2002-02-23 02:32:10 +00001533** Add a new element to the end of an expression list. If pList is
1534** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001535**
drha19543f2017-09-15 15:17:48 +00001536** The pList argument must be either NULL or a pointer to an ExprList
1537** obtained from a prior call to sqlite3ExprListAppend(). This routine
1538** may not be used with an ExprList obtained from sqlite3ExprListDup().
1539** Reason: This routine assumes that the number of slots in pList->a[]
1540** is a power of two. That is true for sqlite3ExprListAppend() returns
1541** but is not necessarily true from the return value of sqlite3ExprListDup().
1542**
drhb7916a72009-05-27 10:31:29 +00001543** If a memory allocation error occurs, the entire list is freed and
1544** NULL is returned. If non-NULL is returned, then it is guaranteed
1545** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001546*/
drh17435752007-08-16 04:30:38 +00001547ExprList *sqlite3ExprListAppend(
1548 Parse *pParse, /* Parsing context */
1549 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001550 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001551){
drh43606172017-04-05 11:32:13 +00001552 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001553 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001554 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001555 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001556 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001557 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001558 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001559 }
drhc263f7c2016-01-18 13:18:54 +00001560 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001561 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001562 ExprList *pNew;
1563 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001564 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001565 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001566 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001567 }
drh43606172017-04-05 11:32:13 +00001568 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001569 }
drh43606172017-04-05 11:32:13 +00001570 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001571 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1572 assert( offsetof(struct ExprList_item,pExpr)==0 );
1573 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001574 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001575 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001576
1577no_mem:
1578 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001579 sqlite3ExprDelete(db, pExpr);
1580 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001581 return 0;
drha76b5df2002-02-23 02:32:10 +00001582}
1583
1584/*
drh8762ec12016-08-20 01:06:22 +00001585** pColumns and pExpr form a vector assignment which is part of the SET
1586** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001587**
1588** (a,b,c) = (expr1,expr2,expr3)
1589** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1590**
1591** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001592** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001593** TK_SELECT_COLUMN expressions.
1594*/
1595ExprList *sqlite3ExprListAppendVector(
1596 Parse *pParse, /* Parsing context */
1597 ExprList *pList, /* List to which to append. Might be NULL */
1598 IdList *pColumns, /* List of names of LHS of the assignment */
1599 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1600){
1601 sqlite3 *db = pParse->db;
1602 int n;
1603 int i;
drh66860af2016-08-23 18:30:10 +00001604 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001605 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1606 ** exit prior to this routine being invoked */
1607 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001608 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001609
1610 /* If the RHS is a vector, then we can immediately check to see that
1611 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1612 ** wildcards ("*") in the result set of the SELECT must be expanded before
1613 ** we can do the size check, so defer the size check until code generation.
1614 */
1615 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001616 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1617 pColumns->nId, n);
1618 goto vector_append_error;
1619 }
drh966e2912017-01-03 02:58:01 +00001620
1621 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001622 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1623 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1624 if( pList ){
drh66860af2016-08-23 18:30:10 +00001625 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001626 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1627 pColumns->a[i].zName = 0;
1628 }
1629 }
drh966e2912017-01-03 02:58:01 +00001630
drhffe28052017-05-06 18:09:36 +00001631 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001632 Expr *pFirst = pList->a[iFirst].pExpr;
1633 assert( pFirst!=0 );
1634 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001635
drhf4dd26c2017-04-05 11:49:06 +00001636 /* Store the SELECT statement in pRight so it will be deleted when
1637 ** sqlite3ExprListDelete() is called */
1638 pFirst->pRight = pExpr;
1639 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001640
drhf4dd26c2017-04-05 11:49:06 +00001641 /* Remember the size of the LHS in iTable so that we can check that
1642 ** the RHS and LHS sizes match during code generation. */
1643 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001644 }
1645
1646vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001647 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001648 sqlite3IdListDelete(db, pColumns);
1649 return pList;
1650}
1651
1652/*
drhbc622bc2015-08-24 15:39:42 +00001653** Set the sort order for the last element on the given ExprList.
1654*/
1655void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1656 if( p==0 ) return;
1657 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1658 assert( p->nExpr>0 );
1659 if( iSortOrder<0 ){
1660 assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1661 return;
1662 }
1663 p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
drhbc622bc2015-08-24 15:39:42 +00001664}
1665
1666/*
drhb7916a72009-05-27 10:31:29 +00001667** Set the ExprList.a[].zName element of the most recently added item
1668** on the expression list.
1669**
1670** pList might be NULL following an OOM error. But pName should never be
1671** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1672** is set.
1673*/
1674void sqlite3ExprListSetName(
1675 Parse *pParse, /* Parsing context */
1676 ExprList *pList, /* List to which to add the span. */
1677 Token *pName, /* Name to be added */
1678 int dequote /* True to cause the name to be dequoted */
1679){
1680 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1681 if( pList ){
1682 struct ExprList_item *pItem;
1683 assert( pList->nExpr>0 );
1684 pItem = &pList->a[pList->nExpr-1];
1685 assert( pItem->zName==0 );
1686 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001687 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001688 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001689 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001690 }
drhb7916a72009-05-27 10:31:29 +00001691 }
1692}
1693
1694/*
1695** Set the ExprList.a[].zSpan element of the most recently added item
1696** on the expression list.
1697**
1698** pList might be NULL following an OOM error. But pSpan should never be
1699** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1700** is set.
1701*/
1702void sqlite3ExprListSetSpan(
1703 Parse *pParse, /* Parsing context */
1704 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001705 const char *zStart, /* Start of the span */
1706 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001707){
1708 sqlite3 *db = pParse->db;
1709 assert( pList!=0 || db->mallocFailed!=0 );
1710 if( pList ){
1711 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1712 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001713 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001714 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001715 }
1716}
1717
1718/*
danielk19777a15a4b2007-05-08 17:54:43 +00001719** If the expression list pEList contains more than iLimit elements,
1720** leave an error message in pParse.
1721*/
1722void sqlite3ExprListCheckLength(
1723 Parse *pParse,
1724 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001725 const char *zObject
1726){
drhb1a6c3c2008-03-20 16:30:17 +00001727 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001728 testcase( pEList && pEList->nExpr==mx );
1729 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001730 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001731 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1732 }
1733}
1734
1735/*
drha76b5df2002-02-23 02:32:10 +00001736** Delete an entire expression list.
1737*/
drhaffa8552016-04-11 18:25:05 +00001738static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001739 int i = pList->nExpr;
1740 struct ExprList_item *pItem = pList->a;
1741 assert( pList->nExpr>0 );
1742 do{
drh633e6d52008-07-28 19:34:53 +00001743 sqlite3ExprDelete(db, pItem->pExpr);
1744 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001745 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001746 pItem++;
1747 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001748 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001749}
drhaffa8552016-04-11 18:25:05 +00001750void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1751 if( pList ) exprListDeleteNN(db, pList);
1752}
drha76b5df2002-02-23 02:32:10 +00001753
1754/*
drh2308ed32015-02-09 16:09:34 +00001755** Return the bitwise-OR of all Expr.flags fields in the given
1756** ExprList.
drh885a5b02015-02-09 15:21:36 +00001757*/
drh2308ed32015-02-09 16:09:34 +00001758u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001759 int i;
drh2308ed32015-02-09 16:09:34 +00001760 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001761 assert( pList!=0 );
1762 for(i=0; i<pList->nExpr; i++){
1763 Expr *pExpr = pList->a[i].pExpr;
1764 assert( pExpr!=0 );
1765 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001766 }
drh2308ed32015-02-09 16:09:34 +00001767 return m;
drh885a5b02015-02-09 15:21:36 +00001768}
1769
1770/*
drh7e6f9802017-09-04 00:33:04 +00001771** This is a SELECT-node callback for the expression walker that
1772** always "fails". By "fail" in this case, we mean set
1773** pWalker->eCode to zero and abort.
1774**
1775** This callback is used by multiple expression walkers.
1776*/
1777int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1778 UNUSED_PARAMETER(NotUsed);
1779 pWalker->eCode = 0;
1780 return WRC_Abort;
1781}
1782
1783/*
drh171d16b2018-02-26 20:15:54 +00001784** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001785** then convert it into an TK_TRUEFALSE term. Return non-zero if
1786** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001787*/
1788int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1789 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001790 if( !ExprHasProperty(pExpr, EP_Quoted)
1791 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1792 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001793 ){
1794 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001795 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001796 return 1;
1797 }
1798 return 0;
1799}
1800
drh43c4ac82018-02-26 21:26:27 +00001801/*
drh96acafb2018-02-27 14:49:25 +00001802** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001803** and 0 if it is FALSE.
1804*/
drh96acafb2018-02-27 14:49:25 +00001805int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001806 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001807 assert( pExpr->op==TK_TRUEFALSE );
1808 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1809 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1810 return pExpr->u.zToken[4]==0;
1811}
1812
drh17180fc2019-04-19 17:26:19 +00001813/*
1814** If pExpr is an AND or OR expression, try to simplify it by eliminating
1815** terms that are always true or false. Return the simplified expression.
1816** Or return the original expression if no simplification is possible.
1817**
1818** Examples:
1819**
1820** (x<10) AND true => (x<10)
1821** (x<10) AND false => false
1822** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1823** (x<10) AND (y=22 OR true) => (x<10)
1824** (y=22) OR true => true
1825*/
1826Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1827 assert( pExpr!=0 );
1828 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1829 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1830 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1831 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1832 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1833 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1834 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1835 }
1836 }
1837 return pExpr;
1838}
1839
drh171d16b2018-02-26 20:15:54 +00001840
1841/*
drh059b2d52014-10-24 19:28:09 +00001842** These routines are Walker callbacks used to check expressions to
1843** see if they are "constant" for some definition of constant. The
1844** Walker.eCode value determines the type of "constant" we are looking
1845** for.
drh73b211a2005-01-18 04:00:42 +00001846**
drh7d10d5a2008-08-20 16:35:10 +00001847** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001848**
drh059b2d52014-10-24 19:28:09 +00001849** sqlite3ExprIsConstant() pWalker->eCode==1
1850** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001851** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001852** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001853**
drh059b2d52014-10-24 19:28:09 +00001854** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1855** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001856**
drhfeada2d2014-09-24 13:20:22 +00001857** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001858** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1859** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001860** parameter raises an error for new statements, but is silently converted
1861** to NULL for existing schemas. This allows sqlite_master tables that
1862** contain a bound parameter because they were generated by older versions
1863** of SQLite to be parsed by newer versions of SQLite without raising a
1864** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001865*/
drh7d10d5a2008-08-20 16:35:10 +00001866static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001867
drh059b2d52014-10-24 19:28:09 +00001868 /* If pWalker->eCode is 2 then any term of the expression that comes from
1869 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001870 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001871 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1872 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001873 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001874 }
1875
drh626a8792005-01-17 22:08:19 +00001876 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001877 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001878 ** and either pWalker->eCode==4 or 5 or the function has the
1879 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001880 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001881 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001882 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001883 }else{
1884 pWalker->eCode = 0;
1885 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001886 }
drh626a8792005-01-17 22:08:19 +00001887 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001888 /* Convert "true" or "false" in a DEFAULT clause into the
1889 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001890 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001891 return WRC_Prune;
1892 }
1893 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001894 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001895 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001896 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001897 testcase( pExpr->op==TK_ID );
1898 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001899 testcase( pExpr->op==TK_AGG_FUNCTION );
1900 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001901 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001902 return WRC_Continue;
1903 }
drh059b2d52014-10-24 19:28:09 +00001904 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1905 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001906 }
drhf43ce0b2017-05-25 00:08:48 +00001907 /* Fall through */
1908 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001909 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001910 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001911 testcase( pExpr->op==TK_IF_NULL_ROW );
1912 pWalker->eCode = 0;
1913 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001914 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001915 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001916 /* Silently convert bound parameters that appear inside of CREATE
1917 ** statements into a NULL when parsing the CREATE statement text out
1918 ** of the sqlite_master table */
1919 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001920 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001921 /* A bound parameter in a CREATE statement that originates from
1922 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001923 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001924 return WRC_Abort;
1925 }
1926 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001927 default:
drh6e341b92018-04-17 18:50:40 +00001928 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1929 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001930 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001931 }
1932}
drh059b2d52014-10-24 19:28:09 +00001933static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001934 Walker w;
drh059b2d52014-10-24 19:28:09 +00001935 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001936 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001937 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001938#ifdef SQLITE_DEBUG
1939 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1940#endif
drh059b2d52014-10-24 19:28:09 +00001941 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001942 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001943 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001944}
drh626a8792005-01-17 22:08:19 +00001945
1946/*
drh059b2d52014-10-24 19:28:09 +00001947** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001948** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001949**
1950** For the purposes of this function, a double-quoted string (ex: "abc")
1951** is considered a variable but a single-quoted string (ex: 'abc') is
1952** a constant.
drhfef52082000-06-06 01:50:43 +00001953*/
danielk19774adee202004-05-08 08:23:19 +00001954int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001955 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001956}
1957
1958/*
drh07aded62018-07-28 16:24:08 +00001959** Walk an expression tree. Return non-zero if
1960**
1961** (1) the expression is constant, and
1962** (2) the expression does originate in the ON or USING clause
1963** of a LEFT JOIN, and
1964** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1965** operands created by the constant propagation optimization.
1966**
1967** When this routine returns true, it indicates that the expression
1968** can be added to the pParse->pConstExpr list and evaluated once when
1969** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00001970*/
1971int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001972 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00001973}
1974
1975/*
drhfcb9f4f2015-06-01 18:13:16 +00001976** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00001977** for any single row of the table with cursor iCur. In other words, the
1978** expression must not refer to any non-deterministic function nor any
1979** table other than iCur.
1980*/
1981int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1982 return exprIsConst(p, 3, iCur);
1983}
1984
danab31a842017-04-29 20:53:09 +00001985
1986/*
1987** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1988*/
1989static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1990 ExprList *pGroupBy = pWalker->u.pGroupBy;
1991 int i;
1992
1993 /* Check if pExpr is identical to any GROUP BY term. If so, consider
1994 ** it constant. */
1995 for(i=0; i<pGroupBy->nExpr; i++){
1996 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00001997 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00001998 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00001999 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002000 return WRC_Prune;
2001 }
2002 }
2003 }
2004
2005 /* Check if pExpr is a sub-select. If so, consider it variable. */
2006 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2007 pWalker->eCode = 0;
2008 return WRC_Abort;
2009 }
2010
2011 return exprNodeIsConstant(pWalker, pExpr);
2012}
2013
2014/*
2015** Walk the expression tree passed as the first argument. Return non-zero
2016** if the expression consists entirely of constants or copies of terms
2017** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002018**
2019** This routine is used to determine if a term of the HAVING clause can
2020** be promoted into the WHERE clause. In order for such a promotion to work,
2021** the value of the HAVING clause term must be the same for all members of
2022** a "group". The requirement that the GROUP BY term must be BINARY
2023** assumes that no other collating sequence will have a finer-grained
2024** grouping than binary. In other words (A=B COLLATE binary) implies
2025** A=B in every other collating sequence. The requirement that the
2026** GROUP BY be BINARY is stricter than necessary. It would also work
2027** to promote HAVING clauses that use the same alternative collating
2028** sequence as the GROUP BY term, but that is much harder to check,
2029** alternative collating sequences are uncommon, and this is only an
2030** optimization, so we take the easy way out and simply require the
2031** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002032*/
2033int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2034 Walker w;
danab31a842017-04-29 20:53:09 +00002035 w.eCode = 1;
2036 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002037 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002038 w.u.pGroupBy = pGroupBy;
2039 w.pParse = pParse;
2040 sqlite3WalkExpr(&w, p);
2041 return w.eCode;
2042}
2043
drh059b2d52014-10-24 19:28:09 +00002044/*
2045** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002046** or a function call with constant arguments. Return and 0 if there
2047** are any variables.
2048**
2049** For the purposes of this function, a double-quoted string (ex: "abc")
2050** is considered a variable but a single-quoted string (ex: 'abc') is
2051** a constant.
2052*/
drhfeada2d2014-09-24 13:20:22 +00002053int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2054 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002055 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002056}
2057
drh5b88bc42013-12-07 23:35:21 +00002058#ifdef SQLITE_ENABLE_CURSOR_HINTS
2059/*
2060** Walk an expression tree. Return 1 if the expression contains a
2061** subquery of some kind. Return 0 if there are no subqueries.
2062*/
2063int sqlite3ExprContainsSubquery(Expr *p){
2064 Walker w;
drhbec24762015-08-13 20:07:13 +00002065 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002066 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002067 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002068#ifdef SQLITE_DEBUG
2069 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2070#endif
drh5b88bc42013-12-07 23:35:21 +00002071 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002072 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002073}
2074#endif
2075
drheb55bd22005-06-30 17:04:21 +00002076/*
drh73b211a2005-01-18 04:00:42 +00002077** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002078** to fit in a 32-bit integer, return 1 and put the value of the integer
2079** in *pValue. If the expression is not an integer or if it is too big
2080** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002081*/
danielk19774adee202004-05-08 08:23:19 +00002082int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002083 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002084 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002085
2086 /* If an expression is an integer literal that fits in a signed 32-bit
2087 ** integer, then the EP_IntValue flag will have already been set */
2088 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2089 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2090
drh92b01d52008-06-24 00:32:35 +00002091 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002092 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002093 return 1;
2094 }
drhe4de1fe2002-06-02 16:09:01 +00002095 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002096 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002097 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002098 break;
drh4b59ab52002-08-24 18:24:51 +00002099 }
drhe4de1fe2002-06-02 16:09:01 +00002100 case TK_UMINUS: {
2101 int v;
danielk19774adee202004-05-08 08:23:19 +00002102 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002103 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002104 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002105 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002106 }
2107 break;
2108 }
2109 default: break;
2110 }
drh92b01d52008-06-24 00:32:35 +00002111 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002112}
2113
2114/*
drh039fc322009-11-17 18:31:47 +00002115** Return FALSE if there is no chance that the expression can be NULL.
2116**
2117** If the expression might be NULL or if the expression is too complex
2118** to tell return TRUE.
2119**
2120** This routine is used as an optimization, to skip OP_IsNull opcodes
2121** when we know that a value cannot be NULL. Hence, a false positive
2122** (returning TRUE when in fact the expression can never be NULL) might
2123** be a small performance hit but is otherwise harmless. On the other
2124** hand, a false negative (returning FALSE when the result could be NULL)
2125** will likely result in an incorrect answer. So when in doubt, return
2126** TRUE.
2127*/
2128int sqlite3ExprCanBeNull(const Expr *p){
2129 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002130 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2131 p = p->pLeft;
2132 }
drh039fc322009-11-17 18:31:47 +00002133 op = p->op;
2134 if( op==TK_REGISTER ) op = p->op2;
2135 switch( op ){
2136 case TK_INTEGER:
2137 case TK_STRING:
2138 case TK_FLOAT:
2139 case TK_BLOB:
2140 return 0;
drh7248a8b2014-08-04 18:50:54 +00002141 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002142 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002143 p->y.pTab==0 || /* Reference to column of index on expression */
2144 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002145 default:
2146 return 1;
2147 }
2148}
2149
2150/*
2151** Return TRUE if the given expression is a constant which would be
2152** unchanged by OP_Affinity with the affinity given in the second
2153** argument.
2154**
2155** This routine is used to determine if the OP_Affinity operation
2156** can be omitted. When in doubt return FALSE. A false negative
2157** is harmless. A false positive, however, can result in the wrong
2158** answer.
2159*/
2160int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2161 u8 op;
drh05883a32015-06-02 15:32:08 +00002162 if( aff==SQLITE_AFF_BLOB ) return 1;
drhcd7f4572009-11-19 14:48:40 +00002163 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
drh039fc322009-11-17 18:31:47 +00002164 op = p->op;
2165 if( op==TK_REGISTER ) op = p->op2;
2166 switch( op ){
2167 case TK_INTEGER: {
2168 return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2169 }
2170 case TK_FLOAT: {
2171 return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2172 }
2173 case TK_STRING: {
2174 return aff==SQLITE_AFF_TEXT;
2175 }
2176 case TK_BLOB: {
2177 return 1;
2178 }
drh2f2855b2009-11-18 01:25:26 +00002179 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002180 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
2181 return p->iColumn<0
2182 && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
drh2f2855b2009-11-18 01:25:26 +00002183 }
drh039fc322009-11-17 18:31:47 +00002184 default: {
2185 return 0;
2186 }
2187 }
2188}
2189
2190/*
drhc4a3c772001-04-04 11:48:57 +00002191** Return TRUE if the given string is a row-id column name.
2192*/
danielk19774adee202004-05-08 08:23:19 +00002193int sqlite3IsRowid(const char *z){
2194 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2195 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2196 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002197 return 0;
2198}
2199
danielk19779a96b662007-11-29 17:05:18 +00002200/*
drh69c355b2016-03-09 15:34:51 +00002201** pX is the RHS of an IN operator. If pX is a SELECT statement
2202** that can be simplified to a direct table access, then return
2203** a pointer to the SELECT statement. If pX is not a SELECT statement,
2204** or if the SELECT statement needs to be manifested into a transient
2205** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002206*/
2207#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002208static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002209 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002210 SrcList *pSrc;
2211 ExprList *pEList;
2212 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002213 int i;
drh69c355b2016-03-09 15:34:51 +00002214 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2215 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2216 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002217 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002218 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002219 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2220 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2221 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002222 }
drhb74b1012009-05-28 21:04:37 +00002223 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002224 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002225 if( p->pWhere ) return 0; /* Has no WHERE clause */
2226 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002227 assert( pSrc!=0 );
2228 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002229 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002230 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002231 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002232 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002233 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2234 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002235 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002236 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002237 for(i=0; i<pEList->nExpr; i++){
2238 Expr *pRes = pEList->a[i].pExpr;
2239 if( pRes->op!=TK_COLUMN ) return 0;
2240 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002241 }
drh69c355b2016-03-09 15:34:51 +00002242 return p;
drhb287f4b2008-04-25 00:08:38 +00002243}
2244#endif /* SQLITE_OMIT_SUBQUERY */
2245
danf9b2e052016-08-02 17:45:00 +00002246#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002247/*
drh4c259e92014-08-01 21:12:35 +00002248** Generate code that checks the left-most column of index table iCur to see if
2249** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002250** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2251** to be set to NULL if iCur contains one or more NULL values.
2252*/
2253static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002254 int addr1;
drh6be515e2014-08-01 21:00:53 +00002255 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002256 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002257 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2258 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002259 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002260 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002261}
danf9b2e052016-08-02 17:45:00 +00002262#endif
drh6be515e2014-08-01 21:00:53 +00002263
drhbb53ecb2014-08-02 21:03:33 +00002264
2265#ifndef SQLITE_OMIT_SUBQUERY
2266/*
2267** The argument is an IN operator with a list (not a subquery) on the
2268** right-hand side. Return TRUE if that list is constant.
2269*/
2270static int sqlite3InRhsIsConstant(Expr *pIn){
2271 Expr *pLHS;
2272 int res;
2273 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2274 pLHS = pIn->pLeft;
2275 pIn->pLeft = 0;
2276 res = sqlite3ExprIsConstant(pIn);
2277 pIn->pLeft = pLHS;
2278 return res;
2279}
2280#endif
2281
drh6be515e2014-08-01 21:00:53 +00002282/*
danielk19779a96b662007-11-29 17:05:18 +00002283** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002284** The pX parameter is the expression on the RHS of the IN operator, which
2285** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002286**
drhd4305ca2012-09-18 17:08:33 +00002287** The job of this routine is to find or create a b-tree object that can
2288** be used either to test for membership in the RHS set or to iterate through
2289** all members of the RHS set, skipping duplicates.
2290**
drh3a856252014-08-01 14:46:57 +00002291** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002292** and pX->iTable is set to the index of that cursor.
2293**
drhb74b1012009-05-28 21:04:37 +00002294** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002295**
drh1ccce442013-03-12 20:38:51 +00002296** IN_INDEX_ROWID - The cursor was opened on a database table.
2297** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2298** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2299** IN_INDEX_EPH - The cursor was opened on a specially created and
2300** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002301** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2302** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002303**
drhd4305ca2012-09-18 17:08:33 +00002304** An existing b-tree might be used if the RHS expression pX is a simple
2305** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002306**
dan553168c2016-08-01 20:14:31 +00002307** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002308**
drhd4305ca2012-09-18 17:08:33 +00002309** If the RHS of the IN operator is a list or a more complex subquery, then
2310** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002311** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002312** existing table.
drhd4305ca2012-09-18 17:08:33 +00002313**
drh7fc0ba02017-11-17 15:02:00 +00002314** The inFlags parameter must contain, at a minimum, one of the bits
2315** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2316** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2317** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2318** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002319**
2320** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2321** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002322** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002323** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2324** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002325**
drh3a856252014-08-01 14:46:57 +00002326** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2327** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002328** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2329** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002330**
drhbb53ecb2014-08-02 21:03:33 +00002331** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2332** if the RHS of the IN operator is a list (not a subquery) then this
2333** routine might decide that creating an ephemeral b-tree for membership
2334** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2335** calling routine should implement the IN operator using a sequence
2336** of Eq or Ne comparison operations.
2337**
drhb74b1012009-05-28 21:04:37 +00002338** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002339** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002340** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002341** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002342** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002343** to *prRhsHasNull. If there is no chance that the (...) contains a
2344** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002345**
drhe21a6e12014-08-01 18:00:24 +00002346** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002347** the value in that register will be NULL if the b-tree contains one or more
2348** NULL values, and it will be some non-NULL value if the b-tree contains no
2349** NULL values.
dan553168c2016-08-01 20:14:31 +00002350**
2351** If the aiMap parameter is not NULL, it must point to an array containing
2352** one element for each column returned by the SELECT statement on the RHS
2353** of the IN(...) operator. The i'th entry of the array is populated with the
2354** offset of the index column that matches the i'th column returned by the
2355** SELECT. For example, if the expression and selected index are:
2356**
2357** (?,?,?) IN (SELECT a, b, c FROM t1)
2358** CREATE INDEX i1 ON t1(b, c, a);
2359**
2360** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002361*/
danielk1977284f4ac2007-12-10 05:03:46 +00002362#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002363int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002364 Parse *pParse, /* Parsing context */
2365 Expr *pX, /* The right-hand side (RHS) of the IN operator */
2366 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2367 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002368 int *aiMap, /* Mapping from Index fields to RHS fields */
2369 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002370){
drhb74b1012009-05-28 21:04:37 +00002371 Select *p; /* SELECT to the right of IN operator */
2372 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2373 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002374 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002375 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002376
drh1450bc62009-10-30 13:25:56 +00002377 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002378 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002379
dan7b35a772016-07-28 19:47:15 +00002380 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2381 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002382 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002383 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002384 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002385 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2386 int i;
2387 ExprList *pEList = pX->x.pSelect->pEList;
2388 for(i=0; i<pEList->nExpr; i++){
2389 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2390 }
2391 if( i==pEList->nExpr ){
2392 prRhsHasNull = 0;
2393 }
2394 }
2395
drhb74b1012009-05-28 21:04:37 +00002396 /* Check to see if an existing table or index can be used to
2397 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002398 ** ephemeral table. */
2399 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002400 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002401 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002402 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002403 ExprList *pEList = p->pEList;
2404 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002405
drhb07028f2011-10-14 21:49:18 +00002406 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2407 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2408 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2409 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002410
drhb22f7c82014-02-06 23:56:27 +00002411 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002412 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2413 sqlite3CodeVerifySchema(pParse, iDb);
2414 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002415
drha84a2832016-08-26 21:15:35 +00002416 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002417 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002418 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002419 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002420 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002421
2422 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2423 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002424 ExplainQueryPlan((pParse, 0,
2425 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002426 sqlite3VdbeJumpHere(v, iAddr);
2427 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002428 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002429 int affinity_ok = 1;
2430 int i;
2431
2432 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002433 ** comparison is the same as the affinity of each column in table
2434 ** on the RHS of the IN operator. If it not, it is not possible to
2435 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002436 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002437 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002438 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002439 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002440 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002441 testcase( cmpaff==SQLITE_AFF_BLOB );
2442 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002443 switch( cmpaff ){
2444 case SQLITE_AFF_BLOB:
2445 break;
2446 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002447 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2448 ** other has no affinity and the other side is TEXT. Hence,
2449 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2450 ** and for the term on the LHS of the IN to have no affinity. */
2451 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002452 break;
2453 default:
2454 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2455 }
2456 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002457
drha84a2832016-08-26 21:15:35 +00002458 if( affinity_ok ){
2459 /* Search for an existing index that will work for this IN operator */
2460 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2461 Bitmask colUsed; /* Columns of the index used */
2462 Bitmask mCol; /* Mask for the current column */
2463 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002464 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002465 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2466 ** BITMASK(nExpr) without overflowing */
2467 testcase( pIdx->nColumn==BMS-2 );
2468 testcase( pIdx->nColumn==BMS-1 );
2469 if( pIdx->nColumn>=BMS-1 ) continue;
2470 if( mustBeUnique ){
2471 if( pIdx->nKeyCol>nExpr
2472 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2473 ){
2474 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002475 }
danielk19770cdc0222008-06-26 18:04:03 +00002476 }
drha84a2832016-08-26 21:15:35 +00002477
2478 colUsed = 0; /* Columns of index used so far */
2479 for(i=0; i<nExpr; i++){
2480 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2481 Expr *pRhs = pEList->a[i].pExpr;
2482 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2483 int j;
2484
2485 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2486 for(j=0; j<nExpr; j++){
2487 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2488 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002489 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2490 continue;
2491 }
drha84a2832016-08-26 21:15:35 +00002492 break;
2493 }
2494 if( j==nExpr ) break;
2495 mCol = MASKBIT(j);
2496 if( mCol & colUsed ) break; /* Each column used only once */
2497 colUsed |= mCol;
2498 if( aiMap ) aiMap[i] = j;
2499 }
2500
2501 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2502 if( colUsed==(MASKBIT(nExpr)-1) ){
2503 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002504 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002505 ExplainQueryPlan((pParse, 0,
2506 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002507 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2508 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2509 VdbeComment((v, "%s", pIdx->zName));
2510 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2511 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2512
2513 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002514#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002515 i64 mask = (1<<nExpr)-1;
2516 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2517 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002518#endif
2519 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002520 if( nExpr==1 ){
2521 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2522 }
2523 }
2524 sqlite3VdbeJumpHere(v, iAddr);
2525 }
2526 } /* End loop over indexes */
2527 } /* End if( affinity_ok ) */
2528 } /* End if not an rowid index */
2529 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002530
drhbb53ecb2014-08-02 21:03:33 +00002531 /* If no preexisting index is available for the IN clause
2532 ** and IN_INDEX_NOOP is an allowed reply
2533 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002534 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002535 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002536 ** the IN operator so return IN_INDEX_NOOP.
2537 */
2538 if( eType==0
2539 && (inFlags & IN_INDEX_NOOP_OK)
2540 && !ExprHasProperty(pX, EP_xIsSelect)
2541 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2542 ){
2543 eType = IN_INDEX_NOOP;
2544 }
drhbb53ecb2014-08-02 21:03:33 +00002545
danielk19779a96b662007-11-29 17:05:18 +00002546 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002547 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002548 ** We will have to generate an ephemeral table to do the job.
2549 */
drh8e23daf2013-06-11 13:30:04 +00002550 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002551 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002552 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002553 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002554 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002555 }else if( prRhsHasNull ){
2556 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002557 }
drh85bcdce2018-12-23 21:27:29 +00002558 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002559 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002560 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002561 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002562 }
drhcf4d38a2010-07-28 02:53:36 +00002563 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002564 }
danba00e302016-07-23 20:24:06 +00002565
2566 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2567 int i, n;
2568 n = sqlite3ExprVectorSize(pX->pLeft);
2569 for(i=0; i<n; i++) aiMap[i] = i;
2570 }
drh2c041312018-12-24 02:34:49 +00002571 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002572 return eType;
2573}
danielk1977284f4ac2007-12-10 05:03:46 +00002574#endif
drh626a8792005-01-17 22:08:19 +00002575
danf9b2e052016-08-02 17:45:00 +00002576#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002577/*
2578** Argument pExpr is an (?, ?...) IN(...) expression. This
2579** function allocates and returns a nul-terminated string containing
2580** the affinities to be used for each column of the comparison.
2581**
2582** It is the responsibility of the caller to ensure that the returned
2583** string is eventually freed using sqlite3DbFree().
2584*/
dan71c57db2016-07-09 20:23:55 +00002585static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2586 Expr *pLeft = pExpr->pLeft;
2587 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002588 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002589 char *zRet;
2590
dan553168c2016-08-01 20:14:31 +00002591 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002592 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002593 if( zRet ){
2594 int i;
2595 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002596 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002597 char a = sqlite3ExprAffinity(pA);
2598 if( pSelect ){
2599 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2600 }else{
2601 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002602 }
dan71c57db2016-07-09 20:23:55 +00002603 }
2604 zRet[nVal] = '\0';
2605 }
2606 return zRet;
2607}
danf9b2e052016-08-02 17:45:00 +00002608#endif
dan71c57db2016-07-09 20:23:55 +00002609
dan8da209b2016-07-26 18:06:08 +00002610#ifndef SQLITE_OMIT_SUBQUERY
2611/*
2612** Load the Parse object passed as the first argument with an error
2613** message of the form:
2614**
2615** "sub-select returns N columns - expected M"
2616*/
2617void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2618 const char *zFmt = "sub-select returns %d columns - expected %d";
2619 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2620}
2621#endif
2622
drh626a8792005-01-17 22:08:19 +00002623/*
dan44c56042016-12-07 15:38:37 +00002624** Expression pExpr is a vector that has been used in a context where
2625** it is not permitted. If pExpr is a sub-select vector, this routine
2626** loads the Parse object with a message of the form:
2627**
2628** "sub-select returns N columns - expected 1"
2629**
2630** Or, if it is a regular scalar vector:
2631**
2632** "row value misused"
2633*/
2634void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2635#ifndef SQLITE_OMIT_SUBQUERY
2636 if( pExpr->flags & EP_xIsSelect ){
2637 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2638 }else
2639#endif
2640 {
2641 sqlite3ErrorMsg(pParse, "row value misused");
2642 }
2643}
2644
drh85bcdce2018-12-23 21:27:29 +00002645#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002646/*
drh85bcdce2018-12-23 21:27:29 +00002647** Generate code that will construct an ephemeral table containing all terms
2648** in the RHS of an IN operator. The IN operator can be in either of two
2649** forms:
drh626a8792005-01-17 22:08:19 +00002650**
drh9cbe6352005-11-29 03:13:21 +00002651** x IN (4,5,11) -- IN operator with list on right-hand side
2652** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002653**
drh2c041312018-12-24 02:34:49 +00002654** The pExpr parameter is the IN operator. The cursor number for the
2655** constructed ephermeral table is returned. The first time the ephemeral
2656** table is computed, the cursor number is also stored in pExpr->iTable,
2657** however the cursor number returned might not be the same, as it might
2658** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002659**
drh85bcdce2018-12-23 21:27:29 +00002660** If the LHS expression ("x" in the examples) is a column value, or
2661** the SELECT statement returns a column value, then the affinity of that
2662** column is used to build the index keys. If both 'x' and the
2663** SELECT... statement are columns, then numeric affinity is used
2664** if either column has NUMERIC or INTEGER affinity. If neither
2665** 'x' nor the SELECT... statement are columns, then numeric affinity
2666** is used.
drhcce7d172000-05-31 15:34:51 +00002667*/
drh85bcdce2018-12-23 21:27:29 +00002668void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002669 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002670 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002671 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002672){
drh2c041312018-12-24 02:34:49 +00002673 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002674 int addr; /* Address of OP_OpenEphemeral instruction */
2675 Expr *pLeft; /* the LHS of the IN operator */
2676 KeyInfo *pKeyInfo = 0; /* Key information */
2677 int nVal; /* Size of vector pLeft */
2678 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002679
drh2c041312018-12-24 02:34:49 +00002680 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002681 assert( v!=0 );
2682
drh2c041312018-12-24 02:34:49 +00002683 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002684 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002685 **
2686 ** * The right-hand side is a correlated subquery
2687 ** * The right-hand side is an expression list containing variables
2688 ** * We are inside a trigger
2689 **
drh2c041312018-12-24 02:34:49 +00002690 ** If all of the above are false, then we can compute the RHS just once
2691 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002692 */
drhefb699f2018-12-24 11:55:44 +00002693 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002694 /* Reuse of the RHS is allowed */
2695 /* If this routine has already been coded, but the previous code
2696 ** might not have been invoked yet, so invoke it now as a subroutine.
2697 */
2698 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002699 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002700 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2701 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2702 pExpr->x.pSelect->selId));
2703 }
drh2c041312018-12-24 02:34:49 +00002704 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2705 pExpr->y.sub.iAddr);
2706 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002707 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002708 return;
2709 }
2710
2711 /* Begin coding the subroutine */
2712 ExprSetProperty(pExpr, EP_Subrtn);
2713 pExpr->y.sub.regReturn = ++pParse->nMem;
2714 pExpr->y.sub.iAddr =
2715 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2716 VdbeComment((v, "return address"));
2717
2718 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002719 }
2720
drh85bcdce2018-12-23 21:27:29 +00002721 /* Check to see if this is a vector IN operator */
2722 pLeft = pExpr->pLeft;
2723 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002724
drh85bcdce2018-12-23 21:27:29 +00002725 /* Construct the ephemeral table that will contain the content of
2726 ** RHS of the IN operator.
2727 */
drh2c041312018-12-24 02:34:49 +00002728 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002729 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002730#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2731 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2732 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2733 }else{
2734 VdbeComment((v, "RHS of IN operator"));
2735 }
2736#endif
drh50ef6712019-02-22 23:29:56 +00002737 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002738
drh85bcdce2018-12-23 21:27:29 +00002739 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2740 /* Case 1: expr IN (SELECT ...)
2741 **
2742 ** Generate code to write the results of the select into the temporary
2743 ** table allocated and opened above.
2744 */
2745 Select *pSelect = pExpr->x.pSelect;
2746 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002747
drh2c041312018-12-24 02:34:49 +00002748 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2749 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002750 ));
drh85bcdce2018-12-23 21:27:29 +00002751 /* If the LHS and RHS of the IN operator do not match, that
2752 ** error will have been caught long before we reach this point. */
2753 if( ALWAYS(pEList->nExpr==nVal) ){
2754 SelectDest dest;
2755 int i;
drhbd462bc2018-12-24 20:21:06 +00002756 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002757 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2758 pSelect->iLimit = 0;
2759 testcase( pSelect->selFlags & SF_Distinct );
2760 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2761 if( sqlite3Select(pParse, pSelect, &dest) ){
2762 sqlite3DbFree(pParse->db, dest.zAffSdst);
2763 sqlite3KeyInfoUnref(pKeyInfo);
2764 return;
drhfef52082000-06-06 01:50:43 +00002765 }
drh85bcdce2018-12-23 21:27:29 +00002766 sqlite3DbFree(pParse->db, dest.zAffSdst);
2767 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2768 assert( pEList!=0 );
2769 assert( pEList->nExpr>0 );
2770 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2771 for(i=0; i<nVal; i++){
2772 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2773 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2774 pParse, p, pEList->a[i].pExpr
2775 );
danielk197741a05b72008-10-02 13:50:55 +00002776 }
drh85bcdce2018-12-23 21:27:29 +00002777 }
2778 }else if( ALWAYS(pExpr->x.pList!=0) ){
2779 /* Case 2: expr IN (exprlist)
2780 **
2781 ** For each expression, build an index key from the evaluation and
2782 ** store it in the temporary table. If <expr> is a column, then use
2783 ** that columns affinity when building index keys. If <expr> is not
2784 ** a column, use numeric affinity.
2785 */
2786 char affinity; /* Affinity of the LHS of the IN */
2787 int i;
2788 ExprList *pList = pExpr->x.pList;
2789 struct ExprList_item *pItem;
2790 int r1, r2, r3;
2791 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002792 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002793 affinity = SQLITE_AFF_BLOB;
2794 }
2795 if( pKeyInfo ){
2796 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2797 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002798 }
2799
drh85bcdce2018-12-23 21:27:29 +00002800 /* Loop through each expression in <exprlist>. */
2801 r1 = sqlite3GetTempReg(pParse);
2802 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002803 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2804 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002805
2806 /* If the expression is not constant then we will need to
2807 ** disable the test that was generated above that makes sure
2808 ** this code only executes once. Because for a non-constant
2809 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002810 */
drh2c041312018-12-24 02:34:49 +00002811 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2812 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002813 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002814 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002815 }
drh1398ad32005-01-19 23:24:50 +00002816
drh85bcdce2018-12-23 21:27:29 +00002817 /* Evaluate the expression and insert it into the temp table */
drh50ef6712019-02-22 23:29:56 +00002818 r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2819 sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2820 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
drhcce7d172000-05-31 15:34:51 +00002821 }
drh85bcdce2018-12-23 21:27:29 +00002822 sqlite3ReleaseTempReg(pParse, r1);
2823 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002824 }
drh85bcdce2018-12-23 21:27:29 +00002825 if( pKeyInfo ){
2826 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2827 }
drh2c041312018-12-24 02:34:49 +00002828 if( addrOnce ){
2829 sqlite3VdbeJumpHere(v, addrOnce);
2830 /* Subroutine return */
2831 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2832 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh85bcdce2018-12-23 21:27:29 +00002833 }
2834}
2835#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002836
drh85bcdce2018-12-23 21:27:29 +00002837/*
2838** Generate code for scalar subqueries used as a subquery expression
2839** or EXISTS operator:
2840**
2841** (SELECT a FROM b) -- subquery
2842** EXISTS (SELECT a FROM b) -- EXISTS subquery
2843**
2844** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2845**
2846** The register that holds the result. For a multi-column SELECT,
2847** the result is stored in a contiguous array of registers and the
2848** return value is the register of the left-most result column.
2849** Return 0 if an error occurs.
2850*/
2851#ifndef SQLITE_OMIT_SUBQUERY
2852int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002853 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002854 int rReg = 0; /* Register storing resulting */
2855 Select *pSel; /* SELECT statement to encode */
2856 SelectDest dest; /* How to deal with SELECT result */
2857 int nReg; /* Registers to allocate */
2858 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002859
2860 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002861 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002862 testcase( pExpr->op==TK_EXISTS );
2863 testcase( pExpr->op==TK_SELECT );
2864 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2865 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2866 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002867
drh5198ff52018-12-24 12:09:47 +00002868 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002869 ** is encountered if any of the following is true:
2870 **
2871 ** * The right-hand side is a correlated subquery
2872 ** * The right-hand side is an expression list containing variables
2873 ** * We are inside a trigger
2874 **
2875 ** If all of the above are false, then we can run this code just once
2876 ** save the results, and reuse the same result on subsequent invocations.
2877 */
2878 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002879 /* If this routine has already been coded, then invoke it as a
2880 ** subroutine. */
2881 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002882 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002883 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2884 pExpr->y.sub.iAddr);
2885 return pExpr->iTable;
2886 }
2887
2888 /* Begin coding the subroutine */
2889 ExprSetProperty(pExpr, EP_Subrtn);
2890 pExpr->y.sub.regReturn = ++pParse->nMem;
2891 pExpr->y.sub.iAddr =
2892 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2893 VdbeComment((v, "return address"));
2894
drh2c041312018-12-24 02:34:49 +00002895 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002896 }
drh85bcdce2018-12-23 21:27:29 +00002897
2898 /* For a SELECT, generate code to put the values for all columns of
2899 ** the first row into an array of registers and return the index of
2900 ** the first register.
2901 **
2902 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2903 ** into a register and return that register number.
2904 **
2905 ** In both cases, the query is augmented with "LIMIT 1". Any
2906 ** preexisting limit is discarded in place of the new LIMIT 1.
2907 */
drhbd462bc2018-12-24 20:21:06 +00002908 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2909 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002910 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2911 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2912 pParse->nMem += nReg;
2913 if( pExpr->op==TK_SELECT ){
2914 dest.eDest = SRT_Mem;
2915 dest.iSdst = dest.iSDParm;
2916 dest.nSdst = nReg;
2917 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2918 VdbeComment((v, "Init subquery result"));
2919 }else{
2920 dest.eDest = SRT_Exists;
2921 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2922 VdbeComment((v, "Init EXISTS result"));
2923 }
2924 pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
2925 if( pSel->pLimit ){
2926 sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
2927 pSel->pLimit->pLeft = pLimit;
2928 }else{
2929 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2930 }
2931 pSel->iLimit = 0;
2932 if( sqlite3Select(pParse, pSel, &dest) ){
2933 return 0;
2934 }
drh2c041312018-12-24 02:34:49 +00002935 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002936 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002937 if( addrOnce ){
2938 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002939
drh5198ff52018-12-24 12:09:47 +00002940 /* Subroutine return */
2941 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2942 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
2943 }
drh2c041312018-12-24 02:34:49 +00002944
drh1450bc62009-10-30 13:25:56 +00002945 return rReg;
drhcce7d172000-05-31 15:34:51 +00002946}
drh51522cd2005-01-20 13:36:19 +00002947#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002948
drhe3365e62009-11-12 17:52:24 +00002949#ifndef SQLITE_OMIT_SUBQUERY
2950/*
dan7b35a772016-07-28 19:47:15 +00002951** Expr pIn is an IN(...) expression. This function checks that the
2952** sub-select on the RHS of the IN() operator has the same number of
2953** columns as the vector on the LHS. Or, if the RHS of the IN() is not
2954** a sub-query, that the LHS is a vector of size 1.
2955*/
2956int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
2957 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
2958 if( (pIn->flags & EP_xIsSelect) ){
2959 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
2960 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
2961 return 1;
2962 }
2963 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00002964 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00002965 return 1;
2966 }
2967 return 0;
2968}
2969#endif
2970
2971#ifndef SQLITE_OMIT_SUBQUERY
2972/*
drhe3365e62009-11-12 17:52:24 +00002973** Generate code for an IN expression.
2974**
2975** x IN (SELECT ...)
2976** x IN (value, value, ...)
2977**
drhecb87ac2016-08-25 15:46:25 +00002978** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00002979** right-hand side (RHS) is an array of zero or more scalar values, or a
2980** subquery. If the RHS is a subquery, the number of result columns must
2981** match the number of columns in the vector on the LHS. If the RHS is
2982** a list of values, the LHS must be a scalar.
2983**
2984** The IN operator is true if the LHS value is contained within the RHS.
2985** The result is false if the LHS is definitely not in the RHS. The
2986** result is NULL if the presence of the LHS in the RHS cannot be
2987** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00002988**
drh6be515e2014-08-01 21:00:53 +00002989** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00002990** contained within the RHS. If due to NULLs we cannot determine if the LHS
2991** is contained in the RHS then jump to destIfNull. If the LHS is contained
2992** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00002993**
2994** See the separate in-operator.md documentation file in the canonical
2995** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00002996*/
2997static void sqlite3ExprCodeIN(
2998 Parse *pParse, /* Parsing and code generating context */
2999 Expr *pExpr, /* The IN expression */
3000 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3001 int destIfNull /* Jump here if the results are unknown due to NULLs */
3002){
3003 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003004 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003005 int rLhs; /* Register(s) holding the LHS values */
3006 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003007 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003008 int *aiMap = 0; /* Map from vector field to index column */
3009 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003010 int nVector; /* Size of vectors for this IN operator */
3011 int iDummy; /* Dummy parameter to exprCodeVector() */
3012 Expr *pLeft; /* The LHS of the IN operator */
3013 int i; /* loop counter */
3014 int destStep2; /* Where to jump when NULLs seen in step 2 */
3015 int destStep6 = 0; /* Start of code for Step 6 */
3016 int addrTruthOp; /* Address of opcode that determines the IN is true */
3017 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3018 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003019 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003020
drhe347d3e2016-08-25 21:14:34 +00003021 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003022 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003023 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003024 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3025 aiMap = (int*)sqlite3DbMallocZero(
3026 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3027 );
drhe347d3e2016-08-25 21:14:34 +00003028 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003029
danba00e302016-07-23 20:24:06 +00003030 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003031 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003032 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3033 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003034 v = pParse->pVdbe;
3035 assert( v!=0 ); /* OOM detected prior to this routine */
3036 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003037 eType = sqlite3FindInIndex(pParse, pExpr,
3038 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003039 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3040 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003041
danba00e302016-07-23 20:24:06 +00003042 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3043 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3044 );
drhecb87ac2016-08-25 15:46:25 +00003045#ifdef SQLITE_DEBUG
3046 /* Confirm that aiMap[] contains nVector integer values between 0 and
3047 ** nVector-1. */
3048 for(i=0; i<nVector; i++){
3049 int j, cnt;
3050 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3051 assert( cnt==1 );
3052 }
3053#endif
drhe3365e62009-11-12 17:52:24 +00003054
danba00e302016-07-23 20:24:06 +00003055 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3056 ** vector, then it is stored in an array of nVector registers starting
3057 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003058 **
3059 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3060 ** so that the fields are in the same order as an existing index. The
3061 ** aiMap[] array contains a mapping from the original LHS field order to
3062 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003063 */
drhe347d3e2016-08-25 21:14:34 +00003064 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3065 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003066 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003067 /* LHS fields are not reordered */
3068 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003069 }else{
3070 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003071 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003072 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003073 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003074 }
danba00e302016-07-23 20:24:06 +00003075 }
drhe3365e62009-11-12 17:52:24 +00003076
drhbb53ecb2014-08-02 21:03:33 +00003077 /* If sqlite3FindInIndex() did not find or create an index that is
3078 ** suitable for evaluating the IN operator, then evaluate using a
3079 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003080 **
3081 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003082 */
drhbb53ecb2014-08-02 21:03:33 +00003083 if( eType==IN_INDEX_NOOP ){
3084 ExprList *pList = pExpr->x.pList;
3085 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003086 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003087 int r2, regToFree;
3088 int regCkNull = 0;
3089 int ii;
3090 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003091 if( destIfNull!=destIfFalse ){
3092 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003093 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003094 }
3095 for(ii=0; ii<pList->nExpr; ii++){
3096 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003097 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003098 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3099 }
3100 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003101 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003102 (void*)pColl, P4_COLLSEQ);
3103 VdbeCoverageIf(v, ii<pList->nExpr-1);
3104 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003105 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003106 }else{
3107 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003108 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003109 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003110 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003111 }
3112 sqlite3ReleaseTempReg(pParse, regToFree);
3113 }
3114 if( regCkNull ){
3115 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003116 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003117 }
3118 sqlite3VdbeResolveLabel(v, labelOk);
3119 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003120 goto sqlite3ExprCodeIN_finished;
3121 }
3122
3123 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3124 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3125 ** We will then skip the binary search of the RHS.
3126 */
3127 if( destIfNull==destIfFalse ){
3128 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003129 }else{
drhec4ccdb2018-12-29 02:26:59 +00003130 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003131 }
3132 for(i=0; i<nVector; i++){
3133 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3134 if( sqlite3ExprCanBeNull(p) ){
3135 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003136 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003137 }
drhe3365e62009-11-12 17:52:24 +00003138 }
drhe347d3e2016-08-25 21:14:34 +00003139
3140 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3141 ** of the RHS using the LHS as a probe. If found, the result is
3142 ** true.
3143 */
3144 if( eType==IN_INDEX_ROWID ){
3145 /* In this case, the RHS is the ROWID of table b-tree and so we also
3146 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3147 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003148 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003149 VdbeCoverage(v);
3150 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3151 }else{
3152 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3153 if( destIfFalse==destIfNull ){
3154 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003155 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003156 rLhs, nVector); VdbeCoverage(v);
3157 goto sqlite3ExprCodeIN_finished;
3158 }
3159 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003160 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003161 rLhs, nVector); VdbeCoverage(v);
3162 }
3163
3164 /* Step 4. If the RHS is known to be non-NULL and we did not find
3165 ** an match on the search above, then the result must be FALSE.
3166 */
3167 if( rRhsHasNull && nVector==1 ){
3168 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3169 VdbeCoverage(v);
3170 }
3171
3172 /* Step 5. If we do not care about the difference between NULL and
3173 ** FALSE, then just return false.
3174 */
3175 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3176
3177 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3178 ** If any comparison is NULL, then the result is NULL. If all
3179 ** comparisons are FALSE then the final result is FALSE.
3180 **
3181 ** For a scalar LHS, it is sufficient to check just the first row
3182 ** of the RHS.
3183 */
3184 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003185 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003186 VdbeCoverage(v);
3187 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003188 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003189 }else{
3190 /* For nVector==1, combine steps 6 and 7 by immediately returning
3191 ** FALSE if the first comparison is not NULL */
3192 destNotNull = destIfFalse;
3193 }
3194 for(i=0; i<nVector; i++){
3195 Expr *p;
3196 CollSeq *pColl;
3197 int r3 = sqlite3GetTempReg(pParse);
3198 p = sqlite3VectorFieldSubexpr(pLeft, i);
3199 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003200 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003201 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3202 (void*)pColl, P4_COLLSEQ);
3203 VdbeCoverage(v);
3204 sqlite3ReleaseTempReg(pParse, r3);
3205 }
3206 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3207 if( nVector>1 ){
3208 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003209 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003210 VdbeCoverage(v);
3211
3212 /* Step 7: If we reach this point, we know that the result must
3213 ** be false. */
3214 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3215 }
3216
3217 /* Jumps here in order to return true. */
3218 sqlite3VdbeJumpHere(v, addrTruthOp);
3219
3220sqlite3ExprCodeIN_finished:
3221 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003222 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003223sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003224 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003225 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003226}
3227#endif /* SQLITE_OMIT_SUBQUERY */
3228
drh13573c72010-01-12 17:04:07 +00003229#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003230/*
3231** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003232** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003233**
3234** The z[] string will probably not be zero-terminated. But the
3235** z[n] character is guaranteed to be something that does not look
3236** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003237*/
drhb7916a72009-05-27 10:31:29 +00003238static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003239 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003240 double value;
drh9339da12010-09-30 00:50:49 +00003241 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003242 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3243 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003244 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003245 }
3246}
drh13573c72010-01-12 17:04:07 +00003247#endif
drh598f1342007-10-23 15:39:45 +00003248
3249
3250/*
drhfec19aa2004-05-19 20:41:03 +00003251** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003252** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003253**
shaneh5f1d6b62010-09-30 16:51:25 +00003254** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003255*/
drh13573c72010-01-12 17:04:07 +00003256static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3257 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003258 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003259 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003260 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003261 if( negFlag ) i = -i;
3262 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003263 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003264 int c;
3265 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003266 const char *z = pExpr->u.zToken;
3267 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003268 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003269 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003270#ifdef SQLITE_OMIT_FLOATING_POINT
3271 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3272#else
drh1b7ddc52014-07-23 14:52:05 +00003273#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003274 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003275 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003276 }else
3277#endif
3278 {
drh9296c182014-07-23 13:40:49 +00003279 codeReal(v, z, negFlag, iMem);
3280 }
drh13573c72010-01-12 17:04:07 +00003281#endif
drh77320ea2016-11-30 14:47:37 +00003282 }else{
drh84d4f1a2017-09-20 10:47:10 +00003283 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003284 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003285 }
drhfec19aa2004-05-19 20:41:03 +00003286 }
3287}
3288
drh5cd79232009-05-25 11:46:29 +00003289
drh1f9ca2c2015-08-25 16:57:52 +00003290/* Generate code that will load into register regOut a value that is
3291** appropriate for the iIdxCol-th column of index pIdx.
3292*/
3293void sqlite3ExprCodeLoadIndexColumn(
3294 Parse *pParse, /* The parsing context */
3295 Index *pIdx, /* The index whose column is to be loaded */
3296 int iTabCur, /* Cursor pointing to a table row */
3297 int iIdxCol, /* The column of the index to be loaded */
3298 int regOut /* Store the index column value in this register */
3299){
3300 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003301 if( iTabCol==XN_EXPR ){
3302 assert( pIdx->aColExpr );
3303 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003304 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003305 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003306 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003307 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003308 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3309 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003310 }
drh1f9ca2c2015-08-25 16:57:52 +00003311}
3312
drh5cd79232009-05-25 11:46:29 +00003313/*
drh5c092e82010-05-14 19:24:02 +00003314** Generate code to extract the value of the iCol-th column of a table.
3315*/
3316void sqlite3ExprCodeGetColumnOfTable(
3317 Vdbe *v, /* The VDBE under construction */
3318 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003319 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003320 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003321 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003322){
drhaca19e12017-04-07 19:41:31 +00003323 if( pTab==0 ){
3324 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3325 return;
3326 }
drh5c092e82010-05-14 19:24:02 +00003327 if( iCol<0 || iCol==pTab->iPKey ){
3328 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3329 }else{
3330 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003331 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003332 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003333 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3334 }
3335 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003336 }
3337 if( iCol>=0 ){
3338 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3339 }
3340}
3341
3342/*
drh945498f2007-02-24 11:52:52 +00003343** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003344** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003345**
3346** There must be an open cursor to pTab in iTable when this routine
3347** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003348*/
drhe55cbd72008-03-31 23:48:03 +00003349int sqlite3ExprCodeGetColumn(
3350 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003351 Table *pTab, /* Description of the table we are reading from */
3352 int iColumn, /* Index of the table column */
3353 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003354 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003355 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003356){
drhe55cbd72008-03-31 23:48:03 +00003357 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003358 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003359 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003360 if( p5 ){
3361 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003362 }
drhe55cbd72008-03-31 23:48:03 +00003363 return iReg;
3364}
drhe55cbd72008-03-31 23:48:03 +00003365
3366/*
drhb21e7c72008-06-22 12:37:57 +00003367** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003368** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003369*/
drhb21e7c72008-06-22 12:37:57 +00003370void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003371 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003372 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003373}
3374
drh652fbf52008-04-01 01:42:41 +00003375/*
drh12abf402016-08-22 14:30:05 +00003376** Convert a scalar expression node to a TK_REGISTER referencing
3377** register iReg. The caller must ensure that iReg already contains
3378** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003379*/
dan069d1b12019-06-16 08:58:14 +00003380static void exprToRegister(Expr *pExpr, int iReg){
3381 Expr *p = sqlite3ExprSkipCollate(pExpr);
drha4c3c872013-09-12 17:29:25 +00003382 p->op2 = p->op;
3383 p->op = TK_REGISTER;
3384 p->iTable = iReg;
3385 ExprClearProperty(p, EP_Skip);
3386}
3387
drh12abf402016-08-22 14:30:05 +00003388/*
3389** Evaluate an expression (either a vector or a scalar expression) and store
3390** the result in continguous temporary registers. Return the index of
3391** the first register used to store the result.
3392**
3393** If the returned result register is a temporary scalar, then also write
3394** that register number into *piFreeable. If the returned result register
3395** is not a temporary or if the expression is a vector set *piFreeable
3396** to 0.
3397*/
3398static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3399 int iResult;
3400 int nResult = sqlite3ExprVectorSize(p);
3401 if( nResult==1 ){
3402 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3403 }else{
3404 *piFreeable = 0;
3405 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003406#if SQLITE_OMIT_SUBQUERY
3407 iResult = 0;
3408#else
drh85bcdce2018-12-23 21:27:29 +00003409 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003410#endif
drh12abf402016-08-22 14:30:05 +00003411 }else{
3412 int i;
3413 iResult = pParse->nMem+1;
3414 pParse->nMem += nResult;
3415 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003416 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003417 }
3418 }
3419 }
3420 return iResult;
3421}
3422
dan71c57db2016-07-09 20:23:55 +00003423
drha4c3c872013-09-12 17:29:25 +00003424/*
drhcce7d172000-05-31 15:34:51 +00003425** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003426** expression. Attempt to store the results in register "target".
3427** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003428**
drh8b213892008-08-29 02:14:02 +00003429** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003430** be stored in target. The result might be stored in some other
3431** register if it is convenient to do so. The calling function
3432** must check the return code and move the results to the desired
3433** register.
drhcce7d172000-05-31 15:34:51 +00003434*/
drh678ccce2008-03-31 18:19:54 +00003435int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003436 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3437 int op; /* The opcode being coded */
3438 int inReg = target; /* Results stored in register inReg */
3439 int regFree1 = 0; /* If non-zero free this temporary register */
3440 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003441 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003442 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003443 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003444
drh9cbf3422008-01-17 16:22:13 +00003445 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003446 if( v==0 ){
3447 assert( pParse->db->mallocFailed );
3448 return 0;
3449 }
drh389a1ad2008-01-03 23:44:53 +00003450
drh1efa8022018-04-28 04:16:43 +00003451expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003452 if( pExpr==0 ){
3453 op = TK_NULL;
3454 }else{
3455 op = pExpr->op;
3456 }
drhf2bc0132004-10-04 13:19:23 +00003457 switch( op ){
drh13449892005-09-07 21:22:45 +00003458 case TK_AGG_COLUMN: {
3459 AggInfo *pAggInfo = pExpr->pAggInfo;
3460 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3461 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003462 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003463 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003464 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003465 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003466 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003467 return target;
drh13449892005-09-07 21:22:45 +00003468 }
3469 /* Otherwise, fall thru into the TK_COLUMN case */
3470 }
drh967e8b72000-06-21 13:59:10 +00003471 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003472 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003473 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003474 /* This COLUMN expression is really a constant due to WHERE clause
3475 ** constraints, and that constant is coded by the pExpr->pLeft
3476 ** expresssion. However, make sure the constant has the correct
3477 ** datatype by applying the Affinity of the table column to the
3478 ** constant.
3479 */
3480 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003481 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00003482 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003483 static const char zAff[] = "B\000C\000D\000E";
3484 assert( SQLITE_AFF_BLOB=='A' );
3485 assert( SQLITE_AFF_TEXT=='B' );
3486 if( iReg!=target ){
3487 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3488 iReg = target;
3489 }
3490 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3491 &zAff[(aff-'B')*2], P4_STATIC);
3492 }
3493 return iReg;
drhefad2e22018-07-27 16:57:11 +00003494 }
drhb2b9d3d2013-08-01 01:14:43 +00003495 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003496 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003497 /* Generating CHECK constraints or inserting into partial index */
drh6e97f8e2017-07-20 13:17:08 +00003498 return pExpr->iColumn - pParse->iSelfTab;
drhb2b9d3d2013-08-01 01:14:43 +00003499 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003500 /* Coding an expression that is part of an index where column names
3501 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003502 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003503 }
drh22827922000-06-06 17:27:05 +00003504 }
drheda079c2018-09-20 19:02:15 +00003505 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003506 pExpr->iColumn, iTab, target,
3507 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003508 }
3509 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003510 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003511 return target;
drhfec19aa2004-05-19 20:41:03 +00003512 }
drh8abed7b2018-02-26 18:49:05 +00003513 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003514 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003515 return target;
3516 }
drh13573c72010-01-12 17:04:07 +00003517#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003518 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003519 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3520 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003521 return target;
drh598f1342007-10-23 15:39:45 +00003522 }
drh13573c72010-01-12 17:04:07 +00003523#endif
drhfec19aa2004-05-19 20:41:03 +00003524 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003525 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003526 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003527 return target;
drhcce7d172000-05-31 15:34:51 +00003528 }
drhf0863fe2005-06-12 21:35:51 +00003529 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003530 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003531 return target;
drhf0863fe2005-06-12 21:35:51 +00003532 }
danielk19775338a5f2005-01-20 13:03:10 +00003533#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003534 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003535 int n;
3536 const char *z;
drhca48c902008-01-18 14:08:24 +00003537 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003538 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3539 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3540 assert( pExpr->u.zToken[1]=='\'' );
3541 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003542 n = sqlite3Strlen30(z) - 1;
3543 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003544 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3545 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003546 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003547 }
danielk19775338a5f2005-01-20 13:03:10 +00003548#endif
drh50457892003-09-06 01:10:47 +00003549 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003550 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3551 assert( pExpr->u.zToken!=0 );
3552 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003553 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3554 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003555 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003556 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003557 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003558 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003559 }
drhc332cc32016-09-19 10:24:19 +00003560 return target;
drh50457892003-09-06 01:10:47 +00003561 }
drh4e0cff62004-11-05 05:10:28 +00003562 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003563 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003564 }
drh487e2622005-06-25 18:42:14 +00003565#ifndef SQLITE_OMIT_CAST
3566 case TK_CAST: {
3567 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003568 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003569 if( inReg!=target ){
3570 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3571 inReg = target;
3572 }
drh4169e432014-08-25 20:11:52 +00003573 sqlite3VdbeAddOp2(v, OP_Cast, target,
3574 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003575 return inReg;
drh487e2622005-06-25 18:42:14 +00003576 }
3577#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003578 case TK_IS:
3579 case TK_ISNOT:
3580 op = (op==TK_IS) ? TK_EQ : TK_NE;
3581 p5 = SQLITE_NULLEQ;
3582 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003583 case TK_LT:
3584 case TK_LE:
3585 case TK_GT:
3586 case TK_GE:
3587 case TK_NE:
3588 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003589 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003590 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003591 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003592 }else{
3593 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3594 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3595 codeCompare(pParse, pLeft, pExpr->pRight, op,
3596 r1, r2, inReg, SQLITE_STOREP2 | p5);
3597 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3598 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3599 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3600 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3601 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3602 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3603 testcase( regFree1==0 );
3604 testcase( regFree2==0 );
3605 }
drh6a2fe092009-09-23 02:29:36 +00003606 break;
3607 }
drhcce7d172000-05-31 15:34:51 +00003608 case TK_AND:
3609 case TK_OR:
3610 case TK_PLUS:
3611 case TK_STAR:
3612 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003613 case TK_REM:
3614 case TK_BITAND:
3615 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003616 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003617 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003618 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003619 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003620 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3621 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3622 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3623 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3624 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3625 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3626 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3627 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3628 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3629 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3630 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003631 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3632 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003633 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003634 testcase( regFree1==0 );
3635 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003636 break;
3637 }
drhcce7d172000-05-31 15:34:51 +00003638 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003639 Expr *pLeft = pExpr->pLeft;
3640 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003641 if( pLeft->op==TK_INTEGER ){
3642 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003643 return target;
drh13573c72010-01-12 17:04:07 +00003644#ifndef SQLITE_OMIT_FLOATING_POINT
3645 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003646 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3647 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003648 return target;
drh13573c72010-01-12 17:04:07 +00003649#endif
drh3c84ddf2008-01-09 02:15:38 +00003650 }else{
drh10d1edf2013-11-15 15:52:39 +00003651 tempX.op = TK_INTEGER;
3652 tempX.flags = EP_IntValue|EP_TokenOnly;
3653 tempX.u.iValue = 0;
3654 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003655 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003656 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003657 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003658 }
drh3c84ddf2008-01-09 02:15:38 +00003659 break;
drh6e142f52000-06-08 13:36:40 +00003660 }
drhbf4133c2001-10-13 02:59:08 +00003661 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003662 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003663 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3664 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003665 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3666 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003667 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003668 break;
3669 }
drh8abed7b2018-02-26 18:49:05 +00003670 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003671 int isTrue; /* IS TRUE or IS NOT TRUE */
3672 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003673 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3674 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003675 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3676 bNormal = pExpr->op2==TK_IS;
3677 testcase( isTrue && bNormal);
3678 testcase( !isTrue && bNormal);
3679 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003680 break;
3681 }
drhcce7d172000-05-31 15:34:51 +00003682 case TK_ISNULL:
3683 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003684 int addr;
drh7d176102014-02-18 03:07:12 +00003685 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3686 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003687 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003688 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003689 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003690 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003691 VdbeCoverageIf(v, op==TK_ISNULL);
3692 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003693 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003694 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003695 break;
drhcce7d172000-05-31 15:34:51 +00003696 }
drh22827922000-06-06 17:27:05 +00003697 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003698 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003699 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003700 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3701 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003702 }else{
drhc332cc32016-09-19 10:24:19 +00003703 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003704 }
drh22827922000-06-06 17:27:05 +00003705 break;
3706 }
drhcce7d172000-05-31 15:34:51 +00003707 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003708 ExprList *pFarg; /* List of function arguments */
3709 int nFarg; /* Number of function arguments */
3710 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003711 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003712 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003713 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003714 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003715 u8 enc = ENC(db); /* The text encoding used by this database */
3716 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003717
dan67a9b8e2018-06-22 20:51:35 +00003718#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003719 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3720 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003721 }
dan67a9b8e2018-06-22 20:51:35 +00003722#endif
dan86fb6e12018-05-16 20:58:07 +00003723
drh1e9b53f2017-01-04 01:07:24 +00003724 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003725 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003726 ** out of the inner loop, even if that means an extra OP_Copy. */
3727 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003728 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003729 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003730 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003731 pFarg = 0;
3732 }else{
3733 pFarg = pExpr->x.pList;
3734 }
3735 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003736 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3737 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003738 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003739#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3740 if( pDef==0 && pParse->explain ){
3741 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3742 }
3743#endif
danb6e9f7a2018-05-19 14:15:29 +00003744 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003745 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003746 break;
3747 }
drhae6bb952009-11-11 00:24:31 +00003748
3749 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003750 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003751 ** arguments past the first non-NULL argument.
3752 */
drhd36e1042013-09-06 13:10:12 +00003753 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003754 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003755 assert( nFarg>=2 );
3756 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3757 for(i=1; i<nFarg; i++){
3758 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003759 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003760 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003761 }
3762 sqlite3VdbeResolveLabel(v, endCoalesce);
3763 break;
3764 }
3765
drhcca9f3d2013-09-06 15:23:29 +00003766 /* The UNLIKELY() function is a no-op. The result is the value
3767 ** of the first argument.
3768 */
3769 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3770 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003771 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003772 }
drhae6bb952009-11-11 00:24:31 +00003773
drh54240752017-01-03 14:39:30 +00003774#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003775 /* The AFFINITY() function evaluates to a string that describes
3776 ** the type affinity of the argument. This is used for testing of
3777 ** the SQLite type logic.
3778 */
3779 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3780 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3781 char aff;
3782 assert( nFarg==1 );
3783 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3784 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003785 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003786 return target;
3787 }
drh54240752017-01-03 14:39:30 +00003788#endif
drha1a523a2016-12-26 00:18:36 +00003789
drhd1a01ed2013-11-21 16:08:52 +00003790 for(i=0; i<nFarg; i++){
3791 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003792 testcase( i==31 );
3793 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003794 }
3795 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3796 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3797 }
3798 }
drh12ffee82009-04-08 13:51:51 +00003799 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003800 if( constMask ){
3801 r1 = pParse->nMem+1;
3802 pParse->nMem += nFarg;
3803 }else{
3804 r1 = sqlite3GetTempRange(pParse, nFarg);
3805 }
drha748fdc2012-03-28 01:34:47 +00003806
3807 /* For length() and typeof() functions with a column argument,
3808 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3809 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3810 ** loading.
3811 */
drhd36e1042013-09-06 13:10:12 +00003812 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003813 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003814 assert( nFarg==1 );
3815 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003816 exprOp = pFarg->a[0].pExpr->op;
3817 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003818 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3819 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003820 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3821 pFarg->a[0].pExpr->op2 =
3822 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003823 }
3824 }
3825
drh5579d592015-08-26 14:01:41 +00003826 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003827 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003828 }else{
drh12ffee82009-04-08 13:51:51 +00003829 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003830 }
drhb7f6f682006-07-08 17:06:43 +00003831#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003832 /* Possibly overload the function if the first argument is
3833 ** a virtual table column.
3834 **
3835 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3836 ** second argument, not the first, as the argument to test to
3837 ** see if it is a column in a virtual table. This is done because
3838 ** the left operand of infix functions (the operand we want to
3839 ** control overloading) ends up as the second argument to the
3840 ** function. The expression "A glob B" is equivalent to
3841 ** "glob(B,A). We want to use the A in "A glob B" to test
3842 ** for function overloading. But we use the B term in "glob(B,A)".
3843 */
drh59155062018-05-26 18:03:48 +00003844 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003845 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3846 }else if( nFarg>0 ){
3847 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003848 }
3849#endif
drhd36e1042013-09-06 13:10:12 +00003850 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003851 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003852 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003853 }
drh092457b2017-12-29 15:04:49 +00003854#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3855 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003856 Expr *pArg = pFarg->a[0].pExpr;
3857 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003858 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003859 }else{
3860 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3861 }
drh092457b2017-12-29 15:04:49 +00003862 }else
3863#endif
3864 {
drh2fc865c2017-12-16 20:20:37 +00003865 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3866 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3867 sqlite3VdbeChangeP5(v, (u8)nFarg);
3868 }
drhd1a01ed2013-11-21 16:08:52 +00003869 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003870 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003871 }
drhc332cc32016-09-19 10:24:19 +00003872 return target;
drhcce7d172000-05-31 15:34:51 +00003873 }
drhfe2093d2005-01-20 22:48:47 +00003874#ifndef SQLITE_OMIT_SUBQUERY
3875 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003876 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003877 int nCol;
drhc5499be2008-04-01 15:06:33 +00003878 testcase( op==TK_EXISTS );
3879 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003880 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3881 sqlite3SubselectError(pParse, nCol, 1);
3882 }else{
drh85bcdce2018-12-23 21:27:29 +00003883 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003884 }
drh19a775c2000-06-05 18:54:46 +00003885 break;
3886 }
drhfc7f27b2016-08-20 00:07:01 +00003887 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003888 int n;
drhfc7f27b2016-08-20 00:07:01 +00003889 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003890 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003891 }
drh966e2912017-01-03 02:58:01 +00003892 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3893 if( pExpr->iTable
3894 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3895 ){
3896 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3897 pExpr->iTable, n);
3898 }
drhc332cc32016-09-19 10:24:19 +00003899 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003900 }
drhfef52082000-06-06 01:50:43 +00003901 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003902 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3903 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003904 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3905 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3906 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3907 sqlite3VdbeResolveLabel(v, destIfFalse);
3908 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3909 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003910 return target;
drhfef52082000-06-06 01:50:43 +00003911 }
drhe3365e62009-11-12 17:52:24 +00003912#endif /* SQLITE_OMIT_SUBQUERY */
3913
3914
drh2dcef112008-01-12 19:03:48 +00003915 /*
3916 ** x BETWEEN y AND z
3917 **
3918 ** This is equivalent to
3919 **
3920 ** x>=y AND x<=z
3921 **
3922 ** X is stored in pExpr->pLeft.
3923 ** Y is stored in pExpr->pList->a[0].pExpr.
3924 ** Z is stored in pExpr->pList->a[1].pExpr.
3925 */
drhfef52082000-06-06 01:50:43 +00003926 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003927 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003928 return target;
drhfef52082000-06-06 01:50:43 +00003929 }
drh94fa9c42016-02-27 21:16:04 +00003930 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00003931 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00003932 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00003933 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00003934 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00003935 }
drh2dcef112008-01-12 19:03:48 +00003936
dan165921a2009-08-28 18:53:45 +00003937 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00003938 /* If the opcode is TK_TRIGGER, then the expression is a reference
3939 ** to a column in the new.* or old.* pseudo-tables available to
3940 ** trigger programs. In this case Expr.iTable is set to 1 for the
3941 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3942 ** is set to the column of the pseudo-table to read, or to -1 to
3943 ** read the rowid field.
3944 **
3945 ** The expression is implemented using an OP_Param opcode. The p1
3946 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
3947 ** to reference another column of the old.* pseudo-table, where
3948 ** i is the index of the column. For a new.rowid reference, p1 is
3949 ** set to (n+1), where n is the number of columns in each pseudo-table.
3950 ** For a reference to any other column in the new.* pseudo-table, p1
3951 ** is set to (n+2+i), where n and i are as defined previously. For
3952 ** example, if the table on which triggers are being fired is
3953 ** declared as:
3954 **
3955 ** CREATE TABLE t1(a, b);
3956 **
3957 ** Then p1 is interpreted as follows:
3958 **
3959 ** p1==0 -> old.rowid p1==3 -> new.rowid
3960 ** p1==1 -> old.a p1==4 -> new.a
3961 ** p1==2 -> old.b p1==5 -> new.b
3962 */
drheda079c2018-09-20 19:02:15 +00003963 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00003964 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
3965
3966 assert( pExpr->iTable==0 || pExpr->iTable==1 );
3967 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
3968 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
3969 assert( p1>=0 && p1<(pTab->nCol*2+2) );
3970
3971 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00003972 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00003973 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00003974 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00003975 ));
dan65a7cd12009-09-01 12:16:01 +00003976
drh44dbca82010-01-13 04:22:20 +00003977#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00003978 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00003979 ** integer. Use OP_RealAffinity to make sure it is really real.
3980 **
3981 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3982 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00003983 if( pExpr->iColumn>=0
3984 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3985 ){
3986 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3987 }
drh44dbca82010-01-13 04:22:20 +00003988#endif
dan165921a2009-08-28 18:53:45 +00003989 break;
3990 }
3991
dan71c57db2016-07-09 20:23:55 +00003992 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00003993 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00003994 break;
3995 }
3996
drh9e9a67a2019-08-17 17:07:15 +00003997 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
3998 ** that derive from the right-hand table of a LEFT JOIN. The
3999 ** Expr.iTable value is the table number for the right-hand table.
4000 ** The expression is only evaluated if that table is not currently
4001 ** on a LEFT JOIN NULL row.
4002 */
drh31d6fd52017-04-14 19:03:10 +00004003 case TK_IF_NULL_ROW: {
4004 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004005 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004006 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004007 /* Temporarily disable factoring of constant expressions, since
4008 ** even though expressions may appear to be constant, they are not
4009 ** really constant because they originate from the right-hand side
4010 ** of a LEFT JOIN. */
4011 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004012 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004013 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004014 sqlite3VdbeJumpHere(v, addrINR);
4015 sqlite3VdbeChangeP3(v, addrINR, inReg);
4016 break;
4017 }
4018
drh2dcef112008-01-12 19:03:48 +00004019 /*
4020 ** Form A:
4021 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4022 **
4023 ** Form B:
4024 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4025 **
4026 ** Form A is can be transformed into the equivalent form B as follows:
4027 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4028 ** WHEN x=eN THEN rN ELSE y END
4029 **
4030 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004031 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4032 ** odd. The Y is also optional. If the number of elements in x.pList
4033 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004034 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4035 **
4036 ** The result of the expression is the Ri for the first matching Ei,
4037 ** or if there is no matching Ei, the ELSE term Y, or if there is
4038 ** no ELSE term, NULL.
4039 */
drh33cd4902009-05-30 20:49:20 +00004040 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004041 int endLabel; /* GOTO label for end of CASE stmt */
4042 int nextCase; /* GOTO label for next WHEN clause */
4043 int nExpr; /* 2x number of WHEN terms */
4044 int i; /* Loop counter */
4045 ExprList *pEList; /* List of WHEN terms */
4046 struct ExprList_item *aListelem; /* Array of WHEN terms */
4047 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004048 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004049 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004050 Expr *pDel = 0;
4051 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004052
danielk19776ab3a2e2009-02-19 14:39:25 +00004053 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004054 assert(pExpr->x.pList->nExpr > 0);
4055 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004056 aListelem = pEList->a;
4057 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004058 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004059 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004060 pDel = sqlite3ExprDup(db, pX, 0);
4061 if( db->mallocFailed ){
4062 sqlite3ExprDelete(db, pDel);
4063 break;
4064 }
drh33cd4902009-05-30 20:49:20 +00004065 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004066 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004067 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004068 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004069 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004070 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004071 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004072 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4073 ** The value in regFree1 might get SCopy-ed into the file result.
4074 ** So make sure that the regFree1 register is not reused for other
4075 ** purposes and possibly overwritten. */
4076 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004077 }
drhc5cd1242013-09-12 16:50:49 +00004078 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004079 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004080 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004081 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004082 }else{
drh2dcef112008-01-12 19:03:48 +00004083 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004084 }
drhec4ccdb2018-12-29 02:26:59 +00004085 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004086 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004087 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004088 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004089 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004090 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004091 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004092 }
drhc5cd1242013-09-12 16:50:49 +00004093 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004094 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004095 }else{
drh9de221d2008-01-05 06:51:30 +00004096 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004097 }
dan8b65e592019-07-17 14:34:17 +00004098 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004099 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004100 break;
4101 }
danielk19775338a5f2005-01-20 13:03:10 +00004102#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004103 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004104 assert( pExpr->affExpr==OE_Rollback
4105 || pExpr->affExpr==OE_Abort
4106 || pExpr->affExpr==OE_Fail
4107 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004108 );
dane0af83a2009-09-08 19:15:01 +00004109 if( !pParse->pTriggerTab ){
4110 sqlite3ErrorMsg(pParse,
4111 "RAISE() may only be used within a trigger-program");
4112 return 0;
4113 }
drh11949042019-08-05 18:01:42 +00004114 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004115 sqlite3MayAbort(pParse);
4116 }
dan165921a2009-08-28 18:53:45 +00004117 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004118 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004119 sqlite3VdbeAddOp4(
4120 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004121 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004122 }else{
drh433dccf2013-02-09 15:37:11 +00004123 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004124 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004125 }
4126
drhffe07b22005-11-03 00:41:17 +00004127 break;
drh17a7f8d2002-03-24 13:13:27 +00004128 }
danielk19775338a5f2005-01-20 13:03:10 +00004129#endif
drhffe07b22005-11-03 00:41:17 +00004130 }
drh2dcef112008-01-12 19:03:48 +00004131 sqlite3ReleaseTempReg(pParse, regFree1);
4132 sqlite3ReleaseTempReg(pParse, regFree2);
4133 return inReg;
4134}
4135
4136/*
drhd1a01ed2013-11-21 16:08:52 +00004137** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004138**
drhad879ff2017-01-04 04:10:02 +00004139** If regDest>=0 then the result is always stored in that register and the
4140** result is not reusable. If regDest<0 then this routine is free to
4141** store the value whereever it wants. The register where the expression
4142** is stored is returned. When regDest<0, two identical expressions will
4143** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004144*/
drh1e9b53f2017-01-04 01:07:24 +00004145int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004146 Parse *pParse, /* Parsing context */
4147 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004148 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004149){
drhd1a01ed2013-11-21 16:08:52 +00004150 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004151 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004152 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004153 if( regDest<0 && p ){
4154 struct ExprList_item *pItem;
4155 int i;
4156 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004157 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004158 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004159 }
4160 }
drh1e9b53f2017-01-04 01:07:24 +00004161 }
drhd1a01ed2013-11-21 16:08:52 +00004162 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4163 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004164 if( p ){
4165 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004166 pItem->reusable = regDest<0;
4167 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004168 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004169 }
drhd1a01ed2013-11-21 16:08:52 +00004170 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004171 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004172}
4173
4174/*
drh2dcef112008-01-12 19:03:48 +00004175** Generate code to evaluate an expression and store the results
4176** into a register. Return the register number where the results
4177** are stored.
4178**
4179** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004180** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004181** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004182**
4183** If pExpr is a constant, then this routine might generate this
4184** code to fill the register in the initialization section of the
4185** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004186*/
4187int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004188 int r2;
4189 pExpr = sqlite3ExprSkipCollate(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004190 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004191 && pExpr->op!=TK_REGISTER
4192 && sqlite3ExprIsConstantNotJoin(pExpr)
4193 ){
drhf30a9692013-11-15 01:10:18 +00004194 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004195 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004196 }else{
drhf30a9692013-11-15 01:10:18 +00004197 int r1 = sqlite3GetTempReg(pParse);
4198 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4199 if( r2==r1 ){
4200 *pReg = r1;
4201 }else{
4202 sqlite3ReleaseTempReg(pParse, r1);
4203 *pReg = 0;
4204 }
drh2dcef112008-01-12 19:03:48 +00004205 }
4206 return r2;
4207}
4208
4209/*
4210** Generate code that will evaluate expression pExpr and store the
4211** results in register target. The results are guaranteed to appear
4212** in register target.
4213*/
drh05a86c52014-02-16 01:55:49 +00004214void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004215 int inReg;
4216
4217 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004218 if( pExpr && pExpr->op==TK_REGISTER ){
4219 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4220 }else{
4221 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004222 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004223 if( inReg!=target && pParse->pVdbe ){
4224 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4225 }
drhcce7d172000-05-31 15:34:51 +00004226 }
drhcce7d172000-05-31 15:34:51 +00004227}
4228
4229/*
drh1c75c9d2015-12-21 15:22:13 +00004230** Make a transient copy of expression pExpr and then code it using
4231** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4232** except that the input expression is guaranteed to be unchanged.
4233*/
4234void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4235 sqlite3 *db = pParse->db;
4236 pExpr = sqlite3ExprDup(db, pExpr, 0);
4237 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4238 sqlite3ExprDelete(db, pExpr);
4239}
4240
4241/*
drh05a86c52014-02-16 01:55:49 +00004242** Generate code that will evaluate expression pExpr and store the
4243** results in register target. The results are guaranteed to appear
4244** in register target. If the expression is constant, then this routine
4245** might choose to code the expression at initialization time.
4246*/
4247void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004248 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004249 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004250 }else{
4251 sqlite3ExprCode(pParse, pExpr, target);
4252 }
drhcce7d172000-05-31 15:34:51 +00004253}
4254
4255/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004256** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004257** in register target.
drh25303782004-12-07 15:41:48 +00004258**
drh2dcef112008-01-12 19:03:48 +00004259** Also make a copy of the expression results into another "cache" register
4260** and modify the expression so that the next time it is evaluated,
4261** the result is a copy of the cache register.
4262**
4263** This routine is used for expressions that are used multiple
4264** times. They are evaluated once and the results of the expression
4265** are reused.
drh25303782004-12-07 15:41:48 +00004266*/
drh05a86c52014-02-16 01:55:49 +00004267void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004268 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004269 int iMem;
4270
drhde4fcfd2008-01-19 23:50:26 +00004271 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004272 assert( pExpr->op!=TK_REGISTER );
4273 sqlite3ExprCode(pParse, pExpr, target);
4274 iMem = ++pParse->nMem;
4275 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4276 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004277}
drh2dcef112008-01-12 19:03:48 +00004278
drh678ccce2008-03-31 18:19:54 +00004279/*
drh268380c2004-02-25 13:47:31 +00004280** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004281** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004282**
drh3df6c3b2017-09-15 15:38:01 +00004283** Return the number of elements evaluated. The number returned will
4284** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4285** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004286**
4287** The SQLITE_ECEL_DUP flag prevents the arguments from being
4288** filled using OP_SCopy. OP_Copy must be used instead.
4289**
4290** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4291** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004292**
4293** The SQLITE_ECEL_REF flag means that expressions in the list with
4294** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4295** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004296** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4297** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004298*/
danielk19774adee202004-05-08 08:23:19 +00004299int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004300 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004301 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004302 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004303 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004304 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004305){
4306 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004307 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004308 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004309 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004310 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004311 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004312 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004313 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004314 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004315 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004316 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004317#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4318 if( pItem->bSorterRef ){
4319 i--;
4320 n--;
4321 }else
4322#endif
dan257c13f2016-11-10 20:14:06 +00004323 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4324 if( flags & SQLITE_ECEL_OMITREF ){
4325 i--;
4326 n--;
4327 }else{
4328 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4329 }
drhb8b06692018-08-04 15:16:20 +00004330 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4331 && sqlite3ExprIsConstantNotJoin(pExpr)
4332 ){
drhad879ff2017-01-04 04:10:02 +00004333 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004334 }else{
4335 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4336 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004337 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004338 if( copyOp==OP_Copy
4339 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4340 && pOp->p1+pOp->p3+1==inReg
4341 && pOp->p2+pOp->p3+1==target+i
4342 ){
4343 pOp->p3++;
4344 }else{
4345 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4346 }
drhd1a01ed2013-11-21 16:08:52 +00004347 }
drhd1766112008-09-17 00:13:12 +00004348 }
drh268380c2004-02-25 13:47:31 +00004349 }
drhf9b596e2004-05-26 16:54:42 +00004350 return n;
drh268380c2004-02-25 13:47:31 +00004351}
4352
4353/*
drh36c563a2009-11-12 13:32:22 +00004354** Generate code for a BETWEEN operator.
4355**
4356** x BETWEEN y AND z
4357**
4358** The above is equivalent to
4359**
4360** x>=y AND x<=z
4361**
4362** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004363** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004364**
4365** The xJumpIf parameter determines details:
4366**
4367** NULL: Store the boolean result in reg[dest]
4368** sqlite3ExprIfTrue: Jump to dest if true
4369** sqlite3ExprIfFalse: Jump to dest if false
4370**
4371** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004372*/
4373static void exprCodeBetween(
4374 Parse *pParse, /* Parsing and code generating context */
4375 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004376 int dest, /* Jump destination or storage location */
4377 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004378 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4379){
dan8b65e592019-07-17 14:34:17 +00004380 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004381 Expr compLeft; /* The x>=y term */
4382 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004383 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004384 Expr *pDel = 0;
4385 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004386
dan71c57db2016-07-09 20:23:55 +00004387 memset(&compLeft, 0, sizeof(Expr));
4388 memset(&compRight, 0, sizeof(Expr));
4389 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004390
4391 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004392 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4393 if( db->mallocFailed==0 ){
4394 exprAnd.op = TK_AND;
4395 exprAnd.pLeft = &compLeft;
4396 exprAnd.pRight = &compRight;
4397 compLeft.op = TK_GE;
4398 compLeft.pLeft = pDel;
4399 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4400 compRight.op = TK_LE;
4401 compRight.pLeft = pDel;
4402 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4403 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4404 if( xJump ){
4405 xJump(pParse, &exprAnd, dest, jumpIfNull);
4406 }else{
4407 /* Mark the expression is being from the ON or USING clause of a join
4408 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4409 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4410 ** for clarity, but we are out of bits in the Expr.flags field so we
4411 ** have to reuse the EP_FromJoin bit. Bummer. */
4412 pDel->flags |= EP_FromJoin;
4413 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4414 }
4415 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004416 }
dan8b65e592019-07-17 14:34:17 +00004417 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004418
4419 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004420 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==sqlite3ExprIfTrue && 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 );
4427 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004428 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004429}
4430
4431/*
drhcce7d172000-05-31 15:34:51 +00004432** Generate code for a boolean expression such that a jump is made
4433** to the label "dest" if the expression is true but execution
4434** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004435**
4436** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004437** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004438**
4439** This code depends on the fact that certain token values (ex: TK_EQ)
4440** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4441** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4442** the make process cause these values to align. Assert()s in the code
4443** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004444*/
danielk19774adee202004-05-08 08:23:19 +00004445void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004446 Vdbe *v = pParse->pVdbe;
4447 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004448 int regFree1 = 0;
4449 int regFree2 = 0;
4450 int r1, r2;
4451
drh35573352008-01-08 23:54:25 +00004452 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004453 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004454 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004455 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004456 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004457 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004458 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004459 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4460 if( pAlt!=pExpr ){
4461 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4462 }else if( op==TK_AND ){
4463 int d2 = sqlite3VdbeMakeLabel(pParse);
4464 testcase( jumpIfNull==0 );
4465 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4466 jumpIfNull^SQLITE_JUMPIFNULL);
4467 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4468 sqlite3VdbeResolveLabel(v, d2);
4469 }else{
4470 testcase( jumpIfNull==0 );
4471 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4472 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4473 }
drhcce7d172000-05-31 15:34:51 +00004474 break;
4475 }
4476 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004477 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004478 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004479 break;
4480 }
drh8abed7b2018-02-26 18:49:05 +00004481 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004482 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4483 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004484 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004485 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004486 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004487 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004488 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004489 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004490 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4491 isNot ? SQLITE_JUMPIFNULL : 0);
4492 }else{
4493 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4494 isNot ? SQLITE_JUMPIFNULL : 0);
4495 }
drh007c8432018-02-26 03:20:18 +00004496 break;
4497 }
drhde845c22016-03-17 19:07:52 +00004498 case TK_IS:
4499 case TK_ISNOT:
4500 testcase( op==TK_IS );
4501 testcase( op==TK_ISNOT );
4502 op = (op==TK_IS) ? TK_EQ : TK_NE;
4503 jumpIfNull = SQLITE_NULLEQ;
4504 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004505 case TK_LT:
4506 case TK_LE:
4507 case TK_GT:
4508 case TK_GE:
4509 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004510 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004511 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004512 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004513 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4514 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004515 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004516 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004517 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4518 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4519 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4520 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004521 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4522 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4523 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4524 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4525 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4526 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004527 testcase( regFree1==0 );
4528 testcase( regFree2==0 );
4529 break;
4530 }
drhcce7d172000-05-31 15:34:51 +00004531 case TK_ISNULL:
4532 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004533 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4534 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004535 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4536 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004537 VdbeCoverageIf(v, op==TK_ISNULL);
4538 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004539 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004540 break;
4541 }
drhfef52082000-06-06 01:50:43 +00004542 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004543 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004544 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004545 break;
4546 }
drh84e30ca2011-02-10 17:46:14 +00004547#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004548 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004549 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004550 int destIfNull = jumpIfNull ? dest : destIfFalse;
4551 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004552 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004553 sqlite3VdbeResolveLabel(v, destIfFalse);
4554 break;
4555 }
shanehbb201342011-02-09 19:55:20 +00004556#endif
drhcce7d172000-05-31 15:34:51 +00004557 default: {
dan7b35a772016-07-28 19:47:15 +00004558 default_expr:
drhad317272019-04-19 16:21:51 +00004559 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004560 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004561 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004562 /* No-op */
4563 }else{
4564 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4565 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004566 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004567 testcase( regFree1==0 );
4568 testcase( jumpIfNull==0 );
4569 }
drhcce7d172000-05-31 15:34:51 +00004570 break;
4571 }
4572 }
drh2dcef112008-01-12 19:03:48 +00004573 sqlite3ReleaseTempReg(pParse, regFree1);
4574 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004575}
4576
4577/*
drh66b89c82000-11-28 20:47:17 +00004578** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004579** to the label "dest" if the expression is false but execution
4580** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004581**
4582** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004583** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4584** is 0.
drhcce7d172000-05-31 15:34:51 +00004585*/
danielk19774adee202004-05-08 08:23:19 +00004586void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004587 Vdbe *v = pParse->pVdbe;
4588 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004589 int regFree1 = 0;
4590 int regFree2 = 0;
4591 int r1, r2;
4592
drh35573352008-01-08 23:54:25 +00004593 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004594 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004595 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004596
4597 /* The value of pExpr->op and op are related as follows:
4598 **
4599 ** pExpr->op op
4600 ** --------- ----------
4601 ** TK_ISNULL OP_NotNull
4602 ** TK_NOTNULL OP_IsNull
4603 ** TK_NE OP_Eq
4604 ** TK_EQ OP_Ne
4605 ** TK_GT OP_Le
4606 ** TK_LE OP_Gt
4607 ** TK_GE OP_Lt
4608 ** TK_LT OP_Ge
4609 **
4610 ** For other values of pExpr->op, op is undefined and unused.
4611 ** The value of TK_ and OP_ constants are arranged such that we
4612 ** can compute the mapping above using the following expression.
4613 ** Assert()s verify that the computation is correct.
4614 */
4615 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4616
4617 /* Verify correct alignment of TK_ and OP_ constants
4618 */
4619 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4620 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4621 assert( pExpr->op!=TK_NE || op==OP_Eq );
4622 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4623 assert( pExpr->op!=TK_LT || op==OP_Ge );
4624 assert( pExpr->op!=TK_LE || op==OP_Gt );
4625 assert( pExpr->op!=TK_GT || op==OP_Le );
4626 assert( pExpr->op!=TK_GE || op==OP_Lt );
4627
danba00e302016-07-23 20:24:06 +00004628 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004629 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004630 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004631 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4632 if( pAlt!=pExpr ){
4633 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4634 }else if( pExpr->op==TK_AND ){
4635 testcase( jumpIfNull==0 );
4636 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4637 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4638 }else{
4639 int d2 = sqlite3VdbeMakeLabel(pParse);
4640 testcase( jumpIfNull==0 );
4641 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4642 jumpIfNull^SQLITE_JUMPIFNULL);
4643 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4644 sqlite3VdbeResolveLabel(v, d2);
4645 }
drhcce7d172000-05-31 15:34:51 +00004646 break;
4647 }
4648 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004649 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004650 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004651 break;
4652 }
drh8abed7b2018-02-26 18:49:05 +00004653 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004654 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4655 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004656 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004657 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004658 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004659 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004660 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004661 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004662 /* IS TRUE and IS NOT FALSE */
4663 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4664 isNot ? 0 : SQLITE_JUMPIFNULL);
4665
4666 }else{
4667 /* IS FALSE and IS NOT TRUE */
4668 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004669 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004670 }
drh007c8432018-02-26 03:20:18 +00004671 break;
4672 }
drhde845c22016-03-17 19:07:52 +00004673 case TK_IS:
4674 case TK_ISNOT:
4675 testcase( pExpr->op==TK_IS );
4676 testcase( pExpr->op==TK_ISNOT );
4677 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4678 jumpIfNull = SQLITE_NULLEQ;
4679 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004680 case TK_LT:
4681 case TK_LE:
4682 case TK_GT:
4683 case TK_GE:
4684 case TK_NE:
4685 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004686 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004687 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004688 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4689 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004690 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004691 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004692 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4693 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4694 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4695 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004696 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4697 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4698 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4699 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4700 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4701 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004702 testcase( regFree1==0 );
4703 testcase( regFree2==0 );
4704 break;
4705 }
drhcce7d172000-05-31 15:34:51 +00004706 case TK_ISNULL:
4707 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004708 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4709 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004710 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4711 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004712 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004713 break;
4714 }
drhfef52082000-06-06 01:50:43 +00004715 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004716 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004717 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004718 break;
4719 }
drh84e30ca2011-02-10 17:46:14 +00004720#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004721 case TK_IN: {
4722 if( jumpIfNull ){
4723 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4724 }else{
drhec4ccdb2018-12-29 02:26:59 +00004725 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004726 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4727 sqlite3VdbeResolveLabel(v, destIfNull);
4728 }
4729 break;
4730 }
shanehbb201342011-02-09 19:55:20 +00004731#endif
drhcce7d172000-05-31 15:34:51 +00004732 default: {
danba00e302016-07-23 20:24:06 +00004733 default_expr:
drhad317272019-04-19 16:21:51 +00004734 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004735 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004736 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004737 /* no-op */
4738 }else{
4739 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4740 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004741 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004742 testcase( regFree1==0 );
4743 testcase( jumpIfNull==0 );
4744 }
drhcce7d172000-05-31 15:34:51 +00004745 break;
4746 }
4747 }
drh2dcef112008-01-12 19:03:48 +00004748 sqlite3ReleaseTempReg(pParse, regFree1);
4749 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004750}
drh22827922000-06-06 17:27:05 +00004751
4752/*
drh72bc8202015-06-11 13:58:35 +00004753** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4754** code generation, and that copy is deleted after code generation. This
4755** ensures that the original pExpr is unchanged.
4756*/
4757void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4758 sqlite3 *db = pParse->db;
4759 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4760 if( db->mallocFailed==0 ){
4761 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4762 }
4763 sqlite3ExprDelete(db, pCopy);
4764}
4765
dan5aa550c2017-06-24 18:10:29 +00004766/*
4767** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4768** type of expression.
4769**
4770** If pExpr is a simple SQL value - an integer, real, string, blob
4771** or NULL value - then the VDBE currently being prepared is configured
4772** to re-prepare each time a new value is bound to variable pVar.
4773**
4774** Additionally, if pExpr is a simple SQL value and the value is the
4775** same as that currently bound to variable pVar, non-zero is returned.
4776** Otherwise, if the values are not the same or if pExpr is not a simple
4777** SQL value, zero is returned.
4778*/
4779static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4780 int res = 0;
drhc0804222017-06-28 21:47:16 +00004781 int iVar;
4782 sqlite3_value *pL, *pR = 0;
4783
4784 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4785 if( pR ){
4786 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004787 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004788 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004789 if( pL ){
4790 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4791 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4792 }
4793 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004794 }
drhc0804222017-06-28 21:47:16 +00004795 sqlite3ValueFree(pR);
4796 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004797 }
4798
4799 return res;
4800}
drh72bc8202015-06-11 13:58:35 +00004801
4802/*
drh1d9da702010-01-07 15:17:02 +00004803** Do a deep comparison of two expression trees. Return 0 if the two
4804** expressions are completely identical. Return 1 if they differ only
4805** by a COLLATE operator at the top level. Return 2 if there are differences
4806** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004807**
drh619a1302013-08-01 13:04:46 +00004808** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4809** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4810**
drh66518ca2013-08-01 15:09:57 +00004811** The pA side might be using TK_REGISTER. If that is the case and pB is
4812** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4813**
drh1d9da702010-01-07 15:17:02 +00004814** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004815** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004816** identical, we return 2 just to be safe. So if this routine
4817** returns 2, then you do not really know for certain if the two
4818** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004819** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004820** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004821** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004822** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004823**
drhc0804222017-06-28 21:47:16 +00004824** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4825** pParse->pReprepare can be matched against literals in pB. The
4826** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4827** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4828** Argument pParse should normally be NULL. If it is not NULL and pA or
4829** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004830*/
dan5aa550c2017-06-24 18:10:29 +00004831int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004832 u32 combinedFlags;
4833 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004834 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004835 }
dan5aa550c2017-06-24 18:10:29 +00004836 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4837 return 0;
4838 }
drh10d1edf2013-11-15 15:52:39 +00004839 combinedFlags = pA->flags | pB->flags;
4840 if( combinedFlags & EP_IntValue ){
4841 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4842 return 0;
4843 }
drh1d9da702010-01-07 15:17:02 +00004844 return 2;
drh22827922000-06-06 17:27:05 +00004845 }
dan16dd3982018-12-20 15:04:38 +00004846 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004847 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004848 return 1;
4849 }
dan5aa550c2017-06-24 18:10:29 +00004850 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004851 return 1;
4852 }
4853 return 2;
4854 }
drh2edc5fd2015-11-24 02:10:52 +00004855 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00004856 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00004857 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004858#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00004859 assert( pA->op==pB->op );
4860 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4861 return 2;
4862 }
drheda079c2018-09-20 19:02:15 +00004863 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00004864 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
4865 return 2;
4866 }
drheda079c2018-09-20 19:02:15 +00004867 }
4868#endif
drhf20bbc52019-01-17 01:06:00 +00004869 }else if( pA->op==TK_NULL ){
4870 return 0;
drhd5af5422018-04-13 14:27:01 +00004871 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004872 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004873 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004874 return 2;
drh2646da72005-12-09 20:02:05 +00004875 }
drh22827922000-06-06 17:27:05 +00004876 }
drh10d1edf2013-11-15 15:52:39 +00004877 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004878 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004879 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004880 if( (combinedFlags & EP_FixedCol)==0
4881 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004882 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004883 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004884 if( pA->op!=TK_STRING
4885 && pA->op!=TK_TRUEFALSE
4886 && (combinedFlags & EP_Reduced)==0
4887 ){
drh10d1edf2013-11-15 15:52:39 +00004888 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00004889 if( pA->op2!=pB->op2 ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004890 if( pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004891 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004892 }
4893 }
drh1d9da702010-01-07 15:17:02 +00004894 return 0;
drh22827922000-06-06 17:27:05 +00004895}
4896
drh8c6f6662010-04-26 19:17:26 +00004897/*
4898** Compare two ExprList objects. Return 0 if they are identical and
4899** non-zero if they differ in any way.
4900**
drh619a1302013-08-01 13:04:46 +00004901** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4902** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4903**
drh8c6f6662010-04-26 19:17:26 +00004904** This routine might return non-zero for equivalent ExprLists. The
4905** only consequence will be disabled optimizations. But this routine
4906** must never return 0 if the two ExprList objects are different, or
4907** a malfunction will result.
4908**
4909** Two NULL pointers are considered to be the same. But a NULL pointer
4910** always differs from a non-NULL pointer.
4911*/
drh619a1302013-08-01 13:04:46 +00004912int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004913 int i;
4914 if( pA==0 && pB==0 ) return 0;
4915 if( pA==0 || pB==0 ) return 1;
4916 if( pA->nExpr!=pB->nExpr ) return 1;
4917 for(i=0; i<pA->nExpr; i++){
4918 Expr *pExprA = pA->a[i].pExpr;
4919 Expr *pExprB = pB->a[i].pExpr;
4920 if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004921 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004922 }
4923 return 0;
4924}
drh13449892005-09-07 21:22:45 +00004925
drh22827922000-06-06 17:27:05 +00004926/*
drhf9463df2017-02-11 14:59:58 +00004927** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4928** are ignored.
4929*/
4930int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00004931 return sqlite3ExprCompare(0,
drhf9463df2017-02-11 14:59:58 +00004932 sqlite3ExprSkipCollate(pA),
4933 sqlite3ExprSkipCollate(pB),
4934 iTab);
4935}
4936
4937/*
drhc51cf862019-05-11 19:36:03 +00004938** Return non-zero if Expr p can only be true if pNN is not NULL.
4939*/
4940static int exprImpliesNotNull(
4941 Parse *pParse, /* Parsing context */
4942 Expr *p, /* The expression to be checked */
4943 Expr *pNN, /* The expression that is NOT NULL */
4944 int iTab, /* Table being evaluated */
4945 int seenNot /* True if p is an operand of NOT */
4946){
4947 assert( p );
4948 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00004949 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
4950 return pNN->op!=TK_NULL;
4951 }
drhc51cf862019-05-11 19:36:03 +00004952 switch( p->op ){
4953 case TK_IN: {
4954 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4955 assert( ExprHasProperty(p,EP_xIsSelect)
4956 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4957 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4958 }
4959 case TK_BETWEEN: {
4960 ExprList *pList = p->x.pList;
4961 assert( pList!=0 );
4962 assert( pList->nExpr==2 );
4963 if( seenNot ) return 0;
4964 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4965 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4966 ){
4967 return 1;
4968 }
4969 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4970 }
4971 case TK_EQ:
4972 case TK_NE:
4973 case TK_LT:
4974 case TK_LE:
4975 case TK_GT:
4976 case TK_GE:
4977 case TK_PLUS:
4978 case TK_MINUS:
4979 case TK_STAR:
4980 case TK_REM:
4981 case TK_BITAND:
4982 case TK_BITOR:
4983 case TK_SLASH:
4984 case TK_LSHIFT:
4985 case TK_RSHIFT:
4986 case TK_CONCAT: {
4987 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
4988 /* Fall thru into the next case */
4989 }
4990 case TK_SPAN:
4991 case TK_COLLATE:
4992 case TK_BITNOT:
4993 case TK_UPLUS:
4994 case TK_UMINUS: {
4995 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4996 }
4997 case TK_TRUTH: {
4998 if( seenNot ) return 0;
4999 if( p->op2!=TK_IS ) return 0;
5000 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5001 }
5002 case TK_NOT: {
5003 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5004 }
5005 }
5006 return 0;
5007}
5008
5009/*
drh4bd5f732013-07-31 23:22:39 +00005010** Return true if we can prove the pE2 will always be true if pE1 is
5011** true. Return false if we cannot complete the proof or if pE2 might
5012** be false. Examples:
5013**
drh619a1302013-08-01 13:04:46 +00005014** pE1: x==5 pE2: x==5 Result: true
5015** pE1: x>0 pE2: x==5 Result: false
5016** pE1: x=21 pE2: x=21 OR y=43 Result: true
5017** pE1: x!=123 pE2: x IS NOT NULL Result: true
5018** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5019** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5020** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005021**
5022** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5023** Expr.iTable<0 then assume a table number given by iTab.
5024**
drhc0804222017-06-28 21:47:16 +00005025** If pParse is not NULL, then the values of bound variables in pE1 are
5026** compared against literal values in pE2 and pParse->pVdbe->expmask is
5027** modified to record which bound variables are referenced. If pParse
5028** is NULL, then false will be returned if pE1 contains any bound variables.
5029**
drh4bd5f732013-07-31 23:22:39 +00005030** When in doubt, return false. Returning true might give a performance
5031** improvement. Returning false might cause a performance reduction, but
5032** it will always give the correct answer and is hence always safe.
5033*/
dan5aa550c2017-06-24 18:10:29 +00005034int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5035 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005036 return 1;
5037 }
5038 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005039 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5040 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005041 ){
5042 return 1;
5043 }
drh664d6d12019-05-04 17:32:07 +00005044 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005045 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005046 ){
drhc51cf862019-05-11 19:36:03 +00005047 return 1;
drh619a1302013-08-01 13:04:46 +00005048 }
5049 return 0;
drh4bd5f732013-07-31 23:22:39 +00005050}
5051
5052/*
drh25897872018-03-20 21:16:15 +00005053** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5054** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005055** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5056**
5057** This routine controls an optimization. False positives (setting
5058** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5059** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005060*/
5061static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005062 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005063 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005064 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5065 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005066 case TK_ISNOT:
dana1054dc2018-04-10 12:10:01 +00005067 case TK_NOT:
drh25897872018-03-20 21:16:15 +00005068 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005069 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005070 case TK_IS:
5071 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005072 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005073 case TK_IN:
drh25897872018-03-20 21:16:15 +00005074 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00005075 testcase( pExpr->op==TK_ISNOT );
5076 testcase( pExpr->op==TK_NOT );
drh821b6102018-03-24 18:01:51 +00005077 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005078 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005079 testcase( pExpr->op==TK_IS );
5080 testcase( pExpr->op==TK_OR );
5081 testcase( pExpr->op==TK_CASE );
5082 testcase( pExpr->op==TK_IN );
5083 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005084 return WRC_Prune;
5085 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005086 if( pWalker->u.iCur==pExpr->iTable ){
5087 pWalker->eCode = 1;
5088 return WRC_Abort;
5089 }
5090 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005091
5092 /* Virtual tables are allowed to use constraints like x=NULL. So
5093 ** a term of the form x=y does not prove that y is not null if x
5094 ** is the column of a virtual table */
5095 case TK_EQ:
5096 case TK_NE:
5097 case TK_LT:
5098 case TK_LE:
5099 case TK_GT:
5100 case TK_GE:
5101 testcase( pExpr->op==TK_EQ );
5102 testcase( pExpr->op==TK_NE );
5103 testcase( pExpr->op==TK_LT );
5104 testcase( pExpr->op==TK_LE );
5105 testcase( pExpr->op==TK_GT );
5106 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005107 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5108 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005109 ){
5110 return WRC_Prune;
5111 }
drh25897872018-03-20 21:16:15 +00005112 default:
5113 return WRC_Continue;
5114 }
5115}
5116
5117/*
5118** Return true (non-zero) if expression p can only be true if at least
5119** one column of table iTab is non-null. In other words, return true
5120** if expression p will always be NULL or false if every column of iTab
5121** is NULL.
5122**
drh821b6102018-03-24 18:01:51 +00005123** False negatives are acceptable. In other words, it is ok to return
5124** zero even if expression p will never be true of every column of iTab
5125** is NULL. A false negative is merely a missed optimization opportunity.
5126**
5127** False positives are not allowed, however. A false positive may result
5128** in an incorrect answer.
5129**
drh25897872018-03-20 21:16:15 +00005130** Terms of p that are marked with EP_FromJoin (and hence that come from
5131** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5132**
5133** This routine is used to check if a LEFT JOIN can be converted into
5134** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5135** clause requires that some column of the right table of the LEFT JOIN
5136** be non-NULL, then the LEFT JOIN can be safely converted into an
5137** ordinary join.
5138*/
5139int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5140 Walker w;
drhd6db6592019-04-01 19:42:42 +00005141 p = sqlite3ExprSkipCollate(p);
5142 while( p ){
5143 if( p->op==TK_NOTNULL ){
5144 p = p->pLeft;
5145 }else if( p->op==TK_AND ){
5146 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5147 p = p->pRight;
5148 }else{
5149 break;
5150 }
5151 }
drh25897872018-03-20 21:16:15 +00005152 w.xExprCallback = impliesNotNullRow;
5153 w.xSelectCallback = 0;
5154 w.xSelectCallback2 = 0;
5155 w.eCode = 0;
5156 w.u.iCur = iTab;
5157 sqlite3WalkExpr(&w, p);
5158 return w.eCode;
5159}
5160
5161/*
drh030796d2012-08-23 16:18:10 +00005162** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005163** to determine if an expression can be evaluated by reference to the
5164** index only, without having to do a search for the corresponding
5165** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5166** is the cursor for the table.
5167*/
5168struct IdxCover {
5169 Index *pIdx; /* The index to be tested for coverage */
5170 int iCur; /* Cursor number for the table corresponding to the index */
5171};
5172
5173/*
5174** Check to see if there are references to columns in table
5175** pWalker->u.pIdxCover->iCur can be satisfied using the index
5176** pWalker->u.pIdxCover->pIdx.
5177*/
5178static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5179 if( pExpr->op==TK_COLUMN
5180 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5181 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5182 ){
5183 pWalker->eCode = 1;
5184 return WRC_Abort;
5185 }
5186 return WRC_Continue;
5187}
5188
5189/*
drhe604ec02016-07-27 19:20:58 +00005190** Determine if an index pIdx on table with cursor iCur contains will
5191** the expression pExpr. Return true if the index does cover the
5192** expression and false if the pExpr expression references table columns
5193** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005194**
5195** An index covering an expression means that the expression can be
5196** evaluated using only the index and without having to lookup the
5197** corresponding table entry.
5198*/
5199int sqlite3ExprCoveredByIndex(
5200 Expr *pExpr, /* The index to be tested */
5201 int iCur, /* The cursor number for the corresponding table */
5202 Index *pIdx /* The index that might be used for coverage */
5203){
5204 Walker w;
5205 struct IdxCover xcov;
5206 memset(&w, 0, sizeof(w));
5207 xcov.iCur = iCur;
5208 xcov.pIdx = pIdx;
5209 w.xExprCallback = exprIdxCover;
5210 w.u.pIdxCover = &xcov;
5211 sqlite3WalkExpr(&w, pExpr);
5212 return !w.eCode;
5213}
5214
5215
5216/*
5217** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005218** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005219** aggregate function, in order to implement the
5220** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005221*/
drh030796d2012-08-23 16:18:10 +00005222struct SrcCount {
5223 SrcList *pSrc; /* One particular FROM clause in a nested query */
5224 int nThis; /* Number of references to columns in pSrcList */
5225 int nOther; /* Number of references to columns in other FROM clauses */
5226};
5227
5228/*
5229** Count the number of references to columns.
5230*/
5231static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005232 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5233 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5234 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5235 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5236 ** NEVER() will need to be removed. */
5237 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005238 int i;
drh030796d2012-08-23 16:18:10 +00005239 struct SrcCount *p = pWalker->u.pSrcCount;
5240 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005241 int nSrc = pSrc ? pSrc->nSrc : 0;
5242 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005243 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005244 }
drh655814d2015-01-09 01:27:29 +00005245 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005246 p->nThis++;
5247 }else{
5248 p->nOther++;
5249 }
drh374fdce2012-04-17 16:38:53 +00005250 }
drh030796d2012-08-23 16:18:10 +00005251 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005252}
5253
5254/*
drh030796d2012-08-23 16:18:10 +00005255** Determine if any of the arguments to the pExpr Function reference
5256** pSrcList. Return true if they do. Also return true if the function
5257** has no arguments or has only constant arguments. Return false if pExpr
5258** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005259*/
drh030796d2012-08-23 16:18:10 +00005260int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005261 Walker w;
drh030796d2012-08-23 16:18:10 +00005262 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005263 assert( pExpr->op==TK_AGG_FUNCTION );
drh030796d2012-08-23 16:18:10 +00005264 w.xExprCallback = exprSrcCount;
drh979dd1b2017-05-29 14:26:07 +00005265 w.xSelectCallback = 0;
drh030796d2012-08-23 16:18:10 +00005266 w.u.pSrcCount = &cnt;
5267 cnt.pSrc = pSrcList;
5268 cnt.nThis = 0;
5269 cnt.nOther = 0;
5270 sqlite3WalkExprList(&w, pExpr->x.pList);
5271 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005272}
5273
5274/*
drh13449892005-09-07 21:22:45 +00005275** Add a new element to the pAggInfo->aCol[] array. Return the index of
5276** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005277*/
drh17435752007-08-16 04:30:38 +00005278static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005279 int i;
drhcf643722007-03-27 13:36:37 +00005280 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005281 db,
drhcf643722007-03-27 13:36:37 +00005282 pInfo->aCol,
5283 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005284 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005285 &i
5286 );
drh13449892005-09-07 21:22:45 +00005287 return i;
5288}
5289
5290/*
5291** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5292** the new element. Return a negative number if malloc fails.
5293*/
drh17435752007-08-16 04:30:38 +00005294static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005295 int i;
drhcf643722007-03-27 13:36:37 +00005296 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005297 db,
drhcf643722007-03-27 13:36:37 +00005298 pInfo->aFunc,
5299 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005300 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005301 &i
5302 );
drh13449892005-09-07 21:22:45 +00005303 return i;
5304}
drh22827922000-06-06 17:27:05 +00005305
5306/*
drh7d10d5a2008-08-20 16:35:10 +00005307** This is the xExprCallback for a tree walker. It is used to
5308** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005309** for additional information.
drh22827922000-06-06 17:27:05 +00005310*/
drh7d10d5a2008-08-20 16:35:10 +00005311static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005312 int i;
drh7d10d5a2008-08-20 16:35:10 +00005313 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005314 Parse *pParse = pNC->pParse;
5315 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005316 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005317
drh25c3b8c2018-04-16 10:34:13 +00005318 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005319 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005320 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005321 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005322 testcase( pExpr->op==TK_AGG_COLUMN );
5323 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005324 /* Check to see if the column is in one of the tables in the FROM
5325 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005326 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005327 struct SrcList_item *pItem = pSrcList->a;
5328 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5329 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005330 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005331 if( pExpr->iTable==pItem->iCursor ){
5332 /* If we reach this point, it means that pExpr refers to a table
5333 ** that is in the FROM clause of the aggregate query.
5334 **
5335 ** Make an entry for the column in pAggInfo->aCol[] if there
5336 ** is not an entry there already.
5337 */
drh7f906d62007-03-12 23:48:52 +00005338 int k;
drh13449892005-09-07 21:22:45 +00005339 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005340 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005341 if( pCol->iTable==pExpr->iTable &&
5342 pCol->iColumn==pExpr->iColumn ){
5343 break;
5344 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005345 }
danielk19771e536952007-08-16 10:09:01 +00005346 if( (k>=pAggInfo->nColumn)
5347 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5348 ){
drh7f906d62007-03-12 23:48:52 +00005349 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005350 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005351 pCol->iTable = pExpr->iTable;
5352 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005353 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005354 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005355 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005356 if( pAggInfo->pGroupBy ){
5357 int j, n;
5358 ExprList *pGB = pAggInfo->pGroupBy;
5359 struct ExprList_item *pTerm = pGB->a;
5360 n = pGB->nExpr;
5361 for(j=0; j<n; j++, pTerm++){
5362 Expr *pE = pTerm->pExpr;
5363 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5364 pE->iColumn==pExpr->iColumn ){
5365 pCol->iSorterColumn = j;
5366 break;
5367 }
5368 }
5369 }
5370 if( pCol->iSorterColumn<0 ){
5371 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5372 }
5373 }
5374 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5375 ** because it was there before or because we just created it).
5376 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5377 ** pAggInfo->aCol[] entry.
5378 */
drhebb6a652013-09-12 23:42:22 +00005379 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005380 pExpr->pAggInfo = pAggInfo;
5381 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005382 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005383 break;
5384 } /* endif pExpr->iTable==pItem->iCursor */
5385 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005386 }
drh7d10d5a2008-08-20 16:35:10 +00005387 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005388 }
5389 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005390 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005391 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005392 ){
drh13449892005-09-07 21:22:45 +00005393 /* Check to see if pExpr is a duplicate of another aggregate
5394 ** function that is already in the pAggInfo structure
5395 */
5396 struct AggInfo_func *pItem = pAggInfo->aFunc;
5397 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005398 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005399 break;
5400 }
drh22827922000-06-06 17:27:05 +00005401 }
drh13449892005-09-07 21:22:45 +00005402 if( i>=pAggInfo->nFunc ){
5403 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5404 */
danielk197714db2662006-01-09 16:12:04 +00005405 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005406 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005407 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005408 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005409 pItem = &pAggInfo->aFunc[i];
5410 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005411 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005412 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005413 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005414 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005415 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005416 if( pExpr->flags & EP_Distinct ){
5417 pItem->iDistinct = pParse->nTab++;
5418 }else{
5419 pItem->iDistinct = -1;
5420 }
drh13449892005-09-07 21:22:45 +00005421 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005422 }
drh13449892005-09-07 21:22:45 +00005423 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5424 */
drhc5cd1242013-09-12 16:50:49 +00005425 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005426 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005427 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005428 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005429 return WRC_Prune;
5430 }else{
5431 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005432 }
drh22827922000-06-06 17:27:05 +00005433 }
5434 }
drh7d10d5a2008-08-20 16:35:10 +00005435 return WRC_Continue;
5436}
5437static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005438 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005439 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005440 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005441}
drh979dd1b2017-05-29 14:26:07 +00005442static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5443 UNUSED_PARAMETER(pSelect);
5444 pWalker->walkerDepth--;
5445}
drh626a8792005-01-17 22:08:19 +00005446
5447/*
drhe8abb4c2012-11-02 18:24:57 +00005448** Analyze the pExpr expression looking for aggregate functions and
5449** for variables that need to be added to AggInfo object that pNC->pAggInfo
5450** points to. Additional entries are made on the AggInfo object as
5451** necessary.
drh626a8792005-01-17 22:08:19 +00005452**
5453** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005454** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005455*/
drhd2b3e232008-01-23 14:51:49 +00005456void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005457 Walker w;
5458 w.xExprCallback = analyzeAggregate;
5459 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005460 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5461 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005462 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005463 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005464 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005465 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005466}
drh5d9a4af2005-08-30 00:54:01 +00005467
5468/*
5469** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5470** expression list. Return the number of errors.
5471**
5472** If an error is found, the analysis is cut short.
5473*/
drhd2b3e232008-01-23 14:51:49 +00005474void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005475 struct ExprList_item *pItem;
5476 int i;
drh5d9a4af2005-08-30 00:54:01 +00005477 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005478 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5479 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005480 }
5481 }
drh5d9a4af2005-08-30 00:54:01 +00005482}
drh892d3172008-01-10 03:46:36 +00005483
5484/*
drhceea3322009-04-23 13:22:42 +00005485** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005486*/
5487int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005488 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005489 return ++pParse->nMem;
5490 }
danielk19772f425f62008-07-04 09:41:39 +00005491 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005492}
drhceea3322009-04-23 13:22:42 +00005493
5494/*
5495** Deallocate a register, making available for reuse for some other
5496** purpose.
drhceea3322009-04-23 13:22:42 +00005497*/
drh892d3172008-01-10 03:46:36 +00005498void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005499 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005500 pParse->aTempReg[pParse->nTempReg++] = iReg;
5501 }
5502}
5503
5504/*
drhed24da42016-09-06 14:37:05 +00005505** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005506*/
5507int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005508 int i, n;
drhed24da42016-09-06 14:37:05 +00005509 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005510 i = pParse->iRangeReg;
5511 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005512 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005513 pParse->iRangeReg += nReg;
5514 pParse->nRangeReg -= nReg;
5515 }else{
5516 i = pParse->nMem+1;
5517 pParse->nMem += nReg;
5518 }
5519 return i;
5520}
5521void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005522 if( nReg==1 ){
5523 sqlite3ReleaseTempReg(pParse, iReg);
5524 return;
5525 }
drh892d3172008-01-10 03:46:36 +00005526 if( nReg>pParse->nRangeReg ){
5527 pParse->nRangeReg = nReg;
5528 pParse->iRangeReg = iReg;
5529 }
5530}
drhcdc69552011-12-06 13:24:59 +00005531
5532/*
5533** Mark all temporary registers as being unavailable for reuse.
5534*/
5535void sqlite3ClearTempRegCache(Parse *pParse){
5536 pParse->nTempReg = 0;
5537 pParse->nRangeReg = 0;
5538}
drhbb9b5f22016-03-19 00:35:02 +00005539
5540/*
5541** Validate that no temporary register falls within the range of
5542** iFirst..iLast, inclusive. This routine is only call from within assert()
5543** statements.
5544*/
5545#ifdef SQLITE_DEBUG
5546int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5547 int i;
5548 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005549 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5550 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005551 ){
5552 return 0;
5553 }
5554 for(i=0; i<pParse->nTempReg; i++){
5555 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5556 return 0;
5557 }
5558 }
5559 return 1;
5560}
5561#endif /* SQLITE_DEBUG */