blob: 7277bb75de75dbc29ce9f0b48c74b806c0667ef4 [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;
drh46fe1382020-08-19 23:32:06 +000047 while( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
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 );
drh6af305d2020-07-10 21:43:53 +000055 assert( pExpr->x.pSelect!=0 );
56 assert( pExpr->x.pSelect->pEList!=0 );
57 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
58 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000059 }
drhdb45bd52016-08-22 00:48:58 +000060 if( op==TK_REGISTER ) op = pExpr->op2;
drh487e2622005-06-25 18:42:14 +000061#ifndef SQLITE_OMIT_CAST
62 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000063 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000064 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000065 }
66#endif
drheda079c2018-09-20 19:02:15 +000067 if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
68 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
drh7d10d5a2008-08-20 16:35:10 +000069 }
dan80aa5452016-09-03 19:52:12 +000070 if( op==TK_SELECT_COLUMN ){
71 assert( pExpr->pLeft->flags&EP_xIsSelect );
72 return sqlite3ExprAffinity(
73 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
74 );
75 }
drhdb36e252019-10-22 19:51:29 +000076 if( op==TK_VECTOR ){
77 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
78 }
drh11949042019-08-05 18:01:42 +000079 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000080}
81
drh53db1452004-05-20 13:54:53 +000082/*
drh8b4c40d2007-02-01 23:02:45 +000083** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000084** sequence named by pToken. Return a pointer to a new Expr node that
85** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000086**
87** If a memory allocation error occurs, that fact is recorded in pParse->db
88** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000089*/
drh4ef7efa2014-03-20 15:14:08 +000090Expr *sqlite3ExprAddCollateToken(
91 Parse *pParse, /* Parsing context */
92 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000093 const Token *pCollName, /* Name of collating sequence */
94 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000095){
drh0a8a4062012-12-07 18:38:16 +000096 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000097 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +000098 if( pNew ){
99 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000100 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000101 pExpr = pNew;
102 }
drhae80dde2012-12-06 21:16:43 +0000103 }
drh0a8a4062012-12-07 18:38:16 +0000104 return pExpr;
105}
106Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000107 Token s;
108 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000109 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000110 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000111}
112
113/*
drh0d950af2019-08-22 16:38:42 +0000114** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000115*/
116Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000117 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000118 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000119 pExpr = pExpr->pLeft;
120 }
121 return pExpr;
122}
123
124/*
125** Skip over any TK_COLLATE operators and/or any unlikely()
126** or likelihood() or likely() functions at the root of an
127** expression.
128*/
129Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000130 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000131 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000132 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
133 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000134 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000135 pExpr = pExpr->x.pList->a[0].pExpr;
136 }else{
drh46fe1382020-08-19 23:32:06 +0000137 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000138 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000139 }
drha4c3c872013-09-12 17:29:25 +0000140 }
drh0a8a4062012-12-07 18:38:16 +0000141 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000142}
143
144/*
drhae80dde2012-12-06 21:16:43 +0000145** Return the collation sequence for the expression pExpr. If
146** there is no defined collating sequence, return NULL.
147**
drh70efa842017-09-28 01:58:23 +0000148** See also: sqlite3ExprNNCollSeq()
149**
150** The sqlite3ExprNNCollSeq() works the same exact that it returns the
151** default collation if pExpr has no defined collation.
152**
drhae80dde2012-12-06 21:16:43 +0000153** The collating sequence might be determined by a COLLATE operator
154** or by the presence of a column with a defined collating sequence.
155** COLLATE operators take first precedence. Left operands take
156** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000157*/
drhe7375bf2020-03-10 19:24:38 +0000158CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000159 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000160 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000161 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000162 while( p ){
drhae80dde2012-12-06 21:16:43 +0000163 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000164 if( op==TK_REGISTER ) op = p->op2;
165 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000166 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000167 ){
drheda079c2018-09-20 19:02:15 +0000168 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000169 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000170 int j = p->iColumn;
171 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000172 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000173 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000174 }
175 break;
danielk19770202b292004-06-09 09:55:16 +0000176 }
drhe081d732018-07-27 18:19:12 +0000177 if( op==TK_CAST || op==TK_UPLUS ){
178 p = p->pLeft;
179 continue;
180 }
drh269d3222019-10-23 18:09:39 +0000181 if( op==TK_VECTOR ){
182 p = p->x.pList->a[0].pExpr;
183 continue;
184 }
drhcb0e04f2018-12-12 21:34:17 +0000185 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000186 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
187 break;
188 }
drhae80dde2012-12-06 21:16:43 +0000189 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000190 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000191 p = p->pLeft;
192 }else{
drh2308ed32015-02-09 16:09:34 +0000193 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000194 /* The Expr.x union is never used at the same time as Expr.pRight */
195 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000196 if( p->x.pList!=0
197 && !db->mallocFailed
198 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
199 ){
drh2308ed32015-02-09 16:09:34 +0000200 int i;
drh5b107652020-07-13 15:35:08 +0000201 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000202 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
203 pNext = p->x.pList->a[i].pExpr;
204 break;
205 }
206 }
207 }
208 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000209 }
210 }else{
drh7d10d5a2008-08-20 16:35:10 +0000211 break;
212 }
danielk19770202b292004-06-09 09:55:16 +0000213 }
danielk19777cedc8d2004-06-10 10:50:08 +0000214 if( sqlite3CheckCollSeq(pParse, pColl) ){
215 pColl = 0;
216 }
217 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000218}
219
220/*
drh70efa842017-09-28 01:58:23 +0000221** Return the collation sequence for the expression pExpr. If
222** there is no defined collating sequence, return a pointer to the
223** defautl collation sequence.
224**
225** See also: sqlite3ExprCollSeq()
226**
227** The sqlite3ExprCollSeq() routine works the same except that it
228** returns NULL if there is no defined collation.
229*/
drhe7375bf2020-03-10 19:24:38 +0000230CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000231 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
232 if( p==0 ) p = pParse->db->pDfltColl;
233 assert( p!=0 );
234 return p;
235}
236
237/*
238** Return TRUE if the two expressions have equivalent collating sequences.
239*/
drhe7375bf2020-03-10 19:24:38 +0000240int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000241 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
242 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
243 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
244}
245
246/*
drh626a8792005-01-17 22:08:19 +0000247** pExpr is an operand of a comparison operator. aff2 is the
248** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000249** type affinity that should be used for the comparison operator.
250*/
drhe7375bf2020-03-10 19:24:38 +0000251char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000252 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000253 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000254 /* Both sides of the comparison are columns. If one has numeric
255 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000256 */
drh8a512562005-11-14 22:29:05 +0000257 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000258 return SQLITE_AFF_NUMERIC;
259 }else{
drh05883a32015-06-02 15:32:08 +0000260 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000261 }
danielk1977e014a832004-05-17 10:48:57 +0000262 }else{
263 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000264 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
265 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000266 }
267}
268
drh53db1452004-05-20 13:54:53 +0000269/*
270** pExpr is a comparison operator. Return the type affinity that should
271** be applied to both operands prior to doing the comparison.
272*/
drhe7375bf2020-03-10 19:24:38 +0000273static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000274 char aff;
275 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
276 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000277 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000278 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000279 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000280 if( pExpr->pRight ){
281 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000282 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
283 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000284 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000285 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000286 }
287 return aff;
288}
289
290/*
291** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
292** idx_affinity is the affinity of an indexed column. Return true
293** if the index with affinity idx_affinity may be used to implement
294** the comparison in pExpr.
295*/
drhe7375bf2020-03-10 19:24:38 +0000296int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000297 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000298 if( aff<SQLITE_AFF_TEXT ){
299 return 1;
drh8a512562005-11-14 22:29:05 +0000300 }
drh915e4342019-08-06 15:18:15 +0000301 if( aff==SQLITE_AFF_TEXT ){
302 return idx_affinity==SQLITE_AFF_TEXT;
303 }
304 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000305}
306
danielk1977a37cdde2004-05-16 11:15:36 +0000307/*
drh35573352008-01-08 23:54:25 +0000308** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000309** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000310*/
drhe7375bf2020-03-10 19:24:38 +0000311static u8 binaryCompareP5(
312 const Expr *pExpr1, /* Left operand */
313 const Expr *pExpr2, /* Right operand */
314 int jumpIfNull /* Extra flags added to P5 */
315){
drh35573352008-01-08 23:54:25 +0000316 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000317 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000318 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000319}
320
drha2e00042002-01-22 03:13:42 +0000321/*
danielk19770202b292004-06-09 09:55:16 +0000322** Return a pointer to the collation sequence that should be used by
323** a binary comparison operator comparing pLeft and pRight.
324**
325** If the left hand expression has a collating sequence type, then it is
326** used. Otherwise the collation sequence for the right hand expression
327** is used, or the default (BINARY) if neither expression has a collating
328** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000329**
330** Argument pRight (but not pLeft) may be a null pointer. In this case,
331** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000332*/
drh0a0e1312007-08-07 17:04:59 +0000333CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000334 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000335 const Expr *pLeft,
336 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000337){
drhec41dda2007-02-07 13:09:45 +0000338 CollSeq *pColl;
339 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000340 if( pLeft->flags & EP_Collate ){
341 pColl = sqlite3ExprCollSeq(pParse, pLeft);
342 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
343 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000344 }else{
345 pColl = sqlite3ExprCollSeq(pParse, pLeft);
346 if( !pColl ){
347 pColl = sqlite3ExprCollSeq(pParse, pRight);
348 }
danielk19770202b292004-06-09 09:55:16 +0000349 }
350 return pColl;
351}
352
drh898c5272019-10-22 00:03:41 +0000353/* Expresssion p is a comparison operator. Return a collation sequence
354** appropriate for the comparison operator.
355**
356** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
357** However, if the OP_Commuted flag is set, then the order of the operands
358** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
359** correct collating sequence is found.
360*/
drhe7375bf2020-03-10 19:24:38 +0000361CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000362 if( ExprHasProperty(p, EP_Commuted) ){
363 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
364 }else{
365 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
366 }
367}
368
danielk19770202b292004-06-09 09:55:16 +0000369/*
drhbe5c89a2004-07-26 00:31:09 +0000370** Generate code for a comparison operator.
371*/
372static int codeCompare(
373 Parse *pParse, /* The parsing (and code generating) context */
374 Expr *pLeft, /* The left operand */
375 Expr *pRight, /* The right operand */
376 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000377 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000378 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000379 int jumpIfNull, /* If true, jump if either operand is NULL */
380 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000381){
drh35573352008-01-08 23:54:25 +0000382 int p5;
383 int addr;
384 CollSeq *p4;
385
drh86541862019-12-19 20:37:32 +0000386 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000387 if( isCommuted ){
388 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
389 }else{
390 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
391 }
drh35573352008-01-08 23:54:25 +0000392 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
393 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
394 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000395 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000396 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000397}
398
dancfbb5e82016-07-13 19:48:13 +0000399/*
dan870a0702016-08-01 16:37:43 +0000400** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000401**
402** A vector is defined as any expression that results in two or more
403** columns of result. Every TK_VECTOR node is an vector because the
404** parser will not generate a TK_VECTOR with fewer than two entries.
405** But a TK_SELECT might be either a vector or a scalar. It is only
406** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000407*/
408int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000409 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000410}
411
412/*
dancfbb5e82016-07-13 19:48:13 +0000413** If the expression passed as the only argument is of type TK_VECTOR
414** return the number of expressions in the vector. Or, if the expression
415** is a sub-select, return the number of columns in the sub-select. For
416** any other type of expression, return 1.
417*/
dan71c57db2016-07-09 20:23:55 +0000418int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000419 u8 op = pExpr->op;
420 if( op==TK_REGISTER ) op = pExpr->op2;
421 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000422 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000423 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000424 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000425 }else{
426 return 1;
dan71c57db2016-07-09 20:23:55 +0000427 }
dan71c57db2016-07-09 20:23:55 +0000428}
429
danba00e302016-07-23 20:24:06 +0000430/*
drhfc7f27b2016-08-20 00:07:01 +0000431** Return a pointer to a subexpression of pVector that is the i-th
432** column of the vector (numbered starting with 0). The caller must
433** ensure that i is within range.
434**
drh76dbe7a2016-08-20 21:02:38 +0000435** If pVector is really a scalar (and "scalar" here includes subqueries
436** that return a single column!) then return pVector unmodified.
437**
drhfc7f27b2016-08-20 00:07:01 +0000438** pVector retains ownership of the returned subexpression.
439**
440** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000441** just the expression for the i-th term of the result set, and may
442** not be ready for evaluation because the table cursor has not yet
443** been positioned.
danba00e302016-07-23 20:24:06 +0000444*/
drhfc7f27b2016-08-20 00:07:01 +0000445Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
dan870a0702016-08-01 16:37:43 +0000446 assert( i<sqlite3ExprVectorSize(pVector) );
447 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000448 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
449 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000450 return pVector->x.pSelect->pEList->a[i].pExpr;
451 }else{
452 return pVector->x.pList->a[i].pExpr;
453 }
dan71c57db2016-07-09 20:23:55 +0000454 }
dan870a0702016-08-01 16:37:43 +0000455 return pVector;
dan71c57db2016-07-09 20:23:55 +0000456}
drhfc7f27b2016-08-20 00:07:01 +0000457
drhfc7f27b2016-08-20 00:07:01 +0000458/*
459** Compute and return a new Expr object which when passed to
460** sqlite3ExprCode() will generate all necessary code to compute
461** the iField-th column of the vector expression pVector.
462**
drh8762ec12016-08-20 01:06:22 +0000463** It is ok for pVector to be a scalar (as long as iField==0).
464** In that case, this routine works like sqlite3ExprDup().
465**
drhfc7f27b2016-08-20 00:07:01 +0000466** The caller owns the returned Expr object and is responsible for
467** ensuring that the returned value eventually gets freed.
468**
drh8762ec12016-08-20 01:06:22 +0000469** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000470** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000471** valid for the life of the returned object. If pVector is a TK_VECTOR
472** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000473** returns.
drh8762ec12016-08-20 01:06:22 +0000474**
475** A trick to cause a TK_SELECT pVector to be deleted together with
476** the returned Expr object is to attach the pVector to the pRight field
477** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000478*/
479Expr *sqlite3ExprForVectorField(
480 Parse *pParse, /* Parsing context */
481 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000482 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000483){
484 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000485 if( pVector->op==TK_SELECT ){
486 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000487 /* The TK_SELECT_COLUMN Expr node:
488 **
drh966e2912017-01-03 02:58:01 +0000489 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000490 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000491 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000492 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000493 ** pLeft->iTable: First in an array of register holding result, or 0
494 ** if the result is not yet computed.
495 **
496 ** sqlite3ExprDelete() specifically skips the recursive delete of
497 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000498 ** can be attached to pRight to cause this node to take ownership of
499 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
500 ** with the same pLeft pointer to the pVector, but only one of them
501 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000502 */
drhabfd35e2016-12-06 22:47:23 +0000503 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000504 if( pRet ){
505 pRet->iColumn = iField;
506 pRet->pLeft = pVector;
507 }
drhfc7f27b2016-08-20 00:07:01 +0000508 assert( pRet==0 || pRet->iTable==0 );
509 }else{
drha1251bc2016-08-20 00:51:37 +0000510 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
511 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000512 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000513 }
514 return pRet;
515}
dan71c57db2016-07-09 20:23:55 +0000516
dan5c288b92016-07-30 21:02:33 +0000517/*
518** If expression pExpr is of type TK_SELECT, generate code to evaluate
519** it. Return the register in which the result is stored (or, if the
520** sub-select returns more than one column, the first in an array
521** of registers in which the result is stored).
522**
523** If pExpr is not a TK_SELECT expression, return 0.
524*/
525static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000526 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000527#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000528 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000529 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000530 }
danf9b2e052016-08-02 17:45:00 +0000531#endif
dan8da209b2016-07-26 18:06:08 +0000532 return reg;
533}
534
dan5c288b92016-07-30 21:02:33 +0000535/*
536** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000537** or TK_SELECT that returns more than one column. This function returns
538** the register number of a register that contains the value of
539** element iField of the vector.
540**
541** If pVector is a TK_SELECT expression, then code for it must have
542** already been generated using the exprCodeSubselect() routine. In this
543** case parameter regSelect should be the first in an array of registers
544** containing the results of the sub-select.
545**
546** If pVector is of type TK_VECTOR, then code for the requested field
547** is generated. In this case (*pRegFree) may be set to the number of
548** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000549**
550** Before returning, output parameter (*ppExpr) is set to point to the
551** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000552*/
553static int exprVectorRegister(
554 Parse *pParse, /* Parse context */
555 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000556 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000557 int regSelect, /* First in array of registers */
558 Expr **ppExpr, /* OUT: Expression element */
559 int *pRegFree /* OUT: Temp register to free */
560){
drh12abf402016-08-22 14:30:05 +0000561 u8 op = pVector->op;
drhc1bcd9c2016-09-05 19:57:46 +0000562 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
drh12abf402016-08-22 14:30:05 +0000563 if( op==TK_REGISTER ){
564 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
565 return pVector->iTable+iField;
566 }
567 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000568 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
569 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000570 }
dan870a0702016-08-01 16:37:43 +0000571 *ppExpr = pVector->x.pList->a[iField].pExpr;
dan5c288b92016-07-30 21:02:33 +0000572 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
573}
574
575/*
576** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000577** the result of the comparison (1, 0, or NULL) and write that
578** result into register dest.
579**
580** The caller must satisfy the following preconditions:
581**
582** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
583** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
584** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000585*/
drh79752b62016-08-13 10:02:17 +0000586static void codeVectorCompare(
587 Parse *pParse, /* Code generator context */
588 Expr *pExpr, /* The comparison operation */
589 int dest, /* Write results into this register */
590 u8 op, /* Comparison operator */
591 u8 p5 /* SQLITE_NULLEQ or zero */
592){
dan71c57db2016-07-09 20:23:55 +0000593 Vdbe *v = pParse->pVdbe;
594 Expr *pLeft = pExpr->pLeft;
595 Expr *pRight = pExpr->pRight;
596 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000597 int i;
598 int regLeft = 0;
599 int regRight = 0;
600 u8 opx = op;
drhec4ccdb2018-12-29 02:26:59 +0000601 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000602 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000603
drhe7375bf2020-03-10 19:24:38 +0000604 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh70d6b832019-12-30 23:50:19 +0000605 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000606 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
607 sqlite3ErrorMsg(pParse, "row value misused");
608 return;
609 }
drhb29e60c2016-09-05 12:02:34 +0000610 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
611 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
612 || pExpr->op==TK_LT || pExpr->op==TK_GT
613 || pExpr->op==TK_LE || pExpr->op==TK_GE
614 );
615 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
616 || (pExpr->op==TK_ISNOT && op==TK_NE) );
617 assert( p5==0 || pExpr->op!=op );
618 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000619
drhb29e60c2016-09-05 12:02:34 +0000620 p5 |= SQLITE_STOREP2;
621 if( opx==TK_LE ) opx = TK_LT;
622 if( opx==TK_GE ) opx = TK_GT;
dan71c57db2016-07-09 20:23:55 +0000623
drhb29e60c2016-09-05 12:02:34 +0000624 regLeft = exprCodeSubselect(pParse, pLeft);
625 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000626
drhb29e60c2016-09-05 12:02:34 +0000627 for(i=0; 1 /*Loop exits by "break"*/; i++){
628 int regFree1 = 0, regFree2 = 0;
629 Expr *pL, *pR;
630 int r1, r2;
631 assert( i>=0 && i<nLeft );
drhb29e60c2016-09-05 12:02:34 +0000632 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
633 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh898c5272019-10-22 00:03:41 +0000634 codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000635 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
636 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
637 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
638 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
639 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
640 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
641 sqlite3ReleaseTempReg(pParse, regFree1);
642 sqlite3ReleaseTempReg(pParse, regFree2);
drhb29e60c2016-09-05 12:02:34 +0000643 if( i==nLeft-1 ){
644 break;
dan71c57db2016-07-09 20:23:55 +0000645 }
drhb29e60c2016-09-05 12:02:34 +0000646 if( opx==TK_EQ ){
647 sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
648 p5 |= SQLITE_KEEPNULL;
649 }else if( opx==TK_NE ){
650 sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
651 p5 |= SQLITE_KEEPNULL;
652 }else{
653 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
654 sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
655 VdbeCoverageIf(v, op==TK_LT);
656 VdbeCoverageIf(v, op==TK_GT);
657 VdbeCoverageIf(v, op==TK_LE);
658 VdbeCoverageIf(v, op==TK_GE);
659 if( i==nLeft-2 ) opx = op;
660 }
dan71c57db2016-07-09 20:23:55 +0000661 }
drhb29e60c2016-09-05 12:02:34 +0000662 sqlite3VdbeResolveLabel(v, addrDone);
dan71c57db2016-07-09 20:23:55 +0000663}
664
danielk19774b5255a2008-06-05 16:47:39 +0000665#if SQLITE_MAX_EXPR_DEPTH>0
666/*
667** Check that argument nHeight is less than or equal to the maximum
668** expression depth allowed. If it is not, leave an error message in
669** pParse.
670*/
drh7d10d5a2008-08-20 16:35:10 +0000671int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000672 int rc = SQLITE_OK;
673 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
674 if( nHeight>mxHeight ){
675 sqlite3ErrorMsg(pParse,
676 "Expression tree is too large (maximum depth %d)", mxHeight
677 );
678 rc = SQLITE_ERROR;
679 }
680 return rc;
681}
682
683/* The following three functions, heightOfExpr(), heightOfExprList()
684** and heightOfSelect(), are used to determine the maximum height
685** of any expression tree referenced by the structure passed as the
686** first argument.
687**
688** If this maximum height is greater than the current value pointed
689** to by pnHeight, the second parameter, then set *pnHeight to that
690** value.
691*/
692static void heightOfExpr(Expr *p, int *pnHeight){
693 if( p ){
694 if( p->nHeight>*pnHeight ){
695 *pnHeight = p->nHeight;
696 }
697 }
698}
699static void heightOfExprList(ExprList *p, int *pnHeight){
700 if( p ){
701 int i;
702 for(i=0; i<p->nExpr; i++){
703 heightOfExpr(p->a[i].pExpr, pnHeight);
704 }
705 }
706}
dan1a3a3082018-01-18 19:00:54 +0000707static void heightOfSelect(Select *pSelect, int *pnHeight){
708 Select *p;
709 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000710 heightOfExpr(p->pWhere, pnHeight);
711 heightOfExpr(p->pHaving, pnHeight);
712 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000713 heightOfExprList(p->pEList, pnHeight);
714 heightOfExprList(p->pGroupBy, pnHeight);
715 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000716 }
717}
718
719/*
720** Set the Expr.nHeight variable in the structure passed as an
721** argument. An expression with no children, Expr.pList or
722** Expr.pSelect member has a height of 1. Any other expression
723** has a height equal to the maximum height of any other
724** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000725**
726** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
727** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000728*/
729static void exprSetHeight(Expr *p){
730 int nHeight = 0;
731 heightOfExpr(p->pLeft, &nHeight);
732 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000733 if( ExprHasProperty(p, EP_xIsSelect) ){
734 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000735 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000736 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000737 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000738 }
danielk19774b5255a2008-06-05 16:47:39 +0000739 p->nHeight = nHeight + 1;
740}
741
742/*
743** Set the Expr.nHeight variable using the exprSetHeight() function. If
744** the height is greater than the maximum allowed expression depth,
745** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000746**
747** Also propagate all EP_Propagate flags from the Expr.x.pList into
748** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000749*/
drh2308ed32015-02-09 16:09:34 +0000750void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000751 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000752 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000753 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000754}
755
756/*
757** Return the maximum height of any expression tree referenced
758** by the select statement passed as an argument.
759*/
760int sqlite3SelectExprHeight(Select *p){
761 int nHeight = 0;
762 heightOfSelect(p, &nHeight);
763 return nHeight;
764}
drh2308ed32015-02-09 16:09:34 +0000765#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
766/*
767** Propagate all EP_Propagate flags from the Expr.x.pList into
768** Expr.flags.
769*/
770void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000771 if( pParse->nErr ) return;
drh2308ed32015-02-09 16:09:34 +0000772 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
773 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
774 }
775}
776#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000777#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
778
drhbe5c89a2004-07-26 00:31:09 +0000779/*
drhb7916a72009-05-27 10:31:29 +0000780** This routine is the core allocator for Expr nodes.
781**
drha76b5df2002-02-23 02:32:10 +0000782** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000783** for this node and for the pToken argument is a single allocation
784** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000785** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000786**
787** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000788** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000789** parameter is ignored if pToken is NULL or if the token does not
790** appear to be quoted. If the quotes were of the form "..." (double-quotes)
791** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000792**
793** Special case: If op==TK_INTEGER and pToken points to a string that
794** can be translated into a 32-bit integer, then the token is not
795** stored in u.zToken. Instead, the integer values is written
796** into u.iValue and the EP_IntValue flag is set. No extra storage
797** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000798*/
drhb7916a72009-05-27 10:31:29 +0000799Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000800 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000801 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000802 const Token *pToken, /* Token argument. Might be NULL */
803 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000804){
drha76b5df2002-02-23 02:32:10 +0000805 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000806 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000807 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000808
drh575fad62016-02-05 13:38:36 +0000809 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000810 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000811 if( op!=TK_INTEGER || pToken->z==0
812 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
813 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000814 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000815 }
drhb7916a72009-05-27 10:31:29 +0000816 }
drh575fad62016-02-05 13:38:36 +0000817 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000818 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000819 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000820 pNew->op = (u8)op;
821 pNew->iAgg = -1;
822 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000823 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000824 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000825 pNew->u.iValue = iValue;
826 }else{
drh33e619f2009-05-28 01:00:55 +0000827 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000828 assert( pToken->z!=0 || pToken->n==0 );
829 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000830 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000831 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000832 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000833 }
drhb7916a72009-05-27 10:31:29 +0000834 }
835 }
836#if SQLITE_MAX_EXPR_DEPTH>0
837 pNew->nHeight = 1;
838#endif
839 }
drha76b5df2002-02-23 02:32:10 +0000840 return pNew;
841}
842
843/*
drhb7916a72009-05-27 10:31:29 +0000844** Allocate a new expression node from a zero-terminated token that has
845** already been dequoted.
846*/
847Expr *sqlite3Expr(
848 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
849 int op, /* Expression opcode */
850 const char *zToken /* Token argument. Might be NULL */
851){
852 Token x;
853 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000854 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000855 return sqlite3ExprAlloc(db, op, &x, 0);
856}
857
858/*
859** Attach subtrees pLeft and pRight to the Expr node pRoot.
860**
861** If pRoot==NULL that means that a memory allocation error has occurred.
862** In that case, delete the subtrees pLeft and pRight.
863*/
864void sqlite3ExprAttachSubtrees(
865 sqlite3 *db,
866 Expr *pRoot,
867 Expr *pLeft,
868 Expr *pRight
869){
870 if( pRoot==0 ){
871 assert( db->mallocFailed );
872 sqlite3ExprDelete(db, pLeft);
873 sqlite3ExprDelete(db, pRight);
874 }else{
875 if( pRight ){
876 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000877 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000878 }
879 if( pLeft ){
880 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000881 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000882 }
883 exprSetHeight(pRoot);
884 }
885}
886
887/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000888** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000889**
drhbf664462009-06-19 18:32:54 +0000890** One or both of the subtrees can be NULL. Return a pointer to the new
891** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
892** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000893*/
drh17435752007-08-16 04:30:38 +0000894Expr *sqlite3PExpr(
895 Parse *pParse, /* Parsing context */
896 int op, /* Expression opcode */
897 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000898 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000899){
drh5fb52ca2012-03-31 02:34:35 +0000900 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000901 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
902 if( p ){
903 memset(p, 0, sizeof(Expr));
904 p->op = op & 0xff;
905 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000906 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000907 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000908 }else{
909 sqlite3ExprDelete(pParse->db, pLeft);
910 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000911 }
drh4e0cff62004-11-05 05:10:28 +0000912 return p;
913}
914
915/*
drh08de4f72016-04-11 01:06:47 +0000916** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
917** do a memory allocation failure) then delete the pSelect object.
918*/
919void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
920 if( pExpr ){
921 pExpr->x.pSelect = pSelect;
922 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
923 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
924 }else{
925 assert( pParse->db->mallocFailed );
926 sqlite3SelectDelete(pParse->db, pSelect);
927 }
928}
929
930
931/*
drh91bb0ee2004-09-01 03:06:34 +0000932** Join two expressions using an AND operator. If either expression is
933** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000934**
935** If one side or the other of the AND is known to be false, then instead
936** of returning an AND expression, just return a constant expression with
937** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000938*/
drhd5c851c2019-04-19 13:38:34 +0000939Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
940 sqlite3 *db = pParse->db;
941 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000942 return pRight;
943 }else if( pRight==0 ){
944 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000945 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
946 && !IN_RENAME_OBJECT
947 ){
948 sqlite3ExprDelete(db, pLeft);
949 sqlite3ExprDelete(db, pRight);
drh5776ee52019-09-23 12:38:10 +0000950 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000951 }else{
drhd5c851c2019-04-19 13:38:34 +0000952 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000953 }
954}
955
956/*
957** Construct a new expression node for a function with multiple
958** arguments.
959*/
drh954733b2018-07-27 23:33:16 +0000960Expr *sqlite3ExprFunction(
961 Parse *pParse, /* Parsing context */
962 ExprList *pList, /* Argument list */
963 Token *pToken, /* Name of the function */
964 int eDistinct /* SF_Distinct or SF_ALL or 0 */
965){
drha76b5df2002-02-23 02:32:10 +0000966 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000967 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000968 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000969 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000970 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000971 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000972 return 0;
973 }
drh954733b2018-07-27 23:33:16 +0000974 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
975 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
976 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000977 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000978 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000979 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000980 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000981 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000982 return pNew;
983}
984
985/*
drh0dfa5252020-01-08 17:28:19 +0000986** Check to see if a function is usable according to current access
987** rules:
988**
989** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
990**
991** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
992** top-level SQL
993**
994** If the function is not usable, create an error.
995*/
996void sqlite3ExprFunctionUsable(
997 Parse *pParse, /* Parsing and code generating context */
998 Expr *pExpr, /* The function invocation */
999 FuncDef *pDef /* The function being invoked */
1000){
1001 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001002 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1003 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001004 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1005 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1006 ){
1007 /* Functions prohibited in triggers and views if:
1008 ** (1) tagged with SQLITE_DIRECTONLY
1009 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1010 ** is tagged with SQLITE_FUNC_UNSAFE) and
1011 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1012 ** that the schema is possibly tainted).
1013 */
1014 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1015 }
1016 }
1017}
1018
1019/*
drhfa6bc002004-09-07 16:19:52 +00001020** Assign a variable number to an expression that encodes a wildcard
1021** in the original SQL statement.
1022**
1023** Wildcards consisting of a single "?" are assigned the next sequential
1024** variable number.
1025**
1026** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001027** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001028** the SQL statement comes from an external source.
1029**
drh51f49f12009-05-21 20:41:32 +00001030** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001031** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001032** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001033** assigned.
1034*/
drhde25a882016-10-03 15:28:24 +00001035void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001036 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001037 const char *z;
drhf326d662016-12-23 13:30:53 +00001038 ynVar x;
drh17435752007-08-16 04:30:38 +00001039
drhfa6bc002004-09-07 16:19:52 +00001040 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001041 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001042 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001043 assert( z!=0 );
1044 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001045 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001046 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001047 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001048 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001049 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001050 }else{
drhf326d662016-12-23 13:30:53 +00001051 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001052 if( z[0]=='?' ){
1053 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1054 ** use it as the variable number */
1055 i64 i;
drh18814df2017-01-31 03:52:34 +00001056 int bOk;
1057 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1058 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1059 bOk = 1;
1060 }else{
1061 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1062 }
drh124c0b42011-06-01 18:15:55 +00001063 testcase( i==0 );
1064 testcase( i==1 );
1065 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1066 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1067 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1068 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1069 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001070 return;
drhfa6bc002004-09-07 16:19:52 +00001071 }
drh8e74e7b2017-01-31 12:41:48 +00001072 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001073 if( x>pParse->nVar ){
1074 pParse->nVar = (int)x;
1075 doAdd = 1;
1076 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1077 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001078 }
1079 }else{
1080 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1081 ** number as the prior appearance of the same name, or if the name
1082 ** has never appeared before, reuse the same variable number
1083 */
drh9bf755c2016-12-23 03:59:31 +00001084 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1085 if( x==0 ){
1086 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001087 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001088 }
drhfa6bc002004-09-07 16:19:52 +00001089 }
drhf326d662016-12-23 13:30:53 +00001090 if( doAdd ){
1091 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1092 }
1093 }
1094 pExpr->iColumn = x;
1095 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001096 sqlite3ErrorMsg(pParse, "too many SQL variables");
1097 }
drhfa6bc002004-09-07 16:19:52 +00001098}
1099
1100/*
danf6963f92009-11-23 14:39:14 +00001101** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001102*/
drh4f0010b2016-04-11 14:49:39 +00001103static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1104 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001105 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1106 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001107
1108 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1109 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001110 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001111#ifdef SQLITE_DEBUG
1112 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1113 assert( p->pLeft==0 );
1114 assert( p->pRight==0 );
1115 assert( p->x.pSelect==0 );
1116 }
1117#endif
1118 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001119 /* The Expr.x union is never used at the same time as Expr.pRight */
1120 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001121 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001122 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001123 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001124 sqlite3ExprDeleteNN(db, p->pRight);
1125 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001126 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001127 sqlite3SelectDelete(db, p->x.pSelect);
1128 }else{
1129 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001130#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001131 if( ExprHasProperty(p, EP_WinFunc) ){
1132 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001133 }
dan6ba7ab02019-07-02 11:56:47 +00001134#endif
dan8117f112019-07-10 20:16:53 +00001135 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001136 }
drh209bc522016-09-23 21:36:24 +00001137 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001138 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001139 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001140 }
drha2e00042002-01-22 03:13:42 +00001141}
drh4f0010b2016-04-11 14:49:39 +00001142void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1143 if( p ) sqlite3ExprDeleteNN(db, p);
1144}
drha2e00042002-01-22 03:13:42 +00001145
drh8e34e402019-06-11 10:43:56 +00001146/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1147** expression.
1148*/
1149void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1150 if( p ){
1151 if( IN_RENAME_OBJECT ){
1152 sqlite3RenameExprUnmap(pParse, p);
1153 }
1154 sqlite3ExprDeleteNN(pParse->db, p);
1155 }
1156}
1157
drhd2687b72005-08-12 22:56:09 +00001158/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001159** Return the number of bytes allocated for the expression structure
1160** passed as the first argument. This is always one of EXPR_FULLSIZE,
1161** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1162*/
1163static int exprStructSize(Expr *p){
1164 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001165 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1166 return EXPR_FULLSIZE;
1167}
1168
1169/*
drh33e619f2009-05-28 01:00:55 +00001170** The dupedExpr*Size() routines each return the number of bytes required
1171** to store a copy of an expression or expression tree. They differ in
1172** how much of the tree is measured.
1173**
1174** dupedExprStructSize() Size of only the Expr structure
1175** dupedExprNodeSize() Size of Expr + space for token
1176** dupedExprSize() Expr + token + subtree components
1177**
1178***************************************************************************
1179**
1180** The dupedExprStructSize() function returns two values OR-ed together:
1181** (1) the space required for a copy of the Expr structure only and
1182** (2) the EP_xxx flags that indicate what the structure size should be.
1183** The return values is always one of:
1184**
1185** EXPR_FULLSIZE
1186** EXPR_REDUCEDSIZE | EP_Reduced
1187** EXPR_TOKENONLYSIZE | EP_TokenOnly
1188**
1189** The size of the structure can be found by masking the return value
1190** of this routine with 0xfff. The flags can be found by masking the
1191** return value with EP_Reduced|EP_TokenOnly.
1192**
1193** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1194** (unreduced) Expr objects as they or originally constructed by the parser.
1195** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001196** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001197** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001198** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001199** to reduce a pristine expression tree from the parser. The implementation
1200** of dupedExprStructSize() contain multiple assert() statements that attempt
1201** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001202*/
1203static int dupedExprStructSize(Expr *p, int flags){
1204 int nSize;
drh33e619f2009-05-28 01:00:55 +00001205 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001206 assert( EXPR_FULLSIZE<=0xfff );
1207 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001208 if( 0==flags || p->op==TK_SELECT_COLUMN
1209#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001210 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001211#endif
1212 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001213 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001214 }else{
drhc5cd1242013-09-12 16:50:49 +00001215 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001216 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001217 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001218 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001219 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001220 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1221 }else{
drhaecd8022013-09-13 18:15:15 +00001222 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001223 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1224 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001225 }
1226 return nSize;
1227}
1228
1229/*
drh33e619f2009-05-28 01:00:55 +00001230** This function returns the space in bytes required to store the copy
1231** of the Expr structure and a copy of the Expr.u.zToken string (if that
1232** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001233*/
1234static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001235 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1236 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001237 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001238 }
danielk1977bc739712009-03-23 04:33:32 +00001239 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001240}
1241
1242/*
1243** Return the number of bytes required to create a duplicate of the
1244** expression passed as the first argument. The second argument is a
1245** mask containing EXPRDUP_XXX flags.
1246**
1247** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001248** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001249**
1250** If the EXPRDUP_REDUCE flag is set, then the return value includes
1251** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1252** and Expr.pRight variables (but not for any structures pointed to or
1253** descended from the Expr.x.pList or Expr.x.pSelect variables).
1254*/
1255static int dupedExprSize(Expr *p, int flags){
1256 int nByte = 0;
1257 if( p ){
1258 nByte = dupedExprNodeSize(p, flags);
1259 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001260 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001261 }
1262 }
1263 return nByte;
1264}
1265
1266/*
1267** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1268** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001269** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001270** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001271** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001272** portion of the buffer copied into by this function.
1273*/
drh3c194692016-04-11 16:43:43 +00001274static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1275 Expr *pNew; /* Value to return */
1276 u8 *zAlloc; /* Memory space from which to build Expr object */
1277 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1278
drh575fad62016-02-05 13:38:36 +00001279 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001280 assert( p );
1281 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1282 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001283
drh3c194692016-04-11 16:43:43 +00001284 /* Figure out where to write the new Expr structure. */
1285 if( pzBuffer ){
1286 zAlloc = *pzBuffer;
1287 staticFlag = EP_Static;
1288 }else{
1289 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1290 staticFlag = 0;
1291 }
1292 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001293
drh3c194692016-04-11 16:43:43 +00001294 if( pNew ){
1295 /* Set nNewSize to the size allocated for the structure pointed to
1296 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1297 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1298 ** by the copy of the p->u.zToken string (if any).
1299 */
1300 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1301 const int nNewSize = nStructSize & 0xfff;
1302 int nToken;
1303 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1304 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001305 }else{
drh3c194692016-04-11 16:43:43 +00001306 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001307 }
drh3c194692016-04-11 16:43:43 +00001308 if( dupFlags ){
1309 assert( ExprHasProperty(p, EP_Reduced)==0 );
1310 memcpy(zAlloc, p, nNewSize);
1311 }else{
1312 u32 nSize = (u32)exprStructSize(p);
1313 memcpy(zAlloc, p, nSize);
1314 if( nSize<EXPR_FULLSIZE ){
1315 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1316 }
1317 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001318
drh3c194692016-04-11 16:43:43 +00001319 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1320 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1321 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1322 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001323 ExprClearVVAProperties(pNew);
1324 if( dupFlags ){
1325 ExprSetVVAProperty(pNew, EP_Immutable);
1326 }
drh3c194692016-04-11 16:43:43 +00001327
1328 /* Copy the p->u.zToken string, if any. */
1329 if( nToken ){
1330 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1331 memcpy(zToken, p->u.zToken, nToken);
1332 }
1333
drh209bc522016-09-23 21:36:24 +00001334 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001335 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1336 if( ExprHasProperty(p, EP_xIsSelect) ){
1337 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001338 }else{
drh3c194692016-04-11 16:43:43 +00001339 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001340 }
drh3c194692016-04-11 16:43:43 +00001341 }
1342
1343 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001344 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001345 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001346 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001347 pNew->pLeft = p->pLeft ?
1348 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1349 pNew->pRight = p->pRight ?
1350 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001351 }
dan67a9b8e2018-06-22 20:51:35 +00001352#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001353 if( ExprHasProperty(p, EP_WinFunc) ){
1354 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1355 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001356 }
dan67a9b8e2018-06-22 20:51:35 +00001357#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001358 if( pzBuffer ){
1359 *pzBuffer = zAlloc;
1360 }
1361 }else{
drh209bc522016-09-23 21:36:24 +00001362 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001363 if( pNew->op==TK_SELECT_COLUMN ){
1364 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001365 assert( p->iColumn==0 || p->pRight==0 );
1366 assert( p->pRight==0 || p->pRight==p->pLeft );
drh98542602016-08-20 17:00:16 +00001367 }else{
1368 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1369 }
drh3c194692016-04-11 16:43:43 +00001370 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001371 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001372 }
1373 }
1374 return pNew;
1375}
1376
1377/*
danbfe31e72014-01-15 14:17:31 +00001378** Create and return a deep copy of the object passed as the second
1379** argument. If an OOM condition is encountered, NULL is returned
1380** and the db->mallocFailed flag set.
1381*/
daneede6a52014-01-15 19:42:23 +00001382#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001383static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001384 With *pRet = 0;
1385 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001386 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001387 pRet = sqlite3DbMallocZero(db, nByte);
1388 if( pRet ){
1389 int i;
1390 pRet->nCte = p->nCte;
1391 for(i=0; i<p->nCte; i++){
1392 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1393 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1394 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1395 }
1396 }
1397 }
1398 return pRet;
1399}
daneede6a52014-01-15 19:42:23 +00001400#else
1401# define withDup(x,y) 0
1402#endif
dan4e9119d2014-01-13 15:12:23 +00001403
drha8389972018-12-06 22:04:19 +00001404#ifndef SQLITE_OMIT_WINDOWFUNC
1405/*
1406** The gatherSelectWindows() procedure and its helper routine
1407** gatherSelectWindowsCallback() are used to scan all the expressions
1408** an a newly duplicated SELECT statement and gather all of the Window
1409** objects found there, assembling them onto the linked list at Select->pWin.
1410*/
1411static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001412 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001413 Select *pSelect = pWalker->u.pSelect;
1414 Window *pWin = pExpr->y.pWin;
1415 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001416 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001417 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001418 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001419 }
1420 return WRC_Continue;
1421}
drha37b6a52018-12-06 22:12:18 +00001422static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1423 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1424}
drha8389972018-12-06 22:04:19 +00001425static void gatherSelectWindows(Select *p){
1426 Walker w;
1427 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001428 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1429 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001430 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001431 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001432 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001433}
1434#endif
1435
1436
drha76b5df2002-02-23 02:32:10 +00001437/*
drhff78bd22002-02-27 01:47:11 +00001438** The following group of routines make deep copies of expressions,
1439** expression lists, ID lists, and select statements. The copies can
1440** be deleted (by being passed to their respective ...Delete() routines)
1441** without effecting the originals.
1442**
danielk19774adee202004-05-08 08:23:19 +00001443** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1444** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001445** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001446**
drhad3cab52002-05-24 02:04:32 +00001447** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001448**
drhb7916a72009-05-27 10:31:29 +00001449** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001450** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1451** truncated version of the usual Expr structure that will be stored as
1452** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001453*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001454Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001455 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001456 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001457}
danielk19776ab3a2e2009-02-19 14:39:25 +00001458ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001459 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001460 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001461 int i;
drhb1637482017-01-03 00:27:16 +00001462 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001463 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001464 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001465 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001466 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001467 pNew->nExpr = p->nExpr;
drh43606172017-04-05 11:32:13 +00001468 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001469 pOldItem = p->a;
1470 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001471 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001472 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001473 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001474 if( pOldExpr
1475 && pOldExpr->op==TK_SELECT_COLUMN
1476 && (pNewExpr = pItem->pExpr)!=0
1477 ){
1478 assert( pNewExpr->iColumn==0 || i>0 );
1479 if( pNewExpr->iColumn==0 ){
1480 assert( pOldExpr->pLeft==pOldExpr->pRight );
drhb1637482017-01-03 00:27:16 +00001481 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1482 }else{
1483 assert( i>0 );
1484 assert( pItem[-1].pExpr!=0 );
1485 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1486 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1487 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001488 }
1489 }
drh41cee662019-12-12 20:22:34 +00001490 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001491 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001492 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001493 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001494 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001495 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001496 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001497 }
1498 return pNew;
1499}
danielk197793758c82005-01-21 08:13:14 +00001500
1501/*
1502** If cursors, triggers, views and subqueries are all omitted from
1503** the build, then none of the following routines, except for
1504** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1505** called with a NULL argument.
1506*/
danielk19776a67fe82005-02-04 04:07:16 +00001507#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1508 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001509SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001510 SrcList *pNew;
1511 int i;
drh113088e2003-03-20 01:16:58 +00001512 int nByte;
drh575fad62016-02-05 13:38:36 +00001513 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001514 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001515 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001516 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001517 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001518 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001519 for(i=0; i<p->nSrc; i++){
drh4efc4752004-01-16 15:55:37 +00001520 struct SrcList_item *pNewItem = &pNew->a[i];
1521 struct SrcList_item *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001522 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001523 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001524 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1525 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1526 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001527 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001528 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001529 pNewItem->addrFillSub = pOldItem->addrFillSub;
1530 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001531 if( pNewItem->fg.isIndexedBy ){
1532 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1533 }
1534 pNewItem->pIBIndex = pOldItem->pIBIndex;
1535 if( pNewItem->fg.isTabFunc ){
1536 pNewItem->u1.pFuncArg =
1537 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1538 }
drhed8a3bb2005-06-06 21:19:56 +00001539 pTab = pNewItem->pTab = pOldItem->pTab;
1540 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001541 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001542 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001543 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1544 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001545 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001546 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001547 }
1548 return pNew;
1549}
drh17435752007-08-16 04:30:38 +00001550IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001551 IdList *pNew;
1552 int i;
drh575fad62016-02-05 13:38:36 +00001553 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001554 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001555 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001556 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001557 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001558 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001559 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001560 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001561 return 0;
1562 }
drh6c535152012-02-02 03:38:30 +00001563 /* Note that because the size of the allocation for p->a[] is not
1564 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1565 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001566 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001567 struct IdList_item *pNewItem = &pNew->a[i];
1568 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001569 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001570 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001571 }
1572 return pNew;
1573}
dana7466202017-02-03 14:44:52 +00001574Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1575 Select *pRet = 0;
1576 Select *pNext = 0;
1577 Select **pp = &pRet;
1578 Select *p;
1579
drh575fad62016-02-05 13:38:36 +00001580 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001581 for(p=pDup; p; p=p->pPrior){
1582 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1583 if( pNew==0 ) break;
1584 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1585 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1586 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1587 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1588 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1589 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1590 pNew->op = p->op;
1591 pNew->pNext = pNext;
1592 pNew->pPrior = 0;
1593 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001594 pNew->iLimit = 0;
1595 pNew->iOffset = 0;
1596 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1597 pNew->addrOpenEphm[0] = -1;
1598 pNew->addrOpenEphm[1] = -1;
1599 pNew->nSelectRow = p->nSelectRow;
1600 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001601#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001602 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001603 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001604 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001605#endif
drhfef37762018-07-10 19:48:35 +00001606 pNew->selId = p->selId;
dana7466202017-02-03 14:44:52 +00001607 *pp = pNew;
1608 pp = &pNew->pPrior;
1609 pNext = pNew;
1610 }
1611
1612 return pRet;
drhff78bd22002-02-27 01:47:11 +00001613}
danielk197793758c82005-01-21 08:13:14 +00001614#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001615Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001616 assert( p==0 );
1617 return 0;
1618}
1619#endif
drhff78bd22002-02-27 01:47:11 +00001620
1621
1622/*
drha76b5df2002-02-23 02:32:10 +00001623** Add a new element to the end of an expression list. If pList is
1624** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001625**
drha19543f2017-09-15 15:17:48 +00001626** The pList argument must be either NULL or a pointer to an ExprList
1627** obtained from a prior call to sqlite3ExprListAppend(). This routine
1628** may not be used with an ExprList obtained from sqlite3ExprListDup().
1629** Reason: This routine assumes that the number of slots in pList->a[]
1630** is a power of two. That is true for sqlite3ExprListAppend() returns
1631** but is not necessarily true from the return value of sqlite3ExprListDup().
1632**
drhb7916a72009-05-27 10:31:29 +00001633** If a memory allocation error occurs, the entire list is freed and
1634** NULL is returned. If non-NULL is returned, then it is guaranteed
1635** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001636*/
drh17435752007-08-16 04:30:38 +00001637ExprList *sqlite3ExprListAppend(
1638 Parse *pParse, /* Parsing context */
1639 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001640 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001641){
drh43606172017-04-05 11:32:13 +00001642 struct ExprList_item *pItem;
drh17435752007-08-16 04:30:38 +00001643 sqlite3 *db = pParse->db;
drh575fad62016-02-05 13:38:36 +00001644 assert( db!=0 );
drha76b5df2002-02-23 02:32:10 +00001645 if( pList==0 ){
drh575fad62016-02-05 13:38:36 +00001646 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
drha76b5df2002-02-23 02:32:10 +00001647 if( pList==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001648 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001649 }
drhc263f7c2016-01-18 13:18:54 +00001650 pList->nExpr = 0;
drha19543f2017-09-15 15:17:48 +00001651 }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
drh43606172017-04-05 11:32:13 +00001652 ExprList *pNew;
1653 pNew = sqlite3DbRealloc(db, pList,
drh0aa32312019-04-13 04:01:12 +00001654 sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
drh43606172017-04-05 11:32:13 +00001655 if( pNew==0 ){
danielk1977d5d56522005-03-16 12:15:20 +00001656 goto no_mem;
drha76b5df2002-02-23 02:32:10 +00001657 }
drh43606172017-04-05 11:32:13 +00001658 pList = pNew;
drha76b5df2002-02-23 02:32:10 +00001659 }
drh43606172017-04-05 11:32:13 +00001660 pItem = &pList->a[pList->nExpr++];
drh41cee662019-12-12 20:22:34 +00001661 assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
drha8b97932017-05-31 02:58:30 +00001662 assert( offsetof(struct ExprList_item,pExpr)==0 );
drh41cee662019-12-12 20:22:34 +00001663 memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
drh43606172017-04-05 11:32:13 +00001664 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001665 return pList;
danielk1977d5d56522005-03-16 12:15:20 +00001666
1667no_mem:
1668 /* Avoid leaking memory if malloc has failed. */
drh633e6d52008-07-28 19:34:53 +00001669 sqlite3ExprDelete(db, pExpr);
1670 sqlite3ExprListDelete(db, pList);
danielk1977d5d56522005-03-16 12:15:20 +00001671 return 0;
drha76b5df2002-02-23 02:32:10 +00001672}
1673
1674/*
drh8762ec12016-08-20 01:06:22 +00001675** pColumns and pExpr form a vector assignment which is part of the SET
1676** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001677**
1678** (a,b,c) = (expr1,expr2,expr3)
1679** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1680**
1681** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001682** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001683** TK_SELECT_COLUMN expressions.
1684*/
1685ExprList *sqlite3ExprListAppendVector(
1686 Parse *pParse, /* Parsing context */
1687 ExprList *pList, /* List to which to append. Might be NULL */
1688 IdList *pColumns, /* List of names of LHS of the assignment */
1689 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1690){
1691 sqlite3 *db = pParse->db;
1692 int n;
1693 int i;
drh66860af2016-08-23 18:30:10 +00001694 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001695 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1696 ** exit prior to this routine being invoked */
1697 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001698 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001699
1700 /* If the RHS is a vector, then we can immediately check to see that
1701 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1702 ** wildcards ("*") in the result set of the SELECT must be expanded before
1703 ** we can do the size check, so defer the size check until code generation.
1704 */
1705 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001706 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1707 pColumns->nId, n);
1708 goto vector_append_error;
1709 }
drh966e2912017-01-03 02:58:01 +00001710
1711 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001712 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001713 assert( pSubExpr!=0 || db->mallocFailed );
1714 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1715 if( pSubExpr==0 ) continue;
1716 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001717 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1718 if( pList ){
drh66860af2016-08-23 18:30:10 +00001719 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001720 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001721 pColumns->a[i].zName = 0;
1722 }
1723 }
drh966e2912017-01-03 02:58:01 +00001724
drhffe28052017-05-06 18:09:36 +00001725 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001726 Expr *pFirst = pList->a[iFirst].pExpr;
1727 assert( pFirst!=0 );
1728 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001729
drhf4dd26c2017-04-05 11:49:06 +00001730 /* Store the SELECT statement in pRight so it will be deleted when
1731 ** sqlite3ExprListDelete() is called */
1732 pFirst->pRight = pExpr;
1733 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001734
drhf4dd26c2017-04-05 11:49:06 +00001735 /* Remember the size of the LHS in iTable so that we can check that
1736 ** the RHS and LHS sizes match during code generation. */
1737 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001738 }
1739
1740vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001741 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001742 sqlite3IdListDelete(db, pColumns);
1743 return pList;
1744}
1745
1746/*
drhbc622bc2015-08-24 15:39:42 +00001747** Set the sort order for the last element on the given ExprList.
1748*/
dan6e118922019-08-12 16:36:38 +00001749void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001750 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001751 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001752 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001753
1754 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1755 assert( iSortOrder==SQLITE_SO_UNDEFINED
1756 || iSortOrder==SQLITE_SO_ASC
1757 || iSortOrder==SQLITE_SO_DESC
1758 );
1759 assert( eNulls==SQLITE_SO_UNDEFINED
1760 || eNulls==SQLITE_SO_ASC
1761 || eNulls==SQLITE_SO_DESC
1762 );
1763
dan9105fd52019-08-19 17:26:32 +00001764 pItem = &p->a[p->nExpr-1];
1765 assert( pItem->bNulls==0 );
1766 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1767 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001768 }
dan9105fd52019-08-19 17:26:32 +00001769 pItem->sortFlags = (u8)iSortOrder;
1770
1771 if( eNulls!=SQLITE_SO_UNDEFINED ){
1772 pItem->bNulls = 1;
1773 if( iSortOrder!=eNulls ){
1774 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1775 }
drhbc622bc2015-08-24 15:39:42 +00001776 }
drhbc622bc2015-08-24 15:39:42 +00001777}
1778
1779/*
drh41cee662019-12-12 20:22:34 +00001780** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001781** on the expression list.
1782**
1783** pList might be NULL following an OOM error. But pName should never be
1784** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1785** is set.
1786*/
1787void sqlite3ExprListSetName(
1788 Parse *pParse, /* Parsing context */
1789 ExprList *pList, /* List to which to add the span. */
1790 Token *pName, /* Name to be added */
1791 int dequote /* True to cause the name to be dequoted */
1792){
1793 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001794 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001795 if( pList ){
1796 struct ExprList_item *pItem;
1797 assert( pList->nExpr>0 );
1798 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001799 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001800 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001801 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001802 if( dequote ){
1803 /* If dequote==0, then pName->z does not point to part of a DDL
1804 ** statement handled by the parser. And so no token need be added
1805 ** to the token-map. */
1806 sqlite3Dequote(pItem->zEName);
1807 if( IN_RENAME_OBJECT ){
1808 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1809 }
dan5be60c52018-08-15 20:28:39 +00001810 }
drhb7916a72009-05-27 10:31:29 +00001811 }
1812}
1813
1814/*
1815** Set the ExprList.a[].zSpan element of the most recently added item
1816** on the expression list.
1817**
1818** pList might be NULL following an OOM error. But pSpan should never be
1819** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1820** is set.
1821*/
1822void sqlite3ExprListSetSpan(
1823 Parse *pParse, /* Parsing context */
1824 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001825 const char *zStart, /* Start of the span */
1826 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001827){
1828 sqlite3 *db = pParse->db;
1829 assert( pList!=0 || db->mallocFailed!=0 );
1830 if( pList ){
1831 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1832 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001833 if( pItem->zEName==0 ){
1834 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1835 pItem->eEName = ENAME_SPAN;
1836 }
drhb7916a72009-05-27 10:31:29 +00001837 }
1838}
1839
1840/*
danielk19777a15a4b2007-05-08 17:54:43 +00001841** If the expression list pEList contains more than iLimit elements,
1842** leave an error message in pParse.
1843*/
1844void sqlite3ExprListCheckLength(
1845 Parse *pParse,
1846 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001847 const char *zObject
1848){
drhb1a6c3c2008-03-20 16:30:17 +00001849 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001850 testcase( pEList && pEList->nExpr==mx );
1851 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001852 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001853 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1854 }
1855}
1856
1857/*
drha76b5df2002-02-23 02:32:10 +00001858** Delete an entire expression list.
1859*/
drhaffa8552016-04-11 18:25:05 +00001860static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001861 int i = pList->nExpr;
1862 struct ExprList_item *pItem = pList->a;
1863 assert( pList->nExpr>0 );
1864 do{
drh633e6d52008-07-28 19:34:53 +00001865 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001866 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001867 pItem++;
1868 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001869 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001870}
drhaffa8552016-04-11 18:25:05 +00001871void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1872 if( pList ) exprListDeleteNN(db, pList);
1873}
drha76b5df2002-02-23 02:32:10 +00001874
1875/*
drh2308ed32015-02-09 16:09:34 +00001876** Return the bitwise-OR of all Expr.flags fields in the given
1877** ExprList.
drh885a5b02015-02-09 15:21:36 +00001878*/
drh2308ed32015-02-09 16:09:34 +00001879u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001880 int i;
drh2308ed32015-02-09 16:09:34 +00001881 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001882 assert( pList!=0 );
1883 for(i=0; i<pList->nExpr; i++){
1884 Expr *pExpr = pList->a[i].pExpr;
1885 assert( pExpr!=0 );
1886 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001887 }
drh2308ed32015-02-09 16:09:34 +00001888 return m;
drh885a5b02015-02-09 15:21:36 +00001889}
1890
1891/*
drh7e6f9802017-09-04 00:33:04 +00001892** This is a SELECT-node callback for the expression walker that
1893** always "fails". By "fail" in this case, we mean set
1894** pWalker->eCode to zero and abort.
1895**
1896** This callback is used by multiple expression walkers.
1897*/
1898int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1899 UNUSED_PARAMETER(NotUsed);
1900 pWalker->eCode = 0;
1901 return WRC_Abort;
1902}
1903
1904/*
drh0cbec592020-01-03 02:20:37 +00001905** Check the input string to see if it is "true" or "false" (in any case).
1906**
1907** If the string is.... Return
1908** "true" EP_IsTrue
1909** "false" EP_IsFalse
1910** anything else 0
1911*/
1912u32 sqlite3IsTrueOrFalse(const char *zIn){
1913 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1914 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1915 return 0;
1916}
1917
1918
1919/*
drh171d16b2018-02-26 20:15:54 +00001920** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001921** then convert it into an TK_TRUEFALSE term. Return non-zero if
1922** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001923*/
1924int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001925 u32 v;
drh171d16b2018-02-26 20:15:54 +00001926 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001927 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001928 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001929 ){
1930 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00001931 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00001932 return 1;
1933 }
1934 return 0;
1935}
1936
drh43c4ac82018-02-26 21:26:27 +00001937/*
drh96acafb2018-02-27 14:49:25 +00001938** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00001939** and 0 if it is FALSE.
1940*/
drh96acafb2018-02-27 14:49:25 +00001941int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00001942 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00001943 assert( pExpr->op==TK_TRUEFALSE );
1944 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
1945 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
1946 return pExpr->u.zToken[4]==0;
1947}
1948
drh17180fc2019-04-19 17:26:19 +00001949/*
1950** If pExpr is an AND or OR expression, try to simplify it by eliminating
1951** terms that are always true or false. Return the simplified expression.
1952** Or return the original expression if no simplification is possible.
1953**
1954** Examples:
1955**
1956** (x<10) AND true => (x<10)
1957** (x<10) AND false => false
1958** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
1959** (x<10) AND (y=22 OR true) => (x<10)
1960** (y=22) OR true => true
1961*/
1962Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
1963 assert( pExpr!=0 );
1964 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
1965 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
1966 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
1967 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
1968 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
1969 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
1970 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
1971 }
1972 }
1973 return pExpr;
1974}
1975
drh171d16b2018-02-26 20:15:54 +00001976
1977/*
drh059b2d52014-10-24 19:28:09 +00001978** These routines are Walker callbacks used to check expressions to
1979** see if they are "constant" for some definition of constant. The
1980** Walker.eCode value determines the type of "constant" we are looking
1981** for.
drh73b211a2005-01-18 04:00:42 +00001982**
drh7d10d5a2008-08-20 16:35:10 +00001983** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00001984**
drh059b2d52014-10-24 19:28:09 +00001985** sqlite3ExprIsConstant() pWalker->eCode==1
1986** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00001987** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00001988** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00001989**
drh059b2d52014-10-24 19:28:09 +00001990** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1991** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00001992**
drh014fff22020-01-08 22:22:36 +00001993** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1994** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00001995** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00001996** when processing a new CREATE TABLE statement. A bound parameter raises
1997** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00001998** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00001999** contain a bound parameter because they were generated by older versions
2000** of SQLite to be parsed by newer versions of SQLite without raising a
2001** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002002*/
drh7d10d5a2008-08-20 16:35:10 +00002003static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002004
drh059b2d52014-10-24 19:28:09 +00002005 /* If pWalker->eCode is 2 then any term of the expression that comes from
2006 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002007 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002008 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2009 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002010 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002011 }
2012
drh626a8792005-01-17 22:08:19 +00002013 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002014 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002015 ** and either pWalker->eCode==4 or 5 or the function has the
2016 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002017 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002018 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2019 && !ExprHasProperty(pExpr, EP_WinFunc)
2020 ){
drh014fff22020-01-08 22:22:36 +00002021 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002022 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002023 }else{
2024 pWalker->eCode = 0;
2025 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002026 }
drh626a8792005-01-17 22:08:19 +00002027 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002028 /* Convert "true" or "false" in a DEFAULT clause into the
2029 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002030 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002031 return WRC_Prune;
2032 }
drh08b92082020-08-10 14:18:00 +00002033 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002034 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002035 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002036 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002037 testcase( pExpr->op==TK_ID );
2038 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002039 testcase( pExpr->op==TK_AGG_FUNCTION );
2040 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002041 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002042 return WRC_Continue;
2043 }
drh059b2d52014-10-24 19:28:09 +00002044 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2045 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002046 }
drh08b92082020-08-10 14:18:00 +00002047 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002048 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002049 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002050 case TK_DOT:
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 );
drh74e0d962020-06-13 03:18:21 +00002053 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002054 pWalker->eCode = 0;
2055 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002056 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002057 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002058 /* Silently convert bound parameters that appear inside of CREATE
2059 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002060 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002061 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002062 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002063 /* A bound parameter in a CREATE statement that originates from
2064 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002065 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002066 return WRC_Abort;
2067 }
drh08b92082020-08-10 14:18:00 +00002068 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002069 default:
drh6e341b92018-04-17 18:50:40 +00002070 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2071 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002072 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002073 }
2074}
drh059b2d52014-10-24 19:28:09 +00002075static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002076 Walker w;
drh059b2d52014-10-24 19:28:09 +00002077 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002078 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002079 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002080#ifdef SQLITE_DEBUG
2081 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2082#endif
drh059b2d52014-10-24 19:28:09 +00002083 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002084 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002085 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002086}
drh626a8792005-01-17 22:08:19 +00002087
2088/*
drh059b2d52014-10-24 19:28:09 +00002089** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002090** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002091**
2092** For the purposes of this function, a double-quoted string (ex: "abc")
2093** is considered a variable but a single-quoted string (ex: 'abc') is
2094** a constant.
drhfef52082000-06-06 01:50:43 +00002095*/
danielk19774adee202004-05-08 08:23:19 +00002096int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002097 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002098}
2099
2100/*
drh07aded62018-07-28 16:24:08 +00002101** Walk an expression tree. Return non-zero if
2102**
2103** (1) the expression is constant, and
2104** (2) the expression does originate in the ON or USING clause
2105** of a LEFT JOIN, and
2106** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2107** operands created by the constant propagation optimization.
2108**
2109** When this routine returns true, it indicates that the expression
2110** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002111** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002112*/
2113int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002114 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002115}
2116
2117/*
drhfcb9f4f2015-06-01 18:13:16 +00002118** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002119** for any single row of the table with cursor iCur. In other words, the
2120** expression must not refer to any non-deterministic function nor any
2121** table other than iCur.
2122*/
2123int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2124 return exprIsConst(p, 3, iCur);
2125}
2126
danab31a842017-04-29 20:53:09 +00002127
2128/*
2129** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2130*/
2131static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2132 ExprList *pGroupBy = pWalker->u.pGroupBy;
2133 int i;
2134
2135 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2136 ** it constant. */
2137 for(i=0; i<pGroupBy->nExpr; i++){
2138 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002139 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002140 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002141 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002142 return WRC_Prune;
2143 }
2144 }
2145 }
2146
2147 /* Check if pExpr is a sub-select. If so, consider it variable. */
2148 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2149 pWalker->eCode = 0;
2150 return WRC_Abort;
2151 }
2152
2153 return exprNodeIsConstant(pWalker, pExpr);
2154}
2155
2156/*
2157** Walk the expression tree passed as the first argument. Return non-zero
2158** if the expression consists entirely of constants or copies of terms
2159** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002160**
2161** This routine is used to determine if a term of the HAVING clause can
2162** be promoted into the WHERE clause. In order for such a promotion to work,
2163** the value of the HAVING clause term must be the same for all members of
2164** a "group". The requirement that the GROUP BY term must be BINARY
2165** assumes that no other collating sequence will have a finer-grained
2166** grouping than binary. In other words (A=B COLLATE binary) implies
2167** A=B in every other collating sequence. The requirement that the
2168** GROUP BY be BINARY is stricter than necessary. It would also work
2169** to promote HAVING clauses that use the same alternative collating
2170** sequence as the GROUP BY term, but that is much harder to check,
2171** alternative collating sequences are uncommon, and this is only an
2172** optimization, so we take the easy way out and simply require the
2173** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002174*/
2175int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2176 Walker w;
danab31a842017-04-29 20:53:09 +00002177 w.eCode = 1;
2178 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002179 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002180 w.u.pGroupBy = pGroupBy;
2181 w.pParse = pParse;
2182 sqlite3WalkExpr(&w, p);
2183 return w.eCode;
2184}
2185
drh059b2d52014-10-24 19:28:09 +00002186/*
drh014fff22020-01-08 22:22:36 +00002187** Walk an expression tree for the DEFAULT field of a column definition
2188** in a CREATE TABLE statement. Return non-zero if the expression is
2189** acceptable for use as a DEFAULT. That is to say, return non-zero if
2190** the expression is constant or a function call with constant arguments.
2191** Return and 0 if there are any variables.
2192**
drh1e32bed2020-06-19 13:33:53 +00002193** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002194** processing a new CREATE TABLE statement. When isInit is true, parameters
2195** (such as ? or $abc) in the expression are converted into NULL. When
2196** isInit is false, parameters raise an error. Parameters should not be
2197** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002198** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002199** backwards compatibility.
2200**
2201** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002202**
2203** For the purposes of this function, a double-quoted string (ex: "abc")
2204** is considered a variable but a single-quoted string (ex: 'abc') is
2205** a constant.
2206*/
drhfeada2d2014-09-24 13:20:22 +00002207int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2208 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002209 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002210}
2211
drh5b88bc42013-12-07 23:35:21 +00002212#ifdef SQLITE_ENABLE_CURSOR_HINTS
2213/*
2214** Walk an expression tree. Return 1 if the expression contains a
2215** subquery of some kind. Return 0 if there are no subqueries.
2216*/
2217int sqlite3ExprContainsSubquery(Expr *p){
2218 Walker w;
drhbec24762015-08-13 20:07:13 +00002219 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002220 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002221 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002222#ifdef SQLITE_DEBUG
2223 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2224#endif
drh5b88bc42013-12-07 23:35:21 +00002225 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002226 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002227}
2228#endif
2229
drheb55bd22005-06-30 17:04:21 +00002230/*
drh73b211a2005-01-18 04:00:42 +00002231** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002232** to fit in a 32-bit integer, return 1 and put the value of the integer
2233** in *pValue. If the expression is not an integer or if it is too big
2234** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002235*/
danielk19774adee202004-05-08 08:23:19 +00002236int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002237 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002238 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002239
2240 /* If an expression is an integer literal that fits in a signed 32-bit
2241 ** integer, then the EP_IntValue flag will have already been set */
2242 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2243 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2244
drh92b01d52008-06-24 00:32:35 +00002245 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002246 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002247 return 1;
2248 }
drhe4de1fe2002-06-02 16:09:01 +00002249 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002250 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002251 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002252 break;
drh4b59ab52002-08-24 18:24:51 +00002253 }
drhe4de1fe2002-06-02 16:09:01 +00002254 case TK_UMINUS: {
2255 int v;
danielk19774adee202004-05-08 08:23:19 +00002256 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002257 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002258 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002259 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002260 }
2261 break;
2262 }
2263 default: break;
2264 }
drh92b01d52008-06-24 00:32:35 +00002265 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002266}
2267
2268/*
drh039fc322009-11-17 18:31:47 +00002269** Return FALSE if there is no chance that the expression can be NULL.
2270**
2271** If the expression might be NULL or if the expression is too complex
2272** to tell return TRUE.
2273**
2274** This routine is used as an optimization, to skip OP_IsNull opcodes
2275** when we know that a value cannot be NULL. Hence, a false positive
2276** (returning TRUE when in fact the expression can never be NULL) might
2277** be a small performance hit but is otherwise harmless. On the other
2278** hand, a false negative (returning FALSE when the result could be NULL)
2279** will likely result in an incorrect answer. So when in doubt, return
2280** TRUE.
2281*/
2282int sqlite3ExprCanBeNull(const Expr *p){
2283 u8 op;
drh9bfb0792018-12-22 01:13:25 +00002284 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2285 p = p->pLeft;
2286 }
drh039fc322009-11-17 18:31:47 +00002287 op = p->op;
2288 if( op==TK_REGISTER ) op = p->op2;
2289 switch( op ){
2290 case TK_INTEGER:
2291 case TK_STRING:
2292 case TK_FLOAT:
2293 case TK_BLOB:
2294 return 0;
drh7248a8b2014-08-04 18:50:54 +00002295 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002296 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002297 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002298 (p->iColumn>=0
2299 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2300 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002301 default:
2302 return 1;
2303 }
2304}
2305
2306/*
2307** Return TRUE if the given expression is a constant which would be
2308** unchanged by OP_Affinity with the affinity given in the second
2309** argument.
2310**
2311** This routine is used to determine if the OP_Affinity operation
2312** can be omitted. When in doubt return FALSE. A false negative
2313** is harmless. A false positive, however, can result in the wrong
2314** answer.
2315*/
2316int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2317 u8 op;
drhaf866402019-08-22 11:11:28 +00002318 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002319 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002320 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2321 if( p->op==TK_UMINUS ) unaryMinus = 1;
2322 p = p->pLeft;
2323 }
drh039fc322009-11-17 18:31:47 +00002324 op = p->op;
2325 if( op==TK_REGISTER ) op = p->op2;
2326 switch( op ){
2327 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002328 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002329 }
2330 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002331 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002332 }
2333 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002334 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002335 }
2336 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002337 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002338 }
drh2f2855b2009-11-18 01:25:26 +00002339 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002340 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002341 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002342 }
drh039fc322009-11-17 18:31:47 +00002343 default: {
2344 return 0;
2345 }
2346 }
2347}
2348
2349/*
drhc4a3c772001-04-04 11:48:57 +00002350** Return TRUE if the given string is a row-id column name.
2351*/
danielk19774adee202004-05-08 08:23:19 +00002352int sqlite3IsRowid(const char *z){
2353 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2354 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2355 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002356 return 0;
2357}
2358
danielk19779a96b662007-11-29 17:05:18 +00002359/*
drh69c355b2016-03-09 15:34:51 +00002360** pX is the RHS of an IN operator. If pX is a SELECT statement
2361** that can be simplified to a direct table access, then return
2362** a pointer to the SELECT statement. If pX is not a SELECT statement,
2363** or if the SELECT statement needs to be manifested into a transient
2364** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002365*/
2366#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002367static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002368 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002369 SrcList *pSrc;
2370 ExprList *pEList;
2371 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002372 int i;
drh69c355b2016-03-09 15:34:51 +00002373 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2374 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2375 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002376 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002377 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002378 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2379 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2380 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002381 }
drh2e26a602020-01-06 18:59:46 +00002382 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002383 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002384 if( p->pWhere ) return 0; /* Has no WHERE clause */
2385 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002386 assert( pSrc!=0 );
2387 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002388 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002389 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002390 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002391 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002392 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2393 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002394 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002395 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002396 for(i=0; i<pEList->nExpr; i++){
2397 Expr *pRes = pEList->a[i].pExpr;
2398 if( pRes->op!=TK_COLUMN ) return 0;
2399 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002400 }
drh69c355b2016-03-09 15:34:51 +00002401 return p;
drhb287f4b2008-04-25 00:08:38 +00002402}
2403#endif /* SQLITE_OMIT_SUBQUERY */
2404
danf9b2e052016-08-02 17:45:00 +00002405#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002406/*
drh4c259e92014-08-01 21:12:35 +00002407** Generate code that checks the left-most column of index table iCur to see if
2408** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002409** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2410** to be set to NULL if iCur contains one or more NULL values.
2411*/
2412static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002413 int addr1;
drh6be515e2014-08-01 21:00:53 +00002414 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002415 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002416 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2417 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002418 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002419 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002420}
danf9b2e052016-08-02 17:45:00 +00002421#endif
drh6be515e2014-08-01 21:00:53 +00002422
drhbb53ecb2014-08-02 21:03:33 +00002423
2424#ifndef SQLITE_OMIT_SUBQUERY
2425/*
2426** The argument is an IN operator with a list (not a subquery) on the
2427** right-hand side. Return TRUE if that list is constant.
2428*/
2429static int sqlite3InRhsIsConstant(Expr *pIn){
2430 Expr *pLHS;
2431 int res;
2432 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2433 pLHS = pIn->pLeft;
2434 pIn->pLeft = 0;
2435 res = sqlite3ExprIsConstant(pIn);
2436 pIn->pLeft = pLHS;
2437 return res;
2438}
2439#endif
2440
drh6be515e2014-08-01 21:00:53 +00002441/*
danielk19779a96b662007-11-29 17:05:18 +00002442** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002443** The pX parameter is the expression on the RHS of the IN operator, which
2444** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002445**
drhd4305ca2012-09-18 17:08:33 +00002446** The job of this routine is to find or create a b-tree object that can
2447** be used either to test for membership in the RHS set or to iterate through
2448** all members of the RHS set, skipping duplicates.
2449**
drh3a856252014-08-01 14:46:57 +00002450** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002451** and pX->iTable is set to the index of that cursor.
2452**
drhb74b1012009-05-28 21:04:37 +00002453** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002454**
drh1ccce442013-03-12 20:38:51 +00002455** IN_INDEX_ROWID - The cursor was opened on a database table.
2456** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2457** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2458** IN_INDEX_EPH - The cursor was opened on a specially created and
2459** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002460** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2461** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002462**
drhd4305ca2012-09-18 17:08:33 +00002463** An existing b-tree might be used if the RHS expression pX is a simple
2464** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002465**
dan553168c2016-08-01 20:14:31 +00002466** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002467**
drhd4305ca2012-09-18 17:08:33 +00002468** If the RHS of the IN operator is a list or a more complex subquery, then
2469** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002470** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002471** existing table.
drhd4305ca2012-09-18 17:08:33 +00002472**
drh7fc0ba02017-11-17 15:02:00 +00002473** The inFlags parameter must contain, at a minimum, one of the bits
2474** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2475** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2476** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2477** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002478**
2479** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2480** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002481** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002482** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2483** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002484**
drh3a856252014-08-01 14:46:57 +00002485** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2486** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002487** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2488** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002489**
drhbb53ecb2014-08-02 21:03:33 +00002490** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2491** if the RHS of the IN operator is a list (not a subquery) then this
2492** routine might decide that creating an ephemeral b-tree for membership
2493** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2494** calling routine should implement the IN operator using a sequence
2495** of Eq or Ne comparison operations.
2496**
drhb74b1012009-05-28 21:04:37 +00002497** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002498** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002499** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002500** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002501** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002502** to *prRhsHasNull. If there is no chance that the (...) contains a
2503** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002504**
drhe21a6e12014-08-01 18:00:24 +00002505** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002506** the value in that register will be NULL if the b-tree contains one or more
2507** NULL values, and it will be some non-NULL value if the b-tree contains no
2508** NULL values.
dan553168c2016-08-01 20:14:31 +00002509**
2510** If the aiMap parameter is not NULL, it must point to an array containing
2511** one element for each column returned by the SELECT statement on the RHS
2512** of the IN(...) operator. The i'th entry of the array is populated with the
2513** offset of the index column that matches the i'th column returned by the
2514** SELECT. For example, if the expression and selected index are:
2515**
2516** (?,?,?) IN (SELECT a, b, c FROM t1)
2517** CREATE INDEX i1 ON t1(b, c, a);
2518**
2519** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002520*/
danielk1977284f4ac2007-12-10 05:03:46 +00002521#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002522int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002523 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002524 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002525 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2526 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002527 int *aiMap, /* Mapping from Index fields to RHS fields */
2528 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002529){
drhb74b1012009-05-28 21:04:37 +00002530 Select *p; /* SELECT to the right of IN operator */
2531 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2532 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002533 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002534 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002535
drh1450bc62009-10-30 13:25:56 +00002536 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002537 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002538
dan7b35a772016-07-28 19:47:15 +00002539 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2540 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002541 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002542 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002543 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002544 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2545 int i;
2546 ExprList *pEList = pX->x.pSelect->pEList;
2547 for(i=0; i<pEList->nExpr; i++){
2548 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2549 }
2550 if( i==pEList->nExpr ){
2551 prRhsHasNull = 0;
2552 }
2553 }
2554
drhb74b1012009-05-28 21:04:37 +00002555 /* Check to see if an existing table or index can be used to
2556 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002557 ** ephemeral table. */
2558 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002559 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002560 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002561 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002562 ExprList *pEList = p->pEList;
2563 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002564
drhb07028f2011-10-14 21:49:18 +00002565 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2566 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2567 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2568 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002569
drhb22f7c82014-02-06 23:56:27 +00002570 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002571 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drhbdd4f7d2020-05-26 10:54:46 +00002572 assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
danielk1977e1fb65a2009-04-02 17:23:32 +00002573 sqlite3CodeVerifySchema(pParse, iDb);
2574 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002575
drha84a2832016-08-26 21:15:35 +00002576 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002577 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002578 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002579 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002580 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002581
2582 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2583 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002584 ExplainQueryPlan((pParse, 0,
2585 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002586 sqlite3VdbeJumpHere(v, iAddr);
2587 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002588 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002589 int affinity_ok = 1;
2590 int i;
2591
2592 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002593 ** comparison is the same as the affinity of each column in table
2594 ** on the RHS of the IN operator. If it not, it is not possible to
2595 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002596 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002597 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002598 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002599 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002600 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002601 testcase( cmpaff==SQLITE_AFF_BLOB );
2602 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002603 switch( cmpaff ){
2604 case SQLITE_AFF_BLOB:
2605 break;
2606 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002607 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2608 ** other has no affinity and the other side is TEXT. Hence,
2609 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2610 ** and for the term on the LHS of the IN to have no affinity. */
2611 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002612 break;
2613 default:
2614 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2615 }
2616 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002617
drha84a2832016-08-26 21:15:35 +00002618 if( affinity_ok ){
2619 /* Search for an existing index that will work for this IN operator */
2620 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2621 Bitmask colUsed; /* Columns of the index used */
2622 Bitmask mCol; /* Mask for the current column */
2623 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002624 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002625 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2626 ** BITMASK(nExpr) without overflowing */
2627 testcase( pIdx->nColumn==BMS-2 );
2628 testcase( pIdx->nColumn==BMS-1 );
2629 if( pIdx->nColumn>=BMS-1 ) continue;
2630 if( mustBeUnique ){
2631 if( pIdx->nKeyCol>nExpr
2632 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2633 ){
2634 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002635 }
danielk19770cdc0222008-06-26 18:04:03 +00002636 }
drha84a2832016-08-26 21:15:35 +00002637
2638 colUsed = 0; /* Columns of index used so far */
2639 for(i=0; i<nExpr; i++){
2640 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2641 Expr *pRhs = pEList->a[i].pExpr;
2642 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2643 int j;
2644
2645 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2646 for(j=0; j<nExpr; j++){
2647 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2648 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002649 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2650 continue;
2651 }
drha84a2832016-08-26 21:15:35 +00002652 break;
2653 }
2654 if( j==nExpr ) break;
2655 mCol = MASKBIT(j);
2656 if( mCol & colUsed ) break; /* Each column used only once */
2657 colUsed |= mCol;
2658 if( aiMap ) aiMap[i] = j;
2659 }
2660
2661 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2662 if( colUsed==(MASKBIT(nExpr)-1) ){
2663 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002664 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002665 ExplainQueryPlan((pParse, 0,
2666 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002667 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2668 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2669 VdbeComment((v, "%s", pIdx->zName));
2670 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2671 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2672
2673 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002674#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002675 i64 mask = (1<<nExpr)-1;
2676 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2677 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002678#endif
2679 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002680 if( nExpr==1 ){
2681 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2682 }
2683 }
2684 sqlite3VdbeJumpHere(v, iAddr);
2685 }
2686 } /* End loop over indexes */
2687 } /* End if( affinity_ok ) */
2688 } /* End if not an rowid index */
2689 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002690
drhbb53ecb2014-08-02 21:03:33 +00002691 /* If no preexisting index is available for the IN clause
2692 ** and IN_INDEX_NOOP is an allowed reply
2693 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002694 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002695 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002696 ** the IN operator so return IN_INDEX_NOOP.
2697 */
2698 if( eType==0
2699 && (inFlags & IN_INDEX_NOOP_OK)
2700 && !ExprHasProperty(pX, EP_xIsSelect)
2701 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2702 ){
2703 eType = IN_INDEX_NOOP;
2704 }
drhbb53ecb2014-08-02 21:03:33 +00002705
danielk19779a96b662007-11-29 17:05:18 +00002706 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002707 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002708 ** We will have to generate an ephemeral table to do the job.
2709 */
drh8e23daf2013-06-11 13:30:04 +00002710 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002711 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002712 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002713 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002714 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002715 }else if( prRhsHasNull ){
2716 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002717 }
drh85bcdce2018-12-23 21:27:29 +00002718 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002719 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002720 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002721 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002722 }
drhcf4d38a2010-07-28 02:53:36 +00002723 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002724 }
danba00e302016-07-23 20:24:06 +00002725
2726 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2727 int i, n;
2728 n = sqlite3ExprVectorSize(pX->pLeft);
2729 for(i=0; i<n; i++) aiMap[i] = i;
2730 }
drh2c041312018-12-24 02:34:49 +00002731 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002732 return eType;
2733}
danielk1977284f4ac2007-12-10 05:03:46 +00002734#endif
drh626a8792005-01-17 22:08:19 +00002735
danf9b2e052016-08-02 17:45:00 +00002736#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002737/*
2738** Argument pExpr is an (?, ?...) IN(...) expression. This
2739** function allocates and returns a nul-terminated string containing
2740** the affinities to be used for each column of the comparison.
2741**
2742** It is the responsibility of the caller to ensure that the returned
2743** string is eventually freed using sqlite3DbFree().
2744*/
dan71c57db2016-07-09 20:23:55 +00002745static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2746 Expr *pLeft = pExpr->pLeft;
2747 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002748 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002749 char *zRet;
2750
dan553168c2016-08-01 20:14:31 +00002751 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002752 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002753 if( zRet ){
2754 int i;
2755 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002756 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002757 char a = sqlite3ExprAffinity(pA);
2758 if( pSelect ){
2759 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2760 }else{
2761 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002762 }
dan71c57db2016-07-09 20:23:55 +00002763 }
2764 zRet[nVal] = '\0';
2765 }
2766 return zRet;
2767}
danf9b2e052016-08-02 17:45:00 +00002768#endif
dan71c57db2016-07-09 20:23:55 +00002769
dan8da209b2016-07-26 18:06:08 +00002770#ifndef SQLITE_OMIT_SUBQUERY
2771/*
2772** Load the Parse object passed as the first argument with an error
2773** message of the form:
2774**
2775** "sub-select returns N columns - expected M"
2776*/
2777void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002778 if( pParse->nErr==0 ){
2779 const char *zFmt = "sub-select returns %d columns - expected %d";
2780 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2781 }
dan8da209b2016-07-26 18:06:08 +00002782}
2783#endif
2784
drh626a8792005-01-17 22:08:19 +00002785/*
dan44c56042016-12-07 15:38:37 +00002786** Expression pExpr is a vector that has been used in a context where
2787** it is not permitted. If pExpr is a sub-select vector, this routine
2788** loads the Parse object with a message of the form:
2789**
2790** "sub-select returns N columns - expected 1"
2791**
2792** Or, if it is a regular scalar vector:
2793**
2794** "row value misused"
2795*/
2796void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2797#ifndef SQLITE_OMIT_SUBQUERY
2798 if( pExpr->flags & EP_xIsSelect ){
2799 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2800 }else
2801#endif
2802 {
2803 sqlite3ErrorMsg(pParse, "row value misused");
2804 }
2805}
2806
drh85bcdce2018-12-23 21:27:29 +00002807#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002808/*
drh85bcdce2018-12-23 21:27:29 +00002809** Generate code that will construct an ephemeral table containing all terms
2810** in the RHS of an IN operator. The IN operator can be in either of two
2811** forms:
drh626a8792005-01-17 22:08:19 +00002812**
drh9cbe6352005-11-29 03:13:21 +00002813** x IN (4,5,11) -- IN operator with list on right-hand side
2814** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002815**
drh2c041312018-12-24 02:34:49 +00002816** The pExpr parameter is the IN operator. The cursor number for the
2817** constructed ephermeral table is returned. The first time the ephemeral
2818** table is computed, the cursor number is also stored in pExpr->iTable,
2819** however the cursor number returned might not be the same, as it might
2820** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002821**
drh85bcdce2018-12-23 21:27:29 +00002822** If the LHS expression ("x" in the examples) is a column value, or
2823** the SELECT statement returns a column value, then the affinity of that
2824** column is used to build the index keys. If both 'x' and the
2825** SELECT... statement are columns, then numeric affinity is used
2826** if either column has NUMERIC or INTEGER affinity. If neither
2827** 'x' nor the SELECT... statement are columns, then numeric affinity
2828** is used.
drhcce7d172000-05-31 15:34:51 +00002829*/
drh85bcdce2018-12-23 21:27:29 +00002830void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002831 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002832 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002833 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002834){
drh2c041312018-12-24 02:34:49 +00002835 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002836 int addr; /* Address of OP_OpenEphemeral instruction */
2837 Expr *pLeft; /* the LHS of the IN operator */
2838 KeyInfo *pKeyInfo = 0; /* Key information */
2839 int nVal; /* Size of vector pLeft */
2840 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002841
drh2c041312018-12-24 02:34:49 +00002842 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002843 assert( v!=0 );
2844
drh2c041312018-12-24 02:34:49 +00002845 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002846 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002847 **
2848 ** * The right-hand side is a correlated subquery
2849 ** * The right-hand side is an expression list containing variables
2850 ** * We are inside a trigger
2851 **
drh2c041312018-12-24 02:34:49 +00002852 ** If all of the above are false, then we can compute the RHS just once
2853 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002854 */
drhefb699f2018-12-24 11:55:44 +00002855 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002856 /* Reuse of the RHS is allowed */
2857 /* If this routine has already been coded, but the previous code
2858 ** might not have been invoked yet, so invoke it now as a subroutine.
2859 */
2860 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002861 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002862 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2863 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2864 pExpr->x.pSelect->selId));
2865 }
drh2c041312018-12-24 02:34:49 +00002866 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2867 pExpr->y.sub.iAddr);
2868 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002869 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002870 return;
2871 }
2872
2873 /* Begin coding the subroutine */
2874 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002875 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002876 pExpr->y.sub.regReturn = ++pParse->nMem;
2877 pExpr->y.sub.iAddr =
2878 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2879 VdbeComment((v, "return address"));
2880
2881 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002882 }
2883
drh85bcdce2018-12-23 21:27:29 +00002884 /* Check to see if this is a vector IN operator */
2885 pLeft = pExpr->pLeft;
2886 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002887
drh85bcdce2018-12-23 21:27:29 +00002888 /* Construct the ephemeral table that will contain the content of
2889 ** RHS of the IN operator.
2890 */
drh2c041312018-12-24 02:34:49 +00002891 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002892 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002893#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2894 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2895 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2896 }else{
2897 VdbeComment((v, "RHS of IN operator"));
2898 }
2899#endif
drh50ef6712019-02-22 23:29:56 +00002900 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002901
drh85bcdce2018-12-23 21:27:29 +00002902 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2903 /* Case 1: expr IN (SELECT ...)
2904 **
2905 ** Generate code to write the results of the select into the temporary
2906 ** table allocated and opened above.
2907 */
2908 Select *pSelect = pExpr->x.pSelect;
2909 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002910
drh2c041312018-12-24 02:34:49 +00002911 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2912 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002913 ));
drh85bcdce2018-12-23 21:27:29 +00002914 /* If the LHS and RHS of the IN operator do not match, that
2915 ** error will have been caught long before we reach this point. */
2916 if( ALWAYS(pEList->nExpr==nVal) ){
2917 SelectDest dest;
2918 int i;
drhbd462bc2018-12-24 20:21:06 +00002919 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002920 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2921 pSelect->iLimit = 0;
2922 testcase( pSelect->selFlags & SF_Distinct );
2923 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2924 if( sqlite3Select(pParse, pSelect, &dest) ){
2925 sqlite3DbFree(pParse->db, dest.zAffSdst);
2926 sqlite3KeyInfoUnref(pKeyInfo);
2927 return;
drhfef52082000-06-06 01:50:43 +00002928 }
drh85bcdce2018-12-23 21:27:29 +00002929 sqlite3DbFree(pParse->db, dest.zAffSdst);
2930 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
2931 assert( pEList!=0 );
2932 assert( pEList->nExpr>0 );
2933 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2934 for(i=0; i<nVal; i++){
2935 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
2936 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
2937 pParse, p, pEList->a[i].pExpr
2938 );
danielk197741a05b72008-10-02 13:50:55 +00002939 }
drh85bcdce2018-12-23 21:27:29 +00002940 }
2941 }else if( ALWAYS(pExpr->x.pList!=0) ){
2942 /* Case 2: expr IN (exprlist)
2943 **
2944 ** For each expression, build an index key from the evaluation and
2945 ** store it in the temporary table. If <expr> is a column, then use
2946 ** that columns affinity when building index keys. If <expr> is not
2947 ** a column, use numeric affinity.
2948 */
2949 char affinity; /* Affinity of the LHS of the IN */
2950 int i;
2951 ExprList *pList = pExpr->x.pList;
2952 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00002953 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00002954 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00002955 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00002956 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00002957 }else if( affinity==SQLITE_AFF_REAL ){
2958 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00002959 }
2960 if( pKeyInfo ){
2961 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2962 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00002963 }
2964
drh85bcdce2018-12-23 21:27:29 +00002965 /* Loop through each expression in <exprlist>. */
2966 r1 = sqlite3GetTempReg(pParse);
2967 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00002968 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
2969 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00002970
2971 /* If the expression is not constant then we will need to
2972 ** disable the test that was generated above that makes sure
2973 ** this code only executes once. Because for a non-constant
2974 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00002975 */
drh2c041312018-12-24 02:34:49 +00002976 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
2977 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00002978 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00002979 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00002980 }
drh1398ad32005-01-19 23:24:50 +00002981
drh85bcdce2018-12-23 21:27:29 +00002982 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00002983 sqlite3ExprCode(pParse, pE2, r1);
2984 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2985 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00002986 }
drh85bcdce2018-12-23 21:27:29 +00002987 sqlite3ReleaseTempReg(pParse, r1);
2988 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00002989 }
drh85bcdce2018-12-23 21:27:29 +00002990 if( pKeyInfo ){
2991 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
2992 }
drh2c041312018-12-24 02:34:49 +00002993 if( addrOnce ){
2994 sqlite3VdbeJumpHere(v, addrOnce);
2995 /* Subroutine return */
2996 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
2997 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00002998 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00002999 }
3000}
3001#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003002
drh85bcdce2018-12-23 21:27:29 +00003003/*
3004** Generate code for scalar subqueries used as a subquery expression
3005** or EXISTS operator:
3006**
3007** (SELECT a FROM b) -- subquery
3008** EXISTS (SELECT a FROM b) -- EXISTS subquery
3009**
3010** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3011**
drhd86fe442019-08-26 13:45:49 +00003012** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003013** the result is stored in a contiguous array of registers and the
3014** return value is the register of the left-most result column.
3015** Return 0 if an error occurs.
3016*/
3017#ifndef SQLITE_OMIT_SUBQUERY
3018int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003019 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003020 int rReg = 0; /* Register storing resulting */
3021 Select *pSel; /* SELECT statement to encode */
3022 SelectDest dest; /* How to deal with SELECT result */
3023 int nReg; /* Registers to allocate */
3024 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003025
3026 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003027 assert( v!=0 );
drhbd462bc2018-12-24 20:21:06 +00003028 testcase( pExpr->op==TK_EXISTS );
3029 testcase( pExpr->op==TK_SELECT );
3030 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3031 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3032 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003033
drh5198ff52018-12-24 12:09:47 +00003034 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003035 ** is encountered if any of the following is true:
3036 **
3037 ** * The right-hand side is a correlated subquery
3038 ** * The right-hand side is an expression list containing variables
3039 ** * We are inside a trigger
3040 **
3041 ** If all of the above are false, then we can run this code just once
3042 ** save the results, and reuse the same result on subsequent invocations.
3043 */
3044 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003045 /* If this routine has already been coded, then invoke it as a
3046 ** subroutine. */
3047 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003048 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003049 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3050 pExpr->y.sub.iAddr);
3051 return pExpr->iTable;
3052 }
3053
3054 /* Begin coding the subroutine */
3055 ExprSetProperty(pExpr, EP_Subrtn);
3056 pExpr->y.sub.regReturn = ++pParse->nMem;
3057 pExpr->y.sub.iAddr =
3058 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3059 VdbeComment((v, "return address"));
3060
drh2c041312018-12-24 02:34:49 +00003061 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003062 }
drh85bcdce2018-12-23 21:27:29 +00003063
3064 /* For a SELECT, generate code to put the values for all columns of
3065 ** the first row into an array of registers and return the index of
3066 ** the first register.
3067 **
3068 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3069 ** into a register and return that register number.
3070 **
3071 ** In both cases, the query is augmented with "LIMIT 1". Any
3072 ** preexisting limit is discarded in place of the new LIMIT 1.
3073 */
drhbd462bc2018-12-24 20:21:06 +00003074 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3075 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003076 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3077 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3078 pParse->nMem += nReg;
3079 if( pExpr->op==TK_SELECT ){
3080 dest.eDest = SRT_Mem;
3081 dest.iSdst = dest.iSDParm;
3082 dest.nSdst = nReg;
3083 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3084 VdbeComment((v, "Init subquery result"));
3085 }else{
3086 dest.eDest = SRT_Exists;
3087 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3088 VdbeComment((v, "Init EXISTS result"));
3089 }
drh85bcdce2018-12-23 21:27:29 +00003090 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003091 /* The subquery already has a limit. If the pre-existing limit is X
3092 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3093 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003094 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003095 if( pLimit ){
3096 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3097 pLimit = sqlite3PExpr(pParse, TK_NE,
3098 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3099 }
3100 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003101 pSel->pLimit->pLeft = pLimit;
3102 }else{
drh7ca13472019-09-23 11:55:22 +00003103 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003104 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003105 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3106 }
3107 pSel->iLimit = 0;
3108 if( sqlite3Select(pParse, pSel, &dest) ){
3109 return 0;
3110 }
drh2c041312018-12-24 02:34:49 +00003111 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003112 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003113 if( addrOnce ){
3114 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003115
drh5198ff52018-12-24 12:09:47 +00003116 /* Subroutine return */
3117 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3118 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003119 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003120 }
drh2c041312018-12-24 02:34:49 +00003121
drh1450bc62009-10-30 13:25:56 +00003122 return rReg;
drhcce7d172000-05-31 15:34:51 +00003123}
drh51522cd2005-01-20 13:36:19 +00003124#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003125
drhe3365e62009-11-12 17:52:24 +00003126#ifndef SQLITE_OMIT_SUBQUERY
3127/*
dan7b35a772016-07-28 19:47:15 +00003128** Expr pIn is an IN(...) expression. This function checks that the
3129** sub-select on the RHS of the IN() operator has the same number of
3130** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3131** a sub-query, that the LHS is a vector of size 1.
3132*/
3133int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3134 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3135 if( (pIn->flags & EP_xIsSelect) ){
3136 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3137 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3138 return 1;
3139 }
3140 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003141 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003142 return 1;
3143 }
3144 return 0;
3145}
3146#endif
3147
3148#ifndef SQLITE_OMIT_SUBQUERY
3149/*
drhe3365e62009-11-12 17:52:24 +00003150** Generate code for an IN expression.
3151**
3152** x IN (SELECT ...)
3153** x IN (value, value, ...)
3154**
drhecb87ac2016-08-25 15:46:25 +00003155** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003156** right-hand side (RHS) is an array of zero or more scalar values, or a
3157** subquery. If the RHS is a subquery, the number of result columns must
3158** match the number of columns in the vector on the LHS. If the RHS is
3159** a list of values, the LHS must be a scalar.
3160**
3161** The IN operator is true if the LHS value is contained within the RHS.
3162** The result is false if the LHS is definitely not in the RHS. The
3163** result is NULL if the presence of the LHS in the RHS cannot be
3164** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003165**
drh6be515e2014-08-01 21:00:53 +00003166** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003167** contained within the RHS. If due to NULLs we cannot determine if the LHS
3168** is contained in the RHS then jump to destIfNull. If the LHS is contained
3169** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003170**
3171** See the separate in-operator.md documentation file in the canonical
3172** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003173*/
3174static void sqlite3ExprCodeIN(
3175 Parse *pParse, /* Parsing and code generating context */
3176 Expr *pExpr, /* The IN expression */
3177 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3178 int destIfNull /* Jump here if the results are unknown due to NULLs */
3179){
3180 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003181 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003182 int rLhs; /* Register(s) holding the LHS values */
3183 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003184 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003185 int *aiMap = 0; /* Map from vector field to index column */
3186 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003187 int nVector; /* Size of vectors for this IN operator */
3188 int iDummy; /* Dummy parameter to exprCodeVector() */
3189 Expr *pLeft; /* The LHS of the IN operator */
3190 int i; /* loop counter */
3191 int destStep2; /* Where to jump when NULLs seen in step 2 */
3192 int destStep6 = 0; /* Start of code for Step 6 */
3193 int addrTruthOp; /* Address of opcode that determines the IN is true */
3194 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3195 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003196 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003197 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003198
drhe7375bf2020-03-10 19:24:38 +00003199 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003200 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003201 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003202 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003203 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3204 aiMap = (int*)sqlite3DbMallocZero(
3205 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3206 );
drhe347d3e2016-08-25 21:14:34 +00003207 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003208
danba00e302016-07-23 20:24:06 +00003209 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003210 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003211 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3212 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003213 v = pParse->pVdbe;
3214 assert( v!=0 ); /* OOM detected prior to this routine */
3215 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003216 eType = sqlite3FindInIndex(pParse, pExpr,
3217 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003218 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3219 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003220
danba00e302016-07-23 20:24:06 +00003221 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3222 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3223 );
drhecb87ac2016-08-25 15:46:25 +00003224#ifdef SQLITE_DEBUG
3225 /* Confirm that aiMap[] contains nVector integer values between 0 and
3226 ** nVector-1. */
3227 for(i=0; i<nVector; i++){
3228 int j, cnt;
3229 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3230 assert( cnt==1 );
3231 }
3232#endif
drhe3365e62009-11-12 17:52:24 +00003233
danba00e302016-07-23 20:24:06 +00003234 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3235 ** vector, then it is stored in an array of nVector registers starting
3236 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003237 **
3238 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3239 ** so that the fields are in the same order as an existing index. The
3240 ** aiMap[] array contains a mapping from the original LHS field order to
3241 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003242 **
3243 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3244 ** even if it is constant, as OP_Affinity may be used on the register
3245 ** by code generated below. */
3246 assert( pParse->okConstFactor==okConstFactor );
3247 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003248 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003249 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003250 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003251 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003252 /* LHS fields are not reordered */
3253 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003254 }else{
3255 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003256 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003257 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003258 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003259 }
danba00e302016-07-23 20:24:06 +00003260 }
drhe3365e62009-11-12 17:52:24 +00003261
drhbb53ecb2014-08-02 21:03:33 +00003262 /* If sqlite3FindInIndex() did not find or create an index that is
3263 ** suitable for evaluating the IN operator, then evaluate using a
3264 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003265 **
3266 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003267 */
drhbb53ecb2014-08-02 21:03:33 +00003268 if( eType==IN_INDEX_NOOP ){
3269 ExprList *pList = pExpr->x.pList;
3270 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003271 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003272 int r2, regToFree;
3273 int regCkNull = 0;
3274 int ii;
3275 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003276 if( destIfNull!=destIfFalse ){
3277 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003278 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003279 }
3280 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003281 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003282 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003283 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3284 }
drhf6ea97e2020-01-04 15:21:47 +00003285 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003286 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003287 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3288 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003289 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003290 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3291 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3292 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3293 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003294 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003295 }else{
drh47994882019-12-22 23:48:36 +00003296 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003297 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003298 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3299 (void*)pColl, P4_COLLSEQ);
3300 VdbeCoverageIf(v, op==OP_Ne);
3301 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003302 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003303 }
drhbb53ecb2014-08-02 21:03:33 +00003304 }
3305 if( regCkNull ){
3306 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003307 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003308 }
3309 sqlite3VdbeResolveLabel(v, labelOk);
3310 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003311 goto sqlite3ExprCodeIN_finished;
3312 }
3313
3314 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3315 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3316 ** We will then skip the binary search of the RHS.
3317 */
3318 if( destIfNull==destIfFalse ){
3319 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003320 }else{
drhec4ccdb2018-12-29 02:26:59 +00003321 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003322 }
drh4eac5f02019-12-24 15:01:17 +00003323 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003324 for(i=0; i<nVector; i++){
3325 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3326 if( sqlite3ExprCanBeNull(p) ){
3327 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003328 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003329 }
drhe3365e62009-11-12 17:52:24 +00003330 }
drhe347d3e2016-08-25 21:14:34 +00003331
3332 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3333 ** of the RHS using the LHS as a probe. If found, the result is
3334 ** true.
3335 */
3336 if( eType==IN_INDEX_ROWID ){
3337 /* In this case, the RHS is the ROWID of table b-tree and so we also
3338 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3339 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003340 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003341 VdbeCoverage(v);
3342 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3343 }else{
3344 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3345 if( destIfFalse==destIfNull ){
3346 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003347 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003348 rLhs, nVector); VdbeCoverage(v);
3349 goto sqlite3ExprCodeIN_finished;
3350 }
3351 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003352 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003353 rLhs, nVector); VdbeCoverage(v);
3354 }
3355
3356 /* Step 4. If the RHS is known to be non-NULL and we did not find
3357 ** an match on the search above, then the result must be FALSE.
3358 */
3359 if( rRhsHasNull && nVector==1 ){
3360 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3361 VdbeCoverage(v);
3362 }
3363
3364 /* Step 5. If we do not care about the difference between NULL and
3365 ** FALSE, then just return false.
3366 */
3367 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3368
3369 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3370 ** If any comparison is NULL, then the result is NULL. If all
3371 ** comparisons are FALSE then the final result is FALSE.
3372 **
3373 ** For a scalar LHS, it is sufficient to check just the first row
3374 ** of the RHS.
3375 */
3376 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003377 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003378 VdbeCoverage(v);
3379 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003380 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003381 }else{
3382 /* For nVector==1, combine steps 6 and 7 by immediately returning
3383 ** FALSE if the first comparison is not NULL */
3384 destNotNull = destIfFalse;
3385 }
3386 for(i=0; i<nVector; i++){
3387 Expr *p;
3388 CollSeq *pColl;
3389 int r3 = sqlite3GetTempReg(pParse);
3390 p = sqlite3VectorFieldSubexpr(pLeft, i);
3391 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003392 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003393 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3394 (void*)pColl, P4_COLLSEQ);
3395 VdbeCoverage(v);
3396 sqlite3ReleaseTempReg(pParse, r3);
3397 }
3398 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3399 if( nVector>1 ){
3400 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003401 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003402 VdbeCoverage(v);
3403
3404 /* Step 7: If we reach this point, we know that the result must
3405 ** be false. */
3406 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3407 }
3408
3409 /* Jumps here in order to return true. */
3410 sqlite3VdbeJumpHere(v, addrTruthOp);
3411
3412sqlite3ExprCodeIN_finished:
3413 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003414 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003415sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003416 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003417 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003418}
3419#endif /* SQLITE_OMIT_SUBQUERY */
3420
drh13573c72010-01-12 17:04:07 +00003421#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003422/*
3423** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003424** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003425**
3426** The z[] string will probably not be zero-terminated. But the
3427** z[n] character is guaranteed to be something that does not look
3428** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003429*/
drhb7916a72009-05-27 10:31:29 +00003430static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003431 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003432 double value;
drh9339da12010-09-30 00:50:49 +00003433 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003434 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3435 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003436 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003437 }
3438}
drh13573c72010-01-12 17:04:07 +00003439#endif
drh598f1342007-10-23 15:39:45 +00003440
3441
3442/*
drhfec19aa2004-05-19 20:41:03 +00003443** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003444** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003445**
shaneh5f1d6b62010-09-30 16:51:25 +00003446** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003447*/
drh13573c72010-01-12 17:04:07 +00003448static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3449 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003450 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003451 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003452 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003453 if( negFlag ) i = -i;
3454 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003455 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003456 int c;
3457 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003458 const char *z = pExpr->u.zToken;
3459 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003460 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003461 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003462#ifdef SQLITE_OMIT_FLOATING_POINT
3463 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3464#else
drh1b7ddc52014-07-23 14:52:05 +00003465#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003466 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003467 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003468 }else
3469#endif
3470 {
drh9296c182014-07-23 13:40:49 +00003471 codeReal(v, z, negFlag, iMem);
3472 }
drh13573c72010-01-12 17:04:07 +00003473#endif
drh77320ea2016-11-30 14:47:37 +00003474 }else{
drh84d4f1a2017-09-20 10:47:10 +00003475 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003476 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003477 }
drhfec19aa2004-05-19 20:41:03 +00003478 }
3479}
3480
drh5cd79232009-05-25 11:46:29 +00003481
drh1f9ca2c2015-08-25 16:57:52 +00003482/* Generate code that will load into register regOut a value that is
3483** appropriate for the iIdxCol-th column of index pIdx.
3484*/
3485void sqlite3ExprCodeLoadIndexColumn(
3486 Parse *pParse, /* The parsing context */
3487 Index *pIdx, /* The index whose column is to be loaded */
3488 int iTabCur, /* Cursor pointing to a table row */
3489 int iIdxCol, /* The column of the index to be loaded */
3490 int regOut /* Store the index column value in this register */
3491){
3492 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003493 if( iTabCol==XN_EXPR ){
3494 assert( pIdx->aColExpr );
3495 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003496 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003497 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003498 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003499 }else{
drh6df9c4b2019-10-18 12:52:08 +00003500 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003501 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003502 }
drh1f9ca2c2015-08-25 16:57:52 +00003503}
3504
drhe70fa7f2019-10-22 21:01:34 +00003505#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3506/*
3507** Generate code that will compute the value of generated column pCol
3508** and store the result in register regOut
3509*/
3510void sqlite3ExprCodeGeneratedColumn(
3511 Parse *pParse,
3512 Column *pCol,
3513 int regOut
3514){
drh4dad7ed2019-12-16 16:52:22 +00003515 int iAddr;
3516 Vdbe *v = pParse->pVdbe;
3517 assert( v!=0 );
3518 assert( pParse->iSelfTab!=0 );
3519 if( pParse->iSelfTab>0 ){
3520 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3521 }else{
3522 iAddr = 0;
3523 }
drh24e39902020-03-10 13:35:04 +00003524 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003525 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003526 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003527 }
drh4dad7ed2019-12-16 16:52:22 +00003528 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003529}
3530#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3531
drh5cd79232009-05-25 11:46:29 +00003532/*
drh5c092e82010-05-14 19:24:02 +00003533** Generate code to extract the value of the iCol-th column of a table.
3534*/
3535void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003536 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003537 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003538 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003539 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003540 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003541){
drhab45fc02019-10-16 22:01:56 +00003542 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003543 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003544 if( pTab==0 ){
3545 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3546 return;
3547 }
drh5c092e82010-05-14 19:24:02 +00003548 if( iCol<0 || iCol==pTab->iPKey ){
3549 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3550 }else{
drh81f7b372019-10-16 12:18:59 +00003551 int op;
3552 int x;
3553 if( IsVirtual(pTab) ){
3554 op = OP_VColumn;
3555 x = iCol;
3556#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003557 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003558 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003559 if( pCol->colFlags & COLFLAG_BUSY ){
3560 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3561 }else{
3562 int savedSelfTab = pParse->iSelfTab;
3563 pCol->colFlags |= COLFLAG_BUSY;
3564 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003565 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003566 pParse->iSelfTab = savedSelfTab;
3567 pCol->colFlags &= ~COLFLAG_BUSY;
3568 }
drh81f7b372019-10-16 12:18:59 +00003569 return;
3570#endif
3571 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003572 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003573 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003574 op = OP_Column;
3575 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003576 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003577 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003578 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003579 }
3580 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003581 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3582 }
3583}
3584
3585/*
drh945498f2007-02-24 11:52:52 +00003586** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003587** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003588**
3589** There must be an open cursor to pTab in iTable when this routine
3590** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003591*/
drhe55cbd72008-03-31 23:48:03 +00003592int sqlite3ExprCodeGetColumn(
3593 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003594 Table *pTab, /* Description of the table we are reading from */
3595 int iColumn, /* Index of the table column */
3596 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003597 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003598 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003599){
drh81f7b372019-10-16 12:18:59 +00003600 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003601 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003602 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003603 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3604 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003605 }
drhe55cbd72008-03-31 23:48:03 +00003606 return iReg;
3607}
drhe55cbd72008-03-31 23:48:03 +00003608
3609/*
drhb21e7c72008-06-22 12:37:57 +00003610** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003611** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003612*/
drhb21e7c72008-06-22 12:37:57 +00003613void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003614 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003615}
3616
drh652fbf52008-04-01 01:42:41 +00003617/*
drh12abf402016-08-22 14:30:05 +00003618** Convert a scalar expression node to a TK_REGISTER referencing
3619** register iReg. The caller must ensure that iReg already contains
3620** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003621*/
dan069d1b12019-06-16 08:58:14 +00003622static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003623 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drha4c3c872013-09-12 17:29:25 +00003624 p->op2 = p->op;
3625 p->op = TK_REGISTER;
3626 p->iTable = iReg;
3627 ExprClearProperty(p, EP_Skip);
3628}
3629
drh12abf402016-08-22 14:30:05 +00003630/*
3631** Evaluate an expression (either a vector or a scalar expression) and store
3632** the result in continguous temporary registers. Return the index of
3633** the first register used to store the result.
3634**
3635** If the returned result register is a temporary scalar, then also write
3636** that register number into *piFreeable. If the returned result register
3637** is not a temporary or if the expression is a vector set *piFreeable
3638** to 0.
3639*/
3640static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3641 int iResult;
3642 int nResult = sqlite3ExprVectorSize(p);
3643 if( nResult==1 ){
3644 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3645 }else{
3646 *piFreeable = 0;
3647 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003648#if SQLITE_OMIT_SUBQUERY
3649 iResult = 0;
3650#else
drh85bcdce2018-12-23 21:27:29 +00003651 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003652#endif
drh12abf402016-08-22 14:30:05 +00003653 }else{
3654 int i;
3655 iResult = pParse->nMem+1;
3656 pParse->nMem += nResult;
3657 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003658 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003659 }
3660 }
3661 }
3662 return iResult;
3663}
3664
drh25c42962020-01-01 13:55:08 +00003665/*
drh92a27f72020-02-04 01:41:44 +00003666** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3667** so that a subsequent copy will not be merged into this one.
3668*/
3669static void setDoNotMergeFlagOnCopy(Vdbe *v){
3670 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3671 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3672 }
3673}
3674
3675/*
drh25c42962020-01-01 13:55:08 +00003676** Generate code to implement special SQL functions that are implemented
3677** in-line rather than by using the usual callbacks.
3678*/
3679static int exprCodeInlineFunction(
3680 Parse *pParse, /* Parsing context */
3681 ExprList *pFarg, /* List of function arguments */
3682 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3683 int target /* Store function result in this register */
3684){
3685 int nFarg;
3686 Vdbe *v = pParse->pVdbe;
3687 assert( v!=0 );
3688 assert( pFarg!=0 );
3689 nFarg = pFarg->nExpr;
3690 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3691 switch( iFuncId ){
3692 case INLINEFUNC_coalesce: {
3693 /* Attempt a direct implementation of the built-in COALESCE() and
3694 ** IFNULL() functions. This avoids unnecessary evaluation of
3695 ** arguments past the first non-NULL argument.
3696 */
3697 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3698 int i;
3699 assert( nFarg>=2 );
3700 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3701 for(i=1; i<nFarg; i++){
3702 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3703 VdbeCoverage(v);
3704 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3705 }
drh92a27f72020-02-04 01:41:44 +00003706 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003707 sqlite3VdbeResolveLabel(v, endCoalesce);
3708 break;
3709 }
drh3c0e6062020-05-13 18:03:34 +00003710 case INLINEFUNC_iif: {
3711 Expr caseExpr;
3712 memset(&caseExpr, 0, sizeof(caseExpr));
3713 caseExpr.op = TK_CASE;
3714 caseExpr.x.pList = pFarg;
3715 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3716 }
drh25c42962020-01-01 13:55:08 +00003717
drh171c50e2020-01-01 15:43:30 +00003718 default: {
drh25c42962020-01-01 13:55:08 +00003719 /* The UNLIKELY() function is a no-op. The result is the value
3720 ** of the first argument.
3721 */
drh171c50e2020-01-01 15:43:30 +00003722 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003723 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3724 break;
3725 }
3726
drh171c50e2020-01-01 15:43:30 +00003727 /***********************************************************************
3728 ** Test-only SQL functions that are only usable if enabled
3729 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3730 */
3731 case INLINEFUNC_expr_compare: {
3732 /* Compare two expressions using sqlite3ExprCompare() */
3733 assert( nFarg==2 );
3734 sqlite3VdbeAddOp2(v, OP_Integer,
3735 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3736 target);
3737 break;
3738 }
3739
3740 case INLINEFUNC_expr_implies_expr: {
3741 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3742 assert( nFarg==2 );
3743 sqlite3VdbeAddOp2(v, OP_Integer,
3744 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3745 target);
3746 break;
3747 }
3748
3749 case INLINEFUNC_implies_nonnull_row: {
3750 /* REsult of sqlite3ExprImpliesNonNullRow() */
3751 Expr *pA1;
3752 assert( nFarg==2 );
3753 pA1 = pFarg->a[1].pExpr;
3754 if( pA1->op==TK_COLUMN ){
3755 sqlite3VdbeAddOp2(v, OP_Integer,
3756 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3757 target);
3758 }else{
3759 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3760 }
3761 break;
3762 }
3763
drh25c42962020-01-01 13:55:08 +00003764#ifdef SQLITE_DEBUG
3765 case INLINEFUNC_affinity: {
3766 /* The AFFINITY() function evaluates to a string that describes
3767 ** the type affinity of the argument. This is used for testing of
3768 ** the SQLite type logic.
3769 */
3770 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3771 char aff;
3772 assert( nFarg==1 );
3773 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3774 sqlite3VdbeLoadString(v, target,
3775 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3776 break;
3777 }
3778#endif
3779 }
3780 return target;
3781}
3782
dan71c57db2016-07-09 20:23:55 +00003783
drha4c3c872013-09-12 17:29:25 +00003784/*
drhcce7d172000-05-31 15:34:51 +00003785** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003786** expression. Attempt to store the results in register "target".
3787** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003788**
drh8b213892008-08-29 02:14:02 +00003789** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003790** be stored in target. The result might be stored in some other
3791** register if it is convenient to do so. The calling function
3792** must check the return code and move the results to the desired
3793** register.
drhcce7d172000-05-31 15:34:51 +00003794*/
drh678ccce2008-03-31 18:19:54 +00003795int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003796 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3797 int op; /* The opcode being coded */
3798 int inReg = target; /* Results stored in register inReg */
3799 int regFree1 = 0; /* If non-zero free this temporary register */
3800 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003801 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003802 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003803 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003804
drh9cbf3422008-01-17 16:22:13 +00003805 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003806 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003807
drh1efa8022018-04-28 04:16:43 +00003808expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003809 if( pExpr==0 ){
3810 op = TK_NULL;
3811 }else{
drhe7375bf2020-03-10 19:24:38 +00003812 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003813 op = pExpr->op;
3814 }
drhf2bc0132004-10-04 13:19:23 +00003815 switch( op ){
drh13449892005-09-07 21:22:45 +00003816 case TK_AGG_COLUMN: {
3817 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003818 struct AggInfo_col *pCol;
3819 assert( pAggInfo!=0 );
3820 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3821 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003822 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003823 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003824 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003825 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003826 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003827 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003828 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003829 if( pCol->iColumn<0 ){
3830 VdbeComment((v,"%s.rowid",pTab->zName));
3831 }else{
3832 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3833 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3834 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3835 }
drh0c76e892020-03-10 11:50:43 +00003836 }
drhc332cc32016-09-19 10:24:19 +00003837 return target;
drh13449892005-09-07 21:22:45 +00003838 }
3839 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00003840 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00003841 }
drh967e8b72000-06-21 13:59:10 +00003842 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003843 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003844 int iReg;
drhefad2e22018-07-27 16:57:11 +00003845 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003846 /* This COLUMN expression is really a constant due to WHERE clause
3847 ** constraints, and that constant is coded by the pExpr->pLeft
3848 ** expresssion. However, make sure the constant has the correct
3849 ** datatype by applying the Affinity of the table column to the
3850 ** constant.
3851 */
drh57f7ece2019-11-21 18:28:44 +00003852 int aff;
drh67b9ba12019-12-20 20:45:02 +00003853 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003854 if( pExpr->y.pTab ){
3855 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3856 }else{
3857 aff = pExpr->affExpr;
3858 }
drh96fb16e2019-08-06 14:37:24 +00003859 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003860 static const char zAff[] = "B\000C\000D\000E";
3861 assert( SQLITE_AFF_BLOB=='A' );
3862 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003863 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3864 &zAff[(aff-'B')*2], P4_STATIC);
3865 }
3866 return iReg;
drhefad2e22018-07-27 16:57:11 +00003867 }
drhb2b9d3d2013-08-01 01:14:43 +00003868 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003869 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003870 /* Other columns in the same row for CHECK constraints or
3871 ** generated columns or for inserting into partial index.
3872 ** The row is unpacked into registers beginning at
3873 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3874 ** immediately prior to the first column.
3875 */
3876 Column *pCol;
3877 Table *pTab = pExpr->y.pTab;
3878 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003879 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003880 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003881 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003882 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003883 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003884 return -1-pParse->iSelfTab;
3885 }
drhc5f808d2019-10-19 15:01:52 +00003886 pCol = pTab->aCol + iCol;
3887 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3888 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003889#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3890 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003891 if( pCol->colFlags & COLFLAG_BUSY ){
3892 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3893 pCol->zName);
3894 return 0;
3895 }
3896 pCol->colFlags |= COLFLAG_BUSY;
3897 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3898 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3899 }
3900 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003901 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003902 }else
3903#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3904 if( pCol->affinity==SQLITE_AFF_REAL ){
3905 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003906 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3907 return target;
3908 }else{
drh9942ef02019-10-18 02:19:18 +00003909 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003910 }
drhb2b9d3d2013-08-01 01:14:43 +00003911 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003912 /* Coding an expression that is part of an index where column names
3913 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003914 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003915 }
drh22827922000-06-06 17:27:05 +00003916 }
drh67b9ba12019-12-20 20:45:02 +00003917 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003918 pExpr->iColumn, iTab, target,
3919 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003920 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3921 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
3922 }
3923 return iReg;
drhcce7d172000-05-31 15:34:51 +00003924 }
3925 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00003926 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00003927 return target;
drhfec19aa2004-05-19 20:41:03 +00003928 }
drh8abed7b2018-02-26 18:49:05 +00003929 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00003930 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00003931 return target;
3932 }
drh13573c72010-01-12 17:04:07 +00003933#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003934 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00003935 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3936 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00003937 return target;
drh598f1342007-10-23 15:39:45 +00003938 }
drh13573c72010-01-12 17:04:07 +00003939#endif
drhfec19aa2004-05-19 20:41:03 +00003940 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00003941 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00003942 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00003943 return target;
drhcce7d172000-05-31 15:34:51 +00003944 }
drhaac30f92019-12-14 15:01:55 +00003945 default: {
drhc29af652019-12-18 21:22:40 +00003946 /* Make NULL the default case so that if a bug causes an illegal
3947 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00003948 ** sanely and not crash. But keep the assert() to bring the problem
3949 ** to the attention of the developers. */
3950 assert( op==TK_NULL );
drh9de221d2008-01-05 06:51:30 +00003951 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00003952 return target;
drhf0863fe2005-06-12 21:35:51 +00003953 }
danielk19775338a5f2005-01-20 13:03:10 +00003954#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00003955 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00003956 int n;
3957 const char *z;
drhca48c902008-01-18 14:08:24 +00003958 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00003959 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3960 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
3961 assert( pExpr->u.zToken[1]=='\'' );
3962 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00003963 n = sqlite3Strlen30(z) - 1;
3964 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00003965 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3966 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00003967 return target;
danielk1977c572ef72004-05-27 09:28:41 +00003968 }
danielk19775338a5f2005-01-20 13:03:10 +00003969#endif
drh50457892003-09-06 01:10:47 +00003970 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00003971 assert( !ExprHasProperty(pExpr, EP_IntValue) );
3972 assert( pExpr->u.zToken!=0 );
3973 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00003974 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
3975 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00003976 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00003977 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00003978 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00003979 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00003980 }
drhc332cc32016-09-19 10:24:19 +00003981 return target;
drh50457892003-09-06 01:10:47 +00003982 }
drh4e0cff62004-11-05 05:10:28 +00003983 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00003984 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00003985 }
drh487e2622005-06-25 18:42:14 +00003986#ifndef SQLITE_OMIT_CAST
3987 case TK_CAST: {
3988 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00003989 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00003990 if( inReg!=target ){
3991 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
3992 inReg = target;
3993 }
drh4169e432014-08-25 20:11:52 +00003994 sqlite3VdbeAddOp2(v, OP_Cast, target,
3995 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00003996 return inReg;
drh487e2622005-06-25 18:42:14 +00003997 }
3998#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00003999 case TK_IS:
4000 case TK_ISNOT:
4001 op = (op==TK_IS) ? TK_EQ : TK_NE;
4002 p5 = SQLITE_NULLEQ;
4003 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004004 case TK_LT:
4005 case TK_LE:
4006 case TK_GT:
4007 case TK_GE:
4008 case TK_NE:
4009 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004010 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004011 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004012 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004013 }else{
4014 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4015 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4016 codeCompare(pParse, pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004017 r1, r2, inReg, SQLITE_STOREP2 | p5,
4018 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004019 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4020 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4021 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4022 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4023 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4024 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4025 testcase( regFree1==0 );
4026 testcase( regFree2==0 );
4027 }
drh6a2fe092009-09-23 02:29:36 +00004028 break;
4029 }
drhcce7d172000-05-31 15:34:51 +00004030 case TK_AND:
4031 case TK_OR:
4032 case TK_PLUS:
4033 case TK_STAR:
4034 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004035 case TK_REM:
4036 case TK_BITAND:
4037 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004038 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004039 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004040 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004041 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004042 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4043 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4044 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4045 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4046 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4047 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4048 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4049 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4050 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4051 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4052 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004053 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4054 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004055 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004056 testcase( regFree1==0 );
4057 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004058 break;
4059 }
drhcce7d172000-05-31 15:34:51 +00004060 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004061 Expr *pLeft = pExpr->pLeft;
4062 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004063 if( pLeft->op==TK_INTEGER ){
4064 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004065 return target;
drh13573c72010-01-12 17:04:07 +00004066#ifndef SQLITE_OMIT_FLOATING_POINT
4067 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004068 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4069 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004070 return target;
drh13573c72010-01-12 17:04:07 +00004071#endif
drh3c84ddf2008-01-09 02:15:38 +00004072 }else{
drh10d1edf2013-11-15 15:52:39 +00004073 tempX.op = TK_INTEGER;
4074 tempX.flags = EP_IntValue|EP_TokenOnly;
4075 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004076 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004077 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004078 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004079 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004080 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004081 }
drh3c84ddf2008-01-09 02:15:38 +00004082 break;
drh6e142f52000-06-08 13:36:40 +00004083 }
drhbf4133c2001-10-13 02:59:08 +00004084 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004085 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004086 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4087 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004088 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4089 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004090 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004091 break;
4092 }
drh8abed7b2018-02-26 18:49:05 +00004093 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004094 int isTrue; /* IS TRUE or IS NOT TRUE */
4095 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004096 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4097 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004098 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4099 bNormal = pExpr->op2==TK_IS;
4100 testcase( isTrue && bNormal);
4101 testcase( !isTrue && bNormal);
4102 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004103 break;
4104 }
drhcce7d172000-05-31 15:34:51 +00004105 case TK_ISNULL:
4106 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004107 int addr;
drh7d176102014-02-18 03:07:12 +00004108 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4109 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004110 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004111 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004112 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004113 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004114 VdbeCoverageIf(v, op==TK_ISNULL);
4115 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004116 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004117 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004118 break;
drhcce7d172000-05-31 15:34:51 +00004119 }
drh22827922000-06-06 17:27:05 +00004120 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004121 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004122 if( pInfo==0
4123 || NEVER(pExpr->iAgg<0)
4124 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4125 ){
drh33e619f2009-05-28 01:00:55 +00004126 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4127 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004128 }else{
drhc332cc32016-09-19 10:24:19 +00004129 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004130 }
drh22827922000-06-06 17:27:05 +00004131 break;
4132 }
drhcce7d172000-05-31 15:34:51 +00004133 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004134 ExprList *pFarg; /* List of function arguments */
4135 int nFarg; /* Number of function arguments */
4136 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004137 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004138 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004139 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004140 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004141 u8 enc = ENC(db); /* The text encoding used by this database */
4142 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004143
dan67a9b8e2018-06-22 20:51:35 +00004144#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004145 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4146 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004147 }
dan67a9b8e2018-06-22 20:51:35 +00004148#endif
dan86fb6e12018-05-16 20:58:07 +00004149
drh1e9b53f2017-01-04 01:07:24 +00004150 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004151 /* SQL functions can be expensive. So try to avoid running them
4152 ** multiple times if we know they always give the same result */
4153 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004154 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004155 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004156 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4157 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004158 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004159 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4160 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004161 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004162#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4163 if( pDef==0 && pParse->explain ){
4164 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4165 }
4166#endif
danb6e9f7a2018-05-19 14:15:29 +00004167 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004168 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004169 break;
4170 }
drh25c42962020-01-01 13:55:08 +00004171 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004172 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4173 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004174 return exprCodeInlineFunction(pParse, pFarg,
4175 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004176 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4177 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004178 }
4179
drhd1a01ed2013-11-21 16:08:52 +00004180 for(i=0; i<nFarg; i++){
4181 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004182 testcase( i==31 );
4183 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004184 }
4185 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4186 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4187 }
4188 }
drh12ffee82009-04-08 13:51:51 +00004189 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004190 if( constMask ){
4191 r1 = pParse->nMem+1;
4192 pParse->nMem += nFarg;
4193 }else{
4194 r1 = sqlite3GetTempRange(pParse, nFarg);
4195 }
drha748fdc2012-03-28 01:34:47 +00004196
4197 /* For length() and typeof() functions with a column argument,
4198 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4199 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4200 ** loading.
4201 */
drhd36e1042013-09-06 13:10:12 +00004202 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004203 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004204 assert( nFarg==1 );
4205 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004206 exprOp = pFarg->a[0].pExpr->op;
4207 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004208 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4209 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004210 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4211 pFarg->a[0].pExpr->op2 =
4212 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004213 }
4214 }
4215
drh5579d592015-08-26 14:01:41 +00004216 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004217 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004218 }else{
drh12ffee82009-04-08 13:51:51 +00004219 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004220 }
drhb7f6f682006-07-08 17:06:43 +00004221#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004222 /* Possibly overload the function if the first argument is
4223 ** a virtual table column.
4224 **
4225 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4226 ** second argument, not the first, as the argument to test to
4227 ** see if it is a column in a virtual table. This is done because
4228 ** the left operand of infix functions (the operand we want to
4229 ** control overloading) ends up as the second argument to the
4230 ** function. The expression "A glob B" is equivalent to
4231 ** "glob(B,A). We want to use the A in "A glob B" to test
4232 ** for function overloading. But we use the B term in "glob(B,A)".
4233 */
drh59155062018-05-26 18:03:48 +00004234 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004235 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4236 }else if( nFarg>0 ){
4237 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004238 }
4239#endif
drhd36e1042013-09-06 13:10:12 +00004240 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004241 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004242 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004243 }
drh092457b2017-12-29 15:04:49 +00004244#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4245 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004246 Expr *pArg = pFarg->a[0].pExpr;
4247 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004248 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004249 }else{
4250 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4251 }
drh092457b2017-12-29 15:04:49 +00004252 }else
4253#endif
4254 {
drh920cf592019-10-30 16:29:02 +00004255 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004256 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004257 }
drh13d79502019-12-23 02:18:49 +00004258 if( nFarg ){
4259 if( constMask==0 ){
4260 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4261 }else{
drh3aef2fb2020-01-02 17:46:02 +00004262 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004263 }
drh2dcef112008-01-12 19:03:48 +00004264 }
drhc332cc32016-09-19 10:24:19 +00004265 return target;
drhcce7d172000-05-31 15:34:51 +00004266 }
drhfe2093d2005-01-20 22:48:47 +00004267#ifndef SQLITE_OMIT_SUBQUERY
4268 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004269 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004270 int nCol;
drhc5499be2008-04-01 15:06:33 +00004271 testcase( op==TK_EXISTS );
4272 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004273 if( pParse->db->mallocFailed ){
4274 return 0;
4275 }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
dan8da209b2016-07-26 18:06:08 +00004276 sqlite3SubselectError(pParse, nCol, 1);
4277 }else{
drh85bcdce2018-12-23 21:27:29 +00004278 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004279 }
drh19a775c2000-06-05 18:54:46 +00004280 break;
4281 }
drhfc7f27b2016-08-20 00:07:01 +00004282 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004283 int n;
drhfc7f27b2016-08-20 00:07:01 +00004284 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004285 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004286 }
drh966e2912017-01-03 02:58:01 +00004287 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
drh554a9dc2019-08-26 14:18:28 +00004288 if( pExpr->iTable!=0
4289 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004290 ){
4291 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4292 pExpr->iTable, n);
4293 }
drhc332cc32016-09-19 10:24:19 +00004294 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004295 }
drhfef52082000-06-06 01:50:43 +00004296 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004297 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4298 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004299 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4300 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4301 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4302 sqlite3VdbeResolveLabel(v, destIfFalse);
4303 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4304 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004305 return target;
drhfef52082000-06-06 01:50:43 +00004306 }
drhe3365e62009-11-12 17:52:24 +00004307#endif /* SQLITE_OMIT_SUBQUERY */
4308
4309
drh2dcef112008-01-12 19:03:48 +00004310 /*
4311 ** x BETWEEN y AND z
4312 **
4313 ** This is equivalent to
4314 **
4315 ** x>=y AND x<=z
4316 **
4317 ** X is stored in pExpr->pLeft.
4318 ** Y is stored in pExpr->pList->a[0].pExpr.
4319 ** Z is stored in pExpr->pList->a[1].pExpr.
4320 */
drhfef52082000-06-06 01:50:43 +00004321 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004322 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004323 return target;
drhfef52082000-06-06 01:50:43 +00004324 }
drh94fa9c42016-02-27 21:16:04 +00004325 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004326 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004327 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004328 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004329 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004330 }
drh2dcef112008-01-12 19:03:48 +00004331
dan165921a2009-08-28 18:53:45 +00004332 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004333 /* If the opcode is TK_TRIGGER, then the expression is a reference
4334 ** to a column in the new.* or old.* pseudo-tables available to
4335 ** trigger programs. In this case Expr.iTable is set to 1 for the
4336 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4337 ** is set to the column of the pseudo-table to read, or to -1 to
4338 ** read the rowid field.
4339 **
4340 ** The expression is implemented using an OP_Param opcode. The p1
4341 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4342 ** to reference another column of the old.* pseudo-table, where
4343 ** i is the index of the column. For a new.rowid reference, p1 is
4344 ** set to (n+1), where n is the number of columns in each pseudo-table.
4345 ** For a reference to any other column in the new.* pseudo-table, p1
4346 ** is set to (n+2+i), where n and i are as defined previously. For
4347 ** example, if the table on which triggers are being fired is
4348 ** declared as:
4349 **
4350 ** CREATE TABLE t1(a, b);
4351 **
4352 ** Then p1 is interpreted as follows:
4353 **
4354 ** p1==0 -> old.rowid p1==3 -> new.rowid
4355 ** p1==1 -> old.a p1==4 -> new.a
4356 ** p1==2 -> old.b p1==5 -> new.b
4357 */
drheda079c2018-09-20 19:02:15 +00004358 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004359 int iCol = pExpr->iColumn;
4360 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004361 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004362
4363 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004364 assert( iCol>=-1 && iCol<pTab->nCol );
4365 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004366 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4367
4368 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004369 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004370 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004371 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004372 ));
dan65a7cd12009-09-01 12:16:01 +00004373
drh44dbca82010-01-13 04:22:20 +00004374#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004375 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004376 ** integer. Use OP_RealAffinity to make sure it is really real.
4377 **
4378 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4379 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004380 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004381 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4382 }
drh44dbca82010-01-13 04:22:20 +00004383#endif
dan165921a2009-08-28 18:53:45 +00004384 break;
4385 }
4386
dan71c57db2016-07-09 20:23:55 +00004387 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004388 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004389 break;
4390 }
4391
drh9e9a67a2019-08-17 17:07:15 +00004392 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4393 ** that derive from the right-hand table of a LEFT JOIN. The
4394 ** Expr.iTable value is the table number for the right-hand table.
4395 ** The expression is only evaluated if that table is not currently
4396 ** on a LEFT JOIN NULL row.
4397 */
drh31d6fd52017-04-14 19:03:10 +00004398 case TK_IF_NULL_ROW: {
4399 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004400 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004401 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004402 /* Temporarily disable factoring of constant expressions, since
4403 ** even though expressions may appear to be constant, they are not
4404 ** really constant because they originate from the right-hand side
4405 ** of a LEFT JOIN. */
4406 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004407 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004408 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004409 sqlite3VdbeJumpHere(v, addrINR);
4410 sqlite3VdbeChangeP3(v, addrINR, inReg);
4411 break;
4412 }
4413
drh2dcef112008-01-12 19:03:48 +00004414 /*
4415 ** Form A:
4416 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4417 **
4418 ** Form B:
4419 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4420 **
4421 ** Form A is can be transformed into the equivalent form B as follows:
4422 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4423 ** WHEN x=eN THEN rN ELSE y END
4424 **
4425 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004426 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4427 ** odd. The Y is also optional. If the number of elements in x.pList
4428 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004429 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4430 **
4431 ** The result of the expression is the Ri for the first matching Ei,
4432 ** or if there is no matching Ei, the ELSE term Y, or if there is
4433 ** no ELSE term, NULL.
4434 */
drhaac30f92019-12-14 15:01:55 +00004435 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004436 int endLabel; /* GOTO label for end of CASE stmt */
4437 int nextCase; /* GOTO label for next WHEN clause */
4438 int nExpr; /* 2x number of WHEN terms */
4439 int i; /* Loop counter */
4440 ExprList *pEList; /* List of WHEN terms */
4441 struct ExprList_item *aListelem; /* Array of WHEN terms */
4442 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004443 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004444 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004445 Expr *pDel = 0;
4446 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004447
danielk19776ab3a2e2009-02-19 14:39:25 +00004448 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004449 assert(pExpr->x.pList->nExpr > 0);
4450 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004451 aListelem = pEList->a;
4452 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004453 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004454 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004455 pDel = sqlite3ExprDup(db, pX, 0);
4456 if( db->mallocFailed ){
4457 sqlite3ExprDelete(db, pDel);
4458 break;
4459 }
drh33cd4902009-05-30 20:49:20 +00004460 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004461 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004462 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004463 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004464 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004465 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004466 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004467 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4468 ** The value in regFree1 might get SCopy-ed into the file result.
4469 ** So make sure that the regFree1 register is not reused for other
4470 ** purposes and possibly overwritten. */
4471 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004472 }
drhc5cd1242013-09-12 16:50:49 +00004473 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004474 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004475 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004476 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004477 }else{
drh2dcef112008-01-12 19:03:48 +00004478 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004479 }
drhec4ccdb2018-12-29 02:26:59 +00004480 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004481 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004482 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004483 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004484 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004485 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004486 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004487 }
drhc5cd1242013-09-12 16:50:49 +00004488 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004489 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004490 }else{
drh9de221d2008-01-05 06:51:30 +00004491 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004492 }
dan8b65e592019-07-17 14:34:17 +00004493 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004494 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004495 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004496 break;
4497 }
danielk19775338a5f2005-01-20 13:03:10 +00004498#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004499 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004500 assert( pExpr->affExpr==OE_Rollback
4501 || pExpr->affExpr==OE_Abort
4502 || pExpr->affExpr==OE_Fail
4503 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004504 );
drh9e5fdc42020-05-08 19:02:21 +00004505 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004506 sqlite3ErrorMsg(pParse,
4507 "RAISE() may only be used within a trigger-program");
4508 return 0;
4509 }
drh11949042019-08-05 18:01:42 +00004510 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004511 sqlite3MayAbort(pParse);
4512 }
dan165921a2009-08-28 18:53:45 +00004513 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004514 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004515 sqlite3VdbeAddOp4(
4516 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004517 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004518 }else{
drh9e5fdc42020-05-08 19:02:21 +00004519 sqlite3HaltConstraint(pParse,
4520 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4521 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004522 }
4523
drhffe07b22005-11-03 00:41:17 +00004524 break;
drh17a7f8d2002-03-24 13:13:27 +00004525 }
danielk19775338a5f2005-01-20 13:03:10 +00004526#endif
drhffe07b22005-11-03 00:41:17 +00004527 }
drh2dcef112008-01-12 19:03:48 +00004528 sqlite3ReleaseTempReg(pParse, regFree1);
4529 sqlite3ReleaseTempReg(pParse, regFree2);
4530 return inReg;
4531}
4532
4533/*
drh9b258c52020-03-11 19:41:49 +00004534** Generate code that will evaluate expression pExpr just one time
4535** per prepared statement execution.
4536**
4537** If the expression uses functions (that might throw an exception) then
4538** guard them with an OP_Once opcode to ensure that the code is only executed
4539** once. If no functions are involved, then factor the code out and put it at
4540** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004541**
drhad879ff2017-01-04 04:10:02 +00004542** If regDest>=0 then the result is always stored in that register and the
4543** result is not reusable. If regDest<0 then this routine is free to
4544** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004545** is stored is returned. When regDest<0, two identical expressions might
4546** code to the same register, if they do not contain function calls and hence
4547** are factored out into the initialization section at the end of the
4548** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004549*/
drh9b258c52020-03-11 19:41:49 +00004550int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004551 Parse *pParse, /* Parsing context */
4552 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004553 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004554){
drhd1a01ed2013-11-21 16:08:52 +00004555 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004556 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004557 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004558 if( regDest<0 && p ){
4559 struct ExprList_item *pItem;
4560 int i;
4561 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004562 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004563 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004564 }
4565 }
drh1e9b53f2017-01-04 01:07:24 +00004566 }
drhd1a01ed2013-11-21 16:08:52 +00004567 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004568 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4569 Vdbe *v = pParse->pVdbe;
4570 int addr;
4571 assert( v );
4572 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4573 pParse->okConstFactor = 0;
4574 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004575 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004576 sqlite3ExprCode(pParse, pExpr, regDest);
4577 }
4578 pParse->okConstFactor = 1;
4579 sqlite3ExprDelete(pParse->db, pExpr);
4580 sqlite3VdbeJumpHere(v, addr);
4581 }else{
4582 p = sqlite3ExprListAppend(pParse, p, pExpr);
4583 if( p ){
4584 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4585 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004586 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004587 pItem->u.iConstExprReg = regDest;
4588 }
4589 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004590 }
drh1e9b53f2017-01-04 01:07:24 +00004591 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004592}
4593
4594/*
drh2dcef112008-01-12 19:03:48 +00004595** Generate code to evaluate an expression and store the results
4596** into a register. Return the register number where the results
4597** are stored.
4598**
4599** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004600** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004601** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004602**
4603** If pExpr is a constant, then this routine might generate this
4604** code to fill the register in the initialization section of the
4605** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004606*/
4607int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004608 int r2;
drh0d950af2019-08-22 16:38:42 +00004609 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004610 if( ConstFactorOk(pParse)
drhf30a9692013-11-15 01:10:18 +00004611 && pExpr->op!=TK_REGISTER
4612 && sqlite3ExprIsConstantNotJoin(pExpr)
4613 ){
drhf30a9692013-11-15 01:10:18 +00004614 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004615 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004616 }else{
drhf30a9692013-11-15 01:10:18 +00004617 int r1 = sqlite3GetTempReg(pParse);
4618 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4619 if( r2==r1 ){
4620 *pReg = r1;
4621 }else{
4622 sqlite3ReleaseTempReg(pParse, r1);
4623 *pReg = 0;
4624 }
drh2dcef112008-01-12 19:03:48 +00004625 }
4626 return r2;
4627}
4628
4629/*
4630** Generate code that will evaluate expression pExpr and store the
4631** results in register target. The results are guaranteed to appear
4632** in register target.
4633*/
drh05a86c52014-02-16 01:55:49 +00004634void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004635 int inReg;
4636
drhe7375bf2020-03-10 19:24:38 +00004637 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004638 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004639 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004640 if( pParse->pVdbe==0 ) return;
4641 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4642 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004643 u8 op;
4644 if( ExprHasProperty(pExpr,EP_Subquery) ){
4645 op = OP_Copy;
4646 }else{
4647 op = OP_SCopy;
4648 }
4649 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004650 }
drhcce7d172000-05-31 15:34:51 +00004651}
4652
4653/*
drh1c75c9d2015-12-21 15:22:13 +00004654** Make a transient copy of expression pExpr and then code it using
4655** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4656** except that the input expression is guaranteed to be unchanged.
4657*/
4658void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4659 sqlite3 *db = pParse->db;
4660 pExpr = sqlite3ExprDup(db, pExpr, 0);
4661 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4662 sqlite3ExprDelete(db, pExpr);
4663}
4664
4665/*
drh05a86c52014-02-16 01:55:49 +00004666** Generate code that will evaluate expression pExpr and store the
4667** results in register target. The results are guaranteed to appear
4668** in register target. If the expression is constant, then this routine
4669** might choose to code the expression at initialization time.
4670*/
4671void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004672 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004673 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004674 }else{
drh088489e2020-03-10 02:57:37 +00004675 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004676 }
drhcce7d172000-05-31 15:34:51 +00004677}
4678
4679/*
drh268380c2004-02-25 13:47:31 +00004680** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004681** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004682**
drh3df6c3b2017-09-15 15:38:01 +00004683** Return the number of elements evaluated. The number returned will
4684** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4685** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004686**
4687** The SQLITE_ECEL_DUP flag prevents the arguments from being
4688** filled using OP_SCopy. OP_Copy must be used instead.
4689**
4690** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4691** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004692**
4693** The SQLITE_ECEL_REF flag means that expressions in the list with
4694** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4695** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004696** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4697** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004698*/
danielk19774adee202004-05-08 08:23:19 +00004699int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004700 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004701 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004702 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004703 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004704 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004705){
4706 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004707 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004708 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004709 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004710 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004711 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004712 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004713 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004714 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004715 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004716 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004717#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4718 if( pItem->bSorterRef ){
4719 i--;
4720 n--;
4721 }else
4722#endif
dan257c13f2016-11-10 20:14:06 +00004723 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4724 if( flags & SQLITE_ECEL_OMITREF ){
4725 i--;
4726 n--;
4727 }else{
4728 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4729 }
drhb8b06692018-08-04 15:16:20 +00004730 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4731 && sqlite3ExprIsConstantNotJoin(pExpr)
4732 ){
drh9b258c52020-03-11 19:41:49 +00004733 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004734 }else{
4735 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4736 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004737 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004738 if( copyOp==OP_Copy
4739 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4740 && pOp->p1+pOp->p3+1==inReg
4741 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004742 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004743 ){
4744 pOp->p3++;
4745 }else{
4746 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4747 }
drhd1a01ed2013-11-21 16:08:52 +00004748 }
drhd1766112008-09-17 00:13:12 +00004749 }
drh268380c2004-02-25 13:47:31 +00004750 }
drhf9b596e2004-05-26 16:54:42 +00004751 return n;
drh268380c2004-02-25 13:47:31 +00004752}
4753
4754/*
drh36c563a2009-11-12 13:32:22 +00004755** Generate code for a BETWEEN operator.
4756**
4757** x BETWEEN y AND z
4758**
4759** The above is equivalent to
4760**
4761** x>=y AND x<=z
4762**
4763** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004764** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004765**
4766** The xJumpIf parameter determines details:
4767**
4768** NULL: Store the boolean result in reg[dest]
4769** sqlite3ExprIfTrue: Jump to dest if true
4770** sqlite3ExprIfFalse: Jump to dest if false
4771**
4772** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004773*/
4774static void exprCodeBetween(
4775 Parse *pParse, /* Parsing and code generating context */
4776 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004777 int dest, /* Jump destination or storage location */
4778 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004779 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4780){
dan8b65e592019-07-17 14:34:17 +00004781 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004782 Expr compLeft; /* The x>=y term */
4783 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004784 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004785 Expr *pDel = 0;
4786 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004787
dan71c57db2016-07-09 20:23:55 +00004788 memset(&compLeft, 0, sizeof(Expr));
4789 memset(&compRight, 0, sizeof(Expr));
4790 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004791
4792 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004793 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4794 if( db->mallocFailed==0 ){
4795 exprAnd.op = TK_AND;
4796 exprAnd.pLeft = &compLeft;
4797 exprAnd.pRight = &compRight;
4798 compLeft.op = TK_GE;
4799 compLeft.pLeft = pDel;
4800 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4801 compRight.op = TK_LE;
4802 compRight.pLeft = pDel;
4803 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4804 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4805 if( xJump ){
4806 xJump(pParse, &exprAnd, dest, jumpIfNull);
4807 }else{
4808 /* Mark the expression is being from the ON or USING clause of a join
4809 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4810 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4811 ** for clarity, but we are out of bits in the Expr.flags field so we
4812 ** have to reuse the EP_FromJoin bit. Bummer. */
4813 pDel->flags |= EP_FromJoin;
4814 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4815 }
4816 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004817 }
dan8b65e592019-07-17 14:34:17 +00004818 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004819
4820 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004821 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4822 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4823 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4824 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4825 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4826 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4827 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4828 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004829 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004830}
4831
4832/*
drhcce7d172000-05-31 15:34:51 +00004833** Generate code for a boolean expression such that a jump is made
4834** to the label "dest" if the expression is true but execution
4835** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004836**
4837** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004838** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004839**
4840** This code depends on the fact that certain token values (ex: TK_EQ)
4841** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4842** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4843** the make process cause these values to align. Assert()s in the code
4844** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004845*/
danielk19774adee202004-05-08 08:23:19 +00004846void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004847 Vdbe *v = pParse->pVdbe;
4848 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004849 int regFree1 = 0;
4850 int regFree2 = 0;
4851 int r1, r2;
4852
drh35573352008-01-08 23:54:25 +00004853 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004854 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004855 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004856 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004857 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004858 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004859 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004860 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004861 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4862 if( pAlt!=pExpr ){
4863 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4864 }else if( op==TK_AND ){
4865 int d2 = sqlite3VdbeMakeLabel(pParse);
4866 testcase( jumpIfNull==0 );
4867 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4868 jumpIfNull^SQLITE_JUMPIFNULL);
4869 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4870 sqlite3VdbeResolveLabel(v, d2);
4871 }else{
4872 testcase( jumpIfNull==0 );
4873 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4874 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4875 }
drhcce7d172000-05-31 15:34:51 +00004876 break;
4877 }
4878 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004879 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004880 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004881 break;
4882 }
drh8abed7b2018-02-26 18:49:05 +00004883 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004884 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4885 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004886 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004887 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004888 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004889 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004890 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004891 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004892 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4893 isNot ? SQLITE_JUMPIFNULL : 0);
4894 }else{
4895 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4896 isNot ? SQLITE_JUMPIFNULL : 0);
4897 }
drh007c8432018-02-26 03:20:18 +00004898 break;
4899 }
drhde845c22016-03-17 19:07:52 +00004900 case TK_IS:
4901 case TK_ISNOT:
4902 testcase( op==TK_IS );
4903 testcase( op==TK_ISNOT );
4904 op = (op==TK_IS) ? TK_EQ : TK_NE;
4905 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00004906 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00004907 case TK_LT:
4908 case TK_LE:
4909 case TK_GT:
4910 case TK_GE:
4911 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004912 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004913 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00004914 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00004915 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4916 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00004917 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00004918 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00004919 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4920 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4921 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4922 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00004923 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4924 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4925 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4926 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4927 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4928 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00004929 testcase( regFree1==0 );
4930 testcase( regFree2==0 );
4931 break;
4932 }
drhcce7d172000-05-31 15:34:51 +00004933 case TK_ISNULL:
4934 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00004935 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4936 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00004937 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4938 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00004939 VdbeCoverageIf(v, op==TK_ISNULL);
4940 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00004941 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00004942 break;
4943 }
drhfef52082000-06-06 01:50:43 +00004944 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00004945 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00004946 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00004947 break;
4948 }
drh84e30ca2011-02-10 17:46:14 +00004949#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00004950 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004951 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004952 int destIfNull = jumpIfNull ? dest : destIfFalse;
4953 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00004954 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00004955 sqlite3VdbeResolveLabel(v, destIfFalse);
4956 break;
4957 }
shanehbb201342011-02-09 19:55:20 +00004958#endif
drhcce7d172000-05-31 15:34:51 +00004959 default: {
dan7b35a772016-07-28 19:47:15 +00004960 default_expr:
drhad317272019-04-19 16:21:51 +00004961 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00004962 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00004963 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00004964 /* No-op */
4965 }else{
4966 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
4967 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00004968 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00004969 testcase( regFree1==0 );
4970 testcase( jumpIfNull==0 );
4971 }
drhcce7d172000-05-31 15:34:51 +00004972 break;
4973 }
4974 }
drh2dcef112008-01-12 19:03:48 +00004975 sqlite3ReleaseTempReg(pParse, regFree1);
4976 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00004977}
4978
4979/*
drh66b89c82000-11-28 20:47:17 +00004980** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00004981** to the label "dest" if the expression is false but execution
4982** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00004983**
4984** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00004985** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
4986** is 0.
drhcce7d172000-05-31 15:34:51 +00004987*/
danielk19774adee202004-05-08 08:23:19 +00004988void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004989 Vdbe *v = pParse->pVdbe;
4990 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004991 int regFree1 = 0;
4992 int regFree2 = 0;
4993 int r1, r2;
4994
drh35573352008-01-08 23:54:25 +00004995 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004996 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004997 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00004998 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004999
5000 /* The value of pExpr->op and op are related as follows:
5001 **
5002 ** pExpr->op op
5003 ** --------- ----------
5004 ** TK_ISNULL OP_NotNull
5005 ** TK_NOTNULL OP_IsNull
5006 ** TK_NE OP_Eq
5007 ** TK_EQ OP_Ne
5008 ** TK_GT OP_Le
5009 ** TK_LE OP_Gt
5010 ** TK_GE OP_Lt
5011 ** TK_LT OP_Ge
5012 **
5013 ** For other values of pExpr->op, op is undefined and unused.
5014 ** The value of TK_ and OP_ constants are arranged such that we
5015 ** can compute the mapping above using the following expression.
5016 ** Assert()s verify that the computation is correct.
5017 */
5018 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5019
5020 /* Verify correct alignment of TK_ and OP_ constants
5021 */
5022 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5023 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5024 assert( pExpr->op!=TK_NE || op==OP_Eq );
5025 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5026 assert( pExpr->op!=TK_LT || op==OP_Ge );
5027 assert( pExpr->op!=TK_LE || op==OP_Gt );
5028 assert( pExpr->op!=TK_GT || op==OP_Le );
5029 assert( pExpr->op!=TK_GE || op==OP_Lt );
5030
danba00e302016-07-23 20:24:06 +00005031 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005032 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005033 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005034 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5035 if( pAlt!=pExpr ){
5036 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5037 }else if( pExpr->op==TK_AND ){
5038 testcase( jumpIfNull==0 );
5039 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5040 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5041 }else{
5042 int d2 = sqlite3VdbeMakeLabel(pParse);
5043 testcase( jumpIfNull==0 );
5044 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5045 jumpIfNull^SQLITE_JUMPIFNULL);
5046 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5047 sqlite3VdbeResolveLabel(v, d2);
5048 }
drhcce7d172000-05-31 15:34:51 +00005049 break;
5050 }
5051 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005052 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005053 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005054 break;
5055 }
drh8abed7b2018-02-26 18:49:05 +00005056 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005057 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5058 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005059 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005060 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005061 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005062 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005063 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005064 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005065 /* IS TRUE and IS NOT FALSE */
5066 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5067 isNot ? 0 : SQLITE_JUMPIFNULL);
5068
5069 }else{
5070 /* IS FALSE and IS NOT TRUE */
5071 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005072 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005073 }
drh007c8432018-02-26 03:20:18 +00005074 break;
5075 }
drhde845c22016-03-17 19:07:52 +00005076 case TK_IS:
5077 case TK_ISNOT:
5078 testcase( pExpr->op==TK_IS );
5079 testcase( pExpr->op==TK_ISNOT );
5080 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5081 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005082 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005083 case TK_LT:
5084 case TK_LE:
5085 case TK_GT:
5086 case TK_GE:
5087 case TK_NE:
5088 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005089 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005090 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005091 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5092 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005093 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005094 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005095 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5096 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5097 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5098 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005099 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5100 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5101 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5102 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5103 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5104 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005105 testcase( regFree1==0 );
5106 testcase( regFree2==0 );
5107 break;
5108 }
drhcce7d172000-05-31 15:34:51 +00005109 case TK_ISNULL:
5110 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005111 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5112 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005113 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5114 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005115 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005116 break;
5117 }
drhfef52082000-06-06 01:50:43 +00005118 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005119 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005120 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005121 break;
5122 }
drh84e30ca2011-02-10 17:46:14 +00005123#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005124 case TK_IN: {
5125 if( jumpIfNull ){
5126 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5127 }else{
drhec4ccdb2018-12-29 02:26:59 +00005128 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005129 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5130 sqlite3VdbeResolveLabel(v, destIfNull);
5131 }
5132 break;
5133 }
shanehbb201342011-02-09 19:55:20 +00005134#endif
drhcce7d172000-05-31 15:34:51 +00005135 default: {
danba00e302016-07-23 20:24:06 +00005136 default_expr:
drhad317272019-04-19 16:21:51 +00005137 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005138 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005139 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005140 /* no-op */
5141 }else{
5142 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5143 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005144 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005145 testcase( regFree1==0 );
5146 testcase( jumpIfNull==0 );
5147 }
drhcce7d172000-05-31 15:34:51 +00005148 break;
5149 }
5150 }
drh2dcef112008-01-12 19:03:48 +00005151 sqlite3ReleaseTempReg(pParse, regFree1);
5152 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005153}
drh22827922000-06-06 17:27:05 +00005154
5155/*
drh72bc8202015-06-11 13:58:35 +00005156** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5157** code generation, and that copy is deleted after code generation. This
5158** ensures that the original pExpr is unchanged.
5159*/
5160void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5161 sqlite3 *db = pParse->db;
5162 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5163 if( db->mallocFailed==0 ){
5164 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5165 }
5166 sqlite3ExprDelete(db, pCopy);
5167}
5168
dan5aa550c2017-06-24 18:10:29 +00005169/*
5170** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5171** type of expression.
5172**
5173** If pExpr is a simple SQL value - an integer, real, string, blob
5174** or NULL value - then the VDBE currently being prepared is configured
5175** to re-prepare each time a new value is bound to variable pVar.
5176**
5177** Additionally, if pExpr is a simple SQL value and the value is the
5178** same as that currently bound to variable pVar, non-zero is returned.
5179** Otherwise, if the values are not the same or if pExpr is not a simple
5180** SQL value, zero is returned.
5181*/
5182static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5183 int res = 0;
drhc0804222017-06-28 21:47:16 +00005184 int iVar;
5185 sqlite3_value *pL, *pR = 0;
5186
5187 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5188 if( pR ){
5189 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005190 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005191 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005192 if( pL ){
5193 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5194 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5195 }
5196 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005197 }
drhc0804222017-06-28 21:47:16 +00005198 sqlite3ValueFree(pR);
5199 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005200 }
5201
5202 return res;
5203}
drh72bc8202015-06-11 13:58:35 +00005204
5205/*
drh1d9da702010-01-07 15:17:02 +00005206** Do a deep comparison of two expression trees. Return 0 if the two
5207** expressions are completely identical. Return 1 if they differ only
5208** by a COLLATE operator at the top level. Return 2 if there are differences
5209** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005210**
drh619a1302013-08-01 13:04:46 +00005211** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5212** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5213**
drh66518ca2013-08-01 15:09:57 +00005214** The pA side might be using TK_REGISTER. If that is the case and pB is
5215** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5216**
drh1d9da702010-01-07 15:17:02 +00005217** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005218** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005219** identical, we return 2 just to be safe. So if this routine
5220** returns 2, then you do not really know for certain if the two
5221** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005222** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005223** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005224** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005225** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005226**
drhc0804222017-06-28 21:47:16 +00005227** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5228** pParse->pReprepare can be matched against literals in pB. The
5229** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5230** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5231** Argument pParse should normally be NULL. If it is not NULL and pA or
5232** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005233*/
dan5aa550c2017-06-24 18:10:29 +00005234int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005235 u32 combinedFlags;
5236 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005237 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005238 }
dan5aa550c2017-06-24 18:10:29 +00005239 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5240 return 0;
5241 }
drh10d1edf2013-11-15 15:52:39 +00005242 combinedFlags = pA->flags | pB->flags;
5243 if( combinedFlags & EP_IntValue ){
5244 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5245 return 0;
5246 }
drh1d9da702010-01-07 15:17:02 +00005247 return 2;
drh22827922000-06-06 17:27:05 +00005248 }
dan16dd3982018-12-20 15:04:38 +00005249 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005250 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005251 return 1;
5252 }
dan5aa550c2017-06-24 18:10:29 +00005253 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005254 return 1;
5255 }
5256 return 2;
5257 }
drh2edc5fd2015-11-24 02:10:52 +00005258 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005259 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005260 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005261#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005262 assert( pA->op==pB->op );
5263 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5264 return 2;
5265 }
drheda079c2018-09-20 19:02:15 +00005266 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005267 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5268 return 2;
5269 }
drheda079c2018-09-20 19:02:15 +00005270 }
5271#endif
drhf20bbc52019-01-17 01:06:00 +00005272 }else if( pA->op==TK_NULL ){
5273 return 0;
drhd5af5422018-04-13 14:27:01 +00005274 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005275 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005276 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005277 return 2;
drh2646da72005-12-09 20:02:05 +00005278 }
drh22827922000-06-06 17:27:05 +00005279 }
drh898c5272019-10-22 00:03:41 +00005280 if( (pA->flags & (EP_Distinct|EP_Commuted))
5281 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005282 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005283 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005284 if( (combinedFlags & EP_FixedCol)==0
5285 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005286 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005287 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005288 if( pA->op!=TK_STRING
5289 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005290 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005291 ){
drh10d1edf2013-11-15 15:52:39 +00005292 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005293 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005294 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5295 return 2;
5296 }
drh10d1edf2013-11-15 15:52:39 +00005297 }
5298 }
drh1d9da702010-01-07 15:17:02 +00005299 return 0;
drh22827922000-06-06 17:27:05 +00005300}
5301
drh8c6f6662010-04-26 19:17:26 +00005302/*
danfbb6e9f2020-01-09 20:11:29 +00005303** Compare two ExprList objects. Return 0 if they are identical, 1
5304** if they are certainly different, or 2 if it is not possible to
5305** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005306**
drh619a1302013-08-01 13:04:46 +00005307** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5308** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5309**
drh8c6f6662010-04-26 19:17:26 +00005310** This routine might return non-zero for equivalent ExprLists. The
5311** only consequence will be disabled optimizations. But this routine
5312** must never return 0 if the two ExprList objects are different, or
5313** a malfunction will result.
5314**
5315** Two NULL pointers are considered to be the same. But a NULL pointer
5316** always differs from a non-NULL pointer.
5317*/
drh619a1302013-08-01 13:04:46 +00005318int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005319 int i;
5320 if( pA==0 && pB==0 ) return 0;
5321 if( pA==0 || pB==0 ) return 1;
5322 if( pA->nExpr!=pB->nExpr ) return 1;
5323 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005324 int res;
drh8c6f6662010-04-26 19:17:26 +00005325 Expr *pExprA = pA->a[i].pExpr;
5326 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005327 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005328 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005329 }
5330 return 0;
5331}
drh13449892005-09-07 21:22:45 +00005332
drh22827922000-06-06 17:27:05 +00005333/*
drhf9463df2017-02-11 14:59:58 +00005334** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5335** are ignored.
5336*/
5337int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005338 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005339 sqlite3ExprSkipCollateAndLikely(pA),
5340 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005341 iTab);
5342}
5343
5344/*
drhc51cf862019-05-11 19:36:03 +00005345** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005346**
5347** Or if seenNot is true, return non-zero if Expr p can only be
5348** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005349*/
5350static int exprImpliesNotNull(
5351 Parse *pParse, /* Parsing context */
5352 Expr *p, /* The expression to be checked */
5353 Expr *pNN, /* The expression that is NOT NULL */
5354 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005355 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005356){
5357 assert( p );
5358 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005359 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5360 return pNN->op!=TK_NULL;
5361 }
drhc51cf862019-05-11 19:36:03 +00005362 switch( p->op ){
5363 case TK_IN: {
5364 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5365 assert( ExprHasProperty(p,EP_xIsSelect)
5366 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005367 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005368 }
5369 case TK_BETWEEN: {
5370 ExprList *pList = p->x.pList;
5371 assert( pList!=0 );
5372 assert( pList->nExpr==2 );
5373 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005374 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5375 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005376 ){
5377 return 1;
5378 }
drh7a231b42019-08-30 15:11:08 +00005379 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005380 }
5381 case TK_EQ:
5382 case TK_NE:
5383 case TK_LT:
5384 case TK_LE:
5385 case TK_GT:
5386 case TK_GE:
5387 case TK_PLUS:
5388 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005389 case TK_BITOR:
5390 case TK_LSHIFT:
5391 case TK_RSHIFT:
5392 case TK_CONCAT:
5393 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005394 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005395 case TK_STAR:
5396 case TK_REM:
5397 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005398 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005399 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005400 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005401 }
5402 case TK_SPAN:
5403 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005404 case TK_UPLUS:
5405 case TK_UMINUS: {
5406 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5407 }
5408 case TK_TRUTH: {
5409 if( seenNot ) return 0;
5410 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005411 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005412 }
dan1cd382e2019-08-29 15:06:35 +00005413 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005414 case TK_NOT: {
5415 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5416 }
5417 }
5418 return 0;
5419}
5420
5421/*
drh4bd5f732013-07-31 23:22:39 +00005422** Return true if we can prove the pE2 will always be true if pE1 is
5423** true. Return false if we cannot complete the proof or if pE2 might
5424** be false. Examples:
5425**
drh619a1302013-08-01 13:04:46 +00005426** pE1: x==5 pE2: x==5 Result: true
5427** pE1: x>0 pE2: x==5 Result: false
5428** pE1: x=21 pE2: x=21 OR y=43 Result: true
5429** pE1: x!=123 pE2: x IS NOT NULL Result: true
5430** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5431** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5432** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005433**
5434** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5435** Expr.iTable<0 then assume a table number given by iTab.
5436**
drhc0804222017-06-28 21:47:16 +00005437** If pParse is not NULL, then the values of bound variables in pE1 are
5438** compared against literal values in pE2 and pParse->pVdbe->expmask is
5439** modified to record which bound variables are referenced. If pParse
5440** is NULL, then false will be returned if pE1 contains any bound variables.
5441**
drh4bd5f732013-07-31 23:22:39 +00005442** When in doubt, return false. Returning true might give a performance
5443** improvement. Returning false might cause a performance reduction, but
5444** it will always give the correct answer and is hence always safe.
5445*/
dan5aa550c2017-06-24 18:10:29 +00005446int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5447 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005448 return 1;
5449 }
5450 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005451 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5452 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005453 ){
5454 return 1;
5455 }
drh664d6d12019-05-04 17:32:07 +00005456 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005457 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005458 ){
drhc51cf862019-05-11 19:36:03 +00005459 return 1;
drh619a1302013-08-01 13:04:46 +00005460 }
5461 return 0;
drh4bd5f732013-07-31 23:22:39 +00005462}
5463
5464/*
drh6c68d752019-11-04 02:05:52 +00005465** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005466** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005467** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5468**
5469** This routine controls an optimization. False positives (setting
5470** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5471** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005472*/
5473static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005474 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005475 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005476 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5477 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005478 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005479 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005480 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005481 case TK_IS:
5482 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005483 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005484 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005485 case TK_IN:
drh25897872018-03-20 21:16:15 +00005486 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005487 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005488 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005489 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005490 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005491 testcase( pExpr->op==TK_IS );
5492 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005493 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005494 testcase( pExpr->op==TK_CASE );
5495 testcase( pExpr->op==TK_IN );
5496 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005497 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005498 return WRC_Prune;
5499 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005500 if( pWalker->u.iCur==pExpr->iTable ){
5501 pWalker->eCode = 1;
5502 return WRC_Abort;
5503 }
5504 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005505
dan9d23ea72019-08-29 19:34:29 +00005506 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005507 if( pWalker->eCode==0 ){
5508 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5509 if( pWalker->eCode ){
5510 pWalker->eCode = 0;
5511 sqlite3WalkExpr(pWalker, pExpr->pRight);
5512 }
dan9d23ea72019-08-29 19:34:29 +00005513 }
5514 return WRC_Prune;
5515
5516 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005517 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5518 assert( pWalker->eCode );
5519 return WRC_Abort;
5520 }
dan9d23ea72019-08-29 19:34:29 +00005521 return WRC_Prune;
5522
drh98811552018-04-03 14:04:48 +00005523 /* Virtual tables are allowed to use constraints like x=NULL. So
5524 ** a term of the form x=y does not prove that y is not null if x
5525 ** is the column of a virtual table */
5526 case TK_EQ:
5527 case TK_NE:
5528 case TK_LT:
5529 case TK_LE:
5530 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005531 case TK_GE: {
5532 Expr *pLeft = pExpr->pLeft;
5533 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005534 testcase( pExpr->op==TK_EQ );
5535 testcase( pExpr->op==TK_NE );
5536 testcase( pExpr->op==TK_LT );
5537 testcase( pExpr->op==TK_LE );
5538 testcase( pExpr->op==TK_GT );
5539 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005540 /* The y.pTab=0 assignment in wherecode.c always happens after the
5541 ** impliesNotNullRow() test */
5542 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5543 && IsVirtual(pLeft->y.pTab))
5544 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5545 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005546 ){
drh78d1d222020-02-17 19:25:07 +00005547 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005548 }
drh08b92082020-08-10 14:18:00 +00005549 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005550 }
drh25897872018-03-20 21:16:15 +00005551 default:
5552 return WRC_Continue;
5553 }
5554}
5555
5556/*
5557** Return true (non-zero) if expression p can only be true if at least
5558** one column of table iTab is non-null. In other words, return true
5559** if expression p will always be NULL or false if every column of iTab
5560** is NULL.
5561**
drh821b6102018-03-24 18:01:51 +00005562** False negatives are acceptable. In other words, it is ok to return
5563** zero even if expression p will never be true of every column of iTab
5564** is NULL. A false negative is merely a missed optimization opportunity.
5565**
5566** False positives are not allowed, however. A false positive may result
5567** in an incorrect answer.
5568**
drh25897872018-03-20 21:16:15 +00005569** Terms of p that are marked with EP_FromJoin (and hence that come from
5570** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5571**
5572** This routine is used to check if a LEFT JOIN can be converted into
5573** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5574** clause requires that some column of the right table of the LEFT JOIN
5575** be non-NULL, then the LEFT JOIN can be safely converted into an
5576** ordinary join.
5577*/
5578int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5579 Walker w;
drh0d950af2019-08-22 16:38:42 +00005580 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005581 if( p==0 ) return 0;
5582 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005583 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005584 }else{
5585 while( p->op==TK_AND ){
5586 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5587 p = p->pRight;
5588 }
drhd6db6592019-04-01 19:42:42 +00005589 }
drh25897872018-03-20 21:16:15 +00005590 w.xExprCallback = impliesNotNullRow;
5591 w.xSelectCallback = 0;
5592 w.xSelectCallback2 = 0;
5593 w.eCode = 0;
5594 w.u.iCur = iTab;
5595 sqlite3WalkExpr(&w, p);
5596 return w.eCode;
5597}
5598
5599/*
drh030796d2012-08-23 16:18:10 +00005600** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005601** to determine if an expression can be evaluated by reference to the
5602** index only, without having to do a search for the corresponding
5603** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5604** is the cursor for the table.
5605*/
5606struct IdxCover {
5607 Index *pIdx; /* The index to be tested for coverage */
5608 int iCur; /* Cursor number for the table corresponding to the index */
5609};
5610
5611/*
5612** Check to see if there are references to columns in table
5613** pWalker->u.pIdxCover->iCur can be satisfied using the index
5614** pWalker->u.pIdxCover->pIdx.
5615*/
5616static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5617 if( pExpr->op==TK_COLUMN
5618 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005619 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005620 ){
5621 pWalker->eCode = 1;
5622 return WRC_Abort;
5623 }
5624 return WRC_Continue;
5625}
5626
5627/*
drhe604ec02016-07-27 19:20:58 +00005628** Determine if an index pIdx on table with cursor iCur contains will
5629** the expression pExpr. Return true if the index does cover the
5630** expression and false if the pExpr expression references table columns
5631** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005632**
5633** An index covering an expression means that the expression can be
5634** evaluated using only the index and without having to lookup the
5635** corresponding table entry.
5636*/
5637int sqlite3ExprCoveredByIndex(
5638 Expr *pExpr, /* The index to be tested */
5639 int iCur, /* The cursor number for the corresponding table */
5640 Index *pIdx /* The index that might be used for coverage */
5641){
5642 Walker w;
5643 struct IdxCover xcov;
5644 memset(&w, 0, sizeof(w));
5645 xcov.iCur = iCur;
5646 xcov.pIdx = pIdx;
5647 w.xExprCallback = exprIdxCover;
5648 w.u.pIdxCover = &xcov;
5649 sqlite3WalkExpr(&w, pExpr);
5650 return !w.eCode;
5651}
5652
5653
5654/*
5655** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005656** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005657** aggregate function, in order to implement the
5658** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005659*/
drh030796d2012-08-23 16:18:10 +00005660struct SrcCount {
5661 SrcList *pSrc; /* One particular FROM clause in a nested query */
daned41a962020-06-09 17:45:48 +00005662 int iSrcInner; /* Smallest cursor number in this context */
drh030796d2012-08-23 16:18:10 +00005663 int nThis; /* Number of references to columns in pSrcList */
5664 int nOther; /* Number of references to columns in other FROM clauses */
5665};
5666
5667/*
daned41a962020-06-09 17:45:48 +00005668** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5669** SELECT with a FROM clause encountered during this iteration, set
5670** SrcCount.iSrcInner to the cursor number of the leftmost object in
5671** the FROM cause.
5672*/
5673static int selectSrcCount(Walker *pWalker, Select *pSel){
5674 struct SrcCount *p = pWalker->u.pSrcCount;
drhbc050b82020-06-09 22:11:06 +00005675 if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
daned41a962020-06-09 17:45:48 +00005676 pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5677 }
5678 return WRC_Continue;
5679}
5680
5681/*
drh030796d2012-08-23 16:18:10 +00005682** Count the number of references to columns.
5683*/
5684static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005685 /* There was once a NEVER() on the second term on the grounds that
5686 ** sqlite3FunctionUsesThisSrc() was always called before
5687 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5688 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5689 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5690 ** FunctionUsesThisSrc() when creating a new sub-select. */
5691 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005692 int i;
drh030796d2012-08-23 16:18:10 +00005693 struct SrcCount *p = pWalker->u.pSrcCount;
5694 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005695 int nSrc = pSrc ? pSrc->nSrc : 0;
5696 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005697 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005698 }
drh655814d2015-01-09 01:27:29 +00005699 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005700 p->nThis++;
daned41a962020-06-09 17:45:48 +00005701 }else if( pExpr->iTable<p->iSrcInner ){
drh80f6bfc2019-08-31 20:13:30 +00005702 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005703 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005704 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005705 p->nOther++;
5706 }
drh374fdce2012-04-17 16:38:53 +00005707 }
drh030796d2012-08-23 16:18:10 +00005708 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005709}
5710
5711/*
drh030796d2012-08-23 16:18:10 +00005712** Determine if any of the arguments to the pExpr Function reference
5713** pSrcList. Return true if they do. Also return true if the function
5714** has no arguments or has only constant arguments. Return false if pExpr
5715** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005716*/
drh030796d2012-08-23 16:18:10 +00005717int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005718 Walker w;
drh030796d2012-08-23 16:18:10 +00005719 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005720 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005721 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005722 w.xExprCallback = exprSrcCount;
daned41a962020-06-09 17:45:48 +00005723 w.xSelectCallback = selectSrcCount;
drh030796d2012-08-23 16:18:10 +00005724 w.u.pSrcCount = &cnt;
5725 cnt.pSrc = pSrcList;
daned41a962020-06-09 17:45:48 +00005726 cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
drh030796d2012-08-23 16:18:10 +00005727 cnt.nThis = 0;
5728 cnt.nOther = 0;
5729 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005730#ifndef SQLITE_OMIT_WINDOWFUNC
5731 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5732 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5733 }
5734#endif
drh030796d2012-08-23 16:18:10 +00005735 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005736}
5737
5738/*
drh89636622020-06-07 17:33:18 +00005739** This is a Walker expression node callback.
5740**
5741** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
5742** object that is referenced does not refer directly to the Expr. If
5743** it does, make a copy. This is done because the pExpr argument is
5744** subject to change.
5745**
5746** The copy is stored on pParse->pConstExpr with a register number of 0.
5747** This will cause the expression to be deleted automatically when the
5748** Parse object is destroyed, but the zero register number means that it
5749** will not generate any code in the preamble.
5750*/
5751static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00005752 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00005753 && pExpr->pAggInfo!=0
5754 ){
5755 AggInfo *pAggInfo = pExpr->pAggInfo;
5756 int iAgg = pExpr->iAgg;
5757 Parse *pParse = pWalker->pParse;
5758 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00005759 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
5760 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00005761 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00005762 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005763 pExpr = sqlite3ExprDup(db, pExpr, 0);
5764 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005765 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005766 pParse->pConstExpr =
5767 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5768 }
5769 }
5770 }else{
5771 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00005772 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005773 pExpr = sqlite3ExprDup(db, pExpr, 0);
5774 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005775 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drh89636622020-06-07 17:33:18 +00005776 pParse->pConstExpr =
5777 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
5778 }
5779 }
5780 }
5781 }
5782 return WRC_Continue;
5783}
5784
5785/*
5786** Initialize a Walker object so that will persist AggInfo entries referenced
5787** by the tree that is walked.
5788*/
5789void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
5790 memset(pWalker, 0, sizeof(*pWalker));
5791 pWalker->pParse = pParse;
5792 pWalker->xExprCallback = agginfoPersistExprCb;
5793 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
5794}
5795
5796/*
drh13449892005-09-07 21:22:45 +00005797** Add a new element to the pAggInfo->aCol[] array. Return the index of
5798** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005799*/
drh17435752007-08-16 04:30:38 +00005800static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005801 int i;
drhcf643722007-03-27 13:36:37 +00005802 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005803 db,
drhcf643722007-03-27 13:36:37 +00005804 pInfo->aCol,
5805 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005806 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005807 &i
5808 );
drh13449892005-09-07 21:22:45 +00005809 return i;
5810}
5811
5812/*
5813** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5814** the new element. Return a negative number if malloc fails.
5815*/
drh17435752007-08-16 04:30:38 +00005816static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005817 int i;
drhcf643722007-03-27 13:36:37 +00005818 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005819 db,
drhcf643722007-03-27 13:36:37 +00005820 pInfo->aFunc,
5821 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005822 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005823 &i
5824 );
drh13449892005-09-07 21:22:45 +00005825 return i;
drh89636622020-06-07 17:33:18 +00005826}
drh22827922000-06-06 17:27:05 +00005827
5828/*
drh7d10d5a2008-08-20 16:35:10 +00005829** This is the xExprCallback for a tree walker. It is used to
5830** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005831** for additional information.
drh22827922000-06-06 17:27:05 +00005832*/
drh7d10d5a2008-08-20 16:35:10 +00005833static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005834 int i;
drh7d10d5a2008-08-20 16:35:10 +00005835 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005836 Parse *pParse = pNC->pParse;
5837 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005838 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005839
drh25c3b8c2018-04-16 10:34:13 +00005840 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005841 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005842 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005843 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005844 testcase( pExpr->op==TK_AGG_COLUMN );
5845 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005846 /* Check to see if the column is in one of the tables in the FROM
5847 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005848 if( ALWAYS(pSrcList!=0) ){
drh13449892005-09-07 21:22:45 +00005849 struct SrcList_item *pItem = pSrcList->a;
5850 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5851 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005852 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005853 if( pExpr->iTable==pItem->iCursor ){
5854 /* If we reach this point, it means that pExpr refers to a table
5855 ** that is in the FROM clause of the aggregate query.
5856 **
5857 ** Make an entry for the column in pAggInfo->aCol[] if there
5858 ** is not an entry there already.
5859 */
drh7f906d62007-03-12 23:48:52 +00005860 int k;
drh13449892005-09-07 21:22:45 +00005861 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005862 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005863 if( pCol->iTable==pExpr->iTable &&
5864 pCol->iColumn==pExpr->iColumn ){
5865 break;
5866 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005867 }
danielk19771e536952007-08-16 10:09:01 +00005868 if( (k>=pAggInfo->nColumn)
5869 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5870 ){
drh7f906d62007-03-12 23:48:52 +00005871 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005872 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005873 pCol->iTable = pExpr->iTable;
5874 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005875 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005876 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00005877 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005878 if( pAggInfo->pGroupBy ){
5879 int j, n;
5880 ExprList *pGB = pAggInfo->pGroupBy;
5881 struct ExprList_item *pTerm = pGB->a;
5882 n = pGB->nExpr;
5883 for(j=0; j<n; j++, pTerm++){
5884 Expr *pE = pTerm->pExpr;
5885 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5886 pE->iColumn==pExpr->iColumn ){
5887 pCol->iSorterColumn = j;
5888 break;
5889 }
5890 }
5891 }
5892 if( pCol->iSorterColumn<0 ){
5893 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5894 }
5895 }
5896 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5897 ** because it was there before or because we just created it).
5898 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5899 ** pAggInfo->aCol[] entry.
5900 */
drhebb6a652013-09-12 23:42:22 +00005901 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005902 pExpr->pAggInfo = pAggInfo;
5903 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005904 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005905 break;
5906 } /* endif pExpr->iTable==pItem->iCursor */
5907 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005908 }
drh7d10d5a2008-08-20 16:35:10 +00005909 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005910 }
5911 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005912 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005913 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005914 ){
drh13449892005-09-07 21:22:45 +00005915 /* Check to see if pExpr is a duplicate of another aggregate
5916 ** function that is already in the pAggInfo structure
5917 */
5918 struct AggInfo_func *pItem = pAggInfo->aFunc;
5919 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh81185a52020-06-09 13:38:12 +00005920 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00005921 break;
5922 }
drh22827922000-06-06 17:27:05 +00005923 }
drh13449892005-09-07 21:22:45 +00005924 if( i>=pAggInfo->nFunc ){
5925 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
5926 */
danielk197714db2662006-01-09 16:12:04 +00005927 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00005928 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00005929 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00005930 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00005931 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00005932 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00005933 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00005934 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00005935 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00005936 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00005937 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00005938 if( pExpr->flags & EP_Distinct ){
5939 pItem->iDistinct = pParse->nTab++;
5940 }else{
5941 pItem->iDistinct = -1;
5942 }
drh13449892005-09-07 21:22:45 +00005943 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005944 }
drh13449892005-09-07 21:22:45 +00005945 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
5946 */
drhc5cd1242013-09-12 16:50:49 +00005947 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00005948 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00005949 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00005950 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00005951 return WRC_Prune;
5952 }else{
5953 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00005954 }
drh22827922000-06-06 17:27:05 +00005955 }
5956 }
drh7d10d5a2008-08-20 16:35:10 +00005957 return WRC_Continue;
5958}
drh626a8792005-01-17 22:08:19 +00005959
5960/*
drhe8abb4c2012-11-02 18:24:57 +00005961** Analyze the pExpr expression looking for aggregate functions and
5962** for variables that need to be added to AggInfo object that pNC->pAggInfo
5963** points to. Additional entries are made on the AggInfo object as
5964** necessary.
drh626a8792005-01-17 22:08:19 +00005965**
5966** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00005967** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00005968*/
drhd2b3e232008-01-23 14:51:49 +00005969void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00005970 Walker w;
5971 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00005972 w.xSelectCallback = sqlite3WalkerDepthIncrease;
5973 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00005974 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00005975 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00005976 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00005977 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00005978 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00005979}
drh5d9a4af2005-08-30 00:54:01 +00005980
5981/*
5982** Call sqlite3ExprAnalyzeAggregates() for every expression in an
5983** expression list. Return the number of errors.
5984**
5985** If an error is found, the analysis is cut short.
5986*/
drhd2b3e232008-01-23 14:51:49 +00005987void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00005988 struct ExprList_item *pItem;
5989 int i;
drh5d9a4af2005-08-30 00:54:01 +00005990 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00005991 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5992 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00005993 }
5994 }
drh5d9a4af2005-08-30 00:54:01 +00005995}
drh892d3172008-01-10 03:46:36 +00005996
5997/*
drhceea3322009-04-23 13:22:42 +00005998** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00005999*/
6000int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006001 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006002 return ++pParse->nMem;
6003 }
danielk19772f425f62008-07-04 09:41:39 +00006004 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006005}
drhceea3322009-04-23 13:22:42 +00006006
6007/*
6008** Deallocate a register, making available for reuse for some other
6009** purpose.
drhceea3322009-04-23 13:22:42 +00006010*/
drh892d3172008-01-10 03:46:36 +00006011void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006012 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006013 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006014 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6015 pParse->aTempReg[pParse->nTempReg++] = iReg;
6016 }
drh892d3172008-01-10 03:46:36 +00006017 }
6018}
6019
6020/*
drhed24da42016-09-06 14:37:05 +00006021** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006022*/
6023int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006024 int i, n;
drhed24da42016-09-06 14:37:05 +00006025 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006026 i = pParse->iRangeReg;
6027 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006028 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006029 pParse->iRangeReg += nReg;
6030 pParse->nRangeReg -= nReg;
6031 }else{
6032 i = pParse->nMem+1;
6033 pParse->nMem += nReg;
6034 }
6035 return i;
6036}
6037void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006038 if( nReg==1 ){
6039 sqlite3ReleaseTempReg(pParse, iReg);
6040 return;
6041 }
drh3aef2fb2020-01-02 17:46:02 +00006042 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006043 if( nReg>pParse->nRangeReg ){
6044 pParse->nRangeReg = nReg;
6045 pParse->iRangeReg = iReg;
6046 }
6047}
drhcdc69552011-12-06 13:24:59 +00006048
6049/*
6050** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006051**
6052** Always invoke this procedure after coding a subroutine or co-routine
6053** that might be invoked from other parts of the code, to ensure that
6054** the sub/co-routine does not use registers in common with the code that
6055** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006056*/
6057void sqlite3ClearTempRegCache(Parse *pParse){
6058 pParse->nTempReg = 0;
6059 pParse->nRangeReg = 0;
6060}
drhbb9b5f22016-03-19 00:35:02 +00006061
6062/*
6063** Validate that no temporary register falls within the range of
6064** iFirst..iLast, inclusive. This routine is only call from within assert()
6065** statements.
6066*/
6067#ifdef SQLITE_DEBUG
6068int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6069 int i;
6070 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006071 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6072 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006073 ){
6074 return 0;
6075 }
6076 for(i=0; i<pParse->nTempReg; i++){
6077 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6078 return 0;
6079 }
6080 }
6081 return 1;
6082}
6083#endif /* SQLITE_DEBUG */