blob: 3b625a2de67bcf31d85caf20106615f70ef56004 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
drh1ccde152000-06-17 13:12:39 +000012** This file contains routines used for analyzing expressions and
drhb19a2bc2001-09-16 00:13:26 +000013** for generating VDBE code that evaluates expressions in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
drha2e00042002-01-22 03:13:42 +000016
drh12abf402016-08-22 14:30:05 +000017/* Forward declarations */
18static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
19static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
20
drh0dfa4f62016-08-26 13:19:49 +000021/*
22** Return the affinity character for a single column of a table.
23*/
24char sqlite3TableColumnAffinity(Table *pTab, int iCol){
25 assert( iCol<pTab->nCol );
26 return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
27}
drh12abf402016-08-22 14:30:05 +000028
danielk1977e014a832004-05-17 10:48:57 +000029/*
30** Return the 'affinity' of the expression pExpr if any.
31**
32** If pExpr is a column, a reference to a column via an 'AS' alias,
33** or a sub-select with a column as the return value, then the
34** affinity of that column is returned. Otherwise, 0x00 is returned,
35** indicating no affinity for the expression.
36**
peter.d.reid60ec9142014-09-06 16:39:46 +000037** i.e. the WHERE clause expressions in the following statements all
danielk1977e014a832004-05-17 10:48:57 +000038** have an affinity:
39**
40** CREATE TABLE t1(a);
41** SELECT * FROM t1 WHERE a;
42** SELECT a AS b FROM t1 WHERE b;
43** SELECT * FROM t1 WHERE (select a from t1);
44*/
danielk1977bf3b7212004-05-18 10:06:24 +000045char sqlite3ExprAffinity(Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
48 assert( pExpr->op==TK_COLLATE );
49 pExpr = pExpr->pLeft;
50 assert( pExpr!=0 );
51 }
drh580c8c12012-12-08 03:34:04 +000052 op = pExpr->op;
drh487e2622005-06-25 18:42:14 +000053 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000054 assert( pExpr->flags&EP_xIsSelect );
55 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000056 }
drhdb45bd52016-08-22 00:48:58 +000057 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000058#ifndef SQLITE_OMIT_CAST
59 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000060 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000061 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000062 }
63#endif
drheda079c2018-09-20 19:02:15 +000064 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000066 }
dan80aa5452016-09-03 19:52:12 +000067 if( op==TK_SELECT_COLUMN ){
68 assert( pExpr->pLeft->flags&EP_xIsSelect );
69 return sqlite3ExprAffinity(
70 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
71 );
72 }
drh11949042019-08-05 18:01:42 +000073 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000074}
75
drh53db1452004-05-20 13:54:53 +000076/*
drh8b4c40d2007-02-01 23:02:45 +000077** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000078** sequence named by pToken. Return a pointer to a new Expr node that
79** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000080**
81** If a memory allocation error occurs, that fact is recorded in pParse->db
82** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000083*/
drh4ef7efa2014-03-20 15:14:08 +000084Expr *sqlite3ExprAddCollateToken(
85 Parse *pParse, /* Parsing context */
86 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000087 const Token *pCollName, /* Name of collating sequence */
88 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000089){
drh0a8a4062012-12-07 18:38:16 +000090 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000091 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000092 if( pNew ){
93 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +000094 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +000095 pExpr = pNew;
96 }
drhae80dde2012-12-06 21:16:43 +000097 }
drh0a8a4062012-12-07 18:38:16 +000098 return pExpr;
99}
100Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000101 Token s;
102 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000103 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000104 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000105}
106
107/*
drh0d950af2019-08-22 16:38:42 +0000108** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000109*/
110Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000111 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
112 assert( pExpr->op==TK_COLLATE );
113 pExpr = pExpr->pLeft;
114 }
115 return pExpr;
116}
117
118/*
119** Skip over any TK_COLLATE operators and/or any unlikely()
120** or likelihood() or likely() functions at the root of an
121** expression.
122*/
123Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000124 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000125 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000126 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
127 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000128 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000129 pExpr = pExpr->x.pList->a[0].pExpr;
130 }else{
drh0b8d2552015-09-05 22:36:07 +0000131 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000132 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000133 }
drha4c3c872013-09-12 17:29:25 +0000134 }
drh0a8a4062012-12-07 18:38:16 +0000135 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000136}
137
138/*
drhae80dde2012-12-06 21:16:43 +0000139** Return the collation sequence for the expression pExpr. If
140** there is no defined collating sequence, return NULL.
141**
drh70efa842017-09-28 01:58:23 +0000142** See also: sqlite3ExprNNCollSeq()
143**
144** The sqlite3ExprNNCollSeq() works the same exact that it returns the
145** default collation if pExpr has no defined collation.
146**
drhae80dde2012-12-06 21:16:43 +0000147** The collating sequence might be determined by a COLLATE operator
148** or by the presence of a column with a defined collating sequence.
149** COLLATE operators take first precedence. Left operands take
150** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000151*/
danielk19777cedc8d2004-06-10 10:50:08 +0000152CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000153 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000154 CollSeq *pColl = 0;
drh7d10d5a2008-08-20 16:35:10 +0000155 Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000156 while( p ){
drhae80dde2012-12-06 21:16:43 +0000157 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000158 if( op==TK_REGISTER ) op = p->op2;
159 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000160 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000161 ){
drheda079c2018-09-20 19:02:15 +0000162 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000163 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000164 int j = p->iColumn;
165 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000166 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000167 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000168 }
169 break;
danielk19770202b292004-06-09 09:55:16 +0000170 }
drhe081d732018-07-27 18:19:12 +0000171 if( op==TK_CAST || op==TK_UPLUS ){
172 p = p->pLeft;
173 continue;
174 }
drhcb0e04f2018-12-12 21:34:17 +0000175 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000176 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
177 break;
178 }
drhae80dde2012-12-06 21:16:43 +0000179 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000180 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000181 p = p->pLeft;
182 }else{
drh2308ed32015-02-09 16:09:34 +0000183 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000184 /* The Expr.x union is never used at the same time as Expr.pRight */
185 assert( p->x.pList==0 || p->pRight==0 );
186 /* p->flags holds EP_Collate and p->pLeft->flags does not. And
187 ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
188 ** least one EP_Collate. Thus the following two ALWAYS. */
189 if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
drh2308ed32015-02-09 16:09:34 +0000190 int i;
drh6728cd92015-02-09 18:28:03 +0000191 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000192 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
193 pNext = p->x.pList->a[i].pExpr;
194 break;
195 }
196 }
197 }
198 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000199 }
200 }else{
drh7d10d5a2008-08-20 16:35:10 +0000201 break;
202 }
danielk19770202b292004-06-09 09:55:16 +0000203 }
danielk19777cedc8d2004-06-10 10:50:08 +0000204 if( sqlite3CheckCollSeq(pParse, pColl) ){
205 pColl = 0;
206 }
207 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000208}
209
210/*
drh70efa842017-09-28 01:58:23 +0000211** Return the collation sequence for the expression pExpr. If
212** there is no defined collating sequence, return a pointer to the
213** defautl collation sequence.
214**
215** See also: sqlite3ExprCollSeq()
216**
217** The sqlite3ExprCollSeq() routine works the same except that it
218** returns NULL if there is no defined collation.
219*/
220CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
221 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
222 if( p==0 ) p = pParse->db->pDfltColl;
223 assert( p!=0 );
224 return p;
225}
226
227/*
228** Return TRUE if the two expressions have equivalent collating sequences.
229*/
230int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
231 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
232 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
233 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
234}
235
236/*
drh626a8792005-01-17 22:08:19 +0000237** pExpr is an operand of a comparison operator. aff2 is the
238** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000239** type affinity that should be used for the comparison operator.
240*/
danielk1977e014a832004-05-17 10:48:57 +0000241char sqlite3CompareAffinity(Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000242 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000243 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000244 /* Both sides of the comparison are columns. If one has numeric
245 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000246 */
drh8a512562005-11-14 22:29:05 +0000247 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000248 return SQLITE_AFF_NUMERIC;
249 }else{
drh05883a32015-06-02 15:32:08 +0000250 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000251 }
danielk1977e014a832004-05-17 10:48:57 +0000252 }else{
253 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000254 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
255 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000256 }
257}
258
drh53db1452004-05-20 13:54:53 +0000259/*
260** pExpr is a comparison operator. Return the type affinity that should
261** be applied to both operands prior to doing the comparison.
262*/
danielk1977e014a832004-05-17 10:48:57 +0000263static char comparisonAffinity(Expr *pExpr){
264 char aff;
265 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
266 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000267 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000268 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000269 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000270 if( pExpr->pRight ){
271 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000272 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
273 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000274 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000275 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000276 }
277 return aff;
278}
279
280/*
281** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
282** idx_affinity is the affinity of an indexed column. Return true
283** if the index with affinity idx_affinity may be used to implement
284** the comparison in pExpr.
285*/
286int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
287 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000288 if( aff<SQLITE_AFF_TEXT ){
289 return 1;
drh8a512562005-11-14 22:29:05 +0000290 }
drh915e4342019-08-06 15:18:15 +0000291 if( aff==SQLITE_AFF_TEXT ){
292 return idx_affinity==SQLITE_AFF_TEXT;
293 }
294 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000295}
296
danielk1977a37cdde2004-05-16 11:15:36 +0000297/*
drh35573352008-01-08 23:54:25 +0000298** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000299** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000300*/
drh35573352008-01-08 23:54:25 +0000301static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
302 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000303 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000304 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000305}
306
drha2e00042002-01-22 03:13:42 +0000307/*
danielk19770202b292004-06-09 09:55:16 +0000308** Return a pointer to the collation sequence that should be used by
309** a binary comparison operator comparing pLeft and pRight.
310**
311** If the left hand expression has a collating sequence type, then it is
312** used. Otherwise the collation sequence for the right hand expression
313** is used, or the default (BINARY) if neither expression has a collating
314** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000315**
316** Argument pRight (but not pLeft) may be a null pointer. In this case,
317** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000318*/
drh0a0e1312007-08-07 17:04:59 +0000319CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000320 Parse *pParse,
321 Expr *pLeft,
322 Expr *pRight
323){
drhec41dda2007-02-07 13:09:45 +0000324 CollSeq *pColl;
325 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000326 if( pLeft->flags & EP_Collate ){
327 pColl = sqlite3ExprCollSeq(pParse, pLeft);
328 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
329 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000330 }else{
331 pColl = sqlite3ExprCollSeq(pParse, pLeft);
332 if( !pColl ){
333 pColl = sqlite3ExprCollSeq(pParse, pRight);
334 }
danielk19770202b292004-06-09 09:55:16 +0000335 }
336 return pColl;
337}
338
339/*
drhbe5c89a2004-07-26 00:31:09 +0000340** Generate code for a comparison operator.
341*/
342static int codeCompare(
343 Parse *pParse, /* The parsing (and code generating) context */
344 Expr *pLeft, /* The left operand */
345 Expr *pRight, /* The right operand */
346 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000347 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000348 int dest, /* Jump here if true. */
349 int jumpIfNull /* If true, jump if either operand is NULL */
350){
drh35573352008-01-08 23:54:25 +0000351 int p5;
352 int addr;
353 CollSeq *p4;
354
355 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
356 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
357 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
358 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000359 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000360 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000361}
362
dancfbb5e82016-07-13 19:48:13 +0000363/*
dan870a0702016-08-01 16:37:43 +0000364** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000365**
366** A vector is defined as any expression that results in two or more
367** columns of result. Every TK_VECTOR node is an vector because the
368** parser will not generate a TK_VECTOR with fewer than two entries.
369** But a TK_SELECT might be either a vector or a scalar. It is only
370** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000371*/
372int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000373 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000374}
375
376/*
dancfbb5e82016-07-13 19:48:13 +0000377** If the expression passed as the only argument is of type TK_VECTOR
378** return the number of expressions in the vector. Or, if the expression
379** is a sub-select, return the number of columns in the sub-select. For
380** any other type of expression, return 1.
381*/
dan71c57db2016-07-09 20:23:55 +0000382int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000383 u8 op = pExpr->op;
384 if( op==TK_REGISTER ) op = pExpr->op2;
385 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000386 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000387 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000388 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000389 }else{
390 return 1;
dan71c57db2016-07-09 20:23:55 +0000391 }
dan71c57db2016-07-09 20:23:55 +0000392}
393
danba00e302016-07-23 20:24:06 +0000394/*
drhfc7f27b2016-08-20 00:07:01 +0000395** Return a pointer to a subexpression of pVector that is the i-th
396** column of the vector (numbered starting with 0). The caller must
397** ensure that i is within range.
398**
drh76dbe7a2016-08-20 21:02:38 +0000399** If pVector is really a scalar (and "scalar" here includes subqueries
400** that return a single column!) then return pVector unmodified.
401**
drhfc7f27b2016-08-20 00:07:01 +0000402** pVector retains ownership of the returned subexpression.
403**
404** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000405** just the expression for the i-th term of the result set, and may
406** not be ready for evaluation because the table cursor has not yet
407** been positioned.
danba00e302016-07-23 20:24:06 +0000408*/
drhfc7f27b2016-08-20 00:07:01 +0000409Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000410 assert( i<sqlite3ExprVectorSize(pVector) );
411 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000412 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
413 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000414 return pVector->x.pSelect->pEList->a[i].pExpr;
415 }else{
416 return pVector->x.pList->a[i].pExpr;
417 }
dan71c57db2016-07-09 20:23:55 +0000418 }
dan870a0702016-08-01 16:37:43 +0000419 return pVector;
dan71c57db2016-07-09 20:23:55 +0000420}
drhfc7f27b2016-08-20 00:07:01 +0000421
drhfc7f27b2016-08-20 00:07:01 +0000422/*
423** Compute and return a new Expr object which when passed to
424** sqlite3ExprCode() will generate all necessary code to compute
425** the iField-th column of the vector expression pVector.
426**
drh8762ec12016-08-20 01:06:22 +0000427** It is ok for pVector to be a scalar (as long as iField==0).
428** In that case, this routine works like sqlite3ExprDup().
429**
drhfc7f27b2016-08-20 00:07:01 +0000430** The caller owns the returned Expr object and is responsible for
431** ensuring that the returned value eventually gets freed.
432**
drh8762ec12016-08-20 01:06:22 +0000433** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000434** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000435** valid for the life of the returned object. If pVector is a TK_VECTOR
436** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000437** returns.
drh8762ec12016-08-20 01:06:22 +0000438**
439** A trick to cause a TK_SELECT pVector to be deleted together with
440** the returned Expr object is to attach the pVector to the pRight field
441** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000442*/
443Expr *sqlite3ExprForVectorField(
444 Parse *pParse, /* Parsing context */
445 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000446 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000447){
448 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000449 if( pVector->op==TK_SELECT ){
450 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000451 /* The TK_SELECT_COLUMN Expr node:
452 **
drh966e2912017-01-03 02:58:01 +0000453 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000454 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000455 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000456 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000457 ** pLeft->iTable: First in an array of register holding result, or 0
458 ** if the result is not yet computed.
459 **
460 ** sqlite3ExprDelete() specifically skips the recursive delete of
461 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000462 ** can be attached to pRight to cause this node to take ownership of
463 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
464 ** with the same pLeft pointer to the pVector, but only one of them
465 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000466 */
drhabfd35e2016-12-06 22:47:23 +0000467 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000468 if( pRet ){
469 pRet->iColumn = iField;
470 pRet->pLeft = pVector;
471 }
drhfc7f27b2016-08-20 00:07:01 +0000472 assert( pRet==0 || pRet->iTable==0 );
473 }else{
drha1251bc2016-08-20 00:51:37 +0000474 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
475 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000476 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000477 }
478 return pRet;
479}
dan71c57db2016-07-09 20:23:55 +0000480
dan5c288b92016-07-30 21:02:33 +0000481/*
482** If expression pExpr is of type TK_SELECT, generate code to evaluate
483** it. Return the register in which the result is stored (or, if the
484** sub-select returns more than one column, the first in an array
485** of registers in which the result is stored).
486**
487** If pExpr is not a TK_SELECT expression, return 0.
488*/
489static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000490 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000491#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000492 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000493 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000494 }
danf9b2e052016-08-02 17:45:00 +0000495#endif
dan8da209b2016-07-26 18:06:08 +0000496 return reg;
497}
498
dan5c288b92016-07-30 21:02:33 +0000499/*
500** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000501** or TK_SELECT that returns more than one column. This function returns
502** the register number of a register that contains the value of
503** element iField of the vector.
504**
505** If pVector is a TK_SELECT expression, then code for it must have
506** already been generated using the exprCodeSubselect() routine. In this
507** case parameter regSelect should be the first in an array of registers
508** containing the results of the sub-select.
509**
510** If pVector is of type TK_VECTOR, then code for the requested field
511** is generated. In this case (*pRegFree) may be set to the number of
512** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000513**
514** Before returning, output parameter (*ppExpr) is set to point to the
515** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000516*/
517static int exprVectorRegister(
518 Parse *pParse, /* Parse context */
519 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000520 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000521 int regSelect, /* First in array of registers */
522 Expr **ppExpr, /* OUT: Expression element */
523 int *pRegFree /* OUT: Temp register to free */
524){
drh12abf402016-08-22 14:30:05 +0000525 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000526 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000527 if( op==TK_REGISTER ){
528 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
529 return pVector->iTable+iField;
530 }
531 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000532 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
533 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000534 }
dan870a0702016-08-01 16:37:43 +0000535 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000536 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
537}
538
539/*
540** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000541** the result of the comparison (1, 0, or NULL) and write that
542** result into register dest.
543**
544** The caller must satisfy the following preconditions:
545**
546** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
547** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
548** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000549*/
drh79752b62016-08-13 10:02:17 +0000550static void codeVectorCompare(
551 Parse *pParse, /* Code generator context */
552 Expr *pExpr, /* The comparison operation */
553 int dest, /* Write results into this register */
554 u8 op, /* Comparison operator */
555 u8 p5 /* SQLITE_NULLEQ or zero */
556){
dan71c57db2016-07-09 20:23:55 +0000557 Vdbe *v = pParse->pVdbe;
558 Expr *pLeft = pExpr->pLeft;
559 Expr *pRight = pExpr->pRight;
560 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000561 int i;
562 int regLeft = 0;
563 int regRight = 0;
564 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000565 int addrDone = sqlite3VdbeMakeLabel(pParse);
dan71c57db2016-07-09 20:23:55 +0000566
drh245ce622017-01-01 12:44:07 +0000567 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
568 sqlite3ErrorMsg(pParse, "row value misused");
569 return;
570 }
drhb29e60c2016-09-05 12:02:34 +0000571 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
572 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
573 || pExpr->op==TK_LT || pExpr->op==TK_GT
574 || pExpr->op==TK_LE || pExpr->op==TK_GE
575 );
576 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
577 || (pExpr->op==TK_ISNOT && op==TK_NE) );
578 assert( p5==0 || pExpr->op!=op );
579 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000580
drhb29e60c2016-09-05 12:02:34 +0000581 p5 |= SQLITE_STOREP2;
582 if( opx==TK_LE ) opx = TK_LT;
583 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000584
drhb29e60c2016-09-05 12:02:34 +0000585 regLeft = exprCodeSubselect(pParse, pLeft);
586 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000587
drhb29e60c2016-09-05 12:02:34 +0000588 for(i=0; 1 /*Loop exits by "break"*/; i++){
589 int regFree1 = 0, regFree2 = 0;
590 Expr *pL, *pR;
591 int r1, r2;
592 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000593 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
594 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
595 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
596 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
597 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
598 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
599 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
600 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
601 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
602 sqlite3ReleaseTempReg(pParse, regFree1);
603 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000604 if( i==nLeft-1 ){
605 break;
dan71c57db2016-07-09 20:23:55 +0000606 }
drhb29e60c2016-09-05 12:02:34 +0000607 if( opx==TK_EQ ){
608 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
609 p5 |= SQLITE_KEEPNULL;
610 }else if( opx==TK_NE ){
611 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
612 p5 |= SQLITE_KEEPNULL;
613 }else{
614 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
615 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
616 VdbeCoverageIf(v, op==TK_LT);
617 VdbeCoverageIf(v, op==TK_GT);
618 VdbeCoverageIf(v, op==TK_LE);
619 VdbeCoverageIf(v, op==TK_GE);
620 if( i==nLeft-2 ) opx = op;
621 }
dan71c57db2016-07-09 20:23:55 +0000622 }
drhb29e60c2016-09-05 12:02:34 +0000623 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000624}
625
danielk19774b5255a2008-06-05 16:47:39 +0000626#if SQLITE_MAX_EXPR_DEPTH>0
627/*
628** Check that argument nHeight is less than or equal to the maximum
629** expression depth allowed. If it is not, leave an error message in
630** pParse.
631*/
drh7d10d5a2008-08-20 16:35:10 +0000632int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000633 int rc = SQLITE_OK;
634 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
635 if( nHeight>mxHeight ){
636 sqlite3ErrorMsg(pParse,
637 "Expression tree is too large (maximum depth %d)", mxHeight
638 );
639 rc = SQLITE_ERROR;
640 }
641 return rc;
642}
643
644/* The following three functions, heightOfExpr(), heightOfExprList()
645** and heightOfSelect(), are used to determine the maximum height
646** of any expression tree referenced by the structure passed as the
647** first argument.
648**
649** If this maximum height is greater than the current value pointed
650** to by pnHeight, the second parameter, then set *pnHeight to that
651** value.
652*/
653static void heightOfExpr(Expr *p, int *pnHeight){
654 if( p ){
655 if( p->nHeight>*pnHeight ){
656 *pnHeight = p->nHeight;
657 }
658 }
659}
660static void heightOfExprList(ExprList *p, int *pnHeight){
661 if( p ){
662 int i;
663 for(i=0; i<p->nExpr; i++){
664 heightOfExpr(p->a[i].pExpr, pnHeight);
665 }
666 }
667}
dan1a3a3082018-01-18 19:00:54 +0000668static void heightOfSelect(Select *pSelect, int *pnHeight){
669 Select *p;
670 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000671 heightOfExpr(p->pWhere, pnHeight);
672 heightOfExpr(p->pHaving, pnHeight);
673 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000674 heightOfExprList(p->pEList, pnHeight);
675 heightOfExprList(p->pGroupBy, pnHeight);
676 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000677 }
678}
679
680/*
681** Set the Expr.nHeight variable in the structure passed as an
682** argument. An expression with no children, Expr.pList or
683** Expr.pSelect member has a height of 1. Any other expression
684** has a height equal to the maximum height of any other
685** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000686**
687** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
688** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000689*/
690static void exprSetHeight(Expr *p){
691 int nHeight = 0;
692 heightOfExpr(p->pLeft, &nHeight);
693 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000694 if( ExprHasProperty(p, EP_xIsSelect) ){
695 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000696 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000697 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000698 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000699 }
danielk19774b5255a2008-06-05 16:47:39 +0000700 p->nHeight = nHeight + 1;
701}
702
703/*
704** Set the Expr.nHeight variable using the exprSetHeight() function. If
705** the height is greater than the maximum allowed expression depth,
706** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000707**
708** Also propagate all EP_Propagate flags from the Expr.x.pList into
709** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000710*/
drh2308ed32015-02-09 16:09:34 +0000711void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000712 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000713 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000714 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000715}
716
717/*
718** Return the maximum height of any expression tree referenced
719** by the select statement passed as an argument.
720*/
721int sqlite3SelectExprHeight(Select *p){
722 int nHeight = 0;
723 heightOfSelect(p, &nHeight);
724 return nHeight;
725}
drh2308ed32015-02-09 16:09:34 +0000726#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
727/*
728** Propagate all EP_Propagate flags from the Expr.x.pList into
729** Expr.flags.
730*/
731void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
732 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
733 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
734 }
735}
736#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000737#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
738
drhbe5c89a2004-07-26 00:31:09 +0000739/*
drhb7916a72009-05-27 10:31:29 +0000740** This routine is the core allocator for Expr nodes.
741**
drha76b5df2002-02-23 02:32:10 +0000742** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000743** for this node and for the pToken argument is a single allocation
744** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000745** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000746**
747** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000748** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000749** parameter is ignored if pToken is NULL or if the token does not
750** appear to be quoted. If the quotes were of the form "..." (double-quotes)
751** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000752**
753** Special case: If op==TK_INTEGER and pToken points to a string that
754** can be translated into a 32-bit integer, then the token is not
755** stored in u.zToken. Instead, the integer values is written
756** into u.iValue and the EP_IntValue flag is set. No extra storage
757** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000758*/
drhb7916a72009-05-27 10:31:29 +0000759Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000760 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000761 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000762 const Token *pToken, /* Token argument. Might be NULL */
763 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000764){
drha76b5df2002-02-23 02:32:10 +0000765 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000766 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000767 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000768
drh575fad62016-02-05 13:38:36 +0000769 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000770 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000771 if( op!=TK_INTEGER || pToken->z==0
772 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
773 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000774 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000775 }
drhb7916a72009-05-27 10:31:29 +0000776 }
drh575fad62016-02-05 13:38:36 +0000777 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000778 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000779 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000780 pNew->op = (u8)op;
781 pNew->iAgg = -1;
782 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000783 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000784 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000785 pNew->u.iValue = iValue;
786 }else{
drh33e619f2009-05-28 01:00:55 +0000787 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000788 assert( pToken->z!=0 || pToken->n==0 );
789 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000790 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000791 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000792 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000793 }
drhb7916a72009-05-27 10:31:29 +0000794 }
795 }
796#if SQLITE_MAX_EXPR_DEPTH>0
797 pNew->nHeight = 1;
798#endif
799 }
drha76b5df2002-02-23 02:32:10 +0000800 return pNew;
801}
802
803/*
drhb7916a72009-05-27 10:31:29 +0000804** Allocate a new expression node from a zero-terminated token that has
805** already been dequoted.
806*/
807Expr *sqlite3Expr(
808 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
809 int op, /* Expression opcode */
810 const char *zToken /* Token argument. Might be NULL */
811){
812 Token x;
813 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000814 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000815 return sqlite3ExprAlloc(db, op, &x, 0);
816}
817
818/*
819** Attach subtrees pLeft and pRight to the Expr node pRoot.
820**
821** If pRoot==NULL that means that a memory allocation error has occurred.
822** In that case, delete the subtrees pLeft and pRight.
823*/
824void sqlite3ExprAttachSubtrees(
825 sqlite3 *db,
826 Expr *pRoot,
827 Expr *pLeft,
828 Expr *pRight
829){
830 if( pRoot==0 ){
831 assert( db->mallocFailed );
832 sqlite3ExprDelete(db, pLeft);
833 sqlite3ExprDelete(db, pRight);
834 }else{
835 if( pRight ){
836 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000837 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000838 }
839 if( pLeft ){
840 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000841 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000842 }
843 exprSetHeight(pRoot);
844 }
845}
846
847/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000848** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000849**
drhbf664462009-06-19 18:32:54 +0000850** One or both of the subtrees can be NULL. Return a pointer to the new
851** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
852** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000853*/
drh17435752007-08-16 04:30:38 +0000854Expr *sqlite3PExpr(
855 Parse *pParse, /* Parsing context */
856 int op, /* Expression opcode */
857 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000858 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000859){
drh5fb52ca2012-03-31 02:34:35 +0000860 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000861 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
862 if( p ){
863 memset(p, 0, sizeof(Expr));
864 p->op = op & 0xff;
865 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000866 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000867 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000868 }else{
869 sqlite3ExprDelete(pParse->db, pLeft);
870 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000871 }
drh4e0cff62004-11-05 05:10:28 +0000872 return p;
873}
874
875/*
drh08de4f72016-04-11 01:06:47 +0000876** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
877** do a memory allocation failure) then delete the pSelect object.
878*/
879void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
880 if( pExpr ){
881 pExpr->x.pSelect = pSelect;
882 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
883 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
884 }else{
885 assert( pParse->db->mallocFailed );
886 sqlite3SelectDelete(pParse->db, pSelect);
887 }
888}
889
890
891/*
drh91bb0ee2004-09-01 03:06:34 +0000892** Join two expressions using an AND operator. If either expression is
893** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000894**
895** If one side or the other of the AND is known to be false, then instead
896** of returning an AND expression, just return a constant expression with
897** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000898*/
drhd5c851c2019-04-19 13:38:34 +0000899Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
900 sqlite3 *db = pParse->db;
901 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000902 return pRight;
903 }else if( pRight==0 ){
904 return pLeft;
drhad317272019-04-19 16:21:51 +0000905 }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
drh8e34e402019-06-11 10:43:56 +0000906 sqlite3ExprUnmapAndDelete(pParse, pLeft);
907 sqlite3ExprUnmapAndDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000908 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000909 }else{
drhd5c851c2019-04-19 13:38:34 +0000910 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000911 }
912}
913
914/*
915** Construct a new expression node for a function with multiple
916** arguments.
917*/
drh954733b2018-07-27 23:33:16 +0000918Expr *sqlite3ExprFunction(
919 Parse *pParse, /* Parsing context */
920 ExprList *pList, /* Argument list */
921 Token *pToken, /* Name of the function */
922 int eDistinct /* SF_Distinct or SF_ALL or 0 */
923){
drha76b5df2002-02-23 02:32:10 +0000924 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000925 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000926 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000927 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000928 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000929 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000930 return 0;
931 }
drh954733b2018-07-27 23:33:16 +0000932 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
933 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
934 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000935 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000936 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000937 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000938 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000939 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000940 return pNew;
941}
942
943/*
drhfa6bc002004-09-07 16:19:52 +0000944** Assign a variable number to an expression that encodes a wildcard
945** in the original SQL statement.
946**
947** Wildcards consisting of a single "?" are assigned the next sequential
948** variable number.
949**
950** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +0000951** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +0000952** the SQL statement comes from an external source.
953**
drh51f49f12009-05-21 20:41:32 +0000954** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +0000955** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +0000956** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +0000957** assigned.
958*/
drhde25a882016-10-03 15:28:24 +0000959void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +0000960 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +0000961 const char *z;
drhf326d662016-12-23 13:30:53 +0000962 ynVar x;
drh17435752007-08-16 04:30:38 +0000963
drhfa6bc002004-09-07 16:19:52 +0000964 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +0000965 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +0000966 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +0000967 assert( z!=0 );
968 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +0000969 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +0000970 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +0000971 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +0000972 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +0000973 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +0000974 }else{
drhf326d662016-12-23 13:30:53 +0000975 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +0000976 if( z[0]=='?' ){
977 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
978 ** use it as the variable number */
979 i64 i;
drh18814df2017-01-31 03:52:34 +0000980 int bOk;
981 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
982 i = z[1]-'0'; /* The common case of ?N for a single digit N */
983 bOk = 1;
984 }else{
985 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
986 }
drh124c0b42011-06-01 18:15:55 +0000987 testcase( i==0 );
988 testcase( i==1 );
989 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
990 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
991 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
992 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
993 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +0000994 return;
drhfa6bc002004-09-07 16:19:52 +0000995 }
drh8e74e7b2017-01-31 12:41:48 +0000996 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +0000997 if( x>pParse->nVar ){
998 pParse->nVar = (int)x;
999 doAdd = 1;
1000 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1001 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001002 }
1003 }else{
1004 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1005 ** number as the prior appearance of the same name, or if the name
1006 ** has never appeared before, reuse the same variable number
1007 */
drh9bf755c2016-12-23 03:59:31 +00001008 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1009 if( x==0 ){
1010 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001011 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001012 }
drhfa6bc002004-09-07 16:19:52 +00001013 }
drhf326d662016-12-23 13:30:53 +00001014 if( doAdd ){
1015 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1016 }
1017 }
1018 pExpr->iColumn = x;
1019 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001020 sqlite3ErrorMsg(pParse, "too many SQL variables");
1021 }
drhfa6bc002004-09-07 16:19:52 +00001022}
1023
1024/*
danf6963f92009-11-23 14:39:14 +00001025** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001026*/
drh4f0010b2016-04-11 14:49:39 +00001027static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1028 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001029 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1030 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001031
1032 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1033 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001034 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001035#ifdef SQLITE_DEBUG
1036 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1037 assert( p->pLeft==0 );
1038 assert( p->pRight==0 );
1039 assert( p->x.pSelect==0 );
1040 }
1041#endif
1042 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001043 /* The Expr.x union is never used at the same time as Expr.pRight */
1044 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001045 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001046 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001047 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001048 sqlite3ExprDeleteNN(db, p->pRight);
1049 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001050 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001051 sqlite3SelectDelete(db, p->x.pSelect);
1052 }else{
1053 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001054#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001055 if( ExprHasProperty(p, EP_WinFunc) ){
1056 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001057 }
dan6ba7ab02019-07-02 11:56:47 +00001058#endif
dan8117f112019-07-10 20:16:53 +00001059 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001060 }
drh209bc522016-09-23 21:36:24 +00001061 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001062 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001063 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001064 }
drha2e00042002-01-22 03:13:42 +00001065}
drh4f0010b2016-04-11 14:49:39 +00001066void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1067 if( p ) sqlite3ExprDeleteNN(db, p);
1068}
drha2e00042002-01-22 03:13:42 +00001069
drh8e34e402019-06-11 10:43:56 +00001070/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1071** expression.
1072*/
1073void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1074 if( p ){
1075 if( IN_RENAME_OBJECT ){
1076 sqlite3RenameExprUnmap(pParse, p);
1077 }
1078 sqlite3ExprDeleteNN(pParse->db, p);
1079 }
1080}
1081
drhd2687b72005-08-12 22:56:09 +00001082/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001083** Return the number of bytes allocated for the expression structure
1084** passed as the first argument. This is always one of EXPR_FULLSIZE,
1085** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1086*/
1087static int exprStructSize(Expr *p){
1088 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001089 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1090 return EXPR_FULLSIZE;
1091}
1092
1093/*
drh33e619f2009-05-28 01:00:55 +00001094** The dupedExpr*Size() routines each return the number of bytes required
1095** to store a copy of an expression or expression tree. They differ in
1096** how much of the tree is measured.
1097**
1098** dupedExprStructSize() Size of only the Expr structure
1099** dupedExprNodeSize() Size of Expr + space for token
1100** dupedExprSize() Expr + token + subtree components
1101**
1102***************************************************************************
1103**
1104** The dupedExprStructSize() function returns two values OR-ed together:
1105** (1) the space required for a copy of the Expr structure only and
1106** (2) the EP_xxx flags that indicate what the structure size should be.
1107** The return values is always one of:
1108**
1109** EXPR_FULLSIZE
1110** EXPR_REDUCEDSIZE | EP_Reduced
1111** EXPR_TOKENONLYSIZE | EP_TokenOnly
1112**
1113** The size of the structure can be found by masking the return value
1114** of this routine with 0xfff. The flags can be found by masking the
1115** return value with EP_Reduced|EP_TokenOnly.
1116**
1117** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1118** (unreduced) Expr objects as they or originally constructed by the parser.
1119** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001120** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001121** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001122** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001123** to reduce a pristine expression tree from the parser. The implementation
1124** of dupedExprStructSize() contain multiple assert() statements that attempt
1125** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001126*/
1127static int dupedExprStructSize(Expr *p, int flags){
1128 int nSize;
drh33e619f2009-05-28 01:00:55 +00001129 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001130 assert( EXPR_FULLSIZE<=0xfff );
1131 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001132 if( 0==flags || p->op==TK_SELECT_COLUMN
1133#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001134 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001135#endif
1136 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001137 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001138 }else{
drhc5cd1242013-09-12 16:50:49 +00001139 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001140 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001141 assert( !ExprHasProperty(p, EP_MemToken) );
drhebb6a652013-09-12 23:42:22 +00001142 assert( !ExprHasProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001143 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001144 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1145 }else{
drhaecd8022013-09-13 18:15:15 +00001146 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001147 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1148 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001149 }
1150 return nSize;
1151}
1152
1153/*
drh33e619f2009-05-28 01:00:55 +00001154** This function returns the space in bytes required to store the copy
1155** of the Expr structure and a copy of the Expr.u.zToken string (if that
1156** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001157*/
1158static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001159 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1160 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001161 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001162 }
danielk1977bc739712009-03-23 04:33:32 +00001163 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001164}
1165
1166/*
1167** Return the number of bytes required to create a duplicate of the
1168** expression passed as the first argument. The second argument is a
1169** mask containing EXPRDUP_XXX flags.
1170**
1171** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001172** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001173**
1174** If the EXPRDUP_REDUCE flag is set, then the return value includes
1175** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1176** and Expr.pRight variables (but not for any structures pointed to or
1177** descended from the Expr.x.pList or Expr.x.pSelect variables).
1178*/
1179static int dupedExprSize(Expr *p, int flags){
1180 int nByte = 0;
1181 if( p ){
1182 nByte = dupedExprNodeSize(p, flags);
1183 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001184 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001185 }
1186 }
1187 return nByte;
1188}
1189
1190/*
1191** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1192** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001193** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001194** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001195** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001196** portion of the buffer copied into by this function.
1197*/
drh3c194692016-04-11 16:43:43 +00001198static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1199 Expr *pNew; /* Value to return */
1200 u8 *zAlloc; /* Memory space from which to build Expr object */
1201 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1202
drh575fad62016-02-05 13:38:36 +00001203 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001204 assert( p );
1205 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1206 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001207
drh3c194692016-04-11 16:43:43 +00001208 /* Figure out where to write the new Expr structure. */
1209 if( pzBuffer ){
1210 zAlloc = *pzBuffer;
1211 staticFlag = EP_Static;
1212 }else{
1213 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1214 staticFlag = 0;
1215 }
1216 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001217
drh3c194692016-04-11 16:43:43 +00001218 if( pNew ){
1219 /* Set nNewSize to the size allocated for the structure pointed to
1220 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1221 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1222 ** by the copy of the p->u.zToken string (if any).
1223 */
1224 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1225 const int nNewSize = nStructSize & 0xfff;
1226 int nToken;
1227 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1228 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001229 }else{
drh3c194692016-04-11 16:43:43 +00001230 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001231 }
drh3c194692016-04-11 16:43:43 +00001232 if( dupFlags ){
1233 assert( ExprHasProperty(p, EP_Reduced)==0 );
1234 memcpy(zAlloc, p, nNewSize);
1235 }else{
1236 u32 nSize = (u32)exprStructSize(p);
1237 memcpy(zAlloc, p, nSize);
1238 if( nSize<EXPR_FULLSIZE ){
1239 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1240 }
1241 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001242
drh3c194692016-04-11 16:43:43 +00001243 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1244 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1245 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1246 pNew->flags |= staticFlag;
1247
1248 /* Copy the p->u.zToken string, if any. */
1249 if( nToken ){
1250 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1251 memcpy(zToken, p->u.zToken, nToken);
1252 }
1253
drh209bc522016-09-23 21:36:24 +00001254 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001255 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1256 if( ExprHasProperty(p, EP_xIsSelect) ){
1257 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001258 }else{
drh3c194692016-04-11 16:43:43 +00001259 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001260 }
drh3c194692016-04-11 16:43:43 +00001261 }
1262
1263 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001264 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001265 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001266 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001267 pNew->pLeft = p->pLeft ?
1268 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1269 pNew->pRight = p->pRight ?
1270 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001271 }
dan67a9b8e2018-06-22 20:51:35 +00001272#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001273 if( ExprHasProperty(p, EP_WinFunc) ){
1274 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1275 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001276 }
dan67a9b8e2018-06-22 20:51:35 +00001277#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001278 if( pzBuffer ){
1279 *pzBuffer = zAlloc;
1280 }
1281 }else{
drh209bc522016-09-23 21:36:24 +00001282 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001283 if( pNew->op==TK_SELECT_COLUMN ){
1284 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001285 assert( p->iColumn==0 || p->pRight==0 );
1286 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001287 }else{
1288 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1289 }
drh3c194692016-04-11 16:43:43 +00001290 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001291 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001292 }
1293 }
1294 return pNew;
1295}
1296
1297/*
danbfe31e72014-01-15 14:17:31 +00001298** Create and return a deep copy of the object passed as the second
1299** argument. If an OOM condition is encountered, NULL is returned
1300** and the db->mallocFailed flag set.
1301*/
daneede6a52014-01-15 19:42:23 +00001302#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001303static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001304 With *pRet = 0;
1305 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001306 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001307 pRet = sqlite3DbMallocZero(db, nByte);
1308 if( pRet ){
1309 int i;
1310 pRet->nCte = p->nCte;
1311 for(i=0; i<p->nCte; i++){
1312 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1313 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1314 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1315 }
1316 }
1317 }
1318 return pRet;
1319}
daneede6a52014-01-15 19:42:23 +00001320#else
1321# define withDup(x,y) 0
1322#endif
dan4e9119d2014-01-13 15:12:23 +00001323
drha8389972018-12-06 22:04:19 +00001324#ifndef SQLITE_OMIT_WINDOWFUNC
1325/*
1326** The gatherSelectWindows() procedure and its helper routine
1327** gatherSelectWindowsCallback() are used to scan all the expressions
1328** an a newly duplicated SELECT statement and gather all of the Window
1329** objects found there, assembling them onto the linked list at Select->pWin.
1330*/
1331static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001332 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001333 Select *pSelect = pWalker->u.pSelect;
1334 Window *pWin = pExpr->y.pWin;
1335 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001336 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001337 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001338 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001339 }
1340 return WRC_Continue;
1341}
drha37b6a52018-12-06 22:12:18 +00001342static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1343 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1344}
drha8389972018-12-06 22:04:19 +00001345static void gatherSelectWindows(Select *p){
1346 Walker w;
1347 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001348 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1349 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001350 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001351 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001352 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001353}
1354#endif
1355
1356
drha76b5df2002-02-23 02:32:10 +00001357/*
drhff78bd22002-02-27 01:47:11 +00001358** The following group of routines make deep copies of expressions,
1359** expression lists, ID lists, and select statements. The copies can
1360** be deleted (by being passed to their respective ...Delete() routines)
1361** without effecting the originals.
1362**
danielk19774adee202004-05-08 08:23:19 +00001363** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1364** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001365** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001366**
drhad3cab52002-05-24 02:04:32 +00001367** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001368**
drhb7916a72009-05-27 10:31:29 +00001369** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001370** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1371** truncated version of the usual Expr structure that will be stored as
1372** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001373*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001374Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001375 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001376 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001377}
danielk19776ab3a2e2009-02-19 14:39:25 +00001378ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001379 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001380 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001381 int i;
drhb1637482017-01-03 00:27:16 +00001382 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001383 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001384 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001385 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001386 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001387 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001388 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001389 pOldItem = p->a;
1390 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001391 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001392 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001393 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001394 if( pOldExpr
1395 && pOldExpr->op==TK_SELECT_COLUMN
1396 && (pNewExpr = pItem->pExpr)!=0
1397 ){
1398 assert( pNewExpr->iColumn==0 || i>0 );
1399 if( pNewExpr->iColumn==0 ){
1400 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001401 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1402 }else{
1403 assert( i>0 );
1404 assert( pItem[-1].pExpr!=0 );
1405 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1406 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1407 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001408 }
1409 }
drh17435752007-08-16 04:30:38 +00001410 pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drhb7916a72009-05-27 10:31:29 +00001411 pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
dan6e118922019-08-12 16:36:38 +00001412 pItem->sortFlags = pOldItem->sortFlags;
drh3e7bc9c2004-02-21 19:17:17 +00001413 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001414 pItem->bNulls = pOldItem->bNulls;
drh2c036cf2013-06-26 00:34:13 +00001415 pItem->bSpanIsTab = pOldItem->bSpanIsTab;
dan24e25d32018-04-14 18:46:20 +00001416 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001417 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001418 }
1419 return pNew;
1420}
danielk197793758c82005-01-21 08:13:14 +00001421
1422/*
1423** If cursors, triggers, views and subqueries are all omitted from
1424** the build, then none of the following routines, except for
1425** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1426** called with a NULL argument.
1427*/
danielk19776a67fe82005-02-04 04:07:16 +00001428#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1429 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001430SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001431 SrcList *pNew;
1432 int i;
drh113088e2003-03-20 01:16:58 +00001433 int nByte;
drh575fad62016-02-05 13:38:36 +00001434 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001435 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001436 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001437 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001438 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001439 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001440 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001441 struct SrcList_item *pNewItem = &pNew->a[i];
1442 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001443 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001444 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001445 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1446 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1447 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001448 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001449 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001450 pNewItem->addrFillSub = pOldItem->addrFillSub;
1451 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001452 if( pNewItem->fg.isIndexedBy ){
1453 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1454 }
1455 pNewItem->pIBIndex = pOldItem->pIBIndex;
1456 if( pNewItem->fg.isTabFunc ){
1457 pNewItem->u1.pFuncArg =
1458 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1459 }
drhed8a3bb2005-06-06 21:19:56 +00001460 pTab = pNewItem->pTab = pOldItem->pTab;
1461 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001462 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001463 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001464 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1465 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001466 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001467 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001468 }
1469 return pNew;
1470}
drh17435752007-08-16 04:30:38 +00001471IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001472 IdList *pNew;
1473 int i;
drh575fad62016-02-05 13:38:36 +00001474 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001475 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001476 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001477 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001478 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001479 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001480 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001481 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001482 return 0;
1483 }
drh6c535152012-02-02 03:38:30 +00001484 /* Note that because the size of the allocation for p->a[] is not
1485 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1486 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001487 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001488 struct IdList_item *pNewItem = &pNew->a[i];
1489 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001490 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001491 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001492 }
1493 return pNew;
1494}
dana7466202017-02-03 14:44:52 +00001495Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1496 Select *pRet = 0;
1497 Select *pNext = 0;
1498 Select **pp = &pRet;
1499 Select *p;
1500
drh575fad62016-02-05 13:38:36 +00001501 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001502 for(p=pDup; p; p=p->pPrior){
1503 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1504 if( pNew==0 ) break;
1505 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1506 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1507 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1508 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1509 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1510 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1511 pNew->op = p->op;
1512 pNew->pNext = pNext;
1513 pNew->pPrior = 0;
1514 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001515 pNew->iLimit = 0;
1516 pNew->iOffset = 0;
1517 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1518 pNew->addrOpenEphm[0] = -1;
1519 pNew->addrOpenEphm[1] = -1;
1520 pNew->nSelectRow = p->nSelectRow;
1521 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001522#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001523 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001524 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001525 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001526#endif
drhfef37762018-07-10 19:48:35 +00001527 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001528 *pp = pNew;
1529 pp = &pNew->pPrior;
1530 pNext = pNew;
1531 }
1532
1533 return pRet;
drhff78bd22002-02-27 01:47:11 +00001534}
danielk197793758c82005-01-21 08:13:14 +00001535#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001536Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001537 assert( p==0 );
1538 return 0;
1539}
1540#endif
drhff78bd22002-02-27 01:47:11 +00001541
1542
1543/*
drha76b5df2002-02-23 02:32:10 +00001544** Add a new element to the end of an expression list. If pList is
1545** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001546**
drha19543f2017-09-15 15:17:48 +00001547** The pList argument must be either NULL or a pointer to an ExprList
1548** obtained from a prior call to sqlite3ExprListAppend(). This routine
1549** may not be used with an ExprList obtained from sqlite3ExprListDup().
1550** Reason: This routine assumes that the number of slots in pList->a[]
1551** is a power of two. That is true for sqlite3ExprListAppend() returns
1552** but is not necessarily true from the return value of sqlite3ExprListDup().
1553**
drhb7916a72009-05-27 10:31:29 +00001554** If a memory allocation error occurs, the entire list is freed and
1555** NULL is returned. If non-NULL is returned, then it is guaranteed
1556** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001557*/
drh17435752007-08-16 04:30:38 +00001558ExprList *sqlite3ExprListAppend(
1559 Parse *pParse, /* Parsing context */
1560 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001561 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001562){
drh43606172017-04-05 11:32:13 +00001563 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001564 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001565 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001566 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001567 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001568 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001569 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001570 }
drhc263f7c2016-01-18 13:18:54 +00001571 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001572 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001573 ExprList *pNew;
1574 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001575 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001576 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001577 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001578 }
drh43606172017-04-05 11:32:13 +00001579 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001580 }
drh43606172017-04-05 11:32:13 +00001581 pItem = &pList->a[pList->nExpr++];
drha8b97932017-05-31 02:58:30 +00001582 assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1583 assert( offsetof(struct ExprList_item,pExpr)==0 );
1584 memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
drh43606172017-04-05 11:32:13 +00001585 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001586 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001587
1588no_mem:
1589 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001590 sqlite3ExprDelete(db, pExpr);
1591 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001592 return 0;
drha76b5df2002-02-23 02:32:10 +00001593}
1594
1595/*
drh8762ec12016-08-20 01:06:22 +00001596** pColumns and pExpr form a vector assignment which is part of the SET
1597** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001598**
1599** (a,b,c) = (expr1,expr2,expr3)
1600** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1601**
1602** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001603** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001604** TK_SELECT_COLUMN expressions.
1605*/
1606ExprList *sqlite3ExprListAppendVector(
1607 Parse *pParse, /* Parsing context */
1608 ExprList *pList, /* List to which to append. Might be NULL */
1609 IdList *pColumns, /* List of names of LHS of the assignment */
1610 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1611){
1612 sqlite3 *db = pParse->db;
1613 int n;
1614 int i;
drh66860af2016-08-23 18:30:10 +00001615 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001616 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1617 ** exit prior to this routine being invoked */
1618 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001619 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001620
1621 /* If the RHS is a vector, then we can immediately check to see that
1622 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1623 ** wildcards ("*") in the result set of the SELECT must be expanded before
1624 ** we can do the size check, so defer the size check until code generation.
1625 */
1626 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001627 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1628 pColumns->nId, n);
1629 goto vector_append_error;
1630 }
drh966e2912017-01-03 02:58:01 +00001631
1632 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001633 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001634 assert( pSubExpr!=0 || db->mallocFailed );
1635 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1636 if( pSubExpr==0 ) continue;
1637 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001638 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1639 if( pList ){
drh66860af2016-08-23 18:30:10 +00001640 assert( pList->nExpr==iFirst+i+1 );
drha1251bc2016-08-20 00:51:37 +00001641 pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1642 pColumns->a[i].zName = 0;
1643 }
1644 }
drh966e2912017-01-03 02:58:01 +00001645
drhffe28052017-05-06 18:09:36 +00001646 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001647 Expr *pFirst = pList->a[iFirst].pExpr;
1648 assert( pFirst!=0 );
1649 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001650
drhf4dd26c2017-04-05 11:49:06 +00001651 /* Store the SELECT statement in pRight so it will be deleted when
1652 ** sqlite3ExprListDelete() is called */
1653 pFirst->pRight = pExpr;
1654 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001655
drhf4dd26c2017-04-05 11:49:06 +00001656 /* Remember the size of the LHS in iTable so that we can check that
1657 ** the RHS and LHS sizes match during code generation. */
1658 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001659 }
1660
1661vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001662 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001663 sqlite3IdListDelete(db, pColumns);
1664 return pList;
1665}
1666
1667/*
drhbc622bc2015-08-24 15:39:42 +00001668** Set the sort order for the last element on the given ExprList.
1669*/
dan6e118922019-08-12 16:36:38 +00001670void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001671 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001672 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001673 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001674
1675 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1676 assert( iSortOrder==SQLITE_SO_UNDEFINED
1677 || iSortOrder==SQLITE_SO_ASC
1678 || iSortOrder==SQLITE_SO_DESC
1679 );
1680 assert( eNulls==SQLITE_SO_UNDEFINED
1681 || eNulls==SQLITE_SO_ASC
1682 || eNulls==SQLITE_SO_DESC
1683 );
1684
dan9105fd52019-08-19 17:26:32 +00001685 pItem = &p->a[p->nExpr-1];
1686 assert( pItem->bNulls==0 );
1687 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1688 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001689 }
dan9105fd52019-08-19 17:26:32 +00001690 pItem->sortFlags = (u8)iSortOrder;
1691
1692 if( eNulls!=SQLITE_SO_UNDEFINED ){
1693 pItem->bNulls = 1;
1694 if( iSortOrder!=eNulls ){
1695 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1696 }
drhbc622bc2015-08-24 15:39:42 +00001697 }
drhbc622bc2015-08-24 15:39:42 +00001698}
1699
1700/*
drhb7916a72009-05-27 10:31:29 +00001701** Set the ExprList.a[].zName element of the most recently added item
1702** on the expression list.
1703**
1704** pList might be NULL following an OOM error. But pName should never be
1705** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1706** is set.
1707*/
1708void sqlite3ExprListSetName(
1709 Parse *pParse, /* Parsing context */
1710 ExprList *pList, /* List to which to add the span. */
1711 Token *pName, /* Name to be added */
1712 int dequote /* True to cause the name to be dequoted */
1713){
1714 assert( pList!=0 || pParse->db->mallocFailed!=0 );
1715 if( pList ){
1716 struct ExprList_item *pItem;
1717 assert( pList->nExpr>0 );
1718 pItem = &pList->a[pList->nExpr-1];
1719 assert( pItem->zName==0 );
1720 pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
drh244b9d62016-04-11 19:01:08 +00001721 if( dequote ) sqlite3Dequote(pItem->zName);
danc9461ec2018-08-29 21:00:16 +00001722 if( IN_RENAME_OBJECT ){
dan07e95232018-08-21 16:32:53 +00001723 sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
dan5be60c52018-08-15 20:28:39 +00001724 }
drhb7916a72009-05-27 10:31:29 +00001725 }
1726}
1727
1728/*
1729** Set the ExprList.a[].zSpan element of the most recently added item
1730** on the expression list.
1731**
1732** pList might be NULL following an OOM error. But pSpan should never be
1733** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1734** is set.
1735*/
1736void sqlite3ExprListSetSpan(
1737 Parse *pParse, /* Parsing context */
1738 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001739 const char *zStart, /* Start of the span */
1740 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001741){
1742 sqlite3 *db = pParse->db;
1743 assert( pList!=0 || db->mallocFailed!=0 );
1744 if( pList ){
1745 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1746 assert( pList->nExpr>0 );
drhb7916a72009-05-27 10:31:29 +00001747 sqlite3DbFree(db, pItem->zSpan);
drh9b2e0432017-12-27 19:43:22 +00001748 pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
drhb7916a72009-05-27 10:31:29 +00001749 }
1750}
1751
1752/*
danielk19777a15a4b2007-05-08 17:54:43 +00001753** If the expression list pEList contains more than iLimit elements,
1754** leave an error message in pParse.
1755*/
1756void sqlite3ExprListCheckLength(
1757 Parse *pParse,
1758 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001759 const char *zObject
1760){
drhb1a6c3c2008-03-20 16:30:17 +00001761 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001762 testcase( pEList && pEList->nExpr==mx );
1763 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001764 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001765 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1766 }
1767}
1768
1769/*
drha76b5df2002-02-23 02:32:10 +00001770** Delete an entire expression list.
1771*/
drhaffa8552016-04-11 18:25:05 +00001772static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001773 int i = pList->nExpr;
1774 struct ExprList_item *pItem = pList->a;
1775 assert( pList->nExpr>0 );
1776 do{
drh633e6d52008-07-28 19:34:53 +00001777 sqlite3ExprDelete(db, pItem->pExpr);
1778 sqlite3DbFree(db, pItem->zName);
drhb7916a72009-05-27 10:31:29 +00001779 sqlite3DbFree(db, pItem->zSpan);
drhac48b752017-04-05 11:57:56 +00001780 pItem++;
1781 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001782 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001783}
drhaffa8552016-04-11 18:25:05 +00001784void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1785 if( pList ) exprListDeleteNN(db, pList);
1786}
drha76b5df2002-02-23 02:32:10 +00001787
1788/*
drh2308ed32015-02-09 16:09:34 +00001789** Return the bitwise-OR of all Expr.flags fields in the given
1790** ExprList.
drh885a5b02015-02-09 15:21:36 +00001791*/
drh2308ed32015-02-09 16:09:34 +00001792u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001793 int i;
drh2308ed32015-02-09 16:09:34 +00001794 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001795 assert( pList!=0 );
1796 for(i=0; i<pList->nExpr; i++){
1797 Expr *pExpr = pList->a[i].pExpr;
1798 assert( pExpr!=0 );
1799 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001800 }
drh2308ed32015-02-09 16:09:34 +00001801 return m;
drh885a5b02015-02-09 15:21:36 +00001802}
1803
1804/*
drh7e6f9802017-09-04 00:33:04 +00001805** This is a SELECT-node callback for the expression walker that
1806** always "fails". By "fail" in this case, we mean set
1807** pWalker->eCode to zero and abort.
1808**
1809** This callback is used by multiple expression walkers.
1810*/
1811int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1812 UNUSED_PARAMETER(NotUsed);
1813 pWalker->eCode = 0;
1814 return WRC_Abort;
1815}
1816
1817/*
drh171d16b2018-02-26 20:15:54 +00001818** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001819** then convert it into an TK_TRUEFALSE term. Return non-zero if
1820** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001821*/
1822int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1823 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001824 if( !ExprHasProperty(pExpr, EP_Quoted)
1825 && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
1826 || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
drh171d16b2018-02-26 20:15:54 +00001827 ){
1828 pExpr->op = TK_TRUEFALSE;
drhad317272019-04-19 16:21:51 +00001829 ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
drh171d16b2018-02-26 20:15:54 +00001830 return 1;
1831 }
1832 return 0;
1833}
1834
drh43c4ac82018-02-26 21:26:27 +00001835/*
drh96acafb2018-02-27 14:49:25 +00001836** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001837** and 0 if it is FALSE.
1838*/
drh96acafb2018-02-27 14:49:25 +00001839int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001840 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001841 assert( pExpr->op==TK_TRUEFALSE );
1842 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1843 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1844 return pExpr->u.zToken[4]==0;
1845}
1846
drh17180fc2019-04-19 17:26:19 +00001847/*
1848** If pExpr is an AND or OR expression, try to simplify it by eliminating
1849** terms that are always true or false. Return the simplified expression.
1850** Or return the original expression if no simplification is possible.
1851**
1852** Examples:
1853**
1854** (x<10) AND true => (x<10)
1855** (x<10) AND false => false
1856** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1857** (x<10) AND (y=22 OR true) => (x<10)
1858** (y=22) OR true => true
1859*/
1860Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1861 assert( pExpr!=0 );
1862 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1863 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1864 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1865 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1866 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1867 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1868 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1869 }
1870 }
1871 return pExpr;
1872}
1873
drh171d16b2018-02-26 20:15:54 +00001874
1875/*
drh059b2d52014-10-24 19:28:09 +00001876** These routines are Walker callbacks used to check expressions to
1877** see if they are "constant" for some definition of constant. The
1878** Walker.eCode value determines the type of "constant" we are looking
1879** for.
drh73b211a2005-01-18 04:00:42 +00001880**
drh7d10d5a2008-08-20 16:35:10 +00001881** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001882**
drh059b2d52014-10-24 19:28:09 +00001883** sqlite3ExprIsConstant() pWalker->eCode==1
1884** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001885** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001886** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001887**
drh059b2d52014-10-24 19:28:09 +00001888** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1889** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001890**
drhfeada2d2014-09-24 13:20:22 +00001891** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
drh059b2d52014-10-24 19:28:09 +00001892** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
1893** an existing schema and 4 when processing a new statement. A bound
drhfeada2d2014-09-24 13:20:22 +00001894** parameter raises an error for new statements, but is silently converted
1895** to NULL for existing schemas. This allows sqlite_master tables that
1896** contain a bound parameter because they were generated by older versions
1897** of SQLite to be parsed by newer versions of SQLite without raising a
1898** malformed schema error.
drh626a8792005-01-17 22:08:19 +00001899*/
drh7d10d5a2008-08-20 16:35:10 +00001900static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00001901
drh059b2d52014-10-24 19:28:09 +00001902 /* If pWalker->eCode is 2 then any term of the expression that comes from
1903 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00001904 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00001905 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1906 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00001907 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00001908 }
1909
drh626a8792005-01-17 22:08:19 +00001910 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00001911 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00001912 ** and either pWalker->eCode==4 or 5 or the function has the
1913 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00001914 case TK_FUNCTION:
drh63f84572015-02-09 14:07:07 +00001915 if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
drhb1fba282013-11-21 14:33:48 +00001916 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001917 }else{
1918 pWalker->eCode = 0;
1919 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00001920 }
drh626a8792005-01-17 22:08:19 +00001921 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00001922 /* Convert "true" or "false" in a DEFAULT clause into the
1923 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00001924 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00001925 return WRC_Prune;
1926 }
1927 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00001928 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00001929 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00001930 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00001931 testcase( pExpr->op==TK_ID );
1932 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00001933 testcase( pExpr->op==TK_AGG_FUNCTION );
1934 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00001935 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00001936 return WRC_Continue;
1937 }
drh059b2d52014-10-24 19:28:09 +00001938 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1939 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00001940 }
drhf43ce0b2017-05-25 00:08:48 +00001941 /* Fall through */
1942 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00001943 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00001944 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00001945 testcase( pExpr->op==TK_IF_NULL_ROW );
1946 pWalker->eCode = 0;
1947 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00001948 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00001949 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00001950 /* Silently convert bound parameters that appear inside of CREATE
1951 ** statements into a NULL when parsing the CREATE statement text out
1952 ** of the sqlite_master table */
1953 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00001954 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00001955 /* A bound parameter in a CREATE statement that originates from
1956 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00001957 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00001958 return WRC_Abort;
1959 }
1960 /* Fall through */
drh626a8792005-01-17 22:08:19 +00001961 default:
drh6e341b92018-04-17 18:50:40 +00001962 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
1963 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00001964 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00001965 }
1966}
drh059b2d52014-10-24 19:28:09 +00001967static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00001968 Walker w;
drh059b2d52014-10-24 19:28:09 +00001969 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00001970 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00001971 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00001972#ifdef SQLITE_DEBUG
1973 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1974#endif
drh059b2d52014-10-24 19:28:09 +00001975 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00001976 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00001977 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00001978}
drh626a8792005-01-17 22:08:19 +00001979
1980/*
drh059b2d52014-10-24 19:28:09 +00001981** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00001982** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00001983**
1984** For the purposes of this function, a double-quoted string (ex: "abc")
1985** is considered a variable but a single-quoted string (ex: 'abc') is
1986** a constant.
drhfef52082000-06-06 01:50:43 +00001987*/
danielk19774adee202004-05-08 08:23:19 +00001988int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00001989 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00001990}
1991
1992/*
drh07aded62018-07-28 16:24:08 +00001993** Walk an expression tree. Return non-zero if
1994**
1995** (1) the expression is constant, and
1996** (2) the expression does originate in the ON or USING clause
1997** of a LEFT JOIN, and
1998** (3) the expression does not contain any EP_FixedCol TK_COLUMN
1999** operands created by the constant propagation optimization.
2000**
2001** When this routine returns true, it indicates that the expression
2002** can be added to the pParse->pConstExpr list and evaluated once when
2003** the prepared statement starts up. See sqlite3ExprCodeAtInit().
drh0a168372007-06-08 00:20:47 +00002004*/
2005int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002006 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002007}
2008
2009/*
drhfcb9f4f2015-06-01 18:13:16 +00002010** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002011** for any single row of the table with cursor iCur. In other words, the
2012** expression must not refer to any non-deterministic function nor any
2013** table other than iCur.
2014*/
2015int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2016 return exprIsConst(p, 3, iCur);
2017}
2018
danab31a842017-04-29 20:53:09 +00002019
2020/*
2021** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2022*/
2023static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2024 ExprList *pGroupBy = pWalker->u.pGroupBy;
2025 int i;
2026
2027 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2028 ** it constant. */
2029 for(i=0; i<pGroupBy->nExpr; i++){
2030 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002031 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002032 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002033 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002034 return WRC_Prune;
2035 }
2036 }
2037 }
2038
2039 /* Check if pExpr is a sub-select. If so, consider it variable. */
2040 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2041 pWalker->eCode = 0;
2042 return WRC_Abort;
2043 }
2044
2045 return exprNodeIsConstant(pWalker, pExpr);
2046}
2047
2048/*
2049** Walk the expression tree passed as the first argument. Return non-zero
2050** if the expression consists entirely of constants or copies of terms
2051** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002052**
2053** This routine is used to determine if a term of the HAVING clause can
2054** be promoted into the WHERE clause. In order for such a promotion to work,
2055** the value of the HAVING clause term must be the same for all members of
2056** a "group". The requirement that the GROUP BY term must be BINARY
2057** assumes that no other collating sequence will have a finer-grained
2058** grouping than binary. In other words (A=B COLLATE binary) implies
2059** A=B in every other collating sequence. The requirement that the
2060** GROUP BY be BINARY is stricter than necessary. It would also work
2061** to promote HAVING clauses that use the same alternative collating
2062** sequence as the GROUP BY term, but that is much harder to check,
2063** alternative collating sequences are uncommon, and this is only an
2064** optimization, so we take the easy way out and simply require the
2065** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002066*/
2067int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2068 Walker w;
danab31a842017-04-29 20:53:09 +00002069 w.eCode = 1;
2070 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002071 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002072 w.u.pGroupBy = pGroupBy;
2073 w.pParse = pParse;
2074 sqlite3WalkExpr(&w, p);
2075 return w.eCode;
2076}
2077
drh059b2d52014-10-24 19:28:09 +00002078/*
2079** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002080** or a function call with constant arguments. Return and 0 if there
2081** are any variables.
2082**
2083** For the purposes of this function, a double-quoted string (ex: "abc")
2084** is considered a variable but a single-quoted string (ex: 'abc') is
2085** a constant.
2086*/
drhfeada2d2014-09-24 13:20:22 +00002087int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2088 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002089 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002090}
2091
drh5b88bc42013-12-07 23:35:21 +00002092#ifdef SQLITE_ENABLE_CURSOR_HINTS
2093/*
2094** Walk an expression tree. Return 1 if the expression contains a
2095** subquery of some kind. Return 0 if there are no subqueries.
2096*/
2097int sqlite3ExprContainsSubquery(Expr *p){
2098 Walker w;
drhbec24762015-08-13 20:07:13 +00002099 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002100 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002101 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002102#ifdef SQLITE_DEBUG
2103 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2104#endif
drh5b88bc42013-12-07 23:35:21 +00002105 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002106 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002107}
2108#endif
2109
drheb55bd22005-06-30 17:04:21 +00002110/*
drh73b211a2005-01-18 04:00:42 +00002111** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002112** to fit in a 32-bit integer, return 1 and put the value of the integer
2113** in *pValue. If the expression is not an integer or if it is too big
2114** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002115*/
danielk19774adee202004-05-08 08:23:19 +00002116int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002117 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002118 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002119
2120 /* If an expression is an integer literal that fits in a signed 32-bit
2121 ** integer, then the EP_IntValue flag will have already been set */
2122 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2123 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2124
drh92b01d52008-06-24 00:32:35 +00002125 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002126 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002127 return 1;
2128 }
drhe4de1fe2002-06-02 16:09:01 +00002129 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002130 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002131 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002132 break;
drh4b59ab52002-08-24 18:24:51 +00002133 }
drhe4de1fe2002-06-02 16:09:01 +00002134 case TK_UMINUS: {
2135 int v;
danielk19774adee202004-05-08 08:23:19 +00002136 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002137 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002138 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002139 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002140 }
2141 break;
2142 }
2143 default: break;
2144 }
drh92b01d52008-06-24 00:32:35 +00002145 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002146}
2147
2148/*
drh039fc322009-11-17 18:31:47 +00002149** Return FALSE if there is no chance that the expression can be NULL.
2150**
2151** If the expression might be NULL or if the expression is too complex
2152** to tell return TRUE.
2153**
2154** This routine is used as an optimization, to skip OP_IsNull opcodes
2155** when we know that a value cannot be NULL. Hence, a false positive
2156** (returning TRUE when in fact the expression can never be NULL) might
2157** be a small performance hit but is otherwise harmless. On the other
2158** hand, a false negative (returning FALSE when the result could be NULL)
2159** will likely result in an incorrect answer. So when in doubt, return
2160** TRUE.
2161*/
2162int sqlite3ExprCanBeNull(const Expr *p){
2163 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002164 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2165 p = p->pLeft;
2166 }
drh039fc322009-11-17 18:31:47 +00002167 op = p->op;
2168 if( op==TK_REGISTER ) op = p->op2;
2169 switch( op ){
2170 case TK_INTEGER:
2171 case TK_STRING:
2172 case TK_FLOAT:
2173 case TK_BLOB:
2174 return 0;
drh7248a8b2014-08-04 18:50:54 +00002175 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002176 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002177 p->y.pTab==0 || /* Reference to column of index on expression */
2178 (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002179 default:
2180 return 1;
2181 }
2182}
2183
2184/*
2185** Return TRUE if the given expression is a constant which would be
2186** unchanged by OP_Affinity with the affinity given in the second
2187** argument.
2188**
2189** This routine is used to determine if the OP_Affinity operation
2190** can be omitted. When in doubt return FALSE. A false negative
2191** is harmless. A false positive, however, can result in the wrong
2192** answer.
2193*/
2194int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2195 u8 op;
drhaf866402019-08-22 11:11:28 +00002196 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002197 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002198 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2199 if( p->op==TK_UMINUS ) unaryMinus = 1;
2200 p = p->pLeft;
2201 }
drh039fc322009-11-17 18:31:47 +00002202 op = p->op;
2203 if( op==TK_REGISTER ) op = p->op2;
2204 switch( op ){
2205 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002206 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002207 }
2208 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002209 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002210 }
2211 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002212 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002213 }
2214 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002215 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002216 }
drh2f2855b2009-11-18 01:25:26 +00002217 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002218 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002219 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002220 }
drh039fc322009-11-17 18:31:47 +00002221 default: {
2222 return 0;
2223 }
2224 }
2225}
2226
2227/*
drhc4a3c772001-04-04 11:48:57 +00002228** Return TRUE if the given string is a row-id column name.
2229*/
danielk19774adee202004-05-08 08:23:19 +00002230int sqlite3IsRowid(const char *z){
2231 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2232 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2233 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002234 return 0;
2235}
2236
danielk19779a96b662007-11-29 17:05:18 +00002237/*
drh69c355b2016-03-09 15:34:51 +00002238** pX is the RHS of an IN operator. If pX is a SELECT statement
2239** that can be simplified to a direct table access, then return
2240** a pointer to the SELECT statement. If pX is not a SELECT statement,
2241** or if the SELECT statement needs to be manifested into a transient
2242** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002243*/
2244#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002245static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002246 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002247 SrcList *pSrc;
2248 ExprList *pEList;
2249 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002250 int i;
drh69c355b2016-03-09 15:34:51 +00002251 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2252 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2253 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002254 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002255 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002256 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2257 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2258 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002259 }
drhb74b1012009-05-28 21:04:37 +00002260 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002261 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002262 if( p->pWhere ) return 0; /* Has no WHERE clause */
2263 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002264 assert( pSrc!=0 );
2265 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002266 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002267 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002268 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002269 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002270 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2271 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002272 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002273 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002274 for(i=0; i<pEList->nExpr; i++){
2275 Expr *pRes = pEList->a[i].pExpr;
2276 if( pRes->op!=TK_COLUMN ) return 0;
2277 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002278 }
drh69c355b2016-03-09 15:34:51 +00002279 return p;
drhb287f4b2008-04-25 00:08:38 +00002280}
2281#endif /* SQLITE_OMIT_SUBQUERY */
2282
danf9b2e052016-08-02 17:45:00 +00002283#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002284/*
drh4c259e92014-08-01 21:12:35 +00002285** Generate code that checks the left-most column of index table iCur to see if
2286** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002287** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2288** to be set to NULL if iCur contains one or more NULL values.
2289*/
2290static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002291 int addr1;
drh6be515e2014-08-01 21:00:53 +00002292 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002293 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002294 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2295 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002296 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002297 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002298}
danf9b2e052016-08-02 17:45:00 +00002299#endif
drh6be515e2014-08-01 21:00:53 +00002300
drhbb53ecb2014-08-02 21:03:33 +00002301
2302#ifndef SQLITE_OMIT_SUBQUERY
2303/*
2304** The argument is an IN operator with a list (not a subquery) on the
2305** right-hand side. Return TRUE if that list is constant.
2306*/
2307static int sqlite3InRhsIsConstant(Expr *pIn){
2308 Expr *pLHS;
2309 int res;
2310 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2311 pLHS = pIn->pLeft;
2312 pIn->pLeft = 0;
2313 res = sqlite3ExprIsConstant(pIn);
2314 pIn->pLeft = pLHS;
2315 return res;
2316}
2317#endif
2318
drh6be515e2014-08-01 21:00:53 +00002319/*
danielk19779a96b662007-11-29 17:05:18 +00002320** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002321** The pX parameter is the expression on the RHS of the IN operator, which
2322** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002323**
drhd4305ca2012-09-18 17:08:33 +00002324** The job of this routine is to find or create a b-tree object that can
2325** be used either to test for membership in the RHS set or to iterate through
2326** all members of the RHS set, skipping duplicates.
2327**
drh3a856252014-08-01 14:46:57 +00002328** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002329** and pX->iTable is set to the index of that cursor.
2330**
drhb74b1012009-05-28 21:04:37 +00002331** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002332**
drh1ccce442013-03-12 20:38:51 +00002333** IN_INDEX_ROWID - The cursor was opened on a database table.
2334** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2335** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2336** IN_INDEX_EPH - The cursor was opened on a specially created and
2337** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002338** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2339** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002340**
drhd4305ca2012-09-18 17:08:33 +00002341** An existing b-tree might be used if the RHS expression pX is a simple
2342** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002343**
dan553168c2016-08-01 20:14:31 +00002344** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002345**
drhd4305ca2012-09-18 17:08:33 +00002346** If the RHS of the IN operator is a list or a more complex subquery, then
2347** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002348** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002349** existing table.
drhd4305ca2012-09-18 17:08:33 +00002350**
drh7fc0ba02017-11-17 15:02:00 +00002351** The inFlags parameter must contain, at a minimum, one of the bits
2352** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2353** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2354** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2355** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002356**
2357** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2358** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002359** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002360** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2361** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002362**
drh3a856252014-08-01 14:46:57 +00002363** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2364** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002365** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2366** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002367**
drhbb53ecb2014-08-02 21:03:33 +00002368** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2369** if the RHS of the IN operator is a list (not a subquery) then this
2370** routine might decide that creating an ephemeral b-tree for membership
2371** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2372** calling routine should implement the IN operator using a sequence
2373** of Eq or Ne comparison operations.
2374**
drhb74b1012009-05-28 21:04:37 +00002375** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002376** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002377** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002378** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002379** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002380** to *prRhsHasNull. If there is no chance that the (...) contains a
2381** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002382**
drhe21a6e12014-08-01 18:00:24 +00002383** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002384** the value in that register will be NULL if the b-tree contains one or more
2385** NULL values, and it will be some non-NULL value if the b-tree contains no
2386** NULL values.
dan553168c2016-08-01 20:14:31 +00002387**
2388** If the aiMap parameter is not NULL, it must point to an array containing
2389** one element for each column returned by the SELECT statement on the RHS
2390** of the IN(...) operator. The i'th entry of the array is populated with the
2391** offset of the index column that matches the i'th column returned by the
2392** SELECT. For example, if the expression and selected index are:
2393**
2394** (?,?,?) IN (SELECT a, b, c FROM t1)
2395** CREATE INDEX i1 ON t1(b, c, a);
2396**
2397** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002398*/
danielk1977284f4ac2007-12-10 05:03:46 +00002399#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002400int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002401 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002402 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002403 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2404 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002405 int *aiMap, /* Mapping from Index fields to RHS fields */
2406 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002407){
drhb74b1012009-05-28 21:04:37 +00002408 Select *p; /* SELECT to the right of IN operator */
2409 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2410 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002411 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002412 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002413
drh1450bc62009-10-30 13:25:56 +00002414 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002415 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002416
dan7b35a772016-07-28 19:47:15 +00002417 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2418 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002419 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002420 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002421 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002422 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2423 int i;
2424 ExprList *pEList = pX->x.pSelect->pEList;
2425 for(i=0; i<pEList->nExpr; i++){
2426 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2427 }
2428 if( i==pEList->nExpr ){
2429 prRhsHasNull = 0;
2430 }
2431 }
2432
drhb74b1012009-05-28 21:04:37 +00002433 /* Check to see if an existing table or index can be used to
2434 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002435 ** ephemeral table. */
2436 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002437 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002438 Table *pTab; /* Table <table>. */
danba00e302016-07-23 20:24:06 +00002439 i16 iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002440 ExprList *pEList = p->pEList;
2441 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002442
drhb07028f2011-10-14 21:49:18 +00002443 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2444 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2445 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2446 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002447
drhb22f7c82014-02-06 23:56:27 +00002448 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002449 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2450 sqlite3CodeVerifySchema(pParse, iDb);
2451 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002452
drha84a2832016-08-26 21:15:35 +00002453 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002454 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002455 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002456 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002457 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002458
2459 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2460 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002461 ExplainQueryPlan((pParse, 0,
2462 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002463 sqlite3VdbeJumpHere(v, iAddr);
2464 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002465 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002466 int affinity_ok = 1;
2467 int i;
2468
2469 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002470 ** comparison is the same as the affinity of each column in table
2471 ** on the RHS of the IN operator. If it not, it is not possible to
2472 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002473 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002474 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002475 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002476 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002477 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002478 testcase( cmpaff==SQLITE_AFF_BLOB );
2479 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002480 switch( cmpaff ){
2481 case SQLITE_AFF_BLOB:
2482 break;
2483 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002484 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2485 ** other has no affinity and the other side is TEXT. Hence,
2486 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2487 ** and for the term on the LHS of the IN to have no affinity. */
2488 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002489 break;
2490 default:
2491 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2492 }
2493 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002494
drha84a2832016-08-26 21:15:35 +00002495 if( affinity_ok ){
2496 /* Search for an existing index that will work for this IN operator */
2497 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2498 Bitmask colUsed; /* Columns of the index used */
2499 Bitmask mCol; /* Mask for the current column */
2500 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002501 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002502 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2503 ** BITMASK(nExpr) without overflowing */
2504 testcase( pIdx->nColumn==BMS-2 );
2505 testcase( pIdx->nColumn==BMS-1 );
2506 if( pIdx->nColumn>=BMS-1 ) continue;
2507 if( mustBeUnique ){
2508 if( pIdx->nKeyCol>nExpr
2509 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2510 ){
2511 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002512 }
danielk19770cdc0222008-06-26 18:04:03 +00002513 }
drha84a2832016-08-26 21:15:35 +00002514
2515 colUsed = 0; /* Columns of index used so far */
2516 for(i=0; i<nExpr; i++){
2517 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2518 Expr *pRhs = pEList->a[i].pExpr;
2519 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2520 int j;
2521
2522 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2523 for(j=0; j<nExpr; j++){
2524 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2525 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002526 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2527 continue;
2528 }
drha84a2832016-08-26 21:15:35 +00002529 break;
2530 }
2531 if( j==nExpr ) break;
2532 mCol = MASKBIT(j);
2533 if( mCol & colUsed ) break; /* Each column used only once */
2534 colUsed |= mCol;
2535 if( aiMap ) aiMap[i] = j;
2536 }
2537
2538 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2539 if( colUsed==(MASKBIT(nExpr)-1) ){
2540 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002541 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002542 ExplainQueryPlan((pParse, 0,
2543 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002544 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2545 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2546 VdbeComment((v, "%s", pIdx->zName));
2547 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2548 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2549
2550 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002551#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002552 i64 mask = (1<<nExpr)-1;
2553 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2554 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002555#endif
2556 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002557 if( nExpr==1 ){
2558 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2559 }
2560 }
2561 sqlite3VdbeJumpHere(v, iAddr);
2562 }
2563 } /* End loop over indexes */
2564 } /* End if( affinity_ok ) */
2565 } /* End if not an rowid index */
2566 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002567
drhbb53ecb2014-08-02 21:03:33 +00002568 /* If no preexisting index is available for the IN clause
2569 ** and IN_INDEX_NOOP is an allowed reply
2570 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002571 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002572 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002573 ** the IN operator so return IN_INDEX_NOOP.
2574 */
2575 if( eType==0
2576 && (inFlags & IN_INDEX_NOOP_OK)
2577 && !ExprHasProperty(pX, EP_xIsSelect)
2578 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2579 ){
2580 eType = IN_INDEX_NOOP;
2581 }
drhbb53ecb2014-08-02 21:03:33 +00002582
danielk19779a96b662007-11-29 17:05:18 +00002583 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002584 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002585 ** We will have to generate an ephemeral table to do the job.
2586 */
drh8e23daf2013-06-11 13:30:04 +00002587 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002588 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002589 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002590 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002591 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002592 }else if( prRhsHasNull ){
2593 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002594 }
drh85bcdce2018-12-23 21:27:29 +00002595 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002596 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002597 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002598 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002599 }
drhcf4d38a2010-07-28 02:53:36 +00002600 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002601 }
danba00e302016-07-23 20:24:06 +00002602
2603 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2604 int i, n;
2605 n = sqlite3ExprVectorSize(pX->pLeft);
2606 for(i=0; i<n; i++) aiMap[i] = i;
2607 }
drh2c041312018-12-24 02:34:49 +00002608 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002609 return eType;
2610}
danielk1977284f4ac2007-12-10 05:03:46 +00002611#endif
drh626a8792005-01-17 22:08:19 +00002612
danf9b2e052016-08-02 17:45:00 +00002613#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002614/*
2615** Argument pExpr is an (?, ?...) IN(...) expression. This
2616** function allocates and returns a nul-terminated string containing
2617** the affinities to be used for each column of the comparison.
2618**
2619** It is the responsibility of the caller to ensure that the returned
2620** string is eventually freed using sqlite3DbFree().
2621*/
dan71c57db2016-07-09 20:23:55 +00002622static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2623 Expr *pLeft = pExpr->pLeft;
2624 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002625 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002626 char *zRet;
2627
dan553168c2016-08-01 20:14:31 +00002628 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002629 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002630 if( zRet ){
2631 int i;
2632 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002633 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002634 char a = sqlite3ExprAffinity(pA);
2635 if( pSelect ){
2636 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2637 }else{
2638 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002639 }
dan71c57db2016-07-09 20:23:55 +00002640 }
2641 zRet[nVal] = '\0';
2642 }
2643 return zRet;
2644}
danf9b2e052016-08-02 17:45:00 +00002645#endif
dan71c57db2016-07-09 20:23:55 +00002646
dan8da209b2016-07-26 18:06:08 +00002647#ifndef SQLITE_OMIT_SUBQUERY
2648/*
2649** Load the Parse object passed as the first argument with an error
2650** message of the form:
2651**
2652** "sub-select returns N columns - expected M"
2653*/
2654void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2655 const char *zFmt = "sub-select returns %d columns - expected %d";
2656 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2657}
2658#endif
2659
drh626a8792005-01-17 22:08:19 +00002660/*
dan44c56042016-12-07 15:38:37 +00002661** Expression pExpr is a vector that has been used in a context where
2662** it is not permitted. If pExpr is a sub-select vector, this routine
2663** loads the Parse object with a message of the form:
2664**
2665** "sub-select returns N columns - expected 1"
2666**
2667** Or, if it is a regular scalar vector:
2668**
2669** "row value misused"
2670*/
2671void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2672#ifndef SQLITE_OMIT_SUBQUERY
2673 if( pExpr->flags & EP_xIsSelect ){
2674 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2675 }else
2676#endif
2677 {
2678 sqlite3ErrorMsg(pParse, "row value misused");
2679 }
2680}
2681
drh85bcdce2018-12-23 21:27:29 +00002682#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002683/*
drh85bcdce2018-12-23 21:27:29 +00002684** Generate code that will construct an ephemeral table containing all terms
2685** in the RHS of an IN operator. The IN operator can be in either of two
2686** forms:
drh626a8792005-01-17 22:08:19 +00002687**
drh9cbe6352005-11-29 03:13:21 +00002688** x IN (4,5,11) -- IN operator with list on right-hand side
2689** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002690**
drh2c041312018-12-24 02:34:49 +00002691** The pExpr parameter is the IN operator. The cursor number for the
2692** constructed ephermeral table is returned. The first time the ephemeral
2693** table is computed, the cursor number is also stored in pExpr->iTable,
2694** however the cursor number returned might not be the same, as it might
2695** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002696**
drh85bcdce2018-12-23 21:27:29 +00002697** If the LHS expression ("x" in the examples) is a column value, or
2698** the SELECT statement returns a column value, then the affinity of that
2699** column is used to build the index keys. If both 'x' and the
2700** SELECT... statement are columns, then numeric affinity is used
2701** if either column has NUMERIC or INTEGER affinity. If neither
2702** 'x' nor the SELECT... statement are columns, then numeric affinity
2703** is used.
drhcce7d172000-05-31 15:34:51 +00002704*/
drh85bcdce2018-12-23 21:27:29 +00002705void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002706 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002707 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002708 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002709){
drh2c041312018-12-24 02:34:49 +00002710 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002711 int addr; /* Address of OP_OpenEphemeral instruction */
2712 Expr *pLeft; /* the LHS of the IN operator */
2713 KeyInfo *pKeyInfo = 0; /* Key information */
2714 int nVal; /* Size of vector pLeft */
2715 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002716
drh2c041312018-12-24 02:34:49 +00002717 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002718 assert( v!=0 );
2719
drh2c041312018-12-24 02:34:49 +00002720 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002721 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002722 **
2723 ** * The right-hand side is a correlated subquery
2724 ** * The right-hand side is an expression list containing variables
2725 ** * We are inside a trigger
2726 **
drh2c041312018-12-24 02:34:49 +00002727 ** If all of the above are false, then we can compute the RHS just once
2728 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002729 */
drhefb699f2018-12-24 11:55:44 +00002730 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002731 /* Reuse of the RHS is allowed */
2732 /* If this routine has already been coded, but the previous code
2733 ** might not have been invoked yet, so invoke it now as a subroutine.
2734 */
2735 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002736 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002737 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2738 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2739 pExpr->x.pSelect->selId));
2740 }
drh2c041312018-12-24 02:34:49 +00002741 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2742 pExpr->y.sub.iAddr);
2743 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002744 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002745 return;
2746 }
2747
2748 /* Begin coding the subroutine */
2749 ExprSetProperty(pExpr, EP_Subrtn);
2750 pExpr->y.sub.regReturn = ++pParse->nMem;
2751 pExpr->y.sub.iAddr =
2752 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2753 VdbeComment((v, "return address"));
2754
2755 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002756 }
2757
drh85bcdce2018-12-23 21:27:29 +00002758 /* Check to see if this is a vector IN operator */
2759 pLeft = pExpr->pLeft;
2760 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002761
drh85bcdce2018-12-23 21:27:29 +00002762 /* Construct the ephemeral table that will contain the content of
2763 ** RHS of the IN operator.
2764 */
drh2c041312018-12-24 02:34:49 +00002765 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002766 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002767#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2768 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2769 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2770 }else{
2771 VdbeComment((v, "RHS of IN operator"));
2772 }
2773#endif
drh50ef6712019-02-22 23:29:56 +00002774 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002775
drh85bcdce2018-12-23 21:27:29 +00002776 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2777 /* Case 1: expr IN (SELECT ...)
2778 **
2779 ** Generate code to write the results of the select into the temporary
2780 ** table allocated and opened above.
2781 */
2782 Select *pSelect = pExpr->x.pSelect;
2783 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002784
drh2c041312018-12-24 02:34:49 +00002785 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2786 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002787 ));
drh85bcdce2018-12-23 21:27:29 +00002788 /* If the LHS and RHS of the IN operator do not match, that
2789 ** error will have been caught long before we reach this point. */
2790 if( ALWAYS(pEList->nExpr==nVal) ){
2791 SelectDest dest;
2792 int i;
drhbd462bc2018-12-24 20:21:06 +00002793 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002794 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2795 pSelect->iLimit = 0;
2796 testcase( pSelect->selFlags & SF_Distinct );
2797 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2798 if( sqlite3Select(pParse, pSelect, &dest) ){
2799 sqlite3DbFree(pParse->db, dest.zAffSdst);
2800 sqlite3KeyInfoUnref(pKeyInfo);
2801 return;
drhfef52082000-06-06 01:50:43 +00002802 }
drh85bcdce2018-12-23 21:27:29 +00002803 sqlite3DbFree(pParse->db, dest.zAffSdst);
2804 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2805 assert( pEList!=0 );
2806 assert( pEList->nExpr>0 );
2807 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2808 for(i=0; i<nVal; i++){
2809 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2810 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2811 pParse, p, pEList->a[i].pExpr
2812 );
danielk197741a05b72008-10-02 13:50:55 +00002813 }
drh85bcdce2018-12-23 21:27:29 +00002814 }
2815 }else if( ALWAYS(pExpr->x.pList!=0) ){
2816 /* Case 2: expr IN (exprlist)
2817 **
2818 ** For each expression, build an index key from the evaluation and
2819 ** store it in the temporary table. If <expr> is a column, then use
2820 ** that columns affinity when building index keys. If <expr> is not
2821 ** a column, use numeric affinity.
2822 */
2823 char affinity; /* Affinity of the LHS of the IN */
2824 int i;
2825 ExprList *pList = pExpr->x.pList;
2826 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002827 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002828 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002829 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002830 affinity = SQLITE_AFF_BLOB;
2831 }
2832 if( pKeyInfo ){
2833 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2834 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002835 }
2836
drh85bcdce2018-12-23 21:27:29 +00002837 /* Loop through each expression in <exprlist>. */
2838 r1 = sqlite3GetTempReg(pParse);
2839 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002840 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2841 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002842
2843 /* If the expression is not constant then we will need to
2844 ** disable the test that was generated above that makes sure
2845 ** this code only executes once. Because for a non-constant
2846 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002847 */
drh2c041312018-12-24 02:34:49 +00002848 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2849 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002850 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002851 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002852 }
drh1398ad32005-01-19 23:24:50 +00002853
drh85bcdce2018-12-23 21:27:29 +00002854 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002855 sqlite3ExprCode(pParse, pE2, r1);
2856 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2857 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002858 }
drh85bcdce2018-12-23 21:27:29 +00002859 sqlite3ReleaseTempReg(pParse, r1);
2860 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002861 }
drh85bcdce2018-12-23 21:27:29 +00002862 if( pKeyInfo ){
2863 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2864 }
drh2c041312018-12-24 02:34:49 +00002865 if( addrOnce ){
2866 sqlite3VdbeJumpHere(v, addrOnce);
2867 /* Subroutine return */
2868 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2869 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002870 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002871 }
2872}
2873#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00002874
drh85bcdce2018-12-23 21:27:29 +00002875/*
2876** Generate code for scalar subqueries used as a subquery expression
2877** or EXISTS operator:
2878**
2879** (SELECT a FROM b) -- subquery
2880** EXISTS (SELECT a FROM b) -- EXISTS subquery
2881**
2882** The pExpr parameter is the SELECT or EXISTS operator to be coded.
2883**
drhd86fe442019-08-26 13:45:49 +00002884** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00002885** the result is stored in a contiguous array of registers and the
2886** return value is the register of the left-most result column.
2887** Return 0 if an error occurs.
2888*/
2889#ifndef SQLITE_OMIT_SUBQUERY
2890int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00002891 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00002892 int rReg = 0; /* Register storing resulting */
2893 Select *pSel; /* SELECT statement to encode */
2894 SelectDest dest; /* How to deal with SELECT result */
2895 int nReg; /* Registers to allocate */
2896 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00002897
2898 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002899 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00002900 testcase( pExpr->op==TK_EXISTS );
2901 testcase( pExpr->op==TK_SELECT );
2902 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2903 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2904 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00002905
drh5198ff52018-12-24 12:09:47 +00002906 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00002907 ** is encountered if any of the following is true:
2908 **
2909 ** * The right-hand side is a correlated subquery
2910 ** * The right-hand side is an expression list containing variables
2911 ** * We are inside a trigger
2912 **
2913 ** If all of the above are false, then we can run this code just once
2914 ** save the results, and reuse the same result on subsequent invocations.
2915 */
2916 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00002917 /* If this routine has already been coded, then invoke it as a
2918 ** subroutine. */
2919 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00002920 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00002921 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2922 pExpr->y.sub.iAddr);
2923 return pExpr->iTable;
2924 }
2925
2926 /* Begin coding the subroutine */
2927 ExprSetProperty(pExpr, EP_Subrtn);
2928 pExpr->y.sub.regReturn = ++pParse->nMem;
2929 pExpr->y.sub.iAddr =
2930 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2931 VdbeComment((v, "return address"));
2932
drh2c041312018-12-24 02:34:49 +00002933 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002934 }
drh85bcdce2018-12-23 21:27:29 +00002935
2936 /* For a SELECT, generate code to put the values for all columns of
2937 ** the first row into an array of registers and return the index of
2938 ** the first register.
2939 **
2940 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
2941 ** into a register and return that register number.
2942 **
2943 ** In both cases, the query is augmented with "LIMIT 1". Any
2944 ** preexisting limit is discarded in place of the new LIMIT 1.
2945 */
drhbd462bc2018-12-24 20:21:06 +00002946 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2947 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00002948 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
2949 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
2950 pParse->nMem += nReg;
2951 if( pExpr->op==TK_SELECT ){
2952 dest.eDest = SRT_Mem;
2953 dest.iSdst = dest.iSDParm;
2954 dest.nSdst = nReg;
2955 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2956 VdbeComment((v, "Init subquery result"));
2957 }else{
2958 dest.eDest = SRT_Exists;
2959 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2960 VdbeComment((v, "Init EXISTS result"));
2961 }
drh85bcdce2018-12-23 21:27:29 +00002962 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00002963 /* The subquery already has a limit. If the pre-existing limit is X
2964 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
2965 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00002966 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00002967 if( pLimit ){
2968 pLimit->affExpr = SQLITE_AFF_NUMERIC;
2969 pLimit = sqlite3PExpr(pParse, TK_NE,
2970 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
2971 }
2972 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00002973 pSel->pLimit->pLeft = pLimit;
2974 }else{
drh7ca13472019-09-23 11:55:22 +00002975 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00002976 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00002977 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
2978 }
2979 pSel->iLimit = 0;
2980 if( sqlite3Select(pParse, pSel, &dest) ){
2981 return 0;
2982 }
drh2c041312018-12-24 02:34:49 +00002983 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00002984 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00002985 if( addrOnce ){
2986 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00002987
drh5198ff52018-12-24 12:09:47 +00002988 /* Subroutine return */
2989 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2990 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002991 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00002992 }
drh2c041312018-12-24 02:34:49 +00002993
drh1450bc62009-10-30 13:25:56 +00002994 return rReg;
drhcce7d172000-05-31 15:34:51 +00002995}
drh51522cd2005-01-20 13:36:19 +00002996#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00002997
drhe3365e62009-11-12 17:52:24 +00002998#ifndef SQLITE_OMIT_SUBQUERY
2999/*
dan7b35a772016-07-28 19:47:15 +00003000** Expr pIn is an IN(...) expression. This function checks that the
3001** sub-select on the RHS of the IN() operator has the same number of
3002** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3003** a sub-query, that the LHS is a vector of size 1.
3004*/
3005int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3006 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3007 if( (pIn->flags & EP_xIsSelect) ){
3008 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3009 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3010 return 1;
3011 }
3012 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003013 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003014 return 1;
3015 }
3016 return 0;
3017}
3018#endif
3019
3020#ifndef SQLITE_OMIT_SUBQUERY
3021/*
drhe3365e62009-11-12 17:52:24 +00003022** Generate code for an IN expression.
3023**
3024** x IN (SELECT ...)
3025** x IN (value, value, ...)
3026**
drhecb87ac2016-08-25 15:46:25 +00003027** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003028** right-hand side (RHS) is an array of zero or more scalar values, or a
3029** subquery. If the RHS is a subquery, the number of result columns must
3030** match the number of columns in the vector on the LHS. If the RHS is
3031** a list of values, the LHS must be a scalar.
3032**
3033** The IN operator is true if the LHS value is contained within the RHS.
3034** The result is false if the LHS is definitely not in the RHS. The
3035** result is NULL if the presence of the LHS in the RHS cannot be
3036** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003037**
drh6be515e2014-08-01 21:00:53 +00003038** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003039** contained within the RHS. If due to NULLs we cannot determine if the LHS
3040** is contained in the RHS then jump to destIfNull. If the LHS is contained
3041** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003042**
3043** See the separate in-operator.md documentation file in the canonical
3044** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003045*/
3046static void sqlite3ExprCodeIN(
3047 Parse *pParse, /* Parsing and code generating context */
3048 Expr *pExpr, /* The IN expression */
3049 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3050 int destIfNull /* Jump here if the results are unknown due to NULLs */
3051){
3052 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003053 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003054 int rLhs; /* Register(s) holding the LHS values */
3055 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003056 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003057 int *aiMap = 0; /* Map from vector field to index column */
3058 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003059 int nVector; /* Size of vectors for this IN operator */
3060 int iDummy; /* Dummy parameter to exprCodeVector() */
3061 Expr *pLeft; /* The LHS of the IN operator */
3062 int i; /* loop counter */
3063 int destStep2; /* Where to jump when NULLs seen in step 2 */
3064 int destStep6 = 0; /* Start of code for Step 6 */
3065 int addrTruthOp; /* Address of opcode that determines the IN is true */
3066 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3067 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003068 int iTab = 0; /* Index to use */
drhe3365e62009-11-12 17:52:24 +00003069
drhe347d3e2016-08-25 21:14:34 +00003070 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003071 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003072 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003073 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3074 aiMap = (int*)sqlite3DbMallocZero(
3075 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3076 );
drhe347d3e2016-08-25 21:14:34 +00003077 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003078
danba00e302016-07-23 20:24:06 +00003079 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003080 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003081 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3082 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003083 v = pParse->pVdbe;
3084 assert( v!=0 ); /* OOM detected prior to this routine */
3085 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003086 eType = sqlite3FindInIndex(pParse, pExpr,
3087 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003088 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3089 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003090
danba00e302016-07-23 20:24:06 +00003091 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3092 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3093 );
drhecb87ac2016-08-25 15:46:25 +00003094#ifdef SQLITE_DEBUG
3095 /* Confirm that aiMap[] contains nVector integer values between 0 and
3096 ** nVector-1. */
3097 for(i=0; i<nVector; i++){
3098 int j, cnt;
3099 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3100 assert( cnt==1 );
3101 }
3102#endif
drhe3365e62009-11-12 17:52:24 +00003103
danba00e302016-07-23 20:24:06 +00003104 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3105 ** vector, then it is stored in an array of nVector registers starting
3106 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003107 **
3108 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3109 ** so that the fields are in the same order as an existing index. The
3110 ** aiMap[] array contains a mapping from the original LHS field order to
3111 ** the field order that matches the RHS index.
drhe3365e62009-11-12 17:52:24 +00003112 */
drhe347d3e2016-08-25 21:14:34 +00003113 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3114 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003115 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003116 /* LHS fields are not reordered */
3117 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003118 }else{
3119 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003120 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003121 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003122 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003123 }
danba00e302016-07-23 20:24:06 +00003124 }
drhe3365e62009-11-12 17:52:24 +00003125
drhbb53ecb2014-08-02 21:03:33 +00003126 /* If sqlite3FindInIndex() did not find or create an index that is
3127 ** suitable for evaluating the IN operator, then evaluate using a
3128 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003129 **
3130 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003131 */
drhbb53ecb2014-08-02 21:03:33 +00003132 if( eType==IN_INDEX_NOOP ){
3133 ExprList *pList = pExpr->x.pList;
3134 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003135 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003136 int r2, regToFree;
3137 int regCkNull = 0;
3138 int ii;
drhdd668c22019-09-02 02:21:58 +00003139 int bLhsReal; /* True if the LHS of the IN has REAL affinity */
drhbb53ecb2014-08-02 21:03:33 +00003140 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003141 if( destIfNull!=destIfFalse ){
3142 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003143 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003144 }
drhdd668c22019-09-02 02:21:58 +00003145 bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
drhbb53ecb2014-08-02 21:03:33 +00003146 for(ii=0; ii<pList->nExpr; ii++){
drhdd668c22019-09-02 02:21:58 +00003147 if( bLhsReal ){
drh4fc83652019-09-02 22:13:06 +00003148 r2 = regToFree = sqlite3GetTempReg(pParse);
3149 sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
drhdd668c22019-09-02 02:21:58 +00003150 sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
drh4fc83652019-09-02 22:13:06 +00003151 }else{
3152 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drhdd668c22019-09-02 02:21:58 +00003153 }
drha9769792014-08-04 16:39:39 +00003154 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003155 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3156 }
3157 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drhe347d3e2016-08-25 21:14:34 +00003158 sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003159 (void*)pColl, P4_COLLSEQ);
3160 VdbeCoverageIf(v, ii<pList->nExpr-1);
3161 VdbeCoverageIf(v, ii==pList->nExpr-1);
danba00e302016-07-23 20:24:06 +00003162 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003163 }else{
3164 assert( destIfNull==destIfFalse );
drhe347d3e2016-08-25 21:14:34 +00003165 sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
drhbb53ecb2014-08-02 21:03:33 +00003166 (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
danba00e302016-07-23 20:24:06 +00003167 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003168 }
3169 sqlite3ReleaseTempReg(pParse, regToFree);
3170 }
3171 if( regCkNull ){
3172 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003173 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003174 }
3175 sqlite3VdbeResolveLabel(v, labelOk);
3176 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003177 goto sqlite3ExprCodeIN_finished;
3178 }
3179
3180 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3181 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3182 ** We will then skip the binary search of the RHS.
3183 */
3184 if( destIfNull==destIfFalse ){
3185 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003186 }else{
drhec4ccdb2018-12-29 02:26:59 +00003187 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003188 }
3189 for(i=0; i<nVector; i++){
3190 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3191 if( sqlite3ExprCanBeNull(p) ){
3192 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003193 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003194 }
drhe3365e62009-11-12 17:52:24 +00003195 }
drhe347d3e2016-08-25 21:14:34 +00003196
3197 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3198 ** of the RHS using the LHS as a probe. If found, the result is
3199 ** true.
3200 */
3201 if( eType==IN_INDEX_ROWID ){
3202 /* In this case, the RHS is the ROWID of table b-tree and so we also
3203 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3204 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003205 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003206 VdbeCoverage(v);
3207 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3208 }else{
3209 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3210 if( destIfFalse==destIfNull ){
3211 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003212 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003213 rLhs, nVector); VdbeCoverage(v);
3214 goto sqlite3ExprCodeIN_finished;
3215 }
3216 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003217 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003218 rLhs, nVector); VdbeCoverage(v);
3219 }
3220
3221 /* Step 4. If the RHS is known to be non-NULL and we did not find
3222 ** an match on the search above, then the result must be FALSE.
3223 */
3224 if( rRhsHasNull && nVector==1 ){
3225 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3226 VdbeCoverage(v);
3227 }
3228
3229 /* Step 5. If we do not care about the difference between NULL and
3230 ** FALSE, then just return false.
3231 */
3232 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3233
3234 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3235 ** If any comparison is NULL, then the result is NULL. If all
3236 ** comparisons are FALSE then the final result is FALSE.
3237 **
3238 ** For a scalar LHS, it is sufficient to check just the first row
3239 ** of the RHS.
3240 */
3241 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003242 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003243 VdbeCoverage(v);
3244 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003245 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003246 }else{
3247 /* For nVector==1, combine steps 6 and 7 by immediately returning
3248 ** FALSE if the first comparison is not NULL */
3249 destNotNull = destIfFalse;
3250 }
3251 for(i=0; i<nVector; i++){
3252 Expr *p;
3253 CollSeq *pColl;
3254 int r3 = sqlite3GetTempReg(pParse);
3255 p = sqlite3VectorFieldSubexpr(pLeft, i);
3256 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003257 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003258 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3259 (void*)pColl, P4_COLLSEQ);
3260 VdbeCoverage(v);
3261 sqlite3ReleaseTempReg(pParse, r3);
3262 }
3263 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3264 if( nVector>1 ){
3265 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003266 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003267 VdbeCoverage(v);
3268
3269 /* Step 7: If we reach this point, we know that the result must
3270 ** be false. */
3271 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3272 }
3273
3274 /* Jumps here in order to return true. */
3275 sqlite3VdbeJumpHere(v, addrTruthOp);
3276
3277sqlite3ExprCodeIN_finished:
3278 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003279 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003280sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003281 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003282 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003283}
3284#endif /* SQLITE_OMIT_SUBQUERY */
3285
drh13573c72010-01-12 17:04:07 +00003286#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003287/*
3288** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003289** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003290**
3291** The z[] string will probably not be zero-terminated. But the
3292** z[n] character is guaranteed to be something that does not look
3293** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003294*/
drhb7916a72009-05-27 10:31:29 +00003295static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003296 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003297 double value;
drh9339da12010-09-30 00:50:49 +00003298 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003299 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3300 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003301 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003302 }
3303}
drh13573c72010-01-12 17:04:07 +00003304#endif
drh598f1342007-10-23 15:39:45 +00003305
3306
3307/*
drhfec19aa2004-05-19 20:41:03 +00003308** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003309** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003310**
shaneh5f1d6b62010-09-30 16:51:25 +00003311** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003312*/
drh13573c72010-01-12 17:04:07 +00003313static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3314 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003315 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003316 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003317 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003318 if( negFlag ) i = -i;
3319 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003320 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003321 int c;
3322 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003323 const char *z = pExpr->u.zToken;
3324 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003325 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003326 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003327#ifdef SQLITE_OMIT_FLOATING_POINT
3328 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3329#else
drh1b7ddc52014-07-23 14:52:05 +00003330#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003331 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003332 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003333 }else
3334#endif
3335 {
drh9296c182014-07-23 13:40:49 +00003336 codeReal(v, z, negFlag, iMem);
3337 }
drh13573c72010-01-12 17:04:07 +00003338#endif
drh77320ea2016-11-30 14:47:37 +00003339 }else{
drh84d4f1a2017-09-20 10:47:10 +00003340 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003341 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003342 }
drhfec19aa2004-05-19 20:41:03 +00003343 }
3344}
3345
drh5cd79232009-05-25 11:46:29 +00003346
drh1f9ca2c2015-08-25 16:57:52 +00003347/* Generate code that will load into register regOut a value that is
3348** appropriate for the iIdxCol-th column of index pIdx.
3349*/
3350void sqlite3ExprCodeLoadIndexColumn(
3351 Parse *pParse, /* The parsing context */
3352 Index *pIdx, /* The index whose column is to be loaded */
3353 int iTabCur, /* Cursor pointing to a table row */
3354 int iIdxCol, /* The column of the index to be loaded */
3355 int regOut /* Store the index column value in this register */
3356){
3357 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003358 if( iTabCol==XN_EXPR ){
3359 assert( pIdx->aColExpr );
3360 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003361 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003362 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003363 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003364 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003365 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
3366 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003367 }
drh1f9ca2c2015-08-25 16:57:52 +00003368}
3369
drh5cd79232009-05-25 11:46:29 +00003370/*
drh5c092e82010-05-14 19:24:02 +00003371** Generate code to extract the value of the iCol-th column of a table.
3372*/
3373void sqlite3ExprCodeGetColumnOfTable(
3374 Vdbe *v, /* The VDBE under construction */
3375 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003376 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003377 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003378 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003379){
drhaca19e12017-04-07 19:41:31 +00003380 if( pTab==0 ){
3381 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3382 return;
3383 }
drh5c092e82010-05-14 19:24:02 +00003384 if( iCol<0 || iCol==pTab->iPKey ){
3385 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3386 }else{
3387 int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003388 int x = iCol;
drh35db31b2016-06-02 23:13:21 +00003389 if( !HasRowid(pTab) && !IsVirtual(pTab) ){
drhee0ec8e2013-10-31 17:38:01 +00003390 x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3391 }
3392 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003393 }
3394 if( iCol>=0 ){
3395 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3396 }
3397}
3398
3399/*
drh945498f2007-02-24 11:52:52 +00003400** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003401** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003402**
3403** There must be an open cursor to pTab in iTable when this routine
3404** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003405*/
drhe55cbd72008-03-31 23:48:03 +00003406int sqlite3ExprCodeGetColumn(
3407 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003408 Table *pTab, /* Description of the table we are reading from */
3409 int iColumn, /* Index of the table column */
3410 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003411 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003412 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003413){
drhe55cbd72008-03-31 23:48:03 +00003414 Vdbe *v = pParse->pVdbe;
drhe55cbd72008-03-31 23:48:03 +00003415 assert( v!=0 );
drh5c092e82010-05-14 19:24:02 +00003416 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003417 if( p5 ){
3418 sqlite3VdbeChangeP5(v, p5);
drha748fdc2012-03-28 01:34:47 +00003419 }
drhe55cbd72008-03-31 23:48:03 +00003420 return iReg;
3421}
drhe55cbd72008-03-31 23:48:03 +00003422
3423/*
drhb21e7c72008-06-22 12:37:57 +00003424** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003425** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003426*/
drhb21e7c72008-06-22 12:37:57 +00003427void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drhe8e4af72012-09-21 00:04:28 +00003428 assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
drh079a3072014-03-19 14:10:55 +00003429 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003430}
3431
drh652fbf52008-04-01 01:42:41 +00003432/*
drh12abf402016-08-22 14:30:05 +00003433** Convert a scalar expression node to a TK_REGISTER referencing
3434** register iReg. The caller must ensure that iReg already contains
3435** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003436*/
dan069d1b12019-06-16 08:58:14 +00003437static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003438 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003439 p->op2 = p->op;
3440 p->op = TK_REGISTER;
3441 p->iTable = iReg;
3442 ExprClearProperty(p, EP_Skip);
3443}
3444
drh12abf402016-08-22 14:30:05 +00003445/*
3446** Evaluate an expression (either a vector or a scalar expression) and store
3447** the result in continguous temporary registers. Return the index of
3448** the first register used to store the result.
3449**
3450** If the returned result register is a temporary scalar, then also write
3451** that register number into *piFreeable. If the returned result register
3452** is not a temporary or if the expression is a vector set *piFreeable
3453** to 0.
3454*/
3455static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3456 int iResult;
3457 int nResult = sqlite3ExprVectorSize(p);
3458 if( nResult==1 ){
3459 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3460 }else{
3461 *piFreeable = 0;
3462 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003463#if SQLITE_OMIT_SUBQUERY
3464 iResult = 0;
3465#else
drh85bcdce2018-12-23 21:27:29 +00003466 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003467#endif
drh12abf402016-08-22 14:30:05 +00003468 }else{
3469 int i;
3470 iResult = pParse->nMem+1;
3471 pParse->nMem += nResult;
3472 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003473 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003474 }
3475 }
3476 }
3477 return iResult;
3478}
3479
dan71c57db2016-07-09 20:23:55 +00003480
drha4c3c872013-09-12 17:29:25 +00003481/*
drhcce7d172000-05-31 15:34:51 +00003482** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003483** expression. Attempt to store the results in register "target".
3484** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003485**
drh8b213892008-08-29 02:14:02 +00003486** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003487** be stored in target. The result might be stored in some other
3488** register if it is convenient to do so. The calling function
3489** must check the return code and move the results to the desired
3490** register.
drhcce7d172000-05-31 15:34:51 +00003491*/
drh678ccce2008-03-31 18:19:54 +00003492int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003493 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3494 int op; /* The opcode being coded */
3495 int inReg = target; /* Results stored in register inReg */
3496 int regFree1 = 0; /* If non-zero free this temporary register */
3497 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003498 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003499 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003500 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003501
drh9cbf3422008-01-17 16:22:13 +00003502 assert( target>0 && target<=pParse->nMem );
drh20411ea2009-05-29 19:00:12 +00003503 if( v==0 ){
3504 assert( pParse->db->mallocFailed );
3505 return 0;
3506 }
drh389a1ad2008-01-03 23:44:53 +00003507
drh1efa8022018-04-28 04:16:43 +00003508expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003509 if( pExpr==0 ){
3510 op = TK_NULL;
3511 }else{
3512 op = pExpr->op;
3513 }
drhf2bc0132004-10-04 13:19:23 +00003514 switch( op ){
drh13449892005-09-07 21:22:45 +00003515 case TK_AGG_COLUMN: {
3516 AggInfo *pAggInfo = pExpr->pAggInfo;
3517 struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
3518 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003519 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003520 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003521 }else if( pAggInfo->useSortingIdx ){
dan5134d132011-09-02 10:31:11 +00003522 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003523 pCol->iSorterColumn, target);
drhc332cc32016-09-19 10:24:19 +00003524 return target;
drh13449892005-09-07 21:22:45 +00003525 }
3526 /* Otherwise, fall thru into the TK_COLUMN case */
3527 }
drh967e8b72000-06-21 13:59:10 +00003528 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003529 int iTab = pExpr->iTable;
drhefad2e22018-07-27 16:57:11 +00003530 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003531 /* This COLUMN expression is really a constant due to WHERE clause
3532 ** constraints, and that constant is coded by the pExpr->pLeft
3533 ** expresssion. However, make sure the constant has the correct
3534 ** datatype by applying the Affinity of the table column to the
3535 ** constant.
3536 */
3537 int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drheda079c2018-09-20 19:02:15 +00003538 int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh96fb16e2019-08-06 14:37:24 +00003539 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003540 static const char zAff[] = "B\000C\000D\000E";
3541 assert( SQLITE_AFF_BLOB=='A' );
3542 assert( SQLITE_AFF_TEXT=='B' );
3543 if( iReg!=target ){
3544 sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3545 iReg = target;
3546 }
3547 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3548 &zAff[(aff-'B')*2], P4_STATIC);
3549 }
3550 return iReg;
drhefad2e22018-07-27 16:57:11 +00003551 }
drhb2b9d3d2013-08-01 01:14:43 +00003552 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003553 if( pParse->iSelfTab<0 ){
drhb2b9d3d2013-08-01 01:14:43 +00003554 /* Generating CHECK constraints or inserting into partial index */
drhbffdd632019-09-02 00:58:44 +00003555 assert( pExpr->y.pTab!=0 );
3556 assert( pExpr->iColumn>=XN_ROWID );
3557 assert( pExpr->iColumn<pExpr->y.pTab->nCol );
3558 if( pExpr->iColumn>=0
3559 && pExpr->y.pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3560 ){
3561 sqlite3VdbeAddOp2(v, OP_SCopy, pExpr->iColumn - pParse->iSelfTab,
3562 target);
3563 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3564 return target;
3565 }else{
3566 return pExpr->iColumn - pParse->iSelfTab;
3567 }
drhb2b9d3d2013-08-01 01:14:43 +00003568 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003569 /* Coding an expression that is part of an index where column names
3570 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003571 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003572 }
drh22827922000-06-06 17:27:05 +00003573 }
drheda079c2018-09-20 19:02:15 +00003574 return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003575 pExpr->iColumn, iTab, target,
3576 pExpr->op2);
drhcce7d172000-05-31 15:34:51 +00003577 }
3578 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003579 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003580 return target;
drhfec19aa2004-05-19 20:41:03 +00003581 }
drh8abed7b2018-02-26 18:49:05 +00003582 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003583 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003584 return target;
3585 }
drh13573c72010-01-12 17:04:07 +00003586#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003587 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003588 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3589 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003590 return target;
drh598f1342007-10-23 15:39:45 +00003591 }
drh13573c72010-01-12 17:04:07 +00003592#endif
drhfec19aa2004-05-19 20:41:03 +00003593 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003594 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003595 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003596 return target;
drhcce7d172000-05-31 15:34:51 +00003597 }
drhf0863fe2005-06-12 21:35:51 +00003598 case TK_NULL: {
drh9de221d2008-01-05 06:51:30 +00003599 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003600 return target;
drhf0863fe2005-06-12 21:35:51 +00003601 }
danielk19775338a5f2005-01-20 13:03:10 +00003602#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003603 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003604 int n;
3605 const char *z;
drhca48c902008-01-18 14:08:24 +00003606 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003607 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3608 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3609 assert( pExpr->u.zToken[1]=='\'' );
3610 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003611 n = sqlite3Strlen30(z) - 1;
3612 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003613 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3614 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003615 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003616 }
danielk19775338a5f2005-01-20 13:03:10 +00003617#endif
drh50457892003-09-06 01:10:47 +00003618 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003619 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3620 assert( pExpr->u.zToken!=0 );
3621 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003622 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3623 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003624 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drhf326d662016-12-23 13:30:53 +00003625 assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
drhce1bbe52016-12-23 13:52:45 +00003626 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003627 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003628 }
drhc332cc32016-09-19 10:24:19 +00003629 return target;
drh50457892003-09-06 01:10:47 +00003630 }
drh4e0cff62004-11-05 05:10:28 +00003631 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003632 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003633 }
drh487e2622005-06-25 18:42:14 +00003634#ifndef SQLITE_OMIT_CAST
3635 case TK_CAST: {
3636 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003637 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003638 if( inReg!=target ){
3639 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3640 inReg = target;
3641 }
drh4169e432014-08-25 20:11:52 +00003642 sqlite3VdbeAddOp2(v, OP_Cast, target,
3643 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003644 return inReg;
drh487e2622005-06-25 18:42:14 +00003645 }
3646#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003647 case TK_IS:
3648 case TK_ISNOT:
3649 op = (op==TK_IS) ? TK_EQ : TK_NE;
3650 p5 = SQLITE_NULLEQ;
3651 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00003652 case TK_LT:
3653 case TK_LE:
3654 case TK_GT:
3655 case TK_GE:
3656 case TK_NE:
3657 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00003658 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00003659 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00003660 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00003661 }else{
3662 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3663 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
3664 codeCompare(pParse, pLeft, pExpr->pRight, op,
3665 r1, r2, inReg, SQLITE_STOREP2 | p5);
3666 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
3667 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
3668 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
3669 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
3670 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
3671 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3672 testcase( regFree1==0 );
3673 testcase( regFree2==0 );
3674 }
drh6a2fe092009-09-23 02:29:36 +00003675 break;
3676 }
drhcce7d172000-05-31 15:34:51 +00003677 case TK_AND:
3678 case TK_OR:
3679 case TK_PLUS:
3680 case TK_STAR:
3681 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00003682 case TK_REM:
3683 case TK_BITAND:
3684 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00003685 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00003686 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00003687 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00003688 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00003689 assert( TK_AND==OP_And ); testcase( op==TK_AND );
3690 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
3691 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
3692 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
3693 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
3694 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
3695 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
3696 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
3697 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
3698 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
3699 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00003700 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3701 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00003702 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003703 testcase( regFree1==0 );
3704 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00003705 break;
3706 }
drhcce7d172000-05-31 15:34:51 +00003707 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00003708 Expr *pLeft = pExpr->pLeft;
3709 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00003710 if( pLeft->op==TK_INTEGER ){
3711 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00003712 return target;
drh13573c72010-01-12 17:04:07 +00003713#ifndef SQLITE_OMIT_FLOATING_POINT
3714 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00003715 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3716 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00003717 return target;
drh13573c72010-01-12 17:04:07 +00003718#endif
drh3c84ddf2008-01-09 02:15:38 +00003719 }else{
drh10d1edf2013-11-15 15:52:39 +00003720 tempX.op = TK_INTEGER;
3721 tempX.flags = EP_IntValue|EP_TokenOnly;
3722 tempX.u.iValue = 0;
3723 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00003724 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00003725 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00003726 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00003727 }
drh3c84ddf2008-01-09 02:15:38 +00003728 break;
drh6e142f52000-06-08 13:36:40 +00003729 }
drhbf4133c2001-10-13 02:59:08 +00003730 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00003731 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00003732 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
3733 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00003734 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3735 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00003736 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00003737 break;
3738 }
drh8abed7b2018-02-26 18:49:05 +00003739 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00003740 int isTrue; /* IS TRUE or IS NOT TRUE */
3741 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00003742 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3743 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00003744 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
3745 bNormal = pExpr->op2==TK_IS;
3746 testcase( isTrue && bNormal);
3747 testcase( !isTrue && bNormal);
3748 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00003749 break;
3750 }
drhcce7d172000-05-31 15:34:51 +00003751 case TK_ISNULL:
3752 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00003753 int addr;
drh7d176102014-02-18 03:07:12 +00003754 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
3755 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00003756 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00003757 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00003758 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00003759 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00003760 VdbeCoverageIf(v, op==TK_ISNULL);
3761 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00003762 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00003763 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00003764 break;
drhcce7d172000-05-31 15:34:51 +00003765 }
drh22827922000-06-06 17:27:05 +00003766 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00003767 AggInfo *pInfo = pExpr->pAggInfo;
drh7e56e712005-11-16 12:53:15 +00003768 if( pInfo==0 ){
drh33e619f2009-05-28 01:00:55 +00003769 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3770 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00003771 }else{
drhc332cc32016-09-19 10:24:19 +00003772 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00003773 }
drh22827922000-06-06 17:27:05 +00003774 break;
3775 }
drhcce7d172000-05-31 15:34:51 +00003776 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00003777 ExprList *pFarg; /* List of function arguments */
3778 int nFarg; /* Number of function arguments */
3779 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00003780 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00003781 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00003782 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00003783 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00003784 u8 enc = ENC(db); /* The text encoding used by this database */
3785 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00003786
dan67a9b8e2018-06-22 20:51:35 +00003787#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00003788 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3789 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00003790 }
dan67a9b8e2018-06-22 20:51:35 +00003791#endif
dan86fb6e12018-05-16 20:58:07 +00003792
drh1e9b53f2017-01-04 01:07:24 +00003793 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh49c5ab22017-01-04 04:18:00 +00003794 /* SQL functions can be expensive. So try to move constant functions
drhad879ff2017-01-04 04:10:02 +00003795 ** out of the inner loop, even if that means an extra OP_Copy. */
3796 return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00003797 }
danielk19776ab3a2e2009-02-19 14:39:25 +00003798 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhc5cd1242013-09-12 16:50:49 +00003799 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
drh12ffee82009-04-08 13:51:51 +00003800 pFarg = 0;
3801 }else{
3802 pFarg = pExpr->x.pList;
3803 }
3804 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00003805 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3806 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00003807 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00003808#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3809 if( pDef==0 && pParse->explain ){
3810 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3811 }
3812#endif
danb6e9f7a2018-05-19 14:15:29 +00003813 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00003814 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00003815 break;
3816 }
drhae6bb952009-11-11 00:24:31 +00003817
3818 /* Attempt a direct implementation of the built-in COALESCE() and
peter.d.reid60ec9142014-09-06 16:39:46 +00003819 ** IFNULL() functions. This avoids unnecessary evaluation of
drhae6bb952009-11-11 00:24:31 +00003820 ** arguments past the first non-NULL argument.
3821 */
drhd36e1042013-09-06 13:10:12 +00003822 if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
drhec4ccdb2018-12-29 02:26:59 +00003823 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
drhae6bb952009-11-11 00:24:31 +00003824 assert( nFarg>=2 );
3825 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3826 for(i=1; i<nFarg; i++){
3827 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
drh688852a2014-02-17 22:40:43 +00003828 VdbeCoverage(v);
drhae6bb952009-11-11 00:24:31 +00003829 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
drhae6bb952009-11-11 00:24:31 +00003830 }
3831 sqlite3VdbeResolveLabel(v, endCoalesce);
3832 break;
3833 }
3834
drhcca9f3d2013-09-06 15:23:29 +00003835 /* The UNLIKELY() function is a no-op. The result is the value
3836 ** of the first argument.
3837 */
3838 if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3839 assert( nFarg>=1 );
drhc332cc32016-09-19 10:24:19 +00003840 return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
drhcca9f3d2013-09-06 15:23:29 +00003841 }
drhae6bb952009-11-11 00:24:31 +00003842
drh54240752017-01-03 14:39:30 +00003843#ifdef SQLITE_DEBUG
drha1a523a2016-12-26 00:18:36 +00003844 /* The AFFINITY() function evaluates to a string that describes
3845 ** the type affinity of the argument. This is used for testing of
3846 ** the SQLite type logic.
3847 */
3848 if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3849 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3850 char aff;
3851 assert( nFarg==1 );
3852 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3853 sqlite3VdbeLoadString(v, target,
drh96fb16e2019-08-06 14:37:24 +00003854 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
drha1a523a2016-12-26 00:18:36 +00003855 return target;
3856 }
drh54240752017-01-03 14:39:30 +00003857#endif
drha1a523a2016-12-26 00:18:36 +00003858
drhd1a01ed2013-11-21 16:08:52 +00003859 for(i=0; i<nFarg; i++){
3860 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00003861 testcase( i==31 );
3862 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00003863 }
3864 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3865 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3866 }
3867 }
drh12ffee82009-04-08 13:51:51 +00003868 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00003869 if( constMask ){
3870 r1 = pParse->nMem+1;
3871 pParse->nMem += nFarg;
3872 }else{
3873 r1 = sqlite3GetTempRange(pParse, nFarg);
3874 }
drha748fdc2012-03-28 01:34:47 +00003875
3876 /* For length() and typeof() functions with a column argument,
3877 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3878 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3879 ** loading.
3880 */
drhd36e1042013-09-06 13:10:12 +00003881 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00003882 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00003883 assert( nFarg==1 );
3884 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00003885 exprOp = pFarg->a[0].pExpr->op;
3886 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00003887 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3888 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00003889 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3890 pFarg->a[0].pExpr->op2 =
3891 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00003892 }
3893 }
3894
drh5579d592015-08-26 14:01:41 +00003895 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00003896 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00003897 }else{
drh12ffee82009-04-08 13:51:51 +00003898 r1 = 0;
drh892d3172008-01-10 03:46:36 +00003899 }
drhb7f6f682006-07-08 17:06:43 +00003900#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00003901 /* Possibly overload the function if the first argument is
3902 ** a virtual table column.
3903 **
3904 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3905 ** second argument, not the first, as the argument to test to
3906 ** see if it is a column in a virtual table. This is done because
3907 ** the left operand of infix functions (the operand we want to
3908 ** control overloading) ends up as the second argument to the
3909 ** function. The expression "A glob B" is equivalent to
3910 ** "glob(B,A). We want to use the A in "A glob B" to test
3911 ** for function overloading. But we use the B term in "glob(B,A)".
3912 */
drh59155062018-05-26 18:03:48 +00003913 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00003914 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
3915 }else if( nFarg>0 ){
3916 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00003917 }
3918#endif
drhd36e1042013-09-06 13:10:12 +00003919 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00003920 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00003921 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00003922 }
drh092457b2017-12-29 15:04:49 +00003923#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3924 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00003925 Expr *pArg = pFarg->a[0].pExpr;
3926 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00003927 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00003928 }else{
3929 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3930 }
drh092457b2017-12-29 15:04:49 +00003931 }else
3932#endif
3933 {
drh2fc865c2017-12-16 20:20:37 +00003934 sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
3935 constMask, r1, target, (char*)pDef, P4_FUNCDEF);
3936 sqlite3VdbeChangeP5(v, (u8)nFarg);
3937 }
drhd1a01ed2013-11-21 16:08:52 +00003938 if( nFarg && constMask==0 ){
drh12ffee82009-04-08 13:51:51 +00003939 sqlite3ReleaseTempRange(pParse, r1, nFarg);
drh2dcef112008-01-12 19:03:48 +00003940 }
drhc332cc32016-09-19 10:24:19 +00003941 return target;
drhcce7d172000-05-31 15:34:51 +00003942 }
drhfe2093d2005-01-20 22:48:47 +00003943#ifndef SQLITE_OMIT_SUBQUERY
3944 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00003945 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00003946 int nCol;
drhc5499be2008-04-01 15:06:33 +00003947 testcase( op==TK_EXISTS );
3948 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00003949 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
3950 sqlite3SubselectError(pParse, nCol, 1);
3951 }else{
drh85bcdce2018-12-23 21:27:29 +00003952 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00003953 }
drh19a775c2000-06-05 18:54:46 +00003954 break;
3955 }
drhfc7f27b2016-08-20 00:07:01 +00003956 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00003957 int n;
drhfc7f27b2016-08-20 00:07:01 +00003958 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00003959 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00003960 }
drh966e2912017-01-03 02:58:01 +00003961 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00003962 if( pExpr->iTable!=0
3963 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00003964 ){
3965 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3966 pExpr->iTable, n);
3967 }
drhc332cc32016-09-19 10:24:19 +00003968 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00003969 }
drhfef52082000-06-06 01:50:43 +00003970 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00003971 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3972 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00003973 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3974 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3975 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3976 sqlite3VdbeResolveLabel(v, destIfFalse);
3977 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3978 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00003979 return target;
drhfef52082000-06-06 01:50:43 +00003980 }
drhe3365e62009-11-12 17:52:24 +00003981#endif /* SQLITE_OMIT_SUBQUERY */
3982
3983
drh2dcef112008-01-12 19:03:48 +00003984 /*
3985 ** x BETWEEN y AND z
3986 **
3987 ** This is equivalent to
3988 **
3989 ** x>=y AND x<=z
3990 **
3991 ** X is stored in pExpr->pLeft.
3992 ** Y is stored in pExpr->pList->a[0].pExpr.
3993 ** Z is stored in pExpr->pList->a[1].pExpr.
3994 */
drhfef52082000-06-06 01:50:43 +00003995 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00003996 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00003997 return target;
drhfef52082000-06-06 01:50:43 +00003998 }
drh94fa9c42016-02-27 21:16:04 +00003999 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004000 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004001 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004002 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004003 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004004 }
drh2dcef112008-01-12 19:03:48 +00004005
dan165921a2009-08-28 18:53:45 +00004006 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004007 /* If the opcode is TK_TRIGGER, then the expression is a reference
4008 ** to a column in the new.* or old.* pseudo-tables available to
4009 ** trigger programs. In this case Expr.iTable is set to 1 for the
4010 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4011 ** is set to the column of the pseudo-table to read, or to -1 to
4012 ** read the rowid field.
4013 **
4014 ** The expression is implemented using an OP_Param opcode. The p1
4015 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4016 ** to reference another column of the old.* pseudo-table, where
4017 ** i is the index of the column. For a new.rowid reference, p1 is
4018 ** set to (n+1), where n is the number of columns in each pseudo-table.
4019 ** For a reference to any other column in the new.* pseudo-table, p1
4020 ** is set to (n+2+i), where n and i are as defined previously. For
4021 ** example, if the table on which triggers are being fired is
4022 ** declared as:
4023 **
4024 ** CREATE TABLE t1(a, b);
4025 **
4026 ** Then p1 is interpreted as follows:
4027 **
4028 ** p1==0 -> old.rowid p1==3 -> new.rowid
4029 ** p1==1 -> old.a p1==4 -> new.a
4030 ** p1==2 -> old.b p1==5 -> new.b
4031 */
drheda079c2018-09-20 19:02:15 +00004032 Table *pTab = pExpr->y.pTab;
dan65a7cd12009-09-01 12:16:01 +00004033 int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
4034
4035 assert( pExpr->iTable==0 || pExpr->iTable==1 );
4036 assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
4037 assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
4038 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4039
4040 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004041 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004042 (pExpr->iTable ? "new" : "old"),
drheda079c2018-09-20 19:02:15 +00004043 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
dan165921a2009-08-28 18:53:45 +00004044 ));
dan65a7cd12009-09-01 12:16:01 +00004045
drh44dbca82010-01-13 04:22:20 +00004046#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004047 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004048 ** integer. Use OP_RealAffinity to make sure it is really real.
4049 **
4050 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4051 ** floating point when extracting it from the record. */
dan2832ad42009-08-31 15:27:27 +00004052 if( pExpr->iColumn>=0
4053 && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
4054 ){
4055 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4056 }
drh44dbca82010-01-13 04:22:20 +00004057#endif
dan165921a2009-08-28 18:53:45 +00004058 break;
4059 }
4060
dan71c57db2016-07-09 20:23:55 +00004061 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004062 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004063 break;
4064 }
4065
drh9e9a67a2019-08-17 17:07:15 +00004066 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4067 ** that derive from the right-hand table of a LEFT JOIN. The
4068 ** Expr.iTable value is the table number for the right-hand table.
4069 ** The expression is only evaluated if that table is not currently
4070 ** on a LEFT JOIN NULL row.
4071 */
drh31d6fd52017-04-14 19:03:10 +00004072 case TK_IF_NULL_ROW: {
4073 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004074 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004075 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004076 /* Temporarily disable factoring of constant expressions, since
4077 ** even though expressions may appear to be constant, they are not
4078 ** really constant because they originate from the right-hand side
4079 ** of a LEFT JOIN. */
4080 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004081 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004082 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004083 sqlite3VdbeJumpHere(v, addrINR);
4084 sqlite3VdbeChangeP3(v, addrINR, inReg);
4085 break;
4086 }
4087
drh2dcef112008-01-12 19:03:48 +00004088 /*
4089 ** Form A:
4090 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4091 **
4092 ** Form B:
4093 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4094 **
4095 ** Form A is can be transformed into the equivalent form B as follows:
4096 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4097 ** WHEN x=eN THEN rN ELSE y END
4098 **
4099 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004100 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4101 ** odd. The Y is also optional. If the number of elements in x.pList
4102 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004103 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4104 **
4105 ** The result of the expression is the Ri for the first matching Ei,
4106 ** or if there is no matching Ei, the ELSE term Y, or if there is
4107 ** no ELSE term, NULL.
4108 */
drh33cd4902009-05-30 20:49:20 +00004109 default: assert( op==TK_CASE ); {
drh2dcef112008-01-12 19:03:48 +00004110 int endLabel; /* GOTO label for end of CASE stmt */
4111 int nextCase; /* GOTO label for next WHEN clause */
4112 int nExpr; /* 2x number of WHEN terms */
4113 int i; /* Loop counter */
4114 ExprList *pEList; /* List of WHEN terms */
4115 struct ExprList_item *aListelem; /* Array of WHEN terms */
4116 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004117 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004118 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004119 Expr *pDel = 0;
4120 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004121
danielk19776ab3a2e2009-02-19 14:39:25 +00004122 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004123 assert(pExpr->x.pList->nExpr > 0);
4124 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004125 aListelem = pEList->a;
4126 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004127 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004128 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004129 pDel = sqlite3ExprDup(db, pX, 0);
4130 if( db->mallocFailed ){
4131 sqlite3ExprDelete(db, pDel);
4132 break;
4133 }
drh33cd4902009-05-30 20:49:20 +00004134 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004135 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004136 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004137 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004138 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004139 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004140 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004141 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4142 ** The value in regFree1 might get SCopy-ed into the file result.
4143 ** So make sure that the regFree1 register is not reused for other
4144 ** purposes and possibly overwritten. */
4145 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004146 }
drhc5cd1242013-09-12 16:50:49 +00004147 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004148 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004149 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004150 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004151 }else{
drh2dcef112008-01-12 19:03:48 +00004152 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004153 }
drhec4ccdb2018-12-29 02:26:59 +00004154 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004155 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004156 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004157 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004158 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004159 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004160 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004161 }
drhc5cd1242013-09-12 16:50:49 +00004162 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004163 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004164 }else{
drh9de221d2008-01-05 06:51:30 +00004165 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004166 }
dan8b65e592019-07-17 14:34:17 +00004167 sqlite3ExprDelete(db, pDel);
drh2dcef112008-01-12 19:03:48 +00004168 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004169 break;
4170 }
danielk19775338a5f2005-01-20 13:03:10 +00004171#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004172 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004173 assert( pExpr->affExpr==OE_Rollback
4174 || pExpr->affExpr==OE_Abort
4175 || pExpr->affExpr==OE_Fail
4176 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004177 );
dane0af83a2009-09-08 19:15:01 +00004178 if( !pParse->pTriggerTab ){
4179 sqlite3ErrorMsg(pParse,
4180 "RAISE() may only be used within a trigger-program");
4181 return 0;
4182 }
drh11949042019-08-05 18:01:42 +00004183 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004184 sqlite3MayAbort(pParse);
4185 }
dan165921a2009-08-28 18:53:45 +00004186 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004187 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004188 sqlite3VdbeAddOp4(
4189 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004190 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004191 }else{
drh433dccf2013-02-09 15:37:11 +00004192 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
drh11949042019-08-05 18:01:42 +00004193 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004194 }
4195
drhffe07b22005-11-03 00:41:17 +00004196 break;
drh17a7f8d2002-03-24 13:13:27 +00004197 }
danielk19775338a5f2005-01-20 13:03:10 +00004198#endif
drhffe07b22005-11-03 00:41:17 +00004199 }
drh2dcef112008-01-12 19:03:48 +00004200 sqlite3ReleaseTempReg(pParse, regFree1);
4201 sqlite3ReleaseTempReg(pParse, regFree2);
4202 return inReg;
4203}
4204
4205/*
drhd1a01ed2013-11-21 16:08:52 +00004206** Factor out the code of the given expression to initialization time.
drh1e9b53f2017-01-04 01:07:24 +00004207**
drhad879ff2017-01-04 04:10:02 +00004208** If regDest>=0 then the result is always stored in that register and the
4209** result is not reusable. If regDest<0 then this routine is free to
4210** store the value whereever it wants. The register where the expression
4211** is stored is returned. When regDest<0, two identical expressions will
4212** code to the same register.
drhd1a01ed2013-11-21 16:08:52 +00004213*/
drh1e9b53f2017-01-04 01:07:24 +00004214int sqlite3ExprCodeAtInit(
drhd673cdd2013-11-21 21:23:31 +00004215 Parse *pParse, /* Parsing context */
4216 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004217 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004218){
drhd1a01ed2013-11-21 16:08:52 +00004219 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004220 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004221 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004222 if( regDest<0 && p ){
4223 struct ExprList_item *pItem;
4224 int i;
4225 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004226 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004227 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004228 }
4229 }
drh1e9b53f2017-01-04 01:07:24 +00004230 }
drhd1a01ed2013-11-21 16:08:52 +00004231 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4232 p = sqlite3ExprListAppend(pParse, p, pExpr);
drhd673cdd2013-11-21 21:23:31 +00004233 if( p ){
4234 struct ExprList_item *pItem = &p->a[p->nExpr-1];
drhad879ff2017-01-04 04:10:02 +00004235 pItem->reusable = regDest<0;
4236 if( regDest<0 ) regDest = ++pParse->nMem;
drhd673cdd2013-11-21 21:23:31 +00004237 pItem->u.iConstExprReg = regDest;
drhd673cdd2013-11-21 21:23:31 +00004238 }
drhd1a01ed2013-11-21 16:08:52 +00004239 pParse->pConstExpr = p;
drh1e9b53f2017-01-04 01:07:24 +00004240 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004241}
4242
4243/*
drh2dcef112008-01-12 19:03:48 +00004244** Generate code to evaluate an expression and store the results
4245** into a register. Return the register number where the results
4246** are stored.
4247**
4248** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004249** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004250** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004251**
4252** If pExpr is a constant, then this routine might generate this
4253** code to fill the register in the initialization section of the
4254** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004255*/
4256int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004257 int r2;
drh0d950af2019-08-22 16:38:42 +00004258 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004259 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004260 && pExpr->op!=TK_REGISTER
4261 && sqlite3ExprIsConstantNotJoin(pExpr)
4262 ){
drhf30a9692013-11-15 01:10:18 +00004263 *pReg = 0;
drhad879ff2017-01-04 04:10:02 +00004264 r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004265 }else{
drhf30a9692013-11-15 01:10:18 +00004266 int r1 = sqlite3GetTempReg(pParse);
4267 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4268 if( r2==r1 ){
4269 *pReg = r1;
4270 }else{
4271 sqlite3ReleaseTempReg(pParse, r1);
4272 *pReg = 0;
4273 }
drh2dcef112008-01-12 19:03:48 +00004274 }
4275 return r2;
4276}
4277
4278/*
4279** Generate code that will evaluate expression pExpr and store the
4280** results in register target. The results are guaranteed to appear
4281** in register target.
4282*/
drh05a86c52014-02-16 01:55:49 +00004283void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004284 int inReg;
4285
4286 assert( target>0 && target<=pParse->nMem );
drhebc16712010-09-28 00:25:58 +00004287 if( pExpr && pExpr->op==TK_REGISTER ){
4288 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4289 }else{
4290 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
drh1c75c9d2015-12-21 15:22:13 +00004291 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhebc16712010-09-28 00:25:58 +00004292 if( inReg!=target && pParse->pVdbe ){
4293 sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
4294 }
drhcce7d172000-05-31 15:34:51 +00004295 }
drhcce7d172000-05-31 15:34:51 +00004296}
4297
4298/*
drh1c75c9d2015-12-21 15:22:13 +00004299** Make a transient copy of expression pExpr and then code it using
4300** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4301** except that the input expression is guaranteed to be unchanged.
4302*/
4303void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4304 sqlite3 *db = pParse->db;
4305 pExpr = sqlite3ExprDup(db, pExpr, 0);
4306 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4307 sqlite3ExprDelete(db, pExpr);
4308}
4309
4310/*
drh05a86c52014-02-16 01:55:49 +00004311** Generate code that will evaluate expression pExpr and store the
4312** results in register target. The results are guaranteed to appear
4313** in register target. If the expression is constant, then this routine
4314** might choose to code the expression at initialization time.
4315*/
4316void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004317 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drhad879ff2017-01-04 04:10:02 +00004318 sqlite3ExprCodeAtInit(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004319 }else{
4320 sqlite3ExprCode(pParse, pExpr, target);
4321 }
drhcce7d172000-05-31 15:34:51 +00004322}
4323
4324/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004325** Generate code that evaluates the given expression and puts the result
drhde4fcfd2008-01-19 23:50:26 +00004326** in register target.
drh25303782004-12-07 15:41:48 +00004327**
drh2dcef112008-01-12 19:03:48 +00004328** Also make a copy of the expression results into another "cache" register
4329** and modify the expression so that the next time it is evaluated,
4330** the result is a copy of the cache register.
4331**
4332** This routine is used for expressions that are used multiple
4333** times. They are evaluated once and the results of the expression
4334** are reused.
drh25303782004-12-07 15:41:48 +00004335*/
drh05a86c52014-02-16 01:55:49 +00004336void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
drh25303782004-12-07 15:41:48 +00004337 Vdbe *v = pParse->pVdbe;
drh05a86c52014-02-16 01:55:49 +00004338 int iMem;
4339
drhde4fcfd2008-01-19 23:50:26 +00004340 assert( target>0 );
drh05a86c52014-02-16 01:55:49 +00004341 assert( pExpr->op!=TK_REGISTER );
4342 sqlite3ExprCode(pParse, pExpr, target);
4343 iMem = ++pParse->nMem;
4344 sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4345 exprToRegister(pExpr, iMem);
drh25303782004-12-07 15:41:48 +00004346}
drh2dcef112008-01-12 19:03:48 +00004347
drh678ccce2008-03-31 18:19:54 +00004348/*
drh268380c2004-02-25 13:47:31 +00004349** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004350** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004351**
drh3df6c3b2017-09-15 15:38:01 +00004352** Return the number of elements evaluated. The number returned will
4353** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4354** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004355**
4356** The SQLITE_ECEL_DUP flag prevents the arguments from being
4357** filled using OP_SCopy. OP_Copy must be used instead.
4358**
4359** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4360** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004361**
4362** The SQLITE_ECEL_REF flag means that expressions in the list with
4363** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4364** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004365** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4366** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004367*/
danielk19774adee202004-05-08 08:23:19 +00004368int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004369 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004370 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004371 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004372 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004373 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004374){
4375 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004376 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004377 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004378 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004379 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004380 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004381 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004382 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004383 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004384 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004385 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004386#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4387 if( pItem->bSorterRef ){
4388 i--;
4389 n--;
4390 }else
4391#endif
dan257c13f2016-11-10 20:14:06 +00004392 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4393 if( flags & SQLITE_ECEL_OMITREF ){
4394 i--;
4395 n--;
4396 }else{
4397 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4398 }
drhb8b06692018-08-04 15:16:20 +00004399 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4400 && sqlite3ExprIsConstantNotJoin(pExpr)
4401 ){
drhad879ff2017-01-04 04:10:02 +00004402 sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004403 }else{
4404 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4405 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004406 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004407 if( copyOp==OP_Copy
4408 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4409 && pOp->p1+pOp->p3+1==inReg
4410 && pOp->p2+pOp->p3+1==target+i
4411 ){
4412 pOp->p3++;
4413 }else{
4414 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4415 }
drhd1a01ed2013-11-21 16:08:52 +00004416 }
drhd1766112008-09-17 00:13:12 +00004417 }
drh268380c2004-02-25 13:47:31 +00004418 }
drhf9b596e2004-05-26 16:54:42 +00004419 return n;
drh268380c2004-02-25 13:47:31 +00004420}
4421
4422/*
drh36c563a2009-11-12 13:32:22 +00004423** Generate code for a BETWEEN operator.
4424**
4425** x BETWEEN y AND z
4426**
4427** The above is equivalent to
4428**
4429** x>=y AND x<=z
4430**
4431** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004432** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004433**
4434** The xJumpIf parameter determines details:
4435**
4436** NULL: Store the boolean result in reg[dest]
4437** sqlite3ExprIfTrue: Jump to dest if true
4438** sqlite3ExprIfFalse: Jump to dest if false
4439**
4440** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004441*/
4442static void exprCodeBetween(
4443 Parse *pParse, /* Parsing and code generating context */
4444 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004445 int dest, /* Jump destination or storage location */
4446 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004447 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4448){
dan8b65e592019-07-17 14:34:17 +00004449 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004450 Expr compLeft; /* The x>=y term */
4451 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004452 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004453 Expr *pDel = 0;
4454 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004455
dan71c57db2016-07-09 20:23:55 +00004456 memset(&compLeft, 0, sizeof(Expr));
4457 memset(&compRight, 0, sizeof(Expr));
4458 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004459
4460 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004461 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4462 if( db->mallocFailed==0 ){
4463 exprAnd.op = TK_AND;
4464 exprAnd.pLeft = &compLeft;
4465 exprAnd.pRight = &compRight;
4466 compLeft.op = TK_GE;
4467 compLeft.pLeft = pDel;
4468 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4469 compRight.op = TK_LE;
4470 compRight.pLeft = pDel;
4471 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4472 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4473 if( xJump ){
4474 xJump(pParse, &exprAnd, dest, jumpIfNull);
4475 }else{
4476 /* Mark the expression is being from the ON or USING clause of a join
4477 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4478 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4479 ** for clarity, but we are out of bits in the Expr.flags field so we
4480 ** have to reuse the EP_FromJoin bit. Bummer. */
4481 pDel->flags |= EP_FromJoin;
4482 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4483 }
4484 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004485 }
dan8b65e592019-07-17 14:34:17 +00004486 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004487
4488 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004489 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4490 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4491 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4492 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4493 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4494 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4495 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4496 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004497 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004498}
4499
4500/*
drhcce7d172000-05-31 15:34:51 +00004501** Generate code for a boolean expression such that a jump is made
4502** to the label "dest" if the expression is true but execution
4503** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004504**
4505** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004506** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004507**
4508** This code depends on the fact that certain token values (ex: TK_EQ)
4509** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4510** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4511** the make process cause these values to align. Assert()s in the code
4512** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004513*/
danielk19774adee202004-05-08 08:23:19 +00004514void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004515 Vdbe *v = pParse->pVdbe;
4516 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004517 int regFree1 = 0;
4518 int regFree2 = 0;
4519 int r1, r2;
4520
drh35573352008-01-08 23:54:25 +00004521 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004522 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004523 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhf2bc0132004-10-04 13:19:23 +00004524 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004525 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004526 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004527 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004528 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4529 if( pAlt!=pExpr ){
4530 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4531 }else if( op==TK_AND ){
4532 int d2 = sqlite3VdbeMakeLabel(pParse);
4533 testcase( jumpIfNull==0 );
4534 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4535 jumpIfNull^SQLITE_JUMPIFNULL);
4536 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4537 sqlite3VdbeResolveLabel(v, d2);
4538 }else{
4539 testcase( jumpIfNull==0 );
4540 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4541 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4542 }
drhcce7d172000-05-31 15:34:51 +00004543 break;
4544 }
4545 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004546 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004547 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004548 break;
4549 }
drh8abed7b2018-02-26 18:49:05 +00004550 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004551 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4552 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004553 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004554 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004555 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004556 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004557 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004558 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004559 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4560 isNot ? SQLITE_JUMPIFNULL : 0);
4561 }else{
4562 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4563 isNot ? SQLITE_JUMPIFNULL : 0);
4564 }
drh007c8432018-02-26 03:20:18 +00004565 break;
4566 }
drhde845c22016-03-17 19:07:52 +00004567 case TK_IS:
4568 case TK_ISNOT:
4569 testcase( op==TK_IS );
4570 testcase( op==TK_ISNOT );
4571 op = (op==TK_IS) ? TK_EQ : TK_NE;
4572 jumpIfNull = SQLITE_NULLEQ;
4573 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004574 case TK_LT:
4575 case TK_LE:
4576 case TK_GT:
4577 case TK_GE:
4578 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004579 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004580 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004581 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004582 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4583 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004584 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004585 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004586 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4587 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4588 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4589 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004590 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4591 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4592 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4593 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4594 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4595 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004596 testcase( regFree1==0 );
4597 testcase( regFree2==0 );
4598 break;
4599 }
drhcce7d172000-05-31 15:34:51 +00004600 case TK_ISNULL:
4601 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004602 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4603 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004604 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4605 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004606 VdbeCoverageIf(v, op==TK_ISNULL);
4607 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004608 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004609 break;
4610 }
drhfef52082000-06-06 01:50:43 +00004611 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004612 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004613 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004614 break;
4615 }
drh84e30ca2011-02-10 17:46:14 +00004616#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004617 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004618 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004619 int destIfNull = jumpIfNull ? dest : destIfFalse;
4620 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004621 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004622 sqlite3VdbeResolveLabel(v, destIfFalse);
4623 break;
4624 }
shanehbb201342011-02-09 19:55:20 +00004625#endif
drhcce7d172000-05-31 15:34:51 +00004626 default: {
dan7b35a772016-07-28 19:47:15 +00004627 default_expr:
drhad317272019-04-19 16:21:51 +00004628 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004629 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004630 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004631 /* No-op */
4632 }else{
4633 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4634 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004635 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004636 testcase( regFree1==0 );
4637 testcase( jumpIfNull==0 );
4638 }
drhcce7d172000-05-31 15:34:51 +00004639 break;
4640 }
4641 }
drh2dcef112008-01-12 19:03:48 +00004642 sqlite3ReleaseTempReg(pParse, regFree1);
4643 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004644}
4645
4646/*
drh66b89c82000-11-28 20:47:17 +00004647** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004648** to the label "dest" if the expression is false but execution
4649** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004650**
4651** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004652** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4653** is 0.
drhcce7d172000-05-31 15:34:51 +00004654*/
danielk19774adee202004-05-08 08:23:19 +00004655void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004656 Vdbe *v = pParse->pVdbe;
4657 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004658 int regFree1 = 0;
4659 int regFree2 = 0;
4660 int r1, r2;
4661
drh35573352008-01-08 23:54:25 +00004662 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004663 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004664 if( pExpr==0 ) return;
drhf2bc0132004-10-04 13:19:23 +00004665
4666 /* The value of pExpr->op and op are related as follows:
4667 **
4668 ** pExpr->op op
4669 ** --------- ----------
4670 ** TK_ISNULL OP_NotNull
4671 ** TK_NOTNULL OP_IsNull
4672 ** TK_NE OP_Eq
4673 ** TK_EQ OP_Ne
4674 ** TK_GT OP_Le
4675 ** TK_LE OP_Gt
4676 ** TK_GE OP_Lt
4677 ** TK_LT OP_Ge
4678 **
4679 ** For other values of pExpr->op, op is undefined and unused.
4680 ** The value of TK_ and OP_ constants are arranged such that we
4681 ** can compute the mapping above using the following expression.
4682 ** Assert()s verify that the computation is correct.
4683 */
4684 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4685
4686 /* Verify correct alignment of TK_ and OP_ constants
4687 */
4688 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4689 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4690 assert( pExpr->op!=TK_NE || op==OP_Eq );
4691 assert( pExpr->op!=TK_EQ || op==OP_Ne );
4692 assert( pExpr->op!=TK_LT || op==OP_Ge );
4693 assert( pExpr->op!=TK_LE || op==OP_Gt );
4694 assert( pExpr->op!=TK_GT || op==OP_Le );
4695 assert( pExpr->op!=TK_GE || op==OP_Lt );
4696
danba00e302016-07-23 20:24:06 +00004697 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00004698 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004699 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004700 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4701 if( pAlt!=pExpr ){
4702 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
4703 }else if( pExpr->op==TK_AND ){
4704 testcase( jumpIfNull==0 );
4705 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4706 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4707 }else{
4708 int d2 = sqlite3VdbeMakeLabel(pParse);
4709 testcase( jumpIfNull==0 );
4710 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
4711 jumpIfNull^SQLITE_JUMPIFNULL);
4712 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4713 sqlite3VdbeResolveLabel(v, d2);
4714 }
drhcce7d172000-05-31 15:34:51 +00004715 break;
4716 }
4717 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00004718 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004719 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004720 break;
4721 }
drh8abed7b2018-02-26 18:49:05 +00004722 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004723 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4724 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00004725 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004726 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004727 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004728 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004729 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004730 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004731 /* IS TRUE and IS NOT FALSE */
4732 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4733 isNot ? 0 : SQLITE_JUMPIFNULL);
4734
4735 }else{
4736 /* IS FALSE and IS NOT TRUE */
4737 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00004738 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00004739 }
drh007c8432018-02-26 03:20:18 +00004740 break;
4741 }
drhde845c22016-03-17 19:07:52 +00004742 case TK_IS:
4743 case TK_ISNOT:
4744 testcase( pExpr->op==TK_IS );
4745 testcase( pExpr->op==TK_ISNOT );
4746 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4747 jumpIfNull = SQLITE_NULLEQ;
4748 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004749 case TK_LT:
4750 case TK_LE:
4751 case TK_GT:
4752 case TK_GE:
4753 case TK_NE:
4754 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004755 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004756 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004757 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4758 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004759 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh2dcef112008-01-12 19:03:48 +00004760 r1, r2, dest, jumpIfNull);
drh7d176102014-02-18 03:07:12 +00004761 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4762 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4763 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4764 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004765 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4766 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4767 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4768 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4769 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4770 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004771 testcase( regFree1==0 );
4772 testcase( regFree2==0 );
4773 break;
4774 }
drhcce7d172000-05-31 15:34:51 +00004775 case TK_ISNULL:
4776 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00004777 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4778 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004779 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
4780 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004781 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004782 break;
4783 }
drhfef52082000-06-06 01:50:43 +00004784 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004785 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004786 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004787 break;
4788 }
drh84e30ca2011-02-10 17:46:14 +00004789#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004790 case TK_IN: {
4791 if( jumpIfNull ){
4792 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4793 }else{
drhec4ccdb2018-12-29 02:26:59 +00004794 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004795 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4796 sqlite3VdbeResolveLabel(v, destIfNull);
4797 }
4798 break;
4799 }
shanehbb201342011-02-09 19:55:20 +00004800#endif
drhcce7d172000-05-31 15:34:51 +00004801 default: {
danba00e302016-07-23 20:24:06 +00004802 default_expr:
drhad317272019-04-19 16:21:51 +00004803 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004804 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004805 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004806 /* no-op */
4807 }else{
4808 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4809 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004810 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004811 testcase( regFree1==0 );
4812 testcase( jumpIfNull==0 );
4813 }
drhcce7d172000-05-31 15:34:51 +00004814 break;
4815 }
4816 }
drh2dcef112008-01-12 19:03:48 +00004817 sqlite3ReleaseTempReg(pParse, regFree1);
4818 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004819}
drh22827922000-06-06 17:27:05 +00004820
4821/*
drh72bc8202015-06-11 13:58:35 +00004822** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
4823** code generation, and that copy is deleted after code generation. This
4824** ensures that the original pExpr is unchanged.
4825*/
4826void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
4827 sqlite3 *db = pParse->db;
4828 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
4829 if( db->mallocFailed==0 ){
4830 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
4831 }
4832 sqlite3ExprDelete(db, pCopy);
4833}
4834
dan5aa550c2017-06-24 18:10:29 +00004835/*
4836** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
4837** type of expression.
4838**
4839** If pExpr is a simple SQL value - an integer, real, string, blob
4840** or NULL value - then the VDBE currently being prepared is configured
4841** to re-prepare each time a new value is bound to variable pVar.
4842**
4843** Additionally, if pExpr is a simple SQL value and the value is the
4844** same as that currently bound to variable pVar, non-zero is returned.
4845** Otherwise, if the values are not the same or if pExpr is not a simple
4846** SQL value, zero is returned.
4847*/
4848static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
4849 int res = 0;
drhc0804222017-06-28 21:47:16 +00004850 int iVar;
4851 sqlite3_value *pL, *pR = 0;
4852
4853 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4854 if( pR ){
4855 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00004856 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00004857 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00004858 if( pL ){
4859 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
4860 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
4861 }
4862 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00004863 }
drhc0804222017-06-28 21:47:16 +00004864 sqlite3ValueFree(pR);
4865 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00004866 }
4867
4868 return res;
4869}
drh72bc8202015-06-11 13:58:35 +00004870
4871/*
drh1d9da702010-01-07 15:17:02 +00004872** Do a deep comparison of two expression trees. Return 0 if the two
4873** expressions are completely identical. Return 1 if they differ only
4874** by a COLLATE operator at the top level. Return 2 if there are differences
4875** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00004876**
drh619a1302013-08-01 13:04:46 +00004877** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4878** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4879**
drh66518ca2013-08-01 15:09:57 +00004880** The pA side might be using TK_REGISTER. If that is the case and pB is
4881** not using TK_REGISTER but is otherwise equivalent, then still return 0.
4882**
drh1d9da702010-01-07 15:17:02 +00004883** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00004884** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00004885** identical, we return 2 just to be safe. So if this routine
4886** returns 2, then you do not really know for certain if the two
4887** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00004888** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00004889** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00004890** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00004891** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00004892**
drhc0804222017-06-28 21:47:16 +00004893** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4894** pParse->pReprepare can be matched against literals in pB. The
4895** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4896** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4897** Argument pParse should normally be NULL. If it is not NULL and pA or
4898** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00004899*/
dan5aa550c2017-06-24 18:10:29 +00004900int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00004901 u32 combinedFlags;
4902 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00004903 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00004904 }
dan5aa550c2017-06-24 18:10:29 +00004905 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
4906 return 0;
4907 }
drh10d1edf2013-11-15 15:52:39 +00004908 combinedFlags = pA->flags | pB->flags;
4909 if( combinedFlags & EP_IntValue ){
4910 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
4911 return 0;
4912 }
drh1d9da702010-01-07 15:17:02 +00004913 return 2;
drh22827922000-06-06 17:27:05 +00004914 }
dan16dd3982018-12-20 15:04:38 +00004915 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00004916 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004917 return 1;
4918 }
dan5aa550c2017-06-24 18:10:29 +00004919 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00004920 return 1;
4921 }
4922 return 2;
4923 }
drh2edc5fd2015-11-24 02:10:52 +00004924 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00004925 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00004926 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00004927#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00004928 assert( pA->op==pB->op );
4929 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4930 return 2;
4931 }
drheda079c2018-09-20 19:02:15 +00004932 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00004933 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
4934 return 2;
4935 }
drheda079c2018-09-20 19:02:15 +00004936 }
4937#endif
drhf20bbc52019-01-17 01:06:00 +00004938 }else if( pA->op==TK_NULL ){
4939 return 0;
drhd5af5422018-04-13 14:27:01 +00004940 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00004941 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00004942 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00004943 return 2;
drh2646da72005-12-09 20:02:05 +00004944 }
drh22827922000-06-06 17:27:05 +00004945 }
drh10d1edf2013-11-15 15:52:39 +00004946 if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
drh89b6de02018-12-12 20:11:23 +00004947 if( (combinedFlags & EP_TokenOnly)==0 ){
drh10d1edf2013-11-15 15:52:39 +00004948 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00004949 if( (combinedFlags & EP_FixedCol)==0
4950 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00004951 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004952 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00004953 if( pA->op!=TK_STRING
4954 && pA->op!=TK_TRUEFALSE
4955 && (combinedFlags & EP_Reduced)==0
4956 ){
drh10d1edf2013-11-15 15:52:39 +00004957 if( pA->iColumn!=pB->iColumn ) return 2;
dan8ac02a92019-05-20 10:36:15 +00004958 if( pA->op2!=pB->op2 ) return 2;
drhebc64082019-09-27 15:15:38 +00004959 if( pA->op!=TK_IN
4960 && pA->iTable!=pB->iTable
drh85f8aa72013-11-15 20:06:26 +00004961 && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00004962 }
4963 }
drh1d9da702010-01-07 15:17:02 +00004964 return 0;
drh22827922000-06-06 17:27:05 +00004965}
4966
drh8c6f6662010-04-26 19:17:26 +00004967/*
4968** Compare two ExprList objects. Return 0 if they are identical and
4969** non-zero if they differ in any way.
4970**
drh619a1302013-08-01 13:04:46 +00004971** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4972** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4973**
drh8c6f6662010-04-26 19:17:26 +00004974** This routine might return non-zero for equivalent ExprLists. The
4975** only consequence will be disabled optimizations. But this routine
4976** must never return 0 if the two ExprList objects are different, or
4977** a malfunction will result.
4978**
4979** Two NULL pointers are considered to be the same. But a NULL pointer
4980** always differs from a non-NULL pointer.
4981*/
drh619a1302013-08-01 13:04:46 +00004982int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00004983 int i;
4984 if( pA==0 && pB==0 ) return 0;
4985 if( pA==0 || pB==0 ) return 1;
4986 if( pA->nExpr!=pB->nExpr ) return 1;
4987 for(i=0; i<pA->nExpr; i++){
4988 Expr *pExprA = pA->a[i].pExpr;
4989 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00004990 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
dan5aa550c2017-06-24 18:10:29 +00004991 if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
drh8c6f6662010-04-26 19:17:26 +00004992 }
4993 return 0;
4994}
drh13449892005-09-07 21:22:45 +00004995
drh22827922000-06-06 17:27:05 +00004996/*
drhf9463df2017-02-11 14:59:58 +00004997** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4998** are ignored.
4999*/
5000int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005001 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005002 sqlite3ExprSkipCollateAndLikely(pA),
5003 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005004 iTab);
5005}
5006
5007/*
drhc51cf862019-05-11 19:36:03 +00005008** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005009**
5010** Or if seenNot is true, return non-zero if Expr p can only be
5011** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005012*/
5013static int exprImpliesNotNull(
5014 Parse *pParse, /* Parsing context */
5015 Expr *p, /* The expression to be checked */
5016 Expr *pNN, /* The expression that is NOT NULL */
5017 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005018 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005019){
5020 assert( p );
5021 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005022 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5023 return pNN->op!=TK_NULL;
5024 }
drhc51cf862019-05-11 19:36:03 +00005025 switch( p->op ){
5026 case TK_IN: {
5027 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5028 assert( ExprHasProperty(p,EP_xIsSelect)
5029 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005030 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005031 }
5032 case TK_BETWEEN: {
5033 ExprList *pList = p->x.pList;
5034 assert( pList!=0 );
5035 assert( pList->nExpr==2 );
5036 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005037 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5038 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005039 ){
5040 return 1;
5041 }
drh7a231b42019-08-30 15:11:08 +00005042 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005043 }
5044 case TK_EQ:
5045 case TK_NE:
5046 case TK_LT:
5047 case TK_LE:
5048 case TK_GT:
5049 case TK_GE:
5050 case TK_PLUS:
5051 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005052 case TK_BITOR:
5053 case TK_LSHIFT:
5054 case TK_RSHIFT:
5055 case TK_CONCAT:
5056 seenNot = 1;
5057 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005058 case TK_STAR:
5059 case TK_REM:
5060 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005061 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005062 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5063 /* Fall thru into the next case */
5064 }
5065 case TK_SPAN:
5066 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005067 case TK_UPLUS:
5068 case TK_UMINUS: {
5069 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5070 }
5071 case TK_TRUTH: {
5072 if( seenNot ) return 0;
5073 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005074 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005075 }
dan1cd382e2019-08-29 15:06:35 +00005076 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005077 case TK_NOT: {
5078 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5079 }
5080 }
5081 return 0;
5082}
5083
5084/*
drh4bd5f732013-07-31 23:22:39 +00005085** Return true if we can prove the pE2 will always be true if pE1 is
5086** true. Return false if we cannot complete the proof or if pE2 might
5087** be false. Examples:
5088**
drh619a1302013-08-01 13:04:46 +00005089** pE1: x==5 pE2: x==5 Result: true
5090** pE1: x>0 pE2: x==5 Result: false
5091** pE1: x=21 pE2: x=21 OR y=43 Result: true
5092** pE1: x!=123 pE2: x IS NOT NULL Result: true
5093** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5094** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5095** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005096**
5097** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5098** Expr.iTable<0 then assume a table number given by iTab.
5099**
drhc0804222017-06-28 21:47:16 +00005100** If pParse is not NULL, then the values of bound variables in pE1 are
5101** compared against literal values in pE2 and pParse->pVdbe->expmask is
5102** modified to record which bound variables are referenced. If pParse
5103** is NULL, then false will be returned if pE1 contains any bound variables.
5104**
drh4bd5f732013-07-31 23:22:39 +00005105** When in doubt, return false. Returning true might give a performance
5106** improvement. Returning false might cause a performance reduction, but
5107** it will always give the correct answer and is hence always safe.
5108*/
dan5aa550c2017-06-24 18:10:29 +00005109int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5110 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005111 return 1;
5112 }
5113 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005114 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5115 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005116 ){
5117 return 1;
5118 }
drh664d6d12019-05-04 17:32:07 +00005119 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005120 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005121 ){
drhc51cf862019-05-11 19:36:03 +00005122 return 1;
drh619a1302013-08-01 13:04:46 +00005123 }
5124 return 0;
drh4bd5f732013-07-31 23:22:39 +00005125}
5126
5127/*
drh25897872018-03-20 21:16:15 +00005128** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
5129** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005130** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5131**
5132** This routine controls an optimization. False positives (setting
5133** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5134** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005135*/
5136static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005137 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005138 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005139 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5140 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005141 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005142 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005143 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005144 case TK_IS:
5145 case TK_OR:
drh2c492062018-03-24 13:24:02 +00005146 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005147 case TK_IN:
drh25897872018-03-20 21:16:15 +00005148 case TK_FUNCTION:
dan04932222018-04-10 15:31:56 +00005149 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005150 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005151 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005152 testcase( pExpr->op==TK_IS );
5153 testcase( pExpr->op==TK_OR );
5154 testcase( pExpr->op==TK_CASE );
5155 testcase( pExpr->op==TK_IN );
5156 testcase( pExpr->op==TK_FUNCTION );
drh25897872018-03-20 21:16:15 +00005157 return WRC_Prune;
5158 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005159 if( pWalker->u.iCur==pExpr->iTable ){
5160 pWalker->eCode = 1;
5161 return WRC_Abort;
5162 }
5163 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005164
dan9d23ea72019-08-29 19:34:29 +00005165 case TK_AND:
5166 if( sqlite3ExprImpliesNonNullRow(pExpr->pLeft, pWalker->u.iCur)
5167 && sqlite3ExprImpliesNonNullRow(pExpr->pRight, pWalker->u.iCur)
5168 ){
5169 pWalker->eCode = 1;
5170 }
5171 return WRC_Prune;
5172
5173 case TK_BETWEEN:
5174 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5175 return WRC_Prune;
5176
drh98811552018-04-03 14:04:48 +00005177 /* Virtual tables are allowed to use constraints like x=NULL. So
5178 ** a term of the form x=y does not prove that y is not null if x
5179 ** is the column of a virtual table */
5180 case TK_EQ:
5181 case TK_NE:
5182 case TK_LT:
5183 case TK_LE:
5184 case TK_GT:
5185 case TK_GE:
5186 testcase( pExpr->op==TK_EQ );
5187 testcase( pExpr->op==TK_NE );
5188 testcase( pExpr->op==TK_LT );
5189 testcase( pExpr->op==TK_LE );
5190 testcase( pExpr->op==TK_GT );
5191 testcase( pExpr->op==TK_GE );
drheda079c2018-09-20 19:02:15 +00005192 if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5193 || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005194 ){
5195 return WRC_Prune;
5196 }
dan9d23ea72019-08-29 19:34:29 +00005197
drh25897872018-03-20 21:16:15 +00005198 default:
5199 return WRC_Continue;
5200 }
5201}
5202
5203/*
5204** Return true (non-zero) if expression p can only be true if at least
5205** one column of table iTab is non-null. In other words, return true
5206** if expression p will always be NULL or false if every column of iTab
5207** is NULL.
5208**
drh821b6102018-03-24 18:01:51 +00005209** False negatives are acceptable. In other words, it is ok to return
5210** zero even if expression p will never be true of every column of iTab
5211** is NULL. A false negative is merely a missed optimization opportunity.
5212**
5213** False positives are not allowed, however. A false positive may result
5214** in an incorrect answer.
5215**
drh25897872018-03-20 21:16:15 +00005216** Terms of p that are marked with EP_FromJoin (and hence that come from
5217** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5218**
5219** This routine is used to check if a LEFT JOIN can be converted into
5220** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5221** clause requires that some column of the right table of the LEFT JOIN
5222** be non-NULL, then the LEFT JOIN can be safely converted into an
5223** ordinary join.
5224*/
5225int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5226 Walker w;
drh0d950af2019-08-22 16:38:42 +00005227 p = sqlite3ExprSkipCollateAndLikely(p);
drhd6db6592019-04-01 19:42:42 +00005228 while( p ){
5229 if( p->op==TK_NOTNULL ){
5230 p = p->pLeft;
5231 }else if( p->op==TK_AND ){
5232 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5233 p = p->pRight;
5234 }else{
5235 break;
5236 }
5237 }
drh25897872018-03-20 21:16:15 +00005238 w.xExprCallback = impliesNotNullRow;
5239 w.xSelectCallback = 0;
5240 w.xSelectCallback2 = 0;
5241 w.eCode = 0;
5242 w.u.iCur = iTab;
5243 sqlite3WalkExpr(&w, p);
5244 return w.eCode;
5245}
5246
5247/*
drh030796d2012-08-23 16:18:10 +00005248** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005249** to determine if an expression can be evaluated by reference to the
5250** index only, without having to do a search for the corresponding
5251** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5252** is the cursor for the table.
5253*/
5254struct IdxCover {
5255 Index *pIdx; /* The index to be tested for coverage */
5256 int iCur; /* Cursor number for the table corresponding to the index */
5257};
5258
5259/*
5260** Check to see if there are references to columns in table
5261** pWalker->u.pIdxCover->iCur can be satisfied using the index
5262** pWalker->u.pIdxCover->pIdx.
5263*/
5264static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5265 if( pExpr->op==TK_COLUMN
5266 && pExpr->iTable==pWalker->u.pIdxCover->iCur
5267 && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
5268 ){
5269 pWalker->eCode = 1;
5270 return WRC_Abort;
5271 }
5272 return WRC_Continue;
5273}
5274
5275/*
drhe604ec02016-07-27 19:20:58 +00005276** Determine if an index pIdx on table with cursor iCur contains will
5277** the expression pExpr. Return true if the index does cover the
5278** expression and false if the pExpr expression references table columns
5279** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005280**
5281** An index covering an expression means that the expression can be
5282** evaluated using only the index and without having to lookup the
5283** corresponding table entry.
5284*/
5285int sqlite3ExprCoveredByIndex(
5286 Expr *pExpr, /* The index to be tested */
5287 int iCur, /* The cursor number for the corresponding table */
5288 Index *pIdx /* The index that might be used for coverage */
5289){
5290 Walker w;
5291 struct IdxCover xcov;
5292 memset(&w, 0, sizeof(w));
5293 xcov.iCur = iCur;
5294 xcov.pIdx = pIdx;
5295 w.xExprCallback = exprIdxCover;
5296 w.u.pIdxCover = &xcov;
5297 sqlite3WalkExpr(&w, pExpr);
5298 return !w.eCode;
5299}
5300
5301
5302/*
5303** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005304** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005305** aggregate function, in order to implement the
5306** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005307*/
drh030796d2012-08-23 16:18:10 +00005308struct SrcCount {
5309 SrcList *pSrc; /* One particular FROM clause in a nested query */
5310 int nThis; /* Number of references to columns in pSrcList */
5311 int nOther; /* Number of references to columns in other FROM clauses */
5312};
5313
5314/*
5315** Count the number of references to columns.
5316*/
5317static int exprSrcCount(Walker *pWalker, Expr *pExpr){
drhfb0a6082012-08-24 01:07:52 +00005318 /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5319 ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5320 ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
5321 ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5322 ** NEVER() will need to be removed. */
5323 if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
drh374fdce2012-04-17 16:38:53 +00005324 int i;
drh030796d2012-08-23 16:18:10 +00005325 struct SrcCount *p = pWalker->u.pSrcCount;
5326 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005327 int nSrc = pSrc ? pSrc->nSrc : 0;
5328 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005329 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005330 }
drh655814d2015-01-09 01:27:29 +00005331 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005332 p->nThis++;
drh80f6bfc2019-08-31 20:13:30 +00005333 }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
5334 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005335 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005336 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005337 p->nOther++;
5338 }
drh374fdce2012-04-17 16:38:53 +00005339 }
drh030796d2012-08-23 16:18:10 +00005340 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005341}
5342
5343/*
drh030796d2012-08-23 16:18:10 +00005344** Determine if any of the arguments to the pExpr Function reference
5345** pSrcList. Return true if they do. Also return true if the function
5346** has no arguments or has only constant arguments. Return false if pExpr
5347** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005348*/
drh030796d2012-08-23 16:18:10 +00005349int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005350 Walker w;
drh030796d2012-08-23 16:18:10 +00005351 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005352 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005353 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005354 w.xExprCallback = exprSrcCount;
drh80f6bfc2019-08-31 20:13:30 +00005355 w.xSelectCallback = sqlite3SelectWalkNoop;
drh030796d2012-08-23 16:18:10 +00005356 w.u.pSrcCount = &cnt;
5357 cnt.pSrc = pSrcList;
5358 cnt.nThis = 0;
5359 cnt.nOther = 0;
5360 sqlite3WalkExprList(&w, pExpr->x.pList);
5361 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005362}
5363
5364/*
drh13449892005-09-07 21:22:45 +00005365** Add a new element to the pAggInfo->aCol[] array. Return the index of
5366** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005367*/
drh17435752007-08-16 04:30:38 +00005368static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005369 int i;
drhcf643722007-03-27 13:36:37 +00005370 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005371 db,
drhcf643722007-03-27 13:36:37 +00005372 pInfo->aCol,
5373 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005374 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005375 &i
5376 );
drh13449892005-09-07 21:22:45 +00005377 return i;
5378}
5379
5380/*
5381** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5382** the new element. Return a negative number if malloc fails.
5383*/
drh17435752007-08-16 04:30:38 +00005384static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005385 int i;
drhcf643722007-03-27 13:36:37 +00005386 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005387 db,
drhcf643722007-03-27 13:36:37 +00005388 pInfo->aFunc,
5389 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005390 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005391 &i
5392 );
drh13449892005-09-07 21:22:45 +00005393 return i;
5394}
drh22827922000-06-06 17:27:05 +00005395
5396/*
drh7d10d5a2008-08-20 16:35:10 +00005397** This is the xExprCallback for a tree walker. It is used to
5398** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005399** for additional information.
drh22827922000-06-06 17:27:05 +00005400*/
drh7d10d5a2008-08-20 16:35:10 +00005401static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005402 int i;
drh7d10d5a2008-08-20 16:35:10 +00005403 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005404 Parse *pParse = pNC->pParse;
5405 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005406 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005407
drh25c3b8c2018-04-16 10:34:13 +00005408 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005409 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005410 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005411 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005412 testcase( pExpr->op==TK_AGG_COLUMN );
5413 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005414 /* Check to see if the column is in one of the tables in the FROM
5415 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005416 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005417 struct SrcList_item *pItem = pSrcList->a;
5418 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5419 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005420 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005421 if( pExpr->iTable==pItem->iCursor ){
5422 /* If we reach this point, it means that pExpr refers to a table
5423 ** that is in the FROM clause of the aggregate query.
5424 **
5425 ** Make an entry for the column in pAggInfo->aCol[] if there
5426 ** is not an entry there already.
5427 */
drh7f906d62007-03-12 23:48:52 +00005428 int k;
drh13449892005-09-07 21:22:45 +00005429 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005430 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005431 if( pCol->iTable==pExpr->iTable &&
5432 pCol->iColumn==pExpr->iColumn ){
5433 break;
5434 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005435 }
danielk19771e536952007-08-16 10:09:01 +00005436 if( (k>=pAggInfo->nColumn)
5437 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5438 ){
drh7f906d62007-03-12 23:48:52 +00005439 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005440 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005441 pCol->iTable = pExpr->iTable;
5442 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005443 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005444 pCol->iSorterColumn = -1;
drh5774b802005-09-07 22:48:16 +00005445 pCol->pExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005446 if( pAggInfo->pGroupBy ){
5447 int j, n;
5448 ExprList *pGB = pAggInfo->pGroupBy;
5449 struct ExprList_item *pTerm = pGB->a;
5450 n = pGB->nExpr;
5451 for(j=0; j<n; j++, pTerm++){
5452 Expr *pE = pTerm->pExpr;
5453 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5454 pE->iColumn==pExpr->iColumn ){
5455 pCol->iSorterColumn = j;
5456 break;
5457 }
5458 }
5459 }
5460 if( pCol->iSorterColumn<0 ){
5461 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5462 }
5463 }
5464 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5465 ** because it was there before or because we just created it).
5466 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5467 ** pAggInfo->aCol[] entry.
5468 */
drhebb6a652013-09-12 23:42:22 +00005469 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005470 pExpr->pAggInfo = pAggInfo;
5471 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005472 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005473 break;
5474 } /* endif pExpr->iTable==pItem->iCursor */
5475 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005476 }
drh7d10d5a2008-08-20 16:35:10 +00005477 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005478 }
5479 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005480 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005481 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005482 ){
drh13449892005-09-07 21:22:45 +00005483 /* Check to see if pExpr is a duplicate of another aggregate
5484 ** function that is already in the pAggInfo structure
5485 */
5486 struct AggInfo_func *pItem = pAggInfo->aFunc;
5487 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
dan5aa550c2017-06-24 18:10:29 +00005488 if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005489 break;
5490 }
drh22827922000-06-06 17:27:05 +00005491 }
drh13449892005-09-07 21:22:45 +00005492 if( i>=pAggInfo->nFunc ){
5493 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5494 */
danielk197714db2662006-01-09 16:12:04 +00005495 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005496 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005497 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005498 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005499 pItem = &pAggInfo->aFunc[i];
5500 pItem->pExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005501 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005502 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005503 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005504 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005505 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005506 if( pExpr->flags & EP_Distinct ){
5507 pItem->iDistinct = pParse->nTab++;
5508 }else{
5509 pItem->iDistinct = -1;
5510 }
drh13449892005-09-07 21:22:45 +00005511 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005512 }
drh13449892005-09-07 21:22:45 +00005513 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5514 */
drhc5cd1242013-09-12 16:50:49 +00005515 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005516 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005517 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005518 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005519 return WRC_Prune;
5520 }else{
5521 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005522 }
drh22827922000-06-06 17:27:05 +00005523 }
5524 }
drh7d10d5a2008-08-20 16:35:10 +00005525 return WRC_Continue;
5526}
5527static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
drhd5a336e2012-04-19 15:49:19 +00005528 UNUSED_PARAMETER(pSelect);
drh979dd1b2017-05-29 14:26:07 +00005529 pWalker->walkerDepth++;
drh374fdce2012-04-17 16:38:53 +00005530 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00005531}
drh979dd1b2017-05-29 14:26:07 +00005532static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5533 UNUSED_PARAMETER(pSelect);
5534 pWalker->walkerDepth--;
5535}
drh626a8792005-01-17 22:08:19 +00005536
5537/*
drhe8abb4c2012-11-02 18:24:57 +00005538** Analyze the pExpr expression looking for aggregate functions and
5539** for variables that need to be added to AggInfo object that pNC->pAggInfo
5540** points to. Additional entries are made on the AggInfo object as
5541** necessary.
drh626a8792005-01-17 22:08:19 +00005542**
5543** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005544** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005545*/
drhd2b3e232008-01-23 14:51:49 +00005546void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005547 Walker w;
5548 w.xExprCallback = analyzeAggregate;
5549 w.xSelectCallback = analyzeAggregatesInSelect;
drh979dd1b2017-05-29 14:26:07 +00005550 w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5551 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005552 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005553 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005554 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005555 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005556}
drh5d9a4af2005-08-30 00:54:01 +00005557
5558/*
5559** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5560** expression list. Return the number of errors.
5561**
5562** If an error is found, the analysis is cut short.
5563*/
drhd2b3e232008-01-23 14:51:49 +00005564void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005565 struct ExprList_item *pItem;
5566 int i;
drh5d9a4af2005-08-30 00:54:01 +00005567 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005568 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5569 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005570 }
5571 }
drh5d9a4af2005-08-30 00:54:01 +00005572}
drh892d3172008-01-10 03:46:36 +00005573
5574/*
drhceea3322009-04-23 13:22:42 +00005575** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005576*/
5577int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005578 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005579 return ++pParse->nMem;
5580 }
danielk19772f425f62008-07-04 09:41:39 +00005581 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00005582}
drhceea3322009-04-23 13:22:42 +00005583
5584/*
5585** Deallocate a register, making available for reuse for some other
5586** purpose.
drhceea3322009-04-23 13:22:42 +00005587*/
drh892d3172008-01-10 03:46:36 +00005588void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh2dcef112008-01-12 19:03:48 +00005589 if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
drh892d3172008-01-10 03:46:36 +00005590 pParse->aTempReg[pParse->nTempReg++] = iReg;
5591 }
5592}
5593
5594/*
drhed24da42016-09-06 14:37:05 +00005595** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00005596*/
5597int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00005598 int i, n;
drhed24da42016-09-06 14:37:05 +00005599 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00005600 i = pParse->iRangeReg;
5601 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00005602 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00005603 pParse->iRangeReg += nReg;
5604 pParse->nRangeReg -= nReg;
5605 }else{
5606 i = pParse->nMem+1;
5607 pParse->nMem += nReg;
5608 }
5609 return i;
5610}
5611void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00005612 if( nReg==1 ){
5613 sqlite3ReleaseTempReg(pParse, iReg);
5614 return;
5615 }
drh892d3172008-01-10 03:46:36 +00005616 if( nReg>pParse->nRangeReg ){
5617 pParse->nRangeReg = nReg;
5618 pParse->iRangeReg = iReg;
5619 }
5620}
drhcdc69552011-12-06 13:24:59 +00005621
5622/*
5623** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00005624**
5625** Always invoke this procedure after coding a subroutine or co-routine
5626** that might be invoked from other parts of the code, to ensure that
5627** the sub/co-routine does not use registers in common with the code that
5628** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00005629*/
5630void sqlite3ClearTempRegCache(Parse *pParse){
5631 pParse->nTempReg = 0;
5632 pParse->nRangeReg = 0;
5633}
drhbb9b5f22016-03-19 00:35:02 +00005634
5635/*
5636** Validate that no temporary register falls within the range of
5637** iFirst..iLast, inclusive. This routine is only call from within assert()
5638** statements.
5639*/
5640#ifdef SQLITE_DEBUG
5641int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5642 int i;
5643 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00005644 && pParse->iRangeReg+pParse->nRangeReg > iFirst
5645 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00005646 ){
5647 return 0;
5648 }
5649 for(i=0; i<pParse->nTempReg; i++){
5650 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5651 return 0;
5652 }
5653 }
5654 return 1;
5655}
5656#endif /* SQLITE_DEBUG */