blob: 79d57454c98489b950f013f6cb5d1315056b756a [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*/
drhe7375bf2020-03-10 19:24:38 +000045char sqlite3ExprAffinity(const Expr *pExpr){
drh580c8c12012-12-08 03:34:04 +000046 int op;
drha7d6db62019-06-11 21:02:15 +000047 while( ExprHasProperty(pExpr, EP_Skip) ){
dan07f9e8f2020-04-25 15:01:53 +000048 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drha7d6db62019-06-11 21:02:15 +000049 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 );
drh2f82acc2020-06-07 22:44:23 +000055 if( ALWAYS(pExpr->x.pSelect)
56 && pExpr->x.pSelect->pEList
57 && ALWAYS(pExpr->x.pSelect->pEList->a[0].pExpr)
58 ){
59 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
60 }
danielk1977a37cdde2004-05-16 11:15:36 +000061 }
drhdb45bd52016-08-22 00:48:58 +000062 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000063#ifndef SQLITE_OMIT_CAST
64 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000065 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000066 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000067 }
68#endif
drheda079c2018-09-20 19:02:15 +000069 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
70 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000071 }
dan80aa5452016-09-03 19:52:12 +000072 if( op==TK_SELECT_COLUMN ){
73 assert( pExpr->pLeft->flags&EP_xIsSelect );
74 return sqlite3ExprAffinity(
75 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
76 );
77 }
drhdb36e252019-10-22 19:51:29 +000078 if( op==TK_VECTOR ){
79 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
80 }
drh11949042019-08-05 18:01:42 +000081 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000082}
83
drh53db1452004-05-20 13:54:53 +000084/*
drh8b4c40d2007-02-01 23:02:45 +000085** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000086** sequence named by pToken. Return a pointer to a new Expr node that
87** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000088**
89** If a memory allocation error occurs, that fact is recorded in pParse->db
90** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000091*/
drh4ef7efa2014-03-20 15:14:08 +000092Expr *sqlite3ExprAddCollateToken(
93 Parse *pParse, /* Parsing context */
94 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000095 const Token *pCollName, /* Name of collating sequence */
96 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000097){
drh0a8a4062012-12-07 18:38:16 +000098 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000099 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000100 if( pNew ){
101 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000102 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000103 pExpr = pNew;
104 }
drhae80dde2012-12-06 21:16:43 +0000105 }
drh0a8a4062012-12-07 18:38:16 +0000106 return pExpr;
107}
108Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000109 Token s;
110 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000111 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000112 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000113}
114
115/*
drh0d950af2019-08-22 16:38:42 +0000116** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000117*/
118Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000119 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
dan07f9e8f2020-04-25 15:01:53 +0000120 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drh0d950af2019-08-22 16:38:42 +0000121 pExpr = pExpr->pLeft;
122 }
123 return pExpr;
124}
125
126/*
127** Skip over any TK_COLLATE operators and/or any unlikely()
128** or likelihood() or likely() functions at the root of an
129** expression.
130*/
131Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000132 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000133 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000134 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
135 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000136 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000137 pExpr = pExpr->x.pList->a[0].pExpr;
138 }else{
dan07f9e8f2020-04-25 15:01:53 +0000139 assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
drha4c3c872013-09-12 17:29:25 +0000140 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000141 }
drha4c3c872013-09-12 17:29:25 +0000142 }
drh0a8a4062012-12-07 18:38:16 +0000143 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000144}
145
146/*
drhae80dde2012-12-06 21:16:43 +0000147** Return the collation sequence for the expression pExpr. If
148** there is no defined collating sequence, return NULL.
149**
drh70efa842017-09-28 01:58:23 +0000150** See also: sqlite3ExprNNCollSeq()
151**
152** The sqlite3ExprNNCollSeq() works the same exact that it returns the
153** default collation if pExpr has no defined collation.
154**
drhae80dde2012-12-06 21:16:43 +0000155** The collating sequence might be determined by a COLLATE operator
156** or by the presence of a column with a defined collating sequence.
157** COLLATE operators take first precedence. Left operands take
158** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000159*/
drhe7375bf2020-03-10 19:24:38 +0000160CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000161 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000162 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000163 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000164 while( p ){
drhae80dde2012-12-06 21:16:43 +0000165 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000166 if( op==TK_REGISTER ) op = p->op2;
167 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000168 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000169 ){
drheda079c2018-09-20 19:02:15 +0000170 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000171 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000172 int j = p->iColumn;
173 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000174 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000175 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000176 }
177 break;
danielk19770202b292004-06-09 09:55:16 +0000178 }
drhe081d732018-07-27 18:19:12 +0000179 if( op==TK_CAST || op==TK_UPLUS ){
180 p = p->pLeft;
181 continue;
182 }
drh269d3222019-10-23 18:09:39 +0000183 if( op==TK_VECTOR ){
184 p = p->x.pList->a[0].pExpr;
185 continue;
186 }
drhcb0e04f2018-12-12 21:34:17 +0000187 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000188 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
189 break;
190 }
drhae80dde2012-12-06 21:16:43 +0000191 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000192 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000193 p = p->pLeft;
194 }else{
drh2308ed32015-02-09 16:09:34 +0000195 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000196 /* The Expr.x union is never used at the same time as Expr.pRight */
197 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000198 if( p->x.pList!=0
199 && !db->mallocFailed
200 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
201 ){
drh2308ed32015-02-09 16:09:34 +0000202 int i;
drh95768022019-11-10 10:08:03 +0000203 for(i=0; i<p->x.pList->nExpr; i++){
drh2308ed32015-02-09 16:09:34 +0000204 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
205 pNext = p->x.pList->a[i].pExpr;
206 break;
207 }
208 }
209 }
210 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000211 }
212 }else{
drh7d10d5a2008-08-20 16:35:10 +0000213 break;
214 }
danielk19770202b292004-06-09 09:55:16 +0000215 }
danielk19777cedc8d2004-06-10 10:50:08 +0000216 if( sqlite3CheckCollSeq(pParse, pColl) ){
217 pColl = 0;
218 }
219 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000220}
221
222/*
drh70efa842017-09-28 01:58:23 +0000223** Return the collation sequence for the expression pExpr. If
224** there is no defined collating sequence, return a pointer to the
225** defautl collation sequence.
226**
227** See also: sqlite3ExprCollSeq()
228**
229** The sqlite3ExprCollSeq() routine works the same except that it
230** returns NULL if there is no defined collation.
231*/
drhe7375bf2020-03-10 19:24:38 +0000232CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000233 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
234 if( p==0 ) p = pParse->db->pDfltColl;
235 assert( p!=0 );
236 return p;
237}
238
239/*
240** Return TRUE if the two expressions have equivalent collating sequences.
241*/
drhe7375bf2020-03-10 19:24:38 +0000242int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000243 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
244 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
245 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
246}
247
248/*
drh626a8792005-01-17 22:08:19 +0000249** pExpr is an operand of a comparison operator. aff2 is the
250** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000251** type affinity that should be used for the comparison operator.
252*/
drhe7375bf2020-03-10 19:24:38 +0000253char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000254 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000255 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000256 /* Both sides of the comparison are columns. If one has numeric
257 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000258 */
drh8a512562005-11-14 22:29:05 +0000259 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000260 return SQLITE_AFF_NUMERIC;
261 }else{
drh05883a32015-06-02 15:32:08 +0000262 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
danielk1977e014a832004-05-17 10:48:57 +0000264 }else{
265 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000266 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
267 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000268 }
269}
270
drh53db1452004-05-20 13:54:53 +0000271/*
272** pExpr is a comparison operator. Return the type affinity that should
273** be applied to both operands prior to doing the comparison.
274*/
drhe7375bf2020-03-10 19:24:38 +0000275static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000276 char aff;
277 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
278 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000279 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000280 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000281 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000282 if( pExpr->pRight ){
283 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000284 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
285 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000286 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000287 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000288 }
289 return aff;
290}
291
292/*
293** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
294** idx_affinity is the affinity of an indexed column. Return true
295** if the index with affinity idx_affinity may be used to implement
296** the comparison in pExpr.
297*/
drhe7375bf2020-03-10 19:24:38 +0000298int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000299 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000300 if( aff<SQLITE_AFF_TEXT ){
301 return 1;
drh8a512562005-11-14 22:29:05 +0000302 }
drh915e4342019-08-06 15:18:15 +0000303 if( aff==SQLITE_AFF_TEXT ){
304 return idx_affinity==SQLITE_AFF_TEXT;
305 }
306 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000307}
308
danielk1977a37cdde2004-05-16 11:15:36 +0000309/*
drh35573352008-01-08 23:54:25 +0000310** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000311** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000312*/
drhe7375bf2020-03-10 19:24:38 +0000313static u8 binaryCompareP5(
314 const Expr *pExpr1, /* Left operand */
315 const Expr *pExpr2, /* Right operand */
316 int jumpIfNull /* Extra flags added to P5 */
317){
drh35573352008-01-08 23:54:25 +0000318 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000319 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000320 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000321}
322
drha2e00042002-01-22 03:13:42 +0000323/*
danielk19770202b292004-06-09 09:55:16 +0000324** Return a pointer to the collation sequence that should be used by
325** a binary comparison operator comparing pLeft and pRight.
326**
327** If the left hand expression has a collating sequence type, then it is
328** used. Otherwise the collation sequence for the right hand expression
329** is used, or the default (BINARY) if neither expression has a collating
330** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000331**
332** Argument pRight (but not pLeft) may be a null pointer. In this case,
333** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000334*/
drh0a0e1312007-08-07 17:04:59 +0000335CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000336 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000337 const Expr *pLeft,
338 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000339){
drhec41dda2007-02-07 13:09:45 +0000340 CollSeq *pColl;
341 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000342 if( pLeft->flags & EP_Collate ){
343 pColl = sqlite3ExprCollSeq(pParse, pLeft);
344 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
345 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000346 }else{
347 pColl = sqlite3ExprCollSeq(pParse, pLeft);
348 if( !pColl ){
349 pColl = sqlite3ExprCollSeq(pParse, pRight);
350 }
danielk19770202b292004-06-09 09:55:16 +0000351 }
352 return pColl;
353}
354
drh898c5272019-10-22 00:03:41 +0000355/* Expresssion p is a comparison operator. Return a collation sequence
356** appropriate for the comparison operator.
357**
358** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
359** However, if the OP_Commuted flag is set, then the order of the operands
360** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
361** correct collating sequence is found.
362*/
drhe7375bf2020-03-10 19:24:38 +0000363CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000364 if( ExprHasProperty(p, EP_Commuted) ){
365 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
366 }else{
367 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
368 }
369}
370
danielk19770202b292004-06-09 09:55:16 +0000371/*
drhbe5c89a2004-07-26 00:31:09 +0000372** Generate code for a comparison operator.
373*/
374static int codeCompare(
375 Parse *pParse, /* The parsing (and code generating) context */
376 Expr *pLeft, /* The left operand */
377 Expr *pRight, /* The right operand */
378 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000379 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000380 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000381 int jumpIfNull, /* If true, jump if either operand is NULL */
382 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000383){
drh35573352008-01-08 23:54:25 +0000384 int p5;
385 int addr;
386 CollSeq *p4;
387
drh86541862019-12-19 20:37:32 +0000388 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000389 if( isCommuted ){
390 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
391 }else{
392 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
393 }
drh35573352008-01-08 23:54:25 +0000394 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
395 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
396 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000397 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000398 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000399}
400
dancfbb5e82016-07-13 19:48:13 +0000401/*
dan870a0702016-08-01 16:37:43 +0000402** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000403**
404** A vector is defined as any expression that results in two or more
405** columns of result. Every TK_VECTOR node is an vector because the
406** parser will not generate a TK_VECTOR with fewer than two entries.
407** But a TK_SELECT might be either a vector or a scalar. It is only
408** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000409*/
410int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000411 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000412}
413
414/*
dancfbb5e82016-07-13 19:48:13 +0000415** If the expression passed as the only argument is of type TK_VECTOR
416** return the number of expressions in the vector. Or, if the expression
417** is a sub-select, return the number of columns in the sub-select. For
418** any other type of expression, return 1.
419*/
dan71c57db2016-07-09 20:23:55 +0000420int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000421 u8 op = pExpr->op;
422 if( op==TK_REGISTER ) op = pExpr->op2;
423 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000424 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000425 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000426 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000427 }else{
428 return 1;
dan71c57db2016-07-09 20:23:55 +0000429 }
dan71c57db2016-07-09 20:23:55 +0000430}
431
danba00e302016-07-23 20:24:06 +0000432/*
drhfc7f27b2016-08-20 00:07:01 +0000433** Return a pointer to a subexpression of pVector that is the i-th
434** column of the vector (numbered starting with 0). The caller must
435** ensure that i is within range.
436**
drh76dbe7a2016-08-20 21:02:38 +0000437** If pVector is really a scalar (and "scalar" here includes subqueries
438** that return a single column!) then return pVector unmodified.
439**
drhfc7f27b2016-08-20 00:07:01 +0000440** pVector retains ownership of the returned subexpression.
441**
442** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000443** just the expression for the i-th term of the result set, and may
444** not be ready for evaluation because the table cursor has not yet
445** been positioned.
danba00e302016-07-23 20:24:06 +0000446*/
drhfc7f27b2016-08-20 00:07:01 +0000447Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000448 assert( i<sqlite3ExprVectorSize(pVector) );
449 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000450 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
451 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000452 return pVector->x.pSelect->pEList->a[i].pExpr;
453 }else{
454 return pVector->x.pList->a[i].pExpr;
455 }
dan71c57db2016-07-09 20:23:55 +0000456 }
dan870a0702016-08-01 16:37:43 +0000457 return pVector;
dan71c57db2016-07-09 20:23:55 +0000458}
drhfc7f27b2016-08-20 00:07:01 +0000459
drhfc7f27b2016-08-20 00:07:01 +0000460/*
461** Compute and return a new Expr object which when passed to
462** sqlite3ExprCode() will generate all necessary code to compute
463** the iField-th column of the vector expression pVector.
464**
drh8762ec12016-08-20 01:06:22 +0000465** It is ok for pVector to be a scalar (as long as iField==0).
466** In that case, this routine works like sqlite3ExprDup().
467**
drhfc7f27b2016-08-20 00:07:01 +0000468** The caller owns the returned Expr object and is responsible for
469** ensuring that the returned value eventually gets freed.
470**
drh8762ec12016-08-20 01:06:22 +0000471** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000472** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000473** valid for the life of the returned object. If pVector is a TK_VECTOR
474** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000475** returns.
drh8762ec12016-08-20 01:06:22 +0000476**
477** A trick to cause a TK_SELECT pVector to be deleted together with
478** the returned Expr object is to attach the pVector to the pRight field
479** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000480*/
481Expr *sqlite3ExprForVectorField(
482 Parse *pParse, /* Parsing context */
483 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000484 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000485){
486 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000487 if( pVector->op==TK_SELECT ){
488 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000489 /* The TK_SELECT_COLUMN Expr node:
490 **
drh966e2912017-01-03 02:58:01 +0000491 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000492 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000493 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000494 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000495 ** pLeft->iTable: First in an array of register holding result, or 0
496 ** if the result is not yet computed.
497 **
498 ** sqlite3ExprDelete() specifically skips the recursive delete of
499 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000500 ** can be attached to pRight to cause this node to take ownership of
501 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
502 ** with the same pLeft pointer to the pVector, but only one of them
503 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000504 */
drhabfd35e2016-12-06 22:47:23 +0000505 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000506 if( pRet ){
507 pRet->iColumn = iField;
508 pRet->pLeft = pVector;
509 }
drhfc7f27b2016-08-20 00:07:01 +0000510 assert( pRet==0 || pRet->iTable==0 );
511 }else{
drha1251bc2016-08-20 00:51:37 +0000512 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
513 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000514 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000515 }
516 return pRet;
517}
dan71c57db2016-07-09 20:23:55 +0000518
dan5c288b92016-07-30 21:02:33 +0000519/*
520** If expression pExpr is of type TK_SELECT, generate code to evaluate
521** it. Return the register in which the result is stored (or, if the
522** sub-select returns more than one column, the first in an array
523** of registers in which the result is stored).
524**
525** If pExpr is not a TK_SELECT expression, return 0.
526*/
527static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000528 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000529#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000530 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000531 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000532 }
danf9b2e052016-08-02 17:45:00 +0000533#endif
dan8da209b2016-07-26 18:06:08 +0000534 return reg;
535}
536
dan5c288b92016-07-30 21:02:33 +0000537/*
538** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000539** or TK_SELECT that returns more than one column. This function returns
540** the register number of a register that contains the value of
541** element iField of the vector.
542**
543** If pVector is a TK_SELECT expression, then code for it must have
544** already been generated using the exprCodeSubselect() routine. In this
545** case parameter regSelect should be the first in an array of registers
546** containing the results of the sub-select.
547**
548** If pVector is of type TK_VECTOR, then code for the requested field
549** is generated. In this case (*pRegFree) may be set to the number of
550** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000551**
552** Before returning, output parameter (*ppExpr) is set to point to the
553** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000554*/
555static int exprVectorRegister(
556 Parse *pParse, /* Parse context */
557 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000558 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000559 int regSelect, /* First in array of registers */
560 Expr **ppExpr, /* OUT: Expression element */
561 int *pRegFree /* OUT: Temp register to free */
562){
drh12abf402016-08-22 14:30:05 +0000563 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000564 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000565 if( op==TK_REGISTER ){
566 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
567 return pVector->iTable+iField;
568 }
569 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000570 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
571 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000572 }
dan870a0702016-08-01 16:37:43 +0000573 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000574 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
575}
576
577/*
578** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000579** the result of the comparison (1, 0, or NULL) and write that
580** result into register dest.
581**
582** The caller must satisfy the following preconditions:
583**
584** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
585** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
586** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000587*/
drh79752b62016-08-13 10:02:17 +0000588static void codeVectorCompare(
589 Parse *pParse, /* Code generator context */
590 Expr *pExpr, /* The comparison operation */
591 int dest, /* Write results into this register */
592 u8 op, /* Comparison operator */
593 u8 p5 /* SQLITE_NULLEQ or zero */
594){
dan71c57db2016-07-09 20:23:55 +0000595 Vdbe *v = pParse->pVdbe;
596 Expr *pLeft = pExpr->pLeft;
597 Expr *pRight = pExpr->pRight;
598 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000599 int i;
600 int regLeft = 0;
601 int regRight = 0;
602 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000603 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000604 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000605
drhe7375bf2020-03-10 19:24:38 +0000606 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh70d6b832019-12-30 23:50:19 +0000607 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000608 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
609 sqlite3ErrorMsg(pParse, "row value misused");
610 return;
611 }
drhb29e60c2016-09-05 12:02:34 +0000612 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
613 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
614 || pExpr->op==TK_LT || pExpr->op==TK_GT
615 || pExpr->op==TK_LE || pExpr->op==TK_GE
616 );
617 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
618 || (pExpr->op==TK_ISNOT && op==TK_NE) );
619 assert( p5==0 || pExpr->op!=op );
620 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000621
drhb29e60c2016-09-05 12:02:34 +0000622 p5 |= SQLITE_STOREP2;
623 if( opx==TK_LE ) opx = TK_LT;
624 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000625
drhb29e60c2016-09-05 12:02:34 +0000626 regLeft = exprCodeSubselect(pParse, pLeft);
627 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000628
drhb29e60c2016-09-05 12:02:34 +0000629 for(i=0; 1 /*Loop exits by "break"*/; i++){
630 int regFree1 = 0, regFree2 = 0;
631 Expr *pL, *pR;
632 int r1, r2;
633 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000634 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
635 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000636 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000637 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
638 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
639 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
640 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
641 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
642 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
643 sqlite3ReleaseTempReg(pParse, regFree1);
644 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000645 if( i==nLeft-1 ){
646 break;
dan71c57db2016-07-09 20:23:55 +0000647 }
drhb29e60c2016-09-05 12:02:34 +0000648 if( opx==TK_EQ ){
649 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
650 p5 |= SQLITE_KEEPNULL;
651 }else if( opx==TK_NE ){
652 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
653 p5 |= SQLITE_KEEPNULL;
654 }else{
655 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
656 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
657 VdbeCoverageIf(v, op==TK_LT);
658 VdbeCoverageIf(v, op==TK_GT);
659 VdbeCoverageIf(v, op==TK_LE);
660 VdbeCoverageIf(v, op==TK_GE);
661 if( i==nLeft-2 ) opx = op;
662 }
dan71c57db2016-07-09 20:23:55 +0000663 }
drhb29e60c2016-09-05 12:02:34 +0000664 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000665}
666
danielk19774b5255a2008-06-05 16:47:39 +0000667#if SQLITE_MAX_EXPR_DEPTH>0
668/*
669** Check that argument nHeight is less than or equal to the maximum
670** expression depth allowed. If it is not, leave an error message in
671** pParse.
672*/
drh7d10d5a2008-08-20 16:35:10 +0000673int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000674 int rc = SQLITE_OK;
675 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
676 if( nHeight>mxHeight ){
677 sqlite3ErrorMsg(pParse,
678 "Expression tree is too large (maximum depth %d)", mxHeight
679 );
680 rc = SQLITE_ERROR;
681 }
682 return rc;
683}
684
685/* The following three functions, heightOfExpr(), heightOfExprList()
686** and heightOfSelect(), are used to determine the maximum height
687** of any expression tree referenced by the structure passed as the
688** first argument.
689**
690** If this maximum height is greater than the current value pointed
691** to by pnHeight, the second parameter, then set *pnHeight to that
692** value.
693*/
694static void heightOfExpr(Expr *p, int *pnHeight){
695 if( p ){
696 if( p->nHeight>*pnHeight ){
697 *pnHeight = p->nHeight;
698 }
699 }
700}
701static void heightOfExprList(ExprList *p, int *pnHeight){
702 if( p ){
703 int i;
704 for(i=0; i<p->nExpr; i++){
705 heightOfExpr(p->a[i].pExpr, pnHeight);
706 }
707 }
708}
dan1a3a3082018-01-18 19:00:54 +0000709static void heightOfSelect(Select *pSelect, int *pnHeight){
710 Select *p;
711 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000712 heightOfExpr(p->pWhere, pnHeight);
713 heightOfExpr(p->pHaving, pnHeight);
714 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000715 heightOfExprList(p->pEList, pnHeight);
716 heightOfExprList(p->pGroupBy, pnHeight);
717 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000718 }
719}
720
721/*
722** Set the Expr.nHeight variable in the structure passed as an
723** argument. An expression with no children, Expr.pList or
724** Expr.pSelect member has a height of 1. Any other expression
725** has a height equal to the maximum height of any other
726** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000727**
728** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
729** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000730*/
731static void exprSetHeight(Expr *p){
732 int nHeight = 0;
733 heightOfExpr(p->pLeft, &nHeight);
734 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000735 if( ExprHasProperty(p, EP_xIsSelect) ){
736 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000737 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000738 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000739 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000740 }
danielk19774b5255a2008-06-05 16:47:39 +0000741 p->nHeight = nHeight + 1;
742}
743
744/*
745** Set the Expr.nHeight variable using the exprSetHeight() function. If
746** the height is greater than the maximum allowed expression depth,
747** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000748**
749** Also propagate all EP_Propagate flags from the Expr.x.pList into
750** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000751*/
drh2308ed32015-02-09 16:09:34 +0000752void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000753 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000754 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000755 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000756}
757
758/*
759** Return the maximum height of any expression tree referenced
760** by the select statement passed as an argument.
761*/
762int sqlite3SelectExprHeight(Select *p){
763 int nHeight = 0;
764 heightOfSelect(p, &nHeight);
765 return nHeight;
766}
drh2308ed32015-02-09 16:09:34 +0000767#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
768/*
769** Propagate all EP_Propagate flags from the Expr.x.pList into
770** Expr.flags.
771*/
772void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
773 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
774 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
775 }
776}
777#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000778#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
779
drhbe5c89a2004-07-26 00:31:09 +0000780/*
drhb7916a72009-05-27 10:31:29 +0000781** This routine is the core allocator for Expr nodes.
782**
drha76b5df2002-02-23 02:32:10 +0000783** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000784** for this node and for the pToken argument is a single allocation
785** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000786** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000787**
788** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000789** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000790** parameter is ignored if pToken is NULL or if the token does not
791** appear to be quoted. If the quotes were of the form "..." (double-quotes)
792** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000793**
794** Special case: If op==TK_INTEGER and pToken points to a string that
795** can be translated into a 32-bit integer, then the token is not
796** stored in u.zToken. Instead, the integer values is written
797** into u.iValue and the EP_IntValue flag is set. No extra storage
798** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000799*/
drhb7916a72009-05-27 10:31:29 +0000800Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000801 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000802 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000803 const Token *pToken, /* Token argument. Might be NULL */
804 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000805){
drha76b5df2002-02-23 02:32:10 +0000806 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000807 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000808 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000809
drh575fad62016-02-05 13:38:36 +0000810 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000811 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000812 if( op!=TK_INTEGER || pToken->z==0
813 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
814 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000815 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000816 }
drhb7916a72009-05-27 10:31:29 +0000817 }
drh575fad62016-02-05 13:38:36 +0000818 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000819 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000820 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000821 pNew->op = (u8)op;
822 pNew->iAgg = -1;
823 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000824 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000825 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000826 pNew->u.iValue = iValue;
827 }else{
drh33e619f2009-05-28 01:00:55 +0000828 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000829 assert( pToken->z!=0 || pToken->n==0 );
830 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000831 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000832 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000833 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000834 }
drhb7916a72009-05-27 10:31:29 +0000835 }
836 }
837#if SQLITE_MAX_EXPR_DEPTH>0
838 pNew->nHeight = 1;
839#endif
840 }
drha76b5df2002-02-23 02:32:10 +0000841 return pNew;
842}
843
844/*
drhb7916a72009-05-27 10:31:29 +0000845** Allocate a new expression node from a zero-terminated token that has
846** already been dequoted.
847*/
848Expr *sqlite3Expr(
849 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
850 int op, /* Expression opcode */
851 const char *zToken /* Token argument. Might be NULL */
852){
853 Token x;
854 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000855 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000856 return sqlite3ExprAlloc(db, op, &x, 0);
857}
858
859/*
860** Attach subtrees pLeft and pRight to the Expr node pRoot.
861**
862** If pRoot==NULL that means that a memory allocation error has occurred.
863** In that case, delete the subtrees pLeft and pRight.
864*/
865void sqlite3ExprAttachSubtrees(
866 sqlite3 *db,
867 Expr *pRoot,
868 Expr *pLeft,
869 Expr *pRight
870){
871 if( pRoot==0 ){
872 assert( db->mallocFailed );
873 sqlite3ExprDelete(db, pLeft);
874 sqlite3ExprDelete(db, pRight);
875 }else{
876 if( pRight ){
877 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000878 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000879 }
880 if( pLeft ){
881 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000882 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000883 }
884 exprSetHeight(pRoot);
885 }
886}
887
888/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000889** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000890**
drhbf664462009-06-19 18:32:54 +0000891** One or both of the subtrees can be NULL. Return a pointer to the new
892** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
893** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000894*/
drh17435752007-08-16 04:30:38 +0000895Expr *sqlite3PExpr(
896 Parse *pParse, /* Parsing context */
897 int op, /* Expression opcode */
898 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000899 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000900){
drh5fb52ca2012-03-31 02:34:35 +0000901 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000902 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
903 if( p ){
904 memset(p, 0, sizeof(Expr));
905 p->op = op & 0xff;
906 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000907 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000908 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000909 }else{
910 sqlite3ExprDelete(pParse->db, pLeft);
911 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000912 }
drh4e0cff62004-11-05 05:10:28 +0000913 return p;
914}
915
916/*
drh08de4f72016-04-11 01:06:47 +0000917** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
918** do a memory allocation failure) then delete the pSelect object.
919*/
920void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
921 if( pExpr ){
922 pExpr->x.pSelect = pSelect;
923 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
924 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
925 }else{
926 assert( pParse->db->mallocFailed );
927 sqlite3SelectDelete(pParse->db, pSelect);
928 }
929}
930
931
932/*
drh91bb0ee2004-09-01 03:06:34 +0000933** Join two expressions using an AND operator. If either expression is
934** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000935**
936** If one side or the other of the AND is known to be false, then instead
937** of returning an AND expression, just return a constant expression with
938** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000939*/
drhd5c851c2019-04-19 13:38:34 +0000940Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
941 sqlite3 *db = pParse->db;
942 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000943 return pRight;
944 }else if( pRight==0 ){
945 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000946 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
947 && !IN_RENAME_OBJECT
948 ){
949 sqlite3ExprDelete(db, pLeft);
950 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000951 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000952 }else{
drhd5c851c2019-04-19 13:38:34 +0000953 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000954 }
955}
956
957/*
958** Construct a new expression node for a function with multiple
959** arguments.
960*/
drh954733b2018-07-27 23:33:16 +0000961Expr *sqlite3ExprFunction(
962 Parse *pParse, /* Parsing context */
963 ExprList *pList, /* Argument list */
964 Token *pToken, /* Name of the function */
965 int eDistinct /* SF_Distinct or SF_ALL or 0 */
966){
drha76b5df2002-02-23 02:32:10 +0000967 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000968 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000969 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000970 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000971 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000972 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000973 return 0;
974 }
drh954733b2018-07-27 23:33:16 +0000975 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
976 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
977 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000978 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000979 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000980 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000981 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000982 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000983 return pNew;
984}
985
986/*
drh0dfa5252020-01-08 17:28:19 +0000987** Check to see if a function is usable according to current access
988** rules:
989**
990** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
991**
992** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
993** top-level SQL
994**
995** If the function is not usable, create an error.
996*/
997void sqlite3ExprFunctionUsable(
998 Parse *pParse, /* Parsing and code generating context */
999 Expr *pExpr, /* The function invocation */
1000 FuncDef *pDef /* The function being invoked */
1001){
1002 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001003 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1004 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001005 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1006 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1007 ){
1008 /* Functions prohibited in triggers and views if:
1009 ** (1) tagged with SQLITE_DIRECTONLY
1010 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1011 ** is tagged with SQLITE_FUNC_UNSAFE) and
1012 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1013 ** that the schema is possibly tainted).
1014 */
1015 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1016 }
1017 }
1018}
1019
1020/*
drhfa6bc002004-09-07 16:19:52 +00001021** Assign a variable number to an expression that encodes a wildcard
1022** in the original SQL statement.
1023**
1024** Wildcards consisting of a single "?" are assigned the next sequential
1025** variable number.
1026**
1027** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001028** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001029** the SQL statement comes from an external source.
1030**
drh51f49f12009-05-21 20:41:32 +00001031** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001032** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001033** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001034** assigned.
1035*/
drhde25a882016-10-03 15:28:24 +00001036void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001037 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001038 const char *z;
drhf326d662016-12-23 13:30:53 +00001039 ynVar x;
drh17435752007-08-16 04:30:38 +00001040
drhfa6bc002004-09-07 16:19:52 +00001041 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001042 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001043 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001044 assert( z!=0 );
1045 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001046 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001047 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001048 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001049 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001050 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001051 }else{
drhf326d662016-12-23 13:30:53 +00001052 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001053 if( z[0]=='?' ){
1054 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1055 ** use it as the variable number */
1056 i64 i;
drh18814df2017-01-31 03:52:34 +00001057 int bOk;
1058 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1059 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1060 bOk = 1;
1061 }else{
1062 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1063 }
drh124c0b42011-06-01 18:15:55 +00001064 testcase( i==0 );
1065 testcase( i==1 );
1066 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1067 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1068 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1069 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1070 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001071 return;
drhfa6bc002004-09-07 16:19:52 +00001072 }
drh8e74e7b2017-01-31 12:41:48 +00001073 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001074 if( x>pParse->nVar ){
1075 pParse->nVar = (int)x;
1076 doAdd = 1;
1077 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1078 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001079 }
1080 }else{
1081 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1082 ** number as the prior appearance of the same name, or if the name
1083 ** has never appeared before, reuse the same variable number
1084 */
drh9bf755c2016-12-23 03:59:31 +00001085 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1086 if( x==0 ){
1087 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001088 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001089 }
drhfa6bc002004-09-07 16:19:52 +00001090 }
drhf326d662016-12-23 13:30:53 +00001091 if( doAdd ){
1092 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1093 }
1094 }
1095 pExpr->iColumn = x;
1096 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001097 sqlite3ErrorMsg(pParse, "too many SQL variables");
1098 }
drhfa6bc002004-09-07 16:19:52 +00001099}
1100
1101/*
danf6963f92009-11-23 14:39:14 +00001102** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001103*/
drh4f0010b2016-04-11 14:49:39 +00001104static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1105 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001106 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1107 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001108
1109 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1110 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001111 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001112#ifdef SQLITE_DEBUG
1113 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1114 assert( p->pLeft==0 );
1115 assert( p->pRight==0 );
1116 assert( p->x.pSelect==0 );
1117 }
1118#endif
1119 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001120 /* The Expr.x union is never used at the same time as Expr.pRight */
1121 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001122 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001123 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001124 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001125 sqlite3ExprDeleteNN(db, p->pRight);
1126 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001127 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001128 sqlite3SelectDelete(db, p->x.pSelect);
1129 }else{
1130 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001131#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001132 if( ExprHasProperty(p, EP_WinFunc) ){
1133 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001134 }
dan6ba7ab02019-07-02 11:56:47 +00001135#endif
dan8117f112019-07-10 20:16:53 +00001136 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001137 }
drh209bc522016-09-23 21:36:24 +00001138 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001139 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001140 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001141 }
drha2e00042002-01-22 03:13:42 +00001142}
drh4f0010b2016-04-11 14:49:39 +00001143void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1144 if( p ) sqlite3ExprDeleteNN(db, p);
1145}
drha2e00042002-01-22 03:13:42 +00001146
drh8e34e402019-06-11 10:43:56 +00001147/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1148** expression.
1149*/
1150void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1151 if( p ){
1152 if( IN_RENAME_OBJECT ){
1153 sqlite3RenameExprUnmap(pParse, p);
1154 }
1155 sqlite3ExprDeleteNN(pParse->db, p);
1156 }
1157}
1158
drhd2687b72005-08-12 22:56:09 +00001159/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001160** Return the number of bytes allocated for the expression structure
1161** passed as the first argument. This is always one of EXPR_FULLSIZE,
1162** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1163*/
1164static int exprStructSize(Expr *p){
1165 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001166 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1167 return EXPR_FULLSIZE;
1168}
1169
1170/*
drh33e619f2009-05-28 01:00:55 +00001171** The dupedExpr*Size() routines each return the number of bytes required
1172** to store a copy of an expression or expression tree. They differ in
1173** how much of the tree is measured.
1174**
1175** dupedExprStructSize() Size of only the Expr structure
1176** dupedExprNodeSize() Size of Expr + space for token
1177** dupedExprSize() Expr + token + subtree components
1178**
1179***************************************************************************
1180**
1181** The dupedExprStructSize() function returns two values OR-ed together:
1182** (1) the space required for a copy of the Expr structure only and
1183** (2) the EP_xxx flags that indicate what the structure size should be.
1184** The return values is always one of:
1185**
1186** EXPR_FULLSIZE
1187** EXPR_REDUCEDSIZE | EP_Reduced
1188** EXPR_TOKENONLYSIZE | EP_TokenOnly
1189**
1190** The size of the structure can be found by masking the return value
1191** of this routine with 0xfff. The flags can be found by masking the
1192** return value with EP_Reduced|EP_TokenOnly.
1193**
1194** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1195** (unreduced) Expr objects as they or originally constructed by the parser.
1196** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001197** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001198** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001199** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001200** to reduce a pristine expression tree from the parser. The implementation
1201** of dupedExprStructSize() contain multiple assert() statements that attempt
1202** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001203*/
1204static int dupedExprStructSize(Expr *p, int flags){
1205 int nSize;
drh33e619f2009-05-28 01:00:55 +00001206 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001207 assert( EXPR_FULLSIZE<=0xfff );
1208 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001209 if( 0==flags || p->op==TK_SELECT_COLUMN
1210#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001211 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001212#endif
1213 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001214 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001215 }else{
drhc5cd1242013-09-12 16:50:49 +00001216 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001217 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001218 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001219 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001220 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001221 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1222 }else{
drhaecd8022013-09-13 18:15:15 +00001223 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001224 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1225 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001226 }
1227 return nSize;
1228}
1229
1230/*
drh33e619f2009-05-28 01:00:55 +00001231** This function returns the space in bytes required to store the copy
1232** of the Expr structure and a copy of the Expr.u.zToken string (if that
1233** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001234*/
1235static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001236 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1237 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001238 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001239 }
danielk1977bc739712009-03-23 04:33:32 +00001240 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001241}
1242
1243/*
1244** Return the number of bytes required to create a duplicate of the
1245** expression passed as the first argument. The second argument is a
1246** mask containing EXPRDUP_XXX flags.
1247**
1248** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001249** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001250**
1251** If the EXPRDUP_REDUCE flag is set, then the return value includes
1252** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1253** and Expr.pRight variables (but not for any structures pointed to or
1254** descended from the Expr.x.pList or Expr.x.pSelect variables).
1255*/
1256static int dupedExprSize(Expr *p, int flags){
1257 int nByte = 0;
1258 if( p ){
1259 nByte = dupedExprNodeSize(p, flags);
1260 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001261 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001262 }
1263 }
1264 return nByte;
1265}
1266
1267/*
1268** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1269** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001270** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001271** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001272** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001273** portion of the buffer copied into by this function.
1274*/
drh3c194692016-04-11 16:43:43 +00001275static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1276 Expr *pNew; /* Value to return */
1277 u8 *zAlloc; /* Memory space from which to build Expr object */
1278 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1279
drh575fad62016-02-05 13:38:36 +00001280 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001281 assert( p );
1282 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1283 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001284
drh3c194692016-04-11 16:43:43 +00001285 /* Figure out where to write the new Expr structure. */
1286 if( pzBuffer ){
1287 zAlloc = *pzBuffer;
1288 staticFlag = EP_Static;
1289 }else{
1290 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1291 staticFlag = 0;
1292 }
1293 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001294
drh3c194692016-04-11 16:43:43 +00001295 if( pNew ){
1296 /* Set nNewSize to the size allocated for the structure pointed to
1297 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1298 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1299 ** by the copy of the p->u.zToken string (if any).
1300 */
1301 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1302 const int nNewSize = nStructSize & 0xfff;
1303 int nToken;
1304 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1305 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001306 }else{
drh3c194692016-04-11 16:43:43 +00001307 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001308 }
drh3c194692016-04-11 16:43:43 +00001309 if( dupFlags ){
1310 assert( ExprHasProperty(p, EP_Reduced)==0 );
1311 memcpy(zAlloc, p, nNewSize);
1312 }else{
1313 u32 nSize = (u32)exprStructSize(p);
1314 memcpy(zAlloc, p, nSize);
1315 if( nSize<EXPR_FULLSIZE ){
1316 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1317 }
1318 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001319
drh3c194692016-04-11 16:43:43 +00001320 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1321 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1322 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1323 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001324 ExprClearVVAProperties(pNew);
1325 if( dupFlags ){
1326 ExprSetVVAProperty(pNew, EP_Immutable);
1327 }
drh3c194692016-04-11 16:43:43 +00001328
1329 /* Copy the p->u.zToken string, if any. */
1330 if( nToken ){
1331 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1332 memcpy(zToken, p->u.zToken, nToken);
1333 }
1334
drh209bc522016-09-23 21:36:24 +00001335 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001336 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1337 if( ExprHasProperty(p, EP_xIsSelect) ){
1338 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001339 }else{
drh3c194692016-04-11 16:43:43 +00001340 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001341 }
drh3c194692016-04-11 16:43:43 +00001342 }
1343
1344 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001345 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001346 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001347 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001348 pNew->pLeft = p->pLeft ?
1349 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1350 pNew->pRight = p->pRight ?
1351 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001352 }
dan67a9b8e2018-06-22 20:51:35 +00001353#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001354 if( ExprHasProperty(p, EP_WinFunc) ){
1355 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1356 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001357 }
dan67a9b8e2018-06-22 20:51:35 +00001358#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001359 if( pzBuffer ){
1360 *pzBuffer = zAlloc;
1361 }
1362 }else{
drh209bc522016-09-23 21:36:24 +00001363 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001364 if( pNew->op==TK_SELECT_COLUMN ){
1365 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001366 assert( p->iColumn==0 || p->pRight==0 );
1367 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001368 }else{
1369 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1370 }
drh3c194692016-04-11 16:43:43 +00001371 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001372 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001373 }
1374 }
1375 return pNew;
1376}
1377
1378/*
danbfe31e72014-01-15 14:17:31 +00001379** Create and return a deep copy of the object passed as the second
1380** argument. If an OOM condition is encountered, NULL is returned
1381** and the db->mallocFailed flag set.
1382*/
daneede6a52014-01-15 19:42:23 +00001383#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001384static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001385 With *pRet = 0;
1386 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001387 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001388 pRet = sqlite3DbMallocZero(db, nByte);
1389 if( pRet ){
1390 int i;
1391 pRet->nCte = p->nCte;
1392 for(i=0; i<p->nCte; i++){
1393 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1394 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1395 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1396 }
1397 }
1398 }
1399 return pRet;
1400}
daneede6a52014-01-15 19:42:23 +00001401#else
1402# define withDup(x,y) 0
1403#endif
dan4e9119d2014-01-13 15:12:23 +00001404
drha8389972018-12-06 22:04:19 +00001405#ifndef SQLITE_OMIT_WINDOWFUNC
1406/*
1407** The gatherSelectWindows() procedure and its helper routine
1408** gatherSelectWindowsCallback() are used to scan all the expressions
1409** an a newly duplicated SELECT statement and gather all of the Window
1410** objects found there, assembling them onto the linked list at Select->pWin.
1411*/
1412static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001413 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001414 Select *pSelect = pWalker->u.pSelect;
1415 Window *pWin = pExpr->y.pWin;
1416 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001417 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001418 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001419 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001420 }
1421 return WRC_Continue;
1422}
drha37b6a52018-12-06 22:12:18 +00001423static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1424 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1425}
drha8389972018-12-06 22:04:19 +00001426static void gatherSelectWindows(Select *p){
1427 Walker w;
1428 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001429 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1430 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001431 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001432 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001433 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001434}
1435#endif
1436
1437
drha76b5df2002-02-23 02:32:10 +00001438/*
drhff78bd22002-02-27 01:47:11 +00001439** The following group of routines make deep copies of expressions,
1440** expression lists, ID lists, and select statements. The copies can
1441** be deleted (by being passed to their respective ...Delete() routines)
1442** without effecting the originals.
1443**
danielk19774adee202004-05-08 08:23:19 +00001444** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1445** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001446** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001447**
drhad3cab52002-05-24 02:04:32 +00001448** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001449**
drhb7916a72009-05-27 10:31:29 +00001450** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001451** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1452** truncated version of the usual Expr structure that will be stored as
1453** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001454*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001455Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001456 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001457 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001458}
danielk19776ab3a2e2009-02-19 14:39:25 +00001459ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001460 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001461 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001462 int i;
drhb1637482017-01-03 00:27:16 +00001463 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001464 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001465 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001466 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001467 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001468 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001469 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001470 pOldItem = p->a;
1471 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001472 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001473 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001474 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001475 if( pOldExpr
1476 && pOldExpr->op==TK_SELECT_COLUMN
1477 && (pNewExpr = pItem->pExpr)!=0
1478 ){
1479 assert( pNewExpr->iColumn==0 || i>0 );
1480 if( pNewExpr->iColumn==0 ){
1481 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001482 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1483 }else{
1484 assert( i>0 );
1485 assert( pItem[-1].pExpr!=0 );
1486 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1487 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1488 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001489 }
1490 }
drh41cee662019-12-12 20:22:34 +00001491 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001492 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001493 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001494 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001495 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001496 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001497 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001498 }
1499 return pNew;
1500}
danielk197793758c82005-01-21 08:13:14 +00001501
1502/*
1503** If cursors, triggers, views and subqueries are all omitted from
1504** the build, then none of the following routines, except for
1505** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1506** called with a NULL argument.
1507*/
danielk19776a67fe82005-02-04 04:07:16 +00001508#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1509 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001510SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001511 SrcList *pNew;
1512 int i;
drh113088e2003-03-20 01:16:58 +00001513 int nByte;
drh575fad62016-02-05 13:38:36 +00001514 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001515 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001516 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001517 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001518 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001519 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001520 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001521 struct SrcList_item *pNewItem = &pNew->a[i];
1522 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001523 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001524 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001525 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1526 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1527 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001528 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001529 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001530 pNewItem->addrFillSub = pOldItem->addrFillSub;
1531 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001532 if( pNewItem->fg.isIndexedBy ){
1533 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1534 }
1535 pNewItem->pIBIndex = pOldItem->pIBIndex;
1536 if( pNewItem->fg.isTabFunc ){
1537 pNewItem->u1.pFuncArg =
1538 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1539 }
drhed8a3bb2005-06-06 21:19:56 +00001540 pTab = pNewItem->pTab = pOldItem->pTab;
1541 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001542 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001543 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001544 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1545 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001546 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001547 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001548 }
1549 return pNew;
1550}
drh17435752007-08-16 04:30:38 +00001551IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001552 IdList *pNew;
1553 int i;
drh575fad62016-02-05 13:38:36 +00001554 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001555 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001556 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001557 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001558 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001559 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001560 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001561 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001562 return 0;
1563 }
drh6c535152012-02-02 03:38:30 +00001564 /* Note that because the size of the allocation for p->a[] is not
1565 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1566 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001567 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001568 struct IdList_item *pNewItem = &pNew->a[i];
1569 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001570 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001571 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001572 }
1573 return pNew;
1574}
dana7466202017-02-03 14:44:52 +00001575Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1576 Select *pRet = 0;
1577 Select *pNext = 0;
1578 Select **pp = &pRet;
1579 Select *p;
1580
drh575fad62016-02-05 13:38:36 +00001581 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001582 for(p=pDup; p; p=p->pPrior){
1583 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1584 if( pNew==0 ) break;
1585 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1586 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1587 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1588 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1589 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1590 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1591 pNew->op = p->op;
1592 pNew->pNext = pNext;
1593 pNew->pPrior = 0;
1594 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001595 pNew->iLimit = 0;
1596 pNew->iOffset = 0;
1597 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1598 pNew->addrOpenEphm[0] = -1;
1599 pNew->addrOpenEphm[1] = -1;
1600 pNew->nSelectRow = p->nSelectRow;
1601 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001602#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001603 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001604 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001605 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001606#endif
drhfef37762018-07-10 19:48:35 +00001607 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001608 *pp = pNew;
1609 pp = &pNew->pPrior;
1610 pNext = pNew;
1611 }
1612
1613 return pRet;
drhff78bd22002-02-27 01:47:11 +00001614}
danielk197793758c82005-01-21 08:13:14 +00001615#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001616Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001617 assert( p==0 );
1618 return 0;
1619}
1620#endif
drhff78bd22002-02-27 01:47:11 +00001621
1622
1623/*
drha76b5df2002-02-23 02:32:10 +00001624** Add a new element to the end of an expression list. If pList is
1625** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001626**
drha19543f2017-09-15 15:17:48 +00001627** The pList argument must be either NULL or a pointer to an ExprList
1628** obtained from a prior call to sqlite3ExprListAppend(). This routine
1629** may not be used with an ExprList obtained from sqlite3ExprListDup().
1630** Reason: This routine assumes that the number of slots in pList->a[]
1631** is a power of two. That is true for sqlite3ExprListAppend() returns
1632** but is not necessarily true from the return value of sqlite3ExprListDup().
1633**
drhb7916a72009-05-27 10:31:29 +00001634** If a memory allocation error occurs, the entire list is freed and
1635** NULL is returned. If non-NULL is returned, then it is guaranteed
1636** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001637*/
drh17435752007-08-16 04:30:38 +00001638ExprList *sqlite3ExprListAppend(
1639 Parse *pParse, /* Parsing context */
1640 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001641 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001642){
drh43606172017-04-05 11:32:13 +00001643 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001644 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001645 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001646 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001647 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001648 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001649 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001650 }
drhc263f7c2016-01-18 13:18:54 +00001651 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001652 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001653 ExprList *pNew;
1654 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001655 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001656 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001657 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001658 }
drh43606172017-04-05 11:32:13 +00001659 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001660 }
drh43606172017-04-05 11:32:13 +00001661 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001662 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001663 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001664 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001665 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001666 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001667
1668no_mem:
1669 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001670 sqlite3ExprDelete(db, pExpr);
1671 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001672 return 0;
drha76b5df2002-02-23 02:32:10 +00001673}
1674
1675/*
drh8762ec12016-08-20 01:06:22 +00001676** pColumns and pExpr form a vector assignment which is part of the SET
1677** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001678**
1679** (a,b,c) = (expr1,expr2,expr3)
1680** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1681**
1682** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001683** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001684** TK_SELECT_COLUMN expressions.
1685*/
1686ExprList *sqlite3ExprListAppendVector(
1687 Parse *pParse, /* Parsing context */
1688 ExprList *pList, /* List to which to append. Might be NULL */
1689 IdList *pColumns, /* List of names of LHS of the assignment */
1690 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1691){
1692 sqlite3 *db = pParse->db;
1693 int n;
1694 int i;
drh66860af2016-08-23 18:30:10 +00001695 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001696 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1697 ** exit prior to this routine being invoked */
1698 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001699 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001700
1701 /* If the RHS is a vector, then we can immediately check to see that
1702 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1703 ** wildcards ("*") in the result set of the SELECT must be expanded before
1704 ** we can do the size check, so defer the size check until code generation.
1705 */
1706 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001707 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1708 pColumns->nId, n);
1709 goto vector_append_error;
1710 }
drh966e2912017-01-03 02:58:01 +00001711
1712 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001713 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001714 assert( pSubExpr!=0 || db->mallocFailed );
1715 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1716 if( pSubExpr==0 ) continue;
1717 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001718 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1719 if( pList ){
drh66860af2016-08-23 18:30:10 +00001720 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001721 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001722 pColumns->a[i].zName = 0;
1723 }
1724 }
drh966e2912017-01-03 02:58:01 +00001725
drhffe28052017-05-06 18:09:36 +00001726 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001727 Expr *pFirst = pList->a[iFirst].pExpr;
1728 assert( pFirst!=0 );
1729 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001730
drhf4dd26c2017-04-05 11:49:06 +00001731 /* Store the SELECT statement in pRight so it will be deleted when
1732 ** sqlite3ExprListDelete() is called */
1733 pFirst->pRight = pExpr;
1734 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001735
drhf4dd26c2017-04-05 11:49:06 +00001736 /* Remember the size of the LHS in iTable so that we can check that
1737 ** the RHS and LHS sizes match during code generation. */
1738 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001739 }
1740
1741vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001742 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001743 sqlite3IdListDelete(db, pColumns);
1744 return pList;
1745}
1746
1747/*
drhbc622bc2015-08-24 15:39:42 +00001748** Set the sort order for the last element on the given ExprList.
1749*/
dan6e118922019-08-12 16:36:38 +00001750void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001751 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001752 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001753 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001754
1755 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1756 assert( iSortOrder==SQLITE_SO_UNDEFINED
1757 || iSortOrder==SQLITE_SO_ASC
1758 || iSortOrder==SQLITE_SO_DESC
1759 );
1760 assert( eNulls==SQLITE_SO_UNDEFINED
1761 || eNulls==SQLITE_SO_ASC
1762 || eNulls==SQLITE_SO_DESC
1763 );
1764
dan9105fd52019-08-19 17:26:32 +00001765 pItem = &p->a[p->nExpr-1];
1766 assert( pItem->bNulls==0 );
1767 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1768 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001769 }
dan9105fd52019-08-19 17:26:32 +00001770 pItem->sortFlags = (u8)iSortOrder;
1771
1772 if( eNulls!=SQLITE_SO_UNDEFINED ){
1773 pItem->bNulls = 1;
1774 if( iSortOrder!=eNulls ){
1775 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1776 }
drhbc622bc2015-08-24 15:39:42 +00001777 }
drhbc622bc2015-08-24 15:39:42 +00001778}
1779
1780/*
drh41cee662019-12-12 20:22:34 +00001781** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001782** on the expression list.
1783**
1784** pList might be NULL following an OOM error. But pName should never be
1785** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1786** is set.
1787*/
1788void sqlite3ExprListSetName(
1789 Parse *pParse, /* Parsing context */
1790 ExprList *pList, /* List to which to add the span. */
1791 Token *pName, /* Name to be added */
1792 int dequote /* True to cause the name to be dequoted */
1793){
1794 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001795 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001796 if( pList ){
1797 struct ExprList_item *pItem;
1798 assert( pList->nExpr>0 );
1799 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001800 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001801 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001802 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001803 if( dequote ){
1804 /* If dequote==0, then pName->z does not point to part of a DDL
1805 ** statement handled by the parser. And so no token need be added
1806 ** to the token-map. */
1807 sqlite3Dequote(pItem->zEName);
1808 if( IN_RENAME_OBJECT ){
1809 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1810 }
dan5be60c52018-08-15 20:28:39 +00001811 }
drhb7916a72009-05-27 10:31:29 +00001812 }
1813}
1814
1815/*
1816** Set the ExprList.a[].zSpan element of the most recently added item
1817** on the expression list.
1818**
1819** pList might be NULL following an OOM error. But pSpan should never be
1820** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1821** is set.
1822*/
1823void sqlite3ExprListSetSpan(
1824 Parse *pParse, /* Parsing context */
1825 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001826 const char *zStart, /* Start of the span */
1827 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001828){
1829 sqlite3 *db = pParse->db;
1830 assert( pList!=0 || db->mallocFailed!=0 );
1831 if( pList ){
1832 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1833 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001834 if( pItem->zEName==0 ){
1835 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1836 pItem->eEName = ENAME_SPAN;
1837 }
drhb7916a72009-05-27 10:31:29 +00001838 }
1839}
1840
1841/*
danielk19777a15a4b2007-05-08 17:54:43 +00001842** If the expression list pEList contains more than iLimit elements,
1843** leave an error message in pParse.
1844*/
1845void sqlite3ExprListCheckLength(
1846 Parse *pParse,
1847 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001848 const char *zObject
1849){
drhb1a6c3c2008-03-20 16:30:17 +00001850 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001851 testcase( pEList && pEList->nExpr==mx );
1852 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001853 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001854 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1855 }
1856}
1857
1858/*
drha76b5df2002-02-23 02:32:10 +00001859** Delete an entire expression list.
1860*/
drhaffa8552016-04-11 18:25:05 +00001861static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001862 int i = pList->nExpr;
1863 struct ExprList_item *pItem = pList->a;
1864 assert( pList->nExpr>0 );
1865 do{
drh633e6d52008-07-28 19:34:53 +00001866 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001867 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001868 pItem++;
1869 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001870 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001871}
drhaffa8552016-04-11 18:25:05 +00001872void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1873 if( pList ) exprListDeleteNN(db, pList);
1874}
drha76b5df2002-02-23 02:32:10 +00001875
1876/*
drh2308ed32015-02-09 16:09:34 +00001877** Return the bitwise-OR of all Expr.flags fields in the given
1878** ExprList.
drh885a5b02015-02-09 15:21:36 +00001879*/
drh2308ed32015-02-09 16:09:34 +00001880u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001881 int i;
drh2308ed32015-02-09 16:09:34 +00001882 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001883 assert( pList!=0 );
1884 for(i=0; i<pList->nExpr; i++){
1885 Expr *pExpr = pList->a[i].pExpr;
1886 assert( pExpr!=0 );
1887 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001888 }
drh2308ed32015-02-09 16:09:34 +00001889 return m;
drh885a5b02015-02-09 15:21:36 +00001890}
1891
1892/*
drh7e6f9802017-09-04 00:33:04 +00001893** This is a SELECT-node callback for the expression walker that
1894** always "fails". By "fail" in this case, we mean set
1895** pWalker->eCode to zero and abort.
1896**
1897** This callback is used by multiple expression walkers.
1898*/
1899int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1900 UNUSED_PARAMETER(NotUsed);
1901 pWalker->eCode = 0;
1902 return WRC_Abort;
1903}
1904
1905/*
drh0cbec592020-01-03 02:20:37 +00001906** Check the input string to see if it is "true" or "false" (in any case).
1907**
1908** If the string is.... Return
1909** "true" EP_IsTrue
1910** "false" EP_IsFalse
1911** anything else 0
1912*/
1913u32 sqlite3IsTrueOrFalse(const char *zIn){
1914 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1915 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1916 return 0;
1917}
1918
1919
1920/*
drh171d16b2018-02-26 20:15:54 +00001921** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001922** then convert it into an TK_TRUEFALSE term. Return non-zero if
1923** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001924*/
1925int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001926 u32 v;
drh171d16b2018-02-26 20:15:54 +00001927 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001928 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001929 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001930 ){
1931 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001932 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001933 return 1;
1934 }
1935 return 0;
1936}
1937
drh43c4ac82018-02-26 21:26:27 +00001938/*
drh96acafb2018-02-27 14:49:25 +00001939** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001940** and 0 if it is FALSE.
1941*/
drh96acafb2018-02-27 14:49:25 +00001942int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001943 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001944 assert( pExpr->op==TK_TRUEFALSE );
1945 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1946 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1947 return pExpr->u.zToken[4]==0;
1948}
1949
drh17180fc2019-04-19 17:26:19 +00001950/*
1951** If pExpr is an AND or OR expression, try to simplify it by eliminating
1952** terms that are always true or false. Return the simplified expression.
1953** Or return the original expression if no simplification is possible.
1954**
1955** Examples:
1956**
1957** (x<10) AND true => (x<10)
1958** (x<10) AND false => false
1959** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1960** (x<10) AND (y=22 OR true) => (x<10)
1961** (y=22) OR true => true
1962*/
1963Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1964 assert( pExpr!=0 );
1965 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1966 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1967 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1968 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1969 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1970 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1971 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1972 }
1973 }
1974 return pExpr;
1975}
1976
drh171d16b2018-02-26 20:15:54 +00001977
1978/*
drh059b2d52014-10-24 19:28:09 +00001979** These routines are Walker callbacks used to check expressions to
1980** see if they are "constant" for some definition of constant. The
1981** Walker.eCode value determines the type of "constant" we are looking
1982** for.
drh73b211a2005-01-18 04:00:42 +00001983**
drh7d10d5a2008-08-20 16:35:10 +00001984** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001985**
drh059b2d52014-10-24 19:28:09 +00001986** sqlite3ExprIsConstant() pWalker->eCode==1
1987** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001988** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001989** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001990**
drh059b2d52014-10-24 19:28:09 +00001991** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1992** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001993**
drh014fff22020-01-08 22:22:36 +00001994** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1995** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
1996** when parsing an existing schema out of the sqlite_master table and 4
1997** when processing a new CREATE TABLE statement. A bound parameter raises
1998** an error for new statements, but is silently converted
drhfeada2d2014-09-24 13:20:22 +00001999** to NULL for existing schemas. This allows sqlite_master tables that
2000** contain a bound parameter because they were generated by older versions
2001** of SQLite to be parsed by newer versions of SQLite without raising a
2002** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002003*/
drh7d10d5a2008-08-20 16:35:10 +00002004static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002005
drh059b2d52014-10-24 19:28:09 +00002006 /* If pWalker->eCode is 2 then any term of the expression that comes from
2007 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002008 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002009 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2010 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002011 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002012 }
2013
drh626a8792005-01-17 22:08:19 +00002014 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002015 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002016 ** and either pWalker->eCode==4 or 5 or the function has the
2017 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002018 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002019 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2020 && !ExprHasProperty(pExpr, EP_WinFunc)
2021 ){
drh014fff22020-01-08 22:22:36 +00002022 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002023 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002024 }else{
2025 pWalker->eCode = 0;
2026 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002027 }
drh626a8792005-01-17 22:08:19 +00002028 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002029 /* Convert "true" or "false" in a DEFAULT clause into the
2030 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002031 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002032 return WRC_Prune;
2033 }
2034 /* Fall thru */
drh626a8792005-01-17 22:08:19 +00002035 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002036 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002037 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002038 testcase( pExpr->op==TK_ID );
2039 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002040 testcase( pExpr->op==TK_AGG_FUNCTION );
2041 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002042 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002043 return WRC_Continue;
2044 }
drh059b2d52014-10-24 19:28:09 +00002045 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2046 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002047 }
drhf43ce0b2017-05-25 00:08:48 +00002048 /* Fall through */
2049 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002050 case TK_REGISTER:
drh99160482018-04-18 01:34:39 +00002051 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002052 testcase( pExpr->op==TK_IF_NULL_ROW );
2053 pWalker->eCode = 0;
2054 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002055 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002056 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002057 /* Silently convert bound parameters that appear inside of CREATE
2058 ** statements into a NULL when parsing the CREATE statement text out
2059 ** of the sqlite_master table */
2060 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002061 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002062 /* A bound parameter in a CREATE statement that originates from
2063 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002064 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002065 return WRC_Abort;
2066 }
2067 /* Fall through */
drh626a8792005-01-17 22:08:19 +00002068 default:
drh6e341b92018-04-17 18:50:40 +00002069 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2070 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002071 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002072 }
2073}
drh059b2d52014-10-24 19:28:09 +00002074static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002075 Walker w;
drh059b2d52014-10-24 19:28:09 +00002076 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002077 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002078 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002079#ifdef SQLITE_DEBUG
2080 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2081#endif
drh059b2d52014-10-24 19:28:09 +00002082 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002083 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002084 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002085}
drh626a8792005-01-17 22:08:19 +00002086
2087/*
drh059b2d52014-10-24 19:28:09 +00002088** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002089** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002090**
2091** For the purposes of this function, a double-quoted string (ex: "abc")
2092** is considered a variable but a single-quoted string (ex: 'abc') is
2093** a constant.
drhfef52082000-06-06 01:50:43 +00002094*/
danielk19774adee202004-05-08 08:23:19 +00002095int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002096 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002097}
2098
2099/*
drh07aded62018-07-28 16:24:08 +00002100** Walk an expression tree. Return non-zero if
2101**
2102** (1) the expression is constant, and
2103** (2) the expression does originate in the ON or USING clause
2104** of a LEFT JOIN, and
2105** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2106** operands created by the constant propagation optimization.
2107**
2108** When this routine returns true, it indicates that the expression
2109** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002110** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002111*/
2112int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002113 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002114}
2115
2116/*
drhfcb9f4f2015-06-01 18:13:16 +00002117** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002118** for any single row of the table with cursor iCur. In other words, the
2119** expression must not refer to any non-deterministic function nor any
2120** table other than iCur.
2121*/
2122int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2123 return exprIsConst(p, 3, iCur);
2124}
2125
danab31a842017-04-29 20:53:09 +00002126
2127/*
2128** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2129*/
2130static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2131 ExprList *pGroupBy = pWalker->u.pGroupBy;
2132 int i;
2133
2134 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2135 ** it constant. */
2136 for(i=0; i<pGroupBy->nExpr; i++){
2137 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002138 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002139 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002140 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002141 return WRC_Prune;
2142 }
2143 }
2144 }
2145
2146 /* Check if pExpr is a sub-select. If so, consider it variable. */
2147 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2148 pWalker->eCode = 0;
2149 return WRC_Abort;
2150 }
2151
2152 return exprNodeIsConstant(pWalker, pExpr);
2153}
2154
2155/*
2156** Walk the expression tree passed as the first argument. Return non-zero
2157** if the expression consists entirely of constants or copies of terms
2158** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002159**
2160** This routine is used to determine if a term of the HAVING clause can
2161** be promoted into the WHERE clause. In order for such a promotion to work,
2162** the value of the HAVING clause term must be the same for all members of
2163** a "group". The requirement that the GROUP BY term must be BINARY
2164** assumes that no other collating sequence will have a finer-grained
2165** grouping than binary. In other words (A=B COLLATE binary) implies
2166** A=B in every other collating sequence. The requirement that the
2167** GROUP BY be BINARY is stricter than necessary. It would also work
2168** to promote HAVING clauses that use the same alternative collating
2169** sequence as the GROUP BY term, but that is much harder to check,
2170** alternative collating sequences are uncommon, and this is only an
2171** optimization, so we take the easy way out and simply require the
2172** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002173*/
2174int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2175 Walker w;
danab31a842017-04-29 20:53:09 +00002176 w.eCode = 1;
2177 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002178 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002179 w.u.pGroupBy = pGroupBy;
2180 w.pParse = pParse;
2181 sqlite3WalkExpr(&w, p);
2182 return w.eCode;
2183}
2184
drh059b2d52014-10-24 19:28:09 +00002185/*
drh014fff22020-01-08 22:22:36 +00002186** Walk an expression tree for the DEFAULT field of a column definition
2187** in a CREATE TABLE statement. Return non-zero if the expression is
2188** acceptable for use as a DEFAULT. That is to say, return non-zero if
2189** the expression is constant or a function call with constant arguments.
2190** Return and 0 if there are any variables.
2191**
2192** isInit is true when parsing from sqlite_master. isInit is false when
2193** processing a new CREATE TABLE statement. When isInit is true, parameters
2194** (such as ? or $abc) in the expression are converted into NULL. When
2195** isInit is false, parameters raise an error. Parameters should not be
2196** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
2197** allowed it, so we need to support it when reading sqlite_master for
2198** backwards compatibility.
2199**
2200** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002201**
2202** For the purposes of this function, a double-quoted string (ex: "abc")
2203** is considered a variable but a single-quoted string (ex: 'abc') is
2204** a constant.
2205*/
drhfeada2d2014-09-24 13:20:22 +00002206int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2207 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002208 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002209}
2210
drh5b88bc42013-12-07 23:35:21 +00002211#ifdef SQLITE_ENABLE_CURSOR_HINTS
2212/*
2213** Walk an expression tree. Return 1 if the expression contains a
2214** subquery of some kind. Return 0 if there are no subqueries.
2215*/
2216int sqlite3ExprContainsSubquery(Expr *p){
2217 Walker w;
drhbec24762015-08-13 20:07:13 +00002218 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002219 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002220 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002221#ifdef SQLITE_DEBUG
2222 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2223#endif
drh5b88bc42013-12-07 23:35:21 +00002224 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002225 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002226}
2227#endif
2228
drheb55bd22005-06-30 17:04:21 +00002229/*
drh73b211a2005-01-18 04:00:42 +00002230** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002231** to fit in a 32-bit integer, return 1 and put the value of the integer
2232** in *pValue. If the expression is not an integer or if it is too big
2233** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002234*/
danielk19774adee202004-05-08 08:23:19 +00002235int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002236 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002237 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002238
2239 /* If an expression is an integer literal that fits in a signed 32-bit
2240 ** integer, then the EP_IntValue flag will have already been set */
2241 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2242 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2243
drh92b01d52008-06-24 00:32:35 +00002244 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002245 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002246 return 1;
2247 }
drhe4de1fe2002-06-02 16:09:01 +00002248 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002249 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002250 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002251 break;
drh4b59ab52002-08-24 18:24:51 +00002252 }
drhe4de1fe2002-06-02 16:09:01 +00002253 case TK_UMINUS: {
2254 int v;
danielk19774adee202004-05-08 08:23:19 +00002255 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002256 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002257 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002258 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002259 }
2260 break;
2261 }
2262 default: break;
2263 }
drh92b01d52008-06-24 00:32:35 +00002264 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002265}
2266
2267/*
drh039fc322009-11-17 18:31:47 +00002268** Return FALSE if there is no chance that the expression can be NULL.
2269**
2270** If the expression might be NULL or if the expression is too complex
2271** to tell return TRUE.
2272**
2273** This routine is used as an optimization, to skip OP_IsNull opcodes
2274** when we know that a value cannot be NULL. Hence, a false positive
2275** (returning TRUE when in fact the expression can never be NULL) might
2276** be a small performance hit but is otherwise harmless. On the other
2277** hand, a false negative (returning FALSE when the result could be NULL)
2278** will likely result in an incorrect answer. So when in doubt, return
2279** TRUE.
2280*/
2281int sqlite3ExprCanBeNull(const Expr *p){
2282 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002283 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2284 p = p->pLeft;
2285 }
drh039fc322009-11-17 18:31:47 +00002286 op = p->op;
2287 if( op==TK_REGISTER ) op = p->op2;
2288 switch( op ){
2289 case TK_INTEGER:
2290 case TK_STRING:
2291 case TK_FLOAT:
2292 case TK_BLOB:
2293 return 0;
drh7248a8b2014-08-04 18:50:54 +00002294 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002295 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002296 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002297 (p->iColumn>=0
2298 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2299 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002300 default:
2301 return 1;
2302 }
2303}
2304
2305/*
2306** Return TRUE if the given expression is a constant which would be
2307** unchanged by OP_Affinity with the affinity given in the second
2308** argument.
2309**
2310** This routine is used to determine if the OP_Affinity operation
2311** can be omitted. When in doubt return FALSE. A false negative
2312** is harmless. A false positive, however, can result in the wrong
2313** answer.
2314*/
2315int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2316 u8 op;
drhaf866402019-08-22 11:11:28 +00002317 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002318 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002319 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2320 if( p->op==TK_UMINUS ) unaryMinus = 1;
2321 p = p->pLeft;
2322 }
drh039fc322009-11-17 18:31:47 +00002323 op = p->op;
2324 if( op==TK_REGISTER ) op = p->op2;
2325 switch( op ){
2326 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002327 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002328 }
2329 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002330 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002331 }
2332 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002333 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002334 }
2335 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002336 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002337 }
drh2f2855b2009-11-18 01:25:26 +00002338 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002339 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002340 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002341 }
drh039fc322009-11-17 18:31:47 +00002342 default: {
2343 return 0;
2344 }
2345 }
2346}
2347
2348/*
drhc4a3c772001-04-04 11:48:57 +00002349** Return TRUE if the given string is a row-id column name.
2350*/
danielk19774adee202004-05-08 08:23:19 +00002351int sqlite3IsRowid(const char *z){
2352 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2353 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2354 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002355 return 0;
2356}
2357
danielk19779a96b662007-11-29 17:05:18 +00002358/*
drh69c355b2016-03-09 15:34:51 +00002359** pX is the RHS of an IN operator. If pX is a SELECT statement
2360** that can be simplified to a direct table access, then return
2361** a pointer to the SELECT statement. If pX is not a SELECT statement,
2362** or if the SELECT statement needs to be manifested into a transient
2363** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002364*/
2365#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002366static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002367 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002368 SrcList *pSrc;
2369 ExprList *pEList;
2370 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002371 int i;
drh69c355b2016-03-09 15:34:51 +00002372 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2373 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2374 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002375 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002376 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002377 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2378 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2379 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002380 }
drh2e26a602020-01-06 18:59:46 +00002381 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002382 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002383 if( p->pWhere ) return 0; /* Has no WHERE clause */
2384 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002385 assert( pSrc!=0 );
2386 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002387 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002388 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002389 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002390 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002391 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2392 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002393 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002394 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002395 for(i=0; i<pEList->nExpr; i++){
2396 Expr *pRes = pEList->a[i].pExpr;
2397 if( pRes->op!=TK_COLUMN ) return 0;
2398 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002399 }
drh69c355b2016-03-09 15:34:51 +00002400 return p;
drhb287f4b2008-04-25 00:08:38 +00002401}
2402#endif /* SQLITE_OMIT_SUBQUERY */
2403
danf9b2e052016-08-02 17:45:00 +00002404#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002405/*
drh4c259e92014-08-01 21:12:35 +00002406** Generate code that checks the left-most column of index table iCur to see if
2407** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002408** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2409** to be set to NULL if iCur contains one or more NULL values.
2410*/
2411static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002412 int addr1;
drh6be515e2014-08-01 21:00:53 +00002413 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002414 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002415 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2416 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002417 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002418 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002419}
danf9b2e052016-08-02 17:45:00 +00002420#endif
drh6be515e2014-08-01 21:00:53 +00002421
drhbb53ecb2014-08-02 21:03:33 +00002422
2423#ifndef SQLITE_OMIT_SUBQUERY
2424/*
2425** The argument is an IN operator with a list (not a subquery) on the
2426** right-hand side. Return TRUE if that list is constant.
2427*/
2428static int sqlite3InRhsIsConstant(Expr *pIn){
2429 Expr *pLHS;
2430 int res;
2431 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2432 pLHS = pIn->pLeft;
2433 pIn->pLeft = 0;
2434 res = sqlite3ExprIsConstant(pIn);
2435 pIn->pLeft = pLHS;
2436 return res;
2437}
2438#endif
2439
drh6be515e2014-08-01 21:00:53 +00002440/*
danielk19779a96b662007-11-29 17:05:18 +00002441** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002442** The pX parameter is the expression on the RHS of the IN operator, which
2443** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002444**
drhd4305ca2012-09-18 17:08:33 +00002445** The job of this routine is to find or create a b-tree object that can
2446** be used either to test for membership in the RHS set or to iterate through
2447** all members of the RHS set, skipping duplicates.
2448**
drh3a856252014-08-01 14:46:57 +00002449** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002450** and pX->iTable is set to the index of that cursor.
2451**
drhb74b1012009-05-28 21:04:37 +00002452** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002453**
drh1ccce442013-03-12 20:38:51 +00002454** IN_INDEX_ROWID - The cursor was opened on a database table.
2455** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2456** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2457** IN_INDEX_EPH - The cursor was opened on a specially created and
2458** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002459** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2460** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002461**
drhd4305ca2012-09-18 17:08:33 +00002462** An existing b-tree might be used if the RHS expression pX is a simple
2463** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002464**
dan553168c2016-08-01 20:14:31 +00002465** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002466**
drhd4305ca2012-09-18 17:08:33 +00002467** If the RHS of the IN operator is a list or a more complex subquery, then
2468** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002469** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002470** existing table.
drhd4305ca2012-09-18 17:08:33 +00002471**
drh7fc0ba02017-11-17 15:02:00 +00002472** The inFlags parameter must contain, at a minimum, one of the bits
2473** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2474** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2475** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2476** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002477**
2478** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2479** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002480** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002481** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2482** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002483**
drh3a856252014-08-01 14:46:57 +00002484** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2485** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002486** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2487** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002488**
drhbb53ecb2014-08-02 21:03:33 +00002489** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2490** if the RHS of the IN operator is a list (not a subquery) then this
2491** routine might decide that creating an ephemeral b-tree for membership
2492** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2493** calling routine should implement the IN operator using a sequence
2494** of Eq or Ne comparison operations.
2495**
drhb74b1012009-05-28 21:04:37 +00002496** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002497** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002498** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002499** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002500** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002501** to *prRhsHasNull. If there is no chance that the (...) contains a
2502** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002503**
drhe21a6e12014-08-01 18:00:24 +00002504** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002505** the value in that register will be NULL if the b-tree contains one or more
2506** NULL values, and it will be some non-NULL value if the b-tree contains no
2507** NULL values.
dan553168c2016-08-01 20:14:31 +00002508**
2509** If the aiMap parameter is not NULL, it must point to an array containing
2510** one element for each column returned by the SELECT statement on the RHS
2511** of the IN(...) operator. The i'th entry of the array is populated with the
2512** offset of the index column that matches the i'th column returned by the
2513** SELECT. For example, if the expression and selected index are:
2514**
2515** (?,?,?) IN (SELECT a, b, c FROM t1)
2516** CREATE INDEX i1 ON t1(b, c, a);
2517**
2518** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002519*/
danielk1977284f4ac2007-12-10 05:03:46 +00002520#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002521int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002522 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002523 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002524 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2525 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002526 int *aiMap, /* Mapping from Index fields to RHS fields */
2527 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002528){
drhb74b1012009-05-28 21:04:37 +00002529 Select *p; /* SELECT to the right of IN operator */
2530 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2531 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002532 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002533 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002534
drh1450bc62009-10-30 13:25:56 +00002535 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002536 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002537
dan7b35a772016-07-28 19:47:15 +00002538 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2539 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002540 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002541 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002542 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002543 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2544 int i;
2545 ExprList *pEList = pX->x.pSelect->pEList;
2546 for(i=0; i<pEList->nExpr; i++){
2547 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2548 }
2549 if( i==pEList->nExpr ){
2550 prRhsHasNull = 0;
2551 }
2552 }
2553
drhb74b1012009-05-28 21:04:37 +00002554 /* Check to see if an existing table or index can be used to
2555 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002556 ** ephemeral table. */
2557 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002558 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002559 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002560 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002561 ExprList *pEList = p->pEList;
2562 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002563
drhb07028f2011-10-14 21:49:18 +00002564 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2565 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2566 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2567 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002568
drhb22f7c82014-02-06 23:56:27 +00002569 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002570 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drhbdd4f7d2020-05-26 10:54:46 +00002571 assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
danielk1977e1fb65a2009-04-02 17:23:32 +00002572 sqlite3CodeVerifySchema(pParse, iDb);
2573 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002574
drha84a2832016-08-26 21:15:35 +00002575 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002576 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002577 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002578 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002579 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002580
2581 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2582 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002583 ExplainQueryPlan((pParse, 0,
2584 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002585 sqlite3VdbeJumpHere(v, iAddr);
2586 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002587 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002588 int affinity_ok = 1;
2589 int i;
2590
2591 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002592 ** comparison is the same as the affinity of each column in table
2593 ** on the RHS of the IN operator. If it not, it is not possible to
2594 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002595 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002596 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002597 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002598 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002599 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002600 testcase( cmpaff==SQLITE_AFF_BLOB );
2601 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002602 switch( cmpaff ){
2603 case SQLITE_AFF_BLOB:
2604 break;
2605 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002606 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2607 ** other has no affinity and the other side is TEXT. Hence,
2608 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2609 ** and for the term on the LHS of the IN to have no affinity. */
2610 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002611 break;
2612 default:
2613 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2614 }
2615 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002616
drha84a2832016-08-26 21:15:35 +00002617 if( affinity_ok ){
2618 /* Search for an existing index that will work for this IN operator */
2619 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2620 Bitmask colUsed; /* Columns of the index used */
2621 Bitmask mCol; /* Mask for the current column */
2622 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002623 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002624 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2625 ** BITMASK(nExpr) without overflowing */
2626 testcase( pIdx->nColumn==BMS-2 );
2627 testcase( pIdx->nColumn==BMS-1 );
2628 if( pIdx->nColumn>=BMS-1 ) continue;
2629 if( mustBeUnique ){
2630 if( pIdx->nKeyCol>nExpr
2631 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2632 ){
2633 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002634 }
danielk19770cdc0222008-06-26 18:04:03 +00002635 }
drha84a2832016-08-26 21:15:35 +00002636
2637 colUsed = 0; /* Columns of index used so far */
2638 for(i=0; i<nExpr; i++){
2639 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2640 Expr *pRhs = pEList->a[i].pExpr;
2641 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2642 int j;
2643
2644 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2645 for(j=0; j<nExpr; j++){
2646 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2647 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002648 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2649 continue;
2650 }
drha84a2832016-08-26 21:15:35 +00002651 break;
2652 }
2653 if( j==nExpr ) break;
2654 mCol = MASKBIT(j);
2655 if( mCol & colUsed ) break; /* Each column used only once */
2656 colUsed |= mCol;
2657 if( aiMap ) aiMap[i] = j;
2658 }
2659
2660 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2661 if( colUsed==(MASKBIT(nExpr)-1) ){
2662 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002663 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002664 ExplainQueryPlan((pParse, 0,
2665 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002666 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2667 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2668 VdbeComment((v, "%s", pIdx->zName));
2669 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2670 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2671
2672 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002673#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002674 i64 mask = (1<<nExpr)-1;
2675 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2676 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002677#endif
2678 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002679 if( nExpr==1 ){
2680 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2681 }
2682 }
2683 sqlite3VdbeJumpHere(v, iAddr);
2684 }
2685 } /* End loop over indexes */
2686 } /* End if( affinity_ok ) */
2687 } /* End if not an rowid index */
2688 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002689
drhbb53ecb2014-08-02 21:03:33 +00002690 /* If no preexisting index is available for the IN clause
2691 ** and IN_INDEX_NOOP is an allowed reply
2692 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002693 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002694 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002695 ** the IN operator so return IN_INDEX_NOOP.
2696 */
2697 if( eType==0
2698 && (inFlags & IN_INDEX_NOOP_OK)
2699 && !ExprHasProperty(pX, EP_xIsSelect)
2700 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2701 ){
2702 eType = IN_INDEX_NOOP;
2703 }
drhbb53ecb2014-08-02 21:03:33 +00002704
danielk19779a96b662007-11-29 17:05:18 +00002705 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002706 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002707 ** We will have to generate an ephemeral table to do the job.
2708 */
drh8e23daf2013-06-11 13:30:04 +00002709 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002710 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002711 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002712 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002713 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002714 }else if( prRhsHasNull ){
2715 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002716 }
drh85bcdce2018-12-23 21:27:29 +00002717 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002718 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002719 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002720 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002721 }
drhcf4d38a2010-07-28 02:53:36 +00002722 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002723 }
danba00e302016-07-23 20:24:06 +00002724
2725 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2726 int i, n;
2727 n = sqlite3ExprVectorSize(pX->pLeft);
2728 for(i=0; i<n; i++) aiMap[i] = i;
2729 }
drh2c041312018-12-24 02:34:49 +00002730 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002731 return eType;
2732}
danielk1977284f4ac2007-12-10 05:03:46 +00002733#endif
drh626a8792005-01-17 22:08:19 +00002734
danf9b2e052016-08-02 17:45:00 +00002735#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002736/*
2737** Argument pExpr is an (?, ?...) IN(...) expression. This
2738** function allocates and returns a nul-terminated string containing
2739** the affinities to be used for each column of the comparison.
2740**
2741** It is the responsibility of the caller to ensure that the returned
2742** string is eventually freed using sqlite3DbFree().
2743*/
dan71c57db2016-07-09 20:23:55 +00002744static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2745 Expr *pLeft = pExpr->pLeft;
2746 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002747 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002748 char *zRet;
2749
dan553168c2016-08-01 20:14:31 +00002750 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002751 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002752 if( zRet ){
2753 int i;
2754 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002755 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002756 char a = sqlite3ExprAffinity(pA);
2757 if( pSelect ){
2758 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2759 }else{
2760 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002761 }
dan71c57db2016-07-09 20:23:55 +00002762 }
2763 zRet[nVal] = '\0';
2764 }
2765 return zRet;
2766}
danf9b2e052016-08-02 17:45:00 +00002767#endif
dan71c57db2016-07-09 20:23:55 +00002768
dan8da209b2016-07-26 18:06:08 +00002769#ifndef SQLITE_OMIT_SUBQUERY
2770/*
2771** Load the Parse object passed as the first argument with an error
2772** message of the form:
2773**
2774** "sub-select returns N columns - expected M"
2775*/
2776void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002777 if( pParse->nErr==0 ){
2778 const char *zFmt = "sub-select returns %d columns - expected %d";
2779 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2780 }
dan8da209b2016-07-26 18:06:08 +00002781}
2782#endif
2783
drh626a8792005-01-17 22:08:19 +00002784/*
dan44c56042016-12-07 15:38:37 +00002785** Expression pExpr is a vector that has been used in a context where
2786** it is not permitted. If pExpr is a sub-select vector, this routine
2787** loads the Parse object with a message of the form:
2788**
2789** "sub-select returns N columns - expected 1"
2790**
2791** Or, if it is a regular scalar vector:
2792**
2793** "row value misused"
2794*/
2795void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2796#ifndef SQLITE_OMIT_SUBQUERY
2797 if( pExpr->flags & EP_xIsSelect ){
2798 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2799 }else
2800#endif
2801 {
2802 sqlite3ErrorMsg(pParse, "row value misused");
2803 }
2804}
2805
drh85bcdce2018-12-23 21:27:29 +00002806#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002807/*
drh85bcdce2018-12-23 21:27:29 +00002808** Generate code that will construct an ephemeral table containing all terms
2809** in the RHS of an IN operator. The IN operator can be in either of two
2810** forms:
drh626a8792005-01-17 22:08:19 +00002811**
drh9cbe6352005-11-29 03:13:21 +00002812** x IN (4,5,11) -- IN operator with list on right-hand side
2813** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002814**
drh2c041312018-12-24 02:34:49 +00002815** The pExpr parameter is the IN operator. The cursor number for the
2816** constructed ephermeral table is returned. The first time the ephemeral
2817** table is computed, the cursor number is also stored in pExpr->iTable,
2818** however the cursor number returned might not be the same, as it might
2819** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002820**
drh85bcdce2018-12-23 21:27:29 +00002821** If the LHS expression ("x" in the examples) is a column value, or
2822** the SELECT statement returns a column value, then the affinity of that
2823** column is used to build the index keys. If both 'x' and the
2824** SELECT... statement are columns, then numeric affinity is used
2825** if either column has NUMERIC or INTEGER affinity. If neither
2826** 'x' nor the SELECT... statement are columns, then numeric affinity
2827** is used.
drhcce7d172000-05-31 15:34:51 +00002828*/
drh85bcdce2018-12-23 21:27:29 +00002829void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002830 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002831 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002832 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002833){
drh2c041312018-12-24 02:34:49 +00002834 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002835 int addr; /* Address of OP_OpenEphemeral instruction */
2836 Expr *pLeft; /* the LHS of the IN operator */
2837 KeyInfo *pKeyInfo = 0; /* Key information */
2838 int nVal; /* Size of vector pLeft */
2839 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002840
drh2c041312018-12-24 02:34:49 +00002841 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002842 assert( v!=0 );
2843
drh2c041312018-12-24 02:34:49 +00002844 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002845 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002846 **
2847 ** * The right-hand side is a correlated subquery
2848 ** * The right-hand side is an expression list containing variables
2849 ** * We are inside a trigger
2850 **
drh2c041312018-12-24 02:34:49 +00002851 ** If all of the above are false, then we can compute the RHS just once
2852 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002853 */
drhefb699f2018-12-24 11:55:44 +00002854 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002855 /* Reuse of the RHS is allowed */
2856 /* If this routine has already been coded, but the previous code
2857 ** might not have been invoked yet, so invoke it now as a subroutine.
2858 */
2859 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002860 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002861 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2862 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2863 pExpr->x.pSelect->selId));
2864 }
drh2c041312018-12-24 02:34:49 +00002865 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2866 pExpr->y.sub.iAddr);
2867 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002868 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002869 return;
2870 }
2871
2872 /* Begin coding the subroutine */
2873 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002874 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002875 pExpr->y.sub.regReturn = ++pParse->nMem;
2876 pExpr->y.sub.iAddr =
2877 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2878 VdbeComment((v, "return address"));
2879
2880 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002881 }
2882
drh85bcdce2018-12-23 21:27:29 +00002883 /* Check to see if this is a vector IN operator */
2884 pLeft = pExpr->pLeft;
2885 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002886
drh85bcdce2018-12-23 21:27:29 +00002887 /* Construct the ephemeral table that will contain the content of
2888 ** RHS of the IN operator.
2889 */
drh2c041312018-12-24 02:34:49 +00002890 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002891 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002892#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2893 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2894 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2895 }else{
2896 VdbeComment((v, "RHS of IN operator"));
2897 }
2898#endif
drh50ef6712019-02-22 23:29:56 +00002899 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002900
drh85bcdce2018-12-23 21:27:29 +00002901 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2902 /* Case 1: expr IN (SELECT ...)
2903 **
2904 ** Generate code to write the results of the select into the temporary
2905 ** table allocated and opened above.
2906 */
2907 Select *pSelect = pExpr->x.pSelect;
2908 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002909
drh2c041312018-12-24 02:34:49 +00002910 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2911 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002912 ));
drh85bcdce2018-12-23 21:27:29 +00002913 /* If the LHS and RHS of the IN operator do not match, that
2914 ** error will have been caught long before we reach this point. */
2915 if( ALWAYS(pEList->nExpr==nVal) ){
2916 SelectDest dest;
2917 int i;
drhbd462bc2018-12-24 20:21:06 +00002918 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002919 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2920 pSelect->iLimit = 0;
2921 testcase( pSelect->selFlags & SF_Distinct );
2922 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2923 if( sqlite3Select(pParse, pSelect, &dest) ){
2924 sqlite3DbFree(pParse->db, dest.zAffSdst);
2925 sqlite3KeyInfoUnref(pKeyInfo);
2926 return;
drhfef52082000-06-06 01:50:43 +00002927 }
drh85bcdce2018-12-23 21:27:29 +00002928 sqlite3DbFree(pParse->db, dest.zAffSdst);
2929 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2930 assert( pEList!=0 );
2931 assert( pEList->nExpr>0 );
2932 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2933 for(i=0; i<nVal; i++){
2934 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2935 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2936 pParse, p, pEList->a[i].pExpr
2937 );
danielk197741a05b72008-10-02 13:50:55 +00002938 }
drh85bcdce2018-12-23 21:27:29 +00002939 }
2940 }else if( ALWAYS(pExpr->x.pList!=0) ){
2941 /* Case 2: expr IN (exprlist)
2942 **
2943 ** For each expression, build an index key from the evaluation and
2944 ** store it in the temporary table. If <expr> is a column, then use
2945 ** that columns affinity when building index keys. If <expr> is not
2946 ** a column, use numeric affinity.
2947 */
2948 char affinity; /* Affinity of the LHS of the IN */
2949 int i;
2950 ExprList *pList = pExpr->x.pList;
2951 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002952 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002953 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002954 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002955 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00002956 }else if( affinity==SQLITE_AFF_REAL ){
2957 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00002958 }
2959 if( pKeyInfo ){
2960 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2961 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002962 }
2963
drh85bcdce2018-12-23 21:27:29 +00002964 /* Loop through each expression in <exprlist>. */
2965 r1 = sqlite3GetTempReg(pParse);
2966 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002967 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2968 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002969
2970 /* If the expression is not constant then we will need to
2971 ** disable the test that was generated above that makes sure
2972 ** this code only executes once. Because for a non-constant
2973 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002974 */
drh2c041312018-12-24 02:34:49 +00002975 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2976 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002977 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002978 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002979 }
drh1398ad32005-01-19 23:24:50 +00002980
drh85bcdce2018-12-23 21:27:29 +00002981 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002982 sqlite3ExprCode(pParse, pE2, r1);
2983 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2984 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002985 }
drh85bcdce2018-12-23 21:27:29 +00002986 sqlite3ReleaseTempReg(pParse, r1);
2987 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002988 }
drh85bcdce2018-12-23 21:27:29 +00002989 if( pKeyInfo ){
2990 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2991 }
drh2c041312018-12-24 02:34:49 +00002992 if( addrOnce ){
2993 sqlite3VdbeJumpHere(v, addrOnce);
2994 /* Subroutine return */
2995 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2996 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002997 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002998 }
2999}
3000#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003001
drh85bcdce2018-12-23 21:27:29 +00003002/*
3003** Generate code for scalar subqueries used as a subquery expression
3004** or EXISTS operator:
3005**
3006** (SELECT a FROM b) -- subquery
3007** EXISTS (SELECT a FROM b) -- EXISTS subquery
3008**
3009** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3010**
drhd86fe442019-08-26 13:45:49 +00003011** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003012** the result is stored in a contiguous array of registers and the
3013** return value is the register of the left-most result column.
3014** Return 0 if an error occurs.
3015*/
3016#ifndef SQLITE_OMIT_SUBQUERY
3017int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003018 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003019 int rReg = 0; /* Register storing resulting */
3020 Select *pSel; /* SELECT statement to encode */
3021 SelectDest dest; /* How to deal with SELECT result */
3022 int nReg; /* Registers to allocate */
3023 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003024
3025 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003026 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003027 testcase( pExpr->op==TK_EXISTS );
3028 testcase( pExpr->op==TK_SELECT );
3029 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3030 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3031 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003032
drh5198ff52018-12-24 12:09:47 +00003033 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003034 ** is encountered if any of the following is true:
3035 **
3036 ** * The right-hand side is a correlated subquery
3037 ** * The right-hand side is an expression list containing variables
3038 ** * We are inside a trigger
3039 **
3040 ** If all of the above are false, then we can run this code just once
3041 ** save the results, and reuse the same result on subsequent invocations.
3042 */
3043 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003044 /* If this routine has already been coded, then invoke it as a
3045 ** subroutine. */
3046 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003047 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003048 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3049 pExpr->y.sub.iAddr);
3050 return pExpr->iTable;
3051 }
3052
3053 /* Begin coding the subroutine */
3054 ExprSetProperty(pExpr, EP_Subrtn);
3055 pExpr->y.sub.regReturn = ++pParse->nMem;
3056 pExpr->y.sub.iAddr =
3057 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3058 VdbeComment((v, "return address"));
3059
drh2c041312018-12-24 02:34:49 +00003060 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003061 }
drh85bcdce2018-12-23 21:27:29 +00003062
3063 /* For a SELECT, generate code to put the values for all columns of
3064 ** the first row into an array of registers and return the index of
3065 ** the first register.
3066 **
3067 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3068 ** into a register and return that register number.
3069 **
3070 ** In both cases, the query is augmented with "LIMIT 1". Any
3071 ** preexisting limit is discarded in place of the new LIMIT 1.
3072 */
drhbd462bc2018-12-24 20:21:06 +00003073 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3074 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003075 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3076 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3077 pParse->nMem += nReg;
3078 if( pExpr->op==TK_SELECT ){
3079 dest.eDest = SRT_Mem;
3080 dest.iSdst = dest.iSDParm;
3081 dest.nSdst = nReg;
3082 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3083 VdbeComment((v, "Init subquery result"));
3084 }else{
3085 dest.eDest = SRT_Exists;
3086 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3087 VdbeComment((v, "Init EXISTS result"));
3088 }
drh85bcdce2018-12-23 21:27:29 +00003089 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003090 /* The subquery already has a limit. If the pre-existing limit is X
3091 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3092 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003093 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003094 if( pLimit ){
3095 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3096 pLimit = sqlite3PExpr(pParse, TK_NE,
3097 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3098 }
3099 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003100 pSel->pLimit->pLeft = pLimit;
3101 }else{
drh7ca13472019-09-23 11:55:22 +00003102 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003103 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003104 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3105 }
3106 pSel->iLimit = 0;
3107 if( sqlite3Select(pParse, pSel, &dest) ){
3108 return 0;
3109 }
drh2c041312018-12-24 02:34:49 +00003110 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003111 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003112 if( addrOnce ){
3113 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003114
drh5198ff52018-12-24 12:09:47 +00003115 /* Subroutine return */
3116 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3117 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003118 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003119 }
drh2c041312018-12-24 02:34:49 +00003120
drh1450bc62009-10-30 13:25:56 +00003121 return rReg;
drhcce7d172000-05-31 15:34:51 +00003122}
drh51522cd2005-01-20 13:36:19 +00003123#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003124
drhe3365e62009-11-12 17:52:24 +00003125#ifndef SQLITE_OMIT_SUBQUERY
3126/*
dan7b35a772016-07-28 19:47:15 +00003127** Expr pIn is an IN(...) expression. This function checks that the
3128** sub-select on the RHS of the IN() operator has the same number of
3129** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3130** a sub-query, that the LHS is a vector of size 1.
3131*/
3132int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3133 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3134 if( (pIn->flags & EP_xIsSelect) ){
3135 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3136 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3137 return 1;
3138 }
3139 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003140 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003141 return 1;
3142 }
3143 return 0;
3144}
3145#endif
3146
3147#ifndef SQLITE_OMIT_SUBQUERY
3148/*
drhe3365e62009-11-12 17:52:24 +00003149** Generate code for an IN expression.
3150**
3151** x IN (SELECT ...)
3152** x IN (value, value, ...)
3153**
drhecb87ac2016-08-25 15:46:25 +00003154** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003155** right-hand side (RHS) is an array of zero or more scalar values, or a
3156** subquery. If the RHS is a subquery, the number of result columns must
3157** match the number of columns in the vector on the LHS. If the RHS is
3158** a list of values, the LHS must be a scalar.
3159**
3160** The IN operator is true if the LHS value is contained within the RHS.
3161** The result is false if the LHS is definitely not in the RHS. The
3162** result is NULL if the presence of the LHS in the RHS cannot be
3163** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003164**
drh6be515e2014-08-01 21:00:53 +00003165** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003166** contained within the RHS. If due to NULLs we cannot determine if the LHS
3167** is contained in the RHS then jump to destIfNull. If the LHS is contained
3168** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003169**
3170** See the separate in-operator.md documentation file in the canonical
3171** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003172*/
3173static void sqlite3ExprCodeIN(
3174 Parse *pParse, /* Parsing and code generating context */
3175 Expr *pExpr, /* The IN expression */
3176 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3177 int destIfNull /* Jump here if the results are unknown due to NULLs */
3178){
3179 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003180 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003181 int rLhs; /* Register(s) holding the LHS values */
3182 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003183 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003184 int *aiMap = 0; /* Map from vector field to index column */
3185 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003186 int nVector; /* Size of vectors for this IN operator */
3187 int iDummy; /* Dummy parameter to exprCodeVector() */
3188 Expr *pLeft; /* The LHS of the IN operator */
3189 int i; /* loop counter */
3190 int destStep2; /* Where to jump when NULLs seen in step 2 */
3191 int destStep6 = 0; /* Start of code for Step 6 */
3192 int addrTruthOp; /* Address of opcode that determines the IN is true */
3193 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3194 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003195 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003196 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003197
drhe7375bf2020-03-10 19:24:38 +00003198 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003199 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003200 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003201 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003202 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3203 aiMap = (int*)sqlite3DbMallocZero(
3204 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3205 );
drhe347d3e2016-08-25 21:14:34 +00003206 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003207
danba00e302016-07-23 20:24:06 +00003208 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003209 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003210 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3211 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003212 v = pParse->pVdbe;
3213 assert( v!=0 ); /* OOM detected prior to this routine */
3214 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003215 eType = sqlite3FindInIndex(pParse, pExpr,
3216 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003217 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3218 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003219
danba00e302016-07-23 20:24:06 +00003220 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3221 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3222 );
drhecb87ac2016-08-25 15:46:25 +00003223#ifdef SQLITE_DEBUG
3224 /* Confirm that aiMap[] contains nVector integer values between 0 and
3225 ** nVector-1. */
3226 for(i=0; i<nVector; i++){
3227 int j, cnt;
3228 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3229 assert( cnt==1 );
3230 }
3231#endif
drhe3365e62009-11-12 17:52:24 +00003232
danba00e302016-07-23 20:24:06 +00003233 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3234 ** vector, then it is stored in an array of nVector registers starting
3235 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003236 **
3237 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3238 ** so that the fields are in the same order as an existing index. The
3239 ** aiMap[] array contains a mapping from the original LHS field order to
3240 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003241 **
3242 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3243 ** even if it is constant, as OP_Affinity may be used on the register
3244 ** by code generated below. */
3245 assert( pParse->okConstFactor==okConstFactor );
3246 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003247 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003248 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003249 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003250 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003251 /* LHS fields are not reordered */
3252 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003253 }else{
3254 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003255 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003256 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003257 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003258 }
danba00e302016-07-23 20:24:06 +00003259 }
drhe3365e62009-11-12 17:52:24 +00003260
drhbb53ecb2014-08-02 21:03:33 +00003261 /* If sqlite3FindInIndex() did not find or create an index that is
3262 ** suitable for evaluating the IN operator, then evaluate using a
3263 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003264 **
3265 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003266 */
drhbb53ecb2014-08-02 21:03:33 +00003267 if( eType==IN_INDEX_NOOP ){
3268 ExprList *pList = pExpr->x.pList;
3269 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003270 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003271 int r2, regToFree;
3272 int regCkNull = 0;
3273 int ii;
3274 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003275 if( destIfNull!=destIfFalse ){
3276 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003277 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003278 }
3279 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003280 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003281 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003282 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3283 }
drhf6ea97e2020-01-04 15:21:47 +00003284 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003285 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003286 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3287 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003288 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003289 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3290 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3291 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3292 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003293 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003294 }else{
drh47994882019-12-22 23:48:36 +00003295 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003296 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003297 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3298 (void*)pColl, P4_COLLSEQ);
3299 VdbeCoverageIf(v, op==OP_Ne);
3300 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003301 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003302 }
drhbb53ecb2014-08-02 21:03:33 +00003303 }
3304 if( regCkNull ){
3305 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003306 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003307 }
3308 sqlite3VdbeResolveLabel(v, labelOk);
3309 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003310 goto sqlite3ExprCodeIN_finished;
3311 }
3312
3313 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3314 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3315 ** We will then skip the binary search of the RHS.
3316 */
3317 if( destIfNull==destIfFalse ){
3318 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003319 }else{
drhec4ccdb2018-12-29 02:26:59 +00003320 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003321 }
drh4eac5f02019-12-24 15:01:17 +00003322 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003323 for(i=0; i<nVector; i++){
3324 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3325 if( sqlite3ExprCanBeNull(p) ){
3326 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003327 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003328 }
drhe3365e62009-11-12 17:52:24 +00003329 }
drhe347d3e2016-08-25 21:14:34 +00003330
3331 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3332 ** of the RHS using the LHS as a probe. If found, the result is
3333 ** true.
3334 */
3335 if( eType==IN_INDEX_ROWID ){
3336 /* In this case, the RHS is the ROWID of table b-tree and so we also
3337 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3338 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003339 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003340 VdbeCoverage(v);
3341 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3342 }else{
3343 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3344 if( destIfFalse==destIfNull ){
3345 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003346 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003347 rLhs, nVector); VdbeCoverage(v);
3348 goto sqlite3ExprCodeIN_finished;
3349 }
3350 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003351 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003352 rLhs, nVector); VdbeCoverage(v);
3353 }
3354
3355 /* Step 4. If the RHS is known to be non-NULL and we did not find
3356 ** an match on the search above, then the result must be FALSE.
3357 */
3358 if( rRhsHasNull && nVector==1 ){
3359 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3360 VdbeCoverage(v);
3361 }
3362
3363 /* Step 5. If we do not care about the difference between NULL and
3364 ** FALSE, then just return false.
3365 */
3366 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3367
3368 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3369 ** If any comparison is NULL, then the result is NULL. If all
3370 ** comparisons are FALSE then the final result is FALSE.
3371 **
3372 ** For a scalar LHS, it is sufficient to check just the first row
3373 ** of the RHS.
3374 */
3375 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003376 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003377 VdbeCoverage(v);
3378 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003379 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003380 }else{
3381 /* For nVector==1, combine steps 6 and 7 by immediately returning
3382 ** FALSE if the first comparison is not NULL */
3383 destNotNull = destIfFalse;
3384 }
3385 for(i=0; i<nVector; i++){
3386 Expr *p;
3387 CollSeq *pColl;
3388 int r3 = sqlite3GetTempReg(pParse);
3389 p = sqlite3VectorFieldSubexpr(pLeft, i);
3390 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003391 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003392 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3393 (void*)pColl, P4_COLLSEQ);
3394 VdbeCoverage(v);
3395 sqlite3ReleaseTempReg(pParse, r3);
3396 }
3397 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3398 if( nVector>1 ){
3399 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003400 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003401 VdbeCoverage(v);
3402
3403 /* Step 7: If we reach this point, we know that the result must
3404 ** be false. */
3405 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3406 }
3407
3408 /* Jumps here in order to return true. */
3409 sqlite3VdbeJumpHere(v, addrTruthOp);
3410
3411sqlite3ExprCodeIN_finished:
3412 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003413 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003414sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003415 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003416 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003417}
3418#endif /* SQLITE_OMIT_SUBQUERY */
3419
drh13573c72010-01-12 17:04:07 +00003420#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003421/*
3422** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003423** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003424**
3425** The z[] string will probably not be zero-terminated. But the
3426** z[n] character is guaranteed to be something that does not look
3427** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003428*/
drhb7916a72009-05-27 10:31:29 +00003429static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003430 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003431 double value;
drh9339da12010-09-30 00:50:49 +00003432 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003433 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3434 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003435 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003436 }
3437}
drh13573c72010-01-12 17:04:07 +00003438#endif
drh598f1342007-10-23 15:39:45 +00003439
3440
3441/*
drhfec19aa2004-05-19 20:41:03 +00003442** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003443** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003444**
shaneh5f1d6b62010-09-30 16:51:25 +00003445** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003446*/
drh13573c72010-01-12 17:04:07 +00003447static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3448 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003449 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003450 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003451 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003452 if( negFlag ) i = -i;
3453 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003454 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003455 int c;
3456 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003457 const char *z = pExpr->u.zToken;
3458 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003459 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003460 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003461#ifdef SQLITE_OMIT_FLOATING_POINT
3462 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3463#else
drh1b7ddc52014-07-23 14:52:05 +00003464#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003465 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003466 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003467 }else
3468#endif
3469 {
drh9296c182014-07-23 13:40:49 +00003470 codeReal(v, z, negFlag, iMem);
3471 }
drh13573c72010-01-12 17:04:07 +00003472#endif
drh77320ea2016-11-30 14:47:37 +00003473 }else{
drh84d4f1a2017-09-20 10:47:10 +00003474 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003475 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003476 }
drhfec19aa2004-05-19 20:41:03 +00003477 }
3478}
3479
drh5cd79232009-05-25 11:46:29 +00003480
drh1f9ca2c2015-08-25 16:57:52 +00003481/* Generate code that will load into register regOut a value that is
3482** appropriate for the iIdxCol-th column of index pIdx.
3483*/
3484void sqlite3ExprCodeLoadIndexColumn(
3485 Parse *pParse, /* The parsing context */
3486 Index *pIdx, /* The index whose column is to be loaded */
3487 int iTabCur, /* Cursor pointing to a table row */
3488 int iIdxCol, /* The column of the index to be loaded */
3489 int regOut /* Store the index column value in this register */
3490){
3491 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003492 if( iTabCol==XN_EXPR ){
3493 assert( pIdx->aColExpr );
3494 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003495 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003496 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003497 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003498 }else{
drh6df9c4b2019-10-18 12:52:08 +00003499 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003500 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003501 }
drh1f9ca2c2015-08-25 16:57:52 +00003502}
3503
drhe70fa7f2019-10-22 21:01:34 +00003504#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3505/*
3506** Generate code that will compute the value of generated column pCol
3507** and store the result in register regOut
3508*/
3509void sqlite3ExprCodeGeneratedColumn(
3510 Parse *pParse,
3511 Column *pCol,
3512 int regOut
3513){
drh4dad7ed2019-12-16 16:52:22 +00003514 int iAddr;
3515 Vdbe *v = pParse->pVdbe;
3516 assert( v!=0 );
3517 assert( pParse->iSelfTab!=0 );
3518 if( pParse->iSelfTab>0 ){
3519 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3520 }else{
3521 iAddr = 0;
3522 }
drh24e39902020-03-10 13:35:04 +00003523 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003524 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003525 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003526 }
drh4dad7ed2019-12-16 16:52:22 +00003527 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003528}
3529#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3530
drh5cd79232009-05-25 11:46:29 +00003531/*
drh5c092e82010-05-14 19:24:02 +00003532** Generate code to extract the value of the iCol-th column of a table.
3533*/
3534void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003535 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003536 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003537 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003538 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003539 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003540){
drhab45fc02019-10-16 22:01:56 +00003541 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003542 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003543 if( pTab==0 ){
3544 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3545 return;
3546 }
drh5c092e82010-05-14 19:24:02 +00003547 if( iCol<0 || iCol==pTab->iPKey ){
3548 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3549 }else{
drh81f7b372019-10-16 12:18:59 +00003550 int op;
3551 int x;
3552 if( IsVirtual(pTab) ){
3553 op = OP_VColumn;
3554 x = iCol;
3555#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003556 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003557 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003558 if( pCol->colFlags & COLFLAG_BUSY ){
3559 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3560 }else{
3561 int savedSelfTab = pParse->iSelfTab;
3562 pCol->colFlags |= COLFLAG_BUSY;
3563 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003564 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003565 pParse->iSelfTab = savedSelfTab;
3566 pCol->colFlags &= ~COLFLAG_BUSY;
3567 }
drh81f7b372019-10-16 12:18:59 +00003568 return;
3569#endif
3570 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003571 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003572 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003573 op = OP_Column;
3574 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003575 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003576 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003577 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003578 }
3579 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003580 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3581 }
3582}
3583
3584/*
drh945498f2007-02-24 11:52:52 +00003585** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003586** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003587**
3588** There must be an open cursor to pTab in iTable when this routine
3589** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003590*/
drhe55cbd72008-03-31 23:48:03 +00003591int sqlite3ExprCodeGetColumn(
3592 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003593 Table *pTab, /* Description of the table we are reading from */
3594 int iColumn, /* Index of the table column */
3595 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003596 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003597 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003598){
drh81f7b372019-10-16 12:18:59 +00003599 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003600 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003601 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003602 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3603 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003604 }
drhe55cbd72008-03-31 23:48:03 +00003605 return iReg;
3606}
drhe55cbd72008-03-31 23:48:03 +00003607
3608/*
drhb21e7c72008-06-22 12:37:57 +00003609** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003610** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003611*/
drhb21e7c72008-06-22 12:37:57 +00003612void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003613 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003614}
3615
drh652fbf52008-04-01 01:42:41 +00003616/*
drh12abf402016-08-22 14:30:05 +00003617** Convert a scalar expression node to a TK_REGISTER referencing
3618** register iReg. The caller must ensure that iReg already contains
3619** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003620*/
dan069d1b12019-06-16 08:58:14 +00003621static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003622 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003623 p->op2 = p->op;
3624 p->op = TK_REGISTER;
3625 p->iTable = iReg;
3626 ExprClearProperty(p, EP_Skip);
3627}
3628
drh12abf402016-08-22 14:30:05 +00003629/*
3630** Evaluate an expression (either a vector or a scalar expression) and store
3631** the result in continguous temporary registers. Return the index of
3632** the first register used to store the result.
3633**
3634** If the returned result register is a temporary scalar, then also write
3635** that register number into *piFreeable. If the returned result register
3636** is not a temporary or if the expression is a vector set *piFreeable
3637** to 0.
3638*/
3639static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3640 int iResult;
3641 int nResult = sqlite3ExprVectorSize(p);
3642 if( nResult==1 ){
3643 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3644 }else{
3645 *piFreeable = 0;
3646 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003647#if SQLITE_OMIT_SUBQUERY
3648 iResult = 0;
3649#else
drh85bcdce2018-12-23 21:27:29 +00003650 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003651#endif
drh12abf402016-08-22 14:30:05 +00003652 }else{
3653 int i;
3654 iResult = pParse->nMem+1;
3655 pParse->nMem += nResult;
3656 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003657 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003658 }
3659 }
3660 }
3661 return iResult;
3662}
3663
drh25c42962020-01-01 13:55:08 +00003664/*
drh92a27f72020-02-04 01:41:44 +00003665** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3666** so that a subsequent copy will not be merged into this one.
3667*/
3668static void setDoNotMergeFlagOnCopy(Vdbe *v){
3669 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3670 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3671 }
3672}
3673
3674/*
drh25c42962020-01-01 13:55:08 +00003675** Generate code to implement special SQL functions that are implemented
3676** in-line rather than by using the usual callbacks.
3677*/
3678static int exprCodeInlineFunction(
3679 Parse *pParse, /* Parsing context */
3680 ExprList *pFarg, /* List of function arguments */
3681 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3682 int target /* Store function result in this register */
3683){
3684 int nFarg;
3685 Vdbe *v = pParse->pVdbe;
3686 assert( v!=0 );
3687 assert( pFarg!=0 );
3688 nFarg = pFarg->nExpr;
3689 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3690 switch( iFuncId ){
3691 case INLINEFUNC_coalesce: {
3692 /* Attempt a direct implementation of the built-in COALESCE() and
3693 ** IFNULL() functions. This avoids unnecessary evaluation of
3694 ** arguments past the first non-NULL argument.
3695 */
3696 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3697 int i;
3698 assert( nFarg>=2 );
3699 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3700 for(i=1; i<nFarg; i++){
3701 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3702 VdbeCoverage(v);
3703 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3704 }
drh92a27f72020-02-04 01:41:44 +00003705 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003706 sqlite3VdbeResolveLabel(v, endCoalesce);
3707 break;
3708 }
drh3c0e6062020-05-13 18:03:34 +00003709 case INLINEFUNC_iif: {
3710 Expr caseExpr;
3711 memset(&caseExpr, 0, sizeof(caseExpr));
3712 caseExpr.op = TK_CASE;
3713 caseExpr.x.pList = pFarg;
3714 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3715 }
drh25c42962020-01-01 13:55:08 +00003716
drh171c50e2020-01-01 15:43:30 +00003717 default: {
drh25c42962020-01-01 13:55:08 +00003718 /* The UNLIKELY() function is a no-op. The result is the value
3719 ** of the first argument.
3720 */
drh171c50e2020-01-01 15:43:30 +00003721 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003722 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3723 break;
3724 }
3725
drh171c50e2020-01-01 15:43:30 +00003726 /***********************************************************************
3727 ** Test-only SQL functions that are only usable if enabled
3728 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3729 */
3730 case INLINEFUNC_expr_compare: {
3731 /* Compare two expressions using sqlite3ExprCompare() */
3732 assert( nFarg==2 );
3733 sqlite3VdbeAddOp2(v, OP_Integer,
3734 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3735 target);
3736 break;
3737 }
3738
3739 case INLINEFUNC_expr_implies_expr: {
3740 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3741 assert( nFarg==2 );
3742 sqlite3VdbeAddOp2(v, OP_Integer,
3743 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3744 target);
3745 break;
3746 }
3747
3748 case INLINEFUNC_implies_nonnull_row: {
3749 /* REsult of sqlite3ExprImpliesNonNullRow() */
3750 Expr *pA1;
3751 assert( nFarg==2 );
3752 pA1 = pFarg->a[1].pExpr;
3753 if( pA1->op==TK_COLUMN ){
3754 sqlite3VdbeAddOp2(v, OP_Integer,
3755 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3756 target);
3757 }else{
3758 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3759 }
3760 break;
3761 }
3762
drh25c42962020-01-01 13:55:08 +00003763#ifdef SQLITE_DEBUG
3764 case INLINEFUNC_affinity: {
3765 /* The AFFINITY() function evaluates to a string that describes
3766 ** the type affinity of the argument. This is used for testing of
3767 ** the SQLite type logic.
3768 */
3769 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3770 char aff;
3771 assert( nFarg==1 );
3772 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3773 sqlite3VdbeLoadString(v, target,
3774 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3775 break;
3776 }
3777#endif
3778 }
3779 return target;
3780}
3781
dan71c57db2016-07-09 20:23:55 +00003782
drha4c3c872013-09-12 17:29:25 +00003783/*
drhcce7d172000-05-31 15:34:51 +00003784** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003785** expression. Attempt to store the results in register "target".
3786** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003787**
drh8b213892008-08-29 02:14:02 +00003788** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003789** be stored in target. The result might be stored in some other
3790** register if it is convenient to do so. The calling function
3791** must check the return code and move the results to the desired
3792** register.
drhcce7d172000-05-31 15:34:51 +00003793*/
drh678ccce2008-03-31 18:19:54 +00003794int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003795 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3796 int op; /* The opcode being coded */
3797 int inReg = target; /* Results stored in register inReg */
3798 int regFree1 = 0; /* If non-zero free this temporary register */
3799 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003800 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003801 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003802 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003803
drh9cbf3422008-01-17 16:22:13 +00003804 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003805 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003806
drh1efa8022018-04-28 04:16:43 +00003807expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003808 if( pExpr==0 ){
3809 op = TK_NULL;
3810 }else{
drhe7375bf2020-03-10 19:24:38 +00003811 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003812 op = pExpr->op;
3813 }
drhf2bc0132004-10-04 13:19:23 +00003814 switch( op ){
drh13449892005-09-07 21:22:45 +00003815 case TK_AGG_COLUMN: {
3816 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003817 struct AggInfo_col *pCol;
3818 assert( pAggInfo!=0 );
3819 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3820 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003821 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003822 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003823 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003824 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003825 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003826 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003827 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003828 if( pCol->iColumn<0 ){
3829 VdbeComment((v,"%s.rowid",pTab->zName));
3830 }else{
3831 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3832 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3833 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3834 }
drh0c76e892020-03-10 11:50:43 +00003835 }
drhc332cc32016-09-19 10:24:19 +00003836 return target;
drh13449892005-09-07 21:22:45 +00003837 }
3838 /* Otherwise, fall thru into the TK_COLUMN case */
3839 }
drh967e8b72000-06-21 13:59:10 +00003840 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003841 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003842 int iReg;
drhefad2e22018-07-27 16:57:11 +00003843 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003844 /* This COLUMN expression is really a constant due to WHERE clause
3845 ** constraints, and that constant is coded by the pExpr->pLeft
3846 ** expresssion. However, make sure the constant has the correct
3847 ** datatype by applying the Affinity of the table column to the
3848 ** constant.
3849 */
drh57f7ece2019-11-21 18:28:44 +00003850 int aff;
drh67b9ba12019-12-20 20:45:02 +00003851 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003852 if( pExpr->y.pTab ){
3853 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3854 }else{
3855 aff = pExpr->affExpr;
3856 }
drh96fb16e2019-08-06 14:37:24 +00003857 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003858 static const char zAff[] = "B\000C\000D\000E";
3859 assert( SQLITE_AFF_BLOB=='A' );
3860 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003861 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3862 &zAff[(aff-'B')*2], P4_STATIC);
3863 }
3864 return iReg;
drhefad2e22018-07-27 16:57:11 +00003865 }
drhb2b9d3d2013-08-01 01:14:43 +00003866 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003867 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003868 /* Other columns in the same row for CHECK constraints or
3869 ** generated columns or for inserting into partial index.
3870 ** The row is unpacked into registers beginning at
3871 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3872 ** immediately prior to the first column.
3873 */
3874 Column *pCol;
3875 Table *pTab = pExpr->y.pTab;
3876 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003877 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003878 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003879 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003880 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003881 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003882 return -1-pParse->iSelfTab;
3883 }
drhc5f808d2019-10-19 15:01:52 +00003884 pCol = pTab->aCol + iCol;
3885 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3886 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003887#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3888 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003889 if( pCol->colFlags & COLFLAG_BUSY ){
3890 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3891 pCol->zName);
3892 return 0;
3893 }
3894 pCol->colFlags |= COLFLAG_BUSY;
3895 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3896 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3897 }
3898 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003899 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003900 }else
3901#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3902 if( pCol->affinity==SQLITE_AFF_REAL ){
3903 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003904 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3905 return target;
3906 }else{
drh9942ef02019-10-18 02:19:18 +00003907 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003908 }
drhb2b9d3d2013-08-01 01:14:43 +00003909 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003910 /* Coding an expression that is part of an index where column names
3911 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003912 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003913 }
drh22827922000-06-06 17:27:05 +00003914 }
drh67b9ba12019-12-20 20:45:02 +00003915 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003916 pExpr->iColumn, iTab, target,
3917 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003918 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3919 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3920 }
3921 return iReg;
drhcce7d172000-05-31 15:34:51 +00003922 }
3923 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003924 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003925 return target;
drhfec19aa2004-05-19 20:41:03 +00003926 }
drh8abed7b2018-02-26 18:49:05 +00003927 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003928 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003929 return target;
3930 }
drh13573c72010-01-12 17:04:07 +00003931#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003932 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003933 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3934 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003935 return target;
drh598f1342007-10-23 15:39:45 +00003936 }
drh13573c72010-01-12 17:04:07 +00003937#endif
drhfec19aa2004-05-19 20:41:03 +00003938 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003939 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003940 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003941 return target;
drhcce7d172000-05-31 15:34:51 +00003942 }
drhaac30f92019-12-14 15:01:55 +00003943 default: {
drhc29af652019-12-18 21:22:40 +00003944 /* Make NULL the default case so that if a bug causes an illegal
3945 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003946 ** sanely and not crash. But keep the assert() to bring the problem
3947 ** to the attention of the developers. */
3948 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003949 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003950 return target;
drhf0863fe2005-06-12 21:35:51 +00003951 }
danielk19775338a5f2005-01-20 13:03:10 +00003952#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003953 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003954 int n;
3955 const char *z;
drhca48c902008-01-18 14:08:24 +00003956 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003957 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3958 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3959 assert( pExpr->u.zToken[1]=='\'' );
3960 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003961 n = sqlite3Strlen30(z) - 1;
3962 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003963 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3964 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003965 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003966 }
danielk19775338a5f2005-01-20 13:03:10 +00003967#endif
drh50457892003-09-06 01:10:47 +00003968 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003969 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3970 assert( pExpr->u.zToken!=0 );
3971 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003972 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3973 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003974 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003975 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003976 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003977 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003978 }
drhc332cc32016-09-19 10:24:19 +00003979 return target;
drh50457892003-09-06 01:10:47 +00003980 }
drh4e0cff62004-11-05 05:10:28 +00003981 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003982 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003983 }
drh487e2622005-06-25 18:42:14 +00003984#ifndef SQLITE_OMIT_CAST
3985 case TK_CAST: {
3986 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003987 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003988 if( inReg!=target ){
3989 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3990 inReg = target;
3991 }
drh4169e432014-08-25 20:11:52 +00003992 sqlite3VdbeAddOp2(v, OP_Cast, target,
3993 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003994 return inReg;
drh487e2622005-06-25 18:42:14 +00003995 }
3996#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003997 case TK_IS:
3998 case TK_ISNOT:
3999 op = (op==TK_IS) ? TK_EQ : TK_NE;
4000 p5 = SQLITE_NULLEQ;
4001 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004002 case TK_LT:
4003 case TK_LE:
4004 case TK_GT:
4005 case TK_GE:
4006 case TK_NE:
4007 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004008 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004009 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004010 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004011 }else{
4012 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4013 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4014 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004015 r1, r2, inReg, SQLITE_STOREP2 | p5,
4016 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004017 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4018 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4019 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4020 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4021 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4022 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4023 testcase( regFree1==0 );
4024 testcase( regFree2==0 );
4025 }
drh6a2fe092009-09-23 02:29:36 +00004026 break;
4027 }
drhcce7d172000-05-31 15:34:51 +00004028 case TK_AND:
4029 case TK_OR:
4030 case TK_PLUS:
4031 case TK_STAR:
4032 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004033 case TK_REM:
4034 case TK_BITAND:
4035 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004036 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004037 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004038 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004039 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004040 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4041 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4042 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4043 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4044 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4045 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4046 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4047 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4048 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4049 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4050 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004051 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4052 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004053 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004054 testcase( regFree1==0 );
4055 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004056 break;
4057 }
drhcce7d172000-05-31 15:34:51 +00004058 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004059 Expr *pLeft = pExpr->pLeft;
4060 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004061 if( pLeft->op==TK_INTEGER ){
4062 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004063 return target;
drh13573c72010-01-12 17:04:07 +00004064#ifndef SQLITE_OMIT_FLOATING_POINT
4065 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004066 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4067 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004068 return target;
drh13573c72010-01-12 17:04:07 +00004069#endif
drh3c84ddf2008-01-09 02:15:38 +00004070 }else{
drh10d1edf2013-11-15 15:52:39 +00004071 tempX.op = TK_INTEGER;
4072 tempX.flags = EP_IntValue|EP_TokenOnly;
4073 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004074 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004075 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004076 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004077 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004078 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004079 }
drh3c84ddf2008-01-09 02:15:38 +00004080 break;
drh6e142f52000-06-08 13:36:40 +00004081 }
drhbf4133c2001-10-13 02:59:08 +00004082 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004083 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004084 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4085 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004086 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4087 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004088 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004089 break;
4090 }
drh8abed7b2018-02-26 18:49:05 +00004091 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004092 int isTrue; /* IS TRUE or IS NOT TRUE */
4093 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004094 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4095 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004096 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4097 bNormal = pExpr->op2==TK_IS;
4098 testcase( isTrue && bNormal);
4099 testcase( !isTrue && bNormal);
4100 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004101 break;
4102 }
drhcce7d172000-05-31 15:34:51 +00004103 case TK_ISNULL:
4104 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004105 int addr;
drh7d176102014-02-18 03:07:12 +00004106 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4107 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004108 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004109 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004110 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004111 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004112 VdbeCoverageIf(v, op==TK_ISNULL);
4113 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004114 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004115 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004116 break;
drhcce7d172000-05-31 15:34:51 +00004117 }
drh22827922000-06-06 17:27:05 +00004118 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004119 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004120 if( pInfo==0
4121 || NEVER(pExpr->iAgg<0)
4122 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4123 ){
drh33e619f2009-05-28 01:00:55 +00004124 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4125 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004126 }else{
drhc332cc32016-09-19 10:24:19 +00004127 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004128 }
drh22827922000-06-06 17:27:05 +00004129 break;
4130 }
drhcce7d172000-05-31 15:34:51 +00004131 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004132 ExprList *pFarg; /* List of function arguments */
4133 int nFarg; /* Number of function arguments */
4134 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004135 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004136 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004137 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004138 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004139 u8 enc = ENC(db); /* The text encoding used by this database */
4140 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004141
dan67a9b8e2018-06-22 20:51:35 +00004142#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004143 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4144 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004145 }
dan67a9b8e2018-06-22 20:51:35 +00004146#endif
dan86fb6e12018-05-16 20:58:07 +00004147
drh1e9b53f2017-01-04 01:07:24 +00004148 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004149 /* SQL functions can be expensive. So try to avoid running them
4150 ** multiple times if we know they always give the same result */
4151 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004152 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004153 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004154 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4155 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004156 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004157 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4158 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004159 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004160#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4161 if( pDef==0 && pParse->explain ){
4162 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4163 }
4164#endif
danb6e9f7a2018-05-19 14:15:29 +00004165 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004166 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004167 break;
4168 }
drh25c42962020-01-01 13:55:08 +00004169 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004170 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4171 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004172 return exprCodeInlineFunction(pParse, pFarg,
4173 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004174 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4175 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004176 }
4177
drhd1a01ed2013-11-21 16:08:52 +00004178 for(i=0; i<nFarg; i++){
4179 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004180 testcase( i==31 );
4181 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004182 }
4183 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4184 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4185 }
4186 }
drh12ffee82009-04-08 13:51:51 +00004187 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004188 if( constMask ){
4189 r1 = pParse->nMem+1;
4190 pParse->nMem += nFarg;
4191 }else{
4192 r1 = sqlite3GetTempRange(pParse, nFarg);
4193 }
drha748fdc2012-03-28 01:34:47 +00004194
4195 /* For length() and typeof() functions with a column argument,
4196 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4197 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4198 ** loading.
4199 */
drhd36e1042013-09-06 13:10:12 +00004200 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004201 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004202 assert( nFarg==1 );
4203 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004204 exprOp = pFarg->a[0].pExpr->op;
4205 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004206 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4207 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004208 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4209 pFarg->a[0].pExpr->op2 =
4210 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004211 }
4212 }
4213
drh5579d592015-08-26 14:01:41 +00004214 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004215 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004216 }else{
drh12ffee82009-04-08 13:51:51 +00004217 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004218 }
drhb7f6f682006-07-08 17:06:43 +00004219#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004220 /* Possibly overload the function if the first argument is
4221 ** a virtual table column.
4222 **
4223 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4224 ** second argument, not the first, as the argument to test to
4225 ** see if it is a column in a virtual table. This is done because
4226 ** the left operand of infix functions (the operand we want to
4227 ** control overloading) ends up as the second argument to the
4228 ** function. The expression "A glob B" is equivalent to
4229 ** "glob(B,A). We want to use the A in "A glob B" to test
4230 ** for function overloading. But we use the B term in "glob(B,A)".
4231 */
drh59155062018-05-26 18:03:48 +00004232 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004233 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4234 }else if( nFarg>0 ){
4235 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004236 }
4237#endif
drhd36e1042013-09-06 13:10:12 +00004238 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004239 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004240 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004241 }
drh092457b2017-12-29 15:04:49 +00004242#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4243 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004244 Expr *pArg = pFarg->a[0].pExpr;
4245 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004246 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004247 }else{
4248 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4249 }
drh092457b2017-12-29 15:04:49 +00004250 }else
4251#endif
4252 {
drh920cf592019-10-30 16:29:02 +00004253 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004254 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004255 }
drh13d79502019-12-23 02:18:49 +00004256 if( nFarg ){
4257 if( constMask==0 ){
4258 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4259 }else{
drh3aef2fb2020-01-02 17:46:02 +00004260 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004261 }
drh2dcef112008-01-12 19:03:48 +00004262 }
drhc332cc32016-09-19 10:24:19 +00004263 return target;
drhcce7d172000-05-31 15:34:51 +00004264 }
drhfe2093d2005-01-20 22:48:47 +00004265#ifndef SQLITE_OMIT_SUBQUERY
4266 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004267 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004268 int nCol;
drhc5499be2008-04-01 15:06:33 +00004269 testcase( op==TK_EXISTS );
4270 testcase( op==TK_SELECT );
dan8da209b2016-07-26 18:06:08 +00004271 if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
4272 sqlite3SubselectError(pParse, nCol, 1);
4273 }else{
drh85bcdce2018-12-23 21:27:29 +00004274 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004275 }
drh19a775c2000-06-05 18:54:46 +00004276 break;
4277 }
drhfc7f27b2016-08-20 00:07:01 +00004278 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004279 int n;
drhfc7f27b2016-08-20 00:07:01 +00004280 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004281 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004282 }
drh966e2912017-01-03 02:58:01 +00004283 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004284 if( pExpr->iTable!=0
4285 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004286 ){
4287 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4288 pExpr->iTable, n);
4289 }
drhc332cc32016-09-19 10:24:19 +00004290 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004291 }
drhfef52082000-06-06 01:50:43 +00004292 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004293 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4294 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004295 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4296 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4297 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4298 sqlite3VdbeResolveLabel(v, destIfFalse);
4299 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4300 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004301 return target;
drhfef52082000-06-06 01:50:43 +00004302 }
drhe3365e62009-11-12 17:52:24 +00004303#endif /* SQLITE_OMIT_SUBQUERY */
4304
4305
drh2dcef112008-01-12 19:03:48 +00004306 /*
4307 ** x BETWEEN y AND z
4308 **
4309 ** This is equivalent to
4310 **
4311 ** x>=y AND x<=z
4312 **
4313 ** X is stored in pExpr->pLeft.
4314 ** Y is stored in pExpr->pList->a[0].pExpr.
4315 ** Z is stored in pExpr->pList->a[1].pExpr.
4316 */
drhfef52082000-06-06 01:50:43 +00004317 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004318 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004319 return target;
drhfef52082000-06-06 01:50:43 +00004320 }
drh94fa9c42016-02-27 21:16:04 +00004321 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004322 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004323 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004324 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004325 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004326 }
drh2dcef112008-01-12 19:03:48 +00004327
dan165921a2009-08-28 18:53:45 +00004328 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004329 /* If the opcode is TK_TRIGGER, then the expression is a reference
4330 ** to a column in the new.* or old.* pseudo-tables available to
4331 ** trigger programs. In this case Expr.iTable is set to 1 for the
4332 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4333 ** is set to the column of the pseudo-table to read, or to -1 to
4334 ** read the rowid field.
4335 **
4336 ** The expression is implemented using an OP_Param opcode. The p1
4337 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4338 ** to reference another column of the old.* pseudo-table, where
4339 ** i is the index of the column. For a new.rowid reference, p1 is
4340 ** set to (n+1), where n is the number of columns in each pseudo-table.
4341 ** For a reference to any other column in the new.* pseudo-table, p1
4342 ** is set to (n+2+i), where n and i are as defined previously. For
4343 ** example, if the table on which triggers are being fired is
4344 ** declared as:
4345 **
4346 ** CREATE TABLE t1(a, b);
4347 **
4348 ** Then p1 is interpreted as follows:
4349 **
4350 ** p1==0 -> old.rowid p1==3 -> new.rowid
4351 ** p1==1 -> old.a p1==4 -> new.a
4352 ** p1==2 -> old.b p1==5 -> new.b
4353 */
drheda079c2018-09-20 19:02:15 +00004354 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004355 int iCol = pExpr->iColumn;
4356 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004357 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004358
4359 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004360 assert( iCol>=-1 && iCol<pTab->nCol );
4361 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004362 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4363
4364 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004365 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004366 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004367 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004368 ));
dan65a7cd12009-09-01 12:16:01 +00004369
drh44dbca82010-01-13 04:22:20 +00004370#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004371 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004372 ** integer. Use OP_RealAffinity to make sure it is really real.
4373 **
4374 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4375 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004376 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004377 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4378 }
drh44dbca82010-01-13 04:22:20 +00004379#endif
dan165921a2009-08-28 18:53:45 +00004380 break;
4381 }
4382
dan71c57db2016-07-09 20:23:55 +00004383 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004384 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004385 break;
4386 }
4387
drh9e9a67a2019-08-17 17:07:15 +00004388 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4389 ** that derive from the right-hand table of a LEFT JOIN. The
4390 ** Expr.iTable value is the table number for the right-hand table.
4391 ** The expression is only evaluated if that table is not currently
4392 ** on a LEFT JOIN NULL row.
4393 */
drh31d6fd52017-04-14 19:03:10 +00004394 case TK_IF_NULL_ROW: {
4395 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004396 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004397 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004398 /* Temporarily disable factoring of constant expressions, since
4399 ** even though expressions may appear to be constant, they are not
4400 ** really constant because they originate from the right-hand side
4401 ** of a LEFT JOIN. */
4402 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004403 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004404 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004405 sqlite3VdbeJumpHere(v, addrINR);
4406 sqlite3VdbeChangeP3(v, addrINR, inReg);
4407 break;
4408 }
4409
drh2dcef112008-01-12 19:03:48 +00004410 /*
4411 ** Form A:
4412 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4413 **
4414 ** Form B:
4415 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4416 **
4417 ** Form A is can be transformed into the equivalent form B as follows:
4418 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4419 ** WHEN x=eN THEN rN ELSE y END
4420 **
4421 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004422 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4423 ** odd. The Y is also optional. If the number of elements in x.pList
4424 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004425 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4426 **
4427 ** The result of the expression is the Ri for the first matching Ei,
4428 ** or if there is no matching Ei, the ELSE term Y, or if there is
4429 ** no ELSE term, NULL.
4430 */
drhaac30f92019-12-14 15:01:55 +00004431 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004432 int endLabel; /* GOTO label for end of CASE stmt */
4433 int nextCase; /* GOTO label for next WHEN clause */
4434 int nExpr; /* 2x number of WHEN terms */
4435 int i; /* Loop counter */
4436 ExprList *pEList; /* List of WHEN terms */
4437 struct ExprList_item *aListelem; /* Array of WHEN terms */
4438 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004439 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004440 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004441 Expr *pDel = 0;
4442 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004443
danielk19776ab3a2e2009-02-19 14:39:25 +00004444 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004445 assert(pExpr->x.pList->nExpr > 0);
4446 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004447 aListelem = pEList->a;
4448 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004449 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004450 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004451 pDel = sqlite3ExprDup(db, pX, 0);
4452 if( db->mallocFailed ){
4453 sqlite3ExprDelete(db, pDel);
4454 break;
4455 }
drh33cd4902009-05-30 20:49:20 +00004456 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004457 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004458 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004459 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004460 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004461 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004462 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004463 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4464 ** The value in regFree1 might get SCopy-ed into the file result.
4465 ** So make sure that the regFree1 register is not reused for other
4466 ** purposes and possibly overwritten. */
4467 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004468 }
drhc5cd1242013-09-12 16:50:49 +00004469 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004470 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004471 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004472 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004473 }else{
drh2dcef112008-01-12 19:03:48 +00004474 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004475 }
drhec4ccdb2018-12-29 02:26:59 +00004476 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004477 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004478 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004479 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004480 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004481 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004482 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004483 }
drhc5cd1242013-09-12 16:50:49 +00004484 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004485 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004486 }else{
drh9de221d2008-01-05 06:51:30 +00004487 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004488 }
dan8b65e592019-07-17 14:34:17 +00004489 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004490 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004491 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004492 break;
4493 }
danielk19775338a5f2005-01-20 13:03:10 +00004494#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004495 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004496 assert( pExpr->affExpr==OE_Rollback
4497 || pExpr->affExpr==OE_Abort
4498 || pExpr->affExpr==OE_Fail
4499 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004500 );
drh9e5fdc42020-05-08 19:02:21 +00004501 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004502 sqlite3ErrorMsg(pParse,
4503 "RAISE() may only be used within a trigger-program");
4504 return 0;
4505 }
drh11949042019-08-05 18:01:42 +00004506 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004507 sqlite3MayAbort(pParse);
4508 }
dan165921a2009-08-28 18:53:45 +00004509 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004510 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004511 sqlite3VdbeAddOp4(
4512 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004513 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004514 }else{
drh9e5fdc42020-05-08 19:02:21 +00004515 sqlite3HaltConstraint(pParse,
4516 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4517 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004518 }
4519
drhffe07b22005-11-03 00:41:17 +00004520 break;
drh17a7f8d2002-03-24 13:13:27 +00004521 }
danielk19775338a5f2005-01-20 13:03:10 +00004522#endif
drhffe07b22005-11-03 00:41:17 +00004523 }
drh2dcef112008-01-12 19:03:48 +00004524 sqlite3ReleaseTempReg(pParse, regFree1);
4525 sqlite3ReleaseTempReg(pParse, regFree2);
4526 return inReg;
4527}
4528
4529/*
drh9b258c52020-03-11 19:41:49 +00004530** Generate code that will evaluate expression pExpr just one time
4531** per prepared statement execution.
4532**
4533** If the expression uses functions (that might throw an exception) then
4534** guard them with an OP_Once opcode to ensure that the code is only executed
4535** once. If no functions are involved, then factor the code out and put it at
4536** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004537**
drhad879ff2017-01-04 04:10:02 +00004538** If regDest>=0 then the result is always stored in that register and the
4539** result is not reusable. If regDest<0 then this routine is free to
4540** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004541** is stored is returned. When regDest<0, two identical expressions might
4542** code to the same register, if they do not contain function calls and hence
4543** are factored out into the initialization section at the end of the
4544** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004545*/
drh9b258c52020-03-11 19:41:49 +00004546int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004547 Parse *pParse, /* Parsing context */
4548 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004549 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004550){
drhd1a01ed2013-11-21 16:08:52 +00004551 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004552 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004553 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004554 if( regDest<0 && p ){
4555 struct ExprList_item *pItem;
4556 int i;
4557 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004558 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004559 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004560 }
4561 }
drh1e9b53f2017-01-04 01:07:24 +00004562 }
drhd1a01ed2013-11-21 16:08:52 +00004563 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004564 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4565 Vdbe *v = pParse->pVdbe;
4566 int addr;
4567 assert( v );
4568 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4569 pParse->okConstFactor = 0;
4570 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004571 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004572 sqlite3ExprCode(pParse, pExpr, regDest);
4573 }
4574 pParse->okConstFactor = 1;
4575 sqlite3ExprDelete(pParse->db, pExpr);
4576 sqlite3VdbeJumpHere(v, addr);
4577 }else{
4578 p = sqlite3ExprListAppend(pParse, p, pExpr);
4579 if( p ){
4580 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4581 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004582 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004583 pItem->u.iConstExprReg = regDest;
4584 }
4585 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004586 }
drh1e9b53f2017-01-04 01:07:24 +00004587 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004588}
4589
4590/*
drh2dcef112008-01-12 19:03:48 +00004591** Generate code to evaluate an expression and store the results
4592** into a register. Return the register number where the results
4593** are stored.
4594**
4595** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004596** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004597** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004598**
4599** If pExpr is a constant, then this routine might generate this
4600** code to fill the register in the initialization section of the
4601** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004602*/
4603int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004604 int r2;
drh0d950af2019-08-22 16:38:42 +00004605 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004606 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004607 && pExpr->op!=TK_REGISTER
4608 && sqlite3ExprIsConstantNotJoin(pExpr)
4609 ){
drhf30a9692013-11-15 01:10:18 +00004610 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004611 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004612 }else{
drhf30a9692013-11-15 01:10:18 +00004613 int r1 = sqlite3GetTempReg(pParse);
4614 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4615 if( r2==r1 ){
4616 *pReg = r1;
4617 }else{
4618 sqlite3ReleaseTempReg(pParse, r1);
4619 *pReg = 0;
4620 }
drh2dcef112008-01-12 19:03:48 +00004621 }
4622 return r2;
4623}
4624
4625/*
4626** Generate code that will evaluate expression pExpr and store the
4627** results in register target. The results are guaranteed to appear
4628** in register target.
4629*/
drh05a86c52014-02-16 01:55:49 +00004630void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004631 int inReg;
4632
drhe7375bf2020-03-10 19:24:38 +00004633 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004634 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004635 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004636 if( pParse->pVdbe==0 ) return;
4637 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4638 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004639 u8 op;
4640 if( ExprHasProperty(pExpr,EP_Subquery) ){
4641 op = OP_Copy;
4642 }else{
4643 op = OP_SCopy;
4644 }
4645 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004646 }
drhcce7d172000-05-31 15:34:51 +00004647}
4648
4649/*
drh1c75c9d2015-12-21 15:22:13 +00004650** Make a transient copy of expression pExpr and then code it using
4651** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4652** except that the input expression is guaranteed to be unchanged.
4653*/
4654void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4655 sqlite3 *db = pParse->db;
4656 pExpr = sqlite3ExprDup(db, pExpr, 0);
4657 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4658 sqlite3ExprDelete(db, pExpr);
4659}
4660
4661/*
drh05a86c52014-02-16 01:55:49 +00004662** Generate code that will evaluate expression pExpr and store the
4663** results in register target. The results are guaranteed to appear
4664** in register target. If the expression is constant, then this routine
4665** might choose to code the expression at initialization time.
4666*/
4667void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004668 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004669 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004670 }else{
drh088489e2020-03-10 02:57:37 +00004671 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004672 }
drhcce7d172000-05-31 15:34:51 +00004673}
4674
4675/*
drh268380c2004-02-25 13:47:31 +00004676** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004677** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004678**
drh3df6c3b2017-09-15 15:38:01 +00004679** Return the number of elements evaluated. The number returned will
4680** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4681** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004682**
4683** The SQLITE_ECEL_DUP flag prevents the arguments from being
4684** filled using OP_SCopy. OP_Copy must be used instead.
4685**
4686** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4687** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004688**
4689** The SQLITE_ECEL_REF flag means that expressions in the list with
4690** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4691** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004692** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4693** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004694*/
danielk19774adee202004-05-08 08:23:19 +00004695int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004696 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004697 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004698 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004699 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004700 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004701){
4702 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004703 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004704 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004705 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004706 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004707 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004708 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004709 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004710 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004711 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004712 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004713#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4714 if( pItem->bSorterRef ){
4715 i--;
4716 n--;
4717 }else
4718#endif
dan257c13f2016-11-10 20:14:06 +00004719 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4720 if( flags & SQLITE_ECEL_OMITREF ){
4721 i--;
4722 n--;
4723 }else{
4724 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4725 }
drhb8b06692018-08-04 15:16:20 +00004726 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4727 && sqlite3ExprIsConstantNotJoin(pExpr)
4728 ){
drh9b258c52020-03-11 19:41:49 +00004729 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004730 }else{
4731 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4732 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004733 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004734 if( copyOp==OP_Copy
4735 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4736 && pOp->p1+pOp->p3+1==inReg
4737 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004738 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004739 ){
4740 pOp->p3++;
4741 }else{
4742 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4743 }
drhd1a01ed2013-11-21 16:08:52 +00004744 }
drhd1766112008-09-17 00:13:12 +00004745 }
drh268380c2004-02-25 13:47:31 +00004746 }
drhf9b596e2004-05-26 16:54:42 +00004747 return n;
drh268380c2004-02-25 13:47:31 +00004748}
4749
4750/*
drh36c563a2009-11-12 13:32:22 +00004751** Generate code for a BETWEEN operator.
4752**
4753** x BETWEEN y AND z
4754**
4755** The above is equivalent to
4756**
4757** x>=y AND x<=z
4758**
4759** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004760** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004761**
4762** The xJumpIf parameter determines details:
4763**
4764** NULL: Store the boolean result in reg[dest]
4765** sqlite3ExprIfTrue: Jump to dest if true
4766** sqlite3ExprIfFalse: Jump to dest if false
4767**
4768** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004769*/
4770static void exprCodeBetween(
4771 Parse *pParse, /* Parsing and code generating context */
4772 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004773 int dest, /* Jump destination or storage location */
4774 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004775 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4776){
dan8b65e592019-07-17 14:34:17 +00004777 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004778 Expr compLeft; /* The x>=y term */
4779 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004780 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004781 Expr *pDel = 0;
4782 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004783
dan71c57db2016-07-09 20:23:55 +00004784 memset(&compLeft, 0, sizeof(Expr));
4785 memset(&compRight, 0, sizeof(Expr));
4786 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004787
4788 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004789 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4790 if( db->mallocFailed==0 ){
4791 exprAnd.op = TK_AND;
4792 exprAnd.pLeft = &compLeft;
4793 exprAnd.pRight = &compRight;
4794 compLeft.op = TK_GE;
4795 compLeft.pLeft = pDel;
4796 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4797 compRight.op = TK_LE;
4798 compRight.pLeft = pDel;
4799 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4800 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4801 if( xJump ){
4802 xJump(pParse, &exprAnd, dest, jumpIfNull);
4803 }else{
4804 /* Mark the expression is being from the ON or USING clause of a join
4805 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4806 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4807 ** for clarity, but we are out of bits in the Expr.flags field so we
4808 ** have to reuse the EP_FromJoin bit. Bummer. */
4809 pDel->flags |= EP_FromJoin;
4810 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4811 }
4812 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004813 }
dan8b65e592019-07-17 14:34:17 +00004814 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004815
4816 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004817 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4818 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4819 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4820 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4821 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4822 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4823 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4824 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004825 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004826}
4827
4828/*
drhcce7d172000-05-31 15:34:51 +00004829** Generate code for a boolean expression such that a jump is made
4830** to the label "dest" if the expression is true but execution
4831** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004832**
4833** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004834** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004835**
4836** This code depends on the fact that certain token values (ex: TK_EQ)
4837** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4838** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4839** the make process cause these values to align. Assert()s in the code
4840** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004841*/
danielk19774adee202004-05-08 08:23:19 +00004842void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004843 Vdbe *v = pParse->pVdbe;
4844 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004845 int regFree1 = 0;
4846 int regFree2 = 0;
4847 int r1, r2;
4848
drh35573352008-01-08 23:54:25 +00004849 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004850 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004851 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004852 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004853 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004854 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004855 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004856 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004857 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4858 if( pAlt!=pExpr ){
4859 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4860 }else if( op==TK_AND ){
4861 int d2 = sqlite3VdbeMakeLabel(pParse);
4862 testcase( jumpIfNull==0 );
4863 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4864 jumpIfNull^SQLITE_JUMPIFNULL);
4865 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4866 sqlite3VdbeResolveLabel(v, d2);
4867 }else{
4868 testcase( jumpIfNull==0 );
4869 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4870 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4871 }
drhcce7d172000-05-31 15:34:51 +00004872 break;
4873 }
4874 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004875 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004876 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004877 break;
4878 }
drh8abed7b2018-02-26 18:49:05 +00004879 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004880 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4881 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004882 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004883 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004884 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004885 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004886 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004887 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004888 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4889 isNot ? SQLITE_JUMPIFNULL : 0);
4890 }else{
4891 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4892 isNot ? SQLITE_JUMPIFNULL : 0);
4893 }
drh007c8432018-02-26 03:20:18 +00004894 break;
4895 }
drhde845c22016-03-17 19:07:52 +00004896 case TK_IS:
4897 case TK_ISNOT:
4898 testcase( op==TK_IS );
4899 testcase( op==TK_ISNOT );
4900 op = (op==TK_IS) ? TK_EQ : TK_NE;
4901 jumpIfNull = SQLITE_NULLEQ;
4902 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00004903 case TK_LT:
4904 case TK_LE:
4905 case TK_GT:
4906 case TK_GE:
4907 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004908 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004909 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004910 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004911 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4912 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004913 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004914 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004915 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4916 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4917 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4918 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004919 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4920 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4921 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4922 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4923 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4924 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004925 testcase( regFree1==0 );
4926 testcase( regFree2==0 );
4927 break;
4928 }
drhcce7d172000-05-31 15:34:51 +00004929 case TK_ISNULL:
4930 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004931 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4932 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004933 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4934 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004935 VdbeCoverageIf(v, op==TK_ISNULL);
4936 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004937 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004938 break;
4939 }
drhfef52082000-06-06 01:50:43 +00004940 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004941 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004942 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004943 break;
4944 }
drh84e30ca2011-02-10 17:46:14 +00004945#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004946 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004947 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004948 int destIfNull = jumpIfNull ? dest : destIfFalse;
4949 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004950 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004951 sqlite3VdbeResolveLabel(v, destIfFalse);
4952 break;
4953 }
shanehbb201342011-02-09 19:55:20 +00004954#endif
drhcce7d172000-05-31 15:34:51 +00004955 default: {
dan7b35a772016-07-28 19:47:15 +00004956 default_expr:
drhad317272019-04-19 16:21:51 +00004957 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004958 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004959 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004960 /* No-op */
4961 }else{
4962 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4963 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004964 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004965 testcase( regFree1==0 );
4966 testcase( jumpIfNull==0 );
4967 }
drhcce7d172000-05-31 15:34:51 +00004968 break;
4969 }
4970 }
drh2dcef112008-01-12 19:03:48 +00004971 sqlite3ReleaseTempReg(pParse, regFree1);
4972 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004973}
4974
4975/*
drh66b89c82000-11-28 20:47:17 +00004976** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004977** to the label "dest" if the expression is false but execution
4978** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004979**
4980** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004981** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4982** is 0.
drhcce7d172000-05-31 15:34:51 +00004983*/
danielk19774adee202004-05-08 08:23:19 +00004984void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004985 Vdbe *v = pParse->pVdbe;
4986 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004987 int regFree1 = 0;
4988 int regFree2 = 0;
4989 int r1, r2;
4990
drh35573352008-01-08 23:54:25 +00004991 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004992 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004993 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00004994 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004995
4996 /* The value of pExpr->op and op are related as follows:
4997 **
4998 ** pExpr->op op
4999 ** --------- ----------
5000 ** TK_ISNULL OP_NotNull
5001 ** TK_NOTNULL OP_IsNull
5002 ** TK_NE OP_Eq
5003 ** TK_EQ OP_Ne
5004 ** TK_GT OP_Le
5005 ** TK_LE OP_Gt
5006 ** TK_GE OP_Lt
5007 ** TK_LT OP_Ge
5008 **
5009 ** For other values of pExpr->op, op is undefined and unused.
5010 ** The value of TK_ and OP_ constants are arranged such that we
5011 ** can compute the mapping above using the following expression.
5012 ** Assert()s verify that the computation is correct.
5013 */
5014 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5015
5016 /* Verify correct alignment of TK_ and OP_ constants
5017 */
5018 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5019 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5020 assert( pExpr->op!=TK_NE || op==OP_Eq );
5021 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5022 assert( pExpr->op!=TK_LT || op==OP_Ge );
5023 assert( pExpr->op!=TK_LE || op==OP_Gt );
5024 assert( pExpr->op!=TK_GT || op==OP_Le );
5025 assert( pExpr->op!=TK_GE || op==OP_Lt );
5026
danba00e302016-07-23 20:24:06 +00005027 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005028 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005029 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005030 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5031 if( pAlt!=pExpr ){
5032 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5033 }else if( pExpr->op==TK_AND ){
5034 testcase( jumpIfNull==0 );
5035 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5036 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5037 }else{
5038 int d2 = sqlite3VdbeMakeLabel(pParse);
5039 testcase( jumpIfNull==0 );
5040 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5041 jumpIfNull^SQLITE_JUMPIFNULL);
5042 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5043 sqlite3VdbeResolveLabel(v, d2);
5044 }
drhcce7d172000-05-31 15:34:51 +00005045 break;
5046 }
5047 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005048 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005049 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005050 break;
5051 }
drh8abed7b2018-02-26 18:49:05 +00005052 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005053 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5054 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005055 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005056 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005057 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005058 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005059 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005060 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005061 /* IS TRUE and IS NOT FALSE */
5062 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5063 isNot ? 0 : SQLITE_JUMPIFNULL);
5064
5065 }else{
5066 /* IS FALSE and IS NOT TRUE */
5067 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005068 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005069 }
drh007c8432018-02-26 03:20:18 +00005070 break;
5071 }
drhde845c22016-03-17 19:07:52 +00005072 case TK_IS:
5073 case TK_ISNOT:
5074 testcase( pExpr->op==TK_IS );
5075 testcase( pExpr->op==TK_ISNOT );
5076 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5077 jumpIfNull = SQLITE_NULLEQ;
5078 /* Fall thru */
drhcce7d172000-05-31 15:34:51 +00005079 case TK_LT:
5080 case TK_LE:
5081 case TK_GT:
5082 case TK_GE:
5083 case TK_NE:
5084 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005085 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005086 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005087 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5088 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005089 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005090 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005091 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5092 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5093 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5094 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005095 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5096 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5097 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5098 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5099 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5100 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005101 testcase( regFree1==0 );
5102 testcase( regFree2==0 );
5103 break;
5104 }
drhcce7d172000-05-31 15:34:51 +00005105 case TK_ISNULL:
5106 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005107 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5108 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005109 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5110 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005111 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005112 break;
5113 }
drhfef52082000-06-06 01:50:43 +00005114 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005115 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005116 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005117 break;
5118 }
drh84e30ca2011-02-10 17:46:14 +00005119#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005120 case TK_IN: {
5121 if( jumpIfNull ){
5122 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5123 }else{
drhec4ccdb2018-12-29 02:26:59 +00005124 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005125 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5126 sqlite3VdbeResolveLabel(v, destIfNull);
5127 }
5128 break;
5129 }
shanehbb201342011-02-09 19:55:20 +00005130#endif
drhcce7d172000-05-31 15:34:51 +00005131 default: {
danba00e302016-07-23 20:24:06 +00005132 default_expr:
drhad317272019-04-19 16:21:51 +00005133 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005134 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005135 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005136 /* no-op */
5137 }else{
5138 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5139 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005140 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005141 testcase( regFree1==0 );
5142 testcase( jumpIfNull==0 );
5143 }
drhcce7d172000-05-31 15:34:51 +00005144 break;
5145 }
5146 }
drh2dcef112008-01-12 19:03:48 +00005147 sqlite3ReleaseTempReg(pParse, regFree1);
5148 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005149}
drh22827922000-06-06 17:27:05 +00005150
5151/*
drh72bc8202015-06-11 13:58:35 +00005152** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5153** code generation, and that copy is deleted after code generation. This
5154** ensures that the original pExpr is unchanged.
5155*/
5156void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5157 sqlite3 *db = pParse->db;
5158 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5159 if( db->mallocFailed==0 ){
5160 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5161 }
5162 sqlite3ExprDelete(db, pCopy);
5163}
5164
dan5aa550c2017-06-24 18:10:29 +00005165/*
5166** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5167** type of expression.
5168**
5169** If pExpr is a simple SQL value - an integer, real, string, blob
5170** or NULL value - then the VDBE currently being prepared is configured
5171** to re-prepare each time a new value is bound to variable pVar.
5172**
5173** Additionally, if pExpr is a simple SQL value and the value is the
5174** same as that currently bound to variable pVar, non-zero is returned.
5175** Otherwise, if the values are not the same or if pExpr is not a simple
5176** SQL value, zero is returned.
5177*/
5178static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5179 int res = 0;
drhc0804222017-06-28 21:47:16 +00005180 int iVar;
5181 sqlite3_value *pL, *pR = 0;
5182
5183 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5184 if( pR ){
5185 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005186 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005187 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005188 if( pL ){
5189 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5190 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5191 }
5192 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005193 }
drhc0804222017-06-28 21:47:16 +00005194 sqlite3ValueFree(pR);
5195 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005196 }
5197
5198 return res;
5199}
drh72bc8202015-06-11 13:58:35 +00005200
5201/*
drh1d9da702010-01-07 15:17:02 +00005202** Do a deep comparison of two expression trees. Return 0 if the two
5203** expressions are completely identical. Return 1 if they differ only
5204** by a COLLATE operator at the top level. Return 2 if there are differences
5205** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005206**
drh619a1302013-08-01 13:04:46 +00005207** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5208** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5209**
drh66518ca2013-08-01 15:09:57 +00005210** The pA side might be using TK_REGISTER. If that is the case and pB is
5211** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5212**
drh1d9da702010-01-07 15:17:02 +00005213** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005214** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005215** identical, we return 2 just to be safe. So if this routine
5216** returns 2, then you do not really know for certain if the two
5217** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005218** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005219** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005220** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005221** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005222**
drhc0804222017-06-28 21:47:16 +00005223** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5224** pParse->pReprepare can be matched against literals in pB. The
5225** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5226** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5227** Argument pParse should normally be NULL. If it is not NULL and pA or
5228** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005229*/
dan5aa550c2017-06-24 18:10:29 +00005230int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005231 u32 combinedFlags;
5232 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005233 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005234 }
dan5aa550c2017-06-24 18:10:29 +00005235 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5236 return 0;
5237 }
drh10d1edf2013-11-15 15:52:39 +00005238 combinedFlags = pA->flags | pB->flags;
5239 if( combinedFlags & EP_IntValue ){
5240 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5241 return 0;
5242 }
drh1d9da702010-01-07 15:17:02 +00005243 return 2;
drh22827922000-06-06 17:27:05 +00005244 }
dan16dd3982018-12-20 15:04:38 +00005245 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005246 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005247 return 1;
5248 }
dan5aa550c2017-06-24 18:10:29 +00005249 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005250 return 1;
5251 }
5252 return 2;
5253 }
drh2edc5fd2015-11-24 02:10:52 +00005254 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005255 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005256 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005257#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005258 assert( pA->op==pB->op );
5259 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5260 return 2;
5261 }
drheda079c2018-09-20 19:02:15 +00005262 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005263 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5264 return 2;
5265 }
drheda079c2018-09-20 19:02:15 +00005266 }
5267#endif
drhf20bbc52019-01-17 01:06:00 +00005268 }else if( pA->op==TK_NULL ){
5269 return 0;
drhd5af5422018-04-13 14:27:01 +00005270 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005271 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005272 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005273 return 2;
drh2646da72005-12-09 20:02:05 +00005274 }
drh22827922000-06-06 17:27:05 +00005275 }
drh898c5272019-10-22 00:03:41 +00005276 if( (pA->flags & (EP_Distinct|EP_Commuted))
5277 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005278 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005279 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005280 if( (combinedFlags & EP_FixedCol)==0
5281 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005282 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005283 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005284 if( pA->op!=TK_STRING
5285 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005286 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005287 ){
drh10d1edf2013-11-15 15:52:39 +00005288 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005289 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005290 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5291 return 2;
5292 }
drh10d1edf2013-11-15 15:52:39 +00005293 }
5294 }
drh1d9da702010-01-07 15:17:02 +00005295 return 0;
drh22827922000-06-06 17:27:05 +00005296}
5297
drh8c6f6662010-04-26 19:17:26 +00005298/*
danfbb6e9f2020-01-09 20:11:29 +00005299** Compare two ExprList objects. Return 0 if they are identical, 1
5300** if they are certainly different, or 2 if it is not possible to
5301** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005302**
drh619a1302013-08-01 13:04:46 +00005303** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5304** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5305**
drh8c6f6662010-04-26 19:17:26 +00005306** This routine might return non-zero for equivalent ExprLists. The
5307** only consequence will be disabled optimizations. But this routine
5308** must never return 0 if the two ExprList objects are different, or
5309** a malfunction will result.
5310**
5311** Two NULL pointers are considered to be the same. But a NULL pointer
5312** always differs from a non-NULL pointer.
5313*/
drh619a1302013-08-01 13:04:46 +00005314int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005315 int i;
5316 if( pA==0 && pB==0 ) return 0;
5317 if( pA==0 || pB==0 ) return 1;
5318 if( pA->nExpr!=pB->nExpr ) return 1;
5319 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005320 int res;
drh8c6f6662010-04-26 19:17:26 +00005321 Expr *pExprA = pA->a[i].pExpr;
5322 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005323 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005324 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005325 }
5326 return 0;
5327}
drh13449892005-09-07 21:22:45 +00005328
drh22827922000-06-06 17:27:05 +00005329/*
drhf9463df2017-02-11 14:59:58 +00005330** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5331** are ignored.
5332*/
5333int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005334 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005335 sqlite3ExprSkipCollateAndLikely(pA),
5336 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005337 iTab);
5338}
5339
5340/*
drhc51cf862019-05-11 19:36:03 +00005341** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005342**
5343** Or if seenNot is true, return non-zero if Expr p can only be
5344** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005345*/
5346static int exprImpliesNotNull(
5347 Parse *pParse, /* Parsing context */
5348 Expr *p, /* The expression to be checked */
5349 Expr *pNN, /* The expression that is NOT NULL */
5350 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005351 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005352){
5353 assert( p );
5354 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005355 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5356 return pNN->op!=TK_NULL;
5357 }
drhc51cf862019-05-11 19:36:03 +00005358 switch( p->op ){
5359 case TK_IN: {
5360 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5361 assert( ExprHasProperty(p,EP_xIsSelect)
5362 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005363 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005364 }
5365 case TK_BETWEEN: {
5366 ExprList *pList = p->x.pList;
5367 assert( pList!=0 );
5368 assert( pList->nExpr==2 );
5369 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005370 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5371 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005372 ){
5373 return 1;
5374 }
drh7a231b42019-08-30 15:11:08 +00005375 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005376 }
5377 case TK_EQ:
5378 case TK_NE:
5379 case TK_LT:
5380 case TK_LE:
5381 case TK_GT:
5382 case TK_GE:
5383 case TK_PLUS:
5384 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005385 case TK_BITOR:
5386 case TK_LSHIFT:
5387 case TK_RSHIFT:
5388 case TK_CONCAT:
5389 seenNot = 1;
5390 /* Fall thru */
drhc51cf862019-05-11 19:36:03 +00005391 case TK_STAR:
5392 case TK_REM:
5393 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005394 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005395 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5396 /* Fall thru into the next case */
5397 }
5398 case TK_SPAN:
5399 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005400 case TK_UPLUS:
5401 case TK_UMINUS: {
5402 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5403 }
5404 case TK_TRUTH: {
5405 if( seenNot ) return 0;
5406 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005407 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005408 }
dan1cd382e2019-08-29 15:06:35 +00005409 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005410 case TK_NOT: {
5411 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5412 }
5413 }
5414 return 0;
5415}
5416
5417/*
drh4bd5f732013-07-31 23:22:39 +00005418** Return true if we can prove the pE2 will always be true if pE1 is
5419** true. Return false if we cannot complete the proof or if pE2 might
5420** be false. Examples:
5421**
drh619a1302013-08-01 13:04:46 +00005422** pE1: x==5 pE2: x==5 Result: true
5423** pE1: x>0 pE2: x==5 Result: false
5424** pE1: x=21 pE2: x=21 OR y=43 Result: true
5425** pE1: x!=123 pE2: x IS NOT NULL Result: true
5426** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5427** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5428** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005429**
5430** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5431** Expr.iTable<0 then assume a table number given by iTab.
5432**
drhc0804222017-06-28 21:47:16 +00005433** If pParse is not NULL, then the values of bound variables in pE1 are
5434** compared against literal values in pE2 and pParse->pVdbe->expmask is
5435** modified to record which bound variables are referenced. If pParse
5436** is NULL, then false will be returned if pE1 contains any bound variables.
5437**
drh4bd5f732013-07-31 23:22:39 +00005438** When in doubt, return false. Returning true might give a performance
5439** improvement. Returning false might cause a performance reduction, but
5440** it will always give the correct answer and is hence always safe.
5441*/
dan5aa550c2017-06-24 18:10:29 +00005442int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5443 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005444 return 1;
5445 }
5446 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005447 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5448 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005449 ){
5450 return 1;
5451 }
drh664d6d12019-05-04 17:32:07 +00005452 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005453 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005454 ){
drhc51cf862019-05-11 19:36:03 +00005455 return 1;
drh619a1302013-08-01 13:04:46 +00005456 }
5457 return 0;
drh4bd5f732013-07-31 23:22:39 +00005458}
5459
5460/*
drh6c68d752019-11-04 02:05:52 +00005461** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005462** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005463** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5464**
5465** This routine controls an optimization. False positives (setting
5466** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5467** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005468*/
5469static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005470 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005471 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005472 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5473 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005474 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005475 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005476 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005477 case TK_IS:
5478 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005479 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005480 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005481 case TK_IN:
drh25897872018-03-20 21:16:15 +00005482 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005483 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005484 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005485 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005486 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005487 testcase( pExpr->op==TK_IS );
5488 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005489 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005490 testcase( pExpr->op==TK_CASE );
5491 testcase( pExpr->op==TK_IN );
5492 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005493 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005494 return WRC_Prune;
5495 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005496 if( pWalker->u.iCur==pExpr->iTable ){
5497 pWalker->eCode = 1;
5498 return WRC_Abort;
5499 }
5500 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005501
dan9d23ea72019-08-29 19:34:29 +00005502 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005503 if( pWalker->eCode==0 ){
5504 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5505 if( pWalker->eCode ){
5506 pWalker->eCode = 0;
5507 sqlite3WalkExpr(pWalker, pExpr->pRight);
5508 }
dan9d23ea72019-08-29 19:34:29 +00005509 }
5510 return WRC_Prune;
5511
5512 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005513 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5514 assert( pWalker->eCode );
5515 return WRC_Abort;
5516 }
dan9d23ea72019-08-29 19:34:29 +00005517 return WRC_Prune;
5518
drh98811552018-04-03 14:04:48 +00005519 /* Virtual tables are allowed to use constraints like x=NULL. So
5520 ** a term of the form x=y does not prove that y is not null if x
5521 ** is the column of a virtual table */
5522 case TK_EQ:
5523 case TK_NE:
5524 case TK_LT:
5525 case TK_LE:
5526 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005527 case TK_GE: {
5528 Expr *pLeft = pExpr->pLeft;
5529 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005530 testcase( pExpr->op==TK_EQ );
5531 testcase( pExpr->op==TK_NE );
5532 testcase( pExpr->op==TK_LT );
5533 testcase( pExpr->op==TK_LE );
5534 testcase( pExpr->op==TK_GT );
5535 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005536 /* The y.pTab=0 assignment in wherecode.c always happens after the
5537 ** impliesNotNullRow() test */
5538 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5539 && IsVirtual(pLeft->y.pTab))
5540 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5541 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005542 ){
drh78d1d222020-02-17 19:25:07 +00005543 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005544 }
drh78d1d222020-02-17 19:25:07 +00005545 }
drh25897872018-03-20 21:16:15 +00005546 default:
5547 return WRC_Continue;
5548 }
5549}
5550
5551/*
5552** Return true (non-zero) if expression p can only be true if at least
5553** one column of table iTab is non-null. In other words, return true
5554** if expression p will always be NULL or false if every column of iTab
5555** is NULL.
5556**
drh821b6102018-03-24 18:01:51 +00005557** False negatives are acceptable. In other words, it is ok to return
5558** zero even if expression p will never be true of every column of iTab
5559** is NULL. A false negative is merely a missed optimization opportunity.
5560**
5561** False positives are not allowed, however. A false positive may result
5562** in an incorrect answer.
5563**
drh25897872018-03-20 21:16:15 +00005564** Terms of p that are marked with EP_FromJoin (and hence that come from
5565** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5566**
5567** This routine is used to check if a LEFT JOIN can be converted into
5568** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5569** clause requires that some column of the right table of the LEFT JOIN
5570** be non-NULL, then the LEFT JOIN can be safely converted into an
5571** ordinary join.
5572*/
5573int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5574 Walker w;
drh0d950af2019-08-22 16:38:42 +00005575 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005576 if( p==0 ) return 0;
5577 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005578 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005579 }else{
5580 while( p->op==TK_AND ){
5581 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5582 p = p->pRight;
5583 }
drhd6db6592019-04-01 19:42:42 +00005584 }
drh25897872018-03-20 21:16:15 +00005585 w.xExprCallback = impliesNotNullRow;
5586 w.xSelectCallback = 0;
5587 w.xSelectCallback2 = 0;
5588 w.eCode = 0;
5589 w.u.iCur = iTab;
5590 sqlite3WalkExpr(&w, p);
5591 return w.eCode;
5592}
5593
5594/*
drh030796d2012-08-23 16:18:10 +00005595** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005596** to determine if an expression can be evaluated by reference to the
5597** index only, without having to do a search for the corresponding
5598** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5599** is the cursor for the table.
5600*/
5601struct IdxCover {
5602 Index *pIdx; /* The index to be tested for coverage */
5603 int iCur; /* Cursor number for the table corresponding to the index */
5604};
5605
5606/*
5607** Check to see if there are references to columns in table
5608** pWalker->u.pIdxCover->iCur can be satisfied using the index
5609** pWalker->u.pIdxCover->pIdx.
5610*/
5611static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5612 if( pExpr->op==TK_COLUMN
5613 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005614 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005615 ){
5616 pWalker->eCode = 1;
5617 return WRC_Abort;
5618 }
5619 return WRC_Continue;
5620}
5621
5622/*
drhe604ec02016-07-27 19:20:58 +00005623** Determine if an index pIdx on table with cursor iCur contains will
5624** the expression pExpr. Return true if the index does cover the
5625** expression and false if the pExpr expression references table columns
5626** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005627**
5628** An index covering an expression means that the expression can be
5629** evaluated using only the index and without having to lookup the
5630** corresponding table entry.
5631*/
5632int sqlite3ExprCoveredByIndex(
5633 Expr *pExpr, /* The index to be tested */
5634 int iCur, /* The cursor number for the corresponding table */
5635 Index *pIdx /* The index that might be used for coverage */
5636){
5637 Walker w;
5638 struct IdxCover xcov;
5639 memset(&w, 0, sizeof(w));
5640 xcov.iCur = iCur;
5641 xcov.pIdx = pIdx;
5642 w.xExprCallback = exprIdxCover;
5643 w.u.pIdxCover = &xcov;
5644 sqlite3WalkExpr(&w, pExpr);
5645 return !w.eCode;
5646}
5647
5648
5649/*
5650** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005651** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005652** aggregate function, in order to implement the
5653** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005654*/
drh030796d2012-08-23 16:18:10 +00005655struct SrcCount {
5656 SrcList *pSrc; /* One particular FROM clause in a nested query */
daned41a962020-06-09 17:45:48 +00005657 int iSrcInner; /* Smallest cursor number in this context */
drh030796d2012-08-23 16:18:10 +00005658 int nThis; /* Number of references to columns in pSrcList */
5659 int nOther; /* Number of references to columns in other FROM clauses */
5660};
5661
5662/*
daned41a962020-06-09 17:45:48 +00005663** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5664** SELECT with a FROM clause encountered during this iteration, set
5665** SrcCount.iSrcInner to the cursor number of the leftmost object in
5666** the FROM cause.
5667*/
5668static int selectSrcCount(Walker *pWalker, Select *pSel){
5669 struct SrcCount *p = pWalker->u.pSrcCount;
drhbc050b82020-06-09 22:11:06 +00005670 if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
daned41a962020-06-09 17:45:48 +00005671 pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5672 }
5673 return WRC_Continue;
5674}
5675
5676/*
drh030796d2012-08-23 16:18:10 +00005677** Count the number of references to columns.
5678*/
5679static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005680 /* There was once a NEVER() on the second term on the grounds that
5681 ** sqlite3FunctionUsesThisSrc() was always called before
5682 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5683 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5684 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5685 ** FunctionUsesThisSrc() when creating a new sub-select. */
5686 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005687 int i;
drh030796d2012-08-23 16:18:10 +00005688 struct SrcCount *p = pWalker->u.pSrcCount;
5689 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005690 int nSrc = pSrc ? pSrc->nSrc : 0;
5691 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005692 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005693 }
drh655814d2015-01-09 01:27:29 +00005694 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005695 p->nThis++;
daned41a962020-06-09 17:45:48 +00005696 }else if( pExpr->iTable<p->iSrcInner ){
drh80f6bfc2019-08-31 20:13:30 +00005697 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005698 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005699 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005700 p->nOther++;
5701 }
drh374fdce2012-04-17 16:38:53 +00005702 }
drh030796d2012-08-23 16:18:10 +00005703 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005704}
5705
5706/*
drh030796d2012-08-23 16:18:10 +00005707** Determine if any of the arguments to the pExpr Function reference
5708** pSrcList. Return true if they do. Also return true if the function
5709** has no arguments or has only constant arguments. Return false if pExpr
5710** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005711*/
drh030796d2012-08-23 16:18:10 +00005712int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005713 Walker w;
drh030796d2012-08-23 16:18:10 +00005714 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005715 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005716 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005717 w.xExprCallback = exprSrcCount;
daned41a962020-06-09 17:45:48 +00005718 w.xSelectCallback = selectSrcCount;
drh030796d2012-08-23 16:18:10 +00005719 w.u.pSrcCount = &cnt;
5720 cnt.pSrc = pSrcList;
daned41a962020-06-09 17:45:48 +00005721 cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
drh030796d2012-08-23 16:18:10 +00005722 cnt.nThis = 0;
5723 cnt.nOther = 0;
5724 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005725#ifndef SQLITE_OMIT_WINDOWFUNC
5726 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5727 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5728 }
5729#endif
drh030796d2012-08-23 16:18:10 +00005730 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005731}
5732
5733/*
drh89636622020-06-07 17:33:18 +00005734** This is a Walker expression node callback.
5735**
5736** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
5737** object that is referenced does not refer directly to the Expr. If
5738** it does, make a copy. This is done because the pExpr argument is
5739** subject to change.
5740**
5741** The copy is stored on pParse->pConstExpr with a register number of 0.
5742** This will cause the expression to be deleted automatically when the
5743** Parse object is destroyed, but the zero register number means that it
5744** will not generate any code in the preamble.
5745*/
5746static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00005747 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00005748 && pExpr->pAggInfo!=0
5749 ){
5750 AggInfo *pAggInfo = pExpr->pAggInfo;
5751 int iAgg = pExpr->iAgg;
5752 Parse *pParse = pWalker->pParse;
5753 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00005754 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
5755 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00005756 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00005757 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005758 pExpr = sqlite3ExprDup(db, pExpr, 0);
5759 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005760 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005761 pParse->pConstExpr =
5762 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5763 }
5764 }
5765 }else{
5766 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00005767 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005768 pExpr = sqlite3ExprDup(db, pExpr, 0);
5769 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005770 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005771 pParse->pConstExpr =
5772 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5773 }
5774 }
5775 }
5776 }
5777 return WRC_Continue;
5778}
5779
5780/*
5781** Initialize a Walker object so that will persist AggInfo entries referenced
5782** by the tree that is walked.
5783*/
5784void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
5785 memset(pWalker, 0, sizeof(*pWalker));
5786 pWalker->pParse = pParse;
5787 pWalker->xExprCallback = agginfoPersistExprCb;
5788 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
5789}
5790
5791/*
drh13449892005-09-07 21:22:45 +00005792** Add a new element to the pAggInfo->aCol[] array. Return the index of
5793** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005794*/
drh17435752007-08-16 04:30:38 +00005795static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005796 int i;
drhcf643722007-03-27 13:36:37 +00005797 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005798 db,
drhcf643722007-03-27 13:36:37 +00005799 pInfo->aCol,
5800 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005801 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005802 &i
5803 );
drh13449892005-09-07 21:22:45 +00005804 return i;
5805}
5806
5807/*
5808** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5809** the new element. Return a negative number if malloc fails.
5810*/
drh17435752007-08-16 04:30:38 +00005811static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005812 int i;
drhcf643722007-03-27 13:36:37 +00005813 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005814 db,
drhcf643722007-03-27 13:36:37 +00005815 pInfo->aFunc,
5816 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005817 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005818 &i
5819 );
drh13449892005-09-07 21:22:45 +00005820 return i;
drh89636622020-06-07 17:33:18 +00005821}
drh22827922000-06-06 17:27:05 +00005822
5823/*
drh7d10d5a2008-08-20 16:35:10 +00005824** This is the xExprCallback for a tree walker. It is used to
5825** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005826** for additional information.
drh22827922000-06-06 17:27:05 +00005827*/
drh7d10d5a2008-08-20 16:35:10 +00005828static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005829 int i;
drh7d10d5a2008-08-20 16:35:10 +00005830 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005831 Parse *pParse = pNC->pParse;
5832 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005833 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005834
drh25c3b8c2018-04-16 10:34:13 +00005835 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005836 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005837 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005838 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005839 testcase( pExpr->op==TK_AGG_COLUMN );
5840 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005841 /* Check to see if the column is in one of the tables in the FROM
5842 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005843 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005844 struct SrcList_item *pItem = pSrcList->a;
5845 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5846 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005847 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005848 if( pExpr->iTable==pItem->iCursor ){
5849 /* If we reach this point, it means that pExpr refers to a table
5850 ** that is in the FROM clause of the aggregate query.
5851 **
5852 ** Make an entry for the column in pAggInfo->aCol[] if there
5853 ** is not an entry there already.
5854 */
drh7f906d62007-03-12 23:48:52 +00005855 int k;
drh13449892005-09-07 21:22:45 +00005856 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005857 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005858 if( pCol->iTable==pExpr->iTable &&
5859 pCol->iColumn==pExpr->iColumn ){
5860 break;
5861 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005862 }
danielk19771e536952007-08-16 10:09:01 +00005863 if( (k>=pAggInfo->nColumn)
5864 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5865 ){
drh7f906d62007-03-12 23:48:52 +00005866 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005867 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005868 pCol->iTable = pExpr->iTable;
5869 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005870 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005871 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00005872 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005873 if( pAggInfo->pGroupBy ){
5874 int j, n;
5875 ExprList *pGB = pAggInfo->pGroupBy;
5876 struct ExprList_item *pTerm = pGB->a;
5877 n = pGB->nExpr;
5878 for(j=0; j<n; j++, pTerm++){
5879 Expr *pE = pTerm->pExpr;
5880 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5881 pE->iColumn==pExpr->iColumn ){
5882 pCol->iSorterColumn = j;
5883 break;
5884 }
5885 }
5886 }
5887 if( pCol->iSorterColumn<0 ){
5888 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5889 }
5890 }
5891 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5892 ** because it was there before or because we just created it).
5893 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5894 ** pAggInfo->aCol[] entry.
5895 */
drhebb6a652013-09-12 23:42:22 +00005896 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005897 pExpr->pAggInfo = pAggInfo;
5898 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005899 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005900 break;
5901 } /* endif pExpr->iTable==pItem->iCursor */
5902 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005903 }
drh7d10d5a2008-08-20 16:35:10 +00005904 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005905 }
5906 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005907 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005908 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005909 ){
drh13449892005-09-07 21:22:45 +00005910 /* Check to see if pExpr is a duplicate of another aggregate
5911 ** function that is already in the pAggInfo structure
5912 */
5913 struct AggInfo_func *pItem = pAggInfo->aFunc;
5914 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh81185a52020-06-09 13:38:12 +00005915 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005916 break;
5917 }
drh22827922000-06-06 17:27:05 +00005918 }
drh13449892005-09-07 21:22:45 +00005919 if( i>=pAggInfo->nFunc ){
5920 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5921 */
danielk197714db2662006-01-09 16:12:04 +00005922 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005923 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005924 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005925 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005926 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00005927 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005928 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005929 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005930 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005931 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005932 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005933 if( pExpr->flags & EP_Distinct ){
5934 pItem->iDistinct = pParse->nTab++;
5935 }else{
5936 pItem->iDistinct = -1;
5937 }
drh13449892005-09-07 21:22:45 +00005938 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005939 }
drh13449892005-09-07 21:22:45 +00005940 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5941 */
drhc5cd1242013-09-12 16:50:49 +00005942 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005943 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005944 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005945 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005946 return WRC_Prune;
5947 }else{
5948 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005949 }
drh22827922000-06-06 17:27:05 +00005950 }
5951 }
drh7d10d5a2008-08-20 16:35:10 +00005952 return WRC_Continue;
5953}
drh626a8792005-01-17 22:08:19 +00005954
5955/*
drhe8abb4c2012-11-02 18:24:57 +00005956** Analyze the pExpr expression looking for aggregate functions and
5957** for variables that need to be added to AggInfo object that pNC->pAggInfo
5958** points to. Additional entries are made on the AggInfo object as
5959** necessary.
drh626a8792005-01-17 22:08:19 +00005960**
5961** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005962** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005963*/
drhd2b3e232008-01-23 14:51:49 +00005964void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005965 Walker w;
5966 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00005967 w.xSelectCallback = sqlite3WalkerDepthIncrease;
5968 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00005969 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005970 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005971 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005972 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005973 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005974}
drh5d9a4af2005-08-30 00:54:01 +00005975
5976/*
5977** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5978** expression list. Return the number of errors.
5979**
5980** If an error is found, the analysis is cut short.
5981*/
drhd2b3e232008-01-23 14:51:49 +00005982void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005983 struct ExprList_item *pItem;
5984 int i;
drh5d9a4af2005-08-30 00:54:01 +00005985 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005986 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5987 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005988 }
5989 }
drh5d9a4af2005-08-30 00:54:01 +00005990}
drh892d3172008-01-10 03:46:36 +00005991
5992/*
drhceea3322009-04-23 13:22:42 +00005993** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005994*/
5995int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00005996 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00005997 return ++pParse->nMem;
5998 }
danielk19772f425f62008-07-04 09:41:39 +00005999 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006000}
drhceea3322009-04-23 13:22:42 +00006001
6002/*
6003** Deallocate a register, making available for reuse for some other
6004** purpose.
drhceea3322009-04-23 13:22:42 +00006005*/
drh892d3172008-01-10 03:46:36 +00006006void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006007 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006008 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006009 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6010 pParse->aTempReg[pParse->nTempReg++] = iReg;
6011 }
drh892d3172008-01-10 03:46:36 +00006012 }
6013}
6014
6015/*
drhed24da42016-09-06 14:37:05 +00006016** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006017*/
6018int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006019 int i, n;
drhed24da42016-09-06 14:37:05 +00006020 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006021 i = pParse->iRangeReg;
6022 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006023 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006024 pParse->iRangeReg += nReg;
6025 pParse->nRangeReg -= nReg;
6026 }else{
6027 i = pParse->nMem+1;
6028 pParse->nMem += nReg;
6029 }
6030 return i;
6031}
6032void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006033 if( nReg==1 ){
6034 sqlite3ReleaseTempReg(pParse, iReg);
6035 return;
6036 }
drh3aef2fb2020-01-02 17:46:02 +00006037 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006038 if( nReg>pParse->nRangeReg ){
6039 pParse->nRangeReg = nReg;
6040 pParse->iRangeReg = iReg;
6041 }
6042}
drhcdc69552011-12-06 13:24:59 +00006043
6044/*
6045** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006046**
6047** Always invoke this procedure after coding a subroutine or co-routine
6048** that might be invoked from other parts of the code, to ensure that
6049** the sub/co-routine does not use registers in common with the code that
6050** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006051*/
6052void sqlite3ClearTempRegCache(Parse *pParse){
6053 pParse->nTempReg = 0;
6054 pParse->nRangeReg = 0;
6055}
drhbb9b5f22016-03-19 00:35:02 +00006056
6057/*
6058** Validate that no temporary register falls within the range of
6059** iFirst..iLast, inclusive. This routine is only call from within assert()
6060** statements.
6061*/
6062#ifdef SQLITE_DEBUG
6063int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6064 int i;
6065 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006066 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6067 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006068 ){
6069 return 0;
6070 }
6071 for(i=0; i<pParse->nTempReg; i++){
6072 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6073 return 0;
6074 }
6075 }
6076 return 1;
6077}
6078#endif /* SQLITE_DEBUG */