blob: fbfba759f58d572099b21fb274a1caaafe642bcf [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) ){
drh9bb612f2020-10-02 12:42:51 +000048 assert( pExpr->op==TK_COLLATE
49 || pExpr->op==TK_IF_NULL_ROW
50 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
drha7d6db62019-06-11 21:02:15 +000051 pExpr = pExpr->pLeft;
52 assert( pExpr!=0 );
53 }
drh580c8c12012-12-08 03:34:04 +000054 op = pExpr->op;
drhde0e1b12021-04-16 22:53:57 +000055 if( op==TK_REGISTER ) op = pExpr->op2;
56 if( (op==TK_COLUMN || op==TK_AGG_COLUMN) && pExpr->y.pTab ){
57 return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
58 }
drh487e2622005-06-25 18:42:14 +000059 if( op==TK_SELECT ){
danielk19776ab3a2e2009-02-19 14:39:25 +000060 assert( pExpr->flags&EP_xIsSelect );
drh6af305d2020-07-10 21:43:53 +000061 assert( pExpr->x.pSelect!=0 );
62 assert( pExpr->x.pSelect->pEList!=0 );
63 assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
64 return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
danielk1977a37cdde2004-05-16 11:15:36 +000065 }
drh487e2622005-06-25 18:42:14 +000066#ifndef SQLITE_OMIT_CAST
67 if( op==TK_CAST ){
drh33e619f2009-05-28 01:00:55 +000068 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhfdaac672013-10-04 15:30:21 +000069 return sqlite3AffinityType(pExpr->u.zToken, 0);
drh487e2622005-06-25 18:42:14 +000070 }
71#endif
dan80aa5452016-09-03 19:52:12 +000072 if( op==TK_SELECT_COLUMN ){
73 assert( pExpr->pLeft->flags&EP_xIsSelect );
74 return sqlite3ExprAffinity(
75 pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
76 );
77 }
drhdb36e252019-10-22 19:51:29 +000078 if( op==TK_VECTOR ){
79 return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
80 }
drh11949042019-08-05 18:01:42 +000081 return pExpr->affExpr;
danielk1977a37cdde2004-05-16 11:15:36 +000082}
83
drh53db1452004-05-20 13:54:53 +000084/*
drh8b4c40d2007-02-01 23:02:45 +000085** Set the collating sequence for expression pExpr to be the collating
drhae80dde2012-12-06 21:16:43 +000086** sequence named by pToken. Return a pointer to a new Expr node that
87** implements the COLLATE operator.
drh0a8a4062012-12-07 18:38:16 +000088**
89** If a memory allocation error occurs, that fact is recorded in pParse->db
90** and the pExpr parameter is returned unchanged.
drh8b4c40d2007-02-01 23:02:45 +000091*/
drh4ef7efa2014-03-20 15:14:08 +000092Expr *sqlite3ExprAddCollateToken(
93 Parse *pParse, /* Parsing context */
94 Expr *pExpr, /* Add the "COLLATE" clause to this expression */
dan80103fc2015-03-20 08:43:59 +000095 const Token *pCollName, /* Name of collating sequence */
96 int dequote /* True to dequote pCollName */
drh4ef7efa2014-03-20 15:14:08 +000097){
drh433a3e92021-05-04 12:07:16 +000098 if( pCollName->n>0 ){
dan80103fc2015-03-20 08:43:59 +000099 Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
drh0a8a4062012-12-07 18:38:16 +0000100 if( pNew ){
101 pNew->pLeft = pExpr;
drha4c3c872013-09-12 17:29:25 +0000102 pNew->flags |= EP_Collate|EP_Skip;
drh0a8a4062012-12-07 18:38:16 +0000103 pExpr = pNew;
104 }
drhae80dde2012-12-06 21:16:43 +0000105 }
drh0a8a4062012-12-07 18:38:16 +0000106 return pExpr;
107}
108Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
drh261d8a52012-12-08 21:36:26 +0000109 Token s;
110 assert( zC!=0 );
drh40aced52016-01-22 17:48:09 +0000111 sqlite3TokenInit(&s, (char*)zC);
dan80103fc2015-03-20 08:43:59 +0000112 return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
drh0a8a4062012-12-07 18:38:16 +0000113}
114
115/*
drh0d950af2019-08-22 16:38:42 +0000116** Skip over any TK_COLLATE operators.
drh0a8a4062012-12-07 18:38:16 +0000117*/
118Expr *sqlite3ExprSkipCollate(Expr *pExpr){
drh0d950af2019-08-22 16:38:42 +0000119 while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
drh46fe1382020-08-19 23:32:06 +0000120 assert( pExpr->op==TK_COLLATE );
drh0d950af2019-08-22 16:38:42 +0000121 pExpr = pExpr->pLeft;
122 }
123 return pExpr;
124}
125
126/*
127** Skip over any TK_COLLATE operators and/or any unlikely()
128** or likelihood() or likely() functions at the root of an
129** expression.
130*/
131Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
drha7d6db62019-06-11 21:02:15 +0000132 while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
drha4c3c872013-09-12 17:29:25 +0000133 if( ExprHasProperty(pExpr, EP_Unlikely) ){
drhcca9f3d2013-09-06 15:23:29 +0000134 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
135 assert( pExpr->x.pList->nExpr>0 );
drha4c3c872013-09-12 17:29:25 +0000136 assert( pExpr->op==TK_FUNCTION );
drhcca9f3d2013-09-06 15:23:29 +0000137 pExpr = pExpr->x.pList->a[0].pExpr;
138 }else{
drh46fe1382020-08-19 23:32:06 +0000139 assert( pExpr->op==TK_COLLATE );
drha4c3c872013-09-12 17:29:25 +0000140 pExpr = pExpr->pLeft;
drhcca9f3d2013-09-06 15:23:29 +0000141 }
drha4c3c872013-09-12 17:29:25 +0000142 }
drh0a8a4062012-12-07 18:38:16 +0000143 return pExpr;
drh8b4c40d2007-02-01 23:02:45 +0000144}
145
146/*
drhae80dde2012-12-06 21:16:43 +0000147** Return the collation sequence for the expression pExpr. If
148** there is no defined collating sequence, return NULL.
149**
drh70efa842017-09-28 01:58:23 +0000150** See also: sqlite3ExprNNCollSeq()
151**
152** The sqlite3ExprNNCollSeq() works the same exact that it returns the
153** default collation if pExpr has no defined collation.
154**
drhae80dde2012-12-06 21:16:43 +0000155** The collating sequence might be determined by a COLLATE operator
156** or by the presence of a column with a defined collating sequence.
157** COLLATE operators take first precedence. Left operands take
158** precedence over right operands.
danielk19770202b292004-06-09 09:55:16 +0000159*/
drhe7375bf2020-03-10 19:24:38 +0000160CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000161 sqlite3 *db = pParse->db;
danielk19777cedc8d2004-06-10 10:50:08 +0000162 CollSeq *pColl = 0;
drhe7375bf2020-03-10 19:24:38 +0000163 const Expr *p = pExpr;
drh261d8a52012-12-08 21:36:26 +0000164 while( p ){
drhae80dde2012-12-06 21:16:43 +0000165 int op = p->op;
drhcb0e04f2018-12-12 21:34:17 +0000166 if( op==TK_REGISTER ) op = p->op2;
167 if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
drheda079c2018-09-20 19:02:15 +0000168 && p->y.pTab!=0
drhae80dde2012-12-06 21:16:43 +0000169 ){
drheda079c2018-09-20 19:02:15 +0000170 /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
drh7d10d5a2008-08-20 16:35:10 +0000171 ** a TK_COLUMN but was previously evaluated and cached in a register */
drh7d10d5a2008-08-20 16:35:10 +0000172 int j = p->iColumn;
173 if( j>=0 ){
drheda079c2018-09-20 19:02:15 +0000174 const char *zColl = p->y.pTab->aCol[j].zColl;
drhc4a64fa2009-05-11 20:53:28 +0000175 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
drh7d10d5a2008-08-20 16:35:10 +0000176 }
177 break;
danielk19770202b292004-06-09 09:55:16 +0000178 }
drhe081d732018-07-27 18:19:12 +0000179 if( op==TK_CAST || op==TK_UPLUS ){
180 p = p->pLeft;
181 continue;
182 }
drh269d3222019-10-23 18:09:39 +0000183 if( op==TK_VECTOR ){
184 p = p->x.pList->a[0].pExpr;
185 continue;
186 }
drhcb0e04f2018-12-12 21:34:17 +0000187 if( op==TK_COLLATE ){
drhe081d732018-07-27 18:19:12 +0000188 pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
189 break;
190 }
drhae80dde2012-12-06 21:16:43 +0000191 if( p->flags & EP_Collate ){
drh2308ed32015-02-09 16:09:34 +0000192 if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
drhae80dde2012-12-06 21:16:43 +0000193 p = p->pLeft;
194 }else{
drh2308ed32015-02-09 16:09:34 +0000195 Expr *pNext = p->pRight;
drh6728cd92015-02-09 18:28:03 +0000196 /* The Expr.x union is never used at the same time as Expr.pRight */
197 assert( p->x.pList==0 || p->pRight==0 );
drh92a28242019-10-09 15:37:58 +0000198 if( p->x.pList!=0
199 && !db->mallocFailed
200 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
201 ){
drh2308ed32015-02-09 16:09:34 +0000202 int i;
drh5b107652020-07-13 15:35:08 +0000203 for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
drh2308ed32015-02-09 16:09:34 +0000204 if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
205 pNext = p->x.pList->a[i].pExpr;
206 break;
207 }
208 }
209 }
210 p = pNext;
drhae80dde2012-12-06 21:16:43 +0000211 }
212 }else{
drh7d10d5a2008-08-20 16:35:10 +0000213 break;
214 }
danielk19770202b292004-06-09 09:55:16 +0000215 }
danielk19777cedc8d2004-06-10 10:50:08 +0000216 if( sqlite3CheckCollSeq(pParse, pColl) ){
217 pColl = 0;
218 }
219 return pColl;
danielk19770202b292004-06-09 09:55:16 +0000220}
221
222/*
drh70efa842017-09-28 01:58:23 +0000223** Return the collation sequence for the expression pExpr. If
224** there is no defined collating sequence, return a pointer to the
225** defautl collation sequence.
226**
227** See also: sqlite3ExprCollSeq()
228**
229** The sqlite3ExprCollSeq() routine works the same except that it
230** returns NULL if there is no defined collation.
231*/
drhe7375bf2020-03-10 19:24:38 +0000232CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
drh70efa842017-09-28 01:58:23 +0000233 CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
234 if( p==0 ) p = pParse->db->pDfltColl;
235 assert( p!=0 );
236 return p;
237}
238
239/*
240** Return TRUE if the two expressions have equivalent collating sequences.
241*/
drhe7375bf2020-03-10 19:24:38 +0000242int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
drh70efa842017-09-28 01:58:23 +0000243 CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
244 CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
245 return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
246}
247
248/*
drh626a8792005-01-17 22:08:19 +0000249** pExpr is an operand of a comparison operator. aff2 is the
250** type affinity of the other operand. This routine returns the
drh53db1452004-05-20 13:54:53 +0000251** type affinity that should be used for the comparison operator.
252*/
drhe7375bf2020-03-10 19:24:38 +0000253char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
danielk1977bf3b7212004-05-18 10:06:24 +0000254 char aff1 = sqlite3ExprAffinity(pExpr);
drh96fb16e2019-08-06 14:37:24 +0000255 if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
drh8df447f2005-11-01 15:48:24 +0000256 /* Both sides of the comparison are columns. If one has numeric
257 ** affinity, use that. Otherwise use no affinity.
danielk1977e014a832004-05-17 10:48:57 +0000258 */
drh8a512562005-11-14 22:29:05 +0000259 if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
danielk1977e014a832004-05-17 10:48:57 +0000260 return SQLITE_AFF_NUMERIC;
261 }else{
drh05883a32015-06-02 15:32:08 +0000262 return SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000263 }
danielk1977e014a832004-05-17 10:48:57 +0000264 }else{
265 /* One side is a column, the other is not. Use the columns affinity. */
drh96fb16e2019-08-06 14:37:24 +0000266 assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
267 return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
danielk1977e014a832004-05-17 10:48:57 +0000268 }
269}
270
drh53db1452004-05-20 13:54:53 +0000271/*
272** pExpr is a comparison operator. Return the type affinity that should
273** be applied to both operands prior to doing the comparison.
274*/
drhe7375bf2020-03-10 19:24:38 +0000275static char comparisonAffinity(const Expr *pExpr){
danielk1977e014a832004-05-17 10:48:57 +0000276 char aff;
277 assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
278 pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
drh6a2fe092009-09-23 02:29:36 +0000279 pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
danielk1977e014a832004-05-17 10:48:57 +0000280 assert( pExpr->pLeft );
danielk1977bf3b7212004-05-18 10:06:24 +0000281 aff = sqlite3ExprAffinity(pExpr->pLeft);
danielk1977e014a832004-05-17 10:48:57 +0000282 if( pExpr->pRight ){
283 aff = sqlite3CompareAffinity(pExpr->pRight, aff);
danielk19776ab3a2e2009-02-19 14:39:25 +0000284 }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
285 aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
drh13ac46e2017-02-11 13:51:23 +0000286 }else if( aff==0 ){
drh05883a32015-06-02 15:32:08 +0000287 aff = SQLITE_AFF_BLOB;
danielk1977e014a832004-05-17 10:48:57 +0000288 }
289 return aff;
290}
291
292/*
293** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
294** idx_affinity is the affinity of an indexed column. Return true
295** if the index with affinity idx_affinity may be used to implement
296** the comparison in pExpr.
297*/
drhe7375bf2020-03-10 19:24:38 +0000298int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
danielk1977e014a832004-05-17 10:48:57 +0000299 char aff = comparisonAffinity(pExpr);
drh915e4342019-08-06 15:18:15 +0000300 if( aff<SQLITE_AFF_TEXT ){
301 return 1;
drh8a512562005-11-14 22:29:05 +0000302 }
drh915e4342019-08-06 15:18:15 +0000303 if( aff==SQLITE_AFF_TEXT ){
304 return idx_affinity==SQLITE_AFF_TEXT;
305 }
306 return sqlite3IsNumericAffinity(idx_affinity);
danielk1977e014a832004-05-17 10:48:57 +0000307}
308
danielk1977a37cdde2004-05-16 11:15:36 +0000309/*
drh35573352008-01-08 23:54:25 +0000310** Return the P5 value that should be used for a binary comparison
danielk1977a37cdde2004-05-16 11:15:36 +0000311** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
danielk1977a37cdde2004-05-16 11:15:36 +0000312*/
drhe7375bf2020-03-10 19:24:38 +0000313static u8 binaryCompareP5(
314 const Expr *pExpr1, /* Left operand */
315 const Expr *pExpr2, /* Right operand */
316 int jumpIfNull /* Extra flags added to P5 */
317){
drh35573352008-01-08 23:54:25 +0000318 u8 aff = (char)sqlite3ExprAffinity(pExpr2);
drh1bd10f82008-12-10 21:19:56 +0000319 aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
drh35573352008-01-08 23:54:25 +0000320 return aff;
danielk1977a37cdde2004-05-16 11:15:36 +0000321}
322
drha2e00042002-01-22 03:13:42 +0000323/*
danielk19770202b292004-06-09 09:55:16 +0000324** Return a pointer to the collation sequence that should be used by
325** a binary comparison operator comparing pLeft and pRight.
326**
327** If the left hand expression has a collating sequence type, then it is
328** used. Otherwise the collation sequence for the right hand expression
329** is used, or the default (BINARY) if neither expression has a collating
330** type.
danielk1977bcbb04e2007-05-29 12:11:29 +0000331**
332** Argument pRight (but not pLeft) may be a null pointer. In this case,
333** it is not considered.
danielk19770202b292004-06-09 09:55:16 +0000334*/
drh0a0e1312007-08-07 17:04:59 +0000335CollSeq *sqlite3BinaryCompareCollSeq(
danielk1977bcbb04e2007-05-29 12:11:29 +0000336 Parse *pParse,
drhe7375bf2020-03-10 19:24:38 +0000337 const Expr *pLeft,
338 const Expr *pRight
danielk1977bcbb04e2007-05-29 12:11:29 +0000339){
drhec41dda2007-02-07 13:09:45 +0000340 CollSeq *pColl;
341 assert( pLeft );
drhae80dde2012-12-06 21:16:43 +0000342 if( pLeft->flags & EP_Collate ){
343 pColl = sqlite3ExprCollSeq(pParse, pLeft);
344 }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
345 pColl = sqlite3ExprCollSeq(pParse, pRight);
drhec41dda2007-02-07 13:09:45 +0000346 }else{
347 pColl = sqlite3ExprCollSeq(pParse, pLeft);
348 if( !pColl ){
349 pColl = sqlite3ExprCollSeq(pParse, pRight);
350 }
danielk19770202b292004-06-09 09:55:16 +0000351 }
352 return pColl;
353}
354
drh898c5272019-10-22 00:03:41 +0000355/* Expresssion p is a comparison operator. Return a collation sequence
356** appropriate for the comparison operator.
357**
358** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
359** However, if the OP_Commuted flag is set, then the order of the operands
360** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
361** correct collating sequence is found.
362*/
drhe7375bf2020-03-10 19:24:38 +0000363CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
drh898c5272019-10-22 00:03:41 +0000364 if( ExprHasProperty(p, EP_Commuted) ){
365 return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
366 }else{
367 return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
368 }
369}
370
danielk19770202b292004-06-09 09:55:16 +0000371/*
drhbe5c89a2004-07-26 00:31:09 +0000372** Generate code for a comparison operator.
373*/
374static int codeCompare(
375 Parse *pParse, /* The parsing (and code generating) context */
376 Expr *pLeft, /* The left operand */
377 Expr *pRight, /* The right operand */
378 int opcode, /* The comparison opcode */
drh35573352008-01-08 23:54:25 +0000379 int in1, int in2, /* Register holding operands */
drhbe5c89a2004-07-26 00:31:09 +0000380 int dest, /* Jump here if true. */
drh898c5272019-10-22 00:03:41 +0000381 int jumpIfNull, /* If true, jump if either operand is NULL */
382 int isCommuted /* The comparison has been commuted */
drhbe5c89a2004-07-26 00:31:09 +0000383){
drh35573352008-01-08 23:54:25 +0000384 int p5;
385 int addr;
386 CollSeq *p4;
387
drh86541862019-12-19 20:37:32 +0000388 if( pParse->nErr ) return 0;
drh898c5272019-10-22 00:03:41 +0000389 if( isCommuted ){
390 p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
391 }else{
392 p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
393 }
drh35573352008-01-08 23:54:25 +0000394 p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
395 addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
396 (void*)p4, P4_COLLSEQ);
drh1bd10f82008-12-10 21:19:56 +0000397 sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
drh35573352008-01-08 23:54:25 +0000398 return addr;
drhbe5c89a2004-07-26 00:31:09 +0000399}
400
dancfbb5e82016-07-13 19:48:13 +0000401/*
dan870a0702016-08-01 16:37:43 +0000402** Return true if expression pExpr is a vector, or false otherwise.
drhd832da72016-08-20 21:11:25 +0000403**
404** A vector is defined as any expression that results in two or more
405** columns of result. Every TK_VECTOR node is an vector because the
406** parser will not generate a TK_VECTOR with fewer than two entries.
407** But a TK_SELECT might be either a vector or a scalar. It is only
408** considered a vector if it has two or more result columns.
dan870a0702016-08-01 16:37:43 +0000409*/
410int sqlite3ExprIsVector(Expr *pExpr){
drh76dbe7a2016-08-20 21:02:38 +0000411 return sqlite3ExprVectorSize(pExpr)>1;
dan870a0702016-08-01 16:37:43 +0000412}
413
414/*
dancfbb5e82016-07-13 19:48:13 +0000415** If the expression passed as the only argument is of type TK_VECTOR
416** return the number of expressions in the vector. Or, if the expression
417** is a sub-select, return the number of columns in the sub-select. For
418** any other type of expression, return 1.
419*/
dan71c57db2016-07-09 20:23:55 +0000420int sqlite3ExprVectorSize(Expr *pExpr){
drh12abf402016-08-22 14:30:05 +0000421 u8 op = pExpr->op;
422 if( op==TK_REGISTER ) op = pExpr->op2;
423 if( op==TK_VECTOR ){
drh76dbe7a2016-08-20 21:02:38 +0000424 return pExpr->x.pList->nExpr;
drh12abf402016-08-22 14:30:05 +0000425 }else if( op==TK_SELECT ){
dan71c57db2016-07-09 20:23:55 +0000426 return pExpr->x.pSelect->pEList->nExpr;
drh76dbe7a2016-08-20 21:02:38 +0000427 }else{
428 return 1;
dan71c57db2016-07-09 20:23:55 +0000429 }
dan71c57db2016-07-09 20:23:55 +0000430}
431
danba00e302016-07-23 20:24:06 +0000432/*
drhfc7f27b2016-08-20 00:07:01 +0000433** Return a pointer to a subexpression of pVector that is the i-th
434** column of the vector (numbered starting with 0). The caller must
435** ensure that i is within range.
436**
drh76dbe7a2016-08-20 21:02:38 +0000437** If pVector is really a scalar (and "scalar" here includes subqueries
438** that return a single column!) then return pVector unmodified.
439**
drhfc7f27b2016-08-20 00:07:01 +0000440** pVector retains ownership of the returned subexpression.
441**
442** If the vector is a (SELECT ...) then the expression returned is
drh76dbe7a2016-08-20 21:02:38 +0000443** just the expression for the i-th term of the result set, and may
444** not be ready for evaluation because the table cursor has not yet
445** been positioned.
danba00e302016-07-23 20:24:06 +0000446*/
drhfc7f27b2016-08-20 00:07:01 +0000447Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
drhbf7f3a02021-05-24 11:35:16 +0000448 assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
dan870a0702016-08-01 16:37:43 +0000449 if( sqlite3ExprIsVector(pVector) ){
drh9f24b532016-09-05 22:50:48 +0000450 assert( pVector->op2==0 || pVector->op==TK_REGISTER );
451 if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000452 return pVector->x.pSelect->pEList->a[i].pExpr;
453 }else{
454 return pVector->x.pList->a[i].pExpr;
455 }
dan71c57db2016-07-09 20:23:55 +0000456 }
dan870a0702016-08-01 16:37:43 +0000457 return pVector;
dan71c57db2016-07-09 20:23:55 +0000458}
drhfc7f27b2016-08-20 00:07:01 +0000459
drhfc7f27b2016-08-20 00:07:01 +0000460/*
461** Compute and return a new Expr object which when passed to
462** sqlite3ExprCode() will generate all necessary code to compute
463** the iField-th column of the vector expression pVector.
464**
drh8762ec12016-08-20 01:06:22 +0000465** It is ok for pVector to be a scalar (as long as iField==0).
466** In that case, this routine works like sqlite3ExprDup().
467**
drhfc7f27b2016-08-20 00:07:01 +0000468** The caller owns the returned Expr object and is responsible for
469** ensuring that the returned value eventually gets freed.
470**
drh8762ec12016-08-20 01:06:22 +0000471** The caller retains ownership of pVector. If pVector is a TK_SELECT,
danfad0e702016-09-06 12:04:50 +0000472** then the returned object will reference pVector and so pVector must remain
drh8762ec12016-08-20 01:06:22 +0000473** valid for the life of the returned object. If pVector is a TK_VECTOR
474** or a scalar expression, then it can be deleted as soon as this routine
drh76dbe7a2016-08-20 21:02:38 +0000475** returns.
drh8762ec12016-08-20 01:06:22 +0000476**
477** A trick to cause a TK_SELECT pVector to be deleted together with
478** the returned Expr object is to attach the pVector to the pRight field
479** of the returned TK_SELECT_COLUMN Expr object.
drhfc7f27b2016-08-20 00:07:01 +0000480*/
481Expr *sqlite3ExprForVectorField(
482 Parse *pParse, /* Parsing context */
483 Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
drha1251bc2016-08-20 00:51:37 +0000484 int iField /* Which column of the vector to return */
drhfc7f27b2016-08-20 00:07:01 +0000485){
486 Expr *pRet;
drha1251bc2016-08-20 00:51:37 +0000487 if( pVector->op==TK_SELECT ){
488 assert( pVector->flags & EP_xIsSelect );
drhfc7f27b2016-08-20 00:07:01 +0000489 /* The TK_SELECT_COLUMN Expr node:
490 **
drh966e2912017-01-03 02:58:01 +0000491 ** pLeft: pVector containing TK_SELECT. Not deleted.
drh8762ec12016-08-20 01:06:22 +0000492 ** pRight: not used. But recursively deleted.
drhfc7f27b2016-08-20 00:07:01 +0000493 ** iColumn: Index of a column in pVector
drh966e2912017-01-03 02:58:01 +0000494 ** iTable: 0 or the number of columns on the LHS of an assignment
drhfc7f27b2016-08-20 00:07:01 +0000495 ** pLeft->iTable: First in an array of register holding result, or 0
496 ** if the result is not yet computed.
497 **
498 ** sqlite3ExprDelete() specifically skips the recursive delete of
499 ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
drh8762ec12016-08-20 01:06:22 +0000500 ** can be attached to pRight to cause this node to take ownership of
501 ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
502 ** with the same pLeft pointer to the pVector, but only one of them
503 ** will own the pVector.
drhfc7f27b2016-08-20 00:07:01 +0000504 */
drhabfd35e2016-12-06 22:47:23 +0000505 pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
drh8bd0d582016-08-20 18:06:14 +0000506 if( pRet ){
507 pRet->iColumn = iField;
508 pRet->pLeft = pVector;
509 }
drhfc7f27b2016-08-20 00:07:01 +0000510 assert( pRet==0 || pRet->iTable==0 );
511 }else{
drha1251bc2016-08-20 00:51:37 +0000512 if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
513 pRet = sqlite3ExprDup(pParse->db, pVector, 0);
dandfb5c962019-01-15 20:51:35 +0000514 sqlite3RenameTokenRemap(pParse, pRet, pVector);
drhfc7f27b2016-08-20 00:07:01 +0000515 }
516 return pRet;
517}
dan71c57db2016-07-09 20:23:55 +0000518
dan5c288b92016-07-30 21:02:33 +0000519/*
520** If expression pExpr is of type TK_SELECT, generate code to evaluate
521** it. Return the register in which the result is stored (or, if the
522** sub-select returns more than one column, the first in an array
523** of registers in which the result is stored).
524**
525** If pExpr is not a TK_SELECT expression, return 0.
526*/
527static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
dan8da209b2016-07-26 18:06:08 +0000528 int reg = 0;
danf9b2e052016-08-02 17:45:00 +0000529#ifndef SQLITE_OMIT_SUBQUERY
dan5c288b92016-07-30 21:02:33 +0000530 if( pExpr->op==TK_SELECT ){
drh85bcdce2018-12-23 21:27:29 +0000531 reg = sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +0000532 }
danf9b2e052016-08-02 17:45:00 +0000533#endif
dan8da209b2016-07-26 18:06:08 +0000534 return reg;
535}
536
dan5c288b92016-07-30 21:02:33 +0000537/*
538** Argument pVector points to a vector expression - either a TK_VECTOR
dan870a0702016-08-01 16:37:43 +0000539** or TK_SELECT that returns more than one column. This function returns
540** the register number of a register that contains the value of
541** element iField of the vector.
542**
543** If pVector is a TK_SELECT expression, then code for it must have
544** already been generated using the exprCodeSubselect() routine. In this
545** case parameter regSelect should be the first in an array of registers
546** containing the results of the sub-select.
547**
548** If pVector is of type TK_VECTOR, then code for the requested field
549** is generated. In this case (*pRegFree) may be set to the number of
550** a temporary register to be freed by the caller before returning.
dan5c288b92016-07-30 21:02:33 +0000551**
552** Before returning, output parameter (*ppExpr) is set to point to the
553** Expr object corresponding to element iElem of the vector.
dan5c288b92016-07-30 21:02:33 +0000554*/
555static int exprVectorRegister(
556 Parse *pParse, /* Parse context */
557 Expr *pVector, /* Vector to extract element from */
dan870a0702016-08-01 16:37:43 +0000558 int iField, /* Field to extract from pVector */
dan5c288b92016-07-30 21:02:33 +0000559 int regSelect, /* First in array of registers */
560 Expr **ppExpr, /* OUT: Expression element */
561 int *pRegFree /* OUT: Temp register to free */
562){
drh12abf402016-08-22 14:30:05 +0000563 u8 op = pVector->op;
drh05428122021-05-24 00:17:04 +0000564 assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
drh12abf402016-08-22 14:30:05 +0000565 if( op==TK_REGISTER ){
566 *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
567 return pVector->iTable+iField;
568 }
569 if( op==TK_SELECT ){
dan870a0702016-08-01 16:37:43 +0000570 *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
571 return regSelect+iField;
dan5c288b92016-07-30 21:02:33 +0000572 }
drh05428122021-05-24 00:17:04 +0000573 if( op==TK_VECTOR ){
574 *ppExpr = pVector->x.pList->a[iField].pExpr;
575 return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
576 }
577 return 0;
dan5c288b92016-07-30 21:02:33 +0000578}
579
580/*
581** Expression pExpr is a comparison between two vector values. Compute
drh79752b62016-08-13 10:02:17 +0000582** the result of the comparison (1, 0, or NULL) and write that
583** result into register dest.
584**
585** The caller must satisfy the following preconditions:
586**
587** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
588** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
589** otherwise: op==pExpr->op and p5==0
dan5c288b92016-07-30 21:02:33 +0000590*/
drh79752b62016-08-13 10:02:17 +0000591static void codeVectorCompare(
592 Parse *pParse, /* Code generator context */
593 Expr *pExpr, /* The comparison operation */
594 int dest, /* Write results into this register */
595 u8 op, /* Comparison operator */
596 u8 p5 /* SQLITE_NULLEQ or zero */
597){
dan71c57db2016-07-09 20:23:55 +0000598 Vdbe *v = pParse->pVdbe;
599 Expr *pLeft = pExpr->pLeft;
600 Expr *pRight = pExpr->pRight;
601 int nLeft = sqlite3ExprVectorSize(pLeft);
drhb29e60c2016-09-05 12:02:34 +0000602 int i;
603 int regLeft = 0;
604 int regRight = 0;
605 u8 opx = op;
drh4bc20452021-03-29 18:53:47 +0000606 int addrCmp = 0;
drhec4ccdb2018-12-29 02:26:59 +0000607 int addrDone = sqlite3VdbeMakeLabel(pParse);
drh898c5272019-10-22 00:03:41 +0000608 int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
dan71c57db2016-07-09 20:23:55 +0000609
drhe7375bf2020-03-10 19:24:38 +0000610 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh340fd0b2021-03-19 16:29:40 +0000611 if( pParse->nErr ) return;
drh245ce622017-01-01 12:44:07 +0000612 if( nLeft!=sqlite3ExprVectorSize(pRight) ){
613 sqlite3ErrorMsg(pParse, "row value misused");
614 return;
615 }
drhb29e60c2016-09-05 12:02:34 +0000616 assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
617 || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
618 || pExpr->op==TK_LT || pExpr->op==TK_GT
619 || pExpr->op==TK_LE || pExpr->op==TK_GE
620 );
621 assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
622 || (pExpr->op==TK_ISNOT && op==TK_NE) );
623 assert( p5==0 || pExpr->op!=op );
624 assert( p5==SQLITE_NULLEQ || pExpr->op==op );
dan71c57db2016-07-09 20:23:55 +0000625
drh4bc20452021-03-29 18:53:47 +0000626 if( op==TK_LE ) opx = TK_LT;
627 if( op==TK_GE ) opx = TK_GT;
628 if( op==TK_NE ) opx = TK_EQ;
dan71c57db2016-07-09 20:23:55 +0000629
drhb29e60c2016-09-05 12:02:34 +0000630 regLeft = exprCodeSubselect(pParse, pLeft);
631 regRight = exprCodeSubselect(pParse, pRight);
dan71c57db2016-07-09 20:23:55 +0000632
drh4bc20452021-03-29 18:53:47 +0000633 sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
drhb29e60c2016-09-05 12:02:34 +0000634 for(i=0; 1 /*Loop exits by "break"*/; i++){
635 int regFree1 = 0, regFree2 = 0;
636 Expr *pL, *pR;
637 int r1, r2;
638 assert( i>=0 && i<nLeft );
drh4bc20452021-03-29 18:53:47 +0000639 if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000640 r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
641 r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
drh4bc20452021-03-29 18:53:47 +0000642 addrCmp = sqlite3VdbeCurrentAddr(v);
643 codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
drhb29e60c2016-09-05 12:02:34 +0000644 testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
645 testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
646 testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
647 testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
648 testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
649 testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
650 sqlite3ReleaseTempReg(pParse, regFree1);
651 sqlite3ReleaseTempReg(pParse, regFree2);
drh4bc20452021-03-29 18:53:47 +0000652 if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
653 addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
654 testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
655 testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
656 }
657 if( p5==SQLITE_NULLEQ ){
658 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
659 }else{
660 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
661 }
drhb29e60c2016-09-05 12:02:34 +0000662 if( i==nLeft-1 ){
663 break;
dan71c57db2016-07-09 20:23:55 +0000664 }
drhb29e60c2016-09-05 12:02:34 +0000665 if( opx==TK_EQ ){
drh4bc20452021-03-29 18:53:47 +0000666 sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
drhb29e60c2016-09-05 12:02:34 +0000667 }else{
668 assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
drh4bc20452021-03-29 18:53:47 +0000669 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
drhb29e60c2016-09-05 12:02:34 +0000670 if( i==nLeft-2 ) opx = op;
671 }
dan71c57db2016-07-09 20:23:55 +0000672 }
drh4bc20452021-03-29 18:53:47 +0000673 sqlite3VdbeJumpHere(v, addrCmp);
drhb29e60c2016-09-05 12:02:34 +0000674 sqlite3VdbeResolveLabel(v, addrDone);
drh4bc20452021-03-29 18:53:47 +0000675 if( op==TK_NE ){
676 sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
677 }
dan71c57db2016-07-09 20:23:55 +0000678}
679
danielk19774b5255a2008-06-05 16:47:39 +0000680#if SQLITE_MAX_EXPR_DEPTH>0
681/*
682** Check that argument nHeight is less than or equal to the maximum
683** expression depth allowed. If it is not, leave an error message in
684** pParse.
685*/
drh7d10d5a2008-08-20 16:35:10 +0000686int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
danielk19774b5255a2008-06-05 16:47:39 +0000687 int rc = SQLITE_OK;
688 int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
689 if( nHeight>mxHeight ){
690 sqlite3ErrorMsg(pParse,
691 "Expression tree is too large (maximum depth %d)", mxHeight
692 );
693 rc = SQLITE_ERROR;
694 }
695 return rc;
696}
697
698/* The following three functions, heightOfExpr(), heightOfExprList()
699** and heightOfSelect(), are used to determine the maximum height
700** of any expression tree referenced by the structure passed as the
701** first argument.
702**
703** If this maximum height is greater than the current value pointed
704** to by pnHeight, the second parameter, then set *pnHeight to that
705** value.
706*/
707static void heightOfExpr(Expr *p, int *pnHeight){
708 if( p ){
709 if( p->nHeight>*pnHeight ){
710 *pnHeight = p->nHeight;
711 }
712 }
713}
714static void heightOfExprList(ExprList *p, int *pnHeight){
715 if( p ){
716 int i;
717 for(i=0; i<p->nExpr; i++){
718 heightOfExpr(p->a[i].pExpr, pnHeight);
719 }
720 }
721}
dan1a3a3082018-01-18 19:00:54 +0000722static void heightOfSelect(Select *pSelect, int *pnHeight){
723 Select *p;
724 for(p=pSelect; p; p=p->pPrior){
danielk19774b5255a2008-06-05 16:47:39 +0000725 heightOfExpr(p->pWhere, pnHeight);
726 heightOfExpr(p->pHaving, pnHeight);
727 heightOfExpr(p->pLimit, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000728 heightOfExprList(p->pEList, pnHeight);
729 heightOfExprList(p->pGroupBy, pnHeight);
730 heightOfExprList(p->pOrderBy, pnHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000731 }
732}
733
734/*
735** Set the Expr.nHeight variable in the structure passed as an
736** argument. An expression with no children, Expr.pList or
737** Expr.pSelect member has a height of 1. Any other expression
738** has a height equal to the maximum height of any other
739** referenced Expr plus one.
drh2308ed32015-02-09 16:09:34 +0000740**
741** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
742** if appropriate.
danielk19774b5255a2008-06-05 16:47:39 +0000743*/
744static void exprSetHeight(Expr *p){
745 int nHeight = 0;
746 heightOfExpr(p->pLeft, &nHeight);
747 heightOfExpr(p->pRight, &nHeight);
danielk19776ab3a2e2009-02-19 14:39:25 +0000748 if( ExprHasProperty(p, EP_xIsSelect) ){
749 heightOfSelect(p->x.pSelect, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000750 }else if( p->x.pList ){
danielk19776ab3a2e2009-02-19 14:39:25 +0000751 heightOfExprList(p->x.pList, &nHeight);
drh2308ed32015-02-09 16:09:34 +0000752 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +0000753 }
danielk19774b5255a2008-06-05 16:47:39 +0000754 p->nHeight = nHeight + 1;
755}
756
757/*
758** Set the Expr.nHeight variable using the exprSetHeight() function. If
759** the height is greater than the maximum allowed expression depth,
760** leave an error in pParse.
drh2308ed32015-02-09 16:09:34 +0000761**
762** Also propagate all EP_Propagate flags from the Expr.x.pList into
763** Expr.flags.
danielk19774b5255a2008-06-05 16:47:39 +0000764*/
drh2308ed32015-02-09 16:09:34 +0000765void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
drh74893a42015-03-22 10:23:17 +0000766 if( pParse->nErr ) return;
danielk19774b5255a2008-06-05 16:47:39 +0000767 exprSetHeight(p);
drh7d10d5a2008-08-20 16:35:10 +0000768 sqlite3ExprCheckHeight(pParse, p->nHeight);
danielk19774b5255a2008-06-05 16:47:39 +0000769}
770
771/*
772** Return the maximum height of any expression tree referenced
773** by the select statement passed as an argument.
774*/
775int sqlite3SelectExprHeight(Select *p){
776 int nHeight = 0;
777 heightOfSelect(p, &nHeight);
778 return nHeight;
779}
drh2308ed32015-02-09 16:09:34 +0000780#else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
781/*
782** Propagate all EP_Propagate flags from the Expr.x.pList into
783** Expr.flags.
784*/
785void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
dan6c3b4b02020-08-20 16:25:26 +0000786 if( pParse->nErr ) return;
drh2308ed32015-02-09 16:09:34 +0000787 if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
788 p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
789 }
790}
791#define exprSetHeight(y)
danielk19774b5255a2008-06-05 16:47:39 +0000792#endif /* SQLITE_MAX_EXPR_DEPTH>0 */
793
drhbe5c89a2004-07-26 00:31:09 +0000794/*
drhb7916a72009-05-27 10:31:29 +0000795** This routine is the core allocator for Expr nodes.
796**
drha76b5df2002-02-23 02:32:10 +0000797** Construct a new expression node and return a pointer to it. Memory
drhb7916a72009-05-27 10:31:29 +0000798** for this node and for the pToken argument is a single allocation
799** obtained from sqlite3DbMalloc(). The calling function
drha76b5df2002-02-23 02:32:10 +0000800** is responsible for making sure the node eventually gets freed.
drhb7916a72009-05-27 10:31:29 +0000801**
802** If dequote is true, then the token (if it exists) is dequoted.
drhe792b5b2015-08-23 20:48:29 +0000803** If dequote is false, no dequoting is performed. The deQuote
drhb7916a72009-05-27 10:31:29 +0000804** parameter is ignored if pToken is NULL or if the token does not
805** appear to be quoted. If the quotes were of the form "..." (double-quotes)
806** then the EP_DblQuoted flag is set on the expression node.
drh33e619f2009-05-28 01:00:55 +0000807**
808** Special case: If op==TK_INTEGER and pToken points to a string that
809** can be translated into a 32-bit integer, then the token is not
810** stored in u.zToken. Instead, the integer values is written
811** into u.iValue and the EP_IntValue flag is set. No extra storage
812** is allocated to hold the integer text and the dequote flag is ignored.
drha76b5df2002-02-23 02:32:10 +0000813*/
drhb7916a72009-05-27 10:31:29 +0000814Expr *sqlite3ExprAlloc(
drhcca8a4a2016-10-03 12:56:48 +0000815 sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
drh17435752007-08-16 04:30:38 +0000816 int op, /* Expression opcode */
drhb7916a72009-05-27 10:31:29 +0000817 const Token *pToken, /* Token argument. Might be NULL */
818 int dequote /* True to dequote */
drh17435752007-08-16 04:30:38 +0000819){
drha76b5df2002-02-23 02:32:10 +0000820 Expr *pNew;
drh33e619f2009-05-28 01:00:55 +0000821 int nExtra = 0;
shanecf697392009-06-01 16:53:09 +0000822 int iValue = 0;
danielk1977fc976062007-05-10 10:46:56 +0000823
drh575fad62016-02-05 13:38:36 +0000824 assert( db!=0 );
drhb7916a72009-05-27 10:31:29 +0000825 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000826 if( op!=TK_INTEGER || pToken->z==0
827 || sqlite3GetInt32(pToken->z, &iValue)==0 ){
828 nExtra = pToken->n+1;
drhd50ffc42011-03-08 02:38:28 +0000829 assert( iValue>=0 );
drh33e619f2009-05-28 01:00:55 +0000830 }
drhb7916a72009-05-27 10:31:29 +0000831 }
drh575fad62016-02-05 13:38:36 +0000832 pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
drhb7916a72009-05-27 10:31:29 +0000833 if( pNew ){
drhca3862d2016-01-08 12:46:39 +0000834 memset(pNew, 0, sizeof(Expr));
drhb7916a72009-05-27 10:31:29 +0000835 pNew->op = (u8)op;
836 pNew->iAgg = -1;
837 if( pToken ){
drh33e619f2009-05-28 01:00:55 +0000838 if( nExtra==0 ){
drhad317272019-04-19 16:21:51 +0000839 pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
drh33e619f2009-05-28 01:00:55 +0000840 pNew->u.iValue = iValue;
841 }else{
drh33e619f2009-05-28 01:00:55 +0000842 pNew->u.zToken = (char*)&pNew[1];
drhb07028f2011-10-14 21:49:18 +0000843 assert( pToken->z!=0 || pToken->n==0 );
844 if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
drh33e619f2009-05-28 01:00:55 +0000845 pNew->u.zToken[pToken->n] = 0;
drh244b9d62016-04-11 19:01:08 +0000846 if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
drh51d35b02019-01-11 13:32:23 +0000847 sqlite3DequoteExpr(pNew);
drh33e619f2009-05-28 01:00:55 +0000848 }
drhb7916a72009-05-27 10:31:29 +0000849 }
850 }
851#if SQLITE_MAX_EXPR_DEPTH>0
852 pNew->nHeight = 1;
853#endif
854 }
drha76b5df2002-02-23 02:32:10 +0000855 return pNew;
856}
857
858/*
drhb7916a72009-05-27 10:31:29 +0000859** Allocate a new expression node from a zero-terminated token that has
860** already been dequoted.
861*/
862Expr *sqlite3Expr(
863 sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
864 int op, /* Expression opcode */
865 const char *zToken /* Token argument. Might be NULL */
866){
867 Token x;
868 x.z = zToken;
drhb40f06c2017-08-21 02:20:57 +0000869 x.n = sqlite3Strlen30(zToken);
drhb7916a72009-05-27 10:31:29 +0000870 return sqlite3ExprAlloc(db, op, &x, 0);
871}
872
873/*
874** Attach subtrees pLeft and pRight to the Expr node pRoot.
875**
876** If pRoot==NULL that means that a memory allocation error has occurred.
877** In that case, delete the subtrees pLeft and pRight.
878*/
879void sqlite3ExprAttachSubtrees(
880 sqlite3 *db,
881 Expr *pRoot,
882 Expr *pLeft,
883 Expr *pRight
884){
885 if( pRoot==0 ){
886 assert( db->mallocFailed );
887 sqlite3ExprDelete(db, pLeft);
888 sqlite3ExprDelete(db, pRight);
889 }else{
890 if( pRight ){
891 pRoot->pRight = pRight;
drh885a5b02015-02-09 15:21:36 +0000892 pRoot->flags |= EP_Propagate & pRight->flags;
drhb7916a72009-05-27 10:31:29 +0000893 }
894 if( pLeft ){
895 pRoot->pLeft = pLeft;
drh885a5b02015-02-09 15:21:36 +0000896 pRoot->flags |= EP_Propagate & pLeft->flags;
drhb7916a72009-05-27 10:31:29 +0000897 }
898 exprSetHeight(pRoot);
899 }
900}
901
902/*
peter.d.reid60ec9142014-09-06 16:39:46 +0000903** Allocate an Expr node which joins as many as two subtrees.
drhb7916a72009-05-27 10:31:29 +0000904**
drhbf664462009-06-19 18:32:54 +0000905** One or both of the subtrees can be NULL. Return a pointer to the new
906** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
907** free the subtrees and return NULL.
drh206f3d92006-07-11 13:15:08 +0000908*/
drh17435752007-08-16 04:30:38 +0000909Expr *sqlite3PExpr(
910 Parse *pParse, /* Parsing context */
911 int op, /* Expression opcode */
912 Expr *pLeft, /* Left operand */
drhabfd35e2016-12-06 22:47:23 +0000913 Expr *pRight /* Right operand */
drh17435752007-08-16 04:30:38 +0000914){
drh5fb52ca2012-03-31 02:34:35 +0000915 Expr *p;
drhd5c851c2019-04-19 13:38:34 +0000916 p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
917 if( p ){
918 memset(p, 0, sizeof(Expr));
919 p->op = op & 0xff;
920 p->iAgg = -1;
drh5fb52ca2012-03-31 02:34:35 +0000921 sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
dan2b359bd2010-10-28 11:31:23 +0000922 sqlite3ExprCheckHeight(pParse, p->nHeight);
drhd5c851c2019-04-19 13:38:34 +0000923 }else{
924 sqlite3ExprDelete(pParse->db, pLeft);
925 sqlite3ExprDelete(pParse->db, pRight);
dan2b359bd2010-10-28 11:31:23 +0000926 }
drh4e0cff62004-11-05 05:10:28 +0000927 return p;
928}
929
930/*
drh08de4f72016-04-11 01:06:47 +0000931** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
932** do a memory allocation failure) then delete the pSelect object.
933*/
934void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
935 if( pExpr ){
936 pExpr->x.pSelect = pSelect;
937 ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
938 sqlite3ExprSetHeightAndFlags(pParse, pExpr);
939 }else{
940 assert( pParse->db->mallocFailed );
941 sqlite3SelectDelete(pParse->db, pSelect);
942 }
943}
944
945
946/*
drh91bb0ee2004-09-01 03:06:34 +0000947** Join two expressions using an AND operator. If either expression is
948** NULL, then just return the other expression.
drh5fb52ca2012-03-31 02:34:35 +0000949**
950** If one side or the other of the AND is known to be false, then instead
951** of returning an AND expression, just return a constant expression with
952** a value of false.
drh91bb0ee2004-09-01 03:06:34 +0000953*/
drhd5c851c2019-04-19 13:38:34 +0000954Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
955 sqlite3 *db = pParse->db;
956 if( pLeft==0 ){
drh91bb0ee2004-09-01 03:06:34 +0000957 return pRight;
958 }else if( pRight==0 ){
959 return pLeft;
dan2b6e6702019-12-30 06:55:31 +0000960 }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
961 && !IN_RENAME_OBJECT
962 ){
drhb3ad4e62021-03-31 13:31:33 +0000963 sqlite3ExprDeferredDelete(pParse, pLeft);
964 sqlite3ExprDeferredDelete(pParse, pRight);
drh5776ee52019-09-23 12:38:10 +0000965 return sqlite3Expr(db, TK_INTEGER, "0");
drh91bb0ee2004-09-01 03:06:34 +0000966 }else{
drhd5c851c2019-04-19 13:38:34 +0000967 return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
drha76b5df2002-02-23 02:32:10 +0000968 }
969}
970
971/*
972** Construct a new expression node for a function with multiple
973** arguments.
974*/
drh954733b2018-07-27 23:33:16 +0000975Expr *sqlite3ExprFunction(
976 Parse *pParse, /* Parsing context */
977 ExprList *pList, /* Argument list */
978 Token *pToken, /* Name of the function */
979 int eDistinct /* SF_Distinct or SF_ALL or 0 */
980){
drha76b5df2002-02-23 02:32:10 +0000981 Expr *pNew;
drh633e6d52008-07-28 19:34:53 +0000982 sqlite3 *db = pParse->db;
danielk19774b202ae2006-01-23 05:50:58 +0000983 assert( pToken );
drhb7916a72009-05-27 10:31:29 +0000984 pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
drha76b5df2002-02-23 02:32:10 +0000985 if( pNew==0 ){
drhd9da78a2009-03-24 15:08:09 +0000986 sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
drha76b5df2002-02-23 02:32:10 +0000987 return 0;
988 }
drh954733b2018-07-27 23:33:16 +0000989 if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
990 sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
991 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000992 pNew->x.pList = pList;
drhfca23552017-10-28 20:51:54 +0000993 ExprSetProperty(pNew, EP_HasFunc);
danielk19776ab3a2e2009-02-19 14:39:25 +0000994 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
drh2308ed32015-02-09 16:09:34 +0000995 sqlite3ExprSetHeightAndFlags(pParse, pNew);
drh954733b2018-07-27 23:33:16 +0000996 if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
drha76b5df2002-02-23 02:32:10 +0000997 return pNew;
998}
999
1000/*
drh0dfa5252020-01-08 17:28:19 +00001001** Check to see if a function is usable according to current access
1002** rules:
1003**
1004** SQLITE_FUNC_DIRECT - Only usable from top-level SQL
1005**
1006** SQLITE_FUNC_UNSAFE - Usable if TRUSTED_SCHEMA or from
1007** top-level SQL
1008**
1009** If the function is not usable, create an error.
1010*/
1011void sqlite3ExprFunctionUsable(
1012 Parse *pParse, /* Parsing and code generating context */
1013 Expr *pExpr, /* The function invocation */
1014 FuncDef *pDef /* The function being invoked */
1015){
1016 assert( !IN_RENAME_OBJECT );
drh2eeca202020-01-08 20:37:45 +00001017 assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
1018 if( ExprHasProperty(pExpr, EP_FromDDL) ){
drh0dfa5252020-01-08 17:28:19 +00001019 if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
1020 || (pParse->db->flags & SQLITE_TrustedSchema)==0
1021 ){
1022 /* Functions prohibited in triggers and views if:
1023 ** (1) tagged with SQLITE_DIRECTONLY
1024 ** (2) not tagged with SQLITE_INNOCUOUS (which means it
1025 ** is tagged with SQLITE_FUNC_UNSAFE) and
1026 ** SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
1027 ** that the schema is possibly tainted).
1028 */
1029 sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
1030 }
1031 }
1032}
1033
1034/*
drhfa6bc002004-09-07 16:19:52 +00001035** Assign a variable number to an expression that encodes a wildcard
1036** in the original SQL statement.
1037**
1038** Wildcards consisting of a single "?" are assigned the next sequential
1039** variable number.
1040**
1041** Wildcards of the form "?nnn" are assigned the number "nnn". We make
drh9bf755c2016-12-23 03:59:31 +00001042** sure "nnn" is not too big to avoid a denial of service attack when
drhfa6bc002004-09-07 16:19:52 +00001043** the SQL statement comes from an external source.
1044**
drh51f49f12009-05-21 20:41:32 +00001045** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
drhfa6bc002004-09-07 16:19:52 +00001046** as the previous instance of the same wildcard. Or if this is the first
peter.d.reid60ec9142014-09-06 16:39:46 +00001047** instance of the wildcard, the next sequential variable number is
drhfa6bc002004-09-07 16:19:52 +00001048** assigned.
1049*/
drhde25a882016-10-03 15:28:24 +00001050void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
drh17435752007-08-16 04:30:38 +00001051 sqlite3 *db = pParse->db;
drhb7916a72009-05-27 10:31:29 +00001052 const char *z;
drhf326d662016-12-23 13:30:53 +00001053 ynVar x;
drh17435752007-08-16 04:30:38 +00001054
drhfa6bc002004-09-07 16:19:52 +00001055 if( pExpr==0 ) return;
drhc5cd1242013-09-12 16:50:49 +00001056 assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
drh33e619f2009-05-28 01:00:55 +00001057 z = pExpr->u.zToken;
drhb7916a72009-05-27 10:31:29 +00001058 assert( z!=0 );
1059 assert( z[0]!=0 );
mistachkinb1ed7172017-04-14 14:50:34 +00001060 assert( n==(u32)sqlite3Strlen30(z) );
drhb7916a72009-05-27 10:31:29 +00001061 if( z[1]==0 ){
drhfa6bc002004-09-07 16:19:52 +00001062 /* Wildcard of the form "?". Assign the next variable number */
drhb7916a72009-05-27 10:31:29 +00001063 assert( z[0]=='?' );
drhf326d662016-12-23 13:30:53 +00001064 x = (ynVar)(++pParse->nVar);
drhfa6bc002004-09-07 16:19:52 +00001065 }else{
drhf326d662016-12-23 13:30:53 +00001066 int doAdd = 0;
drh124c0b42011-06-01 18:15:55 +00001067 if( z[0]=='?' ){
1068 /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
1069 ** use it as the variable number */
1070 i64 i;
drh18814df2017-01-31 03:52:34 +00001071 int bOk;
1072 if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
1073 i = z[1]-'0'; /* The common case of ?N for a single digit N */
1074 bOk = 1;
1075 }else{
1076 bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
1077 }
drh124c0b42011-06-01 18:15:55 +00001078 testcase( i==0 );
1079 testcase( i==1 );
1080 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1081 testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1082 if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1083 sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1084 db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
drhc9b39282016-10-03 16:33:14 +00001085 return;
drhfa6bc002004-09-07 16:19:52 +00001086 }
drh8e74e7b2017-01-31 12:41:48 +00001087 x = (ynVar)i;
drhf326d662016-12-23 13:30:53 +00001088 if( x>pParse->nVar ){
1089 pParse->nVar = (int)x;
1090 doAdd = 1;
1091 }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1092 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001093 }
1094 }else{
1095 /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
1096 ** number as the prior appearance of the same name, or if the name
1097 ** has never appeared before, reuse the same variable number
1098 */
drh9bf755c2016-12-23 03:59:31 +00001099 x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
1100 if( x==0 ){
1101 x = (ynVar)(++pParse->nVar);
drhf326d662016-12-23 13:30:53 +00001102 doAdd = 1;
drh124c0b42011-06-01 18:15:55 +00001103 }
drhfa6bc002004-09-07 16:19:52 +00001104 }
drhf326d662016-12-23 13:30:53 +00001105 if( doAdd ){
1106 pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1107 }
1108 }
1109 pExpr->iColumn = x;
1110 if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
danielk1977832b2662007-05-09 11:37:22 +00001111 sqlite3ErrorMsg(pParse, "too many SQL variables");
1112 }
drhfa6bc002004-09-07 16:19:52 +00001113}
1114
1115/*
danf6963f92009-11-23 14:39:14 +00001116** Recursively delete an expression tree.
drha2e00042002-01-22 03:13:42 +00001117*/
drh4f0010b2016-04-11 14:49:39 +00001118static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
1119 assert( p!=0 );
drhd50ffc42011-03-08 02:38:28 +00001120 /* Sanity check: Assert that the IntValue is non-negative if it exists */
1121 assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
drheda079c2018-09-20 19:02:15 +00001122
1123 assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1124 assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
dan4f9adee2019-07-13 16:22:50 +00001125 || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
drh209bc522016-09-23 21:36:24 +00001126#ifdef SQLITE_DEBUG
1127 if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1128 assert( p->pLeft==0 );
1129 assert( p->pRight==0 );
1130 assert( p->x.pSelect==0 );
1131 }
1132#endif
1133 if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
drhc5cd1242013-09-12 16:50:49 +00001134 /* The Expr.x union is never used at the same time as Expr.pRight */
1135 assert( p->x.pList==0 || p->pRight==0 );
drh4910a762016-09-03 01:46:15 +00001136 if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
drhd1086672017-07-07 13:59:34 +00001137 if( p->pRight ){
dan4f9adee2019-07-13 16:22:50 +00001138 assert( !ExprHasProperty(p, EP_WinFunc) );
drhd1086672017-07-07 13:59:34 +00001139 sqlite3ExprDeleteNN(db, p->pRight);
1140 }else if( ExprHasProperty(p, EP_xIsSelect) ){
dan4f9adee2019-07-13 16:22:50 +00001141 assert( !ExprHasProperty(p, EP_WinFunc) );
danielk19776ab3a2e2009-02-19 14:39:25 +00001142 sqlite3SelectDelete(db, p->x.pSelect);
1143 }else{
1144 sqlite3ExprListDelete(db, p->x.pList);
dan6ba7ab02019-07-02 11:56:47 +00001145#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00001146 if( ExprHasProperty(p, EP_WinFunc) ){
1147 sqlite3WindowDelete(db, p->y.pWin);
dan8117f112019-07-10 20:16:53 +00001148 }
dan6ba7ab02019-07-02 11:56:47 +00001149#endif
dan8117f112019-07-10 20:16:53 +00001150 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001151 }
drh209bc522016-09-23 21:36:24 +00001152 if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
drh33e619f2009-05-28 01:00:55 +00001153 if( !ExprHasProperty(p, EP_Static) ){
drhdbd6a7d2017-04-05 12:39:49 +00001154 sqlite3DbFreeNN(db, p);
drh33e619f2009-05-28 01:00:55 +00001155 }
drha2e00042002-01-22 03:13:42 +00001156}
drh4f0010b2016-04-11 14:49:39 +00001157void sqlite3ExprDelete(sqlite3 *db, Expr *p){
1158 if( p ) sqlite3ExprDeleteNN(db, p);
1159}
drha2e00042002-01-22 03:13:42 +00001160
drhb3ad4e62021-03-31 13:31:33 +00001161
1162/*
1163** Arrange to cause pExpr to be deleted when the pParse is deleted.
1164** This is similar to sqlite3ExprDelete() except that the delete is
1165** deferred untilthe pParse is deleted.
1166**
1167** The pExpr might be deleted immediately on an OOM error.
1168**
1169** The deferred delete is (currently) implemented by adding the
1170** pExpr to the pParse->pConstExpr list with a register number of 0.
1171*/
1172void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1173 pParse->pConstExpr =
1174 sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1175}
1176
drh8e34e402019-06-11 10:43:56 +00001177/* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
1178** expression.
1179*/
1180void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
1181 if( p ){
1182 if( IN_RENAME_OBJECT ){
1183 sqlite3RenameExprUnmap(pParse, p);
1184 }
1185 sqlite3ExprDeleteNN(pParse->db, p);
1186 }
1187}
1188
drhd2687b72005-08-12 22:56:09 +00001189/*
danielk19776ab3a2e2009-02-19 14:39:25 +00001190** Return the number of bytes allocated for the expression structure
1191** passed as the first argument. This is always one of EXPR_FULLSIZE,
1192** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
1193*/
1194static int exprStructSize(Expr *p){
1195 if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001196 if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
1197 return EXPR_FULLSIZE;
1198}
1199
1200/*
drh33e619f2009-05-28 01:00:55 +00001201** The dupedExpr*Size() routines each return the number of bytes required
1202** to store a copy of an expression or expression tree. They differ in
1203** how much of the tree is measured.
1204**
1205** dupedExprStructSize() Size of only the Expr structure
1206** dupedExprNodeSize() Size of Expr + space for token
1207** dupedExprSize() Expr + token + subtree components
1208**
1209***************************************************************************
1210**
1211** The dupedExprStructSize() function returns two values OR-ed together:
1212** (1) the space required for a copy of the Expr structure only and
1213** (2) the EP_xxx flags that indicate what the structure size should be.
1214** The return values is always one of:
1215**
1216** EXPR_FULLSIZE
1217** EXPR_REDUCEDSIZE | EP_Reduced
1218** EXPR_TOKENONLYSIZE | EP_TokenOnly
1219**
1220** The size of the structure can be found by masking the return value
1221** of this routine with 0xfff. The flags can be found by masking the
1222** return value with EP_Reduced|EP_TokenOnly.
1223**
1224** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
1225** (unreduced) Expr objects as they or originally constructed by the parser.
1226** During expression analysis, extra information is computed and moved into
danc95f38d2018-06-18 20:34:43 +00001227** later parts of the Expr object and that extra information might get chopped
drh33e619f2009-05-28 01:00:55 +00001228** off if the expression is reduced. Note also that it does not work to
peter.d.reid60ec9142014-09-06 16:39:46 +00001229** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
drh33e619f2009-05-28 01:00:55 +00001230** to reduce a pristine expression tree from the parser. The implementation
1231** of dupedExprStructSize() contain multiple assert() statements that attempt
1232** to enforce this constraint.
danielk19776ab3a2e2009-02-19 14:39:25 +00001233*/
1234static int dupedExprStructSize(Expr *p, int flags){
1235 int nSize;
drh33e619f2009-05-28 01:00:55 +00001236 assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
drhaecd8022013-09-13 18:15:15 +00001237 assert( EXPR_FULLSIZE<=0xfff );
1238 assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
dan67a9b8e2018-06-22 20:51:35 +00001239 if( 0==flags || p->op==TK_SELECT_COLUMN
1240#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001241 || ExprHasProperty(p, EP_WinFunc)
dan67a9b8e2018-06-22 20:51:35 +00001242#endif
1243 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001244 nSize = EXPR_FULLSIZE;
danielk19776ab3a2e2009-02-19 14:39:25 +00001245 }else{
drhc5cd1242013-09-12 16:50:49 +00001246 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drh33e619f2009-05-28 01:00:55 +00001247 assert( !ExprHasProperty(p, EP_FromJoin) );
drhc5cd1242013-09-12 16:50:49 +00001248 assert( !ExprHasProperty(p, EP_MemToken) );
drhe7375bf2020-03-10 19:24:38 +00001249 assert( !ExprHasVVAProperty(p, EP_NoReduce) );
drhaecd8022013-09-13 18:15:15 +00001250 if( p->pLeft || p->x.pList ){
drh33e619f2009-05-28 01:00:55 +00001251 nSize = EXPR_REDUCEDSIZE | EP_Reduced;
1252 }else{
drhaecd8022013-09-13 18:15:15 +00001253 assert( p->pRight==0 );
drh33e619f2009-05-28 01:00:55 +00001254 nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
1255 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001256 }
1257 return nSize;
1258}
1259
1260/*
drh33e619f2009-05-28 01:00:55 +00001261** This function returns the space in bytes required to store the copy
1262** of the Expr structure and a copy of the Expr.u.zToken string (if that
1263** string is defined.)
danielk19776ab3a2e2009-02-19 14:39:25 +00001264*/
1265static int dupedExprNodeSize(Expr *p, int flags){
drh33e619f2009-05-28 01:00:55 +00001266 int nByte = dupedExprStructSize(p, flags) & 0xfff;
1267 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
drh7301e772018-10-31 20:52:00 +00001268 nByte += sqlite3Strlen30NN(p->u.zToken)+1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001269 }
danielk1977bc739712009-03-23 04:33:32 +00001270 return ROUND8(nByte);
danielk19776ab3a2e2009-02-19 14:39:25 +00001271}
1272
1273/*
1274** Return the number of bytes required to create a duplicate of the
1275** expression passed as the first argument. The second argument is a
1276** mask containing EXPRDUP_XXX flags.
1277**
1278** The value returned includes space to create a copy of the Expr struct
drh33e619f2009-05-28 01:00:55 +00001279** itself and the buffer referred to by Expr.u.zToken, if any.
danielk19776ab3a2e2009-02-19 14:39:25 +00001280**
1281** If the EXPRDUP_REDUCE flag is set, then the return value includes
1282** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
1283** and Expr.pRight variables (but not for any structures pointed to or
1284** descended from the Expr.x.pList or Expr.x.pSelect variables).
1285*/
1286static int dupedExprSize(Expr *p, int flags){
1287 int nByte = 0;
1288 if( p ){
1289 nByte = dupedExprNodeSize(p, flags);
1290 if( flags&EXPRDUP_REDUCE ){
drhb7916a72009-05-27 10:31:29 +00001291 nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
danielk19776ab3a2e2009-02-19 14:39:25 +00001292 }
1293 }
1294 return nByte;
1295}
1296
1297/*
1298** This function is similar to sqlite3ExprDup(), except that if pzBuffer
1299** is not NULL then *pzBuffer is assumed to point to a buffer large enough
drh33e619f2009-05-28 01:00:55 +00001300** to store the copy of expression p, the copies of p->u.zToken
danielk19776ab3a2e2009-02-19 14:39:25 +00001301** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
peter.d.reid60ec9142014-09-06 16:39:46 +00001302** if any. Before returning, *pzBuffer is set to the first byte past the
danielk19776ab3a2e2009-02-19 14:39:25 +00001303** portion of the buffer copied into by this function.
1304*/
drh3c194692016-04-11 16:43:43 +00001305static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
1306 Expr *pNew; /* Value to return */
1307 u8 *zAlloc; /* Memory space from which to build Expr object */
1308 u32 staticFlag; /* EP_Static if space not obtained from malloc */
1309
drh575fad62016-02-05 13:38:36 +00001310 assert( db!=0 );
drh3c194692016-04-11 16:43:43 +00001311 assert( p );
1312 assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
1313 assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
danielk19776ab3a2e2009-02-19 14:39:25 +00001314
drh3c194692016-04-11 16:43:43 +00001315 /* Figure out where to write the new Expr structure. */
1316 if( pzBuffer ){
1317 zAlloc = *pzBuffer;
1318 staticFlag = EP_Static;
drh3c6edc82021-04-26 15:28:06 +00001319 assert( zAlloc!=0 );
drh3c194692016-04-11 16:43:43 +00001320 }else{
1321 zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
1322 staticFlag = 0;
1323 }
1324 pNew = (Expr *)zAlloc;
danielk19776ab3a2e2009-02-19 14:39:25 +00001325
drh3c194692016-04-11 16:43:43 +00001326 if( pNew ){
1327 /* Set nNewSize to the size allocated for the structure pointed to
1328 ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
1329 ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
1330 ** by the copy of the p->u.zToken string (if any).
1331 */
1332 const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
1333 const int nNewSize = nStructSize & 0xfff;
1334 int nToken;
1335 if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
1336 nToken = sqlite3Strlen30(p->u.zToken) + 1;
danielk19776ab3a2e2009-02-19 14:39:25 +00001337 }else{
drh3c194692016-04-11 16:43:43 +00001338 nToken = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001339 }
drh3c194692016-04-11 16:43:43 +00001340 if( dupFlags ){
1341 assert( ExprHasProperty(p, EP_Reduced)==0 );
1342 memcpy(zAlloc, p, nNewSize);
1343 }else{
1344 u32 nSize = (u32)exprStructSize(p);
1345 memcpy(zAlloc, p, nSize);
1346 if( nSize<EXPR_FULLSIZE ){
1347 memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
1348 }
1349 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001350
drh3c194692016-04-11 16:43:43 +00001351 /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1352 pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
1353 pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
1354 pNew->flags |= staticFlag;
drhe7375bf2020-03-10 19:24:38 +00001355 ExprClearVVAProperties(pNew);
1356 if( dupFlags ){
1357 ExprSetVVAProperty(pNew, EP_Immutable);
1358 }
drh3c194692016-04-11 16:43:43 +00001359
1360 /* Copy the p->u.zToken string, if any. */
1361 if( nToken ){
1362 char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
1363 memcpy(zToken, p->u.zToken, nToken);
1364 }
1365
drh209bc522016-09-23 21:36:24 +00001366 if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
drh3c194692016-04-11 16:43:43 +00001367 /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1368 if( ExprHasProperty(p, EP_xIsSelect) ){
1369 pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001370 }else{
drh3c194692016-04-11 16:43:43 +00001371 pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
drh33e619f2009-05-28 01:00:55 +00001372 }
drh3c194692016-04-11 16:43:43 +00001373 }
1374
1375 /* Fill in pNew->pLeft and pNew->pRight. */
dan4f9adee2019-07-13 16:22:50 +00001376 if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
drh53988062018-09-24 15:39:30 +00001377 zAlloc += dupedExprNodeSize(p, dupFlags);
drh209bc522016-09-23 21:36:24 +00001378 if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
drh3c194692016-04-11 16:43:43 +00001379 pNew->pLeft = p->pLeft ?
1380 exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
1381 pNew->pRight = p->pRight ?
1382 exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00001383 }
dan67a9b8e2018-06-22 20:51:35 +00001384#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00001385 if( ExprHasProperty(p, EP_WinFunc) ){
1386 pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1387 assert( ExprHasProperty(pNew, EP_WinFunc) );
dane2f781b2018-05-17 19:24:08 +00001388 }
dan67a9b8e2018-06-22 20:51:35 +00001389#endif /* SQLITE_OMIT_WINDOWFUNC */
drh53988062018-09-24 15:39:30 +00001390 if( pzBuffer ){
1391 *pzBuffer = zAlloc;
1392 }
1393 }else{
drh209bc522016-09-23 21:36:24 +00001394 if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
drh98542602016-08-20 17:00:16 +00001395 if( pNew->op==TK_SELECT_COLUMN ){
1396 pNew->pLeft = p->pLeft;
drh47073f62017-01-02 22:36:32 +00001397 assert( p->iColumn==0 || p->pRight==0 );
drh5cc9daf2021-04-12 23:18:18 +00001398 assert( p->pRight==0 || p->pRight==p->pLeft
1399 || ExprHasProperty(p->pLeft, EP_Subquery) );
drh98542602016-08-20 17:00:16 +00001400 }else{
1401 pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
1402 }
drh3c194692016-04-11 16:43:43 +00001403 pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
danielk19776ab3a2e2009-02-19 14:39:25 +00001404 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001405 }
1406 }
1407 return pNew;
1408}
1409
1410/*
danbfe31e72014-01-15 14:17:31 +00001411** Create and return a deep copy of the object passed as the second
1412** argument. If an OOM condition is encountered, NULL is returned
1413** and the db->mallocFailed flag set.
1414*/
daneede6a52014-01-15 19:42:23 +00001415#ifndef SQLITE_OMIT_CTE
danbfe31e72014-01-15 14:17:31 +00001416static With *withDup(sqlite3 *db, With *p){
dan4e9119d2014-01-13 15:12:23 +00001417 With *pRet = 0;
1418 if( p ){
drhd4de9f72019-04-14 00:34:20 +00001419 sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
dan4e9119d2014-01-13 15:12:23 +00001420 pRet = sqlite3DbMallocZero(db, nByte);
1421 if( pRet ){
1422 int i;
1423 pRet->nCte = p->nCte;
1424 for(i=0; i<p->nCte; i++){
1425 pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
1426 pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
1427 pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
1428 }
1429 }
1430 }
1431 return pRet;
1432}
daneede6a52014-01-15 19:42:23 +00001433#else
1434# define withDup(x,y) 0
1435#endif
dan4e9119d2014-01-13 15:12:23 +00001436
drha8389972018-12-06 22:04:19 +00001437#ifndef SQLITE_OMIT_WINDOWFUNC
1438/*
1439** The gatherSelectWindows() procedure and its helper routine
1440** gatherSelectWindowsCallback() are used to scan all the expressions
1441** an a newly duplicated SELECT statement and gather all of the Window
1442** objects found there, assembling them onto the linked list at Select->pWin.
1443*/
1444static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
dan6ba7ab02019-07-02 11:56:47 +00001445 if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
dan75b08212019-07-22 16:20:03 +00001446 Select *pSelect = pWalker->u.pSelect;
1447 Window *pWin = pExpr->y.pWin;
1448 assert( pWin );
dan4f9adee2019-07-13 16:22:50 +00001449 assert( IsWindowFunc(pExpr) );
dane0ae3f62019-07-22 17:28:43 +00001450 assert( pWin->ppThis==0 );
dana3fcc002019-08-15 13:53:22 +00001451 sqlite3WindowLink(pSelect, pWin);
drha8389972018-12-06 22:04:19 +00001452 }
1453 return WRC_Continue;
1454}
drha37b6a52018-12-06 22:12:18 +00001455static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1456 return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1457}
drha8389972018-12-06 22:04:19 +00001458static void gatherSelectWindows(Select *p){
1459 Walker w;
1460 w.xExprCallback = gatherSelectWindowsCallback;
drha37b6a52018-12-06 22:12:18 +00001461 w.xSelectCallback = gatherSelectWindowsSelectCallback;
1462 w.xSelectCallback2 = 0;
drh9c46c662019-02-01 15:06:27 +00001463 w.pParse = 0;
drha8389972018-12-06 22:04:19 +00001464 w.u.pSelect = p;
drha37b6a52018-12-06 22:12:18 +00001465 sqlite3WalkSelect(&w, p);
drha8389972018-12-06 22:04:19 +00001466}
1467#endif
1468
1469
drha76b5df2002-02-23 02:32:10 +00001470/*
drhff78bd22002-02-27 01:47:11 +00001471** The following group of routines make deep copies of expressions,
1472** expression lists, ID lists, and select statements. The copies can
1473** be deleted (by being passed to their respective ...Delete() routines)
1474** without effecting the originals.
1475**
danielk19774adee202004-05-08 08:23:19 +00001476** The expression list, ID, and source lists return by sqlite3ExprListDup(),
1477** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
drhad3cab52002-05-24 02:04:32 +00001478** by subsequent calls to sqlite*ListAppend() routines.
drhff78bd22002-02-27 01:47:11 +00001479**
drhad3cab52002-05-24 02:04:32 +00001480** Any tables that the SrcList might point to are not duplicated.
danielk19776ab3a2e2009-02-19 14:39:25 +00001481**
drhb7916a72009-05-27 10:31:29 +00001482** The flags parameter contains a combination of the EXPRDUP_XXX flags.
danielk19776ab3a2e2009-02-19 14:39:25 +00001483** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
1484** truncated version of the usual Expr structure that will be stored as
1485** part of the in-memory representation of the database schema.
drhff78bd22002-02-27 01:47:11 +00001486*/
danielk19776ab3a2e2009-02-19 14:39:25 +00001487Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
drh72ea29d2015-12-08 16:58:45 +00001488 assert( flags==0 || flags==EXPRDUP_REDUCE );
drh3c194692016-04-11 16:43:43 +00001489 return p ? exprDup(db, p, flags, 0) : 0;
drhff78bd22002-02-27 01:47:11 +00001490}
danielk19776ab3a2e2009-02-19 14:39:25 +00001491ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
drhff78bd22002-02-27 01:47:11 +00001492 ExprList *pNew;
drh145716b2004-09-24 12:24:06 +00001493 struct ExprList_item *pItem, *pOldItem;
drhff78bd22002-02-27 01:47:11 +00001494 int i;
drhb1637482017-01-03 00:27:16 +00001495 Expr *pPriorSelectCol = 0;
drh575fad62016-02-05 13:38:36 +00001496 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001497 if( p==0 ) return 0;
drh97258192017-09-17 19:45:28 +00001498 pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
drhff78bd22002-02-27 01:47:11 +00001499 if( pNew==0 ) return 0;
drha19543f2017-09-15 15:17:48 +00001500 pNew->nExpr = p->nExpr;
drh50e43c52021-03-23 14:27:35 +00001501 pNew->nAlloc = p->nAlloc;
drh43606172017-04-05 11:32:13 +00001502 pItem = pNew->a;
drh145716b2004-09-24 12:24:06 +00001503 pOldItem = p->a;
1504 for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
danielk19776ab3a2e2009-02-19 14:39:25 +00001505 Expr *pOldExpr = pOldItem->pExpr;
drh47073f62017-01-02 22:36:32 +00001506 Expr *pNewExpr;
drhb5526ea2009-07-16 12:41:05 +00001507 pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
drh47073f62017-01-02 22:36:32 +00001508 if( pOldExpr
1509 && pOldExpr->op==TK_SELECT_COLUMN
1510 && (pNewExpr = pItem->pExpr)!=0
1511 ){
1512 assert( pNewExpr->iColumn==0 || i>0 );
1513 if( pNewExpr->iColumn==0 ){
drhec2f6892021-05-20 23:25:28 +00001514 assert( pOldExpr->pLeft==pOldExpr->pRight
1515 || ExprHasProperty(pOldExpr->pLeft, EP_Subquery) );
drhb1637482017-01-03 00:27:16 +00001516 pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1517 }else{
1518 assert( i>0 );
1519 assert( pItem[-1].pExpr!=0 );
1520 assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1521 assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1522 pNewExpr->pLeft = pPriorSelectCol;
drh47073f62017-01-02 22:36:32 +00001523 }
1524 }
drh41cee662019-12-12 20:22:34 +00001525 pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
dan6e118922019-08-12 16:36:38 +00001526 pItem->sortFlags = pOldItem->sortFlags;
drhcbb9da32019-12-12 22:11:33 +00001527 pItem->eEName = pOldItem->eEName;
drh3e7bc9c2004-02-21 19:17:17 +00001528 pItem->done = 0;
danae8e45c2019-08-19 19:59:50 +00001529 pItem->bNulls = pOldItem->bNulls;
dan24e25d32018-04-14 18:46:20 +00001530 pItem->bSorterRef = pOldItem->bSorterRef;
drhc2acc4e2013-11-15 18:15:19 +00001531 pItem->u = pOldItem->u;
drhff78bd22002-02-27 01:47:11 +00001532 }
1533 return pNew;
1534}
danielk197793758c82005-01-21 08:13:14 +00001535
1536/*
1537** If cursors, triggers, views and subqueries are all omitted from
1538** the build, then none of the following routines, except for
1539** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
1540** called with a NULL argument.
1541*/
danielk19776a67fe82005-02-04 04:07:16 +00001542#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
1543 || !defined(SQLITE_OMIT_SUBQUERY)
danielk19776ab3a2e2009-02-19 14:39:25 +00001544SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
drhad3cab52002-05-24 02:04:32 +00001545 SrcList *pNew;
1546 int i;
drh113088e2003-03-20 01:16:58 +00001547 int nByte;
drh575fad62016-02-05 13:38:36 +00001548 assert( db!=0 );
drhad3cab52002-05-24 02:04:32 +00001549 if( p==0 ) return 0;
drh113088e2003-03-20 01:16:58 +00001550 nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
drh575fad62016-02-05 13:38:36 +00001551 pNew = sqlite3DbMallocRawNN(db, nByte );
drhad3cab52002-05-24 02:04:32 +00001552 if( pNew==0 ) return 0;
drh4305d102003-07-30 12:34:12 +00001553 pNew->nSrc = pNew->nAlloc = p->nSrc;
drhad3cab52002-05-24 02:04:32 +00001554 for(i=0; i<p->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001555 SrcItem *pNewItem = &pNew->a[i];
1556 SrcItem *pOldItem = &p->a[i];
drhed8a3bb2005-06-06 21:19:56 +00001557 Table *pTab;
dan41fb5cd2012-10-04 19:33:00 +00001558 pNewItem->pSchema = pOldItem->pSchema;
drh17435752007-08-16 04:30:38 +00001559 pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
1560 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1561 pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
drh8a48b9c2015-08-19 15:20:00 +00001562 pNewItem->fg = pOldItem->fg;
drh4efc4752004-01-16 15:55:37 +00001563 pNewItem->iCursor = pOldItem->iCursor;
drh5b6a9ed2011-09-15 23:58:14 +00001564 pNewItem->addrFillSub = pOldItem->addrFillSub;
1565 pNewItem->regReturn = pOldItem->regReturn;
drh8a48b9c2015-08-19 15:20:00 +00001566 if( pNewItem->fg.isIndexedBy ){
1567 pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
1568 }
drha79e2a22021-02-21 23:44:14 +00001569 pNewItem->u2 = pOldItem->u2;
1570 if( pNewItem->fg.isCte ){
1571 pNewItem->u2.pCteUse->nUse++;
1572 }
drh8a48b9c2015-08-19 15:20:00 +00001573 if( pNewItem->fg.isTabFunc ){
1574 pNewItem->u1.pFuncArg =
1575 sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
1576 }
drhed8a3bb2005-06-06 21:19:56 +00001577 pTab = pNewItem->pTab = pOldItem->pTab;
1578 if( pTab ){
drh79df7782016-12-14 14:07:35 +00001579 pTab->nTabRef++;
danielk1977a1cb1832005-02-12 08:59:55 +00001580 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001581 pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1582 pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
drh17435752007-08-16 04:30:38 +00001583 pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
danielk19776c18b6e2005-01-30 09:17:58 +00001584 pNewItem->colUsed = pOldItem->colUsed;
drhad3cab52002-05-24 02:04:32 +00001585 }
1586 return pNew;
1587}
drh17435752007-08-16 04:30:38 +00001588IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
drhff78bd22002-02-27 01:47:11 +00001589 IdList *pNew;
1590 int i;
drh575fad62016-02-05 13:38:36 +00001591 assert( db!=0 );
drhff78bd22002-02-27 01:47:11 +00001592 if( p==0 ) return 0;
drh575fad62016-02-05 13:38:36 +00001593 pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
drhff78bd22002-02-27 01:47:11 +00001594 if( pNew==0 ) return 0;
drh6c535152012-02-02 03:38:30 +00001595 pNew->nId = p->nId;
drh575fad62016-02-05 13:38:36 +00001596 pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
danielk1977d5d56522005-03-16 12:15:20 +00001597 if( pNew->a==0 ){
drhdbd6a7d2017-04-05 12:39:49 +00001598 sqlite3DbFreeNN(db, pNew);
danielk1977d5d56522005-03-16 12:15:20 +00001599 return 0;
1600 }
drh6c535152012-02-02 03:38:30 +00001601 /* Note that because the size of the allocation for p->a[] is not
1602 ** necessarily a power of two, sqlite3IdListAppend() may not be called
1603 ** on the duplicate created by this function. */
drhff78bd22002-02-27 01:47:11 +00001604 for(i=0; i<p->nId; i++){
drh4efc4752004-01-16 15:55:37 +00001605 struct IdList_item *pNewItem = &pNew->a[i];
1606 struct IdList_item *pOldItem = &p->a[i];
drh17435752007-08-16 04:30:38 +00001607 pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
drh4efc4752004-01-16 15:55:37 +00001608 pNewItem->idx = pOldItem->idx;
drhff78bd22002-02-27 01:47:11 +00001609 }
1610 return pNew;
1611}
dana7466202017-02-03 14:44:52 +00001612Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1613 Select *pRet = 0;
1614 Select *pNext = 0;
1615 Select **pp = &pRet;
1616 Select *p;
1617
drh575fad62016-02-05 13:38:36 +00001618 assert( db!=0 );
dana7466202017-02-03 14:44:52 +00001619 for(p=pDup; p; p=p->pPrior){
1620 Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1621 if( pNew==0 ) break;
1622 pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
1623 pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
1624 pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
1625 pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
1626 pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
1627 pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1628 pNew->op = p->op;
1629 pNew->pNext = pNext;
1630 pNew->pPrior = 0;
1631 pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
dana7466202017-02-03 14:44:52 +00001632 pNew->iLimit = 0;
1633 pNew->iOffset = 0;
1634 pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1635 pNew->addrOpenEphm[0] = -1;
1636 pNew->addrOpenEphm[1] = -1;
1637 pNew->nSelectRow = p->nSelectRow;
1638 pNew->pWith = withDup(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +00001639#ifndef SQLITE_OMIT_WINDOWFUNC
dan2e362f92018-05-17 14:26:27 +00001640 pNew->pWin = 0;
danc95f38d2018-06-18 20:34:43 +00001641 pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
dan4780b9a2019-08-20 14:43:01 +00001642 if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
dan67a9b8e2018-06-22 20:51:35 +00001643#endif
drhfef37762018-07-10 19:48:35 +00001644 pNew->selId = p->selId;
drh9da977f2021-04-20 12:14:12 +00001645 if( db->mallocFailed ){
1646 /* Any prior OOM might have left the Select object incomplete.
1647 ** Delete the whole thing rather than allow an incomplete Select
1648 ** to be used by the code generator. */
1649 pNew->pNext = 0;
1650 sqlite3SelectDelete(db, pNew);
1651 break;
1652 }
dana7466202017-02-03 14:44:52 +00001653 *pp = pNew;
1654 pp = &pNew->pPrior;
1655 pNext = pNew;
1656 }
1657
1658 return pRet;
drhff78bd22002-02-27 01:47:11 +00001659}
danielk197793758c82005-01-21 08:13:14 +00001660#else
danielk19776ab3a2e2009-02-19 14:39:25 +00001661Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
danielk197793758c82005-01-21 08:13:14 +00001662 assert( p==0 );
1663 return 0;
1664}
1665#endif
drhff78bd22002-02-27 01:47:11 +00001666
1667
1668/*
drha76b5df2002-02-23 02:32:10 +00001669** Add a new element to the end of an expression list. If pList is
1670** initially NULL, then create a new expression list.
drhb7916a72009-05-27 10:31:29 +00001671**
drha19543f2017-09-15 15:17:48 +00001672** The pList argument must be either NULL or a pointer to an ExprList
1673** obtained from a prior call to sqlite3ExprListAppend(). This routine
1674** may not be used with an ExprList obtained from sqlite3ExprListDup().
1675** Reason: This routine assumes that the number of slots in pList->a[]
1676** is a power of two. That is true for sqlite3ExprListAppend() returns
1677** but is not necessarily true from the return value of sqlite3ExprListDup().
1678**
drhb7916a72009-05-27 10:31:29 +00001679** If a memory allocation error occurs, the entire list is freed and
1680** NULL is returned. If non-NULL is returned, then it is guaranteed
1681** that the new entry was successfully appended.
drha76b5df2002-02-23 02:32:10 +00001682*/
larrybrdabada62021-04-04 12:52:58 +00001683static const struct ExprList_item zeroItem = {0};
drh50e43c52021-03-23 14:27:35 +00001684SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
1685 sqlite3 *db, /* Database handle. Used for memory allocation */
1686 Expr *pExpr /* Expression to be appended. Might be NULL */
1687){
1688 struct ExprList_item *pItem;
1689 ExprList *pList;
1690
1691 pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
1692 if( pList==0 ){
1693 sqlite3ExprDelete(db, pExpr);
1694 return 0;
1695 }
1696 pList->nAlloc = 4;
1697 pList->nExpr = 1;
1698 pItem = &pList->a[0];
1699 *pItem = zeroItem;
1700 pItem->pExpr = pExpr;
1701 return pList;
1702}
1703SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
1704 sqlite3 *db, /* Database handle. Used for memory allocation */
1705 ExprList *pList, /* List to which to append. Might be NULL */
1706 Expr *pExpr /* Expression to be appended. Might be NULL */
1707){
1708 struct ExprList_item *pItem;
1709 ExprList *pNew;
1710 pList->nAlloc *= 2;
1711 pNew = sqlite3DbRealloc(db, pList,
1712 sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
1713 if( pNew==0 ){
1714 sqlite3ExprListDelete(db, pList);
1715 sqlite3ExprDelete(db, pExpr);
1716 return 0;
1717 }else{
1718 pList = pNew;
1719 }
1720 pItem = &pList->a[pList->nExpr++];
1721 *pItem = zeroItem;
1722 pItem->pExpr = pExpr;
1723 return pList;
1724}
drh17435752007-08-16 04:30:38 +00001725ExprList *sqlite3ExprListAppend(
1726 Parse *pParse, /* Parsing context */
1727 ExprList *pList, /* List to which to append. Might be NULL */
drhb7916a72009-05-27 10:31:29 +00001728 Expr *pExpr /* Expression to be appended. Might be NULL */
drh17435752007-08-16 04:30:38 +00001729){
drh43606172017-04-05 11:32:13 +00001730 struct ExprList_item *pItem;
drha76b5df2002-02-23 02:32:10 +00001731 if( pList==0 ){
drh50e43c52021-03-23 14:27:35 +00001732 return sqlite3ExprListAppendNew(pParse->db,pExpr);
1733 }
1734 if( pList->nAlloc<pList->nExpr+1 ){
1735 return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
drha76b5df2002-02-23 02:32:10 +00001736 }
drh43606172017-04-05 11:32:13 +00001737 pItem = &pList->a[pList->nExpr++];
drh50e43c52021-03-23 14:27:35 +00001738 *pItem = zeroItem;
drh43606172017-04-05 11:32:13 +00001739 pItem->pExpr = pExpr;
drha76b5df2002-02-23 02:32:10 +00001740 return pList;
1741}
1742
1743/*
drh8762ec12016-08-20 01:06:22 +00001744** pColumns and pExpr form a vector assignment which is part of the SET
1745** clause of an UPDATE statement. Like this:
drha1251bc2016-08-20 00:51:37 +00001746**
1747** (a,b,c) = (expr1,expr2,expr3)
1748** Or: (a,b,c) = (SELECT x,y,z FROM ....)
1749**
1750** For each term of the vector assignment, append new entries to the
drhb67343d2017-01-03 11:59:54 +00001751** expression list pList. In the case of a subquery on the RHS, append
drha1251bc2016-08-20 00:51:37 +00001752** TK_SELECT_COLUMN expressions.
1753*/
1754ExprList *sqlite3ExprListAppendVector(
1755 Parse *pParse, /* Parsing context */
1756 ExprList *pList, /* List to which to append. Might be NULL */
1757 IdList *pColumns, /* List of names of LHS of the assignment */
1758 Expr *pExpr /* Vector expression to be appended. Might be NULL */
1759){
1760 sqlite3 *db = pParse->db;
1761 int n;
1762 int i;
drh66860af2016-08-23 18:30:10 +00001763 int iFirst = pList ? pList->nExpr : 0;
drh321e8282016-08-24 17:49:07 +00001764 /* pColumns can only be NULL due to an OOM but an OOM will cause an
1765 ** exit prior to this routine being invoked */
1766 if( NEVER(pColumns==0) ) goto vector_append_error;
drha1251bc2016-08-20 00:51:37 +00001767 if( pExpr==0 ) goto vector_append_error;
drh966e2912017-01-03 02:58:01 +00001768
1769 /* If the RHS is a vector, then we can immediately check to see that
1770 ** the size of the RHS and LHS match. But if the RHS is a SELECT,
1771 ** wildcards ("*") in the result set of the SELECT must be expanded before
1772 ** we can do the size check, so defer the size check until code generation.
1773 */
1774 if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
drha1251bc2016-08-20 00:51:37 +00001775 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1776 pColumns->nId, n);
1777 goto vector_append_error;
1778 }
drh966e2912017-01-03 02:58:01 +00001779
1780 for(i=0; i<pColumns->nId; i++){
drha1251bc2016-08-20 00:51:37 +00001781 Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
drh554a9dc2019-08-26 14:18:28 +00001782 assert( pSubExpr!=0 || db->mallocFailed );
1783 assert( pSubExpr==0 || pSubExpr->iTable==0 );
1784 if( pSubExpr==0 ) continue;
1785 pSubExpr->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001786 pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1787 if( pList ){
drh66860af2016-08-23 18:30:10 +00001788 assert( pList->nExpr==iFirst+i+1 );
drh41cee662019-12-12 20:22:34 +00001789 pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
drha1251bc2016-08-20 00:51:37 +00001790 pColumns->a[i].zName = 0;
1791 }
1792 }
drh966e2912017-01-03 02:58:01 +00001793
drhffe28052017-05-06 18:09:36 +00001794 if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
drhf4dd26c2017-04-05 11:49:06 +00001795 Expr *pFirst = pList->a[iFirst].pExpr;
1796 assert( pFirst!=0 );
1797 assert( pFirst->op==TK_SELECT_COLUMN );
drh966e2912017-01-03 02:58:01 +00001798
drhf4dd26c2017-04-05 11:49:06 +00001799 /* Store the SELECT statement in pRight so it will be deleted when
1800 ** sqlite3ExprListDelete() is called */
1801 pFirst->pRight = pExpr;
1802 pExpr = 0;
drh966e2912017-01-03 02:58:01 +00001803
drhf4dd26c2017-04-05 11:49:06 +00001804 /* Remember the size of the LHS in iTable so that we can check that
1805 ** the RHS and LHS sizes match during code generation. */
1806 pFirst->iTable = pColumns->nId;
drha1251bc2016-08-20 00:51:37 +00001807 }
1808
1809vector_append_error:
drh8e34e402019-06-11 10:43:56 +00001810 sqlite3ExprUnmapAndDelete(pParse, pExpr);
drha1251bc2016-08-20 00:51:37 +00001811 sqlite3IdListDelete(db, pColumns);
1812 return pList;
1813}
1814
1815/*
drhbc622bc2015-08-24 15:39:42 +00001816** Set the sort order for the last element on the given ExprList.
1817*/
dan6e118922019-08-12 16:36:38 +00001818void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
dan9105fd52019-08-19 17:26:32 +00001819 struct ExprList_item *pItem;
drhbc622bc2015-08-24 15:39:42 +00001820 if( p==0 ) return;
drhbc622bc2015-08-24 15:39:42 +00001821 assert( p->nExpr>0 );
dan6e118922019-08-12 16:36:38 +00001822
1823 assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
1824 assert( iSortOrder==SQLITE_SO_UNDEFINED
1825 || iSortOrder==SQLITE_SO_ASC
1826 || iSortOrder==SQLITE_SO_DESC
1827 );
1828 assert( eNulls==SQLITE_SO_UNDEFINED
1829 || eNulls==SQLITE_SO_ASC
1830 || eNulls==SQLITE_SO_DESC
1831 );
1832
dan9105fd52019-08-19 17:26:32 +00001833 pItem = &p->a[p->nExpr-1];
1834 assert( pItem->bNulls==0 );
1835 if( iSortOrder==SQLITE_SO_UNDEFINED ){
1836 iSortOrder = SQLITE_SO_ASC;
drhbc622bc2015-08-24 15:39:42 +00001837 }
dan9105fd52019-08-19 17:26:32 +00001838 pItem->sortFlags = (u8)iSortOrder;
1839
1840 if( eNulls!=SQLITE_SO_UNDEFINED ){
1841 pItem->bNulls = 1;
1842 if( iSortOrder!=eNulls ){
1843 pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
1844 }
drhbc622bc2015-08-24 15:39:42 +00001845 }
drhbc622bc2015-08-24 15:39:42 +00001846}
1847
1848/*
drh41cee662019-12-12 20:22:34 +00001849** Set the ExprList.a[].zEName element of the most recently added item
drhb7916a72009-05-27 10:31:29 +00001850** on the expression list.
1851**
1852** pList might be NULL following an OOM error. But pName should never be
1853** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1854** is set.
1855*/
1856void sqlite3ExprListSetName(
1857 Parse *pParse, /* Parsing context */
1858 ExprList *pList, /* List to which to add the span. */
1859 Token *pName, /* Name to be added */
1860 int dequote /* True to cause the name to be dequoted */
1861){
1862 assert( pList!=0 || pParse->db->mallocFailed!=0 );
drh2d99f952020-04-07 01:18:23 +00001863 assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
drhb7916a72009-05-27 10:31:29 +00001864 if( pList ){
1865 struct ExprList_item *pItem;
1866 assert( pList->nExpr>0 );
1867 pItem = &pList->a[pList->nExpr-1];
drh41cee662019-12-12 20:22:34 +00001868 assert( pItem->zEName==0 );
drhc4938ea2019-12-13 00:49:42 +00001869 assert( pItem->eEName==ENAME_NAME );
drh41cee662019-12-12 20:22:34 +00001870 pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
dan85f2c762020-04-06 16:37:05 +00001871 if( dequote ){
1872 /* If dequote==0, then pName->z does not point to part of a DDL
1873 ** statement handled by the parser. And so no token need be added
1874 ** to the token-map. */
1875 sqlite3Dequote(pItem->zEName);
1876 if( IN_RENAME_OBJECT ){
1877 sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
1878 }
dan5be60c52018-08-15 20:28:39 +00001879 }
drhb7916a72009-05-27 10:31:29 +00001880 }
1881}
1882
1883/*
1884** Set the ExprList.a[].zSpan element of the most recently added item
1885** on the expression list.
1886**
1887** pList might be NULL following an OOM error. But pSpan should never be
1888** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
1889** is set.
1890*/
1891void sqlite3ExprListSetSpan(
1892 Parse *pParse, /* Parsing context */
1893 ExprList *pList, /* List to which to add the span. */
drh1be266b2017-12-24 00:18:47 +00001894 const char *zStart, /* Start of the span */
1895 const char *zEnd /* End of the span */
drhb7916a72009-05-27 10:31:29 +00001896){
1897 sqlite3 *db = pParse->db;
1898 assert( pList!=0 || db->mallocFailed!=0 );
1899 if( pList ){
1900 struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1901 assert( pList->nExpr>0 );
drhcbb9da32019-12-12 22:11:33 +00001902 if( pItem->zEName==0 ){
1903 pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1904 pItem->eEName = ENAME_SPAN;
1905 }
drhb7916a72009-05-27 10:31:29 +00001906 }
1907}
1908
1909/*
danielk19777a15a4b2007-05-08 17:54:43 +00001910** If the expression list pEList contains more than iLimit elements,
1911** leave an error message in pParse.
1912*/
1913void sqlite3ExprListCheckLength(
1914 Parse *pParse,
1915 ExprList *pEList,
danielk19777a15a4b2007-05-08 17:54:43 +00001916 const char *zObject
1917){
drhb1a6c3c2008-03-20 16:30:17 +00001918 int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
drhc5499be2008-04-01 15:06:33 +00001919 testcase( pEList && pEList->nExpr==mx );
1920 testcase( pEList && pEList->nExpr==mx+1 );
drhb1a6c3c2008-03-20 16:30:17 +00001921 if( pEList && pEList->nExpr>mx ){
danielk19777a15a4b2007-05-08 17:54:43 +00001922 sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
1923 }
1924}
1925
1926/*
drha76b5df2002-02-23 02:32:10 +00001927** Delete an entire expression list.
1928*/
drhaffa8552016-04-11 18:25:05 +00001929static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
drhac48b752017-04-05 11:57:56 +00001930 int i = pList->nExpr;
1931 struct ExprList_item *pItem = pList->a;
1932 assert( pList->nExpr>0 );
1933 do{
drh633e6d52008-07-28 19:34:53 +00001934 sqlite3ExprDelete(db, pItem->pExpr);
drh41cee662019-12-12 20:22:34 +00001935 sqlite3DbFree(db, pItem->zEName);
drhac48b752017-04-05 11:57:56 +00001936 pItem++;
1937 }while( --i>0 );
drhdbd6a7d2017-04-05 12:39:49 +00001938 sqlite3DbFreeNN(db, pList);
drha76b5df2002-02-23 02:32:10 +00001939}
drhaffa8552016-04-11 18:25:05 +00001940void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1941 if( pList ) exprListDeleteNN(db, pList);
1942}
drha76b5df2002-02-23 02:32:10 +00001943
1944/*
drh2308ed32015-02-09 16:09:34 +00001945** Return the bitwise-OR of all Expr.flags fields in the given
1946** ExprList.
drh885a5b02015-02-09 15:21:36 +00001947*/
drh2308ed32015-02-09 16:09:34 +00001948u32 sqlite3ExprListFlags(const ExprList *pList){
drh885a5b02015-02-09 15:21:36 +00001949 int i;
drh2308ed32015-02-09 16:09:34 +00001950 u32 m = 0;
drh508e2d02017-09-30 01:25:04 +00001951 assert( pList!=0 );
1952 for(i=0; i<pList->nExpr; i++){
1953 Expr *pExpr = pList->a[i].pExpr;
1954 assert( pExpr!=0 );
1955 m |= pExpr->flags;
drh885a5b02015-02-09 15:21:36 +00001956 }
drh2308ed32015-02-09 16:09:34 +00001957 return m;
drh885a5b02015-02-09 15:21:36 +00001958}
1959
1960/*
drh7e6f9802017-09-04 00:33:04 +00001961** This is a SELECT-node callback for the expression walker that
1962** always "fails". By "fail" in this case, we mean set
1963** pWalker->eCode to zero and abort.
1964**
1965** This callback is used by multiple expression walkers.
1966*/
1967int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
1968 UNUSED_PARAMETER(NotUsed);
1969 pWalker->eCode = 0;
1970 return WRC_Abort;
1971}
1972
1973/*
drh0cbec592020-01-03 02:20:37 +00001974** Check the input string to see if it is "true" or "false" (in any case).
1975**
1976** If the string is.... Return
1977** "true" EP_IsTrue
1978** "false" EP_IsFalse
1979** anything else 0
1980*/
1981u32 sqlite3IsTrueOrFalse(const char *zIn){
1982 if( sqlite3StrICmp(zIn, "true")==0 ) return EP_IsTrue;
1983 if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
1984 return 0;
1985}
1986
1987
1988/*
drh171d16b2018-02-26 20:15:54 +00001989** If the input expression is an ID with the name "true" or "false"
drh96acafb2018-02-27 14:49:25 +00001990** then convert it into an TK_TRUEFALSE term. Return non-zero if
1991** the conversion happened, and zero if the expression is unaltered.
drh171d16b2018-02-26 20:15:54 +00001992*/
1993int sqlite3ExprIdToTrueFalse(Expr *pExpr){
drh0cbec592020-01-03 02:20:37 +00001994 u32 v;
drh171d16b2018-02-26 20:15:54 +00001995 assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
drh51d35b02019-01-11 13:32:23 +00001996 if( !ExprHasProperty(pExpr, EP_Quoted)
drh0cbec592020-01-03 02:20:37 +00001997 && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
drh171d16b2018-02-26 20:15:54 +00001998 ){
1999 pExpr->op = TK_TRUEFALSE;
drh0cbec592020-01-03 02:20:37 +00002000 ExprSetProperty(pExpr, v);
drh171d16b2018-02-26 20:15:54 +00002001 return 1;
2002 }
2003 return 0;
2004}
2005
drh43c4ac82018-02-26 21:26:27 +00002006/*
drh96acafb2018-02-27 14:49:25 +00002007** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
drh43c4ac82018-02-26 21:26:27 +00002008** and 0 if it is FALSE.
2009*/
drh96acafb2018-02-27 14:49:25 +00002010int sqlite3ExprTruthValue(const Expr *pExpr){
dan6ece3532019-06-12 13:49:32 +00002011 pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
drh43c4ac82018-02-26 21:26:27 +00002012 assert( pExpr->op==TK_TRUEFALSE );
2013 assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
2014 || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
2015 return pExpr->u.zToken[4]==0;
2016}
2017
drh17180fc2019-04-19 17:26:19 +00002018/*
2019** If pExpr is an AND or OR expression, try to simplify it by eliminating
2020** terms that are always true or false. Return the simplified expression.
2021** Or return the original expression if no simplification is possible.
2022**
2023** Examples:
2024**
2025** (x<10) AND true => (x<10)
2026** (x<10) AND false => false
2027** (x<10) AND (y=22 OR false) => (x<10) AND (y=22)
2028** (x<10) AND (y=22 OR true) => (x<10)
2029** (y=22) OR true => true
2030*/
2031Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
2032 assert( pExpr!=0 );
2033 if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
2034 Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
2035 Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
2036 if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
2037 pExpr = pExpr->op==TK_AND ? pRight : pLeft;
2038 }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
2039 pExpr = pExpr->op==TK_AND ? pLeft : pRight;
2040 }
2041 }
2042 return pExpr;
2043}
2044
drh171d16b2018-02-26 20:15:54 +00002045
2046/*
drh059b2d52014-10-24 19:28:09 +00002047** These routines are Walker callbacks used to check expressions to
2048** see if they are "constant" for some definition of constant. The
2049** Walker.eCode value determines the type of "constant" we are looking
2050** for.
drh73b211a2005-01-18 04:00:42 +00002051**
drh7d10d5a2008-08-20 16:35:10 +00002052** These callback routines are used to implement the following:
drh626a8792005-01-17 22:08:19 +00002053**
drh059b2d52014-10-24 19:28:09 +00002054** sqlite3ExprIsConstant() pWalker->eCode==1
2055** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
drhfcb9f4f2015-06-01 18:13:16 +00002056** sqlite3ExprIsTableConstant() pWalker->eCode==3
drh059b2d52014-10-24 19:28:09 +00002057** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
drh87abf5c2005-08-25 12:45:04 +00002058**
drh059b2d52014-10-24 19:28:09 +00002059** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2060** is found to not be a constant.
drh87abf5c2005-08-25 12:45:04 +00002061**
drh014fff22020-01-08 22:22:36 +00002062** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2063** expressions in a CREATE TABLE statement. The Walker.eCode value is 5
drh1e32bed2020-06-19 13:33:53 +00002064** when parsing an existing schema out of the sqlite_schema table and 4
drh014fff22020-01-08 22:22:36 +00002065** when processing a new CREATE TABLE statement. A bound parameter raises
2066** an error for new statements, but is silently converted
drh1e32bed2020-06-19 13:33:53 +00002067** to NULL for existing schemas. This allows sqlite_schema tables that
drhfeada2d2014-09-24 13:20:22 +00002068** contain a bound parameter because they were generated by older versions
2069** of SQLite to be parsed by newer versions of SQLite without raising a
2070** malformed schema error.
drh626a8792005-01-17 22:08:19 +00002071*/
drh7d10d5a2008-08-20 16:35:10 +00002072static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
drh626a8792005-01-17 22:08:19 +00002073
drh059b2d52014-10-24 19:28:09 +00002074 /* If pWalker->eCode is 2 then any term of the expression that comes from
2075 ** the ON or USING clauses of a left join disqualifies the expression
drh0a168372007-06-08 00:20:47 +00002076 ** from being considered constant. */
drh059b2d52014-10-24 19:28:09 +00002077 if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2078 pWalker->eCode = 0;
drh7d10d5a2008-08-20 16:35:10 +00002079 return WRC_Abort;
drh0a168372007-06-08 00:20:47 +00002080 }
2081
drh626a8792005-01-17 22:08:19 +00002082 switch( pExpr->op ){
drheb55bd22005-06-30 17:04:21 +00002083 /* Consider functions to be constant if all their arguments are constant
drh059b2d52014-10-24 19:28:09 +00002084 ** and either pWalker->eCode==4 or 5 or the function has the
2085 ** SQLITE_FUNC_CONST flag. */
drheb55bd22005-06-30 17:04:21 +00002086 case TK_FUNCTION:
drha634c9e2019-12-04 19:45:52 +00002087 if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2088 && !ExprHasProperty(pExpr, EP_WinFunc)
2089 ){
drh014fff22020-01-08 22:22:36 +00002090 if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
drhb1fba282013-11-21 14:33:48 +00002091 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002092 }else{
2093 pWalker->eCode = 0;
2094 return WRC_Abort;
drhb1fba282013-11-21 14:33:48 +00002095 }
drh626a8792005-01-17 22:08:19 +00002096 case TK_ID:
drh171d16b2018-02-26 20:15:54 +00002097 /* Convert "true" or "false" in a DEFAULT clause into the
2098 ** appropriate TK_TRUEFALSE operator */
drhe39ef312018-02-27 00:58:13 +00002099 if( sqlite3ExprIdToTrueFalse(pExpr) ){
drh171d16b2018-02-26 20:15:54 +00002100 return WRC_Prune;
2101 }
drh08b92082020-08-10 14:18:00 +00002102 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002103 case TK_COLUMN:
drh626a8792005-01-17 22:08:19 +00002104 case TK_AGG_FUNCTION:
drh13449892005-09-07 21:22:45 +00002105 case TK_AGG_COLUMN:
drhc5499be2008-04-01 15:06:33 +00002106 testcase( pExpr->op==TK_ID );
2107 testcase( pExpr->op==TK_COLUMN );
drhc5499be2008-04-01 15:06:33 +00002108 testcase( pExpr->op==TK_AGG_FUNCTION );
2109 testcase( pExpr->op==TK_AGG_COLUMN );
drh07aded62018-07-28 16:24:08 +00002110 if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
drhefad2e22018-07-27 16:57:11 +00002111 return WRC_Continue;
2112 }
drh059b2d52014-10-24 19:28:09 +00002113 if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2114 return WRC_Continue;
drh059b2d52014-10-24 19:28:09 +00002115 }
drh08b92082020-08-10 14:18:00 +00002116 /* no break */ deliberate_fall_through
drhf43ce0b2017-05-25 00:08:48 +00002117 case TK_IF_NULL_ROW:
drh6e341b92018-04-17 18:50:40 +00002118 case TK_REGISTER:
drh74e0d962020-06-13 03:18:21 +00002119 case TK_DOT:
drh99160482018-04-18 01:34:39 +00002120 testcase( pExpr->op==TK_REGISTER );
drhf43ce0b2017-05-25 00:08:48 +00002121 testcase( pExpr->op==TK_IF_NULL_ROW );
drh74e0d962020-06-13 03:18:21 +00002122 testcase( pExpr->op==TK_DOT );
drhf43ce0b2017-05-25 00:08:48 +00002123 pWalker->eCode = 0;
2124 return WRC_Abort;
drhfeada2d2014-09-24 13:20:22 +00002125 case TK_VARIABLE:
drh059b2d52014-10-24 19:28:09 +00002126 if( pWalker->eCode==5 ){
drhfeada2d2014-09-24 13:20:22 +00002127 /* Silently convert bound parameters that appear inside of CREATE
2128 ** statements into a NULL when parsing the CREATE statement text out
drh1e32bed2020-06-19 13:33:53 +00002129 ** of the sqlite_schema table */
drhfeada2d2014-09-24 13:20:22 +00002130 pExpr->op = TK_NULL;
drh059b2d52014-10-24 19:28:09 +00002131 }else if( pWalker->eCode==4 ){
drhfeada2d2014-09-24 13:20:22 +00002132 /* A bound parameter in a CREATE statement that originates from
2133 ** sqlite3_prepare() causes an error */
drh059b2d52014-10-24 19:28:09 +00002134 pWalker->eCode = 0;
drhfeada2d2014-09-24 13:20:22 +00002135 return WRC_Abort;
2136 }
drh08b92082020-08-10 14:18:00 +00002137 /* no break */ deliberate_fall_through
drh626a8792005-01-17 22:08:19 +00002138 default:
drh6e341b92018-04-17 18:50:40 +00002139 testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
2140 testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
drh7d10d5a2008-08-20 16:35:10 +00002141 return WRC_Continue;
drh626a8792005-01-17 22:08:19 +00002142 }
2143}
drh059b2d52014-10-24 19:28:09 +00002144static int exprIsConst(Expr *p, int initFlag, int iCur){
drh7d10d5a2008-08-20 16:35:10 +00002145 Walker w;
drh059b2d52014-10-24 19:28:09 +00002146 w.eCode = initFlag;
drh7d10d5a2008-08-20 16:35:10 +00002147 w.xExprCallback = exprNodeIsConstant;
drh7e6f9802017-09-04 00:33:04 +00002148 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002149#ifdef SQLITE_DEBUG
2150 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2151#endif
drh059b2d52014-10-24 19:28:09 +00002152 w.u.iCur = iCur;
drh7d10d5a2008-08-20 16:35:10 +00002153 sqlite3WalkExpr(&w, p);
drh059b2d52014-10-24 19:28:09 +00002154 return w.eCode;
drh7d10d5a2008-08-20 16:35:10 +00002155}
drh626a8792005-01-17 22:08:19 +00002156
2157/*
drh059b2d52014-10-24 19:28:09 +00002158** Walk an expression tree. Return non-zero if the expression is constant
drheb55bd22005-06-30 17:04:21 +00002159** and 0 if it involves variables or function calls.
drh23989372002-05-21 13:43:04 +00002160**
2161** For the purposes of this function, a double-quoted string (ex: "abc")
2162** is considered a variable but a single-quoted string (ex: 'abc') is
2163** a constant.
drhfef52082000-06-06 01:50:43 +00002164*/
danielk19774adee202004-05-08 08:23:19 +00002165int sqlite3ExprIsConstant(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002166 return exprIsConst(p, 1, 0);
drhfef52082000-06-06 01:50:43 +00002167}
2168
2169/*
drh07aded62018-07-28 16:24:08 +00002170** Walk an expression tree. Return non-zero if
2171**
2172** (1) the expression is constant, and
2173** (2) the expression does originate in the ON or USING clause
2174** of a LEFT JOIN, and
2175** (3) the expression does not contain any EP_FixedCol TK_COLUMN
2176** operands created by the constant propagation optimization.
2177**
2178** When this routine returns true, it indicates that the expression
2179** can be added to the pParse->pConstExpr list and evaluated once when
drh9b258c52020-03-11 19:41:49 +00002180** the prepared statement starts up. See sqlite3ExprCodeRunJustOnce().
drh0a168372007-06-08 00:20:47 +00002181*/
2182int sqlite3ExprIsConstantNotJoin(Expr *p){
drh059b2d52014-10-24 19:28:09 +00002183 return exprIsConst(p, 2, 0);
drh0a168372007-06-08 00:20:47 +00002184}
2185
2186/*
drhfcb9f4f2015-06-01 18:13:16 +00002187** Walk an expression tree. Return non-zero if the expression is constant
drh059b2d52014-10-24 19:28:09 +00002188** for any single row of the table with cursor iCur. In other words, the
2189** expression must not refer to any non-deterministic function nor any
2190** table other than iCur.
2191*/
2192int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2193 return exprIsConst(p, 3, iCur);
2194}
2195
danab31a842017-04-29 20:53:09 +00002196
2197/*
2198** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2199*/
2200static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2201 ExprList *pGroupBy = pWalker->u.pGroupBy;
2202 int i;
2203
2204 /* Check if pExpr is identical to any GROUP BY term. If so, consider
2205 ** it constant. */
2206 for(i=0; i<pGroupBy->nExpr; i++){
2207 Expr *p = pGroupBy->a[i].pExpr;
dan5aa550c2017-06-24 18:10:29 +00002208 if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
drh70efa842017-09-28 01:58:23 +00002209 CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
drhefad2e22018-07-27 16:57:11 +00002210 if( sqlite3IsBinary(pColl) ){
danab31a842017-04-29 20:53:09 +00002211 return WRC_Prune;
2212 }
2213 }
2214 }
2215
2216 /* Check if pExpr is a sub-select. If so, consider it variable. */
2217 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2218 pWalker->eCode = 0;
2219 return WRC_Abort;
2220 }
2221
2222 return exprNodeIsConstant(pWalker, pExpr);
2223}
2224
2225/*
2226** Walk the expression tree passed as the first argument. Return non-zero
2227** if the expression consists entirely of constants or copies of terms
2228** in pGroupBy that sort with the BINARY collation sequence.
drhab314002017-05-02 16:46:41 +00002229**
2230** This routine is used to determine if a term of the HAVING clause can
2231** be promoted into the WHERE clause. In order for such a promotion to work,
2232** the value of the HAVING clause term must be the same for all members of
2233** a "group". The requirement that the GROUP BY term must be BINARY
2234** assumes that no other collating sequence will have a finer-grained
2235** grouping than binary. In other words (A=B COLLATE binary) implies
2236** A=B in every other collating sequence. The requirement that the
2237** GROUP BY be BINARY is stricter than necessary. It would also work
2238** to promote HAVING clauses that use the same alternative collating
2239** sequence as the GROUP BY term, but that is much harder to check,
2240** alternative collating sequences are uncommon, and this is only an
2241** optimization, so we take the easy way out and simply require the
2242** GROUP BY to use the BINARY collating sequence.
danab31a842017-04-29 20:53:09 +00002243*/
2244int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2245 Walker w;
danab31a842017-04-29 20:53:09 +00002246 w.eCode = 1;
2247 w.xExprCallback = exprNodeIsConstantOrGroupBy;
drh979dd1b2017-05-29 14:26:07 +00002248 w.xSelectCallback = 0;
danab31a842017-04-29 20:53:09 +00002249 w.u.pGroupBy = pGroupBy;
2250 w.pParse = pParse;
2251 sqlite3WalkExpr(&w, p);
2252 return w.eCode;
2253}
2254
drh059b2d52014-10-24 19:28:09 +00002255/*
drh014fff22020-01-08 22:22:36 +00002256** Walk an expression tree for the DEFAULT field of a column definition
2257** in a CREATE TABLE statement. Return non-zero if the expression is
2258** acceptable for use as a DEFAULT. That is to say, return non-zero if
2259** the expression is constant or a function call with constant arguments.
2260** Return and 0 if there are any variables.
2261**
drh1e32bed2020-06-19 13:33:53 +00002262** isInit is true when parsing from sqlite_schema. isInit is false when
drh014fff22020-01-08 22:22:36 +00002263** processing a new CREATE TABLE statement. When isInit is true, parameters
2264** (such as ? or $abc) in the expression are converted into NULL. When
2265** isInit is false, parameters raise an error. Parameters should not be
2266** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
drh1e32bed2020-06-19 13:33:53 +00002267** allowed it, so we need to support it when reading sqlite_schema for
drh014fff22020-01-08 22:22:36 +00002268** backwards compatibility.
2269**
2270** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
drheb55bd22005-06-30 17:04:21 +00002271**
2272** For the purposes of this function, a double-quoted string (ex: "abc")
2273** is considered a variable but a single-quoted string (ex: 'abc') is
2274** a constant.
2275*/
drhfeada2d2014-09-24 13:20:22 +00002276int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2277 assert( isInit==0 || isInit==1 );
drh059b2d52014-10-24 19:28:09 +00002278 return exprIsConst(p, 4+isInit, 0);
drheb55bd22005-06-30 17:04:21 +00002279}
2280
drh5b88bc42013-12-07 23:35:21 +00002281#ifdef SQLITE_ENABLE_CURSOR_HINTS
2282/*
2283** Walk an expression tree. Return 1 if the expression contains a
2284** subquery of some kind. Return 0 if there are no subqueries.
2285*/
2286int sqlite3ExprContainsSubquery(Expr *p){
2287 Walker w;
drhbec24762015-08-13 20:07:13 +00002288 w.eCode = 1;
drh5b88bc42013-12-07 23:35:21 +00002289 w.xExprCallback = sqlite3ExprWalkNoop;
drh7e6f9802017-09-04 00:33:04 +00002290 w.xSelectCallback = sqlite3SelectWalkFail;
drh979dd1b2017-05-29 14:26:07 +00002291#ifdef SQLITE_DEBUG
2292 w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2293#endif
drh5b88bc42013-12-07 23:35:21 +00002294 sqlite3WalkExpr(&w, p);
drh07194bf2015-08-13 20:34:41 +00002295 return w.eCode==0;
drh5b88bc42013-12-07 23:35:21 +00002296}
2297#endif
2298
drheb55bd22005-06-30 17:04:21 +00002299/*
drh73b211a2005-01-18 04:00:42 +00002300** If the expression p codes a constant integer that is small enough
drh202b2df2004-01-06 01:13:46 +00002301** to fit in a 32-bit integer, return 1 and put the value of the integer
2302** in *pValue. If the expression is not an integer or if it is too big
2303** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
drhe4de1fe2002-06-02 16:09:01 +00002304*/
danielk19774adee202004-05-08 08:23:19 +00002305int sqlite3ExprIsInteger(Expr *p, int *pValue){
drh92b01d52008-06-24 00:32:35 +00002306 int rc = 0;
drh1d2d71a2019-04-19 23:05:56 +00002307 if( NEVER(p==0) ) return 0; /* Used to only happen following on OOM */
drhcd92e842011-02-17 15:58:20 +00002308
2309 /* If an expression is an integer literal that fits in a signed 32-bit
2310 ** integer, then the EP_IntValue flag will have already been set */
2311 assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2312 || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2313
drh92b01d52008-06-24 00:32:35 +00002314 if( p->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00002315 *pValue = p->u.iValue;
drh92b01d52008-06-24 00:32:35 +00002316 return 1;
2317 }
drhe4de1fe2002-06-02 16:09:01 +00002318 switch( p->op ){
drh4b59ab52002-08-24 18:24:51 +00002319 case TK_UPLUS: {
drh92b01d52008-06-24 00:32:35 +00002320 rc = sqlite3ExprIsInteger(p->pLeft, pValue);
drhf6e369a2008-06-24 12:46:30 +00002321 break;
drh4b59ab52002-08-24 18:24:51 +00002322 }
drhe4de1fe2002-06-02 16:09:01 +00002323 case TK_UMINUS: {
2324 int v;
danielk19774adee202004-05-08 08:23:19 +00002325 if( sqlite3ExprIsInteger(p->pLeft, &v) ){
mistachkinf6418892013-08-28 01:54:12 +00002326 assert( v!=(-2147483647-1) );
drhe4de1fe2002-06-02 16:09:01 +00002327 *pValue = -v;
drh92b01d52008-06-24 00:32:35 +00002328 rc = 1;
drhe4de1fe2002-06-02 16:09:01 +00002329 }
2330 break;
2331 }
2332 default: break;
2333 }
drh92b01d52008-06-24 00:32:35 +00002334 return rc;
drhe4de1fe2002-06-02 16:09:01 +00002335}
2336
2337/*
drh039fc322009-11-17 18:31:47 +00002338** Return FALSE if there is no chance that the expression can be NULL.
2339**
2340** If the expression might be NULL or if the expression is too complex
2341** to tell return TRUE.
2342**
2343** This routine is used as an optimization, to skip OP_IsNull opcodes
2344** when we know that a value cannot be NULL. Hence, a false positive
2345** (returning TRUE when in fact the expression can never be NULL) might
2346** be a small performance hit but is otherwise harmless. On the other
2347** hand, a false negative (returning FALSE when the result could be NULL)
2348** will likely result in an incorrect answer. So when in doubt, return
2349** TRUE.
2350*/
2351int sqlite3ExprCanBeNull(const Expr *p){
2352 u8 op;
drh3c6edc82021-04-26 15:28:06 +00002353 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002354 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2355 p = p->pLeft;
drh3c6edc82021-04-26 15:28:06 +00002356 assert( p!=0 );
drh9bfb0792018-12-22 01:13:25 +00002357 }
drh039fc322009-11-17 18:31:47 +00002358 op = p->op;
2359 if( op==TK_REGISTER ) op = p->op2;
2360 switch( op ){
2361 case TK_INTEGER:
2362 case TK_STRING:
2363 case TK_FLOAT:
2364 case TK_BLOB:
2365 return 0;
drh7248a8b2014-08-04 18:50:54 +00002366 case TK_COLUMN:
drh72673a22014-12-04 16:27:17 +00002367 return ExprHasProperty(p, EP_CanBeNull) ||
drheda079c2018-09-20 19:02:15 +00002368 p->y.pTab==0 || /* Reference to column of index on expression */
drh4eac5f02019-12-24 15:01:17 +00002369 (p->iColumn>=0
2370 && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
2371 && p->y.pTab->aCol[p->iColumn].notNull==0);
drh039fc322009-11-17 18:31:47 +00002372 default:
2373 return 1;
2374 }
2375}
2376
2377/*
2378** Return TRUE if the given expression is a constant which would be
2379** unchanged by OP_Affinity with the affinity given in the second
2380** argument.
2381**
2382** This routine is used to determine if the OP_Affinity operation
2383** can be omitted. When in doubt return FALSE. A false negative
2384** is harmless. A false positive, however, can result in the wrong
2385** answer.
2386*/
2387int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2388 u8 op;
drhaf866402019-08-22 11:11:28 +00002389 int unaryMinus = 0;
drh05883a32015-06-02 15:32:08 +00002390 if( aff==SQLITE_AFF_BLOB ) return 1;
drhaf866402019-08-22 11:11:28 +00002391 while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2392 if( p->op==TK_UMINUS ) unaryMinus = 1;
2393 p = p->pLeft;
2394 }
drh039fc322009-11-17 18:31:47 +00002395 op = p->op;
2396 if( op==TK_REGISTER ) op = p->op2;
2397 switch( op ){
2398 case TK_INTEGER: {
drh6a198652019-08-31 01:33:19 +00002399 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002400 }
2401 case TK_FLOAT: {
drh6a198652019-08-31 01:33:19 +00002402 return aff>=SQLITE_AFF_NUMERIC;
drh039fc322009-11-17 18:31:47 +00002403 }
2404 case TK_STRING: {
drhaf866402019-08-22 11:11:28 +00002405 return !unaryMinus && aff==SQLITE_AFF_TEXT;
drh039fc322009-11-17 18:31:47 +00002406 }
2407 case TK_BLOB: {
drhaf866402019-08-22 11:11:28 +00002408 return !unaryMinus;
drh039fc322009-11-17 18:31:47 +00002409 }
drh2f2855b2009-11-18 01:25:26 +00002410 case TK_COLUMN: {
drh88376ca2009-11-19 15:44:53 +00002411 assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
drh6a198652019-08-31 01:33:19 +00002412 return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
drh2f2855b2009-11-18 01:25:26 +00002413 }
drh039fc322009-11-17 18:31:47 +00002414 default: {
2415 return 0;
2416 }
2417 }
2418}
2419
2420/*
drhc4a3c772001-04-04 11:48:57 +00002421** Return TRUE if the given string is a row-id column name.
2422*/
danielk19774adee202004-05-08 08:23:19 +00002423int sqlite3IsRowid(const char *z){
2424 if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
2425 if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
2426 if( sqlite3StrICmp(z, "OID")==0 ) return 1;
drhc4a3c772001-04-04 11:48:57 +00002427 return 0;
2428}
2429
danielk19779a96b662007-11-29 17:05:18 +00002430/*
drh69c355b2016-03-09 15:34:51 +00002431** pX is the RHS of an IN operator. If pX is a SELECT statement
2432** that can be simplified to a direct table access, then return
2433** a pointer to the SELECT statement. If pX is not a SELECT statement,
2434** or if the SELECT statement needs to be manifested into a transient
2435** table, then return NULL.
drhb287f4b2008-04-25 00:08:38 +00002436*/
2437#ifndef SQLITE_OMIT_SUBQUERY
dan7b35a772016-07-28 19:47:15 +00002438static Select *isCandidateForInOpt(Expr *pX){
drh69c355b2016-03-09 15:34:51 +00002439 Select *p;
drhb287f4b2008-04-25 00:08:38 +00002440 SrcList *pSrc;
2441 ExprList *pEList;
2442 Table *pTab;
dancfbb5e82016-07-13 19:48:13 +00002443 int i;
drh69c355b2016-03-09 15:34:51 +00002444 if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
2445 if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
2446 p = pX->x.pSelect;
drhb287f4b2008-04-25 00:08:38 +00002447 if( p->pPrior ) return 0; /* Not a compound SELECT */
drh7d10d5a2008-08-20 16:35:10 +00002448 if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
drhb74b1012009-05-28 21:04:37 +00002449 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2450 testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
2451 return 0; /* No DISTINCT keyword and no aggregate functions */
drh7d10d5a2008-08-20 16:35:10 +00002452 }
drh2e26a602020-01-06 18:59:46 +00002453 assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
drhb287f4b2008-04-25 00:08:38 +00002454 if( p->pLimit ) return 0; /* Has no LIMIT clause */
drhb287f4b2008-04-25 00:08:38 +00002455 if( p->pWhere ) return 0; /* Has no WHERE clause */
2456 pSrc = p->pSrc;
drhd1fa7bc2009-01-10 13:24:50 +00002457 assert( pSrc!=0 );
2458 if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
drhb74b1012009-05-28 21:04:37 +00002459 if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
drhb287f4b2008-04-25 00:08:38 +00002460 pTab = pSrc->a[0].pTab;
drh69c355b2016-03-09 15:34:51 +00002461 assert( pTab!=0 );
drhb74b1012009-05-28 21:04:37 +00002462 assert( pTab->pSelect==0 ); /* FROM clause is not a view */
drhb287f4b2008-04-25 00:08:38 +00002463 if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
2464 pEList = p->pEList;
drhac6b47d2016-08-24 00:51:48 +00002465 assert( pEList!=0 );
dan7b35a772016-07-28 19:47:15 +00002466 /* All SELECT results must be columns. */
dancfbb5e82016-07-13 19:48:13 +00002467 for(i=0; i<pEList->nExpr; i++){
2468 Expr *pRes = pEList->a[i].pExpr;
2469 if( pRes->op!=TK_COLUMN ) return 0;
2470 assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
dancfbb5e82016-07-13 19:48:13 +00002471 }
drh69c355b2016-03-09 15:34:51 +00002472 return p;
drhb287f4b2008-04-25 00:08:38 +00002473}
2474#endif /* SQLITE_OMIT_SUBQUERY */
2475
danf9b2e052016-08-02 17:45:00 +00002476#ifndef SQLITE_OMIT_SUBQUERY
dan1d8cb212011-12-09 13:24:16 +00002477/*
drh4c259e92014-08-01 21:12:35 +00002478** Generate code that checks the left-most column of index table iCur to see if
2479** it contains any NULL entries. Cause the register at regHasNull to be set
drh6be515e2014-08-01 21:00:53 +00002480** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
2481** to be set to NULL if iCur contains one or more NULL values.
2482*/
2483static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
drh728e0f92015-10-10 14:41:28 +00002484 int addr1;
drh6be515e2014-08-01 21:00:53 +00002485 sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
drh728e0f92015-10-10 14:41:28 +00002486 addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
drh6be515e2014-08-01 21:00:53 +00002487 sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
2488 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
drh4c259e92014-08-01 21:12:35 +00002489 VdbeComment((v, "first_entry_in(%d)", iCur));
drh728e0f92015-10-10 14:41:28 +00002490 sqlite3VdbeJumpHere(v, addr1);
drh6be515e2014-08-01 21:00:53 +00002491}
danf9b2e052016-08-02 17:45:00 +00002492#endif
drh6be515e2014-08-01 21:00:53 +00002493
drhbb53ecb2014-08-02 21:03:33 +00002494
2495#ifndef SQLITE_OMIT_SUBQUERY
2496/*
2497** The argument is an IN operator with a list (not a subquery) on the
2498** right-hand side. Return TRUE if that list is constant.
2499*/
2500static int sqlite3InRhsIsConstant(Expr *pIn){
2501 Expr *pLHS;
2502 int res;
2503 assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2504 pLHS = pIn->pLeft;
2505 pIn->pLeft = 0;
2506 res = sqlite3ExprIsConstant(pIn);
2507 pIn->pLeft = pLHS;
2508 return res;
2509}
2510#endif
2511
drh6be515e2014-08-01 21:00:53 +00002512/*
danielk19779a96b662007-11-29 17:05:18 +00002513** This function is used by the implementation of the IN (...) operator.
drhd4305ca2012-09-18 17:08:33 +00002514** The pX parameter is the expression on the RHS of the IN operator, which
2515** might be either a list of expressions or a subquery.
danielk19779a96b662007-11-29 17:05:18 +00002516**
drhd4305ca2012-09-18 17:08:33 +00002517** The job of this routine is to find or create a b-tree object that can
2518** be used either to test for membership in the RHS set or to iterate through
2519** all members of the RHS set, skipping duplicates.
2520**
drh3a856252014-08-01 14:46:57 +00002521** A cursor is opened on the b-tree object that is the RHS of the IN operator
drhd4305ca2012-09-18 17:08:33 +00002522** and pX->iTable is set to the index of that cursor.
2523**
drhb74b1012009-05-28 21:04:37 +00002524** The returned value of this function indicates the b-tree type, as follows:
danielk19779a96b662007-11-29 17:05:18 +00002525**
drh1ccce442013-03-12 20:38:51 +00002526** IN_INDEX_ROWID - The cursor was opened on a database table.
2527** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
2528** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
2529** IN_INDEX_EPH - The cursor was opened on a specially created and
2530** populated epheremal table.
drhbb53ecb2014-08-02 21:03:33 +00002531** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
2532** implemented as a sequence of comparisons.
danielk19779a96b662007-11-29 17:05:18 +00002533**
drhd4305ca2012-09-18 17:08:33 +00002534** An existing b-tree might be used if the RHS expression pX is a simple
2535** subquery such as:
danielk19779a96b662007-11-29 17:05:18 +00002536**
dan553168c2016-08-01 20:14:31 +00002537** SELECT <column1>, <column2>... FROM <table>
danielk19779a96b662007-11-29 17:05:18 +00002538**
drhd4305ca2012-09-18 17:08:33 +00002539** If the RHS of the IN operator is a list or a more complex subquery, then
2540** an ephemeral table might need to be generated from the RHS and then
peter.d.reid60ec9142014-09-06 16:39:46 +00002541** pX->iTable made to point to the ephemeral table instead of an
drh3a856252014-08-01 14:46:57 +00002542** existing table.
drhd4305ca2012-09-18 17:08:33 +00002543**
drh7fc0ba02017-11-17 15:02:00 +00002544** The inFlags parameter must contain, at a minimum, one of the bits
2545** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
2546** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
2547** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
2548** be used to loop over all values of the RHS of the IN operator.
drh3a856252014-08-01 14:46:57 +00002549**
2550** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
2551** through the set members) then the b-tree must not contain duplicates.
drh7fc0ba02017-11-17 15:02:00 +00002552** An epheremal table will be created unless the selected columns are guaranteed
dan553168c2016-08-01 20:14:31 +00002553** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2554** a UNIQUE constraint or index.
danielk19770cdc0222008-06-26 18:04:03 +00002555**
drh3a856252014-08-01 14:46:57 +00002556** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
2557** for fast set membership tests) then an epheremal table must
dan553168c2016-08-01 20:14:31 +00002558** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2559** index can be found with the specified <columns> as its left-most.
danielk19770cdc0222008-06-26 18:04:03 +00002560**
drhbb53ecb2014-08-02 21:03:33 +00002561** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2562** if the RHS of the IN operator is a list (not a subquery) then this
2563** routine might decide that creating an ephemeral b-tree for membership
2564** testing is too expensive and return IN_INDEX_NOOP. In that case, the
2565** calling routine should implement the IN operator using a sequence
2566** of Eq or Ne comparison operations.
2567**
drhb74b1012009-05-28 21:04:37 +00002568** When the b-tree is being used for membership tests, the calling function
drh3a856252014-08-01 14:46:57 +00002569** might need to know whether or not the RHS side of the IN operator
drhe21a6e12014-08-01 18:00:24 +00002570** contains a NULL. If prRhsHasNull is not a NULL pointer and
drh3a856252014-08-01 14:46:57 +00002571** if there is any chance that the (...) might contain a NULL value at
danielk19770cdc0222008-06-26 18:04:03 +00002572** runtime, then a register is allocated and the register number written
drhe21a6e12014-08-01 18:00:24 +00002573** to *prRhsHasNull. If there is no chance that the (...) contains a
2574** NULL value, then *prRhsHasNull is left unchanged.
danielk19770cdc0222008-06-26 18:04:03 +00002575**
drhe21a6e12014-08-01 18:00:24 +00002576** If a register is allocated and its location stored in *prRhsHasNull, then
drh6be515e2014-08-01 21:00:53 +00002577** the value in that register will be NULL if the b-tree contains one or more
2578** NULL values, and it will be some non-NULL value if the b-tree contains no
2579** NULL values.
dan553168c2016-08-01 20:14:31 +00002580**
2581** If the aiMap parameter is not NULL, it must point to an array containing
2582** one element for each column returned by the SELECT statement on the RHS
2583** of the IN(...) operator. The i'th entry of the array is populated with the
2584** offset of the index column that matches the i'th column returned by the
2585** SELECT. For example, if the expression and selected index are:
2586**
2587** (?,?,?) IN (SELECT a, b, c FROM t1)
2588** CREATE INDEX i1 ON t1(b, c, a);
2589**
2590** then aiMap[] is populated with {2, 0, 1}.
danielk19779a96b662007-11-29 17:05:18 +00002591*/
danielk1977284f4ac2007-12-10 05:03:46 +00002592#ifndef SQLITE_OMIT_SUBQUERY
danba00e302016-07-23 20:24:06 +00002593int sqlite3FindInIndex(
drh6fc8f362016-08-26 19:31:29 +00002594 Parse *pParse, /* Parsing context */
drh0167ef22019-09-02 01:25:07 +00002595 Expr *pX, /* The IN expression */
drh6fc8f362016-08-26 19:31:29 +00002596 u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
2597 int *prRhsHasNull, /* Register holding NULL status. See notes */
drh2c041312018-12-24 02:34:49 +00002598 int *aiMap, /* Mapping from Index fields to RHS fields */
2599 int *piTab /* OUT: index to use */
danba00e302016-07-23 20:24:06 +00002600){
drhb74b1012009-05-28 21:04:37 +00002601 Select *p; /* SELECT to the right of IN operator */
2602 int eType = 0; /* Type of RHS table. IN_INDEX_* */
2603 int iTab = pParse->nTab++; /* Cursor of the RHS table */
drh3a856252014-08-01 14:46:57 +00002604 int mustBeUnique; /* True if RHS must be unique */
drhb8475df2011-12-09 16:21:19 +00002605 Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
danielk19779a96b662007-11-29 17:05:18 +00002606
drh1450bc62009-10-30 13:25:56 +00002607 assert( pX->op==TK_IN );
drh3a856252014-08-01 14:46:57 +00002608 mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
drh1450bc62009-10-30 13:25:56 +00002609
dan7b35a772016-07-28 19:47:15 +00002610 /* If the RHS of this IN(...) operator is a SELECT, and if it matters
2611 ** whether or not the SELECT result contains NULL values, check whether
dan870a0702016-08-01 16:37:43 +00002612 ** or not NULL is actually possible (it may not be, for example, due
dan7b35a772016-07-28 19:47:15 +00002613 ** to NOT NULL constraints in the schema). If no NULL values are possible,
dan870a0702016-08-01 16:37:43 +00002614 ** set prRhsHasNull to 0 before continuing. */
dan7b35a772016-07-28 19:47:15 +00002615 if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
2616 int i;
2617 ExprList *pEList = pX->x.pSelect->pEList;
2618 for(i=0; i<pEList->nExpr; i++){
2619 if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
2620 }
2621 if( i==pEList->nExpr ){
2622 prRhsHasNull = 0;
2623 }
2624 }
2625
drhb74b1012009-05-28 21:04:37 +00002626 /* Check to see if an existing table or index can be used to
2627 ** satisfy the query. This is preferable to generating a new
dan7b35a772016-07-28 19:47:15 +00002628 ** ephemeral table. */
2629 if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
danielk1977e1fb65a2009-04-02 17:23:32 +00002630 sqlite3 *db = pParse->db; /* Database connection */
drhb07028f2011-10-14 21:49:18 +00002631 Table *pTab; /* Table <table>. */
drh399062c2020-05-27 00:02:07 +00002632 int iDb; /* Database idx for pTab */
dancfbb5e82016-07-13 19:48:13 +00002633 ExprList *pEList = p->pEList;
2634 int nExpr = pEList->nExpr;
drhb07028f2011-10-14 21:49:18 +00002635
drhb07028f2011-10-14 21:49:18 +00002636 assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
2637 assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2638 assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
2639 pTab = p->pSrc->a[0].pTab;
dancfbb5e82016-07-13 19:48:13 +00002640
drhb22f7c82014-02-06 23:56:27 +00002641 /* Code an OP_Transaction and OP_TableLock for <table>. */
danielk1977e1fb65a2009-04-02 17:23:32 +00002642 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh099b3852021-03-10 16:35:37 +00002643 assert( iDb>=0 && iDb<SQLITE_MAX_DB );
danielk1977e1fb65a2009-04-02 17:23:32 +00002644 sqlite3CodeVerifySchema(pParse, iDb);
2645 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danielk19779a96b662007-11-29 17:05:18 +00002646
drha84a2832016-08-26 21:15:35 +00002647 assert(v); /* sqlite3GetVdbe() has always been previously called */
dancfbb5e82016-07-13 19:48:13 +00002648 if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
drh62659b22016-08-24 18:51:23 +00002649 /* The "x IN (SELECT rowid FROM table)" case */
drh511f9e82016-09-22 18:53:13 +00002650 int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
drh7d176102014-02-18 03:07:12 +00002651 VdbeCoverage(v);
danielk19779a96b662007-11-29 17:05:18 +00002652
2653 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2654 eType = IN_INDEX_ROWID;
drhd8852092018-08-16 15:29:40 +00002655 ExplainQueryPlan((pParse, 0,
2656 "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
danielk19779a96b662007-11-29 17:05:18 +00002657 sqlite3VdbeJumpHere(v, iAddr);
2658 }else{
danielk1977e1fb65a2009-04-02 17:23:32 +00002659 Index *pIdx; /* Iterator variable */
dancfbb5e82016-07-13 19:48:13 +00002660 int affinity_ok = 1;
2661 int i;
2662
2663 /* Check that the affinity that will be used to perform each
drh62659b22016-08-24 18:51:23 +00002664 ** comparison is the same as the affinity of each column in table
2665 ** on the RHS of the IN operator. If it not, it is not possible to
2666 ** use any index of the RHS table. */
dancfbb5e82016-07-13 19:48:13 +00002667 for(i=0; i<nExpr && affinity_ok; i++){
drhfc7f27b2016-08-20 00:07:01 +00002668 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
dancfbb5e82016-07-13 19:48:13 +00002669 int iCol = pEList->a[i].pExpr->iColumn;
drh0dfa4f62016-08-26 13:19:49 +00002670 char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
dancfbb5e82016-07-13 19:48:13 +00002671 char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
drh62659b22016-08-24 18:51:23 +00002672 testcase( cmpaff==SQLITE_AFF_BLOB );
2673 testcase( cmpaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002674 switch( cmpaff ){
2675 case SQLITE_AFF_BLOB:
2676 break;
2677 case SQLITE_AFF_TEXT:
drh62659b22016-08-24 18:51:23 +00002678 /* sqlite3CompareAffinity() only returns TEXT if one side or the
2679 ** other has no affinity and the other side is TEXT. Hence,
2680 ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
2681 ** and for the term on the LHS of the IN to have no affinity. */
2682 assert( idxaff==SQLITE_AFF_TEXT );
dancfbb5e82016-07-13 19:48:13 +00002683 break;
2684 default:
2685 affinity_ok = sqlite3IsNumericAffinity(idxaff);
2686 }
2687 }
danielk1977e1fb65a2009-04-02 17:23:32 +00002688
drha84a2832016-08-26 21:15:35 +00002689 if( affinity_ok ){
2690 /* Search for an existing index that will work for this IN operator */
2691 for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2692 Bitmask colUsed; /* Columns of the index used */
2693 Bitmask mCol; /* Mask for the current column */
2694 if( pIdx->nColumn<nExpr ) continue;
drhd4a4a362018-12-08 20:30:31 +00002695 if( pIdx->pPartIdxWhere!=0 ) continue;
drha84a2832016-08-26 21:15:35 +00002696 /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2697 ** BITMASK(nExpr) without overflowing */
2698 testcase( pIdx->nColumn==BMS-2 );
2699 testcase( pIdx->nColumn==BMS-1 );
2700 if( pIdx->nColumn>=BMS-1 ) continue;
2701 if( mustBeUnique ){
2702 if( pIdx->nKeyCol>nExpr
2703 ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
2704 ){
2705 continue; /* This index is not unique over the IN RHS columns */
dan7b35a772016-07-28 19:47:15 +00002706 }
danielk19770cdc0222008-06-26 18:04:03 +00002707 }
drha84a2832016-08-26 21:15:35 +00002708
2709 colUsed = 0; /* Columns of index used so far */
2710 for(i=0; i<nExpr; i++){
2711 Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2712 Expr *pRhs = pEList->a[i].pExpr;
2713 CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2714 int j;
2715
2716 assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2717 for(j=0; j<nExpr; j++){
2718 if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2719 assert( pIdx->azColl[j] );
drh106526e2016-08-26 22:09:01 +00002720 if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2721 continue;
2722 }
drha84a2832016-08-26 21:15:35 +00002723 break;
2724 }
2725 if( j==nExpr ) break;
2726 mCol = MASKBIT(j);
2727 if( mCol & colUsed ) break; /* Each column used only once */
2728 colUsed |= mCol;
2729 if( aiMap ) aiMap[i] = j;
2730 }
2731
2732 assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2733 if( colUsed==(MASKBIT(nExpr)-1) ){
2734 /* If we reach this point, that means the index pIdx is usable */
drh511f9e82016-09-22 18:53:13 +00002735 int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhe2ca99c2018-05-02 00:33:43 +00002736 ExplainQueryPlan((pParse, 0,
2737 "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
drha84a2832016-08-26 21:15:35 +00002738 sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
2739 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2740 VdbeComment((v, "%s", pIdx->zName));
2741 assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
2742 eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
2743
2744 if( prRhsHasNull ){
drhb80dbdc2016-09-09 15:12:41 +00002745#ifdef SQLITE_ENABLE_COLUMN_USED_MASK
drha84a2832016-08-26 21:15:35 +00002746 i64 mask = (1<<nExpr)-1;
2747 sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2748 iTab, 0, 0, (u8*)&mask, P4_INT64);
drhb80dbdc2016-09-09 15:12:41 +00002749#endif
2750 *prRhsHasNull = ++pParse->nMem;
drha84a2832016-08-26 21:15:35 +00002751 if( nExpr==1 ){
2752 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
2753 }
2754 }
2755 sqlite3VdbeJumpHere(v, iAddr);
2756 }
2757 } /* End loop over indexes */
2758 } /* End if( affinity_ok ) */
2759 } /* End if not an rowid index */
2760 } /* End attempt to optimize using an index */
danielk19779a96b662007-11-29 17:05:18 +00002761
drhbb53ecb2014-08-02 21:03:33 +00002762 /* If no preexisting index is available for the IN clause
2763 ** and IN_INDEX_NOOP is an allowed reply
2764 ** and the RHS of the IN operator is a list, not a subquery
dan71c57db2016-07-09 20:23:55 +00002765 ** and the RHS is not constant or has two or fewer terms,
peter.d.reid60ec9142014-09-06 16:39:46 +00002766 ** then it is not worth creating an ephemeral table to evaluate
drhbb53ecb2014-08-02 21:03:33 +00002767 ** the IN operator so return IN_INDEX_NOOP.
2768 */
2769 if( eType==0
2770 && (inFlags & IN_INDEX_NOOP_OK)
2771 && !ExprHasProperty(pX, EP_xIsSelect)
2772 && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2773 ){
2774 eType = IN_INDEX_NOOP;
2775 }
drhbb53ecb2014-08-02 21:03:33 +00002776
danielk19779a96b662007-11-29 17:05:18 +00002777 if( eType==0 ){
drh43870062014-07-31 15:44:44 +00002778 /* Could not find an existing table or index to use as the RHS b-tree.
drhb74b1012009-05-28 21:04:37 +00002779 ** We will have to generate an ephemeral table to do the job.
2780 */
drh8e23daf2013-06-11 13:30:04 +00002781 u32 savedNQueryLoop = pParse->nQueryLoop;
danielk19770cdc0222008-06-26 18:04:03 +00002782 int rMayHaveNull = 0;
danielk197741a05b72008-10-02 13:50:55 +00002783 eType = IN_INDEX_EPH;
drh3a856252014-08-01 14:46:57 +00002784 if( inFlags & IN_INDEX_LOOP ){
drh4a5acf82013-06-18 20:06:23 +00002785 pParse->nQueryLoop = 0;
drhe21a6e12014-08-01 18:00:24 +00002786 }else if( prRhsHasNull ){
2787 *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
danielk19770cdc0222008-06-26 18:04:03 +00002788 }
drh85bcdce2018-12-23 21:27:29 +00002789 assert( pX->op==TK_IN );
drh50ef6712019-02-22 23:29:56 +00002790 sqlite3CodeRhsOfIN(pParse, pX, iTab);
drh85bcdce2018-12-23 21:27:29 +00002791 if( rMayHaveNull ){
drh2c041312018-12-24 02:34:49 +00002792 sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
drh85bcdce2018-12-23 21:27:29 +00002793 }
drhcf4d38a2010-07-28 02:53:36 +00002794 pParse->nQueryLoop = savedNQueryLoop;
danielk19779a96b662007-11-29 17:05:18 +00002795 }
danba00e302016-07-23 20:24:06 +00002796
2797 if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2798 int i, n;
2799 n = sqlite3ExprVectorSize(pX->pLeft);
2800 for(i=0; i<n; i++) aiMap[i] = i;
2801 }
drh2c041312018-12-24 02:34:49 +00002802 *piTab = iTab;
danielk19779a96b662007-11-29 17:05:18 +00002803 return eType;
2804}
danielk1977284f4ac2007-12-10 05:03:46 +00002805#endif
drh626a8792005-01-17 22:08:19 +00002806
danf9b2e052016-08-02 17:45:00 +00002807#ifndef SQLITE_OMIT_SUBQUERY
dan553168c2016-08-01 20:14:31 +00002808/*
2809** Argument pExpr is an (?, ?...) IN(...) expression. This
2810** function allocates and returns a nul-terminated string containing
2811** the affinities to be used for each column of the comparison.
2812**
2813** It is the responsibility of the caller to ensure that the returned
2814** string is eventually freed using sqlite3DbFree().
2815*/
dan71c57db2016-07-09 20:23:55 +00002816static char *exprINAffinity(Parse *pParse, Expr *pExpr){
2817 Expr *pLeft = pExpr->pLeft;
2818 int nVal = sqlite3ExprVectorSize(pLeft);
dan553168c2016-08-01 20:14:31 +00002819 Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
dan71c57db2016-07-09 20:23:55 +00002820 char *zRet;
2821
dan553168c2016-08-01 20:14:31 +00002822 assert( pExpr->op==TK_IN );
drh5c258dc2017-02-16 17:18:07 +00002823 zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
dan71c57db2016-07-09 20:23:55 +00002824 if( zRet ){
2825 int i;
2826 for(i=0; i<nVal; i++){
drhfc7f27b2016-08-20 00:07:01 +00002827 Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
dan553168c2016-08-01 20:14:31 +00002828 char a = sqlite3ExprAffinity(pA);
2829 if( pSelect ){
2830 zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
2831 }else{
2832 zRet[i] = a;
dan71c57db2016-07-09 20:23:55 +00002833 }
dan71c57db2016-07-09 20:23:55 +00002834 }
2835 zRet[nVal] = '\0';
2836 }
2837 return zRet;
2838}
danf9b2e052016-08-02 17:45:00 +00002839#endif
dan71c57db2016-07-09 20:23:55 +00002840
dan8da209b2016-07-26 18:06:08 +00002841#ifndef SQLITE_OMIT_SUBQUERY
2842/*
2843** Load the Parse object passed as the first argument with an error
2844** message of the form:
2845**
2846** "sub-select returns N columns - expected M"
2847*/
2848void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
drha9ebfe22019-12-25 23:54:21 +00002849 if( pParse->nErr==0 ){
2850 const char *zFmt = "sub-select returns %d columns - expected %d";
2851 sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
2852 }
dan8da209b2016-07-26 18:06:08 +00002853}
2854#endif
2855
drh626a8792005-01-17 22:08:19 +00002856/*
dan44c56042016-12-07 15:38:37 +00002857** Expression pExpr is a vector that has been used in a context where
2858** it is not permitted. If pExpr is a sub-select vector, this routine
2859** loads the Parse object with a message of the form:
2860**
2861** "sub-select returns N columns - expected 1"
2862**
2863** Or, if it is a regular scalar vector:
2864**
2865** "row value misused"
2866*/
2867void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
2868#ifndef SQLITE_OMIT_SUBQUERY
2869 if( pExpr->flags & EP_xIsSelect ){
2870 sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
2871 }else
2872#endif
2873 {
2874 sqlite3ErrorMsg(pParse, "row value misused");
2875 }
2876}
2877
drh85bcdce2018-12-23 21:27:29 +00002878#ifndef SQLITE_OMIT_SUBQUERY
dan44c56042016-12-07 15:38:37 +00002879/*
drh85bcdce2018-12-23 21:27:29 +00002880** Generate code that will construct an ephemeral table containing all terms
2881** in the RHS of an IN operator. The IN operator can be in either of two
2882** forms:
drh626a8792005-01-17 22:08:19 +00002883**
drh9cbe6352005-11-29 03:13:21 +00002884** x IN (4,5,11) -- IN operator with list on right-hand side
2885** x IN (SELECT a FROM b) -- IN operator with subquery on the right
drhfef52082000-06-06 01:50:43 +00002886**
drh2c041312018-12-24 02:34:49 +00002887** The pExpr parameter is the IN operator. The cursor number for the
2888** constructed ephermeral table is returned. The first time the ephemeral
2889** table is computed, the cursor number is also stored in pExpr->iTable,
2890** however the cursor number returned might not be the same, as it might
2891** have been duplicated using OP_OpenDup.
danielk197741a05b72008-10-02 13:50:55 +00002892**
drh85bcdce2018-12-23 21:27:29 +00002893** If the LHS expression ("x" in the examples) is a column value, or
2894** the SELECT statement returns a column value, then the affinity of that
2895** column is used to build the index keys. If both 'x' and the
2896** SELECT... statement are columns, then numeric affinity is used
2897** if either column has NUMERIC or INTEGER affinity. If neither
2898** 'x' nor the SELECT... statement are columns, then numeric affinity
2899** is used.
drhcce7d172000-05-31 15:34:51 +00002900*/
drh85bcdce2018-12-23 21:27:29 +00002901void sqlite3CodeRhsOfIN(
drhfd773cf2009-05-29 14:39:07 +00002902 Parse *pParse, /* Parsing context */
drh85bcdce2018-12-23 21:27:29 +00002903 Expr *pExpr, /* The IN operator */
drh50ef6712019-02-22 23:29:56 +00002904 int iTab /* Use this cursor number */
danielk197741a05b72008-10-02 13:50:55 +00002905){
drh2c041312018-12-24 02:34:49 +00002906 int addrOnce = 0; /* Address of the OP_Once instruction at top */
drh85bcdce2018-12-23 21:27:29 +00002907 int addr; /* Address of OP_OpenEphemeral instruction */
2908 Expr *pLeft; /* the LHS of the IN operator */
2909 KeyInfo *pKeyInfo = 0; /* Key information */
2910 int nVal; /* Size of vector pLeft */
2911 Vdbe *v; /* The prepared statement under construction */
danielk1977fc976062007-05-10 10:46:56 +00002912
drh2c041312018-12-24 02:34:49 +00002913 v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00002914 assert( v!=0 );
2915
drh2c041312018-12-24 02:34:49 +00002916 /* The evaluation of the IN must be repeated every time it
drh39a11812016-08-19 19:12:58 +00002917 ** is encountered if any of the following is true:
drh57dbd7b2005-07-08 18:25:26 +00002918 **
2919 ** * The right-hand side is a correlated subquery
2920 ** * The right-hand side is an expression list containing variables
2921 ** * We are inside a trigger
2922 **
drh2c041312018-12-24 02:34:49 +00002923 ** If all of the above are false, then we can compute the RHS just once
2924 ** and reuse it many names.
danielk1977b3bce662005-01-29 08:32:43 +00002925 */
drhefb699f2018-12-24 11:55:44 +00002926 if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
drh2c041312018-12-24 02:34:49 +00002927 /* Reuse of the RHS is allowed */
2928 /* If this routine has already been coded, but the previous code
2929 ** might not have been invoked yet, so invoke it now as a subroutine.
2930 */
2931 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhf9231c32018-12-31 21:43:55 +00002932 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drhbd462bc2018-12-24 20:21:06 +00002933 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2934 ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2935 pExpr->x.pSelect->selId));
2936 }
drh2c041312018-12-24 02:34:49 +00002937 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
2938 pExpr->y.sub.iAddr);
2939 sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
drhf9231c32018-12-31 21:43:55 +00002940 sqlite3VdbeJumpHere(v, addrOnce);
drh2c041312018-12-24 02:34:49 +00002941 return;
2942 }
2943
2944 /* Begin coding the subroutine */
2945 ExprSetProperty(pExpr, EP_Subrtn);
drh088489e2020-03-10 02:57:37 +00002946 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh2c041312018-12-24 02:34:49 +00002947 pExpr->y.sub.regReturn = ++pParse->nMem;
2948 pExpr->y.sub.iAddr =
2949 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
2950 VdbeComment((v, "return address"));
2951
2952 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00002953 }
2954
drh85bcdce2018-12-23 21:27:29 +00002955 /* Check to see if this is a vector IN operator */
2956 pLeft = pExpr->pLeft;
2957 nVal = sqlite3ExprVectorSize(pLeft);
danielk1977e014a832004-05-17 10:48:57 +00002958
drh85bcdce2018-12-23 21:27:29 +00002959 /* Construct the ephemeral table that will contain the content of
2960 ** RHS of the IN operator.
2961 */
drh2c041312018-12-24 02:34:49 +00002962 pExpr->iTable = iTab;
drh50ef6712019-02-22 23:29:56 +00002963 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
drh2c041312018-12-24 02:34:49 +00002964#ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
2965 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2966 VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
2967 }else{
2968 VdbeComment((v, "RHS of IN operator"));
2969 }
2970#endif
drh50ef6712019-02-22 23:29:56 +00002971 pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
danielk1977e014a832004-05-17 10:48:57 +00002972
drh85bcdce2018-12-23 21:27:29 +00002973 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2974 /* Case 1: expr IN (SELECT ...)
2975 **
2976 ** Generate code to write the results of the select into the temporary
2977 ** table allocated and opened above.
2978 */
2979 Select *pSelect = pExpr->x.pSelect;
2980 ExprList *pEList = pSelect->pEList;
drh1013c932008-01-06 00:25:21 +00002981
drh2c041312018-12-24 02:34:49 +00002982 ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
2983 addrOnce?"":"CORRELATED ", pSelect->selId
drh85bcdce2018-12-23 21:27:29 +00002984 ));
drh85bcdce2018-12-23 21:27:29 +00002985 /* If the LHS and RHS of the IN operator do not match, that
2986 ** error will have been caught long before we reach this point. */
2987 if( ALWAYS(pEList->nExpr==nVal) ){
2988 SelectDest dest;
2989 int i;
drhbd462bc2018-12-24 20:21:06 +00002990 sqlite3SelectDestInit(&dest, SRT_Set, iTab);
drh85bcdce2018-12-23 21:27:29 +00002991 dest.zAffSdst = exprINAffinity(pParse, pExpr);
2992 pSelect->iLimit = 0;
2993 testcase( pSelect->selFlags & SF_Distinct );
2994 testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
2995 if( sqlite3Select(pParse, pSelect, &dest) ){
2996 sqlite3DbFree(pParse->db, dest.zAffSdst);
2997 sqlite3KeyInfoUnref(pKeyInfo);
2998 return;
drhfef52082000-06-06 01:50:43 +00002999 }
drh85bcdce2018-12-23 21:27:29 +00003000 sqlite3DbFree(pParse->db, dest.zAffSdst);
3001 assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
3002 assert( pEList!=0 );
3003 assert( pEList->nExpr>0 );
3004 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3005 for(i=0; i<nVal; i++){
3006 Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
3007 pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
3008 pParse, p, pEList->a[i].pExpr
3009 );
danielk197741a05b72008-10-02 13:50:55 +00003010 }
drh85bcdce2018-12-23 21:27:29 +00003011 }
3012 }else if( ALWAYS(pExpr->x.pList!=0) ){
3013 /* Case 2: expr IN (exprlist)
3014 **
3015 ** For each expression, build an index key from the evaluation and
3016 ** store it in the temporary table. If <expr> is a column, then use
3017 ** that columns affinity when building index keys. If <expr> is not
3018 ** a column, use numeric affinity.
3019 */
3020 char affinity; /* Affinity of the LHS of the IN */
3021 int i;
3022 ExprList *pList = pExpr->x.pList;
3023 struct ExprList_item *pItem;
danc324d442019-08-17 19:13:49 +00003024 int r1, r2;
drh85bcdce2018-12-23 21:27:29 +00003025 affinity = sqlite3ExprAffinity(pLeft);
drh96fb16e2019-08-06 14:37:24 +00003026 if( affinity<=SQLITE_AFF_NONE ){
drh85bcdce2018-12-23 21:27:29 +00003027 affinity = SQLITE_AFF_BLOB;
drh95b39592020-03-26 00:29:50 +00003028 }else if( affinity==SQLITE_AFF_REAL ){
3029 affinity = SQLITE_AFF_NUMERIC;
drh85bcdce2018-12-23 21:27:29 +00003030 }
3031 if( pKeyInfo ){
3032 assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3033 pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhfef52082000-06-06 01:50:43 +00003034 }
3035
drh85bcdce2018-12-23 21:27:29 +00003036 /* Loop through each expression in <exprlist>. */
3037 r1 = sqlite3GetTempReg(pParse);
3038 r2 = sqlite3GetTempReg(pParse);
drh85bcdce2018-12-23 21:27:29 +00003039 for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
3040 Expr *pE2 = pItem->pExpr;
drh85bcdce2018-12-23 21:27:29 +00003041
3042 /* If the expression is not constant then we will need to
3043 ** disable the test that was generated above that makes sure
3044 ** this code only executes once. Because for a non-constant
3045 ** expression we need to rerun this code each time.
drhfef52082000-06-06 01:50:43 +00003046 */
drh2c041312018-12-24 02:34:49 +00003047 if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
3048 sqlite3VdbeChangeToNoop(v, addrOnce);
dan7ac0e562019-05-18 21:22:25 +00003049 ExprClearProperty(pExpr, EP_Subrtn);
drh2c041312018-12-24 02:34:49 +00003050 addrOnce = 0;
drh85bcdce2018-12-23 21:27:29 +00003051 }
drh1398ad32005-01-19 23:24:50 +00003052
drh85bcdce2018-12-23 21:27:29 +00003053 /* Evaluate the expression and insert it into the temp table */
danc324d442019-08-17 19:13:49 +00003054 sqlite3ExprCode(pParse, pE2, r1);
3055 sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3056 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
drhcce7d172000-05-31 15:34:51 +00003057 }
drh85bcdce2018-12-23 21:27:29 +00003058 sqlite3ReleaseTempReg(pParse, r1);
3059 sqlite3ReleaseTempReg(pParse, r2);
drhcce7d172000-05-31 15:34:51 +00003060 }
drh85bcdce2018-12-23 21:27:29 +00003061 if( pKeyInfo ){
3062 sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
3063 }
drh2c041312018-12-24 02:34:49 +00003064 if( addrOnce ){
3065 sqlite3VdbeJumpHere(v, addrOnce);
3066 /* Subroutine return */
3067 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3068 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003069 sqlite3ClearTempRegCache(pParse);
drh85bcdce2018-12-23 21:27:29 +00003070 }
3071}
3072#endif /* SQLITE_OMIT_SUBQUERY */
danielk1977b3bce662005-01-29 08:32:43 +00003073
drh85bcdce2018-12-23 21:27:29 +00003074/*
3075** Generate code for scalar subqueries used as a subquery expression
3076** or EXISTS operator:
3077**
3078** (SELECT a FROM b) -- subquery
3079** EXISTS (SELECT a FROM b) -- EXISTS subquery
3080**
3081** The pExpr parameter is the SELECT or EXISTS operator to be coded.
3082**
drhd86fe442019-08-26 13:45:49 +00003083** Return the register that holds the result. For a multi-column SELECT,
drh85bcdce2018-12-23 21:27:29 +00003084** the result is stored in a contiguous array of registers and the
3085** return value is the register of the left-most result column.
3086** Return 0 if an error occurs.
3087*/
3088#ifndef SQLITE_OMIT_SUBQUERY
3089int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
drh2c041312018-12-24 02:34:49 +00003090 int addrOnce = 0; /* Address of OP_Once at top of subroutine */
drh85bcdce2018-12-23 21:27:29 +00003091 int rReg = 0; /* Register storing resulting */
3092 Select *pSel; /* SELECT statement to encode */
3093 SelectDest dest; /* How to deal with SELECT result */
3094 int nReg; /* Registers to allocate */
3095 Expr *pLimit; /* New limit expression */
drh2c041312018-12-24 02:34:49 +00003096
3097 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00003098 assert( v!=0 );
drh05428122021-05-24 00:17:04 +00003099 if( pParse->nErr ) return 0;
drhbd462bc2018-12-24 20:21:06 +00003100 testcase( pExpr->op==TK_EXISTS );
3101 testcase( pExpr->op==TK_SELECT );
3102 assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3103 assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3104 pSel = pExpr->x.pSelect;
drh85bcdce2018-12-23 21:27:29 +00003105
drh5198ff52018-12-24 12:09:47 +00003106 /* The evaluation of the EXISTS/SELECT must be repeated every time it
drh85bcdce2018-12-23 21:27:29 +00003107 ** is encountered if any of the following is true:
3108 **
3109 ** * The right-hand side is a correlated subquery
3110 ** * The right-hand side is an expression list containing variables
3111 ** * We are inside a trigger
3112 **
3113 ** If all of the above are false, then we can run this code just once
3114 ** save the results, and reuse the same result on subsequent invocations.
3115 */
3116 if( !ExprHasProperty(pExpr, EP_VarSelect) ){
drh5198ff52018-12-24 12:09:47 +00003117 /* If this routine has already been coded, then invoke it as a
3118 ** subroutine. */
3119 if( ExprHasProperty(pExpr, EP_Subrtn) ){
drhbd462bc2018-12-24 20:21:06 +00003120 ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
drh5198ff52018-12-24 12:09:47 +00003121 sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
3122 pExpr->y.sub.iAddr);
3123 return pExpr->iTable;
3124 }
3125
3126 /* Begin coding the subroutine */
3127 ExprSetProperty(pExpr, EP_Subrtn);
3128 pExpr->y.sub.regReturn = ++pParse->nMem;
3129 pExpr->y.sub.iAddr =
3130 sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
3131 VdbeComment((v, "return address"));
3132
drh2c041312018-12-24 02:34:49 +00003133 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
danielk1977b3bce662005-01-29 08:32:43 +00003134 }
drh85bcdce2018-12-23 21:27:29 +00003135
3136 /* For a SELECT, generate code to put the values for all columns of
3137 ** the first row into an array of registers and return the index of
3138 ** the first register.
3139 **
3140 ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
3141 ** into a register and return that register number.
3142 **
3143 ** In both cases, the query is augmented with "LIMIT 1". Any
3144 ** preexisting limit is discarded in place of the new LIMIT 1.
3145 */
drhbd462bc2018-12-24 20:21:06 +00003146 ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3147 addrOnce?"":"CORRELATED ", pSel->selId));
drh85bcdce2018-12-23 21:27:29 +00003148 nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
3149 sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
3150 pParse->nMem += nReg;
3151 if( pExpr->op==TK_SELECT ){
3152 dest.eDest = SRT_Mem;
3153 dest.iSdst = dest.iSDParm;
3154 dest.nSdst = nReg;
3155 sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3156 VdbeComment((v, "Init subquery result"));
3157 }else{
3158 dest.eDest = SRT_Exists;
3159 sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3160 VdbeComment((v, "Init EXISTS result"));
3161 }
drh85bcdce2018-12-23 21:27:29 +00003162 if( pSel->pLimit ){
drh7ca13472019-09-23 11:55:22 +00003163 /* The subquery already has a limit. If the pre-existing limit is X
3164 ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
3165 sqlite3 *db = pParse->db;
drh5776ee52019-09-23 12:38:10 +00003166 pLimit = sqlite3Expr(db, TK_INTEGER, "0");
drh7ca13472019-09-23 11:55:22 +00003167 if( pLimit ){
3168 pLimit->affExpr = SQLITE_AFF_NUMERIC;
3169 pLimit = sqlite3PExpr(pParse, TK_NE,
3170 sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
3171 }
3172 sqlite3ExprDelete(db, pSel->pLimit->pLeft);
drh85bcdce2018-12-23 21:27:29 +00003173 pSel->pLimit->pLeft = pLimit;
3174 }else{
drh7ca13472019-09-23 11:55:22 +00003175 /* If there is no pre-existing limit add a limit of 1 */
drh5776ee52019-09-23 12:38:10 +00003176 pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
drh85bcdce2018-12-23 21:27:29 +00003177 pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
3178 }
3179 pSel->iLimit = 0;
3180 if( sqlite3Select(pParse, pSel, &dest) ){
drhbf7f3a02021-05-24 11:35:16 +00003181 if( pParse->nErr ){
3182 pExpr->op2 = pExpr->op;
3183 pExpr->op = TK_ERROR;
3184 }
drh85bcdce2018-12-23 21:27:29 +00003185 return 0;
3186 }
drh2c041312018-12-24 02:34:49 +00003187 pExpr->iTable = rReg = dest.iSDParm;
drh85bcdce2018-12-23 21:27:29 +00003188 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh2c041312018-12-24 02:34:49 +00003189 if( addrOnce ){
3190 sqlite3VdbeJumpHere(v, addrOnce);
danielk1977fc976062007-05-10 10:46:56 +00003191
drh5198ff52018-12-24 12:09:47 +00003192 /* Subroutine return */
3193 sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
3194 sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
drh6d2566d2019-09-18 20:34:54 +00003195 sqlite3ClearTempRegCache(pParse);
drh5198ff52018-12-24 12:09:47 +00003196 }
drh2c041312018-12-24 02:34:49 +00003197
drh1450bc62009-10-30 13:25:56 +00003198 return rReg;
drhcce7d172000-05-31 15:34:51 +00003199}
drh51522cd2005-01-20 13:36:19 +00003200#endif /* SQLITE_OMIT_SUBQUERY */
drhcce7d172000-05-31 15:34:51 +00003201
drhe3365e62009-11-12 17:52:24 +00003202#ifndef SQLITE_OMIT_SUBQUERY
3203/*
dan7b35a772016-07-28 19:47:15 +00003204** Expr pIn is an IN(...) expression. This function checks that the
3205** sub-select on the RHS of the IN() operator has the same number of
3206** columns as the vector on the LHS. Or, if the RHS of the IN() is not
3207** a sub-query, that the LHS is a vector of size 1.
3208*/
3209int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
3210 int nVector = sqlite3ExprVectorSize(pIn->pLeft);
drh7a04e292021-04-23 00:59:38 +00003211 if( (pIn->flags & EP_xIsSelect)!=0 && !pParse->db->mallocFailed ){
dan7b35a772016-07-28 19:47:15 +00003212 if( nVector!=pIn->x.pSelect->pEList->nExpr ){
3213 sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
3214 return 1;
3215 }
3216 }else if( nVector!=1 ){
dan44c56042016-12-07 15:38:37 +00003217 sqlite3VectorErrorMsg(pParse, pIn->pLeft);
dan7b35a772016-07-28 19:47:15 +00003218 return 1;
3219 }
3220 return 0;
3221}
3222#endif
3223
3224#ifndef SQLITE_OMIT_SUBQUERY
3225/*
drhe3365e62009-11-12 17:52:24 +00003226** Generate code for an IN expression.
3227**
3228** x IN (SELECT ...)
3229** x IN (value, value, ...)
3230**
drhecb87ac2016-08-25 15:46:25 +00003231** The left-hand side (LHS) is a scalar or vector expression. The
drhe347d3e2016-08-25 21:14:34 +00003232** right-hand side (RHS) is an array of zero or more scalar values, or a
3233** subquery. If the RHS is a subquery, the number of result columns must
3234** match the number of columns in the vector on the LHS. If the RHS is
3235** a list of values, the LHS must be a scalar.
3236**
3237** The IN operator is true if the LHS value is contained within the RHS.
3238** The result is false if the LHS is definitely not in the RHS. The
3239** result is NULL if the presence of the LHS in the RHS cannot be
3240** determined due to NULLs.
drhe3365e62009-11-12 17:52:24 +00003241**
drh6be515e2014-08-01 21:00:53 +00003242** This routine generates code that jumps to destIfFalse if the LHS is not
drhe3365e62009-11-12 17:52:24 +00003243** contained within the RHS. If due to NULLs we cannot determine if the LHS
3244** is contained in the RHS then jump to destIfNull. If the LHS is contained
3245** within the RHS then fall through.
drhecb87ac2016-08-25 15:46:25 +00003246**
3247** See the separate in-operator.md documentation file in the canonical
3248** SQLite source tree for additional information.
drhe3365e62009-11-12 17:52:24 +00003249*/
3250static void sqlite3ExprCodeIN(
3251 Parse *pParse, /* Parsing and code generating context */
3252 Expr *pExpr, /* The IN expression */
3253 int destIfFalse, /* Jump here if LHS is not contained in the RHS */
3254 int destIfNull /* Jump here if the results are unknown due to NULLs */
3255){
3256 int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
drhe3365e62009-11-12 17:52:24 +00003257 int eType; /* Type of the RHS */
drhe347d3e2016-08-25 21:14:34 +00003258 int rLhs; /* Register(s) holding the LHS values */
3259 int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
drhe3365e62009-11-12 17:52:24 +00003260 Vdbe *v; /* Statement under construction */
danba00e302016-07-23 20:24:06 +00003261 int *aiMap = 0; /* Map from vector field to index column */
3262 char *zAff = 0; /* Affinity string for comparisons */
drhe347d3e2016-08-25 21:14:34 +00003263 int nVector; /* Size of vectors for this IN operator */
3264 int iDummy; /* Dummy parameter to exprCodeVector() */
3265 Expr *pLeft; /* The LHS of the IN operator */
3266 int i; /* loop counter */
3267 int destStep2; /* Where to jump when NULLs seen in step 2 */
3268 int destStep6 = 0; /* Start of code for Step 6 */
3269 int addrTruthOp; /* Address of opcode that determines the IN is true */
3270 int destNotNull; /* Jump here if a comparison is not true in step 6 */
3271 int addrTop; /* Top of the step-6 loop */
drh2c041312018-12-24 02:34:49 +00003272 int iTab = 0; /* Index to use */
danc59b4ac2020-04-03 19:37:14 +00003273 u8 okConstFactor = pParse->okConstFactor;
drhe3365e62009-11-12 17:52:24 +00003274
drhe7375bf2020-03-10 19:24:38 +00003275 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhe347d3e2016-08-25 21:14:34 +00003276 pLeft = pExpr->pLeft;
dan7b35a772016-07-28 19:47:15 +00003277 if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
dan553168c2016-08-01 20:14:31 +00003278 zAff = exprINAffinity(pParse, pExpr);
danba00e302016-07-23 20:24:06 +00003279 nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3280 aiMap = (int*)sqlite3DbMallocZero(
3281 pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3282 );
drhe347d3e2016-08-25 21:14:34 +00003283 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
dan7b35a772016-07-28 19:47:15 +00003284
danba00e302016-07-23 20:24:06 +00003285 /* Attempt to compute the RHS. After this step, if anything other than
drh2c041312018-12-24 02:34:49 +00003286 ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
danba00e302016-07-23 20:24:06 +00003287 ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3288 ** the RHS has not yet been coded. */
drhe3365e62009-11-12 17:52:24 +00003289 v = pParse->pVdbe;
3290 assert( v!=0 ); /* OOM detected prior to this routine */
3291 VdbeNoopComment((v, "begin IN expr"));
drhbb53ecb2014-08-02 21:03:33 +00003292 eType = sqlite3FindInIndex(pParse, pExpr,
3293 IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
drh2c041312018-12-24 02:34:49 +00003294 destIfFalse==destIfNull ? 0 : &rRhsHasNull,
3295 aiMap, &iTab);
drhe3365e62009-11-12 17:52:24 +00003296
danba00e302016-07-23 20:24:06 +00003297 assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3298 || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3299 );
drhecb87ac2016-08-25 15:46:25 +00003300#ifdef SQLITE_DEBUG
3301 /* Confirm that aiMap[] contains nVector integer values between 0 and
3302 ** nVector-1. */
3303 for(i=0; i<nVector; i++){
3304 int j, cnt;
3305 for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3306 assert( cnt==1 );
3307 }
3308#endif
drhe3365e62009-11-12 17:52:24 +00003309
danba00e302016-07-23 20:24:06 +00003310 /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3311 ** vector, then it is stored in an array of nVector registers starting
3312 ** at r1.
drhe347d3e2016-08-25 21:14:34 +00003313 **
3314 ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3315 ** so that the fields are in the same order as an existing index. The
3316 ** aiMap[] array contains a mapping from the original LHS field order to
3317 ** the field order that matches the RHS index.
danc59b4ac2020-04-03 19:37:14 +00003318 **
3319 ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3320 ** even if it is constant, as OP_Affinity may be used on the register
3321 ** by code generated below. */
3322 assert( pParse->okConstFactor==okConstFactor );
3323 pParse->okConstFactor = 0;
drhe347d3e2016-08-25 21:14:34 +00003324 rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
danc59b4ac2020-04-03 19:37:14 +00003325 pParse->okConstFactor = okConstFactor;
drhe347d3e2016-08-25 21:14:34 +00003326 for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
drhecb87ac2016-08-25 15:46:25 +00003327 if( i==nVector ){
drhe347d3e2016-08-25 21:14:34 +00003328 /* LHS fields are not reordered */
3329 rLhs = rLhsOrig;
drhecb87ac2016-08-25 15:46:25 +00003330 }else{
3331 /* Need to reorder the LHS fields according to aiMap */
drhe347d3e2016-08-25 21:14:34 +00003332 rLhs = sqlite3GetTempRange(pParse, nVector);
drhecb87ac2016-08-25 15:46:25 +00003333 for(i=0; i<nVector; i++){
drhe347d3e2016-08-25 21:14:34 +00003334 sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
drhecb87ac2016-08-25 15:46:25 +00003335 }
danba00e302016-07-23 20:24:06 +00003336 }
drhe3365e62009-11-12 17:52:24 +00003337
drhbb53ecb2014-08-02 21:03:33 +00003338 /* If sqlite3FindInIndex() did not find or create an index that is
3339 ** suitable for evaluating the IN operator, then evaluate using a
3340 ** sequence of comparisons.
drhe347d3e2016-08-25 21:14:34 +00003341 **
3342 ** This is step (1) in the in-operator.md optimized algorithm.
drh094430e2010-07-14 18:24:06 +00003343 */
drhbb53ecb2014-08-02 21:03:33 +00003344 if( eType==IN_INDEX_NOOP ){
3345 ExprList *pList = pExpr->x.pList;
3346 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhec4ccdb2018-12-29 02:26:59 +00003347 int labelOk = sqlite3VdbeMakeLabel(pParse);
drhbb53ecb2014-08-02 21:03:33 +00003348 int r2, regToFree;
3349 int regCkNull = 0;
3350 int ii;
3351 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhbb53ecb2014-08-02 21:03:33 +00003352 if( destIfNull!=destIfFalse ){
3353 regCkNull = sqlite3GetTempReg(pParse);
drhe347d3e2016-08-25 21:14:34 +00003354 sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
drhbb53ecb2014-08-02 21:03:33 +00003355 }
3356 for(ii=0; ii<pList->nExpr; ii++){
drh95b39592020-03-26 00:29:50 +00003357 r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
drha9769792014-08-04 16:39:39 +00003358 if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
drhbb53ecb2014-08-02 21:03:33 +00003359 sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3360 }
drhf6ea97e2020-01-04 15:21:47 +00003361 sqlite3ReleaseTempReg(pParse, regToFree);
drhbb53ecb2014-08-02 21:03:33 +00003362 if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
drh47994882019-12-22 23:48:36 +00003363 int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
3364 sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
drh4336b0e2014-08-05 00:53:51 +00003365 (void*)pColl, P4_COLLSEQ);
drh47994882019-12-22 23:48:36 +00003366 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
3367 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
3368 VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
3369 VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
danba00e302016-07-23 20:24:06 +00003370 sqlite3VdbeChangeP5(v, zAff[0]);
drhbb53ecb2014-08-02 21:03:33 +00003371 }else{
drh47994882019-12-22 23:48:36 +00003372 int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
drhbb53ecb2014-08-02 21:03:33 +00003373 assert( destIfNull==destIfFalse );
drh47994882019-12-22 23:48:36 +00003374 sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
3375 (void*)pColl, P4_COLLSEQ);
3376 VdbeCoverageIf(v, op==OP_Ne);
3377 VdbeCoverageIf(v, op==OP_IsNull);
danba00e302016-07-23 20:24:06 +00003378 sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
drhbb53ecb2014-08-02 21:03:33 +00003379 }
drhbb53ecb2014-08-02 21:03:33 +00003380 }
3381 if( regCkNull ){
3382 sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003383 sqlite3VdbeGoto(v, destIfFalse);
drhbb53ecb2014-08-02 21:03:33 +00003384 }
3385 sqlite3VdbeResolveLabel(v, labelOk);
3386 sqlite3ReleaseTempReg(pParse, regCkNull);
drhe347d3e2016-08-25 21:14:34 +00003387 goto sqlite3ExprCodeIN_finished;
3388 }
3389
3390 /* Step 2: Check to see if the LHS contains any NULL columns. If the
3391 ** LHS does contain NULLs then the result must be either FALSE or NULL.
3392 ** We will then skip the binary search of the RHS.
3393 */
3394 if( destIfNull==destIfFalse ){
3395 destStep2 = destIfFalse;
drh094430e2010-07-14 18:24:06 +00003396 }else{
drhec4ccdb2018-12-29 02:26:59 +00003397 destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003398 }
drh4eac5f02019-12-24 15:01:17 +00003399 if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
drhe347d3e2016-08-25 21:14:34 +00003400 for(i=0; i<nVector; i++){
3401 Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
drh4c4a2572021-04-06 12:50:24 +00003402 if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
drhe347d3e2016-08-25 21:14:34 +00003403 if( sqlite3ExprCanBeNull(p) ){
3404 sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
dand49fd4e2016-07-27 19:33:04 +00003405 VdbeCoverage(v);
drhe3365e62009-11-12 17:52:24 +00003406 }
drhe3365e62009-11-12 17:52:24 +00003407 }
drhe347d3e2016-08-25 21:14:34 +00003408
3409 /* Step 3. The LHS is now known to be non-NULL. Do the binary search
3410 ** of the RHS using the LHS as a probe. If found, the result is
3411 ** true.
3412 */
3413 if( eType==IN_INDEX_ROWID ){
3414 /* In this case, the RHS is the ROWID of table b-tree and so we also
3415 ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
3416 ** into a single opcode. */
drh2c041312018-12-24 02:34:49 +00003417 sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
drhe347d3e2016-08-25 21:14:34 +00003418 VdbeCoverage(v);
3419 addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
3420 }else{
3421 sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3422 if( destIfFalse==destIfNull ){
3423 /* Combine Step 3 and Step 5 into a single opcode */
drh2c041312018-12-24 02:34:49 +00003424 sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
drhe347d3e2016-08-25 21:14:34 +00003425 rLhs, nVector); VdbeCoverage(v);
3426 goto sqlite3ExprCodeIN_finished;
3427 }
3428 /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
drh2c041312018-12-24 02:34:49 +00003429 addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
drhe347d3e2016-08-25 21:14:34 +00003430 rLhs, nVector); VdbeCoverage(v);
3431 }
3432
3433 /* Step 4. If the RHS is known to be non-NULL and we did not find
3434 ** an match on the search above, then the result must be FALSE.
3435 */
3436 if( rRhsHasNull && nVector==1 ){
3437 sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3438 VdbeCoverage(v);
3439 }
3440
3441 /* Step 5. If we do not care about the difference between NULL and
3442 ** FALSE, then just return false.
3443 */
3444 if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3445
3446 /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
3447 ** If any comparison is NULL, then the result is NULL. If all
3448 ** comparisons are FALSE then the final result is FALSE.
3449 **
3450 ** For a scalar LHS, it is sufficient to check just the first row
3451 ** of the RHS.
3452 */
3453 if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
drh2c041312018-12-24 02:34:49 +00003454 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
drhe347d3e2016-08-25 21:14:34 +00003455 VdbeCoverage(v);
3456 if( nVector>1 ){
drhec4ccdb2018-12-29 02:26:59 +00003457 destNotNull = sqlite3VdbeMakeLabel(pParse);
drhe347d3e2016-08-25 21:14:34 +00003458 }else{
3459 /* For nVector==1, combine steps 6 and 7 by immediately returning
3460 ** FALSE if the first comparison is not NULL */
3461 destNotNull = destIfFalse;
3462 }
3463 for(i=0; i<nVector; i++){
3464 Expr *p;
3465 CollSeq *pColl;
3466 int r3 = sqlite3GetTempReg(pParse);
3467 p = sqlite3VectorFieldSubexpr(pLeft, i);
3468 pColl = sqlite3ExprCollSeq(pParse, p);
drh2c041312018-12-24 02:34:49 +00003469 sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
drhe347d3e2016-08-25 21:14:34 +00003470 sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
3471 (void*)pColl, P4_COLLSEQ);
3472 VdbeCoverage(v);
3473 sqlite3ReleaseTempReg(pParse, r3);
3474 }
3475 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3476 if( nVector>1 ){
3477 sqlite3VdbeResolveLabel(v, destNotNull);
drh2c041312018-12-24 02:34:49 +00003478 sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
drhe347d3e2016-08-25 21:14:34 +00003479 VdbeCoverage(v);
3480
3481 /* Step 7: If we reach this point, we know that the result must
3482 ** be false. */
3483 sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
3484 }
3485
3486 /* Jumps here in order to return true. */
3487 sqlite3VdbeJumpHere(v, addrTruthOp);
3488
3489sqlite3ExprCodeIN_finished:
3490 if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
drhecb87ac2016-08-25 15:46:25 +00003491 VdbeComment((v, "end IN expr"));
drhe347d3e2016-08-25 21:14:34 +00003492sqlite3ExprCodeIN_oom_error:
danba00e302016-07-23 20:24:06 +00003493 sqlite3DbFree(pParse->db, aiMap);
dan553168c2016-08-01 20:14:31 +00003494 sqlite3DbFree(pParse->db, zAff);
drhe3365e62009-11-12 17:52:24 +00003495}
3496#endif /* SQLITE_OMIT_SUBQUERY */
3497
drh13573c72010-01-12 17:04:07 +00003498#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00003499/*
3500** Generate an instruction that will put the floating point
drh9cbf3422008-01-17 16:22:13 +00003501** value described by z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003502**
3503** The z[] string will probably not be zero-terminated. But the
3504** z[n] character is guaranteed to be something that does not look
3505** like the continuation of the number.
drh598f1342007-10-23 15:39:45 +00003506*/
drhb7916a72009-05-27 10:31:29 +00003507static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
drhfd773cf2009-05-29 14:39:07 +00003508 if( ALWAYS(z!=0) ){
drh598f1342007-10-23 15:39:45 +00003509 double value;
drh9339da12010-09-30 00:50:49 +00003510 sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
drhd0015162009-08-21 13:22:25 +00003511 assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3512 if( negateFlag ) value = -value;
drh97bae792015-06-05 15:59:57 +00003513 sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
drh598f1342007-10-23 15:39:45 +00003514 }
3515}
drh13573c72010-01-12 17:04:07 +00003516#endif
drh598f1342007-10-23 15:39:45 +00003517
3518
3519/*
drhfec19aa2004-05-19 20:41:03 +00003520** Generate an instruction that will put the integer describe by
drh9cbf3422008-01-17 16:22:13 +00003521** text z[0..n-1] into register iMem.
drh0cf19ed2007-10-23 18:55:48 +00003522**
shaneh5f1d6b62010-09-30 16:51:25 +00003523** Expr.u.zToken is always UTF8 and zero-terminated.
drhfec19aa2004-05-19 20:41:03 +00003524*/
drh13573c72010-01-12 17:04:07 +00003525static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
3526 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003527 if( pExpr->flags & EP_IntValue ){
drh33e619f2009-05-28 01:00:55 +00003528 int i = pExpr->u.iValue;
drhd50ffc42011-03-08 02:38:28 +00003529 assert( i>=0 );
drh92b01d52008-06-24 00:32:35 +00003530 if( negFlag ) i = -i;
3531 sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
drhfd773cf2009-05-29 14:39:07 +00003532 }else{
shaneh5f1d6b62010-09-30 16:51:25 +00003533 int c;
3534 i64 value;
drhfd773cf2009-05-29 14:39:07 +00003535 const char *z = pExpr->u.zToken;
3536 assert( z!=0 );
drh9296c182014-07-23 13:40:49 +00003537 c = sqlite3DecOrHexToI64(z, &value);
drh84d4f1a2017-09-20 10:47:10 +00003538 if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
drh13573c72010-01-12 17:04:07 +00003539#ifdef SQLITE_OMIT_FLOATING_POINT
3540 sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
3541#else
drh1b7ddc52014-07-23 14:52:05 +00003542#ifndef SQLITE_OMIT_HEX_INTEGER
drh9296c182014-07-23 13:40:49 +00003543 if( sqlite3_strnicmp(z,"0x",2)==0 ){
drh77320ea2016-11-30 14:47:37 +00003544 sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
drh1b7ddc52014-07-23 14:52:05 +00003545 }else
3546#endif
3547 {
drh9296c182014-07-23 13:40:49 +00003548 codeReal(v, z, negFlag, iMem);
3549 }
drh13573c72010-01-12 17:04:07 +00003550#endif
drh77320ea2016-11-30 14:47:37 +00003551 }else{
drh84d4f1a2017-09-20 10:47:10 +00003552 if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
drh77320ea2016-11-30 14:47:37 +00003553 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
danielk1977c9cf9012007-05-30 10:36:47 +00003554 }
drhfec19aa2004-05-19 20:41:03 +00003555 }
3556}
3557
drh5cd79232009-05-25 11:46:29 +00003558
drh1f9ca2c2015-08-25 16:57:52 +00003559/* Generate code that will load into register regOut a value that is
3560** appropriate for the iIdxCol-th column of index pIdx.
3561*/
3562void sqlite3ExprCodeLoadIndexColumn(
3563 Parse *pParse, /* The parsing context */
3564 Index *pIdx, /* The index whose column is to be loaded */
3565 int iTabCur, /* Cursor pointing to a table row */
3566 int iIdxCol, /* The column of the index to be loaded */
3567 int regOut /* Store the index column value in this register */
3568){
3569 i16 iTabCol = pIdx->aiColumn[iIdxCol];
drh4b92f982015-09-29 17:20:14 +00003570 if( iTabCol==XN_EXPR ){
3571 assert( pIdx->aColExpr );
3572 assert( pIdx->aColExpr->nExpr>iIdxCol );
drh3e34eab2017-07-19 19:48:40 +00003573 pParse->iSelfTab = iTabCur + 1;
drh1c75c9d2015-12-21 15:22:13 +00003574 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
drh3e34eab2017-07-19 19:48:40 +00003575 pParse->iSelfTab = 0;
drh4b92f982015-09-29 17:20:14 +00003576 }else{
drh6df9c4b2019-10-18 12:52:08 +00003577 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
drh1f9ca2c2015-08-25 16:57:52 +00003578 iTabCol, regOut);
drh1f9ca2c2015-08-25 16:57:52 +00003579 }
drh1f9ca2c2015-08-25 16:57:52 +00003580}
3581
drhe70fa7f2019-10-22 21:01:34 +00003582#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3583/*
3584** Generate code that will compute the value of generated column pCol
3585** and store the result in register regOut
3586*/
3587void sqlite3ExprCodeGeneratedColumn(
3588 Parse *pParse,
3589 Column *pCol,
3590 int regOut
3591){
drh4dad7ed2019-12-16 16:52:22 +00003592 int iAddr;
3593 Vdbe *v = pParse->pVdbe;
3594 assert( v!=0 );
3595 assert( pParse->iSelfTab!=0 );
3596 if( pParse->iSelfTab>0 ){
3597 iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
3598 }else{
3599 iAddr = 0;
3600 }
drh24e39902020-03-10 13:35:04 +00003601 sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
drhe70fa7f2019-10-22 21:01:34 +00003602 if( pCol->affinity>=SQLITE_AFF_TEXT ){
drh4dad7ed2019-12-16 16:52:22 +00003603 sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
drhe70fa7f2019-10-22 21:01:34 +00003604 }
drh4dad7ed2019-12-16 16:52:22 +00003605 if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
drhe70fa7f2019-10-22 21:01:34 +00003606}
3607#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3608
drh5cd79232009-05-25 11:46:29 +00003609/*
drh5c092e82010-05-14 19:24:02 +00003610** Generate code to extract the value of the iCol-th column of a table.
3611*/
3612void sqlite3ExprCodeGetColumnOfTable(
drh6df9c4b2019-10-18 12:52:08 +00003613 Vdbe *v, /* Parsing context */
drh5c092e82010-05-14 19:24:02 +00003614 Table *pTab, /* The table containing the value */
drh313619f2013-10-31 20:34:06 +00003615 int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
drh5c092e82010-05-14 19:24:02 +00003616 int iCol, /* Index of the column to extract */
drh313619f2013-10-31 20:34:06 +00003617 int regOut /* Extract the value into this register */
drh5c092e82010-05-14 19:24:02 +00003618){
drhab45fc02019-10-16 22:01:56 +00003619 Column *pCol;
drh81f7b372019-10-16 12:18:59 +00003620 assert( v!=0 );
drhaca19e12017-04-07 19:41:31 +00003621 if( pTab==0 ){
3622 sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3623 return;
3624 }
drh5c092e82010-05-14 19:24:02 +00003625 if( iCol<0 || iCol==pTab->iPKey ){
3626 sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3627 }else{
drh81f7b372019-10-16 12:18:59 +00003628 int op;
3629 int x;
3630 if( IsVirtual(pTab) ){
3631 op = OP_VColumn;
3632 x = iCol;
3633#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhab45fc02019-10-16 22:01:56 +00003634 }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
drh6df9c4b2019-10-18 12:52:08 +00003635 Parse *pParse = sqlite3VdbeParser(v);
drhab45fc02019-10-16 22:01:56 +00003636 if( pCol->colFlags & COLFLAG_BUSY ){
3637 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3638 }else{
3639 int savedSelfTab = pParse->iSelfTab;
3640 pCol->colFlags |= COLFLAG_BUSY;
3641 pParse->iSelfTab = iTabCur+1;
drhe70fa7f2019-10-22 21:01:34 +00003642 sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
drhab45fc02019-10-16 22:01:56 +00003643 pParse->iSelfTab = savedSelfTab;
3644 pCol->colFlags &= ~COLFLAG_BUSY;
3645 }
drh81f7b372019-10-16 12:18:59 +00003646 return;
3647#endif
3648 }else if( !HasRowid(pTab) ){
drhc5f808d2019-10-19 15:01:52 +00003649 testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
drhb9bcf7c2019-10-19 13:29:10 +00003650 x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
drh81f7b372019-10-16 12:18:59 +00003651 op = OP_Column;
3652 }else{
drhb9bcf7c2019-10-19 13:29:10 +00003653 x = sqlite3TableColumnToStorage(pTab,iCol);
drhc5f808d2019-10-19 15:01:52 +00003654 testcase( x!=iCol );
drh81f7b372019-10-16 12:18:59 +00003655 op = OP_Column;
drhee0ec8e2013-10-31 17:38:01 +00003656 }
3657 sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
drh5c092e82010-05-14 19:24:02 +00003658 sqlite3ColumnDefault(v, pTab, iCol, regOut);
3659 }
3660}
3661
3662/*
drh945498f2007-02-24 11:52:52 +00003663** Generate code that will extract the iColumn-th column from
drh8c607192018-08-04 15:53:55 +00003664** table pTab and store the column value in register iReg.
drhe55cbd72008-03-31 23:48:03 +00003665**
3666** There must be an open cursor to pTab in iTable when this routine
3667** is called. If iColumn<0 then code is generated that extracts the rowid.
drh945498f2007-02-24 11:52:52 +00003668*/
drhe55cbd72008-03-31 23:48:03 +00003669int sqlite3ExprCodeGetColumn(
3670 Parse *pParse, /* Parsing and code generating context */
drh2133d822008-01-03 18:44:59 +00003671 Table *pTab, /* Description of the table we are reading from */
3672 int iColumn, /* Index of the table column */
3673 int iTable, /* The cursor pointing to the table */
drha748fdc2012-03-28 01:34:47 +00003674 int iReg, /* Store results here */
drhce78bc62015-10-15 19:21:51 +00003675 u8 p5 /* P5 value for OP_Column + FLAGS */
drh2133d822008-01-03 18:44:59 +00003676){
drh81f7b372019-10-16 12:18:59 +00003677 assert( pParse->pVdbe!=0 );
drh6df9c4b2019-10-18 12:52:08 +00003678 sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
drha748fdc2012-03-28 01:34:47 +00003679 if( p5 ){
drh99670ab2019-12-14 17:43:37 +00003680 VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
3681 if( pOp->opcode==OP_Column ) pOp->p5 = p5;
drha748fdc2012-03-28 01:34:47 +00003682 }
drhe55cbd72008-03-31 23:48:03 +00003683 return iReg;
3684}
drhe55cbd72008-03-31 23:48:03 +00003685
3686/*
drhb21e7c72008-06-22 12:37:57 +00003687** Generate code to move content from registers iFrom...iFrom+nReg-1
drh36a5d882018-08-04 17:15:56 +00003688** over to iTo..iTo+nReg-1.
drhe55cbd72008-03-31 23:48:03 +00003689*/
drhb21e7c72008-06-22 12:37:57 +00003690void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
drh079a3072014-03-19 14:10:55 +00003691 sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
drh945498f2007-02-24 11:52:52 +00003692}
3693
drh652fbf52008-04-01 01:42:41 +00003694/*
drh12abf402016-08-22 14:30:05 +00003695** Convert a scalar expression node to a TK_REGISTER referencing
3696** register iReg. The caller must ensure that iReg already contains
3697** the correct value for the expression.
drha4c3c872013-09-12 17:29:25 +00003698*/
dan069d1b12019-06-16 08:58:14 +00003699static void exprToRegister(Expr *pExpr, int iReg){
drh0d950af2019-08-22 16:38:42 +00003700 Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
drh235667a2020-11-08 20:44:30 +00003701 if( NEVER(p==0) ) return;
drha4c3c872013-09-12 17:29:25 +00003702 p->op2 = p->op;
3703 p->op = TK_REGISTER;
3704 p->iTable = iReg;
3705 ExprClearProperty(p, EP_Skip);
3706}
3707
drh12abf402016-08-22 14:30:05 +00003708/*
3709** Evaluate an expression (either a vector or a scalar expression) and store
3710** the result in continguous temporary registers. Return the index of
3711** the first register used to store the result.
3712**
3713** If the returned result register is a temporary scalar, then also write
3714** that register number into *piFreeable. If the returned result register
3715** is not a temporary or if the expression is a vector set *piFreeable
3716** to 0.
3717*/
3718static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
3719 int iResult;
3720 int nResult = sqlite3ExprVectorSize(p);
3721 if( nResult==1 ){
3722 iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
3723 }else{
3724 *piFreeable = 0;
3725 if( p->op==TK_SELECT ){
drhdd1bb432017-05-15 15:12:24 +00003726#if SQLITE_OMIT_SUBQUERY
3727 iResult = 0;
3728#else
drh85bcdce2018-12-23 21:27:29 +00003729 iResult = sqlite3CodeSubselect(pParse, p);
drhdd1bb432017-05-15 15:12:24 +00003730#endif
drh12abf402016-08-22 14:30:05 +00003731 }else{
3732 int i;
3733 iResult = pParse->nMem+1;
3734 pParse->nMem += nResult;
3735 for(i=0; i<nResult; i++){
dan4b725242016-11-23 19:31:18 +00003736 sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
drh12abf402016-08-22 14:30:05 +00003737 }
3738 }
3739 }
3740 return iResult;
3741}
3742
drh25c42962020-01-01 13:55:08 +00003743/*
drh92a27f72020-02-04 01:41:44 +00003744** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
3745** so that a subsequent copy will not be merged into this one.
3746*/
3747static void setDoNotMergeFlagOnCopy(Vdbe *v){
3748 if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
3749 sqlite3VdbeChangeP5(v, 1); /* Tag trailing OP_Copy as not mergable */
3750 }
3751}
3752
3753/*
drh25c42962020-01-01 13:55:08 +00003754** Generate code to implement special SQL functions that are implemented
3755** in-line rather than by using the usual callbacks.
3756*/
3757static int exprCodeInlineFunction(
3758 Parse *pParse, /* Parsing context */
3759 ExprList *pFarg, /* List of function arguments */
3760 int iFuncId, /* Function ID. One of the INTFUNC_... values */
3761 int target /* Store function result in this register */
3762){
3763 int nFarg;
3764 Vdbe *v = pParse->pVdbe;
3765 assert( v!=0 );
3766 assert( pFarg!=0 );
3767 nFarg = pFarg->nExpr;
3768 assert( nFarg>0 ); /* All in-line functions have at least one argument */
3769 switch( iFuncId ){
3770 case INLINEFUNC_coalesce: {
3771 /* Attempt a direct implementation of the built-in COALESCE() and
3772 ** IFNULL() functions. This avoids unnecessary evaluation of
3773 ** arguments past the first non-NULL argument.
3774 */
3775 int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3776 int i;
3777 assert( nFarg>=2 );
3778 sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3779 for(i=1; i<nFarg; i++){
3780 sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3781 VdbeCoverage(v);
3782 sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3783 }
drh92a27f72020-02-04 01:41:44 +00003784 setDoNotMergeFlagOnCopy(v);
drh25c42962020-01-01 13:55:08 +00003785 sqlite3VdbeResolveLabel(v, endCoalesce);
3786 break;
3787 }
drh3c0e6062020-05-13 18:03:34 +00003788 case INLINEFUNC_iif: {
3789 Expr caseExpr;
3790 memset(&caseExpr, 0, sizeof(caseExpr));
3791 caseExpr.op = TK_CASE;
3792 caseExpr.x.pList = pFarg;
3793 return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
3794 }
drh25c42962020-01-01 13:55:08 +00003795
drh171c50e2020-01-01 15:43:30 +00003796 default: {
drh25c42962020-01-01 13:55:08 +00003797 /* The UNLIKELY() function is a no-op. The result is the value
3798 ** of the first argument.
3799 */
drh171c50e2020-01-01 15:43:30 +00003800 assert( nFarg==1 || nFarg==2 );
drh25c42962020-01-01 13:55:08 +00003801 target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3802 break;
3803 }
3804
drh171c50e2020-01-01 15:43:30 +00003805 /***********************************************************************
3806 ** Test-only SQL functions that are only usable if enabled
3807 ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3808 */
3809 case INLINEFUNC_expr_compare: {
3810 /* Compare two expressions using sqlite3ExprCompare() */
3811 assert( nFarg==2 );
3812 sqlite3VdbeAddOp2(v, OP_Integer,
3813 sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3814 target);
3815 break;
3816 }
3817
3818 case INLINEFUNC_expr_implies_expr: {
3819 /* Compare two expressions using sqlite3ExprImpliesExpr() */
3820 assert( nFarg==2 );
3821 sqlite3VdbeAddOp2(v, OP_Integer,
3822 sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3823 target);
3824 break;
3825 }
3826
3827 case INLINEFUNC_implies_nonnull_row: {
3828 /* REsult of sqlite3ExprImpliesNonNullRow() */
3829 Expr *pA1;
3830 assert( nFarg==2 );
3831 pA1 = pFarg->a[1].pExpr;
3832 if( pA1->op==TK_COLUMN ){
3833 sqlite3VdbeAddOp2(v, OP_Integer,
3834 sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3835 target);
3836 }else{
3837 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3838 }
3839 break;
3840 }
3841
drh25c42962020-01-01 13:55:08 +00003842#ifdef SQLITE_DEBUG
3843 case INLINEFUNC_affinity: {
3844 /* The AFFINITY() function evaluates to a string that describes
3845 ** the type affinity of the argument. This is used for testing of
3846 ** the SQLite type logic.
3847 */
3848 const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3849 char aff;
3850 assert( nFarg==1 );
3851 aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3852 sqlite3VdbeLoadString(v, target,
3853 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3854 break;
3855 }
3856#endif
3857 }
3858 return target;
3859}
3860
dan71c57db2016-07-09 20:23:55 +00003861
drha4c3c872013-09-12 17:29:25 +00003862/*
drhcce7d172000-05-31 15:34:51 +00003863** Generate code into the current Vdbe to evaluate the given
drh2dcef112008-01-12 19:03:48 +00003864** expression. Attempt to store the results in register "target".
3865** Return the register where results are stored.
drh389a1ad2008-01-03 23:44:53 +00003866**
drh8b213892008-08-29 02:14:02 +00003867** With this routine, there is no guarantee that results will
drh2dcef112008-01-12 19:03:48 +00003868** be stored in target. The result might be stored in some other
3869** register if it is convenient to do so. The calling function
3870** must check the return code and move the results to the desired
3871** register.
drhcce7d172000-05-31 15:34:51 +00003872*/
drh678ccce2008-03-31 18:19:54 +00003873int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
drh2dcef112008-01-12 19:03:48 +00003874 Vdbe *v = pParse->pVdbe; /* The VM under construction */
3875 int op; /* The opcode being coded */
3876 int inReg = target; /* Results stored in register inReg */
3877 int regFree1 = 0; /* If non-zero free this temporary register */
3878 int regFree2 = 0; /* If non-zero free this temporary register */
dan7b35a772016-07-28 19:47:15 +00003879 int r1, r2; /* Various register numbers */
drh10d1edf2013-11-15 15:52:39 +00003880 Expr tempX; /* Temporary expression node */
dan71c57db2016-07-09 20:23:55 +00003881 int p5 = 0;
drhffe07b22005-11-03 00:41:17 +00003882
drh9cbf3422008-01-17 16:22:13 +00003883 assert( target>0 && target<=pParse->nMem );
drhb639a202020-05-27 12:44:28 +00003884 assert( v!=0 );
drh389a1ad2008-01-03 23:44:53 +00003885
drh1efa8022018-04-28 04:16:43 +00003886expr_code_doover:
drh389a1ad2008-01-03 23:44:53 +00003887 if( pExpr==0 ){
3888 op = TK_NULL;
3889 }else{
drhe7375bf2020-03-10 19:24:38 +00003890 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh389a1ad2008-01-03 23:44:53 +00003891 op = pExpr->op;
3892 }
drhf2bc0132004-10-04 13:19:23 +00003893 switch( op ){
drh13449892005-09-07 21:22:45 +00003894 case TK_AGG_COLUMN: {
3895 AggInfo *pAggInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00003896 struct AggInfo_col *pCol;
3897 assert( pAggInfo!=0 );
3898 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
3899 pCol = &pAggInfo->aCol[pExpr->iAgg];
drh13449892005-09-07 21:22:45 +00003900 if( !pAggInfo->directMode ){
drh9de221d2008-01-05 06:51:30 +00003901 assert( pCol->iMem>0 );
drhc332cc32016-09-19 10:24:19 +00003902 return pCol->iMem;
drh13449892005-09-07 21:22:45 +00003903 }else if( pAggInfo->useSortingIdx ){
drh0c76e892020-03-10 11:50:43 +00003904 Table *pTab = pCol->pTab;
dan5134d132011-09-02 10:31:11 +00003905 sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
drh389a1ad2008-01-03 23:44:53 +00003906 pCol->iSorterColumn, target);
drh8d5cea62020-03-11 02:04:15 +00003907 if( pCol->iColumn<0 ){
3908 VdbeComment((v,"%s.rowid",pTab->zName));
3909 }else{
3910 VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
3911 if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
3912 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3913 }
drh0c76e892020-03-10 11:50:43 +00003914 }
drhc332cc32016-09-19 10:24:19 +00003915 return target;
drh13449892005-09-07 21:22:45 +00003916 }
3917 /* Otherwise, fall thru into the TK_COLUMN case */
drh08b92082020-08-10 14:18:00 +00003918 /* no break */ deliberate_fall_through
drh13449892005-09-07 21:22:45 +00003919 }
drh967e8b72000-06-21 13:59:10 +00003920 case TK_COLUMN: {
drhb2b9d3d2013-08-01 01:14:43 +00003921 int iTab = pExpr->iTable;
drh67b9ba12019-12-20 20:45:02 +00003922 int iReg;
drhefad2e22018-07-27 16:57:11 +00003923 if( ExprHasProperty(pExpr, EP_FixedCol) ){
drhd98f5322018-08-09 18:36:54 +00003924 /* This COLUMN expression is really a constant due to WHERE clause
3925 ** constraints, and that constant is coded by the pExpr->pLeft
3926 ** expresssion. However, make sure the constant has the correct
3927 ** datatype by applying the Affinity of the table column to the
3928 ** constant.
3929 */
drh57f7ece2019-11-21 18:28:44 +00003930 int aff;
drh67b9ba12019-12-20 20:45:02 +00003931 iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
drh57f7ece2019-11-21 18:28:44 +00003932 if( pExpr->y.pTab ){
3933 aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3934 }else{
3935 aff = pExpr->affExpr;
3936 }
drh96fb16e2019-08-06 14:37:24 +00003937 if( aff>SQLITE_AFF_BLOB ){
drhd98f5322018-08-09 18:36:54 +00003938 static const char zAff[] = "B\000C\000D\000E";
3939 assert( SQLITE_AFF_BLOB=='A' );
3940 assert( SQLITE_AFF_TEXT=='B' );
drhd98f5322018-08-09 18:36:54 +00003941 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3942 &zAff[(aff-'B')*2], P4_STATIC);
3943 }
3944 return iReg;
drhefad2e22018-07-27 16:57:11 +00003945 }
drhb2b9d3d2013-08-01 01:14:43 +00003946 if( iTab<0 ){
drh6e97f8e2017-07-20 13:17:08 +00003947 if( pParse->iSelfTab<0 ){
drh9942ef02019-10-18 02:19:18 +00003948 /* Other columns in the same row for CHECK constraints or
3949 ** generated columns or for inserting into partial index.
3950 ** The row is unpacked into registers beginning at
3951 ** 0-(pParse->iSelfTab). The rowid (if any) is in a register
3952 ** immediately prior to the first column.
3953 */
3954 Column *pCol;
3955 Table *pTab = pExpr->y.pTab;
3956 int iSrc;
drhc5f808d2019-10-19 15:01:52 +00003957 int iCol = pExpr->iColumn;
drh9942ef02019-10-18 02:19:18 +00003958 assert( pTab!=0 );
drhc5f808d2019-10-19 15:01:52 +00003959 assert( iCol>=XN_ROWID );
drhb0cbcd02019-12-21 14:09:30 +00003960 assert( iCol<pTab->nCol );
drhc5f808d2019-10-19 15:01:52 +00003961 if( iCol<0 ){
drh9942ef02019-10-18 02:19:18 +00003962 return -1-pParse->iSelfTab;
3963 }
drhc5f808d2019-10-19 15:01:52 +00003964 pCol = pTab->aCol + iCol;
3965 testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3966 iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
drh9942ef02019-10-18 02:19:18 +00003967#ifndef SQLITE_OMIT_GENERATED_COLUMNS
3968 if( pCol->colFlags & COLFLAG_GENERATED ){
drh4e8e5332019-11-07 02:32:54 +00003969 if( pCol->colFlags & COLFLAG_BUSY ){
3970 sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3971 pCol->zName);
3972 return 0;
3973 }
3974 pCol->colFlags |= COLFLAG_BUSY;
3975 if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3976 sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
3977 }
3978 pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
drhdd6cc9b2019-10-19 18:47:27 +00003979 return iSrc;
drh9942ef02019-10-18 02:19:18 +00003980 }else
3981#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3982 if( pCol->affinity==SQLITE_AFF_REAL ){
3983 sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
drhbffdd632019-09-02 00:58:44 +00003984 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3985 return target;
3986 }else{
drh9942ef02019-10-18 02:19:18 +00003987 return iSrc;
drhbffdd632019-09-02 00:58:44 +00003988 }
drhb2b9d3d2013-08-01 01:14:43 +00003989 }else{
drh1f9ca2c2015-08-25 16:57:52 +00003990 /* Coding an expression that is part of an index where column names
3991 ** in the index refer to the table to which the index belongs */
drh3e34eab2017-07-19 19:48:40 +00003992 iTab = pParse->iSelfTab - 1;
drhb2b9d3d2013-08-01 01:14:43 +00003993 }
drh22827922000-06-06 17:27:05 +00003994 }
drh67b9ba12019-12-20 20:45:02 +00003995 iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
drhb2b9d3d2013-08-01 01:14:43 +00003996 pExpr->iColumn, iTab, target,
3997 pExpr->op2);
drh67b9ba12019-12-20 20:45:02 +00003998 if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
3999 sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
4000 }
4001 return iReg;
drhcce7d172000-05-31 15:34:51 +00004002 }
4003 case TK_INTEGER: {
drh13573c72010-01-12 17:04:07 +00004004 codeInteger(pParse, pExpr, 0, target);
drhc332cc32016-09-19 10:24:19 +00004005 return target;
drhfec19aa2004-05-19 20:41:03 +00004006 }
drh8abed7b2018-02-26 18:49:05 +00004007 case TK_TRUEFALSE: {
drh96acafb2018-02-27 14:49:25 +00004008 sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
drh007c8432018-02-26 03:20:18 +00004009 return target;
4010 }
drh13573c72010-01-12 17:04:07 +00004011#ifndef SQLITE_OMIT_FLOATING_POINT
drh598f1342007-10-23 15:39:45 +00004012 case TK_FLOAT: {
drh33e619f2009-05-28 01:00:55 +00004013 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4014 codeReal(v, pExpr->u.zToken, 0, target);
drhc332cc32016-09-19 10:24:19 +00004015 return target;
drh598f1342007-10-23 15:39:45 +00004016 }
drh13573c72010-01-12 17:04:07 +00004017#endif
drhfec19aa2004-05-19 20:41:03 +00004018 case TK_STRING: {
drh33e619f2009-05-28 01:00:55 +00004019 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh076e85f2015-09-03 13:46:12 +00004020 sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
drhc332cc32016-09-19 10:24:19 +00004021 return target;
drhcce7d172000-05-31 15:34:51 +00004022 }
drhaac30f92019-12-14 15:01:55 +00004023 default: {
drhc29af652019-12-18 21:22:40 +00004024 /* Make NULL the default case so that if a bug causes an illegal
4025 ** Expr node to be passed into this function, it will be handled
drh9524a7e2019-12-22 18:06:49 +00004026 ** sanely and not crash. But keep the assert() to bring the problem
4027 ** to the attention of the developers. */
drh05428122021-05-24 00:17:04 +00004028 assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
drh9de221d2008-01-05 06:51:30 +00004029 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drhc332cc32016-09-19 10:24:19 +00004030 return target;
drhf0863fe2005-06-12 21:35:51 +00004031 }
danielk19775338a5f2005-01-20 13:03:10 +00004032#ifndef SQLITE_OMIT_BLOB_LITERAL
danielk1977c572ef72004-05-27 09:28:41 +00004033 case TK_BLOB: {
drh6c8c6ce2005-08-23 11:17:58 +00004034 int n;
4035 const char *z;
drhca48c902008-01-18 14:08:24 +00004036 char *zBlob;
drh33e619f2009-05-28 01:00:55 +00004037 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4038 assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
4039 assert( pExpr->u.zToken[1]=='\'' );
4040 z = &pExpr->u.zToken[2];
drhb7916a72009-05-27 10:31:29 +00004041 n = sqlite3Strlen30(z) - 1;
4042 assert( z[n]=='\'' );
drhca48c902008-01-18 14:08:24 +00004043 zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4044 sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
drhc332cc32016-09-19 10:24:19 +00004045 return target;
danielk1977c572ef72004-05-27 09:28:41 +00004046 }
danielk19775338a5f2005-01-20 13:03:10 +00004047#endif
drh50457892003-09-06 01:10:47 +00004048 case TK_VARIABLE: {
drh33e619f2009-05-28 01:00:55 +00004049 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4050 assert( pExpr->u.zToken!=0 );
4051 assert( pExpr->u.zToken[0]!=0 );
drheaf52d82010-05-12 13:50:23 +00004052 sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
4053 if( pExpr->u.zToken[1]!=0 ){
drh9bf755c2016-12-23 03:59:31 +00004054 const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
drh9524a7e2019-12-22 18:06:49 +00004055 assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
drhce1bbe52016-12-23 13:52:45 +00004056 pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
drhf326d662016-12-23 13:30:53 +00004057 sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
drh895d7472004-08-20 16:02:39 +00004058 }
drhc332cc32016-09-19 10:24:19 +00004059 return target;
drh50457892003-09-06 01:10:47 +00004060 }
drh4e0cff62004-11-05 05:10:28 +00004061 case TK_REGISTER: {
drhc332cc32016-09-19 10:24:19 +00004062 return pExpr->iTable;
drh4e0cff62004-11-05 05:10:28 +00004063 }
drh487e2622005-06-25 18:42:14 +00004064#ifndef SQLITE_OMIT_CAST
4065 case TK_CAST: {
4066 /* Expressions of the form: CAST(pLeft AS token) */
drh2dcef112008-01-12 19:03:48 +00004067 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh1735fa82008-11-06 15:33:03 +00004068 if( inReg!=target ){
4069 sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
4070 inReg = target;
4071 }
drh4169e432014-08-25 20:11:52 +00004072 sqlite3VdbeAddOp2(v, OP_Cast, target,
4073 sqlite3AffinityType(pExpr->u.zToken, 0));
drhc332cc32016-09-19 10:24:19 +00004074 return inReg;
drh487e2622005-06-25 18:42:14 +00004075 }
4076#endif /* SQLITE_OMIT_CAST */
dan71c57db2016-07-09 20:23:55 +00004077 case TK_IS:
4078 case TK_ISNOT:
4079 op = (op==TK_IS) ? TK_EQ : TK_NE;
4080 p5 = SQLITE_NULLEQ;
4081 /* fall-through */
drhc9b84a12002-06-20 11:36:48 +00004082 case TK_LT:
4083 case TK_LE:
4084 case TK_GT:
4085 case TK_GE:
4086 case TK_NE:
4087 case TK_EQ: {
dan71c57db2016-07-09 20:23:55 +00004088 Expr *pLeft = pExpr->pLeft;
dan625015e2016-07-30 16:39:28 +00004089 if( sqlite3ExprIsVector(pLeft) ){
drh79752b62016-08-13 10:02:17 +00004090 codeVectorCompare(pParse, pExpr, target, op, p5);
dan71c57db2016-07-09 20:23:55 +00004091 }else{
4092 r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4093 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh871e7ff2021-03-29 14:40:48 +00004094 sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4095 codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4096 sqlite3VdbeCurrentAddr(v)+2, p5,
drh898c5272019-10-22 00:03:41 +00004097 ExprHasProperty(pExpr,EP_Commuted));
dan71c57db2016-07-09 20:23:55 +00004098 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
4099 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
4100 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
4101 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4102 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
4103 assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
drh529df922021-03-29 19:47:39 +00004104 if( p5==SQLITE_NULLEQ ){
4105 sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4106 }else{
4107 sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4108 }
dan71c57db2016-07-09 20:23:55 +00004109 testcase( regFree1==0 );
4110 testcase( regFree2==0 );
4111 }
drh6a2fe092009-09-23 02:29:36 +00004112 break;
4113 }
drhcce7d172000-05-31 15:34:51 +00004114 case TK_AND:
4115 case TK_OR:
4116 case TK_PLUS:
4117 case TK_STAR:
4118 case TK_MINUS:
drhbf4133c2001-10-13 02:59:08 +00004119 case TK_REM:
4120 case TK_BITAND:
4121 case TK_BITOR:
drh17c40292004-07-21 02:53:29 +00004122 case TK_SLASH:
drhbf4133c2001-10-13 02:59:08 +00004123 case TK_LSHIFT:
drh855eb1c2004-08-31 13:45:11 +00004124 case TK_RSHIFT:
drh00400772000-06-16 20:51:26 +00004125 case TK_CONCAT: {
drh7d176102014-02-18 03:07:12 +00004126 assert( TK_AND==OP_And ); testcase( op==TK_AND );
4127 assert( TK_OR==OP_Or ); testcase( op==TK_OR );
4128 assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
4129 assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
4130 assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
4131 assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
4132 assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
4133 assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
4134 assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
4135 assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
4136 assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
drh2dcef112008-01-12 19:03:48 +00004137 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4138 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh5b6afba2008-01-05 16:29:28 +00004139 sqlite3VdbeAddOp3(v, op, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004140 testcase( regFree1==0 );
4141 testcase( regFree2==0 );
drh00400772000-06-16 20:51:26 +00004142 break;
4143 }
drhcce7d172000-05-31 15:34:51 +00004144 case TK_UMINUS: {
drhfec19aa2004-05-19 20:41:03 +00004145 Expr *pLeft = pExpr->pLeft;
4146 assert( pLeft );
drh13573c72010-01-12 17:04:07 +00004147 if( pLeft->op==TK_INTEGER ){
4148 codeInteger(pParse, pLeft, 1, target);
drhc332cc32016-09-19 10:24:19 +00004149 return target;
drh13573c72010-01-12 17:04:07 +00004150#ifndef SQLITE_OMIT_FLOATING_POINT
4151 }else if( pLeft->op==TK_FLOAT ){
drh33e619f2009-05-28 01:00:55 +00004152 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4153 codeReal(v, pLeft->u.zToken, 1, target);
drhc332cc32016-09-19 10:24:19 +00004154 return target;
drh13573c72010-01-12 17:04:07 +00004155#endif
drh3c84ddf2008-01-09 02:15:38 +00004156 }else{
drh10d1edf2013-11-15 15:52:39 +00004157 tempX.op = TK_INTEGER;
4158 tempX.flags = EP_IntValue|EP_TokenOnly;
4159 tempX.u.iValue = 0;
drhe7375bf2020-03-10 19:24:38 +00004160 ExprClearVVAProperties(&tempX);
drh10d1edf2013-11-15 15:52:39 +00004161 r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
drhe55cbd72008-03-31 23:48:03 +00004162 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
drh2dcef112008-01-12 19:03:48 +00004163 sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
drhc5499be2008-04-01 15:06:33 +00004164 testcase( regFree2==0 );
drh6e142f52000-06-08 13:36:40 +00004165 }
drh3c84ddf2008-01-09 02:15:38 +00004166 break;
drh6e142f52000-06-08 13:36:40 +00004167 }
drhbf4133c2001-10-13 02:59:08 +00004168 case TK_BITNOT:
drh6e142f52000-06-08 13:36:40 +00004169 case TK_NOT: {
drh7d176102014-02-18 03:07:12 +00004170 assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
4171 assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
drhe99fa2a2008-12-15 15:27:51 +00004172 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4173 testcase( regFree1==0 );
drhe99fa2a2008-12-15 15:27:51 +00004174 sqlite3VdbeAddOp2(v, op, r1, inReg);
drhcce7d172000-05-31 15:34:51 +00004175 break;
4176 }
drh8abed7b2018-02-26 18:49:05 +00004177 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004178 int isTrue; /* IS TRUE or IS NOT TRUE */
4179 int bNormal; /* IS TRUE or IS FALSE */
drh007c8432018-02-26 03:20:18 +00004180 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4181 testcase( regFree1==0 );
drh96acafb2018-02-27 14:49:25 +00004182 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
4183 bNormal = pExpr->op2==TK_IS;
4184 testcase( isTrue && bNormal);
4185 testcase( !isTrue && bNormal);
4186 sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
drh007c8432018-02-26 03:20:18 +00004187 break;
4188 }
drhcce7d172000-05-31 15:34:51 +00004189 case TK_ISNULL:
4190 case TK_NOTNULL: {
drh6a288a32008-01-07 19:20:24 +00004191 int addr;
drh7d176102014-02-18 03:07:12 +00004192 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
4193 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh9de221d2008-01-05 06:51:30 +00004194 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
drh2dcef112008-01-12 19:03:48 +00004195 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
drhc5499be2008-04-01 15:06:33 +00004196 testcase( regFree1==0 );
drh2dcef112008-01-12 19:03:48 +00004197 addr = sqlite3VdbeAddOp1(v, op, r1);
drh7d176102014-02-18 03:07:12 +00004198 VdbeCoverageIf(v, op==TK_ISNULL);
4199 VdbeCoverageIf(v, op==TK_NOTNULL);
drha9769792014-08-04 16:39:39 +00004200 sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
drh6a288a32008-01-07 19:20:24 +00004201 sqlite3VdbeJumpHere(v, addr);
drhf2bc0132004-10-04 13:19:23 +00004202 break;
drhcce7d172000-05-31 15:34:51 +00004203 }
drh22827922000-06-06 17:27:05 +00004204 case TK_AGG_FUNCTION: {
drh13449892005-09-07 21:22:45 +00004205 AggInfo *pInfo = pExpr->pAggInfo;
drh0934d642020-05-25 15:19:52 +00004206 if( pInfo==0
4207 || NEVER(pExpr->iAgg<0)
4208 || NEVER(pExpr->iAgg>=pInfo->nFunc)
4209 ){
drh33e619f2009-05-28 01:00:55 +00004210 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4211 sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
drh7e56e712005-11-16 12:53:15 +00004212 }else{
drhc332cc32016-09-19 10:24:19 +00004213 return pInfo->aFunc[pExpr->iAgg].iMem;
drh7e56e712005-11-16 12:53:15 +00004214 }
drh22827922000-06-06 17:27:05 +00004215 break;
4216 }
drhcce7d172000-05-31 15:34:51 +00004217 case TK_FUNCTION: {
drh12ffee82009-04-08 13:51:51 +00004218 ExprList *pFarg; /* List of function arguments */
4219 int nFarg; /* Number of function arguments */
4220 FuncDef *pDef; /* The function definition object */
drh12ffee82009-04-08 13:51:51 +00004221 const char *zId; /* The function name */
drh693e6712014-01-24 22:58:00 +00004222 u32 constMask = 0; /* Mask of function arguments that are constant */
drh12ffee82009-04-08 13:51:51 +00004223 int i; /* Loop counter */
drhc332cc32016-09-19 10:24:19 +00004224 sqlite3 *db = pParse->db; /* The database connection */
drh12ffee82009-04-08 13:51:51 +00004225 u8 enc = ENC(db); /* The text encoding used by this database */
4226 CollSeq *pColl = 0; /* A collating sequence */
drh17435752007-08-16 04:30:38 +00004227
dan67a9b8e2018-06-22 20:51:35 +00004228#ifndef SQLITE_OMIT_WINDOWFUNC
drheda079c2018-09-20 19:02:15 +00004229 if( ExprHasProperty(pExpr, EP_WinFunc) ){
4230 return pExpr->y.pWin->regResult;
dan86fb6e12018-05-16 20:58:07 +00004231 }
dan67a9b8e2018-06-22 20:51:35 +00004232#endif
dan86fb6e12018-05-16 20:58:07 +00004233
drh1e9b53f2017-01-04 01:07:24 +00004234 if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004235 /* SQL functions can be expensive. So try to avoid running them
4236 ** multiple times if we know they always give the same result */
4237 return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh1e9b53f2017-01-04 01:07:24 +00004238 }
danielk19776ab3a2e2009-02-19 14:39:25 +00004239 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drhe7375bf2020-03-10 19:24:38 +00004240 assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4241 pFarg = pExpr->x.pList;
drh12ffee82009-04-08 13:51:51 +00004242 nFarg = pFarg ? pFarg->nExpr : 0;
drh33e619f2009-05-28 01:00:55 +00004243 assert( !ExprHasProperty(pExpr, EP_IntValue) );
4244 zId = pExpr->u.zToken;
drh80738d92016-02-15 00:34:16 +00004245 pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
drhcc153132016-08-04 12:35:17 +00004246#ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4247 if( pDef==0 && pParse->explain ){
4248 pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4249 }
4250#endif
danb6e9f7a2018-05-19 14:15:29 +00004251 if( pDef==0 || pDef->xFinalize!=0 ){
drh80738d92016-02-15 00:34:16 +00004252 sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
drhfeb306f2009-08-18 16:05:46 +00004253 break;
4254 }
drh25c42962020-01-01 13:55:08 +00004255 if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
drh0dfa5252020-01-08 17:28:19 +00004256 assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
4257 assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
drh25c42962020-01-01 13:55:08 +00004258 return exprCodeInlineFunction(pParse, pFarg,
4259 SQLITE_PTR_TO_INT(pDef->pUserData), target);
drh2eeca202020-01-08 20:37:45 +00004260 }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
4261 sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
drhae6bb952009-11-11 00:24:31 +00004262 }
4263
drhd1a01ed2013-11-21 16:08:52 +00004264 for(i=0; i<nFarg; i++){
4265 if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
drh693e6712014-01-24 22:58:00 +00004266 testcase( i==31 );
4267 constMask |= MASKBIT32(i);
drhd1a01ed2013-11-21 16:08:52 +00004268 }
4269 if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4270 pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4271 }
4272 }
drh12ffee82009-04-08 13:51:51 +00004273 if( pFarg ){
drhd1a01ed2013-11-21 16:08:52 +00004274 if( constMask ){
4275 r1 = pParse->nMem+1;
4276 pParse->nMem += nFarg;
4277 }else{
4278 r1 = sqlite3GetTempRange(pParse, nFarg);
4279 }
drha748fdc2012-03-28 01:34:47 +00004280
4281 /* For length() and typeof() functions with a column argument,
4282 ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4283 ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4284 ** loading.
4285 */
drhd36e1042013-09-06 13:10:12 +00004286 if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
drh4e245a42012-03-30 00:00:36 +00004287 u8 exprOp;
drha748fdc2012-03-28 01:34:47 +00004288 assert( nFarg==1 );
4289 assert( pFarg->a[0].pExpr!=0 );
drh4e245a42012-03-30 00:00:36 +00004290 exprOp = pFarg->a[0].pExpr->op;
4291 if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
drha748fdc2012-03-28 01:34:47 +00004292 assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4293 assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
drhb1fba282013-11-21 14:33:48 +00004294 testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4295 pFarg->a[0].pExpr->op2 =
4296 pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
drha748fdc2012-03-28 01:34:47 +00004297 }
4298 }
4299
drh5579d592015-08-26 14:01:41 +00004300 sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
drhd1a01ed2013-11-21 16:08:52 +00004301 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
drh892d3172008-01-10 03:46:36 +00004302 }else{
drh12ffee82009-04-08 13:51:51 +00004303 r1 = 0;
drh892d3172008-01-10 03:46:36 +00004304 }
drhb7f6f682006-07-08 17:06:43 +00004305#ifndef SQLITE_OMIT_VIRTUALTABLE
drha43fa222006-07-08 18:41:37 +00004306 /* Possibly overload the function if the first argument is
4307 ** a virtual table column.
4308 **
4309 ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4310 ** second argument, not the first, as the argument to test to
4311 ** see if it is a column in a virtual table. This is done because
4312 ** the left operand of infix functions (the operand we want to
4313 ** control overloading) ends up as the second argument to the
4314 ** function. The expression "A glob B" is equivalent to
4315 ** "glob(B,A). We want to use the A in "A glob B" to test
4316 ** for function overloading. But we use the B term in "glob(B,A)".
4317 */
drh59155062018-05-26 18:03:48 +00004318 if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
drh12ffee82009-04-08 13:51:51 +00004319 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
4320 }else if( nFarg>0 ){
4321 pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
drhb7f6f682006-07-08 17:06:43 +00004322 }
4323#endif
drhd36e1042013-09-06 13:10:12 +00004324 if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh8b213892008-08-29 02:14:02 +00004325 if( !pColl ) pColl = db->pDfltColl;
drh66a51672008-01-03 00:01:23 +00004326 sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
danielk1977682f68b2004-06-05 10:22:17 +00004327 }
drh092457b2017-12-29 15:04:49 +00004328#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4329 if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
drh2fc865c2017-12-16 20:20:37 +00004330 Expr *pArg = pFarg->a[0].pExpr;
4331 if( pArg->op==TK_COLUMN ){
drh092457b2017-12-29 15:04:49 +00004332 sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
drh2fc865c2017-12-16 20:20:37 +00004333 }else{
4334 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4335 }
drh092457b2017-12-29 15:04:49 +00004336 }else
4337#endif
4338 {
drh920cf592019-10-30 16:29:02 +00004339 sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
drh20cee7d2019-10-30 18:50:08 +00004340 pDef, pExpr->op2);
drh2fc865c2017-12-16 20:20:37 +00004341 }
drh13d79502019-12-23 02:18:49 +00004342 if( nFarg ){
4343 if( constMask==0 ){
4344 sqlite3ReleaseTempRange(pParse, r1, nFarg);
4345 }else{
drh3aef2fb2020-01-02 17:46:02 +00004346 sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
drh13d79502019-12-23 02:18:49 +00004347 }
drh2dcef112008-01-12 19:03:48 +00004348 }
drhc332cc32016-09-19 10:24:19 +00004349 return target;
drhcce7d172000-05-31 15:34:51 +00004350 }
drhfe2093d2005-01-20 22:48:47 +00004351#ifndef SQLITE_OMIT_SUBQUERY
4352 case TK_EXISTS:
drh19a775c2000-06-05 18:54:46 +00004353 case TK_SELECT: {
dan8da209b2016-07-26 18:06:08 +00004354 int nCol;
drhc5499be2008-04-01 15:06:33 +00004355 testcase( op==TK_EXISTS );
4356 testcase( op==TK_SELECT );
drhd8d335d2020-06-26 04:34:28 +00004357 if( pParse->db->mallocFailed ){
4358 return 0;
4359 }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
dan8da209b2016-07-26 18:06:08 +00004360 sqlite3SubselectError(pParse, nCol, 1);
4361 }else{
drh85bcdce2018-12-23 21:27:29 +00004362 return sqlite3CodeSubselect(pParse, pExpr);
dan8da209b2016-07-26 18:06:08 +00004363 }
drh19a775c2000-06-05 18:54:46 +00004364 break;
4365 }
drhfc7f27b2016-08-20 00:07:01 +00004366 case TK_SELECT_COLUMN: {
drh966e2912017-01-03 02:58:01 +00004367 int n;
drhfc7f27b2016-08-20 00:07:01 +00004368 if( pExpr->pLeft->iTable==0 ){
drh85bcdce2018-12-23 21:27:29 +00004369 pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
drhfc7f27b2016-08-20 00:07:01 +00004370 }
drh05428122021-05-24 00:17:04 +00004371 assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT
4372 || pExpr->pLeft->op==TK_ERROR );
drh554a9dc2019-08-26 14:18:28 +00004373 if( pExpr->iTable!=0
4374 && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
drh966e2912017-01-03 02:58:01 +00004375 ){
4376 sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4377 pExpr->iTable, n);
4378 }
drhc332cc32016-09-19 10:24:19 +00004379 return pExpr->pLeft->iTable + pExpr->iColumn;
drhfc7f27b2016-08-20 00:07:01 +00004380 }
drhfef52082000-06-06 01:50:43 +00004381 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00004382 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4383 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00004384 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4385 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4386 sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4387 sqlite3VdbeResolveLabel(v, destIfFalse);
4388 sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4389 sqlite3VdbeResolveLabel(v, destIfNull);
drhc332cc32016-09-19 10:24:19 +00004390 return target;
drhfef52082000-06-06 01:50:43 +00004391 }
drhe3365e62009-11-12 17:52:24 +00004392#endif /* SQLITE_OMIT_SUBQUERY */
4393
4394
drh2dcef112008-01-12 19:03:48 +00004395 /*
4396 ** x BETWEEN y AND z
4397 **
4398 ** This is equivalent to
4399 **
4400 ** x>=y AND x<=z
4401 **
4402 ** X is stored in pExpr->pLeft.
4403 ** Y is stored in pExpr->pList->a[0].pExpr.
4404 ** Z is stored in pExpr->pList->a[1].pExpr.
4405 */
drhfef52082000-06-06 01:50:43 +00004406 case TK_BETWEEN: {
dan71c57db2016-07-09 20:23:55 +00004407 exprCodeBetween(pParse, pExpr, target, 0, 0);
drhc332cc32016-09-19 10:24:19 +00004408 return target;
drhfef52082000-06-06 01:50:43 +00004409 }
drh94fa9c42016-02-27 21:16:04 +00004410 case TK_SPAN:
drhae80dde2012-12-06 21:16:43 +00004411 case TK_COLLATE:
drh4f07e5f2007-05-14 11:34:46 +00004412 case TK_UPLUS: {
drh1efa8022018-04-28 04:16:43 +00004413 pExpr = pExpr->pLeft;
drh59ee43a2018-05-29 15:18:31 +00004414 goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
drha2e00042002-01-22 03:13:42 +00004415 }
drh2dcef112008-01-12 19:03:48 +00004416
dan165921a2009-08-28 18:53:45 +00004417 case TK_TRIGGER: {
dan65a7cd12009-09-01 12:16:01 +00004418 /* If the opcode is TK_TRIGGER, then the expression is a reference
4419 ** to a column in the new.* or old.* pseudo-tables available to
4420 ** trigger programs. In this case Expr.iTable is set to 1 for the
4421 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
4422 ** is set to the column of the pseudo-table to read, or to -1 to
4423 ** read the rowid field.
4424 **
4425 ** The expression is implemented using an OP_Param opcode. The p1
4426 ** parameter is set to 0 for an old.rowid reference, or to (i+1)
4427 ** to reference another column of the old.* pseudo-table, where
4428 ** i is the index of the column. For a new.rowid reference, p1 is
4429 ** set to (n+1), where n is the number of columns in each pseudo-table.
4430 ** For a reference to any other column in the new.* pseudo-table, p1
4431 ** is set to (n+2+i), where n and i are as defined previously. For
4432 ** example, if the table on which triggers are being fired is
4433 ** declared as:
4434 **
4435 ** CREATE TABLE t1(a, b);
4436 **
4437 ** Then p1 is interpreted as follows:
4438 **
4439 ** p1==0 -> old.rowid p1==3 -> new.rowid
4440 ** p1==1 -> old.a p1==4 -> new.a
4441 ** p1==2 -> old.b p1==5 -> new.b
4442 */
drheda079c2018-09-20 19:02:15 +00004443 Table *pTab = pExpr->y.pTab;
drhdd6cc9b2019-10-19 18:47:27 +00004444 int iCol = pExpr->iColumn;
4445 int p1 = pExpr->iTable * (pTab->nCol+1) + 1
drh7fe2fc02019-12-07 00:22:18 +00004446 + sqlite3TableColumnToStorage(pTab, iCol);
dan65a7cd12009-09-01 12:16:01 +00004447
4448 assert( pExpr->iTable==0 || pExpr->iTable==1 );
drhdd6cc9b2019-10-19 18:47:27 +00004449 assert( iCol>=-1 && iCol<pTab->nCol );
4450 assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
dan65a7cd12009-09-01 12:16:01 +00004451 assert( p1>=0 && p1<(pTab->nCol*2+2) );
4452
4453 sqlite3VdbeAddOp2(v, OP_Param, p1, target);
drh896494e2018-04-26 12:27:03 +00004454 VdbeComment((v, "r[%d]=%s.%s", target,
dan2bd93512009-08-31 08:22:46 +00004455 (pExpr->iTable ? "new" : "old"),
drhdd6cc9b2019-10-19 18:47:27 +00004456 (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
dan165921a2009-08-28 18:53:45 +00004457 ));
dan65a7cd12009-09-01 12:16:01 +00004458
drh44dbca82010-01-13 04:22:20 +00004459#ifndef SQLITE_OMIT_FLOATING_POINT
dan65a7cd12009-09-01 12:16:01 +00004460 /* If the column has REAL affinity, it may currently be stored as an
drh113762a2014-11-19 16:36:25 +00004461 ** integer. Use OP_RealAffinity to make sure it is really real.
4462 **
4463 ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4464 ** floating point when extracting it from the record. */
drhdd6cc9b2019-10-19 18:47:27 +00004465 if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
dan2832ad42009-08-31 15:27:27 +00004466 sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4467 }
drh44dbca82010-01-13 04:22:20 +00004468#endif
dan165921a2009-08-28 18:53:45 +00004469 break;
4470 }
4471
dan71c57db2016-07-09 20:23:55 +00004472 case TK_VECTOR: {
drhe835bc12016-08-23 19:02:55 +00004473 sqlite3ErrorMsg(pParse, "row value misused");
dan71c57db2016-07-09 20:23:55 +00004474 break;
4475 }
4476
drh9e9a67a2019-08-17 17:07:15 +00004477 /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
4478 ** that derive from the right-hand table of a LEFT JOIN. The
4479 ** Expr.iTable value is the table number for the right-hand table.
4480 ** The expression is only evaluated if that table is not currently
4481 ** on a LEFT JOIN NULL row.
4482 */
drh31d6fd52017-04-14 19:03:10 +00004483 case TK_IF_NULL_ROW: {
4484 int addrINR;
drh9e9a67a2019-08-17 17:07:15 +00004485 u8 okConstFactor = pParse->okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004486 addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
drh9e9a67a2019-08-17 17:07:15 +00004487 /* Temporarily disable factoring of constant expressions, since
4488 ** even though expressions may appear to be constant, they are not
4489 ** really constant because they originate from the right-hand side
4490 ** of a LEFT JOIN. */
4491 pParse->okConstFactor = 0;
drh31d6fd52017-04-14 19:03:10 +00004492 inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
drh9e9a67a2019-08-17 17:07:15 +00004493 pParse->okConstFactor = okConstFactor;
drh31d6fd52017-04-14 19:03:10 +00004494 sqlite3VdbeJumpHere(v, addrINR);
4495 sqlite3VdbeChangeP3(v, addrINR, inReg);
4496 break;
4497 }
4498
drh2dcef112008-01-12 19:03:48 +00004499 /*
4500 ** Form A:
4501 ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4502 **
4503 ** Form B:
4504 ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
4505 **
4506 ** Form A is can be transformed into the equivalent form B as follows:
4507 ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
4508 ** WHEN x=eN THEN rN ELSE y END
4509 **
4510 ** X (if it exists) is in pExpr->pLeft.
drhc5cd1242013-09-12 16:50:49 +00004511 ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4512 ** odd. The Y is also optional. If the number of elements in x.pList
4513 ** is even, then Y is omitted and the "otherwise" result is NULL.
drh2dcef112008-01-12 19:03:48 +00004514 ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
4515 **
4516 ** The result of the expression is the Ri for the first matching Ei,
4517 ** or if there is no matching Ei, the ELSE term Y, or if there is
4518 ** no ELSE term, NULL.
4519 */
drhaac30f92019-12-14 15:01:55 +00004520 case TK_CASE: {
drh2dcef112008-01-12 19:03:48 +00004521 int endLabel; /* GOTO label for end of CASE stmt */
4522 int nextCase; /* GOTO label for next WHEN clause */
4523 int nExpr; /* 2x number of WHEN terms */
4524 int i; /* Loop counter */
4525 ExprList *pEList; /* List of WHEN terms */
4526 struct ExprList_item *aListelem; /* Array of WHEN terms */
4527 Expr opCompare; /* The X==Ei expression */
drh2dcef112008-01-12 19:03:48 +00004528 Expr *pX; /* The X expression */
drh1bd10f82008-12-10 21:19:56 +00004529 Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
dan8b65e592019-07-17 14:34:17 +00004530 Expr *pDel = 0;
4531 sqlite3 *db = pParse->db;
drh17a7f8d2002-03-24 13:13:27 +00004532
danielk19776ab3a2e2009-02-19 14:39:25 +00004533 assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
danielk19776ab3a2e2009-02-19 14:39:25 +00004534 assert(pExpr->x.pList->nExpr > 0);
4535 pEList = pExpr->x.pList;
drhbe5c89a2004-07-26 00:31:09 +00004536 aListelem = pEList->a;
4537 nExpr = pEList->nExpr;
drhec4ccdb2018-12-29 02:26:59 +00004538 endLabel = sqlite3VdbeMakeLabel(pParse);
drh2dcef112008-01-12 19:03:48 +00004539 if( (pX = pExpr->pLeft)!=0 ){
dan8b65e592019-07-17 14:34:17 +00004540 pDel = sqlite3ExprDup(db, pX, 0);
4541 if( db->mallocFailed ){
4542 sqlite3ExprDelete(db, pDel);
4543 break;
4544 }
drh33cd4902009-05-30 20:49:20 +00004545 testcase( pX->op==TK_COLUMN );
dan8b65e592019-07-17 14:34:17 +00004546 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
drhc5499be2008-04-01 15:06:33 +00004547 testcase( regFree1==0 );
drhabb9d5f2016-08-23 17:30:55 +00004548 memset(&opCompare, 0, sizeof(opCompare));
drh2dcef112008-01-12 19:03:48 +00004549 opCompare.op = TK_EQ;
dan8b65e592019-07-17 14:34:17 +00004550 opCompare.pLeft = pDel;
drh2dcef112008-01-12 19:03:48 +00004551 pTest = &opCompare;
drh8b1db072010-09-28 04:14:03 +00004552 /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
4553 ** The value in regFree1 might get SCopy-ed into the file result.
4554 ** So make sure that the regFree1 register is not reused for other
4555 ** purposes and possibly overwritten. */
4556 regFree1 = 0;
drh17a7f8d2002-03-24 13:13:27 +00004557 }
drhc5cd1242013-09-12 16:50:49 +00004558 for(i=0; i<nExpr-1; i=i+2){
drh2dcef112008-01-12 19:03:48 +00004559 if( pX ){
drh1bd10f82008-12-10 21:19:56 +00004560 assert( pTest!=0 );
drh2dcef112008-01-12 19:03:48 +00004561 opCompare.pRight = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004562 }else{
drh2dcef112008-01-12 19:03:48 +00004563 pTest = aListelem[i].pExpr;
drh17a7f8d2002-03-24 13:13:27 +00004564 }
drhec4ccdb2018-12-29 02:26:59 +00004565 nextCase = sqlite3VdbeMakeLabel(pParse);
drh33cd4902009-05-30 20:49:20 +00004566 testcase( pTest->op==TK_COLUMN );
drh2dcef112008-01-12 19:03:48 +00004567 sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
drhc5499be2008-04-01 15:06:33 +00004568 testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
drh9de221d2008-01-05 06:51:30 +00004569 sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
drh076e85f2015-09-03 13:46:12 +00004570 sqlite3VdbeGoto(v, endLabel);
drh2dcef112008-01-12 19:03:48 +00004571 sqlite3VdbeResolveLabel(v, nextCase);
drhf570f012002-05-31 15:51:25 +00004572 }
drhc5cd1242013-09-12 16:50:49 +00004573 if( (nExpr&1)!=0 ){
drhc5cd1242013-09-12 16:50:49 +00004574 sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
drh17a7f8d2002-03-24 13:13:27 +00004575 }else{
drh9de221d2008-01-05 06:51:30 +00004576 sqlite3VdbeAddOp2(v, OP_Null, 0, target);
drh17a7f8d2002-03-24 13:13:27 +00004577 }
dan8b65e592019-07-17 14:34:17 +00004578 sqlite3ExprDelete(db, pDel);
drh92a27f72020-02-04 01:41:44 +00004579 setDoNotMergeFlagOnCopy(v);
drh2dcef112008-01-12 19:03:48 +00004580 sqlite3VdbeResolveLabel(v, endLabel);
danielk19776f349032002-06-11 02:25:40 +00004581 break;
4582 }
danielk19775338a5f2005-01-20 13:03:10 +00004583#ifndef SQLITE_OMIT_TRIGGER
danielk19776f349032002-06-11 02:25:40 +00004584 case TK_RAISE: {
drh11949042019-08-05 18:01:42 +00004585 assert( pExpr->affExpr==OE_Rollback
4586 || pExpr->affExpr==OE_Abort
4587 || pExpr->affExpr==OE_Fail
4588 || pExpr->affExpr==OE_Ignore
dan165921a2009-08-28 18:53:45 +00004589 );
drh9e5fdc42020-05-08 19:02:21 +00004590 if( !pParse->pTriggerTab && !pParse->nested ){
dane0af83a2009-09-08 19:15:01 +00004591 sqlite3ErrorMsg(pParse,
4592 "RAISE() may only be used within a trigger-program");
4593 return 0;
4594 }
drh11949042019-08-05 18:01:42 +00004595 if( pExpr->affExpr==OE_Abort ){
dane0af83a2009-09-08 19:15:01 +00004596 sqlite3MayAbort(pParse);
4597 }
dan165921a2009-08-28 18:53:45 +00004598 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh11949042019-08-05 18:01:42 +00004599 if( pExpr->affExpr==OE_Ignore ){
dane0af83a2009-09-08 19:15:01 +00004600 sqlite3VdbeAddOp4(
4601 v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
drh688852a2014-02-17 22:40:43 +00004602 VdbeCoverage(v);
dane0af83a2009-09-08 19:15:01 +00004603 }else{
drh9e5fdc42020-05-08 19:02:21 +00004604 sqlite3HaltConstraint(pParse,
4605 pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
4606 pExpr->affExpr, pExpr->u.zToken, 0, 0);
dane0af83a2009-09-08 19:15:01 +00004607 }
4608
drhffe07b22005-11-03 00:41:17 +00004609 break;
drh17a7f8d2002-03-24 13:13:27 +00004610 }
danielk19775338a5f2005-01-20 13:03:10 +00004611#endif
drhffe07b22005-11-03 00:41:17 +00004612 }
drh2dcef112008-01-12 19:03:48 +00004613 sqlite3ReleaseTempReg(pParse, regFree1);
4614 sqlite3ReleaseTempReg(pParse, regFree2);
4615 return inReg;
4616}
4617
4618/*
drh9b258c52020-03-11 19:41:49 +00004619** Generate code that will evaluate expression pExpr just one time
4620** per prepared statement execution.
4621**
4622** If the expression uses functions (that might throw an exception) then
4623** guard them with an OP_Once opcode to ensure that the code is only executed
4624** once. If no functions are involved, then factor the code out and put it at
4625** the end of the prepared statement in the initialization section.
drh1e9b53f2017-01-04 01:07:24 +00004626**
drhad879ff2017-01-04 04:10:02 +00004627** If regDest>=0 then the result is always stored in that register and the
4628** result is not reusable. If regDest<0 then this routine is free to
4629** store the value whereever it wants. The register where the expression
drh9b258c52020-03-11 19:41:49 +00004630** is stored is returned. When regDest<0, two identical expressions might
4631** code to the same register, if they do not contain function calls and hence
4632** are factored out into the initialization section at the end of the
4633** prepared statement.
drhd1a01ed2013-11-21 16:08:52 +00004634*/
drh9b258c52020-03-11 19:41:49 +00004635int sqlite3ExprCodeRunJustOnce(
drhd673cdd2013-11-21 21:23:31 +00004636 Parse *pParse, /* Parsing context */
4637 Expr *pExpr, /* The expression to code when the VDBE initializes */
drhad879ff2017-01-04 04:10:02 +00004638 int regDest /* Store the value in this register */
drhd673cdd2013-11-21 21:23:31 +00004639){
drhd1a01ed2013-11-21 16:08:52 +00004640 ExprList *p;
drhd9f158e2013-11-21 20:48:42 +00004641 assert( ConstFactorOk(pParse) );
drhd1a01ed2013-11-21 16:08:52 +00004642 p = pParse->pConstExpr;
drhad879ff2017-01-04 04:10:02 +00004643 if( regDest<0 && p ){
4644 struct ExprList_item *pItem;
4645 int i;
4646 for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
dan5aa550c2017-06-24 18:10:29 +00004647 if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
drhad879ff2017-01-04 04:10:02 +00004648 return pItem->u.iConstExprReg;
drh1e9b53f2017-01-04 01:07:24 +00004649 }
4650 }
drh1e9b53f2017-01-04 01:07:24 +00004651 }
drhd1a01ed2013-11-21 16:08:52 +00004652 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
drh38dfbda2020-03-11 17:58:27 +00004653 if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
4654 Vdbe *v = pParse->pVdbe;
4655 int addr;
4656 assert( v );
4657 addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
4658 pParse->okConstFactor = 0;
4659 if( !pParse->db->mallocFailed ){
drh9b258c52020-03-11 19:41:49 +00004660 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004661 sqlite3ExprCode(pParse, pExpr, regDest);
4662 }
4663 pParse->okConstFactor = 1;
4664 sqlite3ExprDelete(pParse->db, pExpr);
4665 sqlite3VdbeJumpHere(v, addr);
4666 }else{
4667 p = sqlite3ExprListAppend(pParse, p, pExpr);
4668 if( p ){
4669 struct ExprList_item *pItem = &p->a[p->nExpr-1];
4670 pItem->reusable = regDest<0;
drh9b258c52020-03-11 19:41:49 +00004671 if( regDest<0 ) regDest = ++pParse->nMem;
drh38dfbda2020-03-11 17:58:27 +00004672 pItem->u.iConstExprReg = regDest;
4673 }
4674 pParse->pConstExpr = p;
drhd673cdd2013-11-21 21:23:31 +00004675 }
drh1e9b53f2017-01-04 01:07:24 +00004676 return regDest;
drhd1a01ed2013-11-21 16:08:52 +00004677}
4678
4679/*
drh2dcef112008-01-12 19:03:48 +00004680** Generate code to evaluate an expression and store the results
4681** into a register. Return the register number where the results
4682** are stored.
4683**
4684** If the register is a temporary register that can be deallocated,
drh678ccce2008-03-31 18:19:54 +00004685** then write its number into *pReg. If the result register is not
drh2dcef112008-01-12 19:03:48 +00004686** a temporary, then set *pReg to zero.
drhf30a9692013-11-15 01:10:18 +00004687**
4688** If pExpr is a constant, then this routine might generate this
4689** code to fill the register in the initialization section of the
4690** VDBE program, in order to factor it out of the evaluation loop.
drh2dcef112008-01-12 19:03:48 +00004691*/
4692int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
drhf30a9692013-11-15 01:10:18 +00004693 int r2;
drh0d950af2019-08-22 16:38:42 +00004694 pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
drhd9f158e2013-11-21 20:48:42 +00004695 if( ConstFactorOk(pParse)
drh235667a2020-11-08 20:44:30 +00004696 && ALWAYS(pExpr!=0)
drhf30a9692013-11-15 01:10:18 +00004697 && pExpr->op!=TK_REGISTER
4698 && sqlite3ExprIsConstantNotJoin(pExpr)
4699 ){
drhf30a9692013-11-15 01:10:18 +00004700 *pReg = 0;
drh9b258c52020-03-11 19:41:49 +00004701 r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
drh2dcef112008-01-12 19:03:48 +00004702 }else{
drhf30a9692013-11-15 01:10:18 +00004703 int r1 = sqlite3GetTempReg(pParse);
4704 r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
4705 if( r2==r1 ){
4706 *pReg = r1;
4707 }else{
4708 sqlite3ReleaseTempReg(pParse, r1);
4709 *pReg = 0;
4710 }
drh2dcef112008-01-12 19:03:48 +00004711 }
4712 return r2;
4713}
4714
4715/*
4716** Generate code that will evaluate expression pExpr and store the
4717** results in register target. The results are guaranteed to appear
4718** in register target.
4719*/
drh05a86c52014-02-16 01:55:49 +00004720void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
drh9cbf3422008-01-17 16:22:13 +00004721 int inReg;
4722
drhe7375bf2020-03-10 19:24:38 +00004723 assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
drh9cbf3422008-01-17 16:22:13 +00004724 assert( target>0 && target<=pParse->nMem );
drhf5f19152019-10-21 01:04:11 +00004725 assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
drhb639a202020-05-27 12:44:28 +00004726 if( pParse->pVdbe==0 ) return;
4727 inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4728 if( inReg!=target ){
drh629b88c2020-01-02 02:50:45 +00004729 u8 op;
4730 if( ExprHasProperty(pExpr,EP_Subquery) ){
4731 op = OP_Copy;
4732 }else{
4733 op = OP_SCopy;
4734 }
4735 sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
drhcce7d172000-05-31 15:34:51 +00004736 }
drhcce7d172000-05-31 15:34:51 +00004737}
4738
4739/*
drh1c75c9d2015-12-21 15:22:13 +00004740** Make a transient copy of expression pExpr and then code it using
4741** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
4742** except that the input expression is guaranteed to be unchanged.
4743*/
4744void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
4745 sqlite3 *db = pParse->db;
4746 pExpr = sqlite3ExprDup(db, pExpr, 0);
4747 if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
4748 sqlite3ExprDelete(db, pExpr);
4749}
4750
4751/*
drh05a86c52014-02-16 01:55:49 +00004752** Generate code that will evaluate expression pExpr and store the
4753** results in register target. The results are guaranteed to appear
4754** in register target. If the expression is constant, then this routine
4755** might choose to code the expression at initialization time.
4756*/
4757void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
drhb8b06692018-08-04 15:16:20 +00004758 if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
drh9b258c52020-03-11 19:41:49 +00004759 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004760 }else{
drh088489e2020-03-10 02:57:37 +00004761 sqlite3ExprCodeCopy(pParse, pExpr, target);
drh05a86c52014-02-16 01:55:49 +00004762 }
drhcce7d172000-05-31 15:34:51 +00004763}
4764
4765/*
drh268380c2004-02-25 13:47:31 +00004766** Generate code that pushes the value of every element of the given
drh9cbf3422008-01-17 16:22:13 +00004767** expression list into a sequence of registers beginning at target.
drh268380c2004-02-25 13:47:31 +00004768**
drh3df6c3b2017-09-15 15:38:01 +00004769** Return the number of elements evaluated. The number returned will
4770** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
4771** is defined.
drhd1a01ed2013-11-21 16:08:52 +00004772**
4773** The SQLITE_ECEL_DUP flag prevents the arguments from being
4774** filled using OP_SCopy. OP_Copy must be used instead.
4775**
4776** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4777** factored out into initialization code.
drhb0df9632015-10-16 23:55:08 +00004778**
4779** The SQLITE_ECEL_REF flag means that expressions in the list with
4780** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4781** in registers at srcReg, and so the value can be copied from there.
drh3df6c3b2017-09-15 15:38:01 +00004782** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
4783** are simply omitted rather than being copied from srcReg.
drh268380c2004-02-25 13:47:31 +00004784*/
danielk19774adee202004-05-08 08:23:19 +00004785int sqlite3ExprCodeExprList(
drh268380c2004-02-25 13:47:31 +00004786 Parse *pParse, /* Parsing context */
drh389a1ad2008-01-03 23:44:53 +00004787 ExprList *pList, /* The expression list to be coded */
drh191b54c2008-04-15 12:14:21 +00004788 int target, /* Where to write results */
drh5579d592015-08-26 14:01:41 +00004789 int srcReg, /* Source registers if SQLITE_ECEL_REF */
drhd1a01ed2013-11-21 16:08:52 +00004790 u8 flags /* SQLITE_ECEL_* flags */
drh268380c2004-02-25 13:47:31 +00004791){
4792 struct ExprList_item *pItem;
drh5579d592015-08-26 14:01:41 +00004793 int i, j, n;
drhd1a01ed2013-11-21 16:08:52 +00004794 u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
drh5579d592015-08-26 14:01:41 +00004795 Vdbe *v = pParse->pVdbe;
drh9d8b3072008-08-22 16:29:51 +00004796 assert( pList!=0 );
drh9cbf3422008-01-17 16:22:13 +00004797 assert( target>0 );
drhd81a1422010-09-28 07:11:24 +00004798 assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
drh268380c2004-02-25 13:47:31 +00004799 n = pList->nExpr;
drhd9f158e2013-11-21 20:48:42 +00004800 if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
drh191b54c2008-04-15 12:14:21 +00004801 for(pItem=pList->a, i=0; i<n; i++, pItem++){
drh7445ffe2010-09-27 18:14:12 +00004802 Expr *pExpr = pItem->pExpr;
dan24e25d32018-04-14 18:46:20 +00004803#ifdef SQLITE_ENABLE_SORTER_REFERENCES
4804 if( pItem->bSorterRef ){
4805 i--;
4806 n--;
4807 }else
4808#endif
dan257c13f2016-11-10 20:14:06 +00004809 if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4810 if( flags & SQLITE_ECEL_OMITREF ){
4811 i--;
4812 n--;
4813 }else{
4814 sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4815 }
drhb8b06692018-08-04 15:16:20 +00004816 }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4817 && sqlite3ExprIsConstantNotJoin(pExpr)
4818 ){
drh9b258c52020-03-11 19:41:49 +00004819 sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
drhd1a01ed2013-11-21 16:08:52 +00004820 }else{
4821 int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4822 if( inReg!=target+i ){
drh4eded602013-12-20 15:59:20 +00004823 VdbeOp *pOp;
drh4eded602013-12-20 15:59:20 +00004824 if( copyOp==OP_Copy
4825 && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
4826 && pOp->p1+pOp->p3+1==inReg
4827 && pOp->p2+pOp->p3+1==target+i
drh90996882020-01-03 14:16:43 +00004828 && pOp->p5==0 /* The do-not-merge flag must be clear */
drh4eded602013-12-20 15:59:20 +00004829 ){
4830 pOp->p3++;
4831 }else{
4832 sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
4833 }
drhd1a01ed2013-11-21 16:08:52 +00004834 }
drhd1766112008-09-17 00:13:12 +00004835 }
drh268380c2004-02-25 13:47:31 +00004836 }
drhf9b596e2004-05-26 16:54:42 +00004837 return n;
drh268380c2004-02-25 13:47:31 +00004838}
4839
4840/*
drh36c563a2009-11-12 13:32:22 +00004841** Generate code for a BETWEEN operator.
4842**
4843** x BETWEEN y AND z
4844**
4845** The above is equivalent to
4846**
4847** x>=y AND x<=z
4848**
4849** Code it as such, taking care to do the common subexpression
peter.d.reid60ec9142014-09-06 16:39:46 +00004850** elimination of x.
drh84b19a32016-08-20 22:49:28 +00004851**
4852** The xJumpIf parameter determines details:
4853**
4854** NULL: Store the boolean result in reg[dest]
4855** sqlite3ExprIfTrue: Jump to dest if true
4856** sqlite3ExprIfFalse: Jump to dest if false
4857**
4858** The jumpIfNull parameter is ignored if xJumpIf is NULL.
drh36c563a2009-11-12 13:32:22 +00004859*/
4860static void exprCodeBetween(
4861 Parse *pParse, /* Parsing and code generating context */
4862 Expr *pExpr, /* The BETWEEN expression */
drh84b19a32016-08-20 22:49:28 +00004863 int dest, /* Jump destination or storage location */
4864 void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
drh36c563a2009-11-12 13:32:22 +00004865 int jumpIfNull /* Take the jump if the BETWEEN is NULL */
4866){
dan8b65e592019-07-17 14:34:17 +00004867 Expr exprAnd; /* The AND operator in x>=y AND x<=z */
drh36c563a2009-11-12 13:32:22 +00004868 Expr compLeft; /* The x>=y term */
4869 Expr compRight; /* The x<=z term */
drhdb45bd52016-08-22 00:48:58 +00004870 int regFree1 = 0; /* Temporary use register */
dan8b65e592019-07-17 14:34:17 +00004871 Expr *pDel = 0;
4872 sqlite3 *db = pParse->db;
drh84b19a32016-08-20 22:49:28 +00004873
dan71c57db2016-07-09 20:23:55 +00004874 memset(&compLeft, 0, sizeof(Expr));
4875 memset(&compRight, 0, sizeof(Expr));
4876 memset(&exprAnd, 0, sizeof(Expr));
drhdb45bd52016-08-22 00:48:58 +00004877
4878 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
dan8b65e592019-07-17 14:34:17 +00004879 pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
4880 if( db->mallocFailed==0 ){
4881 exprAnd.op = TK_AND;
4882 exprAnd.pLeft = &compLeft;
4883 exprAnd.pRight = &compRight;
4884 compLeft.op = TK_GE;
4885 compLeft.pLeft = pDel;
4886 compLeft.pRight = pExpr->x.pList->a[0].pExpr;
4887 compRight.op = TK_LE;
4888 compRight.pLeft = pDel;
4889 compRight.pRight = pExpr->x.pList->a[1].pExpr;
4890 exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4891 if( xJump ){
4892 xJump(pParse, &exprAnd, dest, jumpIfNull);
4893 }else{
4894 /* Mark the expression is being from the ON or USING clause of a join
4895 ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
4896 ** it into the Parse.pConstExpr list. We should use a new bit for this,
4897 ** for clarity, but we are out of bits in the Expr.flags field so we
4898 ** have to reuse the EP_FromJoin bit. Bummer. */
4899 pDel->flags |= EP_FromJoin;
4900 sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
4901 }
4902 sqlite3ReleaseTempReg(pParse, regFree1);
drh36c563a2009-11-12 13:32:22 +00004903 }
dan8b65e592019-07-17 14:34:17 +00004904 sqlite3ExprDelete(db, pDel);
drh36c563a2009-11-12 13:32:22 +00004905
4906 /* Ensure adequate test coverage */
drhdb45bd52016-08-22 00:48:58 +00004907 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
4908 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
4909 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
4910 testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
4911 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4912 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4913 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4914 testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
drh84b19a32016-08-20 22:49:28 +00004915 testcase( xJump==0 );
drh36c563a2009-11-12 13:32:22 +00004916}
4917
4918/*
drhcce7d172000-05-31 15:34:51 +00004919** Generate code for a boolean expression such that a jump is made
4920** to the label "dest" if the expression is true but execution
4921** continues straight thru if the expression is false.
drhf5905aa2002-05-26 20:54:33 +00004922**
4923** If the expression evaluates to NULL (neither true nor false), then
drh35573352008-01-08 23:54:25 +00004924** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
drhf2bc0132004-10-04 13:19:23 +00004925**
4926** This code depends on the fact that certain token values (ex: TK_EQ)
4927** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4928** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
4929** the make process cause these values to align. Assert()s in the code
4930** below verify that the numbers are aligned correctly.
drhcce7d172000-05-31 15:34:51 +00004931*/
danielk19774adee202004-05-08 08:23:19 +00004932void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00004933 Vdbe *v = pParse->pVdbe;
4934 int op = 0;
drh2dcef112008-01-12 19:03:48 +00004935 int regFree1 = 0;
4936 int regFree2 = 0;
4937 int r1, r2;
4938
drh35573352008-01-08 23:54:25 +00004939 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00004940 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00004941 if( NEVER(pExpr==0) ) return; /* No way this can happen */
drhe7375bf2020-03-10 19:24:38 +00004942 assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00004943 op = pExpr->op;
dan7b35a772016-07-28 19:47:15 +00004944 switch( op ){
drh17180fc2019-04-19 17:26:19 +00004945 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00004946 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00004947 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
4948 if( pAlt!=pExpr ){
4949 sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
4950 }else if( op==TK_AND ){
4951 int d2 = sqlite3VdbeMakeLabel(pParse);
4952 testcase( jumpIfNull==0 );
4953 sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
4954 jumpIfNull^SQLITE_JUMPIFNULL);
4955 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4956 sqlite3VdbeResolveLabel(v, d2);
4957 }else{
4958 testcase( jumpIfNull==0 );
4959 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4960 sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4961 }
drhcce7d172000-05-31 15:34:51 +00004962 break;
4963 }
4964 case TK_NOT: {
drhc5499be2008-04-01 15:06:33 +00004965 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00004966 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00004967 break;
4968 }
drh8abed7b2018-02-26 18:49:05 +00004969 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00004970 int isNot; /* IS NOT TRUE or IS NOT FALSE */
4971 int isTrue; /* IS TRUE or IS NOT TRUE */
drh007c8432018-02-26 03:20:18 +00004972 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00004973 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00004974 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00004975 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00004976 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00004977 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00004978 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
4979 isNot ? SQLITE_JUMPIFNULL : 0);
4980 }else{
4981 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
4982 isNot ? SQLITE_JUMPIFNULL : 0);
4983 }
drh007c8432018-02-26 03:20:18 +00004984 break;
4985 }
drhde845c22016-03-17 19:07:52 +00004986 case TK_IS:
4987 case TK_ISNOT:
4988 testcase( op==TK_IS );
4989 testcase( op==TK_ISNOT );
4990 op = (op==TK_IS) ? TK_EQ : TK_NE;
4991 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00004992 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00004993 case TK_LT:
4994 case TK_LE:
4995 case TK_GT:
4996 case TK_GE:
4997 case TK_NE:
drh0ac65892002-04-20 14:24:41 +00004998 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00004999 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005000 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005001 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5002 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005003 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005004 r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005005 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5006 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5007 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5008 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005009 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5010 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5011 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5012 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5013 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5014 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005015 testcase( regFree1==0 );
5016 testcase( regFree2==0 );
5017 break;
5018 }
drhcce7d172000-05-31 15:34:51 +00005019 case TK_ISNULL:
5020 case TK_NOTNULL: {
drh7d176102014-02-18 03:07:12 +00005021 assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
5022 assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
drh2dcef112008-01-12 19:03:48 +00005023 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5024 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005025 VdbeCoverageIf(v, op==TK_ISNULL);
5026 VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005027 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005028 break;
5029 }
drhfef52082000-06-06 01:50:43 +00005030 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005031 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005032 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005033 break;
5034 }
drh84e30ca2011-02-10 17:46:14 +00005035#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005036 case TK_IN: {
drhec4ccdb2018-12-29 02:26:59 +00005037 int destIfFalse = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005038 int destIfNull = jumpIfNull ? dest : destIfFalse;
5039 sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
drh076e85f2015-09-03 13:46:12 +00005040 sqlite3VdbeGoto(v, dest);
drhe3365e62009-11-12 17:52:24 +00005041 sqlite3VdbeResolveLabel(v, destIfFalse);
5042 break;
5043 }
shanehbb201342011-02-09 19:55:20 +00005044#endif
drhcce7d172000-05-31 15:34:51 +00005045 default: {
dan7b35a772016-07-28 19:47:15 +00005046 default_expr:
drhad317272019-04-19 16:21:51 +00005047 if( ExprAlwaysTrue(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005048 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005049 }else if( ExprAlwaysFalse(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005050 /* No-op */
5051 }else{
5052 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5053 sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005054 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005055 testcase( regFree1==0 );
5056 testcase( jumpIfNull==0 );
5057 }
drhcce7d172000-05-31 15:34:51 +00005058 break;
5059 }
5060 }
drh2dcef112008-01-12 19:03:48 +00005061 sqlite3ReleaseTempReg(pParse, regFree1);
5062 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005063}
5064
5065/*
drh66b89c82000-11-28 20:47:17 +00005066** Generate code for a boolean expression such that a jump is made
drhcce7d172000-05-31 15:34:51 +00005067** to the label "dest" if the expression is false but execution
5068** continues straight thru if the expression is true.
drhf5905aa2002-05-26 20:54:33 +00005069**
5070** If the expression evaluates to NULL (neither true nor false) then
drh35573352008-01-08 23:54:25 +00005071** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
5072** is 0.
drhcce7d172000-05-31 15:34:51 +00005073*/
danielk19774adee202004-05-08 08:23:19 +00005074void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
drhcce7d172000-05-31 15:34:51 +00005075 Vdbe *v = pParse->pVdbe;
5076 int op = 0;
drh2dcef112008-01-12 19:03:48 +00005077 int regFree1 = 0;
5078 int regFree2 = 0;
5079 int r1, r2;
5080
drh35573352008-01-08 23:54:25 +00005081 assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
mistachkin48864df2013-03-21 21:20:32 +00005082 if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
drh33cd4902009-05-30 20:49:20 +00005083 if( pExpr==0 ) return;
drhe7375bf2020-03-10 19:24:38 +00005084 assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
drhf2bc0132004-10-04 13:19:23 +00005085
5086 /* The value of pExpr->op and op are related as follows:
5087 **
5088 ** pExpr->op op
5089 ** --------- ----------
5090 ** TK_ISNULL OP_NotNull
5091 ** TK_NOTNULL OP_IsNull
5092 ** TK_NE OP_Eq
5093 ** TK_EQ OP_Ne
5094 ** TK_GT OP_Le
5095 ** TK_LE OP_Gt
5096 ** TK_GE OP_Lt
5097 ** TK_LT OP_Ge
5098 **
5099 ** For other values of pExpr->op, op is undefined and unused.
5100 ** The value of TK_ and OP_ constants are arranged such that we
5101 ** can compute the mapping above using the following expression.
5102 ** Assert()s verify that the computation is correct.
5103 */
5104 op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5105
5106 /* Verify correct alignment of TK_ and OP_ constants
5107 */
5108 assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5109 assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5110 assert( pExpr->op!=TK_NE || op==OP_Eq );
5111 assert( pExpr->op!=TK_EQ || op==OP_Ne );
5112 assert( pExpr->op!=TK_LT || op==OP_Ge );
5113 assert( pExpr->op!=TK_LE || op==OP_Gt );
5114 assert( pExpr->op!=TK_GT || op==OP_Le );
5115 assert( pExpr->op!=TK_GE || op==OP_Lt );
5116
danba00e302016-07-23 20:24:06 +00005117 switch( pExpr->op ){
drh17180fc2019-04-19 17:26:19 +00005118 case TK_AND:
drhcce7d172000-05-31 15:34:51 +00005119 case TK_OR: {
drh17180fc2019-04-19 17:26:19 +00005120 Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
5121 if( pAlt!=pExpr ){
5122 sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
5123 }else if( pExpr->op==TK_AND ){
5124 testcase( jumpIfNull==0 );
5125 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5126 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5127 }else{
5128 int d2 = sqlite3VdbeMakeLabel(pParse);
5129 testcase( jumpIfNull==0 );
5130 sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
5131 jumpIfNull^SQLITE_JUMPIFNULL);
5132 sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
5133 sqlite3VdbeResolveLabel(v, d2);
5134 }
drhcce7d172000-05-31 15:34:51 +00005135 break;
5136 }
5137 case TK_NOT: {
drh5c03f302009-11-13 15:03:59 +00005138 testcase( jumpIfNull==0 );
danielk19774adee202004-05-08 08:23:19 +00005139 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
drhcce7d172000-05-31 15:34:51 +00005140 break;
5141 }
drh8abed7b2018-02-26 18:49:05 +00005142 case TK_TRUTH: {
drh96acafb2018-02-27 14:49:25 +00005143 int isNot; /* IS NOT TRUE or IS NOT FALSE */
5144 int isTrue; /* IS TRUE or IS NOT TRUE */
drh8abed7b2018-02-26 18:49:05 +00005145 testcase( jumpIfNull==0 );
drh8abed7b2018-02-26 18:49:05 +00005146 isNot = pExpr->op2==TK_ISNOT;
drh96acafb2018-02-27 14:49:25 +00005147 isTrue = sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +00005148 testcase( isTrue && isNot );
drh96acafb2018-02-27 14:49:25 +00005149 testcase( !isTrue && isNot );
drh43c4ac82018-02-26 21:26:27 +00005150 if( isTrue ^ isNot ){
drh8abed7b2018-02-26 18:49:05 +00005151 /* IS TRUE and IS NOT FALSE */
5152 sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
5153 isNot ? 0 : SQLITE_JUMPIFNULL);
5154
5155 }else{
5156 /* IS FALSE and IS NOT TRUE */
5157 sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
drh96acafb2018-02-27 14:49:25 +00005158 isNot ? 0 : SQLITE_JUMPIFNULL);
drh8abed7b2018-02-26 18:49:05 +00005159 }
drh007c8432018-02-26 03:20:18 +00005160 break;
5161 }
drhde845c22016-03-17 19:07:52 +00005162 case TK_IS:
5163 case TK_ISNOT:
5164 testcase( pExpr->op==TK_IS );
5165 testcase( pExpr->op==TK_ISNOT );
5166 op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5167 jumpIfNull = SQLITE_NULLEQ;
drh08b92082020-08-10 14:18:00 +00005168 /* no break */ deliberate_fall_through
drhcce7d172000-05-31 15:34:51 +00005169 case TK_LT:
5170 case TK_LE:
5171 case TK_GT:
5172 case TK_GE:
5173 case TK_NE:
5174 case TK_EQ: {
dan625015e2016-07-30 16:39:28 +00005175 if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
drhc5499be2008-04-01 15:06:33 +00005176 testcase( jumpIfNull==0 );
drhb6da74e2009-12-24 16:00:28 +00005177 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5178 r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
drh35573352008-01-08 23:54:25 +00005179 codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
drh898c5272019-10-22 00:03:41 +00005180 r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
drh7d176102014-02-18 03:07:12 +00005181 assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
5182 assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
5183 assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
5184 assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
drhde845c22016-03-17 19:07:52 +00005185 assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5186 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5187 VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5188 assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5189 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5190 VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
drh6a2fe092009-09-23 02:29:36 +00005191 testcase( regFree1==0 );
5192 testcase( regFree2==0 );
5193 break;
5194 }
drhcce7d172000-05-31 15:34:51 +00005195 case TK_ISNULL:
5196 case TK_NOTNULL: {
drh2dcef112008-01-12 19:03:48 +00005197 r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5198 sqlite3VdbeAddOp2(v, op, r1, dest);
drh7d176102014-02-18 03:07:12 +00005199 testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
5200 testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
drhc5499be2008-04-01 15:06:33 +00005201 testcase( regFree1==0 );
drhcce7d172000-05-31 15:34:51 +00005202 break;
5203 }
drhfef52082000-06-06 01:50:43 +00005204 case TK_BETWEEN: {
drh5c03f302009-11-13 15:03:59 +00005205 testcase( jumpIfNull==0 );
dan71c57db2016-07-09 20:23:55 +00005206 exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
drhfef52082000-06-06 01:50:43 +00005207 break;
5208 }
drh84e30ca2011-02-10 17:46:14 +00005209#ifndef SQLITE_OMIT_SUBQUERY
drhe3365e62009-11-12 17:52:24 +00005210 case TK_IN: {
5211 if( jumpIfNull ){
5212 sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5213 }else{
drhec4ccdb2018-12-29 02:26:59 +00005214 int destIfNull = sqlite3VdbeMakeLabel(pParse);
drhe3365e62009-11-12 17:52:24 +00005215 sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5216 sqlite3VdbeResolveLabel(v, destIfNull);
5217 }
5218 break;
5219 }
shanehbb201342011-02-09 19:55:20 +00005220#endif
drhcce7d172000-05-31 15:34:51 +00005221 default: {
danba00e302016-07-23 20:24:06 +00005222 default_expr:
drhad317272019-04-19 16:21:51 +00005223 if( ExprAlwaysFalse(pExpr) ){
drh076e85f2015-09-03 13:46:12 +00005224 sqlite3VdbeGoto(v, dest);
drhad317272019-04-19 16:21:51 +00005225 }else if( ExprAlwaysTrue(pExpr) ){
drh991a1982014-01-02 17:57:16 +00005226 /* no-op */
5227 }else{
5228 r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
5229 sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
drh688852a2014-02-17 22:40:43 +00005230 VdbeCoverage(v);
drh991a1982014-01-02 17:57:16 +00005231 testcase( regFree1==0 );
5232 testcase( jumpIfNull==0 );
5233 }
drhcce7d172000-05-31 15:34:51 +00005234 break;
5235 }
5236 }
drh2dcef112008-01-12 19:03:48 +00005237 sqlite3ReleaseTempReg(pParse, regFree1);
5238 sqlite3ReleaseTempReg(pParse, regFree2);
drhcce7d172000-05-31 15:34:51 +00005239}
drh22827922000-06-06 17:27:05 +00005240
5241/*
drh72bc8202015-06-11 13:58:35 +00005242** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
5243** code generation, and that copy is deleted after code generation. This
5244** ensures that the original pExpr is unchanged.
5245*/
5246void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
5247 sqlite3 *db = pParse->db;
5248 Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
5249 if( db->mallocFailed==0 ){
5250 sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
5251 }
5252 sqlite3ExprDelete(db, pCopy);
5253}
5254
dan5aa550c2017-06-24 18:10:29 +00005255/*
5256** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
5257** type of expression.
5258**
5259** If pExpr is a simple SQL value - an integer, real, string, blob
5260** or NULL value - then the VDBE currently being prepared is configured
5261** to re-prepare each time a new value is bound to variable pVar.
5262**
5263** Additionally, if pExpr is a simple SQL value and the value is the
5264** same as that currently bound to variable pVar, non-zero is returned.
5265** Otherwise, if the values are not the same or if pExpr is not a simple
5266** SQL value, zero is returned.
5267*/
5268static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
5269 int res = 0;
drhc0804222017-06-28 21:47:16 +00005270 int iVar;
5271 sqlite3_value *pL, *pR = 0;
5272
5273 sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5274 if( pR ){
5275 iVar = pVar->iColumn;
dan5aa550c2017-06-24 18:10:29 +00005276 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan5aa550c2017-06-24 18:10:29 +00005277 pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
drh5aa307e2017-06-29 01:23:12 +00005278 if( pL ){
5279 if( sqlite3_value_type(pL)==SQLITE_TEXT ){
5280 sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
5281 }
5282 res = 0==sqlite3MemCompare(pL, pR, 0);
dan5aa550c2017-06-24 18:10:29 +00005283 }
drhc0804222017-06-28 21:47:16 +00005284 sqlite3ValueFree(pR);
5285 sqlite3ValueFree(pL);
dan5aa550c2017-06-24 18:10:29 +00005286 }
5287
5288 return res;
5289}
drh72bc8202015-06-11 13:58:35 +00005290
5291/*
drh1d9da702010-01-07 15:17:02 +00005292** Do a deep comparison of two expression trees. Return 0 if the two
5293** expressions are completely identical. Return 1 if they differ only
5294** by a COLLATE operator at the top level. Return 2 if there are differences
5295** other than the top-level COLLATE operator.
drhd40aab02007-02-24 15:29:03 +00005296**
drh619a1302013-08-01 13:04:46 +00005297** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5298** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5299**
drh66518ca2013-08-01 15:09:57 +00005300** The pA side might be using TK_REGISTER. If that is the case and pB is
5301** not using TK_REGISTER but is otherwise equivalent, then still return 0.
5302**
drh1d9da702010-01-07 15:17:02 +00005303** Sometimes this routine will return 2 even if the two expressions
drhd40aab02007-02-24 15:29:03 +00005304** really are equivalent. If we cannot prove that the expressions are
drh1d9da702010-01-07 15:17:02 +00005305** identical, we return 2 just to be safe. So if this routine
5306** returns 2, then you do not really know for certain if the two
5307** expressions are the same. But if you get a 0 or 1 return, then you
drhd40aab02007-02-24 15:29:03 +00005308** can be sure the expressions are the same. In the places where
drh1d9da702010-01-07 15:17:02 +00005309** this routine is used, it does not hurt to get an extra 2 - that
drhd40aab02007-02-24 15:29:03 +00005310** just might result in some slightly slower code. But returning
drh1d9da702010-01-07 15:17:02 +00005311** an incorrect 0 or 1 could lead to a malfunction.
dan5aa550c2017-06-24 18:10:29 +00005312**
drhc0804222017-06-28 21:47:16 +00005313** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5314** pParse->pReprepare can be matched against literals in pB. The
5315** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5316** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5317** Argument pParse should normally be NULL. If it is not NULL and pA or
5318** pB causes a return value of 2.
drh22827922000-06-06 17:27:05 +00005319*/
dan5aa550c2017-06-24 18:10:29 +00005320int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
drh10d1edf2013-11-15 15:52:39 +00005321 u32 combinedFlags;
5322 if( pA==0 || pB==0 ){
drh1d9da702010-01-07 15:17:02 +00005323 return pB==pA ? 0 : 2;
drh22827922000-06-06 17:27:05 +00005324 }
dan5aa550c2017-06-24 18:10:29 +00005325 if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
5326 return 0;
5327 }
drh10d1edf2013-11-15 15:52:39 +00005328 combinedFlags = pA->flags | pB->flags;
5329 if( combinedFlags & EP_IntValue ){
5330 if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
5331 return 0;
5332 }
drh1d9da702010-01-07 15:17:02 +00005333 return 2;
drh22827922000-06-06 17:27:05 +00005334 }
dan16dd3982018-12-20 15:04:38 +00005335 if( pA->op!=pB->op || pA->op==TK_RAISE ){
dan5aa550c2017-06-24 18:10:29 +00005336 if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005337 return 1;
5338 }
dan5aa550c2017-06-24 18:10:29 +00005339 if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
drhae80dde2012-12-06 21:16:43 +00005340 return 1;
5341 }
5342 return 2;
5343 }
drh2edc5fd2015-11-24 02:10:52 +00005344 if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
dan4f9adee2019-07-13 16:22:50 +00005345 if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
drh390b88a2015-08-31 18:13:01 +00005346 if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drheda079c2018-09-20 19:02:15 +00005347#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00005348 assert( pA->op==pB->op );
5349 if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
5350 return 2;
5351 }
drheda079c2018-09-20 19:02:15 +00005352 if( ExprHasProperty(pA,EP_WinFunc) ){
dan4f9adee2019-07-13 16:22:50 +00005353 if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
5354 return 2;
5355 }
drheda079c2018-09-20 19:02:15 +00005356 }
5357#endif
drhf20bbc52019-01-17 01:06:00 +00005358 }else if( pA->op==TK_NULL ){
5359 return 0;
drhd5af5422018-04-13 14:27:01 +00005360 }else if( pA->op==TK_COLLATE ){
drhe79f6292018-04-18 17:52:28 +00005361 if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
drhf20bbc52019-01-17 01:06:00 +00005362 }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
drhd5af5422018-04-13 14:27:01 +00005363 return 2;
drh2646da72005-12-09 20:02:05 +00005364 }
drh22827922000-06-06 17:27:05 +00005365 }
drh898c5272019-10-22 00:03:41 +00005366 if( (pA->flags & (EP_Distinct|EP_Commuted))
5367 != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
drhe7375bf2020-03-10 19:24:38 +00005368 if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
drh10d1edf2013-11-15 15:52:39 +00005369 if( combinedFlags & EP_xIsSelect ) return 2;
drhefad2e22018-07-27 16:57:11 +00005370 if( (combinedFlags & EP_FixedCol)==0
5371 && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
dan5aa550c2017-06-24 18:10:29 +00005372 if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
drh10d1edf2013-11-15 15:52:39 +00005373 if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
drh03c5c212018-12-12 11:23:40 +00005374 if( pA->op!=TK_STRING
5375 && pA->op!=TK_TRUEFALSE
drhe7375bf2020-03-10 19:24:38 +00005376 && ALWAYS((combinedFlags & EP_Reduced)==0)
drh03c5c212018-12-12 11:23:40 +00005377 ){
drh10d1edf2013-11-15 15:52:39 +00005378 if( pA->iColumn!=pB->iColumn ) return 2;
drh9b258c52020-03-11 19:41:49 +00005379 if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
drh0f28e1b2019-10-28 13:07:01 +00005380 if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
5381 return 2;
5382 }
drh10d1edf2013-11-15 15:52:39 +00005383 }
5384 }
drh1d9da702010-01-07 15:17:02 +00005385 return 0;
drh22827922000-06-06 17:27:05 +00005386}
5387
drh8c6f6662010-04-26 19:17:26 +00005388/*
danfbb6e9f2020-01-09 20:11:29 +00005389** Compare two ExprList objects. Return 0 if they are identical, 1
5390** if they are certainly different, or 2 if it is not possible to
5391** determine if they are identical or not.
drh8c6f6662010-04-26 19:17:26 +00005392**
drh619a1302013-08-01 13:04:46 +00005393** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5394** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5395**
drh8c6f6662010-04-26 19:17:26 +00005396** This routine might return non-zero for equivalent ExprLists. The
5397** only consequence will be disabled optimizations. But this routine
5398** must never return 0 if the two ExprList objects are different, or
5399** a malfunction will result.
5400**
5401** Two NULL pointers are considered to be the same. But a NULL pointer
5402** always differs from a non-NULL pointer.
5403*/
drh619a1302013-08-01 13:04:46 +00005404int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
drh8c6f6662010-04-26 19:17:26 +00005405 int i;
5406 if( pA==0 && pB==0 ) return 0;
5407 if( pA==0 || pB==0 ) return 1;
5408 if( pA->nExpr!=pB->nExpr ) return 1;
5409 for(i=0; i<pA->nExpr; i++){
danfbb6e9f2020-01-09 20:11:29 +00005410 int res;
drh8c6f6662010-04-26 19:17:26 +00005411 Expr *pExprA = pA->a[i].pExpr;
5412 Expr *pExprB = pB->a[i].pExpr;
dan6e118922019-08-12 16:36:38 +00005413 if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
danfbb6e9f2020-01-09 20:11:29 +00005414 if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
drh8c6f6662010-04-26 19:17:26 +00005415 }
5416 return 0;
5417}
drh13449892005-09-07 21:22:45 +00005418
drh22827922000-06-06 17:27:05 +00005419/*
drhf9463df2017-02-11 14:59:58 +00005420** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5421** are ignored.
5422*/
5423int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
dan5aa550c2017-06-24 18:10:29 +00005424 return sqlite3ExprCompare(0,
drh0d950af2019-08-22 16:38:42 +00005425 sqlite3ExprSkipCollateAndLikely(pA),
5426 sqlite3ExprSkipCollateAndLikely(pB),
drhf9463df2017-02-11 14:59:58 +00005427 iTab);
5428}
5429
5430/*
drhc51cf862019-05-11 19:36:03 +00005431** Return non-zero if Expr p can only be true if pNN is not NULL.
drh7a231b42019-08-30 15:11:08 +00005432**
5433** Or if seenNot is true, return non-zero if Expr p can only be
5434** non-NULL if pNN is not NULL
drhc51cf862019-05-11 19:36:03 +00005435*/
5436static int exprImpliesNotNull(
5437 Parse *pParse, /* Parsing context */
5438 Expr *p, /* The expression to be checked */
5439 Expr *pNN, /* The expression that is NOT NULL */
5440 int iTab, /* Table being evaluated */
drh7a231b42019-08-30 15:11:08 +00005441 int seenNot /* Return true only if p can be any non-NULL value */
drhc51cf862019-05-11 19:36:03 +00005442){
5443 assert( p );
5444 assert( pNN );
drh14c865e2019-08-10 15:06:03 +00005445 if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
5446 return pNN->op!=TK_NULL;
5447 }
drhc51cf862019-05-11 19:36:03 +00005448 switch( p->op ){
5449 case TK_IN: {
5450 if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5451 assert( ExprHasProperty(p,EP_xIsSelect)
5452 || (p->x.pList!=0 && p->x.pList->nExpr>0) );
drhae144a12019-08-30 16:00:58 +00005453 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005454 }
5455 case TK_BETWEEN: {
5456 ExprList *pList = p->x.pList;
5457 assert( pList!=0 );
5458 assert( pList->nExpr==2 );
5459 if( seenNot ) return 0;
drh7a231b42019-08-30 15:11:08 +00005460 if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
5461 || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
drhc51cf862019-05-11 19:36:03 +00005462 ){
5463 return 1;
5464 }
drh7a231b42019-08-30 15:11:08 +00005465 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005466 }
5467 case TK_EQ:
5468 case TK_NE:
5469 case TK_LT:
5470 case TK_LE:
5471 case TK_GT:
5472 case TK_GE:
5473 case TK_PLUS:
5474 case TK_MINUS:
dan9d23ea72019-08-29 19:34:29 +00005475 case TK_BITOR:
5476 case TK_LSHIFT:
5477 case TK_RSHIFT:
5478 case TK_CONCAT:
5479 seenNot = 1;
drh08b92082020-08-10 14:18:00 +00005480 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005481 case TK_STAR:
5482 case TK_REM:
5483 case TK_BITAND:
dan9d23ea72019-08-29 19:34:29 +00005484 case TK_SLASH: {
drhc51cf862019-05-11 19:36:03 +00005485 if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
drh08b92082020-08-10 14:18:00 +00005486 /* no break */ deliberate_fall_through
drhc51cf862019-05-11 19:36:03 +00005487 }
5488 case TK_SPAN:
5489 case TK_COLLATE:
drhc51cf862019-05-11 19:36:03 +00005490 case TK_UPLUS:
5491 case TK_UMINUS: {
5492 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5493 }
5494 case TK_TRUTH: {
5495 if( seenNot ) return 0;
5496 if( p->op2!=TK_IS ) return 0;
drh38cefc82019-08-30 13:07:06 +00005497 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
drhc51cf862019-05-11 19:36:03 +00005498 }
dan1cd382e2019-08-29 15:06:35 +00005499 case TK_BITNOT:
drhc51cf862019-05-11 19:36:03 +00005500 case TK_NOT: {
5501 return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5502 }
5503 }
5504 return 0;
5505}
5506
5507/*
drh4bd5f732013-07-31 23:22:39 +00005508** Return true if we can prove the pE2 will always be true if pE1 is
5509** true. Return false if we cannot complete the proof or if pE2 might
5510** be false. Examples:
5511**
drh619a1302013-08-01 13:04:46 +00005512** pE1: x==5 pE2: x==5 Result: true
5513** pE1: x>0 pE2: x==5 Result: false
5514** pE1: x=21 pE2: x=21 OR y=43 Result: true
5515** pE1: x!=123 pE2: x IS NOT NULL Result: true
5516** pE1: x!=?1 pE2: x IS NOT NULL Result: true
5517** pE1: x IS NULL pE2: x IS NOT NULL Result: false
5518** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
drh4bd5f732013-07-31 23:22:39 +00005519**
5520** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
5521** Expr.iTable<0 then assume a table number given by iTab.
5522**
drhc0804222017-06-28 21:47:16 +00005523** If pParse is not NULL, then the values of bound variables in pE1 are
5524** compared against literal values in pE2 and pParse->pVdbe->expmask is
5525** modified to record which bound variables are referenced. If pParse
5526** is NULL, then false will be returned if pE1 contains any bound variables.
5527**
drh4bd5f732013-07-31 23:22:39 +00005528** When in doubt, return false. Returning true might give a performance
5529** improvement. Returning false might cause a performance reduction, but
5530** it will always give the correct answer and is hence always safe.
5531*/
dan5aa550c2017-06-24 18:10:29 +00005532int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
5533 if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
drh619a1302013-08-01 13:04:46 +00005534 return 1;
5535 }
5536 if( pE2->op==TK_OR
dan5aa550c2017-06-24 18:10:29 +00005537 && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
5538 || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
drh619a1302013-08-01 13:04:46 +00005539 ){
5540 return 1;
5541 }
drh664d6d12019-05-04 17:32:07 +00005542 if( pE2->op==TK_NOTNULL
drhc51cf862019-05-11 19:36:03 +00005543 && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
drh664d6d12019-05-04 17:32:07 +00005544 ){
drhc51cf862019-05-11 19:36:03 +00005545 return 1;
drh619a1302013-08-01 13:04:46 +00005546 }
5547 return 0;
drh4bd5f732013-07-31 23:22:39 +00005548}
5549
5550/*
drh6c68d752019-11-04 02:05:52 +00005551** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
drh25897872018-03-20 21:16:15 +00005552** If the expression node requires that the table at pWalker->iCur
drhf8937f92018-09-23 02:01:42 +00005553** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5554**
5555** This routine controls an optimization. False positives (setting
5556** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5557** (never setting pWalker->eCode) is a harmless missed optimization.
drh25897872018-03-20 21:16:15 +00005558*/
5559static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
drhf8937f92018-09-23 02:01:42 +00005560 testcase( pExpr->op==TK_AGG_COLUMN );
drh821b6102018-03-24 18:01:51 +00005561 testcase( pExpr->op==TK_AGG_FUNCTION );
drh25897872018-03-20 21:16:15 +00005562 if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
5563 switch( pExpr->op ){
dan04932222018-04-10 15:31:56 +00005564 case TK_ISNOT:
drh25897872018-03-20 21:16:15 +00005565 case TK_ISNULL:
drhd5793672019-02-05 14:36:33 +00005566 case TK_NOTNULL:
drh25897872018-03-20 21:16:15 +00005567 case TK_IS:
5568 case TK_OR:
drh6c68d752019-11-04 02:05:52 +00005569 case TK_VECTOR:
drh2c492062018-03-24 13:24:02 +00005570 case TK_CASE:
drhe3eff262018-03-24 15:47:31 +00005571 case TK_IN:
drh25897872018-03-20 21:16:15 +00005572 case TK_FUNCTION:
danda03c1e2019-10-09 21:14:00 +00005573 case TK_TRUTH:
dan04932222018-04-10 15:31:56 +00005574 testcase( pExpr->op==TK_ISNOT );
drh821b6102018-03-24 18:01:51 +00005575 testcase( pExpr->op==TK_ISNULL );
drhd5793672019-02-05 14:36:33 +00005576 testcase( pExpr->op==TK_NOTNULL );
drh821b6102018-03-24 18:01:51 +00005577 testcase( pExpr->op==TK_IS );
5578 testcase( pExpr->op==TK_OR );
drh6c68d752019-11-04 02:05:52 +00005579 testcase( pExpr->op==TK_VECTOR );
drh821b6102018-03-24 18:01:51 +00005580 testcase( pExpr->op==TK_CASE );
5581 testcase( pExpr->op==TK_IN );
5582 testcase( pExpr->op==TK_FUNCTION );
danda03c1e2019-10-09 21:14:00 +00005583 testcase( pExpr->op==TK_TRUTH );
drh25897872018-03-20 21:16:15 +00005584 return WRC_Prune;
5585 case TK_COLUMN:
drh25897872018-03-20 21:16:15 +00005586 if( pWalker->u.iCur==pExpr->iTable ){
5587 pWalker->eCode = 1;
5588 return WRC_Abort;
5589 }
5590 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005591
dan9d23ea72019-08-29 19:34:29 +00005592 case TK_AND:
drhaef81672020-01-01 16:43:41 +00005593 if( pWalker->eCode==0 ){
5594 sqlite3WalkExpr(pWalker, pExpr->pLeft);
5595 if( pWalker->eCode ){
5596 pWalker->eCode = 0;
5597 sqlite3WalkExpr(pWalker, pExpr->pRight);
5598 }
dan9d23ea72019-08-29 19:34:29 +00005599 }
5600 return WRC_Prune;
5601
5602 case TK_BETWEEN:
dan1d24a532019-12-23 15:17:11 +00005603 if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
5604 assert( pWalker->eCode );
5605 return WRC_Abort;
5606 }
dan9d23ea72019-08-29 19:34:29 +00005607 return WRC_Prune;
5608
drh98811552018-04-03 14:04:48 +00005609 /* Virtual tables are allowed to use constraints like x=NULL. So
5610 ** a term of the form x=y does not prove that y is not null if x
5611 ** is the column of a virtual table */
5612 case TK_EQ:
5613 case TK_NE:
5614 case TK_LT:
5615 case TK_LE:
5616 case TK_GT:
drh78d1d222020-02-17 19:25:07 +00005617 case TK_GE: {
5618 Expr *pLeft = pExpr->pLeft;
5619 Expr *pRight = pExpr->pRight;
drh98811552018-04-03 14:04:48 +00005620 testcase( pExpr->op==TK_EQ );
5621 testcase( pExpr->op==TK_NE );
5622 testcase( pExpr->op==TK_LT );
5623 testcase( pExpr->op==TK_LE );
5624 testcase( pExpr->op==TK_GT );
5625 testcase( pExpr->op==TK_GE );
drh78d1d222020-02-17 19:25:07 +00005626 /* The y.pTab=0 assignment in wherecode.c always happens after the
5627 ** impliesNotNullRow() test */
5628 if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
5629 && IsVirtual(pLeft->y.pTab))
5630 || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
5631 && IsVirtual(pRight->y.pTab))
drh98811552018-04-03 14:04:48 +00005632 ){
drh78d1d222020-02-17 19:25:07 +00005633 return WRC_Prune;
drh98811552018-04-03 14:04:48 +00005634 }
drh08b92082020-08-10 14:18:00 +00005635 /* no break */ deliberate_fall_through
drh78d1d222020-02-17 19:25:07 +00005636 }
drh25897872018-03-20 21:16:15 +00005637 default:
5638 return WRC_Continue;
5639 }
5640}
5641
5642/*
5643** Return true (non-zero) if expression p can only be true if at least
5644** one column of table iTab is non-null. In other words, return true
5645** if expression p will always be NULL or false if every column of iTab
5646** is NULL.
5647**
drh821b6102018-03-24 18:01:51 +00005648** False negatives are acceptable. In other words, it is ok to return
5649** zero even if expression p will never be true of every column of iTab
5650** is NULL. A false negative is merely a missed optimization opportunity.
5651**
5652** False positives are not allowed, however. A false positive may result
5653** in an incorrect answer.
5654**
drh25897872018-03-20 21:16:15 +00005655** Terms of p that are marked with EP_FromJoin (and hence that come from
5656** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
5657**
5658** This routine is used to check if a LEFT JOIN can be converted into
5659** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
5660** clause requires that some column of the right table of the LEFT JOIN
5661** be non-NULL, then the LEFT JOIN can be safely converted into an
5662** ordinary join.
5663*/
5664int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
5665 Walker w;
drh0d950af2019-08-22 16:38:42 +00005666 p = sqlite3ExprSkipCollateAndLikely(p);
drh4a254f92019-10-11 16:01:21 +00005667 if( p==0 ) return 0;
5668 if( p->op==TK_NOTNULL ){
dan0287c952019-10-10 17:09:44 +00005669 p = p->pLeft;
drha1698992019-10-11 17:14:40 +00005670 }else{
5671 while( p->op==TK_AND ){
5672 if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5673 p = p->pRight;
5674 }
drhd6db6592019-04-01 19:42:42 +00005675 }
drh25897872018-03-20 21:16:15 +00005676 w.xExprCallback = impliesNotNullRow;
5677 w.xSelectCallback = 0;
5678 w.xSelectCallback2 = 0;
5679 w.eCode = 0;
5680 w.u.iCur = iTab;
5681 sqlite3WalkExpr(&w, p);
5682 return w.eCode;
5683}
5684
5685/*
drh030796d2012-08-23 16:18:10 +00005686** An instance of the following structure is used by the tree walker
drh2409f8a2016-07-27 18:27:02 +00005687** to determine if an expression can be evaluated by reference to the
5688** index only, without having to do a search for the corresponding
5689** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
5690** is the cursor for the table.
5691*/
5692struct IdxCover {
5693 Index *pIdx; /* The index to be tested for coverage */
5694 int iCur; /* Cursor number for the table corresponding to the index */
5695};
5696
5697/*
5698** Check to see if there are references to columns in table
5699** pWalker->u.pIdxCover->iCur can be satisfied using the index
5700** pWalker->u.pIdxCover->pIdx.
5701*/
5702static int exprIdxCover(Walker *pWalker, Expr *pExpr){
5703 if( pExpr->op==TK_COLUMN
5704 && pExpr->iTable==pWalker->u.pIdxCover->iCur
drhb9bcf7c2019-10-19 13:29:10 +00005705 && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
drh2409f8a2016-07-27 18:27:02 +00005706 ){
5707 pWalker->eCode = 1;
5708 return WRC_Abort;
5709 }
5710 return WRC_Continue;
5711}
5712
5713/*
drhe604ec02016-07-27 19:20:58 +00005714** Determine if an index pIdx on table with cursor iCur contains will
5715** the expression pExpr. Return true if the index does cover the
5716** expression and false if the pExpr expression references table columns
5717** that are not found in the index pIdx.
drh2409f8a2016-07-27 18:27:02 +00005718**
5719** An index covering an expression means that the expression can be
5720** evaluated using only the index and without having to lookup the
5721** corresponding table entry.
5722*/
5723int sqlite3ExprCoveredByIndex(
5724 Expr *pExpr, /* The index to be tested */
5725 int iCur, /* The cursor number for the corresponding table */
5726 Index *pIdx /* The index that might be used for coverage */
5727){
5728 Walker w;
5729 struct IdxCover xcov;
5730 memset(&w, 0, sizeof(w));
5731 xcov.iCur = iCur;
5732 xcov.pIdx = pIdx;
5733 w.xExprCallback = exprIdxCover;
5734 w.u.pIdxCover = &xcov;
5735 sqlite3WalkExpr(&w, pExpr);
5736 return !w.eCode;
5737}
5738
5739
5740/*
5741** An instance of the following structure is used by the tree walker
drh030796d2012-08-23 16:18:10 +00005742** to count references to table columns in the arguments of an
drhed551b92012-08-23 19:46:11 +00005743** aggregate function, in order to implement the
5744** sqlite3FunctionThisSrc() routine.
drh374fdce2012-04-17 16:38:53 +00005745*/
drh030796d2012-08-23 16:18:10 +00005746struct SrcCount {
5747 SrcList *pSrc; /* One particular FROM clause in a nested query */
daned41a962020-06-09 17:45:48 +00005748 int iSrcInner; /* Smallest cursor number in this context */
drh030796d2012-08-23 16:18:10 +00005749 int nThis; /* Number of references to columns in pSrcList */
5750 int nOther; /* Number of references to columns in other FROM clauses */
5751};
5752
5753/*
daned41a962020-06-09 17:45:48 +00005754** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5755** SELECT with a FROM clause encountered during this iteration, set
5756** SrcCount.iSrcInner to the cursor number of the leftmost object in
5757** the FROM cause.
5758*/
5759static int selectSrcCount(Walker *pWalker, Select *pSel){
5760 struct SrcCount *p = pWalker->u.pSrcCount;
drhbc050b82020-06-09 22:11:06 +00005761 if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
daned41a962020-06-09 17:45:48 +00005762 pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5763 }
5764 return WRC_Continue;
5765}
5766
5767/*
drh030796d2012-08-23 16:18:10 +00005768** Count the number of references to columns.
5769*/
5770static int exprSrcCount(Walker *pWalker, Expr *pExpr){
danb4b36302019-12-27 20:06:32 +00005771 /* There was once a NEVER() on the second term on the grounds that
5772 ** sqlite3FunctionUsesThisSrc() was always called before
5773 ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5774 ** been converted into TK_AGG_COLUMN. But this is no longer true due
5775 ** to window functions - sqlite3WindowRewrite() may now indirectly call
5776 ** FunctionUsesThisSrc() when creating a new sub-select. */
5777 if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
drh374fdce2012-04-17 16:38:53 +00005778 int i;
drh030796d2012-08-23 16:18:10 +00005779 struct SrcCount *p = pWalker->u.pSrcCount;
5780 SrcList *pSrc = p->pSrc;
drh655814d2015-01-09 01:27:29 +00005781 int nSrc = pSrc ? pSrc->nSrc : 0;
5782 for(i=0; i<nSrc; i++){
drh030796d2012-08-23 16:18:10 +00005783 if( pExpr->iTable==pSrc->a[i].iCursor ) break;
drh374fdce2012-04-17 16:38:53 +00005784 }
drh655814d2015-01-09 01:27:29 +00005785 if( i<nSrc ){
drh030796d2012-08-23 16:18:10 +00005786 p->nThis++;
daned41a962020-06-09 17:45:48 +00005787 }else if( pExpr->iTable<p->iSrcInner ){
drh80f6bfc2019-08-31 20:13:30 +00005788 /* In a well-formed parse tree (no name resolution errors),
drh35a38e02019-08-31 20:29:28 +00005789 ** TK_COLUMN nodes with smaller Expr.iTable values are in an
drh80f6bfc2019-08-31 20:13:30 +00005790 ** outer context. Those are the only ones to count as "other" */
drh030796d2012-08-23 16:18:10 +00005791 p->nOther++;
5792 }
drh374fdce2012-04-17 16:38:53 +00005793 }
drh030796d2012-08-23 16:18:10 +00005794 return WRC_Continue;
drh374fdce2012-04-17 16:38:53 +00005795}
5796
5797/*
drh030796d2012-08-23 16:18:10 +00005798** Determine if any of the arguments to the pExpr Function reference
5799** pSrcList. Return true if they do. Also return true if the function
5800** has no arguments or has only constant arguments. Return false if pExpr
5801** references columns but not columns of tables found in pSrcList.
drh374fdce2012-04-17 16:38:53 +00005802*/
drh030796d2012-08-23 16:18:10 +00005803int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
drh374fdce2012-04-17 16:38:53 +00005804 Walker w;
drh030796d2012-08-23 16:18:10 +00005805 struct SrcCount cnt;
drh374fdce2012-04-17 16:38:53 +00005806 assert( pExpr->op==TK_AGG_FUNCTION );
drh80f6bfc2019-08-31 20:13:30 +00005807 memset(&w, 0, sizeof(w));
drh030796d2012-08-23 16:18:10 +00005808 w.xExprCallback = exprSrcCount;
daned41a962020-06-09 17:45:48 +00005809 w.xSelectCallback = selectSrcCount;
drh030796d2012-08-23 16:18:10 +00005810 w.u.pSrcCount = &cnt;
5811 cnt.pSrc = pSrcList;
daned41a962020-06-09 17:45:48 +00005812 cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
drh030796d2012-08-23 16:18:10 +00005813 cnt.nThis = 0;
5814 cnt.nOther = 0;
5815 sqlite3WalkExprList(&w, pExpr->x.pList);
dan5e484cb2019-12-27 08:57:08 +00005816#ifndef SQLITE_OMIT_WINDOWFUNC
5817 if( ExprHasProperty(pExpr, EP_WinFunc) ){
5818 sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
5819 }
5820#endif
drh030796d2012-08-23 16:18:10 +00005821 return cnt.nThis>0 || cnt.nOther==0;
drh374fdce2012-04-17 16:38:53 +00005822}
5823
5824/*
drh89636622020-06-07 17:33:18 +00005825** This is a Walker expression node callback.
5826**
5827** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
5828** object that is referenced does not refer directly to the Expr. If
5829** it does, make a copy. This is done because the pExpr argument is
5830** subject to change.
5831**
5832** The copy is stored on pParse->pConstExpr with a register number of 0.
5833** This will cause the expression to be deleted automatically when the
5834** Parse object is destroyed, but the zero register number means that it
5835** will not generate any code in the preamble.
5836*/
5837static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
drh2f82acc2020-06-07 22:44:23 +00005838 if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
drh89636622020-06-07 17:33:18 +00005839 && pExpr->pAggInfo!=0
5840 ){
5841 AggInfo *pAggInfo = pExpr->pAggInfo;
5842 int iAgg = pExpr->iAgg;
5843 Parse *pParse = pWalker->pParse;
5844 sqlite3 *db = pParse->db;
drh2f82acc2020-06-07 22:44:23 +00005845 assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
5846 if( pExpr->op==TK_AGG_COLUMN ){
drh89636622020-06-07 17:33:18 +00005847 assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
drh81185a52020-06-09 13:38:12 +00005848 if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005849 pExpr = sqlite3ExprDup(db, pExpr, 0);
5850 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005851 pAggInfo->aCol[iAgg].pCExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00005852 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00005853 }
5854 }
5855 }else{
5856 assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
drh81185a52020-06-09 13:38:12 +00005857 if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
drh89636622020-06-07 17:33:18 +00005858 pExpr = sqlite3ExprDup(db, pExpr, 0);
5859 if( pExpr ){
drh81185a52020-06-09 13:38:12 +00005860 pAggInfo->aFunc[iAgg].pFExpr = pExpr;
drhb3ad4e62021-03-31 13:31:33 +00005861 sqlite3ExprDeferredDelete(pParse, pExpr);
drh89636622020-06-07 17:33:18 +00005862 }
5863 }
5864 }
5865 }
5866 return WRC_Continue;
5867}
5868
5869/*
5870** Initialize a Walker object so that will persist AggInfo entries referenced
5871** by the tree that is walked.
5872*/
5873void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
5874 memset(pWalker, 0, sizeof(*pWalker));
5875 pWalker->pParse = pParse;
5876 pWalker->xExprCallback = agginfoPersistExprCb;
5877 pWalker->xSelectCallback = sqlite3SelectWalkNoop;
5878}
5879
5880/*
drh13449892005-09-07 21:22:45 +00005881** Add a new element to the pAggInfo->aCol[] array. Return the index of
5882** the new element. Return a negative number if malloc fails.
drh22827922000-06-06 17:27:05 +00005883*/
drh17435752007-08-16 04:30:38 +00005884static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005885 int i;
drhcf643722007-03-27 13:36:37 +00005886 pInfo->aCol = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005887 db,
drhcf643722007-03-27 13:36:37 +00005888 pInfo->aCol,
5889 sizeof(pInfo->aCol[0]),
drhcf643722007-03-27 13:36:37 +00005890 &pInfo->nColumn,
drhcf643722007-03-27 13:36:37 +00005891 &i
5892 );
drh13449892005-09-07 21:22:45 +00005893 return i;
5894}
5895
5896/*
5897** Add a new element to the pAggInfo->aFunc[] array. Return the index of
5898** the new element. Return a negative number if malloc fails.
5899*/
drh17435752007-08-16 04:30:38 +00005900static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
drh13449892005-09-07 21:22:45 +00005901 int i;
drhcf643722007-03-27 13:36:37 +00005902 pInfo->aFunc = sqlite3ArrayAllocate(
drh17435752007-08-16 04:30:38 +00005903 db,
drhcf643722007-03-27 13:36:37 +00005904 pInfo->aFunc,
5905 sizeof(pInfo->aFunc[0]),
drhcf643722007-03-27 13:36:37 +00005906 &pInfo->nFunc,
drhcf643722007-03-27 13:36:37 +00005907 &i
5908 );
drh13449892005-09-07 21:22:45 +00005909 return i;
drh89636622020-06-07 17:33:18 +00005910}
drh22827922000-06-06 17:27:05 +00005911
5912/*
drh7d10d5a2008-08-20 16:35:10 +00005913** This is the xExprCallback for a tree walker. It is used to
5914** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
drh626a8792005-01-17 22:08:19 +00005915** for additional information.
drh22827922000-06-06 17:27:05 +00005916*/
drh7d10d5a2008-08-20 16:35:10 +00005917static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
drh22827922000-06-06 17:27:05 +00005918 int i;
drh7d10d5a2008-08-20 16:35:10 +00005919 NameContext *pNC = pWalker->u.pNC;
danielk1977a58fdfb2005-02-08 07:50:40 +00005920 Parse *pParse = pNC->pParse;
5921 SrcList *pSrcList = pNC->pSrcList;
drh25c3b8c2018-04-16 10:34:13 +00005922 AggInfo *pAggInfo = pNC->uNC.pAggInfo;
drh22827922000-06-06 17:27:05 +00005923
drh25c3b8c2018-04-16 10:34:13 +00005924 assert( pNC->ncFlags & NC_UAggInfo );
drh22827922000-06-06 17:27:05 +00005925 switch( pExpr->op ){
drh89c69d02007-01-04 01:20:28 +00005926 case TK_AGG_COLUMN:
drh967e8b72000-06-21 13:59:10 +00005927 case TK_COLUMN: {
drh8b213892008-08-29 02:14:02 +00005928 testcase( pExpr->op==TK_AGG_COLUMN );
5929 testcase( pExpr->op==TK_COLUMN );
drh13449892005-09-07 21:22:45 +00005930 /* Check to see if the column is in one of the tables in the FROM
5931 ** clause of the aggregate query */
drh20bc3932009-05-30 23:35:43 +00005932 if( ALWAYS(pSrcList!=0) ){
drh76012942021-02-21 21:04:54 +00005933 SrcItem *pItem = pSrcList->a;
drh13449892005-09-07 21:22:45 +00005934 for(i=0; i<pSrcList->nSrc; i++, pItem++){
5935 struct AggInfo_col *pCol;
drhc5cd1242013-09-12 16:50:49 +00005936 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drh13449892005-09-07 21:22:45 +00005937 if( pExpr->iTable==pItem->iCursor ){
5938 /* If we reach this point, it means that pExpr refers to a table
5939 ** that is in the FROM clause of the aggregate query.
5940 **
5941 ** Make an entry for the column in pAggInfo->aCol[] if there
5942 ** is not an entry there already.
5943 */
drh7f906d62007-03-12 23:48:52 +00005944 int k;
drh13449892005-09-07 21:22:45 +00005945 pCol = pAggInfo->aCol;
drh7f906d62007-03-12 23:48:52 +00005946 for(k=0; k<pAggInfo->nColumn; k++, pCol++){
drh13449892005-09-07 21:22:45 +00005947 if( pCol->iTable==pExpr->iTable &&
5948 pCol->iColumn==pExpr->iColumn ){
5949 break;
5950 }
danielk1977a58fdfb2005-02-08 07:50:40 +00005951 }
danielk19771e536952007-08-16 10:09:01 +00005952 if( (k>=pAggInfo->nColumn)
5953 && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
5954 ){
drh7f906d62007-03-12 23:48:52 +00005955 pCol = &pAggInfo->aCol[k];
drheda079c2018-09-20 19:02:15 +00005956 pCol->pTab = pExpr->y.pTab;
drh13449892005-09-07 21:22:45 +00005957 pCol->iTable = pExpr->iTable;
5958 pCol->iColumn = pExpr->iColumn;
drh0a07c102008-01-03 18:03:08 +00005959 pCol->iMem = ++pParse->nMem;
drh13449892005-09-07 21:22:45 +00005960 pCol->iSorterColumn = -1;
drh81185a52020-06-09 13:38:12 +00005961 pCol->pCExpr = pExpr;
drh13449892005-09-07 21:22:45 +00005962 if( pAggInfo->pGroupBy ){
5963 int j, n;
5964 ExprList *pGB = pAggInfo->pGroupBy;
5965 struct ExprList_item *pTerm = pGB->a;
5966 n = pGB->nExpr;
5967 for(j=0; j<n; j++, pTerm++){
5968 Expr *pE = pTerm->pExpr;
5969 if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
5970 pE->iColumn==pExpr->iColumn ){
5971 pCol->iSorterColumn = j;
5972 break;
5973 }
5974 }
5975 }
5976 if( pCol->iSorterColumn<0 ){
5977 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
5978 }
5979 }
5980 /* There is now an entry for pExpr in pAggInfo->aCol[] (either
5981 ** because it was there before or because we just created it).
5982 ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
5983 ** pAggInfo->aCol[] entry.
5984 */
drhebb6a652013-09-12 23:42:22 +00005985 ExprSetVVAProperty(pExpr, EP_NoReduce);
drh13449892005-09-07 21:22:45 +00005986 pExpr->pAggInfo = pAggInfo;
5987 pExpr->op = TK_AGG_COLUMN;
shanecf697392009-06-01 16:53:09 +00005988 pExpr->iAgg = (i16)k;
drh13449892005-09-07 21:22:45 +00005989 break;
5990 } /* endif pExpr->iTable==pItem->iCursor */
5991 } /* end loop over pSrcList */
drh22827922000-06-06 17:27:05 +00005992 }
drh7d10d5a2008-08-20 16:35:10 +00005993 return WRC_Prune;
drh22827922000-06-06 17:27:05 +00005994 }
5995 case TK_AGG_FUNCTION: {
drh3a8c4be2012-05-21 20:13:39 +00005996 if( (pNC->ncFlags & NC_InAggFunc)==0
drhed551b92012-08-23 19:46:11 +00005997 && pWalker->walkerDepth==pExpr->op2
drh3a8c4be2012-05-21 20:13:39 +00005998 ){
drh13449892005-09-07 21:22:45 +00005999 /* Check to see if pExpr is a duplicate of another aggregate
6000 ** function that is already in the pAggInfo structure
6001 */
6002 struct AggInfo_func *pItem = pAggInfo->aFunc;
6003 for(i=0; i<pAggInfo->nFunc; i++, pItem++){
drh81185a52020-06-09 13:38:12 +00006004 if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
danielk1977a58fdfb2005-02-08 07:50:40 +00006005 break;
6006 }
drh22827922000-06-06 17:27:05 +00006007 }
drh13449892005-09-07 21:22:45 +00006008 if( i>=pAggInfo->nFunc ){
6009 /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
6010 */
danielk197714db2662006-01-09 16:12:04 +00006011 u8 enc = ENC(pParse->db);
danielk19771e536952007-08-16 10:09:01 +00006012 i = addAggInfoFunc(pParse->db, pAggInfo);
drh13449892005-09-07 21:22:45 +00006013 if( i>=0 ){
danielk19776ab3a2e2009-02-19 14:39:25 +00006014 assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
drh13449892005-09-07 21:22:45 +00006015 pItem = &pAggInfo->aFunc[i];
drh81185a52020-06-09 13:38:12 +00006016 pItem->pFExpr = pExpr;
drh0a07c102008-01-03 18:03:08 +00006017 pItem->iMem = ++pParse->nMem;
drh33e619f2009-05-28 01:00:55 +00006018 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh13449892005-09-07 21:22:45 +00006019 pItem->pFunc = sqlite3FindFunction(pParse->db,
drh80738d92016-02-15 00:34:16 +00006020 pExpr->u.zToken,
danielk19776ab3a2e2009-02-19 14:39:25 +00006021 pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
drhfd357972005-09-09 01:33:19 +00006022 if( pExpr->flags & EP_Distinct ){
6023 pItem->iDistinct = pParse->nTab++;
6024 }else{
6025 pItem->iDistinct = -1;
6026 }
drh13449892005-09-07 21:22:45 +00006027 }
danielk1977a58fdfb2005-02-08 07:50:40 +00006028 }
drh13449892005-09-07 21:22:45 +00006029 /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
6030 */
drhc5cd1242013-09-12 16:50:49 +00006031 assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +00006032 ExprSetVVAProperty(pExpr, EP_NoReduce);
shanecf697392009-06-01 16:53:09 +00006033 pExpr->iAgg = (i16)i;
drh13449892005-09-07 21:22:45 +00006034 pExpr->pAggInfo = pAggInfo;
drh6e83a572012-11-02 18:48:49 +00006035 return WRC_Prune;
6036 }else{
6037 return WRC_Continue;
drh22827922000-06-06 17:27:05 +00006038 }
drh22827922000-06-06 17:27:05 +00006039 }
6040 }
drh7d10d5a2008-08-20 16:35:10 +00006041 return WRC_Continue;
6042}
drh626a8792005-01-17 22:08:19 +00006043
6044/*
drhe8abb4c2012-11-02 18:24:57 +00006045** Analyze the pExpr expression looking for aggregate functions and
6046** for variables that need to be added to AggInfo object that pNC->pAggInfo
6047** points to. Additional entries are made on the AggInfo object as
6048** necessary.
drh626a8792005-01-17 22:08:19 +00006049**
6050** This routine should only be called after the expression has been
drh7d10d5a2008-08-20 16:35:10 +00006051** analyzed by sqlite3ResolveExprNames().
drh626a8792005-01-17 22:08:19 +00006052*/
drhd2b3e232008-01-23 14:51:49 +00006053void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
drh7d10d5a2008-08-20 16:35:10 +00006054 Walker w;
6055 w.xExprCallback = analyzeAggregate;
drhe40cc162020-05-24 03:01:36 +00006056 w.xSelectCallback = sqlite3WalkerDepthIncrease;
6057 w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
drh979dd1b2017-05-29 14:26:07 +00006058 w.walkerDepth = 0;
drh7d10d5a2008-08-20 16:35:10 +00006059 w.u.pNC = pNC;
dand9995032019-01-23 16:59:24 +00006060 w.pParse = 0;
drh20bc3932009-05-30 23:35:43 +00006061 assert( pNC->pSrcList!=0 );
drh7d10d5a2008-08-20 16:35:10 +00006062 sqlite3WalkExpr(&w, pExpr);
drh22827922000-06-06 17:27:05 +00006063}
drh5d9a4af2005-08-30 00:54:01 +00006064
6065/*
6066** Call sqlite3ExprAnalyzeAggregates() for every expression in an
6067** expression list. Return the number of errors.
6068**
6069** If an error is found, the analysis is cut short.
6070*/
drhd2b3e232008-01-23 14:51:49 +00006071void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
drh5d9a4af2005-08-30 00:54:01 +00006072 struct ExprList_item *pItem;
6073 int i;
drh5d9a4af2005-08-30 00:54:01 +00006074 if( pList ){
drhd2b3e232008-01-23 14:51:49 +00006075 for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6076 sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
drh5d9a4af2005-08-30 00:54:01 +00006077 }
6078 }
drh5d9a4af2005-08-30 00:54:01 +00006079}
drh892d3172008-01-10 03:46:36 +00006080
6081/*
drhceea3322009-04-23 13:22:42 +00006082** Allocate a single new register for use to hold some intermediate result.
drh892d3172008-01-10 03:46:36 +00006083*/
6084int sqlite3GetTempReg(Parse *pParse){
drhe55cbd72008-03-31 23:48:03 +00006085 if( pParse->nTempReg==0 ){
drh892d3172008-01-10 03:46:36 +00006086 return ++pParse->nMem;
6087 }
danielk19772f425f62008-07-04 09:41:39 +00006088 return pParse->aTempReg[--pParse->nTempReg];
drh892d3172008-01-10 03:46:36 +00006089}
drhceea3322009-04-23 13:22:42 +00006090
6091/*
6092** Deallocate a register, making available for reuse for some other
6093** purpose.
drhceea3322009-04-23 13:22:42 +00006094*/
drh892d3172008-01-10 03:46:36 +00006095void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
drh13d79502019-12-23 02:18:49 +00006096 if( iReg ){
drh3aef2fb2020-01-02 17:46:02 +00006097 sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
drh13d79502019-12-23 02:18:49 +00006098 if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6099 pParse->aTempReg[pParse->nTempReg++] = iReg;
6100 }
drh892d3172008-01-10 03:46:36 +00006101 }
6102}
6103
6104/*
drhed24da42016-09-06 14:37:05 +00006105** Allocate or deallocate a block of nReg consecutive registers.
drh892d3172008-01-10 03:46:36 +00006106*/
6107int sqlite3GetTempRange(Parse *pParse, int nReg){
drhe55cbd72008-03-31 23:48:03 +00006108 int i, n;
drhed24da42016-09-06 14:37:05 +00006109 if( nReg==1 ) return sqlite3GetTempReg(pParse);
drhe55cbd72008-03-31 23:48:03 +00006110 i = pParse->iRangeReg;
6111 n = pParse->nRangeReg;
drhf49f3522009-12-30 14:12:38 +00006112 if( nReg<=n ){
drh892d3172008-01-10 03:46:36 +00006113 pParse->iRangeReg += nReg;
6114 pParse->nRangeReg -= nReg;
6115 }else{
6116 i = pParse->nMem+1;
6117 pParse->nMem += nReg;
6118 }
6119 return i;
6120}
6121void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
drhed24da42016-09-06 14:37:05 +00006122 if( nReg==1 ){
6123 sqlite3ReleaseTempReg(pParse, iReg);
6124 return;
6125 }
drh3aef2fb2020-01-02 17:46:02 +00006126 sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
drh892d3172008-01-10 03:46:36 +00006127 if( nReg>pParse->nRangeReg ){
6128 pParse->nRangeReg = nReg;
6129 pParse->iRangeReg = iReg;
6130 }
6131}
drhcdc69552011-12-06 13:24:59 +00006132
6133/*
6134** Mark all temporary registers as being unavailable for reuse.
drh6d2566d2019-09-18 20:34:54 +00006135**
6136** Always invoke this procedure after coding a subroutine or co-routine
6137** that might be invoked from other parts of the code, to ensure that
6138** the sub/co-routine does not use registers in common with the code that
6139** invokes the sub/co-routine.
drhcdc69552011-12-06 13:24:59 +00006140*/
6141void sqlite3ClearTempRegCache(Parse *pParse){
6142 pParse->nTempReg = 0;
6143 pParse->nRangeReg = 0;
6144}
drhbb9b5f22016-03-19 00:35:02 +00006145
6146/*
6147** Validate that no temporary register falls within the range of
6148** iFirst..iLast, inclusive. This routine is only call from within assert()
6149** statements.
6150*/
6151#ifdef SQLITE_DEBUG
6152int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6153 int i;
6154 if( pParse->nRangeReg>0
drh3963e582017-07-15 20:33:19 +00006155 && pParse->iRangeReg+pParse->nRangeReg > iFirst
6156 && pParse->iRangeReg <= iLast
drhbb9b5f22016-03-19 00:35:02 +00006157 ){
6158 return 0;
6159 }
6160 for(i=0; i<pParse->nTempReg; i++){
6161 if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6162 return 0;
6163 }
6164 }
6165 return 1;
6166}
6167#endif /* SQLITE_DEBUG */